blob: 5bc27b9d06f576829091e3d2550404bc89339d2b [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"
17#include "clang/AST/RecordLayout.h"
18#include "clang/Basic/TargetInfo.h"
Mike Stump6f376332009-08-05 22:37:18 +000019#include <llvm/ADT/SmallSet.h>
Anders Carlssonbda4c102009-07-18 20:20:21 +000020#include <llvm/Support/MathExtras.h>
21
22using namespace clang;
23
Mike Stump1eb44332009-09-09 15:08:12 +000024ASTRecordLayoutBuilder::ASTRecordLayoutBuilder(ASTContext &Ctx)
Anders Carlssone4fc0d92009-11-22 19:13:51 +000025 : Ctx(Ctx), Size(0), Alignment(8), Packed(false), UnfilledBitsInLastByte(0),
26 MaxFieldAlignment(0), DataSize(0), IsUnion(false), NonVirtualSize(0),
27 NonVirtualAlignment(8), PrimaryBase(0), PrimaryBaseWasVirtual(false) {}
Anders Carlssonbda4c102009-07-18 20:20:21 +000028
Mike Stump2effeca2009-08-06 00:38:46 +000029/// LayoutVtable - Lay out the vtable and set PrimaryBase.
Anders Carlsson3f066522009-09-22 03:02:06 +000030void ASTRecordLayoutBuilder::LayoutVtable(const CXXRecordDecl *RD) {
Mike Stump02b16232009-08-12 22:06:55 +000031 if (!RD->isDynamicClass()) {
Mike Stump2effeca2009-08-06 00:38:46 +000032 // There is no primary base in this case.
Mike Stump6f376332009-08-05 22:37:18 +000033 return;
Mike Stump2effeca2009-08-06 00:38:46 +000034 }
Mike Stump6f376332009-08-05 22:37:18 +000035
Anders Carlsson3f066522009-09-22 03:02:06 +000036 SelectPrimaryBase(RD);
Mike Stump6f376332009-08-05 22:37:18 +000037 if (PrimaryBase == 0) {
38 int AS = 0;
39 UpdateAlignment(Ctx.Target.getPointerAlign(AS));
40 Size += Ctx.Target.getPointerWidth(AS);
Anders Carlssona2239352009-09-26 01:34:51 +000041 DataSize = Size;
Mike Stump6f376332009-08-05 22:37:18 +000042 }
Mike Stump3dee6ef2009-07-30 00:22:38 +000043}
44
Mike Stump1eb44332009-09-09 15:08:12 +000045void
Anders Carlsson74cbe222009-07-19 00:18:47 +000046ASTRecordLayoutBuilder::LayoutNonVirtualBases(const CXXRecordDecl *RD) {
Anders Carlsson74cbe222009-07-19 00:18:47 +000047 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
48 e = RD->bases_end(); i != e; ++i) {
49 if (!i->isVirtual()) {
Sebastian Redl9994a342009-10-25 17:03:50 +000050 assert(!i->getType()->isDependentType() &&
51 "Cannot layout class with dependent bases.");
Mike Stump1eb44332009-09-09 15:08:12 +000052 const CXXRecordDecl *Base =
Ted Kremenek6217b802009-07-29 21:53:49 +000053 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Mike Stump2effeca2009-08-06 00:38:46 +000054 // Skip the PrimaryBase here, as it is laid down first.
Mike Stump21538912009-08-14 01:44:03 +000055 if (Base != PrimaryBase || PrimaryBaseWasVirtual)
56 LayoutBaseNonVirtually(Base, false);
Anders Carlsson74cbe222009-07-19 00:18:47 +000057 }
58 }
59}
60
Mike Stump6f376332009-08-05 22:37:18 +000061// Helper routines related to the abi definition from:
62// http://www.codesourcery.com/public/cxx-abi/abi.html
63//
64/// IsNearlyEmpty - Indicates when a class has a vtable pointer, but
65/// no other data.
Anders Carlsson3f066522009-09-22 03:02:06 +000066bool ASTRecordLayoutBuilder::IsNearlyEmpty(const CXXRecordDecl *RD) const {
Mike Stump6f376332009-08-05 22:37:18 +000067 // FIXME: Audit the corners
68 if (!RD->isDynamicClass())
69 return false;
70 const ASTRecordLayout &BaseInfo = Ctx.getASTRecordLayout(RD);
71 if (BaseInfo.getNonVirtualSize() == Ctx.Target.getPointerWidth(0))
72 return true;
73 return false;
74}
75
Anders Carlsson3f066522009-09-22 03:02:06 +000076void ASTRecordLayoutBuilder::IdentifyPrimaryBases(const CXXRecordDecl *RD) {
Mike Stump49520942009-08-11 04:03:59 +000077 const ASTRecordLayout &Layout = Ctx.getASTRecordLayout(RD);
Anders Carlsson3f066522009-09-22 03:02:06 +000078
79 // If the record has a primary base class that is virtual, add it to the set
80 // of primary bases.
81 if (Layout.getPrimaryBaseWasVirtual())
82 IndirectPrimaryBases.insert(Layout.getPrimaryBase());
83
84 // Now traverse all bases and find primary bases for them.
Mike Stump6f376332009-08-05 22:37:18 +000085 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
86 e = RD->bases_end(); i != e; ++i) {
Sebastian Redl9994a342009-10-25 17:03:50 +000087 assert(!i->getType()->isDependentType() &&
88 "Cannot layout class with dependent bases.");
Mike Stump1eb44332009-09-09 15:08:12 +000089 const CXXRecordDecl *Base =
Mike Stump49520942009-08-11 04:03:59 +000090 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson3f066522009-09-22 03:02:06 +000091
Mike Stump49520942009-08-11 04:03:59 +000092 // Only bases with virtual bases participate in computing the
93 // indirect primary virtual base classes.
Mike Stump4ef98092009-08-13 22:53:07 +000094 if (Base->getNumVBases())
Anders Carlsson3f066522009-09-22 03:02:06 +000095 IdentifyPrimaryBases(Base);
Mike Stump6f376332009-08-05 22:37:18 +000096 }
97}
98
Anders Carlsson3f066522009-09-22 03:02:06 +000099void
100ASTRecordLayoutBuilder::SelectPrimaryVBase(const CXXRecordDecl *RD,
101 const CXXRecordDecl *&FirstPrimary) {
Mike Stumpd76264e2009-08-12 21:50:08 +0000102 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
103 e = RD->bases_end(); i != e; ++i) {
Sebastian Redl9994a342009-10-25 17:03:50 +0000104 assert(!i->getType()->isDependentType() &&
105 "Cannot layout class with dependent bases.");
Mike Stump1eb44332009-09-09 15:08:12 +0000106 const CXXRecordDecl *Base =
Mike Stumpd76264e2009-08-12 21:50:08 +0000107 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
108 if (!i->isVirtual()) {
Anders Carlsson3f066522009-09-22 03:02:06 +0000109 SelectPrimaryVBase(Base, FirstPrimary);
Mike Stumpd76264e2009-08-12 21:50:08 +0000110 if (PrimaryBase)
111 return;
112 continue;
113 }
114 if (IsNearlyEmpty(Base)) {
115 if (FirstPrimary==0)
116 FirstPrimary = Base;
Anders Carlsson3f066522009-09-22 03:02:06 +0000117 if (!IndirectPrimaryBases.count(Base)) {
Mike Stumpd76264e2009-08-12 21:50:08 +0000118 setPrimaryBase(Base, true);
119 return;
120 }
121 }
122 }
123}
124
Mike Stump6f376332009-08-05 22:37:18 +0000125/// SelectPrimaryBase - Selects the primary base for the given class and
Mike Stump0880e752009-08-13 23:26:06 +0000126/// record that with setPrimaryBase. We also calculate the IndirectPrimaries.
Anders Carlsson3f066522009-09-22 03:02:06 +0000127void ASTRecordLayoutBuilder::SelectPrimaryBase(const CXXRecordDecl *RD) {
128 // Compute all the primary virtual bases for all of our direct and
Mike Stump0880e752009-08-13 23:26:06 +0000129 // indirect bases, and record all their primary virtual base classes.
Mike Stump0880e752009-08-13 23:26:06 +0000130 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
131 e = RD->bases_end(); i != e; ++i) {
Sebastian Redl9994a342009-10-25 17:03:50 +0000132 assert(!i->getType()->isDependentType() &&
133 "Cannot layout class with dependent bases.");
Mike Stump1eb44332009-09-09 15:08:12 +0000134 const CXXRecordDecl *Base =
Mike Stump0880e752009-08-13 23:26:06 +0000135 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson3f066522009-09-22 03:02:06 +0000136 IdentifyPrimaryBases(Base);
Mike Stump0880e752009-08-13 23:26:06 +0000137 }
138
Anders Carlsson3f066522009-09-22 03:02:06 +0000139 // If the record has a dynamic base class, attempt to choose a primary base
140 // class. It is the first (in direct base class order) non-virtual dynamic
141 // base class, if one exists.
Mike Stump6f376332009-08-05 22:37:18 +0000142 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
143 e = RD->bases_end(); i != e; ++i) {
144 if (!i->isVirtual()) {
Mike Stump1eb44332009-09-09 15:08:12 +0000145 const CXXRecordDecl *Base =
Mike Stump6f376332009-08-05 22:37:18 +0000146 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
147 if (Base->isDynamicClass()) {
Anders Carlsson3f066522009-09-22 03:02:06 +0000148 // We found it.
Mike Stump928f1502009-08-07 19:00:50 +0000149 setPrimaryBase(Base, false);
Mike Stump6f376332009-08-05 22:37:18 +0000150 return;
151 }
152 }
153 }
154
155 // Otherwise, it is the first nearly empty virtual base that is not an
Mike Stump49520942009-08-11 04:03:59 +0000156 // indirect primary virtual base class, if one exists.
Mike Stump6f376332009-08-05 22:37:18 +0000157
158 // If we have no virtual bases at this point, bail out as the searching below
159 // is expensive.
Anders Carlsson0cd40e42009-09-22 18:21:58 +0000160 if (RD->getNumVBases() == 0)
Mike Stump6f376332009-08-05 22:37:18 +0000161 return;
Anders Carlsson3f066522009-09-22 03:02:06 +0000162
Mike Stump6f376332009-08-05 22:37:18 +0000163 // Then we can search for the first nearly empty virtual base itself.
Anders Carlsson3f066522009-09-22 03:02:06 +0000164 const CXXRecordDecl *FirstPrimary = 0;
165 SelectPrimaryVBase(RD, FirstPrimary);
Mike Stump6f376332009-08-05 22:37:18 +0000166
Mike Stump928f1502009-08-07 19:00:50 +0000167 // Otherwise if is the first nearly empty virtual base, if one exists,
168 // otherwise there is no primary base class.
Anders Carlsson56cfdc12009-09-22 19:16:59 +0000169 if (!PrimaryBase)
170 setPrimaryBase(FirstPrimary, true);
Mike Stump6f376332009-08-05 22:37:18 +0000171}
172
Mike Stumpeb19fa92009-08-06 13:41:24 +0000173void ASTRecordLayoutBuilder::LayoutVirtualBase(const CXXRecordDecl *RD) {
Mike Stump21538912009-08-14 01:44:03 +0000174 LayoutBaseNonVirtually(RD, true);
Mike Stumpeb19fa92009-08-06 13:41:24 +0000175}
176
Mike Stump968db332009-11-05 04:02:15 +0000177uint64_t ASTRecordLayoutBuilder::getBaseOffset(const CXXRecordDecl *Base) {
178 for (size_t i = 0; i < Bases.size(); ++i) {
179 if (Bases[i].first == Base)
180 return Bases[i].second;
181 }
182 for (size_t i = 0; i < VBases.size(); ++i) {
183 if (VBases[i].first == Base)
184 return VBases[i].second;
185 }
186 assert(0 && "missing base");
187 return 0;
188}
189
190
191void ASTRecordLayoutBuilder::LayoutVirtualBases(const CXXRecordDecl *Class,
192 const CXXRecordDecl *RD,
Mike Stumpfe3010d2009-08-16 19:04:13 +0000193 const CXXRecordDecl *PB,
Mike Stump968db332009-11-05 04:02:15 +0000194 uint64_t Offset,
Mike Stump276b9f12009-08-16 01:46:26 +0000195 llvm::SmallSet<const CXXRecordDecl*, 32> &mark,
Mike Stumpd53cef12009-08-13 02:02:14 +0000196 llvm::SmallSet<const CXXRecordDecl*, 32> &IndirectPrimary) {
Mike Stump4ef98092009-08-13 22:53:07 +0000197 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
198 e = RD->bases_end(); i != e; ++i) {
Sebastian Redl9994a342009-10-25 17:03:50 +0000199 assert(!i->getType()->isDependentType() &&
200 "Cannot layout class with dependent bases.");
Mike Stump1eb44332009-09-09 15:08:12 +0000201 const CXXRecordDecl *Base =
Mike Stumpeb19fa92009-08-06 13:41:24 +0000202 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Mike Stump968db332009-11-05 04:02:15 +0000203 uint64_t BaseOffset = Offset;
Mike Stump276b9f12009-08-16 01:46:26 +0000204 if (i->isVirtual()) {
Mike Stumpfe3010d2009-08-16 19:04:13 +0000205 if (Base == PB) {
206 // Only lay things out once.
207 if (mark.count(Base))
208 continue;
209 // Mark it so we don't lay it out twice.
210 mark.insert(Base);
211 assert (IndirectPrimary.count(Base) && "IndirectPrimary was wrong");
Anders Carlssone4feb832009-09-22 00:04:45 +0000212 VBases.push_back(std::make_pair(Base, Offset));
Mike Stumpfe3010d2009-08-16 19:04:13 +0000213 } else if (IndirectPrimary.count(Base)) {
214 // Someone else will eventually lay this out.
215 ;
216 } else {
217 // Only lay things out once.
218 if (mark.count(Base))
219 continue;
220 // Mark it so we don't lay it out twice.
221 mark.insert(Base);
Mike Stump276b9f12009-08-16 01:46:26 +0000222 LayoutVirtualBase(Base);
Anders Carlssone4feb832009-09-22 00:04:45 +0000223 BaseOffset = VBases.back().second;
Mike Stumpfe3010d2009-08-16 19:04:13 +0000224 }
Mike Stump968db332009-11-05 04:02:15 +0000225 } else {
226 if (RD == Class)
227 BaseOffset = getBaseOffset(Base);
228 else {
Mike Stump37acf5a2009-11-11 02:49:00 +0000229 const ASTRecordLayout &Layout = Ctx.getASTRecordLayout(RD);
Mike Stump968db332009-11-05 04:02:15 +0000230 BaseOffset = Offset + Layout.getBaseClassOffset(Base);
231 }
Mike Stump4ef98092009-08-13 22:53:07 +0000232 }
Mike Stump968db332009-11-05 04:02:15 +0000233
Mike Stumpfe3010d2009-08-16 19:04:13 +0000234 if (Base->getNumVBases()) {
235 const ASTRecordLayout &L = Ctx.getASTRecordLayout(Base);
236 const CXXRecordDecl *PB = L.getPrimaryBase();
Mike Stump968db332009-11-05 04:02:15 +0000237 LayoutVirtualBases(Class, Base, PB, BaseOffset, mark, IndirectPrimary);
Mike Stumpfe3010d2009-08-16 19:04:13 +0000238 }
Mike Stumpeb19fa92009-08-06 13:41:24 +0000239 }
240}
241
Anders Carlsson96061492009-09-24 03:13:30 +0000242bool ASTRecordLayoutBuilder::canPlaceRecordAtOffset(const CXXRecordDecl *RD,
243 uint64_t Offset) const {
Anders Carlsson1345bd22009-09-24 03:22:10 +0000244 // Look for an empty class with the same type at the same offset.
245 for (EmptyClassOffsetsTy::const_iterator I =
246 EmptyClassOffsets.lower_bound(Offset),
247 E = EmptyClassOffsets.upper_bound(Offset); I != E; ++I) {
248
249 if (I->second == RD)
250 return false;
251 }
252
Anders Carlssonffbdefc2009-09-24 05:21:31 +0000253 const ASTRecordLayout &Info = Ctx.getASTRecordLayout(RD);
254
255 // Check bases.
256 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
257 E = RD->bases_end(); I != E; ++I) {
Sebastian Redl9994a342009-10-25 17:03:50 +0000258 assert(!I->getType()->isDependentType() &&
259 "Cannot layout class with dependent bases.");
Anders Carlssonffbdefc2009-09-24 05:21:31 +0000260 if (I->isVirtual())
261 continue;
262
263 const CXXRecordDecl *Base =
264 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
265
266 uint64_t BaseClassOffset = Info.getBaseClassOffset(Base);
267
268 if (!canPlaceRecordAtOffset(Base, Offset + BaseClassOffset))
269 return false;
270 }
271
Anders Carlsson1eca99b2009-09-25 15:39:00 +0000272 // Check fields.
273 unsigned FieldNo = 0;
274 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
275 I != E; ++I, ++FieldNo) {
276 const FieldDecl *FD = *I;
277
278 uint64_t FieldOffset = Info.getFieldOffset(FieldNo);
279
280 if (!canPlaceFieldAtOffset(FD, Offset + FieldOffset))
281 return false;
282 }
283
Anders Carlssonffbdefc2009-09-24 05:21:31 +0000284 // FIXME: virtual bases.
Anders Carlsson96061492009-09-24 03:13:30 +0000285 return true;
286}
287
Anders Carlsson60265042009-09-25 00:02:51 +0000288bool ASTRecordLayoutBuilder::canPlaceFieldAtOffset(const FieldDecl *FD,
289 uint64_t Offset) const {
Anders Carlssonfbbce492009-09-25 01:23:32 +0000290 QualType T = FD->getType();
291 if (const RecordType *RT = T->getAs<RecordType>()) {
Anders Carlsson60265042009-09-25 00:02:51 +0000292 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl()))
293 return canPlaceRecordAtOffset(RD, Offset);
294 }
295
Anders Carlssonfbbce492009-09-25 01:23:32 +0000296 if (const ConstantArrayType *AT = Ctx.getAsConstantArrayType(T)) {
297 QualType ElemTy = Ctx.getBaseElementType(AT);
298 const RecordType *RT = ElemTy->getAs<RecordType>();
299 if (!RT)
300 return true;
301 const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl());
302 if (!RD)
303 return true;
304
305 const ASTRecordLayout &Info = Ctx.getASTRecordLayout(RD);
306
307 uint64_t NumElements = Ctx.getConstantArrayElementCount(AT);
Mike Stump968db332009-11-05 04:02:15 +0000308 uint64_t ElementOffset = Offset;
Anders Carlssonfbbce492009-09-25 01:23:32 +0000309 for (uint64_t I = 0; I != NumElements; ++I) {
310 if (!canPlaceRecordAtOffset(RD, ElementOffset))
311 return false;
312
313 ElementOffset += Info.getSize();
314 }
315 }
Anders Carlsson60265042009-09-25 00:02:51 +0000316
317 return true;
318}
319
Anders Carlsson96061492009-09-24 03:13:30 +0000320void ASTRecordLayoutBuilder::UpdateEmptyClassOffsets(const CXXRecordDecl *RD,
321 uint64_t Offset) {
Anders Carlsson1345bd22009-09-24 03:22:10 +0000322 if (RD->isEmpty())
323 EmptyClassOffsets.insert(std::make_pair(Offset, RD));
Anders Carlssonffbdefc2009-09-24 05:21:31 +0000324
325 const ASTRecordLayout &Info = Ctx.getASTRecordLayout(RD);
326
327 // Update bases.
328 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
329 E = RD->bases_end(); I != E; ++I) {
Sebastian Redl9994a342009-10-25 17:03:50 +0000330 assert(!I->getType()->isDependentType() &&
331 "Cannot layout class with dependent bases.");
Anders Carlssonffbdefc2009-09-24 05:21:31 +0000332 if (I->isVirtual())
333 continue;
Anders Carlsson1345bd22009-09-24 03:22:10 +0000334
Anders Carlssonffbdefc2009-09-24 05:21:31 +0000335 const CXXRecordDecl *Base =
336 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
337
338 uint64_t BaseClassOffset = Info.getBaseClassOffset(Base);
339 UpdateEmptyClassOffsets(Base, Offset + BaseClassOffset);
340 }
341
Anders Carlsson1eca99b2009-09-25 15:39:00 +0000342 // Update fields.
343 unsigned FieldNo = 0;
344 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
345 I != E; ++I, ++FieldNo) {
346 const FieldDecl *FD = *I;
347
348 uint64_t FieldOffset = Info.getFieldOffset(FieldNo);
349 UpdateEmptyClassOffsets(FD, Offset + FieldOffset);
350 }
351
352 // FIXME: Update virtual bases.
Anders Carlsson96061492009-09-24 03:13:30 +0000353}
354
Anders Carlssona4c60812009-09-25 01:54:38 +0000355void
356ASTRecordLayoutBuilder::UpdateEmptyClassOffsets(const FieldDecl *FD,
357 uint64_t Offset) {
358 QualType T = FD->getType();
359
360 if (const RecordType *RT = T->getAs<RecordType>()) {
361 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl())) {
362 UpdateEmptyClassOffsets(RD, Offset);
363 return;
364 }
365 }
366
367 if (const ConstantArrayType *AT = Ctx.getAsConstantArrayType(T)) {
368 QualType ElemTy = Ctx.getBaseElementType(AT);
369 const RecordType *RT = ElemTy->getAs<RecordType>();
370 if (!RT)
371 return;
372 const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl());
373 if (!RD)
374 return;
375
376 const ASTRecordLayout &Info = Ctx.getASTRecordLayout(RD);
377
378 uint64_t NumElements = Ctx.getConstantArrayElementCount(AT);
Mike Stump968db332009-11-05 04:02:15 +0000379 uint64_t ElementOffset = Offset;
Anders Carlssona4c60812009-09-25 01:54:38 +0000380
381 for (uint64_t I = 0; I != NumElements; ++I) {
382 UpdateEmptyClassOffsets(RD, ElementOffset);
383 ElementOffset += Info.getSize();
384 }
385 }
386}
387
Anders Carlsson96061492009-09-24 03:13:30 +0000388uint64_t ASTRecordLayoutBuilder::LayoutBase(const CXXRecordDecl *RD) {
Anders Carlsson74cbe222009-07-19 00:18:47 +0000389 const ASTRecordLayout &BaseInfo = Ctx.getASTRecordLayout(RD);
Anders Carlsson1345bd22009-09-24 03:22:10 +0000390
391 // If we have an empty base class, try to place it at offset 0.
392 if (RD->isEmpty() && canPlaceRecordAtOffset(RD, 0)) {
393 // We were able to place the class at offset 0.
Anders Carlsson1345bd22009-09-24 03:22:10 +0000394 UpdateEmptyClassOffsets(RD, 0);
Anders Carlssonffbdefc2009-09-24 05:21:31 +0000395
Anders Carlsson1eca99b2009-09-25 15:39:00 +0000396 Size = std::max(Size, BaseInfo.getSize());
Anders Carlssonffbdefc2009-09-24 05:21:31 +0000397
Anders Carlsson1345bd22009-09-24 03:22:10 +0000398 return 0;
Anders Carlssonb237fd62009-09-17 04:42:56 +0000399 }
400
Anders Carlssonb2fafd42009-07-28 19:24:15 +0000401 unsigned BaseAlign = BaseInfo.getNonVirtualAlign();
Anders Carlssonffbdefc2009-09-24 05:21:31 +0000402
Anders Carlsson74cbe222009-07-19 00:18:47 +0000403 // Round up the current record size to the base's alignment boundary.
Anders Carlssona2239352009-09-26 01:34:51 +0000404 uint64_t Offset = llvm::RoundUpToAlignment(DataSize, BaseAlign);
Anders Carlsson96061492009-09-24 03:13:30 +0000405
Anders Carlssonffbdefc2009-09-24 05:21:31 +0000406 // Try to place the base.
407 while (true) {
408 if (canPlaceRecordAtOffset(RD, Offset))
409 break;
410
411 Offset += BaseAlign;
412 }
413
Anders Carlsson1eca99b2009-09-25 15:39:00 +0000414 if (!RD->isEmpty()) {
Anders Carlssona2239352009-09-26 01:34:51 +0000415 // Update the data size.
416 DataSize = Offset + BaseInfo.getNonVirtualSize();
Anders Carlssonffbdefc2009-09-24 05:21:31 +0000417
Anders Carlssona2239352009-09-26 01:34:51 +0000418 Size = std::max(Size, DataSize);
Anders Carlsson1eca99b2009-09-25 15:39:00 +0000419 } else
420 Size = std::max(Size, Offset + BaseInfo.getSize());
421
Anders Carlsson96061492009-09-24 03:13:30 +0000422 // Remember max struct/class alignment.
423 UpdateAlignment(BaseAlign);
Anders Carlssonffbdefc2009-09-24 05:21:31 +0000424
425 UpdateEmptyClassOffsets(RD, Offset);
Anders Carlsson96061492009-09-24 03:13:30 +0000426 return Offset;
427}
428
429void ASTRecordLayoutBuilder::LayoutBaseNonVirtually(const CXXRecordDecl *RD,
430 bool IsVirtualBase) {
431 // Layout the base.
Mike Stump968db332009-11-05 04:02:15 +0000432 uint64_t Offset = LayoutBase(RD);
Anders Carlsson74cbe222009-07-19 00:18:47 +0000433
Mike Stump276b9f12009-08-16 01:46:26 +0000434 // Add base class offsets.
Anders Carlssone4feb832009-09-22 00:04:45 +0000435 if (IsVirtualBase)
Anders Carlsson96061492009-09-24 03:13:30 +0000436 VBases.push_back(std::make_pair(RD, Offset));
Anders Carlssone4feb832009-09-22 00:04:45 +0000437 else
Anders Carlsson96061492009-09-24 03:13:30 +0000438 Bases.push_back(std::make_pair(RD, Offset));
Anders Carlsson74cbe222009-07-19 00:18:47 +0000439}
440
Anders Carlssonbda4c102009-07-18 20:20:21 +0000441void ASTRecordLayoutBuilder::Layout(const RecordDecl *D) {
442 IsUnion = D->isUnion();
Anders Carlssona860e752009-08-08 18:23:56 +0000443
Anders Carlssona5dd7222009-08-08 19:38:24 +0000444 Packed = D->hasAttr<PackedAttr>();
445
446 // The #pragma pack attribute specifies the maximum field alignment.
Anders Carlssona860e752009-08-08 18:23:56 +0000447 if (const PragmaPackAttr *PPA = D->getAttr<PragmaPackAttr>())
Anders Carlssona5dd7222009-08-08 19:38:24 +0000448 MaxFieldAlignment = PPA->getAlignment();
Mike Stump1eb44332009-09-09 15:08:12 +0000449
Anders Carlssonbda4c102009-07-18 20:20:21 +0000450 if (const AlignedAttr *AA = D->getAttr<AlignedAttr>())
Sean Huntbbd37c62009-11-21 08:43:09 +0000451 UpdateAlignment(AA->getMaxAlignment());
Anders Carlsson74cbe222009-07-19 00:18:47 +0000452
Mike Stump276b9f12009-08-16 01:46:26 +0000453 // If this is a C++ class, lay out the vtable and the non-virtual bases.
Mike Stumpeb19fa92009-08-06 13:41:24 +0000454 const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D);
455 if (RD) {
Anders Carlsson3f066522009-09-22 03:02:06 +0000456 LayoutVtable(RD);
Mike Stump2effeca2009-08-06 00:38:46 +0000457 // PrimaryBase goes first.
Mike Stumpd53cef12009-08-13 02:02:14 +0000458 if (PrimaryBase) {
Mike Stumpd53cef12009-08-13 02:02:14 +0000459 if (PrimaryBaseWasVirtual)
Anders Carlsson3f066522009-09-22 03:02:06 +0000460 IndirectPrimaryBases.insert(PrimaryBase);
Mike Stump21538912009-08-14 01:44:03 +0000461 LayoutBaseNonVirtually(PrimaryBase, PrimaryBaseWasVirtual);
Mike Stumpd53cef12009-08-13 02:02:14 +0000462 }
Mike Stump3dee6ef2009-07-30 00:22:38 +0000463 LayoutNonVirtualBases(RD);
Mike Stump3dee6ef2009-07-30 00:22:38 +0000464 }
Anders Carlsson74cbe222009-07-19 00:18:47 +0000465
Anders Carlssona2df41c2009-07-18 21:48:39 +0000466 LayoutFields(D);
Mike Stump1eb44332009-09-09 15:08:12 +0000467
Anders Carlssonb2fafd42009-07-28 19:24:15 +0000468 NonVirtualSize = Size;
469 NonVirtualAlignment = Alignment;
Mike Stump3dee6ef2009-07-30 00:22:38 +0000470
Mike Stump276b9f12009-08-16 01:46:26 +0000471 if (RD) {
472 llvm::SmallSet<const CXXRecordDecl*, 32> mark;
Mike Stump968db332009-11-05 04:02:15 +0000473 LayoutVirtualBases(RD, RD, PrimaryBase, 0, mark, IndirectPrimaryBases);
Mike Stump276b9f12009-08-16 01:46:26 +0000474 }
Mike Stumpeb19fa92009-08-06 13:41:24 +0000475
Anders Carlssonbda4c102009-07-18 20:20:21 +0000476 // Finally, round the size of the total struct up to the alignment of the
477 // struct itself.
478 FinishLayout();
479}
480
Anders Carlsson93fab9d2009-07-18 20:50:59 +0000481void ASTRecordLayoutBuilder::Layout(const ObjCInterfaceDecl *D,
482 const ObjCImplementationDecl *Impl) {
483 if (ObjCInterfaceDecl *SD = D->getSuperClass()) {
484 const ASTRecordLayout &SL = Ctx.getASTObjCInterfaceLayout(SD);
485
486 UpdateAlignment(SL.getAlignment());
Mike Stump1eb44332009-09-09 15:08:12 +0000487
Anders Carlsson93fab9d2009-07-18 20:50:59 +0000488 // We start laying out ivars not at the end of the superclass
489 // structure, but at the next byte following the last field.
Anders Carlsson243a6852009-07-18 21:26:44 +0000490 Size = llvm::RoundUpToAlignment(SL.getDataSize(), 8);
Anders Carlssona2239352009-09-26 01:34:51 +0000491 DataSize = Size;
Anders Carlsson93fab9d2009-07-18 20:50:59 +0000492 }
Mike Stump1eb44332009-09-09 15:08:12 +0000493
Anders Carlssona5dd7222009-08-08 19:38:24 +0000494 Packed = D->hasAttr<PackedAttr>();
Mike Stump1eb44332009-09-09 15:08:12 +0000495
Anders Carlssona5dd7222009-08-08 19:38:24 +0000496 // The #pragma pack attribute specifies the maximum field alignment.
497 if (const PragmaPackAttr *PPA = D->getAttr<PragmaPackAttr>())
498 MaxFieldAlignment = PPA->getAlignment();
Mike Stump1eb44332009-09-09 15:08:12 +0000499
Anders Carlsson93fab9d2009-07-18 20:50:59 +0000500 if (const AlignedAttr *AA = D->getAttr<AlignedAttr>())
Sean Huntbbd37c62009-11-21 08:43:09 +0000501 UpdateAlignment(AA->getMaxAlignment());
Mike Stump1eb44332009-09-09 15:08:12 +0000502
Anders Carlsson93fab9d2009-07-18 20:50:59 +0000503 // Layout each ivar sequentially.
504 llvm::SmallVector<ObjCIvarDecl*, 16> Ivars;
505 Ctx.ShallowCollectObjCIvars(D, Ivars, Impl);
506 for (unsigned i = 0, e = Ivars.size(); i != e; ++i)
507 LayoutField(Ivars[i]);
Mike Stump1eb44332009-09-09 15:08:12 +0000508
Anders Carlsson93fab9d2009-07-18 20:50:59 +0000509 // Finally, round the size of the total struct up to the alignment of the
510 // struct itself.
511 FinishLayout();
512}
513
Anders Carlssona2df41c2009-07-18 21:48:39 +0000514void ASTRecordLayoutBuilder::LayoutFields(const RecordDecl *D) {
515 // Layout each field, for now, just sequentially, respecting alignment. In
516 // the future, this will need to be tweakable by targets.
Mike Stump1eb44332009-09-09 15:08:12 +0000517 for (RecordDecl::field_iterator Field = D->field_begin(),
Anders Carlssona2df41c2009-07-18 21:48:39 +0000518 FieldEnd = D->field_end(); Field != FieldEnd; ++Field)
519 LayoutField(*Field);
520}
521
Anders Carlsson42dbcc42009-11-22 17:37:31 +0000522void ASTRecordLayoutBuilder::LayoutBitField(const FieldDecl *D) {
523 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Anders Carlssone4fc0d92009-11-22 19:13:51 +0000524 uint64_t FieldOffset = IsUnion ? 0 : (DataSize - UnfilledBitsInLastByte);
Anders Carlsson42dbcc42009-11-22 17:37:31 +0000525 uint64_t FieldSize = D->getBitWidth()->EvaluateAsInt(Ctx).getZExtValue();
526
527 std::pair<uint64_t, unsigned> FieldInfo = Ctx.getTypeInfo(D->getType());
528 uint64_t TypeSize = FieldInfo.first;
529 unsigned FieldAlign = FieldInfo.second;
530
531 if (FieldPacked)
532 FieldAlign = 1;
533 if (const AlignedAttr *AA = D->getAttr<AlignedAttr>())
534 FieldAlign = std::max(FieldAlign, AA->getMaxAlignment());
535
536 // The maximum field alignment overrides the aligned attribute.
537 if (MaxFieldAlignment)
538 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
539
540 // Check if we need to add padding to give the field the correct
541 // alignment.
542 if (FieldSize == 0 || (FieldOffset & (FieldAlign-1)) + FieldSize > TypeSize)
543 FieldOffset = (FieldOffset + (FieldAlign-1)) & ~(FieldAlign-1);
544
545 // Padding members don't affect overall alignment
546 if (!D->getIdentifier())
547 FieldAlign = 1;
548
549 // Place this field at the current location.
550 FieldOffsets.push_back(FieldOffset);
551
Anders Carlssone4fc0d92009-11-22 19:13:51 +0000552 // Update DataSize to include the last byte containing (part of) the bitfield.
553 if (IsUnion) {
554 // FIXME: I think FieldSize should be TypeSize here.
555 DataSize = std::max(DataSize, FieldSize);
556 } else {
557 uint64_t NewSizeInBits = FieldOffset + FieldSize;
558
559 DataSize = llvm::RoundUpToAlignment(NewSizeInBits, 8);
560 UnfilledBitsInLastByte = DataSize - NewSizeInBits;
561 }
Anders Carlsson42dbcc42009-11-22 17:37:31 +0000562
Anders Carlssone4fc0d92009-11-22 19:13:51 +0000563 // Update the size.
564 Size = std::max(Size, DataSize);
Anders Carlsson42dbcc42009-11-22 17:37:31 +0000565
566 // Remember max struct/class alignment.
567 UpdateAlignment(FieldAlign);
568}
569
Anders Carlssonbda4c102009-07-18 20:20:21 +0000570void ASTRecordLayoutBuilder::LayoutField(const FieldDecl *D) {
Anders Carlsson42dbcc42009-11-22 17:37:31 +0000571 if (D->isBitField()) {
572 LayoutBitField(D);
573 return;
574 }
575
Anders Carlssone4fc0d92009-11-22 19:13:51 +0000576 // Reset the unfilled bits.
577 UnfilledBitsInLastByte = 0;
578
Anders Carlsson42dbcc42009-11-22 17:37:31 +0000579 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Anders Carlssona2239352009-09-26 01:34:51 +0000580 uint64_t FieldOffset = IsUnion ? 0 : DataSize;
Anders Carlssonbda4c102009-07-18 20:20:21 +0000581 uint64_t FieldSize;
582 unsigned FieldAlign;
Anders Carlsson42dbcc42009-11-22 17:37:31 +0000583
584 if (D->getType()->isIncompleteArrayType()) {
585 // This is a flexible array member; we can't directly
586 // query getTypeInfo about these, so we figure it out here.
587 // Flexible array members don't have any size, but they
588 // have to be aligned appropriately for their element type.
589 FieldSize = 0;
590 const ArrayType* ATy = Ctx.getAsArrayType(D->getType());
591 FieldAlign = Ctx.getTypeAlign(ATy->getElementType());
592 } else if (const ReferenceType *RT = D->getType()->getAs<ReferenceType>()) {
593 unsigned AS = RT->getPointeeType().getAddressSpace();
594 FieldSize = Ctx.Target.getPointerWidth(AS);
595 FieldAlign = Ctx.Target.getPointerAlign(AS);
Anders Carlssonbda4c102009-07-18 20:20:21 +0000596 } else {
Anders Carlsson42dbcc42009-11-22 17:37:31 +0000597 std::pair<uint64_t, unsigned> FieldInfo = Ctx.getTypeInfo(D->getType());
598 FieldSize = FieldInfo.first;
599 FieldAlign = FieldInfo.second;
Anders Carlssonbda4c102009-07-18 20:20:21 +0000600 }
Mike Stump1eb44332009-09-09 15:08:12 +0000601
Anders Carlsson42dbcc42009-11-22 17:37:31 +0000602 if (FieldPacked)
603 FieldAlign = 8;
604 if (const AlignedAttr *AA = D->getAttr<AlignedAttr>())
605 FieldAlign = std::max(FieldAlign, AA->getMaxAlignment());
606
607 // The maximum field alignment overrides the aligned attribute.
608 if (MaxFieldAlignment)
609 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
610
611 // Round up the current record size to the field's alignment boundary.
612 FieldOffset = llvm::RoundUpToAlignment(FieldOffset, FieldAlign);
613
614 if (!IsUnion) {
615 while (true) {
616 // Check if we can place the field at this offset.
617 if (canPlaceFieldAtOffset(D, FieldOffset))
618 break;
619
620 // We couldn't place the field at the offset. Try again at a new offset.
621 FieldOffset += FieldAlign;
622 }
623
624 UpdateEmptyClassOffsets(D, FieldOffset);
625 }
626
Anders Carlssonbda4c102009-07-18 20:20:21 +0000627 // Place this field at the current location.
628 FieldOffsets.push_back(FieldOffset);
Mike Stump1eb44332009-09-09 15:08:12 +0000629
Anders Carlssonbda4c102009-07-18 20:20:21 +0000630 // Reserve space for this field.
631 if (IsUnion)
632 Size = std::max(Size, FieldSize);
633 else
634 Size = FieldOffset + FieldSize;
Mike Stump1eb44332009-09-09 15:08:12 +0000635
Anders Carlssona2239352009-09-26 01:34:51 +0000636 // Update the data size.
637 DataSize = Size;
Mike Stump1eb44332009-09-09 15:08:12 +0000638
Anders Carlssonbda4c102009-07-18 20:20:21 +0000639 // Remember max struct/class alignment.
640 UpdateAlignment(FieldAlign);
641}
642
643void ASTRecordLayoutBuilder::FinishLayout() {
644 // In C++, records cannot be of size 0.
645 if (Ctx.getLangOptions().CPlusPlus && Size == 0)
646 Size = 8;
647 // Finally, round the size of the record up to the alignment of the
648 // record itself.
Anders Carlsson42dbcc42009-11-22 17:37:31 +0000649 Size = llvm::RoundUpToAlignment(Size, Alignment);
Anders Carlssonbda4c102009-07-18 20:20:21 +0000650}
651
652void ASTRecordLayoutBuilder::UpdateAlignment(unsigned NewAlignment) {
653 if (NewAlignment <= Alignment)
654 return;
Mike Stump1eb44332009-09-09 15:08:12 +0000655
Anders Carlssonbda4c102009-07-18 20:20:21 +0000656 assert(llvm::isPowerOf2_32(NewAlignment && "Alignment not a power of 2"));
Mike Stump1eb44332009-09-09 15:08:12 +0000657
Anders Carlssonbda4c102009-07-18 20:20:21 +0000658 Alignment = NewAlignment;
659}
Mike Stump1eb44332009-09-09 15:08:12 +0000660
Anders Carlssonbda4c102009-07-18 20:20:21 +0000661const ASTRecordLayout *
Mike Stump1eb44332009-09-09 15:08:12 +0000662ASTRecordLayoutBuilder::ComputeLayout(ASTContext &Ctx,
Anders Carlssonbda4c102009-07-18 20:20:21 +0000663 const RecordDecl *D) {
664 ASTRecordLayoutBuilder Builder(Ctx);
665
666 Builder.Layout(D);
667
Anders Carlssonb2fafd42009-07-28 19:24:15 +0000668 if (!isa<CXXRecordDecl>(D))
669 return new ASTRecordLayout(Builder.Size, Builder.Alignment, Builder.Size,
Mike Stump1eb44332009-09-09 15:08:12 +0000670 Builder.FieldOffsets.data(),
Anders Carlssonb2fafd42009-07-28 19:24:15 +0000671 Builder.FieldOffsets.size());
Mike Stump1eb44332009-09-09 15:08:12 +0000672
Anders Carlssonb2fafd42009-07-28 19:24:15 +0000673 // FIXME: This is not always correct. See the part about bitfields at
674 // http://www.codesourcery.com/public/cxx-abi/abi.html#POD for more info.
675 // FIXME: IsPODForThePurposeOfLayout should be stored in the record layout.
676 bool IsPODForThePurposeOfLayout = cast<CXXRecordDecl>(D)->isPOD();
Mike Stump1eb44332009-09-09 15:08:12 +0000677
Anders Carlssonb2fafd42009-07-28 19:24:15 +0000678 // FIXME: This should be done in FinalizeLayout.
Mike Stump1eb44332009-09-09 15:08:12 +0000679 uint64_t DataSize =
Anders Carlssona2239352009-09-26 01:34:51 +0000680 IsPODForThePurposeOfLayout ? Builder.Size : Builder.DataSize;
Mike Stump1eb44332009-09-09 15:08:12 +0000681 uint64_t NonVirtualSize =
Anders Carlssonb2fafd42009-07-28 19:24:15 +0000682 IsPODForThePurposeOfLayout ? DataSize : Builder.NonVirtualSize;
Mike Stump1eb44332009-09-09 15:08:12 +0000683
Anders Carlsson74cbe222009-07-19 00:18:47 +0000684 return new ASTRecordLayout(Builder.Size, Builder.Alignment, DataSize,
Mike Stump1eb44332009-09-09 15:08:12 +0000685 Builder.FieldOffsets.data(),
Anders Carlssonb2fafd42009-07-28 19:24:15 +0000686 Builder.FieldOffsets.size(),
687 NonVirtualSize,
688 Builder.NonVirtualAlignment,
Mike Stump6f376332009-08-05 22:37:18 +0000689 Builder.PrimaryBase,
Mike Stump928f1502009-08-07 19:00:50 +0000690 Builder.PrimaryBaseWasVirtual,
Anders Carlssonb2fafd42009-07-28 19:24:15 +0000691 Builder.Bases.data(),
Mike Stump21538912009-08-14 01:44:03 +0000692 Builder.Bases.size(),
693 Builder.VBases.data(),
Mike Stump21538912009-08-14 01:44:03 +0000694 Builder.VBases.size());
Anders Carlsson93fab9d2009-07-18 20:50:59 +0000695}
696
697const ASTRecordLayout *
698ASTRecordLayoutBuilder::ComputeLayout(ASTContext &Ctx,
699 const ObjCInterfaceDecl *D,
700 const ObjCImplementationDecl *Impl) {
701 ASTRecordLayoutBuilder Builder(Ctx);
Mike Stump1eb44332009-09-09 15:08:12 +0000702
Anders Carlsson93fab9d2009-07-18 20:50:59 +0000703 Builder.Layout(D, Impl);
Mike Stump1eb44332009-09-09 15:08:12 +0000704
Anders Carlsson93fab9d2009-07-18 20:50:59 +0000705 return new ASTRecordLayout(Builder.Size, Builder.Alignment,
Anders Carlssona2239352009-09-26 01:34:51 +0000706 Builder.DataSize,
Mike Stump1eb44332009-09-09 15:08:12 +0000707 Builder.FieldOffsets.data(),
Anders Carlssonbda4c102009-07-18 20:20:21 +0000708 Builder.FieldOffsets.size());
709}