blob: c878c25f416578e29c273d1248a5ab3a02dbd121 [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 Carlsson0a14ee92010-11-01 00:21:58 +0000247 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base->Class);
Anders Carlsson439edd12010-05-27 05:41:06 +0000248
249 if (!CanPlaceBaseSubobjectAtOffset(Base, BaseOffset))
250 return false;
251 }
252
Anders Carlssone3c24c72010-05-29 17:35:14 +0000253 if (Info->PrimaryVirtualBaseInfo) {
254 BaseSubobjectInfo *PrimaryVirtualBaseInfo = Info->PrimaryVirtualBaseInfo;
Anders Carlsson439edd12010-05-27 05:41:06 +0000255
256 if (Info == PrimaryVirtualBaseInfo->Derived) {
257 if (!CanPlaceBaseSubobjectAtOffset(PrimaryVirtualBaseInfo, Offset))
258 return false;
259 }
260 }
261
Anders Carlssondb319762010-05-27 18:20:57 +0000262 // Traverse all member variables.
263 unsigned FieldNo = 0;
264 for (CXXRecordDecl::field_iterator I = Info->Class->field_begin(),
265 E = Info->Class->field_end(); I != E; ++I, ++FieldNo) {
266 const FieldDecl *FD = *I;
Anders Carlsson233e2722010-10-31 21:54:55 +0000267 if (FD->isBitField())
268 continue;
269
Anders Carlsson28466ab2010-10-31 22:13:23 +0000270 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
Anders Carlssondb319762010-05-27 18:20:57 +0000271 if (!CanPlaceFieldSubobjectAtOffset(FD, FieldOffset))
272 return false;
273 }
274
Anders Carlsson439edd12010-05-27 05:41:06 +0000275 return true;
276}
277
Anders Carlssona7f3cdb2010-05-28 21:24:37 +0000278void EmptySubobjectMap::UpdateEmptyBaseSubobjects(const BaseSubobjectInfo *Info,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000279 CharUnits Offset,
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000280 bool PlacingEmptyBase) {
281 if (!PlacingEmptyBase && Offset >= SizeOfLargestEmptySubobject) {
282 // We know that the only empty subobjects that can conflict with empty
283 // subobject of non-empty bases, are empty bases that can be placed at
284 // offset zero. Because of this, we only need to keep track of empty base
285 // subobjects with offsets less than the size of the largest empty
286 // subobject for our class.
287 return;
288 }
289
Anders Carlsson28466ab2010-10-31 22:13:23 +0000290 AddSubobjectAtOffset(Info->Class, Offset);
Anders Carlssona7774a62010-05-29 21:10:24 +0000291
Anders Carlsson439edd12010-05-27 05:41:06 +0000292 // Traverse all non-virtual bases.
Anders Carlssona7774a62010-05-29 21:10:24 +0000293 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Info->Class);
Anders Carlsson439edd12010-05-27 05:41:06 +0000294 for (unsigned I = 0, E = Info->Bases.size(); I != E; ++I) {
Anders Carlssona7f3cdb2010-05-28 21:24:37 +0000295 BaseSubobjectInfo* Base = Info->Bases[I];
Anders Carlsson439edd12010-05-27 05:41:06 +0000296 if (Base->IsVirtual)
297 continue;
Anders Carlssona7774a62010-05-29 21:10:24 +0000298
Anders Carlsson0a14ee92010-11-01 00:21:58 +0000299 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base->Class);
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000300 UpdateEmptyBaseSubobjects(Base, BaseOffset, PlacingEmptyBase);
Anders Carlsson439edd12010-05-27 05:41:06 +0000301 }
302
Anders Carlssone3c24c72010-05-29 17:35:14 +0000303 if (Info->PrimaryVirtualBaseInfo) {
304 BaseSubobjectInfo *PrimaryVirtualBaseInfo = Info->PrimaryVirtualBaseInfo;
Anders Carlsson439edd12010-05-27 05:41:06 +0000305
306 if (Info == PrimaryVirtualBaseInfo->Derived)
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000307 UpdateEmptyBaseSubobjects(PrimaryVirtualBaseInfo, Offset,
308 PlacingEmptyBase);
Anders Carlsson439edd12010-05-27 05:41:06 +0000309 }
Anders Carlssondb319762010-05-27 18:20:57 +0000310
Anders Carlssondb319762010-05-27 18:20:57 +0000311 // Traverse all member variables.
312 unsigned FieldNo = 0;
313 for (CXXRecordDecl::field_iterator I = Info->Class->field_begin(),
314 E = Info->Class->field_end(); I != E; ++I, ++FieldNo) {
315 const FieldDecl *FD = *I;
Anders Carlsson233e2722010-10-31 21:54:55 +0000316 if (FD->isBitField())
317 continue;
Anders Carlssona7774a62010-05-29 21:10:24 +0000318
Anders Carlsson28466ab2010-10-31 22:13:23 +0000319 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
320 UpdateEmptyFieldSubobjects(FD, FieldOffset);
Anders Carlssondb319762010-05-27 18:20:57 +0000321 }
Anders Carlsson439edd12010-05-27 05:41:06 +0000322}
323
Anders Carlssona60b86a2010-05-29 20:49:49 +0000324bool EmptySubobjectMap::CanPlaceBaseAtOffset(const BaseSubobjectInfo *Info,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000325 CharUnits Offset) {
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000326 // If we know this class doesn't have any empty subobjects we don't need to
327 // bother checking.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000328 if (SizeOfLargestEmptySubobject.isZero())
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000329 return true;
330
Anders Carlsson439edd12010-05-27 05:41:06 +0000331 if (!CanPlaceBaseSubobjectAtOffset(Info, Offset))
332 return false;
Anders Carlssondb319762010-05-27 18:20:57 +0000333
334 // We are able to place the base at this offset. Make sure to update the
335 // empty base subobject map.
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000336 UpdateEmptyBaseSubobjects(Info, Offset, Info->Class->isEmpty());
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000337 return true;
338}
339
Anders Carlssondb319762010-05-27 18:20:57 +0000340bool
341EmptySubobjectMap::CanPlaceFieldSubobjectAtOffset(const CXXRecordDecl *RD,
342 const CXXRecordDecl *Class,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000343 CharUnits Offset) const {
Anders Carlsson45c1d282010-06-08 16:20:35 +0000344 // We don't have to keep looking past the maximum offset that's known to
345 // contain an empty class.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000346 if (!AnyEmptySubobjectsBeyondOffset(Offset))
Anders Carlsson45c1d282010-06-08 16:20:35 +0000347 return true;
348
Anders Carlsson28466ab2010-10-31 22:13:23 +0000349 if (!CanPlaceSubobjectAtOffset(RD, Offset))
Anders Carlssondb319762010-05-27 18:20:57 +0000350 return false;
351
352 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
353
354 // Traverse all non-virtual bases.
355 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
356 E = RD->bases_end(); I != E; ++I) {
357 if (I->isVirtual())
358 continue;
359
360 const CXXRecordDecl *BaseDecl =
361 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
362
Anders Carlsson0a14ee92010-11-01 00:21:58 +0000363 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(BaseDecl);
Anders Carlssondb319762010-05-27 18:20:57 +0000364 if (!CanPlaceFieldSubobjectAtOffset(BaseDecl, Class, BaseOffset))
365 return false;
366 }
367
Anders Carlsson44687202010-06-08 19:09:24 +0000368 if (RD == Class) {
369 // This is the most derived class, traverse virtual bases as well.
370 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
371 E = RD->vbases_end(); I != E; ++I) {
372 const CXXRecordDecl *VBaseDecl =
373 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
374
Anders Carlsson3f018712010-10-31 23:45:59 +0000375 CharUnits VBaseOffset = Offset + Layout.getVBaseClassOffset(VBaseDecl);
Anders Carlsson44687202010-06-08 19:09:24 +0000376 if (!CanPlaceFieldSubobjectAtOffset(VBaseDecl, Class, VBaseOffset))
377 return false;
378 }
379 }
380
Anders Carlssondb319762010-05-27 18:20:57 +0000381 // Traverse all member variables.
382 unsigned FieldNo = 0;
383 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
384 I != E; ++I, ++FieldNo) {
385 const FieldDecl *FD = *I;
Anders Carlsson233e2722010-10-31 21:54:55 +0000386 if (FD->isBitField())
387 continue;
388
Anders Carlsson28466ab2010-10-31 22:13:23 +0000389 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
Anders Carlssondb319762010-05-27 18:20:57 +0000390
391 if (!CanPlaceFieldSubobjectAtOffset(FD, FieldOffset))
392 return false;
393 }
394
395 return true;
396}
397
Anders Carlsson233e2722010-10-31 21:54:55 +0000398bool
399EmptySubobjectMap::CanPlaceFieldSubobjectAtOffset(const FieldDecl *FD,
400 CharUnits Offset) const {
Anders Carlsson45c1d282010-06-08 16:20:35 +0000401 // We don't have to keep looking past the maximum offset that's known to
402 // contain an empty class.
Anders Carlsson233e2722010-10-31 21:54:55 +0000403 if (!AnyEmptySubobjectsBeyondOffset(Offset))
Anders Carlsson45c1d282010-06-08 16:20:35 +0000404 return true;
405
Anders Carlssondb319762010-05-27 18:20:57 +0000406 QualType T = FD->getType();
407 if (const RecordType *RT = T->getAs<RecordType>()) {
408 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
Anders Carlsson28466ab2010-10-31 22:13:23 +0000409 return CanPlaceFieldSubobjectAtOffset(RD, RD, Offset);
Anders Carlssondb319762010-05-27 18:20:57 +0000410 }
411
412 // If we have an array type we need to look at every element.
413 if (const ConstantArrayType *AT = Context.getAsConstantArrayType(T)) {
414 QualType ElemTy = Context.getBaseElementType(AT);
415 const RecordType *RT = ElemTy->getAs<RecordType>();
416 if (!RT)
417 return true;
418
419 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
420 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
421
422 uint64_t NumElements = Context.getConstantArrayElementCount(AT);
Anders Carlsson233e2722010-10-31 21:54:55 +0000423 CharUnits ElementOffset = Offset;
Anders Carlssondb319762010-05-27 18:20:57 +0000424 for (uint64_t I = 0; I != NumElements; ++I) {
Anders Carlsson45c1d282010-06-08 16:20:35 +0000425 // We don't have to keep looking past the maximum offset that's known to
426 // contain an empty class.
Anders Carlsson233e2722010-10-31 21:54:55 +0000427 if (!AnyEmptySubobjectsBeyondOffset(ElementOffset))
Anders Carlsson45c1d282010-06-08 16:20:35 +0000428 return true;
429
Anders Carlsson28466ab2010-10-31 22:13:23 +0000430 if (!CanPlaceFieldSubobjectAtOffset(RD, RD, ElementOffset))
Anders Carlssondb319762010-05-27 18:20:57 +0000431 return false;
432
Anders Carlsson233e2722010-10-31 21:54:55 +0000433 ElementOffset += toCharUnits(Layout.getSize());
Anders Carlssondb319762010-05-27 18:20:57 +0000434 }
435 }
436
437 return true;
438}
439
440bool
Anders Carlsson28466ab2010-10-31 22:13:23 +0000441EmptySubobjectMap::CanPlaceFieldAtOffset(const FieldDecl *FD,
442 CharUnits Offset) {
443 if (!CanPlaceFieldSubobjectAtOffset(FD, Offset))
Anders Carlssondb319762010-05-27 18:20:57 +0000444 return false;
445
446 // We are able to place the member variable at this offset.
447 // Make sure to update the empty base subobject map.
448 UpdateEmptyFieldSubobjects(FD, Offset);
449 return true;
450}
451
452void EmptySubobjectMap::UpdateEmptyFieldSubobjects(const CXXRecordDecl *RD,
453 const CXXRecordDecl *Class,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000454 CharUnits Offset) {
Anders Carlssonae111dc2010-06-13 17:49:16 +0000455 // We know that the only empty subobjects that can conflict with empty
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000456 // field subobjects are subobjects of empty bases that can be placed at offset
Anders Carlssonae111dc2010-06-13 17:49:16 +0000457 // zero. Because of this, we only need to keep track of empty field
458 // subobjects with offsets less than the size of the largest empty
459 // subobject for our class.
460 if (Offset >= SizeOfLargestEmptySubobject)
461 return;
462
Anders Carlsson28466ab2010-10-31 22:13:23 +0000463 AddSubobjectAtOffset(RD, Offset);
Anders Carlssondb319762010-05-27 18:20:57 +0000464
465 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
466
467 // Traverse all non-virtual bases.
468 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
469 E = RD->bases_end(); I != E; ++I) {
470 if (I->isVirtual())
471 continue;
472
473 const CXXRecordDecl *BaseDecl =
474 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
475
Anders Carlsson0a14ee92010-11-01 00:21:58 +0000476 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(BaseDecl);
Anders Carlssondb319762010-05-27 18:20:57 +0000477 UpdateEmptyFieldSubobjects(BaseDecl, Class, BaseOffset);
478 }
479
Anders Carlsson44687202010-06-08 19:09:24 +0000480 if (RD == Class) {
481 // This is the most derived class, traverse virtual bases as well.
482 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
483 E = RD->vbases_end(); I != E; ++I) {
484 const CXXRecordDecl *VBaseDecl =
485 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
486
Anders Carlsson3f018712010-10-31 23:45:59 +0000487 CharUnits VBaseOffset = Offset + Layout.getVBaseClassOffset(VBaseDecl);
Anders Carlsson44687202010-06-08 19:09:24 +0000488 UpdateEmptyFieldSubobjects(VBaseDecl, Class, VBaseOffset);
489 }
490 }
491
Anders Carlssondb319762010-05-27 18:20:57 +0000492 // Traverse all member variables.
493 unsigned FieldNo = 0;
494 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
495 I != E; ++I, ++FieldNo) {
496 const FieldDecl *FD = *I;
497
Anders Carlsson28466ab2010-10-31 22:13:23 +0000498 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
Anders Carlssondb319762010-05-27 18:20:57 +0000499
Anders Carlsson28466ab2010-10-31 22:13:23 +0000500 UpdateEmptyFieldSubobjects(FD, FieldOffset);
Anders Carlssondb319762010-05-27 18:20:57 +0000501 }
502}
503
504void EmptySubobjectMap::UpdateEmptyFieldSubobjects(const FieldDecl *FD,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000505 CharUnits Offset) {
Anders Carlssondb319762010-05-27 18:20:57 +0000506 QualType T = FD->getType();
507 if (const RecordType *RT = T->getAs<RecordType>()) {
508 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
509 UpdateEmptyFieldSubobjects(RD, RD, Offset);
510 return;
511 }
512
513 // If we have an array type we need to update every element.
514 if (const ConstantArrayType *AT = Context.getAsConstantArrayType(T)) {
515 QualType ElemTy = Context.getBaseElementType(AT);
516 const RecordType *RT = ElemTy->getAs<RecordType>();
517 if (!RT)
518 return;
519
520 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
521 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
522
523 uint64_t NumElements = Context.getConstantArrayElementCount(AT);
Anders Carlsson28466ab2010-10-31 22:13:23 +0000524 CharUnits ElementOffset = Offset;
Anders Carlssondb319762010-05-27 18:20:57 +0000525
526 for (uint64_t I = 0; I != NumElements; ++I) {
Anders Carlssonae111dc2010-06-13 17:49:16 +0000527 // We know that the only empty subobjects that can conflict with empty
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000528 // field subobjects are subobjects of empty bases that can be placed at
Anders Carlssonae111dc2010-06-13 17:49:16 +0000529 // offset zero. Because of this, we only need to keep track of empty field
530 // subobjects with offsets less than the size of the largest empty
531 // subobject for our class.
532 if (ElementOffset >= SizeOfLargestEmptySubobject)
533 return;
534
Anders Carlssondb319762010-05-27 18:20:57 +0000535 UpdateEmptyFieldSubobjects(RD, RD, ElementOffset);
Anders Carlsson28466ab2010-10-31 22:13:23 +0000536 ElementOffset += toCharUnits(Layout.getSize());
Anders Carlssondb319762010-05-27 18:20:57 +0000537 }
538 }
539}
540
Anders Carlssonc2226202010-05-26 05:58:59 +0000541class RecordLayoutBuilder {
Charles Davisc2c576a2010-08-19 00:55:19 +0000542protected:
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000543 // FIXME: Remove this and make the appropriate fields public.
544 friend class clang::ASTContext;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000545
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000546 ASTContext &Context;
547
Anders Carlssonf58de112010-05-26 15:32:58 +0000548 EmptySubobjectMap *EmptySubobjects;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000549
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000550 /// Size - The current size of the record layout.
551 uint64_t Size;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000552
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000553 /// Alignment - The current alignment of the record layout.
554 unsigned Alignment;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000555
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000556 /// \brief The alignment if attribute packed is not used.
557 unsigned UnpackedAlignment;
558
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000559 llvm::SmallVector<uint64_t, 16> FieldOffsets;
560
561 /// Packed - Whether the record is packed or not.
Daniel Dunbar6da10982010-05-27 05:45:51 +0000562 unsigned Packed : 1;
563
564 unsigned IsUnion : 1;
565
566 unsigned IsMac68kAlign : 1;
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000567
568 /// UnfilledBitsInLastByte - If the last field laid out was a bitfield,
569 /// this contains the number of bits in the last byte that can be used for
570 /// an adjacent bitfield if necessary.
571 unsigned char UnfilledBitsInLastByte;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000572
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000573 /// MaxFieldAlignment - The maximum allowed field alignment. This is set by
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000574 /// #pragma pack.
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000575 unsigned MaxFieldAlignment;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000576
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000577 /// DataSize - The data size of the record being laid out.
578 uint64_t DataSize;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000579
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000580 uint64_t NonVirtualSize;
581 unsigned NonVirtualAlignment;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000582
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000583 /// PrimaryBase - the primary base class (if one exists) of the class
584 /// we're laying out.
585 const CXXRecordDecl *PrimaryBase;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000586
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000587 /// PrimaryBaseIsVirtual - Whether the primary base of the class we're laying
588 /// out is virtual.
589 bool PrimaryBaseIsVirtual;
590
Anders Carlsson22f57202010-10-31 21:01:46 +0000591 typedef llvm::DenseMap<const CXXRecordDecl *, CharUnits> BaseOffsetsMapTy;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000592
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000593 /// Bases - base classes and their offsets in the record.
594 BaseOffsetsMapTy Bases;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000595
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000596 // VBases - virtual base classes and their offsets in the record.
597 BaseOffsetsMapTy VBases;
598
599 /// IndirectPrimaryBases - Virtual base classes, direct or indirect, that are
600 /// primary base classes for some other direct or indirect base class.
601 llvm::SmallSet<const CXXRecordDecl*, 32> IndirectPrimaryBases;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000602
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000603 /// FirstNearlyEmptyVBase - The first nearly empty virtual base class in
604 /// inheritance graph order. Used for determining the primary base class.
605 const CXXRecordDecl *FirstNearlyEmptyVBase;
606
607 /// VisitedVirtualBases - A set of all the visited virtual bases, used to
608 /// avoid visiting virtual bases more than once.
609 llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBases;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000610
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000611 RecordLayoutBuilder(ASTContext &Context, EmptySubobjectMap *EmptySubobjects)
612 : Context(Context), EmptySubobjects(EmptySubobjects), Size(0), Alignment(8),
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000613 UnpackedAlignment(Alignment), Packed(false), IsUnion(false),
614 IsMac68kAlign(false), UnfilledBitsInLastByte(0), MaxFieldAlignment(0),
615 DataSize(0), NonVirtualSize(0), NonVirtualAlignment(8), PrimaryBase(0),
Daniel Dunbar6da10982010-05-27 05:45:51 +0000616 PrimaryBaseIsVirtual(false), FirstNearlyEmptyVBase(0) { }
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000617
Anders Carlsson725190f2010-10-31 21:39:24 +0000618 // FIXME: Remove these.
619 CharUnits toCharUnits(uint64_t Offset) const {
620 return CharUnits::fromQuantity(Offset / Context.getCharWidth());
621 }
622 uint64_t toOffset(CharUnits Offset) const {
623 return Offset.getQuantity() * Context.getCharWidth();
624 }
625
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000626 void Layout(const RecordDecl *D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000627 void Layout(const CXXRecordDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000628 void Layout(const ObjCInterfaceDecl *D);
629
630 void LayoutFields(const RecordDecl *D);
631 void LayoutField(const FieldDecl *D);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000632 void LayoutWideBitField(uint64_t FieldSize, uint64_t TypeSize,
633 bool FieldPacked, const FieldDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000634 void LayoutBitField(const FieldDecl *D);
635
Anders Carlssone3c24c72010-05-29 17:35:14 +0000636 /// BaseSubobjectInfoAllocator - Allocator for BaseSubobjectInfo objects.
637 llvm::SpecificBumpPtrAllocator<BaseSubobjectInfo> BaseSubobjectInfoAllocator;
638
639 typedef llvm::DenseMap<const CXXRecordDecl *, BaseSubobjectInfo *>
640 BaseSubobjectInfoMapTy;
641
642 /// VirtualBaseInfo - Map from all the (direct or indirect) virtual bases
643 /// of the class we're laying out to their base subobject info.
644 BaseSubobjectInfoMapTy VirtualBaseInfo;
645
646 /// NonVirtualBaseInfo - Map from all the direct non-virtual bases of the
647 /// class we're laying out to their base subobject info.
648 BaseSubobjectInfoMapTy NonVirtualBaseInfo;
649
650 /// ComputeBaseSubobjectInfo - Compute the base subobject information for the
651 /// bases of the given class.
652 void ComputeBaseSubobjectInfo(const CXXRecordDecl *RD);
653
654 /// ComputeBaseSubobjectInfo - Compute the base subobject information for a
655 /// single class and all of its base classes.
656 BaseSubobjectInfo *ComputeBaseSubobjectInfo(const CXXRecordDecl *RD,
657 bool IsVirtual,
658 BaseSubobjectInfo *Derived);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000659
660 /// DeterminePrimaryBase - Determine the primary base of the given class.
661 void DeterminePrimaryBase(const CXXRecordDecl *RD);
662
663 void SelectPrimaryVBase(const CXXRecordDecl *RD);
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000664
Charles Davisc2c576a2010-08-19 00:55:19 +0000665 virtual uint64_t GetVirtualPointersSize(const CXXRecordDecl *RD) const;
666
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000667 /// IdentifyPrimaryBases - Identify all virtual base classes, direct or
668 /// indirect, that are primary base classes for some other direct or indirect
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000669 /// base class.
670 void IdentifyPrimaryBases(const CXXRecordDecl *RD);
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000671
Charles Davisc2c576a2010-08-19 00:55:19 +0000672 virtual bool IsNearlyEmpty(const CXXRecordDecl *RD) const;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000673
674 /// LayoutNonVirtualBases - Determines the primary base class (if any) and
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000675 /// lays it out. Will then proceed to lay out all non-virtual base clasess.
676 void LayoutNonVirtualBases(const CXXRecordDecl *RD);
677
678 /// LayoutNonVirtualBase - Lays out a single non-virtual base.
Anders Carlssonbb0e6782010-05-29 17:42:25 +0000679 void LayoutNonVirtualBase(const BaseSubobjectInfo *Base);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000680
Anders Carlssona2f8e412010-10-31 22:20:42 +0000681 void AddPrimaryVirtualBaseOffsets(const BaseSubobjectInfo *Info,
682 CharUnits Offset);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000683
684 /// LayoutVirtualBases - Lays out all the virtual bases.
685 void LayoutVirtualBases(const CXXRecordDecl *RD,
686 const CXXRecordDecl *MostDerivedClass);
687
688 /// LayoutVirtualBase - Lays out a single virtual base.
Anders Carlssond6ff5d72010-05-29 17:48:36 +0000689 void LayoutVirtualBase(const BaseSubobjectInfo *Base);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000690
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000691 /// LayoutBase - Will lay out a base and return the offset where it was
Anders Carlssona2f8e412010-10-31 22:20:42 +0000692 /// placed, in chars.
693 CharUnits LayoutBase(const BaseSubobjectInfo *Base);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000694
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000695 /// InitializeLayout - Initialize record layout for the given record decl.
Daniel Dunbar6da10982010-05-27 05:45:51 +0000696 void InitializeLayout(const Decl *D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000697
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000698 /// FinishLayout - Finalize record layout. Adjust record size based on the
699 /// alignment.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000700 void FinishLayout(const NamedDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000701
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000702 void UpdateAlignment(unsigned NewAlignment, unsigned UnpackedNewAlignment);
703 void UpdateAlignment(unsigned NewAlignment) {
704 UpdateAlignment(NewAlignment, NewAlignment);
705 }
706
707 void CheckFieldPadding(uint64_t Offset, uint64_t UnpaddedOffset,
708 uint64_t UnpackedOffset, unsigned UnpackedAlign,
709 bool isPacked, const FieldDecl *D);
710
711 DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000712
Argyrios Kyrtzidis499e6e42010-08-15 10:17:39 +0000713 RecordLayoutBuilder(const RecordLayoutBuilder&); // DO NOT IMPLEMENT
714 void operator=(const RecordLayoutBuilder&); // DO NOT IMPLEMENT
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000715public:
716 static const CXXMethodDecl *ComputeKeyFunction(const CXXRecordDecl *RD);
Argyrios Kyrtzidis3c6cd172010-08-25 00:32:14 +0000717
718 virtual ~RecordLayoutBuilder() { }
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000719};
Benjamin Kramerc7656cd2010-05-26 09:58:31 +0000720} // end anonymous namespace
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000721
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000722/// IsNearlyEmpty - Indicates when a class has a vtable pointer, but
723/// no other data.
Anders Carlssonc2226202010-05-26 05:58:59 +0000724bool RecordLayoutBuilder::IsNearlyEmpty(const CXXRecordDecl *RD) const {
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000725 // FIXME: Audit the corners
726 if (!RD->isDynamicClass())
727 return false;
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000728 const ASTRecordLayout &BaseInfo = Context.getASTRecordLayout(RD);
729 if (BaseInfo.getNonVirtualSize() == Context.Target.getPointerWidth(0))
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000730 return true;
731 return false;
732}
733
Anders Carlssonc2226202010-05-26 05:58:59 +0000734void RecordLayoutBuilder::IdentifyPrimaryBases(const CXXRecordDecl *RD) {
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000735 const ASTRecordLayout::PrimaryBaseInfo &BaseInfo =
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000736 Context.getASTRecordLayout(RD).getPrimaryBaseInfo();
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000737
Anders Carlsson81430692009-09-22 03:02:06 +0000738 // If the record has a primary base class that is virtual, add it to the set
739 // of primary bases.
Anders Carlssona30c0d32009-11-27 22:14:40 +0000740 if (BaseInfo.isVirtual())
741 IndirectPrimaryBases.insert(BaseInfo.getBase());
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000742
Anders Carlsson81430692009-09-22 03:02:06 +0000743 // Now traverse all bases and find primary bases for them.
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000744 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000745 e = RD->bases_end(); i != e; ++i) {
Sebastian Redl1054fae2009-10-25 17:03:50 +0000746 assert(!i->getType()->isDependentType() &&
747 "Cannot layout class with dependent bases.");
Mike Stump11289f42009-09-09 15:08:12 +0000748 const CXXRecordDecl *Base =
Mike Stump78696a72009-08-11 04:03:59 +0000749 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000750
Mike Stump78696a72009-08-11 04:03:59 +0000751 // Only bases with virtual bases participate in computing the
752 // indirect primary virtual base classes.
Mike Stumpc2f591b2009-08-13 22:53:07 +0000753 if (Base->getNumVBases())
Anders Carlsson81430692009-09-22 03:02:06 +0000754 IdentifyPrimaryBases(Base);
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000755 }
756}
757
Anders Carlsson81430692009-09-22 03:02:06 +0000758void
Anders Carlssonc2226202010-05-26 05:58:59 +0000759RecordLayoutBuilder::SelectPrimaryVBase(const CXXRecordDecl *RD) {
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000760 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000761 E = RD->bases_end(); I != E; ++I) {
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000762 assert(!I->getType()->isDependentType() &&
Sebastian Redl1054fae2009-10-25 17:03:50 +0000763 "Cannot layout class with dependent bases.");
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000764
Mike Stump11289f42009-09-09 15:08:12 +0000765 const CXXRecordDecl *Base =
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000766 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000767
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000768 // Check if this is a nearly empty virtual base.
769 if (I->isVirtual() && IsNearlyEmpty(Base)) {
770 // If it's not an indirect primary base, then we've found our primary
771 // base.
Anders Carlsson81430692009-09-22 03:02:06 +0000772 if (!IndirectPrimaryBases.count(Base)) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000773 PrimaryBase = Base;
774 PrimaryBaseIsVirtual = true;
Mike Stump6f3793b2009-08-12 21:50:08 +0000775 return;
776 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000777
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000778 // Is this the first nearly empty virtual base?
779 if (!FirstNearlyEmptyVBase)
780 FirstNearlyEmptyVBase = Base;
Mike Stump6f3793b2009-08-12 21:50:08 +0000781 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000782
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000783 SelectPrimaryVBase(Base);
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000784 if (PrimaryBase)
Zhongxing Xuec345b72010-02-15 04:28:35 +0000785 return;
Mike Stump6f3793b2009-08-12 21:50:08 +0000786 }
787}
788
Charles Davisc2c576a2010-08-19 00:55:19 +0000789uint64_t
790RecordLayoutBuilder::GetVirtualPointersSize(const CXXRecordDecl *RD) const {
791 return Context.Target.getPointerWidth(0);
792}
793
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000794/// DeterminePrimaryBase - Determine the primary base of the given class.
Anders Carlssonc2226202010-05-26 05:58:59 +0000795void RecordLayoutBuilder::DeterminePrimaryBase(const CXXRecordDecl *RD) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000796 // If the class isn't dynamic, it won't have a primary base.
797 if (!RD->isDynamicClass())
798 return;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000799
Anders Carlsson81430692009-09-22 03:02:06 +0000800 // Compute all the primary virtual bases for all of our direct and
Mike Stump590a7c72009-08-13 23:26:06 +0000801 // indirect bases, and record all their primary virtual base classes.
Mike Stump590a7c72009-08-13 23:26:06 +0000802 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000803 e = RD->bases_end(); i != e; ++i) {
Sebastian Redl1054fae2009-10-25 17:03:50 +0000804 assert(!i->getType()->isDependentType() &&
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000805 "Cannot lay out class with dependent bases.");
Mike Stump11289f42009-09-09 15:08:12 +0000806 const CXXRecordDecl *Base =
Mike Stump590a7c72009-08-13 23:26:06 +0000807 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson81430692009-09-22 03:02:06 +0000808 IdentifyPrimaryBases(Base);
Mike Stump590a7c72009-08-13 23:26:06 +0000809 }
810
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000811 // If the record has a dynamic base class, attempt to choose a primary base
812 // class. It is the first (in direct base class order) non-virtual dynamic
Anders Carlsson81430692009-09-22 03:02:06 +0000813 // base class, if one exists.
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000814 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000815 e = RD->bases_end(); i != e; ++i) {
Anders Carlsson03ff3792009-11-27 22:05:05 +0000816 // Ignore virtual bases.
817 if (i->isVirtual())
818 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000819
Anders Carlsson03ff3792009-11-27 22:05:05 +0000820 const CXXRecordDecl *Base =
821 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
822
823 if (Base->isDynamicClass()) {
824 // We found it.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000825 PrimaryBase = Base;
826 PrimaryBaseIsVirtual = false;
Anders Carlsson03ff3792009-11-27 22:05:05 +0000827 return;
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000828 }
829 }
830
831 // Otherwise, it is the first nearly empty virtual base that is not an
Mike Stump78696a72009-08-11 04:03:59 +0000832 // indirect primary virtual base class, if one exists.
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000833 if (RD->getNumVBases() != 0) {
834 SelectPrimaryVBase(RD);
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000835 if (PrimaryBase)
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000836 return;
837 }
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000838
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000839 // Otherwise, it is the first nearly empty virtual base that is not an
840 // indirect primary virtual base class, if one exists.
841 if (FirstNearlyEmptyVBase) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000842 PrimaryBase = FirstNearlyEmptyVBase;
843 PrimaryBaseIsVirtual = true;
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000844 return;
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000845 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000846
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000847 // Otherwise there is no primary base class.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000848 assert(!PrimaryBase && "Should not get here with a primary base!");
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000849
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000850 // Allocate the virtual table pointer at offset zero.
851 assert(DataSize == 0 && "Vtable pointer must be at offset zero!");
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000852
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000853 // Update the size.
Charles Davisc2c576a2010-08-19 00:55:19 +0000854 Size += GetVirtualPointersSize(RD);
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000855 DataSize = Size;
856
857 // Update the alignment.
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000858 UpdateAlignment(Context.Target.getPointerAlign(0));
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000859}
860
Anders Carlssone3c24c72010-05-29 17:35:14 +0000861BaseSubobjectInfo *
862RecordLayoutBuilder::ComputeBaseSubobjectInfo(const CXXRecordDecl *RD,
863 bool IsVirtual,
864 BaseSubobjectInfo *Derived) {
865 BaseSubobjectInfo *Info;
866
867 if (IsVirtual) {
868 // Check if we already have info about this virtual base.
869 BaseSubobjectInfo *&InfoSlot = VirtualBaseInfo[RD];
870 if (InfoSlot) {
871 assert(InfoSlot->Class == RD && "Wrong class for virtual base info!");
872 return InfoSlot;
873 }
874
875 // We don't, create it.
876 InfoSlot = new (BaseSubobjectInfoAllocator.Allocate()) BaseSubobjectInfo;
877 Info = InfoSlot;
878 } else {
879 Info = new (BaseSubobjectInfoAllocator.Allocate()) BaseSubobjectInfo;
880 }
881
882 Info->Class = RD;
883 Info->IsVirtual = IsVirtual;
884 Info->Derived = 0;
885 Info->PrimaryVirtualBaseInfo = 0;
886
887 const CXXRecordDecl *PrimaryVirtualBase = 0;
888 BaseSubobjectInfo *PrimaryVirtualBaseInfo = 0;
889
890 // Check if this base has a primary virtual base.
891 if (RD->getNumVBases()) {
892 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
893 if (Layout.getPrimaryBaseWasVirtual()) {
894 // This base does have a primary virtual base.
895 PrimaryVirtualBase = Layout.getPrimaryBase();
896 assert(PrimaryVirtualBase && "Didn't have a primary virtual base!");
897
898 // Now check if we have base subobject info about this primary base.
899 PrimaryVirtualBaseInfo = VirtualBaseInfo.lookup(PrimaryVirtualBase);
900
901 if (PrimaryVirtualBaseInfo) {
902 if (PrimaryVirtualBaseInfo->Derived) {
903 // We did have info about this primary base, and it turns out that it
904 // has already been claimed as a primary virtual base for another
905 // base.
906 PrimaryVirtualBase = 0;
907 } else {
908 // We can claim this base as our primary base.
909 Info->PrimaryVirtualBaseInfo = PrimaryVirtualBaseInfo;
910 PrimaryVirtualBaseInfo->Derived = Info;
911 }
912 }
913 }
914 }
915
916 // Now go through all direct bases.
917 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
918 E = RD->bases_end(); I != E; ++I) {
919 bool IsVirtual = I->isVirtual();
920
921 const CXXRecordDecl *BaseDecl =
922 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
923
924 Info->Bases.push_back(ComputeBaseSubobjectInfo(BaseDecl, IsVirtual, Info));
925 }
926
927 if (PrimaryVirtualBase && !PrimaryVirtualBaseInfo) {
928 // Traversing the bases must have created the base info for our primary
929 // virtual base.
930 PrimaryVirtualBaseInfo = VirtualBaseInfo.lookup(PrimaryVirtualBase);
931 assert(PrimaryVirtualBaseInfo &&
932 "Did not create a primary virtual base!");
933
934 // Claim the primary virtual base as our primary virtual base.
935 Info->PrimaryVirtualBaseInfo = PrimaryVirtualBaseInfo;
936 PrimaryVirtualBaseInfo->Derived = Info;
937 }
938
939 return Info;
940}
941
942void RecordLayoutBuilder::ComputeBaseSubobjectInfo(const CXXRecordDecl *RD) {
943 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
944 E = RD->bases_end(); I != E; ++I) {
945 bool IsVirtual = I->isVirtual();
946
947 const CXXRecordDecl *BaseDecl =
948 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
949
950 // Compute the base subobject info for this base.
951 BaseSubobjectInfo *Info = ComputeBaseSubobjectInfo(BaseDecl, IsVirtual, 0);
952
953 if (IsVirtual) {
954 // ComputeBaseInfo has already added this base for us.
955 assert(VirtualBaseInfo.count(BaseDecl) &&
956 "Did not add virtual base!");
957 } else {
958 // Add the base info to the map of non-virtual bases.
959 assert(!NonVirtualBaseInfo.count(BaseDecl) &&
960 "Non-virtual base already exists!");
961 NonVirtualBaseInfo.insert(std::make_pair(BaseDecl, Info));
962 }
963 }
964}
965
Anders Carlsson09ffa322010-03-10 22:21:28 +0000966void
Anders Carlssonc2226202010-05-26 05:58:59 +0000967RecordLayoutBuilder::LayoutNonVirtualBases(const CXXRecordDecl *RD) {
Anders Carlssone3c24c72010-05-29 17:35:14 +0000968 // Then, determine the primary base class.
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000969 DeterminePrimaryBase(RD);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000970
Anders Carlssone3c24c72010-05-29 17:35:14 +0000971 // Compute base subobject info.
972 ComputeBaseSubobjectInfo(RD);
973
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000974 // If we have a primary base class, lay it out.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000975 if (PrimaryBase) {
976 if (PrimaryBaseIsVirtual) {
Anders Carlssone3c24c72010-05-29 17:35:14 +0000977 // If the primary virtual base was a primary virtual base of some other
978 // base class we'll have to steal it.
979 BaseSubobjectInfo *PrimaryBaseInfo = VirtualBaseInfo.lookup(PrimaryBase);
980 PrimaryBaseInfo->Derived = 0;
981
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000982 // We have a virtual primary base, insert it as an indirect primary base.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000983 IndirectPrimaryBases.insert(PrimaryBase);
Anders Carlssonfe900962010-03-11 05:42:17 +0000984
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000985 assert(!VisitedVirtualBases.count(PrimaryBase) &&
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000986 "vbase already visited!");
987 VisitedVirtualBases.insert(PrimaryBase);
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000988
Anders Carlssond6ff5d72010-05-29 17:48:36 +0000989 LayoutVirtualBase(PrimaryBaseInfo);
Anders Carlssonbb0e6782010-05-29 17:42:25 +0000990 } else {
991 BaseSubobjectInfo *PrimaryBaseInfo =
992 NonVirtualBaseInfo.lookup(PrimaryBase);
993 assert(PrimaryBaseInfo &&
994 "Did not find base info for non-virtual primary base!");
995
996 LayoutNonVirtualBase(PrimaryBaseInfo);
997 }
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000998 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000999
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001000 // Now lay out the non-virtual bases.
1001 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001002 E = RD->bases_end(); I != E; ++I) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001003
1004 // Ignore virtual bases.
1005 if (I->isVirtual())
1006 continue;
1007
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001008 const CXXRecordDecl *BaseDecl =
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001009 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1010
1011 // Skip the primary base.
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001012 if (BaseDecl == PrimaryBase && !PrimaryBaseIsVirtual)
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001013 continue;
1014
1015 // Lay out the base.
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001016 BaseSubobjectInfo *BaseInfo = NonVirtualBaseInfo.lookup(BaseDecl);
1017 assert(BaseInfo && "Did not find base info for non-virtual base!");
1018
1019 LayoutNonVirtualBase(BaseInfo);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001020 }
1021}
1022
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001023void RecordLayoutBuilder::LayoutNonVirtualBase(const BaseSubobjectInfo *Base) {
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001024 // Layout the base.
Anders Carlssona2f8e412010-10-31 22:20:42 +00001025 CharUnits Offset = LayoutBase(Base);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001026
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001027 // Add its base class offset.
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001028 assert(!Bases.count(Base->Class) && "base offset already exists!");
Anders Carlssona2f8e412010-10-31 22:20:42 +00001029 Bases.insert(std::make_pair(Base->Class, Offset));
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001030
1031 AddPrimaryVirtualBaseOffsets(Base, Offset);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001032}
Mike Stump2b84dd32009-11-05 04:02:15 +00001033
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001034void
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001035RecordLayoutBuilder::AddPrimaryVirtualBaseOffsets(const BaseSubobjectInfo *Info,
Anders Carlssona2f8e412010-10-31 22:20:42 +00001036 CharUnits Offset) {
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001037 // This base isn't interesting, it has no virtual bases.
1038 if (!Info->Class->getNumVBases())
1039 return;
1040
1041 // First, check if we have a virtual primary base to add offsets for.
1042 if (Info->PrimaryVirtualBaseInfo) {
1043 assert(Info->PrimaryVirtualBaseInfo->IsVirtual &&
1044 "Primary virtual base is not virtual!");
1045 if (Info->PrimaryVirtualBaseInfo->Derived == Info) {
1046 // Add the offset.
1047 assert(!VBases.count(Info->PrimaryVirtualBaseInfo->Class) &&
1048 "primary vbase offset already exists!");
1049 VBases.insert(std::make_pair(Info->PrimaryVirtualBaseInfo->Class,
Anders Carlssona2f8e412010-10-31 22:20:42 +00001050 Offset));
Anders Carlssonea7b1822010-04-15 16:12:58 +00001051
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001052 // Traverse the primary virtual base.
1053 AddPrimaryVirtualBaseOffsets(Info->PrimaryVirtualBaseInfo, Offset);
1054 }
Anders Carlssonea7b1822010-04-15 16:12:58 +00001055 }
1056
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001057 // Now go through all direct non-virtual bases.
1058 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Info->Class);
1059 for (unsigned I = 0, E = Info->Bases.size(); I != E; ++I) {
1060 const BaseSubobjectInfo *Base = Info->Bases[I];
1061 if (Base->IsVirtual)
Anders Carlssonea7b1822010-04-15 16:12:58 +00001062 continue;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001063
Anders Carlsson0a14ee92010-11-01 00:21:58 +00001064 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base->Class);
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001065 AddPrimaryVirtualBaseOffsets(Base, BaseOffset);
Anders Carlssonea7b1822010-04-15 16:12:58 +00001066 }
1067}
1068
1069void
Anders Carlssonc2226202010-05-26 05:58:59 +00001070RecordLayoutBuilder::LayoutVirtualBases(const CXXRecordDecl *RD,
Anders Carlssonea7b1822010-04-15 16:12:58 +00001071 const CXXRecordDecl *MostDerivedClass) {
Anders Carlssonde710c92010-03-11 04:33:54 +00001072 const CXXRecordDecl *PrimaryBase;
Anders Carlsson291279e2010-04-10 18:42:27 +00001073 bool PrimaryBaseIsVirtual;
Anders Carlssonfe900962010-03-11 05:42:17 +00001074
Anders Carlsson291279e2010-04-10 18:42:27 +00001075 if (MostDerivedClass == RD) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +00001076 PrimaryBase = this->PrimaryBase;
1077 PrimaryBaseIsVirtual = this->PrimaryBaseIsVirtual;
Anders Carlsson291279e2010-04-10 18:42:27 +00001078 } else {
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001079 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlssonde710c92010-03-11 04:33:54 +00001080 PrimaryBase = Layout.getPrimaryBase();
Anders Carlsson291279e2010-04-10 18:42:27 +00001081 PrimaryBaseIsVirtual = Layout.getPrimaryBaseWasVirtual();
1082 }
1083
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001084 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1085 E = RD->bases_end(); I != E; ++I) {
1086 assert(!I->getType()->isDependentType() &&
Sebastian Redl1054fae2009-10-25 17:03:50 +00001087 "Cannot layout class with dependent bases.");
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001088
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001089 const CXXRecordDecl *BaseDecl =
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001090 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1091
1092 if (I->isVirtual()) {
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001093 if (PrimaryBase != BaseDecl || !PrimaryBaseIsVirtual) {
1094 bool IndirectPrimaryBase = IndirectPrimaryBases.count(BaseDecl);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001095
Anders Carlsson291279e2010-04-10 18:42:27 +00001096 // Only lay out the virtual base if it's not an indirect primary base.
1097 if (!IndirectPrimaryBase) {
1098 // Only visit virtual bases once.
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001099 if (!VisitedVirtualBases.insert(BaseDecl))
Anders Carlsson291279e2010-04-10 18:42:27 +00001100 continue;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001101
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001102 const BaseSubobjectInfo *BaseInfo = VirtualBaseInfo.lookup(BaseDecl);
1103 assert(BaseInfo && "Did not find virtual base info!");
1104 LayoutVirtualBase(BaseInfo);
Anders Carlsson6a848892010-03-11 04:10:39 +00001105 }
Mike Stump2b84dd32009-11-05 04:02:15 +00001106 }
Mike Stumpc2f591b2009-08-13 22:53:07 +00001107 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001108
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001109 if (!BaseDecl->getNumVBases()) {
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001110 // This base isn't interesting since it doesn't have any virtual bases.
1111 continue;
Mike Stump996576f32009-08-16 19:04:13 +00001112 }
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001113
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001114 LayoutVirtualBases(BaseDecl, MostDerivedClass);
Mike Stump6b2556f2009-08-06 13:41:24 +00001115 }
1116}
1117
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001118void RecordLayoutBuilder::LayoutVirtualBase(const BaseSubobjectInfo *Base) {
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001119 assert(!Base->Derived && "Trying to lay out a primary virtual base!");
1120
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001121 // Layout the base.
Anders Carlssona2f8e412010-10-31 22:20:42 +00001122 CharUnits Offset = LayoutBase(Base);
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001123
1124 // Add its base class offset.
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001125 assert(!VBases.count(Base->Class) && "vbase offset already exists!");
Anders Carlssona2f8e412010-10-31 22:20:42 +00001126 VBases.insert(std::make_pair(Base->Class, Offset));
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001127
1128 AddPrimaryVirtualBaseOffsets(Base, Offset);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001129}
1130
Anders Carlssona2f8e412010-10-31 22:20:42 +00001131CharUnits RecordLayoutBuilder::LayoutBase(const BaseSubobjectInfo *Base) {
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001132 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Base->Class);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001133
1134 // If we have an empty base class, try to place it at offset 0.
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001135 if (Base->Class->isEmpty() &&
Anders Carlsson28466ab2010-10-31 22:13:23 +00001136 EmptySubobjects->CanPlaceBaseAtOffset(Base, CharUnits::Zero())) {
Anders Carlsson2357bfd2010-05-08 22:35:05 +00001137 Size = std::max(Size, Layout.getSize());
Anders Carlsson09ffa322010-03-10 22:21:28 +00001138
Anders Carlssona2f8e412010-10-31 22:20:42 +00001139 return CharUnits::Zero();
Anders Carlsson09ffa322010-03-10 22:21:28 +00001140 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001141
Anders Carlsson2357bfd2010-05-08 22:35:05 +00001142 unsigned BaseAlign = Layout.getNonVirtualAlign();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001143
Anders Carlsson09ffa322010-03-10 22:21:28 +00001144 // Round up the current record size to the base's alignment boundary.
1145 uint64_t Offset = llvm::RoundUpToAlignment(DataSize, BaseAlign);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001146
Anders Carlsson09ffa322010-03-10 22:21:28 +00001147 // Try to place the base.
Anders Carlsson28466ab2010-10-31 22:13:23 +00001148 while (!EmptySubobjects->CanPlaceBaseAtOffset(Base, toCharUnits(Offset)))
Anders Carlsson09ffa322010-03-10 22:21:28 +00001149 Offset += BaseAlign;
Anders Carlsson09ffa322010-03-10 22:21:28 +00001150
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001151 if (!Base->Class->isEmpty()) {
Anders Carlsson09ffa322010-03-10 22:21:28 +00001152 // Update the data size.
Anders Carlsson2357bfd2010-05-08 22:35:05 +00001153 DataSize = Offset + Layout.getNonVirtualSize();
Anders Carlsson09ffa322010-03-10 22:21:28 +00001154
1155 Size = std::max(Size, DataSize);
1156 } else
Anders Carlsson2357bfd2010-05-08 22:35:05 +00001157 Size = std::max(Size, Offset + Layout.getSize());
Anders Carlsson09ffa322010-03-10 22:21:28 +00001158
1159 // Remember max struct/class alignment.
1160 UpdateAlignment(BaseAlign);
1161
Anders Carlssona2f8e412010-10-31 22:20:42 +00001162 return toCharUnits(Offset);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001163}
1164
Daniel Dunbar6da10982010-05-27 05:45:51 +00001165void RecordLayoutBuilder::InitializeLayout(const Decl *D) {
1166 if (const RecordDecl *RD = dyn_cast<RecordDecl>(D))
1167 IsUnion = RD->isUnion();
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001168
Anders Carlsson28a5fa22009-08-08 19:38:24 +00001169 Packed = D->hasAttr<PackedAttr>();
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001170
Daniel Dunbar6da10982010-05-27 05:45:51 +00001171 // mac68k alignment supersedes maximum field alignment and attribute aligned,
1172 // and forces all structures to have 2-byte alignment. The IBM docs on it
1173 // allude to additional (more complicated) semantics, especially with regard
1174 // to bit-fields, but gcc appears not to follow that.
1175 if (D->hasAttr<AlignMac68kAttr>()) {
1176 IsMac68kAlign = true;
1177 MaxFieldAlignment = 2 * 8;
1178 Alignment = 2 * 8;
1179 } else {
1180 if (const MaxFieldAlignmentAttr *MFAA = D->getAttr<MaxFieldAlignmentAttr>())
1181 MaxFieldAlignment = MFAA->getAlignment();
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001182
Alexis Huntdcfba7b2010-08-18 23:23:40 +00001183 if (unsigned MaxAlign = D->getMaxAlignment())
1184 UpdateAlignment(MaxAlign);
Daniel Dunbar6da10982010-05-27 05:45:51 +00001185 }
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001186}
Anders Carlsson6d9f6f32009-07-19 00:18:47 +00001187
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001188void RecordLayoutBuilder::Layout(const RecordDecl *D) {
1189 InitializeLayout(D);
Anders Carlsson118ce162009-07-18 21:48:39 +00001190 LayoutFields(D);
Mike Stump11289f42009-09-09 15:08:12 +00001191
Anders Carlsson79474332009-07-18 20:20:21 +00001192 // Finally, round the size of the total struct up to the alignment of the
1193 // struct itself.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001194 FinishLayout(D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001195}
1196
1197void RecordLayoutBuilder::Layout(const CXXRecordDecl *RD) {
1198 InitializeLayout(RD);
1199
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001200 // Lay out the vtable and the non-virtual bases.
1201 LayoutNonVirtualBases(RD);
1202
1203 LayoutFields(RD);
1204
1205 NonVirtualSize = Size;
1206 NonVirtualAlignment = Alignment;
1207
1208 // Lay out the virtual bases and add the primary virtual base offsets.
1209 LayoutVirtualBases(RD, RD);
1210
1211 VisitedVirtualBases.clear();
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001212
1213 // Finally, round the size of the total struct up to the alignment of the
1214 // struct itself.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001215 FinishLayout(RD);
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001216
Anders Carlsson5b441d72010-04-10 21:24:48 +00001217#ifndef NDEBUG
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001218 // Check that we have base offsets for all bases.
1219 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1220 E = RD->bases_end(); I != E; ++I) {
1221 if (I->isVirtual())
1222 continue;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001223
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001224 const CXXRecordDecl *BaseDecl =
1225 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1226
1227 assert(Bases.count(BaseDecl) && "Did not find base offset!");
1228 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001229
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001230 // And all virtual bases.
1231 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
1232 E = RD->vbases_end(); I != E; ++I) {
1233 const CXXRecordDecl *BaseDecl =
1234 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001235
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001236 assert(VBases.count(BaseDecl) && "Did not find base offset!");
Anders Carlsson5b441d72010-04-10 21:24:48 +00001237 }
1238#endif
Anders Carlsson79474332009-07-18 20:20:21 +00001239}
1240
Anders Carlssonc2226202010-05-26 05:58:59 +00001241void RecordLayoutBuilder::Layout(const ObjCInterfaceDecl *D) {
Anders Carlsson4f516282009-07-18 20:50:59 +00001242 if (ObjCInterfaceDecl *SD = D->getSuperClass()) {
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001243 const ASTRecordLayout &SL = Context.getASTObjCInterfaceLayout(SD);
Anders Carlsson4f516282009-07-18 20:50:59 +00001244
1245 UpdateAlignment(SL.getAlignment());
Mike Stump11289f42009-09-09 15:08:12 +00001246
Anders Carlsson4f516282009-07-18 20:50:59 +00001247 // We start laying out ivars not at the end of the superclass
1248 // structure, but at the next byte following the last field.
Anders Carlsson27b50132009-07-18 21:26:44 +00001249 Size = llvm::RoundUpToAlignment(SL.getDataSize(), 8);
Anders Carlsson47680d82009-09-26 01:34:51 +00001250 DataSize = Size;
Anders Carlsson4f516282009-07-18 20:50:59 +00001251 }
Mike Stump11289f42009-09-09 15:08:12 +00001252
Daniel Dunbar6da10982010-05-27 05:45:51 +00001253 InitializeLayout(D);
Daniel Dunbar40130442010-05-27 01:12:46 +00001254
Anders Carlsson4f516282009-07-18 20:50:59 +00001255 // Layout each ivar sequentially.
1256 llvm::SmallVector<ObjCIvarDecl*, 16> Ivars;
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001257 Context.ShallowCollectObjCIvars(D, Ivars);
Anders Carlsson4f516282009-07-18 20:50:59 +00001258 for (unsigned i = 0, e = Ivars.size(); i != e; ++i)
1259 LayoutField(Ivars[i]);
Mike Stump11289f42009-09-09 15:08:12 +00001260
Anders Carlsson4f516282009-07-18 20:50:59 +00001261 // Finally, round the size of the total struct up to the alignment of the
1262 // struct itself.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001263 FinishLayout(D);
Anders Carlsson4f516282009-07-18 20:50:59 +00001264}
1265
Anders Carlssonc2226202010-05-26 05:58:59 +00001266void RecordLayoutBuilder::LayoutFields(const RecordDecl *D) {
Anders Carlsson118ce162009-07-18 21:48:39 +00001267 // Layout each field, for now, just sequentially, respecting alignment. In
1268 // the future, this will need to be tweakable by targets.
Mike Stump11289f42009-09-09 15:08:12 +00001269 for (RecordDecl::field_iterator Field = D->field_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001270 FieldEnd = D->field_end(); Field != FieldEnd; ++Field)
Anders Carlsson118ce162009-07-18 21:48:39 +00001271 LayoutField(*Field);
1272}
1273
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001274void RecordLayoutBuilder::LayoutWideBitField(uint64_t FieldSize,
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001275 uint64_t TypeSize,
1276 bool FieldPacked,
1277 const FieldDecl *D) {
Anders Carlsson57235162010-04-16 15:57:11 +00001278 assert(Context.getLangOptions().CPlusPlus &&
1279 "Can only have wide bit-fields in C++!");
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001280
Anders Carlsson57235162010-04-16 15:57:11 +00001281 // Itanium C++ ABI 2.4:
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001282 // If sizeof(T)*8 < n, let T' be the largest integral POD type with
Anders Carlsson57235162010-04-16 15:57:11 +00001283 // sizeof(T')*8 <= n.
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001284
Anders Carlsson57235162010-04-16 15:57:11 +00001285 QualType IntegralPODTypes[] = {
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001286 Context.UnsignedCharTy, Context.UnsignedShortTy, Context.UnsignedIntTy,
Anders Carlsson57235162010-04-16 15:57:11 +00001287 Context.UnsignedLongTy, Context.UnsignedLongLongTy
1288 };
1289
Anders Carlsson57235162010-04-16 15:57:11 +00001290 QualType Type;
1291 for (unsigned I = 0, E = llvm::array_lengthof(IntegralPODTypes);
1292 I != E; ++I) {
1293 uint64_t Size = Context.getTypeSize(IntegralPODTypes[I]);
Anders Carlsson57235162010-04-16 15:57:11 +00001294
1295 if (Size > FieldSize)
1296 break;
1297
1298 Type = IntegralPODTypes[I];
1299 }
1300 assert(!Type.isNull() && "Did not find a type!");
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001301
Anders Carlsson57235162010-04-16 15:57:11 +00001302 unsigned TypeAlign = Context.getTypeAlign(Type);
1303
1304 // We're not going to use any of the unfilled bits in the last byte.
1305 UnfilledBitsInLastByte = 0;
1306
Anders Carlssonaad5fa82010-04-17 20:21:41 +00001307 uint64_t FieldOffset;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001308 uint64_t UnpaddedFieldOffset = DataSize - UnfilledBitsInLastByte;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001309
Anders Carlsson57235162010-04-16 15:57:11 +00001310 if (IsUnion) {
1311 DataSize = std::max(DataSize, FieldSize);
Anders Carlssonaad5fa82010-04-17 20:21:41 +00001312 FieldOffset = 0;
Anders Carlsson57235162010-04-16 15:57:11 +00001313 } else {
Anders Carlssonaad5fa82010-04-17 20:21:41 +00001314 // The bitfield is allocated starting at the next offset aligned appropriately
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001315 // for T', with length n bits.
Anders Carlssonaad5fa82010-04-17 20:21:41 +00001316 FieldOffset = llvm::RoundUpToAlignment(DataSize, TypeAlign);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001317
Anders Carlsson57235162010-04-16 15:57:11 +00001318 uint64_t NewSizeInBits = FieldOffset + FieldSize;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001319
Anders Carlsson57235162010-04-16 15:57:11 +00001320 DataSize = llvm::RoundUpToAlignment(NewSizeInBits, 8);
1321 UnfilledBitsInLastByte = DataSize - NewSizeInBits;
1322 }
1323
1324 // Place this field at the current location.
1325 FieldOffsets.push_back(FieldOffset);
1326
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001327 CheckFieldPadding(FieldOffset, UnpaddedFieldOffset, FieldOffset,
1328 TypeAlign, FieldPacked, D);
1329
Anders Carlsson57235162010-04-16 15:57:11 +00001330 // Update the size.
1331 Size = std::max(Size, DataSize);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001332
Anders Carlsson57235162010-04-16 15:57:11 +00001333 // Remember max struct/class alignment.
1334 UpdateAlignment(TypeAlign);
1335}
1336
Anders Carlssonc2226202010-05-26 05:58:59 +00001337void RecordLayoutBuilder::LayoutBitField(const FieldDecl *D) {
Anders Carlsson07209442009-11-22 17:37:31 +00001338 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001339 uint64_t UnpaddedFieldOffset = DataSize - UnfilledBitsInLastByte;
1340 uint64_t FieldOffset = IsUnion ? 0 : UnpaddedFieldOffset;
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001341 uint64_t FieldSize = D->getBitWidth()->EvaluateAsInt(Context).getZExtValue();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001342
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001343 std::pair<uint64_t, unsigned> FieldInfo = Context.getTypeInfo(D->getType());
Anders Carlsson07209442009-11-22 17:37:31 +00001344 uint64_t TypeSize = FieldInfo.first;
1345 unsigned FieldAlign = FieldInfo.second;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001346
Anders Carlsson57235162010-04-16 15:57:11 +00001347 if (FieldSize > TypeSize) {
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001348 LayoutWideBitField(FieldSize, TypeSize, FieldPacked, D);
Anders Carlsson57235162010-04-16 15:57:11 +00001349 return;
1350 }
1351
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001352 // The align if the field is not packed. This is to check if the attribute
1353 // was unnecessary (-Wpacked).
1354 unsigned UnpackedFieldAlign = FieldAlign;
1355 uint64_t UnpackedFieldOffset = FieldOffset;
1356 if (!Context.Target.useBitFieldTypeAlignment())
1357 UnpackedFieldAlign = 1;
1358
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001359 if (FieldPacked || !Context.Target.useBitFieldTypeAlignment())
Anders Carlsson07209442009-11-22 17:37:31 +00001360 FieldAlign = 1;
Alexis Huntdcfba7b2010-08-18 23:23:40 +00001361 FieldAlign = std::max(FieldAlign, D->getMaxAlignment());
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001362 UnpackedFieldAlign = std::max(UnpackedFieldAlign, D->getMaxAlignment());
Anders Carlsson07209442009-11-22 17:37:31 +00001363
1364 // The maximum field alignment overrides the aligned attribute.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001365 if (MaxFieldAlignment) {
Anders Carlsson07209442009-11-22 17:37:31 +00001366 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001367 UnpackedFieldAlign = std::min(UnpackedFieldAlign, MaxFieldAlignment);
1368 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001369
Daniel Dunbar3d9289c2010-04-15 06:18:39 +00001370 // Check if we need to add padding to give the field the correct alignment.
Anders Carlsson07209442009-11-22 17:37:31 +00001371 if (FieldSize == 0 || (FieldOffset & (FieldAlign-1)) + FieldSize > TypeSize)
Daniel Dunbarf35e7652010-06-29 18:34:35 +00001372 FieldOffset = llvm::RoundUpToAlignment(FieldOffset, FieldAlign);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001373
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001374 if (FieldSize == 0 ||
1375 (UnpackedFieldOffset & (UnpackedFieldAlign-1)) + FieldSize > TypeSize)
1376 UnpackedFieldOffset = llvm::RoundUpToAlignment(UnpackedFieldOffset,
1377 UnpackedFieldAlign);
1378
Daniel Dunbar3d9289c2010-04-15 06:18:39 +00001379 // Padding members don't affect overall alignment.
Anders Carlsson07209442009-11-22 17:37:31 +00001380 if (!D->getIdentifier())
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001381 FieldAlign = UnpackedFieldAlign = 1;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001382
Anders Carlsson07209442009-11-22 17:37:31 +00001383 // Place this field at the current location.
1384 FieldOffsets.push_back(FieldOffset);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001385
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001386 CheckFieldPadding(FieldOffset, UnpaddedFieldOffset, UnpackedFieldOffset,
1387 UnpackedFieldAlign, FieldPacked, D);
1388
Anders Carlssonba958402009-11-22 19:13:51 +00001389 // Update DataSize to include the last byte containing (part of) the bitfield.
1390 if (IsUnion) {
1391 // FIXME: I think FieldSize should be TypeSize here.
1392 DataSize = std::max(DataSize, FieldSize);
1393 } else {
1394 uint64_t NewSizeInBits = FieldOffset + FieldSize;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001395
Anders Carlssonba958402009-11-22 19:13:51 +00001396 DataSize = llvm::RoundUpToAlignment(NewSizeInBits, 8);
1397 UnfilledBitsInLastByte = DataSize - NewSizeInBits;
1398 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001399
Anders Carlssonba958402009-11-22 19:13:51 +00001400 // Update the size.
1401 Size = std::max(Size, DataSize);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001402
Anders Carlsson07209442009-11-22 17:37:31 +00001403 // Remember max struct/class alignment.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001404 UpdateAlignment(FieldAlign, UnpackedFieldAlign);
Anders Carlsson07209442009-11-22 17:37:31 +00001405}
1406
Anders Carlssonc2226202010-05-26 05:58:59 +00001407void RecordLayoutBuilder::LayoutField(const FieldDecl *D) {
Anders Carlsson07209442009-11-22 17:37:31 +00001408 if (D->isBitField()) {
1409 LayoutBitField(D);
1410 return;
1411 }
1412
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001413 uint64_t UnpaddedFieldOffset = DataSize - UnfilledBitsInLastByte;
1414
Anders Carlssonba958402009-11-22 19:13:51 +00001415 // Reset the unfilled bits.
1416 UnfilledBitsInLastByte = 0;
1417
Anders Carlsson07209442009-11-22 17:37:31 +00001418 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Anders Carlsson47680d82009-09-26 01:34:51 +00001419 uint64_t FieldOffset = IsUnion ? 0 : DataSize;
Anders Carlsson79474332009-07-18 20:20:21 +00001420 uint64_t FieldSize;
1421 unsigned FieldAlign;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001422
Anders Carlsson07209442009-11-22 17:37:31 +00001423 if (D->getType()->isIncompleteArrayType()) {
1424 // This is a flexible array member; we can't directly
1425 // query getTypeInfo about these, so we figure it out here.
1426 // Flexible array members don't have any size, but they
1427 // have to be aligned appropriately for their element type.
1428 FieldSize = 0;
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001429 const ArrayType* ATy = Context.getAsArrayType(D->getType());
1430 FieldAlign = Context.getTypeAlign(ATy->getElementType());
Anders Carlsson07209442009-11-22 17:37:31 +00001431 } else if (const ReferenceType *RT = D->getType()->getAs<ReferenceType>()) {
1432 unsigned AS = RT->getPointeeType().getAddressSpace();
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001433 FieldSize = Context.Target.getPointerWidth(AS);
1434 FieldAlign = Context.Target.getPointerAlign(AS);
Anders Carlsson79474332009-07-18 20:20:21 +00001435 } else {
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001436 std::pair<uint64_t, unsigned> FieldInfo = Context.getTypeInfo(D->getType());
Anders Carlsson07209442009-11-22 17:37:31 +00001437 FieldSize = FieldInfo.first;
1438 FieldAlign = FieldInfo.second;
Anders Carlsson79474332009-07-18 20:20:21 +00001439 }
Mike Stump11289f42009-09-09 15:08:12 +00001440
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001441 // The align if the field is not packed. This is to check if the attribute
1442 // was unnecessary (-Wpacked).
1443 unsigned UnpackedFieldAlign = FieldAlign;
1444 uint64_t UnpackedFieldOffset = FieldOffset;
1445
Anders Carlsson07209442009-11-22 17:37:31 +00001446 if (FieldPacked)
1447 FieldAlign = 8;
Alexis Huntdcfba7b2010-08-18 23:23:40 +00001448 FieldAlign = std::max(FieldAlign, D->getMaxAlignment());
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001449 UnpackedFieldAlign = std::max(UnpackedFieldAlign, D->getMaxAlignment());
Anders Carlsson07209442009-11-22 17:37:31 +00001450
1451 // The maximum field alignment overrides the aligned attribute.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001452 if (MaxFieldAlignment) {
Anders Carlsson07209442009-11-22 17:37:31 +00001453 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001454 UnpackedFieldAlign = std::min(UnpackedFieldAlign, MaxFieldAlignment);
1455 }
Anders Carlsson07209442009-11-22 17:37:31 +00001456
1457 // Round up the current record size to the field's alignment boundary.
1458 FieldOffset = llvm::RoundUpToAlignment(FieldOffset, FieldAlign);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001459 UnpackedFieldOffset = llvm::RoundUpToAlignment(UnpackedFieldOffset,
1460 UnpackedFieldAlign);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001461
Anders Carlssonb1fcdd02010-05-30 06:52:33 +00001462 if (!IsUnion && EmptySubobjects) {
1463 // Check if we can place the field at this offset.
Anders Carlsson28466ab2010-10-31 22:13:23 +00001464 while (!EmptySubobjects->CanPlaceFieldAtOffset(D,
1465 toCharUnits(FieldOffset))) {
Anders Carlsson07209442009-11-22 17:37:31 +00001466 // We couldn't place the field at the offset. Try again at a new offset.
1467 FieldOffset += FieldAlign;
1468 }
Anders Carlsson07209442009-11-22 17:37:31 +00001469 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001470
Anders Carlsson79474332009-07-18 20:20:21 +00001471 // Place this field at the current location.
1472 FieldOffsets.push_back(FieldOffset);
Mike Stump11289f42009-09-09 15:08:12 +00001473
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001474 CheckFieldPadding(FieldOffset, UnpaddedFieldOffset, UnpackedFieldOffset,
1475 UnpackedFieldAlign, FieldPacked, D);
1476
Anders Carlsson79474332009-07-18 20:20:21 +00001477 // Reserve space for this field.
1478 if (IsUnion)
1479 Size = std::max(Size, FieldSize);
1480 else
1481 Size = FieldOffset + FieldSize;
Mike Stump11289f42009-09-09 15:08:12 +00001482
Anders Carlsson47680d82009-09-26 01:34:51 +00001483 // Update the data size.
1484 DataSize = Size;
Mike Stump11289f42009-09-09 15:08:12 +00001485
Anders Carlsson79474332009-07-18 20:20:21 +00001486 // Remember max struct/class alignment.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001487 UpdateAlignment(FieldAlign, UnpackedFieldAlign);
Anders Carlsson79474332009-07-18 20:20:21 +00001488}
1489
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001490void RecordLayoutBuilder::FinishLayout(const NamedDecl *D) {
Anders Carlsson79474332009-07-18 20:20:21 +00001491 // In C++, records cannot be of size 0.
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001492 if (Context.getLangOptions().CPlusPlus && Size == 0)
Anders Carlsson79474332009-07-18 20:20:21 +00001493 Size = 8;
1494 // Finally, round the size of the record up to the alignment of the
1495 // record itself.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001496 uint64_t UnpaddedSize = Size - UnfilledBitsInLastByte;
1497 uint64_t UnpackedSize = llvm::RoundUpToAlignment(Size, UnpackedAlignment);
Anders Carlsson07209442009-11-22 17:37:31 +00001498 Size = llvm::RoundUpToAlignment(Size, Alignment);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001499
1500 unsigned CharBitNum = Context.Target.getCharWidth();
1501 if (const RecordDecl *RD = dyn_cast<RecordDecl>(D)) {
1502 // Warn if padding was introduced to the struct/class/union.
1503 if (Size > UnpaddedSize) {
1504 unsigned PadSize = Size - UnpaddedSize;
1505 bool InBits = true;
1506 if (PadSize % CharBitNum == 0) {
1507 PadSize = PadSize / CharBitNum;
1508 InBits = false;
1509 }
1510 Diag(RD->getLocation(), diag::warn_padded_struct_size)
1511 << Context.getTypeDeclType(RD)
1512 << PadSize
1513 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1); // plural or not
1514 }
1515
1516 // Warn if we packed it unnecessarily. If the alignment is 1 byte don't
1517 // bother since there won't be alignment issues.
1518 if (Packed && UnpackedAlignment > CharBitNum && Size == UnpackedSize)
1519 Diag(D->getLocation(), diag::warn_unnecessary_packed)
1520 << Context.getTypeDeclType(RD);
1521 }
Anders Carlsson79474332009-07-18 20:20:21 +00001522}
1523
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001524void RecordLayoutBuilder::UpdateAlignment(unsigned NewAlignment,
1525 unsigned UnpackedNewAlignment) {
Daniel Dunbar6da10982010-05-27 05:45:51 +00001526 // The alignment is not modified when using 'mac68k' alignment.
1527 if (IsMac68kAlign)
1528 return;
1529
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001530 if (NewAlignment > Alignment) {
1531 assert(llvm::isPowerOf2_32(NewAlignment && "Alignment not a power of 2"));
1532 Alignment = NewAlignment;
1533 }
1534
1535 if (UnpackedNewAlignment > UnpackedAlignment) {
1536 assert(llvm::isPowerOf2_32(UnpackedNewAlignment &&
1537 "Alignment not a power of 2"));
1538 UnpackedAlignment = UnpackedNewAlignment;
1539 }
1540}
1541
1542void RecordLayoutBuilder::CheckFieldPadding(uint64_t Offset,
1543 uint64_t UnpaddedOffset,
1544 uint64_t UnpackedOffset,
1545 unsigned UnpackedAlign,
1546 bool isPacked,
1547 const FieldDecl *D) {
1548 // We let objc ivars without warning, objc interfaces generally are not used
1549 // for padding tricks.
1550 if (isa<ObjCIvarDecl>(D))
Anders Carlsson79474332009-07-18 20:20:21 +00001551 return;
Mike Stump11289f42009-09-09 15:08:12 +00001552
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001553 unsigned CharBitNum = Context.Target.getCharWidth();
Mike Stump11289f42009-09-09 15:08:12 +00001554
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001555 // Warn if padding was introduced to the struct/class.
1556 if (!IsUnion && Offset > UnpaddedOffset) {
1557 unsigned PadSize = Offset - UnpaddedOffset;
1558 bool InBits = true;
1559 if (PadSize % CharBitNum == 0) {
1560 PadSize = PadSize / CharBitNum;
1561 InBits = false;
1562 }
1563 if (D->getIdentifier())
1564 Diag(D->getLocation(), diag::warn_padded_struct_field)
1565 << (D->getParent()->isStruct() ? 0 : 1) // struct|class
1566 << Context.getTypeDeclType(D->getParent())
1567 << PadSize
1568 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1) // plural or not
1569 << D->getIdentifier();
1570 else
1571 Diag(D->getLocation(), diag::warn_padded_struct_anon_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 }
1577
1578 // Warn if we packed it unnecessarily. If the alignment is 1 byte don't
1579 // bother since there won't be alignment issues.
1580 if (isPacked && UnpackedAlign > CharBitNum && Offset == UnpackedOffset)
1581 Diag(D->getLocation(), diag::warn_unnecessary_packed)
1582 << D->getIdentifier();
Anders Carlsson79474332009-07-18 20:20:21 +00001583}
Mike Stump11289f42009-09-09 15:08:12 +00001584
Anders Carlsson5ebf8b42009-12-07 04:35:11 +00001585const CXXMethodDecl *
Anders Carlssonc2226202010-05-26 05:58:59 +00001586RecordLayoutBuilder::ComputeKeyFunction(const CXXRecordDecl *RD) {
Daniel Dunbarccabe482010-04-19 20:44:53 +00001587 // If a class isn't polymorphic it doesn't have a key function.
Anders Carlsson5ebf8b42009-12-07 04:35:11 +00001588 if (!RD->isPolymorphic())
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001589 return 0;
Eli Friedmanf2c79b62009-12-08 03:56:49 +00001590
1591 // A class inside an anonymous namespace doesn't have a key function. (Or
1592 // at least, there's no point to assigning a key function to such a class;
1593 // this doesn't affect the ABI.)
1594 if (RD->isInAnonymousNamespace())
1595 return 0;
1596
Argyrios Kyrtzidis8c64bbe2010-10-13 02:39:41 +00001597 // Template instantiations don't have key functions,see Itanium C++ ABI 5.2.6.
1598 // Same behavior as GCC.
1599 TemplateSpecializationKind TSK = RD->getTemplateSpecializationKind();
1600 if (TSK == TSK_ImplicitInstantiation ||
1601 TSK == TSK_ExplicitInstantiationDefinition)
1602 return 0;
1603
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001604 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
1605 E = RD->method_end(); I != E; ++I) {
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001606 const CXXMethodDecl *MD = *I;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001607
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001608 if (!MD->isVirtual())
1609 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001610
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001611 if (MD->isPure())
1612 continue;
Eli Friedmanf2c79b62009-12-08 03:56:49 +00001613
Anders Carlssonf98849e2009-12-02 17:15:43 +00001614 // Ignore implicit member functions, they are always marked as inline, but
1615 // they don't have a body until they're defined.
1616 if (MD->isImplicit())
1617 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001618
Douglas Gregora318efd2010-01-05 19:06:31 +00001619 if (MD->isInlineSpecified())
1620 continue;
Eli Friedman71a26d82009-12-06 20:50:05 +00001621
1622 if (MD->hasInlineBody())
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001623 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001624
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001625 // We found it.
1626 return MD;
1627 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001628
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001629 return 0;
1630}
1631
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001632DiagnosticBuilder
1633RecordLayoutBuilder::Diag(SourceLocation Loc, unsigned DiagID) {
1634 return Context.getDiagnostics().Report(
1635 FullSourceLoc(Loc, Context.getSourceManager()), DiagID);
1636}
1637
Benjamin Kramer2fc373e2010-10-22 16:33:16 +00001638namespace {
1639 // This class implements layout specific to the Microsoft ABI.
1640 class MSRecordLayoutBuilder : public RecordLayoutBuilder {
1641 public:
1642 MSRecordLayoutBuilder(ASTContext& Ctx, EmptySubobjectMap *EmptySubobjects) :
1643 RecordLayoutBuilder(Ctx, EmptySubobjects) {}
Charles Davisc2c576a2010-08-19 00:55:19 +00001644
Benjamin Kramer2fc373e2010-10-22 16:33:16 +00001645 virtual bool IsNearlyEmpty(const CXXRecordDecl *RD) const;
1646 virtual uint64_t GetVirtualPointersSize(const CXXRecordDecl *RD) const;
1647 };
1648}
Charles Davisc2c576a2010-08-19 00:55:19 +00001649
1650bool MSRecordLayoutBuilder::IsNearlyEmpty(const CXXRecordDecl *RD) const {
1651 // FIXME: Audit the corners
1652 if (!RD->isDynamicClass())
1653 return false;
1654 const ASTRecordLayout &BaseInfo = Context.getASTRecordLayout(RD);
1655 // In the Microsoft ABI, classes can have one or two vtable pointers.
1656 if (BaseInfo.getNonVirtualSize() == Context.Target.getPointerWidth(0) ||
1657 BaseInfo.getNonVirtualSize() == Context.Target.getPointerWidth(0) * 2)
1658 return true;
1659 return false;
1660}
1661
1662uint64_t
1663MSRecordLayoutBuilder::GetVirtualPointersSize(const CXXRecordDecl *RD) const {
1664 // We should reserve space for two pointers if the class has both
1665 // virtual functions and virtual bases.
1666 if (RD->isPolymorphic() && RD->getNumVBases() > 0)
1667 return 2 * Context.Target.getPointerWidth(0);
1668 return Context.Target.getPointerWidth(0);
1669}
1670
Anders Carlssondf291d82010-05-26 04:56:53 +00001671/// getASTRecordLayout - Get or compute information about the layout of the
1672/// specified record (struct/union/class), which indicates its size and field
1673/// position information.
1674const ASTRecordLayout &ASTContext::getASTRecordLayout(const RecordDecl *D) {
1675 D = D->getDefinition();
1676 assert(D && "Cannot get layout of forward declarations!");
1677
1678 // Look up this layout, if already laid out, return what we have.
1679 // Note that we can't save a reference to the entry because this function
1680 // is recursive.
1681 const ASTRecordLayout *Entry = ASTRecordLayouts[D];
1682 if (Entry) return *Entry;
1683
Anders Carlssond2954862010-05-26 05:10:47 +00001684 const ASTRecordLayout *NewEntry;
1685
1686 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
Anders Carlssonc121b4e2010-05-27 00:07:01 +00001687 EmptySubobjectMap EmptySubobjects(*this, RD);
Anders Carlsson439edd12010-05-27 05:41:06 +00001688
Charles Davisc2c576a2010-08-19 00:55:19 +00001689 // When compiling for Microsoft, use the special MS builder.
Argyrios Kyrtzidis3c6cd172010-08-25 00:32:14 +00001690 llvm::OwningPtr<RecordLayoutBuilder> Builder;
Charles Davis6bcb07a2010-08-19 02:18:14 +00001691 switch (Target.getCXXABI()) {
1692 default:
Argyrios Kyrtzidis3c6cd172010-08-25 00:32:14 +00001693 Builder.reset(new RecordLayoutBuilder(*this, &EmptySubobjects));
Charles Davis6bcb07a2010-08-19 02:18:14 +00001694 break;
1695 case CXXABI_Microsoft:
Argyrios Kyrtzidis3c6cd172010-08-25 00:32:14 +00001696 Builder.reset(new MSRecordLayoutBuilder(*this, &EmptySubobjects));
Charles Davis6bcb07a2010-08-19 02:18:14 +00001697 }
Charles Davisc2c576a2010-08-19 00:55:19 +00001698 Builder->Layout(RD);
Anders Carlssond2954862010-05-26 05:10:47 +00001699
1700 // FIXME: This is not always correct. See the part about bitfields at
1701 // http://www.codesourcery.com/public/cxx-abi/abi.html#POD for more info.
1702 // FIXME: IsPODForThePurposeOfLayout should be stored in the record layout.
1703 bool IsPODForThePurposeOfLayout = cast<CXXRecordDecl>(D)->isPOD();
1704
1705 // FIXME: This should be done in FinalizeLayout.
1706 uint64_t DataSize =
Charles Davisc2c576a2010-08-19 00:55:19 +00001707 IsPODForThePurposeOfLayout ? Builder->Size : Builder->DataSize;
Anders Carlssond2954862010-05-26 05:10:47 +00001708 uint64_t NonVirtualSize =
Charles Davisc2c576a2010-08-19 00:55:19 +00001709 IsPODForThePurposeOfLayout ? DataSize : Builder->NonVirtualSize;
Anders Carlssond2954862010-05-26 05:10:47 +00001710
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001711 NewEntry =
Charles Davisc2c576a2010-08-19 00:55:19 +00001712 new (*this) ASTRecordLayout(*this, Builder->Size, Builder->Alignment,
1713 DataSize, Builder->FieldOffsets.data(),
1714 Builder->FieldOffsets.size(),
Anders Carlssond2954862010-05-26 05:10:47 +00001715 NonVirtualSize,
Charles Davisc2c576a2010-08-19 00:55:19 +00001716 Builder->NonVirtualAlignment,
Anders Carlssonc121b4e2010-05-27 00:07:01 +00001717 EmptySubobjects.SizeOfLargestEmptySubobject,
Charles Davisc2c576a2010-08-19 00:55:19 +00001718 Builder->PrimaryBase,
1719 Builder->PrimaryBaseIsVirtual,
1720 Builder->Bases, Builder->VBases);
Anders Carlssond2954862010-05-26 05:10:47 +00001721 } else {
Anders Carlssonc121b4e2010-05-27 00:07:01 +00001722 RecordLayoutBuilder Builder(*this, /*EmptySubobjects=*/0);
Anders Carlssond2954862010-05-26 05:10:47 +00001723 Builder.Layout(D);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001724
Anders Carlssond2954862010-05-26 05:10:47 +00001725 NewEntry =
1726 new (*this) ASTRecordLayout(*this, Builder.Size, Builder.Alignment,
1727 Builder.Size,
1728 Builder.FieldOffsets.data(),
1729 Builder.FieldOffsets.size());
1730 }
1731
Anders Carlssondf291d82010-05-26 04:56:53 +00001732 ASTRecordLayouts[D] = NewEntry;
1733
1734 if (getLangOptions().DumpRecordLayouts) {
1735 llvm::errs() << "\n*** Dumping AST Record Layout\n";
1736 DumpRecordLayout(D, llvm::errs());
1737 }
1738
1739 return *NewEntry;
1740}
1741
1742const CXXMethodDecl *ASTContext::getKeyFunction(const CXXRecordDecl *RD) {
1743 RD = cast<CXXRecordDecl>(RD->getDefinition());
1744 assert(RD && "Cannot get key function for forward declarations!");
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001745
Anders Carlssondf291d82010-05-26 04:56:53 +00001746 const CXXMethodDecl *&Entry = KeyFunctions[RD];
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001747 if (!Entry)
Anders Carlssonc2226202010-05-26 05:58:59 +00001748 Entry = RecordLayoutBuilder::ComputeKeyFunction(RD);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001749
Anders Carlssondf291d82010-05-26 04:56:53 +00001750 return Entry;
1751}
1752
1753/// getInterfaceLayoutImpl - Get or compute information about the
1754/// layout of the given interface.
1755///
1756/// \param Impl - If given, also include the layout of the interface's
1757/// implementation. This may differ by including synthesized ivars.
1758const ASTRecordLayout &
1759ASTContext::getObjCLayout(const ObjCInterfaceDecl *D,
1760 const ObjCImplementationDecl *Impl) {
1761 assert(!D->isForwardDecl() && "Invalid interface decl!");
1762
1763 // Look up this layout, if already laid out, return what we have.
1764 ObjCContainerDecl *Key =
1765 Impl ? (ObjCContainerDecl*) Impl : (ObjCContainerDecl*) D;
1766 if (const ASTRecordLayout *Entry = ObjCLayouts[Key])
1767 return *Entry;
1768
1769 // Add in synthesized ivar count if laying out an implementation.
1770 if (Impl) {
1771 unsigned SynthCount = CountNonClassIvars(D);
1772 // If there aren't any sythesized ivars then reuse the interface
1773 // entry. Note we can't cache this because we simply free all
1774 // entries later; however we shouldn't look up implementations
1775 // frequently.
1776 if (SynthCount == 0)
1777 return getObjCLayout(D, 0);
1778 }
1779
Anders Carlssonc121b4e2010-05-27 00:07:01 +00001780 RecordLayoutBuilder Builder(*this, /*EmptySubobjects=*/0);
Anders Carlsson6ed3a9a2010-05-26 05:04:25 +00001781 Builder.Layout(D);
1782
Anders Carlssondf291d82010-05-26 04:56:53 +00001783 const ASTRecordLayout *NewEntry =
Anders Carlsson6ed3a9a2010-05-26 05:04:25 +00001784 new (*this) ASTRecordLayout(*this, Builder.Size, Builder.Alignment,
1785 Builder.DataSize,
1786 Builder.FieldOffsets.data(),
1787 Builder.FieldOffsets.size());
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001788
Anders Carlssondf291d82010-05-26 04:56:53 +00001789 ObjCLayouts[Key] = NewEntry;
1790
1791 return *NewEntry;
1792}
1793
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001794static void PrintOffset(llvm::raw_ostream &OS,
Anders Carlsson3f018712010-10-31 23:45:59 +00001795 CharUnits Offset, unsigned IndentLevel) {
1796 OS << llvm::format("%4d | ", Offset.getQuantity());
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001797 OS.indent(IndentLevel * 2);
1798}
1799
1800static void DumpCXXRecordLayout(llvm::raw_ostream &OS,
1801 const CXXRecordDecl *RD, ASTContext &C,
Anders Carlsson3f018712010-10-31 23:45:59 +00001802 CharUnits Offset,
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001803 unsigned IndentLevel,
1804 const char* Description,
1805 bool IncludeVirtualBases) {
Anders Carlsson3f018712010-10-31 23:45:59 +00001806 const ASTRecordLayout &Layout = C.getASTRecordLayout(RD);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001807
1808 PrintOffset(OS, Offset, IndentLevel);
Dan Gohman145f3f12010-04-19 16:39:44 +00001809 OS << C.getTypeDeclType(const_cast<CXXRecordDecl *>(RD)).getAsString();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001810 if (Description)
1811 OS << ' ' << Description;
1812 if (RD->isEmpty())
1813 OS << " (empty)";
1814 OS << '\n';
1815
1816 IndentLevel++;
1817
Anders Carlsson3f018712010-10-31 23:45:59 +00001818 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001819
1820 // Vtable pointer.
1821 if (RD->isDynamicClass() && !PrimaryBase) {
1822 PrintOffset(OS, Offset, IndentLevel);
Benjamin Kramerb11416d2010-04-17 09:33:03 +00001823 OS << '(' << RD << " vtable pointer)\n";
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001824 }
1825 // Dump (non-virtual) bases
1826 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1827 E = RD->bases_end(); I != E; ++I) {
1828 assert(!I->getType()->isDependentType() &&
1829 "Cannot layout class with dependent bases.");
1830 if (I->isVirtual())
1831 continue;
1832
1833 const CXXRecordDecl *Base =
1834 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1835
Anders Carlsson3f018712010-10-31 23:45:59 +00001836 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001837
1838 DumpCXXRecordLayout(OS, Base, C, BaseOffset, IndentLevel,
1839 Base == PrimaryBase ? "(primary base)" : "(base)",
1840 /*IncludeVirtualBases=*/false);
1841 }
1842
1843 // Dump fields.
1844 uint64_t FieldNo = 0;
1845 for (CXXRecordDecl::field_iterator I = RD->field_begin(),
1846 E = RD->field_end(); I != E; ++I, ++FieldNo) {
1847 const FieldDecl *Field = *I;
Anders Carlsson3f018712010-10-31 23:45:59 +00001848 CharUnits FieldOffset = Offset +
1849 CharUnits::fromQuantity(Layout.getFieldOffset(FieldNo) /
1850 C.getCharWidth());
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001851
1852 if (const RecordType *RT = Field->getType()->getAs<RecordType>()) {
1853 if (const CXXRecordDecl *D = dyn_cast<CXXRecordDecl>(RT->getDecl())) {
1854 DumpCXXRecordLayout(OS, D, C, FieldOffset, IndentLevel,
Daniel Dunbar56df9772010-08-17 22:39:59 +00001855 Field->getName().data(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001856 /*IncludeVirtualBases=*/true);
1857 continue;
1858 }
1859 }
1860
1861 PrintOffset(OS, FieldOffset, IndentLevel);
Benjamin Kramerb11416d2010-04-17 09:33:03 +00001862 OS << Field->getType().getAsString() << ' ' << Field << '\n';
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001863 }
1864
1865 if (!IncludeVirtualBases)
1866 return;
1867
1868 // Dump virtual bases.
1869 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
1870 E = RD->vbases_end(); I != E; ++I) {
1871 assert(I->isVirtual() && "Found non-virtual class!");
1872 const CXXRecordDecl *VBase =
1873 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1874
Anders Carlsson3f018712010-10-31 23:45:59 +00001875 CharUnits VBaseOffset = Offset + Layout.getVBaseClassOffset(VBase);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001876 DumpCXXRecordLayout(OS, VBase, C, VBaseOffset, IndentLevel,
1877 VBase == PrimaryBase ?
1878 "(primary virtual base)" : "(virtual base)",
1879 /*IncludeVirtualBases=*/false);
1880 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001881
Anders Carlsson3f018712010-10-31 23:45:59 +00001882 OS << " sizeof=" << Layout.getSize() / 8;
1883 OS << ", dsize=" << Layout.getDataSize() / 8;
1884 OS << ", align=" << Layout.getAlignment() / 8 << '\n';
1885 OS << " nvsize=" << Layout.getNonVirtualSize() / 8;
1886 OS << ", nvalign=" << Layout.getNonVirtualAlign() / 8 << '\n';
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001887 OS << '\n';
1888}
Daniel Dunbarccabe482010-04-19 20:44:53 +00001889
1890void ASTContext::DumpRecordLayout(const RecordDecl *RD,
1891 llvm::raw_ostream &OS) {
1892 const ASTRecordLayout &Info = getASTRecordLayout(RD);
1893
1894 if (const CXXRecordDecl *CXXRD = dyn_cast<CXXRecordDecl>(RD))
Anders Carlsson3f018712010-10-31 23:45:59 +00001895 return DumpCXXRecordLayout(OS, CXXRD, *this, CharUnits(), 0, 0,
Daniel Dunbarccabe482010-04-19 20:44:53 +00001896 /*IncludeVirtualBases=*/true);
1897
1898 OS << "Type: " << getTypeDeclType(RD).getAsString() << "\n";
1899 OS << "Record: ";
1900 RD->dump();
1901 OS << "\nLayout: ";
1902 OS << "<ASTRecordLayout\n";
1903 OS << " Size:" << Info.getSize() << "\n";
1904 OS << " DataSize:" << Info.getDataSize() << "\n";
1905 OS << " Alignment:" << Info.getAlignment() << "\n";
1906 OS << " FieldOffsets: [";
1907 for (unsigned i = 0, e = Info.getFieldCount(); i != e; ++i) {
1908 if (i) OS << ", ";
1909 OS << Info.getFieldOffset(i);
1910 }
1911 OS << "]>\n";
1912}