blob: 1bf071c85d5673846e5306bd91408cba1aeb3b78 [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"
Anders Carlssond46ed892010-02-27 16:18:19 +000019#include "llvm/ADT/SetVector.h"
Chandler Carruth94eab4a2010-02-13 10:38:52 +000020#include "llvm/Support/Compiler.h"
Anders Carlsson5d40c6f2010-02-11 08:02:13 +000021#include "llvm/Support/Format.h"
Zhongxing Xu1721ef72009-11-13 05:46:16 +000022#include <cstdio>
Anders Carlsson2bb27f52009-10-11 22:13:54 +000023
24using namespace clang;
25using namespace CodeGen;
26
Anders Carlssond59885022009-11-27 22:21:51 +000027namespace {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +000028
Anders Carlsson075056a2010-02-23 01:34:28 +000029/// BaseOffset - Represents an offset from a derived class to a direct or
30/// indirect base class.
31struct BaseOffset {
32 /// DerivedClass - The derived class.
33 const CXXRecordDecl *DerivedClass;
34
35 /// VirtualBase - If the path from the derived class to the base class
36 /// involves a virtual base class, this holds its declaration.
37 const CXXRecordDecl *VirtualBase;
38
39 /// NonVirtualOffset - The offset from the derived class to the base class.
40 /// (Or the offset from the virtual base class to the base class, if the
41 /// path from the derived class to the base class involves a virtual base
42 /// class.
43 int64_t NonVirtualOffset;
44
45 BaseOffset() : DerivedClass(0), VirtualBase(0), NonVirtualOffset(0) { }
46 BaseOffset(const CXXRecordDecl *DerivedClass,
47 const CXXRecordDecl *VirtualBase, int64_t NonVirtualOffset)
48 : DerivedClass(DerivedClass), VirtualBase(VirtualBase),
49 NonVirtualOffset(NonVirtualOffset) { }
50
51 bool isEmpty() const { return !NonVirtualOffset && !VirtualBase; }
52};
53
Anders Carlssone8ac42a2010-02-11 21:24:32 +000054/// FinalOverriders - Contains the final overrider member functions for all
55/// member functions in the base subobjects of a class.
56class FinalOverriders {
Anders Carlsson136bd192010-02-12 16:55:34 +000057public:
58 /// OverriderInfo - Information about a final overrider.
59 struct OverriderInfo {
60 /// Method - The method decl of the overrider.
61 const CXXMethodDecl *Method;
Anders Carlsson5a7654a2010-02-18 16:29:24 +000062
63 /// BaseOffset - the base offset of the overrider.
64 uint64_t BaseOffset;
Anders Carlsson136bd192010-02-12 16:55:34 +000065
Anders Carlsson5a7654a2010-02-18 16:29:24 +000066 OverriderInfo() : Method(0), BaseOffset(0) { }
Anders Carlsson136bd192010-02-12 16:55:34 +000067 };
68
69private:
Anders Carlssone8ac42a2010-02-11 21:24:32 +000070 /// MostDerivedClass - The most derived class for which the final overriders
71 /// are stored.
72 const CXXRecordDecl *MostDerivedClass;
73
74 ASTContext &Context;
75
76 /// MostDerivedClassLayout - the AST record layout of the most derived class.
77 const ASTRecordLayout &MostDerivedClassLayout;
78
Anders Carlssoneee53d92010-02-13 02:02:03 +000079 /// BaseSubobjectMethodPairTy - Uniquely identifies a member function
80 /// in a base subobject.
81 typedef std::pair<BaseSubobject, const CXXMethodDecl *>
82 BaseSubobjectMethodPairTy;
83
84 typedef llvm::DenseMap<BaseSubobjectMethodPairTy,
Anders Carlsson136bd192010-02-12 16:55:34 +000085 OverriderInfo> OverridersMapTy;
Anders Carlssone8ac42a2010-02-11 21:24:32 +000086
87 /// OverridersMap - The final overriders for all virtual member functions of
88 /// all the base subobjects of the most derived class.
89 OverridersMapTy OverridersMap;
90
Anders Carlsson6a7e6a42010-02-14 00:37:35 +000091 /// VisitedVirtualBases - A set of all the visited virtual bases, used to
92 /// avoid visiting virtual bases more than once.
93 llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBases;
94
Anders Carlssoneee53d92010-02-13 02:02:03 +000095 typedef llvm::DenseMap<BaseSubobjectMethodPairTy, BaseOffset>
96 AdjustmentOffsetsMapTy;
97
98 /// ReturnAdjustments - Holds return adjustments for all the overriders that
99 /// need to perform return value adjustments.
100 AdjustmentOffsetsMapTy ReturnAdjustments;
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000101
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000102 typedef llvm::SmallVector<uint64_t, 1> OffsetVectorTy;
103
104 /// SubobjectOffsetsMapTy - This map is used for keeping track of all the
105 /// base subobject offsets that a single class declaration might refer to.
106 ///
107 /// For example, in:
108 ///
109 /// struct A { virtual void f(); };
110 /// struct B1 : A { };
111 /// struct B2 : A { };
112 /// struct C : B1, B2 { virtual void f(); };
113 ///
114 /// when we determine that C::f() overrides A::f(), we need to update the
115 /// overriders map for both A-in-B1 and A-in-B2 and the subobject offsets map
116 /// will have the subobject offsets for both A copies.
117 typedef llvm::DenseMap<const CXXRecordDecl *, OffsetVectorTy>
118 SubobjectOffsetsMapTy;
119
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000120 /// ComputeFinalOverriders - Compute the final overriders for a given base
121 /// subobject (and all its direct and indirect bases).
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000122 void ComputeFinalOverriders(BaseSubobject Base,
Anders Carlsson231461f2010-02-17 17:48:25 +0000123 bool BaseSubobjectIsVisitedVBase,
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000124 SubobjectOffsetsMapTy &Offsets);
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000125
126 /// AddOverriders - Add the final overriders for this base subobject to the
127 /// map of final overriders.
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000128 void AddOverriders(BaseSubobject Base, SubobjectOffsetsMapTy &Offsets);
129
130 /// PropagateOverrider - Propagate the NewMD overrider to all the functions
131 /// that OldMD overrides. For example, if we have:
132 ///
133 /// struct A { virtual void f(); };
134 /// struct B : A { virtual void f(); };
135 /// struct C : B { virtual void f(); };
136 ///
137 /// and we want to override B::f with C::f, we also need to override A::f with
138 /// C::f.
139 void PropagateOverrider(const CXXMethodDecl *OldMD,
Anders Carlssona678aa12010-02-13 22:23:31 +0000140 BaseSubobject NewBase,
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000141 const CXXMethodDecl *NewMD,
142 SubobjectOffsetsMapTy &Offsets);
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000143
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000144 static void MergeSubobjectOffsets(const SubobjectOffsetsMapTy &NewOffsets,
145 SubobjectOffsetsMapTy &Offsets);
146
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000147public:
148 explicit FinalOverriders(const CXXRecordDecl *MostDerivedClass);
Anders Carlsson8025e7b2010-02-24 22:18:01 +0000149
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000150 /// getOverrider - Get the final overrider for the given method declaration in
151 /// the given base subobject.
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000152 OverriderInfo getOverrider(BaseSubobject Base,
153 const CXXMethodDecl *MD) const {
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000154 assert(OverridersMap.count(std::make_pair(Base, MD)) &&
155 "Did not find overrider!");
156
157 return OverridersMap.lookup(std::make_pair(Base, MD));
158 }
159
Anders Carlssond3adb0c2010-02-13 23:40:17 +0000160 /// getReturnAdjustmentOffset - Get the return adjustment offset for the
161 /// method decl in the given base subobject. Returns an empty base offset if
162 /// no adjustment is needed.
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +0000163 BaseOffset getReturnAdjustmentOffset(BaseSubobject Base,
164 const CXXMethodDecl *MD) const {
165 return ReturnAdjustments.lookup(std::make_pair(Base, MD));
166 }
167
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000168 /// dump - dump the final overriders.
Anders Carlsson6a7e6a42010-02-14 00:37:35 +0000169 void dump() {
170 assert(VisitedVirtualBases.empty() &&
171 "Visited virtual bases aren't empty!");
172 dump(llvm::errs(), BaseSubobject(MostDerivedClass, 0));
173 VisitedVirtualBases.clear();
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000174 }
175
176 /// dump - dump the final overriders for a base subobject, and all its direct
177 /// and indirect base subobjects.
Anders Carlsson6a7e6a42010-02-14 00:37:35 +0000178 void dump(llvm::raw_ostream &Out, BaseSubobject Base);
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000179};
Anders Carlssoneee53d92010-02-13 02:02:03 +0000180
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000181FinalOverriders::FinalOverriders(const CXXRecordDecl *MostDerivedClass)
182 : MostDerivedClass(MostDerivedClass),
183 Context(MostDerivedClass->getASTContext()),
184 MostDerivedClassLayout(Context.getASTRecordLayout(MostDerivedClass)) {
185
186 // Compute the final overriders.
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000187 SubobjectOffsetsMapTy Offsets;
Anders Carlsson231461f2010-02-17 17:48:25 +0000188 ComputeFinalOverriders(BaseSubobject(MostDerivedClass, 0),
189 /*BaseSubobjectIsVisitedVBase=*/false, Offsets);
190 VisitedVirtualBases.clear();
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000191
192 // And dump them (for now).
193 dump();
Anders Carlsson3f9917d2010-02-13 21:33:22 +0000194
195 // Also dump the base offsets (for now).
196 for (SubobjectOffsetsMapTy::const_iterator I = Offsets.begin(),
197 E = Offsets.end(); I != E; ++I) {
198 const OffsetVectorTy& OffsetVector = I->second;
199
200 llvm::errs() << "Base offsets for ";
201 llvm::errs() << I->first->getQualifiedNameAsString() << '\n';
202
203 for (unsigned I = 0, E = OffsetVector.size(); I != E; ++I)
204 llvm::errs() << " " << I << " - " << OffsetVector[I] << '\n';
205 }
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000206}
207
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000208void FinalOverriders::AddOverriders(BaseSubobject Base,
209 SubobjectOffsetsMapTy &Offsets) {
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000210 const CXXRecordDecl *RD = Base.getBase();
211
212 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
213 E = RD->method_end(); I != E; ++I) {
214 const CXXMethodDecl *MD = *I;
215
216 if (!MD->isVirtual())
217 continue;
218
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000219 // First, propagate the overrider.
Anders Carlssona678aa12010-02-13 22:23:31 +0000220 PropagateOverrider(MD, Base, MD, Offsets);
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000221
222 // Add the overrider as the final overrider of itself.
Anders Carlsson136bd192010-02-12 16:55:34 +0000223 OverriderInfo& Overrider = OverridersMap[std::make_pair(Base, MD)];
224 assert(!Overrider.Method && "Overrider should not exist yet!");
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000225
Anders Carlsson5a7654a2010-02-18 16:29:24 +0000226 Overrider.BaseOffset = Base.getBaseOffset();
Anders Carlsson136bd192010-02-12 16:55:34 +0000227 Overrider.Method = MD;
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000228 }
229}
230
Anders Carlsson075056a2010-02-23 01:34:28 +0000231static BaseOffset ComputeBaseOffset(ASTContext &Context,
232 const CXXRecordDecl *DerivedRD,
233 const CXXBasePath &Path) {
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000234 int64_t NonVirtualOffset = 0;
Anders Carlssoneee53d92010-02-13 02:02:03 +0000235
Anders Carlssonf3f67842010-02-13 20:41:15 +0000236 unsigned NonVirtualStart = 0;
237 const CXXRecordDecl *VirtualBase = 0;
238
239 // First, look for the virtual base class.
240 for (unsigned I = 0, E = Path.size(); I != E; ++I) {
241 const CXXBasePathElement &Element = Path[I];
242
243 if (Element.Base->isVirtual()) {
244 // FIXME: Can we break when we find the first virtual base?
245 // (If we can't, can't we just iterate over the path in reverse order?)
246 NonVirtualStart = I + 1;
247 QualType VBaseType = Element.Base->getType();
248 VirtualBase =
249 cast<CXXRecordDecl>(VBaseType->getAs<RecordType>()->getDecl());
250 }
251 }
252
253 // Now compute the non-virtual offset.
254 for (unsigned I = NonVirtualStart, E = Path.size(); I != E; ++I) {
255 const CXXBasePathElement &Element = Path[I];
Anders Carlssoneee53d92010-02-13 02:02:03 +0000256
257 // Check the base class offset.
258 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Element.Class);
Anders Carlssoned7d0e82010-02-25 22:18:35 +0000259
Anders Carlssoneee53d92010-02-13 02:02:03 +0000260 const RecordType *BaseType = Element.Base->getType()->getAs<RecordType>();
261 const CXXRecordDecl *Base = cast<CXXRecordDecl>(BaseType->getDecl());
Anders Carlssoned7d0e82010-02-25 22:18:35 +0000262
Anders Carlssoneee53d92010-02-13 02:02:03 +0000263 NonVirtualOffset += Layout.getBaseClassOffset(Base);
264 }
265
266 // FIXME: This should probably use CharUnits or something. Maybe we should
267 // even change the base offsets in ASTRecordLayout to be specified in
268 // CharUnits.
Anders Carlsson075056a2010-02-23 01:34:28 +0000269 return BaseOffset(DerivedRD, VirtualBase, NonVirtualOffset / 8);
Anders Carlsson258a1e32010-02-14 00:16:19 +0000270
271}
272
Anders Carlsson075056a2010-02-23 01:34:28 +0000273static BaseOffset ComputeBaseOffset(ASTContext &Context,
274 const CXXRecordDecl *BaseRD,
275 const CXXRecordDecl *DerivedRD) {
Anders Carlsson258a1e32010-02-14 00:16:19 +0000276 CXXBasePaths Paths(/*FindAmbiguities=*/false,
277 /*RecordPaths=*/true, /*DetectVirtual=*/false);
278
279 if (!const_cast<CXXRecordDecl *>(DerivedRD)->
280 isDerivedFrom(const_cast<CXXRecordDecl *>(BaseRD), Paths)) {
281 assert(false && "Class must be derived from the passed in base class!");
Anders Carlsson075056a2010-02-23 01:34:28 +0000282 return BaseOffset();
Anders Carlsson258a1e32010-02-14 00:16:19 +0000283 }
284
285 return ComputeBaseOffset(Context, DerivedRD, Paths.front());
Anders Carlssoneee53d92010-02-13 02:02:03 +0000286}
287
Anders Carlsson075056a2010-02-23 01:34:28 +0000288static BaseOffset
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000289ComputeReturnAdjustmentBaseOffset(ASTContext &Context,
290 const CXXMethodDecl *DerivedMD,
291 const CXXMethodDecl *BaseMD) {
Anders Carlssoneee53d92010-02-13 02:02:03 +0000292 const FunctionType *BaseFT = BaseMD->getType()->getAs<FunctionType>();
293 const FunctionType *DerivedFT = DerivedMD->getType()->getAs<FunctionType>();
294
295 // Canonicalize the return types.
296 CanQualType CanDerivedReturnType =
297 Context.getCanonicalType(DerivedFT->getResultType());
298 CanQualType CanBaseReturnType =
299 Context.getCanonicalType(BaseFT->getResultType());
300
301 assert(CanDerivedReturnType->getTypeClass() ==
302 CanBaseReturnType->getTypeClass() &&
303 "Types must have same type class!");
304
305 if (CanDerivedReturnType == CanBaseReturnType) {
306 // No adjustment needed.
Anders Carlsson075056a2010-02-23 01:34:28 +0000307 return BaseOffset();
Anders Carlssoneee53d92010-02-13 02:02:03 +0000308 }
309
310 if (isa<ReferenceType>(CanDerivedReturnType)) {
311 CanDerivedReturnType =
312 CanDerivedReturnType->getAs<ReferenceType>()->getPointeeType();
313 CanBaseReturnType =
314 CanBaseReturnType->getAs<ReferenceType>()->getPointeeType();
315 } else if (isa<PointerType>(CanDerivedReturnType)) {
316 CanDerivedReturnType =
317 CanDerivedReturnType->getAs<PointerType>()->getPointeeType();
318 CanBaseReturnType =
319 CanBaseReturnType->getAs<PointerType>()->getPointeeType();
320 } else {
321 assert(false && "Unexpected return type!");
322 }
323
324 // We need to compare unqualified types here; consider
325 // const T *Base::foo();
326 // T *Derived::foo();
327 if (CanDerivedReturnType.getUnqualifiedType() ==
328 CanBaseReturnType.getUnqualifiedType()) {
329 // No adjustment needed.
Anders Carlsson075056a2010-02-23 01:34:28 +0000330 return BaseOffset();
Anders Carlssoneee53d92010-02-13 02:02:03 +0000331 }
332
333 const CXXRecordDecl *DerivedRD =
334 cast<CXXRecordDecl>(cast<RecordType>(CanDerivedReturnType)->getDecl());
335
336 const CXXRecordDecl *BaseRD =
337 cast<CXXRecordDecl>(cast<RecordType>(CanBaseReturnType)->getDecl());
338
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000339 return ComputeBaseOffset(Context, BaseRD, DerivedRD);
Anders Carlssoneee53d92010-02-13 02:02:03 +0000340}
341
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000342void FinalOverriders::PropagateOverrider(const CXXMethodDecl *OldMD,
Anders Carlssona678aa12010-02-13 22:23:31 +0000343 BaseSubobject NewBase,
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000344 const CXXMethodDecl *NewMD,
345 SubobjectOffsetsMapTy &Offsets) {
346 for (CXXMethodDecl::method_iterator I = OldMD->begin_overridden_methods(),
347 E = OldMD->end_overridden_methods(); I != E; ++I) {
348 const CXXMethodDecl *OverriddenMD = *I;
349 const CXXRecordDecl *OverriddenRD = OverriddenMD->getParent();
350
351 // We want to override OverriddenMD in all subobjects, for example:
352 //
353 /// struct A { virtual void f(); };
354 /// struct B1 : A { };
355 /// struct B2 : A { };
356 /// struct C : B1, B2 { virtual void f(); };
357 ///
358 /// When overriding A::f with C::f we need to do so in both A subobjects.
359 const OffsetVectorTy &OffsetVector = Offsets[OverriddenRD];
360
361 // Go through all the subobjects.
362 for (unsigned I = 0, E = OffsetVector.size(); I != E; ++I) {
363 uint64_t Offset = OffsetVector[I];
364
Anders Carlsson258a1e32010-02-14 00:16:19 +0000365 BaseSubobject OverriddenSubobject = BaseSubobject(OverriddenRD, Offset);
Anders Carlssoneee53d92010-02-13 02:02:03 +0000366 BaseSubobjectMethodPairTy SubobjectAndMethod =
Anders Carlsson258a1e32010-02-14 00:16:19 +0000367 std::make_pair(OverriddenSubobject, OverriddenMD);
Anders Carlssoneee53d92010-02-13 02:02:03 +0000368
369 OverriderInfo &Overrider = OverridersMap[SubobjectAndMethod];
370
Anders Carlsson136bd192010-02-12 16:55:34 +0000371 assert(Overrider.Method && "Did not find existing overrider!");
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000372
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000373 // Check if we need return adjustments or base adjustments.
Anders Carlssonc1290ad2010-02-13 21:16:54 +0000374 // (We don't want to do this for pure virtual member functions).
375 if (!NewMD->isPure()) {
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000376 // Get the return adjustment base offset.
Anders Carlssonc1290ad2010-02-13 21:16:54 +0000377 BaseOffset ReturnBaseOffset =
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000378 ComputeReturnAdjustmentBaseOffset(Context, NewMD, OverriddenMD);
379
Anders Carlssonc1290ad2010-02-13 21:16:54 +0000380 if (!ReturnBaseOffset.isEmpty()) {
381 // Store the return adjustment base offset.
382 ReturnAdjustments[SubobjectAndMethod] = ReturnBaseOffset;
383 }
Anders Carlsson8e661e12010-02-12 17:13:23 +0000384 }
385
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000386 // Set the new overrider.
Anders Carlsson5a7654a2010-02-18 16:29:24 +0000387 Overrider.BaseOffset = NewBase.getBaseOffset();
Anders Carlsson136bd192010-02-12 16:55:34 +0000388 Overrider.Method = NewMD;
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000389
390 // And propagate it further.
Anders Carlssona678aa12010-02-13 22:23:31 +0000391 PropagateOverrider(OverriddenMD, NewBase, NewMD, Offsets);
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000392 }
393 }
394}
395
396void
397FinalOverriders::MergeSubobjectOffsets(const SubobjectOffsetsMapTy &NewOffsets,
398 SubobjectOffsetsMapTy &Offsets) {
399 // Iterate over the new offsets.
400 for (SubobjectOffsetsMapTy::const_iterator I = NewOffsets.begin(),
401 E = NewOffsets.end(); I != E; ++I) {
402 const CXXRecordDecl *NewRD = I->first;
Anders Carlsson3f9917d2010-02-13 21:33:22 +0000403 const OffsetVectorTy& NewOffsetVector = I->second;
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000404
Anders Carlsson3f9917d2010-02-13 21:33:22 +0000405 OffsetVectorTy &OffsetVector = Offsets[NewRD];
406 if (OffsetVector.empty()) {
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000407 // There were no previous offsets in this vector, just insert all entries
Anders Carlsson3f9917d2010-02-13 21:33:22 +0000408 // from the new offset vector.
409 OffsetVector.append(NewOffsetVector.begin(), NewOffsetVector.end());
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000410 continue;
411 }
412
Anders Carlsson3f9917d2010-02-13 21:33:22 +0000413 // We need to merge the new offsets vector into the old, but we don't want
414 // to have duplicate entries. Do this by inserting the old offsets in a set
415 // so they'll be unique. After this, we iterate over the new offset vector
416 // and only append elements that aren't in the set.
417
418 // First, add the existing offsets to the set.
419 llvm::SmallSet<uint64_t, 4> OffsetSet;
420 for (unsigned I = 0, E = OffsetVector.size(); I != E; ++I) {
421 bool Inserted = OffsetSet.insert(OffsetVector[I]);
422 if (!Inserted)
423 assert(false && "Set of offsets should be unique!");
424 }
425
426 // Next, only add the new offsets if they are not already in the set.
427 for (unsigned I = 0, E = NewOffsetVector.size(); I != E; ++I) {
428 uint64_t Offset = NewOffsetVector[I];
429
430 if (OffsetSet.count(Offset)) {
431 // Ignore the offset.
432 continue;
433 }
434
435 // Otherwise, add it to the offsets vector.
436 OffsetVector.push_back(Offset);
437 }
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000438 }
439}
440
441void FinalOverriders::ComputeFinalOverriders(BaseSubobject Base,
Anders Carlsson231461f2010-02-17 17:48:25 +0000442 bool BaseSubobjectIsVisitedVBase,
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000443 SubobjectOffsetsMapTy &Offsets) {
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000444 const CXXRecordDecl *RD = Base.getBase();
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000445 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000446
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000447 SubobjectOffsetsMapTy NewOffsets;
448
449 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
450 E = RD->bases_end(); I != E; ++I) {
451 const CXXRecordDecl *BaseDecl =
452 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
453
Anders Carlsson033d4862010-02-14 17:05:59 +0000454 // Ignore bases that don't have any virtual member functions.
455 if (!BaseDecl->isPolymorphic())
456 continue;
457
Anders Carlssoned7d0e82010-02-25 22:18:35 +0000458 bool IsVisitedVirtualBase = BaseSubobjectIsVisitedVBase;
Anders Carlsson6a7e6a42010-02-14 00:37:35 +0000459 uint64_t BaseOffset;
460 if (I->isVirtual()) {
Anders Carlsson231461f2010-02-17 17:48:25 +0000461 if (!VisitedVirtualBases.insert(BaseDecl))
462 IsVisitedVirtualBase = true;
Anders Carlsson6a7e6a42010-02-14 00:37:35 +0000463 BaseOffset = MostDerivedClassLayout.getVBaseClassOffset(BaseDecl);
464 } else {
465 BaseOffset = Layout.getBaseClassOffset(BaseDecl) + Base.getBaseOffset();
466 }
467
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000468 // Compute the final overriders for this base.
Anders Carlsson231461f2010-02-17 17:48:25 +0000469 // We always want to compute the final overriders, even if the base is a
470 // visited virtual base. Consider:
471 //
472 // struct A {
473 // virtual void f();
474 // virtual void g();
475 // };
476 //
477 // struct B : virtual A {
478 // void f();
479 // };
480 //
481 // struct C : virtual A {
482 // void g ();
483 // };
484 //
485 // struct D : B, C { };
486 //
487 // Here, we still want to compute the overriders for A as a base of C,
488 // because otherwise we'll miss that C::g overrides A::f.
489 ComputeFinalOverriders(BaseSubobject(BaseDecl, BaseOffset),
490 IsVisitedVirtualBase, NewOffsets);
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000491 }
492
493 /// Now add the overriders for this particular subobject.
Anders Carlsson231461f2010-02-17 17:48:25 +0000494 /// (We don't want to do this more than once for a virtual base).
495 if (!BaseSubobjectIsVisitedVBase)
496 AddOverriders(Base, NewOffsets);
Anders Carlsson9fbf6d92010-02-12 01:40:03 +0000497
498 // And merge the newly discovered subobject offsets.
499 MergeSubobjectOffsets(NewOffsets, Offsets);
500
501 /// Finally, add the offset for our own subobject.
502 Offsets[RD].push_back(Base.getBaseOffset());
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000503}
504
Anders Carlsson6a7e6a42010-02-14 00:37:35 +0000505void FinalOverriders::dump(llvm::raw_ostream &Out, BaseSubobject Base) {
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000506 const CXXRecordDecl *RD = Base.getBase();
507 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
508
509 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
510 E = RD->bases_end(); I != E; ++I) {
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000511 const CXXRecordDecl *BaseDecl =
512 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
513
Anders Carlsson033d4862010-02-14 17:05:59 +0000514 // Ignore bases that don't have any virtual member functions.
515 if (!BaseDecl->isPolymorphic())
516 continue;
517
Anders Carlsson6a7e6a42010-02-14 00:37:35 +0000518 uint64_t BaseOffset;
519 if (I->isVirtual()) {
520 if (!VisitedVirtualBases.insert(BaseDecl)) {
521 // We've visited this base before.
522 continue;
523 }
524
525 BaseOffset = MostDerivedClassLayout.getVBaseClassOffset(BaseDecl);
526 } else {
527 BaseOffset = Layout.getBaseClassOffset(BaseDecl) +
528 Base.getBaseOffset();
529 }
530
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000531 dump(Out, BaseSubobject(BaseDecl, BaseOffset));
532 }
533
534 Out << "Final overriders for (" << RD->getQualifiedNameAsString() << ", ";
535 Out << Base.getBaseOffset() << ")\n";
536
537 // Now dump the overriders for this base subobject.
538 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
539 E = RD->method_end(); I != E; ++I) {
540 const CXXMethodDecl *MD = *I;
541
542 if (!MD->isVirtual())
543 continue;
544
Anders Carlsson136bd192010-02-12 16:55:34 +0000545 OverriderInfo Overrider = getOverrider(Base, MD);
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000546
547 Out << " " << MD->getQualifiedNameAsString() << " - ";
Anders Carlsson8e661e12010-02-12 17:13:23 +0000548 Out << Overrider.Method->getQualifiedNameAsString();
Anders Carlssoneee53d92010-02-13 02:02:03 +0000549
Benjamin Kramer02c67372010-02-13 09:11:28 +0000550 AdjustmentOffsetsMapTy::const_iterator AI =
Anders Carlssoneee53d92010-02-13 02:02:03 +0000551 ReturnAdjustments.find(std::make_pair(Base, MD));
Benjamin Kramer02c67372010-02-13 09:11:28 +0000552 if (AI != ReturnAdjustments.end()) {
553 const BaseOffset &Offset = AI->second;
Anders Carlssonf3f67842010-02-13 20:41:15 +0000554
555 Out << " [ret-adj: ";
556 if (Offset.VirtualBase)
557 Out << Offset.VirtualBase->getQualifiedNameAsString() << " vbase, ";
Anders Carlssoneee53d92010-02-13 02:02:03 +0000558
Anders Carlssonf3f67842010-02-13 20:41:15 +0000559 Out << Offset.NonVirtualOffset << " nv]";
Anders Carlssoneee53d92010-02-13 02:02:03 +0000560 }
Anders Carlssoncce9ee82010-02-13 23:17:31 +0000561
Anders Carlsson8e661e12010-02-12 17:13:23 +0000562 Out << "\n";
Anders Carlssone8ac42a2010-02-11 21:24:32 +0000563 }
564}
565
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000566/// VtableComponent - Represents a single component in a vtable.
567class VtableComponent {
568public:
569 enum Kind {
570 CK_VCallOffset,
571 CK_VBaseOffset,
572 CK_OffsetToTop,
573 CK_RTTI,
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000574 CK_FunctionPointer,
575
576 /// CK_CompleteDtorPointer - A pointer to the complete destructor.
577 CK_CompleteDtorPointer,
578
579 /// CK_DeletingDtorPointer - A pointer to the deleting destructor.
Anders Carlsson350b56e2010-02-19 20:08:13 +0000580 CK_DeletingDtorPointer,
581
582 /// CK_UnusedFunctionPointer - In some cases, a vtable function pointer
583 /// will end up never being called. Such vtable function pointers are
584 /// represented as a CK_UnusedFunctionPointer.
585 CK_UnusedFunctionPointer
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000586 };
587
Anders Carlssonb0a588f2010-02-17 06:07:19 +0000588 static VtableComponent MakeVCallOffset(int64_t Offset) {
589 return VtableComponent(CK_VCallOffset, Offset);
590 }
591
Anders Carlssondc2dba32010-02-16 04:49:44 +0000592 static VtableComponent MakeVBaseOffset(int64_t Offset) {
593 return VtableComponent(CK_VBaseOffset, Offset);
594 }
595
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000596 static VtableComponent MakeOffsetToTop(int64_t Offset) {
597 return VtableComponent(CK_OffsetToTop, Offset);
598 }
599
600 static VtableComponent MakeRTTI(const CXXRecordDecl *RD) {
601 return VtableComponent(CK_RTTI, reinterpret_cast<uintptr_t>(RD));
602 }
603
604 static VtableComponent MakeFunction(const CXXMethodDecl *MD) {
605 assert(!isa<CXXDestructorDecl>(MD) &&
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000606 "Don't use MakeFunction with destructors!");
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000607
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000608 return VtableComponent(CK_FunctionPointer,
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000609 reinterpret_cast<uintptr_t>(MD));
610 }
611
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000612 static VtableComponent MakeCompleteDtor(const CXXDestructorDecl *DD) {
613 return VtableComponent(CK_CompleteDtorPointer,
614 reinterpret_cast<uintptr_t>(DD));
615 }
616
617 static VtableComponent MakeDeletingDtor(const CXXDestructorDecl *DD) {
618 return VtableComponent(CK_DeletingDtorPointer,
619 reinterpret_cast<uintptr_t>(DD));
620 }
621
Anders Carlsson350b56e2010-02-19 20:08:13 +0000622 static VtableComponent MakeUnusedFunction(const CXXMethodDecl *MD) {
623 assert(!isa<CXXDestructorDecl>(MD) &&
624 "Don't use MakeUnusedFunction with destructors!");
625 return VtableComponent(CK_UnusedFunctionPointer,
626 reinterpret_cast<uintptr_t>(MD));
627 }
628
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000629 /// getKind - Get the kind of this vtable component.
630 Kind getKind() const {
631 return (Kind)(Value & 0x7);
632 }
633
Anders Carlssonb0a588f2010-02-17 06:07:19 +0000634 int64_t getVCallOffset() const {
635 assert(getKind() == CK_VCallOffset && "Invalid component kind!");
636
637 return getOffset();
638 }
639
Anders Carlssondc2dba32010-02-16 04:49:44 +0000640 int64_t getVBaseOffset() const {
641 assert(getKind() == CK_VBaseOffset && "Invalid component kind!");
642
643 return getOffset();
644 }
645
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000646 int64_t getOffsetToTop() const {
647 assert(getKind() == CK_OffsetToTop && "Invalid component kind!");
648
649 return getOffset();
650 }
651
652 const CXXRecordDecl *getRTTIDecl() const {
653 assert(getKind() == CK_RTTI && "Invalid component kind!");
654
655 return reinterpret_cast<CXXRecordDecl *>(getPointer());
656 }
657
658 const CXXMethodDecl *getFunctionDecl() const {
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000659 assert(getKind() == CK_FunctionPointer);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000660
661 return reinterpret_cast<CXXMethodDecl *>(getPointer());
662 }
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000663
664 const CXXDestructorDecl *getDestructorDecl() const {
665 assert((getKind() == CK_CompleteDtorPointer ||
666 getKind() == CK_DeletingDtorPointer) && "Invalid component kind!");
667
668 return reinterpret_cast<CXXDestructorDecl *>(getPointer());
669 }
670
Anders Carlsson350b56e2010-02-19 20:08:13 +0000671 const CXXMethodDecl *getUnusedFunctionDecl() const {
672 assert(getKind() == CK_UnusedFunctionPointer);
673
674 return reinterpret_cast<CXXMethodDecl *>(getPointer());
675 }
676
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000677private:
678 VtableComponent(Kind ComponentKind, int64_t Offset) {
679 assert((ComponentKind == CK_VCallOffset ||
680 ComponentKind == CK_VBaseOffset ||
681 ComponentKind == CK_OffsetToTop) && "Invalid component kind!");
682 assert(Offset <= ((1LL << 56) - 1) && "Offset is too big!");
683
684 Value = ((Offset << 3) | ComponentKind);
685 }
686
687 VtableComponent(Kind ComponentKind, uintptr_t Ptr) {
688 assert((ComponentKind == CK_RTTI ||
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000689 ComponentKind == CK_FunctionPointer ||
690 ComponentKind == CK_CompleteDtorPointer ||
Anders Carlsson350b56e2010-02-19 20:08:13 +0000691 ComponentKind == CK_DeletingDtorPointer ||
692 ComponentKind == CK_UnusedFunctionPointer) &&
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000693 "Invalid component kind!");
694
695 assert((Ptr & 7) == 0 && "Pointer not sufficiently aligned!");
696
697 Value = Ptr | ComponentKind;
698 }
699
700 int64_t getOffset() const {
701 assert((getKind() == CK_VCallOffset || getKind() == CK_VBaseOffset ||
702 getKind() == CK_OffsetToTop) && "Invalid component kind!");
703
704 return Value >> 3;
705 }
706
707 uintptr_t getPointer() const {
Anders Carlsson5bd8d192010-02-11 18:20:28 +0000708 assert((getKind() == CK_RTTI ||
709 getKind() == CK_FunctionPointer ||
710 getKind() == CK_CompleteDtorPointer ||
Anders Carlsson350b56e2010-02-19 20:08:13 +0000711 getKind() == CK_DeletingDtorPointer ||
712 getKind() == CK_UnusedFunctionPointer) &&
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000713 "Invalid component kind!");
Anders Carlsson5d40c6f2010-02-11 08:02:13 +0000714
715 return static_cast<uintptr_t>(Value & ~7ULL);
716 }
717
718 /// The kind is stored in the lower 3 bits of the value. For offsets, we
719 /// make use of the facts that classes can't be larger than 2^55 bytes,
720 /// so we store the offset in the lower part of the 61 bytes that remain.
721 /// (The reason that we're not simply using a PointerIntPair here is that we
722 /// need the offsets to be 64-bit, even when on a 32-bit machine).
723 int64_t Value;
724};
725
Anders Carlsson78277c72010-02-18 17:00:09 +0000726/// VCallOffsetMap - Keeps track of vcall offsets when building a vtable.
727struct VCallOffsetMap {
728
729 typedef std::pair<const CXXMethodDecl *, int64_t> MethodAndOffsetPairTy;
730
731 /// Offsets - Keeps track of methods and their offsets.
732 // FIXME: This should be a real map and not a vector.
733 llvm::SmallVector<MethodAndOffsetPairTy, 16> Offsets;
734
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000735 /// MethodsCanShareVCallOffset - Returns whether two virtual member functions
736 /// can share the same vcall offset.
737 static bool MethodsCanShareVCallOffset(const CXXMethodDecl *LHS,
738 const CXXMethodDecl *RHS);
739
Anders Carlsson78277c72010-02-18 17:00:09 +0000740public:
741 /// AddVCallOffset - Adds a vcall offset to the map. Returns true if the
742 /// add was successful, or false if there was already a member function with
743 /// the same signature in the map.
744 bool AddVCallOffset(const CXXMethodDecl *MD, int64_t OffsetOffset);
745
746 /// getVCallOffsetOffset - Returns the vcall offset offset (relative to the
747 /// vtable address point) for the given virtual member function.
748 int64_t getVCallOffsetOffset(const CXXMethodDecl *MD);
749
Anders Carlsson9e3b3a32010-02-25 22:23:13 +0000750 // empty - Return whether the offset map is empty or not.
751 bool empty() const { return Offsets.empty(); }
Anders Carlsson78277c72010-02-18 17:00:09 +0000752};
753
John McCall43c6ffb2010-02-26 20:22:44 +0000754static bool HasSameVirtualSignature(const CXXMethodDecl *LHS,
755 const CXXMethodDecl *RHS) {
756 ASTContext &C = LHS->getASTContext(); // TODO: thread this down
757 CanQual<FunctionProtoType>
758 LT = C.getCanonicalType(LHS->getType()).getAs<FunctionProtoType>(),
759 RT = C.getCanonicalType(RHS->getType()).getAs<FunctionProtoType>();
760
761 // Fast-path matches in the canonical types.
762 if (LT == RT) return true;
763
764 // Force the signatures to match. We can't rely on the overrides
765 // list here because there isn't necessarily an inheritance
766 // relationship between the two methods.
767 if (LT.getQualifiers() != RT.getQualifiers() ||
768 LT->getNumArgs() != RT->getNumArgs())
769 return false;
770 for (unsigned I = 0, E = LT->getNumArgs(); I != E; ++I)
771 if (LT->getArgType(I) != RT->getArgType(I))
772 return false;
773 return true;
774}
775
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000776bool VCallOffsetMap::MethodsCanShareVCallOffset(const CXXMethodDecl *LHS,
777 const CXXMethodDecl *RHS) {
778 assert(LHS->isVirtual() && "LHS must be virtual!");
779 assert(RHS->isVirtual() && "LHS must be virtual!");
780
Anders Carlssond69b2f92010-02-27 04:12:52 +0000781 // A destructor can share a vcall offset with another destructor.
782 if (isa<CXXDestructorDecl>(LHS))
783 return isa<CXXDestructorDecl>(RHS);
784
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000785 // FIXME: We need to check more things here.
786
Anders Carlssond69b2f92010-02-27 04:12:52 +0000787 // The methods must have the same name.
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000788 DeclarationName LHSName = LHS->getDeclName();
789 DeclarationName RHSName = RHS->getDeclName();
John McCall43c6ffb2010-02-26 20:22:44 +0000790 if (LHSName != RHSName)
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000791 return false;
John McCall43c6ffb2010-02-26 20:22:44 +0000792
Anders Carlssond69b2f92010-02-27 04:12:52 +0000793 // And the same signatures.
794 return HasSameVirtualSignature(LHS, RHS);
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000795}
796
Anders Carlsson78277c72010-02-18 17:00:09 +0000797bool VCallOffsetMap::AddVCallOffset(const CXXMethodDecl *MD,
798 int64_t OffsetOffset) {
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000799 // Check if we can reuse an offset.
800 for (unsigned I = 0, E = Offsets.size(); I != E; ++I) {
801 if (MethodsCanShareVCallOffset(Offsets[I].first, MD))
802 return false;
803 }
804
805 // Add the offset.
806 Offsets.push_back(MethodAndOffsetPairTy(MD, OffsetOffset));
Anders Carlsson78277c72010-02-18 17:00:09 +0000807 return true;
808}
809
810int64_t VCallOffsetMap::getVCallOffsetOffset(const CXXMethodDecl *MD) {
Anders Carlsson8847d9e2010-02-18 17:26:40 +0000811 // Look for an offset.
812 for (unsigned I = 0, E = Offsets.size(); I != E; ++I) {
813 if (MethodsCanShareVCallOffset(Offsets[I].first, MD))
814 return Offsets[I].second;
815 }
816
817 assert(false && "Should always find a vcall offset offset!");
Anders Carlsson78277c72010-02-18 17:00:09 +0000818 return 0;
819}
820
Anders Carlsson422f7782010-02-25 03:45:56 +0000821/// VCallAndVBaseOffsetBuilder - Class for building vcall and vbase offsets.
822class VCallAndVBaseOffsetBuilder {
823 /// MostDerivedClass - The most derived class for which we're building this
824 /// vtable.
825 const CXXRecordDecl *MostDerivedClass;
826
827 /// Context - The ASTContext which we will use for layout information.
828 ASTContext &Context;
829
830 /// Components - vcall and vbase offset components
831 typedef llvm::SmallVector<VtableComponent, 64> VtableComponentVectorTy;
832 VtableComponentVectorTy Components;
833
834 /// VisitedVirtualBases - Visited virtual bases.
835 llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBases;
836
837 /// VCallOffsets - Keeps track of vcall offsets.
838 VCallOffsetMap VCallOffsets;
839
840 /// FinalOverriders - The final overriders of the most derived class.
841 /// (Can be null when we're not building a vtable of the most derived class).
842 const FinalOverriders *Overriders;
843
844 /// AddVCallAndVBaseOffsets - Add vcall offsets and vbase offsets for the
845 /// given base subobject.
846 void AddVCallAndVBaseOffsets(BaseSubobject Base, bool BaseIsVirtual,
847 uint64_t RealBaseOffset);
848
849 /// AddVCallOffsets - Add vcall offsets for the given base subobject.
850 void AddVCallOffsets(BaseSubobject Base, uint64_t VBaseOffset);
851
852 /// AddVBaseOffsets - Add vbase offsets for the given class.
853 void AddVBaseOffsets(const CXXRecordDecl *Base, int64_t OffsetToTop);
854
855public:
856 VCallAndVBaseOffsetBuilder(const CXXRecordDecl *MostDerivedClass,
857 const FinalOverriders *Overriders,
858 BaseSubobject Base, bool BaseIsVirtual)
859 : MostDerivedClass(MostDerivedClass),
860 Context(MostDerivedClass->getASTContext()), Overriders(Overriders) {
861
862 // Add vcall and vbase offsets.
863 AddVCallAndVBaseOffsets(Base, BaseIsVirtual, Base.getBaseOffset());
864 }
865
866 /// Methods for iterating over the components.
867 typedef VtableComponentVectorTy::const_reverse_iterator const_iterator;
868 const_iterator components_begin() const { return Components.rbegin(); }
869 const_iterator components_end() const { return Components.rend(); }
870
Anders Carlsson422f7782010-02-25 03:45:56 +0000871 const VCallOffsetMap& getVCallOffsets() const { return VCallOffsets; }
872};
873
874void
875VCallAndVBaseOffsetBuilder::AddVCallAndVBaseOffsets(BaseSubobject Base,
876 bool BaseIsVirtual,
877 uint64_t RealBaseOffset) {
878 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Base.getBase());
879
880 // Itanium C++ ABI 2.5.2:
881 // ..in classes sharing a virtual table with a primary base class, the vcall
882 // and vbase offsets added by the derived class all come before the vcall
883 // and vbase offsets required by the base class, so that the latter may be
884 // laid out as required by the base class without regard to additions from
885 // the derived class(es).
886
887 // (Since we're emitting the vcall and vbase offsets in reverse order, we'll
888 // emit them for the primary base first).
889 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
890 bool PrimaryBaseIsVirtual = Layout.getPrimaryBaseWasVirtual();
891
892 uint64_t PrimaryBaseOffset;
893
894 // Get the base offset of the primary base.
895 if (PrimaryBaseIsVirtual) {
896 assert(Layout.getVBaseClassOffset(PrimaryBase) == 0 &&
897 "Primary vbase should have a zero offset!");
898
899 const ASTRecordLayout &MostDerivedClassLayout =
900 Context.getASTRecordLayout(MostDerivedClass);
901
902 PrimaryBaseOffset =
903 MostDerivedClassLayout.getVBaseClassOffset(PrimaryBase);
904 } else {
905 assert(Layout.getBaseClassOffset(PrimaryBase) == 0 &&
906 "Primary base should have a zero offset!");
907
908 PrimaryBaseOffset = Base.getBaseOffset();
909 }
910
911 AddVCallAndVBaseOffsets(BaseSubobject(PrimaryBase, PrimaryBaseOffset),
912 PrimaryBaseIsVirtual, RealBaseOffset);
913 }
914
915 // FIXME: Don't use /8 here.
Anders Carlssone02a9262010-02-27 19:21:58 +0000916 int64_t OffsetToTop = -(int64_t)RealBaseOffset / 8;
Anders Carlsson422f7782010-02-25 03:45:56 +0000917 AddVBaseOffsets(Base.getBase(), OffsetToTop);
918
919 // We only want to add vcall offsets for virtual bases.
920 if (BaseIsVirtual)
921 AddVCallOffsets(Base, RealBaseOffset);
922}
923
924void VCallAndVBaseOffsetBuilder::AddVCallOffsets(BaseSubobject Base,
925 uint64_t VBaseOffset) {
926 const CXXRecordDecl *RD = Base.getBase();
927 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
928
John McCall43c6ffb2010-02-26 20:22:44 +0000929 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
930
Anders Carlsson422f7782010-02-25 03:45:56 +0000931 // Handle the primary base first.
John McCall43c6ffb2010-02-26 20:22:44 +0000932 if (PrimaryBase) {
Anders Carlsson422f7782010-02-25 03:45:56 +0000933 uint64_t PrimaryBaseOffset;
934
935 // Get the base offset of the primary base.
936 if (Layout.getPrimaryBaseWasVirtual()) {
937 assert(Layout.getVBaseClassOffset(PrimaryBase) == 0 &&
938 "Primary vbase should have a zero offset!");
939
940 const ASTRecordLayout &MostDerivedClassLayout =
941 Context.getASTRecordLayout(MostDerivedClass);
942
943 PrimaryBaseOffset =
944 MostDerivedClassLayout.getVBaseClassOffset(PrimaryBase);
945 } else {
946 assert(Layout.getBaseClassOffset(PrimaryBase) == 0 &&
947 "Primary base should have a zero offset!");
948
949 PrimaryBaseOffset = Base.getBaseOffset();
950 }
951
952 AddVCallOffsets(BaseSubobject(PrimaryBase, PrimaryBaseOffset),
953 VBaseOffset);
954 }
955
956 // Add the vcall offsets.
957 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
958 E = RD->method_end(); I != E; ++I) {
959 const CXXMethodDecl *MD = *I;
960
961 if (!MD->isVirtual())
962 continue;
963
964 // OffsetIndex is the index of this vcall offset, relative to the vtable
965 // address point. (We subtract 3 to account for the information just
966 // above the address point, the RTTI info, the offset to top, and the
967 // vcall offset itself).
968 int64_t OffsetIndex = -(int64_t)(3 + Components.size());
969
970 // FIXME: We shouldn't use / 8 here.
971 int64_t OffsetOffset = OffsetIndex *
972 (int64_t)Context.Target.getPointerWidth(0) / 8;
973
974 // Don't add a vcall offset if we already have one for this member function
975 // signature.
976 if (!VCallOffsets.AddVCallOffset(MD, OffsetOffset))
977 continue;
978
979 int64_t Offset = 0;
980
981 if (Overriders) {
982 // Get the final overrider.
983 FinalOverriders::OverriderInfo Overrider =
984 Overriders->getOverrider(Base, MD);
985
986 /// The vcall offset is the offset from the virtual base to the object where
987 /// the function was overridden.
988 // FIXME: We should not use / 8 here.
989 Offset = (int64_t)(Overrider.BaseOffset - VBaseOffset) / 8;
990 }
991
992 Components.push_back(VtableComponent::MakeVCallOffset(Offset));
993 }
994
995 // And iterate over all non-virtual bases (ignoring the primary base).
996 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
997 E = RD->bases_end(); I != E; ++I) {
998
999 if (I->isVirtual())
1000 continue;
1001
1002 const CXXRecordDecl *BaseDecl =
1003 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
John McCall43c6ffb2010-02-26 20:22:44 +00001004 if (BaseDecl == PrimaryBase)
1005 continue;
Anders Carlsson422f7782010-02-25 03:45:56 +00001006
1007 // Get the base offset of this base.
1008 uint64_t BaseOffset = Base.getBaseOffset() +
1009 Layout.getBaseClassOffset(BaseDecl);
1010
1011 AddVCallOffsets(BaseSubobject(BaseDecl, BaseOffset), VBaseOffset);
1012 }
1013}
1014
1015
1016void VCallAndVBaseOffsetBuilder::AddVBaseOffsets(const CXXRecordDecl *RD,
1017 int64_t OffsetToTop) {
1018 const ASTRecordLayout &MostDerivedClassLayout =
1019 Context.getASTRecordLayout(MostDerivedClass);
1020
1021 // Add vbase offsets.
1022 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1023 E = RD->bases_end(); I != E; ++I) {
1024 const CXXRecordDecl *BaseDecl =
1025 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1026
1027 // Check if this is a virtual base that we haven't visited before.
1028 if (I->isVirtual() && VisitedVirtualBases.insert(BaseDecl)) {
1029 // FIXME: We shouldn't use / 8 here.
1030 uint64_t Offset =
1031 OffsetToTop + MostDerivedClassLayout.getVBaseClassOffset(BaseDecl) / 8;
1032
1033 Components.push_back(VtableComponent::MakeVBaseOffset(Offset));
1034 }
1035
1036 // Check the base class looking for more vbase offsets.
1037 AddVBaseOffsets(BaseDecl, OffsetToTop);
1038 }
1039}
1040
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001041/// VtableBuilder - Class for building vtable layout information.
Benjamin Kramer337e3a52009-11-28 19:45:26 +00001042class VtableBuilder {
Anders Carlsson65b49782010-02-12 05:25:12 +00001043public:
Anders Carlssond46ed892010-02-27 16:18:19 +00001044 /// PrimaryBasesSetVectorTy - A set vector of direct and indirect
1045 /// primary bases.
1046 typedef llvm::SmallSetVector<const CXXRecordDecl *, 8>
1047 PrimaryBasesSetVectorTy;
1048
Anders Carlsson65b49782010-02-12 05:25:12 +00001049private:
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001050 /// VtableInfo - Global vtable information.
1051 CGVtableInfo &VtableInfo;
1052
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001053 /// MostDerivedClass - The most derived class for which we're building this
1054 /// vtable.
1055 const CXXRecordDecl *MostDerivedClass;
1056
1057 /// Context - The ASTContext which we will use for layout information.
Anders Carlsson65b49782010-02-12 05:25:12 +00001058 ASTContext &Context;
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001059
Anders Carlssone8ac42a2010-02-11 21:24:32 +00001060 /// FinalOverriders - The final overriders of the most derived class.
Anders Carlsson422f7782010-02-25 03:45:56 +00001061 const FinalOverriders Overriders;
Anders Carlssone8ac42a2010-02-11 21:24:32 +00001062
Anders Carlsson9e3b3a32010-02-25 22:23:13 +00001063 /// VCallOffsetsForVBases - Keeps track of vcall offsets for the virtual
1064 /// bases in this vtable.
1065 llvm::DenseMap<const CXXRecordDecl *, VCallOffsetMap> VCallOffsetsForVBases;
Anders Carlsson78277c72010-02-18 17:00:09 +00001066
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001067 /// Components - The components of the vtable being built.
1068 llvm::SmallVector<VtableComponent, 64> Components;
1069
Anders Carlsson932c2f22010-02-11 17:18:51 +00001070 /// AddressPoints - Address points for the vtable being built.
1071 CGVtableInfo::AddressPointsMapTy AddressPoints;
1072
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001073 /// ReturnAdjustment - A return adjustment.
Anders Carlsson5272c252010-02-12 17:37:14 +00001074 struct ReturnAdjustment {
1075 /// NonVirtual - The non-virtual adjustment from the derived object to its
1076 /// nearest virtual base.
1077 int64_t NonVirtual;
1078
Anders Carlsson78277c72010-02-18 17:00:09 +00001079 /// VBaseOffsetOffset - The offset (in bytes), relative to the address point
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001080 /// of the virtual base class offset.
1081 int64_t VBaseOffsetOffset;
Anders Carlsson5272c252010-02-12 17:37:14 +00001082
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001083 ReturnAdjustment() : NonVirtual(0), VBaseOffsetOffset(0) { }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001084
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001085 bool isEmpty() const { return !NonVirtual && !VBaseOffsetOffset; }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001086 };
1087
1088 /// ReturnAdjustments - The return adjustments needed in this vtable.
1089 llvm::SmallVector<std::pair<uint64_t, ReturnAdjustment>, 16>
1090 ReturnAdjustments;
1091
Anders Carlssond46ed892010-02-27 16:18:19 +00001092 /// MethodInfo - Contains information about a method in a vtable.
1093 /// (Used for computing 'this' pointer adjustment thunks.
1094 struct MethodInfo {
1095 /// BaseOffset - The base offset of this method.
1096 const uint64_t BaseOffset;
1097
1098 /// VtableIndex - The index in the vtable that this method has.
1099 /// (For destructors, this is the index of the complete destructor).
1100 const uint64_t VtableIndex;
1101
1102 MethodInfo(uint64_t BaseOffset, uint64_t VtableIndex)
1103 : BaseOffset(BaseOffset), VtableIndex(VtableIndex) { }
Anders Carlsson40687982010-02-27 16:52:49 +00001104
1105 MethodInfo() : BaseOffset(0), VtableIndex(0) { }
Anders Carlssond46ed892010-02-27 16:18:19 +00001106 };
1107
1108 typedef llvm::DenseMap<const CXXMethodDecl *, MethodInfo> MethodInfoMapTy;
1109
1110 /// MethodInfoMap - The information for all methods in the vtable we're
1111 /// currently building.
1112 MethodInfoMapTy MethodInfoMap;
1113
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001114 /// ThisAdjustment - A 'this' pointer adjustment thunk.
1115 struct ThisAdjustment {
1116 /// NonVirtual - The non-virtual adjustment from the derived object to its
1117 /// nearest virtual base.
1118 int64_t NonVirtual;
1119
John McCall43c6ffb2010-02-26 20:22:44 +00001120 /// VCallOffsetOffset - The offset (in bytes), relative to the address point,
Anders Carlsson78277c72010-02-18 17:00:09 +00001121 /// of the virtual call offset.
1122 int64_t VCallOffsetOffset;
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001123
Anders Carlsson78277c72010-02-18 17:00:09 +00001124 ThisAdjustment() : NonVirtual(0), VCallOffsetOffset(0) { }
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001125
Anders Carlsson78277c72010-02-18 17:00:09 +00001126 bool isEmpty() const { return !NonVirtual && !VCallOffsetOffset; }
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001127 };
1128
1129 /// ThisAdjustments - The 'this' pointer adjustments needed in this vtable.
1130 llvm::SmallVector<std::pair<uint64_t, ThisAdjustment>, 16>
1131 ThisAdjustments;
Anders Carlssond46ed892010-02-27 16:18:19 +00001132
Anders Carlsson40687982010-02-27 16:52:49 +00001133 /// ComputeThisAdjustments - Compute the 'this' pointer adjustments for the
1134 /// part of the vtable we're currently building.
1135 void ComputeThisAdjustments();
1136
Anders Carlssondc2dba32010-02-16 04:49:44 +00001137 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
1138
Anders Carlssond46ed892010-02-27 16:18:19 +00001139 /// PrimaryVirtualBases - All known virtual bases who are a primary base of
Anders Carlsson0570f712010-02-23 03:48:14 +00001140 /// some other base.
1141 VisitedVirtualBasesSetTy PrimaryVirtualBases;
1142
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001143 /// ComputeReturnAdjustment - Compute the return adjustment given a return
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001144 /// adjustment base offset.
Anders Carlsson075056a2010-02-23 01:34:28 +00001145 ReturnAdjustment ComputeReturnAdjustment(BaseOffset Offset);
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001146
Anders Carlsson9f19aaaa2010-02-27 19:57:44 +00001147 /// ComputeThisAdjustmentBaseOffset - Compute the base offset for adjusting
1148 /// the 'this' pointer from the base subobject to the derived subobject.
1149 BaseOffset ComputeThisAdjustmentBaseOffset(BaseSubobject Base,
1150 BaseSubobject Derived) const;
1151
Anders Carlsson78277c72010-02-18 17:00:09 +00001152 /// ComputeThisAdjustment - Compute the 'this' pointer adjustment for the
1153 /// given virtual member function and the 'this' pointer adjustment base
1154 /// offset.
1155 ThisAdjustment ComputeThisAdjustment(const CXXMethodDecl *MD,
Anders Carlsson075056a2010-02-23 01:34:28 +00001156 BaseOffset Offset);
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001157
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001158 /// AddMethod - Add a single virtual member function to the vtable
1159 /// components vector.
Anders Carlsson40687982010-02-27 16:52:49 +00001160 void AddMethod(const CXXMethodDecl *MD, ReturnAdjustment ReturnAdjustment);
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001161
Anders Carlssona8796c62010-02-23 04:26:39 +00001162 /// IsOverriderUsed - Returns whether the overrider will ever be used in this
1163 /// part of the vtable.
1164 ///
1165 /// Itanium C++ ABI 2.5.2:
1166 ///
1167 /// struct A { virtual void f(); };
1168 /// struct B : virtual public A { int i; };
1169 /// struct C : virtual public A { int j; };
1170 /// struct D : public B, public C {};
1171 ///
1172 /// When B and C are declared, A is a primary base in each case, so although
1173 /// vcall offsets are allocated in the A-in-B and A-in-C vtables, no this
1174 /// adjustment is required and no thunk is generated. However, inside D
1175 /// objects, A is no longer a primary base of C, so if we allowed calls to
1176 /// C::f() to use the copy of A's vtable in the C subobject, we would need
1177 /// to adjust this from C* to B::A*, which would require a third-party
1178 /// thunk. Since we require that a call to C::f() first convert to A*,
1179 /// C-in-D's copy of A's vtable is never referenced, so this is not
1180 /// necessary.
1181 bool IsOverriderUsed(BaseSubobject Base,
1182 BaseSubobject FirstBaseInPrimaryBaseChain,
1183 FinalOverriders::OverriderInfo Overrider) const;
1184
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001185 /// AddMethods - Add the methods of this base subobject and all its
1186 /// primary bases to the vtable components vector.
Anders Carlssona8796c62010-02-23 04:26:39 +00001187 void AddMethods(BaseSubobject Base, BaseSubobject FirstBaseInPrimaryBaseChain,
Anders Carlssond46ed892010-02-27 16:18:19 +00001188 PrimaryBasesSetVectorTy &PrimaryBases);
Anders Carlssonb716a542010-02-16 16:26:28 +00001189
1190 // LayoutVtable - Layout the vtable for the most derived class, including its
1191 // secondary vtables and any vtables for virtual bases.
1192 void LayoutVtable();
1193
1194 /// LayoutPrimaryAndAndSecondaryVtables - Layout the primary vtable for the
1195 /// given base subobject, as well as all its secondary vtables.
Anders Carlssondb042202010-02-17 03:11:55 +00001196 void LayoutPrimaryAndAndSecondaryVtables(BaseSubobject Base,
1197 bool BaseIsVirtual);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001198
Anders Carlsson14157932010-02-16 16:02:57 +00001199 /// LayoutSecondaryVtables - Layout the secondary vtables for the given base
1200 /// subobject.
1201 void LayoutSecondaryVtables(BaseSubobject Base);
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001202
1203 /// DeterminePrimaryVirtualBases - Determine the primary virtual bases in this
1204 /// class hierarchy.
1205 void DeterminePrimaryVirtualBases(const CXXRecordDecl *RD,
1206 VisitedVirtualBasesSetTy &VBases);
1207
Anders Carlsson13f0f662010-02-16 16:49:35 +00001208 /// LayoutVtablesForVirtualBases - Layout vtables for all virtual bases of the
1209 /// given base (excluding any primary bases).
1210 void LayoutVtablesForVirtualBases(const CXXRecordDecl *RD,
1211 VisitedVirtualBasesSetTy &VBases);
1212
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001213public:
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001214 VtableBuilder(CGVtableInfo &VtableInfo, const CXXRecordDecl *MostDerivedClass)
1215 : VtableInfo(VtableInfo), MostDerivedClass(MostDerivedClass),
Anders Carlssone8ac42a2010-02-11 21:24:32 +00001216 Context(MostDerivedClass->getASTContext()), Overriders(MostDerivedClass) {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001217
Anders Carlssonb716a542010-02-16 16:26:28 +00001218 LayoutVtable();
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001219 }
1220
1221 /// dumpLayout - Dump the vtable layout.
1222 void dumpLayout(llvm::raw_ostream&);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001223};
1224
Anders Carlssond2025412010-02-27 06:38:03 +00001225/// OverridesMethodInBases - Checks whether whether this virtual member
1226/// function overrides a member function in any of the given bases.
Anders Carlsson65b49782010-02-12 05:25:12 +00001227/// Returns the overridden member function, or null if none was found.
1228static const CXXMethodDecl *
Anders Carlssond2025412010-02-27 06:38:03 +00001229OverridesMethodInBases(const CXXMethodDecl *MD,
Anders Carlssond46ed892010-02-27 16:18:19 +00001230 VtableBuilder::PrimaryBasesSetVectorTy &Bases) {
Anders Carlsson65b49782010-02-12 05:25:12 +00001231 for (CXXMethodDecl::method_iterator I = MD->begin_overridden_methods(),
1232 E = MD->end_overridden_methods(); I != E; ++I) {
1233 const CXXMethodDecl *OverriddenMD = *I;
1234 const CXXRecordDecl *OverriddenRD = OverriddenMD->getParent();
1235 assert(OverriddenMD->isCanonicalDecl() &&
1236 "Should have the canonical decl of the overridden RD!");
1237
Anders Carlssond2025412010-02-27 06:38:03 +00001238 if (Bases.count(OverriddenRD))
Anders Carlsson65b49782010-02-12 05:25:12 +00001239 return OverriddenMD;
1240 }
1241
1242 return 0;
1243}
1244
Anders Carlsson40687982010-02-27 16:52:49 +00001245void VtableBuilder::ComputeThisAdjustments() {
Anders Carlsson4d0729a2010-02-27 19:00:53 +00001246 std::map<uint64_t, ThisAdjustment> SortedThisAdjustments;
1247
Anders Carlsson40687982010-02-27 16:52:49 +00001248 // Now go through the method info map and see if any of the methods need
1249 // 'this' pointer adjustments.
1250 for (MethodInfoMapTy::const_iterator I = MethodInfoMap.begin(),
1251 E = MethodInfoMap.end(); I != E; ++I) {
1252 const CXXMethodDecl *MD = I->first;
1253 const MethodInfo &MethodInfo = I->second;
1254
1255 BaseSubobject OverriddenBaseSubobject(MD->getParent(),
1256 MethodInfo.BaseOffset);
1257
1258 // Get the final overrider for this method.
1259 FinalOverriders::OverriderInfo Overrider =
1260 Overriders.getOverrider(OverriddenBaseSubobject, MD);
1261
1262 // Check if we need an adjustment.
1263 if (Overrider.BaseOffset == MethodInfo.BaseOffset)
1264 continue;
1265
Anders Carlsson01d3c7d2010-02-27 18:09:40 +00001266 uint64_t VtableIndex = MethodInfo.VtableIndex;
Anders Carlsson2b381bb2010-02-27 18:16:50 +00001267
1268 // Ignore adjustments for pure virtual member functions.
1269 if (Overrider.Method->isPure())
1270 continue;
1271
1272 // Ignore adjustments for unused function pointers.
Anders Carlsson01d3c7d2010-02-27 18:09:40 +00001273 if (Components[VtableIndex].getKind() ==
1274 VtableComponent::CK_UnusedFunctionPointer)
1275 continue;
1276
Anders Carlsson40687982010-02-27 16:52:49 +00001277 BaseSubobject OverriderBaseSubobject(Overrider.Method->getParent(),
1278 Overrider.BaseOffset);
1279
1280 // Compute the adjustment offset.
1281 BaseOffset ThisAdjustmentOffset =
Anders Carlsson9f19aaaa2010-02-27 19:57:44 +00001282 ComputeThisAdjustmentBaseOffset(OverriddenBaseSubobject,
1283 OverriderBaseSubobject);
1284
Anders Carlsson40687982010-02-27 16:52:49 +00001285 // Then compute the adjustment itself.
1286 ThisAdjustment ThisAdjustment = ComputeThisAdjustment(Overrider.Method,
1287 ThisAdjustmentOffset);
1288
Anders Carlsson01d3c7d2010-02-27 18:09:40 +00001289 // Add it.
Anders Carlsson4d0729a2010-02-27 19:00:53 +00001290 SortedThisAdjustments.insert(std::make_pair(VtableIndex, ThisAdjustment));
Anders Carlsson01d3c7d2010-02-27 18:09:40 +00001291
Anders Carlsson40687982010-02-27 16:52:49 +00001292 if (isa<CXXDestructorDecl>(MD)) {
1293 // Add an adjustment for the deleting destructor as well.
Anders Carlsson4d0729a2010-02-27 19:00:53 +00001294 SortedThisAdjustments.insert(std::make_pair(VtableIndex + 1,
1295 ThisAdjustment));
Anders Carlsson40687982010-02-27 16:52:49 +00001296 }
1297 }
1298
1299 /// Clear the method info map.
1300 MethodInfoMap.clear();
Anders Carlsson4d0729a2010-02-27 19:00:53 +00001301
1302 // Add the sorted elements.
1303 ThisAdjustments.append(SortedThisAdjustments.begin(),
1304 SortedThisAdjustments.end());
Anders Carlsson40687982010-02-27 16:52:49 +00001305}
1306
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001307VtableBuilder::ReturnAdjustment
Anders Carlsson075056a2010-02-23 01:34:28 +00001308VtableBuilder::ComputeReturnAdjustment(BaseOffset Offset) {
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001309 ReturnAdjustment Adjustment;
1310
1311 if (!Offset.isEmpty()) {
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001312 if (Offset.VirtualBase) {
1313 // Get the virtual base offset offset.
1314 Adjustment.VBaseOffsetOffset =
1315 VtableInfo.getVirtualBaseOffsetIndex(Offset.DerivedClass,
1316 Offset.VirtualBase);
1317 // FIXME: Once the assert in getVirtualBaseOffsetIndex is back again,
1318 // we can get rid of this assert.
1319 assert(Adjustment.VBaseOffsetOffset != 0 &&
1320 "Invalid base offset offset!");
1321 }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001322
1323 Adjustment.NonVirtual = Offset.NonVirtualOffset;
1324 }
1325
1326 return Adjustment;
1327}
1328
Anders Carlsson9f19aaaa2010-02-27 19:57:44 +00001329BaseOffset
1330VtableBuilder::ComputeThisAdjustmentBaseOffset(BaseSubobject Base,
1331 BaseSubobject Derived) const {
1332 const CXXRecordDecl *BaseRD = Base.getBase();
1333 const CXXRecordDecl *DerivedRD = Derived.getBase();
1334
1335 CXXBasePaths Paths(/*FindAmbiguities=*/true,
1336 /*RecordPaths=*/true, /*DetectVirtual=*/true);
1337
1338 if (!const_cast<CXXRecordDecl *>(DerivedRD)->
1339 isDerivedFrom(const_cast<CXXRecordDecl *>(BaseRD), Paths)) {
1340 assert(false && "Class must be derived from the passed in base class!");
1341 return BaseOffset();
1342 }
1343
1344 // We have to go through all the paths, and see which one leads us to the
1345 // right base subobject.
1346 for (CXXBasePaths::const_paths_iterator I = Paths.begin(), E = Paths.end();
1347 I != E; ++I) {
1348 BaseOffset Offset = ComputeBaseOffset(Context, DerivedRD, *I);
1349
1350 // FIXME: Should not use * 8 here.
1351 uint64_t OffsetToBaseSubobject = Offset.NonVirtualOffset * 8;
1352
1353 if (Offset.VirtualBase) {
1354 // If we have a virtual base class, the non-virtual offset is relative
1355 // to the virtual base class offset.
1356 const ASTRecordLayout &MostDerivedClassLayout =
1357 Context.getASTRecordLayout(MostDerivedClass);
1358
1359 /// Get the virtual base offset, relative to the most derived class
1360 /// layout.
1361 OffsetToBaseSubobject +=
1362 MostDerivedClassLayout.getVBaseClassOffset(Offset.VirtualBase);
1363 } else {
1364 // Otherwise, the non-virtual offset is relative to the derived class
1365 // offset.
1366 OffsetToBaseSubobject += Derived.getBaseOffset();
1367 }
1368
1369 // Check if this path gives us the right base subobject.
1370 if (OffsetToBaseSubobject == Base.getBaseOffset()) {
1371 // Since we're going from the base class _to_ the derived class, we'll
1372 // invert the non-virtual offset here.
1373 Offset.NonVirtualOffset = -Offset.NonVirtualOffset;
1374 return Offset;
1375 }
1376 }
1377
1378 return BaseOffset();
1379}
1380
1381
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001382VtableBuilder::ThisAdjustment
Anders Carlsson78277c72010-02-18 17:00:09 +00001383VtableBuilder::ComputeThisAdjustment(const CXXMethodDecl *MD,
Anders Carlsson075056a2010-02-23 01:34:28 +00001384 BaseOffset Offset) {
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001385 ThisAdjustment Adjustment;
1386
1387 if (!Offset.isEmpty()) {
Anders Carlsson8847d9e2010-02-18 17:26:40 +00001388 if (Offset.VirtualBase) {
Anders Carlsson9e3b3a32010-02-25 22:23:13 +00001389 // Get the vcall offset map for this virtual base.
1390 VCallOffsetMap &VCallOffsets = VCallOffsetsForVBases[Offset.VirtualBase];
1391
1392 if (VCallOffsets.empty()) {
1393 // We don't have vcall offsets for this virtual base, go ahead and
1394 // build them.
1395 VCallAndVBaseOffsetBuilder Builder(MostDerivedClass, 0,
1396 BaseSubobject(Offset.VirtualBase, 0),
1397 /*BaseIsVirtual=*/true);
1398
1399 VCallOffsets = Builder.getVCallOffsets();
1400 }
1401
Anders Carlsson8847d9e2010-02-18 17:26:40 +00001402 Adjustment.VCallOffsetOffset = VCallOffsets.getVCallOffsetOffset(MD);
1403 }
1404
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001405 Adjustment.NonVirtual = Offset.NonVirtualOffset;
1406 }
1407
1408 return Adjustment;
1409}
1410
Anders Carlsson65b49782010-02-12 05:25:12 +00001411void
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001412VtableBuilder::AddMethod(const CXXMethodDecl *MD,
Anders Carlsson40687982010-02-27 16:52:49 +00001413 ReturnAdjustment ReturnAdjustment) {
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001414 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
1415 assert(ReturnAdjustment.isEmpty() &&
1416 "Destructor can't have return adjustment!");
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001417
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001418 // Add both the complete destructor and the deleting destructor.
1419 Components.push_back(VtableComponent::MakeCompleteDtor(DD));
1420 Components.push_back(VtableComponent::MakeDeletingDtor(DD));
1421 } else {
1422 // Add the return adjustment if necessary.
1423 if (!ReturnAdjustment.isEmpty())
1424 ReturnAdjustments.push_back(std::make_pair(Components.size(),
1425 ReturnAdjustment));
1426
1427 // Add the function.
1428 Components.push_back(VtableComponent::MakeFunction(MD));
1429 }
1430}
1431
Anders Carlssond2025412010-02-27 06:38:03 +00001432/// OverridesIndirectMethodInBase - Return whether the given member function
1433/// overrides any methods in the set of given bases.
1434/// Unlike OverridesMethodInBase, this checks "overriders of overriders".
1435/// For example, if we have:
1436///
1437/// struct A { virtual void f(); }
1438/// struct B : A { virtual void f(); }
1439/// struct C : B { virtual void f(); }
1440///
1441/// OverridesIndirectMethodInBase will return true if given C::f as the method
1442/// and { A } as the set of bases.
1443static bool
1444OverridesIndirectMethodInBases(const CXXMethodDecl *MD,
Anders Carlssond46ed892010-02-27 16:18:19 +00001445 VtableBuilder::PrimaryBasesSetVectorTy &Bases) {
Anders Carlssond2025412010-02-27 06:38:03 +00001446 for (CXXMethodDecl::method_iterator I = MD->begin_overridden_methods(),
1447 E = MD->end_overridden_methods(); I != E; ++I) {
1448 const CXXMethodDecl *OverriddenMD = *I;
1449 const CXXRecordDecl *OverriddenRD = OverriddenMD->getParent();
1450 assert(OverriddenMD->isCanonicalDecl() &&
1451 "Should have the canonical decl of the overridden RD!");
1452
1453 if (Bases.count(OverriddenRD))
1454 return true;
1455
1456 // Check "indirect overriders".
1457 if (OverridesIndirectMethodInBases(OverriddenMD, Bases))
1458 return true;
1459 }
1460
1461 return false;
1462}
1463
Anders Carlssona8796c62010-02-23 04:26:39 +00001464bool
1465VtableBuilder::IsOverriderUsed(BaseSubobject Base,
1466 BaseSubobject FirstBaseInPrimaryBaseChain,
1467 FinalOverriders::OverriderInfo Overrider) const {
1468 // If the base and the first base in the primary base chain have the same
1469 // offsets, then this overrider will be used.
1470 if (Base.getBaseOffset() == FirstBaseInPrimaryBaseChain.getBaseOffset())
Anders Carlsson8939e402010-02-23 06:34:44 +00001471 return true;
1472
1473 // We know now that Base (or a direct or indirect base of it) is a primary
1474 // base in part of the class hierarchy, but not a primary base in the most
1475 // derived class.
1476
1477 // If the overrider is the first base in the primary base chain, we know
1478 // that the overrider will be used.
1479 if (Overrider.Method->getParent() == FirstBaseInPrimaryBaseChain.getBase())
Anders Carlssona8796c62010-02-23 04:26:39 +00001480 return true;
1481
Anders Carlssond46ed892010-02-27 16:18:19 +00001482 VtableBuilder::PrimaryBasesSetVectorTy PrimaryBases;
Anders Carlsson8939e402010-02-23 06:34:44 +00001483
1484 const CXXRecordDecl *RD = FirstBaseInPrimaryBaseChain.getBase();
1485 PrimaryBases.insert(RD);
1486
1487 // Now traverse the base chain, starting with the first base, until we find
1488 // the base that is no longer a primary base.
1489 while (true) {
1490 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1491 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
1492
1493 if (!PrimaryBase)
1494 break;
1495
1496 if (Layout.getPrimaryBaseWasVirtual()) {
1497 assert(Layout.getVBaseClassOffset(PrimaryBase) == 0 &&
1498 "Primary base should always be at offset 0!");
1499
1500 const ASTRecordLayout &MostDerivedClassLayout =
1501 Context.getASTRecordLayout(MostDerivedClass);
1502
1503 // Now check if this is the primary base that is not a primary base in the
1504 // most derived class.
1505 if (MostDerivedClassLayout.getVBaseClassOffset(PrimaryBase) !=
1506 FirstBaseInPrimaryBaseChain.getBaseOffset()) {
1507 // We found it, stop walking the chain.
1508 break;
1509 }
1510 } else {
1511 assert(Layout.getBaseClassOffset(PrimaryBase) == 0 &&
1512 "Primary base should always be at offset 0!");
1513 }
Anders Carlsson01d3c7d2010-02-27 18:09:40 +00001514
Anders Carlssonb26c2ab2010-02-27 19:51:04 +00001515 if (!PrimaryBases.insert(PrimaryBase))
1516 assert(false && "Found a duplicate primary base!");
1517
Anders Carlsson01d3c7d2010-02-27 18:09:40 +00001518 RD = PrimaryBase;
Anders Carlsson8939e402010-02-23 06:34:44 +00001519 }
1520
1521 // If the final overrider is an override of one of the primary bases,
1522 // then we know that it will be used.
Anders Carlssond2025412010-02-27 06:38:03 +00001523 return OverridesIndirectMethodInBases(Overrider.Method, PrimaryBases);
Anders Carlssona8796c62010-02-23 04:26:39 +00001524}
1525
Anders Carlsson40687982010-02-27 16:52:49 +00001526/// FindNearestOverriddenMethod - Given a method, returns the overridden method
1527/// from the nearest base. Returns null if no method was found.
1528static const CXXMethodDecl *
1529FindNearestOverriddenMethod(const CXXMethodDecl *MD,
1530 VtableBuilder::PrimaryBasesSetVectorTy &Bases) {
1531 for (int I = Bases.size(), E = 0; I != E; --I) {
1532 const CXXRecordDecl *PrimaryBase = Bases[I - 1];
1533
1534 // Now check the overriden methods.
1535 for (CXXMethodDecl::method_iterator I = MD->begin_overridden_methods(),
1536 E = MD->end_overridden_methods(); I != E; ++I) {
1537 const CXXMethodDecl *OverriddenMD = *I;
1538
1539 // We found our overridden method.
1540 if (OverriddenMD->getParent() == PrimaryBase)
1541 return OverriddenMD;
1542 }
1543 }
1544
1545 return 0;
1546}
1547
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001548void
Anders Carlssona8796c62010-02-23 04:26:39 +00001549VtableBuilder::AddMethods(BaseSubobject Base,
1550 BaseSubobject FirstBaseInPrimaryBaseChain,
Anders Carlssond46ed892010-02-27 16:18:19 +00001551 PrimaryBasesSetVectorTy &PrimaryBases) {
Anders Carlsson65b49782010-02-12 05:25:12 +00001552 const CXXRecordDecl *RD = Base.getBase();
1553
1554 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1555
1556 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
Anders Carlsson0570f712010-02-23 03:48:14 +00001557 uint64_t BaseOffset;
1558 if (Layout.getPrimaryBaseWasVirtual()) {
1559 assert(Layout.getVBaseClassOffset(PrimaryBase) == 0 &&
1560 "Primary vbase should have a zero offset!");
1561
1562 const ASTRecordLayout &MostDerivedClassLayout =
1563 Context.getASTRecordLayout(MostDerivedClass);
1564
1565 BaseOffset = MostDerivedClassLayout.getVBaseClassOffset(PrimaryBase);
Anders Carlsson0570f712010-02-23 03:48:14 +00001566 } else {
Anders Carlsson65b49782010-02-12 05:25:12 +00001567 assert(Layout.getBaseClassOffset(PrimaryBase) == 0 &&
1568 "Primary base should have a zero offset!");
Anders Carlsson0570f712010-02-23 03:48:14 +00001569
1570 BaseOffset = Base.getBaseOffset();
1571 }
Anders Carlsson65b49782010-02-12 05:25:12 +00001572
Anders Carlssona8796c62010-02-23 04:26:39 +00001573 AddMethods(BaseSubobject(PrimaryBase, BaseOffset),
1574 FirstBaseInPrimaryBaseChain, PrimaryBases);
Anders Carlsson65b49782010-02-12 05:25:12 +00001575
1576 if (!PrimaryBases.insert(PrimaryBase))
1577 assert(false && "Found a duplicate primary base!");
1578 }
Anders Carlsson932c2f22010-02-11 17:18:51 +00001579
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001580 // Now go through all virtual member functions and add them.
1581 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
1582 E = RD->method_end(); I != E; ++I) {
1583 const CXXMethodDecl *MD = *I;
Anders Carlsson65b49782010-02-12 05:25:12 +00001584
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001585 if (!MD->isVirtual())
1586 continue;
Anders Carlsson65b49782010-02-12 05:25:12 +00001587
1588 // Get the final overrider.
Anders Carlsson136bd192010-02-12 16:55:34 +00001589 FinalOverriders::OverriderInfo Overrider =
1590 Overriders.getOverrider(Base, MD);
Anders Carlsson65b49782010-02-12 05:25:12 +00001591
1592 // Check if this virtual member function overrides a method in a primary
1593 // base. If this is the case, and the return type doesn't require adjustment
1594 // then we can just use the member function from the primary base.
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001595 if (const CXXMethodDecl *OverriddenMD =
Anders Carlsson40687982010-02-27 16:52:49 +00001596 FindNearestOverriddenMethod(MD, PrimaryBases)) {
Anders Carlssoncce9ee82010-02-13 23:17:31 +00001597 if (ComputeReturnAdjustmentBaseOffset(Context, MD,
Anders Carlsson40687982010-02-27 16:52:49 +00001598 OverriddenMD).isEmpty()) {
1599 // Replace the method info of the overridden method with our own
1600 // method.
1601 assert(MethodInfoMap.count(OverriddenMD) &&
1602 "Did not find the overridden method!");
1603 MethodInfo &OverriddenMethodInfo = MethodInfoMap[OverriddenMD];
1604
1605 MethodInfo MethodInfo(Base.getBaseOffset(),
1606 OverriddenMethodInfo.VtableIndex);
1607
1608 assert(!MethodInfoMap.count(MD) &&
1609 "Should not have method info for this method yet!");
1610
1611 MethodInfoMap.insert(std::make_pair(MD, MethodInfo));
1612 MethodInfoMap.erase(OverriddenMD);
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001613 continue;
Anders Carlsson40687982010-02-27 16:52:49 +00001614 }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001615 }
Anders Carlssoneee53d92010-02-13 02:02:03 +00001616
Anders Carlsson40687982010-02-27 16:52:49 +00001617 // Insert the method info for this method.
1618 MethodInfo MethodInfo(Base.getBaseOffset(), Components.size());
1619
1620 assert(!MethodInfoMap.count(MD) &&
1621 "Should not have method info for this method yet!");
1622 MethodInfoMap.insert(std::make_pair(MD, MethodInfo));
Anders Carlsson01d3c7d2010-02-27 18:09:40 +00001623
1624 // Check if this overrider is going to be used.
1625 if (!IsOverriderUsed(Base, FirstBaseInPrimaryBaseChain, Overrider)) {
1626 const CXXMethodDecl *OverriderMD = Overrider.Method;
1627 Components.push_back(VtableComponent::MakeUnusedFunction(OverriderMD));
1628 continue;
1629 }
Anders Carlssona8796c62010-02-23 04:26:39 +00001630
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001631 // Check if this overrider needs a return adjustment.
Anders Carlsson075056a2010-02-23 01:34:28 +00001632 BaseOffset ReturnAdjustmentOffset =
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001633 Overriders.getReturnAdjustmentOffset(Base, MD);
1634
1635 ReturnAdjustment ReturnAdjustment =
1636 ComputeReturnAdjustment(ReturnAdjustmentOffset);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001637
Anders Carlsson40687982010-02-27 16:52:49 +00001638 AddMethod(Overrider.Method, ReturnAdjustment);
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001639 }
1640}
1641
Anders Carlssonb716a542010-02-16 16:26:28 +00001642void VtableBuilder::LayoutVtable() {
Anders Carlssondb042202010-02-17 03:11:55 +00001643 LayoutPrimaryAndAndSecondaryVtables(BaseSubobject(MostDerivedClass, 0),
1644 /*BaseIsVirtual=*/false);
Anders Carlssonb716a542010-02-16 16:26:28 +00001645
Anders Carlsson13f0f662010-02-16 16:49:35 +00001646 VisitedVirtualBasesSetTy VBases;
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001647
1648 // Determine the primary virtual bases.
1649 DeterminePrimaryVirtualBases(MostDerivedClass, VBases);
1650 VBases.clear();
1651
Anders Carlsson13f0f662010-02-16 16:49:35 +00001652 LayoutVtablesForVirtualBases(MostDerivedClass, VBases);
Anders Carlssonb716a542010-02-16 16:26:28 +00001653}
1654
Anders Carlssondb042202010-02-17 03:11:55 +00001655void VtableBuilder::LayoutPrimaryAndAndSecondaryVtables(BaseSubobject Base,
1656 bool BaseIsVirtual) {
Chris Lattnerd2408f72010-02-17 21:42:34 +00001657 assert(Base.getBase()->isDynamicClass() && "class does not have a vtable!");
Anders Carlsson033d4862010-02-14 17:05:59 +00001658
Anders Carlsson77904f12010-02-16 04:59:55 +00001659 // Add vcall and vbase offsets for this vtable.
Anders Carlsson422f7782010-02-25 03:45:56 +00001660 VCallAndVBaseOffsetBuilder Builder(MostDerivedClass, &Overriders,
1661 Base, BaseIsVirtual);
1662 Components.append(Builder.components_begin(), Builder.components_end());
1663
Anders Carlsson9e3b3a32010-02-25 22:23:13 +00001664 // Check if we need to add these vcall offsets.
1665 if (BaseIsVirtual && !Builder.getVCallOffsets().empty()) {
1666 VCallOffsetMap &VCallOffsets = VCallOffsetsForVBases[Base.getBase()];
1667
1668 if (VCallOffsets.empty())
1669 VCallOffsets = Builder.getVCallOffsets();
1670 }
1671
Anders Carlsson77904f12010-02-16 04:59:55 +00001672 // Add the offset to top.
Anders Carlssone75aaa92010-02-13 22:05:23 +00001673 // FIXME: This is not going to be right for construction vtables.
Anders Carlsson258a1e32010-02-14 00:16:19 +00001674 // FIXME: We should not use / 8 here.
Anders Carlssondb042202010-02-17 03:11:55 +00001675 int64_t OffsetToTop = -(int64_t)Base.getBaseOffset() / 8;
Anders Carlssone75aaa92010-02-13 22:05:23 +00001676 Components.push_back(VtableComponent::MakeOffsetToTop(OffsetToTop));
Anders Carlsson65b49782010-02-12 05:25:12 +00001677
1678 // Next, add the RTTI.
Anders Carlssone75aaa92010-02-13 22:05:23 +00001679 Components.push_back(VtableComponent::MakeRTTI(MostDerivedClass));
Anders Carlsson65b49782010-02-12 05:25:12 +00001680
Anders Carlssone8a97562010-02-12 07:43:48 +00001681 uint64_t AddressPoint = Components.size();
Anders Carlsson65b49782010-02-12 05:25:12 +00001682
1683 // Now go through all virtual member functions and add them.
Anders Carlssond46ed892010-02-27 16:18:19 +00001684 PrimaryBasesSetVectorTy PrimaryBases;
Anders Carlssona8796c62010-02-23 04:26:39 +00001685 AddMethods(Base, Base, PrimaryBases);
Anders Carlsson65b49782010-02-12 05:25:12 +00001686
Anders Carlsson40687982010-02-27 16:52:49 +00001687 // Compute 'this' pointer adjustments.
1688 ComputeThisAdjustments();
1689
Anders Carlssone8a97562010-02-12 07:43:48 +00001690 // Record the address point.
1691 AddressPoints.insert(std::make_pair(Base, AddressPoint));
1692
1693 // Record the address points for all primary bases.
Anders Carlssond46ed892010-02-27 16:18:19 +00001694 for (PrimaryBasesSetVectorTy::const_iterator I = PrimaryBases.begin(),
Anders Carlssone8a97562010-02-12 07:43:48 +00001695 E = PrimaryBases.end(); I != E; ++I) {
1696 const CXXRecordDecl *BaseDecl = *I;
1697
1698 // We know that all the primary bases have the same offset as the base
1699 // subobject.
1700 BaseSubobject PrimaryBase(BaseDecl, Base.getBaseOffset());
1701 AddressPoints.insert(std::make_pair(PrimaryBase, AddressPoint));
1702 }
1703
Anders Carlssona9f633b2010-02-24 16:43:12 +00001704 // Layout secondary vtables.
1705 LayoutSecondaryVtables(Base);
Anders Carlsson14157932010-02-16 16:02:57 +00001706}
1707
1708void VtableBuilder::LayoutSecondaryVtables(BaseSubobject Base) {
1709 // Itanium C++ ABI 2.5.2:
1710 // Following the primary virtual table of a derived class are secondary
1711 // virtual tables for each of its proper base classes, except any primary
1712 // base(s) with which it shares its primary virtual table.
1713
1714 const CXXRecordDecl *RD = Base.getBase();
Anders Carlsson65b49782010-02-12 05:25:12 +00001715 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1716 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
Anders Carlsson14157932010-02-16 16:02:57 +00001717
Anders Carlsson65b49782010-02-12 05:25:12 +00001718 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1719 E = RD->bases_end(); I != E; ++I) {
Anders Carlsson14157932010-02-16 16:02:57 +00001720 // Ignore virtual bases, we'll emit them later.
1721 if (I->isVirtual())
1722 continue;
1723
Anders Carlsson65b49782010-02-12 05:25:12 +00001724 const CXXRecordDecl *BaseDecl =
1725 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson033d4862010-02-14 17:05:59 +00001726
Anders Carlssondc2dba32010-02-16 04:49:44 +00001727 // Ignore bases that don't have a vtable.
1728 if (!BaseDecl->isDynamicClass())
1729 continue;
Anders Carlsson033d4862010-02-14 17:05:59 +00001730
Anders Carlssone75aaa92010-02-13 22:05:23 +00001731 // Get the base offset of this base.
1732 uint64_t BaseOffset = Base.getBaseOffset() +
1733 Layout.getBaseClassOffset(BaseDecl);
Anders Carlsson14157932010-02-16 16:02:57 +00001734
1735 // Don't emit a secondary vtable for a primary base. We might however want
1736 // to emit secondary vtables for other bases of this base.
1737 if (BaseDecl == PrimaryBase) {
1738 LayoutSecondaryVtables(BaseSubobject(BaseDecl, BaseOffset));
1739 continue;
1740 }
Anders Carlssone75aaa92010-02-13 22:05:23 +00001741
Anders Carlssonb716a542010-02-16 16:26:28 +00001742 // Layout the primary vtable (and any secondary vtables) for this base.
Anders Carlssondb042202010-02-17 03:11:55 +00001743 LayoutPrimaryAndAndSecondaryVtables(BaseSubobject(BaseDecl, BaseOffset),
1744 /*BaseIsVirtual=*/false);
Anders Carlsson65b49782010-02-12 05:25:12 +00001745 }
1746}
1747
Anders Carlsson13f0f662010-02-16 16:49:35 +00001748void
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001749VtableBuilder::DeterminePrimaryVirtualBases(const CXXRecordDecl *RD,
1750 VisitedVirtualBasesSetTy &VBases) {
1751 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1752
1753 // Check if this base has a primary base.
1754 if (const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase()) {
1755 // Check if it's virtual
1756 if (Layout.getPrimaryBaseWasVirtual())
1757 PrimaryVirtualBases.insert(PrimaryBase);
1758 }
1759
1760 // Traverse bases, looking for more primary virtual bases.
1761 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1762 E = RD->bases_end(); I != E; ++I) {
1763 const CXXRecordDecl *BaseDecl =
1764 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1765
1766 if (I->isVirtual() && !VBases.insert(BaseDecl))
1767 continue;
1768
1769 DeterminePrimaryVirtualBases(BaseDecl, VBases);
1770 }
1771}
1772
1773void
Anders Carlsson13f0f662010-02-16 16:49:35 +00001774VtableBuilder::LayoutVtablesForVirtualBases(const CXXRecordDecl *RD,
1775 VisitedVirtualBasesSetTy &VBases) {
1776 // Itanium C++ ABI 2.5.2:
1777 // Then come the virtual base virtual tables, also in inheritance graph
1778 // order, and again excluding primary bases (which share virtual tables with
1779 // the classes for which they are primary).
Anders Carlsson13f0f662010-02-16 16:49:35 +00001780 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1781 E = RD->bases_end(); I != E; ++I) {
1782 const CXXRecordDecl *BaseDecl =
1783 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1784
Anders Carlsson0570f712010-02-23 03:48:14 +00001785 // Check if this base needs a vtable. (If it's virtual, not a primary base
1786 // of some other class, and we haven't visited it before).
Anders Carlsson13f0f662010-02-16 16:49:35 +00001787 if (I->isVirtual() && BaseDecl->isDynamicClass() &&
Anders Carlssonb08aaa32010-02-27 04:05:52 +00001788 !PrimaryVirtualBases.count(BaseDecl) && VBases.insert(BaseDecl)) {
Anders Carlsson13f0f662010-02-16 16:49:35 +00001789 const ASTRecordLayout &MostDerivedClassLayout =
1790 Context.getASTRecordLayout(MostDerivedClass);
1791 uint64_t BaseOffset =
1792 MostDerivedClassLayout.getVBaseClassOffset(BaseDecl);
1793
Anders Carlssondb042202010-02-17 03:11:55 +00001794 LayoutPrimaryAndAndSecondaryVtables(BaseSubobject(BaseDecl, BaseOffset),
1795 /*BaseIsVirtual=*/true);
Anders Carlsson13f0f662010-02-16 16:49:35 +00001796 }
1797
1798 // We only need to check the base for virtual base vtables if it actually
1799 // has virtual bases.
1800 if (BaseDecl->getNumVBases())
1801 LayoutVtablesForVirtualBases(BaseDecl, VBases);
1802 }
1803}
1804
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001805/// dumpLayout - Dump the vtable layout.
1806void VtableBuilder::dumpLayout(llvm::raw_ostream& Out) {
1807
1808 Out << "Vtable for '" << MostDerivedClass->getQualifiedNameAsString();
1809 Out << "' (" << Components.size() << " entries).\n";
1810
Anders Carlsson932c2f22010-02-11 17:18:51 +00001811 // Iterate through the address points and insert them into a new map where
1812 // they are keyed by the index and not the base object.
1813 // Since an address point can be shared by multiple subobjects, we use an
1814 // STL multimap.
1815 std::multimap<uint64_t, BaseSubobject> AddressPointsByIndex;
1816 for (CGVtableInfo::AddressPointsMapTy::const_iterator I =
1817 AddressPoints.begin(), E = AddressPoints.end(); I != E; ++I) {
1818 const BaseSubobject& Base = I->first;
1819 uint64_t Index = I->second;
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001820
Anders Carlsson932c2f22010-02-11 17:18:51 +00001821 AddressPointsByIndex.insert(std::make_pair(Index, Base));
1822 }
1823
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001824 unsigned NextReturnAdjustmentIndex = 0;
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001825 unsigned NextThisAdjustmentIndex = 0;
Anders Carlsson932c2f22010-02-11 17:18:51 +00001826 for (unsigned I = 0, E = Components.size(); I != E; ++I) {
Anders Carlssone8a97562010-02-12 07:43:48 +00001827 uint64_t Index = I;
1828
Anders Carlsson932c2f22010-02-11 17:18:51 +00001829 if (AddressPointsByIndex.count(I)) {
Anders Carlssone8a97562010-02-12 07:43:48 +00001830 if (AddressPointsByIndex.count(Index) == 1) {
1831 const BaseSubobject &Base = AddressPointsByIndex.find(Index)->second;
1832
1833 // FIXME: Instead of dividing by 8, we should be using CharUnits.
1834 Out << " -- (" << Base.getBase()->getQualifiedNameAsString();
1835 Out << ", " << Base.getBaseOffset() / 8 << ") vtable address --\n";
1836 } else {
1837 uint64_t BaseOffset =
1838 AddressPointsByIndex.lower_bound(Index)->second.getBaseOffset();
1839
1840 // We store the class names in a set to get a stable order.
1841 std::set<std::string> ClassNames;
1842 for (std::multimap<uint64_t, BaseSubobject>::const_iterator I =
1843 AddressPointsByIndex.lower_bound(Index), E =
1844 AddressPointsByIndex.upper_bound(Index); I != E; ++I) {
1845 assert(I->second.getBaseOffset() == BaseOffset &&
1846 "Invalid base offset!");
1847 const CXXRecordDecl *RD = I->second.getBase();
1848 ClassNames.insert(RD->getQualifiedNameAsString());
1849 }
1850
1851 for (std::set<std::string>::const_iterator I = ClassNames.begin(),
1852 E = ClassNames.end(); I != E; ++I) {
1853 // FIXME: Instead of dividing by 8, we should be using CharUnits.
1854 Out << " -- (" << *I;
1855 Out << ", " << BaseOffset / 8 << ") vtable address --\n";
1856 }
1857 }
Anders Carlsson932c2f22010-02-11 17:18:51 +00001858 }
1859
1860 Out << llvm::format("%4d | ", I);
1861
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001862 const VtableComponent &Component = Components[I];
1863
1864 // Dump the component.
1865 switch (Component.getKind()) {
Anders Carlssonb0a588f2010-02-17 06:07:19 +00001866
1867 case VtableComponent::CK_VCallOffset:
1868 Out << "vcall_offset (" << Component.getVCallOffset() << ")";
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001869 break;
Anders Carlsson77904f12010-02-16 04:59:55 +00001870
1871 case VtableComponent::CK_VBaseOffset:
1872 Out << "vbase_offset (" << Component.getVBaseOffset() << ")";
1873 break;
1874
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001875 case VtableComponent::CK_OffsetToTop:
1876 Out << "offset_to_top (" << Component.getOffsetToTop() << ")";
1877 break;
1878
1879 case VtableComponent::CK_RTTI:
1880 Out << Component.getRTTIDecl()->getQualifiedNameAsString() << " RTTI";
1881 break;
1882
Anders Carlsson5bd8d192010-02-11 18:20:28 +00001883 case VtableComponent::CK_FunctionPointer: {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001884 const CXXMethodDecl *MD = Component.getFunctionDecl();
1885
Anders Carlsson5bd8d192010-02-11 18:20:28 +00001886 std::string Str =
1887 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
1888 MD);
1889 Out << Str;
Anders Carlsson09da3372010-02-12 02:38:13 +00001890 if (MD->isPure())
1891 Out << " [pure]";
1892
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001893 // If this function pointer has a return adjustment, dump it.
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001894 if (NextReturnAdjustmentIndex < ReturnAdjustments.size() &&
1895 ReturnAdjustments[NextReturnAdjustmentIndex].first == I) {
1896 const ReturnAdjustment Adjustment =
1897 ReturnAdjustments[NextReturnAdjustmentIndex].second;
1898
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001899 Out << "\n [return adjustment: ";
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001900 Out << Adjustment.NonVirtual << " non-virtual";
1901
1902 if (Adjustment.VBaseOffsetOffset)
1903 Out << ", " << Adjustment.VBaseOffsetOffset << " vbase offset offset";
Anders Carlsson78277c72010-02-18 17:00:09 +00001904
Anders Carlssoncf5a8822010-02-13 21:07:32 +00001905 Out << ']';
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001906
1907 NextReturnAdjustmentIndex++;
1908 }
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001909
1910 // If this function pointer has a 'this' pointer adjustment, dump it.
1911 if (NextThisAdjustmentIndex < ThisAdjustments.size() &&
1912 ThisAdjustments[NextThisAdjustmentIndex].first == I) {
1913 const ThisAdjustment Adjustment =
1914 ThisAdjustments[NextThisAdjustmentIndex].second;
1915
1916 Out << "\n [this adjustment: ";
1917 Out << Adjustment.NonVirtual << " non-virtual";
Anders Carlsson78277c72010-02-18 17:00:09 +00001918
1919 if (Adjustment.VCallOffsetOffset)
1920 Out << ", " << Adjustment.VCallOffsetOffset << " vcall offset offset";
1921
Anders Carlssond3adb0c2010-02-13 23:40:17 +00001922 Out << ']';
1923
1924 NextThisAdjustmentIndex++;
1925 }
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00001926
Anders Carlsson5bd8d192010-02-11 18:20:28 +00001927 break;
1928 }
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001929
Anders Carlsson2d3d9032010-02-19 06:03:53 +00001930 case VtableComponent::CK_CompleteDtorPointer:
Anders Carlsson5bd8d192010-02-11 18:20:28 +00001931 case VtableComponent::CK_DeletingDtorPointer: {
Anders Carlsson2d3d9032010-02-19 06:03:53 +00001932 bool IsComplete =
1933 Component.getKind() == VtableComponent::CK_CompleteDtorPointer;
1934
Anders Carlsson5bd8d192010-02-11 18:20:28 +00001935 const CXXDestructorDecl *DD = Component.getDestructorDecl();
1936
Anders Carlsson2d3d9032010-02-19 06:03:53 +00001937 Out << DD->getQualifiedNameAsString();
1938 if (IsComplete)
1939 Out << "() [complete]";
1940 else
1941 Out << "() [deleting]";
1942
Anders Carlsson09da3372010-02-12 02:38:13 +00001943 if (DD->isPure())
1944 Out << " [pure]";
1945
Anders Carlsson2d3d9032010-02-19 06:03:53 +00001946 // If this destructor has a 'this' pointer adjustment, dump it.
1947 if (NextThisAdjustmentIndex < ThisAdjustments.size() &&
1948 ThisAdjustments[NextThisAdjustmentIndex].first == I) {
1949 const ThisAdjustment Adjustment =
1950 ThisAdjustments[NextThisAdjustmentIndex].second;
1951
1952 Out << "\n [this adjustment: ";
1953 Out << Adjustment.NonVirtual << " non-virtual";
1954
1955 if (Adjustment.VCallOffsetOffset)
1956 Out << ", " << Adjustment.VCallOffsetOffset << " vcall offset offset";
1957
1958 Out << ']';
1959
1960 NextThisAdjustmentIndex++;
1961 }
1962
1963
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001964 break;
1965 }
1966
Anders Carlsson350b56e2010-02-19 20:08:13 +00001967 case VtableComponent::CK_UnusedFunctionPointer: {
1968 const CXXMethodDecl *MD = Component.getUnusedFunctionDecl();
1969
1970 std::string Str =
1971 PredefinedExpr::ComputeName(PredefinedExpr::PrettyFunctionNoVirtual,
1972 MD);
1973 Out << "[unused] " << Str;
1974 if (MD->isPure())
1975 Out << " [pure]";
1976 }
1977
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001978 }
Anders Carlsson932c2f22010-02-11 17:18:51 +00001979
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00001980 Out << '\n';
1981 }
1982
1983}
1984
1985}
1986
1987namespace {
1988class OldVtableBuilder {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001989public:
1990 /// Index_t - Vtable index type.
1991 typedef uint64_t Index_t;
Eli Friedman31bc3ad2009-12-07 23:56:34 +00001992 typedef std::vector<std::pair<GlobalDecl,
1993 std::pair<GlobalDecl, ThunkAdjustment> > >
1994 SavedAdjustmentsVectorTy;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00001995private:
Anders Carlsson472404f2009-12-04 16:19:30 +00001996
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00001997 // VtableComponents - The components of the vtable being built.
1998 typedef llvm::SmallVector<llvm::Constant *, 64> VtableComponentsVectorTy;
1999 VtableComponentsVectorTy VtableComponents;
2000
Eli Friedman6c08ce72009-12-05 01:05:03 +00002001 const bool BuildVtable;
2002
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002003 llvm::Type *Ptr8Ty;
Anders Carlssonbad80eb2009-12-04 18:36:22 +00002004
2005 /// MostDerivedClass - The most derived class that this vtable is being
2006 /// built for.
2007 const CXXRecordDecl *MostDerivedClass;
2008
Mike Stump83066c82009-11-13 01:54:23 +00002009 /// LayoutClass - The most derived class used for virtual base layout
2010 /// information.
2011 const CXXRecordDecl *LayoutClass;
Mike Stump653d0b92009-11-13 02:13:54 +00002012 /// LayoutOffset - The offset for Class in LayoutClass.
2013 uint64_t LayoutOffset;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002014 /// BLayout - Layout for the most derived class that this vtable is being
2015 /// built for.
2016 const ASTRecordLayout &BLayout;
2017 llvm::SmallSet<const CXXRecordDecl *, 32> IndirectPrimary;
2018 llvm::SmallSet<const CXXRecordDecl *, 32> SeenVBase;
2019 llvm::Constant *rtti;
2020 llvm::LLVMContext &VMContext;
2021 CodeGenModule &CGM; // Per-module state.
Anders Carlssonf2f31f42009-12-04 03:46:21 +00002022
Mike Stump90181eb2010-01-26 00:05:04 +00002023 llvm::DenseMap<const CXXMethodDecl *, Index_t> VCall;
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002024 llvm::DenseMap<GlobalDecl, Index_t> VCallOffset;
Mike Stump77537b12010-01-26 03:42:22 +00002025 llvm::DenseMap<GlobalDecl, Index_t> VCallOffsetForVCall;
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002026 // This is the offset to the nearest virtual base
Mike Stump90181eb2010-01-26 00:05:04 +00002027 llvm::DenseMap<const CXXMethodDecl *, Index_t> NonVirtualOffset;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002028 llvm::DenseMap<const CXXRecordDecl *, Index_t> VBIndex;
Mike Stumpbb9ff052009-10-27 23:46:47 +00002029
Anders Carlsson323bb042009-11-26 19:54:33 +00002030 /// PureVirtualFunction - Points to __cxa_pure_virtual.
2031 llvm::Constant *PureVirtualFn;
2032
Anders Carlssona84b6e82009-12-04 02:01:07 +00002033 /// VtableMethods - A data structure for keeping track of methods in a vtable.
2034 /// Can add methods, override methods and iterate in vtable order.
2035 class VtableMethods {
2036 // MethodToIndexMap - Maps from a global decl to the index it has in the
2037 // Methods vector.
2038 llvm::DenseMap<GlobalDecl, uint64_t> MethodToIndexMap;
2039
2040 /// Methods - The methods, in vtable order.
2041 typedef llvm::SmallVector<GlobalDecl, 16> MethodsVectorTy;
2042 MethodsVectorTy Methods;
Eli Friedman8174f2c2009-12-06 22:01:30 +00002043 MethodsVectorTy OrigMethods;
Anders Carlssona84b6e82009-12-04 02:01:07 +00002044
2045 public:
2046 /// AddMethod - Add a method to the vtable methods.
2047 void AddMethod(GlobalDecl GD) {
2048 assert(!MethodToIndexMap.count(GD) &&
2049 "Method has already been added!");
2050
2051 MethodToIndexMap[GD] = Methods.size();
2052 Methods.push_back(GD);
Eli Friedman8174f2c2009-12-06 22:01:30 +00002053 OrigMethods.push_back(GD);
Anders Carlssona84b6e82009-12-04 02:01:07 +00002054 }
2055
2056 /// OverrideMethod - Replace a method with another.
2057 void OverrideMethod(GlobalDecl OverriddenGD, GlobalDecl GD) {
2058 llvm::DenseMap<GlobalDecl, uint64_t>::iterator i
2059 = MethodToIndexMap.find(OverriddenGD);
2060 assert(i != MethodToIndexMap.end() && "Did not find entry!");
2061
2062 // Get the index of the old decl.
2063 uint64_t Index = i->second;
2064
2065 // Replace the old decl with the new decl.
2066 Methods[Index] = GD;
2067
Anders Carlssona84b6e82009-12-04 02:01:07 +00002068 // And add the new.
2069 MethodToIndexMap[GD] = Index;
2070 }
2071
Anders Carlsson7bb70762009-12-04 15:49:02 +00002072 /// getIndex - Gives the index of a passed in GlobalDecl. Returns false if
2073 /// the index couldn't be found.
Benjamin Kramer62ab6162009-12-04 22:45:27 +00002074 bool getIndex(GlobalDecl GD, uint64_t &Index) const {
Anders Carlsson7bb70762009-12-04 15:49:02 +00002075 llvm::DenseMap<GlobalDecl, uint64_t>::const_iterator i
2076 = MethodToIndexMap.find(GD);
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002077
Anders Carlsson7bb70762009-12-04 15:49:02 +00002078 if (i == MethodToIndexMap.end())
2079 return false;
Anders Carlssone6096362009-12-04 03:41:37 +00002080
Anders Carlsson7bb70762009-12-04 15:49:02 +00002081 Index = i->second;
2082 return true;
Anders Carlssone6096362009-12-04 03:41:37 +00002083 }
2084
Eli Friedman8174f2c2009-12-06 22:01:30 +00002085 GlobalDecl getOrigMethod(uint64_t Index) const {
2086 return OrigMethods[Index];
2087 }
2088
Anders Carlssona84b6e82009-12-04 02:01:07 +00002089 MethodsVectorTy::size_type size() const {
2090 return Methods.size();
2091 }
2092
2093 void clear() {
2094 MethodToIndexMap.clear();
2095 Methods.clear();
Eli Friedman8174f2c2009-12-06 22:01:30 +00002096 OrigMethods.clear();
Anders Carlssona84b6e82009-12-04 02:01:07 +00002097 }
2098
Anders Carlssone6096362009-12-04 03:41:37 +00002099 GlobalDecl operator[](uint64_t Index) const {
Anders Carlssona84b6e82009-12-04 02:01:07 +00002100 return Methods[Index];
2101 }
2102 };
2103
2104 /// Methods - The vtable methods we're currently building.
2105 VtableMethods Methods;
2106
Anders Carlsson4c837d22009-12-04 02:26:15 +00002107 /// ThisAdjustments - For a given index in the vtable, contains the 'this'
2108 /// pointer adjustment needed for a method.
2109 typedef llvm::DenseMap<uint64_t, ThunkAdjustment> ThisAdjustmentsMapTy;
2110 ThisAdjustmentsMapTy ThisAdjustments;
Anders Carlssond420a312009-11-26 19:32:45 +00002111
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002112 SavedAdjustmentsVectorTy SavedAdjustments;
Eli Friedman8174f2c2009-12-06 22:01:30 +00002113
Anders Carlssonc521f952009-12-04 02:22:02 +00002114 /// BaseReturnTypes - Contains the base return types of methods who have been
2115 /// overridden with methods whose return types require adjustment. Used for
2116 /// generating covariant thunk information.
2117 typedef llvm::DenseMap<uint64_t, CanQualType> BaseReturnTypesMapTy;
2118 BaseReturnTypesMapTy BaseReturnTypes;
Anders Carlssond420a312009-11-26 19:32:45 +00002119
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002120 std::vector<Index_t> VCalls;
Mike Stump2cefe382009-11-12 20:47:57 +00002121
2122 typedef std::pair<const CXXRecordDecl *, uint64_t> CtorVtable_t;
Mike Stumpcd2b8212009-11-19 20:52:19 +00002123 // subAddressPoints - Used to hold the AddressPoints (offsets) into the built
2124 // vtable for use in computing the initializers for the VTT.
2125 llvm::DenseMap<CtorVtable_t, int64_t> &subAddressPoints;
Mike Stump2cefe382009-11-12 20:47:57 +00002126
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002127 /// AddressPoints - Address points for this vtable.
2128 CGVtableInfo::AddressPointsMapTy& AddressPoints;
2129
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002130 typedef CXXRecordDecl::method_iterator method_iter;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002131 const uint32_t LLVMPointerWidth;
2132 Index_t extra;
Mike Stump37dbe962009-10-15 02:04:03 +00002133 typedef std::vector<std::pair<const CXXRecordDecl *, int64_t> > Path_t;
Mike Stumpcd2b8212009-11-19 20:52:19 +00002134 static llvm::DenseMap<CtorVtable_t, int64_t>&
2135 AllocAddressPoint(CodeGenModule &cgm, const CXXRecordDecl *l,
2136 const CXXRecordDecl *c) {
Anders Carlsson93a18842010-01-02 18:02:32 +00002137 CGVtableInfo::AddrMap_t *&oref = cgm.getVtableInfo().AddressPoints[l];
Mike Stumpcd2b8212009-11-19 20:52:19 +00002138 if (oref == 0)
Anders Carlsson93a18842010-01-02 18:02:32 +00002139 oref = new CGVtableInfo::AddrMap_t;
Mike Stumpcd2b8212009-11-19 20:52:19 +00002140
2141 llvm::DenseMap<CtorVtable_t, int64_t> *&ref = (*oref)[c];
2142 if (ref == 0)
2143 ref = new llvm::DenseMap<CtorVtable_t, int64_t>;
2144 return *ref;
2145 }
Anders Carlsson323bb042009-11-26 19:54:33 +00002146
Mike Stump90181eb2010-01-26 00:05:04 +00002147 bool DclIsSame(const FunctionDecl *New, const FunctionDecl *Old) {
2148 FunctionTemplateDecl *OldTemplate = Old->getDescribedFunctionTemplate();
2149 FunctionTemplateDecl *NewTemplate = New->getDescribedFunctionTemplate();
2150
2151 // C++ [temp.fct]p2:
2152 // A function template can be overloaded with other function templates
2153 // and with normal (non-template) functions.
2154 if ((OldTemplate == 0) != (NewTemplate == 0))
2155 return false;
2156
2157 // Is the function New an overload of the function Old?
2158 QualType OldQType = CGM.getContext().getCanonicalType(Old->getType());
2159 QualType NewQType = CGM.getContext().getCanonicalType(New->getType());
2160
2161 // Compare the signatures (C++ 1.3.10) of the two functions to
2162 // determine whether they are overloads. If we find any mismatch
2163 // in the signature, they are overloads.
2164
2165 // If either of these functions is a K&R-style function (no
2166 // prototype), then we consider them to have matching signatures.
2167 if (isa<FunctionNoProtoType>(OldQType.getTypePtr()) ||
2168 isa<FunctionNoProtoType>(NewQType.getTypePtr()))
2169 return true;
2170
2171 FunctionProtoType* OldType = cast<FunctionProtoType>(OldQType);
2172 FunctionProtoType* NewType = cast<FunctionProtoType>(NewQType);
2173
2174 // The signature of a function includes the types of its
2175 // parameters (C++ 1.3.10), which includes the presence or absence
2176 // of the ellipsis; see C++ DR 357).
2177 if (OldQType != NewQType &&
2178 (OldType->getNumArgs() != NewType->getNumArgs() ||
2179 OldType->isVariadic() != NewType->isVariadic() ||
2180 !std::equal(OldType->arg_type_begin(), OldType->arg_type_end(),
2181 NewType->arg_type_begin())))
2182 return false;
2183
2184#if 0
2185 // C++ [temp.over.link]p4:
2186 // The signature of a function template consists of its function
2187 // signature, its return type and its template parameter list. The names
2188 // of the template parameters are significant only for establishing the
2189 // relationship between the template parameters and the rest of the
2190 // signature.
2191 //
2192 // We check the return type and template parameter lists for function
2193 // templates first; the remaining checks follow.
2194 if (NewTemplate &&
2195 (!TemplateParameterListsAreEqual(NewTemplate->getTemplateParameters(),
2196 OldTemplate->getTemplateParameters(),
2197 TPL_TemplateMatch) ||
2198 OldType->getResultType() != NewType->getResultType()))
2199 return false;
2200#endif
2201
2202 // If the function is a class member, its signature includes the
2203 // cv-qualifiers (if any) on the function itself.
2204 //
2205 // As part of this, also check whether one of the member functions
2206 // is static, in which case they are not overloads (C++
2207 // 13.1p2). While not part of the definition of the signature,
2208 // this check is important to determine whether these functions
2209 // can be overloaded.
2210 const CXXMethodDecl* OldMethod = dyn_cast<CXXMethodDecl>(Old);
2211 const CXXMethodDecl* NewMethod = dyn_cast<CXXMethodDecl>(New);
2212 if (OldMethod && NewMethod &&
2213 !OldMethod->isStatic() && !NewMethod->isStatic() &&
2214 OldMethod->getTypeQualifiers() != NewMethod->getTypeQualifiers())
2215 return false;
2216
2217 // The signatures match; this is not an overload.
2218 return true;
2219 }
2220
2221 typedef llvm::DenseMap<const CXXMethodDecl *, const CXXMethodDecl*>
2222 ForwardUnique_t;
2223 ForwardUnique_t ForwardUnique;
2224 llvm::DenseMap<const CXXMethodDecl*, const CXXMethodDecl*> UniqueOverrider;
2225
2226 void BuildUniqueOverrider(const CXXMethodDecl *U, const CXXMethodDecl *MD) {
2227 const CXXMethodDecl *PrevU = UniqueOverrider[MD];
2228 assert(U && "no unique overrider");
2229 if (PrevU == U)
2230 return;
2231 if (PrevU != U && PrevU != 0) {
2232 // If already set, note the two sets as the same
2233 if (0)
2234 printf("%s::%s same as %s::%s\n",
Douglas Gregor76eb74a2010-02-22 16:44:27 +00002235 PrevU->getParent()->getNameAsString().c_str(),
2236 PrevU->getNameAsString().c_str(),
2237 U->getParent()->getNameAsString().c_str(),
2238 U->getNameAsString().c_str());
Mike Stump90181eb2010-01-26 00:05:04 +00002239 ForwardUnique[PrevU] = U;
2240 return;
2241 }
2242
2243 // Not set, set it now
2244 if (0)
2245 printf("marking %s::%s %p override as %s::%s\n",
Douglas Gregor76eb74a2010-02-22 16:44:27 +00002246 MD->getParent()->getNameAsString().c_str(),
2247 MD->getNameAsString().c_str(),
Mike Stump90181eb2010-01-26 00:05:04 +00002248 (void*)MD,
Douglas Gregor76eb74a2010-02-22 16:44:27 +00002249 U->getParent()->getNameAsString().c_str(),
2250 U->getNameAsString().c_str());
Mike Stump90181eb2010-01-26 00:05:04 +00002251 UniqueOverrider[MD] = U;
2252
2253 for (CXXMethodDecl::method_iterator mi = MD->begin_overridden_methods(),
2254 me = MD->end_overridden_methods(); mi != me; ++mi) {
2255 BuildUniqueOverrider(U, *mi);
2256 }
2257 }
2258
2259 void BuildUniqueOverriders(const CXXRecordDecl *RD) {
2260 if (0) printf("walking %s\n", RD->getNameAsCString());
2261 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
2262 e = RD->method_end(); i != e; ++i) {
2263 const CXXMethodDecl *MD = *i;
2264 if (!MD->isVirtual())
2265 continue;
2266
2267 if (UniqueOverrider[MD] == 0) {
2268 // Only set this, if it hasn't been set yet.
2269 BuildUniqueOverrider(MD, MD);
2270 if (0)
2271 printf("top set is %s::%s %p\n",
Douglas Gregor76eb74a2010-02-22 16:44:27 +00002272 MD->getParent()->getNameAsString().c_str(),
2273 MD->getNameAsString().c_str(),
Mike Stump90181eb2010-01-26 00:05:04 +00002274 (void*)MD);
2275 ForwardUnique[MD] = MD;
2276 }
2277 }
2278 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
2279 e = RD->bases_end(); i != e; ++i) {
2280 const CXXRecordDecl *Base =
2281 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
2282 BuildUniqueOverriders(Base);
2283 }
2284 }
2285
2286 static int DclCmp(const void *p1, const void *p2) {
John McCallef3057c2010-02-13 01:04:05 +00002287 const CXXMethodDecl *MD1 = *(const CXXMethodDecl *const *)p1;
2288 const CXXMethodDecl *MD2 = *(const CXXMethodDecl *const *)p2;
2289
2290 return (DeclarationName::compare(MD1->getDeclName(), MD2->getDeclName()));
Mike Stump90181eb2010-01-26 00:05:04 +00002291 }
2292
2293 void MergeForwarding() {
2294 typedef llvm::SmallVector<const CXXMethodDecl *, 100> A_t;
2295 A_t A;
2296 for (ForwardUnique_t::iterator I = ForwardUnique.begin(),
2297 E = ForwardUnique.end(); I != E; ++I) {
2298 if (I->first == I->second)
2299 // Only add the roots of all trees
2300 A.push_back(I->first);
2301 }
2302 llvm::array_pod_sort(A.begin(), A.end(), DclCmp);
2303 for (A_t::iterator I = A.begin(),
2304 E = A.end(); I != E; ++I) {
2305 A_t::iterator J = I;
John McCallef3057c2010-02-13 01:04:05 +00002306 while (++J != E && DclCmp(I, J) == 0)
Mike Stump90181eb2010-01-26 00:05:04 +00002307 if (DclIsSame(*I, *J)) {
Douglas Gregor76eb74a2010-02-22 16:44:27 +00002308 if (0) printf("connecting %s\n", (*I)->getNameAsString().c_str());
Mike Stump90181eb2010-01-26 00:05:04 +00002309 ForwardUnique[*J] = *I;
2310 }
2311 }
2312 }
2313
2314 const CXXMethodDecl *getUnique(const CXXMethodDecl *MD) {
2315 const CXXMethodDecl *U = UniqueOverrider[MD];
2316 assert(U && "unique overrider not found");
2317 while (ForwardUnique.count(U)) {
2318 const CXXMethodDecl *NU = ForwardUnique[U];
2319 if (NU == U) break;
2320 U = NU;
2321 }
2322 return U;
2323 }
Anders Carlsson72281172010-01-26 17:36:47 +00002324
2325 GlobalDecl getUnique(GlobalDecl GD) {
2326 const CXXMethodDecl *Unique = getUnique(cast<CXXMethodDecl>(GD.getDecl()));
2327
2328 if (const CXXConstructorDecl *CD = dyn_cast<CXXConstructorDecl>(Unique))
2329 return GlobalDecl(CD, GD.getCtorType());
2330
2331 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(Unique))
2332 return GlobalDecl(DD, GD.getDtorType());
2333
2334 return Unique;
Mike Stump90181eb2010-01-26 00:05:04 +00002335 }
2336
Anders Carlsson323bb042009-11-26 19:54:33 +00002337 /// getPureVirtualFn - Return the __cxa_pure_virtual function.
2338 llvm::Constant* getPureVirtualFn() {
2339 if (!PureVirtualFn) {
2340 const llvm::FunctionType *Ty =
2341 llvm::FunctionType::get(llvm::Type::getVoidTy(VMContext),
2342 /*isVarArg=*/false);
2343 PureVirtualFn = wrap(CGM.CreateRuntimeFunction(Ty, "__cxa_pure_virtual"));
2344 }
2345
2346 return PureVirtualFn;
2347 }
2348
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002349public:
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002350 OldVtableBuilder(const CXXRecordDecl *MostDerivedClass,
Eli Friedman6c08ce72009-12-05 01:05:03 +00002351 const CXXRecordDecl *l, uint64_t lo, CodeGenModule &cgm,
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002352 bool build, CGVtableInfo::AddressPointsMapTy& AddressPoints)
Eli Friedman6c08ce72009-12-05 01:05:03 +00002353 : BuildVtable(build), MostDerivedClass(MostDerivedClass), LayoutClass(l),
2354 LayoutOffset(lo), BLayout(cgm.getContext().getASTRecordLayout(l)),
2355 rtti(0), VMContext(cgm.getModule().getContext()),CGM(cgm),
2356 PureVirtualFn(0),
Anders Carlssonbad80eb2009-12-04 18:36:22 +00002357 subAddressPoints(AllocAddressPoint(cgm, l, MostDerivedClass)),
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002358 AddressPoints(AddressPoints),
2359 LLVMPointerWidth(cgm.getContext().Target.getPointerWidth(0))
2360 {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002361 Ptr8Ty = llvm::PointerType::get(llvm::Type::getInt8Ty(VMContext), 0);
Anders Carlsson3f4336c2009-12-17 07:09:17 +00002362 if (BuildVtable) {
2363 QualType ClassType = CGM.getContext().getTagDeclType(MostDerivedClass);
2364 rtti = CGM.GetAddrOfRTTIDescriptor(ClassType);
2365 }
Mike Stump90181eb2010-01-26 00:05:04 +00002366 BuildUniqueOverriders(MostDerivedClass);
2367 MergeForwarding();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002368 }
2369
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002370 // getVtableComponents - Returns a reference to the vtable components.
2371 const VtableComponentsVectorTy &getVtableComponents() const {
2372 return VtableComponents;
Anders Carlsson472404f2009-12-04 16:19:30 +00002373 }
2374
Anders Carlssone36a6b32010-01-02 01:01:18 +00002375 llvm::DenseMap<const CXXRecordDecl *, uint64_t> &getVBIndex()
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002376 { return VBIndex; }
2377
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002378 SavedAdjustmentsVectorTy &getSavedAdjustments()
2379 { return SavedAdjustments; }
Eli Friedman8174f2c2009-12-06 22:01:30 +00002380
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002381 llvm::Constant *wrap(Index_t i) {
2382 llvm::Constant *m;
2383 m = llvm::ConstantInt::get(llvm::Type::getInt64Ty(VMContext), i);
2384 return llvm::ConstantExpr::getIntToPtr(m, Ptr8Ty);
2385 }
2386
2387 llvm::Constant *wrap(llvm::Constant *m) {
2388 return llvm::ConstantExpr::getBitCast(m, Ptr8Ty);
2389 }
2390
Mike Stumpd2808442010-01-22 02:51:26 +00002391//#define D1(x)
Douglas Gregorf4f2e022010-02-22 16:48:26 +00002392#define D1(X) do { if (getenv("CLANG_VTABLE_DEBUG")) { X; } } while (0)
Mike Stump75ce5732009-10-31 20:06:59 +00002393
2394 void GenerateVBaseOffsets(const CXXRecordDecl *RD, uint64_t Offset,
Mike Stump28431212009-10-13 22:54:56 +00002395 bool updateVBIndex, Index_t current_vbindex) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002396 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
2397 e = RD->bases_end(); i != e; ++i) {
2398 const CXXRecordDecl *Base =
2399 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Mike Stump28431212009-10-13 22:54:56 +00002400 Index_t next_vbindex = current_vbindex;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002401 if (i->isVirtual() && !SeenVBase.count(Base)) {
2402 SeenVBase.insert(Base);
Mike Stump28431212009-10-13 22:54:56 +00002403 if (updateVBIndex) {
Mike Stump75ce5732009-10-31 20:06:59 +00002404 next_vbindex = (ssize_t)(-(VCalls.size()*LLVMPointerWidth/8)
Mike Stump28431212009-10-13 22:54:56 +00002405 - 3*LLVMPointerWidth/8);
2406 VBIndex[Base] = next_vbindex;
2407 }
Mike Stump75ce5732009-10-31 20:06:59 +00002408 int64_t BaseOffset = -(Offset/8) + BLayout.getVBaseClassOffset(Base)/8;
2409 VCalls.push_back((0?700:0) + BaseOffset);
2410 D1(printf(" vbase for %s at %d delta %d most derived %s\n",
2411 Base->getNameAsCString(),
2412 (int)-VCalls.size()-3, (int)BaseOffset,
Mike Stumpd2808442010-01-22 02:51:26 +00002413 MostDerivedClass->getNameAsCString()));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002414 }
Mike Stump28431212009-10-13 22:54:56 +00002415 // We also record offsets for non-virtual bases to closest enclosing
2416 // virtual base. We do this so that we don't have to search
2417 // for the nearst virtual base class when generating thunks.
2418 if (updateVBIndex && VBIndex.count(Base) == 0)
2419 VBIndex[Base] = next_vbindex;
Mike Stump75ce5732009-10-31 20:06:59 +00002420 GenerateVBaseOffsets(Base, Offset, updateVBIndex, next_vbindex);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002421 }
2422 }
2423
2424 void StartNewTable() {
2425 SeenVBase.clear();
2426 }
2427
Mike Stump8bccbfd2009-10-15 09:30:16 +00002428 Index_t getNVOffset_1(const CXXRecordDecl *D, const CXXRecordDecl *B,
2429 Index_t Offset = 0) {
2430
2431 if (B == D)
2432 return Offset;
2433
2434 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(D);
2435 for (CXXRecordDecl::base_class_const_iterator i = D->bases_begin(),
2436 e = D->bases_end(); i != e; ++i) {
2437 const CXXRecordDecl *Base =
2438 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
2439 int64_t BaseOffset = 0;
2440 if (!i->isVirtual())
2441 BaseOffset = Offset + Layout.getBaseClassOffset(Base);
2442 int64_t o = getNVOffset_1(Base, B, BaseOffset);
2443 if (o >= 0)
2444 return o;
2445 }
2446
2447 return -1;
2448 }
2449
2450 /// getNVOffset - Returns the non-virtual offset for the given (B) base of the
2451 /// derived class D.
2452 Index_t getNVOffset(QualType qB, QualType qD) {
Mike Stump46271322009-11-03 19:03:17 +00002453 qD = qD->getPointeeType();
2454 qB = qB->getPointeeType();
Mike Stump8bccbfd2009-10-15 09:30:16 +00002455 CXXRecordDecl *D = cast<CXXRecordDecl>(qD->getAs<RecordType>()->getDecl());
2456 CXXRecordDecl *B = cast<CXXRecordDecl>(qB->getAs<RecordType>()->getDecl());
2457 int64_t o = getNVOffset_1(D, B);
2458 if (o >= 0)
2459 return o;
2460
2461 assert(false && "FIXME: non-virtual base not found");
2462 return 0;
2463 }
2464
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002465 /// getVbaseOffset - Returns the index into the vtable for the virtual base
2466 /// offset for the given (B) virtual base of the derived class D.
2467 Index_t getVbaseOffset(QualType qB, QualType qD) {
Mike Stump46271322009-11-03 19:03:17 +00002468 qD = qD->getPointeeType();
2469 qB = qB->getPointeeType();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002470 CXXRecordDecl *D = cast<CXXRecordDecl>(qD->getAs<RecordType>()->getDecl());
2471 CXXRecordDecl *B = cast<CXXRecordDecl>(qB->getAs<RecordType>()->getDecl());
Anders Carlssonbad80eb2009-12-04 18:36:22 +00002472 if (D != MostDerivedClass)
Eli Friedman03aa2f12009-11-30 01:19:33 +00002473 return CGM.getVtableInfo().getVirtualBaseOffsetIndex(D, B);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002474 llvm::DenseMap<const CXXRecordDecl *, Index_t>::iterator i;
2475 i = VBIndex.find(B);
2476 if (i != VBIndex.end())
2477 return i->second;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002478
Mike Stump28431212009-10-13 22:54:56 +00002479 assert(false && "FIXME: Base not found");
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002480 return 0;
2481 }
2482
Eli Friedman81fb0d22009-12-04 08:40:51 +00002483 bool OverrideMethod(GlobalDecl GD, bool MorallyVirtual,
2484 Index_t OverrideOffset, Index_t Offset,
2485 int64_t CurrentVBaseOffset);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002486
Anders Carlsson495634e2009-12-04 02:39:04 +00002487 /// AppendMethods - Append the current methods to the vtable.
Anders Carlssonddf42c82009-12-04 02:56:03 +00002488 void AppendMethodsToVtable();
Anders Carlsson495634e2009-12-04 02:39:04 +00002489
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002490 llvm::Constant *WrapAddrOf(GlobalDecl GD) {
2491 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2492
Anders Carlsson64457732009-11-24 05:08:52 +00002493 const llvm::Type *Ty = CGM.getTypes().GetFunctionTypeForVtable(MD);
Mike Stump18e8b472009-10-27 23:36:26 +00002494
Mike Stumpcdeb8002009-12-03 16:55:20 +00002495 return wrap(CGM.GetAddrOfFunction(GD, Ty));
Mike Stump18e8b472009-10-27 23:36:26 +00002496 }
2497
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002498 void OverrideMethods(Path_t *Path, bool MorallyVirtual, int64_t Offset,
2499 int64_t CurrentVBaseOffset) {
Mike Stump37dbe962009-10-15 02:04:03 +00002500 for (Path_t::reverse_iterator i = Path->rbegin(),
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002501 e = Path->rend(); i != e; ++i) {
2502 const CXXRecordDecl *RD = i->first;
Mike Stump8bccbfd2009-10-15 09:30:16 +00002503 int64_t OverrideOffset = i->second;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002504 for (method_iter mi = RD->method_begin(), me = RD->method_end(); mi != me;
2505 ++mi) {
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002506 const CXXMethodDecl *MD = *mi;
2507
2508 if (!MD->isVirtual())
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002509 continue;
2510
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002511 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2512 // Override both the complete and the deleting destructor.
2513 GlobalDecl CompDtor(DD, Dtor_Complete);
Eli Friedman81fb0d22009-12-04 08:40:51 +00002514 OverrideMethod(CompDtor, MorallyVirtual, OverrideOffset, Offset,
2515 CurrentVBaseOffset);
2516
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002517 GlobalDecl DeletingDtor(DD, Dtor_Deleting);
Eli Friedman81fb0d22009-12-04 08:40:51 +00002518 OverrideMethod(DeletingDtor, MorallyVirtual, OverrideOffset, Offset,
2519 CurrentVBaseOffset);
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002520 } else {
Eli Friedman81fb0d22009-12-04 08:40:51 +00002521 OverrideMethod(MD, MorallyVirtual, OverrideOffset, Offset,
2522 CurrentVBaseOffset);
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002523 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002524 }
2525 }
2526 }
2527
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002528 void AddMethod(const GlobalDecl GD, bool MorallyVirtual, Index_t Offset,
Eli Friedman03aa2f12009-11-30 01:19:33 +00002529 int64_t CurrentVBaseOffset) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002530 // If we can find a previously allocated slot for this, reuse it.
Eli Friedman81fb0d22009-12-04 08:40:51 +00002531 if (OverrideMethod(GD, MorallyVirtual, Offset, Offset,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002532 CurrentVBaseOffset))
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002533 return;
2534
Mike Stump1f49d652010-01-22 18:48:47 +00002535 D1(printf(" vfn for %s at %d\n",
Douglas Gregor76eb74a2010-02-22 16:44:27 +00002536 dyn_cast<CXXMethodDecl>(GD.getDecl())->getNameAsString().c_str(),
Mike Stump1f49d652010-01-22 18:48:47 +00002537 (int)Methods.size()));
2538
Anders Carlssoncdf18982009-12-04 02:08:24 +00002539 // We didn't find an entry in the vtable that we could use, add a new
2540 // entry.
2541 Methods.AddMethod(GD);
2542
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002543 VCallOffset[GD] = Offset/8 - CurrentVBaseOffset/8;
2544
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002545 if (MorallyVirtual) {
Anders Carlsson72281172010-01-26 17:36:47 +00002546 GlobalDecl UGD = getUnique(GD);
2547 const CXXMethodDecl *UMD = cast<CXXMethodDecl>(UGD.getDecl());
2548
Mike Stump90181eb2010-01-26 00:05:04 +00002549 assert(UMD && "final overrider not found");
2550
2551 Index_t &idx = VCall[UMD];
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002552 // Allocate the first one, after that, we reuse the previous one.
2553 if (idx == 0) {
Anders Carlsson72281172010-01-26 17:36:47 +00002554 VCallOffsetForVCall[UGD] = Offset/8;
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002555 NonVirtualOffset[UMD] = Offset/8 - CurrentVBaseOffset/8;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002556 idx = VCalls.size()+1;
Mike Stump90181eb2010-01-26 00:05:04 +00002557 VCalls.push_back(Offset/8 - CurrentVBaseOffset/8);
Mike Stump75ce5732009-10-31 20:06:59 +00002558 D1(printf(" vcall for %s at %d with delta %d\n",
Douglas Gregor76eb74a2010-02-22 16:44:27 +00002559 dyn_cast<CXXMethodDecl>(GD.getDecl())->getNameAsString().c_str(),
Mike Stump90181eb2010-01-26 00:05:04 +00002560 (int)-VCalls.size()-3, (int)VCalls[idx-1]));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002561 }
2562 }
2563 }
2564
2565 void AddMethods(const CXXRecordDecl *RD, bool MorallyVirtual,
Eli Friedman03aa2f12009-11-30 01:19:33 +00002566 Index_t Offset, int64_t CurrentVBaseOffset) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002567 for (method_iter mi = RD->method_begin(), me = RD->method_end(); mi != me;
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002568 ++mi) {
2569 const CXXMethodDecl *MD = *mi;
2570 if (!MD->isVirtual())
2571 continue;
2572
2573 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
2574 // For destructors, add both the complete and the deleting destructor
2575 // to the vtable.
2576 AddMethod(GlobalDecl(DD, Dtor_Complete), MorallyVirtual, Offset,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002577 CurrentVBaseOffset);
Eli Friedman03aa2f12009-11-30 01:19:33 +00002578 AddMethod(GlobalDecl(DD, Dtor_Deleting), MorallyVirtual, Offset,
2579 CurrentVBaseOffset);
2580 } else
2581 AddMethod(MD, MorallyVirtual, Offset, CurrentVBaseOffset);
Anders Carlssonfb4dda42009-11-13 17:08:56 +00002582 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002583 }
2584
2585 void NonVirtualBases(const CXXRecordDecl *RD, const ASTRecordLayout &Layout,
2586 const CXXRecordDecl *PrimaryBase,
2587 bool PrimaryBaseWasVirtual, bool MorallyVirtual,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002588 int64_t Offset, int64_t CurrentVBaseOffset,
2589 Path_t *Path) {
Mike Stump37dbe962009-10-15 02:04:03 +00002590 Path->push_back(std::make_pair(RD, Offset));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002591 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
2592 e = RD->bases_end(); i != e; ++i) {
2593 if (i->isVirtual())
2594 continue;
2595 const CXXRecordDecl *Base =
2596 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Mike Stump9eb76d42010-01-22 06:45:05 +00002597 uint64_t o = Offset + Layout.getBaseClassOffset(Base);
2598 StartNewTable();
2599 GenerateVtableForBase(Base, o, MorallyVirtual, false,
2600 true, Base == PrimaryBase && !PrimaryBaseWasVirtual,
2601 CurrentVBaseOffset, Path);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002602 }
Mike Stump37dbe962009-10-15 02:04:03 +00002603 Path->pop_back();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002604 }
2605
Mike Stumpb21c4ee2009-10-14 18:14:51 +00002606// #define D(X) do { X; } while (0)
2607#define D(X)
2608
2609 void insertVCalls(int InsertionPoint) {
Mike Stump75ce5732009-10-31 20:06:59 +00002610 D1(printf("============= combining vbase/vcall\n"));
Mike Stumpb21c4ee2009-10-14 18:14:51 +00002611 D(VCalls.insert(VCalls.begin(), 673));
2612 D(VCalls.push_back(672));
Eli Friedman6c08ce72009-12-05 01:05:03 +00002613
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002614 VtableComponents.insert(VtableComponents.begin() + InsertionPoint,
2615 VCalls.size(), 0);
Eli Friedman6c08ce72009-12-05 01:05:03 +00002616 if (BuildVtable) {
2617 // The vcalls come first...
2618 for (std::vector<Index_t>::reverse_iterator i = VCalls.rbegin(),
2619 e = VCalls.rend();
2620 i != e; ++i)
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002621 VtableComponents[InsertionPoint++] = wrap((0?600:0) + *i);
Eli Friedman6c08ce72009-12-05 01:05:03 +00002622 }
Mike Stumpb21c4ee2009-10-14 18:14:51 +00002623 VCalls.clear();
Mike Stump9f23a142009-11-10 02:30:51 +00002624 VCall.clear();
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002625 VCallOffsetForVCall.clear();
2626 VCallOffset.clear();
2627 NonVirtualOffset.clear();
Mike Stumpb21c4ee2009-10-14 18:14:51 +00002628 }
2629
Mike Stump559387f2009-11-13 23:13:20 +00002630 void AddAddressPoints(const CXXRecordDecl *RD, uint64_t Offset,
2631 Index_t AddressPoint) {
2632 D1(printf("XXX address point for %s in %s layout %s at offset %d is %d\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002633 RD->getNameAsCString(), MostDerivedClass->getNameAsCString(),
Mike Stump559387f2009-11-13 23:13:20 +00002634 LayoutClass->getNameAsCString(), (int)Offset, (int)AddressPoint));
Mike Stumpcd2b8212009-11-19 20:52:19 +00002635 subAddressPoints[std::make_pair(RD, Offset)] = AddressPoint;
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002636 AddressPoints[BaseSubobject(RD, Offset)] = AddressPoint;
Mike Stump559387f2009-11-13 23:13:20 +00002637
2638 // Now also add the address point for all our primary bases.
2639 while (1) {
2640 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
2641 RD = Layout.getPrimaryBase();
2642 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
2643 // FIXME: Double check this.
2644 if (RD == 0)
2645 break;
2646 if (PrimaryBaseWasVirtual &&
2647 BLayout.getVBaseClassOffset(RD) != Offset)
2648 break;
2649 D1(printf("XXX address point for %s in %s layout %s at offset %d is %d\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002650 RD->getNameAsCString(), MostDerivedClass->getNameAsCString(),
Mike Stump559387f2009-11-13 23:13:20 +00002651 LayoutClass->getNameAsCString(), (int)Offset, (int)AddressPoint));
Mike Stumpcd2b8212009-11-19 20:52:19 +00002652 subAddressPoints[std::make_pair(RD, Offset)] = AddressPoint;
Anders Carlsson5f9a8812010-01-14 02:29:07 +00002653 AddressPoints[BaseSubobject(RD, Offset)] = AddressPoint;
Mike Stump559387f2009-11-13 23:13:20 +00002654 }
2655 }
2656
2657
Mike Stumpd538a6d2009-12-24 07:29:41 +00002658 void FinishGenerateVtable(const CXXRecordDecl *RD,
2659 const ASTRecordLayout &Layout,
2660 const CXXRecordDecl *PrimaryBase,
Mike Stump9eb76d42010-01-22 06:45:05 +00002661 bool ForNPNVBases, bool WasPrimaryBase,
Mike Stumpd538a6d2009-12-24 07:29:41 +00002662 bool PrimaryBaseWasVirtual,
2663 bool MorallyVirtual, int64_t Offset,
2664 bool ForVirtualBase, int64_t CurrentVBaseOffset,
2665 Path_t *Path) {
Mike Stump37dbe962009-10-15 02:04:03 +00002666 bool alloc = false;
2667 if (Path == 0) {
2668 alloc = true;
2669 Path = new Path_t;
2670 }
2671
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002672 StartNewTable();
2673 extra = 0;
Mike Stump9eb76d42010-01-22 06:45:05 +00002674 Index_t AddressPoint = 0;
2675 int VCallInsertionPoint = 0;
2676 if (!ForNPNVBases || !WasPrimaryBase) {
2677 bool DeferVCalls = MorallyVirtual || ForVirtualBase;
2678 VCallInsertionPoint = VtableComponents.size();
2679 if (!DeferVCalls) {
2680 insertVCalls(VCallInsertionPoint);
2681 } else
2682 // FIXME: just for extra, or for all uses of VCalls.size post this?
2683 extra = -VCalls.size();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002684
Mike Stump9eb76d42010-01-22 06:45:05 +00002685 // Add the offset to top.
2686 VtableComponents.push_back(BuildVtable ? wrap(-((Offset-LayoutOffset)/8)) : 0);
Anders Carlsson472404f2009-12-04 16:19:30 +00002687
Mike Stump9eb76d42010-01-22 06:45:05 +00002688 // Add the RTTI information.
2689 VtableComponents.push_back(rtti);
Anders Carlsson472404f2009-12-04 16:19:30 +00002690
Mike Stump9eb76d42010-01-22 06:45:05 +00002691 AddressPoint = VtableComponents.size();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002692
Mike Stump9eb76d42010-01-22 06:45:05 +00002693 AppendMethodsToVtable();
2694 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002695
2696 // and then the non-virtual bases.
2697 NonVirtualBases(RD, Layout, PrimaryBase, PrimaryBaseWasVirtual,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002698 MorallyVirtual, Offset, CurrentVBaseOffset, Path);
Mike Stumpb21c4ee2009-10-14 18:14:51 +00002699
2700 if (ForVirtualBase) {
Mike Stump2cefe382009-11-12 20:47:57 +00002701 // FIXME: We're adding to VCalls in callers, we need to do the overrides
2702 // in the inner part, so that we know the complete set of vcalls during
2703 // the build and don't have to insert into methods. Saving out the
2704 // AddressPoint here, would need to be fixed, if we didn't do that. Also
2705 // retroactively adding vcalls for overrides later wind up in the wrong
2706 // place, the vcall slot has to be alloted during the walk of the base
2707 // when the function is first introduces.
Mike Stumpb21c4ee2009-10-14 18:14:51 +00002708 AddressPoint += VCalls.size();
Mike Stump2cefe382009-11-12 20:47:57 +00002709 insertVCalls(VCallInsertionPoint);
Mike Stumpb21c4ee2009-10-14 18:14:51 +00002710 }
2711
Mike Stump9eb76d42010-01-22 06:45:05 +00002712 if (!ForNPNVBases || !WasPrimaryBase)
2713 AddAddressPoints(RD, Offset, AddressPoint);
Mike Stump2cefe382009-11-12 20:47:57 +00002714
Mike Stump37dbe962009-10-15 02:04:03 +00002715 if (alloc) {
2716 delete Path;
2717 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002718 }
2719
Mike Stump75ce5732009-10-31 20:06:59 +00002720 void Primaries(const CXXRecordDecl *RD, bool MorallyVirtual, int64_t Offset,
2721 bool updateVBIndex, Index_t current_vbindex,
Eli Friedman03aa2f12009-11-30 01:19:33 +00002722 int64_t CurrentVBaseOffset) {
Mike Stump75ce5732009-10-31 20:06:59 +00002723 if (!RD->isDynamicClass())
2724 return;
2725
2726 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
2727 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
2728 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
2729
2730 // vtables are composed from the chain of primaries.
Eli Friedman65d87222009-12-04 08:52:11 +00002731 if (PrimaryBase && !PrimaryBaseWasVirtual) {
Mike Stump75ce5732009-10-31 20:06:59 +00002732 D1(printf(" doing primaries for %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002733 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Eli Friedman65d87222009-12-04 08:52:11 +00002734 Primaries(PrimaryBase, PrimaryBaseWasVirtual|MorallyVirtual, Offset,
2735 updateVBIndex, current_vbindex, CurrentVBaseOffset);
Mike Stump75ce5732009-10-31 20:06:59 +00002736 }
2737
2738 D1(printf(" doing vcall entries for %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002739 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Mike Stump75ce5732009-10-31 20:06:59 +00002740
2741 // And add the virtuals for the class to the primary vtable.
Eli Friedman03aa2f12009-11-30 01:19:33 +00002742 AddMethods(RD, MorallyVirtual, Offset, CurrentVBaseOffset);
Mike Stump75ce5732009-10-31 20:06:59 +00002743 }
2744
2745 void VBPrimaries(const CXXRecordDecl *RD, bool MorallyVirtual, int64_t Offset,
2746 bool updateVBIndex, Index_t current_vbindex,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002747 bool RDisVirtualBase, int64_t CurrentVBaseOffset,
Eli Friedman03aa2f12009-11-30 01:19:33 +00002748 bool bottom) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002749 if (!RD->isDynamicClass())
2750 return;
2751
2752 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
2753 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
2754 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
2755
2756 // vtables are composed from the chain of primaries.
2757 if (PrimaryBase) {
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002758 int BaseCurrentVBaseOffset = CurrentVBaseOffset;
2759 if (PrimaryBaseWasVirtual) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002760 IndirectPrimary.insert(PrimaryBase);
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002761 BaseCurrentVBaseOffset = BLayout.getVBaseClassOffset(PrimaryBase);
2762 }
Mike Stump75ce5732009-10-31 20:06:59 +00002763
2764 D1(printf(" doing primaries for %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002765 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Mike Stump75ce5732009-10-31 20:06:59 +00002766
2767 VBPrimaries(PrimaryBase, PrimaryBaseWasVirtual|MorallyVirtual, Offset,
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002768 updateVBIndex, current_vbindex, PrimaryBaseWasVirtual,
Eli Friedman03aa2f12009-11-30 01:19:33 +00002769 BaseCurrentVBaseOffset, false);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002770 }
2771
Mike Stump75ce5732009-10-31 20:06:59 +00002772 D1(printf(" doing vbase entries for %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002773 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Mike Stump75ce5732009-10-31 20:06:59 +00002774 GenerateVBaseOffsets(RD, Offset, updateVBIndex, current_vbindex);
2775
2776 if (RDisVirtualBase || bottom) {
2777 Primaries(RD, MorallyVirtual, Offset, updateVBIndex, current_vbindex,
Eli Friedman03aa2f12009-11-30 01:19:33 +00002778 CurrentVBaseOffset);
Mike Stump75ce5732009-10-31 20:06:59 +00002779 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002780 }
2781
Mike Stumpd538a6d2009-12-24 07:29:41 +00002782 void GenerateVtableForBase(const CXXRecordDecl *RD, int64_t Offset = 0,
2783 bool MorallyVirtual = false,
2784 bool ForVirtualBase = false,
Mike Stump9eb76d42010-01-22 06:45:05 +00002785 bool ForNPNVBases = false,
2786 bool WasPrimaryBase = true,
Mike Stumpd538a6d2009-12-24 07:29:41 +00002787 int CurrentVBaseOffset = 0,
2788 Path_t *Path = 0) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002789 if (!RD->isDynamicClass())
Mike Stumpd538a6d2009-12-24 07:29:41 +00002790 return;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002791
Mike Stumpfa818082009-11-13 02:35:38 +00002792 // Construction vtable don't need parts that have no virtual bases and
2793 // aren't morally virtual.
Anders Carlssonbad80eb2009-12-04 18:36:22 +00002794 if ((LayoutClass != MostDerivedClass) &&
2795 RD->getNumVBases() == 0 && !MorallyVirtual)
Mike Stumpd538a6d2009-12-24 07:29:41 +00002796 return;
Mike Stumpfa818082009-11-13 02:35:38 +00002797
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002798 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
2799 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
2800 const bool PrimaryBaseWasVirtual = Layout.getPrimaryBaseWasVirtual();
2801
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002802 extra = 0;
Mike Stump75ce5732009-10-31 20:06:59 +00002803 D1(printf("building entries for base %s most derived %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002804 RD->getNameAsCString(), MostDerivedClass->getNameAsCString()));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002805
Mike Stump75ce5732009-10-31 20:06:59 +00002806 if (ForVirtualBase)
2807 extra = VCalls.size();
2808
Mike Stump9eb76d42010-01-22 06:45:05 +00002809 if (!ForNPNVBases || !WasPrimaryBase) {
2810 VBPrimaries(RD, MorallyVirtual, Offset, !ForVirtualBase, 0,
2811 ForVirtualBase, CurrentVBaseOffset, true);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002812
Mike Stump9eb76d42010-01-22 06:45:05 +00002813 if (Path)
2814 OverrideMethods(Path, MorallyVirtual, Offset, CurrentVBaseOffset);
2815 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002816
Mike Stump9eb76d42010-01-22 06:45:05 +00002817 FinishGenerateVtable(RD, Layout, PrimaryBase, ForNPNVBases, WasPrimaryBase,
2818 PrimaryBaseWasVirtual, MorallyVirtual, Offset,
2819 ForVirtualBase, CurrentVBaseOffset, Path);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002820 }
2821
2822 void GenerateVtableForVBases(const CXXRecordDecl *RD,
2823 int64_t Offset = 0,
Mike Stump37dbe962009-10-15 02:04:03 +00002824 Path_t *Path = 0) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002825 bool alloc = false;
2826 if (Path == 0) {
2827 alloc = true;
Mike Stump37dbe962009-10-15 02:04:03 +00002828 Path = new Path_t;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002829 }
2830 // FIXME: We also need to override using all paths to a virtual base,
2831 // right now, we just process the first path
2832 Path->push_back(std::make_pair(RD, Offset));
2833 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
2834 e = RD->bases_end(); i != e; ++i) {
2835 const CXXRecordDecl *Base =
2836 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
2837 if (i->isVirtual() && !IndirectPrimary.count(Base)) {
2838 // Mark it so we don't output it twice.
2839 IndirectPrimary.insert(Base);
2840 StartNewTable();
Mike Stumpb21c4ee2009-10-14 18:14:51 +00002841 VCall.clear();
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002842 int64_t BaseOffset = BLayout.getVBaseClassOffset(Base);
Mike Stumpcd6f9ed2009-11-06 23:27:42 +00002843 int64_t CurrentVBaseOffset = BaseOffset;
Mike Stump75ce5732009-10-31 20:06:59 +00002844 D1(printf("vtable %s virtual base %s\n",
Mike Stumpd2808442010-01-22 02:51:26 +00002845 MostDerivedClass->getNameAsCString(), Base->getNameAsCString()));
Mike Stump9eb76d42010-01-22 06:45:05 +00002846 GenerateVtableForBase(Base, BaseOffset, true, true, false,
2847 true, CurrentVBaseOffset, Path);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002848 }
Mike Stump2cefe382009-11-12 20:47:57 +00002849 int64_t BaseOffset;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002850 if (i->isVirtual())
2851 BaseOffset = BLayout.getVBaseClassOffset(Base);
Mike Stump2cefe382009-11-12 20:47:57 +00002852 else {
2853 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
2854 BaseOffset = Offset + Layout.getBaseClassOffset(Base);
2855 }
2856
Mike Stump37dbe962009-10-15 02:04:03 +00002857 if (Base->getNumVBases()) {
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002858 GenerateVtableForVBases(Base, BaseOffset, Path);
Mike Stump37dbe962009-10-15 02:04:03 +00002859 }
Anders Carlsson2bb27f52009-10-11 22:13:54 +00002860 }
2861 Path->pop_back();
2862 if (alloc)
2863 delete Path;
2864 }
2865};
Anders Carlssonca1bf682009-12-03 01:54:02 +00002866} // end anonymous namespace
2867
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002868bool OldVtableBuilder::OverrideMethod(GlobalDecl GD, bool MorallyVirtual,
Eli Friedman81fb0d22009-12-04 08:40:51 +00002869 Index_t OverrideOffset, Index_t Offset,
2870 int64_t CurrentVBaseOffset) {
Anders Carlssonca1bf682009-12-03 01:54:02 +00002871 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
2872
2873 const bool isPure = MD->isPure();
Anders Carlsson21bbc1e2009-12-05 17:04:47 +00002874
Anders Carlssonca1bf682009-12-03 01:54:02 +00002875 // FIXME: Should OverrideOffset's be Offset?
2876
Anders Carlsson21bbc1e2009-12-05 17:04:47 +00002877 for (CXXMethodDecl::method_iterator mi = MD->begin_overridden_methods(),
2878 e = MD->end_overridden_methods(); mi != e; ++mi) {
Anders Carlssonca1bf682009-12-03 01:54:02 +00002879 GlobalDecl OGD;
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002880 GlobalDecl OGD2;
Anders Carlssonca1bf682009-12-03 01:54:02 +00002881
Anders Carlssonf3935b42009-12-04 05:51:56 +00002882 const CXXMethodDecl *OMD = *mi;
Anders Carlssonca1bf682009-12-03 01:54:02 +00002883 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(OMD))
2884 OGD = GlobalDecl(DD, GD.getDtorType());
2885 else
2886 OGD = OMD;
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002887
Eli Friedman8174f2c2009-12-06 22:01:30 +00002888 // Check whether this is the method being overridden in this section of
2889 // the vtable.
Anders Carlsson7bb70762009-12-04 15:49:02 +00002890 uint64_t Index;
2891 if (!Methods.getIndex(OGD, Index))
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002892 continue;
2893
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002894 OGD2 = OGD;
2895
Eli Friedman8174f2c2009-12-06 22:01:30 +00002896 // Get the original method, which we should be computing thunks, etc,
2897 // against.
2898 OGD = Methods.getOrigMethod(Index);
2899 OMD = cast<CXXMethodDecl>(OGD.getDecl());
2900
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002901 QualType ReturnType =
2902 MD->getType()->getAs<FunctionType>()->getResultType();
2903 QualType OverriddenReturnType =
2904 OMD->getType()->getAs<FunctionType>()->getResultType();
Anders Carlssonca1bf682009-12-03 01:54:02 +00002905
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002906 // Check if we need a return type adjustment.
Anders Carlssoncce9ee82010-02-13 23:17:31 +00002907 if (!ComputeReturnAdjustmentBaseOffset(CGM.getContext(), MD,
2908 OMD).isEmpty()) {
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002909 CanQualType &BaseReturnType = BaseReturnTypes[Index];
Anders Carlssonca1bf682009-12-03 01:54:02 +00002910
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002911 // Insert the base return type.
2912 if (BaseReturnType.isNull())
2913 BaseReturnType =
2914 CGM.getContext().getCanonicalType(OverriddenReturnType);
2915 }
Anders Carlssona93e9802009-12-04 03:52:52 +00002916
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002917 Methods.OverrideMethod(OGD, GD);
2918
Anders Carlsson72281172010-01-26 17:36:47 +00002919 GlobalDecl UGD = getUnique(GD);
2920 const CXXMethodDecl *UMD = cast<CXXMethodDecl>(UGD.getDecl());
2921 assert(UGD.getDecl() && "unique overrider not found");
2922 assert(UGD == getUnique(OGD) && "unique overrider not unique");
Mike Stump90181eb2010-01-26 00:05:04 +00002923
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002924 ThisAdjustments.erase(Index);
Mike Stump90181eb2010-01-26 00:05:04 +00002925 if (MorallyVirtual || VCall.count(UMD)) {
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002926
Mike Stump90181eb2010-01-26 00:05:04 +00002927 Index_t &idx = VCall[UMD];
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002928 if (idx == 0) {
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002929 VCallOffset[GD] = VCallOffset[OGD];
2930 // NonVirtualOffset[UMD] = CurrentVBaseOffset/8 - OverrideOffset/8;
2931 NonVirtualOffset[UMD] = VCallOffset[OGD];
Mike Stump77537b12010-01-26 03:42:22 +00002932 VCallOffsetForVCall[UMD] = OverrideOffset/8;
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002933 idx = VCalls.size()+1;
Mike Stump77537b12010-01-26 03:42:22 +00002934 VCalls.push_back(OverrideOffset/8 - CurrentVBaseOffset/8);
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002935 D1(printf(" vcall for %s at %d with delta %d most derived %s\n",
2936 MD->getNameAsString().c_str(), (int)-idx-3,
Mike Stumpd2808442010-01-22 02:51:26 +00002937 (int)VCalls[idx-1], MostDerivedClass->getNameAsCString()));
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002938 } else {
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002939 VCallOffset[GD] = NonVirtualOffset[UMD];
Anders Carlsson72281172010-01-26 17:36:47 +00002940 VCalls[idx-1] = -VCallOffsetForVCall[UGD] + OverrideOffset/8;
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002941 D1(printf(" vcall patch for %s at %d with delta %d most derived %s\n",
2942 MD->getNameAsString().c_str(), (int)-idx-3,
Mike Stumpd2808442010-01-22 02:51:26 +00002943 (int)VCalls[idx-1], MostDerivedClass->getNameAsCString()));
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002944 }
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002945 int64_t NonVirtualAdjustment = -VCallOffset[OGD];
Mike Stumpded0a402010-01-26 22:44:01 +00002946 QualType DerivedType = MD->getThisType(CGM.getContext());
2947 QualType BaseType = cast<const CXXMethodDecl>(OGD.getDecl())->getThisType(CGM.getContext());
2948 int64_t NonVirtualAdjustment2 = -(getNVOffset(BaseType, DerivedType)/8);
2949 if (NonVirtualAdjustment2 != NonVirtualAdjustment) {
2950 NonVirtualAdjustment = NonVirtualAdjustment2;
2951 }
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002952 int64_t VirtualAdjustment =
2953 -((idx + extra + 2) * LLVMPointerWidth / 8);
Anders Carlsson657f1392009-12-03 02:32:59 +00002954
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002955 // Optimize out virtual adjustments of 0.
2956 if (VCalls[idx-1] == 0)
2957 VirtualAdjustment = 0;
Anders Carlsson657f1392009-12-03 02:32:59 +00002958
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002959 ThunkAdjustment ThisAdjustment(NonVirtualAdjustment,
2960 VirtualAdjustment);
Anders Carlsson2ca285f2009-12-03 02:22:59 +00002961
Eli Friedman8174f2c2009-12-06 22:01:30 +00002962 if (!isPure && !ThisAdjustment.isEmpty()) {
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002963 ThisAdjustments[Index] = ThisAdjustment;
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002964 SavedAdjustments.push_back(
2965 std::make_pair(GD, std::make_pair(OGD, ThisAdjustment)));
Eli Friedman8174f2c2009-12-06 22:01:30 +00002966 }
Anders Carlssonca1bf682009-12-03 01:54:02 +00002967 return true;
2968 }
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002969
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002970 VCallOffset[GD] = VCallOffset[OGD2] - OverrideOffset/8;
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002971
Mike Stumpa04ecfb2010-01-26 21:35:27 +00002972 int64_t NonVirtualAdjustment = -VCallOffset[GD];
2973 QualType DerivedType = MD->getThisType(CGM.getContext());
2974 QualType BaseType = cast<const CXXMethodDecl>(OGD.getDecl())->getThisType(CGM.getContext());
2975 int64_t NonVirtualAdjustment2 = -(getNVOffset(BaseType, DerivedType)/8);
2976 if (NonVirtualAdjustment2 != NonVirtualAdjustment) {
2977 NonVirtualAdjustment = NonVirtualAdjustment2;
2978 }
2979
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002980 if (NonVirtualAdjustment) {
2981 ThunkAdjustment ThisAdjustment(NonVirtualAdjustment, 0);
2982
Eli Friedmanf2eda5e2009-12-06 22:33:51 +00002983 if (!isPure) {
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002984 ThisAdjustments[Index] = ThisAdjustment;
Eli Friedman31bc3ad2009-12-07 23:56:34 +00002985 SavedAdjustments.push_back(
2986 std::make_pair(GD, std::make_pair(OGD, ThisAdjustment)));
Eli Friedmanf2eda5e2009-12-06 22:33:51 +00002987 }
Eli Friedman3d2e9de2009-12-04 08:34:14 +00002988 }
2989 return true;
Anders Carlssonca1bf682009-12-03 01:54:02 +00002990 }
2991
2992 return false;
Anders Carlssond59885022009-11-27 22:21:51 +00002993}
2994
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00002995void OldVtableBuilder::AppendMethodsToVtable() {
Eli Friedman6c08ce72009-12-05 01:05:03 +00002996 if (!BuildVtable) {
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00002997 VtableComponents.insert(VtableComponents.end(), Methods.size(),
2998 (llvm::Constant *)0);
Eli Friedman6c08ce72009-12-05 01:05:03 +00002999 ThisAdjustments.clear();
3000 BaseReturnTypes.clear();
3001 Methods.clear();
3002 return;
3003 }
3004
Anders Carlsson472404f2009-12-04 16:19:30 +00003005 // Reserve room in the vtable for our new methods.
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00003006 VtableComponents.reserve(VtableComponents.size() + Methods.size());
Anders Carlssonb07567c2009-12-04 03:07:26 +00003007
Anders Carlsson86809cd2009-12-04 02:43:50 +00003008 for (unsigned i = 0, e = Methods.size(); i != e; ++i) {
3009 GlobalDecl GD = Methods[i];
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00003010 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
3011
3012 // Get the 'this' pointer adjustment.
Anders Carlsson86809cd2009-12-04 02:43:50 +00003013 ThunkAdjustment ThisAdjustment = ThisAdjustments.lookup(i);
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00003014
3015 // Construct the return type adjustment.
3016 ThunkAdjustment ReturnAdjustment;
3017
3018 QualType BaseReturnType = BaseReturnTypes.lookup(i);
3019 if (!BaseReturnType.isNull() && !MD->isPure()) {
3020 QualType DerivedType =
3021 MD->getType()->getAs<FunctionType>()->getResultType();
3022
3023 int64_t NonVirtualAdjustment =
3024 getNVOffset(BaseReturnType, DerivedType) / 8;
3025
3026 int64_t VirtualAdjustment =
3027 getVbaseOffset(BaseReturnType, DerivedType);
3028
3029 ReturnAdjustment = ThunkAdjustment(NonVirtualAdjustment,
3030 VirtualAdjustment);
3031 }
3032
Anders Carlsson50f14742009-12-04 03:06:03 +00003033 llvm::Constant *Method = 0;
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00003034 if (!ReturnAdjustment.isEmpty()) {
3035 // Build a covariant thunk.
3036 CovariantThunkAdjustment Adjustment(ThisAdjustment, ReturnAdjustment);
Eli Friedman8174f2c2009-12-06 22:01:30 +00003037 Method = wrap(CGM.GetAddrOfCovariantThunk(GD, Adjustment));
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00003038 } else if (!ThisAdjustment.isEmpty()) {
3039 // Build a "regular" thunk.
Eli Friedman8174f2c2009-12-06 22:01:30 +00003040 Method = wrap(CGM.GetAddrOfThunk(GD, ThisAdjustment));
Anders Carlssonddf42c82009-12-04 02:56:03 +00003041 } else if (MD->isPure()) {
3042 // We have a pure virtual method.
Anders Carlsson50f14742009-12-04 03:06:03 +00003043 Method = getPureVirtualFn();
3044 } else {
3045 // We have a good old regular method.
3046 Method = WrapAddrOf(GD);
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00003047 }
Anders Carlsson50f14742009-12-04 03:06:03 +00003048
3049 // Add the method to the vtable.
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00003050 VtableComponents.push_back(Method);
Anders Carlsson86809cd2009-12-04 02:43:50 +00003051 }
3052
Anders Carlsson50f14742009-12-04 03:06:03 +00003053
Anders Carlsson86809cd2009-12-04 02:43:50 +00003054 ThisAdjustments.clear();
Anders Carlsson5b3ea9b2009-12-04 02:52:22 +00003055 BaseReturnTypes.clear();
Anders Carlsson86809cd2009-12-04 02:43:50 +00003056
Anders Carlsson495634e2009-12-04 02:39:04 +00003057 Methods.clear();
Anders Carlsson495634e2009-12-04 02:39:04 +00003058}
3059
Anders Carlssonf942ee02009-11-27 20:47:55 +00003060void CGVtableInfo::ComputeMethodVtableIndices(const CXXRecordDecl *RD) {
3061
3062 // Itanium C++ ABI 2.5.2:
Anders Carlsson259688c2010-02-02 03:37:46 +00003063 // The order of the virtual function pointers in a virtual table is the
3064 // order of declaration of the corresponding member functions in the class.
Anders Carlssonf942ee02009-11-27 20:47:55 +00003065 //
Anders Carlsson259688c2010-02-02 03:37:46 +00003066 // There is an entry for any virtual function declared in a class,
3067 // whether it is a new function or overrides a base class function,
3068 // unless it overrides a function from the primary base, and conversion
3069 // between their return types does not require an adjustment.
Anders Carlssonf942ee02009-11-27 20:47:55 +00003070
3071 int64_t CurrentIndex = 0;
3072
3073 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
3074 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
3075
3076 if (PrimaryBase) {
Anders Carlssonc920fa22009-11-30 19:43:26 +00003077 assert(PrimaryBase->isDefinition() &&
3078 "Should have the definition decl of the primary base!");
Anders Carlssonf942ee02009-11-27 20:47:55 +00003079
3080 // Since the record decl shares its vtable pointer with the primary base
3081 // we need to start counting at the end of the primary base's vtable.
3082 CurrentIndex = getNumVirtualFunctionPointers(PrimaryBase);
3083 }
Eli Friedman21517252009-12-15 03:31:17 +00003084
3085 // Collect all the primary bases, so we can check whether methods override
3086 // a method from the base.
Anders Carlssond46ed892010-02-27 16:18:19 +00003087 VtableBuilder::PrimaryBasesSetVectorTy PrimaryBases;
Eli Friedman21517252009-12-15 03:31:17 +00003088 for (ASTRecordLayout::primary_base_info_iterator
3089 I = Layout.primary_base_begin(), E = Layout.primary_base_end();
3090 I != E; ++I)
3091 PrimaryBases.insert((*I).getBase());
3092
Anders Carlssonf942ee02009-11-27 20:47:55 +00003093 const CXXDestructorDecl *ImplicitVirtualDtor = 0;
3094
3095 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
3096 e = RD->method_end(); i != e; ++i) {
3097 const CXXMethodDecl *MD = *i;
3098
3099 // We only want virtual methods.
3100 if (!MD->isVirtual())
3101 continue;
3102
Anders Carlssonf942ee02009-11-27 20:47:55 +00003103 // Check if this method overrides a method in the primary base.
Anders Carlsson65b49782010-02-12 05:25:12 +00003104 if (const CXXMethodDecl *OverriddenMD =
Anders Carlssond2025412010-02-27 06:38:03 +00003105 OverridesMethodInBases(MD, PrimaryBases)) {
Anders Carlsson65b49782010-02-12 05:25:12 +00003106 // Check if converting from the return type of the method to the
3107 // return type of the overridden method requires conversion.
Anders Carlssoncce9ee82010-02-13 23:17:31 +00003108 if (ComputeReturnAdjustmentBaseOffset(CGM.getContext(), MD,
3109 OverriddenMD).isEmpty()) {
Anders Carlsson65b49782010-02-12 05:25:12 +00003110 // This index is shared between the index in the vtable of the primary
3111 // base class.
3112 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
3113 const CXXDestructorDecl *OverriddenDD =
3114 cast<CXXDestructorDecl>(OverriddenMD);
Anders Carlssonf942ee02009-11-27 20:47:55 +00003115
Anders Carlsson65b49782010-02-12 05:25:12 +00003116 // Add both the complete and deleting entries.
3117 MethodVtableIndices[GlobalDecl(DD, Dtor_Complete)] =
3118 getMethodVtableIndex(GlobalDecl(OverriddenDD, Dtor_Complete));
3119 MethodVtableIndices[GlobalDecl(DD, Dtor_Deleting)] =
3120 getMethodVtableIndex(GlobalDecl(OverriddenDD, Dtor_Deleting));
3121 } else {
3122 MethodVtableIndices[MD] = getMethodVtableIndex(OverriddenMD);
3123 }
3124
3125 // We don't need to add an entry for this method.
Anders Carlsson07604812010-02-12 18:14:46 +00003126 continue;
Anders Carlssonf942ee02009-11-27 20:47:55 +00003127 }
3128 }
3129
Anders Carlssonf942ee02009-11-27 20:47:55 +00003130 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) {
3131 if (MD->isImplicit()) {
3132 assert(!ImplicitVirtualDtor &&
3133 "Did already see an implicit virtual dtor!");
3134 ImplicitVirtualDtor = DD;
3135 continue;
3136 }
3137
3138 // Add the complete dtor.
3139 MethodVtableIndices[GlobalDecl(DD, Dtor_Complete)] = CurrentIndex++;
3140
3141 // Add the deleting dtor.
3142 MethodVtableIndices[GlobalDecl(DD, Dtor_Deleting)] = CurrentIndex++;
3143 } else {
3144 // Add the entry.
3145 MethodVtableIndices[MD] = CurrentIndex++;
3146 }
3147 }
3148
3149 if (ImplicitVirtualDtor) {
3150 // Itanium C++ ABI 2.5.2:
Anders Carlssondc2dba32010-02-16 04:49:44 +00003151 // If a class has an implicitly-defined virtual destructor,
3152 // its entries come after the declared virtual function pointers.
Anders Carlssonf942ee02009-11-27 20:47:55 +00003153
3154 // Add the complete dtor.
3155 MethodVtableIndices[GlobalDecl(ImplicitVirtualDtor, Dtor_Complete)] =
3156 CurrentIndex++;
3157
3158 // Add the deleting dtor.
3159 MethodVtableIndices[GlobalDecl(ImplicitVirtualDtor, Dtor_Deleting)] =
3160 CurrentIndex++;
3161 }
3162
3163 NumVirtualFunctionPointers[RD] = CurrentIndex;
3164}
3165
3166uint64_t CGVtableInfo::getNumVirtualFunctionPointers(const CXXRecordDecl *RD) {
3167 llvm::DenseMap<const CXXRecordDecl *, uint64_t>::iterator I =
3168 NumVirtualFunctionPointers.find(RD);
3169 if (I != NumVirtualFunctionPointers.end())
3170 return I->second;
3171
3172 ComputeMethodVtableIndices(RD);
3173
3174 I = NumVirtualFunctionPointers.find(RD);
3175 assert(I != NumVirtualFunctionPointers.end() && "Did not find entry!");
3176 return I->second;
3177}
3178
3179uint64_t CGVtableInfo::getMethodVtableIndex(GlobalDecl GD) {
Anders Carlssonfb4dda42009-11-13 17:08:56 +00003180 MethodVtableIndicesTy::iterator I = MethodVtableIndices.find(GD);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003181 if (I != MethodVtableIndices.end())
3182 return I->second;
3183
Anders Carlssonfb4dda42009-11-13 17:08:56 +00003184 const CXXRecordDecl *RD = cast<CXXMethodDecl>(GD.getDecl())->getParent();
Anders Carlssonf942ee02009-11-27 20:47:55 +00003185
3186 ComputeMethodVtableIndices(RD);
3187
Anders Carlssonfb4dda42009-11-13 17:08:56 +00003188 I = MethodVtableIndices.find(GD);
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003189 assert(I != MethodVtableIndices.end() && "Did not find index!");
3190 return I->second;
3191}
3192
Eli Friedman31bc3ad2009-12-07 23:56:34 +00003193CGVtableInfo::AdjustmentVectorTy*
3194CGVtableInfo::getAdjustments(GlobalDecl GD) {
3195 SavedAdjustmentsTy::iterator I = SavedAdjustments.find(GD);
3196 if (I != SavedAdjustments.end())
3197 return &I->second;
Eli Friedman8174f2c2009-12-06 22:01:30 +00003198
3199 const CXXRecordDecl *RD = cast<CXXRecordDecl>(GD.getDecl()->getDeclContext());
Eli Friedman31bc3ad2009-12-07 23:56:34 +00003200 if (!SavedAdjustmentRecords.insert(RD).second)
3201 return 0;
Eli Friedman8174f2c2009-12-06 22:01:30 +00003202
Anders Carlsson5f9a8812010-01-14 02:29:07 +00003203 AddressPointsMapTy AddressPoints;
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00003204 OldVtableBuilder b(RD, RD, 0, CGM, false, AddressPoints);
Eli Friedman8174f2c2009-12-06 22:01:30 +00003205 D1(printf("vtable %s\n", RD->getNameAsCString()));
3206 b.GenerateVtableForBase(RD);
3207 b.GenerateVtableForVBases(RD);
Eli Friedman8174f2c2009-12-06 22:01:30 +00003208
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00003209 for (OldVtableBuilder::SavedAdjustmentsVectorTy::iterator
Eli Friedman31bc3ad2009-12-07 23:56:34 +00003210 i = b.getSavedAdjustments().begin(),
3211 e = b.getSavedAdjustments().end(); i != e; i++)
3212 SavedAdjustments[i->first].push_back(i->second);
Eli Friedman8174f2c2009-12-06 22:01:30 +00003213
Eli Friedman31bc3ad2009-12-07 23:56:34 +00003214 I = SavedAdjustments.find(GD);
3215 if (I != SavedAdjustments.end())
3216 return &I->second;
3217
3218 return 0;
Eli Friedman8174f2c2009-12-06 22:01:30 +00003219}
3220
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003221int64_t CGVtableInfo::getVirtualBaseOffsetIndex(const CXXRecordDecl *RD,
3222 const CXXRecordDecl *VBase) {
3223 ClassPairTy ClassPair(RD, VBase);
3224
3225 VirtualBaseClassIndiciesTy::iterator I =
3226 VirtualBaseClassIndicies.find(ClassPair);
3227 if (I != VirtualBaseClassIndicies.end())
3228 return I->second;
3229
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003230 // FIXME: This seems expensive. Can we do a partial job to get
3231 // just this data.
Anders Carlsson5f9a8812010-01-14 02:29:07 +00003232 AddressPointsMapTy AddressPoints;
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00003233 OldVtableBuilder b(RD, RD, 0, CGM, false, AddressPoints);
Mike Stump75ce5732009-10-31 20:06:59 +00003234 D1(printf("vtable %s\n", RD->getNameAsCString()));
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003235 b.GenerateVtableForBase(RD);
3236 b.GenerateVtableForVBases(RD);
3237
3238 for (llvm::DenseMap<const CXXRecordDecl *, uint64_t>::iterator I =
3239 b.getVBIndex().begin(), E = b.getVBIndex().end(); I != E; ++I) {
3240 // Insert all types.
3241 ClassPairTy ClassPair(RD, I->first);
3242
3243 VirtualBaseClassIndicies.insert(std::make_pair(ClassPair, I->second));
3244 }
3245
3246 I = VirtualBaseClassIndicies.find(ClassPair);
Anders Carlsson6a6cbfc2010-02-13 20:11:51 +00003247 // FIXME: The assertion below assertion currently fails with the old vtable
3248 /// layout code if there is a non-virtual thunk adjustment in a vtable.
3249 // Once the new layout is in place, this return should be removed.
3250 if (I == VirtualBaseClassIndicies.end())
3251 return 0;
3252
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003253 assert(I != VirtualBaseClassIndicies.end() && "Did not find index!");
3254
3255 return I->second;
3256}
3257
Anders Carlssonc8e39ec2009-12-05 21:03:56 +00003258uint64_t CGVtableInfo::getVtableAddressPoint(const CXXRecordDecl *RD) {
3259 uint64_t AddressPoint =
Anders Carlsson93a18842010-01-02 18:02:32 +00003260 (*(*(CGM.getVtableInfo().AddressPoints[RD]))[RD])[std::make_pair(RD, 0)];
Anders Carlssonc8e39ec2009-12-05 21:03:56 +00003261
3262 return AddressPoint;
3263}
3264
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00003265llvm::GlobalVariable *
Anders Carlsson0911ae82009-12-06 00:23:49 +00003266CGVtableInfo::GenerateVtable(llvm::GlobalVariable::LinkageTypes Linkage,
Anders Carlsson232324c2009-12-06 00:53:22 +00003267 bool GenerateDefinition,
Anders Carlsson0911ae82009-12-06 00:23:49 +00003268 const CXXRecordDecl *LayoutClass,
Anders Carlsson5f9a8812010-01-14 02:29:07 +00003269 const CXXRecordDecl *RD, uint64_t Offset,
3270 AddressPointsMapTy& AddressPoints) {
Anders Carlsson1888b442010-02-14 00:22:59 +00003271 if (GenerateDefinition && CGM.getLangOptions().DumpVtableLayouts &&
3272 LayoutClass == RD) {
Anders Carlssoncf5a8822010-02-13 21:07:32 +00003273 VtableBuilder Builder(*this, RD);
Anders Carlssoneee53d92010-02-13 02:02:03 +00003274
3275 Builder.dumpLayout(llvm::errs());
3276 }
3277
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003278 llvm::SmallString<256> OutName;
Mike Stump2cefe382009-11-12 20:47:57 +00003279 if (LayoutClass != RD)
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00003280 CGM.getMangleContext().mangleCXXCtorVtable(LayoutClass, Offset / 8,
3281 RD, OutName);
Mike Stumpeac45592009-11-11 20:26:26 +00003282 else
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00003283 CGM.getMangleContext().mangleCXXVtable(RD, OutName);
Daniel Dunbare128dd12009-11-21 09:06:22 +00003284 llvm::StringRef Name = OutName.str();
Benjamin Kramerbb0a07b2009-10-11 22:57:54 +00003285
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00003286 llvm::GlobalVariable *GV = CGM.getModule().getGlobalVariable(Name);
Anders Carlsson93a18842010-01-02 18:02:32 +00003287 if (GV == 0 || CGM.getVtableInfo().AddressPoints[LayoutClass] == 0 ||
3288 GV->isDeclaration()) {
Anders Carlsson5d40c6f2010-02-11 08:02:13 +00003289 OldVtableBuilder b(RD, LayoutClass, Offset, CGM, GenerateDefinition,
3290 AddressPoints);
Eli Friedman6c08ce72009-12-05 01:05:03 +00003291
3292 D1(printf("vtable %s\n", RD->getNameAsCString()));
3293 // First comes the vtables for all the non-virtual bases...
Mike Stumpd538a6d2009-12-24 07:29:41 +00003294 b.GenerateVtableForBase(RD, Offset);
Eli Friedman6c08ce72009-12-05 01:05:03 +00003295
3296 // then the vtables for all the virtual bases.
3297 b.GenerateVtableForVBases(RD, Offset);
3298
Anders Carlsson58b271d2009-12-05 22:19:10 +00003299 llvm::Constant *Init = 0;
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00003300 const llvm::Type *Int8PtrTy = llvm::Type::getInt8PtrTy(CGM.getLLVMContext());
Anders Carlsson58b271d2009-12-05 22:19:10 +00003301 llvm::ArrayType *ArrayType =
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00003302 llvm::ArrayType::get(Int8PtrTy, b.getVtableComponents().size());
Anders Carlssona95d4c52009-12-05 21:09:05 +00003303
Anders Carlsson232324c2009-12-06 00:53:22 +00003304 if (GenerateDefinition)
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00003305 Init = llvm::ConstantArray::get(ArrayType, &b.getVtableComponents()[0],
3306 b.getVtableComponents().size());
Anders Carlsson232324c2009-12-06 00:53:22 +00003307
Mike Stumpaa51ad62009-11-19 04:04:36 +00003308 llvm::GlobalVariable *OGV = GV;
Anders Carlsson232324c2009-12-06 00:53:22 +00003309
3310 GV = new llvm::GlobalVariable(CGM.getModule(), ArrayType,
3311 /*isConstant=*/true, Linkage, Init, Name);
Anders Carlssonfe5f7d92009-12-06 01:09:21 +00003312 CGM.setGlobalVisibility(GV, RD);
3313
Mike Stumpaa51ad62009-11-19 04:04:36 +00003314 if (OGV) {
3315 GV->takeName(OGV);
Anders Carlsson58b271d2009-12-05 22:19:10 +00003316 llvm::Constant *NewPtr =
3317 llvm::ConstantExpr::getBitCast(GV, OGV->getType());
Mike Stumpaa51ad62009-11-19 04:04:36 +00003318 OGV->replaceAllUsesWith(NewPtr);
3319 OGV->eraseFromParent();
3320 }
Mike Stumpaa51ad62009-11-19 04:04:36 +00003321 }
Anders Carlssonb3f54b72009-12-05 21:28:12 +00003322
3323 return GV;
Anders Carlsson2bb27f52009-10-11 22:13:54 +00003324}
Mike Stump9f23a142009-11-10 02:30:51 +00003325
Anders Carlsson232324c2009-12-06 00:53:22 +00003326void CGVtableInfo::GenerateClassData(llvm::GlobalVariable::LinkageTypes Linkage,
3327 const CXXRecordDecl *RD) {
Anders Carlssone1b3e622009-12-07 07:59:52 +00003328 llvm::GlobalVariable *&Vtable = Vtables[RD];
3329 if (Vtable) {
3330 assert(Vtable->getInitializer() && "Vtable doesn't have a definition!");
3331 return;
3332 }
3333
Anders Carlsson5f9a8812010-01-14 02:29:07 +00003334 AddressPointsMapTy AddressPoints;
3335 Vtable = GenerateVtable(Linkage, /*GenerateDefinition=*/true, RD, RD, 0,
3336 AddressPoints);
Anders Carlssone36a6b32010-01-02 01:01:18 +00003337 GenerateVTT(Linkage, /*GenerateDefinition=*/true, RD);
Mike Stump1a139f82009-11-19 01:08:19 +00003338}
3339
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00003340llvm::GlobalVariable *CGVtableInfo::getVtable(const CXXRecordDecl *RD) {
Anders Carlsson232324c2009-12-06 00:53:22 +00003341 llvm::GlobalVariable *Vtable = Vtables.lookup(RD);
Anders Carlsson7e28c5f2009-12-06 00:01:05 +00003342
Anders Carlsson5f9a8812010-01-14 02:29:07 +00003343 if (!Vtable) {
3344 AddressPointsMapTy AddressPoints;
Anders Carlsson232324c2009-12-06 00:53:22 +00003345 Vtable = GenerateVtable(llvm::GlobalValue::ExternalLinkage,
Anders Carlsson5f9a8812010-01-14 02:29:07 +00003346 /*GenerateDefinition=*/false, RD, RD, 0,
3347 AddressPoints);
3348 }
Mike Stumpaa51ad62009-11-19 04:04:36 +00003349
Anders Carlsson4ed44eb2009-12-05 22:42:54 +00003350 return Vtable;
Mike Stumpd846d082009-11-10 07:44:33 +00003351}
Mike Stumpeac45592009-11-11 20:26:26 +00003352
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00003353void CGVtableInfo::MaybeEmitVtable(GlobalDecl GD) {
3354 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
3355 const CXXRecordDecl *RD = MD->getParent();
3356
Anders Carlsson4ed44eb2009-12-05 22:42:54 +00003357 // If the class doesn't have a vtable we don't need to emit one.
3358 if (!RD->isDynamicClass())
3359 return;
3360
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00003361 // Get the key function.
Anders Carlsson5ebf8b42009-12-07 04:35:11 +00003362 const CXXMethodDecl *KeyFunction = CGM.getContext().getKeyFunction(RD);
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00003363
Anders Carlsson4ed44eb2009-12-05 22:42:54 +00003364 if (KeyFunction) {
3365 // We don't have the right key function.
3366 if (KeyFunction->getCanonicalDecl() != MD->getCanonicalDecl())
3367 return;
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00003368 }
3369
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00003370 // Emit the data.
Douglas Gregorccecc1b2010-01-06 20:27:16 +00003371 GenerateClassData(CGM.getVtableLinkage(RD), RD);
Eli Friedman8174f2c2009-12-06 22:01:30 +00003372
3373 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
3374 e = RD->method_end(); i != e; ++i) {
Eli Friedman31bc3ad2009-12-07 23:56:34 +00003375 if ((*i)->isVirtual() && ((*i)->hasInlineBody() || (*i)->isImplicit())) {
Eli Friedman8174f2c2009-12-06 22:01:30 +00003376 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(*i)) {
3377 CGM.BuildThunksForVirtual(GlobalDecl(DD, Dtor_Complete));
3378 CGM.BuildThunksForVirtual(GlobalDecl(DD, Dtor_Deleting));
3379 } else {
3380 CGM.BuildThunksForVirtual(GlobalDecl(*i));
3381 }
3382 }
3383 }
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00003384}
3385