blob: 46b339dd198a88425640ba9f0d347c4f54f2a8ab [file] [log] [blame]
Anders Carlsson046c2942010-04-17 20:15:18 +00001//===--- CGVTables.cpp - Emit LLVM Code for C++ vtables -------------------===//
Anders Carlssondbd920c2009-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 McCall4c40d982010-08-31 07:33:07 +000016#include "CGCXXABI.h"
Anders Carlssond6b07fb2009-11-27 20:47:55 +000017#include "clang/AST/CXXInheritance.h"
Anders Carlssondbd920c2009-10-11 22:13:54 +000018#include "clang/AST/RecordLayout.h"
John McCall7a536902010-08-05 20:39:18 +000019#include "clang/Frontend/CodeGenOptions.h"
Anders Carlsson5dd730a2009-11-26 19:32:45 +000020#include "llvm/ADT/DenseSet.h"
Anders Carlssonb9021e92010-02-27 16:18:19 +000021#include "llvm/ADT/SetVector.h"
Chandler Carruthe087f072010-02-13 10:38:52 +000022#include "llvm/Support/Compiler.h"
Anders Carlsson824d7ea2010-02-11 08:02:13 +000023#include "llvm/Support/Format.h"
Anders Carlsson5e454aa2010-03-17 20:06:32 +000024#include <algorithm>
Zhongxing Xu7fe26ac2009-11-13 05:46:16 +000025#include <cstdio>
Anders Carlssondbd920c2009-10-11 22:13:54 +000026
27using namespace clang;
28using namespace CodeGen;
29
Anders Carlsson27f69d02009-11-27 22:21:51 +000030namespace {
Anders Carlsson824d7ea2010-02-11 08:02:13 +000031
Anders Carlsson2fca9be2010-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 Carlssonbdf73d82010-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 Carlssona7575822010-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 Carlsson96309c42010-02-18 16:29:24 +000065
Anders Carlssondb4022c2010-03-10 02:33:41 +000066 /// Offset - the base offset of the overrider in the layout class.
Ken Dyck17d85192011-03-26 01:29:16 +000067 CharUnits Offset;
Anders Carlssona7575822010-02-12 16:55:34 +000068
Ken Dyck17d85192011-03-26 01:29:16 +000069 OverriderInfo() : Method(0), Offset(CharUnits::Zero()) { }
Anders Carlssona7575822010-02-12 16:55:34 +000070 };
71
72private:
Anders Carlssonbdf73d82010-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 Carlssondb4022c2010-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 Dyckfc724202011-03-27 20:10:29 +000080 const CharUnits MostDerivedClassOffset;
Anders Carlssondb4022c2010-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 Carlssonbdf73d82010-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 Carlsson0a028602010-06-01 23:52:26 +000092 /// MethodBaseOffsetPairTy - Uniquely identifies a member function
Anders Carlsson0c0eeb22010-02-13 02:02:03 +000093 /// in a base subobject.
Ken Dycke6203132011-03-26 01:18:17 +000094 typedef std::pair<const CXXMethodDecl *, CharUnits> MethodBaseOffsetPairTy;
Anders Carlsson0a028602010-06-01 23:52:26 +000095
96 typedef llvm::DenseMap<MethodBaseOffsetPairTy,
Anders Carlssona7575822010-02-12 16:55:34 +000097 OverriderInfo> OverridersMapTy;
Anders Carlssonbdf73d82010-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 Carlsson147a23d2010-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 Dyck35c416b2011-03-26 01:09:13 +0000107 CharUnits> SubobjectOffsetMapTy;
Anders Carlsson147a23d2010-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 Dyckb4c82b42011-03-26 01:36:26 +0000114 CharUnits OffsetInLayoutClass,
Anders Carlsson147a23d2010-06-04 00:54:04 +0000115 SubobjectOffsetMapTy &SubobjectOffsets,
116 SubobjectOffsetMapTy &SubobjectLayoutClassOffsets,
117 SubobjectCountMapTy &SubobjectCounts);
118
Anders Carlssonb9cae1d2010-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 Carlssonbdf73d82010-02-11 21:24:32 +0000126public:
Anders Carlssondb4022c2010-03-10 02:33:41 +0000127 FinalOverriders(const CXXRecordDecl *MostDerivedClass,
Ken Dyckfc724202011-03-27 20:10:29 +0000128 CharUnits MostDerivedClassOffset,
Anders Carlssondb4022c2010-03-10 02:33:41 +0000129 const CXXRecordDecl *LayoutClass);
Anders Carlsson2157d302010-02-24 22:18:01 +0000130
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000131 /// getOverrider - Get the final overrider for the given method declaration in
Anders Carlsson26387642010-06-01 23:17:37 +0000132 /// the subobject with the given base offset.
133 OverriderInfo getOverrider(const CXXMethodDecl *MD,
Ken Dycke6203132011-03-26 01:18:17 +0000134 CharUnits BaseOffset) const {
Anders Carlsson0a028602010-06-01 23:52:26 +0000135 assert(OverridersMap.count(std::make_pair(MD, BaseOffset)) &&
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000136 "Did not find overrider!");
137
Anders Carlsson0a028602010-06-01 23:52:26 +0000138 return OverridersMap.lookup(std::make_pair(MD, BaseOffset));
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000139 }
140
141 /// dump - dump the final overriders.
Anders Carlsson9d6f0d52010-02-14 00:37:35 +0000142 void dump() {
Anders Carlssonb9cae1d2010-06-04 00:59:37 +0000143 VisitedVirtualBasesSetTy VisitedVirtualBases;
Ken Dyck4230d522011-03-24 01:21:01 +0000144 dump(llvm::errs(), BaseSubobject(MostDerivedClass, CharUnits::Zero()),
145 VisitedVirtualBases);
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000146 }
147
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000148};
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000149
Anders Carlsson327568e2010-02-27 20:02:53 +0000150#define DUMP_OVERRIDERS 0
151
Anders Carlssondb4022c2010-03-10 02:33:41 +0000152FinalOverriders::FinalOverriders(const CXXRecordDecl *MostDerivedClass,
Ken Dyckfc724202011-03-27 20:10:29 +0000153 CharUnits MostDerivedClassOffset,
Anders Carlssondb4022c2010-03-10 02:33:41 +0000154 const CXXRecordDecl *LayoutClass)
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000155 : MostDerivedClass(MostDerivedClass),
Anders Carlssondb4022c2010-03-10 02:33:41 +0000156 MostDerivedClassOffset(MostDerivedClassOffset), LayoutClass(LayoutClass),
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000157 Context(MostDerivedClass->getASTContext()),
158 MostDerivedClassLayout(Context.getASTRecordLayout(MostDerivedClass)) {
Anders Carlssonb9cae1d2010-06-04 00:59:37 +0000159
Anders Carlsson147a23d2010-06-04 00:54:04 +0000160 // Compute base offsets.
161 SubobjectOffsetMapTy SubobjectOffsets;
162 SubobjectOffsetMapTy SubobjectLayoutClassOffsets;
163 SubobjectCountMapTy SubobjectCounts;
Ken Dyck4230d522011-03-24 01:21:01 +0000164 ComputeBaseOffsets(BaseSubobject(MostDerivedClass, CharUnits::Zero()),
165 /*IsVirtual=*/false,
Ken Dyckfc724202011-03-27 20:10:29 +0000166 MostDerivedClassOffset,
Ken Dyckb4c82b42011-03-26 01:36:26 +0000167 SubobjectOffsets, SubobjectLayoutClassOffsets,
168 SubobjectCounts);
Anders Carlsson147a23d2010-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 Dyck35c416b2011-03-26 01:09:13 +0000186 CharUnits BaseOffset = SubobjectOffsets[std::make_pair(MD->getParent(),
Anders Carlsson147a23d2010-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 Dyck35c416b2011-03-26 01:09:13 +0000196 CharUnits OverriderOffset =
Anders Carlsson147a23d2010-06-04 00:54:04 +0000197 SubobjectLayoutClassOffsets[std::make_pair(OverriderRD,
198 Method.Subobject)];
199
Ken Dycke6203132011-03-26 01:18:17 +0000200 OverriderInfo& Overrider = OverridersMap[std::make_pair(MD, BaseOffset)];
Anders Carlsson147a23d2010-06-04 00:54:04 +0000201 assert(!Overrider.Method && "Overrider should not exist yet!");
202
Ken Dyck17d85192011-03-26 01:29:16 +0000203 Overrider.Offset = OverriderOffset;
Anders Carlsson147a23d2010-06-04 00:54:04 +0000204 Overrider.Method = Method.Method;
205 }
206 }
Anders Carlsson327568e2010-02-27 20:02:53 +0000207
208#if DUMP_OVERRIDERS
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000209 // And dump them (for now).
210 dump();
Anders Carlsson327568e2010-02-27 20:02:53 +0000211#endif
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000212}
213
Anders Carlsson2fca9be2010-02-23 01:34:28 +0000214static BaseOffset ComputeBaseOffset(ASTContext &Context,
215 const CXXRecordDecl *DerivedRD,
216 const CXXBasePath &Path) {
Anders Carlssondf31af12010-02-13 23:17:31 +0000217 int64_t NonVirtualOffset = 0;
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000218
Anders Carlssona4a54172010-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 Carlsson0c0eeb22010-02-13 02:02:03 +0000239
240 // Check the base class offset.
241 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Element.Class);
Anders Carlssonbf554f62010-02-25 22:18:35 +0000242
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000243 const RecordType *BaseType = Element.Base->getType()->getAs<RecordType>();
244 const CXXRecordDecl *Base = cast<CXXRecordDecl>(BaseType->getDecl());
Anders Carlssonbf554f62010-02-25 22:18:35 +0000245
Anders Carlssona14f5972010-10-31 23:22:37 +0000246 NonVirtualOffset += Layout.getBaseClassOffsetInBits(Base);
Anders Carlsson0c0eeb22010-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 Carlsson2fca9be2010-02-23 01:34:28 +0000252 return BaseOffset(DerivedRD, VirtualBase, NonVirtualOffset / 8);
Anders Carlssone67dc302010-02-14 00:16:19 +0000253
254}
255
Anders Carlsson2fca9be2010-02-23 01:34:28 +0000256static BaseOffset ComputeBaseOffset(ASTContext &Context,
257 const CXXRecordDecl *BaseRD,
258 const CXXRecordDecl *DerivedRD) {
Anders Carlssone67dc302010-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 Carlsson2fca9be2010-02-23 01:34:28 +0000265 return BaseOffset();
Anders Carlssone67dc302010-02-14 00:16:19 +0000266 }
267
268 return ComputeBaseOffset(Context, DerivedRD, Paths.front());
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000269}
270
Anders Carlsson2fca9be2010-02-23 01:34:28 +0000271static BaseOffset
Anders Carlssondf31af12010-02-13 23:17:31 +0000272ComputeReturnAdjustmentBaseOffset(ASTContext &Context,
273 const CXXMethodDecl *DerivedMD,
274 const CXXMethodDecl *BaseMD) {
Anders Carlsson0c0eeb22010-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 Carlsson2fca9be2010-02-23 01:34:28 +0000290 return BaseOffset();
Anders Carlsson0c0eeb22010-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 Carlsson2fca9be2010-02-23 01:34:28 +0000313 return BaseOffset();
Anders Carlsson0c0eeb22010-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 Carlssondf31af12010-02-13 23:17:31 +0000322 return ComputeBaseOffset(Context, BaseRD, DerivedRD);
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000323}
324
Anders Carlsson147a23d2010-06-04 00:54:04 +0000325void
326FinalOverriders::ComputeBaseOffsets(BaseSubobject Base, bool IsVirtual,
Ken Dyckb4c82b42011-03-26 01:36:26 +0000327 CharUnits OffsetInLayoutClass,
Anders Carlsson147a23d2010-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 Dyck35c416b2011-03-26 01:09:13 +0000343 SubobjectOffsets[std::make_pair(RD, SubobjectNumber)] = Base.getBaseOffset();
Anders Carlsson147a23d2010-06-04 00:54:04 +0000344 SubobjectLayoutClassOffsets[std::make_pair(RD, SubobjectNumber)] =
Ken Dyckb4c82b42011-03-26 01:36:26 +0000345 OffsetInLayoutClass;
Anders Carlsson147a23d2010-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 Dyck57ebe332011-03-26 00:51:24 +0000353 CharUnits BaseOffset;
354 CharUnits BaseOffsetInLayoutClass;
Anders Carlsson147a23d2010-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 Dyck57ebe332011-03-26 00:51:24 +0000363 BaseOffset = MostDerivedClassLayout.getVBaseClassOffset(BaseDecl);
Anders Carlsson147a23d2010-06-04 00:54:04 +0000364 BaseOffsetInLayoutClass =
Ken Dyck57ebe332011-03-26 00:51:24 +0000365 LayoutClassLayout.getVBaseClassOffset(BaseDecl);
Anders Carlsson147a23d2010-06-04 00:54:04 +0000366 } else {
367 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Ken Dyck57ebe332011-03-26 00:51:24 +0000368 CharUnits Offset = Layout.getBaseClassOffset(BaseDecl);
Anders Carlsson147a23d2010-06-04 00:54:04 +0000369
Ken Dyck57ebe332011-03-26 00:51:24 +0000370 BaseOffset = Base.getBaseOffset() + Offset;
Ken Dyckb4c82b42011-03-26 01:36:26 +0000371 BaseOffsetInLayoutClass = OffsetInLayoutClass + Offset;
Anders Carlsson147a23d2010-06-04 00:54:04 +0000372 }
373
Ken Dyck57ebe332011-03-26 00:51:24 +0000374 ComputeBaseOffsets(BaseSubobject(BaseDecl, BaseOffset),
Ken Dyckb4c82b42011-03-26 01:36:26 +0000375 I->isVirtual(), BaseOffsetInLayoutClass,
Ken Dyck4230d522011-03-24 01:21:01 +0000376 SubobjectOffsets, SubobjectLayoutClassOffsets,
377 SubobjectCounts);
Anders Carlsson147a23d2010-06-04 00:54:04 +0000378 }
379}
380
Anders Carlssonb9cae1d2010-06-04 00:59:37 +0000381void FinalOverriders::dump(llvm::raw_ostream &Out, BaseSubobject Base,
382 VisitedVirtualBasesSetTy &VisitedVirtualBases) {
Anders Carlssonbdf73d82010-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 Carlssonbdf73d82010-02-11 21:24:32 +0000388 const CXXRecordDecl *BaseDecl =
389 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
390
Anders Carlssonb828afa2010-02-14 17:05:59 +0000391 // Ignore bases that don't have any virtual member functions.
392 if (!BaseDecl->isPolymorphic())
393 continue;
394
Ken Dyck4230d522011-03-24 01:21:01 +0000395 CharUnits BaseOffset;
Anders Carlsson9d6f0d52010-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 Dyck4230d522011-03-24 01:21:01 +0000402 BaseOffset = MostDerivedClassLayout.getVBaseClassOffset(BaseDecl);
Anders Carlsson9d6f0d52010-02-14 00:37:35 +0000403 } else {
Ken Dyck4230d522011-03-24 01:21:01 +0000404 BaseOffset = Layout.getBaseClassOffset(BaseDecl) + Base.getBaseOffset();
Anders Carlsson9d6f0d52010-02-14 00:37:35 +0000405 }
406
Anders Carlssonb9cae1d2010-06-04 00:59:37 +0000407 dump(Out, BaseSubobject(BaseDecl, BaseOffset), VisitedVirtualBases);
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000408 }
409
410 Out << "Final overriders for (" << RD->getQualifiedNameAsString() << ", ";
Ken Dyck4230d522011-03-24 01:21:01 +0000411 Out << Base.getBaseOffset().getQuantity() << ")\n";
Anders Carlssonbdf73d82010-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 Dycke6203132011-03-26 01:18:17 +0000421 OverriderInfo Overrider = getOverrider(MD, Base.getBaseOffset());
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000422
Anders Carlssond86e5d82010-03-02 03:44:06 +0000423 Out << " " << MD->getQualifiedNameAsString() << " - (";
Anders Carlsson16b73122010-02-12 17:13:23 +0000424 Out << Overrider.Method->getQualifiedNameAsString();
Ken Dyck17d85192011-03-26 01:29:16 +0000425 Out << ", " << ", " << Overrider.Offset.getQuantity() << ')';
Anders Carlssond86e5d82010-03-02 03:44:06 +0000426
Anders Carlsson7097e752010-06-01 23:47:05 +0000427 BaseOffset Offset;
428 if (!Overrider.Method->isPure())
429 Offset = ComputeReturnAdjustmentBaseOffset(Context, Overrider.Method, MD);
Anders Carlssona4a54172010-02-13 20:41:15 +0000430
Anders Carlsson7097e752010-06-01 23:47:05 +0000431 if (!Offset.isEmpty()) {
Anders Carlssona4a54172010-02-13 20:41:15 +0000432 Out << " [ret-adj: ";
433 if (Offset.VirtualBase)
434 Out << Offset.VirtualBase->getQualifiedNameAsString() << " vbase, ";
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000435
Anders Carlssona4a54172010-02-13 20:41:15 +0000436 Out << Offset.NonVirtualOffset << " nv]";
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000437 }
Anders Carlssondf31af12010-02-13 23:17:31 +0000438
Anders Carlsson16b73122010-02-12 17:13:23 +0000439 Out << "\n";
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000440 }
441}
442
Anders Carlsson94464812010-04-10 19:13:06 +0000443/// VTableComponent - Represents a single component in a vtable.
444class VTableComponent {
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000445public:
446 enum Kind {
447 CK_VCallOffset,
448 CK_VBaseOffset,
449 CK_OffsetToTop,
450 CK_RTTI,
Anders Carlsson848fa642010-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 Carlsson1f464662010-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 Carlsson824d7ea2010-02-11 08:02:13 +0000463 };
464
Ken Dyckc40a3fd2011-04-02 01:14:48 +0000465 static VTableComponent MakeVCallOffset(CharUnits Offset) {
Anders Carlsson94464812010-04-10 19:13:06 +0000466 return VTableComponent(CK_VCallOffset, Offset);
Anders Carlssond9a67042010-02-17 06:07:19 +0000467 }
468
Ken Dyckc40a3fd2011-04-02 01:14:48 +0000469 static VTableComponent MakeVBaseOffset(CharUnits Offset) {
Anders Carlsson94464812010-04-10 19:13:06 +0000470 return VTableComponent(CK_VBaseOffset, Offset);
Anders Carlssona661a542010-02-16 04:49:44 +0000471 }
472
Ken Dyckc40a3fd2011-04-02 01:14:48 +0000473 static VTableComponent MakeOffsetToTop(CharUnits Offset) {
Anders Carlsson94464812010-04-10 19:13:06 +0000474 return VTableComponent(CK_OffsetToTop, Offset);
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000475 }
476
Anders Carlsson94464812010-04-10 19:13:06 +0000477 static VTableComponent MakeRTTI(const CXXRecordDecl *RD) {
478 return VTableComponent(CK_RTTI, reinterpret_cast<uintptr_t>(RD));
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000479 }
480
Anders Carlsson94464812010-04-10 19:13:06 +0000481 static VTableComponent MakeFunction(const CXXMethodDecl *MD) {
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000482 assert(!isa<CXXDestructorDecl>(MD) &&
Anders Carlsson848fa642010-02-11 18:20:28 +0000483 "Don't use MakeFunction with destructors!");
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000484
Anders Carlsson94464812010-04-10 19:13:06 +0000485 return VTableComponent(CK_FunctionPointer,
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000486 reinterpret_cast<uintptr_t>(MD));
487 }
488
Anders Carlsson94464812010-04-10 19:13:06 +0000489 static VTableComponent MakeCompleteDtor(const CXXDestructorDecl *DD) {
490 return VTableComponent(CK_CompleteDtorPointer,
Anders Carlsson848fa642010-02-11 18:20:28 +0000491 reinterpret_cast<uintptr_t>(DD));
492 }
493
Anders Carlsson94464812010-04-10 19:13:06 +0000494 static VTableComponent MakeDeletingDtor(const CXXDestructorDecl *DD) {
495 return VTableComponent(CK_DeletingDtorPointer,
Anders Carlsson848fa642010-02-11 18:20:28 +0000496 reinterpret_cast<uintptr_t>(DD));
497 }
498
Anders Carlsson94464812010-04-10 19:13:06 +0000499 static VTableComponent MakeUnusedFunction(const CXXMethodDecl *MD) {
Anders Carlsson1f464662010-02-19 20:08:13 +0000500 assert(!isa<CXXDestructorDecl>(MD) &&
501 "Don't use MakeUnusedFunction with destructors!");
Anders Carlsson94464812010-04-10 19:13:06 +0000502 return VTableComponent(CK_UnusedFunctionPointer,
Anders Carlsson1f464662010-02-19 20:08:13 +0000503 reinterpret_cast<uintptr_t>(MD));
504 }
505
Anders Carlsson94464812010-04-10 19:13:06 +0000506 static VTableComponent getFromOpaqueInteger(uint64_t I) {
507 return VTableComponent(I);
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +0000508 }
509
Anders Carlsson824d7ea2010-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
Ken Dyckc40a3fd2011-04-02 01:14:48 +0000515 CharUnits getVCallOffset() const {
Anders Carlssond9a67042010-02-17 06:07:19 +0000516 assert(getKind() == CK_VCallOffset && "Invalid component kind!");
517
518 return getOffset();
519 }
520
Ken Dyckc40a3fd2011-04-02 01:14:48 +0000521 CharUnits getVBaseOffset() const {
Anders Carlssona661a542010-02-16 04:49:44 +0000522 assert(getKind() == CK_VBaseOffset && "Invalid component kind!");
523
524 return getOffset();
525 }
526
Ken Dyckc40a3fd2011-04-02 01:14:48 +0000527 CharUnits getOffsetToTop() const {
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000528 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 Carlsson848fa642010-02-11 18:20:28 +0000540 assert(getKind() == CK_FunctionPointer);
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000541
542 return reinterpret_cast<CXXMethodDecl *>(getPointer());
543 }
Anders Carlsson848fa642010-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 Carlsson1f464662010-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 Carlsson824d7ea2010-02-11 08:02:13 +0000558private:
Ken Dyckc40a3fd2011-04-02 01:14:48 +0000559 VTableComponent(Kind ComponentKind, CharUnits Offset) {
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000560 assert((ComponentKind == CK_VCallOffset ||
561 ComponentKind == CK_VBaseOffset ||
562 ComponentKind == CK_OffsetToTop) && "Invalid component kind!");
Ken Dyckc40a3fd2011-04-02 01:14:48 +0000563 assert(Offset.getQuantity() <= ((1LL << 56) - 1) && "Offset is too big!");
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000564
Ken Dyckc40a3fd2011-04-02 01:14:48 +0000565 Value = ((Offset.getQuantity() << 3) | ComponentKind);
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000566 }
567
Anders Carlsson94464812010-04-10 19:13:06 +0000568 VTableComponent(Kind ComponentKind, uintptr_t Ptr) {
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000569 assert((ComponentKind == CK_RTTI ||
Anders Carlsson848fa642010-02-11 18:20:28 +0000570 ComponentKind == CK_FunctionPointer ||
571 ComponentKind == CK_CompleteDtorPointer ||
Anders Carlsson1f464662010-02-19 20:08:13 +0000572 ComponentKind == CK_DeletingDtorPointer ||
573 ComponentKind == CK_UnusedFunctionPointer) &&
Anders Carlsson824d7ea2010-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
Ken Dyckc40a3fd2011-04-02 01:14:48 +0000581 CharUnits getOffset() const {
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000582 assert((getKind() == CK_VCallOffset || getKind() == CK_VBaseOffset ||
583 getKind() == CK_OffsetToTop) && "Invalid component kind!");
584
Ken Dyckc40a3fd2011-04-02 01:14:48 +0000585 return CharUnits::fromQuantity(Value >> 3);
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000586 }
587
588 uintptr_t getPointer() const {
Anders Carlsson848fa642010-02-11 18:20:28 +0000589 assert((getKind() == CK_RTTI ||
590 getKind() == CK_FunctionPointer ||
591 getKind() == CK_CompleteDtorPointer ||
Anders Carlsson1f464662010-02-19 20:08:13 +0000592 getKind() == CK_DeletingDtorPointer ||
593 getKind() == CK_UnusedFunctionPointer) &&
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000594 "Invalid component kind!");
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000595
596 return static_cast<uintptr_t>(Value & ~7ULL);
597 }
598
Anders Carlsson94464812010-04-10 19:13:06 +0000599 explicit VTableComponent(uint64_t Value)
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +0000600 : Value(Value) { }
601
Anders Carlsson824d7ea2010-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 Carlsson60cc72a2010-02-18 17:00:09 +0000610/// VCallOffsetMap - Keeps track of vcall offsets when building a vtable.
611struct VCallOffsetMap {
612
Ken Dyckc952d382011-04-02 00:51:15 +0000613 typedef std::pair<const CXXMethodDecl *, CharUnits> MethodAndOffsetPairTy;
Anders Carlsson60cc72a2010-02-18 17:00:09 +0000614
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 Carlssoneb577d02010-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 Carlsson60cc72a2010-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.
Ken Dyckc952d382011-04-02 00:51:15 +0000628 bool AddVCallOffset(const CXXMethodDecl *MD, CharUnits OffsetOffset);
Anders Carlsson60cc72a2010-02-18 17:00:09 +0000629
630 /// getVCallOffsetOffset - Returns the vcall offset offset (relative to the
631 /// vtable address point) for the given virtual member function.
Ken Dyckc952d382011-04-02 00:51:15 +0000632 CharUnits getVCallOffsetOffset(const CXXMethodDecl *MD);
Anders Carlsson60cc72a2010-02-18 17:00:09 +0000633
Anders Carlssondba6ef82010-02-25 22:23:13 +0000634 // empty - Return whether the offset map is empty or not.
635 bool empty() const { return Offsets.empty(); }
Anders Carlsson60cc72a2010-02-18 17:00:09 +0000636};
637
John McCall331a03a2010-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 Carlssoneb577d02010-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 Carlsson55609692010-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 Carlssoneb577d02010-02-18 17:26:40 +0000669 // FIXME: We need to check more things here.
670
Anders Carlsson55609692010-02-27 04:12:52 +0000671 // The methods must have the same name.
Anders Carlssoneb577d02010-02-18 17:26:40 +0000672 DeclarationName LHSName = LHS->getDeclName();
673 DeclarationName RHSName = RHS->getDeclName();
John McCall331a03a2010-02-26 20:22:44 +0000674 if (LHSName != RHSName)
Anders Carlssoneb577d02010-02-18 17:26:40 +0000675 return false;
John McCall331a03a2010-02-26 20:22:44 +0000676
Anders Carlsson55609692010-02-27 04:12:52 +0000677 // And the same signatures.
678 return HasSameVirtualSignature(LHS, RHS);
Anders Carlssoneb577d02010-02-18 17:26:40 +0000679}
680
Anders Carlsson60cc72a2010-02-18 17:00:09 +0000681bool VCallOffsetMap::AddVCallOffset(const CXXMethodDecl *MD,
Ken Dyckc952d382011-04-02 00:51:15 +0000682 CharUnits OffsetOffset) {
Anders Carlssoneb577d02010-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 Carlsson60cc72a2010-02-18 17:00:09 +0000691 return true;
692}
693
Ken Dyckc952d382011-04-02 00:51:15 +0000694CharUnits VCallOffsetMap::getVCallOffsetOffset(const CXXMethodDecl *MD) {
Anders Carlssoneb577d02010-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!");
Ken Dyckc952d382011-04-02 00:51:15 +0000702 return CharUnits::Zero();
Anders Carlsson60cc72a2010-02-18 17:00:09 +0000703}
704
Anders Carlssond68c0832010-02-25 03:45:56 +0000705/// VCallAndVBaseOffsetBuilder - Class for building vcall and vbase offsets.
706class VCallAndVBaseOffsetBuilder {
Anders Carlssonc89a7cf2010-03-11 16:06:20 +0000707public:
708 typedef llvm::DenseMap<const CXXRecordDecl *, int64_t>
709 VBaseOffsetOffsetsMapTy;
710
711private:
Anders Carlsson530c40c2010-02-28 01:43:58 +0000712 /// MostDerivedClass - The most derived class for which we're building vcall
713 /// and vbase offsets.
Anders Carlssond68c0832010-02-25 03:45:56 +0000714 const CXXRecordDecl *MostDerivedClass;
715
Anders Carlsson0041a642010-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 Carlssond68c0832010-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 Carlsson94464812010-04-10 19:13:06 +0000725 typedef llvm::SmallVector<VTableComponent, 64> VTableComponentVectorTy;
726 VTableComponentVectorTy Components;
Anders Carlssond68c0832010-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 Carlssonbb6305b2010-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 Carlssond68c0832010-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 Dyckf38d8ae2011-03-31 00:37:24 +0000746 CharUnits RealBaseOffset);
Anders Carlssond68c0832010-02-25 03:45:56 +0000747
748 /// AddVCallOffsets - Add vcall offsets for the given base subobject.
Ken Dyck301af862011-03-30 10:11:40 +0000749 void AddVCallOffsets(BaseSubobject Base, CharUnits VBaseOffset);
Anders Carlssond68c0832010-02-25 03:45:56 +0000750
751 /// AddVBaseOffsets - Add vbase offsets for the given class.
Ken Dyckbb625e92011-03-31 00:56:47 +0000752 void AddVBaseOffsets(const CXXRecordDecl *Base,
753 CharUnits OffsetInLayoutClass);
Anders Carlssond68c0832010-02-25 03:45:56 +0000754
Anders Carlssonbb6305b2010-03-11 06:43:12 +0000755 /// getCurrentOffsetOffset - Get the current vcall or vbase offset offset in
Ken Dyck3ed994b2011-03-31 01:08:46 +0000756 /// chars, relative to the vtable address point.
757 CharUnits getCurrentOffsetOffset() const;
Anders Carlssonbb6305b2010-03-11 06:43:12 +0000758
Anders Carlssond68c0832010-02-25 03:45:56 +0000759public:
760 VCallAndVBaseOffsetBuilder(const CXXRecordDecl *MostDerivedClass,
Anders Carlsson0041a642010-02-27 21:09:00 +0000761 const CXXRecordDecl *LayoutClass,
Anders Carlssond68c0832010-02-25 03:45:56 +0000762 const FinalOverriders *Overriders,
Anders Carlsson530c40c2010-02-28 01:43:58 +0000763 BaseSubobject Base, bool BaseIsVirtual,
Ken Dyck3ecfa2d2011-03-31 00:48:04 +0000764 CharUnits OffsetInLayoutClass)
Anders Carlsson530c40c2010-02-28 01:43:58 +0000765 : MostDerivedClass(MostDerivedClass), LayoutClass(LayoutClass),
Anders Carlssond68c0832010-02-25 03:45:56 +0000766 Context(MostDerivedClass->getASTContext()), Overriders(Overriders) {
767
768 // Add vcall and vbase offsets.
Ken Dyck3ecfa2d2011-03-31 00:48:04 +0000769 AddVCallAndVBaseOffsets(Base, BaseIsVirtual, OffsetInLayoutClass);
Anders Carlssond68c0832010-02-25 03:45:56 +0000770 }
771
772 /// Methods for iterating over the components.
Anders Carlsson94464812010-04-10 19:13:06 +0000773 typedef VTableComponentVectorTy::const_reverse_iterator const_iterator;
Anders Carlssond68c0832010-02-25 03:45:56 +0000774 const_iterator components_begin() const { return Components.rbegin(); }
775 const_iterator components_end() const { return Components.rend(); }
776
Anders Carlssonc89a7cf2010-03-11 16:06:20 +0000777 const VCallOffsetMap &getVCallOffsets() const { return VCallOffsets; }
778 const VBaseOffsetOffsetsMapTy &getVBaseOffsetOffsets() const {
Anders Carlssonbb6305b2010-03-11 06:43:12 +0000779 return VBaseOffsetOffsets;
780 }
Anders Carlssond68c0832010-02-25 03:45:56 +0000781};
782
783void
784VCallAndVBaseOffsetBuilder::AddVCallAndVBaseOffsets(BaseSubobject Base,
785 bool BaseIsVirtual,
Ken Dyckf38d8ae2011-03-31 00:37:24 +0000786 CharUnits RealBaseOffset) {
Anders Carlssond68c0832010-02-25 03:45:56 +0000787 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Base.getBase());
788
789 // Itanium C++ ABI 2.5.2:
790 // ..in classes sharing a virtual table with a primary base class, the vcall
791 // and vbase offsets added by the derived class all come before the vcall
792 // and vbase offsets required by the base class, so that the latter may be
793 // laid out as required by the base class without regard to additions from
794 // the derived class(es).
795
796 // (Since we're emitting the vcall and vbase offsets in reverse order, we'll
797 // emit them for the primary base first).
798 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
Anders Carlssonc9e814b2010-11-24 23:12:57 +0000799 bool PrimaryBaseIsVirtual = Layout.isPrimaryBaseVirtual();
Anders Carlssond68c0832010-02-25 03:45:56 +0000800
Ken Dyck57ebe332011-03-26 00:51:24 +0000801 CharUnits PrimaryBaseOffset;
Anders Carlssond68c0832010-02-25 03:45:56 +0000802
803 // Get the base offset of the primary base.
804 if (PrimaryBaseIsVirtual) {
Anders Carlssona14f5972010-10-31 23:22:37 +0000805 assert(Layout.getVBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlssond68c0832010-02-25 03:45:56 +0000806 "Primary vbase should have a zero offset!");
807
808 const ASTRecordLayout &MostDerivedClassLayout =
809 Context.getASTRecordLayout(MostDerivedClass);
810
811 PrimaryBaseOffset =
Ken Dyck57ebe332011-03-26 00:51:24 +0000812 MostDerivedClassLayout.getVBaseClassOffset(PrimaryBase);
Anders Carlssond68c0832010-02-25 03:45:56 +0000813 } else {
Anders Carlssona14f5972010-10-31 23:22:37 +0000814 assert(Layout.getBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlssond68c0832010-02-25 03:45:56 +0000815 "Primary base should have a zero offset!");
816
Ken Dyck57ebe332011-03-26 00:51:24 +0000817 PrimaryBaseOffset = Base.getBaseOffset();
Anders Carlssond68c0832010-02-25 03:45:56 +0000818 }
819
Ken Dyck4230d522011-03-24 01:21:01 +0000820 AddVCallAndVBaseOffsets(
Ken Dyck57ebe332011-03-26 00:51:24 +0000821 BaseSubobject(PrimaryBase,PrimaryBaseOffset),
Ken Dyck4230d522011-03-24 01:21:01 +0000822 PrimaryBaseIsVirtual, RealBaseOffset);
Anders Carlssond68c0832010-02-25 03:45:56 +0000823 }
824
Ken Dyckbb625e92011-03-31 00:56:47 +0000825 AddVBaseOffsets(Base.getBase(), RealBaseOffset);
Anders Carlssond68c0832010-02-25 03:45:56 +0000826
827 // We only want to add vcall offsets for virtual bases.
828 if (BaseIsVirtual)
Ken Dyckf38d8ae2011-03-31 00:37:24 +0000829 AddVCallOffsets(Base, RealBaseOffset);
Anders Carlssond68c0832010-02-25 03:45:56 +0000830}
831
Ken Dyck3ed994b2011-03-31 01:08:46 +0000832CharUnits VCallAndVBaseOffsetBuilder::getCurrentOffsetOffset() const {
Anders Carlssonbb6305b2010-03-11 06:43:12 +0000833 // OffsetIndex is the index of this vcall or vbase offset, relative to the
834 // vtable address point. (We subtract 3 to account for the information just
835 // above the address point, the RTTI info, the offset to top, and the
836 // vcall offset itself).
837 int64_t OffsetIndex = -(int64_t)(3 + Components.size());
838
Ken Dyck3ed994b2011-03-31 01:08:46 +0000839 CharUnits PointerWidth =
840 Context.toCharUnitsFromBits(Context.Target.getPointerWidth(0));
841 CharUnits OffsetOffset = PointerWidth * OffsetIndex;
Anders Carlssonbb6305b2010-03-11 06:43:12 +0000842 return OffsetOffset;
843}
844
Anders Carlssond68c0832010-02-25 03:45:56 +0000845void VCallAndVBaseOffsetBuilder::AddVCallOffsets(BaseSubobject Base,
Ken Dyck301af862011-03-30 10:11:40 +0000846 CharUnits VBaseOffset) {
Anders Carlssond68c0832010-02-25 03:45:56 +0000847 const CXXRecordDecl *RD = Base.getBase();
848 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
849
John McCall331a03a2010-02-26 20:22:44 +0000850 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
851
Anders Carlssond68c0832010-02-25 03:45:56 +0000852 // Handle the primary base first.
Anders Carlssonaf6ddf22010-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 Carlssonc9e814b2010-11-24 23:12:57 +0000855 if (PrimaryBase && !Layout.isPrimaryBaseVirtual()) {
Anders Carlssond68c0832010-02-25 03:45:56 +0000856 // Get the base offset of the primary base.
Anders Carlssona14f5972010-10-31 23:22:37 +0000857 assert(Layout.getBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlssonaf6ddf22010-04-11 20:04:11 +0000858 "Primary base should have a zero offset!");
Anders Carlssond68c0832010-02-25 03:45:56 +0000859
Anders Carlssonaf6ddf22010-04-11 20:04:11 +0000860 AddVCallOffsets(BaseSubobject(PrimaryBase, Base.getBaseOffset()),
Anders Carlssond68c0832010-02-25 03:45:56 +0000861 VBaseOffset);
862 }
Anders Carlssonaf6ddf22010-04-11 20:04:11 +0000863
Anders Carlssond68c0832010-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
Ken Dyck3ed994b2011-03-31 01:08:46 +0000872 CharUnits OffsetOffset = getCurrentOffsetOffset();
Anders Carlssond68c0832010-02-25 03:45:56 +0000873
874 // Don't add a vcall offset if we already have one for this member function
875 // signature.
Ken Dyckc952d382011-04-02 00:51:15 +0000876 if (!VCallOffsets.AddVCallOffset(MD, OffsetOffset))
Anders Carlssond68c0832010-02-25 03:45:56 +0000877 continue;
878
Ken Dyck0c64b7d2011-03-30 01:21:33 +0000879 CharUnits Offset = CharUnits::Zero();
Anders Carlssond68c0832010-02-25 03:45:56 +0000880
881 if (Overriders) {
882 // Get the final overrider.
883 FinalOverriders::OverriderInfo Overrider =
Ken Dycke6203132011-03-26 01:18:17 +0000884 Overriders->getOverrider(MD, Base.getBaseOffset());
Anders Carlssond68c0832010-02-25 03:45:56 +0000885
Anders Carlsson438bc422010-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 Dyck301af862011-03-30 10:11:40 +0000888 Offset = Overrider.Offset - VBaseOffset;
Anders Carlssond68c0832010-02-25 03:45:56 +0000889 }
890
Ken Dyck0c64b7d2011-03-30 01:21:33 +0000891 Components.push_back(
Ken Dyckc40a3fd2011-04-02 01:14:48 +0000892 VTableComponent::MakeVCallOffset(Offset));
Anders Carlssond68c0832010-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 McCall331a03a2010-02-26 20:22:44 +0000904 if (BaseDecl == PrimaryBase)
905 continue;
Anders Carlssond68c0832010-02-25 03:45:56 +0000906
907 // Get the base offset of this base.
Ken Dyck57ebe332011-03-26 00:51:24 +0000908 CharUnits BaseOffset = Base.getBaseOffset() +
909 Layout.getBaseClassOffset(BaseDecl);
Anders Carlssond68c0832010-02-25 03:45:56 +0000910
Ken Dyck57ebe332011-03-26 00:51:24 +0000911 AddVCallOffsets(BaseSubobject(BaseDecl, BaseOffset),
912 VBaseOffset);
Anders Carlssond68c0832010-02-25 03:45:56 +0000913 }
914}
915
Ken Dyckbb625e92011-03-31 00:56:47 +0000916void
917VCallAndVBaseOffsetBuilder::AddVBaseOffsets(const CXXRecordDecl *RD,
918 CharUnits OffsetInLayoutClass) {
Anders Carlsson0041a642010-02-27 21:09:00 +0000919 const ASTRecordLayout &LayoutClassLayout =
920 Context.getASTRecordLayout(LayoutClass);
Anders Carlssond68c0832010-02-25 03:45:56 +0000921
922 // Add vbase offsets.
923 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
924 E = RD->bases_end(); I != E; ++I) {
925 const CXXRecordDecl *BaseDecl =
926 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
927
928 // Check if this is a virtual base that we haven't visited before.
929 if (I->isVirtual() && VisitedVirtualBases.insert(BaseDecl)) {
Ken Dyckbb625e92011-03-31 00:56:47 +0000930 CharUnits Offset =
931 LayoutClassLayout.getVBaseClassOffset(BaseDecl) - OffsetInLayoutClass;
Anders Carlssonbb6305b2010-03-11 06:43:12 +0000932
933 // Add the vbase offset offset.
934 assert(!VBaseOffsetOffsets.count(BaseDecl) &&
935 "vbase offset offset already exists!");
936
Ken Dyck3ed994b2011-03-31 01:08:46 +0000937 CharUnits VBaseOffsetOffset = getCurrentOffsetOffset();
938 VBaseOffsetOffsets.insert(
939 std::make_pair(BaseDecl, VBaseOffsetOffset.getQuantity()));
Anders Carlssonbb6305b2010-03-11 06:43:12 +0000940
Ken Dyckbb625e92011-03-31 00:56:47 +0000941 Components.push_back(
Ken Dyckc40a3fd2011-04-02 01:14:48 +0000942 VTableComponent::MakeVBaseOffset(Offset));
Anders Carlssond68c0832010-02-25 03:45:56 +0000943 }
Anders Carlssonbb6305b2010-03-11 06:43:12 +0000944
Anders Carlssond68c0832010-02-25 03:45:56 +0000945 // Check the base class looking for more vbase offsets.
Anders Carlsson88800662010-03-02 05:40:45 +0000946 AddVBaseOffsets(BaseDecl, OffsetInLayoutClass);
Anders Carlssond68c0832010-02-25 03:45:56 +0000947 }
948}
949
Anders Carlsson94464812010-04-10 19:13:06 +0000950/// VTableBuilder - Class for building vtable layout information.
951class VTableBuilder {
Anders Carlsson57071e22010-02-12 05:25:12 +0000952public:
Anders Carlssonb9021e92010-02-27 16:18:19 +0000953 /// PrimaryBasesSetVectorTy - A set vector of direct and indirect
954 /// primary bases.
955 typedef llvm::SmallSetVector<const CXXRecordDecl *, 8>
956 PrimaryBasesSetVectorTy;
957
Anders Carlssonccd83d72010-03-24 16:42:11 +0000958 typedef llvm::DenseMap<const CXXRecordDecl *, int64_t>
959 VBaseOffsetOffsetsMapTy;
Anders Carlsson66d567d2010-03-25 00:51:13 +0000960
961 typedef llvm::DenseMap<BaseSubobject, uint64_t>
962 AddressPointsMapTy;
Anders Carlssonccd83d72010-03-24 16:42:11 +0000963
Anders Carlsson57071e22010-02-12 05:25:12 +0000964private:
Anders Carlssonaf440352010-03-23 04:11:45 +0000965 /// VTables - Global vtable information.
966 CodeGenVTables &VTables;
Anders Carlsson60db0ee2010-02-13 21:07:32 +0000967
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000968 /// MostDerivedClass - The most derived class for which we're building this
969 /// vtable.
970 const CXXRecordDecl *MostDerivedClass;
971
Anders Carlssond03a3262010-02-27 20:39:05 +0000972 /// MostDerivedClassOffset - If we're building a construction vtable, this
973 /// holds the offset from the layout class to the most derived class.
Ken Dyck23da84a2011-03-27 20:20:28 +0000974 const CharUnits MostDerivedClassOffset;
Anders Carlssond03a3262010-02-27 20:39:05 +0000975
Anders Carlsson5d7af6b2010-02-28 00:36:23 +0000976 /// MostDerivedClassIsVirtual - Whether the most derived class is a virtual
977 /// base. (This only makes sense when building a construction vtable).
978 bool MostDerivedClassIsVirtual;
979
Anders Carlssond03a3262010-02-27 20:39:05 +0000980 /// LayoutClass - The class we're using for layout information. Will be
981 /// different than the most derived class if we're building a construction
982 /// vtable.
983 const CXXRecordDecl *LayoutClass;
984
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000985 /// Context - The ASTContext which we will use for layout information.
Anders Carlsson57071e22010-02-12 05:25:12 +0000986 ASTContext &Context;
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000987
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000988 /// FinalOverriders - The final overriders of the most derived class.
Anders Carlssond68c0832010-02-25 03:45:56 +0000989 const FinalOverriders Overriders;
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000990
Anders Carlssondba6ef82010-02-25 22:23:13 +0000991 /// VCallOffsetsForVBases - Keeps track of vcall offsets for the virtual
992 /// bases in this vtable.
993 llvm::DenseMap<const CXXRecordDecl *, VCallOffsetMap> VCallOffsetsForVBases;
Anders Carlsson60cc72a2010-02-18 17:00:09 +0000994
Anders Carlssonbb6305b2010-03-11 06:43:12 +0000995 /// VBaseOffsetOffsets - Contains the offsets of the virtual base offsets for
996 /// the most derived class.
997 VBaseOffsetOffsetsMapTy VBaseOffsetOffsets;
998
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000999 /// Components - The components of the vtable being built.
Anders Carlsson94464812010-04-10 19:13:06 +00001000 llvm::SmallVector<VTableComponent, 64> Components;
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001001
Anders Carlsson822307b2010-02-11 17:18:51 +00001002 /// AddressPoints - Address points for the vtable being built.
Anders Carlssonff143f82010-03-25 00:35:49 +00001003 AddressPointsMapTy AddressPoints;
Anders Carlsson822307b2010-02-11 17:18:51 +00001004
Anders Carlssonb9021e92010-02-27 16:18:19 +00001005 /// MethodInfo - Contains information about a method in a vtable.
1006 /// (Used for computing 'this' pointer adjustment thunks.
1007 struct MethodInfo {
1008 /// BaseOffset - The base offset of this method.
Ken Dyck82abeae2011-03-27 18:57:53 +00001009 const CharUnits BaseOffset;
Anders Carlssonb9021e92010-02-27 16:18:19 +00001010
Anders Carlsson2bc1d3a2010-03-10 21:25:37 +00001011 /// BaseOffsetInLayoutClass - The base offset in the layout class of this
1012 /// method.
Ken Dyck82abeae2011-03-27 18:57:53 +00001013 const CharUnits BaseOffsetInLayoutClass;
Anders Carlsson2bc1d3a2010-03-10 21:25:37 +00001014
Anders Carlsson718d0692010-04-11 22:07:06 +00001015 /// VTableIndex - The index in the vtable that this method has.
Anders Carlssonb9021e92010-02-27 16:18:19 +00001016 /// (For destructors, this is the index of the complete destructor).
Anders Carlsson718d0692010-04-11 22:07:06 +00001017 const uint64_t VTableIndex;
Anders Carlssonb9021e92010-02-27 16:18:19 +00001018
Ken Dyck82abeae2011-03-27 18:57:53 +00001019 MethodInfo(CharUnits BaseOffset, CharUnits BaseOffsetInLayoutClass,
Anders Carlsson718d0692010-04-11 22:07:06 +00001020 uint64_t VTableIndex)
Anders Carlsson2bc1d3a2010-03-10 21:25:37 +00001021 : BaseOffset(BaseOffset),
1022 BaseOffsetInLayoutClass(BaseOffsetInLayoutClass),
Anders Carlsson718d0692010-04-11 22:07:06 +00001023 VTableIndex(VTableIndex) { }
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001024
Ken Dyck82abeae2011-03-27 18:57:53 +00001025 MethodInfo()
1026 : BaseOffset(CharUnits::Zero()),
1027 BaseOffsetInLayoutClass(CharUnits::Zero()),
1028 VTableIndex(0) { }
Anders Carlssonb9021e92010-02-27 16:18:19 +00001029 };
1030
1031 typedef llvm::DenseMap<const CXXMethodDecl *, MethodInfo> MethodInfoMapTy;
1032
1033 /// MethodInfoMap - The information for all methods in the vtable we're
1034 /// currently building.
1035 MethodInfoMapTy MethodInfoMap;
1036
Anders Carlsson718d0692010-04-11 22:07:06 +00001037 typedef llvm::DenseMap<uint64_t, ThunkInfo> VTableThunksMapTy;
Anders Carlssondd366812010-03-12 04:54:20 +00001038
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00001039 /// VTableThunks - The thunks by vtable index in the vtable currently being
1040 /// built.
Anders Carlsson718d0692010-04-11 22:07:06 +00001041 VTableThunksMapTy VTableThunks;
Anders Carlssonb9021e92010-02-27 16:18:19 +00001042
Anders Carlssonee5ab9f2010-03-23 04:59:02 +00001043 typedef llvm::SmallVector<ThunkInfo, 1> ThunkInfoVectorTy;
1044 typedef llvm::DenseMap<const CXXMethodDecl *, ThunkInfoVectorTy> ThunksMapTy;
Anders Carlsson5e454aa2010-03-17 20:06:32 +00001045
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00001046 /// Thunks - A map that contains all the thunks needed for all methods in the
1047 /// most derived class for which the vtable is currently being built.
Anders Carlssonee5ab9f2010-03-23 04:59:02 +00001048 ThunksMapTy Thunks;
Anders Carlsson5e454aa2010-03-17 20:06:32 +00001049
1050 /// AddThunk - Add a thunk for the given method.
Anders Carlsson9d734f32010-03-21 20:27:14 +00001051 void AddThunk(const CXXMethodDecl *MD, const ThunkInfo &Thunk);
Anders Carlsson5e454aa2010-03-17 20:06:32 +00001052
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001053 /// ComputeThisAdjustments - Compute the 'this' pointer adjustments for the
1054 /// part of the vtable we're currently building.
1055 void ComputeThisAdjustments();
1056
Anders Carlssona661a542010-02-16 04:49:44 +00001057 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
1058
Anders Carlssonb9021e92010-02-27 16:18:19 +00001059 /// PrimaryVirtualBases - All known virtual bases who are a primary base of
Anders Carlssonaf280c02010-02-23 03:48:14 +00001060 /// some other base.
1061 VisitedVirtualBasesSetTy PrimaryVirtualBases;
1062
Anders Carlsson60db0ee2010-02-13 21:07:32 +00001063 /// ComputeReturnAdjustment - Compute the return adjustment given a return
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001064 /// adjustment base offset.
Anders Carlsson2fca9be2010-02-23 01:34:28 +00001065 ReturnAdjustment ComputeReturnAdjustment(BaseOffset Offset);
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001066
Anders Carlsson379017f2010-02-27 19:57:44 +00001067 /// ComputeThisAdjustmentBaseOffset - Compute the base offset for adjusting
1068 /// the 'this' pointer from the base subobject to the derived subobject.
1069 BaseOffset ComputeThisAdjustmentBaseOffset(BaseSubobject Base,
1070 BaseSubobject Derived) const;
1071
Anders Carlsson60cc72a2010-02-18 17:00:09 +00001072 /// ComputeThisAdjustment - Compute the 'this' pointer adjustment for the
Anders Carlsson617def32010-03-12 05:28:07 +00001073 /// given virtual member function, its offset in the layout class and its
1074 /// final overrider.
1075 ThisAdjustment
1076 ComputeThisAdjustment(const CXXMethodDecl *MD,
Ken Dyck0e55ade2011-03-27 19:03:44 +00001077 CharUnits BaseOffsetInLayoutClass,
Anders Carlsson617def32010-03-12 05:28:07 +00001078 FinalOverriders::OverriderInfo Overrider);
1079
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001080 /// AddMethod - Add a single virtual member function to the vtable
1081 /// components vector.
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001082 void AddMethod(const CXXMethodDecl *MD, ReturnAdjustment ReturnAdjustment);
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001083
Anders Carlsson464c8f12010-02-23 04:26:39 +00001084 /// IsOverriderUsed - Returns whether the overrider will ever be used in this
1085 /// part of the vtable.
1086 ///
1087 /// Itanium C++ ABI 2.5.2:
1088 ///
1089 /// struct A { virtual void f(); };
1090 /// struct B : virtual public A { int i; };
1091 /// struct C : virtual public A { int j; };
1092 /// struct D : public B, public C {};
1093 ///
1094 /// When B and C are declared, A is a primary base in each case, so although
1095 /// vcall offsets are allocated in the A-in-B and A-in-C vtables, no this
1096 /// adjustment is required and no thunk is generated. However, inside D
1097 /// objects, A is no longer a primary base of C, so if we allowed calls to
1098 /// C::f() to use the copy of A's vtable in the C subobject, we would need
1099 /// to adjust this from C* to B::A*, which would require a third-party
1100 /// thunk. Since we require that a call to C::f() first convert to A*,
1101 /// C-in-D's copy of A's vtable is never referenced, so this is not
1102 /// necessary.
Anders Carlsson60396612010-03-10 06:51:42 +00001103 bool IsOverriderUsed(const CXXMethodDecl *Overrider,
Ken Dyck413e7d22011-04-02 00:44:58 +00001104 CharUnits BaseOffsetInLayoutClass,
Anders Carlsson60396612010-03-10 06:51:42 +00001105 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
Ken Dyck413e7d22011-04-02 00:44:58 +00001106 CharUnits FirstBaseOffsetInLayoutClass) const;
Anders Carlsson60396612010-03-10 06:51:42 +00001107
Anders Carlsson464c8f12010-02-23 04:26:39 +00001108
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001109 /// AddMethods - Add the methods of this base subobject and all its
1110 /// primary bases to the vtable components vector.
Ken Dyck3a726802011-03-27 19:15:11 +00001111 void AddMethods(BaseSubobject Base, CharUnits BaseOffsetInLayoutClass,
Anders Carlsson60396612010-03-10 06:51:42 +00001112 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
Ken Dyck3a726802011-03-27 19:15:11 +00001113 CharUnits FirstBaseOffsetInLayoutClass,
Anders Carlssonb9021e92010-02-27 16:18:19 +00001114 PrimaryBasesSetVectorTy &PrimaryBases);
Anders Carlsson89ad4212010-02-16 16:26:28 +00001115
Anders Carlsson718d0692010-04-11 22:07:06 +00001116 // LayoutVTable - Layout the vtable for the given base class, including its
Anders Carlsson89ad4212010-02-16 16:26:28 +00001117 // secondary vtables and any vtables for virtual bases.
Anders Carlsson718d0692010-04-11 22:07:06 +00001118 void LayoutVTable();
Anders Carlsson89ad4212010-02-16 16:26:28 +00001119
Anders Carlsson718d0692010-04-11 22:07:06 +00001120 /// LayoutPrimaryAndSecondaryVTables - Layout the primary vtable for the
Anders Carlsson89ad4212010-02-16 16:26:28 +00001121 /// given base subobject, as well as all its secondary vtables.
Anders Carlsson91232842010-04-11 22:03:57 +00001122 ///
Anders Carlsson73e6fa02010-04-11 22:20:36 +00001123 /// \param BaseIsMorallyVirtual whether the base subobject is a virtual base
1124 /// or a direct or indirect base of a virtual base.
1125 ///
Anders Carlsson91232842010-04-11 22:03:57 +00001126 /// \param BaseIsVirtualInLayoutClass - Whether the base subobject is virtual
1127 /// in the layout class.
Anders Carlsson718d0692010-04-11 22:07:06 +00001128 void LayoutPrimaryAndSecondaryVTables(BaseSubobject Base,
Anders Carlsson73e6fa02010-04-11 22:20:36 +00001129 bool BaseIsMorallyVirtual,
Anders Carlsson91232842010-04-11 22:03:57 +00001130 bool BaseIsVirtualInLayoutClass,
Ken Dyck7ba8f522011-03-27 20:33:38 +00001131 CharUnits OffsetInLayoutClass);
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001132
Anders Carlsson718d0692010-04-11 22:07:06 +00001133 /// LayoutSecondaryVTables - Layout the secondary vtables for the given base
Anders Carlssonc7b63162010-02-16 16:02:57 +00001134 /// subobject.
Anders Carlssona96a2e92010-03-10 19:39:11 +00001135 ///
1136 /// \param BaseIsMorallyVirtual whether the base subobject is a virtual base
1137 /// or a direct or indirect base of a virtual base.
Anders Carlsson718d0692010-04-11 22:07:06 +00001138 void LayoutSecondaryVTables(BaseSubobject Base, bool BaseIsMorallyVirtual,
Ken Dyck75762b32011-03-30 00:50:28 +00001139 CharUnits OffsetInLayoutClass);
Anders Carlsson08c26752010-02-27 04:05:52 +00001140
1141 /// DeterminePrimaryVirtualBases - Determine the primary virtual bases in this
1142 /// class hierarchy.
1143 void DeterminePrimaryVirtualBases(const CXXRecordDecl *RD,
Ken Dyck8fe59932011-03-30 01:10:23 +00001144 CharUnits OffsetInLayoutClass,
Anders Carlsson08c26752010-02-27 04:05:52 +00001145 VisitedVirtualBasesSetTy &VBases);
1146
Anders Carlsson718d0692010-04-11 22:07:06 +00001147 /// LayoutVTablesForVirtualBases - Layout vtables for all virtual bases of the
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001148 /// given base (excluding any primary bases).
Anders Carlsson718d0692010-04-11 22:07:06 +00001149 void LayoutVTablesForVirtualBases(const CXXRecordDecl *RD,
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001150 VisitedVirtualBasesSetTy &VBases);
1151
Anders Carlsson718d0692010-04-11 22:07:06 +00001152 /// isBuildingConstructionVTable - Return whether this vtable builder is
Anders Carlsson438bc422010-02-28 00:10:58 +00001153 /// building a construction vtable.
Anders Carlsson718d0692010-04-11 22:07:06 +00001154 bool isBuildingConstructorVTable() const {
Anders Carlsson438bc422010-02-28 00:10:58 +00001155 return MostDerivedClass != LayoutClass;
1156 }
1157
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001158public:
Anders Carlsson94464812010-04-10 19:13:06 +00001159 VTableBuilder(CodeGenVTables &VTables, const CXXRecordDecl *MostDerivedClass,
Ken Dyck23da84a2011-03-27 20:20:28 +00001160 CharUnits MostDerivedClassOffset,
1161 bool MostDerivedClassIsVirtual, const
1162 CXXRecordDecl *LayoutClass)
Anders Carlssonaf440352010-03-23 04:11:45 +00001163 : VTables(VTables), MostDerivedClass(MostDerivedClass),
Anders Carlsson5d7af6b2010-02-28 00:36:23 +00001164 MostDerivedClassOffset(MostDerivedClassOffset),
1165 MostDerivedClassIsVirtual(MostDerivedClassIsVirtual),
1166 LayoutClass(LayoutClass), Context(MostDerivedClass->getASTContext()),
Ken Dyck23da84a2011-03-27 20:20:28 +00001167 Overriders(MostDerivedClass, MostDerivedClassOffset, LayoutClass) {
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001168
Anders Carlsson718d0692010-04-11 22:07:06 +00001169 LayoutVTable();
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001170 }
1171
Anders Carlssonfbf6ed42010-03-23 16:36:50 +00001172 ThunksMapTy::const_iterator thunks_begin() const {
1173 return Thunks.begin();
1174 }
1175
1176 ThunksMapTy::const_iterator thunks_end() const {
1177 return Thunks.end();
1178 }
1179
Anders Carlssonccd83d72010-03-24 16:42:11 +00001180 const VBaseOffsetOffsetsMapTy &getVBaseOffsetOffsets() const {
1181 return VBaseOffsetOffsets;
1182 }
1183
1184 /// getNumVTableComponents - Return the number of components in the vtable
1185 /// currently built.
1186 uint64_t getNumVTableComponents() const {
1187 return Components.size();
1188 }
1189
Anders Carlsson66d567d2010-03-25 00:51:13 +00001190 const uint64_t *vtable_components_data_begin() const {
Anders Carlssonccd83d72010-03-24 16:42:11 +00001191 return reinterpret_cast<const uint64_t *>(Components.begin());
1192 }
1193
Anders Carlsson66d567d2010-03-25 00:51:13 +00001194 const uint64_t *vtable_components_data_end() const {
Anders Carlssonccd83d72010-03-24 16:42:11 +00001195 return reinterpret_cast<const uint64_t *>(Components.end());
1196 }
1197
Anders Carlsson66d567d2010-03-25 00:51:13 +00001198 AddressPointsMapTy::const_iterator address_points_begin() const {
1199 return AddressPoints.begin();
1200 }
1201
1202 AddressPointsMapTy::const_iterator address_points_end() const {
1203 return AddressPoints.end();
1204 }
1205
Anders Carlsson718d0692010-04-11 22:07:06 +00001206 VTableThunksMapTy::const_iterator vtable_thunks_begin() const {
Anders Carlsson0d1407e2010-03-25 15:26:28 +00001207 return VTableThunks.begin();
1208 }
1209
Anders Carlsson718d0692010-04-11 22:07:06 +00001210 VTableThunksMapTy::const_iterator vtable_thunks_end() const {
Anders Carlsson0d1407e2010-03-25 15:26:28 +00001211 return VTableThunks.end();
1212 }
1213
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001214 /// dumpLayout - Dump the vtable layout.
1215 void dumpLayout(llvm::raw_ostream&);
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001216};
1217
Anders Carlsson94464812010-04-10 19:13:06 +00001218void VTableBuilder::AddThunk(const CXXMethodDecl *MD, const ThunkInfo &Thunk) {
Anders Carlsson718d0692010-04-11 22:07:06 +00001219 assert(!isBuildingConstructorVTable() &&
Anders Carlssonbca5d372010-03-22 20:06:40 +00001220 "Can't add thunks for construction vtable");
Anders Carlsson9135a842010-03-18 02:44:19 +00001221
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00001222 llvm::SmallVector<ThunkInfo, 1> &ThunksVector = Thunks[MD];
Anders Carlsson5e454aa2010-03-17 20:06:32 +00001223
1224 // Check if we have this thunk already.
1225 if (std::find(ThunksVector.begin(), ThunksVector.end(), Thunk) !=
1226 ThunksVector.end())
1227 return;
1228
1229 ThunksVector.push_back(Thunk);
1230}
1231
Anders Carlssonf622b452010-04-10 20:39:29 +00001232typedef llvm::SmallPtrSet<const CXXMethodDecl *, 8> OverriddenMethodsSetTy;
1233
1234/// ComputeAllOverriddenMethods - Given a method decl, will return a set of all
1235/// the overridden methods that the function decl overrides.
1236static void
1237ComputeAllOverriddenMethods(const CXXMethodDecl *MD,
1238 OverriddenMethodsSetTy& OverriddenMethods) {
1239 assert(MD->isVirtual() && "Method is not virtual!");
1240
Anders Carlsson57071e22010-02-12 05:25:12 +00001241 for (CXXMethodDecl::method_iterator I = MD->begin_overridden_methods(),
1242 E = MD->end_overridden_methods(); I != E; ++I) {
1243 const CXXMethodDecl *OverriddenMD = *I;
Anders Carlsson57071e22010-02-12 05:25:12 +00001244
Anders Carlssonf622b452010-04-10 20:39:29 +00001245 OverriddenMethods.insert(OverriddenMD);
1246
1247 ComputeAllOverriddenMethods(OverriddenMD, OverriddenMethods);
Anders Carlsson57071e22010-02-12 05:25:12 +00001248 }
Anders Carlsson57071e22010-02-12 05:25:12 +00001249}
1250
Anders Carlsson94464812010-04-10 19:13:06 +00001251void VTableBuilder::ComputeThisAdjustments() {
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001252 // Now go through the method info map and see if any of the methods need
1253 // 'this' pointer adjustments.
1254 for (MethodInfoMapTy::const_iterator I = MethodInfoMap.begin(),
1255 E = MethodInfoMap.end(); I != E; ++I) {
1256 const CXXMethodDecl *MD = I->first;
1257 const MethodInfo &MethodInfo = I->second;
1258
Anders Carlsson617def32010-03-12 05:28:07 +00001259 // Ignore adjustments for unused function pointers.
Anders Carlsson718d0692010-04-11 22:07:06 +00001260 uint64_t VTableIndex = MethodInfo.VTableIndex;
1261 if (Components[VTableIndex].getKind() ==
Anders Carlsson94464812010-04-10 19:13:06 +00001262 VTableComponent::CK_UnusedFunctionPointer)
Anders Carlsson617def32010-03-12 05:28:07 +00001263 continue;
1264
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001265 // Get the final overrider for this method.
1266 FinalOverriders::OverriderInfo Overrider =
Ken Dyck82abeae2011-03-27 18:57:53 +00001267 Overriders.getOverrider(MD, MethodInfo.BaseOffset);
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001268
Anders Carlssonbca5d372010-03-22 20:06:40 +00001269 // Check if we need an adjustment at all.
Ken Dyck82abeae2011-03-27 18:57:53 +00001270 if (MethodInfo.BaseOffsetInLayoutClass == Overrider.Offset) {
Anders Carlssonadb507d2010-03-29 15:08:41 +00001271 // When a return thunk is needed by a derived class that overrides a
1272 // virtual base, gcc uses a virtual 'this' adjustment as well.
1273 // While the thunk itself might be needed by vtables in subclasses or
1274 // in construction vtables, there doesn't seem to be a reason for using
1275 // the thunk in this vtable. Still, we do so to match gcc.
Anders Carlsson718d0692010-04-11 22:07:06 +00001276 if (VTableThunks.lookup(VTableIndex).Return.isEmpty())
Anders Carlssonadb507d2010-03-29 15:08:41 +00001277 continue;
1278 }
Anders Carlssonbca5d372010-03-22 20:06:40 +00001279
Anders Carlsson617def32010-03-12 05:28:07 +00001280 ThisAdjustment ThisAdjustment =
Ken Dyck0e55ade2011-03-27 19:03:44 +00001281 ComputeThisAdjustment(MD, MethodInfo.BaseOffsetInLayoutClass, Overrider);
Anders Carlsson617def32010-03-12 05:28:07 +00001282
1283 if (ThisAdjustment.isEmpty())
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001284 continue;
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001285
Anders Carlssoncd4e6372010-02-27 18:09:40 +00001286 // Add it.
Anders Carlsson718d0692010-04-11 22:07:06 +00001287 VTableThunks[VTableIndex].This = ThisAdjustment;
Anders Carlsson617def32010-03-12 05:28:07 +00001288
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001289 if (isa<CXXDestructorDecl>(MD)) {
1290 // Add an adjustment for the deleting destructor as well.
Anders Carlsson718d0692010-04-11 22:07:06 +00001291 VTableThunks[VTableIndex + 1].This = ThisAdjustment;
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001292 }
1293 }
1294
1295 /// Clear the method info map.
1296 MethodInfoMap.clear();
Anders Carlsson25394212010-03-22 15:47:01 +00001297
Anders Carlsson718d0692010-04-11 22:07:06 +00001298 if (isBuildingConstructorVTable()) {
Anders Carlsson25394212010-03-22 15:47:01 +00001299 // We don't need to store thunk information for construction vtables.
1300 return;
1301 }
1302
Anders Carlsson718d0692010-04-11 22:07:06 +00001303 for (VTableThunksMapTy::const_iterator I = VTableThunks.begin(),
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00001304 E = VTableThunks.end(); I != E; ++I) {
Anders Carlsson94464812010-04-10 19:13:06 +00001305 const VTableComponent &Component = Components[I->first];
Anders Carlsson25394212010-03-22 15:47:01 +00001306 const ThunkInfo &Thunk = I->second;
Anders Carlssonbca5d372010-03-22 20:06:40 +00001307 const CXXMethodDecl *MD;
Anders Carlsson25394212010-03-22 15:47:01 +00001308
1309 switch (Component.getKind()) {
1310 default:
1311 llvm_unreachable("Unexpected vtable component kind!");
Anders Carlsson94464812010-04-10 19:13:06 +00001312 case VTableComponent::CK_FunctionPointer:
Anders Carlssonbca5d372010-03-22 20:06:40 +00001313 MD = Component.getFunctionDecl();
Anders Carlsson25394212010-03-22 15:47:01 +00001314 break;
Anders Carlsson94464812010-04-10 19:13:06 +00001315 case VTableComponent::CK_CompleteDtorPointer:
Anders Carlssonbca5d372010-03-22 20:06:40 +00001316 MD = Component.getDestructorDecl();
Anders Carlsson25394212010-03-22 15:47:01 +00001317 break;
Anders Carlsson94464812010-04-10 19:13:06 +00001318 case VTableComponent::CK_DeletingDtorPointer:
Anders Carlsson25394212010-03-22 15:47:01 +00001319 // We've already added the thunk when we saw the complete dtor pointer.
Anders Carlssonbca5d372010-03-22 20:06:40 +00001320 continue;
Anders Carlsson25394212010-03-22 15:47:01 +00001321 }
Anders Carlssonbca5d372010-03-22 20:06:40 +00001322
1323 if (MD->getParent() == MostDerivedClass)
1324 AddThunk(MD, Thunk);
Anders Carlsson25394212010-03-22 15:47:01 +00001325 }
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001326}
1327
Anders Carlsson94464812010-04-10 19:13:06 +00001328ReturnAdjustment VTableBuilder::ComputeReturnAdjustment(BaseOffset Offset) {
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001329 ReturnAdjustment Adjustment;
1330
1331 if (!Offset.isEmpty()) {
Anders Carlsson60db0ee2010-02-13 21:07:32 +00001332 if (Offset.VirtualBase) {
1333 // Get the virtual base offset offset.
Anders Carlsson1972ced2010-03-11 07:00:45 +00001334 if (Offset.DerivedClass == MostDerivedClass) {
1335 // We can get the offset offset directly from our map.
1336 Adjustment.VBaseOffsetOffset =
1337 VBaseOffsetOffsets.lookup(Offset.VirtualBase);
1338 } else {
1339 Adjustment.VBaseOffsetOffset =
Anders Carlssonaf440352010-03-23 04:11:45 +00001340 VTables.getVirtualBaseOffsetOffset(Offset.DerivedClass,
1341 Offset.VirtualBase);
Anders Carlsson1972ced2010-03-11 07:00:45 +00001342 }
Anders Carlsson60db0ee2010-02-13 21:07:32 +00001343 }
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001344
1345 Adjustment.NonVirtual = Offset.NonVirtualOffset;
1346 }
1347
1348 return Adjustment;
1349}
1350
Anders Carlsson379017f2010-02-27 19:57:44 +00001351BaseOffset
Anders Carlsson94464812010-04-10 19:13:06 +00001352VTableBuilder::ComputeThisAdjustmentBaseOffset(BaseSubobject Base,
Anders Carlsson379017f2010-02-27 19:57:44 +00001353 BaseSubobject Derived) const {
1354 const CXXRecordDecl *BaseRD = Base.getBase();
1355 const CXXRecordDecl *DerivedRD = Derived.getBase();
1356
1357 CXXBasePaths Paths(/*FindAmbiguities=*/true,
1358 /*RecordPaths=*/true, /*DetectVirtual=*/true);
1359
1360 if (!const_cast<CXXRecordDecl *>(DerivedRD)->
1361 isDerivedFrom(const_cast<CXXRecordDecl *>(BaseRD), Paths)) {
1362 assert(false && "Class must be derived from the passed in base class!");
1363 return BaseOffset();
1364 }
1365
1366 // We have to go through all the paths, and see which one leads us to the
1367 // right base subobject.
1368 for (CXXBasePaths::const_paths_iterator I = Paths.begin(), E = Paths.end();
1369 I != E; ++I) {
1370 BaseOffset Offset = ComputeBaseOffset(Context, DerivedRD, *I);
1371
Ken Dyck57ebe332011-03-26 00:51:24 +00001372 CharUnits OffsetToBaseSubobject =
1373 CharUnits::fromQuantity(Offset.NonVirtualOffset);
Anders Carlsson379017f2010-02-27 19:57:44 +00001374
1375 if (Offset.VirtualBase) {
1376 // If we have a virtual base class, the non-virtual offset is relative
1377 // to the virtual base class offset.
Anders Carlsson2bc1d3a2010-03-10 21:25:37 +00001378 const ASTRecordLayout &LayoutClassLayout =
1379 Context.getASTRecordLayout(LayoutClass);
Anders Carlsson379017f2010-02-27 19:57:44 +00001380
1381 /// Get the virtual base offset, relative to the most derived class
1382 /// layout.
1383 OffsetToBaseSubobject +=
Ken Dyck57ebe332011-03-26 00:51:24 +00001384 LayoutClassLayout.getVBaseClassOffset(Offset.VirtualBase);
Anders Carlsson379017f2010-02-27 19:57:44 +00001385 } else {
1386 // Otherwise, the non-virtual offset is relative to the derived class
1387 // offset.
Ken Dyck57ebe332011-03-26 00:51:24 +00001388 OffsetToBaseSubobject += Derived.getBaseOffset();
Anders Carlsson379017f2010-02-27 19:57:44 +00001389 }
1390
1391 // Check if this path gives us the right base subobject.
Ken Dyck57ebe332011-03-26 00:51:24 +00001392 if (OffsetToBaseSubobject == Base.getBaseOffset()) {
Anders Carlsson379017f2010-02-27 19:57:44 +00001393 // Since we're going from the base class _to_ the derived class, we'll
1394 // invert the non-virtual offset here.
1395 Offset.NonVirtualOffset = -Offset.NonVirtualOffset;
1396 return Offset;
1397 }
1398 }
1399
1400 return BaseOffset();
1401}
1402
Anders Carlsson80d8d7d2010-03-23 15:13:06 +00001403ThisAdjustment
Anders Carlsson94464812010-04-10 19:13:06 +00001404VTableBuilder::ComputeThisAdjustment(const CXXMethodDecl *MD,
Ken Dyck0e55ade2011-03-27 19:03:44 +00001405 CharUnits BaseOffsetInLayoutClass,
Anders Carlsson617def32010-03-12 05:28:07 +00001406 FinalOverriders::OverriderInfo Overrider) {
Anders Carlsson617def32010-03-12 05:28:07 +00001407 // Ignore adjustments for pure virtual member functions.
1408 if (Overrider.Method->isPure())
1409 return ThisAdjustment();
1410
Ken Dyck0e55ade2011-03-27 19:03:44 +00001411 BaseSubobject OverriddenBaseSubobject(MD->getParent(),
1412 BaseOffsetInLayoutClass);
Anders Carlsson617def32010-03-12 05:28:07 +00001413
1414 BaseSubobject OverriderBaseSubobject(Overrider.Method->getParent(),
Ken Dyck17d85192011-03-26 01:29:16 +00001415 Overrider.Offset);
Anders Carlsson617def32010-03-12 05:28:07 +00001416
1417 // Compute the adjustment offset.
1418 BaseOffset Offset = ComputeThisAdjustmentBaseOffset(OverriddenBaseSubobject,
1419 OverriderBaseSubobject);
1420 if (Offset.isEmpty())
1421 return ThisAdjustment();
1422
Anders Carlsson49bac9a2010-02-13 23:40:17 +00001423 ThisAdjustment Adjustment;
1424
Anders Carlsson617def32010-03-12 05:28:07 +00001425 if (Offset.VirtualBase) {
1426 // Get the vcall offset map for this virtual base.
1427 VCallOffsetMap &VCallOffsets = VCallOffsetsForVBases[Offset.VirtualBase];
Anders Carlssoneb577d02010-02-18 17:26:40 +00001428
Anders Carlsson617def32010-03-12 05:28:07 +00001429 if (VCallOffsets.empty()) {
1430 // We don't have vcall offsets for this virtual base, go ahead and
1431 // build them.
1432 VCallAndVBaseOffsetBuilder Builder(MostDerivedClass, MostDerivedClass,
1433 /*FinalOverriders=*/0,
Ken Dyck4230d522011-03-24 01:21:01 +00001434 BaseSubobject(Offset.VirtualBase,
1435 CharUnits::Zero()),
Anders Carlsson617def32010-03-12 05:28:07 +00001436 /*BaseIsVirtual=*/true,
Ken Dyck3ecfa2d2011-03-31 00:48:04 +00001437 /*OffsetInLayoutClass=*/
1438 CharUnits::Zero());
Anders Carlsson617def32010-03-12 05:28:07 +00001439
1440 VCallOffsets = Builder.getVCallOffsets();
1441 }
1442
Ken Dyckc952d382011-04-02 00:51:15 +00001443 Adjustment.VCallOffsetOffset =
1444 VCallOffsets.getVCallOffsetOffset(MD).getQuantity();
Anders Carlsson49bac9a2010-02-13 23:40:17 +00001445 }
Anders Carlsson617def32010-03-12 05:28:07 +00001446
1447 // Set the non-virtual part of the adjustment.
1448 Adjustment.NonVirtual = Offset.NonVirtualOffset;
Anders Carlsson49bac9a2010-02-13 23:40:17 +00001449
1450 return Adjustment;
1451}
Anders Carlsson617def32010-03-12 05:28:07 +00001452
Anders Carlsson57071e22010-02-12 05:25:12 +00001453void
Anders Carlsson94464812010-04-10 19:13:06 +00001454VTableBuilder::AddMethod(const CXXMethodDecl *MD,
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001455 ReturnAdjustment ReturnAdjustment) {
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001456 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1457 assert(ReturnAdjustment.isEmpty() &&
1458 "Destructor can't have return adjustment!");
Anders Carlsson49bac9a2010-02-13 23:40:17 +00001459
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001460 // Add both the complete destructor and the deleting destructor.
Anders Carlsson94464812010-04-10 19:13:06 +00001461 Components.push_back(VTableComponent::MakeCompleteDtor(DD));
1462 Components.push_back(VTableComponent::MakeDeletingDtor(DD));
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001463 } else {
1464 // Add the return adjustment if necessary.
1465 if (!ReturnAdjustment.isEmpty())
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00001466 VTableThunks[Components.size()].Return = ReturnAdjustment;
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001467
1468 // Add the function.
Anders Carlsson94464812010-04-10 19:13:06 +00001469 Components.push_back(VTableComponent::MakeFunction(MD));
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001470 }
1471}
1472
Anders Carlssonc784ba22010-02-27 06:38:03 +00001473/// OverridesIndirectMethodInBase - Return whether the given member function
1474/// overrides any methods in the set of given bases.
1475/// Unlike OverridesMethodInBase, this checks "overriders of overriders".
1476/// For example, if we have:
1477///
1478/// struct A { virtual void f(); }
1479/// struct B : A { virtual void f(); }
1480/// struct C : B { virtual void f(); }
1481///
1482/// OverridesIndirectMethodInBase will return true if given C::f as the method
Anders Carlssonf622b452010-04-10 20:39:29 +00001483/// and { A } as the set of bases.
Anders Carlssonc784ba22010-02-27 06:38:03 +00001484static bool
1485OverridesIndirectMethodInBases(const CXXMethodDecl *MD,
Anders Carlsson94464812010-04-10 19:13:06 +00001486 VTableBuilder::PrimaryBasesSetVectorTy &Bases) {
Anders Carlssonfbf05612010-04-17 17:24:33 +00001487 if (Bases.count(MD->getParent()))
1488 return true;
1489
Anders Carlssonc784ba22010-02-27 06:38:03 +00001490 for (CXXMethodDecl::method_iterator I = MD->begin_overridden_methods(),
1491 E = MD->end_overridden_methods(); I != E; ++I) {
1492 const CXXMethodDecl *OverriddenMD = *I;
Anders Carlssonc784ba22010-02-27 06:38:03 +00001493
1494 // Check "indirect overriders".
1495 if (OverridesIndirectMethodInBases(OverriddenMD, Bases))
1496 return true;
1497 }
1498
1499 return false;
1500}
1501
Anders Carlsson464c8f12010-02-23 04:26:39 +00001502bool
Anders Carlsson94464812010-04-10 19:13:06 +00001503VTableBuilder::IsOverriderUsed(const CXXMethodDecl *Overrider,
Ken Dyck413e7d22011-04-02 00:44:58 +00001504 CharUnits BaseOffsetInLayoutClass,
Anders Carlsson60396612010-03-10 06:51:42 +00001505 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
Ken Dyck413e7d22011-04-02 00:44:58 +00001506 CharUnits FirstBaseOffsetInLayoutClass) const {
Anders Carlsson464c8f12010-02-23 04:26:39 +00001507 // If the base and the first base in the primary base chain have the same
1508 // offsets, then this overrider will be used.
Anders Carlsson60396612010-03-10 06:51:42 +00001509 if (BaseOffsetInLayoutClass == FirstBaseOffsetInLayoutClass)
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001510 return true;
1511
1512 // We know now that Base (or a direct or indirect base of it) is a primary
1513 // base in part of the class hierarchy, but not a primary base in the most
1514 // derived class.
1515
1516 // If the overrider is the first base in the primary base chain, we know
1517 // that the overrider will be used.
Anders Carlsson60396612010-03-10 06:51:42 +00001518 if (Overrider->getParent() == FirstBaseInPrimaryBaseChain)
Anders Carlsson464c8f12010-02-23 04:26:39 +00001519 return true;
1520
Anders Carlsson94464812010-04-10 19:13:06 +00001521 VTableBuilder::PrimaryBasesSetVectorTy PrimaryBases;
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001522
Anders Carlsson60396612010-03-10 06:51:42 +00001523 const CXXRecordDecl *RD = FirstBaseInPrimaryBaseChain;
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001524 PrimaryBases.insert(RD);
1525
1526 // Now traverse the base chain, starting with the first base, until we find
1527 // the base that is no longer a primary base.
1528 while (true) {
1529 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1530 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
1531
1532 if (!PrimaryBase)
1533 break;
1534
Anders Carlssonc9e814b2010-11-24 23:12:57 +00001535 if (Layout.isPrimaryBaseVirtual()) {
Anders Carlssona14f5972010-10-31 23:22:37 +00001536 assert(Layout.getVBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001537 "Primary base should always be at offset 0!");
1538
Anders Carlssondad0f992010-02-28 18:37:33 +00001539 const ASTRecordLayout &LayoutClassLayout =
1540 Context.getASTRecordLayout(LayoutClass);
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001541
1542 // Now check if this is the primary base that is not a primary base in the
1543 // most derived class.
Ken Dyck413e7d22011-04-02 00:44:58 +00001544 if (LayoutClassLayout.getVBaseClassOffset(PrimaryBase) !=
Anders Carlsson60396612010-03-10 06:51:42 +00001545 FirstBaseOffsetInLayoutClass) {
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001546 // We found it, stop walking the chain.
1547 break;
1548 }
1549 } else {
Anders Carlssona14f5972010-10-31 23:22:37 +00001550 assert(Layout.getBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001551 "Primary base should always be at offset 0!");
1552 }
Anders Carlssoncd4e6372010-02-27 18:09:40 +00001553
Anders Carlssonf89bb6c2010-02-27 19:51:04 +00001554 if (!PrimaryBases.insert(PrimaryBase))
1555 assert(false && "Found a duplicate primary base!");
1556
Anders Carlssoncd4e6372010-02-27 18:09:40 +00001557 RD = PrimaryBase;
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001558 }
1559
1560 // If the final overrider is an override of one of the primary bases,
1561 // then we know that it will be used.
Anders Carlsson60396612010-03-10 06:51:42 +00001562 return OverridesIndirectMethodInBases(Overrider, PrimaryBases);
Anders Carlsson464c8f12010-02-23 04:26:39 +00001563}
1564
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001565/// FindNearestOverriddenMethod - Given a method, returns the overridden method
1566/// from the nearest base. Returns null if no method was found.
1567static const CXXMethodDecl *
1568FindNearestOverriddenMethod(const CXXMethodDecl *MD,
Anders Carlsson94464812010-04-10 19:13:06 +00001569 VTableBuilder::PrimaryBasesSetVectorTy &Bases) {
Anders Carlssonf622b452010-04-10 20:39:29 +00001570 OverriddenMethodsSetTy OverriddenMethods;
1571 ComputeAllOverriddenMethods(MD, OverriddenMethods);
1572
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001573 for (int I = Bases.size(), E = 0; I != E; --I) {
1574 const CXXRecordDecl *PrimaryBase = Bases[I - 1];
1575
1576 // Now check the overriden methods.
Anders Carlssonf622b452010-04-10 20:39:29 +00001577 for (OverriddenMethodsSetTy::const_iterator I = OverriddenMethods.begin(),
1578 E = OverriddenMethods.end(); I != E; ++I) {
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001579 const CXXMethodDecl *OverriddenMD = *I;
Anders Carlssonf622b452010-04-10 20:39:29 +00001580
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001581 // We found our overridden method.
1582 if (OverriddenMD->getParent() == PrimaryBase)
1583 return OverriddenMD;
1584 }
1585 }
1586
1587 return 0;
1588}
1589
Anders Carlsson60396612010-03-10 06:51:42 +00001590void
Ken Dyck3a726802011-03-27 19:15:11 +00001591VTableBuilder::AddMethods(BaseSubobject Base, CharUnits BaseOffsetInLayoutClass,
Anders Carlsson60396612010-03-10 06:51:42 +00001592 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
Ken Dyck3a726802011-03-27 19:15:11 +00001593 CharUnits FirstBaseOffsetInLayoutClass,
Anders Carlssonb9021e92010-02-27 16:18:19 +00001594 PrimaryBasesSetVectorTy &PrimaryBases) {
Anders Carlsson57071e22010-02-12 05:25:12 +00001595 const CXXRecordDecl *RD = Base.getBase();
Anders Carlsson57071e22010-02-12 05:25:12 +00001596 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1597
1598 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
Ken Dyck57ebe332011-03-26 00:51:24 +00001599 CharUnits PrimaryBaseOffset;
Ken Dyck3a726802011-03-27 19:15:11 +00001600 CharUnits PrimaryBaseOffsetInLayoutClass;
Anders Carlssonc9e814b2010-11-24 23:12:57 +00001601 if (Layout.isPrimaryBaseVirtual()) {
Anders Carlssona14f5972010-10-31 23:22:37 +00001602 assert(Layout.getVBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlssonaf280c02010-02-23 03:48:14 +00001603 "Primary vbase should have a zero offset!");
1604
1605 const ASTRecordLayout &MostDerivedClassLayout =
1606 Context.getASTRecordLayout(MostDerivedClass);
1607
Anders Carlsson60396612010-03-10 06:51:42 +00001608 PrimaryBaseOffset =
Ken Dyck57ebe332011-03-26 00:51:24 +00001609 MostDerivedClassLayout.getVBaseClassOffset(PrimaryBase);
Anders Carlsson60396612010-03-10 06:51:42 +00001610
1611 const ASTRecordLayout &LayoutClassLayout =
1612 Context.getASTRecordLayout(LayoutClass);
1613
1614 PrimaryBaseOffsetInLayoutClass =
Ken Dyck3a726802011-03-27 19:15:11 +00001615 LayoutClassLayout.getVBaseClassOffset(PrimaryBase);
Anders Carlssonaf280c02010-02-23 03:48:14 +00001616 } else {
Anders Carlssona14f5972010-10-31 23:22:37 +00001617 assert(Layout.getBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlsson57071e22010-02-12 05:25:12 +00001618 "Primary base should have a zero offset!");
Anders Carlssonaf280c02010-02-23 03:48:14 +00001619
Ken Dyck57ebe332011-03-26 00:51:24 +00001620 PrimaryBaseOffset = Base.getBaseOffset();
Anders Carlsson60396612010-03-10 06:51:42 +00001621 PrimaryBaseOffsetInLayoutClass = BaseOffsetInLayoutClass;
Anders Carlssonaf280c02010-02-23 03:48:14 +00001622 }
Anders Carlssondad0f992010-02-28 18:37:33 +00001623
Ken Dyck57ebe332011-03-26 00:51:24 +00001624 AddMethods(BaseSubobject(PrimaryBase, PrimaryBaseOffset),
Anders Carlsson60396612010-03-10 06:51:42 +00001625 PrimaryBaseOffsetInLayoutClass, FirstBaseInPrimaryBaseChain,
1626 FirstBaseOffsetInLayoutClass, PrimaryBases);
Anders Carlsson57071e22010-02-12 05:25:12 +00001627
1628 if (!PrimaryBases.insert(PrimaryBase))
1629 assert(false && "Found a duplicate primary base!");
1630 }
Anders Carlsson822307b2010-02-11 17:18:51 +00001631
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001632 // Now go through all virtual member functions and add them.
1633 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
1634 E = RD->method_end(); I != E; ++I) {
1635 const CXXMethodDecl *MD = *I;
Anders Carlsson57071e22010-02-12 05:25:12 +00001636
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001637 if (!MD->isVirtual())
1638 continue;
Anders Carlsson57071e22010-02-12 05:25:12 +00001639
1640 // Get the final overrider.
Anders Carlssona7575822010-02-12 16:55:34 +00001641 FinalOverriders::OverriderInfo Overrider =
Ken Dycke6203132011-03-26 01:18:17 +00001642 Overriders.getOverrider(MD, Base.getBaseOffset());
Anders Carlsson57071e22010-02-12 05:25:12 +00001643
1644 // Check if this virtual member function overrides a method in a primary
1645 // base. If this is the case, and the return type doesn't require adjustment
1646 // then we can just use the member function from the primary base.
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001647 if (const CXXMethodDecl *OverriddenMD =
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001648 FindNearestOverriddenMethod(MD, PrimaryBases)) {
Anders Carlssondf31af12010-02-13 23:17:31 +00001649 if (ComputeReturnAdjustmentBaseOffset(Context, MD,
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001650 OverriddenMD).isEmpty()) {
1651 // Replace the method info of the overridden method with our own
1652 // method.
1653 assert(MethodInfoMap.count(OverriddenMD) &&
1654 "Did not find the overridden method!");
1655 MethodInfo &OverriddenMethodInfo = MethodInfoMap[OverriddenMD];
1656
Ken Dyck3a726802011-03-27 19:15:11 +00001657 MethodInfo MethodInfo(Base.getBaseOffset(), BaseOffsetInLayoutClass,
1658 OverriddenMethodInfo.VTableIndex);
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001659
1660 assert(!MethodInfoMap.count(MD) &&
1661 "Should not have method info for this method yet!");
1662
1663 MethodInfoMap.insert(std::make_pair(MD, MethodInfo));
1664 MethodInfoMap.erase(OverriddenMD);
Anders Carlssonbca5d372010-03-22 20:06:40 +00001665
1666 // If the overridden method exists in a virtual base class or a direct
1667 // or indirect base class of a virtual base class, we need to emit a
1668 // thunk if we ever have a class hierarchy where the base class is not
1669 // a primary base in the complete object.
Anders Carlsson718d0692010-04-11 22:07:06 +00001670 if (!isBuildingConstructorVTable() && OverriddenMD != MD) {
Anders Carlssonbca5d372010-03-22 20:06:40 +00001671 // Compute the this adjustment.
1672 ThisAdjustment ThisAdjustment =
Ken Dyck3a726802011-03-27 19:15:11 +00001673 ComputeThisAdjustment(OverriddenMD, BaseOffsetInLayoutClass,
1674 Overrider);
Anders Carlssonbca5d372010-03-22 20:06:40 +00001675
Anders Carlssonacfa6ae2010-03-29 02:53:58 +00001676 if (ThisAdjustment.VCallOffsetOffset &&
1677 Overrider.Method->getParent() == MostDerivedClass) {
John McCall4e3b17c2010-11-09 01:18:05 +00001678
1679 // There's no return adjustment from OverriddenMD and MD,
1680 // but that doesn't mean there isn't one between MD and
1681 // the final overrider.
1682 BaseOffset ReturnAdjustmentOffset =
1683 ComputeReturnAdjustmentBaseOffset(Context, Overrider.Method, MD);
1684 ReturnAdjustment ReturnAdjustment =
1685 ComputeReturnAdjustment(ReturnAdjustmentOffset);
1686
Anders Carlssonacfa6ae2010-03-29 02:53:58 +00001687 // This is a virtual thunk for the most derived class, add it.
Anders Carlssonbca5d372010-03-22 20:06:40 +00001688 AddThunk(Overrider.Method,
John McCall4e3b17c2010-11-09 01:18:05 +00001689 ThunkInfo(ThisAdjustment, ReturnAdjustment));
Anders Carlssonbca5d372010-03-22 20:06:40 +00001690 }
1691 }
1692
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001693 continue;
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001694 }
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001695 }
Anders Carlsson0c0eeb22010-02-13 02:02:03 +00001696
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001697 // Insert the method info for this method.
Ken Dyck3a726802011-03-27 19:15:11 +00001698 MethodInfo MethodInfo(Base.getBaseOffset(), BaseOffsetInLayoutClass,
Ken Dyck82abeae2011-03-27 18:57:53 +00001699 Components.size());
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001700
1701 assert(!MethodInfoMap.count(MD) &&
1702 "Should not have method info for this method yet!");
1703 MethodInfoMap.insert(std::make_pair(MD, MethodInfo));
Anders Carlssoncd4e6372010-02-27 18:09:40 +00001704
1705 // Check if this overrider is going to be used.
Anders Carlsson60396612010-03-10 06:51:42 +00001706 const CXXMethodDecl *OverriderMD = Overrider.Method;
Ken Dyck413e7d22011-04-02 00:44:58 +00001707 if (!IsOverriderUsed(OverriderMD, BaseOffsetInLayoutClass,
Anders Carlsson60396612010-03-10 06:51:42 +00001708 FirstBaseInPrimaryBaseChain,
Ken Dyck413e7d22011-04-02 00:44:58 +00001709 FirstBaseOffsetInLayoutClass)) {
Anders Carlsson94464812010-04-10 19:13:06 +00001710 Components.push_back(VTableComponent::MakeUnusedFunction(OverriderMD));
Anders Carlssoncd4e6372010-02-27 18:09:40 +00001711 continue;
1712 }
Anders Carlsson464c8f12010-02-23 04:26:39 +00001713
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001714 // Check if this overrider needs a return adjustment.
Anders Carlsson7097e752010-06-01 23:47:05 +00001715 // We don't want to do this for pure virtual member functions.
1716 BaseOffset ReturnAdjustmentOffset;
1717 if (!OverriderMD->isPure()) {
1718 ReturnAdjustmentOffset =
1719 ComputeReturnAdjustmentBaseOffset(Context, OverriderMD, MD);
1720 }
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001721
1722 ReturnAdjustment ReturnAdjustment =
1723 ComputeReturnAdjustment(ReturnAdjustmentOffset);
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001724
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001725 AddMethod(Overrider.Method, ReturnAdjustment);
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001726 }
1727}
1728
Anders Carlsson718d0692010-04-11 22:07:06 +00001729void VTableBuilder::LayoutVTable() {
Ken Dyck4230d522011-03-24 01:21:01 +00001730 LayoutPrimaryAndSecondaryVTables(BaseSubobject(MostDerivedClass,
1731 CharUnits::Zero()),
Anders Carlsson73e6fa02010-04-11 22:20:36 +00001732 /*BaseIsMorallyVirtual=*/false,
Anders Carlsson530c40c2010-02-28 01:43:58 +00001733 MostDerivedClassIsVirtual,
Ken Dyck7ba8f522011-03-27 20:33:38 +00001734 MostDerivedClassOffset);
Anders Carlsson89ad4212010-02-16 16:26:28 +00001735
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001736 VisitedVirtualBasesSetTy VBases;
Anders Carlsson08c26752010-02-27 04:05:52 +00001737
1738 // Determine the primary virtual bases.
Ken Dyck8fe59932011-03-30 01:10:23 +00001739 DeterminePrimaryVirtualBases(MostDerivedClass, MostDerivedClassOffset,
1740 VBases);
Anders Carlsson08c26752010-02-27 04:05:52 +00001741 VBases.clear();
1742
Anders Carlsson718d0692010-04-11 22:07:06 +00001743 LayoutVTablesForVirtualBases(MostDerivedClass, VBases);
Anders Carlsson89ad4212010-02-16 16:26:28 +00001744}
1745
Anders Carlsson530c40c2010-02-28 01:43:58 +00001746void
Anders Carlsson718d0692010-04-11 22:07:06 +00001747VTableBuilder::LayoutPrimaryAndSecondaryVTables(BaseSubobject Base,
Anders Carlsson73e6fa02010-04-11 22:20:36 +00001748 bool BaseIsMorallyVirtual,
Anders Carlsson91232842010-04-11 22:03:57 +00001749 bool BaseIsVirtualInLayoutClass,
Ken Dyck7ba8f522011-03-27 20:33:38 +00001750 CharUnits OffsetInLayoutClass) {
Chris Lattner04a23112010-02-17 21:42:34 +00001751 assert(Base.getBase()->isDynamicClass() && "class does not have a vtable!");
Anders Carlssonb828afa2010-02-14 17:05:59 +00001752
Anders Carlsson852213e2010-02-16 04:59:55 +00001753 // Add vcall and vbase offsets for this vtable.
Anders Carlsson530c40c2010-02-28 01:43:58 +00001754 VCallAndVBaseOffsetBuilder Builder(MostDerivedClass, LayoutClass, &Overriders,
Anders Carlsson91232842010-04-11 22:03:57 +00001755 Base, BaseIsVirtualInLayoutClass,
Ken Dyck3ecfa2d2011-03-31 00:48:04 +00001756 OffsetInLayoutClass);
Anders Carlssond68c0832010-02-25 03:45:56 +00001757 Components.append(Builder.components_begin(), Builder.components_end());
1758
Anders Carlssondba6ef82010-02-25 22:23:13 +00001759 // Check if we need to add these vcall offsets.
Anders Carlsson91232842010-04-11 22:03:57 +00001760 if (BaseIsVirtualInLayoutClass && !Builder.getVCallOffsets().empty()) {
Anders Carlssondba6ef82010-02-25 22:23:13 +00001761 VCallOffsetMap &VCallOffsets = VCallOffsetsForVBases[Base.getBase()];
1762
1763 if (VCallOffsets.empty())
1764 VCallOffsets = Builder.getVCallOffsets();
1765 }
1766
Anders Carlssonbb6305b2010-03-11 06:43:12 +00001767 // If we're laying out the most derived class we want to keep track of the
1768 // virtual base class offset offsets.
1769 if (Base.getBase() == MostDerivedClass)
1770 VBaseOffsetOffsets = Builder.getVBaseOffsetOffsets();
1771
Anders Carlsson852213e2010-02-16 04:59:55 +00001772 // Add the offset to top.
Ken Dyck7ba8f522011-03-27 20:33:38 +00001773 CharUnits OffsetToTop = MostDerivedClassOffset - OffsetInLayoutClass;
1774 Components.push_back(
Ken Dyckc40a3fd2011-04-02 01:14:48 +00001775 VTableComponent::MakeOffsetToTop(OffsetToTop));
Anders Carlsson57071e22010-02-12 05:25:12 +00001776
1777 // Next, add the RTTI.
Anders Carlsson94464812010-04-10 19:13:06 +00001778 Components.push_back(VTableComponent::MakeRTTI(MostDerivedClass));
Anders Carlsson57071e22010-02-12 05:25:12 +00001779
Anders Carlsson28cbc8b2010-02-12 07:43:48 +00001780 uint64_t AddressPoint = Components.size();
Anders Carlsson57071e22010-02-12 05:25:12 +00001781
1782 // Now go through all virtual member functions and add them.
Anders Carlssonb9021e92010-02-27 16:18:19 +00001783 PrimaryBasesSetVectorTy PrimaryBases;
Ken Dyck7ba8f522011-03-27 20:33:38 +00001784 AddMethods(Base, OffsetInLayoutClass,
1785 Base.getBase(), OffsetInLayoutClass,
Anders Carlsson60396612010-03-10 06:51:42 +00001786 PrimaryBases);
Anders Carlsson57071e22010-02-12 05:25:12 +00001787
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001788 // Compute 'this' pointer adjustments.
1789 ComputeThisAdjustments();
1790
Anders Carlsson014a3582010-03-25 21:45:14 +00001791 // Add all address points.
1792 const CXXRecordDecl *RD = Base.getBase();
1793 while (true) {
Ken Dyck4230d522011-03-24 01:21:01 +00001794 AddressPoints.insert(std::make_pair(
Ken Dyck7ba8f522011-03-27 20:33:38 +00001795 BaseSubobject(RD, OffsetInLayoutClass),
Ken Dyck4230d522011-03-24 01:21:01 +00001796 AddressPoint));
Anders Carlsson014a3582010-03-25 21:45:14 +00001797
1798 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1799 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
Anders Carlsson28cbc8b2010-02-12 07:43:48 +00001800
Anders Carlsson014a3582010-03-25 21:45:14 +00001801 if (!PrimaryBase)
1802 break;
1803
Anders Carlssonc9e814b2010-11-24 23:12:57 +00001804 if (Layout.isPrimaryBaseVirtual()) {
Anders Carlsson014a3582010-03-25 21:45:14 +00001805 // Check if this virtual primary base is a primary base in the layout
1806 // class. If it's not, we don't want to add it.
1807 const ASTRecordLayout &LayoutClassLayout =
1808 Context.getASTRecordLayout(LayoutClass);
1809
Ken Dyck7ba8f522011-03-27 20:33:38 +00001810 if (LayoutClassLayout.getVBaseClassOffset(PrimaryBase) !=
Anders Carlsson014a3582010-03-25 21:45:14 +00001811 OffsetInLayoutClass) {
1812 // We don't want to add this class (or any of its primary bases).
1813 break;
1814 }
1815 }
1816
1817 RD = PrimaryBase;
Anders Carlsson28cbc8b2010-02-12 07:43:48 +00001818 }
1819
Anders Carlsson5edcc372010-02-24 16:43:12 +00001820 // Layout secondary vtables.
Ken Dyck75762b32011-03-30 00:50:28 +00001821 LayoutSecondaryVTables(Base, BaseIsMorallyVirtual, OffsetInLayoutClass);
Anders Carlssonc7b63162010-02-16 16:02:57 +00001822}
1823
Anders Carlsson718d0692010-04-11 22:07:06 +00001824void VTableBuilder::LayoutSecondaryVTables(BaseSubobject Base,
Anders Carlssona96a2e92010-03-10 19:39:11 +00001825 bool BaseIsMorallyVirtual,
Ken Dyck75762b32011-03-30 00:50:28 +00001826 CharUnits OffsetInLayoutClass) {
Anders Carlssonc7b63162010-02-16 16:02:57 +00001827 // Itanium C++ ABI 2.5.2:
1828 // Following the primary virtual table of a derived class are secondary
1829 // virtual tables for each of its proper base classes, except any primary
1830 // base(s) with which it shares its primary virtual table.
1831
1832 const CXXRecordDecl *RD = Base.getBase();
Anders Carlsson57071e22010-02-12 05:25:12 +00001833 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1834 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
Anders Carlssonc7b63162010-02-16 16:02:57 +00001835
Anders Carlsson57071e22010-02-12 05:25:12 +00001836 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1837 E = RD->bases_end(); I != E; ++I) {
Anders Carlssonc7b63162010-02-16 16:02:57 +00001838 // Ignore virtual bases, we'll emit them later.
1839 if (I->isVirtual())
1840 continue;
1841
Anders Carlsson57071e22010-02-12 05:25:12 +00001842 const CXXRecordDecl *BaseDecl =
1843 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Anders Carlssonb828afa2010-02-14 17:05:59 +00001844
Anders Carlssona661a542010-02-16 04:49:44 +00001845 // Ignore bases that don't have a vtable.
1846 if (!BaseDecl->isDynamicClass())
1847 continue;
Anders Carlssonb828afa2010-02-14 17:05:59 +00001848
Anders Carlsson718d0692010-04-11 22:07:06 +00001849 if (isBuildingConstructorVTable()) {
Anders Carlssonf2c98ce2010-03-10 19:15:26 +00001850 // Itanium C++ ABI 2.6.4:
1851 // Some of the base class subobjects may not need construction virtual
1852 // tables, which will therefore not be present in the construction
1853 // virtual table group, even though the subobject virtual tables are
1854 // present in the main virtual table group for the complete object.
Anders Carlssona96a2e92010-03-10 19:39:11 +00001855 if (!BaseIsMorallyVirtual && !BaseDecl->getNumVBases())
Anders Carlssonf2c98ce2010-03-10 19:15:26 +00001856 continue;
Anders Carlssonf2c98ce2010-03-10 19:15:26 +00001857 }
1858
Anders Carlsson76f1aa72010-02-13 22:05:23 +00001859 // Get the base offset of this base.
Ken Dyck57ebe332011-03-26 00:51:24 +00001860 CharUnits RelativeBaseOffset = Layout.getBaseClassOffset(BaseDecl);
1861 CharUnits BaseOffset = Base.getBaseOffset() + RelativeBaseOffset;
Anders Carlsson530c40c2010-02-28 01:43:58 +00001862
Ken Dyck57ebe332011-03-26 00:51:24 +00001863 CharUnits BaseOffsetInLayoutClass =
Ken Dyck75762b32011-03-30 00:50:28 +00001864 OffsetInLayoutClass + RelativeBaseOffset;
Anders Carlssonc7b63162010-02-16 16:02:57 +00001865
1866 // Don't emit a secondary vtable for a primary base. We might however want
1867 // to emit secondary vtables for other bases of this base.
1868 if (BaseDecl == PrimaryBase) {
Ken Dyck75762b32011-03-30 00:50:28 +00001869 LayoutSecondaryVTables(BaseSubobject(BaseDecl, BaseOffset),
1870 BaseIsMorallyVirtual, BaseOffsetInLayoutClass);
Anders Carlssonc7b63162010-02-16 16:02:57 +00001871 continue;
1872 }
Anders Carlsson76f1aa72010-02-13 22:05:23 +00001873
Anders Carlsson89ad4212010-02-16 16:26:28 +00001874 // Layout the primary vtable (and any secondary vtables) for this base.
Ken Dyck4230d522011-03-24 01:21:01 +00001875 LayoutPrimaryAndSecondaryVTables(
Ken Dyck57ebe332011-03-26 00:51:24 +00001876 BaseSubobject(BaseDecl, BaseOffset),
Ken Dyck4230d522011-03-24 01:21:01 +00001877 BaseIsMorallyVirtual,
1878 /*BaseIsVirtualInLayoutClass=*/false,
Ken Dyck7ba8f522011-03-27 20:33:38 +00001879 BaseOffsetInLayoutClass);
Anders Carlsson57071e22010-02-12 05:25:12 +00001880 }
1881}
1882
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001883void
Anders Carlsson94464812010-04-10 19:13:06 +00001884VTableBuilder::DeterminePrimaryVirtualBases(const CXXRecordDecl *RD,
Ken Dyck8fe59932011-03-30 01:10:23 +00001885 CharUnits OffsetInLayoutClass,
Anders Carlsson08c26752010-02-27 04:05:52 +00001886 VisitedVirtualBasesSetTy &VBases) {
1887 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1888
1889 // Check if this base has a primary base.
1890 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
Anders Carlsson0378bf02010-02-28 18:08:38 +00001891
1892 // Check if it's virtual.
Anders Carlssonc9e814b2010-11-24 23:12:57 +00001893 if (Layout.isPrimaryBaseVirtual()) {
Anders Carlsson0378bf02010-02-28 18:08:38 +00001894 bool IsPrimaryVirtualBase = true;
1895
Anders Carlsson718d0692010-04-11 22:07:06 +00001896 if (isBuildingConstructorVTable()) {
Anders Carlsson0378bf02010-02-28 18:08:38 +00001897 // Check if the base is actually a primary base in the class we use for
1898 // layout.
Anders Carlssond7fdae52010-03-10 03:02:01 +00001899 const ASTRecordLayout &LayoutClassLayout =
1900 Context.getASTRecordLayout(LayoutClass);
1901
Ken Dyck8fe59932011-03-30 01:10:23 +00001902 CharUnits PrimaryBaseOffsetInLayoutClass =
1903 LayoutClassLayout.getVBaseClassOffset(PrimaryBase);
Anders Carlssond7fdae52010-03-10 03:02:01 +00001904
1905 // We know that the base is not a primary base in the layout class if
1906 // the base offsets are different.
1907 if (PrimaryBaseOffsetInLayoutClass != OffsetInLayoutClass)
Anders Carlsson0378bf02010-02-28 18:08:38 +00001908 IsPrimaryVirtualBase = false;
1909 }
1910
1911 if (IsPrimaryVirtualBase)
1912 PrimaryVirtualBases.insert(PrimaryBase);
1913 }
Anders Carlsson08c26752010-02-27 04:05:52 +00001914 }
1915
1916 // Traverse bases, looking for more primary virtual bases.
1917 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1918 E = RD->bases_end(); I != E; ++I) {
1919 const CXXRecordDecl *BaseDecl =
1920 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1921
Ken Dyck8fe59932011-03-30 01:10:23 +00001922 CharUnits BaseOffsetInLayoutClass;
Anders Carlssond7fdae52010-03-10 03:02:01 +00001923
1924 if (I->isVirtual()) {
1925 if (!VBases.insert(BaseDecl))
1926 continue;
1927
1928 const ASTRecordLayout &LayoutClassLayout =
1929 Context.getASTRecordLayout(LayoutClass);
Anders Carlsson08c26752010-02-27 04:05:52 +00001930
Anders Carlssona14f5972010-10-31 23:22:37 +00001931 BaseOffsetInLayoutClass =
Ken Dyck8fe59932011-03-30 01:10:23 +00001932 LayoutClassLayout.getVBaseClassOffset(BaseDecl);
Anders Carlssond7fdae52010-03-10 03:02:01 +00001933 } else {
1934 BaseOffsetInLayoutClass =
Ken Dyck8fe59932011-03-30 01:10:23 +00001935 OffsetInLayoutClass + Layout.getBaseClassOffset(BaseDecl);
Anders Carlssond7fdae52010-03-10 03:02:01 +00001936 }
1937
1938 DeterminePrimaryVirtualBases(BaseDecl, BaseOffsetInLayoutClass, VBases);
Anders Carlsson08c26752010-02-27 04:05:52 +00001939 }
1940}
1941
1942void
Anders Carlsson718d0692010-04-11 22:07:06 +00001943VTableBuilder::LayoutVTablesForVirtualBases(const CXXRecordDecl *RD,
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001944 VisitedVirtualBasesSetTy &VBases) {
1945 // Itanium C++ ABI 2.5.2:
1946 // Then come the virtual base virtual tables, also in inheritance graph
1947 // order, and again excluding primary bases (which share virtual tables with
1948 // the classes for which they are primary).
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001949 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1950 E = RD->bases_end(); I != E; ++I) {
1951 const CXXRecordDecl *BaseDecl =
1952 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1953
Anders Carlssonaf280c02010-02-23 03:48:14 +00001954 // Check if this base needs a vtable. (If it's virtual, not a primary base
1955 // of some other class, and we haven't visited it before).
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001956 if (I->isVirtual() && BaseDecl->isDynamicClass() &&
Anders Carlsson08c26752010-02-27 04:05:52 +00001957 !PrimaryVirtualBases.count(BaseDecl) && VBases.insert(BaseDecl)) {
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001958 const ASTRecordLayout &MostDerivedClassLayout =
1959 Context.getASTRecordLayout(MostDerivedClass);
Ken Dyck7262e902011-03-30 01:14:22 +00001960 CharUnits BaseOffset =
1961 MostDerivedClassLayout.getVBaseClassOffset(BaseDecl);
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001962
Anders Carlsson530c40c2010-02-28 01:43:58 +00001963 const ASTRecordLayout &LayoutClassLayout =
1964 Context.getASTRecordLayout(LayoutClass);
Ken Dyck7ba8f522011-03-27 20:33:38 +00001965 CharUnits BaseOffsetInLayoutClass =
1966 LayoutClassLayout.getVBaseClassOffset(BaseDecl);
Anders Carlsson530c40c2010-02-28 01:43:58 +00001967
Ken Dyck4230d522011-03-24 01:21:01 +00001968 LayoutPrimaryAndSecondaryVTables(
Ken Dyck7262e902011-03-30 01:14:22 +00001969 BaseSubobject(BaseDecl, BaseOffset),
Ken Dyck4230d522011-03-24 01:21:01 +00001970 /*BaseIsMorallyVirtual=*/true,
1971 /*BaseIsVirtualInLayoutClass=*/true,
1972 BaseOffsetInLayoutClass);
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001973 }
1974
1975 // We only need to check the base for virtual base vtables if it actually
1976 // has virtual bases.
1977 if (BaseDecl->getNumVBases())
Anders Carlsson718d0692010-04-11 22:07:06 +00001978 LayoutVTablesForVirtualBases(BaseDecl, VBases);
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001979 }
1980}
1981
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001982/// dumpLayout - Dump the vtable layout.
Anders Carlsson94464812010-04-10 19:13:06 +00001983void VTableBuilder::dumpLayout(llvm::raw_ostream& Out) {
Anders Carlssond03a3262010-02-27 20:39:05 +00001984
Anders Carlsson718d0692010-04-11 22:07:06 +00001985 if (isBuildingConstructorVTable()) {
Anders Carlssond03a3262010-02-27 20:39:05 +00001986 Out << "Construction vtable for ('";
1987 Out << MostDerivedClass->getQualifiedNameAsString() << "', ";
Ken Dyck23da84a2011-03-27 20:20:28 +00001988 Out << MostDerivedClassOffset.getQuantity() << ") in '";
Anders Carlssond03a3262010-02-27 20:39:05 +00001989 Out << LayoutClass->getQualifiedNameAsString();
Anders Carlssonbb6305b2010-03-11 06:43:12 +00001990 } else {
1991 Out << "Vtable for '";
1992 Out << MostDerivedClass->getQualifiedNameAsString();
Anders Carlssond03a3262010-02-27 20:39:05 +00001993 }
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001994 Out << "' (" << Components.size() << " entries).\n";
1995
Anders Carlsson822307b2010-02-11 17:18:51 +00001996 // Iterate through the address points and insert them into a new map where
1997 // they are keyed by the index and not the base object.
1998 // Since an address point can be shared by multiple subobjects, we use an
1999 // STL multimap.
2000 std::multimap<uint64_t, BaseSubobject> AddressPointsByIndex;
Anders Carlssonff143f82010-03-25 00:35:49 +00002001 for (AddressPointsMapTy::const_iterator I = AddressPoints.begin(),
2002 E = AddressPoints.end(); I != E; ++I) {
Anders Carlsson822307b2010-02-11 17:18:51 +00002003 const BaseSubobject& Base = I->first;
2004 uint64_t Index = I->second;
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002005
Anders Carlsson822307b2010-02-11 17:18:51 +00002006 AddressPointsByIndex.insert(std::make_pair(Index, Base));
2007 }
2008
2009 for (unsigned I = 0, E = Components.size(); I != E; ++I) {
Anders Carlsson28cbc8b2010-02-12 07:43:48 +00002010 uint64_t Index = I;
Anders Carlsson822307b2010-02-11 17:18:51 +00002011
2012 Out << llvm::format("%4d | ", I);
2013
Anders Carlsson94464812010-04-10 19:13:06 +00002014 const VTableComponent &Component = Components[I];
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002015
2016 // Dump the component.
2017 switch (Component.getKind()) {
Anders Carlssond9a67042010-02-17 06:07:19 +00002018
Anders Carlsson94464812010-04-10 19:13:06 +00002019 case VTableComponent::CK_VCallOffset:
Ken Dyckc40a3fd2011-04-02 01:14:48 +00002020 Out << "vcall_offset ("
2021 << Component.getVCallOffset().getQuantity()
2022 << ")";
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002023 break;
Anders Carlsson852213e2010-02-16 04:59:55 +00002024
Anders Carlsson94464812010-04-10 19:13:06 +00002025 case VTableComponent::CK_VBaseOffset:
Ken Dyckc40a3fd2011-04-02 01:14:48 +00002026 Out << "vbase_offset ("
2027 << Component.getVBaseOffset().getQuantity()
2028 << ")";
Anders Carlsson852213e2010-02-16 04:59:55 +00002029 break;
2030
Anders Carlsson94464812010-04-10 19:13:06 +00002031 case VTableComponent::CK_OffsetToTop:
Ken Dyckc40a3fd2011-04-02 01:14:48 +00002032 Out << "offset_to_top ("
2033 << Component.getOffsetToTop().getQuantity()
2034 << ")";
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002035 break;
2036
Anders Carlsson94464812010-04-10 19:13:06 +00002037 case VTableComponent::CK_RTTI:
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002038 Out << Component.getRTTIDecl()->getQualifiedNameAsString() << " RTTI";
2039 break;
2040
Anders Carlsson94464812010-04-10 19:13:06 +00002041 case VTableComponent::CK_FunctionPointer: {
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002042 const CXXMethodDecl *MD = Component.getFunctionDecl();
2043
Anders Carlsson848fa642010-02-11 18:20:28 +00002044 std::string Str =
2045 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
2046 MD);
2047 Out << Str;
Anders Carlsson98241422010-02-12 02:38:13 +00002048 if (MD->isPure())
2049 Out << " [pure]";
2050
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00002051 ThunkInfo Thunk = VTableThunks.lookup(I);
Anders Carlssondd366812010-03-12 04:54:20 +00002052 if (!Thunk.isEmpty()) {
2053 // If this function pointer has a return adjustment, dump it.
2054 if (!Thunk.Return.isEmpty()) {
2055 Out << "\n [return adjustment: ";
2056 Out << Thunk.Return.NonVirtual << " non-virtual";
2057
2058 if (Thunk.Return.VBaseOffsetOffset) {
2059 Out << ", " << Thunk.Return.VBaseOffsetOffset;
2060 Out << " vbase offset offset";
2061 }
Anders Carlsson60cc72a2010-02-18 17:00:09 +00002062
Anders Carlssondd366812010-03-12 04:54:20 +00002063 Out << ']';
2064 }
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00002065
Anders Carlssondd366812010-03-12 04:54:20 +00002066 // If this function pointer has a 'this' pointer adjustment, dump it.
2067 if (!Thunk.This.isEmpty()) {
2068 Out << "\n [this adjustment: ";
2069 Out << Thunk.This.NonVirtual << " non-virtual";
2070
2071 if (Thunk.This.VCallOffsetOffset) {
2072 Out << ", " << Thunk.This.VCallOffsetOffset;
2073 Out << " vcall offset offset";
2074 }
Anders Carlsson60cc72a2010-02-18 17:00:09 +00002075
Anders Carlssondd366812010-03-12 04:54:20 +00002076 Out << ']';
2077 }
Anders Carlsson49bac9a2010-02-13 23:40:17 +00002078 }
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00002079
Anders Carlsson848fa642010-02-11 18:20:28 +00002080 break;
2081 }
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002082
Anders Carlsson94464812010-04-10 19:13:06 +00002083 case VTableComponent::CK_CompleteDtorPointer:
2084 case VTableComponent::CK_DeletingDtorPointer: {
Anders Carlsson6065e022010-02-19 06:03:53 +00002085 bool IsComplete =
Anders Carlsson94464812010-04-10 19:13:06 +00002086 Component.getKind() == VTableComponent::CK_CompleteDtorPointer;
Anders Carlsson6065e022010-02-19 06:03:53 +00002087
Anders Carlsson848fa642010-02-11 18:20:28 +00002088 const CXXDestructorDecl *DD = Component.getDestructorDecl();
2089
Anders Carlsson6065e022010-02-19 06:03:53 +00002090 Out << DD->getQualifiedNameAsString();
2091 if (IsComplete)
2092 Out << "() [complete]";
2093 else
2094 Out << "() [deleting]";
2095
Anders Carlsson98241422010-02-12 02:38:13 +00002096 if (DD->isPure())
2097 Out << " [pure]";
2098
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00002099 ThunkInfo Thunk = VTableThunks.lookup(I);
Anders Carlssondd366812010-03-12 04:54:20 +00002100 if (!Thunk.isEmpty()) {
2101 // If this destructor has a 'this' pointer adjustment, dump it.
2102 if (!Thunk.This.isEmpty()) {
2103 Out << "\n [this adjustment: ";
2104 Out << Thunk.This.NonVirtual << " non-virtual";
2105
2106 if (Thunk.This.VCallOffsetOffset) {
2107 Out << ", " << Thunk.This.VCallOffsetOffset;
2108 Out << " vcall offset offset";
2109 }
2110
2111 Out << ']';
2112 }
2113 }
Anders Carlsson6065e022010-02-19 06:03:53 +00002114
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002115 break;
2116 }
2117
Anders Carlsson94464812010-04-10 19:13:06 +00002118 case VTableComponent::CK_UnusedFunctionPointer: {
Anders Carlsson1f464662010-02-19 20:08:13 +00002119 const CXXMethodDecl *MD = Component.getUnusedFunctionDecl();
2120
2121 std::string Str =
2122 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
2123 MD);
2124 Out << "[unused] " << Str;
2125 if (MD->isPure())
2126 Out << " [pure]";
2127 }
2128
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002129 }
Anders Carlsson822307b2010-02-11 17:18:51 +00002130
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002131 Out << '\n';
Anders Carlssond2c3a7c2010-02-27 23:58:01 +00002132
2133 // Dump the next address point.
2134 uint64_t NextIndex = Index + 1;
2135 if (AddressPointsByIndex.count(NextIndex)) {
2136 if (AddressPointsByIndex.count(NextIndex) == 1) {
2137 const BaseSubobject &Base =
2138 AddressPointsByIndex.find(NextIndex)->second;
2139
Anders Carlssond2c3a7c2010-02-27 23:58:01 +00002140 Out << " -- (" << Base.getBase()->getQualifiedNameAsString();
Ken Dyck4230d522011-03-24 01:21:01 +00002141 Out << ", " << Base.getBaseOffset().getQuantity();
2142 Out << ") vtable address --\n";
Anders Carlssond2c3a7c2010-02-27 23:58:01 +00002143 } else {
Ken Dyck57ebe332011-03-26 00:51:24 +00002144 CharUnits BaseOffset =
2145 AddressPointsByIndex.lower_bound(NextIndex)->second.getBaseOffset();
Anders Carlssond2c3a7c2010-02-27 23:58:01 +00002146
2147 // We store the class names in a set to get a stable order.
2148 std::set<std::string> ClassNames;
2149 for (std::multimap<uint64_t, BaseSubobject>::const_iterator I =
2150 AddressPointsByIndex.lower_bound(NextIndex), E =
2151 AddressPointsByIndex.upper_bound(NextIndex); I != E; ++I) {
Ken Dyck57ebe332011-03-26 00:51:24 +00002152 assert(I->second.getBaseOffset() == BaseOffset &&
Anders Carlssond2c3a7c2010-02-27 23:58:01 +00002153 "Invalid base offset!");
2154 const CXXRecordDecl *RD = I->second.getBase();
2155 ClassNames.insert(RD->getQualifiedNameAsString());
2156 }
2157
2158 for (std::set<std::string>::const_iterator I = ClassNames.begin(),
2159 E = ClassNames.end(); I != E; ++I) {
Anders Carlssond2c3a7c2010-02-27 23:58:01 +00002160 Out << " -- (" << *I;
Ken Dyck57ebe332011-03-26 00:51:24 +00002161 Out << ", " << BaseOffset.getQuantity() << ") vtable address --\n";
Anders Carlssond2c3a7c2010-02-27 23:58:01 +00002162 }
2163 }
2164 }
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002165 }
Anders Carlssond03a3262010-02-27 20:39:05 +00002166
2167 Out << '\n';
Anders Carlssonbb6305b2010-03-11 06:43:12 +00002168
Anders Carlsson718d0692010-04-11 22:07:06 +00002169 if (isBuildingConstructorVTable())
Anders Carlsson9135a842010-03-18 02:44:19 +00002170 return;
2171
2172 if (MostDerivedClass->getNumVBases()) {
Anders Carlssonbb6305b2010-03-11 06:43:12 +00002173 // We store the virtual base class names and their offsets in a map to get
2174 // a stable order.
Anders Carlssonbb6305b2010-03-11 06:43:12 +00002175
Anders Carlsson9135a842010-03-18 02:44:19 +00002176 std::map<std::string, int64_t> ClassNamesAndOffsets;
Anders Carlssonbb6305b2010-03-11 06:43:12 +00002177 for (VBaseOffsetOffsetsMapTy::const_iterator I = VBaseOffsetOffsets.begin(),
2178 E = VBaseOffsetOffsets.end(); I != E; ++I) {
2179 std::string ClassName = I->first->getQualifiedNameAsString();
2180 int64_t OffsetOffset = I->second;
2181 ClassNamesAndOffsets.insert(std::make_pair(ClassName, OffsetOffset));
2182 }
Anders Carlsson9135a842010-03-18 02:44:19 +00002183
2184 Out << "Virtual base offset offsets for '";
2185 Out << MostDerivedClass->getQualifiedNameAsString() << "' (";
2186 Out << ClassNamesAndOffsets.size();
2187 Out << (ClassNamesAndOffsets.size() == 1 ? " entry" : " entries") << ").\n";
Anders Carlssonbb6305b2010-03-11 06:43:12 +00002188
2189 for (std::map<std::string, int64_t>::const_iterator I =
2190 ClassNamesAndOffsets.begin(), E = ClassNamesAndOffsets.end();
2191 I != E; ++I)
2192 Out << " " << I->first << " | " << I->second << '\n';
2193
2194 Out << "\n";
2195 }
Anders Carlsson9135a842010-03-18 02:44:19 +00002196
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00002197 if (!Thunks.empty()) {
Anders Carlsson9135a842010-03-18 02:44:19 +00002198 // We store the method names in a map to get a stable order.
2199 std::map<std::string, const CXXMethodDecl *> MethodNamesAndDecls;
2200
Anders Carlssonee5ab9f2010-03-23 04:59:02 +00002201 for (ThunksMapTy::const_iterator I = Thunks.begin(), E = Thunks.end();
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00002202 I != E; ++I) {
Anders Carlsson9135a842010-03-18 02:44:19 +00002203 const CXXMethodDecl *MD = I->first;
2204 std::string MethodName =
2205 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
2206 MD);
2207
2208 MethodNamesAndDecls.insert(std::make_pair(MethodName, MD));
2209 }
2210
2211 for (std::map<std::string, const CXXMethodDecl *>::const_iterator I =
2212 MethodNamesAndDecls.begin(), E = MethodNamesAndDecls.end();
2213 I != E; ++I) {
2214 const std::string &MethodName = I->first;
2215 const CXXMethodDecl *MD = I->second;
Anders Carlsson87e0ac82010-03-22 16:30:44 +00002216
Anders Carlssonee5ab9f2010-03-23 04:59:02 +00002217 ThunkInfoVectorTy ThunksVector = Thunks[MD];
Anders Carlsson87e0ac82010-03-22 16:30:44 +00002218 std::sort(ThunksVector.begin(), ThunksVector.end());
Anders Carlsson9135a842010-03-18 02:44:19 +00002219
2220 Out << "Thunks for '" << MethodName << "' (" << ThunksVector.size();
2221 Out << (ThunksVector.size() == 1 ? " entry" : " entries") << ").\n";
2222
2223 for (unsigned I = 0, E = ThunksVector.size(); I != E; ++I) {
2224 const ThunkInfo &Thunk = ThunksVector[I];
2225
2226 Out << llvm::format("%4d | ", I);
2227
Anders Carlsson09daa502010-03-22 16:10:59 +00002228 // If this function pointer has a return pointer adjustment, dump it.
2229 if (!Thunk.Return.isEmpty()) {
2230 Out << "return adjustment: " << Thunk.This.NonVirtual;
2231 Out << " non-virtual";
2232 if (Thunk.Return.VBaseOffsetOffset) {
2233 Out << ", " << Thunk.Return.VBaseOffsetOffset;
2234 Out << " vbase offset offset";
2235 }
2236
2237 if (!Thunk.This.isEmpty())
2238 Out << "\n ";
2239 }
2240
Anders Carlsson9135a842010-03-18 02:44:19 +00002241 // If this function pointer has a 'this' pointer adjustment, dump it.
2242 if (!Thunk.This.isEmpty()) {
Anders Carlsson09daa502010-03-22 16:10:59 +00002243 Out << "this adjustment: ";
2244 Out << Thunk.This.NonVirtual << " non-virtual";
Anders Carlsson9135a842010-03-18 02:44:19 +00002245
2246 if (Thunk.This.VCallOffsetOffset) {
2247 Out << ", " << Thunk.This.VCallOffsetOffset;
Anders Carlsson09daa502010-03-22 16:10:59 +00002248 Out << " vcall offset offset";
Anders Carlsson9135a842010-03-18 02:44:19 +00002249 }
2250 }
2251
2252 Out << '\n';
2253 }
Anders Carlssonbca5d372010-03-22 20:06:40 +00002254
2255 Out << '\n';
2256
Anders Carlsson9135a842010-03-18 02:44:19 +00002257 }
2258 }
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002259}
2260
2261}
2262
Anders Carlssonbdb4a9d2010-11-24 23:04:03 +00002263static void
2264CollectPrimaryBases(const CXXRecordDecl *RD, ASTContext &Context,
2265 VTableBuilder::PrimaryBasesSetVectorTy &PrimaryBases) {
2266 while (RD) {
2267 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
2268 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
2269 if (PrimaryBase)
2270 PrimaryBases.insert(PrimaryBase);
2271
2272 RD = PrimaryBase;
2273 }
2274}
2275
Anders Carlsson046c2942010-04-17 20:15:18 +00002276void CodeGenVTables::ComputeMethodVTableIndices(const CXXRecordDecl *RD) {
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002277
2278 // Itanium C++ ABI 2.5.2:
Anders Carlsson45147d02010-02-02 03:37:46 +00002279 // The order of the virtual function pointers in a virtual table is the
2280 // order of declaration of the corresponding member functions in the class.
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002281 //
Anders Carlsson45147d02010-02-02 03:37:46 +00002282 // There is an entry for any virtual function declared in a class,
2283 // whether it is a new function or overrides a base class function,
2284 // unless it overrides a function from the primary base, and conversion
2285 // between their return types does not require an adjustment.
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002286
2287 int64_t CurrentIndex = 0;
2288
2289 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
2290 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
2291
2292 if (PrimaryBase) {
Anders Carlsson0121fbd2009-11-30 19:43:26 +00002293 assert(PrimaryBase->isDefinition() &&
2294 "Should have the definition decl of the primary base!");
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002295
2296 // Since the record decl shares its vtable pointer with the primary base
2297 // we need to start counting at the end of the primary base's vtable.
2298 CurrentIndex = getNumVirtualFunctionPointers(PrimaryBase);
2299 }
Eli Friedmanea5ae312009-12-15 03:31:17 +00002300
2301 // Collect all the primary bases, so we can check whether methods override
2302 // a method from the base.
Anders Carlsson94464812010-04-10 19:13:06 +00002303 VTableBuilder::PrimaryBasesSetVectorTy PrimaryBases;
Anders Carlssonbdb4a9d2010-11-24 23:04:03 +00002304 CollectPrimaryBases(RD, CGM.getContext(), PrimaryBases);
Eli Friedmanea5ae312009-12-15 03:31:17 +00002305
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002306 const CXXDestructorDecl *ImplicitVirtualDtor = 0;
2307
2308 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
2309 e = RD->method_end(); i != e; ++i) {
2310 const CXXMethodDecl *MD = *i;
2311
2312 // We only want virtual methods.
2313 if (!MD->isVirtual())
2314 continue;
2315
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002316 // Check if this method overrides a method in the primary base.
Anders Carlsson57071e22010-02-12 05:25:12 +00002317 if (const CXXMethodDecl *OverriddenMD =
Anders Carlssonf622b452010-04-10 20:39:29 +00002318 FindNearestOverriddenMethod(MD, PrimaryBases)) {
Anders Carlsson57071e22010-02-12 05:25:12 +00002319 // Check if converting from the return type of the method to the
2320 // return type of the overridden method requires conversion.
Anders Carlssondf31af12010-02-13 23:17:31 +00002321 if (ComputeReturnAdjustmentBaseOffset(CGM.getContext(), MD,
2322 OverriddenMD).isEmpty()) {
Anders Carlsson57071e22010-02-12 05:25:12 +00002323 // This index is shared between the index in the vtable of the primary
2324 // base class.
2325 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2326 const CXXDestructorDecl *OverriddenDD =
2327 cast<CXXDestructorDecl>(OverriddenMD);
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002328
Anders Carlsson57071e22010-02-12 05:25:12 +00002329 // Add both the complete and deleting entries.
Anders Carlsson046c2942010-04-17 20:15:18 +00002330 MethodVTableIndices[GlobalDecl(DD, Dtor_Complete)] =
2331 getMethodVTableIndex(GlobalDecl(OverriddenDD, Dtor_Complete));
2332 MethodVTableIndices[GlobalDecl(DD, Dtor_Deleting)] =
2333 getMethodVTableIndex(GlobalDecl(OverriddenDD, Dtor_Deleting));
Anders Carlsson57071e22010-02-12 05:25:12 +00002334 } else {
Anders Carlsson046c2942010-04-17 20:15:18 +00002335 MethodVTableIndices[MD] = getMethodVTableIndex(OverriddenMD);
Anders Carlsson57071e22010-02-12 05:25:12 +00002336 }
2337
2338 // We don't need to add an entry for this method.
Anders Carlssonc1eec892010-02-12 18:14:46 +00002339 continue;
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002340 }
2341 }
2342
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002343 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2344 if (MD->isImplicit()) {
2345 assert(!ImplicitVirtualDtor &&
2346 "Did already see an implicit virtual dtor!");
2347 ImplicitVirtualDtor = DD;
2348 continue;
2349 }
Tilmann Schellerca0df922011-03-02 20:40:50 +00002350
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002351 // Add the complete dtor.
Anders Carlsson046c2942010-04-17 20:15:18 +00002352 MethodVTableIndices[GlobalDecl(DD, Dtor_Complete)] = CurrentIndex++;
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002353
2354 // Add the deleting dtor.
Anders Carlsson046c2942010-04-17 20:15:18 +00002355 MethodVTableIndices[GlobalDecl(DD, Dtor_Deleting)] = CurrentIndex++;
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002356 } else {
2357 // Add the entry.
Tilmann Schellerca0df922011-03-02 20:40:50 +00002358 MethodVTableIndices[MD] = CurrentIndex++;
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002359 }
2360 }
2361
2362 if (ImplicitVirtualDtor) {
2363 // Itanium C++ ABI 2.5.2:
Anders Carlssona661a542010-02-16 04:49:44 +00002364 // If a class has an implicitly-defined virtual destructor,
2365 // its entries come after the declared virtual function pointers.
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002366
2367 // Add the complete dtor.
Anders Carlsson046c2942010-04-17 20:15:18 +00002368 MethodVTableIndices[GlobalDecl(ImplicitVirtualDtor, Dtor_Complete)] =
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002369 CurrentIndex++;
2370
2371 // Add the deleting dtor.
Anders Carlsson046c2942010-04-17 20:15:18 +00002372 MethodVTableIndices[GlobalDecl(ImplicitVirtualDtor, Dtor_Deleting)] =
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002373 CurrentIndex++;
2374 }
2375
2376 NumVirtualFunctionPointers[RD] = CurrentIndex;
2377}
2378
Argyrios Kyrtzidisd2c47bd2010-10-11 03:25:57 +00002379bool CodeGenVTables::ShouldEmitVTableInThisTU(const CXXRecordDecl *RD) {
2380 assert(RD->isDynamicClass() && "Non dynamic classes have no VTable.");
2381
2382 TemplateSpecializationKind TSK = RD->getTemplateSpecializationKind();
2383 if (TSK == TSK_ExplicitInstantiationDeclaration)
2384 return false;
2385
2386 const CXXMethodDecl *KeyFunction = CGM.getContext().getKeyFunction(RD);
2387 if (!KeyFunction)
2388 return true;
2389
2390 // Itanium C++ ABI, 5.2.6 Instantiated Templates:
2391 // An instantiation of a class template requires:
2392 // - In the object where instantiated, the virtual table...
2393 if (TSK == TSK_ImplicitInstantiation ||
2394 TSK == TSK_ExplicitInstantiationDefinition)
2395 return true;
2396
Anders Carlsson6d7f8472011-01-30 20:45:54 +00002397 // If we're building with optimization, we always emit VTables since that
2398 // allows for virtual function calls to be devirtualized.
2399 // (We don't want to do this in -fapple-kext mode however).
2400 if (CGM.getCodeGenOpts().OptimizationLevel && !CGM.getLangOptions().AppleKext)
2401 return true;
2402
Argyrios Kyrtzidisd2c47bd2010-10-11 03:25:57 +00002403 return KeyFunction->hasBody();
2404}
2405
Anders Carlssonaf440352010-03-23 04:11:45 +00002406uint64_t CodeGenVTables::getNumVirtualFunctionPointers(const CXXRecordDecl *RD) {
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002407 llvm::DenseMap<const CXXRecordDecl *, uint64_t>::iterator I =
2408 NumVirtualFunctionPointers.find(RD);
2409 if (I != NumVirtualFunctionPointers.end())
2410 return I->second;
2411
Anders Carlsson046c2942010-04-17 20:15:18 +00002412 ComputeMethodVTableIndices(RD);
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002413
2414 I = NumVirtualFunctionPointers.find(RD);
2415 assert(I != NumVirtualFunctionPointers.end() && "Did not find entry!");
2416 return I->second;
2417}
2418
Anders Carlsson046c2942010-04-17 20:15:18 +00002419uint64_t CodeGenVTables::getMethodVTableIndex(GlobalDecl GD) {
2420 MethodVTableIndicesTy::iterator I = MethodVTableIndices.find(GD);
2421 if (I != MethodVTableIndices.end())
Anders Carlssondbd920c2009-10-11 22:13:54 +00002422 return I->second;
2423
Anders Carlssona0fdd912009-11-13 17:08:56 +00002424 const CXXRecordDecl *RD = cast<CXXMethodDecl>(GD.getDecl())->getParent();
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002425
Anders Carlsson046c2942010-04-17 20:15:18 +00002426 ComputeMethodVTableIndices(RD);
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002427
Anders Carlsson046c2942010-04-17 20:15:18 +00002428 I = MethodVTableIndices.find(GD);
2429 assert(I != MethodVTableIndices.end() && "Did not find index!");
Anders Carlssondbd920c2009-10-11 22:13:54 +00002430 return I->second;
2431}
2432
Anders Carlssonaf440352010-03-23 04:11:45 +00002433int64_t CodeGenVTables::getVirtualBaseOffsetOffset(const CXXRecordDecl *RD,
2434 const CXXRecordDecl *VBase) {
Anders Carlssondbd920c2009-10-11 22:13:54 +00002435 ClassPairTy ClassPair(RD, VBase);
2436
Anders Carlssonbba16072010-03-11 07:15:17 +00002437 VirtualBaseClassOffsetOffsetsMapTy::iterator I =
2438 VirtualBaseClassOffsetOffsets.find(ClassPair);
2439 if (I != VirtualBaseClassOffsetOffsets.end())
Anders Carlssondbd920c2009-10-11 22:13:54 +00002440 return I->second;
2441
Anders Carlssonc89a7cf2010-03-11 16:06:20 +00002442 VCallAndVBaseOffsetBuilder Builder(RD, RD, /*FinalOverriders=*/0,
Ken Dyck4230d522011-03-24 01:21:01 +00002443 BaseSubobject(RD, CharUnits::Zero()),
Anders Carlssonc89a7cf2010-03-11 16:06:20 +00002444 /*BaseIsVirtual=*/false,
Ken Dyck3ecfa2d2011-03-31 00:48:04 +00002445 /*OffsetInLayoutClass=*/CharUnits::Zero());
Anders Carlssonc89a7cf2010-03-11 16:06:20 +00002446
2447 for (VCallAndVBaseOffsetBuilder::VBaseOffsetOffsetsMapTy::const_iterator I =
2448 Builder.getVBaseOffsetOffsets().begin(),
2449 E = Builder.getVBaseOffsetOffsets().end(); I != E; ++I) {
Anders Carlssondbd920c2009-10-11 22:13:54 +00002450 // Insert all types.
2451 ClassPairTy ClassPair(RD, I->first);
2452
Anders Carlssonbba16072010-03-11 07:15:17 +00002453 VirtualBaseClassOffsetOffsets.insert(std::make_pair(ClassPair, I->second));
Anders Carlssondbd920c2009-10-11 22:13:54 +00002454 }
2455
Anders Carlssonbba16072010-03-11 07:15:17 +00002456 I = VirtualBaseClassOffsetOffsets.find(ClassPair);
Anders Carlssonbba16072010-03-11 07:15:17 +00002457 assert(I != VirtualBaseClassOffsetOffsets.end() && "Did not find index!");
Anders Carlssondbd920c2009-10-11 22:13:54 +00002458
2459 return I->second;
2460}
2461
Anders Carlsson64c9eca2010-03-29 02:08:26 +00002462uint64_t
2463CodeGenVTables::getAddressPoint(BaseSubobject Base, const CXXRecordDecl *RD) {
Anders Carlssonec9c2022010-04-08 16:18:36 +00002464 assert(AddressPoints.count(std::make_pair(RD, Base)) &&
2465 "Did not find address point!");
2466
Anders Carlssona7cde3b2010-03-29 03:38:52 +00002467 uint64_t AddressPoint = AddressPoints.lookup(std::make_pair(RD, Base));
Anders Carlsson64c9eca2010-03-29 02:08:26 +00002468 assert(AddressPoint && "Address point must not be zero!");
Anders Carlssona7cde3b2010-03-29 03:38:52 +00002469
Anders Carlsson64c9eca2010-03-29 02:08:26 +00002470 return AddressPoint;
2471}
2472
Anders Carlsson19879c92010-03-23 17:17:29 +00002473llvm::Constant *CodeGenModule::GetAddrOfThunk(GlobalDecl GD,
Anders Carlsson84c49e42011-02-06 17:15:43 +00002474 const ThunkInfo &Thunk) {
Anders Carlsson19879c92010-03-23 17:17:29 +00002475 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2476
2477 // Compute the mangled name.
2478 llvm::SmallString<256> Name;
Rafael Espindolaf0be9792011-02-11 02:52:17 +00002479 llvm::raw_svector_ostream Out(Name);
Anders Carlsson19879c92010-03-23 17:17:29 +00002480 if (const CXXDestructorDecl* DD = dyn_cast<CXXDestructorDecl>(MD))
John McCall4c40d982010-08-31 07:33:07 +00002481 getCXXABI().getMangleContext().mangleCXXDtorThunk(DD, GD.getDtorType(),
Rafael Espindolaf0be9792011-02-11 02:52:17 +00002482 Thunk.This, Out);
Anders Carlsson19879c92010-03-23 17:17:29 +00002483 else
Rafael Espindolaf0be9792011-02-11 02:52:17 +00002484 getCXXABI().getMangleContext().mangleThunk(MD, Thunk, Out);
2485 Out.flush();
2486
John McCall4c40d982010-08-31 07:33:07 +00002487 const llvm::Type *Ty = getTypes().GetFunctionTypeForVTable(GD);
Anders Carlsson84c49e42011-02-06 17:15:43 +00002488 return GetOrCreateLLVMFunction(Name, Ty, GD, /*ForVTable=*/true);
Anders Carlsson19879c92010-03-23 17:17:29 +00002489}
2490
Anders Carlsson519c3282010-03-24 00:39:18 +00002491static llvm::Value *PerformTypeAdjustment(CodeGenFunction &CGF,
2492 llvm::Value *Ptr,
2493 int64_t NonVirtualAdjustment,
2494 int64_t VirtualAdjustment) {
2495 if (!NonVirtualAdjustment && !VirtualAdjustment)
2496 return Ptr;
2497
2498 const llvm::Type *Int8PtrTy =
2499 llvm::Type::getInt8PtrTy(CGF.getLLVMContext());
2500
2501 llvm::Value *V = CGF.Builder.CreateBitCast(Ptr, Int8PtrTy);
2502
2503 if (NonVirtualAdjustment) {
2504 // Do the non-virtual adjustment.
2505 V = CGF.Builder.CreateConstInBoundsGEP1_64(V, NonVirtualAdjustment);
2506 }
2507
2508 if (VirtualAdjustment) {
2509 const llvm::Type *PtrDiffTy =
2510 CGF.ConvertType(CGF.getContext().getPointerDiffType());
2511
2512 // Do the virtual adjustment.
2513 llvm::Value *VTablePtrPtr =
2514 CGF.Builder.CreateBitCast(V, Int8PtrTy->getPointerTo());
2515
2516 llvm::Value *VTablePtr = CGF.Builder.CreateLoad(VTablePtrPtr);
2517
2518 llvm::Value *OffsetPtr =
2519 CGF.Builder.CreateConstInBoundsGEP1_64(VTablePtr, VirtualAdjustment);
2520
2521 OffsetPtr = CGF.Builder.CreateBitCast(OffsetPtr, PtrDiffTy->getPointerTo());
2522
2523 // Load the adjustment offset from the vtable.
2524 llvm::Value *Offset = CGF.Builder.CreateLoad(OffsetPtr);
2525
2526 // Adjust our pointer.
2527 V = CGF.Builder.CreateInBoundsGEP(V, Offset);
2528 }
2529
2530 // Cast back to the original type.
2531 return CGF.Builder.CreateBitCast(V, Ptr->getType());
2532}
2533
John McCall65005532010-08-04 23:46:35 +00002534static void setThunkVisibility(CodeGenModule &CGM, const CXXMethodDecl *MD,
2535 const ThunkInfo &Thunk, llvm::Function *Fn) {
Anders Carlsson0ffeaad2011-01-29 19:39:23 +00002536 CGM.setGlobalVisibility(Fn, MD);
John McCall65005532010-08-04 23:46:35 +00002537
John McCall279b5eb2010-08-12 23:36:15 +00002538 if (!CGM.getCodeGenOpts().HiddenWeakVTables)
2539 return;
2540
John McCall65005532010-08-04 23:46:35 +00002541 // If the thunk has weak/linkonce linkage, but the function must be
2542 // emitted in every translation unit that references it, then we can
2543 // emit its thunks with hidden visibility, since its thunks must be
2544 // emitted when the function is.
2545
John McCall7a536902010-08-05 20:39:18 +00002546 // This follows CodeGenModule::setTypeVisibility; see the comments
2547 // there for explanation.
John McCall65005532010-08-04 23:46:35 +00002548
2549 if ((Fn->getLinkage() != llvm::GlobalVariable::LinkOnceODRLinkage &&
2550 Fn->getLinkage() != llvm::GlobalVariable::WeakODRLinkage) ||
2551 Fn->getVisibility() != llvm::GlobalVariable::DefaultVisibility)
2552 return;
2553
Douglas Gregor4421d2b2011-03-26 12:10:19 +00002554 if (MD->getExplicitVisibility())
John McCall65005532010-08-04 23:46:35 +00002555 return;
2556
2557 switch (MD->getTemplateSpecializationKind()) {
John McCall65005532010-08-04 23:46:35 +00002558 case TSK_ExplicitInstantiationDefinition:
2559 case TSK_ExplicitInstantiationDeclaration:
2560 return;
2561
John McCall65005532010-08-04 23:46:35 +00002562 case TSK_Undeclared:
2563 break;
2564
John McCall7a536902010-08-05 20:39:18 +00002565 case TSK_ExplicitSpecialization:
John McCall65005532010-08-04 23:46:35 +00002566 case TSK_ImplicitInstantiation:
John McCall279b5eb2010-08-12 23:36:15 +00002567 if (!CGM.getCodeGenOpts().HiddenWeakTemplateVTables)
John McCall7a536902010-08-05 20:39:18 +00002568 return;
John McCall65005532010-08-04 23:46:35 +00002569 break;
2570 }
2571
2572 // If there's an explicit definition, and that definition is
2573 // out-of-line, then we can't assume that all users will have a
2574 // definition to emit.
2575 const FunctionDecl *Def = 0;
2576 if (MD->hasBody(Def) && Def->isOutOfLine())
2577 return;
2578
2579 Fn->setVisibility(llvm::GlobalValue::HiddenVisibility);
2580}
2581
John McCall311b4422011-03-09 07:12:35 +00002582#ifndef NDEBUG
2583static bool similar(const ABIArgInfo &infoL, CanQualType typeL,
2584 const ABIArgInfo &infoR, CanQualType typeR) {
2585 return (infoL.getKind() == infoR.getKind() &&
2586 (typeL == typeR ||
2587 (isa<PointerType>(typeL) && isa<PointerType>(typeR)) ||
2588 (isa<ReferenceType>(typeL) && isa<ReferenceType>(typeR))));
2589}
2590#endif
2591
John McCalld26bc762011-03-09 04:27:21 +00002592void CodeGenFunction::GenerateThunk(llvm::Function *Fn,
2593 const CGFunctionInfo &FnInfo,
2594 GlobalDecl GD, const ThunkInfo &Thunk) {
Anders Carlsson519c3282010-03-24 00:39:18 +00002595 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2596 const FunctionProtoType *FPT = MD->getType()->getAs<FunctionProtoType>();
2597 QualType ResultType = FPT->getResultType();
2598 QualType ThisType = MD->getThisType(getContext());
2599
2600 FunctionArgList FunctionArgs;
2601
2602 // FIXME: It would be nice if more of this code could be shared with
2603 // CodeGenFunction::GenerateCode.
2604
2605 // Create the implicit 'this' parameter declaration.
John McCall4c40d982010-08-31 07:33:07 +00002606 CurGD = GD;
2607 CGM.getCXXABI().BuildInstanceFunctionParams(*this, ResultType, FunctionArgs);
Anders Carlsson519c3282010-03-24 00:39:18 +00002608
2609 // Add the rest of the parameters.
2610 for (FunctionDecl::param_const_iterator I = MD->param_begin(),
2611 E = MD->param_end(); I != E; ++I) {
2612 ParmVarDecl *Param = *I;
2613
John McCalld26bc762011-03-09 04:27:21 +00002614 FunctionArgs.push_back(Param);
Anders Carlsson519c3282010-03-24 00:39:18 +00002615 }
Tilmann Scheller9c6082f2011-03-02 21:36:49 +00002616
John McCalld26bc762011-03-09 04:27:21 +00002617 StartFunction(GlobalDecl(), ResultType, Fn, FnInfo, FunctionArgs,
2618 SourceLocation());
Anders Carlsson519c3282010-03-24 00:39:18 +00002619
John McCall4c40d982010-08-31 07:33:07 +00002620 CGM.getCXXABI().EmitInstanceFunctionProlog(*this);
2621
Anders Carlsson519c3282010-03-24 00:39:18 +00002622 // Adjust the 'this' pointer if necessary.
2623 llvm::Value *AdjustedThisPtr =
2624 PerformTypeAdjustment(*this, LoadCXXThis(),
2625 Thunk.This.NonVirtual,
2626 Thunk.This.VCallOffsetOffset);
2627
2628 CallArgList CallArgs;
2629
2630 // Add our adjusted 'this' pointer.
2631 CallArgs.push_back(std::make_pair(RValue::get(AdjustedThisPtr), ThisType));
2632
2633 // Add the rest of the parameters.
2634 for (FunctionDecl::param_const_iterator I = MD->param_begin(),
2635 E = MD->param_end(); I != E; ++I) {
John McCall413ebdb2011-03-11 20:59:21 +00002636 ParmVarDecl *param = *I;
2637 EmitDelegateCallArg(CallArgs, param);
Anders Carlsson519c3282010-03-24 00:39:18 +00002638 }
2639
2640 // Get our callee.
2641 const llvm::Type *Ty =
John McCall4c40d982010-08-31 07:33:07 +00002642 CGM.getTypes().GetFunctionType(CGM.getTypes().getFunctionInfo(GD),
Anders Carlsson519c3282010-03-24 00:39:18 +00002643 FPT->isVariadic());
Anders Carlsson84c49e42011-02-06 17:15:43 +00002644 llvm::Value *Callee = CGM.GetAddrOfFunction(GD, Ty, /*ForVTable=*/true);
Anders Carlsson519c3282010-03-24 00:39:18 +00002645
John McCalld26bc762011-03-09 04:27:21 +00002646#ifndef NDEBUG
2647 const CGFunctionInfo &CallFnInfo =
2648 CGM.getTypes().getFunctionInfo(ResultType, CallArgs, FPT->getExtInfo());
John McCall311b4422011-03-09 07:12:35 +00002649 assert(CallFnInfo.getRegParm() == FnInfo.getRegParm() &&
2650 CallFnInfo.isNoReturn() == FnInfo.isNoReturn() &&
2651 CallFnInfo.getCallingConvention() == FnInfo.getCallingConvention());
2652 assert(similar(CallFnInfo.getReturnInfo(), CallFnInfo.getReturnType(),
2653 FnInfo.getReturnInfo(), FnInfo.getReturnType()));
2654 assert(CallFnInfo.arg_size() == FnInfo.arg_size());
2655 for (unsigned i = 0, e = FnInfo.arg_size(); i != e; ++i)
2656 assert(similar(CallFnInfo.arg_begin()[i].info,
2657 CallFnInfo.arg_begin()[i].type,
2658 FnInfo.arg_begin()[i].info, FnInfo.arg_begin()[i].type));
John McCalld26bc762011-03-09 04:27:21 +00002659#endif
Anders Carlsson519c3282010-03-24 00:39:18 +00002660
Douglas Gregorcb359df2010-05-20 05:54:35 +00002661 // Determine whether we have a return value slot to use.
2662 ReturnValueSlot Slot;
2663 if (!ResultType->isVoidType() &&
2664 FnInfo.getReturnInfo().getKind() == ABIArgInfo::Indirect &&
2665 hasAggregateLLVMType(CurFnInfo->getReturnType()))
2666 Slot = ReturnValueSlot(ReturnValue, ResultType.isVolatileQualified());
2667
Anders Carlsson519c3282010-03-24 00:39:18 +00002668 // Now emit our call.
Douglas Gregorcb359df2010-05-20 05:54:35 +00002669 RValue RV = EmitCall(FnInfo, Callee, Slot, CallArgs, MD);
Anders Carlsson519c3282010-03-24 00:39:18 +00002670
2671 if (!Thunk.Return.isEmpty()) {
2672 // Emit the return adjustment.
2673 bool NullCheckValue = !ResultType->isReferenceType();
2674
2675 llvm::BasicBlock *AdjustNull = 0;
2676 llvm::BasicBlock *AdjustNotNull = 0;
2677 llvm::BasicBlock *AdjustEnd = 0;
2678
2679 llvm::Value *ReturnValue = RV.getScalarVal();
2680
2681 if (NullCheckValue) {
2682 AdjustNull = createBasicBlock("adjust.null");
2683 AdjustNotNull = createBasicBlock("adjust.notnull");
2684 AdjustEnd = createBasicBlock("adjust.end");
2685
2686 llvm::Value *IsNull = Builder.CreateIsNull(ReturnValue);
2687 Builder.CreateCondBr(IsNull, AdjustNull, AdjustNotNull);
2688 EmitBlock(AdjustNotNull);
2689 }
2690
2691 ReturnValue = PerformTypeAdjustment(*this, ReturnValue,
2692 Thunk.Return.NonVirtual,
2693 Thunk.Return.VBaseOffsetOffset);
2694
2695 if (NullCheckValue) {
2696 Builder.CreateBr(AdjustEnd);
2697 EmitBlock(AdjustNull);
2698 Builder.CreateBr(AdjustEnd);
2699 EmitBlock(AdjustEnd);
2700
Jay Foadbbf3bac2011-03-30 11:28:58 +00002701 llvm::PHINode *PHI = Builder.CreatePHI(ReturnValue->getType(), 2);
Anders Carlsson519c3282010-03-24 00:39:18 +00002702 PHI->addIncoming(ReturnValue, AdjustNotNull);
2703 PHI->addIncoming(llvm::Constant::getNullValue(ReturnValue->getType()),
2704 AdjustNull);
2705 ReturnValue = PHI;
2706 }
2707
2708 RV = RValue::get(ReturnValue);
2709 }
2710
Douglas Gregorcb359df2010-05-20 05:54:35 +00002711 if (!ResultType->isVoidType() && Slot.isNull())
John McCalld16c2cf2011-02-08 08:22:06 +00002712 CGM.getCXXABI().EmitReturnFromThunk(*this, RV, ResultType);
Anders Carlsson519c3282010-03-24 00:39:18 +00002713
2714 FinishFunction();
2715
Anders Carlsson519c3282010-03-24 00:39:18 +00002716 // Set the right linkage.
John McCall8b242332010-05-25 04:30:21 +00002717 CGM.setFunctionLinkage(MD, Fn);
Anders Carlsson519c3282010-03-24 00:39:18 +00002718
2719 // Set the right visibility.
John McCall65005532010-08-04 23:46:35 +00002720 setThunkVisibility(CGM, MD, Thunk, Fn);
Anders Carlsson519c3282010-03-24 00:39:18 +00002721}
2722
Anders Carlsson14e82fd2011-02-06 18:31:40 +00002723void CodeGenVTables::EmitThunk(GlobalDecl GD, const ThunkInfo &Thunk,
2724 bool UseAvailableExternallyLinkage)
Anders Carlssonfbf6ed42010-03-23 16:36:50 +00002725{
John McCalld26bc762011-03-09 04:27:21 +00002726 const CGFunctionInfo &FnInfo = CGM.getTypes().getFunctionInfo(GD);
2727
2728 // FIXME: re-use FnInfo in this computation.
Anders Carlsson84c49e42011-02-06 17:15:43 +00002729 llvm::Constant *Entry = CGM.GetAddrOfThunk(GD, Thunk);
Anders Carlsson19879c92010-03-23 17:17:29 +00002730
Anders Carlsson7986ad52010-03-23 18:18:41 +00002731 // Strip off a bitcast if we got one back.
Anders Carlsson13d68982010-03-24 00:35:44 +00002732 if (llvm::ConstantExpr *CE = dyn_cast<llvm::ConstantExpr>(Entry)) {
Anders Carlsson7986ad52010-03-23 18:18:41 +00002733 assert(CE->getOpcode() == llvm::Instruction::BitCast);
Anders Carlsson13d68982010-03-24 00:35:44 +00002734 Entry = CE->getOperand(0);
Anders Carlsson7986ad52010-03-23 18:18:41 +00002735 }
2736
Anders Carlsson7986ad52010-03-23 18:18:41 +00002737 // There's already a declaration with the same name, check if it has the same
2738 // type or if we need to replace it.
Anders Carlsson13d68982010-03-24 00:35:44 +00002739 if (cast<llvm::GlobalValue>(Entry)->getType()->getElementType() !=
John McCall4c40d982010-08-31 07:33:07 +00002740 CGM.getTypes().GetFunctionTypeForVTable(GD)) {
Anders Carlsson13d68982010-03-24 00:35:44 +00002741 llvm::GlobalValue *OldThunkFn = cast<llvm::GlobalValue>(Entry);
Anders Carlsson7986ad52010-03-23 18:18:41 +00002742
2743 // If the types mismatch then we have to rewrite the definition.
2744 assert(OldThunkFn->isDeclaration() &&
2745 "Shouldn't replace non-declaration");
2746
2747 // Remove the name from the old thunk function and get a new thunk.
2748 OldThunkFn->setName(llvm::StringRef());
Anders Carlsson84c49e42011-02-06 17:15:43 +00002749 Entry = CGM.GetAddrOfThunk(GD, Thunk);
Anders Carlsson7986ad52010-03-23 18:18:41 +00002750
2751 // If needed, replace the old thunk with a bitcast.
2752 if (!OldThunkFn->use_empty()) {
2753 llvm::Constant *NewPtrForOldDecl =
Anders Carlsson13d68982010-03-24 00:35:44 +00002754 llvm::ConstantExpr::getBitCast(Entry, OldThunkFn->getType());
Anders Carlsson7986ad52010-03-23 18:18:41 +00002755 OldThunkFn->replaceAllUsesWith(NewPtrForOldDecl);
2756 }
2757
2758 // Remove the old thunk.
2759 OldThunkFn->eraseFromParent();
2760 }
Anders Carlsson519c3282010-03-24 00:39:18 +00002761
Anders Carlsson519c3282010-03-24 00:39:18 +00002762 llvm::Function *ThunkFn = cast<llvm::Function>(Entry);
Anders Carlsson14e82fd2011-02-06 18:31:40 +00002763
2764 if (!ThunkFn->isDeclaration()) {
2765 if (UseAvailableExternallyLinkage) {
2766 // There is already a thunk emitted for this function, do nothing.
2767 return;
2768 }
2769
Anders Carlsson22df7b12011-02-06 20:09:44 +00002770 // If a function has a body, it should have available_externally linkage.
2771 assert(ThunkFn->hasAvailableExternallyLinkage() &&
2772 "Function should have available_externally linkage!");
2773
2774 // Change the linkage.
2775 CGM.setFunctionLinkage(cast<CXXMethodDecl>(GD.getDecl()), ThunkFn);
2776 return;
Anders Carlsson14e82fd2011-02-06 18:31:40 +00002777 }
2778
2779 // Actually generate the thunk body.
John McCalld26bc762011-03-09 04:27:21 +00002780 CodeGenFunction(CGM).GenerateThunk(ThunkFn, FnInfo, GD, Thunk);
Anders Carlsson14e82fd2011-02-06 18:31:40 +00002781
2782 if (UseAvailableExternallyLinkage)
2783 ThunkFn->setLinkage(llvm::GlobalValue::AvailableExternallyLinkage);
2784}
2785
2786void CodeGenVTables::MaybeEmitThunkAvailableExternally(GlobalDecl GD,
2787 const ThunkInfo &Thunk) {
2788 // We only want to do this when building with optimizations.
2789 if (!CGM.getCodeGenOpts().OptimizationLevel)
2790 return;
2791
2792 // We can't emit thunks for member functions with incomplete types.
2793 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2794 if (CGM.getTypes().VerifyFuncTypeComplete(MD->getType().getTypePtr()))
2795 return;
2796
2797 EmitThunk(GD, Thunk, /*UseAvailableExternallyLinkage=*/true);
Anders Carlssonfbf6ed42010-03-23 16:36:50 +00002798}
2799
Anders Carlssonee5ab9f2010-03-23 04:59:02 +00002800void CodeGenVTables::EmitThunks(GlobalDecl GD)
2801{
Anders Carlssonfbf6ed42010-03-23 16:36:50 +00002802 const CXXMethodDecl *MD =
2803 cast<CXXMethodDecl>(GD.getDecl())->getCanonicalDecl();
2804
2805 // We don't need to generate thunks for the base destructor.
2806 if (isa<CXXDestructorDecl>(MD) && GD.getDtorType() == Dtor_Base)
2807 return;
2808
2809 const CXXRecordDecl *RD = MD->getParent();
2810
Anders Carlssonccd83d72010-03-24 16:42:11 +00002811 // Compute VTable related info for this class.
John McCalle2132352010-06-02 21:22:02 +00002812 ComputeVTableRelatedInformation(RD, false);
Anders Carlssonccd83d72010-03-24 16:42:11 +00002813
Anders Carlssonfbf6ed42010-03-23 16:36:50 +00002814 ThunksMapTy::const_iterator I = Thunks.find(MD);
2815 if (I == Thunks.end()) {
Anders Carlssonccd83d72010-03-24 16:42:11 +00002816 // We did not find a thunk for this method.
2817 return;
Anders Carlssonfbf6ed42010-03-23 16:36:50 +00002818 }
Anders Carlssonccd83d72010-03-24 16:42:11 +00002819
Anders Carlssonfbf6ed42010-03-23 16:36:50 +00002820 const ThunkInfoVectorTy &ThunkInfoVector = I->second;
2821 for (unsigned I = 0, E = ThunkInfoVector.size(); I != E; ++I)
Anders Carlsson14e82fd2011-02-06 18:31:40 +00002822 EmitThunk(GD, ThunkInfoVector[I], /*UseAvailableExternallyLinkage=*/false);
Anders Carlssonee5ab9f2010-03-23 04:59:02 +00002823}
2824
John McCalle2132352010-06-02 21:22:02 +00002825void CodeGenVTables::ComputeVTableRelatedInformation(const CXXRecordDecl *RD,
2826 bool RequireVTable) {
2827 VTableLayoutData &Entry = VTableLayoutMap[RD];
Douglas Gregor6fb745b2010-05-13 16:44:06 +00002828
2829 // We may need to generate a definition for this vtable.
John McCalle2132352010-06-02 21:22:02 +00002830 if (RequireVTable && !Entry.getInt()) {
Argyrios Kyrtzidisd2c47bd2010-10-11 03:25:57 +00002831 if (ShouldEmitVTableInThisTU(RD))
John McCalle2132352010-06-02 21:22:02 +00002832 CGM.DeferredVTables.push_back(RD);
2833
2834 Entry.setInt(true);
2835 }
2836
2837 // Check if we've computed this information before.
2838 if (Entry.getPointer())
2839 return;
Douglas Gregor6fb745b2010-05-13 16:44:06 +00002840
Ken Dyck23da84a2011-03-27 20:20:28 +00002841 VTableBuilder Builder(*this, RD, CharUnits::Zero(),
2842 /*MostDerivedClassIsVirtual=*/0, RD);
Anders Carlssonccd83d72010-03-24 16:42:11 +00002843
2844 // Add the VTable layout.
2845 uint64_t NumVTableComponents = Builder.getNumVTableComponents();
Fariborz Jahaniana50e33e2011-01-28 23:42:29 +00002846 // -fapple-kext adds an extra entry at end of vtbl.
2847 bool IsAppleKext = CGM.getContext().getLangOptions().AppleKext;
2848 if (IsAppleKext)
2849 NumVTableComponents += 1;
2850
John McCalle2132352010-06-02 21:22:02 +00002851 uint64_t *LayoutData = new uint64_t[NumVTableComponents + 1];
Fariborz Jahaniana50e33e2011-01-28 23:42:29 +00002852 if (IsAppleKext)
2853 LayoutData[NumVTableComponents] = 0;
John McCalle2132352010-06-02 21:22:02 +00002854 Entry.setPointer(LayoutData);
Anders Carlssonccd83d72010-03-24 16:42:11 +00002855
2856 // Store the number of components.
2857 LayoutData[0] = NumVTableComponents;
2858
2859 // Store the components.
2860 std::copy(Builder.vtable_components_data_begin(),
2861 Builder.vtable_components_data_end(),
2862 &LayoutData[1]);
2863
2864 // Add the known thunks.
2865 Thunks.insert(Builder.thunks_begin(), Builder.thunks_end());
2866
Anders Carlsson276701f2010-03-29 01:38:05 +00002867 // Add the thunks needed in this vtable.
2868 assert(!VTableThunksMap.count(RD) &&
2869 "Thunks already exists for this vtable!");
2870
2871 VTableThunksTy &VTableThunks = VTableThunksMap[RD];
2872 VTableThunks.append(Builder.vtable_thunks_begin(),
2873 Builder.vtable_thunks_end());
2874
2875 // Sort them.
2876 std::sort(VTableThunks.begin(), VTableThunks.end());
2877
Anders Carlsson66d567d2010-03-25 00:51:13 +00002878 // Add the address points.
Anders Carlsson94464812010-04-10 19:13:06 +00002879 for (VTableBuilder::AddressPointsMapTy::const_iterator I =
Anders Carlsson66d567d2010-03-25 00:51:13 +00002880 Builder.address_points_begin(), E = Builder.address_points_end();
2881 I != E; ++I) {
2882
2883 uint64_t &AddressPoint = AddressPoints[std::make_pair(RD, I->first)];
2884
2885 // Check if we already have the address points for this base.
2886 assert(!AddressPoint && "Address point already exists for this base!");
2887
2888 AddressPoint = I->second;
2889 }
2890
Anders Carlssonccd83d72010-03-24 16:42:11 +00002891 // If we don't have the vbase information for this class, insert it.
2892 // getVirtualBaseOffsetOffset will compute it separately without computing
2893 // the rest of the vtable related information.
2894 if (!RD->getNumVBases())
2895 return;
2896
2897 const RecordType *VBaseRT =
2898 RD->vbases_begin()->getType()->getAs<RecordType>();
2899 const CXXRecordDecl *VBase = cast<CXXRecordDecl>(VBaseRT->getDecl());
2900
2901 if (VirtualBaseClassOffsetOffsets.count(std::make_pair(RD, VBase)))
2902 return;
2903
Anders Carlsson94464812010-04-10 19:13:06 +00002904 for (VTableBuilder::VBaseOffsetOffsetsMapTy::const_iterator I =
Anders Carlssonccd83d72010-03-24 16:42:11 +00002905 Builder.getVBaseOffsetOffsets().begin(),
2906 E = Builder.getVBaseOffsetOffsets().end(); I != E; ++I) {
2907 // Insert all types.
2908 ClassPairTy ClassPair(RD, I->first);
2909
2910 VirtualBaseClassOffsetOffsets.insert(std::make_pair(ClassPair, I->second));
2911 }
2912}
2913
Anders Carlsson0d1407e2010-03-25 15:26:28 +00002914llvm::Constant *
2915CodeGenVTables::CreateVTableInitializer(const CXXRecordDecl *RD,
2916 const uint64_t *Components,
2917 unsigned NumComponents,
2918 const VTableThunksTy &VTableThunks) {
2919 llvm::SmallVector<llvm::Constant *, 64> Inits;
2920
2921 const llvm::Type *Int8PtrTy = llvm::Type::getInt8PtrTy(CGM.getLLVMContext());
2922
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002923 const llvm::Type *PtrDiffTy =
2924 CGM.getTypes().ConvertType(CGM.getContext().getPointerDiffType());
2925
2926 QualType ClassType = CGM.getContext().getTagDeclType(RD);
2927 llvm::Constant *RTTI = CGM.GetAddrOfRTTIDescriptor(ClassType);
2928
2929 unsigned NextVTableThunkIndex = 0;
2930
Anders Carlsson67d568a2010-03-29 05:40:50 +00002931 llvm::Constant* PureVirtualFn = 0;
2932
Anders Carlsson0d1407e2010-03-25 15:26:28 +00002933 for (unsigned I = 0; I != NumComponents; ++I) {
Anders Carlsson94464812010-04-10 19:13:06 +00002934 VTableComponent Component =
2935 VTableComponent::getFromOpaqueInteger(Components[I]);
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002936
2937 llvm::Constant *Init = 0;
2938
2939 switch (Component.getKind()) {
Anders Carlsson94464812010-04-10 19:13:06 +00002940 case VTableComponent::CK_VCallOffset:
Ken Dyckc40a3fd2011-04-02 01:14:48 +00002941 Init = llvm::ConstantInt::get(PtrDiffTy,
2942 Component.getVCallOffset().getQuantity());
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002943 Init = llvm::ConstantExpr::getIntToPtr(Init, Int8PtrTy);
2944 break;
Anders Carlsson94464812010-04-10 19:13:06 +00002945 case VTableComponent::CK_VBaseOffset:
Ken Dyckc40a3fd2011-04-02 01:14:48 +00002946 Init = llvm::ConstantInt::get(PtrDiffTy,
2947 Component.getVBaseOffset().getQuantity());
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002948 Init = llvm::ConstantExpr::getIntToPtr(Init, Int8PtrTy);
2949 break;
Anders Carlsson94464812010-04-10 19:13:06 +00002950 case VTableComponent::CK_OffsetToTop:
Ken Dyckc40a3fd2011-04-02 01:14:48 +00002951 Init = llvm::ConstantInt::get(PtrDiffTy,
2952 Component.getOffsetToTop().getQuantity());
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002953 Init = llvm::ConstantExpr::getIntToPtr(Init, Int8PtrTy);
2954 break;
Anders Carlsson94464812010-04-10 19:13:06 +00002955 case VTableComponent::CK_RTTI:
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002956 Init = llvm::ConstantExpr::getBitCast(RTTI, Int8PtrTy);
2957 break;
Anders Carlsson94464812010-04-10 19:13:06 +00002958 case VTableComponent::CK_FunctionPointer:
2959 case VTableComponent::CK_CompleteDtorPointer:
2960 case VTableComponent::CK_DeletingDtorPointer: {
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002961 GlobalDecl GD;
2962
2963 // Get the right global decl.
2964 switch (Component.getKind()) {
2965 default:
2966 llvm_unreachable("Unexpected vtable component kind");
Anders Carlsson94464812010-04-10 19:13:06 +00002967 case VTableComponent::CK_FunctionPointer:
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002968 GD = Component.getFunctionDecl();
2969 break;
Anders Carlsson94464812010-04-10 19:13:06 +00002970 case VTableComponent::CK_CompleteDtorPointer:
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002971 GD = GlobalDecl(Component.getDestructorDecl(), Dtor_Complete);
2972 break;
Anders Carlsson94464812010-04-10 19:13:06 +00002973 case VTableComponent::CK_DeletingDtorPointer:
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002974 GD = GlobalDecl(Component.getDestructorDecl(), Dtor_Deleting);
2975 break;
2976 }
2977
Anders Carlsson67d568a2010-03-29 05:40:50 +00002978 if (cast<CXXMethodDecl>(GD.getDecl())->isPure()) {
2979 // We have a pure virtual member function.
2980 if (!PureVirtualFn) {
2981 const llvm::FunctionType *Ty =
2982 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2983 /*isVarArg=*/false);
2984 PureVirtualFn =
2985 CGM.CreateRuntimeFunction(Ty, "__cxa_pure_virtual");
2986 PureVirtualFn = llvm::ConstantExpr::getBitCast(PureVirtualFn,
2987 Int8PtrTy);
2988 }
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002989
Anders Carlsson67d568a2010-03-29 05:40:50 +00002990 Init = PureVirtualFn;
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002991 } else {
Anders Carlsson67d568a2010-03-29 05:40:50 +00002992 // Check if we should use a thunk.
2993 if (NextVTableThunkIndex < VTableThunks.size() &&
2994 VTableThunks[NextVTableThunkIndex].first == I) {
2995 const ThunkInfo &Thunk = VTableThunks[NextVTableThunkIndex].second;
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002996
Anders Carlsson84c49e42011-02-06 17:15:43 +00002997 Init = CGM.GetAddrOfThunk(GD, Thunk);
Anders Carlsson14e82fd2011-02-06 18:31:40 +00002998 MaybeEmitThunkAvailableExternally(GD, Thunk);
2999
Anders Carlsson67d568a2010-03-29 05:40:50 +00003000 NextVTableThunkIndex++;
3001 } else {
John McCall4c40d982010-08-31 07:33:07 +00003002 const llvm::Type *Ty = CGM.getTypes().GetFunctionTypeForVTable(GD);
Anders Carlsson67d568a2010-03-29 05:40:50 +00003003
Anders Carlsson1faa89f2011-02-05 04:35:53 +00003004 Init = CGM.GetAddrOfFunction(GD, Ty, /*ForVTable=*/true);
Anders Carlsson67d568a2010-03-29 05:40:50 +00003005 }
3006
3007 Init = llvm::ConstantExpr::getBitCast(Init, Int8PtrTy);
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00003008 }
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00003009 break;
3010 }
3011
Anders Carlsson94464812010-04-10 19:13:06 +00003012 case VTableComponent::CK_UnusedFunctionPointer:
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00003013 Init = llvm::ConstantExpr::getNullValue(Int8PtrTy);
3014 break;
3015 };
Anders Carlsson0d1407e2010-03-25 15:26:28 +00003016
3017 Inits.push_back(Init);
3018 }
3019
3020 llvm::ArrayType *ArrayType = llvm::ArrayType::get(Int8PtrTy, NumComponents);
3021 return llvm::ConstantArray::get(ArrayType, Inits.data(), Inits.size());
3022}
3023
Anders Carlsson9dc338a2010-03-30 03:35:35 +00003024llvm::GlobalVariable *CodeGenVTables::GetAddrOfVTable(const CXXRecordDecl *RD) {
Anders Carlsson5c6c1d92010-03-24 03:57:14 +00003025 llvm::SmallString<256> OutName;
Rafael Espindolaf0be9792011-02-11 02:52:17 +00003026 llvm::raw_svector_ostream Out(OutName);
3027 CGM.getCXXABI().getMangleContext().mangleCXXVTable(RD, Out);
3028 Out.flush();
Anders Carlsson5c6c1d92010-03-24 03:57:14 +00003029 llvm::StringRef Name = OutName.str();
Mike Stump85615df2009-11-19 04:04:36 +00003030
John McCalle2132352010-06-02 21:22:02 +00003031 ComputeVTableRelatedInformation(RD, true);
Anders Carlssonccd83d72010-03-24 16:42:11 +00003032
Anders Carlsson5c6c1d92010-03-24 03:57:14 +00003033 const llvm::Type *Int8PtrTy = llvm::Type::getInt8PtrTy(CGM.getLLVMContext());
Anders Carlssonccd83d72010-03-24 16:42:11 +00003034 llvm::ArrayType *ArrayType =
3035 llvm::ArrayType::get(Int8PtrTy, getNumVTableComponents(RD));
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003036
Rafael Espindola9f959db2011-01-11 21:10:26 +00003037 llvm::GlobalVariable *GV =
Anders Carlsson96eaf292011-01-29 18:25:07 +00003038 CGM.CreateOrReplaceCXXRuntimeVariable(Name, ArrayType,
3039 llvm::GlobalValue::ExternalLinkage);
Rafael Espindolacd3ac4b2011-01-15 08:23:14 +00003040 GV->setUnnamedAddr(true);
Rafael Espindola9f959db2011-01-11 21:10:26 +00003041 return GV;
Mike Stump380dd752009-11-10 07:44:33 +00003042}
Mike Stump8cfcb522009-11-11 20:26:26 +00003043
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003044void
3045CodeGenVTables::EmitVTableDefinition(llvm::GlobalVariable *VTable,
3046 llvm::GlobalVariable::LinkageTypes Linkage,
3047 const CXXRecordDecl *RD) {
3048 // Dump the vtable layout if necessary.
Anders Carlsson046c2942010-04-17 20:15:18 +00003049 if (CGM.getLangOptions().DumpVTableLayouts) {
Ken Dyck23da84a2011-03-27 20:20:28 +00003050 VTableBuilder Builder(*this, RD, CharUnits::Zero(),
3051 /*MostDerivedClassIsVirtual=*/0, RD);
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003052
3053 Builder.dumpLayout(llvm::errs());
3054 }
3055
3056 assert(VTableThunksMap.count(RD) &&
3057 "No thunk status for this record decl!");
3058
3059 const VTableThunksTy& Thunks = VTableThunksMap[RD];
3060
3061 // Create and set the initializer.
3062 llvm::Constant *Init =
3063 CreateVTableInitializer(RD, getVTableComponentsData(RD),
3064 getNumVTableComponents(RD), Thunks);
3065 VTable->setInitializer(Init);
Anders Carlsson67d568a2010-03-29 05:40:50 +00003066
3067 // Set the correct linkage.
3068 VTable->setLinkage(Linkage);
Douglas Gregorc66bcfd2010-06-14 23:41:45 +00003069
3070 // Set the right visibility.
Anders Carlssonfa2e99f2011-01-29 20:24:48 +00003071 CGM.setTypeVisibility(VTable, RD, CodeGenModule::TVK_ForVTable);
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003072}
3073
Anders Carlssonff143f82010-03-25 00:35:49 +00003074llvm::GlobalVariable *
3075CodeGenVTables::GenerateConstructionVTable(const CXXRecordDecl *RD,
Anders Carlsson2c822f12010-03-26 03:56:54 +00003076 const BaseSubobject &Base,
3077 bool BaseIsVirtual,
John McCallbda0d6b2011-03-27 09:00:25 +00003078 llvm::GlobalVariable::LinkageTypes Linkage,
Anders Carlsson2c822f12010-03-26 03:56:54 +00003079 VTableAddressPointsMapTy& AddressPoints) {
Ken Dyck4230d522011-03-24 01:21:01 +00003080 VTableBuilder Builder(*this, Base.getBase(),
Ken Dyck23da84a2011-03-27 20:20:28 +00003081 Base.getBaseOffset(),
Anders Carlsson0d1407e2010-03-25 15:26:28 +00003082 /*MostDerivedClassIsVirtual=*/BaseIsVirtual, RD);
3083
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00003084 // Dump the vtable layout if necessary.
Anders Carlsson046c2942010-04-17 20:15:18 +00003085 if (CGM.getLangOptions().DumpVTableLayouts)
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00003086 Builder.dumpLayout(llvm::errs());
3087
3088 // Add the address points.
Anders Carlsson2c822f12010-03-26 03:56:54 +00003089 AddressPoints.insert(Builder.address_points_begin(),
3090 Builder.address_points_end());
Anders Carlsson0d1407e2010-03-25 15:26:28 +00003091
3092 // Get the mangled construction vtable name.
3093 llvm::SmallString<256> OutName;
Rafael Espindolaf0be9792011-02-11 02:52:17 +00003094 llvm::raw_svector_ostream Out(OutName);
John McCall4c40d982010-08-31 07:33:07 +00003095 CGM.getCXXABI().getMangleContext().
Ken Dyck4230d522011-03-24 01:21:01 +00003096 mangleCXXCtorVTable(RD, Base.getBaseOffset().getQuantity(), Base.getBase(),
3097 Out);
Rafael Espindolaf0be9792011-02-11 02:52:17 +00003098 Out.flush();
Anders Carlsson0d1407e2010-03-25 15:26:28 +00003099 llvm::StringRef Name = OutName.str();
3100
3101 const llvm::Type *Int8PtrTy = llvm::Type::getInt8PtrTy(CGM.getLLVMContext());
3102 llvm::ArrayType *ArrayType =
3103 llvm::ArrayType::get(Int8PtrTy, Builder.getNumVTableComponents());
3104
3105 // Create the variable that will hold the construction vtable.
3106 llvm::GlobalVariable *VTable =
John McCallbda0d6b2011-03-27 09:00:25 +00003107 CGM.CreateOrReplaceCXXRuntimeVariable(Name, ArrayType, Linkage);
3108 CGM.setTypeVisibility(VTable, RD, CodeGenModule::TVK_ForConstructionVTable);
3109
3110 // V-tables are always unnamed_addr.
3111 VTable->setUnnamedAddr(true);
Anders Carlsson0d1407e2010-03-25 15:26:28 +00003112
3113 // Add the thunks.
3114 VTableThunksTy VTableThunks;
3115 VTableThunks.append(Builder.vtable_thunks_begin(),
3116 Builder.vtable_thunks_end());
3117
Anders Carlssonaed924e2010-03-29 01:28:05 +00003118 // Sort them.
3119 std::sort(VTableThunks.begin(), VTableThunks.end());
3120
Anders Carlsson0d1407e2010-03-25 15:26:28 +00003121 // Create and set the initializer.
3122 llvm::Constant *Init =
3123 CreateVTableInitializer(Base.getBase(),
3124 Builder.vtable_components_data_begin(),
3125 Builder.getNumVTableComponents(), VTableThunks);
3126 VTable->setInitializer(Init);
3127
Anders Carlssonff143f82010-03-25 00:35:49 +00003128 return VTable;
3129}
3130
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003131void
3132CodeGenVTables::GenerateClassData(llvm::GlobalVariable::LinkageTypes Linkage,
3133 const CXXRecordDecl *RD) {
Anders Carlsson046c2942010-04-17 20:15:18 +00003134 llvm::GlobalVariable *&VTable = VTables[RD];
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003135 if (VTable) {
Anders Carlsson046c2942010-04-17 20:15:18 +00003136 assert(VTable->getInitializer() && "VTable doesn't have a definition!");
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003137 return;
3138 }
3139
Anders Carlsson9dc338a2010-03-30 03:35:35 +00003140 VTable = GetAddrOfVTable(RD);
3141 EmitVTableDefinition(VTable, Linkage, RD);
3142
Anders Carlsson1cbce122011-01-29 19:16:51 +00003143 if (RD->getNumVBases()) {
3144 llvm::GlobalVariable *VTT = GetAddrOfVTT(RD);
3145 EmitVTTDefinition(VTT, Linkage, RD);
3146 }
Douglas Gregor1e201b42010-04-08 15:52:03 +00003147
3148 // If this is the magic class __cxxabiv1::__fundamental_type_info,
3149 // we will emit the typeinfo for the fundamental types. This is the
3150 // same behaviour as GCC.
3151 const DeclContext *DC = RD->getDeclContext();
3152 if (RD->getIdentifier() &&
3153 RD->getIdentifier()->isStr("__fundamental_type_info") &&
3154 isa<NamespaceDecl>(DC) &&
3155 cast<NamespaceDecl>(DC)->getIdentifier() &&
3156 cast<NamespaceDecl>(DC)->getIdentifier()->isStr("__cxxabiv1") &&
3157 DC->getParent()->isTranslationUnit())
3158 CGM.EmitFundamentalRTTIDescriptors();
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003159}