blob: 9233838c93bf8f608680566f0072a6daf59f2d0d [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) {
915}
916
917void
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000918VtableBuilder::AddMethod(const CXXMethodDecl *MD,
Anders Carlssond3adb0c2010-02-13 23:40:17 +0000919 ReturnAdjustment ReturnAdjustment,
920 ThisAdjustment ThisAdjustment) {
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000921 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
922 assert(ReturnAdjustment.isEmpty() &&
923 "Destructor can't have return adjustment!");
Anders Carlssond3adb0c2010-02-13 23:40:17 +0000924 // Add the 'this' pointer adjustments if necessary.
925 if (!ThisAdjustment.isEmpty()) {
926 ThisAdjustments.push_back(std::make_pair(Components.size(),
927 ThisAdjustment));
928 ThisAdjustments.push_back(std::make_pair(Components.size() + 1,
929 ThisAdjustment));
930 }
931
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000932 // Add both the complete destructor and the deleting destructor.
933 Components.push_back(VtableComponent::MakeCompleteDtor(DD));
934 Components.push_back(VtableComponent::MakeDeletingDtor(DD));
935 } else {
936 // Add the return adjustment if necessary.
937 if (!ReturnAdjustment.isEmpty())
938 ReturnAdjustments.push_back(std::make_pair(Components.size(),
939 ReturnAdjustment));
940
Anders Carlssond3adb0c2010-02-13 23:40:17 +0000941 // Add the 'this' pointer adjustment if necessary.
942 if (!ThisAdjustment.isEmpty())
943 ThisAdjustments.push_back(std::make_pair(Components.size(),
944 ThisAdjustment));
945
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000946 // Add the function.
947 Components.push_back(VtableComponent::MakeFunction(MD));
948 }
949}
950
951void
952VtableBuilder::AddMethods(BaseSubobject Base, PrimaryBasesSetTy &PrimaryBases) {
Anders Carlsson65b49782010-02-12 05:25:12 +0000953 const CXXRecordDecl *RD = Base.getBase();
954
955 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
956
957 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
958 if (Layout.getPrimaryBaseWasVirtual())
959 assert(false && "FIXME: Handle vbases here.");
960 else
961 assert(Layout.getBaseClassOffset(PrimaryBase) == 0 &&
962 "Primary base should have a zero offset!");
963
Anders Carlssone75aaa92010-02-13 22:05:23 +0000964 AddMethods(BaseSubobject(PrimaryBase, Base.getBaseOffset()), PrimaryBases);
Anders Carlsson65b49782010-02-12 05:25:12 +0000965
966 if (!PrimaryBases.insert(PrimaryBase))
967 assert(false && "Found a duplicate primary base!");
968 }
Anders Carlsson932c2f22010-02-11 17:18:51 +0000969
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000970 // Now go through all virtual member functions and add them.
971 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
972 E = RD->method_end(); I != E; ++I) {
973 const CXXMethodDecl *MD = *I;
Anders Carlsson65b49782010-02-12 05:25:12 +0000974
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000975 if (!MD->isVirtual())
976 continue;
Anders Carlsson65b49782010-02-12 05:25:12 +0000977
978 // Get the final overrider.
Anders Carlsson136bd192010-02-12 16:55:34 +0000979 FinalOverriders::OverriderInfo Overrider =
980 Overriders.getOverrider(Base, MD);
Anders Carlsson65b49782010-02-12 05:25:12 +0000981
982 // Check if this virtual member function overrides a method in a primary
983 // base. If this is the case, and the return type doesn't require adjustment
984 // then we can just use the member function from the primary base.
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000985 if (const CXXMethodDecl *OverriddenMD =
986 OverridesMethodInPrimaryBase(MD, PrimaryBases)) {
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000987 if (ComputeReturnAdjustmentBaseOffset(Context, MD,
988 OverriddenMD).isEmpty())
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000989 continue;
990 }
Anders Carlssoneee53d92010-02-13 02:02:03 +0000991
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000992 // Check if this overrider needs a return adjustment.
993 FinalOverriders::BaseOffset ReturnAdjustmentOffset =
994 Overriders.getReturnAdjustmentOffset(Base, MD);
995
996 ReturnAdjustment ReturnAdjustment =
997 ComputeReturnAdjustment(ReturnAdjustmentOffset);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000998
Anders Carlssond3adb0c2010-02-13 23:40:17 +0000999 // Check if this overrider needs a 'this' pointer adjustment.
1000 FinalOverriders::BaseOffset ThisAdjustmentOffset =
1001 Overriders.getThisAdjustmentOffset(Base, MD);
1002
1003 ThisAdjustment ThisAdjustment = ComputeThisAdjustment(ThisAdjustmentOffset);
1004
1005 AddMethod(Overrider.Method, ReturnAdjustment, ThisAdjustment);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001006 }
1007}
1008
Anders Carlssondc2dba32010-02-16 04:49:44 +00001009void VtableBuilder::LayoutVtable(BaseSubobject Base) {
Anders Carlsson65b49782010-02-12 05:25:12 +00001010 const CXXRecordDecl *RD = Base.getBase();
Anders Carlsson033d4862010-02-14 17:05:59 +00001011
1012 assert(RD->isDynamicClass() && "class does not have a vtable!");
1013
Anders Carlsson65b49782010-02-12 05:25:12 +00001014 // First, add the offset to top.
Anders Carlssone75aaa92010-02-13 22:05:23 +00001015 // FIXME: This is not going to be right for construction vtables.
Anders Carlsson258a1e32010-02-14 00:16:19 +00001016 // FIXME: We should not use / 8 here.
Anders Carlssone75aaa92010-02-13 22:05:23 +00001017 int64_t OffsetToTop = -(int64_t)Base.getBaseOffset() / 8;
1018 Components.push_back(VtableComponent::MakeOffsetToTop(OffsetToTop));
Anders Carlsson65b49782010-02-12 05:25:12 +00001019
1020 // Next, add the RTTI.
Anders Carlssone75aaa92010-02-13 22:05:23 +00001021 Components.push_back(VtableComponent::MakeRTTI(MostDerivedClass));
Anders Carlsson65b49782010-02-12 05:25:12 +00001022
Anders Carlssone8a97562010-02-12 07:43:48 +00001023 uint64_t AddressPoint = Components.size();
Anders Carlsson65b49782010-02-12 05:25:12 +00001024
1025 // Now go through all virtual member functions and add them.
1026 PrimaryBasesSetTy PrimaryBases;
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001027 AddMethods(Base, PrimaryBases);
Anders Carlsson65b49782010-02-12 05:25:12 +00001028
Anders Carlssone8a97562010-02-12 07:43:48 +00001029 // Record the address point.
1030 AddressPoints.insert(std::make_pair(Base, AddressPoint));
1031
1032 // Record the address points for all primary bases.
1033 for (PrimaryBasesSetTy::const_iterator I = PrimaryBases.begin(),
1034 E = PrimaryBases.end(); I != E; ++I) {
1035 const CXXRecordDecl *BaseDecl = *I;
1036
1037 // We know that all the primary bases have the same offset as the base
1038 // subobject.
1039 BaseSubobject PrimaryBase(BaseDecl, Base.getBaseOffset());
1040 AddressPoints.insert(std::make_pair(PrimaryBase, AddressPoint));
1041 }
1042
Anders Carlsson65b49782010-02-12 05:25:12 +00001043 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1044 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
1045
Anders Carlssone75aaa92010-02-13 22:05:23 +00001046 // Layout secondary vtables.
Anders Carlsson65b49782010-02-12 05:25:12 +00001047 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1048 E = RD->bases_end(); I != E; ++I) {
1049 const CXXRecordDecl *BaseDecl =
1050 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson033d4862010-02-14 17:05:59 +00001051
Anders Carlssondc2dba32010-02-16 04:49:44 +00001052 // Ignore bases that don't have a vtable.
1053 if (!BaseDecl->isDynamicClass())
1054 continue;
1055
Anders Carlsson65b49782010-02-12 05:25:12 +00001056 // Ignore the primary base.
1057 if (BaseDecl == PrimaryBase)
1058 continue;
Anders Carlsson033d4862010-02-14 17:05:59 +00001059
Anders Carlssondc2dba32010-02-16 04:49:44 +00001060 // Ignore virtual bases, we'll emit them later.
1061 if (I->isVirtual())
Anders Carlsson033d4862010-02-14 17:05:59 +00001062 continue;
Anders Carlsson65b49782010-02-12 05:25:12 +00001063
Anders Carlssone75aaa92010-02-13 22:05:23 +00001064 // Get the base offset of this base.
1065 uint64_t BaseOffset = Base.getBaseOffset() +
1066 Layout.getBaseClassOffset(BaseDecl);
1067
1068 // Layout this secondary vtable.
Anders Carlssondc2dba32010-02-16 04:49:44 +00001069 LayoutVtable(BaseSubobject(BaseDecl, BaseOffset));
Anders Carlsson65b49782010-02-12 05:25:12 +00001070 }
Anders Carlssondc2dba32010-02-16 04:49:44 +00001071
1072 // FIXME: Emit vtables for virtual bases here.
Anders Carlsson65b49782010-02-12 05:25:12 +00001073}
1074
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001075/// dumpLayout - Dump the vtable layout.
1076void VtableBuilder::dumpLayout(llvm::raw_ostream& Out) {
1077
1078 Out << "Vtable for '" << MostDerivedClass->getQualifiedNameAsString();
1079 Out << "' (" << Components.size() << " entries).\n";
1080
Anders Carlsson932c2f22010-02-11 17:18:51 +00001081 // Iterate through the address points and insert them into a new map where
1082 // they are keyed by the index and not the base object.
1083 // Since an address point can be shared by multiple subobjects, we use an
1084 // STL multimap.
1085 std::multimap<uint64_t, BaseSubobject> AddressPointsByIndex;
1086 for (CGVtableInfo::AddressPointsMapTy::const_iterator I =
1087 AddressPoints.begin(), E = AddressPoints.end(); I != E; ++I) {
1088 const BaseSubobject& Base = I->first;
1089 uint64_t Index = I->second;
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001090
Anders Carlsson932c2f22010-02-11 17:18:51 +00001091 AddressPointsByIndex.insert(std::make_pair(Index, Base));
1092 }
1093
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001094 unsigned NextReturnAdjustmentIndex = 0;
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001095 unsigned NextThisAdjustmentIndex = 0;
Anders Carlsson932c2f22010-02-11 17:18:51 +00001096 for (unsigned I = 0, E = Components.size(); I != E; ++I) {
Anders Carlssone8a97562010-02-12 07:43:48 +00001097 uint64_t Index = I;
1098
Anders Carlsson932c2f22010-02-11 17:18:51 +00001099 if (AddressPointsByIndex.count(I)) {
Anders Carlssone8a97562010-02-12 07:43:48 +00001100 if (AddressPointsByIndex.count(Index) == 1) {
1101 const BaseSubobject &Base = AddressPointsByIndex.find(Index)->second;
1102
1103 // FIXME: Instead of dividing by 8, we should be using CharUnits.
1104 Out << " -- (" << Base.getBase()->getQualifiedNameAsString();
1105 Out << ", " << Base.getBaseOffset() / 8 << ") vtable address --\n";
1106 } else {
1107 uint64_t BaseOffset =
1108 AddressPointsByIndex.lower_bound(Index)->second.getBaseOffset();
1109
1110 // We store the class names in a set to get a stable order.
1111 std::set<std::string> ClassNames;
1112 for (std::multimap<uint64_t, BaseSubobject>::const_iterator I =
1113 AddressPointsByIndex.lower_bound(Index), E =
1114 AddressPointsByIndex.upper_bound(Index); I != E; ++I) {
1115 assert(I->second.getBaseOffset() == BaseOffset &&
1116 "Invalid base offset!");
1117 const CXXRecordDecl *RD = I->second.getBase();
1118 ClassNames.insert(RD->getQualifiedNameAsString());
1119 }
1120
1121 for (std::set<std::string>::const_iterator I = ClassNames.begin(),
1122 E = ClassNames.end(); I != E; ++I) {
1123 // FIXME: Instead of dividing by 8, we should be using CharUnits.
1124 Out << " -- (" << *I;
1125 Out << ", " << BaseOffset / 8 << ") vtable address --\n";
1126 }
1127 }
Anders Carlsson932c2f22010-02-11 17:18:51 +00001128 }
1129
1130 Out << llvm::format("%4d | ", I);
1131
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001132 const VtableComponent &Component = Components[I];
1133
1134 // Dump the component.
1135 switch (Component.getKind()) {
1136 // FIXME: Remove this default case.
1137 default:
1138 assert(false && "Unhandled component kind!");
1139 break;
1140
1141 case VtableComponent::CK_OffsetToTop:
1142 Out << "offset_to_top (" << Component.getOffsetToTop() << ")";
1143 break;
1144
1145 case VtableComponent::CK_RTTI:
1146 Out << Component.getRTTIDecl()->getQualifiedNameAsString() << " RTTI";
1147 break;
1148
Anders Carlsson5bd8d192010-02-11 18:20:28 +00001149 case VtableComponent::CK_FunctionPointer: {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001150 const CXXMethodDecl *MD = Component.getFunctionDecl();
1151
Anders Carlsson5bd8d192010-02-11 18:20:28 +00001152 std::string Str =
1153 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
1154 MD);
1155 Out << Str;
Anders Carlsson09da3372010-02-12 02:38:13 +00001156 if (MD->isPure())
1157 Out << " [pure]";
1158
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001159 // If this function pointer has a return adjustment, dump it.
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001160 if (NextReturnAdjustmentIndex < ReturnAdjustments.size() &&
1161 ReturnAdjustments[NextReturnAdjustmentIndex].first == I) {
1162 const ReturnAdjustment Adjustment =
1163 ReturnAdjustments[NextReturnAdjustmentIndex].second;
1164
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001165 Out << "\n [return adjustment: ";
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001166 Out << Adjustment.NonVirtual << " non-virtual";
1167
1168 if (Adjustment.VBaseOffsetOffset)
1169 Out << ", " << Adjustment.VBaseOffsetOffset << " vbase offset offset";
1170 Out << ']';
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001171
1172 NextReturnAdjustmentIndex++;
1173 }
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001174
1175 // If this function pointer has a 'this' pointer adjustment, dump it.
1176 if (NextThisAdjustmentIndex < ThisAdjustments.size() &&
1177 ThisAdjustments[NextThisAdjustmentIndex].first == I) {
1178 const ThisAdjustment Adjustment =
1179 ThisAdjustments[NextThisAdjustmentIndex].second;
1180
1181 Out << "\n [this adjustment: ";
1182 Out << Adjustment.NonVirtual << " non-virtual";
1183
1184 Out << ']';
1185
1186 NextThisAdjustmentIndex++;
1187 }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001188
Anders Carlsson5bd8d192010-02-11 18:20:28 +00001189 break;
1190 }
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001191
Anders Carlsson5bd8d192010-02-11 18:20:28 +00001192 case VtableComponent::CK_CompleteDtorPointer: {
1193 const CXXDestructorDecl *DD = Component.getDestructorDecl();
1194
1195 Out << DD->getQualifiedNameAsString() << "() [complete]";
Anders Carlsson09da3372010-02-12 02:38:13 +00001196 if (DD->isPure())
1197 Out << " [pure]";
1198
Anders Carlsson5bd8d192010-02-11 18:20:28 +00001199 break;
1200 }
1201
1202 case VtableComponent::CK_DeletingDtorPointer: {
1203 const CXXDestructorDecl *DD = Component.getDestructorDecl();
1204
1205 Out << DD->getQualifiedNameAsString() << "() [deleting]";
Anders Carlsson09da3372010-02-12 02:38:13 +00001206 if (DD->isPure())
1207 Out << " [pure]";
1208
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001209 break;
1210 }
1211
1212 }
Anders Carlsson932c2f22010-02-11 17:18:51 +00001213
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001214 Out << '\n';
1215 }
1216
1217}
1218
1219}
1220
1221namespace {
1222class OldVtableBuilder {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001223public:
1224 /// Index_t - Vtable index type.
1225 typedef uint64_t Index_t;
Eli Friedman31bc3ad2009-12-07 23:56:34 +00001226 typedef std::vector<std::pair<GlobalDecl,
1227 std::pair<GlobalDecl, ThunkAdjustment> > >
1228 SavedAdjustmentsVectorTy;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001229private:
Anders Carlsson472404f2009-12-04 16:19:30 +00001230
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00001231 // VtableComponents - The components of the vtable being built.
1232 typedef llvm::SmallVector<llvm::Constant *, 64> VtableComponentsVectorTy;
1233 VtableComponentsVectorTy VtableComponents;
1234
Eli Friedman6c08ce72009-12-05 01:05:03 +00001235 const bool BuildVtable;
1236
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001237 llvm::Type *Ptr8Ty;
Anders Carlssonbad80eb2009-12-04 18:36:22 +00001238
1239 /// MostDerivedClass - The most derived class that this vtable is being
1240 /// built for.
1241 const CXXRecordDecl *MostDerivedClass;
1242
Mike Stump83066c82009-11-13 01:54:23 +00001243 /// LayoutClass - The most derived class used for virtual base layout
1244 /// information.
1245 const CXXRecordDecl *LayoutClass;
Mike Stump653d0b92009-11-13 02:13:54 +00001246 /// LayoutOffset - The offset for Class in LayoutClass.
1247 uint64_t LayoutOffset;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001248 /// BLayout - Layout for the most derived class that this vtable is being
1249 /// built for.
1250 const ASTRecordLayout &BLayout;
1251 llvm::SmallSet<const CXXRecordDecl *, 32> IndirectPrimary;
1252 llvm::SmallSet<const CXXRecordDecl *, 32> SeenVBase;
1253 llvm::Constant *rtti;
1254 llvm::LLVMContext &VMContext;
1255 CodeGenModule &CGM; // Per-module state.
Anders Carlssonf2f31f42009-12-04 03:46:21 +00001256
Mike Stump90181eb2010-01-26 00:05:04 +00001257 llvm::DenseMap<const CXXMethodDecl *, Index_t> VCall;
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001258 llvm::DenseMap<GlobalDecl, Index_t> VCallOffset;
Mike Stump77537b12010-01-26 03:42:22 +00001259 llvm::DenseMap<GlobalDecl, Index_t> VCallOffsetForVCall;
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00001260 // This is the offset to the nearest virtual base
Mike Stump90181eb2010-01-26 00:05:04 +00001261 llvm::DenseMap<const CXXMethodDecl *, Index_t> NonVirtualOffset;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001262 llvm::DenseMap<const CXXRecordDecl *, Index_t> VBIndex;
Mike Stumpbb9ff052009-10-27 23:46:47 +00001263
Anders Carlsson323bb042009-11-26 19:54:33 +00001264 /// PureVirtualFunction - Points to __cxa_pure_virtual.
1265 llvm::Constant *PureVirtualFn;
1266
Anders Carlssona84b6e82009-12-04 02:01:07 +00001267 /// VtableMethods - A data structure for keeping track of methods in a vtable.
1268 /// Can add methods, override methods and iterate in vtable order.
1269 class VtableMethods {
1270 // MethodToIndexMap - Maps from a global decl to the index it has in the
1271 // Methods vector.
1272 llvm::DenseMap<GlobalDecl, uint64_t> MethodToIndexMap;
1273
1274 /// Methods - The methods, in vtable order.
1275 typedef llvm::SmallVector<GlobalDecl, 16> MethodsVectorTy;
1276 MethodsVectorTy Methods;
Eli Friedman8174f2c2009-12-06 22:01:30 +00001277 MethodsVectorTy OrigMethods;
Anders Carlssona84b6e82009-12-04 02:01:07 +00001278
1279 public:
1280 /// AddMethod - Add a method to the vtable methods.
1281 void AddMethod(GlobalDecl GD) {
1282 assert(!MethodToIndexMap.count(GD) &&
1283 "Method has already been added!");
1284
1285 MethodToIndexMap[GD] = Methods.size();
1286 Methods.push_back(GD);
Eli Friedman8174f2c2009-12-06 22:01:30 +00001287 OrigMethods.push_back(GD);
Anders Carlssona84b6e82009-12-04 02:01:07 +00001288 }
1289
1290 /// OverrideMethod - Replace a method with another.
1291 void OverrideMethod(GlobalDecl OverriddenGD, GlobalDecl GD) {
1292 llvm::DenseMap<GlobalDecl, uint64_t>::iterator i
1293 = MethodToIndexMap.find(OverriddenGD);
1294 assert(i != MethodToIndexMap.end() && "Did not find entry!");
1295
1296 // Get the index of the old decl.
1297 uint64_t Index = i->second;
1298
1299 // Replace the old decl with the new decl.
1300 Methods[Index] = GD;
1301
Anders Carlssona84b6e82009-12-04 02:01:07 +00001302 // And add the new.
1303 MethodToIndexMap[GD] = Index;
1304 }
1305
Anders Carlsson7bb70762009-12-04 15:49:02 +00001306 /// getIndex - Gives the index of a passed in GlobalDecl. Returns false if
1307 /// the index couldn't be found.
Benjamin Kramer62ab6162009-12-04 22:45:27 +00001308 bool getIndex(GlobalDecl GD, uint64_t &Index) const {
Anders Carlsson7bb70762009-12-04 15:49:02 +00001309 llvm::DenseMap<GlobalDecl, uint64_t>::const_iterator i
1310 = MethodToIndexMap.find(GD);
Eli Friedman3d2e9de2009-12-04 08:34:14 +00001311
Anders Carlsson7bb70762009-12-04 15:49:02 +00001312 if (i == MethodToIndexMap.end())
1313 return false;
Anders Carlssone6096362009-12-04 03:41:37 +00001314
Anders Carlsson7bb70762009-12-04 15:49:02 +00001315 Index = i->second;
1316 return true;
Anders Carlssone6096362009-12-04 03:41:37 +00001317 }
1318
Eli Friedman8174f2c2009-12-06 22:01:30 +00001319 GlobalDecl getOrigMethod(uint64_t Index) const {
1320 return OrigMethods[Index];
1321 }
1322
Anders Carlssona84b6e82009-12-04 02:01:07 +00001323 MethodsVectorTy::size_type size() const {
1324 return Methods.size();
1325 }
1326
1327 void clear() {
1328 MethodToIndexMap.clear();
1329 Methods.clear();
Eli Friedman8174f2c2009-12-06 22:01:30 +00001330 OrigMethods.clear();
Anders Carlssona84b6e82009-12-04 02:01:07 +00001331 }
1332
Anders Carlssone6096362009-12-04 03:41:37 +00001333 GlobalDecl operator[](uint64_t Index) const {
Anders Carlssona84b6e82009-12-04 02:01:07 +00001334 return Methods[Index];
1335 }
1336 };
1337
1338 /// Methods - The vtable methods we're currently building.
1339 VtableMethods Methods;
1340
Anders Carlsson4c837d22009-12-04 02:26:15 +00001341 /// ThisAdjustments - For a given index in the vtable, contains the 'this'
1342 /// pointer adjustment needed for a method.
1343 typedef llvm::DenseMap<uint64_t, ThunkAdjustment> ThisAdjustmentsMapTy;
1344 ThisAdjustmentsMapTy ThisAdjustments;
Anders Carlssond420a312009-11-26 19:32:45 +00001345
Eli Friedman31bc3ad2009-12-07 23:56:34 +00001346 SavedAdjustmentsVectorTy SavedAdjustments;
Eli Friedman8174f2c2009-12-06 22:01:30 +00001347
Anders Carlssonc521f952009-12-04 02:22:02 +00001348 /// BaseReturnTypes - Contains the base return types of methods who have been
1349 /// overridden with methods whose return types require adjustment. Used for
1350 /// generating covariant thunk information.
1351 typedef llvm::DenseMap<uint64_t, CanQualType> BaseReturnTypesMapTy;
1352 BaseReturnTypesMapTy BaseReturnTypes;
Anders Carlssond420a312009-11-26 19:32:45 +00001353
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001354 std::vector<Index_t> VCalls;
Mike Stump2cefe382009-11-12 20:47:57 +00001355
1356 typedef std::pair<const CXXRecordDecl *, uint64_t> CtorVtable_t;
Mike Stumpcd2b8212009-11-19 20:52:19 +00001357 // subAddressPoints - Used to hold the AddressPoints (offsets) into the built
1358 // vtable for use in computing the initializers for the VTT.
1359 llvm::DenseMap<CtorVtable_t, int64_t> &subAddressPoints;
Mike Stump2cefe382009-11-12 20:47:57 +00001360
Anders Carlsson5f9a8812010-01-14 02:29:07 +00001361 /// AddressPoints - Address points for this vtable.
1362 CGVtableInfo::AddressPointsMapTy& AddressPoints;
1363
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001364 typedef CXXRecordDecl::method_iterator method_iter;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001365 const uint32_t LLVMPointerWidth;
1366 Index_t extra;
Mike Stump37dbe962009-10-15 02:04:03 +00001367 typedef std::vector<std::pair<const CXXRecordDecl *, int64_t> > Path_t;
Mike Stumpcd2b8212009-11-19 20:52:19 +00001368 static llvm::DenseMap<CtorVtable_t, int64_t>&
1369 AllocAddressPoint(CodeGenModule &cgm, const CXXRecordDecl *l,
1370 const CXXRecordDecl *c) {
Anders Carlsson93a18842010-01-02 18:02:32 +00001371 CGVtableInfo::AddrMap_t *&oref = cgm.getVtableInfo().AddressPoints[l];
Mike Stumpcd2b8212009-11-19 20:52:19 +00001372 if (oref == 0)
Anders Carlsson93a18842010-01-02 18:02:32 +00001373 oref = new CGVtableInfo::AddrMap_t;
Mike Stumpcd2b8212009-11-19 20:52:19 +00001374
1375 llvm::DenseMap<CtorVtable_t, int64_t> *&ref = (*oref)[c];
1376 if (ref == 0)
1377 ref = new llvm::DenseMap<CtorVtable_t, int64_t>;
1378 return *ref;
1379 }
Anders Carlsson323bb042009-11-26 19:54:33 +00001380
Mike Stump90181eb2010-01-26 00:05:04 +00001381 bool DclIsSame(const FunctionDecl *New, const FunctionDecl *Old) {
1382 FunctionTemplateDecl *OldTemplate = Old->getDescribedFunctionTemplate();
1383 FunctionTemplateDecl *NewTemplate = New->getDescribedFunctionTemplate();
1384
1385 // C++ [temp.fct]p2:
1386 // A function template can be overloaded with other function templates
1387 // and with normal (non-template) functions.
1388 if ((OldTemplate == 0) != (NewTemplate == 0))
1389 return false;
1390
1391 // Is the function New an overload of the function Old?
1392 QualType OldQType = CGM.getContext().getCanonicalType(Old->getType());
1393 QualType NewQType = CGM.getContext().getCanonicalType(New->getType());
1394
1395 // Compare the signatures (C++ 1.3.10) of the two functions to
1396 // determine whether they are overloads. If we find any mismatch
1397 // in the signature, they are overloads.
1398
1399 // If either of these functions is a K&R-style function (no
1400 // prototype), then we consider them to have matching signatures.
1401 if (isa<FunctionNoProtoType>(OldQType.getTypePtr()) ||
1402 isa<FunctionNoProtoType>(NewQType.getTypePtr()))
1403 return true;
1404
1405 FunctionProtoType* OldType = cast<FunctionProtoType>(OldQType);
1406 FunctionProtoType* NewType = cast<FunctionProtoType>(NewQType);
1407
1408 // The signature of a function includes the types of its
1409 // parameters (C++ 1.3.10), which includes the presence or absence
1410 // of the ellipsis; see C++ DR 357).
1411 if (OldQType != NewQType &&
1412 (OldType->getNumArgs() != NewType->getNumArgs() ||
1413 OldType->isVariadic() != NewType->isVariadic() ||
1414 !std::equal(OldType->arg_type_begin(), OldType->arg_type_end(),
1415 NewType->arg_type_begin())))
1416 return false;
1417
1418#if 0
1419 // C++ [temp.over.link]p4:
1420 // The signature of a function template consists of its function
1421 // signature, its return type and its template parameter list. The names
1422 // of the template parameters are significant only for establishing the
1423 // relationship between the template parameters and the rest of the
1424 // signature.
1425 //
1426 // We check the return type and template parameter lists for function
1427 // templates first; the remaining checks follow.
1428 if (NewTemplate &&
1429 (!TemplateParameterListsAreEqual(NewTemplate->getTemplateParameters(),
1430 OldTemplate->getTemplateParameters(),
1431 TPL_TemplateMatch) ||
1432 OldType->getResultType() != NewType->getResultType()))
1433 return false;
1434#endif
1435
1436 // If the function is a class member, its signature includes the
1437 // cv-qualifiers (if any) on the function itself.
1438 //
1439 // As part of this, also check whether one of the member functions
1440 // is static, in which case they are not overloads (C++
1441 // 13.1p2). While not part of the definition of the signature,
1442 // this check is important to determine whether these functions
1443 // can be overloaded.
1444 const CXXMethodDecl* OldMethod = dyn_cast<CXXMethodDecl>(Old);
1445 const CXXMethodDecl* NewMethod = dyn_cast<CXXMethodDecl>(New);
1446 if (OldMethod && NewMethod &&
1447 !OldMethod->isStatic() && !NewMethod->isStatic() &&
1448 OldMethod->getTypeQualifiers() != NewMethod->getTypeQualifiers())
1449 return false;
1450
1451 // The signatures match; this is not an overload.
1452 return true;
1453 }
1454
1455 typedef llvm::DenseMap<const CXXMethodDecl *, const CXXMethodDecl*>
1456 ForwardUnique_t;
1457 ForwardUnique_t ForwardUnique;
1458 llvm::DenseMap<const CXXMethodDecl*, const CXXMethodDecl*> UniqueOverrider;
1459
1460 void BuildUniqueOverrider(const CXXMethodDecl *U, const CXXMethodDecl *MD) {
1461 const CXXMethodDecl *PrevU = UniqueOverrider[MD];
1462 assert(U && "no unique overrider");
1463 if (PrevU == U)
1464 return;
1465 if (PrevU != U && PrevU != 0) {
1466 // If already set, note the two sets as the same
1467 if (0)
1468 printf("%s::%s same as %s::%s\n",
1469 PrevU->getParent()->getNameAsCString(),
1470 PrevU->getNameAsCString(),
1471 U->getParent()->getNameAsCString(),
1472 U->getNameAsCString());
1473 ForwardUnique[PrevU] = U;
1474 return;
1475 }
1476
1477 // Not set, set it now
1478 if (0)
1479 printf("marking %s::%s %p override as %s::%s\n",
1480 MD->getParent()->getNameAsCString(),
1481 MD->getNameAsCString(),
1482 (void*)MD,
1483 U->getParent()->getNameAsCString(),
1484 U->getNameAsCString());
1485 UniqueOverrider[MD] = U;
1486
1487 for (CXXMethodDecl::method_iterator mi = MD->begin_overridden_methods(),
1488 me = MD->end_overridden_methods(); mi != me; ++mi) {
1489 BuildUniqueOverrider(U, *mi);
1490 }
1491 }
1492
1493 void BuildUniqueOverriders(const CXXRecordDecl *RD) {
1494 if (0) printf("walking %s\n", RD->getNameAsCString());
1495 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
1496 e = RD->method_end(); i != e; ++i) {
1497 const CXXMethodDecl *MD = *i;
1498 if (!MD->isVirtual())
1499 continue;
1500
1501 if (UniqueOverrider[MD] == 0) {
1502 // Only set this, if it hasn't been set yet.
1503 BuildUniqueOverrider(MD, MD);
1504 if (0)
1505 printf("top set is %s::%s %p\n",
1506 MD->getParent()->getNameAsCString(),
1507 MD->getNameAsCString(),
1508 (void*)MD);
1509 ForwardUnique[MD] = MD;
1510 }
1511 }
1512 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
1513 e = RD->bases_end(); i != e; ++i) {
1514 const CXXRecordDecl *Base =
1515 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
1516 BuildUniqueOverriders(Base);
1517 }
1518 }
1519
1520 static int DclCmp(const void *p1, const void *p2) {
John McCallef3057c2010-02-13 01:04:05 +00001521 const CXXMethodDecl *MD1 = *(const CXXMethodDecl *const *)p1;
1522 const CXXMethodDecl *MD2 = *(const CXXMethodDecl *const *)p2;
1523
1524 return (DeclarationName::compare(MD1->getDeclName(), MD2->getDeclName()));
Mike Stump90181eb2010-01-26 00:05:04 +00001525 }
1526
1527 void MergeForwarding() {
1528 typedef llvm::SmallVector<const CXXMethodDecl *, 100> A_t;
1529 A_t A;
1530 for (ForwardUnique_t::iterator I = ForwardUnique.begin(),
1531 E = ForwardUnique.end(); I != E; ++I) {
1532 if (I->first == I->second)
1533 // Only add the roots of all trees
1534 A.push_back(I->first);
1535 }
1536 llvm::array_pod_sort(A.begin(), A.end(), DclCmp);
1537 for (A_t::iterator I = A.begin(),
1538 E = A.end(); I != E; ++I) {
1539 A_t::iterator J = I;
John McCallef3057c2010-02-13 01:04:05 +00001540 while (++J != E && DclCmp(I, J) == 0)
Mike Stump90181eb2010-01-26 00:05:04 +00001541 if (DclIsSame(*I, *J)) {
Eli Friedman18c28f62010-02-13 00:03:21 +00001542 if (0) printf("connecting %s\n", (*I)->getNameAsCString());
Mike Stump90181eb2010-01-26 00:05:04 +00001543 ForwardUnique[*J] = *I;
1544 }
1545 }
1546 }
1547
1548 const CXXMethodDecl *getUnique(const CXXMethodDecl *MD) {
1549 const CXXMethodDecl *U = UniqueOverrider[MD];
1550 assert(U && "unique overrider not found");
1551 while (ForwardUnique.count(U)) {
1552 const CXXMethodDecl *NU = ForwardUnique[U];
1553 if (NU == U) break;
1554 U = NU;
1555 }
1556 return U;
1557 }
Anders Carlsson72281172010-01-26 17:36:47 +00001558
1559 GlobalDecl getUnique(GlobalDecl GD) {
1560 const CXXMethodDecl *Unique = getUnique(cast<CXXMethodDecl>(GD.getDecl()));
1561
1562 if (const CXXConstructorDecl *CD = dyn_cast<CXXConstructorDecl>(Unique))
1563 return GlobalDecl(CD, GD.getCtorType());
1564
1565 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(Unique))
1566 return GlobalDecl(DD, GD.getDtorType());
1567
1568 return Unique;
Mike Stump90181eb2010-01-26 00:05:04 +00001569 }
1570
Anders Carlsson323bb042009-11-26 19:54:33 +00001571 /// getPureVirtualFn - Return the __cxa_pure_virtual function.
1572 llvm::Constant* getPureVirtualFn() {
1573 if (!PureVirtualFn) {
1574 const llvm::FunctionType *Ty =
1575 llvm::FunctionType::get(llvm::Type::getVoidTy(VMContext),
1576 /*isVarArg=*/false);
1577 PureVirtualFn = wrap(CGM.CreateRuntimeFunction(Ty, "__cxa_pure_virtual"));
1578 }
1579
1580 return PureVirtualFn;
1581 }
1582
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001583public:
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001584 OldVtableBuilder(const CXXRecordDecl *MostDerivedClass,
Eli Friedman6c08ce72009-12-05 01:05:03 +00001585 const CXXRecordDecl *l, uint64_t lo, CodeGenModule &cgm,
Anders Carlsson5f9a8812010-01-14 02:29:07 +00001586 bool build, CGVtableInfo::AddressPointsMapTy& AddressPoints)
Eli Friedman6c08ce72009-12-05 01:05:03 +00001587 : BuildVtable(build), MostDerivedClass(MostDerivedClass), LayoutClass(l),
1588 LayoutOffset(lo), BLayout(cgm.getContext().getASTRecordLayout(l)),
1589 rtti(0), VMContext(cgm.getModule().getContext()),CGM(cgm),
1590 PureVirtualFn(0),
Anders Carlssonbad80eb2009-12-04 18:36:22 +00001591 subAddressPoints(AllocAddressPoint(cgm, l, MostDerivedClass)),
Anders Carlsson5f9a8812010-01-14 02:29:07 +00001592 AddressPoints(AddressPoints),
1593 LLVMPointerWidth(cgm.getContext().Target.getPointerWidth(0))
1594 {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001595 Ptr8Ty = llvm::PointerType::get(llvm::Type::getInt8Ty(VMContext), 0);
Anders Carlsson3f4336c2009-12-17 07:09:17 +00001596 if (BuildVtable) {
1597 QualType ClassType = CGM.getContext().getTagDeclType(MostDerivedClass);
1598 rtti = CGM.GetAddrOfRTTIDescriptor(ClassType);
1599 }
Mike Stump90181eb2010-01-26 00:05:04 +00001600 BuildUniqueOverriders(MostDerivedClass);
1601 MergeForwarding();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001602 }
1603
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00001604 // getVtableComponents - Returns a reference to the vtable components.
1605 const VtableComponentsVectorTy &getVtableComponents() const {
1606 return VtableComponents;
Anders Carlsson472404f2009-12-04 16:19:30 +00001607 }
1608
Anders Carlssone36a6b32010-01-02 01:01:18 +00001609 llvm::DenseMap<const CXXRecordDecl *, uint64_t> &getVBIndex()
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001610 { return VBIndex; }
1611
Eli Friedman31bc3ad2009-12-07 23:56:34 +00001612 SavedAdjustmentsVectorTy &getSavedAdjustments()
1613 { return SavedAdjustments; }
Eli Friedman8174f2c2009-12-06 22:01:30 +00001614
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001615 llvm::Constant *wrap(Index_t i) {
1616 llvm::Constant *m;
1617 m = llvm::ConstantInt::get(llvm::Type::getInt64Ty(VMContext), i);
1618 return llvm::ConstantExpr::getIntToPtr(m, Ptr8Ty);
1619 }
1620
1621 llvm::Constant *wrap(llvm::Constant *m) {
1622 return llvm::ConstantExpr::getBitCast(m, Ptr8Ty);
1623 }
1624
Mike Stumpd2808442010-01-22 02:51:26 +00001625//#define D1(x)
1626#define D1(X) do { if (getenv("DEBUG")) { X; } } while (0)
Mike Stump75ce5732009-10-31 20:06:59 +00001627
1628 void GenerateVBaseOffsets(const CXXRecordDecl *RD, uint64_t Offset,
Mike Stump28431212009-10-13 22:54:56 +00001629 bool updateVBIndex, Index_t current_vbindex) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001630 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
1631 e = RD->bases_end(); i != e; ++i) {
1632 const CXXRecordDecl *Base =
1633 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Mike Stump28431212009-10-13 22:54:56 +00001634 Index_t next_vbindex = current_vbindex;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001635 if (i->isVirtual() && !SeenVBase.count(Base)) {
1636 SeenVBase.insert(Base);
Mike Stump28431212009-10-13 22:54:56 +00001637 if (updateVBIndex) {
Mike Stump75ce5732009-10-31 20:06:59 +00001638 next_vbindex = (ssize_t)(-(VCalls.size()*LLVMPointerWidth/8)
Mike Stump28431212009-10-13 22:54:56 +00001639 - 3*LLVMPointerWidth/8);
1640 VBIndex[Base] = next_vbindex;
1641 }
Mike Stump75ce5732009-10-31 20:06:59 +00001642 int64_t BaseOffset = -(Offset/8) + BLayout.getVBaseClassOffset(Base)/8;
1643 VCalls.push_back((0?700:0) + BaseOffset);
1644 D1(printf(" vbase for %s at %d delta %d most derived %s\n",
1645 Base->getNameAsCString(),
1646 (int)-VCalls.size()-3, (int)BaseOffset,
Mike Stumpd2808442010-01-22 02:51:26 +00001647 MostDerivedClass->getNameAsCString()));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001648 }
Mike Stump28431212009-10-13 22:54:56 +00001649 // We also record offsets for non-virtual bases to closest enclosing
1650 // virtual base. We do this so that we don't have to search
1651 // for the nearst virtual base class when generating thunks.
1652 if (updateVBIndex && VBIndex.count(Base) == 0)
1653 VBIndex[Base] = next_vbindex;
Mike Stump75ce5732009-10-31 20:06:59 +00001654 GenerateVBaseOffsets(Base, Offset, updateVBIndex, next_vbindex);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001655 }
1656 }
1657
1658 void StartNewTable() {
1659 SeenVBase.clear();
1660 }
1661
Mike Stump8bccbfd2009-10-15 09:30:16 +00001662 Index_t getNVOffset_1(const CXXRecordDecl *D, const CXXRecordDecl *B,
1663 Index_t Offset = 0) {
1664
1665 if (B == D)
1666 return Offset;
1667
1668 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(D);
1669 for (CXXRecordDecl::base_class_const_iterator i = D->bases_begin(),
1670 e = D->bases_end(); i != e; ++i) {
1671 const CXXRecordDecl *Base =
1672 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
1673 int64_t BaseOffset = 0;
1674 if (!i->isVirtual())
1675 BaseOffset = Offset + Layout.getBaseClassOffset(Base);
1676 int64_t o = getNVOffset_1(Base, B, BaseOffset);
1677 if (o >= 0)
1678 return o;
1679 }
1680
1681 return -1;
1682 }
1683
1684 /// getNVOffset - Returns the non-virtual offset for the given (B) base of the
1685 /// derived class D.
1686 Index_t getNVOffset(QualType qB, QualType qD) {
Mike Stump46271322009-11-03 19:03:17 +00001687 qD = qD->getPointeeType();
1688 qB = qB->getPointeeType();
Mike Stump8bccbfd2009-10-15 09:30:16 +00001689 CXXRecordDecl *D = cast<CXXRecordDecl>(qD->getAs<RecordType>()->getDecl());
1690 CXXRecordDecl *B = cast<CXXRecordDecl>(qB->getAs<RecordType>()->getDecl());
1691 int64_t o = getNVOffset_1(D, B);
1692 if (o >= 0)
1693 return o;
1694
1695 assert(false && "FIXME: non-virtual base not found");
1696 return 0;
1697 }
1698
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001699 /// getVbaseOffset - Returns the index into the vtable for the virtual base
1700 /// offset for the given (B) virtual base of the derived class D.
1701 Index_t getVbaseOffset(QualType qB, QualType qD) {
Mike Stump46271322009-11-03 19:03:17 +00001702 qD = qD->getPointeeType();
1703 qB = qB->getPointeeType();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001704 CXXRecordDecl *D = cast<CXXRecordDecl>(qD->getAs<RecordType>()->getDecl());
1705 CXXRecordDecl *B = cast<CXXRecordDecl>(qB->getAs<RecordType>()->getDecl());
Anders Carlssonbad80eb2009-12-04 18:36:22 +00001706 if (D != MostDerivedClass)
Eli Friedman03aa2f12009-11-30 01:19:33 +00001707 return CGM.getVtableInfo().getVirtualBaseOffsetIndex(D, B);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001708 llvm::DenseMap<const CXXRecordDecl *, Index_t>::iterator i;
1709 i = VBIndex.find(B);
1710 if (i != VBIndex.end())
1711 return i->second;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001712
Mike Stump28431212009-10-13 22:54:56 +00001713 assert(false && "FIXME: Base not found");
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001714 return 0;
1715 }
1716
Eli Friedman81fb0d22009-12-04 08:40:51 +00001717 bool OverrideMethod(GlobalDecl GD, bool MorallyVirtual,
1718 Index_t OverrideOffset, Index_t Offset,
1719 int64_t CurrentVBaseOffset);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001720
Anders Carlsson495634e2009-12-04 02:39:04 +00001721 /// AppendMethods - Append the current methods to the vtable.
Anders Carlssonddf42c82009-12-04 02:56:03 +00001722 void AppendMethodsToVtable();
Anders Carlsson495634e2009-12-04 02:39:04 +00001723
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001724 llvm::Constant *WrapAddrOf(GlobalDecl GD) {
1725 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
1726
Anders Carlsson64457732009-11-24 05:08:52 +00001727 const llvm::Type *Ty = CGM.getTypes().GetFunctionTypeForVtable(MD);
Mike Stump18e8b472009-10-27 23:36:26 +00001728
Mike Stumpcdeb8002009-12-03 16:55:20 +00001729 return wrap(CGM.GetAddrOfFunction(GD, Ty));
Mike Stump18e8b472009-10-27 23:36:26 +00001730 }
1731
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00001732 void OverrideMethods(Path_t *Path, bool MorallyVirtual, int64_t Offset,
1733 int64_t CurrentVBaseOffset) {
Mike Stump37dbe962009-10-15 02:04:03 +00001734 for (Path_t::reverse_iterator i = Path->rbegin(),
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001735 e = Path->rend(); i != e; ++i) {
1736 const CXXRecordDecl *RD = i->first;
Mike Stump8bccbfd2009-10-15 09:30:16 +00001737 int64_t OverrideOffset = i->second;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001738 for (method_iter mi = RD->method_begin(), me = RD->method_end(); mi != me;
1739 ++mi) {
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001740 const CXXMethodDecl *MD = *mi;
1741
1742 if (!MD->isVirtual())
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001743 continue;
1744
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001745 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1746 // Override both the complete and the deleting destructor.
1747 GlobalDecl CompDtor(DD, Dtor_Complete);
Eli Friedman81fb0d22009-12-04 08:40:51 +00001748 OverrideMethod(CompDtor, MorallyVirtual, OverrideOffset, Offset,
1749 CurrentVBaseOffset);
1750
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001751 GlobalDecl DeletingDtor(DD, Dtor_Deleting);
Eli Friedman81fb0d22009-12-04 08:40:51 +00001752 OverrideMethod(DeletingDtor, MorallyVirtual, OverrideOffset, Offset,
1753 CurrentVBaseOffset);
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001754 } else {
Eli Friedman81fb0d22009-12-04 08:40:51 +00001755 OverrideMethod(MD, MorallyVirtual, OverrideOffset, Offset,
1756 CurrentVBaseOffset);
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001757 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001758 }
1759 }
1760 }
1761
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001762 void AddMethod(const GlobalDecl GD, bool MorallyVirtual, Index_t Offset,
Eli Friedman03aa2f12009-11-30 01:19:33 +00001763 int64_t CurrentVBaseOffset) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001764 // If we can find a previously allocated slot for this, reuse it.
Eli Friedman81fb0d22009-12-04 08:40:51 +00001765 if (OverrideMethod(GD, MorallyVirtual, Offset, Offset,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00001766 CurrentVBaseOffset))
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001767 return;
1768
Mike Stump1f49d652010-01-22 18:48:47 +00001769 D1(printf(" vfn for %s at %d\n",
1770 dyn_cast<CXXMethodDecl>(GD.getDecl())->getNameAsCString(),
1771 (int)Methods.size()));
1772
Anders Carlssoncdf18982009-12-04 02:08:24 +00001773 // We didn't find an entry in the vtable that we could use, add a new
1774 // entry.
1775 Methods.AddMethod(GD);
1776
Mike Stumpa04ecfb2010-01-26 21:35:27 +00001777 VCallOffset[GD] = Offset/8 - CurrentVBaseOffset/8;
1778
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001779 if (MorallyVirtual) {
Anders Carlsson72281172010-01-26 17:36:47 +00001780 GlobalDecl UGD = getUnique(GD);
1781 const CXXMethodDecl *UMD = cast<CXXMethodDecl>(UGD.getDecl());
1782
Mike Stump90181eb2010-01-26 00:05:04 +00001783 assert(UMD && "final overrider not found");
1784
1785 Index_t &idx = VCall[UMD];
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001786 // Allocate the first one, after that, we reuse the previous one.
1787 if (idx == 0) {
Anders Carlsson72281172010-01-26 17:36:47 +00001788 VCallOffsetForVCall[UGD] = Offset/8;
Mike Stumpa04ecfb2010-01-26 21:35:27 +00001789 NonVirtualOffset[UMD] = Offset/8 - CurrentVBaseOffset/8;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001790 idx = VCalls.size()+1;
Mike Stump90181eb2010-01-26 00:05:04 +00001791 VCalls.push_back(Offset/8 - CurrentVBaseOffset/8);
Mike Stump75ce5732009-10-31 20:06:59 +00001792 D1(printf(" vcall for %s at %d with delta %d\n",
Mike Stumpd2808442010-01-22 02:51:26 +00001793 dyn_cast<CXXMethodDecl>(GD.getDecl())->getNameAsCString(),
Mike Stump90181eb2010-01-26 00:05:04 +00001794 (int)-VCalls.size()-3, (int)VCalls[idx-1]));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001795 }
1796 }
1797 }
1798
1799 void AddMethods(const CXXRecordDecl *RD, bool MorallyVirtual,
Eli Friedman03aa2f12009-11-30 01:19:33 +00001800 Index_t Offset, int64_t CurrentVBaseOffset) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001801 for (method_iter mi = RD->method_begin(), me = RD->method_end(); mi != me;
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001802 ++mi) {
1803 const CXXMethodDecl *MD = *mi;
1804 if (!MD->isVirtual())
1805 continue;
1806
1807 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1808 // For destructors, add both the complete and the deleting destructor
1809 // to the vtable.
1810 AddMethod(GlobalDecl(DD, Dtor_Complete), MorallyVirtual, Offset,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00001811 CurrentVBaseOffset);
Eli Friedman03aa2f12009-11-30 01:19:33 +00001812 AddMethod(GlobalDecl(DD, Dtor_Deleting), MorallyVirtual, Offset,
1813 CurrentVBaseOffset);
1814 } else
1815 AddMethod(MD, MorallyVirtual, Offset, CurrentVBaseOffset);
Anders Carlssonfb4dda42009-11-13 17:08:56 +00001816 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001817 }
1818
1819 void NonVirtualBases(const CXXRecordDecl *RD, const ASTRecordLayout &Layout,
1820 const CXXRecordDecl *PrimaryBase,
1821 bool PrimaryBaseWasVirtual, bool MorallyVirtual,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00001822 int64_t Offset, int64_t CurrentVBaseOffset,
1823 Path_t *Path) {
Mike Stump37dbe962009-10-15 02:04:03 +00001824 Path->push_back(std::make_pair(RD, Offset));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001825 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
1826 e = RD->bases_end(); i != e; ++i) {
1827 if (i->isVirtual())
1828 continue;
1829 const CXXRecordDecl *Base =
1830 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Mike Stump9eb76d42010-01-22 06:45:05 +00001831 uint64_t o = Offset + Layout.getBaseClassOffset(Base);
1832 StartNewTable();
1833 GenerateVtableForBase(Base, o, MorallyVirtual, false,
1834 true, Base == PrimaryBase && !PrimaryBaseWasVirtual,
1835 CurrentVBaseOffset, Path);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001836 }
Mike Stump37dbe962009-10-15 02:04:03 +00001837 Path->pop_back();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001838 }
1839
Mike Stumpb21c4ee2009-10-14 18:14:51 +00001840// #define D(X) do { X; } while (0)
1841#define D(X)
1842
1843 void insertVCalls(int InsertionPoint) {
Mike Stump75ce5732009-10-31 20:06:59 +00001844 D1(printf("============= combining vbase/vcall\n"));
Mike Stumpb21c4ee2009-10-14 18:14:51 +00001845 D(VCalls.insert(VCalls.begin(), 673));
1846 D(VCalls.push_back(672));
Eli Friedman6c08ce72009-12-05 01:05:03 +00001847
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00001848 VtableComponents.insert(VtableComponents.begin() + InsertionPoint,
1849 VCalls.size(), 0);
Eli Friedman6c08ce72009-12-05 01:05:03 +00001850 if (BuildVtable) {
1851 // The vcalls come first...
1852 for (std::vector<Index_t>::reverse_iterator i = VCalls.rbegin(),
1853 e = VCalls.rend();
1854 i != e; ++i)
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00001855 VtableComponents[InsertionPoint++] = wrap((0?600:0) + *i);
Eli Friedman6c08ce72009-12-05 01:05:03 +00001856 }
Mike Stumpb21c4ee2009-10-14 18:14:51 +00001857 VCalls.clear();
Mike Stump9f23a142009-11-10 02:30:51 +00001858 VCall.clear();
Mike Stumpa04ecfb2010-01-26 21:35:27 +00001859 VCallOffsetForVCall.clear();
1860 VCallOffset.clear();
1861 NonVirtualOffset.clear();
Mike Stumpb21c4ee2009-10-14 18:14:51 +00001862 }
1863
Mike Stump559387f2009-11-13 23:13:20 +00001864 void AddAddressPoints(const CXXRecordDecl *RD, uint64_t Offset,
1865 Index_t AddressPoint) {
1866 D1(printf("XXX address point for %s in %s layout %s at offset %d is %d\n",
Mike Stumpd2808442010-01-22 02:51:26 +00001867 RD->getNameAsCString(), MostDerivedClass->getNameAsCString(),
Mike Stump559387f2009-11-13 23:13:20 +00001868 LayoutClass->getNameAsCString(), (int)Offset, (int)AddressPoint));
Mike Stumpcd2b8212009-11-19 20:52:19 +00001869 subAddressPoints[std::make_pair(RD, Offset)] = AddressPoint;
Anders Carlsson5f9a8812010-01-14 02:29:07 +00001870 AddressPoints[BaseSubobject(RD, Offset)] = AddressPoint;
Mike Stump559387f2009-11-13 23:13:20 +00001871
1872 // Now also add the address point for all our primary bases.
1873 while (1) {
1874 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
1875 RD = Layout.getPrimaryBase();
1876 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
1877 // FIXME: Double check this.
1878 if (RD == 0)
1879 break;
1880 if (PrimaryBaseWasVirtual &&
1881 BLayout.getVBaseClassOffset(RD) != Offset)
1882 break;
1883 D1(printf("XXX address point for %s in %s layout %s at offset %d is %d\n",
Mike Stumpd2808442010-01-22 02:51:26 +00001884 RD->getNameAsCString(), MostDerivedClass->getNameAsCString(),
Mike Stump559387f2009-11-13 23:13:20 +00001885 LayoutClass->getNameAsCString(), (int)Offset, (int)AddressPoint));
Mike Stumpcd2b8212009-11-19 20:52:19 +00001886 subAddressPoints[std::make_pair(RD, Offset)] = AddressPoint;
Anders Carlsson5f9a8812010-01-14 02:29:07 +00001887 AddressPoints[BaseSubobject(RD, Offset)] = AddressPoint;
Mike Stump559387f2009-11-13 23:13:20 +00001888 }
1889 }
1890
1891
Mike Stumpd538a6d2009-12-24 07:29:41 +00001892 void FinishGenerateVtable(const CXXRecordDecl *RD,
1893 const ASTRecordLayout &Layout,
1894 const CXXRecordDecl *PrimaryBase,
Mike Stump9eb76d42010-01-22 06:45:05 +00001895 bool ForNPNVBases, bool WasPrimaryBase,
Mike Stumpd538a6d2009-12-24 07:29:41 +00001896 bool PrimaryBaseWasVirtual,
1897 bool MorallyVirtual, int64_t Offset,
1898 bool ForVirtualBase, int64_t CurrentVBaseOffset,
1899 Path_t *Path) {
Mike Stump37dbe962009-10-15 02:04:03 +00001900 bool alloc = false;
1901 if (Path == 0) {
1902 alloc = true;
1903 Path = new Path_t;
1904 }
1905
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001906 StartNewTable();
1907 extra = 0;
Mike Stump9eb76d42010-01-22 06:45:05 +00001908 Index_t AddressPoint = 0;
1909 int VCallInsertionPoint = 0;
1910 if (!ForNPNVBases || !WasPrimaryBase) {
1911 bool DeferVCalls = MorallyVirtual || ForVirtualBase;
1912 VCallInsertionPoint = VtableComponents.size();
1913 if (!DeferVCalls) {
1914 insertVCalls(VCallInsertionPoint);
1915 } else
1916 // FIXME: just for extra, or for all uses of VCalls.size post this?
1917 extra = -VCalls.size();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001918
Mike Stump9eb76d42010-01-22 06:45:05 +00001919 // Add the offset to top.
1920 VtableComponents.push_back(BuildVtable ? wrap(-((Offset-LayoutOffset)/8)) : 0);
Anders Carlsson472404f2009-12-04 16:19:30 +00001921
Mike Stump9eb76d42010-01-22 06:45:05 +00001922 // Add the RTTI information.
1923 VtableComponents.push_back(rtti);
Anders Carlsson472404f2009-12-04 16:19:30 +00001924
Mike Stump9eb76d42010-01-22 06:45:05 +00001925 AddressPoint = VtableComponents.size();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001926
Mike Stump9eb76d42010-01-22 06:45:05 +00001927 AppendMethodsToVtable();
1928 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001929
1930 // and then the non-virtual bases.
1931 NonVirtualBases(RD, Layout, PrimaryBase, PrimaryBaseWasVirtual,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00001932 MorallyVirtual, Offset, CurrentVBaseOffset, Path);
Mike Stumpb21c4ee2009-10-14 18:14:51 +00001933
1934 if (ForVirtualBase) {
Mike Stump2cefe382009-11-12 20:47:57 +00001935 // FIXME: We're adding to VCalls in callers, we need to do the overrides
1936 // in the inner part, so that we know the complete set of vcalls during
1937 // the build and don't have to insert into methods. Saving out the
1938 // AddressPoint here, would need to be fixed, if we didn't do that. Also
1939 // retroactively adding vcalls for overrides later wind up in the wrong
1940 // place, the vcall slot has to be alloted during the walk of the base
1941 // when the function is first introduces.
Mike Stumpb21c4ee2009-10-14 18:14:51 +00001942 AddressPoint += VCalls.size();
Mike Stump2cefe382009-11-12 20:47:57 +00001943 insertVCalls(VCallInsertionPoint);
Mike Stumpb21c4ee2009-10-14 18:14:51 +00001944 }
1945
Mike Stump9eb76d42010-01-22 06:45:05 +00001946 if (!ForNPNVBases || !WasPrimaryBase)
1947 AddAddressPoints(RD, Offset, AddressPoint);
Mike Stump2cefe382009-11-12 20:47:57 +00001948
Mike Stump37dbe962009-10-15 02:04:03 +00001949 if (alloc) {
1950 delete Path;
1951 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001952 }
1953
Mike Stump75ce5732009-10-31 20:06:59 +00001954 void Primaries(const CXXRecordDecl *RD, bool MorallyVirtual, int64_t Offset,
1955 bool updateVBIndex, Index_t current_vbindex,
Eli Friedman03aa2f12009-11-30 01:19:33 +00001956 int64_t CurrentVBaseOffset) {
Mike Stump75ce5732009-10-31 20:06:59 +00001957 if (!RD->isDynamicClass())
1958 return;
1959
1960 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
1961 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
1962 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
1963
1964 // vtables are composed from the chain of primaries.
Eli Friedman65d87222009-12-04 08:52:11 +00001965 if (PrimaryBase && !PrimaryBaseWasVirtual) {
Mike Stump75ce5732009-10-31 20:06:59 +00001966 D1(printf(" doing primaries for %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00001967 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Eli Friedman65d87222009-12-04 08:52:11 +00001968 Primaries(PrimaryBase, PrimaryBaseWasVirtual|MorallyVirtual, Offset,
1969 updateVBIndex, current_vbindex, CurrentVBaseOffset);
Mike Stump75ce5732009-10-31 20:06:59 +00001970 }
1971
1972 D1(printf(" doing vcall entries for %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00001973 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Mike Stump75ce5732009-10-31 20:06:59 +00001974
1975 // And add the virtuals for the class to the primary vtable.
Eli Friedman03aa2f12009-11-30 01:19:33 +00001976 AddMethods(RD, MorallyVirtual, Offset, CurrentVBaseOffset);
Mike Stump75ce5732009-10-31 20:06:59 +00001977 }
1978
1979 void VBPrimaries(const CXXRecordDecl *RD, bool MorallyVirtual, int64_t Offset,
1980 bool updateVBIndex, Index_t current_vbindex,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00001981 bool RDisVirtualBase, int64_t CurrentVBaseOffset,
Eli Friedman03aa2f12009-11-30 01:19:33 +00001982 bool bottom) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001983 if (!RD->isDynamicClass())
1984 return;
1985
1986 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
1987 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
1988 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
1989
1990 // vtables are composed from the chain of primaries.
1991 if (PrimaryBase) {
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00001992 int BaseCurrentVBaseOffset = CurrentVBaseOffset;
1993 if (PrimaryBaseWasVirtual) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001994 IndirectPrimary.insert(PrimaryBase);
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00001995 BaseCurrentVBaseOffset = BLayout.getVBaseClassOffset(PrimaryBase);
1996 }
Mike Stump75ce5732009-10-31 20:06:59 +00001997
1998 D1(printf(" doing primaries for %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00001999 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Mike Stump75ce5732009-10-31 20:06:59 +00002000
2001 VBPrimaries(PrimaryBase, PrimaryBaseWasVirtual|MorallyVirtual, Offset,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002002 updateVBIndex, current_vbindex, PrimaryBaseWasVirtual,
Eli Friedman03aa2f12009-11-30 01:19:33 +00002003 BaseCurrentVBaseOffset, false);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002004 }
2005
Mike Stump75ce5732009-10-31 20:06:59 +00002006 D1(printf(" doing vbase 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 GenerateVBaseOffsets(RD, Offset, updateVBIndex, current_vbindex);
2009
2010 if (RDisVirtualBase || bottom) {
2011 Primaries(RD, MorallyVirtual, Offset, updateVBIndex, current_vbindex,
Eli Friedman03aa2f12009-11-30 01:19:33 +00002012 CurrentVBaseOffset);
Mike Stump75ce5732009-10-31 20:06:59 +00002013 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002014 }
2015
Mike Stumpd538a6d2009-12-24 07:29:41 +00002016 void GenerateVtableForBase(const CXXRecordDecl *RD, int64_t Offset = 0,
2017 bool MorallyVirtual = false,
2018 bool ForVirtualBase = false,
Mike Stump9eb76d42010-01-22 06:45:05 +00002019 bool ForNPNVBases = false,
2020 bool WasPrimaryBase = true,
Mike Stumpd538a6d2009-12-24 07:29:41 +00002021 int CurrentVBaseOffset = 0,
2022 Path_t *Path = 0) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002023 if (!RD->isDynamicClass())
Mike Stumpd538a6d2009-12-24 07:29:41 +00002024 return;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002025
Mike Stumpfa818082009-11-13 02:35:38 +00002026 // Construction vtable don't need parts that have no virtual bases and
2027 // aren't morally virtual.
Anders Carlssonbad80eb2009-12-04 18:36:22 +00002028 if ((LayoutClass != MostDerivedClass) &&
2029 RD->getNumVBases() == 0 && !MorallyVirtual)
Mike Stumpd538a6d2009-12-24 07:29:41 +00002030 return;
Mike Stumpfa818082009-11-13 02:35:38 +00002031
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002032 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
2033 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
2034 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
2035
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002036 extra = 0;
Mike Stump75ce5732009-10-31 20:06:59 +00002037 D1(printf("building entries for base %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002038 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002039
Mike Stump75ce5732009-10-31 20:06:59 +00002040 if (ForVirtualBase)
2041 extra = VCalls.size();
2042
Mike Stump9eb76d42010-01-22 06:45:05 +00002043 if (!ForNPNVBases || !WasPrimaryBase) {
2044 VBPrimaries(RD, MorallyVirtual, Offset, !ForVirtualBase, 0,
2045 ForVirtualBase, CurrentVBaseOffset, true);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002046
Mike Stump9eb76d42010-01-22 06:45:05 +00002047 if (Path)
2048 OverrideMethods(Path, MorallyVirtual, Offset, CurrentVBaseOffset);
2049 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002050
Mike Stump9eb76d42010-01-22 06:45:05 +00002051 FinishGenerateVtable(RD, Layout, PrimaryBase, ForNPNVBases, WasPrimaryBase,
2052 PrimaryBaseWasVirtual, MorallyVirtual, Offset,
2053 ForVirtualBase, CurrentVBaseOffset, Path);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002054 }
2055
2056 void GenerateVtableForVBases(const CXXRecordDecl *RD,
2057 int64_t Offset = 0,
Mike Stump37dbe962009-10-15 02:04:03 +00002058 Path_t *Path = 0) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002059 bool alloc = false;
2060 if (Path == 0) {
2061 alloc = true;
Mike Stump37dbe962009-10-15 02:04:03 +00002062 Path = new Path_t;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002063 }
2064 // FIXME: We also need to override using all paths to a virtual base,
2065 // right now, we just process the first path
2066 Path->push_back(std::make_pair(RD, Offset));
2067 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
2068 e = RD->bases_end(); i != e; ++i) {
2069 const CXXRecordDecl *Base =
2070 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
2071 if (i->isVirtual() && !IndirectPrimary.count(Base)) {
2072 // Mark it so we don't output it twice.
2073 IndirectPrimary.insert(Base);
2074 StartNewTable();
Mike Stumpb21c4ee2009-10-14 18:14:51 +00002075 VCall.clear();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002076 int64_t BaseOffset = BLayout.getVBaseClassOffset(Base);
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002077 int64_t CurrentVBaseOffset = BaseOffset;
Mike Stump75ce5732009-10-31 20:06:59 +00002078 D1(printf("vtable %s virtual base %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002079 MostDerivedClass->getNameAsCString(), Base->getNameAsCString()));
Mike Stump9eb76d42010-01-22 06:45:05 +00002080 GenerateVtableForBase(Base, BaseOffset, true, true, false,
2081 true, CurrentVBaseOffset, Path);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002082 }
Mike Stump2cefe382009-11-12 20:47:57 +00002083 int64_t BaseOffset;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002084 if (i->isVirtual())
2085 BaseOffset = BLayout.getVBaseClassOffset(Base);
Mike Stump2cefe382009-11-12 20:47:57 +00002086 else {
2087 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
2088 BaseOffset = Offset + Layout.getBaseClassOffset(Base);
2089 }
2090
Mike Stump37dbe962009-10-15 02:04:03 +00002091 if (Base->getNumVBases()) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002092 GenerateVtableForVBases(Base, BaseOffset, Path);
Mike Stump37dbe962009-10-15 02:04:03 +00002093 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002094 }
2095 Path->pop_back();
2096 if (alloc)
2097 delete Path;
2098 }
2099};
Anders Carlssonca1bf682009-12-03 01:54:02 +00002100} // end anonymous namespace
2101
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002102bool OldVtableBuilder::OverrideMethod(GlobalDecl GD, bool MorallyVirtual,
Eli Friedman81fb0d22009-12-04 08:40:51 +00002103 Index_t OverrideOffset, Index_t Offset,
2104 int64_t CurrentVBaseOffset) {
Anders Carlssonca1bf682009-12-03 01:54:02 +00002105 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2106
2107 const bool isPure = MD->isPure();
Anders Carlsson21bbc1e2009-12-05 17:04:47 +00002108
Anders Carlssonca1bf682009-12-03 01:54:02 +00002109 // FIXME: Should OverrideOffset's be Offset?
2110
Anders Carlsson21bbc1e2009-12-05 17:04:47 +00002111 for (CXXMethodDecl::method_iterator mi = MD->begin_overridden_methods(),
2112 e = MD->end_overridden_methods(); mi != e; ++mi) {
Anders Carlssonca1bf682009-12-03 01:54:02 +00002113 GlobalDecl OGD;
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002114 GlobalDecl OGD2;
Anders Carlssonca1bf682009-12-03 01:54:02 +00002115
Anders Carlssonf3935b42009-12-04 05:51:56 +00002116 const CXXMethodDecl *OMD = *mi;
Anders Carlssonca1bf682009-12-03 01:54:02 +00002117 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(OMD))
2118 OGD = GlobalDecl(DD, GD.getDtorType());
2119 else
2120 OGD = OMD;
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002121
Eli Friedman8174f2c2009-12-06 22:01:30 +00002122 // Check whether this is the method being overridden in this section of
2123 // the vtable.
Anders Carlsson7bb70762009-12-04 15:49:02 +00002124 uint64_t Index;
2125 if (!Methods.getIndex(OGD, Index))
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002126 continue;
2127
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002128 OGD2 = OGD;
2129
Eli Friedman8174f2c2009-12-06 22:01:30 +00002130 // Get the original method, which we should be computing thunks, etc,
2131 // against.
2132 OGD = Methods.getOrigMethod(Index);
2133 OMD = cast<CXXMethodDecl>(OGD.getDecl());
2134
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002135 QualType ReturnType =
2136 MD->getType()->getAs<FunctionType>()->getResultType();
2137 QualType OverriddenReturnType =
2138 OMD->getType()->getAs<FunctionType>()->getResultType();
Anders Carlssonca1bf682009-12-03 01:54:02 +00002139
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002140 // Check if we need a return type adjustment.
Anders Carlssoncce9ee82010-02-13 23:17:31 +00002141 if (!ComputeReturnAdjustmentBaseOffset(CGM.getContext(), MD,
2142 OMD).isEmpty()) {
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002143 CanQualType &BaseReturnType = BaseReturnTypes[Index];
Anders Carlssonca1bf682009-12-03 01:54:02 +00002144
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002145 // Insert the base return type.
2146 if (BaseReturnType.isNull())
2147 BaseReturnType =
2148 CGM.getContext().getCanonicalType(OverriddenReturnType);
2149 }
Anders Carlssona93e9802009-12-04 03:52:52 +00002150
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002151 Methods.OverrideMethod(OGD, GD);
2152
Anders Carlsson72281172010-01-26 17:36:47 +00002153 GlobalDecl UGD = getUnique(GD);
2154 const CXXMethodDecl *UMD = cast<CXXMethodDecl>(UGD.getDecl());
2155 assert(UGD.getDecl() && "unique overrider not found");
2156 assert(UGD == getUnique(OGD) && "unique overrider not unique");
Mike Stump90181eb2010-01-26 00:05:04 +00002157
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002158 ThisAdjustments.erase(Index);
Mike Stump90181eb2010-01-26 00:05:04 +00002159 if (MorallyVirtual || VCall.count(UMD)) {
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002160
Mike Stump90181eb2010-01-26 00:05:04 +00002161 Index_t &idx = VCall[UMD];
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002162 if (idx == 0) {
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002163 VCallOffset[GD] = VCallOffset[OGD];
2164 // NonVirtualOffset[UMD] = CurrentVBaseOffset/8 - OverrideOffset/8;
2165 NonVirtualOffset[UMD] = VCallOffset[OGD];
Mike Stump77537b12010-01-26 03:42:22 +00002166 VCallOffsetForVCall[UMD] = OverrideOffset/8;
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002167 idx = VCalls.size()+1;
Mike Stump77537b12010-01-26 03:42:22 +00002168 VCalls.push_back(OverrideOffset/8 - CurrentVBaseOffset/8);
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002169 D1(printf(" vcall for %s at %d with delta %d most derived %s\n",
2170 MD->getNameAsString().c_str(), (int)-idx-3,
Mike Stumpd2808442010-01-22 02:51:26 +00002171 (int)VCalls[idx-1], MostDerivedClass->getNameAsCString()));
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002172 } else {
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002173 VCallOffset[GD] = NonVirtualOffset[UMD];
Anders Carlsson72281172010-01-26 17:36:47 +00002174 VCalls[idx-1] = -VCallOffsetForVCall[UGD] + OverrideOffset/8;
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002175 D1(printf(" vcall patch for %s at %d with delta %d most derived %s\n",
2176 MD->getNameAsString().c_str(), (int)-idx-3,
Mike Stumpd2808442010-01-22 02:51:26 +00002177 (int)VCalls[idx-1], MostDerivedClass->getNameAsCString()));
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002178 }
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002179 int64_t NonVirtualAdjustment = -VCallOffset[OGD];
Mike Stumpded0a402010-01-26 22:44:01 +00002180 QualType DerivedType = MD->getThisType(CGM.getContext());
2181 QualType BaseType = cast<const CXXMethodDecl>(OGD.getDecl())->getThisType(CGM.getContext());
2182 int64_t NonVirtualAdjustment2 = -(getNVOffset(BaseType, DerivedType)/8);
2183 if (NonVirtualAdjustment2 != NonVirtualAdjustment) {
2184 NonVirtualAdjustment = NonVirtualAdjustment2;
2185 }
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002186 int64_t VirtualAdjustment =
2187 -((idx + extra + 2) * LLVMPointerWidth / 8);
Anders Carlsson657f1392009-12-03 02:32:59 +00002188
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002189 // Optimize out virtual adjustments of 0.
2190 if (VCalls[idx-1] == 0)
2191 VirtualAdjustment = 0;
Anders Carlsson657f1392009-12-03 02:32:59 +00002192
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002193 ThunkAdjustment ThisAdjustment(NonVirtualAdjustment,
2194 VirtualAdjustment);
Anders Carlsson2ca285f2009-12-03 02:22:59 +00002195
Eli Friedman8174f2c2009-12-06 22:01:30 +00002196 if (!isPure && !ThisAdjustment.isEmpty()) {
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002197 ThisAdjustments[Index] = ThisAdjustment;
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002198 SavedAdjustments.push_back(
2199 std::make_pair(GD, std::make_pair(OGD, ThisAdjustment)));
Eli Friedman8174f2c2009-12-06 22:01:30 +00002200 }
Anders Carlssonca1bf682009-12-03 01:54:02 +00002201 return true;
2202 }
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002203
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002204 VCallOffset[GD] = VCallOffset[OGD2] - OverrideOffset/8;
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002205
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002206 int64_t NonVirtualAdjustment = -VCallOffset[GD];
2207 QualType DerivedType = MD->getThisType(CGM.getContext());
2208 QualType BaseType = cast<const CXXMethodDecl>(OGD.getDecl())->getThisType(CGM.getContext());
2209 int64_t NonVirtualAdjustment2 = -(getNVOffset(BaseType, DerivedType)/8);
2210 if (NonVirtualAdjustment2 != NonVirtualAdjustment) {
2211 NonVirtualAdjustment = NonVirtualAdjustment2;
2212 }
2213
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002214 if (NonVirtualAdjustment) {
2215 ThunkAdjustment ThisAdjustment(NonVirtualAdjustment, 0);
2216
Eli Friedmanf2eda5e2009-12-06 22:33:51 +00002217 if (!isPure) {
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002218 ThisAdjustments[Index] = ThisAdjustment;
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002219 SavedAdjustments.push_back(
2220 std::make_pair(GD, std::make_pair(OGD, ThisAdjustment)));
Eli Friedmanf2eda5e2009-12-06 22:33:51 +00002221 }
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002222 }
2223 return true;
Anders Carlssonca1bf682009-12-03 01:54:02 +00002224 }
2225
2226 return false;
Anders Carlssond59885022009-11-27 22:21:51 +00002227}
2228
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002229void OldVtableBuilder::AppendMethodsToVtable() {
Eli Friedman6c08ce72009-12-05 01:05:03 +00002230 if (!BuildVtable) {
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002231 VtableComponents.insert(VtableComponents.end(), Methods.size(),
2232 (llvm::Constant *)0);
Eli Friedman6c08ce72009-12-05 01:05:03 +00002233 ThisAdjustments.clear();
2234 BaseReturnTypes.clear();
2235 Methods.clear();
2236 return;
2237 }
2238
Anders Carlsson472404f2009-12-04 16:19:30 +00002239 // Reserve room in the vtable for our new methods.
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002240 VtableComponents.reserve(VtableComponents.size() + Methods.size());
Anders Carlssonb07567c2009-12-04 03:07:26 +00002241
Anders Carlsson86809cd2009-12-04 02:43:50 +00002242 for (unsigned i = 0, e = Methods.size(); i != e; ++i) {
2243 GlobalDecl GD = Methods[i];
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00002244 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2245
2246 // Get the 'this' pointer adjustment.
Anders Carlsson86809cd2009-12-04 02:43:50 +00002247 ThunkAdjustment ThisAdjustment = ThisAdjustments.lookup(i);
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00002248
2249 // Construct the return type adjustment.
2250 ThunkAdjustment ReturnAdjustment;
2251
2252 QualType BaseReturnType = BaseReturnTypes.lookup(i);
2253 if (!BaseReturnType.isNull() && !MD->isPure()) {
2254 QualType DerivedType =
2255 MD->getType()->getAs<FunctionType>()->getResultType();
2256
2257 int64_t NonVirtualAdjustment =
2258 getNVOffset(BaseReturnType, DerivedType) / 8;
2259
2260 int64_t VirtualAdjustment =
2261 getVbaseOffset(BaseReturnType, DerivedType);
2262
2263 ReturnAdjustment = ThunkAdjustment(NonVirtualAdjustment,
2264 VirtualAdjustment);
2265 }
2266
Anders Carlsson50f14742009-12-04 03:06:03 +00002267 llvm::Constant *Method = 0;
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00002268 if (!ReturnAdjustment.isEmpty()) {
2269 // Build a covariant thunk.
2270 CovariantThunkAdjustment Adjustment(ThisAdjustment, ReturnAdjustment);
Eli Friedman8174f2c2009-12-06 22:01:30 +00002271 Method = wrap(CGM.GetAddrOfCovariantThunk(GD, Adjustment));
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00002272 } else if (!ThisAdjustment.isEmpty()) {
2273 // Build a "regular" thunk.
Eli Friedman8174f2c2009-12-06 22:01:30 +00002274 Method = wrap(CGM.GetAddrOfThunk(GD, ThisAdjustment));
Anders Carlssonddf42c82009-12-04 02:56:03 +00002275 } else if (MD->isPure()) {
2276 // We have a pure virtual method.
Anders Carlsson50f14742009-12-04 03:06:03 +00002277 Method = getPureVirtualFn();
2278 } else {
2279 // We have a good old regular method.
2280 Method = WrapAddrOf(GD);
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00002281 }
Anders Carlsson50f14742009-12-04 03:06:03 +00002282
2283 // Add the method to the vtable.
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002284 VtableComponents.push_back(Method);
Anders Carlsson86809cd2009-12-04 02:43:50 +00002285 }
2286
Anders Carlsson50f14742009-12-04 03:06:03 +00002287
Anders Carlsson86809cd2009-12-04 02:43:50 +00002288 ThisAdjustments.clear();
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00002289 BaseReturnTypes.clear();
Anders Carlsson86809cd2009-12-04 02:43:50 +00002290
Anders Carlsson495634e2009-12-04 02:39:04 +00002291 Methods.clear();
Anders Carlsson495634e2009-12-04 02:39:04 +00002292}
2293
Anders Carlssonf942ee02009-11-27 20:47:55 +00002294void CGVtableInfo::ComputeMethodVtableIndices(const CXXRecordDecl *RD) {
2295
2296 // Itanium C++ ABI 2.5.2:
Anders Carlsson259688c2010-02-02 03:37:46 +00002297 // The order of the virtual function pointers in a virtual table is the
2298 // order of declaration of the corresponding member functions in the class.
Anders Carlssonf942ee02009-11-27 20:47:55 +00002299 //
Anders Carlsson259688c2010-02-02 03:37:46 +00002300 // There is an entry for any virtual function declared in a class,
2301 // whether it is a new function or overrides a base class function,
2302 // unless it overrides a function from the primary base, and conversion
2303 // between their return types does not require an adjustment.
Anders Carlssonf942ee02009-11-27 20:47:55 +00002304
2305 int64_t CurrentIndex = 0;
2306
2307 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
2308 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
2309
2310 if (PrimaryBase) {
Anders Carlssonc920fa22009-11-30 19:43:26 +00002311 assert(PrimaryBase->isDefinition() &&
2312 "Should have the definition decl of the primary base!");
Anders Carlssonf942ee02009-11-27 20:47:55 +00002313
2314 // Since the record decl shares its vtable pointer with the primary base
2315 // we need to start counting at the end of the primary base's vtable.
2316 CurrentIndex = getNumVirtualFunctionPointers(PrimaryBase);
2317 }
Eli Friedman21517252009-12-15 03:31:17 +00002318
2319 // Collect all the primary bases, so we can check whether methods override
2320 // a method from the base.
Anders Carlsson65b49782010-02-12 05:25:12 +00002321 VtableBuilder::PrimaryBasesSetTy PrimaryBases;
Eli Friedman21517252009-12-15 03:31:17 +00002322 for (ASTRecordLayout::primary_base_info_iterator
2323 I = Layout.primary_base_begin(), E = Layout.primary_base_end();
2324 I != E; ++I)
2325 PrimaryBases.insert((*I).getBase());
2326
Anders Carlssonf942ee02009-11-27 20:47:55 +00002327 const CXXDestructorDecl *ImplicitVirtualDtor = 0;
2328
2329 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
2330 e = RD->method_end(); i != e; ++i) {
2331 const CXXMethodDecl *MD = *i;
2332
2333 // We only want virtual methods.
2334 if (!MD->isVirtual())
2335 continue;
2336
Anders Carlssonf942ee02009-11-27 20:47:55 +00002337 // Check if this method overrides a method in the primary base.
Anders Carlsson65b49782010-02-12 05:25:12 +00002338 if (const CXXMethodDecl *OverriddenMD =
2339 OverridesMethodInPrimaryBase(MD, PrimaryBases)) {
2340 // Check if converting from the return type of the method to the
2341 // return type of the overridden method requires conversion.
Anders Carlssoncce9ee82010-02-13 23:17:31 +00002342 if (ComputeReturnAdjustmentBaseOffset(CGM.getContext(), MD,
2343 OverriddenMD).isEmpty()) {
Anders Carlsson65b49782010-02-12 05:25:12 +00002344 // This index is shared between the index in the vtable of the primary
2345 // base class.
2346 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2347 const CXXDestructorDecl *OverriddenDD =
2348 cast<CXXDestructorDecl>(OverriddenMD);
Anders Carlssonf942ee02009-11-27 20:47:55 +00002349
Anders Carlsson65b49782010-02-12 05:25:12 +00002350 // Add both the complete and deleting entries.
2351 MethodVtableIndices[GlobalDecl(DD, Dtor_Complete)] =
2352 getMethodVtableIndex(GlobalDecl(OverriddenDD, Dtor_Complete));
2353 MethodVtableIndices[GlobalDecl(DD, Dtor_Deleting)] =
2354 getMethodVtableIndex(GlobalDecl(OverriddenDD, Dtor_Deleting));
2355 } else {
2356 MethodVtableIndices[MD] = getMethodVtableIndex(OverriddenMD);
2357 }
2358
2359 // We don't need to add an entry for this method.
Anders Carlsson07604812010-02-12 18:14:46 +00002360 continue;
Anders Carlssonf942ee02009-11-27 20:47:55 +00002361 }
2362 }
2363
Anders Carlssonf942ee02009-11-27 20:47:55 +00002364 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2365 if (MD->isImplicit()) {
2366 assert(!ImplicitVirtualDtor &&
2367 "Did already see an implicit virtual dtor!");
2368 ImplicitVirtualDtor = DD;
2369 continue;
2370 }
2371
2372 // Add the complete dtor.
2373 MethodVtableIndices[GlobalDecl(DD, Dtor_Complete)] = CurrentIndex++;
2374
2375 // Add the deleting dtor.
2376 MethodVtableIndices[GlobalDecl(DD, Dtor_Deleting)] = CurrentIndex++;
2377 } else {
2378 // Add the entry.
2379 MethodVtableIndices[MD] = CurrentIndex++;
2380 }
2381 }
2382
2383 if (ImplicitVirtualDtor) {
2384 // Itanium C++ ABI 2.5.2:
Anders Carlssondc2dba32010-02-16 04:49:44 +00002385 // If a class has an implicitly-defined virtual destructor,
2386 // its entries come after the declared virtual function pointers.
Anders Carlssonf942ee02009-11-27 20:47:55 +00002387
2388 // Add the complete dtor.
2389 MethodVtableIndices[GlobalDecl(ImplicitVirtualDtor, Dtor_Complete)] =
2390 CurrentIndex++;
2391
2392 // Add the deleting dtor.
2393 MethodVtableIndices[GlobalDecl(ImplicitVirtualDtor, Dtor_Deleting)] =
2394 CurrentIndex++;
2395 }
2396
2397 NumVirtualFunctionPointers[RD] = CurrentIndex;
2398}
2399
2400uint64_t CGVtableInfo::getNumVirtualFunctionPointers(const CXXRecordDecl *RD) {
2401 llvm::DenseMap<const CXXRecordDecl *, uint64_t>::iterator I =
2402 NumVirtualFunctionPointers.find(RD);
2403 if (I != NumVirtualFunctionPointers.end())
2404 return I->second;
2405
2406 ComputeMethodVtableIndices(RD);
2407
2408 I = NumVirtualFunctionPointers.find(RD);
2409 assert(I != NumVirtualFunctionPointers.end() && "Did not find entry!");
2410 return I->second;
2411}
2412
2413uint64_t CGVtableInfo::getMethodVtableIndex(GlobalDecl GD) {
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002414 MethodVtableIndicesTy::iterator I = MethodVtableIndices.find(GD);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002415 if (I != MethodVtableIndices.end())
2416 return I->second;
2417
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002418 const CXXRecordDecl *RD = cast<CXXMethodDecl>(GD.getDecl())->getParent();
Anders Carlssonf942ee02009-11-27 20:47:55 +00002419
2420 ComputeMethodVtableIndices(RD);
2421
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002422 I = MethodVtableIndices.find(GD);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002423 assert(I != MethodVtableIndices.end() && "Did not find index!");
2424 return I->second;
2425}
2426
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002427CGVtableInfo::AdjustmentVectorTy*
2428CGVtableInfo::getAdjustments(GlobalDecl GD) {
2429 SavedAdjustmentsTy::iterator I = SavedAdjustments.find(GD);
2430 if (I != SavedAdjustments.end())
2431 return &I->second;
Eli Friedman8174f2c2009-12-06 22:01:30 +00002432
2433 const CXXRecordDecl *RD = cast<CXXRecordDecl>(GD.getDecl()->getDeclContext());
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002434 if (!SavedAdjustmentRecords.insert(RD).second)
2435 return 0;
Eli Friedman8174f2c2009-12-06 22:01:30 +00002436
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002437 AddressPointsMapTy AddressPoints;
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002438 OldVtableBuilder b(RD, RD, 0, CGM, false, AddressPoints);
Eli Friedman8174f2c2009-12-06 22:01:30 +00002439 D1(printf("vtable %s\n", RD->getNameAsCString()));
2440 b.GenerateVtableForBase(RD);
2441 b.GenerateVtableForVBases(RD);
Eli Friedman8174f2c2009-12-06 22:01:30 +00002442
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002443 for (OldVtableBuilder::SavedAdjustmentsVectorTy::iterator
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002444 i = b.getSavedAdjustments().begin(),
2445 e = b.getSavedAdjustments().end(); i != e; i++)
2446 SavedAdjustments[i->first].push_back(i->second);
Eli Friedman8174f2c2009-12-06 22:01:30 +00002447
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002448 I = SavedAdjustments.find(GD);
2449 if (I != SavedAdjustments.end())
2450 return &I->second;
2451
2452 return 0;
Eli Friedman8174f2c2009-12-06 22:01:30 +00002453}
2454
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002455int64_t CGVtableInfo::getVirtualBaseOffsetIndex(const CXXRecordDecl *RD,
2456 const CXXRecordDecl *VBase) {
2457 ClassPairTy ClassPair(RD, VBase);
2458
2459 VirtualBaseClassIndiciesTy::iterator I =
2460 VirtualBaseClassIndicies.find(ClassPair);
2461 if (I != VirtualBaseClassIndicies.end())
2462 return I->second;
2463
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002464 // FIXME: This seems expensive. Can we do a partial job to get
2465 // just this data.
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002466 AddressPointsMapTy AddressPoints;
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002467 OldVtableBuilder b(RD, RD, 0, CGM, false, AddressPoints);
Mike Stump75ce5732009-10-31 20:06:59 +00002468 D1(printf("vtable %s\n", RD->getNameAsCString()));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002469 b.GenerateVtableForBase(RD);
2470 b.GenerateVtableForVBases(RD);
2471
2472 for (llvm::DenseMap<const CXXRecordDecl *, uint64_t>::iterator I =
2473 b.getVBIndex().begin(), E = b.getVBIndex().end(); I != E; ++I) {
2474 // Insert all types.
2475 ClassPairTy ClassPair(RD, I->first);
2476
2477 VirtualBaseClassIndicies.insert(std::make_pair(ClassPair, I->second));
2478 }
2479
2480 I = VirtualBaseClassIndicies.find(ClassPair);
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00002481 // FIXME: The assertion below assertion currently fails with the old vtable
2482 /// layout code if there is a non-virtual thunk adjustment in a vtable.
2483 // Once the new layout is in place, this return should be removed.
2484 if (I == VirtualBaseClassIndicies.end())
2485 return 0;
2486
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002487 assert(I != VirtualBaseClassIndicies.end() && "Did not find index!");
2488
2489 return I->second;
2490}
2491
Anders Carlssonc8e39ec2009-12-05 21:03:56 +00002492uint64_t CGVtableInfo::getVtableAddressPoint(const CXXRecordDecl *RD) {
2493 uint64_t AddressPoint =
Anders Carlsson93a18842010-01-02 18:02:32 +00002494 (*(*(CGM.getVtableInfo().AddressPoints[RD]))[RD])[std::make_pair(RD, 0)];
Anders Carlssonc8e39ec2009-12-05 21:03:56 +00002495
2496 return AddressPoint;
2497}
2498
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00002499llvm::GlobalVariable *
Anders Carlsson0911ae82009-12-06 00:23:49 +00002500CGVtableInfo::GenerateVtable(llvm::GlobalVariable::LinkageTypes Linkage,
Anders Carlsson232324c2009-12-06 00:53:22 +00002501 bool GenerateDefinition,
Anders Carlsson0911ae82009-12-06 00:23:49 +00002502 const CXXRecordDecl *LayoutClass,
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002503 const CXXRecordDecl *RD, uint64_t Offset,
2504 AddressPointsMapTy& AddressPoints) {
Anders Carlsson1888b442010-02-14 00:22:59 +00002505 if (GenerateDefinition && CGM.getLangOptions().DumpVtableLayouts &&
2506 LayoutClass == RD) {
Anders Carlssoncf5a8822010-02-13 21:07:32 +00002507 VtableBuilder Builder(*this, RD);
Anders Carlssoneee53d92010-02-13 02:02:03 +00002508
2509 Builder.dumpLayout(llvm::errs());
2510 }
2511
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002512 llvm::SmallString<256> OutName;
Mike Stump2cefe382009-11-12 20:47:57 +00002513 if (LayoutClass != RD)
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00002514 CGM.getMangleContext().mangleCXXCtorVtable(LayoutClass, Offset / 8,
2515 RD, OutName);
Mike Stumpeac45592009-11-11 20:26:26 +00002516 else
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00002517 CGM.getMangleContext().mangleCXXVtable(RD, OutName);
Daniel Dunbare128dd12009-11-21 09:06:22 +00002518 llvm::StringRef Name = OutName.str();
Benjamin Kramerbb0a07b2009-10-11 22:57:54 +00002519
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00002520 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name);
Anders Carlsson93a18842010-01-02 18:02:32 +00002521 if (GV == 0 || CGM.getVtableInfo().AddressPoints[LayoutClass] == 0 ||
2522 GV->isDeclaration()) {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002523 OldVtableBuilder b(RD, LayoutClass, Offset, CGM, GenerateDefinition,
2524 AddressPoints);
Eli Friedman6c08ce72009-12-05 01:05:03 +00002525
2526 D1(printf("vtable %s\n", RD->getNameAsCString()));
2527 // First comes the vtables for all the non-virtual bases...
Mike Stumpd538a6d2009-12-24 07:29:41 +00002528 b.GenerateVtableForBase(RD, Offset);
Eli Friedman6c08ce72009-12-05 01:05:03 +00002529
2530 // then the vtables for all the virtual bases.
2531 b.GenerateVtableForVBases(RD, Offset);
2532
Anders Carlsson58b271d2009-12-05 22:19:10 +00002533 llvm::Constant *Init = 0;
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00002534 const llvm::Type *Int8PtrTy = llvm::Type::getInt8PtrTy(CGM.getLLVMContext());
Anders Carlsson58b271d2009-12-05 22:19:10 +00002535 llvm::ArrayType *ArrayType =
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002536 llvm::ArrayType::get(Int8PtrTy, b.getVtableComponents().size());
Anders Carlssona95d4c52009-12-05 21:09:05 +00002537
Anders Carlsson232324c2009-12-06 00:53:22 +00002538 if (GenerateDefinition)
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002539 Init = llvm::ConstantArray::get(ArrayType, &b.getVtableComponents()[0],
2540 b.getVtableComponents().size());
Anders Carlsson232324c2009-12-06 00:53:22 +00002541
Mike Stumpaa51ad62009-11-19 04:04:36 +00002542 llvm::GlobalVariable *OGV = GV;
Anders Carlsson232324c2009-12-06 00:53:22 +00002543
2544 GV = new llvm::GlobalVariable(CGM.getModule(), ArrayType,
2545 /*isConstant=*/true, Linkage, Init, Name);
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002546 CGM.setGlobalVisibility(GV, RD);
2547
Mike Stumpaa51ad62009-11-19 04:04:36 +00002548 if (OGV) {
2549 GV->takeName(OGV);
Anders Carlsson58b271d2009-12-05 22:19:10 +00002550 llvm::Constant *NewPtr =
2551 llvm::ConstantExpr::getBitCast(GV, OGV->getType());
Mike Stumpaa51ad62009-11-19 04:04:36 +00002552 OGV->replaceAllUsesWith(NewPtr);
2553 OGV->eraseFromParent();
2554 }
Mike Stumpaa51ad62009-11-19 04:04:36 +00002555 }
Anders Carlssonb3f54b72009-12-05 21:28:12 +00002556
2557 return GV;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002558}
Mike Stump9f23a142009-11-10 02:30:51 +00002559
Anders Carlsson232324c2009-12-06 00:53:22 +00002560void CGVtableInfo::GenerateClassData(llvm::GlobalVariable::LinkageTypes Linkage,
2561 const CXXRecordDecl *RD) {
Anders Carlssone1b3e622009-12-07 07:59:52 +00002562 llvm::GlobalVariable *&Vtable = Vtables[RD];
2563 if (Vtable) {
2564 assert(Vtable->getInitializer() && "Vtable doesn't have a definition!");
2565 return;
2566 }
2567
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002568 AddressPointsMapTy AddressPoints;
2569 Vtable = GenerateVtable(Linkage, /*GenerateDefinition=*/true, RD, RD, 0,
2570 AddressPoints);
Anders Carlssone36a6b32010-01-02 01:01:18 +00002571 GenerateVTT(Linkage, /*GenerateDefinition=*/true, RD);
Mike Stump1a139f82009-11-19 01:08:19 +00002572}
2573
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00002574llvm::GlobalVariable *CGVtableInfo::getVtable(const CXXRecordDecl *RD) {
Anders Carlsson232324c2009-12-06 00:53:22 +00002575 llvm::GlobalVariable *Vtable = Vtables.lookup(RD);
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00002576
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002577 if (!Vtable) {
2578 AddressPointsMapTy AddressPoints;
Anders Carlsson232324c2009-12-06 00:53:22 +00002579 Vtable = GenerateVtable(llvm::GlobalValue::ExternalLinkage,
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002580 /*GenerateDefinition=*/false, RD, RD, 0,
2581 AddressPoints);
2582 }
Mike Stumpaa51ad62009-11-19 04:04:36 +00002583
Anders Carlsson4ed44eb2009-12-05 22:42:54 +00002584 return Vtable;
Mike Stumpd846d082009-11-10 07:44:33 +00002585}
Mike Stumpeac45592009-11-11 20:26:26 +00002586
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002587void CGVtableInfo::MaybeEmitVtable(GlobalDecl GD) {
2588 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2589 const CXXRecordDecl *RD = MD->getParent();
2590
Anders Carlsson4ed44eb2009-12-05 22:42:54 +00002591 // If the class doesn't have a vtable we don't need to emit one.
2592 if (!RD->isDynamicClass())
2593 return;
2594
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002595 // Get the key function.
Anders Carlsson5ebf8b42009-12-07 04:35:11 +00002596 const CXXMethodDecl *KeyFunction = CGM.getContext().getKeyFunction(RD);
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002597
Anders Carlsson4ed44eb2009-12-05 22:42:54 +00002598 if (KeyFunction) {
2599 // We don't have the right key function.
2600 if (KeyFunction->getCanonicalDecl() != MD->getCanonicalDecl())
2601 return;
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002602 }
2603
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002604 // Emit the data.
Douglas Gregorccecc1b2010-01-06 20:27:16 +00002605 GenerateClassData(CGM.getVtableLinkage(RD), RD);
Eli Friedman8174f2c2009-12-06 22:01:30 +00002606
2607 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
2608 e = RD->method_end(); i != e; ++i) {
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002609 if ((*i)->isVirtual() && ((*i)->hasInlineBody() || (*i)->isImplicit())) {
Eli Friedman8174f2c2009-12-06 22:01:30 +00002610 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(*i)) {
2611 CGM.BuildThunksForVirtual(GlobalDecl(DD, Dtor_Complete));
2612 CGM.BuildThunksForVirtual(GlobalDecl(DD, Dtor_Deleting));
2613 } else {
2614 CGM.BuildThunksForVirtual(GlobalDecl(*i));
2615 }
2616 }
2617 }
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002618}
2619