blob: d9fa11d5a8955bf5da08b563e14a507de6214f1c [file] [log] [blame]
Anders Carlssonbda4c102009-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 Carlsson74cbe222009-07-19 00:18:47 +000014#include "clang/AST/DeclCXX.h"
Anders Carlsson93fab9d2009-07-18 20:50:59 +000015#include "clang/AST/DeclObjC.h"
Anders Carlssonbda4c102009-07-18 20:20:21 +000016#include "clang/AST/Expr.h"
Anders Carlssonbda4c102009-07-18 20:20:21 +000017#include "clang/Basic/TargetInfo.h"
Mike Stump6f376332009-08-05 22:37:18 +000018#include <llvm/ADT/SmallSet.h>
Anders Carlssonbda4c102009-07-18 20:20:21 +000019#include <llvm/Support/MathExtras.h>
20
21using namespace clang;
22
Mike Stump1eb44332009-09-09 15:08:12 +000023ASTRecordLayoutBuilder::ASTRecordLayoutBuilder(ASTContext &Ctx)
Anders Carlssone4fc0d92009-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 Carlsson200c5c22010-03-11 00:15:35 +000026 NonVirtualAlignment(8), FirstNearlyEmptyVBase(0) { }
Mike Stump3dee6ef2009-07-30 00:22:38 +000027
Mike Stump6f376332009-08-05 22:37:18 +000028/// IsNearlyEmpty - Indicates when a class has a vtable pointer, but
29/// no other data.
Anders Carlsson3f066522009-09-22 03:02:06 +000030bool ASTRecordLayoutBuilder::IsNearlyEmpty(const CXXRecordDecl *RD) const {
Mike Stump6f376332009-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 Carlsson3f066522009-09-22 03:02:06 +000040void ASTRecordLayoutBuilder::IdentifyPrimaryBases(const CXXRecordDecl *RD) {
Anders Carlssonce2009a2009-11-27 22:05:05 +000041 const ASTRecordLayout::PrimaryBaseInfo &BaseInfo =
42 Ctx.getASTRecordLayout(RD).getPrimaryBaseInfo();
Anders Carlsson3f066522009-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 Carlsson261fba62009-11-27 22:14:40 +000046 if (BaseInfo.isVirtual())
47 IndirectPrimaryBases.insert(BaseInfo.getBase());
Anders Carlsson3f066522009-09-22 03:02:06 +000048
49 // Now traverse all bases and find primary bases for them.
Mike Stump6f376332009-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 Redl9994a342009-10-25 17:03:50 +000052 assert(!i->getType()->isDependentType() &&
53 "Cannot layout class with dependent bases.");
Mike Stump1eb44332009-09-09 15:08:12 +000054 const CXXRecordDecl *Base =
Mike Stump49520942009-08-11 04:03:59 +000055 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson3f066522009-09-22 03:02:06 +000056
Mike Stump49520942009-08-11 04:03:59 +000057 // Only bases with virtual bases participate in computing the
58 // indirect primary virtual base classes.
Mike Stump4ef98092009-08-13 22:53:07 +000059 if (Base->getNumVBases())
Anders Carlsson3f066522009-09-22 03:02:06 +000060 IdentifyPrimaryBases(Base);
Mike Stump6f376332009-08-05 22:37:18 +000061 }
62}
63
Anders Carlsson3f066522009-09-22 03:02:06 +000064void
Anders Carlsson200c5c22010-03-11 00:15:35 +000065ASTRecordLayoutBuilder::SelectPrimaryVBase(const CXXRecordDecl *RD) {
Anders Carlsson584e1df2010-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 Redl9994a342009-10-25 17:03:50 +000069 "Cannot layout class with dependent bases.");
Anders Carlsson584e1df2010-03-11 03:39:12 +000070
Mike Stump1eb44332009-09-09 15:08:12 +000071 const CXXRecordDecl *Base =
Anders Carlsson584e1df2010-03-11 03:39:12 +000072 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson200c5c22010-03-11 00:15:35 +000073
Anders Carlsson584e1df2010-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 Carlsson3f066522009-09-22 03:02:06 +000078 if (!IndirectPrimaryBases.count(Base)) {
Anders Carlsson200c5c22010-03-11 00:15:35 +000079 PrimaryBase = ASTRecordLayout::PrimaryBaseInfo(Base,
80 /*IsVirtual=*/true);
Mike Stumpd76264e2009-08-12 21:50:08 +000081 return;
82 }
Anders Carlsson584e1df2010-03-11 03:39:12 +000083
84 // Is this the first nearly empty virtual base?
85 if (!FirstNearlyEmptyVBase)
86 FirstNearlyEmptyVBase = Base;
Mike Stumpd76264e2009-08-12 21:50:08 +000087 }
Anders Carlsson200c5c22010-03-11 00:15:35 +000088
Anders Carlsson200c5c22010-03-11 00:15:35 +000089 SelectPrimaryVBase(Base);
Zhongxing Xu94ba3802010-02-15 04:28:35 +000090 if (PrimaryBase.getBase())
91 return;
Mike Stumpd76264e2009-08-12 21:50:08 +000092 }
93}
94
Anders Carlsson200c5c22010-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 Carlsson3f066522009-09-22 03:02:06 +0000101 // Compute all the primary virtual bases for all of our direct and
Mike Stump0880e752009-08-13 23:26:06 +0000102 // indirect bases, and record all their primary virtual base classes.
Mike Stump0880e752009-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 Redl9994a342009-10-25 17:03:50 +0000105 assert(!i->getType()->isDependentType() &&
Anders Carlsson200c5c22010-03-11 00:15:35 +0000106 "Cannot lay out class with dependent bases.");
Mike Stump1eb44332009-09-09 15:08:12 +0000107 const CXXRecordDecl *Base =
Mike Stump0880e752009-08-13 23:26:06 +0000108 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson3f066522009-09-22 03:02:06 +0000109 IdentifyPrimaryBases(Base);
Mike Stump0880e752009-08-13 23:26:06 +0000110 }
111
Anders Carlsson3f066522009-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 Stump6f376332009-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 Carlssonce2009a2009-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 Stump6f376332009-08-05 22:37:18 +0000128 }
129 }
130
131 // Otherwise, it is the first nearly empty virtual base that is not an
Mike Stump49520942009-08-11 04:03:59 +0000132 // indirect primary virtual base class, if one exists.
Anders Carlsson200c5c22010-03-11 00:15:35 +0000133 if (RD->getNumVBases() != 0) {
134 SelectPrimaryVBase(RD);
135 if (PrimaryBase.getBase())
136 return;
137 }
Mike Stump6f376332009-08-05 22:37:18 +0000138
Anders Carlsson200c5c22010-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 Carlsson584e1df2010-03-11 03:39:12 +0000142 PrimaryBase = ASTRecordLayout::PrimaryBaseInfo(FirstNearlyEmptyVBase,
143 /*IsVirtual=*/true);
Mike Stump6f376332009-08-05 22:37:18 +0000144 return;
Anders Carlsson200c5c22010-03-11 00:15:35 +0000145 }
Anders Carlsson3f066522009-09-22 03:02:06 +0000146
Anders Carlsson200c5c22010-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 Stump6f376332009-08-05 22:37:18 +0000149
Anders Carlsson200c5c22010-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 Stump6f376332009-08-05 22:37:18 +0000159}
160
Mike Stump968db332009-11-05 04:02:15 +0000161uint64_t ASTRecordLayoutBuilder::getBaseOffset(const CXXRecordDecl *Base) {
162 for (size_t i = 0; i < Bases.size(); ++i) {
163 if (Bases[i].first == Base)
164 return Bases[i].second;
165 }
166 for (size_t i = 0; i < VBases.size(); ++i) {
167 if (VBases[i].first == Base)
168 return VBases[i].second;
169 }
170 assert(0 && "missing base");
171 return 0;
172}
173
Anders Carlssone239b9d2010-03-10 22:21:28 +0000174void
175ASTRecordLayoutBuilder::LayoutNonVirtualBases(const CXXRecordDecl *RD) {
Anders Carlsson200c5c22010-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 Carlsson200c5c22010-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 Carlssone239b9d2010-03-10 22:21:28 +0000207 }
208}
209
210void ASTRecordLayoutBuilder::LayoutNonVirtualBase(const CXXRecordDecl *RD) {
Anders Carlssone3bdbee2010-03-10 22:26:24 +0000211 // Layout the base.
212 uint64_t Offset = LayoutBase(RD);
213
214 // Add its base class offset.
215 Bases.push_back(std::make_pair(RD, Offset));
Anders Carlssone239b9d2010-03-10 22:21:28 +0000216}
Mike Stump968db332009-11-05 04:02:15 +0000217
218void ASTRecordLayoutBuilder::LayoutVirtualBases(const CXXRecordDecl *Class,
219 const CXXRecordDecl *RD,
Mike Stumpfe3010d2009-08-16 19:04:13 +0000220 const CXXRecordDecl *PB,
Anders Carlsson23a5fcb2010-03-11 02:41:30 +0000221 uint64_t Offset) {
Mike Stump4ef98092009-08-13 22:53:07 +0000222 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
223 e = RD->bases_end(); i != e; ++i) {
Sebastian Redl9994a342009-10-25 17:03:50 +0000224 assert(!i->getType()->isDependentType() &&
225 "Cannot layout class with dependent bases.");
Mike Stump1eb44332009-09-09 15:08:12 +0000226 const CXXRecordDecl *Base =
Mike Stumpeb19fa92009-08-06 13:41:24 +0000227 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Mike Stump968db332009-11-05 04:02:15 +0000228 uint64_t BaseOffset = Offset;
Mike Stump276b9f12009-08-16 01:46:26 +0000229 if (i->isVirtual()) {
Mike Stumpfe3010d2009-08-16 19:04:13 +0000230 if (Base == PB) {
231 // Only lay things out once.
Anders Carlsson23a5fcb2010-03-11 02:41:30 +0000232 if (VisitedVirtualBases.count(Base))
Mike Stumpfe3010d2009-08-16 19:04:13 +0000233 continue;
234 // Mark it so we don't lay it out twice.
Anders Carlsson23a5fcb2010-03-11 02:41:30 +0000235 VisitedVirtualBases.insert(Base);
Anders Carlsson9dc82d22010-03-11 00:21:21 +0000236 assert (IndirectPrimaryBases.count(Base) && "IndirectPrimary was wrong");
Anders Carlssone4feb832009-09-22 00:04:45 +0000237 VBases.push_back(std::make_pair(Base, Offset));
Anders Carlsson9dc82d22010-03-11 00:21:21 +0000238 } else if (IndirectPrimaryBases.count(Base)) {
Mike Stumpfe3010d2009-08-16 19:04:13 +0000239 // Someone else will eventually lay this out.
240 ;
241 } else {
242 // Only lay things out once.
Anders Carlsson23a5fcb2010-03-11 02:41:30 +0000243 if (VisitedVirtualBases.count(Base))
Mike Stumpfe3010d2009-08-16 19:04:13 +0000244 continue;
245 // Mark it so we don't lay it out twice.
Anders Carlsson23a5fcb2010-03-11 02:41:30 +0000246 VisitedVirtualBases.insert(Base);
Mike Stump276b9f12009-08-16 01:46:26 +0000247 LayoutVirtualBase(Base);
Anders Carlssone4feb832009-09-22 00:04:45 +0000248 BaseOffset = VBases.back().second;
Mike Stumpfe3010d2009-08-16 19:04:13 +0000249 }
Mike Stump968db332009-11-05 04:02:15 +0000250 } else {
251 if (RD == Class)
252 BaseOffset = getBaseOffset(Base);
253 else {
Mike Stump37acf5a2009-11-11 02:49:00 +0000254 const ASTRecordLayout &Layout = Ctx.getASTRecordLayout(RD);
Mike Stump968db332009-11-05 04:02:15 +0000255 BaseOffset = Offset + Layout.getBaseClassOffset(Base);
256 }
Mike Stump4ef98092009-08-13 22:53:07 +0000257 }
Mike Stump968db332009-11-05 04:02:15 +0000258
Mike Stumpfe3010d2009-08-16 19:04:13 +0000259 if (Base->getNumVBases()) {
Anders Carlssonce2009a2009-11-27 22:05:05 +0000260 const ASTRecordLayout &Layout = Ctx.getASTRecordLayout(Base);
Anders Carlsson261fba62009-11-27 22:14:40 +0000261 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBaseInfo().getBase();
Anders Carlsson23a5fcb2010-03-11 02:41:30 +0000262 LayoutVirtualBases(Class, Base, PrimaryBase, BaseOffset);
Mike Stumpfe3010d2009-08-16 19:04:13 +0000263 }
Mike Stumpeb19fa92009-08-06 13:41:24 +0000264 }
265}
266
Anders Carlssone239b9d2010-03-10 22:21:28 +0000267void ASTRecordLayoutBuilder::LayoutVirtualBase(const CXXRecordDecl *RD) {
Anders Carlssone3bdbee2010-03-10 22:26:24 +0000268 // Layout the base.
269 uint64_t Offset = LayoutBase(RD);
270
271 // Add its base class offset.
272 VBases.push_back(std::make_pair(RD, Offset));
Anders Carlssone239b9d2010-03-10 22:21:28 +0000273}
274
275uint64_t ASTRecordLayoutBuilder::LayoutBase(const CXXRecordDecl *RD) {
276 const ASTRecordLayout &BaseInfo = Ctx.getASTRecordLayout(RD);
277
278 // If we have an empty base class, try to place it at offset 0.
279 if (RD->isEmpty() && canPlaceRecordAtOffset(RD, 0)) {
280 // We were able to place the class at offset 0.
281 UpdateEmptyClassOffsets(RD, 0);
282
283 Size = std::max(Size, BaseInfo.getSize());
284
285 return 0;
286 }
287
288 unsigned BaseAlign = BaseInfo.getNonVirtualAlign();
289
290 // Round up the current record size to the base's alignment boundary.
291 uint64_t Offset = llvm::RoundUpToAlignment(DataSize, BaseAlign);
292
293 // Try to place the base.
294 while (true) {
295 if (canPlaceRecordAtOffset(RD, Offset))
296 break;
297
298 Offset += BaseAlign;
299 }
300
301 if (!RD->isEmpty()) {
302 // Update the data size.
303 DataSize = Offset + BaseInfo.getNonVirtualSize();
304
305 Size = std::max(Size, DataSize);
306 } else
307 Size = std::max(Size, Offset + BaseInfo.getSize());
308
309 // Remember max struct/class alignment.
310 UpdateAlignment(BaseAlign);
311
312 UpdateEmptyClassOffsets(RD, Offset);
313 return Offset;
314}
315
Anders Carlsson96061492009-09-24 03:13:30 +0000316bool ASTRecordLayoutBuilder::canPlaceRecordAtOffset(const CXXRecordDecl *RD,
317 uint64_t Offset) const {
Anders Carlsson1345bd22009-09-24 03:22:10 +0000318 // Look for an empty class with the same type at the same offset.
319 for (EmptyClassOffsetsTy::const_iterator I =
320 EmptyClassOffsets.lower_bound(Offset),
321 E = EmptyClassOffsets.upper_bound(Offset); I != E; ++I) {
322
323 if (I->second == RD)
324 return false;
325 }
326
Anders Carlssonffbdefc2009-09-24 05:21:31 +0000327 const ASTRecordLayout &Info = Ctx.getASTRecordLayout(RD);
328
329 // Check bases.
330 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
331 E = RD->bases_end(); I != E; ++I) {
Sebastian Redl9994a342009-10-25 17:03:50 +0000332 assert(!I->getType()->isDependentType() &&
333 "Cannot layout class with dependent bases.");
Anders Carlssonffbdefc2009-09-24 05:21:31 +0000334 if (I->isVirtual())
335 continue;
336
337 const CXXRecordDecl *Base =
338 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
339
340 uint64_t BaseClassOffset = Info.getBaseClassOffset(Base);
341
342 if (!canPlaceRecordAtOffset(Base, Offset + BaseClassOffset))
343 return false;
344 }
345
Anders Carlsson1eca99b2009-09-25 15:39:00 +0000346 // Check fields.
347 unsigned FieldNo = 0;
348 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
349 I != E; ++I, ++FieldNo) {
350 const FieldDecl *FD = *I;
351
352 uint64_t FieldOffset = Info.getFieldOffset(FieldNo);
353
354 if (!canPlaceFieldAtOffset(FD, Offset + FieldOffset))
355 return false;
356 }
357
Anders Carlssonffbdefc2009-09-24 05:21:31 +0000358 // FIXME: virtual bases.
Anders Carlsson96061492009-09-24 03:13:30 +0000359 return true;
360}
361
Anders Carlsson60265042009-09-25 00:02:51 +0000362bool ASTRecordLayoutBuilder::canPlaceFieldAtOffset(const FieldDecl *FD,
363 uint64_t Offset) const {
Anders Carlssonfbbce492009-09-25 01:23:32 +0000364 QualType T = FD->getType();
365 if (const RecordType *RT = T->getAs<RecordType>()) {
Anders Carlsson60265042009-09-25 00:02:51 +0000366 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl()))
367 return canPlaceRecordAtOffset(RD, Offset);
368 }
369
Anders Carlssonfbbce492009-09-25 01:23:32 +0000370 if (const ConstantArrayType *AT = Ctx.getAsConstantArrayType(T)) {
371 QualType ElemTy = Ctx.getBaseElementType(AT);
372 const RecordType *RT = ElemTy->getAs<RecordType>();
373 if (!RT)
374 return true;
375 const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl());
376 if (!RD)
377 return true;
378
379 const ASTRecordLayout &Info = Ctx.getASTRecordLayout(RD);
380
381 uint64_t NumElements = Ctx.getConstantArrayElementCount(AT);
Mike Stump968db332009-11-05 04:02:15 +0000382 uint64_t ElementOffset = Offset;
Anders Carlssonfbbce492009-09-25 01:23:32 +0000383 for (uint64_t I = 0; I != NumElements; ++I) {
384 if (!canPlaceRecordAtOffset(RD, ElementOffset))
385 return false;
386
387 ElementOffset += Info.getSize();
388 }
389 }
Anders Carlsson60265042009-09-25 00:02:51 +0000390
391 return true;
392}
393
Anders Carlsson96061492009-09-24 03:13:30 +0000394void ASTRecordLayoutBuilder::UpdateEmptyClassOffsets(const CXXRecordDecl *RD,
395 uint64_t Offset) {
Anders Carlsson1345bd22009-09-24 03:22:10 +0000396 if (RD->isEmpty())
397 EmptyClassOffsets.insert(std::make_pair(Offset, RD));
Anders Carlssonffbdefc2009-09-24 05:21:31 +0000398
399 const ASTRecordLayout &Info = Ctx.getASTRecordLayout(RD);
400
401 // Update bases.
402 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
403 E = RD->bases_end(); I != E; ++I) {
Sebastian Redl9994a342009-10-25 17:03:50 +0000404 assert(!I->getType()->isDependentType() &&
405 "Cannot layout class with dependent bases.");
Anders Carlssonffbdefc2009-09-24 05:21:31 +0000406 if (I->isVirtual())
407 continue;
Anders Carlsson1345bd22009-09-24 03:22:10 +0000408
Anders Carlssonffbdefc2009-09-24 05:21:31 +0000409 const CXXRecordDecl *Base =
410 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
411
412 uint64_t BaseClassOffset = Info.getBaseClassOffset(Base);
413 UpdateEmptyClassOffsets(Base, Offset + BaseClassOffset);
414 }
415
Anders Carlsson1eca99b2009-09-25 15:39:00 +0000416 // Update fields.
417 unsigned FieldNo = 0;
418 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
419 I != E; ++I, ++FieldNo) {
420 const FieldDecl *FD = *I;
421
422 uint64_t FieldOffset = Info.getFieldOffset(FieldNo);
423 UpdateEmptyClassOffsets(FD, Offset + FieldOffset);
424 }
425
426 // FIXME: Update virtual bases.
Anders Carlsson96061492009-09-24 03:13:30 +0000427}
428
Anders Carlssona4c60812009-09-25 01:54:38 +0000429void
430ASTRecordLayoutBuilder::UpdateEmptyClassOffsets(const FieldDecl *FD,
431 uint64_t Offset) {
432 QualType T = FD->getType();
433
434 if (const RecordType *RT = T->getAs<RecordType>()) {
435 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl())) {
436 UpdateEmptyClassOffsets(RD, Offset);
437 return;
438 }
439 }
440
441 if (const ConstantArrayType *AT = Ctx.getAsConstantArrayType(T)) {
442 QualType ElemTy = Ctx.getBaseElementType(AT);
443 const RecordType *RT = ElemTy->getAs<RecordType>();
444 if (!RT)
445 return;
446 const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl());
447 if (!RD)
448 return;
449
450 const ASTRecordLayout &Info = Ctx.getASTRecordLayout(RD);
451
452 uint64_t NumElements = Ctx.getConstantArrayElementCount(AT);
Mike Stump968db332009-11-05 04:02:15 +0000453 uint64_t ElementOffset = Offset;
Anders Carlssona4c60812009-09-25 01:54:38 +0000454
455 for (uint64_t I = 0; I != NumElements; ++I) {
456 UpdateEmptyClassOffsets(RD, ElementOffset);
457 ElementOffset += Info.getSize();
458 }
459 }
460}
461
Anders Carlssonbda4c102009-07-18 20:20:21 +0000462void ASTRecordLayoutBuilder::Layout(const RecordDecl *D) {
463 IsUnion = D->isUnion();
Anders Carlssona860e752009-08-08 18:23:56 +0000464
Anders Carlssona5dd7222009-08-08 19:38:24 +0000465 Packed = D->hasAttr<PackedAttr>();
466
467 // The #pragma pack attribute specifies the maximum field alignment.
Anders Carlssona860e752009-08-08 18:23:56 +0000468 if (const PragmaPackAttr *PPA = D->getAttr<PragmaPackAttr>())
Anders Carlssona5dd7222009-08-08 19:38:24 +0000469 MaxFieldAlignment = PPA->getAlignment();
Mike Stump1eb44332009-09-09 15:08:12 +0000470
Anders Carlssonbda4c102009-07-18 20:20:21 +0000471 if (const AlignedAttr *AA = D->getAttr<AlignedAttr>())
Sean Huntbbd37c62009-11-21 08:43:09 +0000472 UpdateAlignment(AA->getMaxAlignment());
Anders Carlsson74cbe222009-07-19 00:18:47 +0000473
Mike Stump276b9f12009-08-16 01:46:26 +0000474 // If this is a C++ class, lay out the vtable and the non-virtual bases.
Mike Stumpeb19fa92009-08-06 13:41:24 +0000475 const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D);
Anders Carlsson200c5c22010-03-11 00:15:35 +0000476 if (RD)
Mike Stump3dee6ef2009-07-30 00:22:38 +0000477 LayoutNonVirtualBases(RD);
Anders Carlsson74cbe222009-07-19 00:18:47 +0000478
Anders Carlssona2df41c2009-07-18 21:48:39 +0000479 LayoutFields(D);
Mike Stump1eb44332009-09-09 15:08:12 +0000480
Anders Carlssonb2fafd42009-07-28 19:24:15 +0000481 NonVirtualSize = Size;
482 NonVirtualAlignment = Alignment;
Mike Stump3dee6ef2009-07-30 00:22:38 +0000483
Mike Stump276b9f12009-08-16 01:46:26 +0000484 if (RD) {
Anders Carlsson23a5fcb2010-03-11 02:41:30 +0000485 LayoutVirtualBases(RD, RD, PrimaryBase.getBase(), 0);
Mike Stump276b9f12009-08-16 01:46:26 +0000486 }
Mike Stumpeb19fa92009-08-06 13:41:24 +0000487
Anders Carlssonbda4c102009-07-18 20:20:21 +0000488 // Finally, round the size of the total struct up to the alignment of the
489 // struct itself.
490 FinishLayout();
491}
492
Fariborz Jahanian11062e12010-02-19 00:31:17 +0000493// FIXME. Impl is no longer needed.
Anders Carlsson93fab9d2009-07-18 20:50:59 +0000494void ASTRecordLayoutBuilder::Layout(const ObjCInterfaceDecl *D,
495 const ObjCImplementationDecl *Impl) {
496 if (ObjCInterfaceDecl *SD = D->getSuperClass()) {
497 const ASTRecordLayout &SL = Ctx.getASTObjCInterfaceLayout(SD);
498
499 UpdateAlignment(SL.getAlignment());
Mike Stump1eb44332009-09-09 15:08:12 +0000500
Anders Carlsson93fab9d2009-07-18 20:50:59 +0000501 // We start laying out ivars not at the end of the superclass
502 // structure, but at the next byte following the last field.
Anders Carlsson243a6852009-07-18 21:26:44 +0000503 Size = llvm::RoundUpToAlignment(SL.getDataSize(), 8);
Anders Carlssona2239352009-09-26 01:34:51 +0000504 DataSize = Size;
Anders Carlsson93fab9d2009-07-18 20:50:59 +0000505 }
Mike Stump1eb44332009-09-09 15:08:12 +0000506
Anders Carlssona5dd7222009-08-08 19:38:24 +0000507 Packed = D->hasAttr<PackedAttr>();
Mike Stump1eb44332009-09-09 15:08:12 +0000508
Anders Carlssona5dd7222009-08-08 19:38:24 +0000509 // The #pragma pack attribute specifies the maximum field alignment.
510 if (const PragmaPackAttr *PPA = D->getAttr<PragmaPackAttr>())
511 MaxFieldAlignment = PPA->getAlignment();
Mike Stump1eb44332009-09-09 15:08:12 +0000512
Anders Carlsson93fab9d2009-07-18 20:50:59 +0000513 if (const AlignedAttr *AA = D->getAttr<AlignedAttr>())
Sean Huntbbd37c62009-11-21 08:43:09 +0000514 UpdateAlignment(AA->getMaxAlignment());
Anders Carlsson93fab9d2009-07-18 20:50:59 +0000515 // Layout each ivar sequentially.
516 llvm::SmallVector<ObjCIvarDecl*, 16> Ivars;
Fariborz Jahanian11062e12010-02-19 00:31:17 +0000517 Ctx.ShallowCollectObjCIvars(D, Ivars);
Anders Carlsson93fab9d2009-07-18 20:50:59 +0000518 for (unsigned i = 0, e = Ivars.size(); i != e; ++i)
519 LayoutField(Ivars[i]);
Mike Stump1eb44332009-09-09 15:08:12 +0000520
Anders Carlsson93fab9d2009-07-18 20:50:59 +0000521 // Finally, round the size of the total struct up to the alignment of the
522 // struct itself.
523 FinishLayout();
524}
525
Anders Carlssona2df41c2009-07-18 21:48:39 +0000526void ASTRecordLayoutBuilder::LayoutFields(const RecordDecl *D) {
527 // Layout each field, for now, just sequentially, respecting alignment. In
528 // the future, this will need to be tweakable by targets.
Mike Stump1eb44332009-09-09 15:08:12 +0000529 for (RecordDecl::field_iterator Field = D->field_begin(),
Anders Carlssona2df41c2009-07-18 21:48:39 +0000530 FieldEnd = D->field_end(); Field != FieldEnd; ++Field)
531 LayoutField(*Field);
532}
533
Anders Carlsson42dbcc42009-11-22 17:37:31 +0000534void ASTRecordLayoutBuilder::LayoutBitField(const FieldDecl *D) {
535 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Anders Carlssone4fc0d92009-11-22 19:13:51 +0000536 uint64_t FieldOffset = IsUnion ? 0 : (DataSize - UnfilledBitsInLastByte);
Anders Carlsson42dbcc42009-11-22 17:37:31 +0000537 uint64_t FieldSize = D->getBitWidth()->EvaluateAsInt(Ctx).getZExtValue();
538
539 std::pair<uint64_t, unsigned> FieldInfo = Ctx.getTypeInfo(D->getType());
540 uint64_t TypeSize = FieldInfo.first;
541 unsigned FieldAlign = FieldInfo.second;
542
543 if (FieldPacked)
544 FieldAlign = 1;
545 if (const AlignedAttr *AA = D->getAttr<AlignedAttr>())
546 FieldAlign = std::max(FieldAlign, AA->getMaxAlignment());
547
548 // The maximum field alignment overrides the aligned attribute.
549 if (MaxFieldAlignment)
550 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
551
552 // Check if we need to add padding to give the field the correct
553 // alignment.
554 if (FieldSize == 0 || (FieldOffset & (FieldAlign-1)) + FieldSize > TypeSize)
555 FieldOffset = (FieldOffset + (FieldAlign-1)) & ~(FieldAlign-1);
556
557 // Padding members don't affect overall alignment
558 if (!D->getIdentifier())
559 FieldAlign = 1;
560
561 // Place this field at the current location.
562 FieldOffsets.push_back(FieldOffset);
563
Anders Carlssone4fc0d92009-11-22 19:13:51 +0000564 // Update DataSize to include the last byte containing (part of) the bitfield.
565 if (IsUnion) {
566 // FIXME: I think FieldSize should be TypeSize here.
567 DataSize = std::max(DataSize, FieldSize);
568 } else {
569 uint64_t NewSizeInBits = FieldOffset + FieldSize;
570
571 DataSize = llvm::RoundUpToAlignment(NewSizeInBits, 8);
572 UnfilledBitsInLastByte = DataSize - NewSizeInBits;
573 }
Anders Carlsson42dbcc42009-11-22 17:37:31 +0000574
Anders Carlssone4fc0d92009-11-22 19:13:51 +0000575 // Update the size.
576 Size = std::max(Size, DataSize);
Anders Carlsson42dbcc42009-11-22 17:37:31 +0000577
578 // Remember max struct/class alignment.
579 UpdateAlignment(FieldAlign);
580}
581
Anders Carlssonbda4c102009-07-18 20:20:21 +0000582void ASTRecordLayoutBuilder::LayoutField(const FieldDecl *D) {
Anders Carlsson42dbcc42009-11-22 17:37:31 +0000583 if (D->isBitField()) {
584 LayoutBitField(D);
585 return;
586 }
587
Anders Carlssone4fc0d92009-11-22 19:13:51 +0000588 // Reset the unfilled bits.
589 UnfilledBitsInLastByte = 0;
590
Anders Carlsson42dbcc42009-11-22 17:37:31 +0000591 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Anders Carlssona2239352009-09-26 01:34:51 +0000592 uint64_t FieldOffset = IsUnion ? 0 : DataSize;
Anders Carlssonbda4c102009-07-18 20:20:21 +0000593 uint64_t FieldSize;
594 unsigned FieldAlign;
Anders Carlsson42dbcc42009-11-22 17:37:31 +0000595
596 if (D->getType()->isIncompleteArrayType()) {
597 // This is a flexible array member; we can't directly
598 // query getTypeInfo about these, so we figure it out here.
599 // Flexible array members don't have any size, but they
600 // have to be aligned appropriately for their element type.
601 FieldSize = 0;
602 const ArrayType* ATy = Ctx.getAsArrayType(D->getType());
603 FieldAlign = Ctx.getTypeAlign(ATy->getElementType());
604 } else if (const ReferenceType *RT = D->getType()->getAs<ReferenceType>()) {
605 unsigned AS = RT->getPointeeType().getAddressSpace();
606 FieldSize = Ctx.Target.getPointerWidth(AS);
607 FieldAlign = Ctx.Target.getPointerAlign(AS);
Anders Carlssonbda4c102009-07-18 20:20:21 +0000608 } else {
Anders Carlsson42dbcc42009-11-22 17:37:31 +0000609 std::pair<uint64_t, unsigned> FieldInfo = Ctx.getTypeInfo(D->getType());
610 FieldSize = FieldInfo.first;
611 FieldAlign = FieldInfo.second;
Anders Carlssonbda4c102009-07-18 20:20:21 +0000612 }
Mike Stump1eb44332009-09-09 15:08:12 +0000613
Anders Carlsson42dbcc42009-11-22 17:37:31 +0000614 if (FieldPacked)
615 FieldAlign = 8;
616 if (const AlignedAttr *AA = D->getAttr<AlignedAttr>())
617 FieldAlign = std::max(FieldAlign, AA->getMaxAlignment());
618
619 // The maximum field alignment overrides the aligned attribute.
620 if (MaxFieldAlignment)
621 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
622
623 // Round up the current record size to the field's alignment boundary.
624 FieldOffset = llvm::RoundUpToAlignment(FieldOffset, FieldAlign);
625
626 if (!IsUnion) {
627 while (true) {
628 // Check if we can place the field at this offset.
629 if (canPlaceFieldAtOffset(D, FieldOffset))
630 break;
631
632 // We couldn't place the field at the offset. Try again at a new offset.
633 FieldOffset += FieldAlign;
634 }
635
636 UpdateEmptyClassOffsets(D, FieldOffset);
637 }
638
Anders Carlssonbda4c102009-07-18 20:20:21 +0000639 // Place this field at the current location.
640 FieldOffsets.push_back(FieldOffset);
Mike Stump1eb44332009-09-09 15:08:12 +0000641
Anders Carlssonbda4c102009-07-18 20:20:21 +0000642 // Reserve space for this field.
643 if (IsUnion)
644 Size = std::max(Size, FieldSize);
645 else
646 Size = FieldOffset + FieldSize;
Mike Stump1eb44332009-09-09 15:08:12 +0000647
Anders Carlssona2239352009-09-26 01:34:51 +0000648 // Update the data size.
649 DataSize = Size;
Mike Stump1eb44332009-09-09 15:08:12 +0000650
Anders Carlssonbda4c102009-07-18 20:20:21 +0000651 // Remember max struct/class alignment.
652 UpdateAlignment(FieldAlign);
653}
654
655void ASTRecordLayoutBuilder::FinishLayout() {
656 // In C++, records cannot be of size 0.
657 if (Ctx.getLangOptions().CPlusPlus && Size == 0)
658 Size = 8;
659 // Finally, round the size of the record up to the alignment of the
660 // record itself.
Anders Carlsson42dbcc42009-11-22 17:37:31 +0000661 Size = llvm::RoundUpToAlignment(Size, Alignment);
Anders Carlssonbda4c102009-07-18 20:20:21 +0000662}
663
664void ASTRecordLayoutBuilder::UpdateAlignment(unsigned NewAlignment) {
665 if (NewAlignment <= Alignment)
666 return;
Mike Stump1eb44332009-09-09 15:08:12 +0000667
Anders Carlssonbda4c102009-07-18 20:20:21 +0000668 assert(llvm::isPowerOf2_32(NewAlignment && "Alignment not a power of 2"));
Mike Stump1eb44332009-09-09 15:08:12 +0000669
Anders Carlssonbda4c102009-07-18 20:20:21 +0000670 Alignment = NewAlignment;
671}
Mike Stump1eb44332009-09-09 15:08:12 +0000672
Anders Carlssonf53df232009-12-07 04:35:11 +0000673const ASTRecordLayout *
674ASTRecordLayoutBuilder::ComputeLayout(ASTContext &Ctx,
675 const RecordDecl *D) {
676 ASTRecordLayoutBuilder Builder(Ctx);
677
678 Builder.Layout(D);
679
680 if (!isa<CXXRecordDecl>(D))
Ted Kremenek503524a2010-03-08 20:56:29 +0000681 return new (Ctx) ASTRecordLayout(Ctx, Builder.Size, Builder.Alignment,
682 Builder.Size,
683 Builder.FieldOffsets.data(),
684 Builder.FieldOffsets.size());
Anders Carlssonf53df232009-12-07 04:35:11 +0000685
686 // FIXME: This is not always correct. See the part about bitfields at
687 // http://www.codesourcery.com/public/cxx-abi/abi.html#POD for more info.
688 // FIXME: IsPODForThePurposeOfLayout should be stored in the record layout.
689 bool IsPODForThePurposeOfLayout = cast<CXXRecordDecl>(D)->isPOD();
690
691 // FIXME: This should be done in FinalizeLayout.
692 uint64_t DataSize =
693 IsPODForThePurposeOfLayout ? Builder.Size : Builder.DataSize;
694 uint64_t NonVirtualSize =
695 IsPODForThePurposeOfLayout ? DataSize : Builder.NonVirtualSize;
696
Ted Kremenek503524a2010-03-08 20:56:29 +0000697 return new (Ctx) ASTRecordLayout(Ctx, Builder.Size, Builder.Alignment,
698 DataSize, Builder.FieldOffsets.data(),
699 Builder.FieldOffsets.size(),
700 NonVirtualSize,
701 Builder.NonVirtualAlignment,
702 Builder.PrimaryBase,
703 Builder.Bases.data(),
704 Builder.Bases.size(),
705 Builder.VBases.data(),
706 Builder.VBases.size());
Anders Carlssonf53df232009-12-07 04:35:11 +0000707}
708
709const ASTRecordLayout *
710ASTRecordLayoutBuilder::ComputeLayout(ASTContext &Ctx,
711 const ObjCInterfaceDecl *D,
712 const ObjCImplementationDecl *Impl) {
713 ASTRecordLayoutBuilder Builder(Ctx);
714
715 Builder.Layout(D, Impl);
716
Ted Kremenek503524a2010-03-08 20:56:29 +0000717 return new (Ctx) ASTRecordLayout(Ctx, Builder.Size, Builder.Alignment,
718 Builder.DataSize,
719 Builder.FieldOffsets.data(),
720 Builder.FieldOffsets.size());
Anders Carlssonf53df232009-12-07 04:35:11 +0000721}
722
723const CXXMethodDecl *
724ASTRecordLayoutBuilder::ComputeKeyFunction(const CXXRecordDecl *RD) {
725 assert(RD->isDynamicClass() && "Class does not have any virtual methods!");
726
727 // If a class isnt' polymorphic it doesn't have a key function.
728 if (!RD->isPolymorphic())
Anders Carlsson1a5e0d72009-11-30 23:41:22 +0000729 return 0;
Eli Friedman61eab882009-12-08 03:56:49 +0000730
731 // A class inside an anonymous namespace doesn't have a key function. (Or
732 // at least, there's no point to assigning a key function to such a class;
733 // this doesn't affect the ABI.)
734 if (RD->isInAnonymousNamespace())
735 return 0;
736
Anders Carlsson1a5e0d72009-11-30 23:41:22 +0000737 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
738 E = RD->method_end(); I != E; ++I) {
739 const CXXMethodDecl *MD = *I;
740
741 if (!MD->isVirtual())
742 continue;
743
744 if (MD->isPure())
745 continue;
Eli Friedman61eab882009-12-08 03:56:49 +0000746
Anders Carlsson5ec02ae2009-12-02 17:15:43 +0000747 // Ignore implicit member functions, they are always marked as inline, but
748 // they don't have a body until they're defined.
749 if (MD->isImplicit())
750 continue;
Douglas Gregorbd6d6192010-01-05 19:06:31 +0000751
752 if (MD->isInlineSpecified())
753 continue;
Eli Friedmand7d7f672009-12-06 20:50:05 +0000754
755 if (MD->hasInlineBody())
Anders Carlsson1a5e0d72009-11-30 23:41:22 +0000756 continue;
757
758 // We found it.
759 return MD;
760 }
761
762 return 0;
763}
764