blob: 462384f82f48c7582a6bb30f8c18660fbb535838 [file] [log] [blame]
Anders Carlsson461e3262010-04-08 16:30:25 +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"
Anders Carlssond6b07fb2009-11-27 20:47:55 +000016#include "clang/AST/CXXInheritance.h"
Anders Carlssondbd920c2009-10-11 22:13:54 +000017#include "clang/AST/RecordLayout.h"
Anders Carlsson5dd730a2009-11-26 19:32:45 +000018#include "llvm/ADT/DenseSet.h"
Anders Carlssonb9021e92010-02-27 16:18:19 +000019#include "llvm/ADT/SetVector.h"
Chandler Carruthe087f072010-02-13 10:38:52 +000020#include "llvm/Support/Compiler.h"
Anders Carlsson824d7ea2010-02-11 08:02:13 +000021#include "llvm/Support/Format.h"
Anders Carlsson5e454aa2010-03-17 20:06:32 +000022#include <algorithm>
Zhongxing Xu7fe26ac2009-11-13 05:46:16 +000023#include <cstdio>
Anders Carlssondbd920c2009-10-11 22:13:54 +000024
25using namespace clang;
26using namespace CodeGen;
27
Anders Carlsson27f69d02009-11-27 22:21:51 +000028namespace {
Anders Carlsson824d7ea2010-02-11 08:02:13 +000029
Anders Carlsson2fca9be2010-02-23 01:34:28 +000030/// BaseOffset - Represents an offset from a derived class to a direct or
31/// indirect base class.
32struct BaseOffset {
33 /// DerivedClass - The derived class.
34 const CXXRecordDecl *DerivedClass;
35
36 /// VirtualBase - If the path from the derived class to the base class
37 /// involves a virtual base class, this holds its declaration.
38 const CXXRecordDecl *VirtualBase;
39
40 /// NonVirtualOffset - The offset from the derived class to the base class.
41 /// (Or the offset from the virtual base class to the base class, if the
42 /// path from the derived class to the base class involves a virtual base
43 /// class.
44 int64_t NonVirtualOffset;
45
46 BaseOffset() : DerivedClass(0), VirtualBase(0), NonVirtualOffset(0) { }
47 BaseOffset(const CXXRecordDecl *DerivedClass,
48 const CXXRecordDecl *VirtualBase, int64_t NonVirtualOffset)
49 : DerivedClass(DerivedClass), VirtualBase(VirtualBase),
50 NonVirtualOffset(NonVirtualOffset) { }
51
52 bool isEmpty() const { return !NonVirtualOffset && !VirtualBase; }
53};
54
Anders Carlssonbdf73d82010-02-11 21:24:32 +000055/// FinalOverriders - Contains the final overrider member functions for all
56/// member functions in the base subobjects of a class.
57class FinalOverriders {
Anders Carlssona7575822010-02-12 16:55:34 +000058public:
59 /// OverriderInfo - Information about a final overrider.
60 struct OverriderInfo {
61 /// Method - The method decl of the overrider.
62 const CXXMethodDecl *Method;
Anders Carlsson96309c42010-02-18 16:29:24 +000063
Anders Carlssondb4022c2010-03-10 02:33:41 +000064 /// Offset - the base offset of the overrider in the layout class.
65 uint64_t Offset;
Anders Carlssona7575822010-02-12 16:55:34 +000066
Anders Carlssoncd0d27f2010-03-12 05:02:01 +000067 OverriderInfo() : Method(0), Offset(0) { }
Anders Carlssona7575822010-02-12 16:55:34 +000068 };
69
70private:
Anders Carlssonbdf73d82010-02-11 21:24:32 +000071 /// MostDerivedClass - The most derived class for which the final overriders
72 /// are stored.
73 const CXXRecordDecl *MostDerivedClass;
74
Anders Carlssondb4022c2010-03-10 02:33:41 +000075 /// MostDerivedClassOffset - If we're building final overriders for a
76 /// construction vtable, this holds the offset from the layout class to the
77 /// most derived class.
78 const uint64_t MostDerivedClassOffset;
79
80 /// LayoutClass - The class we're using for layout information. Will be
81 /// different than the most derived class if the final overriders are for a
82 /// construction vtable.
83 const CXXRecordDecl *LayoutClass;
84
Anders Carlssonbdf73d82010-02-11 21:24:32 +000085 ASTContext &Context;
86
87 /// MostDerivedClassLayout - the AST record layout of the most derived class.
88 const ASTRecordLayout &MostDerivedClassLayout;
89
Anders Carlsson0c0eeb22010-02-13 02:02:03 +000090 /// BaseSubobjectMethodPairTy - Uniquely identifies a member function
91 /// in a base subobject.
92 typedef std::pair<BaseSubobject, const CXXMethodDecl *>
93 BaseSubobjectMethodPairTy;
94
95 typedef llvm::DenseMap<BaseSubobjectMethodPairTy,
Anders Carlssona7575822010-02-12 16:55:34 +000096 OverriderInfo> OverridersMapTy;
Anders Carlssonbdf73d82010-02-11 21:24:32 +000097
98 /// OverridersMap - The final overriders for all virtual member functions of
99 /// all the base subobjects of the most derived class.
100 OverridersMapTy OverridersMap;
101
Anders Carlsson9d6f0d52010-02-14 00:37:35 +0000102 /// VisitedVirtualBases - A set of all the visited virtual bases, used to
103 /// avoid visiting virtual bases more than once.
104 llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBases;
105
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000106 typedef llvm::DenseMap<BaseSubobjectMethodPairTy, BaseOffset>
107 AdjustmentOffsetsMapTy;
108
109 /// ReturnAdjustments - Holds return adjustments for all the overriders that
110 /// need to perform return value adjustments.
111 AdjustmentOffsetsMapTy ReturnAdjustments;
Anders Carlssondf31af12010-02-13 23:17:31 +0000112
Anders Carlssonce57dd52010-03-03 04:58:02 +0000113 // FIXME: We might be able to get away with making this a SmallSet.
114 typedef llvm::SmallSetVector<uint64_t, 2> OffsetSetVectorTy;
Anders Carlssonb8358d82010-02-12 01:40:03 +0000115
116 /// SubobjectOffsetsMapTy - This map is used for keeping track of all the
117 /// base subobject offsets that a single class declaration might refer to.
118 ///
119 /// For example, in:
120 ///
121 /// struct A { virtual void f(); };
122 /// struct B1 : A { };
123 /// struct B2 : A { };
124 /// struct C : B1, B2 { virtual void f(); };
125 ///
126 /// when we determine that C::f() overrides A::f(), we need to update the
127 /// overriders map for both A-in-B1 and A-in-B2 and the subobject offsets map
128 /// will have the subobject offsets for both A copies.
Anders Carlssonce57dd52010-03-03 04:58:02 +0000129 typedef llvm::DenseMap<const CXXRecordDecl *, OffsetSetVectorTy>
Anders Carlssonb8358d82010-02-12 01:40:03 +0000130 SubobjectOffsetsMapTy;
131
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000132 /// ComputeFinalOverriders - Compute the final overriders for a given base
133 /// subobject (and all its direct and indirect bases).
Anders Carlssonb8358d82010-02-12 01:40:03 +0000134 void ComputeFinalOverriders(BaseSubobject Base,
Anders Carlssond5c7cca2010-02-17 17:48:25 +0000135 bool BaseSubobjectIsVisitedVBase,
Anders Carlssondb4022c2010-03-10 02:33:41 +0000136 uint64_t OffsetInLayoutClass,
Anders Carlssonb8358d82010-02-12 01:40:03 +0000137 SubobjectOffsetsMapTy &Offsets);
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000138
139 /// AddOverriders - Add the final overriders for this base subobject to the
140 /// map of final overriders.
Anders Carlssonc1246c82010-03-26 00:35:45 +0000141 void AddOverriders(BaseSubobject Base, uint64_t OffsetInLayoutClass,
Anders Carlssondb4022c2010-03-10 02:33:41 +0000142 SubobjectOffsetsMapTy &Offsets);
Anders Carlssonb8358d82010-02-12 01:40:03 +0000143
144 /// PropagateOverrider - Propagate the NewMD overrider to all the functions
145 /// that OldMD overrides. For example, if we have:
146 ///
147 /// struct A { virtual void f(); };
148 /// struct B : A { virtual void f(); };
149 /// struct C : B { virtual void f(); };
150 ///
151 /// and we want to override B::f with C::f, we also need to override A::f with
152 /// C::f.
153 void PropagateOverrider(const CXXMethodDecl *OldMD,
Anders Carlsson74c364e2010-02-13 22:23:31 +0000154 BaseSubobject NewBase,
Anders Carlssondb4022c2010-03-10 02:33:41 +0000155 uint64_t OverriderOffsetInLayoutClass,
Anders Carlssonb8358d82010-02-12 01:40:03 +0000156 const CXXMethodDecl *NewMD,
157 SubobjectOffsetsMapTy &Offsets);
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000158
Anders Carlssonb8358d82010-02-12 01:40:03 +0000159 static void MergeSubobjectOffsets(const SubobjectOffsetsMapTy &NewOffsets,
160 SubobjectOffsetsMapTy &Offsets);
161
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000162public:
Anders Carlssondb4022c2010-03-10 02:33:41 +0000163 FinalOverriders(const CXXRecordDecl *MostDerivedClass,
164 uint64_t MostDerivedClassOffset,
165 const CXXRecordDecl *LayoutClass);
Anders Carlsson2157d302010-02-24 22:18:01 +0000166
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000167 /// getOverrider - Get the final overrider for the given method declaration in
168 /// the given base subobject.
Anders Carlsson7dbf47a2010-02-13 20:11:51 +0000169 OverriderInfo getOverrider(BaseSubobject Base,
170 const CXXMethodDecl *MD) const {
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000171 assert(OverridersMap.count(std::make_pair(Base, MD)) &&
172 "Did not find overrider!");
173
174 return OverridersMap.lookup(std::make_pair(Base, MD));
175 }
176
Anders Carlsson49bac9a2010-02-13 23:40:17 +0000177 /// getReturnAdjustmentOffset - Get the return adjustment offset for the
178 /// method decl in the given base subobject. Returns an empty base offset if
179 /// no adjustment is needed.
Anders Carlsson7dbf47a2010-02-13 20:11:51 +0000180 BaseOffset getReturnAdjustmentOffset(BaseSubobject Base,
181 const CXXMethodDecl *MD) const {
182 return ReturnAdjustments.lookup(std::make_pair(Base, MD));
183 }
184
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000185 /// dump - dump the final overriders.
Anders Carlsson9d6f0d52010-02-14 00:37:35 +0000186 void dump() {
187 assert(VisitedVirtualBases.empty() &&
188 "Visited virtual bases aren't empty!");
189 dump(llvm::errs(), BaseSubobject(MostDerivedClass, 0));
190 VisitedVirtualBases.clear();
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000191 }
192
193 /// dump - dump the final overriders for a base subobject, and all its direct
194 /// and indirect base subobjects.
Anders Carlsson9d6f0d52010-02-14 00:37:35 +0000195 void dump(llvm::raw_ostream &Out, BaseSubobject Base);
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000196};
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000197
Anders Carlsson327568e2010-02-27 20:02:53 +0000198#define DUMP_OVERRIDERS 0
199
Anders Carlssondb4022c2010-03-10 02:33:41 +0000200FinalOverriders::FinalOverriders(const CXXRecordDecl *MostDerivedClass,
201 uint64_t MostDerivedClassOffset,
202 const CXXRecordDecl *LayoutClass)
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000203 : MostDerivedClass(MostDerivedClass),
Anders Carlssondb4022c2010-03-10 02:33:41 +0000204 MostDerivedClassOffset(MostDerivedClassOffset), LayoutClass(LayoutClass),
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000205 Context(MostDerivedClass->getASTContext()),
206 MostDerivedClassLayout(Context.getASTRecordLayout(MostDerivedClass)) {
207
208 // Compute the final overriders.
Anders Carlssonb8358d82010-02-12 01:40:03 +0000209 SubobjectOffsetsMapTy Offsets;
Anders Carlssond5c7cca2010-02-17 17:48:25 +0000210 ComputeFinalOverriders(BaseSubobject(MostDerivedClass, 0),
Anders Carlssondb4022c2010-03-10 02:33:41 +0000211 /*BaseSubobjectIsVisitedVBase=*/false,
212 MostDerivedClassOffset, Offsets);
Anders Carlssond5c7cca2010-02-17 17:48:25 +0000213 VisitedVirtualBases.clear();
Anders Carlsson327568e2010-02-27 20:02:53 +0000214
215#if DUMP_OVERRIDERS
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000216 // And dump them (for now).
217 dump();
Anders Carlssona4699882010-02-13 21:33:22 +0000218
219 // Also dump the base offsets (for now).
220 for (SubobjectOffsetsMapTy::const_iterator I = Offsets.begin(),
221 E = Offsets.end(); I != E; ++I) {
Anders Carlssondb4022c2010-03-10 02:33:41 +0000222 const OffsetSetVectorTy& OffsetSetVector = I->second;
Anders Carlssona4699882010-02-13 21:33:22 +0000223
224 llvm::errs() << "Base offsets for ";
225 llvm::errs() << I->first->getQualifiedNameAsString() << '\n';
226
Anders Carlssondb4022c2010-03-10 02:33:41 +0000227 for (unsigned I = 0, E = OffsetSetVector.size(); I != E; ++I)
228 llvm::errs() << " " << I << " - " << OffsetSetVector[I] / 8 << '\n';
Anders Carlssona4699882010-02-13 21:33:22 +0000229 }
Anders Carlsson327568e2010-02-27 20:02:53 +0000230#endif
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000231}
232
Anders Carlssonb8358d82010-02-12 01:40:03 +0000233void FinalOverriders::AddOverriders(BaseSubobject Base,
Anders Carlssondb4022c2010-03-10 02:33:41 +0000234 uint64_t OffsetInLayoutClass,
Anders Carlssonb8358d82010-02-12 01:40:03 +0000235 SubobjectOffsetsMapTy &Offsets) {
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000236 const CXXRecordDecl *RD = Base.getBase();
237
238 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
239 E = RD->method_end(); I != E; ++I) {
240 const CXXMethodDecl *MD = *I;
241
242 if (!MD->isVirtual())
243 continue;
244
Anders Carlssonb8358d82010-02-12 01:40:03 +0000245 // First, propagate the overrider.
Anders Carlssondb4022c2010-03-10 02:33:41 +0000246 PropagateOverrider(MD, Base, OffsetInLayoutClass, MD, Offsets);
Anders Carlssonb8358d82010-02-12 01:40:03 +0000247
248 // Add the overrider as the final overrider of itself.
Anders Carlssona7575822010-02-12 16:55:34 +0000249 OverriderInfo& Overrider = OverridersMap[std::make_pair(Base, MD)];
250 assert(!Overrider.Method && "Overrider should not exist yet!");
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000251
Anders Carlssondb4022c2010-03-10 02:33:41 +0000252 Overrider.Offset = OffsetInLayoutClass;
Anders Carlssona7575822010-02-12 16:55:34 +0000253 Overrider.Method = MD;
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000254 }
255}
256
Anders Carlsson2fca9be2010-02-23 01:34:28 +0000257static BaseOffset ComputeBaseOffset(ASTContext &Context,
258 const CXXRecordDecl *DerivedRD,
259 const CXXBasePath &Path) {
Anders Carlssondf31af12010-02-13 23:17:31 +0000260 int64_t NonVirtualOffset = 0;
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000261
Anders Carlssona4a54172010-02-13 20:41:15 +0000262 unsigned NonVirtualStart = 0;
263 const CXXRecordDecl *VirtualBase = 0;
264
265 // First, look for the virtual base class.
266 for (unsigned I = 0, E = Path.size(); I != E; ++I) {
267 const CXXBasePathElement &Element = Path[I];
268
269 if (Element.Base->isVirtual()) {
270 // FIXME: Can we break when we find the first virtual base?
271 // (If we can't, can't we just iterate over the path in reverse order?)
272 NonVirtualStart = I + 1;
273 QualType VBaseType = Element.Base->getType();
274 VirtualBase =
275 cast<CXXRecordDecl>(VBaseType->getAs<RecordType>()->getDecl());
276 }
277 }
278
279 // Now compute the non-virtual offset.
280 for (unsigned I = NonVirtualStart, E = Path.size(); I != E; ++I) {
281 const CXXBasePathElement &Element = Path[I];
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000282
283 // Check the base class offset.
284 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Element.Class);
Anders Carlssonbf554f62010-02-25 22:18:35 +0000285
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000286 const RecordType *BaseType = Element.Base->getType()->getAs<RecordType>();
287 const CXXRecordDecl *Base = cast<CXXRecordDecl>(BaseType->getDecl());
Anders Carlssonbf554f62010-02-25 22:18:35 +0000288
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000289 NonVirtualOffset += Layout.getBaseClassOffset(Base);
290 }
291
292 // FIXME: This should probably use CharUnits or something. Maybe we should
293 // even change the base offsets in ASTRecordLayout to be specified in
294 // CharUnits.
Anders Carlsson2fca9be2010-02-23 01:34:28 +0000295 return BaseOffset(DerivedRD, VirtualBase, NonVirtualOffset / 8);
Anders Carlssone67dc302010-02-14 00:16:19 +0000296
297}
298
Anders Carlsson2fca9be2010-02-23 01:34:28 +0000299static BaseOffset ComputeBaseOffset(ASTContext &Context,
300 const CXXRecordDecl *BaseRD,
301 const CXXRecordDecl *DerivedRD) {
Anders Carlssone67dc302010-02-14 00:16:19 +0000302 CXXBasePaths Paths(/*FindAmbiguities=*/false,
303 /*RecordPaths=*/true, /*DetectVirtual=*/false);
304
305 if (!const_cast<CXXRecordDecl *>(DerivedRD)->
306 isDerivedFrom(const_cast<CXXRecordDecl *>(BaseRD), Paths)) {
307 assert(false && "Class must be derived from the passed in base class!");
Anders Carlsson2fca9be2010-02-23 01:34:28 +0000308 return BaseOffset();
Anders Carlssone67dc302010-02-14 00:16:19 +0000309 }
310
311 return ComputeBaseOffset(Context, DerivedRD, Paths.front());
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000312}
313
Anders Carlsson2fca9be2010-02-23 01:34:28 +0000314static BaseOffset
Anders Carlssondf31af12010-02-13 23:17:31 +0000315ComputeReturnAdjustmentBaseOffset(ASTContext &Context,
316 const CXXMethodDecl *DerivedMD,
317 const CXXMethodDecl *BaseMD) {
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000318 const FunctionType *BaseFT = BaseMD->getType()->getAs<FunctionType>();
319 const FunctionType *DerivedFT = DerivedMD->getType()->getAs<FunctionType>();
320
321 // Canonicalize the return types.
322 CanQualType CanDerivedReturnType =
323 Context.getCanonicalType(DerivedFT->getResultType());
324 CanQualType CanBaseReturnType =
325 Context.getCanonicalType(BaseFT->getResultType());
326
327 assert(CanDerivedReturnType->getTypeClass() ==
328 CanBaseReturnType->getTypeClass() &&
329 "Types must have same type class!");
330
331 if (CanDerivedReturnType == CanBaseReturnType) {
332 // No adjustment needed.
Anders Carlsson2fca9be2010-02-23 01:34:28 +0000333 return BaseOffset();
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000334 }
335
336 if (isa<ReferenceType>(CanDerivedReturnType)) {
337 CanDerivedReturnType =
338 CanDerivedReturnType->getAs<ReferenceType>()->getPointeeType();
339 CanBaseReturnType =
340 CanBaseReturnType->getAs<ReferenceType>()->getPointeeType();
341 } else if (isa<PointerType>(CanDerivedReturnType)) {
342 CanDerivedReturnType =
343 CanDerivedReturnType->getAs<PointerType>()->getPointeeType();
344 CanBaseReturnType =
345 CanBaseReturnType->getAs<PointerType>()->getPointeeType();
346 } else {
347 assert(false && "Unexpected return type!");
348 }
349
350 // We need to compare unqualified types here; consider
351 // const T *Base::foo();
352 // T *Derived::foo();
353 if (CanDerivedReturnType.getUnqualifiedType() ==
354 CanBaseReturnType.getUnqualifiedType()) {
355 // No adjustment needed.
Anders Carlsson2fca9be2010-02-23 01:34:28 +0000356 return BaseOffset();
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000357 }
358
359 const CXXRecordDecl *DerivedRD =
360 cast<CXXRecordDecl>(cast<RecordType>(CanDerivedReturnType)->getDecl());
361
362 const CXXRecordDecl *BaseRD =
363 cast<CXXRecordDecl>(cast<RecordType>(CanBaseReturnType)->getDecl());
364
Anders Carlssondf31af12010-02-13 23:17:31 +0000365 return ComputeBaseOffset(Context, BaseRD, DerivedRD);
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000366}
367
Anders Carlssonb8358d82010-02-12 01:40:03 +0000368void FinalOverriders::PropagateOverrider(const CXXMethodDecl *OldMD,
Anders Carlsson74c364e2010-02-13 22:23:31 +0000369 BaseSubobject NewBase,
Anders Carlssondb4022c2010-03-10 02:33:41 +0000370 uint64_t OverriderOffsetInLayoutClass,
Anders Carlssonb8358d82010-02-12 01:40:03 +0000371 const CXXMethodDecl *NewMD,
372 SubobjectOffsetsMapTy &Offsets) {
373 for (CXXMethodDecl::method_iterator I = OldMD->begin_overridden_methods(),
374 E = OldMD->end_overridden_methods(); I != E; ++I) {
375 const CXXMethodDecl *OverriddenMD = *I;
376 const CXXRecordDecl *OverriddenRD = OverriddenMD->getParent();
377
378 // We want to override OverriddenMD in all subobjects, for example:
379 //
380 /// struct A { virtual void f(); };
381 /// struct B1 : A { };
382 /// struct B2 : A { };
383 /// struct C : B1, B2 { virtual void f(); };
384 ///
385 /// When overriding A::f with C::f we need to do so in both A subobjects.
Anders Carlssonce57dd52010-03-03 04:58:02 +0000386 const OffsetSetVectorTy &OffsetVector = Offsets[OverriddenRD];
Anders Carlssonb8358d82010-02-12 01:40:03 +0000387
388 // Go through all the subobjects.
389 for (unsigned I = 0, E = OffsetVector.size(); I != E; ++I) {
390 uint64_t Offset = OffsetVector[I];
391
Anders Carlssone67dc302010-02-14 00:16:19 +0000392 BaseSubobject OverriddenSubobject = BaseSubobject(OverriddenRD, Offset);
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000393 BaseSubobjectMethodPairTy SubobjectAndMethod =
Anders Carlssone67dc302010-02-14 00:16:19 +0000394 std::make_pair(OverriddenSubobject, OverriddenMD);
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000395
396 OverriderInfo &Overrider = OverridersMap[SubobjectAndMethod];
397
Anders Carlssona7575822010-02-12 16:55:34 +0000398 assert(Overrider.Method && "Did not find existing overrider!");
Anders Carlssonb8358d82010-02-12 01:40:03 +0000399
Anders Carlssondf31af12010-02-13 23:17:31 +0000400 // Check if we need return adjustments or base adjustments.
Anders Carlsson1d05be52010-02-13 21:16:54 +0000401 // (We don't want to do this for pure virtual member functions).
402 if (!NewMD->isPure()) {
Anders Carlssondf31af12010-02-13 23:17:31 +0000403 // Get the return adjustment base offset.
Anders Carlsson1d05be52010-02-13 21:16:54 +0000404 BaseOffset ReturnBaseOffset =
Anders Carlssondf31af12010-02-13 23:17:31 +0000405 ComputeReturnAdjustmentBaseOffset(Context, NewMD, OverriddenMD);
406
Anders Carlsson1d05be52010-02-13 21:16:54 +0000407 if (!ReturnBaseOffset.isEmpty()) {
408 // Store the return adjustment base offset.
409 ReturnAdjustments[SubobjectAndMethod] = ReturnBaseOffset;
410 }
Anders Carlsson16b73122010-02-12 17:13:23 +0000411 }
412
Anders Carlssonb8358d82010-02-12 01:40:03 +0000413 // Set the new overrider.
Anders Carlssondb4022c2010-03-10 02:33:41 +0000414 Overrider.Offset = OverriderOffsetInLayoutClass;
Anders Carlssona7575822010-02-12 16:55:34 +0000415 Overrider.Method = NewMD;
Anders Carlssonb8358d82010-02-12 01:40:03 +0000416
417 // And propagate it further.
Anders Carlssondb4022c2010-03-10 02:33:41 +0000418 PropagateOverrider(OverriddenMD, NewBase, OverriderOffsetInLayoutClass,
419 NewMD, Offsets);
Anders Carlssonb8358d82010-02-12 01:40:03 +0000420 }
421 }
422}
423
424void
425FinalOverriders::MergeSubobjectOffsets(const SubobjectOffsetsMapTy &NewOffsets,
426 SubobjectOffsetsMapTy &Offsets) {
427 // Iterate over the new offsets.
428 for (SubobjectOffsetsMapTy::const_iterator I = NewOffsets.begin(),
429 E = NewOffsets.end(); I != E; ++I) {
430 const CXXRecordDecl *NewRD = I->first;
Anders Carlssonce57dd52010-03-03 04:58:02 +0000431 const OffsetSetVectorTy& NewOffsetVector = I->second;
Anders Carlssonb8358d82010-02-12 01:40:03 +0000432
Anders Carlssonce57dd52010-03-03 04:58:02 +0000433 OffsetSetVectorTy &OffsetVector = Offsets[NewRD];
Anders Carlssonb8358d82010-02-12 01:40:03 +0000434
Anders Carlssonce57dd52010-03-03 04:58:02 +0000435 // Merge the new offsets set vector into the old.
436 OffsetVector.insert(NewOffsetVector.begin(), NewOffsetVector.end());
Anders Carlssonb8358d82010-02-12 01:40:03 +0000437 }
438}
439
440void FinalOverriders::ComputeFinalOverriders(BaseSubobject Base,
Anders Carlssond5c7cca2010-02-17 17:48:25 +0000441 bool BaseSubobjectIsVisitedVBase,
Anders Carlssondb4022c2010-03-10 02:33:41 +0000442 uint64_t OffsetInLayoutClass,
Anders Carlssonb8358d82010-02-12 01:40:03 +0000443 SubobjectOffsetsMapTy &Offsets) {
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000444 const CXXRecordDecl *RD = Base.getBase();
Anders Carlssonb8358d82010-02-12 01:40:03 +0000445 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000446
Anders Carlssonb8358d82010-02-12 01:40:03 +0000447 SubobjectOffsetsMapTy NewOffsets;
448
449 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
450 E = RD->bases_end(); I != E; ++I) {
451 const CXXRecordDecl *BaseDecl =
452 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
453
Anders Carlssonb828afa2010-02-14 17:05:59 +0000454 // Ignore bases that don't have any virtual member functions.
455 if (!BaseDecl->isPolymorphic())
456 continue;
457
Anders Carlssonbf554f62010-02-25 22:18:35 +0000458 bool IsVisitedVirtualBase = BaseSubobjectIsVisitedVBase;
Anders Carlsson9d6f0d52010-02-14 00:37:35 +0000459 uint64_t BaseOffset;
Anders Carlssondb4022c2010-03-10 02:33:41 +0000460 uint64_t BaseOffsetInLayoutClass;
Anders Carlsson9d6f0d52010-02-14 00:37:35 +0000461 if (I->isVirtual()) {
Anders Carlssond5c7cca2010-02-17 17:48:25 +0000462 if (!VisitedVirtualBases.insert(BaseDecl))
463 IsVisitedVirtualBase = true;
Anders Carlsson9d6f0d52010-02-14 00:37:35 +0000464 BaseOffset = MostDerivedClassLayout.getVBaseClassOffset(BaseDecl);
Anders Carlssondb4022c2010-03-10 02:33:41 +0000465
466 const ASTRecordLayout &LayoutClassLayout =
467 Context.getASTRecordLayout(LayoutClass);
468 BaseOffsetInLayoutClass =
469 LayoutClassLayout.getVBaseClassOffset(BaseDecl);
Anders Carlsson9d6f0d52010-02-14 00:37:35 +0000470 } else {
471 BaseOffset = Layout.getBaseClassOffset(BaseDecl) + Base.getBaseOffset();
Anders Carlssondb4022c2010-03-10 02:33:41 +0000472 BaseOffsetInLayoutClass = Layout.getBaseClassOffset(BaseDecl) +
473 OffsetInLayoutClass;
Anders Carlsson9d6f0d52010-02-14 00:37:35 +0000474 }
475
Anders Carlssonb8358d82010-02-12 01:40:03 +0000476 // Compute the final overriders for this base.
Anders Carlssond5c7cca2010-02-17 17:48:25 +0000477 // We always want to compute the final overriders, even if the base is a
478 // visited virtual base. Consider:
479 //
480 // struct A {
481 // virtual void f();
482 // virtual void g();
483 // };
484 //
485 // struct B : virtual A {
486 // void f();
487 // };
488 //
489 // struct C : virtual A {
490 // void g ();
491 // };
492 //
493 // struct D : B, C { };
494 //
495 // Here, we still want to compute the overriders for A as a base of C,
496 // because otherwise we'll miss that C::g overrides A::f.
497 ComputeFinalOverriders(BaseSubobject(BaseDecl, BaseOffset),
Anders Carlssondb4022c2010-03-10 02:33:41 +0000498 IsVisitedVirtualBase, BaseOffsetInLayoutClass,
499 NewOffsets);
Anders Carlssonb8358d82010-02-12 01:40:03 +0000500 }
501
502 /// Now add the overriders for this particular subobject.
Anders Carlssond5c7cca2010-02-17 17:48:25 +0000503 /// (We don't want to do this more than once for a virtual base).
504 if (!BaseSubobjectIsVisitedVBase)
Anders Carlssondb4022c2010-03-10 02:33:41 +0000505 AddOverriders(Base, OffsetInLayoutClass, NewOffsets);
Anders Carlssonb8358d82010-02-12 01:40:03 +0000506
507 // And merge the newly discovered subobject offsets.
508 MergeSubobjectOffsets(NewOffsets, Offsets);
509
510 /// Finally, add the offset for our own subobject.
Anders Carlssonce57dd52010-03-03 04:58:02 +0000511 Offsets[RD].insert(Base.getBaseOffset());
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000512}
513
Anders Carlsson9d6f0d52010-02-14 00:37:35 +0000514void FinalOverriders::dump(llvm::raw_ostream &Out, BaseSubobject Base) {
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000515 const CXXRecordDecl *RD = Base.getBase();
516 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
517
518 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
519 E = RD->bases_end(); I != E; ++I) {
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000520 const CXXRecordDecl *BaseDecl =
521 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
522
Anders Carlssonb828afa2010-02-14 17:05:59 +0000523 // Ignore bases that don't have any virtual member functions.
524 if (!BaseDecl->isPolymorphic())
525 continue;
526
Anders Carlsson9d6f0d52010-02-14 00:37:35 +0000527 uint64_t BaseOffset;
528 if (I->isVirtual()) {
529 if (!VisitedVirtualBases.insert(BaseDecl)) {
530 // We've visited this base before.
531 continue;
532 }
533
534 BaseOffset = MostDerivedClassLayout.getVBaseClassOffset(BaseDecl);
535 } else {
536 BaseOffset = Layout.getBaseClassOffset(BaseDecl) +
537 Base.getBaseOffset();
538 }
539
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000540 dump(Out, BaseSubobject(BaseDecl, BaseOffset));
541 }
542
543 Out << "Final overriders for (" << RD->getQualifiedNameAsString() << ", ";
Anders Carlssondb4022c2010-03-10 02:33:41 +0000544 Out << Base.getBaseOffset() / 8 << ")\n";
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000545
546 // Now dump the overriders for this base subobject.
547 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
548 E = RD->method_end(); I != E; ++I) {
549 const CXXMethodDecl *MD = *I;
550
551 if (!MD->isVirtual())
552 continue;
553
Anders Carlssona7575822010-02-12 16:55:34 +0000554 OverriderInfo Overrider = getOverrider(Base, MD);
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000555
Anders Carlssond86e5d82010-03-02 03:44:06 +0000556 Out << " " << MD->getQualifiedNameAsString() << " - (";
Anders Carlsson16b73122010-02-12 17:13:23 +0000557 Out << Overrider.Method->getQualifiedNameAsString();
Anders Carlssoncd0d27f2010-03-12 05:02:01 +0000558 Out << ", " << ", " << Overrider.Offset / 8 << ')';
Anders Carlssond86e5d82010-03-02 03:44:06 +0000559
Benjamin Kramere3d0b1c2010-02-13 09:11:28 +0000560 AdjustmentOffsetsMapTy::const_iterator AI =
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000561 ReturnAdjustments.find(std::make_pair(Base, MD));
Benjamin Kramere3d0b1c2010-02-13 09:11:28 +0000562 if (AI != ReturnAdjustments.end()) {
563 const BaseOffset &Offset = AI->second;
Anders Carlssona4a54172010-02-13 20:41:15 +0000564
565 Out << " [ret-adj: ";
566 if (Offset.VirtualBase)
567 Out << Offset.VirtualBase->getQualifiedNameAsString() << " vbase, ";
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000568
Anders Carlssona4a54172010-02-13 20:41:15 +0000569 Out << Offset.NonVirtualOffset << " nv]";
Anders Carlsson0c0eeb22010-02-13 02:02:03 +0000570 }
Anders Carlssondf31af12010-02-13 23:17:31 +0000571
Anders Carlsson16b73122010-02-12 17:13:23 +0000572 Out << "\n";
Anders Carlssonbdf73d82010-02-11 21:24:32 +0000573 }
574}
575
Anders Carlsson94464812010-04-10 19:13:06 +0000576/// VTableComponent - Represents a single component in a vtable.
577class VTableComponent {
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000578public:
579 enum Kind {
580 CK_VCallOffset,
581 CK_VBaseOffset,
582 CK_OffsetToTop,
583 CK_RTTI,
Anders Carlsson848fa642010-02-11 18:20:28 +0000584 CK_FunctionPointer,
585
586 /// CK_CompleteDtorPointer - A pointer to the complete destructor.
587 CK_CompleteDtorPointer,
588
589 /// CK_DeletingDtorPointer - A pointer to the deleting destructor.
Anders Carlsson1f464662010-02-19 20:08:13 +0000590 CK_DeletingDtorPointer,
591
592 /// CK_UnusedFunctionPointer - In some cases, a vtable function pointer
593 /// will end up never being called. Such vtable function pointers are
594 /// represented as a CK_UnusedFunctionPointer.
595 CK_UnusedFunctionPointer
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000596 };
597
Anders Carlsson94464812010-04-10 19:13:06 +0000598 static VTableComponent MakeVCallOffset(int64_t Offset) {
599 return VTableComponent(CK_VCallOffset, Offset);
Anders Carlssond9a67042010-02-17 06:07:19 +0000600 }
601
Anders Carlsson94464812010-04-10 19:13:06 +0000602 static VTableComponent MakeVBaseOffset(int64_t Offset) {
603 return VTableComponent(CK_VBaseOffset, Offset);
Anders Carlssona661a542010-02-16 04:49:44 +0000604 }
605
Anders Carlsson94464812010-04-10 19:13:06 +0000606 static VTableComponent MakeOffsetToTop(int64_t Offset) {
607 return VTableComponent(CK_OffsetToTop, Offset);
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000608 }
609
Anders Carlsson94464812010-04-10 19:13:06 +0000610 static VTableComponent MakeRTTI(const CXXRecordDecl *RD) {
611 return VTableComponent(CK_RTTI, reinterpret_cast<uintptr_t>(RD));
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000612 }
613
Anders Carlsson94464812010-04-10 19:13:06 +0000614 static VTableComponent MakeFunction(const CXXMethodDecl *MD) {
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000615 assert(!isa<CXXDestructorDecl>(MD) &&
Anders Carlsson848fa642010-02-11 18:20:28 +0000616 "Don't use MakeFunction with destructors!");
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000617
Anders Carlsson94464812010-04-10 19:13:06 +0000618 return VTableComponent(CK_FunctionPointer,
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000619 reinterpret_cast<uintptr_t>(MD));
620 }
621
Anders Carlsson94464812010-04-10 19:13:06 +0000622 static VTableComponent MakeCompleteDtor(const CXXDestructorDecl *DD) {
623 return VTableComponent(CK_CompleteDtorPointer,
Anders Carlsson848fa642010-02-11 18:20:28 +0000624 reinterpret_cast<uintptr_t>(DD));
625 }
626
Anders Carlsson94464812010-04-10 19:13:06 +0000627 static VTableComponent MakeDeletingDtor(const CXXDestructorDecl *DD) {
628 return VTableComponent(CK_DeletingDtorPointer,
Anders Carlsson848fa642010-02-11 18:20:28 +0000629 reinterpret_cast<uintptr_t>(DD));
630 }
631
Anders Carlsson94464812010-04-10 19:13:06 +0000632 static VTableComponent MakeUnusedFunction(const CXXMethodDecl *MD) {
Anders Carlsson1f464662010-02-19 20:08:13 +0000633 assert(!isa<CXXDestructorDecl>(MD) &&
634 "Don't use MakeUnusedFunction with destructors!");
Anders Carlsson94464812010-04-10 19:13:06 +0000635 return VTableComponent(CK_UnusedFunctionPointer,
Anders Carlsson1f464662010-02-19 20:08:13 +0000636 reinterpret_cast<uintptr_t>(MD));
637 }
638
Anders Carlsson94464812010-04-10 19:13:06 +0000639 static VTableComponent getFromOpaqueInteger(uint64_t I) {
640 return VTableComponent(I);
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +0000641 }
642
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000643 /// getKind - Get the kind of this vtable component.
644 Kind getKind() const {
645 return (Kind)(Value & 0x7);
646 }
647
Anders Carlssond9a67042010-02-17 06:07:19 +0000648 int64_t getVCallOffset() const {
649 assert(getKind() == CK_VCallOffset && "Invalid component kind!");
650
651 return getOffset();
652 }
653
Anders Carlssona661a542010-02-16 04:49:44 +0000654 int64_t getVBaseOffset() const {
655 assert(getKind() == CK_VBaseOffset && "Invalid component kind!");
656
657 return getOffset();
658 }
659
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000660 int64_t getOffsetToTop() const {
661 assert(getKind() == CK_OffsetToTop && "Invalid component kind!");
662
663 return getOffset();
664 }
665
666 const CXXRecordDecl *getRTTIDecl() const {
667 assert(getKind() == CK_RTTI && "Invalid component kind!");
668
669 return reinterpret_cast<CXXRecordDecl *>(getPointer());
670 }
671
672 const CXXMethodDecl *getFunctionDecl() const {
Anders Carlsson848fa642010-02-11 18:20:28 +0000673 assert(getKind() == CK_FunctionPointer);
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000674
675 return reinterpret_cast<CXXMethodDecl *>(getPointer());
676 }
Anders Carlsson848fa642010-02-11 18:20:28 +0000677
678 const CXXDestructorDecl *getDestructorDecl() const {
679 assert((getKind() == CK_CompleteDtorPointer ||
680 getKind() == CK_DeletingDtorPointer) && "Invalid component kind!");
681
682 return reinterpret_cast<CXXDestructorDecl *>(getPointer());
683 }
684
Anders Carlsson1f464662010-02-19 20:08:13 +0000685 const CXXMethodDecl *getUnusedFunctionDecl() const {
686 assert(getKind() == CK_UnusedFunctionPointer);
687
688 return reinterpret_cast<CXXMethodDecl *>(getPointer());
689 }
690
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000691private:
Anders Carlsson94464812010-04-10 19:13:06 +0000692 VTableComponent(Kind ComponentKind, int64_t Offset) {
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000693 assert((ComponentKind == CK_VCallOffset ||
694 ComponentKind == CK_VBaseOffset ||
695 ComponentKind == CK_OffsetToTop) && "Invalid component kind!");
696 assert(Offset <= ((1LL << 56) - 1) && "Offset is too big!");
697
698 Value = ((Offset << 3) | ComponentKind);
699 }
700
Anders Carlsson94464812010-04-10 19:13:06 +0000701 VTableComponent(Kind ComponentKind, uintptr_t Ptr) {
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000702 assert((ComponentKind == CK_RTTI ||
Anders Carlsson848fa642010-02-11 18:20:28 +0000703 ComponentKind == CK_FunctionPointer ||
704 ComponentKind == CK_CompleteDtorPointer ||
Anders Carlsson1f464662010-02-19 20:08:13 +0000705 ComponentKind == CK_DeletingDtorPointer ||
706 ComponentKind == CK_UnusedFunctionPointer) &&
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000707 "Invalid component kind!");
708
709 assert((Ptr & 7) == 0 && "Pointer not sufficiently aligned!");
710
711 Value = Ptr | ComponentKind;
712 }
713
714 int64_t getOffset() const {
715 assert((getKind() == CK_VCallOffset || getKind() == CK_VBaseOffset ||
716 getKind() == CK_OffsetToTop) && "Invalid component kind!");
717
718 return Value >> 3;
719 }
720
721 uintptr_t getPointer() const {
Anders Carlsson848fa642010-02-11 18:20:28 +0000722 assert((getKind() == CK_RTTI ||
723 getKind() == CK_FunctionPointer ||
724 getKind() == CK_CompleteDtorPointer ||
Anders Carlsson1f464662010-02-19 20:08:13 +0000725 getKind() == CK_DeletingDtorPointer ||
726 getKind() == CK_UnusedFunctionPointer) &&
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000727 "Invalid component kind!");
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000728
729 return static_cast<uintptr_t>(Value & ~7ULL);
730 }
731
Anders Carlsson94464812010-04-10 19:13:06 +0000732 explicit VTableComponent(uint64_t Value)
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +0000733 : Value(Value) { }
734
Anders Carlsson824d7ea2010-02-11 08:02:13 +0000735 /// The kind is stored in the lower 3 bits of the value. For offsets, we
736 /// make use of the facts that classes can't be larger than 2^55 bytes,
737 /// so we store the offset in the lower part of the 61 bytes that remain.
738 /// (The reason that we're not simply using a PointerIntPair here is that we
739 /// need the offsets to be 64-bit, even when on a 32-bit machine).
740 int64_t Value;
741};
742
Anders Carlsson60cc72a2010-02-18 17:00:09 +0000743/// VCallOffsetMap - Keeps track of vcall offsets when building a vtable.
744struct VCallOffsetMap {
745
746 typedef std::pair<const CXXMethodDecl *, int64_t> MethodAndOffsetPairTy;
747
748 /// Offsets - Keeps track of methods and their offsets.
749 // FIXME: This should be a real map and not a vector.
750 llvm::SmallVector<MethodAndOffsetPairTy, 16> Offsets;
751
Anders Carlssoneb577d02010-02-18 17:26:40 +0000752 /// MethodsCanShareVCallOffset - Returns whether two virtual member functions
753 /// can share the same vcall offset.
754 static bool MethodsCanShareVCallOffset(const CXXMethodDecl *LHS,
755 const CXXMethodDecl *RHS);
756
Anders Carlsson60cc72a2010-02-18 17:00:09 +0000757public:
758 /// AddVCallOffset - Adds a vcall offset to the map. Returns true if the
759 /// add was successful, or false if there was already a member function with
760 /// the same signature in the map.
761 bool AddVCallOffset(const CXXMethodDecl *MD, int64_t OffsetOffset);
762
763 /// getVCallOffsetOffset - Returns the vcall offset offset (relative to the
764 /// vtable address point) for the given virtual member function.
765 int64_t getVCallOffsetOffset(const CXXMethodDecl *MD);
766
Anders Carlssondba6ef82010-02-25 22:23:13 +0000767 // empty - Return whether the offset map is empty or not.
768 bool empty() const { return Offsets.empty(); }
Anders Carlsson60cc72a2010-02-18 17:00:09 +0000769};
770
John McCall331a03a2010-02-26 20:22:44 +0000771static bool HasSameVirtualSignature(const CXXMethodDecl *LHS,
772 const CXXMethodDecl *RHS) {
773 ASTContext &C = LHS->getASTContext(); // TODO: thread this down
774 CanQual<FunctionProtoType>
775 LT = C.getCanonicalType(LHS->getType()).getAs<FunctionProtoType>(),
776 RT = C.getCanonicalType(RHS->getType()).getAs<FunctionProtoType>();
777
778 // Fast-path matches in the canonical types.
779 if (LT == RT) return true;
780
781 // Force the signatures to match. We can't rely on the overrides
782 // list here because there isn't necessarily an inheritance
783 // relationship between the two methods.
784 if (LT.getQualifiers() != RT.getQualifiers() ||
785 LT->getNumArgs() != RT->getNumArgs())
786 return false;
787 for (unsigned I = 0, E = LT->getNumArgs(); I != E; ++I)
788 if (LT->getArgType(I) != RT->getArgType(I))
789 return false;
790 return true;
791}
792
Anders Carlssoneb577d02010-02-18 17:26:40 +0000793bool VCallOffsetMap::MethodsCanShareVCallOffset(const CXXMethodDecl *LHS,
794 const CXXMethodDecl *RHS) {
795 assert(LHS->isVirtual() && "LHS must be virtual!");
796 assert(RHS->isVirtual() && "LHS must be virtual!");
797
Anders Carlsson55609692010-02-27 04:12:52 +0000798 // A destructor can share a vcall offset with another destructor.
799 if (isa<CXXDestructorDecl>(LHS))
800 return isa<CXXDestructorDecl>(RHS);
801
Anders Carlssoneb577d02010-02-18 17:26:40 +0000802 // FIXME: We need to check more things here.
803
Anders Carlsson55609692010-02-27 04:12:52 +0000804 // The methods must have the same name.
Anders Carlssoneb577d02010-02-18 17:26:40 +0000805 DeclarationName LHSName = LHS->getDeclName();
806 DeclarationName RHSName = RHS->getDeclName();
John McCall331a03a2010-02-26 20:22:44 +0000807 if (LHSName != RHSName)
Anders Carlssoneb577d02010-02-18 17:26:40 +0000808 return false;
John McCall331a03a2010-02-26 20:22:44 +0000809
Anders Carlsson55609692010-02-27 04:12:52 +0000810 // And the same signatures.
811 return HasSameVirtualSignature(LHS, RHS);
Anders Carlssoneb577d02010-02-18 17:26:40 +0000812}
813
Anders Carlsson60cc72a2010-02-18 17:00:09 +0000814bool VCallOffsetMap::AddVCallOffset(const CXXMethodDecl *MD,
815 int64_t OffsetOffset) {
Anders Carlssoneb577d02010-02-18 17:26:40 +0000816 // Check if we can reuse an offset.
817 for (unsigned I = 0, E = Offsets.size(); I != E; ++I) {
818 if (MethodsCanShareVCallOffset(Offsets[I].first, MD))
819 return false;
820 }
821
822 // Add the offset.
823 Offsets.push_back(MethodAndOffsetPairTy(MD, OffsetOffset));
Anders Carlsson60cc72a2010-02-18 17:00:09 +0000824 return true;
825}
826
827int64_t VCallOffsetMap::getVCallOffsetOffset(const CXXMethodDecl *MD) {
Anders Carlssoneb577d02010-02-18 17:26:40 +0000828 // Look for an offset.
829 for (unsigned I = 0, E = Offsets.size(); I != E; ++I) {
830 if (MethodsCanShareVCallOffset(Offsets[I].first, MD))
831 return Offsets[I].second;
832 }
833
834 assert(false && "Should always find a vcall offset offset!");
Anders Carlsson60cc72a2010-02-18 17:00:09 +0000835 return 0;
836}
837
Anders Carlssond68c0832010-02-25 03:45:56 +0000838/// VCallAndVBaseOffsetBuilder - Class for building vcall and vbase offsets.
839class VCallAndVBaseOffsetBuilder {
Anders Carlssonc89a7cf2010-03-11 16:06:20 +0000840public:
841 typedef llvm::DenseMap<const CXXRecordDecl *, int64_t>
842 VBaseOffsetOffsetsMapTy;
843
844private:
Anders Carlsson530c40c2010-02-28 01:43:58 +0000845 /// MostDerivedClass - The most derived class for which we're building vcall
846 /// and vbase offsets.
Anders Carlssond68c0832010-02-25 03:45:56 +0000847 const CXXRecordDecl *MostDerivedClass;
848
Anders Carlsson0041a642010-02-27 21:09:00 +0000849 /// LayoutClass - The class we're using for layout information. Will be
850 /// different than the most derived class if we're building a construction
851 /// vtable.
852 const CXXRecordDecl *LayoutClass;
853
Anders Carlssond68c0832010-02-25 03:45:56 +0000854 /// Context - The ASTContext which we will use for layout information.
855 ASTContext &Context;
856
857 /// Components - vcall and vbase offset components
Anders Carlsson94464812010-04-10 19:13:06 +0000858 typedef llvm::SmallVector<VTableComponent, 64> VTableComponentVectorTy;
859 VTableComponentVectorTy Components;
Anders Carlssond68c0832010-02-25 03:45:56 +0000860
861 /// VisitedVirtualBases - Visited virtual bases.
862 llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBases;
863
864 /// VCallOffsets - Keeps track of vcall offsets.
865 VCallOffsetMap VCallOffsets;
866
Anders Carlssonbb6305b2010-03-11 06:43:12 +0000867
868 /// VBaseOffsetOffsets - Contains the offsets of the virtual base offsets,
869 /// relative to the address point.
870 VBaseOffsetOffsetsMapTy VBaseOffsetOffsets;
871
Anders Carlssond68c0832010-02-25 03:45:56 +0000872 /// FinalOverriders - The final overriders of the most derived class.
873 /// (Can be null when we're not building a vtable of the most derived class).
874 const FinalOverriders *Overriders;
875
876 /// AddVCallAndVBaseOffsets - Add vcall offsets and vbase offsets for the
877 /// given base subobject.
878 void AddVCallAndVBaseOffsets(BaseSubobject Base, bool BaseIsVirtual,
879 uint64_t RealBaseOffset);
880
881 /// AddVCallOffsets - Add vcall offsets for the given base subobject.
882 void AddVCallOffsets(BaseSubobject Base, uint64_t VBaseOffset);
883
884 /// AddVBaseOffsets - Add vbase offsets for the given class.
Anders Carlsson88800662010-03-02 05:40:45 +0000885 void AddVBaseOffsets(const CXXRecordDecl *Base, uint64_t OffsetInLayoutClass);
Anders Carlssond68c0832010-02-25 03:45:56 +0000886
Anders Carlssonbb6305b2010-03-11 06:43:12 +0000887 /// getCurrentOffsetOffset - Get the current vcall or vbase offset offset in
888 /// bytes, relative to the vtable address point.
889 int64_t getCurrentOffsetOffset() const;
890
Anders Carlssond68c0832010-02-25 03:45:56 +0000891public:
892 VCallAndVBaseOffsetBuilder(const CXXRecordDecl *MostDerivedClass,
Anders Carlsson0041a642010-02-27 21:09:00 +0000893 const CXXRecordDecl *LayoutClass,
Anders Carlssond68c0832010-02-25 03:45:56 +0000894 const FinalOverriders *Overriders,
Anders Carlsson530c40c2010-02-28 01:43:58 +0000895 BaseSubobject Base, bool BaseIsVirtual,
896 uint64_t OffsetInLayoutClass)
897 : MostDerivedClass(MostDerivedClass), LayoutClass(LayoutClass),
Anders Carlssond68c0832010-02-25 03:45:56 +0000898 Context(MostDerivedClass->getASTContext()), Overriders(Overriders) {
899
900 // Add vcall and vbase offsets.
Anders Carlsson530c40c2010-02-28 01:43:58 +0000901 AddVCallAndVBaseOffsets(Base, BaseIsVirtual, OffsetInLayoutClass);
Anders Carlssond68c0832010-02-25 03:45:56 +0000902 }
903
904 /// Methods for iterating over the components.
Anders Carlsson94464812010-04-10 19:13:06 +0000905 typedef VTableComponentVectorTy::const_reverse_iterator const_iterator;
Anders Carlssond68c0832010-02-25 03:45:56 +0000906 const_iterator components_begin() const { return Components.rbegin(); }
907 const_iterator components_end() const { return Components.rend(); }
908
Anders Carlssonc89a7cf2010-03-11 16:06:20 +0000909 const VCallOffsetMap &getVCallOffsets() const { return VCallOffsets; }
910 const VBaseOffsetOffsetsMapTy &getVBaseOffsetOffsets() const {
Anders Carlssonbb6305b2010-03-11 06:43:12 +0000911 return VBaseOffsetOffsets;
912 }
Anders Carlssond68c0832010-02-25 03:45:56 +0000913};
914
915void
916VCallAndVBaseOffsetBuilder::AddVCallAndVBaseOffsets(BaseSubobject Base,
917 bool BaseIsVirtual,
918 uint64_t RealBaseOffset) {
919 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Base.getBase());
920
921 // Itanium C++ ABI 2.5.2:
922 // ..in classes sharing a virtual table with a primary base class, the vcall
923 // and vbase offsets added by the derived class all come before the vcall
924 // and vbase offsets required by the base class, so that the latter may be
925 // laid out as required by the base class without regard to additions from
926 // the derived class(es).
927
928 // (Since we're emitting the vcall and vbase offsets in reverse order, we'll
929 // emit them for the primary base first).
930 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
931 bool PrimaryBaseIsVirtual = Layout.getPrimaryBaseWasVirtual();
932
933 uint64_t PrimaryBaseOffset;
934
935 // Get the base offset of the primary base.
936 if (PrimaryBaseIsVirtual) {
937 assert(Layout.getVBaseClassOffset(PrimaryBase) == 0 &&
938 "Primary vbase should have a zero offset!");
939
940 const ASTRecordLayout &MostDerivedClassLayout =
941 Context.getASTRecordLayout(MostDerivedClass);
942
943 PrimaryBaseOffset =
944 MostDerivedClassLayout.getVBaseClassOffset(PrimaryBase);
945 } else {
946 assert(Layout.getBaseClassOffset(PrimaryBase) == 0 &&
947 "Primary base should have a zero offset!");
948
949 PrimaryBaseOffset = Base.getBaseOffset();
950 }
951
952 AddVCallAndVBaseOffsets(BaseSubobject(PrimaryBase, PrimaryBaseOffset),
953 PrimaryBaseIsVirtual, RealBaseOffset);
954 }
955
Anders Carlsson88800662010-03-02 05:40:45 +0000956 AddVBaseOffsets(Base.getBase(), RealBaseOffset);
Anders Carlssond68c0832010-02-25 03:45:56 +0000957
958 // We only want to add vcall offsets for virtual bases.
959 if (BaseIsVirtual)
960 AddVCallOffsets(Base, RealBaseOffset);
961}
962
Anders Carlssonbb6305b2010-03-11 06:43:12 +0000963int64_t VCallAndVBaseOffsetBuilder::getCurrentOffsetOffset() const {
964 // OffsetIndex is the index of this vcall or vbase offset, relative to the
965 // vtable address point. (We subtract 3 to account for the information just
966 // above the address point, the RTTI info, the offset to top, and the
967 // vcall offset itself).
968 int64_t OffsetIndex = -(int64_t)(3 + Components.size());
969
970 // FIXME: We shouldn't use / 8 here.
971 int64_t OffsetOffset = OffsetIndex *
972 (int64_t)Context.Target.getPointerWidth(0) / 8;
973
974 return OffsetOffset;
975}
976
Anders Carlssond68c0832010-02-25 03:45:56 +0000977void VCallAndVBaseOffsetBuilder::AddVCallOffsets(BaseSubobject Base,
978 uint64_t VBaseOffset) {
979 const CXXRecordDecl *RD = Base.getBase();
980 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
981
John McCall331a03a2010-02-26 20:22:44 +0000982 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
983
Anders Carlssond68c0832010-02-25 03:45:56 +0000984 // Handle the primary base first.
Anders Carlssonaf6ddf22010-04-11 20:04:11 +0000985 // We only want to add vcall offsets if the base is non-virtual; a virtual
986 // primary base will have its vcall and vbase offsets emitted already.
987 if (PrimaryBase && !Layout.getPrimaryBaseWasVirtual()) {
Anders Carlssond68c0832010-02-25 03:45:56 +0000988 // Get the base offset of the primary base.
Anders Carlssonaf6ddf22010-04-11 20:04:11 +0000989 assert(Layout.getBaseClassOffset(PrimaryBase) == 0 &&
990 "Primary base should have a zero offset!");
Anders Carlssond68c0832010-02-25 03:45:56 +0000991
Anders Carlssonaf6ddf22010-04-11 20:04:11 +0000992 AddVCallOffsets(BaseSubobject(PrimaryBase, Base.getBaseOffset()),
Anders Carlssond68c0832010-02-25 03:45:56 +0000993 VBaseOffset);
994 }
Anders Carlssonaf6ddf22010-04-11 20:04:11 +0000995
Anders Carlssond68c0832010-02-25 03:45:56 +0000996 // Add the vcall offsets.
997 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
998 E = RD->method_end(); I != E; ++I) {
999 const CXXMethodDecl *MD = *I;
1000
1001 if (!MD->isVirtual())
1002 continue;
1003
Anders Carlssonbb6305b2010-03-11 06:43:12 +00001004 int64_t OffsetOffset = getCurrentOffsetOffset();
Anders Carlssond68c0832010-02-25 03:45:56 +00001005
1006 // Don't add a vcall offset if we already have one for this member function
1007 // signature.
1008 if (!VCallOffsets.AddVCallOffset(MD, OffsetOffset))
1009 continue;
1010
1011 int64_t Offset = 0;
1012
1013 if (Overriders) {
1014 // Get the final overrider.
1015 FinalOverriders::OverriderInfo Overrider =
1016 Overriders->getOverrider(Base, MD);
1017
Anders Carlsson438bc422010-02-28 00:10:58 +00001018 /// The vcall offset is the offset from the virtual base to the object
1019 /// where the function was overridden.
Anders Carlssond68c0832010-02-25 03:45:56 +00001020 // FIXME: We should not use / 8 here.
Anders Carlssond86e5d82010-03-02 03:44:06 +00001021 Offset = (int64_t)(Overrider.Offset - VBaseOffset) / 8;
Anders Carlssond68c0832010-02-25 03:45:56 +00001022 }
1023
Anders Carlsson94464812010-04-10 19:13:06 +00001024 Components.push_back(VTableComponent::MakeVCallOffset(Offset));
Anders Carlssond68c0832010-02-25 03:45:56 +00001025 }
1026
1027 // And iterate over all non-virtual bases (ignoring the primary base).
1028 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1029 E = RD->bases_end(); I != E; ++I) {
1030
1031 if (I->isVirtual())
1032 continue;
1033
1034 const CXXRecordDecl *BaseDecl =
1035 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
John McCall331a03a2010-02-26 20:22:44 +00001036 if (BaseDecl == PrimaryBase)
1037 continue;
Anders Carlssond68c0832010-02-25 03:45:56 +00001038
1039 // Get the base offset of this base.
1040 uint64_t BaseOffset = Base.getBaseOffset() +
1041 Layout.getBaseClassOffset(BaseDecl);
1042
1043 AddVCallOffsets(BaseSubobject(BaseDecl, BaseOffset), VBaseOffset);
1044 }
1045}
1046
Anders Carlssond68c0832010-02-25 03:45:56 +00001047void VCallAndVBaseOffsetBuilder::AddVBaseOffsets(const CXXRecordDecl *RD,
Anders Carlsson88800662010-03-02 05:40:45 +00001048 uint64_t OffsetInLayoutClass) {
Anders Carlsson0041a642010-02-27 21:09:00 +00001049 const ASTRecordLayout &LayoutClassLayout =
1050 Context.getASTRecordLayout(LayoutClass);
Anders Carlssond68c0832010-02-25 03:45:56 +00001051
1052 // Add vbase offsets.
1053 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1054 E = RD->bases_end(); I != E; ++I) {
1055 const CXXRecordDecl *BaseDecl =
1056 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1057
1058 // Check if this is a virtual base that we haven't visited before.
1059 if (I->isVirtual() && VisitedVirtualBases.insert(BaseDecl)) {
1060 // FIXME: We shouldn't use / 8 here.
Anders Carlsson88800662010-03-02 05:40:45 +00001061 int64_t Offset =
1062 (int64_t)(LayoutClassLayout.getVBaseClassOffset(BaseDecl) -
1063 OffsetInLayoutClass) / 8;
Anders Carlssonbb6305b2010-03-11 06:43:12 +00001064
1065 // Add the vbase offset offset.
1066 assert(!VBaseOffsetOffsets.count(BaseDecl) &&
1067 "vbase offset offset already exists!");
1068
1069 int64_t VBaseOffsetOffset = getCurrentOffsetOffset();
1070 VBaseOffsetOffsets.insert(std::make_pair(BaseDecl, VBaseOffsetOffset));
1071
Anders Carlsson94464812010-04-10 19:13:06 +00001072 Components.push_back(VTableComponent::MakeVBaseOffset(Offset));
Anders Carlssond68c0832010-02-25 03:45:56 +00001073 }
Anders Carlssonbb6305b2010-03-11 06:43:12 +00001074
Anders Carlssond68c0832010-02-25 03:45:56 +00001075 // Check the base class looking for more vbase offsets.
Anders Carlsson88800662010-03-02 05:40:45 +00001076 AddVBaseOffsets(BaseDecl, OffsetInLayoutClass);
Anders Carlssond68c0832010-02-25 03:45:56 +00001077 }
1078}
1079
Anders Carlsson94464812010-04-10 19:13:06 +00001080/// VTableBuilder - Class for building vtable layout information.
1081class VTableBuilder {
Anders Carlsson57071e22010-02-12 05:25:12 +00001082public:
Anders Carlssonb9021e92010-02-27 16:18:19 +00001083 /// PrimaryBasesSetVectorTy - A set vector of direct and indirect
1084 /// primary bases.
1085 typedef llvm::SmallSetVector<const CXXRecordDecl *, 8>
1086 PrimaryBasesSetVectorTy;
1087
Anders Carlssonccd83d72010-03-24 16:42:11 +00001088 typedef llvm::DenseMap<const CXXRecordDecl *, int64_t>
1089 VBaseOffsetOffsetsMapTy;
Anders Carlsson66d567d2010-03-25 00:51:13 +00001090
1091 typedef llvm::DenseMap<BaseSubobject, uint64_t>
1092 AddressPointsMapTy;
Anders Carlssonccd83d72010-03-24 16:42:11 +00001093
Anders Carlsson57071e22010-02-12 05:25:12 +00001094private:
Anders Carlssonaf440352010-03-23 04:11:45 +00001095 /// VTables - Global vtable information.
1096 CodeGenVTables &VTables;
Anders Carlsson60db0ee2010-02-13 21:07:32 +00001097
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001098 /// MostDerivedClass - The most derived class for which we're building this
1099 /// vtable.
1100 const CXXRecordDecl *MostDerivedClass;
1101
Anders Carlssond03a3262010-02-27 20:39:05 +00001102 /// MostDerivedClassOffset - If we're building a construction vtable, this
1103 /// holds the offset from the layout class to the most derived class.
1104 const uint64_t MostDerivedClassOffset;
1105
Anders Carlsson5d7af6b2010-02-28 00:36:23 +00001106 /// MostDerivedClassIsVirtual - Whether the most derived class is a virtual
1107 /// base. (This only makes sense when building a construction vtable).
1108 bool MostDerivedClassIsVirtual;
1109
Anders Carlssond03a3262010-02-27 20:39:05 +00001110 /// LayoutClass - The class we're using for layout information. Will be
1111 /// different than the most derived class if we're building a construction
1112 /// vtable.
1113 const CXXRecordDecl *LayoutClass;
1114
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001115 /// Context - The ASTContext which we will use for layout information.
Anders Carlsson57071e22010-02-12 05:25:12 +00001116 ASTContext &Context;
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001117
Anders Carlssonbdf73d82010-02-11 21:24:32 +00001118 /// FinalOverriders - The final overriders of the most derived class.
Anders Carlssond68c0832010-02-25 03:45:56 +00001119 const FinalOverriders Overriders;
Anders Carlssonbdf73d82010-02-11 21:24:32 +00001120
Anders Carlssondba6ef82010-02-25 22:23:13 +00001121 /// VCallOffsetsForVBases - Keeps track of vcall offsets for the virtual
1122 /// bases in this vtable.
1123 llvm::DenseMap<const CXXRecordDecl *, VCallOffsetMap> VCallOffsetsForVBases;
Anders Carlsson60cc72a2010-02-18 17:00:09 +00001124
Anders Carlssonbb6305b2010-03-11 06:43:12 +00001125 /// VBaseOffsetOffsets - Contains the offsets of the virtual base offsets for
1126 /// the most derived class.
1127 VBaseOffsetOffsetsMapTy VBaseOffsetOffsets;
1128
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001129 /// Components - The components of the vtable being built.
Anders Carlsson94464812010-04-10 19:13:06 +00001130 llvm::SmallVector<VTableComponent, 64> Components;
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001131
Anders Carlsson822307b2010-02-11 17:18:51 +00001132 /// AddressPoints - Address points for the vtable being built.
Anders Carlssonff143f82010-03-25 00:35:49 +00001133 AddressPointsMapTy AddressPoints;
Anders Carlsson822307b2010-02-11 17:18:51 +00001134
Anders Carlssonb9021e92010-02-27 16:18:19 +00001135 /// MethodInfo - Contains information about a method in a vtable.
1136 /// (Used for computing 'this' pointer adjustment thunks.
1137 struct MethodInfo {
1138 /// BaseOffset - The base offset of this method.
1139 const uint64_t BaseOffset;
1140
Anders Carlsson2bc1d3a2010-03-10 21:25:37 +00001141 /// BaseOffsetInLayoutClass - The base offset in the layout class of this
1142 /// method.
1143 const uint64_t BaseOffsetInLayoutClass;
1144
Anders Carlsson718d0692010-04-11 22:07:06 +00001145 /// VTableIndex - The index in the vtable that this method has.
Anders Carlssonb9021e92010-02-27 16:18:19 +00001146 /// (For destructors, this is the index of the complete destructor).
Anders Carlsson718d0692010-04-11 22:07:06 +00001147 const uint64_t VTableIndex;
Anders Carlssonb9021e92010-02-27 16:18:19 +00001148
Anders Carlsson2bc1d3a2010-03-10 21:25:37 +00001149 MethodInfo(uint64_t BaseOffset, uint64_t BaseOffsetInLayoutClass,
Anders Carlsson718d0692010-04-11 22:07:06 +00001150 uint64_t VTableIndex)
Anders Carlsson2bc1d3a2010-03-10 21:25:37 +00001151 : BaseOffset(BaseOffset),
1152 BaseOffsetInLayoutClass(BaseOffsetInLayoutClass),
Anders Carlsson718d0692010-04-11 22:07:06 +00001153 VTableIndex(VTableIndex) { }
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001154
Anders Carlsson718d0692010-04-11 22:07:06 +00001155 MethodInfo() : BaseOffset(0), BaseOffsetInLayoutClass(0), VTableIndex(0) { }
Anders Carlssonb9021e92010-02-27 16:18:19 +00001156 };
1157
1158 typedef llvm::DenseMap<const CXXMethodDecl *, MethodInfo> MethodInfoMapTy;
1159
1160 /// MethodInfoMap - The information for all methods in the vtable we're
1161 /// currently building.
1162 MethodInfoMapTy MethodInfoMap;
1163
Anders Carlsson718d0692010-04-11 22:07:06 +00001164 typedef llvm::DenseMap<uint64_t, ThunkInfo> VTableThunksMapTy;
Anders Carlssondd366812010-03-12 04:54:20 +00001165
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00001166 /// VTableThunks - The thunks by vtable index in the vtable currently being
1167 /// built.
Anders Carlsson718d0692010-04-11 22:07:06 +00001168 VTableThunksMapTy VTableThunks;
Anders Carlssonb9021e92010-02-27 16:18:19 +00001169
Anders Carlssonee5ab9f2010-03-23 04:59:02 +00001170 typedef llvm::SmallVector<ThunkInfo, 1> ThunkInfoVectorTy;
1171 typedef llvm::DenseMap<const CXXMethodDecl *, ThunkInfoVectorTy> ThunksMapTy;
Anders Carlsson5e454aa2010-03-17 20:06:32 +00001172
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00001173 /// Thunks - A map that contains all the thunks needed for all methods in the
1174 /// most derived class for which the vtable is currently being built.
Anders Carlssonee5ab9f2010-03-23 04:59:02 +00001175 ThunksMapTy Thunks;
Anders Carlsson5e454aa2010-03-17 20:06:32 +00001176
1177 /// AddThunk - Add a thunk for the given method.
Anders Carlsson9d734f32010-03-21 20:27:14 +00001178 void AddThunk(const CXXMethodDecl *MD, const ThunkInfo &Thunk);
Anders Carlsson5e454aa2010-03-17 20:06:32 +00001179
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001180 /// ComputeThisAdjustments - Compute the 'this' pointer adjustments for the
1181 /// part of the vtable we're currently building.
1182 void ComputeThisAdjustments();
1183
Anders Carlssona661a542010-02-16 04:49:44 +00001184 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
1185
Anders Carlssonb9021e92010-02-27 16:18:19 +00001186 /// PrimaryVirtualBases - All known virtual bases who are a primary base of
Anders Carlssonaf280c02010-02-23 03:48:14 +00001187 /// some other base.
1188 VisitedVirtualBasesSetTy PrimaryVirtualBases;
1189
Anders Carlsson60db0ee2010-02-13 21:07:32 +00001190 /// ComputeReturnAdjustment - Compute the return adjustment given a return
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001191 /// adjustment base offset.
Anders Carlsson2fca9be2010-02-23 01:34:28 +00001192 ReturnAdjustment ComputeReturnAdjustment(BaseOffset Offset);
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001193
Anders Carlsson379017f2010-02-27 19:57:44 +00001194 /// ComputeThisAdjustmentBaseOffset - Compute the base offset for adjusting
1195 /// the 'this' pointer from the base subobject to the derived subobject.
1196 BaseOffset ComputeThisAdjustmentBaseOffset(BaseSubobject Base,
1197 BaseSubobject Derived) const;
1198
Anders Carlsson60cc72a2010-02-18 17:00:09 +00001199 /// ComputeThisAdjustment - Compute the 'this' pointer adjustment for the
Anders Carlsson617def32010-03-12 05:28:07 +00001200 /// given virtual member function, its offset in the layout class and its
1201 /// final overrider.
1202 ThisAdjustment
1203 ComputeThisAdjustment(const CXXMethodDecl *MD,
1204 uint64_t BaseOffsetInLayoutClass,
1205 FinalOverriders::OverriderInfo Overrider);
1206
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001207 /// AddMethod - Add a single virtual member function to the vtable
1208 /// components vector.
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001209 void AddMethod(const CXXMethodDecl *MD, ReturnAdjustment ReturnAdjustment);
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001210
Anders Carlsson464c8f12010-02-23 04:26:39 +00001211 /// IsOverriderUsed - Returns whether the overrider will ever be used in this
1212 /// part of the vtable.
1213 ///
1214 /// Itanium C++ ABI 2.5.2:
1215 ///
1216 /// struct A { virtual void f(); };
1217 /// struct B : virtual public A { int i; };
1218 /// struct C : virtual public A { int j; };
1219 /// struct D : public B, public C {};
1220 ///
1221 /// When B and C are declared, A is a primary base in each case, so although
1222 /// vcall offsets are allocated in the A-in-B and A-in-C vtables, no this
1223 /// adjustment is required and no thunk is generated. However, inside D
1224 /// objects, A is no longer a primary base of C, so if we allowed calls to
1225 /// C::f() to use the copy of A's vtable in the C subobject, we would need
1226 /// to adjust this from C* to B::A*, which would require a third-party
1227 /// thunk. Since we require that a call to C::f() first convert to A*,
1228 /// C-in-D's copy of A's vtable is never referenced, so this is not
1229 /// necessary.
Anders Carlsson60396612010-03-10 06:51:42 +00001230 bool IsOverriderUsed(const CXXMethodDecl *Overrider,
1231 uint64_t BaseOffsetInLayoutClass,
1232 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
1233 uint64_t FirstBaseOffsetInLayoutClass) const;
1234
Anders Carlsson464c8f12010-02-23 04:26:39 +00001235
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001236 /// AddMethods - Add the methods of this base subobject and all its
1237 /// primary bases to the vtable components vector.
Anders Carlsson60396612010-03-10 06:51:42 +00001238 void AddMethods(BaseSubobject Base, uint64_t BaseOffsetInLayoutClass,
1239 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
1240 uint64_t FirstBaseOffsetInLayoutClass,
Anders Carlssonb9021e92010-02-27 16:18:19 +00001241 PrimaryBasesSetVectorTy &PrimaryBases);
Anders Carlsson89ad4212010-02-16 16:26:28 +00001242
Anders Carlsson718d0692010-04-11 22:07:06 +00001243 // LayoutVTable - Layout the vtable for the given base class, including its
Anders Carlsson89ad4212010-02-16 16:26:28 +00001244 // secondary vtables and any vtables for virtual bases.
Anders Carlsson718d0692010-04-11 22:07:06 +00001245 void LayoutVTable();
Anders Carlsson89ad4212010-02-16 16:26:28 +00001246
Anders Carlsson718d0692010-04-11 22:07:06 +00001247 /// LayoutPrimaryAndSecondaryVTables - Layout the primary vtable for the
Anders Carlsson89ad4212010-02-16 16:26:28 +00001248 /// given base subobject, as well as all its secondary vtables.
Anders Carlsson91232842010-04-11 22:03:57 +00001249 ///
Anders Carlsson73e6fa02010-04-11 22:20:36 +00001250 /// \param BaseIsMorallyVirtual whether the base subobject is a virtual base
1251 /// or a direct or indirect base of a virtual base.
1252 ///
Anders Carlsson91232842010-04-11 22:03:57 +00001253 /// \param BaseIsVirtualInLayoutClass - Whether the base subobject is virtual
1254 /// in the layout class.
Anders Carlsson718d0692010-04-11 22:07:06 +00001255 void LayoutPrimaryAndSecondaryVTables(BaseSubobject Base,
Anders Carlsson73e6fa02010-04-11 22:20:36 +00001256 bool BaseIsMorallyVirtual,
Anders Carlsson91232842010-04-11 22:03:57 +00001257 bool BaseIsVirtualInLayoutClass,
Anders Carlsson530c40c2010-02-28 01:43:58 +00001258 uint64_t OffsetInLayoutClass);
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001259
Anders Carlsson718d0692010-04-11 22:07:06 +00001260 /// LayoutSecondaryVTables - Layout the secondary vtables for the given base
Anders Carlssonc7b63162010-02-16 16:02:57 +00001261 /// subobject.
Anders Carlssona96a2e92010-03-10 19:39:11 +00001262 ///
1263 /// \param BaseIsMorallyVirtual whether the base subobject is a virtual base
1264 /// or a direct or indirect base of a virtual base.
Anders Carlsson718d0692010-04-11 22:07:06 +00001265 void LayoutSecondaryVTables(BaseSubobject Base, bool BaseIsMorallyVirtual,
Anders Carlssona96a2e92010-03-10 19:39:11 +00001266 uint64_t OffsetInLayoutClass);
Anders Carlsson08c26752010-02-27 04:05:52 +00001267
1268 /// DeterminePrimaryVirtualBases - Determine the primary virtual bases in this
1269 /// class hierarchy.
1270 void DeterminePrimaryVirtualBases(const CXXRecordDecl *RD,
Anders Carlssond7fdae52010-03-10 03:02:01 +00001271 uint64_t OffsetInLayoutClass,
Anders Carlsson08c26752010-02-27 04:05:52 +00001272 VisitedVirtualBasesSetTy &VBases);
1273
Anders Carlsson718d0692010-04-11 22:07:06 +00001274 /// LayoutVTablesForVirtualBases - Layout vtables for all virtual bases of the
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001275 /// given base (excluding any primary bases).
Anders Carlsson718d0692010-04-11 22:07:06 +00001276 void LayoutVTablesForVirtualBases(const CXXRecordDecl *RD,
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001277 VisitedVirtualBasesSetTy &VBases);
1278
Anders Carlsson718d0692010-04-11 22:07:06 +00001279 /// isBuildingConstructionVTable - Return whether this vtable builder is
Anders Carlsson438bc422010-02-28 00:10:58 +00001280 /// building a construction vtable.
Anders Carlsson718d0692010-04-11 22:07:06 +00001281 bool isBuildingConstructorVTable() const {
Anders Carlsson438bc422010-02-28 00:10:58 +00001282 return MostDerivedClass != LayoutClass;
1283 }
1284
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001285public:
Anders Carlsson94464812010-04-10 19:13:06 +00001286 VTableBuilder(CodeGenVTables &VTables, const CXXRecordDecl *MostDerivedClass,
Anders Carlsson5d7af6b2010-02-28 00:36:23 +00001287 uint64_t MostDerivedClassOffset, bool MostDerivedClassIsVirtual,
Anders Carlssond03a3262010-02-27 20:39:05 +00001288 const CXXRecordDecl *LayoutClass)
Anders Carlssonaf440352010-03-23 04:11:45 +00001289 : VTables(VTables), MostDerivedClass(MostDerivedClass),
Anders Carlsson5d7af6b2010-02-28 00:36:23 +00001290 MostDerivedClassOffset(MostDerivedClassOffset),
1291 MostDerivedClassIsVirtual(MostDerivedClassIsVirtual),
1292 LayoutClass(LayoutClass), Context(MostDerivedClass->getASTContext()),
Anders Carlssondb4022c2010-03-10 02:33:41 +00001293 Overriders(MostDerivedClass, MostDerivedClassOffset, LayoutClass) {
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001294
Anders Carlsson718d0692010-04-11 22:07:06 +00001295 LayoutVTable();
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001296 }
1297
Anders Carlssonfbf6ed42010-03-23 16:36:50 +00001298 ThunksMapTy::const_iterator thunks_begin() const {
1299 return Thunks.begin();
1300 }
1301
1302 ThunksMapTy::const_iterator thunks_end() const {
1303 return Thunks.end();
1304 }
1305
Anders Carlssonccd83d72010-03-24 16:42:11 +00001306 const VBaseOffsetOffsetsMapTy &getVBaseOffsetOffsets() const {
1307 return VBaseOffsetOffsets;
1308 }
1309
1310 /// getNumVTableComponents - Return the number of components in the vtable
1311 /// currently built.
1312 uint64_t getNumVTableComponents() const {
1313 return Components.size();
1314 }
1315
Anders Carlsson66d567d2010-03-25 00:51:13 +00001316 const uint64_t *vtable_components_data_begin() const {
Anders Carlssonccd83d72010-03-24 16:42:11 +00001317 return reinterpret_cast<const uint64_t *>(Components.begin());
1318 }
1319
Anders Carlsson66d567d2010-03-25 00:51:13 +00001320 const uint64_t *vtable_components_data_end() const {
Anders Carlssonccd83d72010-03-24 16:42:11 +00001321 return reinterpret_cast<const uint64_t *>(Components.end());
1322 }
1323
Anders Carlsson66d567d2010-03-25 00:51:13 +00001324 AddressPointsMapTy::const_iterator address_points_begin() const {
1325 return AddressPoints.begin();
1326 }
1327
1328 AddressPointsMapTy::const_iterator address_points_end() const {
1329 return AddressPoints.end();
1330 }
1331
Anders Carlsson718d0692010-04-11 22:07:06 +00001332 VTableThunksMapTy::const_iterator vtable_thunks_begin() const {
Anders Carlsson0d1407e2010-03-25 15:26:28 +00001333 return VTableThunks.begin();
1334 }
1335
Anders Carlsson718d0692010-04-11 22:07:06 +00001336 VTableThunksMapTy::const_iterator vtable_thunks_end() const {
Anders Carlsson0d1407e2010-03-25 15:26:28 +00001337 return VTableThunks.end();
1338 }
1339
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001340 /// dumpLayout - Dump the vtable layout.
1341 void dumpLayout(llvm::raw_ostream&);
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001342};
1343
Anders Carlsson94464812010-04-10 19:13:06 +00001344void VTableBuilder::AddThunk(const CXXMethodDecl *MD, const ThunkInfo &Thunk) {
Anders Carlsson718d0692010-04-11 22:07:06 +00001345 assert(!isBuildingConstructorVTable() &&
Anders Carlssonbca5d372010-03-22 20:06:40 +00001346 "Can't add thunks for construction vtable");
Anders Carlsson9135a842010-03-18 02:44:19 +00001347
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00001348 llvm::SmallVector<ThunkInfo, 1> &ThunksVector = Thunks[MD];
Anders Carlsson5e454aa2010-03-17 20:06:32 +00001349
1350 // Check if we have this thunk already.
1351 if (std::find(ThunksVector.begin(), ThunksVector.end(), Thunk) !=
1352 ThunksVector.end())
1353 return;
1354
1355 ThunksVector.push_back(Thunk);
1356}
1357
Anders Carlssonf622b452010-04-10 20:39:29 +00001358typedef llvm::SmallPtrSet<const CXXMethodDecl *, 8> OverriddenMethodsSetTy;
1359
1360/// ComputeAllOverriddenMethods - Given a method decl, will return a set of all
1361/// the overridden methods that the function decl overrides.
1362static void
1363ComputeAllOverriddenMethods(const CXXMethodDecl *MD,
1364 OverriddenMethodsSetTy& OverriddenMethods) {
1365 assert(MD->isVirtual() && "Method is not virtual!");
1366
Anders Carlsson57071e22010-02-12 05:25:12 +00001367 for (CXXMethodDecl::method_iterator I = MD->begin_overridden_methods(),
1368 E = MD->end_overridden_methods(); I != E; ++I) {
1369 const CXXMethodDecl *OverriddenMD = *I;
Anders Carlsson57071e22010-02-12 05:25:12 +00001370
Anders Carlssonf622b452010-04-10 20:39:29 +00001371 OverriddenMethods.insert(OverriddenMD);
1372
1373 ComputeAllOverriddenMethods(OverriddenMD, OverriddenMethods);
Anders Carlsson57071e22010-02-12 05:25:12 +00001374 }
Anders Carlsson57071e22010-02-12 05:25:12 +00001375}
1376
Anders Carlsson94464812010-04-10 19:13:06 +00001377void VTableBuilder::ComputeThisAdjustments() {
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001378 // Now go through the method info map and see if any of the methods need
1379 // 'this' pointer adjustments.
1380 for (MethodInfoMapTy::const_iterator I = MethodInfoMap.begin(),
1381 E = MethodInfoMap.end(); I != E; ++I) {
1382 const CXXMethodDecl *MD = I->first;
1383 const MethodInfo &MethodInfo = I->second;
1384
Anders Carlsson617def32010-03-12 05:28:07 +00001385 // Ignore adjustments for unused function pointers.
Anders Carlsson718d0692010-04-11 22:07:06 +00001386 uint64_t VTableIndex = MethodInfo.VTableIndex;
1387 if (Components[VTableIndex].getKind() ==
Anders Carlsson94464812010-04-10 19:13:06 +00001388 VTableComponent::CK_UnusedFunctionPointer)
Anders Carlsson617def32010-03-12 05:28:07 +00001389 continue;
1390
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001391 // Get the final overrider for this method.
1392 FinalOverriders::OverriderInfo Overrider =
Anders Carlsson2bc1d3a2010-03-10 21:25:37 +00001393 Overriders.getOverrider(BaseSubobject(MD->getParent(),
1394 MethodInfo.BaseOffset), MD);
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001395
Anders Carlssonbca5d372010-03-22 20:06:40 +00001396 // Check if we need an adjustment at all.
Anders Carlssonadb507d2010-03-29 15:08:41 +00001397 if (MethodInfo.BaseOffsetInLayoutClass == Overrider.Offset) {
1398 // When a return thunk is needed by a derived class that overrides a
1399 // virtual base, gcc uses a virtual 'this' adjustment as well.
1400 // While the thunk itself might be needed by vtables in subclasses or
1401 // in construction vtables, there doesn't seem to be a reason for using
1402 // the thunk in this vtable. Still, we do so to match gcc.
Anders Carlsson718d0692010-04-11 22:07:06 +00001403 if (VTableThunks.lookup(VTableIndex).Return.isEmpty())
Anders Carlssonadb507d2010-03-29 15:08:41 +00001404 continue;
1405 }
Anders Carlssonbca5d372010-03-22 20:06:40 +00001406
Anders Carlsson617def32010-03-12 05:28:07 +00001407 ThisAdjustment ThisAdjustment =
1408 ComputeThisAdjustment(MD, MethodInfo.BaseOffsetInLayoutClass, Overrider);
1409
1410 if (ThisAdjustment.isEmpty())
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001411 continue;
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001412
Anders Carlssoncd4e6372010-02-27 18:09:40 +00001413 // Add it.
Anders Carlsson718d0692010-04-11 22:07:06 +00001414 VTableThunks[VTableIndex].This = ThisAdjustment;
Anders Carlsson617def32010-03-12 05:28:07 +00001415
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001416 if (isa<CXXDestructorDecl>(MD)) {
1417 // Add an adjustment for the deleting destructor as well.
Anders Carlsson718d0692010-04-11 22:07:06 +00001418 VTableThunks[VTableIndex + 1].This = ThisAdjustment;
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001419 }
1420 }
1421
1422 /// Clear the method info map.
1423 MethodInfoMap.clear();
Anders Carlsson25394212010-03-22 15:47:01 +00001424
Anders Carlsson718d0692010-04-11 22:07:06 +00001425 if (isBuildingConstructorVTable()) {
Anders Carlsson25394212010-03-22 15:47:01 +00001426 // We don't need to store thunk information for construction vtables.
1427 return;
1428 }
1429
Anders Carlsson718d0692010-04-11 22:07:06 +00001430 for (VTableThunksMapTy::const_iterator I = VTableThunks.begin(),
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00001431 E = VTableThunks.end(); I != E; ++I) {
Anders Carlsson94464812010-04-10 19:13:06 +00001432 const VTableComponent &Component = Components[I->first];
Anders Carlsson25394212010-03-22 15:47:01 +00001433 const ThunkInfo &Thunk = I->second;
Anders Carlssonbca5d372010-03-22 20:06:40 +00001434 const CXXMethodDecl *MD;
Anders Carlsson25394212010-03-22 15:47:01 +00001435
1436 switch (Component.getKind()) {
1437 default:
1438 llvm_unreachable("Unexpected vtable component kind!");
Anders Carlsson94464812010-04-10 19:13:06 +00001439 case VTableComponent::CK_FunctionPointer:
Anders Carlssonbca5d372010-03-22 20:06:40 +00001440 MD = Component.getFunctionDecl();
Anders Carlsson25394212010-03-22 15:47:01 +00001441 break;
Anders Carlsson94464812010-04-10 19:13:06 +00001442 case VTableComponent::CK_CompleteDtorPointer:
Anders Carlssonbca5d372010-03-22 20:06:40 +00001443 MD = Component.getDestructorDecl();
Anders Carlsson25394212010-03-22 15:47:01 +00001444 break;
Anders Carlsson94464812010-04-10 19:13:06 +00001445 case VTableComponent::CK_DeletingDtorPointer:
Anders Carlsson25394212010-03-22 15:47:01 +00001446 // We've already added the thunk when we saw the complete dtor pointer.
Anders Carlssonbca5d372010-03-22 20:06:40 +00001447 continue;
Anders Carlsson25394212010-03-22 15:47:01 +00001448 }
Anders Carlssonbca5d372010-03-22 20:06:40 +00001449
1450 if (MD->getParent() == MostDerivedClass)
1451 AddThunk(MD, Thunk);
Anders Carlsson25394212010-03-22 15:47:01 +00001452 }
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001453}
1454
Anders Carlsson94464812010-04-10 19:13:06 +00001455ReturnAdjustment VTableBuilder::ComputeReturnAdjustment(BaseOffset Offset) {
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001456 ReturnAdjustment Adjustment;
1457
1458 if (!Offset.isEmpty()) {
Anders Carlsson60db0ee2010-02-13 21:07:32 +00001459 if (Offset.VirtualBase) {
1460 // Get the virtual base offset offset.
Anders Carlsson1972ced2010-03-11 07:00:45 +00001461 if (Offset.DerivedClass == MostDerivedClass) {
1462 // We can get the offset offset directly from our map.
1463 Adjustment.VBaseOffsetOffset =
1464 VBaseOffsetOffsets.lookup(Offset.VirtualBase);
1465 } else {
1466 Adjustment.VBaseOffsetOffset =
Anders Carlssonaf440352010-03-23 04:11:45 +00001467 VTables.getVirtualBaseOffsetOffset(Offset.DerivedClass,
1468 Offset.VirtualBase);
Anders Carlsson1972ced2010-03-11 07:00:45 +00001469 }
Anders Carlsson60db0ee2010-02-13 21:07:32 +00001470 }
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001471
1472 Adjustment.NonVirtual = Offset.NonVirtualOffset;
1473 }
1474
1475 return Adjustment;
1476}
1477
Anders Carlsson379017f2010-02-27 19:57:44 +00001478BaseOffset
Anders Carlsson94464812010-04-10 19:13:06 +00001479VTableBuilder::ComputeThisAdjustmentBaseOffset(BaseSubobject Base,
Anders Carlsson379017f2010-02-27 19:57:44 +00001480 BaseSubobject Derived) const {
1481 const CXXRecordDecl *BaseRD = Base.getBase();
1482 const CXXRecordDecl *DerivedRD = Derived.getBase();
1483
1484 CXXBasePaths Paths(/*FindAmbiguities=*/true,
1485 /*RecordPaths=*/true, /*DetectVirtual=*/true);
1486
1487 if (!const_cast<CXXRecordDecl *>(DerivedRD)->
1488 isDerivedFrom(const_cast<CXXRecordDecl *>(BaseRD), Paths)) {
1489 assert(false && "Class must be derived from the passed in base class!");
1490 return BaseOffset();
1491 }
1492
1493 // We have to go through all the paths, and see which one leads us to the
1494 // right base subobject.
1495 for (CXXBasePaths::const_paths_iterator I = Paths.begin(), E = Paths.end();
1496 I != E; ++I) {
1497 BaseOffset Offset = ComputeBaseOffset(Context, DerivedRD, *I);
1498
1499 // FIXME: Should not use * 8 here.
1500 uint64_t OffsetToBaseSubobject = Offset.NonVirtualOffset * 8;
1501
1502 if (Offset.VirtualBase) {
1503 // If we have a virtual base class, the non-virtual offset is relative
1504 // to the virtual base class offset.
Anders Carlsson2bc1d3a2010-03-10 21:25:37 +00001505 const ASTRecordLayout &LayoutClassLayout =
1506 Context.getASTRecordLayout(LayoutClass);
Anders Carlsson379017f2010-02-27 19:57:44 +00001507
1508 /// Get the virtual base offset, relative to the most derived class
1509 /// layout.
1510 OffsetToBaseSubobject +=
Anders Carlsson2bc1d3a2010-03-10 21:25:37 +00001511 LayoutClassLayout.getVBaseClassOffset(Offset.VirtualBase);
Anders Carlsson379017f2010-02-27 19:57:44 +00001512 } else {
1513 // Otherwise, the non-virtual offset is relative to the derived class
1514 // offset.
1515 OffsetToBaseSubobject += Derived.getBaseOffset();
1516 }
1517
1518 // Check if this path gives us the right base subobject.
1519 if (OffsetToBaseSubobject == Base.getBaseOffset()) {
1520 // Since we're going from the base class _to_ the derived class, we'll
1521 // invert the non-virtual offset here.
1522 Offset.NonVirtualOffset = -Offset.NonVirtualOffset;
1523 return Offset;
1524 }
1525 }
1526
1527 return BaseOffset();
1528}
1529
Anders Carlsson80d8d7d2010-03-23 15:13:06 +00001530ThisAdjustment
Anders Carlsson94464812010-04-10 19:13:06 +00001531VTableBuilder::ComputeThisAdjustment(const CXXMethodDecl *MD,
Anders Carlsson617def32010-03-12 05:28:07 +00001532 uint64_t BaseOffsetInLayoutClass,
1533 FinalOverriders::OverriderInfo Overrider) {
Anders Carlsson617def32010-03-12 05:28:07 +00001534 // Ignore adjustments for pure virtual member functions.
1535 if (Overrider.Method->isPure())
1536 return ThisAdjustment();
1537
1538 BaseSubobject OverriddenBaseSubobject(MD->getParent(),
1539 BaseOffsetInLayoutClass);
1540
1541 BaseSubobject OverriderBaseSubobject(Overrider.Method->getParent(),
1542 Overrider.Offset);
1543
1544 // Compute the adjustment offset.
1545 BaseOffset Offset = ComputeThisAdjustmentBaseOffset(OverriddenBaseSubobject,
1546 OverriderBaseSubobject);
1547 if (Offset.isEmpty())
1548 return ThisAdjustment();
1549
Anders Carlsson49bac9a2010-02-13 23:40:17 +00001550 ThisAdjustment Adjustment;
1551
Anders Carlsson617def32010-03-12 05:28:07 +00001552 if (Offset.VirtualBase) {
1553 // Get the vcall offset map for this virtual base.
1554 VCallOffsetMap &VCallOffsets = VCallOffsetsForVBases[Offset.VirtualBase];
Anders Carlssoneb577d02010-02-18 17:26:40 +00001555
Anders Carlsson617def32010-03-12 05:28:07 +00001556 if (VCallOffsets.empty()) {
1557 // We don't have vcall offsets for this virtual base, go ahead and
1558 // build them.
1559 VCallAndVBaseOffsetBuilder Builder(MostDerivedClass, MostDerivedClass,
1560 /*FinalOverriders=*/0,
1561 BaseSubobject(Offset.VirtualBase, 0),
1562 /*BaseIsVirtual=*/true,
1563 /*OffsetInLayoutClass=*/0);
1564
1565 VCallOffsets = Builder.getVCallOffsets();
1566 }
1567
1568 Adjustment.VCallOffsetOffset = VCallOffsets.getVCallOffsetOffset(MD);
Anders Carlsson49bac9a2010-02-13 23:40:17 +00001569 }
Anders Carlsson617def32010-03-12 05:28:07 +00001570
1571 // Set the non-virtual part of the adjustment.
1572 Adjustment.NonVirtual = Offset.NonVirtualOffset;
Anders Carlsson49bac9a2010-02-13 23:40:17 +00001573
1574 return Adjustment;
1575}
Anders Carlsson617def32010-03-12 05:28:07 +00001576
Anders Carlsson57071e22010-02-12 05:25:12 +00001577void
Anders Carlsson94464812010-04-10 19:13:06 +00001578VTableBuilder::AddMethod(const CXXMethodDecl *MD,
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001579 ReturnAdjustment ReturnAdjustment) {
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001580 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1581 assert(ReturnAdjustment.isEmpty() &&
1582 "Destructor can't have return adjustment!");
Anders Carlsson49bac9a2010-02-13 23:40:17 +00001583
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001584 // Add both the complete destructor and the deleting destructor.
Anders Carlsson94464812010-04-10 19:13:06 +00001585 Components.push_back(VTableComponent::MakeCompleteDtor(DD));
1586 Components.push_back(VTableComponent::MakeDeletingDtor(DD));
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001587 } else {
1588 // Add the return adjustment if necessary.
1589 if (!ReturnAdjustment.isEmpty())
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00001590 VTableThunks[Components.size()].Return = ReturnAdjustment;
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001591
1592 // Add the function.
Anders Carlsson94464812010-04-10 19:13:06 +00001593 Components.push_back(VTableComponent::MakeFunction(MD));
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001594 }
1595}
1596
Anders Carlssonc784ba22010-02-27 06:38:03 +00001597/// OverridesIndirectMethodInBase - Return whether the given member function
1598/// overrides any methods in the set of given bases.
1599/// Unlike OverridesMethodInBase, this checks "overriders of overriders".
1600/// For example, if we have:
1601///
1602/// struct A { virtual void f(); }
1603/// struct B : A { virtual void f(); }
1604/// struct C : B { virtual void f(); }
1605///
1606/// OverridesIndirectMethodInBase will return true if given C::f as the method
Anders Carlssonf622b452010-04-10 20:39:29 +00001607/// and { A } as the set of bases.
Anders Carlssonc784ba22010-02-27 06:38:03 +00001608static bool
1609OverridesIndirectMethodInBases(const CXXMethodDecl *MD,
Anders Carlsson94464812010-04-10 19:13:06 +00001610 VTableBuilder::PrimaryBasesSetVectorTy &Bases) {
Anders Carlssonc784ba22010-02-27 06:38:03 +00001611 for (CXXMethodDecl::method_iterator I = MD->begin_overridden_methods(),
1612 E = MD->end_overridden_methods(); I != E; ++I) {
1613 const CXXMethodDecl *OverriddenMD = *I;
1614 const CXXRecordDecl *OverriddenRD = OverriddenMD->getParent();
1615 assert(OverriddenMD->isCanonicalDecl() &&
1616 "Should have the canonical decl of the overridden RD!");
1617
1618 if (Bases.count(OverriddenRD))
1619 return true;
1620
1621 // Check "indirect overriders".
1622 if (OverridesIndirectMethodInBases(OverriddenMD, Bases))
1623 return true;
1624 }
1625
1626 return false;
1627}
1628
Anders Carlsson464c8f12010-02-23 04:26:39 +00001629bool
Anders Carlsson94464812010-04-10 19:13:06 +00001630VTableBuilder::IsOverriderUsed(const CXXMethodDecl *Overrider,
Anders Carlsson60396612010-03-10 06:51:42 +00001631 uint64_t BaseOffsetInLayoutClass,
1632 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
1633 uint64_t FirstBaseOffsetInLayoutClass) const {
Anders Carlsson464c8f12010-02-23 04:26:39 +00001634 // If the base and the first base in the primary base chain have the same
1635 // offsets, then this overrider will be used.
Anders Carlsson60396612010-03-10 06:51:42 +00001636 if (BaseOffsetInLayoutClass == FirstBaseOffsetInLayoutClass)
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001637 return true;
1638
1639 // We know now that Base (or a direct or indirect base of it) is a primary
1640 // base in part of the class hierarchy, but not a primary base in the most
1641 // derived class.
1642
1643 // If the overrider is the first base in the primary base chain, we know
1644 // that the overrider will be used.
Anders Carlsson60396612010-03-10 06:51:42 +00001645 if (Overrider->getParent() == FirstBaseInPrimaryBaseChain)
Anders Carlsson464c8f12010-02-23 04:26:39 +00001646 return true;
1647
Anders Carlsson94464812010-04-10 19:13:06 +00001648 VTableBuilder::PrimaryBasesSetVectorTy PrimaryBases;
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001649
Anders Carlsson60396612010-03-10 06:51:42 +00001650 const CXXRecordDecl *RD = FirstBaseInPrimaryBaseChain;
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001651 PrimaryBases.insert(RD);
1652
1653 // Now traverse the base chain, starting with the first base, until we find
1654 // the base that is no longer a primary base.
1655 while (true) {
1656 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1657 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
1658
1659 if (!PrimaryBase)
1660 break;
1661
1662 if (Layout.getPrimaryBaseWasVirtual()) {
1663 assert(Layout.getVBaseClassOffset(PrimaryBase) == 0 &&
1664 "Primary base should always be at offset 0!");
1665
Anders Carlssondad0f992010-02-28 18:37:33 +00001666 const ASTRecordLayout &LayoutClassLayout =
1667 Context.getASTRecordLayout(LayoutClass);
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001668
1669 // Now check if this is the primary base that is not a primary base in the
1670 // most derived class.
Anders Carlssondad0f992010-02-28 18:37:33 +00001671 if (LayoutClassLayout.getVBaseClassOffset(PrimaryBase) !=
Anders Carlsson60396612010-03-10 06:51:42 +00001672 FirstBaseOffsetInLayoutClass) {
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001673 // We found it, stop walking the chain.
1674 break;
1675 }
1676 } else {
1677 assert(Layout.getBaseClassOffset(PrimaryBase) == 0 &&
1678 "Primary base should always be at offset 0!");
1679 }
Anders Carlssoncd4e6372010-02-27 18:09:40 +00001680
Anders Carlssonf89bb6c2010-02-27 19:51:04 +00001681 if (!PrimaryBases.insert(PrimaryBase))
1682 assert(false && "Found a duplicate primary base!");
1683
Anders Carlssoncd4e6372010-02-27 18:09:40 +00001684 RD = PrimaryBase;
Anders Carlssonf9fbc712010-02-23 06:34:44 +00001685 }
1686
1687 // If the final overrider is an override of one of the primary bases,
1688 // then we know that it will be used.
Anders Carlsson60396612010-03-10 06:51:42 +00001689 return OverridesIndirectMethodInBases(Overrider, PrimaryBases);
Anders Carlsson464c8f12010-02-23 04:26:39 +00001690}
1691
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001692/// FindNearestOverriddenMethod - Given a method, returns the overridden method
1693/// from the nearest base. Returns null if no method was found.
1694static const CXXMethodDecl *
1695FindNearestOverriddenMethod(const CXXMethodDecl *MD,
Anders Carlsson94464812010-04-10 19:13:06 +00001696 VTableBuilder::PrimaryBasesSetVectorTy &Bases) {
Anders Carlssonf622b452010-04-10 20:39:29 +00001697 OverriddenMethodsSetTy OverriddenMethods;
1698 ComputeAllOverriddenMethods(MD, OverriddenMethods);
1699
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001700 for (int I = Bases.size(), E = 0; I != E; --I) {
1701 const CXXRecordDecl *PrimaryBase = Bases[I - 1];
1702
1703 // Now check the overriden methods.
Anders Carlssonf622b452010-04-10 20:39:29 +00001704 for (OverriddenMethodsSetTy::const_iterator I = OverriddenMethods.begin(),
1705 E = OverriddenMethods.end(); I != E; ++I) {
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001706 const CXXMethodDecl *OverriddenMD = *I;
Anders Carlssonf622b452010-04-10 20:39:29 +00001707
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001708 // We found our overridden method.
1709 if (OverriddenMD->getParent() == PrimaryBase)
1710 return OverriddenMD;
1711 }
1712 }
1713
1714 return 0;
1715}
1716
Anders Carlsson60396612010-03-10 06:51:42 +00001717void
Anders Carlsson94464812010-04-10 19:13:06 +00001718VTableBuilder::AddMethods(BaseSubobject Base, uint64_t BaseOffsetInLayoutClass,
Anders Carlsson60396612010-03-10 06:51:42 +00001719 const CXXRecordDecl *FirstBaseInPrimaryBaseChain,
1720 uint64_t FirstBaseOffsetInLayoutClass,
Anders Carlssonb9021e92010-02-27 16:18:19 +00001721 PrimaryBasesSetVectorTy &PrimaryBases) {
Anders Carlsson57071e22010-02-12 05:25:12 +00001722 const CXXRecordDecl *RD = Base.getBase();
Anders Carlsson57071e22010-02-12 05:25:12 +00001723 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1724
1725 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
Anders Carlsson60396612010-03-10 06:51:42 +00001726 uint64_t PrimaryBaseOffset;
1727 uint64_t PrimaryBaseOffsetInLayoutClass;
Anders Carlssonaf280c02010-02-23 03:48:14 +00001728 if (Layout.getPrimaryBaseWasVirtual()) {
1729 assert(Layout.getVBaseClassOffset(PrimaryBase) == 0 &&
1730 "Primary vbase should have a zero offset!");
1731
1732 const ASTRecordLayout &MostDerivedClassLayout =
1733 Context.getASTRecordLayout(MostDerivedClass);
1734
Anders Carlsson60396612010-03-10 06:51:42 +00001735 PrimaryBaseOffset =
1736 MostDerivedClassLayout.getVBaseClassOffset(PrimaryBase);
1737
1738 const ASTRecordLayout &LayoutClassLayout =
1739 Context.getASTRecordLayout(LayoutClass);
1740
1741 PrimaryBaseOffsetInLayoutClass =
1742 LayoutClassLayout.getVBaseClassOffset(PrimaryBase);
Anders Carlssonaf280c02010-02-23 03:48:14 +00001743 } else {
Anders Carlsson57071e22010-02-12 05:25:12 +00001744 assert(Layout.getBaseClassOffset(PrimaryBase) == 0 &&
1745 "Primary base should have a zero offset!");
Anders Carlssonaf280c02010-02-23 03:48:14 +00001746
Anders Carlsson60396612010-03-10 06:51:42 +00001747 PrimaryBaseOffset = Base.getBaseOffset();
1748 PrimaryBaseOffsetInLayoutClass = BaseOffsetInLayoutClass;
Anders Carlssonaf280c02010-02-23 03:48:14 +00001749 }
Anders Carlssondad0f992010-02-28 18:37:33 +00001750
Anders Carlsson60396612010-03-10 06:51:42 +00001751 AddMethods(BaseSubobject(PrimaryBase, PrimaryBaseOffset),
1752 PrimaryBaseOffsetInLayoutClass, FirstBaseInPrimaryBaseChain,
1753 FirstBaseOffsetInLayoutClass, PrimaryBases);
Anders Carlsson57071e22010-02-12 05:25:12 +00001754
1755 if (!PrimaryBases.insert(PrimaryBase))
1756 assert(false && "Found a duplicate primary base!");
1757 }
Anders Carlsson822307b2010-02-11 17:18:51 +00001758
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001759 // Now go through all virtual member functions and add them.
1760 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
1761 E = RD->method_end(); I != E; ++I) {
1762 const CXXMethodDecl *MD = *I;
Anders Carlsson57071e22010-02-12 05:25:12 +00001763
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001764 if (!MD->isVirtual())
1765 continue;
Anders Carlsson57071e22010-02-12 05:25:12 +00001766
1767 // Get the final overrider.
Anders Carlssona7575822010-02-12 16:55:34 +00001768 FinalOverriders::OverriderInfo Overrider =
1769 Overriders.getOverrider(Base, MD);
Anders Carlsson57071e22010-02-12 05:25:12 +00001770
1771 // Check if this virtual member function overrides a method in a primary
1772 // base. If this is the case, and the return type doesn't require adjustment
1773 // then we can just use the member function from the primary base.
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001774 if (const CXXMethodDecl *OverriddenMD =
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001775 FindNearestOverriddenMethod(MD, PrimaryBases)) {
Anders Carlssondf31af12010-02-13 23:17:31 +00001776 if (ComputeReturnAdjustmentBaseOffset(Context, MD,
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001777 OverriddenMD).isEmpty()) {
1778 // Replace the method info of the overridden method with our own
1779 // method.
1780 assert(MethodInfoMap.count(OverriddenMD) &&
1781 "Did not find the overridden method!");
1782 MethodInfo &OverriddenMethodInfo = MethodInfoMap[OverriddenMD];
1783
1784 MethodInfo MethodInfo(Base.getBaseOffset(),
Anders Carlsson2bc1d3a2010-03-10 21:25:37 +00001785 BaseOffsetInLayoutClass,
Anders Carlsson718d0692010-04-11 22:07:06 +00001786 OverriddenMethodInfo.VTableIndex);
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001787
1788 assert(!MethodInfoMap.count(MD) &&
1789 "Should not have method info for this method yet!");
1790
1791 MethodInfoMap.insert(std::make_pair(MD, MethodInfo));
1792 MethodInfoMap.erase(OverriddenMD);
Anders Carlssonbca5d372010-03-22 20:06:40 +00001793
1794 // If the overridden method exists in a virtual base class or a direct
1795 // or indirect base class of a virtual base class, we need to emit a
1796 // thunk if we ever have a class hierarchy where the base class is not
1797 // a primary base in the complete object.
Anders Carlsson718d0692010-04-11 22:07:06 +00001798 if (!isBuildingConstructorVTable() && OverriddenMD != MD) {
Anders Carlssonbca5d372010-03-22 20:06:40 +00001799 // Compute the this adjustment.
1800 ThisAdjustment ThisAdjustment =
1801 ComputeThisAdjustment(OverriddenMD, BaseOffsetInLayoutClass,
1802 Overrider);
1803
Anders Carlssonacfa6ae2010-03-29 02:53:58 +00001804 if (ThisAdjustment.VCallOffsetOffset &&
1805 Overrider.Method->getParent() == MostDerivedClass) {
1806 // This is a virtual thunk for the most derived class, add it.
Anders Carlssonbca5d372010-03-22 20:06:40 +00001807 AddThunk(Overrider.Method,
1808 ThunkInfo(ThisAdjustment, ReturnAdjustment()));
1809 }
1810 }
1811
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001812 continue;
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001813 }
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001814 }
Anders Carlsson0c0eeb22010-02-13 02:02:03 +00001815
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001816 // Insert the method info for this method.
Anders Carlsson2bc1d3a2010-03-10 21:25:37 +00001817 MethodInfo MethodInfo(Base.getBaseOffset(), BaseOffsetInLayoutClass,
1818 Components.size());
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001819
1820 assert(!MethodInfoMap.count(MD) &&
1821 "Should not have method info for this method yet!");
1822 MethodInfoMap.insert(std::make_pair(MD, MethodInfo));
Anders Carlssoncd4e6372010-02-27 18:09:40 +00001823
1824 // Check if this overrider is going to be used.
Anders Carlsson60396612010-03-10 06:51:42 +00001825 const CXXMethodDecl *OverriderMD = Overrider.Method;
1826 if (!IsOverriderUsed(OverriderMD, BaseOffsetInLayoutClass,
1827 FirstBaseInPrimaryBaseChain,
1828 FirstBaseOffsetInLayoutClass)) {
Anders Carlsson94464812010-04-10 19:13:06 +00001829 Components.push_back(VTableComponent::MakeUnusedFunction(OverriderMD));
Anders Carlssoncd4e6372010-02-27 18:09:40 +00001830 continue;
1831 }
Anders Carlsson464c8f12010-02-23 04:26:39 +00001832
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001833 // Check if this overrider needs a return adjustment.
Anders Carlsson2fca9be2010-02-23 01:34:28 +00001834 BaseOffset ReturnAdjustmentOffset =
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00001835 Overriders.getReturnAdjustmentOffset(Base, MD);
1836
1837 ReturnAdjustment ReturnAdjustment =
1838 ComputeReturnAdjustment(ReturnAdjustmentOffset);
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001839
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001840 AddMethod(Overrider.Method, ReturnAdjustment);
Anders Carlsson824d7ea2010-02-11 08:02:13 +00001841 }
1842}
1843
Anders Carlsson718d0692010-04-11 22:07:06 +00001844void VTableBuilder::LayoutVTable() {
1845 LayoutPrimaryAndSecondaryVTables(BaseSubobject(MostDerivedClass, 0),
Anders Carlsson73e6fa02010-04-11 22:20:36 +00001846 /*BaseIsMorallyVirtual=*/false,
Anders Carlsson530c40c2010-02-28 01:43:58 +00001847 MostDerivedClassIsVirtual,
1848 MostDerivedClassOffset);
Anders Carlsson89ad4212010-02-16 16:26:28 +00001849
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001850 VisitedVirtualBasesSetTy VBases;
Anders Carlsson08c26752010-02-27 04:05:52 +00001851
1852 // Determine the primary virtual bases.
Anders Carlssond7fdae52010-03-10 03:02:01 +00001853 DeterminePrimaryVirtualBases(MostDerivedClass, MostDerivedClassOffset,
1854 VBases);
Anders Carlsson08c26752010-02-27 04:05:52 +00001855 VBases.clear();
1856
Anders Carlsson718d0692010-04-11 22:07:06 +00001857 LayoutVTablesForVirtualBases(MostDerivedClass, VBases);
Anders Carlsson89ad4212010-02-16 16:26:28 +00001858}
1859
Anders Carlsson530c40c2010-02-28 01:43:58 +00001860void
Anders Carlsson718d0692010-04-11 22:07:06 +00001861VTableBuilder::LayoutPrimaryAndSecondaryVTables(BaseSubobject Base,
Anders Carlsson73e6fa02010-04-11 22:20:36 +00001862 bool BaseIsMorallyVirtual,
Anders Carlsson91232842010-04-11 22:03:57 +00001863 bool BaseIsVirtualInLayoutClass,
Anders Carlsson530c40c2010-02-28 01:43:58 +00001864 uint64_t OffsetInLayoutClass) {
Chris Lattner04a23112010-02-17 21:42:34 +00001865 assert(Base.getBase()->isDynamicClass() && "class does not have a vtable!");
Anders Carlssonb828afa2010-02-14 17:05:59 +00001866
Anders Carlsson852213e2010-02-16 04:59:55 +00001867 // Add vcall and vbase offsets for this vtable.
Anders Carlsson530c40c2010-02-28 01:43:58 +00001868 VCallAndVBaseOffsetBuilder Builder(MostDerivedClass, LayoutClass, &Overriders,
Anders Carlsson91232842010-04-11 22:03:57 +00001869 Base, BaseIsVirtualInLayoutClass,
1870 OffsetInLayoutClass);
Anders Carlssond68c0832010-02-25 03:45:56 +00001871 Components.append(Builder.components_begin(), Builder.components_end());
1872
Anders Carlssondba6ef82010-02-25 22:23:13 +00001873 // Check if we need to add these vcall offsets.
Anders Carlsson91232842010-04-11 22:03:57 +00001874 if (BaseIsVirtualInLayoutClass && !Builder.getVCallOffsets().empty()) {
Anders Carlssondba6ef82010-02-25 22:23:13 +00001875 VCallOffsetMap &VCallOffsets = VCallOffsetsForVBases[Base.getBase()];
1876
1877 if (VCallOffsets.empty())
1878 VCallOffsets = Builder.getVCallOffsets();
1879 }
1880
Anders Carlssonbb6305b2010-03-11 06:43:12 +00001881 // If we're laying out the most derived class we want to keep track of the
1882 // virtual base class offset offsets.
1883 if (Base.getBase() == MostDerivedClass)
1884 VBaseOffsetOffsets = Builder.getVBaseOffsetOffsets();
1885
Anders Carlsson852213e2010-02-16 04:59:55 +00001886 // Add the offset to top.
Anders Carlssone67dc302010-02-14 00:16:19 +00001887 // FIXME: We should not use / 8 here.
Anders Carlsson530c40c2010-02-28 01:43:58 +00001888 int64_t OffsetToTop = -(int64_t)(OffsetInLayoutClass -
1889 MostDerivedClassOffset) / 8;
Anders Carlsson94464812010-04-10 19:13:06 +00001890 Components.push_back(VTableComponent::MakeOffsetToTop(OffsetToTop));
Anders Carlsson57071e22010-02-12 05:25:12 +00001891
1892 // Next, add the RTTI.
Anders Carlsson94464812010-04-10 19:13:06 +00001893 Components.push_back(VTableComponent::MakeRTTI(MostDerivedClass));
Anders Carlsson57071e22010-02-12 05:25:12 +00001894
Anders Carlsson28cbc8b2010-02-12 07:43:48 +00001895 uint64_t AddressPoint = Components.size();
Anders Carlsson57071e22010-02-12 05:25:12 +00001896
1897 // Now go through all virtual member functions and add them.
Anders Carlssonb9021e92010-02-27 16:18:19 +00001898 PrimaryBasesSetVectorTy PrimaryBases;
Anders Carlsson60396612010-03-10 06:51:42 +00001899 AddMethods(Base, OffsetInLayoutClass, Base.getBase(), OffsetInLayoutClass,
1900 PrimaryBases);
Anders Carlsson57071e22010-02-12 05:25:12 +00001901
Anders Carlsson2ef9d6b2010-02-27 16:52:49 +00001902 // Compute 'this' pointer adjustments.
1903 ComputeThisAdjustments();
1904
Anders Carlsson014a3582010-03-25 21:45:14 +00001905 // Add all address points.
1906 const CXXRecordDecl *RD = Base.getBase();
1907 while (true) {
1908 AddressPoints.insert(std::make_pair(BaseSubobject(RD, OffsetInLayoutClass),
1909 AddressPoint));
1910
1911 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1912 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
Anders Carlsson28cbc8b2010-02-12 07:43:48 +00001913
Anders Carlsson014a3582010-03-25 21:45:14 +00001914 if (!PrimaryBase)
1915 break;
1916
1917 if (Layout.getPrimaryBaseWasVirtual()) {
1918 // Check if this virtual primary base is a primary base in the layout
1919 // class. If it's not, we don't want to add it.
1920 const ASTRecordLayout &LayoutClassLayout =
1921 Context.getASTRecordLayout(LayoutClass);
1922
1923 if (LayoutClassLayout.getVBaseClassOffset(PrimaryBase) !=
1924 OffsetInLayoutClass) {
1925 // We don't want to add this class (or any of its primary bases).
1926 break;
1927 }
1928 }
1929
1930 RD = PrimaryBase;
Anders Carlsson28cbc8b2010-02-12 07:43:48 +00001931 }
1932
Anders Carlsson5edcc372010-02-24 16:43:12 +00001933 // Layout secondary vtables.
Anders Carlsson718d0692010-04-11 22:07:06 +00001934 LayoutSecondaryVTables(Base, BaseIsMorallyVirtual, OffsetInLayoutClass);
Anders Carlssonc7b63162010-02-16 16:02:57 +00001935}
1936
Anders Carlsson718d0692010-04-11 22:07:06 +00001937void VTableBuilder::LayoutSecondaryVTables(BaseSubobject Base,
Anders Carlssona96a2e92010-03-10 19:39:11 +00001938 bool BaseIsMorallyVirtual,
Anders Carlsson530c40c2010-02-28 01:43:58 +00001939 uint64_t OffsetInLayoutClass) {
Anders Carlssonc7b63162010-02-16 16:02:57 +00001940 // Itanium C++ ABI 2.5.2:
1941 // Following the primary virtual table of a derived class are secondary
1942 // virtual tables for each of its proper base classes, except any primary
1943 // base(s) with which it shares its primary virtual table.
1944
1945 const CXXRecordDecl *RD = Base.getBase();
Anders Carlsson57071e22010-02-12 05:25:12 +00001946 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1947 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
Anders Carlssonc7b63162010-02-16 16:02:57 +00001948
Anders Carlsson57071e22010-02-12 05:25:12 +00001949 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1950 E = RD->bases_end(); I != E; ++I) {
Anders Carlssonc7b63162010-02-16 16:02:57 +00001951 // Ignore virtual bases, we'll emit them later.
1952 if (I->isVirtual())
1953 continue;
1954
Anders Carlsson57071e22010-02-12 05:25:12 +00001955 const CXXRecordDecl *BaseDecl =
1956 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Anders Carlssonb828afa2010-02-14 17:05:59 +00001957
Anders Carlssona661a542010-02-16 04:49:44 +00001958 // Ignore bases that don't have a vtable.
1959 if (!BaseDecl->isDynamicClass())
1960 continue;
Anders Carlssonb828afa2010-02-14 17:05:59 +00001961
Anders Carlsson718d0692010-04-11 22:07:06 +00001962 if (isBuildingConstructorVTable()) {
Anders Carlssonf2c98ce2010-03-10 19:15:26 +00001963 // Itanium C++ ABI 2.6.4:
1964 // Some of the base class subobjects may not need construction virtual
1965 // tables, which will therefore not be present in the construction
1966 // virtual table group, even though the subobject virtual tables are
1967 // present in the main virtual table group for the complete object.
Anders Carlssona96a2e92010-03-10 19:39:11 +00001968 if (!BaseIsMorallyVirtual && !BaseDecl->getNumVBases())
Anders Carlssonf2c98ce2010-03-10 19:15:26 +00001969 continue;
Anders Carlssonf2c98ce2010-03-10 19:15:26 +00001970 }
1971
Anders Carlsson76f1aa72010-02-13 22:05:23 +00001972 // Get the base offset of this base.
Anders Carlsson530c40c2010-02-28 01:43:58 +00001973 uint64_t RelativeBaseOffset = Layout.getBaseClassOffset(BaseDecl);
1974 uint64_t BaseOffset = Base.getBaseOffset() + RelativeBaseOffset;
1975
1976 uint64_t BaseOffsetInLayoutClass = OffsetInLayoutClass + RelativeBaseOffset;
Anders Carlssonc7b63162010-02-16 16:02:57 +00001977
1978 // Don't emit a secondary vtable for a primary base. We might however want
1979 // to emit secondary vtables for other bases of this base.
1980 if (BaseDecl == PrimaryBase) {
Anders Carlsson718d0692010-04-11 22:07:06 +00001981 LayoutSecondaryVTables(BaseSubobject(BaseDecl, BaseOffset),
Anders Carlssona96a2e92010-03-10 19:39:11 +00001982 BaseIsMorallyVirtual, BaseOffsetInLayoutClass);
Anders Carlssonc7b63162010-02-16 16:02:57 +00001983 continue;
1984 }
Anders Carlsson76f1aa72010-02-13 22:05:23 +00001985
Anders Carlsson89ad4212010-02-16 16:26:28 +00001986 // Layout the primary vtable (and any secondary vtables) for this base.
Anders Carlsson718d0692010-04-11 22:07:06 +00001987 LayoutPrimaryAndSecondaryVTables(BaseSubobject(BaseDecl, BaseOffset),
Anders Carlsson73e6fa02010-04-11 22:20:36 +00001988 BaseIsMorallyVirtual,
Anders Carlsson91232842010-04-11 22:03:57 +00001989 /*BaseIsVirtualInLayoutClass=*/false,
Anders Carlsson530c40c2010-02-28 01:43:58 +00001990 BaseOffsetInLayoutClass);
Anders Carlsson57071e22010-02-12 05:25:12 +00001991 }
1992}
1993
Anders Carlsson69dc04e2010-02-16 16:49:35 +00001994void
Anders Carlsson94464812010-04-10 19:13:06 +00001995VTableBuilder::DeterminePrimaryVirtualBases(const CXXRecordDecl *RD,
Anders Carlssond7fdae52010-03-10 03:02:01 +00001996 uint64_t OffsetInLayoutClass,
Anders Carlsson08c26752010-02-27 04:05:52 +00001997 VisitedVirtualBasesSetTy &VBases) {
1998 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1999
2000 // Check if this base has a primary base.
2001 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
Anders Carlsson0378bf02010-02-28 18:08:38 +00002002
2003 // Check if it's virtual.
2004 if (Layout.getPrimaryBaseWasVirtual()) {
2005 bool IsPrimaryVirtualBase = true;
2006
Anders Carlsson718d0692010-04-11 22:07:06 +00002007 if (isBuildingConstructorVTable()) {
Anders Carlsson0378bf02010-02-28 18:08:38 +00002008 // Check if the base is actually a primary base in the class we use for
2009 // layout.
Anders Carlssond7fdae52010-03-10 03:02:01 +00002010 const ASTRecordLayout &LayoutClassLayout =
2011 Context.getASTRecordLayout(LayoutClass);
2012
2013 uint64_t PrimaryBaseOffsetInLayoutClass =
2014 LayoutClassLayout.getVBaseClassOffset(PrimaryBase);
2015
2016 // We know that the base is not a primary base in the layout class if
2017 // the base offsets are different.
2018 if (PrimaryBaseOffsetInLayoutClass != OffsetInLayoutClass)
Anders Carlsson0378bf02010-02-28 18:08:38 +00002019 IsPrimaryVirtualBase = false;
2020 }
2021
2022 if (IsPrimaryVirtualBase)
2023 PrimaryVirtualBases.insert(PrimaryBase);
2024 }
Anders Carlsson08c26752010-02-27 04:05:52 +00002025 }
2026
2027 // Traverse bases, looking for more primary virtual bases.
2028 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
2029 E = RD->bases_end(); I != E; ++I) {
2030 const CXXRecordDecl *BaseDecl =
2031 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
2032
Anders Carlssond7fdae52010-03-10 03:02:01 +00002033 uint64_t BaseOffsetInLayoutClass;
2034
2035 if (I->isVirtual()) {
2036 if (!VBases.insert(BaseDecl))
2037 continue;
2038
2039 const ASTRecordLayout &LayoutClassLayout =
2040 Context.getASTRecordLayout(LayoutClass);
Anders Carlsson08c26752010-02-27 04:05:52 +00002041
Anders Carlssond7fdae52010-03-10 03:02:01 +00002042 BaseOffsetInLayoutClass = LayoutClassLayout.getVBaseClassOffset(BaseDecl);
2043 } else {
2044 BaseOffsetInLayoutClass =
2045 OffsetInLayoutClass + Layout.getBaseClassOffset(BaseDecl);
2046 }
2047
2048 DeterminePrimaryVirtualBases(BaseDecl, BaseOffsetInLayoutClass, VBases);
Anders Carlsson08c26752010-02-27 04:05:52 +00002049 }
2050}
2051
2052void
Anders Carlsson718d0692010-04-11 22:07:06 +00002053VTableBuilder::LayoutVTablesForVirtualBases(const CXXRecordDecl *RD,
Anders Carlsson69dc04e2010-02-16 16:49:35 +00002054 VisitedVirtualBasesSetTy &VBases) {
2055 // Itanium C++ ABI 2.5.2:
2056 // Then come the virtual base virtual tables, also in inheritance graph
2057 // order, and again excluding primary bases (which share virtual tables with
2058 // the classes for which they are primary).
Anders Carlsson69dc04e2010-02-16 16:49:35 +00002059 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
2060 E = RD->bases_end(); I != E; ++I) {
2061 const CXXRecordDecl *BaseDecl =
2062 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
2063
Anders Carlssonaf280c02010-02-23 03:48:14 +00002064 // Check if this base needs a vtable. (If it's virtual, not a primary base
2065 // of some other class, and we haven't visited it before).
Anders Carlsson69dc04e2010-02-16 16:49:35 +00002066 if (I->isVirtual() && BaseDecl->isDynamicClass() &&
Anders Carlsson08c26752010-02-27 04:05:52 +00002067 !PrimaryVirtualBases.count(BaseDecl) && VBases.insert(BaseDecl)) {
Anders Carlsson69dc04e2010-02-16 16:49:35 +00002068 const ASTRecordLayout &MostDerivedClassLayout =
2069 Context.getASTRecordLayout(MostDerivedClass);
2070 uint64_t BaseOffset =
2071 MostDerivedClassLayout.getVBaseClassOffset(BaseDecl);
2072
Anders Carlsson530c40c2010-02-28 01:43:58 +00002073 const ASTRecordLayout &LayoutClassLayout =
2074 Context.getASTRecordLayout(LayoutClass);
2075 uint64_t BaseOffsetInLayoutClass =
2076 LayoutClassLayout.getVBaseClassOffset(BaseDecl);
2077
Anders Carlsson718d0692010-04-11 22:07:06 +00002078 LayoutPrimaryAndSecondaryVTables(BaseSubobject(BaseDecl, BaseOffset),
Anders Carlsson73e6fa02010-04-11 22:20:36 +00002079 /*BaseIsMorallyVirtual=*/true,
2080 /*BaseIsVirtualInLayoutClass=*/true,
Anders Carlsson530c40c2010-02-28 01:43:58 +00002081 BaseOffsetInLayoutClass);
Anders Carlsson69dc04e2010-02-16 16:49:35 +00002082 }
2083
2084 // We only need to check the base for virtual base vtables if it actually
2085 // has virtual bases.
2086 if (BaseDecl->getNumVBases())
Anders Carlsson718d0692010-04-11 22:07:06 +00002087 LayoutVTablesForVirtualBases(BaseDecl, VBases);
Anders Carlsson69dc04e2010-02-16 16:49:35 +00002088 }
2089}
2090
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002091/// dumpLayout - Dump the vtable layout.
Anders Carlsson94464812010-04-10 19:13:06 +00002092void VTableBuilder::dumpLayout(llvm::raw_ostream& Out) {
Anders Carlssond03a3262010-02-27 20:39:05 +00002093
Anders Carlsson718d0692010-04-11 22:07:06 +00002094 if (isBuildingConstructorVTable()) {
Anders Carlssond03a3262010-02-27 20:39:05 +00002095 Out << "Construction vtable for ('";
2096 Out << MostDerivedClass->getQualifiedNameAsString() << "', ";
2097 // FIXME: Don't use / 8 .
2098 Out << MostDerivedClassOffset / 8 << ") in '";
2099 Out << LayoutClass->getQualifiedNameAsString();
Anders Carlssonbb6305b2010-03-11 06:43:12 +00002100 } else {
2101 Out << "Vtable for '";
2102 Out << MostDerivedClass->getQualifiedNameAsString();
Anders Carlssond03a3262010-02-27 20:39:05 +00002103 }
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002104 Out << "' (" << Components.size() << " entries).\n";
2105
Anders Carlsson822307b2010-02-11 17:18:51 +00002106 // Iterate through the address points and insert them into a new map where
2107 // they are keyed by the index and not the base object.
2108 // Since an address point can be shared by multiple subobjects, we use an
2109 // STL multimap.
2110 std::multimap<uint64_t, BaseSubobject> AddressPointsByIndex;
Anders Carlssonff143f82010-03-25 00:35:49 +00002111 for (AddressPointsMapTy::const_iterator I = AddressPoints.begin(),
2112 E = AddressPoints.end(); I != E; ++I) {
Anders Carlsson822307b2010-02-11 17:18:51 +00002113 const BaseSubobject& Base = I->first;
2114 uint64_t Index = I->second;
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002115
Anders Carlsson822307b2010-02-11 17:18:51 +00002116 AddressPointsByIndex.insert(std::make_pair(Index, Base));
2117 }
2118
2119 for (unsigned I = 0, E = Components.size(); I != E; ++I) {
Anders Carlsson28cbc8b2010-02-12 07:43:48 +00002120 uint64_t Index = I;
Anders Carlsson822307b2010-02-11 17:18:51 +00002121
2122 Out << llvm::format("%4d | ", I);
2123
Anders Carlsson94464812010-04-10 19:13:06 +00002124 const VTableComponent &Component = Components[I];
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002125
2126 // Dump the component.
2127 switch (Component.getKind()) {
Anders Carlssond9a67042010-02-17 06:07:19 +00002128
Anders Carlsson94464812010-04-10 19:13:06 +00002129 case VTableComponent::CK_VCallOffset:
Anders Carlssond9a67042010-02-17 06:07:19 +00002130 Out << "vcall_offset (" << Component.getVCallOffset() << ")";
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002131 break;
Anders Carlsson852213e2010-02-16 04:59:55 +00002132
Anders Carlsson94464812010-04-10 19:13:06 +00002133 case VTableComponent::CK_VBaseOffset:
Anders Carlsson852213e2010-02-16 04:59:55 +00002134 Out << "vbase_offset (" << Component.getVBaseOffset() << ")";
2135 break;
2136
Anders Carlsson94464812010-04-10 19:13:06 +00002137 case VTableComponent::CK_OffsetToTop:
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002138 Out << "offset_to_top (" << Component.getOffsetToTop() << ")";
2139 break;
2140
Anders Carlsson94464812010-04-10 19:13:06 +00002141 case VTableComponent::CK_RTTI:
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002142 Out << Component.getRTTIDecl()->getQualifiedNameAsString() << " RTTI";
2143 break;
2144
Anders Carlsson94464812010-04-10 19:13:06 +00002145 case VTableComponent::CK_FunctionPointer: {
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002146 const CXXMethodDecl *MD = Component.getFunctionDecl();
2147
Anders Carlsson848fa642010-02-11 18:20:28 +00002148 std::string Str =
2149 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
2150 MD);
2151 Out << Str;
Anders Carlsson98241422010-02-12 02:38:13 +00002152 if (MD->isPure())
2153 Out << " [pure]";
2154
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00002155 ThunkInfo Thunk = VTableThunks.lookup(I);
Anders Carlssondd366812010-03-12 04:54:20 +00002156 if (!Thunk.isEmpty()) {
2157 // If this function pointer has a return adjustment, dump it.
2158 if (!Thunk.Return.isEmpty()) {
2159 Out << "\n [return adjustment: ";
2160 Out << Thunk.Return.NonVirtual << " non-virtual";
2161
2162 if (Thunk.Return.VBaseOffsetOffset) {
2163 Out << ", " << Thunk.Return.VBaseOffsetOffset;
2164 Out << " vbase offset offset";
2165 }
Anders Carlsson60cc72a2010-02-18 17:00:09 +00002166
Anders Carlssondd366812010-03-12 04:54:20 +00002167 Out << ']';
2168 }
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00002169
Anders Carlssondd366812010-03-12 04:54:20 +00002170 // If this function pointer has a 'this' pointer adjustment, dump it.
2171 if (!Thunk.This.isEmpty()) {
2172 Out << "\n [this adjustment: ";
2173 Out << Thunk.This.NonVirtual << " non-virtual";
2174
2175 if (Thunk.This.VCallOffsetOffset) {
2176 Out << ", " << Thunk.This.VCallOffsetOffset;
2177 Out << " vcall offset offset";
2178 }
Anders Carlsson60cc72a2010-02-18 17:00:09 +00002179
Anders Carlssondd366812010-03-12 04:54:20 +00002180 Out << ']';
2181 }
Anders Carlsson49bac9a2010-02-13 23:40:17 +00002182 }
Anders Carlsson7dbf47a2010-02-13 20:11:51 +00002183
Anders Carlsson848fa642010-02-11 18:20:28 +00002184 break;
2185 }
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002186
Anders Carlsson94464812010-04-10 19:13:06 +00002187 case VTableComponent::CK_CompleteDtorPointer:
2188 case VTableComponent::CK_DeletingDtorPointer: {
Anders Carlsson6065e022010-02-19 06:03:53 +00002189 bool IsComplete =
Anders Carlsson94464812010-04-10 19:13:06 +00002190 Component.getKind() == VTableComponent::CK_CompleteDtorPointer;
Anders Carlsson6065e022010-02-19 06:03:53 +00002191
Anders Carlsson848fa642010-02-11 18:20:28 +00002192 const CXXDestructorDecl *DD = Component.getDestructorDecl();
2193
Anders Carlsson6065e022010-02-19 06:03:53 +00002194 Out << DD->getQualifiedNameAsString();
2195 if (IsComplete)
2196 Out << "() [complete]";
2197 else
2198 Out << "() [deleting]";
2199
Anders Carlsson98241422010-02-12 02:38:13 +00002200 if (DD->isPure())
2201 Out << " [pure]";
2202
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00002203 ThunkInfo Thunk = VTableThunks.lookup(I);
Anders Carlssondd366812010-03-12 04:54:20 +00002204 if (!Thunk.isEmpty()) {
2205 // If this destructor has a 'this' pointer adjustment, dump it.
2206 if (!Thunk.This.isEmpty()) {
2207 Out << "\n [this adjustment: ";
2208 Out << Thunk.This.NonVirtual << " non-virtual";
2209
2210 if (Thunk.This.VCallOffsetOffset) {
2211 Out << ", " << Thunk.This.VCallOffsetOffset;
2212 Out << " vcall offset offset";
2213 }
2214
2215 Out << ']';
2216 }
2217 }
Anders Carlsson6065e022010-02-19 06:03:53 +00002218
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002219 break;
2220 }
2221
Anders Carlsson94464812010-04-10 19:13:06 +00002222 case VTableComponent::CK_UnusedFunctionPointer: {
Anders Carlsson1f464662010-02-19 20:08:13 +00002223 const CXXMethodDecl *MD = Component.getUnusedFunctionDecl();
2224
2225 std::string Str =
2226 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
2227 MD);
2228 Out << "[unused] " << Str;
2229 if (MD->isPure())
2230 Out << " [pure]";
2231 }
2232
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002233 }
Anders Carlsson822307b2010-02-11 17:18:51 +00002234
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002235 Out << '\n';
Anders Carlssond2c3a7c2010-02-27 23:58:01 +00002236
2237 // Dump the next address point.
2238 uint64_t NextIndex = Index + 1;
2239 if (AddressPointsByIndex.count(NextIndex)) {
2240 if (AddressPointsByIndex.count(NextIndex) == 1) {
2241 const BaseSubobject &Base =
2242 AddressPointsByIndex.find(NextIndex)->second;
2243
2244 // FIXME: Instead of dividing by 8, we should be using CharUnits.
2245 Out << " -- (" << Base.getBase()->getQualifiedNameAsString();
2246 Out << ", " << Base.getBaseOffset() / 8 << ") vtable address --\n";
2247 } else {
2248 uint64_t BaseOffset =
2249 AddressPointsByIndex.lower_bound(NextIndex)->second.getBaseOffset();
2250
2251 // We store the class names in a set to get a stable order.
2252 std::set<std::string> ClassNames;
2253 for (std::multimap<uint64_t, BaseSubobject>::const_iterator I =
2254 AddressPointsByIndex.lower_bound(NextIndex), E =
2255 AddressPointsByIndex.upper_bound(NextIndex); I != E; ++I) {
2256 assert(I->second.getBaseOffset() == BaseOffset &&
2257 "Invalid base offset!");
2258 const CXXRecordDecl *RD = I->second.getBase();
2259 ClassNames.insert(RD->getQualifiedNameAsString());
2260 }
2261
2262 for (std::set<std::string>::const_iterator I = ClassNames.begin(),
2263 E = ClassNames.end(); I != E; ++I) {
2264 // FIXME: Instead of dividing by 8, we should be using CharUnits.
2265 Out << " -- (" << *I;
2266 Out << ", " << BaseOffset / 8 << ") vtable address --\n";
2267 }
2268 }
2269 }
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002270 }
Anders Carlssond03a3262010-02-27 20:39:05 +00002271
2272 Out << '\n';
Anders Carlssonbb6305b2010-03-11 06:43:12 +00002273
Anders Carlsson718d0692010-04-11 22:07:06 +00002274 if (isBuildingConstructorVTable())
Anders Carlsson9135a842010-03-18 02:44:19 +00002275 return;
2276
2277 if (MostDerivedClass->getNumVBases()) {
Anders Carlssonbb6305b2010-03-11 06:43:12 +00002278 // We store the virtual base class names and their offsets in a map to get
2279 // a stable order.
Anders Carlssonbb6305b2010-03-11 06:43:12 +00002280
Anders Carlsson9135a842010-03-18 02:44:19 +00002281 std::map<std::string, int64_t> ClassNamesAndOffsets;
Anders Carlssonbb6305b2010-03-11 06:43:12 +00002282 for (VBaseOffsetOffsetsMapTy::const_iterator I = VBaseOffsetOffsets.begin(),
2283 E = VBaseOffsetOffsets.end(); I != E; ++I) {
2284 std::string ClassName = I->first->getQualifiedNameAsString();
2285 int64_t OffsetOffset = I->second;
2286 ClassNamesAndOffsets.insert(std::make_pair(ClassName, OffsetOffset));
2287 }
Anders Carlsson9135a842010-03-18 02:44:19 +00002288
2289 Out << "Virtual base offset offsets for '";
2290 Out << MostDerivedClass->getQualifiedNameAsString() << "' (";
2291 Out << ClassNamesAndOffsets.size();
2292 Out << (ClassNamesAndOffsets.size() == 1 ? " entry" : " entries") << ").\n";
Anders Carlssonbb6305b2010-03-11 06:43:12 +00002293
2294 for (std::map<std::string, int64_t>::const_iterator I =
2295 ClassNamesAndOffsets.begin(), E = ClassNamesAndOffsets.end();
2296 I != E; ++I)
2297 Out << " " << I->first << " | " << I->second << '\n';
2298
2299 Out << "\n";
2300 }
Anders Carlsson9135a842010-03-18 02:44:19 +00002301
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00002302 if (!Thunks.empty()) {
Anders Carlsson9135a842010-03-18 02:44:19 +00002303 // We store the method names in a map to get a stable order.
2304 std::map<std::string, const CXXMethodDecl *> MethodNamesAndDecls;
2305
Anders Carlssonee5ab9f2010-03-23 04:59:02 +00002306 for (ThunksMapTy::const_iterator I = Thunks.begin(), E = Thunks.end();
Anders Carlsson3a5df3f2010-03-23 04:44:10 +00002307 I != E; ++I) {
Anders Carlsson9135a842010-03-18 02:44:19 +00002308 const CXXMethodDecl *MD = I->first;
2309 std::string MethodName =
2310 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
2311 MD);
2312
2313 MethodNamesAndDecls.insert(std::make_pair(MethodName, MD));
2314 }
2315
2316 for (std::map<std::string, const CXXMethodDecl *>::const_iterator I =
2317 MethodNamesAndDecls.begin(), E = MethodNamesAndDecls.end();
2318 I != E; ++I) {
2319 const std::string &MethodName = I->first;
2320 const CXXMethodDecl *MD = I->second;
Anders Carlsson87e0ac82010-03-22 16:30:44 +00002321
Anders Carlssonee5ab9f2010-03-23 04:59:02 +00002322 ThunkInfoVectorTy ThunksVector = Thunks[MD];
Anders Carlsson87e0ac82010-03-22 16:30:44 +00002323 std::sort(ThunksVector.begin(), ThunksVector.end());
Anders Carlsson9135a842010-03-18 02:44:19 +00002324
2325 Out << "Thunks for '" << MethodName << "' (" << ThunksVector.size();
2326 Out << (ThunksVector.size() == 1 ? " entry" : " entries") << ").\n";
2327
2328 for (unsigned I = 0, E = ThunksVector.size(); I != E; ++I) {
2329 const ThunkInfo &Thunk = ThunksVector[I];
2330
2331 Out << llvm::format("%4d | ", I);
2332
Anders Carlsson09daa502010-03-22 16:10:59 +00002333 // If this function pointer has a return pointer adjustment, dump it.
2334 if (!Thunk.Return.isEmpty()) {
2335 Out << "return adjustment: " << Thunk.This.NonVirtual;
2336 Out << " non-virtual";
2337 if (Thunk.Return.VBaseOffsetOffset) {
2338 Out << ", " << Thunk.Return.VBaseOffsetOffset;
2339 Out << " vbase offset offset";
2340 }
2341
2342 if (!Thunk.This.isEmpty())
2343 Out << "\n ";
2344 }
2345
Anders Carlsson9135a842010-03-18 02:44:19 +00002346 // If this function pointer has a 'this' pointer adjustment, dump it.
2347 if (!Thunk.This.isEmpty()) {
Anders Carlsson09daa502010-03-22 16:10:59 +00002348 Out << "this adjustment: ";
2349 Out << Thunk.This.NonVirtual << " non-virtual";
Anders Carlsson9135a842010-03-18 02:44:19 +00002350
2351 if (Thunk.This.VCallOffsetOffset) {
2352 Out << ", " << Thunk.This.VCallOffsetOffset;
Anders Carlsson09daa502010-03-22 16:10:59 +00002353 Out << " vcall offset offset";
Anders Carlsson9135a842010-03-18 02:44:19 +00002354 }
2355 }
2356
2357 Out << '\n';
2358 }
Anders Carlssonbca5d372010-03-22 20:06:40 +00002359
2360 Out << '\n';
2361
Anders Carlsson9135a842010-03-18 02:44:19 +00002362 }
2363 }
Anders Carlsson824d7ea2010-02-11 08:02:13 +00002364}
2365
2366}
2367
Anders Carlssonaf440352010-03-23 04:11:45 +00002368void CodeGenVTables::ComputeMethodVtableIndices(const CXXRecordDecl *RD) {
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002369
2370 // Itanium C++ ABI 2.5.2:
Anders Carlsson45147d02010-02-02 03:37:46 +00002371 // The order of the virtual function pointers in a virtual table is the
2372 // order of declaration of the corresponding member functions in the class.
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002373 //
Anders Carlsson45147d02010-02-02 03:37:46 +00002374 // There is an entry for any virtual function declared in a class,
2375 // whether it is a new function or overrides a base class function,
2376 // unless it overrides a function from the primary base, and conversion
2377 // between their return types does not require an adjustment.
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002378
2379 int64_t CurrentIndex = 0;
2380
2381 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
2382 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
2383
2384 if (PrimaryBase) {
Anders Carlsson0121fbd2009-11-30 19:43:26 +00002385 assert(PrimaryBase->isDefinition() &&
2386 "Should have the definition decl of the primary base!");
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002387
2388 // Since the record decl shares its vtable pointer with the primary base
2389 // we need to start counting at the end of the primary base's vtable.
2390 CurrentIndex = getNumVirtualFunctionPointers(PrimaryBase);
2391 }
Eli Friedmanea5ae312009-12-15 03:31:17 +00002392
2393 // Collect all the primary bases, so we can check whether methods override
2394 // a method from the base.
Anders Carlsson94464812010-04-10 19:13:06 +00002395 VTableBuilder::PrimaryBasesSetVectorTy PrimaryBases;
Eli Friedmanea5ae312009-12-15 03:31:17 +00002396 for (ASTRecordLayout::primary_base_info_iterator
2397 I = Layout.primary_base_begin(), E = Layout.primary_base_end();
2398 I != E; ++I)
2399 PrimaryBases.insert((*I).getBase());
2400
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002401 const CXXDestructorDecl *ImplicitVirtualDtor = 0;
2402
2403 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
2404 e = RD->method_end(); i != e; ++i) {
2405 const CXXMethodDecl *MD = *i;
2406
2407 // We only want virtual methods.
2408 if (!MD->isVirtual())
2409 continue;
2410
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002411 // Check if this method overrides a method in the primary base.
Anders Carlsson57071e22010-02-12 05:25:12 +00002412 if (const CXXMethodDecl *OverriddenMD =
Anders Carlssonf622b452010-04-10 20:39:29 +00002413 FindNearestOverriddenMethod(MD, PrimaryBases)) {
Anders Carlsson57071e22010-02-12 05:25:12 +00002414 // Check if converting from the return type of the method to the
2415 // return type of the overridden method requires conversion.
Anders Carlssondf31af12010-02-13 23:17:31 +00002416 if (ComputeReturnAdjustmentBaseOffset(CGM.getContext(), MD,
2417 OverriddenMD).isEmpty()) {
Anders Carlsson57071e22010-02-12 05:25:12 +00002418 // This index is shared between the index in the vtable of the primary
2419 // base class.
2420 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2421 const CXXDestructorDecl *OverriddenDD =
2422 cast<CXXDestructorDecl>(OverriddenMD);
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002423
Anders Carlsson57071e22010-02-12 05:25:12 +00002424 // Add both the complete and deleting entries.
2425 MethodVtableIndices[GlobalDecl(DD, Dtor_Complete)] =
2426 getMethodVtableIndex(GlobalDecl(OverriddenDD, Dtor_Complete));
2427 MethodVtableIndices[GlobalDecl(DD, Dtor_Deleting)] =
2428 getMethodVtableIndex(GlobalDecl(OverriddenDD, Dtor_Deleting));
2429 } else {
2430 MethodVtableIndices[MD] = getMethodVtableIndex(OverriddenMD);
2431 }
2432
2433 // We don't need to add an entry for this method.
Anders Carlssonc1eec892010-02-12 18:14:46 +00002434 continue;
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002435 }
2436 }
2437
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002438 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2439 if (MD->isImplicit()) {
2440 assert(!ImplicitVirtualDtor &&
2441 "Did already see an implicit virtual dtor!");
2442 ImplicitVirtualDtor = DD;
2443 continue;
2444 }
2445
2446 // Add the complete dtor.
2447 MethodVtableIndices[GlobalDecl(DD, Dtor_Complete)] = CurrentIndex++;
2448
2449 // Add the deleting dtor.
2450 MethodVtableIndices[GlobalDecl(DD, Dtor_Deleting)] = CurrentIndex++;
2451 } else {
2452 // Add the entry.
2453 MethodVtableIndices[MD] = CurrentIndex++;
2454 }
2455 }
2456
2457 if (ImplicitVirtualDtor) {
2458 // Itanium C++ ABI 2.5.2:
Anders Carlssona661a542010-02-16 04:49:44 +00002459 // If a class has an implicitly-defined virtual destructor,
2460 // its entries come after the declared virtual function pointers.
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002461
2462 // Add the complete dtor.
2463 MethodVtableIndices[GlobalDecl(ImplicitVirtualDtor, Dtor_Complete)] =
2464 CurrentIndex++;
2465
2466 // Add the deleting dtor.
2467 MethodVtableIndices[GlobalDecl(ImplicitVirtualDtor, Dtor_Deleting)] =
2468 CurrentIndex++;
2469 }
2470
2471 NumVirtualFunctionPointers[RD] = CurrentIndex;
2472}
2473
Anders Carlssonaf440352010-03-23 04:11:45 +00002474uint64_t CodeGenVTables::getNumVirtualFunctionPointers(const CXXRecordDecl *RD) {
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002475 llvm::DenseMap<const CXXRecordDecl *, uint64_t>::iterator I =
2476 NumVirtualFunctionPointers.find(RD);
2477 if (I != NumVirtualFunctionPointers.end())
2478 return I->second;
2479
2480 ComputeMethodVtableIndices(RD);
2481
2482 I = NumVirtualFunctionPointers.find(RD);
2483 assert(I != NumVirtualFunctionPointers.end() && "Did not find entry!");
2484 return I->second;
2485}
2486
Anders Carlssonaf440352010-03-23 04:11:45 +00002487uint64_t CodeGenVTables::getMethodVtableIndex(GlobalDecl GD) {
Anders Carlssona0fdd912009-11-13 17:08:56 +00002488 MethodVtableIndicesTy::iterator I = MethodVtableIndices.find(GD);
Anders Carlssondbd920c2009-10-11 22:13:54 +00002489 if (I != MethodVtableIndices.end())
2490 return I->second;
2491
Anders Carlssona0fdd912009-11-13 17:08:56 +00002492 const CXXRecordDecl *RD = cast<CXXMethodDecl>(GD.getDecl())->getParent();
Anders Carlssond6b07fb2009-11-27 20:47:55 +00002493
2494 ComputeMethodVtableIndices(RD);
2495
Anders Carlssona0fdd912009-11-13 17:08:56 +00002496 I = MethodVtableIndices.find(GD);
Anders Carlssondbd920c2009-10-11 22:13:54 +00002497 assert(I != MethodVtableIndices.end() && "Did not find index!");
2498 return I->second;
2499}
2500
Anders Carlssonaf440352010-03-23 04:11:45 +00002501int64_t CodeGenVTables::getVirtualBaseOffsetOffset(const CXXRecordDecl *RD,
2502 const CXXRecordDecl *VBase) {
Anders Carlssondbd920c2009-10-11 22:13:54 +00002503 ClassPairTy ClassPair(RD, VBase);
2504
Anders Carlssonbba16072010-03-11 07:15:17 +00002505 VirtualBaseClassOffsetOffsetsMapTy::iterator I =
2506 VirtualBaseClassOffsetOffsets.find(ClassPair);
2507 if (I != VirtualBaseClassOffsetOffsets.end())
Anders Carlssondbd920c2009-10-11 22:13:54 +00002508 return I->second;
2509
Anders Carlssonc89a7cf2010-03-11 16:06:20 +00002510 VCallAndVBaseOffsetBuilder Builder(RD, RD, /*FinalOverriders=*/0,
2511 BaseSubobject(RD, 0),
2512 /*BaseIsVirtual=*/false,
2513 /*OffsetInLayoutClass=*/0);
Anders Carlssonc89a7cf2010-03-11 16:06:20 +00002514
2515 for (VCallAndVBaseOffsetBuilder::VBaseOffsetOffsetsMapTy::const_iterator I =
2516 Builder.getVBaseOffsetOffsets().begin(),
2517 E = Builder.getVBaseOffsetOffsets().end(); I != E; ++I) {
Anders Carlssondbd920c2009-10-11 22:13:54 +00002518 // Insert all types.
2519 ClassPairTy ClassPair(RD, I->first);
2520
Anders Carlssonbba16072010-03-11 07:15:17 +00002521 VirtualBaseClassOffsetOffsets.insert(std::make_pair(ClassPair, I->second));
Anders Carlssondbd920c2009-10-11 22:13:54 +00002522 }
2523
Anders Carlssonbba16072010-03-11 07:15:17 +00002524 I = VirtualBaseClassOffsetOffsets.find(ClassPair);
Anders Carlssonbba16072010-03-11 07:15:17 +00002525 assert(I != VirtualBaseClassOffsetOffsets.end() && "Did not find index!");
Anders Carlssondbd920c2009-10-11 22:13:54 +00002526
2527 return I->second;
2528}
2529
Anders Carlsson64c9eca2010-03-29 02:08:26 +00002530uint64_t
2531CodeGenVTables::getAddressPoint(BaseSubobject Base, const CXXRecordDecl *RD) {
Anders Carlssonec9c2022010-04-08 16:18:36 +00002532 assert(AddressPoints.count(std::make_pair(RD, Base)) &&
2533 "Did not find address point!");
2534
Anders Carlssona7cde3b2010-03-29 03:38:52 +00002535 uint64_t AddressPoint = AddressPoints.lookup(std::make_pair(RD, Base));
Anders Carlsson64c9eca2010-03-29 02:08:26 +00002536 assert(AddressPoint && "Address point must not be zero!");
Anders Carlssona7cde3b2010-03-29 03:38:52 +00002537
Anders Carlsson64c9eca2010-03-29 02:08:26 +00002538 return AddressPoint;
2539}
2540
Anders Carlsson19879c92010-03-23 17:17:29 +00002541llvm::Constant *CodeGenModule::GetAddrOfThunk(GlobalDecl GD,
2542 const ThunkInfo &Thunk) {
2543 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2544
2545 // Compute the mangled name.
2546 llvm::SmallString<256> Name;
2547 if (const CXXDestructorDecl* DD = dyn_cast<CXXDestructorDecl>(MD))
2548 getMangleContext().mangleCXXDtorThunk(DD, GD.getDtorType(), Thunk.This,
2549 Name);
2550 else
2551 getMangleContext().mangleThunk(MD, Thunk, Name);
2552
2553 const llvm::Type *Ty = getTypes().GetFunctionTypeForVtable(MD);
2554 return GetOrCreateLLVMFunction(Name, Ty, GlobalDecl());
2555}
2556
Anders Carlsson519c3282010-03-24 00:39:18 +00002557static llvm::Value *PerformTypeAdjustment(CodeGenFunction &CGF,
2558 llvm::Value *Ptr,
2559 int64_t NonVirtualAdjustment,
2560 int64_t VirtualAdjustment) {
2561 if (!NonVirtualAdjustment && !VirtualAdjustment)
2562 return Ptr;
2563
2564 const llvm::Type *Int8PtrTy =
2565 llvm::Type::getInt8PtrTy(CGF.getLLVMContext());
2566
2567 llvm::Value *V = CGF.Builder.CreateBitCast(Ptr, Int8PtrTy);
2568
2569 if (NonVirtualAdjustment) {
2570 // Do the non-virtual adjustment.
2571 V = CGF.Builder.CreateConstInBoundsGEP1_64(V, NonVirtualAdjustment);
2572 }
2573
2574 if (VirtualAdjustment) {
2575 const llvm::Type *PtrDiffTy =
2576 CGF.ConvertType(CGF.getContext().getPointerDiffType());
2577
2578 // Do the virtual adjustment.
2579 llvm::Value *VTablePtrPtr =
2580 CGF.Builder.CreateBitCast(V, Int8PtrTy->getPointerTo());
2581
2582 llvm::Value *VTablePtr = CGF.Builder.CreateLoad(VTablePtrPtr);
2583
2584 llvm::Value *OffsetPtr =
2585 CGF.Builder.CreateConstInBoundsGEP1_64(VTablePtr, VirtualAdjustment);
2586
2587 OffsetPtr = CGF.Builder.CreateBitCast(OffsetPtr, PtrDiffTy->getPointerTo());
2588
2589 // Load the adjustment offset from the vtable.
2590 llvm::Value *Offset = CGF.Builder.CreateLoad(OffsetPtr);
2591
2592 // Adjust our pointer.
2593 V = CGF.Builder.CreateInBoundsGEP(V, Offset);
2594 }
2595
2596 // Cast back to the original type.
2597 return CGF.Builder.CreateBitCast(V, Ptr->getType());
2598}
2599
2600void CodeGenFunction::GenerateThunk(llvm::Function *Fn, GlobalDecl GD,
2601 const ThunkInfo &Thunk) {
2602 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2603 const FunctionProtoType *FPT = MD->getType()->getAs<FunctionProtoType>();
2604 QualType ResultType = FPT->getResultType();
2605 QualType ThisType = MD->getThisType(getContext());
2606
2607 FunctionArgList FunctionArgs;
2608
2609 // FIXME: It would be nice if more of this code could be shared with
2610 // CodeGenFunction::GenerateCode.
2611
2612 // Create the implicit 'this' parameter declaration.
2613 CXXThisDecl = ImplicitParamDecl::Create(getContext(), 0,
2614 MD->getLocation(),
2615 &getContext().Idents.get("this"),
2616 ThisType);
2617
2618 // Add the 'this' parameter.
2619 FunctionArgs.push_back(std::make_pair(CXXThisDecl, CXXThisDecl->getType()));
2620
2621 // Add the rest of the parameters.
2622 for (FunctionDecl::param_const_iterator I = MD->param_begin(),
2623 E = MD->param_end(); I != E; ++I) {
2624 ParmVarDecl *Param = *I;
2625
2626 FunctionArgs.push_back(std::make_pair(Param, Param->getType()));
2627 }
2628
2629 StartFunction(GlobalDecl(), ResultType, Fn, FunctionArgs, SourceLocation());
2630
2631 // Adjust the 'this' pointer if necessary.
2632 llvm::Value *AdjustedThisPtr =
2633 PerformTypeAdjustment(*this, LoadCXXThis(),
2634 Thunk.This.NonVirtual,
2635 Thunk.This.VCallOffsetOffset);
2636
2637 CallArgList CallArgs;
2638
2639 // Add our adjusted 'this' pointer.
2640 CallArgs.push_back(std::make_pair(RValue::get(AdjustedThisPtr), ThisType));
2641
2642 // Add the rest of the parameters.
2643 for (FunctionDecl::param_const_iterator I = MD->param_begin(),
2644 E = MD->param_end(); I != E; ++I) {
2645 ParmVarDecl *Param = *I;
2646 QualType ArgType = Param->getType();
2647
2648 // FIXME: Declaring a DeclRefExpr on the stack is kinda icky.
2649 DeclRefExpr ArgExpr(Param, ArgType.getNonReferenceType(), SourceLocation());
2650 CallArgs.push_back(std::make_pair(EmitCallArg(&ArgExpr, ArgType), ArgType));
2651 }
2652
2653 // Get our callee.
2654 const llvm::Type *Ty =
2655 CGM.getTypes().GetFunctionType(CGM.getTypes().getFunctionInfo(MD),
2656 FPT->isVariadic());
2657 llvm::Value *Callee = CGM.GetAddrOfFunction(GD, Ty);
2658
2659 const CGFunctionInfo &FnInfo =
Rafael Espindola264ba482010-03-30 20:24:48 +00002660 CGM.getTypes().getFunctionInfo(ResultType, CallArgs,
2661 FPT->getExtInfo());
Anders Carlsson519c3282010-03-24 00:39:18 +00002662
2663 // Now emit our call.
2664 RValue RV = EmitCall(FnInfo, Callee, ReturnValueSlot(), CallArgs, MD);
2665
2666 if (!Thunk.Return.isEmpty()) {
2667 // Emit the return adjustment.
2668 bool NullCheckValue = !ResultType->isReferenceType();
2669
2670 llvm::BasicBlock *AdjustNull = 0;
2671 llvm::BasicBlock *AdjustNotNull = 0;
2672 llvm::BasicBlock *AdjustEnd = 0;
2673
2674 llvm::Value *ReturnValue = RV.getScalarVal();
2675
2676 if (NullCheckValue) {
2677 AdjustNull = createBasicBlock("adjust.null");
2678 AdjustNotNull = createBasicBlock("adjust.notnull");
2679 AdjustEnd = createBasicBlock("adjust.end");
2680
2681 llvm::Value *IsNull = Builder.CreateIsNull(ReturnValue);
2682 Builder.CreateCondBr(IsNull, AdjustNull, AdjustNotNull);
2683 EmitBlock(AdjustNotNull);
2684 }
2685
2686 ReturnValue = PerformTypeAdjustment(*this, ReturnValue,
2687 Thunk.Return.NonVirtual,
2688 Thunk.Return.VBaseOffsetOffset);
2689
2690 if (NullCheckValue) {
2691 Builder.CreateBr(AdjustEnd);
2692 EmitBlock(AdjustNull);
2693 Builder.CreateBr(AdjustEnd);
2694 EmitBlock(AdjustEnd);
2695
2696 llvm::PHINode *PHI = Builder.CreatePHI(ReturnValue->getType());
2697 PHI->reserveOperandSpace(2);
2698 PHI->addIncoming(ReturnValue, AdjustNotNull);
2699 PHI->addIncoming(llvm::Constant::getNullValue(ReturnValue->getType()),
2700 AdjustNull);
2701 ReturnValue = PHI;
2702 }
2703
2704 RV = RValue::get(ReturnValue);
2705 }
2706
2707 if (!ResultType->isVoidType())
2708 EmitReturnOfRValue(RV, ResultType);
2709
2710 FinishFunction();
2711
2712 // Destroy the 'this' declaration.
2713 CXXThisDecl->Destroy(getContext());
2714
2715 // Set the right linkage.
Anders Carlssonada087c2010-03-27 20:50:27 +00002716 Fn->setLinkage(CGM.getFunctionLinkage(MD));
Anders Carlsson519c3282010-03-24 00:39:18 +00002717
2718 // Set the right visibility.
2719 CGM.setGlobalVisibility(Fn, MD);
2720}
2721
Anders Carlssonfbf6ed42010-03-23 16:36:50 +00002722void CodeGenVTables::EmitThunk(GlobalDecl GD, const ThunkInfo &Thunk)
2723{
Anders Carlsson13d68982010-03-24 00:35:44 +00002724 llvm::Constant *Entry = CGM.GetAddrOfThunk(GD, Thunk);
Anders Carlsson7986ad52010-03-23 18:18:41 +00002725 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
Anders Carlsson19879c92010-03-23 17:17:29 +00002726
Anders Carlsson7986ad52010-03-23 18:18:41 +00002727 // Strip off a bitcast if we got one back.
Anders Carlsson13d68982010-03-24 00:35:44 +00002728 if (llvm::ConstantExpr *CE = dyn_cast<llvm::ConstantExpr>(Entry)) {
Anders Carlsson7986ad52010-03-23 18:18:41 +00002729 assert(CE->getOpcode() == llvm::Instruction::BitCast);
Anders Carlsson13d68982010-03-24 00:35:44 +00002730 Entry = CE->getOperand(0);
Anders Carlsson7986ad52010-03-23 18:18:41 +00002731 }
2732
Anders Carlsson7986ad52010-03-23 18:18:41 +00002733 // There's already a declaration with the same name, check if it has the same
2734 // type or if we need to replace it.
Anders Carlsson13d68982010-03-24 00:35:44 +00002735 if (cast<llvm::GlobalValue>(Entry)->getType()->getElementType() !=
2736 CGM.getTypes().GetFunctionTypeForVtable(MD)) {
2737 llvm::GlobalValue *OldThunkFn = cast<llvm::GlobalValue>(Entry);
Anders Carlsson7986ad52010-03-23 18:18:41 +00002738
2739 // If the types mismatch then we have to rewrite the definition.
2740 assert(OldThunkFn->isDeclaration() &&
2741 "Shouldn't replace non-declaration");
2742
2743 // Remove the name from the old thunk function and get a new thunk.
2744 OldThunkFn->setName(llvm::StringRef());
Anders Carlsson13d68982010-03-24 00:35:44 +00002745 Entry = CGM.GetAddrOfThunk(GD, Thunk);
Anders Carlsson7986ad52010-03-23 18:18:41 +00002746
2747 // If needed, replace the old thunk with a bitcast.
2748 if (!OldThunkFn->use_empty()) {
2749 llvm::Constant *NewPtrForOldDecl =
Anders Carlsson13d68982010-03-24 00:35:44 +00002750 llvm::ConstantExpr::getBitCast(Entry, OldThunkFn->getType());
Anders Carlsson7986ad52010-03-23 18:18:41 +00002751 OldThunkFn->replaceAllUsesWith(NewPtrForOldDecl);
2752 }
2753
2754 // Remove the old thunk.
2755 OldThunkFn->eraseFromParent();
2756 }
Anders Carlsson519c3282010-03-24 00:39:18 +00002757
2758 // Actually generate the thunk body.
2759 llvm::Function *ThunkFn = cast<llvm::Function>(Entry);
2760 CodeGenFunction(CGM).GenerateThunk(ThunkFn, GD, Thunk);
Anders Carlssonfbf6ed42010-03-23 16:36:50 +00002761}
2762
Anders Carlssonee5ab9f2010-03-23 04:59:02 +00002763void CodeGenVTables::EmitThunks(GlobalDecl GD)
2764{
Anders Carlssonfbf6ed42010-03-23 16:36:50 +00002765 const CXXMethodDecl *MD =
2766 cast<CXXMethodDecl>(GD.getDecl())->getCanonicalDecl();
2767
2768 // We don't need to generate thunks for the base destructor.
2769 if (isa<CXXDestructorDecl>(MD) && GD.getDtorType() == Dtor_Base)
2770 return;
2771
2772 const CXXRecordDecl *RD = MD->getParent();
2773
Anders Carlssonccd83d72010-03-24 16:42:11 +00002774 // Compute VTable related info for this class.
2775 ComputeVTableRelatedInformation(RD);
2776
Anders Carlssonfbf6ed42010-03-23 16:36:50 +00002777 ThunksMapTy::const_iterator I = Thunks.find(MD);
2778 if (I == Thunks.end()) {
Anders Carlssonccd83d72010-03-24 16:42:11 +00002779 // We did not find a thunk for this method.
2780 return;
Anders Carlssonfbf6ed42010-03-23 16:36:50 +00002781 }
Anders Carlssonccd83d72010-03-24 16:42:11 +00002782
Anders Carlssonfbf6ed42010-03-23 16:36:50 +00002783 const ThunkInfoVectorTy &ThunkInfoVector = I->second;
2784 for (unsigned I = 0, E = ThunkInfoVector.size(); I != E; ++I)
2785 EmitThunk(GD, ThunkInfoVector[I]);
Anders Carlssonee5ab9f2010-03-23 04:59:02 +00002786}
2787
Anders Carlssonccd83d72010-03-24 16:42:11 +00002788void CodeGenVTables::ComputeVTableRelatedInformation(const CXXRecordDecl *RD) {
2789 uint64_t *&LayoutData = VTableLayoutMap[RD];
2790
2791 // Check if we've computed this information before.
2792 if (LayoutData)
2793 return;
2794
Anders Carlsson94464812010-04-10 19:13:06 +00002795 VTableBuilder Builder(*this, RD, 0, /*MostDerivedClassIsVirtual=*/0, RD);
Anders Carlssonccd83d72010-03-24 16:42:11 +00002796
2797 // Add the VTable layout.
2798 uint64_t NumVTableComponents = Builder.getNumVTableComponents();
2799 LayoutData = new uint64_t[NumVTableComponents + 1];
2800
2801 // Store the number of components.
2802 LayoutData[0] = NumVTableComponents;
2803
2804 // Store the components.
2805 std::copy(Builder.vtable_components_data_begin(),
2806 Builder.vtable_components_data_end(),
2807 &LayoutData[1]);
2808
2809 // Add the known thunks.
2810 Thunks.insert(Builder.thunks_begin(), Builder.thunks_end());
2811
Anders Carlsson276701f2010-03-29 01:38:05 +00002812 // Add the thunks needed in this vtable.
2813 assert(!VTableThunksMap.count(RD) &&
2814 "Thunks already exists for this vtable!");
2815
2816 VTableThunksTy &VTableThunks = VTableThunksMap[RD];
2817 VTableThunks.append(Builder.vtable_thunks_begin(),
2818 Builder.vtable_thunks_end());
2819
2820 // Sort them.
2821 std::sort(VTableThunks.begin(), VTableThunks.end());
2822
Anders Carlsson66d567d2010-03-25 00:51:13 +00002823 // Add the address points.
Anders Carlsson94464812010-04-10 19:13:06 +00002824 for (VTableBuilder::AddressPointsMapTy::const_iterator I =
Anders Carlsson66d567d2010-03-25 00:51:13 +00002825 Builder.address_points_begin(), E = Builder.address_points_end();
2826 I != E; ++I) {
2827
2828 uint64_t &AddressPoint = AddressPoints[std::make_pair(RD, I->first)];
2829
2830 // Check if we already have the address points for this base.
2831 assert(!AddressPoint && "Address point already exists for this base!");
2832
2833 AddressPoint = I->second;
2834 }
2835
Anders Carlssonccd83d72010-03-24 16:42:11 +00002836 // If we don't have the vbase information for this class, insert it.
2837 // getVirtualBaseOffsetOffset will compute it separately without computing
2838 // the rest of the vtable related information.
2839 if (!RD->getNumVBases())
2840 return;
2841
2842 const RecordType *VBaseRT =
2843 RD->vbases_begin()->getType()->getAs<RecordType>();
2844 const CXXRecordDecl *VBase = cast<CXXRecordDecl>(VBaseRT->getDecl());
2845
2846 if (VirtualBaseClassOffsetOffsets.count(std::make_pair(RD, VBase)))
2847 return;
2848
Anders Carlsson94464812010-04-10 19:13:06 +00002849 for (VTableBuilder::VBaseOffsetOffsetsMapTy::const_iterator I =
Anders Carlssonccd83d72010-03-24 16:42:11 +00002850 Builder.getVBaseOffsetOffsets().begin(),
2851 E = Builder.getVBaseOffsetOffsets().end(); I != E; ++I) {
2852 // Insert all types.
2853 ClassPairTy ClassPair(RD, I->first);
2854
2855 VirtualBaseClassOffsetOffsets.insert(std::make_pair(ClassPair, I->second));
2856 }
2857}
2858
Anders Carlsson0d1407e2010-03-25 15:26:28 +00002859llvm::Constant *
2860CodeGenVTables::CreateVTableInitializer(const CXXRecordDecl *RD,
2861 const uint64_t *Components,
2862 unsigned NumComponents,
2863 const VTableThunksTy &VTableThunks) {
2864 llvm::SmallVector<llvm::Constant *, 64> Inits;
2865
2866 const llvm::Type *Int8PtrTy = llvm::Type::getInt8PtrTy(CGM.getLLVMContext());
2867
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002868 const llvm::Type *PtrDiffTy =
2869 CGM.getTypes().ConvertType(CGM.getContext().getPointerDiffType());
2870
2871 QualType ClassType = CGM.getContext().getTagDeclType(RD);
2872 llvm::Constant *RTTI = CGM.GetAddrOfRTTIDescriptor(ClassType);
2873
2874 unsigned NextVTableThunkIndex = 0;
2875
Anders Carlsson67d568a2010-03-29 05:40:50 +00002876 llvm::Constant* PureVirtualFn = 0;
2877
Anders Carlsson0d1407e2010-03-25 15:26:28 +00002878 for (unsigned I = 0; I != NumComponents; ++I) {
Anders Carlsson94464812010-04-10 19:13:06 +00002879 VTableComponent Component =
2880 VTableComponent::getFromOpaqueInteger(Components[I]);
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002881
2882 llvm::Constant *Init = 0;
2883
2884 switch (Component.getKind()) {
Anders Carlsson94464812010-04-10 19:13:06 +00002885 case VTableComponent::CK_VCallOffset:
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002886 Init = llvm::ConstantInt::get(PtrDiffTy, Component.getVCallOffset());
2887 Init = llvm::ConstantExpr::getIntToPtr(Init, Int8PtrTy);
2888 break;
Anders Carlsson94464812010-04-10 19:13:06 +00002889 case VTableComponent::CK_VBaseOffset:
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002890 Init = llvm::ConstantInt::get(PtrDiffTy, Component.getVBaseOffset());
2891 Init = llvm::ConstantExpr::getIntToPtr(Init, Int8PtrTy);
2892 break;
Anders Carlsson94464812010-04-10 19:13:06 +00002893 case VTableComponent::CK_OffsetToTop:
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002894 Init = llvm::ConstantInt::get(PtrDiffTy, Component.getOffsetToTop());
2895 Init = llvm::ConstantExpr::getIntToPtr(Init, Int8PtrTy);
2896 break;
Anders Carlsson94464812010-04-10 19:13:06 +00002897 case VTableComponent::CK_RTTI:
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002898 Init = llvm::ConstantExpr::getBitCast(RTTI, Int8PtrTy);
2899 break;
Anders Carlsson94464812010-04-10 19:13:06 +00002900 case VTableComponent::CK_FunctionPointer:
2901 case VTableComponent::CK_CompleteDtorPointer:
2902 case VTableComponent::CK_DeletingDtorPointer: {
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002903 GlobalDecl GD;
2904
2905 // Get the right global decl.
2906 switch (Component.getKind()) {
2907 default:
2908 llvm_unreachable("Unexpected vtable component kind");
Anders Carlsson94464812010-04-10 19:13:06 +00002909 case VTableComponent::CK_FunctionPointer:
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002910 GD = Component.getFunctionDecl();
2911 break;
Anders Carlsson94464812010-04-10 19:13:06 +00002912 case VTableComponent::CK_CompleteDtorPointer:
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002913 GD = GlobalDecl(Component.getDestructorDecl(), Dtor_Complete);
2914 break;
Anders Carlsson94464812010-04-10 19:13:06 +00002915 case VTableComponent::CK_DeletingDtorPointer:
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002916 GD = GlobalDecl(Component.getDestructorDecl(), Dtor_Deleting);
2917 break;
2918 }
2919
Anders Carlsson67d568a2010-03-29 05:40:50 +00002920 if (cast<CXXMethodDecl>(GD.getDecl())->isPure()) {
2921 // We have a pure virtual member function.
2922 if (!PureVirtualFn) {
2923 const llvm::FunctionType *Ty =
2924 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
2925 /*isVarArg=*/false);
2926 PureVirtualFn =
2927 CGM.CreateRuntimeFunction(Ty, "__cxa_pure_virtual");
2928 PureVirtualFn = llvm::ConstantExpr::getBitCast(PureVirtualFn,
2929 Int8PtrTy);
2930 }
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002931
Anders Carlsson67d568a2010-03-29 05:40:50 +00002932 Init = PureVirtualFn;
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002933 } else {
Anders Carlsson67d568a2010-03-29 05:40:50 +00002934 // Check if we should use a thunk.
2935 if (NextVTableThunkIndex < VTableThunks.size() &&
2936 VTableThunks[NextVTableThunkIndex].first == I) {
2937 const ThunkInfo &Thunk = VTableThunks[NextVTableThunkIndex].second;
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002938
Anders Carlsson67d568a2010-03-29 05:40:50 +00002939 Init = CGM.GetAddrOfThunk(GD, Thunk);
2940
2941 NextVTableThunkIndex++;
2942 } else {
2943 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2944 const llvm::Type *Ty = CGM.getTypes().GetFunctionTypeForVtable(MD);
2945
2946 Init = CGM.GetAddrOfFunction(GD, Ty);
2947 }
2948
2949 Init = llvm::ConstantExpr::getBitCast(Init, Int8PtrTy);
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002950 }
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002951 break;
2952 }
2953
Anders Carlsson94464812010-04-10 19:13:06 +00002954 case VTableComponent::CK_UnusedFunctionPointer:
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00002955 Init = llvm::ConstantExpr::getNullValue(Int8PtrTy);
2956 break;
2957 };
Anders Carlsson0d1407e2010-03-25 15:26:28 +00002958
2959 Inits.push_back(Init);
2960 }
2961
2962 llvm::ArrayType *ArrayType = llvm::ArrayType::get(Int8PtrTy, NumComponents);
2963 return llvm::ConstantArray::get(ArrayType, Inits.data(), Inits.size());
2964}
2965
2966/// GetGlobalVariable - Will return a global variable of the given type.
2967/// If a variable with a different type already exists then a new variable
2968/// with the right type will be created.
2969/// FIXME: We should move this to CodeGenModule and rename it to something
2970/// better and then use it in CGVTT and CGRTTI.
2971static llvm::GlobalVariable *
2972GetGlobalVariable(llvm::Module &Module, llvm::StringRef Name,
2973 const llvm::Type *Ty,
2974 llvm::GlobalValue::LinkageTypes Linkage) {
2975
2976 llvm::GlobalVariable *GV = Module.getNamedGlobal(Name);
2977 llvm::GlobalVariable *OldGV = 0;
2978
2979 if (GV) {
2980 // Check if the variable has the right type.
Anders Carlsson67d568a2010-03-29 05:40:50 +00002981 if (GV->getType()->getElementType() == Ty)
Anders Carlsson0d1407e2010-03-25 15:26:28 +00002982 return GV;
Anders Carlsson0d1407e2010-03-25 15:26:28 +00002983
2984 assert(GV->isDeclaration() && "Declaration has wrong type!");
2985
2986 OldGV = GV;
2987 }
2988
2989 // Create a new variable.
2990 GV = new llvm::GlobalVariable(Module, Ty, /*isConstant=*/true,
2991 Linkage, 0, Name);
2992
2993 if (OldGV) {
2994 // Replace occurrences of the old variable if needed.
2995 GV->takeName(OldGV);
2996
2997 if (!OldGV->use_empty()) {
2998 llvm::Constant *NewPtrForOldDecl =
2999 llvm::ConstantExpr::getBitCast(GV, OldGV->getType());
3000 OldGV->replaceAllUsesWith(NewPtrForOldDecl);
3001 }
3002
3003 OldGV->eraseFromParent();
3004 }
3005
3006 return GV;
3007}
3008
Anders Carlsson9dc338a2010-03-30 03:35:35 +00003009llvm::GlobalVariable *CodeGenVTables::GetAddrOfVTable(const CXXRecordDecl *RD) {
Anders Carlsson5c6c1d92010-03-24 03:57:14 +00003010 llvm::SmallString<256> OutName;
3011 CGM.getMangleContext().mangleCXXVtable(RD, OutName);
3012 llvm::StringRef Name = OutName.str();
Mike Stump85615df2009-11-19 04:04:36 +00003013
Anders Carlssonccd83d72010-03-24 16:42:11 +00003014 ComputeVTableRelatedInformation(RD);
3015
Anders Carlsson5c6c1d92010-03-24 03:57:14 +00003016 const llvm::Type *Int8PtrTy = llvm::Type::getInt8PtrTy(CGM.getLLVMContext());
Anders Carlssonccd83d72010-03-24 16:42:11 +00003017 llvm::ArrayType *ArrayType =
3018 llvm::ArrayType::get(Int8PtrTy, getNumVTableComponents(RD));
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003019
Anders Carlsson9dc338a2010-03-30 03:35:35 +00003020 return GetGlobalVariable(CGM.getModule(), Name, ArrayType,
3021 llvm::GlobalValue::ExternalLinkage);
Mike Stump380dd752009-11-10 07:44:33 +00003022}
Mike Stump8cfcb522009-11-11 20:26:26 +00003023
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003024void
3025CodeGenVTables::EmitVTableDefinition(llvm::GlobalVariable *VTable,
3026 llvm::GlobalVariable::LinkageTypes Linkage,
3027 const CXXRecordDecl *RD) {
3028 // Dump the vtable layout if necessary.
3029 if (CGM.getLangOptions().DumpVtableLayouts) {
Anders Carlsson94464812010-04-10 19:13:06 +00003030 VTableBuilder Builder(*this, RD, 0, /*MostDerivedClassIsVirtual=*/0, RD);
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003031
3032 Builder.dumpLayout(llvm::errs());
3033 }
3034
3035 assert(VTableThunksMap.count(RD) &&
3036 "No thunk status for this record decl!");
3037
3038 const VTableThunksTy& Thunks = VTableThunksMap[RD];
3039
3040 // Create and set the initializer.
3041 llvm::Constant *Init =
3042 CreateVTableInitializer(RD, getVTableComponentsData(RD),
3043 getNumVTableComponents(RD), Thunks);
3044 VTable->setInitializer(Init);
Anders Carlsson67d568a2010-03-29 05:40:50 +00003045
3046 // Set the correct linkage.
3047 VTable->setLinkage(Linkage);
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003048}
3049
Anders Carlssonff143f82010-03-25 00:35:49 +00003050llvm::GlobalVariable *
3051CodeGenVTables::GenerateConstructionVTable(const CXXRecordDecl *RD,
Anders Carlsson2c822f12010-03-26 03:56:54 +00003052 const BaseSubobject &Base,
3053 bool BaseIsVirtual,
3054 VTableAddressPointsMapTy& AddressPoints) {
Anders Carlsson94464812010-04-10 19:13:06 +00003055 VTableBuilder Builder(*this, Base.getBase(), Base.getBaseOffset(),
Anders Carlsson0d1407e2010-03-25 15:26:28 +00003056 /*MostDerivedClassIsVirtual=*/BaseIsVirtual, RD);
3057
Anders Carlsson6a5ab5d2010-03-25 16:49:53 +00003058 // Dump the vtable layout if necessary.
3059 if (CGM.getLangOptions().DumpVtableLayouts)
3060 Builder.dumpLayout(llvm::errs());
3061
3062 // Add the address points.
Anders Carlsson2c822f12010-03-26 03:56:54 +00003063 AddressPoints.insert(Builder.address_points_begin(),
3064 Builder.address_points_end());
Anders Carlsson0d1407e2010-03-25 15:26:28 +00003065
3066 // Get the mangled construction vtable name.
3067 llvm::SmallString<256> OutName;
3068 CGM.getMangleContext().mangleCXXCtorVtable(RD, Base.getBaseOffset() / 8,
3069 Base.getBase(), OutName);
3070 llvm::StringRef Name = OutName.str();
3071
3072 const llvm::Type *Int8PtrTy = llvm::Type::getInt8PtrTy(CGM.getLLVMContext());
3073 llvm::ArrayType *ArrayType =
3074 llvm::ArrayType::get(Int8PtrTy, Builder.getNumVTableComponents());
3075
3076 // Create the variable that will hold the construction vtable.
3077 llvm::GlobalVariable *VTable =
3078 GetGlobalVariable(CGM.getModule(), Name, ArrayType,
3079 llvm::GlobalValue::InternalLinkage);
3080
3081 // Add the thunks.
3082 VTableThunksTy VTableThunks;
3083 VTableThunks.append(Builder.vtable_thunks_begin(),
3084 Builder.vtable_thunks_end());
3085
Anders Carlssonaed924e2010-03-29 01:28:05 +00003086 // Sort them.
3087 std::sort(VTableThunks.begin(), VTableThunks.end());
3088
Anders Carlsson0d1407e2010-03-25 15:26:28 +00003089 // Create and set the initializer.
3090 llvm::Constant *Init =
3091 CreateVTableInitializer(Base.getBase(),
3092 Builder.vtable_components_data_begin(),
3093 Builder.getNumVTableComponents(), VTableThunks);
3094 VTable->setInitializer(Init);
3095
Anders Carlssonff143f82010-03-25 00:35:49 +00003096 return VTable;
3097}
3098
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003099void
3100CodeGenVTables::GenerateClassData(llvm::GlobalVariable::LinkageTypes Linkage,
3101 const CXXRecordDecl *RD) {
3102 llvm::GlobalVariable *&VTable = Vtables[RD];
3103 if (VTable) {
3104 assert(VTable->getInitializer() && "Vtable doesn't have a definition!");
3105 return;
3106 }
3107
Anders Carlsson9dc338a2010-03-30 03:35:35 +00003108 VTable = GetAddrOfVTable(RD);
3109 EmitVTableDefinition(VTable, Linkage, RD);
3110
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003111 GenerateVTT(Linkage, /*GenerateDefinition=*/true, RD);
Douglas Gregor1e201b42010-04-08 15:52:03 +00003112
3113 // If this is the magic class __cxxabiv1::__fundamental_type_info,
3114 // we will emit the typeinfo for the fundamental types. This is the
3115 // same behaviour as GCC.
3116 const DeclContext *DC = RD->getDeclContext();
3117 if (RD->getIdentifier() &&
3118 RD->getIdentifier()->isStr("__fundamental_type_info") &&
3119 isa<NamespaceDecl>(DC) &&
3120 cast<NamespaceDecl>(DC)->getIdentifier() &&
3121 cast<NamespaceDecl>(DC)->getIdentifier()->isStr("__cxxabiv1") &&
3122 DC->getParent()->isTranslationUnit())
3123 CGM.EmitFundamentalRTTIDescriptors();
Anders Carlssona7cde3b2010-03-29 03:38:52 +00003124}
3125
Anders Carlsson13189d02010-03-23 04:15:00 +00003126void CodeGenVTables::EmitVTableRelatedData(GlobalDecl GD) {
Anders Carlsson1a5e0d72009-11-30 23:41:22 +00003127 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
3128 const CXXRecordDecl *RD = MD->getParent();
3129
Anders Carlsson224c3122009-12-05 22:42:54 +00003130 // If the class doesn't have a vtable we don't need to emit one.
3131 if (!RD->isDynamicClass())
3132 return;
3133
Anders Carlsson7270ee42010-03-23 04:31:31 +00003134 // Check if we need to emit thunks for this function.
3135 if (MD->isVirtual())
Anders Carlssonee5ab9f2010-03-23 04:59:02 +00003136 EmitThunks(GD);
Anders Carlsson7270ee42010-03-23 04:31:31 +00003137
Anders Carlsson1a5e0d72009-11-30 23:41:22 +00003138 // Get the key function.
Anders Carlssonf53df232009-12-07 04:35:11 +00003139 const CXXMethodDecl *KeyFunction = CGM.getContext().getKeyFunction(RD);
Anders Carlsson1a5e0d72009-11-30 23:41:22 +00003140
Rafael Espindolae0f38672010-03-30 18:07:27 +00003141 TemplateSpecializationKind RDKind = RD->getTemplateSpecializationKind();
3142 TemplateSpecializationKind MDKind = MD->getTemplateSpecializationKind();
3143
Anders Carlsson224c3122009-12-05 22:42:54 +00003144 if (KeyFunction) {
3145 // We don't have the right key function.
3146 if (KeyFunction->getCanonicalDecl() != MD->getCanonicalDecl())
3147 return;
Rafael Espindolae0f38672010-03-30 18:07:27 +00003148 } else {
Rafael Espindola35d64612010-04-03 04:26:42 +00003149 // If we have no key funcion and this is a explicit instantiation declaration,
3150 // we will produce a vtable at the explicit instantiation. We don't need one
3151 // here.
3152 if (RDKind == clang::TSK_ExplicitInstantiationDeclaration)
3153 return;
3154
Rafael Espindolae0f38672010-03-30 18:07:27 +00003155 // If this is an explicit instantiation of a method, we don't need a vtable.
3156 // Since we have no key function, we will emit the vtable when we see
3157 // a use, and just defining a function is not an use.
Rafael Espindola35d64612010-04-03 04:26:42 +00003158 if (RDKind == TSK_ImplicitInstantiation &&
Rafael Espindolae0f38672010-03-30 18:07:27 +00003159 MDKind == TSK_ExplicitInstantiationDefinition)
3160 return;
Anders Carlsson1a5e0d72009-11-30 23:41:22 +00003161 }
3162
Rafael Espindolabbf58bb2010-03-10 02:19:29 +00003163 if (Vtables.count(RD))
3164 return;
Eli Friedman72649ed2009-12-06 22:01:30 +00003165
Rafael Espindolae0f38672010-03-30 18:07:27 +00003166 if (RDKind == TSK_ImplicitInstantiation)
Rafael Espindolabbf58bb2010-03-10 02:19:29 +00003167 CGM.DeferredVtables.push_back(RD);
3168 else
3169 GenerateClassData(CGM.getVtableLinkage(RD), RD);
Anders Carlsson1a5e0d72009-11-30 23:41:22 +00003170}