blob: 970bbd777f1418662ca94628e8391bb8267c615d [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
825public:
Anders Carlssoncf5a8822010-02-13 21:07:32 +0000826 VtableBuilder(CGVtableInfo &VtableInfo, const CXXRecordDecl *MostDerivedClass)
827 : VtableInfo(VtableInfo), MostDerivedClass(MostDerivedClass),
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000828 Context(MostDerivedClass->getASTContext()), Overriders(MostDerivedClass) {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000829
Anders Carlssondc2dba32010-02-16 04:49:44 +0000830 LayoutVtable(BaseSubobject(MostDerivedClass, 0));
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000831 }
832
833 /// dumpLayout - Dump the vtable layout.
834 void dumpLayout(llvm::raw_ostream&);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000835};
836
Anders Carlsson65b49782010-02-12 05:25:12 +0000837/// OverridesMethodInPrimaryBase - Checks whether whether this virtual member
838/// function overrides a member function in a direct or indirect primary base.
839/// Returns the overridden member function, or null if none was found.
840static const CXXMethodDecl *
841OverridesMethodInPrimaryBase(const CXXMethodDecl *MD,
842 VtableBuilder::PrimaryBasesSetTy &PrimaryBases) {
843 for (CXXMethodDecl::method_iterator I = MD->begin_overridden_methods(),
844 E = MD->end_overridden_methods(); I != E; ++I) {
845 const CXXMethodDecl *OverriddenMD = *I;
846 const CXXRecordDecl *OverriddenRD = OverriddenMD->getParent();
847 assert(OverriddenMD->isCanonicalDecl() &&
848 "Should have the canonical decl of the overridden RD!");
849
850 if (PrimaryBases.count(OverriddenRD))
851 return OverriddenMD;
852 }
853
854 return 0;
855}
856
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000857VtableBuilder::ReturnAdjustment
858VtableBuilder::ComputeReturnAdjustment(FinalOverriders::BaseOffset Offset) {
859 ReturnAdjustment Adjustment;
860
861 if (!Offset.isEmpty()) {
Anders Carlssoncf5a8822010-02-13 21:07:32 +0000862 if (Offset.VirtualBase) {
863 // Get the virtual base offset offset.
864 Adjustment.VBaseOffsetOffset =
865 VtableInfo.getVirtualBaseOffsetIndex(Offset.DerivedClass,
866 Offset.VirtualBase);
867 // FIXME: Once the assert in getVirtualBaseOffsetIndex is back again,
868 // we can get rid of this assert.
869 assert(Adjustment.VBaseOffsetOffset != 0 &&
870 "Invalid base offset offset!");
871 }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000872
873 Adjustment.NonVirtual = Offset.NonVirtualOffset;
874 }
875
876 return Adjustment;
877}
878
Anders Carlssond3adb0c2010-02-13 23:40:17 +0000879VtableBuilder::ThisAdjustment
880VtableBuilder::ComputeThisAdjustment(FinalOverriders::BaseOffset Offset) {
881 ThisAdjustment Adjustment;
882
883 if (!Offset.isEmpty()) {
884 assert(!Offset.VirtualBase && "FIXME: Handle virtual bases!");
885 Adjustment.NonVirtual = Offset.NonVirtualOffset;
886 }
887
888 return Adjustment;
889}
890
Anders Carlsson65b49782010-02-12 05:25:12 +0000891void
Anders Carlssondc2dba32010-02-16 04:49:44 +0000892VtableBuilder::AddVCallAndVBaseOffsets(const CXXRecordDecl *RD,
893 int64_t OffsetToTop,
894 VisitedVirtualBasesSetTy &VBases) {
895 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
896
897 // Itanium C++ ABI 2.5.2:
898 // ..in classes sharing a virtual table with a primary base class, the vcall
899 // and vbase offsets added by the derived class all come before the vcall
900 // and vbase offsets required by the base class, so that the latter may be
901 // laid out as required by the base class without regard to additions from
902 // the derived class(es).
903
904 // (Since we're emitting the vcall and vbase offsets in reverse order, we'll
905 // emit them for the primary base first).
906 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase())
907 AddVCallAndVBaseOffsets(PrimaryBase, OffsetToTop, VBases);
908
909 AddVBaseOffsets(RD, OffsetToTop, VBases);
910}
911
912void VtableBuilder::AddVBaseOffsets(const CXXRecordDecl *RD,
913 int64_t OffsetToTop,
914 VisitedVirtualBasesSetTy &VBases) {
Anders Carlsson77904f12010-02-16 04:59:55 +0000915 const ASTRecordLayout &MostDerivedClassLayout =
916 Context.getASTRecordLayout(MostDerivedClass);
917
918 // Add vbase offsets.
919 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
920 E = RD->bases_end(); I != E; ++I) {
921 const CXXRecordDecl *BaseDecl =
922 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
923
924 // Check if this is a virtual base that we haven't visited before.
925 if (I->isVirtual() && VBases.insert(BaseDecl)) {
926 // FIXME: We shouldn't use / 8 here.
927 uint64_t Offset =
928 OffsetToTop + MostDerivedClassLayout.getVBaseClassOffset(BaseDecl) / 8;
929
930 VCallAndVBaseOffsets.push_back(VtableComponent::MakeVBaseOffset(Offset));
931 }
932
933 // Check the base class looking for more vbase offsets.
934 AddVBaseOffsets(BaseDecl, OffsetToTop, VBases);
935 }
Anders Carlssondc2dba32010-02-16 04:49:44 +0000936}
937
938void
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000939VtableBuilder::AddMethod(const CXXMethodDecl *MD,
Anders Carlssond3adb0c2010-02-13 23:40:17 +0000940 ReturnAdjustment ReturnAdjustment,
941 ThisAdjustment ThisAdjustment) {
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000942 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
943 assert(ReturnAdjustment.isEmpty() &&
944 "Destructor can't have return adjustment!");
Anders Carlssond3adb0c2010-02-13 23:40:17 +0000945 // Add the 'this' pointer adjustments if necessary.
946 if (!ThisAdjustment.isEmpty()) {
947 ThisAdjustments.push_back(std::make_pair(Components.size(),
948 ThisAdjustment));
949 ThisAdjustments.push_back(std::make_pair(Components.size() + 1,
950 ThisAdjustment));
951 }
952
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000953 // Add both the complete destructor and the deleting destructor.
954 Components.push_back(VtableComponent::MakeCompleteDtor(DD));
955 Components.push_back(VtableComponent::MakeDeletingDtor(DD));
956 } else {
957 // Add the return adjustment if necessary.
958 if (!ReturnAdjustment.isEmpty())
959 ReturnAdjustments.push_back(std::make_pair(Components.size(),
960 ReturnAdjustment));
961
Anders Carlssond3adb0c2010-02-13 23:40:17 +0000962 // Add the 'this' pointer adjustment if necessary.
963 if (!ThisAdjustment.isEmpty())
964 ThisAdjustments.push_back(std::make_pair(Components.size(),
965 ThisAdjustment));
966
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000967 // Add the function.
968 Components.push_back(VtableComponent::MakeFunction(MD));
969 }
970}
971
972void
973VtableBuilder::AddMethods(BaseSubobject Base, PrimaryBasesSetTy &PrimaryBases) {
Anders Carlsson65b49782010-02-12 05:25:12 +0000974 const CXXRecordDecl *RD = Base.getBase();
975
976 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
977
978 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
979 if (Layout.getPrimaryBaseWasVirtual())
980 assert(false && "FIXME: Handle vbases here.");
981 else
982 assert(Layout.getBaseClassOffset(PrimaryBase) == 0 &&
983 "Primary base should have a zero offset!");
984
Anders Carlssone75aaa92010-02-13 22:05:23 +0000985 AddMethods(BaseSubobject(PrimaryBase, Base.getBaseOffset()), PrimaryBases);
Anders Carlsson65b49782010-02-12 05:25:12 +0000986
987 if (!PrimaryBases.insert(PrimaryBase))
988 assert(false && "Found a duplicate primary base!");
989 }
Anders Carlsson932c2f22010-02-11 17:18:51 +0000990
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000991 // Now go through all virtual member functions and add them.
992 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
993 E = RD->method_end(); I != E; ++I) {
994 const CXXMethodDecl *MD = *I;
Anders Carlsson65b49782010-02-12 05:25:12 +0000995
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000996 if (!MD->isVirtual())
997 continue;
Anders Carlsson65b49782010-02-12 05:25:12 +0000998
999 // Get the final overrider.
Anders Carlsson136bd192010-02-12 16:55:34 +00001000 FinalOverriders::OverriderInfo Overrider =
1001 Overriders.getOverrider(Base, MD);
Anders Carlsson65b49782010-02-12 05:25:12 +00001002
1003 // Check if this virtual member function overrides a method in a primary
1004 // base. If this is the case, and the return type doesn't require adjustment
1005 // then we can just use the member function from the primary base.
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001006 if (const CXXMethodDecl *OverriddenMD =
1007 OverridesMethodInPrimaryBase(MD, PrimaryBases)) {
Anders Carlssoncce9ee82010-02-13 23:17:31 +00001008 if (ComputeReturnAdjustmentBaseOffset(Context, MD,
1009 OverriddenMD).isEmpty())
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001010 continue;
1011 }
Anders Carlssoneee53d92010-02-13 02:02:03 +00001012
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001013 // Check if this overrider needs a return adjustment.
1014 FinalOverriders::BaseOffset ReturnAdjustmentOffset =
1015 Overriders.getReturnAdjustmentOffset(Base, MD);
1016
1017 ReturnAdjustment ReturnAdjustment =
1018 ComputeReturnAdjustment(ReturnAdjustmentOffset);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001019
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001020 // Check if this overrider needs a 'this' pointer adjustment.
1021 FinalOverriders::BaseOffset ThisAdjustmentOffset =
1022 Overriders.getThisAdjustmentOffset(Base, MD);
1023
1024 ThisAdjustment ThisAdjustment = ComputeThisAdjustment(ThisAdjustmentOffset);
1025
1026 AddMethod(Overrider.Method, ReturnAdjustment, ThisAdjustment);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001027 }
1028}
1029
Anders Carlssondc2dba32010-02-16 04:49:44 +00001030void VtableBuilder::LayoutVtable(BaseSubobject Base) {
Anders Carlsson65b49782010-02-12 05:25:12 +00001031 const CXXRecordDecl *RD = Base.getBase();
Anders Carlsson033d4862010-02-14 17:05:59 +00001032 assert(RD->isDynamicClass() && "class does not have a vtable!");
1033
Anders Carlsson77904f12010-02-16 04:59:55 +00001034 int64_t OffsetToTop = -(int64_t)Base.getBaseOffset() / 8;
1035
1036 // Add vcall and vbase offsets for this vtable.
1037 VisitedVirtualBasesSetTy VBases;
1038 AddVCallAndVBaseOffsets(RD, OffsetToTop, VBases);
1039
1040 // Reverse them and add them to the vtable components.
1041 std::reverse(VCallAndVBaseOffsets.begin(), VCallAndVBaseOffsets.end());
1042 Components.append(VCallAndVBaseOffsets.begin(), VCallAndVBaseOffsets.end());
1043 VCallAndVBaseOffsets.clear();
1044
1045 // Add the offset to top.
Anders Carlssone75aaa92010-02-13 22:05:23 +00001046 // FIXME: This is not going to be right for construction vtables.
Anders Carlsson258a1e32010-02-14 00:16:19 +00001047 // FIXME: We should not use / 8 here.
Anders Carlssone75aaa92010-02-13 22:05:23 +00001048 Components.push_back(VtableComponent::MakeOffsetToTop(OffsetToTop));
Anders Carlsson65b49782010-02-12 05:25:12 +00001049
1050 // Next, add the RTTI.
Anders Carlssone75aaa92010-02-13 22:05:23 +00001051 Components.push_back(VtableComponent::MakeRTTI(MostDerivedClass));
Anders Carlsson65b49782010-02-12 05:25:12 +00001052
Anders Carlssone8a97562010-02-12 07:43:48 +00001053 uint64_t AddressPoint = Components.size();
Anders Carlsson65b49782010-02-12 05:25:12 +00001054
1055 // Now go through all virtual member functions and add them.
1056 PrimaryBasesSetTy PrimaryBases;
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001057 AddMethods(Base, PrimaryBases);
Anders Carlsson65b49782010-02-12 05:25:12 +00001058
Anders Carlssone8a97562010-02-12 07:43:48 +00001059 // Record the address point.
1060 AddressPoints.insert(std::make_pair(Base, AddressPoint));
1061
1062 // Record the address points for all primary bases.
1063 for (PrimaryBasesSetTy::const_iterator I = PrimaryBases.begin(),
1064 E = PrimaryBases.end(); I != E; ++I) {
1065 const CXXRecordDecl *BaseDecl = *I;
1066
1067 // We know that all the primary bases have the same offset as the base
1068 // subobject.
1069 BaseSubobject PrimaryBase(BaseDecl, Base.getBaseOffset());
1070 AddressPoints.insert(std::make_pair(PrimaryBase, AddressPoint));
1071 }
1072
Anders Carlsson65b49782010-02-12 05:25:12 +00001073 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1074 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
1075
Anders Carlssone75aaa92010-02-13 22:05:23 +00001076 // Layout secondary vtables.
Anders Carlsson65b49782010-02-12 05:25:12 +00001077 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1078 E = RD->bases_end(); I != E; ++I) {
1079 const CXXRecordDecl *BaseDecl =
1080 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson033d4862010-02-14 17:05:59 +00001081
Anders Carlssondc2dba32010-02-16 04:49:44 +00001082 // Ignore bases that don't have a vtable.
1083 if (!BaseDecl->isDynamicClass())
1084 continue;
1085
Anders Carlsson65b49782010-02-12 05:25:12 +00001086 // Ignore the primary base.
1087 if (BaseDecl == PrimaryBase)
1088 continue;
Anders Carlsson033d4862010-02-14 17:05:59 +00001089
Anders Carlssondc2dba32010-02-16 04:49:44 +00001090 // Ignore virtual bases, we'll emit them later.
1091 if (I->isVirtual())
Anders Carlsson033d4862010-02-14 17:05:59 +00001092 continue;
Anders Carlsson65b49782010-02-12 05:25:12 +00001093
Anders Carlssone75aaa92010-02-13 22:05:23 +00001094 // Get the base offset of this base.
1095 uint64_t BaseOffset = Base.getBaseOffset() +
1096 Layout.getBaseClassOffset(BaseDecl);
1097
1098 // Layout this secondary vtable.
Anders Carlssondc2dba32010-02-16 04:49:44 +00001099 LayoutVtable(BaseSubobject(BaseDecl, BaseOffset));
Anders Carlsson65b49782010-02-12 05:25:12 +00001100 }
Anders Carlssondc2dba32010-02-16 04:49:44 +00001101
1102 // FIXME: Emit vtables for virtual bases here.
Anders Carlsson65b49782010-02-12 05:25:12 +00001103}
1104
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001105/// dumpLayout - Dump the vtable layout.
1106void VtableBuilder::dumpLayout(llvm::raw_ostream& Out) {
1107
1108 Out << "Vtable for '" << MostDerivedClass->getQualifiedNameAsString();
1109 Out << "' (" << Components.size() << " entries).\n";
1110
Anders Carlsson932c2f22010-02-11 17:18:51 +00001111 // Iterate through the address points and insert them into a new map where
1112 // they are keyed by the index and not the base object.
1113 // Since an address point can be shared by multiple subobjects, we use an
1114 // STL multimap.
1115 std::multimap<uint64_t, BaseSubobject> AddressPointsByIndex;
1116 for (CGVtableInfo::AddressPointsMapTy::const_iterator I =
1117 AddressPoints.begin(), E = AddressPoints.end(); I != E; ++I) {
1118 const BaseSubobject& Base = I->first;
1119 uint64_t Index = I->second;
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001120
Anders Carlsson932c2f22010-02-11 17:18:51 +00001121 AddressPointsByIndex.insert(std::make_pair(Index, Base));
1122 }
1123
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001124 unsigned NextReturnAdjustmentIndex = 0;
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001125 unsigned NextThisAdjustmentIndex = 0;
Anders Carlsson932c2f22010-02-11 17:18:51 +00001126 for (unsigned I = 0, E = Components.size(); I != E; ++I) {
Anders Carlssone8a97562010-02-12 07:43:48 +00001127 uint64_t Index = I;
1128
Anders Carlsson932c2f22010-02-11 17:18:51 +00001129 if (AddressPointsByIndex.count(I)) {
Anders Carlssone8a97562010-02-12 07:43:48 +00001130 if (AddressPointsByIndex.count(Index) == 1) {
1131 const BaseSubobject &Base = AddressPointsByIndex.find(Index)->second;
1132
1133 // FIXME: Instead of dividing by 8, we should be using CharUnits.
1134 Out << " -- (" << Base.getBase()->getQualifiedNameAsString();
1135 Out << ", " << Base.getBaseOffset() / 8 << ") vtable address --\n";
1136 } else {
1137 uint64_t BaseOffset =
1138 AddressPointsByIndex.lower_bound(Index)->second.getBaseOffset();
1139
1140 // We store the class names in a set to get a stable order.
1141 std::set<std::string> ClassNames;
1142 for (std::multimap<uint64_t, BaseSubobject>::const_iterator I =
1143 AddressPointsByIndex.lower_bound(Index), E =
1144 AddressPointsByIndex.upper_bound(Index); I != E; ++I) {
1145 assert(I->second.getBaseOffset() == BaseOffset &&
1146 "Invalid base offset!");
1147 const CXXRecordDecl *RD = I->second.getBase();
1148 ClassNames.insert(RD->getQualifiedNameAsString());
1149 }
1150
1151 for (std::set<std::string>::const_iterator I = ClassNames.begin(),
1152 E = ClassNames.end(); I != E; ++I) {
1153 // FIXME: Instead of dividing by 8, we should be using CharUnits.
1154 Out << " -- (" << *I;
1155 Out << ", " << BaseOffset / 8 << ") vtable address --\n";
1156 }
1157 }
Anders Carlsson932c2f22010-02-11 17:18:51 +00001158 }
1159
1160 Out << llvm::format("%4d | ", I);
1161
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001162 const VtableComponent &Component = Components[I];
1163
1164 // Dump the component.
1165 switch (Component.getKind()) {
1166 // FIXME: Remove this default case.
1167 default:
1168 assert(false && "Unhandled component kind!");
1169 break;
Anders Carlsson77904f12010-02-16 04:59:55 +00001170
1171 case VtableComponent::CK_VBaseOffset:
1172 Out << "vbase_offset (" << Component.getVBaseOffset() << ")";
1173 break;
1174
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001175 case VtableComponent::CK_OffsetToTop:
1176 Out << "offset_to_top (" << Component.getOffsetToTop() << ")";
1177 break;
1178
1179 case VtableComponent::CK_RTTI:
1180 Out << Component.getRTTIDecl()->getQualifiedNameAsString() << " RTTI";
1181 break;
1182
Anders Carlsson5bd8d192010-02-11 18:20:28 +00001183 case VtableComponent::CK_FunctionPointer: {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001184 const CXXMethodDecl *MD = Component.getFunctionDecl();
1185
Anders Carlsson5bd8d192010-02-11 18:20:28 +00001186 std::string Str =
1187 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
1188 MD);
1189 Out << Str;
Anders Carlsson09da3372010-02-12 02:38:13 +00001190 if (MD->isPure())
1191 Out << " [pure]";
1192
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001193 // If this function pointer has a return adjustment, dump it.
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001194 if (NextReturnAdjustmentIndex < ReturnAdjustments.size() &&
1195 ReturnAdjustments[NextReturnAdjustmentIndex].first == I) {
1196 const ReturnAdjustment Adjustment =
1197 ReturnAdjustments[NextReturnAdjustmentIndex].second;
1198
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001199 Out << "\n [return adjustment: ";
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001200 Out << Adjustment.NonVirtual << " non-virtual";
1201
1202 if (Adjustment.VBaseOffsetOffset)
1203 Out << ", " << Adjustment.VBaseOffsetOffset << " vbase offset offset";
1204 Out << ']';
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001205
1206 NextReturnAdjustmentIndex++;
1207 }
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001208
1209 // If this function pointer has a 'this' pointer adjustment, dump it.
1210 if (NextThisAdjustmentIndex < ThisAdjustments.size() &&
1211 ThisAdjustments[NextThisAdjustmentIndex].first == I) {
1212 const ThisAdjustment Adjustment =
1213 ThisAdjustments[NextThisAdjustmentIndex].second;
1214
1215 Out << "\n [this adjustment: ";
1216 Out << Adjustment.NonVirtual << " non-virtual";
1217
1218 Out << ']';
1219
1220 NextThisAdjustmentIndex++;
1221 }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001222
Anders Carlsson5bd8d192010-02-11 18:20:28 +00001223 break;
1224 }
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001225
Anders Carlsson5bd8d192010-02-11 18:20:28 +00001226 case VtableComponent::CK_CompleteDtorPointer: {
1227 const CXXDestructorDecl *DD = Component.getDestructorDecl();
1228
1229 Out << DD->getQualifiedNameAsString() << "() [complete]";
Anders Carlsson09da3372010-02-12 02:38:13 +00001230 if (DD->isPure())
1231 Out << " [pure]";
1232
Anders Carlsson5bd8d192010-02-11 18:20:28 +00001233 break;
1234 }
1235
1236 case VtableComponent::CK_DeletingDtorPointer: {
1237 const CXXDestructorDecl *DD = Component.getDestructorDecl();
1238
1239 Out << DD->getQualifiedNameAsString() << "() [deleting]";
Anders Carlsson09da3372010-02-12 02:38:13 +00001240 if (DD->isPure())
1241 Out << " [pure]";
1242
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001243 break;
1244 }
1245
1246 }
Anders Carlsson932c2f22010-02-11 17:18:51 +00001247
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001248 Out << '\n';
1249 }
1250
1251}
1252
1253}
1254
1255namespace {
1256class OldVtableBuilder {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001257public:
1258 /// Index_t - Vtable index type.
1259 typedef uint64_t Index_t;
Eli Friedman31bc3ad2009-12-07 23:56:34 +00001260 typedef std::vector<std::pair<GlobalDecl,
1261 std::pair<GlobalDecl, ThunkAdjustment> > >
1262 SavedAdjustmentsVectorTy;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001263private:
Anders Carlsson472404f2009-12-04 16:19:30 +00001264
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00001265 // VtableComponents - The components of the vtable being built.
1266 typedef llvm::SmallVector<llvm::Constant *, 64> VtableComponentsVectorTy;
1267 VtableComponentsVectorTy VtableComponents;
1268
Eli Friedman6c08ce72009-12-05 01:05:03 +00001269 const bool BuildVtable;
1270
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001271 llvm::Type *Ptr8Ty;
Anders Carlssonbad80eb2009-12-04 18:36:22 +00001272
1273 /// MostDerivedClass - The most derived class that this vtable is being
1274 /// built for.
1275 const CXXRecordDecl *MostDerivedClass;
1276
Mike Stump83066c82009-11-13 01:54:23 +00001277 /// LayoutClass - The most derived class used for virtual base layout
1278 /// information.
1279 const CXXRecordDecl *LayoutClass;
Mike Stump653d0b92009-11-13 02:13:54 +00001280 /// LayoutOffset - The offset for Class in LayoutClass.
1281 uint64_t LayoutOffset;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001282 /// BLayout - Layout for the most derived class that this vtable is being
1283 /// built for.
1284 const ASTRecordLayout &BLayout;
1285 llvm::SmallSet<const CXXRecordDecl *, 32> IndirectPrimary;
1286 llvm::SmallSet<const CXXRecordDecl *, 32> SeenVBase;
1287 llvm::Constant *rtti;
1288 llvm::LLVMContext &VMContext;
1289 CodeGenModule &CGM; // Per-module state.
Anders Carlssonf2f31f42009-12-04 03:46:21 +00001290
Mike Stump90181eb2010-01-26 00:05:04 +00001291 llvm::DenseMap<const CXXMethodDecl *, Index_t> VCall;
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001292 llvm::DenseMap<GlobalDecl, Index_t> VCallOffset;
Mike Stump77537b12010-01-26 03:42:22 +00001293 llvm::DenseMap<GlobalDecl, Index_t> VCallOffsetForVCall;
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00001294 // This is the offset to the nearest virtual base
Mike Stump90181eb2010-01-26 00:05:04 +00001295 llvm::DenseMap<const CXXMethodDecl *, Index_t> NonVirtualOffset;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001296 llvm::DenseMap<const CXXRecordDecl *, Index_t> VBIndex;
Mike Stumpbb9ff052009-10-27 23:46:47 +00001297
Anders Carlsson323bb042009-11-26 19:54:33 +00001298 /// PureVirtualFunction - Points to __cxa_pure_virtual.
1299 llvm::Constant *PureVirtualFn;
1300
Anders Carlssona84b6e82009-12-04 02:01:07 +00001301 /// VtableMethods - A data structure for keeping track of methods in a vtable.
1302 /// Can add methods, override methods and iterate in vtable order.
1303 class VtableMethods {
1304 // MethodToIndexMap - Maps from a global decl to the index it has in the
1305 // Methods vector.
1306 llvm::DenseMap<GlobalDecl, uint64_t> MethodToIndexMap;
1307
1308 /// Methods - The methods, in vtable order.
1309 typedef llvm::SmallVector<GlobalDecl, 16> MethodsVectorTy;
1310 MethodsVectorTy Methods;
Eli Friedman8174f2c2009-12-06 22:01:30 +00001311 MethodsVectorTy OrigMethods;
Anders Carlssona84b6e82009-12-04 02:01:07 +00001312
1313 public:
1314 /// AddMethod - Add a method to the vtable methods.
1315 void AddMethod(GlobalDecl GD) {
1316 assert(!MethodToIndexMap.count(GD) &&
1317 "Method has already been added!");
1318
1319 MethodToIndexMap[GD] = Methods.size();
1320 Methods.push_back(GD);
Eli Friedman8174f2c2009-12-06 22:01:30 +00001321 OrigMethods.push_back(GD);
Anders Carlssona84b6e82009-12-04 02:01:07 +00001322 }
1323
1324 /// OverrideMethod - Replace a method with another.
1325 void OverrideMethod(GlobalDecl OverriddenGD, GlobalDecl GD) {
1326 llvm::DenseMap<GlobalDecl, uint64_t>::iterator i
1327 = MethodToIndexMap.find(OverriddenGD);
1328 assert(i != MethodToIndexMap.end() && "Did not find entry!");
1329
1330 // Get the index of the old decl.
1331 uint64_t Index = i->second;
1332
1333 // Replace the old decl with the new decl.
1334 Methods[Index] = GD;
1335
Anders Carlssona84b6e82009-12-04 02:01:07 +00001336 // And add the new.
1337 MethodToIndexMap[GD] = Index;
1338 }
1339
Anders Carlsson7bb70762009-12-04 15:49:02 +00001340 /// getIndex - Gives the index of a passed in GlobalDecl. Returns false if
1341 /// the index couldn't be found.
Benjamin Kramer62ab6162009-12-04 22:45:27 +00001342 bool getIndex(GlobalDecl GD, uint64_t &Index) const {
Anders Carlsson7bb70762009-12-04 15:49:02 +00001343 llvm::DenseMap<GlobalDecl, uint64_t>::const_iterator i
1344 = MethodToIndexMap.find(GD);
Eli Friedman3d2e9de2009-12-04 08:34:14 +00001345
Anders Carlsson7bb70762009-12-04 15:49:02 +00001346 if (i == MethodToIndexMap.end())
1347 return false;
Anders Carlssone6096362009-12-04 03:41:37 +00001348
Anders Carlsson7bb70762009-12-04 15:49:02 +00001349 Index = i->second;
1350 return true;
Anders Carlssone6096362009-12-04 03:41:37 +00001351 }
1352
Eli Friedman8174f2c2009-12-06 22:01:30 +00001353 GlobalDecl getOrigMethod(uint64_t Index) const {
1354 return OrigMethods[Index];
1355 }
1356
Anders Carlssona84b6e82009-12-04 02:01:07 +00001357 MethodsVectorTy::size_type size() const {
1358 return Methods.size();
1359 }
1360
1361 void clear() {
1362 MethodToIndexMap.clear();
1363 Methods.clear();
Eli Friedman8174f2c2009-12-06 22:01:30 +00001364 OrigMethods.clear();
Anders Carlssona84b6e82009-12-04 02:01:07 +00001365 }
1366
Anders Carlssone6096362009-12-04 03:41:37 +00001367 GlobalDecl operator[](uint64_t Index) const {
Anders Carlssona84b6e82009-12-04 02:01:07 +00001368 return Methods[Index];
1369 }
1370 };
1371
1372 /// Methods - The vtable methods we're currently building.
1373 VtableMethods Methods;
1374
Anders Carlsson4c837d22009-12-04 02:26:15 +00001375 /// ThisAdjustments - For a given index in the vtable, contains the 'this'
1376 /// pointer adjustment needed for a method.
1377 typedef llvm::DenseMap<uint64_t, ThunkAdjustment> ThisAdjustmentsMapTy;
1378 ThisAdjustmentsMapTy ThisAdjustments;
Anders Carlssond420a312009-11-26 19:32:45 +00001379
Eli Friedman31bc3ad2009-12-07 23:56:34 +00001380 SavedAdjustmentsVectorTy SavedAdjustments;
Eli Friedman8174f2c2009-12-06 22:01:30 +00001381
Anders Carlssonc521f952009-12-04 02:22:02 +00001382 /// BaseReturnTypes - Contains the base return types of methods who have been
1383 /// overridden with methods whose return types require adjustment. Used for
1384 /// generating covariant thunk information.
1385 typedef llvm::DenseMap<uint64_t, CanQualType> BaseReturnTypesMapTy;
1386 BaseReturnTypesMapTy BaseReturnTypes;
Anders Carlssond420a312009-11-26 19:32:45 +00001387
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001388 std::vector<Index_t> VCalls;
Mike Stump2cefe382009-11-12 20:47:57 +00001389
1390 typedef std::pair<const CXXRecordDecl *, uint64_t> CtorVtable_t;
Mike Stumpcd2b8212009-11-19 20:52:19 +00001391 // subAddressPoints - Used to hold the AddressPoints (offsets) into the built
1392 // vtable for use in computing the initializers for the VTT.
1393 llvm::DenseMap<CtorVtable_t, int64_t> &subAddressPoints;
Mike Stump2cefe382009-11-12 20:47:57 +00001394
Anders Carlsson5f9a8812010-01-14 02:29:07 +00001395 /// AddressPoints - Address points for this vtable.
1396 CGVtableInfo::AddressPointsMapTy& AddressPoints;
1397
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001398 typedef CXXRecordDecl::method_iterator method_iter;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001399 const uint32_t LLVMPointerWidth;
1400 Index_t extra;
Mike Stump37dbe962009-10-15 02:04:03 +00001401 typedef std::vector<std::pair<const CXXRecordDecl *, int64_t> > Path_t;
Mike Stumpcd2b8212009-11-19 20:52:19 +00001402 static llvm::DenseMap<CtorVtable_t, int64_t>&
1403 AllocAddressPoint(CodeGenModule &cgm, const CXXRecordDecl *l,
1404 const CXXRecordDecl *c) {
Anders Carlsson93a18842010-01-02 18:02:32 +00001405 CGVtableInfo::AddrMap_t *&oref = cgm.getVtableInfo().AddressPoints[l];
Mike Stumpcd2b8212009-11-19 20:52:19 +00001406 if (oref == 0)
Anders Carlsson93a18842010-01-02 18:02:32 +00001407 oref = new CGVtableInfo::AddrMap_t;
Mike Stumpcd2b8212009-11-19 20:52:19 +00001408
1409 llvm::DenseMap<CtorVtable_t, int64_t> *&ref = (*oref)[c];
1410 if (ref == 0)
1411 ref = new llvm::DenseMap<CtorVtable_t, int64_t>;
1412 return *ref;
1413 }
Anders Carlsson323bb042009-11-26 19:54:33 +00001414
Mike Stump90181eb2010-01-26 00:05:04 +00001415 bool DclIsSame(const FunctionDecl *New, const FunctionDecl *Old) {
1416 FunctionTemplateDecl *OldTemplate = Old->getDescribedFunctionTemplate();
1417 FunctionTemplateDecl *NewTemplate = New->getDescribedFunctionTemplate();
1418
1419 // C++ [temp.fct]p2:
1420 // A function template can be overloaded with other function templates
1421 // and with normal (non-template) functions.
1422 if ((OldTemplate == 0) != (NewTemplate == 0))
1423 return false;
1424
1425 // Is the function New an overload of the function Old?
1426 QualType OldQType = CGM.getContext().getCanonicalType(Old->getType());
1427 QualType NewQType = CGM.getContext().getCanonicalType(New->getType());
1428
1429 // Compare the signatures (C++ 1.3.10) of the two functions to
1430 // determine whether they are overloads. If we find any mismatch
1431 // in the signature, they are overloads.
1432
1433 // If either of these functions is a K&R-style function (no
1434 // prototype), then we consider them to have matching signatures.
1435 if (isa<FunctionNoProtoType>(OldQType.getTypePtr()) ||
1436 isa<FunctionNoProtoType>(NewQType.getTypePtr()))
1437 return true;
1438
1439 FunctionProtoType* OldType = cast<FunctionProtoType>(OldQType);
1440 FunctionProtoType* NewType = cast<FunctionProtoType>(NewQType);
1441
1442 // The signature of a function includes the types of its
1443 // parameters (C++ 1.3.10), which includes the presence or absence
1444 // of the ellipsis; see C++ DR 357).
1445 if (OldQType != NewQType &&
1446 (OldType->getNumArgs() != NewType->getNumArgs() ||
1447 OldType->isVariadic() != NewType->isVariadic() ||
1448 !std::equal(OldType->arg_type_begin(), OldType->arg_type_end(),
1449 NewType->arg_type_begin())))
1450 return false;
1451
1452#if 0
1453 // C++ [temp.over.link]p4:
1454 // The signature of a function template consists of its function
1455 // signature, its return type and its template parameter list. The names
1456 // of the template parameters are significant only for establishing the
1457 // relationship between the template parameters and the rest of the
1458 // signature.
1459 //
1460 // We check the return type and template parameter lists for function
1461 // templates first; the remaining checks follow.
1462 if (NewTemplate &&
1463 (!TemplateParameterListsAreEqual(NewTemplate->getTemplateParameters(),
1464 OldTemplate->getTemplateParameters(),
1465 TPL_TemplateMatch) ||
1466 OldType->getResultType() != NewType->getResultType()))
1467 return false;
1468#endif
1469
1470 // If the function is a class member, its signature includes the
1471 // cv-qualifiers (if any) on the function itself.
1472 //
1473 // As part of this, also check whether one of the member functions
1474 // is static, in which case they are not overloads (C++
1475 // 13.1p2). While not part of the definition of the signature,
1476 // this check is important to determine whether these functions
1477 // can be overloaded.
1478 const CXXMethodDecl* OldMethod = dyn_cast<CXXMethodDecl>(Old);
1479 const CXXMethodDecl* NewMethod = dyn_cast<CXXMethodDecl>(New);
1480 if (OldMethod && NewMethod &&
1481 !OldMethod->isStatic() && !NewMethod->isStatic() &&
1482 OldMethod->getTypeQualifiers() != NewMethod->getTypeQualifiers())
1483 return false;
1484
1485 // The signatures match; this is not an overload.
1486 return true;
1487 }
1488
1489 typedef llvm::DenseMap<const CXXMethodDecl *, const CXXMethodDecl*>
1490 ForwardUnique_t;
1491 ForwardUnique_t ForwardUnique;
1492 llvm::DenseMap<const CXXMethodDecl*, const CXXMethodDecl*> UniqueOverrider;
1493
1494 void BuildUniqueOverrider(const CXXMethodDecl *U, const CXXMethodDecl *MD) {
1495 const CXXMethodDecl *PrevU = UniqueOverrider[MD];
1496 assert(U && "no unique overrider");
1497 if (PrevU == U)
1498 return;
1499 if (PrevU != U && PrevU != 0) {
1500 // If already set, note the two sets as the same
1501 if (0)
1502 printf("%s::%s same as %s::%s\n",
1503 PrevU->getParent()->getNameAsCString(),
1504 PrevU->getNameAsCString(),
1505 U->getParent()->getNameAsCString(),
1506 U->getNameAsCString());
1507 ForwardUnique[PrevU] = U;
1508 return;
1509 }
1510
1511 // Not set, set it now
1512 if (0)
1513 printf("marking %s::%s %p override as %s::%s\n",
1514 MD->getParent()->getNameAsCString(),
1515 MD->getNameAsCString(),
1516 (void*)MD,
1517 U->getParent()->getNameAsCString(),
1518 U->getNameAsCString());
1519 UniqueOverrider[MD] = U;
1520
1521 for (CXXMethodDecl::method_iterator mi = MD->begin_overridden_methods(),
1522 me = MD->end_overridden_methods(); mi != me; ++mi) {
1523 BuildUniqueOverrider(U, *mi);
1524 }
1525 }
1526
1527 void BuildUniqueOverriders(const CXXRecordDecl *RD) {
1528 if (0) printf("walking %s\n", RD->getNameAsCString());
1529 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
1530 e = RD->method_end(); i != e; ++i) {
1531 const CXXMethodDecl *MD = *i;
1532 if (!MD->isVirtual())
1533 continue;
1534
1535 if (UniqueOverrider[MD] == 0) {
1536 // Only set this, if it hasn't been set yet.
1537 BuildUniqueOverrider(MD, MD);
1538 if (0)
1539 printf("top set is %s::%s %p\n",
1540 MD->getParent()->getNameAsCString(),
1541 MD->getNameAsCString(),
1542 (void*)MD);
1543 ForwardUnique[MD] = MD;
1544 }
1545 }
1546 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
1547 e = RD->bases_end(); i != e; ++i) {
1548 const CXXRecordDecl *Base =
1549 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
1550 BuildUniqueOverriders(Base);
1551 }
1552 }
1553
1554 static int DclCmp(const void *p1, const void *p2) {
John McCallef3057c2010-02-13 01:04:05 +00001555 const CXXMethodDecl *MD1 = *(const CXXMethodDecl *const *)p1;
1556 const CXXMethodDecl *MD2 = *(const CXXMethodDecl *const *)p2;
1557
1558 return (DeclarationName::compare(MD1->getDeclName(), MD2->getDeclName()));
Mike Stump90181eb2010-01-26 00:05:04 +00001559 }
1560
1561 void MergeForwarding() {
1562 typedef llvm::SmallVector<const CXXMethodDecl *, 100> A_t;
1563 A_t A;
1564 for (ForwardUnique_t::iterator I = ForwardUnique.begin(),
1565 E = ForwardUnique.end(); I != E; ++I) {
1566 if (I->first == I->second)
1567 // Only add the roots of all trees
1568 A.push_back(I->first);
1569 }
1570 llvm::array_pod_sort(A.begin(), A.end(), DclCmp);
1571 for (A_t::iterator I = A.begin(),
1572 E = A.end(); I != E; ++I) {
1573 A_t::iterator J = I;
John McCallef3057c2010-02-13 01:04:05 +00001574 while (++J != E && DclCmp(I, J) == 0)
Mike Stump90181eb2010-01-26 00:05:04 +00001575 if (DclIsSame(*I, *J)) {
Eli Friedman18c28f62010-02-13 00:03:21 +00001576 if (0) printf("connecting %s\n", (*I)->getNameAsCString());
Mike Stump90181eb2010-01-26 00:05:04 +00001577 ForwardUnique[*J] = *I;
1578 }
1579 }
1580 }
1581
1582 const CXXMethodDecl *getUnique(const CXXMethodDecl *MD) {
1583 const CXXMethodDecl *U = UniqueOverrider[MD];
1584 assert(U && "unique overrider not found");
1585 while (ForwardUnique.count(U)) {
1586 const CXXMethodDecl *NU = ForwardUnique[U];
1587 if (NU == U) break;
1588 U = NU;
1589 }
1590 return U;
1591 }
Anders Carlsson72281172010-01-26 17:36:47 +00001592
1593 GlobalDecl getUnique(GlobalDecl GD) {
1594 const CXXMethodDecl *Unique = getUnique(cast<CXXMethodDecl>(GD.getDecl()));
1595
1596 if (const CXXConstructorDecl *CD = dyn_cast<CXXConstructorDecl>(Unique))
1597 return GlobalDecl(CD, GD.getCtorType());
1598
1599 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(Unique))
1600 return GlobalDecl(DD, GD.getDtorType());
1601
1602 return Unique;
Mike Stump90181eb2010-01-26 00:05:04 +00001603 }
1604
Anders Carlsson323bb042009-11-26 19:54:33 +00001605 /// getPureVirtualFn - Return the __cxa_pure_virtual function.
1606 llvm::Constant* getPureVirtualFn() {
1607 if (!PureVirtualFn) {
1608 const llvm::FunctionType *Ty =
1609 llvm::FunctionType::get(llvm::Type::getVoidTy(VMContext),
1610 /*isVarArg=*/false);
1611 PureVirtualFn = wrap(CGM.CreateRuntimeFunction(Ty, "__cxa_pure_virtual"));
1612 }
1613
1614 return PureVirtualFn;
1615 }
1616
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001617public:
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001618 OldVtableBuilder(const CXXRecordDecl *MostDerivedClass,
Eli Friedman6c08ce72009-12-05 01:05:03 +00001619 const CXXRecordDecl *l, uint64_t lo, CodeGenModule &cgm,
Anders Carlsson5f9a8812010-01-14 02:29:07 +00001620 bool build, CGVtableInfo::AddressPointsMapTy& AddressPoints)
Eli Friedman6c08ce72009-12-05 01:05:03 +00001621 : BuildVtable(build), MostDerivedClass(MostDerivedClass), LayoutClass(l),
1622 LayoutOffset(lo), BLayout(cgm.getContext().getASTRecordLayout(l)),
1623 rtti(0), VMContext(cgm.getModule().getContext()),CGM(cgm),
1624 PureVirtualFn(0),
Anders Carlssonbad80eb2009-12-04 18:36:22 +00001625 subAddressPoints(AllocAddressPoint(cgm, l, MostDerivedClass)),
Anders Carlsson5f9a8812010-01-14 02:29:07 +00001626 AddressPoints(AddressPoints),
1627 LLVMPointerWidth(cgm.getContext().Target.getPointerWidth(0))
1628 {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001629 Ptr8Ty = llvm::PointerType::get(llvm::Type::getInt8Ty(VMContext), 0);
Anders Carlsson3f4336c2009-12-17 07:09:17 +00001630 if (BuildVtable) {
1631 QualType ClassType = CGM.getContext().getTagDeclType(MostDerivedClass);
1632 rtti = CGM.GetAddrOfRTTIDescriptor(ClassType);
1633 }
Mike Stump90181eb2010-01-26 00:05:04 +00001634 BuildUniqueOverriders(MostDerivedClass);
1635 MergeForwarding();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001636 }
1637
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00001638 // getVtableComponents - Returns a reference to the vtable components.
1639 const VtableComponentsVectorTy &getVtableComponents() const {
1640 return VtableComponents;
Anders Carlsson472404f2009-12-04 16:19:30 +00001641 }
1642
Anders Carlssone36a6b32010-01-02 01:01:18 +00001643 llvm::DenseMap<const CXXRecordDecl *, uint64_t> &getVBIndex()
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001644 { return VBIndex; }
1645
Eli Friedman31bc3ad2009-12-07 23:56:34 +00001646 SavedAdjustmentsVectorTy &getSavedAdjustments()
1647 { return SavedAdjustments; }
Eli Friedman8174f2c2009-12-06 22:01:30 +00001648
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001649 llvm::Constant *wrap(Index_t i) {
1650 llvm::Constant *m;
1651 m = llvm::ConstantInt::get(llvm::Type::getInt64Ty(VMContext), i);
1652 return llvm::ConstantExpr::getIntToPtr(m, Ptr8Ty);
1653 }
1654
1655 llvm::Constant *wrap(llvm::Constant *m) {
1656 return llvm::ConstantExpr::getBitCast(m, Ptr8Ty);
1657 }
1658
Mike Stumpd2808442010-01-22 02:51:26 +00001659//#define D1(x)
1660#define D1(X) do { if (getenv("DEBUG")) { X; } } while (0)
Mike Stump75ce5732009-10-31 20:06:59 +00001661
1662 void GenerateVBaseOffsets(const CXXRecordDecl *RD, uint64_t Offset,
Mike Stump28431212009-10-13 22:54:56 +00001663 bool updateVBIndex, Index_t current_vbindex) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001664 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
1665 e = RD->bases_end(); i != e; ++i) {
1666 const CXXRecordDecl *Base =
1667 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Mike Stump28431212009-10-13 22:54:56 +00001668 Index_t next_vbindex = current_vbindex;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001669 if (i->isVirtual() && !SeenVBase.count(Base)) {
1670 SeenVBase.insert(Base);
Mike Stump28431212009-10-13 22:54:56 +00001671 if (updateVBIndex) {
Mike Stump75ce5732009-10-31 20:06:59 +00001672 next_vbindex = (ssize_t)(-(VCalls.size()*LLVMPointerWidth/8)
Mike Stump28431212009-10-13 22:54:56 +00001673 - 3*LLVMPointerWidth/8);
1674 VBIndex[Base] = next_vbindex;
1675 }
Mike Stump75ce5732009-10-31 20:06:59 +00001676 int64_t BaseOffset = -(Offset/8) + BLayout.getVBaseClassOffset(Base)/8;
1677 VCalls.push_back((0?700:0) + BaseOffset);
1678 D1(printf(" vbase for %s at %d delta %d most derived %s\n",
1679 Base->getNameAsCString(),
1680 (int)-VCalls.size()-3, (int)BaseOffset,
Mike Stumpd2808442010-01-22 02:51:26 +00001681 MostDerivedClass->getNameAsCString()));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001682 }
Mike Stump28431212009-10-13 22:54:56 +00001683 // We also record offsets for non-virtual bases to closest enclosing
1684 // virtual base. We do this so that we don't have to search
1685 // for the nearst virtual base class when generating thunks.
1686 if (updateVBIndex && VBIndex.count(Base) == 0)
1687 VBIndex[Base] = next_vbindex;
Mike Stump75ce5732009-10-31 20:06:59 +00001688 GenerateVBaseOffsets(Base, Offset, updateVBIndex, next_vbindex);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001689 }
1690 }
1691
1692 void StartNewTable() {
1693 SeenVBase.clear();
1694 }
1695
Mike Stump8bccbfd2009-10-15 09:30:16 +00001696 Index_t getNVOffset_1(const CXXRecordDecl *D, const CXXRecordDecl *B,
1697 Index_t Offset = 0) {
1698
1699 if (B == D)
1700 return Offset;
1701
1702 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(D);
1703 for (CXXRecordDecl::base_class_const_iterator i = D->bases_begin(),
1704 e = D->bases_end(); i != e; ++i) {
1705 const CXXRecordDecl *Base =
1706 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
1707 int64_t BaseOffset = 0;
1708 if (!i->isVirtual())
1709 BaseOffset = Offset + Layout.getBaseClassOffset(Base);
1710 int64_t o = getNVOffset_1(Base, B, BaseOffset);
1711 if (o >= 0)
1712 return o;
1713 }
1714
1715 return -1;
1716 }
1717
1718 /// getNVOffset - Returns the non-virtual offset for the given (B) base of the
1719 /// derived class D.
1720 Index_t getNVOffset(QualType qB, QualType qD) {
Mike Stump46271322009-11-03 19:03:17 +00001721 qD = qD->getPointeeType();
1722 qB = qB->getPointeeType();
Mike Stump8bccbfd2009-10-15 09:30:16 +00001723 CXXRecordDecl *D = cast<CXXRecordDecl>(qD->getAs<RecordType>()->getDecl());
1724 CXXRecordDecl *B = cast<CXXRecordDecl>(qB->getAs<RecordType>()->getDecl());
1725 int64_t o = getNVOffset_1(D, B);
1726 if (o >= 0)
1727 return o;
1728
1729 assert(false && "FIXME: non-virtual base not found");
1730 return 0;
1731 }
1732
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001733 /// getVbaseOffset - Returns the index into the vtable for the virtual base
1734 /// offset for the given (B) virtual base of the derived class D.
1735 Index_t getVbaseOffset(QualType qB, QualType qD) {
Mike Stump46271322009-11-03 19:03:17 +00001736 qD = qD->getPointeeType();
1737 qB = qB->getPointeeType();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001738 CXXRecordDecl *D = cast<CXXRecordDecl>(qD->getAs<RecordType>()->getDecl());
1739 CXXRecordDecl *B = cast<CXXRecordDecl>(qB->getAs<RecordType>()->getDecl());
Anders Carlssonbad80eb2009-12-04 18:36:22 +00001740 if (D != MostDerivedClass)
Eli Friedman03aa2f12009-11-30 01:19:33 +00001741 return CGM.getVtableInfo().getVirtualBaseOffsetIndex(D, B);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001742 llvm::DenseMap<const CXXRecordDecl *, Index_t>::iterator i;
1743 i = VBIndex.find(B);
1744 if (i != VBIndex.end())
1745 return i->second;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001746
Mike Stump28431212009-10-13 22:54:56 +00001747 assert(false && "FIXME: Base not found");
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001748 return 0;
1749 }
1750
Eli Friedman81fb0d22009-12-04 08:40:51 +00001751 bool OverrideMethod(GlobalDecl GD, bool MorallyVirtual,
1752 Index_t OverrideOffset, Index_t Offset,
1753 int64_t CurrentVBaseOffset);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001754
Anders Carlsson495634e2009-12-04 02:39:04 +00001755 /// AppendMethods - Append the current methods to the vtable.
Anders Carlssonddf42c82009-12-04 02:56:03 +00001756 void AppendMethodsToVtable();
Anders Carlsson495634e2009-12-04 02:39:04 +00001757
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001758 llvm::Constant *WrapAddrOf(GlobalDecl GD) {
1759 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
1760
Anders Carlsson64457732009-11-24 05:08:52 +00001761 const llvm::Type *Ty = CGM.getTypes().GetFunctionTypeForVtable(MD);
Mike Stump18e8b472009-10-27 23:36:26 +00001762
Mike Stumpcdeb8002009-12-03 16:55:20 +00001763 return wrap(CGM.GetAddrOfFunction(GD, Ty));
Mike Stump18e8b472009-10-27 23:36:26 +00001764 }
1765
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00001766 void OverrideMethods(Path_t *Path, bool MorallyVirtual, int64_t Offset,
1767 int64_t CurrentVBaseOffset) {
Mike Stump37dbe962009-10-15 02:04:03 +00001768 for (Path_t::reverse_iterator i = Path->rbegin(),
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001769 e = Path->rend(); i != e; ++i) {
1770 const CXXRecordDecl *RD = i->first;
Mike Stump8bccbfd2009-10-15 09:30:16 +00001771 int64_t OverrideOffset = i->second;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001772 for (method_iter mi = RD->method_begin(), me = RD->method_end(); mi != me;
1773 ++mi) {
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001774 const CXXMethodDecl *MD = *mi;
1775
1776 if (!MD->isVirtual())
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001777 continue;
1778
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001779 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1780 // Override both the complete and the deleting destructor.
1781 GlobalDecl CompDtor(DD, Dtor_Complete);
Eli Friedman81fb0d22009-12-04 08:40:51 +00001782 OverrideMethod(CompDtor, MorallyVirtual, OverrideOffset, Offset,
1783 CurrentVBaseOffset);
1784
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001785 GlobalDecl DeletingDtor(DD, Dtor_Deleting);
Eli Friedman81fb0d22009-12-04 08:40:51 +00001786 OverrideMethod(DeletingDtor, MorallyVirtual, OverrideOffset, Offset,
1787 CurrentVBaseOffset);
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001788 } else {
Eli Friedman81fb0d22009-12-04 08:40:51 +00001789 OverrideMethod(MD, MorallyVirtual, OverrideOffset, Offset,
1790 CurrentVBaseOffset);
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001791 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001792 }
1793 }
1794 }
1795
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001796 void AddMethod(const GlobalDecl GD, bool MorallyVirtual, Index_t Offset,
Eli Friedman03aa2f12009-11-30 01:19:33 +00001797 int64_t CurrentVBaseOffset) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001798 // If we can find a previously allocated slot for this, reuse it.
Eli Friedman81fb0d22009-12-04 08:40:51 +00001799 if (OverrideMethod(GD, MorallyVirtual, Offset, Offset,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00001800 CurrentVBaseOffset))
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001801 return;
1802
Mike Stump1f49d652010-01-22 18:48:47 +00001803 D1(printf(" vfn for %s at %d\n",
1804 dyn_cast<CXXMethodDecl>(GD.getDecl())->getNameAsCString(),
1805 (int)Methods.size()));
1806
Anders Carlssoncdf18982009-12-04 02:08:24 +00001807 // We didn't find an entry in the vtable that we could use, add a new
1808 // entry.
1809 Methods.AddMethod(GD);
1810
Mike Stumpa04ecfb2010-01-26 21:35:27 +00001811 VCallOffset[GD] = Offset/8 - CurrentVBaseOffset/8;
1812
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001813 if (MorallyVirtual) {
Anders Carlsson72281172010-01-26 17:36:47 +00001814 GlobalDecl UGD = getUnique(GD);
1815 const CXXMethodDecl *UMD = cast<CXXMethodDecl>(UGD.getDecl());
1816
Mike Stump90181eb2010-01-26 00:05:04 +00001817 assert(UMD && "final overrider not found");
1818
1819 Index_t &idx = VCall[UMD];
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001820 // Allocate the first one, after that, we reuse the previous one.
1821 if (idx == 0) {
Anders Carlsson72281172010-01-26 17:36:47 +00001822 VCallOffsetForVCall[UGD] = Offset/8;
Mike Stumpa04ecfb2010-01-26 21:35:27 +00001823 NonVirtualOffset[UMD] = Offset/8 - CurrentVBaseOffset/8;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001824 idx = VCalls.size()+1;
Mike Stump90181eb2010-01-26 00:05:04 +00001825 VCalls.push_back(Offset/8 - CurrentVBaseOffset/8);
Mike Stump75ce5732009-10-31 20:06:59 +00001826 D1(printf(" vcall for %s at %d with delta %d\n",
Mike Stumpd2808442010-01-22 02:51:26 +00001827 dyn_cast<CXXMethodDecl>(GD.getDecl())->getNameAsCString(),
Mike Stump90181eb2010-01-26 00:05:04 +00001828 (int)-VCalls.size()-3, (int)VCalls[idx-1]));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001829 }
1830 }
1831 }
1832
1833 void AddMethods(const CXXRecordDecl *RD, bool MorallyVirtual,
Eli Friedman03aa2f12009-11-30 01:19:33 +00001834 Index_t Offset, int64_t CurrentVBaseOffset) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001835 for (method_iter mi = RD->method_begin(), me = RD->method_end(); mi != me;
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001836 ++mi) {
1837 const CXXMethodDecl *MD = *mi;
1838 if (!MD->isVirtual())
1839 continue;
1840
1841 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1842 // For destructors, add both the complete and the deleting destructor
1843 // to the vtable.
1844 AddMethod(GlobalDecl(DD, Dtor_Complete), MorallyVirtual, Offset,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00001845 CurrentVBaseOffset);
Eli Friedman03aa2f12009-11-30 01:19:33 +00001846 AddMethod(GlobalDecl(DD, Dtor_Deleting), MorallyVirtual, Offset,
1847 CurrentVBaseOffset);
1848 } else
1849 AddMethod(MD, MorallyVirtual, Offset, CurrentVBaseOffset);
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001850 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001851 }
1852
1853 void NonVirtualBases(const CXXRecordDecl *RD, const ASTRecordLayout &Layout,
1854 const CXXRecordDecl *PrimaryBase,
1855 bool PrimaryBaseWasVirtual, bool MorallyVirtual,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00001856 int64_t Offset, int64_t CurrentVBaseOffset,
1857 Path_t *Path) {
Mike Stump37dbe962009-10-15 02:04:03 +00001858 Path->push_back(std::make_pair(RD, Offset));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001859 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
1860 e = RD->bases_end(); i != e; ++i) {
1861 if (i->isVirtual())
1862 continue;
1863 const CXXRecordDecl *Base =
1864 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Mike Stump9eb76d42010-01-22 06:45:05 +00001865 uint64_t o = Offset + Layout.getBaseClassOffset(Base);
1866 StartNewTable();
1867 GenerateVtableForBase(Base, o, MorallyVirtual, false,
1868 true, Base == PrimaryBase && !PrimaryBaseWasVirtual,
1869 CurrentVBaseOffset, Path);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001870 }
Mike Stump37dbe962009-10-15 02:04:03 +00001871 Path->pop_back();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001872 }
1873
Mike Stumpb21c4ee2009-10-14 18:14:51 +00001874// #define D(X) do { X; } while (0)
1875#define D(X)
1876
1877 void insertVCalls(int InsertionPoint) {
Mike Stump75ce5732009-10-31 20:06:59 +00001878 D1(printf("============= combining vbase/vcall\n"));
Mike Stumpb21c4ee2009-10-14 18:14:51 +00001879 D(VCalls.insert(VCalls.begin(), 673));
1880 D(VCalls.push_back(672));
Eli Friedman6c08ce72009-12-05 01:05:03 +00001881
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00001882 VtableComponents.insert(VtableComponents.begin() + InsertionPoint,
1883 VCalls.size(), 0);
Eli Friedman6c08ce72009-12-05 01:05:03 +00001884 if (BuildVtable) {
1885 // The vcalls come first...
1886 for (std::vector<Index_t>::reverse_iterator i = VCalls.rbegin(),
1887 e = VCalls.rend();
1888 i != e; ++i)
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00001889 VtableComponents[InsertionPoint++] = wrap((0?600:0) + *i);
Eli Friedman6c08ce72009-12-05 01:05:03 +00001890 }
Mike Stumpb21c4ee2009-10-14 18:14:51 +00001891 VCalls.clear();
Mike Stump9f23a142009-11-10 02:30:51 +00001892 VCall.clear();
Mike Stumpa04ecfb2010-01-26 21:35:27 +00001893 VCallOffsetForVCall.clear();
1894 VCallOffset.clear();
1895 NonVirtualOffset.clear();
Mike Stumpb21c4ee2009-10-14 18:14:51 +00001896 }
1897
Mike Stump559387f2009-11-13 23:13:20 +00001898 void AddAddressPoints(const CXXRecordDecl *RD, uint64_t Offset,
1899 Index_t AddressPoint) {
1900 D1(printf("XXX address point for %s in %s layout %s at offset %d is %d\n",
Mike Stumpd2808442010-01-22 02:51:26 +00001901 RD->getNameAsCString(), MostDerivedClass->getNameAsCString(),
Mike Stump559387f2009-11-13 23:13:20 +00001902 LayoutClass->getNameAsCString(), (int)Offset, (int)AddressPoint));
Mike Stumpcd2b8212009-11-19 20:52:19 +00001903 subAddressPoints[std::make_pair(RD, Offset)] = AddressPoint;
Anders Carlsson5f9a8812010-01-14 02:29:07 +00001904 AddressPoints[BaseSubobject(RD, Offset)] = AddressPoint;
Mike Stump559387f2009-11-13 23:13:20 +00001905
1906 // Now also add the address point for all our primary bases.
1907 while (1) {
1908 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
1909 RD = Layout.getPrimaryBase();
1910 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
1911 // FIXME: Double check this.
1912 if (RD == 0)
1913 break;
1914 if (PrimaryBaseWasVirtual &&
1915 BLayout.getVBaseClassOffset(RD) != Offset)
1916 break;
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 }
1924
1925
Mike Stumpd538a6d2009-12-24 07:29:41 +00001926 void FinishGenerateVtable(const CXXRecordDecl *RD,
1927 const ASTRecordLayout &Layout,
1928 const CXXRecordDecl *PrimaryBase,
Mike Stump9eb76d42010-01-22 06:45:05 +00001929 bool ForNPNVBases, bool WasPrimaryBase,
Mike Stumpd538a6d2009-12-24 07:29:41 +00001930 bool PrimaryBaseWasVirtual,
1931 bool MorallyVirtual, int64_t Offset,
1932 bool ForVirtualBase, int64_t CurrentVBaseOffset,
1933 Path_t *Path) {
Mike Stump37dbe962009-10-15 02:04:03 +00001934 bool alloc = false;
1935 if (Path == 0) {
1936 alloc = true;
1937 Path = new Path_t;
1938 }
1939
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001940 StartNewTable();
1941 extra = 0;
Mike Stump9eb76d42010-01-22 06:45:05 +00001942 Index_t AddressPoint = 0;
1943 int VCallInsertionPoint = 0;
1944 if (!ForNPNVBases || !WasPrimaryBase) {
1945 bool DeferVCalls = MorallyVirtual || ForVirtualBase;
1946 VCallInsertionPoint = VtableComponents.size();
1947 if (!DeferVCalls) {
1948 insertVCalls(VCallInsertionPoint);
1949 } else
1950 // FIXME: just for extra, or for all uses of VCalls.size post this?
1951 extra = -VCalls.size();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001952
Mike Stump9eb76d42010-01-22 06:45:05 +00001953 // Add the offset to top.
1954 VtableComponents.push_back(BuildVtable ? wrap(-((Offset-LayoutOffset)/8)) : 0);
Anders Carlsson472404f2009-12-04 16:19:30 +00001955
Mike Stump9eb76d42010-01-22 06:45:05 +00001956 // Add the RTTI information.
1957 VtableComponents.push_back(rtti);
Anders Carlsson472404f2009-12-04 16:19:30 +00001958
Mike Stump9eb76d42010-01-22 06:45:05 +00001959 AddressPoint = VtableComponents.size();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001960
Mike Stump9eb76d42010-01-22 06:45:05 +00001961 AppendMethodsToVtable();
1962 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001963
1964 // and then the non-virtual bases.
1965 NonVirtualBases(RD, Layout, PrimaryBase, PrimaryBaseWasVirtual,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00001966 MorallyVirtual, Offset, CurrentVBaseOffset, Path);
Mike Stumpb21c4ee2009-10-14 18:14:51 +00001967
1968 if (ForVirtualBase) {
Mike Stump2cefe382009-11-12 20:47:57 +00001969 // FIXME: We're adding to VCalls in callers, we need to do the overrides
1970 // in the inner part, so that we know the complete set of vcalls during
1971 // the build and don't have to insert into methods. Saving out the
1972 // AddressPoint here, would need to be fixed, if we didn't do that. Also
1973 // retroactively adding vcalls for overrides later wind up in the wrong
1974 // place, the vcall slot has to be alloted during the walk of the base
1975 // when the function is first introduces.
Mike Stumpb21c4ee2009-10-14 18:14:51 +00001976 AddressPoint += VCalls.size();
Mike Stump2cefe382009-11-12 20:47:57 +00001977 insertVCalls(VCallInsertionPoint);
Mike Stumpb21c4ee2009-10-14 18:14:51 +00001978 }
1979
Mike Stump9eb76d42010-01-22 06:45:05 +00001980 if (!ForNPNVBases || !WasPrimaryBase)
1981 AddAddressPoints(RD, Offset, AddressPoint);
Mike Stump2cefe382009-11-12 20:47:57 +00001982
Mike Stump37dbe962009-10-15 02:04:03 +00001983 if (alloc) {
1984 delete Path;
1985 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001986 }
1987
Mike Stump75ce5732009-10-31 20:06:59 +00001988 void Primaries(const CXXRecordDecl *RD, bool MorallyVirtual, int64_t Offset,
1989 bool updateVBIndex, Index_t current_vbindex,
Eli Friedman03aa2f12009-11-30 01:19:33 +00001990 int64_t CurrentVBaseOffset) {
Mike Stump75ce5732009-10-31 20:06:59 +00001991 if (!RD->isDynamicClass())
1992 return;
1993
1994 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
1995 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
1996 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
1997
1998 // vtables are composed from the chain of primaries.
Eli Friedman65d87222009-12-04 08:52:11 +00001999 if (PrimaryBase && !PrimaryBaseWasVirtual) {
Mike Stump75ce5732009-10-31 20:06:59 +00002000 D1(printf(" doing primaries for %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002001 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Eli Friedman65d87222009-12-04 08:52:11 +00002002 Primaries(PrimaryBase, PrimaryBaseWasVirtual|MorallyVirtual, Offset,
2003 updateVBIndex, current_vbindex, CurrentVBaseOffset);
Mike Stump75ce5732009-10-31 20:06:59 +00002004 }
2005
2006 D1(printf(" doing vcall entries for %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002007 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Mike Stump75ce5732009-10-31 20:06:59 +00002008
2009 // And add the virtuals for the class to the primary vtable.
Eli Friedman03aa2f12009-11-30 01:19:33 +00002010 AddMethods(RD, MorallyVirtual, Offset, CurrentVBaseOffset);
Mike Stump75ce5732009-10-31 20:06:59 +00002011 }
2012
2013 void VBPrimaries(const CXXRecordDecl *RD, bool MorallyVirtual, int64_t Offset,
2014 bool updateVBIndex, Index_t current_vbindex,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002015 bool RDisVirtualBase, int64_t CurrentVBaseOffset,
Eli Friedman03aa2f12009-11-30 01:19:33 +00002016 bool bottom) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002017 if (!RD->isDynamicClass())
2018 return;
2019
2020 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
2021 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
2022 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
2023
2024 // vtables are composed from the chain of primaries.
2025 if (PrimaryBase) {
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002026 int BaseCurrentVBaseOffset = CurrentVBaseOffset;
2027 if (PrimaryBaseWasVirtual) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002028 IndirectPrimary.insert(PrimaryBase);
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002029 BaseCurrentVBaseOffset = BLayout.getVBaseClassOffset(PrimaryBase);
2030 }
Mike Stump75ce5732009-10-31 20:06:59 +00002031
2032 D1(printf(" doing primaries for %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002033 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Mike Stump75ce5732009-10-31 20:06:59 +00002034
2035 VBPrimaries(PrimaryBase, PrimaryBaseWasVirtual|MorallyVirtual, Offset,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002036 updateVBIndex, current_vbindex, PrimaryBaseWasVirtual,
Eli Friedman03aa2f12009-11-30 01:19:33 +00002037 BaseCurrentVBaseOffset, false);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002038 }
2039
Mike Stump75ce5732009-10-31 20:06:59 +00002040 D1(printf(" doing vbase entries for %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002041 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Mike Stump75ce5732009-10-31 20:06:59 +00002042 GenerateVBaseOffsets(RD, Offset, updateVBIndex, current_vbindex);
2043
2044 if (RDisVirtualBase || bottom) {
2045 Primaries(RD, MorallyVirtual, Offset, updateVBIndex, current_vbindex,
Eli Friedman03aa2f12009-11-30 01:19:33 +00002046 CurrentVBaseOffset);
Mike Stump75ce5732009-10-31 20:06:59 +00002047 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002048 }
2049
Mike Stumpd538a6d2009-12-24 07:29:41 +00002050 void GenerateVtableForBase(const CXXRecordDecl *RD, int64_t Offset = 0,
2051 bool MorallyVirtual = false,
2052 bool ForVirtualBase = false,
Mike Stump9eb76d42010-01-22 06:45:05 +00002053 bool ForNPNVBases = false,
2054 bool WasPrimaryBase = true,
Mike Stumpd538a6d2009-12-24 07:29:41 +00002055 int CurrentVBaseOffset = 0,
2056 Path_t *Path = 0) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002057 if (!RD->isDynamicClass())
Mike Stumpd538a6d2009-12-24 07:29:41 +00002058 return;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002059
Mike Stumpfa818082009-11-13 02:35:38 +00002060 // Construction vtable don't need parts that have no virtual bases and
2061 // aren't morally virtual.
Anders Carlssonbad80eb2009-12-04 18:36:22 +00002062 if ((LayoutClass != MostDerivedClass) &&
2063 RD->getNumVBases() == 0 && !MorallyVirtual)
Mike Stumpd538a6d2009-12-24 07:29:41 +00002064 return;
Mike Stumpfa818082009-11-13 02:35:38 +00002065
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002066 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
2067 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
2068 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
2069
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002070 extra = 0;
Mike Stump75ce5732009-10-31 20:06:59 +00002071 D1(printf("building entries for base %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002072 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002073
Mike Stump75ce5732009-10-31 20:06:59 +00002074 if (ForVirtualBase)
2075 extra = VCalls.size();
2076
Mike Stump9eb76d42010-01-22 06:45:05 +00002077 if (!ForNPNVBases || !WasPrimaryBase) {
2078 VBPrimaries(RD, MorallyVirtual, Offset, !ForVirtualBase, 0,
2079 ForVirtualBase, CurrentVBaseOffset, true);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002080
Mike Stump9eb76d42010-01-22 06:45:05 +00002081 if (Path)
2082 OverrideMethods(Path, MorallyVirtual, Offset, CurrentVBaseOffset);
2083 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002084
Mike Stump9eb76d42010-01-22 06:45:05 +00002085 FinishGenerateVtable(RD, Layout, PrimaryBase, ForNPNVBases, WasPrimaryBase,
2086 PrimaryBaseWasVirtual, MorallyVirtual, Offset,
2087 ForVirtualBase, CurrentVBaseOffset, Path);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002088 }
2089
2090 void GenerateVtableForVBases(const CXXRecordDecl *RD,
2091 int64_t Offset = 0,
Mike Stump37dbe962009-10-15 02:04:03 +00002092 Path_t *Path = 0) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002093 bool alloc = false;
2094 if (Path == 0) {
2095 alloc = true;
Mike Stump37dbe962009-10-15 02:04:03 +00002096 Path = new Path_t;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002097 }
2098 // FIXME: We also need to override using all paths to a virtual base,
2099 // right now, we just process the first path
2100 Path->push_back(std::make_pair(RD, Offset));
2101 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
2102 e = RD->bases_end(); i != e; ++i) {
2103 const CXXRecordDecl *Base =
2104 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
2105 if (i->isVirtual() && !IndirectPrimary.count(Base)) {
2106 // Mark it so we don't output it twice.
2107 IndirectPrimary.insert(Base);
2108 StartNewTable();
Mike Stumpb21c4ee2009-10-14 18:14:51 +00002109 VCall.clear();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002110 int64_t BaseOffset = BLayout.getVBaseClassOffset(Base);
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002111 int64_t CurrentVBaseOffset = BaseOffset;
Mike Stump75ce5732009-10-31 20:06:59 +00002112 D1(printf("vtable %s virtual base %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002113 MostDerivedClass->getNameAsCString(), Base->getNameAsCString()));
Mike Stump9eb76d42010-01-22 06:45:05 +00002114 GenerateVtableForBase(Base, BaseOffset, true, true, false,
2115 true, CurrentVBaseOffset, Path);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002116 }
Mike Stump2cefe382009-11-12 20:47:57 +00002117 int64_t BaseOffset;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002118 if (i->isVirtual())
2119 BaseOffset = BLayout.getVBaseClassOffset(Base);
Mike Stump2cefe382009-11-12 20:47:57 +00002120 else {
2121 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
2122 BaseOffset = Offset + Layout.getBaseClassOffset(Base);
2123 }
2124
Mike Stump37dbe962009-10-15 02:04:03 +00002125 if (Base->getNumVBases()) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002126 GenerateVtableForVBases(Base, BaseOffset, Path);
Mike Stump37dbe962009-10-15 02:04:03 +00002127 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002128 }
2129 Path->pop_back();
2130 if (alloc)
2131 delete Path;
2132 }
2133};
Anders Carlssonca1bf682009-12-03 01:54:02 +00002134} // end anonymous namespace
2135
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002136bool OldVtableBuilder::OverrideMethod(GlobalDecl GD, bool MorallyVirtual,
Eli Friedman81fb0d22009-12-04 08:40:51 +00002137 Index_t OverrideOffset, Index_t Offset,
2138 int64_t CurrentVBaseOffset) {
Anders Carlssonca1bf682009-12-03 01:54:02 +00002139 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2140
2141 const bool isPure = MD->isPure();
Anders Carlsson21bbc1e2009-12-05 17:04:47 +00002142
Anders Carlssonca1bf682009-12-03 01:54:02 +00002143 // FIXME: Should OverrideOffset's be Offset?
2144
Anders Carlsson21bbc1e2009-12-05 17:04:47 +00002145 for (CXXMethodDecl::method_iterator mi = MD->begin_overridden_methods(),
2146 e = MD->end_overridden_methods(); mi != e; ++mi) {
Anders Carlssonca1bf682009-12-03 01:54:02 +00002147 GlobalDecl OGD;
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002148 GlobalDecl OGD2;
Anders Carlssonca1bf682009-12-03 01:54:02 +00002149
Anders Carlssonf3935b42009-12-04 05:51:56 +00002150 const CXXMethodDecl *OMD = *mi;
Anders Carlssonca1bf682009-12-03 01:54:02 +00002151 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(OMD))
2152 OGD = GlobalDecl(DD, GD.getDtorType());
2153 else
2154 OGD = OMD;
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002155
Eli Friedman8174f2c2009-12-06 22:01:30 +00002156 // Check whether this is the method being overridden in this section of
2157 // the vtable.
Anders Carlsson7bb70762009-12-04 15:49:02 +00002158 uint64_t Index;
2159 if (!Methods.getIndex(OGD, Index))
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002160 continue;
2161
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002162 OGD2 = OGD;
2163
Eli Friedman8174f2c2009-12-06 22:01:30 +00002164 // Get the original method, which we should be computing thunks, etc,
2165 // against.
2166 OGD = Methods.getOrigMethod(Index);
2167 OMD = cast<CXXMethodDecl>(OGD.getDecl());
2168
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002169 QualType ReturnType =
2170 MD->getType()->getAs<FunctionType>()->getResultType();
2171 QualType OverriddenReturnType =
2172 OMD->getType()->getAs<FunctionType>()->getResultType();
Anders Carlssonca1bf682009-12-03 01:54:02 +00002173
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002174 // Check if we need a return type adjustment.
Anders Carlssoncce9ee82010-02-13 23:17:31 +00002175 if (!ComputeReturnAdjustmentBaseOffset(CGM.getContext(), MD,
2176 OMD).isEmpty()) {
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002177 CanQualType &BaseReturnType = BaseReturnTypes[Index];
Anders Carlssonca1bf682009-12-03 01:54:02 +00002178
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002179 // Insert the base return type.
2180 if (BaseReturnType.isNull())
2181 BaseReturnType =
2182 CGM.getContext().getCanonicalType(OverriddenReturnType);
2183 }
Anders Carlssona93e9802009-12-04 03:52:52 +00002184
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002185 Methods.OverrideMethod(OGD, GD);
2186
Anders Carlsson72281172010-01-26 17:36:47 +00002187 GlobalDecl UGD = getUnique(GD);
2188 const CXXMethodDecl *UMD = cast<CXXMethodDecl>(UGD.getDecl());
2189 assert(UGD.getDecl() && "unique overrider not found");
2190 assert(UGD == getUnique(OGD) && "unique overrider not unique");
Mike Stump90181eb2010-01-26 00:05:04 +00002191
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002192 ThisAdjustments.erase(Index);
Mike Stump90181eb2010-01-26 00:05:04 +00002193 if (MorallyVirtual || VCall.count(UMD)) {
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002194
Mike Stump90181eb2010-01-26 00:05:04 +00002195 Index_t &idx = VCall[UMD];
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002196 if (idx == 0) {
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002197 VCallOffset[GD] = VCallOffset[OGD];
2198 // NonVirtualOffset[UMD] = CurrentVBaseOffset/8 - OverrideOffset/8;
2199 NonVirtualOffset[UMD] = VCallOffset[OGD];
Mike Stump77537b12010-01-26 03:42:22 +00002200 VCallOffsetForVCall[UMD] = OverrideOffset/8;
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002201 idx = VCalls.size()+1;
Mike Stump77537b12010-01-26 03:42:22 +00002202 VCalls.push_back(OverrideOffset/8 - CurrentVBaseOffset/8);
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002203 D1(printf(" vcall for %s at %d with delta %d most derived %s\n",
2204 MD->getNameAsString().c_str(), (int)-idx-3,
Mike Stumpd2808442010-01-22 02:51:26 +00002205 (int)VCalls[idx-1], MostDerivedClass->getNameAsCString()));
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002206 } else {
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002207 VCallOffset[GD] = NonVirtualOffset[UMD];
Anders Carlsson72281172010-01-26 17:36:47 +00002208 VCalls[idx-1] = -VCallOffsetForVCall[UGD] + OverrideOffset/8;
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002209 D1(printf(" vcall patch for %s at %d with delta %d most derived %s\n",
2210 MD->getNameAsString().c_str(), (int)-idx-3,
Mike Stumpd2808442010-01-22 02:51:26 +00002211 (int)VCalls[idx-1], MostDerivedClass->getNameAsCString()));
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002212 }
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002213 int64_t NonVirtualAdjustment = -VCallOffset[OGD];
Mike Stumpded0a402010-01-26 22:44:01 +00002214 QualType DerivedType = MD->getThisType(CGM.getContext());
2215 QualType BaseType = cast<const CXXMethodDecl>(OGD.getDecl())->getThisType(CGM.getContext());
2216 int64_t NonVirtualAdjustment2 = -(getNVOffset(BaseType, DerivedType)/8);
2217 if (NonVirtualAdjustment2 != NonVirtualAdjustment) {
2218 NonVirtualAdjustment = NonVirtualAdjustment2;
2219 }
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002220 int64_t VirtualAdjustment =
2221 -((idx + extra + 2) * LLVMPointerWidth / 8);
Anders Carlsson657f1392009-12-03 02:32:59 +00002222
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002223 // Optimize out virtual adjustments of 0.
2224 if (VCalls[idx-1] == 0)
2225 VirtualAdjustment = 0;
Anders Carlsson657f1392009-12-03 02:32:59 +00002226
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002227 ThunkAdjustment ThisAdjustment(NonVirtualAdjustment,
2228 VirtualAdjustment);
Anders Carlsson2ca285f2009-12-03 02:22:59 +00002229
Eli Friedman8174f2c2009-12-06 22:01:30 +00002230 if (!isPure && !ThisAdjustment.isEmpty()) {
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002231 ThisAdjustments[Index] = ThisAdjustment;
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002232 SavedAdjustments.push_back(
2233 std::make_pair(GD, std::make_pair(OGD, ThisAdjustment)));
Eli Friedman8174f2c2009-12-06 22:01:30 +00002234 }
Anders Carlssonca1bf682009-12-03 01:54:02 +00002235 return true;
2236 }
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002237
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002238 VCallOffset[GD] = VCallOffset[OGD2] - OverrideOffset/8;
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002239
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002240 int64_t NonVirtualAdjustment = -VCallOffset[GD];
2241 QualType DerivedType = MD->getThisType(CGM.getContext());
2242 QualType BaseType = cast<const CXXMethodDecl>(OGD.getDecl())->getThisType(CGM.getContext());
2243 int64_t NonVirtualAdjustment2 = -(getNVOffset(BaseType, DerivedType)/8);
2244 if (NonVirtualAdjustment2 != NonVirtualAdjustment) {
2245 NonVirtualAdjustment = NonVirtualAdjustment2;
2246 }
2247
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002248 if (NonVirtualAdjustment) {
2249 ThunkAdjustment ThisAdjustment(NonVirtualAdjustment, 0);
2250
Eli Friedmanf2eda5e2009-12-06 22:33:51 +00002251 if (!isPure) {
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002252 ThisAdjustments[Index] = ThisAdjustment;
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002253 SavedAdjustments.push_back(
2254 std::make_pair(GD, std::make_pair(OGD, ThisAdjustment)));
Eli Friedmanf2eda5e2009-12-06 22:33:51 +00002255 }
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002256 }
2257 return true;
Anders Carlssonca1bf682009-12-03 01:54:02 +00002258 }
2259
2260 return false;
Anders Carlssond59885022009-11-27 22:21:51 +00002261}
2262
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002263void OldVtableBuilder::AppendMethodsToVtable() {
Eli Friedman6c08ce72009-12-05 01:05:03 +00002264 if (!BuildVtable) {
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002265 VtableComponents.insert(VtableComponents.end(), Methods.size(),
2266 (llvm::Constant *)0);
Eli Friedman6c08ce72009-12-05 01:05:03 +00002267 ThisAdjustments.clear();
2268 BaseReturnTypes.clear();
2269 Methods.clear();
2270 return;
2271 }
2272
Anders Carlsson472404f2009-12-04 16:19:30 +00002273 // Reserve room in the vtable for our new methods.
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002274 VtableComponents.reserve(VtableComponents.size() + Methods.size());
Anders Carlssonb07567c2009-12-04 03:07:26 +00002275
Anders Carlsson86809cd2009-12-04 02:43:50 +00002276 for (unsigned i = 0, e = Methods.size(); i != e; ++i) {
2277 GlobalDecl GD = Methods[i];
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00002278 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2279
2280 // Get the 'this' pointer adjustment.
Anders Carlsson86809cd2009-12-04 02:43:50 +00002281 ThunkAdjustment ThisAdjustment = ThisAdjustments.lookup(i);
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00002282
2283 // Construct the return type adjustment.
2284 ThunkAdjustment ReturnAdjustment;
2285
2286 QualType BaseReturnType = BaseReturnTypes.lookup(i);
2287 if (!BaseReturnType.isNull() && !MD->isPure()) {
2288 QualType DerivedType =
2289 MD->getType()->getAs<FunctionType>()->getResultType();
2290
2291 int64_t NonVirtualAdjustment =
2292 getNVOffset(BaseReturnType, DerivedType) / 8;
2293
2294 int64_t VirtualAdjustment =
2295 getVbaseOffset(BaseReturnType, DerivedType);
2296
2297 ReturnAdjustment = ThunkAdjustment(NonVirtualAdjustment,
2298 VirtualAdjustment);
2299 }
2300
Anders Carlsson50f14742009-12-04 03:06:03 +00002301 llvm::Constant *Method = 0;
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00002302 if (!ReturnAdjustment.isEmpty()) {
2303 // Build a covariant thunk.
2304 CovariantThunkAdjustment Adjustment(ThisAdjustment, ReturnAdjustment);
Eli Friedman8174f2c2009-12-06 22:01:30 +00002305 Method = wrap(CGM.GetAddrOfCovariantThunk(GD, Adjustment));
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00002306 } else if (!ThisAdjustment.isEmpty()) {
2307 // Build a "regular" thunk.
Eli Friedman8174f2c2009-12-06 22:01:30 +00002308 Method = wrap(CGM.GetAddrOfThunk(GD, ThisAdjustment));
Anders Carlssonddf42c82009-12-04 02:56:03 +00002309 } else if (MD->isPure()) {
2310 // We have a pure virtual method.
Anders Carlsson50f14742009-12-04 03:06:03 +00002311 Method = getPureVirtualFn();
2312 } else {
2313 // We have a good old regular method.
2314 Method = WrapAddrOf(GD);
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00002315 }
Anders Carlsson50f14742009-12-04 03:06:03 +00002316
2317 // Add the method to the vtable.
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002318 VtableComponents.push_back(Method);
Anders Carlsson86809cd2009-12-04 02:43:50 +00002319 }
2320
Anders Carlsson50f14742009-12-04 03:06:03 +00002321
Anders Carlsson86809cd2009-12-04 02:43:50 +00002322 ThisAdjustments.clear();
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00002323 BaseReturnTypes.clear();
Anders Carlsson86809cd2009-12-04 02:43:50 +00002324
Anders Carlsson495634e2009-12-04 02:39:04 +00002325 Methods.clear();
Anders Carlsson495634e2009-12-04 02:39:04 +00002326}
2327
Anders Carlssonf942ee02009-11-27 20:47:55 +00002328void CGVtableInfo::ComputeMethodVtableIndices(const CXXRecordDecl *RD) {
2329
2330 // Itanium C++ ABI 2.5.2:
Anders Carlsson259688c2010-02-02 03:37:46 +00002331 // The order of the virtual function pointers in a virtual table is the
2332 // order of declaration of the corresponding member functions in the class.
Anders Carlssonf942ee02009-11-27 20:47:55 +00002333 //
Anders Carlsson259688c2010-02-02 03:37:46 +00002334 // There is an entry for any virtual function declared in a class,
2335 // whether it is a new function or overrides a base class function,
2336 // unless it overrides a function from the primary base, and conversion
2337 // between their return types does not require an adjustment.
Anders Carlssonf942ee02009-11-27 20:47:55 +00002338
2339 int64_t CurrentIndex = 0;
2340
2341 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
2342 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
2343
2344 if (PrimaryBase) {
Anders Carlssonc920fa22009-11-30 19:43:26 +00002345 assert(PrimaryBase->isDefinition() &&
2346 "Should have the definition decl of the primary base!");
Anders Carlssonf942ee02009-11-27 20:47:55 +00002347
2348 // Since the record decl shares its vtable pointer with the primary base
2349 // we need to start counting at the end of the primary base's vtable.
2350 CurrentIndex = getNumVirtualFunctionPointers(PrimaryBase);
2351 }
Eli Friedman21517252009-12-15 03:31:17 +00002352
2353 // Collect all the primary bases, so we can check whether methods override
2354 // a method from the base.
Anders Carlsson65b49782010-02-12 05:25:12 +00002355 VtableBuilder::PrimaryBasesSetTy PrimaryBases;
Eli Friedman21517252009-12-15 03:31:17 +00002356 for (ASTRecordLayout::primary_base_info_iterator
2357 I = Layout.primary_base_begin(), E = Layout.primary_base_end();
2358 I != E; ++I)
2359 PrimaryBases.insert((*I).getBase());
2360
Anders Carlssonf942ee02009-11-27 20:47:55 +00002361 const CXXDestructorDecl *ImplicitVirtualDtor = 0;
2362
2363 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
2364 e = RD->method_end(); i != e; ++i) {
2365 const CXXMethodDecl *MD = *i;
2366
2367 // We only want virtual methods.
2368 if (!MD->isVirtual())
2369 continue;
2370
Anders Carlssonf942ee02009-11-27 20:47:55 +00002371 // Check if this method overrides a method in the primary base.
Anders Carlsson65b49782010-02-12 05:25:12 +00002372 if (const CXXMethodDecl *OverriddenMD =
2373 OverridesMethodInPrimaryBase(MD, PrimaryBases)) {
2374 // Check if converting from the return type of the method to the
2375 // return type of the overridden method requires conversion.
Anders Carlssoncce9ee82010-02-13 23:17:31 +00002376 if (ComputeReturnAdjustmentBaseOffset(CGM.getContext(), MD,
2377 OverriddenMD).isEmpty()) {
Anders Carlsson65b49782010-02-12 05:25:12 +00002378 // This index is shared between the index in the vtable of the primary
2379 // base class.
2380 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2381 const CXXDestructorDecl *OverriddenDD =
2382 cast<CXXDestructorDecl>(OverriddenMD);
Anders Carlssonf942ee02009-11-27 20:47:55 +00002383
Anders Carlsson65b49782010-02-12 05:25:12 +00002384 // Add both the complete and deleting entries.
2385 MethodVtableIndices[GlobalDecl(DD, Dtor_Complete)] =
2386 getMethodVtableIndex(GlobalDecl(OverriddenDD, Dtor_Complete));
2387 MethodVtableIndices[GlobalDecl(DD, Dtor_Deleting)] =
2388 getMethodVtableIndex(GlobalDecl(OverriddenDD, Dtor_Deleting));
2389 } else {
2390 MethodVtableIndices[MD] = getMethodVtableIndex(OverriddenMD);
2391 }
2392
2393 // We don't need to add an entry for this method.
Anders Carlsson07604812010-02-12 18:14:46 +00002394 continue;
Anders Carlssonf942ee02009-11-27 20:47:55 +00002395 }
2396 }
2397
Anders Carlssonf942ee02009-11-27 20:47:55 +00002398 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2399 if (MD->isImplicit()) {
2400 assert(!ImplicitVirtualDtor &&
2401 "Did already see an implicit virtual dtor!");
2402 ImplicitVirtualDtor = DD;
2403 continue;
2404 }
2405
2406 // Add the complete dtor.
2407 MethodVtableIndices[GlobalDecl(DD, Dtor_Complete)] = CurrentIndex++;
2408
2409 // Add the deleting dtor.
2410 MethodVtableIndices[GlobalDecl(DD, Dtor_Deleting)] = CurrentIndex++;
2411 } else {
2412 // Add the entry.
2413 MethodVtableIndices[MD] = CurrentIndex++;
2414 }
2415 }
2416
2417 if (ImplicitVirtualDtor) {
2418 // Itanium C++ ABI 2.5.2:
Anders Carlssondc2dba32010-02-16 04:49:44 +00002419 // If a class has an implicitly-defined virtual destructor,
2420 // its entries come after the declared virtual function pointers.
Anders Carlssonf942ee02009-11-27 20:47:55 +00002421
2422 // Add the complete dtor.
2423 MethodVtableIndices[GlobalDecl(ImplicitVirtualDtor, Dtor_Complete)] =
2424 CurrentIndex++;
2425
2426 // Add the deleting dtor.
2427 MethodVtableIndices[GlobalDecl(ImplicitVirtualDtor, Dtor_Deleting)] =
2428 CurrentIndex++;
2429 }
2430
2431 NumVirtualFunctionPointers[RD] = CurrentIndex;
2432}
2433
2434uint64_t CGVtableInfo::getNumVirtualFunctionPointers(const CXXRecordDecl *RD) {
2435 llvm::DenseMap<const CXXRecordDecl *, uint64_t>::iterator I =
2436 NumVirtualFunctionPointers.find(RD);
2437 if (I != NumVirtualFunctionPointers.end())
2438 return I->second;
2439
2440 ComputeMethodVtableIndices(RD);
2441
2442 I = NumVirtualFunctionPointers.find(RD);
2443 assert(I != NumVirtualFunctionPointers.end() && "Did not find entry!");
2444 return I->second;
2445}
2446
2447uint64_t CGVtableInfo::getMethodVtableIndex(GlobalDecl GD) {
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002448 MethodVtableIndicesTy::iterator I = MethodVtableIndices.find(GD);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002449 if (I != MethodVtableIndices.end())
2450 return I->second;
2451
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002452 const CXXRecordDecl *RD = cast<CXXMethodDecl>(GD.getDecl())->getParent();
Anders Carlssonf942ee02009-11-27 20:47:55 +00002453
2454 ComputeMethodVtableIndices(RD);
2455
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002456 I = MethodVtableIndices.find(GD);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002457 assert(I != MethodVtableIndices.end() && "Did not find index!");
2458 return I->second;
2459}
2460
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002461CGVtableInfo::AdjustmentVectorTy*
2462CGVtableInfo::getAdjustments(GlobalDecl GD) {
2463 SavedAdjustmentsTy::iterator I = SavedAdjustments.find(GD);
2464 if (I != SavedAdjustments.end())
2465 return &I->second;
Eli Friedman8174f2c2009-12-06 22:01:30 +00002466
2467 const CXXRecordDecl *RD = cast<CXXRecordDecl>(GD.getDecl()->getDeclContext());
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002468 if (!SavedAdjustmentRecords.insert(RD).second)
2469 return 0;
Eli Friedman8174f2c2009-12-06 22:01:30 +00002470
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002471 AddressPointsMapTy AddressPoints;
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002472 OldVtableBuilder b(RD, RD, 0, CGM, false, AddressPoints);
Eli Friedman8174f2c2009-12-06 22:01:30 +00002473 D1(printf("vtable %s\n", RD->getNameAsCString()));
2474 b.GenerateVtableForBase(RD);
2475 b.GenerateVtableForVBases(RD);
Eli Friedman8174f2c2009-12-06 22:01:30 +00002476
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002477 for (OldVtableBuilder::SavedAdjustmentsVectorTy::iterator
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002478 i = b.getSavedAdjustments().begin(),
2479 e = b.getSavedAdjustments().end(); i != e; i++)
2480 SavedAdjustments[i->first].push_back(i->second);
Eli Friedman8174f2c2009-12-06 22:01:30 +00002481
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002482 I = SavedAdjustments.find(GD);
2483 if (I != SavedAdjustments.end())
2484 return &I->second;
2485
2486 return 0;
Eli Friedman8174f2c2009-12-06 22:01:30 +00002487}
2488
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002489int64_t CGVtableInfo::getVirtualBaseOffsetIndex(const CXXRecordDecl *RD,
2490 const CXXRecordDecl *VBase) {
2491 ClassPairTy ClassPair(RD, VBase);
2492
2493 VirtualBaseClassIndiciesTy::iterator I =
2494 VirtualBaseClassIndicies.find(ClassPair);
2495 if (I != VirtualBaseClassIndicies.end())
2496 return I->second;
2497
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002498 // FIXME: This seems expensive. Can we do a partial job to get
2499 // just this data.
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002500 AddressPointsMapTy AddressPoints;
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002501 OldVtableBuilder b(RD, RD, 0, CGM, false, AddressPoints);
Mike Stump75ce5732009-10-31 20:06:59 +00002502 D1(printf("vtable %s\n", RD->getNameAsCString()));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002503 b.GenerateVtableForBase(RD);
2504 b.GenerateVtableForVBases(RD);
2505
2506 for (llvm::DenseMap<const CXXRecordDecl *, uint64_t>::iterator I =
2507 b.getVBIndex().begin(), E = b.getVBIndex().end(); I != E; ++I) {
2508 // Insert all types.
2509 ClassPairTy ClassPair(RD, I->first);
2510
2511 VirtualBaseClassIndicies.insert(std::make_pair(ClassPair, I->second));
2512 }
2513
2514 I = VirtualBaseClassIndicies.find(ClassPair);
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00002515 // FIXME: The assertion below assertion currently fails with the old vtable
2516 /// layout code if there is a non-virtual thunk adjustment in a vtable.
2517 // Once the new layout is in place, this return should be removed.
2518 if (I == VirtualBaseClassIndicies.end())
2519 return 0;
2520
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002521 assert(I != VirtualBaseClassIndicies.end() && "Did not find index!");
2522
2523 return I->second;
2524}
2525
Anders Carlssonc8e39ec2009-12-05 21:03:56 +00002526uint64_t CGVtableInfo::getVtableAddressPoint(const CXXRecordDecl *RD) {
2527 uint64_t AddressPoint =
Anders Carlsson93a18842010-01-02 18:02:32 +00002528 (*(*(CGM.getVtableInfo().AddressPoints[RD]))[RD])[std::make_pair(RD, 0)];
Anders Carlssonc8e39ec2009-12-05 21:03:56 +00002529
2530 return AddressPoint;
2531}
2532
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00002533llvm::GlobalVariable *
Anders Carlsson0911ae82009-12-06 00:23:49 +00002534CGVtableInfo::GenerateVtable(llvm::GlobalVariable::LinkageTypes Linkage,
Anders Carlsson232324c2009-12-06 00:53:22 +00002535 bool GenerateDefinition,
Anders Carlsson0911ae82009-12-06 00:23:49 +00002536 const CXXRecordDecl *LayoutClass,
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002537 const CXXRecordDecl *RD, uint64_t Offset,
2538 AddressPointsMapTy& AddressPoints) {
Anders Carlsson1888b442010-02-14 00:22:59 +00002539 if (GenerateDefinition && CGM.getLangOptions().DumpVtableLayouts &&
2540 LayoutClass == RD) {
Anders Carlssoncf5a8822010-02-13 21:07:32 +00002541 VtableBuilder Builder(*this, RD);
Anders Carlssoneee53d92010-02-13 02:02:03 +00002542
2543 Builder.dumpLayout(llvm::errs());
2544 }
2545
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002546 llvm::SmallString<256> OutName;
Mike Stump2cefe382009-11-12 20:47:57 +00002547 if (LayoutClass != RD)
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00002548 CGM.getMangleContext().mangleCXXCtorVtable(LayoutClass, Offset / 8,
2549 RD, OutName);
Mike Stumpeac45592009-11-11 20:26:26 +00002550 else
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00002551 CGM.getMangleContext().mangleCXXVtable(RD, OutName);
Daniel Dunbare128dd12009-11-21 09:06:22 +00002552 llvm::StringRef Name = OutName.str();
Benjamin Kramerbb0a07b2009-10-11 22:57:54 +00002553
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00002554 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name);
Anders Carlsson93a18842010-01-02 18:02:32 +00002555 if (GV == 0 || CGM.getVtableInfo().AddressPoints[LayoutClass] == 0 ||
2556 GV->isDeclaration()) {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002557 OldVtableBuilder b(RD, LayoutClass, Offset, CGM, GenerateDefinition,
2558 AddressPoints);
Eli Friedman6c08ce72009-12-05 01:05:03 +00002559
2560 D1(printf("vtable %s\n", RD->getNameAsCString()));
2561 // First comes the vtables for all the non-virtual bases...
Mike Stumpd538a6d2009-12-24 07:29:41 +00002562 b.GenerateVtableForBase(RD, Offset);
Eli Friedman6c08ce72009-12-05 01:05:03 +00002563
2564 // then the vtables for all the virtual bases.
2565 b.GenerateVtableForVBases(RD, Offset);
2566
Anders Carlsson58b271d2009-12-05 22:19:10 +00002567 llvm::Constant *Init = 0;
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00002568 const llvm::Type *Int8PtrTy = llvm::Type::getInt8PtrTy(CGM.getLLVMContext());
Anders Carlsson58b271d2009-12-05 22:19:10 +00002569 llvm::ArrayType *ArrayType =
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002570 llvm::ArrayType::get(Int8PtrTy, b.getVtableComponents().size());
Anders Carlssona95d4c52009-12-05 21:09:05 +00002571
Anders Carlsson232324c2009-12-06 00:53:22 +00002572 if (GenerateDefinition)
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002573 Init = llvm::ConstantArray::get(ArrayType, &b.getVtableComponents()[0],
2574 b.getVtableComponents().size());
Anders Carlsson232324c2009-12-06 00:53:22 +00002575
Mike Stumpaa51ad62009-11-19 04:04:36 +00002576 llvm::GlobalVariable *OGV = GV;
Anders Carlsson232324c2009-12-06 00:53:22 +00002577
2578 GV = new llvm::GlobalVariable(CGM.getModule(), ArrayType,
2579 /*isConstant=*/true, Linkage, Init, Name);
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002580 CGM.setGlobalVisibility(GV, RD);
2581
Mike Stumpaa51ad62009-11-19 04:04:36 +00002582 if (OGV) {
2583 GV->takeName(OGV);
Anders Carlsson58b271d2009-12-05 22:19:10 +00002584 llvm::Constant *NewPtr =
2585 llvm::ConstantExpr::getBitCast(GV, OGV->getType());
Mike Stumpaa51ad62009-11-19 04:04:36 +00002586 OGV->replaceAllUsesWith(NewPtr);
2587 OGV->eraseFromParent();
2588 }
Mike Stumpaa51ad62009-11-19 04:04:36 +00002589 }
Anders Carlssonb3f54b72009-12-05 21:28:12 +00002590
2591 return GV;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002592}
Mike Stump9f23a142009-11-10 02:30:51 +00002593
Anders Carlsson232324c2009-12-06 00:53:22 +00002594void CGVtableInfo::GenerateClassData(llvm::GlobalVariable::LinkageTypes Linkage,
2595 const CXXRecordDecl *RD) {
Anders Carlssone1b3e622009-12-07 07:59:52 +00002596 llvm::GlobalVariable *&Vtable = Vtables[RD];
2597 if (Vtable) {
2598 assert(Vtable->getInitializer() && "Vtable doesn't have a definition!");
2599 return;
2600 }
2601
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002602 AddressPointsMapTy AddressPoints;
2603 Vtable = GenerateVtable(Linkage, /*GenerateDefinition=*/true, RD, RD, 0,
2604 AddressPoints);
Anders Carlssone36a6b32010-01-02 01:01:18 +00002605 GenerateVTT(Linkage, /*GenerateDefinition=*/true, RD);
Mike Stump1a139f82009-11-19 01:08:19 +00002606}
2607
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00002608llvm::GlobalVariable *CGVtableInfo::getVtable(const CXXRecordDecl *RD) {
Anders Carlsson232324c2009-12-06 00:53:22 +00002609 llvm::GlobalVariable *Vtable = Vtables.lookup(RD);
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00002610
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002611 if (!Vtable) {
2612 AddressPointsMapTy AddressPoints;
Anders Carlsson232324c2009-12-06 00:53:22 +00002613 Vtable = GenerateVtable(llvm::GlobalValue::ExternalLinkage,
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002614 /*GenerateDefinition=*/false, RD, RD, 0,
2615 AddressPoints);
2616 }
Mike Stumpaa51ad62009-11-19 04:04:36 +00002617
Anders Carlsson4ed44eb2009-12-05 22:42:54 +00002618 return Vtable;
Mike Stumpd846d082009-11-10 07:44:33 +00002619}
Mike Stumpeac45592009-11-11 20:26:26 +00002620
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002621void CGVtableInfo::MaybeEmitVtable(GlobalDecl GD) {
2622 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2623 const CXXRecordDecl *RD = MD->getParent();
2624
Anders Carlsson4ed44eb2009-12-05 22:42:54 +00002625 // If the class doesn't have a vtable we don't need to emit one.
2626 if (!RD->isDynamicClass())
2627 return;
2628
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002629 // Get the key function.
Anders Carlsson5ebf8b42009-12-07 04:35:11 +00002630 const CXXMethodDecl *KeyFunction = CGM.getContext().getKeyFunction(RD);
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002631
Anders Carlsson4ed44eb2009-12-05 22:42:54 +00002632 if (KeyFunction) {
2633 // We don't have the right key function.
2634 if (KeyFunction->getCanonicalDecl() != MD->getCanonicalDecl())
2635 return;
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002636 }
2637
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002638 // Emit the data.
Douglas Gregorccecc1b2010-01-06 20:27:16 +00002639 GenerateClassData(CGM.getVtableLinkage(RD), RD);
Eli Friedman8174f2c2009-12-06 22:01:30 +00002640
2641 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
2642 e = RD->method_end(); i != e; ++i) {
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002643 if ((*i)->isVirtual() && ((*i)->hasInlineBody() || (*i)->isImplicit())) {
Eli Friedman8174f2c2009-12-06 22:01:30 +00002644 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(*i)) {
2645 CGM.BuildThunksForVirtual(GlobalDecl(DD, Dtor_Complete));
2646 CGM.BuildThunksForVirtual(GlobalDecl(DD, Dtor_Deleting));
2647 } else {
2648 CGM.BuildThunksForVirtual(GlobalDecl(*i));
2649 }
2650 }
2651 }
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002652}
2653