blob: 176e9c303785e82b5ef7c649ce8e49878194f260 [file] [log] [blame]
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001//===--- CGVtable.cpp - Emit LLVM Code for C++ vtables --------------------===//
2//
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 Carlssonf942ee02009-11-27 20:47:55 +000016#include "clang/AST/CXXInheritance.h"
Anders Carlsson2bb27f52009-10-11 22:13:54 +000017#include "clang/AST/RecordLayout.h"
Anders Carlssond420a312009-11-26 19:32:45 +000018#include "llvm/ADT/DenseSet.h"
Chandler Carruth94eab4a2010-02-13 10:38:52 +000019#include "llvm/Support/Compiler.h"
Anders Carlsson5d40c6f2010-02-11 08:02:13 +000020#include "llvm/Support/Format.h"
Zhongxing Xu1721ef72009-11-13 05:46:16 +000021#include <cstdio>
Anders Carlsson2bb27f52009-10-11 22:13:54 +000022
23using namespace clang;
24using namespace CodeGen;
25
Anders Carlssond59885022009-11-27 22:21:51 +000026namespace {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +000027
Anders Carlssone8ac42a2010-02-11 21:24:32 +000028/// FinalOverriders - Contains the final overrider member functions for all
29/// member functions in the base subobjects of a class.
30class FinalOverriders {
Anders Carlsson136bd192010-02-12 16:55:34 +000031public:
Anders Carlssoneee53d92010-02-13 02:02:03 +000032 /// BaseOffset - Represents an offset from a derived class to a direct or
33 /// indirect base class.
34 struct BaseOffset {
Anders Carlssoncf5a8822010-02-13 21:07:32 +000035 /// DerivedClass - The derived class.
36 const CXXRecordDecl *DerivedClass;
37
Anders Carlssoneee53d92010-02-13 02:02:03 +000038 /// VirtualBase - If the path from the derived class to the base class
39 /// involves a virtual base class, this holds its declaration.
40 const CXXRecordDecl *VirtualBase;
41
42 /// NonVirtualOffset - The offset from the derived class to the base class.
Anders Carlsson03db9e92010-02-17 02:05:23 +000043 /// (Or the offset from the virtual base class to the base class, if the
44 /// path from the derived class to the base class involves a virtual base
45 /// class.
Anders Carlssoncce9ee82010-02-13 23:17:31 +000046 int64_t NonVirtualOffset;
Anders Carlssoneee53d92010-02-13 02:02:03 +000047
Anders Carlssoncf5a8822010-02-13 21:07:32 +000048 BaseOffset() : DerivedClass(0), VirtualBase(0), NonVirtualOffset(0) { }
49 BaseOffset(const CXXRecordDecl *DerivedClass,
Anders Carlssoncce9ee82010-02-13 23:17:31 +000050 const CXXRecordDecl *VirtualBase, int64_t NonVirtualOffset)
Anders Carlssoncf5a8822010-02-13 21:07:32 +000051 : DerivedClass(DerivedClass), VirtualBase(VirtualBase),
52 NonVirtualOffset(NonVirtualOffset) { }
Anders Carlssoneee53d92010-02-13 02:02:03 +000053
Benjamin Kramere047e112010-02-13 09:15:07 +000054 bool isEmpty() const { return !NonVirtualOffset && !VirtualBase; }
Anders Carlssoneee53d92010-02-13 02:02:03 +000055 };
56
Anders Carlsson136bd192010-02-12 16:55:34 +000057 /// OverriderInfo - Information about a final overrider.
58 struct OverriderInfo {
59 /// Method - The method decl of the overrider.
60 const CXXMethodDecl *Method;
Anders Carlsson5a7654a2010-02-18 16:29:24 +000061
62 /// BaseOffset - the base offset of the overrider.
63 uint64_t BaseOffset;
Anders Carlsson136bd192010-02-12 16:55:34 +000064
Anders Carlsson5a7654a2010-02-18 16:29:24 +000065 OverriderInfo() : Method(0), BaseOffset(0) { }
Anders Carlsson136bd192010-02-12 16:55:34 +000066 };
67
68private:
Anders Carlssone8ac42a2010-02-11 21:24:32 +000069 /// MostDerivedClass - The most derived class for which the final overriders
70 /// are stored.
71 const CXXRecordDecl *MostDerivedClass;
72
73 ASTContext &Context;
74
75 /// MostDerivedClassLayout - the AST record layout of the most derived class.
76 const ASTRecordLayout &MostDerivedClassLayout;
77
Anders Carlssoneee53d92010-02-13 02:02:03 +000078 /// BaseSubobjectMethodPairTy - Uniquely identifies a member function
79 /// in a base subobject.
80 typedef std::pair<BaseSubobject, const CXXMethodDecl *>
81 BaseSubobjectMethodPairTy;
82
83 typedef llvm::DenseMap<BaseSubobjectMethodPairTy,
Anders Carlsson136bd192010-02-12 16:55:34 +000084 OverriderInfo> OverridersMapTy;
Anders Carlssone8ac42a2010-02-11 21:24:32 +000085
86 /// OverridersMap - The final overriders for all virtual member functions of
87 /// all the base subobjects of the most derived class.
88 OverridersMapTy OverridersMap;
89
Anders Carlsson6a7e6a42010-02-14 00:37:35 +000090 /// VisitedVirtualBases - A set of all the visited virtual bases, used to
91 /// avoid visiting virtual bases more than once.
92 llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBases;
93
Anders Carlssoneee53d92010-02-13 02:02:03 +000094 typedef llvm::DenseMap<BaseSubobjectMethodPairTy, BaseOffset>
95 AdjustmentOffsetsMapTy;
96
97 /// ReturnAdjustments - Holds return adjustments for all the overriders that
98 /// need to perform return value adjustments.
99 AdjustmentOffsetsMapTy ReturnAdjustments;
100
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000101 /// ThisAdjustments - Holds 'this' adjustments for all the overriders that
102 /// need them.
103 AdjustmentOffsetsMapTy ThisAdjustments;
104
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000105 typedef llvm::SmallVector<uint64_t, 1> OffsetVectorTy;
106
107 /// SubobjectOffsetsMapTy - This map is used for keeping track of all the
108 /// base subobject offsets that a single class declaration might refer to.
109 ///
110 /// For example, in:
111 ///
112 /// struct A { virtual void f(); };
113 /// struct B1 : A { };
114 /// struct B2 : A { };
115 /// struct C : B1, B2 { virtual void f(); };
116 ///
117 /// when we determine that C::f() overrides A::f(), we need to update the
118 /// overriders map for both A-in-B1 and A-in-B2 and the subobject offsets map
119 /// will have the subobject offsets for both A copies.
120 typedef llvm::DenseMap<const CXXRecordDecl *, OffsetVectorTy>
121 SubobjectOffsetsMapTy;
122
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000123 /// ComputeFinalOverriders - Compute the final overriders for a given base
124 /// subobject (and all its direct and indirect bases).
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000125 void ComputeFinalOverriders(BaseSubobject Base,
Anders Carlsson231461f2010-02-17 17:48:25 +0000126 bool BaseSubobjectIsVisitedVBase,
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000127 SubobjectOffsetsMapTy &Offsets);
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000128
129 /// AddOverriders - Add the final overriders for this base subobject to the
130 /// map of final overriders.
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000131 void AddOverriders(BaseSubobject Base, SubobjectOffsetsMapTy &Offsets);
132
133 /// PropagateOverrider - Propagate the NewMD overrider to all the functions
134 /// that OldMD overrides. For example, if we have:
135 ///
136 /// struct A { virtual void f(); };
137 /// struct B : A { virtual void f(); };
138 /// struct C : B { virtual void f(); };
139 ///
140 /// and we want to override B::f with C::f, we also need to override A::f with
141 /// C::f.
142 void PropagateOverrider(const CXXMethodDecl *OldMD,
Anders Carlssona678aa12010-02-13 22:23:31 +0000143 BaseSubobject NewBase,
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000144 const CXXMethodDecl *NewMD,
145 SubobjectOffsetsMapTy &Offsets);
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000146
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000147 /// ComputeThisAdjustmentBaseOffset - Compute the base offset for adjusting
Anders Carlsson258a1e32010-02-14 00:16:19 +0000148 /// the 'this' pointer from the base subobject to the derived subobject.
Anders Carlsson073a0c82010-02-14 00:44:19 +0000149 BaseOffset ComputeThisAdjustmentBaseOffset(BaseSubobject Base,
Anders Carlsson258a1e32010-02-14 00:16:19 +0000150 BaseSubobject Derived);
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000151
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000152 static void MergeSubobjectOffsets(const SubobjectOffsetsMapTy &NewOffsets,
153 SubobjectOffsetsMapTy &Offsets);
154
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000155public:
156 explicit FinalOverriders(const CXXRecordDecl *MostDerivedClass);
157
158 /// getOverrider - Get the final overrider for the given method declaration in
159 /// the given base subobject.
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000160 OverriderInfo getOverrider(BaseSubobject Base,
161 const CXXMethodDecl *MD) const {
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000162 assert(OverridersMap.count(std::make_pair(Base, MD)) &&
163 "Did not find overrider!");
164
165 return OverridersMap.lookup(std::make_pair(Base, MD));
166 }
167
Anders Carlssond3adb0c2010-02-13 23:40:17 +0000168 /// getReturnAdjustmentOffset - Get the return adjustment offset for the
169 /// method decl in the given base subobject. Returns an empty base offset if
170 /// no adjustment is needed.
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000171 BaseOffset getReturnAdjustmentOffset(BaseSubobject Base,
172 const CXXMethodDecl *MD) const {
173 return ReturnAdjustments.lookup(std::make_pair(Base, MD));
174 }
175
Anders Carlssond3adb0c2010-02-13 23:40:17 +0000176 /// getThisAdjustmentOffset - Get the 'this' pointer adjustment offset for the
177 /// method decl in the given base subobject. Returns an empty base offset if
178 /// no adjustment is needed.
179 BaseOffset getThisAdjustmentOffset(BaseSubobject Base,
180 const CXXMethodDecl *MD) const {
181 return ThisAdjustments.lookup(std::make_pair(Base, MD));
182 }
183
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000184 /// dump - dump the final overriders.
Anders Carlsson6a7e6a42010-02-14 00:37:35 +0000185 void dump() {
186 assert(VisitedVirtualBases.empty() &&
187 "Visited virtual bases aren't empty!");
188 dump(llvm::errs(), BaseSubobject(MostDerivedClass, 0));
189 VisitedVirtualBases.clear();
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000190 }
191
192 /// dump - dump the final overriders for a base subobject, and all its direct
193 /// and indirect base subobjects.
Anders Carlsson6a7e6a42010-02-14 00:37:35 +0000194 void dump(llvm::raw_ostream &Out, BaseSubobject Base);
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000195};
Anders Carlssoneee53d92010-02-13 02:02:03 +0000196
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000197FinalOverriders::FinalOverriders(const CXXRecordDecl *MostDerivedClass)
198 : MostDerivedClass(MostDerivedClass),
199 Context(MostDerivedClass->getASTContext()),
200 MostDerivedClassLayout(Context.getASTRecordLayout(MostDerivedClass)) {
201
202 // Compute the final overriders.
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000203 SubobjectOffsetsMapTy Offsets;
Anders Carlsson231461f2010-02-17 17:48:25 +0000204 ComputeFinalOverriders(BaseSubobject(MostDerivedClass, 0),
205 /*BaseSubobjectIsVisitedVBase=*/false, Offsets);
206 VisitedVirtualBases.clear();
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000207
208 // And dump them (for now).
209 dump();
Anders Carlsson3f9917d2010-02-13 21:33:22 +0000210
211 // Also dump the base offsets (for now).
212 for (SubobjectOffsetsMapTy::const_iterator I = Offsets.begin(),
213 E = Offsets.end(); I != E; ++I) {
214 const OffsetVectorTy& OffsetVector = I->second;
215
216 llvm::errs() << "Base offsets for ";
217 llvm::errs() << I->first->getQualifiedNameAsString() << '\n';
218
219 for (unsigned I = 0, E = OffsetVector.size(); I != E; ++I)
220 llvm::errs() << " " << I << " - " << OffsetVector[I] << '\n';
221 }
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000222}
223
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000224void FinalOverriders::AddOverriders(BaseSubobject Base,
225 SubobjectOffsetsMapTy &Offsets) {
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000226 const CXXRecordDecl *RD = Base.getBase();
227
228 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
229 E = RD->method_end(); I != E; ++I) {
230 const CXXMethodDecl *MD = *I;
231
232 if (!MD->isVirtual())
233 continue;
234
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000235 // First, propagate the overrider.
Anders Carlssona678aa12010-02-13 22:23:31 +0000236 PropagateOverrider(MD, Base, MD, Offsets);
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000237
238 // Add the overrider as the final overrider of itself.
Anders Carlsson136bd192010-02-12 16:55:34 +0000239 OverriderInfo& Overrider = OverridersMap[std::make_pair(Base, MD)];
240 assert(!Overrider.Method && "Overrider should not exist yet!");
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000241
Anders Carlsson5a7654a2010-02-18 16:29:24 +0000242 Overrider.BaseOffset = Base.getBaseOffset();
Anders Carlsson136bd192010-02-12 16:55:34 +0000243 Overrider.Method = MD;
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000244 }
245}
246
Anders Carlsson258a1e32010-02-14 00:16:19 +0000247static FinalOverriders::BaseOffset
248ComputeBaseOffset(ASTContext &Context, const CXXRecordDecl *DerivedRD,
249 const CXXBasePath &Path) {
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000250 int64_t NonVirtualOffset = 0;
Anders Carlssoneee53d92010-02-13 02:02:03 +0000251
Anders Carlssonf3f67842010-02-13 20:41:15 +0000252 unsigned NonVirtualStart = 0;
253 const CXXRecordDecl *VirtualBase = 0;
254
255 // First, look for the virtual base class.
256 for (unsigned I = 0, E = Path.size(); I != E; ++I) {
257 const CXXBasePathElement &Element = Path[I];
258
259 if (Element.Base->isVirtual()) {
260 // FIXME: Can we break when we find the first virtual base?
261 // (If we can't, can't we just iterate over the path in reverse order?)
262 NonVirtualStart = I + 1;
263 QualType VBaseType = Element.Base->getType();
264 VirtualBase =
265 cast<CXXRecordDecl>(VBaseType->getAs<RecordType>()->getDecl());
266 }
267 }
268
269 // Now compute the non-virtual offset.
270 for (unsigned I = NonVirtualStart, E = Path.size(); I != E; ++I) {
271 const CXXBasePathElement &Element = Path[I];
Anders Carlssoneee53d92010-02-13 02:02:03 +0000272
273 // Check the base class offset.
274 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Element.Class);
275
276 const RecordType *BaseType = Element.Base->getType()->getAs<RecordType>();
277 const CXXRecordDecl *Base = cast<CXXRecordDecl>(BaseType->getDecl());
278
279 NonVirtualOffset += Layout.getBaseClassOffset(Base);
280 }
281
282 // FIXME: This should probably use CharUnits or something. Maybe we should
283 // even change the base offsets in ASTRecordLayout to be specified in
284 // CharUnits.
Anders Carlssoncf5a8822010-02-13 21:07:32 +0000285 return FinalOverriders::BaseOffset(DerivedRD, VirtualBase,
286 NonVirtualOffset / 8);
Anders Carlsson258a1e32010-02-14 00:16:19 +0000287
288}
289
290static FinalOverriders::BaseOffset
291ComputeBaseOffset(ASTContext &Context, const CXXRecordDecl *BaseRD,
292 const CXXRecordDecl *DerivedRD) {
293 CXXBasePaths Paths(/*FindAmbiguities=*/false,
294 /*RecordPaths=*/true, /*DetectVirtual=*/false);
295
296 if (!const_cast<CXXRecordDecl *>(DerivedRD)->
297 isDerivedFrom(const_cast<CXXRecordDecl *>(BaseRD), Paths)) {
298 assert(false && "Class must be derived from the passed in base class!");
299 return FinalOverriders::BaseOffset();
300 }
301
302 return ComputeBaseOffset(Context, DerivedRD, Paths.front());
Anders Carlssoneee53d92010-02-13 02:02:03 +0000303}
304
305static FinalOverriders::BaseOffset
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000306ComputeReturnAdjustmentBaseOffset(ASTContext &Context,
307 const CXXMethodDecl *DerivedMD,
308 const CXXMethodDecl *BaseMD) {
Anders Carlssoneee53d92010-02-13 02:02:03 +0000309 const FunctionType *BaseFT = BaseMD->getType()->getAs<FunctionType>();
310 const FunctionType *DerivedFT = DerivedMD->getType()->getAs<FunctionType>();
311
312 // Canonicalize the return types.
313 CanQualType CanDerivedReturnType =
314 Context.getCanonicalType(DerivedFT->getResultType());
315 CanQualType CanBaseReturnType =
316 Context.getCanonicalType(BaseFT->getResultType());
317
318 assert(CanDerivedReturnType->getTypeClass() ==
319 CanBaseReturnType->getTypeClass() &&
320 "Types must have same type class!");
321
322 if (CanDerivedReturnType == CanBaseReturnType) {
323 // No adjustment needed.
324 return FinalOverriders::BaseOffset();
325 }
326
327 if (isa<ReferenceType>(CanDerivedReturnType)) {
328 CanDerivedReturnType =
329 CanDerivedReturnType->getAs<ReferenceType>()->getPointeeType();
330 CanBaseReturnType =
331 CanBaseReturnType->getAs<ReferenceType>()->getPointeeType();
332 } else if (isa<PointerType>(CanDerivedReturnType)) {
333 CanDerivedReturnType =
334 CanDerivedReturnType->getAs<PointerType>()->getPointeeType();
335 CanBaseReturnType =
336 CanBaseReturnType->getAs<PointerType>()->getPointeeType();
337 } else {
338 assert(false && "Unexpected return type!");
339 }
340
341 // We need to compare unqualified types here; consider
342 // const T *Base::foo();
343 // T *Derived::foo();
344 if (CanDerivedReturnType.getUnqualifiedType() ==
345 CanBaseReturnType.getUnqualifiedType()) {
346 // No adjustment needed.
347 return FinalOverriders::BaseOffset();
348 }
349
350 const CXXRecordDecl *DerivedRD =
351 cast<CXXRecordDecl>(cast<RecordType>(CanDerivedReturnType)->getDecl());
352
353 const CXXRecordDecl *BaseRD =
354 cast<CXXRecordDecl>(cast<RecordType>(CanBaseReturnType)->getDecl());
355
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000356 return ComputeBaseOffset(Context, BaseRD, DerivedRD);
Anders Carlssoneee53d92010-02-13 02:02:03 +0000357}
358
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000359FinalOverriders::BaseOffset
Anders Carlsson258a1e32010-02-14 00:16:19 +0000360FinalOverriders::ComputeThisAdjustmentBaseOffset(BaseSubobject Base,
361 BaseSubobject Derived) {
362 const CXXRecordDecl *BaseRD = Base.getBase();
363 const CXXRecordDecl *DerivedRD = Derived.getBase();
364
365 CXXBasePaths Paths(/*FindAmbiguities=*/true,
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000366 /*RecordPaths=*/true, /*DetectVirtual=*/true);
367
368 if (!const_cast<CXXRecordDecl *>(DerivedRD)->
369 isDerivedFrom(const_cast<CXXRecordDecl *>(BaseRD), Paths)) {
370 assert(false && "Class must be derived from the passed in base class!");
Anders Carlsson03db9e92010-02-17 02:05:23 +0000371 return BaseOffset();
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000372 }
373
Anders Carlsson03db9e92010-02-17 02:05:23 +0000374 // We have to go through all the paths, and see which one leads us to the
375 // right base subobject.
376 for (CXXBasePaths::const_paths_iterator I = Paths.begin(), E = Paths.end();
377 I != E; ++I) {
378 BaseOffset Offset = ComputeBaseOffset(Context, DerivedRD, *I);
379
380 // FIXME: Should not use * 8 here.
381 uint64_t OffsetToBaseSubobject = Offset.NonVirtualOffset * 8;
382
383 if (Offset.VirtualBase) {
384 // If we have a virtual base class, the non-virtual offset is relative
385 // to the virtual base class offset.
386 const ASTRecordLayout &MostDerivedClassLayout =
387 Context.getASTRecordLayout(MostDerivedClass);
388
389 /// Get the virtual base offset, relative to the most derived class
390 /// layout.
391 OffsetToBaseSubobject +=
392 MostDerivedClassLayout.getVBaseClassOffset(Offset.VirtualBase);
393 } else {
394 // Otherwise, the non-virtual offset is relative to the derived class
395 // offset.
396 OffsetToBaseSubobject += Derived.getBaseOffset();
397 }
398
399 // Check if this path gives us the right base subobject.
400 if (OffsetToBaseSubobject == Base.getBaseOffset()) {
401 // Since we're going from the base class _to_ the derived class, we'll
402 // invert the non-virtual offset here.
403 Offset.NonVirtualOffset = -Offset.NonVirtualOffset;
404 return Offset;
405 }
406 }
407
408 return BaseOffset();
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000409}
410
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000411void FinalOverriders::PropagateOverrider(const CXXMethodDecl *OldMD,
Anders Carlssona678aa12010-02-13 22:23:31 +0000412 BaseSubobject NewBase,
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000413 const CXXMethodDecl *NewMD,
414 SubobjectOffsetsMapTy &Offsets) {
415 for (CXXMethodDecl::method_iterator I = OldMD->begin_overridden_methods(),
416 E = OldMD->end_overridden_methods(); I != E; ++I) {
417 const CXXMethodDecl *OverriddenMD = *I;
418 const CXXRecordDecl *OverriddenRD = OverriddenMD->getParent();
419
420 // We want to override OverriddenMD in all subobjects, for example:
421 //
422 /// struct A { virtual void f(); };
423 /// struct B1 : A { };
424 /// struct B2 : A { };
425 /// struct C : B1, B2 { virtual void f(); };
426 ///
427 /// When overriding A::f with C::f we need to do so in both A subobjects.
428 const OffsetVectorTy &OffsetVector = Offsets[OverriddenRD];
429
430 // Go through all the subobjects.
431 for (unsigned I = 0, E = OffsetVector.size(); I != E; ++I) {
432 uint64_t Offset = OffsetVector[I];
433
Anders Carlsson258a1e32010-02-14 00:16:19 +0000434 BaseSubobject OverriddenSubobject = BaseSubobject(OverriddenRD, Offset);
Anders Carlssoneee53d92010-02-13 02:02:03 +0000435 BaseSubobjectMethodPairTy SubobjectAndMethod =
Anders Carlsson258a1e32010-02-14 00:16:19 +0000436 std::make_pair(OverriddenSubobject, OverriddenMD);
Anders Carlssoneee53d92010-02-13 02:02:03 +0000437
438 OverriderInfo &Overrider = OverridersMap[SubobjectAndMethod];
439
Anders Carlsson136bd192010-02-12 16:55:34 +0000440 assert(Overrider.Method && "Did not find existing overrider!");
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000441
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000442 // Check if we need return adjustments or base adjustments.
Anders Carlssonc1290ad2010-02-13 21:16:54 +0000443 // (We don't want to do this for pure virtual member functions).
444 if (!NewMD->isPure()) {
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000445 // Get the return adjustment base offset.
Anders Carlssonc1290ad2010-02-13 21:16:54 +0000446 BaseOffset ReturnBaseOffset =
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000447 ComputeReturnAdjustmentBaseOffset(Context, NewMD, OverriddenMD);
448
Anders Carlssonc1290ad2010-02-13 21:16:54 +0000449 if (!ReturnBaseOffset.isEmpty()) {
450 // Store the return adjustment base offset.
451 ReturnAdjustments[SubobjectAndMethod] = ReturnBaseOffset;
452 }
Anders Carlssona678aa12010-02-13 22:23:31 +0000453
454 // Check if we need a 'this' adjustment base offset as well.
455 if (Offset != NewBase.getBaseOffset()) {
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000456 BaseOffset ThisBaseOffset =
Anders Carlsson258a1e32010-02-14 00:16:19 +0000457 ComputeThisAdjustmentBaseOffset(OverriddenSubobject,
458 NewBase);
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000459 assert(!ThisBaseOffset.isEmpty() &&
460 "Should not get an empty 'this' adjustment!");
461
462 ThisAdjustments[SubobjectAndMethod] = ThisBaseOffset;
Anders Carlssona678aa12010-02-13 22:23:31 +0000463 }
Anders Carlsson8e661e12010-02-12 17:13:23 +0000464 }
465
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000466 // Set the new overrider.
Anders Carlsson5a7654a2010-02-18 16:29:24 +0000467 Overrider.BaseOffset = NewBase.getBaseOffset();
Anders Carlsson136bd192010-02-12 16:55:34 +0000468 Overrider.Method = NewMD;
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000469
470 // And propagate it further.
Anders Carlssona678aa12010-02-13 22:23:31 +0000471 PropagateOverrider(OverriddenMD, NewBase, NewMD, Offsets);
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000472 }
473 }
474}
475
476void
477FinalOverriders::MergeSubobjectOffsets(const SubobjectOffsetsMapTy &NewOffsets,
478 SubobjectOffsetsMapTy &Offsets) {
479 // Iterate over the new offsets.
480 for (SubobjectOffsetsMapTy::const_iterator I = NewOffsets.begin(),
481 E = NewOffsets.end(); I != E; ++I) {
482 const CXXRecordDecl *NewRD = I->first;
Anders Carlsson3f9917d2010-02-13 21:33:22 +0000483 const OffsetVectorTy& NewOffsetVector = I->second;
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000484
Anders Carlsson3f9917d2010-02-13 21:33:22 +0000485 OffsetVectorTy &OffsetVector = Offsets[NewRD];
486 if (OffsetVector.empty()) {
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000487 // There were no previous offsets in this vector, just insert all entries
Anders Carlsson3f9917d2010-02-13 21:33:22 +0000488 // from the new offset vector.
489 OffsetVector.append(NewOffsetVector.begin(), NewOffsetVector.end());
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000490 continue;
491 }
492
Anders Carlsson3f9917d2010-02-13 21:33:22 +0000493 // We need to merge the new offsets vector into the old, but we don't want
494 // to have duplicate entries. Do this by inserting the old offsets in a set
495 // so they'll be unique. After this, we iterate over the new offset vector
496 // and only append elements that aren't in the set.
497
498 // First, add the existing offsets to the set.
499 llvm::SmallSet<uint64_t, 4> OffsetSet;
500 for (unsigned I = 0, E = OffsetVector.size(); I != E; ++I) {
501 bool Inserted = OffsetSet.insert(OffsetVector[I]);
502 if (!Inserted)
503 assert(false && "Set of offsets should be unique!");
504 }
505
506 // Next, only add the new offsets if they are not already in the set.
507 for (unsigned I = 0, E = NewOffsetVector.size(); I != E; ++I) {
508 uint64_t Offset = NewOffsetVector[I];
509
510 if (OffsetSet.count(Offset)) {
511 // Ignore the offset.
512 continue;
513 }
514
515 // Otherwise, add it to the offsets vector.
516 OffsetVector.push_back(Offset);
517 }
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000518 }
519}
520
521void FinalOverriders::ComputeFinalOverriders(BaseSubobject Base,
Anders Carlsson231461f2010-02-17 17:48:25 +0000522 bool BaseSubobjectIsVisitedVBase,
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000523 SubobjectOffsetsMapTy &Offsets) {
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000524 const CXXRecordDecl *RD = Base.getBase();
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000525 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000526
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000527 SubobjectOffsetsMapTy NewOffsets;
528
529 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
530 E = RD->bases_end(); I != E; ++I) {
531 const CXXRecordDecl *BaseDecl =
532 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
533
Anders Carlsson033d4862010-02-14 17:05:59 +0000534 // Ignore bases that don't have any virtual member functions.
535 if (!BaseDecl->isPolymorphic())
536 continue;
537
Anders Carlsson231461f2010-02-17 17:48:25 +0000538 bool IsVisitedVirtualBase = false;
Anders Carlsson6a7e6a42010-02-14 00:37:35 +0000539 uint64_t BaseOffset;
540 if (I->isVirtual()) {
Anders Carlsson231461f2010-02-17 17:48:25 +0000541 if (!VisitedVirtualBases.insert(BaseDecl))
542 IsVisitedVirtualBase = true;
Anders Carlsson6a7e6a42010-02-14 00:37:35 +0000543 BaseOffset = MostDerivedClassLayout.getVBaseClassOffset(BaseDecl);
544 } else {
545 BaseOffset = Layout.getBaseClassOffset(BaseDecl) + Base.getBaseOffset();
546 }
547
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000548 // Compute the final overriders for this base.
Anders Carlsson231461f2010-02-17 17:48:25 +0000549 // We always want to compute the final overriders, even if the base is a
550 // visited virtual base. Consider:
551 //
552 // struct A {
553 // virtual void f();
554 // virtual void g();
555 // };
556 //
557 // struct B : virtual A {
558 // void f();
559 // };
560 //
561 // struct C : virtual A {
562 // void g ();
563 // };
564 //
565 // struct D : B, C { };
566 //
567 // Here, we still want to compute the overriders for A as a base of C,
568 // because otherwise we'll miss that C::g overrides A::f.
569 ComputeFinalOverriders(BaseSubobject(BaseDecl, BaseOffset),
570 IsVisitedVirtualBase, NewOffsets);
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000571 }
572
573 /// Now add the overriders for this particular subobject.
Anders Carlsson231461f2010-02-17 17:48:25 +0000574 /// (We don't want to do this more than once for a virtual base).
575 if (!BaseSubobjectIsVisitedVBase)
576 AddOverriders(Base, NewOffsets);
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000577
578 // And merge the newly discovered subobject offsets.
579 MergeSubobjectOffsets(NewOffsets, Offsets);
580
581 /// Finally, add the offset for our own subobject.
582 Offsets[RD].push_back(Base.getBaseOffset());
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000583}
584
Anders Carlsson6a7e6a42010-02-14 00:37:35 +0000585void FinalOverriders::dump(llvm::raw_ostream &Out, BaseSubobject Base) {
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000586 const CXXRecordDecl *RD = Base.getBase();
587 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
588
589 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
590 E = RD->bases_end(); I != E; ++I) {
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000591 const CXXRecordDecl *BaseDecl =
592 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
593
Anders Carlsson033d4862010-02-14 17:05:59 +0000594 // Ignore bases that don't have any virtual member functions.
595 if (!BaseDecl->isPolymorphic())
596 continue;
597
Anders Carlsson6a7e6a42010-02-14 00:37:35 +0000598 uint64_t BaseOffset;
599 if (I->isVirtual()) {
600 if (!VisitedVirtualBases.insert(BaseDecl)) {
601 // We've visited this base before.
602 continue;
603 }
604
605 BaseOffset = MostDerivedClassLayout.getVBaseClassOffset(BaseDecl);
606 } else {
607 BaseOffset = Layout.getBaseClassOffset(BaseDecl) +
608 Base.getBaseOffset();
609 }
610
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000611 dump(Out, BaseSubobject(BaseDecl, BaseOffset));
612 }
613
614 Out << "Final overriders for (" << RD->getQualifiedNameAsString() << ", ";
615 Out << Base.getBaseOffset() << ")\n";
616
617 // Now dump the overriders for this base subobject.
618 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
619 E = RD->method_end(); I != E; ++I) {
620 const CXXMethodDecl *MD = *I;
621
622 if (!MD->isVirtual())
623 continue;
624
Anders Carlsson136bd192010-02-12 16:55:34 +0000625 OverriderInfo Overrider = getOverrider(Base, MD);
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000626
627 Out << " " << MD->getQualifiedNameAsString() << " - ";
Anders Carlsson8e661e12010-02-12 17:13:23 +0000628 Out << Overrider.Method->getQualifiedNameAsString();
Anders Carlssoneee53d92010-02-13 02:02:03 +0000629
Benjamin Kramer02c67372010-02-13 09:11:28 +0000630 AdjustmentOffsetsMapTy::const_iterator AI =
Anders Carlssoneee53d92010-02-13 02:02:03 +0000631 ReturnAdjustments.find(std::make_pair(Base, MD));
Benjamin Kramer02c67372010-02-13 09:11:28 +0000632 if (AI != ReturnAdjustments.end()) {
633 const BaseOffset &Offset = AI->second;
Anders Carlssonf3f67842010-02-13 20:41:15 +0000634
635 Out << " [ret-adj: ";
636 if (Offset.VirtualBase)
637 Out << Offset.VirtualBase->getQualifiedNameAsString() << " vbase, ";
Anders Carlssoneee53d92010-02-13 02:02:03 +0000638
Anders Carlssonf3f67842010-02-13 20:41:15 +0000639 Out << Offset.NonVirtualOffset << " nv]";
Anders Carlssoneee53d92010-02-13 02:02:03 +0000640 }
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000641
642 AI = ThisAdjustments.find(std::make_pair(Base, MD));
643 if (AI != ThisAdjustments.end()) {
644 const BaseOffset &Offset = AI->second;
645
646 Out << " [this-adj: ";
647 if (Offset.VirtualBase)
648 Out << Offset.VirtualBase->getQualifiedNameAsString() << " vbase, ";
649
650 Out << Offset.NonVirtualOffset << " nv]";
651 }
652
Anders Carlsson8e661e12010-02-12 17:13:23 +0000653 Out << "\n";
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000654 }
655}
656
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000657/// VtableComponent - Represents a single component in a vtable.
658class VtableComponent {
659public:
660 enum Kind {
661 CK_VCallOffset,
662 CK_VBaseOffset,
663 CK_OffsetToTop,
664 CK_RTTI,
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000665 CK_FunctionPointer,
666
667 /// CK_CompleteDtorPointer - A pointer to the complete destructor.
668 CK_CompleteDtorPointer,
669
670 /// CK_DeletingDtorPointer - A pointer to the deleting destructor.
671 CK_DeletingDtorPointer
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000672 };
673
Anders Carlssonb0a588f2010-02-17 06:07:19 +0000674 static VtableComponent MakeVCallOffset(int64_t Offset) {
675 return VtableComponent(CK_VCallOffset, Offset);
676 }
677
Anders Carlssondc2dba32010-02-16 04:49:44 +0000678 static VtableComponent MakeVBaseOffset(int64_t Offset) {
679 return VtableComponent(CK_VBaseOffset, Offset);
680 }
681
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000682 static VtableComponent MakeOffsetToTop(int64_t Offset) {
683 return VtableComponent(CK_OffsetToTop, Offset);
684 }
685
686 static VtableComponent MakeRTTI(const CXXRecordDecl *RD) {
687 return VtableComponent(CK_RTTI, reinterpret_cast<uintptr_t>(RD));
688 }
689
690 static VtableComponent MakeFunction(const CXXMethodDecl *MD) {
691 assert(!isa<CXXDestructorDecl>(MD) &&
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000692 "Don't use MakeFunction with destructors!");
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000693
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000694 return VtableComponent(CK_FunctionPointer,
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000695 reinterpret_cast<uintptr_t>(MD));
696 }
697
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000698 static VtableComponent MakeCompleteDtor(const CXXDestructorDecl *DD) {
699 return VtableComponent(CK_CompleteDtorPointer,
700 reinterpret_cast<uintptr_t>(DD));
701 }
702
703 static VtableComponent MakeDeletingDtor(const CXXDestructorDecl *DD) {
704 return VtableComponent(CK_DeletingDtorPointer,
705 reinterpret_cast<uintptr_t>(DD));
706 }
707
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000708 /// getKind - Get the kind of this vtable component.
709 Kind getKind() const {
710 return (Kind)(Value & 0x7);
711 }
712
Anders Carlssonb0a588f2010-02-17 06:07:19 +0000713 int64_t getVCallOffset() const {
714 assert(getKind() == CK_VCallOffset && "Invalid component kind!");
715
716 return getOffset();
717 }
718
Anders Carlssondc2dba32010-02-16 04:49:44 +0000719 int64_t getVBaseOffset() const {
720 assert(getKind() == CK_VBaseOffset && "Invalid component kind!");
721
722 return getOffset();
723 }
724
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000725 int64_t getOffsetToTop() const {
726 assert(getKind() == CK_OffsetToTop && "Invalid component kind!");
727
728 return getOffset();
729 }
730
731 const CXXRecordDecl *getRTTIDecl() const {
732 assert(getKind() == CK_RTTI && "Invalid component kind!");
733
734 return reinterpret_cast<CXXRecordDecl *>(getPointer());
735 }
736
737 const CXXMethodDecl *getFunctionDecl() const {
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000738 assert(getKind() == CK_FunctionPointer);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000739
740 return reinterpret_cast<CXXMethodDecl *>(getPointer());
741 }
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000742
743 const CXXDestructorDecl *getDestructorDecl() const {
744 assert((getKind() == CK_CompleteDtorPointer ||
745 getKind() == CK_DeletingDtorPointer) && "Invalid component kind!");
746
747 return reinterpret_cast<CXXDestructorDecl *>(getPointer());
748 }
749
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000750private:
751 VtableComponent(Kind ComponentKind, int64_t Offset) {
752 assert((ComponentKind == CK_VCallOffset ||
753 ComponentKind == CK_VBaseOffset ||
754 ComponentKind == CK_OffsetToTop) && "Invalid component kind!");
755 assert(Offset <= ((1LL << 56) - 1) && "Offset is too big!");
756
757 Value = ((Offset << 3) | ComponentKind);
758 }
759
760 VtableComponent(Kind ComponentKind, uintptr_t Ptr) {
761 assert((ComponentKind == CK_RTTI ||
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000762 ComponentKind == CK_FunctionPointer ||
763 ComponentKind == CK_CompleteDtorPointer ||
764 ComponentKind == CK_DeletingDtorPointer) &&
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000765 "Invalid component kind!");
766
767 assert((Ptr & 7) == 0 && "Pointer not sufficiently aligned!");
768
769 Value = Ptr | ComponentKind;
770 }
771
772 int64_t getOffset() const {
773 assert((getKind() == CK_VCallOffset || getKind() == CK_VBaseOffset ||
774 getKind() == CK_OffsetToTop) && "Invalid component kind!");
775
776 return Value >> 3;
777 }
778
779 uintptr_t getPointer() const {
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000780 assert((getKind() == CK_RTTI ||
781 getKind() == CK_FunctionPointer ||
782 getKind() == CK_CompleteDtorPointer ||
783 getKind() == CK_DeletingDtorPointer) &&
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000784 "Invalid component kind!");
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000785
786 return static_cast<uintptr_t>(Value & ~7ULL);
787 }
788
789 /// The kind is stored in the lower 3 bits of the value. For offsets, we
790 /// make use of the facts that classes can't be larger than 2^55 bytes,
791 /// so we store the offset in the lower part of the 61 bytes that remain.
792 /// (The reason that we're not simply using a PointerIntPair here is that we
793 /// need the offsets to be 64-bit, even when on a 32-bit machine).
794 int64_t Value;
795};
796
Anders Carlsson78277c72010-02-18 17:00:09 +0000797/// VCallOffsetMap - Keeps track of vcall offsets when building a vtable.
798struct VCallOffsetMap {
799
800 typedef std::pair<const CXXMethodDecl *, int64_t> MethodAndOffsetPairTy;
801
802 /// Offsets - Keeps track of methods and their offsets.
803 // FIXME: This should be a real map and not a vector.
804 llvm::SmallVector<MethodAndOffsetPairTy, 16> Offsets;
805
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000806 /// MethodsCanShareVCallOffset - Returns whether two virtual member functions
807 /// can share the same vcall offset.
808 static bool MethodsCanShareVCallOffset(const CXXMethodDecl *LHS,
809 const CXXMethodDecl *RHS);
810
Anders Carlsson78277c72010-02-18 17:00:09 +0000811public:
812 /// AddVCallOffset - Adds a vcall offset to the map. Returns true if the
813 /// add was successful, or false if there was already a member function with
814 /// the same signature in the map.
815 bool AddVCallOffset(const CXXMethodDecl *MD, int64_t OffsetOffset);
816
817 /// getVCallOffsetOffset - Returns the vcall offset offset (relative to the
818 /// vtable address point) for the given virtual member function.
819 int64_t getVCallOffsetOffset(const CXXMethodDecl *MD);
820
821 /// clear - Clear the offset map.
822 void clear() { Offsets.clear(); }
823};
824
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000825bool VCallOffsetMap::MethodsCanShareVCallOffset(const CXXMethodDecl *LHS,
826 const CXXMethodDecl *RHS) {
827 assert(LHS->isVirtual() && "LHS must be virtual!");
828 assert(RHS->isVirtual() && "LHS must be virtual!");
829
830 // FIXME: We need to check more things here.
831
832 DeclarationName LHSName = LHS->getDeclName();
833 DeclarationName RHSName = RHS->getDeclName();
834 if (LHSName.getNameKind() != LHSName.getNameKind())
835 return false;
836
837 switch (LHSName.getNameKind()) {
838 default:
839 assert(false && "Unhandled name kind!");
840 case DeclarationName::Identifier:
841 if (LHSName.getAsIdentifierInfo() != RHSName.getAsIdentifierInfo())
842 return false;
843 }
844
845 return true;
846}
847
Anders Carlsson78277c72010-02-18 17:00:09 +0000848bool VCallOffsetMap::AddVCallOffset(const CXXMethodDecl *MD,
849 int64_t OffsetOffset) {
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000850 // Check if we can reuse an offset.
851 for (unsigned I = 0, E = Offsets.size(); I != E; ++I) {
852 if (MethodsCanShareVCallOffset(Offsets[I].first, MD))
853 return false;
854 }
855
856 // Add the offset.
857 Offsets.push_back(MethodAndOffsetPairTy(MD, OffsetOffset));
Anders Carlsson78277c72010-02-18 17:00:09 +0000858 return true;
859}
860
861int64_t VCallOffsetMap::getVCallOffsetOffset(const CXXMethodDecl *MD) {
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000862 // Look for an offset.
863 for (unsigned I = 0, E = Offsets.size(); I != E; ++I) {
864 if (MethodsCanShareVCallOffset(Offsets[I].first, MD))
865 return Offsets[I].second;
866 }
867
868 assert(false && "Should always find a vcall offset offset!");
Anders Carlsson78277c72010-02-18 17:00:09 +0000869 return 0;
870}
871
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000872/// VtableBuilder - Class for building vtable layout information.
Benjamin Kramer337e3a52009-11-28 19:45:26 +0000873class VtableBuilder {
Anders Carlsson65b49782010-02-12 05:25:12 +0000874public:
875 /// PrimaryBasesSetTy - A set of direct and indirect primary bases.
876 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 8> PrimaryBasesSetTy;
877
878private:
Anders Carlssoncf5a8822010-02-13 21:07:32 +0000879 /// VtableInfo - Global vtable information.
880 CGVtableInfo &VtableInfo;
881
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000882 /// MostDerivedClass - The most derived class for which we're building this
883 /// vtable.
884 const CXXRecordDecl *MostDerivedClass;
885
886 /// Context - The ASTContext which we will use for layout information.
Anders Carlsson65b49782010-02-12 05:25:12 +0000887 ASTContext &Context;
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000888
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000889 /// FinalOverriders - The final overriders of the most derived class.
890 FinalOverriders Overriders;
891
Anders Carlssondc2dba32010-02-16 04:49:44 +0000892 /// VCallAndVBaseOffsets - The vcall and vbase offset, of the vtable we're
893 // building (in reverse order).
894 llvm::SmallVector<VtableComponent, 64> VCallAndVBaseOffsets;
895
Anders Carlsson78277c72010-02-18 17:00:09 +0000896 /// VCallOffsets - Keeps track of vcall offsets for the current vtable.
897 VCallOffsetMap VCallOffsets;
898
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000899 /// Components - The components of the vtable being built.
900 llvm::SmallVector<VtableComponent, 64> Components;
901
Anders Carlsson932c2f22010-02-11 17:18:51 +0000902 /// AddressPoints - Address points for the vtable being built.
903 CGVtableInfo::AddressPointsMapTy AddressPoints;
904
Anders Carlssond3adb0c2010-02-13 23:40:17 +0000905 /// ReturnAdjustment - A return adjustment.
Anders Carlsson5272c252010-02-12 17:37:14 +0000906 struct ReturnAdjustment {
907 /// NonVirtual - The non-virtual adjustment from the derived object to its
908 /// nearest virtual base.
909 int64_t NonVirtual;
910
Anders Carlsson78277c72010-02-18 17:00:09 +0000911 /// VBaseOffsetOffset - The offset (in bytes), relative to the address point
Anders Carlssoncf5a8822010-02-13 21:07:32 +0000912 /// of the virtual base class offset.
913 int64_t VBaseOffsetOffset;
Anders Carlsson5272c252010-02-12 17:37:14 +0000914
Anders Carlssoncf5a8822010-02-13 21:07:32 +0000915 ReturnAdjustment() : NonVirtual(0), VBaseOffsetOffset(0) { }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000916
Anders Carlssoncf5a8822010-02-13 21:07:32 +0000917 bool isEmpty() const { return !NonVirtual && !VBaseOffsetOffset; }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000918 };
919
920 /// ReturnAdjustments - The return adjustments needed in this vtable.
921 llvm::SmallVector<std::pair<uint64_t, ReturnAdjustment>, 16>
922 ReturnAdjustments;
923
Anders Carlssond3adb0c2010-02-13 23:40:17 +0000924 /// ThisAdjustment - A 'this' pointer adjustment thunk.
925 struct ThisAdjustment {
926 /// NonVirtual - The non-virtual adjustment from the derived object to its
927 /// nearest virtual base.
928 int64_t NonVirtual;
929
Anders Carlsson78277c72010-02-18 17:00:09 +0000930 /// VCallOffsetOffset - The offset (in bytes), relative to the address point
931 /// of the virtual call offset.
932 int64_t VCallOffsetOffset;
Anders Carlssond3adb0c2010-02-13 23:40:17 +0000933
Anders Carlsson78277c72010-02-18 17:00:09 +0000934 ThisAdjustment() : NonVirtual(0), VCallOffsetOffset(0) { }
Anders Carlssond3adb0c2010-02-13 23:40:17 +0000935
Anders Carlsson78277c72010-02-18 17:00:09 +0000936 bool isEmpty() const { return !NonVirtual && !VCallOffsetOffset; }
Anders Carlssond3adb0c2010-02-13 23:40:17 +0000937 };
938
939 /// ThisAdjustments - The 'this' pointer adjustments needed in this vtable.
940 llvm::SmallVector<std::pair<uint64_t, ThisAdjustment>, 16>
941 ThisAdjustments;
942
Anders Carlssondc2dba32010-02-16 04:49:44 +0000943 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
944
945 /// AddVCallAndVBaseOffsets - Add vcall offsets and vbase offsets for the
Anders Carlssondb042202010-02-17 03:11:55 +0000946 /// given base subobject.
947 void AddVCallAndVBaseOffsets(BaseSubobject Base, bool BaseIsVirtual,
Anders Carlssondc2dba32010-02-16 04:49:44 +0000948 VisitedVirtualBasesSetTy &VBases);
949
Anders Carlssonb0a588f2010-02-17 06:07:19 +0000950 /// AddVCallOffsets - Add vcall offsets for the given base subobject.
951 void AddVCallOffsets(BaseSubobject Base);
952
Anders Carlssondc2dba32010-02-16 04:49:44 +0000953 /// AddVBaseOffsets - Add vbase offsets for the given class.
Anders Carlssondb042202010-02-17 03:11:55 +0000954 void AddVBaseOffsets(const CXXRecordDecl *Base, int64_t OffsetToTop,
Anders Carlssondc2dba32010-02-16 04:49:44 +0000955 VisitedVirtualBasesSetTy &VBases);
956
Anders Carlssoncf5a8822010-02-13 21:07:32 +0000957 /// ComputeReturnAdjustment - Compute the return adjustment given a return
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000958 /// adjustment base offset.
959 ReturnAdjustment ComputeReturnAdjustment(FinalOverriders::BaseOffset Offset);
960
Anders Carlsson78277c72010-02-18 17:00:09 +0000961 /// ComputeThisAdjustment - Compute the 'this' pointer adjustment for the
962 /// given virtual member function and the 'this' pointer adjustment base
963 /// offset.
964 ThisAdjustment ComputeThisAdjustment(const CXXMethodDecl *MD,
965 FinalOverriders::BaseOffset Offset);
Anders Carlssond3adb0c2010-02-13 23:40:17 +0000966
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000967 /// AddMethod - Add a single virtual member function to the vtable
968 /// components vector.
Anders Carlssond3adb0c2010-02-13 23:40:17 +0000969 void AddMethod(const CXXMethodDecl *MD, ReturnAdjustment ReturnAdjustment,
970 ThisAdjustment ThisAdjustment);
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000971
972 /// AddMethods - Add the methods of this base subobject and all its
973 /// primary bases to the vtable components vector.
974 void AddMethods(BaseSubobject Base, PrimaryBasesSetTy &PrimaryBases);
Anders Carlssonb716a542010-02-16 16:26:28 +0000975
976 // LayoutVtable - Layout the vtable for the most derived class, including its
977 // secondary vtables and any vtables for virtual bases.
978 void LayoutVtable();
979
980 /// LayoutPrimaryAndAndSecondaryVtables - Layout the primary vtable for the
981 /// given base subobject, as well as all its secondary vtables.
Anders Carlssondb042202010-02-17 03:11:55 +0000982 void LayoutPrimaryAndAndSecondaryVtables(BaseSubobject Base,
983 bool BaseIsVirtual);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000984
Anders Carlsson14157932010-02-16 16:02:57 +0000985 /// LayoutSecondaryVtables - Layout the secondary vtables for the given base
986 /// subobject.
987 void LayoutSecondaryVtables(BaseSubobject Base);
988
Anders Carlsson13f0f662010-02-16 16:49:35 +0000989 /// LayoutVtablesForVirtualBases - Layout vtables for all virtual bases of the
990 /// given base (excluding any primary bases).
991 void LayoutVtablesForVirtualBases(const CXXRecordDecl *RD,
992 VisitedVirtualBasesSetTy &VBases);
993
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000994public:
Anders Carlssoncf5a8822010-02-13 21:07:32 +0000995 VtableBuilder(CGVtableInfo &VtableInfo, const CXXRecordDecl *MostDerivedClass)
996 : VtableInfo(VtableInfo), MostDerivedClass(MostDerivedClass),
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000997 Context(MostDerivedClass->getASTContext()), Overriders(MostDerivedClass) {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000998
Anders Carlssonb716a542010-02-16 16:26:28 +0000999 LayoutVtable();
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001000 }
1001
1002 /// dumpLayout - Dump the vtable layout.
1003 void dumpLayout(llvm::raw_ostream&);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001004};
1005
Anders Carlsson65b49782010-02-12 05:25:12 +00001006/// OverridesMethodInPrimaryBase - Checks whether whether this virtual member
1007/// function overrides a member function in a direct or indirect primary base.
1008/// Returns the overridden member function, or null if none was found.
1009static const CXXMethodDecl *
1010OverridesMethodInPrimaryBase(const CXXMethodDecl *MD,
1011 VtableBuilder::PrimaryBasesSetTy &PrimaryBases) {
1012 for (CXXMethodDecl::method_iterator I = MD->begin_overridden_methods(),
1013 E = MD->end_overridden_methods(); I != E; ++I) {
1014 const CXXMethodDecl *OverriddenMD = *I;
1015 const CXXRecordDecl *OverriddenRD = OverriddenMD->getParent();
1016 assert(OverriddenMD->isCanonicalDecl() &&
1017 "Should have the canonical decl of the overridden RD!");
1018
1019 if (PrimaryBases.count(OverriddenRD))
1020 return OverriddenMD;
1021 }
1022
1023 return 0;
1024}
1025
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001026VtableBuilder::ReturnAdjustment
1027VtableBuilder::ComputeReturnAdjustment(FinalOverriders::BaseOffset Offset) {
1028 ReturnAdjustment Adjustment;
1029
1030 if (!Offset.isEmpty()) {
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001031 if (Offset.VirtualBase) {
1032 // Get the virtual base offset offset.
1033 Adjustment.VBaseOffsetOffset =
1034 VtableInfo.getVirtualBaseOffsetIndex(Offset.DerivedClass,
1035 Offset.VirtualBase);
1036 // FIXME: Once the assert in getVirtualBaseOffsetIndex is back again,
1037 // we can get rid of this assert.
1038 assert(Adjustment.VBaseOffsetOffset != 0 &&
1039 "Invalid base offset offset!");
1040 }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001041
1042 Adjustment.NonVirtual = Offset.NonVirtualOffset;
1043 }
1044
1045 return Adjustment;
1046}
1047
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001048VtableBuilder::ThisAdjustment
Anders Carlsson78277c72010-02-18 17:00:09 +00001049VtableBuilder::ComputeThisAdjustment(const CXXMethodDecl *MD,
1050 FinalOverriders::BaseOffset Offset) {
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001051 ThisAdjustment Adjustment;
1052
1053 if (!Offset.isEmpty()) {
Anders Carlsson8847d9e2010-02-18 17:26:40 +00001054 if (Offset.VirtualBase) {
1055 // Get the vcall offset offset.
1056 Adjustment.VCallOffsetOffset = VCallOffsets.getVCallOffsetOffset(MD);
1057 }
1058
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001059 Adjustment.NonVirtual = Offset.NonVirtualOffset;
1060 }
1061
1062 return Adjustment;
1063}
1064
Anders Carlsson65b49782010-02-12 05:25:12 +00001065void
Anders Carlssondb042202010-02-17 03:11:55 +00001066VtableBuilder::AddVCallAndVBaseOffsets(BaseSubobject Base,
1067 bool BaseIsVirtual,
Anders Carlssondc2dba32010-02-16 04:49:44 +00001068 VisitedVirtualBasesSetTy &VBases) {
Anders Carlssondb042202010-02-17 03:11:55 +00001069 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Base.getBase());
Anders Carlssondc2dba32010-02-16 04:49:44 +00001070
1071 // Itanium C++ ABI 2.5.2:
1072 // ..in classes sharing a virtual table with a primary base class, the vcall
1073 // and vbase offsets added by the derived class all come before the vcall
1074 // and vbase offsets required by the base class, so that the latter may be
1075 // laid out as required by the base class without regard to additions from
1076 // the derived class(es).
1077
1078 // (Since we're emitting the vcall and vbase offsets in reverse order, we'll
1079 // emit them for the primary base first).
Anders Carlssondb042202010-02-17 03:11:55 +00001080 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
1081 bool PrimaryBaseIsVirtual = Layout.getPrimaryBaseWasVirtual();
1082 AddVCallAndVBaseOffsets(BaseSubobject(PrimaryBase, Base.getBaseOffset()),
1083 PrimaryBaseIsVirtual, VBases);
1084 }
Anders Carlssondc2dba32010-02-16 04:49:44 +00001085
Anders Carlssondb042202010-02-17 03:11:55 +00001086 // FIXME: Don't use /8 here.
1087 int64_t OffsetToTop = -(int64_t)Base.getBaseOffset() / 8;
1088 AddVBaseOffsets(Base.getBase(), OffsetToTop, VBases);
Anders Carlssonb0a588f2010-02-17 06:07:19 +00001089
1090 // We only want to add vcall offsets for virtual bases in secondary vtables.
1091 if (BaseIsVirtual && OffsetToTop != 0)
1092 AddVCallOffsets(Base);
1093}
1094
1095void VtableBuilder::AddVCallOffsets(BaseSubobject Base) {
1096 const CXXRecordDecl *RD = Base.getBase();
Anders Carlssonb0a588f2010-02-17 06:07:19 +00001097 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlssond2fd3022010-02-17 06:30:02 +00001098
1099 // Handle the primary base first.
Anders Carlssonb0a588f2010-02-17 06:07:19 +00001100 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
Anders Carlssond2fd3022010-02-17 06:30:02 +00001101 if (PrimaryBase && Layout.getPrimaryBaseWasVirtual()) {
1102 // Get the base offset of the primary base.
1103 uint64_t PrimaryBaseOffset = Base.getBaseOffset() +
1104 Layout.getBaseClassOffset(PrimaryBase);
1105
1106 AddVCallOffsets(BaseSubobject(PrimaryBase, PrimaryBaseOffset));
1107 }
Anders Carlssonb0a588f2010-02-17 06:07:19 +00001108
1109 // Add the vcall offsets.
1110 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
1111 E = RD->method_end(); I != E; ++I) {
1112 const CXXMethodDecl *MD = *I;
1113
1114 if (!MD->isVirtual())
1115 continue;
1116
Anders Carlsson8847d9e2010-02-18 17:26:40 +00001117 // OffsetIndex is the index of this vcall offset, relative to the vtable
1118 // address point. (We subtract 3 to account for the information just
1119 // above the address point, the RTTI info, the offset to top, and the
1120 // vcall offset itself).
1121 int64_t OffsetIndex = -(3 + VCallAndVBaseOffsets.size());
1122
1123 // FIXME: We shouldn't use / 8 here.
1124 int64_t OffsetOffset = OffsetIndex *
1125 (int64_t)Context.Target.getPointerWidth(0) / 8;
1126
1127 // Don't add a vcall offset if we already have one for this member function
Anders Carlssonb0a588f2010-02-17 06:07:19 +00001128 // signature.
Anders Carlsson8847d9e2010-02-18 17:26:40 +00001129 if (!VCallOffsets.AddVCallOffset(MD, OffsetOffset))
1130 continue;
Anders Carlssonb0a588f2010-02-17 06:07:19 +00001131
1132 // Get the 'this' pointer adjustment offset.
1133 FinalOverriders::BaseOffset ThisAdjustmentOffset =
1134 Overriders.getThisAdjustmentOffset(Base, MD);
1135
1136 int64_t Offset = 0;
1137 if (const CXXRecordDecl *VBaseDecl = ThisAdjustmentOffset.VirtualBase) {
1138 const ASTRecordLayout &MostDerivedClassLayout =
1139 Context.getASTRecordLayout(MostDerivedClass);
1140
1141 // FIXME: We should not use / 8 here.
1142 Offset =
1143 -(int64_t)MostDerivedClassLayout.getVBaseClassOffset(VBaseDecl) / 8;
1144 }
1145
1146 VCallAndVBaseOffsets.push_back(VtableComponent::MakeVCallOffset(Offset));
1147 }
1148
1149 // And iterate over all non-virtual bases (ignoring the primary base).
1150 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1151 E = RD->bases_end(); I != E; ++I) {
1152
1153 if (I->isVirtual())
1154 continue;
1155
1156 const CXXRecordDecl *BaseDecl =
1157 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1158
1159 // Ignore the primary base.
1160 if (BaseDecl == PrimaryBase)
1161 continue;
1162
1163 // Get the base offset of this base.
1164 uint64_t BaseOffset = Base.getBaseOffset() +
1165 Layout.getBaseClassOffset(BaseDecl);
1166
1167 AddVCallOffsets(BaseSubobject(BaseDecl, BaseOffset));
1168 }
Anders Carlssondc2dba32010-02-16 04:49:44 +00001169}
1170
1171void VtableBuilder::AddVBaseOffsets(const CXXRecordDecl *RD,
1172 int64_t OffsetToTop,
1173 VisitedVirtualBasesSetTy &VBases) {
Anders Carlsson77904f12010-02-16 04:59:55 +00001174 const ASTRecordLayout &MostDerivedClassLayout =
1175 Context.getASTRecordLayout(MostDerivedClass);
1176
1177 // Add vbase offsets.
1178 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1179 E = RD->bases_end(); I != E; ++I) {
1180 const CXXRecordDecl *BaseDecl =
1181 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1182
1183 // Check if this is a virtual base that we haven't visited before.
1184 if (I->isVirtual() && VBases.insert(BaseDecl)) {
1185 // FIXME: We shouldn't use / 8 here.
1186 uint64_t Offset =
1187 OffsetToTop + MostDerivedClassLayout.getVBaseClassOffset(BaseDecl) / 8;
1188
1189 VCallAndVBaseOffsets.push_back(VtableComponent::MakeVBaseOffset(Offset));
1190 }
1191
1192 // Check the base class looking for more vbase offsets.
1193 AddVBaseOffsets(BaseDecl, OffsetToTop, VBases);
1194 }
Anders Carlssondc2dba32010-02-16 04:49:44 +00001195}
1196
1197void
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001198VtableBuilder::AddMethod(const CXXMethodDecl *MD,
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001199 ReturnAdjustment ReturnAdjustment,
1200 ThisAdjustment ThisAdjustment) {
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001201 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1202 assert(ReturnAdjustment.isEmpty() &&
1203 "Destructor can't have return adjustment!");
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001204 // Add the 'this' pointer adjustments if necessary.
1205 if (!ThisAdjustment.isEmpty()) {
1206 ThisAdjustments.push_back(std::make_pair(Components.size(),
1207 ThisAdjustment));
1208 ThisAdjustments.push_back(std::make_pair(Components.size() + 1,
1209 ThisAdjustment));
1210 }
1211
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001212 // Add both the complete destructor and the deleting destructor.
1213 Components.push_back(VtableComponent::MakeCompleteDtor(DD));
1214 Components.push_back(VtableComponent::MakeDeletingDtor(DD));
1215 } else {
1216 // Add the return adjustment if necessary.
1217 if (!ReturnAdjustment.isEmpty())
1218 ReturnAdjustments.push_back(std::make_pair(Components.size(),
1219 ReturnAdjustment));
1220
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001221 // Add the 'this' pointer adjustment if necessary.
1222 if (!ThisAdjustment.isEmpty())
1223 ThisAdjustments.push_back(std::make_pair(Components.size(),
1224 ThisAdjustment));
1225
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001226 // Add the function.
1227 Components.push_back(VtableComponent::MakeFunction(MD));
1228 }
1229}
1230
1231void
1232VtableBuilder::AddMethods(BaseSubobject Base, PrimaryBasesSetTy &PrimaryBases) {
Anders Carlsson65b49782010-02-12 05:25:12 +00001233 const CXXRecordDecl *RD = Base.getBase();
1234
1235 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1236
1237 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
1238 if (Layout.getPrimaryBaseWasVirtual())
1239 assert(false && "FIXME: Handle vbases here.");
1240 else
1241 assert(Layout.getBaseClassOffset(PrimaryBase) == 0 &&
1242 "Primary base should have a zero offset!");
1243
Anders Carlssone75aaa92010-02-13 22:05:23 +00001244 AddMethods(BaseSubobject(PrimaryBase, Base.getBaseOffset()), PrimaryBases);
Anders Carlsson65b49782010-02-12 05:25:12 +00001245
1246 if (!PrimaryBases.insert(PrimaryBase))
1247 assert(false && "Found a duplicate primary base!");
1248 }
Anders Carlsson932c2f22010-02-11 17:18:51 +00001249
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001250 // Now go through all virtual member functions and add them.
1251 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
1252 E = RD->method_end(); I != E; ++I) {
1253 const CXXMethodDecl *MD = *I;
Anders Carlsson65b49782010-02-12 05:25:12 +00001254
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001255 if (!MD->isVirtual())
1256 continue;
Anders Carlsson65b49782010-02-12 05:25:12 +00001257
1258 // Get the final overrider.
Anders Carlsson136bd192010-02-12 16:55:34 +00001259 FinalOverriders::OverriderInfo Overrider =
1260 Overriders.getOverrider(Base, MD);
Anders Carlsson65b49782010-02-12 05:25:12 +00001261
1262 // Check if this virtual member function overrides a method in a primary
1263 // base. If this is the case, and the return type doesn't require adjustment
1264 // then we can just use the member function from the primary base.
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001265 if (const CXXMethodDecl *OverriddenMD =
1266 OverridesMethodInPrimaryBase(MD, PrimaryBases)) {
Anders Carlssoncce9ee82010-02-13 23:17:31 +00001267 if (ComputeReturnAdjustmentBaseOffset(Context, MD,
1268 OverriddenMD).isEmpty())
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001269 continue;
1270 }
Anders Carlssoneee53d92010-02-13 02:02:03 +00001271
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001272 // Check if this overrider needs a return adjustment.
1273 FinalOverriders::BaseOffset ReturnAdjustmentOffset =
1274 Overriders.getReturnAdjustmentOffset(Base, MD);
1275
1276 ReturnAdjustment ReturnAdjustment =
1277 ComputeReturnAdjustment(ReturnAdjustmentOffset);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001278
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001279 // Check if this overrider needs a 'this' pointer adjustment.
1280 FinalOverriders::BaseOffset ThisAdjustmentOffset =
1281 Overriders.getThisAdjustmentOffset(Base, MD);
1282
Anders Carlsson78277c72010-02-18 17:00:09 +00001283 ThisAdjustment ThisAdjustment = ComputeThisAdjustment(Overrider.Method,
1284 ThisAdjustmentOffset);
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001285
1286 AddMethod(Overrider.Method, ReturnAdjustment, ThisAdjustment);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001287 }
1288}
1289
Anders Carlssonb716a542010-02-16 16:26:28 +00001290void VtableBuilder::LayoutVtable() {
Anders Carlssondb042202010-02-17 03:11:55 +00001291 LayoutPrimaryAndAndSecondaryVtables(BaseSubobject(MostDerivedClass, 0),
1292 /*BaseIsVirtual=*/false);
Anders Carlssonb716a542010-02-16 16:26:28 +00001293
Anders Carlsson13f0f662010-02-16 16:49:35 +00001294 VisitedVirtualBasesSetTy VBases;
1295 LayoutVtablesForVirtualBases(MostDerivedClass, VBases);
Anders Carlssonb716a542010-02-16 16:26:28 +00001296}
1297
Anders Carlssondb042202010-02-17 03:11:55 +00001298void VtableBuilder::LayoutPrimaryAndAndSecondaryVtables(BaseSubobject Base,
1299 bool BaseIsVirtual) {
Chris Lattnerd2408f72010-02-17 21:42:34 +00001300 assert(Base.getBase()->isDynamicClass() && "class does not have a vtable!");
Anders Carlsson033d4862010-02-14 17:05:59 +00001301
Anders Carlsson77904f12010-02-16 04:59:55 +00001302 // Add vcall and vbase offsets for this vtable.
1303 VisitedVirtualBasesSetTy VBases;
Anders Carlssondb042202010-02-17 03:11:55 +00001304 AddVCallAndVBaseOffsets(Base, BaseIsVirtual, VBases);
Anders Carlsson77904f12010-02-16 04:59:55 +00001305
1306 // Reverse them and add them to the vtable components.
1307 std::reverse(VCallAndVBaseOffsets.begin(), VCallAndVBaseOffsets.end());
1308 Components.append(VCallAndVBaseOffsets.begin(), VCallAndVBaseOffsets.end());
1309 VCallAndVBaseOffsets.clear();
1310
1311 // Add the offset to top.
Anders Carlssone75aaa92010-02-13 22:05:23 +00001312 // FIXME: This is not going to be right for construction vtables.
Anders Carlsson258a1e32010-02-14 00:16:19 +00001313 // FIXME: We should not use / 8 here.
Anders Carlssondb042202010-02-17 03:11:55 +00001314 int64_t OffsetToTop = -(int64_t)Base.getBaseOffset() / 8;
Anders Carlssone75aaa92010-02-13 22:05:23 +00001315 Components.push_back(VtableComponent::MakeOffsetToTop(OffsetToTop));
Anders Carlsson65b49782010-02-12 05:25:12 +00001316
1317 // Next, add the RTTI.
Anders Carlssone75aaa92010-02-13 22:05:23 +00001318 Components.push_back(VtableComponent::MakeRTTI(MostDerivedClass));
Anders Carlsson65b49782010-02-12 05:25:12 +00001319
Anders Carlssone8a97562010-02-12 07:43:48 +00001320 uint64_t AddressPoint = Components.size();
Anders Carlsson65b49782010-02-12 05:25:12 +00001321
1322 // Now go through all virtual member functions and add them.
1323 PrimaryBasesSetTy PrimaryBases;
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001324 AddMethods(Base, PrimaryBases);
Anders Carlsson65b49782010-02-12 05:25:12 +00001325
Anders Carlssone8a97562010-02-12 07:43:48 +00001326 // Record the address point.
1327 AddressPoints.insert(std::make_pair(Base, AddressPoint));
1328
1329 // Record the address points for all primary bases.
1330 for (PrimaryBasesSetTy::const_iterator I = PrimaryBases.begin(),
1331 E = PrimaryBases.end(); I != E; ++I) {
1332 const CXXRecordDecl *BaseDecl = *I;
1333
1334 // We know that all the primary bases have the same offset as the base
1335 // subobject.
1336 BaseSubobject PrimaryBase(BaseDecl, Base.getBaseOffset());
1337 AddressPoints.insert(std::make_pair(PrimaryBase, AddressPoint));
1338 }
1339
Anders Carlsson14157932010-02-16 16:02:57 +00001340 // Layout secondary vtables.
1341 LayoutSecondaryVtables(Base);
Anders Carlsson78277c72010-02-18 17:00:09 +00001342
1343 // Clear the vcall offsets.
1344 VCallOffsets.clear();
Anders Carlsson14157932010-02-16 16:02:57 +00001345}
1346
1347void VtableBuilder::LayoutSecondaryVtables(BaseSubobject Base) {
1348 // Itanium C++ ABI 2.5.2:
1349 // Following the primary virtual table of a derived class are secondary
1350 // virtual tables for each of its proper base classes, except any primary
1351 // base(s) with which it shares its primary virtual table.
1352
1353 const CXXRecordDecl *RD = Base.getBase();
Anders Carlsson65b49782010-02-12 05:25:12 +00001354 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1355 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
Anders Carlsson14157932010-02-16 16:02:57 +00001356
Anders Carlsson65b49782010-02-12 05:25:12 +00001357 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1358 E = RD->bases_end(); I != E; ++I) {
Anders Carlsson14157932010-02-16 16:02:57 +00001359 // Ignore virtual bases, we'll emit them later.
1360 if (I->isVirtual())
1361 continue;
1362
Anders Carlsson65b49782010-02-12 05:25:12 +00001363 const CXXRecordDecl *BaseDecl =
1364 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson033d4862010-02-14 17:05:59 +00001365
Anders Carlssondc2dba32010-02-16 04:49:44 +00001366 // Ignore bases that don't have a vtable.
1367 if (!BaseDecl->isDynamicClass())
1368 continue;
Anders Carlsson033d4862010-02-14 17:05:59 +00001369
Anders Carlssone75aaa92010-02-13 22:05:23 +00001370 // Get the base offset of this base.
1371 uint64_t BaseOffset = Base.getBaseOffset() +
1372 Layout.getBaseClassOffset(BaseDecl);
Anders Carlsson14157932010-02-16 16:02:57 +00001373
1374 // Don't emit a secondary vtable for a primary base. We might however want
1375 // to emit secondary vtables for other bases of this base.
1376 if (BaseDecl == PrimaryBase) {
1377 LayoutSecondaryVtables(BaseSubobject(BaseDecl, BaseOffset));
1378 continue;
1379 }
Anders Carlssone75aaa92010-02-13 22:05:23 +00001380
Anders Carlssonb716a542010-02-16 16:26:28 +00001381 // Layout the primary vtable (and any secondary vtables) for this base.
Anders Carlssondb042202010-02-17 03:11:55 +00001382 LayoutPrimaryAndAndSecondaryVtables(BaseSubobject(BaseDecl, BaseOffset),
1383 /*BaseIsVirtual=*/false);
Anders Carlsson65b49782010-02-12 05:25:12 +00001384 }
1385}
1386
Anders Carlsson13f0f662010-02-16 16:49:35 +00001387void
1388VtableBuilder::LayoutVtablesForVirtualBases(const CXXRecordDecl *RD,
1389 VisitedVirtualBasesSetTy &VBases) {
1390 // Itanium C++ ABI 2.5.2:
1391 // Then come the virtual base virtual tables, also in inheritance graph
1392 // order, and again excluding primary bases (which share virtual tables with
1393 // the classes for which they are primary).
1394 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1395 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
1396
1397 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1398 E = RD->bases_end(); I != E; ++I) {
1399 const CXXRecordDecl *BaseDecl =
1400 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1401
1402 // Check if this base needs a vtable. (If it's virtual, and we haven't
1403 // visited it before).
1404 if (I->isVirtual() && BaseDecl->isDynamicClass() &&
1405 BaseDecl != PrimaryBase && VBases.insert(BaseDecl)) {
1406 const ASTRecordLayout &MostDerivedClassLayout =
1407 Context.getASTRecordLayout(MostDerivedClass);
1408 uint64_t BaseOffset =
1409 MostDerivedClassLayout.getVBaseClassOffset(BaseDecl);
1410
Anders Carlssondb042202010-02-17 03:11:55 +00001411 LayoutPrimaryAndAndSecondaryVtables(BaseSubobject(BaseDecl, BaseOffset),
1412 /*BaseIsVirtual=*/true);
Anders Carlsson13f0f662010-02-16 16:49:35 +00001413 }
1414
1415 // We only need to check the base for virtual base vtables if it actually
1416 // has virtual bases.
1417 if (BaseDecl->getNumVBases())
1418 LayoutVtablesForVirtualBases(BaseDecl, VBases);
1419 }
1420}
1421
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001422/// dumpLayout - Dump the vtable layout.
1423void VtableBuilder::dumpLayout(llvm::raw_ostream& Out) {
1424
1425 Out << "Vtable for '" << MostDerivedClass->getQualifiedNameAsString();
1426 Out << "' (" << Components.size() << " entries).\n";
1427
Anders Carlsson932c2f22010-02-11 17:18:51 +00001428 // Iterate through the address points and insert them into a new map where
1429 // they are keyed by the index and not the base object.
1430 // Since an address point can be shared by multiple subobjects, we use an
1431 // STL multimap.
1432 std::multimap<uint64_t, BaseSubobject> AddressPointsByIndex;
1433 for (CGVtableInfo::AddressPointsMapTy::const_iterator I =
1434 AddressPoints.begin(), E = AddressPoints.end(); I != E; ++I) {
1435 const BaseSubobject& Base = I->first;
1436 uint64_t Index = I->second;
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001437
Anders Carlsson932c2f22010-02-11 17:18:51 +00001438 AddressPointsByIndex.insert(std::make_pair(Index, Base));
1439 }
1440
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001441 unsigned NextReturnAdjustmentIndex = 0;
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001442 unsigned NextThisAdjustmentIndex = 0;
Anders Carlsson932c2f22010-02-11 17:18:51 +00001443 for (unsigned I = 0, E = Components.size(); I != E; ++I) {
Anders Carlssone8a97562010-02-12 07:43:48 +00001444 uint64_t Index = I;
1445
Anders Carlsson932c2f22010-02-11 17:18:51 +00001446 if (AddressPointsByIndex.count(I)) {
Anders Carlssone8a97562010-02-12 07:43:48 +00001447 if (AddressPointsByIndex.count(Index) == 1) {
1448 const BaseSubobject &Base = AddressPointsByIndex.find(Index)->second;
1449
1450 // FIXME: Instead of dividing by 8, we should be using CharUnits.
1451 Out << " -- (" << Base.getBase()->getQualifiedNameAsString();
1452 Out << ", " << Base.getBaseOffset() / 8 << ") vtable address --\n";
1453 } else {
1454 uint64_t BaseOffset =
1455 AddressPointsByIndex.lower_bound(Index)->second.getBaseOffset();
1456
1457 // We store the class names in a set to get a stable order.
1458 std::set<std::string> ClassNames;
1459 for (std::multimap<uint64_t, BaseSubobject>::const_iterator I =
1460 AddressPointsByIndex.lower_bound(Index), E =
1461 AddressPointsByIndex.upper_bound(Index); I != E; ++I) {
1462 assert(I->second.getBaseOffset() == BaseOffset &&
1463 "Invalid base offset!");
1464 const CXXRecordDecl *RD = I->second.getBase();
1465 ClassNames.insert(RD->getQualifiedNameAsString());
1466 }
1467
1468 for (std::set<std::string>::const_iterator I = ClassNames.begin(),
1469 E = ClassNames.end(); I != E; ++I) {
1470 // FIXME: Instead of dividing by 8, we should be using CharUnits.
1471 Out << " -- (" << *I;
1472 Out << ", " << BaseOffset / 8 << ") vtable address --\n";
1473 }
1474 }
Anders Carlsson932c2f22010-02-11 17:18:51 +00001475 }
1476
1477 Out << llvm::format("%4d | ", I);
1478
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001479 const VtableComponent &Component = Components[I];
1480
1481 // Dump the component.
1482 switch (Component.getKind()) {
Anders Carlssonb0a588f2010-02-17 06:07:19 +00001483
1484 case VtableComponent::CK_VCallOffset:
1485 Out << "vcall_offset (" << Component.getVCallOffset() << ")";
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001486 break;
Anders Carlsson77904f12010-02-16 04:59:55 +00001487
1488 case VtableComponent::CK_VBaseOffset:
1489 Out << "vbase_offset (" << Component.getVBaseOffset() << ")";
1490 break;
1491
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001492 case VtableComponent::CK_OffsetToTop:
1493 Out << "offset_to_top (" << Component.getOffsetToTop() << ")";
1494 break;
1495
1496 case VtableComponent::CK_RTTI:
1497 Out << Component.getRTTIDecl()->getQualifiedNameAsString() << " RTTI";
1498 break;
1499
Anders Carlsson5bd8d192010-02-11 18:20:28 +00001500 case VtableComponent::CK_FunctionPointer: {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001501 const CXXMethodDecl *MD = Component.getFunctionDecl();
1502
Anders Carlsson5bd8d192010-02-11 18:20:28 +00001503 std::string Str =
1504 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
1505 MD);
1506 Out << Str;
Anders Carlsson09da3372010-02-12 02:38:13 +00001507 if (MD->isPure())
1508 Out << " [pure]";
1509
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001510 // If this function pointer has a return adjustment, dump it.
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001511 if (NextReturnAdjustmentIndex < ReturnAdjustments.size() &&
1512 ReturnAdjustments[NextReturnAdjustmentIndex].first == I) {
1513 const ReturnAdjustment Adjustment =
1514 ReturnAdjustments[NextReturnAdjustmentIndex].second;
1515
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001516 Out << "\n [return adjustment: ";
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001517 Out << Adjustment.NonVirtual << " non-virtual";
1518
1519 if (Adjustment.VBaseOffsetOffset)
1520 Out << ", " << Adjustment.VBaseOffsetOffset << " vbase offset offset";
Anders Carlsson78277c72010-02-18 17:00:09 +00001521
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001522 Out << ']';
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001523
1524 NextReturnAdjustmentIndex++;
1525 }
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001526
1527 // If this function pointer has a 'this' pointer adjustment, dump it.
1528 if (NextThisAdjustmentIndex < ThisAdjustments.size() &&
1529 ThisAdjustments[NextThisAdjustmentIndex].first == I) {
1530 const ThisAdjustment Adjustment =
1531 ThisAdjustments[NextThisAdjustmentIndex].second;
1532
1533 Out << "\n [this adjustment: ";
1534 Out << Adjustment.NonVirtual << " non-virtual";
Anders Carlsson78277c72010-02-18 17:00:09 +00001535
1536 if (Adjustment.VCallOffsetOffset)
1537 Out << ", " << Adjustment.VCallOffsetOffset << " vcall offset offset";
1538
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001539 Out << ']';
1540
1541 NextThisAdjustmentIndex++;
1542 }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001543
Anders Carlsson5bd8d192010-02-11 18:20:28 +00001544 break;
1545 }
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001546
Anders Carlsson5bd8d192010-02-11 18:20:28 +00001547 case VtableComponent::CK_CompleteDtorPointer: {
1548 const CXXDestructorDecl *DD = Component.getDestructorDecl();
1549
1550 Out << DD->getQualifiedNameAsString() << "() [complete]";
Anders Carlsson09da3372010-02-12 02:38:13 +00001551 if (DD->isPure())
1552 Out << " [pure]";
1553
Anders Carlsson5bd8d192010-02-11 18:20:28 +00001554 break;
1555 }
1556
1557 case VtableComponent::CK_DeletingDtorPointer: {
1558 const CXXDestructorDecl *DD = Component.getDestructorDecl();
1559
1560 Out << DD->getQualifiedNameAsString() << "() [deleting]";
Anders Carlsson09da3372010-02-12 02:38:13 +00001561 if (DD->isPure())
1562 Out << " [pure]";
1563
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001564 break;
1565 }
1566
1567 }
Anders Carlsson932c2f22010-02-11 17:18:51 +00001568
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001569 Out << '\n';
1570 }
1571
1572}
1573
1574}
1575
1576namespace {
1577class OldVtableBuilder {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001578public:
1579 /// Index_t - Vtable index type.
1580 typedef uint64_t Index_t;
Eli Friedman31bc3ad2009-12-07 23:56:34 +00001581 typedef std::vector<std::pair<GlobalDecl,
1582 std::pair<GlobalDecl, ThunkAdjustment> > >
1583 SavedAdjustmentsVectorTy;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001584private:
Anders Carlsson472404f2009-12-04 16:19:30 +00001585
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00001586 // VtableComponents - The components of the vtable being built.
1587 typedef llvm::SmallVector<llvm::Constant *, 64> VtableComponentsVectorTy;
1588 VtableComponentsVectorTy VtableComponents;
1589
Eli Friedman6c08ce72009-12-05 01:05:03 +00001590 const bool BuildVtable;
1591
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001592 llvm::Type *Ptr8Ty;
Anders Carlssonbad80eb2009-12-04 18:36:22 +00001593
1594 /// MostDerivedClass - The most derived class that this vtable is being
1595 /// built for.
1596 const CXXRecordDecl *MostDerivedClass;
1597
Mike Stump83066c82009-11-13 01:54:23 +00001598 /// LayoutClass - The most derived class used for virtual base layout
1599 /// information.
1600 const CXXRecordDecl *LayoutClass;
Mike Stump653d0b92009-11-13 02:13:54 +00001601 /// LayoutOffset - The offset for Class in LayoutClass.
1602 uint64_t LayoutOffset;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001603 /// BLayout - Layout for the most derived class that this vtable is being
1604 /// built for.
1605 const ASTRecordLayout &BLayout;
1606 llvm::SmallSet<const CXXRecordDecl *, 32> IndirectPrimary;
1607 llvm::SmallSet<const CXXRecordDecl *, 32> SeenVBase;
1608 llvm::Constant *rtti;
1609 llvm::LLVMContext &VMContext;
1610 CodeGenModule &CGM; // Per-module state.
Anders Carlssonf2f31f42009-12-04 03:46:21 +00001611
Mike Stump90181eb2010-01-26 00:05:04 +00001612 llvm::DenseMap<const CXXMethodDecl *, Index_t> VCall;
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001613 llvm::DenseMap<GlobalDecl, Index_t> VCallOffset;
Mike Stump77537b12010-01-26 03:42:22 +00001614 llvm::DenseMap<GlobalDecl, Index_t> VCallOffsetForVCall;
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00001615 // This is the offset to the nearest virtual base
Mike Stump90181eb2010-01-26 00:05:04 +00001616 llvm::DenseMap<const CXXMethodDecl *, Index_t> NonVirtualOffset;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001617 llvm::DenseMap<const CXXRecordDecl *, Index_t> VBIndex;
Mike Stumpbb9ff052009-10-27 23:46:47 +00001618
Anders Carlsson323bb042009-11-26 19:54:33 +00001619 /// PureVirtualFunction - Points to __cxa_pure_virtual.
1620 llvm::Constant *PureVirtualFn;
1621
Anders Carlssona84b6e82009-12-04 02:01:07 +00001622 /// VtableMethods - A data structure for keeping track of methods in a vtable.
1623 /// Can add methods, override methods and iterate in vtable order.
1624 class VtableMethods {
1625 // MethodToIndexMap - Maps from a global decl to the index it has in the
1626 // Methods vector.
1627 llvm::DenseMap<GlobalDecl, uint64_t> MethodToIndexMap;
1628
1629 /// Methods - The methods, in vtable order.
1630 typedef llvm::SmallVector<GlobalDecl, 16> MethodsVectorTy;
1631 MethodsVectorTy Methods;
Eli Friedman8174f2c2009-12-06 22:01:30 +00001632 MethodsVectorTy OrigMethods;
Anders Carlssona84b6e82009-12-04 02:01:07 +00001633
1634 public:
1635 /// AddMethod - Add a method to the vtable methods.
1636 void AddMethod(GlobalDecl GD) {
1637 assert(!MethodToIndexMap.count(GD) &&
1638 "Method has already been added!");
1639
1640 MethodToIndexMap[GD] = Methods.size();
1641 Methods.push_back(GD);
Eli Friedman8174f2c2009-12-06 22:01:30 +00001642 OrigMethods.push_back(GD);
Anders Carlssona84b6e82009-12-04 02:01:07 +00001643 }
1644
1645 /// OverrideMethod - Replace a method with another.
1646 void OverrideMethod(GlobalDecl OverriddenGD, GlobalDecl GD) {
1647 llvm::DenseMap<GlobalDecl, uint64_t>::iterator i
1648 = MethodToIndexMap.find(OverriddenGD);
1649 assert(i != MethodToIndexMap.end() && "Did not find entry!");
1650
1651 // Get the index of the old decl.
1652 uint64_t Index = i->second;
1653
1654 // Replace the old decl with the new decl.
1655 Methods[Index] = GD;
1656
Anders Carlssona84b6e82009-12-04 02:01:07 +00001657 // And add the new.
1658 MethodToIndexMap[GD] = Index;
1659 }
1660
Anders Carlsson7bb70762009-12-04 15:49:02 +00001661 /// getIndex - Gives the index of a passed in GlobalDecl. Returns false if
1662 /// the index couldn't be found.
Benjamin Kramer62ab6162009-12-04 22:45:27 +00001663 bool getIndex(GlobalDecl GD, uint64_t &Index) const {
Anders Carlsson7bb70762009-12-04 15:49:02 +00001664 llvm::DenseMap<GlobalDecl, uint64_t>::const_iterator i
1665 = MethodToIndexMap.find(GD);
Eli Friedman3d2e9de2009-12-04 08:34:14 +00001666
Anders Carlsson7bb70762009-12-04 15:49:02 +00001667 if (i == MethodToIndexMap.end())
1668 return false;
Anders Carlssone6096362009-12-04 03:41:37 +00001669
Anders Carlsson7bb70762009-12-04 15:49:02 +00001670 Index = i->second;
1671 return true;
Anders Carlssone6096362009-12-04 03:41:37 +00001672 }
1673
Eli Friedman8174f2c2009-12-06 22:01:30 +00001674 GlobalDecl getOrigMethod(uint64_t Index) const {
1675 return OrigMethods[Index];
1676 }
1677
Anders Carlssona84b6e82009-12-04 02:01:07 +00001678 MethodsVectorTy::size_type size() const {
1679 return Methods.size();
1680 }
1681
1682 void clear() {
1683 MethodToIndexMap.clear();
1684 Methods.clear();
Eli Friedman8174f2c2009-12-06 22:01:30 +00001685 OrigMethods.clear();
Anders Carlssona84b6e82009-12-04 02:01:07 +00001686 }
1687
Anders Carlssone6096362009-12-04 03:41:37 +00001688 GlobalDecl operator[](uint64_t Index) const {
Anders Carlssona84b6e82009-12-04 02:01:07 +00001689 return Methods[Index];
1690 }
1691 };
1692
1693 /// Methods - The vtable methods we're currently building.
1694 VtableMethods Methods;
1695
Anders Carlsson4c837d22009-12-04 02:26:15 +00001696 /// ThisAdjustments - For a given index in the vtable, contains the 'this'
1697 /// pointer adjustment needed for a method.
1698 typedef llvm::DenseMap<uint64_t, ThunkAdjustment> ThisAdjustmentsMapTy;
1699 ThisAdjustmentsMapTy ThisAdjustments;
Anders Carlssond420a312009-11-26 19:32:45 +00001700
Eli Friedman31bc3ad2009-12-07 23:56:34 +00001701 SavedAdjustmentsVectorTy SavedAdjustments;
Eli Friedman8174f2c2009-12-06 22:01:30 +00001702
Anders Carlssonc521f952009-12-04 02:22:02 +00001703 /// BaseReturnTypes - Contains the base return types of methods who have been
1704 /// overridden with methods whose return types require adjustment. Used for
1705 /// generating covariant thunk information.
1706 typedef llvm::DenseMap<uint64_t, CanQualType> BaseReturnTypesMapTy;
1707 BaseReturnTypesMapTy BaseReturnTypes;
Anders Carlssond420a312009-11-26 19:32:45 +00001708
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001709 std::vector<Index_t> VCalls;
Mike Stump2cefe382009-11-12 20:47:57 +00001710
1711 typedef std::pair<const CXXRecordDecl *, uint64_t> CtorVtable_t;
Mike Stumpcd2b8212009-11-19 20:52:19 +00001712 // subAddressPoints - Used to hold the AddressPoints (offsets) into the built
1713 // vtable for use in computing the initializers for the VTT.
1714 llvm::DenseMap<CtorVtable_t, int64_t> &subAddressPoints;
Mike Stump2cefe382009-11-12 20:47:57 +00001715
Anders Carlsson5f9a8812010-01-14 02:29:07 +00001716 /// AddressPoints - Address points for this vtable.
1717 CGVtableInfo::AddressPointsMapTy& AddressPoints;
1718
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001719 typedef CXXRecordDecl::method_iterator method_iter;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001720 const uint32_t LLVMPointerWidth;
1721 Index_t extra;
Mike Stump37dbe962009-10-15 02:04:03 +00001722 typedef std::vector<std::pair<const CXXRecordDecl *, int64_t> > Path_t;
Mike Stumpcd2b8212009-11-19 20:52:19 +00001723 static llvm::DenseMap<CtorVtable_t, int64_t>&
1724 AllocAddressPoint(CodeGenModule &cgm, const CXXRecordDecl *l,
1725 const CXXRecordDecl *c) {
Anders Carlsson93a18842010-01-02 18:02:32 +00001726 CGVtableInfo::AddrMap_t *&oref = cgm.getVtableInfo().AddressPoints[l];
Mike Stumpcd2b8212009-11-19 20:52:19 +00001727 if (oref == 0)
Anders Carlsson93a18842010-01-02 18:02:32 +00001728 oref = new CGVtableInfo::AddrMap_t;
Mike Stumpcd2b8212009-11-19 20:52:19 +00001729
1730 llvm::DenseMap<CtorVtable_t, int64_t> *&ref = (*oref)[c];
1731 if (ref == 0)
1732 ref = new llvm::DenseMap<CtorVtable_t, int64_t>;
1733 return *ref;
1734 }
Anders Carlsson323bb042009-11-26 19:54:33 +00001735
Mike Stump90181eb2010-01-26 00:05:04 +00001736 bool DclIsSame(const FunctionDecl *New, const FunctionDecl *Old) {
1737 FunctionTemplateDecl *OldTemplate = Old->getDescribedFunctionTemplate();
1738 FunctionTemplateDecl *NewTemplate = New->getDescribedFunctionTemplate();
1739
1740 // C++ [temp.fct]p2:
1741 // A function template can be overloaded with other function templates
1742 // and with normal (non-template) functions.
1743 if ((OldTemplate == 0) != (NewTemplate == 0))
1744 return false;
1745
1746 // Is the function New an overload of the function Old?
1747 QualType OldQType = CGM.getContext().getCanonicalType(Old->getType());
1748 QualType NewQType = CGM.getContext().getCanonicalType(New->getType());
1749
1750 // Compare the signatures (C++ 1.3.10) of the two functions to
1751 // determine whether they are overloads. If we find any mismatch
1752 // in the signature, they are overloads.
1753
1754 // If either of these functions is a K&R-style function (no
1755 // prototype), then we consider them to have matching signatures.
1756 if (isa<FunctionNoProtoType>(OldQType.getTypePtr()) ||
1757 isa<FunctionNoProtoType>(NewQType.getTypePtr()))
1758 return true;
1759
1760 FunctionProtoType* OldType = cast<FunctionProtoType>(OldQType);
1761 FunctionProtoType* NewType = cast<FunctionProtoType>(NewQType);
1762
1763 // The signature of a function includes the types of its
1764 // parameters (C++ 1.3.10), which includes the presence or absence
1765 // of the ellipsis; see C++ DR 357).
1766 if (OldQType != NewQType &&
1767 (OldType->getNumArgs() != NewType->getNumArgs() ||
1768 OldType->isVariadic() != NewType->isVariadic() ||
1769 !std::equal(OldType->arg_type_begin(), OldType->arg_type_end(),
1770 NewType->arg_type_begin())))
1771 return false;
1772
1773#if 0
1774 // C++ [temp.over.link]p4:
1775 // The signature of a function template consists of its function
1776 // signature, its return type and its template parameter list. The names
1777 // of the template parameters are significant only for establishing the
1778 // relationship between the template parameters and the rest of the
1779 // signature.
1780 //
1781 // We check the return type and template parameter lists for function
1782 // templates first; the remaining checks follow.
1783 if (NewTemplate &&
1784 (!TemplateParameterListsAreEqual(NewTemplate->getTemplateParameters(),
1785 OldTemplate->getTemplateParameters(),
1786 TPL_TemplateMatch) ||
1787 OldType->getResultType() != NewType->getResultType()))
1788 return false;
1789#endif
1790
1791 // If the function is a class member, its signature includes the
1792 // cv-qualifiers (if any) on the function itself.
1793 //
1794 // As part of this, also check whether one of the member functions
1795 // is static, in which case they are not overloads (C++
1796 // 13.1p2). While not part of the definition of the signature,
1797 // this check is important to determine whether these functions
1798 // can be overloaded.
1799 const CXXMethodDecl* OldMethod = dyn_cast<CXXMethodDecl>(Old);
1800 const CXXMethodDecl* NewMethod = dyn_cast<CXXMethodDecl>(New);
1801 if (OldMethod && NewMethod &&
1802 !OldMethod->isStatic() && !NewMethod->isStatic() &&
1803 OldMethod->getTypeQualifiers() != NewMethod->getTypeQualifiers())
1804 return false;
1805
1806 // The signatures match; this is not an overload.
1807 return true;
1808 }
1809
1810 typedef llvm::DenseMap<const CXXMethodDecl *, const CXXMethodDecl*>
1811 ForwardUnique_t;
1812 ForwardUnique_t ForwardUnique;
1813 llvm::DenseMap<const CXXMethodDecl*, const CXXMethodDecl*> UniqueOverrider;
1814
1815 void BuildUniqueOverrider(const CXXMethodDecl *U, const CXXMethodDecl *MD) {
1816 const CXXMethodDecl *PrevU = UniqueOverrider[MD];
1817 assert(U && "no unique overrider");
1818 if (PrevU == U)
1819 return;
1820 if (PrevU != U && PrevU != 0) {
1821 // If already set, note the two sets as the same
1822 if (0)
1823 printf("%s::%s same as %s::%s\n",
1824 PrevU->getParent()->getNameAsCString(),
1825 PrevU->getNameAsCString(),
1826 U->getParent()->getNameAsCString(),
1827 U->getNameAsCString());
1828 ForwardUnique[PrevU] = U;
1829 return;
1830 }
1831
1832 // Not set, set it now
1833 if (0)
1834 printf("marking %s::%s %p override as %s::%s\n",
1835 MD->getParent()->getNameAsCString(),
1836 MD->getNameAsCString(),
1837 (void*)MD,
1838 U->getParent()->getNameAsCString(),
1839 U->getNameAsCString());
1840 UniqueOverrider[MD] = U;
1841
1842 for (CXXMethodDecl::method_iterator mi = MD->begin_overridden_methods(),
1843 me = MD->end_overridden_methods(); mi != me; ++mi) {
1844 BuildUniqueOverrider(U, *mi);
1845 }
1846 }
1847
1848 void BuildUniqueOverriders(const CXXRecordDecl *RD) {
1849 if (0) printf("walking %s\n", RD->getNameAsCString());
1850 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
1851 e = RD->method_end(); i != e; ++i) {
1852 const CXXMethodDecl *MD = *i;
1853 if (!MD->isVirtual())
1854 continue;
1855
1856 if (UniqueOverrider[MD] == 0) {
1857 // Only set this, if it hasn't been set yet.
1858 BuildUniqueOverrider(MD, MD);
1859 if (0)
1860 printf("top set is %s::%s %p\n",
1861 MD->getParent()->getNameAsCString(),
1862 MD->getNameAsCString(),
1863 (void*)MD);
1864 ForwardUnique[MD] = MD;
1865 }
1866 }
1867 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
1868 e = RD->bases_end(); i != e; ++i) {
1869 const CXXRecordDecl *Base =
1870 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
1871 BuildUniqueOverriders(Base);
1872 }
1873 }
1874
1875 static int DclCmp(const void *p1, const void *p2) {
John McCallef3057c2010-02-13 01:04:05 +00001876 const CXXMethodDecl *MD1 = *(const CXXMethodDecl *const *)p1;
1877 const CXXMethodDecl *MD2 = *(const CXXMethodDecl *const *)p2;
1878
1879 return (DeclarationName::compare(MD1->getDeclName(), MD2->getDeclName()));
Mike Stump90181eb2010-01-26 00:05:04 +00001880 }
1881
1882 void MergeForwarding() {
1883 typedef llvm::SmallVector<const CXXMethodDecl *, 100> A_t;
1884 A_t A;
1885 for (ForwardUnique_t::iterator I = ForwardUnique.begin(),
1886 E = ForwardUnique.end(); I != E; ++I) {
1887 if (I->first == I->second)
1888 // Only add the roots of all trees
1889 A.push_back(I->first);
1890 }
1891 llvm::array_pod_sort(A.begin(), A.end(), DclCmp);
1892 for (A_t::iterator I = A.begin(),
1893 E = A.end(); I != E; ++I) {
1894 A_t::iterator J = I;
John McCallef3057c2010-02-13 01:04:05 +00001895 while (++J != E && DclCmp(I, J) == 0)
Mike Stump90181eb2010-01-26 00:05:04 +00001896 if (DclIsSame(*I, *J)) {
Eli Friedman18c28f62010-02-13 00:03:21 +00001897 if (0) printf("connecting %s\n", (*I)->getNameAsCString());
Mike Stump90181eb2010-01-26 00:05:04 +00001898 ForwardUnique[*J] = *I;
1899 }
1900 }
1901 }
1902
1903 const CXXMethodDecl *getUnique(const CXXMethodDecl *MD) {
1904 const CXXMethodDecl *U = UniqueOverrider[MD];
1905 assert(U && "unique overrider not found");
1906 while (ForwardUnique.count(U)) {
1907 const CXXMethodDecl *NU = ForwardUnique[U];
1908 if (NU == U) break;
1909 U = NU;
1910 }
1911 return U;
1912 }
Anders Carlsson72281172010-01-26 17:36:47 +00001913
1914 GlobalDecl getUnique(GlobalDecl GD) {
1915 const CXXMethodDecl *Unique = getUnique(cast<CXXMethodDecl>(GD.getDecl()));
1916
1917 if (const CXXConstructorDecl *CD = dyn_cast<CXXConstructorDecl>(Unique))
1918 return GlobalDecl(CD, GD.getCtorType());
1919
1920 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(Unique))
1921 return GlobalDecl(DD, GD.getDtorType());
1922
1923 return Unique;
Mike Stump90181eb2010-01-26 00:05:04 +00001924 }
1925
Anders Carlsson323bb042009-11-26 19:54:33 +00001926 /// getPureVirtualFn - Return the __cxa_pure_virtual function.
1927 llvm::Constant* getPureVirtualFn() {
1928 if (!PureVirtualFn) {
1929 const llvm::FunctionType *Ty =
1930 llvm::FunctionType::get(llvm::Type::getVoidTy(VMContext),
1931 /*isVarArg=*/false);
1932 PureVirtualFn = wrap(CGM.CreateRuntimeFunction(Ty, "__cxa_pure_virtual"));
1933 }
1934
1935 return PureVirtualFn;
1936 }
1937
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001938public:
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001939 OldVtableBuilder(const CXXRecordDecl *MostDerivedClass,
Eli Friedman6c08ce72009-12-05 01:05:03 +00001940 const CXXRecordDecl *l, uint64_t lo, CodeGenModule &cgm,
Anders Carlsson5f9a8812010-01-14 02:29:07 +00001941 bool build, CGVtableInfo::AddressPointsMapTy& AddressPoints)
Eli Friedman6c08ce72009-12-05 01:05:03 +00001942 : BuildVtable(build), MostDerivedClass(MostDerivedClass), LayoutClass(l),
1943 LayoutOffset(lo), BLayout(cgm.getContext().getASTRecordLayout(l)),
1944 rtti(0), VMContext(cgm.getModule().getContext()),CGM(cgm),
1945 PureVirtualFn(0),
Anders Carlssonbad80eb2009-12-04 18:36:22 +00001946 subAddressPoints(AllocAddressPoint(cgm, l, MostDerivedClass)),
Anders Carlsson5f9a8812010-01-14 02:29:07 +00001947 AddressPoints(AddressPoints),
1948 LLVMPointerWidth(cgm.getContext().Target.getPointerWidth(0))
1949 {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001950 Ptr8Ty = llvm::PointerType::get(llvm::Type::getInt8Ty(VMContext), 0);
Anders Carlsson3f4336c2009-12-17 07:09:17 +00001951 if (BuildVtable) {
1952 QualType ClassType = CGM.getContext().getTagDeclType(MostDerivedClass);
1953 rtti = CGM.GetAddrOfRTTIDescriptor(ClassType);
1954 }
Mike Stump90181eb2010-01-26 00:05:04 +00001955 BuildUniqueOverriders(MostDerivedClass);
1956 MergeForwarding();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001957 }
1958
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00001959 // getVtableComponents - Returns a reference to the vtable components.
1960 const VtableComponentsVectorTy &getVtableComponents() const {
1961 return VtableComponents;
Anders Carlsson472404f2009-12-04 16:19:30 +00001962 }
1963
Anders Carlssone36a6b32010-01-02 01:01:18 +00001964 llvm::DenseMap<const CXXRecordDecl *, uint64_t> &getVBIndex()
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001965 { return VBIndex; }
1966
Eli Friedman31bc3ad2009-12-07 23:56:34 +00001967 SavedAdjustmentsVectorTy &getSavedAdjustments()
1968 { return SavedAdjustments; }
Eli Friedman8174f2c2009-12-06 22:01:30 +00001969
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001970 llvm::Constant *wrap(Index_t i) {
1971 llvm::Constant *m;
1972 m = llvm::ConstantInt::get(llvm::Type::getInt64Ty(VMContext), i);
1973 return llvm::ConstantExpr::getIntToPtr(m, Ptr8Ty);
1974 }
1975
1976 llvm::Constant *wrap(llvm::Constant *m) {
1977 return llvm::ConstantExpr::getBitCast(m, Ptr8Ty);
1978 }
1979
Mike Stumpd2808442010-01-22 02:51:26 +00001980//#define D1(x)
1981#define D1(X) do { if (getenv("DEBUG")) { X; } } while (0)
Mike Stump75ce5732009-10-31 20:06:59 +00001982
1983 void GenerateVBaseOffsets(const CXXRecordDecl *RD, uint64_t Offset,
Mike Stump28431212009-10-13 22:54:56 +00001984 bool updateVBIndex, Index_t current_vbindex) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001985 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
1986 e = RD->bases_end(); i != e; ++i) {
1987 const CXXRecordDecl *Base =
1988 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Mike Stump28431212009-10-13 22:54:56 +00001989 Index_t next_vbindex = current_vbindex;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001990 if (i->isVirtual() && !SeenVBase.count(Base)) {
1991 SeenVBase.insert(Base);
Mike Stump28431212009-10-13 22:54:56 +00001992 if (updateVBIndex) {
Mike Stump75ce5732009-10-31 20:06:59 +00001993 next_vbindex = (ssize_t)(-(VCalls.size()*LLVMPointerWidth/8)
Mike Stump28431212009-10-13 22:54:56 +00001994 - 3*LLVMPointerWidth/8);
1995 VBIndex[Base] = next_vbindex;
1996 }
Mike Stump75ce5732009-10-31 20:06:59 +00001997 int64_t BaseOffset = -(Offset/8) + BLayout.getVBaseClassOffset(Base)/8;
1998 VCalls.push_back((0?700:0) + BaseOffset);
1999 D1(printf(" vbase for %s at %d delta %d most derived %s\n",
2000 Base->getNameAsCString(),
2001 (int)-VCalls.size()-3, (int)BaseOffset,
Mike Stumpd2808442010-01-22 02:51:26 +00002002 MostDerivedClass->getNameAsCString()));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002003 }
Mike Stump28431212009-10-13 22:54:56 +00002004 // We also record offsets for non-virtual bases to closest enclosing
2005 // virtual base. We do this so that we don't have to search
2006 // for the nearst virtual base class when generating thunks.
2007 if (updateVBIndex && VBIndex.count(Base) == 0)
2008 VBIndex[Base] = next_vbindex;
Mike Stump75ce5732009-10-31 20:06:59 +00002009 GenerateVBaseOffsets(Base, Offset, updateVBIndex, next_vbindex);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002010 }
2011 }
2012
2013 void StartNewTable() {
2014 SeenVBase.clear();
2015 }
2016
Mike Stump8bccbfd2009-10-15 09:30:16 +00002017 Index_t getNVOffset_1(const CXXRecordDecl *D, const CXXRecordDecl *B,
2018 Index_t Offset = 0) {
2019
2020 if (B == D)
2021 return Offset;
2022
2023 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(D);
2024 for (CXXRecordDecl::base_class_const_iterator i = D->bases_begin(),
2025 e = D->bases_end(); i != e; ++i) {
2026 const CXXRecordDecl *Base =
2027 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
2028 int64_t BaseOffset = 0;
2029 if (!i->isVirtual())
2030 BaseOffset = Offset + Layout.getBaseClassOffset(Base);
2031 int64_t o = getNVOffset_1(Base, B, BaseOffset);
2032 if (o >= 0)
2033 return o;
2034 }
2035
2036 return -1;
2037 }
2038
2039 /// getNVOffset - Returns the non-virtual offset for the given (B) base of the
2040 /// derived class D.
2041 Index_t getNVOffset(QualType qB, QualType qD) {
Mike Stump46271322009-11-03 19:03:17 +00002042 qD = qD->getPointeeType();
2043 qB = qB->getPointeeType();
Mike Stump8bccbfd2009-10-15 09:30:16 +00002044 CXXRecordDecl *D = cast<CXXRecordDecl>(qD->getAs<RecordType>()->getDecl());
2045 CXXRecordDecl *B = cast<CXXRecordDecl>(qB->getAs<RecordType>()->getDecl());
2046 int64_t o = getNVOffset_1(D, B);
2047 if (o >= 0)
2048 return o;
2049
2050 assert(false && "FIXME: non-virtual base not found");
2051 return 0;
2052 }
2053
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002054 /// getVbaseOffset - Returns the index into the vtable for the virtual base
2055 /// offset for the given (B) virtual base of the derived class D.
2056 Index_t getVbaseOffset(QualType qB, QualType qD) {
Mike Stump46271322009-11-03 19:03:17 +00002057 qD = qD->getPointeeType();
2058 qB = qB->getPointeeType();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002059 CXXRecordDecl *D = cast<CXXRecordDecl>(qD->getAs<RecordType>()->getDecl());
2060 CXXRecordDecl *B = cast<CXXRecordDecl>(qB->getAs<RecordType>()->getDecl());
Anders Carlssonbad80eb2009-12-04 18:36:22 +00002061 if (D != MostDerivedClass)
Eli Friedman03aa2f12009-11-30 01:19:33 +00002062 return CGM.getVtableInfo().getVirtualBaseOffsetIndex(D, B);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002063 llvm::DenseMap<const CXXRecordDecl *, Index_t>::iterator i;
2064 i = VBIndex.find(B);
2065 if (i != VBIndex.end())
2066 return i->second;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002067
Mike Stump28431212009-10-13 22:54:56 +00002068 assert(false && "FIXME: Base not found");
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002069 return 0;
2070 }
2071
Eli Friedman81fb0d22009-12-04 08:40:51 +00002072 bool OverrideMethod(GlobalDecl GD, bool MorallyVirtual,
2073 Index_t OverrideOffset, Index_t Offset,
2074 int64_t CurrentVBaseOffset);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002075
Anders Carlsson495634e2009-12-04 02:39:04 +00002076 /// AppendMethods - Append the current methods to the vtable.
Anders Carlssonddf42c82009-12-04 02:56:03 +00002077 void AppendMethodsToVtable();
Anders Carlsson495634e2009-12-04 02:39:04 +00002078
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002079 llvm::Constant *WrapAddrOf(GlobalDecl GD) {
2080 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2081
Anders Carlsson64457732009-11-24 05:08:52 +00002082 const llvm::Type *Ty = CGM.getTypes().GetFunctionTypeForVtable(MD);
Mike Stump18e8b472009-10-27 23:36:26 +00002083
Mike Stumpcdeb8002009-12-03 16:55:20 +00002084 return wrap(CGM.GetAddrOfFunction(GD, Ty));
Mike Stump18e8b472009-10-27 23:36:26 +00002085 }
2086
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002087 void OverrideMethods(Path_t *Path, bool MorallyVirtual, int64_t Offset,
2088 int64_t CurrentVBaseOffset) {
Mike Stump37dbe962009-10-15 02:04:03 +00002089 for (Path_t::reverse_iterator i = Path->rbegin(),
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002090 e = Path->rend(); i != e; ++i) {
2091 const CXXRecordDecl *RD = i->first;
Mike Stump8bccbfd2009-10-15 09:30:16 +00002092 int64_t OverrideOffset = i->second;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002093 for (method_iter mi = RD->method_begin(), me = RD->method_end(); mi != me;
2094 ++mi) {
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002095 const CXXMethodDecl *MD = *mi;
2096
2097 if (!MD->isVirtual())
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002098 continue;
2099
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002100 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2101 // Override both the complete and the deleting destructor.
2102 GlobalDecl CompDtor(DD, Dtor_Complete);
Eli Friedman81fb0d22009-12-04 08:40:51 +00002103 OverrideMethod(CompDtor, MorallyVirtual, OverrideOffset, Offset,
2104 CurrentVBaseOffset);
2105
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002106 GlobalDecl DeletingDtor(DD, Dtor_Deleting);
Eli Friedman81fb0d22009-12-04 08:40:51 +00002107 OverrideMethod(DeletingDtor, MorallyVirtual, OverrideOffset, Offset,
2108 CurrentVBaseOffset);
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002109 } else {
Eli Friedman81fb0d22009-12-04 08:40:51 +00002110 OverrideMethod(MD, MorallyVirtual, OverrideOffset, Offset,
2111 CurrentVBaseOffset);
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002112 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002113 }
2114 }
2115 }
2116
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002117 void AddMethod(const GlobalDecl GD, bool MorallyVirtual, Index_t Offset,
Eli Friedman03aa2f12009-11-30 01:19:33 +00002118 int64_t CurrentVBaseOffset) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002119 // If we can find a previously allocated slot for this, reuse it.
Eli Friedman81fb0d22009-12-04 08:40:51 +00002120 if (OverrideMethod(GD, MorallyVirtual, Offset, Offset,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002121 CurrentVBaseOffset))
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002122 return;
2123
Mike Stump1f49d652010-01-22 18:48:47 +00002124 D1(printf(" vfn for %s at %d\n",
2125 dyn_cast<CXXMethodDecl>(GD.getDecl())->getNameAsCString(),
2126 (int)Methods.size()));
2127
Anders Carlssoncdf18982009-12-04 02:08:24 +00002128 // We didn't find an entry in the vtable that we could use, add a new
2129 // entry.
2130 Methods.AddMethod(GD);
2131
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002132 VCallOffset[GD] = Offset/8 - CurrentVBaseOffset/8;
2133
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002134 if (MorallyVirtual) {
Anders Carlsson72281172010-01-26 17:36:47 +00002135 GlobalDecl UGD = getUnique(GD);
2136 const CXXMethodDecl *UMD = cast<CXXMethodDecl>(UGD.getDecl());
2137
Mike Stump90181eb2010-01-26 00:05:04 +00002138 assert(UMD && "final overrider not found");
2139
2140 Index_t &idx = VCall[UMD];
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002141 // Allocate the first one, after that, we reuse the previous one.
2142 if (idx == 0) {
Anders Carlsson72281172010-01-26 17:36:47 +00002143 VCallOffsetForVCall[UGD] = Offset/8;
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002144 NonVirtualOffset[UMD] = Offset/8 - CurrentVBaseOffset/8;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002145 idx = VCalls.size()+1;
Mike Stump90181eb2010-01-26 00:05:04 +00002146 VCalls.push_back(Offset/8 - CurrentVBaseOffset/8);
Mike Stump75ce5732009-10-31 20:06:59 +00002147 D1(printf(" vcall for %s at %d with delta %d\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002148 dyn_cast<CXXMethodDecl>(GD.getDecl())->getNameAsCString(),
Mike Stump90181eb2010-01-26 00:05:04 +00002149 (int)-VCalls.size()-3, (int)VCalls[idx-1]));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002150 }
2151 }
2152 }
2153
2154 void AddMethods(const CXXRecordDecl *RD, bool MorallyVirtual,
Eli Friedman03aa2f12009-11-30 01:19:33 +00002155 Index_t Offset, int64_t CurrentVBaseOffset) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002156 for (method_iter mi = RD->method_begin(), me = RD->method_end(); mi != me;
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002157 ++mi) {
2158 const CXXMethodDecl *MD = *mi;
2159 if (!MD->isVirtual())
2160 continue;
2161
2162 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2163 // For destructors, add both the complete and the deleting destructor
2164 // to the vtable.
2165 AddMethod(GlobalDecl(DD, Dtor_Complete), MorallyVirtual, Offset,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002166 CurrentVBaseOffset);
Eli Friedman03aa2f12009-11-30 01:19:33 +00002167 AddMethod(GlobalDecl(DD, Dtor_Deleting), MorallyVirtual, Offset,
2168 CurrentVBaseOffset);
2169 } else
2170 AddMethod(MD, MorallyVirtual, Offset, CurrentVBaseOffset);
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002171 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002172 }
2173
2174 void NonVirtualBases(const CXXRecordDecl *RD, const ASTRecordLayout &Layout,
2175 const CXXRecordDecl *PrimaryBase,
2176 bool PrimaryBaseWasVirtual, bool MorallyVirtual,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002177 int64_t Offset, int64_t CurrentVBaseOffset,
2178 Path_t *Path) {
Mike Stump37dbe962009-10-15 02:04:03 +00002179 Path->push_back(std::make_pair(RD, Offset));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002180 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
2181 e = RD->bases_end(); i != e; ++i) {
2182 if (i->isVirtual())
2183 continue;
2184 const CXXRecordDecl *Base =
2185 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Mike Stump9eb76d42010-01-22 06:45:05 +00002186 uint64_t o = Offset + Layout.getBaseClassOffset(Base);
2187 StartNewTable();
2188 GenerateVtableForBase(Base, o, MorallyVirtual, false,
2189 true, Base == PrimaryBase && !PrimaryBaseWasVirtual,
2190 CurrentVBaseOffset, Path);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002191 }
Mike Stump37dbe962009-10-15 02:04:03 +00002192 Path->pop_back();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002193 }
2194
Mike Stumpb21c4ee2009-10-14 18:14:51 +00002195// #define D(X) do { X; } while (0)
2196#define D(X)
2197
2198 void insertVCalls(int InsertionPoint) {
Mike Stump75ce5732009-10-31 20:06:59 +00002199 D1(printf("============= combining vbase/vcall\n"));
Mike Stumpb21c4ee2009-10-14 18:14:51 +00002200 D(VCalls.insert(VCalls.begin(), 673));
2201 D(VCalls.push_back(672));
Eli Friedman6c08ce72009-12-05 01:05:03 +00002202
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002203 VtableComponents.insert(VtableComponents.begin() + InsertionPoint,
2204 VCalls.size(), 0);
Eli Friedman6c08ce72009-12-05 01:05:03 +00002205 if (BuildVtable) {
2206 // The vcalls come first...
2207 for (std::vector<Index_t>::reverse_iterator i = VCalls.rbegin(),
2208 e = VCalls.rend();
2209 i != e; ++i)
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002210 VtableComponents[InsertionPoint++] = wrap((0?600:0) + *i);
Eli Friedman6c08ce72009-12-05 01:05:03 +00002211 }
Mike Stumpb21c4ee2009-10-14 18:14:51 +00002212 VCalls.clear();
Mike Stump9f23a142009-11-10 02:30:51 +00002213 VCall.clear();
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002214 VCallOffsetForVCall.clear();
2215 VCallOffset.clear();
2216 NonVirtualOffset.clear();
Mike Stumpb21c4ee2009-10-14 18:14:51 +00002217 }
2218
Mike Stump559387f2009-11-13 23:13:20 +00002219 void AddAddressPoints(const CXXRecordDecl *RD, uint64_t Offset,
2220 Index_t AddressPoint) {
2221 D1(printf("XXX address point for %s in %s layout %s at offset %d is %d\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002222 RD->getNameAsCString(), MostDerivedClass->getNameAsCString(),
Mike Stump559387f2009-11-13 23:13:20 +00002223 LayoutClass->getNameAsCString(), (int)Offset, (int)AddressPoint));
Mike Stumpcd2b8212009-11-19 20:52:19 +00002224 subAddressPoints[std::make_pair(RD, Offset)] = AddressPoint;
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002225 AddressPoints[BaseSubobject(RD, Offset)] = AddressPoint;
Mike Stump559387f2009-11-13 23:13:20 +00002226
2227 // Now also add the address point for all our primary bases.
2228 while (1) {
2229 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
2230 RD = Layout.getPrimaryBase();
2231 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
2232 // FIXME: Double check this.
2233 if (RD == 0)
2234 break;
2235 if (PrimaryBaseWasVirtual &&
2236 BLayout.getVBaseClassOffset(RD) != Offset)
2237 break;
2238 D1(printf("XXX address point for %s in %s layout %s at offset %d is %d\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002239 RD->getNameAsCString(), MostDerivedClass->getNameAsCString(),
Mike Stump559387f2009-11-13 23:13:20 +00002240 LayoutClass->getNameAsCString(), (int)Offset, (int)AddressPoint));
Mike Stumpcd2b8212009-11-19 20:52:19 +00002241 subAddressPoints[std::make_pair(RD, Offset)] = AddressPoint;
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002242 AddressPoints[BaseSubobject(RD, Offset)] = AddressPoint;
Mike Stump559387f2009-11-13 23:13:20 +00002243 }
2244 }
2245
2246
Mike Stumpd538a6d2009-12-24 07:29:41 +00002247 void FinishGenerateVtable(const CXXRecordDecl *RD,
2248 const ASTRecordLayout &Layout,
2249 const CXXRecordDecl *PrimaryBase,
Mike Stump9eb76d42010-01-22 06:45:05 +00002250 bool ForNPNVBases, bool WasPrimaryBase,
Mike Stumpd538a6d2009-12-24 07:29:41 +00002251 bool PrimaryBaseWasVirtual,
2252 bool MorallyVirtual, int64_t Offset,
2253 bool ForVirtualBase, int64_t CurrentVBaseOffset,
2254 Path_t *Path) {
Mike Stump37dbe962009-10-15 02:04:03 +00002255 bool alloc = false;
2256 if (Path == 0) {
2257 alloc = true;
2258 Path = new Path_t;
2259 }
2260
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002261 StartNewTable();
2262 extra = 0;
Mike Stump9eb76d42010-01-22 06:45:05 +00002263 Index_t AddressPoint = 0;
2264 int VCallInsertionPoint = 0;
2265 if (!ForNPNVBases || !WasPrimaryBase) {
2266 bool DeferVCalls = MorallyVirtual || ForVirtualBase;
2267 VCallInsertionPoint = VtableComponents.size();
2268 if (!DeferVCalls) {
2269 insertVCalls(VCallInsertionPoint);
2270 } else
2271 // FIXME: just for extra, or for all uses of VCalls.size post this?
2272 extra = -VCalls.size();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002273
Mike Stump9eb76d42010-01-22 06:45:05 +00002274 // Add the offset to top.
2275 VtableComponents.push_back(BuildVtable ? wrap(-((Offset-LayoutOffset)/8)) : 0);
Anders Carlsson472404f2009-12-04 16:19:30 +00002276
Mike Stump9eb76d42010-01-22 06:45:05 +00002277 // Add the RTTI information.
2278 VtableComponents.push_back(rtti);
Anders Carlsson472404f2009-12-04 16:19:30 +00002279
Mike Stump9eb76d42010-01-22 06:45:05 +00002280 AddressPoint = VtableComponents.size();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002281
Mike Stump9eb76d42010-01-22 06:45:05 +00002282 AppendMethodsToVtable();
2283 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002284
2285 // and then the non-virtual bases.
2286 NonVirtualBases(RD, Layout, PrimaryBase, PrimaryBaseWasVirtual,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002287 MorallyVirtual, Offset, CurrentVBaseOffset, Path);
Mike Stumpb21c4ee2009-10-14 18:14:51 +00002288
2289 if (ForVirtualBase) {
Mike Stump2cefe382009-11-12 20:47:57 +00002290 // FIXME: We're adding to VCalls in callers, we need to do the overrides
2291 // in the inner part, so that we know the complete set of vcalls during
2292 // the build and don't have to insert into methods. Saving out the
2293 // AddressPoint here, would need to be fixed, if we didn't do that. Also
2294 // retroactively adding vcalls for overrides later wind up in the wrong
2295 // place, the vcall slot has to be alloted during the walk of the base
2296 // when the function is first introduces.
Mike Stumpb21c4ee2009-10-14 18:14:51 +00002297 AddressPoint += VCalls.size();
Mike Stump2cefe382009-11-12 20:47:57 +00002298 insertVCalls(VCallInsertionPoint);
Mike Stumpb21c4ee2009-10-14 18:14:51 +00002299 }
2300
Mike Stump9eb76d42010-01-22 06:45:05 +00002301 if (!ForNPNVBases || !WasPrimaryBase)
2302 AddAddressPoints(RD, Offset, AddressPoint);
Mike Stump2cefe382009-11-12 20:47:57 +00002303
Mike Stump37dbe962009-10-15 02:04:03 +00002304 if (alloc) {
2305 delete Path;
2306 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002307 }
2308
Mike Stump75ce5732009-10-31 20:06:59 +00002309 void Primaries(const CXXRecordDecl *RD, bool MorallyVirtual, int64_t Offset,
2310 bool updateVBIndex, Index_t current_vbindex,
Eli Friedman03aa2f12009-11-30 01:19:33 +00002311 int64_t CurrentVBaseOffset) {
Mike Stump75ce5732009-10-31 20:06:59 +00002312 if (!RD->isDynamicClass())
2313 return;
2314
2315 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
2316 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
2317 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
2318
2319 // vtables are composed from the chain of primaries.
Eli Friedman65d87222009-12-04 08:52:11 +00002320 if (PrimaryBase && !PrimaryBaseWasVirtual) {
Mike Stump75ce5732009-10-31 20:06:59 +00002321 D1(printf(" doing primaries for %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002322 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Eli Friedman65d87222009-12-04 08:52:11 +00002323 Primaries(PrimaryBase, PrimaryBaseWasVirtual|MorallyVirtual, Offset,
2324 updateVBIndex, current_vbindex, CurrentVBaseOffset);
Mike Stump75ce5732009-10-31 20:06:59 +00002325 }
2326
2327 D1(printf(" doing vcall entries for %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002328 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Mike Stump75ce5732009-10-31 20:06:59 +00002329
2330 // And add the virtuals for the class to the primary vtable.
Eli Friedman03aa2f12009-11-30 01:19:33 +00002331 AddMethods(RD, MorallyVirtual, Offset, CurrentVBaseOffset);
Mike Stump75ce5732009-10-31 20:06:59 +00002332 }
2333
2334 void VBPrimaries(const CXXRecordDecl *RD, bool MorallyVirtual, int64_t Offset,
2335 bool updateVBIndex, Index_t current_vbindex,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002336 bool RDisVirtualBase, int64_t CurrentVBaseOffset,
Eli Friedman03aa2f12009-11-30 01:19:33 +00002337 bool bottom) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002338 if (!RD->isDynamicClass())
2339 return;
2340
2341 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
2342 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
2343 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
2344
2345 // vtables are composed from the chain of primaries.
2346 if (PrimaryBase) {
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002347 int BaseCurrentVBaseOffset = CurrentVBaseOffset;
2348 if (PrimaryBaseWasVirtual) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002349 IndirectPrimary.insert(PrimaryBase);
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002350 BaseCurrentVBaseOffset = BLayout.getVBaseClassOffset(PrimaryBase);
2351 }
Mike Stump75ce5732009-10-31 20:06:59 +00002352
2353 D1(printf(" doing primaries for %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002354 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Mike Stump75ce5732009-10-31 20:06:59 +00002355
2356 VBPrimaries(PrimaryBase, PrimaryBaseWasVirtual|MorallyVirtual, Offset,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002357 updateVBIndex, current_vbindex, PrimaryBaseWasVirtual,
Eli Friedman03aa2f12009-11-30 01:19:33 +00002358 BaseCurrentVBaseOffset, false);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002359 }
2360
Mike Stump75ce5732009-10-31 20:06:59 +00002361 D1(printf(" doing vbase entries for %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002362 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Mike Stump75ce5732009-10-31 20:06:59 +00002363 GenerateVBaseOffsets(RD, Offset, updateVBIndex, current_vbindex);
2364
2365 if (RDisVirtualBase || bottom) {
2366 Primaries(RD, MorallyVirtual, Offset, updateVBIndex, current_vbindex,
Eli Friedman03aa2f12009-11-30 01:19:33 +00002367 CurrentVBaseOffset);
Mike Stump75ce5732009-10-31 20:06:59 +00002368 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002369 }
2370
Mike Stumpd538a6d2009-12-24 07:29:41 +00002371 void GenerateVtableForBase(const CXXRecordDecl *RD, int64_t Offset = 0,
2372 bool MorallyVirtual = false,
2373 bool ForVirtualBase = false,
Mike Stump9eb76d42010-01-22 06:45:05 +00002374 bool ForNPNVBases = false,
2375 bool WasPrimaryBase = true,
Mike Stumpd538a6d2009-12-24 07:29:41 +00002376 int CurrentVBaseOffset = 0,
2377 Path_t *Path = 0) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002378 if (!RD->isDynamicClass())
Mike Stumpd538a6d2009-12-24 07:29:41 +00002379 return;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002380
Mike Stumpfa818082009-11-13 02:35:38 +00002381 // Construction vtable don't need parts that have no virtual bases and
2382 // aren't morally virtual.
Anders Carlssonbad80eb2009-12-04 18:36:22 +00002383 if ((LayoutClass != MostDerivedClass) &&
2384 RD->getNumVBases() == 0 && !MorallyVirtual)
Mike Stumpd538a6d2009-12-24 07:29:41 +00002385 return;
Mike Stumpfa818082009-11-13 02:35:38 +00002386
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002387 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
2388 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
2389 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
2390
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002391 extra = 0;
Mike Stump75ce5732009-10-31 20:06:59 +00002392 D1(printf("building entries for base %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002393 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002394
Mike Stump75ce5732009-10-31 20:06:59 +00002395 if (ForVirtualBase)
2396 extra = VCalls.size();
2397
Mike Stump9eb76d42010-01-22 06:45:05 +00002398 if (!ForNPNVBases || !WasPrimaryBase) {
2399 VBPrimaries(RD, MorallyVirtual, Offset, !ForVirtualBase, 0,
2400 ForVirtualBase, CurrentVBaseOffset, true);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002401
Mike Stump9eb76d42010-01-22 06:45:05 +00002402 if (Path)
2403 OverrideMethods(Path, MorallyVirtual, Offset, CurrentVBaseOffset);
2404 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002405
Mike Stump9eb76d42010-01-22 06:45:05 +00002406 FinishGenerateVtable(RD, Layout, PrimaryBase, ForNPNVBases, WasPrimaryBase,
2407 PrimaryBaseWasVirtual, MorallyVirtual, Offset,
2408 ForVirtualBase, CurrentVBaseOffset, Path);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002409 }
2410
2411 void GenerateVtableForVBases(const CXXRecordDecl *RD,
2412 int64_t Offset = 0,
Mike Stump37dbe962009-10-15 02:04:03 +00002413 Path_t *Path = 0) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002414 bool alloc = false;
2415 if (Path == 0) {
2416 alloc = true;
Mike Stump37dbe962009-10-15 02:04:03 +00002417 Path = new Path_t;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002418 }
2419 // FIXME: We also need to override using all paths to a virtual base,
2420 // right now, we just process the first path
2421 Path->push_back(std::make_pair(RD, Offset));
2422 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
2423 e = RD->bases_end(); i != e; ++i) {
2424 const CXXRecordDecl *Base =
2425 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
2426 if (i->isVirtual() && !IndirectPrimary.count(Base)) {
2427 // Mark it so we don't output it twice.
2428 IndirectPrimary.insert(Base);
2429 StartNewTable();
Mike Stumpb21c4ee2009-10-14 18:14:51 +00002430 VCall.clear();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002431 int64_t BaseOffset = BLayout.getVBaseClassOffset(Base);
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002432 int64_t CurrentVBaseOffset = BaseOffset;
Mike Stump75ce5732009-10-31 20:06:59 +00002433 D1(printf("vtable %s virtual base %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002434 MostDerivedClass->getNameAsCString(), Base->getNameAsCString()));
Mike Stump9eb76d42010-01-22 06:45:05 +00002435 GenerateVtableForBase(Base, BaseOffset, true, true, false,
2436 true, CurrentVBaseOffset, Path);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002437 }
Mike Stump2cefe382009-11-12 20:47:57 +00002438 int64_t BaseOffset;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002439 if (i->isVirtual())
2440 BaseOffset = BLayout.getVBaseClassOffset(Base);
Mike Stump2cefe382009-11-12 20:47:57 +00002441 else {
2442 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
2443 BaseOffset = Offset + Layout.getBaseClassOffset(Base);
2444 }
2445
Mike Stump37dbe962009-10-15 02:04:03 +00002446 if (Base->getNumVBases()) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002447 GenerateVtableForVBases(Base, BaseOffset, Path);
Mike Stump37dbe962009-10-15 02:04:03 +00002448 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002449 }
2450 Path->pop_back();
2451 if (alloc)
2452 delete Path;
2453 }
2454};
Anders Carlssonca1bf682009-12-03 01:54:02 +00002455} // end anonymous namespace
2456
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002457bool OldVtableBuilder::OverrideMethod(GlobalDecl GD, bool MorallyVirtual,
Eli Friedman81fb0d22009-12-04 08:40:51 +00002458 Index_t OverrideOffset, Index_t Offset,
2459 int64_t CurrentVBaseOffset) {
Anders Carlssonca1bf682009-12-03 01:54:02 +00002460 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2461
2462 const bool isPure = MD->isPure();
Anders Carlsson21bbc1e2009-12-05 17:04:47 +00002463
Anders Carlssonca1bf682009-12-03 01:54:02 +00002464 // FIXME: Should OverrideOffset's be Offset?
2465
Anders Carlsson21bbc1e2009-12-05 17:04:47 +00002466 for (CXXMethodDecl::method_iterator mi = MD->begin_overridden_methods(),
2467 e = MD->end_overridden_methods(); mi != e; ++mi) {
Anders Carlssonca1bf682009-12-03 01:54:02 +00002468 GlobalDecl OGD;
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002469 GlobalDecl OGD2;
Anders Carlssonca1bf682009-12-03 01:54:02 +00002470
Anders Carlssonf3935b42009-12-04 05:51:56 +00002471 const CXXMethodDecl *OMD = *mi;
Anders Carlssonca1bf682009-12-03 01:54:02 +00002472 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(OMD))
2473 OGD = GlobalDecl(DD, GD.getDtorType());
2474 else
2475 OGD = OMD;
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002476
Eli Friedman8174f2c2009-12-06 22:01:30 +00002477 // Check whether this is the method being overridden in this section of
2478 // the vtable.
Anders Carlsson7bb70762009-12-04 15:49:02 +00002479 uint64_t Index;
2480 if (!Methods.getIndex(OGD, Index))
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002481 continue;
2482
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002483 OGD2 = OGD;
2484
Eli Friedman8174f2c2009-12-06 22:01:30 +00002485 // Get the original method, which we should be computing thunks, etc,
2486 // against.
2487 OGD = Methods.getOrigMethod(Index);
2488 OMD = cast<CXXMethodDecl>(OGD.getDecl());
2489
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002490 QualType ReturnType =
2491 MD->getType()->getAs<FunctionType>()->getResultType();
2492 QualType OverriddenReturnType =
2493 OMD->getType()->getAs<FunctionType>()->getResultType();
Anders Carlssonca1bf682009-12-03 01:54:02 +00002494
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002495 // Check if we need a return type adjustment.
Anders Carlssoncce9ee82010-02-13 23:17:31 +00002496 if (!ComputeReturnAdjustmentBaseOffset(CGM.getContext(), MD,
2497 OMD).isEmpty()) {
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002498 CanQualType &BaseReturnType = BaseReturnTypes[Index];
Anders Carlssonca1bf682009-12-03 01:54:02 +00002499
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002500 // Insert the base return type.
2501 if (BaseReturnType.isNull())
2502 BaseReturnType =
2503 CGM.getContext().getCanonicalType(OverriddenReturnType);
2504 }
Anders Carlssona93e9802009-12-04 03:52:52 +00002505
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002506 Methods.OverrideMethod(OGD, GD);
2507
Anders Carlsson72281172010-01-26 17:36:47 +00002508 GlobalDecl UGD = getUnique(GD);
2509 const CXXMethodDecl *UMD = cast<CXXMethodDecl>(UGD.getDecl());
2510 assert(UGD.getDecl() && "unique overrider not found");
2511 assert(UGD == getUnique(OGD) && "unique overrider not unique");
Mike Stump90181eb2010-01-26 00:05:04 +00002512
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002513 ThisAdjustments.erase(Index);
Mike Stump90181eb2010-01-26 00:05:04 +00002514 if (MorallyVirtual || VCall.count(UMD)) {
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002515
Mike Stump90181eb2010-01-26 00:05:04 +00002516 Index_t &idx = VCall[UMD];
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002517 if (idx == 0) {
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002518 VCallOffset[GD] = VCallOffset[OGD];
2519 // NonVirtualOffset[UMD] = CurrentVBaseOffset/8 - OverrideOffset/8;
2520 NonVirtualOffset[UMD] = VCallOffset[OGD];
Mike Stump77537b12010-01-26 03:42:22 +00002521 VCallOffsetForVCall[UMD] = OverrideOffset/8;
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002522 idx = VCalls.size()+1;
Mike Stump77537b12010-01-26 03:42:22 +00002523 VCalls.push_back(OverrideOffset/8 - CurrentVBaseOffset/8);
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002524 D1(printf(" vcall for %s at %d with delta %d most derived %s\n",
2525 MD->getNameAsString().c_str(), (int)-idx-3,
Mike Stumpd2808442010-01-22 02:51:26 +00002526 (int)VCalls[idx-1], MostDerivedClass->getNameAsCString()));
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002527 } else {
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002528 VCallOffset[GD] = NonVirtualOffset[UMD];
Anders Carlsson72281172010-01-26 17:36:47 +00002529 VCalls[idx-1] = -VCallOffsetForVCall[UGD] + OverrideOffset/8;
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002530 D1(printf(" vcall patch for %s at %d with delta %d most derived %s\n",
2531 MD->getNameAsString().c_str(), (int)-idx-3,
Mike Stumpd2808442010-01-22 02:51:26 +00002532 (int)VCalls[idx-1], MostDerivedClass->getNameAsCString()));
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002533 }
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002534 int64_t NonVirtualAdjustment = -VCallOffset[OGD];
Mike Stumpded0a402010-01-26 22:44:01 +00002535 QualType DerivedType = MD->getThisType(CGM.getContext());
2536 QualType BaseType = cast<const CXXMethodDecl>(OGD.getDecl())->getThisType(CGM.getContext());
2537 int64_t NonVirtualAdjustment2 = -(getNVOffset(BaseType, DerivedType)/8);
2538 if (NonVirtualAdjustment2 != NonVirtualAdjustment) {
2539 NonVirtualAdjustment = NonVirtualAdjustment2;
2540 }
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002541 int64_t VirtualAdjustment =
2542 -((idx + extra + 2) * LLVMPointerWidth / 8);
Anders Carlsson657f1392009-12-03 02:32:59 +00002543
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002544 // Optimize out virtual adjustments of 0.
2545 if (VCalls[idx-1] == 0)
2546 VirtualAdjustment = 0;
Anders Carlsson657f1392009-12-03 02:32:59 +00002547
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002548 ThunkAdjustment ThisAdjustment(NonVirtualAdjustment,
2549 VirtualAdjustment);
Anders Carlsson2ca285f2009-12-03 02:22:59 +00002550
Eli Friedman8174f2c2009-12-06 22:01:30 +00002551 if (!isPure && !ThisAdjustment.isEmpty()) {
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002552 ThisAdjustments[Index] = ThisAdjustment;
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002553 SavedAdjustments.push_back(
2554 std::make_pair(GD, std::make_pair(OGD, ThisAdjustment)));
Eli Friedman8174f2c2009-12-06 22:01:30 +00002555 }
Anders Carlssonca1bf682009-12-03 01:54:02 +00002556 return true;
2557 }
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002558
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002559 VCallOffset[GD] = VCallOffset[OGD2] - OverrideOffset/8;
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002560
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002561 int64_t NonVirtualAdjustment = -VCallOffset[GD];
2562 QualType DerivedType = MD->getThisType(CGM.getContext());
2563 QualType BaseType = cast<const CXXMethodDecl>(OGD.getDecl())->getThisType(CGM.getContext());
2564 int64_t NonVirtualAdjustment2 = -(getNVOffset(BaseType, DerivedType)/8);
2565 if (NonVirtualAdjustment2 != NonVirtualAdjustment) {
2566 NonVirtualAdjustment = NonVirtualAdjustment2;
2567 }
2568
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002569 if (NonVirtualAdjustment) {
2570 ThunkAdjustment ThisAdjustment(NonVirtualAdjustment, 0);
2571
Eli Friedmanf2eda5e2009-12-06 22:33:51 +00002572 if (!isPure) {
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002573 ThisAdjustments[Index] = ThisAdjustment;
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002574 SavedAdjustments.push_back(
2575 std::make_pair(GD, std::make_pair(OGD, ThisAdjustment)));
Eli Friedmanf2eda5e2009-12-06 22:33:51 +00002576 }
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002577 }
2578 return true;
Anders Carlssonca1bf682009-12-03 01:54:02 +00002579 }
2580
2581 return false;
Anders Carlssond59885022009-11-27 22:21:51 +00002582}
2583
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002584void OldVtableBuilder::AppendMethodsToVtable() {
Eli Friedman6c08ce72009-12-05 01:05:03 +00002585 if (!BuildVtable) {
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002586 VtableComponents.insert(VtableComponents.end(), Methods.size(),
2587 (llvm::Constant *)0);
Eli Friedman6c08ce72009-12-05 01:05:03 +00002588 ThisAdjustments.clear();
2589 BaseReturnTypes.clear();
2590 Methods.clear();
2591 return;
2592 }
2593
Anders Carlsson472404f2009-12-04 16:19:30 +00002594 // Reserve room in the vtable for our new methods.
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002595 VtableComponents.reserve(VtableComponents.size() + Methods.size());
Anders Carlssonb07567c2009-12-04 03:07:26 +00002596
Anders Carlsson86809cd2009-12-04 02:43:50 +00002597 for (unsigned i = 0, e = Methods.size(); i != e; ++i) {
2598 GlobalDecl GD = Methods[i];
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00002599 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2600
2601 // Get the 'this' pointer adjustment.
Anders Carlsson86809cd2009-12-04 02:43:50 +00002602 ThunkAdjustment ThisAdjustment = ThisAdjustments.lookup(i);
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00002603
2604 // Construct the return type adjustment.
2605 ThunkAdjustment ReturnAdjustment;
2606
2607 QualType BaseReturnType = BaseReturnTypes.lookup(i);
2608 if (!BaseReturnType.isNull() && !MD->isPure()) {
2609 QualType DerivedType =
2610 MD->getType()->getAs<FunctionType>()->getResultType();
2611
2612 int64_t NonVirtualAdjustment =
2613 getNVOffset(BaseReturnType, DerivedType) / 8;
2614
2615 int64_t VirtualAdjustment =
2616 getVbaseOffset(BaseReturnType, DerivedType);
2617
2618 ReturnAdjustment = ThunkAdjustment(NonVirtualAdjustment,
2619 VirtualAdjustment);
2620 }
2621
Anders Carlsson50f14742009-12-04 03:06:03 +00002622 llvm::Constant *Method = 0;
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00002623 if (!ReturnAdjustment.isEmpty()) {
2624 // Build a covariant thunk.
2625 CovariantThunkAdjustment Adjustment(ThisAdjustment, ReturnAdjustment);
Eli Friedman8174f2c2009-12-06 22:01:30 +00002626 Method = wrap(CGM.GetAddrOfCovariantThunk(GD, Adjustment));
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00002627 } else if (!ThisAdjustment.isEmpty()) {
2628 // Build a "regular" thunk.
Eli Friedman8174f2c2009-12-06 22:01:30 +00002629 Method = wrap(CGM.GetAddrOfThunk(GD, ThisAdjustment));
Anders Carlssonddf42c82009-12-04 02:56:03 +00002630 } else if (MD->isPure()) {
2631 // We have a pure virtual method.
Anders Carlsson50f14742009-12-04 03:06:03 +00002632 Method = getPureVirtualFn();
2633 } else {
2634 // We have a good old regular method.
2635 Method = WrapAddrOf(GD);
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00002636 }
Anders Carlsson50f14742009-12-04 03:06:03 +00002637
2638 // Add the method to the vtable.
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002639 VtableComponents.push_back(Method);
Anders Carlsson86809cd2009-12-04 02:43:50 +00002640 }
2641
Anders Carlsson50f14742009-12-04 03:06:03 +00002642
Anders Carlsson86809cd2009-12-04 02:43:50 +00002643 ThisAdjustments.clear();
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00002644 BaseReturnTypes.clear();
Anders Carlsson86809cd2009-12-04 02:43:50 +00002645
Anders Carlsson495634e2009-12-04 02:39:04 +00002646 Methods.clear();
Anders Carlsson495634e2009-12-04 02:39:04 +00002647}
2648
Anders Carlssonf942ee02009-11-27 20:47:55 +00002649void CGVtableInfo::ComputeMethodVtableIndices(const CXXRecordDecl *RD) {
2650
2651 // Itanium C++ ABI 2.5.2:
Anders Carlsson259688c2010-02-02 03:37:46 +00002652 // The order of the virtual function pointers in a virtual table is the
2653 // order of declaration of the corresponding member functions in the class.
Anders Carlssonf942ee02009-11-27 20:47:55 +00002654 //
Anders Carlsson259688c2010-02-02 03:37:46 +00002655 // There is an entry for any virtual function declared in a class,
2656 // whether it is a new function or overrides a base class function,
2657 // unless it overrides a function from the primary base, and conversion
2658 // between their return types does not require an adjustment.
Anders Carlssonf942ee02009-11-27 20:47:55 +00002659
2660 int64_t CurrentIndex = 0;
2661
2662 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
2663 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
2664
2665 if (PrimaryBase) {
Anders Carlssonc920fa22009-11-30 19:43:26 +00002666 assert(PrimaryBase->isDefinition() &&
2667 "Should have the definition decl of the primary base!");
Anders Carlssonf942ee02009-11-27 20:47:55 +00002668
2669 // Since the record decl shares its vtable pointer with the primary base
2670 // we need to start counting at the end of the primary base's vtable.
2671 CurrentIndex = getNumVirtualFunctionPointers(PrimaryBase);
2672 }
Eli Friedman21517252009-12-15 03:31:17 +00002673
2674 // Collect all the primary bases, so we can check whether methods override
2675 // a method from the base.
Anders Carlsson65b49782010-02-12 05:25:12 +00002676 VtableBuilder::PrimaryBasesSetTy PrimaryBases;
Eli Friedman21517252009-12-15 03:31:17 +00002677 for (ASTRecordLayout::primary_base_info_iterator
2678 I = Layout.primary_base_begin(), E = Layout.primary_base_end();
2679 I != E; ++I)
2680 PrimaryBases.insert((*I).getBase());
2681
Anders Carlssonf942ee02009-11-27 20:47:55 +00002682 const CXXDestructorDecl *ImplicitVirtualDtor = 0;
2683
2684 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
2685 e = RD->method_end(); i != e; ++i) {
2686 const CXXMethodDecl *MD = *i;
2687
2688 // We only want virtual methods.
2689 if (!MD->isVirtual())
2690 continue;
2691
Anders Carlssonf942ee02009-11-27 20:47:55 +00002692 // Check if this method overrides a method in the primary base.
Anders Carlsson65b49782010-02-12 05:25:12 +00002693 if (const CXXMethodDecl *OverriddenMD =
2694 OverridesMethodInPrimaryBase(MD, PrimaryBases)) {
2695 // Check if converting from the return type of the method to the
2696 // return type of the overridden method requires conversion.
Anders Carlssoncce9ee82010-02-13 23:17:31 +00002697 if (ComputeReturnAdjustmentBaseOffset(CGM.getContext(), MD,
2698 OverriddenMD).isEmpty()) {
Anders Carlsson65b49782010-02-12 05:25:12 +00002699 // This index is shared between the index in the vtable of the primary
2700 // base class.
2701 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2702 const CXXDestructorDecl *OverriddenDD =
2703 cast<CXXDestructorDecl>(OverriddenMD);
Anders Carlssonf942ee02009-11-27 20:47:55 +00002704
Anders Carlsson65b49782010-02-12 05:25:12 +00002705 // Add both the complete and deleting entries.
2706 MethodVtableIndices[GlobalDecl(DD, Dtor_Complete)] =
2707 getMethodVtableIndex(GlobalDecl(OverriddenDD, Dtor_Complete));
2708 MethodVtableIndices[GlobalDecl(DD, Dtor_Deleting)] =
2709 getMethodVtableIndex(GlobalDecl(OverriddenDD, Dtor_Deleting));
2710 } else {
2711 MethodVtableIndices[MD] = getMethodVtableIndex(OverriddenMD);
2712 }
2713
2714 // We don't need to add an entry for this method.
Anders Carlsson07604812010-02-12 18:14:46 +00002715 continue;
Anders Carlssonf942ee02009-11-27 20:47:55 +00002716 }
2717 }
2718
Anders Carlssonf942ee02009-11-27 20:47:55 +00002719 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2720 if (MD->isImplicit()) {
2721 assert(!ImplicitVirtualDtor &&
2722 "Did already see an implicit virtual dtor!");
2723 ImplicitVirtualDtor = DD;
2724 continue;
2725 }
2726
2727 // Add the complete dtor.
2728 MethodVtableIndices[GlobalDecl(DD, Dtor_Complete)] = CurrentIndex++;
2729
2730 // Add the deleting dtor.
2731 MethodVtableIndices[GlobalDecl(DD, Dtor_Deleting)] = CurrentIndex++;
2732 } else {
2733 // Add the entry.
2734 MethodVtableIndices[MD] = CurrentIndex++;
2735 }
2736 }
2737
2738 if (ImplicitVirtualDtor) {
2739 // Itanium C++ ABI 2.5.2:
Anders Carlssondc2dba32010-02-16 04:49:44 +00002740 // If a class has an implicitly-defined virtual destructor,
2741 // its entries come after the declared virtual function pointers.
Anders Carlssonf942ee02009-11-27 20:47:55 +00002742
2743 // Add the complete dtor.
2744 MethodVtableIndices[GlobalDecl(ImplicitVirtualDtor, Dtor_Complete)] =
2745 CurrentIndex++;
2746
2747 // Add the deleting dtor.
2748 MethodVtableIndices[GlobalDecl(ImplicitVirtualDtor, Dtor_Deleting)] =
2749 CurrentIndex++;
2750 }
2751
2752 NumVirtualFunctionPointers[RD] = CurrentIndex;
2753}
2754
2755uint64_t CGVtableInfo::getNumVirtualFunctionPointers(const CXXRecordDecl *RD) {
2756 llvm::DenseMap<const CXXRecordDecl *, uint64_t>::iterator I =
2757 NumVirtualFunctionPointers.find(RD);
2758 if (I != NumVirtualFunctionPointers.end())
2759 return I->second;
2760
2761 ComputeMethodVtableIndices(RD);
2762
2763 I = NumVirtualFunctionPointers.find(RD);
2764 assert(I != NumVirtualFunctionPointers.end() && "Did not find entry!");
2765 return I->second;
2766}
2767
2768uint64_t CGVtableInfo::getMethodVtableIndex(GlobalDecl GD) {
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002769 MethodVtableIndicesTy::iterator I = MethodVtableIndices.find(GD);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002770 if (I != MethodVtableIndices.end())
2771 return I->second;
2772
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002773 const CXXRecordDecl *RD = cast<CXXMethodDecl>(GD.getDecl())->getParent();
Anders Carlssonf942ee02009-11-27 20:47:55 +00002774
2775 ComputeMethodVtableIndices(RD);
2776
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002777 I = MethodVtableIndices.find(GD);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002778 assert(I != MethodVtableIndices.end() && "Did not find index!");
2779 return I->second;
2780}
2781
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002782CGVtableInfo::AdjustmentVectorTy*
2783CGVtableInfo::getAdjustments(GlobalDecl GD) {
2784 SavedAdjustmentsTy::iterator I = SavedAdjustments.find(GD);
2785 if (I != SavedAdjustments.end())
2786 return &I->second;
Eli Friedman8174f2c2009-12-06 22:01:30 +00002787
2788 const CXXRecordDecl *RD = cast<CXXRecordDecl>(GD.getDecl()->getDeclContext());
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002789 if (!SavedAdjustmentRecords.insert(RD).second)
2790 return 0;
Eli Friedman8174f2c2009-12-06 22:01:30 +00002791
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002792 AddressPointsMapTy AddressPoints;
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002793 OldVtableBuilder b(RD, RD, 0, CGM, false, AddressPoints);
Eli Friedman8174f2c2009-12-06 22:01:30 +00002794 D1(printf("vtable %s\n", RD->getNameAsCString()));
2795 b.GenerateVtableForBase(RD);
2796 b.GenerateVtableForVBases(RD);
Eli Friedman8174f2c2009-12-06 22:01:30 +00002797
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002798 for (OldVtableBuilder::SavedAdjustmentsVectorTy::iterator
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002799 i = b.getSavedAdjustments().begin(),
2800 e = b.getSavedAdjustments().end(); i != e; i++)
2801 SavedAdjustments[i->first].push_back(i->second);
Eli Friedman8174f2c2009-12-06 22:01:30 +00002802
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002803 I = SavedAdjustments.find(GD);
2804 if (I != SavedAdjustments.end())
2805 return &I->second;
2806
2807 return 0;
Eli Friedman8174f2c2009-12-06 22:01:30 +00002808}
2809
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002810int64_t CGVtableInfo::getVirtualBaseOffsetIndex(const CXXRecordDecl *RD,
2811 const CXXRecordDecl *VBase) {
2812 ClassPairTy ClassPair(RD, VBase);
2813
2814 VirtualBaseClassIndiciesTy::iterator I =
2815 VirtualBaseClassIndicies.find(ClassPair);
2816 if (I != VirtualBaseClassIndicies.end())
2817 return I->second;
2818
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002819 // FIXME: This seems expensive. Can we do a partial job to get
2820 // just this data.
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002821 AddressPointsMapTy AddressPoints;
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002822 OldVtableBuilder b(RD, RD, 0, CGM, false, AddressPoints);
Mike Stump75ce5732009-10-31 20:06:59 +00002823 D1(printf("vtable %s\n", RD->getNameAsCString()));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002824 b.GenerateVtableForBase(RD);
2825 b.GenerateVtableForVBases(RD);
2826
2827 for (llvm::DenseMap<const CXXRecordDecl *, uint64_t>::iterator I =
2828 b.getVBIndex().begin(), E = b.getVBIndex().end(); I != E; ++I) {
2829 // Insert all types.
2830 ClassPairTy ClassPair(RD, I->first);
2831
2832 VirtualBaseClassIndicies.insert(std::make_pair(ClassPair, I->second));
2833 }
2834
2835 I = VirtualBaseClassIndicies.find(ClassPair);
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00002836 // FIXME: The assertion below assertion currently fails with the old vtable
2837 /// layout code if there is a non-virtual thunk adjustment in a vtable.
2838 // Once the new layout is in place, this return should be removed.
2839 if (I == VirtualBaseClassIndicies.end())
2840 return 0;
2841
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002842 assert(I != VirtualBaseClassIndicies.end() && "Did not find index!");
2843
2844 return I->second;
2845}
2846
Anders Carlssonc8e39ec2009-12-05 21:03:56 +00002847uint64_t CGVtableInfo::getVtableAddressPoint(const CXXRecordDecl *RD) {
2848 uint64_t AddressPoint =
Anders Carlsson93a18842010-01-02 18:02:32 +00002849 (*(*(CGM.getVtableInfo().AddressPoints[RD]))[RD])[std::make_pair(RD, 0)];
Anders Carlssonc8e39ec2009-12-05 21:03:56 +00002850
2851 return AddressPoint;
2852}
2853
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00002854llvm::GlobalVariable *
Anders Carlsson0911ae82009-12-06 00:23:49 +00002855CGVtableInfo::GenerateVtable(llvm::GlobalVariable::LinkageTypes Linkage,
Anders Carlsson232324c2009-12-06 00:53:22 +00002856 bool GenerateDefinition,
Anders Carlsson0911ae82009-12-06 00:23:49 +00002857 const CXXRecordDecl *LayoutClass,
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002858 const CXXRecordDecl *RD, uint64_t Offset,
2859 AddressPointsMapTy& AddressPoints) {
Anders Carlsson1888b442010-02-14 00:22:59 +00002860 if (GenerateDefinition && CGM.getLangOptions().DumpVtableLayouts &&
2861 LayoutClass == RD) {
Anders Carlssoncf5a8822010-02-13 21:07:32 +00002862 VtableBuilder Builder(*this, RD);
Anders Carlssoneee53d92010-02-13 02:02:03 +00002863
2864 Builder.dumpLayout(llvm::errs());
2865 }
2866
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002867 llvm::SmallString<256> OutName;
Mike Stump2cefe382009-11-12 20:47:57 +00002868 if (LayoutClass != RD)
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00002869 CGM.getMangleContext().mangleCXXCtorVtable(LayoutClass, Offset / 8,
2870 RD, OutName);
Mike Stumpeac45592009-11-11 20:26:26 +00002871 else
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00002872 CGM.getMangleContext().mangleCXXVtable(RD, OutName);
Daniel Dunbare128dd12009-11-21 09:06:22 +00002873 llvm::StringRef Name = OutName.str();
Benjamin Kramerbb0a07b2009-10-11 22:57:54 +00002874
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00002875 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name);
Anders Carlsson93a18842010-01-02 18:02:32 +00002876 if (GV == 0 || CGM.getVtableInfo().AddressPoints[LayoutClass] == 0 ||
2877 GV->isDeclaration()) {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002878 OldVtableBuilder b(RD, LayoutClass, Offset, CGM, GenerateDefinition,
2879 AddressPoints);
Eli Friedman6c08ce72009-12-05 01:05:03 +00002880
2881 D1(printf("vtable %s\n", RD->getNameAsCString()));
2882 // First comes the vtables for all the non-virtual bases...
Mike Stumpd538a6d2009-12-24 07:29:41 +00002883 b.GenerateVtableForBase(RD, Offset);
Eli Friedman6c08ce72009-12-05 01:05:03 +00002884
2885 // then the vtables for all the virtual bases.
2886 b.GenerateVtableForVBases(RD, Offset);
2887
Anders Carlsson58b271d2009-12-05 22:19:10 +00002888 llvm::Constant *Init = 0;
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00002889 const llvm::Type *Int8PtrTy = llvm::Type::getInt8PtrTy(CGM.getLLVMContext());
Anders Carlsson58b271d2009-12-05 22:19:10 +00002890 llvm::ArrayType *ArrayType =
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002891 llvm::ArrayType::get(Int8PtrTy, b.getVtableComponents().size());
Anders Carlssona95d4c52009-12-05 21:09:05 +00002892
Anders Carlsson232324c2009-12-06 00:53:22 +00002893 if (GenerateDefinition)
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002894 Init = llvm::ConstantArray::get(ArrayType, &b.getVtableComponents()[0],
2895 b.getVtableComponents().size());
Anders Carlsson232324c2009-12-06 00:53:22 +00002896
Mike Stumpaa51ad62009-11-19 04:04:36 +00002897 llvm::GlobalVariable *OGV = GV;
Anders Carlsson232324c2009-12-06 00:53:22 +00002898
2899 GV = new llvm::GlobalVariable(CGM.getModule(), ArrayType,
2900 /*isConstant=*/true, Linkage, Init, Name);
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002901 CGM.setGlobalVisibility(GV, RD);
2902
Mike Stumpaa51ad62009-11-19 04:04:36 +00002903 if (OGV) {
2904 GV->takeName(OGV);
Anders Carlsson58b271d2009-12-05 22:19:10 +00002905 llvm::Constant *NewPtr =
2906 llvm::ConstantExpr::getBitCast(GV, OGV->getType());
Mike Stumpaa51ad62009-11-19 04:04:36 +00002907 OGV->replaceAllUsesWith(NewPtr);
2908 OGV->eraseFromParent();
2909 }
Mike Stumpaa51ad62009-11-19 04:04:36 +00002910 }
Anders Carlssonb3f54b72009-12-05 21:28:12 +00002911
2912 return GV;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002913}
Mike Stump9f23a142009-11-10 02:30:51 +00002914
Anders Carlsson232324c2009-12-06 00:53:22 +00002915void CGVtableInfo::GenerateClassData(llvm::GlobalVariable::LinkageTypes Linkage,
2916 const CXXRecordDecl *RD) {
Anders Carlssone1b3e622009-12-07 07:59:52 +00002917 llvm::GlobalVariable *&Vtable = Vtables[RD];
2918 if (Vtable) {
2919 assert(Vtable->getInitializer() && "Vtable doesn't have a definition!");
2920 return;
2921 }
2922
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002923 AddressPointsMapTy AddressPoints;
2924 Vtable = GenerateVtable(Linkage, /*GenerateDefinition=*/true, RD, RD, 0,
2925 AddressPoints);
Anders Carlssone36a6b32010-01-02 01:01:18 +00002926 GenerateVTT(Linkage, /*GenerateDefinition=*/true, RD);
Mike Stump1a139f82009-11-19 01:08:19 +00002927}
2928
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00002929llvm::GlobalVariable *CGVtableInfo::getVtable(const CXXRecordDecl *RD) {
Anders Carlsson232324c2009-12-06 00:53:22 +00002930 llvm::GlobalVariable *Vtable = Vtables.lookup(RD);
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00002931
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002932 if (!Vtable) {
2933 AddressPointsMapTy AddressPoints;
Anders Carlsson232324c2009-12-06 00:53:22 +00002934 Vtable = GenerateVtable(llvm::GlobalValue::ExternalLinkage,
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002935 /*GenerateDefinition=*/false, RD, RD, 0,
2936 AddressPoints);
2937 }
Mike Stumpaa51ad62009-11-19 04:04:36 +00002938
Anders Carlsson4ed44eb2009-12-05 22:42:54 +00002939 return Vtable;
Mike Stumpd846d082009-11-10 07:44:33 +00002940}
Mike Stumpeac45592009-11-11 20:26:26 +00002941
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002942void CGVtableInfo::MaybeEmitVtable(GlobalDecl GD) {
2943 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2944 const CXXRecordDecl *RD = MD->getParent();
2945
Anders Carlsson4ed44eb2009-12-05 22:42:54 +00002946 // If the class doesn't have a vtable we don't need to emit one.
2947 if (!RD->isDynamicClass())
2948 return;
2949
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002950 // Get the key function.
Anders Carlsson5ebf8b42009-12-07 04:35:11 +00002951 const CXXMethodDecl *KeyFunction = CGM.getContext().getKeyFunction(RD);
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002952
Anders Carlsson4ed44eb2009-12-05 22:42:54 +00002953 if (KeyFunction) {
2954 // We don't have the right key function.
2955 if (KeyFunction->getCanonicalDecl() != MD->getCanonicalDecl())
2956 return;
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002957 }
2958
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002959 // Emit the data.
Douglas Gregorccecc1b2010-01-06 20:27:16 +00002960 GenerateClassData(CGM.getVtableLinkage(RD), RD);
Eli Friedman8174f2c2009-12-06 22:01:30 +00002961
2962 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
2963 e = RD->method_end(); i != e; ++i) {
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002964 if ((*i)->isVirtual() && ((*i)->hasInlineBody() || (*i)->isImplicit())) {
Eli Friedman8174f2c2009-12-06 22:01:30 +00002965 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(*i)) {
2966 CGM.BuildThunksForVirtual(GlobalDecl(DD, Dtor_Complete));
2967 CGM.BuildThunksForVirtual(GlobalDecl(DD, Dtor_Deleting));
2968 } else {
2969 CGM.BuildThunksForVirtual(GlobalDecl(*i));
2970 }
2971 }
2972 }
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002973}
2974