blob: 021c53e9514f67f3957dfe6c1b8913e6cf7ed0d7 [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 Stump2b84dd32009-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 Stump996576f32009-08-16 19:04:13 +0000193 const CXXRecordDecl *PB,
Mike Stump2b84dd32009-11-05 04:02:15 +0000194 uint64_t Offset,
Mike Stump22ea1f82009-08-16 01:46:26 +0000195 llvm::SmallSet<const CXXRecordDecl*, 32> &mark,
Mike Stump13007542009-08-13 02:02:14 +0000196 llvm::SmallSet<const CXXRecordDecl*, 32> &IndirectPrimary) {
Mike Stumpc2f591b2009-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 Redl1054fae2009-10-25 17:03:50 +0000199 assert(!i->getType()->isDependentType() &&
200 "Cannot layout class with dependent bases.");
Mike Stump11289f42009-09-09 15:08:12 +0000201 const CXXRecordDecl *Base =
Mike Stump6b2556f2009-08-06 13:41:24 +0000202 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Mike Stump2b84dd32009-11-05 04:02:15 +0000203 uint64_t BaseOffset = Offset;
Mike Stump22ea1f82009-08-16 01:46:26 +0000204 if (i->isVirtual()) {
Mike Stump996576f32009-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 Carlssond6020c32009-09-22 00:04:45 +0000212 VBases.push_back(std::make_pair(Base, Offset));
Mike Stump996576f32009-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 Stump22ea1f82009-08-16 01:46:26 +0000222 LayoutVirtualBase(Base);
Anders Carlssond6020c32009-09-22 00:04:45 +0000223 BaseOffset = VBases.back().second;
Mike Stump996576f32009-08-16 19:04:13 +0000224 }
Mike Stump2b84dd32009-11-05 04:02:15 +0000225 } else {
226 if (RD == Class)
227 BaseOffset = getBaseOffset(Base);
228 else {
229 const ASTRecordLayout &Layout
230 = Ctx.getASTRecordLayout(RD);
231 BaseOffset = Offset + Layout.getBaseClassOffset(Base);
232 }
Mike Stumpc2f591b2009-08-13 22:53:07 +0000233 }
Mike Stump2b84dd32009-11-05 04:02:15 +0000234
Mike Stump996576f32009-08-16 19:04:13 +0000235 if (Base->getNumVBases()) {
236 const ASTRecordLayout &L = Ctx.getASTRecordLayout(Base);
237 const CXXRecordDecl *PB = L.getPrimaryBase();
Mike Stump2b84dd32009-11-05 04:02:15 +0000238 LayoutVirtualBases(Class, Base, PB, BaseOffset, mark, IndirectPrimary);
Mike Stump996576f32009-08-16 19:04:13 +0000239 }
Mike Stump6b2556f2009-08-06 13:41:24 +0000240 }
241}
242
Anders Carlsson6522b052009-09-24 03:13:30 +0000243bool ASTRecordLayoutBuilder::canPlaceRecordAtOffset(const CXXRecordDecl *RD,
244 uint64_t Offset) const {
Anders Carlssonf24b18f2009-09-24 03:22:10 +0000245 // Look for an empty class with the same type at the same offset.
246 for (EmptyClassOffsetsTy::const_iterator I =
247 EmptyClassOffsets.lower_bound(Offset),
248 E = EmptyClassOffsets.upper_bound(Offset); I != E; ++I) {
249
250 if (I->second == RD)
251 return false;
252 }
253
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000254 const ASTRecordLayout &Info = Ctx.getASTRecordLayout(RD);
255
256 // Check bases.
257 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
258 E = RD->bases_end(); I != E; ++I) {
Sebastian Redl1054fae2009-10-25 17:03:50 +0000259 assert(!I->getType()->isDependentType() &&
260 "Cannot layout class with dependent bases.");
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000261 if (I->isVirtual())
262 continue;
263
264 const CXXRecordDecl *Base =
265 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
266
267 uint64_t BaseClassOffset = Info.getBaseClassOffset(Base);
268
269 if (!canPlaceRecordAtOffset(Base, Offset + BaseClassOffset))
270 return false;
271 }
272
Anders Carlssond7d358a2009-09-25 15:39:00 +0000273 // Check fields.
274 unsigned FieldNo = 0;
275 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
276 I != E; ++I, ++FieldNo) {
277 const FieldDecl *FD = *I;
278
279 uint64_t FieldOffset = Info.getFieldOffset(FieldNo);
280
281 if (!canPlaceFieldAtOffset(FD, Offset + FieldOffset))
282 return false;
283 }
284
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000285 // FIXME: virtual bases.
Anders Carlsson6522b052009-09-24 03:13:30 +0000286 return true;
287}
288
Anders Carlsson6f95c702009-09-25 00:02:51 +0000289bool ASTRecordLayoutBuilder::canPlaceFieldAtOffset(const FieldDecl *FD,
290 uint64_t Offset) const {
Anders Carlsson4bf82142009-09-25 01:23:32 +0000291 QualType T = FD->getType();
292 if (const RecordType *RT = T->getAs<RecordType>()) {
Anders Carlsson6f95c702009-09-25 00:02:51 +0000293 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl()))
294 return canPlaceRecordAtOffset(RD, Offset);
295 }
296
Anders Carlsson4bf82142009-09-25 01:23:32 +0000297 if (const ConstantArrayType *AT = Ctx.getAsConstantArrayType(T)) {
298 QualType ElemTy = Ctx.getBaseElementType(AT);
299 const RecordType *RT = ElemTy->getAs<RecordType>();
300 if (!RT)
301 return true;
302 const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl());
303 if (!RD)
304 return true;
305
306 const ASTRecordLayout &Info = Ctx.getASTRecordLayout(RD);
307
308 uint64_t NumElements = Ctx.getConstantArrayElementCount(AT);
Mike Stump2b84dd32009-11-05 04:02:15 +0000309 uint64_t ElementOffset = Offset;
Anders Carlsson4bf82142009-09-25 01:23:32 +0000310 for (uint64_t I = 0; I != NumElements; ++I) {
311 if (!canPlaceRecordAtOffset(RD, ElementOffset))
312 return false;
313
314 ElementOffset += Info.getSize();
315 }
316 }
Anders Carlsson6f95c702009-09-25 00:02:51 +0000317
318 return true;
319}
320
Anders Carlsson6522b052009-09-24 03:13:30 +0000321void ASTRecordLayoutBuilder::UpdateEmptyClassOffsets(const CXXRecordDecl *RD,
322 uint64_t Offset) {
Anders Carlssonf24b18f2009-09-24 03:22:10 +0000323 if (RD->isEmpty())
324 EmptyClassOffsets.insert(std::make_pair(Offset, RD));
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000325
326 const ASTRecordLayout &Info = Ctx.getASTRecordLayout(RD);
327
328 // Update bases.
329 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
330 E = RD->bases_end(); I != E; ++I) {
Sebastian Redl1054fae2009-10-25 17:03:50 +0000331 assert(!I->getType()->isDependentType() &&
332 "Cannot layout class with dependent bases.");
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000333 if (I->isVirtual())
334 continue;
Anders Carlssonf24b18f2009-09-24 03:22:10 +0000335
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000336 const CXXRecordDecl *Base =
337 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
338
339 uint64_t BaseClassOffset = Info.getBaseClassOffset(Base);
340 UpdateEmptyClassOffsets(Base, Offset + BaseClassOffset);
341 }
342
Anders Carlssond7d358a2009-09-25 15:39:00 +0000343 // Update fields.
344 unsigned FieldNo = 0;
345 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
346 I != E; ++I, ++FieldNo) {
347 const FieldDecl *FD = *I;
348
349 uint64_t FieldOffset = Info.getFieldOffset(FieldNo);
350 UpdateEmptyClassOffsets(FD, Offset + FieldOffset);
351 }
352
353 // FIXME: Update virtual bases.
Anders Carlsson6522b052009-09-24 03:13:30 +0000354}
355
Anders Carlssone1883102009-09-25 01:54:38 +0000356void
357ASTRecordLayoutBuilder::UpdateEmptyClassOffsets(const FieldDecl *FD,
358 uint64_t Offset) {
359 QualType T = FD->getType();
360
361 if (const RecordType *RT = T->getAs<RecordType>()) {
362 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl())) {
363 UpdateEmptyClassOffsets(RD, Offset);
364 return;
365 }
366 }
367
368 if (const ConstantArrayType *AT = Ctx.getAsConstantArrayType(T)) {
369 QualType ElemTy = Ctx.getBaseElementType(AT);
370 const RecordType *RT = ElemTy->getAs<RecordType>();
371 if (!RT)
372 return;
373 const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl());
374 if (!RD)
375 return;
376
377 const ASTRecordLayout &Info = Ctx.getASTRecordLayout(RD);
378
379 uint64_t NumElements = Ctx.getConstantArrayElementCount(AT);
Mike Stump2b84dd32009-11-05 04:02:15 +0000380 uint64_t ElementOffset = Offset;
Anders Carlssone1883102009-09-25 01:54:38 +0000381
382 for (uint64_t I = 0; I != NumElements; ++I) {
383 UpdateEmptyClassOffsets(RD, ElementOffset);
384 ElementOffset += Info.getSize();
385 }
386 }
387}
388
Anders Carlsson6522b052009-09-24 03:13:30 +0000389uint64_t ASTRecordLayoutBuilder::LayoutBase(const CXXRecordDecl *RD) {
Anders Carlsson6d9f6f32009-07-19 00:18:47 +0000390 const ASTRecordLayout &BaseInfo = Ctx.getASTRecordLayout(RD);
Anders Carlssonf24b18f2009-09-24 03:22:10 +0000391
392 // If we have an empty base class, try to place it at offset 0.
393 if (RD->isEmpty() && canPlaceRecordAtOffset(RD, 0)) {
394 // We were able to place the class at offset 0.
Anders Carlssonf24b18f2009-09-24 03:22:10 +0000395 UpdateEmptyClassOffsets(RD, 0);
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000396
Anders Carlssond7d358a2009-09-25 15:39:00 +0000397 Size = std::max(Size, BaseInfo.getSize());
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000398
Anders Carlssonf24b18f2009-09-24 03:22:10 +0000399 return 0;
Anders Carlsson93b6d5e2009-09-17 04:42:56 +0000400 }
401
Anders Carlssonfc8cfa82009-07-28 19:24:15 +0000402 unsigned BaseAlign = BaseInfo.getNonVirtualAlign();
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000403
Anders Carlsson6d9f6f32009-07-19 00:18:47 +0000404 // Round up the current record size to the base's alignment boundary.
Anders Carlsson47680d82009-09-26 01:34:51 +0000405 uint64_t Offset = llvm::RoundUpToAlignment(DataSize, BaseAlign);
Anders Carlsson6522b052009-09-24 03:13:30 +0000406
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000407 // Try to place the base.
408 while (true) {
409 if (canPlaceRecordAtOffset(RD, Offset))
410 break;
411
412 Offset += BaseAlign;
413 }
414
Anders Carlssond7d358a2009-09-25 15:39:00 +0000415 if (!RD->isEmpty()) {
Anders Carlsson47680d82009-09-26 01:34:51 +0000416 // Update the data size.
417 DataSize = Offset + BaseInfo.getNonVirtualSize();
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000418
Anders Carlsson47680d82009-09-26 01:34:51 +0000419 Size = std::max(Size, DataSize);
Anders Carlssond7d358a2009-09-25 15:39:00 +0000420 } else
421 Size = std::max(Size, Offset + BaseInfo.getSize());
422
Anders Carlsson6522b052009-09-24 03:13:30 +0000423 // Remember max struct/class alignment.
424 UpdateAlignment(BaseAlign);
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000425
426 UpdateEmptyClassOffsets(RD, Offset);
Anders Carlsson6522b052009-09-24 03:13:30 +0000427 return Offset;
428}
429
430void ASTRecordLayoutBuilder::LayoutBaseNonVirtually(const CXXRecordDecl *RD,
431 bool IsVirtualBase) {
432 // Layout the base.
Mike Stump2b84dd32009-11-05 04:02:15 +0000433 uint64_t Offset = LayoutBase(RD);
Anders Carlsson6d9f6f32009-07-19 00:18:47 +0000434
Mike Stump22ea1f82009-08-16 01:46:26 +0000435 // Add base class offsets.
Anders Carlssond6020c32009-09-22 00:04:45 +0000436 if (IsVirtualBase)
Anders Carlsson6522b052009-09-24 03:13:30 +0000437 VBases.push_back(std::make_pair(RD, Offset));
Anders Carlssond6020c32009-09-22 00:04:45 +0000438 else
Anders Carlsson6522b052009-09-24 03:13:30 +0000439 Bases.push_back(std::make_pair(RD, Offset));
Anders Carlsson6d9f6f32009-07-19 00:18:47 +0000440}
441
Anders Carlsson79474332009-07-18 20:20:21 +0000442void ASTRecordLayoutBuilder::Layout(const RecordDecl *D) {
443 IsUnion = D->isUnion();
Anders Carlsson68e0b682009-08-08 18:23:56 +0000444
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000445 Packed = D->hasAttr<PackedAttr>();
446
447 // The #pragma pack attribute specifies the maximum field alignment.
Anders Carlsson68e0b682009-08-08 18:23:56 +0000448 if (const PragmaPackAttr *PPA = D->getAttr<PragmaPackAttr>())
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000449 MaxFieldAlignment = PPA->getAlignment();
Mike Stump11289f42009-09-09 15:08:12 +0000450
Anders Carlsson79474332009-07-18 20:20:21 +0000451 if (const AlignedAttr *AA = D->getAttr<AlignedAttr>())
452 UpdateAlignment(AA->getAlignment());
Anders Carlsson6d9f6f32009-07-19 00:18:47 +0000453
Mike Stump22ea1f82009-08-16 01:46:26 +0000454 // If this is a C++ class, lay out the vtable and the non-virtual bases.
Mike Stump6b2556f2009-08-06 13:41:24 +0000455 const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D);
456 if (RD) {
Anders Carlsson81430692009-09-22 03:02:06 +0000457 LayoutVtable(RD);
Mike Stump25094802009-08-06 00:38:46 +0000458 // PrimaryBase goes first.
Mike Stump13007542009-08-13 02:02:14 +0000459 if (PrimaryBase) {
Mike Stump13007542009-08-13 02:02:14 +0000460 if (PrimaryBaseWasVirtual)
Anders Carlsson81430692009-09-22 03:02:06 +0000461 IndirectPrimaryBases.insert(PrimaryBase);
Mike Stumpbcf756c2009-08-14 01:44:03 +0000462 LayoutBaseNonVirtually(PrimaryBase, PrimaryBaseWasVirtual);
Mike Stump13007542009-08-13 02:02:14 +0000463 }
Mike Stump3dc7eb92009-07-30 00:22:38 +0000464 LayoutNonVirtualBases(RD);
Mike Stump3dc7eb92009-07-30 00:22:38 +0000465 }
Anders Carlsson6d9f6f32009-07-19 00:18:47 +0000466
Anders Carlsson118ce162009-07-18 21:48:39 +0000467 LayoutFields(D);
Mike Stump11289f42009-09-09 15:08:12 +0000468
Anders Carlssonfc8cfa82009-07-28 19:24:15 +0000469 NonVirtualSize = Size;
470 NonVirtualAlignment = Alignment;
Mike Stump3dc7eb92009-07-30 00:22:38 +0000471
Mike Stump22ea1f82009-08-16 01:46:26 +0000472 if (RD) {
473 llvm::SmallSet<const CXXRecordDecl*, 32> mark;
Mike Stump2b84dd32009-11-05 04:02:15 +0000474 LayoutVirtualBases(RD, RD, PrimaryBase, 0, mark, IndirectPrimaryBases);
Mike Stump22ea1f82009-08-16 01:46:26 +0000475 }
Mike Stump6b2556f2009-08-06 13:41:24 +0000476
Anders Carlsson79474332009-07-18 20:20:21 +0000477 // Finally, round the size of the total struct up to the alignment of the
478 // struct itself.
479 FinishLayout();
480}
481
Anders Carlsson4f516282009-07-18 20:50:59 +0000482void ASTRecordLayoutBuilder::Layout(const ObjCInterfaceDecl *D,
483 const ObjCImplementationDecl *Impl) {
484 if (ObjCInterfaceDecl *SD = D->getSuperClass()) {
485 const ASTRecordLayout &SL = Ctx.getASTObjCInterfaceLayout(SD);
486
487 UpdateAlignment(SL.getAlignment());
Mike Stump11289f42009-09-09 15:08:12 +0000488
Anders Carlsson4f516282009-07-18 20:50:59 +0000489 // We start laying out ivars not at the end of the superclass
490 // structure, but at the next byte following the last field.
Anders Carlsson27b50132009-07-18 21:26:44 +0000491 Size = llvm::RoundUpToAlignment(SL.getDataSize(), 8);
Anders Carlsson47680d82009-09-26 01:34:51 +0000492 DataSize = Size;
Anders Carlsson4f516282009-07-18 20:50:59 +0000493 }
Mike Stump11289f42009-09-09 15:08:12 +0000494
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000495 Packed = D->hasAttr<PackedAttr>();
Mike Stump11289f42009-09-09 15:08:12 +0000496
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000497 // The #pragma pack attribute specifies the maximum field alignment.
498 if (const PragmaPackAttr *PPA = D->getAttr<PragmaPackAttr>())
499 MaxFieldAlignment = PPA->getAlignment();
Mike Stump11289f42009-09-09 15:08:12 +0000500
Anders Carlsson4f516282009-07-18 20:50:59 +0000501 if (const AlignedAttr *AA = D->getAttr<AlignedAttr>())
502 UpdateAlignment(AA->getAlignment());
Mike Stump11289f42009-09-09 15:08:12 +0000503
Anders Carlsson4f516282009-07-18 20:50:59 +0000504 // Layout each ivar sequentially.
505 llvm::SmallVector<ObjCIvarDecl*, 16> Ivars;
506 Ctx.ShallowCollectObjCIvars(D, Ivars, Impl);
507 for (unsigned i = 0, e = Ivars.size(); i != e; ++i)
508 LayoutField(Ivars[i]);
Mike Stump11289f42009-09-09 15:08:12 +0000509
Anders Carlsson4f516282009-07-18 20:50:59 +0000510 // Finally, round the size of the total struct up to the alignment of the
511 // struct itself.
512 FinishLayout();
513}
514
Anders Carlsson118ce162009-07-18 21:48:39 +0000515void ASTRecordLayoutBuilder::LayoutFields(const RecordDecl *D) {
516 // Layout each field, for now, just sequentially, respecting alignment. In
517 // the future, this will need to be tweakable by targets.
Mike Stump11289f42009-09-09 15:08:12 +0000518 for (RecordDecl::field_iterator Field = D->field_begin(),
Anders Carlsson118ce162009-07-18 21:48:39 +0000519 FieldEnd = D->field_end(); Field != FieldEnd; ++Field)
520 LayoutField(*Field);
521}
522
Anders Carlsson79474332009-07-18 20:20:21 +0000523void ASTRecordLayoutBuilder::LayoutField(const FieldDecl *D) {
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000524 bool FieldPacked = Packed;
Anders Carlsson47680d82009-09-26 01:34:51 +0000525 uint64_t FieldOffset = IsUnion ? 0 : DataSize;
Anders Carlsson79474332009-07-18 20:20:21 +0000526 uint64_t FieldSize;
527 unsigned FieldAlign;
Mike Stump11289f42009-09-09 15:08:12 +0000528
529 FieldPacked |= D->hasAttr<PackedAttr>();
530
Anders Carlsson79474332009-07-18 20:20:21 +0000531 if (const Expr *BitWidthExpr = D->getBitWidth()) {
532 // TODO: Need to check this algorithm on other targets!
533 // (tested on Linux-X86)
534 FieldSize = BitWidthExpr->EvaluateAsInt(Ctx).getZExtValue();
Mike Stump11289f42009-09-09 15:08:12 +0000535
Anders Carlsson79474332009-07-18 20:20:21 +0000536 std::pair<uint64_t, unsigned> FieldInfo = Ctx.getTypeInfo(D->getType());
537 uint64_t TypeSize = FieldInfo.first;
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000538
Anders Carlsson79474332009-07-18 20:20:21 +0000539 FieldAlign = FieldInfo.second;
Mike Stump11289f42009-09-09 15:08:12 +0000540
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000541 if (FieldPacked)
542 FieldAlign = 1;
Anders Carlsson79474332009-07-18 20:20:21 +0000543 if (const AlignedAttr *AA = D->getAttr<AlignedAttr>())
544 FieldAlign = std::max(FieldAlign, AA->getAlignment());
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000545 // The maximum field alignment overrides the aligned attribute.
546 if (MaxFieldAlignment)
547 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
548
Anders Carlsson79474332009-07-18 20:20:21 +0000549 // Check if we need to add padding to give the field the correct
550 // alignment.
551 if (FieldSize == 0 || (FieldOffset & (FieldAlign-1)) + FieldSize > TypeSize)
552 FieldOffset = (FieldOffset + (FieldAlign-1)) & ~(FieldAlign-1);
Mike Stump11289f42009-09-09 15:08:12 +0000553
Anders Carlsson79474332009-07-18 20:20:21 +0000554 // Padding members don't affect overall alignment
555 if (!D->getIdentifier())
556 FieldAlign = 1;
557 } else {
558 if (D->getType()->isIncompleteArrayType()) {
559 // This is a flexible array member; we can't directly
560 // query getTypeInfo about these, so we figure it out here.
561 // Flexible array members don't have any size, but they
562 // have to be aligned appropriately for their element type.
563 FieldSize = 0;
564 const ArrayType* ATy = Ctx.getAsArrayType(D->getType());
565 FieldAlign = Ctx.getTypeAlign(ATy->getElementType());
Ted Kremenekc23c7e62009-07-29 21:53:49 +0000566 } else if (const ReferenceType *RT = D->getType()->getAs<ReferenceType>()) {
Anders Carlsson79474332009-07-18 20:20:21 +0000567 unsigned AS = RT->getPointeeType().getAddressSpace();
568 FieldSize = Ctx.Target.getPointerWidth(AS);
569 FieldAlign = Ctx.Target.getPointerAlign(AS);
570 } else {
571 std::pair<uint64_t, unsigned> FieldInfo = Ctx.getTypeInfo(D->getType());
572 FieldSize = FieldInfo.first;
573 FieldAlign = FieldInfo.second;
574 }
Mike Stump11289f42009-09-09 15:08:12 +0000575
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000576 if (FieldPacked)
577 FieldAlign = 8;
Anders Carlsson79474332009-07-18 20:20:21 +0000578 if (const AlignedAttr *AA = D->getAttr<AlignedAttr>())
579 FieldAlign = std::max(FieldAlign, AA->getAlignment());
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000580 // The maximum field alignment overrides the aligned attribute.
581 if (MaxFieldAlignment)
582 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
Mike Stump11289f42009-09-09 15:08:12 +0000583
Anders Carlsson79474332009-07-18 20:20:21 +0000584 // Round up the current record size to the field's alignment boundary.
Anders Carlsson6522b052009-09-24 03:13:30 +0000585 FieldOffset = llvm::RoundUpToAlignment(FieldOffset, FieldAlign);
Anders Carlsson6f95c702009-09-25 00:02:51 +0000586
587 if (!IsUnion) {
588 while (true) {
589 // Check if we can place the field at this offset.
590 if (canPlaceFieldAtOffset(D, FieldOffset))
591 break;
592
Anders Carlsson534b0632009-09-26 16:55:29 +0000593 // We couldn't place the field at the offset. Try again at a new offset.
Anders Carlsson6f95c702009-09-25 00:02:51 +0000594 FieldOffset += FieldAlign;
595 }
Anders Carlssone1883102009-09-25 01:54:38 +0000596
597 UpdateEmptyClassOffsets(D, FieldOffset);
Anders Carlsson6f95c702009-09-25 00:02:51 +0000598 }
Anders Carlsson79474332009-07-18 20:20:21 +0000599 }
Mike Stump11289f42009-09-09 15:08:12 +0000600
Anders Carlsson79474332009-07-18 20:20:21 +0000601 // Place this field at the current location.
602 FieldOffsets.push_back(FieldOffset);
Mike Stump11289f42009-09-09 15:08:12 +0000603
Anders Carlsson79474332009-07-18 20:20:21 +0000604 // Reserve space for this field.
605 if (IsUnion)
606 Size = std::max(Size, FieldSize);
607 else
608 Size = FieldOffset + FieldSize;
Mike Stump11289f42009-09-09 15:08:12 +0000609
Anders Carlsson47680d82009-09-26 01:34:51 +0000610 // Update the data size.
611 DataSize = Size;
Mike Stump11289f42009-09-09 15:08:12 +0000612
Anders Carlsson79474332009-07-18 20:20:21 +0000613 // Remember max struct/class alignment.
614 UpdateAlignment(FieldAlign);
615}
616
617void ASTRecordLayoutBuilder::FinishLayout() {
618 // In C++, records cannot be of size 0.
619 if (Ctx.getLangOptions().CPlusPlus && Size == 0)
620 Size = 8;
621 // Finally, round the size of the record up to the alignment of the
622 // record itself.
623 Size = (Size + (Alignment-1)) & ~(Alignment-1);
624}
625
626void ASTRecordLayoutBuilder::UpdateAlignment(unsigned NewAlignment) {
627 if (NewAlignment <= Alignment)
628 return;
Mike Stump11289f42009-09-09 15:08:12 +0000629
Anders Carlsson79474332009-07-18 20:20:21 +0000630 assert(llvm::isPowerOf2_32(NewAlignment && "Alignment not a power of 2"));
Mike Stump11289f42009-09-09 15:08:12 +0000631
Anders Carlsson79474332009-07-18 20:20:21 +0000632 Alignment = NewAlignment;
633}
Mike Stump11289f42009-09-09 15:08:12 +0000634
Anders Carlsson79474332009-07-18 20:20:21 +0000635const ASTRecordLayout *
Mike Stump11289f42009-09-09 15:08:12 +0000636ASTRecordLayoutBuilder::ComputeLayout(ASTContext &Ctx,
Anders Carlsson79474332009-07-18 20:20:21 +0000637 const RecordDecl *D) {
638 ASTRecordLayoutBuilder Builder(Ctx);
639
640 Builder.Layout(D);
641
Anders Carlssonfc8cfa82009-07-28 19:24:15 +0000642 if (!isa<CXXRecordDecl>(D))
643 return new ASTRecordLayout(Builder.Size, Builder.Alignment, Builder.Size,
Mike Stump11289f42009-09-09 15:08:12 +0000644 Builder.FieldOffsets.data(),
Anders Carlssonfc8cfa82009-07-28 19:24:15 +0000645 Builder.FieldOffsets.size());
Mike Stump11289f42009-09-09 15:08:12 +0000646
Anders Carlssonfc8cfa82009-07-28 19:24:15 +0000647 // FIXME: This is not always correct. See the part about bitfields at
648 // http://www.codesourcery.com/public/cxx-abi/abi.html#POD for more info.
649 // FIXME: IsPODForThePurposeOfLayout should be stored in the record layout.
650 bool IsPODForThePurposeOfLayout = cast<CXXRecordDecl>(D)->isPOD();
Mike Stump11289f42009-09-09 15:08:12 +0000651
Anders Carlssonfc8cfa82009-07-28 19:24:15 +0000652 // FIXME: This should be done in FinalizeLayout.
Mike Stump11289f42009-09-09 15:08:12 +0000653 uint64_t DataSize =
Anders Carlsson47680d82009-09-26 01:34:51 +0000654 IsPODForThePurposeOfLayout ? Builder.Size : Builder.DataSize;
Mike Stump11289f42009-09-09 15:08:12 +0000655 uint64_t NonVirtualSize =
Anders Carlssonfc8cfa82009-07-28 19:24:15 +0000656 IsPODForThePurposeOfLayout ? DataSize : Builder.NonVirtualSize;
Mike Stump11289f42009-09-09 15:08:12 +0000657
Anders Carlsson6d9f6f32009-07-19 00:18:47 +0000658 return new ASTRecordLayout(Builder.Size, Builder.Alignment, DataSize,
Mike Stump11289f42009-09-09 15:08:12 +0000659 Builder.FieldOffsets.data(),
Anders Carlssonfc8cfa82009-07-28 19:24:15 +0000660 Builder.FieldOffsets.size(),
661 NonVirtualSize,
662 Builder.NonVirtualAlignment,
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000663 Builder.PrimaryBase,
Mike Stumpc266c6d2009-08-07 19:00:50 +0000664 Builder.PrimaryBaseWasVirtual,
Anders Carlssonfc8cfa82009-07-28 19:24:15 +0000665 Builder.Bases.data(),
Mike Stumpbcf756c2009-08-14 01:44:03 +0000666 Builder.Bases.size(),
667 Builder.VBases.data(),
Mike Stumpbcf756c2009-08-14 01:44:03 +0000668 Builder.VBases.size());
Anders Carlsson4f516282009-07-18 20:50:59 +0000669}
670
671const ASTRecordLayout *
672ASTRecordLayoutBuilder::ComputeLayout(ASTContext &Ctx,
673 const ObjCInterfaceDecl *D,
674 const ObjCImplementationDecl *Impl) {
675 ASTRecordLayoutBuilder Builder(Ctx);
Mike Stump11289f42009-09-09 15:08:12 +0000676
Anders Carlsson4f516282009-07-18 20:50:59 +0000677 Builder.Layout(D, Impl);
Mike Stump11289f42009-09-09 15:08:12 +0000678
Anders Carlsson4f516282009-07-18 20:50:59 +0000679 return new ASTRecordLayout(Builder.Size, Builder.Alignment,
Anders Carlsson47680d82009-09-26 01:34:51 +0000680 Builder.DataSize,
Mike Stump11289f42009-09-09 15:08:12 +0000681 Builder.FieldOffsets.data(),
Anders Carlsson79474332009-07-18 20:20:21 +0000682 Builder.FieldOffsets.size());
683}