blob: c753ce20a850f110c0ca46da8b416f8943879e40 [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();
Peter Collingbourne9984d122011-09-26 01:57:00 +00001003
1004 if (Context.getLangOptions().DumpVTableLayouts)
1005 dumpLayout(llvm::errs());
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001006 }
1007
Peter Collingbournee09cdf42011-09-26 01:56:50 +00001008 uint64_t getNumThunks() const {
1009 return Thunks.size();
1010 }
1011
Anders Carlssonfbf6ed42010-03-23 16:36:50 +00001012 ThunksMapTy::const_iterator thunks_begin() const {
1013 return Thunks.begin();
1014 }
1015
1016 ThunksMapTy::const_iterator thunks_end() const {
1017 return Thunks.end();
1018 }
1019
Anders Carlssonccd83d72010-03-24 16:42:11 +00001020 const VBaseOffsetOffsetsMapTy &getVBaseOffsetOffsets() const {
1021 return VBaseOffsetOffsets;
1022 }
1023
Peter Collingbournee09cdf42011-09-26 01:56:50 +00001024 const AddressPointsMapTy &getAddressPoints() const {
1025 return AddressPoints;
1026 }
1027
Anders Carlssonccd83d72010-03-24 16:42:11 +00001028 /// getNumVTableComponents - Return the number of components in the vtable
1029 /// currently built.
1030 uint64_t getNumVTableComponents() const {
1031 return Components.size();
1032 }
1033
Peter Collingbournee09cdf42011-09-26 01:56:50 +00001034 const VTableComponent *vtable_component_begin() const {
1035 return Components.begin();
Anders Carlssonccd83d72010-03-24 16:42:11 +00001036 }
1037
Peter Collingbournee09cdf42011-09-26 01:56:50 +00001038 const VTableComponent *vtable_component_end() const {
1039 return Components.end();
Anders Carlssonccd83d72010-03-24 16:42:11 +00001040 }
1041
Anders Carlsson66d567d2010-03-25 00:51:13 +00001042 AddressPointsMapTy::const_iterator address_points_begin() const {
1043 return AddressPoints.begin();
1044 }
1045
1046 AddressPointsMapTy::const_iterator address_points_end() const {
1047 return AddressPoints.end();
1048 }
1049
Anders Carlsson718d0692010-04-11 22:07:06 +00001050 VTableThunksMapTy::const_iterator vtable_thunks_begin() const {
Anders Carlsson0d1407e2010-03-25 15:26:28 +00001051 return VTableThunks.begin();
1052 }
1053
Anders Carlsson718d0692010-04-11 22:07:06 +00001054 VTableThunksMapTy::const_iterator vtable_thunks_end() const {
Anders Carlsson0d1407e2010-03-25 15:26:28 +00001055 return VTableThunks.end();
1056 }
1057
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001058 /// dumpLayout - Dump the vtable layout.
Chris Lattner5f9e2722011-07-23 10:55:15 +00001059 void dumpLayout(raw_ostream&);
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001060};
1061
Anders Carlsson94464812010-04-10 19:13:06 +00001062void VTableBuilder::AddThunk(const CXXMethodDecl *MD, const ThunkInfo &Thunk) {
Anders Carlsson718d0692010-04-11 22:07:06 +00001063 assert(!isBuildingConstructorVTable() &&
Anders Carlssonbca5d372010-03-22 20:06:40 +00001064 "Can't add thunks for construction vtable");
Anders Carlsson9135a842010-03-18 02:44:19 +00001065
Chris Lattner5f9e2722011-07-23 10:55:15 +00001066 SmallVector<ThunkInfo, 1> &ThunksVector = Thunks[MD];
Anders Carlsson5e454aa2010-03-17 20:06:32 +00001067
1068 // Check if we have this thunk already.
1069 if (std::find(ThunksVector.begin(), ThunksVector.end(), Thunk) !=
1070 ThunksVector.end())
1071 return;
1072
1073 ThunksVector.push_back(Thunk);
1074}
1075
Anders Carlssonf622b452010-04-10 20:39:29 +00001076typedef llvm::SmallPtrSet<const CXXMethodDecl *, 8> OverriddenMethodsSetTy;
1077
1078/// ComputeAllOverriddenMethods - Given a method decl, will return a set of all
1079/// the overridden methods that the function decl overrides.
1080static void
1081ComputeAllOverriddenMethods(const CXXMethodDecl *MD,
1082 OverriddenMethodsSetTy& OverriddenMethods) {
1083 assert(MD->isVirtual() && "Method is not virtual!");
1084
Anders Carlsson57071e22010-02-12 05:25:12 +00001085 for (CXXMethodDecl::method_iterator I = MD->begin_overridden_methods(),
1086 E = MD->end_overridden_methods(); I != E; ++I) {
1087 const CXXMethodDecl *OverriddenMD = *I;
Anders Carlsson57071e22010-02-12 05:25:12 +00001088
Anders Carlssonf622b452010-04-10 20:39:29 +00001089 OverriddenMethods.insert(OverriddenMD);
1090
1091 ComputeAllOverriddenMethods(OverriddenMD, OverriddenMethods);
Anders Carlsson57071e22010-02-12 05:25:12 +00001092 }
Anders Carlsson57071e22010-02-12 05:25:12 +00001093}
1094
Anders Carlsson94464812010-04-10 19:13:06 +00001095void VTableBuilder::ComputeThisAdjustments() {
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001096 // Now go through the method info map and see if any of the methods need
1097 // 'this' pointer adjustments.
1098 for (MethodInfoMapTy::const_iterator I = MethodInfoMap.begin(),
1099 E = MethodInfoMap.end(); I != E; ++I) {
1100 const CXXMethodDecl *MD = I->first;
1101 const MethodInfo &MethodInfo = I->second;
1102
Anders Carlsson617def32010-03-12 05:28:07 +00001103 // Ignore adjustments for unused function pointers.
Anders Carlsson718d0692010-04-11 22:07:06 +00001104 uint64_t VTableIndex = MethodInfo.VTableIndex;
1105 if (Components[VTableIndex].getKind() ==
Anders Carlsson94464812010-04-10 19:13:06 +00001106 VTableComponent::CK_UnusedFunctionPointer)
Anders Carlsson617def32010-03-12 05:28:07 +00001107 continue;
1108
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001109 // Get the final overrider for this method.
1110 FinalOverriders::OverriderInfo Overrider =
Ken Dyck82abeae2011-03-27 18:57:53 +00001111 Overriders.getOverrider(MD, MethodInfo.BaseOffset);
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001112
Anders Carlssonbca5d372010-03-22 20:06:40 +00001113 // Check if we need an adjustment at all.
Ken Dyck82abeae2011-03-27 18:57:53 +00001114 if (MethodInfo.BaseOffsetInLayoutClass == Overrider.Offset) {
Anders Carlssonadb507d2010-03-29 15:08:41 +00001115 // When a return thunk is needed by a derived class that overrides a
1116 // virtual base, gcc uses a virtual 'this' adjustment as well.
1117 // While the thunk itself might be needed by vtables in subclasses or
1118 // in construction vtables, there doesn't seem to be a reason for using
1119 // the thunk in this vtable. Still, we do so to match gcc.
Anders Carlsson718d0692010-04-11 22:07:06 +00001120 if (VTableThunks.lookup(VTableIndex).Return.isEmpty())
Anders Carlssonadb507d2010-03-29 15:08:41 +00001121 continue;
1122 }
Anders Carlssonbca5d372010-03-22 20:06:40 +00001123
Anders Carlsson617def32010-03-12 05:28:07 +00001124 ThisAdjustment ThisAdjustment =
Ken Dyck0e55ade2011-03-27 19:03:44 +00001125 ComputeThisAdjustment(MD, MethodInfo.BaseOffsetInLayoutClass, Overrider);
Anders Carlsson617def32010-03-12 05:28:07 +00001126
1127 if (ThisAdjustment.isEmpty())
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001128 continue;
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001129
Anders Carlssoncd4e6372010-02-27 18:09:40 +00001130 // Add it.
Anders Carlsson718d0692010-04-11 22:07:06 +00001131 VTableThunks[VTableIndex].This = ThisAdjustment;
Anders Carlsson617def32010-03-12 05:28:07 +00001132
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001133 if (isa<CXXDestructorDecl>(MD)) {
1134 // Add an adjustment for the deleting destructor as well.
Anders Carlsson718d0692010-04-11 22:07:06 +00001135 VTableThunks[VTableIndex + 1].This = ThisAdjustment;
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001136 }
1137 }
1138
1139 /// Clear the method info map.
1140 MethodInfoMap.clear();
Anders Carlsson25394212010-03-22 15:47:01 +00001141
Anders Carlsson718d0692010-04-11 22:07:06 +00001142 if (isBuildingConstructorVTable()) {
Anders Carlsson25394212010-03-22 15:47:01 +00001143 // We don't need to store thunk information for construction vtables.
1144 return;
1145 }
1146
Anders Carlsson718d0692010-04-11 22:07:06 +00001147 for (VTableThunksMapTy::const_iterator I = VTableThunks.begin(),
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00001148 E = VTableThunks.end(); I != E; ++I) {
Anders Carlsson94464812010-04-10 19:13:06 +00001149 const VTableComponent &Component = Components[I->first];
Anders Carlsson25394212010-03-22 15:47:01 +00001150 const ThunkInfo &Thunk = I->second;
Anders Carlssonbca5d372010-03-22 20:06:40 +00001151 const CXXMethodDecl *MD;
Anders Carlsson25394212010-03-22 15:47:01 +00001152
1153 switch (Component.getKind()) {
1154 default:
1155 llvm_unreachable("Unexpected vtable component kind!");
Anders Carlsson94464812010-04-10 19:13:06 +00001156 case VTableComponent::CK_FunctionPointer:
Anders Carlssonbca5d372010-03-22 20:06:40 +00001157 MD = Component.getFunctionDecl();
Anders Carlsson25394212010-03-22 15:47:01 +00001158 break;
Anders Carlsson94464812010-04-10 19:13:06 +00001159 case VTableComponent::CK_CompleteDtorPointer:
Anders Carlssonbca5d372010-03-22 20:06:40 +00001160 MD = Component.getDestructorDecl();
Anders Carlsson25394212010-03-22 15:47:01 +00001161 break;
Anders Carlsson94464812010-04-10 19:13:06 +00001162 case VTableComponent::CK_DeletingDtorPointer:
Anders Carlsson25394212010-03-22 15:47:01 +00001163 // We've already added the thunk when we saw the complete dtor pointer.
Anders Carlssonbca5d372010-03-22 20:06:40 +00001164 continue;
Anders Carlsson25394212010-03-22 15:47:01 +00001165 }
Anders Carlssonbca5d372010-03-22 20:06:40 +00001166
1167 if (MD->getParent() == MostDerivedClass)
1168 AddThunk(MD, Thunk);
Anders Carlsson25394212010-03-22 15:47:01 +00001169 }
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001170}
1171
Anders Carlsson94464812010-04-10 19:13:06 +00001172ReturnAdjustment VTableBuilder::ComputeReturnAdjustment(BaseOffset Offset) {
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001173 ReturnAdjustment Adjustment;
1174
1175 if (!Offset.isEmpty()) {
Anders Carlsson60db0ee2010-02-13 21:07:32 +00001176 if (Offset.VirtualBase) {
1177 // Get the virtual base offset offset.
Anders Carlsson1972ced2010-03-11 07:00:45 +00001178 if (Offset.DerivedClass == MostDerivedClass) {
1179 // We can get the offset offset directly from our map.
1180 Adjustment.VBaseOffsetOffset =
Ken Dyckd28c33c2011-04-07 00:55:01 +00001181 VBaseOffsetOffsets.lookup(Offset.VirtualBase).getQuantity();
Anders Carlsson1972ced2010-03-11 07:00:45 +00001182 } else {
1183 Adjustment.VBaseOffsetOffset =
Anders Carlssonaf440352010-03-23 04:11:45 +00001184 VTables.getVirtualBaseOffsetOffset(Offset.DerivedClass,
Ken Dyck14c65ca2011-04-07 12:37:09 +00001185 Offset.VirtualBase).getQuantity();
Anders Carlsson1972ced2010-03-11 07:00:45 +00001186 }
Anders Carlsson60db0ee2010-02-13 21:07:32 +00001187 }
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001188
Ken Dyck396e4f62011-04-02 01:32:03 +00001189 Adjustment.NonVirtual = Offset.NonVirtualOffset.getQuantity();
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001190 }
1191
1192 return Adjustment;
1193}
1194
Anders Carlsson379017f2010-02-27 19:57:44 +00001195BaseOffset
Anders Carlsson94464812010-04-10 19:13:06 +00001196VTableBuilder::ComputeThisAdjustmentBaseOffset(BaseSubobject Base,
Anders Carlsson379017f2010-02-27 19:57:44 +00001197 BaseSubobject Derived) const {
1198 const CXXRecordDecl *BaseRD = Base.getBase();
1199 const CXXRecordDecl *DerivedRD = Derived.getBase();
1200
1201 CXXBasePaths Paths(/*FindAmbiguities=*/true,
1202 /*RecordPaths=*/true, /*DetectVirtual=*/true);
1203
1204 if (!const_cast<CXXRecordDecl *>(DerivedRD)->
1205 isDerivedFrom(const_cast<CXXRecordDecl *>(BaseRD), Paths)) {
David Blaikieb219cfc2011-09-23 05:06:16 +00001206 llvm_unreachable("Class must be derived from the passed in base class!");
Anders Carlsson379017f2010-02-27 19:57:44 +00001207 }
1208
1209 // We have to go through all the paths, and see which one leads us to the
1210 // right base subobject.
1211 for (CXXBasePaths::const_paths_iterator I = Paths.begin(), E = Paths.end();
1212 I != E; ++I) {
1213 BaseOffset Offset = ComputeBaseOffset(Context, DerivedRD, *I);
1214
Ken Dyck396e4f62011-04-02 01:32:03 +00001215 CharUnits OffsetToBaseSubobject = Offset.NonVirtualOffset;
Anders Carlsson379017f2010-02-27 19:57:44 +00001216
1217 if (Offset.VirtualBase) {
1218 // If we have a virtual base class, the non-virtual offset is relative
1219 // to the virtual base class offset.
Anders Carlsson2bc1d3a2010-03-10 21:25:37 +00001220 const ASTRecordLayout &LayoutClassLayout =
1221 Context.getASTRecordLayout(LayoutClass);
Anders Carlsson379017f2010-02-27 19:57:44 +00001222
1223 /// Get the virtual base offset, relative to the most derived class
1224 /// layout.
1225 OffsetToBaseSubobject +=
Ken Dyck57ebe332011-03-26 00:51:24 +00001226 LayoutClassLayout.getVBaseClassOffset(Offset.VirtualBase);
Anders Carlsson379017f2010-02-27 19:57:44 +00001227 } else {
1228 // Otherwise, the non-virtual offset is relative to the derived class
1229 // offset.
Ken Dyck57ebe332011-03-26 00:51:24 +00001230 OffsetToBaseSubobject += Derived.getBaseOffset();
Anders Carlsson379017f2010-02-27 19:57:44 +00001231 }
1232
1233 // Check if this path gives us the right base subobject.
Ken Dyck57ebe332011-03-26 00:51:24 +00001234 if (OffsetToBaseSubobject == Base.getBaseOffset()) {
Anders Carlsson379017f2010-02-27 19:57:44 +00001235 // Since we're going from the base class _to_ the derived class, we'll
1236 // invert the non-virtual offset here.
1237 Offset.NonVirtualOffset = -Offset.NonVirtualOffset;
1238 return Offset;
1239 }
1240 }
1241
1242 return BaseOffset();
1243}
1244
Anders Carlsson80d8d7d2010-03-23 15:13:06 +00001245ThisAdjustment
Anders Carlsson94464812010-04-10 19:13:06 +00001246VTableBuilder::ComputeThisAdjustment(const CXXMethodDecl *MD,
Ken Dyck0e55ade2011-03-27 19:03:44 +00001247 CharUnits BaseOffsetInLayoutClass,
Anders Carlsson617def32010-03-12 05:28:07 +00001248 FinalOverriders::OverriderInfo Overrider) {
Anders Carlsson617def32010-03-12 05:28:07 +00001249 // Ignore adjustments for pure virtual member functions.
1250 if (Overrider.Method->isPure())
1251 return ThisAdjustment();
1252
Ken Dyck0e55ade2011-03-27 19:03:44 +00001253 BaseSubobject OverriddenBaseSubobject(MD->getParent(),
1254 BaseOffsetInLayoutClass);
Anders Carlsson617def32010-03-12 05:28:07 +00001255
1256 BaseSubobject OverriderBaseSubobject(Overrider.Method->getParent(),
Ken Dyck17d85192011-03-26 01:29:16 +00001257 Overrider.Offset);
Anders Carlsson617def32010-03-12 05:28:07 +00001258
1259 // Compute the adjustment offset.
1260 BaseOffset Offset = ComputeThisAdjustmentBaseOffset(OverriddenBaseSubobject,
1261 OverriderBaseSubobject);
1262 if (Offset.isEmpty())
1263 return ThisAdjustment();
1264
Anders Carlsson49bac9a2010-02-13 23:40:17 +00001265 ThisAdjustment Adjustment;
1266
Anders Carlsson617def32010-03-12 05:28:07 +00001267 if (Offset.VirtualBase) {
1268 // Get the vcall offset map for this virtual base.
1269 VCallOffsetMap &VCallOffsets = VCallOffsetsForVBases[Offset.VirtualBase];
Anders Carlssoneb577d02010-02-18 17:26:40 +00001270
Anders Carlsson617def32010-03-12 05:28:07 +00001271 if (VCallOffsets.empty()) {
1272 // We don't have vcall offsets for this virtual base, go ahead and
1273 // build them.
1274 VCallAndVBaseOffsetBuilder Builder(MostDerivedClass, MostDerivedClass,
1275 /*FinalOverriders=*/0,
Ken Dyck4230d522011-03-24 01:21:01 +00001276 BaseSubobject(Offset.VirtualBase,
1277 CharUnits::Zero()),
Anders Carlsson617def32010-03-12 05:28:07 +00001278 /*BaseIsVirtual=*/true,
Ken Dyck3ecfa2d2011-03-31 00:48:04 +00001279 /*OffsetInLayoutClass=*/
1280 CharUnits::Zero());
Anders Carlsson617def32010-03-12 05:28:07 +00001281
1282 VCallOffsets = Builder.getVCallOffsets();
1283 }
1284
Ken Dyckc952d382011-04-02 00:51:15 +00001285 Adjustment.VCallOffsetOffset =
1286 VCallOffsets.getVCallOffsetOffset(MD).getQuantity();
Anders Carlsson49bac9a2010-02-13 23:40:17 +00001287 }
Anders Carlsson617def32010-03-12 05:28:07 +00001288
1289 // Set the non-virtual part of the adjustment.
Ken Dyck396e4f62011-04-02 01:32:03 +00001290 Adjustment.NonVirtual = Offset.NonVirtualOffset.getQuantity();
Anders Carlsson49bac9a2010-02-13 23:40:17 +00001291
1292 return Adjustment;
1293}
Anders Carlsson617def32010-03-12 05:28:07 +00001294
Anders Carlsson57071e22010-02-12 05:25:12 +00001295void
Anders Carlsson94464812010-04-10 19:13:06 +00001296VTableBuilder::AddMethod(const CXXMethodDecl *MD,
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001297 ReturnAdjustment ReturnAdjustment) {
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001298 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1299 assert(ReturnAdjustment.isEmpty() &&
1300 "Destructor can't have return adjustment!");
Anders Carlsson49bac9a2010-02-13 23:40:17 +00001301
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001302 // Add both the complete destructor and the deleting destructor.
Anders Carlsson94464812010-04-10 19:13:06 +00001303 Components.push_back(VTableComponent::MakeCompleteDtor(DD));
1304 Components.push_back(VTableComponent::MakeDeletingDtor(DD));
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001305 } else {
1306 // Add the return adjustment if necessary.
1307 if (!ReturnAdjustment.isEmpty())
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00001308 VTableThunks[Components.size()].Return = ReturnAdjustment;
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001309
1310 // Add the function.
Anders Carlsson94464812010-04-10 19:13:06 +00001311 Components.push_back(VTableComponent::MakeFunction(MD));
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001312 }
1313}
1314
Anders Carlssonc784ba22010-02-27 06:38:03 +00001315/// OverridesIndirectMethodInBase - Return whether the given member function
1316/// overrides any methods in the set of given bases.
1317/// Unlike OverridesMethodInBase, this checks "overriders of overriders".
1318/// For example, if we have:
1319///
1320/// struct A { virtual void f(); }
1321/// struct B : A { virtual void f(); }
1322/// struct C : B { virtual void f(); }
1323///
1324/// OverridesIndirectMethodInBase will return true if given C::f as the method
Anders Carlssonf622b452010-04-10 20:39:29 +00001325/// and { A } as the set of bases.
Anders Carlssonc784ba22010-02-27 06:38:03 +00001326static bool
1327OverridesIndirectMethodInBases(const CXXMethodDecl *MD,
Anders Carlsson94464812010-04-10 19:13:06 +00001328 VTableBuilder::PrimaryBasesSetVectorTy &Bases) {
Anders Carlssonfbf05612010-04-17 17:24:33 +00001329 if (Bases.count(MD->getParent()))
1330 return true;
1331
Anders Carlssonc784ba22010-02-27 06:38:03 +00001332 for (CXXMethodDecl::method_iterator I = MD->begin_overridden_methods(),
1333 E = MD->end_overridden_methods(); I != E; ++I) {
1334 const CXXMethodDecl *OverriddenMD = *I;
Anders Carlssonc784ba22010-02-27 06:38:03 +00001335
1336 // Check "indirect overriders".
1337 if (OverridesIndirectMethodInBases(OverriddenMD, Bases))
1338 return true;
1339 }
1340
1341 return false;
1342}
1343
Anders Carlsson464c8f12010-02-23 04:26:39 +00001344bool
Anders Carlsson94464812010-04-10 19:13:06 +00001345VTableBuilder::IsOverriderUsed(const CXXMethodDecl *Overrider,
Ken Dyck413e7d22011-04-02 00:44:58 +00001346 CharUnits BaseOffsetInLayoutClass,
Anders Carlsson60396612010-03-10 06:51:42 +00001347 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
Ken Dyck413e7d22011-04-02 00:44:58 +00001348 CharUnits FirstBaseOffsetInLayoutClass) const {
Anders Carlsson464c8f12010-02-23 04:26:39 +00001349 // If the base and the first base in the primary base chain have the same
1350 // offsets, then this overrider will be used.
Anders Carlsson60396612010-03-10 06:51:42 +00001351 if (BaseOffsetInLayoutClass == FirstBaseOffsetInLayoutClass)
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001352 return true;
1353
1354 // We know now that Base (or a direct or indirect base of it) is a primary
1355 // base in part of the class hierarchy, but not a primary base in the most
1356 // derived class.
1357
1358 // If the overrider is the first base in the primary base chain, we know
1359 // that the overrider will be used.
Anders Carlsson60396612010-03-10 06:51:42 +00001360 if (Overrider->getParent() == FirstBaseInPrimaryBaseChain)
Anders Carlsson464c8f12010-02-23 04:26:39 +00001361 return true;
1362
Anders Carlsson94464812010-04-10 19:13:06 +00001363 VTableBuilder::PrimaryBasesSetVectorTy PrimaryBases;
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001364
Anders Carlsson60396612010-03-10 06:51:42 +00001365 const CXXRecordDecl *RD = FirstBaseInPrimaryBaseChain;
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001366 PrimaryBases.insert(RD);
1367
1368 // Now traverse the base chain, starting with the first base, until we find
1369 // the base that is no longer a primary base.
1370 while (true) {
1371 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1372 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
1373
1374 if (!PrimaryBase)
1375 break;
1376
Anders Carlssonc9e814b2010-11-24 23:12:57 +00001377 if (Layout.isPrimaryBaseVirtual()) {
Anders Carlssona14f5972010-10-31 23:22:37 +00001378 assert(Layout.getVBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001379 "Primary base should always be at offset 0!");
1380
Anders Carlssondad0f992010-02-28 18:37:33 +00001381 const ASTRecordLayout &LayoutClassLayout =
1382 Context.getASTRecordLayout(LayoutClass);
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001383
1384 // Now check if this is the primary base that is not a primary base in the
1385 // most derived class.
Ken Dyck413e7d22011-04-02 00:44:58 +00001386 if (LayoutClassLayout.getVBaseClassOffset(PrimaryBase) !=
Anders Carlsson60396612010-03-10 06:51:42 +00001387 FirstBaseOffsetInLayoutClass) {
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001388 // We found it, stop walking the chain.
1389 break;
1390 }
1391 } else {
Anders Carlssona14f5972010-10-31 23:22:37 +00001392 assert(Layout.getBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001393 "Primary base should always be at offset 0!");
1394 }
Anders Carlssoncd4e6372010-02-27 18:09:40 +00001395
Anders Carlssonf89bb6c2010-02-27 19:51:04 +00001396 if (!PrimaryBases.insert(PrimaryBase))
David Blaikieb219cfc2011-09-23 05:06:16 +00001397 llvm_unreachable("Found a duplicate primary base!");
Anders Carlssonf89bb6c2010-02-27 19:51:04 +00001398
Anders Carlssoncd4e6372010-02-27 18:09:40 +00001399 RD = PrimaryBase;
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001400 }
1401
1402 // If the final overrider is an override of one of the primary bases,
1403 // then we know that it will be used.
Anders Carlsson60396612010-03-10 06:51:42 +00001404 return OverridesIndirectMethodInBases(Overrider, PrimaryBases);
Anders Carlsson464c8f12010-02-23 04:26:39 +00001405}
1406
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001407/// FindNearestOverriddenMethod - Given a method, returns the overridden method
1408/// from the nearest base. Returns null if no method was found.
1409static const CXXMethodDecl *
1410FindNearestOverriddenMethod(const CXXMethodDecl *MD,
Anders Carlsson94464812010-04-10 19:13:06 +00001411 VTableBuilder::PrimaryBasesSetVectorTy &Bases) {
Anders Carlssonf622b452010-04-10 20:39:29 +00001412 OverriddenMethodsSetTy OverriddenMethods;
1413 ComputeAllOverriddenMethods(MD, OverriddenMethods);
1414
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001415 for (int I = Bases.size(), E = 0; I != E; --I) {
1416 const CXXRecordDecl *PrimaryBase = Bases[I - 1];
1417
1418 // Now check the overriden methods.
Anders Carlssonf622b452010-04-10 20:39:29 +00001419 for (OverriddenMethodsSetTy::const_iterator I = OverriddenMethods.begin(),
1420 E = OverriddenMethods.end(); I != E; ++I) {
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001421 const CXXMethodDecl *OverriddenMD = *I;
Anders Carlssonf622b452010-04-10 20:39:29 +00001422
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001423 // We found our overridden method.
1424 if (OverriddenMD->getParent() == PrimaryBase)
1425 return OverriddenMD;
1426 }
1427 }
1428
1429 return 0;
1430}
1431
Anders Carlsson60396612010-03-10 06:51:42 +00001432void
Ken Dyck3a726802011-03-27 19:15:11 +00001433VTableBuilder::AddMethods(BaseSubobject Base, CharUnits BaseOffsetInLayoutClass,
Anders Carlsson60396612010-03-10 06:51:42 +00001434 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
Ken Dyck3a726802011-03-27 19:15:11 +00001435 CharUnits FirstBaseOffsetInLayoutClass,
Anders Carlssonb9021e92010-02-27 16:18:19 +00001436 PrimaryBasesSetVectorTy &PrimaryBases) {
Anders Carlsson57071e22010-02-12 05:25:12 +00001437 const CXXRecordDecl *RD = Base.getBase();
Anders Carlsson57071e22010-02-12 05:25:12 +00001438 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1439
1440 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
Ken Dyck57ebe332011-03-26 00:51:24 +00001441 CharUnits PrimaryBaseOffset;
Ken Dyck3a726802011-03-27 19:15:11 +00001442 CharUnits PrimaryBaseOffsetInLayoutClass;
Anders Carlssonc9e814b2010-11-24 23:12:57 +00001443 if (Layout.isPrimaryBaseVirtual()) {
Anders Carlssona14f5972010-10-31 23:22:37 +00001444 assert(Layout.getVBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlssonaf280c02010-02-23 03:48:14 +00001445 "Primary vbase should have a zero offset!");
1446
1447 const ASTRecordLayout &MostDerivedClassLayout =
1448 Context.getASTRecordLayout(MostDerivedClass);
1449
Anders Carlsson60396612010-03-10 06:51:42 +00001450 PrimaryBaseOffset =
Ken Dyck57ebe332011-03-26 00:51:24 +00001451 MostDerivedClassLayout.getVBaseClassOffset(PrimaryBase);
Anders Carlsson60396612010-03-10 06:51:42 +00001452
1453 const ASTRecordLayout &LayoutClassLayout =
1454 Context.getASTRecordLayout(LayoutClass);
1455
1456 PrimaryBaseOffsetInLayoutClass =
Ken Dyck3a726802011-03-27 19:15:11 +00001457 LayoutClassLayout.getVBaseClassOffset(PrimaryBase);
Anders Carlssonaf280c02010-02-23 03:48:14 +00001458 } else {
Anders Carlssona14f5972010-10-31 23:22:37 +00001459 assert(Layout.getBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlsson57071e22010-02-12 05:25:12 +00001460 "Primary base should have a zero offset!");
Anders Carlssonaf280c02010-02-23 03:48:14 +00001461
Ken Dyck57ebe332011-03-26 00:51:24 +00001462 PrimaryBaseOffset = Base.getBaseOffset();
Anders Carlsson60396612010-03-10 06:51:42 +00001463 PrimaryBaseOffsetInLayoutClass = BaseOffsetInLayoutClass;
Anders Carlssonaf280c02010-02-23 03:48:14 +00001464 }
Anders Carlssondad0f992010-02-28 18:37:33 +00001465
Ken Dyck57ebe332011-03-26 00:51:24 +00001466 AddMethods(BaseSubobject(PrimaryBase, PrimaryBaseOffset),
Anders Carlsson60396612010-03-10 06:51:42 +00001467 PrimaryBaseOffsetInLayoutClass, FirstBaseInPrimaryBaseChain,
1468 FirstBaseOffsetInLayoutClass, PrimaryBases);
Anders Carlsson57071e22010-02-12 05:25:12 +00001469
1470 if (!PrimaryBases.insert(PrimaryBase))
David Blaikieb219cfc2011-09-23 05:06:16 +00001471 llvm_unreachable("Found a duplicate primary base!");
Anders Carlsson57071e22010-02-12 05:25:12 +00001472 }
Anders Carlsson822307b2010-02-11 17:18:51 +00001473
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001474 // Now go through all virtual member functions and add them.
1475 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
1476 E = RD->method_end(); I != E; ++I) {
1477 const CXXMethodDecl *MD = *I;
Anders Carlsson57071e22010-02-12 05:25:12 +00001478
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001479 if (!MD->isVirtual())
1480 continue;
Anders Carlsson57071e22010-02-12 05:25:12 +00001481
1482 // Get the final overrider.
Anders Carlssona7575822010-02-12 16:55:34 +00001483 FinalOverriders::OverriderInfo Overrider =
Ken Dycke6203132011-03-26 01:18:17 +00001484 Overriders.getOverrider(MD, Base.getBaseOffset());
Anders Carlsson57071e22010-02-12 05:25:12 +00001485
1486 // Check if this virtual member function overrides a method in a primary
1487 // base. If this is the case, and the return type doesn't require adjustment
1488 // then we can just use the member function from the primary base.
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001489 if (const CXXMethodDecl *OverriddenMD =
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001490 FindNearestOverriddenMethod(MD, PrimaryBases)) {
Anders Carlssondf31af12010-02-13 23:17:31 +00001491 if (ComputeReturnAdjustmentBaseOffset(Context, MD,
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001492 OverriddenMD).isEmpty()) {
1493 // Replace the method info of the overridden method with our own
1494 // method.
1495 assert(MethodInfoMap.count(OverriddenMD) &&
1496 "Did not find the overridden method!");
1497 MethodInfo &OverriddenMethodInfo = MethodInfoMap[OverriddenMD];
1498
Ken Dyck3a726802011-03-27 19:15:11 +00001499 MethodInfo MethodInfo(Base.getBaseOffset(), BaseOffsetInLayoutClass,
1500 OverriddenMethodInfo.VTableIndex);
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001501
1502 assert(!MethodInfoMap.count(MD) &&
1503 "Should not have method info for this method yet!");
1504
1505 MethodInfoMap.insert(std::make_pair(MD, MethodInfo));
1506 MethodInfoMap.erase(OverriddenMD);
Anders Carlssonbca5d372010-03-22 20:06:40 +00001507
1508 // If the overridden method exists in a virtual base class or a direct
1509 // or indirect base class of a virtual base class, we need to emit a
1510 // thunk if we ever have a class hierarchy where the base class is not
1511 // a primary base in the complete object.
Anders Carlsson718d0692010-04-11 22:07:06 +00001512 if (!isBuildingConstructorVTable() && OverriddenMD != MD) {
Anders Carlssonbca5d372010-03-22 20:06:40 +00001513 // Compute the this adjustment.
1514 ThisAdjustment ThisAdjustment =
Ken Dyck3a726802011-03-27 19:15:11 +00001515 ComputeThisAdjustment(OverriddenMD, BaseOffsetInLayoutClass,
1516 Overrider);
Anders Carlssonbca5d372010-03-22 20:06:40 +00001517
Anders Carlssonacfa6ae2010-03-29 02:53:58 +00001518 if (ThisAdjustment.VCallOffsetOffset &&
1519 Overrider.Method->getParent() == MostDerivedClass) {
John McCall4e3b17c2010-11-09 01:18:05 +00001520
1521 // There's no return adjustment from OverriddenMD and MD,
1522 // but that doesn't mean there isn't one between MD and
1523 // the final overrider.
1524 BaseOffset ReturnAdjustmentOffset =
1525 ComputeReturnAdjustmentBaseOffset(Context, Overrider.Method, MD);
1526 ReturnAdjustment ReturnAdjustment =
1527 ComputeReturnAdjustment(ReturnAdjustmentOffset);
1528
Anders Carlssonacfa6ae2010-03-29 02:53:58 +00001529 // This is a virtual thunk for the most derived class, add it.
Anders Carlssonbca5d372010-03-22 20:06:40 +00001530 AddThunk(Overrider.Method,
John McCall4e3b17c2010-11-09 01:18:05 +00001531 ThunkInfo(ThisAdjustment, ReturnAdjustment));
Anders Carlssonbca5d372010-03-22 20:06:40 +00001532 }
1533 }
1534
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001535 continue;
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001536 }
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001537 }
Anders Carlsson0c0eeb22010-02-13 02:02:03 +00001538
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001539 // Insert the method info for this method.
Ken Dyck3a726802011-03-27 19:15:11 +00001540 MethodInfo MethodInfo(Base.getBaseOffset(), BaseOffsetInLayoutClass,
Ken Dyck82abeae2011-03-27 18:57:53 +00001541 Components.size());
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001542
1543 assert(!MethodInfoMap.count(MD) &&
1544 "Should not have method info for this method yet!");
1545 MethodInfoMap.insert(std::make_pair(MD, MethodInfo));
Anders Carlssoncd4e6372010-02-27 18:09:40 +00001546
1547 // Check if this overrider is going to be used.
Anders Carlsson60396612010-03-10 06:51:42 +00001548 const CXXMethodDecl *OverriderMD = Overrider.Method;
Ken Dyck413e7d22011-04-02 00:44:58 +00001549 if (!IsOverriderUsed(OverriderMD, BaseOffsetInLayoutClass,
Anders Carlsson60396612010-03-10 06:51:42 +00001550 FirstBaseInPrimaryBaseChain,
Ken Dyck413e7d22011-04-02 00:44:58 +00001551 FirstBaseOffsetInLayoutClass)) {
Anders Carlsson94464812010-04-10 19:13:06 +00001552 Components.push_back(VTableComponent::MakeUnusedFunction(OverriderMD));
Anders Carlssoncd4e6372010-02-27 18:09:40 +00001553 continue;
1554 }
Anders Carlsson464c8f12010-02-23 04:26:39 +00001555
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001556 // Check if this overrider needs a return adjustment.
Anders Carlsson7097e752010-06-01 23:47:05 +00001557 // We don't want to do this for pure virtual member functions.
1558 BaseOffset ReturnAdjustmentOffset;
1559 if (!OverriderMD->isPure()) {
1560 ReturnAdjustmentOffset =
1561 ComputeReturnAdjustmentBaseOffset(Context, OverriderMD, MD);
1562 }
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001563
1564 ReturnAdjustment ReturnAdjustment =
1565 ComputeReturnAdjustment(ReturnAdjustmentOffset);
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001566
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001567 AddMethod(Overrider.Method, ReturnAdjustment);
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001568 }
1569}
1570
Anders Carlsson718d0692010-04-11 22:07:06 +00001571void VTableBuilder::LayoutVTable() {
Ken Dyck4230d522011-03-24 01:21:01 +00001572 LayoutPrimaryAndSecondaryVTables(BaseSubobject(MostDerivedClass,
1573 CharUnits::Zero()),
Anders Carlsson73e6fa02010-04-11 22:20:36 +00001574 /*BaseIsMorallyVirtual=*/false,
Anders Carlsson530c40c2010-02-28 01:43:58 +00001575 MostDerivedClassIsVirtual,
Ken Dyck7ba8f522011-03-27 20:33:38 +00001576 MostDerivedClassOffset);
Anders Carlsson89ad4212010-02-16 16:26:28 +00001577
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001578 VisitedVirtualBasesSetTy VBases;
Anders Carlsson08c26752010-02-27 04:05:52 +00001579
1580 // Determine the primary virtual bases.
Ken Dyck8fe59932011-03-30 01:10:23 +00001581 DeterminePrimaryVirtualBases(MostDerivedClass, MostDerivedClassOffset,
1582 VBases);
Anders Carlsson08c26752010-02-27 04:05:52 +00001583 VBases.clear();
1584
Anders Carlsson718d0692010-04-11 22:07:06 +00001585 LayoutVTablesForVirtualBases(MostDerivedClass, VBases);
Peter Collingbournee09cdf42011-09-26 01:56:50 +00001586
1587 // -fapple-kext adds an extra entry at end of vtbl.
1588 bool IsAppleKext = Context.getLangOptions().AppleKext;
1589 if (IsAppleKext)
1590 Components.push_back(VTableComponent::MakeVCallOffset(CharUnits::Zero()));
Anders Carlsson89ad4212010-02-16 16:26:28 +00001591}
1592
Anders Carlsson530c40c2010-02-28 01:43:58 +00001593void
Anders Carlsson718d0692010-04-11 22:07:06 +00001594VTableBuilder::LayoutPrimaryAndSecondaryVTables(BaseSubobject Base,
Anders Carlsson73e6fa02010-04-11 22:20:36 +00001595 bool BaseIsMorallyVirtual,
Anders Carlsson91232842010-04-11 22:03:57 +00001596 bool BaseIsVirtualInLayoutClass,
Ken Dyck7ba8f522011-03-27 20:33:38 +00001597 CharUnits OffsetInLayoutClass) {
Chris Lattner04a23112010-02-17 21:42:34 +00001598 assert(Base.getBase()->isDynamicClass() && "class does not have a vtable!");
Anders Carlssonb828afa2010-02-14 17:05:59 +00001599
Anders Carlsson852213e2010-02-16 04:59:55 +00001600 // Add vcall and vbase offsets for this vtable.
Anders Carlsson530c40c2010-02-28 01:43:58 +00001601 VCallAndVBaseOffsetBuilder Builder(MostDerivedClass, LayoutClass, &Overriders,
Anders Carlsson91232842010-04-11 22:03:57 +00001602 Base, BaseIsVirtualInLayoutClass,
Ken Dyck3ecfa2d2011-03-31 00:48:04 +00001603 OffsetInLayoutClass);
Anders Carlssond68c0832010-02-25 03:45:56 +00001604 Components.append(Builder.components_begin(), Builder.components_end());
1605
Anders Carlssondba6ef82010-02-25 22:23:13 +00001606 // Check if we need to add these vcall offsets.
Anders Carlsson91232842010-04-11 22:03:57 +00001607 if (BaseIsVirtualInLayoutClass && !Builder.getVCallOffsets().empty()) {
Anders Carlssondba6ef82010-02-25 22:23:13 +00001608 VCallOffsetMap &VCallOffsets = VCallOffsetsForVBases[Base.getBase()];
1609
1610 if (VCallOffsets.empty())
1611 VCallOffsets = Builder.getVCallOffsets();
1612 }
1613
Anders Carlssonbb6305b2010-03-11 06:43:12 +00001614 // If we're laying out the most derived class we want to keep track of the
1615 // virtual base class offset offsets.
1616 if (Base.getBase() == MostDerivedClass)
1617 VBaseOffsetOffsets = Builder.getVBaseOffsetOffsets();
1618
Anders Carlsson852213e2010-02-16 04:59:55 +00001619 // Add the offset to top.
Ken Dyck7ba8f522011-03-27 20:33:38 +00001620 CharUnits OffsetToTop = MostDerivedClassOffset - OffsetInLayoutClass;
1621 Components.push_back(
Ken Dyckc40a3fd2011-04-02 01:14:48 +00001622 VTableComponent::MakeOffsetToTop(OffsetToTop));
Anders Carlsson57071e22010-02-12 05:25:12 +00001623
1624 // Next, add the RTTI.
Anders Carlsson94464812010-04-10 19:13:06 +00001625 Components.push_back(VTableComponent::MakeRTTI(MostDerivedClass));
Anders Carlsson57071e22010-02-12 05:25:12 +00001626
Anders Carlsson28cbc8b2010-02-12 07:43:48 +00001627 uint64_t AddressPoint = Components.size();
Anders Carlsson57071e22010-02-12 05:25:12 +00001628
1629 // Now go through all virtual member functions and add them.
Anders Carlssonb9021e92010-02-27 16:18:19 +00001630 PrimaryBasesSetVectorTy PrimaryBases;
Ken Dyck7ba8f522011-03-27 20:33:38 +00001631 AddMethods(Base, OffsetInLayoutClass,
1632 Base.getBase(), OffsetInLayoutClass,
Anders Carlsson60396612010-03-10 06:51:42 +00001633 PrimaryBases);
Anders Carlsson57071e22010-02-12 05:25:12 +00001634
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001635 // Compute 'this' pointer adjustments.
1636 ComputeThisAdjustments();
1637
Anders Carlsson014a3582010-03-25 21:45:14 +00001638 // Add all address points.
1639 const CXXRecordDecl *RD = Base.getBase();
1640 while (true) {
Ken Dyck4230d522011-03-24 01:21:01 +00001641 AddressPoints.insert(std::make_pair(
Ken Dyck7ba8f522011-03-27 20:33:38 +00001642 BaseSubobject(RD, OffsetInLayoutClass),
Ken Dyck4230d522011-03-24 01:21:01 +00001643 AddressPoint));
Anders Carlsson014a3582010-03-25 21:45:14 +00001644
1645 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1646 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
Anders Carlsson28cbc8b2010-02-12 07:43:48 +00001647
Anders Carlsson014a3582010-03-25 21:45:14 +00001648 if (!PrimaryBase)
1649 break;
1650
Anders Carlssonc9e814b2010-11-24 23:12:57 +00001651 if (Layout.isPrimaryBaseVirtual()) {
Anders Carlsson014a3582010-03-25 21:45:14 +00001652 // Check if this virtual primary base is a primary base in the layout
1653 // class. If it's not, we don't want to add it.
1654 const ASTRecordLayout &LayoutClassLayout =
1655 Context.getASTRecordLayout(LayoutClass);
1656
Ken Dyck7ba8f522011-03-27 20:33:38 +00001657 if (LayoutClassLayout.getVBaseClassOffset(PrimaryBase) !=
Anders Carlsson014a3582010-03-25 21:45:14 +00001658 OffsetInLayoutClass) {
1659 // We don't want to add this class (or any of its primary bases).
1660 break;
1661 }
1662 }
1663
1664 RD = PrimaryBase;
Anders Carlsson28cbc8b2010-02-12 07:43:48 +00001665 }
1666
Anders Carlsson5edcc372010-02-24 16:43:12 +00001667 // Layout secondary vtables.
Ken Dyck75762b32011-03-30 00:50:28 +00001668 LayoutSecondaryVTables(Base, BaseIsMorallyVirtual, OffsetInLayoutClass);
Anders Carlssonc7b63162010-02-16 16:02:57 +00001669}
1670
Anders Carlsson718d0692010-04-11 22:07:06 +00001671void VTableBuilder::LayoutSecondaryVTables(BaseSubobject Base,
Anders Carlssona96a2e92010-03-10 19:39:11 +00001672 bool BaseIsMorallyVirtual,
Ken Dyck75762b32011-03-30 00:50:28 +00001673 CharUnits OffsetInLayoutClass) {
Anders Carlssonc7b63162010-02-16 16:02:57 +00001674 // Itanium C++ ABI 2.5.2:
1675 // Following the primary virtual table of a derived class are secondary
1676 // virtual tables for each of its proper base classes, except any primary
1677 // base(s) with which it shares its primary virtual table.
1678
1679 const CXXRecordDecl *RD = Base.getBase();
Anders Carlsson57071e22010-02-12 05:25:12 +00001680 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1681 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
Anders Carlssonc7b63162010-02-16 16:02:57 +00001682
Anders Carlsson57071e22010-02-12 05:25:12 +00001683 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1684 E = RD->bases_end(); I != E; ++I) {
Anders Carlssonc7b63162010-02-16 16:02:57 +00001685 // Ignore virtual bases, we'll emit them later.
1686 if (I->isVirtual())
1687 continue;
1688
Anders Carlsson57071e22010-02-12 05:25:12 +00001689 const CXXRecordDecl *BaseDecl =
1690 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Anders Carlssonb828afa2010-02-14 17:05:59 +00001691
Anders Carlssona661a542010-02-16 04:49:44 +00001692 // Ignore bases that don't have a vtable.
1693 if (!BaseDecl->isDynamicClass())
1694 continue;
Anders Carlssonb828afa2010-02-14 17:05:59 +00001695
Anders Carlsson718d0692010-04-11 22:07:06 +00001696 if (isBuildingConstructorVTable()) {
Anders Carlssonf2c98ce2010-03-10 19:15:26 +00001697 // Itanium C++ ABI 2.6.4:
1698 // Some of the base class subobjects may not need construction virtual
1699 // tables, which will therefore not be present in the construction
1700 // virtual table group, even though the subobject virtual tables are
1701 // present in the main virtual table group for the complete object.
Anders Carlssona96a2e92010-03-10 19:39:11 +00001702 if (!BaseIsMorallyVirtual && !BaseDecl->getNumVBases())
Anders Carlssonf2c98ce2010-03-10 19:15:26 +00001703 continue;
Anders Carlssonf2c98ce2010-03-10 19:15:26 +00001704 }
1705
Anders Carlsson76f1aa72010-02-13 22:05:23 +00001706 // Get the base offset of this base.
Ken Dyck57ebe332011-03-26 00:51:24 +00001707 CharUnits RelativeBaseOffset = Layout.getBaseClassOffset(BaseDecl);
1708 CharUnits BaseOffset = Base.getBaseOffset() + RelativeBaseOffset;
Anders Carlsson530c40c2010-02-28 01:43:58 +00001709
Ken Dyck57ebe332011-03-26 00:51:24 +00001710 CharUnits BaseOffsetInLayoutClass =
Ken Dyck75762b32011-03-30 00:50:28 +00001711 OffsetInLayoutClass + RelativeBaseOffset;
Anders Carlssonc7b63162010-02-16 16:02:57 +00001712
1713 // Don't emit a secondary vtable for a primary base. We might however want
1714 // to emit secondary vtables for other bases of this base.
1715 if (BaseDecl == PrimaryBase) {
Ken Dyck75762b32011-03-30 00:50:28 +00001716 LayoutSecondaryVTables(BaseSubobject(BaseDecl, BaseOffset),
1717 BaseIsMorallyVirtual, BaseOffsetInLayoutClass);
Anders Carlssonc7b63162010-02-16 16:02:57 +00001718 continue;
1719 }
Anders Carlsson76f1aa72010-02-13 22:05:23 +00001720
Anders Carlsson89ad4212010-02-16 16:26:28 +00001721 // Layout the primary vtable (and any secondary vtables) for this base.
Ken Dyck4230d522011-03-24 01:21:01 +00001722 LayoutPrimaryAndSecondaryVTables(
Ken Dyck57ebe332011-03-26 00:51:24 +00001723 BaseSubobject(BaseDecl, BaseOffset),
Ken Dyck4230d522011-03-24 01:21:01 +00001724 BaseIsMorallyVirtual,
1725 /*BaseIsVirtualInLayoutClass=*/false,
Ken Dyck7ba8f522011-03-27 20:33:38 +00001726 BaseOffsetInLayoutClass);
Anders Carlsson57071e22010-02-12 05:25:12 +00001727 }
1728}
1729
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001730void
Anders Carlsson94464812010-04-10 19:13:06 +00001731VTableBuilder::DeterminePrimaryVirtualBases(const CXXRecordDecl *RD,
Ken Dyck8fe59932011-03-30 01:10:23 +00001732 CharUnits OffsetInLayoutClass,
Anders Carlsson08c26752010-02-27 04:05:52 +00001733 VisitedVirtualBasesSetTy &VBases) {
1734 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1735
1736 // Check if this base has a primary base.
1737 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
Anders Carlsson0378bf02010-02-28 18:08:38 +00001738
1739 // Check if it's virtual.
Anders Carlssonc9e814b2010-11-24 23:12:57 +00001740 if (Layout.isPrimaryBaseVirtual()) {
Anders Carlsson0378bf02010-02-28 18:08:38 +00001741 bool IsPrimaryVirtualBase = true;
1742
Anders Carlsson718d0692010-04-11 22:07:06 +00001743 if (isBuildingConstructorVTable()) {
Anders Carlsson0378bf02010-02-28 18:08:38 +00001744 // Check if the base is actually a primary base in the class we use for
1745 // layout.
Anders Carlssond7fdae52010-03-10 03:02:01 +00001746 const ASTRecordLayout &LayoutClassLayout =
1747 Context.getASTRecordLayout(LayoutClass);
1748
Ken Dyck8fe59932011-03-30 01:10:23 +00001749 CharUnits PrimaryBaseOffsetInLayoutClass =
1750 LayoutClassLayout.getVBaseClassOffset(PrimaryBase);
Anders Carlssond7fdae52010-03-10 03:02:01 +00001751
1752 // We know that the base is not a primary base in the layout class if
1753 // the base offsets are different.
1754 if (PrimaryBaseOffsetInLayoutClass != OffsetInLayoutClass)
Anders Carlsson0378bf02010-02-28 18:08:38 +00001755 IsPrimaryVirtualBase = false;
1756 }
1757
1758 if (IsPrimaryVirtualBase)
1759 PrimaryVirtualBases.insert(PrimaryBase);
1760 }
Anders Carlsson08c26752010-02-27 04:05:52 +00001761 }
1762
1763 // Traverse bases, looking for more primary virtual bases.
1764 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1765 E = RD->bases_end(); I != E; ++I) {
1766 const CXXRecordDecl *BaseDecl =
1767 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1768
Ken Dyck8fe59932011-03-30 01:10:23 +00001769 CharUnits BaseOffsetInLayoutClass;
Anders Carlssond7fdae52010-03-10 03:02:01 +00001770
1771 if (I->isVirtual()) {
1772 if (!VBases.insert(BaseDecl))
1773 continue;
1774
1775 const ASTRecordLayout &LayoutClassLayout =
1776 Context.getASTRecordLayout(LayoutClass);
Anders Carlsson08c26752010-02-27 04:05:52 +00001777
Anders Carlssona14f5972010-10-31 23:22:37 +00001778 BaseOffsetInLayoutClass =
Ken Dyck8fe59932011-03-30 01:10:23 +00001779 LayoutClassLayout.getVBaseClassOffset(BaseDecl);
Anders Carlssond7fdae52010-03-10 03:02:01 +00001780 } else {
1781 BaseOffsetInLayoutClass =
Ken Dyck8fe59932011-03-30 01:10:23 +00001782 OffsetInLayoutClass + Layout.getBaseClassOffset(BaseDecl);
Anders Carlssond7fdae52010-03-10 03:02:01 +00001783 }
1784
1785 DeterminePrimaryVirtualBases(BaseDecl, BaseOffsetInLayoutClass, VBases);
Anders Carlsson08c26752010-02-27 04:05:52 +00001786 }
1787}
1788
1789void
Anders Carlsson718d0692010-04-11 22:07:06 +00001790VTableBuilder::LayoutVTablesForVirtualBases(const CXXRecordDecl *RD,
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001791 VisitedVirtualBasesSetTy &VBases) {
1792 // Itanium C++ ABI 2.5.2:
1793 // Then come the virtual base virtual tables, also in inheritance graph
1794 // order, and again excluding primary bases (which share virtual tables with
1795 // the classes for which they are primary).
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001796 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1797 E = RD->bases_end(); I != E; ++I) {
1798 const CXXRecordDecl *BaseDecl =
1799 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1800
Anders Carlssonaf280c02010-02-23 03:48:14 +00001801 // Check if this base needs a vtable. (If it's virtual, not a primary base
1802 // of some other class, and we haven't visited it before).
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001803 if (I->isVirtual() && BaseDecl->isDynamicClass() &&
Anders Carlsson08c26752010-02-27 04:05:52 +00001804 !PrimaryVirtualBases.count(BaseDecl) && VBases.insert(BaseDecl)) {
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001805 const ASTRecordLayout &MostDerivedClassLayout =
1806 Context.getASTRecordLayout(MostDerivedClass);
Ken Dyck7262e902011-03-30 01:14:22 +00001807 CharUnits BaseOffset =
1808 MostDerivedClassLayout.getVBaseClassOffset(BaseDecl);
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001809
Anders Carlsson530c40c2010-02-28 01:43:58 +00001810 const ASTRecordLayout &LayoutClassLayout =
1811 Context.getASTRecordLayout(LayoutClass);
Ken Dyck7ba8f522011-03-27 20:33:38 +00001812 CharUnits BaseOffsetInLayoutClass =
1813 LayoutClassLayout.getVBaseClassOffset(BaseDecl);
Anders Carlsson530c40c2010-02-28 01:43:58 +00001814
Ken Dyck4230d522011-03-24 01:21:01 +00001815 LayoutPrimaryAndSecondaryVTables(
Ken Dyck7262e902011-03-30 01:14:22 +00001816 BaseSubobject(BaseDecl, BaseOffset),
Ken Dyck4230d522011-03-24 01:21:01 +00001817 /*BaseIsMorallyVirtual=*/true,
1818 /*BaseIsVirtualInLayoutClass=*/true,
1819 BaseOffsetInLayoutClass);
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001820 }
1821
1822 // We only need to check the base for virtual base vtables if it actually
1823 // has virtual bases.
1824 if (BaseDecl->getNumVBases())
Anders Carlsson718d0692010-04-11 22:07:06 +00001825 LayoutVTablesForVirtualBases(BaseDecl, VBases);
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001826 }
1827}
1828
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001829/// dumpLayout - Dump the vtable layout.
Chris Lattner5f9e2722011-07-23 10:55:15 +00001830void VTableBuilder::dumpLayout(raw_ostream& Out) {
Anders Carlssond03a3262010-02-27 20:39:05 +00001831
Anders Carlsson718d0692010-04-11 22:07:06 +00001832 if (isBuildingConstructorVTable()) {
Anders Carlssond03a3262010-02-27 20:39:05 +00001833 Out << "Construction vtable for ('";
1834 Out << MostDerivedClass->getQualifiedNameAsString() << "', ";
Ken Dyck23da84a2011-03-27 20:20:28 +00001835 Out << MostDerivedClassOffset.getQuantity() << ") in '";
Anders Carlssond03a3262010-02-27 20:39:05 +00001836 Out << LayoutClass->getQualifiedNameAsString();
Anders Carlssonbb6305b2010-03-11 06:43:12 +00001837 } else {
1838 Out << "Vtable for '";
1839 Out << MostDerivedClass->getQualifiedNameAsString();
Anders Carlssond03a3262010-02-27 20:39:05 +00001840 }
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001841 Out << "' (" << Components.size() << " entries).\n";
1842
Anders Carlsson822307b2010-02-11 17:18:51 +00001843 // Iterate through the address points and insert them into a new map where
1844 // they are keyed by the index and not the base object.
1845 // Since an address point can be shared by multiple subobjects, we use an
1846 // STL multimap.
1847 std::multimap<uint64_t, BaseSubobject> AddressPointsByIndex;
Anders Carlssonff143f82010-03-25 00:35:49 +00001848 for (AddressPointsMapTy::const_iterator I = AddressPoints.begin(),
1849 E = AddressPoints.end(); I != E; ++I) {
Anders Carlsson822307b2010-02-11 17:18:51 +00001850 const BaseSubobject& Base = I->first;
1851 uint64_t Index = I->second;
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001852
Anders Carlsson822307b2010-02-11 17:18:51 +00001853 AddressPointsByIndex.insert(std::make_pair(Index, Base));
1854 }
1855
1856 for (unsigned I = 0, E = Components.size(); I != E; ++I) {
Anders Carlsson28cbc8b2010-02-12 07:43:48 +00001857 uint64_t Index = I;
Anders Carlsson822307b2010-02-11 17:18:51 +00001858
1859 Out << llvm::format("%4d | ", I);
1860
Anders Carlsson94464812010-04-10 19:13:06 +00001861 const VTableComponent &Component = Components[I];
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001862
1863 // Dump the component.
1864 switch (Component.getKind()) {
Anders Carlssond9a67042010-02-17 06:07:19 +00001865
Anders Carlsson94464812010-04-10 19:13:06 +00001866 case VTableComponent::CK_VCallOffset:
Ken Dyckc40a3fd2011-04-02 01:14:48 +00001867 Out << "vcall_offset ("
1868 << Component.getVCallOffset().getQuantity()
1869 << ")";
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001870 break;
Anders Carlsson852213e2010-02-16 04:59:55 +00001871
Anders Carlsson94464812010-04-10 19:13:06 +00001872 case VTableComponent::CK_VBaseOffset:
Ken Dyckc40a3fd2011-04-02 01:14:48 +00001873 Out << "vbase_offset ("
1874 << Component.getVBaseOffset().getQuantity()
1875 << ")";
Anders Carlsson852213e2010-02-16 04:59:55 +00001876 break;
1877
Anders Carlsson94464812010-04-10 19:13:06 +00001878 case VTableComponent::CK_OffsetToTop:
Ken Dyckc40a3fd2011-04-02 01:14:48 +00001879 Out << "offset_to_top ("
1880 << Component.getOffsetToTop().getQuantity()
1881 << ")";
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001882 break;
1883
Anders Carlsson94464812010-04-10 19:13:06 +00001884 case VTableComponent::CK_RTTI:
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001885 Out << Component.getRTTIDecl()->getQualifiedNameAsString() << " RTTI";
1886 break;
1887
Anders Carlsson94464812010-04-10 19:13:06 +00001888 case VTableComponent::CK_FunctionPointer: {
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001889 const CXXMethodDecl *MD = Component.getFunctionDecl();
1890
Anders Carlsson848fa642010-02-11 18:20:28 +00001891 std::string Str =
1892 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
1893 MD);
1894 Out << Str;
Anders Carlsson98241422010-02-12 02:38:13 +00001895 if (MD->isPure())
1896 Out << " [pure]";
1897
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00001898 ThunkInfo Thunk = VTableThunks.lookup(I);
Anders Carlssondd366812010-03-12 04:54:20 +00001899 if (!Thunk.isEmpty()) {
1900 // If this function pointer has a return adjustment, dump it.
1901 if (!Thunk.Return.isEmpty()) {
1902 Out << "\n [return adjustment: ";
1903 Out << Thunk.Return.NonVirtual << " non-virtual";
1904
1905 if (Thunk.Return.VBaseOffsetOffset) {
1906 Out << ", " << Thunk.Return.VBaseOffsetOffset;
1907 Out << " vbase offset offset";
1908 }
Anders Carlsson60cc72a2010-02-18 17:00:09 +00001909
Anders Carlssondd366812010-03-12 04:54:20 +00001910 Out << ']';
1911 }
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001912
Anders Carlssondd366812010-03-12 04:54:20 +00001913 // If this function pointer has a 'this' pointer adjustment, dump it.
1914 if (!Thunk.This.isEmpty()) {
1915 Out << "\n [this adjustment: ";
1916 Out << Thunk.This.NonVirtual << " non-virtual";
1917
1918 if (Thunk.This.VCallOffsetOffset) {
1919 Out << ", " << Thunk.This.VCallOffsetOffset;
1920 Out << " vcall offset offset";
1921 }
Anders Carlsson60cc72a2010-02-18 17:00:09 +00001922
Anders Carlssondd366812010-03-12 04:54:20 +00001923 Out << ']';
1924 }
Anders Carlsson49bac9a2010-02-13 23:40:17 +00001925 }
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001926
Anders Carlsson848fa642010-02-11 18:20:28 +00001927 break;
1928 }
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001929
Anders Carlsson94464812010-04-10 19:13:06 +00001930 case VTableComponent::CK_CompleteDtorPointer:
1931 case VTableComponent::CK_DeletingDtorPointer: {
Anders Carlsson6065e022010-02-19 06:03:53 +00001932 bool IsComplete =
Anders Carlsson94464812010-04-10 19:13:06 +00001933 Component.getKind() == VTableComponent::CK_CompleteDtorPointer;
Anders Carlsson6065e022010-02-19 06:03:53 +00001934
Anders Carlsson848fa642010-02-11 18:20:28 +00001935 const CXXDestructorDecl *DD = Component.getDestructorDecl();
1936
Anders Carlsson6065e022010-02-19 06:03:53 +00001937 Out << DD->getQualifiedNameAsString();
1938 if (IsComplete)
1939 Out << "() [complete]";
1940 else
1941 Out << "() [deleting]";
1942
Anders Carlsson98241422010-02-12 02:38:13 +00001943 if (DD->isPure())
1944 Out << " [pure]";
1945
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00001946 ThunkInfo Thunk = VTableThunks.lookup(I);
Anders Carlssondd366812010-03-12 04:54:20 +00001947 if (!Thunk.isEmpty()) {
1948 // If this destructor has a 'this' pointer adjustment, dump it.
1949 if (!Thunk.This.isEmpty()) {
1950 Out << "\n [this adjustment: ";
1951 Out << Thunk.This.NonVirtual << " non-virtual";
1952
1953 if (Thunk.This.VCallOffsetOffset) {
1954 Out << ", " << Thunk.This.VCallOffsetOffset;
1955 Out << " vcall offset offset";
1956 }
1957
1958 Out << ']';
1959 }
1960 }
Anders Carlsson6065e022010-02-19 06:03:53 +00001961
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001962 break;
1963 }
1964
Anders Carlsson94464812010-04-10 19:13:06 +00001965 case VTableComponent::CK_UnusedFunctionPointer: {
Anders Carlsson1f464662010-02-19 20:08:13 +00001966 const CXXMethodDecl *MD = Component.getUnusedFunctionDecl();
1967
1968 std::string Str =
1969 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
1970 MD);
1971 Out << "[unused] " << Str;
1972 if (MD->isPure())
1973 Out << " [pure]";
1974 }
1975
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001976 }
Anders Carlsson822307b2010-02-11 17:18:51 +00001977
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001978 Out << '\n';
Anders Carlssond2c3a7c2010-02-27 23:58:01 +00001979
1980 // Dump the next address point.
1981 uint64_t NextIndex = Index + 1;
1982 if (AddressPointsByIndex.count(NextIndex)) {
1983 if (AddressPointsByIndex.count(NextIndex) == 1) {
1984 const BaseSubobject &Base =
1985 AddressPointsByIndex.find(NextIndex)->second;
1986
Anders Carlssond2c3a7c2010-02-27 23:58:01 +00001987 Out << " -- (" << Base.getBase()->getQualifiedNameAsString();
Ken Dyck4230d522011-03-24 01:21:01 +00001988 Out << ", " << Base.getBaseOffset().getQuantity();
1989 Out << ") vtable address --\n";
Anders Carlssond2c3a7c2010-02-27 23:58:01 +00001990 } else {
Ken Dyck57ebe332011-03-26 00:51:24 +00001991 CharUnits BaseOffset =
1992 AddressPointsByIndex.lower_bound(NextIndex)->second.getBaseOffset();
Anders Carlssond2c3a7c2010-02-27 23:58:01 +00001993
1994 // We store the class names in a set to get a stable order.
1995 std::set<std::string> ClassNames;
1996 for (std::multimap<uint64_t, BaseSubobject>::const_iterator I =
1997 AddressPointsByIndex.lower_bound(NextIndex), E =
1998 AddressPointsByIndex.upper_bound(NextIndex); I != E; ++I) {
Ken Dyck57ebe332011-03-26 00:51:24 +00001999 assert(I->second.getBaseOffset() == BaseOffset &&
Anders Carlssond2c3a7c2010-02-27 23:58:01 +00002000 "Invalid base offset!");
2001 const CXXRecordDecl *RD = I->second.getBase();
2002 ClassNames.insert(RD->getQualifiedNameAsString());
2003 }
2004
2005 for (std::set<std::string>::const_iterator I = ClassNames.begin(),
2006 E = ClassNames.end(); I != E; ++I) {
Anders Carlssond2c3a7c2010-02-27 23:58:01 +00002007 Out << " -- (" << *I;
Ken Dyck57ebe332011-03-26 00:51:24 +00002008 Out << ", " << BaseOffset.getQuantity() << ") vtable address --\n";
Anders Carlssond2c3a7c2010-02-27 23:58:01 +00002009 }
2010 }
2011 }
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002012 }
Anders Carlssond03a3262010-02-27 20:39:05 +00002013
2014 Out << '\n';
Anders Carlssonbb6305b2010-03-11 06:43:12 +00002015
Anders Carlsson718d0692010-04-11 22:07:06 +00002016 if (isBuildingConstructorVTable())
Anders Carlsson9135a842010-03-18 02:44:19 +00002017 return;
2018
2019 if (MostDerivedClass->getNumVBases()) {
Anders Carlssonbb6305b2010-03-11 06:43:12 +00002020 // We store the virtual base class names and their offsets in a map to get
2021 // a stable order.
Anders Carlssonbb6305b2010-03-11 06:43:12 +00002022
Ken Dyck3015c4c2011-04-07 00:59:42 +00002023 std::map<std::string, CharUnits> ClassNamesAndOffsets;
Anders Carlssonbb6305b2010-03-11 06:43:12 +00002024 for (VBaseOffsetOffsetsMapTy::const_iterator I = VBaseOffsetOffsets.begin(),
2025 E = VBaseOffsetOffsets.end(); I != E; ++I) {
2026 std::string ClassName = I->first->getQualifiedNameAsString();
Ken Dyckd28c33c2011-04-07 00:55:01 +00002027 CharUnits OffsetOffset = I->second;
2028 ClassNamesAndOffsets.insert(
Ken Dyck3015c4c2011-04-07 00:59:42 +00002029 std::make_pair(ClassName, OffsetOffset));
Anders Carlssonbb6305b2010-03-11 06:43:12 +00002030 }
Anders Carlsson9135a842010-03-18 02:44:19 +00002031
2032 Out << "Virtual base offset offsets for '";
2033 Out << MostDerivedClass->getQualifiedNameAsString() << "' (";
2034 Out << ClassNamesAndOffsets.size();
2035 Out << (ClassNamesAndOffsets.size() == 1 ? " entry" : " entries") << ").\n";
Anders Carlssonbb6305b2010-03-11 06:43:12 +00002036
Ken Dyck3015c4c2011-04-07 00:59:42 +00002037 for (std::map<std::string, CharUnits>::const_iterator I =
Anders Carlssonbb6305b2010-03-11 06:43:12 +00002038 ClassNamesAndOffsets.begin(), E = ClassNamesAndOffsets.end();
2039 I != E; ++I)
Ken Dyck3015c4c2011-04-07 00:59:42 +00002040 Out << " " << I->first << " | " << I->second.getQuantity() << '\n';
Anders Carlssonbb6305b2010-03-11 06:43:12 +00002041
2042 Out << "\n";
2043 }
Anders Carlsson9135a842010-03-18 02:44:19 +00002044
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00002045 if (!Thunks.empty()) {
Anders Carlsson9135a842010-03-18 02:44:19 +00002046 // We store the method names in a map to get a stable order.
2047 std::map<std::string, const CXXMethodDecl *> MethodNamesAndDecls;
2048
Anders Carlssonee5ab9f2010-03-23 04:59:02 +00002049 for (ThunksMapTy::const_iterator I = Thunks.begin(), E = Thunks.end();
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00002050 I != E; ++I) {
Anders Carlsson9135a842010-03-18 02:44:19 +00002051 const CXXMethodDecl *MD = I->first;
2052 std::string MethodName =
2053 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
2054 MD);
2055
2056 MethodNamesAndDecls.insert(std::make_pair(MethodName, MD));
2057 }
2058
2059 for (std::map<std::string, const CXXMethodDecl *>::const_iterator I =
2060 MethodNamesAndDecls.begin(), E = MethodNamesAndDecls.end();
2061 I != E; ++I) {
2062 const std::string &MethodName = I->first;
2063 const CXXMethodDecl *MD = I->second;
Anders Carlsson87e0ac82010-03-22 16:30:44 +00002064
Anders Carlssonee5ab9f2010-03-23 04:59:02 +00002065 ThunkInfoVectorTy ThunksVector = Thunks[MD];
Anders Carlsson87e0ac82010-03-22 16:30:44 +00002066 std::sort(ThunksVector.begin(), ThunksVector.end());
Anders Carlsson9135a842010-03-18 02:44:19 +00002067
2068 Out << "Thunks for '" << MethodName << "' (" << ThunksVector.size();
2069 Out << (ThunksVector.size() == 1 ? " entry" : " entries") << ").\n";
2070
2071 for (unsigned I = 0, E = ThunksVector.size(); I != E; ++I) {
2072 const ThunkInfo &Thunk = ThunksVector[I];
2073
2074 Out << llvm::format("%4d | ", I);
2075
Anders Carlsson09daa502010-03-22 16:10:59 +00002076 // If this function pointer has a return pointer adjustment, dump it.
2077 if (!Thunk.Return.isEmpty()) {
2078 Out << "return adjustment: " << Thunk.This.NonVirtual;
2079 Out << " non-virtual";
2080 if (Thunk.Return.VBaseOffsetOffset) {
2081 Out << ", " << Thunk.Return.VBaseOffsetOffset;
2082 Out << " vbase offset offset";
2083 }
2084
2085 if (!Thunk.This.isEmpty())
2086 Out << "\n ";
2087 }
2088
Anders Carlsson9135a842010-03-18 02:44:19 +00002089 // If this function pointer has a 'this' pointer adjustment, dump it.
2090 if (!Thunk.This.isEmpty()) {
Anders Carlsson09daa502010-03-22 16:10:59 +00002091 Out << "this adjustment: ";
2092 Out << Thunk.This.NonVirtual << " non-virtual";
Anders Carlsson9135a842010-03-18 02:44:19 +00002093
2094 if (Thunk.This.VCallOffsetOffset) {
2095 Out << ", " << Thunk.This.VCallOffsetOffset;
Anders Carlsson09daa502010-03-22 16:10:59 +00002096 Out << " vcall offset offset";
Anders Carlsson9135a842010-03-18 02:44:19 +00002097 }
2098 }
2099
2100 Out << '\n';
2101 }
Anders Carlssonbca5d372010-03-22 20:06:40 +00002102
2103 Out << '\n';
Anders Carlsson9135a842010-03-18 02:44:19 +00002104 }
2105 }
Anders Carlssond24e50c2011-04-10 17:42:45 +00002106
2107 // Compute the vtable indices for all the member functions.
2108 // Store them in a map keyed by the index so we'll get a sorted table.
2109 std::map<uint64_t, std::string> IndicesMap;
2110
2111 for (CXXRecordDecl::method_iterator i = MostDerivedClass->method_begin(),
2112 e = MostDerivedClass->method_end(); i != e; ++i) {
2113 const CXXMethodDecl *MD = *i;
2114
2115 // We only want virtual member functions.
2116 if (!MD->isVirtual())
2117 continue;
2118
2119 std::string MethodName =
2120 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
2121 MD);
2122
2123 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2124 IndicesMap[VTables.getMethodVTableIndex(GlobalDecl(DD, Dtor_Complete))] =
2125 MethodName + " [complete]";
2126 IndicesMap[VTables.getMethodVTableIndex(GlobalDecl(DD, Dtor_Deleting))] =
2127 MethodName + " [deleting]";
2128 } else {
2129 IndicesMap[VTables.getMethodVTableIndex(MD)] = MethodName;
2130 }
2131 }
2132
2133 // Print the vtable indices for all the member functions.
2134 if (!IndicesMap.empty()) {
2135 Out << "VTable indices for '";
2136 Out << MostDerivedClass->getQualifiedNameAsString();
2137 Out << "' (" << IndicesMap.size() << " entries).\n";
2138
2139 for (std::map<uint64_t, std::string>::const_iterator I = IndicesMap.begin(),
2140 E = IndicesMap.end(); I != E; ++I) {
2141 uint64_t VTableIndex = I->first;
2142 const std::string &MethodName = I->second;
2143
2144 Out << llvm::format(" %4u | ", VTableIndex) << MethodName << '\n';
2145 }
2146 }
2147
2148 Out << '\n';
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002149}
2150
2151}
2152
Peter Collingbournee09cdf42011-09-26 01:56:50 +00002153VTableLayout::VTableLayout(uint64_t NumVTableComponents,
2154 const VTableComponent *VTableComponents,
2155 uint64_t NumVTableThunks,
2156 const VTableThunkTy *VTableThunks,
2157 const AddressPointsMapTy &AddressPoints)
2158 : NumVTableComponents(NumVTableComponents),
2159 VTableComponents(new VTableComponent[NumVTableComponents]),
2160 NumVTableThunks(NumVTableThunks),
2161 VTableThunks(new VTableThunkTy[NumVTableThunks]),
2162 AddressPoints(AddressPoints) {
2163 std::copy(VTableComponents, VTableComponents+NumVTableComponents,
2164 this->VTableComponents);
2165 std::copy(VTableThunks, VTableThunks+NumVTableThunks, this->VTableThunks);
2166}
2167
2168VTableLayout::~VTableLayout() {
2169 delete[] VTableComponents;
2170}
2171
2172VTableContext::~VTableContext() {
2173 llvm::DeleteContainerSeconds(VTableLayouts);
2174}
2175
Anders Carlssonbdb4a9d2010-11-24 23:04:03 +00002176static void
2177CollectPrimaryBases(const CXXRecordDecl *RD, ASTContext &Context,
2178 VTableBuilder::PrimaryBasesSetVectorTy &PrimaryBases) {
Anders Carlssonb8bced02011-04-10 18:00:32 +00002179 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
2180 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
Anders Carlssonbdb4a9d2010-11-24 23:04:03 +00002181
Anders Carlssonb8bced02011-04-10 18:00:32 +00002182 if (!PrimaryBase)
2183 return;
2184
2185 CollectPrimaryBases(PrimaryBase, Context, PrimaryBases);
2186
2187 if (!PrimaryBases.insert(PrimaryBase))
David Blaikieb219cfc2011-09-23 05:06:16 +00002188 llvm_unreachable("Found a duplicate primary base!");
Anders Carlssonbdb4a9d2010-11-24 23:04:03 +00002189}
2190
Peter Collingbourne1d2b3172011-09-26 01:56:30 +00002191void VTableContext::ComputeMethodVTableIndices(const CXXRecordDecl *RD) {
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002192
2193 // Itanium C++ ABI 2.5.2:
Anders Carlsson45147d02010-02-02 03:37:46 +00002194 // The order of the virtual function pointers in a virtual table is the
2195 // order of declaration of the corresponding member functions in the class.
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002196 //
Anders Carlsson45147d02010-02-02 03:37:46 +00002197 // There is an entry for any virtual function declared in a class,
2198 // whether it is a new function or overrides a base class function,
2199 // unless it overrides a function from the primary base, and conversion
2200 // between their return types does not require an adjustment.
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002201
2202 int64_t CurrentIndex = 0;
2203
Peter Collingbourne1d2b3172011-09-26 01:56:30 +00002204 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002205 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
2206
2207 if (PrimaryBase) {
Anders Carlsson0121fbd2009-11-30 19:43:26 +00002208 assert(PrimaryBase->isDefinition() &&
2209 "Should have the definition decl of the primary base!");
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002210
2211 // Since the record decl shares its vtable pointer with the primary base
2212 // we need to start counting at the end of the primary base's vtable.
2213 CurrentIndex = getNumVirtualFunctionPointers(PrimaryBase);
2214 }
Eli Friedmanea5ae312009-12-15 03:31:17 +00002215
2216 // Collect all the primary bases, so we can check whether methods override
2217 // a method from the base.
Anders Carlsson94464812010-04-10 19:13:06 +00002218 VTableBuilder::PrimaryBasesSetVectorTy PrimaryBases;
Peter Collingbourne1d2b3172011-09-26 01:56:30 +00002219 CollectPrimaryBases(RD, Context, PrimaryBases);
Eli Friedmanea5ae312009-12-15 03:31:17 +00002220
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002221 const CXXDestructorDecl *ImplicitVirtualDtor = 0;
2222
2223 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
2224 e = RD->method_end(); i != e; ++i) {
2225 const CXXMethodDecl *MD = *i;
2226
2227 // We only want virtual methods.
2228 if (!MD->isVirtual())
2229 continue;
2230
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002231 // Check if this method overrides a method in the primary base.
Anders Carlsson57071e22010-02-12 05:25:12 +00002232 if (const CXXMethodDecl *OverriddenMD =
Anders Carlssonf622b452010-04-10 20:39:29 +00002233 FindNearestOverriddenMethod(MD, PrimaryBases)) {
Anders Carlsson57071e22010-02-12 05:25:12 +00002234 // Check if converting from the return type of the method to the
2235 // return type of the overridden method requires conversion.
Peter Collingbourne1d2b3172011-09-26 01:56:30 +00002236 if (ComputeReturnAdjustmentBaseOffset(Context, MD,
Anders Carlssondf31af12010-02-13 23:17:31 +00002237 OverriddenMD).isEmpty()) {
Anders Carlsson57071e22010-02-12 05:25:12 +00002238 // This index is shared between the index in the vtable of the primary
2239 // base class.
2240 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2241 const CXXDestructorDecl *OverriddenDD =
2242 cast<CXXDestructorDecl>(OverriddenMD);
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002243
Anders Carlsson57071e22010-02-12 05:25:12 +00002244 // Add both the complete and deleting entries.
Anders Carlsson046c2942010-04-17 20:15:18 +00002245 MethodVTableIndices[GlobalDecl(DD, Dtor_Complete)] =
2246 getMethodVTableIndex(GlobalDecl(OverriddenDD, Dtor_Complete));
2247 MethodVTableIndices[GlobalDecl(DD, Dtor_Deleting)] =
2248 getMethodVTableIndex(GlobalDecl(OverriddenDD, Dtor_Deleting));
Anders Carlsson57071e22010-02-12 05:25:12 +00002249 } else {
Anders Carlsson046c2942010-04-17 20:15:18 +00002250 MethodVTableIndices[MD] = getMethodVTableIndex(OverriddenMD);
Anders Carlsson57071e22010-02-12 05:25:12 +00002251 }
2252
2253 // We don't need to add an entry for this method.
Anders Carlssonc1eec892010-02-12 18:14:46 +00002254 continue;
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002255 }
2256 }
2257
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002258 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2259 if (MD->isImplicit()) {
2260 assert(!ImplicitVirtualDtor &&
2261 "Did already see an implicit virtual dtor!");
2262 ImplicitVirtualDtor = DD;
2263 continue;
2264 }
Tilmann Schellerca0df922011-03-02 20:40:50 +00002265
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002266 // Add the complete dtor.
Anders Carlsson046c2942010-04-17 20:15:18 +00002267 MethodVTableIndices[GlobalDecl(DD, Dtor_Complete)] = CurrentIndex++;
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002268
2269 // Add the deleting dtor.
Anders Carlsson046c2942010-04-17 20:15:18 +00002270 MethodVTableIndices[GlobalDecl(DD, Dtor_Deleting)] = CurrentIndex++;
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002271 } else {
2272 // Add the entry.
Tilmann Schellerca0df922011-03-02 20:40:50 +00002273 MethodVTableIndices[MD] = CurrentIndex++;
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002274 }
2275 }
2276
2277 if (ImplicitVirtualDtor) {
2278 // Itanium C++ ABI 2.5.2:
Anders Carlssona661a542010-02-16 04:49:44 +00002279 // If a class has an implicitly-defined virtual destructor,
2280 // its entries come after the declared virtual function pointers.
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002281
2282 // Add the complete dtor.
Anders Carlsson046c2942010-04-17 20:15:18 +00002283 MethodVTableIndices[GlobalDecl(ImplicitVirtualDtor, Dtor_Complete)] =
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002284 CurrentIndex++;
2285
2286 // Add the deleting dtor.
Anders Carlsson046c2942010-04-17 20:15:18 +00002287 MethodVTableIndices[GlobalDecl(ImplicitVirtualDtor, Dtor_Deleting)] =
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002288 CurrentIndex++;
2289 }
2290
2291 NumVirtualFunctionPointers[RD] = CurrentIndex;
2292}
2293
Peter Collingbourne1d2b3172011-09-26 01:56:30 +00002294CodeGenVTables::CodeGenVTables(CodeGenModule &CGM)
2295 : CGM(CGM), VTContext(CGM.getContext()) { }
2296
Argyrios Kyrtzidisd2c47bd2010-10-11 03:25:57 +00002297bool CodeGenVTables::ShouldEmitVTableInThisTU(const CXXRecordDecl *RD) {
2298 assert(RD->isDynamicClass() && "Non dynamic classes have no VTable.");
2299
2300 TemplateSpecializationKind TSK = RD->getTemplateSpecializationKind();
2301 if (TSK == TSK_ExplicitInstantiationDeclaration)
2302 return false;
2303
2304 const CXXMethodDecl *KeyFunction = CGM.getContext().getKeyFunction(RD);
2305 if (!KeyFunction)
2306 return true;
2307
2308 // Itanium C++ ABI, 5.2.6 Instantiated Templates:
2309 // An instantiation of a class template requires:
2310 // - In the object where instantiated, the virtual table...
2311 if (TSK == TSK_ImplicitInstantiation ||
2312 TSK == TSK_ExplicitInstantiationDefinition)
2313 return true;
2314
Anders Carlsson6d7f8472011-01-30 20:45:54 +00002315 // If we're building with optimization, we always emit VTables since that
2316 // allows for virtual function calls to be devirtualized.
2317 // (We don't want to do this in -fapple-kext mode however).
2318 if (CGM.getCodeGenOpts().OptimizationLevel && !CGM.getLangOptions().AppleKext)
2319 return true;
2320
Argyrios Kyrtzidisd2c47bd2010-10-11 03:25:57 +00002321 return KeyFunction->hasBody();
2322}
2323
Peter Collingbourne1d2b3172011-09-26 01:56:30 +00002324uint64_t VTableContext::getNumVirtualFunctionPointers(const CXXRecordDecl *RD) {
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002325 llvm::DenseMap<const CXXRecordDecl *, uint64_t>::iterator I =
2326 NumVirtualFunctionPointers.find(RD);
2327 if (I != NumVirtualFunctionPointers.end())
2328 return I->second;
2329
Anders Carlsson046c2942010-04-17 20:15:18 +00002330 ComputeMethodVTableIndices(RD);
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002331
2332 I = NumVirtualFunctionPointers.find(RD);
2333 assert(I != NumVirtualFunctionPointers.end() && "Did not find entry!");
2334 return I->second;
2335}
2336
Peter Collingbourne1d2b3172011-09-26 01:56:30 +00002337uint64_t VTableContext::getMethodVTableIndex(GlobalDecl GD) {
Anders Carlsson046c2942010-04-17 20:15:18 +00002338 MethodVTableIndicesTy::iterator I = MethodVTableIndices.find(GD);
2339 if (I != MethodVTableIndices.end())
Anders Carlssondbd920c2009-10-11 22:13:54 +00002340 return I->second;
2341
Anders Carlssona0fdd912009-11-13 17:08:56 +00002342 const CXXRecordDecl *RD = cast<CXXMethodDecl>(GD.getDecl())->getParent();
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002343
Anders Carlsson046c2942010-04-17 20:15:18 +00002344 ComputeMethodVTableIndices(RD);
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002345
Anders Carlsson046c2942010-04-17 20:15:18 +00002346 I = MethodVTableIndices.find(GD);
2347 assert(I != MethodVTableIndices.end() && "Did not find index!");
Anders Carlssondbd920c2009-10-11 22:13:54 +00002348 return I->second;
2349}
2350
Ken Dyck14c65ca2011-04-07 12:37:09 +00002351CharUnits
Peter Collingbourne1d2b3172011-09-26 01:56:30 +00002352VTableContext::getVirtualBaseOffsetOffset(const CXXRecordDecl *RD,
2353 const CXXRecordDecl *VBase) {
Anders Carlssondbd920c2009-10-11 22:13:54 +00002354 ClassPairTy ClassPair(RD, VBase);
2355
Anders Carlssonbba16072010-03-11 07:15:17 +00002356 VirtualBaseClassOffsetOffsetsMapTy::iterator I =
2357 VirtualBaseClassOffsetOffsets.find(ClassPair);
2358 if (I != VirtualBaseClassOffsetOffsets.end())
Ken Dyck14c65ca2011-04-07 12:37:09 +00002359 return I->second;
Anders Carlssondbd920c2009-10-11 22:13:54 +00002360
Anders Carlssonc89a7cf2010-03-11 16:06:20 +00002361 VCallAndVBaseOffsetBuilder Builder(RD, RD, /*FinalOverriders=*/0,
Ken Dyck4230d522011-03-24 01:21:01 +00002362 BaseSubobject(RD, CharUnits::Zero()),
Anders Carlssonc89a7cf2010-03-11 16:06:20 +00002363 /*BaseIsVirtual=*/false,
Ken Dyck3ecfa2d2011-03-31 00:48:04 +00002364 /*OffsetInLayoutClass=*/CharUnits::Zero());
Anders Carlssonc89a7cf2010-03-11 16:06:20 +00002365
2366 for (VCallAndVBaseOffsetBuilder::VBaseOffsetOffsetsMapTy::const_iterator I =
2367 Builder.getVBaseOffsetOffsets().begin(),
2368 E = Builder.getVBaseOffsetOffsets().end(); I != E; ++I) {
Anders Carlssondbd920c2009-10-11 22:13:54 +00002369 // Insert all types.
2370 ClassPairTy ClassPair(RD, I->first);
2371
Ken Dyckd28c33c2011-04-07 00:55:01 +00002372 VirtualBaseClassOffsetOffsets.insert(
Ken Dyck1a7f7522011-04-07 01:22:42 +00002373 std::make_pair(ClassPair, I->second));
Anders Carlssondbd920c2009-10-11 22:13:54 +00002374 }
2375
Anders Carlssonbba16072010-03-11 07:15:17 +00002376 I = VirtualBaseClassOffsetOffsets.find(ClassPair);
Anders Carlssonbba16072010-03-11 07:15:17 +00002377 assert(I != VirtualBaseClassOffsetOffsets.end() && "Did not find index!");
Anders Carlssondbd920c2009-10-11 22:13:54 +00002378
Ken Dyck14c65ca2011-04-07 12:37:09 +00002379 return I->second;
Anders Carlssondbd920c2009-10-11 22:13:54 +00002380}
2381
Anders Carlsson19879c92010-03-23 17:17:29 +00002382llvm::Constant *CodeGenModule::GetAddrOfThunk(GlobalDecl GD,
Anders Carlsson84c49e42011-02-06 17:15:43 +00002383 const ThunkInfo &Thunk) {
Anders Carlsson19879c92010-03-23 17:17:29 +00002384 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2385
2386 // Compute the mangled name.
2387 llvm::SmallString<256> Name;
Rafael Espindolaf0be9792011-02-11 02:52:17 +00002388 llvm::raw_svector_ostream Out(Name);
Anders Carlsson19879c92010-03-23 17:17:29 +00002389 if (const CXXDestructorDecl* DD = dyn_cast<CXXDestructorDecl>(MD))
John McCall4c40d982010-08-31 07:33:07 +00002390 getCXXABI().getMangleContext().mangleCXXDtorThunk(DD, GD.getDtorType(),
Rafael Espindolaf0be9792011-02-11 02:52:17 +00002391 Thunk.This, Out);
Anders Carlsson19879c92010-03-23 17:17:29 +00002392 else
Rafael Espindolaf0be9792011-02-11 02:52:17 +00002393 getCXXABI().getMangleContext().mangleThunk(MD, Thunk, Out);
2394 Out.flush();
2395
Chris Lattner2acc6e32011-07-18 04:24:23 +00002396 llvm::Type *Ty = getTypes().GetFunctionTypeForVTable(GD);
Anders Carlsson84c49e42011-02-06 17:15:43 +00002397 return GetOrCreateLLVMFunction(Name, Ty, GD, /*ForVTable=*/true);
Anders Carlsson19879c92010-03-23 17:17:29 +00002398}
2399
Anders Carlsson519c3282010-03-24 00:39:18 +00002400static llvm::Value *PerformTypeAdjustment(CodeGenFunction &CGF,
2401 llvm::Value *Ptr,
2402 int64_t NonVirtualAdjustment,
2403 int64_t VirtualAdjustment) {
2404 if (!NonVirtualAdjustment && !VirtualAdjustment)
2405 return Ptr;
2406
Chris Lattner2acc6e32011-07-18 04:24:23 +00002407 llvm::Type *Int8PtrTy =
Anders Carlsson519c3282010-03-24 00:39:18 +00002408 llvm::Type::getInt8PtrTy(CGF.getLLVMContext());
2409
2410 llvm::Value *V = CGF.Builder.CreateBitCast(Ptr, Int8PtrTy);
2411
2412 if (NonVirtualAdjustment) {
2413 // Do the non-virtual adjustment.
2414 V = CGF.Builder.CreateConstInBoundsGEP1_64(V, NonVirtualAdjustment);
2415 }
2416
2417 if (VirtualAdjustment) {
Chris Lattner2acc6e32011-07-18 04:24:23 +00002418 llvm::Type *PtrDiffTy =
Anders Carlsson519c3282010-03-24 00:39:18 +00002419 CGF.ConvertType(CGF.getContext().getPointerDiffType());
2420
2421 // Do the virtual adjustment.
2422 llvm::Value *VTablePtrPtr =
2423 CGF.Builder.CreateBitCast(V, Int8PtrTy->getPointerTo());
2424
2425 llvm::Value *VTablePtr = CGF.Builder.CreateLoad(VTablePtrPtr);
2426
2427 llvm::Value *OffsetPtr =
2428 CGF.Builder.CreateConstInBoundsGEP1_64(VTablePtr, VirtualAdjustment);
2429
2430 OffsetPtr = CGF.Builder.CreateBitCast(OffsetPtr, PtrDiffTy->getPointerTo());
2431
2432 // Load the adjustment offset from the vtable.
2433 llvm::Value *Offset = CGF.Builder.CreateLoad(OffsetPtr);
2434
2435 // Adjust our pointer.
2436 V = CGF.Builder.CreateInBoundsGEP(V, Offset);
2437 }
2438
2439 // Cast back to the original type.
2440 return CGF.Builder.CreateBitCast(V, Ptr->getType());
2441}
2442
John McCall65005532010-08-04 23:46:35 +00002443static void setThunkVisibility(CodeGenModule &CGM, const CXXMethodDecl *MD,
2444 const ThunkInfo &Thunk, llvm::Function *Fn) {
Anders Carlsson0ffeaad2011-01-29 19:39:23 +00002445 CGM.setGlobalVisibility(Fn, MD);
John McCall65005532010-08-04 23:46:35 +00002446
John McCall279b5eb2010-08-12 23:36:15 +00002447 if (!CGM.getCodeGenOpts().HiddenWeakVTables)
2448 return;
2449
John McCall65005532010-08-04 23:46:35 +00002450 // If the thunk has weak/linkonce linkage, but the function must be
2451 // emitted in every translation unit that references it, then we can
2452 // emit its thunks with hidden visibility, since its thunks must be
2453 // emitted when the function is.
2454
John McCall7a536902010-08-05 20:39:18 +00002455 // This follows CodeGenModule::setTypeVisibility; see the comments
2456 // there for explanation.
John McCall65005532010-08-04 23:46:35 +00002457
2458 if ((Fn->getLinkage() != llvm::GlobalVariable::LinkOnceODRLinkage &&
2459 Fn->getLinkage() != llvm::GlobalVariable::WeakODRLinkage) ||
2460 Fn->getVisibility() != llvm::GlobalVariable::DefaultVisibility)
2461 return;
2462
Douglas Gregor4421d2b2011-03-26 12:10:19 +00002463 if (MD->getExplicitVisibility())
John McCall65005532010-08-04 23:46:35 +00002464 return;
2465
2466 switch (MD->getTemplateSpecializationKind()) {
John McCall65005532010-08-04 23:46:35 +00002467 case TSK_ExplicitInstantiationDefinition:
2468 case TSK_ExplicitInstantiationDeclaration:
2469 return;
2470
John McCall65005532010-08-04 23:46:35 +00002471 case TSK_Undeclared:
2472 break;
2473
John McCall7a536902010-08-05 20:39:18 +00002474 case TSK_ExplicitSpecialization:
John McCall65005532010-08-04 23:46:35 +00002475 case TSK_ImplicitInstantiation:
John McCall279b5eb2010-08-12 23:36:15 +00002476 if (!CGM.getCodeGenOpts().HiddenWeakTemplateVTables)
John McCall7a536902010-08-05 20:39:18 +00002477 return;
John McCall65005532010-08-04 23:46:35 +00002478 break;
2479 }
2480
2481 // If there's an explicit definition, and that definition is
2482 // out-of-line, then we can't assume that all users will have a
2483 // definition to emit.
2484 const FunctionDecl *Def = 0;
2485 if (MD->hasBody(Def) && Def->isOutOfLine())
2486 return;
2487
2488 Fn->setVisibility(llvm::GlobalValue::HiddenVisibility);
2489}
2490
John McCall311b4422011-03-09 07:12:35 +00002491#ifndef NDEBUG
2492static bool similar(const ABIArgInfo &infoL, CanQualType typeL,
2493 const ABIArgInfo &infoR, CanQualType typeR) {
2494 return (infoL.getKind() == infoR.getKind() &&
2495 (typeL == typeR ||
2496 (isa<PointerType>(typeL) && isa<PointerType>(typeR)) ||
2497 (isa<ReferenceType>(typeL) && isa<ReferenceType>(typeR))));
2498}
2499#endif
2500
Eli Friedman7dcdf5b2011-05-06 17:27:27 +00002501static RValue PerformReturnAdjustment(CodeGenFunction &CGF,
2502 QualType ResultType, RValue RV,
2503 const ThunkInfo &Thunk) {
2504 // Emit the return adjustment.
2505 bool NullCheckValue = !ResultType->isReferenceType();
2506
2507 llvm::BasicBlock *AdjustNull = 0;
2508 llvm::BasicBlock *AdjustNotNull = 0;
2509 llvm::BasicBlock *AdjustEnd = 0;
2510
2511 llvm::Value *ReturnValue = RV.getScalarVal();
2512
2513 if (NullCheckValue) {
2514 AdjustNull = CGF.createBasicBlock("adjust.null");
2515 AdjustNotNull = CGF.createBasicBlock("adjust.notnull");
2516 AdjustEnd = CGF.createBasicBlock("adjust.end");
2517
2518 llvm::Value *IsNull = CGF.Builder.CreateIsNull(ReturnValue);
2519 CGF.Builder.CreateCondBr(IsNull, AdjustNull, AdjustNotNull);
2520 CGF.EmitBlock(AdjustNotNull);
2521 }
2522
2523 ReturnValue = PerformTypeAdjustment(CGF, ReturnValue,
2524 Thunk.Return.NonVirtual,
2525 Thunk.Return.VBaseOffsetOffset);
2526
2527 if (NullCheckValue) {
2528 CGF.Builder.CreateBr(AdjustEnd);
2529 CGF.EmitBlock(AdjustNull);
2530 CGF.Builder.CreateBr(AdjustEnd);
2531 CGF.EmitBlock(AdjustEnd);
2532
2533 llvm::PHINode *PHI = CGF.Builder.CreatePHI(ReturnValue->getType(), 2);
2534 PHI->addIncoming(ReturnValue, AdjustNotNull);
2535 PHI->addIncoming(llvm::Constant::getNullValue(ReturnValue->getType()),
2536 AdjustNull);
2537 ReturnValue = PHI;
2538 }
2539
2540 return RValue::get(ReturnValue);
2541}
2542
2543// This function does roughly the same thing as GenerateThunk, but in a
2544// very different way, so that va_start and va_end work correctly.
2545// FIXME: This function assumes "this" is the first non-sret LLVM argument of
2546// a function, and that there is an alloca built in the entry block
2547// for all accesses to "this".
2548// FIXME: This function assumes there is only one "ret" statement per function.
2549// FIXME: Cloning isn't correct in the presence of indirect goto!
2550// FIXME: This implementation of thunks bloats codesize by duplicating the
2551// function definition. There are alternatives:
2552// 1. Add some sort of stub support to LLVM for cases where we can
2553// do a this adjustment, then a sibcall.
2554// 2. We could transform the definition to take a va_list instead of an
2555// actual variable argument list, then have the thunks (including a
2556// no-op thunk for the regular definition) call va_start/va_end.
2557// There's a bit of per-call overhead for this solution, but it's
2558// better for codesize if the definition is long.
2559void CodeGenFunction::GenerateVarArgsThunk(
2560 llvm::Function *Fn,
2561 const CGFunctionInfo &FnInfo,
2562 GlobalDecl GD, const ThunkInfo &Thunk) {
2563 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2564 const FunctionProtoType *FPT = MD->getType()->getAs<FunctionProtoType>();
2565 QualType ResultType = FPT->getResultType();
2566
2567 // Get the original function
Chris Lattner2acc6e32011-07-18 04:24:23 +00002568 llvm::Type *Ty =
Eli Friedman7dcdf5b2011-05-06 17:27:27 +00002569 CGM.getTypes().GetFunctionType(FnInfo, /*IsVariadic*/true);
2570 llvm::Value *Callee = CGM.GetAddrOfFunction(GD, Ty, /*ForVTable=*/true);
2571 llvm::Function *BaseFn = cast<llvm::Function>(Callee);
2572
2573 // Clone to thunk.
2574 llvm::Function *NewFn = llvm::CloneFunction(BaseFn);
2575 CGM.getModule().getFunctionList().push_back(NewFn);
2576 Fn->replaceAllUsesWith(NewFn);
2577 NewFn->takeName(Fn);
2578 Fn->eraseFromParent();
2579 Fn = NewFn;
2580
2581 // "Initialize" CGF (minimally).
2582 CurFn = Fn;
2583
2584 // Get the "this" value
2585 llvm::Function::arg_iterator AI = Fn->arg_begin();
2586 if (CGM.ReturnTypeUsesSRet(FnInfo))
2587 ++AI;
2588
2589 // Find the first store of "this", which will be to the alloca associated
2590 // with "this".
2591 llvm::Value *ThisPtr = &*AI;
2592 llvm::BasicBlock *EntryBB = Fn->begin();
2593 llvm::Instruction *ThisStore = 0;
2594 for (llvm::BasicBlock::iterator I = EntryBB->begin(), E = EntryBB->end();
2595 I != E; I++) {
2596 if (isa<llvm::StoreInst>(I) && I->getOperand(0) == ThisPtr) {
2597 ThisStore = cast<llvm::StoreInst>(I);
2598 break;
2599 }
2600 }
2601 assert(ThisStore && "Store of this should be in entry block?");
2602 // Adjust "this", if necessary.
2603 Builder.SetInsertPoint(ThisStore);
2604 llvm::Value *AdjustedThisPtr =
2605 PerformTypeAdjustment(*this, ThisPtr,
2606 Thunk.This.NonVirtual,
2607 Thunk.This.VCallOffsetOffset);
2608 ThisStore->setOperand(0, AdjustedThisPtr);
2609
2610 if (!Thunk.Return.isEmpty()) {
2611 // Fix up the returned value, if necessary.
2612 for (llvm::Function::iterator I = Fn->begin(), E = Fn->end(); I != E; I++) {
2613 llvm::Instruction *T = I->getTerminator();
2614 if (isa<llvm::ReturnInst>(T)) {
2615 RValue RV = RValue::get(T->getOperand(0));
2616 T->eraseFromParent();
2617 Builder.SetInsertPoint(&*I);
2618 RV = PerformReturnAdjustment(*this, ResultType, RV, Thunk);
2619 Builder.CreateRet(RV.getScalarVal());
2620 break;
2621 }
2622 }
2623 }
2624}
2625
John McCalld26bc762011-03-09 04:27:21 +00002626void CodeGenFunction::GenerateThunk(llvm::Function *Fn,
2627 const CGFunctionInfo &FnInfo,
2628 GlobalDecl GD, const ThunkInfo &Thunk) {
Anders Carlsson519c3282010-03-24 00:39:18 +00002629 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2630 const FunctionProtoType *FPT = MD->getType()->getAs<FunctionProtoType>();
2631 QualType ResultType = FPT->getResultType();
2632 QualType ThisType = MD->getThisType(getContext());
2633
2634 FunctionArgList FunctionArgs;
2635
2636 // FIXME: It would be nice if more of this code could be shared with
2637 // CodeGenFunction::GenerateCode.
2638
2639 // Create the implicit 'this' parameter declaration.
John McCall4c40d982010-08-31 07:33:07 +00002640 CurGD = GD;
2641 CGM.getCXXABI().BuildInstanceFunctionParams(*this, ResultType, FunctionArgs);
Anders Carlsson519c3282010-03-24 00:39:18 +00002642
2643 // Add the rest of the parameters.
2644 for (FunctionDecl::param_const_iterator I = MD->param_begin(),
2645 E = MD->param_end(); I != E; ++I) {
2646 ParmVarDecl *Param = *I;
2647
John McCalld26bc762011-03-09 04:27:21 +00002648 FunctionArgs.push_back(Param);
Anders Carlsson519c3282010-03-24 00:39:18 +00002649 }
Tilmann Scheller9c6082f2011-03-02 21:36:49 +00002650
John McCalld26bc762011-03-09 04:27:21 +00002651 StartFunction(GlobalDecl(), ResultType, Fn, FnInfo, FunctionArgs,
2652 SourceLocation());
Anders Carlsson519c3282010-03-24 00:39:18 +00002653
John McCall4c40d982010-08-31 07:33:07 +00002654 CGM.getCXXABI().EmitInstanceFunctionProlog(*this);
2655
Anders Carlsson519c3282010-03-24 00:39:18 +00002656 // Adjust the 'this' pointer if necessary.
2657 llvm::Value *AdjustedThisPtr =
2658 PerformTypeAdjustment(*this, LoadCXXThis(),
2659 Thunk.This.NonVirtual,
2660 Thunk.This.VCallOffsetOffset);
2661
2662 CallArgList CallArgs;
2663
2664 // Add our adjusted 'this' pointer.
Eli Friedman04c9a492011-05-02 17:57:46 +00002665 CallArgs.add(RValue::get(AdjustedThisPtr), ThisType);
Anders Carlsson519c3282010-03-24 00:39:18 +00002666
2667 // Add the rest of the parameters.
2668 for (FunctionDecl::param_const_iterator I = MD->param_begin(),
2669 E = MD->param_end(); I != E; ++I) {
John McCall413ebdb2011-03-11 20:59:21 +00002670 ParmVarDecl *param = *I;
2671 EmitDelegateCallArg(CallArgs, param);
Anders Carlsson519c3282010-03-24 00:39:18 +00002672 }
2673
2674 // Get our callee.
Chris Lattner2acc6e32011-07-18 04:24:23 +00002675 llvm::Type *Ty =
John McCall4c40d982010-08-31 07:33:07 +00002676 CGM.getTypes().GetFunctionType(CGM.getTypes().getFunctionInfo(GD),
Anders Carlsson519c3282010-03-24 00:39:18 +00002677 FPT->isVariadic());
Anders Carlsson84c49e42011-02-06 17:15:43 +00002678 llvm::Value *Callee = CGM.GetAddrOfFunction(GD, Ty, /*ForVTable=*/true);
Anders Carlsson519c3282010-03-24 00:39:18 +00002679
John McCalld26bc762011-03-09 04:27:21 +00002680#ifndef NDEBUG
2681 const CGFunctionInfo &CallFnInfo =
Eli Friedman03f48612011-08-09 18:16:09 +00002682 CGM.getTypes().getFunctionInfo(ResultType, CallArgs, FPT->getExtInfo());
John McCall311b4422011-03-09 07:12:35 +00002683 assert(CallFnInfo.getRegParm() == FnInfo.getRegParm() &&
2684 CallFnInfo.isNoReturn() == FnInfo.isNoReturn() &&
2685 CallFnInfo.getCallingConvention() == FnInfo.getCallingConvention());
2686 assert(similar(CallFnInfo.getReturnInfo(), CallFnInfo.getReturnType(),
2687 FnInfo.getReturnInfo(), FnInfo.getReturnType()));
2688 assert(CallFnInfo.arg_size() == FnInfo.arg_size());
2689 for (unsigned i = 0, e = FnInfo.arg_size(); i != e; ++i)
2690 assert(similar(CallFnInfo.arg_begin()[i].info,
2691 CallFnInfo.arg_begin()[i].type,
2692 FnInfo.arg_begin()[i].info, FnInfo.arg_begin()[i].type));
John McCalld26bc762011-03-09 04:27:21 +00002693#endif
Anders Carlsson519c3282010-03-24 00:39:18 +00002694
Douglas Gregorcb359df2010-05-20 05:54:35 +00002695 // Determine whether we have a return value slot to use.
2696 ReturnValueSlot Slot;
2697 if (!ResultType->isVoidType() &&
2698 FnInfo.getReturnInfo().getKind() == ABIArgInfo::Indirect &&
2699 hasAggregateLLVMType(CurFnInfo->getReturnType()))
2700 Slot = ReturnValueSlot(ReturnValue, ResultType.isVolatileQualified());
2701
Anders Carlsson519c3282010-03-24 00:39:18 +00002702 // Now emit our call.
Douglas Gregorcb359df2010-05-20 05:54:35 +00002703 RValue RV = EmitCall(FnInfo, Callee, Slot, CallArgs, MD);
Anders Carlsson519c3282010-03-24 00:39:18 +00002704
Eli Friedman7dcdf5b2011-05-06 17:27:27 +00002705 if (!Thunk.Return.isEmpty())
2706 RV = PerformReturnAdjustment(*this, ResultType, RV, Thunk);
Anders Carlsson519c3282010-03-24 00:39:18 +00002707
Douglas Gregorcb359df2010-05-20 05:54:35 +00002708 if (!ResultType->isVoidType() && Slot.isNull())
John McCalld16c2cf2011-02-08 08:22:06 +00002709 CGM.getCXXABI().EmitReturnFromThunk(*this, RV, ResultType);
Anders Carlsson519c3282010-03-24 00:39:18 +00002710
2711 FinishFunction();
2712
Anders Carlsson519c3282010-03-24 00:39:18 +00002713 // Set the right linkage.
John McCall8b242332010-05-25 04:30:21 +00002714 CGM.setFunctionLinkage(MD, Fn);
Anders Carlsson519c3282010-03-24 00:39:18 +00002715
2716 // Set the right visibility.
John McCall65005532010-08-04 23:46:35 +00002717 setThunkVisibility(CGM, MD, Thunk, Fn);
Anders Carlsson519c3282010-03-24 00:39:18 +00002718}
2719
Anders Carlsson14e82fd2011-02-06 18:31:40 +00002720void CodeGenVTables::EmitThunk(GlobalDecl GD, const ThunkInfo &Thunk,
2721 bool UseAvailableExternallyLinkage)
Anders Carlssonfbf6ed42010-03-23 16:36:50 +00002722{
John McCalld26bc762011-03-09 04:27:21 +00002723 const CGFunctionInfo &FnInfo = CGM.getTypes().getFunctionInfo(GD);
2724
2725 // FIXME: re-use FnInfo in this computation.
Anders Carlsson84c49e42011-02-06 17:15:43 +00002726 llvm::Constant *Entry = CGM.GetAddrOfThunk(GD, Thunk);
Anders Carlsson19879c92010-03-23 17:17:29 +00002727
Anders Carlsson7986ad52010-03-23 18:18:41 +00002728 // Strip off a bitcast if we got one back.
Anders Carlsson13d68982010-03-24 00:35:44 +00002729 if (llvm::ConstantExpr *CE = dyn_cast<llvm::ConstantExpr>(Entry)) {
Anders Carlsson7986ad52010-03-23 18:18:41 +00002730 assert(CE->getOpcode() == llvm::Instruction::BitCast);
Anders Carlsson13d68982010-03-24 00:35:44 +00002731 Entry = CE->getOperand(0);
Anders Carlsson7986ad52010-03-23 18:18:41 +00002732 }
2733
Anders Carlsson7986ad52010-03-23 18:18:41 +00002734 // There's already a declaration with the same name, check if it has the same
2735 // type or if we need to replace it.
Anders Carlsson13d68982010-03-24 00:35:44 +00002736 if (cast<llvm::GlobalValue>(Entry)->getType()->getElementType() !=
John McCall4c40d982010-08-31 07:33:07 +00002737 CGM.getTypes().GetFunctionTypeForVTable(GD)) {
Anders Carlsson13d68982010-03-24 00:35:44 +00002738 llvm::GlobalValue *OldThunkFn = cast<llvm::GlobalValue>(Entry);
Anders Carlsson7986ad52010-03-23 18:18:41 +00002739
2740 // If the types mismatch then we have to rewrite the definition.
2741 assert(OldThunkFn->isDeclaration() &&
2742 "Shouldn't replace non-declaration");
2743
2744 // Remove the name from the old thunk function and get a new thunk.
Chris Lattner5f9e2722011-07-23 10:55:15 +00002745 OldThunkFn->setName(StringRef());
Anders Carlsson84c49e42011-02-06 17:15:43 +00002746 Entry = CGM.GetAddrOfThunk(GD, Thunk);
Anders Carlsson7986ad52010-03-23 18:18:41 +00002747
2748 // If needed, replace the old thunk with a bitcast.
2749 if (!OldThunkFn->use_empty()) {
2750 llvm::Constant *NewPtrForOldDecl =
Anders Carlsson13d68982010-03-24 00:35:44 +00002751 llvm::ConstantExpr::getBitCast(Entry, OldThunkFn->getType());
Anders Carlsson7986ad52010-03-23 18:18:41 +00002752 OldThunkFn->replaceAllUsesWith(NewPtrForOldDecl);
2753 }
2754
2755 // Remove the old thunk.
2756 OldThunkFn->eraseFromParent();
2757 }
Anders Carlsson519c3282010-03-24 00:39:18 +00002758
Anders Carlsson519c3282010-03-24 00:39:18 +00002759 llvm::Function *ThunkFn = cast<llvm::Function>(Entry);
Anders Carlsson14e82fd2011-02-06 18:31:40 +00002760
2761 if (!ThunkFn->isDeclaration()) {
2762 if (UseAvailableExternallyLinkage) {
2763 // There is already a thunk emitted for this function, do nothing.
2764 return;
2765 }
2766
Anders Carlsson22df7b12011-02-06 20:09:44 +00002767 // If a function has a body, it should have available_externally linkage.
2768 assert(ThunkFn->hasAvailableExternallyLinkage() &&
2769 "Function should have available_externally linkage!");
2770
2771 // Change the linkage.
2772 CGM.setFunctionLinkage(cast<CXXMethodDecl>(GD.getDecl()), ThunkFn);
2773 return;
Anders Carlsson14e82fd2011-02-06 18:31:40 +00002774 }
2775
Eli Friedman7dcdf5b2011-05-06 17:27:27 +00002776 if (ThunkFn->isVarArg()) {
2777 // Varargs thunks are special; we can't just generate a call because
2778 // we can't copy the varargs. Our implementation is rather
2779 // expensive/sucky at the moment, so don't generate the thunk unless
2780 // we have to.
2781 // FIXME: Do something better here; GenerateVarArgsThunk is extremely ugly.
2782 if (!UseAvailableExternallyLinkage)
2783 CodeGenFunction(CGM).GenerateVarArgsThunk(ThunkFn, FnInfo, GD, Thunk);
2784 } else {
2785 // Normal thunk body generation.
2786 CodeGenFunction(CGM).GenerateThunk(ThunkFn, FnInfo, GD, Thunk);
2787 }
Anders Carlsson14e82fd2011-02-06 18:31:40 +00002788
2789 if (UseAvailableExternallyLinkage)
2790 ThunkFn->setLinkage(llvm::GlobalValue::AvailableExternallyLinkage);
2791}
2792
2793void CodeGenVTables::MaybeEmitThunkAvailableExternally(GlobalDecl GD,
2794 const ThunkInfo &Thunk) {
2795 // We only want to do this when building with optimizations.
2796 if (!CGM.getCodeGenOpts().OptimizationLevel)
2797 return;
2798
2799 // We can't emit thunks for member functions with incomplete types.
2800 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Chris Lattnerf742eb02011-07-10 00:18:59 +00002801 if (!CGM.getTypes().isFuncTypeConvertible(
2802 cast<FunctionType>(MD->getType().getTypePtr())))
Anders Carlsson14e82fd2011-02-06 18:31:40 +00002803 return;
2804
2805 EmitThunk(GD, Thunk, /*UseAvailableExternallyLinkage=*/true);
Anders Carlssonfbf6ed42010-03-23 16:36:50 +00002806}
2807
Anders Carlssonee5ab9f2010-03-23 04:59:02 +00002808void CodeGenVTables::EmitThunks(GlobalDecl GD)
2809{
Anders Carlssonfbf6ed42010-03-23 16:36:50 +00002810 const CXXMethodDecl *MD =
2811 cast<CXXMethodDecl>(GD.getDecl())->getCanonicalDecl();
2812
2813 // We don't need to generate thunks for the base destructor.
2814 if (isa<CXXDestructorDecl>(MD) && GD.getDtorType() == Dtor_Base)
2815 return;
2816
Peter Collingbourne84fcc482011-09-26 01:56:41 +00002817 const VTableContext::ThunkInfoVectorTy *ThunkInfoVector =
2818 VTContext.getThunkInfo(MD);
2819 if (!ThunkInfoVector)
Anders Carlssonccd83d72010-03-24 16:42:11 +00002820 return;
Anders Carlssonccd83d72010-03-24 16:42:11 +00002821
Peter Collingbourne84fcc482011-09-26 01:56:41 +00002822 for (unsigned I = 0, E = ThunkInfoVector->size(); I != E; ++I)
2823 EmitThunk(GD, (*ThunkInfoVector)[I],
2824 /*UseAvailableExternallyLinkage=*/false);
Anders Carlssonee5ab9f2010-03-23 04:59:02 +00002825}
2826
Peter Collingbournee00fe692011-09-26 01:56:55 +00002827static VTableLayout *CreateVTableLayout(const VTableBuilder &Builder) {
2828 llvm::SmallVector<VTableLayout::VTableThunkTy, 1>
2829 VTableThunks(Builder.vtable_thunks_begin(), Builder.vtable_thunks_end());
2830 std::sort(VTableThunks.begin(), VTableThunks.end());
2831
2832 return new VTableLayout(Builder.getNumVTableComponents(),
2833 Builder.vtable_component_begin(),
2834 VTableThunks.size(),
2835 VTableThunks.data(),
2836 Builder.getAddressPoints());
2837}
2838
Peter Collingbourne84fcc482011-09-26 01:56:41 +00002839void VTableContext::ComputeVTableRelatedInformation(const CXXRecordDecl *RD) {
Peter Collingbournee09cdf42011-09-26 01:56:50 +00002840 const VTableLayout *&Entry = VTableLayouts[RD];
Douglas Gregor6fb745b2010-05-13 16:44:06 +00002841
John McCalle2132352010-06-02 21:22:02 +00002842 // Check if we've computed this information before.
Peter Collingbournebf1c5ae2011-09-26 01:56:36 +00002843 if (Entry)
John McCalle2132352010-06-02 21:22:02 +00002844 return;
Douglas Gregor6fb745b2010-05-13 16:44:06 +00002845
Peter Collingbourne84fcc482011-09-26 01:56:41 +00002846 VTableBuilder Builder(*this, RD, CharUnits::Zero(),
Ken Dyck23da84a2011-03-27 20:20:28 +00002847 /*MostDerivedClassIsVirtual=*/0, RD);
Peter Collingbournee00fe692011-09-26 01:56:55 +00002848 Entry = CreateVTableLayout(Builder);
Anders Carlssonccd83d72010-03-24 16:42:11 +00002849
2850 // Add the known thunks.
2851 Thunks.insert(Builder.thunks_begin(), Builder.thunks_end());
Anders Carlsson276701f2010-03-29 01:38:05 +00002852
Anders Carlssonccd83d72010-03-24 16:42:11 +00002853 // If we don't have the vbase information for this class, insert it.
2854 // getVirtualBaseOffsetOffset will compute it separately without computing
2855 // the rest of the vtable related information.
2856 if (!RD->getNumVBases())
2857 return;
2858
2859 const RecordType *VBaseRT =
2860 RD->vbases_begin()->getType()->getAs<RecordType>();
2861 const CXXRecordDecl *VBase = cast<CXXRecordDecl>(VBaseRT->getDecl());
2862
Peter Collingbourne84fcc482011-09-26 01:56:41 +00002863 if (VirtualBaseClassOffsetOffsets.count(std::make_pair(RD, VBase)))
Anders Carlssonccd83d72010-03-24 16:42:11 +00002864 return;
2865
Anders Carlsson94464812010-04-10 19:13:06 +00002866 for (VTableBuilder::VBaseOffsetOffsetsMapTy::const_iterator I =
Anders Carlssonccd83d72010-03-24 16:42:11 +00002867 Builder.getVBaseOffsetOffsets().begin(),
2868 E = Builder.getVBaseOffsetOffsets().end(); I != E; ++I) {
2869 // Insert all types.
Peter Collingbourne84fcc482011-09-26 01:56:41 +00002870 ClassPairTy ClassPair(RD, I->first);
Anders Carlssonccd83d72010-03-24 16:42:11 +00002871
Peter Collingbourne84fcc482011-09-26 01:56:41 +00002872 VirtualBaseClassOffsetOffsets.insert(std::make_pair(ClassPair, I->second));
Anders Carlssonccd83d72010-03-24 16:42:11 +00002873 }
2874}
2875
Peter Collingbournee00fe692011-09-26 01:56:55 +00002876VTableLayout *VTableContext::createConstructionVTableLayout(
2877 const CXXRecordDecl *MostDerivedClass,
2878 CharUnits MostDerivedClassOffset,
2879 bool MostDerivedClassIsVirtual,
2880 const CXXRecordDecl *LayoutClass) {
2881 VTableBuilder Builder(*this, MostDerivedClass, MostDerivedClassOffset,
2882 MostDerivedClassIsVirtual, LayoutClass);
2883 return CreateVTableLayout(Builder);
2884}
2885
Anders Carlsson0d1407e2010-03-25 15:26:28 +00002886llvm::Constant *
2887CodeGenVTables::CreateVTableInitializer(const CXXRecordDecl *RD,
Peter Collingbournee09cdf42011-09-26 01:56:50 +00002888 const VTableComponent *Components,
Anders Carlsson0d1407e2010-03-25 15:26:28 +00002889 unsigned NumComponents,
Peter Collingbournee09cdf42011-09-26 01:56:50 +00002890 const VTableLayout::VTableThunkTy *VTableThunks,
2891 unsigned NumVTableThunks) {
Chris Lattner5f9e2722011-07-23 10:55:15 +00002892 SmallVector<llvm::Constant *, 64> Inits;
Anders Carlsson0d1407e2010-03-25 15:26:28 +00002893
Chris Lattner2acc6e32011-07-18 04:24:23 +00002894 llvm::Type *Int8PtrTy = llvm::Type::getInt8PtrTy(CGM.getLLVMContext());
Anders Carlsson0d1407e2010-03-25 15:26:28 +00002895
Chris Lattner2acc6e32011-07-18 04:24:23 +00002896 llvm::Type *PtrDiffTy =
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002897 CGM.getTypes().ConvertType(CGM.getContext().getPointerDiffType());
2898
2899 QualType ClassType = CGM.getContext().getTagDeclType(RD);
2900 llvm::Constant *RTTI = CGM.GetAddrOfRTTIDescriptor(ClassType);
2901
2902 unsigned NextVTableThunkIndex = 0;
2903
Anders Carlsson67d568a2010-03-29 05:40:50 +00002904 llvm::Constant* PureVirtualFn = 0;
2905
Anders Carlsson0d1407e2010-03-25 15:26:28 +00002906 for (unsigned I = 0; I != NumComponents; ++I) {
Peter Collingbournee09cdf42011-09-26 01:56:50 +00002907 VTableComponent Component = Components[I];
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002908
2909 llvm::Constant *Init = 0;
2910
2911 switch (Component.getKind()) {
Anders Carlsson94464812010-04-10 19:13:06 +00002912 case VTableComponent::CK_VCallOffset:
Ken Dyckc40a3fd2011-04-02 01:14:48 +00002913 Init = llvm::ConstantInt::get(PtrDiffTy,
2914 Component.getVCallOffset().getQuantity());
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002915 Init = llvm::ConstantExpr::getIntToPtr(Init, Int8PtrTy);
2916 break;
Anders Carlsson94464812010-04-10 19:13:06 +00002917 case VTableComponent::CK_VBaseOffset:
Ken Dyckc40a3fd2011-04-02 01:14:48 +00002918 Init = llvm::ConstantInt::get(PtrDiffTy,
2919 Component.getVBaseOffset().getQuantity());
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002920 Init = llvm::ConstantExpr::getIntToPtr(Init, Int8PtrTy);
2921 break;
Anders Carlsson94464812010-04-10 19:13:06 +00002922 case VTableComponent::CK_OffsetToTop:
Ken Dyckc40a3fd2011-04-02 01:14:48 +00002923 Init = llvm::ConstantInt::get(PtrDiffTy,
2924 Component.getOffsetToTop().getQuantity());
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002925 Init = llvm::ConstantExpr::getIntToPtr(Init, Int8PtrTy);
2926 break;
Anders Carlsson94464812010-04-10 19:13:06 +00002927 case VTableComponent::CK_RTTI:
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002928 Init = llvm::ConstantExpr::getBitCast(RTTI, Int8PtrTy);
2929 break;
Anders Carlsson94464812010-04-10 19:13:06 +00002930 case VTableComponent::CK_FunctionPointer:
2931 case VTableComponent::CK_CompleteDtorPointer:
2932 case VTableComponent::CK_DeletingDtorPointer: {
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002933 GlobalDecl GD;
2934
2935 // Get the right global decl.
2936 switch (Component.getKind()) {
2937 default:
2938 llvm_unreachable("Unexpected vtable component kind");
Anders Carlsson94464812010-04-10 19:13:06 +00002939 case VTableComponent::CK_FunctionPointer:
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002940 GD = Component.getFunctionDecl();
2941 break;
Anders Carlsson94464812010-04-10 19:13:06 +00002942 case VTableComponent::CK_CompleteDtorPointer:
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002943 GD = GlobalDecl(Component.getDestructorDecl(), Dtor_Complete);
2944 break;
Anders Carlsson94464812010-04-10 19:13:06 +00002945 case VTableComponent::CK_DeletingDtorPointer:
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002946 GD = GlobalDecl(Component.getDestructorDecl(), Dtor_Deleting);
2947 break;
2948 }
2949
Anders Carlsson67d568a2010-03-29 05:40:50 +00002950 if (cast<CXXMethodDecl>(GD.getDecl())->isPure()) {
2951 // We have a pure virtual member function.
2952 if (!PureVirtualFn) {
Chris Lattner2acc6e32011-07-18 04:24:23 +00002953 llvm::FunctionType *Ty =
Anders Carlsson67d568a2010-03-29 05:40:50 +00002954 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2955 /*isVarArg=*/false);
2956 PureVirtualFn =
2957 CGM.CreateRuntimeFunction(Ty, "__cxa_pure_virtual");
2958 PureVirtualFn = llvm::ConstantExpr::getBitCast(PureVirtualFn,
2959 Int8PtrTy);
2960 }
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002961
Anders Carlsson67d568a2010-03-29 05:40:50 +00002962 Init = PureVirtualFn;
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002963 } else {
Anders Carlsson67d568a2010-03-29 05:40:50 +00002964 // Check if we should use a thunk.
Peter Collingbournee09cdf42011-09-26 01:56:50 +00002965 if (NextVTableThunkIndex < NumVTableThunks &&
Anders Carlsson67d568a2010-03-29 05:40:50 +00002966 VTableThunks[NextVTableThunkIndex].first == I) {
2967 const ThunkInfo &Thunk = VTableThunks[NextVTableThunkIndex].second;
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002968
Anders Carlsson84c49e42011-02-06 17:15:43 +00002969 Init = CGM.GetAddrOfThunk(GD, Thunk);
Anders Carlsson14e82fd2011-02-06 18:31:40 +00002970 MaybeEmitThunkAvailableExternally(GD, Thunk);
2971
Anders Carlsson67d568a2010-03-29 05:40:50 +00002972 NextVTableThunkIndex++;
2973 } else {
Chris Lattner2acc6e32011-07-18 04:24:23 +00002974 llvm::Type *Ty = CGM.getTypes().GetFunctionTypeForVTable(GD);
Anders Carlsson67d568a2010-03-29 05:40:50 +00002975
Anders Carlsson1faa89f2011-02-05 04:35:53 +00002976 Init = CGM.GetAddrOfFunction(GD, Ty, /*ForVTable=*/true);
Anders Carlsson67d568a2010-03-29 05:40:50 +00002977 }
2978
2979 Init = llvm::ConstantExpr::getBitCast(Init, Int8PtrTy);
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002980 }
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002981 break;
2982 }
2983
Anders Carlsson94464812010-04-10 19:13:06 +00002984 case VTableComponent::CK_UnusedFunctionPointer:
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002985 Init = llvm::ConstantExpr::getNullValue(Int8PtrTy);
2986 break;
2987 };
Anders Carlsson0d1407e2010-03-25 15:26:28 +00002988
2989 Inits.push_back(Init);
2990 }
2991
2992 llvm::ArrayType *ArrayType = llvm::ArrayType::get(Int8PtrTy, NumComponents);
Jay Foad97357602011-06-22 09:24:39 +00002993 return llvm::ConstantArray::get(ArrayType, Inits);
Anders Carlsson0d1407e2010-03-25 15:26:28 +00002994}
2995
Anders Carlsson9dc338a2010-03-30 03:35:35 +00002996llvm::GlobalVariable *CodeGenVTables::GetAddrOfVTable(const CXXRecordDecl *RD) {
Peter Collingbournebf1c5ae2011-09-26 01:56:36 +00002997 llvm::GlobalVariable *&VTable = VTables[RD];
2998 if (VTable)
2999 return VTable;
3000
3001 // We may need to generate a definition for this vtable.
3002 if (ShouldEmitVTableInThisTU(RD))
3003 CGM.DeferredVTables.push_back(RD);
3004
Anders Carlsson5c6c1d92010-03-24 03:57:14 +00003005 llvm::SmallString<256> OutName;
Rafael Espindolaf0be9792011-02-11 02:52:17 +00003006 llvm::raw_svector_ostream Out(OutName);
3007 CGM.getCXXABI().getMangleContext().mangleCXXVTable(RD, Out);
3008 Out.flush();
Chris Lattner5f9e2722011-07-23 10:55:15 +00003009 StringRef Name = OutName.str();
Mike Stump85615df2009-11-19 04:04:36 +00003010
Chris Lattner2acc6e32011-07-18 04:24:23 +00003011 llvm::Type *Int8PtrTy = llvm::Type::getInt8PtrTy(CGM.getLLVMContext());
Anders Carlssonccd83d72010-03-24 16:42:11 +00003012 llvm::ArrayType *ArrayType =
Peter Collingbournee09cdf42011-09-26 01:56:50 +00003013 llvm::ArrayType::get(Int8PtrTy,
3014 VTContext.getVTableLayout(RD).getNumVTableComponents());
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003015
Peter Collingbournebf1c5ae2011-09-26 01:56:36 +00003016 VTable =
Anders Carlsson96eaf292011-01-29 18:25:07 +00003017 CGM.CreateOrReplaceCXXRuntimeVariable(Name, ArrayType,
3018 llvm::GlobalValue::ExternalLinkage);
Peter Collingbournebf1c5ae2011-09-26 01:56:36 +00003019 VTable->setUnnamedAddr(true);
3020 return VTable;
Mike Stump380dd752009-11-10 07:44:33 +00003021}
Mike Stump8cfcb522009-11-11 20:26:26 +00003022
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003023void
3024CodeGenVTables::EmitVTableDefinition(llvm::GlobalVariable *VTable,
3025 llvm::GlobalVariable::LinkageTypes Linkage,
3026 const CXXRecordDecl *RD) {
Peter Collingbournee09cdf42011-09-26 01:56:50 +00003027 const VTableLayout &VTLayout = VTContext.getVTableLayout(RD);
3028
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003029 // Create and set the initializer.
3030 llvm::Constant *Init =
Peter Collingbournee09cdf42011-09-26 01:56:50 +00003031 CreateVTableInitializer(RD,
3032 VTLayout.vtable_component_begin(),
3033 VTLayout.getNumVTableComponents(),
3034 VTLayout.vtable_thunk_begin(),
3035 VTLayout.getNumVTableThunks());
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003036 VTable->setInitializer(Init);
Anders Carlsson67d568a2010-03-29 05:40:50 +00003037
3038 // Set the correct linkage.
3039 VTable->setLinkage(Linkage);
Douglas Gregorc66bcfd2010-06-14 23:41:45 +00003040
3041 // Set the right visibility.
Anders Carlssonfa2e99f2011-01-29 20:24:48 +00003042 CGM.setTypeVisibility(VTable, RD, CodeGenModule::TVK_ForVTable);
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003043}
3044
Anders Carlssonff143f82010-03-25 00:35:49 +00003045llvm::GlobalVariable *
3046CodeGenVTables::GenerateConstructionVTable(const CXXRecordDecl *RD,
Anders Carlsson2c822f12010-03-26 03:56:54 +00003047 const BaseSubobject &Base,
3048 bool BaseIsVirtual,
John McCallbda0d6b2011-03-27 09:00:25 +00003049 llvm::GlobalVariable::LinkageTypes Linkage,
Anders Carlsson2c822f12010-03-26 03:56:54 +00003050 VTableAddressPointsMapTy& AddressPoints) {
Peter Collingbourne1d2b3172011-09-26 01:56:30 +00003051 VTableBuilder Builder(VTContext, Base.getBase(),
Ken Dyck23da84a2011-03-27 20:20:28 +00003052 Base.getBaseOffset(),
Anders Carlsson0d1407e2010-03-25 15:26:28 +00003053 /*MostDerivedClassIsVirtual=*/BaseIsVirtual, RD);
3054
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00003055 // Add the address points.
Anders Carlsson2c822f12010-03-26 03:56:54 +00003056 AddressPoints.insert(Builder.address_points_begin(),
3057 Builder.address_points_end());
Anders Carlsson0d1407e2010-03-25 15:26:28 +00003058
3059 // Get the mangled construction vtable name.
3060 llvm::SmallString<256> OutName;
Rafael Espindolaf0be9792011-02-11 02:52:17 +00003061 llvm::raw_svector_ostream Out(OutName);
John McCall4c40d982010-08-31 07:33:07 +00003062 CGM.getCXXABI().getMangleContext().
Ken Dyck4230d522011-03-24 01:21:01 +00003063 mangleCXXCtorVTable(RD, Base.getBaseOffset().getQuantity(), Base.getBase(),
3064 Out);
Rafael Espindolaf0be9792011-02-11 02:52:17 +00003065 Out.flush();
Chris Lattner5f9e2722011-07-23 10:55:15 +00003066 StringRef Name = OutName.str();
Anders Carlsson0d1407e2010-03-25 15:26:28 +00003067
Chris Lattner2acc6e32011-07-18 04:24:23 +00003068 llvm::Type *Int8PtrTy = llvm::Type::getInt8PtrTy(CGM.getLLVMContext());
Anders Carlsson0d1407e2010-03-25 15:26:28 +00003069 llvm::ArrayType *ArrayType =
3070 llvm::ArrayType::get(Int8PtrTy, Builder.getNumVTableComponents());
3071
3072 // Create the variable that will hold the construction vtable.
3073 llvm::GlobalVariable *VTable =
John McCallbda0d6b2011-03-27 09:00:25 +00003074 CGM.CreateOrReplaceCXXRuntimeVariable(Name, ArrayType, Linkage);
3075 CGM.setTypeVisibility(VTable, RD, CodeGenModule::TVK_ForConstructionVTable);
3076
3077 // V-tables are always unnamed_addr.
3078 VTable->setUnnamedAddr(true);
Anders Carlsson0d1407e2010-03-25 15:26:28 +00003079
3080 // Add the thunks.
Peter Collingbourne84fcc482011-09-26 01:56:41 +00003081 VTableContext::VTableThunksTy VTableThunks;
Anders Carlsson0d1407e2010-03-25 15:26:28 +00003082 VTableThunks.append(Builder.vtable_thunks_begin(),
3083 Builder.vtable_thunks_end());
3084
Anders Carlssonaed924e2010-03-29 01:28:05 +00003085 // Sort them.
3086 std::sort(VTableThunks.begin(), VTableThunks.end());
3087
Anders Carlsson0d1407e2010-03-25 15:26:28 +00003088 // Create and set the initializer.
3089 llvm::Constant *Init =
3090 CreateVTableInitializer(Base.getBase(),
Peter Collingbournee09cdf42011-09-26 01:56:50 +00003091 Builder.vtable_component_begin(),
3092 Builder.getNumVTableComponents(),
3093 VTableThunks.begin(),
3094 VTableThunks.size());
Anders Carlsson0d1407e2010-03-25 15:26:28 +00003095 VTable->setInitializer(Init);
3096
Anders Carlssonff143f82010-03-25 00:35:49 +00003097 return VTable;
3098}
3099
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003100void
3101CodeGenVTables::GenerateClassData(llvm::GlobalVariable::LinkageTypes Linkage,
3102 const CXXRecordDecl *RD) {
Peter Collingbournebf1c5ae2011-09-26 01:56:36 +00003103 llvm::GlobalVariable *VTable = GetAddrOfVTable(RD);
3104 if (VTable->hasInitializer())
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003105 return;
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003106
Anders Carlsson9dc338a2010-03-30 03:35:35 +00003107 EmitVTableDefinition(VTable, Linkage, RD);
3108
Anders Carlsson1cbce122011-01-29 19:16:51 +00003109 if (RD->getNumVBases()) {
3110 llvm::GlobalVariable *VTT = GetAddrOfVTT(RD);
3111 EmitVTTDefinition(VTT, Linkage, RD);
3112 }
Douglas Gregor1e201b42010-04-08 15:52:03 +00003113
3114 // If this is the magic class __cxxabiv1::__fundamental_type_info,
3115 // we will emit the typeinfo for the fundamental types. This is the
3116 // same behaviour as GCC.
3117 const DeclContext *DC = RD->getDeclContext();
3118 if (RD->getIdentifier() &&
3119 RD->getIdentifier()->isStr("__fundamental_type_info") &&
3120 isa<NamespaceDecl>(DC) &&
3121 cast<NamespaceDecl>(DC)->getIdentifier() &&
3122 cast<NamespaceDecl>(DC)->getIdentifier()->isStr("__cxxabiv1") &&
3123 DC->getParent()->isTranslationUnit())
3124 CGM.EmitFundamentalRTTIDescriptors();
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003125}