blob: 414900bde47f74e845461292a46a23beff83364a [file] [log] [blame]
Anders Carlsson11e51402010-04-17 20:15:18 +00001//===--- CGVTables.cpp - Emit LLVM Code for C++ vtables -------------------===//
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This contains code dealing with C++ code generation of virtual tables.
11//
12//===----------------------------------------------------------------------===//
13
14#include "CodeGenModule.h"
15#include "CodeGenFunction.h"
John McCall5d865c322010-08-31 07:33:07 +000016#include "CGCXXABI.h"
Anders Carlssonf942ee02009-11-27 20:47:55 +000017#include "clang/AST/CXXInheritance.h"
Anders Carlsson2bb27f52009-10-11 22:13:54 +000018#include "clang/AST/RecordLayout.h"
John McCall5513fce92010-08-05 20:39:18 +000019#include "clang/Frontend/CodeGenOptions.h"
Anders Carlssond420a312009-11-26 19:32:45 +000020#include "llvm/ADT/DenseSet.h"
Anders Carlssond46ed892010-02-27 16:18:19 +000021#include "llvm/ADT/SetVector.h"
Chandler Carruth94eab4a2010-02-13 10:38:52 +000022#include "llvm/Support/Compiler.h"
Anders Carlsson5d40c6f2010-02-11 08:02:13 +000023#include "llvm/Support/Format.h"
Anders Carlsson56446142010-03-17 20:06:32 +000024#include <algorithm>
Zhongxing Xu1721ef72009-11-13 05:46:16 +000025#include <cstdio>
Anders Carlsson2bb27f52009-10-11 22:13:54 +000026
27using namespace clang;
28using namespace CodeGen;
29
Anders Carlssond59885022009-11-27 22:21:51 +000030namespace {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +000031
Anders Carlsson075056a2010-02-23 01:34:28 +000032/// BaseOffset - Represents an offset from a derived class to a direct or
33/// indirect base class.
34struct BaseOffset {
35 /// DerivedClass - The derived class.
36 const CXXRecordDecl *DerivedClass;
37
38 /// VirtualBase - If the path from the derived class to the base class
39 /// involves a virtual base class, this holds its declaration.
40 const CXXRecordDecl *VirtualBase;
41
42 /// NonVirtualOffset - The offset from the derived class to the base class.
43 /// (Or the offset from the virtual base class to the base class, if the
44 /// path from the derived class to the base class involves a virtual base
45 /// class.
46 int64_t NonVirtualOffset;
47
48 BaseOffset() : DerivedClass(0), VirtualBase(0), NonVirtualOffset(0) { }
49 BaseOffset(const CXXRecordDecl *DerivedClass,
50 const CXXRecordDecl *VirtualBase, int64_t NonVirtualOffset)
51 : DerivedClass(DerivedClass), VirtualBase(VirtualBase),
52 NonVirtualOffset(NonVirtualOffset) { }
53
54 bool isEmpty() const { return !NonVirtualOffset && !VirtualBase; }
55};
56
Anders Carlssone8ac42a2010-02-11 21:24:32 +000057/// FinalOverriders - Contains the final overrider member functions for all
58/// member functions in the base subobjects of a class.
59class FinalOverriders {
Anders Carlsson136bd192010-02-12 16:55:34 +000060public:
61 /// OverriderInfo - Information about a final overrider.
62 struct OverriderInfo {
63 /// Method - The method decl of the overrider.
64 const CXXMethodDecl *Method;
Anders Carlsson5a7654a2010-02-18 16:29:24 +000065
Anders Carlssonca82a4f2010-03-10 02:33:41 +000066 /// Offset - the base offset of the overrider in the layout class.
67 uint64_t Offset;
Anders Carlsson136bd192010-02-12 16:55:34 +000068
Anders Carlsson3c289672010-03-12 05:02:01 +000069 OverriderInfo() : Method(0), Offset(0) { }
Anders Carlsson136bd192010-02-12 16:55:34 +000070 };
71
72private:
Anders Carlssone8ac42a2010-02-11 21:24:32 +000073 /// MostDerivedClass - The most derived class for which the final overriders
74 /// are stored.
75 const CXXRecordDecl *MostDerivedClass;
76
Anders Carlssonca82a4f2010-03-10 02:33:41 +000077 /// MostDerivedClassOffset - If we're building final overriders for a
78 /// construction vtable, this holds the offset from the layout class to the
79 /// most derived class.
80 const uint64_t MostDerivedClassOffset;
81
82 /// LayoutClass - The class we're using for layout information. Will be
83 /// different than the most derived class if the final overriders are for a
84 /// construction vtable.
85 const CXXRecordDecl *LayoutClass;
86
Anders Carlssone8ac42a2010-02-11 21:24:32 +000087 ASTContext &Context;
88
89 /// MostDerivedClassLayout - the AST record layout of the most derived class.
90 const ASTRecordLayout &MostDerivedClassLayout;
91
Anders Carlsson04e51cc2010-06-01 23:52:26 +000092 /// MethodBaseOffsetPairTy - Uniquely identifies a member function
Anders Carlssoneee53d92010-02-13 02:02:03 +000093 /// in a base subobject.
Anders Carlsson04e51cc2010-06-01 23:52:26 +000094 typedef std::pair<const CXXMethodDecl *, uint64_t> MethodBaseOffsetPairTy;
95
96 typedef llvm::DenseMap<MethodBaseOffsetPairTy,
Anders Carlsson136bd192010-02-12 16:55:34 +000097 OverriderInfo> OverridersMapTy;
Anders Carlssone8ac42a2010-02-11 21:24:32 +000098
99 /// OverridersMap - The final overriders for all virtual member functions of
100 /// all the base subobjects of the most derived class.
101 OverridersMapTy OverridersMap;
102
Anders Carlsson27860db2010-06-04 00:54:04 +0000103 /// SubobjectsToOffsetsMapTy - A mapping from a base subobject (represented
104 /// as a record decl and a subobject number) and its offsets in the most
105 /// derived class as well as the layout class.
106 typedef llvm::DenseMap<std::pair<const CXXRecordDecl *, unsigned>,
107 uint64_t> SubobjectOffsetMapTy;
108
109 typedef llvm::DenseMap<const CXXRecordDecl *, unsigned> SubobjectCountMapTy;
110
111 /// ComputeBaseOffsets - Compute the offsets for all base subobjects of the
112 /// given base.
113 void ComputeBaseOffsets(BaseSubobject Base, bool IsVirtual,
114 uint64_t OffsetInLayoutClass,
115 SubobjectOffsetMapTy &SubobjectOffsets,
116 SubobjectOffsetMapTy &SubobjectLayoutClassOffsets,
117 SubobjectCountMapTy &SubobjectCounts);
118
Anders Carlssonfd788402010-06-04 00:59:37 +0000119 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
120
121 /// dump - dump the final overriders for a base subobject, and all its direct
122 /// and indirect base subobjects.
123 void dump(llvm::raw_ostream &Out, BaseSubobject Base,
124 VisitedVirtualBasesSetTy& VisitedVirtualBases);
125
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000126public:
Anders Carlssonca82a4f2010-03-10 02:33:41 +0000127 FinalOverriders(const CXXRecordDecl *MostDerivedClass,
128 uint64_t MostDerivedClassOffset,
129 const CXXRecordDecl *LayoutClass);
Anders Carlsson8025e7b2010-02-24 22:18:01 +0000130
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000131 /// getOverrider - Get the final overrider for the given method declaration in
Anders Carlsson79547c32010-06-01 23:17:37 +0000132 /// the subobject with the given base offset.
133 OverriderInfo getOverrider(const CXXMethodDecl *MD,
134 uint64_t BaseOffset) const {
Anders Carlsson04e51cc2010-06-01 23:52:26 +0000135 assert(OverridersMap.count(std::make_pair(MD, BaseOffset)) &&
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000136 "Did not find overrider!");
137
Anders Carlsson04e51cc2010-06-01 23:52:26 +0000138 return OverridersMap.lookup(std::make_pair(MD, BaseOffset));
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000139 }
140
141 /// dump - dump the final overriders.
Anders Carlsson6a7e6a42010-02-14 00:37:35 +0000142 void dump() {
Anders Carlssonfd788402010-06-04 00:59:37 +0000143 VisitedVirtualBasesSetTy VisitedVirtualBases;
Ken Dyck16ffcac2011-03-24 01:21:01 +0000144 dump(llvm::errs(), BaseSubobject(MostDerivedClass, CharUnits::Zero()),
145 VisitedVirtualBases);
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000146 }
147
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000148};
Anders Carlssoneee53d92010-02-13 02:02:03 +0000149
Anders Carlsson603d7d12010-02-27 20:02:53 +0000150#define DUMP_OVERRIDERS 0
151
Anders Carlssonca82a4f2010-03-10 02:33:41 +0000152FinalOverriders::FinalOverriders(const CXXRecordDecl *MostDerivedClass,
153 uint64_t MostDerivedClassOffset,
154 const CXXRecordDecl *LayoutClass)
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000155 : MostDerivedClass(MostDerivedClass),
Anders Carlssonca82a4f2010-03-10 02:33:41 +0000156 MostDerivedClassOffset(MostDerivedClassOffset), LayoutClass(LayoutClass),
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000157 Context(MostDerivedClass->getASTContext()),
158 MostDerivedClassLayout(Context.getASTRecordLayout(MostDerivedClass)) {
Anders Carlssonfd788402010-06-04 00:59:37 +0000159
Anders Carlsson27860db2010-06-04 00:54:04 +0000160 // Compute base offsets.
161 SubobjectOffsetMapTy SubobjectOffsets;
162 SubobjectOffsetMapTy SubobjectLayoutClassOffsets;
163 SubobjectCountMapTy SubobjectCounts;
Ken Dyck16ffcac2011-03-24 01:21:01 +0000164 ComputeBaseOffsets(BaseSubobject(MostDerivedClass, CharUnits::Zero()),
165 /*IsVirtual=*/false,
Anders Carlsson27860db2010-06-04 00:54:04 +0000166 MostDerivedClassOffset, SubobjectOffsets,
167 SubobjectLayoutClassOffsets, SubobjectCounts);
168
169 // Get the the final overriders.
170 CXXFinalOverriderMap FinalOverriders;
171 MostDerivedClass->getFinalOverriders(FinalOverriders);
172
173 for (CXXFinalOverriderMap::const_iterator I = FinalOverriders.begin(),
174 E = FinalOverriders.end(); I != E; ++I) {
175 const CXXMethodDecl *MD = I->first;
176 const OverridingMethods& Methods = I->second;
177
178 for (OverridingMethods::const_iterator I = Methods.begin(),
179 E = Methods.end(); I != E; ++I) {
180 unsigned SubobjectNumber = I->first;
181 assert(SubobjectOffsets.count(std::make_pair(MD->getParent(),
182 SubobjectNumber)) &&
183 "Did not find subobject offset!");
184
185 uint64_t BaseOffset = SubobjectOffsets[std::make_pair(MD->getParent(),
186 SubobjectNumber)];
187
188 assert(I->second.size() == 1 && "Final overrider is not unique!");
189 const UniqueVirtualMethod &Method = I->second.front();
190
191 const CXXRecordDecl *OverriderRD = Method.Method->getParent();
192 assert(SubobjectLayoutClassOffsets.count(
193 std::make_pair(OverriderRD, Method.Subobject))
194 && "Did not find subobject offset!");
195 uint64_t OverriderOffset =
196 SubobjectLayoutClassOffsets[std::make_pair(OverriderRD,
197 Method.Subobject)];
198
199 OverriderInfo& Overrider = OverridersMap[std::make_pair(MD, BaseOffset)];
200 assert(!Overrider.Method && "Overrider should not exist yet!");
201
202 Overrider.Offset = OverriderOffset;
203 Overrider.Method = Method.Method;
204 }
205 }
Anders Carlsson603d7d12010-02-27 20:02:53 +0000206
207#if DUMP_OVERRIDERS
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000208 // And dump them (for now).
209 dump();
Anders Carlsson603d7d12010-02-27 20:02:53 +0000210#endif
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000211}
212
Anders Carlsson075056a2010-02-23 01:34:28 +0000213static BaseOffset ComputeBaseOffset(ASTContext &Context,
214 const CXXRecordDecl *DerivedRD,
215 const CXXBasePath &Path) {
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000216 int64_t NonVirtualOffset = 0;
Anders Carlssoneee53d92010-02-13 02:02:03 +0000217
Anders Carlssonf3f67842010-02-13 20:41:15 +0000218 unsigned NonVirtualStart = 0;
219 const CXXRecordDecl *VirtualBase = 0;
220
221 // First, look for the virtual base class.
222 for (unsigned I = 0, E = Path.size(); I != E; ++I) {
223 const CXXBasePathElement &Element = Path[I];
224
225 if (Element.Base->isVirtual()) {
226 // FIXME: Can we break when we find the first virtual base?
227 // (If we can't, can't we just iterate over the path in reverse order?)
228 NonVirtualStart = I + 1;
229 QualType VBaseType = Element.Base->getType();
230 VirtualBase =
231 cast<CXXRecordDecl>(VBaseType->getAs<RecordType>()->getDecl());
232 }
233 }
234
235 // Now compute the non-virtual offset.
236 for (unsigned I = NonVirtualStart, E = Path.size(); I != E; ++I) {
237 const CXXBasePathElement &Element = Path[I];
Anders Carlssoneee53d92010-02-13 02:02:03 +0000238
239 // Check the base class offset.
240 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Element.Class);
Anders Carlssoned7d0e82010-02-25 22:18:35 +0000241
Anders Carlssoneee53d92010-02-13 02:02:03 +0000242 const RecordType *BaseType = Element.Base->getType()->getAs<RecordType>();
243 const CXXRecordDecl *Base = cast<CXXRecordDecl>(BaseType->getDecl());
Anders Carlssoned7d0e82010-02-25 22:18:35 +0000244
Anders Carlssonfd88a612010-10-31 23:22:37 +0000245 NonVirtualOffset += Layout.getBaseClassOffsetInBits(Base);
Anders Carlssoneee53d92010-02-13 02:02:03 +0000246 }
247
248 // FIXME: This should probably use CharUnits or something. Maybe we should
249 // even change the base offsets in ASTRecordLayout to be specified in
250 // CharUnits.
Anders Carlsson075056a2010-02-23 01:34:28 +0000251 return BaseOffset(DerivedRD, VirtualBase, NonVirtualOffset / 8);
Anders Carlsson258a1e32010-02-14 00:16:19 +0000252
253}
254
Anders Carlsson075056a2010-02-23 01:34:28 +0000255static BaseOffset ComputeBaseOffset(ASTContext &Context,
256 const CXXRecordDecl *BaseRD,
257 const CXXRecordDecl *DerivedRD) {
Anders Carlsson258a1e32010-02-14 00:16:19 +0000258 CXXBasePaths Paths(/*FindAmbiguities=*/false,
259 /*RecordPaths=*/true, /*DetectVirtual=*/false);
260
261 if (!const_cast<CXXRecordDecl *>(DerivedRD)->
262 isDerivedFrom(const_cast<CXXRecordDecl *>(BaseRD), Paths)) {
263 assert(false && "Class must be derived from the passed in base class!");
Anders Carlsson075056a2010-02-23 01:34:28 +0000264 return BaseOffset();
Anders Carlsson258a1e32010-02-14 00:16:19 +0000265 }
266
267 return ComputeBaseOffset(Context, DerivedRD, Paths.front());
Anders Carlssoneee53d92010-02-13 02:02:03 +0000268}
269
Anders Carlsson075056a2010-02-23 01:34:28 +0000270static BaseOffset
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000271ComputeReturnAdjustmentBaseOffset(ASTContext &Context,
272 const CXXMethodDecl *DerivedMD,
273 const CXXMethodDecl *BaseMD) {
Anders Carlssoneee53d92010-02-13 02:02:03 +0000274 const FunctionType *BaseFT = BaseMD->getType()->getAs<FunctionType>();
275 const FunctionType *DerivedFT = DerivedMD->getType()->getAs<FunctionType>();
276
277 // Canonicalize the return types.
278 CanQualType CanDerivedReturnType =
279 Context.getCanonicalType(DerivedFT->getResultType());
280 CanQualType CanBaseReturnType =
281 Context.getCanonicalType(BaseFT->getResultType());
282
283 assert(CanDerivedReturnType->getTypeClass() ==
284 CanBaseReturnType->getTypeClass() &&
285 "Types must have same type class!");
286
287 if (CanDerivedReturnType == CanBaseReturnType) {
288 // No adjustment needed.
Anders Carlsson075056a2010-02-23 01:34:28 +0000289 return BaseOffset();
Anders Carlssoneee53d92010-02-13 02:02:03 +0000290 }
291
292 if (isa<ReferenceType>(CanDerivedReturnType)) {
293 CanDerivedReturnType =
294 CanDerivedReturnType->getAs<ReferenceType>()->getPointeeType();
295 CanBaseReturnType =
296 CanBaseReturnType->getAs<ReferenceType>()->getPointeeType();
297 } else if (isa<PointerType>(CanDerivedReturnType)) {
298 CanDerivedReturnType =
299 CanDerivedReturnType->getAs<PointerType>()->getPointeeType();
300 CanBaseReturnType =
301 CanBaseReturnType->getAs<PointerType>()->getPointeeType();
302 } else {
303 assert(false && "Unexpected return type!");
304 }
305
306 // We need to compare unqualified types here; consider
307 // const T *Base::foo();
308 // T *Derived::foo();
309 if (CanDerivedReturnType.getUnqualifiedType() ==
310 CanBaseReturnType.getUnqualifiedType()) {
311 // No adjustment needed.
Anders Carlsson075056a2010-02-23 01:34:28 +0000312 return BaseOffset();
Anders Carlssoneee53d92010-02-13 02:02:03 +0000313 }
314
315 const CXXRecordDecl *DerivedRD =
316 cast<CXXRecordDecl>(cast<RecordType>(CanDerivedReturnType)->getDecl());
317
318 const CXXRecordDecl *BaseRD =
319 cast<CXXRecordDecl>(cast<RecordType>(CanBaseReturnType)->getDecl());
320
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000321 return ComputeBaseOffset(Context, BaseRD, DerivedRD);
Anders Carlssoneee53d92010-02-13 02:02:03 +0000322}
323
Anders Carlsson27860db2010-06-04 00:54:04 +0000324void
325FinalOverriders::ComputeBaseOffsets(BaseSubobject Base, bool IsVirtual,
326 uint64_t OffsetInLayoutClass,
327 SubobjectOffsetMapTy &SubobjectOffsets,
328 SubobjectOffsetMapTy &SubobjectLayoutClassOffsets,
329 SubobjectCountMapTy &SubobjectCounts) {
330 const CXXRecordDecl *RD = Base.getBase();
331
332 unsigned SubobjectNumber = 0;
333 if (!IsVirtual)
334 SubobjectNumber = ++SubobjectCounts[RD];
335
336 // Set up the subobject to offset mapping.
337 assert(!SubobjectOffsets.count(std::make_pair(RD, SubobjectNumber))
338 && "Subobject offset already exists!");
339 assert(!SubobjectLayoutClassOffsets.count(std::make_pair(RD, SubobjectNumber))
340 && "Subobject offset already exists!");
341
342 SubobjectOffsets[std::make_pair(RD, SubobjectNumber)] =
Ken Dyck16ffcac2011-03-24 01:21:01 +0000343 Context.toBits(Base.getBaseOffset());
Anders Carlsson27860db2010-06-04 00:54:04 +0000344 SubobjectLayoutClassOffsets[std::make_pair(RD, SubobjectNumber)] =
345 OffsetInLayoutClass;
346
347 // Traverse our bases.
348 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
349 E = RD->bases_end(); I != E; ++I) {
350 const CXXRecordDecl *BaseDecl =
351 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
352
Ken Dyckce812032011-03-26 00:51:24 +0000353 CharUnits BaseOffset;
354 CharUnits BaseOffsetInLayoutClass;
Anders Carlsson27860db2010-06-04 00:54:04 +0000355 if (I->isVirtual()) {
356 // Check if we've visited this virtual base before.
357 if (SubobjectOffsets.count(std::make_pair(BaseDecl, 0)))
358 continue;
359
360 const ASTRecordLayout &LayoutClassLayout =
361 Context.getASTRecordLayout(LayoutClass);
362
Ken Dyckce812032011-03-26 00:51:24 +0000363 BaseOffset = MostDerivedClassLayout.getVBaseClassOffset(BaseDecl);
Anders Carlsson27860db2010-06-04 00:54:04 +0000364 BaseOffsetInLayoutClass =
Ken Dyckce812032011-03-26 00:51:24 +0000365 LayoutClassLayout.getVBaseClassOffset(BaseDecl);
Anders Carlsson27860db2010-06-04 00:54:04 +0000366 } else {
367 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Ken Dyckce812032011-03-26 00:51:24 +0000368 CharUnits Offset = Layout.getBaseClassOffset(BaseDecl);
Anders Carlsson27860db2010-06-04 00:54:04 +0000369
Ken Dyckce812032011-03-26 00:51:24 +0000370 BaseOffset = Base.getBaseOffset() + Offset;
371 BaseOffsetInLayoutClass =
372 Context.toCharUnitsFromBits(OffsetInLayoutClass) + Offset;
Anders Carlsson27860db2010-06-04 00:54:04 +0000373 }
374
Ken Dyckce812032011-03-26 00:51:24 +0000375 ComputeBaseOffsets(BaseSubobject(BaseDecl, BaseOffset),
376 I->isVirtual(), Context.toBits(BaseOffsetInLayoutClass),
Ken Dyck16ffcac2011-03-24 01:21:01 +0000377 SubobjectOffsets, SubobjectLayoutClassOffsets,
378 SubobjectCounts);
Anders Carlsson27860db2010-06-04 00:54:04 +0000379 }
380}
381
Anders Carlssonfd788402010-06-04 00:59:37 +0000382void FinalOverriders::dump(llvm::raw_ostream &Out, BaseSubobject Base,
383 VisitedVirtualBasesSetTy &VisitedVirtualBases) {
Anders Carlssone8ac42a2010-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 Carlssone8ac42a2010-02-11 21:24:32 +0000389 const CXXRecordDecl *BaseDecl =
390 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
391
Anders Carlsson033d4862010-02-14 17:05:59 +0000392 // Ignore bases that don't have any virtual member functions.
393 if (!BaseDecl->isPolymorphic())
394 continue;
395
Ken Dyck16ffcac2011-03-24 01:21:01 +0000396 CharUnits BaseOffset;
Anders Carlsson6a7e6a42010-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 Dyck16ffcac2011-03-24 01:21:01 +0000403 BaseOffset = MostDerivedClassLayout.getVBaseClassOffset(BaseDecl);
Anders Carlsson6a7e6a42010-02-14 00:37:35 +0000404 } else {
Ken Dyck16ffcac2011-03-24 01:21:01 +0000405 BaseOffset = Layout.getBaseClassOffset(BaseDecl) + Base.getBaseOffset();
Anders Carlsson6a7e6a42010-02-14 00:37:35 +0000406 }
407
Anders Carlssonfd788402010-06-04 00:59:37 +0000408 dump(Out, BaseSubobject(BaseDecl, BaseOffset), VisitedVirtualBases);
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000409 }
410
411 Out << "Final overriders for (" << RD->getQualifiedNameAsString() << ", ";
Ken Dyck16ffcac2011-03-24 01:21:01 +0000412 Out << Base.getBaseOffset().getQuantity() << ")\n";
Anders Carlssone8ac42a2010-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 Dyck16ffcac2011-03-24 01:21:01 +0000422 OverriderInfo Overrider =
423 getOverrider(MD, Context.toBits(Base.getBaseOffset()));
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000424
Anders Carlsson6f1f0022010-03-02 03:44:06 +0000425 Out << " " << MD->getQualifiedNameAsString() << " - (";
Anders Carlsson8e661e12010-02-12 17:13:23 +0000426 Out << Overrider.Method->getQualifiedNameAsString();
Anders Carlsson3c289672010-03-12 05:02:01 +0000427 Out << ", " << ", " << Overrider.Offset / 8 << ')';
Anders Carlsson6f1f0022010-03-02 03:44:06 +0000428
Anders Carlsson042ce2d82010-06-01 23:47:05 +0000429 BaseOffset Offset;
430 if (!Overrider.Method->isPure())
431 Offset = ComputeReturnAdjustmentBaseOffset(Context, Overrider.Method, MD);
Anders Carlssonf3f67842010-02-13 20:41:15 +0000432
Anders Carlsson042ce2d82010-06-01 23:47:05 +0000433 if (!Offset.isEmpty()) {
Anders Carlssonf3f67842010-02-13 20:41:15 +0000434 Out << " [ret-adj: ";
435 if (Offset.VirtualBase)
436 Out << Offset.VirtualBase->getQualifiedNameAsString() << " vbase, ";
Anders Carlssoneee53d92010-02-13 02:02:03 +0000437
Anders Carlssonf3f67842010-02-13 20:41:15 +0000438 Out << Offset.NonVirtualOffset << " nv]";
Anders Carlssoneee53d92010-02-13 02:02:03 +0000439 }
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000440
Anders Carlsson8e661e12010-02-12 17:13:23 +0000441 Out << "\n";
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000442 }
443}
444
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000445/// VTableComponent - Represents a single component in a vtable.
446class VTableComponent {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000447public:
448 enum Kind {
449 CK_VCallOffset,
450 CK_VBaseOffset,
451 CK_OffsetToTop,
452 CK_RTTI,
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000453 CK_FunctionPointer,
454
455 /// CK_CompleteDtorPointer - A pointer to the complete destructor.
456 CK_CompleteDtorPointer,
457
458 /// CK_DeletingDtorPointer - A pointer to the deleting destructor.
Anders Carlsson350b56e2010-02-19 20:08:13 +0000459 CK_DeletingDtorPointer,
460
461 /// CK_UnusedFunctionPointer - In some cases, a vtable function pointer
462 /// will end up never being called. Such vtable function pointers are
463 /// represented as a CK_UnusedFunctionPointer.
464 CK_UnusedFunctionPointer
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000465 };
466
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000467 static VTableComponent MakeVCallOffset(int64_t Offset) {
468 return VTableComponent(CK_VCallOffset, Offset);
Anders Carlssonb0a588f2010-02-17 06:07:19 +0000469 }
470
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000471 static VTableComponent MakeVBaseOffset(int64_t Offset) {
472 return VTableComponent(CK_VBaseOffset, Offset);
Anders Carlssondc2dba32010-02-16 04:49:44 +0000473 }
474
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000475 static VTableComponent MakeOffsetToTop(int64_t Offset) {
476 return VTableComponent(CK_OffsetToTop, Offset);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000477 }
478
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000479 static VTableComponent MakeRTTI(const CXXRecordDecl *RD) {
480 return VTableComponent(CK_RTTI, reinterpret_cast<uintptr_t>(RD));
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000481 }
482
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000483 static VTableComponent MakeFunction(const CXXMethodDecl *MD) {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000484 assert(!isa<CXXDestructorDecl>(MD) &&
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000485 "Don't use MakeFunction with destructors!");
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000486
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000487 return VTableComponent(CK_FunctionPointer,
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000488 reinterpret_cast<uintptr_t>(MD));
489 }
490
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000491 static VTableComponent MakeCompleteDtor(const CXXDestructorDecl *DD) {
492 return VTableComponent(CK_CompleteDtorPointer,
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000493 reinterpret_cast<uintptr_t>(DD));
494 }
495
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000496 static VTableComponent MakeDeletingDtor(const CXXDestructorDecl *DD) {
497 return VTableComponent(CK_DeletingDtorPointer,
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000498 reinterpret_cast<uintptr_t>(DD));
499 }
500
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000501 static VTableComponent MakeUnusedFunction(const CXXMethodDecl *MD) {
Anders Carlsson350b56e2010-02-19 20:08:13 +0000502 assert(!isa<CXXDestructorDecl>(MD) &&
503 "Don't use MakeUnusedFunction with destructors!");
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000504 return VTableComponent(CK_UnusedFunctionPointer,
Anders Carlsson350b56e2010-02-19 20:08:13 +0000505 reinterpret_cast<uintptr_t>(MD));
506 }
507
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000508 static VTableComponent getFromOpaqueInteger(uint64_t I) {
509 return VTableComponent(I);
Anders Carlssona5736bd2010-03-25 16:49:53 +0000510 }
511
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000512 /// getKind - Get the kind of this vtable component.
513 Kind getKind() const {
514 return (Kind)(Value & 0x7);
515 }
516
Anders Carlssonb0a588f2010-02-17 06:07:19 +0000517 int64_t getVCallOffset() const {
518 assert(getKind() == CK_VCallOffset && "Invalid component kind!");
519
520 return getOffset();
521 }
522
Anders Carlssondc2dba32010-02-16 04:49:44 +0000523 int64_t getVBaseOffset() const {
524 assert(getKind() == CK_VBaseOffset && "Invalid component kind!");
525
526 return getOffset();
527 }
528
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000529 int64_t getOffsetToTop() const {
530 assert(getKind() == CK_OffsetToTop && "Invalid component kind!");
531
532 return getOffset();
533 }
534
535 const CXXRecordDecl *getRTTIDecl() const {
536 assert(getKind() == CK_RTTI && "Invalid component kind!");
537
538 return reinterpret_cast<CXXRecordDecl *>(getPointer());
539 }
540
541 const CXXMethodDecl *getFunctionDecl() const {
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000542 assert(getKind() == CK_FunctionPointer);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000543
544 return reinterpret_cast<CXXMethodDecl *>(getPointer());
545 }
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000546
547 const CXXDestructorDecl *getDestructorDecl() const {
548 assert((getKind() == CK_CompleteDtorPointer ||
549 getKind() == CK_DeletingDtorPointer) && "Invalid component kind!");
550
551 return reinterpret_cast<CXXDestructorDecl *>(getPointer());
552 }
553
Anders Carlsson350b56e2010-02-19 20:08:13 +0000554 const CXXMethodDecl *getUnusedFunctionDecl() const {
555 assert(getKind() == CK_UnusedFunctionPointer);
556
557 return reinterpret_cast<CXXMethodDecl *>(getPointer());
558 }
559
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000560private:
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000561 VTableComponent(Kind ComponentKind, int64_t Offset) {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000562 assert((ComponentKind == CK_VCallOffset ||
563 ComponentKind == CK_VBaseOffset ||
564 ComponentKind == CK_OffsetToTop) && "Invalid component kind!");
565 assert(Offset <= ((1LL << 56) - 1) && "Offset is too big!");
566
567 Value = ((Offset << 3) | ComponentKind);
568 }
569
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000570 VTableComponent(Kind ComponentKind, uintptr_t Ptr) {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000571 assert((ComponentKind == CK_RTTI ||
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000572 ComponentKind == CK_FunctionPointer ||
573 ComponentKind == CK_CompleteDtorPointer ||
Anders Carlsson350b56e2010-02-19 20:08:13 +0000574 ComponentKind == CK_DeletingDtorPointer ||
575 ComponentKind == CK_UnusedFunctionPointer) &&
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000576 "Invalid component kind!");
577
578 assert((Ptr & 7) == 0 && "Pointer not sufficiently aligned!");
579
580 Value = Ptr | ComponentKind;
581 }
582
583 int64_t getOffset() const {
584 assert((getKind() == CK_VCallOffset || getKind() == CK_VBaseOffset ||
585 getKind() == CK_OffsetToTop) && "Invalid component kind!");
586
587 return Value >> 3;
588 }
589
590 uintptr_t getPointer() const {
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000591 assert((getKind() == CK_RTTI ||
592 getKind() == CK_FunctionPointer ||
593 getKind() == CK_CompleteDtorPointer ||
Anders Carlsson350b56e2010-02-19 20:08:13 +0000594 getKind() == CK_DeletingDtorPointer ||
595 getKind() == CK_UnusedFunctionPointer) &&
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000596 "Invalid component kind!");
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000597
598 return static_cast<uintptr_t>(Value & ~7ULL);
599 }
600
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000601 explicit VTableComponent(uint64_t Value)
Anders Carlssona5736bd2010-03-25 16:49:53 +0000602 : Value(Value) { }
603
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000604 /// The kind is stored in the lower 3 bits of the value. For offsets, we
605 /// make use of the facts that classes can't be larger than 2^55 bytes,
606 /// so we store the offset in the lower part of the 61 bytes that remain.
607 /// (The reason that we're not simply using a PointerIntPair here is that we
608 /// need the offsets to be 64-bit, even when on a 32-bit machine).
609 int64_t Value;
610};
611
Anders Carlsson78277c72010-02-18 17:00:09 +0000612/// VCallOffsetMap - Keeps track of vcall offsets when building a vtable.
613struct VCallOffsetMap {
614
615 typedef std::pair<const CXXMethodDecl *, int64_t> MethodAndOffsetPairTy;
616
617 /// Offsets - Keeps track of methods and their offsets.
618 // FIXME: This should be a real map and not a vector.
619 llvm::SmallVector<MethodAndOffsetPairTy, 16> Offsets;
620
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000621 /// MethodsCanShareVCallOffset - Returns whether two virtual member functions
622 /// can share the same vcall offset.
623 static bool MethodsCanShareVCallOffset(const CXXMethodDecl *LHS,
624 const CXXMethodDecl *RHS);
625
Anders Carlsson78277c72010-02-18 17:00:09 +0000626public:
627 /// AddVCallOffset - Adds a vcall offset to the map. Returns true if the
628 /// add was successful, or false if there was already a member function with
629 /// the same signature in the map.
630 bool AddVCallOffset(const CXXMethodDecl *MD, int64_t OffsetOffset);
631
632 /// getVCallOffsetOffset - Returns the vcall offset offset (relative to the
633 /// vtable address point) for the given virtual member function.
634 int64_t getVCallOffsetOffset(const CXXMethodDecl *MD);
635
Anders Carlsson9e3b3a32010-02-25 22:23:13 +0000636 // empty - Return whether the offset map is empty or not.
637 bool empty() const { return Offsets.empty(); }
Anders Carlsson78277c72010-02-18 17:00:09 +0000638};
639
John McCall43c6ffb2010-02-26 20:22:44 +0000640static bool HasSameVirtualSignature(const CXXMethodDecl *LHS,
641 const CXXMethodDecl *RHS) {
642 ASTContext &C = LHS->getASTContext(); // TODO: thread this down
643 CanQual<FunctionProtoType>
644 LT = C.getCanonicalType(LHS->getType()).getAs<FunctionProtoType>(),
645 RT = C.getCanonicalType(RHS->getType()).getAs<FunctionProtoType>();
646
647 // Fast-path matches in the canonical types.
648 if (LT == RT) return true;
649
650 // Force the signatures to match. We can't rely on the overrides
651 // list here because there isn't necessarily an inheritance
652 // relationship between the two methods.
653 if (LT.getQualifiers() != RT.getQualifiers() ||
654 LT->getNumArgs() != RT->getNumArgs())
655 return false;
656 for (unsigned I = 0, E = LT->getNumArgs(); I != E; ++I)
657 if (LT->getArgType(I) != RT->getArgType(I))
658 return false;
659 return true;
660}
661
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000662bool VCallOffsetMap::MethodsCanShareVCallOffset(const CXXMethodDecl *LHS,
663 const CXXMethodDecl *RHS) {
664 assert(LHS->isVirtual() && "LHS must be virtual!");
665 assert(RHS->isVirtual() && "LHS must be virtual!");
666
Anders Carlssond69b2f92010-02-27 04:12:52 +0000667 // A destructor can share a vcall offset with another destructor.
668 if (isa<CXXDestructorDecl>(LHS))
669 return isa<CXXDestructorDecl>(RHS);
670
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000671 // FIXME: We need to check more things here.
672
Anders Carlssond69b2f92010-02-27 04:12:52 +0000673 // The methods must have the same name.
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000674 DeclarationName LHSName = LHS->getDeclName();
675 DeclarationName RHSName = RHS->getDeclName();
John McCall43c6ffb2010-02-26 20:22:44 +0000676 if (LHSName != RHSName)
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000677 return false;
John McCall43c6ffb2010-02-26 20:22:44 +0000678
Anders Carlssond69b2f92010-02-27 04:12:52 +0000679 // And the same signatures.
680 return HasSameVirtualSignature(LHS, RHS);
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000681}
682
Anders Carlsson78277c72010-02-18 17:00:09 +0000683bool VCallOffsetMap::AddVCallOffset(const CXXMethodDecl *MD,
684 int64_t OffsetOffset) {
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000685 // Check if we can reuse an offset.
686 for (unsigned I = 0, E = Offsets.size(); I != E; ++I) {
687 if (MethodsCanShareVCallOffset(Offsets[I].first, MD))
688 return false;
689 }
690
691 // Add the offset.
692 Offsets.push_back(MethodAndOffsetPairTy(MD, OffsetOffset));
Anders Carlsson78277c72010-02-18 17:00:09 +0000693 return true;
694}
695
696int64_t VCallOffsetMap::getVCallOffsetOffset(const CXXMethodDecl *MD) {
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000697 // Look for an offset.
698 for (unsigned I = 0, E = Offsets.size(); I != E; ++I) {
699 if (MethodsCanShareVCallOffset(Offsets[I].first, MD))
700 return Offsets[I].second;
701 }
702
703 assert(false && "Should always find a vcall offset offset!");
Anders Carlsson78277c72010-02-18 17:00:09 +0000704 return 0;
705}
706
Anders Carlsson422f7782010-02-25 03:45:56 +0000707/// VCallAndVBaseOffsetBuilder - Class for building vcall and vbase offsets.
708class VCallAndVBaseOffsetBuilder {
Anders Carlssondd819c92010-03-11 16:06:20 +0000709public:
710 typedef llvm::DenseMap<const CXXRecordDecl *, int64_t>
711 VBaseOffsetOffsetsMapTy;
712
713private:
Anders Carlssone3385f52010-02-28 01:43:58 +0000714 /// MostDerivedClass - The most derived class for which we're building vcall
715 /// and vbase offsets.
Anders Carlsson422f7782010-02-25 03:45:56 +0000716 const CXXRecordDecl *MostDerivedClass;
717
Anders Carlssonc3f92a12010-02-27 21:09:00 +0000718 /// LayoutClass - The class we're using for layout information. Will be
719 /// different than the most derived class if we're building a construction
720 /// vtable.
721 const CXXRecordDecl *LayoutClass;
722
Anders Carlsson422f7782010-02-25 03:45:56 +0000723 /// Context - The ASTContext which we will use for layout information.
724 ASTContext &Context;
725
726 /// Components - vcall and vbase offset components
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000727 typedef llvm::SmallVector<VTableComponent, 64> VTableComponentVectorTy;
728 VTableComponentVectorTy Components;
Anders Carlsson422f7782010-02-25 03:45:56 +0000729
730 /// VisitedVirtualBases - Visited virtual bases.
731 llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBases;
732
733 /// VCallOffsets - Keeps track of vcall offsets.
734 VCallOffsetMap VCallOffsets;
735
Anders Carlsson7f6b71e2010-03-11 06:43:12 +0000736
737 /// VBaseOffsetOffsets - Contains the offsets of the virtual base offsets,
738 /// relative to the address point.
739 VBaseOffsetOffsetsMapTy VBaseOffsetOffsets;
740
Anders Carlsson422f7782010-02-25 03:45:56 +0000741 /// FinalOverriders - The final overriders of the most derived class.
742 /// (Can be null when we're not building a vtable of the most derived class).
743 const FinalOverriders *Overriders;
744
745 /// AddVCallAndVBaseOffsets - Add vcall offsets and vbase offsets for the
746 /// given base subobject.
747 void AddVCallAndVBaseOffsets(BaseSubobject Base, bool BaseIsVirtual,
748 uint64_t RealBaseOffset);
749
750 /// AddVCallOffsets - Add vcall offsets for the given base subobject.
751 void AddVCallOffsets(BaseSubobject Base, uint64_t VBaseOffset);
752
753 /// AddVBaseOffsets - Add vbase offsets for the given class.
Anders Carlsson93b1b492010-03-02 05:40:45 +0000754 void AddVBaseOffsets(const CXXRecordDecl *Base, uint64_t OffsetInLayoutClass);
Anders Carlsson422f7782010-02-25 03:45:56 +0000755
Anders Carlsson7f6b71e2010-03-11 06:43:12 +0000756 /// getCurrentOffsetOffset - Get the current vcall or vbase offset offset in
757 /// bytes, relative to the vtable address point.
758 int64_t getCurrentOffsetOffset() const;
759
Anders Carlsson422f7782010-02-25 03:45:56 +0000760public:
761 VCallAndVBaseOffsetBuilder(const CXXRecordDecl *MostDerivedClass,
Anders Carlssonc3f92a12010-02-27 21:09:00 +0000762 const CXXRecordDecl *LayoutClass,
Anders Carlsson422f7782010-02-25 03:45:56 +0000763 const FinalOverriders *Overriders,
Anders Carlssone3385f52010-02-28 01:43:58 +0000764 BaseSubobject Base, bool BaseIsVirtual,
765 uint64_t OffsetInLayoutClass)
766 : MostDerivedClass(MostDerivedClass), LayoutClass(LayoutClass),
Anders Carlsson422f7782010-02-25 03:45:56 +0000767 Context(MostDerivedClass->getASTContext()), Overriders(Overriders) {
768
769 // Add vcall and vbase offsets.
Anders Carlssone3385f52010-02-28 01:43:58 +0000770 AddVCallAndVBaseOffsets(Base, BaseIsVirtual, OffsetInLayoutClass);
Anders Carlsson422f7782010-02-25 03:45:56 +0000771 }
772
773 /// Methods for iterating over the components.
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000774 typedef VTableComponentVectorTy::const_reverse_iterator const_iterator;
Anders Carlsson422f7782010-02-25 03:45:56 +0000775 const_iterator components_begin() const { return Components.rbegin(); }
776 const_iterator components_end() const { return Components.rend(); }
777
Anders Carlssondd819c92010-03-11 16:06:20 +0000778 const VCallOffsetMap &getVCallOffsets() const { return VCallOffsets; }
779 const VBaseOffsetOffsetsMapTy &getVBaseOffsetOffsets() const {
Anders Carlsson7f6b71e2010-03-11 06:43:12 +0000780 return VBaseOffsetOffsets;
781 }
Anders Carlsson422f7782010-02-25 03:45:56 +0000782};
783
784void
785VCallAndVBaseOffsetBuilder::AddVCallAndVBaseOffsets(BaseSubobject Base,
786 bool BaseIsVirtual,
787 uint64_t RealBaseOffset) {
788 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Base.getBase());
789
790 // Itanium C++ ABI 2.5.2:
791 // ..in classes sharing a virtual table with a primary base class, the vcall
792 // and vbase offsets added by the derived class all come before the vcall
793 // and vbase offsets required by the base class, so that the latter may be
794 // laid out as required by the base class without regard to additions from
795 // the derived class(es).
796
797 // (Since we're emitting the vcall and vbase offsets in reverse order, we'll
798 // emit them for the primary base first).
799 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
Anders Carlsson7f95cd12010-11-24 23:12:57 +0000800 bool PrimaryBaseIsVirtual = Layout.isPrimaryBaseVirtual();
Anders Carlsson422f7782010-02-25 03:45:56 +0000801
Ken Dyckce812032011-03-26 00:51:24 +0000802 CharUnits PrimaryBaseOffset;
Anders Carlsson422f7782010-02-25 03:45:56 +0000803
804 // Get the base offset of the primary base.
805 if (PrimaryBaseIsVirtual) {
Anders Carlssonfd88a612010-10-31 23:22:37 +0000806 assert(Layout.getVBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlsson422f7782010-02-25 03:45:56 +0000807 "Primary vbase should have a zero offset!");
808
809 const ASTRecordLayout &MostDerivedClassLayout =
810 Context.getASTRecordLayout(MostDerivedClass);
811
812 PrimaryBaseOffset =
Ken Dyckce812032011-03-26 00:51:24 +0000813 MostDerivedClassLayout.getVBaseClassOffset(PrimaryBase);
Anders Carlsson422f7782010-02-25 03:45:56 +0000814 } else {
Anders Carlssonfd88a612010-10-31 23:22:37 +0000815 assert(Layout.getBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlsson422f7782010-02-25 03:45:56 +0000816 "Primary base should have a zero offset!");
817
Ken Dyckce812032011-03-26 00:51:24 +0000818 PrimaryBaseOffset = Base.getBaseOffset();
Anders Carlsson422f7782010-02-25 03:45:56 +0000819 }
820
Ken Dyck16ffcac2011-03-24 01:21:01 +0000821 AddVCallAndVBaseOffsets(
Ken Dyckce812032011-03-26 00:51:24 +0000822 BaseSubobject(PrimaryBase,PrimaryBaseOffset),
Ken Dyck16ffcac2011-03-24 01:21:01 +0000823 PrimaryBaseIsVirtual, RealBaseOffset);
Anders Carlsson422f7782010-02-25 03:45:56 +0000824 }
825
Anders Carlsson93b1b492010-03-02 05:40:45 +0000826 AddVBaseOffsets(Base.getBase(), RealBaseOffset);
Anders Carlsson422f7782010-02-25 03:45:56 +0000827
828 // We only want to add vcall offsets for virtual bases.
829 if (BaseIsVirtual)
830 AddVCallOffsets(Base, RealBaseOffset);
831}
832
Anders Carlsson7f6b71e2010-03-11 06:43:12 +0000833int64_t VCallAndVBaseOffsetBuilder::getCurrentOffsetOffset() const {
834 // OffsetIndex is the index of this vcall or vbase offset, relative to the
835 // vtable address point. (We subtract 3 to account for the information just
836 // above the address point, the RTTI info, the offset to top, and the
837 // vcall offset itself).
838 int64_t OffsetIndex = -(int64_t)(3 + Components.size());
839
840 // FIXME: We shouldn't use / 8 here.
841 int64_t OffsetOffset = OffsetIndex *
842 (int64_t)Context.Target.getPointerWidth(0) / 8;
843
844 return OffsetOffset;
845}
846
Anders Carlsson422f7782010-02-25 03:45:56 +0000847void VCallAndVBaseOffsetBuilder::AddVCallOffsets(BaseSubobject Base,
848 uint64_t VBaseOffset) {
849 const CXXRecordDecl *RD = Base.getBase();
850 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
851
John McCall43c6ffb2010-02-26 20:22:44 +0000852 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
853
Anders Carlsson422f7782010-02-25 03:45:56 +0000854 // Handle the primary base first.
Anders Carlsson343a26b2010-04-11 20:04:11 +0000855 // We only want to add vcall offsets if the base is non-virtual; a virtual
856 // primary base will have its vcall and vbase offsets emitted already.
Anders Carlsson7f95cd12010-11-24 23:12:57 +0000857 if (PrimaryBase && !Layout.isPrimaryBaseVirtual()) {
Anders Carlsson422f7782010-02-25 03:45:56 +0000858 // Get the base offset of the primary base.
Anders Carlssonfd88a612010-10-31 23:22:37 +0000859 assert(Layout.getBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlsson343a26b2010-04-11 20:04:11 +0000860 "Primary base should have a zero offset!");
Anders Carlsson422f7782010-02-25 03:45:56 +0000861
Anders Carlsson343a26b2010-04-11 20:04:11 +0000862 AddVCallOffsets(BaseSubobject(PrimaryBase, Base.getBaseOffset()),
Anders Carlsson422f7782010-02-25 03:45:56 +0000863 VBaseOffset);
864 }
Anders Carlsson343a26b2010-04-11 20:04:11 +0000865
Anders Carlsson422f7782010-02-25 03:45:56 +0000866 // Add the vcall offsets.
867 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
868 E = RD->method_end(); I != E; ++I) {
869 const CXXMethodDecl *MD = *I;
870
871 if (!MD->isVirtual())
872 continue;
873
Anders Carlsson7f6b71e2010-03-11 06:43:12 +0000874 int64_t OffsetOffset = getCurrentOffsetOffset();
Anders Carlsson422f7782010-02-25 03:45:56 +0000875
876 // Don't add a vcall offset if we already have one for this member function
877 // signature.
878 if (!VCallOffsets.AddVCallOffset(MD, OffsetOffset))
879 continue;
880
881 int64_t Offset = 0;
882
883 if (Overriders) {
884 // Get the final overrider.
885 FinalOverriders::OverriderInfo Overrider =
Ken Dyck16ffcac2011-03-24 01:21:01 +0000886 Overriders->getOverrider(MD, Context.toBits(Base.getBaseOffset()));
Anders Carlsson422f7782010-02-25 03:45:56 +0000887
Anders Carlsson31f595f2010-02-28 00:10:58 +0000888 /// The vcall offset is the offset from the virtual base to the object
889 /// where the function was overridden.
Anders Carlsson422f7782010-02-25 03:45:56 +0000890 // FIXME: We should not use / 8 here.
Anders Carlsson6f1f0022010-03-02 03:44:06 +0000891 Offset = (int64_t)(Overrider.Offset - VBaseOffset) / 8;
Anders Carlsson422f7782010-02-25 03:45:56 +0000892 }
893
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000894 Components.push_back(VTableComponent::MakeVCallOffset(Offset));
Anders Carlsson422f7782010-02-25 03:45:56 +0000895 }
896
897 // And iterate over all non-virtual bases (ignoring the primary base).
898 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
899 E = RD->bases_end(); I != E; ++I) {
900
901 if (I->isVirtual())
902 continue;
903
904 const CXXRecordDecl *BaseDecl =
905 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
John McCall43c6ffb2010-02-26 20:22:44 +0000906 if (BaseDecl == PrimaryBase)
907 continue;
Anders Carlsson422f7782010-02-25 03:45:56 +0000908
909 // Get the base offset of this base.
Ken Dyckce812032011-03-26 00:51:24 +0000910 CharUnits BaseOffset = Base.getBaseOffset() +
911 Layout.getBaseClassOffset(BaseDecl);
Anders Carlsson422f7782010-02-25 03:45:56 +0000912
Ken Dyckce812032011-03-26 00:51:24 +0000913 AddVCallOffsets(BaseSubobject(BaseDecl, BaseOffset),
914 VBaseOffset);
Anders Carlsson422f7782010-02-25 03:45:56 +0000915 }
916}
917
Anders Carlsson422f7782010-02-25 03:45:56 +0000918void VCallAndVBaseOffsetBuilder::AddVBaseOffsets(const CXXRecordDecl *RD,
Anders Carlsson93b1b492010-03-02 05:40:45 +0000919 uint64_t OffsetInLayoutClass) {
Anders Carlssonc3f92a12010-02-27 21:09:00 +0000920 const ASTRecordLayout &LayoutClassLayout =
921 Context.getASTRecordLayout(LayoutClass);
Anders Carlsson422f7782010-02-25 03:45:56 +0000922
923 // Add vbase offsets.
924 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
925 E = RD->bases_end(); I != E; ++I) {
926 const CXXRecordDecl *BaseDecl =
927 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
928
929 // Check if this is a virtual base that we haven't visited before.
930 if (I->isVirtual() && VisitedVirtualBases.insert(BaseDecl)) {
931 // FIXME: We shouldn't use / 8 here.
Anders Carlsson93b1b492010-03-02 05:40:45 +0000932 int64_t Offset =
Anders Carlssonfd88a612010-10-31 23:22:37 +0000933 (int64_t)(LayoutClassLayout.getVBaseClassOffsetInBits(BaseDecl) -
Anders Carlsson93b1b492010-03-02 05:40:45 +0000934 OffsetInLayoutClass) / 8;
Anders Carlsson7f6b71e2010-03-11 06:43:12 +0000935
936 // Add the vbase offset offset.
937 assert(!VBaseOffsetOffsets.count(BaseDecl) &&
938 "vbase offset offset already exists!");
939
940 int64_t VBaseOffsetOffset = getCurrentOffsetOffset();
941 VBaseOffsetOffsets.insert(std::make_pair(BaseDecl, VBaseOffsetOffset));
942
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000943 Components.push_back(VTableComponent::MakeVBaseOffset(Offset));
Anders Carlsson422f7782010-02-25 03:45:56 +0000944 }
Anders Carlsson7f6b71e2010-03-11 06:43:12 +0000945
Anders Carlsson422f7782010-02-25 03:45:56 +0000946 // Check the base class looking for more vbase offsets.
Anders Carlsson93b1b492010-03-02 05:40:45 +0000947 AddVBaseOffsets(BaseDecl, OffsetInLayoutClass);
Anders Carlsson422f7782010-02-25 03:45:56 +0000948 }
949}
950
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +0000951/// VTableBuilder - Class for building vtable layout information.
952class VTableBuilder {
Anders Carlsson65b49782010-02-12 05:25:12 +0000953public:
Anders Carlssond46ed892010-02-27 16:18:19 +0000954 /// PrimaryBasesSetVectorTy - A set vector of direct and indirect
955 /// primary bases.
956 typedef llvm::SmallSetVector<const CXXRecordDecl *, 8>
957 PrimaryBasesSetVectorTy;
958
Anders Carlssone90954d2010-03-24 16:42:11 +0000959 typedef llvm::DenseMap<const CXXRecordDecl *, int64_t>
960 VBaseOffsetOffsetsMapTy;
Anders Carlssond03325c2010-03-25 00:51:13 +0000961
962 typedef llvm::DenseMap<BaseSubobject, uint64_t>
963 AddressPointsMapTy;
Anders Carlssone90954d2010-03-24 16:42:11 +0000964
Anders Carlsson65b49782010-02-12 05:25:12 +0000965private:
Anders Carlssona864caf2010-03-23 04:11:45 +0000966 /// VTables - Global vtable information.
967 CodeGenVTables &VTables;
Anders Carlssoncf5a8822010-02-13 21:07:32 +0000968
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000969 /// MostDerivedClass - The most derived class for which we're building this
970 /// vtable.
971 const CXXRecordDecl *MostDerivedClass;
972
Anders Carlsson93913752010-02-27 20:39:05 +0000973 /// MostDerivedClassOffset - If we're building a construction vtable, this
974 /// holds the offset from the layout class to the most derived class.
975 const uint64_t MostDerivedClassOffset;
976
Anders Carlsson62c6c722010-02-28 00:36:23 +0000977 /// MostDerivedClassIsVirtual - Whether the most derived class is a virtual
978 /// base. (This only makes sense when building a construction vtable).
979 bool MostDerivedClassIsVirtual;
980
Anders Carlsson93913752010-02-27 20:39:05 +0000981 /// LayoutClass - The class we're using for layout information. Will be
982 /// different than the most derived class if we're building a construction
983 /// vtable.
984 const CXXRecordDecl *LayoutClass;
985
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000986 /// Context - The ASTContext which we will use for layout information.
Anders Carlsson65b49782010-02-12 05:25:12 +0000987 ASTContext &Context;
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000988
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000989 /// FinalOverriders - The final overriders of the most derived class.
Anders Carlsson422f7782010-02-25 03:45:56 +0000990 const FinalOverriders Overriders;
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000991
Anders Carlsson9e3b3a32010-02-25 22:23:13 +0000992 /// VCallOffsetsForVBases - Keeps track of vcall offsets for the virtual
993 /// bases in this vtable.
994 llvm::DenseMap<const CXXRecordDecl *, VCallOffsetMap> VCallOffsetsForVBases;
Anders Carlsson78277c72010-02-18 17:00:09 +0000995
Anders Carlsson7f6b71e2010-03-11 06:43:12 +0000996 /// VBaseOffsetOffsets - Contains the offsets of the virtual base offsets for
997 /// the most derived class.
998 VBaseOffsetOffsetsMapTy VBaseOffsetOffsets;
999
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001000 /// Components - The components of the vtable being built.
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001001 llvm::SmallVector<VTableComponent, 64> Components;
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001002
Anders Carlsson932c2f22010-02-11 17:18:51 +00001003 /// AddressPoints - Address points for the vtable being built.
Anders Carlsson0534b022010-03-25 00:35:49 +00001004 AddressPointsMapTy AddressPoints;
Anders Carlsson932c2f22010-02-11 17:18:51 +00001005
Anders Carlssond46ed892010-02-27 16:18:19 +00001006 /// MethodInfo - Contains information about a method in a vtable.
1007 /// (Used for computing 'this' pointer adjustment thunks.
1008 struct MethodInfo {
1009 /// BaseOffset - The base offset of this method.
1010 const uint64_t BaseOffset;
1011
Anders Carlsson423406f32010-03-10 21:25:37 +00001012 /// BaseOffsetInLayoutClass - The base offset in the layout class of this
1013 /// method.
1014 const uint64_t BaseOffsetInLayoutClass;
1015
Anders Carlssond78b2242010-04-11 22:07:06 +00001016 /// VTableIndex - The index in the vtable that this method has.
Anders Carlssond46ed892010-02-27 16:18:19 +00001017 /// (For destructors, this is the index of the complete destructor).
Anders Carlssond78b2242010-04-11 22:07:06 +00001018 const uint64_t VTableIndex;
Anders Carlssond46ed892010-02-27 16:18:19 +00001019
Anders Carlsson423406f32010-03-10 21:25:37 +00001020 MethodInfo(uint64_t BaseOffset, uint64_t BaseOffsetInLayoutClass,
Anders Carlssond78b2242010-04-11 22:07:06 +00001021 uint64_t VTableIndex)
Anders Carlsson423406f32010-03-10 21:25:37 +00001022 : BaseOffset(BaseOffset),
1023 BaseOffsetInLayoutClass(BaseOffsetInLayoutClass),
Anders Carlssond78b2242010-04-11 22:07:06 +00001024 VTableIndex(VTableIndex) { }
Anders Carlsson40687982010-02-27 16:52:49 +00001025
Anders Carlssond78b2242010-04-11 22:07:06 +00001026 MethodInfo() : BaseOffset(0), BaseOffsetInLayoutClass(0), VTableIndex(0) { }
Anders Carlssond46ed892010-02-27 16:18:19 +00001027 };
1028
1029 typedef llvm::DenseMap<const CXXMethodDecl *, MethodInfo> MethodInfoMapTy;
1030
1031 /// MethodInfoMap - The information for all methods in the vtable we're
1032 /// currently building.
1033 MethodInfoMapTy MethodInfoMap;
1034
Anders Carlssond78b2242010-04-11 22:07:06 +00001035 typedef llvm::DenseMap<uint64_t, ThunkInfo> VTableThunksMapTy;
Anders Carlsson8a240292010-03-12 04:54:20 +00001036
Anders Carlsson7cea12f2010-03-23 04:44:10 +00001037 /// VTableThunks - The thunks by vtable index in the vtable currently being
1038 /// built.
Anders Carlssond78b2242010-04-11 22:07:06 +00001039 VTableThunksMapTy VTableThunks;
Anders Carlssond46ed892010-02-27 16:18:19 +00001040
Anders Carlsson917229c2010-03-23 04:59:02 +00001041 typedef llvm::SmallVector<ThunkInfo, 1> ThunkInfoVectorTy;
1042 typedef llvm::DenseMap<const CXXMethodDecl *, ThunkInfoVectorTy> ThunksMapTy;
Anders Carlsson56446142010-03-17 20:06:32 +00001043
Anders Carlsson7cea12f2010-03-23 04:44:10 +00001044 /// Thunks - A map that contains all the thunks needed for all methods in the
1045 /// most derived class for which the vtable is currently being built.
Anders Carlsson917229c2010-03-23 04:59:02 +00001046 ThunksMapTy Thunks;
Anders Carlsson56446142010-03-17 20:06:32 +00001047
1048 /// AddThunk - Add a thunk for the given method.
Anders Carlsson4b2411e2010-03-21 20:27:14 +00001049 void AddThunk(const CXXMethodDecl *MD, const ThunkInfo &Thunk);
Anders Carlsson56446142010-03-17 20:06:32 +00001050
Anders Carlsson40687982010-02-27 16:52:49 +00001051 /// ComputeThisAdjustments - Compute the 'this' pointer adjustments for the
1052 /// part of the vtable we're currently building.
1053 void ComputeThisAdjustments();
1054
Anders Carlssondc2dba32010-02-16 04:49:44 +00001055 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
1056
Anders Carlssond46ed892010-02-27 16:18:19 +00001057 /// PrimaryVirtualBases - All known virtual bases who are a primary base of
Anders Carlsson0570f712010-02-23 03:48:14 +00001058 /// some other base.
1059 VisitedVirtualBasesSetTy PrimaryVirtualBases;
1060
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001061 /// ComputeReturnAdjustment - Compute the return adjustment given a return
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001062 /// adjustment base offset.
Anders Carlsson075056a2010-02-23 01:34:28 +00001063 ReturnAdjustment ComputeReturnAdjustment(BaseOffset Offset);
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001064
Anders Carlsson9f19aaaa2010-02-27 19:57:44 +00001065 /// ComputeThisAdjustmentBaseOffset - Compute the base offset for adjusting
1066 /// the 'this' pointer from the base subobject to the derived subobject.
1067 BaseOffset ComputeThisAdjustmentBaseOffset(BaseSubobject Base,
1068 BaseSubobject Derived) const;
1069
Anders Carlsson78277c72010-02-18 17:00:09 +00001070 /// ComputeThisAdjustment - Compute the 'this' pointer adjustment for the
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001071 /// given virtual member function, its offset in the layout class and its
1072 /// final overrider.
1073 ThisAdjustment
1074 ComputeThisAdjustment(const CXXMethodDecl *MD,
1075 uint64_t BaseOffsetInLayoutClass,
1076 FinalOverriders::OverriderInfo Overrider);
1077
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001078 /// AddMethod - Add a single virtual member function to the vtable
1079 /// components vector.
Anders Carlsson40687982010-02-27 16:52:49 +00001080 void AddMethod(const CXXMethodDecl *MD, ReturnAdjustment ReturnAdjustment);
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001081
Anders Carlssona8796c62010-02-23 04:26:39 +00001082 /// IsOverriderUsed - Returns whether the overrider will ever be used in this
1083 /// part of the vtable.
1084 ///
1085 /// Itanium C++ ABI 2.5.2:
1086 ///
1087 /// struct A { virtual void f(); };
1088 /// struct B : virtual public A { int i; };
1089 /// struct C : virtual public A { int j; };
1090 /// struct D : public B, public C {};
1091 ///
1092 /// When B and C are declared, A is a primary base in each case, so although
1093 /// vcall offsets are allocated in the A-in-B and A-in-C vtables, no this
1094 /// adjustment is required and no thunk is generated. However, inside D
1095 /// objects, A is no longer a primary base of C, so if we allowed calls to
1096 /// C::f() to use the copy of A's vtable in the C subobject, we would need
1097 /// to adjust this from C* to B::A*, which would require a third-party
1098 /// thunk. Since we require that a call to C::f() first convert to A*,
1099 /// C-in-D's copy of A's vtable is never referenced, so this is not
1100 /// necessary.
Anders Carlsson804cf512010-03-10 06:51:42 +00001101 bool IsOverriderUsed(const CXXMethodDecl *Overrider,
1102 uint64_t BaseOffsetInLayoutClass,
1103 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
1104 uint64_t FirstBaseOffsetInLayoutClass) const;
1105
Anders Carlssona8796c62010-02-23 04:26:39 +00001106
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001107 /// AddMethods - Add the methods of this base subobject and all its
1108 /// primary bases to the vtable components vector.
Anders Carlsson804cf512010-03-10 06:51:42 +00001109 void AddMethods(BaseSubobject Base, uint64_t BaseOffsetInLayoutClass,
1110 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
1111 uint64_t FirstBaseOffsetInLayoutClass,
Anders Carlssond46ed892010-02-27 16:18:19 +00001112 PrimaryBasesSetVectorTy &PrimaryBases);
Anders Carlssonb716a542010-02-16 16:26:28 +00001113
Anders Carlssond78b2242010-04-11 22:07:06 +00001114 // LayoutVTable - Layout the vtable for the given base class, including its
Anders Carlssonb716a542010-02-16 16:26:28 +00001115 // secondary vtables and any vtables for virtual bases.
Anders Carlssond78b2242010-04-11 22:07:06 +00001116 void LayoutVTable();
Anders Carlssonb716a542010-02-16 16:26:28 +00001117
Anders Carlssond78b2242010-04-11 22:07:06 +00001118 /// LayoutPrimaryAndSecondaryVTables - Layout the primary vtable for the
Anders Carlssonb716a542010-02-16 16:26:28 +00001119 /// given base subobject, as well as all its secondary vtables.
Anders Carlssonb41c6332010-04-11 22:03:57 +00001120 ///
Anders Carlsson3383e2a2010-04-11 22:20:36 +00001121 /// \param BaseIsMorallyVirtual whether the base subobject is a virtual base
1122 /// or a direct or indirect base of a virtual base.
1123 ///
Anders Carlssonb41c6332010-04-11 22:03:57 +00001124 /// \param BaseIsVirtualInLayoutClass - Whether the base subobject is virtual
1125 /// in the layout class.
Anders Carlssond78b2242010-04-11 22:07:06 +00001126 void LayoutPrimaryAndSecondaryVTables(BaseSubobject Base,
Anders Carlsson3383e2a2010-04-11 22:20:36 +00001127 bool BaseIsMorallyVirtual,
Anders Carlssonb41c6332010-04-11 22:03:57 +00001128 bool BaseIsVirtualInLayoutClass,
Anders Carlssone3385f52010-02-28 01:43:58 +00001129 uint64_t OffsetInLayoutClass);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001130
Anders Carlssond78b2242010-04-11 22:07:06 +00001131 /// LayoutSecondaryVTables - Layout the secondary vtables for the given base
Anders Carlsson14157932010-02-16 16:02:57 +00001132 /// subobject.
Anders Carlsson115b4752010-03-10 19:39:11 +00001133 ///
1134 /// \param BaseIsMorallyVirtual whether the base subobject is a virtual base
1135 /// or a direct or indirect base of a virtual base.
Anders Carlssond78b2242010-04-11 22:07:06 +00001136 void LayoutSecondaryVTables(BaseSubobject Base, bool BaseIsMorallyVirtual,
Anders Carlsson115b4752010-03-10 19:39:11 +00001137 uint64_t OffsetInLayoutClass);
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001138
1139 /// DeterminePrimaryVirtualBases - Determine the primary virtual bases in this
1140 /// class hierarchy.
1141 void DeterminePrimaryVirtualBases(const CXXRecordDecl *RD,
Anders Carlsson02b99d62010-03-10 03:02:01 +00001142 uint64_t OffsetInLayoutClass,
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001143 VisitedVirtualBasesSetTy &VBases);
1144
Anders Carlssond78b2242010-04-11 22:07:06 +00001145 /// LayoutVTablesForVirtualBases - Layout vtables for all virtual bases of the
Anders Carlsson13f0f662010-02-16 16:49:35 +00001146 /// given base (excluding any primary bases).
Anders Carlssond78b2242010-04-11 22:07:06 +00001147 void LayoutVTablesForVirtualBases(const CXXRecordDecl *RD,
Anders Carlsson13f0f662010-02-16 16:49:35 +00001148 VisitedVirtualBasesSetTy &VBases);
1149
Anders Carlssond78b2242010-04-11 22:07:06 +00001150 /// isBuildingConstructionVTable - Return whether this vtable builder is
Anders Carlsson31f595f2010-02-28 00:10:58 +00001151 /// building a construction vtable.
Anders Carlssond78b2242010-04-11 22:07:06 +00001152 bool isBuildingConstructorVTable() const {
Anders Carlsson31f595f2010-02-28 00:10:58 +00001153 return MostDerivedClass != LayoutClass;
1154 }
1155
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001156public:
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001157 VTableBuilder(CodeGenVTables &VTables, const CXXRecordDecl *MostDerivedClass,
Anders Carlsson62c6c722010-02-28 00:36:23 +00001158 uint64_t MostDerivedClassOffset, bool MostDerivedClassIsVirtual,
Anders Carlsson93913752010-02-27 20:39:05 +00001159 const CXXRecordDecl *LayoutClass)
Anders Carlssona864caf2010-03-23 04:11:45 +00001160 : VTables(VTables), MostDerivedClass(MostDerivedClass),
Anders Carlsson62c6c722010-02-28 00:36:23 +00001161 MostDerivedClassOffset(MostDerivedClassOffset),
1162 MostDerivedClassIsVirtual(MostDerivedClassIsVirtual),
1163 LayoutClass(LayoutClass), Context(MostDerivedClass->getASTContext()),
Anders Carlssonca82a4f2010-03-10 02:33:41 +00001164 Overriders(MostDerivedClass, MostDerivedClassOffset, LayoutClass) {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001165
Anders Carlssond78b2242010-04-11 22:07:06 +00001166 LayoutVTable();
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001167 }
1168
Anders Carlsson5c5abad2010-03-23 16:36:50 +00001169 ThunksMapTy::const_iterator thunks_begin() const {
1170 return Thunks.begin();
1171 }
1172
1173 ThunksMapTy::const_iterator thunks_end() const {
1174 return Thunks.end();
1175 }
1176
Anders Carlssone90954d2010-03-24 16:42:11 +00001177 const VBaseOffsetOffsetsMapTy &getVBaseOffsetOffsets() const {
1178 return VBaseOffsetOffsets;
1179 }
1180
1181 /// getNumVTableComponents - Return the number of components in the vtable
1182 /// currently built.
1183 uint64_t getNumVTableComponents() const {
1184 return Components.size();
1185 }
1186
Anders Carlssond03325c2010-03-25 00:51:13 +00001187 const uint64_t *vtable_components_data_begin() const {
Anders Carlssone90954d2010-03-24 16:42:11 +00001188 return reinterpret_cast<const uint64_t *>(Components.begin());
1189 }
1190
Anders Carlssond03325c2010-03-25 00:51:13 +00001191 const uint64_t *vtable_components_data_end() const {
Anders Carlssone90954d2010-03-24 16:42:11 +00001192 return reinterpret_cast<const uint64_t *>(Components.end());
1193 }
1194
Anders Carlssond03325c2010-03-25 00:51:13 +00001195 AddressPointsMapTy::const_iterator address_points_begin() const {
1196 return AddressPoints.begin();
1197 }
1198
1199 AddressPointsMapTy::const_iterator address_points_end() const {
1200 return AddressPoints.end();
1201 }
1202
Anders Carlssond78b2242010-04-11 22:07:06 +00001203 VTableThunksMapTy::const_iterator vtable_thunks_begin() const {
Anders Carlssona4147142010-03-25 15:26:28 +00001204 return VTableThunks.begin();
1205 }
1206
Anders Carlssond78b2242010-04-11 22:07:06 +00001207 VTableThunksMapTy::const_iterator vtable_thunks_end() const {
Anders Carlssona4147142010-03-25 15:26:28 +00001208 return VTableThunks.end();
1209 }
1210
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001211 /// dumpLayout - Dump the vtable layout.
1212 void dumpLayout(llvm::raw_ostream&);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001213};
1214
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001215void VTableBuilder::AddThunk(const CXXMethodDecl *MD, const ThunkInfo &Thunk) {
Anders Carlssond78b2242010-04-11 22:07:06 +00001216 assert(!isBuildingConstructorVTable() &&
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001217 "Can't add thunks for construction vtable");
Anders Carlsson18c582d2010-03-18 02:44:19 +00001218
Anders Carlsson7cea12f2010-03-23 04:44:10 +00001219 llvm::SmallVector<ThunkInfo, 1> &ThunksVector = Thunks[MD];
Anders Carlsson56446142010-03-17 20:06:32 +00001220
1221 // Check if we have this thunk already.
1222 if (std::find(ThunksVector.begin(), ThunksVector.end(), Thunk) !=
1223 ThunksVector.end())
1224 return;
1225
1226 ThunksVector.push_back(Thunk);
1227}
1228
Anders Carlsson88cf34f2010-04-10 20:39:29 +00001229typedef llvm::SmallPtrSet<const CXXMethodDecl *, 8> OverriddenMethodsSetTy;
1230
1231/// ComputeAllOverriddenMethods - Given a method decl, will return a set of all
1232/// the overridden methods that the function decl overrides.
1233static void
1234ComputeAllOverriddenMethods(const CXXMethodDecl *MD,
1235 OverriddenMethodsSetTy& OverriddenMethods) {
1236 assert(MD->isVirtual() && "Method is not virtual!");
1237
Anders Carlsson65b49782010-02-12 05:25:12 +00001238 for (CXXMethodDecl::method_iterator I = MD->begin_overridden_methods(),
1239 E = MD->end_overridden_methods(); I != E; ++I) {
1240 const CXXMethodDecl *OverriddenMD = *I;
Anders Carlsson65b49782010-02-12 05:25:12 +00001241
Anders Carlsson88cf34f2010-04-10 20:39:29 +00001242 OverriddenMethods.insert(OverriddenMD);
1243
1244 ComputeAllOverriddenMethods(OverriddenMD, OverriddenMethods);
Anders Carlsson65b49782010-02-12 05:25:12 +00001245 }
Anders Carlsson65b49782010-02-12 05:25:12 +00001246}
1247
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001248void VTableBuilder::ComputeThisAdjustments() {
Anders Carlsson40687982010-02-27 16:52:49 +00001249 // Now go through the method info map and see if any of the methods need
1250 // 'this' pointer adjustments.
1251 for (MethodInfoMapTy::const_iterator I = MethodInfoMap.begin(),
1252 E = MethodInfoMap.end(); I != E; ++I) {
1253 const CXXMethodDecl *MD = I->first;
1254 const MethodInfo &MethodInfo = I->second;
1255
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001256 // Ignore adjustments for unused function pointers.
Anders Carlssond78b2242010-04-11 22:07:06 +00001257 uint64_t VTableIndex = MethodInfo.VTableIndex;
1258 if (Components[VTableIndex].getKind() ==
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001259 VTableComponent::CK_UnusedFunctionPointer)
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001260 continue;
1261
Anders Carlsson40687982010-02-27 16:52:49 +00001262 // Get the final overrider for this method.
1263 FinalOverriders::OverriderInfo Overrider =
Anders Carlsson79547c32010-06-01 23:17:37 +00001264 Overriders.getOverrider(MD, MethodInfo.BaseOffset);
Anders Carlsson40687982010-02-27 16:52:49 +00001265
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001266 // Check if we need an adjustment at all.
Anders Carlssoneba1a602010-03-29 15:08:41 +00001267 if (MethodInfo.BaseOffsetInLayoutClass == Overrider.Offset) {
1268 // When a return thunk is needed by a derived class that overrides a
1269 // virtual base, gcc uses a virtual 'this' adjustment as well.
1270 // While the thunk itself might be needed by vtables in subclasses or
1271 // in construction vtables, there doesn't seem to be a reason for using
1272 // the thunk in this vtable. Still, we do so to match gcc.
Anders Carlssond78b2242010-04-11 22:07:06 +00001273 if (VTableThunks.lookup(VTableIndex).Return.isEmpty())
Anders Carlssoneba1a602010-03-29 15:08:41 +00001274 continue;
1275 }
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001276
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001277 ThisAdjustment ThisAdjustment =
1278 ComputeThisAdjustment(MD, MethodInfo.BaseOffsetInLayoutClass, Overrider);
1279
1280 if (ThisAdjustment.isEmpty())
Anders Carlsson40687982010-02-27 16:52:49 +00001281 continue;
Anders Carlsson40687982010-02-27 16:52:49 +00001282
Anders Carlsson01d3c7d2010-02-27 18:09:40 +00001283 // Add it.
Anders Carlssond78b2242010-04-11 22:07:06 +00001284 VTableThunks[VTableIndex].This = ThisAdjustment;
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001285
Anders Carlsson40687982010-02-27 16:52:49 +00001286 if (isa<CXXDestructorDecl>(MD)) {
1287 // Add an adjustment for the deleting destructor as well.
Anders Carlssond78b2242010-04-11 22:07:06 +00001288 VTableThunks[VTableIndex + 1].This = ThisAdjustment;
Anders Carlsson40687982010-02-27 16:52:49 +00001289 }
1290 }
1291
1292 /// Clear the method info map.
1293 MethodInfoMap.clear();
Anders Carlsson64decd32010-03-22 15:47:01 +00001294
Anders Carlssond78b2242010-04-11 22:07:06 +00001295 if (isBuildingConstructorVTable()) {
Anders Carlsson64decd32010-03-22 15:47:01 +00001296 // We don't need to store thunk information for construction vtables.
1297 return;
1298 }
1299
Anders Carlssond78b2242010-04-11 22:07:06 +00001300 for (VTableThunksMapTy::const_iterator I = VTableThunks.begin(),
Anders Carlsson7cea12f2010-03-23 04:44:10 +00001301 E = VTableThunks.end(); I != E; ++I) {
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001302 const VTableComponent &Component = Components[I->first];
Anders Carlsson64decd32010-03-22 15:47:01 +00001303 const ThunkInfo &Thunk = I->second;
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001304 const CXXMethodDecl *MD;
Anders Carlsson64decd32010-03-22 15:47:01 +00001305
1306 switch (Component.getKind()) {
1307 default:
1308 llvm_unreachable("Unexpected vtable component kind!");
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001309 case VTableComponent::CK_FunctionPointer:
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001310 MD = Component.getFunctionDecl();
Anders Carlsson64decd32010-03-22 15:47:01 +00001311 break;
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001312 case VTableComponent::CK_CompleteDtorPointer:
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001313 MD = Component.getDestructorDecl();
Anders Carlsson64decd32010-03-22 15:47:01 +00001314 break;
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001315 case VTableComponent::CK_DeletingDtorPointer:
Anders Carlsson64decd32010-03-22 15:47:01 +00001316 // We've already added the thunk when we saw the complete dtor pointer.
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001317 continue;
Anders Carlsson64decd32010-03-22 15:47:01 +00001318 }
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001319
1320 if (MD->getParent() == MostDerivedClass)
1321 AddThunk(MD, Thunk);
Anders Carlsson64decd32010-03-22 15:47:01 +00001322 }
Anders Carlsson40687982010-02-27 16:52:49 +00001323}
1324
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001325ReturnAdjustment VTableBuilder::ComputeReturnAdjustment(BaseOffset Offset) {
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001326 ReturnAdjustment Adjustment;
1327
1328 if (!Offset.isEmpty()) {
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001329 if (Offset.VirtualBase) {
1330 // Get the virtual base offset offset.
Anders Carlssone4424882010-03-11 07:00:45 +00001331 if (Offset.DerivedClass == MostDerivedClass) {
1332 // We can get the offset offset directly from our map.
1333 Adjustment.VBaseOffsetOffset =
1334 VBaseOffsetOffsets.lookup(Offset.VirtualBase);
1335 } else {
1336 Adjustment.VBaseOffsetOffset =
Anders Carlssona864caf2010-03-23 04:11:45 +00001337 VTables.getVirtualBaseOffsetOffset(Offset.DerivedClass,
1338 Offset.VirtualBase);
Anders Carlssone4424882010-03-11 07:00:45 +00001339 }
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001340 }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001341
1342 Adjustment.NonVirtual = Offset.NonVirtualOffset;
1343 }
1344
1345 return Adjustment;
1346}
1347
Anders Carlsson9f19aaaa2010-02-27 19:57:44 +00001348BaseOffset
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001349VTableBuilder::ComputeThisAdjustmentBaseOffset(BaseSubobject Base,
Anders Carlsson9f19aaaa2010-02-27 19:57:44 +00001350 BaseSubobject Derived) const {
1351 const CXXRecordDecl *BaseRD = Base.getBase();
1352 const CXXRecordDecl *DerivedRD = Derived.getBase();
1353
1354 CXXBasePaths Paths(/*FindAmbiguities=*/true,
1355 /*RecordPaths=*/true, /*DetectVirtual=*/true);
1356
1357 if (!const_cast<CXXRecordDecl *>(DerivedRD)->
1358 isDerivedFrom(const_cast<CXXRecordDecl *>(BaseRD), Paths)) {
1359 assert(false && "Class must be derived from the passed in base class!");
1360 return BaseOffset();
1361 }
1362
1363 // We have to go through all the paths, and see which one leads us to the
1364 // right base subobject.
1365 for (CXXBasePaths::const_paths_iterator I = Paths.begin(), E = Paths.end();
1366 I != E; ++I) {
1367 BaseOffset Offset = ComputeBaseOffset(Context, DerivedRD, *I);
1368
Ken Dyckce812032011-03-26 00:51:24 +00001369 CharUnits OffsetToBaseSubobject =
1370 CharUnits::fromQuantity(Offset.NonVirtualOffset);
Anders Carlsson9f19aaaa2010-02-27 19:57:44 +00001371
1372 if (Offset.VirtualBase) {
1373 // If we have a virtual base class, the non-virtual offset is relative
1374 // to the virtual base class offset.
Anders Carlsson423406f32010-03-10 21:25:37 +00001375 const ASTRecordLayout &LayoutClassLayout =
1376 Context.getASTRecordLayout(LayoutClass);
Anders Carlsson9f19aaaa2010-02-27 19:57:44 +00001377
1378 /// Get the virtual base offset, relative to the most derived class
1379 /// layout.
1380 OffsetToBaseSubobject +=
Ken Dyckce812032011-03-26 00:51:24 +00001381 LayoutClassLayout.getVBaseClassOffset(Offset.VirtualBase);
Anders Carlsson9f19aaaa2010-02-27 19:57:44 +00001382 } else {
1383 // Otherwise, the non-virtual offset is relative to the derived class
1384 // offset.
Ken Dyckce812032011-03-26 00:51:24 +00001385 OffsetToBaseSubobject += Derived.getBaseOffset();
Anders Carlsson9f19aaaa2010-02-27 19:57:44 +00001386 }
1387
1388 // Check if this path gives us the right base subobject.
Ken Dyckce812032011-03-26 00:51:24 +00001389 if (OffsetToBaseSubobject == Base.getBaseOffset()) {
Anders Carlsson9f19aaaa2010-02-27 19:57:44 +00001390 // Since we're going from the base class _to_ the derived class, we'll
1391 // invert the non-virtual offset here.
1392 Offset.NonVirtualOffset = -Offset.NonVirtualOffset;
1393 return Offset;
1394 }
1395 }
1396
1397 return BaseOffset();
1398}
1399
Anders Carlsson67fd3a50d2010-03-23 15:13:06 +00001400ThisAdjustment
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001401VTableBuilder::ComputeThisAdjustment(const CXXMethodDecl *MD,
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001402 uint64_t BaseOffsetInLayoutClass,
1403 FinalOverriders::OverriderInfo Overrider) {
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001404 // Ignore adjustments for pure virtual member functions.
1405 if (Overrider.Method->isPure())
1406 return ThisAdjustment();
1407
1408 BaseSubobject OverriddenBaseSubobject(MD->getParent(),
Ken Dyck16ffcac2011-03-24 01:21:01 +00001409 Context.toCharUnitsFromBits(
1410 BaseOffsetInLayoutClass));
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001411
1412 BaseSubobject OverriderBaseSubobject(Overrider.Method->getParent(),
Ken Dyck16ffcac2011-03-24 01:21:01 +00001413 Context.toCharUnitsFromBits(
1414 Overrider.Offset));
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001415
1416 // Compute the adjustment offset.
1417 BaseOffset Offset = ComputeThisAdjustmentBaseOffset(OverriddenBaseSubobject,
1418 OverriderBaseSubobject);
1419 if (Offset.isEmpty())
1420 return ThisAdjustment();
1421
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001422 ThisAdjustment Adjustment;
1423
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001424 if (Offset.VirtualBase) {
1425 // Get the vcall offset map for this virtual base.
1426 VCallOffsetMap &VCallOffsets = VCallOffsetsForVBases[Offset.VirtualBase];
Anders Carlsson8847d9e2010-02-18 17:26:40 +00001427
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001428 if (VCallOffsets.empty()) {
1429 // We don't have vcall offsets for this virtual base, go ahead and
1430 // build them.
1431 VCallAndVBaseOffsetBuilder Builder(MostDerivedClass, MostDerivedClass,
1432 /*FinalOverriders=*/0,
Ken Dyck16ffcac2011-03-24 01:21:01 +00001433 BaseSubobject(Offset.VirtualBase,
1434 CharUnits::Zero()),
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001435 /*BaseIsVirtual=*/true,
1436 /*OffsetInLayoutClass=*/0);
1437
1438 VCallOffsets = Builder.getVCallOffsets();
1439 }
1440
1441 Adjustment.VCallOffsetOffset = VCallOffsets.getVCallOffsetOffset(MD);
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001442 }
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001443
1444 // Set the non-virtual part of the adjustment.
1445 Adjustment.NonVirtual = Offset.NonVirtualOffset;
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001446
1447 return Adjustment;
1448}
Anders Carlsson5d3b9012010-03-12 05:28:07 +00001449
Anders Carlsson65b49782010-02-12 05:25:12 +00001450void
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001451VTableBuilder::AddMethod(const CXXMethodDecl *MD,
Anders Carlsson40687982010-02-27 16:52:49 +00001452 ReturnAdjustment ReturnAdjustment) {
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001453 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1454 assert(ReturnAdjustment.isEmpty() &&
1455 "Destructor can't have return adjustment!");
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001456
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001457 // Add both the complete destructor and the deleting destructor.
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001458 Components.push_back(VTableComponent::MakeCompleteDtor(DD));
1459 Components.push_back(VTableComponent::MakeDeletingDtor(DD));
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001460 } else {
1461 // Add the return adjustment if necessary.
1462 if (!ReturnAdjustment.isEmpty())
Anders Carlsson7cea12f2010-03-23 04:44:10 +00001463 VTableThunks[Components.size()].Return = ReturnAdjustment;
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001464
1465 // Add the function.
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001466 Components.push_back(VTableComponent::MakeFunction(MD));
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001467 }
1468}
1469
Anders Carlssond2025412010-02-27 06:38:03 +00001470/// OverridesIndirectMethodInBase - Return whether the given member function
1471/// overrides any methods in the set of given bases.
1472/// Unlike OverridesMethodInBase, this checks "overriders of overriders".
1473/// For example, if we have:
1474///
1475/// struct A { virtual void f(); }
1476/// struct B : A { virtual void f(); }
1477/// struct C : B { virtual void f(); }
1478///
1479/// OverridesIndirectMethodInBase will return true if given C::f as the method
Anders Carlsson88cf34f2010-04-10 20:39:29 +00001480/// and { A } as the set of bases.
Anders Carlssond2025412010-02-27 06:38:03 +00001481static bool
1482OverridesIndirectMethodInBases(const CXXMethodDecl *MD,
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001483 VTableBuilder::PrimaryBasesSetVectorTy &Bases) {
Anders Carlssonc6db5ab2010-04-17 17:24:33 +00001484 if (Bases.count(MD->getParent()))
1485 return true;
1486
Anders Carlssond2025412010-02-27 06:38:03 +00001487 for (CXXMethodDecl::method_iterator I = MD->begin_overridden_methods(),
1488 E = MD->end_overridden_methods(); I != E; ++I) {
1489 const CXXMethodDecl *OverriddenMD = *I;
Anders Carlssond2025412010-02-27 06:38:03 +00001490
1491 // Check "indirect overriders".
1492 if (OverridesIndirectMethodInBases(OverriddenMD, Bases))
1493 return true;
1494 }
1495
1496 return false;
1497}
1498
Anders Carlssona8796c62010-02-23 04:26:39 +00001499bool
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001500VTableBuilder::IsOverriderUsed(const CXXMethodDecl *Overrider,
Anders Carlsson804cf512010-03-10 06:51:42 +00001501 uint64_t BaseOffsetInLayoutClass,
1502 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
1503 uint64_t FirstBaseOffsetInLayoutClass) const {
Anders Carlssona8796c62010-02-23 04:26:39 +00001504 // If the base and the first base in the primary base chain have the same
1505 // offsets, then this overrider will be used.
Anders Carlsson804cf512010-03-10 06:51:42 +00001506 if (BaseOffsetInLayoutClass == FirstBaseOffsetInLayoutClass)
Anders Carlsson8939e402010-02-23 06:34:44 +00001507 return true;
1508
1509 // We know now that Base (or a direct or indirect base of it) is a primary
1510 // base in part of the class hierarchy, but not a primary base in the most
1511 // derived class.
1512
1513 // If the overrider is the first base in the primary base chain, we know
1514 // that the overrider will be used.
Anders Carlsson804cf512010-03-10 06:51:42 +00001515 if (Overrider->getParent() == FirstBaseInPrimaryBaseChain)
Anders Carlssona8796c62010-02-23 04:26:39 +00001516 return true;
1517
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001518 VTableBuilder::PrimaryBasesSetVectorTy PrimaryBases;
Anders Carlsson8939e402010-02-23 06:34:44 +00001519
Anders Carlsson804cf512010-03-10 06:51:42 +00001520 const CXXRecordDecl *RD = FirstBaseInPrimaryBaseChain;
Anders Carlsson8939e402010-02-23 06:34:44 +00001521 PrimaryBases.insert(RD);
1522
1523 // Now traverse the base chain, starting with the first base, until we find
1524 // the base that is no longer a primary base.
1525 while (true) {
1526 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1527 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
1528
1529 if (!PrimaryBase)
1530 break;
1531
Anders Carlsson7f95cd12010-11-24 23:12:57 +00001532 if (Layout.isPrimaryBaseVirtual()) {
Anders Carlssonfd88a612010-10-31 23:22:37 +00001533 assert(Layout.getVBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlsson8939e402010-02-23 06:34:44 +00001534 "Primary base should always be at offset 0!");
1535
Anders Carlsson7162ab92010-02-28 18:37:33 +00001536 const ASTRecordLayout &LayoutClassLayout =
1537 Context.getASTRecordLayout(LayoutClass);
Anders Carlsson8939e402010-02-23 06:34:44 +00001538
1539 // Now check if this is the primary base that is not a primary base in the
1540 // most derived class.
Anders Carlssonfd88a612010-10-31 23:22:37 +00001541 if (LayoutClassLayout.getVBaseClassOffsetInBits(PrimaryBase) !=
Anders Carlsson804cf512010-03-10 06:51:42 +00001542 FirstBaseOffsetInLayoutClass) {
Anders Carlsson8939e402010-02-23 06:34:44 +00001543 // We found it, stop walking the chain.
1544 break;
1545 }
1546 } else {
Anders Carlssonfd88a612010-10-31 23:22:37 +00001547 assert(Layout.getBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlsson8939e402010-02-23 06:34:44 +00001548 "Primary base should always be at offset 0!");
1549 }
Anders Carlsson01d3c7d2010-02-27 18:09:40 +00001550
Anders Carlssonb26c2ab2010-02-27 19:51:04 +00001551 if (!PrimaryBases.insert(PrimaryBase))
1552 assert(false && "Found a duplicate primary base!");
1553
Anders Carlsson01d3c7d2010-02-27 18:09:40 +00001554 RD = PrimaryBase;
Anders Carlsson8939e402010-02-23 06:34:44 +00001555 }
1556
1557 // If the final overrider is an override of one of the primary bases,
1558 // then we know that it will be used.
Anders Carlsson804cf512010-03-10 06:51:42 +00001559 return OverridesIndirectMethodInBases(Overrider, PrimaryBases);
Anders Carlssona8796c62010-02-23 04:26:39 +00001560}
1561
Anders Carlsson40687982010-02-27 16:52:49 +00001562/// FindNearestOverriddenMethod - Given a method, returns the overridden method
1563/// from the nearest base. Returns null if no method was found.
1564static const CXXMethodDecl *
1565FindNearestOverriddenMethod(const CXXMethodDecl *MD,
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001566 VTableBuilder::PrimaryBasesSetVectorTy &Bases) {
Anders Carlsson88cf34f2010-04-10 20:39:29 +00001567 OverriddenMethodsSetTy OverriddenMethods;
1568 ComputeAllOverriddenMethods(MD, OverriddenMethods);
1569
Anders Carlsson40687982010-02-27 16:52:49 +00001570 for (int I = Bases.size(), E = 0; I != E; --I) {
1571 const CXXRecordDecl *PrimaryBase = Bases[I - 1];
1572
1573 // Now check the overriden methods.
Anders Carlsson88cf34f2010-04-10 20:39:29 +00001574 for (OverriddenMethodsSetTy::const_iterator I = OverriddenMethods.begin(),
1575 E = OverriddenMethods.end(); I != E; ++I) {
Anders Carlsson40687982010-02-27 16:52:49 +00001576 const CXXMethodDecl *OverriddenMD = *I;
Anders Carlsson88cf34f2010-04-10 20:39:29 +00001577
Anders Carlsson40687982010-02-27 16:52:49 +00001578 // We found our overridden method.
1579 if (OverriddenMD->getParent() == PrimaryBase)
1580 return OverriddenMD;
1581 }
1582 }
1583
1584 return 0;
1585}
1586
Anders Carlsson804cf512010-03-10 06:51:42 +00001587void
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001588VTableBuilder::AddMethods(BaseSubobject Base, uint64_t BaseOffsetInLayoutClass,
Anders Carlsson804cf512010-03-10 06:51:42 +00001589 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
1590 uint64_t FirstBaseOffsetInLayoutClass,
Anders Carlssond46ed892010-02-27 16:18:19 +00001591 PrimaryBasesSetVectorTy &PrimaryBases) {
Anders Carlsson65b49782010-02-12 05:25:12 +00001592 const CXXRecordDecl *RD = Base.getBase();
Anders Carlsson65b49782010-02-12 05:25:12 +00001593 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1594
1595 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
Ken Dyckce812032011-03-26 00:51:24 +00001596 CharUnits PrimaryBaseOffset;
Anders Carlsson804cf512010-03-10 06:51:42 +00001597 uint64_t PrimaryBaseOffsetInLayoutClass;
Anders Carlsson7f95cd12010-11-24 23:12:57 +00001598 if (Layout.isPrimaryBaseVirtual()) {
Anders Carlssonfd88a612010-10-31 23:22:37 +00001599 assert(Layout.getVBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlsson0570f712010-02-23 03:48:14 +00001600 "Primary vbase should have a zero offset!");
1601
1602 const ASTRecordLayout &MostDerivedClassLayout =
1603 Context.getASTRecordLayout(MostDerivedClass);
1604
Anders Carlsson804cf512010-03-10 06:51:42 +00001605 PrimaryBaseOffset =
Ken Dyckce812032011-03-26 00:51:24 +00001606 MostDerivedClassLayout.getVBaseClassOffset(PrimaryBase);
Anders Carlsson804cf512010-03-10 06:51:42 +00001607
1608 const ASTRecordLayout &LayoutClassLayout =
1609 Context.getASTRecordLayout(LayoutClass);
1610
1611 PrimaryBaseOffsetInLayoutClass =
Anders Carlssonfd88a612010-10-31 23:22:37 +00001612 LayoutClassLayout.getVBaseClassOffsetInBits(PrimaryBase);
Anders Carlsson0570f712010-02-23 03:48:14 +00001613 } else {
Anders Carlssonfd88a612010-10-31 23:22:37 +00001614 assert(Layout.getBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlsson65b49782010-02-12 05:25:12 +00001615 "Primary base should have a zero offset!");
Anders Carlsson0570f712010-02-23 03:48:14 +00001616
Ken Dyckce812032011-03-26 00:51:24 +00001617 PrimaryBaseOffset = Base.getBaseOffset();
Anders Carlsson804cf512010-03-10 06:51:42 +00001618 PrimaryBaseOffsetInLayoutClass = BaseOffsetInLayoutClass;
Anders Carlsson0570f712010-02-23 03:48:14 +00001619 }
Anders Carlsson7162ab92010-02-28 18:37:33 +00001620
Ken Dyckce812032011-03-26 00:51:24 +00001621 AddMethods(BaseSubobject(PrimaryBase, PrimaryBaseOffset),
Anders Carlsson804cf512010-03-10 06:51:42 +00001622 PrimaryBaseOffsetInLayoutClass, FirstBaseInPrimaryBaseChain,
1623 FirstBaseOffsetInLayoutClass, PrimaryBases);
Anders Carlsson65b49782010-02-12 05:25:12 +00001624
1625 if (!PrimaryBases.insert(PrimaryBase))
1626 assert(false && "Found a duplicate primary base!");
1627 }
Anders Carlsson932c2f22010-02-11 17:18:51 +00001628
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001629 // Now go through all virtual member functions and add them.
1630 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
1631 E = RD->method_end(); I != E; ++I) {
1632 const CXXMethodDecl *MD = *I;
Anders Carlsson65b49782010-02-12 05:25:12 +00001633
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001634 if (!MD->isVirtual())
1635 continue;
Anders Carlsson65b49782010-02-12 05:25:12 +00001636
1637 // Get the final overrider.
Anders Carlsson136bd192010-02-12 16:55:34 +00001638 FinalOverriders::OverriderInfo Overrider =
Ken Dyck16ffcac2011-03-24 01:21:01 +00001639 Overriders.getOverrider(MD, Context.toBits(Base.getBaseOffset()));
Anders Carlsson65b49782010-02-12 05:25:12 +00001640
1641 // Check if this virtual member function overrides a method in a primary
1642 // base. If this is the case, and the return type doesn't require adjustment
1643 // then we can just use the member function from the primary base.
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001644 if (const CXXMethodDecl *OverriddenMD =
Anders Carlsson40687982010-02-27 16:52:49 +00001645 FindNearestOverriddenMethod(MD, PrimaryBases)) {
Anders Carlssoncce9ee82010-02-13 23:17:31 +00001646 if (ComputeReturnAdjustmentBaseOffset(Context, MD,
Anders Carlsson40687982010-02-27 16:52:49 +00001647 OverriddenMD).isEmpty()) {
1648 // Replace the method info of the overridden method with our own
1649 // method.
1650 assert(MethodInfoMap.count(OverriddenMD) &&
1651 "Did not find the overridden method!");
1652 MethodInfo &OverriddenMethodInfo = MethodInfoMap[OverriddenMD];
1653
Ken Dyck16ffcac2011-03-24 01:21:01 +00001654 MethodInfo MethodInfo(Context.toBits(Base.getBaseOffset()),
Anders Carlsson423406f32010-03-10 21:25:37 +00001655 BaseOffsetInLayoutClass,
Anders Carlssond78b2242010-04-11 22:07:06 +00001656 OverriddenMethodInfo.VTableIndex);
Anders Carlsson40687982010-02-27 16:52:49 +00001657
1658 assert(!MethodInfoMap.count(MD) &&
1659 "Should not have method info for this method yet!");
1660
1661 MethodInfoMap.insert(std::make_pair(MD, MethodInfo));
1662 MethodInfoMap.erase(OverriddenMD);
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001663
1664 // If the overridden method exists in a virtual base class or a direct
1665 // or indirect base class of a virtual base class, we need to emit a
1666 // thunk if we ever have a class hierarchy where the base class is not
1667 // a primary base in the complete object.
Anders Carlssond78b2242010-04-11 22:07:06 +00001668 if (!isBuildingConstructorVTable() && OverriddenMD != MD) {
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001669 // Compute the this adjustment.
1670 ThisAdjustment ThisAdjustment =
1671 ComputeThisAdjustment(OverriddenMD, BaseOffsetInLayoutClass,
1672 Overrider);
1673
Anders Carlsson800ded62010-03-29 02:53:58 +00001674 if (ThisAdjustment.VCallOffsetOffset &&
1675 Overrider.Method->getParent() == MostDerivedClass) {
John McCall47838252010-11-09 01:18:05 +00001676
1677 // There's no return adjustment from OverriddenMD and MD,
1678 // but that doesn't mean there isn't one between MD and
1679 // the final overrider.
1680 BaseOffset ReturnAdjustmentOffset =
1681 ComputeReturnAdjustmentBaseOffset(Context, Overrider.Method, MD);
1682 ReturnAdjustment ReturnAdjustment =
1683 ComputeReturnAdjustment(ReturnAdjustmentOffset);
1684
Anders Carlsson800ded62010-03-29 02:53:58 +00001685 // This is a virtual thunk for the most derived class, add it.
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001686 AddThunk(Overrider.Method,
John McCall47838252010-11-09 01:18:05 +00001687 ThunkInfo(ThisAdjustment, ReturnAdjustment));
Anders Carlsson290c6ed2010-03-22 20:06:40 +00001688 }
1689 }
1690
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001691 continue;
Anders Carlsson40687982010-02-27 16:52:49 +00001692 }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001693 }
Anders Carlssoneee53d92010-02-13 02:02:03 +00001694
Anders Carlsson40687982010-02-27 16:52:49 +00001695 // Insert the method info for this method.
Ken Dyck16ffcac2011-03-24 01:21:01 +00001696 MethodInfo MethodInfo(Context.toBits(Base.getBaseOffset()),
1697 BaseOffsetInLayoutClass, Components.size());
Anders Carlsson40687982010-02-27 16:52:49 +00001698
1699 assert(!MethodInfoMap.count(MD) &&
1700 "Should not have method info for this method yet!");
1701 MethodInfoMap.insert(std::make_pair(MD, MethodInfo));
Anders Carlsson01d3c7d2010-02-27 18:09:40 +00001702
1703 // Check if this overrider is going to be used.
Anders Carlsson804cf512010-03-10 06:51:42 +00001704 const CXXMethodDecl *OverriderMD = Overrider.Method;
1705 if (!IsOverriderUsed(OverriderMD, BaseOffsetInLayoutClass,
1706 FirstBaseInPrimaryBaseChain,
1707 FirstBaseOffsetInLayoutClass)) {
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001708 Components.push_back(VTableComponent::MakeUnusedFunction(OverriderMD));
Anders Carlsson01d3c7d2010-02-27 18:09:40 +00001709 continue;
1710 }
Anders Carlssona8796c62010-02-23 04:26:39 +00001711
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001712 // Check if this overrider needs a return adjustment.
Anders Carlsson042ce2d82010-06-01 23:47:05 +00001713 // We don't want to do this for pure virtual member functions.
1714 BaseOffset ReturnAdjustmentOffset;
1715 if (!OverriderMD->isPure()) {
1716 ReturnAdjustmentOffset =
1717 ComputeReturnAdjustmentBaseOffset(Context, OverriderMD, MD);
1718 }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001719
1720 ReturnAdjustment ReturnAdjustment =
1721 ComputeReturnAdjustment(ReturnAdjustmentOffset);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001722
Anders Carlsson40687982010-02-27 16:52:49 +00001723 AddMethod(Overrider.Method, ReturnAdjustment);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001724 }
1725}
1726
Anders Carlssond78b2242010-04-11 22:07:06 +00001727void VTableBuilder::LayoutVTable() {
Ken Dyck16ffcac2011-03-24 01:21:01 +00001728 LayoutPrimaryAndSecondaryVTables(BaseSubobject(MostDerivedClass,
1729 CharUnits::Zero()),
Anders Carlsson3383e2a2010-04-11 22:20:36 +00001730 /*BaseIsMorallyVirtual=*/false,
Anders Carlssone3385f52010-02-28 01:43:58 +00001731 MostDerivedClassIsVirtual,
1732 MostDerivedClassOffset);
Anders Carlssonb716a542010-02-16 16:26:28 +00001733
Anders Carlsson13f0f662010-02-16 16:49:35 +00001734 VisitedVirtualBasesSetTy VBases;
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001735
1736 // Determine the primary virtual bases.
Anders Carlsson02b99d62010-03-10 03:02:01 +00001737 DeterminePrimaryVirtualBases(MostDerivedClass, MostDerivedClassOffset,
1738 VBases);
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001739 VBases.clear();
1740
Anders Carlssond78b2242010-04-11 22:07:06 +00001741 LayoutVTablesForVirtualBases(MostDerivedClass, VBases);
Anders Carlssonb716a542010-02-16 16:26:28 +00001742}
1743
Anders Carlssone3385f52010-02-28 01:43:58 +00001744void
Anders Carlssond78b2242010-04-11 22:07:06 +00001745VTableBuilder::LayoutPrimaryAndSecondaryVTables(BaseSubobject Base,
Anders Carlsson3383e2a2010-04-11 22:20:36 +00001746 bool BaseIsMorallyVirtual,
Anders Carlssonb41c6332010-04-11 22:03:57 +00001747 bool BaseIsVirtualInLayoutClass,
Anders Carlssone3385f52010-02-28 01:43:58 +00001748 uint64_t OffsetInLayoutClass) {
Chris Lattnerd2408f72010-02-17 21:42:34 +00001749 assert(Base.getBase()->isDynamicClass() && "class does not have a vtable!");
Anders Carlsson033d4862010-02-14 17:05:59 +00001750
Anders Carlsson77904f12010-02-16 04:59:55 +00001751 // Add vcall and vbase offsets for this vtable.
Anders Carlssone3385f52010-02-28 01:43:58 +00001752 VCallAndVBaseOffsetBuilder Builder(MostDerivedClass, LayoutClass, &Overriders,
Anders Carlssonb41c6332010-04-11 22:03:57 +00001753 Base, BaseIsVirtualInLayoutClass,
1754 OffsetInLayoutClass);
Anders Carlsson422f7782010-02-25 03:45:56 +00001755 Components.append(Builder.components_begin(), Builder.components_end());
1756
Anders Carlsson9e3b3a32010-02-25 22:23:13 +00001757 // Check if we need to add these vcall offsets.
Anders Carlssonb41c6332010-04-11 22:03:57 +00001758 if (BaseIsVirtualInLayoutClass && !Builder.getVCallOffsets().empty()) {
Anders Carlsson9e3b3a32010-02-25 22:23:13 +00001759 VCallOffsetMap &VCallOffsets = VCallOffsetsForVBases[Base.getBase()];
1760
1761 if (VCallOffsets.empty())
1762 VCallOffsets = Builder.getVCallOffsets();
1763 }
1764
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00001765 // If we're laying out the most derived class we want to keep track of the
1766 // virtual base class offset offsets.
1767 if (Base.getBase() == MostDerivedClass)
1768 VBaseOffsetOffsets = Builder.getVBaseOffsetOffsets();
1769
Anders Carlsson77904f12010-02-16 04:59:55 +00001770 // Add the offset to top.
Anders Carlsson258a1e32010-02-14 00:16:19 +00001771 // FIXME: We should not use / 8 here.
Anders Carlssone3385f52010-02-28 01:43:58 +00001772 int64_t OffsetToTop = -(int64_t)(OffsetInLayoutClass -
1773 MostDerivedClassOffset) / 8;
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001774 Components.push_back(VTableComponent::MakeOffsetToTop(OffsetToTop));
Anders Carlsson65b49782010-02-12 05:25:12 +00001775
1776 // Next, add the RTTI.
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001777 Components.push_back(VTableComponent::MakeRTTI(MostDerivedClass));
Anders Carlsson65b49782010-02-12 05:25:12 +00001778
Anders Carlssone8a97562010-02-12 07:43:48 +00001779 uint64_t AddressPoint = Components.size();
Anders Carlsson65b49782010-02-12 05:25:12 +00001780
1781 // Now go through all virtual member functions and add them.
Anders Carlssond46ed892010-02-27 16:18:19 +00001782 PrimaryBasesSetVectorTy PrimaryBases;
Anders Carlsson804cf512010-03-10 06:51:42 +00001783 AddMethods(Base, OffsetInLayoutClass, Base.getBase(), OffsetInLayoutClass,
1784 PrimaryBases);
Anders Carlsson65b49782010-02-12 05:25:12 +00001785
Anders Carlsson40687982010-02-27 16:52:49 +00001786 // Compute 'this' pointer adjustments.
1787 ComputeThisAdjustments();
1788
Anders Carlsson151b0622010-03-25 21:45:14 +00001789 // Add all address points.
1790 const CXXRecordDecl *RD = Base.getBase();
1791 while (true) {
Ken Dyck16ffcac2011-03-24 01:21:01 +00001792 AddressPoints.insert(std::make_pair(
1793 BaseSubobject(RD, Context.toCharUnitsFromBits(OffsetInLayoutClass)),
1794 AddressPoint));
Anders Carlsson151b0622010-03-25 21:45:14 +00001795
1796 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1797 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
Anders Carlssone8a97562010-02-12 07:43:48 +00001798
Anders Carlsson151b0622010-03-25 21:45:14 +00001799 if (!PrimaryBase)
1800 break;
1801
Anders Carlsson7f95cd12010-11-24 23:12:57 +00001802 if (Layout.isPrimaryBaseVirtual()) {
Anders Carlsson151b0622010-03-25 21:45:14 +00001803 // Check if this virtual primary base is a primary base in the layout
1804 // class. If it's not, we don't want to add it.
1805 const ASTRecordLayout &LayoutClassLayout =
1806 Context.getASTRecordLayout(LayoutClass);
1807
Anders Carlssonfd88a612010-10-31 23:22:37 +00001808 if (LayoutClassLayout.getVBaseClassOffsetInBits(PrimaryBase) !=
Anders Carlsson151b0622010-03-25 21:45:14 +00001809 OffsetInLayoutClass) {
1810 // We don't want to add this class (or any of its primary bases).
1811 break;
1812 }
1813 }
1814
1815 RD = PrimaryBase;
Anders Carlssone8a97562010-02-12 07:43:48 +00001816 }
1817
Anders Carlssona9f633b2010-02-24 16:43:12 +00001818 // Layout secondary vtables.
Anders Carlssond78b2242010-04-11 22:07:06 +00001819 LayoutSecondaryVTables(Base, BaseIsMorallyVirtual, OffsetInLayoutClass);
Anders Carlsson14157932010-02-16 16:02:57 +00001820}
1821
Anders Carlssond78b2242010-04-11 22:07:06 +00001822void VTableBuilder::LayoutSecondaryVTables(BaseSubobject Base,
Anders Carlsson115b4752010-03-10 19:39:11 +00001823 bool BaseIsMorallyVirtual,
Anders Carlssone3385f52010-02-28 01:43:58 +00001824 uint64_t OffsetInLayoutClass) {
Anders Carlsson14157932010-02-16 16:02:57 +00001825 // Itanium C++ ABI 2.5.2:
1826 // Following the primary virtual table of a derived class are secondary
1827 // virtual tables for each of its proper base classes, except any primary
1828 // base(s) with which it shares its primary virtual table.
1829
1830 const CXXRecordDecl *RD = Base.getBase();
Anders Carlsson65b49782010-02-12 05:25:12 +00001831 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1832 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
Anders Carlsson14157932010-02-16 16:02:57 +00001833
Anders Carlsson65b49782010-02-12 05:25:12 +00001834 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1835 E = RD->bases_end(); I != E; ++I) {
Anders Carlsson14157932010-02-16 16:02:57 +00001836 // Ignore virtual bases, we'll emit them later.
1837 if (I->isVirtual())
1838 continue;
1839
Anders Carlsson65b49782010-02-12 05:25:12 +00001840 const CXXRecordDecl *BaseDecl =
1841 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson033d4862010-02-14 17:05:59 +00001842
Anders Carlssondc2dba32010-02-16 04:49:44 +00001843 // Ignore bases that don't have a vtable.
1844 if (!BaseDecl->isDynamicClass())
1845 continue;
Anders Carlsson033d4862010-02-14 17:05:59 +00001846
Anders Carlssond78b2242010-04-11 22:07:06 +00001847 if (isBuildingConstructorVTable()) {
Anders Carlsson703a0862010-03-10 19:15:26 +00001848 // Itanium C++ ABI 2.6.4:
1849 // Some of the base class subobjects may not need construction virtual
1850 // tables, which will therefore not be present in the construction
1851 // virtual table group, even though the subobject virtual tables are
1852 // present in the main virtual table group for the complete object.
Anders Carlsson115b4752010-03-10 19:39:11 +00001853 if (!BaseIsMorallyVirtual && !BaseDecl->getNumVBases())
Anders Carlsson703a0862010-03-10 19:15:26 +00001854 continue;
Anders Carlsson703a0862010-03-10 19:15:26 +00001855 }
1856
Anders Carlssone75aaa92010-02-13 22:05:23 +00001857 // Get the base offset of this base.
Ken Dyckce812032011-03-26 00:51:24 +00001858 CharUnits RelativeBaseOffset = Layout.getBaseClassOffset(BaseDecl);
1859 CharUnits BaseOffset = Base.getBaseOffset() + RelativeBaseOffset;
Anders Carlssone3385f52010-02-28 01:43:58 +00001860
Ken Dyckce812032011-03-26 00:51:24 +00001861 CharUnits BaseOffsetInLayoutClass =
1862 Context.toCharUnitsFromBits(OffsetInLayoutClass) + RelativeBaseOffset;
Anders Carlsson14157932010-02-16 16:02:57 +00001863
1864 // Don't emit a secondary vtable for a primary base. We might however want
1865 // to emit secondary vtables for other bases of this base.
1866 if (BaseDecl == PrimaryBase) {
Ken Dyck16ffcac2011-03-24 01:21:01 +00001867 LayoutSecondaryVTables(
Ken Dyckce812032011-03-26 00:51:24 +00001868 BaseSubobject(BaseDecl, BaseOffset),
1869 BaseIsMorallyVirtual, Context.toBits(BaseOffsetInLayoutClass));
Anders Carlsson14157932010-02-16 16:02:57 +00001870 continue;
1871 }
Anders Carlssone75aaa92010-02-13 22:05:23 +00001872
Anders Carlssonb716a542010-02-16 16:26:28 +00001873 // Layout the primary vtable (and any secondary vtables) for this base.
Ken Dyck16ffcac2011-03-24 01:21:01 +00001874 LayoutPrimaryAndSecondaryVTables(
Ken Dyckce812032011-03-26 00:51:24 +00001875 BaseSubobject(BaseDecl, BaseOffset),
Ken Dyck16ffcac2011-03-24 01:21:01 +00001876 BaseIsMorallyVirtual,
1877 /*BaseIsVirtualInLayoutClass=*/false,
Ken Dyckce812032011-03-26 00:51:24 +00001878 Context.toBits(BaseOffsetInLayoutClass));
Anders Carlsson65b49782010-02-12 05:25:12 +00001879 }
1880}
1881
Anders Carlsson13f0f662010-02-16 16:49:35 +00001882void
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001883VTableBuilder::DeterminePrimaryVirtualBases(const CXXRecordDecl *RD,
Anders Carlsson02b99d62010-03-10 03:02:01 +00001884 uint64_t OffsetInLayoutClass,
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001885 VisitedVirtualBasesSetTy &VBases) {
1886 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1887
1888 // Check if this base has a primary base.
1889 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
Anders Carlsson8b37bb72010-02-28 18:08:38 +00001890
1891 // Check if it's virtual.
Anders Carlsson7f95cd12010-11-24 23:12:57 +00001892 if (Layout.isPrimaryBaseVirtual()) {
Anders Carlsson8b37bb72010-02-28 18:08:38 +00001893 bool IsPrimaryVirtualBase = true;
1894
Anders Carlssond78b2242010-04-11 22:07:06 +00001895 if (isBuildingConstructorVTable()) {
Anders Carlsson8b37bb72010-02-28 18:08:38 +00001896 // Check if the base is actually a primary base in the class we use for
1897 // layout.
Anders Carlsson02b99d62010-03-10 03:02:01 +00001898 const ASTRecordLayout &LayoutClassLayout =
1899 Context.getASTRecordLayout(LayoutClass);
1900
1901 uint64_t PrimaryBaseOffsetInLayoutClass =
Anders Carlssonfd88a612010-10-31 23:22:37 +00001902 LayoutClassLayout.getVBaseClassOffsetInBits(PrimaryBase);
Anders Carlsson02b99d62010-03-10 03:02:01 +00001903
1904 // We know that the base is not a primary base in the layout class if
1905 // the base offsets are different.
1906 if (PrimaryBaseOffsetInLayoutClass != OffsetInLayoutClass)
Anders Carlsson8b37bb72010-02-28 18:08:38 +00001907 IsPrimaryVirtualBase = false;
1908 }
1909
1910 if (IsPrimaryVirtualBase)
1911 PrimaryVirtualBases.insert(PrimaryBase);
1912 }
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001913 }
1914
1915 // Traverse bases, looking for more primary virtual bases.
1916 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1917 E = RD->bases_end(); I != E; ++I) {
1918 const CXXRecordDecl *BaseDecl =
1919 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1920
Anders Carlsson02b99d62010-03-10 03:02:01 +00001921 uint64_t BaseOffsetInLayoutClass;
1922
1923 if (I->isVirtual()) {
1924 if (!VBases.insert(BaseDecl))
1925 continue;
1926
1927 const ASTRecordLayout &LayoutClassLayout =
1928 Context.getASTRecordLayout(LayoutClass);
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001929
Anders Carlssonfd88a612010-10-31 23:22:37 +00001930 BaseOffsetInLayoutClass =
1931 LayoutClassLayout.getVBaseClassOffsetInBits(BaseDecl);
Anders Carlsson02b99d62010-03-10 03:02:01 +00001932 } else {
1933 BaseOffsetInLayoutClass =
Anders Carlssonfd88a612010-10-31 23:22:37 +00001934 OffsetInLayoutClass + Layout.getBaseClassOffsetInBits(BaseDecl);
Anders Carlsson02b99d62010-03-10 03:02:01 +00001935 }
1936
1937 DeterminePrimaryVirtualBases(BaseDecl, BaseOffsetInLayoutClass, VBases);
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001938 }
1939}
1940
1941void
Anders Carlssond78b2242010-04-11 22:07:06 +00001942VTableBuilder::LayoutVTablesForVirtualBases(const CXXRecordDecl *RD,
Anders Carlsson13f0f662010-02-16 16:49:35 +00001943 VisitedVirtualBasesSetTy &VBases) {
1944 // Itanium C++ ABI 2.5.2:
1945 // Then come the virtual base virtual tables, also in inheritance graph
1946 // order, and again excluding primary bases (which share virtual tables with
1947 // the classes for which they are primary).
Anders Carlsson13f0f662010-02-16 16:49:35 +00001948 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1949 E = RD->bases_end(); I != E; ++I) {
1950 const CXXRecordDecl *BaseDecl =
1951 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1952
Anders Carlsson0570f712010-02-23 03:48:14 +00001953 // Check if this base needs a vtable. (If it's virtual, not a primary base
1954 // of some other class, and we haven't visited it before).
Anders Carlsson13f0f662010-02-16 16:49:35 +00001955 if (I->isVirtual() && BaseDecl->isDynamicClass() &&
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001956 !PrimaryVirtualBases.count(BaseDecl) && VBases.insert(BaseDecl)) {
Anders Carlsson13f0f662010-02-16 16:49:35 +00001957 const ASTRecordLayout &MostDerivedClassLayout =
1958 Context.getASTRecordLayout(MostDerivedClass);
1959 uint64_t BaseOffset =
Anders Carlssonfd88a612010-10-31 23:22:37 +00001960 MostDerivedClassLayout.getVBaseClassOffsetInBits(BaseDecl);
Anders Carlsson13f0f662010-02-16 16:49:35 +00001961
Anders Carlssone3385f52010-02-28 01:43:58 +00001962 const ASTRecordLayout &LayoutClassLayout =
1963 Context.getASTRecordLayout(LayoutClass);
1964 uint64_t BaseOffsetInLayoutClass =
Anders Carlssonfd88a612010-10-31 23:22:37 +00001965 LayoutClassLayout.getVBaseClassOffsetInBits(BaseDecl);
Anders Carlssone3385f52010-02-28 01:43:58 +00001966
Ken Dyck16ffcac2011-03-24 01:21:01 +00001967 LayoutPrimaryAndSecondaryVTables(
1968 BaseSubobject(BaseDecl, Context.toCharUnitsFromBits(BaseOffset)),
1969 /*BaseIsMorallyVirtual=*/true,
1970 /*BaseIsVirtualInLayoutClass=*/true,
1971 BaseOffsetInLayoutClass);
Anders Carlsson13f0f662010-02-16 16:49:35 +00001972 }
1973
1974 // We only need to check the base for virtual base vtables if it actually
1975 // has virtual bases.
1976 if (BaseDecl->getNumVBases())
Anders Carlssond78b2242010-04-11 22:07:06 +00001977 LayoutVTablesForVirtualBases(BaseDecl, VBases);
Anders Carlsson13f0f662010-02-16 16:49:35 +00001978 }
1979}
1980
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001981/// dumpLayout - Dump the vtable layout.
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00001982void VTableBuilder::dumpLayout(llvm::raw_ostream& Out) {
Anders Carlsson93913752010-02-27 20:39:05 +00001983
Anders Carlssond78b2242010-04-11 22:07:06 +00001984 if (isBuildingConstructorVTable()) {
Anders Carlsson93913752010-02-27 20:39:05 +00001985 Out << "Construction vtable for ('";
1986 Out << MostDerivedClass->getQualifiedNameAsString() << "', ";
1987 // FIXME: Don't use / 8 .
1988 Out << MostDerivedClassOffset / 8 << ") in '";
1989 Out << LayoutClass->getQualifiedNameAsString();
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00001990 } else {
1991 Out << "Vtable for '";
1992 Out << MostDerivedClass->getQualifiedNameAsString();
Anders Carlsson93913752010-02-27 20:39:05 +00001993 }
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001994 Out << "' (" << Components.size() << " entries).\n";
1995
Anders Carlsson932c2f22010-02-11 17:18:51 +00001996 // Iterate through the address points and insert them into a new map where
1997 // they are keyed by the index and not the base object.
1998 // Since an address point can be shared by multiple subobjects, we use an
1999 // STL multimap.
2000 std::multimap<uint64_t, BaseSubobject> AddressPointsByIndex;
Anders Carlsson0534b022010-03-25 00:35:49 +00002001 for (AddressPointsMapTy::const_iterator I = AddressPoints.begin(),
2002 E = AddressPoints.end(); I != E; ++I) {
Anders Carlsson932c2f22010-02-11 17:18:51 +00002003 const BaseSubobject& Base = I->first;
2004 uint64_t Index = I->second;
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002005
Anders Carlsson932c2f22010-02-11 17:18:51 +00002006 AddressPointsByIndex.insert(std::make_pair(Index, Base));
2007 }
2008
2009 for (unsigned I = 0, E = Components.size(); I != E; ++I) {
Anders Carlssone8a97562010-02-12 07:43:48 +00002010 uint64_t Index = I;
Anders Carlsson932c2f22010-02-11 17:18:51 +00002011
2012 Out << llvm::format("%4d | ", I);
2013
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002014 const VTableComponent &Component = Components[I];
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002015
2016 // Dump the component.
2017 switch (Component.getKind()) {
Anders Carlssonb0a588f2010-02-17 06:07:19 +00002018
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002019 case VTableComponent::CK_VCallOffset:
Anders Carlssonb0a588f2010-02-17 06:07:19 +00002020 Out << "vcall_offset (" << Component.getVCallOffset() << ")";
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002021 break;
Anders Carlsson77904f12010-02-16 04:59:55 +00002022
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002023 case VTableComponent::CK_VBaseOffset:
Anders Carlsson77904f12010-02-16 04:59:55 +00002024 Out << "vbase_offset (" << Component.getVBaseOffset() << ")";
2025 break;
2026
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002027 case VTableComponent::CK_OffsetToTop:
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002028 Out << "offset_to_top (" << Component.getOffsetToTop() << ")";
2029 break;
2030
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002031 case VTableComponent::CK_RTTI:
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002032 Out << Component.getRTTIDecl()->getQualifiedNameAsString() << " RTTI";
2033 break;
2034
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002035 case VTableComponent::CK_FunctionPointer: {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002036 const CXXMethodDecl *MD = Component.getFunctionDecl();
2037
Anders Carlsson5bd8d192010-02-11 18:20:28 +00002038 std::string Str =
2039 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
2040 MD);
2041 Out << Str;
Anders Carlsson09da3372010-02-12 02:38:13 +00002042 if (MD->isPure())
2043 Out << " [pure]";
2044
Anders Carlsson7cea12f2010-03-23 04:44:10 +00002045 ThunkInfo Thunk = VTableThunks.lookup(I);
Anders Carlsson8a240292010-03-12 04:54:20 +00002046 if (!Thunk.isEmpty()) {
2047 // If this function pointer has a return adjustment, dump it.
2048 if (!Thunk.Return.isEmpty()) {
2049 Out << "\n [return adjustment: ";
2050 Out << Thunk.Return.NonVirtual << " non-virtual";
2051
2052 if (Thunk.Return.VBaseOffsetOffset) {
2053 Out << ", " << Thunk.Return.VBaseOffsetOffset;
2054 Out << " vbase offset offset";
2055 }
Anders Carlsson78277c72010-02-18 17:00:09 +00002056
Anders Carlsson8a240292010-03-12 04:54:20 +00002057 Out << ']';
2058 }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00002059
Anders Carlsson8a240292010-03-12 04:54:20 +00002060 // If this function pointer has a 'this' pointer adjustment, dump it.
2061 if (!Thunk.This.isEmpty()) {
2062 Out << "\n [this adjustment: ";
2063 Out << Thunk.This.NonVirtual << " non-virtual";
2064
2065 if (Thunk.This.VCallOffsetOffset) {
2066 Out << ", " << Thunk.This.VCallOffsetOffset;
2067 Out << " vcall offset offset";
2068 }
Anders Carlsson78277c72010-02-18 17:00:09 +00002069
Anders Carlsson8a240292010-03-12 04:54:20 +00002070 Out << ']';
2071 }
Anders Carlssond3adb0c2010-02-13 23:40:17 +00002072 }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00002073
Anders Carlsson5bd8d192010-02-11 18:20:28 +00002074 break;
2075 }
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002076
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002077 case VTableComponent::CK_CompleteDtorPointer:
2078 case VTableComponent::CK_DeletingDtorPointer: {
Anders Carlsson2d3d9032010-02-19 06:03:53 +00002079 bool IsComplete =
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002080 Component.getKind() == VTableComponent::CK_CompleteDtorPointer;
Anders Carlsson2d3d9032010-02-19 06:03:53 +00002081
Anders Carlsson5bd8d192010-02-11 18:20:28 +00002082 const CXXDestructorDecl *DD = Component.getDestructorDecl();
2083
Anders Carlsson2d3d9032010-02-19 06:03:53 +00002084 Out << DD->getQualifiedNameAsString();
2085 if (IsComplete)
2086 Out << "() [complete]";
2087 else
2088 Out << "() [deleting]";
2089
Anders Carlsson09da3372010-02-12 02:38:13 +00002090 if (DD->isPure())
2091 Out << " [pure]";
2092
Anders Carlsson7cea12f2010-03-23 04:44:10 +00002093 ThunkInfo Thunk = VTableThunks.lookup(I);
Anders Carlsson8a240292010-03-12 04:54:20 +00002094 if (!Thunk.isEmpty()) {
2095 // If this destructor has a 'this' pointer adjustment, dump it.
2096 if (!Thunk.This.isEmpty()) {
2097 Out << "\n [this adjustment: ";
2098 Out << Thunk.This.NonVirtual << " non-virtual";
2099
2100 if (Thunk.This.VCallOffsetOffset) {
2101 Out << ", " << Thunk.This.VCallOffsetOffset;
2102 Out << " vcall offset offset";
2103 }
2104
2105 Out << ']';
2106 }
2107 }
Anders Carlsson2d3d9032010-02-19 06:03:53 +00002108
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002109 break;
2110 }
2111
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002112 case VTableComponent::CK_UnusedFunctionPointer: {
Anders Carlsson350b56e2010-02-19 20:08:13 +00002113 const CXXMethodDecl *MD = Component.getUnusedFunctionDecl();
2114
2115 std::string Str =
2116 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
2117 MD);
2118 Out << "[unused] " << Str;
2119 if (MD->isPure())
2120 Out << " [pure]";
2121 }
2122
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002123 }
Anders Carlsson932c2f22010-02-11 17:18:51 +00002124
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002125 Out << '\n';
Anders Carlssonf98b47d32010-02-27 23:58:01 +00002126
2127 // Dump the next address point.
2128 uint64_t NextIndex = Index + 1;
2129 if (AddressPointsByIndex.count(NextIndex)) {
2130 if (AddressPointsByIndex.count(NextIndex) == 1) {
2131 const BaseSubobject &Base =
2132 AddressPointsByIndex.find(NextIndex)->second;
2133
2134 // FIXME: Instead of dividing by 8, we should be using CharUnits.
2135 Out << " -- (" << Base.getBase()->getQualifiedNameAsString();
Ken Dyck16ffcac2011-03-24 01:21:01 +00002136 Out << ", " << Base.getBaseOffset().getQuantity();
2137 Out << ") vtable address --\n";
Anders Carlssonf98b47d32010-02-27 23:58:01 +00002138 } else {
Ken Dyckce812032011-03-26 00:51:24 +00002139 CharUnits BaseOffset =
2140 AddressPointsByIndex.lower_bound(NextIndex)->second.getBaseOffset();
Anders Carlssonf98b47d32010-02-27 23:58:01 +00002141
2142 // We store the class names in a set to get a stable order.
2143 std::set<std::string> ClassNames;
2144 for (std::multimap<uint64_t, BaseSubobject>::const_iterator I =
2145 AddressPointsByIndex.lower_bound(NextIndex), E =
2146 AddressPointsByIndex.upper_bound(NextIndex); I != E; ++I) {
Ken Dyckce812032011-03-26 00:51:24 +00002147 assert(I->second.getBaseOffset() == BaseOffset &&
Anders Carlssonf98b47d32010-02-27 23:58:01 +00002148 "Invalid base offset!");
2149 const CXXRecordDecl *RD = I->second.getBase();
2150 ClassNames.insert(RD->getQualifiedNameAsString());
2151 }
2152
2153 for (std::set<std::string>::const_iterator I = ClassNames.begin(),
2154 E = ClassNames.end(); I != E; ++I) {
Anders Carlssonf98b47d32010-02-27 23:58:01 +00002155 Out << " -- (" << *I;
Ken Dyckce812032011-03-26 00:51:24 +00002156 Out << ", " << BaseOffset.getQuantity() << ") vtable address --\n";
Anders Carlssonf98b47d32010-02-27 23:58:01 +00002157 }
2158 }
2159 }
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002160 }
Anders Carlsson93913752010-02-27 20:39:05 +00002161
2162 Out << '\n';
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00002163
Anders Carlssond78b2242010-04-11 22:07:06 +00002164 if (isBuildingConstructorVTable())
Anders Carlsson18c582d2010-03-18 02:44:19 +00002165 return;
2166
2167 if (MostDerivedClass->getNumVBases()) {
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00002168 // We store the virtual base class names and their offsets in a map to get
2169 // a stable order.
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00002170
Anders Carlsson18c582d2010-03-18 02:44:19 +00002171 std::map<std::string, int64_t> ClassNamesAndOffsets;
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00002172 for (VBaseOffsetOffsetsMapTy::const_iterator I = VBaseOffsetOffsets.begin(),
2173 E = VBaseOffsetOffsets.end(); I != E; ++I) {
2174 std::string ClassName = I->first->getQualifiedNameAsString();
2175 int64_t OffsetOffset = I->second;
2176 ClassNamesAndOffsets.insert(std::make_pair(ClassName, OffsetOffset));
2177 }
Anders Carlsson18c582d2010-03-18 02:44:19 +00002178
2179 Out << "Virtual base offset offsets for '";
2180 Out << MostDerivedClass->getQualifiedNameAsString() << "' (";
2181 Out << ClassNamesAndOffsets.size();
2182 Out << (ClassNamesAndOffsets.size() == 1 ? " entry" : " entries") << ").\n";
Anders Carlsson7f6b71e2010-03-11 06:43:12 +00002183
2184 for (std::map<std::string, int64_t>::const_iterator I =
2185 ClassNamesAndOffsets.begin(), E = ClassNamesAndOffsets.end();
2186 I != E; ++I)
2187 Out << " " << I->first << " | " << I->second << '\n';
2188
2189 Out << "\n";
2190 }
Anders Carlsson18c582d2010-03-18 02:44:19 +00002191
Anders Carlsson7cea12f2010-03-23 04:44:10 +00002192 if (!Thunks.empty()) {
Anders Carlsson18c582d2010-03-18 02:44:19 +00002193 // We store the method names in a map to get a stable order.
2194 std::map<std::string, const CXXMethodDecl *> MethodNamesAndDecls;
2195
Anders Carlsson917229c2010-03-23 04:59:02 +00002196 for (ThunksMapTy::const_iterator I = Thunks.begin(), E = Thunks.end();
Anders Carlsson7cea12f2010-03-23 04:44:10 +00002197 I != E; ++I) {
Anders Carlsson18c582d2010-03-18 02:44:19 +00002198 const CXXMethodDecl *MD = I->first;
2199 std::string MethodName =
2200 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
2201 MD);
2202
2203 MethodNamesAndDecls.insert(std::make_pair(MethodName, MD));
2204 }
2205
2206 for (std::map<std::string, const CXXMethodDecl *>::const_iterator I =
2207 MethodNamesAndDecls.begin(), E = MethodNamesAndDecls.end();
2208 I != E; ++I) {
2209 const std::string &MethodName = I->first;
2210 const CXXMethodDecl *MD = I->second;
Anders Carlsson7eb99a62010-03-22 16:30:44 +00002211
Anders Carlsson917229c2010-03-23 04:59:02 +00002212 ThunkInfoVectorTy ThunksVector = Thunks[MD];
Anders Carlsson7eb99a62010-03-22 16:30:44 +00002213 std::sort(ThunksVector.begin(), ThunksVector.end());
Anders Carlsson18c582d2010-03-18 02:44:19 +00002214
2215 Out << "Thunks for '" << MethodName << "' (" << ThunksVector.size();
2216 Out << (ThunksVector.size() == 1 ? " entry" : " entries") << ").\n";
2217
2218 for (unsigned I = 0, E = ThunksVector.size(); I != E; ++I) {
2219 const ThunkInfo &Thunk = ThunksVector[I];
2220
2221 Out << llvm::format("%4d | ", I);
2222
Anders Carlsson53a47bf2010-03-22 16:10:59 +00002223 // If this function pointer has a return pointer adjustment, dump it.
2224 if (!Thunk.Return.isEmpty()) {
2225 Out << "return adjustment: " << Thunk.This.NonVirtual;
2226 Out << " non-virtual";
2227 if (Thunk.Return.VBaseOffsetOffset) {
2228 Out << ", " << Thunk.Return.VBaseOffsetOffset;
2229 Out << " vbase offset offset";
2230 }
2231
2232 if (!Thunk.This.isEmpty())
2233 Out << "\n ";
2234 }
2235
Anders Carlsson18c582d2010-03-18 02:44:19 +00002236 // If this function pointer has a 'this' pointer adjustment, dump it.
2237 if (!Thunk.This.isEmpty()) {
Anders Carlsson53a47bf2010-03-22 16:10:59 +00002238 Out << "this adjustment: ";
2239 Out << Thunk.This.NonVirtual << " non-virtual";
Anders Carlsson18c582d2010-03-18 02:44:19 +00002240
2241 if (Thunk.This.VCallOffsetOffset) {
2242 Out << ", " << Thunk.This.VCallOffsetOffset;
Anders Carlsson53a47bf2010-03-22 16:10:59 +00002243 Out << " vcall offset offset";
Anders Carlsson18c582d2010-03-18 02:44:19 +00002244 }
2245 }
2246
2247 Out << '\n';
2248 }
Anders Carlsson290c6ed2010-03-22 20:06:40 +00002249
2250 Out << '\n';
2251
Anders Carlsson18c582d2010-03-18 02:44:19 +00002252 }
2253 }
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002254}
2255
2256}
2257
Anders Carlssoncadbc462010-11-24 23:04:03 +00002258static void
2259CollectPrimaryBases(const CXXRecordDecl *RD, ASTContext &Context,
2260 VTableBuilder::PrimaryBasesSetVectorTy &PrimaryBases) {
2261 while (RD) {
2262 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
2263 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
2264 if (PrimaryBase)
2265 PrimaryBases.insert(PrimaryBase);
2266
2267 RD = PrimaryBase;
2268 }
2269}
2270
Anders Carlsson11e51402010-04-17 20:15:18 +00002271void CodeGenVTables::ComputeMethodVTableIndices(const CXXRecordDecl *RD) {
Anders Carlssonf942ee02009-11-27 20:47:55 +00002272
2273 // Itanium C++ ABI 2.5.2:
Anders Carlsson259688c2010-02-02 03:37:46 +00002274 // The order of the virtual function pointers in a virtual table is the
2275 // order of declaration of the corresponding member functions in the class.
Anders Carlssonf942ee02009-11-27 20:47:55 +00002276 //
Anders Carlsson259688c2010-02-02 03:37:46 +00002277 // There is an entry for any virtual function declared in a class,
2278 // whether it is a new function or overrides a base class function,
2279 // unless it overrides a function from the primary base, and conversion
2280 // between their return types does not require an adjustment.
Anders Carlssonf942ee02009-11-27 20:47:55 +00002281
2282 int64_t CurrentIndex = 0;
2283
2284 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
2285 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
2286
2287 if (PrimaryBase) {
Anders Carlssonc920fa22009-11-30 19:43:26 +00002288 assert(PrimaryBase->isDefinition() &&
2289 "Should have the definition decl of the primary base!");
Anders Carlssonf942ee02009-11-27 20:47:55 +00002290
2291 // Since the record decl shares its vtable pointer with the primary base
2292 // we need to start counting at the end of the primary base's vtable.
2293 CurrentIndex = getNumVirtualFunctionPointers(PrimaryBase);
2294 }
Eli Friedman21517252009-12-15 03:31:17 +00002295
2296 // Collect all the primary bases, so we can check whether methods override
2297 // a method from the base.
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002298 VTableBuilder::PrimaryBasesSetVectorTy PrimaryBases;
Anders Carlssoncadbc462010-11-24 23:04:03 +00002299 CollectPrimaryBases(RD, CGM.getContext(), PrimaryBases);
Eli Friedman21517252009-12-15 03:31:17 +00002300
Anders Carlssonf942ee02009-11-27 20:47:55 +00002301 const CXXDestructorDecl *ImplicitVirtualDtor = 0;
2302
2303 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
2304 e = RD->method_end(); i != e; ++i) {
2305 const CXXMethodDecl *MD = *i;
2306
2307 // We only want virtual methods.
2308 if (!MD->isVirtual())
2309 continue;
2310
Anders Carlssonf942ee02009-11-27 20:47:55 +00002311 // Check if this method overrides a method in the primary base.
Anders Carlsson65b49782010-02-12 05:25:12 +00002312 if (const CXXMethodDecl *OverriddenMD =
Anders Carlsson88cf34f2010-04-10 20:39:29 +00002313 FindNearestOverriddenMethod(MD, PrimaryBases)) {
Anders Carlsson65b49782010-02-12 05:25:12 +00002314 // Check if converting from the return type of the method to the
2315 // return type of the overridden method requires conversion.
Anders Carlssoncce9ee82010-02-13 23:17:31 +00002316 if (ComputeReturnAdjustmentBaseOffset(CGM.getContext(), MD,
2317 OverriddenMD).isEmpty()) {
Anders Carlsson65b49782010-02-12 05:25:12 +00002318 // This index is shared between the index in the vtable of the primary
2319 // base class.
2320 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2321 const CXXDestructorDecl *OverriddenDD =
2322 cast<CXXDestructorDecl>(OverriddenMD);
Anders Carlssonf942ee02009-11-27 20:47:55 +00002323
Anders Carlsson65b49782010-02-12 05:25:12 +00002324 // Add both the complete and deleting entries.
Anders Carlsson11e51402010-04-17 20:15:18 +00002325 MethodVTableIndices[GlobalDecl(DD, Dtor_Complete)] =
2326 getMethodVTableIndex(GlobalDecl(OverriddenDD, Dtor_Complete));
2327 MethodVTableIndices[GlobalDecl(DD, Dtor_Deleting)] =
2328 getMethodVTableIndex(GlobalDecl(OverriddenDD, Dtor_Deleting));
Anders Carlsson65b49782010-02-12 05:25:12 +00002329 } else {
Anders Carlsson11e51402010-04-17 20:15:18 +00002330 MethodVTableIndices[MD] = getMethodVTableIndex(OverriddenMD);
Anders Carlsson65b49782010-02-12 05:25:12 +00002331 }
2332
2333 // We don't need to add an entry for this method.
Anders Carlsson07604812010-02-12 18:14:46 +00002334 continue;
Anders Carlssonf942ee02009-11-27 20:47:55 +00002335 }
2336 }
2337
Anders Carlssonf942ee02009-11-27 20:47:55 +00002338 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2339 if (MD->isImplicit()) {
2340 assert(!ImplicitVirtualDtor &&
2341 "Did already see an implicit virtual dtor!");
2342 ImplicitVirtualDtor = DD;
2343 continue;
2344 }
Tilmann Schellere60baf72011-03-02 20:40:50 +00002345
Anders Carlssonf942ee02009-11-27 20:47:55 +00002346 // Add the complete dtor.
Anders Carlsson11e51402010-04-17 20:15:18 +00002347 MethodVTableIndices[GlobalDecl(DD, Dtor_Complete)] = CurrentIndex++;
Anders Carlssonf942ee02009-11-27 20:47:55 +00002348
2349 // Add the deleting dtor.
Anders Carlsson11e51402010-04-17 20:15:18 +00002350 MethodVTableIndices[GlobalDecl(DD, Dtor_Deleting)] = CurrentIndex++;
Anders Carlssonf942ee02009-11-27 20:47:55 +00002351 } else {
2352 // Add the entry.
Tilmann Schellere60baf72011-03-02 20:40:50 +00002353 MethodVTableIndices[MD] = CurrentIndex++;
Anders Carlssonf942ee02009-11-27 20:47:55 +00002354 }
2355 }
2356
2357 if (ImplicitVirtualDtor) {
2358 // Itanium C++ ABI 2.5.2:
Anders Carlssondc2dba32010-02-16 04:49:44 +00002359 // If a class has an implicitly-defined virtual destructor,
2360 // its entries come after the declared virtual function pointers.
Anders Carlssonf942ee02009-11-27 20:47:55 +00002361
2362 // Add the complete dtor.
Anders Carlsson11e51402010-04-17 20:15:18 +00002363 MethodVTableIndices[GlobalDecl(ImplicitVirtualDtor, Dtor_Complete)] =
Anders Carlssonf942ee02009-11-27 20:47:55 +00002364 CurrentIndex++;
2365
2366 // Add the deleting dtor.
Anders Carlsson11e51402010-04-17 20:15:18 +00002367 MethodVTableIndices[GlobalDecl(ImplicitVirtualDtor, Dtor_Deleting)] =
Anders Carlssonf942ee02009-11-27 20:47:55 +00002368 CurrentIndex++;
2369 }
2370
2371 NumVirtualFunctionPointers[RD] = CurrentIndex;
2372}
2373
Argyrios Kyrtzidis0c34b132010-10-11 03:25:57 +00002374bool CodeGenVTables::ShouldEmitVTableInThisTU(const CXXRecordDecl *RD) {
2375 assert(RD->isDynamicClass() && "Non dynamic classes have no VTable.");
2376
2377 TemplateSpecializationKind TSK = RD->getTemplateSpecializationKind();
2378 if (TSK == TSK_ExplicitInstantiationDeclaration)
2379 return false;
2380
2381 const CXXMethodDecl *KeyFunction = CGM.getContext().getKeyFunction(RD);
2382 if (!KeyFunction)
2383 return true;
2384
2385 // Itanium C++ ABI, 5.2.6 Instantiated Templates:
2386 // An instantiation of a class template requires:
2387 // - In the object where instantiated, the virtual table...
2388 if (TSK == TSK_ImplicitInstantiation ||
2389 TSK == TSK_ExplicitInstantiationDefinition)
2390 return true;
2391
Anders Carlssona03f3a82011-01-30 20:45:54 +00002392 // If we're building with optimization, we always emit VTables since that
2393 // allows for virtual function calls to be devirtualized.
2394 // (We don't want to do this in -fapple-kext mode however).
2395 if (CGM.getCodeGenOpts().OptimizationLevel && !CGM.getLangOptions().AppleKext)
2396 return true;
2397
Argyrios Kyrtzidis0c34b132010-10-11 03:25:57 +00002398 return KeyFunction->hasBody();
2399}
2400
Anders Carlssona864caf2010-03-23 04:11:45 +00002401uint64_t CodeGenVTables::getNumVirtualFunctionPointers(const CXXRecordDecl *RD) {
Anders Carlssonf942ee02009-11-27 20:47:55 +00002402 llvm::DenseMap<const CXXRecordDecl *, uint64_t>::iterator I =
2403 NumVirtualFunctionPointers.find(RD);
2404 if (I != NumVirtualFunctionPointers.end())
2405 return I->second;
2406
Anders Carlsson11e51402010-04-17 20:15:18 +00002407 ComputeMethodVTableIndices(RD);
Anders Carlssonf942ee02009-11-27 20:47:55 +00002408
2409 I = NumVirtualFunctionPointers.find(RD);
2410 assert(I != NumVirtualFunctionPointers.end() && "Did not find entry!");
2411 return I->second;
2412}
2413
Anders Carlsson11e51402010-04-17 20:15:18 +00002414uint64_t CodeGenVTables::getMethodVTableIndex(GlobalDecl GD) {
2415 MethodVTableIndicesTy::iterator I = MethodVTableIndices.find(GD);
2416 if (I != MethodVTableIndices.end())
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002417 return I->second;
2418
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002419 const CXXRecordDecl *RD = cast<CXXMethodDecl>(GD.getDecl())->getParent();
Anders Carlssonf942ee02009-11-27 20:47:55 +00002420
Anders Carlsson11e51402010-04-17 20:15:18 +00002421 ComputeMethodVTableIndices(RD);
Anders Carlssonf942ee02009-11-27 20:47:55 +00002422
Anders Carlsson11e51402010-04-17 20:15:18 +00002423 I = MethodVTableIndices.find(GD);
2424 assert(I != MethodVTableIndices.end() && "Did not find index!");
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002425 return I->second;
2426}
2427
Anders Carlssona864caf2010-03-23 04:11:45 +00002428int64_t CodeGenVTables::getVirtualBaseOffsetOffset(const CXXRecordDecl *RD,
2429 const CXXRecordDecl *VBase) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002430 ClassPairTy ClassPair(RD, VBase);
2431
Anders Carlsson4cbe83c2010-03-11 07:15:17 +00002432 VirtualBaseClassOffsetOffsetsMapTy::iterator I =
2433 VirtualBaseClassOffsetOffsets.find(ClassPair);
2434 if (I != VirtualBaseClassOffsetOffsets.end())
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002435 return I->second;
2436
Anders Carlssondd819c92010-03-11 16:06:20 +00002437 VCallAndVBaseOffsetBuilder Builder(RD, RD, /*FinalOverriders=*/0,
Ken Dyck16ffcac2011-03-24 01:21:01 +00002438 BaseSubobject(RD, CharUnits::Zero()),
Anders Carlssondd819c92010-03-11 16:06:20 +00002439 /*BaseIsVirtual=*/false,
2440 /*OffsetInLayoutClass=*/0);
Anders Carlssondd819c92010-03-11 16:06:20 +00002441
2442 for (VCallAndVBaseOffsetBuilder::VBaseOffsetOffsetsMapTy::const_iterator I =
2443 Builder.getVBaseOffsetOffsets().begin(),
2444 E = Builder.getVBaseOffsetOffsets().end(); I != E; ++I) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002445 // Insert all types.
2446 ClassPairTy ClassPair(RD, I->first);
2447
Anders Carlsson4cbe83c2010-03-11 07:15:17 +00002448 VirtualBaseClassOffsetOffsets.insert(std::make_pair(ClassPair, I->second));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002449 }
2450
Anders Carlsson4cbe83c2010-03-11 07:15:17 +00002451 I = VirtualBaseClassOffsetOffsets.find(ClassPair);
Anders Carlsson4cbe83c2010-03-11 07:15:17 +00002452 assert(I != VirtualBaseClassOffsetOffsets.end() && "Did not find index!");
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002453
2454 return I->second;
2455}
2456
Anders Carlssonf6f24c62010-03-29 02:08:26 +00002457uint64_t
2458CodeGenVTables::getAddressPoint(BaseSubobject Base, const CXXRecordDecl *RD) {
Anders Carlssonae9e9a62010-04-08 16:18:36 +00002459 assert(AddressPoints.count(std::make_pair(RD, Base)) &&
2460 "Did not find address point!");
2461
Anders Carlssona627ac7e2010-03-29 03:38:52 +00002462 uint64_t AddressPoint = AddressPoints.lookup(std::make_pair(RD, Base));
Anders Carlssonf6f24c62010-03-29 02:08:26 +00002463 assert(AddressPoint && "Address point must not be zero!");
Anders Carlssona627ac7e2010-03-29 03:38:52 +00002464
Anders Carlssonf6f24c62010-03-29 02:08:26 +00002465 return AddressPoint;
2466}
2467
Anders Carlssoncd836f02010-03-23 17:17:29 +00002468llvm::Constant *CodeGenModule::GetAddrOfThunk(GlobalDecl GD,
Anders Carlssonfe8a9932011-02-06 17:15:43 +00002469 const ThunkInfo &Thunk) {
Anders Carlssoncd836f02010-03-23 17:17:29 +00002470 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2471
2472 // Compute the mangled name.
2473 llvm::SmallString<256> Name;
Rafael Espindola3968cd02011-02-11 02:52:17 +00002474 llvm::raw_svector_ostream Out(Name);
Anders Carlssoncd836f02010-03-23 17:17:29 +00002475 if (const CXXDestructorDecl* DD = dyn_cast<CXXDestructorDecl>(MD))
John McCall5d865c322010-08-31 07:33:07 +00002476 getCXXABI().getMangleContext().mangleCXXDtorThunk(DD, GD.getDtorType(),
Rafael Espindola3968cd02011-02-11 02:52:17 +00002477 Thunk.This, Out);
Anders Carlssoncd836f02010-03-23 17:17:29 +00002478 else
Rafael Espindola3968cd02011-02-11 02:52:17 +00002479 getCXXABI().getMangleContext().mangleThunk(MD, Thunk, Out);
2480 Out.flush();
2481
John McCall5d865c322010-08-31 07:33:07 +00002482 const llvm::Type *Ty = getTypes().GetFunctionTypeForVTable(GD);
Anders Carlssonfe8a9932011-02-06 17:15:43 +00002483 return GetOrCreateLLVMFunction(Name, Ty, GD, /*ForVTable=*/true);
Anders Carlssoncd836f02010-03-23 17:17:29 +00002484}
2485
Anders Carlssonbad991d2010-03-24 00:39:18 +00002486static llvm::Value *PerformTypeAdjustment(CodeGenFunction &CGF,
2487 llvm::Value *Ptr,
2488 int64_t NonVirtualAdjustment,
2489 int64_t VirtualAdjustment) {
2490 if (!NonVirtualAdjustment && !VirtualAdjustment)
2491 return Ptr;
2492
2493 const llvm::Type *Int8PtrTy =
2494 llvm::Type::getInt8PtrTy(CGF.getLLVMContext());
2495
2496 llvm::Value *V = CGF.Builder.CreateBitCast(Ptr, Int8PtrTy);
2497
2498 if (NonVirtualAdjustment) {
2499 // Do the non-virtual adjustment.
2500 V = CGF.Builder.CreateConstInBoundsGEP1_64(V, NonVirtualAdjustment);
2501 }
2502
2503 if (VirtualAdjustment) {
2504 const llvm::Type *PtrDiffTy =
2505 CGF.ConvertType(CGF.getContext().getPointerDiffType());
2506
2507 // Do the virtual adjustment.
2508 llvm::Value *VTablePtrPtr =
2509 CGF.Builder.CreateBitCast(V, Int8PtrTy->getPointerTo());
2510
2511 llvm::Value *VTablePtr = CGF.Builder.CreateLoad(VTablePtrPtr);
2512
2513 llvm::Value *OffsetPtr =
2514 CGF.Builder.CreateConstInBoundsGEP1_64(VTablePtr, VirtualAdjustment);
2515
2516 OffsetPtr = CGF.Builder.CreateBitCast(OffsetPtr, PtrDiffTy->getPointerTo());
2517
2518 // Load the adjustment offset from the vtable.
2519 llvm::Value *Offset = CGF.Builder.CreateLoad(OffsetPtr);
2520
2521 // Adjust our pointer.
2522 V = CGF.Builder.CreateInBoundsGEP(V, Offset);
2523 }
2524
2525 // Cast back to the original type.
2526 return CGF.Builder.CreateBitCast(V, Ptr->getType());
2527}
2528
John McCallc8bd9c22010-08-04 23:46:35 +00002529static void setThunkVisibility(CodeGenModule &CGM, const CXXMethodDecl *MD,
2530 const ThunkInfo &Thunk, llvm::Function *Fn) {
Anders Carlssonc6a47892011-01-29 19:39:23 +00002531 CGM.setGlobalVisibility(Fn, MD);
John McCallc8bd9c22010-08-04 23:46:35 +00002532
John McCallb3732bb2010-08-12 23:36:15 +00002533 if (!CGM.getCodeGenOpts().HiddenWeakVTables)
2534 return;
2535
John McCallc8bd9c22010-08-04 23:46:35 +00002536 // If the thunk has weak/linkonce linkage, but the function must be
2537 // emitted in every translation unit that references it, then we can
2538 // emit its thunks with hidden visibility, since its thunks must be
2539 // emitted when the function is.
2540
John McCall5513fce92010-08-05 20:39:18 +00002541 // This follows CodeGenModule::setTypeVisibility; see the comments
2542 // there for explanation.
John McCallc8bd9c22010-08-04 23:46:35 +00002543
2544 if ((Fn->getLinkage() != llvm::GlobalVariable::LinkOnceODRLinkage &&
2545 Fn->getLinkage() != llvm::GlobalVariable::WeakODRLinkage) ||
2546 Fn->getVisibility() != llvm::GlobalVariable::DefaultVisibility)
2547 return;
2548
John McCallc8bd9c22010-08-04 23:46:35 +00002549 if (MD->hasAttr<VisibilityAttr>())
2550 return;
2551
2552 switch (MD->getTemplateSpecializationKind()) {
John McCallc8bd9c22010-08-04 23:46:35 +00002553 case TSK_ExplicitInstantiationDefinition:
2554 case TSK_ExplicitInstantiationDeclaration:
2555 return;
2556
John McCallc8bd9c22010-08-04 23:46:35 +00002557 case TSK_Undeclared:
2558 break;
2559
John McCall5513fce92010-08-05 20:39:18 +00002560 case TSK_ExplicitSpecialization:
John McCallc8bd9c22010-08-04 23:46:35 +00002561 case TSK_ImplicitInstantiation:
John McCallb3732bb2010-08-12 23:36:15 +00002562 if (!CGM.getCodeGenOpts().HiddenWeakTemplateVTables)
John McCall5513fce92010-08-05 20:39:18 +00002563 return;
John McCallc8bd9c22010-08-04 23:46:35 +00002564 break;
2565 }
2566
2567 // If there's an explicit definition, and that definition is
2568 // out-of-line, then we can't assume that all users will have a
2569 // definition to emit.
2570 const FunctionDecl *Def = 0;
2571 if (MD->hasBody(Def) && Def->isOutOfLine())
2572 return;
2573
2574 Fn->setVisibility(llvm::GlobalValue::HiddenVisibility);
2575}
2576
John McCall5fe00962011-03-09 07:12:35 +00002577#ifndef NDEBUG
2578static bool similar(const ABIArgInfo &infoL, CanQualType typeL,
2579 const ABIArgInfo &infoR, CanQualType typeR) {
2580 return (infoL.getKind() == infoR.getKind() &&
2581 (typeL == typeR ||
2582 (isa<PointerType>(typeL) && isa<PointerType>(typeR)) ||
2583 (isa<ReferenceType>(typeL) && isa<ReferenceType>(typeR))));
2584}
2585#endif
2586
John McCalla738c252011-03-09 04:27:21 +00002587void CodeGenFunction::GenerateThunk(llvm::Function *Fn,
2588 const CGFunctionInfo &FnInfo,
2589 GlobalDecl GD, const ThunkInfo &Thunk) {
Anders Carlssonbad991d2010-03-24 00:39:18 +00002590 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2591 const FunctionProtoType *FPT = MD->getType()->getAs<FunctionProtoType>();
2592 QualType ResultType = FPT->getResultType();
2593 QualType ThisType = MD->getThisType(getContext());
2594
2595 FunctionArgList FunctionArgs;
2596
2597 // FIXME: It would be nice if more of this code could be shared with
2598 // CodeGenFunction::GenerateCode.
2599
2600 // Create the implicit 'this' parameter declaration.
John McCall5d865c322010-08-31 07:33:07 +00002601 CurGD = GD;
2602 CGM.getCXXABI().BuildInstanceFunctionParams(*this, ResultType, FunctionArgs);
Anders Carlssonbad991d2010-03-24 00:39:18 +00002603
2604 // Add the rest of the parameters.
2605 for (FunctionDecl::param_const_iterator I = MD->param_begin(),
2606 E = MD->param_end(); I != E; ++I) {
2607 ParmVarDecl *Param = *I;
2608
John McCalla738c252011-03-09 04:27:21 +00002609 FunctionArgs.push_back(Param);
Anders Carlssonbad991d2010-03-24 00:39:18 +00002610 }
Tilmann Scheller99cc30c2011-03-02 21:36:49 +00002611
John McCalla738c252011-03-09 04:27:21 +00002612 StartFunction(GlobalDecl(), ResultType, Fn, FnInfo, FunctionArgs,
2613 SourceLocation());
Anders Carlssonbad991d2010-03-24 00:39:18 +00002614
John McCall5d865c322010-08-31 07:33:07 +00002615 CGM.getCXXABI().EmitInstanceFunctionProlog(*this);
2616
Anders Carlssonbad991d2010-03-24 00:39:18 +00002617 // Adjust the 'this' pointer if necessary.
2618 llvm::Value *AdjustedThisPtr =
2619 PerformTypeAdjustment(*this, LoadCXXThis(),
2620 Thunk.This.NonVirtual,
2621 Thunk.This.VCallOffsetOffset);
2622
2623 CallArgList CallArgs;
2624
2625 // Add our adjusted 'this' pointer.
2626 CallArgs.push_back(std::make_pair(RValue::get(AdjustedThisPtr), ThisType));
2627
2628 // Add the rest of the parameters.
2629 for (FunctionDecl::param_const_iterator I = MD->param_begin(),
2630 E = MD->param_end(); I != E; ++I) {
John McCall32ea9692011-03-11 20:59:21 +00002631 ParmVarDecl *param = *I;
2632 EmitDelegateCallArg(CallArgs, param);
Anders Carlssonbad991d2010-03-24 00:39:18 +00002633 }
2634
2635 // Get our callee.
2636 const llvm::Type *Ty =
John McCall5d865c322010-08-31 07:33:07 +00002637 CGM.getTypes().GetFunctionType(CGM.getTypes().getFunctionInfo(GD),
Anders Carlssonbad991d2010-03-24 00:39:18 +00002638 FPT->isVariadic());
Anders Carlssonfe8a9932011-02-06 17:15:43 +00002639 llvm::Value *Callee = CGM.GetAddrOfFunction(GD, Ty, /*ForVTable=*/true);
Anders Carlssonbad991d2010-03-24 00:39:18 +00002640
John McCalla738c252011-03-09 04:27:21 +00002641#ifndef NDEBUG
2642 const CGFunctionInfo &CallFnInfo =
2643 CGM.getTypes().getFunctionInfo(ResultType, CallArgs, FPT->getExtInfo());
John McCall5fe00962011-03-09 07:12:35 +00002644 assert(CallFnInfo.getRegParm() == FnInfo.getRegParm() &&
2645 CallFnInfo.isNoReturn() == FnInfo.isNoReturn() &&
2646 CallFnInfo.getCallingConvention() == FnInfo.getCallingConvention());
2647 assert(similar(CallFnInfo.getReturnInfo(), CallFnInfo.getReturnType(),
2648 FnInfo.getReturnInfo(), FnInfo.getReturnType()));
2649 assert(CallFnInfo.arg_size() == FnInfo.arg_size());
2650 for (unsigned i = 0, e = FnInfo.arg_size(); i != e; ++i)
2651 assert(similar(CallFnInfo.arg_begin()[i].info,
2652 CallFnInfo.arg_begin()[i].type,
2653 FnInfo.arg_begin()[i].info, FnInfo.arg_begin()[i].type));
John McCalla738c252011-03-09 04:27:21 +00002654#endif
Anders Carlssonbad991d2010-03-24 00:39:18 +00002655
Douglas Gregoraa2ac802010-05-20 05:54:35 +00002656 // Determine whether we have a return value slot to use.
2657 ReturnValueSlot Slot;
2658 if (!ResultType->isVoidType() &&
2659 FnInfo.getReturnInfo().getKind() == ABIArgInfo::Indirect &&
2660 hasAggregateLLVMType(CurFnInfo->getReturnType()))
2661 Slot = ReturnValueSlot(ReturnValue, ResultType.isVolatileQualified());
2662
Anders Carlssonbad991d2010-03-24 00:39:18 +00002663 // Now emit our call.
Douglas Gregoraa2ac802010-05-20 05:54:35 +00002664 RValue RV = EmitCall(FnInfo, Callee, Slot, CallArgs, MD);
Anders Carlssonbad991d2010-03-24 00:39:18 +00002665
2666 if (!Thunk.Return.isEmpty()) {
2667 // Emit the return adjustment.
2668 bool NullCheckValue = !ResultType->isReferenceType();
2669
2670 llvm::BasicBlock *AdjustNull = 0;
2671 llvm::BasicBlock *AdjustNotNull = 0;
2672 llvm::BasicBlock *AdjustEnd = 0;
2673
2674 llvm::Value *ReturnValue = RV.getScalarVal();
2675
2676 if (NullCheckValue) {
2677 AdjustNull = createBasicBlock("adjust.null");
2678 AdjustNotNull = createBasicBlock("adjust.notnull");
2679 AdjustEnd = createBasicBlock("adjust.end");
2680
2681 llvm::Value *IsNull = Builder.CreateIsNull(ReturnValue);
2682 Builder.CreateCondBr(IsNull, AdjustNull, AdjustNotNull);
2683 EmitBlock(AdjustNotNull);
2684 }
2685
2686 ReturnValue = PerformTypeAdjustment(*this, ReturnValue,
2687 Thunk.Return.NonVirtual,
2688 Thunk.Return.VBaseOffsetOffset);
2689
2690 if (NullCheckValue) {
2691 Builder.CreateBr(AdjustEnd);
2692 EmitBlock(AdjustNull);
2693 Builder.CreateBr(AdjustEnd);
2694 EmitBlock(AdjustEnd);
2695
2696 llvm::PHINode *PHI = Builder.CreatePHI(ReturnValue->getType());
2697 PHI->reserveOperandSpace(2);
2698 PHI->addIncoming(ReturnValue, AdjustNotNull);
2699 PHI->addIncoming(llvm::Constant::getNullValue(ReturnValue->getType()),
2700 AdjustNull);
2701 ReturnValue = PHI;
2702 }
2703
2704 RV = RValue::get(ReturnValue);
2705 }
2706
Douglas Gregoraa2ac802010-05-20 05:54:35 +00002707 if (!ResultType->isVoidType() && Slot.isNull())
John McCallad7c5c12011-02-08 08:22:06 +00002708 CGM.getCXXABI().EmitReturnFromThunk(*this, RV, ResultType);
Anders Carlssonbad991d2010-03-24 00:39:18 +00002709
2710 FinishFunction();
2711
Anders Carlssonbad991d2010-03-24 00:39:18 +00002712 // Set the right linkage.
John McCall7cb02202010-05-25 04:30:21 +00002713 CGM.setFunctionLinkage(MD, Fn);
Anders Carlssonbad991d2010-03-24 00:39:18 +00002714
2715 // Set the right visibility.
John McCallc8bd9c22010-08-04 23:46:35 +00002716 setThunkVisibility(CGM, MD, Thunk, Fn);
Anders Carlssonbad991d2010-03-24 00:39:18 +00002717}
2718
Anders Carlsson8b021832011-02-06 18:31:40 +00002719void CodeGenVTables::EmitThunk(GlobalDecl GD, const ThunkInfo &Thunk,
2720 bool UseAvailableExternallyLinkage)
Anders Carlsson5c5abad2010-03-23 16:36:50 +00002721{
John McCalla738c252011-03-09 04:27:21 +00002722 const CGFunctionInfo &FnInfo = CGM.getTypes().getFunctionInfo(GD);
2723
2724 // FIXME: re-use FnInfo in this computation.
Anders Carlssonfe8a9932011-02-06 17:15:43 +00002725 llvm::Constant *Entry = CGM.GetAddrOfThunk(GD, Thunk);
Anders Carlssoncd836f02010-03-23 17:17:29 +00002726
Anders Carlsson55e89f82010-03-23 18:18:41 +00002727 // Strip off a bitcast if we got one back.
Anders Carlsson4a3cdf52010-03-24 00:35:44 +00002728 if (llvm::ConstantExpr *CE = dyn_cast<llvm::ConstantExpr>(Entry)) {
Anders Carlsson55e89f82010-03-23 18:18:41 +00002729 assert(CE->getOpcode() == llvm::Instruction::BitCast);
Anders Carlsson4a3cdf52010-03-24 00:35:44 +00002730 Entry = CE->getOperand(0);
Anders Carlsson55e89f82010-03-23 18:18:41 +00002731 }
2732
Anders Carlsson55e89f82010-03-23 18:18:41 +00002733 // There's already a declaration with the same name, check if it has the same
2734 // type or if we need to replace it.
Anders Carlsson4a3cdf52010-03-24 00:35:44 +00002735 if (cast<llvm::GlobalValue>(Entry)->getType()->getElementType() !=
John McCall5d865c322010-08-31 07:33:07 +00002736 CGM.getTypes().GetFunctionTypeForVTable(GD)) {
Anders Carlsson4a3cdf52010-03-24 00:35:44 +00002737 llvm::GlobalValue *OldThunkFn = cast<llvm::GlobalValue>(Entry);
Anders Carlsson55e89f82010-03-23 18:18:41 +00002738
2739 // If the types mismatch then we have to rewrite the definition.
2740 assert(OldThunkFn->isDeclaration() &&
2741 "Shouldn't replace non-declaration");
2742
2743 // Remove the name from the old thunk function and get a new thunk.
2744 OldThunkFn->setName(llvm::StringRef());
Anders Carlssonfe8a9932011-02-06 17:15:43 +00002745 Entry = CGM.GetAddrOfThunk(GD, Thunk);
Anders Carlsson55e89f82010-03-23 18:18:41 +00002746
2747 // If needed, replace the old thunk with a bitcast.
2748 if (!OldThunkFn->use_empty()) {
2749 llvm::Constant *NewPtrForOldDecl =
Anders Carlsson4a3cdf52010-03-24 00:35:44 +00002750 llvm::ConstantExpr::getBitCast(Entry, OldThunkFn->getType());
Anders Carlsson55e89f82010-03-23 18:18:41 +00002751 OldThunkFn->replaceAllUsesWith(NewPtrForOldDecl);
2752 }
2753
2754 // Remove the old thunk.
2755 OldThunkFn->eraseFromParent();
2756 }
Anders Carlssonbad991d2010-03-24 00:39:18 +00002757
Anders Carlssonbad991d2010-03-24 00:39:18 +00002758 llvm::Function *ThunkFn = cast<llvm::Function>(Entry);
Anders Carlsson8b021832011-02-06 18:31:40 +00002759
2760 if (!ThunkFn->isDeclaration()) {
2761 if (UseAvailableExternallyLinkage) {
2762 // There is already a thunk emitted for this function, do nothing.
2763 return;
2764 }
2765
Anders Carlssone866d442011-02-06 20:09:44 +00002766 // If a function has a body, it should have available_externally linkage.
2767 assert(ThunkFn->hasAvailableExternallyLinkage() &&
2768 "Function should have available_externally linkage!");
2769
2770 // Change the linkage.
2771 CGM.setFunctionLinkage(cast<CXXMethodDecl>(GD.getDecl()), ThunkFn);
2772 return;
Anders Carlsson8b021832011-02-06 18:31:40 +00002773 }
2774
2775 // Actually generate the thunk body.
John McCalla738c252011-03-09 04:27:21 +00002776 CodeGenFunction(CGM).GenerateThunk(ThunkFn, FnInfo, GD, Thunk);
Anders Carlsson8b021832011-02-06 18:31:40 +00002777
2778 if (UseAvailableExternallyLinkage)
2779 ThunkFn->setLinkage(llvm::GlobalValue::AvailableExternallyLinkage);
2780}
2781
2782void CodeGenVTables::MaybeEmitThunkAvailableExternally(GlobalDecl GD,
2783 const ThunkInfo &Thunk) {
2784 // We only want to do this when building with optimizations.
2785 if (!CGM.getCodeGenOpts().OptimizationLevel)
2786 return;
2787
2788 // We can't emit thunks for member functions with incomplete types.
2789 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2790 if (CGM.getTypes().VerifyFuncTypeComplete(MD->getType().getTypePtr()))
2791 return;
2792
2793 EmitThunk(GD, Thunk, /*UseAvailableExternallyLinkage=*/true);
Anders Carlsson5c5abad2010-03-23 16:36:50 +00002794}
2795
Anders Carlsson917229c2010-03-23 04:59:02 +00002796void CodeGenVTables::EmitThunks(GlobalDecl GD)
2797{
Anders Carlsson5c5abad2010-03-23 16:36:50 +00002798 const CXXMethodDecl *MD =
2799 cast<CXXMethodDecl>(GD.getDecl())->getCanonicalDecl();
2800
2801 // We don't need to generate thunks for the base destructor.
2802 if (isa<CXXDestructorDecl>(MD) && GD.getDtorType() == Dtor_Base)
2803 return;
2804
2805 const CXXRecordDecl *RD = MD->getParent();
2806
Anders Carlssone90954d2010-03-24 16:42:11 +00002807 // Compute VTable related info for this class.
John McCall6a7f9f52010-06-02 21:22:02 +00002808 ComputeVTableRelatedInformation(RD, false);
Anders Carlssone90954d2010-03-24 16:42:11 +00002809
Anders Carlsson5c5abad2010-03-23 16:36:50 +00002810 ThunksMapTy::const_iterator I = Thunks.find(MD);
2811 if (I == Thunks.end()) {
Anders Carlssone90954d2010-03-24 16:42:11 +00002812 // We did not find a thunk for this method.
2813 return;
Anders Carlsson5c5abad2010-03-23 16:36:50 +00002814 }
Anders Carlssone90954d2010-03-24 16:42:11 +00002815
Anders Carlsson5c5abad2010-03-23 16:36:50 +00002816 const ThunkInfoVectorTy &ThunkInfoVector = I->second;
2817 for (unsigned I = 0, E = ThunkInfoVector.size(); I != E; ++I)
Anders Carlsson8b021832011-02-06 18:31:40 +00002818 EmitThunk(GD, ThunkInfoVector[I], /*UseAvailableExternallyLinkage=*/false);
Anders Carlsson917229c2010-03-23 04:59:02 +00002819}
2820
John McCall6a7f9f52010-06-02 21:22:02 +00002821void CodeGenVTables::ComputeVTableRelatedInformation(const CXXRecordDecl *RD,
2822 bool RequireVTable) {
2823 VTableLayoutData &Entry = VTableLayoutMap[RD];
Douglas Gregor88d292c2010-05-13 16:44:06 +00002824
2825 // We may need to generate a definition for this vtable.
John McCall6a7f9f52010-06-02 21:22:02 +00002826 if (RequireVTable && !Entry.getInt()) {
Argyrios Kyrtzidis0c34b132010-10-11 03:25:57 +00002827 if (ShouldEmitVTableInThisTU(RD))
John McCall6a7f9f52010-06-02 21:22:02 +00002828 CGM.DeferredVTables.push_back(RD);
2829
2830 Entry.setInt(true);
2831 }
2832
2833 // Check if we've computed this information before.
2834 if (Entry.getPointer())
2835 return;
Douglas Gregor88d292c2010-05-13 16:44:06 +00002836
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002837 VTableBuilder Builder(*this, RD, 0, /*MostDerivedClassIsVirtual=*/0, RD);
Anders Carlssone90954d2010-03-24 16:42:11 +00002838
2839 // Add the VTable layout.
2840 uint64_t NumVTableComponents = Builder.getNumVTableComponents();
Fariborz Jahanian9f9438b2011-01-28 23:42:29 +00002841 // -fapple-kext adds an extra entry at end of vtbl.
2842 bool IsAppleKext = CGM.getContext().getLangOptions().AppleKext;
2843 if (IsAppleKext)
2844 NumVTableComponents += 1;
2845
John McCall6a7f9f52010-06-02 21:22:02 +00002846 uint64_t *LayoutData = new uint64_t[NumVTableComponents + 1];
Fariborz Jahanian9f9438b2011-01-28 23:42:29 +00002847 if (IsAppleKext)
2848 LayoutData[NumVTableComponents] = 0;
John McCall6a7f9f52010-06-02 21:22:02 +00002849 Entry.setPointer(LayoutData);
Anders Carlssone90954d2010-03-24 16:42:11 +00002850
2851 // Store the number of components.
2852 LayoutData[0] = NumVTableComponents;
2853
2854 // Store the components.
2855 std::copy(Builder.vtable_components_data_begin(),
2856 Builder.vtable_components_data_end(),
2857 &LayoutData[1]);
2858
2859 // Add the known thunks.
2860 Thunks.insert(Builder.thunks_begin(), Builder.thunks_end());
2861
Anders Carlsson9a97e2e2010-03-29 01:38:05 +00002862 // Add the thunks needed in this vtable.
2863 assert(!VTableThunksMap.count(RD) &&
2864 "Thunks already exists for this vtable!");
2865
2866 VTableThunksTy &VTableThunks = VTableThunksMap[RD];
2867 VTableThunks.append(Builder.vtable_thunks_begin(),
2868 Builder.vtable_thunks_end());
2869
2870 // Sort them.
2871 std::sort(VTableThunks.begin(), VTableThunks.end());
2872
Anders Carlssond03325c2010-03-25 00:51:13 +00002873 // Add the address points.
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002874 for (VTableBuilder::AddressPointsMapTy::const_iterator I =
Anders Carlssond03325c2010-03-25 00:51:13 +00002875 Builder.address_points_begin(), E = Builder.address_points_end();
2876 I != E; ++I) {
2877
2878 uint64_t &AddressPoint = AddressPoints[std::make_pair(RD, I->first)];
2879
2880 // Check if we already have the address points for this base.
2881 assert(!AddressPoint && "Address point already exists for this base!");
2882
2883 AddressPoint = I->second;
2884 }
2885
Anders Carlssone90954d2010-03-24 16:42:11 +00002886 // If we don't have the vbase information for this class, insert it.
2887 // getVirtualBaseOffsetOffset will compute it separately without computing
2888 // the rest of the vtable related information.
2889 if (!RD->getNumVBases())
2890 return;
2891
2892 const RecordType *VBaseRT =
2893 RD->vbases_begin()->getType()->getAs<RecordType>();
2894 const CXXRecordDecl *VBase = cast<CXXRecordDecl>(VBaseRT->getDecl());
2895
2896 if (VirtualBaseClassOffsetOffsets.count(std::make_pair(RD, VBase)))
2897 return;
2898
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002899 for (VTableBuilder::VBaseOffsetOffsetsMapTy::const_iterator I =
Anders Carlssone90954d2010-03-24 16:42:11 +00002900 Builder.getVBaseOffsetOffsets().begin(),
2901 E = Builder.getVBaseOffsetOffsets().end(); I != E; ++I) {
2902 // Insert all types.
2903 ClassPairTy ClassPair(RD, I->first);
2904
2905 VirtualBaseClassOffsetOffsets.insert(std::make_pair(ClassPair, I->second));
2906 }
2907}
2908
Anders Carlssona4147142010-03-25 15:26:28 +00002909llvm::Constant *
2910CodeGenVTables::CreateVTableInitializer(const CXXRecordDecl *RD,
2911 const uint64_t *Components,
2912 unsigned NumComponents,
2913 const VTableThunksTy &VTableThunks) {
2914 llvm::SmallVector<llvm::Constant *, 64> Inits;
2915
2916 const llvm::Type *Int8PtrTy = llvm::Type::getInt8PtrTy(CGM.getLLVMContext());
2917
Anders Carlssona5736bd2010-03-25 16:49:53 +00002918 const llvm::Type *PtrDiffTy =
2919 CGM.getTypes().ConvertType(CGM.getContext().getPointerDiffType());
2920
2921 QualType ClassType = CGM.getContext().getTagDeclType(RD);
2922 llvm::Constant *RTTI = CGM.GetAddrOfRTTIDescriptor(ClassType);
2923
2924 unsigned NextVTableThunkIndex = 0;
2925
Anders Carlssoncb6207f2010-03-29 05:40:50 +00002926 llvm::Constant* PureVirtualFn = 0;
2927
Anders Carlssona4147142010-03-25 15:26:28 +00002928 for (unsigned I = 0; I != NumComponents; ++I) {
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002929 VTableComponent Component =
2930 VTableComponent::getFromOpaqueInteger(Components[I]);
Anders Carlssona5736bd2010-03-25 16:49:53 +00002931
2932 llvm::Constant *Init = 0;
2933
2934 switch (Component.getKind()) {
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002935 case VTableComponent::CK_VCallOffset:
Anders Carlssona5736bd2010-03-25 16:49:53 +00002936 Init = llvm::ConstantInt::get(PtrDiffTy, Component.getVCallOffset());
2937 Init = llvm::ConstantExpr::getIntToPtr(Init, Int8PtrTy);
2938 break;
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002939 case VTableComponent::CK_VBaseOffset:
Anders Carlssona5736bd2010-03-25 16:49:53 +00002940 Init = llvm::ConstantInt::get(PtrDiffTy, Component.getVBaseOffset());
2941 Init = llvm::ConstantExpr::getIntToPtr(Init, Int8PtrTy);
2942 break;
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002943 case VTableComponent::CK_OffsetToTop:
Anders Carlssona5736bd2010-03-25 16:49:53 +00002944 Init = llvm::ConstantInt::get(PtrDiffTy, Component.getOffsetToTop());
2945 Init = llvm::ConstantExpr::getIntToPtr(Init, Int8PtrTy);
2946 break;
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002947 case VTableComponent::CK_RTTI:
Anders Carlssona5736bd2010-03-25 16:49:53 +00002948 Init = llvm::ConstantExpr::getBitCast(RTTI, Int8PtrTy);
2949 break;
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002950 case VTableComponent::CK_FunctionPointer:
2951 case VTableComponent::CK_CompleteDtorPointer:
2952 case VTableComponent::CK_DeletingDtorPointer: {
Anders Carlssona5736bd2010-03-25 16:49:53 +00002953 GlobalDecl GD;
2954
2955 // Get the right global decl.
2956 switch (Component.getKind()) {
2957 default:
2958 llvm_unreachable("Unexpected vtable component kind");
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002959 case VTableComponent::CK_FunctionPointer:
Anders Carlssona5736bd2010-03-25 16:49:53 +00002960 GD = Component.getFunctionDecl();
2961 break;
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002962 case VTableComponent::CK_CompleteDtorPointer:
Anders Carlssona5736bd2010-03-25 16:49:53 +00002963 GD = GlobalDecl(Component.getDestructorDecl(), Dtor_Complete);
2964 break;
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00002965 case VTableComponent::CK_DeletingDtorPointer:
Anders Carlssona5736bd2010-03-25 16:49:53 +00002966 GD = GlobalDecl(Component.getDestructorDecl(), Dtor_Deleting);
2967 break;
2968 }
2969
Anders Carlssoncb6207f2010-03-29 05:40:50 +00002970 if (cast<CXXMethodDecl>(GD.getDecl())->isPure()) {
2971 // We have a pure virtual member function.
2972 if (!PureVirtualFn) {
2973 const llvm::FunctionType *Ty =
2974 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2975 /*isVarArg=*/false);
2976 PureVirtualFn =
2977 CGM.CreateRuntimeFunction(Ty, "__cxa_pure_virtual");
2978 PureVirtualFn = llvm::ConstantExpr::getBitCast(PureVirtualFn,
2979 Int8PtrTy);
2980 }
Anders Carlssona5736bd2010-03-25 16:49:53 +00002981
Anders Carlssoncb6207f2010-03-29 05:40:50 +00002982 Init = PureVirtualFn;
Anders Carlssona5736bd2010-03-25 16:49:53 +00002983 } else {
Anders Carlssoncb6207f2010-03-29 05:40:50 +00002984 // Check if we should use a thunk.
2985 if (NextVTableThunkIndex < VTableThunks.size() &&
2986 VTableThunks[NextVTableThunkIndex].first == I) {
2987 const ThunkInfo &Thunk = VTableThunks[NextVTableThunkIndex].second;
Anders Carlssona5736bd2010-03-25 16:49:53 +00002988
Anders Carlssonfe8a9932011-02-06 17:15:43 +00002989 Init = CGM.GetAddrOfThunk(GD, Thunk);
Anders Carlsson8b021832011-02-06 18:31:40 +00002990 MaybeEmitThunkAvailableExternally(GD, Thunk);
2991
Anders Carlssoncb6207f2010-03-29 05:40:50 +00002992 NextVTableThunkIndex++;
2993 } else {
John McCall5d865c322010-08-31 07:33:07 +00002994 const llvm::Type *Ty = CGM.getTypes().GetFunctionTypeForVTable(GD);
Anders Carlssoncb6207f2010-03-29 05:40:50 +00002995
Anders Carlsson3c239482011-02-05 04:35:53 +00002996 Init = CGM.GetAddrOfFunction(GD, Ty, /*ForVTable=*/true);
Anders Carlssoncb6207f2010-03-29 05:40:50 +00002997 }
2998
2999 Init = llvm::ConstantExpr::getBitCast(Init, Int8PtrTy);
Anders Carlssona5736bd2010-03-25 16:49:53 +00003000 }
Anders Carlssona5736bd2010-03-25 16:49:53 +00003001 break;
3002 }
3003
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00003004 case VTableComponent::CK_UnusedFunctionPointer:
Anders Carlssona5736bd2010-03-25 16:49:53 +00003005 Init = llvm::ConstantExpr::getNullValue(Int8PtrTy);
3006 break;
3007 };
Anders Carlssona4147142010-03-25 15:26:28 +00003008
3009 Inits.push_back(Init);
3010 }
3011
3012 llvm::ArrayType *ArrayType = llvm::ArrayType::get(Int8PtrTy, NumComponents);
3013 return llvm::ConstantArray::get(ArrayType, Inits.data(), Inits.size());
3014}
3015
Anders Carlssona086edc2010-03-30 03:35:35 +00003016llvm::GlobalVariable *CodeGenVTables::GetAddrOfVTable(const CXXRecordDecl *RD) {
Anders Carlssonb35ea552010-03-24 03:57:14 +00003017 llvm::SmallString<256> OutName;
Rafael Espindola3968cd02011-02-11 02:52:17 +00003018 llvm::raw_svector_ostream Out(OutName);
3019 CGM.getCXXABI().getMangleContext().mangleCXXVTable(RD, Out);
3020 Out.flush();
Anders Carlssonb35ea552010-03-24 03:57:14 +00003021 llvm::StringRef Name = OutName.str();
Mike Stumpaa51ad62009-11-19 04:04:36 +00003022
John McCall6a7f9f52010-06-02 21:22:02 +00003023 ComputeVTableRelatedInformation(RD, true);
Anders Carlssone90954d2010-03-24 16:42:11 +00003024
Anders Carlssonb35ea552010-03-24 03:57:14 +00003025 const llvm::Type *Int8PtrTy = llvm::Type::getInt8PtrTy(CGM.getLLVMContext());
Anders Carlssone90954d2010-03-24 16:42:11 +00003026 llvm::ArrayType *ArrayType =
3027 llvm::ArrayType::get(Int8PtrTy, getNumVTableComponents(RD));
Anders Carlssona627ac7e2010-03-29 03:38:52 +00003028
Rafael Espindola5674c642011-01-11 21:10:26 +00003029 llvm::GlobalVariable *GV =
Anders Carlsson93be9a92011-01-29 18:25:07 +00003030 CGM.CreateOrReplaceCXXRuntimeVariable(Name, ArrayType,
3031 llvm::GlobalValue::ExternalLinkage);
Rafael Espindolafacb7d02011-01-15 08:23:14 +00003032 GV->setUnnamedAddr(true);
Rafael Espindola5674c642011-01-11 21:10:26 +00003033 return GV;
Mike Stumpd846d082009-11-10 07:44:33 +00003034}
Mike Stumpeac45592009-11-11 20:26:26 +00003035
Anders Carlssona627ac7e2010-03-29 03:38:52 +00003036void
3037CodeGenVTables::EmitVTableDefinition(llvm::GlobalVariable *VTable,
3038 llvm::GlobalVariable::LinkageTypes Linkage,
3039 const CXXRecordDecl *RD) {
3040 // Dump the vtable layout if necessary.
Anders Carlsson11e51402010-04-17 20:15:18 +00003041 if (CGM.getLangOptions().DumpVTableLayouts) {
Anders Carlssonbe1b9cb2010-04-10 19:13:06 +00003042 VTableBuilder Builder(*this, RD, 0, /*MostDerivedClassIsVirtual=*/0, RD);
Anders Carlssona627ac7e2010-03-29 03:38:52 +00003043
3044 Builder.dumpLayout(llvm::errs());
3045 }
3046
3047 assert(VTableThunksMap.count(RD) &&
3048 "No thunk status for this record decl!");
3049
3050 const VTableThunksTy& Thunks = VTableThunksMap[RD];
3051
3052 // Create and set the initializer.
3053 llvm::Constant *Init =
3054 CreateVTableInitializer(RD, getVTableComponentsData(RD),
3055 getNumVTableComponents(RD), Thunks);
3056 VTable->setInitializer(Init);
Anders Carlssoncb6207f2010-03-29 05:40:50 +00003057
3058 // Set the correct linkage.
3059 VTable->setLinkage(Linkage);
Douglas Gregor4f6e8de2010-06-14 23:41:45 +00003060
3061 // Set the right visibility.
Anders Carlsson265aa7c2011-01-29 20:24:48 +00003062 CGM.setTypeVisibility(VTable, RD, CodeGenModule::TVK_ForVTable);
Anders Carlssona627ac7e2010-03-29 03:38:52 +00003063}
3064
Anders Carlsson0534b022010-03-25 00:35:49 +00003065llvm::GlobalVariable *
3066CodeGenVTables::GenerateConstructionVTable(const CXXRecordDecl *RD,
Anders Carlssona208b392010-03-26 03:56:54 +00003067 const BaseSubobject &Base,
3068 bool BaseIsVirtual,
3069 VTableAddressPointsMapTy& AddressPoints) {
Ken Dyck16ffcac2011-03-24 01:21:01 +00003070 VTableBuilder Builder(*this, Base.getBase(),
3071 CGM.getContext().toBits(Base.getBaseOffset()),
Anders Carlssona4147142010-03-25 15:26:28 +00003072 /*MostDerivedClassIsVirtual=*/BaseIsVirtual, RD);
3073
Anders Carlssona5736bd2010-03-25 16:49:53 +00003074 // Dump the vtable layout if necessary.
Anders Carlsson11e51402010-04-17 20:15:18 +00003075 if (CGM.getLangOptions().DumpVTableLayouts)
Anders Carlssona5736bd2010-03-25 16:49:53 +00003076 Builder.dumpLayout(llvm::errs());
3077
3078 // Add the address points.
Anders Carlssona208b392010-03-26 03:56:54 +00003079 AddressPoints.insert(Builder.address_points_begin(),
3080 Builder.address_points_end());
Anders Carlssona4147142010-03-25 15:26:28 +00003081
3082 // Get the mangled construction vtable name.
3083 llvm::SmallString<256> OutName;
Rafael Espindola3968cd02011-02-11 02:52:17 +00003084 llvm::raw_svector_ostream Out(OutName);
John McCall5d865c322010-08-31 07:33:07 +00003085 CGM.getCXXABI().getMangleContext().
Ken Dyck16ffcac2011-03-24 01:21:01 +00003086 mangleCXXCtorVTable(RD, Base.getBaseOffset().getQuantity(), Base.getBase(),
3087 Out);
Rafael Espindola3968cd02011-02-11 02:52:17 +00003088 Out.flush();
Anders Carlssona4147142010-03-25 15:26:28 +00003089 llvm::StringRef Name = OutName.str();
3090
3091 const llvm::Type *Int8PtrTy = llvm::Type::getInt8PtrTy(CGM.getLLVMContext());
3092 llvm::ArrayType *ArrayType =
3093 llvm::ArrayType::get(Int8PtrTy, Builder.getNumVTableComponents());
3094
3095 // Create the variable that will hold the construction vtable.
3096 llvm::GlobalVariable *VTable =
Anders Carlsson93be9a92011-01-29 18:25:07 +00003097 CGM.CreateOrReplaceCXXRuntimeVariable(Name, ArrayType,
3098 llvm::GlobalValue::InternalLinkage);
Anders Carlssona4147142010-03-25 15:26:28 +00003099
3100 // Add the thunks.
3101 VTableThunksTy VTableThunks;
3102 VTableThunks.append(Builder.vtable_thunks_begin(),
3103 Builder.vtable_thunks_end());
3104
Anders Carlsson848d86e2010-03-29 01:28:05 +00003105 // Sort them.
3106 std::sort(VTableThunks.begin(), VTableThunks.end());
3107
Anders Carlssona4147142010-03-25 15:26:28 +00003108 // Create and set the initializer.
3109 llvm::Constant *Init =
3110 CreateVTableInitializer(Base.getBase(),
3111 Builder.vtable_components_data_begin(),
3112 Builder.getNumVTableComponents(), VTableThunks);
3113 VTable->setInitializer(Init);
3114
Anders Carlsson0534b022010-03-25 00:35:49 +00003115 return VTable;
3116}
3117
Anders Carlssona627ac7e2010-03-29 03:38:52 +00003118void
3119CodeGenVTables::GenerateClassData(llvm::GlobalVariable::LinkageTypes Linkage,
3120 const CXXRecordDecl *RD) {
Anders Carlsson11e51402010-04-17 20:15:18 +00003121 llvm::GlobalVariable *&VTable = VTables[RD];
Anders Carlssona627ac7e2010-03-29 03:38:52 +00003122 if (VTable) {
Anders Carlsson11e51402010-04-17 20:15:18 +00003123 assert(VTable->getInitializer() && "VTable doesn't have a definition!");
Anders Carlssona627ac7e2010-03-29 03:38:52 +00003124 return;
3125 }
3126
Anders Carlssona086edc2010-03-30 03:35:35 +00003127 VTable = GetAddrOfVTable(RD);
3128 EmitVTableDefinition(VTable, Linkage, RD);
3129
Anders Carlsson883fc722011-01-29 19:16:51 +00003130 if (RD->getNumVBases()) {
3131 llvm::GlobalVariable *VTT = GetAddrOfVTT(RD);
3132 EmitVTTDefinition(VTT, Linkage, RD);
3133 }
Douglas Gregoreadd3ca2010-04-08 15:52:03 +00003134
3135 // If this is the magic class __cxxabiv1::__fundamental_type_info,
3136 // we will emit the typeinfo for the fundamental types. This is the
3137 // same behaviour as GCC.
3138 const DeclContext *DC = RD->getDeclContext();
3139 if (RD->getIdentifier() &&
3140 RD->getIdentifier()->isStr("__fundamental_type_info") &&
3141 isa<NamespaceDecl>(DC) &&
3142 cast<NamespaceDecl>(DC)->getIdentifier() &&
3143 cast<NamespaceDecl>(DC)->getIdentifier()->isStr("__cxxabiv1") &&
3144 DC->getParent()->isTranslationUnit())
3145 CGM.EmitFundamentalRTTIDescriptors();
Anders Carlssona627ac7e2010-03-29 03:38:52 +00003146}