blob: 0aea31cd2a13b3b4772dc3079df1e6cb42bef52a [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"
Eli Friedman7dcdf5b2011-05-06 17:27:27 +000024#include "llvm/Transforms/Utils/Cloning.h"
Anders Carlsson5e454aa2010-03-17 20:06:32 +000025#include <algorithm>
Zhongxing Xu7fe26ac2009-11-13 05:46:16 +000026#include <cstdio>
Anders Carlssondbd920c2009-10-11 22:13:54 +000027
28using namespace clang;
29using namespace CodeGen;
30
Anders Carlsson27f69d02009-11-27 22:21:51 +000031namespace {
Anders Carlsson824d7ea2010-02-11 08:02:13 +000032
Anders Carlsson2fca9be2010-02-23 01:34:28 +000033/// BaseOffset - Represents an offset from a derived class to a direct or
34/// indirect base class.
35struct BaseOffset {
36 /// DerivedClass - The derived class.
37 const CXXRecordDecl *DerivedClass;
38
39 /// VirtualBase - If the path from the derived class to the base class
40 /// involves a virtual base class, this holds its declaration.
41 const CXXRecordDecl *VirtualBase;
42
43 /// NonVirtualOffset - The offset from the derived class to the base class.
44 /// (Or the offset from the virtual base class to the base class, if the
45 /// path from the derived class to the base class involves a virtual base
46 /// class.
Ken Dyck396e4f62011-04-02 01:32:03 +000047 CharUnits NonVirtualOffset;
Anders Carlsson2fca9be2010-02-23 01:34:28 +000048
Ken Dyck396e4f62011-04-02 01:32:03 +000049 BaseOffset() : DerivedClass(0), VirtualBase(0),
50 NonVirtualOffset(CharUnits::Zero()) { }
Anders Carlsson2fca9be2010-02-23 01:34:28 +000051 BaseOffset(const CXXRecordDecl *DerivedClass,
Ken Dyck396e4f62011-04-02 01:32:03 +000052 const CXXRecordDecl *VirtualBase, CharUnits NonVirtualOffset)
Anders Carlsson2fca9be2010-02-23 01:34:28 +000053 : DerivedClass(DerivedClass), VirtualBase(VirtualBase),
54 NonVirtualOffset(NonVirtualOffset) { }
55
Ken Dyck396e4f62011-04-02 01:32:03 +000056 bool isEmpty() const { return NonVirtualOffset.isZero() && !VirtualBase; }
Anders Carlsson2fca9be2010-02-23 01:34:28 +000057};
58
Anders Carlssonbdf73d82010-02-11 21:24:32 +000059/// FinalOverriders - Contains the final overrider member functions for all
60/// member functions in the base subobjects of a class.
61class FinalOverriders {
Anders Carlssona7575822010-02-12 16:55:34 +000062public:
63 /// OverriderInfo - Information about a final overrider.
64 struct OverriderInfo {
65 /// Method - The method decl of the overrider.
66 const CXXMethodDecl *Method;
Anders Carlsson96309c42010-02-18 16:29:24 +000067
Anders Carlssondb4022c2010-03-10 02:33:41 +000068 /// Offset - the base offset of the overrider in the layout class.
Ken Dyck17d85192011-03-26 01:29:16 +000069 CharUnits Offset;
Anders Carlssona7575822010-02-12 16:55:34 +000070
Ken Dyck17d85192011-03-26 01:29:16 +000071 OverriderInfo() : Method(0), Offset(CharUnits::Zero()) { }
Anders Carlssona7575822010-02-12 16:55:34 +000072 };
73
74private:
Anders Carlssonbdf73d82010-02-11 21:24:32 +000075 /// MostDerivedClass - The most derived class for which the final overriders
76 /// are stored.
77 const CXXRecordDecl *MostDerivedClass;
78
Anders Carlssondb4022c2010-03-10 02:33:41 +000079 /// MostDerivedClassOffset - If we're building final overriders for a
80 /// construction vtable, this holds the offset from the layout class to the
81 /// most derived class.
Ken Dyckfc724202011-03-27 20:10:29 +000082 const CharUnits MostDerivedClassOffset;
Anders Carlssondb4022c2010-03-10 02:33:41 +000083
84 /// LayoutClass - The class we're using for layout information. Will be
85 /// different than the most derived class if the final overriders are for a
86 /// construction vtable.
87 const CXXRecordDecl *LayoutClass;
88
Anders Carlssonbdf73d82010-02-11 21:24:32 +000089 ASTContext &Context;
90
91 /// MostDerivedClassLayout - the AST record layout of the most derived class.
92 const ASTRecordLayout &MostDerivedClassLayout;
93
Anders Carlsson0a028602010-06-01 23:52:26 +000094 /// MethodBaseOffsetPairTy - Uniquely identifies a member function
Anders Carlsson0c0eeb22010-02-13 02:02:03 +000095 /// in a base subobject.
Ken Dycke6203132011-03-26 01:18:17 +000096 typedef std::pair<const CXXMethodDecl *, CharUnits> MethodBaseOffsetPairTy;
Anders Carlsson0a028602010-06-01 23:52:26 +000097
98 typedef llvm::DenseMap<MethodBaseOffsetPairTy,
Anders Carlssona7575822010-02-12 16:55:34 +000099 OverriderInfo> OverridersMapTy;
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000100
101 /// OverridersMap - The final overriders for all virtual member functions of
102 /// all the base subobjects of the most derived class.
103 OverridersMapTy OverridersMap;
104
Anders Carlsson147a23d2010-06-04 00:54:04 +0000105 /// SubobjectsToOffsetsMapTy - A mapping from a base subobject (represented
106 /// as a record decl and a subobject number) and its offsets in the most
107 /// derived class as well as the layout class.
108 typedef llvm::DenseMap<std::pair<const CXXRecordDecl *, unsigned>,
Ken Dyck35c416b2011-03-26 01:09:13 +0000109 CharUnits> SubobjectOffsetMapTy;
Anders Carlsson147a23d2010-06-04 00:54:04 +0000110
111 typedef llvm::DenseMap<const CXXRecordDecl *, unsigned> SubobjectCountMapTy;
112
113 /// ComputeBaseOffsets - Compute the offsets for all base subobjects of the
114 /// given base.
115 void ComputeBaseOffsets(BaseSubobject Base, bool IsVirtual,
Ken Dyckb4c82b42011-03-26 01:36:26 +0000116 CharUnits OffsetInLayoutClass,
Anders Carlsson147a23d2010-06-04 00:54:04 +0000117 SubobjectOffsetMapTy &SubobjectOffsets,
118 SubobjectOffsetMapTy &SubobjectLayoutClassOffsets,
119 SubobjectCountMapTy &SubobjectCounts);
120
Anders Carlssonb9cae1d2010-06-04 00:59:37 +0000121 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
122
123 /// dump - dump the final overriders for a base subobject, and all its direct
124 /// and indirect base subobjects.
Chris Lattner5f9e2722011-07-23 10:55:15 +0000125 void dump(raw_ostream &Out, BaseSubobject Base,
Anders Carlssonb9cae1d2010-06-04 00:59:37 +0000126 VisitedVirtualBasesSetTy& VisitedVirtualBases);
127
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000128public:
Anders Carlssondb4022c2010-03-10 02:33:41 +0000129 FinalOverriders(const CXXRecordDecl *MostDerivedClass,
Ken Dyckfc724202011-03-27 20:10:29 +0000130 CharUnits MostDerivedClassOffset,
Anders Carlssondb4022c2010-03-10 02:33:41 +0000131 const CXXRecordDecl *LayoutClass);
Anders Carlsson2157d302010-02-24 22:18:01 +0000132
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000133 /// getOverrider - Get the final overrider for the given method declaration in
Anders Carlsson26387642010-06-01 23:17:37 +0000134 /// the subobject with the given base offset.
135 OverriderInfo getOverrider(const CXXMethodDecl *MD,
Ken Dycke6203132011-03-26 01:18:17 +0000136 CharUnits BaseOffset) const {
Anders Carlsson0a028602010-06-01 23:52:26 +0000137 assert(OverridersMap.count(std::make_pair(MD, BaseOffset)) &&
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000138 "Did not find overrider!");
139
Anders Carlsson0a028602010-06-01 23:52:26 +0000140 return OverridersMap.lookup(std::make_pair(MD, BaseOffset));
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000141 }
142
143 /// dump - dump the final overriders.
Anders Carlsson9d6f0d52010-02-14 00:37:35 +0000144 void dump() {
Anders Carlssonb9cae1d2010-06-04 00:59:37 +0000145 VisitedVirtualBasesSetTy VisitedVirtualBases;
Ken Dyck4230d522011-03-24 01:21:01 +0000146 dump(llvm::errs(), BaseSubobject(MostDerivedClass, CharUnits::Zero()),
147 VisitedVirtualBases);
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000148 }
149
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000150};
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000151
Anders Carlsson327568e2010-02-27 20:02:53 +0000152#define DUMP_OVERRIDERS 0
153
Anders Carlssondb4022c2010-03-10 02:33:41 +0000154FinalOverriders::FinalOverriders(const CXXRecordDecl *MostDerivedClass,
Ken Dyckfc724202011-03-27 20:10:29 +0000155 CharUnits MostDerivedClassOffset,
Anders Carlssondb4022c2010-03-10 02:33:41 +0000156 const CXXRecordDecl *LayoutClass)
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000157 : MostDerivedClass(MostDerivedClass),
Anders Carlssondb4022c2010-03-10 02:33:41 +0000158 MostDerivedClassOffset(MostDerivedClassOffset), LayoutClass(LayoutClass),
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000159 Context(MostDerivedClass->getASTContext()),
160 MostDerivedClassLayout(Context.getASTRecordLayout(MostDerivedClass)) {
Anders Carlssonb9cae1d2010-06-04 00:59:37 +0000161
Anders Carlsson147a23d2010-06-04 00:54:04 +0000162 // Compute base offsets.
163 SubobjectOffsetMapTy SubobjectOffsets;
164 SubobjectOffsetMapTy SubobjectLayoutClassOffsets;
165 SubobjectCountMapTy SubobjectCounts;
Ken Dyck4230d522011-03-24 01:21:01 +0000166 ComputeBaseOffsets(BaseSubobject(MostDerivedClass, CharUnits::Zero()),
167 /*IsVirtual=*/false,
Ken Dyckfc724202011-03-27 20:10:29 +0000168 MostDerivedClassOffset,
Ken Dyckb4c82b42011-03-26 01:36:26 +0000169 SubobjectOffsets, SubobjectLayoutClassOffsets,
170 SubobjectCounts);
Anders Carlsson147a23d2010-06-04 00:54:04 +0000171
172 // Get the the final overriders.
173 CXXFinalOverriderMap FinalOverriders;
174 MostDerivedClass->getFinalOverriders(FinalOverriders);
175
176 for (CXXFinalOverriderMap::const_iterator I = FinalOverriders.begin(),
177 E = FinalOverriders.end(); I != E; ++I) {
178 const CXXMethodDecl *MD = I->first;
179 const OverridingMethods& Methods = I->second;
180
181 for (OverridingMethods::const_iterator I = Methods.begin(),
182 E = Methods.end(); I != E; ++I) {
183 unsigned SubobjectNumber = I->first;
184 assert(SubobjectOffsets.count(std::make_pair(MD->getParent(),
185 SubobjectNumber)) &&
186 "Did not find subobject offset!");
187
Ken Dyck35c416b2011-03-26 01:09:13 +0000188 CharUnits BaseOffset = SubobjectOffsets[std::make_pair(MD->getParent(),
Anders Carlsson147a23d2010-06-04 00:54:04 +0000189 SubobjectNumber)];
190
191 assert(I->second.size() == 1 && "Final overrider is not unique!");
192 const UniqueVirtualMethod &Method = I->second.front();
193
194 const CXXRecordDecl *OverriderRD = Method.Method->getParent();
195 assert(SubobjectLayoutClassOffsets.count(
196 std::make_pair(OverriderRD, Method.Subobject))
197 && "Did not find subobject offset!");
Ken Dyck35c416b2011-03-26 01:09:13 +0000198 CharUnits OverriderOffset =
Anders Carlsson147a23d2010-06-04 00:54:04 +0000199 SubobjectLayoutClassOffsets[std::make_pair(OverriderRD,
200 Method.Subobject)];
201
Ken Dycke6203132011-03-26 01:18:17 +0000202 OverriderInfo& Overrider = OverridersMap[std::make_pair(MD, BaseOffset)];
Anders Carlsson147a23d2010-06-04 00:54:04 +0000203 assert(!Overrider.Method && "Overrider should not exist yet!");
204
Ken Dyck17d85192011-03-26 01:29:16 +0000205 Overrider.Offset = OverriderOffset;
Anders Carlsson147a23d2010-06-04 00:54:04 +0000206 Overrider.Method = Method.Method;
207 }
208 }
Anders Carlsson327568e2010-02-27 20:02:53 +0000209
210#if DUMP_OVERRIDERS
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000211 // And dump them (for now).
212 dump();
Anders Carlsson327568e2010-02-27 20:02:53 +0000213#endif
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000214}
215
Anders Carlsson2fca9be2010-02-23 01:34:28 +0000216static BaseOffset ComputeBaseOffset(ASTContext &Context,
217 const CXXRecordDecl *DerivedRD,
218 const CXXBasePath &Path) {
Ken Dyck396e4f62011-04-02 01:32:03 +0000219 CharUnits NonVirtualOffset = CharUnits::Zero();
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000220
Anders Carlssona4a54172010-02-13 20:41:15 +0000221 unsigned NonVirtualStart = 0;
222 const CXXRecordDecl *VirtualBase = 0;
223
224 // First, look for the virtual base class.
225 for (unsigned I = 0, E = Path.size(); I != E; ++I) {
226 const CXXBasePathElement &Element = Path[I];
227
228 if (Element.Base->isVirtual()) {
229 // FIXME: Can we break when we find the first virtual base?
230 // (If we can't, can't we just iterate over the path in reverse order?)
231 NonVirtualStart = I + 1;
232 QualType VBaseType = Element.Base->getType();
233 VirtualBase =
234 cast<CXXRecordDecl>(VBaseType->getAs<RecordType>()->getDecl());
235 }
236 }
237
238 // Now compute the non-virtual offset.
239 for (unsigned I = NonVirtualStart, E = Path.size(); I != E; ++I) {
240 const CXXBasePathElement &Element = Path[I];
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000241
242 // Check the base class offset.
243 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Element.Class);
Anders Carlssonbf554f62010-02-25 22:18:35 +0000244
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000245 const RecordType *BaseType = Element.Base->getType()->getAs<RecordType>();
246 const CXXRecordDecl *Base = cast<CXXRecordDecl>(BaseType->getDecl());
Anders Carlssonbf554f62010-02-25 22:18:35 +0000247
Ken Dyck396e4f62011-04-02 01:32:03 +0000248 NonVirtualOffset += Layout.getBaseClassOffset(Base);
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000249 }
250
251 // FIXME: This should probably use CharUnits or something. Maybe we should
252 // even change the base offsets in ASTRecordLayout to be specified in
253 // CharUnits.
Ken Dyck396e4f62011-04-02 01:32:03 +0000254 return BaseOffset(DerivedRD, VirtualBase, NonVirtualOffset);
Anders Carlssone67dc302010-02-14 00:16:19 +0000255
256}
257
Anders Carlsson2fca9be2010-02-23 01:34:28 +0000258static BaseOffset ComputeBaseOffset(ASTContext &Context,
259 const CXXRecordDecl *BaseRD,
260 const CXXRecordDecl *DerivedRD) {
Anders Carlssone67dc302010-02-14 00:16:19 +0000261 CXXBasePaths Paths(/*FindAmbiguities=*/false,
262 /*RecordPaths=*/true, /*DetectVirtual=*/false);
263
264 if (!const_cast<CXXRecordDecl *>(DerivedRD)->
265 isDerivedFrom(const_cast<CXXRecordDecl *>(BaseRD), Paths)) {
David Blaikieb219cfc2011-09-23 05:06:16 +0000266 llvm_unreachable("Class must be derived from the passed in base class!");
Anders Carlssone67dc302010-02-14 00:16:19 +0000267 }
268
269 return ComputeBaseOffset(Context, DerivedRD, Paths.front());
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000270}
271
Anders Carlsson2fca9be2010-02-23 01:34:28 +0000272static BaseOffset
Anders Carlssondf31af12010-02-13 23:17:31 +0000273ComputeReturnAdjustmentBaseOffset(ASTContext &Context,
274 const CXXMethodDecl *DerivedMD,
275 const CXXMethodDecl *BaseMD) {
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000276 const FunctionType *BaseFT = BaseMD->getType()->getAs<FunctionType>();
277 const FunctionType *DerivedFT = DerivedMD->getType()->getAs<FunctionType>();
278
279 // Canonicalize the return types.
280 CanQualType CanDerivedReturnType =
281 Context.getCanonicalType(DerivedFT->getResultType());
282 CanQualType CanBaseReturnType =
283 Context.getCanonicalType(BaseFT->getResultType());
284
285 assert(CanDerivedReturnType->getTypeClass() ==
286 CanBaseReturnType->getTypeClass() &&
287 "Types must have same type class!");
288
289 if (CanDerivedReturnType == CanBaseReturnType) {
290 // No adjustment needed.
Anders Carlsson2fca9be2010-02-23 01:34:28 +0000291 return BaseOffset();
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000292 }
293
294 if (isa<ReferenceType>(CanDerivedReturnType)) {
295 CanDerivedReturnType =
296 CanDerivedReturnType->getAs<ReferenceType>()->getPointeeType();
297 CanBaseReturnType =
298 CanBaseReturnType->getAs<ReferenceType>()->getPointeeType();
299 } else if (isa<PointerType>(CanDerivedReturnType)) {
300 CanDerivedReturnType =
301 CanDerivedReturnType->getAs<PointerType>()->getPointeeType();
302 CanBaseReturnType =
303 CanBaseReturnType->getAs<PointerType>()->getPointeeType();
304 } else {
David Blaikieb219cfc2011-09-23 05:06:16 +0000305 llvm_unreachable("Unexpected return type!");
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000306 }
307
308 // We need to compare unqualified types here; consider
309 // const T *Base::foo();
310 // T *Derived::foo();
311 if (CanDerivedReturnType.getUnqualifiedType() ==
312 CanBaseReturnType.getUnqualifiedType()) {
313 // No adjustment needed.
Anders Carlsson2fca9be2010-02-23 01:34:28 +0000314 return BaseOffset();
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000315 }
316
317 const CXXRecordDecl *DerivedRD =
318 cast<CXXRecordDecl>(cast<RecordType>(CanDerivedReturnType)->getDecl());
319
320 const CXXRecordDecl *BaseRD =
321 cast<CXXRecordDecl>(cast<RecordType>(CanBaseReturnType)->getDecl());
322
Anders Carlssondf31af12010-02-13 23:17:31 +0000323 return ComputeBaseOffset(Context, BaseRD, DerivedRD);
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000324}
325
Anders Carlsson147a23d2010-06-04 00:54:04 +0000326void
327FinalOverriders::ComputeBaseOffsets(BaseSubobject Base, bool IsVirtual,
Ken Dyckb4c82b42011-03-26 01:36:26 +0000328 CharUnits OffsetInLayoutClass,
Anders Carlsson147a23d2010-06-04 00:54:04 +0000329 SubobjectOffsetMapTy &SubobjectOffsets,
330 SubobjectOffsetMapTy &SubobjectLayoutClassOffsets,
331 SubobjectCountMapTy &SubobjectCounts) {
332 const CXXRecordDecl *RD = Base.getBase();
333
334 unsigned SubobjectNumber = 0;
335 if (!IsVirtual)
336 SubobjectNumber = ++SubobjectCounts[RD];
337
338 // Set up the subobject to offset mapping.
339 assert(!SubobjectOffsets.count(std::make_pair(RD, SubobjectNumber))
340 && "Subobject offset already exists!");
341 assert(!SubobjectLayoutClassOffsets.count(std::make_pair(RD, SubobjectNumber))
342 && "Subobject offset already exists!");
343
Ken Dyck35c416b2011-03-26 01:09:13 +0000344 SubobjectOffsets[std::make_pair(RD, SubobjectNumber)] = Base.getBaseOffset();
Anders Carlsson147a23d2010-06-04 00:54:04 +0000345 SubobjectLayoutClassOffsets[std::make_pair(RD, SubobjectNumber)] =
Ken Dyckb4c82b42011-03-26 01:36:26 +0000346 OffsetInLayoutClass;
Anders Carlsson147a23d2010-06-04 00:54:04 +0000347
348 // Traverse our bases.
349 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
350 E = RD->bases_end(); I != E; ++I) {
351 const CXXRecordDecl *BaseDecl =
352 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
353
Ken Dyck57ebe332011-03-26 00:51:24 +0000354 CharUnits BaseOffset;
355 CharUnits BaseOffsetInLayoutClass;
Anders Carlsson147a23d2010-06-04 00:54:04 +0000356 if (I->isVirtual()) {
357 // Check if we've visited this virtual base before.
358 if (SubobjectOffsets.count(std::make_pair(BaseDecl, 0)))
359 continue;
360
361 const ASTRecordLayout &LayoutClassLayout =
362 Context.getASTRecordLayout(LayoutClass);
363
Ken Dyck57ebe332011-03-26 00:51:24 +0000364 BaseOffset = MostDerivedClassLayout.getVBaseClassOffset(BaseDecl);
Anders Carlsson147a23d2010-06-04 00:54:04 +0000365 BaseOffsetInLayoutClass =
Ken Dyck57ebe332011-03-26 00:51:24 +0000366 LayoutClassLayout.getVBaseClassOffset(BaseDecl);
Anders Carlsson147a23d2010-06-04 00:54:04 +0000367 } else {
368 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Ken Dyck57ebe332011-03-26 00:51:24 +0000369 CharUnits Offset = Layout.getBaseClassOffset(BaseDecl);
Anders Carlsson147a23d2010-06-04 00:54:04 +0000370
Ken Dyck57ebe332011-03-26 00:51:24 +0000371 BaseOffset = Base.getBaseOffset() + Offset;
Ken Dyckb4c82b42011-03-26 01:36:26 +0000372 BaseOffsetInLayoutClass = OffsetInLayoutClass + Offset;
Anders Carlsson147a23d2010-06-04 00:54:04 +0000373 }
374
Ken Dyck57ebe332011-03-26 00:51:24 +0000375 ComputeBaseOffsets(BaseSubobject(BaseDecl, BaseOffset),
Ken Dyckb4c82b42011-03-26 01:36:26 +0000376 I->isVirtual(), BaseOffsetInLayoutClass,
Ken Dyck4230d522011-03-24 01:21:01 +0000377 SubobjectOffsets, SubobjectLayoutClassOffsets,
378 SubobjectCounts);
Anders Carlsson147a23d2010-06-04 00:54:04 +0000379 }
380}
381
Chris Lattner5f9e2722011-07-23 10:55:15 +0000382void FinalOverriders::dump(raw_ostream &Out, BaseSubobject Base,
Anders Carlssonb9cae1d2010-06-04 00:59:37 +0000383 VisitedVirtualBasesSetTy &VisitedVirtualBases) {
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000384 const CXXRecordDecl *RD = Base.getBase();
385 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
386
387 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
388 E = RD->bases_end(); I != E; ++I) {
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000389 const CXXRecordDecl *BaseDecl =
390 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
391
Anders Carlssonb828afa2010-02-14 17:05:59 +0000392 // Ignore bases that don't have any virtual member functions.
393 if (!BaseDecl->isPolymorphic())
394 continue;
395
Ken Dyck4230d522011-03-24 01:21:01 +0000396 CharUnits BaseOffset;
Anders Carlsson9d6f0d52010-02-14 00:37:35 +0000397 if (I->isVirtual()) {
398 if (!VisitedVirtualBases.insert(BaseDecl)) {
399 // We've visited this base before.
400 continue;
401 }
402
Ken Dyck4230d522011-03-24 01:21:01 +0000403 BaseOffset = MostDerivedClassLayout.getVBaseClassOffset(BaseDecl);
Anders Carlsson9d6f0d52010-02-14 00:37:35 +0000404 } else {
Ken Dyck4230d522011-03-24 01:21:01 +0000405 BaseOffset = Layout.getBaseClassOffset(BaseDecl) + Base.getBaseOffset();
Anders Carlsson9d6f0d52010-02-14 00:37:35 +0000406 }
407
Anders Carlssonb9cae1d2010-06-04 00:59:37 +0000408 dump(Out, BaseSubobject(BaseDecl, BaseOffset), VisitedVirtualBases);
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000409 }
410
411 Out << "Final overriders for (" << RD->getQualifiedNameAsString() << ", ";
Ken Dyck4230d522011-03-24 01:21:01 +0000412 Out << Base.getBaseOffset().getQuantity() << ")\n";
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000413
414 // Now dump the overriders for this base subobject.
415 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
416 E = RD->method_end(); I != E; ++I) {
417 const CXXMethodDecl *MD = *I;
418
419 if (!MD->isVirtual())
420 continue;
421
Ken Dycke6203132011-03-26 01:18:17 +0000422 OverriderInfo Overrider = getOverrider(MD, Base.getBaseOffset());
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000423
Anders Carlssond86e5d82010-03-02 03:44:06 +0000424 Out << " " << MD->getQualifiedNameAsString() << " - (";
Anders Carlsson16b73122010-02-12 17:13:23 +0000425 Out << Overrider.Method->getQualifiedNameAsString();
Ken Dyck17d85192011-03-26 01:29:16 +0000426 Out << ", " << ", " << Overrider.Offset.getQuantity() << ')';
Anders Carlssond86e5d82010-03-02 03:44:06 +0000427
Anders Carlsson7097e752010-06-01 23:47:05 +0000428 BaseOffset Offset;
429 if (!Overrider.Method->isPure())
430 Offset = ComputeReturnAdjustmentBaseOffset(Context, Overrider.Method, MD);
Anders Carlssona4a54172010-02-13 20:41:15 +0000431
Anders Carlsson7097e752010-06-01 23:47:05 +0000432 if (!Offset.isEmpty()) {
Anders Carlssona4a54172010-02-13 20:41:15 +0000433 Out << " [ret-adj: ";
434 if (Offset.VirtualBase)
435 Out << Offset.VirtualBase->getQualifiedNameAsString() << " vbase, ";
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000436
Ken Dyck396e4f62011-04-02 01:32:03 +0000437 Out << Offset.NonVirtualOffset.getQuantity() << " nv]";
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000438 }
Anders Carlssondf31af12010-02-13 23:17:31 +0000439
Anders Carlsson16b73122010-02-12 17:13:23 +0000440 Out << "\n";
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000441 }
442}
443
Anders Carlsson60cc72a2010-02-18 17:00:09 +0000444/// VCallOffsetMap - Keeps track of vcall offsets when building a vtable.
445struct VCallOffsetMap {
446
Ken Dyckc952d382011-04-02 00:51:15 +0000447 typedef std::pair<const CXXMethodDecl *, CharUnits> MethodAndOffsetPairTy;
Anders Carlsson60cc72a2010-02-18 17:00:09 +0000448
449 /// Offsets - Keeps track of methods and their offsets.
450 // FIXME: This should be a real map and not a vector.
Chris Lattner5f9e2722011-07-23 10:55:15 +0000451 SmallVector<MethodAndOffsetPairTy, 16> Offsets;
Anders Carlsson60cc72a2010-02-18 17:00:09 +0000452
Anders Carlssoneb577d02010-02-18 17:26:40 +0000453 /// MethodsCanShareVCallOffset - Returns whether two virtual member functions
454 /// can share the same vcall offset.
455 static bool MethodsCanShareVCallOffset(const CXXMethodDecl *LHS,
456 const CXXMethodDecl *RHS);
457
Anders Carlsson60cc72a2010-02-18 17:00:09 +0000458public:
459 /// AddVCallOffset - Adds a vcall offset to the map. Returns true if the
460 /// add was successful, or false if there was already a member function with
461 /// the same signature in the map.
Ken Dyckc952d382011-04-02 00:51:15 +0000462 bool AddVCallOffset(const CXXMethodDecl *MD, CharUnits OffsetOffset);
Anders Carlsson60cc72a2010-02-18 17:00:09 +0000463
464 /// getVCallOffsetOffset - Returns the vcall offset offset (relative to the
465 /// vtable address point) for the given virtual member function.
Ken Dyckc952d382011-04-02 00:51:15 +0000466 CharUnits getVCallOffsetOffset(const CXXMethodDecl *MD);
Anders Carlsson60cc72a2010-02-18 17:00:09 +0000467
Anders Carlssondba6ef82010-02-25 22:23:13 +0000468 // empty - Return whether the offset map is empty or not.
469 bool empty() const { return Offsets.empty(); }
Anders Carlsson60cc72a2010-02-18 17:00:09 +0000470};
471
John McCall331a03a2010-02-26 20:22:44 +0000472static bool HasSameVirtualSignature(const CXXMethodDecl *LHS,
473 const CXXMethodDecl *RHS) {
474 ASTContext &C = LHS->getASTContext(); // TODO: thread this down
475 CanQual<FunctionProtoType>
476 LT = C.getCanonicalType(LHS->getType()).getAs<FunctionProtoType>(),
477 RT = C.getCanonicalType(RHS->getType()).getAs<FunctionProtoType>();
478
479 // Fast-path matches in the canonical types.
480 if (LT == RT) return true;
481
482 // Force the signatures to match. We can't rely on the overrides
483 // list here because there isn't necessarily an inheritance
484 // relationship between the two methods.
485 if (LT.getQualifiers() != RT.getQualifiers() ||
486 LT->getNumArgs() != RT->getNumArgs())
487 return false;
488 for (unsigned I = 0, E = LT->getNumArgs(); I != E; ++I)
489 if (LT->getArgType(I) != RT->getArgType(I))
490 return false;
491 return true;
492}
493
Anders Carlssoneb577d02010-02-18 17:26:40 +0000494bool VCallOffsetMap::MethodsCanShareVCallOffset(const CXXMethodDecl *LHS,
495 const CXXMethodDecl *RHS) {
496 assert(LHS->isVirtual() && "LHS must be virtual!");
497 assert(RHS->isVirtual() && "LHS must be virtual!");
498
Anders Carlsson55609692010-02-27 04:12:52 +0000499 // A destructor can share a vcall offset with another destructor.
500 if (isa<CXXDestructorDecl>(LHS))
501 return isa<CXXDestructorDecl>(RHS);
502
Anders Carlssoneb577d02010-02-18 17:26:40 +0000503 // FIXME: We need to check more things here.
504
Anders Carlsson55609692010-02-27 04:12:52 +0000505 // The methods must have the same name.
Anders Carlssoneb577d02010-02-18 17:26:40 +0000506 DeclarationName LHSName = LHS->getDeclName();
507 DeclarationName RHSName = RHS->getDeclName();
John McCall331a03a2010-02-26 20:22:44 +0000508 if (LHSName != RHSName)
Anders Carlssoneb577d02010-02-18 17:26:40 +0000509 return false;
John McCall331a03a2010-02-26 20:22:44 +0000510
Anders Carlsson55609692010-02-27 04:12:52 +0000511 // And the same signatures.
512 return HasSameVirtualSignature(LHS, RHS);
Anders Carlssoneb577d02010-02-18 17:26:40 +0000513}
514
Anders Carlsson60cc72a2010-02-18 17:00:09 +0000515bool VCallOffsetMap::AddVCallOffset(const CXXMethodDecl *MD,
Ken Dyckc952d382011-04-02 00:51:15 +0000516 CharUnits OffsetOffset) {
Anders Carlssoneb577d02010-02-18 17:26:40 +0000517 // Check if we can reuse an offset.
518 for (unsigned I = 0, E = Offsets.size(); I != E; ++I) {
519 if (MethodsCanShareVCallOffset(Offsets[I].first, MD))
520 return false;
521 }
522
523 // Add the offset.
524 Offsets.push_back(MethodAndOffsetPairTy(MD, OffsetOffset));
Anders Carlsson60cc72a2010-02-18 17:00:09 +0000525 return true;
526}
527
Ken Dyckc952d382011-04-02 00:51:15 +0000528CharUnits VCallOffsetMap::getVCallOffsetOffset(const CXXMethodDecl *MD) {
Anders Carlssoneb577d02010-02-18 17:26:40 +0000529 // Look for an offset.
530 for (unsigned I = 0, E = Offsets.size(); I != E; ++I) {
531 if (MethodsCanShareVCallOffset(Offsets[I].first, MD))
532 return Offsets[I].second;
533 }
534
David Blaikieb219cfc2011-09-23 05:06:16 +0000535 llvm_unreachable("Should always find a vcall offset offset!");
Anders Carlsson60cc72a2010-02-18 17:00:09 +0000536}
537
Anders Carlssond68c0832010-02-25 03:45:56 +0000538/// VCallAndVBaseOffsetBuilder - Class for building vcall and vbase offsets.
539class VCallAndVBaseOffsetBuilder {
Anders Carlssonc89a7cf2010-03-11 16:06:20 +0000540public:
Ken Dyckd28c33c2011-04-07 00:55:01 +0000541 typedef llvm::DenseMap<const CXXRecordDecl *, CharUnits>
Anders Carlssonc89a7cf2010-03-11 16:06:20 +0000542 VBaseOffsetOffsetsMapTy;
543
544private:
Anders Carlsson530c40c2010-02-28 01:43:58 +0000545 /// MostDerivedClass - The most derived class for which we're building vcall
546 /// and vbase offsets.
Anders Carlssond68c0832010-02-25 03:45:56 +0000547 const CXXRecordDecl *MostDerivedClass;
548
Anders Carlsson0041a642010-02-27 21:09:00 +0000549 /// LayoutClass - The class we're using for layout information. Will be
550 /// different than the most derived class if we're building a construction
551 /// vtable.
552 const CXXRecordDecl *LayoutClass;
553
Anders Carlssond68c0832010-02-25 03:45:56 +0000554 /// Context - The ASTContext which we will use for layout information.
555 ASTContext &Context;
556
557 /// Components - vcall and vbase offset components
Chris Lattner5f9e2722011-07-23 10:55:15 +0000558 typedef SmallVector<VTableComponent, 64> VTableComponentVectorTy;
Anders Carlsson94464812010-04-10 19:13:06 +0000559 VTableComponentVectorTy Components;
Anders Carlssond68c0832010-02-25 03:45:56 +0000560
561 /// VisitedVirtualBases - Visited virtual bases.
562 llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBases;
563
564 /// VCallOffsets - Keeps track of vcall offsets.
565 VCallOffsetMap VCallOffsets;
566
Anders Carlssonbb6305b2010-03-11 06:43:12 +0000567
568 /// VBaseOffsetOffsets - Contains the offsets of the virtual base offsets,
569 /// relative to the address point.
570 VBaseOffsetOffsetsMapTy VBaseOffsetOffsets;
571
Anders Carlssond68c0832010-02-25 03:45:56 +0000572 /// FinalOverriders - The final overriders of the most derived class.
573 /// (Can be null when we're not building a vtable of the most derived class).
574 const FinalOverriders *Overriders;
575
576 /// AddVCallAndVBaseOffsets - Add vcall offsets and vbase offsets for the
577 /// given base subobject.
578 void AddVCallAndVBaseOffsets(BaseSubobject Base, bool BaseIsVirtual,
Ken Dyckf38d8ae2011-03-31 00:37:24 +0000579 CharUnits RealBaseOffset);
Anders Carlssond68c0832010-02-25 03:45:56 +0000580
581 /// AddVCallOffsets - Add vcall offsets for the given base subobject.
Ken Dyck301af862011-03-30 10:11:40 +0000582 void AddVCallOffsets(BaseSubobject Base, CharUnits VBaseOffset);
Anders Carlssond68c0832010-02-25 03:45:56 +0000583
584 /// AddVBaseOffsets - Add vbase offsets for the given class.
Ken Dyckbb625e92011-03-31 00:56:47 +0000585 void AddVBaseOffsets(const CXXRecordDecl *Base,
586 CharUnits OffsetInLayoutClass);
Anders Carlssond68c0832010-02-25 03:45:56 +0000587
Anders Carlssonbb6305b2010-03-11 06:43:12 +0000588 /// getCurrentOffsetOffset - Get the current vcall or vbase offset offset in
Ken Dyck3ed994b2011-03-31 01:08:46 +0000589 /// chars, relative to the vtable address point.
590 CharUnits getCurrentOffsetOffset() const;
Anders Carlssonbb6305b2010-03-11 06:43:12 +0000591
Anders Carlssond68c0832010-02-25 03:45:56 +0000592public:
593 VCallAndVBaseOffsetBuilder(const CXXRecordDecl *MostDerivedClass,
Anders Carlsson0041a642010-02-27 21:09:00 +0000594 const CXXRecordDecl *LayoutClass,
Anders Carlssond68c0832010-02-25 03:45:56 +0000595 const FinalOverriders *Overriders,
Anders Carlsson530c40c2010-02-28 01:43:58 +0000596 BaseSubobject Base, bool BaseIsVirtual,
Ken Dyck3ecfa2d2011-03-31 00:48:04 +0000597 CharUnits OffsetInLayoutClass)
Anders Carlsson530c40c2010-02-28 01:43:58 +0000598 : MostDerivedClass(MostDerivedClass), LayoutClass(LayoutClass),
Anders Carlssond68c0832010-02-25 03:45:56 +0000599 Context(MostDerivedClass->getASTContext()), Overriders(Overriders) {
600
601 // Add vcall and vbase offsets.
Ken Dyck3ecfa2d2011-03-31 00:48:04 +0000602 AddVCallAndVBaseOffsets(Base, BaseIsVirtual, OffsetInLayoutClass);
Anders Carlssond68c0832010-02-25 03:45:56 +0000603 }
604
605 /// Methods for iterating over the components.
Anders Carlsson94464812010-04-10 19:13:06 +0000606 typedef VTableComponentVectorTy::const_reverse_iterator const_iterator;
Anders Carlssond68c0832010-02-25 03:45:56 +0000607 const_iterator components_begin() const { return Components.rbegin(); }
608 const_iterator components_end() const { return Components.rend(); }
609
Anders Carlssonc89a7cf2010-03-11 16:06:20 +0000610 const VCallOffsetMap &getVCallOffsets() const { return VCallOffsets; }
611 const VBaseOffsetOffsetsMapTy &getVBaseOffsetOffsets() const {
Anders Carlssonbb6305b2010-03-11 06:43:12 +0000612 return VBaseOffsetOffsets;
613 }
Anders Carlssond68c0832010-02-25 03:45:56 +0000614};
615
616void
617VCallAndVBaseOffsetBuilder::AddVCallAndVBaseOffsets(BaseSubobject Base,
618 bool BaseIsVirtual,
Ken Dyckf38d8ae2011-03-31 00:37:24 +0000619 CharUnits RealBaseOffset) {
Anders Carlssond68c0832010-02-25 03:45:56 +0000620 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Base.getBase());
621
622 // Itanium C++ ABI 2.5.2:
623 // ..in classes sharing a virtual table with a primary base class, the vcall
624 // and vbase offsets added by the derived class all come before the vcall
625 // and vbase offsets required by the base class, so that the latter may be
626 // laid out as required by the base class without regard to additions from
627 // the derived class(es).
628
629 // (Since we're emitting the vcall and vbase offsets in reverse order, we'll
630 // emit them for the primary base first).
631 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
Anders Carlssonc9e814b2010-11-24 23:12:57 +0000632 bool PrimaryBaseIsVirtual = Layout.isPrimaryBaseVirtual();
Anders Carlssond68c0832010-02-25 03:45:56 +0000633
Ken Dyck57ebe332011-03-26 00:51:24 +0000634 CharUnits PrimaryBaseOffset;
Anders Carlssond68c0832010-02-25 03:45:56 +0000635
636 // Get the base offset of the primary base.
637 if (PrimaryBaseIsVirtual) {
Anders Carlssona14f5972010-10-31 23:22:37 +0000638 assert(Layout.getVBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlssond68c0832010-02-25 03:45:56 +0000639 "Primary vbase should have a zero offset!");
640
641 const ASTRecordLayout &MostDerivedClassLayout =
642 Context.getASTRecordLayout(MostDerivedClass);
643
644 PrimaryBaseOffset =
Ken Dyck57ebe332011-03-26 00:51:24 +0000645 MostDerivedClassLayout.getVBaseClassOffset(PrimaryBase);
Anders Carlssond68c0832010-02-25 03:45:56 +0000646 } else {
Anders Carlssona14f5972010-10-31 23:22:37 +0000647 assert(Layout.getBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlssond68c0832010-02-25 03:45:56 +0000648 "Primary base should have a zero offset!");
649
Ken Dyck57ebe332011-03-26 00:51:24 +0000650 PrimaryBaseOffset = Base.getBaseOffset();
Anders Carlssond68c0832010-02-25 03:45:56 +0000651 }
652
Ken Dyck4230d522011-03-24 01:21:01 +0000653 AddVCallAndVBaseOffsets(
Ken Dyck57ebe332011-03-26 00:51:24 +0000654 BaseSubobject(PrimaryBase,PrimaryBaseOffset),
Ken Dyck4230d522011-03-24 01:21:01 +0000655 PrimaryBaseIsVirtual, RealBaseOffset);
Anders Carlssond68c0832010-02-25 03:45:56 +0000656 }
657
Ken Dyckbb625e92011-03-31 00:56:47 +0000658 AddVBaseOffsets(Base.getBase(), RealBaseOffset);
Anders Carlssond68c0832010-02-25 03:45:56 +0000659
660 // We only want to add vcall offsets for virtual bases.
661 if (BaseIsVirtual)
Ken Dyckf38d8ae2011-03-31 00:37:24 +0000662 AddVCallOffsets(Base, RealBaseOffset);
Anders Carlssond68c0832010-02-25 03:45:56 +0000663}
664
Ken Dyck3ed994b2011-03-31 01:08:46 +0000665CharUnits VCallAndVBaseOffsetBuilder::getCurrentOffsetOffset() const {
Anders Carlssonbb6305b2010-03-11 06:43:12 +0000666 // OffsetIndex is the index of this vcall or vbase offset, relative to the
667 // vtable address point. (We subtract 3 to account for the information just
668 // above the address point, the RTTI info, the offset to top, and the
669 // vcall offset itself).
670 int64_t OffsetIndex = -(int64_t)(3 + Components.size());
671
Ken Dyck3ed994b2011-03-31 01:08:46 +0000672 CharUnits PointerWidth =
Douglas Gregorbcfd1f52011-09-02 00:18:52 +0000673 Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerWidth(0));
Ken Dyck3ed994b2011-03-31 01:08:46 +0000674 CharUnits OffsetOffset = PointerWidth * OffsetIndex;
Anders Carlssonbb6305b2010-03-11 06:43:12 +0000675 return OffsetOffset;
676}
677
Anders Carlssond68c0832010-02-25 03:45:56 +0000678void VCallAndVBaseOffsetBuilder::AddVCallOffsets(BaseSubobject Base,
Ken Dyck301af862011-03-30 10:11:40 +0000679 CharUnits VBaseOffset) {
Anders Carlssond68c0832010-02-25 03:45:56 +0000680 const CXXRecordDecl *RD = Base.getBase();
681 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
682
John McCall331a03a2010-02-26 20:22:44 +0000683 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
684
Anders Carlssond68c0832010-02-25 03:45:56 +0000685 // Handle the primary base first.
Anders Carlssonaf6ddf22010-04-11 20:04:11 +0000686 // We only want to add vcall offsets if the base is non-virtual; a virtual
687 // primary base will have its vcall and vbase offsets emitted already.
Anders Carlssonc9e814b2010-11-24 23:12:57 +0000688 if (PrimaryBase && !Layout.isPrimaryBaseVirtual()) {
Anders Carlssond68c0832010-02-25 03:45:56 +0000689 // Get the base offset of the primary base.
Anders Carlssona14f5972010-10-31 23:22:37 +0000690 assert(Layout.getBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlssonaf6ddf22010-04-11 20:04:11 +0000691 "Primary base should have a zero offset!");
Anders Carlssond68c0832010-02-25 03:45:56 +0000692
Anders Carlssonaf6ddf22010-04-11 20:04:11 +0000693 AddVCallOffsets(BaseSubobject(PrimaryBase, Base.getBaseOffset()),
Anders Carlssond68c0832010-02-25 03:45:56 +0000694 VBaseOffset);
695 }
Anders Carlssonaf6ddf22010-04-11 20:04:11 +0000696
Anders Carlssond68c0832010-02-25 03:45:56 +0000697 // Add the vcall offsets.
698 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
699 E = RD->method_end(); I != E; ++I) {
700 const CXXMethodDecl *MD = *I;
701
702 if (!MD->isVirtual())
703 continue;
704
Ken Dyck3ed994b2011-03-31 01:08:46 +0000705 CharUnits OffsetOffset = getCurrentOffsetOffset();
Anders Carlssond68c0832010-02-25 03:45:56 +0000706
707 // Don't add a vcall offset if we already have one for this member function
708 // signature.
Ken Dyckc952d382011-04-02 00:51:15 +0000709 if (!VCallOffsets.AddVCallOffset(MD, OffsetOffset))
Anders Carlssond68c0832010-02-25 03:45:56 +0000710 continue;
711
Ken Dyck0c64b7d2011-03-30 01:21:33 +0000712 CharUnits Offset = CharUnits::Zero();
Anders Carlssond68c0832010-02-25 03:45:56 +0000713
714 if (Overriders) {
715 // Get the final overrider.
716 FinalOverriders::OverriderInfo Overrider =
Ken Dycke6203132011-03-26 01:18:17 +0000717 Overriders->getOverrider(MD, Base.getBaseOffset());
Anders Carlssond68c0832010-02-25 03:45:56 +0000718
Anders Carlsson438bc422010-02-28 00:10:58 +0000719 /// The vcall offset is the offset from the virtual base to the object
720 /// where the function was overridden.
Ken Dyck301af862011-03-30 10:11:40 +0000721 Offset = Overrider.Offset - VBaseOffset;
Anders Carlssond68c0832010-02-25 03:45:56 +0000722 }
723
Ken Dyck0c64b7d2011-03-30 01:21:33 +0000724 Components.push_back(
Ken Dyckc40a3fd2011-04-02 01:14:48 +0000725 VTableComponent::MakeVCallOffset(Offset));
Anders Carlssond68c0832010-02-25 03:45:56 +0000726 }
727
728 // And iterate over all non-virtual bases (ignoring the primary base).
729 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
730 E = RD->bases_end(); I != E; ++I) {
731
732 if (I->isVirtual())
733 continue;
734
735 const CXXRecordDecl *BaseDecl =
736 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
John McCall331a03a2010-02-26 20:22:44 +0000737 if (BaseDecl == PrimaryBase)
738 continue;
Anders Carlssond68c0832010-02-25 03:45:56 +0000739
740 // Get the base offset of this base.
Ken Dyck57ebe332011-03-26 00:51:24 +0000741 CharUnits BaseOffset = Base.getBaseOffset() +
742 Layout.getBaseClassOffset(BaseDecl);
Anders Carlssond68c0832010-02-25 03:45:56 +0000743
Ken Dyck57ebe332011-03-26 00:51:24 +0000744 AddVCallOffsets(BaseSubobject(BaseDecl, BaseOffset),
745 VBaseOffset);
Anders Carlssond68c0832010-02-25 03:45:56 +0000746 }
747}
748
Ken Dyckbb625e92011-03-31 00:56:47 +0000749void
750VCallAndVBaseOffsetBuilder::AddVBaseOffsets(const CXXRecordDecl *RD,
751 CharUnits OffsetInLayoutClass) {
Anders Carlsson0041a642010-02-27 21:09:00 +0000752 const ASTRecordLayout &LayoutClassLayout =
753 Context.getASTRecordLayout(LayoutClass);
Anders Carlssond68c0832010-02-25 03:45:56 +0000754
755 // Add vbase offsets.
756 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
757 E = RD->bases_end(); I != E; ++I) {
758 const CXXRecordDecl *BaseDecl =
759 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
760
761 // Check if this is a virtual base that we haven't visited before.
762 if (I->isVirtual() && VisitedVirtualBases.insert(BaseDecl)) {
Ken Dyckbb625e92011-03-31 00:56:47 +0000763 CharUnits Offset =
764 LayoutClassLayout.getVBaseClassOffset(BaseDecl) - OffsetInLayoutClass;
Anders Carlssonbb6305b2010-03-11 06:43:12 +0000765
766 // Add the vbase offset offset.
767 assert(!VBaseOffsetOffsets.count(BaseDecl) &&
768 "vbase offset offset already exists!");
769
Ken Dyck3ed994b2011-03-31 01:08:46 +0000770 CharUnits VBaseOffsetOffset = getCurrentOffsetOffset();
771 VBaseOffsetOffsets.insert(
Ken Dyckd28c33c2011-04-07 00:55:01 +0000772 std::make_pair(BaseDecl, VBaseOffsetOffset));
Anders Carlssonbb6305b2010-03-11 06:43:12 +0000773
Ken Dyckbb625e92011-03-31 00:56:47 +0000774 Components.push_back(
Ken Dyckc40a3fd2011-04-02 01:14:48 +0000775 VTableComponent::MakeVBaseOffset(Offset));
Anders Carlssond68c0832010-02-25 03:45:56 +0000776 }
Anders Carlssonbb6305b2010-03-11 06:43:12 +0000777
Anders Carlssond68c0832010-02-25 03:45:56 +0000778 // Check the base class looking for more vbase offsets.
Anders Carlsson88800662010-03-02 05:40:45 +0000779 AddVBaseOffsets(BaseDecl, OffsetInLayoutClass);
Anders Carlssond68c0832010-02-25 03:45:56 +0000780 }
781}
782
Anders Carlsson94464812010-04-10 19:13:06 +0000783/// VTableBuilder - Class for building vtable layout information.
784class VTableBuilder {
Anders Carlsson57071e22010-02-12 05:25:12 +0000785public:
Anders Carlssonb9021e92010-02-27 16:18:19 +0000786 /// PrimaryBasesSetVectorTy - A set vector of direct and indirect
787 /// primary bases.
788 typedef llvm::SmallSetVector<const CXXRecordDecl *, 8>
789 PrimaryBasesSetVectorTy;
790
Ken Dyckd28c33c2011-04-07 00:55:01 +0000791 typedef llvm::DenseMap<const CXXRecordDecl *, CharUnits>
Anders Carlssonccd83d72010-03-24 16:42:11 +0000792 VBaseOffsetOffsetsMapTy;
Anders Carlsson66d567d2010-03-25 00:51:13 +0000793
794 typedef llvm::DenseMap<BaseSubobject, uint64_t>
795 AddressPointsMapTy;
Anders Carlssonccd83d72010-03-24 16:42:11 +0000796
Anders Carlsson57071e22010-02-12 05:25:12 +0000797private:
Anders Carlssonaf440352010-03-23 04:11:45 +0000798 /// VTables - Global vtable information.
Peter Collingbourne1d2b3172011-09-26 01:56:30 +0000799 VTableContext &VTables;
Anders Carlsson60db0ee2010-02-13 21:07:32 +0000800
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000801 /// MostDerivedClass - The most derived class for which we're building this
802 /// vtable.
803 const CXXRecordDecl *MostDerivedClass;
804
Anders Carlssond03a3262010-02-27 20:39:05 +0000805 /// MostDerivedClassOffset - If we're building a construction vtable, this
806 /// holds the offset from the layout class to the most derived class.
Ken Dyck23da84a2011-03-27 20:20:28 +0000807 const CharUnits MostDerivedClassOffset;
Anders Carlssond03a3262010-02-27 20:39:05 +0000808
Anders Carlsson5d7af6b2010-02-28 00:36:23 +0000809 /// MostDerivedClassIsVirtual - Whether the most derived class is a virtual
810 /// base. (This only makes sense when building a construction vtable).
811 bool MostDerivedClassIsVirtual;
812
Anders Carlssond03a3262010-02-27 20:39:05 +0000813 /// LayoutClass - The class we're using for layout information. Will be
814 /// different than the most derived class if we're building a construction
815 /// vtable.
816 const CXXRecordDecl *LayoutClass;
817
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000818 /// Context - The ASTContext which we will use for layout information.
Anders Carlsson57071e22010-02-12 05:25:12 +0000819 ASTContext &Context;
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000820
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000821 /// FinalOverriders - The final overriders of the most derived class.
Anders Carlssond68c0832010-02-25 03:45:56 +0000822 const FinalOverriders Overriders;
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000823
Anders Carlssondba6ef82010-02-25 22:23:13 +0000824 /// VCallOffsetsForVBases - Keeps track of vcall offsets for the virtual
825 /// bases in this vtable.
826 llvm::DenseMap<const CXXRecordDecl *, VCallOffsetMap> VCallOffsetsForVBases;
Anders Carlsson60cc72a2010-02-18 17:00:09 +0000827
Anders Carlssonbb6305b2010-03-11 06:43:12 +0000828 /// VBaseOffsetOffsets - Contains the offsets of the virtual base offsets for
829 /// the most derived class.
830 VBaseOffsetOffsetsMapTy VBaseOffsetOffsets;
831
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000832 /// Components - The components of the vtable being built.
Chris Lattner5f9e2722011-07-23 10:55:15 +0000833 SmallVector<VTableComponent, 64> Components;
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000834
Anders Carlsson822307b2010-02-11 17:18:51 +0000835 /// AddressPoints - Address points for the vtable being built.
Anders Carlssonff143f82010-03-25 00:35:49 +0000836 AddressPointsMapTy AddressPoints;
Anders Carlsson822307b2010-02-11 17:18:51 +0000837
Anders Carlssonb9021e92010-02-27 16:18:19 +0000838 /// MethodInfo - Contains information about a method in a vtable.
839 /// (Used for computing 'this' pointer adjustment thunks.
840 struct MethodInfo {
841 /// BaseOffset - The base offset of this method.
Ken Dyck82abeae2011-03-27 18:57:53 +0000842 const CharUnits BaseOffset;
Anders Carlssonb9021e92010-02-27 16:18:19 +0000843
Anders Carlsson2bc1d3a2010-03-10 21:25:37 +0000844 /// BaseOffsetInLayoutClass - The base offset in the layout class of this
845 /// method.
Ken Dyck82abeae2011-03-27 18:57:53 +0000846 const CharUnits BaseOffsetInLayoutClass;
Anders Carlsson2bc1d3a2010-03-10 21:25:37 +0000847
Anders Carlsson718d0692010-04-11 22:07:06 +0000848 /// VTableIndex - The index in the vtable that this method has.
Anders Carlssonb9021e92010-02-27 16:18:19 +0000849 /// (For destructors, this is the index of the complete destructor).
Anders Carlsson718d0692010-04-11 22:07:06 +0000850 const uint64_t VTableIndex;
Anders Carlssonb9021e92010-02-27 16:18:19 +0000851
Ken Dyck82abeae2011-03-27 18:57:53 +0000852 MethodInfo(CharUnits BaseOffset, CharUnits BaseOffsetInLayoutClass,
Anders Carlsson718d0692010-04-11 22:07:06 +0000853 uint64_t VTableIndex)
Anders Carlsson2bc1d3a2010-03-10 21:25:37 +0000854 : BaseOffset(BaseOffset),
855 BaseOffsetInLayoutClass(BaseOffsetInLayoutClass),
Anders Carlsson718d0692010-04-11 22:07:06 +0000856 VTableIndex(VTableIndex) { }
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +0000857
Ken Dyck82abeae2011-03-27 18:57:53 +0000858 MethodInfo()
859 : BaseOffset(CharUnits::Zero()),
860 BaseOffsetInLayoutClass(CharUnits::Zero()),
861 VTableIndex(0) { }
Anders Carlssonb9021e92010-02-27 16:18:19 +0000862 };
863
864 typedef llvm::DenseMap<const CXXMethodDecl *, MethodInfo> MethodInfoMapTy;
865
866 /// MethodInfoMap - The information for all methods in the vtable we're
867 /// currently building.
868 MethodInfoMapTy MethodInfoMap;
869
Anders Carlsson718d0692010-04-11 22:07:06 +0000870 typedef llvm::DenseMap<uint64_t, ThunkInfo> VTableThunksMapTy;
Anders Carlssondd366812010-03-12 04:54:20 +0000871
Anders Carlsson3a5df3f2010-03-23 04:44:10 +0000872 /// VTableThunks - The thunks by vtable index in the vtable currently being
873 /// built.
Anders Carlsson718d0692010-04-11 22:07:06 +0000874 VTableThunksMapTy VTableThunks;
Anders Carlssonb9021e92010-02-27 16:18:19 +0000875
Chris Lattner5f9e2722011-07-23 10:55:15 +0000876 typedef SmallVector<ThunkInfo, 1> ThunkInfoVectorTy;
Anders Carlssonee5ab9f2010-03-23 04:59:02 +0000877 typedef llvm::DenseMap<const CXXMethodDecl *, ThunkInfoVectorTy> ThunksMapTy;
Anders Carlsson5e454aa2010-03-17 20:06:32 +0000878
Anders Carlsson3a5df3f2010-03-23 04:44:10 +0000879 /// Thunks - A map that contains all the thunks needed for all methods in the
880 /// most derived class for which the vtable is currently being built.
Anders Carlssonee5ab9f2010-03-23 04:59:02 +0000881 ThunksMapTy Thunks;
Anders Carlsson5e454aa2010-03-17 20:06:32 +0000882
883 /// AddThunk - Add a thunk for the given method.
Anders Carlsson9d734f32010-03-21 20:27:14 +0000884 void AddThunk(const CXXMethodDecl *MD, const ThunkInfo &Thunk);
Anders Carlsson5e454aa2010-03-17 20:06:32 +0000885
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +0000886 /// ComputeThisAdjustments - Compute the 'this' pointer adjustments for the
887 /// part of the vtable we're currently building.
888 void ComputeThisAdjustments();
889
Anders Carlssona661a542010-02-16 04:49:44 +0000890 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
891
Anders Carlssonb9021e92010-02-27 16:18:19 +0000892 /// PrimaryVirtualBases - All known virtual bases who are a primary base of
Anders Carlssonaf280c02010-02-23 03:48:14 +0000893 /// some other base.
894 VisitedVirtualBasesSetTy PrimaryVirtualBases;
895
Anders Carlsson60db0ee2010-02-13 21:07:32 +0000896 /// ComputeReturnAdjustment - Compute the return adjustment given a return
Anders Carlsson7dbf47a2010-02-13 20:11:51 +0000897 /// adjustment base offset.
Anders Carlsson2fca9be2010-02-23 01:34:28 +0000898 ReturnAdjustment ComputeReturnAdjustment(BaseOffset Offset);
Anders Carlsson7dbf47a2010-02-13 20:11:51 +0000899
Anders Carlsson379017f2010-02-27 19:57:44 +0000900 /// ComputeThisAdjustmentBaseOffset - Compute the base offset for adjusting
901 /// the 'this' pointer from the base subobject to the derived subobject.
902 BaseOffset ComputeThisAdjustmentBaseOffset(BaseSubobject Base,
903 BaseSubobject Derived) const;
904
Anders Carlsson60cc72a2010-02-18 17:00:09 +0000905 /// ComputeThisAdjustment - Compute the 'this' pointer adjustment for the
Anders Carlsson617def32010-03-12 05:28:07 +0000906 /// given virtual member function, its offset in the layout class and its
907 /// final overrider.
908 ThisAdjustment
909 ComputeThisAdjustment(const CXXMethodDecl *MD,
Ken Dyck0e55ade2011-03-27 19:03:44 +0000910 CharUnits BaseOffsetInLayoutClass,
Anders Carlsson617def32010-03-12 05:28:07 +0000911 FinalOverriders::OverriderInfo Overrider);
912
Anders Carlsson7dbf47a2010-02-13 20:11:51 +0000913 /// AddMethod - Add a single virtual member function to the vtable
914 /// components vector.
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +0000915 void AddMethod(const CXXMethodDecl *MD, ReturnAdjustment ReturnAdjustment);
Anders Carlsson7dbf47a2010-02-13 20:11:51 +0000916
Anders Carlsson464c8f12010-02-23 04:26:39 +0000917 /// IsOverriderUsed - Returns whether the overrider will ever be used in this
918 /// part of the vtable.
919 ///
920 /// Itanium C++ ABI 2.5.2:
921 ///
922 /// struct A { virtual void f(); };
923 /// struct B : virtual public A { int i; };
924 /// struct C : virtual public A { int j; };
925 /// struct D : public B, public C {};
926 ///
927 /// When B and C are declared, A is a primary base in each case, so although
928 /// vcall offsets are allocated in the A-in-B and A-in-C vtables, no this
929 /// adjustment is required and no thunk is generated. However, inside D
930 /// objects, A is no longer a primary base of C, so if we allowed calls to
931 /// C::f() to use the copy of A's vtable in the C subobject, we would need
932 /// to adjust this from C* to B::A*, which would require a third-party
933 /// thunk. Since we require that a call to C::f() first convert to A*,
934 /// C-in-D's copy of A's vtable is never referenced, so this is not
935 /// necessary.
Anders Carlsson60396612010-03-10 06:51:42 +0000936 bool IsOverriderUsed(const CXXMethodDecl *Overrider,
Ken Dyck413e7d22011-04-02 00:44:58 +0000937 CharUnits BaseOffsetInLayoutClass,
Anders Carlsson60396612010-03-10 06:51:42 +0000938 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
Ken Dyck413e7d22011-04-02 00:44:58 +0000939 CharUnits FirstBaseOffsetInLayoutClass) const;
Anders Carlsson60396612010-03-10 06:51:42 +0000940
Anders Carlsson464c8f12010-02-23 04:26:39 +0000941
Anders Carlsson7dbf47a2010-02-13 20:11:51 +0000942 /// AddMethods - Add the methods of this base subobject and all its
943 /// primary bases to the vtable components vector.
Ken Dyck3a726802011-03-27 19:15:11 +0000944 void AddMethods(BaseSubobject Base, CharUnits BaseOffsetInLayoutClass,
Anders Carlsson60396612010-03-10 06:51:42 +0000945 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
Ken Dyck3a726802011-03-27 19:15:11 +0000946 CharUnits FirstBaseOffsetInLayoutClass,
Anders Carlssonb9021e92010-02-27 16:18:19 +0000947 PrimaryBasesSetVectorTy &PrimaryBases);
Anders Carlsson89ad4212010-02-16 16:26:28 +0000948
Anders Carlsson718d0692010-04-11 22:07:06 +0000949 // LayoutVTable - Layout the vtable for the given base class, including its
Anders Carlsson89ad4212010-02-16 16:26:28 +0000950 // secondary vtables and any vtables for virtual bases.
Anders Carlsson718d0692010-04-11 22:07:06 +0000951 void LayoutVTable();
Anders Carlsson89ad4212010-02-16 16:26:28 +0000952
Anders Carlsson718d0692010-04-11 22:07:06 +0000953 /// LayoutPrimaryAndSecondaryVTables - Layout the primary vtable for the
Anders Carlsson89ad4212010-02-16 16:26:28 +0000954 /// given base subobject, as well as all its secondary vtables.
Anders Carlsson91232842010-04-11 22:03:57 +0000955 ///
Anders Carlsson73e6fa02010-04-11 22:20:36 +0000956 /// \param BaseIsMorallyVirtual whether the base subobject is a virtual base
957 /// or a direct or indirect base of a virtual base.
958 ///
Anders Carlsson91232842010-04-11 22:03:57 +0000959 /// \param BaseIsVirtualInLayoutClass - Whether the base subobject is virtual
960 /// in the layout class.
Anders Carlsson718d0692010-04-11 22:07:06 +0000961 void LayoutPrimaryAndSecondaryVTables(BaseSubobject Base,
Anders Carlsson73e6fa02010-04-11 22:20:36 +0000962 bool BaseIsMorallyVirtual,
Anders Carlsson91232842010-04-11 22:03:57 +0000963 bool BaseIsVirtualInLayoutClass,
Ken Dyck7ba8f522011-03-27 20:33:38 +0000964 CharUnits OffsetInLayoutClass);
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000965
Anders Carlsson718d0692010-04-11 22:07:06 +0000966 /// LayoutSecondaryVTables - Layout the secondary vtables for the given base
Anders Carlssonc7b63162010-02-16 16:02:57 +0000967 /// subobject.
Anders Carlssona96a2e92010-03-10 19:39:11 +0000968 ///
969 /// \param BaseIsMorallyVirtual whether the base subobject is a virtual base
970 /// or a direct or indirect base of a virtual base.
Anders Carlsson718d0692010-04-11 22:07:06 +0000971 void LayoutSecondaryVTables(BaseSubobject Base, bool BaseIsMorallyVirtual,
Ken Dyck75762b32011-03-30 00:50:28 +0000972 CharUnits OffsetInLayoutClass);
Anders Carlsson08c26752010-02-27 04:05:52 +0000973
974 /// DeterminePrimaryVirtualBases - Determine the primary virtual bases in this
975 /// class hierarchy.
976 void DeterminePrimaryVirtualBases(const CXXRecordDecl *RD,
Ken Dyck8fe59932011-03-30 01:10:23 +0000977 CharUnits OffsetInLayoutClass,
Anders Carlsson08c26752010-02-27 04:05:52 +0000978 VisitedVirtualBasesSetTy &VBases);
979
Anders Carlsson718d0692010-04-11 22:07:06 +0000980 /// LayoutVTablesForVirtualBases - Layout vtables for all virtual bases of the
Anders Carlsson69dc04e2010-02-16 16:49:35 +0000981 /// given base (excluding any primary bases).
Anders Carlsson718d0692010-04-11 22:07:06 +0000982 void LayoutVTablesForVirtualBases(const CXXRecordDecl *RD,
Anders Carlsson69dc04e2010-02-16 16:49:35 +0000983 VisitedVirtualBasesSetTy &VBases);
984
Anders Carlsson718d0692010-04-11 22:07:06 +0000985 /// isBuildingConstructionVTable - Return whether this vtable builder is
Anders Carlsson438bc422010-02-28 00:10:58 +0000986 /// building a construction vtable.
Anders Carlsson718d0692010-04-11 22:07:06 +0000987 bool isBuildingConstructorVTable() const {
Anders Carlsson438bc422010-02-28 00:10:58 +0000988 return MostDerivedClass != LayoutClass;
989 }
990
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000991public:
Peter Collingbourne1d2b3172011-09-26 01:56:30 +0000992 VTableBuilder(VTableContext &VTables, const CXXRecordDecl *MostDerivedClass,
Ken Dyck23da84a2011-03-27 20:20:28 +0000993 CharUnits MostDerivedClassOffset,
994 bool MostDerivedClassIsVirtual, const
995 CXXRecordDecl *LayoutClass)
Anders Carlssonaf440352010-03-23 04:11:45 +0000996 : VTables(VTables), MostDerivedClass(MostDerivedClass),
Anders Carlsson5d7af6b2010-02-28 00:36:23 +0000997 MostDerivedClassOffset(MostDerivedClassOffset),
998 MostDerivedClassIsVirtual(MostDerivedClassIsVirtual),
999 LayoutClass(LayoutClass), Context(MostDerivedClass->getASTContext()),
Ken Dyck23da84a2011-03-27 20:20:28 +00001000 Overriders(MostDerivedClass, MostDerivedClassOffset, LayoutClass) {
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001001
Anders Carlsson718d0692010-04-11 22:07:06 +00001002 LayoutVTable();
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001003 }
1004
Anders Carlssonfbf6ed42010-03-23 16:36:50 +00001005 ThunksMapTy::const_iterator thunks_begin() const {
1006 return Thunks.begin();
1007 }
1008
1009 ThunksMapTy::const_iterator thunks_end() const {
1010 return Thunks.end();
1011 }
1012
Anders Carlssonccd83d72010-03-24 16:42:11 +00001013 const VBaseOffsetOffsetsMapTy &getVBaseOffsetOffsets() const {
1014 return VBaseOffsetOffsets;
1015 }
1016
1017 /// getNumVTableComponents - Return the number of components in the vtable
1018 /// currently built.
1019 uint64_t getNumVTableComponents() const {
1020 return Components.size();
1021 }
1022
Anders Carlsson66d567d2010-03-25 00:51:13 +00001023 const uint64_t *vtable_components_data_begin() const {
Anders Carlssonccd83d72010-03-24 16:42:11 +00001024 return reinterpret_cast<const uint64_t *>(Components.begin());
1025 }
1026
Anders Carlsson66d567d2010-03-25 00:51:13 +00001027 const uint64_t *vtable_components_data_end() const {
Anders Carlssonccd83d72010-03-24 16:42:11 +00001028 return reinterpret_cast<const uint64_t *>(Components.end());
1029 }
1030
Anders Carlsson66d567d2010-03-25 00:51:13 +00001031 AddressPointsMapTy::const_iterator address_points_begin() const {
1032 return AddressPoints.begin();
1033 }
1034
1035 AddressPointsMapTy::const_iterator address_points_end() const {
1036 return AddressPoints.end();
1037 }
1038
Anders Carlsson718d0692010-04-11 22:07:06 +00001039 VTableThunksMapTy::const_iterator vtable_thunks_begin() const {
Anders Carlsson0d1407e2010-03-25 15:26:28 +00001040 return VTableThunks.begin();
1041 }
1042
Anders Carlsson718d0692010-04-11 22:07:06 +00001043 VTableThunksMapTy::const_iterator vtable_thunks_end() const {
Anders Carlsson0d1407e2010-03-25 15:26:28 +00001044 return VTableThunks.end();
1045 }
1046
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001047 /// dumpLayout - Dump the vtable layout.
Chris Lattner5f9e2722011-07-23 10:55:15 +00001048 void dumpLayout(raw_ostream&);
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001049};
1050
Anders Carlsson94464812010-04-10 19:13:06 +00001051void VTableBuilder::AddThunk(const CXXMethodDecl *MD, const ThunkInfo &Thunk) {
Anders Carlsson718d0692010-04-11 22:07:06 +00001052 assert(!isBuildingConstructorVTable() &&
Anders Carlssonbca5d372010-03-22 20:06:40 +00001053 "Can't add thunks for construction vtable");
Anders Carlsson9135a842010-03-18 02:44:19 +00001054
Chris Lattner5f9e2722011-07-23 10:55:15 +00001055 SmallVector<ThunkInfo, 1> &ThunksVector = Thunks[MD];
Anders Carlsson5e454aa2010-03-17 20:06:32 +00001056
1057 // Check if we have this thunk already.
1058 if (std::find(ThunksVector.begin(), ThunksVector.end(), Thunk) !=
1059 ThunksVector.end())
1060 return;
1061
1062 ThunksVector.push_back(Thunk);
1063}
1064
Anders Carlssonf622b452010-04-10 20:39:29 +00001065typedef llvm::SmallPtrSet<const CXXMethodDecl *, 8> OverriddenMethodsSetTy;
1066
1067/// ComputeAllOverriddenMethods - Given a method decl, will return a set of all
1068/// the overridden methods that the function decl overrides.
1069static void
1070ComputeAllOverriddenMethods(const CXXMethodDecl *MD,
1071 OverriddenMethodsSetTy& OverriddenMethods) {
1072 assert(MD->isVirtual() && "Method is not virtual!");
1073
Anders Carlsson57071e22010-02-12 05:25:12 +00001074 for (CXXMethodDecl::method_iterator I = MD->begin_overridden_methods(),
1075 E = MD->end_overridden_methods(); I != E; ++I) {
1076 const CXXMethodDecl *OverriddenMD = *I;
Anders Carlsson57071e22010-02-12 05:25:12 +00001077
Anders Carlssonf622b452010-04-10 20:39:29 +00001078 OverriddenMethods.insert(OverriddenMD);
1079
1080 ComputeAllOverriddenMethods(OverriddenMD, OverriddenMethods);
Anders Carlsson57071e22010-02-12 05:25:12 +00001081 }
Anders Carlsson57071e22010-02-12 05:25:12 +00001082}
1083
Anders Carlsson94464812010-04-10 19:13:06 +00001084void VTableBuilder::ComputeThisAdjustments() {
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001085 // Now go through the method info map and see if any of the methods need
1086 // 'this' pointer adjustments.
1087 for (MethodInfoMapTy::const_iterator I = MethodInfoMap.begin(),
1088 E = MethodInfoMap.end(); I != E; ++I) {
1089 const CXXMethodDecl *MD = I->first;
1090 const MethodInfo &MethodInfo = I->second;
1091
Anders Carlsson617def32010-03-12 05:28:07 +00001092 // Ignore adjustments for unused function pointers.
Anders Carlsson718d0692010-04-11 22:07:06 +00001093 uint64_t VTableIndex = MethodInfo.VTableIndex;
1094 if (Components[VTableIndex].getKind() ==
Anders Carlsson94464812010-04-10 19:13:06 +00001095 VTableComponent::CK_UnusedFunctionPointer)
Anders Carlsson617def32010-03-12 05:28:07 +00001096 continue;
1097
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001098 // Get the final overrider for this method.
1099 FinalOverriders::OverriderInfo Overrider =
Ken Dyck82abeae2011-03-27 18:57:53 +00001100 Overriders.getOverrider(MD, MethodInfo.BaseOffset);
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001101
Anders Carlssonbca5d372010-03-22 20:06:40 +00001102 // Check if we need an adjustment at all.
Ken Dyck82abeae2011-03-27 18:57:53 +00001103 if (MethodInfo.BaseOffsetInLayoutClass == Overrider.Offset) {
Anders Carlssonadb507d2010-03-29 15:08:41 +00001104 // When a return thunk is needed by a derived class that overrides a
1105 // virtual base, gcc uses a virtual 'this' adjustment as well.
1106 // While the thunk itself might be needed by vtables in subclasses or
1107 // in construction vtables, there doesn't seem to be a reason for using
1108 // the thunk in this vtable. Still, we do so to match gcc.
Anders Carlsson718d0692010-04-11 22:07:06 +00001109 if (VTableThunks.lookup(VTableIndex).Return.isEmpty())
Anders Carlssonadb507d2010-03-29 15:08:41 +00001110 continue;
1111 }
Anders Carlssonbca5d372010-03-22 20:06:40 +00001112
Anders Carlsson617def32010-03-12 05:28:07 +00001113 ThisAdjustment ThisAdjustment =
Ken Dyck0e55ade2011-03-27 19:03:44 +00001114 ComputeThisAdjustment(MD, MethodInfo.BaseOffsetInLayoutClass, Overrider);
Anders Carlsson617def32010-03-12 05:28:07 +00001115
1116 if (ThisAdjustment.isEmpty())
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001117 continue;
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001118
Anders Carlssoncd4e6372010-02-27 18:09:40 +00001119 // Add it.
Anders Carlsson718d0692010-04-11 22:07:06 +00001120 VTableThunks[VTableIndex].This = ThisAdjustment;
Anders Carlsson617def32010-03-12 05:28:07 +00001121
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001122 if (isa<CXXDestructorDecl>(MD)) {
1123 // Add an adjustment for the deleting destructor as well.
Anders Carlsson718d0692010-04-11 22:07:06 +00001124 VTableThunks[VTableIndex + 1].This = ThisAdjustment;
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001125 }
1126 }
1127
1128 /// Clear the method info map.
1129 MethodInfoMap.clear();
Anders Carlsson25394212010-03-22 15:47:01 +00001130
Anders Carlsson718d0692010-04-11 22:07:06 +00001131 if (isBuildingConstructorVTable()) {
Anders Carlsson25394212010-03-22 15:47:01 +00001132 // We don't need to store thunk information for construction vtables.
1133 return;
1134 }
1135
Anders Carlsson718d0692010-04-11 22:07:06 +00001136 for (VTableThunksMapTy::const_iterator I = VTableThunks.begin(),
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00001137 E = VTableThunks.end(); I != E; ++I) {
Anders Carlsson94464812010-04-10 19:13:06 +00001138 const VTableComponent &Component = Components[I->first];
Anders Carlsson25394212010-03-22 15:47:01 +00001139 const ThunkInfo &Thunk = I->second;
Anders Carlssonbca5d372010-03-22 20:06:40 +00001140 const CXXMethodDecl *MD;
Anders Carlsson25394212010-03-22 15:47:01 +00001141
1142 switch (Component.getKind()) {
1143 default:
1144 llvm_unreachable("Unexpected vtable component kind!");
Anders Carlsson94464812010-04-10 19:13:06 +00001145 case VTableComponent::CK_FunctionPointer:
Anders Carlssonbca5d372010-03-22 20:06:40 +00001146 MD = Component.getFunctionDecl();
Anders Carlsson25394212010-03-22 15:47:01 +00001147 break;
Anders Carlsson94464812010-04-10 19:13:06 +00001148 case VTableComponent::CK_CompleteDtorPointer:
Anders Carlssonbca5d372010-03-22 20:06:40 +00001149 MD = Component.getDestructorDecl();
Anders Carlsson25394212010-03-22 15:47:01 +00001150 break;
Anders Carlsson94464812010-04-10 19:13:06 +00001151 case VTableComponent::CK_DeletingDtorPointer:
Anders Carlsson25394212010-03-22 15:47:01 +00001152 // We've already added the thunk when we saw the complete dtor pointer.
Anders Carlssonbca5d372010-03-22 20:06:40 +00001153 continue;
Anders Carlsson25394212010-03-22 15:47:01 +00001154 }
Anders Carlssonbca5d372010-03-22 20:06:40 +00001155
1156 if (MD->getParent() == MostDerivedClass)
1157 AddThunk(MD, Thunk);
Anders Carlsson25394212010-03-22 15:47:01 +00001158 }
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001159}
1160
Anders Carlsson94464812010-04-10 19:13:06 +00001161ReturnAdjustment VTableBuilder::ComputeReturnAdjustment(BaseOffset Offset) {
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001162 ReturnAdjustment Adjustment;
1163
1164 if (!Offset.isEmpty()) {
Anders Carlsson60db0ee2010-02-13 21:07:32 +00001165 if (Offset.VirtualBase) {
1166 // Get the virtual base offset offset.
Anders Carlsson1972ced2010-03-11 07:00:45 +00001167 if (Offset.DerivedClass == MostDerivedClass) {
1168 // We can get the offset offset directly from our map.
1169 Adjustment.VBaseOffsetOffset =
Ken Dyckd28c33c2011-04-07 00:55:01 +00001170 VBaseOffsetOffsets.lookup(Offset.VirtualBase).getQuantity();
Anders Carlsson1972ced2010-03-11 07:00:45 +00001171 } else {
1172 Adjustment.VBaseOffsetOffset =
Anders Carlssonaf440352010-03-23 04:11:45 +00001173 VTables.getVirtualBaseOffsetOffset(Offset.DerivedClass,
Ken Dyck14c65ca2011-04-07 12:37:09 +00001174 Offset.VirtualBase).getQuantity();
Anders Carlsson1972ced2010-03-11 07:00:45 +00001175 }
Anders Carlsson60db0ee2010-02-13 21:07:32 +00001176 }
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001177
Ken Dyck396e4f62011-04-02 01:32:03 +00001178 Adjustment.NonVirtual = Offset.NonVirtualOffset.getQuantity();
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001179 }
1180
1181 return Adjustment;
1182}
1183
Anders Carlsson379017f2010-02-27 19:57:44 +00001184BaseOffset
Anders Carlsson94464812010-04-10 19:13:06 +00001185VTableBuilder::ComputeThisAdjustmentBaseOffset(BaseSubobject Base,
Anders Carlsson379017f2010-02-27 19:57:44 +00001186 BaseSubobject Derived) const {
1187 const CXXRecordDecl *BaseRD = Base.getBase();
1188 const CXXRecordDecl *DerivedRD = Derived.getBase();
1189
1190 CXXBasePaths Paths(/*FindAmbiguities=*/true,
1191 /*RecordPaths=*/true, /*DetectVirtual=*/true);
1192
1193 if (!const_cast<CXXRecordDecl *>(DerivedRD)->
1194 isDerivedFrom(const_cast<CXXRecordDecl *>(BaseRD), Paths)) {
David Blaikieb219cfc2011-09-23 05:06:16 +00001195 llvm_unreachable("Class must be derived from the passed in base class!");
Anders Carlsson379017f2010-02-27 19:57:44 +00001196 }
1197
1198 // We have to go through all the paths, and see which one leads us to the
1199 // right base subobject.
1200 for (CXXBasePaths::const_paths_iterator I = Paths.begin(), E = Paths.end();
1201 I != E; ++I) {
1202 BaseOffset Offset = ComputeBaseOffset(Context, DerivedRD, *I);
1203
Ken Dyck396e4f62011-04-02 01:32:03 +00001204 CharUnits OffsetToBaseSubobject = Offset.NonVirtualOffset;
Anders Carlsson379017f2010-02-27 19:57:44 +00001205
1206 if (Offset.VirtualBase) {
1207 // If we have a virtual base class, the non-virtual offset is relative
1208 // to the virtual base class offset.
Anders Carlsson2bc1d3a2010-03-10 21:25:37 +00001209 const ASTRecordLayout &LayoutClassLayout =
1210 Context.getASTRecordLayout(LayoutClass);
Anders Carlsson379017f2010-02-27 19:57:44 +00001211
1212 /// Get the virtual base offset, relative to the most derived class
1213 /// layout.
1214 OffsetToBaseSubobject +=
Ken Dyck57ebe332011-03-26 00:51:24 +00001215 LayoutClassLayout.getVBaseClassOffset(Offset.VirtualBase);
Anders Carlsson379017f2010-02-27 19:57:44 +00001216 } else {
1217 // Otherwise, the non-virtual offset is relative to the derived class
1218 // offset.
Ken Dyck57ebe332011-03-26 00:51:24 +00001219 OffsetToBaseSubobject += Derived.getBaseOffset();
Anders Carlsson379017f2010-02-27 19:57:44 +00001220 }
1221
1222 // Check if this path gives us the right base subobject.
Ken Dyck57ebe332011-03-26 00:51:24 +00001223 if (OffsetToBaseSubobject == Base.getBaseOffset()) {
Anders Carlsson379017f2010-02-27 19:57:44 +00001224 // Since we're going from the base class _to_ the derived class, we'll
1225 // invert the non-virtual offset here.
1226 Offset.NonVirtualOffset = -Offset.NonVirtualOffset;
1227 return Offset;
1228 }
1229 }
1230
1231 return BaseOffset();
1232}
1233
Anders Carlsson80d8d7d2010-03-23 15:13:06 +00001234ThisAdjustment
Anders Carlsson94464812010-04-10 19:13:06 +00001235VTableBuilder::ComputeThisAdjustment(const CXXMethodDecl *MD,
Ken Dyck0e55ade2011-03-27 19:03:44 +00001236 CharUnits BaseOffsetInLayoutClass,
Anders Carlsson617def32010-03-12 05:28:07 +00001237 FinalOverriders::OverriderInfo Overrider) {
Anders Carlsson617def32010-03-12 05:28:07 +00001238 // Ignore adjustments for pure virtual member functions.
1239 if (Overrider.Method->isPure())
1240 return ThisAdjustment();
1241
Ken Dyck0e55ade2011-03-27 19:03:44 +00001242 BaseSubobject OverriddenBaseSubobject(MD->getParent(),
1243 BaseOffsetInLayoutClass);
Anders Carlsson617def32010-03-12 05:28:07 +00001244
1245 BaseSubobject OverriderBaseSubobject(Overrider.Method->getParent(),
Ken Dyck17d85192011-03-26 01:29:16 +00001246 Overrider.Offset);
Anders Carlsson617def32010-03-12 05:28:07 +00001247
1248 // Compute the adjustment offset.
1249 BaseOffset Offset = ComputeThisAdjustmentBaseOffset(OverriddenBaseSubobject,
1250 OverriderBaseSubobject);
1251 if (Offset.isEmpty())
1252 return ThisAdjustment();
1253
Anders Carlsson49bac9a2010-02-13 23:40:17 +00001254 ThisAdjustment Adjustment;
1255
Anders Carlsson617def32010-03-12 05:28:07 +00001256 if (Offset.VirtualBase) {
1257 // Get the vcall offset map for this virtual base.
1258 VCallOffsetMap &VCallOffsets = VCallOffsetsForVBases[Offset.VirtualBase];
Anders Carlssoneb577d02010-02-18 17:26:40 +00001259
Anders Carlsson617def32010-03-12 05:28:07 +00001260 if (VCallOffsets.empty()) {
1261 // We don't have vcall offsets for this virtual base, go ahead and
1262 // build them.
1263 VCallAndVBaseOffsetBuilder Builder(MostDerivedClass, MostDerivedClass,
1264 /*FinalOverriders=*/0,
Ken Dyck4230d522011-03-24 01:21:01 +00001265 BaseSubobject(Offset.VirtualBase,
1266 CharUnits::Zero()),
Anders Carlsson617def32010-03-12 05:28:07 +00001267 /*BaseIsVirtual=*/true,
Ken Dyck3ecfa2d2011-03-31 00:48:04 +00001268 /*OffsetInLayoutClass=*/
1269 CharUnits::Zero());
Anders Carlsson617def32010-03-12 05:28:07 +00001270
1271 VCallOffsets = Builder.getVCallOffsets();
1272 }
1273
Ken Dyckc952d382011-04-02 00:51:15 +00001274 Adjustment.VCallOffsetOffset =
1275 VCallOffsets.getVCallOffsetOffset(MD).getQuantity();
Anders Carlsson49bac9a2010-02-13 23:40:17 +00001276 }
Anders Carlsson617def32010-03-12 05:28:07 +00001277
1278 // Set the non-virtual part of the adjustment.
Ken Dyck396e4f62011-04-02 01:32:03 +00001279 Adjustment.NonVirtual = Offset.NonVirtualOffset.getQuantity();
Anders Carlsson49bac9a2010-02-13 23:40:17 +00001280
1281 return Adjustment;
1282}
Anders Carlsson617def32010-03-12 05:28:07 +00001283
Anders Carlsson57071e22010-02-12 05:25:12 +00001284void
Anders Carlsson94464812010-04-10 19:13:06 +00001285VTableBuilder::AddMethod(const CXXMethodDecl *MD,
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001286 ReturnAdjustment ReturnAdjustment) {
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001287 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1288 assert(ReturnAdjustment.isEmpty() &&
1289 "Destructor can't have return adjustment!");
Anders Carlsson49bac9a2010-02-13 23:40:17 +00001290
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001291 // Add both the complete destructor and the deleting destructor.
Anders Carlsson94464812010-04-10 19:13:06 +00001292 Components.push_back(VTableComponent::MakeCompleteDtor(DD));
1293 Components.push_back(VTableComponent::MakeDeletingDtor(DD));
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001294 } else {
1295 // Add the return adjustment if necessary.
1296 if (!ReturnAdjustment.isEmpty())
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00001297 VTableThunks[Components.size()].Return = ReturnAdjustment;
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001298
1299 // Add the function.
Anders Carlsson94464812010-04-10 19:13:06 +00001300 Components.push_back(VTableComponent::MakeFunction(MD));
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001301 }
1302}
1303
Anders Carlssonc784ba22010-02-27 06:38:03 +00001304/// OverridesIndirectMethodInBase - Return whether the given member function
1305/// overrides any methods in the set of given bases.
1306/// Unlike OverridesMethodInBase, this checks "overriders of overriders".
1307/// For example, if we have:
1308///
1309/// struct A { virtual void f(); }
1310/// struct B : A { virtual void f(); }
1311/// struct C : B { virtual void f(); }
1312///
1313/// OverridesIndirectMethodInBase will return true if given C::f as the method
Anders Carlssonf622b452010-04-10 20:39:29 +00001314/// and { A } as the set of bases.
Anders Carlssonc784ba22010-02-27 06:38:03 +00001315static bool
1316OverridesIndirectMethodInBases(const CXXMethodDecl *MD,
Anders Carlsson94464812010-04-10 19:13:06 +00001317 VTableBuilder::PrimaryBasesSetVectorTy &Bases) {
Anders Carlssonfbf05612010-04-17 17:24:33 +00001318 if (Bases.count(MD->getParent()))
1319 return true;
1320
Anders Carlssonc784ba22010-02-27 06:38:03 +00001321 for (CXXMethodDecl::method_iterator I = MD->begin_overridden_methods(),
1322 E = MD->end_overridden_methods(); I != E; ++I) {
1323 const CXXMethodDecl *OverriddenMD = *I;
Anders Carlssonc784ba22010-02-27 06:38:03 +00001324
1325 // Check "indirect overriders".
1326 if (OverridesIndirectMethodInBases(OverriddenMD, Bases))
1327 return true;
1328 }
1329
1330 return false;
1331}
1332
Anders Carlsson464c8f12010-02-23 04:26:39 +00001333bool
Anders Carlsson94464812010-04-10 19:13:06 +00001334VTableBuilder::IsOverriderUsed(const CXXMethodDecl *Overrider,
Ken Dyck413e7d22011-04-02 00:44:58 +00001335 CharUnits BaseOffsetInLayoutClass,
Anders Carlsson60396612010-03-10 06:51:42 +00001336 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
Ken Dyck413e7d22011-04-02 00:44:58 +00001337 CharUnits FirstBaseOffsetInLayoutClass) const {
Anders Carlsson464c8f12010-02-23 04:26:39 +00001338 // If the base and the first base in the primary base chain have the same
1339 // offsets, then this overrider will be used.
Anders Carlsson60396612010-03-10 06:51:42 +00001340 if (BaseOffsetInLayoutClass == FirstBaseOffsetInLayoutClass)
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001341 return true;
1342
1343 // We know now that Base (or a direct or indirect base of it) is a primary
1344 // base in part of the class hierarchy, but not a primary base in the most
1345 // derived class.
1346
1347 // If the overrider is the first base in the primary base chain, we know
1348 // that the overrider will be used.
Anders Carlsson60396612010-03-10 06:51:42 +00001349 if (Overrider->getParent() == FirstBaseInPrimaryBaseChain)
Anders Carlsson464c8f12010-02-23 04:26:39 +00001350 return true;
1351
Anders Carlsson94464812010-04-10 19:13:06 +00001352 VTableBuilder::PrimaryBasesSetVectorTy PrimaryBases;
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001353
Anders Carlsson60396612010-03-10 06:51:42 +00001354 const CXXRecordDecl *RD = FirstBaseInPrimaryBaseChain;
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001355 PrimaryBases.insert(RD);
1356
1357 // Now traverse the base chain, starting with the first base, until we find
1358 // the base that is no longer a primary base.
1359 while (true) {
1360 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1361 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
1362
1363 if (!PrimaryBase)
1364 break;
1365
Anders Carlssonc9e814b2010-11-24 23:12:57 +00001366 if (Layout.isPrimaryBaseVirtual()) {
Anders Carlssona14f5972010-10-31 23:22:37 +00001367 assert(Layout.getVBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001368 "Primary base should always be at offset 0!");
1369
Anders Carlssondad0f992010-02-28 18:37:33 +00001370 const ASTRecordLayout &LayoutClassLayout =
1371 Context.getASTRecordLayout(LayoutClass);
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001372
1373 // Now check if this is the primary base that is not a primary base in the
1374 // most derived class.
Ken Dyck413e7d22011-04-02 00:44:58 +00001375 if (LayoutClassLayout.getVBaseClassOffset(PrimaryBase) !=
Anders Carlsson60396612010-03-10 06:51:42 +00001376 FirstBaseOffsetInLayoutClass) {
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001377 // We found it, stop walking the chain.
1378 break;
1379 }
1380 } else {
Anders Carlssona14f5972010-10-31 23:22:37 +00001381 assert(Layout.getBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001382 "Primary base should always be at offset 0!");
1383 }
Anders Carlssoncd4e6372010-02-27 18:09:40 +00001384
Anders Carlssonf89bb6c2010-02-27 19:51:04 +00001385 if (!PrimaryBases.insert(PrimaryBase))
David Blaikieb219cfc2011-09-23 05:06:16 +00001386 llvm_unreachable("Found a duplicate primary base!");
Anders Carlssonf89bb6c2010-02-27 19:51:04 +00001387
Anders Carlssoncd4e6372010-02-27 18:09:40 +00001388 RD = PrimaryBase;
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001389 }
1390
1391 // If the final overrider is an override of one of the primary bases,
1392 // then we know that it will be used.
Anders Carlsson60396612010-03-10 06:51:42 +00001393 return OverridesIndirectMethodInBases(Overrider, PrimaryBases);
Anders Carlsson464c8f12010-02-23 04:26:39 +00001394}
1395
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001396/// FindNearestOverriddenMethod - Given a method, returns the overridden method
1397/// from the nearest base. Returns null if no method was found.
1398static const CXXMethodDecl *
1399FindNearestOverriddenMethod(const CXXMethodDecl *MD,
Anders Carlsson94464812010-04-10 19:13:06 +00001400 VTableBuilder::PrimaryBasesSetVectorTy &Bases) {
Anders Carlssonf622b452010-04-10 20:39:29 +00001401 OverriddenMethodsSetTy OverriddenMethods;
1402 ComputeAllOverriddenMethods(MD, OverriddenMethods);
1403
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001404 for (int I = Bases.size(), E = 0; I != E; --I) {
1405 const CXXRecordDecl *PrimaryBase = Bases[I - 1];
1406
1407 // Now check the overriden methods.
Anders Carlssonf622b452010-04-10 20:39:29 +00001408 for (OverriddenMethodsSetTy::const_iterator I = OverriddenMethods.begin(),
1409 E = OverriddenMethods.end(); I != E; ++I) {
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001410 const CXXMethodDecl *OverriddenMD = *I;
Anders Carlssonf622b452010-04-10 20:39:29 +00001411
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001412 // We found our overridden method.
1413 if (OverriddenMD->getParent() == PrimaryBase)
1414 return OverriddenMD;
1415 }
1416 }
1417
1418 return 0;
1419}
1420
Anders Carlsson60396612010-03-10 06:51:42 +00001421void
Ken Dyck3a726802011-03-27 19:15:11 +00001422VTableBuilder::AddMethods(BaseSubobject Base, CharUnits BaseOffsetInLayoutClass,
Anders Carlsson60396612010-03-10 06:51:42 +00001423 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
Ken Dyck3a726802011-03-27 19:15:11 +00001424 CharUnits FirstBaseOffsetInLayoutClass,
Anders Carlssonb9021e92010-02-27 16:18:19 +00001425 PrimaryBasesSetVectorTy &PrimaryBases) {
Anders Carlsson57071e22010-02-12 05:25:12 +00001426 const CXXRecordDecl *RD = Base.getBase();
Anders Carlsson57071e22010-02-12 05:25:12 +00001427 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1428
1429 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
Ken Dyck57ebe332011-03-26 00:51:24 +00001430 CharUnits PrimaryBaseOffset;
Ken Dyck3a726802011-03-27 19:15:11 +00001431 CharUnits PrimaryBaseOffsetInLayoutClass;
Anders Carlssonc9e814b2010-11-24 23:12:57 +00001432 if (Layout.isPrimaryBaseVirtual()) {
Anders Carlssona14f5972010-10-31 23:22:37 +00001433 assert(Layout.getVBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlssonaf280c02010-02-23 03:48:14 +00001434 "Primary vbase should have a zero offset!");
1435
1436 const ASTRecordLayout &MostDerivedClassLayout =
1437 Context.getASTRecordLayout(MostDerivedClass);
1438
Anders Carlsson60396612010-03-10 06:51:42 +00001439 PrimaryBaseOffset =
Ken Dyck57ebe332011-03-26 00:51:24 +00001440 MostDerivedClassLayout.getVBaseClassOffset(PrimaryBase);
Anders Carlsson60396612010-03-10 06:51:42 +00001441
1442 const ASTRecordLayout &LayoutClassLayout =
1443 Context.getASTRecordLayout(LayoutClass);
1444
1445 PrimaryBaseOffsetInLayoutClass =
Ken Dyck3a726802011-03-27 19:15:11 +00001446 LayoutClassLayout.getVBaseClassOffset(PrimaryBase);
Anders Carlssonaf280c02010-02-23 03:48:14 +00001447 } else {
Anders Carlssona14f5972010-10-31 23:22:37 +00001448 assert(Layout.getBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlsson57071e22010-02-12 05:25:12 +00001449 "Primary base should have a zero offset!");
Anders Carlssonaf280c02010-02-23 03:48:14 +00001450
Ken Dyck57ebe332011-03-26 00:51:24 +00001451 PrimaryBaseOffset = Base.getBaseOffset();
Anders Carlsson60396612010-03-10 06:51:42 +00001452 PrimaryBaseOffsetInLayoutClass = BaseOffsetInLayoutClass;
Anders Carlssonaf280c02010-02-23 03:48:14 +00001453 }
Anders Carlssondad0f992010-02-28 18:37:33 +00001454
Ken Dyck57ebe332011-03-26 00:51:24 +00001455 AddMethods(BaseSubobject(PrimaryBase, PrimaryBaseOffset),
Anders Carlsson60396612010-03-10 06:51:42 +00001456 PrimaryBaseOffsetInLayoutClass, FirstBaseInPrimaryBaseChain,
1457 FirstBaseOffsetInLayoutClass, PrimaryBases);
Anders Carlsson57071e22010-02-12 05:25:12 +00001458
1459 if (!PrimaryBases.insert(PrimaryBase))
David Blaikieb219cfc2011-09-23 05:06:16 +00001460 llvm_unreachable("Found a duplicate primary base!");
Anders Carlsson57071e22010-02-12 05:25:12 +00001461 }
Anders Carlsson822307b2010-02-11 17:18:51 +00001462
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001463 // Now go through all virtual member functions and add them.
1464 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
1465 E = RD->method_end(); I != E; ++I) {
1466 const CXXMethodDecl *MD = *I;
Anders Carlsson57071e22010-02-12 05:25:12 +00001467
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001468 if (!MD->isVirtual())
1469 continue;
Anders Carlsson57071e22010-02-12 05:25:12 +00001470
1471 // Get the final overrider.
Anders Carlssona7575822010-02-12 16:55:34 +00001472 FinalOverriders::OverriderInfo Overrider =
Ken Dycke6203132011-03-26 01:18:17 +00001473 Overriders.getOverrider(MD, Base.getBaseOffset());
Anders Carlsson57071e22010-02-12 05:25:12 +00001474
1475 // Check if this virtual member function overrides a method in a primary
1476 // base. If this is the case, and the return type doesn't require adjustment
1477 // then we can just use the member function from the primary base.
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001478 if (const CXXMethodDecl *OverriddenMD =
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001479 FindNearestOverriddenMethod(MD, PrimaryBases)) {
Anders Carlssondf31af12010-02-13 23:17:31 +00001480 if (ComputeReturnAdjustmentBaseOffset(Context, MD,
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001481 OverriddenMD).isEmpty()) {
1482 // Replace the method info of the overridden method with our own
1483 // method.
1484 assert(MethodInfoMap.count(OverriddenMD) &&
1485 "Did not find the overridden method!");
1486 MethodInfo &OverriddenMethodInfo = MethodInfoMap[OverriddenMD];
1487
Ken Dyck3a726802011-03-27 19:15:11 +00001488 MethodInfo MethodInfo(Base.getBaseOffset(), BaseOffsetInLayoutClass,
1489 OverriddenMethodInfo.VTableIndex);
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001490
1491 assert(!MethodInfoMap.count(MD) &&
1492 "Should not have method info for this method yet!");
1493
1494 MethodInfoMap.insert(std::make_pair(MD, MethodInfo));
1495 MethodInfoMap.erase(OverriddenMD);
Anders Carlssonbca5d372010-03-22 20:06:40 +00001496
1497 // If the overridden method exists in a virtual base class or a direct
1498 // or indirect base class of a virtual base class, we need to emit a
1499 // thunk if we ever have a class hierarchy where the base class is not
1500 // a primary base in the complete object.
Anders Carlsson718d0692010-04-11 22:07:06 +00001501 if (!isBuildingConstructorVTable() && OverriddenMD != MD) {
Anders Carlssonbca5d372010-03-22 20:06:40 +00001502 // Compute the this adjustment.
1503 ThisAdjustment ThisAdjustment =
Ken Dyck3a726802011-03-27 19:15:11 +00001504 ComputeThisAdjustment(OverriddenMD, BaseOffsetInLayoutClass,
1505 Overrider);
Anders Carlssonbca5d372010-03-22 20:06:40 +00001506
Anders Carlssonacfa6ae2010-03-29 02:53:58 +00001507 if (ThisAdjustment.VCallOffsetOffset &&
1508 Overrider.Method->getParent() == MostDerivedClass) {
John McCall4e3b17c2010-11-09 01:18:05 +00001509
1510 // There's no return adjustment from OverriddenMD and MD,
1511 // but that doesn't mean there isn't one between MD and
1512 // the final overrider.
1513 BaseOffset ReturnAdjustmentOffset =
1514 ComputeReturnAdjustmentBaseOffset(Context, Overrider.Method, MD);
1515 ReturnAdjustment ReturnAdjustment =
1516 ComputeReturnAdjustment(ReturnAdjustmentOffset);
1517
Anders Carlssonacfa6ae2010-03-29 02:53:58 +00001518 // This is a virtual thunk for the most derived class, add it.
Anders Carlssonbca5d372010-03-22 20:06:40 +00001519 AddThunk(Overrider.Method,
John McCall4e3b17c2010-11-09 01:18:05 +00001520 ThunkInfo(ThisAdjustment, ReturnAdjustment));
Anders Carlssonbca5d372010-03-22 20:06:40 +00001521 }
1522 }
1523
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001524 continue;
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001525 }
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001526 }
Anders Carlsson0c0eeb22010-02-13 02:02:03 +00001527
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001528 // Insert the method info for this method.
Ken Dyck3a726802011-03-27 19:15:11 +00001529 MethodInfo MethodInfo(Base.getBaseOffset(), BaseOffsetInLayoutClass,
Ken Dyck82abeae2011-03-27 18:57:53 +00001530 Components.size());
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001531
1532 assert(!MethodInfoMap.count(MD) &&
1533 "Should not have method info for this method yet!");
1534 MethodInfoMap.insert(std::make_pair(MD, MethodInfo));
Anders Carlssoncd4e6372010-02-27 18:09:40 +00001535
1536 // Check if this overrider is going to be used.
Anders Carlsson60396612010-03-10 06:51:42 +00001537 const CXXMethodDecl *OverriderMD = Overrider.Method;
Ken Dyck413e7d22011-04-02 00:44:58 +00001538 if (!IsOverriderUsed(OverriderMD, BaseOffsetInLayoutClass,
Anders Carlsson60396612010-03-10 06:51:42 +00001539 FirstBaseInPrimaryBaseChain,
Ken Dyck413e7d22011-04-02 00:44:58 +00001540 FirstBaseOffsetInLayoutClass)) {
Anders Carlsson94464812010-04-10 19:13:06 +00001541 Components.push_back(VTableComponent::MakeUnusedFunction(OverriderMD));
Anders Carlssoncd4e6372010-02-27 18:09:40 +00001542 continue;
1543 }
Anders Carlsson464c8f12010-02-23 04:26:39 +00001544
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001545 // Check if this overrider needs a return adjustment.
Anders Carlsson7097e752010-06-01 23:47:05 +00001546 // We don't want to do this for pure virtual member functions.
1547 BaseOffset ReturnAdjustmentOffset;
1548 if (!OverriderMD->isPure()) {
1549 ReturnAdjustmentOffset =
1550 ComputeReturnAdjustmentBaseOffset(Context, OverriderMD, MD);
1551 }
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001552
1553 ReturnAdjustment ReturnAdjustment =
1554 ComputeReturnAdjustment(ReturnAdjustmentOffset);
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001555
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001556 AddMethod(Overrider.Method, ReturnAdjustment);
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001557 }
1558}
1559
Anders Carlsson718d0692010-04-11 22:07:06 +00001560void VTableBuilder::LayoutVTable() {
Ken Dyck4230d522011-03-24 01:21:01 +00001561 LayoutPrimaryAndSecondaryVTables(BaseSubobject(MostDerivedClass,
1562 CharUnits::Zero()),
Anders Carlsson73e6fa02010-04-11 22:20:36 +00001563 /*BaseIsMorallyVirtual=*/false,
Anders Carlsson530c40c2010-02-28 01:43:58 +00001564 MostDerivedClassIsVirtual,
Ken Dyck7ba8f522011-03-27 20:33:38 +00001565 MostDerivedClassOffset);
Anders Carlsson89ad4212010-02-16 16:26:28 +00001566
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001567 VisitedVirtualBasesSetTy VBases;
Anders Carlsson08c26752010-02-27 04:05:52 +00001568
1569 // Determine the primary virtual bases.
Ken Dyck8fe59932011-03-30 01:10:23 +00001570 DeterminePrimaryVirtualBases(MostDerivedClass, MostDerivedClassOffset,
1571 VBases);
Anders Carlsson08c26752010-02-27 04:05:52 +00001572 VBases.clear();
1573
Anders Carlsson718d0692010-04-11 22:07:06 +00001574 LayoutVTablesForVirtualBases(MostDerivedClass, VBases);
Anders Carlsson89ad4212010-02-16 16:26:28 +00001575}
1576
Anders Carlsson530c40c2010-02-28 01:43:58 +00001577void
Anders Carlsson718d0692010-04-11 22:07:06 +00001578VTableBuilder::LayoutPrimaryAndSecondaryVTables(BaseSubobject Base,
Anders Carlsson73e6fa02010-04-11 22:20:36 +00001579 bool BaseIsMorallyVirtual,
Anders Carlsson91232842010-04-11 22:03:57 +00001580 bool BaseIsVirtualInLayoutClass,
Ken Dyck7ba8f522011-03-27 20:33:38 +00001581 CharUnits OffsetInLayoutClass) {
Chris Lattner04a23112010-02-17 21:42:34 +00001582 assert(Base.getBase()->isDynamicClass() && "class does not have a vtable!");
Anders Carlssonb828afa2010-02-14 17:05:59 +00001583
Anders Carlsson852213e2010-02-16 04:59:55 +00001584 // Add vcall and vbase offsets for this vtable.
Anders Carlsson530c40c2010-02-28 01:43:58 +00001585 VCallAndVBaseOffsetBuilder Builder(MostDerivedClass, LayoutClass, &Overriders,
Anders Carlsson91232842010-04-11 22:03:57 +00001586 Base, BaseIsVirtualInLayoutClass,
Ken Dyck3ecfa2d2011-03-31 00:48:04 +00001587 OffsetInLayoutClass);
Anders Carlssond68c0832010-02-25 03:45:56 +00001588 Components.append(Builder.components_begin(), Builder.components_end());
1589
Anders Carlssondba6ef82010-02-25 22:23:13 +00001590 // Check if we need to add these vcall offsets.
Anders Carlsson91232842010-04-11 22:03:57 +00001591 if (BaseIsVirtualInLayoutClass && !Builder.getVCallOffsets().empty()) {
Anders Carlssondba6ef82010-02-25 22:23:13 +00001592 VCallOffsetMap &VCallOffsets = VCallOffsetsForVBases[Base.getBase()];
1593
1594 if (VCallOffsets.empty())
1595 VCallOffsets = Builder.getVCallOffsets();
1596 }
1597
Anders Carlssonbb6305b2010-03-11 06:43:12 +00001598 // If we're laying out the most derived class we want to keep track of the
1599 // virtual base class offset offsets.
1600 if (Base.getBase() == MostDerivedClass)
1601 VBaseOffsetOffsets = Builder.getVBaseOffsetOffsets();
1602
Anders Carlsson852213e2010-02-16 04:59:55 +00001603 // Add the offset to top.
Ken Dyck7ba8f522011-03-27 20:33:38 +00001604 CharUnits OffsetToTop = MostDerivedClassOffset - OffsetInLayoutClass;
1605 Components.push_back(
Ken Dyckc40a3fd2011-04-02 01:14:48 +00001606 VTableComponent::MakeOffsetToTop(OffsetToTop));
Anders Carlsson57071e22010-02-12 05:25:12 +00001607
1608 // Next, add the RTTI.
Anders Carlsson94464812010-04-10 19:13:06 +00001609 Components.push_back(VTableComponent::MakeRTTI(MostDerivedClass));
Anders Carlsson57071e22010-02-12 05:25:12 +00001610
Anders Carlsson28cbc8b2010-02-12 07:43:48 +00001611 uint64_t AddressPoint = Components.size();
Anders Carlsson57071e22010-02-12 05:25:12 +00001612
1613 // Now go through all virtual member functions and add them.
Anders Carlssonb9021e92010-02-27 16:18:19 +00001614 PrimaryBasesSetVectorTy PrimaryBases;
Ken Dyck7ba8f522011-03-27 20:33:38 +00001615 AddMethods(Base, OffsetInLayoutClass,
1616 Base.getBase(), OffsetInLayoutClass,
Anders Carlsson60396612010-03-10 06:51:42 +00001617 PrimaryBases);
Anders Carlsson57071e22010-02-12 05:25:12 +00001618
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001619 // Compute 'this' pointer adjustments.
1620 ComputeThisAdjustments();
1621
Anders Carlsson014a3582010-03-25 21:45:14 +00001622 // Add all address points.
1623 const CXXRecordDecl *RD = Base.getBase();
1624 while (true) {
Ken Dyck4230d522011-03-24 01:21:01 +00001625 AddressPoints.insert(std::make_pair(
Ken Dyck7ba8f522011-03-27 20:33:38 +00001626 BaseSubobject(RD, OffsetInLayoutClass),
Ken Dyck4230d522011-03-24 01:21:01 +00001627 AddressPoint));
Anders Carlsson014a3582010-03-25 21:45:14 +00001628
1629 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1630 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
Anders Carlsson28cbc8b2010-02-12 07:43:48 +00001631
Anders Carlsson014a3582010-03-25 21:45:14 +00001632 if (!PrimaryBase)
1633 break;
1634
Anders Carlssonc9e814b2010-11-24 23:12:57 +00001635 if (Layout.isPrimaryBaseVirtual()) {
Anders Carlsson014a3582010-03-25 21:45:14 +00001636 // Check if this virtual primary base is a primary base in the layout
1637 // class. If it's not, we don't want to add it.
1638 const ASTRecordLayout &LayoutClassLayout =
1639 Context.getASTRecordLayout(LayoutClass);
1640
Ken Dyck7ba8f522011-03-27 20:33:38 +00001641 if (LayoutClassLayout.getVBaseClassOffset(PrimaryBase) !=
Anders Carlsson014a3582010-03-25 21:45:14 +00001642 OffsetInLayoutClass) {
1643 // We don't want to add this class (or any of its primary bases).
1644 break;
1645 }
1646 }
1647
1648 RD = PrimaryBase;
Anders Carlsson28cbc8b2010-02-12 07:43:48 +00001649 }
1650
Anders Carlsson5edcc372010-02-24 16:43:12 +00001651 // Layout secondary vtables.
Ken Dyck75762b32011-03-30 00:50:28 +00001652 LayoutSecondaryVTables(Base, BaseIsMorallyVirtual, OffsetInLayoutClass);
Anders Carlssonc7b63162010-02-16 16:02:57 +00001653}
1654
Anders Carlsson718d0692010-04-11 22:07:06 +00001655void VTableBuilder::LayoutSecondaryVTables(BaseSubobject Base,
Anders Carlssona96a2e92010-03-10 19:39:11 +00001656 bool BaseIsMorallyVirtual,
Ken Dyck75762b32011-03-30 00:50:28 +00001657 CharUnits OffsetInLayoutClass) {
Anders Carlssonc7b63162010-02-16 16:02:57 +00001658 // Itanium C++ ABI 2.5.2:
1659 // Following the primary virtual table of a derived class are secondary
1660 // virtual tables for each of its proper base classes, except any primary
1661 // base(s) with which it shares its primary virtual table.
1662
1663 const CXXRecordDecl *RD = Base.getBase();
Anders Carlsson57071e22010-02-12 05:25:12 +00001664 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1665 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
Anders Carlssonc7b63162010-02-16 16:02:57 +00001666
Anders Carlsson57071e22010-02-12 05:25:12 +00001667 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1668 E = RD->bases_end(); I != E; ++I) {
Anders Carlssonc7b63162010-02-16 16:02:57 +00001669 // Ignore virtual bases, we'll emit them later.
1670 if (I->isVirtual())
1671 continue;
1672
Anders Carlsson57071e22010-02-12 05:25:12 +00001673 const CXXRecordDecl *BaseDecl =
1674 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Anders Carlssonb828afa2010-02-14 17:05:59 +00001675
Anders Carlssona661a542010-02-16 04:49:44 +00001676 // Ignore bases that don't have a vtable.
1677 if (!BaseDecl->isDynamicClass())
1678 continue;
Anders Carlssonb828afa2010-02-14 17:05:59 +00001679
Anders Carlsson718d0692010-04-11 22:07:06 +00001680 if (isBuildingConstructorVTable()) {
Anders Carlssonf2c98ce2010-03-10 19:15:26 +00001681 // Itanium C++ ABI 2.6.4:
1682 // Some of the base class subobjects may not need construction virtual
1683 // tables, which will therefore not be present in the construction
1684 // virtual table group, even though the subobject virtual tables are
1685 // present in the main virtual table group for the complete object.
Anders Carlssona96a2e92010-03-10 19:39:11 +00001686 if (!BaseIsMorallyVirtual && !BaseDecl->getNumVBases())
Anders Carlssonf2c98ce2010-03-10 19:15:26 +00001687 continue;
Anders Carlssonf2c98ce2010-03-10 19:15:26 +00001688 }
1689
Anders Carlsson76f1aa72010-02-13 22:05:23 +00001690 // Get the base offset of this base.
Ken Dyck57ebe332011-03-26 00:51:24 +00001691 CharUnits RelativeBaseOffset = Layout.getBaseClassOffset(BaseDecl);
1692 CharUnits BaseOffset = Base.getBaseOffset() + RelativeBaseOffset;
Anders Carlsson530c40c2010-02-28 01:43:58 +00001693
Ken Dyck57ebe332011-03-26 00:51:24 +00001694 CharUnits BaseOffsetInLayoutClass =
Ken Dyck75762b32011-03-30 00:50:28 +00001695 OffsetInLayoutClass + RelativeBaseOffset;
Anders Carlssonc7b63162010-02-16 16:02:57 +00001696
1697 // Don't emit a secondary vtable for a primary base. We might however want
1698 // to emit secondary vtables for other bases of this base.
1699 if (BaseDecl == PrimaryBase) {
Ken Dyck75762b32011-03-30 00:50:28 +00001700 LayoutSecondaryVTables(BaseSubobject(BaseDecl, BaseOffset),
1701 BaseIsMorallyVirtual, BaseOffsetInLayoutClass);
Anders Carlssonc7b63162010-02-16 16:02:57 +00001702 continue;
1703 }
Anders Carlsson76f1aa72010-02-13 22:05:23 +00001704
Anders Carlsson89ad4212010-02-16 16:26:28 +00001705 // Layout the primary vtable (and any secondary vtables) for this base.
Ken Dyck4230d522011-03-24 01:21:01 +00001706 LayoutPrimaryAndSecondaryVTables(
Ken Dyck57ebe332011-03-26 00:51:24 +00001707 BaseSubobject(BaseDecl, BaseOffset),
Ken Dyck4230d522011-03-24 01:21:01 +00001708 BaseIsMorallyVirtual,
1709 /*BaseIsVirtualInLayoutClass=*/false,
Ken Dyck7ba8f522011-03-27 20:33:38 +00001710 BaseOffsetInLayoutClass);
Anders Carlsson57071e22010-02-12 05:25:12 +00001711 }
1712}
1713
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001714void
Anders Carlsson94464812010-04-10 19:13:06 +00001715VTableBuilder::DeterminePrimaryVirtualBases(const CXXRecordDecl *RD,
Ken Dyck8fe59932011-03-30 01:10:23 +00001716 CharUnits OffsetInLayoutClass,
Anders Carlsson08c26752010-02-27 04:05:52 +00001717 VisitedVirtualBasesSetTy &VBases) {
1718 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1719
1720 // Check if this base has a primary base.
1721 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
Anders Carlsson0378bf02010-02-28 18:08:38 +00001722
1723 // Check if it's virtual.
Anders Carlssonc9e814b2010-11-24 23:12:57 +00001724 if (Layout.isPrimaryBaseVirtual()) {
Anders Carlsson0378bf02010-02-28 18:08:38 +00001725 bool IsPrimaryVirtualBase = true;
1726
Anders Carlsson718d0692010-04-11 22:07:06 +00001727 if (isBuildingConstructorVTable()) {
Anders Carlsson0378bf02010-02-28 18:08:38 +00001728 // Check if the base is actually a primary base in the class we use for
1729 // layout.
Anders Carlssond7fdae52010-03-10 03:02:01 +00001730 const ASTRecordLayout &LayoutClassLayout =
1731 Context.getASTRecordLayout(LayoutClass);
1732
Ken Dyck8fe59932011-03-30 01:10:23 +00001733 CharUnits PrimaryBaseOffsetInLayoutClass =
1734 LayoutClassLayout.getVBaseClassOffset(PrimaryBase);
Anders Carlssond7fdae52010-03-10 03:02:01 +00001735
1736 // We know that the base is not a primary base in the layout class if
1737 // the base offsets are different.
1738 if (PrimaryBaseOffsetInLayoutClass != OffsetInLayoutClass)
Anders Carlsson0378bf02010-02-28 18:08:38 +00001739 IsPrimaryVirtualBase = false;
1740 }
1741
1742 if (IsPrimaryVirtualBase)
1743 PrimaryVirtualBases.insert(PrimaryBase);
1744 }
Anders Carlsson08c26752010-02-27 04:05:52 +00001745 }
1746
1747 // Traverse bases, looking for more primary virtual bases.
1748 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1749 E = RD->bases_end(); I != E; ++I) {
1750 const CXXRecordDecl *BaseDecl =
1751 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1752
Ken Dyck8fe59932011-03-30 01:10:23 +00001753 CharUnits BaseOffsetInLayoutClass;
Anders Carlssond7fdae52010-03-10 03:02:01 +00001754
1755 if (I->isVirtual()) {
1756 if (!VBases.insert(BaseDecl))
1757 continue;
1758
1759 const ASTRecordLayout &LayoutClassLayout =
1760 Context.getASTRecordLayout(LayoutClass);
Anders Carlsson08c26752010-02-27 04:05:52 +00001761
Anders Carlssona14f5972010-10-31 23:22:37 +00001762 BaseOffsetInLayoutClass =
Ken Dyck8fe59932011-03-30 01:10:23 +00001763 LayoutClassLayout.getVBaseClassOffset(BaseDecl);
Anders Carlssond7fdae52010-03-10 03:02:01 +00001764 } else {
1765 BaseOffsetInLayoutClass =
Ken Dyck8fe59932011-03-30 01:10:23 +00001766 OffsetInLayoutClass + Layout.getBaseClassOffset(BaseDecl);
Anders Carlssond7fdae52010-03-10 03:02:01 +00001767 }
1768
1769 DeterminePrimaryVirtualBases(BaseDecl, BaseOffsetInLayoutClass, VBases);
Anders Carlsson08c26752010-02-27 04:05:52 +00001770 }
1771}
1772
1773void
Anders Carlsson718d0692010-04-11 22:07:06 +00001774VTableBuilder::LayoutVTablesForVirtualBases(const CXXRecordDecl *RD,
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001775 VisitedVirtualBasesSetTy &VBases) {
1776 // Itanium C++ ABI 2.5.2:
1777 // Then come the virtual base virtual tables, also in inheritance graph
1778 // order, and again excluding primary bases (which share virtual tables with
1779 // the classes for which they are primary).
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001780 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1781 E = RD->bases_end(); I != E; ++I) {
1782 const CXXRecordDecl *BaseDecl =
1783 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1784
Anders Carlssonaf280c02010-02-23 03:48:14 +00001785 // Check if this base needs a vtable. (If it's virtual, not a primary base
1786 // of some other class, and we haven't visited it before).
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001787 if (I->isVirtual() && BaseDecl->isDynamicClass() &&
Anders Carlsson08c26752010-02-27 04:05:52 +00001788 !PrimaryVirtualBases.count(BaseDecl) && VBases.insert(BaseDecl)) {
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001789 const ASTRecordLayout &MostDerivedClassLayout =
1790 Context.getASTRecordLayout(MostDerivedClass);
Ken Dyck7262e902011-03-30 01:14:22 +00001791 CharUnits BaseOffset =
1792 MostDerivedClassLayout.getVBaseClassOffset(BaseDecl);
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001793
Anders Carlsson530c40c2010-02-28 01:43:58 +00001794 const ASTRecordLayout &LayoutClassLayout =
1795 Context.getASTRecordLayout(LayoutClass);
Ken Dyck7ba8f522011-03-27 20:33:38 +00001796 CharUnits BaseOffsetInLayoutClass =
1797 LayoutClassLayout.getVBaseClassOffset(BaseDecl);
Anders Carlsson530c40c2010-02-28 01:43:58 +00001798
Ken Dyck4230d522011-03-24 01:21:01 +00001799 LayoutPrimaryAndSecondaryVTables(
Ken Dyck7262e902011-03-30 01:14:22 +00001800 BaseSubobject(BaseDecl, BaseOffset),
Ken Dyck4230d522011-03-24 01:21:01 +00001801 /*BaseIsMorallyVirtual=*/true,
1802 /*BaseIsVirtualInLayoutClass=*/true,
1803 BaseOffsetInLayoutClass);
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001804 }
1805
1806 // We only need to check the base for virtual base vtables if it actually
1807 // has virtual bases.
1808 if (BaseDecl->getNumVBases())
Anders Carlsson718d0692010-04-11 22:07:06 +00001809 LayoutVTablesForVirtualBases(BaseDecl, VBases);
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001810 }
1811}
1812
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001813/// dumpLayout - Dump the vtable layout.
Chris Lattner5f9e2722011-07-23 10:55:15 +00001814void VTableBuilder::dumpLayout(raw_ostream& Out) {
Anders Carlssond03a3262010-02-27 20:39:05 +00001815
Anders Carlsson718d0692010-04-11 22:07:06 +00001816 if (isBuildingConstructorVTable()) {
Anders Carlssond03a3262010-02-27 20:39:05 +00001817 Out << "Construction vtable for ('";
1818 Out << MostDerivedClass->getQualifiedNameAsString() << "', ";
Ken Dyck23da84a2011-03-27 20:20:28 +00001819 Out << MostDerivedClassOffset.getQuantity() << ") in '";
Anders Carlssond03a3262010-02-27 20:39:05 +00001820 Out << LayoutClass->getQualifiedNameAsString();
Anders Carlssonbb6305b2010-03-11 06:43:12 +00001821 } else {
1822 Out << "Vtable for '";
1823 Out << MostDerivedClass->getQualifiedNameAsString();
Anders Carlssond03a3262010-02-27 20:39:05 +00001824 }
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001825 Out << "' (" << Components.size() << " entries).\n";
1826
Anders Carlsson822307b2010-02-11 17:18:51 +00001827 // Iterate through the address points and insert them into a new map where
1828 // they are keyed by the index and not the base object.
1829 // Since an address point can be shared by multiple subobjects, we use an
1830 // STL multimap.
1831 std::multimap<uint64_t, BaseSubobject> AddressPointsByIndex;
Anders Carlssonff143f82010-03-25 00:35:49 +00001832 for (AddressPointsMapTy::const_iterator I = AddressPoints.begin(),
1833 E = AddressPoints.end(); I != E; ++I) {
Anders Carlsson822307b2010-02-11 17:18:51 +00001834 const BaseSubobject& Base = I->first;
1835 uint64_t Index = I->second;
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001836
Anders Carlsson822307b2010-02-11 17:18:51 +00001837 AddressPointsByIndex.insert(std::make_pair(Index, Base));
1838 }
1839
1840 for (unsigned I = 0, E = Components.size(); I != E; ++I) {
Anders Carlsson28cbc8b2010-02-12 07:43:48 +00001841 uint64_t Index = I;
Anders Carlsson822307b2010-02-11 17:18:51 +00001842
1843 Out << llvm::format("%4d | ", I);
1844
Anders Carlsson94464812010-04-10 19:13:06 +00001845 const VTableComponent &Component = Components[I];
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001846
1847 // Dump the component.
1848 switch (Component.getKind()) {
Anders Carlssond9a67042010-02-17 06:07:19 +00001849
Anders Carlsson94464812010-04-10 19:13:06 +00001850 case VTableComponent::CK_VCallOffset:
Ken Dyckc40a3fd2011-04-02 01:14:48 +00001851 Out << "vcall_offset ("
1852 << Component.getVCallOffset().getQuantity()
1853 << ")";
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001854 break;
Anders Carlsson852213e2010-02-16 04:59:55 +00001855
Anders Carlsson94464812010-04-10 19:13:06 +00001856 case VTableComponent::CK_VBaseOffset:
Ken Dyckc40a3fd2011-04-02 01:14:48 +00001857 Out << "vbase_offset ("
1858 << Component.getVBaseOffset().getQuantity()
1859 << ")";
Anders Carlsson852213e2010-02-16 04:59:55 +00001860 break;
1861
Anders Carlsson94464812010-04-10 19:13:06 +00001862 case VTableComponent::CK_OffsetToTop:
Ken Dyckc40a3fd2011-04-02 01:14:48 +00001863 Out << "offset_to_top ("
1864 << Component.getOffsetToTop().getQuantity()
1865 << ")";
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001866 break;
1867
Anders Carlsson94464812010-04-10 19:13:06 +00001868 case VTableComponent::CK_RTTI:
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001869 Out << Component.getRTTIDecl()->getQualifiedNameAsString() << " RTTI";
1870 break;
1871
Anders Carlsson94464812010-04-10 19:13:06 +00001872 case VTableComponent::CK_FunctionPointer: {
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001873 const CXXMethodDecl *MD = Component.getFunctionDecl();
1874
Anders Carlsson848fa642010-02-11 18:20:28 +00001875 std::string Str =
1876 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
1877 MD);
1878 Out << Str;
Anders Carlsson98241422010-02-12 02:38:13 +00001879 if (MD->isPure())
1880 Out << " [pure]";
1881
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00001882 ThunkInfo Thunk = VTableThunks.lookup(I);
Anders Carlssondd366812010-03-12 04:54:20 +00001883 if (!Thunk.isEmpty()) {
1884 // If this function pointer has a return adjustment, dump it.
1885 if (!Thunk.Return.isEmpty()) {
1886 Out << "\n [return adjustment: ";
1887 Out << Thunk.Return.NonVirtual << " non-virtual";
1888
1889 if (Thunk.Return.VBaseOffsetOffset) {
1890 Out << ", " << Thunk.Return.VBaseOffsetOffset;
1891 Out << " vbase offset offset";
1892 }
Anders Carlsson60cc72a2010-02-18 17:00:09 +00001893
Anders Carlssondd366812010-03-12 04:54:20 +00001894 Out << ']';
1895 }
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001896
Anders Carlssondd366812010-03-12 04:54:20 +00001897 // If this function pointer has a 'this' pointer adjustment, dump it.
1898 if (!Thunk.This.isEmpty()) {
1899 Out << "\n [this adjustment: ";
1900 Out << Thunk.This.NonVirtual << " non-virtual";
1901
1902 if (Thunk.This.VCallOffsetOffset) {
1903 Out << ", " << Thunk.This.VCallOffsetOffset;
1904 Out << " vcall offset offset";
1905 }
Anders Carlsson60cc72a2010-02-18 17:00:09 +00001906
Anders Carlssondd366812010-03-12 04:54:20 +00001907 Out << ']';
1908 }
Anders Carlsson49bac9a2010-02-13 23:40:17 +00001909 }
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001910
Anders Carlsson848fa642010-02-11 18:20:28 +00001911 break;
1912 }
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001913
Anders Carlsson94464812010-04-10 19:13:06 +00001914 case VTableComponent::CK_CompleteDtorPointer:
1915 case VTableComponent::CK_DeletingDtorPointer: {
Anders Carlsson6065e022010-02-19 06:03:53 +00001916 bool IsComplete =
Anders Carlsson94464812010-04-10 19:13:06 +00001917 Component.getKind() == VTableComponent::CK_CompleteDtorPointer;
Anders Carlsson6065e022010-02-19 06:03:53 +00001918
Anders Carlsson848fa642010-02-11 18:20:28 +00001919 const CXXDestructorDecl *DD = Component.getDestructorDecl();
1920
Anders Carlsson6065e022010-02-19 06:03:53 +00001921 Out << DD->getQualifiedNameAsString();
1922 if (IsComplete)
1923 Out << "() [complete]";
1924 else
1925 Out << "() [deleting]";
1926
Anders Carlsson98241422010-02-12 02:38:13 +00001927 if (DD->isPure())
1928 Out << " [pure]";
1929
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00001930 ThunkInfo Thunk = VTableThunks.lookup(I);
Anders Carlssondd366812010-03-12 04:54:20 +00001931 if (!Thunk.isEmpty()) {
1932 // If this destructor has a 'this' pointer adjustment, dump it.
1933 if (!Thunk.This.isEmpty()) {
1934 Out << "\n [this adjustment: ";
1935 Out << Thunk.This.NonVirtual << " non-virtual";
1936
1937 if (Thunk.This.VCallOffsetOffset) {
1938 Out << ", " << Thunk.This.VCallOffsetOffset;
1939 Out << " vcall offset offset";
1940 }
1941
1942 Out << ']';
1943 }
1944 }
Anders Carlsson6065e022010-02-19 06:03:53 +00001945
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001946 break;
1947 }
1948
Anders Carlsson94464812010-04-10 19:13:06 +00001949 case VTableComponent::CK_UnusedFunctionPointer: {
Anders Carlsson1f464662010-02-19 20:08:13 +00001950 const CXXMethodDecl *MD = Component.getUnusedFunctionDecl();
1951
1952 std::string Str =
1953 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
1954 MD);
1955 Out << "[unused] " << Str;
1956 if (MD->isPure())
1957 Out << " [pure]";
1958 }
1959
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001960 }
Anders Carlsson822307b2010-02-11 17:18:51 +00001961
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001962 Out << '\n';
Anders Carlssond2c3a7c2010-02-27 23:58:01 +00001963
1964 // Dump the next address point.
1965 uint64_t NextIndex = Index + 1;
1966 if (AddressPointsByIndex.count(NextIndex)) {
1967 if (AddressPointsByIndex.count(NextIndex) == 1) {
1968 const BaseSubobject &Base =
1969 AddressPointsByIndex.find(NextIndex)->second;
1970
Anders Carlssond2c3a7c2010-02-27 23:58:01 +00001971 Out << " -- (" << Base.getBase()->getQualifiedNameAsString();
Ken Dyck4230d522011-03-24 01:21:01 +00001972 Out << ", " << Base.getBaseOffset().getQuantity();
1973 Out << ") vtable address --\n";
Anders Carlssond2c3a7c2010-02-27 23:58:01 +00001974 } else {
Ken Dyck57ebe332011-03-26 00:51:24 +00001975 CharUnits BaseOffset =
1976 AddressPointsByIndex.lower_bound(NextIndex)->second.getBaseOffset();
Anders Carlssond2c3a7c2010-02-27 23:58:01 +00001977
1978 // We store the class names in a set to get a stable order.
1979 std::set<std::string> ClassNames;
1980 for (std::multimap<uint64_t, BaseSubobject>::const_iterator I =
1981 AddressPointsByIndex.lower_bound(NextIndex), E =
1982 AddressPointsByIndex.upper_bound(NextIndex); I != E; ++I) {
Ken Dyck57ebe332011-03-26 00:51:24 +00001983 assert(I->second.getBaseOffset() == BaseOffset &&
Anders Carlssond2c3a7c2010-02-27 23:58:01 +00001984 "Invalid base offset!");
1985 const CXXRecordDecl *RD = I->second.getBase();
1986 ClassNames.insert(RD->getQualifiedNameAsString());
1987 }
1988
1989 for (std::set<std::string>::const_iterator I = ClassNames.begin(),
1990 E = ClassNames.end(); I != E; ++I) {
Anders Carlssond2c3a7c2010-02-27 23:58:01 +00001991 Out << " -- (" << *I;
Ken Dyck57ebe332011-03-26 00:51:24 +00001992 Out << ", " << BaseOffset.getQuantity() << ") vtable address --\n";
Anders Carlssond2c3a7c2010-02-27 23:58:01 +00001993 }
1994 }
1995 }
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001996 }
Anders Carlssond03a3262010-02-27 20:39:05 +00001997
1998 Out << '\n';
Anders Carlssonbb6305b2010-03-11 06:43:12 +00001999
Anders Carlsson718d0692010-04-11 22:07:06 +00002000 if (isBuildingConstructorVTable())
Anders Carlsson9135a842010-03-18 02:44:19 +00002001 return;
2002
2003 if (MostDerivedClass->getNumVBases()) {
Anders Carlssonbb6305b2010-03-11 06:43:12 +00002004 // We store the virtual base class names and their offsets in a map to get
2005 // a stable order.
Anders Carlssonbb6305b2010-03-11 06:43:12 +00002006
Ken Dyck3015c4c2011-04-07 00:59:42 +00002007 std::map<std::string, CharUnits> ClassNamesAndOffsets;
Anders Carlssonbb6305b2010-03-11 06:43:12 +00002008 for (VBaseOffsetOffsetsMapTy::const_iterator I = VBaseOffsetOffsets.begin(),
2009 E = VBaseOffsetOffsets.end(); I != E; ++I) {
2010 std::string ClassName = I->first->getQualifiedNameAsString();
Ken Dyckd28c33c2011-04-07 00:55:01 +00002011 CharUnits OffsetOffset = I->second;
2012 ClassNamesAndOffsets.insert(
Ken Dyck3015c4c2011-04-07 00:59:42 +00002013 std::make_pair(ClassName, OffsetOffset));
Anders Carlssonbb6305b2010-03-11 06:43:12 +00002014 }
Anders Carlsson9135a842010-03-18 02:44:19 +00002015
2016 Out << "Virtual base offset offsets for '";
2017 Out << MostDerivedClass->getQualifiedNameAsString() << "' (";
2018 Out << ClassNamesAndOffsets.size();
2019 Out << (ClassNamesAndOffsets.size() == 1 ? " entry" : " entries") << ").\n";
Anders Carlssonbb6305b2010-03-11 06:43:12 +00002020
Ken Dyck3015c4c2011-04-07 00:59:42 +00002021 for (std::map<std::string, CharUnits>::const_iterator I =
Anders Carlssonbb6305b2010-03-11 06:43:12 +00002022 ClassNamesAndOffsets.begin(), E = ClassNamesAndOffsets.end();
2023 I != E; ++I)
Ken Dyck3015c4c2011-04-07 00:59:42 +00002024 Out << " " << I->first << " | " << I->second.getQuantity() << '\n';
Anders Carlssonbb6305b2010-03-11 06:43:12 +00002025
2026 Out << "\n";
2027 }
Anders Carlsson9135a842010-03-18 02:44:19 +00002028
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00002029 if (!Thunks.empty()) {
Anders Carlsson9135a842010-03-18 02:44:19 +00002030 // We store the method names in a map to get a stable order.
2031 std::map<std::string, const CXXMethodDecl *> MethodNamesAndDecls;
2032
Anders Carlssonee5ab9f2010-03-23 04:59:02 +00002033 for (ThunksMapTy::const_iterator I = Thunks.begin(), E = Thunks.end();
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00002034 I != E; ++I) {
Anders Carlsson9135a842010-03-18 02:44:19 +00002035 const CXXMethodDecl *MD = I->first;
2036 std::string MethodName =
2037 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
2038 MD);
2039
2040 MethodNamesAndDecls.insert(std::make_pair(MethodName, MD));
2041 }
2042
2043 for (std::map<std::string, const CXXMethodDecl *>::const_iterator I =
2044 MethodNamesAndDecls.begin(), E = MethodNamesAndDecls.end();
2045 I != E; ++I) {
2046 const std::string &MethodName = I->first;
2047 const CXXMethodDecl *MD = I->second;
Anders Carlsson87e0ac82010-03-22 16:30:44 +00002048
Anders Carlssonee5ab9f2010-03-23 04:59:02 +00002049 ThunkInfoVectorTy ThunksVector = Thunks[MD];
Anders Carlsson87e0ac82010-03-22 16:30:44 +00002050 std::sort(ThunksVector.begin(), ThunksVector.end());
Anders Carlsson9135a842010-03-18 02:44:19 +00002051
2052 Out << "Thunks for '" << MethodName << "' (" << ThunksVector.size();
2053 Out << (ThunksVector.size() == 1 ? " entry" : " entries") << ").\n";
2054
2055 for (unsigned I = 0, E = ThunksVector.size(); I != E; ++I) {
2056 const ThunkInfo &Thunk = ThunksVector[I];
2057
2058 Out << llvm::format("%4d | ", I);
2059
Anders Carlsson09daa502010-03-22 16:10:59 +00002060 // If this function pointer has a return pointer adjustment, dump it.
2061 if (!Thunk.Return.isEmpty()) {
2062 Out << "return adjustment: " << Thunk.This.NonVirtual;
2063 Out << " non-virtual";
2064 if (Thunk.Return.VBaseOffsetOffset) {
2065 Out << ", " << Thunk.Return.VBaseOffsetOffset;
2066 Out << " vbase offset offset";
2067 }
2068
2069 if (!Thunk.This.isEmpty())
2070 Out << "\n ";
2071 }
2072
Anders Carlsson9135a842010-03-18 02:44:19 +00002073 // If this function pointer has a 'this' pointer adjustment, dump it.
2074 if (!Thunk.This.isEmpty()) {
Anders Carlsson09daa502010-03-22 16:10:59 +00002075 Out << "this adjustment: ";
2076 Out << Thunk.This.NonVirtual << " non-virtual";
Anders Carlsson9135a842010-03-18 02:44:19 +00002077
2078 if (Thunk.This.VCallOffsetOffset) {
2079 Out << ", " << Thunk.This.VCallOffsetOffset;
Anders Carlsson09daa502010-03-22 16:10:59 +00002080 Out << " vcall offset offset";
Anders Carlsson9135a842010-03-18 02:44:19 +00002081 }
2082 }
2083
2084 Out << '\n';
2085 }
Anders Carlssonbca5d372010-03-22 20:06:40 +00002086
2087 Out << '\n';
Anders Carlsson9135a842010-03-18 02:44:19 +00002088 }
2089 }
Anders Carlssond24e50c2011-04-10 17:42:45 +00002090
2091 // Compute the vtable indices for all the member functions.
2092 // Store them in a map keyed by the index so we'll get a sorted table.
2093 std::map<uint64_t, std::string> IndicesMap;
2094
2095 for (CXXRecordDecl::method_iterator i = MostDerivedClass->method_begin(),
2096 e = MostDerivedClass->method_end(); i != e; ++i) {
2097 const CXXMethodDecl *MD = *i;
2098
2099 // We only want virtual member functions.
2100 if (!MD->isVirtual())
2101 continue;
2102
2103 std::string MethodName =
2104 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
2105 MD);
2106
2107 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2108 IndicesMap[VTables.getMethodVTableIndex(GlobalDecl(DD, Dtor_Complete))] =
2109 MethodName + " [complete]";
2110 IndicesMap[VTables.getMethodVTableIndex(GlobalDecl(DD, Dtor_Deleting))] =
2111 MethodName + " [deleting]";
2112 } else {
2113 IndicesMap[VTables.getMethodVTableIndex(MD)] = MethodName;
2114 }
2115 }
2116
2117 // Print the vtable indices for all the member functions.
2118 if (!IndicesMap.empty()) {
2119 Out << "VTable indices for '";
2120 Out << MostDerivedClass->getQualifiedNameAsString();
2121 Out << "' (" << IndicesMap.size() << " entries).\n";
2122
2123 for (std::map<uint64_t, std::string>::const_iterator I = IndicesMap.begin(),
2124 E = IndicesMap.end(); I != E; ++I) {
2125 uint64_t VTableIndex = I->first;
2126 const std::string &MethodName = I->second;
2127
2128 Out << llvm::format(" %4u | ", VTableIndex) << MethodName << '\n';
2129 }
2130 }
2131
2132 Out << '\n';
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002133}
2134
2135}
2136
Anders Carlssonbdb4a9d2010-11-24 23:04:03 +00002137static void
2138CollectPrimaryBases(const CXXRecordDecl *RD, ASTContext &Context,
2139 VTableBuilder::PrimaryBasesSetVectorTy &PrimaryBases) {
Anders Carlssonb8bced02011-04-10 18:00:32 +00002140 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
2141 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
Anders Carlssonbdb4a9d2010-11-24 23:04:03 +00002142
Anders Carlssonb8bced02011-04-10 18:00:32 +00002143 if (!PrimaryBase)
2144 return;
2145
2146 CollectPrimaryBases(PrimaryBase, Context, PrimaryBases);
2147
2148 if (!PrimaryBases.insert(PrimaryBase))
David Blaikieb219cfc2011-09-23 05:06:16 +00002149 llvm_unreachable("Found a duplicate primary base!");
Anders Carlssonbdb4a9d2010-11-24 23:04:03 +00002150}
2151
Peter Collingbourne1d2b3172011-09-26 01:56:30 +00002152void VTableContext::ComputeMethodVTableIndices(const CXXRecordDecl *RD) {
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002153
2154 // Itanium C++ ABI 2.5.2:
Anders Carlsson45147d02010-02-02 03:37:46 +00002155 // The order of the virtual function pointers in a virtual table is the
2156 // order of declaration of the corresponding member functions in the class.
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002157 //
Anders Carlsson45147d02010-02-02 03:37:46 +00002158 // There is an entry for any virtual function declared in a class,
2159 // whether it is a new function or overrides a base class function,
2160 // unless it overrides a function from the primary base, and conversion
2161 // between their return types does not require an adjustment.
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002162
2163 int64_t CurrentIndex = 0;
2164
Peter Collingbourne1d2b3172011-09-26 01:56:30 +00002165 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002166 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
2167
2168 if (PrimaryBase) {
Anders Carlsson0121fbd2009-11-30 19:43:26 +00002169 assert(PrimaryBase->isDefinition() &&
2170 "Should have the definition decl of the primary base!");
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002171
2172 // Since the record decl shares its vtable pointer with the primary base
2173 // we need to start counting at the end of the primary base's vtable.
2174 CurrentIndex = getNumVirtualFunctionPointers(PrimaryBase);
2175 }
Eli Friedmanea5ae312009-12-15 03:31:17 +00002176
2177 // Collect all the primary bases, so we can check whether methods override
2178 // a method from the base.
Anders Carlsson94464812010-04-10 19:13:06 +00002179 VTableBuilder::PrimaryBasesSetVectorTy PrimaryBases;
Peter Collingbourne1d2b3172011-09-26 01:56:30 +00002180 CollectPrimaryBases(RD, Context, PrimaryBases);
Eli Friedmanea5ae312009-12-15 03:31:17 +00002181
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002182 const CXXDestructorDecl *ImplicitVirtualDtor = 0;
2183
2184 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
2185 e = RD->method_end(); i != e; ++i) {
2186 const CXXMethodDecl *MD = *i;
2187
2188 // We only want virtual methods.
2189 if (!MD->isVirtual())
2190 continue;
2191
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002192 // Check if this method overrides a method in the primary base.
Anders Carlsson57071e22010-02-12 05:25:12 +00002193 if (const CXXMethodDecl *OverriddenMD =
Anders Carlssonf622b452010-04-10 20:39:29 +00002194 FindNearestOverriddenMethod(MD, PrimaryBases)) {
Anders Carlsson57071e22010-02-12 05:25:12 +00002195 // Check if converting from the return type of the method to the
2196 // return type of the overridden method requires conversion.
Peter Collingbourne1d2b3172011-09-26 01:56:30 +00002197 if (ComputeReturnAdjustmentBaseOffset(Context, MD,
Anders Carlssondf31af12010-02-13 23:17:31 +00002198 OverriddenMD).isEmpty()) {
Anders Carlsson57071e22010-02-12 05:25:12 +00002199 // This index is shared between the index in the vtable of the primary
2200 // base class.
2201 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2202 const CXXDestructorDecl *OverriddenDD =
2203 cast<CXXDestructorDecl>(OverriddenMD);
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002204
Anders Carlsson57071e22010-02-12 05:25:12 +00002205 // Add both the complete and deleting entries.
Anders Carlsson046c2942010-04-17 20:15:18 +00002206 MethodVTableIndices[GlobalDecl(DD, Dtor_Complete)] =
2207 getMethodVTableIndex(GlobalDecl(OverriddenDD, Dtor_Complete));
2208 MethodVTableIndices[GlobalDecl(DD, Dtor_Deleting)] =
2209 getMethodVTableIndex(GlobalDecl(OverriddenDD, Dtor_Deleting));
Anders Carlsson57071e22010-02-12 05:25:12 +00002210 } else {
Anders Carlsson046c2942010-04-17 20:15:18 +00002211 MethodVTableIndices[MD] = getMethodVTableIndex(OverriddenMD);
Anders Carlsson57071e22010-02-12 05:25:12 +00002212 }
2213
2214 // We don't need to add an entry for this method.
Anders Carlssonc1eec892010-02-12 18:14:46 +00002215 continue;
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002216 }
2217 }
2218
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002219 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2220 if (MD->isImplicit()) {
2221 assert(!ImplicitVirtualDtor &&
2222 "Did already see an implicit virtual dtor!");
2223 ImplicitVirtualDtor = DD;
2224 continue;
2225 }
Tilmann Schellerca0df922011-03-02 20:40:50 +00002226
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002227 // Add the complete dtor.
Anders Carlsson046c2942010-04-17 20:15:18 +00002228 MethodVTableIndices[GlobalDecl(DD, Dtor_Complete)] = CurrentIndex++;
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002229
2230 // Add the deleting dtor.
Anders Carlsson046c2942010-04-17 20:15:18 +00002231 MethodVTableIndices[GlobalDecl(DD, Dtor_Deleting)] = CurrentIndex++;
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002232 } else {
2233 // Add the entry.
Tilmann Schellerca0df922011-03-02 20:40:50 +00002234 MethodVTableIndices[MD] = CurrentIndex++;
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002235 }
2236 }
2237
2238 if (ImplicitVirtualDtor) {
2239 // Itanium C++ ABI 2.5.2:
Anders Carlssona661a542010-02-16 04:49:44 +00002240 // If a class has an implicitly-defined virtual destructor,
2241 // its entries come after the declared virtual function pointers.
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002242
2243 // Add the complete dtor.
Anders Carlsson046c2942010-04-17 20:15:18 +00002244 MethodVTableIndices[GlobalDecl(ImplicitVirtualDtor, Dtor_Complete)] =
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002245 CurrentIndex++;
2246
2247 // Add the deleting dtor.
Anders Carlsson046c2942010-04-17 20:15:18 +00002248 MethodVTableIndices[GlobalDecl(ImplicitVirtualDtor, Dtor_Deleting)] =
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002249 CurrentIndex++;
2250 }
2251
2252 NumVirtualFunctionPointers[RD] = CurrentIndex;
2253}
2254
Peter Collingbourne1d2b3172011-09-26 01:56:30 +00002255CodeGenVTables::CodeGenVTables(CodeGenModule &CGM)
2256 : CGM(CGM), VTContext(CGM.getContext()) { }
2257
Argyrios Kyrtzidisd2c47bd2010-10-11 03:25:57 +00002258bool CodeGenVTables::ShouldEmitVTableInThisTU(const CXXRecordDecl *RD) {
2259 assert(RD->isDynamicClass() && "Non dynamic classes have no VTable.");
2260
2261 TemplateSpecializationKind TSK = RD->getTemplateSpecializationKind();
2262 if (TSK == TSK_ExplicitInstantiationDeclaration)
2263 return false;
2264
2265 const CXXMethodDecl *KeyFunction = CGM.getContext().getKeyFunction(RD);
2266 if (!KeyFunction)
2267 return true;
2268
2269 // Itanium C++ ABI, 5.2.6 Instantiated Templates:
2270 // An instantiation of a class template requires:
2271 // - In the object where instantiated, the virtual table...
2272 if (TSK == TSK_ImplicitInstantiation ||
2273 TSK == TSK_ExplicitInstantiationDefinition)
2274 return true;
2275
Anders Carlsson6d7f8472011-01-30 20:45:54 +00002276 // If we're building with optimization, we always emit VTables since that
2277 // allows for virtual function calls to be devirtualized.
2278 // (We don't want to do this in -fapple-kext mode however).
2279 if (CGM.getCodeGenOpts().OptimizationLevel && !CGM.getLangOptions().AppleKext)
2280 return true;
2281
Argyrios Kyrtzidisd2c47bd2010-10-11 03:25:57 +00002282 return KeyFunction->hasBody();
2283}
2284
Peter Collingbourne1d2b3172011-09-26 01:56:30 +00002285uint64_t VTableContext::getNumVirtualFunctionPointers(const CXXRecordDecl *RD) {
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002286 llvm::DenseMap<const CXXRecordDecl *, uint64_t>::iterator I =
2287 NumVirtualFunctionPointers.find(RD);
2288 if (I != NumVirtualFunctionPointers.end())
2289 return I->second;
2290
Anders Carlsson046c2942010-04-17 20:15:18 +00002291 ComputeMethodVTableIndices(RD);
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002292
2293 I = NumVirtualFunctionPointers.find(RD);
2294 assert(I != NumVirtualFunctionPointers.end() && "Did not find entry!");
2295 return I->second;
2296}
2297
Peter Collingbourne1d2b3172011-09-26 01:56:30 +00002298uint64_t VTableContext::getMethodVTableIndex(GlobalDecl GD) {
Anders Carlsson046c2942010-04-17 20:15:18 +00002299 MethodVTableIndicesTy::iterator I = MethodVTableIndices.find(GD);
2300 if (I != MethodVTableIndices.end())
Anders Carlssondbd920c2009-10-11 22:13:54 +00002301 return I->second;
2302
Anders Carlssona0fdd912009-11-13 17:08:56 +00002303 const CXXRecordDecl *RD = cast<CXXMethodDecl>(GD.getDecl())->getParent();
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002304
Anders Carlsson046c2942010-04-17 20:15:18 +00002305 ComputeMethodVTableIndices(RD);
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002306
Anders Carlsson046c2942010-04-17 20:15:18 +00002307 I = MethodVTableIndices.find(GD);
2308 assert(I != MethodVTableIndices.end() && "Did not find index!");
Anders Carlssondbd920c2009-10-11 22:13:54 +00002309 return I->second;
2310}
2311
Ken Dyck14c65ca2011-04-07 12:37:09 +00002312CharUnits
Peter Collingbourne1d2b3172011-09-26 01:56:30 +00002313VTableContext::getVirtualBaseOffsetOffset(const CXXRecordDecl *RD,
2314 const CXXRecordDecl *VBase) {
Anders Carlssondbd920c2009-10-11 22:13:54 +00002315 ClassPairTy ClassPair(RD, VBase);
2316
Anders Carlssonbba16072010-03-11 07:15:17 +00002317 VirtualBaseClassOffsetOffsetsMapTy::iterator I =
2318 VirtualBaseClassOffsetOffsets.find(ClassPair);
2319 if (I != VirtualBaseClassOffsetOffsets.end())
Ken Dyck14c65ca2011-04-07 12:37:09 +00002320 return I->second;
Anders Carlssondbd920c2009-10-11 22:13:54 +00002321
Anders Carlssonc89a7cf2010-03-11 16:06:20 +00002322 VCallAndVBaseOffsetBuilder Builder(RD, RD, /*FinalOverriders=*/0,
Ken Dyck4230d522011-03-24 01:21:01 +00002323 BaseSubobject(RD, CharUnits::Zero()),
Anders Carlssonc89a7cf2010-03-11 16:06:20 +00002324 /*BaseIsVirtual=*/false,
Ken Dyck3ecfa2d2011-03-31 00:48:04 +00002325 /*OffsetInLayoutClass=*/CharUnits::Zero());
Anders Carlssonc89a7cf2010-03-11 16:06:20 +00002326
2327 for (VCallAndVBaseOffsetBuilder::VBaseOffsetOffsetsMapTy::const_iterator I =
2328 Builder.getVBaseOffsetOffsets().begin(),
2329 E = Builder.getVBaseOffsetOffsets().end(); I != E; ++I) {
Anders Carlssondbd920c2009-10-11 22:13:54 +00002330 // Insert all types.
2331 ClassPairTy ClassPair(RD, I->first);
2332
Ken Dyckd28c33c2011-04-07 00:55:01 +00002333 VirtualBaseClassOffsetOffsets.insert(
Ken Dyck1a7f7522011-04-07 01:22:42 +00002334 std::make_pair(ClassPair, I->second));
Anders Carlssondbd920c2009-10-11 22:13:54 +00002335 }
2336
Anders Carlssonbba16072010-03-11 07:15:17 +00002337 I = VirtualBaseClassOffsetOffsets.find(ClassPair);
Anders Carlssonbba16072010-03-11 07:15:17 +00002338 assert(I != VirtualBaseClassOffsetOffsets.end() && "Did not find index!");
Anders Carlssondbd920c2009-10-11 22:13:54 +00002339
Ken Dyck14c65ca2011-04-07 12:37:09 +00002340 return I->second;
Anders Carlssondbd920c2009-10-11 22:13:54 +00002341}
2342
Anders Carlsson19879c92010-03-23 17:17:29 +00002343llvm::Constant *CodeGenModule::GetAddrOfThunk(GlobalDecl GD,
Anders Carlsson84c49e42011-02-06 17:15:43 +00002344 const ThunkInfo &Thunk) {
Anders Carlsson19879c92010-03-23 17:17:29 +00002345 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2346
2347 // Compute the mangled name.
2348 llvm::SmallString<256> Name;
Rafael Espindolaf0be9792011-02-11 02:52:17 +00002349 llvm::raw_svector_ostream Out(Name);
Anders Carlsson19879c92010-03-23 17:17:29 +00002350 if (const CXXDestructorDecl* DD = dyn_cast<CXXDestructorDecl>(MD))
John McCall4c40d982010-08-31 07:33:07 +00002351 getCXXABI().getMangleContext().mangleCXXDtorThunk(DD, GD.getDtorType(),
Rafael Espindolaf0be9792011-02-11 02:52:17 +00002352 Thunk.This, Out);
Anders Carlsson19879c92010-03-23 17:17:29 +00002353 else
Rafael Espindolaf0be9792011-02-11 02:52:17 +00002354 getCXXABI().getMangleContext().mangleThunk(MD, Thunk, Out);
2355 Out.flush();
2356
Chris Lattner2acc6e32011-07-18 04:24:23 +00002357 llvm::Type *Ty = getTypes().GetFunctionTypeForVTable(GD);
Anders Carlsson84c49e42011-02-06 17:15:43 +00002358 return GetOrCreateLLVMFunction(Name, Ty, GD, /*ForVTable=*/true);
Anders Carlsson19879c92010-03-23 17:17:29 +00002359}
2360
Anders Carlsson519c3282010-03-24 00:39:18 +00002361static llvm::Value *PerformTypeAdjustment(CodeGenFunction &CGF,
2362 llvm::Value *Ptr,
2363 int64_t NonVirtualAdjustment,
2364 int64_t VirtualAdjustment) {
2365 if (!NonVirtualAdjustment && !VirtualAdjustment)
2366 return Ptr;
2367
Chris Lattner2acc6e32011-07-18 04:24:23 +00002368 llvm::Type *Int8PtrTy =
Anders Carlsson519c3282010-03-24 00:39:18 +00002369 llvm::Type::getInt8PtrTy(CGF.getLLVMContext());
2370
2371 llvm::Value *V = CGF.Builder.CreateBitCast(Ptr, Int8PtrTy);
2372
2373 if (NonVirtualAdjustment) {
2374 // Do the non-virtual adjustment.
2375 V = CGF.Builder.CreateConstInBoundsGEP1_64(V, NonVirtualAdjustment);
2376 }
2377
2378 if (VirtualAdjustment) {
Chris Lattner2acc6e32011-07-18 04:24:23 +00002379 llvm::Type *PtrDiffTy =
Anders Carlsson519c3282010-03-24 00:39:18 +00002380 CGF.ConvertType(CGF.getContext().getPointerDiffType());
2381
2382 // Do the virtual adjustment.
2383 llvm::Value *VTablePtrPtr =
2384 CGF.Builder.CreateBitCast(V, Int8PtrTy->getPointerTo());
2385
2386 llvm::Value *VTablePtr = CGF.Builder.CreateLoad(VTablePtrPtr);
2387
2388 llvm::Value *OffsetPtr =
2389 CGF.Builder.CreateConstInBoundsGEP1_64(VTablePtr, VirtualAdjustment);
2390
2391 OffsetPtr = CGF.Builder.CreateBitCast(OffsetPtr, PtrDiffTy->getPointerTo());
2392
2393 // Load the adjustment offset from the vtable.
2394 llvm::Value *Offset = CGF.Builder.CreateLoad(OffsetPtr);
2395
2396 // Adjust our pointer.
2397 V = CGF.Builder.CreateInBoundsGEP(V, Offset);
2398 }
2399
2400 // Cast back to the original type.
2401 return CGF.Builder.CreateBitCast(V, Ptr->getType());
2402}
2403
John McCall65005532010-08-04 23:46:35 +00002404static void setThunkVisibility(CodeGenModule &CGM, const CXXMethodDecl *MD,
2405 const ThunkInfo &Thunk, llvm::Function *Fn) {
Anders Carlsson0ffeaad2011-01-29 19:39:23 +00002406 CGM.setGlobalVisibility(Fn, MD);
John McCall65005532010-08-04 23:46:35 +00002407
John McCall279b5eb2010-08-12 23:36:15 +00002408 if (!CGM.getCodeGenOpts().HiddenWeakVTables)
2409 return;
2410
John McCall65005532010-08-04 23:46:35 +00002411 // If the thunk has weak/linkonce linkage, but the function must be
2412 // emitted in every translation unit that references it, then we can
2413 // emit its thunks with hidden visibility, since its thunks must be
2414 // emitted when the function is.
2415
John McCall7a536902010-08-05 20:39:18 +00002416 // This follows CodeGenModule::setTypeVisibility; see the comments
2417 // there for explanation.
John McCall65005532010-08-04 23:46:35 +00002418
2419 if ((Fn->getLinkage() != llvm::GlobalVariable::LinkOnceODRLinkage &&
2420 Fn->getLinkage() != llvm::GlobalVariable::WeakODRLinkage) ||
2421 Fn->getVisibility() != llvm::GlobalVariable::DefaultVisibility)
2422 return;
2423
Douglas Gregor4421d2b2011-03-26 12:10:19 +00002424 if (MD->getExplicitVisibility())
John McCall65005532010-08-04 23:46:35 +00002425 return;
2426
2427 switch (MD->getTemplateSpecializationKind()) {
John McCall65005532010-08-04 23:46:35 +00002428 case TSK_ExplicitInstantiationDefinition:
2429 case TSK_ExplicitInstantiationDeclaration:
2430 return;
2431
John McCall65005532010-08-04 23:46:35 +00002432 case TSK_Undeclared:
2433 break;
2434
John McCall7a536902010-08-05 20:39:18 +00002435 case TSK_ExplicitSpecialization:
John McCall65005532010-08-04 23:46:35 +00002436 case TSK_ImplicitInstantiation:
John McCall279b5eb2010-08-12 23:36:15 +00002437 if (!CGM.getCodeGenOpts().HiddenWeakTemplateVTables)
John McCall7a536902010-08-05 20:39:18 +00002438 return;
John McCall65005532010-08-04 23:46:35 +00002439 break;
2440 }
2441
2442 // If there's an explicit definition, and that definition is
2443 // out-of-line, then we can't assume that all users will have a
2444 // definition to emit.
2445 const FunctionDecl *Def = 0;
2446 if (MD->hasBody(Def) && Def->isOutOfLine())
2447 return;
2448
2449 Fn->setVisibility(llvm::GlobalValue::HiddenVisibility);
2450}
2451
John McCall311b4422011-03-09 07:12:35 +00002452#ifndef NDEBUG
2453static bool similar(const ABIArgInfo &infoL, CanQualType typeL,
2454 const ABIArgInfo &infoR, CanQualType typeR) {
2455 return (infoL.getKind() == infoR.getKind() &&
2456 (typeL == typeR ||
2457 (isa<PointerType>(typeL) && isa<PointerType>(typeR)) ||
2458 (isa<ReferenceType>(typeL) && isa<ReferenceType>(typeR))));
2459}
2460#endif
2461
Eli Friedman7dcdf5b2011-05-06 17:27:27 +00002462static RValue PerformReturnAdjustment(CodeGenFunction &CGF,
2463 QualType ResultType, RValue RV,
2464 const ThunkInfo &Thunk) {
2465 // Emit the return adjustment.
2466 bool NullCheckValue = !ResultType->isReferenceType();
2467
2468 llvm::BasicBlock *AdjustNull = 0;
2469 llvm::BasicBlock *AdjustNotNull = 0;
2470 llvm::BasicBlock *AdjustEnd = 0;
2471
2472 llvm::Value *ReturnValue = RV.getScalarVal();
2473
2474 if (NullCheckValue) {
2475 AdjustNull = CGF.createBasicBlock("adjust.null");
2476 AdjustNotNull = CGF.createBasicBlock("adjust.notnull");
2477 AdjustEnd = CGF.createBasicBlock("adjust.end");
2478
2479 llvm::Value *IsNull = CGF.Builder.CreateIsNull(ReturnValue);
2480 CGF.Builder.CreateCondBr(IsNull, AdjustNull, AdjustNotNull);
2481 CGF.EmitBlock(AdjustNotNull);
2482 }
2483
2484 ReturnValue = PerformTypeAdjustment(CGF, ReturnValue,
2485 Thunk.Return.NonVirtual,
2486 Thunk.Return.VBaseOffsetOffset);
2487
2488 if (NullCheckValue) {
2489 CGF.Builder.CreateBr(AdjustEnd);
2490 CGF.EmitBlock(AdjustNull);
2491 CGF.Builder.CreateBr(AdjustEnd);
2492 CGF.EmitBlock(AdjustEnd);
2493
2494 llvm::PHINode *PHI = CGF.Builder.CreatePHI(ReturnValue->getType(), 2);
2495 PHI->addIncoming(ReturnValue, AdjustNotNull);
2496 PHI->addIncoming(llvm::Constant::getNullValue(ReturnValue->getType()),
2497 AdjustNull);
2498 ReturnValue = PHI;
2499 }
2500
2501 return RValue::get(ReturnValue);
2502}
2503
2504// This function does roughly the same thing as GenerateThunk, but in a
2505// very different way, so that va_start and va_end work correctly.
2506// FIXME: This function assumes "this" is the first non-sret LLVM argument of
2507// a function, and that there is an alloca built in the entry block
2508// for all accesses to "this".
2509// FIXME: This function assumes there is only one "ret" statement per function.
2510// FIXME: Cloning isn't correct in the presence of indirect goto!
2511// FIXME: This implementation of thunks bloats codesize by duplicating the
2512// function definition. There are alternatives:
2513// 1. Add some sort of stub support to LLVM for cases where we can
2514// do a this adjustment, then a sibcall.
2515// 2. We could transform the definition to take a va_list instead of an
2516// actual variable argument list, then have the thunks (including a
2517// no-op thunk for the regular definition) call va_start/va_end.
2518// There's a bit of per-call overhead for this solution, but it's
2519// better for codesize if the definition is long.
2520void CodeGenFunction::GenerateVarArgsThunk(
2521 llvm::Function *Fn,
2522 const CGFunctionInfo &FnInfo,
2523 GlobalDecl GD, const ThunkInfo &Thunk) {
2524 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2525 const FunctionProtoType *FPT = MD->getType()->getAs<FunctionProtoType>();
2526 QualType ResultType = FPT->getResultType();
2527
2528 // Get the original function
Chris Lattner2acc6e32011-07-18 04:24:23 +00002529 llvm::Type *Ty =
Eli Friedman7dcdf5b2011-05-06 17:27:27 +00002530 CGM.getTypes().GetFunctionType(FnInfo, /*IsVariadic*/true);
2531 llvm::Value *Callee = CGM.GetAddrOfFunction(GD, Ty, /*ForVTable=*/true);
2532 llvm::Function *BaseFn = cast<llvm::Function>(Callee);
2533
2534 // Clone to thunk.
2535 llvm::Function *NewFn = llvm::CloneFunction(BaseFn);
2536 CGM.getModule().getFunctionList().push_back(NewFn);
2537 Fn->replaceAllUsesWith(NewFn);
2538 NewFn->takeName(Fn);
2539 Fn->eraseFromParent();
2540 Fn = NewFn;
2541
2542 // "Initialize" CGF (minimally).
2543 CurFn = Fn;
2544
2545 // Get the "this" value
2546 llvm::Function::arg_iterator AI = Fn->arg_begin();
2547 if (CGM.ReturnTypeUsesSRet(FnInfo))
2548 ++AI;
2549
2550 // Find the first store of "this", which will be to the alloca associated
2551 // with "this".
2552 llvm::Value *ThisPtr = &*AI;
2553 llvm::BasicBlock *EntryBB = Fn->begin();
2554 llvm::Instruction *ThisStore = 0;
2555 for (llvm::BasicBlock::iterator I = EntryBB->begin(), E = EntryBB->end();
2556 I != E; I++) {
2557 if (isa<llvm::StoreInst>(I) && I->getOperand(0) == ThisPtr) {
2558 ThisStore = cast<llvm::StoreInst>(I);
2559 break;
2560 }
2561 }
2562 assert(ThisStore && "Store of this should be in entry block?");
2563 // Adjust "this", if necessary.
2564 Builder.SetInsertPoint(ThisStore);
2565 llvm::Value *AdjustedThisPtr =
2566 PerformTypeAdjustment(*this, ThisPtr,
2567 Thunk.This.NonVirtual,
2568 Thunk.This.VCallOffsetOffset);
2569 ThisStore->setOperand(0, AdjustedThisPtr);
2570
2571 if (!Thunk.Return.isEmpty()) {
2572 // Fix up the returned value, if necessary.
2573 for (llvm::Function::iterator I = Fn->begin(), E = Fn->end(); I != E; I++) {
2574 llvm::Instruction *T = I->getTerminator();
2575 if (isa<llvm::ReturnInst>(T)) {
2576 RValue RV = RValue::get(T->getOperand(0));
2577 T->eraseFromParent();
2578 Builder.SetInsertPoint(&*I);
2579 RV = PerformReturnAdjustment(*this, ResultType, RV, Thunk);
2580 Builder.CreateRet(RV.getScalarVal());
2581 break;
2582 }
2583 }
2584 }
2585}
2586
John McCalld26bc762011-03-09 04:27:21 +00002587void CodeGenFunction::GenerateThunk(llvm::Function *Fn,
2588 const CGFunctionInfo &FnInfo,
2589 GlobalDecl GD, const ThunkInfo &Thunk) {
Anders Carlsson519c3282010-03-24 00:39:18 +00002590 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2591 const FunctionProtoType *FPT = MD->getType()->getAs<FunctionProtoType>();
2592 QualType ResultType = FPT->getResultType();
2593 QualType ThisType = MD->getThisType(getContext());
2594
2595 FunctionArgList FunctionArgs;
2596
2597 // FIXME: It would be nice if more of this code could be shared with
2598 // CodeGenFunction::GenerateCode.
2599
2600 // Create the implicit 'this' parameter declaration.
John McCall4c40d982010-08-31 07:33:07 +00002601 CurGD = GD;
2602 CGM.getCXXABI().BuildInstanceFunctionParams(*this, ResultType, FunctionArgs);
Anders Carlsson519c3282010-03-24 00:39:18 +00002603
2604 // Add the rest of the parameters.
2605 for (FunctionDecl::param_const_iterator I = MD->param_begin(),
2606 E = MD->param_end(); I != E; ++I) {
2607 ParmVarDecl *Param = *I;
2608
John McCalld26bc762011-03-09 04:27:21 +00002609 FunctionArgs.push_back(Param);
Anders Carlsson519c3282010-03-24 00:39:18 +00002610 }
Tilmann Scheller9c6082f2011-03-02 21:36:49 +00002611
John McCalld26bc762011-03-09 04:27:21 +00002612 StartFunction(GlobalDecl(), ResultType, Fn, FnInfo, FunctionArgs,
2613 SourceLocation());
Anders Carlsson519c3282010-03-24 00:39:18 +00002614
John McCall4c40d982010-08-31 07:33:07 +00002615 CGM.getCXXABI().EmitInstanceFunctionProlog(*this);
2616
Anders Carlsson519c3282010-03-24 00:39:18 +00002617 // Adjust the 'this' pointer if necessary.
2618 llvm::Value *AdjustedThisPtr =
2619 PerformTypeAdjustment(*this, LoadCXXThis(),
2620 Thunk.This.NonVirtual,
2621 Thunk.This.VCallOffsetOffset);
2622
2623 CallArgList CallArgs;
2624
2625 // Add our adjusted 'this' pointer.
Eli Friedman04c9a492011-05-02 17:57:46 +00002626 CallArgs.add(RValue::get(AdjustedThisPtr), ThisType);
Anders Carlsson519c3282010-03-24 00:39:18 +00002627
2628 // Add the rest of the parameters.
2629 for (FunctionDecl::param_const_iterator I = MD->param_begin(),
2630 E = MD->param_end(); I != E; ++I) {
John McCall413ebdb2011-03-11 20:59:21 +00002631 ParmVarDecl *param = *I;
2632 EmitDelegateCallArg(CallArgs, param);
Anders Carlsson519c3282010-03-24 00:39:18 +00002633 }
2634
2635 // Get our callee.
Chris Lattner2acc6e32011-07-18 04:24:23 +00002636 llvm::Type *Ty =
John McCall4c40d982010-08-31 07:33:07 +00002637 CGM.getTypes().GetFunctionType(CGM.getTypes().getFunctionInfo(GD),
Anders Carlsson519c3282010-03-24 00:39:18 +00002638 FPT->isVariadic());
Anders Carlsson84c49e42011-02-06 17:15:43 +00002639 llvm::Value *Callee = CGM.GetAddrOfFunction(GD, Ty, /*ForVTable=*/true);
Anders Carlsson519c3282010-03-24 00:39:18 +00002640
John McCalld26bc762011-03-09 04:27:21 +00002641#ifndef NDEBUG
2642 const CGFunctionInfo &CallFnInfo =
Eli Friedman03f48612011-08-09 18:16:09 +00002643 CGM.getTypes().getFunctionInfo(ResultType, CallArgs, FPT->getExtInfo());
John McCall311b4422011-03-09 07:12:35 +00002644 assert(CallFnInfo.getRegParm() == FnInfo.getRegParm() &&
2645 CallFnInfo.isNoReturn() == FnInfo.isNoReturn() &&
2646 CallFnInfo.getCallingConvention() == FnInfo.getCallingConvention());
2647 assert(similar(CallFnInfo.getReturnInfo(), CallFnInfo.getReturnType(),
2648 FnInfo.getReturnInfo(), FnInfo.getReturnType()));
2649 assert(CallFnInfo.arg_size() == FnInfo.arg_size());
2650 for (unsigned i = 0, e = FnInfo.arg_size(); i != e; ++i)
2651 assert(similar(CallFnInfo.arg_begin()[i].info,
2652 CallFnInfo.arg_begin()[i].type,
2653 FnInfo.arg_begin()[i].info, FnInfo.arg_begin()[i].type));
John McCalld26bc762011-03-09 04:27:21 +00002654#endif
Anders Carlsson519c3282010-03-24 00:39:18 +00002655
Douglas Gregorcb359df2010-05-20 05:54:35 +00002656 // Determine whether we have a return value slot to use.
2657 ReturnValueSlot Slot;
2658 if (!ResultType->isVoidType() &&
2659 FnInfo.getReturnInfo().getKind() == ABIArgInfo::Indirect &&
2660 hasAggregateLLVMType(CurFnInfo->getReturnType()))
2661 Slot = ReturnValueSlot(ReturnValue, ResultType.isVolatileQualified());
2662
Anders Carlsson519c3282010-03-24 00:39:18 +00002663 // Now emit our call.
Douglas Gregorcb359df2010-05-20 05:54:35 +00002664 RValue RV = EmitCall(FnInfo, Callee, Slot, CallArgs, MD);
Anders Carlsson519c3282010-03-24 00:39:18 +00002665
Eli Friedman7dcdf5b2011-05-06 17:27:27 +00002666 if (!Thunk.Return.isEmpty())
2667 RV = PerformReturnAdjustment(*this, ResultType, RV, Thunk);
Anders Carlsson519c3282010-03-24 00:39:18 +00002668
Douglas Gregorcb359df2010-05-20 05:54:35 +00002669 if (!ResultType->isVoidType() && Slot.isNull())
John McCalld16c2cf2011-02-08 08:22:06 +00002670 CGM.getCXXABI().EmitReturnFromThunk(*this, RV, ResultType);
Anders Carlsson519c3282010-03-24 00:39:18 +00002671
2672 FinishFunction();
2673
Anders Carlsson519c3282010-03-24 00:39:18 +00002674 // Set the right linkage.
John McCall8b242332010-05-25 04:30:21 +00002675 CGM.setFunctionLinkage(MD, Fn);
Anders Carlsson519c3282010-03-24 00:39:18 +00002676
2677 // Set the right visibility.
John McCall65005532010-08-04 23:46:35 +00002678 setThunkVisibility(CGM, MD, Thunk, Fn);
Anders Carlsson519c3282010-03-24 00:39:18 +00002679}
2680
Anders Carlsson14e82fd2011-02-06 18:31:40 +00002681void CodeGenVTables::EmitThunk(GlobalDecl GD, const ThunkInfo &Thunk,
2682 bool UseAvailableExternallyLinkage)
Anders Carlssonfbf6ed42010-03-23 16:36:50 +00002683{
John McCalld26bc762011-03-09 04:27:21 +00002684 const CGFunctionInfo &FnInfo = CGM.getTypes().getFunctionInfo(GD);
2685
2686 // FIXME: re-use FnInfo in this computation.
Anders Carlsson84c49e42011-02-06 17:15:43 +00002687 llvm::Constant *Entry = CGM.GetAddrOfThunk(GD, Thunk);
Anders Carlsson19879c92010-03-23 17:17:29 +00002688
Anders Carlsson7986ad52010-03-23 18:18:41 +00002689 // Strip off a bitcast if we got one back.
Anders Carlsson13d68982010-03-24 00:35:44 +00002690 if (llvm::ConstantExpr *CE = dyn_cast<llvm::ConstantExpr>(Entry)) {
Anders Carlsson7986ad52010-03-23 18:18:41 +00002691 assert(CE->getOpcode() == llvm::Instruction::BitCast);
Anders Carlsson13d68982010-03-24 00:35:44 +00002692 Entry = CE->getOperand(0);
Anders Carlsson7986ad52010-03-23 18:18:41 +00002693 }
2694
Anders Carlsson7986ad52010-03-23 18:18:41 +00002695 // There's already a declaration with the same name, check if it has the same
2696 // type or if we need to replace it.
Anders Carlsson13d68982010-03-24 00:35:44 +00002697 if (cast<llvm::GlobalValue>(Entry)->getType()->getElementType() !=
John McCall4c40d982010-08-31 07:33:07 +00002698 CGM.getTypes().GetFunctionTypeForVTable(GD)) {
Anders Carlsson13d68982010-03-24 00:35:44 +00002699 llvm::GlobalValue *OldThunkFn = cast<llvm::GlobalValue>(Entry);
Anders Carlsson7986ad52010-03-23 18:18:41 +00002700
2701 // If the types mismatch then we have to rewrite the definition.
2702 assert(OldThunkFn->isDeclaration() &&
2703 "Shouldn't replace non-declaration");
2704
2705 // Remove the name from the old thunk function and get a new thunk.
Chris Lattner5f9e2722011-07-23 10:55:15 +00002706 OldThunkFn->setName(StringRef());
Anders Carlsson84c49e42011-02-06 17:15:43 +00002707 Entry = CGM.GetAddrOfThunk(GD, Thunk);
Anders Carlsson7986ad52010-03-23 18:18:41 +00002708
2709 // If needed, replace the old thunk with a bitcast.
2710 if (!OldThunkFn->use_empty()) {
2711 llvm::Constant *NewPtrForOldDecl =
Anders Carlsson13d68982010-03-24 00:35:44 +00002712 llvm::ConstantExpr::getBitCast(Entry, OldThunkFn->getType());
Anders Carlsson7986ad52010-03-23 18:18:41 +00002713 OldThunkFn->replaceAllUsesWith(NewPtrForOldDecl);
2714 }
2715
2716 // Remove the old thunk.
2717 OldThunkFn->eraseFromParent();
2718 }
Anders Carlsson519c3282010-03-24 00:39:18 +00002719
Anders Carlsson519c3282010-03-24 00:39:18 +00002720 llvm::Function *ThunkFn = cast<llvm::Function>(Entry);
Anders Carlsson14e82fd2011-02-06 18:31:40 +00002721
2722 if (!ThunkFn->isDeclaration()) {
2723 if (UseAvailableExternallyLinkage) {
2724 // There is already a thunk emitted for this function, do nothing.
2725 return;
2726 }
2727
Anders Carlsson22df7b12011-02-06 20:09:44 +00002728 // If a function has a body, it should have available_externally linkage.
2729 assert(ThunkFn->hasAvailableExternallyLinkage() &&
2730 "Function should have available_externally linkage!");
2731
2732 // Change the linkage.
2733 CGM.setFunctionLinkage(cast<CXXMethodDecl>(GD.getDecl()), ThunkFn);
2734 return;
Anders Carlsson14e82fd2011-02-06 18:31:40 +00002735 }
2736
Eli Friedman7dcdf5b2011-05-06 17:27:27 +00002737 if (ThunkFn->isVarArg()) {
2738 // Varargs thunks are special; we can't just generate a call because
2739 // we can't copy the varargs. Our implementation is rather
2740 // expensive/sucky at the moment, so don't generate the thunk unless
2741 // we have to.
2742 // FIXME: Do something better here; GenerateVarArgsThunk is extremely ugly.
2743 if (!UseAvailableExternallyLinkage)
2744 CodeGenFunction(CGM).GenerateVarArgsThunk(ThunkFn, FnInfo, GD, Thunk);
2745 } else {
2746 // Normal thunk body generation.
2747 CodeGenFunction(CGM).GenerateThunk(ThunkFn, FnInfo, GD, Thunk);
2748 }
Anders Carlsson14e82fd2011-02-06 18:31:40 +00002749
2750 if (UseAvailableExternallyLinkage)
2751 ThunkFn->setLinkage(llvm::GlobalValue::AvailableExternallyLinkage);
2752}
2753
2754void CodeGenVTables::MaybeEmitThunkAvailableExternally(GlobalDecl GD,
2755 const ThunkInfo &Thunk) {
2756 // We only want to do this when building with optimizations.
2757 if (!CGM.getCodeGenOpts().OptimizationLevel)
2758 return;
2759
2760 // We can't emit thunks for member functions with incomplete types.
2761 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Chris Lattnerf742eb02011-07-10 00:18:59 +00002762 if (!CGM.getTypes().isFuncTypeConvertible(
2763 cast<FunctionType>(MD->getType().getTypePtr())))
Anders Carlsson14e82fd2011-02-06 18:31:40 +00002764 return;
2765
2766 EmitThunk(GD, Thunk, /*UseAvailableExternallyLinkage=*/true);
Anders Carlssonfbf6ed42010-03-23 16:36:50 +00002767}
2768
Anders Carlssonee5ab9f2010-03-23 04:59:02 +00002769void CodeGenVTables::EmitThunks(GlobalDecl GD)
2770{
Anders Carlssonfbf6ed42010-03-23 16:36:50 +00002771 const CXXMethodDecl *MD =
2772 cast<CXXMethodDecl>(GD.getDecl())->getCanonicalDecl();
2773
2774 // We don't need to generate thunks for the base destructor.
2775 if (isa<CXXDestructorDecl>(MD) && GD.getDtorType() == Dtor_Base)
2776 return;
2777
Peter Collingbourne84fcc482011-09-26 01:56:41 +00002778 const VTableContext::ThunkInfoVectorTy *ThunkInfoVector =
2779 VTContext.getThunkInfo(MD);
2780 if (!ThunkInfoVector)
Anders Carlssonccd83d72010-03-24 16:42:11 +00002781 return;
Anders Carlssonccd83d72010-03-24 16:42:11 +00002782
Peter Collingbourne84fcc482011-09-26 01:56:41 +00002783 for (unsigned I = 0, E = ThunkInfoVector->size(); I != E; ++I)
2784 EmitThunk(GD, (*ThunkInfoVector)[I],
2785 /*UseAvailableExternallyLinkage=*/false);
Anders Carlssonee5ab9f2010-03-23 04:59:02 +00002786}
2787
Peter Collingbourne84fcc482011-09-26 01:56:41 +00002788void VTableContext::ComputeVTableRelatedInformation(const CXXRecordDecl *RD) {
Peter Collingbournebf1c5ae2011-09-26 01:56:36 +00002789 uint64_t *&Entry = VTableLayoutMap[RD];
Douglas Gregor6fb745b2010-05-13 16:44:06 +00002790
John McCalle2132352010-06-02 21:22:02 +00002791 // Check if we've computed this information before.
Peter Collingbournebf1c5ae2011-09-26 01:56:36 +00002792 if (Entry)
John McCalle2132352010-06-02 21:22:02 +00002793 return;
Douglas Gregor6fb745b2010-05-13 16:44:06 +00002794
Peter Collingbourne84fcc482011-09-26 01:56:41 +00002795 VTableBuilder Builder(*this, RD, CharUnits::Zero(),
Ken Dyck23da84a2011-03-27 20:20:28 +00002796 /*MostDerivedClassIsVirtual=*/0, RD);
Anders Carlssonccd83d72010-03-24 16:42:11 +00002797
2798 // Add the VTable layout.
2799 uint64_t NumVTableComponents = Builder.getNumVTableComponents();
Fariborz Jahaniana50e33e2011-01-28 23:42:29 +00002800 // -fapple-kext adds an extra entry at end of vtbl.
Peter Collingbourne84fcc482011-09-26 01:56:41 +00002801 bool IsAppleKext = Context.getLangOptions().AppleKext;
Fariborz Jahaniana50e33e2011-01-28 23:42:29 +00002802 if (IsAppleKext)
2803 NumVTableComponents += 1;
2804
John McCalle2132352010-06-02 21:22:02 +00002805 uint64_t *LayoutData = new uint64_t[NumVTableComponents + 1];
Fariborz Jahaniana50e33e2011-01-28 23:42:29 +00002806 if (IsAppleKext)
2807 LayoutData[NumVTableComponents] = 0;
Peter Collingbournebf1c5ae2011-09-26 01:56:36 +00002808 Entry = LayoutData;
Anders Carlssonccd83d72010-03-24 16:42:11 +00002809
2810 // Store the number of components.
2811 LayoutData[0] = NumVTableComponents;
2812
2813 // Store the components.
2814 std::copy(Builder.vtable_components_data_begin(),
2815 Builder.vtable_components_data_end(),
2816 &LayoutData[1]);
2817
2818 // Add the known thunks.
2819 Thunks.insert(Builder.thunks_begin(), Builder.thunks_end());
2820
Anders Carlsson276701f2010-03-29 01:38:05 +00002821 // Add the thunks needed in this vtable.
2822 assert(!VTableThunksMap.count(RD) &&
2823 "Thunks already exists for this vtable!");
2824
2825 VTableThunksTy &VTableThunks = VTableThunksMap[RD];
2826 VTableThunks.append(Builder.vtable_thunks_begin(),
2827 Builder.vtable_thunks_end());
2828
2829 // Sort them.
2830 std::sort(VTableThunks.begin(), VTableThunks.end());
2831
Anders Carlsson66d567d2010-03-25 00:51:13 +00002832 // Add the address points.
Anders Carlsson94464812010-04-10 19:13:06 +00002833 for (VTableBuilder::AddressPointsMapTy::const_iterator I =
Anders Carlsson66d567d2010-03-25 00:51:13 +00002834 Builder.address_points_begin(), E = Builder.address_points_end();
2835 I != E; ++I) {
2836
2837 uint64_t &AddressPoint = AddressPoints[std::make_pair(RD, I->first)];
2838
2839 // Check if we already have the address points for this base.
2840 assert(!AddressPoint && "Address point already exists for this base!");
2841
2842 AddressPoint = I->second;
2843 }
2844
Anders Carlssonccd83d72010-03-24 16:42:11 +00002845 // If we don't have the vbase information for this class, insert it.
2846 // getVirtualBaseOffsetOffset will compute it separately without computing
2847 // the rest of the vtable related information.
2848 if (!RD->getNumVBases())
2849 return;
2850
2851 const RecordType *VBaseRT =
2852 RD->vbases_begin()->getType()->getAs<RecordType>();
2853 const CXXRecordDecl *VBase = cast<CXXRecordDecl>(VBaseRT->getDecl());
2854
Peter Collingbourne84fcc482011-09-26 01:56:41 +00002855 if (VirtualBaseClassOffsetOffsets.count(std::make_pair(RD, VBase)))
Anders Carlssonccd83d72010-03-24 16:42:11 +00002856 return;
2857
Anders Carlsson94464812010-04-10 19:13:06 +00002858 for (VTableBuilder::VBaseOffsetOffsetsMapTy::const_iterator I =
Anders Carlssonccd83d72010-03-24 16:42:11 +00002859 Builder.getVBaseOffsetOffsets().begin(),
2860 E = Builder.getVBaseOffsetOffsets().end(); I != E; ++I) {
2861 // Insert all types.
Peter Collingbourne84fcc482011-09-26 01:56:41 +00002862 ClassPairTy ClassPair(RD, I->first);
Anders Carlssonccd83d72010-03-24 16:42:11 +00002863
Peter Collingbourne84fcc482011-09-26 01:56:41 +00002864 VirtualBaseClassOffsetOffsets.insert(std::make_pair(ClassPair, I->second));
Anders Carlssonccd83d72010-03-24 16:42:11 +00002865 }
2866}
2867
Anders Carlsson0d1407e2010-03-25 15:26:28 +00002868llvm::Constant *
2869CodeGenVTables::CreateVTableInitializer(const CXXRecordDecl *RD,
2870 const uint64_t *Components,
2871 unsigned NumComponents,
Peter Collingbourne84fcc482011-09-26 01:56:41 +00002872 const VTableContext::VTableThunksTy &VTableThunks) {
Chris Lattner5f9e2722011-07-23 10:55:15 +00002873 SmallVector<llvm::Constant *, 64> Inits;
Anders Carlsson0d1407e2010-03-25 15:26:28 +00002874
Chris Lattner2acc6e32011-07-18 04:24:23 +00002875 llvm::Type *Int8PtrTy = llvm::Type::getInt8PtrTy(CGM.getLLVMContext());
Anders Carlsson0d1407e2010-03-25 15:26:28 +00002876
Chris Lattner2acc6e32011-07-18 04:24:23 +00002877 llvm::Type *PtrDiffTy =
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002878 CGM.getTypes().ConvertType(CGM.getContext().getPointerDiffType());
2879
2880 QualType ClassType = CGM.getContext().getTagDeclType(RD);
2881 llvm::Constant *RTTI = CGM.GetAddrOfRTTIDescriptor(ClassType);
2882
2883 unsigned NextVTableThunkIndex = 0;
2884
Anders Carlsson67d568a2010-03-29 05:40:50 +00002885 llvm::Constant* PureVirtualFn = 0;
2886
Anders Carlsson0d1407e2010-03-25 15:26:28 +00002887 for (unsigned I = 0; I != NumComponents; ++I) {
Anders Carlsson94464812010-04-10 19:13:06 +00002888 VTableComponent Component =
2889 VTableComponent::getFromOpaqueInteger(Components[I]);
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002890
2891 llvm::Constant *Init = 0;
2892
2893 switch (Component.getKind()) {
Anders Carlsson94464812010-04-10 19:13:06 +00002894 case VTableComponent::CK_VCallOffset:
Ken Dyckc40a3fd2011-04-02 01:14:48 +00002895 Init = llvm::ConstantInt::get(PtrDiffTy,
2896 Component.getVCallOffset().getQuantity());
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002897 Init = llvm::ConstantExpr::getIntToPtr(Init, Int8PtrTy);
2898 break;
Anders Carlsson94464812010-04-10 19:13:06 +00002899 case VTableComponent::CK_VBaseOffset:
Ken Dyckc40a3fd2011-04-02 01:14:48 +00002900 Init = llvm::ConstantInt::get(PtrDiffTy,
2901 Component.getVBaseOffset().getQuantity());
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002902 Init = llvm::ConstantExpr::getIntToPtr(Init, Int8PtrTy);
2903 break;
Anders Carlsson94464812010-04-10 19:13:06 +00002904 case VTableComponent::CK_OffsetToTop:
Ken Dyckc40a3fd2011-04-02 01:14:48 +00002905 Init = llvm::ConstantInt::get(PtrDiffTy,
2906 Component.getOffsetToTop().getQuantity());
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002907 Init = llvm::ConstantExpr::getIntToPtr(Init, Int8PtrTy);
2908 break;
Anders Carlsson94464812010-04-10 19:13:06 +00002909 case VTableComponent::CK_RTTI:
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002910 Init = llvm::ConstantExpr::getBitCast(RTTI, Int8PtrTy);
2911 break;
Anders Carlsson94464812010-04-10 19:13:06 +00002912 case VTableComponent::CK_FunctionPointer:
2913 case VTableComponent::CK_CompleteDtorPointer:
2914 case VTableComponent::CK_DeletingDtorPointer: {
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002915 GlobalDecl GD;
2916
2917 // Get the right global decl.
2918 switch (Component.getKind()) {
2919 default:
2920 llvm_unreachable("Unexpected vtable component kind");
Anders Carlsson94464812010-04-10 19:13:06 +00002921 case VTableComponent::CK_FunctionPointer:
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002922 GD = Component.getFunctionDecl();
2923 break;
Anders Carlsson94464812010-04-10 19:13:06 +00002924 case VTableComponent::CK_CompleteDtorPointer:
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002925 GD = GlobalDecl(Component.getDestructorDecl(), Dtor_Complete);
2926 break;
Anders Carlsson94464812010-04-10 19:13:06 +00002927 case VTableComponent::CK_DeletingDtorPointer:
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002928 GD = GlobalDecl(Component.getDestructorDecl(), Dtor_Deleting);
2929 break;
2930 }
2931
Anders Carlsson67d568a2010-03-29 05:40:50 +00002932 if (cast<CXXMethodDecl>(GD.getDecl())->isPure()) {
2933 // We have a pure virtual member function.
2934 if (!PureVirtualFn) {
Chris Lattner2acc6e32011-07-18 04:24:23 +00002935 llvm::FunctionType *Ty =
Anders Carlsson67d568a2010-03-29 05:40:50 +00002936 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2937 /*isVarArg=*/false);
2938 PureVirtualFn =
2939 CGM.CreateRuntimeFunction(Ty, "__cxa_pure_virtual");
2940 PureVirtualFn = llvm::ConstantExpr::getBitCast(PureVirtualFn,
2941 Int8PtrTy);
2942 }
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002943
Anders Carlsson67d568a2010-03-29 05:40:50 +00002944 Init = PureVirtualFn;
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002945 } else {
Anders Carlsson67d568a2010-03-29 05:40:50 +00002946 // Check if we should use a thunk.
2947 if (NextVTableThunkIndex < VTableThunks.size() &&
2948 VTableThunks[NextVTableThunkIndex].first == I) {
2949 const ThunkInfo &Thunk = VTableThunks[NextVTableThunkIndex].second;
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002950
Anders Carlsson84c49e42011-02-06 17:15:43 +00002951 Init = CGM.GetAddrOfThunk(GD, Thunk);
Anders Carlsson14e82fd2011-02-06 18:31:40 +00002952 MaybeEmitThunkAvailableExternally(GD, Thunk);
2953
Anders Carlsson67d568a2010-03-29 05:40:50 +00002954 NextVTableThunkIndex++;
2955 } else {
Chris Lattner2acc6e32011-07-18 04:24:23 +00002956 llvm::Type *Ty = CGM.getTypes().GetFunctionTypeForVTable(GD);
Anders Carlsson67d568a2010-03-29 05:40:50 +00002957
Anders Carlsson1faa89f2011-02-05 04:35:53 +00002958 Init = CGM.GetAddrOfFunction(GD, Ty, /*ForVTable=*/true);
Anders Carlsson67d568a2010-03-29 05:40:50 +00002959 }
2960
2961 Init = llvm::ConstantExpr::getBitCast(Init, Int8PtrTy);
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002962 }
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002963 break;
2964 }
2965
Anders Carlsson94464812010-04-10 19:13:06 +00002966 case VTableComponent::CK_UnusedFunctionPointer:
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002967 Init = llvm::ConstantExpr::getNullValue(Int8PtrTy);
2968 break;
2969 };
Anders Carlsson0d1407e2010-03-25 15:26:28 +00002970
2971 Inits.push_back(Init);
2972 }
2973
2974 llvm::ArrayType *ArrayType = llvm::ArrayType::get(Int8PtrTy, NumComponents);
Jay Foad97357602011-06-22 09:24:39 +00002975 return llvm::ConstantArray::get(ArrayType, Inits);
Anders Carlsson0d1407e2010-03-25 15:26:28 +00002976}
2977
Anders Carlsson9dc338a2010-03-30 03:35:35 +00002978llvm::GlobalVariable *CodeGenVTables::GetAddrOfVTable(const CXXRecordDecl *RD) {
Peter Collingbournebf1c5ae2011-09-26 01:56:36 +00002979 llvm::GlobalVariable *&VTable = VTables[RD];
2980 if (VTable)
2981 return VTable;
2982
2983 // We may need to generate a definition for this vtable.
2984 if (ShouldEmitVTableInThisTU(RD))
2985 CGM.DeferredVTables.push_back(RD);
2986
Anders Carlsson5c6c1d92010-03-24 03:57:14 +00002987 llvm::SmallString<256> OutName;
Rafael Espindolaf0be9792011-02-11 02:52:17 +00002988 llvm::raw_svector_ostream Out(OutName);
2989 CGM.getCXXABI().getMangleContext().mangleCXXVTable(RD, Out);
2990 Out.flush();
Chris Lattner5f9e2722011-07-23 10:55:15 +00002991 StringRef Name = OutName.str();
Mike Stump85615df2009-11-19 04:04:36 +00002992
Chris Lattner2acc6e32011-07-18 04:24:23 +00002993 llvm::Type *Int8PtrTy = llvm::Type::getInt8PtrTy(CGM.getLLVMContext());
Anders Carlssonccd83d72010-03-24 16:42:11 +00002994 llvm::ArrayType *ArrayType =
Peter Collingbourne84fcc482011-09-26 01:56:41 +00002995 llvm::ArrayType::get(Int8PtrTy, VTContext.getNumVTableComponents(RD));
Anders Carlssona7cde3b2010-03-29 03:38:52 +00002996
Peter Collingbournebf1c5ae2011-09-26 01:56:36 +00002997 VTable =
Anders Carlsson96eaf292011-01-29 18:25:07 +00002998 CGM.CreateOrReplaceCXXRuntimeVariable(Name, ArrayType,
2999 llvm::GlobalValue::ExternalLinkage);
Peter Collingbournebf1c5ae2011-09-26 01:56:36 +00003000 VTable->setUnnamedAddr(true);
3001 return VTable;
Mike Stump380dd752009-11-10 07:44:33 +00003002}
Mike Stump8cfcb522009-11-11 20:26:26 +00003003
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003004void
3005CodeGenVTables::EmitVTableDefinition(llvm::GlobalVariable *VTable,
3006 llvm::GlobalVariable::LinkageTypes Linkage,
3007 const CXXRecordDecl *RD) {
3008 // Dump the vtable layout if necessary.
Anders Carlsson046c2942010-04-17 20:15:18 +00003009 if (CGM.getLangOptions().DumpVTableLayouts) {
Peter Collingbourne1d2b3172011-09-26 01:56:30 +00003010 VTableBuilder Builder(VTContext, RD, CharUnits::Zero(),
Ken Dyck23da84a2011-03-27 20:20:28 +00003011 /*MostDerivedClassIsVirtual=*/0, RD);
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003012
3013 Builder.dumpLayout(llvm::errs());
3014 }
3015
Peter Collingbourne84fcc482011-09-26 01:56:41 +00003016 const VTableContext::VTableThunksTy& Thunks = VTContext.getVTableThunks(RD);
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003017
3018 // Create and set the initializer.
3019 llvm::Constant *Init =
Peter Collingbourne84fcc482011-09-26 01:56:41 +00003020 CreateVTableInitializer(RD, VTContext.getVTableComponentsData(RD),
3021 VTContext.getNumVTableComponents(RD), Thunks);
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003022 VTable->setInitializer(Init);
Anders Carlsson67d568a2010-03-29 05:40:50 +00003023
3024 // Set the correct linkage.
3025 VTable->setLinkage(Linkage);
Douglas Gregorc66bcfd2010-06-14 23:41:45 +00003026
3027 // Set the right visibility.
Anders Carlssonfa2e99f2011-01-29 20:24:48 +00003028 CGM.setTypeVisibility(VTable, RD, CodeGenModule::TVK_ForVTable);
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003029}
3030
Anders Carlssonff143f82010-03-25 00:35:49 +00003031llvm::GlobalVariable *
3032CodeGenVTables::GenerateConstructionVTable(const CXXRecordDecl *RD,
Anders Carlsson2c822f12010-03-26 03:56:54 +00003033 const BaseSubobject &Base,
3034 bool BaseIsVirtual,
John McCallbda0d6b2011-03-27 09:00:25 +00003035 llvm::GlobalVariable::LinkageTypes Linkage,
Anders Carlsson2c822f12010-03-26 03:56:54 +00003036 VTableAddressPointsMapTy& AddressPoints) {
Peter Collingbourne1d2b3172011-09-26 01:56:30 +00003037 VTableBuilder Builder(VTContext, Base.getBase(),
Ken Dyck23da84a2011-03-27 20:20:28 +00003038 Base.getBaseOffset(),
Anders Carlsson0d1407e2010-03-25 15:26:28 +00003039 /*MostDerivedClassIsVirtual=*/BaseIsVirtual, RD);
3040
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00003041 // Dump the vtable layout if necessary.
Anders Carlsson046c2942010-04-17 20:15:18 +00003042 if (CGM.getLangOptions().DumpVTableLayouts)
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00003043 Builder.dumpLayout(llvm::errs());
3044
3045 // Add the address points.
Anders Carlsson2c822f12010-03-26 03:56:54 +00003046 AddressPoints.insert(Builder.address_points_begin(),
3047 Builder.address_points_end());
Anders Carlsson0d1407e2010-03-25 15:26:28 +00003048
3049 // Get the mangled construction vtable name.
3050 llvm::SmallString<256> OutName;
Rafael Espindolaf0be9792011-02-11 02:52:17 +00003051 llvm::raw_svector_ostream Out(OutName);
John McCall4c40d982010-08-31 07:33:07 +00003052 CGM.getCXXABI().getMangleContext().
Ken Dyck4230d522011-03-24 01:21:01 +00003053 mangleCXXCtorVTable(RD, Base.getBaseOffset().getQuantity(), Base.getBase(),
3054 Out);
Rafael Espindolaf0be9792011-02-11 02:52:17 +00003055 Out.flush();
Chris Lattner5f9e2722011-07-23 10:55:15 +00003056 StringRef Name = OutName.str();
Anders Carlsson0d1407e2010-03-25 15:26:28 +00003057
Chris Lattner2acc6e32011-07-18 04:24:23 +00003058 llvm::Type *Int8PtrTy = llvm::Type::getInt8PtrTy(CGM.getLLVMContext());
Anders Carlsson0d1407e2010-03-25 15:26:28 +00003059 llvm::ArrayType *ArrayType =
3060 llvm::ArrayType::get(Int8PtrTy, Builder.getNumVTableComponents());
3061
3062 // Create the variable that will hold the construction vtable.
3063 llvm::GlobalVariable *VTable =
John McCallbda0d6b2011-03-27 09:00:25 +00003064 CGM.CreateOrReplaceCXXRuntimeVariable(Name, ArrayType, Linkage);
3065 CGM.setTypeVisibility(VTable, RD, CodeGenModule::TVK_ForConstructionVTable);
3066
3067 // V-tables are always unnamed_addr.
3068 VTable->setUnnamedAddr(true);
Anders Carlsson0d1407e2010-03-25 15:26:28 +00003069
3070 // Add the thunks.
Peter Collingbourne84fcc482011-09-26 01:56:41 +00003071 VTableContext::VTableThunksTy VTableThunks;
Anders Carlsson0d1407e2010-03-25 15:26:28 +00003072 VTableThunks.append(Builder.vtable_thunks_begin(),
3073 Builder.vtable_thunks_end());
3074
Anders Carlssonaed924e2010-03-29 01:28:05 +00003075 // Sort them.
3076 std::sort(VTableThunks.begin(), VTableThunks.end());
3077
Anders Carlsson0d1407e2010-03-25 15:26:28 +00003078 // Create and set the initializer.
3079 llvm::Constant *Init =
3080 CreateVTableInitializer(Base.getBase(),
3081 Builder.vtable_components_data_begin(),
3082 Builder.getNumVTableComponents(), VTableThunks);
3083 VTable->setInitializer(Init);
3084
Anders Carlssonff143f82010-03-25 00:35:49 +00003085 return VTable;
3086}
3087
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003088void
3089CodeGenVTables::GenerateClassData(llvm::GlobalVariable::LinkageTypes Linkage,
3090 const CXXRecordDecl *RD) {
Peter Collingbournebf1c5ae2011-09-26 01:56:36 +00003091 llvm::GlobalVariable *VTable = GetAddrOfVTable(RD);
3092 if (VTable->hasInitializer())
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003093 return;
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003094
Anders Carlsson9dc338a2010-03-30 03:35:35 +00003095 EmitVTableDefinition(VTable, Linkage, RD);
3096
Anders Carlsson1cbce122011-01-29 19:16:51 +00003097 if (RD->getNumVBases()) {
3098 llvm::GlobalVariable *VTT = GetAddrOfVTT(RD);
3099 EmitVTTDefinition(VTT, Linkage, RD);
3100 }
Douglas Gregor1e201b42010-04-08 15:52:03 +00003101
3102 // If this is the magic class __cxxabiv1::__fundamental_type_info,
3103 // we will emit the typeinfo for the fundamental types. This is the
3104 // same behaviour as GCC.
3105 const DeclContext *DC = RD->getDeclContext();
3106 if (RD->getIdentifier() &&
3107 RD->getIdentifier()->isStr("__fundamental_type_info") &&
3108 isa<NamespaceDecl>(DC) &&
3109 cast<NamespaceDecl>(DC)->getIdentifier() &&
3110 cast<NamespaceDecl>(DC)->getIdentifier()->isStr("__cxxabiv1") &&
3111 DC->getParent()->isTranslationUnit())
3112 CGM.EmitFundamentalRTTIDescriptors();
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003113}