blob: 6199c055b709fe1117c92769a21696a3b32c367a [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 Carlsson65b49782010-02-12 05:25:12 +0000821
Anders Carlssondc2dba32010-02-16 04:49:44 +0000822 /// LayoutVtable - Layout a vtable and all its secondary vtables.
823 void LayoutVtable(BaseSubobject Base);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000824
Anders Carlsson14157932010-02-16 16:02:57 +0000825 /// LayoutSecondaryVtables - Layout the secondary vtables for the given base
826 /// subobject.
827 void LayoutSecondaryVtables(BaseSubobject Base);
828
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000829public:
Anders Carlssoncf5a8822010-02-13 21:07:32 +0000830 VtableBuilder(CGVtableInfo &VtableInfo, const CXXRecordDecl *MostDerivedClass)
831 : VtableInfo(VtableInfo), MostDerivedClass(MostDerivedClass),
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000832 Context(MostDerivedClass->getASTContext()), Overriders(MostDerivedClass) {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000833
Anders Carlssondc2dba32010-02-16 04:49:44 +0000834 LayoutVtable(BaseSubobject(MostDerivedClass, 0));
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000835 }
836
837 /// dumpLayout - Dump the vtable layout.
838 void dumpLayout(llvm::raw_ostream&);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000839};
840
Anders Carlsson65b49782010-02-12 05:25:12 +0000841/// OverridesMethodInPrimaryBase - Checks whether whether this virtual member
842/// function overrides a member function in a direct or indirect primary base.
843/// Returns the overridden member function, or null if none was found.
844static const CXXMethodDecl *
845OverridesMethodInPrimaryBase(const CXXMethodDecl *MD,
846 VtableBuilder::PrimaryBasesSetTy &PrimaryBases) {
847 for (CXXMethodDecl::method_iterator I = MD->begin_overridden_methods(),
848 E = MD->end_overridden_methods(); I != E; ++I) {
849 const CXXMethodDecl *OverriddenMD = *I;
850 const CXXRecordDecl *OverriddenRD = OverriddenMD->getParent();
851 assert(OverriddenMD->isCanonicalDecl() &&
852 "Should have the canonical decl of the overridden RD!");
853
854 if (PrimaryBases.count(OverriddenRD))
855 return OverriddenMD;
856 }
857
858 return 0;
859}
860
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000861VtableBuilder::ReturnAdjustment
862VtableBuilder::ComputeReturnAdjustment(FinalOverriders::BaseOffset Offset) {
863 ReturnAdjustment Adjustment;
864
865 if (!Offset.isEmpty()) {
Anders Carlssoncf5a8822010-02-13 21:07:32 +0000866 if (Offset.VirtualBase) {
867 // Get the virtual base offset offset.
868 Adjustment.VBaseOffsetOffset =
869 VtableInfo.getVirtualBaseOffsetIndex(Offset.DerivedClass,
870 Offset.VirtualBase);
871 // FIXME: Once the assert in getVirtualBaseOffsetIndex is back again,
872 // we can get rid of this assert.
873 assert(Adjustment.VBaseOffsetOffset != 0 &&
874 "Invalid base offset offset!");
875 }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000876
877 Adjustment.NonVirtual = Offset.NonVirtualOffset;
878 }
879
880 return Adjustment;
881}
882
Anders Carlssond3adb0c2010-02-13 23:40:17 +0000883VtableBuilder::ThisAdjustment
884VtableBuilder::ComputeThisAdjustment(FinalOverriders::BaseOffset Offset) {
885 ThisAdjustment Adjustment;
886
887 if (!Offset.isEmpty()) {
888 assert(!Offset.VirtualBase && "FIXME: Handle virtual bases!");
889 Adjustment.NonVirtual = Offset.NonVirtualOffset;
890 }
891
892 return Adjustment;
893}
894
Anders Carlsson65b49782010-02-12 05:25:12 +0000895void
Anders Carlssondc2dba32010-02-16 04:49:44 +0000896VtableBuilder::AddVCallAndVBaseOffsets(const CXXRecordDecl *RD,
897 int64_t OffsetToTop,
898 VisitedVirtualBasesSetTy &VBases) {
899 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
900
901 // Itanium C++ ABI 2.5.2:
902 // ..in classes sharing a virtual table with a primary base class, the vcall
903 // and vbase offsets added by the derived class all come before the vcall
904 // and vbase offsets required by the base class, so that the latter may be
905 // laid out as required by the base class without regard to additions from
906 // the derived class(es).
907
908 // (Since we're emitting the vcall and vbase offsets in reverse order, we'll
909 // emit them for the primary base first).
910 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase())
911 AddVCallAndVBaseOffsets(PrimaryBase, OffsetToTop, VBases);
912
913 AddVBaseOffsets(RD, OffsetToTop, VBases);
914}
915
916void VtableBuilder::AddVBaseOffsets(const CXXRecordDecl *RD,
917 int64_t OffsetToTop,
918 VisitedVirtualBasesSetTy &VBases) {
Anders Carlsson77904f12010-02-16 04:59:55 +0000919 const ASTRecordLayout &MostDerivedClassLayout =
920 Context.getASTRecordLayout(MostDerivedClass);
921
922 // Add vbase offsets.
923 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
924 E = RD->bases_end(); I != E; ++I) {
925 const CXXRecordDecl *BaseDecl =
926 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
927
928 // Check if this is a virtual base that we haven't visited before.
929 if (I->isVirtual() && VBases.insert(BaseDecl)) {
930 // FIXME: We shouldn't use / 8 here.
931 uint64_t Offset =
932 OffsetToTop + MostDerivedClassLayout.getVBaseClassOffset(BaseDecl) / 8;
933
934 VCallAndVBaseOffsets.push_back(VtableComponent::MakeVBaseOffset(Offset));
935 }
936
937 // Check the base class looking for more vbase offsets.
938 AddVBaseOffsets(BaseDecl, OffsetToTop, VBases);
939 }
Anders Carlssondc2dba32010-02-16 04:49:44 +0000940}
941
942void
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000943VtableBuilder::AddMethod(const CXXMethodDecl *MD,
Anders Carlssond3adb0c2010-02-13 23:40:17 +0000944 ReturnAdjustment ReturnAdjustment,
945 ThisAdjustment ThisAdjustment) {
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000946 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
947 assert(ReturnAdjustment.isEmpty() &&
948 "Destructor can't have return adjustment!");
Anders Carlssond3adb0c2010-02-13 23:40:17 +0000949 // Add the 'this' pointer adjustments if necessary.
950 if (!ThisAdjustment.isEmpty()) {
951 ThisAdjustments.push_back(std::make_pair(Components.size(),
952 ThisAdjustment));
953 ThisAdjustments.push_back(std::make_pair(Components.size() + 1,
954 ThisAdjustment));
955 }
956
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000957 // Add both the complete destructor and the deleting destructor.
958 Components.push_back(VtableComponent::MakeCompleteDtor(DD));
959 Components.push_back(VtableComponent::MakeDeletingDtor(DD));
960 } else {
961 // Add the return adjustment if necessary.
962 if (!ReturnAdjustment.isEmpty())
963 ReturnAdjustments.push_back(std::make_pair(Components.size(),
964 ReturnAdjustment));
965
Anders Carlssond3adb0c2010-02-13 23:40:17 +0000966 // Add the 'this' pointer adjustment if necessary.
967 if (!ThisAdjustment.isEmpty())
968 ThisAdjustments.push_back(std::make_pair(Components.size(),
969 ThisAdjustment));
970
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000971 // Add the function.
972 Components.push_back(VtableComponent::MakeFunction(MD));
973 }
974}
975
976void
977VtableBuilder::AddMethods(BaseSubobject Base, PrimaryBasesSetTy &PrimaryBases) {
Anders Carlsson65b49782010-02-12 05:25:12 +0000978 const CXXRecordDecl *RD = Base.getBase();
979
980 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
981
982 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
983 if (Layout.getPrimaryBaseWasVirtual())
984 assert(false && "FIXME: Handle vbases here.");
985 else
986 assert(Layout.getBaseClassOffset(PrimaryBase) == 0 &&
987 "Primary base should have a zero offset!");
988
Anders Carlssone75aaa92010-02-13 22:05:23 +0000989 AddMethods(BaseSubobject(PrimaryBase, Base.getBaseOffset()), PrimaryBases);
Anders Carlsson65b49782010-02-12 05:25:12 +0000990
991 if (!PrimaryBases.insert(PrimaryBase))
992 assert(false && "Found a duplicate primary base!");
993 }
Anders Carlsson932c2f22010-02-11 17:18:51 +0000994
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000995 // Now go through all virtual member functions and add them.
996 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
997 E = RD->method_end(); I != E; ++I) {
998 const CXXMethodDecl *MD = *I;
Anders Carlsson65b49782010-02-12 05:25:12 +0000999
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001000 if (!MD->isVirtual())
1001 continue;
Anders Carlsson65b49782010-02-12 05:25:12 +00001002
1003 // Get the final overrider.
Anders Carlsson136bd192010-02-12 16:55:34 +00001004 FinalOverriders::OverriderInfo Overrider =
1005 Overriders.getOverrider(Base, MD);
Anders Carlsson65b49782010-02-12 05:25:12 +00001006
1007 // Check if this virtual member function overrides a method in a primary
1008 // base. If this is the case, and the return type doesn't require adjustment
1009 // then we can just use the member function from the primary base.
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001010 if (const CXXMethodDecl *OverriddenMD =
1011 OverridesMethodInPrimaryBase(MD, PrimaryBases)) {
Anders Carlssoncce9ee82010-02-13 23:17:31 +00001012 if (ComputeReturnAdjustmentBaseOffset(Context, MD,
1013 OverriddenMD).isEmpty())
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001014 continue;
1015 }
Anders Carlssoneee53d92010-02-13 02:02:03 +00001016
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001017 // Check if this overrider needs a return adjustment.
1018 FinalOverriders::BaseOffset ReturnAdjustmentOffset =
1019 Overriders.getReturnAdjustmentOffset(Base, MD);
1020
1021 ReturnAdjustment ReturnAdjustment =
1022 ComputeReturnAdjustment(ReturnAdjustmentOffset);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001023
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001024 // Check if this overrider needs a 'this' pointer adjustment.
1025 FinalOverriders::BaseOffset ThisAdjustmentOffset =
1026 Overriders.getThisAdjustmentOffset(Base, MD);
1027
1028 ThisAdjustment ThisAdjustment = ComputeThisAdjustment(ThisAdjustmentOffset);
1029
1030 AddMethod(Overrider.Method, ReturnAdjustment, ThisAdjustment);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001031 }
1032}
1033
Anders Carlssondc2dba32010-02-16 04:49:44 +00001034void VtableBuilder::LayoutVtable(BaseSubobject Base) {
Anders Carlsson65b49782010-02-12 05:25:12 +00001035 const CXXRecordDecl *RD = Base.getBase();
Anders Carlsson033d4862010-02-14 17:05:59 +00001036 assert(RD->isDynamicClass() && "class does not have a vtable!");
1037
Anders Carlsson77904f12010-02-16 04:59:55 +00001038 int64_t OffsetToTop = -(int64_t)Base.getBaseOffset() / 8;
1039
1040 // Add vcall and vbase offsets for this vtable.
1041 VisitedVirtualBasesSetTy VBases;
1042 AddVCallAndVBaseOffsets(RD, OffsetToTop, VBases);
1043
1044 // Reverse them and add them to the vtable components.
1045 std::reverse(VCallAndVBaseOffsets.begin(), VCallAndVBaseOffsets.end());
1046 Components.append(VCallAndVBaseOffsets.begin(), VCallAndVBaseOffsets.end());
1047 VCallAndVBaseOffsets.clear();
1048
1049 // Add the offset to top.
Anders Carlssone75aaa92010-02-13 22:05:23 +00001050 // FIXME: This is not going to be right for construction vtables.
Anders Carlsson258a1e32010-02-14 00:16:19 +00001051 // FIXME: We should not use / 8 here.
Anders Carlssone75aaa92010-02-13 22:05:23 +00001052 Components.push_back(VtableComponent::MakeOffsetToTop(OffsetToTop));
Anders Carlsson65b49782010-02-12 05:25:12 +00001053
1054 // Next, add the RTTI.
Anders Carlssone75aaa92010-02-13 22:05:23 +00001055 Components.push_back(VtableComponent::MakeRTTI(MostDerivedClass));
Anders Carlsson65b49782010-02-12 05:25:12 +00001056
Anders Carlssone8a97562010-02-12 07:43:48 +00001057 uint64_t AddressPoint = Components.size();
Anders Carlsson65b49782010-02-12 05:25:12 +00001058
1059 // Now go through all virtual member functions and add them.
1060 PrimaryBasesSetTy PrimaryBases;
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001061 AddMethods(Base, PrimaryBases);
Anders Carlsson65b49782010-02-12 05:25:12 +00001062
Anders Carlssone8a97562010-02-12 07:43:48 +00001063 // Record the address point.
1064 AddressPoints.insert(std::make_pair(Base, AddressPoint));
1065
1066 // Record the address points for all primary bases.
1067 for (PrimaryBasesSetTy::const_iterator I = PrimaryBases.begin(),
1068 E = PrimaryBases.end(); I != E; ++I) {
1069 const CXXRecordDecl *BaseDecl = *I;
1070
1071 // We know that all the primary bases have the same offset as the base
1072 // subobject.
1073 BaseSubobject PrimaryBase(BaseDecl, Base.getBaseOffset());
1074 AddressPoints.insert(std::make_pair(PrimaryBase, AddressPoint));
1075 }
1076
Anders Carlsson14157932010-02-16 16:02:57 +00001077 // Layout secondary vtables.
1078 LayoutSecondaryVtables(Base);
1079
1080 // FIXME: Emit vtables for virtual bases here.
1081}
1082
1083void VtableBuilder::LayoutSecondaryVtables(BaseSubobject Base) {
1084 // Itanium C++ ABI 2.5.2:
1085 // Following the primary virtual table of a derived class are secondary
1086 // virtual tables for each of its proper base classes, except any primary
1087 // base(s) with which it shares its primary virtual table.
1088
1089 const CXXRecordDecl *RD = Base.getBase();
Anders Carlsson65b49782010-02-12 05:25:12 +00001090 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1091 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
Anders Carlsson14157932010-02-16 16:02:57 +00001092
Anders Carlsson65b49782010-02-12 05:25:12 +00001093 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1094 E = RD->bases_end(); I != E; ++I) {
Anders Carlsson14157932010-02-16 16:02:57 +00001095 // Ignore virtual bases, we'll emit them later.
1096 if (I->isVirtual())
1097 continue;
1098
Anders Carlsson65b49782010-02-12 05:25:12 +00001099 const CXXRecordDecl *BaseDecl =
1100 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson033d4862010-02-14 17:05:59 +00001101
Anders Carlssondc2dba32010-02-16 04:49:44 +00001102 // Ignore bases that don't have a vtable.
1103 if (!BaseDecl->isDynamicClass())
1104 continue;
Anders Carlsson033d4862010-02-14 17:05:59 +00001105
Anders Carlssone75aaa92010-02-13 22:05:23 +00001106 // Get the base offset of this base.
1107 uint64_t BaseOffset = Base.getBaseOffset() +
1108 Layout.getBaseClassOffset(BaseDecl);
Anders Carlsson14157932010-02-16 16:02:57 +00001109
1110 // Don't emit a secondary vtable for a primary base. We might however want
1111 // to emit secondary vtables for other bases of this base.
1112 if (BaseDecl == PrimaryBase) {
1113 LayoutSecondaryVtables(BaseSubobject(BaseDecl, BaseOffset));
1114 continue;
1115 }
Anders Carlssone75aaa92010-02-13 22:05:23 +00001116
1117 // Layout this secondary vtable.
Anders Carlssondc2dba32010-02-16 04:49:44 +00001118 LayoutVtable(BaseSubobject(BaseDecl, BaseOffset));
Anders Carlsson65b49782010-02-12 05:25:12 +00001119 }
1120}
1121
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001122/// dumpLayout - Dump the vtable layout.
1123void VtableBuilder::dumpLayout(llvm::raw_ostream& Out) {
1124
1125 Out << "Vtable for '" << MostDerivedClass->getQualifiedNameAsString();
1126 Out << "' (" << Components.size() << " entries).\n";
1127
Anders Carlsson932c2f22010-02-11 17:18:51 +00001128 // Iterate through the address points and insert them into a new map where
1129 // they are keyed by the index and not the base object.
1130 // Since an address point can be shared by multiple subobjects, we use an
1131 // STL multimap.
1132 std::multimap<uint64_t, BaseSubobject> AddressPointsByIndex;
1133 for (CGVtableInfo::AddressPointsMapTy::const_iterator I =
1134 AddressPoints.begin(), E = AddressPoints.end(); I != E; ++I) {
1135 const BaseSubobject& Base = I->first;
1136 uint64_t Index = I->second;
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001137
Anders Carlsson932c2f22010-02-11 17:18:51 +00001138 AddressPointsByIndex.insert(std::make_pair(Index, Base));
1139 }
1140
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001141 unsigned NextReturnAdjustmentIndex = 0;
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001142 unsigned NextThisAdjustmentIndex = 0;
Anders Carlsson932c2f22010-02-11 17:18:51 +00001143 for (unsigned I = 0, E = Components.size(); I != E; ++I) {
Anders Carlssone8a97562010-02-12 07:43:48 +00001144 uint64_t Index = I;
1145
Anders Carlsson932c2f22010-02-11 17:18:51 +00001146 if (AddressPointsByIndex.count(I)) {
Anders Carlssone8a97562010-02-12 07:43:48 +00001147 if (AddressPointsByIndex.count(Index) == 1) {
1148 const BaseSubobject &Base = AddressPointsByIndex.find(Index)->second;
1149
1150 // FIXME: Instead of dividing by 8, we should be using CharUnits.
1151 Out << " -- (" << Base.getBase()->getQualifiedNameAsString();
1152 Out << ", " << Base.getBaseOffset() / 8 << ") vtable address --\n";
1153 } else {
1154 uint64_t BaseOffset =
1155 AddressPointsByIndex.lower_bound(Index)->second.getBaseOffset();
1156
1157 // We store the class names in a set to get a stable order.
1158 std::set<std::string> ClassNames;
1159 for (std::multimap<uint64_t, BaseSubobject>::const_iterator I =
1160 AddressPointsByIndex.lower_bound(Index), E =
1161 AddressPointsByIndex.upper_bound(Index); I != E; ++I) {
1162 assert(I->second.getBaseOffset() == BaseOffset &&
1163 "Invalid base offset!");
1164 const CXXRecordDecl *RD = I->second.getBase();
1165 ClassNames.insert(RD->getQualifiedNameAsString());
1166 }
1167
1168 for (std::set<std::string>::const_iterator I = ClassNames.begin(),
1169 E = ClassNames.end(); I != E; ++I) {
1170 // FIXME: Instead of dividing by 8, we should be using CharUnits.
1171 Out << " -- (" << *I;
1172 Out << ", " << BaseOffset / 8 << ") vtable address --\n";
1173 }
1174 }
Anders Carlsson932c2f22010-02-11 17:18:51 +00001175 }
1176
1177 Out << llvm::format("%4d | ", I);
1178
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001179 const VtableComponent &Component = Components[I];
1180
1181 // Dump the component.
1182 switch (Component.getKind()) {
1183 // FIXME: Remove this default case.
1184 default:
1185 assert(false && "Unhandled component kind!");
1186 break;
Anders Carlsson77904f12010-02-16 04:59:55 +00001187
1188 case VtableComponent::CK_VBaseOffset:
1189 Out << "vbase_offset (" << Component.getVBaseOffset() << ")";
1190 break;
1191
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001192 case VtableComponent::CK_OffsetToTop:
1193 Out << "offset_to_top (" << Component.getOffsetToTop() << ")";
1194 break;
1195
1196 case VtableComponent::CK_RTTI:
1197 Out << Component.getRTTIDecl()->getQualifiedNameAsString() << " RTTI";
1198 break;
1199
Anders Carlsson5bd8d192010-02-11 18:20:28 +00001200 case VtableComponent::CK_FunctionPointer: {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001201 const CXXMethodDecl *MD = Component.getFunctionDecl();
1202
Anders Carlsson5bd8d192010-02-11 18:20:28 +00001203 std::string Str =
1204 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
1205 MD);
1206 Out << Str;
Anders Carlsson09da3372010-02-12 02:38:13 +00001207 if (MD->isPure())
1208 Out << " [pure]";
1209
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001210 // If this function pointer has a return adjustment, dump it.
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001211 if (NextReturnAdjustmentIndex < ReturnAdjustments.size() &&
1212 ReturnAdjustments[NextReturnAdjustmentIndex].first == I) {
1213 const ReturnAdjustment Adjustment =
1214 ReturnAdjustments[NextReturnAdjustmentIndex].second;
1215
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001216 Out << "\n [return adjustment: ";
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001217 Out << Adjustment.NonVirtual << " non-virtual";
1218
1219 if (Adjustment.VBaseOffsetOffset)
1220 Out << ", " << Adjustment.VBaseOffsetOffset << " vbase offset offset";
1221 Out << ']';
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001222
1223 NextReturnAdjustmentIndex++;
1224 }
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001225
1226 // If this function pointer has a 'this' pointer adjustment, dump it.
1227 if (NextThisAdjustmentIndex < ThisAdjustments.size() &&
1228 ThisAdjustments[NextThisAdjustmentIndex].first == I) {
1229 const ThisAdjustment Adjustment =
1230 ThisAdjustments[NextThisAdjustmentIndex].second;
1231
1232 Out << "\n [this adjustment: ";
1233 Out << Adjustment.NonVirtual << " non-virtual";
1234
1235 Out << ']';
1236
1237 NextThisAdjustmentIndex++;
1238 }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001239
Anders Carlsson5bd8d192010-02-11 18:20:28 +00001240 break;
1241 }
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001242
Anders Carlsson5bd8d192010-02-11 18:20:28 +00001243 case VtableComponent::CK_CompleteDtorPointer: {
1244 const CXXDestructorDecl *DD = Component.getDestructorDecl();
1245
1246 Out << DD->getQualifiedNameAsString() << "() [complete]";
Anders Carlsson09da3372010-02-12 02:38:13 +00001247 if (DD->isPure())
1248 Out << " [pure]";
1249
Anders Carlsson5bd8d192010-02-11 18:20:28 +00001250 break;
1251 }
1252
1253 case VtableComponent::CK_DeletingDtorPointer: {
1254 const CXXDestructorDecl *DD = Component.getDestructorDecl();
1255
1256 Out << DD->getQualifiedNameAsString() << "() [deleting]";
Anders Carlsson09da3372010-02-12 02:38:13 +00001257 if (DD->isPure())
1258 Out << " [pure]";
1259
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001260 break;
1261 }
1262
1263 }
Anders Carlsson932c2f22010-02-11 17:18:51 +00001264
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001265 Out << '\n';
1266 }
1267
1268}
1269
1270}
1271
1272namespace {
1273class OldVtableBuilder {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001274public:
1275 /// Index_t - Vtable index type.
1276 typedef uint64_t Index_t;
Eli Friedman31bc3ad2009-12-07 23:56:34 +00001277 typedef std::vector<std::pair<GlobalDecl,
1278 std::pair<GlobalDecl, ThunkAdjustment> > >
1279 SavedAdjustmentsVectorTy;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001280private:
Anders Carlsson472404f2009-12-04 16:19:30 +00001281
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00001282 // VtableComponents - The components of the vtable being built.
1283 typedef llvm::SmallVector<llvm::Constant *, 64> VtableComponentsVectorTy;
1284 VtableComponentsVectorTy VtableComponents;
1285
Eli Friedman6c08ce72009-12-05 01:05:03 +00001286 const bool BuildVtable;
1287
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001288 llvm::Type *Ptr8Ty;
Anders Carlssonbad80eb2009-12-04 18:36:22 +00001289
1290 /// MostDerivedClass - The most derived class that this vtable is being
1291 /// built for.
1292 const CXXRecordDecl *MostDerivedClass;
1293
Mike Stump83066c82009-11-13 01:54:23 +00001294 /// LayoutClass - The most derived class used for virtual base layout
1295 /// information.
1296 const CXXRecordDecl *LayoutClass;
Mike Stump653d0b92009-11-13 02:13:54 +00001297 /// LayoutOffset - The offset for Class in LayoutClass.
1298 uint64_t LayoutOffset;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001299 /// BLayout - Layout for the most derived class that this vtable is being
1300 /// built for.
1301 const ASTRecordLayout &BLayout;
1302 llvm::SmallSet<const CXXRecordDecl *, 32> IndirectPrimary;
1303 llvm::SmallSet<const CXXRecordDecl *, 32> SeenVBase;
1304 llvm::Constant *rtti;
1305 llvm::LLVMContext &VMContext;
1306 CodeGenModule &CGM; // Per-module state.
Anders Carlssonf2f31f42009-12-04 03:46:21 +00001307
Mike Stump90181eb2010-01-26 00:05:04 +00001308 llvm::DenseMap<const CXXMethodDecl *, Index_t> VCall;
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001309 llvm::DenseMap<GlobalDecl, Index_t> VCallOffset;
Mike Stump77537b12010-01-26 03:42:22 +00001310 llvm::DenseMap<GlobalDecl, Index_t> VCallOffsetForVCall;
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00001311 // This is the offset to the nearest virtual base
Mike Stump90181eb2010-01-26 00:05:04 +00001312 llvm::DenseMap<const CXXMethodDecl *, Index_t> NonVirtualOffset;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001313 llvm::DenseMap<const CXXRecordDecl *, Index_t> VBIndex;
Mike Stumpbb9ff052009-10-27 23:46:47 +00001314
Anders Carlsson323bb042009-11-26 19:54:33 +00001315 /// PureVirtualFunction - Points to __cxa_pure_virtual.
1316 llvm::Constant *PureVirtualFn;
1317
Anders Carlssona84b6e82009-12-04 02:01:07 +00001318 /// VtableMethods - A data structure for keeping track of methods in a vtable.
1319 /// Can add methods, override methods and iterate in vtable order.
1320 class VtableMethods {
1321 // MethodToIndexMap - Maps from a global decl to the index it has in the
1322 // Methods vector.
1323 llvm::DenseMap<GlobalDecl, uint64_t> MethodToIndexMap;
1324
1325 /// Methods - The methods, in vtable order.
1326 typedef llvm::SmallVector<GlobalDecl, 16> MethodsVectorTy;
1327 MethodsVectorTy Methods;
Eli Friedman8174f2c2009-12-06 22:01:30 +00001328 MethodsVectorTy OrigMethods;
Anders Carlssona84b6e82009-12-04 02:01:07 +00001329
1330 public:
1331 /// AddMethod - Add a method to the vtable methods.
1332 void AddMethod(GlobalDecl GD) {
1333 assert(!MethodToIndexMap.count(GD) &&
1334 "Method has already been added!");
1335
1336 MethodToIndexMap[GD] = Methods.size();
1337 Methods.push_back(GD);
Eli Friedman8174f2c2009-12-06 22:01:30 +00001338 OrigMethods.push_back(GD);
Anders Carlssona84b6e82009-12-04 02:01:07 +00001339 }
1340
1341 /// OverrideMethod - Replace a method with another.
1342 void OverrideMethod(GlobalDecl OverriddenGD, GlobalDecl GD) {
1343 llvm::DenseMap<GlobalDecl, uint64_t>::iterator i
1344 = MethodToIndexMap.find(OverriddenGD);
1345 assert(i != MethodToIndexMap.end() && "Did not find entry!");
1346
1347 // Get the index of the old decl.
1348 uint64_t Index = i->second;
1349
1350 // Replace the old decl with the new decl.
1351 Methods[Index] = GD;
1352
Anders Carlssona84b6e82009-12-04 02:01:07 +00001353 // And add the new.
1354 MethodToIndexMap[GD] = Index;
1355 }
1356
Anders Carlsson7bb70762009-12-04 15:49:02 +00001357 /// getIndex - Gives the index of a passed in GlobalDecl. Returns false if
1358 /// the index couldn't be found.
Benjamin Kramer62ab6162009-12-04 22:45:27 +00001359 bool getIndex(GlobalDecl GD, uint64_t &Index) const {
Anders Carlsson7bb70762009-12-04 15:49:02 +00001360 llvm::DenseMap<GlobalDecl, uint64_t>::const_iterator i
1361 = MethodToIndexMap.find(GD);
Eli Friedman3d2e9de2009-12-04 08:34:14 +00001362
Anders Carlsson7bb70762009-12-04 15:49:02 +00001363 if (i == MethodToIndexMap.end())
1364 return false;
Anders Carlssone6096362009-12-04 03:41:37 +00001365
Anders Carlsson7bb70762009-12-04 15:49:02 +00001366 Index = i->second;
1367 return true;
Anders Carlssone6096362009-12-04 03:41:37 +00001368 }
1369
Eli Friedman8174f2c2009-12-06 22:01:30 +00001370 GlobalDecl getOrigMethod(uint64_t Index) const {
1371 return OrigMethods[Index];
1372 }
1373
Anders Carlssona84b6e82009-12-04 02:01:07 +00001374 MethodsVectorTy::size_type size() const {
1375 return Methods.size();
1376 }
1377
1378 void clear() {
1379 MethodToIndexMap.clear();
1380 Methods.clear();
Eli Friedman8174f2c2009-12-06 22:01:30 +00001381 OrigMethods.clear();
Anders Carlssona84b6e82009-12-04 02:01:07 +00001382 }
1383
Anders Carlssone6096362009-12-04 03:41:37 +00001384 GlobalDecl operator[](uint64_t Index) const {
Anders Carlssona84b6e82009-12-04 02:01:07 +00001385 return Methods[Index];
1386 }
1387 };
1388
1389 /// Methods - The vtable methods we're currently building.
1390 VtableMethods Methods;
1391
Anders Carlsson4c837d22009-12-04 02:26:15 +00001392 /// ThisAdjustments - For a given index in the vtable, contains the 'this'
1393 /// pointer adjustment needed for a method.
1394 typedef llvm::DenseMap<uint64_t, ThunkAdjustment> ThisAdjustmentsMapTy;
1395 ThisAdjustmentsMapTy ThisAdjustments;
Anders Carlssond420a312009-11-26 19:32:45 +00001396
Eli Friedman31bc3ad2009-12-07 23:56:34 +00001397 SavedAdjustmentsVectorTy SavedAdjustments;
Eli Friedman8174f2c2009-12-06 22:01:30 +00001398
Anders Carlssonc521f952009-12-04 02:22:02 +00001399 /// BaseReturnTypes - Contains the base return types of methods who have been
1400 /// overridden with methods whose return types require adjustment. Used for
1401 /// generating covariant thunk information.
1402 typedef llvm::DenseMap<uint64_t, CanQualType> BaseReturnTypesMapTy;
1403 BaseReturnTypesMapTy BaseReturnTypes;
Anders Carlssond420a312009-11-26 19:32:45 +00001404
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001405 std::vector<Index_t> VCalls;
Mike Stump2cefe382009-11-12 20:47:57 +00001406
1407 typedef std::pair<const CXXRecordDecl *, uint64_t> CtorVtable_t;
Mike Stumpcd2b8212009-11-19 20:52:19 +00001408 // subAddressPoints - Used to hold the AddressPoints (offsets) into the built
1409 // vtable for use in computing the initializers for the VTT.
1410 llvm::DenseMap<CtorVtable_t, int64_t> &subAddressPoints;
Mike Stump2cefe382009-11-12 20:47:57 +00001411
Anders Carlsson5f9a8812010-01-14 02:29:07 +00001412 /// AddressPoints - Address points for this vtable.
1413 CGVtableInfo::AddressPointsMapTy& AddressPoints;
1414
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001415 typedef CXXRecordDecl::method_iterator method_iter;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001416 const uint32_t LLVMPointerWidth;
1417 Index_t extra;
Mike Stump37dbe962009-10-15 02:04:03 +00001418 typedef std::vector<std::pair<const CXXRecordDecl *, int64_t> > Path_t;
Mike Stumpcd2b8212009-11-19 20:52:19 +00001419 static llvm::DenseMap<CtorVtable_t, int64_t>&
1420 AllocAddressPoint(CodeGenModule &cgm, const CXXRecordDecl *l,
1421 const CXXRecordDecl *c) {
Anders Carlsson93a18842010-01-02 18:02:32 +00001422 CGVtableInfo::AddrMap_t *&oref = cgm.getVtableInfo().AddressPoints[l];
Mike Stumpcd2b8212009-11-19 20:52:19 +00001423 if (oref == 0)
Anders Carlsson93a18842010-01-02 18:02:32 +00001424 oref = new CGVtableInfo::AddrMap_t;
Mike Stumpcd2b8212009-11-19 20:52:19 +00001425
1426 llvm::DenseMap<CtorVtable_t, int64_t> *&ref = (*oref)[c];
1427 if (ref == 0)
1428 ref = new llvm::DenseMap<CtorVtable_t, int64_t>;
1429 return *ref;
1430 }
Anders Carlsson323bb042009-11-26 19:54:33 +00001431
Mike Stump90181eb2010-01-26 00:05:04 +00001432 bool DclIsSame(const FunctionDecl *New, const FunctionDecl *Old) {
1433 FunctionTemplateDecl *OldTemplate = Old->getDescribedFunctionTemplate();
1434 FunctionTemplateDecl *NewTemplate = New->getDescribedFunctionTemplate();
1435
1436 // C++ [temp.fct]p2:
1437 // A function template can be overloaded with other function templates
1438 // and with normal (non-template) functions.
1439 if ((OldTemplate == 0) != (NewTemplate == 0))
1440 return false;
1441
1442 // Is the function New an overload of the function Old?
1443 QualType OldQType = CGM.getContext().getCanonicalType(Old->getType());
1444 QualType NewQType = CGM.getContext().getCanonicalType(New->getType());
1445
1446 // Compare the signatures (C++ 1.3.10) of the two functions to
1447 // determine whether they are overloads. If we find any mismatch
1448 // in the signature, they are overloads.
1449
1450 // If either of these functions is a K&R-style function (no
1451 // prototype), then we consider them to have matching signatures.
1452 if (isa<FunctionNoProtoType>(OldQType.getTypePtr()) ||
1453 isa<FunctionNoProtoType>(NewQType.getTypePtr()))
1454 return true;
1455
1456 FunctionProtoType* OldType = cast<FunctionProtoType>(OldQType);
1457 FunctionProtoType* NewType = cast<FunctionProtoType>(NewQType);
1458
1459 // The signature of a function includes the types of its
1460 // parameters (C++ 1.3.10), which includes the presence or absence
1461 // of the ellipsis; see C++ DR 357).
1462 if (OldQType != NewQType &&
1463 (OldType->getNumArgs() != NewType->getNumArgs() ||
1464 OldType->isVariadic() != NewType->isVariadic() ||
1465 !std::equal(OldType->arg_type_begin(), OldType->arg_type_end(),
1466 NewType->arg_type_begin())))
1467 return false;
1468
1469#if 0
1470 // C++ [temp.over.link]p4:
1471 // The signature of a function template consists of its function
1472 // signature, its return type and its template parameter list. The names
1473 // of the template parameters are significant only for establishing the
1474 // relationship between the template parameters and the rest of the
1475 // signature.
1476 //
1477 // We check the return type and template parameter lists for function
1478 // templates first; the remaining checks follow.
1479 if (NewTemplate &&
1480 (!TemplateParameterListsAreEqual(NewTemplate->getTemplateParameters(),
1481 OldTemplate->getTemplateParameters(),
1482 TPL_TemplateMatch) ||
1483 OldType->getResultType() != NewType->getResultType()))
1484 return false;
1485#endif
1486
1487 // If the function is a class member, its signature includes the
1488 // cv-qualifiers (if any) on the function itself.
1489 //
1490 // As part of this, also check whether one of the member functions
1491 // is static, in which case they are not overloads (C++
1492 // 13.1p2). While not part of the definition of the signature,
1493 // this check is important to determine whether these functions
1494 // can be overloaded.
1495 const CXXMethodDecl* OldMethod = dyn_cast<CXXMethodDecl>(Old);
1496 const CXXMethodDecl* NewMethod = dyn_cast<CXXMethodDecl>(New);
1497 if (OldMethod && NewMethod &&
1498 !OldMethod->isStatic() && !NewMethod->isStatic() &&
1499 OldMethod->getTypeQualifiers() != NewMethod->getTypeQualifiers())
1500 return false;
1501
1502 // The signatures match; this is not an overload.
1503 return true;
1504 }
1505
1506 typedef llvm::DenseMap<const CXXMethodDecl *, const CXXMethodDecl*>
1507 ForwardUnique_t;
1508 ForwardUnique_t ForwardUnique;
1509 llvm::DenseMap<const CXXMethodDecl*, const CXXMethodDecl*> UniqueOverrider;
1510
1511 void BuildUniqueOverrider(const CXXMethodDecl *U, const CXXMethodDecl *MD) {
1512 const CXXMethodDecl *PrevU = UniqueOverrider[MD];
1513 assert(U && "no unique overrider");
1514 if (PrevU == U)
1515 return;
1516 if (PrevU != U && PrevU != 0) {
1517 // If already set, note the two sets as the same
1518 if (0)
1519 printf("%s::%s same as %s::%s\n",
1520 PrevU->getParent()->getNameAsCString(),
1521 PrevU->getNameAsCString(),
1522 U->getParent()->getNameAsCString(),
1523 U->getNameAsCString());
1524 ForwardUnique[PrevU] = U;
1525 return;
1526 }
1527
1528 // Not set, set it now
1529 if (0)
1530 printf("marking %s::%s %p override as %s::%s\n",
1531 MD->getParent()->getNameAsCString(),
1532 MD->getNameAsCString(),
1533 (void*)MD,
1534 U->getParent()->getNameAsCString(),
1535 U->getNameAsCString());
1536 UniqueOverrider[MD] = U;
1537
1538 for (CXXMethodDecl::method_iterator mi = MD->begin_overridden_methods(),
1539 me = MD->end_overridden_methods(); mi != me; ++mi) {
1540 BuildUniqueOverrider(U, *mi);
1541 }
1542 }
1543
1544 void BuildUniqueOverriders(const CXXRecordDecl *RD) {
1545 if (0) printf("walking %s\n", RD->getNameAsCString());
1546 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
1547 e = RD->method_end(); i != e; ++i) {
1548 const CXXMethodDecl *MD = *i;
1549 if (!MD->isVirtual())
1550 continue;
1551
1552 if (UniqueOverrider[MD] == 0) {
1553 // Only set this, if it hasn't been set yet.
1554 BuildUniqueOverrider(MD, MD);
1555 if (0)
1556 printf("top set is %s::%s %p\n",
1557 MD->getParent()->getNameAsCString(),
1558 MD->getNameAsCString(),
1559 (void*)MD);
1560 ForwardUnique[MD] = MD;
1561 }
1562 }
1563 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
1564 e = RD->bases_end(); i != e; ++i) {
1565 const CXXRecordDecl *Base =
1566 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
1567 BuildUniqueOverriders(Base);
1568 }
1569 }
1570
1571 static int DclCmp(const void *p1, const void *p2) {
John McCallef3057c2010-02-13 01:04:05 +00001572 const CXXMethodDecl *MD1 = *(const CXXMethodDecl *const *)p1;
1573 const CXXMethodDecl *MD2 = *(const CXXMethodDecl *const *)p2;
1574
1575 return (DeclarationName::compare(MD1->getDeclName(), MD2->getDeclName()));
Mike Stump90181eb2010-01-26 00:05:04 +00001576 }
1577
1578 void MergeForwarding() {
1579 typedef llvm::SmallVector<const CXXMethodDecl *, 100> A_t;
1580 A_t A;
1581 for (ForwardUnique_t::iterator I = ForwardUnique.begin(),
1582 E = ForwardUnique.end(); I != E; ++I) {
1583 if (I->first == I->second)
1584 // Only add the roots of all trees
1585 A.push_back(I->first);
1586 }
1587 llvm::array_pod_sort(A.begin(), A.end(), DclCmp);
1588 for (A_t::iterator I = A.begin(),
1589 E = A.end(); I != E; ++I) {
1590 A_t::iterator J = I;
John McCallef3057c2010-02-13 01:04:05 +00001591 while (++J != E && DclCmp(I, J) == 0)
Mike Stump90181eb2010-01-26 00:05:04 +00001592 if (DclIsSame(*I, *J)) {
Eli Friedman18c28f62010-02-13 00:03:21 +00001593 if (0) printf("connecting %s\n", (*I)->getNameAsCString());
Mike Stump90181eb2010-01-26 00:05:04 +00001594 ForwardUnique[*J] = *I;
1595 }
1596 }
1597 }
1598
1599 const CXXMethodDecl *getUnique(const CXXMethodDecl *MD) {
1600 const CXXMethodDecl *U = UniqueOverrider[MD];
1601 assert(U && "unique overrider not found");
1602 while (ForwardUnique.count(U)) {
1603 const CXXMethodDecl *NU = ForwardUnique[U];
1604 if (NU == U) break;
1605 U = NU;
1606 }
1607 return U;
1608 }
Anders Carlsson72281172010-01-26 17:36:47 +00001609
1610 GlobalDecl getUnique(GlobalDecl GD) {
1611 const CXXMethodDecl *Unique = getUnique(cast<CXXMethodDecl>(GD.getDecl()));
1612
1613 if (const CXXConstructorDecl *CD = dyn_cast<CXXConstructorDecl>(Unique))
1614 return GlobalDecl(CD, GD.getCtorType());
1615
1616 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(Unique))
1617 return GlobalDecl(DD, GD.getDtorType());
1618
1619 return Unique;
Mike Stump90181eb2010-01-26 00:05:04 +00001620 }
1621
Anders Carlsson323bb042009-11-26 19:54:33 +00001622 /// getPureVirtualFn - Return the __cxa_pure_virtual function.
1623 llvm::Constant* getPureVirtualFn() {
1624 if (!PureVirtualFn) {
1625 const llvm::FunctionType *Ty =
1626 llvm::FunctionType::get(llvm::Type::getVoidTy(VMContext),
1627 /*isVarArg=*/false);
1628 PureVirtualFn = wrap(CGM.CreateRuntimeFunction(Ty, "__cxa_pure_virtual"));
1629 }
1630
1631 return PureVirtualFn;
1632 }
1633
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001634public:
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001635 OldVtableBuilder(const CXXRecordDecl *MostDerivedClass,
Eli Friedman6c08ce72009-12-05 01:05:03 +00001636 const CXXRecordDecl *l, uint64_t lo, CodeGenModule &cgm,
Anders Carlsson5f9a8812010-01-14 02:29:07 +00001637 bool build, CGVtableInfo::AddressPointsMapTy& AddressPoints)
Eli Friedman6c08ce72009-12-05 01:05:03 +00001638 : BuildVtable(build), MostDerivedClass(MostDerivedClass), LayoutClass(l),
1639 LayoutOffset(lo), BLayout(cgm.getContext().getASTRecordLayout(l)),
1640 rtti(0), VMContext(cgm.getModule().getContext()),CGM(cgm),
1641 PureVirtualFn(0),
Anders Carlssonbad80eb2009-12-04 18:36:22 +00001642 subAddressPoints(AllocAddressPoint(cgm, l, MostDerivedClass)),
Anders Carlsson5f9a8812010-01-14 02:29:07 +00001643 AddressPoints(AddressPoints),
1644 LLVMPointerWidth(cgm.getContext().Target.getPointerWidth(0))
1645 {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001646 Ptr8Ty = llvm::PointerType::get(llvm::Type::getInt8Ty(VMContext), 0);
Anders Carlsson3f4336c2009-12-17 07:09:17 +00001647 if (BuildVtable) {
1648 QualType ClassType = CGM.getContext().getTagDeclType(MostDerivedClass);
1649 rtti = CGM.GetAddrOfRTTIDescriptor(ClassType);
1650 }
Mike Stump90181eb2010-01-26 00:05:04 +00001651 BuildUniqueOverriders(MostDerivedClass);
1652 MergeForwarding();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001653 }
1654
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00001655 // getVtableComponents - Returns a reference to the vtable components.
1656 const VtableComponentsVectorTy &getVtableComponents() const {
1657 return VtableComponents;
Anders Carlsson472404f2009-12-04 16:19:30 +00001658 }
1659
Anders Carlssone36a6b32010-01-02 01:01:18 +00001660 llvm::DenseMap<const CXXRecordDecl *, uint64_t> &getVBIndex()
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001661 { return VBIndex; }
1662
Eli Friedman31bc3ad2009-12-07 23:56:34 +00001663 SavedAdjustmentsVectorTy &getSavedAdjustments()
1664 { return SavedAdjustments; }
Eli Friedman8174f2c2009-12-06 22:01:30 +00001665
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001666 llvm::Constant *wrap(Index_t i) {
1667 llvm::Constant *m;
1668 m = llvm::ConstantInt::get(llvm::Type::getInt64Ty(VMContext), i);
1669 return llvm::ConstantExpr::getIntToPtr(m, Ptr8Ty);
1670 }
1671
1672 llvm::Constant *wrap(llvm::Constant *m) {
1673 return llvm::ConstantExpr::getBitCast(m, Ptr8Ty);
1674 }
1675
Mike Stumpd2808442010-01-22 02:51:26 +00001676//#define D1(x)
1677#define D1(X) do { if (getenv("DEBUG")) { X; } } while (0)
Mike Stump75ce5732009-10-31 20:06:59 +00001678
1679 void GenerateVBaseOffsets(const CXXRecordDecl *RD, uint64_t Offset,
Mike Stump28431212009-10-13 22:54:56 +00001680 bool updateVBIndex, Index_t current_vbindex) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001681 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
1682 e = RD->bases_end(); i != e; ++i) {
1683 const CXXRecordDecl *Base =
1684 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Mike Stump28431212009-10-13 22:54:56 +00001685 Index_t next_vbindex = current_vbindex;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001686 if (i->isVirtual() && !SeenVBase.count(Base)) {
1687 SeenVBase.insert(Base);
Mike Stump28431212009-10-13 22:54:56 +00001688 if (updateVBIndex) {
Mike Stump75ce5732009-10-31 20:06:59 +00001689 next_vbindex = (ssize_t)(-(VCalls.size()*LLVMPointerWidth/8)
Mike Stump28431212009-10-13 22:54:56 +00001690 - 3*LLVMPointerWidth/8);
1691 VBIndex[Base] = next_vbindex;
1692 }
Mike Stump75ce5732009-10-31 20:06:59 +00001693 int64_t BaseOffset = -(Offset/8) + BLayout.getVBaseClassOffset(Base)/8;
1694 VCalls.push_back((0?700:0) + BaseOffset);
1695 D1(printf(" vbase for %s at %d delta %d most derived %s\n",
1696 Base->getNameAsCString(),
1697 (int)-VCalls.size()-3, (int)BaseOffset,
Mike Stumpd2808442010-01-22 02:51:26 +00001698 MostDerivedClass->getNameAsCString()));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001699 }
Mike Stump28431212009-10-13 22:54:56 +00001700 // We also record offsets for non-virtual bases to closest enclosing
1701 // virtual base. We do this so that we don't have to search
1702 // for the nearst virtual base class when generating thunks.
1703 if (updateVBIndex && VBIndex.count(Base) == 0)
1704 VBIndex[Base] = next_vbindex;
Mike Stump75ce5732009-10-31 20:06:59 +00001705 GenerateVBaseOffsets(Base, Offset, updateVBIndex, next_vbindex);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001706 }
1707 }
1708
1709 void StartNewTable() {
1710 SeenVBase.clear();
1711 }
1712
Mike Stump8bccbfd2009-10-15 09:30:16 +00001713 Index_t getNVOffset_1(const CXXRecordDecl *D, const CXXRecordDecl *B,
1714 Index_t Offset = 0) {
1715
1716 if (B == D)
1717 return Offset;
1718
1719 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(D);
1720 for (CXXRecordDecl::base_class_const_iterator i = D->bases_begin(),
1721 e = D->bases_end(); i != e; ++i) {
1722 const CXXRecordDecl *Base =
1723 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
1724 int64_t BaseOffset = 0;
1725 if (!i->isVirtual())
1726 BaseOffset = Offset + Layout.getBaseClassOffset(Base);
1727 int64_t o = getNVOffset_1(Base, B, BaseOffset);
1728 if (o >= 0)
1729 return o;
1730 }
1731
1732 return -1;
1733 }
1734
1735 /// getNVOffset - Returns the non-virtual offset for the given (B) base of the
1736 /// derived class D.
1737 Index_t getNVOffset(QualType qB, QualType qD) {
Mike Stump46271322009-11-03 19:03:17 +00001738 qD = qD->getPointeeType();
1739 qB = qB->getPointeeType();
Mike Stump8bccbfd2009-10-15 09:30:16 +00001740 CXXRecordDecl *D = cast<CXXRecordDecl>(qD->getAs<RecordType>()->getDecl());
1741 CXXRecordDecl *B = cast<CXXRecordDecl>(qB->getAs<RecordType>()->getDecl());
1742 int64_t o = getNVOffset_1(D, B);
1743 if (o >= 0)
1744 return o;
1745
1746 assert(false && "FIXME: non-virtual base not found");
1747 return 0;
1748 }
1749
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001750 /// getVbaseOffset - Returns the index into the vtable for the virtual base
1751 /// offset for the given (B) virtual base of the derived class D.
1752 Index_t getVbaseOffset(QualType qB, QualType qD) {
Mike Stump46271322009-11-03 19:03:17 +00001753 qD = qD->getPointeeType();
1754 qB = qB->getPointeeType();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001755 CXXRecordDecl *D = cast<CXXRecordDecl>(qD->getAs<RecordType>()->getDecl());
1756 CXXRecordDecl *B = cast<CXXRecordDecl>(qB->getAs<RecordType>()->getDecl());
Anders Carlssonbad80eb2009-12-04 18:36:22 +00001757 if (D != MostDerivedClass)
Eli Friedman03aa2f12009-11-30 01:19:33 +00001758 return CGM.getVtableInfo().getVirtualBaseOffsetIndex(D, B);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001759 llvm::DenseMap<const CXXRecordDecl *, Index_t>::iterator i;
1760 i = VBIndex.find(B);
1761 if (i != VBIndex.end())
1762 return i->second;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001763
Mike Stump28431212009-10-13 22:54:56 +00001764 assert(false && "FIXME: Base not found");
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001765 return 0;
1766 }
1767
Eli Friedman81fb0d22009-12-04 08:40:51 +00001768 bool OverrideMethod(GlobalDecl GD, bool MorallyVirtual,
1769 Index_t OverrideOffset, Index_t Offset,
1770 int64_t CurrentVBaseOffset);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001771
Anders Carlsson495634e2009-12-04 02:39:04 +00001772 /// AppendMethods - Append the current methods to the vtable.
Anders Carlssonddf42c82009-12-04 02:56:03 +00001773 void AppendMethodsToVtable();
Anders Carlsson495634e2009-12-04 02:39:04 +00001774
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001775 llvm::Constant *WrapAddrOf(GlobalDecl GD) {
1776 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
1777
Anders Carlsson64457732009-11-24 05:08:52 +00001778 const llvm::Type *Ty = CGM.getTypes().GetFunctionTypeForVtable(MD);
Mike Stump18e8b472009-10-27 23:36:26 +00001779
Mike Stumpcdeb8002009-12-03 16:55:20 +00001780 return wrap(CGM.GetAddrOfFunction(GD, Ty));
Mike Stump18e8b472009-10-27 23:36:26 +00001781 }
1782
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00001783 void OverrideMethods(Path_t *Path, bool MorallyVirtual, int64_t Offset,
1784 int64_t CurrentVBaseOffset) {
Mike Stump37dbe962009-10-15 02:04:03 +00001785 for (Path_t::reverse_iterator i = Path->rbegin(),
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001786 e = Path->rend(); i != e; ++i) {
1787 const CXXRecordDecl *RD = i->first;
Mike Stump8bccbfd2009-10-15 09:30:16 +00001788 int64_t OverrideOffset = i->second;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001789 for (method_iter mi = RD->method_begin(), me = RD->method_end(); mi != me;
1790 ++mi) {
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001791 const CXXMethodDecl *MD = *mi;
1792
1793 if (!MD->isVirtual())
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001794 continue;
1795
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001796 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1797 // Override both the complete and the deleting destructor.
1798 GlobalDecl CompDtor(DD, Dtor_Complete);
Eli Friedman81fb0d22009-12-04 08:40:51 +00001799 OverrideMethod(CompDtor, MorallyVirtual, OverrideOffset, Offset,
1800 CurrentVBaseOffset);
1801
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001802 GlobalDecl DeletingDtor(DD, Dtor_Deleting);
Eli Friedman81fb0d22009-12-04 08:40:51 +00001803 OverrideMethod(DeletingDtor, MorallyVirtual, OverrideOffset, Offset,
1804 CurrentVBaseOffset);
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001805 } else {
Eli Friedman81fb0d22009-12-04 08:40:51 +00001806 OverrideMethod(MD, MorallyVirtual, OverrideOffset, Offset,
1807 CurrentVBaseOffset);
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001808 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001809 }
1810 }
1811 }
1812
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001813 void AddMethod(const GlobalDecl GD, bool MorallyVirtual, Index_t Offset,
Eli Friedman03aa2f12009-11-30 01:19:33 +00001814 int64_t CurrentVBaseOffset) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001815 // If we can find a previously allocated slot for this, reuse it.
Eli Friedman81fb0d22009-12-04 08:40:51 +00001816 if (OverrideMethod(GD, MorallyVirtual, Offset, Offset,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00001817 CurrentVBaseOffset))
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001818 return;
1819
Mike Stump1f49d652010-01-22 18:48:47 +00001820 D1(printf(" vfn for %s at %d\n",
1821 dyn_cast<CXXMethodDecl>(GD.getDecl())->getNameAsCString(),
1822 (int)Methods.size()));
1823
Anders Carlssoncdf18982009-12-04 02:08:24 +00001824 // We didn't find an entry in the vtable that we could use, add a new
1825 // entry.
1826 Methods.AddMethod(GD);
1827
Mike Stumpa04ecfb2010-01-26 21:35:27 +00001828 VCallOffset[GD] = Offset/8 - CurrentVBaseOffset/8;
1829
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001830 if (MorallyVirtual) {
Anders Carlsson72281172010-01-26 17:36:47 +00001831 GlobalDecl UGD = getUnique(GD);
1832 const CXXMethodDecl *UMD = cast<CXXMethodDecl>(UGD.getDecl());
1833
Mike Stump90181eb2010-01-26 00:05:04 +00001834 assert(UMD && "final overrider not found");
1835
1836 Index_t &idx = VCall[UMD];
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001837 // Allocate the first one, after that, we reuse the previous one.
1838 if (idx == 0) {
Anders Carlsson72281172010-01-26 17:36:47 +00001839 VCallOffsetForVCall[UGD] = Offset/8;
Mike Stumpa04ecfb2010-01-26 21:35:27 +00001840 NonVirtualOffset[UMD] = Offset/8 - CurrentVBaseOffset/8;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001841 idx = VCalls.size()+1;
Mike Stump90181eb2010-01-26 00:05:04 +00001842 VCalls.push_back(Offset/8 - CurrentVBaseOffset/8);
Mike Stump75ce5732009-10-31 20:06:59 +00001843 D1(printf(" vcall for %s at %d with delta %d\n",
Mike Stumpd2808442010-01-22 02:51:26 +00001844 dyn_cast<CXXMethodDecl>(GD.getDecl())->getNameAsCString(),
Mike Stump90181eb2010-01-26 00:05:04 +00001845 (int)-VCalls.size()-3, (int)VCalls[idx-1]));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001846 }
1847 }
1848 }
1849
1850 void AddMethods(const CXXRecordDecl *RD, bool MorallyVirtual,
Eli Friedman03aa2f12009-11-30 01:19:33 +00001851 Index_t Offset, int64_t CurrentVBaseOffset) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001852 for (method_iter mi = RD->method_begin(), me = RD->method_end(); mi != me;
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001853 ++mi) {
1854 const CXXMethodDecl *MD = *mi;
1855 if (!MD->isVirtual())
1856 continue;
1857
1858 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1859 // For destructors, add both the complete and the deleting destructor
1860 // to the vtable.
1861 AddMethod(GlobalDecl(DD, Dtor_Complete), MorallyVirtual, Offset,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00001862 CurrentVBaseOffset);
Eli Friedman03aa2f12009-11-30 01:19:33 +00001863 AddMethod(GlobalDecl(DD, Dtor_Deleting), MorallyVirtual, Offset,
1864 CurrentVBaseOffset);
1865 } else
1866 AddMethod(MD, MorallyVirtual, Offset, CurrentVBaseOffset);
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001867 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001868 }
1869
1870 void NonVirtualBases(const CXXRecordDecl *RD, const ASTRecordLayout &Layout,
1871 const CXXRecordDecl *PrimaryBase,
1872 bool PrimaryBaseWasVirtual, bool MorallyVirtual,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00001873 int64_t Offset, int64_t CurrentVBaseOffset,
1874 Path_t *Path) {
Mike Stump37dbe962009-10-15 02:04:03 +00001875 Path->push_back(std::make_pair(RD, Offset));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001876 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
1877 e = RD->bases_end(); i != e; ++i) {
1878 if (i->isVirtual())
1879 continue;
1880 const CXXRecordDecl *Base =
1881 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Mike Stump9eb76d42010-01-22 06:45:05 +00001882 uint64_t o = Offset + Layout.getBaseClassOffset(Base);
1883 StartNewTable();
1884 GenerateVtableForBase(Base, o, MorallyVirtual, false,
1885 true, Base == PrimaryBase && !PrimaryBaseWasVirtual,
1886 CurrentVBaseOffset, Path);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001887 }
Mike Stump37dbe962009-10-15 02:04:03 +00001888 Path->pop_back();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001889 }
1890
Mike Stumpb21c4ee2009-10-14 18:14:51 +00001891// #define D(X) do { X; } while (0)
1892#define D(X)
1893
1894 void insertVCalls(int InsertionPoint) {
Mike Stump75ce5732009-10-31 20:06:59 +00001895 D1(printf("============= combining vbase/vcall\n"));
Mike Stumpb21c4ee2009-10-14 18:14:51 +00001896 D(VCalls.insert(VCalls.begin(), 673));
1897 D(VCalls.push_back(672));
Eli Friedman6c08ce72009-12-05 01:05:03 +00001898
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00001899 VtableComponents.insert(VtableComponents.begin() + InsertionPoint,
1900 VCalls.size(), 0);
Eli Friedman6c08ce72009-12-05 01:05:03 +00001901 if (BuildVtable) {
1902 // The vcalls come first...
1903 for (std::vector<Index_t>::reverse_iterator i = VCalls.rbegin(),
1904 e = VCalls.rend();
1905 i != e; ++i)
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00001906 VtableComponents[InsertionPoint++] = wrap((0?600:0) + *i);
Eli Friedman6c08ce72009-12-05 01:05:03 +00001907 }
Mike Stumpb21c4ee2009-10-14 18:14:51 +00001908 VCalls.clear();
Mike Stump9f23a142009-11-10 02:30:51 +00001909 VCall.clear();
Mike Stumpa04ecfb2010-01-26 21:35:27 +00001910 VCallOffsetForVCall.clear();
1911 VCallOffset.clear();
1912 NonVirtualOffset.clear();
Mike Stumpb21c4ee2009-10-14 18:14:51 +00001913 }
1914
Mike Stump559387f2009-11-13 23:13:20 +00001915 void AddAddressPoints(const CXXRecordDecl *RD, uint64_t Offset,
1916 Index_t AddressPoint) {
1917 D1(printf("XXX address point for %s in %s layout %s at offset %d is %d\n",
Mike Stumpd2808442010-01-22 02:51:26 +00001918 RD->getNameAsCString(), MostDerivedClass->getNameAsCString(),
Mike Stump559387f2009-11-13 23:13:20 +00001919 LayoutClass->getNameAsCString(), (int)Offset, (int)AddressPoint));
Mike Stumpcd2b8212009-11-19 20:52:19 +00001920 subAddressPoints[std::make_pair(RD, Offset)] = AddressPoint;
Anders Carlsson5f9a8812010-01-14 02:29:07 +00001921 AddressPoints[BaseSubobject(RD, Offset)] = AddressPoint;
Mike Stump559387f2009-11-13 23:13:20 +00001922
1923 // Now also add the address point for all our primary bases.
1924 while (1) {
1925 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
1926 RD = Layout.getPrimaryBase();
1927 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
1928 // FIXME: Double check this.
1929 if (RD == 0)
1930 break;
1931 if (PrimaryBaseWasVirtual &&
1932 BLayout.getVBaseClassOffset(RD) != Offset)
1933 break;
1934 D1(printf("XXX address point for %s in %s layout %s at offset %d is %d\n",
Mike Stumpd2808442010-01-22 02:51:26 +00001935 RD->getNameAsCString(), MostDerivedClass->getNameAsCString(),
Mike Stump559387f2009-11-13 23:13:20 +00001936 LayoutClass->getNameAsCString(), (int)Offset, (int)AddressPoint));
Mike Stumpcd2b8212009-11-19 20:52:19 +00001937 subAddressPoints[std::make_pair(RD, Offset)] = AddressPoint;
Anders Carlsson5f9a8812010-01-14 02:29:07 +00001938 AddressPoints[BaseSubobject(RD, Offset)] = AddressPoint;
Mike Stump559387f2009-11-13 23:13:20 +00001939 }
1940 }
1941
1942
Mike Stumpd538a6d2009-12-24 07:29:41 +00001943 void FinishGenerateVtable(const CXXRecordDecl *RD,
1944 const ASTRecordLayout &Layout,
1945 const CXXRecordDecl *PrimaryBase,
Mike Stump9eb76d42010-01-22 06:45:05 +00001946 bool ForNPNVBases, bool WasPrimaryBase,
Mike Stumpd538a6d2009-12-24 07:29:41 +00001947 bool PrimaryBaseWasVirtual,
1948 bool MorallyVirtual, int64_t Offset,
1949 bool ForVirtualBase, int64_t CurrentVBaseOffset,
1950 Path_t *Path) {
Mike Stump37dbe962009-10-15 02:04:03 +00001951 bool alloc = false;
1952 if (Path == 0) {
1953 alloc = true;
1954 Path = new Path_t;
1955 }
1956
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001957 StartNewTable();
1958 extra = 0;
Mike Stump9eb76d42010-01-22 06:45:05 +00001959 Index_t AddressPoint = 0;
1960 int VCallInsertionPoint = 0;
1961 if (!ForNPNVBases || !WasPrimaryBase) {
1962 bool DeferVCalls = MorallyVirtual || ForVirtualBase;
1963 VCallInsertionPoint = VtableComponents.size();
1964 if (!DeferVCalls) {
1965 insertVCalls(VCallInsertionPoint);
1966 } else
1967 // FIXME: just for extra, or for all uses of VCalls.size post this?
1968 extra = -VCalls.size();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001969
Mike Stump9eb76d42010-01-22 06:45:05 +00001970 // Add the offset to top.
1971 VtableComponents.push_back(BuildVtable ? wrap(-((Offset-LayoutOffset)/8)) : 0);
Anders Carlsson472404f2009-12-04 16:19:30 +00001972
Mike Stump9eb76d42010-01-22 06:45:05 +00001973 // Add the RTTI information.
1974 VtableComponents.push_back(rtti);
Anders Carlsson472404f2009-12-04 16:19:30 +00001975
Mike Stump9eb76d42010-01-22 06:45:05 +00001976 AddressPoint = VtableComponents.size();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001977
Mike Stump9eb76d42010-01-22 06:45:05 +00001978 AppendMethodsToVtable();
1979 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001980
1981 // and then the non-virtual bases.
1982 NonVirtualBases(RD, Layout, PrimaryBase, PrimaryBaseWasVirtual,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00001983 MorallyVirtual, Offset, CurrentVBaseOffset, Path);
Mike Stumpb21c4ee2009-10-14 18:14:51 +00001984
1985 if (ForVirtualBase) {
Mike Stump2cefe382009-11-12 20:47:57 +00001986 // FIXME: We're adding to VCalls in callers, we need to do the overrides
1987 // in the inner part, so that we know the complete set of vcalls during
1988 // the build and don't have to insert into methods. Saving out the
1989 // AddressPoint here, would need to be fixed, if we didn't do that. Also
1990 // retroactively adding vcalls for overrides later wind up in the wrong
1991 // place, the vcall slot has to be alloted during the walk of the base
1992 // when the function is first introduces.
Mike Stumpb21c4ee2009-10-14 18:14:51 +00001993 AddressPoint += VCalls.size();
Mike Stump2cefe382009-11-12 20:47:57 +00001994 insertVCalls(VCallInsertionPoint);
Mike Stumpb21c4ee2009-10-14 18:14:51 +00001995 }
1996
Mike Stump9eb76d42010-01-22 06:45:05 +00001997 if (!ForNPNVBases || !WasPrimaryBase)
1998 AddAddressPoints(RD, Offset, AddressPoint);
Mike Stump2cefe382009-11-12 20:47:57 +00001999
Mike Stump37dbe962009-10-15 02:04:03 +00002000 if (alloc) {
2001 delete Path;
2002 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002003 }
2004
Mike Stump75ce5732009-10-31 20:06:59 +00002005 void Primaries(const CXXRecordDecl *RD, bool MorallyVirtual, int64_t Offset,
2006 bool updateVBIndex, Index_t current_vbindex,
Eli Friedman03aa2f12009-11-30 01:19:33 +00002007 int64_t CurrentVBaseOffset) {
Mike Stump75ce5732009-10-31 20:06:59 +00002008 if (!RD->isDynamicClass())
2009 return;
2010
2011 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
2012 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
2013 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
2014
2015 // vtables are composed from the chain of primaries.
Eli Friedman65d87222009-12-04 08:52:11 +00002016 if (PrimaryBase && !PrimaryBaseWasVirtual) {
Mike Stump75ce5732009-10-31 20:06:59 +00002017 D1(printf(" doing primaries for %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002018 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Eli Friedman65d87222009-12-04 08:52:11 +00002019 Primaries(PrimaryBase, PrimaryBaseWasVirtual|MorallyVirtual, Offset,
2020 updateVBIndex, current_vbindex, CurrentVBaseOffset);
Mike Stump75ce5732009-10-31 20:06:59 +00002021 }
2022
2023 D1(printf(" doing vcall entries for %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002024 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Mike Stump75ce5732009-10-31 20:06:59 +00002025
2026 // And add the virtuals for the class to the primary vtable.
Eli Friedman03aa2f12009-11-30 01:19:33 +00002027 AddMethods(RD, MorallyVirtual, Offset, CurrentVBaseOffset);
Mike Stump75ce5732009-10-31 20:06:59 +00002028 }
2029
2030 void VBPrimaries(const CXXRecordDecl *RD, bool MorallyVirtual, int64_t Offset,
2031 bool updateVBIndex, Index_t current_vbindex,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002032 bool RDisVirtualBase, int64_t CurrentVBaseOffset,
Eli Friedman03aa2f12009-11-30 01:19:33 +00002033 bool bottom) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002034 if (!RD->isDynamicClass())
2035 return;
2036
2037 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
2038 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
2039 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
2040
2041 // vtables are composed from the chain of primaries.
2042 if (PrimaryBase) {
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002043 int BaseCurrentVBaseOffset = CurrentVBaseOffset;
2044 if (PrimaryBaseWasVirtual) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002045 IndirectPrimary.insert(PrimaryBase);
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002046 BaseCurrentVBaseOffset = BLayout.getVBaseClassOffset(PrimaryBase);
2047 }
Mike Stump75ce5732009-10-31 20:06:59 +00002048
2049 D1(printf(" doing primaries for %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002050 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Mike Stump75ce5732009-10-31 20:06:59 +00002051
2052 VBPrimaries(PrimaryBase, PrimaryBaseWasVirtual|MorallyVirtual, Offset,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002053 updateVBIndex, current_vbindex, PrimaryBaseWasVirtual,
Eli Friedman03aa2f12009-11-30 01:19:33 +00002054 BaseCurrentVBaseOffset, false);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002055 }
2056
Mike Stump75ce5732009-10-31 20:06:59 +00002057 D1(printf(" doing vbase entries for %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002058 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Mike Stump75ce5732009-10-31 20:06:59 +00002059 GenerateVBaseOffsets(RD, Offset, updateVBIndex, current_vbindex);
2060
2061 if (RDisVirtualBase || bottom) {
2062 Primaries(RD, MorallyVirtual, Offset, updateVBIndex, current_vbindex,
Eli Friedman03aa2f12009-11-30 01:19:33 +00002063 CurrentVBaseOffset);
Mike Stump75ce5732009-10-31 20:06:59 +00002064 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002065 }
2066
Mike Stumpd538a6d2009-12-24 07:29:41 +00002067 void GenerateVtableForBase(const CXXRecordDecl *RD, int64_t Offset = 0,
2068 bool MorallyVirtual = false,
2069 bool ForVirtualBase = false,
Mike Stump9eb76d42010-01-22 06:45:05 +00002070 bool ForNPNVBases = false,
2071 bool WasPrimaryBase = true,
Mike Stumpd538a6d2009-12-24 07:29:41 +00002072 int CurrentVBaseOffset = 0,
2073 Path_t *Path = 0) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002074 if (!RD->isDynamicClass())
Mike Stumpd538a6d2009-12-24 07:29:41 +00002075 return;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002076
Mike Stumpfa818082009-11-13 02:35:38 +00002077 // Construction vtable don't need parts that have no virtual bases and
2078 // aren't morally virtual.
Anders Carlssonbad80eb2009-12-04 18:36:22 +00002079 if ((LayoutClass != MostDerivedClass) &&
2080 RD->getNumVBases() == 0 && !MorallyVirtual)
Mike Stumpd538a6d2009-12-24 07:29:41 +00002081 return;
Mike Stumpfa818082009-11-13 02:35:38 +00002082
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002083 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
2084 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
2085 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
2086
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002087 extra = 0;
Mike Stump75ce5732009-10-31 20:06:59 +00002088 D1(printf("building entries for base %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002089 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002090
Mike Stump75ce5732009-10-31 20:06:59 +00002091 if (ForVirtualBase)
2092 extra = VCalls.size();
2093
Mike Stump9eb76d42010-01-22 06:45:05 +00002094 if (!ForNPNVBases || !WasPrimaryBase) {
2095 VBPrimaries(RD, MorallyVirtual, Offset, !ForVirtualBase, 0,
2096 ForVirtualBase, CurrentVBaseOffset, true);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002097
Mike Stump9eb76d42010-01-22 06:45:05 +00002098 if (Path)
2099 OverrideMethods(Path, MorallyVirtual, Offset, CurrentVBaseOffset);
2100 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002101
Mike Stump9eb76d42010-01-22 06:45:05 +00002102 FinishGenerateVtable(RD, Layout, PrimaryBase, ForNPNVBases, WasPrimaryBase,
2103 PrimaryBaseWasVirtual, MorallyVirtual, Offset,
2104 ForVirtualBase, CurrentVBaseOffset, Path);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002105 }
2106
2107 void GenerateVtableForVBases(const CXXRecordDecl *RD,
2108 int64_t Offset = 0,
Mike Stump37dbe962009-10-15 02:04:03 +00002109 Path_t *Path = 0) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002110 bool alloc = false;
2111 if (Path == 0) {
2112 alloc = true;
Mike Stump37dbe962009-10-15 02:04:03 +00002113 Path = new Path_t;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002114 }
2115 // FIXME: We also need to override using all paths to a virtual base,
2116 // right now, we just process the first path
2117 Path->push_back(std::make_pair(RD, Offset));
2118 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
2119 e = RD->bases_end(); i != e; ++i) {
2120 const CXXRecordDecl *Base =
2121 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
2122 if (i->isVirtual() && !IndirectPrimary.count(Base)) {
2123 // Mark it so we don't output it twice.
2124 IndirectPrimary.insert(Base);
2125 StartNewTable();
Mike Stumpb21c4ee2009-10-14 18:14:51 +00002126 VCall.clear();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002127 int64_t BaseOffset = BLayout.getVBaseClassOffset(Base);
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002128 int64_t CurrentVBaseOffset = BaseOffset;
Mike Stump75ce5732009-10-31 20:06:59 +00002129 D1(printf("vtable %s virtual base %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002130 MostDerivedClass->getNameAsCString(), Base->getNameAsCString()));
Mike Stump9eb76d42010-01-22 06:45:05 +00002131 GenerateVtableForBase(Base, BaseOffset, true, true, false,
2132 true, CurrentVBaseOffset, Path);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002133 }
Mike Stump2cefe382009-11-12 20:47:57 +00002134 int64_t BaseOffset;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002135 if (i->isVirtual())
2136 BaseOffset = BLayout.getVBaseClassOffset(Base);
Mike Stump2cefe382009-11-12 20:47:57 +00002137 else {
2138 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
2139 BaseOffset = Offset + Layout.getBaseClassOffset(Base);
2140 }
2141
Mike Stump37dbe962009-10-15 02:04:03 +00002142 if (Base->getNumVBases()) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002143 GenerateVtableForVBases(Base, BaseOffset, Path);
Mike Stump37dbe962009-10-15 02:04:03 +00002144 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002145 }
2146 Path->pop_back();
2147 if (alloc)
2148 delete Path;
2149 }
2150};
Anders Carlssonca1bf682009-12-03 01:54:02 +00002151} // end anonymous namespace
2152
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002153bool OldVtableBuilder::OverrideMethod(GlobalDecl GD, bool MorallyVirtual,
Eli Friedman81fb0d22009-12-04 08:40:51 +00002154 Index_t OverrideOffset, Index_t Offset,
2155 int64_t CurrentVBaseOffset) {
Anders Carlssonca1bf682009-12-03 01:54:02 +00002156 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2157
2158 const bool isPure = MD->isPure();
Anders Carlsson21bbc1e2009-12-05 17:04:47 +00002159
Anders Carlssonca1bf682009-12-03 01:54:02 +00002160 // FIXME: Should OverrideOffset's be Offset?
2161
Anders Carlsson21bbc1e2009-12-05 17:04:47 +00002162 for (CXXMethodDecl::method_iterator mi = MD->begin_overridden_methods(),
2163 e = MD->end_overridden_methods(); mi != e; ++mi) {
Anders Carlssonca1bf682009-12-03 01:54:02 +00002164 GlobalDecl OGD;
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002165 GlobalDecl OGD2;
Anders Carlssonca1bf682009-12-03 01:54:02 +00002166
Anders Carlssonf3935b42009-12-04 05:51:56 +00002167 const CXXMethodDecl *OMD = *mi;
Anders Carlssonca1bf682009-12-03 01:54:02 +00002168 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(OMD))
2169 OGD = GlobalDecl(DD, GD.getDtorType());
2170 else
2171 OGD = OMD;
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002172
Eli Friedman8174f2c2009-12-06 22:01:30 +00002173 // Check whether this is the method being overridden in this section of
2174 // the vtable.
Anders Carlsson7bb70762009-12-04 15:49:02 +00002175 uint64_t Index;
2176 if (!Methods.getIndex(OGD, Index))
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002177 continue;
2178
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002179 OGD2 = OGD;
2180
Eli Friedman8174f2c2009-12-06 22:01:30 +00002181 // Get the original method, which we should be computing thunks, etc,
2182 // against.
2183 OGD = Methods.getOrigMethod(Index);
2184 OMD = cast<CXXMethodDecl>(OGD.getDecl());
2185
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002186 QualType ReturnType =
2187 MD->getType()->getAs<FunctionType>()->getResultType();
2188 QualType OverriddenReturnType =
2189 OMD->getType()->getAs<FunctionType>()->getResultType();
Anders Carlssonca1bf682009-12-03 01:54:02 +00002190
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002191 // Check if we need a return type adjustment.
Anders Carlssoncce9ee82010-02-13 23:17:31 +00002192 if (!ComputeReturnAdjustmentBaseOffset(CGM.getContext(), MD,
2193 OMD).isEmpty()) {
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002194 CanQualType &BaseReturnType = BaseReturnTypes[Index];
Anders Carlssonca1bf682009-12-03 01:54:02 +00002195
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002196 // Insert the base return type.
2197 if (BaseReturnType.isNull())
2198 BaseReturnType =
2199 CGM.getContext().getCanonicalType(OverriddenReturnType);
2200 }
Anders Carlssona93e9802009-12-04 03:52:52 +00002201
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002202 Methods.OverrideMethod(OGD, GD);
2203
Anders Carlsson72281172010-01-26 17:36:47 +00002204 GlobalDecl UGD = getUnique(GD);
2205 const CXXMethodDecl *UMD = cast<CXXMethodDecl>(UGD.getDecl());
2206 assert(UGD.getDecl() && "unique overrider not found");
2207 assert(UGD == getUnique(OGD) && "unique overrider not unique");
Mike Stump90181eb2010-01-26 00:05:04 +00002208
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002209 ThisAdjustments.erase(Index);
Mike Stump90181eb2010-01-26 00:05:04 +00002210 if (MorallyVirtual || VCall.count(UMD)) {
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002211
Mike Stump90181eb2010-01-26 00:05:04 +00002212 Index_t &idx = VCall[UMD];
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002213 if (idx == 0) {
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002214 VCallOffset[GD] = VCallOffset[OGD];
2215 // NonVirtualOffset[UMD] = CurrentVBaseOffset/8 - OverrideOffset/8;
2216 NonVirtualOffset[UMD] = VCallOffset[OGD];
Mike Stump77537b12010-01-26 03:42:22 +00002217 VCallOffsetForVCall[UMD] = OverrideOffset/8;
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002218 idx = VCalls.size()+1;
Mike Stump77537b12010-01-26 03:42:22 +00002219 VCalls.push_back(OverrideOffset/8 - CurrentVBaseOffset/8);
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002220 D1(printf(" vcall for %s at %d with delta %d most derived %s\n",
2221 MD->getNameAsString().c_str(), (int)-idx-3,
Mike Stumpd2808442010-01-22 02:51:26 +00002222 (int)VCalls[idx-1], MostDerivedClass->getNameAsCString()));
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002223 } else {
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002224 VCallOffset[GD] = NonVirtualOffset[UMD];
Anders Carlsson72281172010-01-26 17:36:47 +00002225 VCalls[idx-1] = -VCallOffsetForVCall[UGD] + OverrideOffset/8;
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002226 D1(printf(" vcall patch for %s at %d with delta %d most derived %s\n",
2227 MD->getNameAsString().c_str(), (int)-idx-3,
Mike Stumpd2808442010-01-22 02:51:26 +00002228 (int)VCalls[idx-1], MostDerivedClass->getNameAsCString()));
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002229 }
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002230 int64_t NonVirtualAdjustment = -VCallOffset[OGD];
Mike Stumpded0a402010-01-26 22:44:01 +00002231 QualType DerivedType = MD->getThisType(CGM.getContext());
2232 QualType BaseType = cast<const CXXMethodDecl>(OGD.getDecl())->getThisType(CGM.getContext());
2233 int64_t NonVirtualAdjustment2 = -(getNVOffset(BaseType, DerivedType)/8);
2234 if (NonVirtualAdjustment2 != NonVirtualAdjustment) {
2235 NonVirtualAdjustment = NonVirtualAdjustment2;
2236 }
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002237 int64_t VirtualAdjustment =
2238 -((idx + extra + 2) * LLVMPointerWidth / 8);
Anders Carlsson657f1392009-12-03 02:32:59 +00002239
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002240 // Optimize out virtual adjustments of 0.
2241 if (VCalls[idx-1] == 0)
2242 VirtualAdjustment = 0;
Anders Carlsson657f1392009-12-03 02:32:59 +00002243
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002244 ThunkAdjustment ThisAdjustment(NonVirtualAdjustment,
2245 VirtualAdjustment);
Anders Carlsson2ca285f2009-12-03 02:22:59 +00002246
Eli Friedman8174f2c2009-12-06 22:01:30 +00002247 if (!isPure && !ThisAdjustment.isEmpty()) {
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002248 ThisAdjustments[Index] = ThisAdjustment;
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002249 SavedAdjustments.push_back(
2250 std::make_pair(GD, std::make_pair(OGD, ThisAdjustment)));
Eli Friedman8174f2c2009-12-06 22:01:30 +00002251 }
Anders Carlssonca1bf682009-12-03 01:54:02 +00002252 return true;
2253 }
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002254
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002255 VCallOffset[GD] = VCallOffset[OGD2] - OverrideOffset/8;
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002256
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002257 int64_t NonVirtualAdjustment = -VCallOffset[GD];
2258 QualType DerivedType = MD->getThisType(CGM.getContext());
2259 QualType BaseType = cast<const CXXMethodDecl>(OGD.getDecl())->getThisType(CGM.getContext());
2260 int64_t NonVirtualAdjustment2 = -(getNVOffset(BaseType, DerivedType)/8);
2261 if (NonVirtualAdjustment2 != NonVirtualAdjustment) {
2262 NonVirtualAdjustment = NonVirtualAdjustment2;
2263 }
2264
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002265 if (NonVirtualAdjustment) {
2266 ThunkAdjustment ThisAdjustment(NonVirtualAdjustment, 0);
2267
Eli Friedmanf2eda5e2009-12-06 22:33:51 +00002268 if (!isPure) {
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002269 ThisAdjustments[Index] = ThisAdjustment;
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002270 SavedAdjustments.push_back(
2271 std::make_pair(GD, std::make_pair(OGD, ThisAdjustment)));
Eli Friedmanf2eda5e2009-12-06 22:33:51 +00002272 }
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002273 }
2274 return true;
Anders Carlssonca1bf682009-12-03 01:54:02 +00002275 }
2276
2277 return false;
Anders Carlssond59885022009-11-27 22:21:51 +00002278}
2279
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002280void OldVtableBuilder::AppendMethodsToVtable() {
Eli Friedman6c08ce72009-12-05 01:05:03 +00002281 if (!BuildVtable) {
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002282 VtableComponents.insert(VtableComponents.end(), Methods.size(),
2283 (llvm::Constant *)0);
Eli Friedman6c08ce72009-12-05 01:05:03 +00002284 ThisAdjustments.clear();
2285 BaseReturnTypes.clear();
2286 Methods.clear();
2287 return;
2288 }
2289
Anders Carlsson472404f2009-12-04 16:19:30 +00002290 // Reserve room in the vtable for our new methods.
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002291 VtableComponents.reserve(VtableComponents.size() + Methods.size());
Anders Carlssonb07567c2009-12-04 03:07:26 +00002292
Anders Carlsson86809cd2009-12-04 02:43:50 +00002293 for (unsigned i = 0, e = Methods.size(); i != e; ++i) {
2294 GlobalDecl GD = Methods[i];
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00002295 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2296
2297 // Get the 'this' pointer adjustment.
Anders Carlsson86809cd2009-12-04 02:43:50 +00002298 ThunkAdjustment ThisAdjustment = ThisAdjustments.lookup(i);
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00002299
2300 // Construct the return type adjustment.
2301 ThunkAdjustment ReturnAdjustment;
2302
2303 QualType BaseReturnType = BaseReturnTypes.lookup(i);
2304 if (!BaseReturnType.isNull() && !MD->isPure()) {
2305 QualType DerivedType =
2306 MD->getType()->getAs<FunctionType>()->getResultType();
2307
2308 int64_t NonVirtualAdjustment =
2309 getNVOffset(BaseReturnType, DerivedType) / 8;
2310
2311 int64_t VirtualAdjustment =
2312 getVbaseOffset(BaseReturnType, DerivedType);
2313
2314 ReturnAdjustment = ThunkAdjustment(NonVirtualAdjustment,
2315 VirtualAdjustment);
2316 }
2317
Anders Carlsson50f14742009-12-04 03:06:03 +00002318 llvm::Constant *Method = 0;
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00002319 if (!ReturnAdjustment.isEmpty()) {
2320 // Build a covariant thunk.
2321 CovariantThunkAdjustment Adjustment(ThisAdjustment, ReturnAdjustment);
Eli Friedman8174f2c2009-12-06 22:01:30 +00002322 Method = wrap(CGM.GetAddrOfCovariantThunk(GD, Adjustment));
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00002323 } else if (!ThisAdjustment.isEmpty()) {
2324 // Build a "regular" thunk.
Eli Friedman8174f2c2009-12-06 22:01:30 +00002325 Method = wrap(CGM.GetAddrOfThunk(GD, ThisAdjustment));
Anders Carlssonddf42c82009-12-04 02:56:03 +00002326 } else if (MD->isPure()) {
2327 // We have a pure virtual method.
Anders Carlsson50f14742009-12-04 03:06:03 +00002328 Method = getPureVirtualFn();
2329 } else {
2330 // We have a good old regular method.
2331 Method = WrapAddrOf(GD);
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00002332 }
Anders Carlsson50f14742009-12-04 03:06:03 +00002333
2334 // Add the method to the vtable.
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002335 VtableComponents.push_back(Method);
Anders Carlsson86809cd2009-12-04 02:43:50 +00002336 }
2337
Anders Carlsson50f14742009-12-04 03:06:03 +00002338
Anders Carlsson86809cd2009-12-04 02:43:50 +00002339 ThisAdjustments.clear();
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00002340 BaseReturnTypes.clear();
Anders Carlsson86809cd2009-12-04 02:43:50 +00002341
Anders Carlsson495634e2009-12-04 02:39:04 +00002342 Methods.clear();
Anders Carlsson495634e2009-12-04 02:39:04 +00002343}
2344
Anders Carlssonf942ee02009-11-27 20:47:55 +00002345void CGVtableInfo::ComputeMethodVtableIndices(const CXXRecordDecl *RD) {
2346
2347 // Itanium C++ ABI 2.5.2:
Anders Carlsson259688c2010-02-02 03:37:46 +00002348 // The order of the virtual function pointers in a virtual table is the
2349 // order of declaration of the corresponding member functions in the class.
Anders Carlssonf942ee02009-11-27 20:47:55 +00002350 //
Anders Carlsson259688c2010-02-02 03:37:46 +00002351 // There is an entry for any virtual function declared in a class,
2352 // whether it is a new function or overrides a base class function,
2353 // unless it overrides a function from the primary base, and conversion
2354 // between their return types does not require an adjustment.
Anders Carlssonf942ee02009-11-27 20:47:55 +00002355
2356 int64_t CurrentIndex = 0;
2357
2358 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
2359 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
2360
2361 if (PrimaryBase) {
Anders Carlssonc920fa22009-11-30 19:43:26 +00002362 assert(PrimaryBase->isDefinition() &&
2363 "Should have the definition decl of the primary base!");
Anders Carlssonf942ee02009-11-27 20:47:55 +00002364
2365 // Since the record decl shares its vtable pointer with the primary base
2366 // we need to start counting at the end of the primary base's vtable.
2367 CurrentIndex = getNumVirtualFunctionPointers(PrimaryBase);
2368 }
Eli Friedman21517252009-12-15 03:31:17 +00002369
2370 // Collect all the primary bases, so we can check whether methods override
2371 // a method from the base.
Anders Carlsson65b49782010-02-12 05:25:12 +00002372 VtableBuilder::PrimaryBasesSetTy PrimaryBases;
Eli Friedman21517252009-12-15 03:31:17 +00002373 for (ASTRecordLayout::primary_base_info_iterator
2374 I = Layout.primary_base_begin(), E = Layout.primary_base_end();
2375 I != E; ++I)
2376 PrimaryBases.insert((*I).getBase());
2377
Anders Carlssonf942ee02009-11-27 20:47:55 +00002378 const CXXDestructorDecl *ImplicitVirtualDtor = 0;
2379
2380 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
2381 e = RD->method_end(); i != e; ++i) {
2382 const CXXMethodDecl *MD = *i;
2383
2384 // We only want virtual methods.
2385 if (!MD->isVirtual())
2386 continue;
2387
Anders Carlssonf942ee02009-11-27 20:47:55 +00002388 // Check if this method overrides a method in the primary base.
Anders Carlsson65b49782010-02-12 05:25:12 +00002389 if (const CXXMethodDecl *OverriddenMD =
2390 OverridesMethodInPrimaryBase(MD, PrimaryBases)) {
2391 // Check if converting from the return type of the method to the
2392 // return type of the overridden method requires conversion.
Anders Carlssoncce9ee82010-02-13 23:17:31 +00002393 if (ComputeReturnAdjustmentBaseOffset(CGM.getContext(), MD,
2394 OverriddenMD).isEmpty()) {
Anders Carlsson65b49782010-02-12 05:25:12 +00002395 // This index is shared between the index in the vtable of the primary
2396 // base class.
2397 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2398 const CXXDestructorDecl *OverriddenDD =
2399 cast<CXXDestructorDecl>(OverriddenMD);
Anders Carlssonf942ee02009-11-27 20:47:55 +00002400
Anders Carlsson65b49782010-02-12 05:25:12 +00002401 // Add both the complete and deleting entries.
2402 MethodVtableIndices[GlobalDecl(DD, Dtor_Complete)] =
2403 getMethodVtableIndex(GlobalDecl(OverriddenDD, Dtor_Complete));
2404 MethodVtableIndices[GlobalDecl(DD, Dtor_Deleting)] =
2405 getMethodVtableIndex(GlobalDecl(OverriddenDD, Dtor_Deleting));
2406 } else {
2407 MethodVtableIndices[MD] = getMethodVtableIndex(OverriddenMD);
2408 }
2409
2410 // We don't need to add an entry for this method.
Anders Carlsson07604812010-02-12 18:14:46 +00002411 continue;
Anders Carlssonf942ee02009-11-27 20:47:55 +00002412 }
2413 }
2414
Anders Carlssonf942ee02009-11-27 20:47:55 +00002415 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2416 if (MD->isImplicit()) {
2417 assert(!ImplicitVirtualDtor &&
2418 "Did already see an implicit virtual dtor!");
2419 ImplicitVirtualDtor = DD;
2420 continue;
2421 }
2422
2423 // Add the complete dtor.
2424 MethodVtableIndices[GlobalDecl(DD, Dtor_Complete)] = CurrentIndex++;
2425
2426 // Add the deleting dtor.
2427 MethodVtableIndices[GlobalDecl(DD, Dtor_Deleting)] = CurrentIndex++;
2428 } else {
2429 // Add the entry.
2430 MethodVtableIndices[MD] = CurrentIndex++;
2431 }
2432 }
2433
2434 if (ImplicitVirtualDtor) {
2435 // Itanium C++ ABI 2.5.2:
Anders Carlssondc2dba32010-02-16 04:49:44 +00002436 // If a class has an implicitly-defined virtual destructor,
2437 // its entries come after the declared virtual function pointers.
Anders Carlssonf942ee02009-11-27 20:47:55 +00002438
2439 // Add the complete dtor.
2440 MethodVtableIndices[GlobalDecl(ImplicitVirtualDtor, Dtor_Complete)] =
2441 CurrentIndex++;
2442
2443 // Add the deleting dtor.
2444 MethodVtableIndices[GlobalDecl(ImplicitVirtualDtor, Dtor_Deleting)] =
2445 CurrentIndex++;
2446 }
2447
2448 NumVirtualFunctionPointers[RD] = CurrentIndex;
2449}
2450
2451uint64_t CGVtableInfo::getNumVirtualFunctionPointers(const CXXRecordDecl *RD) {
2452 llvm::DenseMap<const CXXRecordDecl *, uint64_t>::iterator I =
2453 NumVirtualFunctionPointers.find(RD);
2454 if (I != NumVirtualFunctionPointers.end())
2455 return I->second;
2456
2457 ComputeMethodVtableIndices(RD);
2458
2459 I = NumVirtualFunctionPointers.find(RD);
2460 assert(I != NumVirtualFunctionPointers.end() && "Did not find entry!");
2461 return I->second;
2462}
2463
2464uint64_t CGVtableInfo::getMethodVtableIndex(GlobalDecl GD) {
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002465 MethodVtableIndicesTy::iterator I = MethodVtableIndices.find(GD);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002466 if (I != MethodVtableIndices.end())
2467 return I->second;
2468
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002469 const CXXRecordDecl *RD = cast<CXXMethodDecl>(GD.getDecl())->getParent();
Anders Carlssonf942ee02009-11-27 20:47:55 +00002470
2471 ComputeMethodVtableIndices(RD);
2472
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002473 I = MethodVtableIndices.find(GD);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002474 assert(I != MethodVtableIndices.end() && "Did not find index!");
2475 return I->second;
2476}
2477
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002478CGVtableInfo::AdjustmentVectorTy*
2479CGVtableInfo::getAdjustments(GlobalDecl GD) {
2480 SavedAdjustmentsTy::iterator I = SavedAdjustments.find(GD);
2481 if (I != SavedAdjustments.end())
2482 return &I->second;
Eli Friedman8174f2c2009-12-06 22:01:30 +00002483
2484 const CXXRecordDecl *RD = cast<CXXRecordDecl>(GD.getDecl()->getDeclContext());
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002485 if (!SavedAdjustmentRecords.insert(RD).second)
2486 return 0;
Eli Friedman8174f2c2009-12-06 22:01:30 +00002487
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002488 AddressPointsMapTy AddressPoints;
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002489 OldVtableBuilder b(RD, RD, 0, CGM, false, AddressPoints);
Eli Friedman8174f2c2009-12-06 22:01:30 +00002490 D1(printf("vtable %s\n", RD->getNameAsCString()));
2491 b.GenerateVtableForBase(RD);
2492 b.GenerateVtableForVBases(RD);
Eli Friedman8174f2c2009-12-06 22:01:30 +00002493
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002494 for (OldVtableBuilder::SavedAdjustmentsVectorTy::iterator
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002495 i = b.getSavedAdjustments().begin(),
2496 e = b.getSavedAdjustments().end(); i != e; i++)
2497 SavedAdjustments[i->first].push_back(i->second);
Eli Friedman8174f2c2009-12-06 22:01:30 +00002498
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002499 I = SavedAdjustments.find(GD);
2500 if (I != SavedAdjustments.end())
2501 return &I->second;
2502
2503 return 0;
Eli Friedman8174f2c2009-12-06 22:01:30 +00002504}
2505
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002506int64_t CGVtableInfo::getVirtualBaseOffsetIndex(const CXXRecordDecl *RD,
2507 const CXXRecordDecl *VBase) {
2508 ClassPairTy ClassPair(RD, VBase);
2509
2510 VirtualBaseClassIndiciesTy::iterator I =
2511 VirtualBaseClassIndicies.find(ClassPair);
2512 if (I != VirtualBaseClassIndicies.end())
2513 return I->second;
2514
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002515 // FIXME: This seems expensive. Can we do a partial job to get
2516 // just this data.
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002517 AddressPointsMapTy AddressPoints;
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002518 OldVtableBuilder b(RD, RD, 0, CGM, false, AddressPoints);
Mike Stump75ce5732009-10-31 20:06:59 +00002519 D1(printf("vtable %s\n", RD->getNameAsCString()));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002520 b.GenerateVtableForBase(RD);
2521 b.GenerateVtableForVBases(RD);
2522
2523 for (llvm::DenseMap<const CXXRecordDecl *, uint64_t>::iterator I =
2524 b.getVBIndex().begin(), E = b.getVBIndex().end(); I != E; ++I) {
2525 // Insert all types.
2526 ClassPairTy ClassPair(RD, I->first);
2527
2528 VirtualBaseClassIndicies.insert(std::make_pair(ClassPair, I->second));
2529 }
2530
2531 I = VirtualBaseClassIndicies.find(ClassPair);
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00002532 // FIXME: The assertion below assertion currently fails with the old vtable
2533 /// layout code if there is a non-virtual thunk adjustment in a vtable.
2534 // Once the new layout is in place, this return should be removed.
2535 if (I == VirtualBaseClassIndicies.end())
2536 return 0;
2537
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002538 assert(I != VirtualBaseClassIndicies.end() && "Did not find index!");
2539
2540 return I->second;
2541}
2542
Anders Carlssonc8e39ec2009-12-05 21:03:56 +00002543uint64_t CGVtableInfo::getVtableAddressPoint(const CXXRecordDecl *RD) {
2544 uint64_t AddressPoint =
Anders Carlsson93a18842010-01-02 18:02:32 +00002545 (*(*(CGM.getVtableInfo().AddressPoints[RD]))[RD])[std::make_pair(RD, 0)];
Anders Carlssonc8e39ec2009-12-05 21:03:56 +00002546
2547 return AddressPoint;
2548}
2549
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00002550llvm::GlobalVariable *
Anders Carlsson0911ae82009-12-06 00:23:49 +00002551CGVtableInfo::GenerateVtable(llvm::GlobalVariable::LinkageTypes Linkage,
Anders Carlsson232324c2009-12-06 00:53:22 +00002552 bool GenerateDefinition,
Anders Carlsson0911ae82009-12-06 00:23:49 +00002553 const CXXRecordDecl *LayoutClass,
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002554 const CXXRecordDecl *RD, uint64_t Offset,
2555 AddressPointsMapTy& AddressPoints) {
Anders Carlsson1888b442010-02-14 00:22:59 +00002556 if (GenerateDefinition && CGM.getLangOptions().DumpVtableLayouts &&
2557 LayoutClass == RD) {
Anders Carlssoncf5a8822010-02-13 21:07:32 +00002558 VtableBuilder Builder(*this, RD);
Anders Carlssoneee53d92010-02-13 02:02:03 +00002559
2560 Builder.dumpLayout(llvm::errs());
2561 }
2562
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002563 llvm::SmallString<256> OutName;
Mike Stump2cefe382009-11-12 20:47:57 +00002564 if (LayoutClass != RD)
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00002565 CGM.getMangleContext().mangleCXXCtorVtable(LayoutClass, Offset / 8,
2566 RD, OutName);
Mike Stumpeac45592009-11-11 20:26:26 +00002567 else
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00002568 CGM.getMangleContext().mangleCXXVtable(RD, OutName);
Daniel Dunbare128dd12009-11-21 09:06:22 +00002569 llvm::StringRef Name = OutName.str();
Benjamin Kramerbb0a07b2009-10-11 22:57:54 +00002570
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00002571 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name);
Anders Carlsson93a18842010-01-02 18:02:32 +00002572 if (GV == 0 || CGM.getVtableInfo().AddressPoints[LayoutClass] == 0 ||
2573 GV->isDeclaration()) {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002574 OldVtableBuilder b(RD, LayoutClass, Offset, CGM, GenerateDefinition,
2575 AddressPoints);
Eli Friedman6c08ce72009-12-05 01:05:03 +00002576
2577 D1(printf("vtable %s\n", RD->getNameAsCString()));
2578 // First comes the vtables for all the non-virtual bases...
Mike Stumpd538a6d2009-12-24 07:29:41 +00002579 b.GenerateVtableForBase(RD, Offset);
Eli Friedman6c08ce72009-12-05 01:05:03 +00002580
2581 // then the vtables for all the virtual bases.
2582 b.GenerateVtableForVBases(RD, Offset);
2583
Anders Carlsson58b271d2009-12-05 22:19:10 +00002584 llvm::Constant *Init = 0;
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00002585 const llvm::Type *Int8PtrTy = llvm::Type::getInt8PtrTy(CGM.getLLVMContext());
Anders Carlsson58b271d2009-12-05 22:19:10 +00002586 llvm::ArrayType *ArrayType =
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002587 llvm::ArrayType::get(Int8PtrTy, b.getVtableComponents().size());
Anders Carlssona95d4c52009-12-05 21:09:05 +00002588
Anders Carlsson232324c2009-12-06 00:53:22 +00002589 if (GenerateDefinition)
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002590 Init = llvm::ConstantArray::get(ArrayType, &b.getVtableComponents()[0],
2591 b.getVtableComponents().size());
Anders Carlsson232324c2009-12-06 00:53:22 +00002592
Mike Stumpaa51ad62009-11-19 04:04:36 +00002593 llvm::GlobalVariable *OGV = GV;
Anders Carlsson232324c2009-12-06 00:53:22 +00002594
2595 GV = new llvm::GlobalVariable(CGM.getModule(), ArrayType,
2596 /*isConstant=*/true, Linkage, Init, Name);
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002597 CGM.setGlobalVisibility(GV, RD);
2598
Mike Stumpaa51ad62009-11-19 04:04:36 +00002599 if (OGV) {
2600 GV->takeName(OGV);
Anders Carlsson58b271d2009-12-05 22:19:10 +00002601 llvm::Constant *NewPtr =
2602 llvm::ConstantExpr::getBitCast(GV, OGV->getType());
Mike Stumpaa51ad62009-11-19 04:04:36 +00002603 OGV->replaceAllUsesWith(NewPtr);
2604 OGV->eraseFromParent();
2605 }
Mike Stumpaa51ad62009-11-19 04:04:36 +00002606 }
Anders Carlssonb3f54b72009-12-05 21:28:12 +00002607
2608 return GV;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002609}
Mike Stump9f23a142009-11-10 02:30:51 +00002610
Anders Carlsson232324c2009-12-06 00:53:22 +00002611void CGVtableInfo::GenerateClassData(llvm::GlobalVariable::LinkageTypes Linkage,
2612 const CXXRecordDecl *RD) {
Anders Carlssone1b3e622009-12-07 07:59:52 +00002613 llvm::GlobalVariable *&Vtable = Vtables[RD];
2614 if (Vtable) {
2615 assert(Vtable->getInitializer() && "Vtable doesn't have a definition!");
2616 return;
2617 }
2618
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002619 AddressPointsMapTy AddressPoints;
2620 Vtable = GenerateVtable(Linkage, /*GenerateDefinition=*/true, RD, RD, 0,
2621 AddressPoints);
Anders Carlssone36a6b32010-01-02 01:01:18 +00002622 GenerateVTT(Linkage, /*GenerateDefinition=*/true, RD);
Mike Stump1a139f82009-11-19 01:08:19 +00002623}
2624
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00002625llvm::GlobalVariable *CGVtableInfo::getVtable(const CXXRecordDecl *RD) {
Anders Carlsson232324c2009-12-06 00:53:22 +00002626 llvm::GlobalVariable *Vtable = Vtables.lookup(RD);
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00002627
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002628 if (!Vtable) {
2629 AddressPointsMapTy AddressPoints;
Anders Carlsson232324c2009-12-06 00:53:22 +00002630 Vtable = GenerateVtable(llvm::GlobalValue::ExternalLinkage,
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002631 /*GenerateDefinition=*/false, RD, RD, 0,
2632 AddressPoints);
2633 }
Mike Stumpaa51ad62009-11-19 04:04:36 +00002634
Anders Carlsson4ed44eb2009-12-05 22:42:54 +00002635 return Vtable;
Mike Stumpd846d082009-11-10 07:44:33 +00002636}
Mike Stumpeac45592009-11-11 20:26:26 +00002637
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002638void CGVtableInfo::MaybeEmitVtable(GlobalDecl GD) {
2639 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2640 const CXXRecordDecl *RD = MD->getParent();
2641
Anders Carlsson4ed44eb2009-12-05 22:42:54 +00002642 // If the class doesn't have a vtable we don't need to emit one.
2643 if (!RD->isDynamicClass())
2644 return;
2645
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002646 // Get the key function.
Anders Carlsson5ebf8b42009-12-07 04:35:11 +00002647 const CXXMethodDecl *KeyFunction = CGM.getContext().getKeyFunction(RD);
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002648
Anders Carlsson4ed44eb2009-12-05 22:42:54 +00002649 if (KeyFunction) {
2650 // We don't have the right key function.
2651 if (KeyFunction->getCanonicalDecl() != MD->getCanonicalDecl())
2652 return;
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002653 }
2654
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002655 // Emit the data.
Douglas Gregorccecc1b2010-01-06 20:27:16 +00002656 GenerateClassData(CGM.getVtableLinkage(RD), RD);
Eli Friedman8174f2c2009-12-06 22:01:30 +00002657
2658 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
2659 e = RD->method_end(); i != e; ++i) {
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002660 if ((*i)->isVirtual() && ((*i)->hasInlineBody() || (*i)->isImplicit())) {
Eli Friedman8174f2c2009-12-06 22:01:30 +00002661 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(*i)) {
2662 CGM.BuildThunksForVirtual(GlobalDecl(DD, Dtor_Complete));
2663 CGM.BuildThunksForVirtual(GlobalDecl(DD, Dtor_Deleting));
2664 } else {
2665 CGM.BuildThunksForVirtual(GlobalDecl(*i));
2666 }
2667 }
2668 }
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002669}
2670