blob: ec0210b36a93ce5ef60e36d8aa72e8624c55c3f4 [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()) {
Mike Stump11289f42009-09-09 15:08:12 +000050 const CXXRecordDecl *Base =
Ted Kremenekc23c7e62009-07-29 21:53:49 +000051 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Mike Stump25094802009-08-06 00:38:46 +000052 // Skip the PrimaryBase here, as it is laid down first.
Mike Stumpbcf756c2009-08-14 01:44:03 +000053 if (Base != PrimaryBase || PrimaryBaseWasVirtual)
54 LayoutBaseNonVirtually(Base, false);
Anders Carlsson6d9f6f32009-07-19 00:18:47 +000055 }
56 }
57}
58
Mike Stumpd8fe7b22009-08-05 22:37:18 +000059// Helper routines related to the abi definition from:
60// http://www.codesourcery.com/public/cxx-abi/abi.html
61//
62/// IsNearlyEmpty - Indicates when a class has a vtable pointer, but
63/// no other data.
Anders Carlsson81430692009-09-22 03:02:06 +000064bool ASTRecordLayoutBuilder::IsNearlyEmpty(const CXXRecordDecl *RD) const {
Mike Stumpd8fe7b22009-08-05 22:37:18 +000065 // FIXME: Audit the corners
66 if (!RD->isDynamicClass())
67 return false;
68 const ASTRecordLayout &BaseInfo = Ctx.getASTRecordLayout(RD);
69 if (BaseInfo.getNonVirtualSize() == Ctx.Target.getPointerWidth(0))
70 return true;
71 return false;
72}
73
Anders Carlsson81430692009-09-22 03:02:06 +000074void ASTRecordLayoutBuilder::IdentifyPrimaryBases(const CXXRecordDecl *RD) {
Mike Stump78696a72009-08-11 04:03:59 +000075 const ASTRecordLayout &Layout = Ctx.getASTRecordLayout(RD);
Anders Carlsson81430692009-09-22 03:02:06 +000076
77 // If the record has a primary base class that is virtual, add it to the set
78 // of primary bases.
79 if (Layout.getPrimaryBaseWasVirtual())
80 IndirectPrimaryBases.insert(Layout.getPrimaryBase());
81
82 // Now traverse all bases and find primary bases for them.
Mike Stumpd8fe7b22009-08-05 22:37:18 +000083 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
84 e = RD->bases_end(); i != e; ++i) {
Mike Stump11289f42009-09-09 15:08:12 +000085 const CXXRecordDecl *Base =
Mike Stump78696a72009-08-11 04:03:59 +000086 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson81430692009-09-22 03:02:06 +000087
Mike Stump78696a72009-08-11 04:03:59 +000088 // Only bases with virtual bases participate in computing the
89 // indirect primary virtual base classes.
Mike Stumpc2f591b2009-08-13 22:53:07 +000090 if (Base->getNumVBases())
Anders Carlsson81430692009-09-22 03:02:06 +000091 IdentifyPrimaryBases(Base);
Mike Stumpd8fe7b22009-08-05 22:37:18 +000092 }
93}
94
Anders Carlsson81430692009-09-22 03:02:06 +000095void
96ASTRecordLayoutBuilder::SelectPrimaryVBase(const CXXRecordDecl *RD,
97 const CXXRecordDecl *&FirstPrimary) {
Mike Stump6f3793b2009-08-12 21:50:08 +000098 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
99 e = RD->bases_end(); i != e; ++i) {
Mike Stump11289f42009-09-09 15:08:12 +0000100 const CXXRecordDecl *Base =
Mike Stump6f3793b2009-08-12 21:50:08 +0000101 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
102 if (!i->isVirtual()) {
Anders Carlsson81430692009-09-22 03:02:06 +0000103 SelectPrimaryVBase(Base, FirstPrimary);
Mike Stump6f3793b2009-08-12 21:50:08 +0000104 if (PrimaryBase)
105 return;
106 continue;
107 }
108 if (IsNearlyEmpty(Base)) {
109 if (FirstPrimary==0)
110 FirstPrimary = Base;
Anders Carlsson81430692009-09-22 03:02:06 +0000111 if (!IndirectPrimaryBases.count(Base)) {
Mike Stump6f3793b2009-08-12 21:50:08 +0000112 setPrimaryBase(Base, true);
113 return;
114 }
115 }
116 }
117}
118
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000119/// SelectPrimaryBase - Selects the primary base for the given class and
Mike Stump590a7c72009-08-13 23:26:06 +0000120/// record that with setPrimaryBase. We also calculate the IndirectPrimaries.
Anders Carlsson81430692009-09-22 03:02:06 +0000121void ASTRecordLayoutBuilder::SelectPrimaryBase(const CXXRecordDecl *RD) {
122 // Compute all the primary virtual bases for all of our direct and
Mike Stump590a7c72009-08-13 23:26:06 +0000123 // indirect bases, and record all their primary virtual base classes.
Mike Stump590a7c72009-08-13 23:26:06 +0000124 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
125 e = RD->bases_end(); i != e; ++i) {
Mike Stump11289f42009-09-09 15:08:12 +0000126 const CXXRecordDecl *Base =
Mike Stump590a7c72009-08-13 23:26:06 +0000127 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson81430692009-09-22 03:02:06 +0000128 IdentifyPrimaryBases(Base);
Mike Stump590a7c72009-08-13 23:26:06 +0000129 }
130
Anders Carlsson81430692009-09-22 03:02:06 +0000131 // If the record has a dynamic base class, attempt to choose a primary base
132 // class. It is the first (in direct base class order) non-virtual dynamic
133 // base class, if one exists.
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000134 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
135 e = RD->bases_end(); i != e; ++i) {
136 if (!i->isVirtual()) {
Mike Stump11289f42009-09-09 15:08:12 +0000137 const CXXRecordDecl *Base =
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000138 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
139 if (Base->isDynamicClass()) {
Anders Carlsson81430692009-09-22 03:02:06 +0000140 // We found it.
Mike Stumpc266c6d2009-08-07 19:00:50 +0000141 setPrimaryBase(Base, false);
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000142 return;
143 }
144 }
145 }
146
147 // Otherwise, it is the first nearly empty virtual base that is not an
Mike Stump78696a72009-08-11 04:03:59 +0000148 // indirect primary virtual base class, if one exists.
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000149
150 // If we have no virtual bases at this point, bail out as the searching below
151 // is expensive.
Anders Carlsson96cff1f2009-09-22 18:21:58 +0000152 if (RD->getNumVBases() == 0)
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000153 return;
Anders Carlsson81430692009-09-22 03:02:06 +0000154
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000155 // Then we can search for the first nearly empty virtual base itself.
Anders Carlsson81430692009-09-22 03:02:06 +0000156 const CXXRecordDecl *FirstPrimary = 0;
157 SelectPrimaryVBase(RD, FirstPrimary);
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000158
Mike Stumpc266c6d2009-08-07 19:00:50 +0000159 // Otherwise if is the first nearly empty virtual base, if one exists,
160 // otherwise there is no primary base class.
Anders Carlsson55640542009-09-22 19:16:59 +0000161 if (!PrimaryBase)
162 setPrimaryBase(FirstPrimary, true);
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000163}
164
Mike Stump6b2556f2009-08-06 13:41:24 +0000165void ASTRecordLayoutBuilder::LayoutVirtualBase(const CXXRecordDecl *RD) {
Mike Stumpbcf756c2009-08-14 01:44:03 +0000166 LayoutBaseNonVirtually(RD, true);
Mike Stump6b2556f2009-08-06 13:41:24 +0000167}
168
Mike Stump13007542009-08-13 02:02:14 +0000169void ASTRecordLayoutBuilder::LayoutVirtualBases(const CXXRecordDecl *RD,
Mike Stump996576f32009-08-16 19:04:13 +0000170 const CXXRecordDecl *PB,
Mike Stump22ea1f82009-08-16 01:46:26 +0000171 int64_t Offset,
172 llvm::SmallSet<const CXXRecordDecl*, 32> &mark,
Mike Stump13007542009-08-13 02:02:14 +0000173 llvm::SmallSet<const CXXRecordDecl*, 32> &IndirectPrimary) {
Mike Stumpc2f591b2009-08-13 22:53:07 +0000174 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
175 e = RD->bases_end(); i != e; ++i) {
Mike Stump11289f42009-09-09 15:08:12 +0000176 const CXXRecordDecl *Base =
Mike Stump6b2556f2009-08-06 13:41:24 +0000177 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Mike Stump22ea1f82009-08-16 01:46:26 +0000178#if 0
179 const ASTRecordLayout &L = Ctx.getASTRecordLayout(Base);
180 const CXXRecordDecl *PB = L.getPrimaryBase();
181 if (PB && L.getPrimaryBaseWasVirtual()
182 && IndirectPrimary.count(PB)) {
183 int64_t BaseOffset;
184 // FIXME: calculate this.
185 BaseOffset = (1<<63) | (1<<31);
186 VBases.push_back(PB);
187 VBaseOffsets.push_back(BaseOffset);
188 }
189#endif
Mike Stump996576f32009-08-16 19:04:13 +0000190 int64_t BaseOffset = Offset;;
191 // FIXME: Calculate BaseOffset.
Mike Stump22ea1f82009-08-16 01:46:26 +0000192 if (i->isVirtual()) {
Mike Stump996576f32009-08-16 19:04:13 +0000193 if (Base == PB) {
194 // Only lay things out once.
195 if (mark.count(Base))
196 continue;
197 // Mark it so we don't lay it out twice.
198 mark.insert(Base);
199 assert (IndirectPrimary.count(Base) && "IndirectPrimary was wrong");
Anders Carlssond6020c32009-09-22 00:04:45 +0000200 VBases.push_back(std::make_pair(Base, Offset));
Mike Stump996576f32009-08-16 19:04:13 +0000201 } else if (IndirectPrimary.count(Base)) {
202 // Someone else will eventually lay this out.
203 ;
204 } else {
205 // Only lay things out once.
206 if (mark.count(Base))
207 continue;
208 // Mark it so we don't lay it out twice.
209 mark.insert(Base);
Mike Stump22ea1f82009-08-16 01:46:26 +0000210 LayoutVirtualBase(Base);
Anders Carlssond6020c32009-09-22 00:04:45 +0000211 BaseOffset = VBases.back().second;
Mike Stump996576f32009-08-16 19:04:13 +0000212 }
Mike Stumpc2f591b2009-08-13 22:53:07 +0000213 }
Mike Stump996576f32009-08-16 19:04:13 +0000214 if (Base->getNumVBases()) {
215 const ASTRecordLayout &L = Ctx.getASTRecordLayout(Base);
216 const CXXRecordDecl *PB = L.getPrimaryBase();
217 LayoutVirtualBases(Base, PB, BaseOffset, mark, IndirectPrimary);
218 }
Mike Stump6b2556f2009-08-06 13:41:24 +0000219 }
220}
221
Anders Carlsson6522b052009-09-24 03:13:30 +0000222bool ASTRecordLayoutBuilder::canPlaceRecordAtOffset(const CXXRecordDecl *RD,
223 uint64_t Offset) const {
Anders Carlssonf24b18f2009-09-24 03:22:10 +0000224 // Look for an empty class with the same type at the same offset.
225 for (EmptyClassOffsetsTy::const_iterator I =
226 EmptyClassOffsets.lower_bound(Offset),
227 E = EmptyClassOffsets.upper_bound(Offset); I != E; ++I) {
228
229 if (I->second == RD)
230 return false;
231 }
232
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000233 const ASTRecordLayout &Info = Ctx.getASTRecordLayout(RD);
234
235 // Check bases.
236 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
237 E = RD->bases_end(); I != E; ++I) {
238 if (I->isVirtual())
239 continue;
240
241 const CXXRecordDecl *Base =
242 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
243
244 uint64_t BaseClassOffset = Info.getBaseClassOffset(Base);
245
246 if (!canPlaceRecordAtOffset(Base, Offset + BaseClassOffset))
247 return false;
248 }
249
Anders Carlssond7d358a2009-09-25 15:39:00 +0000250 // Check fields.
251 unsigned FieldNo = 0;
252 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
253 I != E; ++I, ++FieldNo) {
254 const FieldDecl *FD = *I;
255
256 uint64_t FieldOffset = Info.getFieldOffset(FieldNo);
257
258 if (!canPlaceFieldAtOffset(FD, Offset + FieldOffset))
259 return false;
260 }
261
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000262 // FIXME: virtual bases.
Anders Carlsson6522b052009-09-24 03:13:30 +0000263 return true;
264}
265
Anders Carlsson6f95c702009-09-25 00:02:51 +0000266bool ASTRecordLayoutBuilder::canPlaceFieldAtOffset(const FieldDecl *FD,
267 uint64_t Offset) const {
Anders Carlsson4bf82142009-09-25 01:23:32 +0000268 QualType T = FD->getType();
269 if (const RecordType *RT = T->getAs<RecordType>()) {
Anders Carlsson6f95c702009-09-25 00:02:51 +0000270 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl()))
271 return canPlaceRecordAtOffset(RD, Offset);
272 }
273
Anders Carlsson4bf82142009-09-25 01:23:32 +0000274 if (const ConstantArrayType *AT = Ctx.getAsConstantArrayType(T)) {
275 QualType ElemTy = Ctx.getBaseElementType(AT);
276 const RecordType *RT = ElemTy->getAs<RecordType>();
277 if (!RT)
278 return true;
279 const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl());
280 if (!RD)
281 return true;
282
283 const ASTRecordLayout &Info = Ctx.getASTRecordLayout(RD);
284
285 uint64_t NumElements = Ctx.getConstantArrayElementCount(AT);
286 unsigned ElementOffset = Offset;
287 for (uint64_t I = 0; I != NumElements; ++I) {
288 if (!canPlaceRecordAtOffset(RD, ElementOffset))
289 return false;
290
291 ElementOffset += Info.getSize();
292 }
293 }
Anders Carlsson6f95c702009-09-25 00:02:51 +0000294
295 return true;
296}
297
Anders Carlsson6522b052009-09-24 03:13:30 +0000298void ASTRecordLayoutBuilder::UpdateEmptyClassOffsets(const CXXRecordDecl *RD,
299 uint64_t Offset) {
Anders Carlssonf24b18f2009-09-24 03:22:10 +0000300 if (RD->isEmpty())
301 EmptyClassOffsets.insert(std::make_pair(Offset, RD));
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000302
303 const ASTRecordLayout &Info = Ctx.getASTRecordLayout(RD);
304
305 // Update bases.
306 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
307 E = RD->bases_end(); I != E; ++I) {
308 if (I->isVirtual())
309 continue;
Anders Carlssonf24b18f2009-09-24 03:22:10 +0000310
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000311 const CXXRecordDecl *Base =
312 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
313
314 uint64_t BaseClassOffset = Info.getBaseClassOffset(Base);
315 UpdateEmptyClassOffsets(Base, Offset + BaseClassOffset);
316 }
317
Anders Carlssond7d358a2009-09-25 15:39:00 +0000318 // Update fields.
319 unsigned FieldNo = 0;
320 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
321 I != E; ++I, ++FieldNo) {
322 const FieldDecl *FD = *I;
323
324 uint64_t FieldOffset = Info.getFieldOffset(FieldNo);
325 UpdateEmptyClassOffsets(FD, Offset + FieldOffset);
326 }
327
328 // FIXME: Update virtual bases.
Anders Carlsson6522b052009-09-24 03:13:30 +0000329}
330
Anders Carlssone1883102009-09-25 01:54:38 +0000331void
332ASTRecordLayoutBuilder::UpdateEmptyClassOffsets(const FieldDecl *FD,
333 uint64_t Offset) {
334 QualType T = FD->getType();
335
336 if (const RecordType *RT = T->getAs<RecordType>()) {
337 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl())) {
338 UpdateEmptyClassOffsets(RD, Offset);
339 return;
340 }
341 }
342
343 if (const ConstantArrayType *AT = Ctx.getAsConstantArrayType(T)) {
344 QualType ElemTy = Ctx.getBaseElementType(AT);
345 const RecordType *RT = ElemTy->getAs<RecordType>();
346 if (!RT)
347 return;
348 const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl());
349 if (!RD)
350 return;
351
352 const ASTRecordLayout &Info = Ctx.getASTRecordLayout(RD);
353
354 uint64_t NumElements = Ctx.getConstantArrayElementCount(AT);
355 unsigned ElementOffset = Offset;
356
357 for (uint64_t I = 0; I != NumElements; ++I) {
358 UpdateEmptyClassOffsets(RD, ElementOffset);
359 ElementOffset += Info.getSize();
360 }
361 }
362}
363
Anders Carlsson6522b052009-09-24 03:13:30 +0000364uint64_t ASTRecordLayoutBuilder::LayoutBase(const CXXRecordDecl *RD) {
Anders Carlsson6d9f6f32009-07-19 00:18:47 +0000365 const ASTRecordLayout &BaseInfo = Ctx.getASTRecordLayout(RD);
Anders Carlssonf24b18f2009-09-24 03:22:10 +0000366
367 // If we have an empty base class, try to place it at offset 0.
368 if (RD->isEmpty() && canPlaceRecordAtOffset(RD, 0)) {
369 // We were able to place the class at offset 0.
Anders Carlssonf24b18f2009-09-24 03:22:10 +0000370 UpdateEmptyClassOffsets(RD, 0);
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000371
Anders Carlssond7d358a2009-09-25 15:39:00 +0000372 Size = std::max(Size, BaseInfo.getSize());
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000373
Anders Carlssonf24b18f2009-09-24 03:22:10 +0000374 return 0;
Anders Carlsson93b6d5e2009-09-17 04:42:56 +0000375 }
376
Anders Carlssonfc8cfa82009-07-28 19:24:15 +0000377 unsigned BaseAlign = BaseInfo.getNonVirtualAlign();
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000378
Anders Carlsson6d9f6f32009-07-19 00:18:47 +0000379 // Round up the current record size to the base's alignment boundary.
Anders Carlsson47680d82009-09-26 01:34:51 +0000380 uint64_t Offset = llvm::RoundUpToAlignment(DataSize, BaseAlign);
Anders Carlsson6522b052009-09-24 03:13:30 +0000381
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000382 // Try to place the base.
383 while (true) {
384 if (canPlaceRecordAtOffset(RD, Offset))
385 break;
386
387 Offset += BaseAlign;
388 }
389
Anders Carlssond7d358a2009-09-25 15:39:00 +0000390 if (!RD->isEmpty()) {
Anders Carlsson47680d82009-09-26 01:34:51 +0000391 // Update the data size.
392 DataSize = Offset + BaseInfo.getNonVirtualSize();
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000393
Anders Carlsson47680d82009-09-26 01:34:51 +0000394 Size = std::max(Size, DataSize);
Anders Carlssond7d358a2009-09-25 15:39:00 +0000395 } else
396 Size = std::max(Size, Offset + BaseInfo.getSize());
397
Anders Carlsson6522b052009-09-24 03:13:30 +0000398 // Remember max struct/class alignment.
399 UpdateAlignment(BaseAlign);
Anders Carlssonbb66bc82009-09-24 05:21:31 +0000400
401 UpdateEmptyClassOffsets(RD, Offset);
Anders Carlsson6522b052009-09-24 03:13:30 +0000402 return Offset;
403}
404
405void ASTRecordLayoutBuilder::LayoutBaseNonVirtually(const CXXRecordDecl *RD,
406 bool IsVirtualBase) {
407 // Layout the base.
408 unsigned Offset = LayoutBase(RD);
Anders Carlsson6d9f6f32009-07-19 00:18:47 +0000409
Mike Stump22ea1f82009-08-16 01:46:26 +0000410 // Add base class offsets.
Anders Carlssond6020c32009-09-22 00:04:45 +0000411 if (IsVirtualBase)
Anders Carlsson6522b052009-09-24 03:13:30 +0000412 VBases.push_back(std::make_pair(RD, Offset));
Anders Carlssond6020c32009-09-22 00:04:45 +0000413 else
Anders Carlsson6522b052009-09-24 03:13:30 +0000414 Bases.push_back(std::make_pair(RD, Offset));
Anders Carlssonfc8cfa82009-07-28 19:24:15 +0000415
Mike Stump996576f32009-08-16 19:04:13 +0000416#if 0
Mike Stump22ea1f82009-08-16 01:46:26 +0000417 // And now add offsets for all our primary virtual bases as well, so
418 // they all have offsets.
419 const ASTRecordLayout *L = &BaseInfo;
420 const CXXRecordDecl *PB = L->getPrimaryBase();
421 while (PB) {
422 if (L->getPrimaryBaseWasVirtual()) {
423 VBases.push_back(PB);
424 VBaseOffsets.push_back(Size);
425 }
426 PB = L->getPrimaryBase();
427 if (PB)
428 L = &Ctx.getASTRecordLayout(PB);
429 }
Mike Stump996576f32009-08-16 19:04:13 +0000430#endif
Anders Carlsson6d9f6f32009-07-19 00:18:47 +0000431}
432
Anders Carlsson79474332009-07-18 20:20:21 +0000433void ASTRecordLayoutBuilder::Layout(const RecordDecl *D) {
434 IsUnion = D->isUnion();
Anders Carlsson68e0b682009-08-08 18:23:56 +0000435
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000436 Packed = D->hasAttr<PackedAttr>();
437
438 // The #pragma pack attribute specifies the maximum field alignment.
Anders Carlsson68e0b682009-08-08 18:23:56 +0000439 if (const PragmaPackAttr *PPA = D->getAttr<PragmaPackAttr>())
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000440 MaxFieldAlignment = PPA->getAlignment();
Mike Stump11289f42009-09-09 15:08:12 +0000441
Anders Carlsson79474332009-07-18 20:20:21 +0000442 if (const AlignedAttr *AA = D->getAttr<AlignedAttr>())
443 UpdateAlignment(AA->getAlignment());
Anders Carlsson6d9f6f32009-07-19 00:18:47 +0000444
Mike Stump22ea1f82009-08-16 01:46:26 +0000445 // If this is a C++ class, lay out the vtable and the non-virtual bases.
Mike Stump6b2556f2009-08-06 13:41:24 +0000446 const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D);
447 if (RD) {
Anders Carlsson81430692009-09-22 03:02:06 +0000448 LayoutVtable(RD);
Mike Stump25094802009-08-06 00:38:46 +0000449 // PrimaryBase goes first.
Mike Stump13007542009-08-13 02:02:14 +0000450 if (PrimaryBase) {
Mike Stump13007542009-08-13 02:02:14 +0000451 if (PrimaryBaseWasVirtual)
Anders Carlsson81430692009-09-22 03:02:06 +0000452 IndirectPrimaryBases.insert(PrimaryBase);
Mike Stumpbcf756c2009-08-14 01:44:03 +0000453 LayoutBaseNonVirtually(PrimaryBase, PrimaryBaseWasVirtual);
Mike Stump13007542009-08-13 02:02:14 +0000454 }
Mike Stump3dc7eb92009-07-30 00:22:38 +0000455 LayoutNonVirtualBases(RD);
Mike Stump3dc7eb92009-07-30 00:22:38 +0000456 }
Anders Carlsson6d9f6f32009-07-19 00:18:47 +0000457
Anders Carlsson118ce162009-07-18 21:48:39 +0000458 LayoutFields(D);
Mike Stump11289f42009-09-09 15:08:12 +0000459
Anders Carlssonfc8cfa82009-07-28 19:24:15 +0000460 NonVirtualSize = Size;
461 NonVirtualAlignment = Alignment;
Mike Stump3dc7eb92009-07-30 00:22:38 +0000462
Mike Stump22ea1f82009-08-16 01:46:26 +0000463 if (RD) {
464 llvm::SmallSet<const CXXRecordDecl*, 32> mark;
Anders Carlsson81430692009-09-22 03:02:06 +0000465 LayoutVirtualBases(RD, PrimaryBase, 0, mark, IndirectPrimaryBases);
Mike Stump22ea1f82009-08-16 01:46:26 +0000466 }
Mike Stump6b2556f2009-08-06 13:41:24 +0000467
Anders Carlsson79474332009-07-18 20:20:21 +0000468 // Finally, round the size of the total struct up to the alignment of the
469 // struct itself.
470 FinishLayout();
471}
472
Anders Carlsson4f516282009-07-18 20:50:59 +0000473void ASTRecordLayoutBuilder::Layout(const ObjCInterfaceDecl *D,
474 const ObjCImplementationDecl *Impl) {
475 if (ObjCInterfaceDecl *SD = D->getSuperClass()) {
476 const ASTRecordLayout &SL = Ctx.getASTObjCInterfaceLayout(SD);
477
478 UpdateAlignment(SL.getAlignment());
Mike Stump11289f42009-09-09 15:08:12 +0000479
Anders Carlsson4f516282009-07-18 20:50:59 +0000480 // We start laying out ivars not at the end of the superclass
481 // structure, but at the next byte following the last field.
Anders Carlsson27b50132009-07-18 21:26:44 +0000482 Size = llvm::RoundUpToAlignment(SL.getDataSize(), 8);
Anders Carlsson47680d82009-09-26 01:34:51 +0000483 DataSize = Size;
Anders Carlsson4f516282009-07-18 20:50:59 +0000484 }
Mike Stump11289f42009-09-09 15:08:12 +0000485
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000486 Packed = D->hasAttr<PackedAttr>();
Mike Stump11289f42009-09-09 15:08:12 +0000487
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000488 // The #pragma pack attribute specifies the maximum field alignment.
489 if (const PragmaPackAttr *PPA = D->getAttr<PragmaPackAttr>())
490 MaxFieldAlignment = PPA->getAlignment();
Mike Stump11289f42009-09-09 15:08:12 +0000491
Anders Carlsson4f516282009-07-18 20:50:59 +0000492 if (const AlignedAttr *AA = D->getAttr<AlignedAttr>())
493 UpdateAlignment(AA->getAlignment());
Mike Stump11289f42009-09-09 15:08:12 +0000494
Anders Carlsson4f516282009-07-18 20:50:59 +0000495 // Layout each ivar sequentially.
496 llvm::SmallVector<ObjCIvarDecl*, 16> Ivars;
497 Ctx.ShallowCollectObjCIvars(D, Ivars, Impl);
498 for (unsigned i = 0, e = Ivars.size(); i != e; ++i)
499 LayoutField(Ivars[i]);
Mike Stump11289f42009-09-09 15:08:12 +0000500
Anders Carlsson4f516282009-07-18 20:50:59 +0000501 // Finally, round the size of the total struct up to the alignment of the
502 // struct itself.
503 FinishLayout();
504}
505
Anders Carlsson118ce162009-07-18 21:48:39 +0000506void ASTRecordLayoutBuilder::LayoutFields(const RecordDecl *D) {
507 // Layout each field, for now, just sequentially, respecting alignment. In
508 // the future, this will need to be tweakable by targets.
Mike Stump11289f42009-09-09 15:08:12 +0000509 for (RecordDecl::field_iterator Field = D->field_begin(),
Anders Carlsson118ce162009-07-18 21:48:39 +0000510 FieldEnd = D->field_end(); Field != FieldEnd; ++Field)
511 LayoutField(*Field);
512}
513
Anders Carlsson79474332009-07-18 20:20:21 +0000514void ASTRecordLayoutBuilder::LayoutField(const FieldDecl *D) {
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000515 bool FieldPacked = Packed;
Anders Carlsson47680d82009-09-26 01:34:51 +0000516 uint64_t FieldOffset = IsUnion ? 0 : DataSize;
Anders Carlsson79474332009-07-18 20:20:21 +0000517 uint64_t FieldSize;
518 unsigned FieldAlign;
Mike Stump11289f42009-09-09 15:08:12 +0000519
520 FieldPacked |= D->hasAttr<PackedAttr>();
521
Anders Carlsson79474332009-07-18 20:20:21 +0000522 if (const Expr *BitWidthExpr = D->getBitWidth()) {
523 // TODO: Need to check this algorithm on other targets!
524 // (tested on Linux-X86)
525 FieldSize = BitWidthExpr->EvaluateAsInt(Ctx).getZExtValue();
Mike Stump11289f42009-09-09 15:08:12 +0000526
Anders Carlsson79474332009-07-18 20:20:21 +0000527 std::pair<uint64_t, unsigned> FieldInfo = Ctx.getTypeInfo(D->getType());
528 uint64_t TypeSize = FieldInfo.first;
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000529
Anders Carlsson79474332009-07-18 20:20:21 +0000530 FieldAlign = FieldInfo.second;
Mike Stump11289f42009-09-09 15:08:12 +0000531
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000532 if (FieldPacked)
533 FieldAlign = 1;
Anders Carlsson79474332009-07-18 20:20:21 +0000534 if (const AlignedAttr *AA = D->getAttr<AlignedAttr>())
535 FieldAlign = std::max(FieldAlign, AA->getAlignment());
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000536 // The maximum field alignment overrides the aligned attribute.
537 if (MaxFieldAlignment)
538 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
539
Anders Carlsson79474332009-07-18 20:20:21 +0000540 // 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);
Mike Stump11289f42009-09-09 15:08:12 +0000544
Anders Carlsson79474332009-07-18 20:20:21 +0000545 // Padding members don't affect overall alignment
546 if (!D->getIdentifier())
547 FieldAlign = 1;
548 } else {
549 if (D->getType()->isIncompleteArrayType()) {
550 // This is a flexible array member; we can't directly
551 // query getTypeInfo about these, so we figure it out here.
552 // Flexible array members don't have any size, but they
553 // have to be aligned appropriately for their element type.
554 FieldSize = 0;
555 const ArrayType* ATy = Ctx.getAsArrayType(D->getType());
556 FieldAlign = Ctx.getTypeAlign(ATy->getElementType());
Ted Kremenekc23c7e62009-07-29 21:53:49 +0000557 } else if (const ReferenceType *RT = D->getType()->getAs<ReferenceType>()) {
Anders Carlsson79474332009-07-18 20:20:21 +0000558 unsigned AS = RT->getPointeeType().getAddressSpace();
559 FieldSize = Ctx.Target.getPointerWidth(AS);
560 FieldAlign = Ctx.Target.getPointerAlign(AS);
561 } else {
562 std::pair<uint64_t, unsigned> FieldInfo = Ctx.getTypeInfo(D->getType());
563 FieldSize = FieldInfo.first;
564 FieldAlign = FieldInfo.second;
565 }
Mike Stump11289f42009-09-09 15:08:12 +0000566
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000567 if (FieldPacked)
568 FieldAlign = 8;
Anders Carlsson79474332009-07-18 20:20:21 +0000569 if (const AlignedAttr *AA = D->getAttr<AlignedAttr>())
570 FieldAlign = std::max(FieldAlign, AA->getAlignment());
Anders Carlsson28a5fa22009-08-08 19:38:24 +0000571 // The maximum field alignment overrides the aligned attribute.
572 if (MaxFieldAlignment)
573 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
Mike Stump11289f42009-09-09 15:08:12 +0000574
Anders Carlsson79474332009-07-18 20:20:21 +0000575 // Round up the current record size to the field's alignment boundary.
Anders Carlsson6522b052009-09-24 03:13:30 +0000576 FieldOffset = llvm::RoundUpToAlignment(FieldOffset, FieldAlign);
Anders Carlsson6f95c702009-09-25 00:02:51 +0000577
578 if (!IsUnion) {
579 while (true) {
580 // Check if we can place the field at this offset.
581 if (canPlaceFieldAtOffset(D, FieldOffset))
582 break;
583
584 // We can't try again.
585 FieldOffset += FieldAlign;
586 }
Anders Carlssone1883102009-09-25 01:54:38 +0000587
588 UpdateEmptyClassOffsets(D, FieldOffset);
Anders Carlsson6f95c702009-09-25 00:02:51 +0000589 }
Anders Carlsson79474332009-07-18 20:20:21 +0000590 }
Mike Stump11289f42009-09-09 15:08:12 +0000591
Anders Carlsson79474332009-07-18 20:20:21 +0000592 // Place this field at the current location.
593 FieldOffsets.push_back(FieldOffset);
Mike Stump11289f42009-09-09 15:08:12 +0000594
Anders Carlsson79474332009-07-18 20:20:21 +0000595 // Reserve space for this field.
596 if (IsUnion)
597 Size = std::max(Size, FieldSize);
598 else
599 Size = FieldOffset + FieldSize;
Mike Stump11289f42009-09-09 15:08:12 +0000600
Anders Carlsson47680d82009-09-26 01:34:51 +0000601 // Update the data size.
602 DataSize = Size;
Mike Stump11289f42009-09-09 15:08:12 +0000603
Anders Carlsson79474332009-07-18 20:20:21 +0000604 // Remember max struct/class alignment.
605 UpdateAlignment(FieldAlign);
606}
607
608void ASTRecordLayoutBuilder::FinishLayout() {
609 // In C++, records cannot be of size 0.
610 if (Ctx.getLangOptions().CPlusPlus && Size == 0)
611 Size = 8;
612 // Finally, round the size of the record up to the alignment of the
613 // record itself.
614 Size = (Size + (Alignment-1)) & ~(Alignment-1);
615}
616
617void ASTRecordLayoutBuilder::UpdateAlignment(unsigned NewAlignment) {
618 if (NewAlignment <= Alignment)
619 return;
Mike Stump11289f42009-09-09 15:08:12 +0000620
Anders Carlsson79474332009-07-18 20:20:21 +0000621 assert(llvm::isPowerOf2_32(NewAlignment && "Alignment not a power of 2"));
Mike Stump11289f42009-09-09 15:08:12 +0000622
Anders Carlsson79474332009-07-18 20:20:21 +0000623 Alignment = NewAlignment;
624}
Mike Stump11289f42009-09-09 15:08:12 +0000625
Anders Carlsson79474332009-07-18 20:20:21 +0000626const ASTRecordLayout *
Mike Stump11289f42009-09-09 15:08:12 +0000627ASTRecordLayoutBuilder::ComputeLayout(ASTContext &Ctx,
Anders Carlsson79474332009-07-18 20:20:21 +0000628 const RecordDecl *D) {
629 ASTRecordLayoutBuilder Builder(Ctx);
630
631 Builder.Layout(D);
632
Anders Carlssonfc8cfa82009-07-28 19:24:15 +0000633 if (!isa<CXXRecordDecl>(D))
634 return new ASTRecordLayout(Builder.Size, Builder.Alignment, Builder.Size,
Mike Stump11289f42009-09-09 15:08:12 +0000635 Builder.FieldOffsets.data(),
Anders Carlssonfc8cfa82009-07-28 19:24:15 +0000636 Builder.FieldOffsets.size());
Mike Stump11289f42009-09-09 15:08:12 +0000637
Anders Carlssonfc8cfa82009-07-28 19:24:15 +0000638 // FIXME: This is not always correct. See the part about bitfields at
639 // http://www.codesourcery.com/public/cxx-abi/abi.html#POD for more info.
640 // FIXME: IsPODForThePurposeOfLayout should be stored in the record layout.
641 bool IsPODForThePurposeOfLayout = cast<CXXRecordDecl>(D)->isPOD();
Mike Stump11289f42009-09-09 15:08:12 +0000642
Anders Carlssonfc8cfa82009-07-28 19:24:15 +0000643 // FIXME: This should be done in FinalizeLayout.
Mike Stump11289f42009-09-09 15:08:12 +0000644 uint64_t DataSize =
Anders Carlsson47680d82009-09-26 01:34:51 +0000645 IsPODForThePurposeOfLayout ? Builder.Size : Builder.DataSize;
Mike Stump11289f42009-09-09 15:08:12 +0000646 uint64_t NonVirtualSize =
Anders Carlssonfc8cfa82009-07-28 19:24:15 +0000647 IsPODForThePurposeOfLayout ? DataSize : Builder.NonVirtualSize;
Mike Stump11289f42009-09-09 15:08:12 +0000648
Anders Carlsson6d9f6f32009-07-19 00:18:47 +0000649 return new ASTRecordLayout(Builder.Size, Builder.Alignment, DataSize,
Mike Stump11289f42009-09-09 15:08:12 +0000650 Builder.FieldOffsets.data(),
Anders Carlssonfc8cfa82009-07-28 19:24:15 +0000651 Builder.FieldOffsets.size(),
652 NonVirtualSize,
653 Builder.NonVirtualAlignment,
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000654 Builder.PrimaryBase,
Mike Stumpc266c6d2009-08-07 19:00:50 +0000655 Builder.PrimaryBaseWasVirtual,
Anders Carlssonfc8cfa82009-07-28 19:24:15 +0000656 Builder.Bases.data(),
Mike Stumpbcf756c2009-08-14 01:44:03 +0000657 Builder.Bases.size(),
658 Builder.VBases.data(),
Mike Stumpbcf756c2009-08-14 01:44:03 +0000659 Builder.VBases.size());
Anders Carlsson4f516282009-07-18 20:50:59 +0000660}
661
662const ASTRecordLayout *
663ASTRecordLayoutBuilder::ComputeLayout(ASTContext &Ctx,
664 const ObjCInterfaceDecl *D,
665 const ObjCImplementationDecl *Impl) {
666 ASTRecordLayoutBuilder Builder(Ctx);
Mike Stump11289f42009-09-09 15:08:12 +0000667
Anders Carlsson4f516282009-07-18 20:50:59 +0000668 Builder.Layout(D, Impl);
Mike Stump11289f42009-09-09 15:08:12 +0000669
Anders Carlsson4f516282009-07-18 20:50:59 +0000670 return new ASTRecordLayout(Builder.Size, Builder.Alignment,
Anders Carlsson47680d82009-09-26 01:34:51 +0000671 Builder.DataSize,
Mike Stump11289f42009-09-09 15:08:12 +0000672 Builder.FieldOffsets.data(),
Anders Carlsson79474332009-07-18 20:20:21 +0000673 Builder.FieldOffsets.size());
674}