blob: b9d6332b686c926d9b2aa382078087a355bff74f [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.
43 /// Or the offset from the virtual base class to the base class, if the path
44 /// from the derived class to the base class involves a virtual base class.
Anders Carlssoncce9ee82010-02-13 23:17:31 +000045 int64_t NonVirtualOffset;
Anders Carlssoneee53d92010-02-13 02:02:03 +000046
Anders Carlssoncf5a8822010-02-13 21:07:32 +000047 BaseOffset() : DerivedClass(0), VirtualBase(0), NonVirtualOffset(0) { }
48 BaseOffset(const CXXRecordDecl *DerivedClass,
Anders Carlssoncce9ee82010-02-13 23:17:31 +000049 const CXXRecordDecl *VirtualBase, int64_t NonVirtualOffset)
Anders Carlssoncf5a8822010-02-13 21:07:32 +000050 : DerivedClass(DerivedClass), VirtualBase(VirtualBase),
51 NonVirtualOffset(NonVirtualOffset) { }
Anders Carlssoneee53d92010-02-13 02:02:03 +000052
Benjamin Kramere047e112010-02-13 09:15:07 +000053 bool isEmpty() const { return !NonVirtualOffset && !VirtualBase; }
Anders Carlssoneee53d92010-02-13 02:02:03 +000054 };
55
Anders Carlsson136bd192010-02-12 16:55:34 +000056 /// OverriderInfo - Information about a final overrider.
57 struct OverriderInfo {
58 /// Method - The method decl of the overrider.
59 const CXXMethodDecl *Method;
60
Anders Carlssoneee53d92010-02-13 02:02:03 +000061 OverriderInfo() : Method(0) { }
Anders Carlsson136bd192010-02-12 16:55:34 +000062 };
63
64private:
Anders Carlssone8ac42a2010-02-11 21:24:32 +000065 /// MostDerivedClass - The most derived class for which the final overriders
66 /// are stored.
67 const CXXRecordDecl *MostDerivedClass;
68
69 ASTContext &Context;
70
71 /// MostDerivedClassLayout - the AST record layout of the most derived class.
72 const ASTRecordLayout &MostDerivedClassLayout;
73
Anders Carlssoneee53d92010-02-13 02:02:03 +000074 /// BaseSubobjectMethodPairTy - Uniquely identifies a member function
75 /// in a base subobject.
76 typedef std::pair<BaseSubobject, const CXXMethodDecl *>
77 BaseSubobjectMethodPairTy;
78
79 typedef llvm::DenseMap<BaseSubobjectMethodPairTy,
Anders Carlsson136bd192010-02-12 16:55:34 +000080 OverriderInfo> OverridersMapTy;
Anders Carlssone8ac42a2010-02-11 21:24:32 +000081
82 /// OverridersMap - The final overriders for all virtual member functions of
83 /// all the base subobjects of the most derived class.
84 OverridersMapTy OverridersMap;
85
Anders Carlsson6a7e6a42010-02-14 00:37:35 +000086 /// VisitedVirtualBases - A set of all the visited virtual bases, used to
87 /// avoid visiting virtual bases more than once.
88 llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBases;
89
Anders Carlssoneee53d92010-02-13 02:02:03 +000090 typedef llvm::DenseMap<BaseSubobjectMethodPairTy, BaseOffset>
91 AdjustmentOffsetsMapTy;
92
93 /// ReturnAdjustments - Holds return adjustments for all the overriders that
94 /// need to perform return value adjustments.
95 AdjustmentOffsetsMapTy ReturnAdjustments;
96
Anders Carlssoncce9ee82010-02-13 23:17:31 +000097 /// ThisAdjustments - Holds 'this' adjustments for all the overriders that
98 /// need them.
99 AdjustmentOffsetsMapTy ThisAdjustments;
100
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000101 typedef llvm::SmallVector<uint64_t, 1> OffsetVectorTy;
102
103 /// SubobjectOffsetsMapTy - This map is used for keeping track of all the
104 /// base subobject offsets that a single class declaration might refer to.
105 ///
106 /// For example, in:
107 ///
108 /// struct A { virtual void f(); };
109 /// struct B1 : A { };
110 /// struct B2 : A { };
111 /// struct C : B1, B2 { virtual void f(); };
112 ///
113 /// when we determine that C::f() overrides A::f(), we need to update the
114 /// overriders map for both A-in-B1 and A-in-B2 and the subobject offsets map
115 /// will have the subobject offsets for both A copies.
116 typedef llvm::DenseMap<const CXXRecordDecl *, OffsetVectorTy>
117 SubobjectOffsetsMapTy;
118
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000119 /// ComputeFinalOverriders - Compute the final overriders for a given base
120 /// subobject (and all its direct and indirect bases).
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000121 void ComputeFinalOverriders(BaseSubobject Base,
122 SubobjectOffsetsMapTy &Offsets);
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000123
124 /// AddOverriders - Add the final overriders for this base subobject to the
125 /// map of final overriders.
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000126 void AddOverriders(BaseSubobject Base, SubobjectOffsetsMapTy &Offsets);
127
128 /// PropagateOverrider - Propagate the NewMD overrider to all the functions
129 /// that OldMD overrides. For example, if we have:
130 ///
131 /// struct A { virtual void f(); };
132 /// struct B : A { virtual void f(); };
133 /// struct C : B { virtual void f(); };
134 ///
135 /// and we want to override B::f with C::f, we also need to override A::f with
136 /// C::f.
137 void PropagateOverrider(const CXXMethodDecl *OldMD,
Anders Carlssona678aa12010-02-13 22:23:31 +0000138 BaseSubobject NewBase,
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000139 const CXXMethodDecl *NewMD,
140 SubobjectOffsetsMapTy &Offsets);
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000141
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000142 /// ComputeThisAdjustmentBaseOffset - Compute the base offset for adjusting
Anders Carlsson258a1e32010-02-14 00:16:19 +0000143 /// the 'this' pointer from the base subobject to the derived subobject.
Anders Carlsson073a0c82010-02-14 00:44:19 +0000144 BaseOffset ComputeThisAdjustmentBaseOffset(BaseSubobject Base,
Anders Carlsson258a1e32010-02-14 00:16:19 +0000145 BaseSubobject Derived);
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000146
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000147 static void MergeSubobjectOffsets(const SubobjectOffsetsMapTy &NewOffsets,
148 SubobjectOffsetsMapTy &Offsets);
149
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000150public:
151 explicit FinalOverriders(const CXXRecordDecl *MostDerivedClass);
152
153 /// getOverrider - Get the final overrider for the given method declaration in
154 /// the given base subobject.
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000155 OverriderInfo getOverrider(BaseSubobject Base,
156 const CXXMethodDecl *MD) const {
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000157 assert(OverridersMap.count(std::make_pair(Base, MD)) &&
158 "Did not find overrider!");
159
160 return OverridersMap.lookup(std::make_pair(Base, MD));
161 }
162
Anders Carlssond3adb0c2010-02-13 23:40:17 +0000163 /// getReturnAdjustmentOffset - Get the return adjustment offset for the
164 /// method decl in the given base subobject. Returns an empty base offset if
165 /// no adjustment is needed.
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000166 BaseOffset getReturnAdjustmentOffset(BaseSubobject Base,
167 const CXXMethodDecl *MD) const {
168 return ReturnAdjustments.lookup(std::make_pair(Base, MD));
169 }
170
Anders Carlssond3adb0c2010-02-13 23:40:17 +0000171 /// getThisAdjustmentOffset - Get the 'this' pointer adjustment offset for the
172 /// method decl in the given base subobject. Returns an empty base offset if
173 /// no adjustment is needed.
174 BaseOffset getThisAdjustmentOffset(BaseSubobject Base,
175 const CXXMethodDecl *MD) const {
176 return ThisAdjustments.lookup(std::make_pair(Base, MD));
177 }
178
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000179 /// dump - dump the final overriders.
Anders Carlsson6a7e6a42010-02-14 00:37:35 +0000180 void dump() {
181 assert(VisitedVirtualBases.empty() &&
182 "Visited virtual bases aren't empty!");
183 dump(llvm::errs(), BaseSubobject(MostDerivedClass, 0));
184 VisitedVirtualBases.clear();
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000185 }
186
187 /// dump - dump the final overriders for a base subobject, and all its direct
188 /// and indirect base subobjects.
Anders Carlsson6a7e6a42010-02-14 00:37:35 +0000189 void dump(llvm::raw_ostream &Out, BaseSubobject Base);
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000190};
Anders Carlssoneee53d92010-02-13 02:02:03 +0000191
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000192FinalOverriders::FinalOverriders(const CXXRecordDecl *MostDerivedClass)
193 : MostDerivedClass(MostDerivedClass),
194 Context(MostDerivedClass->getASTContext()),
195 MostDerivedClassLayout(Context.getASTRecordLayout(MostDerivedClass)) {
196
197 // Compute the final overriders.
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000198 SubobjectOffsetsMapTy Offsets;
199 ComputeFinalOverriders(BaseSubobject(MostDerivedClass, 0), Offsets);
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000200
201 // And dump them (for now).
202 dump();
Anders Carlsson3f9917d2010-02-13 21:33:22 +0000203
204 // Also dump the base offsets (for now).
205 for (SubobjectOffsetsMapTy::const_iterator I = Offsets.begin(),
206 E = Offsets.end(); I != E; ++I) {
207 const OffsetVectorTy& OffsetVector = I->second;
208
209 llvm::errs() << "Base offsets for ";
210 llvm::errs() << I->first->getQualifiedNameAsString() << '\n';
211
212 for (unsigned I = 0, E = OffsetVector.size(); I != E; ++I)
213 llvm::errs() << " " << I << " - " << OffsetVector[I] << '\n';
214 }
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000215}
216
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000217void FinalOverriders::AddOverriders(BaseSubobject Base,
218 SubobjectOffsetsMapTy &Offsets) {
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000219 const CXXRecordDecl *RD = Base.getBase();
220
221 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
222 E = RD->method_end(); I != E; ++I) {
223 const CXXMethodDecl *MD = *I;
224
225 if (!MD->isVirtual())
226 continue;
227
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000228 // First, propagate the overrider.
Anders Carlssona678aa12010-02-13 22:23:31 +0000229 PropagateOverrider(MD, Base, MD, Offsets);
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000230
231 // Add the overrider as the final overrider of itself.
Anders Carlsson136bd192010-02-12 16:55:34 +0000232 OverriderInfo& Overrider = OverridersMap[std::make_pair(Base, MD)];
233 assert(!Overrider.Method && "Overrider should not exist yet!");
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000234
Anders Carlsson136bd192010-02-12 16:55:34 +0000235 Overrider.Method = MD;
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000236 }
237}
238
Anders Carlsson258a1e32010-02-14 00:16:19 +0000239static FinalOverriders::BaseOffset
240ComputeBaseOffset(ASTContext &Context, const CXXRecordDecl *DerivedRD,
241 const CXXBasePath &Path) {
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000242 int64_t NonVirtualOffset = 0;
Anders Carlssoneee53d92010-02-13 02:02:03 +0000243
Anders Carlssonf3f67842010-02-13 20:41:15 +0000244 unsigned NonVirtualStart = 0;
245 const CXXRecordDecl *VirtualBase = 0;
246
247 // First, look for the virtual base class.
248 for (unsigned I = 0, E = Path.size(); I != E; ++I) {
249 const CXXBasePathElement &Element = Path[I];
250
251 if (Element.Base->isVirtual()) {
252 // FIXME: Can we break when we find the first virtual base?
253 // (If we can't, can't we just iterate over the path in reverse order?)
254 NonVirtualStart = I + 1;
255 QualType VBaseType = Element.Base->getType();
256 VirtualBase =
257 cast<CXXRecordDecl>(VBaseType->getAs<RecordType>()->getDecl());
258 }
259 }
260
261 // Now compute the non-virtual offset.
262 for (unsigned I = NonVirtualStart, E = Path.size(); I != E; ++I) {
263 const CXXBasePathElement &Element = Path[I];
Anders Carlssoneee53d92010-02-13 02:02:03 +0000264
265 // Check the base class offset.
266 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Element.Class);
267
268 const RecordType *BaseType = Element.Base->getType()->getAs<RecordType>();
269 const CXXRecordDecl *Base = cast<CXXRecordDecl>(BaseType->getDecl());
270
271 NonVirtualOffset += Layout.getBaseClassOffset(Base);
272 }
273
274 // FIXME: This should probably use CharUnits or something. Maybe we should
275 // even change the base offsets in ASTRecordLayout to be specified in
276 // CharUnits.
Anders Carlssoncf5a8822010-02-13 21:07:32 +0000277 return FinalOverriders::BaseOffset(DerivedRD, VirtualBase,
278 NonVirtualOffset / 8);
Anders Carlsson258a1e32010-02-14 00:16:19 +0000279
280}
281
282static FinalOverriders::BaseOffset
283ComputeBaseOffset(ASTContext &Context, const CXXRecordDecl *BaseRD,
284 const CXXRecordDecl *DerivedRD) {
285 CXXBasePaths Paths(/*FindAmbiguities=*/false,
286 /*RecordPaths=*/true, /*DetectVirtual=*/false);
287
288 if (!const_cast<CXXRecordDecl *>(DerivedRD)->
289 isDerivedFrom(const_cast<CXXRecordDecl *>(BaseRD), Paths)) {
290 assert(false && "Class must be derived from the passed in base class!");
291 return FinalOverriders::BaseOffset();
292 }
293
294 return ComputeBaseOffset(Context, DerivedRD, Paths.front());
Anders Carlssoneee53d92010-02-13 02:02:03 +0000295}
296
297static FinalOverriders::BaseOffset
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000298ComputeReturnAdjustmentBaseOffset(ASTContext &Context,
299 const CXXMethodDecl *DerivedMD,
300 const CXXMethodDecl *BaseMD) {
Anders Carlssoneee53d92010-02-13 02:02:03 +0000301 const FunctionType *BaseFT = BaseMD->getType()->getAs<FunctionType>();
302 const FunctionType *DerivedFT = DerivedMD->getType()->getAs<FunctionType>();
303
304 // Canonicalize the return types.
305 CanQualType CanDerivedReturnType =
306 Context.getCanonicalType(DerivedFT->getResultType());
307 CanQualType CanBaseReturnType =
308 Context.getCanonicalType(BaseFT->getResultType());
309
310 assert(CanDerivedReturnType->getTypeClass() ==
311 CanBaseReturnType->getTypeClass() &&
312 "Types must have same type class!");
313
314 if (CanDerivedReturnType == CanBaseReturnType) {
315 // No adjustment needed.
316 return FinalOverriders::BaseOffset();
317 }
318
319 if (isa<ReferenceType>(CanDerivedReturnType)) {
320 CanDerivedReturnType =
321 CanDerivedReturnType->getAs<ReferenceType>()->getPointeeType();
322 CanBaseReturnType =
323 CanBaseReturnType->getAs<ReferenceType>()->getPointeeType();
324 } else if (isa<PointerType>(CanDerivedReturnType)) {
325 CanDerivedReturnType =
326 CanDerivedReturnType->getAs<PointerType>()->getPointeeType();
327 CanBaseReturnType =
328 CanBaseReturnType->getAs<PointerType>()->getPointeeType();
329 } else {
330 assert(false && "Unexpected return type!");
331 }
332
333 // We need to compare unqualified types here; consider
334 // const T *Base::foo();
335 // T *Derived::foo();
336 if (CanDerivedReturnType.getUnqualifiedType() ==
337 CanBaseReturnType.getUnqualifiedType()) {
338 // No adjustment needed.
339 return FinalOverriders::BaseOffset();
340 }
341
342 const CXXRecordDecl *DerivedRD =
343 cast<CXXRecordDecl>(cast<RecordType>(CanDerivedReturnType)->getDecl());
344
345 const CXXRecordDecl *BaseRD =
346 cast<CXXRecordDecl>(cast<RecordType>(CanBaseReturnType)->getDecl());
347
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000348 return ComputeBaseOffset(Context, BaseRD, DerivedRD);
Anders Carlssoneee53d92010-02-13 02:02:03 +0000349}
350
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000351FinalOverriders::BaseOffset
Anders Carlsson258a1e32010-02-14 00:16:19 +0000352FinalOverriders::ComputeThisAdjustmentBaseOffset(BaseSubobject Base,
353 BaseSubobject Derived) {
354 const CXXRecordDecl *BaseRD = Base.getBase();
355 const CXXRecordDecl *DerivedRD = Derived.getBase();
356
357 CXXBasePaths Paths(/*FindAmbiguities=*/true,
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000358 /*RecordPaths=*/true, /*DetectVirtual=*/true);
359
360 if (!const_cast<CXXRecordDecl *>(DerivedRD)->
361 isDerivedFrom(const_cast<CXXRecordDecl *>(BaseRD), Paths)) {
362 assert(false && "Class must be derived from the passed in base class!");
363 return FinalOverriders::BaseOffset();
364 }
365
366 assert(!Paths.getDetectedVirtual() && "FIXME: Handle virtual bases!");
367
Anders Carlsson258a1e32010-02-14 00:16:19 +0000368 BaseOffset Offset;
369
370 // FIXME: This is not going to be enough with virtual bases.
371 // FIXME: We should not use / 8 here.
372 int64_t DerivedToBaseOffset =
373 (Base.getBaseOffset() - Derived.getBaseOffset()) / 8;
374
375 Offset.NonVirtualOffset = -DerivedToBaseOffset;
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000376
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000377 return Offset;
378}
379
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000380void FinalOverriders::PropagateOverrider(const CXXMethodDecl *OldMD,
Anders Carlssona678aa12010-02-13 22:23:31 +0000381 BaseSubobject NewBase,
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000382 const CXXMethodDecl *NewMD,
383 SubobjectOffsetsMapTy &Offsets) {
384 for (CXXMethodDecl::method_iterator I = OldMD->begin_overridden_methods(),
385 E = OldMD->end_overridden_methods(); I != E; ++I) {
386 const CXXMethodDecl *OverriddenMD = *I;
387 const CXXRecordDecl *OverriddenRD = OverriddenMD->getParent();
388
389 // We want to override OverriddenMD in all subobjects, for example:
390 //
391 /// struct A { virtual void f(); };
392 /// struct B1 : A { };
393 /// struct B2 : A { };
394 /// struct C : B1, B2 { virtual void f(); };
395 ///
396 /// When overriding A::f with C::f we need to do so in both A subobjects.
397 const OffsetVectorTy &OffsetVector = Offsets[OverriddenRD];
398
399 // Go through all the subobjects.
400 for (unsigned I = 0, E = OffsetVector.size(); I != E; ++I) {
401 uint64_t Offset = OffsetVector[I];
402
Anders Carlsson258a1e32010-02-14 00:16:19 +0000403 BaseSubobject OverriddenSubobject = BaseSubobject(OverriddenRD, Offset);
Anders Carlssoneee53d92010-02-13 02:02:03 +0000404 BaseSubobjectMethodPairTy SubobjectAndMethod =
Anders Carlsson258a1e32010-02-14 00:16:19 +0000405 std::make_pair(OverriddenSubobject, OverriddenMD);
Anders Carlssoneee53d92010-02-13 02:02:03 +0000406
407 OverriderInfo &Overrider = OverridersMap[SubobjectAndMethod];
408
Anders Carlsson136bd192010-02-12 16:55:34 +0000409 assert(Overrider.Method && "Did not find existing overrider!");
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000410
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000411 // Check if we need return adjustments or base adjustments.
Anders Carlssonc1290ad2010-02-13 21:16:54 +0000412 // (We don't want to do this for pure virtual member functions).
413 if (!NewMD->isPure()) {
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000414 // Get the return adjustment base offset.
Anders Carlssonc1290ad2010-02-13 21:16:54 +0000415 BaseOffset ReturnBaseOffset =
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000416 ComputeReturnAdjustmentBaseOffset(Context, NewMD, OverriddenMD);
417
Anders Carlssonc1290ad2010-02-13 21:16:54 +0000418 if (!ReturnBaseOffset.isEmpty()) {
419 // Store the return adjustment base offset.
420 ReturnAdjustments[SubobjectAndMethod] = ReturnBaseOffset;
421 }
Anders Carlssona678aa12010-02-13 22:23:31 +0000422
423 // Check if we need a 'this' adjustment base offset as well.
424 if (Offset != NewBase.getBaseOffset()) {
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000425 BaseOffset ThisBaseOffset =
Anders Carlsson258a1e32010-02-14 00:16:19 +0000426 ComputeThisAdjustmentBaseOffset(OverriddenSubobject,
427 NewBase);
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000428 assert(!ThisBaseOffset.isEmpty() &&
429 "Should not get an empty 'this' adjustment!");
430
431 ThisAdjustments[SubobjectAndMethod] = ThisBaseOffset;
Anders Carlssona678aa12010-02-13 22:23:31 +0000432 }
Anders Carlsson8e661e12010-02-12 17:13:23 +0000433 }
434
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000435 // Set the new overrider.
Anders Carlsson136bd192010-02-12 16:55:34 +0000436 Overrider.Method = NewMD;
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000437
438 // And propagate it further.
Anders Carlssona678aa12010-02-13 22:23:31 +0000439 PropagateOverrider(OverriddenMD, NewBase, NewMD, Offsets);
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000440 }
441 }
442}
443
444void
445FinalOverriders::MergeSubobjectOffsets(const SubobjectOffsetsMapTy &NewOffsets,
446 SubobjectOffsetsMapTy &Offsets) {
447 // Iterate over the new offsets.
448 for (SubobjectOffsetsMapTy::const_iterator I = NewOffsets.begin(),
449 E = NewOffsets.end(); I != E; ++I) {
450 const CXXRecordDecl *NewRD = I->first;
Anders Carlsson3f9917d2010-02-13 21:33:22 +0000451 const OffsetVectorTy& NewOffsetVector = I->second;
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000452
Anders Carlsson3f9917d2010-02-13 21:33:22 +0000453 OffsetVectorTy &OffsetVector = Offsets[NewRD];
454 if (OffsetVector.empty()) {
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000455 // There were no previous offsets in this vector, just insert all entries
Anders Carlsson3f9917d2010-02-13 21:33:22 +0000456 // from the new offset vector.
457 OffsetVector.append(NewOffsetVector.begin(), NewOffsetVector.end());
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000458 continue;
459 }
460
Anders Carlsson3f9917d2010-02-13 21:33:22 +0000461 // We need to merge the new offsets vector into the old, but we don't want
462 // to have duplicate entries. Do this by inserting the old offsets in a set
463 // so they'll be unique. After this, we iterate over the new offset vector
464 // and only append elements that aren't in the set.
465
466 // First, add the existing offsets to the set.
467 llvm::SmallSet<uint64_t, 4> OffsetSet;
468 for (unsigned I = 0, E = OffsetVector.size(); I != E; ++I) {
469 bool Inserted = OffsetSet.insert(OffsetVector[I]);
470 if (!Inserted)
471 assert(false && "Set of offsets should be unique!");
472 }
473
474 // Next, only add the new offsets if they are not already in the set.
475 for (unsigned I = 0, E = NewOffsetVector.size(); I != E; ++I) {
476 uint64_t Offset = NewOffsetVector[I];
477
478 if (OffsetSet.count(Offset)) {
479 // Ignore the offset.
480 continue;
481 }
482
483 // Otherwise, add it to the offsets vector.
484 OffsetVector.push_back(Offset);
485 }
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000486 }
487}
488
489void FinalOverriders::ComputeFinalOverriders(BaseSubobject Base,
490 SubobjectOffsetsMapTy &Offsets) {
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000491 const CXXRecordDecl *RD = Base.getBase();
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000492 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000493
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000494 SubobjectOffsetsMapTy NewOffsets;
495
496 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
497 E = RD->bases_end(); I != E; ++I) {
498 const CXXRecordDecl *BaseDecl =
499 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
500
Anders Carlsson033d4862010-02-14 17:05:59 +0000501 // Ignore bases that don't have any virtual member functions.
502 if (!BaseDecl->isPolymorphic())
503 continue;
504
Anders Carlsson6a7e6a42010-02-14 00:37:35 +0000505 uint64_t BaseOffset;
506 if (I->isVirtual()) {
507 BaseOffset = MostDerivedClassLayout.getVBaseClassOffset(BaseDecl);
508 } else {
509 BaseOffset = Layout.getBaseClassOffset(BaseDecl) + Base.getBaseOffset();
510 }
511
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000512 // Compute the final overriders for this base.
513 ComputeFinalOverriders(BaseSubobject(BaseDecl, BaseOffset), NewOffsets);
514 }
515
516 /// Now add the overriders for this particular subobject.
517 AddOverriders(Base, NewOffsets);
518
519 // And merge the newly discovered subobject offsets.
520 MergeSubobjectOffsets(NewOffsets, Offsets);
521
522 /// Finally, add the offset for our own subobject.
523 Offsets[RD].push_back(Base.getBaseOffset());
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000524}
525
Anders Carlsson6a7e6a42010-02-14 00:37:35 +0000526void FinalOverriders::dump(llvm::raw_ostream &Out, BaseSubobject Base) {
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000527 const CXXRecordDecl *RD = Base.getBase();
528 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
529
530 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
531 E = RD->bases_end(); I != E; ++I) {
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000532 const CXXRecordDecl *BaseDecl =
533 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
534
Anders Carlsson033d4862010-02-14 17:05:59 +0000535 // Ignore bases that don't have any virtual member functions.
536 if (!BaseDecl->isPolymorphic())
537 continue;
538
Anders Carlsson6a7e6a42010-02-14 00:37:35 +0000539 uint64_t BaseOffset;
540 if (I->isVirtual()) {
541 if (!VisitedVirtualBases.insert(BaseDecl)) {
542 // We've visited this base before.
543 continue;
544 }
545
546 BaseOffset = MostDerivedClassLayout.getVBaseClassOffset(BaseDecl);
547 } else {
548 BaseOffset = Layout.getBaseClassOffset(BaseDecl) +
549 Base.getBaseOffset();
550 }
551
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000552 dump(Out, BaseSubobject(BaseDecl, BaseOffset));
553 }
554
555 Out << "Final overriders for (" << RD->getQualifiedNameAsString() << ", ";
556 Out << Base.getBaseOffset() << ")\n";
557
558 // Now dump the overriders for this base subobject.
559 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
560 E = RD->method_end(); I != E; ++I) {
561 const CXXMethodDecl *MD = *I;
562
563 if (!MD->isVirtual())
564 continue;
565
Anders Carlsson136bd192010-02-12 16:55:34 +0000566 OverriderInfo Overrider = getOverrider(Base, MD);
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000567
568 Out << " " << MD->getQualifiedNameAsString() << " - ";
Anders Carlsson8e661e12010-02-12 17:13:23 +0000569 Out << Overrider.Method->getQualifiedNameAsString();
Anders Carlssoneee53d92010-02-13 02:02:03 +0000570
Benjamin Kramer02c67372010-02-13 09:11:28 +0000571 AdjustmentOffsetsMapTy::const_iterator AI =
Anders Carlssoneee53d92010-02-13 02:02:03 +0000572 ReturnAdjustments.find(std::make_pair(Base, MD));
Benjamin Kramer02c67372010-02-13 09:11:28 +0000573 if (AI != ReturnAdjustments.end()) {
574 const BaseOffset &Offset = AI->second;
Anders Carlssonf3f67842010-02-13 20:41:15 +0000575
576 Out << " [ret-adj: ";
577 if (Offset.VirtualBase)
578 Out << Offset.VirtualBase->getQualifiedNameAsString() << " vbase, ";
Anders Carlssoneee53d92010-02-13 02:02:03 +0000579
Anders Carlssonf3f67842010-02-13 20:41:15 +0000580 Out << Offset.NonVirtualOffset << " nv]";
Anders Carlssoneee53d92010-02-13 02:02:03 +0000581 }
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000582
583 AI = ThisAdjustments.find(std::make_pair(Base, MD));
584 if (AI != ThisAdjustments.end()) {
585 const BaseOffset &Offset = AI->second;
586
587 Out << " [this-adj: ";
588 if (Offset.VirtualBase)
589 Out << Offset.VirtualBase->getQualifiedNameAsString() << " vbase, ";
590
591 Out << Offset.NonVirtualOffset << " nv]";
592 }
593
Anders Carlsson8e661e12010-02-12 17:13:23 +0000594 Out << "\n";
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000595 }
596}
597
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000598/// VtableComponent - Represents a single component in a vtable.
599class VtableComponent {
600public:
601 enum Kind {
602 CK_VCallOffset,
603 CK_VBaseOffset,
604 CK_OffsetToTop,
605 CK_RTTI,
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000606 CK_FunctionPointer,
607
608 /// CK_CompleteDtorPointer - A pointer to the complete destructor.
609 CK_CompleteDtorPointer,
610
611 /// CK_DeletingDtorPointer - A pointer to the deleting destructor.
612 CK_DeletingDtorPointer
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000613 };
614
Anders Carlssondc2dba32010-02-16 04:49:44 +0000615 static VtableComponent MakeVBaseOffset(int64_t Offset) {
616 return VtableComponent(CK_VBaseOffset, Offset);
617 }
618
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000619 static VtableComponent MakeOffsetToTop(int64_t Offset) {
620 return VtableComponent(CK_OffsetToTop, Offset);
621 }
622
623 static VtableComponent MakeRTTI(const CXXRecordDecl *RD) {
624 return VtableComponent(CK_RTTI, reinterpret_cast<uintptr_t>(RD));
625 }
626
627 static VtableComponent MakeFunction(const CXXMethodDecl *MD) {
628 assert(!isa<CXXDestructorDecl>(MD) &&
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000629 "Don't use MakeFunction with destructors!");
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000630
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000631 return VtableComponent(CK_FunctionPointer,
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000632 reinterpret_cast<uintptr_t>(MD));
633 }
634
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000635 static VtableComponent MakeCompleteDtor(const CXXDestructorDecl *DD) {
636 return VtableComponent(CK_CompleteDtorPointer,
637 reinterpret_cast<uintptr_t>(DD));
638 }
639
640 static VtableComponent MakeDeletingDtor(const CXXDestructorDecl *DD) {
641 return VtableComponent(CK_DeletingDtorPointer,
642 reinterpret_cast<uintptr_t>(DD));
643 }
644
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000645 /// getKind - Get the kind of this vtable component.
646 Kind getKind() const {
647 return (Kind)(Value & 0x7);
648 }
649
Anders Carlssondc2dba32010-02-16 04:49:44 +0000650 int64_t getVBaseOffset() const {
651 assert(getKind() == CK_VBaseOffset && "Invalid component kind!");
652
653 return getOffset();
654 }
655
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000656 int64_t getOffsetToTop() const {
657 assert(getKind() == CK_OffsetToTop && "Invalid component kind!");
658
659 return getOffset();
660 }
661
662 const CXXRecordDecl *getRTTIDecl() const {
663 assert(getKind() == CK_RTTI && "Invalid component kind!");
664
665 return reinterpret_cast<CXXRecordDecl *>(getPointer());
666 }
667
668 const CXXMethodDecl *getFunctionDecl() const {
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000669 assert(getKind() == CK_FunctionPointer);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000670
671 return reinterpret_cast<CXXMethodDecl *>(getPointer());
672 }
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000673
674 const CXXDestructorDecl *getDestructorDecl() const {
675 assert((getKind() == CK_CompleteDtorPointer ||
676 getKind() == CK_DeletingDtorPointer) && "Invalid component kind!");
677
678 return reinterpret_cast<CXXDestructorDecl *>(getPointer());
679 }
680
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000681private:
682 VtableComponent(Kind ComponentKind, int64_t Offset) {
683 assert((ComponentKind == CK_VCallOffset ||
684 ComponentKind == CK_VBaseOffset ||
685 ComponentKind == CK_OffsetToTop) && "Invalid component kind!");
686 assert(Offset <= ((1LL << 56) - 1) && "Offset is too big!");
687
688 Value = ((Offset << 3) | ComponentKind);
689 }
690
691 VtableComponent(Kind ComponentKind, uintptr_t Ptr) {
692 assert((ComponentKind == CK_RTTI ||
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000693 ComponentKind == CK_FunctionPointer ||
694 ComponentKind == CK_CompleteDtorPointer ||
695 ComponentKind == CK_DeletingDtorPointer) &&
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000696 "Invalid component kind!");
697
698 assert((Ptr & 7) == 0 && "Pointer not sufficiently aligned!");
699
700 Value = Ptr | ComponentKind;
701 }
702
703 int64_t getOffset() const {
704 assert((getKind() == CK_VCallOffset || getKind() == CK_VBaseOffset ||
705 getKind() == CK_OffsetToTop) && "Invalid component kind!");
706
707 return Value >> 3;
708 }
709
710 uintptr_t getPointer() const {
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000711 assert((getKind() == CK_RTTI ||
712 getKind() == CK_FunctionPointer ||
713 getKind() == CK_CompleteDtorPointer ||
714 getKind() == CK_DeletingDtorPointer) &&
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000715 "Invalid component kind!");
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000716
717 return static_cast<uintptr_t>(Value & ~7ULL);
718 }
719
720 /// The kind is stored in the lower 3 bits of the value. For offsets, we
721 /// make use of the facts that classes can't be larger than 2^55 bytes,
722 /// so we store the offset in the lower part of the 61 bytes that remain.
723 /// (The reason that we're not simply using a PointerIntPair here is that we
724 /// need the offsets to be 64-bit, even when on a 32-bit machine).
725 int64_t Value;
726};
727
728/// VtableBuilder - Class for building vtable layout information.
Benjamin Kramer337e3a52009-11-28 19:45:26 +0000729class VtableBuilder {
Anders Carlsson65b49782010-02-12 05:25:12 +0000730public:
731 /// PrimaryBasesSetTy - A set of direct and indirect primary bases.
732 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 8> PrimaryBasesSetTy;
733
734private:
Anders Carlssoncf5a8822010-02-13 21:07:32 +0000735 /// VtableInfo - Global vtable information.
736 CGVtableInfo &VtableInfo;
737
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000738 /// MostDerivedClass - The most derived class for which we're building this
739 /// vtable.
740 const CXXRecordDecl *MostDerivedClass;
741
742 /// Context - The ASTContext which we will use for layout information.
Anders Carlsson65b49782010-02-12 05:25:12 +0000743 ASTContext &Context;
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000744
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000745 /// FinalOverriders - The final overriders of the most derived class.
746 FinalOverriders Overriders;
747
Anders Carlssondc2dba32010-02-16 04:49:44 +0000748 /// VCallAndVBaseOffsets - The vcall and vbase offset, of the vtable we're
749 // building (in reverse order).
750 llvm::SmallVector<VtableComponent, 64> VCallAndVBaseOffsets;
751
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000752 /// Components - The components of the vtable being built.
753 llvm::SmallVector<VtableComponent, 64> Components;
754
Anders Carlsson932c2f22010-02-11 17:18:51 +0000755 /// AddressPoints - Address points for the vtable being built.
756 CGVtableInfo::AddressPointsMapTy AddressPoints;
757
Anders Carlssond3adb0c2010-02-13 23:40:17 +0000758 /// ReturnAdjustment - A return adjustment.
Anders Carlsson5272c252010-02-12 17:37:14 +0000759 struct ReturnAdjustment {
760 /// NonVirtual - The non-virtual adjustment from the derived object to its
761 /// nearest virtual base.
762 int64_t NonVirtual;
763
Anders Carlssoncf5a8822010-02-13 21:07:32 +0000764 /// VBaseOffsetOffset - The offset, in bytes, relative to the address point
765 /// of the virtual base class offset.
766 int64_t VBaseOffsetOffset;
Anders Carlsson5272c252010-02-12 17:37:14 +0000767
Anders Carlssoncf5a8822010-02-13 21:07:32 +0000768 ReturnAdjustment() : NonVirtual(0), VBaseOffsetOffset(0) { }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000769
Anders Carlssoncf5a8822010-02-13 21:07:32 +0000770 bool isEmpty() const { return !NonVirtual && !VBaseOffsetOffset; }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000771 };
772
773 /// ReturnAdjustments - The return adjustments needed in this vtable.
774 llvm::SmallVector<std::pair<uint64_t, ReturnAdjustment>, 16>
775 ReturnAdjustments;
776
Anders Carlssond3adb0c2010-02-13 23:40:17 +0000777 /// ThisAdjustment - A 'this' pointer adjustment thunk.
778 struct ThisAdjustment {
779 /// NonVirtual - The non-virtual adjustment from the derived object to its
780 /// nearest virtual base.
781 int64_t NonVirtual;
782
783 /// FIXME: Add VCallOffsetOffset here.
784
785 ThisAdjustment() : NonVirtual(0) { }
786
787 bool isEmpty() const { return !NonVirtual; }
788 };
789
790 /// ThisAdjustments - The 'this' pointer adjustments needed in this vtable.
791 llvm::SmallVector<std::pair<uint64_t, ThisAdjustment>, 16>
792 ThisAdjustments;
793
Anders Carlssondc2dba32010-02-16 04:49:44 +0000794 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
795
796 /// AddVCallAndVBaseOffsets - Add vcall offsets and vbase offsets for the
797 /// given class.
798 void AddVCallAndVBaseOffsets(const CXXRecordDecl *RD, int64_t OffsetToTop,
799 VisitedVirtualBasesSetTy &VBases);
800
801 /// AddVBaseOffsets - Add vbase offsets for the given class.
802 void AddVBaseOffsets(const CXXRecordDecl *RD, int64_t OffsetToTop,
803 VisitedVirtualBasesSetTy &VBases);
804
Anders Carlssoncf5a8822010-02-13 21:07:32 +0000805 /// ComputeReturnAdjustment - Compute the return adjustment given a return
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000806 /// adjustment base offset.
807 ReturnAdjustment ComputeReturnAdjustment(FinalOverriders::BaseOffset Offset);
808
Anders Carlssond3adb0c2010-02-13 23:40:17 +0000809 /// ComputeThisAdjustment - Compute the 'this' pointer adjustment given a
810 /// 'this' pointer adjustment base offset.
811 ThisAdjustment ComputeThisAdjustment(FinalOverriders::BaseOffset Offset);
812
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000813 /// AddMethod - Add a single virtual member function to the vtable
814 /// components vector.
Anders Carlssond3adb0c2010-02-13 23:40:17 +0000815 void AddMethod(const CXXMethodDecl *MD, ReturnAdjustment ReturnAdjustment,
816 ThisAdjustment ThisAdjustment);
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000817
818 /// AddMethods - Add the methods of this base subobject and all its
819 /// primary bases to the vtable components vector.
820 void AddMethods(BaseSubobject Base, PrimaryBasesSetTy &PrimaryBases);
Anders Carlssonb716a542010-02-16 16:26:28 +0000821
822 // LayoutVtable - Layout the vtable for the most derived class, including its
823 // secondary vtables and any vtables for virtual bases.
824 void LayoutVtable();
825
826 /// LayoutPrimaryAndAndSecondaryVtables - Layout the primary vtable for the
827 /// given base subobject, as well as all its secondary vtables.
828 void LayoutPrimaryAndAndSecondaryVtables(BaseSubobject Base);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000829
Anders Carlsson14157932010-02-16 16:02:57 +0000830 /// LayoutSecondaryVtables - Layout the secondary vtables for the given base
831 /// subobject.
832 void LayoutSecondaryVtables(BaseSubobject Base);
833
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000834public:
Anders Carlssoncf5a8822010-02-13 21:07:32 +0000835 VtableBuilder(CGVtableInfo &VtableInfo, const CXXRecordDecl *MostDerivedClass)
836 : VtableInfo(VtableInfo), MostDerivedClass(MostDerivedClass),
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000837 Context(MostDerivedClass->getASTContext()), Overriders(MostDerivedClass) {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000838
Anders Carlssonb716a542010-02-16 16:26:28 +0000839 LayoutVtable();
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000840 }
841
842 /// dumpLayout - Dump the vtable layout.
843 void dumpLayout(llvm::raw_ostream&);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000844};
845
Anders Carlsson65b49782010-02-12 05:25:12 +0000846/// OverridesMethodInPrimaryBase - Checks whether whether this virtual member
847/// function overrides a member function in a direct or indirect primary base.
848/// Returns the overridden member function, or null if none was found.
849static const CXXMethodDecl *
850OverridesMethodInPrimaryBase(const CXXMethodDecl *MD,
851 VtableBuilder::PrimaryBasesSetTy &PrimaryBases) {
852 for (CXXMethodDecl::method_iterator I = MD->begin_overridden_methods(),
853 E = MD->end_overridden_methods(); I != E; ++I) {
854 const CXXMethodDecl *OverriddenMD = *I;
855 const CXXRecordDecl *OverriddenRD = OverriddenMD->getParent();
856 assert(OverriddenMD->isCanonicalDecl() &&
857 "Should have the canonical decl of the overridden RD!");
858
859 if (PrimaryBases.count(OverriddenRD))
860 return OverriddenMD;
861 }
862
863 return 0;
864}
865
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000866VtableBuilder::ReturnAdjustment
867VtableBuilder::ComputeReturnAdjustment(FinalOverriders::BaseOffset Offset) {
868 ReturnAdjustment Adjustment;
869
870 if (!Offset.isEmpty()) {
Anders Carlssoncf5a8822010-02-13 21:07:32 +0000871 if (Offset.VirtualBase) {
872 // Get the virtual base offset offset.
873 Adjustment.VBaseOffsetOffset =
874 VtableInfo.getVirtualBaseOffsetIndex(Offset.DerivedClass,
875 Offset.VirtualBase);
876 // FIXME: Once the assert in getVirtualBaseOffsetIndex is back again,
877 // we can get rid of this assert.
878 assert(Adjustment.VBaseOffsetOffset != 0 &&
879 "Invalid base offset offset!");
880 }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000881
882 Adjustment.NonVirtual = Offset.NonVirtualOffset;
883 }
884
885 return Adjustment;
886}
887
Anders Carlssond3adb0c2010-02-13 23:40:17 +0000888VtableBuilder::ThisAdjustment
889VtableBuilder::ComputeThisAdjustment(FinalOverriders::BaseOffset Offset) {
890 ThisAdjustment Adjustment;
891
892 if (!Offset.isEmpty()) {
893 assert(!Offset.VirtualBase && "FIXME: Handle virtual bases!");
894 Adjustment.NonVirtual = Offset.NonVirtualOffset;
895 }
896
897 return Adjustment;
898}
899
Anders Carlsson65b49782010-02-12 05:25:12 +0000900void
Anders Carlssondc2dba32010-02-16 04:49:44 +0000901VtableBuilder::AddVCallAndVBaseOffsets(const CXXRecordDecl *RD,
902 int64_t OffsetToTop,
903 VisitedVirtualBasesSetTy &VBases) {
904 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
905
906 // Itanium C++ ABI 2.5.2:
907 // ..in classes sharing a virtual table with a primary base class, the vcall
908 // and vbase offsets added by the derived class all come before the vcall
909 // and vbase offsets required by the base class, so that the latter may be
910 // laid out as required by the base class without regard to additions from
911 // the derived class(es).
912
913 // (Since we're emitting the vcall and vbase offsets in reverse order, we'll
914 // emit them for the primary base first).
915 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase())
916 AddVCallAndVBaseOffsets(PrimaryBase, OffsetToTop, VBases);
917
918 AddVBaseOffsets(RD, OffsetToTop, VBases);
919}
920
921void VtableBuilder::AddVBaseOffsets(const CXXRecordDecl *RD,
922 int64_t OffsetToTop,
923 VisitedVirtualBasesSetTy &VBases) {
Anders Carlsson77904f12010-02-16 04:59:55 +0000924 const ASTRecordLayout &MostDerivedClassLayout =
925 Context.getASTRecordLayout(MostDerivedClass);
926
927 // Add vbase offsets.
928 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
929 E = RD->bases_end(); I != E; ++I) {
930 const CXXRecordDecl *BaseDecl =
931 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
932
933 // Check if this is a virtual base that we haven't visited before.
934 if (I->isVirtual() && VBases.insert(BaseDecl)) {
935 // FIXME: We shouldn't use / 8 here.
936 uint64_t Offset =
937 OffsetToTop + MostDerivedClassLayout.getVBaseClassOffset(BaseDecl) / 8;
938
939 VCallAndVBaseOffsets.push_back(VtableComponent::MakeVBaseOffset(Offset));
940 }
941
942 // Check the base class looking for more vbase offsets.
943 AddVBaseOffsets(BaseDecl, OffsetToTop, VBases);
944 }
Anders Carlssondc2dba32010-02-16 04:49:44 +0000945}
946
947void
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000948VtableBuilder::AddMethod(const CXXMethodDecl *MD,
Anders Carlssond3adb0c2010-02-13 23:40:17 +0000949 ReturnAdjustment ReturnAdjustment,
950 ThisAdjustment ThisAdjustment) {
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000951 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
952 assert(ReturnAdjustment.isEmpty() &&
953 "Destructor can't have return adjustment!");
Anders Carlssond3adb0c2010-02-13 23:40:17 +0000954 // Add the 'this' pointer adjustments if necessary.
955 if (!ThisAdjustment.isEmpty()) {
956 ThisAdjustments.push_back(std::make_pair(Components.size(),
957 ThisAdjustment));
958 ThisAdjustments.push_back(std::make_pair(Components.size() + 1,
959 ThisAdjustment));
960 }
961
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000962 // Add both the complete destructor and the deleting destructor.
963 Components.push_back(VtableComponent::MakeCompleteDtor(DD));
964 Components.push_back(VtableComponent::MakeDeletingDtor(DD));
965 } else {
966 // Add the return adjustment if necessary.
967 if (!ReturnAdjustment.isEmpty())
968 ReturnAdjustments.push_back(std::make_pair(Components.size(),
969 ReturnAdjustment));
970
Anders Carlssond3adb0c2010-02-13 23:40:17 +0000971 // Add the 'this' pointer adjustment if necessary.
972 if (!ThisAdjustment.isEmpty())
973 ThisAdjustments.push_back(std::make_pair(Components.size(),
974 ThisAdjustment));
975
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000976 // Add the function.
977 Components.push_back(VtableComponent::MakeFunction(MD));
978 }
979}
980
981void
982VtableBuilder::AddMethods(BaseSubobject Base, PrimaryBasesSetTy &PrimaryBases) {
Anders Carlsson65b49782010-02-12 05:25:12 +0000983 const CXXRecordDecl *RD = Base.getBase();
984
985 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
986
987 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
988 if (Layout.getPrimaryBaseWasVirtual())
989 assert(false && "FIXME: Handle vbases here.");
990 else
991 assert(Layout.getBaseClassOffset(PrimaryBase) == 0 &&
992 "Primary base should have a zero offset!");
993
Anders Carlssone75aaa92010-02-13 22:05:23 +0000994 AddMethods(BaseSubobject(PrimaryBase, Base.getBaseOffset()), PrimaryBases);
Anders Carlsson65b49782010-02-12 05:25:12 +0000995
996 if (!PrimaryBases.insert(PrimaryBase))
997 assert(false && "Found a duplicate primary base!");
998 }
Anders Carlsson932c2f22010-02-11 17:18:51 +0000999
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001000 // Now go through all virtual member functions and add them.
1001 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
1002 E = RD->method_end(); I != E; ++I) {
1003 const CXXMethodDecl *MD = *I;
Anders Carlsson65b49782010-02-12 05:25:12 +00001004
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001005 if (!MD->isVirtual())
1006 continue;
Anders Carlsson65b49782010-02-12 05:25:12 +00001007
1008 // Get the final overrider.
Anders Carlsson136bd192010-02-12 16:55:34 +00001009 FinalOverriders::OverriderInfo Overrider =
1010 Overriders.getOverrider(Base, MD);
Anders Carlsson65b49782010-02-12 05:25:12 +00001011
1012 // Check if this virtual member function overrides a method in a primary
1013 // base. If this is the case, and the return type doesn't require adjustment
1014 // then we can just use the member function from the primary base.
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001015 if (const CXXMethodDecl *OverriddenMD =
1016 OverridesMethodInPrimaryBase(MD, PrimaryBases)) {
Anders Carlssoncce9ee82010-02-13 23:17:31 +00001017 if (ComputeReturnAdjustmentBaseOffset(Context, MD,
1018 OverriddenMD).isEmpty())
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001019 continue;
1020 }
Anders Carlssoneee53d92010-02-13 02:02:03 +00001021
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001022 // Check if this overrider needs a return adjustment.
1023 FinalOverriders::BaseOffset ReturnAdjustmentOffset =
1024 Overriders.getReturnAdjustmentOffset(Base, MD);
1025
1026 ReturnAdjustment ReturnAdjustment =
1027 ComputeReturnAdjustment(ReturnAdjustmentOffset);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001028
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001029 // Check if this overrider needs a 'this' pointer adjustment.
1030 FinalOverriders::BaseOffset ThisAdjustmentOffset =
1031 Overriders.getThisAdjustmentOffset(Base, MD);
1032
1033 ThisAdjustment ThisAdjustment = ComputeThisAdjustment(ThisAdjustmentOffset);
1034
1035 AddMethod(Overrider.Method, ReturnAdjustment, ThisAdjustment);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001036 }
1037}
1038
Anders Carlssonb716a542010-02-16 16:26:28 +00001039void VtableBuilder::LayoutVtable() {
1040 LayoutPrimaryAndAndSecondaryVtables(BaseSubobject(MostDerivedClass, 0));
1041
1042 // FIXME: Emit vtables for virtual bases here.
1043}
1044
1045void VtableBuilder::LayoutPrimaryAndAndSecondaryVtables(BaseSubobject Base) {
Anders Carlsson65b49782010-02-12 05:25:12 +00001046 const CXXRecordDecl *RD = Base.getBase();
Anders Carlsson033d4862010-02-14 17:05:59 +00001047 assert(RD->isDynamicClass() && "class does not have a vtable!");
1048
Anders Carlsson77904f12010-02-16 04:59:55 +00001049 int64_t OffsetToTop = -(int64_t)Base.getBaseOffset() / 8;
1050
1051 // Add vcall and vbase offsets for this vtable.
1052 VisitedVirtualBasesSetTy VBases;
1053 AddVCallAndVBaseOffsets(RD, OffsetToTop, VBases);
1054
1055 // Reverse them and add them to the vtable components.
1056 std::reverse(VCallAndVBaseOffsets.begin(), VCallAndVBaseOffsets.end());
1057 Components.append(VCallAndVBaseOffsets.begin(), VCallAndVBaseOffsets.end());
1058 VCallAndVBaseOffsets.clear();
1059
1060 // Add the offset to top.
Anders Carlssone75aaa92010-02-13 22:05:23 +00001061 // FIXME: This is not going to be right for construction vtables.
Anders Carlsson258a1e32010-02-14 00:16:19 +00001062 // FIXME: We should not use / 8 here.
Anders Carlssone75aaa92010-02-13 22:05:23 +00001063 Components.push_back(VtableComponent::MakeOffsetToTop(OffsetToTop));
Anders Carlsson65b49782010-02-12 05:25:12 +00001064
1065 // Next, add the RTTI.
Anders Carlssone75aaa92010-02-13 22:05:23 +00001066 Components.push_back(VtableComponent::MakeRTTI(MostDerivedClass));
Anders Carlsson65b49782010-02-12 05:25:12 +00001067
Anders Carlssone8a97562010-02-12 07:43:48 +00001068 uint64_t AddressPoint = Components.size();
Anders Carlsson65b49782010-02-12 05:25:12 +00001069
1070 // Now go through all virtual member functions and add them.
1071 PrimaryBasesSetTy PrimaryBases;
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001072 AddMethods(Base, PrimaryBases);
Anders Carlsson65b49782010-02-12 05:25:12 +00001073
Anders Carlssone8a97562010-02-12 07:43:48 +00001074 // Record the address point.
1075 AddressPoints.insert(std::make_pair(Base, AddressPoint));
1076
1077 // Record the address points for all primary bases.
1078 for (PrimaryBasesSetTy::const_iterator I = PrimaryBases.begin(),
1079 E = PrimaryBases.end(); I != E; ++I) {
1080 const CXXRecordDecl *BaseDecl = *I;
1081
1082 // We know that all the primary bases have the same offset as the base
1083 // subobject.
1084 BaseSubobject PrimaryBase(BaseDecl, Base.getBaseOffset());
1085 AddressPoints.insert(std::make_pair(PrimaryBase, AddressPoint));
1086 }
1087
Anders Carlsson14157932010-02-16 16:02:57 +00001088 // Layout secondary vtables.
1089 LayoutSecondaryVtables(Base);
Anders Carlsson14157932010-02-16 16:02:57 +00001090}
1091
1092void VtableBuilder::LayoutSecondaryVtables(BaseSubobject Base) {
1093 // Itanium C++ ABI 2.5.2:
1094 // Following the primary virtual table of a derived class are secondary
1095 // virtual tables for each of its proper base classes, except any primary
1096 // base(s) with which it shares its primary virtual table.
1097
1098 const CXXRecordDecl *RD = Base.getBase();
Anders Carlsson65b49782010-02-12 05:25:12 +00001099 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1100 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
Anders Carlsson14157932010-02-16 16:02:57 +00001101
Anders Carlsson65b49782010-02-12 05:25:12 +00001102 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1103 E = RD->bases_end(); I != E; ++I) {
Anders Carlsson14157932010-02-16 16:02:57 +00001104 // Ignore virtual bases, we'll emit them later.
1105 if (I->isVirtual())
1106 continue;
1107
Anders Carlsson65b49782010-02-12 05:25:12 +00001108 const CXXRecordDecl *BaseDecl =
1109 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson033d4862010-02-14 17:05:59 +00001110
Anders Carlssondc2dba32010-02-16 04:49:44 +00001111 // Ignore bases that don't have a vtable.
1112 if (!BaseDecl->isDynamicClass())
1113 continue;
Anders Carlsson033d4862010-02-14 17:05:59 +00001114
Anders Carlssone75aaa92010-02-13 22:05:23 +00001115 // Get the base offset of this base.
1116 uint64_t BaseOffset = Base.getBaseOffset() +
1117 Layout.getBaseClassOffset(BaseDecl);
Anders Carlsson14157932010-02-16 16:02:57 +00001118
1119 // Don't emit a secondary vtable for a primary base. We might however want
1120 // to emit secondary vtables for other bases of this base.
1121 if (BaseDecl == PrimaryBase) {
1122 LayoutSecondaryVtables(BaseSubobject(BaseDecl, BaseOffset));
1123 continue;
1124 }
Anders Carlssone75aaa92010-02-13 22:05:23 +00001125
Anders Carlssonb716a542010-02-16 16:26:28 +00001126 // Layout the primary vtable (and any secondary vtables) for this base.
1127 LayoutPrimaryAndAndSecondaryVtables(BaseSubobject(BaseDecl, BaseOffset));
Anders Carlsson65b49782010-02-12 05:25:12 +00001128 }
1129}
1130
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001131/// dumpLayout - Dump the vtable layout.
1132void VtableBuilder::dumpLayout(llvm::raw_ostream& Out) {
1133
1134 Out << "Vtable for '" << MostDerivedClass->getQualifiedNameAsString();
1135 Out << "' (" << Components.size() << " entries).\n";
1136
Anders Carlsson932c2f22010-02-11 17:18:51 +00001137 // Iterate through the address points and insert them into a new map where
1138 // they are keyed by the index and not the base object.
1139 // Since an address point can be shared by multiple subobjects, we use an
1140 // STL multimap.
1141 std::multimap<uint64_t, BaseSubobject> AddressPointsByIndex;
1142 for (CGVtableInfo::AddressPointsMapTy::const_iterator I =
1143 AddressPoints.begin(), E = AddressPoints.end(); I != E; ++I) {
1144 const BaseSubobject& Base = I->first;
1145 uint64_t Index = I->second;
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001146
Anders Carlsson932c2f22010-02-11 17:18:51 +00001147 AddressPointsByIndex.insert(std::make_pair(Index, Base));
1148 }
1149
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001150 unsigned NextReturnAdjustmentIndex = 0;
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001151 unsigned NextThisAdjustmentIndex = 0;
Anders Carlsson932c2f22010-02-11 17:18:51 +00001152 for (unsigned I = 0, E = Components.size(); I != E; ++I) {
Anders Carlssone8a97562010-02-12 07:43:48 +00001153 uint64_t Index = I;
1154
Anders Carlsson932c2f22010-02-11 17:18:51 +00001155 if (AddressPointsByIndex.count(I)) {
Anders Carlssone8a97562010-02-12 07:43:48 +00001156 if (AddressPointsByIndex.count(Index) == 1) {
1157 const BaseSubobject &Base = AddressPointsByIndex.find(Index)->second;
1158
1159 // FIXME: Instead of dividing by 8, we should be using CharUnits.
1160 Out << " -- (" << Base.getBase()->getQualifiedNameAsString();
1161 Out << ", " << Base.getBaseOffset() / 8 << ") vtable address --\n";
1162 } else {
1163 uint64_t BaseOffset =
1164 AddressPointsByIndex.lower_bound(Index)->second.getBaseOffset();
1165
1166 // We store the class names in a set to get a stable order.
1167 std::set<std::string> ClassNames;
1168 for (std::multimap<uint64_t, BaseSubobject>::const_iterator I =
1169 AddressPointsByIndex.lower_bound(Index), E =
1170 AddressPointsByIndex.upper_bound(Index); I != E; ++I) {
1171 assert(I->second.getBaseOffset() == BaseOffset &&
1172 "Invalid base offset!");
1173 const CXXRecordDecl *RD = I->second.getBase();
1174 ClassNames.insert(RD->getQualifiedNameAsString());
1175 }
1176
1177 for (std::set<std::string>::const_iterator I = ClassNames.begin(),
1178 E = ClassNames.end(); I != E; ++I) {
1179 // FIXME: Instead of dividing by 8, we should be using CharUnits.
1180 Out << " -- (" << *I;
1181 Out << ", " << BaseOffset / 8 << ") vtable address --\n";
1182 }
1183 }
Anders Carlsson932c2f22010-02-11 17:18:51 +00001184 }
1185
1186 Out << llvm::format("%4d | ", I);
1187
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001188 const VtableComponent &Component = Components[I];
1189
1190 // Dump the component.
1191 switch (Component.getKind()) {
1192 // FIXME: Remove this default case.
1193 default:
1194 assert(false && "Unhandled component kind!");
1195 break;
Anders Carlsson77904f12010-02-16 04:59:55 +00001196
1197 case VtableComponent::CK_VBaseOffset:
1198 Out << "vbase_offset (" << Component.getVBaseOffset() << ")";
1199 break;
1200
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001201 case VtableComponent::CK_OffsetToTop:
1202 Out << "offset_to_top (" << Component.getOffsetToTop() << ")";
1203 break;
1204
1205 case VtableComponent::CK_RTTI:
1206 Out << Component.getRTTIDecl()->getQualifiedNameAsString() << " RTTI";
1207 break;
1208
Anders Carlsson5bd8d192010-02-11 18:20:28 +00001209 case VtableComponent::CK_FunctionPointer: {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001210 const CXXMethodDecl *MD = Component.getFunctionDecl();
1211
Anders Carlsson5bd8d192010-02-11 18:20:28 +00001212 std::string Str =
1213 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
1214 MD);
1215 Out << Str;
Anders Carlsson09da3372010-02-12 02:38:13 +00001216 if (MD->isPure())
1217 Out << " [pure]";
1218
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001219 // If this function pointer has a return adjustment, dump it.
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001220 if (NextReturnAdjustmentIndex < ReturnAdjustments.size() &&
1221 ReturnAdjustments[NextReturnAdjustmentIndex].first == I) {
1222 const ReturnAdjustment Adjustment =
1223 ReturnAdjustments[NextReturnAdjustmentIndex].second;
1224
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001225 Out << "\n [return adjustment: ";
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001226 Out << Adjustment.NonVirtual << " non-virtual";
1227
1228 if (Adjustment.VBaseOffsetOffset)
1229 Out << ", " << Adjustment.VBaseOffsetOffset << " vbase offset offset";
1230 Out << ']';
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001231
1232 NextReturnAdjustmentIndex++;
1233 }
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001234
1235 // If this function pointer has a 'this' pointer adjustment, dump it.
1236 if (NextThisAdjustmentIndex < ThisAdjustments.size() &&
1237 ThisAdjustments[NextThisAdjustmentIndex].first == I) {
1238 const ThisAdjustment Adjustment =
1239 ThisAdjustments[NextThisAdjustmentIndex].second;
1240
1241 Out << "\n [this adjustment: ";
1242 Out << Adjustment.NonVirtual << " non-virtual";
1243
1244 Out << ']';
1245
1246 NextThisAdjustmentIndex++;
1247 }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001248
Anders Carlsson5bd8d192010-02-11 18:20:28 +00001249 break;
1250 }
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001251
Anders Carlsson5bd8d192010-02-11 18:20:28 +00001252 case VtableComponent::CK_CompleteDtorPointer: {
1253 const CXXDestructorDecl *DD = Component.getDestructorDecl();
1254
1255 Out << DD->getQualifiedNameAsString() << "() [complete]";
Anders Carlsson09da3372010-02-12 02:38:13 +00001256 if (DD->isPure())
1257 Out << " [pure]";
1258
Anders Carlsson5bd8d192010-02-11 18:20:28 +00001259 break;
1260 }
1261
1262 case VtableComponent::CK_DeletingDtorPointer: {
1263 const CXXDestructorDecl *DD = Component.getDestructorDecl();
1264
1265 Out << DD->getQualifiedNameAsString() << "() [deleting]";
Anders Carlsson09da3372010-02-12 02:38:13 +00001266 if (DD->isPure())
1267 Out << " [pure]";
1268
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001269 break;
1270 }
1271
1272 }
Anders Carlsson932c2f22010-02-11 17:18:51 +00001273
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001274 Out << '\n';
1275 }
1276
1277}
1278
1279}
1280
1281namespace {
1282class OldVtableBuilder {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001283public:
1284 /// Index_t - Vtable index type.
1285 typedef uint64_t Index_t;
Eli Friedman31bc3ad2009-12-07 23:56:34 +00001286 typedef std::vector<std::pair<GlobalDecl,
1287 std::pair<GlobalDecl, ThunkAdjustment> > >
1288 SavedAdjustmentsVectorTy;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001289private:
Anders Carlsson472404f2009-12-04 16:19:30 +00001290
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00001291 // VtableComponents - The components of the vtable being built.
1292 typedef llvm::SmallVector<llvm::Constant *, 64> VtableComponentsVectorTy;
1293 VtableComponentsVectorTy VtableComponents;
1294
Eli Friedman6c08ce72009-12-05 01:05:03 +00001295 const bool BuildVtable;
1296
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001297 llvm::Type *Ptr8Ty;
Anders Carlssonbad80eb2009-12-04 18:36:22 +00001298
1299 /// MostDerivedClass - The most derived class that this vtable is being
1300 /// built for.
1301 const CXXRecordDecl *MostDerivedClass;
1302
Mike Stump83066c82009-11-13 01:54:23 +00001303 /// LayoutClass - The most derived class used for virtual base layout
1304 /// information.
1305 const CXXRecordDecl *LayoutClass;
Mike Stump653d0b92009-11-13 02:13:54 +00001306 /// LayoutOffset - The offset for Class in LayoutClass.
1307 uint64_t LayoutOffset;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001308 /// BLayout - Layout for the most derived class that this vtable is being
1309 /// built for.
1310 const ASTRecordLayout &BLayout;
1311 llvm::SmallSet<const CXXRecordDecl *, 32> IndirectPrimary;
1312 llvm::SmallSet<const CXXRecordDecl *, 32> SeenVBase;
1313 llvm::Constant *rtti;
1314 llvm::LLVMContext &VMContext;
1315 CodeGenModule &CGM; // Per-module state.
Anders Carlssonf2f31f42009-12-04 03:46:21 +00001316
Mike Stump90181eb2010-01-26 00:05:04 +00001317 llvm::DenseMap<const CXXMethodDecl *, Index_t> VCall;
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001318 llvm::DenseMap<GlobalDecl, Index_t> VCallOffset;
Mike Stump77537b12010-01-26 03:42:22 +00001319 llvm::DenseMap<GlobalDecl, Index_t> VCallOffsetForVCall;
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00001320 // This is the offset to the nearest virtual base
Mike Stump90181eb2010-01-26 00:05:04 +00001321 llvm::DenseMap<const CXXMethodDecl *, Index_t> NonVirtualOffset;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001322 llvm::DenseMap<const CXXRecordDecl *, Index_t> VBIndex;
Mike Stumpbb9ff052009-10-27 23:46:47 +00001323
Anders Carlsson323bb042009-11-26 19:54:33 +00001324 /// PureVirtualFunction - Points to __cxa_pure_virtual.
1325 llvm::Constant *PureVirtualFn;
1326
Anders Carlssona84b6e82009-12-04 02:01:07 +00001327 /// VtableMethods - A data structure for keeping track of methods in a vtable.
1328 /// Can add methods, override methods and iterate in vtable order.
1329 class VtableMethods {
1330 // MethodToIndexMap - Maps from a global decl to the index it has in the
1331 // Methods vector.
1332 llvm::DenseMap<GlobalDecl, uint64_t> MethodToIndexMap;
1333
1334 /// Methods - The methods, in vtable order.
1335 typedef llvm::SmallVector<GlobalDecl, 16> MethodsVectorTy;
1336 MethodsVectorTy Methods;
Eli Friedman8174f2c2009-12-06 22:01:30 +00001337 MethodsVectorTy OrigMethods;
Anders Carlssona84b6e82009-12-04 02:01:07 +00001338
1339 public:
1340 /// AddMethod - Add a method to the vtable methods.
1341 void AddMethod(GlobalDecl GD) {
1342 assert(!MethodToIndexMap.count(GD) &&
1343 "Method has already been added!");
1344
1345 MethodToIndexMap[GD] = Methods.size();
1346 Methods.push_back(GD);
Eli Friedman8174f2c2009-12-06 22:01:30 +00001347 OrigMethods.push_back(GD);
Anders Carlssona84b6e82009-12-04 02:01:07 +00001348 }
1349
1350 /// OverrideMethod - Replace a method with another.
1351 void OverrideMethod(GlobalDecl OverriddenGD, GlobalDecl GD) {
1352 llvm::DenseMap<GlobalDecl, uint64_t>::iterator i
1353 = MethodToIndexMap.find(OverriddenGD);
1354 assert(i != MethodToIndexMap.end() && "Did not find entry!");
1355
1356 // Get the index of the old decl.
1357 uint64_t Index = i->second;
1358
1359 // Replace the old decl with the new decl.
1360 Methods[Index] = GD;
1361
Anders Carlssona84b6e82009-12-04 02:01:07 +00001362 // And add the new.
1363 MethodToIndexMap[GD] = Index;
1364 }
1365
Anders Carlsson7bb70762009-12-04 15:49:02 +00001366 /// getIndex - Gives the index of a passed in GlobalDecl. Returns false if
1367 /// the index couldn't be found.
Benjamin Kramer62ab6162009-12-04 22:45:27 +00001368 bool getIndex(GlobalDecl GD, uint64_t &Index) const {
Anders Carlsson7bb70762009-12-04 15:49:02 +00001369 llvm::DenseMap<GlobalDecl, uint64_t>::const_iterator i
1370 = MethodToIndexMap.find(GD);
Eli Friedman3d2e9de2009-12-04 08:34:14 +00001371
Anders Carlsson7bb70762009-12-04 15:49:02 +00001372 if (i == MethodToIndexMap.end())
1373 return false;
Anders Carlssone6096362009-12-04 03:41:37 +00001374
Anders Carlsson7bb70762009-12-04 15:49:02 +00001375 Index = i->second;
1376 return true;
Anders Carlssone6096362009-12-04 03:41:37 +00001377 }
1378
Eli Friedman8174f2c2009-12-06 22:01:30 +00001379 GlobalDecl getOrigMethod(uint64_t Index) const {
1380 return OrigMethods[Index];
1381 }
1382
Anders Carlssona84b6e82009-12-04 02:01:07 +00001383 MethodsVectorTy::size_type size() const {
1384 return Methods.size();
1385 }
1386
1387 void clear() {
1388 MethodToIndexMap.clear();
1389 Methods.clear();
Eli Friedman8174f2c2009-12-06 22:01:30 +00001390 OrigMethods.clear();
Anders Carlssona84b6e82009-12-04 02:01:07 +00001391 }
1392
Anders Carlssone6096362009-12-04 03:41:37 +00001393 GlobalDecl operator[](uint64_t Index) const {
Anders Carlssona84b6e82009-12-04 02:01:07 +00001394 return Methods[Index];
1395 }
1396 };
1397
1398 /// Methods - The vtable methods we're currently building.
1399 VtableMethods Methods;
1400
Anders Carlsson4c837d22009-12-04 02:26:15 +00001401 /// ThisAdjustments - For a given index in the vtable, contains the 'this'
1402 /// pointer adjustment needed for a method.
1403 typedef llvm::DenseMap<uint64_t, ThunkAdjustment> ThisAdjustmentsMapTy;
1404 ThisAdjustmentsMapTy ThisAdjustments;
Anders Carlssond420a312009-11-26 19:32:45 +00001405
Eli Friedman31bc3ad2009-12-07 23:56:34 +00001406 SavedAdjustmentsVectorTy SavedAdjustments;
Eli Friedman8174f2c2009-12-06 22:01:30 +00001407
Anders Carlssonc521f952009-12-04 02:22:02 +00001408 /// BaseReturnTypes - Contains the base return types of methods who have been
1409 /// overridden with methods whose return types require adjustment. Used for
1410 /// generating covariant thunk information.
1411 typedef llvm::DenseMap<uint64_t, CanQualType> BaseReturnTypesMapTy;
1412 BaseReturnTypesMapTy BaseReturnTypes;
Anders Carlssond420a312009-11-26 19:32:45 +00001413
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001414 std::vector<Index_t> VCalls;
Mike Stump2cefe382009-11-12 20:47:57 +00001415
1416 typedef std::pair<const CXXRecordDecl *, uint64_t> CtorVtable_t;
Mike Stumpcd2b8212009-11-19 20:52:19 +00001417 // subAddressPoints - Used to hold the AddressPoints (offsets) into the built
1418 // vtable for use in computing the initializers for the VTT.
1419 llvm::DenseMap<CtorVtable_t, int64_t> &subAddressPoints;
Mike Stump2cefe382009-11-12 20:47:57 +00001420
Anders Carlsson5f9a8812010-01-14 02:29:07 +00001421 /// AddressPoints - Address points for this vtable.
1422 CGVtableInfo::AddressPointsMapTy& AddressPoints;
1423
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001424 typedef CXXRecordDecl::method_iterator method_iter;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001425 const uint32_t LLVMPointerWidth;
1426 Index_t extra;
Mike Stump37dbe962009-10-15 02:04:03 +00001427 typedef std::vector<std::pair<const CXXRecordDecl *, int64_t> > Path_t;
Mike Stumpcd2b8212009-11-19 20:52:19 +00001428 static llvm::DenseMap<CtorVtable_t, int64_t>&
1429 AllocAddressPoint(CodeGenModule &cgm, const CXXRecordDecl *l,
1430 const CXXRecordDecl *c) {
Anders Carlsson93a18842010-01-02 18:02:32 +00001431 CGVtableInfo::AddrMap_t *&oref = cgm.getVtableInfo().AddressPoints[l];
Mike Stumpcd2b8212009-11-19 20:52:19 +00001432 if (oref == 0)
Anders Carlsson93a18842010-01-02 18:02:32 +00001433 oref = new CGVtableInfo::AddrMap_t;
Mike Stumpcd2b8212009-11-19 20:52:19 +00001434
1435 llvm::DenseMap<CtorVtable_t, int64_t> *&ref = (*oref)[c];
1436 if (ref == 0)
1437 ref = new llvm::DenseMap<CtorVtable_t, int64_t>;
1438 return *ref;
1439 }
Anders Carlsson323bb042009-11-26 19:54:33 +00001440
Mike Stump90181eb2010-01-26 00:05:04 +00001441 bool DclIsSame(const FunctionDecl *New, const FunctionDecl *Old) {
1442 FunctionTemplateDecl *OldTemplate = Old->getDescribedFunctionTemplate();
1443 FunctionTemplateDecl *NewTemplate = New->getDescribedFunctionTemplate();
1444
1445 // C++ [temp.fct]p2:
1446 // A function template can be overloaded with other function templates
1447 // and with normal (non-template) functions.
1448 if ((OldTemplate == 0) != (NewTemplate == 0))
1449 return false;
1450
1451 // Is the function New an overload of the function Old?
1452 QualType OldQType = CGM.getContext().getCanonicalType(Old->getType());
1453 QualType NewQType = CGM.getContext().getCanonicalType(New->getType());
1454
1455 // Compare the signatures (C++ 1.3.10) of the two functions to
1456 // determine whether they are overloads. If we find any mismatch
1457 // in the signature, they are overloads.
1458
1459 // If either of these functions is a K&R-style function (no
1460 // prototype), then we consider them to have matching signatures.
1461 if (isa<FunctionNoProtoType>(OldQType.getTypePtr()) ||
1462 isa<FunctionNoProtoType>(NewQType.getTypePtr()))
1463 return true;
1464
1465 FunctionProtoType* OldType = cast<FunctionProtoType>(OldQType);
1466 FunctionProtoType* NewType = cast<FunctionProtoType>(NewQType);
1467
1468 // The signature of a function includes the types of its
1469 // parameters (C++ 1.3.10), which includes the presence or absence
1470 // of the ellipsis; see C++ DR 357).
1471 if (OldQType != NewQType &&
1472 (OldType->getNumArgs() != NewType->getNumArgs() ||
1473 OldType->isVariadic() != NewType->isVariadic() ||
1474 !std::equal(OldType->arg_type_begin(), OldType->arg_type_end(),
1475 NewType->arg_type_begin())))
1476 return false;
1477
1478#if 0
1479 // C++ [temp.over.link]p4:
1480 // The signature of a function template consists of its function
1481 // signature, its return type and its template parameter list. The names
1482 // of the template parameters are significant only for establishing the
1483 // relationship between the template parameters and the rest of the
1484 // signature.
1485 //
1486 // We check the return type and template parameter lists for function
1487 // templates first; the remaining checks follow.
1488 if (NewTemplate &&
1489 (!TemplateParameterListsAreEqual(NewTemplate->getTemplateParameters(),
1490 OldTemplate->getTemplateParameters(),
1491 TPL_TemplateMatch) ||
1492 OldType->getResultType() != NewType->getResultType()))
1493 return false;
1494#endif
1495
1496 // If the function is a class member, its signature includes the
1497 // cv-qualifiers (if any) on the function itself.
1498 //
1499 // As part of this, also check whether one of the member functions
1500 // is static, in which case they are not overloads (C++
1501 // 13.1p2). While not part of the definition of the signature,
1502 // this check is important to determine whether these functions
1503 // can be overloaded.
1504 const CXXMethodDecl* OldMethod = dyn_cast<CXXMethodDecl>(Old);
1505 const CXXMethodDecl* NewMethod = dyn_cast<CXXMethodDecl>(New);
1506 if (OldMethod && NewMethod &&
1507 !OldMethod->isStatic() && !NewMethod->isStatic() &&
1508 OldMethod->getTypeQualifiers() != NewMethod->getTypeQualifiers())
1509 return false;
1510
1511 // The signatures match; this is not an overload.
1512 return true;
1513 }
1514
1515 typedef llvm::DenseMap<const CXXMethodDecl *, const CXXMethodDecl*>
1516 ForwardUnique_t;
1517 ForwardUnique_t ForwardUnique;
1518 llvm::DenseMap<const CXXMethodDecl*, const CXXMethodDecl*> UniqueOverrider;
1519
1520 void BuildUniqueOverrider(const CXXMethodDecl *U, const CXXMethodDecl *MD) {
1521 const CXXMethodDecl *PrevU = UniqueOverrider[MD];
1522 assert(U && "no unique overrider");
1523 if (PrevU == U)
1524 return;
1525 if (PrevU != U && PrevU != 0) {
1526 // If already set, note the two sets as the same
1527 if (0)
1528 printf("%s::%s same as %s::%s\n",
1529 PrevU->getParent()->getNameAsCString(),
1530 PrevU->getNameAsCString(),
1531 U->getParent()->getNameAsCString(),
1532 U->getNameAsCString());
1533 ForwardUnique[PrevU] = U;
1534 return;
1535 }
1536
1537 // Not set, set it now
1538 if (0)
1539 printf("marking %s::%s %p override as %s::%s\n",
1540 MD->getParent()->getNameAsCString(),
1541 MD->getNameAsCString(),
1542 (void*)MD,
1543 U->getParent()->getNameAsCString(),
1544 U->getNameAsCString());
1545 UniqueOverrider[MD] = U;
1546
1547 for (CXXMethodDecl::method_iterator mi = MD->begin_overridden_methods(),
1548 me = MD->end_overridden_methods(); mi != me; ++mi) {
1549 BuildUniqueOverrider(U, *mi);
1550 }
1551 }
1552
1553 void BuildUniqueOverriders(const CXXRecordDecl *RD) {
1554 if (0) printf("walking %s\n", RD->getNameAsCString());
1555 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
1556 e = RD->method_end(); i != e; ++i) {
1557 const CXXMethodDecl *MD = *i;
1558 if (!MD->isVirtual())
1559 continue;
1560
1561 if (UniqueOverrider[MD] == 0) {
1562 // Only set this, if it hasn't been set yet.
1563 BuildUniqueOverrider(MD, MD);
1564 if (0)
1565 printf("top set is %s::%s %p\n",
1566 MD->getParent()->getNameAsCString(),
1567 MD->getNameAsCString(),
1568 (void*)MD);
1569 ForwardUnique[MD] = MD;
1570 }
1571 }
1572 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
1573 e = RD->bases_end(); i != e; ++i) {
1574 const CXXRecordDecl *Base =
1575 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
1576 BuildUniqueOverriders(Base);
1577 }
1578 }
1579
1580 static int DclCmp(const void *p1, const void *p2) {
John McCallef3057c2010-02-13 01:04:05 +00001581 const CXXMethodDecl *MD1 = *(const CXXMethodDecl *const *)p1;
1582 const CXXMethodDecl *MD2 = *(const CXXMethodDecl *const *)p2;
1583
1584 return (DeclarationName::compare(MD1->getDeclName(), MD2->getDeclName()));
Mike Stump90181eb2010-01-26 00:05:04 +00001585 }
1586
1587 void MergeForwarding() {
1588 typedef llvm::SmallVector<const CXXMethodDecl *, 100> A_t;
1589 A_t A;
1590 for (ForwardUnique_t::iterator I = ForwardUnique.begin(),
1591 E = ForwardUnique.end(); I != E; ++I) {
1592 if (I->first == I->second)
1593 // Only add the roots of all trees
1594 A.push_back(I->first);
1595 }
1596 llvm::array_pod_sort(A.begin(), A.end(), DclCmp);
1597 for (A_t::iterator I = A.begin(),
1598 E = A.end(); I != E; ++I) {
1599 A_t::iterator J = I;
John McCallef3057c2010-02-13 01:04:05 +00001600 while (++J != E && DclCmp(I, J) == 0)
Mike Stump90181eb2010-01-26 00:05:04 +00001601 if (DclIsSame(*I, *J)) {
Eli Friedman18c28f62010-02-13 00:03:21 +00001602 if (0) printf("connecting %s\n", (*I)->getNameAsCString());
Mike Stump90181eb2010-01-26 00:05:04 +00001603 ForwardUnique[*J] = *I;
1604 }
1605 }
1606 }
1607
1608 const CXXMethodDecl *getUnique(const CXXMethodDecl *MD) {
1609 const CXXMethodDecl *U = UniqueOverrider[MD];
1610 assert(U && "unique overrider not found");
1611 while (ForwardUnique.count(U)) {
1612 const CXXMethodDecl *NU = ForwardUnique[U];
1613 if (NU == U) break;
1614 U = NU;
1615 }
1616 return U;
1617 }
Anders Carlsson72281172010-01-26 17:36:47 +00001618
1619 GlobalDecl getUnique(GlobalDecl GD) {
1620 const CXXMethodDecl *Unique = getUnique(cast<CXXMethodDecl>(GD.getDecl()));
1621
1622 if (const CXXConstructorDecl *CD = dyn_cast<CXXConstructorDecl>(Unique))
1623 return GlobalDecl(CD, GD.getCtorType());
1624
1625 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(Unique))
1626 return GlobalDecl(DD, GD.getDtorType());
1627
1628 return Unique;
Mike Stump90181eb2010-01-26 00:05:04 +00001629 }
1630
Anders Carlsson323bb042009-11-26 19:54:33 +00001631 /// getPureVirtualFn - Return the __cxa_pure_virtual function.
1632 llvm::Constant* getPureVirtualFn() {
1633 if (!PureVirtualFn) {
1634 const llvm::FunctionType *Ty =
1635 llvm::FunctionType::get(llvm::Type::getVoidTy(VMContext),
1636 /*isVarArg=*/false);
1637 PureVirtualFn = wrap(CGM.CreateRuntimeFunction(Ty, "__cxa_pure_virtual"));
1638 }
1639
1640 return PureVirtualFn;
1641 }
1642
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001643public:
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001644 OldVtableBuilder(const CXXRecordDecl *MostDerivedClass,
Eli Friedman6c08ce72009-12-05 01:05:03 +00001645 const CXXRecordDecl *l, uint64_t lo, CodeGenModule &cgm,
Anders Carlsson5f9a8812010-01-14 02:29:07 +00001646 bool build, CGVtableInfo::AddressPointsMapTy& AddressPoints)
Eli Friedman6c08ce72009-12-05 01:05:03 +00001647 : BuildVtable(build), MostDerivedClass(MostDerivedClass), LayoutClass(l),
1648 LayoutOffset(lo), BLayout(cgm.getContext().getASTRecordLayout(l)),
1649 rtti(0), VMContext(cgm.getModule().getContext()),CGM(cgm),
1650 PureVirtualFn(0),
Anders Carlssonbad80eb2009-12-04 18:36:22 +00001651 subAddressPoints(AllocAddressPoint(cgm, l, MostDerivedClass)),
Anders Carlsson5f9a8812010-01-14 02:29:07 +00001652 AddressPoints(AddressPoints),
1653 LLVMPointerWidth(cgm.getContext().Target.getPointerWidth(0))
1654 {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001655 Ptr8Ty = llvm::PointerType::get(llvm::Type::getInt8Ty(VMContext), 0);
Anders Carlsson3f4336c2009-12-17 07:09:17 +00001656 if (BuildVtable) {
1657 QualType ClassType = CGM.getContext().getTagDeclType(MostDerivedClass);
1658 rtti = CGM.GetAddrOfRTTIDescriptor(ClassType);
1659 }
Mike Stump90181eb2010-01-26 00:05:04 +00001660 BuildUniqueOverriders(MostDerivedClass);
1661 MergeForwarding();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001662 }
1663
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00001664 // getVtableComponents - Returns a reference to the vtable components.
1665 const VtableComponentsVectorTy &getVtableComponents() const {
1666 return VtableComponents;
Anders Carlsson472404f2009-12-04 16:19:30 +00001667 }
1668
Anders Carlssone36a6b32010-01-02 01:01:18 +00001669 llvm::DenseMap<const CXXRecordDecl *, uint64_t> &getVBIndex()
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001670 { return VBIndex; }
1671
Eli Friedman31bc3ad2009-12-07 23:56:34 +00001672 SavedAdjustmentsVectorTy &getSavedAdjustments()
1673 { return SavedAdjustments; }
Eli Friedman8174f2c2009-12-06 22:01:30 +00001674
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001675 llvm::Constant *wrap(Index_t i) {
1676 llvm::Constant *m;
1677 m = llvm::ConstantInt::get(llvm::Type::getInt64Ty(VMContext), i);
1678 return llvm::ConstantExpr::getIntToPtr(m, Ptr8Ty);
1679 }
1680
1681 llvm::Constant *wrap(llvm::Constant *m) {
1682 return llvm::ConstantExpr::getBitCast(m, Ptr8Ty);
1683 }
1684
Mike Stumpd2808442010-01-22 02:51:26 +00001685//#define D1(x)
1686#define D1(X) do { if (getenv("DEBUG")) { X; } } while (0)
Mike Stump75ce5732009-10-31 20:06:59 +00001687
1688 void GenerateVBaseOffsets(const CXXRecordDecl *RD, uint64_t Offset,
Mike Stump28431212009-10-13 22:54:56 +00001689 bool updateVBIndex, Index_t current_vbindex) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001690 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
1691 e = RD->bases_end(); i != e; ++i) {
1692 const CXXRecordDecl *Base =
1693 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Mike Stump28431212009-10-13 22:54:56 +00001694 Index_t next_vbindex = current_vbindex;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001695 if (i->isVirtual() && !SeenVBase.count(Base)) {
1696 SeenVBase.insert(Base);
Mike Stump28431212009-10-13 22:54:56 +00001697 if (updateVBIndex) {
Mike Stump75ce5732009-10-31 20:06:59 +00001698 next_vbindex = (ssize_t)(-(VCalls.size()*LLVMPointerWidth/8)
Mike Stump28431212009-10-13 22:54:56 +00001699 - 3*LLVMPointerWidth/8);
1700 VBIndex[Base] = next_vbindex;
1701 }
Mike Stump75ce5732009-10-31 20:06:59 +00001702 int64_t BaseOffset = -(Offset/8) + BLayout.getVBaseClassOffset(Base)/8;
1703 VCalls.push_back((0?700:0) + BaseOffset);
1704 D1(printf(" vbase for %s at %d delta %d most derived %s\n",
1705 Base->getNameAsCString(),
1706 (int)-VCalls.size()-3, (int)BaseOffset,
Mike Stumpd2808442010-01-22 02:51:26 +00001707 MostDerivedClass->getNameAsCString()));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001708 }
Mike Stump28431212009-10-13 22:54:56 +00001709 // We also record offsets for non-virtual bases to closest enclosing
1710 // virtual base. We do this so that we don't have to search
1711 // for the nearst virtual base class when generating thunks.
1712 if (updateVBIndex && VBIndex.count(Base) == 0)
1713 VBIndex[Base] = next_vbindex;
Mike Stump75ce5732009-10-31 20:06:59 +00001714 GenerateVBaseOffsets(Base, Offset, updateVBIndex, next_vbindex);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001715 }
1716 }
1717
1718 void StartNewTable() {
1719 SeenVBase.clear();
1720 }
1721
Mike Stump8bccbfd2009-10-15 09:30:16 +00001722 Index_t getNVOffset_1(const CXXRecordDecl *D, const CXXRecordDecl *B,
1723 Index_t Offset = 0) {
1724
1725 if (B == D)
1726 return Offset;
1727
1728 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(D);
1729 for (CXXRecordDecl::base_class_const_iterator i = D->bases_begin(),
1730 e = D->bases_end(); i != e; ++i) {
1731 const CXXRecordDecl *Base =
1732 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
1733 int64_t BaseOffset = 0;
1734 if (!i->isVirtual())
1735 BaseOffset = Offset + Layout.getBaseClassOffset(Base);
1736 int64_t o = getNVOffset_1(Base, B, BaseOffset);
1737 if (o >= 0)
1738 return o;
1739 }
1740
1741 return -1;
1742 }
1743
1744 /// getNVOffset - Returns the non-virtual offset for the given (B) base of the
1745 /// derived class D.
1746 Index_t getNVOffset(QualType qB, QualType qD) {
Mike Stump46271322009-11-03 19:03:17 +00001747 qD = qD->getPointeeType();
1748 qB = qB->getPointeeType();
Mike Stump8bccbfd2009-10-15 09:30:16 +00001749 CXXRecordDecl *D = cast<CXXRecordDecl>(qD->getAs<RecordType>()->getDecl());
1750 CXXRecordDecl *B = cast<CXXRecordDecl>(qB->getAs<RecordType>()->getDecl());
1751 int64_t o = getNVOffset_1(D, B);
1752 if (o >= 0)
1753 return o;
1754
1755 assert(false && "FIXME: non-virtual base not found");
1756 return 0;
1757 }
1758
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001759 /// getVbaseOffset - Returns the index into the vtable for the virtual base
1760 /// offset for the given (B) virtual base of the derived class D.
1761 Index_t getVbaseOffset(QualType qB, QualType qD) {
Mike Stump46271322009-11-03 19:03:17 +00001762 qD = qD->getPointeeType();
1763 qB = qB->getPointeeType();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001764 CXXRecordDecl *D = cast<CXXRecordDecl>(qD->getAs<RecordType>()->getDecl());
1765 CXXRecordDecl *B = cast<CXXRecordDecl>(qB->getAs<RecordType>()->getDecl());
Anders Carlssonbad80eb2009-12-04 18:36:22 +00001766 if (D != MostDerivedClass)
Eli Friedman03aa2f12009-11-30 01:19:33 +00001767 return CGM.getVtableInfo().getVirtualBaseOffsetIndex(D, B);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001768 llvm::DenseMap<const CXXRecordDecl *, Index_t>::iterator i;
1769 i = VBIndex.find(B);
1770 if (i != VBIndex.end())
1771 return i->second;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001772
Mike Stump28431212009-10-13 22:54:56 +00001773 assert(false && "FIXME: Base not found");
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001774 return 0;
1775 }
1776
Eli Friedman81fb0d22009-12-04 08:40:51 +00001777 bool OverrideMethod(GlobalDecl GD, bool MorallyVirtual,
1778 Index_t OverrideOffset, Index_t Offset,
1779 int64_t CurrentVBaseOffset);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001780
Anders Carlsson495634e2009-12-04 02:39:04 +00001781 /// AppendMethods - Append the current methods to the vtable.
Anders Carlssonddf42c82009-12-04 02:56:03 +00001782 void AppendMethodsToVtable();
Anders Carlsson495634e2009-12-04 02:39:04 +00001783
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001784 llvm::Constant *WrapAddrOf(GlobalDecl GD) {
1785 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
1786
Anders Carlsson64457732009-11-24 05:08:52 +00001787 const llvm::Type *Ty = CGM.getTypes().GetFunctionTypeForVtable(MD);
Mike Stump18e8b472009-10-27 23:36:26 +00001788
Mike Stumpcdeb8002009-12-03 16:55:20 +00001789 return wrap(CGM.GetAddrOfFunction(GD, Ty));
Mike Stump18e8b472009-10-27 23:36:26 +00001790 }
1791
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00001792 void OverrideMethods(Path_t *Path, bool MorallyVirtual, int64_t Offset,
1793 int64_t CurrentVBaseOffset) {
Mike Stump37dbe962009-10-15 02:04:03 +00001794 for (Path_t::reverse_iterator i = Path->rbegin(),
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001795 e = Path->rend(); i != e; ++i) {
1796 const CXXRecordDecl *RD = i->first;
Mike Stump8bccbfd2009-10-15 09:30:16 +00001797 int64_t OverrideOffset = i->second;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001798 for (method_iter mi = RD->method_begin(), me = RD->method_end(); mi != me;
1799 ++mi) {
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001800 const CXXMethodDecl *MD = *mi;
1801
1802 if (!MD->isVirtual())
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001803 continue;
1804
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001805 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1806 // Override both the complete and the deleting destructor.
1807 GlobalDecl CompDtor(DD, Dtor_Complete);
Eli Friedman81fb0d22009-12-04 08:40:51 +00001808 OverrideMethod(CompDtor, MorallyVirtual, OverrideOffset, Offset,
1809 CurrentVBaseOffset);
1810
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001811 GlobalDecl DeletingDtor(DD, Dtor_Deleting);
Eli Friedman81fb0d22009-12-04 08:40:51 +00001812 OverrideMethod(DeletingDtor, MorallyVirtual, OverrideOffset, Offset,
1813 CurrentVBaseOffset);
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001814 } else {
Eli Friedman81fb0d22009-12-04 08:40:51 +00001815 OverrideMethod(MD, MorallyVirtual, OverrideOffset, Offset,
1816 CurrentVBaseOffset);
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001817 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001818 }
1819 }
1820 }
1821
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001822 void AddMethod(const GlobalDecl GD, bool MorallyVirtual, Index_t Offset,
Eli Friedman03aa2f12009-11-30 01:19:33 +00001823 int64_t CurrentVBaseOffset) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001824 // If we can find a previously allocated slot for this, reuse it.
Eli Friedman81fb0d22009-12-04 08:40:51 +00001825 if (OverrideMethod(GD, MorallyVirtual, Offset, Offset,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00001826 CurrentVBaseOffset))
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001827 return;
1828
Mike Stump1f49d652010-01-22 18:48:47 +00001829 D1(printf(" vfn for %s at %d\n",
1830 dyn_cast<CXXMethodDecl>(GD.getDecl())->getNameAsCString(),
1831 (int)Methods.size()));
1832
Anders Carlssoncdf18982009-12-04 02:08:24 +00001833 // We didn't find an entry in the vtable that we could use, add a new
1834 // entry.
1835 Methods.AddMethod(GD);
1836
Mike Stumpa04ecfb2010-01-26 21:35:27 +00001837 VCallOffset[GD] = Offset/8 - CurrentVBaseOffset/8;
1838
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001839 if (MorallyVirtual) {
Anders Carlsson72281172010-01-26 17:36:47 +00001840 GlobalDecl UGD = getUnique(GD);
1841 const CXXMethodDecl *UMD = cast<CXXMethodDecl>(UGD.getDecl());
1842
Mike Stump90181eb2010-01-26 00:05:04 +00001843 assert(UMD && "final overrider not found");
1844
1845 Index_t &idx = VCall[UMD];
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001846 // Allocate the first one, after that, we reuse the previous one.
1847 if (idx == 0) {
Anders Carlsson72281172010-01-26 17:36:47 +00001848 VCallOffsetForVCall[UGD] = Offset/8;
Mike Stumpa04ecfb2010-01-26 21:35:27 +00001849 NonVirtualOffset[UMD] = Offset/8 - CurrentVBaseOffset/8;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001850 idx = VCalls.size()+1;
Mike Stump90181eb2010-01-26 00:05:04 +00001851 VCalls.push_back(Offset/8 - CurrentVBaseOffset/8);
Mike Stump75ce5732009-10-31 20:06:59 +00001852 D1(printf(" vcall for %s at %d with delta %d\n",
Mike Stumpd2808442010-01-22 02:51:26 +00001853 dyn_cast<CXXMethodDecl>(GD.getDecl())->getNameAsCString(),
Mike Stump90181eb2010-01-26 00:05:04 +00001854 (int)-VCalls.size()-3, (int)VCalls[idx-1]));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001855 }
1856 }
1857 }
1858
1859 void AddMethods(const CXXRecordDecl *RD, bool MorallyVirtual,
Eli Friedman03aa2f12009-11-30 01:19:33 +00001860 Index_t Offset, int64_t CurrentVBaseOffset) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001861 for (method_iter mi = RD->method_begin(), me = RD->method_end(); mi != me;
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001862 ++mi) {
1863 const CXXMethodDecl *MD = *mi;
1864 if (!MD->isVirtual())
1865 continue;
1866
1867 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1868 // For destructors, add both the complete and the deleting destructor
1869 // to the vtable.
1870 AddMethod(GlobalDecl(DD, Dtor_Complete), MorallyVirtual, Offset,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00001871 CurrentVBaseOffset);
Eli Friedman03aa2f12009-11-30 01:19:33 +00001872 AddMethod(GlobalDecl(DD, Dtor_Deleting), MorallyVirtual, Offset,
1873 CurrentVBaseOffset);
1874 } else
1875 AddMethod(MD, MorallyVirtual, Offset, CurrentVBaseOffset);
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001876 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001877 }
1878
1879 void NonVirtualBases(const CXXRecordDecl *RD, const ASTRecordLayout &Layout,
1880 const CXXRecordDecl *PrimaryBase,
1881 bool PrimaryBaseWasVirtual, bool MorallyVirtual,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00001882 int64_t Offset, int64_t CurrentVBaseOffset,
1883 Path_t *Path) {
Mike Stump37dbe962009-10-15 02:04:03 +00001884 Path->push_back(std::make_pair(RD, Offset));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001885 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
1886 e = RD->bases_end(); i != e; ++i) {
1887 if (i->isVirtual())
1888 continue;
1889 const CXXRecordDecl *Base =
1890 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Mike Stump9eb76d42010-01-22 06:45:05 +00001891 uint64_t o = Offset + Layout.getBaseClassOffset(Base);
1892 StartNewTable();
1893 GenerateVtableForBase(Base, o, MorallyVirtual, false,
1894 true, Base == PrimaryBase && !PrimaryBaseWasVirtual,
1895 CurrentVBaseOffset, Path);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001896 }
Mike Stump37dbe962009-10-15 02:04:03 +00001897 Path->pop_back();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001898 }
1899
Mike Stumpb21c4ee2009-10-14 18:14:51 +00001900// #define D(X) do { X; } while (0)
1901#define D(X)
1902
1903 void insertVCalls(int InsertionPoint) {
Mike Stump75ce5732009-10-31 20:06:59 +00001904 D1(printf("============= combining vbase/vcall\n"));
Mike Stumpb21c4ee2009-10-14 18:14:51 +00001905 D(VCalls.insert(VCalls.begin(), 673));
1906 D(VCalls.push_back(672));
Eli Friedman6c08ce72009-12-05 01:05:03 +00001907
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00001908 VtableComponents.insert(VtableComponents.begin() + InsertionPoint,
1909 VCalls.size(), 0);
Eli Friedman6c08ce72009-12-05 01:05:03 +00001910 if (BuildVtable) {
1911 // The vcalls come first...
1912 for (std::vector<Index_t>::reverse_iterator i = VCalls.rbegin(),
1913 e = VCalls.rend();
1914 i != e; ++i)
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00001915 VtableComponents[InsertionPoint++] = wrap((0?600:0) + *i);
Eli Friedman6c08ce72009-12-05 01:05:03 +00001916 }
Mike Stumpb21c4ee2009-10-14 18:14:51 +00001917 VCalls.clear();
Mike Stump9f23a142009-11-10 02:30:51 +00001918 VCall.clear();
Mike Stumpa04ecfb2010-01-26 21:35:27 +00001919 VCallOffsetForVCall.clear();
1920 VCallOffset.clear();
1921 NonVirtualOffset.clear();
Mike Stumpb21c4ee2009-10-14 18:14:51 +00001922 }
1923
Mike Stump559387f2009-11-13 23:13:20 +00001924 void AddAddressPoints(const CXXRecordDecl *RD, uint64_t Offset,
1925 Index_t AddressPoint) {
1926 D1(printf("XXX address point for %s in %s layout %s at offset %d is %d\n",
Mike Stumpd2808442010-01-22 02:51:26 +00001927 RD->getNameAsCString(), MostDerivedClass->getNameAsCString(),
Mike Stump559387f2009-11-13 23:13:20 +00001928 LayoutClass->getNameAsCString(), (int)Offset, (int)AddressPoint));
Mike Stumpcd2b8212009-11-19 20:52:19 +00001929 subAddressPoints[std::make_pair(RD, Offset)] = AddressPoint;
Anders Carlsson5f9a8812010-01-14 02:29:07 +00001930 AddressPoints[BaseSubobject(RD, Offset)] = AddressPoint;
Mike Stump559387f2009-11-13 23:13:20 +00001931
1932 // Now also add the address point for all our primary bases.
1933 while (1) {
1934 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
1935 RD = Layout.getPrimaryBase();
1936 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
1937 // FIXME: Double check this.
1938 if (RD == 0)
1939 break;
1940 if (PrimaryBaseWasVirtual &&
1941 BLayout.getVBaseClassOffset(RD) != Offset)
1942 break;
1943 D1(printf("XXX address point for %s in %s layout %s at offset %d is %d\n",
Mike Stumpd2808442010-01-22 02:51:26 +00001944 RD->getNameAsCString(), MostDerivedClass->getNameAsCString(),
Mike Stump559387f2009-11-13 23:13:20 +00001945 LayoutClass->getNameAsCString(), (int)Offset, (int)AddressPoint));
Mike Stumpcd2b8212009-11-19 20:52:19 +00001946 subAddressPoints[std::make_pair(RD, Offset)] = AddressPoint;
Anders Carlsson5f9a8812010-01-14 02:29:07 +00001947 AddressPoints[BaseSubobject(RD, Offset)] = AddressPoint;
Mike Stump559387f2009-11-13 23:13:20 +00001948 }
1949 }
1950
1951
Mike Stumpd538a6d2009-12-24 07:29:41 +00001952 void FinishGenerateVtable(const CXXRecordDecl *RD,
1953 const ASTRecordLayout &Layout,
1954 const CXXRecordDecl *PrimaryBase,
Mike Stump9eb76d42010-01-22 06:45:05 +00001955 bool ForNPNVBases, bool WasPrimaryBase,
Mike Stumpd538a6d2009-12-24 07:29:41 +00001956 bool PrimaryBaseWasVirtual,
1957 bool MorallyVirtual, int64_t Offset,
1958 bool ForVirtualBase, int64_t CurrentVBaseOffset,
1959 Path_t *Path) {
Mike Stump37dbe962009-10-15 02:04:03 +00001960 bool alloc = false;
1961 if (Path == 0) {
1962 alloc = true;
1963 Path = new Path_t;
1964 }
1965
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001966 StartNewTable();
1967 extra = 0;
Mike Stump9eb76d42010-01-22 06:45:05 +00001968 Index_t AddressPoint = 0;
1969 int VCallInsertionPoint = 0;
1970 if (!ForNPNVBases || !WasPrimaryBase) {
1971 bool DeferVCalls = MorallyVirtual || ForVirtualBase;
1972 VCallInsertionPoint = VtableComponents.size();
1973 if (!DeferVCalls) {
1974 insertVCalls(VCallInsertionPoint);
1975 } else
1976 // FIXME: just for extra, or for all uses of VCalls.size post this?
1977 extra = -VCalls.size();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001978
Mike Stump9eb76d42010-01-22 06:45:05 +00001979 // Add the offset to top.
1980 VtableComponents.push_back(BuildVtable ? wrap(-((Offset-LayoutOffset)/8)) : 0);
Anders Carlsson472404f2009-12-04 16:19:30 +00001981
Mike Stump9eb76d42010-01-22 06:45:05 +00001982 // Add the RTTI information.
1983 VtableComponents.push_back(rtti);
Anders Carlsson472404f2009-12-04 16:19:30 +00001984
Mike Stump9eb76d42010-01-22 06:45:05 +00001985 AddressPoint = VtableComponents.size();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001986
Mike Stump9eb76d42010-01-22 06:45:05 +00001987 AppendMethodsToVtable();
1988 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001989
1990 // and then the non-virtual bases.
1991 NonVirtualBases(RD, Layout, PrimaryBase, PrimaryBaseWasVirtual,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00001992 MorallyVirtual, Offset, CurrentVBaseOffset, Path);
Mike Stumpb21c4ee2009-10-14 18:14:51 +00001993
1994 if (ForVirtualBase) {
Mike Stump2cefe382009-11-12 20:47:57 +00001995 // FIXME: We're adding to VCalls in callers, we need to do the overrides
1996 // in the inner part, so that we know the complete set of vcalls during
1997 // the build and don't have to insert into methods. Saving out the
1998 // AddressPoint here, would need to be fixed, if we didn't do that. Also
1999 // retroactively adding vcalls for overrides later wind up in the wrong
2000 // place, the vcall slot has to be alloted during the walk of the base
2001 // when the function is first introduces.
Mike Stumpb21c4ee2009-10-14 18:14:51 +00002002 AddressPoint += VCalls.size();
Mike Stump2cefe382009-11-12 20:47:57 +00002003 insertVCalls(VCallInsertionPoint);
Mike Stumpb21c4ee2009-10-14 18:14:51 +00002004 }
2005
Mike Stump9eb76d42010-01-22 06:45:05 +00002006 if (!ForNPNVBases || !WasPrimaryBase)
2007 AddAddressPoints(RD, Offset, AddressPoint);
Mike Stump2cefe382009-11-12 20:47:57 +00002008
Mike Stump37dbe962009-10-15 02:04:03 +00002009 if (alloc) {
2010 delete Path;
2011 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002012 }
2013
Mike Stump75ce5732009-10-31 20:06:59 +00002014 void Primaries(const CXXRecordDecl *RD, bool MorallyVirtual, int64_t Offset,
2015 bool updateVBIndex, Index_t current_vbindex,
Eli Friedman03aa2f12009-11-30 01:19:33 +00002016 int64_t CurrentVBaseOffset) {
Mike Stump75ce5732009-10-31 20:06:59 +00002017 if (!RD->isDynamicClass())
2018 return;
2019
2020 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
2021 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
2022 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
2023
2024 // vtables are composed from the chain of primaries.
Eli Friedman65d87222009-12-04 08:52:11 +00002025 if (PrimaryBase && !PrimaryBaseWasVirtual) {
Mike Stump75ce5732009-10-31 20:06:59 +00002026 D1(printf(" doing primaries for %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002027 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Eli Friedman65d87222009-12-04 08:52:11 +00002028 Primaries(PrimaryBase, PrimaryBaseWasVirtual|MorallyVirtual, Offset,
2029 updateVBIndex, current_vbindex, CurrentVBaseOffset);
Mike Stump75ce5732009-10-31 20:06:59 +00002030 }
2031
2032 D1(printf(" doing vcall entries for %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002033 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Mike Stump75ce5732009-10-31 20:06:59 +00002034
2035 // And add the virtuals for the class to the primary vtable.
Eli Friedman03aa2f12009-11-30 01:19:33 +00002036 AddMethods(RD, MorallyVirtual, Offset, CurrentVBaseOffset);
Mike Stump75ce5732009-10-31 20:06:59 +00002037 }
2038
2039 void VBPrimaries(const CXXRecordDecl *RD, bool MorallyVirtual, int64_t Offset,
2040 bool updateVBIndex, Index_t current_vbindex,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002041 bool RDisVirtualBase, int64_t CurrentVBaseOffset,
Eli Friedman03aa2f12009-11-30 01:19:33 +00002042 bool bottom) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002043 if (!RD->isDynamicClass())
2044 return;
2045
2046 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
2047 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
2048 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
2049
2050 // vtables are composed from the chain of primaries.
2051 if (PrimaryBase) {
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002052 int BaseCurrentVBaseOffset = CurrentVBaseOffset;
2053 if (PrimaryBaseWasVirtual) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002054 IndirectPrimary.insert(PrimaryBase);
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002055 BaseCurrentVBaseOffset = BLayout.getVBaseClassOffset(PrimaryBase);
2056 }
Mike Stump75ce5732009-10-31 20:06:59 +00002057
2058 D1(printf(" doing primaries for %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002059 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Mike Stump75ce5732009-10-31 20:06:59 +00002060
2061 VBPrimaries(PrimaryBase, PrimaryBaseWasVirtual|MorallyVirtual, Offset,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002062 updateVBIndex, current_vbindex, PrimaryBaseWasVirtual,
Eli Friedman03aa2f12009-11-30 01:19:33 +00002063 BaseCurrentVBaseOffset, false);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002064 }
2065
Mike Stump75ce5732009-10-31 20:06:59 +00002066 D1(printf(" doing vbase entries for %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002067 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Mike Stump75ce5732009-10-31 20:06:59 +00002068 GenerateVBaseOffsets(RD, Offset, updateVBIndex, current_vbindex);
2069
2070 if (RDisVirtualBase || bottom) {
2071 Primaries(RD, MorallyVirtual, Offset, updateVBIndex, current_vbindex,
Eli Friedman03aa2f12009-11-30 01:19:33 +00002072 CurrentVBaseOffset);
Mike Stump75ce5732009-10-31 20:06:59 +00002073 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002074 }
2075
Mike Stumpd538a6d2009-12-24 07:29:41 +00002076 void GenerateVtableForBase(const CXXRecordDecl *RD, int64_t Offset = 0,
2077 bool MorallyVirtual = false,
2078 bool ForVirtualBase = false,
Mike Stump9eb76d42010-01-22 06:45:05 +00002079 bool ForNPNVBases = false,
2080 bool WasPrimaryBase = true,
Mike Stumpd538a6d2009-12-24 07:29:41 +00002081 int CurrentVBaseOffset = 0,
2082 Path_t *Path = 0) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002083 if (!RD->isDynamicClass())
Mike Stumpd538a6d2009-12-24 07:29:41 +00002084 return;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002085
Mike Stumpfa818082009-11-13 02:35:38 +00002086 // Construction vtable don't need parts that have no virtual bases and
2087 // aren't morally virtual.
Anders Carlssonbad80eb2009-12-04 18:36:22 +00002088 if ((LayoutClass != MostDerivedClass) &&
2089 RD->getNumVBases() == 0 && !MorallyVirtual)
Mike Stumpd538a6d2009-12-24 07:29:41 +00002090 return;
Mike Stumpfa818082009-11-13 02:35:38 +00002091
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002092 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
2093 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
2094 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
2095
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002096 extra = 0;
Mike Stump75ce5732009-10-31 20:06:59 +00002097 D1(printf("building entries for base %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002098 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002099
Mike Stump75ce5732009-10-31 20:06:59 +00002100 if (ForVirtualBase)
2101 extra = VCalls.size();
2102
Mike Stump9eb76d42010-01-22 06:45:05 +00002103 if (!ForNPNVBases || !WasPrimaryBase) {
2104 VBPrimaries(RD, MorallyVirtual, Offset, !ForVirtualBase, 0,
2105 ForVirtualBase, CurrentVBaseOffset, true);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002106
Mike Stump9eb76d42010-01-22 06:45:05 +00002107 if (Path)
2108 OverrideMethods(Path, MorallyVirtual, Offset, CurrentVBaseOffset);
2109 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002110
Mike Stump9eb76d42010-01-22 06:45:05 +00002111 FinishGenerateVtable(RD, Layout, PrimaryBase, ForNPNVBases, WasPrimaryBase,
2112 PrimaryBaseWasVirtual, MorallyVirtual, Offset,
2113 ForVirtualBase, CurrentVBaseOffset, Path);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002114 }
2115
2116 void GenerateVtableForVBases(const CXXRecordDecl *RD,
2117 int64_t Offset = 0,
Mike Stump37dbe962009-10-15 02:04:03 +00002118 Path_t *Path = 0) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002119 bool alloc = false;
2120 if (Path == 0) {
2121 alloc = true;
Mike Stump37dbe962009-10-15 02:04:03 +00002122 Path = new Path_t;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002123 }
2124 // FIXME: We also need to override using all paths to a virtual base,
2125 // right now, we just process the first path
2126 Path->push_back(std::make_pair(RD, Offset));
2127 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
2128 e = RD->bases_end(); i != e; ++i) {
2129 const CXXRecordDecl *Base =
2130 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
2131 if (i->isVirtual() && !IndirectPrimary.count(Base)) {
2132 // Mark it so we don't output it twice.
2133 IndirectPrimary.insert(Base);
2134 StartNewTable();
Mike Stumpb21c4ee2009-10-14 18:14:51 +00002135 VCall.clear();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002136 int64_t BaseOffset = BLayout.getVBaseClassOffset(Base);
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002137 int64_t CurrentVBaseOffset = BaseOffset;
Mike Stump75ce5732009-10-31 20:06:59 +00002138 D1(printf("vtable %s virtual base %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002139 MostDerivedClass->getNameAsCString(), Base->getNameAsCString()));
Mike Stump9eb76d42010-01-22 06:45:05 +00002140 GenerateVtableForBase(Base, BaseOffset, true, true, false,
2141 true, CurrentVBaseOffset, Path);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002142 }
Mike Stump2cefe382009-11-12 20:47:57 +00002143 int64_t BaseOffset;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002144 if (i->isVirtual())
2145 BaseOffset = BLayout.getVBaseClassOffset(Base);
Mike Stump2cefe382009-11-12 20:47:57 +00002146 else {
2147 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
2148 BaseOffset = Offset + Layout.getBaseClassOffset(Base);
2149 }
2150
Mike Stump37dbe962009-10-15 02:04:03 +00002151 if (Base->getNumVBases()) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002152 GenerateVtableForVBases(Base, BaseOffset, Path);
Mike Stump37dbe962009-10-15 02:04:03 +00002153 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002154 }
2155 Path->pop_back();
2156 if (alloc)
2157 delete Path;
2158 }
2159};
Anders Carlssonca1bf682009-12-03 01:54:02 +00002160} // end anonymous namespace
2161
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002162bool OldVtableBuilder::OverrideMethod(GlobalDecl GD, bool MorallyVirtual,
Eli Friedman81fb0d22009-12-04 08:40:51 +00002163 Index_t OverrideOffset, Index_t Offset,
2164 int64_t CurrentVBaseOffset) {
Anders Carlssonca1bf682009-12-03 01:54:02 +00002165 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2166
2167 const bool isPure = MD->isPure();
Anders Carlsson21bbc1e2009-12-05 17:04:47 +00002168
Anders Carlssonca1bf682009-12-03 01:54:02 +00002169 // FIXME: Should OverrideOffset's be Offset?
2170
Anders Carlsson21bbc1e2009-12-05 17:04:47 +00002171 for (CXXMethodDecl::method_iterator mi = MD->begin_overridden_methods(),
2172 e = MD->end_overridden_methods(); mi != e; ++mi) {
Anders Carlssonca1bf682009-12-03 01:54:02 +00002173 GlobalDecl OGD;
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002174 GlobalDecl OGD2;
Anders Carlssonca1bf682009-12-03 01:54:02 +00002175
Anders Carlssonf3935b42009-12-04 05:51:56 +00002176 const CXXMethodDecl *OMD = *mi;
Anders Carlssonca1bf682009-12-03 01:54:02 +00002177 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(OMD))
2178 OGD = GlobalDecl(DD, GD.getDtorType());
2179 else
2180 OGD = OMD;
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002181
Eli Friedman8174f2c2009-12-06 22:01:30 +00002182 // Check whether this is the method being overridden in this section of
2183 // the vtable.
Anders Carlsson7bb70762009-12-04 15:49:02 +00002184 uint64_t Index;
2185 if (!Methods.getIndex(OGD, Index))
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002186 continue;
2187
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002188 OGD2 = OGD;
2189
Eli Friedman8174f2c2009-12-06 22:01:30 +00002190 // Get the original method, which we should be computing thunks, etc,
2191 // against.
2192 OGD = Methods.getOrigMethod(Index);
2193 OMD = cast<CXXMethodDecl>(OGD.getDecl());
2194
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002195 QualType ReturnType =
2196 MD->getType()->getAs<FunctionType>()->getResultType();
2197 QualType OverriddenReturnType =
2198 OMD->getType()->getAs<FunctionType>()->getResultType();
Anders Carlssonca1bf682009-12-03 01:54:02 +00002199
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002200 // Check if we need a return type adjustment.
Anders Carlssoncce9ee82010-02-13 23:17:31 +00002201 if (!ComputeReturnAdjustmentBaseOffset(CGM.getContext(), MD,
2202 OMD).isEmpty()) {
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002203 CanQualType &BaseReturnType = BaseReturnTypes[Index];
Anders Carlssonca1bf682009-12-03 01:54:02 +00002204
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002205 // Insert the base return type.
2206 if (BaseReturnType.isNull())
2207 BaseReturnType =
2208 CGM.getContext().getCanonicalType(OverriddenReturnType);
2209 }
Anders Carlssona93e9802009-12-04 03:52:52 +00002210
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002211 Methods.OverrideMethod(OGD, GD);
2212
Anders Carlsson72281172010-01-26 17:36:47 +00002213 GlobalDecl UGD = getUnique(GD);
2214 const CXXMethodDecl *UMD = cast<CXXMethodDecl>(UGD.getDecl());
2215 assert(UGD.getDecl() && "unique overrider not found");
2216 assert(UGD == getUnique(OGD) && "unique overrider not unique");
Mike Stump90181eb2010-01-26 00:05:04 +00002217
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002218 ThisAdjustments.erase(Index);
Mike Stump90181eb2010-01-26 00:05:04 +00002219 if (MorallyVirtual || VCall.count(UMD)) {
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002220
Mike Stump90181eb2010-01-26 00:05:04 +00002221 Index_t &idx = VCall[UMD];
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002222 if (idx == 0) {
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002223 VCallOffset[GD] = VCallOffset[OGD];
2224 // NonVirtualOffset[UMD] = CurrentVBaseOffset/8 - OverrideOffset/8;
2225 NonVirtualOffset[UMD] = VCallOffset[OGD];
Mike Stump77537b12010-01-26 03:42:22 +00002226 VCallOffsetForVCall[UMD] = OverrideOffset/8;
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002227 idx = VCalls.size()+1;
Mike Stump77537b12010-01-26 03:42:22 +00002228 VCalls.push_back(OverrideOffset/8 - CurrentVBaseOffset/8);
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002229 D1(printf(" vcall for %s at %d with delta %d most derived %s\n",
2230 MD->getNameAsString().c_str(), (int)-idx-3,
Mike Stumpd2808442010-01-22 02:51:26 +00002231 (int)VCalls[idx-1], MostDerivedClass->getNameAsCString()));
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002232 } else {
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002233 VCallOffset[GD] = NonVirtualOffset[UMD];
Anders Carlsson72281172010-01-26 17:36:47 +00002234 VCalls[idx-1] = -VCallOffsetForVCall[UGD] + OverrideOffset/8;
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002235 D1(printf(" vcall patch for %s at %d with delta %d most derived %s\n",
2236 MD->getNameAsString().c_str(), (int)-idx-3,
Mike Stumpd2808442010-01-22 02:51:26 +00002237 (int)VCalls[idx-1], MostDerivedClass->getNameAsCString()));
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002238 }
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002239 int64_t NonVirtualAdjustment = -VCallOffset[OGD];
Mike Stumpded0a402010-01-26 22:44:01 +00002240 QualType DerivedType = MD->getThisType(CGM.getContext());
2241 QualType BaseType = cast<const CXXMethodDecl>(OGD.getDecl())->getThisType(CGM.getContext());
2242 int64_t NonVirtualAdjustment2 = -(getNVOffset(BaseType, DerivedType)/8);
2243 if (NonVirtualAdjustment2 != NonVirtualAdjustment) {
2244 NonVirtualAdjustment = NonVirtualAdjustment2;
2245 }
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002246 int64_t VirtualAdjustment =
2247 -((idx + extra + 2) * LLVMPointerWidth / 8);
Anders Carlsson657f1392009-12-03 02:32:59 +00002248
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002249 // Optimize out virtual adjustments of 0.
2250 if (VCalls[idx-1] == 0)
2251 VirtualAdjustment = 0;
Anders Carlsson657f1392009-12-03 02:32:59 +00002252
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002253 ThunkAdjustment ThisAdjustment(NonVirtualAdjustment,
2254 VirtualAdjustment);
Anders Carlsson2ca285f2009-12-03 02:22:59 +00002255
Eli Friedman8174f2c2009-12-06 22:01:30 +00002256 if (!isPure && !ThisAdjustment.isEmpty()) {
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002257 ThisAdjustments[Index] = ThisAdjustment;
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002258 SavedAdjustments.push_back(
2259 std::make_pair(GD, std::make_pair(OGD, ThisAdjustment)));
Eli Friedman8174f2c2009-12-06 22:01:30 +00002260 }
Anders Carlssonca1bf682009-12-03 01:54:02 +00002261 return true;
2262 }
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002263
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002264 VCallOffset[GD] = VCallOffset[OGD2] - OverrideOffset/8;
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002265
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002266 int64_t NonVirtualAdjustment = -VCallOffset[GD];
2267 QualType DerivedType = MD->getThisType(CGM.getContext());
2268 QualType BaseType = cast<const CXXMethodDecl>(OGD.getDecl())->getThisType(CGM.getContext());
2269 int64_t NonVirtualAdjustment2 = -(getNVOffset(BaseType, DerivedType)/8);
2270 if (NonVirtualAdjustment2 != NonVirtualAdjustment) {
2271 NonVirtualAdjustment = NonVirtualAdjustment2;
2272 }
2273
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002274 if (NonVirtualAdjustment) {
2275 ThunkAdjustment ThisAdjustment(NonVirtualAdjustment, 0);
2276
Eli Friedmanf2eda5e2009-12-06 22:33:51 +00002277 if (!isPure) {
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002278 ThisAdjustments[Index] = ThisAdjustment;
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002279 SavedAdjustments.push_back(
2280 std::make_pair(GD, std::make_pair(OGD, ThisAdjustment)));
Eli Friedmanf2eda5e2009-12-06 22:33:51 +00002281 }
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002282 }
2283 return true;
Anders Carlssonca1bf682009-12-03 01:54:02 +00002284 }
2285
2286 return false;
Anders Carlssond59885022009-11-27 22:21:51 +00002287}
2288
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002289void OldVtableBuilder::AppendMethodsToVtable() {
Eli Friedman6c08ce72009-12-05 01:05:03 +00002290 if (!BuildVtable) {
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002291 VtableComponents.insert(VtableComponents.end(), Methods.size(),
2292 (llvm::Constant *)0);
Eli Friedman6c08ce72009-12-05 01:05:03 +00002293 ThisAdjustments.clear();
2294 BaseReturnTypes.clear();
2295 Methods.clear();
2296 return;
2297 }
2298
Anders Carlsson472404f2009-12-04 16:19:30 +00002299 // Reserve room in the vtable for our new methods.
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002300 VtableComponents.reserve(VtableComponents.size() + Methods.size());
Anders Carlssonb07567c2009-12-04 03:07:26 +00002301
Anders Carlsson86809cd2009-12-04 02:43:50 +00002302 for (unsigned i = 0, e = Methods.size(); i != e; ++i) {
2303 GlobalDecl GD = Methods[i];
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00002304 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2305
2306 // Get the 'this' pointer adjustment.
Anders Carlsson86809cd2009-12-04 02:43:50 +00002307 ThunkAdjustment ThisAdjustment = ThisAdjustments.lookup(i);
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00002308
2309 // Construct the return type adjustment.
2310 ThunkAdjustment ReturnAdjustment;
2311
2312 QualType BaseReturnType = BaseReturnTypes.lookup(i);
2313 if (!BaseReturnType.isNull() && !MD->isPure()) {
2314 QualType DerivedType =
2315 MD->getType()->getAs<FunctionType>()->getResultType();
2316
2317 int64_t NonVirtualAdjustment =
2318 getNVOffset(BaseReturnType, DerivedType) / 8;
2319
2320 int64_t VirtualAdjustment =
2321 getVbaseOffset(BaseReturnType, DerivedType);
2322
2323 ReturnAdjustment = ThunkAdjustment(NonVirtualAdjustment,
2324 VirtualAdjustment);
2325 }
2326
Anders Carlsson50f14742009-12-04 03:06:03 +00002327 llvm::Constant *Method = 0;
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00002328 if (!ReturnAdjustment.isEmpty()) {
2329 // Build a covariant thunk.
2330 CovariantThunkAdjustment Adjustment(ThisAdjustment, ReturnAdjustment);
Eli Friedman8174f2c2009-12-06 22:01:30 +00002331 Method = wrap(CGM.GetAddrOfCovariantThunk(GD, Adjustment));
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00002332 } else if (!ThisAdjustment.isEmpty()) {
2333 // Build a "regular" thunk.
Eli Friedman8174f2c2009-12-06 22:01:30 +00002334 Method = wrap(CGM.GetAddrOfThunk(GD, ThisAdjustment));
Anders Carlssonddf42c82009-12-04 02:56:03 +00002335 } else if (MD->isPure()) {
2336 // We have a pure virtual method.
Anders Carlsson50f14742009-12-04 03:06:03 +00002337 Method = getPureVirtualFn();
2338 } else {
2339 // We have a good old regular method.
2340 Method = WrapAddrOf(GD);
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00002341 }
Anders Carlsson50f14742009-12-04 03:06:03 +00002342
2343 // Add the method to the vtable.
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002344 VtableComponents.push_back(Method);
Anders Carlsson86809cd2009-12-04 02:43:50 +00002345 }
2346
Anders Carlsson50f14742009-12-04 03:06:03 +00002347
Anders Carlsson86809cd2009-12-04 02:43:50 +00002348 ThisAdjustments.clear();
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00002349 BaseReturnTypes.clear();
Anders Carlsson86809cd2009-12-04 02:43:50 +00002350
Anders Carlsson495634e2009-12-04 02:39:04 +00002351 Methods.clear();
Anders Carlsson495634e2009-12-04 02:39:04 +00002352}
2353
Anders Carlssonf942ee02009-11-27 20:47:55 +00002354void CGVtableInfo::ComputeMethodVtableIndices(const CXXRecordDecl *RD) {
2355
2356 // Itanium C++ ABI 2.5.2:
Anders Carlsson259688c2010-02-02 03:37:46 +00002357 // The order of the virtual function pointers in a virtual table is the
2358 // order of declaration of the corresponding member functions in the class.
Anders Carlssonf942ee02009-11-27 20:47:55 +00002359 //
Anders Carlsson259688c2010-02-02 03:37:46 +00002360 // There is an entry for any virtual function declared in a class,
2361 // whether it is a new function or overrides a base class function,
2362 // unless it overrides a function from the primary base, and conversion
2363 // between their return types does not require an adjustment.
Anders Carlssonf942ee02009-11-27 20:47:55 +00002364
2365 int64_t CurrentIndex = 0;
2366
2367 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
2368 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
2369
2370 if (PrimaryBase) {
Anders Carlssonc920fa22009-11-30 19:43:26 +00002371 assert(PrimaryBase->isDefinition() &&
2372 "Should have the definition decl of the primary base!");
Anders Carlssonf942ee02009-11-27 20:47:55 +00002373
2374 // Since the record decl shares its vtable pointer with the primary base
2375 // we need to start counting at the end of the primary base's vtable.
2376 CurrentIndex = getNumVirtualFunctionPointers(PrimaryBase);
2377 }
Eli Friedman21517252009-12-15 03:31:17 +00002378
2379 // Collect all the primary bases, so we can check whether methods override
2380 // a method from the base.
Anders Carlsson65b49782010-02-12 05:25:12 +00002381 VtableBuilder::PrimaryBasesSetTy PrimaryBases;
Eli Friedman21517252009-12-15 03:31:17 +00002382 for (ASTRecordLayout::primary_base_info_iterator
2383 I = Layout.primary_base_begin(), E = Layout.primary_base_end();
2384 I != E; ++I)
2385 PrimaryBases.insert((*I).getBase());
2386
Anders Carlssonf942ee02009-11-27 20:47:55 +00002387 const CXXDestructorDecl *ImplicitVirtualDtor = 0;
2388
2389 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
2390 e = RD->method_end(); i != e; ++i) {
2391 const CXXMethodDecl *MD = *i;
2392
2393 // We only want virtual methods.
2394 if (!MD->isVirtual())
2395 continue;
2396
Anders Carlssonf942ee02009-11-27 20:47:55 +00002397 // Check if this method overrides a method in the primary base.
Anders Carlsson65b49782010-02-12 05:25:12 +00002398 if (const CXXMethodDecl *OverriddenMD =
2399 OverridesMethodInPrimaryBase(MD, PrimaryBases)) {
2400 // Check if converting from the return type of the method to the
2401 // return type of the overridden method requires conversion.
Anders Carlssoncce9ee82010-02-13 23:17:31 +00002402 if (ComputeReturnAdjustmentBaseOffset(CGM.getContext(), MD,
2403 OverriddenMD).isEmpty()) {
Anders Carlsson65b49782010-02-12 05:25:12 +00002404 // This index is shared between the index in the vtable of the primary
2405 // base class.
2406 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2407 const CXXDestructorDecl *OverriddenDD =
2408 cast<CXXDestructorDecl>(OverriddenMD);
Anders Carlssonf942ee02009-11-27 20:47:55 +00002409
Anders Carlsson65b49782010-02-12 05:25:12 +00002410 // Add both the complete and deleting entries.
2411 MethodVtableIndices[GlobalDecl(DD, Dtor_Complete)] =
2412 getMethodVtableIndex(GlobalDecl(OverriddenDD, Dtor_Complete));
2413 MethodVtableIndices[GlobalDecl(DD, Dtor_Deleting)] =
2414 getMethodVtableIndex(GlobalDecl(OverriddenDD, Dtor_Deleting));
2415 } else {
2416 MethodVtableIndices[MD] = getMethodVtableIndex(OverriddenMD);
2417 }
2418
2419 // We don't need to add an entry for this method.
Anders Carlsson07604812010-02-12 18:14:46 +00002420 continue;
Anders Carlssonf942ee02009-11-27 20:47:55 +00002421 }
2422 }
2423
Anders Carlssonf942ee02009-11-27 20:47:55 +00002424 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2425 if (MD->isImplicit()) {
2426 assert(!ImplicitVirtualDtor &&
2427 "Did already see an implicit virtual dtor!");
2428 ImplicitVirtualDtor = DD;
2429 continue;
2430 }
2431
2432 // Add the complete dtor.
2433 MethodVtableIndices[GlobalDecl(DD, Dtor_Complete)] = CurrentIndex++;
2434
2435 // Add the deleting dtor.
2436 MethodVtableIndices[GlobalDecl(DD, Dtor_Deleting)] = CurrentIndex++;
2437 } else {
2438 // Add the entry.
2439 MethodVtableIndices[MD] = CurrentIndex++;
2440 }
2441 }
2442
2443 if (ImplicitVirtualDtor) {
2444 // Itanium C++ ABI 2.5.2:
Anders Carlssondc2dba32010-02-16 04:49:44 +00002445 // If a class has an implicitly-defined virtual destructor,
2446 // its entries come after the declared virtual function pointers.
Anders Carlssonf942ee02009-11-27 20:47:55 +00002447
2448 // Add the complete dtor.
2449 MethodVtableIndices[GlobalDecl(ImplicitVirtualDtor, Dtor_Complete)] =
2450 CurrentIndex++;
2451
2452 // Add the deleting dtor.
2453 MethodVtableIndices[GlobalDecl(ImplicitVirtualDtor, Dtor_Deleting)] =
2454 CurrentIndex++;
2455 }
2456
2457 NumVirtualFunctionPointers[RD] = CurrentIndex;
2458}
2459
2460uint64_t CGVtableInfo::getNumVirtualFunctionPointers(const CXXRecordDecl *RD) {
2461 llvm::DenseMap<const CXXRecordDecl *, uint64_t>::iterator I =
2462 NumVirtualFunctionPointers.find(RD);
2463 if (I != NumVirtualFunctionPointers.end())
2464 return I->second;
2465
2466 ComputeMethodVtableIndices(RD);
2467
2468 I = NumVirtualFunctionPointers.find(RD);
2469 assert(I != NumVirtualFunctionPointers.end() && "Did not find entry!");
2470 return I->second;
2471}
2472
2473uint64_t CGVtableInfo::getMethodVtableIndex(GlobalDecl GD) {
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002474 MethodVtableIndicesTy::iterator I = MethodVtableIndices.find(GD);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002475 if (I != MethodVtableIndices.end())
2476 return I->second;
2477
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002478 const CXXRecordDecl *RD = cast<CXXMethodDecl>(GD.getDecl())->getParent();
Anders Carlssonf942ee02009-11-27 20:47:55 +00002479
2480 ComputeMethodVtableIndices(RD);
2481
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002482 I = MethodVtableIndices.find(GD);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002483 assert(I != MethodVtableIndices.end() && "Did not find index!");
2484 return I->second;
2485}
2486
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002487CGVtableInfo::AdjustmentVectorTy*
2488CGVtableInfo::getAdjustments(GlobalDecl GD) {
2489 SavedAdjustmentsTy::iterator I = SavedAdjustments.find(GD);
2490 if (I != SavedAdjustments.end())
2491 return &I->second;
Eli Friedman8174f2c2009-12-06 22:01:30 +00002492
2493 const CXXRecordDecl *RD = cast<CXXRecordDecl>(GD.getDecl()->getDeclContext());
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002494 if (!SavedAdjustmentRecords.insert(RD).second)
2495 return 0;
Eli Friedman8174f2c2009-12-06 22:01:30 +00002496
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002497 AddressPointsMapTy AddressPoints;
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002498 OldVtableBuilder b(RD, RD, 0, CGM, false, AddressPoints);
Eli Friedman8174f2c2009-12-06 22:01:30 +00002499 D1(printf("vtable %s\n", RD->getNameAsCString()));
2500 b.GenerateVtableForBase(RD);
2501 b.GenerateVtableForVBases(RD);
Eli Friedman8174f2c2009-12-06 22:01:30 +00002502
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002503 for (OldVtableBuilder::SavedAdjustmentsVectorTy::iterator
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002504 i = b.getSavedAdjustments().begin(),
2505 e = b.getSavedAdjustments().end(); i != e; i++)
2506 SavedAdjustments[i->first].push_back(i->second);
Eli Friedman8174f2c2009-12-06 22:01:30 +00002507
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002508 I = SavedAdjustments.find(GD);
2509 if (I != SavedAdjustments.end())
2510 return &I->second;
2511
2512 return 0;
Eli Friedman8174f2c2009-12-06 22:01:30 +00002513}
2514
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002515int64_t CGVtableInfo::getVirtualBaseOffsetIndex(const CXXRecordDecl *RD,
2516 const CXXRecordDecl *VBase) {
2517 ClassPairTy ClassPair(RD, VBase);
2518
2519 VirtualBaseClassIndiciesTy::iterator I =
2520 VirtualBaseClassIndicies.find(ClassPair);
2521 if (I != VirtualBaseClassIndicies.end())
2522 return I->second;
2523
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002524 // FIXME: This seems expensive. Can we do a partial job to get
2525 // just this data.
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002526 AddressPointsMapTy AddressPoints;
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002527 OldVtableBuilder b(RD, RD, 0, CGM, false, AddressPoints);
Mike Stump75ce5732009-10-31 20:06:59 +00002528 D1(printf("vtable %s\n", RD->getNameAsCString()));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002529 b.GenerateVtableForBase(RD);
2530 b.GenerateVtableForVBases(RD);
2531
2532 for (llvm::DenseMap<const CXXRecordDecl *, uint64_t>::iterator I =
2533 b.getVBIndex().begin(), E = b.getVBIndex().end(); I != E; ++I) {
2534 // Insert all types.
2535 ClassPairTy ClassPair(RD, I->first);
2536
2537 VirtualBaseClassIndicies.insert(std::make_pair(ClassPair, I->second));
2538 }
2539
2540 I = VirtualBaseClassIndicies.find(ClassPair);
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00002541 // FIXME: The assertion below assertion currently fails with the old vtable
2542 /// layout code if there is a non-virtual thunk adjustment in a vtable.
2543 // Once the new layout is in place, this return should be removed.
2544 if (I == VirtualBaseClassIndicies.end())
2545 return 0;
2546
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002547 assert(I != VirtualBaseClassIndicies.end() && "Did not find index!");
2548
2549 return I->second;
2550}
2551
Anders Carlssonc8e39ec2009-12-05 21:03:56 +00002552uint64_t CGVtableInfo::getVtableAddressPoint(const CXXRecordDecl *RD) {
2553 uint64_t AddressPoint =
Anders Carlsson93a18842010-01-02 18:02:32 +00002554 (*(*(CGM.getVtableInfo().AddressPoints[RD]))[RD])[std::make_pair(RD, 0)];
Anders Carlssonc8e39ec2009-12-05 21:03:56 +00002555
2556 return AddressPoint;
2557}
2558
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00002559llvm::GlobalVariable *
Anders Carlsson0911ae82009-12-06 00:23:49 +00002560CGVtableInfo::GenerateVtable(llvm::GlobalVariable::LinkageTypes Linkage,
Anders Carlsson232324c2009-12-06 00:53:22 +00002561 bool GenerateDefinition,
Anders Carlsson0911ae82009-12-06 00:23:49 +00002562 const CXXRecordDecl *LayoutClass,
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002563 const CXXRecordDecl *RD, uint64_t Offset,
2564 AddressPointsMapTy& AddressPoints) {
Anders Carlsson1888b442010-02-14 00:22:59 +00002565 if (GenerateDefinition && CGM.getLangOptions().DumpVtableLayouts &&
2566 LayoutClass == RD) {
Anders Carlssoncf5a8822010-02-13 21:07:32 +00002567 VtableBuilder Builder(*this, RD);
Anders Carlssoneee53d92010-02-13 02:02:03 +00002568
2569 Builder.dumpLayout(llvm::errs());
2570 }
2571
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002572 llvm::SmallString<256> OutName;
Mike Stump2cefe382009-11-12 20:47:57 +00002573 if (LayoutClass != RD)
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00002574 CGM.getMangleContext().mangleCXXCtorVtable(LayoutClass, Offset / 8,
2575 RD, OutName);
Mike Stumpeac45592009-11-11 20:26:26 +00002576 else
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00002577 CGM.getMangleContext().mangleCXXVtable(RD, OutName);
Daniel Dunbare128dd12009-11-21 09:06:22 +00002578 llvm::StringRef Name = OutName.str();
Benjamin Kramerbb0a07b2009-10-11 22:57:54 +00002579
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00002580 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name);
Anders Carlsson93a18842010-01-02 18:02:32 +00002581 if (GV == 0 || CGM.getVtableInfo().AddressPoints[LayoutClass] == 0 ||
2582 GV->isDeclaration()) {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002583 OldVtableBuilder b(RD, LayoutClass, Offset, CGM, GenerateDefinition,
2584 AddressPoints);
Eli Friedman6c08ce72009-12-05 01:05:03 +00002585
2586 D1(printf("vtable %s\n", RD->getNameAsCString()));
2587 // First comes the vtables for all the non-virtual bases...
Mike Stumpd538a6d2009-12-24 07:29:41 +00002588 b.GenerateVtableForBase(RD, Offset);
Eli Friedman6c08ce72009-12-05 01:05:03 +00002589
2590 // then the vtables for all the virtual bases.
2591 b.GenerateVtableForVBases(RD, Offset);
2592
Anders Carlsson58b271d2009-12-05 22:19:10 +00002593 llvm::Constant *Init = 0;
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00002594 const llvm::Type *Int8PtrTy = llvm::Type::getInt8PtrTy(CGM.getLLVMContext());
Anders Carlsson58b271d2009-12-05 22:19:10 +00002595 llvm::ArrayType *ArrayType =
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002596 llvm::ArrayType::get(Int8PtrTy, b.getVtableComponents().size());
Anders Carlssona95d4c52009-12-05 21:09:05 +00002597
Anders Carlsson232324c2009-12-06 00:53:22 +00002598 if (GenerateDefinition)
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002599 Init = llvm::ConstantArray::get(ArrayType, &b.getVtableComponents()[0],
2600 b.getVtableComponents().size());
Anders Carlsson232324c2009-12-06 00:53:22 +00002601
Mike Stumpaa51ad62009-11-19 04:04:36 +00002602 llvm::GlobalVariable *OGV = GV;
Anders Carlsson232324c2009-12-06 00:53:22 +00002603
2604 GV = new llvm::GlobalVariable(CGM.getModule(), ArrayType,
2605 /*isConstant=*/true, Linkage, Init, Name);
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002606 CGM.setGlobalVisibility(GV, RD);
2607
Mike Stumpaa51ad62009-11-19 04:04:36 +00002608 if (OGV) {
2609 GV->takeName(OGV);
Anders Carlsson58b271d2009-12-05 22:19:10 +00002610 llvm::Constant *NewPtr =
2611 llvm::ConstantExpr::getBitCast(GV, OGV->getType());
Mike Stumpaa51ad62009-11-19 04:04:36 +00002612 OGV->replaceAllUsesWith(NewPtr);
2613 OGV->eraseFromParent();
2614 }
Mike Stumpaa51ad62009-11-19 04:04:36 +00002615 }
Anders Carlssonb3f54b72009-12-05 21:28:12 +00002616
2617 return GV;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002618}
Mike Stump9f23a142009-11-10 02:30:51 +00002619
Anders Carlsson232324c2009-12-06 00:53:22 +00002620void CGVtableInfo::GenerateClassData(llvm::GlobalVariable::LinkageTypes Linkage,
2621 const CXXRecordDecl *RD) {
Anders Carlssone1b3e622009-12-07 07:59:52 +00002622 llvm::GlobalVariable *&Vtable = Vtables[RD];
2623 if (Vtable) {
2624 assert(Vtable->getInitializer() && "Vtable doesn't have a definition!");
2625 return;
2626 }
2627
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002628 AddressPointsMapTy AddressPoints;
2629 Vtable = GenerateVtable(Linkage, /*GenerateDefinition=*/true, RD, RD, 0,
2630 AddressPoints);
Anders Carlssone36a6b32010-01-02 01:01:18 +00002631 GenerateVTT(Linkage, /*GenerateDefinition=*/true, RD);
Mike Stump1a139f82009-11-19 01:08:19 +00002632}
2633
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00002634llvm::GlobalVariable *CGVtableInfo::getVtable(const CXXRecordDecl *RD) {
Anders Carlsson232324c2009-12-06 00:53:22 +00002635 llvm::GlobalVariable *Vtable = Vtables.lookup(RD);
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00002636
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002637 if (!Vtable) {
2638 AddressPointsMapTy AddressPoints;
Anders Carlsson232324c2009-12-06 00:53:22 +00002639 Vtable = GenerateVtable(llvm::GlobalValue::ExternalLinkage,
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002640 /*GenerateDefinition=*/false, RD, RD, 0,
2641 AddressPoints);
2642 }
Mike Stumpaa51ad62009-11-19 04:04:36 +00002643
Anders Carlsson4ed44eb2009-12-05 22:42:54 +00002644 return Vtable;
Mike Stumpd846d082009-11-10 07:44:33 +00002645}
Mike Stumpeac45592009-11-11 20:26:26 +00002646
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002647void CGVtableInfo::MaybeEmitVtable(GlobalDecl GD) {
2648 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2649 const CXXRecordDecl *RD = MD->getParent();
2650
Anders Carlsson4ed44eb2009-12-05 22:42:54 +00002651 // If the class doesn't have a vtable we don't need to emit one.
2652 if (!RD->isDynamicClass())
2653 return;
2654
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002655 // Get the key function.
Anders Carlsson5ebf8b42009-12-07 04:35:11 +00002656 const CXXMethodDecl *KeyFunction = CGM.getContext().getKeyFunction(RD);
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002657
Anders Carlsson4ed44eb2009-12-05 22:42:54 +00002658 if (KeyFunction) {
2659 // We don't have the right key function.
2660 if (KeyFunction->getCanonicalDecl() != MD->getCanonicalDecl())
2661 return;
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002662 }
2663
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002664 // Emit the data.
Douglas Gregorccecc1b2010-01-06 20:27:16 +00002665 GenerateClassData(CGM.getVtableLinkage(RD), RD);
Eli Friedman8174f2c2009-12-06 22:01:30 +00002666
2667 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
2668 e = RD->method_end(); i != e; ++i) {
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002669 if ((*i)->isVirtual() && ((*i)->hasInlineBody() || (*i)->isImplicit())) {
Eli Friedman8174f2c2009-12-06 22:01:30 +00002670 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(*i)) {
2671 CGM.BuildThunksForVirtual(GlobalDecl(DD, Dtor_Complete));
2672 CGM.BuildThunksForVirtual(GlobalDecl(DD, Dtor_Deleting));
2673 } else {
2674 CGM.BuildThunksForVirtual(GlobalDecl(*i));
2675 }
2676 }
2677 }
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002678}
2679