blob: 0b159c3a7bd865083bec194fc8df144eb7cb4692 [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"
17#include "clang/AST/RecordLayout.h"
18#include "clang/Basic/TargetInfo.h"
Mike Stumpd8fe7b22009-08-05 22:37:18 +000019#include <llvm/ADT/SmallSet.h>
Anders Carlsson79474332009-07-18 20:20:21 +000020#include <llvm/Support/MathExtras.h>
21
22using namespace clang;
23
Mike Stump11289f42009-09-09 15:08:12 +000024ASTRecordLayoutBuilder::ASTRecordLayoutBuilder(ASTContext &Ctx)
25 : Ctx(Ctx), Size(0), Alignment(8), Packed(false), MaxFieldAlignment(0),
Anders Carlsson47680d82009-09-26 01:34:51 +000026 DataSize(0), IsUnion(false), NonVirtualSize(0), NonVirtualAlignment(8),
Anders Carlsson96cff1f2009-09-22 18:21:58 +000027 PrimaryBase(0), PrimaryBaseWasVirtual(false) {}
Anders Carlsson79474332009-07-18 20:20:21 +000028
Mike Stump25094802009-08-06 00:38:46 +000029/// LayoutVtable - Lay out the vtable and set PrimaryBase.
Anders Carlsson81430692009-09-22 03:02:06 +000030void ASTRecordLayoutBuilder::LayoutVtable(const CXXRecordDecl *RD) {
Mike Stumpaa08da72009-08-12 22:06:55 +000031 if (!RD->isDynamicClass()) {
Mike Stump25094802009-08-06 00:38:46 +000032 // There is no primary base in this case.
Mike Stumpd8fe7b22009-08-05 22:37:18 +000033 return;
Mike Stump25094802009-08-06 00:38:46 +000034 }
Mike Stumpd8fe7b22009-08-05 22:37:18 +000035
Anders Carlsson81430692009-09-22 03:02:06 +000036 SelectPrimaryBase(RD);
Mike Stumpd8fe7b22009-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 Carlsson47680d82009-09-26 01:34:51 +000041 DataSize = Size;
Mike Stumpd8fe7b22009-08-05 22:37:18 +000042 }
Mike Stump3dc7eb92009-07-30 00:22:38 +000043}
44
Mike Stump11289f42009-09-09 15:08:12 +000045void
Anders Carlsson6d9f6f32009-07-19 00:18:47 +000046ASTRecordLayoutBuilder::LayoutNonVirtualBases(const CXXRecordDecl *RD) {
Anders Carlsson6d9f6f32009-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 Redl1054fae2009-10-25 17:03:50 +000050 assert(!i->getType()->isDependentType() &&
51 "Cannot layout class with dependent bases.");
Mike Stump11289f42009-09-09 15:08:12 +000052 const CXXRecordDecl *Base =
Ted Kremenekc23c7e62009-07-29 21:53:49 +000053 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Mike Stump25094802009-08-06 00:38:46 +000054 // Skip the PrimaryBase here, as it is laid down first.
Mike Stumpbcf756c2009-08-14 01:44:03 +000055 if (Base != PrimaryBase || PrimaryBaseWasVirtual)
56 LayoutBaseNonVirtually(Base, false);
Anders Carlsson6d9f6f32009-07-19 00:18:47 +000057 }
58 }
59}
60
Mike Stumpd8fe7b22009-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 Carlsson81430692009-09-22 03:02:06 +000066bool ASTRecordLayoutBuilder::IsNearlyEmpty(const CXXRecordDecl *RD) const {
Mike Stumpd8fe7b22009-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 Carlsson81430692009-09-22 03:02:06 +000076void ASTRecordLayoutBuilder::IdentifyPrimaryBases(const CXXRecordDecl *RD) {
Mike Stump78696a72009-08-11 04:03:59 +000077 const ASTRecordLayout &Layout = Ctx.getASTRecordLayout(RD);
Anders Carlsson81430692009-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 Stumpd8fe7b22009-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 Redl1054fae2009-10-25 17:03:50 +000087 assert(!i->getType()->isDependentType() &&
88 "Cannot layout class with dependent bases.");
Mike Stump11289f42009-09-09 15:08:12 +000089 const CXXRecordDecl *Base =
Mike Stump78696a72009-08-11 04:03:59 +000090 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson81430692009-09-22 03:02:06 +000091
Mike Stump78696a72009-08-11 04:03:59 +000092 // Only bases with virtual bases participate in computing the
93 // indirect primary virtual base classes.
Mike Stumpc2f591b2009-08-13 22:53:07 +000094 if (Base->getNumVBases())
Anders Carlsson81430692009-09-22 03:02:06 +000095 IdentifyPrimaryBases(Base);
Mike Stumpd8fe7b22009-08-05 22:37:18 +000096 }
97}
98
Anders Carlsson81430692009-09-22 03:02:06 +000099void
100ASTRecordLayoutBuilder::SelectPrimaryVBase(const CXXRecordDecl *RD,
101 const CXXRecordDecl *&FirstPrimary) {
Mike Stump6f3793b2009-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 Redl1054fae2009-10-25 17:03:50 +0000104 assert(!i->getType()->isDependentType() &&
105 "Cannot layout class with dependent bases.");
Mike Stump11289f42009-09-09 15:08:12 +0000106 const CXXRecordDecl *Base =
Mike Stump6f3793b2009-08-12 21:50:08 +0000107 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
108 if (!i->isVirtual()) {
Anders Carlsson81430692009-09-22 03:02:06 +0000109 SelectPrimaryVBase(Base, FirstPrimary);
Mike Stump6f3793b2009-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 Carlsson81430692009-09-22 03:02:06 +0000117 if (!IndirectPrimaryBases.count(Base)) {
Mike Stump6f3793b2009-08-12 21:50:08 +0000118 setPrimaryBase(Base, true);
119 return;
120 }
121 }
122 }
123}
124
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000125/// SelectPrimaryBase - Selects the primary base for the given class and
Mike Stump590a7c72009-08-13 23:26:06 +0000126/// record that with setPrimaryBase. We also calculate the IndirectPrimaries.
Anders Carlsson81430692009-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 Stump590a7c72009-08-13 23:26:06 +0000129 // indirect bases, and record all their primary virtual base classes.
Mike Stump590a7c72009-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 Redl1054fae2009-10-25 17:03:50 +0000132 assert(!i->getType()->isDependentType() &&
133 "Cannot layout class with dependent bases.");
Mike Stump11289f42009-09-09 15:08:12 +0000134 const CXXRecordDecl *Base =
Mike Stump590a7c72009-08-13 23:26:06 +0000135 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson81430692009-09-22 03:02:06 +0000136 IdentifyPrimaryBases(Base);
Mike Stump590a7c72009-08-13 23:26:06 +0000137 }
138
Anders Carlsson81430692009-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 Stumpd8fe7b22009-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 Stump11289f42009-09-09 15:08:12 +0000145 const CXXRecordDecl *Base =
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000146 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
147 if (Base->isDynamicClass()) {
Anders Carlsson81430692009-09-22 03:02:06 +0000148 // We found it.
Mike Stumpc266c6d2009-08-07 19:00:50 +0000149 setPrimaryBase(Base, false);
Mike Stumpd8fe7b22009-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 Stump78696a72009-08-11 04:03:59 +0000156 // indirect primary virtual base class, if one exists.
Mike Stumpd8fe7b22009-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 Carlsson96cff1f2009-09-22 18:21:58 +0000160 if (RD->getNumVBases() == 0)
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000161 return;
Anders Carlsson81430692009-09-22 03:02:06 +0000162
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000163 // Then we can search for the first nearly empty virtual base itself.
Anders Carlsson81430692009-09-22 03:02:06 +0000164 const CXXRecordDecl *FirstPrimary = 0;
165 SelectPrimaryVBase(RD, FirstPrimary);
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000166
Mike Stumpc266c6d2009-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 Carlsson55640542009-09-22 19:16:59 +0000169 if (!PrimaryBase)
170 setPrimaryBase(FirstPrimary, true);
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000171}
172
Mike Stump6b2556f2009-08-06 13:41:24 +0000173void ASTRecordLayoutBuilder::LayoutVirtualBase(const CXXRecordDecl *RD) {
Mike Stumpbcf756c2009-08-14 01:44:03 +0000174 LayoutBaseNonVirtually(RD, true);
Mike Stump6b2556f2009-08-06 13:41:24 +0000175}
176
Mike Stump13007542009-08-13 02:02:14 +0000177void ASTRecordLayoutBuilder::LayoutVirtualBases(const CXXRecordDecl *RD,
Mike Stump996576f32009-08-16 19:04:13 +0000178 const CXXRecordDecl *PB,
Mike Stump22ea1f82009-08-16 01:46:26 +0000179 int64_t Offset,
180 llvm::SmallSet<const CXXRecordDecl*, 32> &mark,
Mike Stump13007542009-08-13 02:02:14 +0000181 llvm::SmallSet<const CXXRecordDecl*, 32> &IndirectPrimary) {
Mike Stumpc2f591b2009-08-13 22:53:07 +0000182 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
183 e = RD->bases_end(); i != e; ++i) {
Sebastian Redl1054fae2009-10-25 17:03:50 +0000184 assert(!i->getType()->isDependentType() &&
185 "Cannot layout class with dependent bases.");
Mike Stump11289f42009-09-09 15:08:12 +0000186 const CXXRecordDecl *Base =
Mike Stump6b2556f2009-08-06 13:41:24 +0000187 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Mike Stump22ea1f82009-08-16 01:46:26 +0000188#if 0
189 const ASTRecordLayout &L = Ctx.getASTRecordLayout(Base);
190 const CXXRecordDecl *PB = L.getPrimaryBase();
191 if (PB && L.getPrimaryBaseWasVirtual()
192 && IndirectPrimary.count(PB)) {
193 int64_t BaseOffset;
194 // FIXME: calculate this.
195 BaseOffset = (1<<63) | (1<<31);
196 VBases.push_back(PB);
197 VBaseOffsets.push_back(BaseOffset);
198 }
199#endif
Mike Stump996576f32009-08-16 19:04:13 +0000200 int64_t BaseOffset = Offset;;
201 // FIXME: Calculate BaseOffset.
Mike Stump22ea1f82009-08-16 01:46:26 +0000202 if (i->isVirtual()) {
Mike Stump996576f32009-08-16 19:04:13 +0000203 if (Base == PB) {
204 // Only lay things out once.
205 if (mark.count(Base))
206 continue;
207 // Mark it so we don't lay it out twice.
208 mark.insert(Base);
209 assert (IndirectPrimary.count(Base) && "IndirectPrimary was wrong");
Anders Carlssond6020c32009-09-22 00:04:45 +0000210 VBases.push_back(std::make_pair(Base, Offset));
Mike Stump996576f32009-08-16 19:04:13 +0000211 } else if (IndirectPrimary.count(Base)) {
212 // Someone else will eventually lay this out.
213 ;
214 } else {
215 // Only lay things out once.
216 if (mark.count(Base))
217 continue;
218 // Mark it so we don't lay it out twice.
219 mark.insert(Base);
Mike Stump22ea1f82009-08-16 01:46:26 +0000220 LayoutVirtualBase(Base);
Anders Carlssond6020c32009-09-22 00:04:45 +0000221 BaseOffset = VBases.back().second;
Mike Stump996576f32009-08-16 19:04:13 +0000222 }
Mike Stumpc2f591b2009-08-13 22:53:07 +0000223 }
Mike Stump996576f32009-08-16 19:04:13 +0000224 if (Base->getNumVBases()) {
225 const ASTRecordLayout &L = Ctx.getASTRecordLayout(Base);
226 const CXXRecordDecl *PB = L.getPrimaryBase();
227 LayoutVirtualBases(Base, PB, BaseOffset, mark, IndirectPrimary);
228 }
Mike Stump6b2556f2009-08-06 13:41:24 +0000229 }
230}
231
Anders Carlsson6522b052009-09-24 03:13:30 +0000232bool ASTRecordLayoutBuilder::canPlaceRecordAtOffset(const CXXRecordDecl *RD,
233 uint64_t Offset) const {
Anders Carlssonf24b18f2009-09-24 03:22:10 +0000234 // Look for an empty class with the same type at the same offset.
235 for (EmptyClassOffsetsTy::const_iterator I =
236 EmptyClassOffsets.lower_bound(Offset),
237 E = EmptyClassOffsets.upper_bound(Offset); I != E; ++I) {
238
239 if (I->second == RD)
240 return false;
241 }
242
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000243 const ASTRecordLayout &Info = Ctx.getASTRecordLayout(RD);
244
245 // Check bases.
246 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
247 E = RD->bases_end(); I != E; ++I) {
Sebastian Redl1054fae2009-10-25 17:03:50 +0000248 assert(!I->getType()->isDependentType() &&
249 "Cannot layout class with dependent bases.");
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000250 if (I->isVirtual())
251 continue;
252
253 const CXXRecordDecl *Base =
254 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
255
256 uint64_t BaseClassOffset = Info.getBaseClassOffset(Base);
257
258 if (!canPlaceRecordAtOffset(Base, Offset + BaseClassOffset))
259 return false;
260 }
261
Anders Carlssond7d358a2009-09-25 15:39:00 +0000262 // Check fields.
263 unsigned FieldNo = 0;
264 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
265 I != E; ++I, ++FieldNo) {
266 const FieldDecl *FD = *I;
267
268 uint64_t FieldOffset = Info.getFieldOffset(FieldNo);
269
270 if (!canPlaceFieldAtOffset(FD, Offset + FieldOffset))
271 return false;
272 }
273
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000274 // FIXME: virtual bases.
Anders Carlsson6522b052009-09-24 03:13:30 +0000275 return true;
276}
277
Anders Carlsson6f95c702009-09-25 00:02:51 +0000278bool ASTRecordLayoutBuilder::canPlaceFieldAtOffset(const FieldDecl *FD,
279 uint64_t Offset) const {
Anders Carlsson4bf82142009-09-25 01:23:32 +0000280 QualType T = FD->getType();
281 if (const RecordType *RT = T->getAs<RecordType>()) {
Anders Carlsson6f95c702009-09-25 00:02:51 +0000282 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl()))
283 return canPlaceRecordAtOffset(RD, Offset);
284 }
285
Anders Carlsson4bf82142009-09-25 01:23:32 +0000286 if (const ConstantArrayType *AT = Ctx.getAsConstantArrayType(T)) {
287 QualType ElemTy = Ctx.getBaseElementType(AT);
288 const RecordType *RT = ElemTy->getAs<RecordType>();
289 if (!RT)
290 return true;
291 const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl());
292 if (!RD)
293 return true;
294
295 const ASTRecordLayout &Info = Ctx.getASTRecordLayout(RD);
296
297 uint64_t NumElements = Ctx.getConstantArrayElementCount(AT);
298 unsigned ElementOffset = Offset;
299 for (uint64_t I = 0; I != NumElements; ++I) {
300 if (!canPlaceRecordAtOffset(RD, ElementOffset))
301 return false;
302
303 ElementOffset += Info.getSize();
304 }
305 }
Anders Carlsson6f95c702009-09-25 00:02:51 +0000306
307 return true;
308}
309
Anders Carlsson6522b052009-09-24 03:13:30 +0000310void ASTRecordLayoutBuilder::UpdateEmptyClassOffsets(const CXXRecordDecl *RD,
311 uint64_t Offset) {
Anders Carlssonf24b18f2009-09-24 03:22:10 +0000312 if (RD->isEmpty())
313 EmptyClassOffsets.insert(std::make_pair(Offset, RD));
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000314
315 const ASTRecordLayout &Info = Ctx.getASTRecordLayout(RD);
316
317 // Update bases.
318 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
319 E = RD->bases_end(); I != E; ++I) {
Sebastian Redl1054fae2009-10-25 17:03:50 +0000320 assert(!I->getType()->isDependentType() &&
321 "Cannot layout class with dependent bases.");
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000322 if (I->isVirtual())
323 continue;
Anders Carlssonf24b18f2009-09-24 03:22:10 +0000324
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000325 const CXXRecordDecl *Base =
326 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
327
328 uint64_t BaseClassOffset = Info.getBaseClassOffset(Base);
329 UpdateEmptyClassOffsets(Base, Offset + BaseClassOffset);
330 }
331
Anders Carlssond7d358a2009-09-25 15:39:00 +0000332 // Update fields.
333 unsigned FieldNo = 0;
334 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
335 I != E; ++I, ++FieldNo) {
336 const FieldDecl *FD = *I;
337
338 uint64_t FieldOffset = Info.getFieldOffset(FieldNo);
339 UpdateEmptyClassOffsets(FD, Offset + FieldOffset);
340 }
341
342 // FIXME: Update virtual bases.
Anders Carlsson6522b052009-09-24 03:13:30 +0000343}
344
Anders Carlssone1883102009-09-25 01:54:38 +0000345void
346ASTRecordLayoutBuilder::UpdateEmptyClassOffsets(const FieldDecl *FD,
347 uint64_t Offset) {
348 QualType T = FD->getType();
349
350 if (const RecordType *RT = T->getAs<RecordType>()) {
351 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl())) {
352 UpdateEmptyClassOffsets(RD, Offset);
353 return;
354 }
355 }
356
357 if (const ConstantArrayType *AT = Ctx.getAsConstantArrayType(T)) {
358 QualType ElemTy = Ctx.getBaseElementType(AT);
359 const RecordType *RT = ElemTy->getAs<RecordType>();
360 if (!RT)
361 return;
362 const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl());
363 if (!RD)
364 return;
365
366 const ASTRecordLayout &Info = Ctx.getASTRecordLayout(RD);
367
368 uint64_t NumElements = Ctx.getConstantArrayElementCount(AT);
369 unsigned ElementOffset = Offset;
370
371 for (uint64_t I = 0; I != NumElements; ++I) {
372 UpdateEmptyClassOffsets(RD, ElementOffset);
373 ElementOffset += Info.getSize();
374 }
375 }
376}
377
Anders Carlsson6522b052009-09-24 03:13:30 +0000378uint64_t ASTRecordLayoutBuilder::LayoutBase(const CXXRecordDecl *RD) {
Anders Carlsson6d9f6f32009-07-19 00:18:47 +0000379 const ASTRecordLayout &BaseInfo = Ctx.getASTRecordLayout(RD);
Anders Carlssonf24b18f2009-09-24 03:22:10 +0000380
381 // If we have an empty base class, try to place it at offset 0.
382 if (RD->isEmpty() && canPlaceRecordAtOffset(RD, 0)) {
383 // We were able to place the class at offset 0.
Anders Carlssonf24b18f2009-09-24 03:22:10 +0000384 UpdateEmptyClassOffsets(RD, 0);
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000385
Anders Carlssond7d358a2009-09-25 15:39:00 +0000386 Size = std::max(Size, BaseInfo.getSize());
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000387
Anders Carlssonf24b18f2009-09-24 03:22:10 +0000388 return 0;
Anders Carlsson93b6d5e2009-09-17 04:42:56 +0000389 }
390
Anders Carlssonfc8cfa82009-07-28 19:24:15 +0000391 unsigned BaseAlign = BaseInfo.getNonVirtualAlign();
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000392
Anders Carlsson6d9f6f32009-07-19 00:18:47 +0000393 // Round up the current record size to the base's alignment boundary.
Anders Carlsson47680d82009-09-26 01:34:51 +0000394 uint64_t Offset = llvm::RoundUpToAlignment(DataSize, BaseAlign);
Anders Carlsson6522b052009-09-24 03:13:30 +0000395
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000396 // Try to place the base.
397 while (true) {
398 if (canPlaceRecordAtOffset(RD, Offset))
399 break;
400
401 Offset += BaseAlign;
402 }
403
Anders Carlssond7d358a2009-09-25 15:39:00 +0000404 if (!RD->isEmpty()) {
Anders Carlsson47680d82009-09-26 01:34:51 +0000405 // Update the data size.
406 DataSize = Offset + BaseInfo.getNonVirtualSize();
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000407
Anders Carlsson47680d82009-09-26 01:34:51 +0000408 Size = std::max(Size, DataSize);
Anders Carlssond7d358a2009-09-25 15:39:00 +0000409 } else
410 Size = std::max(Size, Offset + BaseInfo.getSize());
411
Anders Carlsson6522b052009-09-24 03:13:30 +0000412 // Remember max struct/class alignment.
413 UpdateAlignment(BaseAlign);
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000414
415 UpdateEmptyClassOffsets(RD, Offset);
Anders Carlsson6522b052009-09-24 03:13:30 +0000416 return Offset;
417}
418
419void ASTRecordLayoutBuilder::LayoutBaseNonVirtually(const CXXRecordDecl *RD,
420 bool IsVirtualBase) {
421 // Layout the base.
422 unsigned Offset = LayoutBase(RD);
Anders Carlsson6d9f6f32009-07-19 00:18:47 +0000423
Mike Stump22ea1f82009-08-16 01:46:26 +0000424 // Add base class offsets.
Anders Carlssond6020c32009-09-22 00:04:45 +0000425 if (IsVirtualBase)
Anders Carlsson6522b052009-09-24 03:13:30 +0000426 VBases.push_back(std::make_pair(RD, Offset));
Anders Carlssond6020c32009-09-22 00:04:45 +0000427 else
Anders Carlsson6522b052009-09-24 03:13:30 +0000428 Bases.push_back(std::make_pair(RD, Offset));
Anders Carlssonfc8cfa82009-07-28 19:24:15 +0000429
Mike Stump996576f32009-08-16 19:04:13 +0000430#if 0
Mike Stump22ea1f82009-08-16 01:46:26 +0000431 // And now add offsets for all our primary virtual bases as well, so
432 // they all have offsets.
433 const ASTRecordLayout *L = &BaseInfo;
434 const CXXRecordDecl *PB = L->getPrimaryBase();
435 while (PB) {
436 if (L->getPrimaryBaseWasVirtual()) {
437 VBases.push_back(PB);
438 VBaseOffsets.push_back(Size);
439 }
440 PB = L->getPrimaryBase();
441 if (PB)
442 L = &Ctx.getASTRecordLayout(PB);
443 }
Mike Stump996576f32009-08-16 19:04:13 +0000444#endif
Anders Carlsson6d9f6f32009-07-19 00:18:47 +0000445}
446
Anders Carlsson79474332009-07-18 20:20:21 +0000447void ASTRecordLayoutBuilder::Layout(const RecordDecl *D) {
448 IsUnion = D->isUnion();
Anders Carlsson68e0b682009-08-08 18:23:56 +0000449
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000450 Packed = D->hasAttr<PackedAttr>();
451
452 // The #pragma pack attribute specifies the maximum field alignment.
Anders Carlsson68e0b682009-08-08 18:23:56 +0000453 if (const PragmaPackAttr *PPA = D->getAttr<PragmaPackAttr>())
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000454 MaxFieldAlignment = PPA->getAlignment();
Mike Stump11289f42009-09-09 15:08:12 +0000455
Anders Carlsson79474332009-07-18 20:20:21 +0000456 if (const AlignedAttr *AA = D->getAttr<AlignedAttr>())
457 UpdateAlignment(AA->getAlignment());
Anders Carlsson6d9f6f32009-07-19 00:18:47 +0000458
Mike Stump22ea1f82009-08-16 01:46:26 +0000459 // If this is a C++ class, lay out the vtable and the non-virtual bases.
Mike Stump6b2556f2009-08-06 13:41:24 +0000460 const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D);
461 if (RD) {
Anders Carlsson81430692009-09-22 03:02:06 +0000462 LayoutVtable(RD);
Mike Stump25094802009-08-06 00:38:46 +0000463 // PrimaryBase goes first.
Mike Stump13007542009-08-13 02:02:14 +0000464 if (PrimaryBase) {
Mike Stump13007542009-08-13 02:02:14 +0000465 if (PrimaryBaseWasVirtual)
Anders Carlsson81430692009-09-22 03:02:06 +0000466 IndirectPrimaryBases.insert(PrimaryBase);
Mike Stumpbcf756c2009-08-14 01:44:03 +0000467 LayoutBaseNonVirtually(PrimaryBase, PrimaryBaseWasVirtual);
Mike Stump13007542009-08-13 02:02:14 +0000468 }
Mike Stump3dc7eb92009-07-30 00:22:38 +0000469 LayoutNonVirtualBases(RD);
Mike Stump3dc7eb92009-07-30 00:22:38 +0000470 }
Anders Carlsson6d9f6f32009-07-19 00:18:47 +0000471
Anders Carlsson118ce162009-07-18 21:48:39 +0000472 LayoutFields(D);
Mike Stump11289f42009-09-09 15:08:12 +0000473
Anders Carlssonfc8cfa82009-07-28 19:24:15 +0000474 NonVirtualSize = Size;
475 NonVirtualAlignment = Alignment;
Mike Stump3dc7eb92009-07-30 00:22:38 +0000476
Mike Stump22ea1f82009-08-16 01:46:26 +0000477 if (RD) {
478 llvm::SmallSet<const CXXRecordDecl*, 32> mark;
Anders Carlsson81430692009-09-22 03:02:06 +0000479 LayoutVirtualBases(RD, PrimaryBase, 0, mark, IndirectPrimaryBases);
Mike Stump22ea1f82009-08-16 01:46:26 +0000480 }
Mike Stump6b2556f2009-08-06 13:41:24 +0000481
Anders Carlsson79474332009-07-18 20:20:21 +0000482 // Finally, round the size of the total struct up to the alignment of the
483 // struct itself.
484 FinishLayout();
485}
486
Anders Carlsson4f516282009-07-18 20:50:59 +0000487void ASTRecordLayoutBuilder::Layout(const ObjCInterfaceDecl *D,
488 const ObjCImplementationDecl *Impl) {
489 if (ObjCInterfaceDecl *SD = D->getSuperClass()) {
490 const ASTRecordLayout &SL = Ctx.getASTObjCInterfaceLayout(SD);
491
492 UpdateAlignment(SL.getAlignment());
Mike Stump11289f42009-09-09 15:08:12 +0000493
Anders Carlsson4f516282009-07-18 20:50:59 +0000494 // We start laying out ivars not at the end of the superclass
495 // structure, but at the next byte following the last field.
Anders Carlsson27b50132009-07-18 21:26:44 +0000496 Size = llvm::RoundUpToAlignment(SL.getDataSize(), 8);
Anders Carlsson47680d82009-09-26 01:34:51 +0000497 DataSize = Size;
Anders Carlsson4f516282009-07-18 20:50:59 +0000498 }
Mike Stump11289f42009-09-09 15:08:12 +0000499
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000500 Packed = D->hasAttr<PackedAttr>();
Mike Stump11289f42009-09-09 15:08:12 +0000501
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000502 // The #pragma pack attribute specifies the maximum field alignment.
503 if (const PragmaPackAttr *PPA = D->getAttr<PragmaPackAttr>())
504 MaxFieldAlignment = PPA->getAlignment();
Mike Stump11289f42009-09-09 15:08:12 +0000505
Anders Carlsson4f516282009-07-18 20:50:59 +0000506 if (const AlignedAttr *AA = D->getAttr<AlignedAttr>())
507 UpdateAlignment(AA->getAlignment());
Mike Stump11289f42009-09-09 15:08:12 +0000508
Anders Carlsson4f516282009-07-18 20:50:59 +0000509 // Layout each ivar sequentially.
510 llvm::SmallVector<ObjCIvarDecl*, 16> Ivars;
511 Ctx.ShallowCollectObjCIvars(D, Ivars, Impl);
512 for (unsigned i = 0, e = Ivars.size(); i != e; ++i)
513 LayoutField(Ivars[i]);
Mike Stump11289f42009-09-09 15:08:12 +0000514
Anders Carlsson4f516282009-07-18 20:50:59 +0000515 // Finally, round the size of the total struct up to the alignment of the
516 // struct itself.
517 FinishLayout();
518}
519
Anders Carlsson118ce162009-07-18 21:48:39 +0000520void ASTRecordLayoutBuilder::LayoutFields(const RecordDecl *D) {
521 // Layout each field, for now, just sequentially, respecting alignment. In
522 // the future, this will need to be tweakable by targets.
Mike Stump11289f42009-09-09 15:08:12 +0000523 for (RecordDecl::field_iterator Field = D->field_begin(),
Anders Carlsson118ce162009-07-18 21:48:39 +0000524 FieldEnd = D->field_end(); Field != FieldEnd; ++Field)
525 LayoutField(*Field);
526}
527
Anders Carlsson79474332009-07-18 20:20:21 +0000528void ASTRecordLayoutBuilder::LayoutField(const FieldDecl *D) {
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000529 bool FieldPacked = Packed;
Anders Carlsson47680d82009-09-26 01:34:51 +0000530 uint64_t FieldOffset = IsUnion ? 0 : DataSize;
Anders Carlsson79474332009-07-18 20:20:21 +0000531 uint64_t FieldSize;
532 unsigned FieldAlign;
Mike Stump11289f42009-09-09 15:08:12 +0000533
534 FieldPacked |= D->hasAttr<PackedAttr>();
535
Anders Carlsson79474332009-07-18 20:20:21 +0000536 if (const Expr *BitWidthExpr = D->getBitWidth()) {
537 // TODO: Need to check this algorithm on other targets!
538 // (tested on Linux-X86)
539 FieldSize = BitWidthExpr->EvaluateAsInt(Ctx).getZExtValue();
Mike Stump11289f42009-09-09 15:08:12 +0000540
Anders Carlsson79474332009-07-18 20:20:21 +0000541 std::pair<uint64_t, unsigned> FieldInfo = Ctx.getTypeInfo(D->getType());
542 uint64_t TypeSize = FieldInfo.first;
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000543
Anders Carlsson79474332009-07-18 20:20:21 +0000544 FieldAlign = FieldInfo.second;
Mike Stump11289f42009-09-09 15:08:12 +0000545
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000546 if (FieldPacked)
547 FieldAlign = 1;
Anders Carlsson79474332009-07-18 20:20:21 +0000548 if (const AlignedAttr *AA = D->getAttr<AlignedAttr>())
549 FieldAlign = std::max(FieldAlign, AA->getAlignment());
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000550 // The maximum field alignment overrides the aligned attribute.
551 if (MaxFieldAlignment)
552 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
553
Anders Carlsson79474332009-07-18 20:20:21 +0000554 // Check if we need to add padding to give the field the correct
555 // alignment.
556 if (FieldSize == 0 || (FieldOffset & (FieldAlign-1)) + FieldSize > TypeSize)
557 FieldOffset = (FieldOffset + (FieldAlign-1)) & ~(FieldAlign-1);
Mike Stump11289f42009-09-09 15:08:12 +0000558
Anders Carlsson79474332009-07-18 20:20:21 +0000559 // Padding members don't affect overall alignment
560 if (!D->getIdentifier())
561 FieldAlign = 1;
562 } else {
563 if (D->getType()->isIncompleteArrayType()) {
564 // This is a flexible array member; we can't directly
565 // query getTypeInfo about these, so we figure it out here.
566 // Flexible array members don't have any size, but they
567 // have to be aligned appropriately for their element type.
568 FieldSize = 0;
569 const ArrayType* ATy = Ctx.getAsArrayType(D->getType());
570 FieldAlign = Ctx.getTypeAlign(ATy->getElementType());
Ted Kremenekc23c7e62009-07-29 21:53:49 +0000571 } else if (const ReferenceType *RT = D->getType()->getAs<ReferenceType>()) {
Anders Carlsson79474332009-07-18 20:20:21 +0000572 unsigned AS = RT->getPointeeType().getAddressSpace();
573 FieldSize = Ctx.Target.getPointerWidth(AS);
574 FieldAlign = Ctx.Target.getPointerAlign(AS);
575 } else {
576 std::pair<uint64_t, unsigned> FieldInfo = Ctx.getTypeInfo(D->getType());
577 FieldSize = FieldInfo.first;
578 FieldAlign = FieldInfo.second;
579 }
Mike Stump11289f42009-09-09 15:08:12 +0000580
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000581 if (FieldPacked)
582 FieldAlign = 8;
Anders Carlsson79474332009-07-18 20:20:21 +0000583 if (const AlignedAttr *AA = D->getAttr<AlignedAttr>())
584 FieldAlign = std::max(FieldAlign, AA->getAlignment());
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000585 // The maximum field alignment overrides the aligned attribute.
586 if (MaxFieldAlignment)
587 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
Mike Stump11289f42009-09-09 15:08:12 +0000588
Anders Carlsson79474332009-07-18 20:20:21 +0000589 // Round up the current record size to the field's alignment boundary.
Anders Carlsson6522b052009-09-24 03:13:30 +0000590 FieldOffset = llvm::RoundUpToAlignment(FieldOffset, FieldAlign);
Anders Carlsson6f95c702009-09-25 00:02:51 +0000591
592 if (!IsUnion) {
593 while (true) {
594 // Check if we can place the field at this offset.
595 if (canPlaceFieldAtOffset(D, FieldOffset))
596 break;
597
Anders Carlsson534b0632009-09-26 16:55:29 +0000598 // We couldn't place the field at the offset. Try again at a new offset.
Anders Carlsson6f95c702009-09-25 00:02:51 +0000599 FieldOffset += FieldAlign;
600 }
Anders Carlssone1883102009-09-25 01:54:38 +0000601
602 UpdateEmptyClassOffsets(D, FieldOffset);
Anders Carlsson6f95c702009-09-25 00:02:51 +0000603 }
Anders Carlsson79474332009-07-18 20:20:21 +0000604 }
Mike Stump11289f42009-09-09 15:08:12 +0000605
Anders Carlsson79474332009-07-18 20:20:21 +0000606 // Place this field at the current location.
607 FieldOffsets.push_back(FieldOffset);
Mike Stump11289f42009-09-09 15:08:12 +0000608
Anders Carlsson79474332009-07-18 20:20:21 +0000609 // Reserve space for this field.
610 if (IsUnion)
611 Size = std::max(Size, FieldSize);
612 else
613 Size = FieldOffset + FieldSize;
Mike Stump11289f42009-09-09 15:08:12 +0000614
Anders Carlsson47680d82009-09-26 01:34:51 +0000615 // Update the data size.
616 DataSize = Size;
Mike Stump11289f42009-09-09 15:08:12 +0000617
Anders Carlsson79474332009-07-18 20:20:21 +0000618 // Remember max struct/class alignment.
619 UpdateAlignment(FieldAlign);
620}
621
622void ASTRecordLayoutBuilder::FinishLayout() {
623 // In C++, records cannot be of size 0.
624 if (Ctx.getLangOptions().CPlusPlus && Size == 0)
625 Size = 8;
626 // Finally, round the size of the record up to the alignment of the
627 // record itself.
628 Size = (Size + (Alignment-1)) & ~(Alignment-1);
629}
630
631void ASTRecordLayoutBuilder::UpdateAlignment(unsigned NewAlignment) {
632 if (NewAlignment <= Alignment)
633 return;
Mike Stump11289f42009-09-09 15:08:12 +0000634
Anders Carlsson79474332009-07-18 20:20:21 +0000635 assert(llvm::isPowerOf2_32(NewAlignment && "Alignment not a power of 2"));
Mike Stump11289f42009-09-09 15:08:12 +0000636
Anders Carlsson79474332009-07-18 20:20:21 +0000637 Alignment = NewAlignment;
638}
Mike Stump11289f42009-09-09 15:08:12 +0000639
Anders Carlsson79474332009-07-18 20:20:21 +0000640const ASTRecordLayout *
Mike Stump11289f42009-09-09 15:08:12 +0000641ASTRecordLayoutBuilder::ComputeLayout(ASTContext &Ctx,
Anders Carlsson79474332009-07-18 20:20:21 +0000642 const RecordDecl *D) {
643 ASTRecordLayoutBuilder Builder(Ctx);
644
645 Builder.Layout(D);
646
Anders Carlssonfc8cfa82009-07-28 19:24:15 +0000647 if (!isa<CXXRecordDecl>(D))
648 return new ASTRecordLayout(Builder.Size, Builder.Alignment, Builder.Size,
Mike Stump11289f42009-09-09 15:08:12 +0000649 Builder.FieldOffsets.data(),
Anders Carlssonfc8cfa82009-07-28 19:24:15 +0000650 Builder.FieldOffsets.size());
Mike Stump11289f42009-09-09 15:08:12 +0000651
Anders Carlssonfc8cfa82009-07-28 19:24:15 +0000652 // FIXME: This is not always correct. See the part about bitfields at
653 // http://www.codesourcery.com/public/cxx-abi/abi.html#POD for more info.
654 // FIXME: IsPODForThePurposeOfLayout should be stored in the record layout.
655 bool IsPODForThePurposeOfLayout = cast<CXXRecordDecl>(D)->isPOD();
Mike Stump11289f42009-09-09 15:08:12 +0000656
Anders Carlssonfc8cfa82009-07-28 19:24:15 +0000657 // FIXME: This should be done in FinalizeLayout.
Mike Stump11289f42009-09-09 15:08:12 +0000658 uint64_t DataSize =
Anders Carlsson47680d82009-09-26 01:34:51 +0000659 IsPODForThePurposeOfLayout ? Builder.Size : Builder.DataSize;
Mike Stump11289f42009-09-09 15:08:12 +0000660 uint64_t NonVirtualSize =
Anders Carlssonfc8cfa82009-07-28 19:24:15 +0000661 IsPODForThePurposeOfLayout ? DataSize : Builder.NonVirtualSize;
Mike Stump11289f42009-09-09 15:08:12 +0000662
Anders Carlsson6d9f6f32009-07-19 00:18:47 +0000663 return new ASTRecordLayout(Builder.Size, Builder.Alignment, DataSize,
Mike Stump11289f42009-09-09 15:08:12 +0000664 Builder.FieldOffsets.data(),
Anders Carlssonfc8cfa82009-07-28 19:24:15 +0000665 Builder.FieldOffsets.size(),
666 NonVirtualSize,
667 Builder.NonVirtualAlignment,
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000668 Builder.PrimaryBase,
Mike Stumpc266c6d2009-08-07 19:00:50 +0000669 Builder.PrimaryBaseWasVirtual,
Anders Carlssonfc8cfa82009-07-28 19:24:15 +0000670 Builder.Bases.data(),
Mike Stumpbcf756c2009-08-14 01:44:03 +0000671 Builder.Bases.size(),
672 Builder.VBases.data(),
Mike Stumpbcf756c2009-08-14 01:44:03 +0000673 Builder.VBases.size());
Anders Carlsson4f516282009-07-18 20:50:59 +0000674}
675
676const ASTRecordLayout *
677ASTRecordLayoutBuilder::ComputeLayout(ASTContext &Ctx,
678 const ObjCInterfaceDecl *D,
679 const ObjCImplementationDecl *Impl) {
680 ASTRecordLayoutBuilder Builder(Ctx);
Mike Stump11289f42009-09-09 15:08:12 +0000681
Anders Carlsson4f516282009-07-18 20:50:59 +0000682 Builder.Layout(D, Impl);
Mike Stump11289f42009-09-09 15:08:12 +0000683
Anders Carlsson4f516282009-07-18 20:50:59 +0000684 return new ASTRecordLayout(Builder.Size, Builder.Alignment,
Anders Carlsson47680d82009-09-26 01:34:51 +0000685 Builder.DataSize,
Mike Stump11289f42009-09-09 15:08:12 +0000686 Builder.FieldOffsets.data(),
Anders Carlsson79474332009-07-18 20:20:21 +0000687 Builder.FieldOffsets.size());
688}