blob: a8908f79d653ff89a31ea2fa7fcf89cde5bff649 [file] [log] [blame]
Anders Carlsson35a36eb2010-05-26 05:41:04 +00001//=== RecordLayoutBuilder.cpp - Helper class for building record layouts ---==//
Anders Carlsson79474332009-07-18 20:20:21 +00002//
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
Anders Carlsson79474332009-07-18 20:20:21 +000010#include "clang/AST/Attr.h"
11#include "clang/AST/Decl.h"
Anders Carlsson6d9f6f32009-07-19 00:18:47 +000012#include "clang/AST/DeclCXX.h"
Anders Carlsson4f516282009-07-18 20:50:59 +000013#include "clang/AST/DeclObjC.h"
Anders Carlsson79474332009-07-18 20:20:21 +000014#include "clang/AST/Expr.h"
Anders Carlsson35a36eb2010-05-26 05:41:04 +000015#include "clang/AST/RecordLayout.h"
Anders Carlsson79474332009-07-18 20:20:21 +000016#include "clang/Basic/TargetInfo.h"
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +000017#include "clang/Sema/SemaDiagnostic.h"
Daniel Dunbaraa423af2010-04-08 02:59:49 +000018#include "llvm/Support/Format.h"
19#include "llvm/ADT/SmallSet.h"
20#include "llvm/Support/MathExtras.h"
Anders Carlsson35a36eb2010-05-26 05:41:04 +000021#include <map>
Anders Carlsson79474332009-07-18 20:20:21 +000022
23using namespace clang;
24
Benjamin Kramerc7656cd2010-05-26 09:58:31 +000025namespace {
Anders Carlssonf58de112010-05-26 15:32:58 +000026
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000027/// BaseSubobjectInfo - Represents a single base subobject in a complete class.
28/// For a class hierarchy like
29///
30/// class A { };
31/// class B : A { };
32/// class C : A, B { };
33///
34/// The BaseSubobjectInfo graph for C will have three BaseSubobjectInfo
35/// instances, one for B and two for A.
36///
37/// If a base is virtual, it will only have one BaseSubobjectInfo allocated.
38struct BaseSubobjectInfo {
39 /// Class - The class for this base info.
Anders Carlsson056818f2010-05-28 21:13:31 +000040 const CXXRecordDecl *Class;
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000041
42 /// IsVirtual - Whether the BaseInfo represents a virtual base or not.
Anders Carlsson056818f2010-05-28 21:13:31 +000043 bool IsVirtual;
44
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000045 /// Bases - Information about the base subobjects.
46 llvm::SmallVector<BaseSubobjectInfo*, 4> Bases;
47
Anders Carlssone3c24c72010-05-29 17:35:14 +000048 /// PrimaryVirtualBaseInfo - Holds the base info for the primary virtual base
49 /// of this base info (if one exists).
50 BaseSubobjectInfo *PrimaryVirtualBaseInfo;
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000051
52 // FIXME: Document.
53 const BaseSubobjectInfo *Derived;
Anders Carlsson056818f2010-05-28 21:13:31 +000054};
55
Anders Carlssonf58de112010-05-26 15:32:58 +000056/// EmptySubobjectMap - Keeps track of which empty subobjects exist at different
57/// offsets while laying out a C++ class.
58class EmptySubobjectMap {
59 ASTContext &Context;
Anders Carlsson233e2722010-10-31 21:54:55 +000060 uint64_t CharWidth;
61
Anders Carlssonf58de112010-05-26 15:32:58 +000062 /// Class - The class whose empty entries we're keeping track of.
63 const CXXRecordDecl *Class;
Daniel Dunbar592a85c2010-05-27 02:25:46 +000064
Anders Carlsson439edd12010-05-27 05:41:06 +000065 /// EmptyClassOffsets - A map from offsets to empty record decls.
66 typedef llvm::SmallVector<const CXXRecordDecl *, 1> ClassVectorTy;
Anders Carlssonf8f756d2010-10-31 21:22:43 +000067 typedef llvm::DenseMap<CharUnits, ClassVectorTy> EmptyClassOffsetsMapTy;
Anders Carlsson439edd12010-05-27 05:41:06 +000068 EmptyClassOffsetsMapTy EmptyClassOffsets;
69
Anders Carlssoncc5de092010-06-08 15:56:03 +000070 /// MaxEmptyClassOffset - The highest offset known to contain an empty
71 /// base subobject.
Anders Carlsson725190f2010-10-31 21:39:24 +000072 CharUnits MaxEmptyClassOffset;
Anders Carlssoncc5de092010-06-08 15:56:03 +000073
Daniel Dunbar592a85c2010-05-27 02:25:46 +000074 /// ComputeEmptySubobjectSizes - Compute the size of the largest base or
Anders Carlssonc5ca1f72010-05-26 15:54:25 +000075 /// member subobject that is empty.
76 void ComputeEmptySubobjectSizes();
Anders Carlsson439edd12010-05-27 05:41:06 +000077
Anders Carlsson725190f2010-10-31 21:39:24 +000078 void AddSubobjectAtOffset(const CXXRecordDecl *RD, CharUnits Offset);
Anders Carlssondb319762010-05-27 18:20:57 +000079
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000080 void UpdateEmptyBaseSubobjects(const BaseSubobjectInfo *Info,
Anders Carlsson28466ab2010-10-31 22:13:23 +000081 CharUnits Offset, bool PlacingEmptyBase);
Anders Carlsson439edd12010-05-27 05:41:06 +000082
Anders Carlssondb319762010-05-27 18:20:57 +000083 void UpdateEmptyFieldSubobjects(const CXXRecordDecl *RD,
84 const CXXRecordDecl *Class,
Anders Carlsson28466ab2010-10-31 22:13:23 +000085 CharUnits Offset);
86 void UpdateEmptyFieldSubobjects(const FieldDecl *FD, CharUnits Offset);
Anders Carlssondb319762010-05-27 18:20:57 +000087
Anders Carlssoncc5de092010-06-08 15:56:03 +000088 /// AnyEmptySubobjectsBeyondOffset - Returns whether there are any empty
89 /// subobjects beyond the given offset.
Anders Carlsson725190f2010-10-31 21:39:24 +000090 bool AnyEmptySubobjectsBeyondOffset(CharUnits Offset) const {
Anders Carlssoncc5de092010-06-08 15:56:03 +000091 return Offset <= MaxEmptyClassOffset;
92 }
93
Anders Carlsson233e2722010-10-31 21:54:55 +000094 CharUnits
95 getFieldOffset(const ASTRecordLayout &Layout, unsigned FieldNo) const {
96 uint64_t FieldOffset = Layout.getFieldOffset(FieldNo);
97 assert(FieldOffset % CharWidth == 0 &&
98 "Field offset not at char boundary!");
99
100 return CharUnits::fromQuantity(FieldOffset / CharWidth);
101 }
102
Anders Carlsson28466ab2010-10-31 22:13:23 +0000103 // FIXME: Remove this.
Anders Carlssonf8f756d2010-10-31 21:22:43 +0000104 CharUnits toCharUnits(uint64_t Offset) const {
Anders Carlsson233e2722010-10-31 21:54:55 +0000105 return CharUnits::fromQuantity(Offset / CharWidth);
Anders Carlssonf8f756d2010-10-31 21:22:43 +0000106 }
Anders Carlssonf8f756d2010-10-31 21:22:43 +0000107
Charles Davisc2c576a2010-08-19 00:55:19 +0000108protected:
Anders Carlsson725190f2010-10-31 21:39:24 +0000109 bool CanPlaceSubobjectAtOffset(const CXXRecordDecl *RD,
110 CharUnits Offset) const;
Charles Davisc2c576a2010-08-19 00:55:19 +0000111
112 bool CanPlaceBaseSubobjectAtOffset(const BaseSubobjectInfo *Info,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000113 CharUnits Offset);
Charles Davisc2c576a2010-08-19 00:55:19 +0000114
115 bool CanPlaceFieldSubobjectAtOffset(const CXXRecordDecl *RD,
116 const CXXRecordDecl *Class,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000117 CharUnits Offset) const;
Charles Davisc2c576a2010-08-19 00:55:19 +0000118 bool CanPlaceFieldSubobjectAtOffset(const FieldDecl *FD,
Anders Carlsson233e2722010-10-31 21:54:55 +0000119 CharUnits Offset) const;
Charles Davisc2c576a2010-08-19 00:55:19 +0000120
Anders Carlssonf58de112010-05-26 15:32:58 +0000121public:
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000122 /// This holds the size of the largest empty subobject (either a base
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000123 /// or a member). Will be zero if the record being built doesn't contain
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000124 /// any empty classes.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000125 CharUnits SizeOfLargestEmptySubobject;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000126
Anders Carlssonf58de112010-05-26 15:32:58 +0000127 EmptySubobjectMap(ASTContext &Context, const CXXRecordDecl *Class)
Anders Carlsson28466ab2010-10-31 22:13:23 +0000128 : Context(Context), CharWidth(Context.getCharWidth()), Class(Class) {
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000129 ComputeEmptySubobjectSizes();
130 }
131
132 /// CanPlaceBaseAtOffset - Return whether the given base class can be placed
133 /// at the given offset.
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000134 /// Returns false if placing the record will result in two components
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000135 /// (direct or indirect) of the same type having the same offset.
Anders Carlssoncc5de092010-06-08 15:56:03 +0000136 bool CanPlaceBaseAtOffset(const BaseSubobjectInfo *Info,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000137 CharUnits Offset);
Anders Carlssondb319762010-05-27 18:20:57 +0000138
139 /// CanPlaceFieldAtOffset - Return whether a field can be placed at the given
140 /// offset.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000141 bool CanPlaceFieldAtOffset(const FieldDecl *FD, CharUnits Offset);
Anders Carlssonf58de112010-05-26 15:32:58 +0000142};
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000143
144void EmptySubobjectMap::ComputeEmptySubobjectSizes() {
145 // Check the bases.
146 for (CXXRecordDecl::base_class_const_iterator I = Class->bases_begin(),
147 E = Class->bases_end(); I != E; ++I) {
148 const CXXRecordDecl *BaseDecl =
149 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
150
Anders Carlsson28466ab2010-10-31 22:13:23 +0000151 CharUnits EmptySize;
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000152 const ASTRecordLayout &Layout = Context.getASTRecordLayout(BaseDecl);
153 if (BaseDecl->isEmpty()) {
154 // If the class decl is empty, get its size.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000155 EmptySize = toCharUnits(Layout.getSize());
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000156 } else {
157 // Otherwise, we get the largest empty subobject for the decl.
158 EmptySize = Layout.getSizeOfLargestEmptySubobject();
159 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000160
Anders Carlsson28466ab2010-10-31 22:13:23 +0000161 if (EmptySize > SizeOfLargestEmptySubobject)
162 SizeOfLargestEmptySubobject = EmptySize;
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000163 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000164
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000165 // Check the fields.
166 for (CXXRecordDecl::field_iterator I = Class->field_begin(),
167 E = Class->field_end(); I != E; ++I) {
168 const FieldDecl *FD = *I;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000169
170 const RecordType *RT =
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000171 Context.getBaseElementType(FD->getType())->getAs<RecordType>();
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000172
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000173 // We only care about record types.
174 if (!RT)
175 continue;
176
Anders Carlsson28466ab2010-10-31 22:13:23 +0000177 CharUnits EmptySize;
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000178 const CXXRecordDecl *MemberDecl = cast<CXXRecordDecl>(RT->getDecl());
179 const ASTRecordLayout &Layout = Context.getASTRecordLayout(MemberDecl);
180 if (MemberDecl->isEmpty()) {
181 // If the class decl is empty, get its size.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000182 EmptySize = toCharUnits(Layout.getSize());
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000183 } else {
184 // Otherwise, we get the largest empty subobject for the decl.
185 EmptySize = Layout.getSizeOfLargestEmptySubobject();
186 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000187
Anders Carlsson28466ab2010-10-31 22:13:23 +0000188 if (EmptySize > SizeOfLargestEmptySubobject)
189 SizeOfLargestEmptySubobject = EmptySize;
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000190 }
191}
192
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000193bool
Anders Carlssondb319762010-05-27 18:20:57 +0000194EmptySubobjectMap::CanPlaceSubobjectAtOffset(const CXXRecordDecl *RD,
Anders Carlsson725190f2010-10-31 21:39:24 +0000195 CharUnits Offset) const {
Anders Carlssondb319762010-05-27 18:20:57 +0000196 // We only need to check empty bases.
197 if (!RD->isEmpty())
198 return true;
199
Anders Carlsson725190f2010-10-31 21:39:24 +0000200 EmptyClassOffsetsMapTy::const_iterator I = EmptyClassOffsets.find(Offset);
Anders Carlssondb319762010-05-27 18:20:57 +0000201 if (I == EmptyClassOffsets.end())
202 return true;
203
204 const ClassVectorTy& Classes = I->second;
205 if (std::find(Classes.begin(), Classes.end(), RD) == Classes.end())
206 return true;
207
208 // There is already an empty class of the same type at this offset.
209 return false;
210}
211
212void EmptySubobjectMap::AddSubobjectAtOffset(const CXXRecordDecl *RD,
Anders Carlsson725190f2010-10-31 21:39:24 +0000213 CharUnits Offset) {
Anders Carlssondb319762010-05-27 18:20:57 +0000214 // We only care about empty bases.
215 if (!RD->isEmpty())
216 return;
217
Anders Carlsson725190f2010-10-31 21:39:24 +0000218 ClassVectorTy& Classes = EmptyClassOffsets[Offset];
Anders Carlssondb319762010-05-27 18:20:57 +0000219 assert(std::find(Classes.begin(), Classes.end(), RD) == Classes.end() &&
220 "Duplicate empty class detected!");
Anders Carlsson44687202010-06-08 19:09:24 +0000221
Anders Carlssondb319762010-05-27 18:20:57 +0000222 Classes.push_back(RD);
Anders Carlssoncc5de092010-06-08 15:56:03 +0000223
224 // Update the empty class offset.
Anders Carlsson725190f2010-10-31 21:39:24 +0000225 if (Offset > MaxEmptyClassOffset)
226 MaxEmptyClassOffset = Offset;
Anders Carlssondb319762010-05-27 18:20:57 +0000227}
228
229bool
Anders Carlsson28466ab2010-10-31 22:13:23 +0000230EmptySubobjectMap::CanPlaceBaseSubobjectAtOffset(const BaseSubobjectInfo *Info,
231 CharUnits Offset) {
Anders Carlsson45c1d282010-06-08 16:20:35 +0000232 // We don't have to keep looking past the maximum offset that's known to
233 // contain an empty class.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000234 if (!AnyEmptySubobjectsBeyondOffset(Offset))
Anders Carlsson45c1d282010-06-08 16:20:35 +0000235 return true;
236
Anders Carlsson28466ab2010-10-31 22:13:23 +0000237 if (!CanPlaceSubobjectAtOffset(Info->Class, Offset))
Anders Carlssondb319762010-05-27 18:20:57 +0000238 return false;
239
Anders Carlsson439edd12010-05-27 05:41:06 +0000240 // Traverse all non-virtual bases.
Anders Carlssona7774a62010-05-29 21:10:24 +0000241 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Info->Class);
Anders Carlsson439edd12010-05-27 05:41:06 +0000242 for (unsigned I = 0, E = Info->Bases.size(); I != E; ++I) {
Anders Carlssona7f3cdb2010-05-28 21:24:37 +0000243 BaseSubobjectInfo* Base = Info->Bases[I];
Anders Carlsson439edd12010-05-27 05:41:06 +0000244 if (Base->IsVirtual)
245 continue;
246
Anders Carlsson28466ab2010-10-31 22:13:23 +0000247 CharUnits BaseOffset =
Anders Carlssonfd88a612010-10-31 23:22:37 +0000248 Offset + toCharUnits(Layout.getBaseClassOffsetInBits(Base->Class));
Anders Carlsson439edd12010-05-27 05:41:06 +0000249
250 if (!CanPlaceBaseSubobjectAtOffset(Base, BaseOffset))
251 return false;
252 }
253
Anders Carlssone3c24c72010-05-29 17:35:14 +0000254 if (Info->PrimaryVirtualBaseInfo) {
255 BaseSubobjectInfo *PrimaryVirtualBaseInfo = Info->PrimaryVirtualBaseInfo;
Anders Carlsson439edd12010-05-27 05:41:06 +0000256
257 if (Info == PrimaryVirtualBaseInfo->Derived) {
258 if (!CanPlaceBaseSubobjectAtOffset(PrimaryVirtualBaseInfo, Offset))
259 return false;
260 }
261 }
262
Anders Carlssondb319762010-05-27 18:20:57 +0000263 // Traverse all member variables.
264 unsigned FieldNo = 0;
265 for (CXXRecordDecl::field_iterator I = Info->Class->field_begin(),
266 E = Info->Class->field_end(); I != E; ++I, ++FieldNo) {
267 const FieldDecl *FD = *I;
Anders Carlsson233e2722010-10-31 21:54:55 +0000268 if (FD->isBitField())
269 continue;
270
Anders Carlsson28466ab2010-10-31 22:13:23 +0000271 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
Anders Carlssondb319762010-05-27 18:20:57 +0000272 if (!CanPlaceFieldSubobjectAtOffset(FD, FieldOffset))
273 return false;
274 }
275
Anders Carlsson439edd12010-05-27 05:41:06 +0000276 return true;
277}
278
Anders Carlssona7f3cdb2010-05-28 21:24:37 +0000279void EmptySubobjectMap::UpdateEmptyBaseSubobjects(const BaseSubobjectInfo *Info,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000280 CharUnits Offset,
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000281 bool PlacingEmptyBase) {
282 if (!PlacingEmptyBase && Offset >= SizeOfLargestEmptySubobject) {
283 // We know that the only empty subobjects that can conflict with empty
284 // subobject of non-empty bases, are empty bases that can be placed at
285 // offset zero. Because of this, we only need to keep track of empty base
286 // subobjects with offsets less than the size of the largest empty
287 // subobject for our class.
288 return;
289 }
290
Anders Carlsson28466ab2010-10-31 22:13:23 +0000291 AddSubobjectAtOffset(Info->Class, Offset);
Anders Carlssona7774a62010-05-29 21:10:24 +0000292
Anders Carlsson439edd12010-05-27 05:41:06 +0000293 // Traverse all non-virtual bases.
Anders Carlssona7774a62010-05-29 21:10:24 +0000294 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Info->Class);
Anders Carlsson439edd12010-05-27 05:41:06 +0000295 for (unsigned I = 0, E = Info->Bases.size(); I != E; ++I) {
Anders Carlssona7f3cdb2010-05-28 21:24:37 +0000296 BaseSubobjectInfo* Base = Info->Bases[I];
Anders Carlsson439edd12010-05-27 05:41:06 +0000297 if (Base->IsVirtual)
298 continue;
Anders Carlssona7774a62010-05-29 21:10:24 +0000299
Anders Carlsson28466ab2010-10-31 22:13:23 +0000300 CharUnits BaseOffset =
Anders Carlssonfd88a612010-10-31 23:22:37 +0000301 Offset + toCharUnits(Layout.getBaseClassOffsetInBits(Base->Class));
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000302 UpdateEmptyBaseSubobjects(Base, BaseOffset, PlacingEmptyBase);
Anders Carlsson439edd12010-05-27 05:41:06 +0000303 }
304
Anders Carlssone3c24c72010-05-29 17:35:14 +0000305 if (Info->PrimaryVirtualBaseInfo) {
306 BaseSubobjectInfo *PrimaryVirtualBaseInfo = Info->PrimaryVirtualBaseInfo;
Anders Carlsson439edd12010-05-27 05:41:06 +0000307
308 if (Info == PrimaryVirtualBaseInfo->Derived)
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000309 UpdateEmptyBaseSubobjects(PrimaryVirtualBaseInfo, Offset,
310 PlacingEmptyBase);
Anders Carlsson439edd12010-05-27 05:41:06 +0000311 }
Anders Carlssondb319762010-05-27 18:20:57 +0000312
Anders Carlssondb319762010-05-27 18:20:57 +0000313 // Traverse all member variables.
314 unsigned FieldNo = 0;
315 for (CXXRecordDecl::field_iterator I = Info->Class->field_begin(),
316 E = Info->Class->field_end(); I != E; ++I, ++FieldNo) {
317 const FieldDecl *FD = *I;
Anders Carlsson233e2722010-10-31 21:54:55 +0000318 if (FD->isBitField())
319 continue;
Anders Carlssona7774a62010-05-29 21:10:24 +0000320
Anders Carlsson28466ab2010-10-31 22:13:23 +0000321 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
322 UpdateEmptyFieldSubobjects(FD, FieldOffset);
Anders Carlssondb319762010-05-27 18:20:57 +0000323 }
Anders Carlsson439edd12010-05-27 05:41:06 +0000324}
325
Anders Carlssona60b86a2010-05-29 20:49:49 +0000326bool EmptySubobjectMap::CanPlaceBaseAtOffset(const BaseSubobjectInfo *Info,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000327 CharUnits Offset) {
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000328 // If we know this class doesn't have any empty subobjects we don't need to
329 // bother checking.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000330 if (SizeOfLargestEmptySubobject.isZero())
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000331 return true;
332
Anders Carlsson439edd12010-05-27 05:41:06 +0000333 if (!CanPlaceBaseSubobjectAtOffset(Info, Offset))
334 return false;
Anders Carlssondb319762010-05-27 18:20:57 +0000335
336 // We are able to place the base at this offset. Make sure to update the
337 // empty base subobject map.
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000338 UpdateEmptyBaseSubobjects(Info, Offset, Info->Class->isEmpty());
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000339 return true;
340}
341
Anders Carlssondb319762010-05-27 18:20:57 +0000342bool
343EmptySubobjectMap::CanPlaceFieldSubobjectAtOffset(const CXXRecordDecl *RD,
344 const CXXRecordDecl *Class,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000345 CharUnits Offset) const {
Anders Carlsson45c1d282010-06-08 16:20:35 +0000346 // We don't have to keep looking past the maximum offset that's known to
347 // contain an empty class.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000348 if (!AnyEmptySubobjectsBeyondOffset(Offset))
Anders Carlsson45c1d282010-06-08 16:20:35 +0000349 return true;
350
Anders Carlsson28466ab2010-10-31 22:13:23 +0000351 if (!CanPlaceSubobjectAtOffset(RD, Offset))
Anders Carlssondb319762010-05-27 18:20:57 +0000352 return false;
353
354 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
355
356 // Traverse all non-virtual bases.
357 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
358 E = RD->bases_end(); I != E; ++I) {
359 if (I->isVirtual())
360 continue;
361
362 const CXXRecordDecl *BaseDecl =
363 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
364
Anders Carlsson28466ab2010-10-31 22:13:23 +0000365 CharUnits BaseOffset =
Anders Carlssonfd88a612010-10-31 23:22:37 +0000366 Offset + toCharUnits(Layout.getBaseClassOffsetInBits(BaseDecl));
Anders Carlssondb319762010-05-27 18:20:57 +0000367 if (!CanPlaceFieldSubobjectAtOffset(BaseDecl, Class, BaseOffset))
368 return false;
369 }
370
Anders Carlsson44687202010-06-08 19:09:24 +0000371 if (RD == Class) {
372 // This is the most derived class, traverse virtual bases as well.
373 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
374 E = RD->vbases_end(); I != E; ++I) {
375 const CXXRecordDecl *VBaseDecl =
376 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
377
Anders Carlsson28466ab2010-10-31 22:13:23 +0000378 CharUnits VBaseOffset = Offset +
Anders Carlssonfd88a612010-10-31 23:22:37 +0000379 toCharUnits(Layout.getVBaseClassOffsetInBits(VBaseDecl));
Anders Carlsson44687202010-06-08 19:09:24 +0000380 if (!CanPlaceFieldSubobjectAtOffset(VBaseDecl, Class, VBaseOffset))
381 return false;
382 }
383 }
384
Anders Carlssondb319762010-05-27 18:20:57 +0000385 // Traverse all member variables.
386 unsigned FieldNo = 0;
387 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
388 I != E; ++I, ++FieldNo) {
389 const FieldDecl *FD = *I;
Anders Carlsson233e2722010-10-31 21:54:55 +0000390 if (FD->isBitField())
391 continue;
392
Anders Carlsson28466ab2010-10-31 22:13:23 +0000393 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
Anders Carlssondb319762010-05-27 18:20:57 +0000394
395 if (!CanPlaceFieldSubobjectAtOffset(FD, FieldOffset))
396 return false;
397 }
398
399 return true;
400}
401
Anders Carlsson233e2722010-10-31 21:54:55 +0000402bool
403EmptySubobjectMap::CanPlaceFieldSubobjectAtOffset(const FieldDecl *FD,
404 CharUnits Offset) const {
Anders Carlsson45c1d282010-06-08 16:20:35 +0000405 // We don't have to keep looking past the maximum offset that's known to
406 // contain an empty class.
Anders Carlsson233e2722010-10-31 21:54:55 +0000407 if (!AnyEmptySubobjectsBeyondOffset(Offset))
Anders Carlsson45c1d282010-06-08 16:20:35 +0000408 return true;
409
Anders Carlssondb319762010-05-27 18:20:57 +0000410 QualType T = FD->getType();
411 if (const RecordType *RT = T->getAs<RecordType>()) {
412 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
Anders Carlsson28466ab2010-10-31 22:13:23 +0000413 return CanPlaceFieldSubobjectAtOffset(RD, RD, Offset);
Anders Carlssondb319762010-05-27 18:20:57 +0000414 }
415
416 // If we have an array type we need to look at every element.
417 if (const ConstantArrayType *AT = Context.getAsConstantArrayType(T)) {
418 QualType ElemTy = Context.getBaseElementType(AT);
419 const RecordType *RT = ElemTy->getAs<RecordType>();
420 if (!RT)
421 return true;
422
423 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
424 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
425
426 uint64_t NumElements = Context.getConstantArrayElementCount(AT);
Anders Carlsson233e2722010-10-31 21:54:55 +0000427 CharUnits ElementOffset = Offset;
Anders Carlssondb319762010-05-27 18:20:57 +0000428 for (uint64_t I = 0; I != NumElements; ++I) {
Anders Carlsson45c1d282010-06-08 16:20:35 +0000429 // We don't have to keep looking past the maximum offset that's known to
430 // contain an empty class.
Anders Carlsson233e2722010-10-31 21:54:55 +0000431 if (!AnyEmptySubobjectsBeyondOffset(ElementOffset))
Anders Carlsson45c1d282010-06-08 16:20:35 +0000432 return true;
433
Anders Carlsson28466ab2010-10-31 22:13:23 +0000434 if (!CanPlaceFieldSubobjectAtOffset(RD, RD, ElementOffset))
Anders Carlssondb319762010-05-27 18:20:57 +0000435 return false;
436
Anders Carlsson233e2722010-10-31 21:54:55 +0000437 ElementOffset += toCharUnits(Layout.getSize());
Anders Carlssondb319762010-05-27 18:20:57 +0000438 }
439 }
440
441 return true;
442}
443
444bool
Anders Carlsson28466ab2010-10-31 22:13:23 +0000445EmptySubobjectMap::CanPlaceFieldAtOffset(const FieldDecl *FD,
446 CharUnits Offset) {
447 if (!CanPlaceFieldSubobjectAtOffset(FD, Offset))
Anders Carlssondb319762010-05-27 18:20:57 +0000448 return false;
449
450 // We are able to place the member variable at this offset.
451 // Make sure to update the empty base subobject map.
452 UpdateEmptyFieldSubobjects(FD, Offset);
453 return true;
454}
455
456void EmptySubobjectMap::UpdateEmptyFieldSubobjects(const CXXRecordDecl *RD,
457 const CXXRecordDecl *Class,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000458 CharUnits Offset) {
Anders Carlssonae111dc2010-06-13 17:49:16 +0000459 // We know that the only empty subobjects that can conflict with empty
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000460 // field subobjects are subobjects of empty bases that can be placed at offset
Anders Carlssonae111dc2010-06-13 17:49:16 +0000461 // zero. Because of this, we only need to keep track of empty field
462 // subobjects with offsets less than the size of the largest empty
463 // subobject for our class.
464 if (Offset >= SizeOfLargestEmptySubobject)
465 return;
466
Anders Carlsson28466ab2010-10-31 22:13:23 +0000467 AddSubobjectAtOffset(RD, Offset);
Anders Carlssondb319762010-05-27 18:20:57 +0000468
469 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
470
471 // Traverse all non-virtual bases.
472 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
473 E = RD->bases_end(); I != E; ++I) {
474 if (I->isVirtual())
475 continue;
476
477 const CXXRecordDecl *BaseDecl =
478 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
479
Anders Carlsson28466ab2010-10-31 22:13:23 +0000480 CharUnits BaseOffset =
Anders Carlssonfd88a612010-10-31 23:22:37 +0000481 Offset + toCharUnits(Layout.getBaseClassOffsetInBits(BaseDecl));
Anders Carlssondb319762010-05-27 18:20:57 +0000482 UpdateEmptyFieldSubobjects(BaseDecl, Class, BaseOffset);
483 }
484
Anders Carlsson44687202010-06-08 19:09:24 +0000485 if (RD == Class) {
486 // This is the most derived class, traverse virtual bases as well.
487 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
488 E = RD->vbases_end(); I != E; ++I) {
489 const CXXRecordDecl *VBaseDecl =
490 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
491
Anders Carlsson28466ab2010-10-31 22:13:23 +0000492 CharUnits VBaseOffset =
Anders Carlssonfd88a612010-10-31 23:22:37 +0000493 Offset + toCharUnits(Layout.getVBaseClassOffsetInBits(VBaseDecl));
Anders Carlsson44687202010-06-08 19:09:24 +0000494 UpdateEmptyFieldSubobjects(VBaseDecl, Class, VBaseOffset);
495 }
496 }
497
Anders Carlssondb319762010-05-27 18:20:57 +0000498 // Traverse all member variables.
499 unsigned FieldNo = 0;
500 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
501 I != E; ++I, ++FieldNo) {
502 const FieldDecl *FD = *I;
503
Anders Carlsson28466ab2010-10-31 22:13:23 +0000504 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
Anders Carlssondb319762010-05-27 18:20:57 +0000505
Anders Carlsson28466ab2010-10-31 22:13:23 +0000506 UpdateEmptyFieldSubobjects(FD, FieldOffset);
Anders Carlssondb319762010-05-27 18:20:57 +0000507 }
508}
509
510void EmptySubobjectMap::UpdateEmptyFieldSubobjects(const FieldDecl *FD,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000511 CharUnits Offset) {
Anders Carlssondb319762010-05-27 18:20:57 +0000512 QualType T = FD->getType();
513 if (const RecordType *RT = T->getAs<RecordType>()) {
514 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
515 UpdateEmptyFieldSubobjects(RD, RD, Offset);
516 return;
517 }
518
519 // If we have an array type we need to update every element.
520 if (const ConstantArrayType *AT = Context.getAsConstantArrayType(T)) {
521 QualType ElemTy = Context.getBaseElementType(AT);
522 const RecordType *RT = ElemTy->getAs<RecordType>();
523 if (!RT)
524 return;
525
526 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
527 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
528
529 uint64_t NumElements = Context.getConstantArrayElementCount(AT);
Anders Carlsson28466ab2010-10-31 22:13:23 +0000530 CharUnits ElementOffset = Offset;
Anders Carlssondb319762010-05-27 18:20:57 +0000531
532 for (uint64_t I = 0; I != NumElements; ++I) {
Anders Carlssonae111dc2010-06-13 17:49:16 +0000533 // We know that the only empty subobjects that can conflict with empty
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000534 // field subobjects are subobjects of empty bases that can be placed at
Anders Carlssonae111dc2010-06-13 17:49:16 +0000535 // offset zero. Because of this, we only need to keep track of empty field
536 // subobjects with offsets less than the size of the largest empty
537 // subobject for our class.
538 if (ElementOffset >= SizeOfLargestEmptySubobject)
539 return;
540
Anders Carlssondb319762010-05-27 18:20:57 +0000541 UpdateEmptyFieldSubobjects(RD, RD, ElementOffset);
Anders Carlsson28466ab2010-10-31 22:13:23 +0000542 ElementOffset += toCharUnits(Layout.getSize());
Anders Carlssondb319762010-05-27 18:20:57 +0000543 }
544 }
545}
546
Anders Carlssonc2226202010-05-26 05:58:59 +0000547class RecordLayoutBuilder {
Charles Davisc2c576a2010-08-19 00:55:19 +0000548protected:
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000549 // FIXME: Remove this and make the appropriate fields public.
550 friend class clang::ASTContext;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000551
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000552 ASTContext &Context;
553
Anders Carlssonf58de112010-05-26 15:32:58 +0000554 EmptySubobjectMap *EmptySubobjects;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000555
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000556 /// Size - The current size of the record layout.
557 uint64_t Size;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000558
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000559 /// Alignment - The current alignment of the record layout.
560 unsigned Alignment;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000561
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000562 /// \brief The alignment if attribute packed is not used.
563 unsigned UnpackedAlignment;
564
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000565 llvm::SmallVector<uint64_t, 16> FieldOffsets;
566
567 /// Packed - Whether the record is packed or not.
Daniel Dunbar6da10982010-05-27 05:45:51 +0000568 unsigned Packed : 1;
569
570 unsigned IsUnion : 1;
571
572 unsigned IsMac68kAlign : 1;
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000573
574 /// UnfilledBitsInLastByte - If the last field laid out was a bitfield,
575 /// this contains the number of bits in the last byte that can be used for
576 /// an adjacent bitfield if necessary.
577 unsigned char UnfilledBitsInLastByte;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000578
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000579 /// MaxFieldAlignment - The maximum allowed field alignment. This is set by
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000580 /// #pragma pack.
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000581 unsigned MaxFieldAlignment;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000582
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000583 /// DataSize - The data size of the record being laid out.
584 uint64_t DataSize;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000585
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000586 uint64_t NonVirtualSize;
587 unsigned NonVirtualAlignment;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000588
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000589 /// PrimaryBase - the primary base class (if one exists) of the class
590 /// we're laying out.
591 const CXXRecordDecl *PrimaryBase;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000592
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000593 /// PrimaryBaseIsVirtual - Whether the primary base of the class we're laying
594 /// out is virtual.
595 bool PrimaryBaseIsVirtual;
596
Anders Carlsson22f57202010-10-31 21:01:46 +0000597 typedef llvm::DenseMap<const CXXRecordDecl *, CharUnits> BaseOffsetsMapTy;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000598
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000599 /// Bases - base classes and their offsets in the record.
600 BaseOffsetsMapTy Bases;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000601
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000602 // VBases - virtual base classes and their offsets in the record.
603 BaseOffsetsMapTy VBases;
604
605 /// IndirectPrimaryBases - Virtual base classes, direct or indirect, that are
606 /// primary base classes for some other direct or indirect base class.
607 llvm::SmallSet<const CXXRecordDecl*, 32> IndirectPrimaryBases;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000608
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000609 /// FirstNearlyEmptyVBase - The first nearly empty virtual base class in
610 /// inheritance graph order. Used for determining the primary base class.
611 const CXXRecordDecl *FirstNearlyEmptyVBase;
612
613 /// VisitedVirtualBases - A set of all the visited virtual bases, used to
614 /// avoid visiting virtual bases more than once.
615 llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBases;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000616
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000617 RecordLayoutBuilder(ASTContext &Context, EmptySubobjectMap *EmptySubobjects)
618 : Context(Context), EmptySubobjects(EmptySubobjects), Size(0), Alignment(8),
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000619 UnpackedAlignment(Alignment), Packed(false), IsUnion(false),
620 IsMac68kAlign(false), UnfilledBitsInLastByte(0), MaxFieldAlignment(0),
621 DataSize(0), NonVirtualSize(0), NonVirtualAlignment(8), PrimaryBase(0),
Daniel Dunbar6da10982010-05-27 05:45:51 +0000622 PrimaryBaseIsVirtual(false), FirstNearlyEmptyVBase(0) { }
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000623
Anders Carlsson725190f2010-10-31 21:39:24 +0000624 // FIXME: Remove these.
625 CharUnits toCharUnits(uint64_t Offset) const {
626 return CharUnits::fromQuantity(Offset / Context.getCharWidth());
627 }
628 uint64_t toOffset(CharUnits Offset) const {
629 return Offset.getQuantity() * Context.getCharWidth();
630 }
631
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000632 void Layout(const RecordDecl *D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000633 void Layout(const CXXRecordDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000634 void Layout(const ObjCInterfaceDecl *D);
635
636 void LayoutFields(const RecordDecl *D);
637 void LayoutField(const FieldDecl *D);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000638 void LayoutWideBitField(uint64_t FieldSize, uint64_t TypeSize,
639 bool FieldPacked, const FieldDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000640 void LayoutBitField(const FieldDecl *D);
641
Anders Carlssone3c24c72010-05-29 17:35:14 +0000642 /// BaseSubobjectInfoAllocator - Allocator for BaseSubobjectInfo objects.
643 llvm::SpecificBumpPtrAllocator<BaseSubobjectInfo> BaseSubobjectInfoAllocator;
644
645 typedef llvm::DenseMap<const CXXRecordDecl *, BaseSubobjectInfo *>
646 BaseSubobjectInfoMapTy;
647
648 /// VirtualBaseInfo - Map from all the (direct or indirect) virtual bases
649 /// of the class we're laying out to their base subobject info.
650 BaseSubobjectInfoMapTy VirtualBaseInfo;
651
652 /// NonVirtualBaseInfo - Map from all the direct non-virtual bases of the
653 /// class we're laying out to their base subobject info.
654 BaseSubobjectInfoMapTy NonVirtualBaseInfo;
655
656 /// ComputeBaseSubobjectInfo - Compute the base subobject information for the
657 /// bases of the given class.
658 void ComputeBaseSubobjectInfo(const CXXRecordDecl *RD);
659
660 /// ComputeBaseSubobjectInfo - Compute the base subobject information for a
661 /// single class and all of its base classes.
662 BaseSubobjectInfo *ComputeBaseSubobjectInfo(const CXXRecordDecl *RD,
663 bool IsVirtual,
664 BaseSubobjectInfo *Derived);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000665
666 /// DeterminePrimaryBase - Determine the primary base of the given class.
667 void DeterminePrimaryBase(const CXXRecordDecl *RD);
668
669 void SelectPrimaryVBase(const CXXRecordDecl *RD);
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000670
Charles Davisc2c576a2010-08-19 00:55:19 +0000671 virtual uint64_t GetVirtualPointersSize(const CXXRecordDecl *RD) const;
672
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000673 /// IdentifyPrimaryBases - Identify all virtual base classes, direct or
674 /// indirect, that are primary base classes for some other direct or indirect
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000675 /// base class.
676 void IdentifyPrimaryBases(const CXXRecordDecl *RD);
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000677
Charles Davisc2c576a2010-08-19 00:55:19 +0000678 virtual bool IsNearlyEmpty(const CXXRecordDecl *RD) const;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000679
680 /// LayoutNonVirtualBases - Determines the primary base class (if any) and
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000681 /// lays it out. Will then proceed to lay out all non-virtual base clasess.
682 void LayoutNonVirtualBases(const CXXRecordDecl *RD);
683
684 /// LayoutNonVirtualBase - Lays out a single non-virtual base.
Anders Carlssonbb0e6782010-05-29 17:42:25 +0000685 void LayoutNonVirtualBase(const BaseSubobjectInfo *Base);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000686
Anders Carlssona2f8e412010-10-31 22:20:42 +0000687 void AddPrimaryVirtualBaseOffsets(const BaseSubobjectInfo *Info,
688 CharUnits Offset);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000689
690 /// LayoutVirtualBases - Lays out all the virtual bases.
691 void LayoutVirtualBases(const CXXRecordDecl *RD,
692 const CXXRecordDecl *MostDerivedClass);
693
694 /// LayoutVirtualBase - Lays out a single virtual base.
Anders Carlssond6ff5d72010-05-29 17:48:36 +0000695 void LayoutVirtualBase(const BaseSubobjectInfo *Base);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000696
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000697 /// LayoutBase - Will lay out a base and return the offset where it was
Anders Carlssona2f8e412010-10-31 22:20:42 +0000698 /// placed, in chars.
699 CharUnits LayoutBase(const BaseSubobjectInfo *Base);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000700
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000701 /// InitializeLayout - Initialize record layout for the given record decl.
Daniel Dunbar6da10982010-05-27 05:45:51 +0000702 void InitializeLayout(const Decl *D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000703
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000704 /// FinishLayout - Finalize record layout. Adjust record size based on the
705 /// alignment.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000706 void FinishLayout(const NamedDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000707
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000708 void UpdateAlignment(unsigned NewAlignment, unsigned UnpackedNewAlignment);
709 void UpdateAlignment(unsigned NewAlignment) {
710 UpdateAlignment(NewAlignment, NewAlignment);
711 }
712
713 void CheckFieldPadding(uint64_t Offset, uint64_t UnpaddedOffset,
714 uint64_t UnpackedOffset, unsigned UnpackedAlign,
715 bool isPacked, const FieldDecl *D);
716
717 DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000718
Argyrios Kyrtzidis499e6e42010-08-15 10:17:39 +0000719 RecordLayoutBuilder(const RecordLayoutBuilder&); // DO NOT IMPLEMENT
720 void operator=(const RecordLayoutBuilder&); // DO NOT IMPLEMENT
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000721public:
722 static const CXXMethodDecl *ComputeKeyFunction(const CXXRecordDecl *RD);
Argyrios Kyrtzidis3c6cd172010-08-25 00:32:14 +0000723
724 virtual ~RecordLayoutBuilder() { }
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000725};
Benjamin Kramerc7656cd2010-05-26 09:58:31 +0000726} // end anonymous namespace
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000727
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000728/// IsNearlyEmpty - Indicates when a class has a vtable pointer, but
729/// no other data.
Anders Carlssonc2226202010-05-26 05:58:59 +0000730bool RecordLayoutBuilder::IsNearlyEmpty(const CXXRecordDecl *RD) const {
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000731 // FIXME: Audit the corners
732 if (!RD->isDynamicClass())
733 return false;
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000734 const ASTRecordLayout &BaseInfo = Context.getASTRecordLayout(RD);
735 if (BaseInfo.getNonVirtualSize() == Context.Target.getPointerWidth(0))
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000736 return true;
737 return false;
738}
739
Anders Carlssonc2226202010-05-26 05:58:59 +0000740void RecordLayoutBuilder::IdentifyPrimaryBases(const CXXRecordDecl *RD) {
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000741 const ASTRecordLayout::PrimaryBaseInfo &BaseInfo =
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000742 Context.getASTRecordLayout(RD).getPrimaryBaseInfo();
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000743
Anders Carlsson81430692009-09-22 03:02:06 +0000744 // If the record has a primary base class that is virtual, add it to the set
745 // of primary bases.
Anders Carlssona30c0d32009-11-27 22:14:40 +0000746 if (BaseInfo.isVirtual())
747 IndirectPrimaryBases.insert(BaseInfo.getBase());
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000748
Anders Carlsson81430692009-09-22 03:02:06 +0000749 // Now traverse all bases and find primary bases for them.
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000750 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000751 e = RD->bases_end(); i != e; ++i) {
Sebastian Redl1054fae2009-10-25 17:03:50 +0000752 assert(!i->getType()->isDependentType() &&
753 "Cannot layout class with dependent bases.");
Mike Stump11289f42009-09-09 15:08:12 +0000754 const CXXRecordDecl *Base =
Mike Stump78696a72009-08-11 04:03:59 +0000755 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000756
Mike Stump78696a72009-08-11 04:03:59 +0000757 // Only bases with virtual bases participate in computing the
758 // indirect primary virtual base classes.
Mike Stumpc2f591b2009-08-13 22:53:07 +0000759 if (Base->getNumVBases())
Anders Carlsson81430692009-09-22 03:02:06 +0000760 IdentifyPrimaryBases(Base);
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000761 }
762}
763
Anders Carlsson81430692009-09-22 03:02:06 +0000764void
Anders Carlssonc2226202010-05-26 05:58:59 +0000765RecordLayoutBuilder::SelectPrimaryVBase(const CXXRecordDecl *RD) {
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000766 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000767 E = RD->bases_end(); I != E; ++I) {
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000768 assert(!I->getType()->isDependentType() &&
Sebastian Redl1054fae2009-10-25 17:03:50 +0000769 "Cannot layout class with dependent bases.");
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000770
Mike Stump11289f42009-09-09 15:08:12 +0000771 const CXXRecordDecl *Base =
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000772 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000773
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000774 // Check if this is a nearly empty virtual base.
775 if (I->isVirtual() && IsNearlyEmpty(Base)) {
776 // If it's not an indirect primary base, then we've found our primary
777 // base.
Anders Carlsson81430692009-09-22 03:02:06 +0000778 if (!IndirectPrimaryBases.count(Base)) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000779 PrimaryBase = Base;
780 PrimaryBaseIsVirtual = true;
Mike Stump6f3793b2009-08-12 21:50:08 +0000781 return;
782 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000783
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000784 // Is this the first nearly empty virtual base?
785 if (!FirstNearlyEmptyVBase)
786 FirstNearlyEmptyVBase = Base;
Mike Stump6f3793b2009-08-12 21:50:08 +0000787 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000788
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000789 SelectPrimaryVBase(Base);
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000790 if (PrimaryBase)
Zhongxing Xuec345b72010-02-15 04:28:35 +0000791 return;
Mike Stump6f3793b2009-08-12 21:50:08 +0000792 }
793}
794
Charles Davisc2c576a2010-08-19 00:55:19 +0000795uint64_t
796RecordLayoutBuilder::GetVirtualPointersSize(const CXXRecordDecl *RD) const {
797 return Context.Target.getPointerWidth(0);
798}
799
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000800/// DeterminePrimaryBase - Determine the primary base of the given class.
Anders Carlssonc2226202010-05-26 05:58:59 +0000801void RecordLayoutBuilder::DeterminePrimaryBase(const CXXRecordDecl *RD) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000802 // If the class isn't dynamic, it won't have a primary base.
803 if (!RD->isDynamicClass())
804 return;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000805
Anders Carlsson81430692009-09-22 03:02:06 +0000806 // Compute all the primary virtual bases for all of our direct and
Mike Stump590a7c72009-08-13 23:26:06 +0000807 // indirect bases, and record all their primary virtual base classes.
Mike Stump590a7c72009-08-13 23:26:06 +0000808 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000809 e = RD->bases_end(); i != e; ++i) {
Sebastian Redl1054fae2009-10-25 17:03:50 +0000810 assert(!i->getType()->isDependentType() &&
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000811 "Cannot lay out class with dependent bases.");
Mike Stump11289f42009-09-09 15:08:12 +0000812 const CXXRecordDecl *Base =
Mike Stump590a7c72009-08-13 23:26:06 +0000813 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson81430692009-09-22 03:02:06 +0000814 IdentifyPrimaryBases(Base);
Mike Stump590a7c72009-08-13 23:26:06 +0000815 }
816
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000817 // If the record has a dynamic base class, attempt to choose a primary base
818 // class. It is the first (in direct base class order) non-virtual dynamic
Anders Carlsson81430692009-09-22 03:02:06 +0000819 // base class, if one exists.
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000820 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000821 e = RD->bases_end(); i != e; ++i) {
Anders Carlsson03ff3792009-11-27 22:05:05 +0000822 // Ignore virtual bases.
823 if (i->isVirtual())
824 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000825
Anders Carlsson03ff3792009-11-27 22:05:05 +0000826 const CXXRecordDecl *Base =
827 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
828
829 if (Base->isDynamicClass()) {
830 // We found it.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000831 PrimaryBase = Base;
832 PrimaryBaseIsVirtual = false;
Anders Carlsson03ff3792009-11-27 22:05:05 +0000833 return;
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000834 }
835 }
836
837 // Otherwise, it is the first nearly empty virtual base that is not an
Mike Stump78696a72009-08-11 04:03:59 +0000838 // indirect primary virtual base class, if one exists.
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000839 if (RD->getNumVBases() != 0) {
840 SelectPrimaryVBase(RD);
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000841 if (PrimaryBase)
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000842 return;
843 }
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000844
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000845 // Otherwise, it is the first nearly empty virtual base that is not an
846 // indirect primary virtual base class, if one exists.
847 if (FirstNearlyEmptyVBase) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000848 PrimaryBase = FirstNearlyEmptyVBase;
849 PrimaryBaseIsVirtual = true;
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000850 return;
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000851 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000852
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000853 // Otherwise there is no primary base class.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000854 assert(!PrimaryBase && "Should not get here with a primary base!");
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000855
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000856 // Allocate the virtual table pointer at offset zero.
857 assert(DataSize == 0 && "Vtable pointer must be at offset zero!");
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000858
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000859 // Update the size.
Charles Davisc2c576a2010-08-19 00:55:19 +0000860 Size += GetVirtualPointersSize(RD);
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000861 DataSize = Size;
862
863 // Update the alignment.
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000864 UpdateAlignment(Context.Target.getPointerAlign(0));
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000865}
866
Anders Carlssone3c24c72010-05-29 17:35:14 +0000867BaseSubobjectInfo *
868RecordLayoutBuilder::ComputeBaseSubobjectInfo(const CXXRecordDecl *RD,
869 bool IsVirtual,
870 BaseSubobjectInfo *Derived) {
871 BaseSubobjectInfo *Info;
872
873 if (IsVirtual) {
874 // Check if we already have info about this virtual base.
875 BaseSubobjectInfo *&InfoSlot = VirtualBaseInfo[RD];
876 if (InfoSlot) {
877 assert(InfoSlot->Class == RD && "Wrong class for virtual base info!");
878 return InfoSlot;
879 }
880
881 // We don't, create it.
882 InfoSlot = new (BaseSubobjectInfoAllocator.Allocate()) BaseSubobjectInfo;
883 Info = InfoSlot;
884 } else {
885 Info = new (BaseSubobjectInfoAllocator.Allocate()) BaseSubobjectInfo;
886 }
887
888 Info->Class = RD;
889 Info->IsVirtual = IsVirtual;
890 Info->Derived = 0;
891 Info->PrimaryVirtualBaseInfo = 0;
892
893 const CXXRecordDecl *PrimaryVirtualBase = 0;
894 BaseSubobjectInfo *PrimaryVirtualBaseInfo = 0;
895
896 // Check if this base has a primary virtual base.
897 if (RD->getNumVBases()) {
898 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
899 if (Layout.getPrimaryBaseWasVirtual()) {
900 // This base does have a primary virtual base.
901 PrimaryVirtualBase = Layout.getPrimaryBase();
902 assert(PrimaryVirtualBase && "Didn't have a primary virtual base!");
903
904 // Now check if we have base subobject info about this primary base.
905 PrimaryVirtualBaseInfo = VirtualBaseInfo.lookup(PrimaryVirtualBase);
906
907 if (PrimaryVirtualBaseInfo) {
908 if (PrimaryVirtualBaseInfo->Derived) {
909 // We did have info about this primary base, and it turns out that it
910 // has already been claimed as a primary virtual base for another
911 // base.
912 PrimaryVirtualBase = 0;
913 } else {
914 // We can claim this base as our primary base.
915 Info->PrimaryVirtualBaseInfo = PrimaryVirtualBaseInfo;
916 PrimaryVirtualBaseInfo->Derived = Info;
917 }
918 }
919 }
920 }
921
922 // Now go through all direct bases.
923 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
924 E = RD->bases_end(); I != E; ++I) {
925 bool IsVirtual = I->isVirtual();
926
927 const CXXRecordDecl *BaseDecl =
928 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
929
930 Info->Bases.push_back(ComputeBaseSubobjectInfo(BaseDecl, IsVirtual, Info));
931 }
932
933 if (PrimaryVirtualBase && !PrimaryVirtualBaseInfo) {
934 // Traversing the bases must have created the base info for our primary
935 // virtual base.
936 PrimaryVirtualBaseInfo = VirtualBaseInfo.lookup(PrimaryVirtualBase);
937 assert(PrimaryVirtualBaseInfo &&
938 "Did not create a primary virtual base!");
939
940 // Claim the primary virtual base as our primary virtual base.
941 Info->PrimaryVirtualBaseInfo = PrimaryVirtualBaseInfo;
942 PrimaryVirtualBaseInfo->Derived = Info;
943 }
944
945 return Info;
946}
947
948void RecordLayoutBuilder::ComputeBaseSubobjectInfo(const CXXRecordDecl *RD) {
949 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
950 E = RD->bases_end(); I != E; ++I) {
951 bool IsVirtual = I->isVirtual();
952
953 const CXXRecordDecl *BaseDecl =
954 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
955
956 // Compute the base subobject info for this base.
957 BaseSubobjectInfo *Info = ComputeBaseSubobjectInfo(BaseDecl, IsVirtual, 0);
958
959 if (IsVirtual) {
960 // ComputeBaseInfo has already added this base for us.
961 assert(VirtualBaseInfo.count(BaseDecl) &&
962 "Did not add virtual base!");
963 } else {
964 // Add the base info to the map of non-virtual bases.
965 assert(!NonVirtualBaseInfo.count(BaseDecl) &&
966 "Non-virtual base already exists!");
967 NonVirtualBaseInfo.insert(std::make_pair(BaseDecl, Info));
968 }
969 }
970}
971
Anders Carlsson09ffa322010-03-10 22:21:28 +0000972void
Anders Carlssonc2226202010-05-26 05:58:59 +0000973RecordLayoutBuilder::LayoutNonVirtualBases(const CXXRecordDecl *RD) {
Anders Carlssone3c24c72010-05-29 17:35:14 +0000974 // Then, determine the primary base class.
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000975 DeterminePrimaryBase(RD);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000976
Anders Carlssone3c24c72010-05-29 17:35:14 +0000977 // Compute base subobject info.
978 ComputeBaseSubobjectInfo(RD);
979
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000980 // If we have a primary base class, lay it out.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000981 if (PrimaryBase) {
982 if (PrimaryBaseIsVirtual) {
Anders Carlssone3c24c72010-05-29 17:35:14 +0000983 // If the primary virtual base was a primary virtual base of some other
984 // base class we'll have to steal it.
985 BaseSubobjectInfo *PrimaryBaseInfo = VirtualBaseInfo.lookup(PrimaryBase);
986 PrimaryBaseInfo->Derived = 0;
987
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000988 // We have a virtual primary base, insert it as an indirect primary base.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000989 IndirectPrimaryBases.insert(PrimaryBase);
Anders Carlssonfe900962010-03-11 05:42:17 +0000990
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000991 assert(!VisitedVirtualBases.count(PrimaryBase) &&
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000992 "vbase already visited!");
993 VisitedVirtualBases.insert(PrimaryBase);
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000994
Anders Carlssond6ff5d72010-05-29 17:48:36 +0000995 LayoutVirtualBase(PrimaryBaseInfo);
Anders Carlssonbb0e6782010-05-29 17:42:25 +0000996 } else {
997 BaseSubobjectInfo *PrimaryBaseInfo =
998 NonVirtualBaseInfo.lookup(PrimaryBase);
999 assert(PrimaryBaseInfo &&
1000 "Did not find base info for non-virtual primary base!");
1001
1002 LayoutNonVirtualBase(PrimaryBaseInfo);
1003 }
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001004 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001005
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001006 // Now lay out the non-virtual bases.
1007 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001008 E = RD->bases_end(); I != E; ++I) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001009
1010 // Ignore virtual bases.
1011 if (I->isVirtual())
1012 continue;
1013
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001014 const CXXRecordDecl *BaseDecl =
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001015 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1016
1017 // Skip the primary base.
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001018 if (BaseDecl == PrimaryBase && !PrimaryBaseIsVirtual)
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001019 continue;
1020
1021 // Lay out the base.
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001022 BaseSubobjectInfo *BaseInfo = NonVirtualBaseInfo.lookup(BaseDecl);
1023 assert(BaseInfo && "Did not find base info for non-virtual base!");
1024
1025 LayoutNonVirtualBase(BaseInfo);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001026 }
1027}
1028
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001029void RecordLayoutBuilder::LayoutNonVirtualBase(const BaseSubobjectInfo *Base) {
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001030 // Layout the base.
Anders Carlssona2f8e412010-10-31 22:20:42 +00001031 CharUnits Offset = LayoutBase(Base);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001032
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001033 // Add its base class offset.
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001034 assert(!Bases.count(Base->Class) && "base offset already exists!");
Anders Carlssona2f8e412010-10-31 22:20:42 +00001035 Bases.insert(std::make_pair(Base->Class, Offset));
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001036
1037 AddPrimaryVirtualBaseOffsets(Base, Offset);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001038}
Mike Stump2b84dd32009-11-05 04:02:15 +00001039
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001040void
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001041RecordLayoutBuilder::AddPrimaryVirtualBaseOffsets(const BaseSubobjectInfo *Info,
Anders Carlssona2f8e412010-10-31 22:20:42 +00001042 CharUnits Offset) {
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001043 // This base isn't interesting, it has no virtual bases.
1044 if (!Info->Class->getNumVBases())
1045 return;
1046
1047 // First, check if we have a virtual primary base to add offsets for.
1048 if (Info->PrimaryVirtualBaseInfo) {
1049 assert(Info->PrimaryVirtualBaseInfo->IsVirtual &&
1050 "Primary virtual base is not virtual!");
1051 if (Info->PrimaryVirtualBaseInfo->Derived == Info) {
1052 // Add the offset.
1053 assert(!VBases.count(Info->PrimaryVirtualBaseInfo->Class) &&
1054 "primary vbase offset already exists!");
1055 VBases.insert(std::make_pair(Info->PrimaryVirtualBaseInfo->Class,
Anders Carlssona2f8e412010-10-31 22:20:42 +00001056 Offset));
Anders Carlssonea7b1822010-04-15 16:12:58 +00001057
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001058 // Traverse the primary virtual base.
1059 AddPrimaryVirtualBaseOffsets(Info->PrimaryVirtualBaseInfo, Offset);
1060 }
Anders Carlssonea7b1822010-04-15 16:12:58 +00001061 }
1062
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001063 // Now go through all direct non-virtual bases.
1064 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Info->Class);
1065 for (unsigned I = 0, E = Info->Bases.size(); I != E; ++I) {
1066 const BaseSubobjectInfo *Base = Info->Bases[I];
1067 if (Base->IsVirtual)
Anders Carlssonea7b1822010-04-15 16:12:58 +00001068 continue;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001069
Anders Carlssona2f8e412010-10-31 22:20:42 +00001070 CharUnits BaseOffset =
Anders Carlssonfd88a612010-10-31 23:22:37 +00001071 Offset + toCharUnits(Layout.getBaseClassOffsetInBits(Base->Class));
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001072 AddPrimaryVirtualBaseOffsets(Base, BaseOffset);
Anders Carlssonea7b1822010-04-15 16:12:58 +00001073 }
1074}
1075
1076void
Anders Carlssonc2226202010-05-26 05:58:59 +00001077RecordLayoutBuilder::LayoutVirtualBases(const CXXRecordDecl *RD,
Anders Carlssonea7b1822010-04-15 16:12:58 +00001078 const CXXRecordDecl *MostDerivedClass) {
Anders Carlssonde710c92010-03-11 04:33:54 +00001079 const CXXRecordDecl *PrimaryBase;
Anders Carlsson291279e2010-04-10 18:42:27 +00001080 bool PrimaryBaseIsVirtual;
Anders Carlssonfe900962010-03-11 05:42:17 +00001081
Anders Carlsson291279e2010-04-10 18:42:27 +00001082 if (MostDerivedClass == RD) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +00001083 PrimaryBase = this->PrimaryBase;
1084 PrimaryBaseIsVirtual = this->PrimaryBaseIsVirtual;
Anders Carlsson291279e2010-04-10 18:42:27 +00001085 } else {
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001086 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlssonde710c92010-03-11 04:33:54 +00001087 PrimaryBase = Layout.getPrimaryBase();
Anders Carlsson291279e2010-04-10 18:42:27 +00001088 PrimaryBaseIsVirtual = Layout.getPrimaryBaseWasVirtual();
1089 }
1090
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001091 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1092 E = RD->bases_end(); I != E; ++I) {
1093 assert(!I->getType()->isDependentType() &&
Sebastian Redl1054fae2009-10-25 17:03:50 +00001094 "Cannot layout class with dependent bases.");
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001095
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001096 const CXXRecordDecl *BaseDecl =
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001097 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1098
1099 if (I->isVirtual()) {
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001100 if (PrimaryBase != BaseDecl || !PrimaryBaseIsVirtual) {
1101 bool IndirectPrimaryBase = IndirectPrimaryBases.count(BaseDecl);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001102
Anders Carlsson291279e2010-04-10 18:42:27 +00001103 // Only lay out the virtual base if it's not an indirect primary base.
1104 if (!IndirectPrimaryBase) {
1105 // Only visit virtual bases once.
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001106 if (!VisitedVirtualBases.insert(BaseDecl))
Anders Carlsson291279e2010-04-10 18:42:27 +00001107 continue;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001108
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001109 const BaseSubobjectInfo *BaseInfo = VirtualBaseInfo.lookup(BaseDecl);
1110 assert(BaseInfo && "Did not find virtual base info!");
1111 LayoutVirtualBase(BaseInfo);
Anders Carlsson6a848892010-03-11 04:10:39 +00001112 }
Mike Stump2b84dd32009-11-05 04:02:15 +00001113 }
Mike Stumpc2f591b2009-08-13 22:53:07 +00001114 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001115
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001116 if (!BaseDecl->getNumVBases()) {
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001117 // This base isn't interesting since it doesn't have any virtual bases.
1118 continue;
Mike Stump996576f32009-08-16 19:04:13 +00001119 }
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001120
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001121 LayoutVirtualBases(BaseDecl, MostDerivedClass);
Mike Stump6b2556f2009-08-06 13:41:24 +00001122 }
1123}
1124
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001125void RecordLayoutBuilder::LayoutVirtualBase(const BaseSubobjectInfo *Base) {
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001126 assert(!Base->Derived && "Trying to lay out a primary virtual base!");
1127
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001128 // Layout the base.
Anders Carlssona2f8e412010-10-31 22:20:42 +00001129 CharUnits Offset = LayoutBase(Base);
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001130
1131 // Add its base class offset.
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001132 assert(!VBases.count(Base->Class) && "vbase offset already exists!");
Anders Carlssona2f8e412010-10-31 22:20:42 +00001133 VBases.insert(std::make_pair(Base->Class, Offset));
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001134
1135 AddPrimaryVirtualBaseOffsets(Base, Offset);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001136}
1137
Anders Carlssona2f8e412010-10-31 22:20:42 +00001138CharUnits RecordLayoutBuilder::LayoutBase(const BaseSubobjectInfo *Base) {
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001139 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Base->Class);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001140
1141 // If we have an empty base class, try to place it at offset 0.
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001142 if (Base->Class->isEmpty() &&
Anders Carlsson28466ab2010-10-31 22:13:23 +00001143 EmptySubobjects->CanPlaceBaseAtOffset(Base, CharUnits::Zero())) {
Anders Carlsson2357bfd2010-05-08 22:35:05 +00001144 Size = std::max(Size, Layout.getSize());
Anders Carlsson09ffa322010-03-10 22:21:28 +00001145
Anders Carlssona2f8e412010-10-31 22:20:42 +00001146 return CharUnits::Zero();
Anders Carlsson09ffa322010-03-10 22:21:28 +00001147 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001148
Anders Carlsson2357bfd2010-05-08 22:35:05 +00001149 unsigned BaseAlign = Layout.getNonVirtualAlign();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001150
Anders Carlsson09ffa322010-03-10 22:21:28 +00001151 // Round up the current record size to the base's alignment boundary.
1152 uint64_t Offset = llvm::RoundUpToAlignment(DataSize, BaseAlign);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001153
Anders Carlsson09ffa322010-03-10 22:21:28 +00001154 // Try to place the base.
Anders Carlsson28466ab2010-10-31 22:13:23 +00001155 while (!EmptySubobjects->CanPlaceBaseAtOffset(Base, toCharUnits(Offset)))
Anders Carlsson09ffa322010-03-10 22:21:28 +00001156 Offset += BaseAlign;
Anders Carlsson09ffa322010-03-10 22:21:28 +00001157
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001158 if (!Base->Class->isEmpty()) {
Anders Carlsson09ffa322010-03-10 22:21:28 +00001159 // Update the data size.
Anders Carlsson2357bfd2010-05-08 22:35:05 +00001160 DataSize = Offset + Layout.getNonVirtualSize();
Anders Carlsson09ffa322010-03-10 22:21:28 +00001161
1162 Size = std::max(Size, DataSize);
1163 } else
Anders Carlsson2357bfd2010-05-08 22:35:05 +00001164 Size = std::max(Size, Offset + Layout.getSize());
Anders Carlsson09ffa322010-03-10 22:21:28 +00001165
1166 // Remember max struct/class alignment.
1167 UpdateAlignment(BaseAlign);
1168
Anders Carlssona2f8e412010-10-31 22:20:42 +00001169 return toCharUnits(Offset);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001170}
1171
Daniel Dunbar6da10982010-05-27 05:45:51 +00001172void RecordLayoutBuilder::InitializeLayout(const Decl *D) {
1173 if (const RecordDecl *RD = dyn_cast<RecordDecl>(D))
1174 IsUnion = RD->isUnion();
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001175
Anders Carlsson28a5fa22009-08-08 19:38:24 +00001176 Packed = D->hasAttr<PackedAttr>();
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001177
Daniel Dunbar6da10982010-05-27 05:45:51 +00001178 // mac68k alignment supersedes maximum field alignment and attribute aligned,
1179 // and forces all structures to have 2-byte alignment. The IBM docs on it
1180 // allude to additional (more complicated) semantics, especially with regard
1181 // to bit-fields, but gcc appears not to follow that.
1182 if (D->hasAttr<AlignMac68kAttr>()) {
1183 IsMac68kAlign = true;
1184 MaxFieldAlignment = 2 * 8;
1185 Alignment = 2 * 8;
1186 } else {
1187 if (const MaxFieldAlignmentAttr *MFAA = D->getAttr<MaxFieldAlignmentAttr>())
1188 MaxFieldAlignment = MFAA->getAlignment();
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001189
Alexis Huntdcfba7b2010-08-18 23:23:40 +00001190 if (unsigned MaxAlign = D->getMaxAlignment())
1191 UpdateAlignment(MaxAlign);
Daniel Dunbar6da10982010-05-27 05:45:51 +00001192 }
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001193}
Anders Carlsson6d9f6f32009-07-19 00:18:47 +00001194
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001195void RecordLayoutBuilder::Layout(const RecordDecl *D) {
1196 InitializeLayout(D);
Anders Carlsson118ce162009-07-18 21:48:39 +00001197 LayoutFields(D);
Mike Stump11289f42009-09-09 15:08:12 +00001198
Anders Carlsson79474332009-07-18 20:20:21 +00001199 // Finally, round the size of the total struct up to the alignment of the
1200 // struct itself.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001201 FinishLayout(D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001202}
1203
1204void RecordLayoutBuilder::Layout(const CXXRecordDecl *RD) {
1205 InitializeLayout(RD);
1206
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001207 // Lay out the vtable and the non-virtual bases.
1208 LayoutNonVirtualBases(RD);
1209
1210 LayoutFields(RD);
1211
1212 NonVirtualSize = Size;
1213 NonVirtualAlignment = Alignment;
1214
1215 // Lay out the virtual bases and add the primary virtual base offsets.
1216 LayoutVirtualBases(RD, RD);
1217
1218 VisitedVirtualBases.clear();
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001219
1220 // Finally, round the size of the total struct up to the alignment of the
1221 // struct itself.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001222 FinishLayout(RD);
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001223
Anders Carlsson5b441d72010-04-10 21:24:48 +00001224#ifndef NDEBUG
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001225 // Check that we have base offsets for all bases.
1226 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1227 E = RD->bases_end(); I != E; ++I) {
1228 if (I->isVirtual())
1229 continue;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001230
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001231 const CXXRecordDecl *BaseDecl =
1232 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1233
1234 assert(Bases.count(BaseDecl) && "Did not find base offset!");
1235 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001236
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001237 // And all virtual bases.
1238 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
1239 E = RD->vbases_end(); I != E; ++I) {
1240 const CXXRecordDecl *BaseDecl =
1241 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001242
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001243 assert(VBases.count(BaseDecl) && "Did not find base offset!");
Anders Carlsson5b441d72010-04-10 21:24:48 +00001244 }
1245#endif
Anders Carlsson79474332009-07-18 20:20:21 +00001246}
1247
Anders Carlssonc2226202010-05-26 05:58:59 +00001248void RecordLayoutBuilder::Layout(const ObjCInterfaceDecl *D) {
Anders Carlsson4f516282009-07-18 20:50:59 +00001249 if (ObjCInterfaceDecl *SD = D->getSuperClass()) {
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001250 const ASTRecordLayout &SL = Context.getASTObjCInterfaceLayout(SD);
Anders Carlsson4f516282009-07-18 20:50:59 +00001251
1252 UpdateAlignment(SL.getAlignment());
Mike Stump11289f42009-09-09 15:08:12 +00001253
Anders Carlsson4f516282009-07-18 20:50:59 +00001254 // We start laying out ivars not at the end of the superclass
1255 // structure, but at the next byte following the last field.
Anders Carlsson27b50132009-07-18 21:26:44 +00001256 Size = llvm::RoundUpToAlignment(SL.getDataSize(), 8);
Anders Carlsson47680d82009-09-26 01:34:51 +00001257 DataSize = Size;
Anders Carlsson4f516282009-07-18 20:50:59 +00001258 }
Mike Stump11289f42009-09-09 15:08:12 +00001259
Daniel Dunbar6da10982010-05-27 05:45:51 +00001260 InitializeLayout(D);
Daniel Dunbar40130442010-05-27 01:12:46 +00001261
Anders Carlsson4f516282009-07-18 20:50:59 +00001262 // Layout each ivar sequentially.
1263 llvm::SmallVector<ObjCIvarDecl*, 16> Ivars;
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001264 Context.ShallowCollectObjCIvars(D, Ivars);
Anders Carlsson4f516282009-07-18 20:50:59 +00001265 for (unsigned i = 0, e = Ivars.size(); i != e; ++i)
1266 LayoutField(Ivars[i]);
Mike Stump11289f42009-09-09 15:08:12 +00001267
Anders Carlsson4f516282009-07-18 20:50:59 +00001268 // Finally, round the size of the total struct up to the alignment of the
1269 // struct itself.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001270 FinishLayout(D);
Anders Carlsson4f516282009-07-18 20:50:59 +00001271}
1272
Anders Carlssonc2226202010-05-26 05:58:59 +00001273void RecordLayoutBuilder::LayoutFields(const RecordDecl *D) {
Anders Carlsson118ce162009-07-18 21:48:39 +00001274 // Layout each field, for now, just sequentially, respecting alignment. In
1275 // the future, this will need to be tweakable by targets.
Mike Stump11289f42009-09-09 15:08:12 +00001276 for (RecordDecl::field_iterator Field = D->field_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001277 FieldEnd = D->field_end(); Field != FieldEnd; ++Field)
Anders Carlsson118ce162009-07-18 21:48:39 +00001278 LayoutField(*Field);
1279}
1280
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001281void RecordLayoutBuilder::LayoutWideBitField(uint64_t FieldSize,
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001282 uint64_t TypeSize,
1283 bool FieldPacked,
1284 const FieldDecl *D) {
Anders Carlsson57235162010-04-16 15:57:11 +00001285 assert(Context.getLangOptions().CPlusPlus &&
1286 "Can only have wide bit-fields in C++!");
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001287
Anders Carlsson57235162010-04-16 15:57:11 +00001288 // Itanium C++ ABI 2.4:
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001289 // If sizeof(T)*8 < n, let T' be the largest integral POD type with
Anders Carlsson57235162010-04-16 15:57:11 +00001290 // sizeof(T')*8 <= n.
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001291
Anders Carlsson57235162010-04-16 15:57:11 +00001292 QualType IntegralPODTypes[] = {
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001293 Context.UnsignedCharTy, Context.UnsignedShortTy, Context.UnsignedIntTy,
Anders Carlsson57235162010-04-16 15:57:11 +00001294 Context.UnsignedLongTy, Context.UnsignedLongLongTy
1295 };
1296
Anders Carlsson57235162010-04-16 15:57:11 +00001297 QualType Type;
1298 for (unsigned I = 0, E = llvm::array_lengthof(IntegralPODTypes);
1299 I != E; ++I) {
1300 uint64_t Size = Context.getTypeSize(IntegralPODTypes[I]);
Anders Carlsson57235162010-04-16 15:57:11 +00001301
1302 if (Size > FieldSize)
1303 break;
1304
1305 Type = IntegralPODTypes[I];
1306 }
1307 assert(!Type.isNull() && "Did not find a type!");
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001308
Anders Carlsson57235162010-04-16 15:57:11 +00001309 unsigned TypeAlign = Context.getTypeAlign(Type);
1310
1311 // We're not going to use any of the unfilled bits in the last byte.
1312 UnfilledBitsInLastByte = 0;
1313
Anders Carlssonaad5fa82010-04-17 20:21:41 +00001314 uint64_t FieldOffset;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001315 uint64_t UnpaddedFieldOffset = DataSize - UnfilledBitsInLastByte;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001316
Anders Carlsson57235162010-04-16 15:57:11 +00001317 if (IsUnion) {
1318 DataSize = std::max(DataSize, FieldSize);
Anders Carlssonaad5fa82010-04-17 20:21:41 +00001319 FieldOffset = 0;
Anders Carlsson57235162010-04-16 15:57:11 +00001320 } else {
Anders Carlssonaad5fa82010-04-17 20:21:41 +00001321 // The bitfield is allocated starting at the next offset aligned appropriately
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001322 // for T', with length n bits.
Anders Carlssonaad5fa82010-04-17 20:21:41 +00001323 FieldOffset = llvm::RoundUpToAlignment(DataSize, TypeAlign);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001324
Anders Carlsson57235162010-04-16 15:57:11 +00001325 uint64_t NewSizeInBits = FieldOffset + FieldSize;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001326
Anders Carlsson57235162010-04-16 15:57:11 +00001327 DataSize = llvm::RoundUpToAlignment(NewSizeInBits, 8);
1328 UnfilledBitsInLastByte = DataSize - NewSizeInBits;
1329 }
1330
1331 // Place this field at the current location.
1332 FieldOffsets.push_back(FieldOffset);
1333
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001334 CheckFieldPadding(FieldOffset, UnpaddedFieldOffset, FieldOffset,
1335 TypeAlign, FieldPacked, D);
1336
Anders Carlsson57235162010-04-16 15:57:11 +00001337 // Update the size.
1338 Size = std::max(Size, DataSize);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001339
Anders Carlsson57235162010-04-16 15:57:11 +00001340 // Remember max struct/class alignment.
1341 UpdateAlignment(TypeAlign);
1342}
1343
Anders Carlssonc2226202010-05-26 05:58:59 +00001344void RecordLayoutBuilder::LayoutBitField(const FieldDecl *D) {
Anders Carlsson07209442009-11-22 17:37:31 +00001345 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001346 uint64_t UnpaddedFieldOffset = DataSize - UnfilledBitsInLastByte;
1347 uint64_t FieldOffset = IsUnion ? 0 : UnpaddedFieldOffset;
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001348 uint64_t FieldSize = D->getBitWidth()->EvaluateAsInt(Context).getZExtValue();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001349
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001350 std::pair<uint64_t, unsigned> FieldInfo = Context.getTypeInfo(D->getType());
Anders Carlsson07209442009-11-22 17:37:31 +00001351 uint64_t TypeSize = FieldInfo.first;
1352 unsigned FieldAlign = FieldInfo.second;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001353
Anders Carlsson57235162010-04-16 15:57:11 +00001354 if (FieldSize > TypeSize) {
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001355 LayoutWideBitField(FieldSize, TypeSize, FieldPacked, D);
Anders Carlsson57235162010-04-16 15:57:11 +00001356 return;
1357 }
1358
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001359 // The align if the field is not packed. This is to check if the attribute
1360 // was unnecessary (-Wpacked).
1361 unsigned UnpackedFieldAlign = FieldAlign;
1362 uint64_t UnpackedFieldOffset = FieldOffset;
1363 if (!Context.Target.useBitFieldTypeAlignment())
1364 UnpackedFieldAlign = 1;
1365
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001366 if (FieldPacked || !Context.Target.useBitFieldTypeAlignment())
Anders Carlsson07209442009-11-22 17:37:31 +00001367 FieldAlign = 1;
Alexis Huntdcfba7b2010-08-18 23:23:40 +00001368 FieldAlign = std::max(FieldAlign, D->getMaxAlignment());
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001369 UnpackedFieldAlign = std::max(UnpackedFieldAlign, D->getMaxAlignment());
Anders Carlsson07209442009-11-22 17:37:31 +00001370
1371 // The maximum field alignment overrides the aligned attribute.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001372 if (MaxFieldAlignment) {
Anders Carlsson07209442009-11-22 17:37:31 +00001373 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001374 UnpackedFieldAlign = std::min(UnpackedFieldAlign, MaxFieldAlignment);
1375 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001376
Daniel Dunbar3d9289c2010-04-15 06:18:39 +00001377 // Check if we need to add padding to give the field the correct alignment.
Anders Carlsson07209442009-11-22 17:37:31 +00001378 if (FieldSize == 0 || (FieldOffset & (FieldAlign-1)) + FieldSize > TypeSize)
Daniel Dunbarf35e7652010-06-29 18:34:35 +00001379 FieldOffset = llvm::RoundUpToAlignment(FieldOffset, FieldAlign);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001380
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001381 if (FieldSize == 0 ||
1382 (UnpackedFieldOffset & (UnpackedFieldAlign-1)) + FieldSize > TypeSize)
1383 UnpackedFieldOffset = llvm::RoundUpToAlignment(UnpackedFieldOffset,
1384 UnpackedFieldAlign);
1385
Daniel Dunbar3d9289c2010-04-15 06:18:39 +00001386 // Padding members don't affect overall alignment.
Anders Carlsson07209442009-11-22 17:37:31 +00001387 if (!D->getIdentifier())
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001388 FieldAlign = UnpackedFieldAlign = 1;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001389
Anders Carlsson07209442009-11-22 17:37:31 +00001390 // Place this field at the current location.
1391 FieldOffsets.push_back(FieldOffset);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001392
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001393 CheckFieldPadding(FieldOffset, UnpaddedFieldOffset, UnpackedFieldOffset,
1394 UnpackedFieldAlign, FieldPacked, D);
1395
Anders Carlssonba958402009-11-22 19:13:51 +00001396 // Update DataSize to include the last byte containing (part of) the bitfield.
1397 if (IsUnion) {
1398 // FIXME: I think FieldSize should be TypeSize here.
1399 DataSize = std::max(DataSize, FieldSize);
1400 } else {
1401 uint64_t NewSizeInBits = FieldOffset + FieldSize;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001402
Anders Carlssonba958402009-11-22 19:13:51 +00001403 DataSize = llvm::RoundUpToAlignment(NewSizeInBits, 8);
1404 UnfilledBitsInLastByte = DataSize - NewSizeInBits;
1405 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001406
Anders Carlssonba958402009-11-22 19:13:51 +00001407 // Update the size.
1408 Size = std::max(Size, DataSize);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001409
Anders Carlsson07209442009-11-22 17:37:31 +00001410 // Remember max struct/class alignment.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001411 UpdateAlignment(FieldAlign, UnpackedFieldAlign);
Anders Carlsson07209442009-11-22 17:37:31 +00001412}
1413
Anders Carlssonc2226202010-05-26 05:58:59 +00001414void RecordLayoutBuilder::LayoutField(const FieldDecl *D) {
Anders Carlsson07209442009-11-22 17:37:31 +00001415 if (D->isBitField()) {
1416 LayoutBitField(D);
1417 return;
1418 }
1419
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001420 uint64_t UnpaddedFieldOffset = DataSize - UnfilledBitsInLastByte;
1421
Anders Carlssonba958402009-11-22 19:13:51 +00001422 // Reset the unfilled bits.
1423 UnfilledBitsInLastByte = 0;
1424
Anders Carlsson07209442009-11-22 17:37:31 +00001425 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Anders Carlsson47680d82009-09-26 01:34:51 +00001426 uint64_t FieldOffset = IsUnion ? 0 : DataSize;
Anders Carlsson79474332009-07-18 20:20:21 +00001427 uint64_t FieldSize;
1428 unsigned FieldAlign;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001429
Anders Carlsson07209442009-11-22 17:37:31 +00001430 if (D->getType()->isIncompleteArrayType()) {
1431 // This is a flexible array member; we can't directly
1432 // query getTypeInfo about these, so we figure it out here.
1433 // Flexible array members don't have any size, but they
1434 // have to be aligned appropriately for their element type.
1435 FieldSize = 0;
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001436 const ArrayType* ATy = Context.getAsArrayType(D->getType());
1437 FieldAlign = Context.getTypeAlign(ATy->getElementType());
Anders Carlsson07209442009-11-22 17:37:31 +00001438 } else if (const ReferenceType *RT = D->getType()->getAs<ReferenceType>()) {
1439 unsigned AS = RT->getPointeeType().getAddressSpace();
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001440 FieldSize = Context.Target.getPointerWidth(AS);
1441 FieldAlign = Context.Target.getPointerAlign(AS);
Anders Carlsson79474332009-07-18 20:20:21 +00001442 } else {
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001443 std::pair<uint64_t, unsigned> FieldInfo = Context.getTypeInfo(D->getType());
Anders Carlsson07209442009-11-22 17:37:31 +00001444 FieldSize = FieldInfo.first;
1445 FieldAlign = FieldInfo.second;
Anders Carlsson79474332009-07-18 20:20:21 +00001446 }
Mike Stump11289f42009-09-09 15:08:12 +00001447
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001448 // The align if the field is not packed. This is to check if the attribute
1449 // was unnecessary (-Wpacked).
1450 unsigned UnpackedFieldAlign = FieldAlign;
1451 uint64_t UnpackedFieldOffset = FieldOffset;
1452
Anders Carlsson07209442009-11-22 17:37:31 +00001453 if (FieldPacked)
1454 FieldAlign = 8;
Alexis Huntdcfba7b2010-08-18 23:23:40 +00001455 FieldAlign = std::max(FieldAlign, D->getMaxAlignment());
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001456 UnpackedFieldAlign = std::max(UnpackedFieldAlign, D->getMaxAlignment());
Anders Carlsson07209442009-11-22 17:37:31 +00001457
1458 // The maximum field alignment overrides the aligned attribute.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001459 if (MaxFieldAlignment) {
Anders Carlsson07209442009-11-22 17:37:31 +00001460 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001461 UnpackedFieldAlign = std::min(UnpackedFieldAlign, MaxFieldAlignment);
1462 }
Anders Carlsson07209442009-11-22 17:37:31 +00001463
1464 // Round up the current record size to the field's alignment boundary.
1465 FieldOffset = llvm::RoundUpToAlignment(FieldOffset, FieldAlign);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001466 UnpackedFieldOffset = llvm::RoundUpToAlignment(UnpackedFieldOffset,
1467 UnpackedFieldAlign);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001468
Anders Carlssonb1fcdd02010-05-30 06:52:33 +00001469 if (!IsUnion && EmptySubobjects) {
1470 // Check if we can place the field at this offset.
Anders Carlsson28466ab2010-10-31 22:13:23 +00001471 while (!EmptySubobjects->CanPlaceFieldAtOffset(D,
1472 toCharUnits(FieldOffset))) {
Anders Carlsson07209442009-11-22 17:37:31 +00001473 // We couldn't place the field at the offset. Try again at a new offset.
1474 FieldOffset += FieldAlign;
1475 }
Anders Carlsson07209442009-11-22 17:37:31 +00001476 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001477
Anders Carlsson79474332009-07-18 20:20:21 +00001478 // Place this field at the current location.
1479 FieldOffsets.push_back(FieldOffset);
Mike Stump11289f42009-09-09 15:08:12 +00001480
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001481 CheckFieldPadding(FieldOffset, UnpaddedFieldOffset, UnpackedFieldOffset,
1482 UnpackedFieldAlign, FieldPacked, D);
1483
Anders Carlsson79474332009-07-18 20:20:21 +00001484 // Reserve space for this field.
1485 if (IsUnion)
1486 Size = std::max(Size, FieldSize);
1487 else
1488 Size = FieldOffset + FieldSize;
Mike Stump11289f42009-09-09 15:08:12 +00001489
Anders Carlsson47680d82009-09-26 01:34:51 +00001490 // Update the data size.
1491 DataSize = Size;
Mike Stump11289f42009-09-09 15:08:12 +00001492
Anders Carlsson79474332009-07-18 20:20:21 +00001493 // Remember max struct/class alignment.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001494 UpdateAlignment(FieldAlign, UnpackedFieldAlign);
Anders Carlsson79474332009-07-18 20:20:21 +00001495}
1496
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001497void RecordLayoutBuilder::FinishLayout(const NamedDecl *D) {
Anders Carlsson79474332009-07-18 20:20:21 +00001498 // In C++, records cannot be of size 0.
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001499 if (Context.getLangOptions().CPlusPlus && Size == 0)
Anders Carlsson79474332009-07-18 20:20:21 +00001500 Size = 8;
1501 // Finally, round the size of the record up to the alignment of the
1502 // record itself.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001503 uint64_t UnpaddedSize = Size - UnfilledBitsInLastByte;
1504 uint64_t UnpackedSize = llvm::RoundUpToAlignment(Size, UnpackedAlignment);
Anders Carlsson07209442009-11-22 17:37:31 +00001505 Size = llvm::RoundUpToAlignment(Size, Alignment);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001506
1507 unsigned CharBitNum = Context.Target.getCharWidth();
1508 if (const RecordDecl *RD = dyn_cast<RecordDecl>(D)) {
1509 // Warn if padding was introduced to the struct/class/union.
1510 if (Size > UnpaddedSize) {
1511 unsigned PadSize = Size - UnpaddedSize;
1512 bool InBits = true;
1513 if (PadSize % CharBitNum == 0) {
1514 PadSize = PadSize / CharBitNum;
1515 InBits = false;
1516 }
1517 Diag(RD->getLocation(), diag::warn_padded_struct_size)
1518 << Context.getTypeDeclType(RD)
1519 << PadSize
1520 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1); // plural or not
1521 }
1522
1523 // Warn if we packed it unnecessarily. If the alignment is 1 byte don't
1524 // bother since there won't be alignment issues.
1525 if (Packed && UnpackedAlignment > CharBitNum && Size == UnpackedSize)
1526 Diag(D->getLocation(), diag::warn_unnecessary_packed)
1527 << Context.getTypeDeclType(RD);
1528 }
Anders Carlsson79474332009-07-18 20:20:21 +00001529}
1530
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001531void RecordLayoutBuilder::UpdateAlignment(unsigned NewAlignment,
1532 unsigned UnpackedNewAlignment) {
Daniel Dunbar6da10982010-05-27 05:45:51 +00001533 // The alignment is not modified when using 'mac68k' alignment.
1534 if (IsMac68kAlign)
1535 return;
1536
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001537 if (NewAlignment > Alignment) {
1538 assert(llvm::isPowerOf2_32(NewAlignment && "Alignment not a power of 2"));
1539 Alignment = NewAlignment;
1540 }
1541
1542 if (UnpackedNewAlignment > UnpackedAlignment) {
1543 assert(llvm::isPowerOf2_32(UnpackedNewAlignment &&
1544 "Alignment not a power of 2"));
1545 UnpackedAlignment = UnpackedNewAlignment;
1546 }
1547}
1548
1549void RecordLayoutBuilder::CheckFieldPadding(uint64_t Offset,
1550 uint64_t UnpaddedOffset,
1551 uint64_t UnpackedOffset,
1552 unsigned UnpackedAlign,
1553 bool isPacked,
1554 const FieldDecl *D) {
1555 // We let objc ivars without warning, objc interfaces generally are not used
1556 // for padding tricks.
1557 if (isa<ObjCIvarDecl>(D))
Anders Carlsson79474332009-07-18 20:20:21 +00001558 return;
Mike Stump11289f42009-09-09 15:08:12 +00001559
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001560 unsigned CharBitNum = Context.Target.getCharWidth();
Mike Stump11289f42009-09-09 15:08:12 +00001561
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001562 // Warn if padding was introduced to the struct/class.
1563 if (!IsUnion && Offset > UnpaddedOffset) {
1564 unsigned PadSize = Offset - UnpaddedOffset;
1565 bool InBits = true;
1566 if (PadSize % CharBitNum == 0) {
1567 PadSize = PadSize / CharBitNum;
1568 InBits = false;
1569 }
1570 if (D->getIdentifier())
1571 Diag(D->getLocation(), diag::warn_padded_struct_field)
1572 << (D->getParent()->isStruct() ? 0 : 1) // struct|class
1573 << Context.getTypeDeclType(D->getParent())
1574 << PadSize
1575 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1) // plural or not
1576 << D->getIdentifier();
1577 else
1578 Diag(D->getLocation(), diag::warn_padded_struct_anon_field)
1579 << (D->getParent()->isStruct() ? 0 : 1) // struct|class
1580 << Context.getTypeDeclType(D->getParent())
1581 << PadSize
1582 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1); // plural or not
1583 }
1584
1585 // Warn if we packed it unnecessarily. If the alignment is 1 byte don't
1586 // bother since there won't be alignment issues.
1587 if (isPacked && UnpackedAlign > CharBitNum && Offset == UnpackedOffset)
1588 Diag(D->getLocation(), diag::warn_unnecessary_packed)
1589 << D->getIdentifier();
Anders Carlsson79474332009-07-18 20:20:21 +00001590}
Mike Stump11289f42009-09-09 15:08:12 +00001591
Anders Carlsson5ebf8b42009-12-07 04:35:11 +00001592const CXXMethodDecl *
Anders Carlssonc2226202010-05-26 05:58:59 +00001593RecordLayoutBuilder::ComputeKeyFunction(const CXXRecordDecl *RD) {
Daniel Dunbarccabe482010-04-19 20:44:53 +00001594 // If a class isn't polymorphic it doesn't have a key function.
Anders Carlsson5ebf8b42009-12-07 04:35:11 +00001595 if (!RD->isPolymorphic())
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001596 return 0;
Eli Friedmanf2c79b62009-12-08 03:56:49 +00001597
1598 // A class inside an anonymous namespace doesn't have a key function. (Or
1599 // at least, there's no point to assigning a key function to such a class;
1600 // this doesn't affect the ABI.)
1601 if (RD->isInAnonymousNamespace())
1602 return 0;
1603
Argyrios Kyrtzidis8c64bbe2010-10-13 02:39:41 +00001604 // Template instantiations don't have key functions,see Itanium C++ ABI 5.2.6.
1605 // Same behavior as GCC.
1606 TemplateSpecializationKind TSK = RD->getTemplateSpecializationKind();
1607 if (TSK == TSK_ImplicitInstantiation ||
1608 TSK == TSK_ExplicitInstantiationDefinition)
1609 return 0;
1610
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001611 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
1612 E = RD->method_end(); I != E; ++I) {
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001613 const CXXMethodDecl *MD = *I;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001614
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001615 if (!MD->isVirtual())
1616 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001617
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001618 if (MD->isPure())
1619 continue;
Eli Friedmanf2c79b62009-12-08 03:56:49 +00001620
Anders Carlssonf98849e2009-12-02 17:15:43 +00001621 // Ignore implicit member functions, they are always marked as inline, but
1622 // they don't have a body until they're defined.
1623 if (MD->isImplicit())
1624 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001625
Douglas Gregora318efd2010-01-05 19:06:31 +00001626 if (MD->isInlineSpecified())
1627 continue;
Eli Friedman71a26d82009-12-06 20:50:05 +00001628
1629 if (MD->hasInlineBody())
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001630 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001631
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001632 // We found it.
1633 return MD;
1634 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001635
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001636 return 0;
1637}
1638
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001639DiagnosticBuilder
1640RecordLayoutBuilder::Diag(SourceLocation Loc, unsigned DiagID) {
1641 return Context.getDiagnostics().Report(
1642 FullSourceLoc(Loc, Context.getSourceManager()), DiagID);
1643}
1644
Benjamin Kramer2fc373e2010-10-22 16:33:16 +00001645namespace {
1646 // This class implements layout specific to the Microsoft ABI.
1647 class MSRecordLayoutBuilder : public RecordLayoutBuilder {
1648 public:
1649 MSRecordLayoutBuilder(ASTContext& Ctx, EmptySubobjectMap *EmptySubobjects) :
1650 RecordLayoutBuilder(Ctx, EmptySubobjects) {}
Charles Davisc2c576a2010-08-19 00:55:19 +00001651
Benjamin Kramer2fc373e2010-10-22 16:33:16 +00001652 virtual bool IsNearlyEmpty(const CXXRecordDecl *RD) const;
1653 virtual uint64_t GetVirtualPointersSize(const CXXRecordDecl *RD) const;
1654 };
1655}
Charles Davisc2c576a2010-08-19 00:55:19 +00001656
1657bool MSRecordLayoutBuilder::IsNearlyEmpty(const CXXRecordDecl *RD) const {
1658 // FIXME: Audit the corners
1659 if (!RD->isDynamicClass())
1660 return false;
1661 const ASTRecordLayout &BaseInfo = Context.getASTRecordLayout(RD);
1662 // In the Microsoft ABI, classes can have one or two vtable pointers.
1663 if (BaseInfo.getNonVirtualSize() == Context.Target.getPointerWidth(0) ||
1664 BaseInfo.getNonVirtualSize() == Context.Target.getPointerWidth(0) * 2)
1665 return true;
1666 return false;
1667}
1668
1669uint64_t
1670MSRecordLayoutBuilder::GetVirtualPointersSize(const CXXRecordDecl *RD) const {
1671 // We should reserve space for two pointers if the class has both
1672 // virtual functions and virtual bases.
1673 if (RD->isPolymorphic() && RD->getNumVBases() > 0)
1674 return 2 * Context.Target.getPointerWidth(0);
1675 return Context.Target.getPointerWidth(0);
1676}
1677
Anders Carlssondf291d82010-05-26 04:56:53 +00001678/// getASTRecordLayout - Get or compute information about the layout of the
1679/// specified record (struct/union/class), which indicates its size and field
1680/// position information.
1681const ASTRecordLayout &ASTContext::getASTRecordLayout(const RecordDecl *D) {
1682 D = D->getDefinition();
1683 assert(D && "Cannot get layout of forward declarations!");
1684
1685 // Look up this layout, if already laid out, return what we have.
1686 // Note that we can't save a reference to the entry because this function
1687 // is recursive.
1688 const ASTRecordLayout *Entry = ASTRecordLayouts[D];
1689 if (Entry) return *Entry;
1690
Anders Carlssond2954862010-05-26 05:10:47 +00001691 const ASTRecordLayout *NewEntry;
1692
1693 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
Anders Carlssonc121b4e2010-05-27 00:07:01 +00001694 EmptySubobjectMap EmptySubobjects(*this, RD);
Anders Carlsson439edd12010-05-27 05:41:06 +00001695
Charles Davisc2c576a2010-08-19 00:55:19 +00001696 // When compiling for Microsoft, use the special MS builder.
Argyrios Kyrtzidis3c6cd172010-08-25 00:32:14 +00001697 llvm::OwningPtr<RecordLayoutBuilder> Builder;
Charles Davis6bcb07a2010-08-19 02:18:14 +00001698 switch (Target.getCXXABI()) {
1699 default:
Argyrios Kyrtzidis3c6cd172010-08-25 00:32:14 +00001700 Builder.reset(new RecordLayoutBuilder(*this, &EmptySubobjects));
Charles Davis6bcb07a2010-08-19 02:18:14 +00001701 break;
1702 case CXXABI_Microsoft:
Argyrios Kyrtzidis3c6cd172010-08-25 00:32:14 +00001703 Builder.reset(new MSRecordLayoutBuilder(*this, &EmptySubobjects));
Charles Davis6bcb07a2010-08-19 02:18:14 +00001704 }
Charles Davisc2c576a2010-08-19 00:55:19 +00001705 Builder->Layout(RD);
Anders Carlssond2954862010-05-26 05:10:47 +00001706
1707 // FIXME: This is not always correct. See the part about bitfields at
1708 // http://www.codesourcery.com/public/cxx-abi/abi.html#POD for more info.
1709 // FIXME: IsPODForThePurposeOfLayout should be stored in the record layout.
1710 bool IsPODForThePurposeOfLayout = cast<CXXRecordDecl>(D)->isPOD();
1711
1712 // FIXME: This should be done in FinalizeLayout.
1713 uint64_t DataSize =
Charles Davisc2c576a2010-08-19 00:55:19 +00001714 IsPODForThePurposeOfLayout ? Builder->Size : Builder->DataSize;
Anders Carlssond2954862010-05-26 05:10:47 +00001715 uint64_t NonVirtualSize =
Charles Davisc2c576a2010-08-19 00:55:19 +00001716 IsPODForThePurposeOfLayout ? DataSize : Builder->NonVirtualSize;
Anders Carlssond2954862010-05-26 05:10:47 +00001717
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001718 NewEntry =
Charles Davisc2c576a2010-08-19 00:55:19 +00001719 new (*this) ASTRecordLayout(*this, Builder->Size, Builder->Alignment,
1720 DataSize, Builder->FieldOffsets.data(),
1721 Builder->FieldOffsets.size(),
Anders Carlssond2954862010-05-26 05:10:47 +00001722 NonVirtualSize,
Charles Davisc2c576a2010-08-19 00:55:19 +00001723 Builder->NonVirtualAlignment,
Anders Carlssonc121b4e2010-05-27 00:07:01 +00001724 EmptySubobjects.SizeOfLargestEmptySubobject,
Charles Davisc2c576a2010-08-19 00:55:19 +00001725 Builder->PrimaryBase,
1726 Builder->PrimaryBaseIsVirtual,
1727 Builder->Bases, Builder->VBases);
Anders Carlssond2954862010-05-26 05:10:47 +00001728 } else {
Anders Carlssonc121b4e2010-05-27 00:07:01 +00001729 RecordLayoutBuilder Builder(*this, /*EmptySubobjects=*/0);
Anders Carlssond2954862010-05-26 05:10:47 +00001730 Builder.Layout(D);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001731
Anders Carlssond2954862010-05-26 05:10:47 +00001732 NewEntry =
1733 new (*this) ASTRecordLayout(*this, Builder.Size, Builder.Alignment,
1734 Builder.Size,
1735 Builder.FieldOffsets.data(),
1736 Builder.FieldOffsets.size());
1737 }
1738
Anders Carlssondf291d82010-05-26 04:56:53 +00001739 ASTRecordLayouts[D] = NewEntry;
1740
1741 if (getLangOptions().DumpRecordLayouts) {
1742 llvm::errs() << "\n*** Dumping AST Record Layout\n";
1743 DumpRecordLayout(D, llvm::errs());
1744 }
1745
1746 return *NewEntry;
1747}
1748
1749const CXXMethodDecl *ASTContext::getKeyFunction(const CXXRecordDecl *RD) {
1750 RD = cast<CXXRecordDecl>(RD->getDefinition());
1751 assert(RD && "Cannot get key function for forward declarations!");
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001752
Anders Carlssondf291d82010-05-26 04:56:53 +00001753 const CXXMethodDecl *&Entry = KeyFunctions[RD];
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001754 if (!Entry)
Anders Carlssonc2226202010-05-26 05:58:59 +00001755 Entry = RecordLayoutBuilder::ComputeKeyFunction(RD);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001756
Anders Carlssondf291d82010-05-26 04:56:53 +00001757 return Entry;
1758}
1759
1760/// getInterfaceLayoutImpl - Get or compute information about the
1761/// layout of the given interface.
1762///
1763/// \param Impl - If given, also include the layout of the interface's
1764/// implementation. This may differ by including synthesized ivars.
1765const ASTRecordLayout &
1766ASTContext::getObjCLayout(const ObjCInterfaceDecl *D,
1767 const ObjCImplementationDecl *Impl) {
1768 assert(!D->isForwardDecl() && "Invalid interface decl!");
1769
1770 // Look up this layout, if already laid out, return what we have.
1771 ObjCContainerDecl *Key =
1772 Impl ? (ObjCContainerDecl*) Impl : (ObjCContainerDecl*) D;
1773 if (const ASTRecordLayout *Entry = ObjCLayouts[Key])
1774 return *Entry;
1775
1776 // Add in synthesized ivar count if laying out an implementation.
1777 if (Impl) {
1778 unsigned SynthCount = CountNonClassIvars(D);
1779 // If there aren't any sythesized ivars then reuse the interface
1780 // entry. Note we can't cache this because we simply free all
1781 // entries later; however we shouldn't look up implementations
1782 // frequently.
1783 if (SynthCount == 0)
1784 return getObjCLayout(D, 0);
1785 }
1786
Anders Carlssonc121b4e2010-05-27 00:07:01 +00001787 RecordLayoutBuilder Builder(*this, /*EmptySubobjects=*/0);
Anders Carlsson6ed3a9a2010-05-26 05:04:25 +00001788 Builder.Layout(D);
1789
Anders Carlssondf291d82010-05-26 04:56:53 +00001790 const ASTRecordLayout *NewEntry =
Anders Carlsson6ed3a9a2010-05-26 05:04:25 +00001791 new (*this) ASTRecordLayout(*this, Builder.Size, Builder.Alignment,
1792 Builder.DataSize,
1793 Builder.FieldOffsets.data(),
1794 Builder.FieldOffsets.size());
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001795
Anders Carlssondf291d82010-05-26 04:56:53 +00001796 ObjCLayouts[Key] = NewEntry;
1797
1798 return *NewEntry;
1799}
1800
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001801static void PrintOffset(llvm::raw_ostream &OS,
1802 uint64_t Offset, unsigned IndentLevel) {
1803 OS << llvm::format("%4d | ", Offset);
1804 OS.indent(IndentLevel * 2);
1805}
1806
1807static void DumpCXXRecordLayout(llvm::raw_ostream &OS,
1808 const CXXRecordDecl *RD, ASTContext &C,
1809 uint64_t Offset,
1810 unsigned IndentLevel,
1811 const char* Description,
1812 bool IncludeVirtualBases) {
1813 const ASTRecordLayout &Info = C.getASTRecordLayout(RD);
1814
1815 PrintOffset(OS, Offset, IndentLevel);
Dan Gohman145f3f12010-04-19 16:39:44 +00001816 OS << C.getTypeDeclType(const_cast<CXXRecordDecl *>(RD)).getAsString();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001817 if (Description)
1818 OS << ' ' << Description;
1819 if (RD->isEmpty())
1820 OS << " (empty)";
1821 OS << '\n';
1822
1823 IndentLevel++;
1824
1825 const CXXRecordDecl *PrimaryBase = Info.getPrimaryBase();
1826
1827 // Vtable pointer.
1828 if (RD->isDynamicClass() && !PrimaryBase) {
1829 PrintOffset(OS, Offset, IndentLevel);
Benjamin Kramerb11416d2010-04-17 09:33:03 +00001830 OS << '(' << RD << " vtable pointer)\n";
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001831 }
1832 // Dump (non-virtual) bases
1833 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1834 E = RD->bases_end(); I != E; ++I) {
1835 assert(!I->getType()->isDependentType() &&
1836 "Cannot layout class with dependent bases.");
1837 if (I->isVirtual())
1838 continue;
1839
1840 const CXXRecordDecl *Base =
1841 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1842
Anders Carlssonfd88a612010-10-31 23:22:37 +00001843 uint64_t BaseOffset = Offset + Info.getBaseClassOffsetInBits(Base) / 8;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001844
1845 DumpCXXRecordLayout(OS, Base, C, BaseOffset, IndentLevel,
1846 Base == PrimaryBase ? "(primary base)" : "(base)",
1847 /*IncludeVirtualBases=*/false);
1848 }
1849
1850 // Dump fields.
1851 uint64_t FieldNo = 0;
1852 for (CXXRecordDecl::field_iterator I = RD->field_begin(),
1853 E = RD->field_end(); I != E; ++I, ++FieldNo) {
1854 const FieldDecl *Field = *I;
1855 uint64_t FieldOffset = Offset + Info.getFieldOffset(FieldNo) / 8;
1856
1857 if (const RecordType *RT = Field->getType()->getAs<RecordType>()) {
1858 if (const CXXRecordDecl *D = dyn_cast<CXXRecordDecl>(RT->getDecl())) {
1859 DumpCXXRecordLayout(OS, D, C, FieldOffset, IndentLevel,
Daniel Dunbar56df9772010-08-17 22:39:59 +00001860 Field->getName().data(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001861 /*IncludeVirtualBases=*/true);
1862 continue;
1863 }
1864 }
1865
1866 PrintOffset(OS, FieldOffset, IndentLevel);
Benjamin Kramerb11416d2010-04-17 09:33:03 +00001867 OS << Field->getType().getAsString() << ' ' << Field << '\n';
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001868 }
1869
1870 if (!IncludeVirtualBases)
1871 return;
1872
1873 // Dump virtual bases.
1874 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
1875 E = RD->vbases_end(); I != E; ++I) {
1876 assert(I->isVirtual() && "Found non-virtual class!");
1877 const CXXRecordDecl *VBase =
1878 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1879
Anders Carlssonfd88a612010-10-31 23:22:37 +00001880 uint64_t VBaseOffset = Offset + Info.getVBaseClassOffsetInBits(VBase) / 8;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001881 DumpCXXRecordLayout(OS, VBase, C, VBaseOffset, IndentLevel,
1882 VBase == PrimaryBase ?
1883 "(primary virtual base)" : "(virtual base)",
1884 /*IncludeVirtualBases=*/false);
1885 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001886
1887 OS << " sizeof=" << Info.getSize() / 8;
1888 OS << ", dsize=" << Info.getDataSize() / 8;
1889 OS << ", align=" << Info.getAlignment() / 8 << '\n';
1890 OS << " nvsize=" << Info.getNonVirtualSize() / 8;
1891 OS << ", nvalign=" << Info.getNonVirtualAlign() / 8 << '\n';
1892 OS << '\n';
1893}
Daniel Dunbarccabe482010-04-19 20:44:53 +00001894
1895void ASTContext::DumpRecordLayout(const RecordDecl *RD,
1896 llvm::raw_ostream &OS) {
1897 const ASTRecordLayout &Info = getASTRecordLayout(RD);
1898
1899 if (const CXXRecordDecl *CXXRD = dyn_cast<CXXRecordDecl>(RD))
1900 return DumpCXXRecordLayout(OS, CXXRD, *this, 0, 0, 0,
1901 /*IncludeVirtualBases=*/true);
1902
1903 OS << "Type: " << getTypeDeclType(RD).getAsString() << "\n";
1904 OS << "Record: ";
1905 RD->dump();
1906 OS << "\nLayout: ";
1907 OS << "<ASTRecordLayout\n";
1908 OS << " Size:" << Info.getSize() << "\n";
1909 OS << " DataSize:" << Info.getDataSize() << "\n";
1910 OS << " Alignment:" << Info.getAlignment() << "\n";
1911 OS << " FieldOffsets: [";
1912 for (unsigned i = 0, e = Info.getFieldCount(); i != e; ++i) {
1913 if (i) OS << ", ";
1914 OS << Info.getFieldOffset(i);
1915 }
1916 OS << "]>\n";
1917}