blob: 6c1b331be7815dc397511b8971b5dee373abe547 [file] [log] [blame]
Anders Carlsson046c2942010-04-17 20:15:18 +00001//===--- CGVTables.cpp - Emit LLVM Code for C++ vtables -------------------===//
Anders Carlssondbd920c2009-10-11 22:13:54 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This contains code dealing with C++ code generation of virtual tables.
11//
12//===----------------------------------------------------------------------===//
13
14#include "CodeGenModule.h"
15#include "CodeGenFunction.h"
John McCall4c40d982010-08-31 07:33:07 +000016#include "CGCXXABI.h"
Anders Carlssond6b07fb2009-11-27 20:47:55 +000017#include "clang/AST/CXXInheritance.h"
Anders Carlssondbd920c2009-10-11 22:13:54 +000018#include "clang/AST/RecordLayout.h"
John McCall7a536902010-08-05 20:39:18 +000019#include "clang/Frontend/CodeGenOptions.h"
Anders Carlsson5dd730a2009-11-26 19:32:45 +000020#include "llvm/ADT/DenseSet.h"
Anders Carlssonb9021e92010-02-27 16:18:19 +000021#include "llvm/ADT/SetVector.h"
Chandler Carruthe087f072010-02-13 10:38:52 +000022#include "llvm/Support/Compiler.h"
Anders Carlsson824d7ea2010-02-11 08:02:13 +000023#include "llvm/Support/Format.h"
Anders Carlsson5e454aa2010-03-17 20:06:32 +000024#include <algorithm>
Zhongxing Xu7fe26ac2009-11-13 05:46:16 +000025#include <cstdio>
Anders Carlssondbd920c2009-10-11 22:13:54 +000026
27using namespace clang;
28using namespace CodeGen;
29
Anders Carlsson27f69d02009-11-27 22:21:51 +000030namespace {
Anders Carlsson824d7ea2010-02-11 08:02:13 +000031
Anders Carlsson2fca9be2010-02-23 01:34:28 +000032/// BaseOffset - Represents an offset from a derived class to a direct or
33/// indirect base class.
34struct BaseOffset {
35 /// DerivedClass - The derived class.
36 const CXXRecordDecl *DerivedClass;
37
38 /// VirtualBase - If the path from the derived class to the base class
39 /// involves a virtual base class, this holds its declaration.
40 const CXXRecordDecl *VirtualBase;
41
42 /// NonVirtualOffset - The offset from the derived class to the base class.
43 /// (Or the offset from the virtual base class to the base class, if the
44 /// path from the derived class to the base class involves a virtual base
45 /// class.
46 int64_t NonVirtualOffset;
47
48 BaseOffset() : DerivedClass(0), VirtualBase(0), NonVirtualOffset(0) { }
49 BaseOffset(const CXXRecordDecl *DerivedClass,
50 const CXXRecordDecl *VirtualBase, int64_t NonVirtualOffset)
51 : DerivedClass(DerivedClass), VirtualBase(VirtualBase),
52 NonVirtualOffset(NonVirtualOffset) { }
53
54 bool isEmpty() const { return !NonVirtualOffset && !VirtualBase; }
55};
56
Anders Carlssonbdf73d82010-02-11 21:24:32 +000057/// FinalOverriders - Contains the final overrider member functions for all
58/// member functions in the base subobjects of a class.
59class FinalOverriders {
Anders Carlssona7575822010-02-12 16:55:34 +000060public:
61 /// OverriderInfo - Information about a final overrider.
62 struct OverriderInfo {
63 /// Method - The method decl of the overrider.
64 const CXXMethodDecl *Method;
Anders Carlsson96309c42010-02-18 16:29:24 +000065
Anders Carlssondb4022c2010-03-10 02:33:41 +000066 /// Offset - the base offset of the overrider in the layout class.
Ken Dyck17d85192011-03-26 01:29:16 +000067 CharUnits Offset;
Anders Carlssona7575822010-02-12 16:55:34 +000068
Ken Dyck17d85192011-03-26 01:29:16 +000069 OverriderInfo() : Method(0), Offset(CharUnits::Zero()) { }
Anders Carlssona7575822010-02-12 16:55:34 +000070 };
71
72private:
Anders Carlssonbdf73d82010-02-11 21:24:32 +000073 /// MostDerivedClass - The most derived class for which the final overriders
74 /// are stored.
75 const CXXRecordDecl *MostDerivedClass;
76
Anders Carlssondb4022c2010-03-10 02:33:41 +000077 /// MostDerivedClassOffset - If we're building final overriders for a
78 /// construction vtable, this holds the offset from the layout class to the
79 /// most derived class.
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 Carlssonbdf73d82010-02-11 21:24:32 +000087 ASTContext &Context;
88
89 /// MostDerivedClassLayout - the AST record layout of the most derived class.
90 const ASTRecordLayout &MostDerivedClassLayout;
91
Anders Carlsson0a028602010-06-01 23:52:26 +000092 /// MethodBaseOffsetPairTy - Uniquely identifies a member function
Anders Carlsson0c0eeb22010-02-13 02:02:03 +000093 /// in a base subobject.
Ken Dycke6203132011-03-26 01:18:17 +000094 typedef std::pair<const CXXMethodDecl *, CharUnits> MethodBaseOffsetPairTy;
Anders Carlsson0a028602010-06-01 23:52:26 +000095
96 typedef llvm::DenseMap<MethodBaseOffsetPairTy,
Anders Carlssona7575822010-02-12 16:55:34 +000097 OverriderInfo> OverridersMapTy;
Anders Carlssonbdf73d82010-02-11 21:24:32 +000098
99 /// OverridersMap - The final overriders for all virtual member functions of
100 /// all the base subobjects of the most derived class.
101 OverridersMapTy OverridersMap;
102
Anders Carlsson147a23d2010-06-04 00:54:04 +0000103 /// SubobjectsToOffsetsMapTy - A mapping from a base subobject (represented
104 /// as a record decl and a subobject number) and its offsets in the most
105 /// derived class as well as the layout class.
106 typedef llvm::DenseMap<std::pair<const CXXRecordDecl *, unsigned>,
Ken Dyck35c416b2011-03-26 01:09:13 +0000107 CharUnits> SubobjectOffsetMapTy;
Anders Carlsson147a23d2010-06-04 00:54:04 +0000108
109 typedef llvm::DenseMap<const CXXRecordDecl *, unsigned> SubobjectCountMapTy;
110
111 /// ComputeBaseOffsets - Compute the offsets for all base subobjects of the
112 /// given base.
113 void ComputeBaseOffsets(BaseSubobject Base, bool IsVirtual,
Ken Dyckb4c82b42011-03-26 01:36:26 +0000114 CharUnits OffsetInLayoutClass,
Anders Carlsson147a23d2010-06-04 00:54:04 +0000115 SubobjectOffsetMapTy &SubobjectOffsets,
116 SubobjectOffsetMapTy &SubobjectLayoutClassOffsets,
117 SubobjectCountMapTy &SubobjectCounts);
118
Anders Carlssonb9cae1d2010-06-04 00:59:37 +0000119 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
120
121 /// dump - dump the final overriders for a base subobject, and all its direct
122 /// and indirect base subobjects.
123 void dump(llvm::raw_ostream &Out, BaseSubobject Base,
124 VisitedVirtualBasesSetTy& VisitedVirtualBases);
125
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000126public:
Anders Carlssondb4022c2010-03-10 02:33:41 +0000127 FinalOverriders(const CXXRecordDecl *MostDerivedClass,
128 uint64_t MostDerivedClassOffset,
129 const CXXRecordDecl *LayoutClass);
Anders Carlsson2157d302010-02-24 22:18:01 +0000130
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000131 /// getOverrider - Get the final overrider for the given method declaration in
Anders Carlsson26387642010-06-01 23:17:37 +0000132 /// the subobject with the given base offset.
133 OverriderInfo getOverrider(const CXXMethodDecl *MD,
Ken Dycke6203132011-03-26 01:18:17 +0000134 CharUnits BaseOffset) const {
Anders Carlsson0a028602010-06-01 23:52:26 +0000135 assert(OverridersMap.count(std::make_pair(MD, BaseOffset)) &&
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000136 "Did not find overrider!");
137
Anders Carlsson0a028602010-06-01 23:52:26 +0000138 return OverridersMap.lookup(std::make_pair(MD, BaseOffset));
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000139 }
140
141 /// dump - dump the final overriders.
Anders Carlsson9d6f0d52010-02-14 00:37:35 +0000142 void dump() {
Anders Carlssonb9cae1d2010-06-04 00:59:37 +0000143 VisitedVirtualBasesSetTy VisitedVirtualBases;
Ken Dyck4230d522011-03-24 01:21:01 +0000144 dump(llvm::errs(), BaseSubobject(MostDerivedClass, CharUnits::Zero()),
145 VisitedVirtualBases);
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000146 }
147
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000148};
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000149
Anders Carlsson327568e2010-02-27 20:02:53 +0000150#define DUMP_OVERRIDERS 0
151
Anders Carlssondb4022c2010-03-10 02:33:41 +0000152FinalOverriders::FinalOverriders(const CXXRecordDecl *MostDerivedClass,
153 uint64_t MostDerivedClassOffset,
154 const CXXRecordDecl *LayoutClass)
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000155 : MostDerivedClass(MostDerivedClass),
Anders Carlssondb4022c2010-03-10 02:33:41 +0000156 MostDerivedClassOffset(MostDerivedClassOffset), LayoutClass(LayoutClass),
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000157 Context(MostDerivedClass->getASTContext()),
158 MostDerivedClassLayout(Context.getASTRecordLayout(MostDerivedClass)) {
Anders Carlssonb9cae1d2010-06-04 00:59:37 +0000159
Anders Carlsson147a23d2010-06-04 00:54:04 +0000160 // Compute base offsets.
161 SubobjectOffsetMapTy SubobjectOffsets;
162 SubobjectOffsetMapTy SubobjectLayoutClassOffsets;
163 SubobjectCountMapTy SubobjectCounts;
Ken Dyck4230d522011-03-24 01:21:01 +0000164 ComputeBaseOffsets(BaseSubobject(MostDerivedClass, CharUnits::Zero()),
165 /*IsVirtual=*/false,
Ken Dyckb4c82b42011-03-26 01:36:26 +0000166 Context.toCharUnitsFromBits(MostDerivedClassOffset),
167 SubobjectOffsets, SubobjectLayoutClassOffsets,
168 SubobjectCounts);
Anders Carlsson147a23d2010-06-04 00:54:04 +0000169
170 // Get the the final overriders.
171 CXXFinalOverriderMap FinalOverriders;
172 MostDerivedClass->getFinalOverriders(FinalOverriders);
173
174 for (CXXFinalOverriderMap::const_iterator I = FinalOverriders.begin(),
175 E = FinalOverriders.end(); I != E; ++I) {
176 const CXXMethodDecl *MD = I->first;
177 const OverridingMethods& Methods = I->second;
178
179 for (OverridingMethods::const_iterator I = Methods.begin(),
180 E = Methods.end(); I != E; ++I) {
181 unsigned SubobjectNumber = I->first;
182 assert(SubobjectOffsets.count(std::make_pair(MD->getParent(),
183 SubobjectNumber)) &&
184 "Did not find subobject offset!");
185
Ken Dyck35c416b2011-03-26 01:09:13 +0000186 CharUnits BaseOffset = SubobjectOffsets[std::make_pair(MD->getParent(),
Anders Carlsson147a23d2010-06-04 00:54:04 +0000187 SubobjectNumber)];
188
189 assert(I->second.size() == 1 && "Final overrider is not unique!");
190 const UniqueVirtualMethod &Method = I->second.front();
191
192 const CXXRecordDecl *OverriderRD = Method.Method->getParent();
193 assert(SubobjectLayoutClassOffsets.count(
194 std::make_pair(OverriderRD, Method.Subobject))
195 && "Did not find subobject offset!");
Ken Dyck35c416b2011-03-26 01:09:13 +0000196 CharUnits OverriderOffset =
Anders Carlsson147a23d2010-06-04 00:54:04 +0000197 SubobjectLayoutClassOffsets[std::make_pair(OverriderRD,
198 Method.Subobject)];
199
Ken Dycke6203132011-03-26 01:18:17 +0000200 OverriderInfo& Overrider = OverridersMap[std::make_pair(MD, BaseOffset)];
Anders Carlsson147a23d2010-06-04 00:54:04 +0000201 assert(!Overrider.Method && "Overrider should not exist yet!");
202
Ken Dyck17d85192011-03-26 01:29:16 +0000203 Overrider.Offset = OverriderOffset;
Anders Carlsson147a23d2010-06-04 00:54:04 +0000204 Overrider.Method = Method.Method;
205 }
206 }
Anders Carlsson327568e2010-02-27 20:02:53 +0000207
208#if DUMP_OVERRIDERS
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000209 // And dump them (for now).
210 dump();
Anders Carlsson327568e2010-02-27 20:02:53 +0000211#endif
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000212}
213
Anders Carlsson2fca9be2010-02-23 01:34:28 +0000214static BaseOffset ComputeBaseOffset(ASTContext &Context,
215 const CXXRecordDecl *DerivedRD,
216 const CXXBasePath &Path) {
Anders Carlssondf31af12010-02-13 23:17:31 +0000217 int64_t NonVirtualOffset = 0;
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000218
Anders Carlssona4a54172010-02-13 20:41:15 +0000219 unsigned NonVirtualStart = 0;
220 const CXXRecordDecl *VirtualBase = 0;
221
222 // First, look for the virtual base class.
223 for (unsigned I = 0, E = Path.size(); I != E; ++I) {
224 const CXXBasePathElement &Element = Path[I];
225
226 if (Element.Base->isVirtual()) {
227 // FIXME: Can we break when we find the first virtual base?
228 // (If we can't, can't we just iterate over the path in reverse order?)
229 NonVirtualStart = I + 1;
230 QualType VBaseType = Element.Base->getType();
231 VirtualBase =
232 cast<CXXRecordDecl>(VBaseType->getAs<RecordType>()->getDecl());
233 }
234 }
235
236 // Now compute the non-virtual offset.
237 for (unsigned I = NonVirtualStart, E = Path.size(); I != E; ++I) {
238 const CXXBasePathElement &Element = Path[I];
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000239
240 // Check the base class offset.
241 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Element.Class);
Anders Carlssonbf554f62010-02-25 22:18:35 +0000242
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000243 const RecordType *BaseType = Element.Base->getType()->getAs<RecordType>();
244 const CXXRecordDecl *Base = cast<CXXRecordDecl>(BaseType->getDecl());
Anders Carlssonbf554f62010-02-25 22:18:35 +0000245
Anders Carlssona14f5972010-10-31 23:22:37 +0000246 NonVirtualOffset += Layout.getBaseClassOffsetInBits(Base);
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000247 }
248
249 // FIXME: This should probably use CharUnits or something. Maybe we should
250 // even change the base offsets in ASTRecordLayout to be specified in
251 // CharUnits.
Anders Carlsson2fca9be2010-02-23 01:34:28 +0000252 return BaseOffset(DerivedRD, VirtualBase, NonVirtualOffset / 8);
Anders Carlssone67dc302010-02-14 00:16:19 +0000253
254}
255
Anders Carlsson2fca9be2010-02-23 01:34:28 +0000256static BaseOffset ComputeBaseOffset(ASTContext &Context,
257 const CXXRecordDecl *BaseRD,
258 const CXXRecordDecl *DerivedRD) {
Anders Carlssone67dc302010-02-14 00:16:19 +0000259 CXXBasePaths Paths(/*FindAmbiguities=*/false,
260 /*RecordPaths=*/true, /*DetectVirtual=*/false);
261
262 if (!const_cast<CXXRecordDecl *>(DerivedRD)->
263 isDerivedFrom(const_cast<CXXRecordDecl *>(BaseRD), Paths)) {
264 assert(false && "Class must be derived from the passed in base class!");
Anders Carlsson2fca9be2010-02-23 01:34:28 +0000265 return BaseOffset();
Anders Carlssone67dc302010-02-14 00:16:19 +0000266 }
267
268 return ComputeBaseOffset(Context, DerivedRD, Paths.front());
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000269}
270
Anders Carlsson2fca9be2010-02-23 01:34:28 +0000271static BaseOffset
Anders Carlssondf31af12010-02-13 23:17:31 +0000272ComputeReturnAdjustmentBaseOffset(ASTContext &Context,
273 const CXXMethodDecl *DerivedMD,
274 const CXXMethodDecl *BaseMD) {
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000275 const FunctionType *BaseFT = BaseMD->getType()->getAs<FunctionType>();
276 const FunctionType *DerivedFT = DerivedMD->getType()->getAs<FunctionType>();
277
278 // Canonicalize the return types.
279 CanQualType CanDerivedReturnType =
280 Context.getCanonicalType(DerivedFT->getResultType());
281 CanQualType CanBaseReturnType =
282 Context.getCanonicalType(BaseFT->getResultType());
283
284 assert(CanDerivedReturnType->getTypeClass() ==
285 CanBaseReturnType->getTypeClass() &&
286 "Types must have same type class!");
287
288 if (CanDerivedReturnType == CanBaseReturnType) {
289 // No adjustment needed.
Anders Carlsson2fca9be2010-02-23 01:34:28 +0000290 return BaseOffset();
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000291 }
292
293 if (isa<ReferenceType>(CanDerivedReturnType)) {
294 CanDerivedReturnType =
295 CanDerivedReturnType->getAs<ReferenceType>()->getPointeeType();
296 CanBaseReturnType =
297 CanBaseReturnType->getAs<ReferenceType>()->getPointeeType();
298 } else if (isa<PointerType>(CanDerivedReturnType)) {
299 CanDerivedReturnType =
300 CanDerivedReturnType->getAs<PointerType>()->getPointeeType();
301 CanBaseReturnType =
302 CanBaseReturnType->getAs<PointerType>()->getPointeeType();
303 } else {
304 assert(false && "Unexpected return type!");
305 }
306
307 // We need to compare unqualified types here; consider
308 // const T *Base::foo();
309 // T *Derived::foo();
310 if (CanDerivedReturnType.getUnqualifiedType() ==
311 CanBaseReturnType.getUnqualifiedType()) {
312 // No adjustment needed.
Anders Carlsson2fca9be2010-02-23 01:34:28 +0000313 return BaseOffset();
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000314 }
315
316 const CXXRecordDecl *DerivedRD =
317 cast<CXXRecordDecl>(cast<RecordType>(CanDerivedReturnType)->getDecl());
318
319 const CXXRecordDecl *BaseRD =
320 cast<CXXRecordDecl>(cast<RecordType>(CanBaseReturnType)->getDecl());
321
Anders Carlssondf31af12010-02-13 23:17:31 +0000322 return ComputeBaseOffset(Context, BaseRD, DerivedRD);
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000323}
324
Anders Carlsson147a23d2010-06-04 00:54:04 +0000325void
326FinalOverriders::ComputeBaseOffsets(BaseSubobject Base, bool IsVirtual,
Ken Dyckb4c82b42011-03-26 01:36:26 +0000327 CharUnits OffsetInLayoutClass,
Anders Carlsson147a23d2010-06-04 00:54:04 +0000328 SubobjectOffsetMapTy &SubobjectOffsets,
329 SubobjectOffsetMapTy &SubobjectLayoutClassOffsets,
330 SubobjectCountMapTy &SubobjectCounts) {
331 const CXXRecordDecl *RD = Base.getBase();
332
333 unsigned SubobjectNumber = 0;
334 if (!IsVirtual)
335 SubobjectNumber = ++SubobjectCounts[RD];
336
337 // Set up the subobject to offset mapping.
338 assert(!SubobjectOffsets.count(std::make_pair(RD, SubobjectNumber))
339 && "Subobject offset already exists!");
340 assert(!SubobjectLayoutClassOffsets.count(std::make_pair(RD, SubobjectNumber))
341 && "Subobject offset already exists!");
342
Ken Dyck35c416b2011-03-26 01:09:13 +0000343 SubobjectOffsets[std::make_pair(RD, SubobjectNumber)] = Base.getBaseOffset();
Anders Carlsson147a23d2010-06-04 00:54:04 +0000344 SubobjectLayoutClassOffsets[std::make_pair(RD, SubobjectNumber)] =
Ken Dyckb4c82b42011-03-26 01:36:26 +0000345 OffsetInLayoutClass;
Anders Carlsson147a23d2010-06-04 00:54:04 +0000346
347 // Traverse our bases.
348 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
349 E = RD->bases_end(); I != E; ++I) {
350 const CXXRecordDecl *BaseDecl =
351 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
352
Ken Dyck57ebe332011-03-26 00:51:24 +0000353 CharUnits BaseOffset;
354 CharUnits BaseOffsetInLayoutClass;
Anders Carlsson147a23d2010-06-04 00:54:04 +0000355 if (I->isVirtual()) {
356 // Check if we've visited this virtual base before.
357 if (SubobjectOffsets.count(std::make_pair(BaseDecl, 0)))
358 continue;
359
360 const ASTRecordLayout &LayoutClassLayout =
361 Context.getASTRecordLayout(LayoutClass);
362
Ken Dyck57ebe332011-03-26 00:51:24 +0000363 BaseOffset = MostDerivedClassLayout.getVBaseClassOffset(BaseDecl);
Anders Carlsson147a23d2010-06-04 00:54:04 +0000364 BaseOffsetInLayoutClass =
Ken Dyck57ebe332011-03-26 00:51:24 +0000365 LayoutClassLayout.getVBaseClassOffset(BaseDecl);
Anders Carlsson147a23d2010-06-04 00:54:04 +0000366 } else {
367 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Ken Dyck57ebe332011-03-26 00:51:24 +0000368 CharUnits Offset = Layout.getBaseClassOffset(BaseDecl);
Anders Carlsson147a23d2010-06-04 00:54:04 +0000369
Ken Dyck57ebe332011-03-26 00:51:24 +0000370 BaseOffset = Base.getBaseOffset() + Offset;
Ken Dyckb4c82b42011-03-26 01:36:26 +0000371 BaseOffsetInLayoutClass = OffsetInLayoutClass + Offset;
Anders Carlsson147a23d2010-06-04 00:54:04 +0000372 }
373
Ken Dyck57ebe332011-03-26 00:51:24 +0000374 ComputeBaseOffsets(BaseSubobject(BaseDecl, BaseOffset),
Ken Dyckb4c82b42011-03-26 01:36:26 +0000375 I->isVirtual(), BaseOffsetInLayoutClass,
Ken Dyck4230d522011-03-24 01:21:01 +0000376 SubobjectOffsets, SubobjectLayoutClassOffsets,
377 SubobjectCounts);
Anders Carlsson147a23d2010-06-04 00:54:04 +0000378 }
379}
380
Anders Carlssonb9cae1d2010-06-04 00:59:37 +0000381void FinalOverriders::dump(llvm::raw_ostream &Out, BaseSubobject Base,
382 VisitedVirtualBasesSetTy &VisitedVirtualBases) {
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000383 const CXXRecordDecl *RD = Base.getBase();
384 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
385
386 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
387 E = RD->bases_end(); I != E; ++I) {
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000388 const CXXRecordDecl *BaseDecl =
389 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
390
Anders Carlssonb828afa2010-02-14 17:05:59 +0000391 // Ignore bases that don't have any virtual member functions.
392 if (!BaseDecl->isPolymorphic())
393 continue;
394
Ken Dyck4230d522011-03-24 01:21:01 +0000395 CharUnits BaseOffset;
Anders Carlsson9d6f0d52010-02-14 00:37:35 +0000396 if (I->isVirtual()) {
397 if (!VisitedVirtualBases.insert(BaseDecl)) {
398 // We've visited this base before.
399 continue;
400 }
401
Ken Dyck4230d522011-03-24 01:21:01 +0000402 BaseOffset = MostDerivedClassLayout.getVBaseClassOffset(BaseDecl);
Anders Carlsson9d6f0d52010-02-14 00:37:35 +0000403 } else {
Ken Dyck4230d522011-03-24 01:21:01 +0000404 BaseOffset = Layout.getBaseClassOffset(BaseDecl) + Base.getBaseOffset();
Anders Carlsson9d6f0d52010-02-14 00:37:35 +0000405 }
406
Anders Carlssonb9cae1d2010-06-04 00:59:37 +0000407 dump(Out, BaseSubobject(BaseDecl, BaseOffset), VisitedVirtualBases);
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000408 }
409
410 Out << "Final overriders for (" << RD->getQualifiedNameAsString() << ", ";
Ken Dyck4230d522011-03-24 01:21:01 +0000411 Out << Base.getBaseOffset().getQuantity() << ")\n";
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000412
413 // Now dump the overriders for this base subobject.
414 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
415 E = RD->method_end(); I != E; ++I) {
416 const CXXMethodDecl *MD = *I;
417
418 if (!MD->isVirtual())
419 continue;
420
Ken Dycke6203132011-03-26 01:18:17 +0000421 OverriderInfo Overrider = getOverrider(MD, Base.getBaseOffset());
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000422
Anders Carlssond86e5d82010-03-02 03:44:06 +0000423 Out << " " << MD->getQualifiedNameAsString() << " - (";
Anders Carlsson16b73122010-02-12 17:13:23 +0000424 Out << Overrider.Method->getQualifiedNameAsString();
Ken Dyck17d85192011-03-26 01:29:16 +0000425 Out << ", " << ", " << Overrider.Offset.getQuantity() << ')';
Anders Carlssond86e5d82010-03-02 03:44:06 +0000426
Anders Carlsson7097e752010-06-01 23:47:05 +0000427 BaseOffset Offset;
428 if (!Overrider.Method->isPure())
429 Offset = ComputeReturnAdjustmentBaseOffset(Context, Overrider.Method, MD);
Anders Carlssona4a54172010-02-13 20:41:15 +0000430
Anders Carlsson7097e752010-06-01 23:47:05 +0000431 if (!Offset.isEmpty()) {
Anders Carlssona4a54172010-02-13 20:41:15 +0000432 Out << " [ret-adj: ";
433 if (Offset.VirtualBase)
434 Out << Offset.VirtualBase->getQualifiedNameAsString() << " vbase, ";
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000435
Anders Carlssona4a54172010-02-13 20:41:15 +0000436 Out << Offset.NonVirtualOffset << " nv]";
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000437 }
Anders Carlssondf31af12010-02-13 23:17:31 +0000438
Anders Carlsson16b73122010-02-12 17:13:23 +0000439 Out << "\n";
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000440 }
441}
442
Anders Carlsson94464812010-04-10 19:13:06 +0000443/// VTableComponent - Represents a single component in a vtable.
444class VTableComponent {
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000445public:
446 enum Kind {
447 CK_VCallOffset,
448 CK_VBaseOffset,
449 CK_OffsetToTop,
450 CK_RTTI,
Anders Carlsson848fa642010-02-11 18:20:28 +0000451 CK_FunctionPointer,
452
453 /// CK_CompleteDtorPointer - A pointer to the complete destructor.
454 CK_CompleteDtorPointer,
455
456 /// CK_DeletingDtorPointer - A pointer to the deleting destructor.
Anders Carlsson1f464662010-02-19 20:08:13 +0000457 CK_DeletingDtorPointer,
458
459 /// CK_UnusedFunctionPointer - In some cases, a vtable function pointer
460 /// will end up never being called. Such vtable function pointers are
461 /// represented as a CK_UnusedFunctionPointer.
462 CK_UnusedFunctionPointer
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000463 };
464
Anders Carlsson94464812010-04-10 19:13:06 +0000465 static VTableComponent MakeVCallOffset(int64_t Offset) {
466 return VTableComponent(CK_VCallOffset, Offset);
Anders Carlssond9a67042010-02-17 06:07:19 +0000467 }
468
Anders Carlsson94464812010-04-10 19:13:06 +0000469 static VTableComponent MakeVBaseOffset(int64_t Offset) {
470 return VTableComponent(CK_VBaseOffset, Offset);
Anders Carlssona661a542010-02-16 04:49:44 +0000471 }
472
Anders Carlsson94464812010-04-10 19:13:06 +0000473 static VTableComponent MakeOffsetToTop(int64_t Offset) {
474 return VTableComponent(CK_OffsetToTop, Offset);
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000475 }
476
Anders Carlsson94464812010-04-10 19:13:06 +0000477 static VTableComponent MakeRTTI(const CXXRecordDecl *RD) {
478 return VTableComponent(CK_RTTI, reinterpret_cast<uintptr_t>(RD));
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000479 }
480
Anders Carlsson94464812010-04-10 19:13:06 +0000481 static VTableComponent MakeFunction(const CXXMethodDecl *MD) {
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000482 assert(!isa<CXXDestructorDecl>(MD) &&
Anders Carlsson848fa642010-02-11 18:20:28 +0000483 "Don't use MakeFunction with destructors!");
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000484
Anders Carlsson94464812010-04-10 19:13:06 +0000485 return VTableComponent(CK_FunctionPointer,
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000486 reinterpret_cast<uintptr_t>(MD));
487 }
488
Anders Carlsson94464812010-04-10 19:13:06 +0000489 static VTableComponent MakeCompleteDtor(const CXXDestructorDecl *DD) {
490 return VTableComponent(CK_CompleteDtorPointer,
Anders Carlsson848fa642010-02-11 18:20:28 +0000491 reinterpret_cast<uintptr_t>(DD));
492 }
493
Anders Carlsson94464812010-04-10 19:13:06 +0000494 static VTableComponent MakeDeletingDtor(const CXXDestructorDecl *DD) {
495 return VTableComponent(CK_DeletingDtorPointer,
Anders Carlsson848fa642010-02-11 18:20:28 +0000496 reinterpret_cast<uintptr_t>(DD));
497 }
498
Anders Carlsson94464812010-04-10 19:13:06 +0000499 static VTableComponent MakeUnusedFunction(const CXXMethodDecl *MD) {
Anders Carlsson1f464662010-02-19 20:08:13 +0000500 assert(!isa<CXXDestructorDecl>(MD) &&
501 "Don't use MakeUnusedFunction with destructors!");
Anders Carlsson94464812010-04-10 19:13:06 +0000502 return VTableComponent(CK_UnusedFunctionPointer,
Anders Carlsson1f464662010-02-19 20:08:13 +0000503 reinterpret_cast<uintptr_t>(MD));
504 }
505
Anders Carlsson94464812010-04-10 19:13:06 +0000506 static VTableComponent getFromOpaqueInteger(uint64_t I) {
507 return VTableComponent(I);
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +0000508 }
509
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000510 /// getKind - Get the kind of this vtable component.
511 Kind getKind() const {
512 return (Kind)(Value & 0x7);
513 }
514
Anders Carlssond9a67042010-02-17 06:07:19 +0000515 int64_t getVCallOffset() const {
516 assert(getKind() == CK_VCallOffset && "Invalid component kind!");
517
518 return getOffset();
519 }
520
Anders Carlssona661a542010-02-16 04:49:44 +0000521 int64_t getVBaseOffset() const {
522 assert(getKind() == CK_VBaseOffset && "Invalid component kind!");
523
524 return getOffset();
525 }
526
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000527 int64_t getOffsetToTop() const {
528 assert(getKind() == CK_OffsetToTop && "Invalid component kind!");
529
530 return getOffset();
531 }
532
533 const CXXRecordDecl *getRTTIDecl() const {
534 assert(getKind() == CK_RTTI && "Invalid component kind!");
535
536 return reinterpret_cast<CXXRecordDecl *>(getPointer());
537 }
538
539 const CXXMethodDecl *getFunctionDecl() const {
Anders Carlsson848fa642010-02-11 18:20:28 +0000540 assert(getKind() == CK_FunctionPointer);
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000541
542 return reinterpret_cast<CXXMethodDecl *>(getPointer());
543 }
Anders Carlsson848fa642010-02-11 18:20:28 +0000544
545 const CXXDestructorDecl *getDestructorDecl() const {
546 assert((getKind() == CK_CompleteDtorPointer ||
547 getKind() == CK_DeletingDtorPointer) && "Invalid component kind!");
548
549 return reinterpret_cast<CXXDestructorDecl *>(getPointer());
550 }
551
Anders Carlsson1f464662010-02-19 20:08:13 +0000552 const CXXMethodDecl *getUnusedFunctionDecl() const {
553 assert(getKind() == CK_UnusedFunctionPointer);
554
555 return reinterpret_cast<CXXMethodDecl *>(getPointer());
556 }
557
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000558private:
Anders Carlsson94464812010-04-10 19:13:06 +0000559 VTableComponent(Kind ComponentKind, int64_t Offset) {
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000560 assert((ComponentKind == CK_VCallOffset ||
561 ComponentKind == CK_VBaseOffset ||
562 ComponentKind == CK_OffsetToTop) && "Invalid component kind!");
563 assert(Offset <= ((1LL << 56) - 1) && "Offset is too big!");
564
565 Value = ((Offset << 3) | ComponentKind);
566 }
567
Anders Carlsson94464812010-04-10 19:13:06 +0000568 VTableComponent(Kind ComponentKind, uintptr_t Ptr) {
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000569 assert((ComponentKind == CK_RTTI ||
Anders Carlsson848fa642010-02-11 18:20:28 +0000570 ComponentKind == CK_FunctionPointer ||
571 ComponentKind == CK_CompleteDtorPointer ||
Anders Carlsson1f464662010-02-19 20:08:13 +0000572 ComponentKind == CK_DeletingDtorPointer ||
573 ComponentKind == CK_UnusedFunctionPointer) &&
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000574 "Invalid component kind!");
575
576 assert((Ptr & 7) == 0 && "Pointer not sufficiently aligned!");
577
578 Value = Ptr | ComponentKind;
579 }
580
581 int64_t getOffset() const {
582 assert((getKind() == CK_VCallOffset || getKind() == CK_VBaseOffset ||
583 getKind() == CK_OffsetToTop) && "Invalid component kind!");
584
585 return Value >> 3;
586 }
587
588 uintptr_t getPointer() const {
Anders Carlsson848fa642010-02-11 18:20:28 +0000589 assert((getKind() == CK_RTTI ||
590 getKind() == CK_FunctionPointer ||
591 getKind() == CK_CompleteDtorPointer ||
Anders Carlsson1f464662010-02-19 20:08:13 +0000592 getKind() == CK_DeletingDtorPointer ||
593 getKind() == CK_UnusedFunctionPointer) &&
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000594 "Invalid component kind!");
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000595
596 return static_cast<uintptr_t>(Value & ~7ULL);
597 }
598
Anders Carlsson94464812010-04-10 19:13:06 +0000599 explicit VTableComponent(uint64_t Value)
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +0000600 : Value(Value) { }
601
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000602 /// The kind is stored in the lower 3 bits of the value. For offsets, we
603 /// make use of the facts that classes can't be larger than 2^55 bytes,
604 /// so we store the offset in the lower part of the 61 bytes that remain.
605 /// (The reason that we're not simply using a PointerIntPair here is that we
606 /// need the offsets to be 64-bit, even when on a 32-bit machine).
607 int64_t Value;
608};
609
Anders Carlsson60cc72a2010-02-18 17:00:09 +0000610/// VCallOffsetMap - Keeps track of vcall offsets when building a vtable.
611struct VCallOffsetMap {
612
613 typedef std::pair<const CXXMethodDecl *, int64_t> MethodAndOffsetPairTy;
614
615 /// Offsets - Keeps track of methods and their offsets.
616 // FIXME: This should be a real map and not a vector.
617 llvm::SmallVector<MethodAndOffsetPairTy, 16> Offsets;
618
Anders Carlssoneb577d02010-02-18 17:26:40 +0000619 /// MethodsCanShareVCallOffset - Returns whether two virtual member functions
620 /// can share the same vcall offset.
621 static bool MethodsCanShareVCallOffset(const CXXMethodDecl *LHS,
622 const CXXMethodDecl *RHS);
623
Anders Carlsson60cc72a2010-02-18 17:00:09 +0000624public:
625 /// AddVCallOffset - Adds a vcall offset to the map. Returns true if the
626 /// add was successful, or false if there was already a member function with
627 /// the same signature in the map.
628 bool AddVCallOffset(const CXXMethodDecl *MD, int64_t OffsetOffset);
629
630 /// getVCallOffsetOffset - Returns the vcall offset offset (relative to the
631 /// vtable address point) for the given virtual member function.
632 int64_t getVCallOffsetOffset(const CXXMethodDecl *MD);
633
Anders Carlssondba6ef82010-02-25 22:23:13 +0000634 // empty - Return whether the offset map is empty or not.
635 bool empty() const { return Offsets.empty(); }
Anders Carlsson60cc72a2010-02-18 17:00:09 +0000636};
637
John McCall331a03a2010-02-26 20:22:44 +0000638static bool HasSameVirtualSignature(const CXXMethodDecl *LHS,
639 const CXXMethodDecl *RHS) {
640 ASTContext &C = LHS->getASTContext(); // TODO: thread this down
641 CanQual<FunctionProtoType>
642 LT = C.getCanonicalType(LHS->getType()).getAs<FunctionProtoType>(),
643 RT = C.getCanonicalType(RHS->getType()).getAs<FunctionProtoType>();
644
645 // Fast-path matches in the canonical types.
646 if (LT == RT) return true;
647
648 // Force the signatures to match. We can't rely on the overrides
649 // list here because there isn't necessarily an inheritance
650 // relationship between the two methods.
651 if (LT.getQualifiers() != RT.getQualifiers() ||
652 LT->getNumArgs() != RT->getNumArgs())
653 return false;
654 for (unsigned I = 0, E = LT->getNumArgs(); I != E; ++I)
655 if (LT->getArgType(I) != RT->getArgType(I))
656 return false;
657 return true;
658}
659
Anders Carlssoneb577d02010-02-18 17:26:40 +0000660bool VCallOffsetMap::MethodsCanShareVCallOffset(const CXXMethodDecl *LHS,
661 const CXXMethodDecl *RHS) {
662 assert(LHS->isVirtual() && "LHS must be virtual!");
663 assert(RHS->isVirtual() && "LHS must be virtual!");
664
Anders Carlsson55609692010-02-27 04:12:52 +0000665 // A destructor can share a vcall offset with another destructor.
666 if (isa<CXXDestructorDecl>(LHS))
667 return isa<CXXDestructorDecl>(RHS);
668
Anders Carlssoneb577d02010-02-18 17:26:40 +0000669 // FIXME: We need to check more things here.
670
Anders Carlsson55609692010-02-27 04:12:52 +0000671 // The methods must have the same name.
Anders Carlssoneb577d02010-02-18 17:26:40 +0000672 DeclarationName LHSName = LHS->getDeclName();
673 DeclarationName RHSName = RHS->getDeclName();
John McCall331a03a2010-02-26 20:22:44 +0000674 if (LHSName != RHSName)
Anders Carlssoneb577d02010-02-18 17:26:40 +0000675 return false;
John McCall331a03a2010-02-26 20:22:44 +0000676
Anders Carlsson55609692010-02-27 04:12:52 +0000677 // And the same signatures.
678 return HasSameVirtualSignature(LHS, RHS);
Anders Carlssoneb577d02010-02-18 17:26:40 +0000679}
680
Anders Carlsson60cc72a2010-02-18 17:00:09 +0000681bool VCallOffsetMap::AddVCallOffset(const CXXMethodDecl *MD,
682 int64_t OffsetOffset) {
Anders Carlssoneb577d02010-02-18 17:26:40 +0000683 // Check if we can reuse an offset.
684 for (unsigned I = 0, E = Offsets.size(); I != E; ++I) {
685 if (MethodsCanShareVCallOffset(Offsets[I].first, MD))
686 return false;
687 }
688
689 // Add the offset.
690 Offsets.push_back(MethodAndOffsetPairTy(MD, OffsetOffset));
Anders Carlsson60cc72a2010-02-18 17:00:09 +0000691 return true;
692}
693
694int64_t VCallOffsetMap::getVCallOffsetOffset(const CXXMethodDecl *MD) {
Anders Carlssoneb577d02010-02-18 17:26:40 +0000695 // Look for an offset.
696 for (unsigned I = 0, E = Offsets.size(); I != E; ++I) {
697 if (MethodsCanShareVCallOffset(Offsets[I].first, MD))
698 return Offsets[I].second;
699 }
700
701 assert(false && "Should always find a vcall offset offset!");
Anders Carlsson60cc72a2010-02-18 17:00:09 +0000702 return 0;
703}
704
Anders Carlssond68c0832010-02-25 03:45:56 +0000705/// VCallAndVBaseOffsetBuilder - Class for building vcall and vbase offsets.
706class VCallAndVBaseOffsetBuilder {
Anders Carlssonc89a7cf2010-03-11 16:06:20 +0000707public:
708 typedef llvm::DenseMap<const CXXRecordDecl *, int64_t>
709 VBaseOffsetOffsetsMapTy;
710
711private:
Anders Carlsson530c40c2010-02-28 01:43:58 +0000712 /// MostDerivedClass - The most derived class for which we're building vcall
713 /// and vbase offsets.
Anders Carlssond68c0832010-02-25 03:45:56 +0000714 const CXXRecordDecl *MostDerivedClass;
715
Anders Carlsson0041a642010-02-27 21:09:00 +0000716 /// LayoutClass - The class we're using for layout information. Will be
717 /// different than the most derived class if we're building a construction
718 /// vtable.
719 const CXXRecordDecl *LayoutClass;
720
Anders Carlssond68c0832010-02-25 03:45:56 +0000721 /// Context - The ASTContext which we will use for layout information.
722 ASTContext &Context;
723
724 /// Components - vcall and vbase offset components
Anders Carlsson94464812010-04-10 19:13:06 +0000725 typedef llvm::SmallVector<VTableComponent, 64> VTableComponentVectorTy;
726 VTableComponentVectorTy Components;
Anders Carlssond68c0832010-02-25 03:45:56 +0000727
728 /// VisitedVirtualBases - Visited virtual bases.
729 llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBases;
730
731 /// VCallOffsets - Keeps track of vcall offsets.
732 VCallOffsetMap VCallOffsets;
733
Anders Carlssonbb6305b2010-03-11 06:43:12 +0000734
735 /// VBaseOffsetOffsets - Contains the offsets of the virtual base offsets,
736 /// relative to the address point.
737 VBaseOffsetOffsetsMapTy VBaseOffsetOffsets;
738
Anders Carlssond68c0832010-02-25 03:45:56 +0000739 /// FinalOverriders - The final overriders of the most derived class.
740 /// (Can be null when we're not building a vtable of the most derived class).
741 const FinalOverriders *Overriders;
742
743 /// AddVCallAndVBaseOffsets - Add vcall offsets and vbase offsets for the
744 /// given base subobject.
745 void AddVCallAndVBaseOffsets(BaseSubobject Base, bool BaseIsVirtual,
746 uint64_t RealBaseOffset);
747
748 /// AddVCallOffsets - Add vcall offsets for the given base subobject.
749 void AddVCallOffsets(BaseSubobject Base, uint64_t VBaseOffset);
750
751 /// AddVBaseOffsets - Add vbase offsets for the given class.
Anders Carlsson88800662010-03-02 05:40:45 +0000752 void AddVBaseOffsets(const CXXRecordDecl *Base, uint64_t OffsetInLayoutClass);
Anders Carlssond68c0832010-02-25 03:45:56 +0000753
Anders Carlssonbb6305b2010-03-11 06:43:12 +0000754 /// getCurrentOffsetOffset - Get the current vcall or vbase offset offset in
755 /// bytes, relative to the vtable address point.
756 int64_t getCurrentOffsetOffset() const;
757
Anders Carlssond68c0832010-02-25 03:45:56 +0000758public:
759 VCallAndVBaseOffsetBuilder(const CXXRecordDecl *MostDerivedClass,
Anders Carlsson0041a642010-02-27 21:09:00 +0000760 const CXXRecordDecl *LayoutClass,
Anders Carlssond68c0832010-02-25 03:45:56 +0000761 const FinalOverriders *Overriders,
Anders Carlsson530c40c2010-02-28 01:43:58 +0000762 BaseSubobject Base, bool BaseIsVirtual,
763 uint64_t OffsetInLayoutClass)
764 : MostDerivedClass(MostDerivedClass), LayoutClass(LayoutClass),
Anders Carlssond68c0832010-02-25 03:45:56 +0000765 Context(MostDerivedClass->getASTContext()), Overriders(Overriders) {
766
767 // Add vcall and vbase offsets.
Anders Carlsson530c40c2010-02-28 01:43:58 +0000768 AddVCallAndVBaseOffsets(Base, BaseIsVirtual, OffsetInLayoutClass);
Anders Carlssond68c0832010-02-25 03:45:56 +0000769 }
770
771 /// Methods for iterating over the components.
Anders Carlsson94464812010-04-10 19:13:06 +0000772 typedef VTableComponentVectorTy::const_reverse_iterator const_iterator;
Anders Carlssond68c0832010-02-25 03:45:56 +0000773 const_iterator components_begin() const { return Components.rbegin(); }
774 const_iterator components_end() const { return Components.rend(); }
775
Anders Carlssonc89a7cf2010-03-11 16:06:20 +0000776 const VCallOffsetMap &getVCallOffsets() const { return VCallOffsets; }
777 const VBaseOffsetOffsetsMapTy &getVBaseOffsetOffsets() const {
Anders Carlssonbb6305b2010-03-11 06:43:12 +0000778 return VBaseOffsetOffsets;
779 }
Anders Carlssond68c0832010-02-25 03:45:56 +0000780};
781
782void
783VCallAndVBaseOffsetBuilder::AddVCallAndVBaseOffsets(BaseSubobject Base,
784 bool BaseIsVirtual,
785 uint64_t RealBaseOffset) {
786 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Base.getBase());
787
788 // Itanium C++ ABI 2.5.2:
789 // ..in classes sharing a virtual table with a primary base class, the vcall
790 // and vbase offsets added by the derived class all come before the vcall
791 // and vbase offsets required by the base class, so that the latter may be
792 // laid out as required by the base class without regard to additions from
793 // the derived class(es).
794
795 // (Since we're emitting the vcall and vbase offsets in reverse order, we'll
796 // emit them for the primary base first).
797 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
Anders Carlssonc9e814b2010-11-24 23:12:57 +0000798 bool PrimaryBaseIsVirtual = Layout.isPrimaryBaseVirtual();
Anders Carlssond68c0832010-02-25 03:45:56 +0000799
Ken Dyck57ebe332011-03-26 00:51:24 +0000800 CharUnits PrimaryBaseOffset;
Anders Carlssond68c0832010-02-25 03:45:56 +0000801
802 // Get the base offset of the primary base.
803 if (PrimaryBaseIsVirtual) {
Anders Carlssona14f5972010-10-31 23:22:37 +0000804 assert(Layout.getVBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlssond68c0832010-02-25 03:45:56 +0000805 "Primary vbase should have a zero offset!");
806
807 const ASTRecordLayout &MostDerivedClassLayout =
808 Context.getASTRecordLayout(MostDerivedClass);
809
810 PrimaryBaseOffset =
Ken Dyck57ebe332011-03-26 00:51:24 +0000811 MostDerivedClassLayout.getVBaseClassOffset(PrimaryBase);
Anders Carlssond68c0832010-02-25 03:45:56 +0000812 } else {
Anders Carlssona14f5972010-10-31 23:22:37 +0000813 assert(Layout.getBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlssond68c0832010-02-25 03:45:56 +0000814 "Primary base should have a zero offset!");
815
Ken Dyck57ebe332011-03-26 00:51:24 +0000816 PrimaryBaseOffset = Base.getBaseOffset();
Anders Carlssond68c0832010-02-25 03:45:56 +0000817 }
818
Ken Dyck4230d522011-03-24 01:21:01 +0000819 AddVCallAndVBaseOffsets(
Ken Dyck57ebe332011-03-26 00:51:24 +0000820 BaseSubobject(PrimaryBase,PrimaryBaseOffset),
Ken Dyck4230d522011-03-24 01:21:01 +0000821 PrimaryBaseIsVirtual, RealBaseOffset);
Anders Carlssond68c0832010-02-25 03:45:56 +0000822 }
823
Anders Carlsson88800662010-03-02 05:40:45 +0000824 AddVBaseOffsets(Base.getBase(), RealBaseOffset);
Anders Carlssond68c0832010-02-25 03:45:56 +0000825
826 // We only want to add vcall offsets for virtual bases.
827 if (BaseIsVirtual)
828 AddVCallOffsets(Base, RealBaseOffset);
829}
830
Anders Carlssonbb6305b2010-03-11 06:43:12 +0000831int64_t VCallAndVBaseOffsetBuilder::getCurrentOffsetOffset() const {
832 // OffsetIndex is the index of this vcall or vbase offset, relative to the
833 // vtable address point. (We subtract 3 to account for the information just
834 // above the address point, the RTTI info, the offset to top, and the
835 // vcall offset itself).
836 int64_t OffsetIndex = -(int64_t)(3 + Components.size());
837
838 // FIXME: We shouldn't use / 8 here.
839 int64_t OffsetOffset = OffsetIndex *
840 (int64_t)Context.Target.getPointerWidth(0) / 8;
841
842 return OffsetOffset;
843}
844
Anders Carlssond68c0832010-02-25 03:45:56 +0000845void VCallAndVBaseOffsetBuilder::AddVCallOffsets(BaseSubobject Base,
846 uint64_t VBaseOffset) {
847 const CXXRecordDecl *RD = Base.getBase();
848 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
849
John McCall331a03a2010-02-26 20:22:44 +0000850 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
851
Anders Carlssond68c0832010-02-25 03:45:56 +0000852 // Handle the primary base first.
Anders Carlssonaf6ddf22010-04-11 20:04:11 +0000853 // We only want to add vcall offsets if the base is non-virtual; a virtual
854 // primary base will have its vcall and vbase offsets emitted already.
Anders Carlssonc9e814b2010-11-24 23:12:57 +0000855 if (PrimaryBase && !Layout.isPrimaryBaseVirtual()) {
Anders Carlssond68c0832010-02-25 03:45:56 +0000856 // Get the base offset of the primary base.
Anders Carlssona14f5972010-10-31 23:22:37 +0000857 assert(Layout.getBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlssonaf6ddf22010-04-11 20:04:11 +0000858 "Primary base should have a zero offset!");
Anders Carlssond68c0832010-02-25 03:45:56 +0000859
Anders Carlssonaf6ddf22010-04-11 20:04:11 +0000860 AddVCallOffsets(BaseSubobject(PrimaryBase, Base.getBaseOffset()),
Anders Carlssond68c0832010-02-25 03:45:56 +0000861 VBaseOffset);
862 }
Anders Carlssonaf6ddf22010-04-11 20:04:11 +0000863
Anders Carlssond68c0832010-02-25 03:45:56 +0000864 // Add the vcall offsets.
865 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
866 E = RD->method_end(); I != E; ++I) {
867 const CXXMethodDecl *MD = *I;
868
869 if (!MD->isVirtual())
870 continue;
871
Anders Carlssonbb6305b2010-03-11 06:43:12 +0000872 int64_t OffsetOffset = getCurrentOffsetOffset();
Anders Carlssond68c0832010-02-25 03:45:56 +0000873
874 // Don't add a vcall offset if we already have one for this member function
875 // signature.
876 if (!VCallOffsets.AddVCallOffset(MD, OffsetOffset))
877 continue;
878
879 int64_t Offset = 0;
880
881 if (Overriders) {
882 // Get the final overrider.
883 FinalOverriders::OverriderInfo Overrider =
Ken Dycke6203132011-03-26 01:18:17 +0000884 Overriders->getOverrider(MD, Base.getBaseOffset());
Anders Carlssond68c0832010-02-25 03:45:56 +0000885
Anders Carlsson438bc422010-02-28 00:10:58 +0000886 /// The vcall offset is the offset from the virtual base to the object
887 /// where the function was overridden.
Anders Carlssond68c0832010-02-25 03:45:56 +0000888 // FIXME: We should not use / 8 here.
Ken Dyck17d85192011-03-26 01:29:16 +0000889 Offset = (int64_t)(Context.toBits(Overrider.Offset) - VBaseOffset) / 8;
Anders Carlssond68c0832010-02-25 03:45:56 +0000890 }
891
Anders Carlsson94464812010-04-10 19:13:06 +0000892 Components.push_back(VTableComponent::MakeVCallOffset(Offset));
Anders Carlssond68c0832010-02-25 03:45:56 +0000893 }
894
895 // And iterate over all non-virtual bases (ignoring the primary base).
896 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
897 E = RD->bases_end(); I != E; ++I) {
898
899 if (I->isVirtual())
900 continue;
901
902 const CXXRecordDecl *BaseDecl =
903 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
John McCall331a03a2010-02-26 20:22:44 +0000904 if (BaseDecl == PrimaryBase)
905 continue;
Anders Carlssond68c0832010-02-25 03:45:56 +0000906
907 // Get the base offset of this base.
Ken Dyck57ebe332011-03-26 00:51:24 +0000908 CharUnits BaseOffset = Base.getBaseOffset() +
909 Layout.getBaseClassOffset(BaseDecl);
Anders Carlssond68c0832010-02-25 03:45:56 +0000910
Ken Dyck57ebe332011-03-26 00:51:24 +0000911 AddVCallOffsets(BaseSubobject(BaseDecl, BaseOffset),
912 VBaseOffset);
Anders Carlssond68c0832010-02-25 03:45:56 +0000913 }
914}
915
Anders Carlssond68c0832010-02-25 03:45:56 +0000916void VCallAndVBaseOffsetBuilder::AddVBaseOffsets(const CXXRecordDecl *RD,
Anders Carlsson88800662010-03-02 05:40:45 +0000917 uint64_t OffsetInLayoutClass) {
Anders Carlsson0041a642010-02-27 21:09:00 +0000918 const ASTRecordLayout &LayoutClassLayout =
919 Context.getASTRecordLayout(LayoutClass);
Anders Carlssond68c0832010-02-25 03:45:56 +0000920
921 // Add vbase offsets.
922 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
923 E = RD->bases_end(); I != E; ++I) {
924 const CXXRecordDecl *BaseDecl =
925 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
926
927 // Check if this is a virtual base that we haven't visited before.
928 if (I->isVirtual() && VisitedVirtualBases.insert(BaseDecl)) {
929 // FIXME: We shouldn't use / 8 here.
Anders Carlsson88800662010-03-02 05:40:45 +0000930 int64_t Offset =
Anders Carlssona14f5972010-10-31 23:22:37 +0000931 (int64_t)(LayoutClassLayout.getVBaseClassOffsetInBits(BaseDecl) -
Anders Carlsson88800662010-03-02 05:40:45 +0000932 OffsetInLayoutClass) / 8;
Anders Carlssonbb6305b2010-03-11 06:43:12 +0000933
934 // Add the vbase offset offset.
935 assert(!VBaseOffsetOffsets.count(BaseDecl) &&
936 "vbase offset offset already exists!");
937
938 int64_t VBaseOffsetOffset = getCurrentOffsetOffset();
939 VBaseOffsetOffsets.insert(std::make_pair(BaseDecl, VBaseOffsetOffset));
940
Anders Carlsson94464812010-04-10 19:13:06 +0000941 Components.push_back(VTableComponent::MakeVBaseOffset(Offset));
Anders Carlssond68c0832010-02-25 03:45:56 +0000942 }
Anders Carlssonbb6305b2010-03-11 06:43:12 +0000943
Anders Carlssond68c0832010-02-25 03:45:56 +0000944 // Check the base class looking for more vbase offsets.
Anders Carlsson88800662010-03-02 05:40:45 +0000945 AddVBaseOffsets(BaseDecl, OffsetInLayoutClass);
Anders Carlssond68c0832010-02-25 03:45:56 +0000946 }
947}
948
Anders Carlsson94464812010-04-10 19:13:06 +0000949/// VTableBuilder - Class for building vtable layout information.
950class VTableBuilder {
Anders Carlsson57071e22010-02-12 05:25:12 +0000951public:
Anders Carlssonb9021e92010-02-27 16:18:19 +0000952 /// PrimaryBasesSetVectorTy - A set vector of direct and indirect
953 /// primary bases.
954 typedef llvm::SmallSetVector<const CXXRecordDecl *, 8>
955 PrimaryBasesSetVectorTy;
956
Anders Carlssonccd83d72010-03-24 16:42:11 +0000957 typedef llvm::DenseMap<const CXXRecordDecl *, int64_t>
958 VBaseOffsetOffsetsMapTy;
Anders Carlsson66d567d2010-03-25 00:51:13 +0000959
960 typedef llvm::DenseMap<BaseSubobject, uint64_t>
961 AddressPointsMapTy;
Anders Carlssonccd83d72010-03-24 16:42:11 +0000962
Anders Carlsson57071e22010-02-12 05:25:12 +0000963private:
Anders Carlssonaf440352010-03-23 04:11:45 +0000964 /// VTables - Global vtable information.
965 CodeGenVTables &VTables;
Anders Carlsson60db0ee2010-02-13 21:07:32 +0000966
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000967 /// MostDerivedClass - The most derived class for which we're building this
968 /// vtable.
969 const CXXRecordDecl *MostDerivedClass;
970
Anders Carlssond03a3262010-02-27 20:39:05 +0000971 /// MostDerivedClassOffset - If we're building a construction vtable, this
972 /// holds the offset from the layout class to the most derived class.
973 const uint64_t MostDerivedClassOffset;
974
Anders Carlsson5d7af6b2010-02-28 00:36:23 +0000975 /// MostDerivedClassIsVirtual - Whether the most derived class is a virtual
976 /// base. (This only makes sense when building a construction vtable).
977 bool MostDerivedClassIsVirtual;
978
Anders Carlssond03a3262010-02-27 20:39:05 +0000979 /// LayoutClass - The class we're using for layout information. Will be
980 /// different than the most derived class if we're building a construction
981 /// vtable.
982 const CXXRecordDecl *LayoutClass;
983
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000984 /// Context - The ASTContext which we will use for layout information.
Anders Carlsson57071e22010-02-12 05:25:12 +0000985 ASTContext &Context;
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000986
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000987 /// FinalOverriders - The final overriders of the most derived class.
Anders Carlssond68c0832010-02-25 03:45:56 +0000988 const FinalOverriders Overriders;
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000989
Anders Carlssondba6ef82010-02-25 22:23:13 +0000990 /// VCallOffsetsForVBases - Keeps track of vcall offsets for the virtual
991 /// bases in this vtable.
992 llvm::DenseMap<const CXXRecordDecl *, VCallOffsetMap> VCallOffsetsForVBases;
Anders Carlsson60cc72a2010-02-18 17:00:09 +0000993
Anders Carlssonbb6305b2010-03-11 06:43:12 +0000994 /// VBaseOffsetOffsets - Contains the offsets of the virtual base offsets for
995 /// the most derived class.
996 VBaseOffsetOffsetsMapTy VBaseOffsetOffsets;
997
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000998 /// Components - The components of the vtable being built.
Anders Carlsson94464812010-04-10 19:13:06 +0000999 llvm::SmallVector<VTableComponent, 64> Components;
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001000
Anders Carlsson822307b2010-02-11 17:18:51 +00001001 /// AddressPoints - Address points for the vtable being built.
Anders Carlssonff143f82010-03-25 00:35:49 +00001002 AddressPointsMapTy AddressPoints;
Anders Carlsson822307b2010-02-11 17:18:51 +00001003
Anders Carlssonb9021e92010-02-27 16:18:19 +00001004 /// MethodInfo - Contains information about a method in a vtable.
1005 /// (Used for computing 'this' pointer adjustment thunks.
1006 struct MethodInfo {
1007 /// BaseOffset - The base offset of this method.
1008 const uint64_t BaseOffset;
1009
Anders Carlsson2bc1d3a2010-03-10 21:25:37 +00001010 /// BaseOffsetInLayoutClass - The base offset in the layout class of this
1011 /// method.
1012 const uint64_t BaseOffsetInLayoutClass;
1013
Anders Carlsson718d0692010-04-11 22:07:06 +00001014 /// VTableIndex - The index in the vtable that this method has.
Anders Carlssonb9021e92010-02-27 16:18:19 +00001015 /// (For destructors, this is the index of the complete destructor).
Anders Carlsson718d0692010-04-11 22:07:06 +00001016 const uint64_t VTableIndex;
Anders Carlssonb9021e92010-02-27 16:18:19 +00001017
Anders Carlsson2bc1d3a2010-03-10 21:25:37 +00001018 MethodInfo(uint64_t BaseOffset, uint64_t BaseOffsetInLayoutClass,
Anders Carlsson718d0692010-04-11 22:07:06 +00001019 uint64_t VTableIndex)
Anders Carlsson2bc1d3a2010-03-10 21:25:37 +00001020 : BaseOffset(BaseOffset),
1021 BaseOffsetInLayoutClass(BaseOffsetInLayoutClass),
Anders Carlsson718d0692010-04-11 22:07:06 +00001022 VTableIndex(VTableIndex) { }
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001023
Anders Carlsson718d0692010-04-11 22:07:06 +00001024 MethodInfo() : BaseOffset(0), BaseOffsetInLayoutClass(0), VTableIndex(0) { }
Anders Carlssonb9021e92010-02-27 16:18:19 +00001025 };
1026
1027 typedef llvm::DenseMap<const CXXMethodDecl *, MethodInfo> MethodInfoMapTy;
1028
1029 /// MethodInfoMap - The information for all methods in the vtable we're
1030 /// currently building.
1031 MethodInfoMapTy MethodInfoMap;
1032
Anders Carlsson718d0692010-04-11 22:07:06 +00001033 typedef llvm::DenseMap<uint64_t, ThunkInfo> VTableThunksMapTy;
Anders Carlssondd366812010-03-12 04:54:20 +00001034
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00001035 /// VTableThunks - The thunks by vtable index in the vtable currently being
1036 /// built.
Anders Carlsson718d0692010-04-11 22:07:06 +00001037 VTableThunksMapTy VTableThunks;
Anders Carlssonb9021e92010-02-27 16:18:19 +00001038
Anders Carlssonee5ab9f2010-03-23 04:59:02 +00001039 typedef llvm::SmallVector<ThunkInfo, 1> ThunkInfoVectorTy;
1040 typedef llvm::DenseMap<const CXXMethodDecl *, ThunkInfoVectorTy> ThunksMapTy;
Anders Carlsson5e454aa2010-03-17 20:06:32 +00001041
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00001042 /// Thunks - A map that contains all the thunks needed for all methods in the
1043 /// most derived class for which the vtable is currently being built.
Anders Carlssonee5ab9f2010-03-23 04:59:02 +00001044 ThunksMapTy Thunks;
Anders Carlsson5e454aa2010-03-17 20:06:32 +00001045
1046 /// AddThunk - Add a thunk for the given method.
Anders Carlsson9d734f32010-03-21 20:27:14 +00001047 void AddThunk(const CXXMethodDecl *MD, const ThunkInfo &Thunk);
Anders Carlsson5e454aa2010-03-17 20:06:32 +00001048
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001049 /// ComputeThisAdjustments - Compute the 'this' pointer adjustments for the
1050 /// part of the vtable we're currently building.
1051 void ComputeThisAdjustments();
1052
Anders Carlssona661a542010-02-16 04:49:44 +00001053 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
1054
Anders Carlssonb9021e92010-02-27 16:18:19 +00001055 /// PrimaryVirtualBases - All known virtual bases who are a primary base of
Anders Carlssonaf280c02010-02-23 03:48:14 +00001056 /// some other base.
1057 VisitedVirtualBasesSetTy PrimaryVirtualBases;
1058
Anders Carlsson60db0ee2010-02-13 21:07:32 +00001059 /// ComputeReturnAdjustment - Compute the return adjustment given a return
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001060 /// adjustment base offset.
Anders Carlsson2fca9be2010-02-23 01:34:28 +00001061 ReturnAdjustment ComputeReturnAdjustment(BaseOffset Offset);
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001062
Anders Carlsson379017f2010-02-27 19:57:44 +00001063 /// ComputeThisAdjustmentBaseOffset - Compute the base offset for adjusting
1064 /// the 'this' pointer from the base subobject to the derived subobject.
1065 BaseOffset ComputeThisAdjustmentBaseOffset(BaseSubobject Base,
1066 BaseSubobject Derived) const;
1067
Anders Carlsson60cc72a2010-02-18 17:00:09 +00001068 /// ComputeThisAdjustment - Compute the 'this' pointer adjustment for the
Anders Carlsson617def32010-03-12 05:28:07 +00001069 /// given virtual member function, its offset in the layout class and its
1070 /// final overrider.
1071 ThisAdjustment
1072 ComputeThisAdjustment(const CXXMethodDecl *MD,
1073 uint64_t BaseOffsetInLayoutClass,
1074 FinalOverriders::OverriderInfo Overrider);
1075
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001076 /// AddMethod - Add a single virtual member function to the vtable
1077 /// components vector.
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001078 void AddMethod(const CXXMethodDecl *MD, ReturnAdjustment ReturnAdjustment);
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001079
Anders Carlsson464c8f12010-02-23 04:26:39 +00001080 /// IsOverriderUsed - Returns whether the overrider will ever be used in this
1081 /// part of the vtable.
1082 ///
1083 /// Itanium C++ ABI 2.5.2:
1084 ///
1085 /// struct A { virtual void f(); };
1086 /// struct B : virtual public A { int i; };
1087 /// struct C : virtual public A { int j; };
1088 /// struct D : public B, public C {};
1089 ///
1090 /// When B and C are declared, A is a primary base in each case, so although
1091 /// vcall offsets are allocated in the A-in-B and A-in-C vtables, no this
1092 /// adjustment is required and no thunk is generated. However, inside D
1093 /// objects, A is no longer a primary base of C, so if we allowed calls to
1094 /// C::f() to use the copy of A's vtable in the C subobject, we would need
1095 /// to adjust this from C* to B::A*, which would require a third-party
1096 /// thunk. Since we require that a call to C::f() first convert to A*,
1097 /// C-in-D's copy of A's vtable is never referenced, so this is not
1098 /// necessary.
Anders Carlsson60396612010-03-10 06:51:42 +00001099 bool IsOverriderUsed(const CXXMethodDecl *Overrider,
1100 uint64_t BaseOffsetInLayoutClass,
1101 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
1102 uint64_t FirstBaseOffsetInLayoutClass) const;
1103
Anders Carlsson464c8f12010-02-23 04:26:39 +00001104
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001105 /// AddMethods - Add the methods of this base subobject and all its
1106 /// primary bases to the vtable components vector.
Anders Carlsson60396612010-03-10 06:51:42 +00001107 void AddMethods(BaseSubobject Base, uint64_t BaseOffsetInLayoutClass,
1108 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
1109 uint64_t FirstBaseOffsetInLayoutClass,
Anders Carlssonb9021e92010-02-27 16:18:19 +00001110 PrimaryBasesSetVectorTy &PrimaryBases);
Anders Carlsson89ad4212010-02-16 16:26:28 +00001111
Anders Carlsson718d0692010-04-11 22:07:06 +00001112 // LayoutVTable - Layout the vtable for the given base class, including its
Anders Carlsson89ad4212010-02-16 16:26:28 +00001113 // secondary vtables and any vtables for virtual bases.
Anders Carlsson718d0692010-04-11 22:07:06 +00001114 void LayoutVTable();
Anders Carlsson89ad4212010-02-16 16:26:28 +00001115
Anders Carlsson718d0692010-04-11 22:07:06 +00001116 /// LayoutPrimaryAndSecondaryVTables - Layout the primary vtable for the
Anders Carlsson89ad4212010-02-16 16:26:28 +00001117 /// given base subobject, as well as all its secondary vtables.
Anders Carlsson91232842010-04-11 22:03:57 +00001118 ///
Anders Carlsson73e6fa02010-04-11 22:20:36 +00001119 /// \param BaseIsMorallyVirtual whether the base subobject is a virtual base
1120 /// or a direct or indirect base of a virtual base.
1121 ///
Anders Carlsson91232842010-04-11 22:03:57 +00001122 /// \param BaseIsVirtualInLayoutClass - Whether the base subobject is virtual
1123 /// in the layout class.
Anders Carlsson718d0692010-04-11 22:07:06 +00001124 void LayoutPrimaryAndSecondaryVTables(BaseSubobject Base,
Anders Carlsson73e6fa02010-04-11 22:20:36 +00001125 bool BaseIsMorallyVirtual,
Anders Carlsson91232842010-04-11 22:03:57 +00001126 bool BaseIsVirtualInLayoutClass,
Anders Carlsson530c40c2010-02-28 01:43:58 +00001127 uint64_t OffsetInLayoutClass);
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001128
Anders Carlsson718d0692010-04-11 22:07:06 +00001129 /// LayoutSecondaryVTables - Layout the secondary vtables for the given base
Anders Carlssonc7b63162010-02-16 16:02:57 +00001130 /// subobject.
Anders Carlssona96a2e92010-03-10 19:39:11 +00001131 ///
1132 /// \param BaseIsMorallyVirtual whether the base subobject is a virtual base
1133 /// or a direct or indirect base of a virtual base.
Anders Carlsson718d0692010-04-11 22:07:06 +00001134 void LayoutSecondaryVTables(BaseSubobject Base, bool BaseIsMorallyVirtual,
Anders Carlssona96a2e92010-03-10 19:39:11 +00001135 uint64_t OffsetInLayoutClass);
Anders Carlsson08c26752010-02-27 04:05:52 +00001136
1137 /// DeterminePrimaryVirtualBases - Determine the primary virtual bases in this
1138 /// class hierarchy.
1139 void DeterminePrimaryVirtualBases(const CXXRecordDecl *RD,
Anders Carlssond7fdae52010-03-10 03:02:01 +00001140 uint64_t OffsetInLayoutClass,
Anders Carlsson08c26752010-02-27 04:05:52 +00001141 VisitedVirtualBasesSetTy &VBases);
1142
Anders Carlsson718d0692010-04-11 22:07:06 +00001143 /// LayoutVTablesForVirtualBases - Layout vtables for all virtual bases of the
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001144 /// given base (excluding any primary bases).
Anders Carlsson718d0692010-04-11 22:07:06 +00001145 void LayoutVTablesForVirtualBases(const CXXRecordDecl *RD,
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001146 VisitedVirtualBasesSetTy &VBases);
1147
Anders Carlsson718d0692010-04-11 22:07:06 +00001148 /// isBuildingConstructionVTable - Return whether this vtable builder is
Anders Carlsson438bc422010-02-28 00:10:58 +00001149 /// building a construction vtable.
Anders Carlsson718d0692010-04-11 22:07:06 +00001150 bool isBuildingConstructorVTable() const {
Anders Carlsson438bc422010-02-28 00:10:58 +00001151 return MostDerivedClass != LayoutClass;
1152 }
1153
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001154public:
Anders Carlsson94464812010-04-10 19:13:06 +00001155 VTableBuilder(CodeGenVTables &VTables, const CXXRecordDecl *MostDerivedClass,
Anders Carlsson5d7af6b2010-02-28 00:36:23 +00001156 uint64_t MostDerivedClassOffset, bool MostDerivedClassIsVirtual,
Anders Carlssond03a3262010-02-27 20:39:05 +00001157 const CXXRecordDecl *LayoutClass)
Anders Carlssonaf440352010-03-23 04:11:45 +00001158 : VTables(VTables), MostDerivedClass(MostDerivedClass),
Anders Carlsson5d7af6b2010-02-28 00:36:23 +00001159 MostDerivedClassOffset(MostDerivedClassOffset),
1160 MostDerivedClassIsVirtual(MostDerivedClassIsVirtual),
1161 LayoutClass(LayoutClass), Context(MostDerivedClass->getASTContext()),
Anders Carlssondb4022c2010-03-10 02:33:41 +00001162 Overriders(MostDerivedClass, MostDerivedClassOffset, LayoutClass) {
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001163
Anders Carlsson718d0692010-04-11 22:07:06 +00001164 LayoutVTable();
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001165 }
1166
Anders Carlssonfbf6ed42010-03-23 16:36:50 +00001167 ThunksMapTy::const_iterator thunks_begin() const {
1168 return Thunks.begin();
1169 }
1170
1171 ThunksMapTy::const_iterator thunks_end() const {
1172 return Thunks.end();
1173 }
1174
Anders Carlssonccd83d72010-03-24 16:42:11 +00001175 const VBaseOffsetOffsetsMapTy &getVBaseOffsetOffsets() const {
1176 return VBaseOffsetOffsets;
1177 }
1178
1179 /// getNumVTableComponents - Return the number of components in the vtable
1180 /// currently built.
1181 uint64_t getNumVTableComponents() const {
1182 return Components.size();
1183 }
1184
Anders Carlsson66d567d2010-03-25 00:51:13 +00001185 const uint64_t *vtable_components_data_begin() const {
Anders Carlssonccd83d72010-03-24 16:42:11 +00001186 return reinterpret_cast<const uint64_t *>(Components.begin());
1187 }
1188
Anders Carlsson66d567d2010-03-25 00:51:13 +00001189 const uint64_t *vtable_components_data_end() const {
Anders Carlssonccd83d72010-03-24 16:42:11 +00001190 return reinterpret_cast<const uint64_t *>(Components.end());
1191 }
1192
Anders Carlsson66d567d2010-03-25 00:51:13 +00001193 AddressPointsMapTy::const_iterator address_points_begin() const {
1194 return AddressPoints.begin();
1195 }
1196
1197 AddressPointsMapTy::const_iterator address_points_end() const {
1198 return AddressPoints.end();
1199 }
1200
Anders Carlsson718d0692010-04-11 22:07:06 +00001201 VTableThunksMapTy::const_iterator vtable_thunks_begin() const {
Anders Carlsson0d1407e2010-03-25 15:26:28 +00001202 return VTableThunks.begin();
1203 }
1204
Anders Carlsson718d0692010-04-11 22:07:06 +00001205 VTableThunksMapTy::const_iterator vtable_thunks_end() const {
Anders Carlsson0d1407e2010-03-25 15:26:28 +00001206 return VTableThunks.end();
1207 }
1208
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001209 /// dumpLayout - Dump the vtable layout.
1210 void dumpLayout(llvm::raw_ostream&);
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001211};
1212
Anders Carlsson94464812010-04-10 19:13:06 +00001213void VTableBuilder::AddThunk(const CXXMethodDecl *MD, const ThunkInfo &Thunk) {
Anders Carlsson718d0692010-04-11 22:07:06 +00001214 assert(!isBuildingConstructorVTable() &&
Anders Carlssonbca5d372010-03-22 20:06:40 +00001215 "Can't add thunks for construction vtable");
Anders Carlsson9135a842010-03-18 02:44:19 +00001216
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00001217 llvm::SmallVector<ThunkInfo, 1> &ThunksVector = Thunks[MD];
Anders Carlsson5e454aa2010-03-17 20:06:32 +00001218
1219 // Check if we have this thunk already.
1220 if (std::find(ThunksVector.begin(), ThunksVector.end(), Thunk) !=
1221 ThunksVector.end())
1222 return;
1223
1224 ThunksVector.push_back(Thunk);
1225}
1226
Anders Carlssonf622b452010-04-10 20:39:29 +00001227typedef llvm::SmallPtrSet<const CXXMethodDecl *, 8> OverriddenMethodsSetTy;
1228
1229/// ComputeAllOverriddenMethods - Given a method decl, will return a set of all
1230/// the overridden methods that the function decl overrides.
1231static void
1232ComputeAllOverriddenMethods(const CXXMethodDecl *MD,
1233 OverriddenMethodsSetTy& OverriddenMethods) {
1234 assert(MD->isVirtual() && "Method is not virtual!");
1235
Anders Carlsson57071e22010-02-12 05:25:12 +00001236 for (CXXMethodDecl::method_iterator I = MD->begin_overridden_methods(),
1237 E = MD->end_overridden_methods(); I != E; ++I) {
1238 const CXXMethodDecl *OverriddenMD = *I;
Anders Carlsson57071e22010-02-12 05:25:12 +00001239
Anders Carlssonf622b452010-04-10 20:39:29 +00001240 OverriddenMethods.insert(OverriddenMD);
1241
1242 ComputeAllOverriddenMethods(OverriddenMD, OverriddenMethods);
Anders Carlsson57071e22010-02-12 05:25:12 +00001243 }
Anders Carlsson57071e22010-02-12 05:25:12 +00001244}
1245
Anders Carlsson94464812010-04-10 19:13:06 +00001246void VTableBuilder::ComputeThisAdjustments() {
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001247 // Now go through the method info map and see if any of the methods need
1248 // 'this' pointer adjustments.
1249 for (MethodInfoMapTy::const_iterator I = MethodInfoMap.begin(),
1250 E = MethodInfoMap.end(); I != E; ++I) {
1251 const CXXMethodDecl *MD = I->first;
1252 const MethodInfo &MethodInfo = I->second;
1253
Anders Carlsson617def32010-03-12 05:28:07 +00001254 // Ignore adjustments for unused function pointers.
Anders Carlsson718d0692010-04-11 22:07:06 +00001255 uint64_t VTableIndex = MethodInfo.VTableIndex;
1256 if (Components[VTableIndex].getKind() ==
Anders Carlsson94464812010-04-10 19:13:06 +00001257 VTableComponent::CK_UnusedFunctionPointer)
Anders Carlsson617def32010-03-12 05:28:07 +00001258 continue;
1259
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001260 // Get the final overrider for this method.
1261 FinalOverriders::OverriderInfo Overrider =
Ken Dycke6203132011-03-26 01:18:17 +00001262 Overriders.getOverrider(MD,
1263 Context.toCharUnitsFromBits(MethodInfo.BaseOffset));
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001264
Anders Carlssonbca5d372010-03-22 20:06:40 +00001265 // Check if we need an adjustment at all.
Ken Dyck17d85192011-03-26 01:29:16 +00001266 uint64_t OverriderOffsetInBits = Context.toBits(Overrider.Offset);
1267 if (MethodInfo.BaseOffsetInLayoutClass == OverriderOffsetInBits) {
Anders Carlssonadb507d2010-03-29 15:08:41 +00001268 // 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 Carlsson718d0692010-04-11 22:07:06 +00001273 if (VTableThunks.lookup(VTableIndex).Return.isEmpty())
Anders Carlssonadb507d2010-03-29 15:08:41 +00001274 continue;
1275 }
Anders Carlssonbca5d372010-03-22 20:06:40 +00001276
Anders Carlsson617def32010-03-12 05:28:07 +00001277 ThisAdjustment ThisAdjustment =
1278 ComputeThisAdjustment(MD, MethodInfo.BaseOffsetInLayoutClass, Overrider);
1279
1280 if (ThisAdjustment.isEmpty())
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001281 continue;
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001282
Anders Carlssoncd4e6372010-02-27 18:09:40 +00001283 // Add it.
Anders Carlsson718d0692010-04-11 22:07:06 +00001284 VTableThunks[VTableIndex].This = ThisAdjustment;
Anders Carlsson617def32010-03-12 05:28:07 +00001285
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001286 if (isa<CXXDestructorDecl>(MD)) {
1287 // Add an adjustment for the deleting destructor as well.
Anders Carlsson718d0692010-04-11 22:07:06 +00001288 VTableThunks[VTableIndex + 1].This = ThisAdjustment;
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001289 }
1290 }
1291
1292 /// Clear the method info map.
1293 MethodInfoMap.clear();
Anders Carlsson25394212010-03-22 15:47:01 +00001294
Anders Carlsson718d0692010-04-11 22:07:06 +00001295 if (isBuildingConstructorVTable()) {
Anders Carlsson25394212010-03-22 15:47:01 +00001296 // We don't need to store thunk information for construction vtables.
1297 return;
1298 }
1299
Anders Carlsson718d0692010-04-11 22:07:06 +00001300 for (VTableThunksMapTy::const_iterator I = VTableThunks.begin(),
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00001301 E = VTableThunks.end(); I != E; ++I) {
Anders Carlsson94464812010-04-10 19:13:06 +00001302 const VTableComponent &Component = Components[I->first];
Anders Carlsson25394212010-03-22 15:47:01 +00001303 const ThunkInfo &Thunk = I->second;
Anders Carlssonbca5d372010-03-22 20:06:40 +00001304 const CXXMethodDecl *MD;
Anders Carlsson25394212010-03-22 15:47:01 +00001305
1306 switch (Component.getKind()) {
1307 default:
1308 llvm_unreachable("Unexpected vtable component kind!");
Anders Carlsson94464812010-04-10 19:13:06 +00001309 case VTableComponent::CK_FunctionPointer:
Anders Carlssonbca5d372010-03-22 20:06:40 +00001310 MD = Component.getFunctionDecl();
Anders Carlsson25394212010-03-22 15:47:01 +00001311 break;
Anders Carlsson94464812010-04-10 19:13:06 +00001312 case VTableComponent::CK_CompleteDtorPointer:
Anders Carlssonbca5d372010-03-22 20:06:40 +00001313 MD = Component.getDestructorDecl();
Anders Carlsson25394212010-03-22 15:47:01 +00001314 break;
Anders Carlsson94464812010-04-10 19:13:06 +00001315 case VTableComponent::CK_DeletingDtorPointer:
Anders Carlsson25394212010-03-22 15:47:01 +00001316 // We've already added the thunk when we saw the complete dtor pointer.
Anders Carlssonbca5d372010-03-22 20:06:40 +00001317 continue;
Anders Carlsson25394212010-03-22 15:47:01 +00001318 }
Anders Carlssonbca5d372010-03-22 20:06:40 +00001319
1320 if (MD->getParent() == MostDerivedClass)
1321 AddThunk(MD, Thunk);
Anders Carlsson25394212010-03-22 15:47:01 +00001322 }
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001323}
1324
Anders Carlsson94464812010-04-10 19:13:06 +00001325ReturnAdjustment VTableBuilder::ComputeReturnAdjustment(BaseOffset Offset) {
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001326 ReturnAdjustment Adjustment;
1327
1328 if (!Offset.isEmpty()) {
Anders Carlsson60db0ee2010-02-13 21:07:32 +00001329 if (Offset.VirtualBase) {
1330 // Get the virtual base offset offset.
Anders Carlsson1972ced2010-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 Carlssonaf440352010-03-23 04:11:45 +00001337 VTables.getVirtualBaseOffsetOffset(Offset.DerivedClass,
1338 Offset.VirtualBase);
Anders Carlsson1972ced2010-03-11 07:00:45 +00001339 }
Anders Carlsson60db0ee2010-02-13 21:07:32 +00001340 }
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001341
1342 Adjustment.NonVirtual = Offset.NonVirtualOffset;
1343 }
1344
1345 return Adjustment;
1346}
1347
Anders Carlsson379017f2010-02-27 19:57:44 +00001348BaseOffset
Anders Carlsson94464812010-04-10 19:13:06 +00001349VTableBuilder::ComputeThisAdjustmentBaseOffset(BaseSubobject Base,
Anders Carlsson379017f2010-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 Dyck57ebe332011-03-26 00:51:24 +00001369 CharUnits OffsetToBaseSubobject =
1370 CharUnits::fromQuantity(Offset.NonVirtualOffset);
Anders Carlsson379017f2010-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 Carlsson2bc1d3a2010-03-10 21:25:37 +00001375 const ASTRecordLayout &LayoutClassLayout =
1376 Context.getASTRecordLayout(LayoutClass);
Anders Carlsson379017f2010-02-27 19:57:44 +00001377
1378 /// Get the virtual base offset, relative to the most derived class
1379 /// layout.
1380 OffsetToBaseSubobject +=
Ken Dyck57ebe332011-03-26 00:51:24 +00001381 LayoutClassLayout.getVBaseClassOffset(Offset.VirtualBase);
Anders Carlsson379017f2010-02-27 19:57:44 +00001382 } else {
1383 // Otherwise, the non-virtual offset is relative to the derived class
1384 // offset.
Ken Dyck57ebe332011-03-26 00:51:24 +00001385 OffsetToBaseSubobject += Derived.getBaseOffset();
Anders Carlsson379017f2010-02-27 19:57:44 +00001386 }
1387
1388 // Check if this path gives us the right base subobject.
Ken Dyck57ebe332011-03-26 00:51:24 +00001389 if (OffsetToBaseSubobject == Base.getBaseOffset()) {
Anders Carlsson379017f2010-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 Carlsson80d8d7d2010-03-23 15:13:06 +00001400ThisAdjustment
Anders Carlsson94464812010-04-10 19:13:06 +00001401VTableBuilder::ComputeThisAdjustment(const CXXMethodDecl *MD,
Anders Carlsson617def32010-03-12 05:28:07 +00001402 uint64_t BaseOffsetInLayoutClass,
1403 FinalOverriders::OverriderInfo Overrider) {
Anders Carlsson617def32010-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 Dyck4230d522011-03-24 01:21:01 +00001409 Context.toCharUnitsFromBits(
1410 BaseOffsetInLayoutClass));
Anders Carlsson617def32010-03-12 05:28:07 +00001411
1412 BaseSubobject OverriderBaseSubobject(Overrider.Method->getParent(),
Ken Dyck17d85192011-03-26 01:29:16 +00001413 Overrider.Offset);
Anders Carlsson617def32010-03-12 05:28:07 +00001414
1415 // Compute the adjustment offset.
1416 BaseOffset Offset = ComputeThisAdjustmentBaseOffset(OverriddenBaseSubobject,
1417 OverriderBaseSubobject);
1418 if (Offset.isEmpty())
1419 return ThisAdjustment();
1420
Anders Carlsson49bac9a2010-02-13 23:40:17 +00001421 ThisAdjustment Adjustment;
1422
Anders Carlsson617def32010-03-12 05:28:07 +00001423 if (Offset.VirtualBase) {
1424 // Get the vcall offset map for this virtual base.
1425 VCallOffsetMap &VCallOffsets = VCallOffsetsForVBases[Offset.VirtualBase];
Anders Carlssoneb577d02010-02-18 17:26:40 +00001426
Anders Carlsson617def32010-03-12 05:28:07 +00001427 if (VCallOffsets.empty()) {
1428 // We don't have vcall offsets for this virtual base, go ahead and
1429 // build them.
1430 VCallAndVBaseOffsetBuilder Builder(MostDerivedClass, MostDerivedClass,
1431 /*FinalOverriders=*/0,
Ken Dyck4230d522011-03-24 01:21:01 +00001432 BaseSubobject(Offset.VirtualBase,
1433 CharUnits::Zero()),
Anders Carlsson617def32010-03-12 05:28:07 +00001434 /*BaseIsVirtual=*/true,
1435 /*OffsetInLayoutClass=*/0);
1436
1437 VCallOffsets = Builder.getVCallOffsets();
1438 }
1439
1440 Adjustment.VCallOffsetOffset = VCallOffsets.getVCallOffsetOffset(MD);
Anders Carlsson49bac9a2010-02-13 23:40:17 +00001441 }
Anders Carlsson617def32010-03-12 05:28:07 +00001442
1443 // Set the non-virtual part of the adjustment.
1444 Adjustment.NonVirtual = Offset.NonVirtualOffset;
Anders Carlsson49bac9a2010-02-13 23:40:17 +00001445
1446 return Adjustment;
1447}
Anders Carlsson617def32010-03-12 05:28:07 +00001448
Anders Carlsson57071e22010-02-12 05:25:12 +00001449void
Anders Carlsson94464812010-04-10 19:13:06 +00001450VTableBuilder::AddMethod(const CXXMethodDecl *MD,
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001451 ReturnAdjustment ReturnAdjustment) {
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001452 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1453 assert(ReturnAdjustment.isEmpty() &&
1454 "Destructor can't have return adjustment!");
Anders Carlsson49bac9a2010-02-13 23:40:17 +00001455
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001456 // Add both the complete destructor and the deleting destructor.
Anders Carlsson94464812010-04-10 19:13:06 +00001457 Components.push_back(VTableComponent::MakeCompleteDtor(DD));
1458 Components.push_back(VTableComponent::MakeDeletingDtor(DD));
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001459 } else {
1460 // Add the return adjustment if necessary.
1461 if (!ReturnAdjustment.isEmpty())
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00001462 VTableThunks[Components.size()].Return = ReturnAdjustment;
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001463
1464 // Add the function.
Anders Carlsson94464812010-04-10 19:13:06 +00001465 Components.push_back(VTableComponent::MakeFunction(MD));
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001466 }
1467}
1468
Anders Carlssonc784ba22010-02-27 06:38:03 +00001469/// OverridesIndirectMethodInBase - Return whether the given member function
1470/// overrides any methods in the set of given bases.
1471/// Unlike OverridesMethodInBase, this checks "overriders of overriders".
1472/// For example, if we have:
1473///
1474/// struct A { virtual void f(); }
1475/// struct B : A { virtual void f(); }
1476/// struct C : B { virtual void f(); }
1477///
1478/// OverridesIndirectMethodInBase will return true if given C::f as the method
Anders Carlssonf622b452010-04-10 20:39:29 +00001479/// and { A } as the set of bases.
Anders Carlssonc784ba22010-02-27 06:38:03 +00001480static bool
1481OverridesIndirectMethodInBases(const CXXMethodDecl *MD,
Anders Carlsson94464812010-04-10 19:13:06 +00001482 VTableBuilder::PrimaryBasesSetVectorTy &Bases) {
Anders Carlssonfbf05612010-04-17 17:24:33 +00001483 if (Bases.count(MD->getParent()))
1484 return true;
1485
Anders Carlssonc784ba22010-02-27 06:38:03 +00001486 for (CXXMethodDecl::method_iterator I = MD->begin_overridden_methods(),
1487 E = MD->end_overridden_methods(); I != E; ++I) {
1488 const CXXMethodDecl *OverriddenMD = *I;
Anders Carlssonc784ba22010-02-27 06:38:03 +00001489
1490 // Check "indirect overriders".
1491 if (OverridesIndirectMethodInBases(OverriddenMD, Bases))
1492 return true;
1493 }
1494
1495 return false;
1496}
1497
Anders Carlsson464c8f12010-02-23 04:26:39 +00001498bool
Anders Carlsson94464812010-04-10 19:13:06 +00001499VTableBuilder::IsOverriderUsed(const CXXMethodDecl *Overrider,
Anders Carlsson60396612010-03-10 06:51:42 +00001500 uint64_t BaseOffsetInLayoutClass,
1501 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
1502 uint64_t FirstBaseOffsetInLayoutClass) const {
Anders Carlsson464c8f12010-02-23 04:26:39 +00001503 // If the base and the first base in the primary base chain have the same
1504 // offsets, then this overrider will be used.
Anders Carlsson60396612010-03-10 06:51:42 +00001505 if (BaseOffsetInLayoutClass == FirstBaseOffsetInLayoutClass)
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001506 return true;
1507
1508 // We know now that Base (or a direct or indirect base of it) is a primary
1509 // base in part of the class hierarchy, but not a primary base in the most
1510 // derived class.
1511
1512 // If the overrider is the first base in the primary base chain, we know
1513 // that the overrider will be used.
Anders Carlsson60396612010-03-10 06:51:42 +00001514 if (Overrider->getParent() == FirstBaseInPrimaryBaseChain)
Anders Carlsson464c8f12010-02-23 04:26:39 +00001515 return true;
1516
Anders Carlsson94464812010-04-10 19:13:06 +00001517 VTableBuilder::PrimaryBasesSetVectorTy PrimaryBases;
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001518
Anders Carlsson60396612010-03-10 06:51:42 +00001519 const CXXRecordDecl *RD = FirstBaseInPrimaryBaseChain;
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001520 PrimaryBases.insert(RD);
1521
1522 // Now traverse the base chain, starting with the first base, until we find
1523 // the base that is no longer a primary base.
1524 while (true) {
1525 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1526 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
1527
1528 if (!PrimaryBase)
1529 break;
1530
Anders Carlssonc9e814b2010-11-24 23:12:57 +00001531 if (Layout.isPrimaryBaseVirtual()) {
Anders Carlssona14f5972010-10-31 23:22:37 +00001532 assert(Layout.getVBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001533 "Primary base should always be at offset 0!");
1534
Anders Carlssondad0f992010-02-28 18:37:33 +00001535 const ASTRecordLayout &LayoutClassLayout =
1536 Context.getASTRecordLayout(LayoutClass);
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001537
1538 // Now check if this is the primary base that is not a primary base in the
1539 // most derived class.
Anders Carlssona14f5972010-10-31 23:22:37 +00001540 if (LayoutClassLayout.getVBaseClassOffsetInBits(PrimaryBase) !=
Anders Carlsson60396612010-03-10 06:51:42 +00001541 FirstBaseOffsetInLayoutClass) {
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001542 // We found it, stop walking the chain.
1543 break;
1544 }
1545 } else {
Anders Carlssona14f5972010-10-31 23:22:37 +00001546 assert(Layout.getBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001547 "Primary base should always be at offset 0!");
1548 }
Anders Carlssoncd4e6372010-02-27 18:09:40 +00001549
Anders Carlssonf89bb6c2010-02-27 19:51:04 +00001550 if (!PrimaryBases.insert(PrimaryBase))
1551 assert(false && "Found a duplicate primary base!");
1552
Anders Carlssoncd4e6372010-02-27 18:09:40 +00001553 RD = PrimaryBase;
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001554 }
1555
1556 // If the final overrider is an override of one of the primary bases,
1557 // then we know that it will be used.
Anders Carlsson60396612010-03-10 06:51:42 +00001558 return OverridesIndirectMethodInBases(Overrider, PrimaryBases);
Anders Carlsson464c8f12010-02-23 04:26:39 +00001559}
1560
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001561/// FindNearestOverriddenMethod - Given a method, returns the overridden method
1562/// from the nearest base. Returns null if no method was found.
1563static const CXXMethodDecl *
1564FindNearestOverriddenMethod(const CXXMethodDecl *MD,
Anders Carlsson94464812010-04-10 19:13:06 +00001565 VTableBuilder::PrimaryBasesSetVectorTy &Bases) {
Anders Carlssonf622b452010-04-10 20:39:29 +00001566 OverriddenMethodsSetTy OverriddenMethods;
1567 ComputeAllOverriddenMethods(MD, OverriddenMethods);
1568
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001569 for (int I = Bases.size(), E = 0; I != E; --I) {
1570 const CXXRecordDecl *PrimaryBase = Bases[I - 1];
1571
1572 // Now check the overriden methods.
Anders Carlssonf622b452010-04-10 20:39:29 +00001573 for (OverriddenMethodsSetTy::const_iterator I = OverriddenMethods.begin(),
1574 E = OverriddenMethods.end(); I != E; ++I) {
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001575 const CXXMethodDecl *OverriddenMD = *I;
Anders Carlssonf622b452010-04-10 20:39:29 +00001576
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001577 // We found our overridden method.
1578 if (OverriddenMD->getParent() == PrimaryBase)
1579 return OverriddenMD;
1580 }
1581 }
1582
1583 return 0;
1584}
1585
Anders Carlsson60396612010-03-10 06:51:42 +00001586void
Anders Carlsson94464812010-04-10 19:13:06 +00001587VTableBuilder::AddMethods(BaseSubobject Base, uint64_t BaseOffsetInLayoutClass,
Anders Carlsson60396612010-03-10 06:51:42 +00001588 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
1589 uint64_t FirstBaseOffsetInLayoutClass,
Anders Carlssonb9021e92010-02-27 16:18:19 +00001590 PrimaryBasesSetVectorTy &PrimaryBases) {
Anders Carlsson57071e22010-02-12 05:25:12 +00001591 const CXXRecordDecl *RD = Base.getBase();
Anders Carlsson57071e22010-02-12 05:25:12 +00001592 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1593
1594 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
Ken Dyck57ebe332011-03-26 00:51:24 +00001595 CharUnits PrimaryBaseOffset;
Anders Carlsson60396612010-03-10 06:51:42 +00001596 uint64_t PrimaryBaseOffsetInLayoutClass;
Anders Carlssonc9e814b2010-11-24 23:12:57 +00001597 if (Layout.isPrimaryBaseVirtual()) {
Anders Carlssona14f5972010-10-31 23:22:37 +00001598 assert(Layout.getVBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlssonaf280c02010-02-23 03:48:14 +00001599 "Primary vbase should have a zero offset!");
1600
1601 const ASTRecordLayout &MostDerivedClassLayout =
1602 Context.getASTRecordLayout(MostDerivedClass);
1603
Anders Carlsson60396612010-03-10 06:51:42 +00001604 PrimaryBaseOffset =
Ken Dyck57ebe332011-03-26 00:51:24 +00001605 MostDerivedClassLayout.getVBaseClassOffset(PrimaryBase);
Anders Carlsson60396612010-03-10 06:51:42 +00001606
1607 const ASTRecordLayout &LayoutClassLayout =
1608 Context.getASTRecordLayout(LayoutClass);
1609
1610 PrimaryBaseOffsetInLayoutClass =
Anders Carlssona14f5972010-10-31 23:22:37 +00001611 LayoutClassLayout.getVBaseClassOffsetInBits(PrimaryBase);
Anders Carlssonaf280c02010-02-23 03:48:14 +00001612 } else {
Anders Carlssona14f5972010-10-31 23:22:37 +00001613 assert(Layout.getBaseClassOffsetInBits(PrimaryBase) == 0 &&
Anders Carlsson57071e22010-02-12 05:25:12 +00001614 "Primary base should have a zero offset!");
Anders Carlssonaf280c02010-02-23 03:48:14 +00001615
Ken Dyck57ebe332011-03-26 00:51:24 +00001616 PrimaryBaseOffset = Base.getBaseOffset();
Anders Carlsson60396612010-03-10 06:51:42 +00001617 PrimaryBaseOffsetInLayoutClass = BaseOffsetInLayoutClass;
Anders Carlssonaf280c02010-02-23 03:48:14 +00001618 }
Anders Carlssondad0f992010-02-28 18:37:33 +00001619
Ken Dyck57ebe332011-03-26 00:51:24 +00001620 AddMethods(BaseSubobject(PrimaryBase, PrimaryBaseOffset),
Anders Carlsson60396612010-03-10 06:51:42 +00001621 PrimaryBaseOffsetInLayoutClass, FirstBaseInPrimaryBaseChain,
1622 FirstBaseOffsetInLayoutClass, PrimaryBases);
Anders Carlsson57071e22010-02-12 05:25:12 +00001623
1624 if (!PrimaryBases.insert(PrimaryBase))
1625 assert(false && "Found a duplicate primary base!");
1626 }
Anders Carlsson822307b2010-02-11 17:18:51 +00001627
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001628 // Now go through all virtual member functions and add them.
1629 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
1630 E = RD->method_end(); I != E; ++I) {
1631 const CXXMethodDecl *MD = *I;
Anders Carlsson57071e22010-02-12 05:25:12 +00001632
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001633 if (!MD->isVirtual())
1634 continue;
Anders Carlsson57071e22010-02-12 05:25:12 +00001635
1636 // Get the final overrider.
Anders Carlssona7575822010-02-12 16:55:34 +00001637 FinalOverriders::OverriderInfo Overrider =
Ken Dycke6203132011-03-26 01:18:17 +00001638 Overriders.getOverrider(MD, Base.getBaseOffset());
Anders Carlsson57071e22010-02-12 05:25:12 +00001639
1640 // Check if this virtual member function overrides a method in a primary
1641 // base. If this is the case, and the return type doesn't require adjustment
1642 // then we can just use the member function from the primary base.
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001643 if (const CXXMethodDecl *OverriddenMD =
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001644 FindNearestOverriddenMethod(MD, PrimaryBases)) {
Anders Carlssondf31af12010-02-13 23:17:31 +00001645 if (ComputeReturnAdjustmentBaseOffset(Context, MD,
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001646 OverriddenMD).isEmpty()) {
1647 // Replace the method info of the overridden method with our own
1648 // method.
1649 assert(MethodInfoMap.count(OverriddenMD) &&
1650 "Did not find the overridden method!");
1651 MethodInfo &OverriddenMethodInfo = MethodInfoMap[OverriddenMD];
1652
Ken Dyck4230d522011-03-24 01:21:01 +00001653 MethodInfo MethodInfo(Context.toBits(Base.getBaseOffset()),
Anders Carlsson2bc1d3a2010-03-10 21:25:37 +00001654 BaseOffsetInLayoutClass,
Anders Carlsson718d0692010-04-11 22:07:06 +00001655 OverriddenMethodInfo.VTableIndex);
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001656
1657 assert(!MethodInfoMap.count(MD) &&
1658 "Should not have method info for this method yet!");
1659
1660 MethodInfoMap.insert(std::make_pair(MD, MethodInfo));
1661 MethodInfoMap.erase(OverriddenMD);
Anders Carlssonbca5d372010-03-22 20:06:40 +00001662
1663 // If the overridden method exists in a virtual base class or a direct
1664 // or indirect base class of a virtual base class, we need to emit a
1665 // thunk if we ever have a class hierarchy where the base class is not
1666 // a primary base in the complete object.
Anders Carlsson718d0692010-04-11 22:07:06 +00001667 if (!isBuildingConstructorVTable() && OverriddenMD != MD) {
Anders Carlssonbca5d372010-03-22 20:06:40 +00001668 // Compute the this adjustment.
1669 ThisAdjustment ThisAdjustment =
1670 ComputeThisAdjustment(OverriddenMD, BaseOffsetInLayoutClass,
1671 Overrider);
1672
Anders Carlssonacfa6ae2010-03-29 02:53:58 +00001673 if (ThisAdjustment.VCallOffsetOffset &&
1674 Overrider.Method->getParent() == MostDerivedClass) {
John McCall4e3b17c2010-11-09 01:18:05 +00001675
1676 // There's no return adjustment from OverriddenMD and MD,
1677 // but that doesn't mean there isn't one between MD and
1678 // the final overrider.
1679 BaseOffset ReturnAdjustmentOffset =
1680 ComputeReturnAdjustmentBaseOffset(Context, Overrider.Method, MD);
1681 ReturnAdjustment ReturnAdjustment =
1682 ComputeReturnAdjustment(ReturnAdjustmentOffset);
1683
Anders Carlssonacfa6ae2010-03-29 02:53:58 +00001684 // This is a virtual thunk for the most derived class, add it.
Anders Carlssonbca5d372010-03-22 20:06:40 +00001685 AddThunk(Overrider.Method,
John McCall4e3b17c2010-11-09 01:18:05 +00001686 ThunkInfo(ThisAdjustment, ReturnAdjustment));
Anders Carlssonbca5d372010-03-22 20:06:40 +00001687 }
1688 }
1689
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001690 continue;
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001691 }
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001692 }
Anders Carlsson0c0eeb22010-02-13 02:02:03 +00001693
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001694 // Insert the method info for this method.
Ken Dyck4230d522011-03-24 01:21:01 +00001695 MethodInfo MethodInfo(Context.toBits(Base.getBaseOffset()),
1696 BaseOffsetInLayoutClass, Components.size());
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001697
1698 assert(!MethodInfoMap.count(MD) &&
1699 "Should not have method info for this method yet!");
1700 MethodInfoMap.insert(std::make_pair(MD, MethodInfo));
Anders Carlssoncd4e6372010-02-27 18:09:40 +00001701
1702 // Check if this overrider is going to be used.
Anders Carlsson60396612010-03-10 06:51:42 +00001703 const CXXMethodDecl *OverriderMD = Overrider.Method;
1704 if (!IsOverriderUsed(OverriderMD, BaseOffsetInLayoutClass,
1705 FirstBaseInPrimaryBaseChain,
1706 FirstBaseOffsetInLayoutClass)) {
Anders Carlsson94464812010-04-10 19:13:06 +00001707 Components.push_back(VTableComponent::MakeUnusedFunction(OverriderMD));
Anders Carlssoncd4e6372010-02-27 18:09:40 +00001708 continue;
1709 }
Anders Carlsson464c8f12010-02-23 04:26:39 +00001710
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001711 // Check if this overrider needs a return adjustment.
Anders Carlsson7097e752010-06-01 23:47:05 +00001712 // We don't want to do this for pure virtual member functions.
1713 BaseOffset ReturnAdjustmentOffset;
1714 if (!OverriderMD->isPure()) {
1715 ReturnAdjustmentOffset =
1716 ComputeReturnAdjustmentBaseOffset(Context, OverriderMD, MD);
1717 }
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001718
1719 ReturnAdjustment ReturnAdjustment =
1720 ComputeReturnAdjustment(ReturnAdjustmentOffset);
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001721
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001722 AddMethod(Overrider.Method, ReturnAdjustment);
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001723 }
1724}
1725
Anders Carlsson718d0692010-04-11 22:07:06 +00001726void VTableBuilder::LayoutVTable() {
Ken Dyck4230d522011-03-24 01:21:01 +00001727 LayoutPrimaryAndSecondaryVTables(BaseSubobject(MostDerivedClass,
1728 CharUnits::Zero()),
Anders Carlsson73e6fa02010-04-11 22:20:36 +00001729 /*BaseIsMorallyVirtual=*/false,
Anders Carlsson530c40c2010-02-28 01:43:58 +00001730 MostDerivedClassIsVirtual,
1731 MostDerivedClassOffset);
Anders Carlsson89ad4212010-02-16 16:26:28 +00001732
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001733 VisitedVirtualBasesSetTy VBases;
Anders Carlsson08c26752010-02-27 04:05:52 +00001734
1735 // Determine the primary virtual bases.
Anders Carlssond7fdae52010-03-10 03:02:01 +00001736 DeterminePrimaryVirtualBases(MostDerivedClass, MostDerivedClassOffset,
1737 VBases);
Anders Carlsson08c26752010-02-27 04:05:52 +00001738 VBases.clear();
1739
Anders Carlsson718d0692010-04-11 22:07:06 +00001740 LayoutVTablesForVirtualBases(MostDerivedClass, VBases);
Anders Carlsson89ad4212010-02-16 16:26:28 +00001741}
1742
Anders Carlsson530c40c2010-02-28 01:43:58 +00001743void
Anders Carlsson718d0692010-04-11 22:07:06 +00001744VTableBuilder::LayoutPrimaryAndSecondaryVTables(BaseSubobject Base,
Anders Carlsson73e6fa02010-04-11 22:20:36 +00001745 bool BaseIsMorallyVirtual,
Anders Carlsson91232842010-04-11 22:03:57 +00001746 bool BaseIsVirtualInLayoutClass,
Anders Carlsson530c40c2010-02-28 01:43:58 +00001747 uint64_t OffsetInLayoutClass) {
Chris Lattner04a23112010-02-17 21:42:34 +00001748 assert(Base.getBase()->isDynamicClass() && "class does not have a vtable!");
Anders Carlssonb828afa2010-02-14 17:05:59 +00001749
Anders Carlsson852213e2010-02-16 04:59:55 +00001750 // Add vcall and vbase offsets for this vtable.
Anders Carlsson530c40c2010-02-28 01:43:58 +00001751 VCallAndVBaseOffsetBuilder Builder(MostDerivedClass, LayoutClass, &Overriders,
Anders Carlsson91232842010-04-11 22:03:57 +00001752 Base, BaseIsVirtualInLayoutClass,
1753 OffsetInLayoutClass);
Anders Carlssond68c0832010-02-25 03:45:56 +00001754 Components.append(Builder.components_begin(), Builder.components_end());
1755
Anders Carlssondba6ef82010-02-25 22:23:13 +00001756 // Check if we need to add these vcall offsets.
Anders Carlsson91232842010-04-11 22:03:57 +00001757 if (BaseIsVirtualInLayoutClass && !Builder.getVCallOffsets().empty()) {
Anders Carlssondba6ef82010-02-25 22:23:13 +00001758 VCallOffsetMap &VCallOffsets = VCallOffsetsForVBases[Base.getBase()];
1759
1760 if (VCallOffsets.empty())
1761 VCallOffsets = Builder.getVCallOffsets();
1762 }
1763
Anders Carlssonbb6305b2010-03-11 06:43:12 +00001764 // If we're laying out the most derived class we want to keep track of the
1765 // virtual base class offset offsets.
1766 if (Base.getBase() == MostDerivedClass)
1767 VBaseOffsetOffsets = Builder.getVBaseOffsetOffsets();
1768
Anders Carlsson852213e2010-02-16 04:59:55 +00001769 // Add the offset to top.
Anders Carlssone67dc302010-02-14 00:16:19 +00001770 // FIXME: We should not use / 8 here.
Anders Carlsson530c40c2010-02-28 01:43:58 +00001771 int64_t OffsetToTop = -(int64_t)(OffsetInLayoutClass -
1772 MostDerivedClassOffset) / 8;
Anders Carlsson94464812010-04-10 19:13:06 +00001773 Components.push_back(VTableComponent::MakeOffsetToTop(OffsetToTop));
Anders Carlsson57071e22010-02-12 05:25:12 +00001774
1775 // Next, add the RTTI.
Anders Carlsson94464812010-04-10 19:13:06 +00001776 Components.push_back(VTableComponent::MakeRTTI(MostDerivedClass));
Anders Carlsson57071e22010-02-12 05:25:12 +00001777
Anders Carlsson28cbc8b2010-02-12 07:43:48 +00001778 uint64_t AddressPoint = Components.size();
Anders Carlsson57071e22010-02-12 05:25:12 +00001779
1780 // Now go through all virtual member functions and add them.
Anders Carlssonb9021e92010-02-27 16:18:19 +00001781 PrimaryBasesSetVectorTy PrimaryBases;
Anders Carlsson60396612010-03-10 06:51:42 +00001782 AddMethods(Base, OffsetInLayoutClass, Base.getBase(), OffsetInLayoutClass,
1783 PrimaryBases);
Anders Carlsson57071e22010-02-12 05:25:12 +00001784
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001785 // Compute 'this' pointer adjustments.
1786 ComputeThisAdjustments();
1787
Anders Carlsson014a3582010-03-25 21:45:14 +00001788 // Add all address points.
1789 const CXXRecordDecl *RD = Base.getBase();
1790 while (true) {
Ken Dyck4230d522011-03-24 01:21:01 +00001791 AddressPoints.insert(std::make_pair(
1792 BaseSubobject(RD, Context.toCharUnitsFromBits(OffsetInLayoutClass)),
1793 AddressPoint));
Anders Carlsson014a3582010-03-25 21:45:14 +00001794
1795 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1796 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
Anders Carlsson28cbc8b2010-02-12 07:43:48 +00001797
Anders Carlsson014a3582010-03-25 21:45:14 +00001798 if (!PrimaryBase)
1799 break;
1800
Anders Carlssonc9e814b2010-11-24 23:12:57 +00001801 if (Layout.isPrimaryBaseVirtual()) {
Anders Carlsson014a3582010-03-25 21:45:14 +00001802 // Check if this virtual primary base is a primary base in the layout
1803 // class. If it's not, we don't want to add it.
1804 const ASTRecordLayout &LayoutClassLayout =
1805 Context.getASTRecordLayout(LayoutClass);
1806
Anders Carlssona14f5972010-10-31 23:22:37 +00001807 if (LayoutClassLayout.getVBaseClassOffsetInBits(PrimaryBase) !=
Anders Carlsson014a3582010-03-25 21:45:14 +00001808 OffsetInLayoutClass) {
1809 // We don't want to add this class (or any of its primary bases).
1810 break;
1811 }
1812 }
1813
1814 RD = PrimaryBase;
Anders Carlsson28cbc8b2010-02-12 07:43:48 +00001815 }
1816
Anders Carlsson5edcc372010-02-24 16:43:12 +00001817 // Layout secondary vtables.
Anders Carlsson718d0692010-04-11 22:07:06 +00001818 LayoutSecondaryVTables(Base, BaseIsMorallyVirtual, OffsetInLayoutClass);
Anders Carlssonc7b63162010-02-16 16:02:57 +00001819}
1820
Anders Carlsson718d0692010-04-11 22:07:06 +00001821void VTableBuilder::LayoutSecondaryVTables(BaseSubobject Base,
Anders Carlssona96a2e92010-03-10 19:39:11 +00001822 bool BaseIsMorallyVirtual,
Anders Carlsson530c40c2010-02-28 01:43:58 +00001823 uint64_t OffsetInLayoutClass) {
Anders Carlssonc7b63162010-02-16 16:02:57 +00001824 // Itanium C++ ABI 2.5.2:
1825 // Following the primary virtual table of a derived class are secondary
1826 // virtual tables for each of its proper base classes, except any primary
1827 // base(s) with which it shares its primary virtual table.
1828
1829 const CXXRecordDecl *RD = Base.getBase();
Anders Carlsson57071e22010-02-12 05:25:12 +00001830 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1831 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
Anders Carlssonc7b63162010-02-16 16:02:57 +00001832
Anders Carlsson57071e22010-02-12 05:25:12 +00001833 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1834 E = RD->bases_end(); I != E; ++I) {
Anders Carlssonc7b63162010-02-16 16:02:57 +00001835 // Ignore virtual bases, we'll emit them later.
1836 if (I->isVirtual())
1837 continue;
1838
Anders Carlsson57071e22010-02-12 05:25:12 +00001839 const CXXRecordDecl *BaseDecl =
1840 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Anders Carlssonb828afa2010-02-14 17:05:59 +00001841
Anders Carlssona661a542010-02-16 04:49:44 +00001842 // Ignore bases that don't have a vtable.
1843 if (!BaseDecl->isDynamicClass())
1844 continue;
Anders Carlssonb828afa2010-02-14 17:05:59 +00001845
Anders Carlsson718d0692010-04-11 22:07:06 +00001846 if (isBuildingConstructorVTable()) {
Anders Carlssonf2c98ce2010-03-10 19:15:26 +00001847 // Itanium C++ ABI 2.6.4:
1848 // Some of the base class subobjects may not need construction virtual
1849 // tables, which will therefore not be present in the construction
1850 // virtual table group, even though the subobject virtual tables are
1851 // present in the main virtual table group for the complete object.
Anders Carlssona96a2e92010-03-10 19:39:11 +00001852 if (!BaseIsMorallyVirtual && !BaseDecl->getNumVBases())
Anders Carlssonf2c98ce2010-03-10 19:15:26 +00001853 continue;
Anders Carlssonf2c98ce2010-03-10 19:15:26 +00001854 }
1855
Anders Carlsson76f1aa72010-02-13 22:05:23 +00001856 // Get the base offset of this base.
Ken Dyck57ebe332011-03-26 00:51:24 +00001857 CharUnits RelativeBaseOffset = Layout.getBaseClassOffset(BaseDecl);
1858 CharUnits BaseOffset = Base.getBaseOffset() + RelativeBaseOffset;
Anders Carlsson530c40c2010-02-28 01:43:58 +00001859
Ken Dyck57ebe332011-03-26 00:51:24 +00001860 CharUnits BaseOffsetInLayoutClass =
1861 Context.toCharUnitsFromBits(OffsetInLayoutClass) + RelativeBaseOffset;
Anders Carlssonc7b63162010-02-16 16:02:57 +00001862
1863 // Don't emit a secondary vtable for a primary base. We might however want
1864 // to emit secondary vtables for other bases of this base.
1865 if (BaseDecl == PrimaryBase) {
Ken Dyck4230d522011-03-24 01:21:01 +00001866 LayoutSecondaryVTables(
Ken Dyck57ebe332011-03-26 00:51:24 +00001867 BaseSubobject(BaseDecl, BaseOffset),
1868 BaseIsMorallyVirtual, Context.toBits(BaseOffsetInLayoutClass));
Anders Carlssonc7b63162010-02-16 16:02:57 +00001869 continue;
1870 }
Anders Carlsson76f1aa72010-02-13 22:05:23 +00001871
Anders Carlsson89ad4212010-02-16 16:26:28 +00001872 // Layout the primary vtable (and any secondary vtables) for this base.
Ken Dyck4230d522011-03-24 01:21:01 +00001873 LayoutPrimaryAndSecondaryVTables(
Ken Dyck57ebe332011-03-26 00:51:24 +00001874 BaseSubobject(BaseDecl, BaseOffset),
Ken Dyck4230d522011-03-24 01:21:01 +00001875 BaseIsMorallyVirtual,
1876 /*BaseIsVirtualInLayoutClass=*/false,
Ken Dyck57ebe332011-03-26 00:51:24 +00001877 Context.toBits(BaseOffsetInLayoutClass));
Anders Carlsson57071e22010-02-12 05:25:12 +00001878 }
1879}
1880
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001881void
Anders Carlsson94464812010-04-10 19:13:06 +00001882VTableBuilder::DeterminePrimaryVirtualBases(const CXXRecordDecl *RD,
Anders Carlssond7fdae52010-03-10 03:02:01 +00001883 uint64_t OffsetInLayoutClass,
Anders Carlsson08c26752010-02-27 04:05:52 +00001884 VisitedVirtualBasesSetTy &VBases) {
1885 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1886
1887 // Check if this base has a primary base.
1888 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
Anders Carlsson0378bf02010-02-28 18:08:38 +00001889
1890 // Check if it's virtual.
Anders Carlssonc9e814b2010-11-24 23:12:57 +00001891 if (Layout.isPrimaryBaseVirtual()) {
Anders Carlsson0378bf02010-02-28 18:08:38 +00001892 bool IsPrimaryVirtualBase = true;
1893
Anders Carlsson718d0692010-04-11 22:07:06 +00001894 if (isBuildingConstructorVTable()) {
Anders Carlsson0378bf02010-02-28 18:08:38 +00001895 // Check if the base is actually a primary base in the class we use for
1896 // layout.
Anders Carlssond7fdae52010-03-10 03:02:01 +00001897 const ASTRecordLayout &LayoutClassLayout =
1898 Context.getASTRecordLayout(LayoutClass);
1899
1900 uint64_t PrimaryBaseOffsetInLayoutClass =
Anders Carlssona14f5972010-10-31 23:22:37 +00001901 LayoutClassLayout.getVBaseClassOffsetInBits(PrimaryBase);
Anders Carlssond7fdae52010-03-10 03:02:01 +00001902
1903 // We know that the base is not a primary base in the layout class if
1904 // the base offsets are different.
1905 if (PrimaryBaseOffsetInLayoutClass != OffsetInLayoutClass)
Anders Carlsson0378bf02010-02-28 18:08:38 +00001906 IsPrimaryVirtualBase = false;
1907 }
1908
1909 if (IsPrimaryVirtualBase)
1910 PrimaryVirtualBases.insert(PrimaryBase);
1911 }
Anders Carlsson08c26752010-02-27 04:05:52 +00001912 }
1913
1914 // Traverse bases, looking for more primary virtual bases.
1915 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1916 E = RD->bases_end(); I != E; ++I) {
1917 const CXXRecordDecl *BaseDecl =
1918 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1919
Anders Carlssond7fdae52010-03-10 03:02:01 +00001920 uint64_t BaseOffsetInLayoutClass;
1921
1922 if (I->isVirtual()) {
1923 if (!VBases.insert(BaseDecl))
1924 continue;
1925
1926 const ASTRecordLayout &LayoutClassLayout =
1927 Context.getASTRecordLayout(LayoutClass);
Anders Carlsson08c26752010-02-27 04:05:52 +00001928
Anders Carlssona14f5972010-10-31 23:22:37 +00001929 BaseOffsetInLayoutClass =
1930 LayoutClassLayout.getVBaseClassOffsetInBits(BaseDecl);
Anders Carlssond7fdae52010-03-10 03:02:01 +00001931 } else {
1932 BaseOffsetInLayoutClass =
Anders Carlssona14f5972010-10-31 23:22:37 +00001933 OffsetInLayoutClass + Layout.getBaseClassOffsetInBits(BaseDecl);
Anders Carlssond7fdae52010-03-10 03:02:01 +00001934 }
1935
1936 DeterminePrimaryVirtualBases(BaseDecl, BaseOffsetInLayoutClass, VBases);
Anders Carlsson08c26752010-02-27 04:05:52 +00001937 }
1938}
1939
1940void
Anders Carlsson718d0692010-04-11 22:07:06 +00001941VTableBuilder::LayoutVTablesForVirtualBases(const CXXRecordDecl *RD,
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001942 VisitedVirtualBasesSetTy &VBases) {
1943 // Itanium C++ ABI 2.5.2:
1944 // Then come the virtual base virtual tables, also in inheritance graph
1945 // order, and again excluding primary bases (which share virtual tables with
1946 // the classes for which they are primary).
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001947 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1948 E = RD->bases_end(); I != E; ++I) {
1949 const CXXRecordDecl *BaseDecl =
1950 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1951
Anders Carlssonaf280c02010-02-23 03:48:14 +00001952 // Check if this base needs a vtable. (If it's virtual, not a primary base
1953 // of some other class, and we haven't visited it before).
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001954 if (I->isVirtual() && BaseDecl->isDynamicClass() &&
Anders Carlsson08c26752010-02-27 04:05:52 +00001955 !PrimaryVirtualBases.count(BaseDecl) && VBases.insert(BaseDecl)) {
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001956 const ASTRecordLayout &MostDerivedClassLayout =
1957 Context.getASTRecordLayout(MostDerivedClass);
1958 uint64_t BaseOffset =
Anders Carlssona14f5972010-10-31 23:22:37 +00001959 MostDerivedClassLayout.getVBaseClassOffsetInBits(BaseDecl);
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001960
Anders Carlsson530c40c2010-02-28 01:43:58 +00001961 const ASTRecordLayout &LayoutClassLayout =
1962 Context.getASTRecordLayout(LayoutClass);
1963 uint64_t BaseOffsetInLayoutClass =
Anders Carlssona14f5972010-10-31 23:22:37 +00001964 LayoutClassLayout.getVBaseClassOffsetInBits(BaseDecl);
Anders Carlsson530c40c2010-02-28 01:43:58 +00001965
Ken Dyck4230d522011-03-24 01:21:01 +00001966 LayoutPrimaryAndSecondaryVTables(
1967 BaseSubobject(BaseDecl, Context.toCharUnitsFromBits(BaseOffset)),
1968 /*BaseIsMorallyVirtual=*/true,
1969 /*BaseIsVirtualInLayoutClass=*/true,
1970 BaseOffsetInLayoutClass);
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001971 }
1972
1973 // We only need to check the base for virtual base vtables if it actually
1974 // has virtual bases.
1975 if (BaseDecl->getNumVBases())
Anders Carlsson718d0692010-04-11 22:07:06 +00001976 LayoutVTablesForVirtualBases(BaseDecl, VBases);
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001977 }
1978}
1979
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001980/// dumpLayout - Dump the vtable layout.
Anders Carlsson94464812010-04-10 19:13:06 +00001981void VTableBuilder::dumpLayout(llvm::raw_ostream& Out) {
Anders Carlssond03a3262010-02-27 20:39:05 +00001982
Anders Carlsson718d0692010-04-11 22:07:06 +00001983 if (isBuildingConstructorVTable()) {
Anders Carlssond03a3262010-02-27 20:39:05 +00001984 Out << "Construction vtable for ('";
1985 Out << MostDerivedClass->getQualifiedNameAsString() << "', ";
1986 // FIXME: Don't use / 8 .
1987 Out << MostDerivedClassOffset / 8 << ") in '";
1988 Out << LayoutClass->getQualifiedNameAsString();
Anders Carlssonbb6305b2010-03-11 06:43:12 +00001989 } else {
1990 Out << "Vtable for '";
1991 Out << MostDerivedClass->getQualifiedNameAsString();
Anders Carlssond03a3262010-02-27 20:39:05 +00001992 }
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001993 Out << "' (" << Components.size() << " entries).\n";
1994
Anders Carlsson822307b2010-02-11 17:18:51 +00001995 // Iterate through the address points and insert them into a new map where
1996 // they are keyed by the index and not the base object.
1997 // Since an address point can be shared by multiple subobjects, we use an
1998 // STL multimap.
1999 std::multimap<uint64_t, BaseSubobject> AddressPointsByIndex;
Anders Carlssonff143f82010-03-25 00:35:49 +00002000 for (AddressPointsMapTy::const_iterator I = AddressPoints.begin(),
2001 E = AddressPoints.end(); I != E; ++I) {
Anders Carlsson822307b2010-02-11 17:18:51 +00002002 const BaseSubobject& Base = I->first;
2003 uint64_t Index = I->second;
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002004
Anders Carlsson822307b2010-02-11 17:18:51 +00002005 AddressPointsByIndex.insert(std::make_pair(Index, Base));
2006 }
2007
2008 for (unsigned I = 0, E = Components.size(); I != E; ++I) {
Anders Carlsson28cbc8b2010-02-12 07:43:48 +00002009 uint64_t Index = I;
Anders Carlsson822307b2010-02-11 17:18:51 +00002010
2011 Out << llvm::format("%4d | ", I);
2012
Anders Carlsson94464812010-04-10 19:13:06 +00002013 const VTableComponent &Component = Components[I];
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002014
2015 // Dump the component.
2016 switch (Component.getKind()) {
Anders Carlssond9a67042010-02-17 06:07:19 +00002017
Anders Carlsson94464812010-04-10 19:13:06 +00002018 case VTableComponent::CK_VCallOffset:
Anders Carlssond9a67042010-02-17 06:07:19 +00002019 Out << "vcall_offset (" << Component.getVCallOffset() << ")";
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002020 break;
Anders Carlsson852213e2010-02-16 04:59:55 +00002021
Anders Carlsson94464812010-04-10 19:13:06 +00002022 case VTableComponent::CK_VBaseOffset:
Anders Carlsson852213e2010-02-16 04:59:55 +00002023 Out << "vbase_offset (" << Component.getVBaseOffset() << ")";
2024 break;
2025
Anders Carlsson94464812010-04-10 19:13:06 +00002026 case VTableComponent::CK_OffsetToTop:
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002027 Out << "offset_to_top (" << Component.getOffsetToTop() << ")";
2028 break;
2029
Anders Carlsson94464812010-04-10 19:13:06 +00002030 case VTableComponent::CK_RTTI:
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002031 Out << Component.getRTTIDecl()->getQualifiedNameAsString() << " RTTI";
2032 break;
2033
Anders Carlsson94464812010-04-10 19:13:06 +00002034 case VTableComponent::CK_FunctionPointer: {
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002035 const CXXMethodDecl *MD = Component.getFunctionDecl();
2036
Anders Carlsson848fa642010-02-11 18:20:28 +00002037 std::string Str =
2038 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
2039 MD);
2040 Out << Str;
Anders Carlsson98241422010-02-12 02:38:13 +00002041 if (MD->isPure())
2042 Out << " [pure]";
2043
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00002044 ThunkInfo Thunk = VTableThunks.lookup(I);
Anders Carlssondd366812010-03-12 04:54:20 +00002045 if (!Thunk.isEmpty()) {
2046 // If this function pointer has a return adjustment, dump it.
2047 if (!Thunk.Return.isEmpty()) {
2048 Out << "\n [return adjustment: ";
2049 Out << Thunk.Return.NonVirtual << " non-virtual";
2050
2051 if (Thunk.Return.VBaseOffsetOffset) {
2052 Out << ", " << Thunk.Return.VBaseOffsetOffset;
2053 Out << " vbase offset offset";
2054 }
Anders Carlsson60cc72a2010-02-18 17:00:09 +00002055
Anders Carlssondd366812010-03-12 04:54:20 +00002056 Out << ']';
2057 }
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00002058
Anders Carlssondd366812010-03-12 04:54:20 +00002059 // If this function pointer has a 'this' pointer adjustment, dump it.
2060 if (!Thunk.This.isEmpty()) {
2061 Out << "\n [this adjustment: ";
2062 Out << Thunk.This.NonVirtual << " non-virtual";
2063
2064 if (Thunk.This.VCallOffsetOffset) {
2065 Out << ", " << Thunk.This.VCallOffsetOffset;
2066 Out << " vcall offset offset";
2067 }
Anders Carlsson60cc72a2010-02-18 17:00:09 +00002068
Anders Carlssondd366812010-03-12 04:54:20 +00002069 Out << ']';
2070 }
Anders Carlsson49bac9a2010-02-13 23:40:17 +00002071 }
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00002072
Anders Carlsson848fa642010-02-11 18:20:28 +00002073 break;
2074 }
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002075
Anders Carlsson94464812010-04-10 19:13:06 +00002076 case VTableComponent::CK_CompleteDtorPointer:
2077 case VTableComponent::CK_DeletingDtorPointer: {
Anders Carlsson6065e022010-02-19 06:03:53 +00002078 bool IsComplete =
Anders Carlsson94464812010-04-10 19:13:06 +00002079 Component.getKind() == VTableComponent::CK_CompleteDtorPointer;
Anders Carlsson6065e022010-02-19 06:03:53 +00002080
Anders Carlsson848fa642010-02-11 18:20:28 +00002081 const CXXDestructorDecl *DD = Component.getDestructorDecl();
2082
Anders Carlsson6065e022010-02-19 06:03:53 +00002083 Out << DD->getQualifiedNameAsString();
2084 if (IsComplete)
2085 Out << "() [complete]";
2086 else
2087 Out << "() [deleting]";
2088
Anders Carlsson98241422010-02-12 02:38:13 +00002089 if (DD->isPure())
2090 Out << " [pure]";
2091
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00002092 ThunkInfo Thunk = VTableThunks.lookup(I);
Anders Carlssondd366812010-03-12 04:54:20 +00002093 if (!Thunk.isEmpty()) {
2094 // If this destructor has a 'this' pointer adjustment, dump it.
2095 if (!Thunk.This.isEmpty()) {
2096 Out << "\n [this adjustment: ";
2097 Out << Thunk.This.NonVirtual << " non-virtual";
2098
2099 if (Thunk.This.VCallOffsetOffset) {
2100 Out << ", " << Thunk.This.VCallOffsetOffset;
2101 Out << " vcall offset offset";
2102 }
2103
2104 Out << ']';
2105 }
2106 }
Anders Carlsson6065e022010-02-19 06:03:53 +00002107
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002108 break;
2109 }
2110
Anders Carlsson94464812010-04-10 19:13:06 +00002111 case VTableComponent::CK_UnusedFunctionPointer: {
Anders Carlsson1f464662010-02-19 20:08:13 +00002112 const CXXMethodDecl *MD = Component.getUnusedFunctionDecl();
2113
2114 std::string Str =
2115 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
2116 MD);
2117 Out << "[unused] " << Str;
2118 if (MD->isPure())
2119 Out << " [pure]";
2120 }
2121
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002122 }
Anders Carlsson822307b2010-02-11 17:18:51 +00002123
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002124 Out << '\n';
Anders Carlssond2c3a7c2010-02-27 23:58:01 +00002125
2126 // Dump the next address point.
2127 uint64_t NextIndex = Index + 1;
2128 if (AddressPointsByIndex.count(NextIndex)) {
2129 if (AddressPointsByIndex.count(NextIndex) == 1) {
2130 const BaseSubobject &Base =
2131 AddressPointsByIndex.find(NextIndex)->second;
2132
2133 // FIXME: Instead of dividing by 8, we should be using CharUnits.
2134 Out << " -- (" << Base.getBase()->getQualifiedNameAsString();
Ken Dyck4230d522011-03-24 01:21:01 +00002135 Out << ", " << Base.getBaseOffset().getQuantity();
2136 Out << ") vtable address --\n";
Anders Carlssond2c3a7c2010-02-27 23:58:01 +00002137 } else {
Ken Dyck57ebe332011-03-26 00:51:24 +00002138 CharUnits BaseOffset =
2139 AddressPointsByIndex.lower_bound(NextIndex)->second.getBaseOffset();
Anders Carlssond2c3a7c2010-02-27 23:58:01 +00002140
2141 // We store the class names in a set to get a stable order.
2142 std::set<std::string> ClassNames;
2143 for (std::multimap<uint64_t, BaseSubobject>::const_iterator I =
2144 AddressPointsByIndex.lower_bound(NextIndex), E =
2145 AddressPointsByIndex.upper_bound(NextIndex); I != E; ++I) {
Ken Dyck57ebe332011-03-26 00:51:24 +00002146 assert(I->second.getBaseOffset() == BaseOffset &&
Anders Carlssond2c3a7c2010-02-27 23:58:01 +00002147 "Invalid base offset!");
2148 const CXXRecordDecl *RD = I->second.getBase();
2149 ClassNames.insert(RD->getQualifiedNameAsString());
2150 }
2151
2152 for (std::set<std::string>::const_iterator I = ClassNames.begin(),
2153 E = ClassNames.end(); I != E; ++I) {
Anders Carlssond2c3a7c2010-02-27 23:58:01 +00002154 Out << " -- (" << *I;
Ken Dyck57ebe332011-03-26 00:51:24 +00002155 Out << ", " << BaseOffset.getQuantity() << ") vtable address --\n";
Anders Carlssond2c3a7c2010-02-27 23:58:01 +00002156 }
2157 }
2158 }
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002159 }
Anders Carlssond03a3262010-02-27 20:39:05 +00002160
2161 Out << '\n';
Anders Carlssonbb6305b2010-03-11 06:43:12 +00002162
Anders Carlsson718d0692010-04-11 22:07:06 +00002163 if (isBuildingConstructorVTable())
Anders Carlsson9135a842010-03-18 02:44:19 +00002164 return;
2165
2166 if (MostDerivedClass->getNumVBases()) {
Anders Carlssonbb6305b2010-03-11 06:43:12 +00002167 // We store the virtual base class names and their offsets in a map to get
2168 // a stable order.
Anders Carlssonbb6305b2010-03-11 06:43:12 +00002169
Anders Carlsson9135a842010-03-18 02:44:19 +00002170 std::map<std::string, int64_t> ClassNamesAndOffsets;
Anders Carlssonbb6305b2010-03-11 06:43:12 +00002171 for (VBaseOffsetOffsetsMapTy::const_iterator I = VBaseOffsetOffsets.begin(),
2172 E = VBaseOffsetOffsets.end(); I != E; ++I) {
2173 std::string ClassName = I->first->getQualifiedNameAsString();
2174 int64_t OffsetOffset = I->second;
2175 ClassNamesAndOffsets.insert(std::make_pair(ClassName, OffsetOffset));
2176 }
Anders Carlsson9135a842010-03-18 02:44:19 +00002177
2178 Out << "Virtual base offset offsets for '";
2179 Out << MostDerivedClass->getQualifiedNameAsString() << "' (";
2180 Out << ClassNamesAndOffsets.size();
2181 Out << (ClassNamesAndOffsets.size() == 1 ? " entry" : " entries") << ").\n";
Anders Carlssonbb6305b2010-03-11 06:43:12 +00002182
2183 for (std::map<std::string, int64_t>::const_iterator I =
2184 ClassNamesAndOffsets.begin(), E = ClassNamesAndOffsets.end();
2185 I != E; ++I)
2186 Out << " " << I->first << " | " << I->second << '\n';
2187
2188 Out << "\n";
2189 }
Anders Carlsson9135a842010-03-18 02:44:19 +00002190
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00002191 if (!Thunks.empty()) {
Anders Carlsson9135a842010-03-18 02:44:19 +00002192 // We store the method names in a map to get a stable order.
2193 std::map<std::string, const CXXMethodDecl *> MethodNamesAndDecls;
2194
Anders Carlssonee5ab9f2010-03-23 04:59:02 +00002195 for (ThunksMapTy::const_iterator I = Thunks.begin(), E = Thunks.end();
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00002196 I != E; ++I) {
Anders Carlsson9135a842010-03-18 02:44:19 +00002197 const CXXMethodDecl *MD = I->first;
2198 std::string MethodName =
2199 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
2200 MD);
2201
2202 MethodNamesAndDecls.insert(std::make_pair(MethodName, MD));
2203 }
2204
2205 for (std::map<std::string, const CXXMethodDecl *>::const_iterator I =
2206 MethodNamesAndDecls.begin(), E = MethodNamesAndDecls.end();
2207 I != E; ++I) {
2208 const std::string &MethodName = I->first;
2209 const CXXMethodDecl *MD = I->second;
Anders Carlsson87e0ac82010-03-22 16:30:44 +00002210
Anders Carlssonee5ab9f2010-03-23 04:59:02 +00002211 ThunkInfoVectorTy ThunksVector = Thunks[MD];
Anders Carlsson87e0ac82010-03-22 16:30:44 +00002212 std::sort(ThunksVector.begin(), ThunksVector.end());
Anders Carlsson9135a842010-03-18 02:44:19 +00002213
2214 Out << "Thunks for '" << MethodName << "' (" << ThunksVector.size();
2215 Out << (ThunksVector.size() == 1 ? " entry" : " entries") << ").\n";
2216
2217 for (unsigned I = 0, E = ThunksVector.size(); I != E; ++I) {
2218 const ThunkInfo &Thunk = ThunksVector[I];
2219
2220 Out << llvm::format("%4d | ", I);
2221
Anders Carlsson09daa502010-03-22 16:10:59 +00002222 // If this function pointer has a return pointer adjustment, dump it.
2223 if (!Thunk.Return.isEmpty()) {
2224 Out << "return adjustment: " << Thunk.This.NonVirtual;
2225 Out << " non-virtual";
2226 if (Thunk.Return.VBaseOffsetOffset) {
2227 Out << ", " << Thunk.Return.VBaseOffsetOffset;
2228 Out << " vbase offset offset";
2229 }
2230
2231 if (!Thunk.This.isEmpty())
2232 Out << "\n ";
2233 }
2234
Anders Carlsson9135a842010-03-18 02:44:19 +00002235 // If this function pointer has a 'this' pointer adjustment, dump it.
2236 if (!Thunk.This.isEmpty()) {
Anders Carlsson09daa502010-03-22 16:10:59 +00002237 Out << "this adjustment: ";
2238 Out << Thunk.This.NonVirtual << " non-virtual";
Anders Carlsson9135a842010-03-18 02:44:19 +00002239
2240 if (Thunk.This.VCallOffsetOffset) {
2241 Out << ", " << Thunk.This.VCallOffsetOffset;
Anders Carlsson09daa502010-03-22 16:10:59 +00002242 Out << " vcall offset offset";
Anders Carlsson9135a842010-03-18 02:44:19 +00002243 }
2244 }
2245
2246 Out << '\n';
2247 }
Anders Carlssonbca5d372010-03-22 20:06:40 +00002248
2249 Out << '\n';
2250
Anders Carlsson9135a842010-03-18 02:44:19 +00002251 }
2252 }
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002253}
2254
2255}
2256
Anders Carlssonbdb4a9d2010-11-24 23:04:03 +00002257static void
2258CollectPrimaryBases(const CXXRecordDecl *RD, ASTContext &Context,
2259 VTableBuilder::PrimaryBasesSetVectorTy &PrimaryBases) {
2260 while (RD) {
2261 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
2262 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
2263 if (PrimaryBase)
2264 PrimaryBases.insert(PrimaryBase);
2265
2266 RD = PrimaryBase;
2267 }
2268}
2269
Anders Carlsson046c2942010-04-17 20:15:18 +00002270void CodeGenVTables::ComputeMethodVTableIndices(const CXXRecordDecl *RD) {
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002271
2272 // Itanium C++ ABI 2.5.2:
Anders Carlsson45147d02010-02-02 03:37:46 +00002273 // The order of the virtual function pointers in a virtual table is the
2274 // order of declaration of the corresponding member functions in the class.
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002275 //
Anders Carlsson45147d02010-02-02 03:37:46 +00002276 // There is an entry for any virtual function declared in a class,
2277 // whether it is a new function or overrides a base class function,
2278 // unless it overrides a function from the primary base, and conversion
2279 // between their return types does not require an adjustment.
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002280
2281 int64_t CurrentIndex = 0;
2282
2283 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
2284 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
2285
2286 if (PrimaryBase) {
Anders Carlsson0121fbd2009-11-30 19:43:26 +00002287 assert(PrimaryBase->isDefinition() &&
2288 "Should have the definition decl of the primary base!");
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002289
2290 // Since the record decl shares its vtable pointer with the primary base
2291 // we need to start counting at the end of the primary base's vtable.
2292 CurrentIndex = getNumVirtualFunctionPointers(PrimaryBase);
2293 }
Eli Friedmanea5ae312009-12-15 03:31:17 +00002294
2295 // Collect all the primary bases, so we can check whether methods override
2296 // a method from the base.
Anders Carlsson94464812010-04-10 19:13:06 +00002297 VTableBuilder::PrimaryBasesSetVectorTy PrimaryBases;
Anders Carlssonbdb4a9d2010-11-24 23:04:03 +00002298 CollectPrimaryBases(RD, CGM.getContext(), PrimaryBases);
Eli Friedmanea5ae312009-12-15 03:31:17 +00002299
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002300 const CXXDestructorDecl *ImplicitVirtualDtor = 0;
2301
2302 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
2303 e = RD->method_end(); i != e; ++i) {
2304 const CXXMethodDecl *MD = *i;
2305
2306 // We only want virtual methods.
2307 if (!MD->isVirtual())
2308 continue;
2309
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002310 // Check if this method overrides a method in the primary base.
Anders Carlsson57071e22010-02-12 05:25:12 +00002311 if (const CXXMethodDecl *OverriddenMD =
Anders Carlssonf622b452010-04-10 20:39:29 +00002312 FindNearestOverriddenMethod(MD, PrimaryBases)) {
Anders Carlsson57071e22010-02-12 05:25:12 +00002313 // Check if converting from the return type of the method to the
2314 // return type of the overridden method requires conversion.
Anders Carlssondf31af12010-02-13 23:17:31 +00002315 if (ComputeReturnAdjustmentBaseOffset(CGM.getContext(), MD,
2316 OverriddenMD).isEmpty()) {
Anders Carlsson57071e22010-02-12 05:25:12 +00002317 // This index is shared between the index in the vtable of the primary
2318 // base class.
2319 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2320 const CXXDestructorDecl *OverriddenDD =
2321 cast<CXXDestructorDecl>(OverriddenMD);
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002322
Anders Carlsson57071e22010-02-12 05:25:12 +00002323 // Add both the complete and deleting entries.
Anders Carlsson046c2942010-04-17 20:15:18 +00002324 MethodVTableIndices[GlobalDecl(DD, Dtor_Complete)] =
2325 getMethodVTableIndex(GlobalDecl(OverriddenDD, Dtor_Complete));
2326 MethodVTableIndices[GlobalDecl(DD, Dtor_Deleting)] =
2327 getMethodVTableIndex(GlobalDecl(OverriddenDD, Dtor_Deleting));
Anders Carlsson57071e22010-02-12 05:25:12 +00002328 } else {
Anders Carlsson046c2942010-04-17 20:15:18 +00002329 MethodVTableIndices[MD] = getMethodVTableIndex(OverriddenMD);
Anders Carlsson57071e22010-02-12 05:25:12 +00002330 }
2331
2332 // We don't need to add an entry for this method.
Anders Carlssonc1eec892010-02-12 18:14:46 +00002333 continue;
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002334 }
2335 }
2336
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002337 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2338 if (MD->isImplicit()) {
2339 assert(!ImplicitVirtualDtor &&
2340 "Did already see an implicit virtual dtor!");
2341 ImplicitVirtualDtor = DD;
2342 continue;
2343 }
Tilmann Schellerca0df922011-03-02 20:40:50 +00002344
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002345 // Add the complete dtor.
Anders Carlsson046c2942010-04-17 20:15:18 +00002346 MethodVTableIndices[GlobalDecl(DD, Dtor_Complete)] = CurrentIndex++;
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002347
2348 // Add the deleting dtor.
Anders Carlsson046c2942010-04-17 20:15:18 +00002349 MethodVTableIndices[GlobalDecl(DD, Dtor_Deleting)] = CurrentIndex++;
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002350 } else {
2351 // Add the entry.
Tilmann Schellerca0df922011-03-02 20:40:50 +00002352 MethodVTableIndices[MD] = CurrentIndex++;
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002353 }
2354 }
2355
2356 if (ImplicitVirtualDtor) {
2357 // Itanium C++ ABI 2.5.2:
Anders Carlssona661a542010-02-16 04:49:44 +00002358 // If a class has an implicitly-defined virtual destructor,
2359 // its entries come after the declared virtual function pointers.
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002360
2361 // Add the complete dtor.
Anders Carlsson046c2942010-04-17 20:15:18 +00002362 MethodVTableIndices[GlobalDecl(ImplicitVirtualDtor, Dtor_Complete)] =
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002363 CurrentIndex++;
2364
2365 // Add the deleting dtor.
Anders Carlsson046c2942010-04-17 20:15:18 +00002366 MethodVTableIndices[GlobalDecl(ImplicitVirtualDtor, Dtor_Deleting)] =
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002367 CurrentIndex++;
2368 }
2369
2370 NumVirtualFunctionPointers[RD] = CurrentIndex;
2371}
2372
Argyrios Kyrtzidisd2c47bd2010-10-11 03:25:57 +00002373bool CodeGenVTables::ShouldEmitVTableInThisTU(const CXXRecordDecl *RD) {
2374 assert(RD->isDynamicClass() && "Non dynamic classes have no VTable.");
2375
2376 TemplateSpecializationKind TSK = RD->getTemplateSpecializationKind();
2377 if (TSK == TSK_ExplicitInstantiationDeclaration)
2378 return false;
2379
2380 const CXXMethodDecl *KeyFunction = CGM.getContext().getKeyFunction(RD);
2381 if (!KeyFunction)
2382 return true;
2383
2384 // Itanium C++ ABI, 5.2.6 Instantiated Templates:
2385 // An instantiation of a class template requires:
2386 // - In the object where instantiated, the virtual table...
2387 if (TSK == TSK_ImplicitInstantiation ||
2388 TSK == TSK_ExplicitInstantiationDefinition)
2389 return true;
2390
Anders Carlsson6d7f8472011-01-30 20:45:54 +00002391 // If we're building with optimization, we always emit VTables since that
2392 // allows for virtual function calls to be devirtualized.
2393 // (We don't want to do this in -fapple-kext mode however).
2394 if (CGM.getCodeGenOpts().OptimizationLevel && !CGM.getLangOptions().AppleKext)
2395 return true;
2396
Argyrios Kyrtzidisd2c47bd2010-10-11 03:25:57 +00002397 return KeyFunction->hasBody();
2398}
2399
Anders Carlssonaf440352010-03-23 04:11:45 +00002400uint64_t CodeGenVTables::getNumVirtualFunctionPointers(const CXXRecordDecl *RD) {
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002401 llvm::DenseMap<const CXXRecordDecl *, uint64_t>::iterator I =
2402 NumVirtualFunctionPointers.find(RD);
2403 if (I != NumVirtualFunctionPointers.end())
2404 return I->second;
2405
Anders Carlsson046c2942010-04-17 20:15:18 +00002406 ComputeMethodVTableIndices(RD);
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002407
2408 I = NumVirtualFunctionPointers.find(RD);
2409 assert(I != NumVirtualFunctionPointers.end() && "Did not find entry!");
2410 return I->second;
2411}
2412
Anders Carlsson046c2942010-04-17 20:15:18 +00002413uint64_t CodeGenVTables::getMethodVTableIndex(GlobalDecl GD) {
2414 MethodVTableIndicesTy::iterator I = MethodVTableIndices.find(GD);
2415 if (I != MethodVTableIndices.end())
Anders Carlssondbd920c2009-10-11 22:13:54 +00002416 return I->second;
2417
Anders Carlssona0fdd912009-11-13 17:08:56 +00002418 const CXXRecordDecl *RD = cast<CXXMethodDecl>(GD.getDecl())->getParent();
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002419
Anders Carlsson046c2942010-04-17 20:15:18 +00002420 ComputeMethodVTableIndices(RD);
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002421
Anders Carlsson046c2942010-04-17 20:15:18 +00002422 I = MethodVTableIndices.find(GD);
2423 assert(I != MethodVTableIndices.end() && "Did not find index!");
Anders Carlssondbd920c2009-10-11 22:13:54 +00002424 return I->second;
2425}
2426
Anders Carlssonaf440352010-03-23 04:11:45 +00002427int64_t CodeGenVTables::getVirtualBaseOffsetOffset(const CXXRecordDecl *RD,
2428 const CXXRecordDecl *VBase) {
Anders Carlssondbd920c2009-10-11 22:13:54 +00002429 ClassPairTy ClassPair(RD, VBase);
2430
Anders Carlssonbba16072010-03-11 07:15:17 +00002431 VirtualBaseClassOffsetOffsetsMapTy::iterator I =
2432 VirtualBaseClassOffsetOffsets.find(ClassPair);
2433 if (I != VirtualBaseClassOffsetOffsets.end())
Anders Carlssondbd920c2009-10-11 22:13:54 +00002434 return I->second;
2435
Anders Carlssonc89a7cf2010-03-11 16:06:20 +00002436 VCallAndVBaseOffsetBuilder Builder(RD, RD, /*FinalOverriders=*/0,
Ken Dyck4230d522011-03-24 01:21:01 +00002437 BaseSubobject(RD, CharUnits::Zero()),
Anders Carlssonc89a7cf2010-03-11 16:06:20 +00002438 /*BaseIsVirtual=*/false,
2439 /*OffsetInLayoutClass=*/0);
Anders Carlssonc89a7cf2010-03-11 16:06:20 +00002440
2441 for (VCallAndVBaseOffsetBuilder::VBaseOffsetOffsetsMapTy::const_iterator I =
2442 Builder.getVBaseOffsetOffsets().begin(),
2443 E = Builder.getVBaseOffsetOffsets().end(); I != E; ++I) {
Anders Carlssondbd920c2009-10-11 22:13:54 +00002444 // Insert all types.
2445 ClassPairTy ClassPair(RD, I->first);
2446
Anders Carlssonbba16072010-03-11 07:15:17 +00002447 VirtualBaseClassOffsetOffsets.insert(std::make_pair(ClassPair, I->second));
Anders Carlssondbd920c2009-10-11 22:13:54 +00002448 }
2449
Anders Carlssonbba16072010-03-11 07:15:17 +00002450 I = VirtualBaseClassOffsetOffsets.find(ClassPair);
Anders Carlssonbba16072010-03-11 07:15:17 +00002451 assert(I != VirtualBaseClassOffsetOffsets.end() && "Did not find index!");
Anders Carlssondbd920c2009-10-11 22:13:54 +00002452
2453 return I->second;
2454}
2455
Anders Carlsson64c9eca2010-03-29 02:08:26 +00002456uint64_t
2457CodeGenVTables::getAddressPoint(BaseSubobject Base, const CXXRecordDecl *RD) {
Anders Carlssonec9c2022010-04-08 16:18:36 +00002458 assert(AddressPoints.count(std::make_pair(RD, Base)) &&
2459 "Did not find address point!");
2460
Anders Carlssona7cde3b2010-03-29 03:38:52 +00002461 uint64_t AddressPoint = AddressPoints.lookup(std::make_pair(RD, Base));
Anders Carlsson64c9eca2010-03-29 02:08:26 +00002462 assert(AddressPoint && "Address point must not be zero!");
Anders Carlssona7cde3b2010-03-29 03:38:52 +00002463
Anders Carlsson64c9eca2010-03-29 02:08:26 +00002464 return AddressPoint;
2465}
2466
Anders Carlsson19879c92010-03-23 17:17:29 +00002467llvm::Constant *CodeGenModule::GetAddrOfThunk(GlobalDecl GD,
Anders Carlsson84c49e42011-02-06 17:15:43 +00002468 const ThunkInfo &Thunk) {
Anders Carlsson19879c92010-03-23 17:17:29 +00002469 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2470
2471 // Compute the mangled name.
2472 llvm::SmallString<256> Name;
Rafael Espindolaf0be9792011-02-11 02:52:17 +00002473 llvm::raw_svector_ostream Out(Name);
Anders Carlsson19879c92010-03-23 17:17:29 +00002474 if (const CXXDestructorDecl* DD = dyn_cast<CXXDestructorDecl>(MD))
John McCall4c40d982010-08-31 07:33:07 +00002475 getCXXABI().getMangleContext().mangleCXXDtorThunk(DD, GD.getDtorType(),
Rafael Espindolaf0be9792011-02-11 02:52:17 +00002476 Thunk.This, Out);
Anders Carlsson19879c92010-03-23 17:17:29 +00002477 else
Rafael Espindolaf0be9792011-02-11 02:52:17 +00002478 getCXXABI().getMangleContext().mangleThunk(MD, Thunk, Out);
2479 Out.flush();
2480
John McCall4c40d982010-08-31 07:33:07 +00002481 const llvm::Type *Ty = getTypes().GetFunctionTypeForVTable(GD);
Anders Carlsson84c49e42011-02-06 17:15:43 +00002482 return GetOrCreateLLVMFunction(Name, Ty, GD, /*ForVTable=*/true);
Anders Carlsson19879c92010-03-23 17:17:29 +00002483}
2484
Anders Carlsson519c3282010-03-24 00:39:18 +00002485static llvm::Value *PerformTypeAdjustment(CodeGenFunction &CGF,
2486 llvm::Value *Ptr,
2487 int64_t NonVirtualAdjustment,
2488 int64_t VirtualAdjustment) {
2489 if (!NonVirtualAdjustment && !VirtualAdjustment)
2490 return Ptr;
2491
2492 const llvm::Type *Int8PtrTy =
2493 llvm::Type::getInt8PtrTy(CGF.getLLVMContext());
2494
2495 llvm::Value *V = CGF.Builder.CreateBitCast(Ptr, Int8PtrTy);
2496
2497 if (NonVirtualAdjustment) {
2498 // Do the non-virtual adjustment.
2499 V = CGF.Builder.CreateConstInBoundsGEP1_64(V, NonVirtualAdjustment);
2500 }
2501
2502 if (VirtualAdjustment) {
2503 const llvm::Type *PtrDiffTy =
2504 CGF.ConvertType(CGF.getContext().getPointerDiffType());
2505
2506 // Do the virtual adjustment.
2507 llvm::Value *VTablePtrPtr =
2508 CGF.Builder.CreateBitCast(V, Int8PtrTy->getPointerTo());
2509
2510 llvm::Value *VTablePtr = CGF.Builder.CreateLoad(VTablePtrPtr);
2511
2512 llvm::Value *OffsetPtr =
2513 CGF.Builder.CreateConstInBoundsGEP1_64(VTablePtr, VirtualAdjustment);
2514
2515 OffsetPtr = CGF.Builder.CreateBitCast(OffsetPtr, PtrDiffTy->getPointerTo());
2516
2517 // Load the adjustment offset from the vtable.
2518 llvm::Value *Offset = CGF.Builder.CreateLoad(OffsetPtr);
2519
2520 // Adjust our pointer.
2521 V = CGF.Builder.CreateInBoundsGEP(V, Offset);
2522 }
2523
2524 // Cast back to the original type.
2525 return CGF.Builder.CreateBitCast(V, Ptr->getType());
2526}
2527
John McCall65005532010-08-04 23:46:35 +00002528static void setThunkVisibility(CodeGenModule &CGM, const CXXMethodDecl *MD,
2529 const ThunkInfo &Thunk, llvm::Function *Fn) {
Anders Carlsson0ffeaad2011-01-29 19:39:23 +00002530 CGM.setGlobalVisibility(Fn, MD);
John McCall65005532010-08-04 23:46:35 +00002531
John McCall279b5eb2010-08-12 23:36:15 +00002532 if (!CGM.getCodeGenOpts().HiddenWeakVTables)
2533 return;
2534
John McCall65005532010-08-04 23:46:35 +00002535 // If the thunk has weak/linkonce linkage, but the function must be
2536 // emitted in every translation unit that references it, then we can
2537 // emit its thunks with hidden visibility, since its thunks must be
2538 // emitted when the function is.
2539
John McCall7a536902010-08-05 20:39:18 +00002540 // This follows CodeGenModule::setTypeVisibility; see the comments
2541 // there for explanation.
John McCall65005532010-08-04 23:46:35 +00002542
2543 if ((Fn->getLinkage() != llvm::GlobalVariable::LinkOnceODRLinkage &&
2544 Fn->getLinkage() != llvm::GlobalVariable::WeakODRLinkage) ||
2545 Fn->getVisibility() != llvm::GlobalVariable::DefaultVisibility)
2546 return;
2547
Douglas Gregor4421d2b2011-03-26 12:10:19 +00002548 if (MD->getExplicitVisibility())
John McCall65005532010-08-04 23:46:35 +00002549 return;
2550
2551 switch (MD->getTemplateSpecializationKind()) {
John McCall65005532010-08-04 23:46:35 +00002552 case TSK_ExplicitInstantiationDefinition:
2553 case TSK_ExplicitInstantiationDeclaration:
2554 return;
2555
John McCall65005532010-08-04 23:46:35 +00002556 case TSK_Undeclared:
2557 break;
2558
John McCall7a536902010-08-05 20:39:18 +00002559 case TSK_ExplicitSpecialization:
John McCall65005532010-08-04 23:46:35 +00002560 case TSK_ImplicitInstantiation:
John McCall279b5eb2010-08-12 23:36:15 +00002561 if (!CGM.getCodeGenOpts().HiddenWeakTemplateVTables)
John McCall7a536902010-08-05 20:39:18 +00002562 return;
John McCall65005532010-08-04 23:46:35 +00002563 break;
2564 }
2565
2566 // If there's an explicit definition, and that definition is
2567 // out-of-line, then we can't assume that all users will have a
2568 // definition to emit.
2569 const FunctionDecl *Def = 0;
2570 if (MD->hasBody(Def) && Def->isOutOfLine())
2571 return;
2572
2573 Fn->setVisibility(llvm::GlobalValue::HiddenVisibility);
2574}
2575
John McCall311b4422011-03-09 07:12:35 +00002576#ifndef NDEBUG
2577static bool similar(const ABIArgInfo &infoL, CanQualType typeL,
2578 const ABIArgInfo &infoR, CanQualType typeR) {
2579 return (infoL.getKind() == infoR.getKind() &&
2580 (typeL == typeR ||
2581 (isa<PointerType>(typeL) && isa<PointerType>(typeR)) ||
2582 (isa<ReferenceType>(typeL) && isa<ReferenceType>(typeR))));
2583}
2584#endif
2585
John McCalld26bc762011-03-09 04:27:21 +00002586void CodeGenFunction::GenerateThunk(llvm::Function *Fn,
2587 const CGFunctionInfo &FnInfo,
2588 GlobalDecl GD, const ThunkInfo &Thunk) {
Anders Carlsson519c3282010-03-24 00:39:18 +00002589 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2590 const FunctionProtoType *FPT = MD->getType()->getAs<FunctionProtoType>();
2591 QualType ResultType = FPT->getResultType();
2592 QualType ThisType = MD->getThisType(getContext());
2593
2594 FunctionArgList FunctionArgs;
2595
2596 // FIXME: It would be nice if more of this code could be shared with
2597 // CodeGenFunction::GenerateCode.
2598
2599 // Create the implicit 'this' parameter declaration.
John McCall4c40d982010-08-31 07:33:07 +00002600 CurGD = GD;
2601 CGM.getCXXABI().BuildInstanceFunctionParams(*this, ResultType, FunctionArgs);
Anders Carlsson519c3282010-03-24 00:39:18 +00002602
2603 // Add the rest of the parameters.
2604 for (FunctionDecl::param_const_iterator I = MD->param_begin(),
2605 E = MD->param_end(); I != E; ++I) {
2606 ParmVarDecl *Param = *I;
2607
John McCalld26bc762011-03-09 04:27:21 +00002608 FunctionArgs.push_back(Param);
Anders Carlsson519c3282010-03-24 00:39:18 +00002609 }
Tilmann Scheller9c6082f2011-03-02 21:36:49 +00002610
John McCalld26bc762011-03-09 04:27:21 +00002611 StartFunction(GlobalDecl(), ResultType, Fn, FnInfo, FunctionArgs,
2612 SourceLocation());
Anders Carlsson519c3282010-03-24 00:39:18 +00002613
John McCall4c40d982010-08-31 07:33:07 +00002614 CGM.getCXXABI().EmitInstanceFunctionProlog(*this);
2615
Anders Carlsson519c3282010-03-24 00:39:18 +00002616 // Adjust the 'this' pointer if necessary.
2617 llvm::Value *AdjustedThisPtr =
2618 PerformTypeAdjustment(*this, LoadCXXThis(),
2619 Thunk.This.NonVirtual,
2620 Thunk.This.VCallOffsetOffset);
2621
2622 CallArgList CallArgs;
2623
2624 // Add our adjusted 'this' pointer.
2625 CallArgs.push_back(std::make_pair(RValue::get(AdjustedThisPtr), ThisType));
2626
2627 // Add the rest of the parameters.
2628 for (FunctionDecl::param_const_iterator I = MD->param_begin(),
2629 E = MD->param_end(); I != E; ++I) {
John McCall413ebdb2011-03-11 20:59:21 +00002630 ParmVarDecl *param = *I;
2631 EmitDelegateCallArg(CallArgs, param);
Anders Carlsson519c3282010-03-24 00:39:18 +00002632 }
2633
2634 // Get our callee.
2635 const llvm::Type *Ty =
John McCall4c40d982010-08-31 07:33:07 +00002636 CGM.getTypes().GetFunctionType(CGM.getTypes().getFunctionInfo(GD),
Anders Carlsson519c3282010-03-24 00:39:18 +00002637 FPT->isVariadic());
Anders Carlsson84c49e42011-02-06 17:15:43 +00002638 llvm::Value *Callee = CGM.GetAddrOfFunction(GD, Ty, /*ForVTable=*/true);
Anders Carlsson519c3282010-03-24 00:39:18 +00002639
John McCalld26bc762011-03-09 04:27:21 +00002640#ifndef NDEBUG
2641 const CGFunctionInfo &CallFnInfo =
2642 CGM.getTypes().getFunctionInfo(ResultType, CallArgs, FPT->getExtInfo());
John McCall311b4422011-03-09 07:12:35 +00002643 assert(CallFnInfo.getRegParm() == FnInfo.getRegParm() &&
2644 CallFnInfo.isNoReturn() == FnInfo.isNoReturn() &&
2645 CallFnInfo.getCallingConvention() == FnInfo.getCallingConvention());
2646 assert(similar(CallFnInfo.getReturnInfo(), CallFnInfo.getReturnType(),
2647 FnInfo.getReturnInfo(), FnInfo.getReturnType()));
2648 assert(CallFnInfo.arg_size() == FnInfo.arg_size());
2649 for (unsigned i = 0, e = FnInfo.arg_size(); i != e; ++i)
2650 assert(similar(CallFnInfo.arg_begin()[i].info,
2651 CallFnInfo.arg_begin()[i].type,
2652 FnInfo.arg_begin()[i].info, FnInfo.arg_begin()[i].type));
John McCalld26bc762011-03-09 04:27:21 +00002653#endif
Anders Carlsson519c3282010-03-24 00:39:18 +00002654
Douglas Gregorcb359df2010-05-20 05:54:35 +00002655 // Determine whether we have a return value slot to use.
2656 ReturnValueSlot Slot;
2657 if (!ResultType->isVoidType() &&
2658 FnInfo.getReturnInfo().getKind() == ABIArgInfo::Indirect &&
2659 hasAggregateLLVMType(CurFnInfo->getReturnType()))
2660 Slot = ReturnValueSlot(ReturnValue, ResultType.isVolatileQualified());
2661
Anders Carlsson519c3282010-03-24 00:39:18 +00002662 // Now emit our call.
Douglas Gregorcb359df2010-05-20 05:54:35 +00002663 RValue RV = EmitCall(FnInfo, Callee, Slot, CallArgs, MD);
Anders Carlsson519c3282010-03-24 00:39:18 +00002664
2665 if (!Thunk.Return.isEmpty()) {
2666 // Emit the return adjustment.
2667 bool NullCheckValue = !ResultType->isReferenceType();
2668
2669 llvm::BasicBlock *AdjustNull = 0;
2670 llvm::BasicBlock *AdjustNotNull = 0;
2671 llvm::BasicBlock *AdjustEnd = 0;
2672
2673 llvm::Value *ReturnValue = RV.getScalarVal();
2674
2675 if (NullCheckValue) {
2676 AdjustNull = createBasicBlock("adjust.null");
2677 AdjustNotNull = createBasicBlock("adjust.notnull");
2678 AdjustEnd = createBasicBlock("adjust.end");
2679
2680 llvm::Value *IsNull = Builder.CreateIsNull(ReturnValue);
2681 Builder.CreateCondBr(IsNull, AdjustNull, AdjustNotNull);
2682 EmitBlock(AdjustNotNull);
2683 }
2684
2685 ReturnValue = PerformTypeAdjustment(*this, ReturnValue,
2686 Thunk.Return.NonVirtual,
2687 Thunk.Return.VBaseOffsetOffset);
2688
2689 if (NullCheckValue) {
2690 Builder.CreateBr(AdjustEnd);
2691 EmitBlock(AdjustNull);
2692 Builder.CreateBr(AdjustEnd);
2693 EmitBlock(AdjustEnd);
2694
2695 llvm::PHINode *PHI = Builder.CreatePHI(ReturnValue->getType());
2696 PHI->reserveOperandSpace(2);
2697 PHI->addIncoming(ReturnValue, AdjustNotNull);
2698 PHI->addIncoming(llvm::Constant::getNullValue(ReturnValue->getType()),
2699 AdjustNull);
2700 ReturnValue = PHI;
2701 }
2702
2703 RV = RValue::get(ReturnValue);
2704 }
2705
Douglas Gregorcb359df2010-05-20 05:54:35 +00002706 if (!ResultType->isVoidType() && Slot.isNull())
John McCalld16c2cf2011-02-08 08:22:06 +00002707 CGM.getCXXABI().EmitReturnFromThunk(*this, RV, ResultType);
Anders Carlsson519c3282010-03-24 00:39:18 +00002708
2709 FinishFunction();
2710
Anders Carlsson519c3282010-03-24 00:39:18 +00002711 // Set the right linkage.
John McCall8b242332010-05-25 04:30:21 +00002712 CGM.setFunctionLinkage(MD, Fn);
Anders Carlsson519c3282010-03-24 00:39:18 +00002713
2714 // Set the right visibility.
John McCall65005532010-08-04 23:46:35 +00002715 setThunkVisibility(CGM, MD, Thunk, Fn);
Anders Carlsson519c3282010-03-24 00:39:18 +00002716}
2717
Anders Carlsson14e82fd2011-02-06 18:31:40 +00002718void CodeGenVTables::EmitThunk(GlobalDecl GD, const ThunkInfo &Thunk,
2719 bool UseAvailableExternallyLinkage)
Anders Carlssonfbf6ed42010-03-23 16:36:50 +00002720{
John McCalld26bc762011-03-09 04:27:21 +00002721 const CGFunctionInfo &FnInfo = CGM.getTypes().getFunctionInfo(GD);
2722
2723 // FIXME: re-use FnInfo in this computation.
Anders Carlsson84c49e42011-02-06 17:15:43 +00002724 llvm::Constant *Entry = CGM.GetAddrOfThunk(GD, Thunk);
Anders Carlsson19879c92010-03-23 17:17:29 +00002725
Anders Carlsson7986ad52010-03-23 18:18:41 +00002726 // Strip off a bitcast if we got one back.
Anders Carlsson13d68982010-03-24 00:35:44 +00002727 if (llvm::ConstantExpr *CE = dyn_cast<llvm::ConstantExpr>(Entry)) {
Anders Carlsson7986ad52010-03-23 18:18:41 +00002728 assert(CE->getOpcode() == llvm::Instruction::BitCast);
Anders Carlsson13d68982010-03-24 00:35:44 +00002729 Entry = CE->getOperand(0);
Anders Carlsson7986ad52010-03-23 18:18:41 +00002730 }
2731
Anders Carlsson7986ad52010-03-23 18:18:41 +00002732 // There's already a declaration with the same name, check if it has the same
2733 // type or if we need to replace it.
Anders Carlsson13d68982010-03-24 00:35:44 +00002734 if (cast<llvm::GlobalValue>(Entry)->getType()->getElementType() !=
John McCall4c40d982010-08-31 07:33:07 +00002735 CGM.getTypes().GetFunctionTypeForVTable(GD)) {
Anders Carlsson13d68982010-03-24 00:35:44 +00002736 llvm::GlobalValue *OldThunkFn = cast<llvm::GlobalValue>(Entry);
Anders Carlsson7986ad52010-03-23 18:18:41 +00002737
2738 // If the types mismatch then we have to rewrite the definition.
2739 assert(OldThunkFn->isDeclaration() &&
2740 "Shouldn't replace non-declaration");
2741
2742 // Remove the name from the old thunk function and get a new thunk.
2743 OldThunkFn->setName(llvm::StringRef());
Anders Carlsson84c49e42011-02-06 17:15:43 +00002744 Entry = CGM.GetAddrOfThunk(GD, Thunk);
Anders Carlsson7986ad52010-03-23 18:18:41 +00002745
2746 // If needed, replace the old thunk with a bitcast.
2747 if (!OldThunkFn->use_empty()) {
2748 llvm::Constant *NewPtrForOldDecl =
Anders Carlsson13d68982010-03-24 00:35:44 +00002749 llvm::ConstantExpr::getBitCast(Entry, OldThunkFn->getType());
Anders Carlsson7986ad52010-03-23 18:18:41 +00002750 OldThunkFn->replaceAllUsesWith(NewPtrForOldDecl);
2751 }
2752
2753 // Remove the old thunk.
2754 OldThunkFn->eraseFromParent();
2755 }
Anders Carlsson519c3282010-03-24 00:39:18 +00002756
Anders Carlsson519c3282010-03-24 00:39:18 +00002757 llvm::Function *ThunkFn = cast<llvm::Function>(Entry);
Anders Carlsson14e82fd2011-02-06 18:31:40 +00002758
2759 if (!ThunkFn->isDeclaration()) {
2760 if (UseAvailableExternallyLinkage) {
2761 // There is already a thunk emitted for this function, do nothing.
2762 return;
2763 }
2764
Anders Carlsson22df7b12011-02-06 20:09:44 +00002765 // If a function has a body, it should have available_externally linkage.
2766 assert(ThunkFn->hasAvailableExternallyLinkage() &&
2767 "Function should have available_externally linkage!");
2768
2769 // Change the linkage.
2770 CGM.setFunctionLinkage(cast<CXXMethodDecl>(GD.getDecl()), ThunkFn);
2771 return;
Anders Carlsson14e82fd2011-02-06 18:31:40 +00002772 }
2773
2774 // Actually generate the thunk body.
John McCalld26bc762011-03-09 04:27:21 +00002775 CodeGenFunction(CGM).GenerateThunk(ThunkFn, FnInfo, GD, Thunk);
Anders Carlsson14e82fd2011-02-06 18:31:40 +00002776
2777 if (UseAvailableExternallyLinkage)
2778 ThunkFn->setLinkage(llvm::GlobalValue::AvailableExternallyLinkage);
2779}
2780
2781void CodeGenVTables::MaybeEmitThunkAvailableExternally(GlobalDecl GD,
2782 const ThunkInfo &Thunk) {
2783 // We only want to do this when building with optimizations.
2784 if (!CGM.getCodeGenOpts().OptimizationLevel)
2785 return;
2786
2787 // We can't emit thunks for member functions with incomplete types.
2788 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2789 if (CGM.getTypes().VerifyFuncTypeComplete(MD->getType().getTypePtr()))
2790 return;
2791
2792 EmitThunk(GD, Thunk, /*UseAvailableExternallyLinkage=*/true);
Anders Carlssonfbf6ed42010-03-23 16:36:50 +00002793}
2794
Anders Carlssonee5ab9f2010-03-23 04:59:02 +00002795void CodeGenVTables::EmitThunks(GlobalDecl GD)
2796{
Anders Carlssonfbf6ed42010-03-23 16:36:50 +00002797 const CXXMethodDecl *MD =
2798 cast<CXXMethodDecl>(GD.getDecl())->getCanonicalDecl();
2799
2800 // We don't need to generate thunks for the base destructor.
2801 if (isa<CXXDestructorDecl>(MD) && GD.getDtorType() == Dtor_Base)
2802 return;
2803
2804 const CXXRecordDecl *RD = MD->getParent();
2805
Anders Carlssonccd83d72010-03-24 16:42:11 +00002806 // Compute VTable related info for this class.
John McCalle2132352010-06-02 21:22:02 +00002807 ComputeVTableRelatedInformation(RD, false);
Anders Carlssonccd83d72010-03-24 16:42:11 +00002808
Anders Carlssonfbf6ed42010-03-23 16:36:50 +00002809 ThunksMapTy::const_iterator I = Thunks.find(MD);
2810 if (I == Thunks.end()) {
Anders Carlssonccd83d72010-03-24 16:42:11 +00002811 // We did not find a thunk for this method.
2812 return;
Anders Carlssonfbf6ed42010-03-23 16:36:50 +00002813 }
Anders Carlssonccd83d72010-03-24 16:42:11 +00002814
Anders Carlssonfbf6ed42010-03-23 16:36:50 +00002815 const ThunkInfoVectorTy &ThunkInfoVector = I->second;
2816 for (unsigned I = 0, E = ThunkInfoVector.size(); I != E; ++I)
Anders Carlsson14e82fd2011-02-06 18:31:40 +00002817 EmitThunk(GD, ThunkInfoVector[I], /*UseAvailableExternallyLinkage=*/false);
Anders Carlssonee5ab9f2010-03-23 04:59:02 +00002818}
2819
John McCalle2132352010-06-02 21:22:02 +00002820void CodeGenVTables::ComputeVTableRelatedInformation(const CXXRecordDecl *RD,
2821 bool RequireVTable) {
2822 VTableLayoutData &Entry = VTableLayoutMap[RD];
Douglas Gregor6fb745b2010-05-13 16:44:06 +00002823
2824 // We may need to generate a definition for this vtable.
John McCalle2132352010-06-02 21:22:02 +00002825 if (RequireVTable && !Entry.getInt()) {
Argyrios Kyrtzidisd2c47bd2010-10-11 03:25:57 +00002826 if (ShouldEmitVTableInThisTU(RD))
John McCalle2132352010-06-02 21:22:02 +00002827 CGM.DeferredVTables.push_back(RD);
2828
2829 Entry.setInt(true);
2830 }
2831
2832 // Check if we've computed this information before.
2833 if (Entry.getPointer())
2834 return;
Douglas Gregor6fb745b2010-05-13 16:44:06 +00002835
Anders Carlsson94464812010-04-10 19:13:06 +00002836 VTableBuilder Builder(*this, RD, 0, /*MostDerivedClassIsVirtual=*/0, RD);
Anders Carlssonccd83d72010-03-24 16:42:11 +00002837
2838 // Add the VTable layout.
2839 uint64_t NumVTableComponents = Builder.getNumVTableComponents();
Fariborz Jahaniana50e33e2011-01-28 23:42:29 +00002840 // -fapple-kext adds an extra entry at end of vtbl.
2841 bool IsAppleKext = CGM.getContext().getLangOptions().AppleKext;
2842 if (IsAppleKext)
2843 NumVTableComponents += 1;
2844
John McCalle2132352010-06-02 21:22:02 +00002845 uint64_t *LayoutData = new uint64_t[NumVTableComponents + 1];
Fariborz Jahaniana50e33e2011-01-28 23:42:29 +00002846 if (IsAppleKext)
2847 LayoutData[NumVTableComponents] = 0;
John McCalle2132352010-06-02 21:22:02 +00002848 Entry.setPointer(LayoutData);
Anders Carlssonccd83d72010-03-24 16:42:11 +00002849
2850 // Store the number of components.
2851 LayoutData[0] = NumVTableComponents;
2852
2853 // Store the components.
2854 std::copy(Builder.vtable_components_data_begin(),
2855 Builder.vtable_components_data_end(),
2856 &LayoutData[1]);
2857
2858 // Add the known thunks.
2859 Thunks.insert(Builder.thunks_begin(), Builder.thunks_end());
2860
Anders Carlsson276701f2010-03-29 01:38:05 +00002861 // Add the thunks needed in this vtable.
2862 assert(!VTableThunksMap.count(RD) &&
2863 "Thunks already exists for this vtable!");
2864
2865 VTableThunksTy &VTableThunks = VTableThunksMap[RD];
2866 VTableThunks.append(Builder.vtable_thunks_begin(),
2867 Builder.vtable_thunks_end());
2868
2869 // Sort them.
2870 std::sort(VTableThunks.begin(), VTableThunks.end());
2871
Anders Carlsson66d567d2010-03-25 00:51:13 +00002872 // Add the address points.
Anders Carlsson94464812010-04-10 19:13:06 +00002873 for (VTableBuilder::AddressPointsMapTy::const_iterator I =
Anders Carlsson66d567d2010-03-25 00:51:13 +00002874 Builder.address_points_begin(), E = Builder.address_points_end();
2875 I != E; ++I) {
2876
2877 uint64_t &AddressPoint = AddressPoints[std::make_pair(RD, I->first)];
2878
2879 // Check if we already have the address points for this base.
2880 assert(!AddressPoint && "Address point already exists for this base!");
2881
2882 AddressPoint = I->second;
2883 }
2884
Anders Carlssonccd83d72010-03-24 16:42:11 +00002885 // If we don't have the vbase information for this class, insert it.
2886 // getVirtualBaseOffsetOffset will compute it separately without computing
2887 // the rest of the vtable related information.
2888 if (!RD->getNumVBases())
2889 return;
2890
2891 const RecordType *VBaseRT =
2892 RD->vbases_begin()->getType()->getAs<RecordType>();
2893 const CXXRecordDecl *VBase = cast<CXXRecordDecl>(VBaseRT->getDecl());
2894
2895 if (VirtualBaseClassOffsetOffsets.count(std::make_pair(RD, VBase)))
2896 return;
2897
Anders Carlsson94464812010-04-10 19:13:06 +00002898 for (VTableBuilder::VBaseOffsetOffsetsMapTy::const_iterator I =
Anders Carlssonccd83d72010-03-24 16:42:11 +00002899 Builder.getVBaseOffsetOffsets().begin(),
2900 E = Builder.getVBaseOffsetOffsets().end(); I != E; ++I) {
2901 // Insert all types.
2902 ClassPairTy ClassPair(RD, I->first);
2903
2904 VirtualBaseClassOffsetOffsets.insert(std::make_pair(ClassPair, I->second));
2905 }
2906}
2907
Anders Carlsson0d1407e2010-03-25 15:26:28 +00002908llvm::Constant *
2909CodeGenVTables::CreateVTableInitializer(const CXXRecordDecl *RD,
2910 const uint64_t *Components,
2911 unsigned NumComponents,
2912 const VTableThunksTy &VTableThunks) {
2913 llvm::SmallVector<llvm::Constant *, 64> Inits;
2914
2915 const llvm::Type *Int8PtrTy = llvm::Type::getInt8PtrTy(CGM.getLLVMContext());
2916
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002917 const llvm::Type *PtrDiffTy =
2918 CGM.getTypes().ConvertType(CGM.getContext().getPointerDiffType());
2919
2920 QualType ClassType = CGM.getContext().getTagDeclType(RD);
2921 llvm::Constant *RTTI = CGM.GetAddrOfRTTIDescriptor(ClassType);
2922
2923 unsigned NextVTableThunkIndex = 0;
2924
Anders Carlsson67d568a2010-03-29 05:40:50 +00002925 llvm::Constant* PureVirtualFn = 0;
2926
Anders Carlsson0d1407e2010-03-25 15:26:28 +00002927 for (unsigned I = 0; I != NumComponents; ++I) {
Anders Carlsson94464812010-04-10 19:13:06 +00002928 VTableComponent Component =
2929 VTableComponent::getFromOpaqueInteger(Components[I]);
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002930
2931 llvm::Constant *Init = 0;
2932
2933 switch (Component.getKind()) {
Anders Carlsson94464812010-04-10 19:13:06 +00002934 case VTableComponent::CK_VCallOffset:
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002935 Init = llvm::ConstantInt::get(PtrDiffTy, Component.getVCallOffset());
2936 Init = llvm::ConstantExpr::getIntToPtr(Init, Int8PtrTy);
2937 break;
Anders Carlsson94464812010-04-10 19:13:06 +00002938 case VTableComponent::CK_VBaseOffset:
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002939 Init = llvm::ConstantInt::get(PtrDiffTy, Component.getVBaseOffset());
2940 Init = llvm::ConstantExpr::getIntToPtr(Init, Int8PtrTy);
2941 break;
Anders Carlsson94464812010-04-10 19:13:06 +00002942 case VTableComponent::CK_OffsetToTop:
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002943 Init = llvm::ConstantInt::get(PtrDiffTy, Component.getOffsetToTop());
2944 Init = llvm::ConstantExpr::getIntToPtr(Init, Int8PtrTy);
2945 break;
Anders Carlsson94464812010-04-10 19:13:06 +00002946 case VTableComponent::CK_RTTI:
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002947 Init = llvm::ConstantExpr::getBitCast(RTTI, Int8PtrTy);
2948 break;
Anders Carlsson94464812010-04-10 19:13:06 +00002949 case VTableComponent::CK_FunctionPointer:
2950 case VTableComponent::CK_CompleteDtorPointer:
2951 case VTableComponent::CK_DeletingDtorPointer: {
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002952 GlobalDecl GD;
2953
2954 // Get the right global decl.
2955 switch (Component.getKind()) {
2956 default:
2957 llvm_unreachable("Unexpected vtable component kind");
Anders Carlsson94464812010-04-10 19:13:06 +00002958 case VTableComponent::CK_FunctionPointer:
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002959 GD = Component.getFunctionDecl();
2960 break;
Anders Carlsson94464812010-04-10 19:13:06 +00002961 case VTableComponent::CK_CompleteDtorPointer:
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002962 GD = GlobalDecl(Component.getDestructorDecl(), Dtor_Complete);
2963 break;
Anders Carlsson94464812010-04-10 19:13:06 +00002964 case VTableComponent::CK_DeletingDtorPointer:
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002965 GD = GlobalDecl(Component.getDestructorDecl(), Dtor_Deleting);
2966 break;
2967 }
2968
Anders Carlsson67d568a2010-03-29 05:40:50 +00002969 if (cast<CXXMethodDecl>(GD.getDecl())->isPure()) {
2970 // We have a pure virtual member function.
2971 if (!PureVirtualFn) {
2972 const llvm::FunctionType *Ty =
2973 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2974 /*isVarArg=*/false);
2975 PureVirtualFn =
2976 CGM.CreateRuntimeFunction(Ty, "__cxa_pure_virtual");
2977 PureVirtualFn = llvm::ConstantExpr::getBitCast(PureVirtualFn,
2978 Int8PtrTy);
2979 }
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002980
Anders Carlsson67d568a2010-03-29 05:40:50 +00002981 Init = PureVirtualFn;
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002982 } else {
Anders Carlsson67d568a2010-03-29 05:40:50 +00002983 // Check if we should use a thunk.
2984 if (NextVTableThunkIndex < VTableThunks.size() &&
2985 VTableThunks[NextVTableThunkIndex].first == I) {
2986 const ThunkInfo &Thunk = VTableThunks[NextVTableThunkIndex].second;
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002987
Anders Carlsson84c49e42011-02-06 17:15:43 +00002988 Init = CGM.GetAddrOfThunk(GD, Thunk);
Anders Carlsson14e82fd2011-02-06 18:31:40 +00002989 MaybeEmitThunkAvailableExternally(GD, Thunk);
2990
Anders Carlsson67d568a2010-03-29 05:40:50 +00002991 NextVTableThunkIndex++;
2992 } else {
John McCall4c40d982010-08-31 07:33:07 +00002993 const llvm::Type *Ty = CGM.getTypes().GetFunctionTypeForVTable(GD);
Anders Carlsson67d568a2010-03-29 05:40:50 +00002994
Anders Carlsson1faa89f2011-02-05 04:35:53 +00002995 Init = CGM.GetAddrOfFunction(GD, Ty, /*ForVTable=*/true);
Anders Carlsson67d568a2010-03-29 05:40:50 +00002996 }
2997
2998 Init = llvm::ConstantExpr::getBitCast(Init, Int8PtrTy);
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002999 }
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00003000 break;
3001 }
3002
Anders Carlsson94464812010-04-10 19:13:06 +00003003 case VTableComponent::CK_UnusedFunctionPointer:
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00003004 Init = llvm::ConstantExpr::getNullValue(Int8PtrTy);
3005 break;
3006 };
Anders Carlsson0d1407e2010-03-25 15:26:28 +00003007
3008 Inits.push_back(Init);
3009 }
3010
3011 llvm::ArrayType *ArrayType = llvm::ArrayType::get(Int8PtrTy, NumComponents);
3012 return llvm::ConstantArray::get(ArrayType, Inits.data(), Inits.size());
3013}
3014
Anders Carlsson9dc338a2010-03-30 03:35:35 +00003015llvm::GlobalVariable *CodeGenVTables::GetAddrOfVTable(const CXXRecordDecl *RD) {
Anders Carlsson5c6c1d92010-03-24 03:57:14 +00003016 llvm::SmallString<256> OutName;
Rafael Espindolaf0be9792011-02-11 02:52:17 +00003017 llvm::raw_svector_ostream Out(OutName);
3018 CGM.getCXXABI().getMangleContext().mangleCXXVTable(RD, Out);
3019 Out.flush();
Anders Carlsson5c6c1d92010-03-24 03:57:14 +00003020 llvm::StringRef Name = OutName.str();
Mike Stump85615df2009-11-19 04:04:36 +00003021
John McCalle2132352010-06-02 21:22:02 +00003022 ComputeVTableRelatedInformation(RD, true);
Anders Carlssonccd83d72010-03-24 16:42:11 +00003023
Anders Carlsson5c6c1d92010-03-24 03:57:14 +00003024 const llvm::Type *Int8PtrTy = llvm::Type::getInt8PtrTy(CGM.getLLVMContext());
Anders Carlssonccd83d72010-03-24 16:42:11 +00003025 llvm::ArrayType *ArrayType =
3026 llvm::ArrayType::get(Int8PtrTy, getNumVTableComponents(RD));
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003027
Rafael Espindola9f959db2011-01-11 21:10:26 +00003028 llvm::GlobalVariable *GV =
Anders Carlsson96eaf292011-01-29 18:25:07 +00003029 CGM.CreateOrReplaceCXXRuntimeVariable(Name, ArrayType,
3030 llvm::GlobalValue::ExternalLinkage);
Rafael Espindolacd3ac4b2011-01-15 08:23:14 +00003031 GV->setUnnamedAddr(true);
Rafael Espindola9f959db2011-01-11 21:10:26 +00003032 return GV;
Mike Stump380dd752009-11-10 07:44:33 +00003033}
Mike Stump8cfcb522009-11-11 20:26:26 +00003034
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003035void
3036CodeGenVTables::EmitVTableDefinition(llvm::GlobalVariable *VTable,
3037 llvm::GlobalVariable::LinkageTypes Linkage,
3038 const CXXRecordDecl *RD) {
3039 // Dump the vtable layout if necessary.
Anders Carlsson046c2942010-04-17 20:15:18 +00003040 if (CGM.getLangOptions().DumpVTableLayouts) {
Anders Carlsson94464812010-04-10 19:13:06 +00003041 VTableBuilder Builder(*this, RD, 0, /*MostDerivedClassIsVirtual=*/0, RD);
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003042
3043 Builder.dumpLayout(llvm::errs());
3044 }
3045
3046 assert(VTableThunksMap.count(RD) &&
3047 "No thunk status for this record decl!");
3048
3049 const VTableThunksTy& Thunks = VTableThunksMap[RD];
3050
3051 // Create and set the initializer.
3052 llvm::Constant *Init =
3053 CreateVTableInitializer(RD, getVTableComponentsData(RD),
3054 getNumVTableComponents(RD), Thunks);
3055 VTable->setInitializer(Init);
Anders Carlsson67d568a2010-03-29 05:40:50 +00003056
3057 // Set the correct linkage.
3058 VTable->setLinkage(Linkage);
Douglas Gregorc66bcfd2010-06-14 23:41:45 +00003059
3060 // Set the right visibility.
Anders Carlssonfa2e99f2011-01-29 20:24:48 +00003061 CGM.setTypeVisibility(VTable, RD, CodeGenModule::TVK_ForVTable);
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003062}
3063
Anders Carlssonff143f82010-03-25 00:35:49 +00003064llvm::GlobalVariable *
3065CodeGenVTables::GenerateConstructionVTable(const CXXRecordDecl *RD,
Anders Carlsson2c822f12010-03-26 03:56:54 +00003066 const BaseSubobject &Base,
3067 bool BaseIsVirtual,
3068 VTableAddressPointsMapTy& AddressPoints) {
Ken Dyck4230d522011-03-24 01:21:01 +00003069 VTableBuilder Builder(*this, Base.getBase(),
3070 CGM.getContext().toBits(Base.getBaseOffset()),
Anders Carlsson0d1407e2010-03-25 15:26:28 +00003071 /*MostDerivedClassIsVirtual=*/BaseIsVirtual, RD);
3072
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00003073 // Dump the vtable layout if necessary.
Anders Carlsson046c2942010-04-17 20:15:18 +00003074 if (CGM.getLangOptions().DumpVTableLayouts)
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00003075 Builder.dumpLayout(llvm::errs());
3076
3077 // Add the address points.
Anders Carlsson2c822f12010-03-26 03:56:54 +00003078 AddressPoints.insert(Builder.address_points_begin(),
3079 Builder.address_points_end());
Anders Carlsson0d1407e2010-03-25 15:26:28 +00003080
3081 // Get the mangled construction vtable name.
3082 llvm::SmallString<256> OutName;
Rafael Espindolaf0be9792011-02-11 02:52:17 +00003083 llvm::raw_svector_ostream Out(OutName);
John McCall4c40d982010-08-31 07:33:07 +00003084 CGM.getCXXABI().getMangleContext().
Ken Dyck4230d522011-03-24 01:21:01 +00003085 mangleCXXCtorVTable(RD, Base.getBaseOffset().getQuantity(), Base.getBase(),
3086 Out);
Rafael Espindolaf0be9792011-02-11 02:52:17 +00003087 Out.flush();
Anders Carlsson0d1407e2010-03-25 15:26:28 +00003088 llvm::StringRef Name = OutName.str();
3089
3090 const llvm::Type *Int8PtrTy = llvm::Type::getInt8PtrTy(CGM.getLLVMContext());
3091 llvm::ArrayType *ArrayType =
3092 llvm::ArrayType::get(Int8PtrTy, Builder.getNumVTableComponents());
3093
3094 // Create the variable that will hold the construction vtable.
3095 llvm::GlobalVariable *VTable =
Anders Carlsson96eaf292011-01-29 18:25:07 +00003096 CGM.CreateOrReplaceCXXRuntimeVariable(Name, ArrayType,
3097 llvm::GlobalValue::InternalLinkage);
Anders Carlsson0d1407e2010-03-25 15:26:28 +00003098
3099 // Add the thunks.
3100 VTableThunksTy VTableThunks;
3101 VTableThunks.append(Builder.vtable_thunks_begin(),
3102 Builder.vtable_thunks_end());
3103
Anders Carlssonaed924e2010-03-29 01:28:05 +00003104 // Sort them.
3105 std::sort(VTableThunks.begin(), VTableThunks.end());
3106
Anders Carlsson0d1407e2010-03-25 15:26:28 +00003107 // Create and set the initializer.
3108 llvm::Constant *Init =
3109 CreateVTableInitializer(Base.getBase(),
3110 Builder.vtable_components_data_begin(),
3111 Builder.getNumVTableComponents(), VTableThunks);
3112 VTable->setInitializer(Init);
3113
Anders Carlssonff143f82010-03-25 00:35:49 +00003114 return VTable;
3115}
3116
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003117void
3118CodeGenVTables::GenerateClassData(llvm::GlobalVariable::LinkageTypes Linkage,
3119 const CXXRecordDecl *RD) {
Anders Carlsson046c2942010-04-17 20:15:18 +00003120 llvm::GlobalVariable *&VTable = VTables[RD];
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003121 if (VTable) {
Anders Carlsson046c2942010-04-17 20:15:18 +00003122 assert(VTable->getInitializer() && "VTable doesn't have a definition!");
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003123 return;
3124 }
3125
Anders Carlsson9dc338a2010-03-30 03:35:35 +00003126 VTable = GetAddrOfVTable(RD);
3127 EmitVTableDefinition(VTable, Linkage, RD);
3128
Anders Carlsson1cbce122011-01-29 19:16:51 +00003129 if (RD->getNumVBases()) {
3130 llvm::GlobalVariable *VTT = GetAddrOfVTT(RD);
3131 EmitVTTDefinition(VTT, Linkage, RD);
3132 }
Douglas Gregor1e201b42010-04-08 15:52:03 +00003133
3134 // If this is the magic class __cxxabiv1::__fundamental_type_info,
3135 // we will emit the typeinfo for the fundamental types. This is the
3136 // same behaviour as GCC.
3137 const DeclContext *DC = RD->getDeclContext();
3138 if (RD->getIdentifier() &&
3139 RD->getIdentifier()->isStr("__fundamental_type_info") &&
3140 isa<NamespaceDecl>(DC) &&
3141 cast<NamespaceDecl>(DC)->getIdentifier() &&
3142 cast<NamespaceDecl>(DC)->getIdentifier()->isStr("__cxxabiv1") &&
3143 DC->getParent()->isTranslationUnit())
3144 CGM.EmitFundamentalRTTIDescriptors();
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003145}