blob: 2882d64d1771110758e88f4689b29a05bd1cebbd [file] [log] [blame]
Anders Carlsson79474332009-07-18 20:20:21 +00001//=== ASTRecordLayoutBuilder.cpp - Helper class for building record layouts ==//
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#include "RecordLayoutBuilder.h"
11
12#include "clang/AST/Attr.h"
13#include "clang/AST/Decl.h"
Anders Carlsson6d9f6f32009-07-19 00:18:47 +000014#include "clang/AST/DeclCXX.h"
Anders Carlsson4f516282009-07-18 20:50:59 +000015#include "clang/AST/DeclObjC.h"
Anders Carlsson79474332009-07-18 20:20:21 +000016#include "clang/AST/Expr.h"
Anders Carlsson79474332009-07-18 20:20:21 +000017#include "clang/Basic/TargetInfo.h"
Mike Stumpd8fe7b22009-08-05 22:37:18 +000018#include <llvm/ADT/SmallSet.h>
Anders Carlsson79474332009-07-18 20:20:21 +000019#include <llvm/Support/MathExtras.h>
20
21using namespace clang;
22
Mike Stump11289f42009-09-09 15:08:12 +000023ASTRecordLayoutBuilder::ASTRecordLayoutBuilder(ASTContext &Ctx)
Anders Carlssonba958402009-11-22 19:13:51 +000024 : Ctx(Ctx), Size(0), Alignment(8), Packed(false), UnfilledBitsInLastByte(0),
25 MaxFieldAlignment(0), DataSize(0), IsUnion(false), NonVirtualSize(0),
Anders Carlsson8630b5b2010-03-11 00:15:35 +000026 NonVirtualAlignment(8), FirstNearlyEmptyVBase(0) { }
Mike Stump3dc7eb92009-07-30 00:22:38 +000027
Mike Stumpd8fe7b22009-08-05 22:37:18 +000028/// IsNearlyEmpty - Indicates when a class has a vtable pointer, but
29/// no other data.
Anders Carlsson81430692009-09-22 03:02:06 +000030bool ASTRecordLayoutBuilder::IsNearlyEmpty(const CXXRecordDecl *RD) const {
Mike Stumpd8fe7b22009-08-05 22:37:18 +000031 // FIXME: Audit the corners
32 if (!RD->isDynamicClass())
33 return false;
34 const ASTRecordLayout &BaseInfo = Ctx.getASTRecordLayout(RD);
35 if (BaseInfo.getNonVirtualSize() == Ctx.Target.getPointerWidth(0))
36 return true;
37 return false;
38}
39
Anders Carlsson81430692009-09-22 03:02:06 +000040void ASTRecordLayoutBuilder::IdentifyPrimaryBases(const CXXRecordDecl *RD) {
Anders Carlsson03ff3792009-11-27 22:05:05 +000041 const ASTRecordLayout::PrimaryBaseInfo &BaseInfo =
42 Ctx.getASTRecordLayout(RD).getPrimaryBaseInfo();
Anders Carlsson81430692009-09-22 03:02:06 +000043
44 // If the record has a primary base class that is virtual, add it to the set
45 // of primary bases.
Anders Carlssona30c0d32009-11-27 22:14:40 +000046 if (BaseInfo.isVirtual())
47 IndirectPrimaryBases.insert(BaseInfo.getBase());
Anders Carlsson81430692009-09-22 03:02:06 +000048
49 // Now traverse all bases and find primary bases for them.
Mike Stumpd8fe7b22009-08-05 22:37:18 +000050 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
51 e = RD->bases_end(); i != e; ++i) {
Sebastian Redl1054fae2009-10-25 17:03:50 +000052 assert(!i->getType()->isDependentType() &&
53 "Cannot layout class with dependent bases.");
Mike Stump11289f42009-09-09 15:08:12 +000054 const CXXRecordDecl *Base =
Mike Stump78696a72009-08-11 04:03:59 +000055 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson81430692009-09-22 03:02:06 +000056
Mike Stump78696a72009-08-11 04:03:59 +000057 // Only bases with virtual bases participate in computing the
58 // indirect primary virtual base classes.
Mike Stumpc2f591b2009-08-13 22:53:07 +000059 if (Base->getNumVBases())
Anders Carlsson81430692009-09-22 03:02:06 +000060 IdentifyPrimaryBases(Base);
Mike Stumpd8fe7b22009-08-05 22:37:18 +000061 }
62}
63
Anders Carlsson81430692009-09-22 03:02:06 +000064void
Anders Carlsson8630b5b2010-03-11 00:15:35 +000065ASTRecordLayoutBuilder::SelectPrimaryVBase(const CXXRecordDecl *RD) {
Anders Carlssonf2fa75b2010-03-11 03:39:12 +000066 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
67 E = RD->bases_end(); I != E; ++I) {
68 assert(!I->getType()->isDependentType() &&
Sebastian Redl1054fae2009-10-25 17:03:50 +000069 "Cannot layout class with dependent bases.");
Anders Carlssonf2fa75b2010-03-11 03:39:12 +000070
Mike Stump11289f42009-09-09 15:08:12 +000071 const CXXRecordDecl *Base =
Anders Carlssonf2fa75b2010-03-11 03:39:12 +000072 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson8630b5b2010-03-11 00:15:35 +000073
Anders Carlssonf2fa75b2010-03-11 03:39:12 +000074 // Check if this is a nearly empty virtual base.
75 if (I->isVirtual() && IsNearlyEmpty(Base)) {
76 // If it's not an indirect primary base, then we've found our primary
77 // base.
Anders Carlsson81430692009-09-22 03:02:06 +000078 if (!IndirectPrimaryBases.count(Base)) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +000079 PrimaryBase = ASTRecordLayout::PrimaryBaseInfo(Base,
80 /*IsVirtual=*/true);
Mike Stump6f3793b2009-08-12 21:50:08 +000081 return;
82 }
Anders Carlssonf2fa75b2010-03-11 03:39:12 +000083
84 // Is this the first nearly empty virtual base?
85 if (!FirstNearlyEmptyVBase)
86 FirstNearlyEmptyVBase = Base;
Mike Stump6f3793b2009-08-12 21:50:08 +000087 }
Anders Carlsson8630b5b2010-03-11 00:15:35 +000088
Anders Carlsson8630b5b2010-03-11 00:15:35 +000089 SelectPrimaryVBase(Base);
Zhongxing Xuec345b72010-02-15 04:28:35 +000090 if (PrimaryBase.getBase())
91 return;
Mike Stump6f3793b2009-08-12 21:50:08 +000092 }
93}
94
Anders Carlsson8630b5b2010-03-11 00:15:35 +000095/// DeterminePrimaryBase - Determine the primary base of the given class.
96void ASTRecordLayoutBuilder::DeterminePrimaryBase(const CXXRecordDecl *RD) {
97 // If the class isn't dynamic, it won't have a primary base.
98 if (!RD->isDynamicClass())
99 return;
100
Anders Carlsson81430692009-09-22 03:02:06 +0000101 // Compute all the primary virtual bases for all of our direct and
Mike Stump590a7c72009-08-13 23:26:06 +0000102 // indirect bases, and record all their primary virtual base classes.
Mike Stump590a7c72009-08-13 23:26:06 +0000103 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
104 e = RD->bases_end(); i != e; ++i) {
Sebastian Redl1054fae2009-10-25 17:03:50 +0000105 assert(!i->getType()->isDependentType() &&
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000106 "Cannot lay out class with dependent bases.");
Mike Stump11289f42009-09-09 15:08:12 +0000107 const CXXRecordDecl *Base =
Mike Stump590a7c72009-08-13 23:26:06 +0000108 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson81430692009-09-22 03:02:06 +0000109 IdentifyPrimaryBases(Base);
Mike Stump590a7c72009-08-13 23:26:06 +0000110 }
111
Anders Carlsson81430692009-09-22 03:02:06 +0000112 // If the record has a dynamic base class, attempt to choose a primary base
113 // class. It is the first (in direct base class order) non-virtual dynamic
114 // base class, if one exists.
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000115 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
116 e = RD->bases_end(); i != e; ++i) {
Anders Carlsson03ff3792009-11-27 22:05:05 +0000117 // Ignore virtual bases.
118 if (i->isVirtual())
119 continue;
120
121 const CXXRecordDecl *Base =
122 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
123
124 if (Base->isDynamicClass()) {
125 // We found it.
126 PrimaryBase = ASTRecordLayout::PrimaryBaseInfo(Base, /*IsVirtual=*/false);
127 return;
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000128 }
129 }
130
131 // Otherwise, it is the first nearly empty virtual base that is not an
Mike Stump78696a72009-08-11 04:03:59 +0000132 // indirect primary virtual base class, if one exists.
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000133 if (RD->getNumVBases() != 0) {
134 SelectPrimaryVBase(RD);
135 if (PrimaryBase.getBase())
136 return;
137 }
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000138
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000139 // Otherwise, it is the first nearly empty virtual base that is not an
140 // indirect primary virtual base class, if one exists.
141 if (FirstNearlyEmptyVBase) {
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000142 PrimaryBase = ASTRecordLayout::PrimaryBaseInfo(FirstNearlyEmptyVBase,
143 /*IsVirtual=*/true);
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000144 return;
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000145 }
Anders Carlsson81430692009-09-22 03:02:06 +0000146
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000147 // Otherwise there is no primary base class.
148 assert(!PrimaryBase.getBase() && "Should not get here with a primary base!");
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000149
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000150 // Allocate the virtual table pointer at offset zero.
151 assert(DataSize == 0 && "Vtable pointer must be at offset zero!");
152
153 // Update the size.
154 Size += Ctx.Target.getPointerWidth(0);
155 DataSize = Size;
156
157 // Update the alignment.
158 UpdateAlignment(Ctx.Target.getPointerAlign(0));
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000159}
160
Mike Stump2b84dd32009-11-05 04:02:15 +0000161uint64_t ASTRecordLayoutBuilder::getBaseOffset(const CXXRecordDecl *Base) {
Anders Carlsson6a848892010-03-11 04:10:39 +0000162 ASTRecordLayout::BaseOffsetsMapTy::iterator I = Bases.find(Base);
163 if (I != Bases.end())
164 return I->second;
165
166 I = VBases.find(Base);
167 if (I != VBases.end())
168 return I->second;
169
Mike Stump2b84dd32009-11-05 04:02:15 +0000170 assert(0 && "missing base");
171 return 0;
172}
173
Anders Carlsson09ffa322010-03-10 22:21:28 +0000174void
175ASTRecordLayoutBuilder::LayoutNonVirtualBases(const CXXRecordDecl *RD) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000176 // First, determine the primary base class.
177 DeterminePrimaryBase(RD);
178
179 // If we have a primary base class, lay it out.
180 if (const CXXRecordDecl *Base = PrimaryBase.getBase()) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000181 if (PrimaryBase.isVirtual()) {
182 // We have a virtual primary base, insert it as an indirect primary base.
183 IndirectPrimaryBases.insert(Base);
184
185 LayoutVirtualBase(Base);
186 } else
187 LayoutNonVirtualBase(Base);
188 }
189
190 // Now lay out the non-virtual bases.
191 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
192 E = RD->bases_end(); I != E; ++I) {
193
194 // Ignore virtual bases.
195 if (I->isVirtual())
196 continue;
197
198 const CXXRecordDecl *Base =
199 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
200
201 // Skip the primary base.
202 if (Base == PrimaryBase.getBase() && !PrimaryBase.isVirtual())
203 continue;
204
205 // Lay out the base.
206 LayoutNonVirtualBase(Base);
Anders Carlsson09ffa322010-03-10 22:21:28 +0000207 }
208}
209
210void ASTRecordLayoutBuilder::LayoutNonVirtualBase(const CXXRecordDecl *RD) {
Anders Carlsson0d0b5882010-03-10 22:26:24 +0000211 // Layout the base.
212 uint64_t Offset = LayoutBase(RD);
213
214 // Add its base class offset.
Anders Carlsson6a848892010-03-11 04:10:39 +0000215 if (!Bases.insert(std::make_pair(RD, Offset)).second)
216 assert(false && "Added same base offset more than once!");
Anders Carlsson09ffa322010-03-10 22:21:28 +0000217}
Mike Stump2b84dd32009-11-05 04:02:15 +0000218
Anders Carlsson6a848892010-03-11 04:10:39 +0000219void
220ASTRecordLayoutBuilder::LayoutVirtualBases(const CXXRecordDecl *Class,
221 const CXXRecordDecl *RD,
222 const CXXRecordDecl *PB,
223 uint64_t Offset) {
Mike Stumpc2f591b2009-08-13 22:53:07 +0000224 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
225 e = RD->bases_end(); i != e; ++i) {
Sebastian Redl1054fae2009-10-25 17:03:50 +0000226 assert(!i->getType()->isDependentType() &&
227 "Cannot layout class with dependent bases.");
Mike Stump11289f42009-09-09 15:08:12 +0000228 const CXXRecordDecl *Base =
Mike Stump6b2556f2009-08-06 13:41:24 +0000229 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Mike Stump2b84dd32009-11-05 04:02:15 +0000230 uint64_t BaseOffset = Offset;
Mike Stump22ea1f82009-08-16 01:46:26 +0000231 if (i->isVirtual()) {
Mike Stump996576f32009-08-16 19:04:13 +0000232 if (Base == PB) {
233 // Only lay things out once.
Anders Carlssonc4c00ec2010-03-11 02:41:30 +0000234 if (VisitedVirtualBases.count(Base))
Mike Stump996576f32009-08-16 19:04:13 +0000235 continue;
236 // Mark it so we don't lay it out twice.
Anders Carlssonc4c00ec2010-03-11 02:41:30 +0000237 VisitedVirtualBases.insert(Base);
Anders Carlssonaa87b4e2010-03-11 00:21:21 +0000238 assert (IndirectPrimaryBases.count(Base) && "IndirectPrimary was wrong");
Anders Carlsson6a848892010-03-11 04:10:39 +0000239
240 if (!VBases.insert(std::make_pair(Base, Offset)).second) {
241 // FIXME: Enable this assertion.
242 // assert(false && "Added same vbase offset more than once!");
243 }
Anders Carlssonaa87b4e2010-03-11 00:21:21 +0000244 } else if (IndirectPrimaryBases.count(Base)) {
Mike Stump996576f32009-08-16 19:04:13 +0000245 // Someone else will eventually lay this out.
246 ;
247 } else {
248 // Only lay things out once.
Anders Carlssonc4c00ec2010-03-11 02:41:30 +0000249 if (VisitedVirtualBases.count(Base))
Mike Stump996576f32009-08-16 19:04:13 +0000250 continue;
251 // Mark it so we don't lay it out twice.
Anders Carlssonc4c00ec2010-03-11 02:41:30 +0000252 VisitedVirtualBases.insert(Base);
Mike Stump22ea1f82009-08-16 01:46:26 +0000253 LayoutVirtualBase(Base);
Anders Carlsson6a848892010-03-11 04:10:39 +0000254 BaseOffset = VBases[Base];
Mike Stump996576f32009-08-16 19:04:13 +0000255 }
Mike Stump2b84dd32009-11-05 04:02:15 +0000256 } else {
257 if (RD == Class)
258 BaseOffset = getBaseOffset(Base);
259 else {
Mike Stump4e16d052009-11-11 02:49:00 +0000260 const ASTRecordLayout &Layout = Ctx.getASTRecordLayout(RD);
Mike Stump2b84dd32009-11-05 04:02:15 +0000261 BaseOffset = Offset + Layout.getBaseClassOffset(Base);
262 }
Mike Stumpc2f591b2009-08-13 22:53:07 +0000263 }
Mike Stump2b84dd32009-11-05 04:02:15 +0000264
Mike Stump996576f32009-08-16 19:04:13 +0000265 if (Base->getNumVBases()) {
Anders Carlsson03ff3792009-11-27 22:05:05 +0000266 const ASTRecordLayout &Layout = Ctx.getASTRecordLayout(Base);
Anders Carlssona30c0d32009-11-27 22:14:40 +0000267 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBaseInfo().getBase();
Anders Carlssonc4c00ec2010-03-11 02:41:30 +0000268 LayoutVirtualBases(Class, Base, PrimaryBase, BaseOffset);
Mike Stump996576f32009-08-16 19:04:13 +0000269 }
Mike Stump6b2556f2009-08-06 13:41:24 +0000270 }
271}
272
Anders Carlsson09ffa322010-03-10 22:21:28 +0000273void ASTRecordLayoutBuilder::LayoutVirtualBase(const CXXRecordDecl *RD) {
Anders Carlsson0d0b5882010-03-10 22:26:24 +0000274 // Layout the base.
275 uint64_t Offset = LayoutBase(RD);
276
277 // Add its base class offset.
Anders Carlsson6a848892010-03-11 04:10:39 +0000278 if (!VBases.insert(std::make_pair(RD, Offset)).second)
279 assert(false && "Added same vbase offset more than once!");
Anders Carlsson09ffa322010-03-10 22:21:28 +0000280}
281
282uint64_t ASTRecordLayoutBuilder::LayoutBase(const CXXRecordDecl *RD) {
283 const ASTRecordLayout &BaseInfo = Ctx.getASTRecordLayout(RD);
284
285 // If we have an empty base class, try to place it at offset 0.
286 if (RD->isEmpty() && canPlaceRecordAtOffset(RD, 0)) {
287 // We were able to place the class at offset 0.
288 UpdateEmptyClassOffsets(RD, 0);
289
290 Size = std::max(Size, BaseInfo.getSize());
291
292 return 0;
293 }
294
295 unsigned BaseAlign = BaseInfo.getNonVirtualAlign();
296
297 // Round up the current record size to the base's alignment boundary.
298 uint64_t Offset = llvm::RoundUpToAlignment(DataSize, BaseAlign);
299
300 // Try to place the base.
301 while (true) {
302 if (canPlaceRecordAtOffset(RD, Offset))
303 break;
304
305 Offset += BaseAlign;
306 }
307
308 if (!RD->isEmpty()) {
309 // Update the data size.
310 DataSize = Offset + BaseInfo.getNonVirtualSize();
311
312 Size = std::max(Size, DataSize);
313 } else
314 Size = std::max(Size, Offset + BaseInfo.getSize());
315
316 // Remember max struct/class alignment.
317 UpdateAlignment(BaseAlign);
318
319 UpdateEmptyClassOffsets(RD, Offset);
320 return Offset;
321}
322
Anders Carlsson6522b052009-09-24 03:13:30 +0000323bool ASTRecordLayoutBuilder::canPlaceRecordAtOffset(const CXXRecordDecl *RD,
324 uint64_t Offset) const {
Anders Carlssonf24b18f2009-09-24 03:22:10 +0000325 // Look for an empty class with the same type at the same offset.
326 for (EmptyClassOffsetsTy::const_iterator I =
327 EmptyClassOffsets.lower_bound(Offset),
328 E = EmptyClassOffsets.upper_bound(Offset); I != E; ++I) {
329
330 if (I->second == RD)
331 return false;
332 }
333
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000334 const ASTRecordLayout &Info = Ctx.getASTRecordLayout(RD);
335
336 // Check bases.
337 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
338 E = RD->bases_end(); I != E; ++I) {
Sebastian Redl1054fae2009-10-25 17:03:50 +0000339 assert(!I->getType()->isDependentType() &&
340 "Cannot layout class with dependent bases.");
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000341 if (I->isVirtual())
342 continue;
343
344 const CXXRecordDecl *Base =
345 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
346
347 uint64_t BaseClassOffset = Info.getBaseClassOffset(Base);
348
349 if (!canPlaceRecordAtOffset(Base, Offset + BaseClassOffset))
350 return false;
351 }
352
Anders Carlssond7d358a2009-09-25 15:39:00 +0000353 // Check fields.
354 unsigned FieldNo = 0;
355 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
356 I != E; ++I, ++FieldNo) {
357 const FieldDecl *FD = *I;
358
359 uint64_t FieldOffset = Info.getFieldOffset(FieldNo);
360
361 if (!canPlaceFieldAtOffset(FD, Offset + FieldOffset))
362 return false;
363 }
364
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000365 // FIXME: virtual bases.
Anders Carlsson6522b052009-09-24 03:13:30 +0000366 return true;
367}
368
Anders Carlsson6f95c702009-09-25 00:02:51 +0000369bool ASTRecordLayoutBuilder::canPlaceFieldAtOffset(const FieldDecl *FD,
370 uint64_t Offset) const {
Anders Carlsson4bf82142009-09-25 01:23:32 +0000371 QualType T = FD->getType();
372 if (const RecordType *RT = T->getAs<RecordType>()) {
Anders Carlsson6f95c702009-09-25 00:02:51 +0000373 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl()))
374 return canPlaceRecordAtOffset(RD, Offset);
375 }
376
Anders Carlsson4bf82142009-09-25 01:23:32 +0000377 if (const ConstantArrayType *AT = Ctx.getAsConstantArrayType(T)) {
378 QualType ElemTy = Ctx.getBaseElementType(AT);
379 const RecordType *RT = ElemTy->getAs<RecordType>();
380 if (!RT)
381 return true;
382 const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl());
383 if (!RD)
384 return true;
385
386 const ASTRecordLayout &Info = Ctx.getASTRecordLayout(RD);
387
388 uint64_t NumElements = Ctx.getConstantArrayElementCount(AT);
Mike Stump2b84dd32009-11-05 04:02:15 +0000389 uint64_t ElementOffset = Offset;
Anders Carlsson4bf82142009-09-25 01:23:32 +0000390 for (uint64_t I = 0; I != NumElements; ++I) {
391 if (!canPlaceRecordAtOffset(RD, ElementOffset))
392 return false;
393
394 ElementOffset += Info.getSize();
395 }
396 }
Anders Carlsson6f95c702009-09-25 00:02:51 +0000397
398 return true;
399}
400
Anders Carlsson6522b052009-09-24 03:13:30 +0000401void ASTRecordLayoutBuilder::UpdateEmptyClassOffsets(const CXXRecordDecl *RD,
402 uint64_t Offset) {
Anders Carlssonf24b18f2009-09-24 03:22:10 +0000403 if (RD->isEmpty())
404 EmptyClassOffsets.insert(std::make_pair(Offset, RD));
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000405
406 const ASTRecordLayout &Info = Ctx.getASTRecordLayout(RD);
407
408 // Update bases.
409 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
410 E = RD->bases_end(); I != E; ++I) {
Sebastian Redl1054fae2009-10-25 17:03:50 +0000411 assert(!I->getType()->isDependentType() &&
412 "Cannot layout class with dependent bases.");
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000413 if (I->isVirtual())
414 continue;
Anders Carlssonf24b18f2009-09-24 03:22:10 +0000415
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000416 const CXXRecordDecl *Base =
417 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
418
419 uint64_t BaseClassOffset = Info.getBaseClassOffset(Base);
420 UpdateEmptyClassOffsets(Base, Offset + BaseClassOffset);
421 }
422
Anders Carlssond7d358a2009-09-25 15:39:00 +0000423 // Update fields.
424 unsigned FieldNo = 0;
425 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
426 I != E; ++I, ++FieldNo) {
427 const FieldDecl *FD = *I;
428
429 uint64_t FieldOffset = Info.getFieldOffset(FieldNo);
430 UpdateEmptyClassOffsets(FD, Offset + FieldOffset);
431 }
432
433 // FIXME: Update virtual bases.
Anders Carlsson6522b052009-09-24 03:13:30 +0000434}
435
Anders Carlssone1883102009-09-25 01:54:38 +0000436void
437ASTRecordLayoutBuilder::UpdateEmptyClassOffsets(const FieldDecl *FD,
438 uint64_t Offset) {
439 QualType T = FD->getType();
440
441 if (const RecordType *RT = T->getAs<RecordType>()) {
442 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl())) {
443 UpdateEmptyClassOffsets(RD, Offset);
444 return;
445 }
446 }
447
448 if (const ConstantArrayType *AT = Ctx.getAsConstantArrayType(T)) {
449 QualType ElemTy = Ctx.getBaseElementType(AT);
450 const RecordType *RT = ElemTy->getAs<RecordType>();
451 if (!RT)
452 return;
453 const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl());
454 if (!RD)
455 return;
456
457 const ASTRecordLayout &Info = Ctx.getASTRecordLayout(RD);
458
459 uint64_t NumElements = Ctx.getConstantArrayElementCount(AT);
Mike Stump2b84dd32009-11-05 04:02:15 +0000460 uint64_t ElementOffset = Offset;
Anders Carlssone1883102009-09-25 01:54:38 +0000461
462 for (uint64_t I = 0; I != NumElements; ++I) {
463 UpdateEmptyClassOffsets(RD, ElementOffset);
464 ElementOffset += Info.getSize();
465 }
466 }
467}
468
Anders Carlsson79474332009-07-18 20:20:21 +0000469void ASTRecordLayoutBuilder::Layout(const RecordDecl *D) {
470 IsUnion = D->isUnion();
Anders Carlsson68e0b682009-08-08 18:23:56 +0000471
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000472 Packed = D->hasAttr<PackedAttr>();
473
474 // The #pragma pack attribute specifies the maximum field alignment.
Anders Carlsson68e0b682009-08-08 18:23:56 +0000475 if (const PragmaPackAttr *PPA = D->getAttr<PragmaPackAttr>())
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000476 MaxFieldAlignment = PPA->getAlignment();
Mike Stump11289f42009-09-09 15:08:12 +0000477
Anders Carlsson79474332009-07-18 20:20:21 +0000478 if (const AlignedAttr *AA = D->getAttr<AlignedAttr>())
Alexis Hunt96d5c762009-11-21 08:43:09 +0000479 UpdateAlignment(AA->getMaxAlignment());
Anders Carlsson6d9f6f32009-07-19 00:18:47 +0000480
Mike Stump22ea1f82009-08-16 01:46:26 +0000481 // If this is a C++ class, lay out the vtable and the non-virtual bases.
Mike Stump6b2556f2009-08-06 13:41:24 +0000482 const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D);
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000483 if (RD)
Mike Stump3dc7eb92009-07-30 00:22:38 +0000484 LayoutNonVirtualBases(RD);
Anders Carlsson6d9f6f32009-07-19 00:18:47 +0000485
Anders Carlsson118ce162009-07-18 21:48:39 +0000486 LayoutFields(D);
Mike Stump11289f42009-09-09 15:08:12 +0000487
Anders Carlssonfc8cfa82009-07-28 19:24:15 +0000488 NonVirtualSize = Size;
489 NonVirtualAlignment = Alignment;
Mike Stump3dc7eb92009-07-30 00:22:38 +0000490
Mike Stump22ea1f82009-08-16 01:46:26 +0000491 if (RD) {
Anders Carlssonc4c00ec2010-03-11 02:41:30 +0000492 LayoutVirtualBases(RD, RD, PrimaryBase.getBase(), 0);
Mike Stump22ea1f82009-08-16 01:46:26 +0000493 }
Mike Stump6b2556f2009-08-06 13:41:24 +0000494
Anders Carlsson79474332009-07-18 20:20:21 +0000495 // Finally, round the size of the total struct up to the alignment of the
496 // struct itself.
497 FinishLayout();
498}
499
Fariborz Jahanianaef66222010-02-19 00:31:17 +0000500// FIXME. Impl is no longer needed.
Anders Carlsson4f516282009-07-18 20:50:59 +0000501void ASTRecordLayoutBuilder::Layout(const ObjCInterfaceDecl *D,
502 const ObjCImplementationDecl *Impl) {
503 if (ObjCInterfaceDecl *SD = D->getSuperClass()) {
504 const ASTRecordLayout &SL = Ctx.getASTObjCInterfaceLayout(SD);
505
506 UpdateAlignment(SL.getAlignment());
Mike Stump11289f42009-09-09 15:08:12 +0000507
Anders Carlsson4f516282009-07-18 20:50:59 +0000508 // We start laying out ivars not at the end of the superclass
509 // structure, but at the next byte following the last field.
Anders Carlsson27b50132009-07-18 21:26:44 +0000510 Size = llvm::RoundUpToAlignment(SL.getDataSize(), 8);
Anders Carlsson47680d82009-09-26 01:34:51 +0000511 DataSize = Size;
Anders Carlsson4f516282009-07-18 20:50:59 +0000512 }
Mike Stump11289f42009-09-09 15:08:12 +0000513
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000514 Packed = D->hasAttr<PackedAttr>();
Mike Stump11289f42009-09-09 15:08:12 +0000515
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000516 // The #pragma pack attribute specifies the maximum field alignment.
517 if (const PragmaPackAttr *PPA = D->getAttr<PragmaPackAttr>())
518 MaxFieldAlignment = PPA->getAlignment();
Mike Stump11289f42009-09-09 15:08:12 +0000519
Anders Carlsson4f516282009-07-18 20:50:59 +0000520 if (const AlignedAttr *AA = D->getAttr<AlignedAttr>())
Alexis Hunt96d5c762009-11-21 08:43:09 +0000521 UpdateAlignment(AA->getMaxAlignment());
Anders Carlsson4f516282009-07-18 20:50:59 +0000522 // Layout each ivar sequentially.
523 llvm::SmallVector<ObjCIvarDecl*, 16> Ivars;
Fariborz Jahanianaef66222010-02-19 00:31:17 +0000524 Ctx.ShallowCollectObjCIvars(D, Ivars);
Anders Carlsson4f516282009-07-18 20:50:59 +0000525 for (unsigned i = 0, e = Ivars.size(); i != e; ++i)
526 LayoutField(Ivars[i]);
Mike Stump11289f42009-09-09 15:08:12 +0000527
Anders Carlsson4f516282009-07-18 20:50:59 +0000528 // Finally, round the size of the total struct up to the alignment of the
529 // struct itself.
530 FinishLayout();
531}
532
Anders Carlsson118ce162009-07-18 21:48:39 +0000533void ASTRecordLayoutBuilder::LayoutFields(const RecordDecl *D) {
534 // Layout each field, for now, just sequentially, respecting alignment. In
535 // the future, this will need to be tweakable by targets.
Mike Stump11289f42009-09-09 15:08:12 +0000536 for (RecordDecl::field_iterator Field = D->field_begin(),
Anders Carlsson118ce162009-07-18 21:48:39 +0000537 FieldEnd = D->field_end(); Field != FieldEnd; ++Field)
538 LayoutField(*Field);
539}
540
Anders Carlsson07209442009-11-22 17:37:31 +0000541void ASTRecordLayoutBuilder::LayoutBitField(const FieldDecl *D) {
542 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Anders Carlssonba958402009-11-22 19:13:51 +0000543 uint64_t FieldOffset = IsUnion ? 0 : (DataSize - UnfilledBitsInLastByte);
Anders Carlsson07209442009-11-22 17:37:31 +0000544 uint64_t FieldSize = D->getBitWidth()->EvaluateAsInt(Ctx).getZExtValue();
545
546 std::pair<uint64_t, unsigned> FieldInfo = Ctx.getTypeInfo(D->getType());
547 uint64_t TypeSize = FieldInfo.first;
548 unsigned FieldAlign = FieldInfo.second;
549
550 if (FieldPacked)
551 FieldAlign = 1;
552 if (const AlignedAttr *AA = D->getAttr<AlignedAttr>())
553 FieldAlign = std::max(FieldAlign, AA->getMaxAlignment());
554
555 // The maximum field alignment overrides the aligned attribute.
556 if (MaxFieldAlignment)
557 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
558
559 // Check if we need to add padding to give the field the correct
560 // alignment.
561 if (FieldSize == 0 || (FieldOffset & (FieldAlign-1)) + FieldSize > TypeSize)
562 FieldOffset = (FieldOffset + (FieldAlign-1)) & ~(FieldAlign-1);
563
564 // Padding members don't affect overall alignment
565 if (!D->getIdentifier())
566 FieldAlign = 1;
567
568 // Place this field at the current location.
569 FieldOffsets.push_back(FieldOffset);
570
Anders Carlssonba958402009-11-22 19:13:51 +0000571 // Update DataSize to include the last byte containing (part of) the bitfield.
572 if (IsUnion) {
573 // FIXME: I think FieldSize should be TypeSize here.
574 DataSize = std::max(DataSize, FieldSize);
575 } else {
576 uint64_t NewSizeInBits = FieldOffset + FieldSize;
577
578 DataSize = llvm::RoundUpToAlignment(NewSizeInBits, 8);
579 UnfilledBitsInLastByte = DataSize - NewSizeInBits;
580 }
Anders Carlsson07209442009-11-22 17:37:31 +0000581
Anders Carlssonba958402009-11-22 19:13:51 +0000582 // Update the size.
583 Size = std::max(Size, DataSize);
Anders Carlsson07209442009-11-22 17:37:31 +0000584
585 // Remember max struct/class alignment.
586 UpdateAlignment(FieldAlign);
587}
588
Anders Carlsson79474332009-07-18 20:20:21 +0000589void ASTRecordLayoutBuilder::LayoutField(const FieldDecl *D) {
Anders Carlsson07209442009-11-22 17:37:31 +0000590 if (D->isBitField()) {
591 LayoutBitField(D);
592 return;
593 }
594
Anders Carlssonba958402009-11-22 19:13:51 +0000595 // Reset the unfilled bits.
596 UnfilledBitsInLastByte = 0;
597
Anders Carlsson07209442009-11-22 17:37:31 +0000598 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Anders Carlsson47680d82009-09-26 01:34:51 +0000599 uint64_t FieldOffset = IsUnion ? 0 : DataSize;
Anders Carlsson79474332009-07-18 20:20:21 +0000600 uint64_t FieldSize;
601 unsigned FieldAlign;
Anders Carlsson07209442009-11-22 17:37:31 +0000602
603 if (D->getType()->isIncompleteArrayType()) {
604 // This is a flexible array member; we can't directly
605 // query getTypeInfo about these, so we figure it out here.
606 // Flexible array members don't have any size, but they
607 // have to be aligned appropriately for their element type.
608 FieldSize = 0;
609 const ArrayType* ATy = Ctx.getAsArrayType(D->getType());
610 FieldAlign = Ctx.getTypeAlign(ATy->getElementType());
611 } else if (const ReferenceType *RT = D->getType()->getAs<ReferenceType>()) {
612 unsigned AS = RT->getPointeeType().getAddressSpace();
613 FieldSize = Ctx.Target.getPointerWidth(AS);
614 FieldAlign = Ctx.Target.getPointerAlign(AS);
Anders Carlsson79474332009-07-18 20:20:21 +0000615 } else {
Anders Carlsson07209442009-11-22 17:37:31 +0000616 std::pair<uint64_t, unsigned> FieldInfo = Ctx.getTypeInfo(D->getType());
617 FieldSize = FieldInfo.first;
618 FieldAlign = FieldInfo.second;
Anders Carlsson79474332009-07-18 20:20:21 +0000619 }
Mike Stump11289f42009-09-09 15:08:12 +0000620
Anders Carlsson07209442009-11-22 17:37:31 +0000621 if (FieldPacked)
622 FieldAlign = 8;
623 if (const AlignedAttr *AA = D->getAttr<AlignedAttr>())
624 FieldAlign = std::max(FieldAlign, AA->getMaxAlignment());
625
626 // The maximum field alignment overrides the aligned attribute.
627 if (MaxFieldAlignment)
628 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
629
630 // Round up the current record size to the field's alignment boundary.
631 FieldOffset = llvm::RoundUpToAlignment(FieldOffset, FieldAlign);
632
633 if (!IsUnion) {
634 while (true) {
635 // Check if we can place the field at this offset.
636 if (canPlaceFieldAtOffset(D, FieldOffset))
637 break;
638
639 // We couldn't place the field at the offset. Try again at a new offset.
640 FieldOffset += FieldAlign;
641 }
642
643 UpdateEmptyClassOffsets(D, FieldOffset);
644 }
645
Anders Carlsson79474332009-07-18 20:20:21 +0000646 // Place this field at the current location.
647 FieldOffsets.push_back(FieldOffset);
Mike Stump11289f42009-09-09 15:08:12 +0000648
Anders Carlsson79474332009-07-18 20:20:21 +0000649 // Reserve space for this field.
650 if (IsUnion)
651 Size = std::max(Size, FieldSize);
652 else
653 Size = FieldOffset + FieldSize;
Mike Stump11289f42009-09-09 15:08:12 +0000654
Anders Carlsson47680d82009-09-26 01:34:51 +0000655 // Update the data size.
656 DataSize = Size;
Mike Stump11289f42009-09-09 15:08:12 +0000657
Anders Carlsson79474332009-07-18 20:20:21 +0000658 // Remember max struct/class alignment.
659 UpdateAlignment(FieldAlign);
660}
661
662void ASTRecordLayoutBuilder::FinishLayout() {
663 // In C++, records cannot be of size 0.
664 if (Ctx.getLangOptions().CPlusPlus && Size == 0)
665 Size = 8;
666 // Finally, round the size of the record up to the alignment of the
667 // record itself.
Anders Carlsson07209442009-11-22 17:37:31 +0000668 Size = llvm::RoundUpToAlignment(Size, Alignment);
Anders Carlsson79474332009-07-18 20:20:21 +0000669}
670
671void ASTRecordLayoutBuilder::UpdateAlignment(unsigned NewAlignment) {
672 if (NewAlignment <= Alignment)
673 return;
Mike Stump11289f42009-09-09 15:08:12 +0000674
Anders Carlsson79474332009-07-18 20:20:21 +0000675 assert(llvm::isPowerOf2_32(NewAlignment && "Alignment not a power of 2"));
Mike Stump11289f42009-09-09 15:08:12 +0000676
Anders Carlsson79474332009-07-18 20:20:21 +0000677 Alignment = NewAlignment;
678}
Mike Stump11289f42009-09-09 15:08:12 +0000679
Anders Carlsson5ebf8b42009-12-07 04:35:11 +0000680const ASTRecordLayout *
681ASTRecordLayoutBuilder::ComputeLayout(ASTContext &Ctx,
682 const RecordDecl *D) {
683 ASTRecordLayoutBuilder Builder(Ctx);
684
685 Builder.Layout(D);
686
687 if (!isa<CXXRecordDecl>(D))
Ted Kremenekc3015a92010-03-08 20:56:29 +0000688 return new (Ctx) ASTRecordLayout(Ctx, Builder.Size, Builder.Alignment,
689 Builder.Size,
690 Builder.FieldOffsets.data(),
691 Builder.FieldOffsets.size());
Anders Carlsson5ebf8b42009-12-07 04:35:11 +0000692
693 // FIXME: This is not always correct. See the part about bitfields at
694 // http://www.codesourcery.com/public/cxx-abi/abi.html#POD for more info.
695 // FIXME: IsPODForThePurposeOfLayout should be stored in the record layout.
696 bool IsPODForThePurposeOfLayout = cast<CXXRecordDecl>(D)->isPOD();
697
698 // FIXME: This should be done in FinalizeLayout.
699 uint64_t DataSize =
700 IsPODForThePurposeOfLayout ? Builder.Size : Builder.DataSize;
701 uint64_t NonVirtualSize =
702 IsPODForThePurposeOfLayout ? DataSize : Builder.NonVirtualSize;
703
Ted Kremenekc3015a92010-03-08 20:56:29 +0000704 return new (Ctx) ASTRecordLayout(Ctx, Builder.Size, Builder.Alignment,
705 DataSize, Builder.FieldOffsets.data(),
706 Builder.FieldOffsets.size(),
707 NonVirtualSize,
708 Builder.NonVirtualAlignment,
709 Builder.PrimaryBase,
Anders Carlsson6a848892010-03-11 04:10:39 +0000710 Builder.Bases, Builder.VBases);
Anders Carlsson5ebf8b42009-12-07 04:35:11 +0000711}
712
713const ASTRecordLayout *
714ASTRecordLayoutBuilder::ComputeLayout(ASTContext &Ctx,
715 const ObjCInterfaceDecl *D,
716 const ObjCImplementationDecl *Impl) {
717 ASTRecordLayoutBuilder Builder(Ctx);
718
719 Builder.Layout(D, Impl);
720
Ted Kremenekc3015a92010-03-08 20:56:29 +0000721 return new (Ctx) ASTRecordLayout(Ctx, Builder.Size, Builder.Alignment,
722 Builder.DataSize,
723 Builder.FieldOffsets.data(),
724 Builder.FieldOffsets.size());
Anders Carlsson5ebf8b42009-12-07 04:35:11 +0000725}
726
727const CXXMethodDecl *
728ASTRecordLayoutBuilder::ComputeKeyFunction(const CXXRecordDecl *RD) {
729 assert(RD->isDynamicClass() && "Class does not have any virtual methods!");
730
731 // If a class isnt' polymorphic it doesn't have a key function.
732 if (!RD->isPolymorphic())
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +0000733 return 0;
Eli Friedmanf2c79b62009-12-08 03:56:49 +0000734
735 // A class inside an anonymous namespace doesn't have a key function. (Or
736 // at least, there's no point to assigning a key function to such a class;
737 // this doesn't affect the ABI.)
738 if (RD->isInAnonymousNamespace())
739 return 0;
740
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +0000741 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
742 E = RD->method_end(); I != E; ++I) {
743 const CXXMethodDecl *MD = *I;
744
745 if (!MD->isVirtual())
746 continue;
747
748 if (MD->isPure())
749 continue;
Eli Friedmanf2c79b62009-12-08 03:56:49 +0000750
Anders Carlssonf98849e2009-12-02 17:15:43 +0000751 // Ignore implicit member functions, they are always marked as inline, but
752 // they don't have a body until they're defined.
753 if (MD->isImplicit())
754 continue;
Douglas Gregora318efd2010-01-05 19:06:31 +0000755
756 if (MD->isInlineSpecified())
757 continue;
Eli Friedman71a26d82009-12-06 20:50:05 +0000758
759 if (MD->hasInlineBody())
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +0000760 continue;
761
762 // We found it.
763 return MD;
764 }
765
766 return 0;
767}
768