blob: 0fe180d551d236de5b2b3a096fd4b525f291a47e [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;
Anders Carlsson09814d32010-11-01 15:14:51 +0000497 if (FD->isBitField())
498 continue;
499
Anders Carlsson28466ab2010-10-31 22:13:23 +0000500 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
Anders Carlssondb319762010-05-27 18:20:57 +0000501
Anders Carlsson28466ab2010-10-31 22:13:23 +0000502 UpdateEmptyFieldSubobjects(FD, FieldOffset);
Anders Carlssondb319762010-05-27 18:20:57 +0000503 }
504}
505
506void EmptySubobjectMap::UpdateEmptyFieldSubobjects(const FieldDecl *FD,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000507 CharUnits Offset) {
Anders Carlssondb319762010-05-27 18:20:57 +0000508 QualType T = FD->getType();
509 if (const RecordType *RT = T->getAs<RecordType>()) {
510 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
511 UpdateEmptyFieldSubobjects(RD, RD, Offset);
512 return;
513 }
514
515 // If we have an array type we need to update every element.
516 if (const ConstantArrayType *AT = Context.getAsConstantArrayType(T)) {
517 QualType ElemTy = Context.getBaseElementType(AT);
518 const RecordType *RT = ElemTy->getAs<RecordType>();
519 if (!RT)
520 return;
521
522 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
523 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
524
525 uint64_t NumElements = Context.getConstantArrayElementCount(AT);
Anders Carlsson28466ab2010-10-31 22:13:23 +0000526 CharUnits ElementOffset = Offset;
Anders Carlssondb319762010-05-27 18:20:57 +0000527
528 for (uint64_t I = 0; I != NumElements; ++I) {
Anders Carlssonae111dc2010-06-13 17:49:16 +0000529 // We know that the only empty subobjects that can conflict with empty
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000530 // field subobjects are subobjects of empty bases that can be placed at
Anders Carlssonae111dc2010-06-13 17:49:16 +0000531 // offset zero. Because of this, we only need to keep track of empty field
532 // subobjects with offsets less than the size of the largest empty
533 // subobject for our class.
534 if (ElementOffset >= SizeOfLargestEmptySubobject)
535 return;
536
Anders Carlssondb319762010-05-27 18:20:57 +0000537 UpdateEmptyFieldSubobjects(RD, RD, ElementOffset);
Anders Carlsson28466ab2010-10-31 22:13:23 +0000538 ElementOffset += toCharUnits(Layout.getSize());
Anders Carlssondb319762010-05-27 18:20:57 +0000539 }
540 }
541}
542
Anders Carlssonc2226202010-05-26 05:58:59 +0000543class RecordLayoutBuilder {
Charles Davisc2c576a2010-08-19 00:55:19 +0000544protected:
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000545 // FIXME: Remove this and make the appropriate fields public.
546 friend class clang::ASTContext;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000547
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000548 ASTContext &Context;
549
Anders Carlssonf58de112010-05-26 15:32:58 +0000550 EmptySubobjectMap *EmptySubobjects;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000551
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000552 /// Size - The current size of the record layout.
553 uint64_t Size;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000554
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000555 /// Alignment - The current alignment of the record layout.
556 unsigned Alignment;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000557
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000558 /// \brief The alignment if attribute packed is not used.
559 unsigned UnpackedAlignment;
560
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000561 llvm::SmallVector<uint64_t, 16> FieldOffsets;
562
563 /// Packed - Whether the record is packed or not.
Daniel Dunbar6da10982010-05-27 05:45:51 +0000564 unsigned Packed : 1;
565
566 unsigned IsUnion : 1;
567
568 unsigned IsMac68kAlign : 1;
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000569
570 /// UnfilledBitsInLastByte - If the last field laid out was a bitfield,
571 /// this contains the number of bits in the last byte that can be used for
572 /// an adjacent bitfield if necessary.
573 unsigned char UnfilledBitsInLastByte;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000574
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000575 /// MaxFieldAlignment - The maximum allowed field alignment. This is set by
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000576 /// #pragma pack.
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000577 unsigned MaxFieldAlignment;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000578
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000579 /// DataSize - The data size of the record being laid out.
580 uint64_t DataSize;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000581
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000582 uint64_t NonVirtualSize;
583 unsigned NonVirtualAlignment;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000584
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000585 /// PrimaryBase - the primary base class (if one exists) of the class
586 /// we're laying out.
587 const CXXRecordDecl *PrimaryBase;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000588
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000589 /// PrimaryBaseIsVirtual - Whether the primary base of the class we're laying
590 /// out is virtual.
591 bool PrimaryBaseIsVirtual;
592
Anders Carlsson22f57202010-10-31 21:01:46 +0000593 typedef llvm::DenseMap<const CXXRecordDecl *, CharUnits> BaseOffsetsMapTy;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000594
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000595 /// Bases - base classes and their offsets in the record.
596 BaseOffsetsMapTy Bases;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000597
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000598 // VBases - virtual base classes and their offsets in the record.
599 BaseOffsetsMapTy VBases;
600
601 /// IndirectPrimaryBases - Virtual base classes, direct or indirect, that are
602 /// primary base classes for some other direct or indirect base class.
603 llvm::SmallSet<const CXXRecordDecl*, 32> IndirectPrimaryBases;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000604
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000605 /// FirstNearlyEmptyVBase - The first nearly empty virtual base class in
606 /// inheritance graph order. Used for determining the primary base class.
607 const CXXRecordDecl *FirstNearlyEmptyVBase;
608
609 /// VisitedVirtualBases - A set of all the visited virtual bases, used to
610 /// avoid visiting virtual bases more than once.
611 llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBases;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000612
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000613 RecordLayoutBuilder(ASTContext &Context, EmptySubobjectMap *EmptySubobjects)
614 : Context(Context), EmptySubobjects(EmptySubobjects), Size(0), Alignment(8),
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000615 UnpackedAlignment(Alignment), Packed(false), IsUnion(false),
616 IsMac68kAlign(false), UnfilledBitsInLastByte(0), MaxFieldAlignment(0),
617 DataSize(0), NonVirtualSize(0), NonVirtualAlignment(8), PrimaryBase(0),
Daniel Dunbar6da10982010-05-27 05:45:51 +0000618 PrimaryBaseIsVirtual(false), FirstNearlyEmptyVBase(0) { }
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000619
Anders Carlsson725190f2010-10-31 21:39:24 +0000620 // FIXME: Remove these.
621 CharUnits toCharUnits(uint64_t Offset) const {
622 return CharUnits::fromQuantity(Offset / Context.getCharWidth());
623 }
624 uint64_t toOffset(CharUnits Offset) const {
625 return Offset.getQuantity() * Context.getCharWidth();
626 }
627
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000628 void Layout(const RecordDecl *D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000629 void Layout(const CXXRecordDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000630 void Layout(const ObjCInterfaceDecl *D);
631
632 void LayoutFields(const RecordDecl *D);
633 void LayoutField(const FieldDecl *D);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000634 void LayoutWideBitField(uint64_t FieldSize, uint64_t TypeSize,
635 bool FieldPacked, const FieldDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000636 void LayoutBitField(const FieldDecl *D);
637
Anders Carlssone3c24c72010-05-29 17:35:14 +0000638 /// BaseSubobjectInfoAllocator - Allocator for BaseSubobjectInfo objects.
639 llvm::SpecificBumpPtrAllocator<BaseSubobjectInfo> BaseSubobjectInfoAllocator;
640
641 typedef llvm::DenseMap<const CXXRecordDecl *, BaseSubobjectInfo *>
642 BaseSubobjectInfoMapTy;
643
644 /// VirtualBaseInfo - Map from all the (direct or indirect) virtual bases
645 /// of the class we're laying out to their base subobject info.
646 BaseSubobjectInfoMapTy VirtualBaseInfo;
647
648 /// NonVirtualBaseInfo - Map from all the direct non-virtual bases of the
649 /// class we're laying out to their base subobject info.
650 BaseSubobjectInfoMapTy NonVirtualBaseInfo;
651
652 /// ComputeBaseSubobjectInfo - Compute the base subobject information for the
653 /// bases of the given class.
654 void ComputeBaseSubobjectInfo(const CXXRecordDecl *RD);
655
656 /// ComputeBaseSubobjectInfo - Compute the base subobject information for a
657 /// single class and all of its base classes.
658 BaseSubobjectInfo *ComputeBaseSubobjectInfo(const CXXRecordDecl *RD,
659 bool IsVirtual,
660 BaseSubobjectInfo *Derived);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000661
662 /// DeterminePrimaryBase - Determine the primary base of the given class.
663 void DeterminePrimaryBase(const CXXRecordDecl *RD);
664
665 void SelectPrimaryVBase(const CXXRecordDecl *RD);
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000666
Charles Davisc2c576a2010-08-19 00:55:19 +0000667 virtual uint64_t GetVirtualPointersSize(const CXXRecordDecl *RD) const;
668
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000669 /// IdentifyPrimaryBases - Identify all virtual base classes, direct or
670 /// indirect, that are primary base classes for some other direct or indirect
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000671 /// base class.
672 void IdentifyPrimaryBases(const CXXRecordDecl *RD);
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000673
Charles Davisc2c576a2010-08-19 00:55:19 +0000674 virtual bool IsNearlyEmpty(const CXXRecordDecl *RD) const;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000675
676 /// LayoutNonVirtualBases - Determines the primary base class (if any) and
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000677 /// lays it out. Will then proceed to lay out all non-virtual base clasess.
678 void LayoutNonVirtualBases(const CXXRecordDecl *RD);
679
680 /// LayoutNonVirtualBase - Lays out a single non-virtual base.
Anders Carlssonbb0e6782010-05-29 17:42:25 +0000681 void LayoutNonVirtualBase(const BaseSubobjectInfo *Base);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000682
Anders Carlssona2f8e412010-10-31 22:20:42 +0000683 void AddPrimaryVirtualBaseOffsets(const BaseSubobjectInfo *Info,
684 CharUnits Offset);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000685
686 /// LayoutVirtualBases - Lays out all the virtual bases.
687 void LayoutVirtualBases(const CXXRecordDecl *RD,
688 const CXXRecordDecl *MostDerivedClass);
689
690 /// LayoutVirtualBase - Lays out a single virtual base.
Anders Carlssond6ff5d72010-05-29 17:48:36 +0000691 void LayoutVirtualBase(const BaseSubobjectInfo *Base);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000692
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000693 /// LayoutBase - Will lay out a base and return the offset where it was
Anders Carlssona2f8e412010-10-31 22:20:42 +0000694 /// placed, in chars.
695 CharUnits LayoutBase(const BaseSubobjectInfo *Base);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000696
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000697 /// InitializeLayout - Initialize record layout for the given record decl.
Daniel Dunbar6da10982010-05-27 05:45:51 +0000698 void InitializeLayout(const Decl *D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000699
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000700 /// FinishLayout - Finalize record layout. Adjust record size based on the
701 /// alignment.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000702 void FinishLayout(const NamedDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000703
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000704 void UpdateAlignment(unsigned NewAlignment, unsigned UnpackedNewAlignment);
705 void UpdateAlignment(unsigned NewAlignment) {
706 UpdateAlignment(NewAlignment, NewAlignment);
707 }
708
709 void CheckFieldPadding(uint64_t Offset, uint64_t UnpaddedOffset,
710 uint64_t UnpackedOffset, unsigned UnpackedAlign,
711 bool isPacked, const FieldDecl *D);
712
713 DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000714
Argyrios Kyrtzidis499e6e42010-08-15 10:17:39 +0000715 RecordLayoutBuilder(const RecordLayoutBuilder&); // DO NOT IMPLEMENT
716 void operator=(const RecordLayoutBuilder&); // DO NOT IMPLEMENT
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000717public:
718 static const CXXMethodDecl *ComputeKeyFunction(const CXXRecordDecl *RD);
Argyrios Kyrtzidis3c6cd172010-08-25 00:32:14 +0000719
720 virtual ~RecordLayoutBuilder() { }
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000721};
Benjamin Kramerc7656cd2010-05-26 09:58:31 +0000722} // end anonymous namespace
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000723
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000724/// IsNearlyEmpty - Indicates when a class has a vtable pointer, but
725/// no other data.
Anders Carlssonc2226202010-05-26 05:58:59 +0000726bool RecordLayoutBuilder::IsNearlyEmpty(const CXXRecordDecl *RD) const {
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000727 // FIXME: Audit the corners
728 if (!RD->isDynamicClass())
729 return false;
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000730 const ASTRecordLayout &BaseInfo = Context.getASTRecordLayout(RD);
731 if (BaseInfo.getNonVirtualSize() == Context.Target.getPointerWidth(0))
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000732 return true;
733 return false;
734}
735
Anders Carlssonc2226202010-05-26 05:58:59 +0000736void RecordLayoutBuilder::IdentifyPrimaryBases(const CXXRecordDecl *RD) {
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000737 const ASTRecordLayout::PrimaryBaseInfo &BaseInfo =
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000738 Context.getASTRecordLayout(RD).getPrimaryBaseInfo();
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000739
Anders Carlsson81430692009-09-22 03:02:06 +0000740 // If the record has a primary base class that is virtual, add it to the set
741 // of primary bases.
Anders Carlssona30c0d32009-11-27 22:14:40 +0000742 if (BaseInfo.isVirtual())
743 IndirectPrimaryBases.insert(BaseInfo.getBase());
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000744
Anders Carlsson81430692009-09-22 03:02:06 +0000745 // Now traverse all bases and find primary bases for them.
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000746 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000747 e = RD->bases_end(); i != e; ++i) {
Sebastian Redl1054fae2009-10-25 17:03:50 +0000748 assert(!i->getType()->isDependentType() &&
749 "Cannot layout class with dependent bases.");
Mike Stump11289f42009-09-09 15:08:12 +0000750 const CXXRecordDecl *Base =
Mike Stump78696a72009-08-11 04:03:59 +0000751 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000752
Mike Stump78696a72009-08-11 04:03:59 +0000753 // Only bases with virtual bases participate in computing the
754 // indirect primary virtual base classes.
Mike Stumpc2f591b2009-08-13 22:53:07 +0000755 if (Base->getNumVBases())
Anders Carlsson81430692009-09-22 03:02:06 +0000756 IdentifyPrimaryBases(Base);
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000757 }
758}
759
Anders Carlsson81430692009-09-22 03:02:06 +0000760void
Anders Carlssonc2226202010-05-26 05:58:59 +0000761RecordLayoutBuilder::SelectPrimaryVBase(const CXXRecordDecl *RD) {
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000762 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000763 E = RD->bases_end(); I != E; ++I) {
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000764 assert(!I->getType()->isDependentType() &&
Sebastian Redl1054fae2009-10-25 17:03:50 +0000765 "Cannot layout class with dependent bases.");
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000766
Mike Stump11289f42009-09-09 15:08:12 +0000767 const CXXRecordDecl *Base =
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000768 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000769
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000770 // Check if this is a nearly empty virtual base.
771 if (I->isVirtual() && IsNearlyEmpty(Base)) {
772 // If it's not an indirect primary base, then we've found our primary
773 // base.
Anders Carlsson81430692009-09-22 03:02:06 +0000774 if (!IndirectPrimaryBases.count(Base)) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000775 PrimaryBase = Base;
776 PrimaryBaseIsVirtual = true;
Mike Stump6f3793b2009-08-12 21:50:08 +0000777 return;
778 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000779
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000780 // Is this the first nearly empty virtual base?
781 if (!FirstNearlyEmptyVBase)
782 FirstNearlyEmptyVBase = Base;
Mike Stump6f3793b2009-08-12 21:50:08 +0000783 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000784
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000785 SelectPrimaryVBase(Base);
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000786 if (PrimaryBase)
Zhongxing Xuec345b72010-02-15 04:28:35 +0000787 return;
Mike Stump6f3793b2009-08-12 21:50:08 +0000788 }
789}
790
Charles Davisc2c576a2010-08-19 00:55:19 +0000791uint64_t
792RecordLayoutBuilder::GetVirtualPointersSize(const CXXRecordDecl *RD) const {
793 return Context.Target.getPointerWidth(0);
794}
795
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000796/// DeterminePrimaryBase - Determine the primary base of the given class.
Anders Carlssonc2226202010-05-26 05:58:59 +0000797void RecordLayoutBuilder::DeterminePrimaryBase(const CXXRecordDecl *RD) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000798 // If the class isn't dynamic, it won't have a primary base.
799 if (!RD->isDynamicClass())
800 return;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000801
Anders Carlsson81430692009-09-22 03:02:06 +0000802 // Compute all the primary virtual bases for all of our direct and
Mike Stump590a7c72009-08-13 23:26:06 +0000803 // indirect bases, and record all their primary virtual base classes.
Mike Stump590a7c72009-08-13 23:26:06 +0000804 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000805 e = RD->bases_end(); i != e; ++i) {
Sebastian Redl1054fae2009-10-25 17:03:50 +0000806 assert(!i->getType()->isDependentType() &&
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000807 "Cannot lay out class with dependent bases.");
Mike Stump11289f42009-09-09 15:08:12 +0000808 const CXXRecordDecl *Base =
Mike Stump590a7c72009-08-13 23:26:06 +0000809 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson81430692009-09-22 03:02:06 +0000810 IdentifyPrimaryBases(Base);
Mike Stump590a7c72009-08-13 23:26:06 +0000811 }
812
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000813 // If the record has a dynamic base class, attempt to choose a primary base
814 // class. It is the first (in direct base class order) non-virtual dynamic
Anders Carlsson81430692009-09-22 03:02:06 +0000815 // base class, if one exists.
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000816 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000817 e = RD->bases_end(); i != e; ++i) {
Anders Carlsson03ff3792009-11-27 22:05:05 +0000818 // Ignore virtual bases.
819 if (i->isVirtual())
820 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000821
Anders Carlsson03ff3792009-11-27 22:05:05 +0000822 const CXXRecordDecl *Base =
823 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
824
825 if (Base->isDynamicClass()) {
826 // We found it.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000827 PrimaryBase = Base;
828 PrimaryBaseIsVirtual = false;
Anders Carlsson03ff3792009-11-27 22:05:05 +0000829 return;
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000830 }
831 }
832
833 // Otherwise, it is the first nearly empty virtual base that is not an
Mike Stump78696a72009-08-11 04:03:59 +0000834 // indirect primary virtual base class, if one exists.
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000835 if (RD->getNumVBases() != 0) {
836 SelectPrimaryVBase(RD);
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000837 if (PrimaryBase)
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000838 return;
839 }
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000840
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000841 // Otherwise, it is the first nearly empty virtual base that is not an
842 // indirect primary virtual base class, if one exists.
843 if (FirstNearlyEmptyVBase) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000844 PrimaryBase = FirstNearlyEmptyVBase;
845 PrimaryBaseIsVirtual = true;
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000846 return;
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000847 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000848
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000849 // Otherwise there is no primary base class.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000850 assert(!PrimaryBase && "Should not get here with a primary base!");
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000851
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000852 // Allocate the virtual table pointer at offset zero.
853 assert(DataSize == 0 && "Vtable pointer must be at offset zero!");
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000854
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000855 // Update the size.
Charles Davisc2c576a2010-08-19 00:55:19 +0000856 Size += GetVirtualPointersSize(RD);
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000857 DataSize = Size;
858
859 // Update the alignment.
Anders Carlsson5efc56e2010-04-16 15:07:51 +0000860 UpdateAlignment(Context.Target.getPointerAlign(0));
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000861}
862
Anders Carlssone3c24c72010-05-29 17:35:14 +0000863BaseSubobjectInfo *
864RecordLayoutBuilder::ComputeBaseSubobjectInfo(const CXXRecordDecl *RD,
865 bool IsVirtual,
866 BaseSubobjectInfo *Derived) {
867 BaseSubobjectInfo *Info;
868
869 if (IsVirtual) {
870 // Check if we already have info about this virtual base.
871 BaseSubobjectInfo *&InfoSlot = VirtualBaseInfo[RD];
872 if (InfoSlot) {
873 assert(InfoSlot->Class == RD && "Wrong class for virtual base info!");
874 return InfoSlot;
875 }
876
877 // We don't, create it.
878 InfoSlot = new (BaseSubobjectInfoAllocator.Allocate()) BaseSubobjectInfo;
879 Info = InfoSlot;
880 } else {
881 Info = new (BaseSubobjectInfoAllocator.Allocate()) BaseSubobjectInfo;
882 }
883
884 Info->Class = RD;
885 Info->IsVirtual = IsVirtual;
886 Info->Derived = 0;
887 Info->PrimaryVirtualBaseInfo = 0;
888
889 const CXXRecordDecl *PrimaryVirtualBase = 0;
890 BaseSubobjectInfo *PrimaryVirtualBaseInfo = 0;
891
892 // Check if this base has a primary virtual base.
893 if (RD->getNumVBases()) {
894 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
895 if (Layout.getPrimaryBaseWasVirtual()) {
896 // This base does have a primary virtual base.
897 PrimaryVirtualBase = Layout.getPrimaryBase();
898 assert(PrimaryVirtualBase && "Didn't have a primary virtual base!");
899
900 // Now check if we have base subobject info about this primary base.
901 PrimaryVirtualBaseInfo = VirtualBaseInfo.lookup(PrimaryVirtualBase);
902
903 if (PrimaryVirtualBaseInfo) {
904 if (PrimaryVirtualBaseInfo->Derived) {
905 // We did have info about this primary base, and it turns out that it
906 // has already been claimed as a primary virtual base for another
907 // base.
908 PrimaryVirtualBase = 0;
909 } else {
910 // We can claim this base as our primary base.
911 Info->PrimaryVirtualBaseInfo = PrimaryVirtualBaseInfo;
912 PrimaryVirtualBaseInfo->Derived = Info;
913 }
914 }
915 }
916 }
917
918 // Now go through all direct bases.
919 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
920 E = RD->bases_end(); I != E; ++I) {
921 bool IsVirtual = I->isVirtual();
922
923 const CXXRecordDecl *BaseDecl =
924 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
925
926 Info->Bases.push_back(ComputeBaseSubobjectInfo(BaseDecl, IsVirtual, Info));
927 }
928
929 if (PrimaryVirtualBase && !PrimaryVirtualBaseInfo) {
930 // Traversing the bases must have created the base info for our primary
931 // virtual base.
932 PrimaryVirtualBaseInfo = VirtualBaseInfo.lookup(PrimaryVirtualBase);
933 assert(PrimaryVirtualBaseInfo &&
934 "Did not create a primary virtual base!");
935
936 // Claim the primary virtual base as our primary virtual base.
937 Info->PrimaryVirtualBaseInfo = PrimaryVirtualBaseInfo;
938 PrimaryVirtualBaseInfo->Derived = Info;
939 }
940
941 return Info;
942}
943
944void RecordLayoutBuilder::ComputeBaseSubobjectInfo(const CXXRecordDecl *RD) {
945 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
946 E = RD->bases_end(); I != E; ++I) {
947 bool IsVirtual = I->isVirtual();
948
949 const CXXRecordDecl *BaseDecl =
950 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
951
952 // Compute the base subobject info for this base.
953 BaseSubobjectInfo *Info = ComputeBaseSubobjectInfo(BaseDecl, IsVirtual, 0);
954
955 if (IsVirtual) {
956 // ComputeBaseInfo has already added this base for us.
957 assert(VirtualBaseInfo.count(BaseDecl) &&
958 "Did not add virtual base!");
959 } else {
960 // Add the base info to the map of non-virtual bases.
961 assert(!NonVirtualBaseInfo.count(BaseDecl) &&
962 "Non-virtual base already exists!");
963 NonVirtualBaseInfo.insert(std::make_pair(BaseDecl, Info));
964 }
965 }
966}
967
Anders Carlsson09ffa322010-03-10 22:21:28 +0000968void
Anders Carlssonc2226202010-05-26 05:58:59 +0000969RecordLayoutBuilder::LayoutNonVirtualBases(const CXXRecordDecl *RD) {
Anders Carlssone3c24c72010-05-29 17:35:14 +0000970 // Then, determine the primary base class.
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000971 DeterminePrimaryBase(RD);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000972
Anders Carlssone3c24c72010-05-29 17:35:14 +0000973 // Compute base subobject info.
974 ComputeBaseSubobjectInfo(RD);
975
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000976 // If we have a primary base class, lay it out.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000977 if (PrimaryBase) {
978 if (PrimaryBaseIsVirtual) {
Anders Carlssone3c24c72010-05-29 17:35:14 +0000979 // If the primary virtual base was a primary virtual base of some other
980 // base class we'll have to steal it.
981 BaseSubobjectInfo *PrimaryBaseInfo = VirtualBaseInfo.lookup(PrimaryBase);
982 PrimaryBaseInfo->Derived = 0;
983
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000984 // We have a virtual primary base, insert it as an indirect primary base.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000985 IndirectPrimaryBases.insert(PrimaryBase);
Anders Carlssonfe900962010-03-11 05:42:17 +0000986
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000987 assert(!VisitedVirtualBases.count(PrimaryBase) &&
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000988 "vbase already visited!");
989 VisitedVirtualBases.insert(PrimaryBase);
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000990
Anders Carlssond6ff5d72010-05-29 17:48:36 +0000991 LayoutVirtualBase(PrimaryBaseInfo);
Anders Carlssonbb0e6782010-05-29 17:42:25 +0000992 } else {
993 BaseSubobjectInfo *PrimaryBaseInfo =
994 NonVirtualBaseInfo.lookup(PrimaryBase);
995 assert(PrimaryBaseInfo &&
996 "Did not find base info for non-virtual primary base!");
997
998 LayoutNonVirtualBase(PrimaryBaseInfo);
999 }
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001000 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001001
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001002 // Now lay out the non-virtual bases.
1003 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001004 E = RD->bases_end(); I != E; ++I) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001005
1006 // Ignore virtual bases.
1007 if (I->isVirtual())
1008 continue;
1009
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001010 const CXXRecordDecl *BaseDecl =
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001011 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1012
1013 // Skip the primary base.
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001014 if (BaseDecl == PrimaryBase && !PrimaryBaseIsVirtual)
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001015 continue;
1016
1017 // Lay out the base.
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001018 BaseSubobjectInfo *BaseInfo = NonVirtualBaseInfo.lookup(BaseDecl);
1019 assert(BaseInfo && "Did not find base info for non-virtual base!");
1020
1021 LayoutNonVirtualBase(BaseInfo);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001022 }
1023}
1024
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001025void RecordLayoutBuilder::LayoutNonVirtualBase(const BaseSubobjectInfo *Base) {
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001026 // Layout the base.
Anders Carlssona2f8e412010-10-31 22:20:42 +00001027 CharUnits Offset = LayoutBase(Base);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001028
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001029 // Add its base class offset.
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001030 assert(!Bases.count(Base->Class) && "base offset already exists!");
Anders Carlssona2f8e412010-10-31 22:20:42 +00001031 Bases.insert(std::make_pair(Base->Class, Offset));
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001032
1033 AddPrimaryVirtualBaseOffsets(Base, Offset);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001034}
Mike Stump2b84dd32009-11-05 04:02:15 +00001035
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001036void
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001037RecordLayoutBuilder::AddPrimaryVirtualBaseOffsets(const BaseSubobjectInfo *Info,
Anders Carlssona2f8e412010-10-31 22:20:42 +00001038 CharUnits Offset) {
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001039 // This base isn't interesting, it has no virtual bases.
1040 if (!Info->Class->getNumVBases())
1041 return;
1042
1043 // First, check if we have a virtual primary base to add offsets for.
1044 if (Info->PrimaryVirtualBaseInfo) {
1045 assert(Info->PrimaryVirtualBaseInfo->IsVirtual &&
1046 "Primary virtual base is not virtual!");
1047 if (Info->PrimaryVirtualBaseInfo->Derived == Info) {
1048 // Add the offset.
1049 assert(!VBases.count(Info->PrimaryVirtualBaseInfo->Class) &&
1050 "primary vbase offset already exists!");
1051 VBases.insert(std::make_pair(Info->PrimaryVirtualBaseInfo->Class,
Anders Carlssona2f8e412010-10-31 22:20:42 +00001052 Offset));
Anders Carlssonea7b1822010-04-15 16:12:58 +00001053
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001054 // Traverse the primary virtual base.
1055 AddPrimaryVirtualBaseOffsets(Info->PrimaryVirtualBaseInfo, Offset);
1056 }
Anders Carlssonea7b1822010-04-15 16:12:58 +00001057 }
1058
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001059 // Now go through all direct non-virtual bases.
1060 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Info->Class);
1061 for (unsigned I = 0, E = Info->Bases.size(); I != E; ++I) {
1062 const BaseSubobjectInfo *Base = Info->Bases[I];
1063 if (Base->IsVirtual)
Anders Carlssonea7b1822010-04-15 16:12:58 +00001064 continue;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001065
Anders Carlsson0a14ee92010-11-01 00:21:58 +00001066 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base->Class);
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001067 AddPrimaryVirtualBaseOffsets(Base, BaseOffset);
Anders Carlssonea7b1822010-04-15 16:12:58 +00001068 }
1069}
1070
1071void
Anders Carlssonc2226202010-05-26 05:58:59 +00001072RecordLayoutBuilder::LayoutVirtualBases(const CXXRecordDecl *RD,
Anders Carlssonea7b1822010-04-15 16:12:58 +00001073 const CXXRecordDecl *MostDerivedClass) {
Anders Carlssonde710c92010-03-11 04:33:54 +00001074 const CXXRecordDecl *PrimaryBase;
Anders Carlsson291279e2010-04-10 18:42:27 +00001075 bool PrimaryBaseIsVirtual;
Anders Carlssonfe900962010-03-11 05:42:17 +00001076
Anders Carlsson291279e2010-04-10 18:42:27 +00001077 if (MostDerivedClass == RD) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +00001078 PrimaryBase = this->PrimaryBase;
1079 PrimaryBaseIsVirtual = this->PrimaryBaseIsVirtual;
Anders Carlsson291279e2010-04-10 18:42:27 +00001080 } else {
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001081 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlssonde710c92010-03-11 04:33:54 +00001082 PrimaryBase = Layout.getPrimaryBase();
Anders Carlsson291279e2010-04-10 18:42:27 +00001083 PrimaryBaseIsVirtual = Layout.getPrimaryBaseWasVirtual();
1084 }
1085
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001086 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1087 E = RD->bases_end(); I != E; ++I) {
1088 assert(!I->getType()->isDependentType() &&
Sebastian Redl1054fae2009-10-25 17:03:50 +00001089 "Cannot layout class with dependent bases.");
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001090
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001091 const CXXRecordDecl *BaseDecl =
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001092 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1093
1094 if (I->isVirtual()) {
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001095 if (PrimaryBase != BaseDecl || !PrimaryBaseIsVirtual) {
1096 bool IndirectPrimaryBase = IndirectPrimaryBases.count(BaseDecl);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001097
Anders Carlsson291279e2010-04-10 18:42:27 +00001098 // Only lay out the virtual base if it's not an indirect primary base.
1099 if (!IndirectPrimaryBase) {
1100 // Only visit virtual bases once.
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001101 if (!VisitedVirtualBases.insert(BaseDecl))
Anders Carlsson291279e2010-04-10 18:42:27 +00001102 continue;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001103
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001104 const BaseSubobjectInfo *BaseInfo = VirtualBaseInfo.lookup(BaseDecl);
1105 assert(BaseInfo && "Did not find virtual base info!");
1106 LayoutVirtualBase(BaseInfo);
Anders Carlsson6a848892010-03-11 04:10:39 +00001107 }
Mike Stump2b84dd32009-11-05 04:02:15 +00001108 }
Mike Stumpc2f591b2009-08-13 22:53:07 +00001109 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001110
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001111 if (!BaseDecl->getNumVBases()) {
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001112 // This base isn't interesting since it doesn't have any virtual bases.
1113 continue;
Mike Stump996576f32009-08-16 19:04:13 +00001114 }
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001115
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001116 LayoutVirtualBases(BaseDecl, MostDerivedClass);
Mike Stump6b2556f2009-08-06 13:41:24 +00001117 }
1118}
1119
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001120void RecordLayoutBuilder::LayoutVirtualBase(const BaseSubobjectInfo *Base) {
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001121 assert(!Base->Derived && "Trying to lay out a primary virtual base!");
1122
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001123 // Layout the base.
Anders Carlssona2f8e412010-10-31 22:20:42 +00001124 CharUnits Offset = LayoutBase(Base);
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001125
1126 // Add its base class offset.
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001127 assert(!VBases.count(Base->Class) && "vbase offset already exists!");
Anders Carlssona2f8e412010-10-31 22:20:42 +00001128 VBases.insert(std::make_pair(Base->Class, Offset));
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001129
1130 AddPrimaryVirtualBaseOffsets(Base, Offset);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001131}
1132
Anders Carlssona2f8e412010-10-31 22:20:42 +00001133CharUnits RecordLayoutBuilder::LayoutBase(const BaseSubobjectInfo *Base) {
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001134 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Base->Class);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001135
1136 // If we have an empty base class, try to place it at offset 0.
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001137 if (Base->Class->isEmpty() &&
Anders Carlsson28466ab2010-10-31 22:13:23 +00001138 EmptySubobjects->CanPlaceBaseAtOffset(Base, CharUnits::Zero())) {
Anders Carlsson2357bfd2010-05-08 22:35:05 +00001139 Size = std::max(Size, Layout.getSize());
Anders Carlsson09ffa322010-03-10 22:21:28 +00001140
Anders Carlssona2f8e412010-10-31 22:20:42 +00001141 return CharUnits::Zero();
Anders Carlsson09ffa322010-03-10 22:21:28 +00001142 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001143
Anders Carlsson2357bfd2010-05-08 22:35:05 +00001144 unsigned BaseAlign = Layout.getNonVirtualAlign();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001145
Anders Carlsson09ffa322010-03-10 22:21:28 +00001146 // Round up the current record size to the base's alignment boundary.
1147 uint64_t Offset = llvm::RoundUpToAlignment(DataSize, BaseAlign);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001148
Anders Carlsson09ffa322010-03-10 22:21:28 +00001149 // Try to place the base.
Anders Carlsson28466ab2010-10-31 22:13:23 +00001150 while (!EmptySubobjects->CanPlaceBaseAtOffset(Base, toCharUnits(Offset)))
Anders Carlsson09ffa322010-03-10 22:21:28 +00001151 Offset += BaseAlign;
Anders Carlsson09ffa322010-03-10 22:21:28 +00001152
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001153 if (!Base->Class->isEmpty()) {
Anders Carlsson09ffa322010-03-10 22:21:28 +00001154 // Update the data size.
Anders Carlsson2357bfd2010-05-08 22:35:05 +00001155 DataSize = Offset + Layout.getNonVirtualSize();
Anders Carlsson09ffa322010-03-10 22:21:28 +00001156
1157 Size = std::max(Size, DataSize);
1158 } else
Anders Carlsson2357bfd2010-05-08 22:35:05 +00001159 Size = std::max(Size, Offset + Layout.getSize());
Anders Carlsson09ffa322010-03-10 22:21:28 +00001160
1161 // Remember max struct/class alignment.
1162 UpdateAlignment(BaseAlign);
1163
Anders Carlssona2f8e412010-10-31 22:20:42 +00001164 return toCharUnits(Offset);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001165}
1166
Daniel Dunbar6da10982010-05-27 05:45:51 +00001167void RecordLayoutBuilder::InitializeLayout(const Decl *D) {
1168 if (const RecordDecl *RD = dyn_cast<RecordDecl>(D))
1169 IsUnion = RD->isUnion();
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001170
Anders Carlsson28a5fa22009-08-08 19:38:24 +00001171 Packed = D->hasAttr<PackedAttr>();
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001172
Daniel Dunbar6da10982010-05-27 05:45:51 +00001173 // mac68k alignment supersedes maximum field alignment and attribute aligned,
1174 // and forces all structures to have 2-byte alignment. The IBM docs on it
1175 // allude to additional (more complicated) semantics, especially with regard
1176 // to bit-fields, but gcc appears not to follow that.
1177 if (D->hasAttr<AlignMac68kAttr>()) {
1178 IsMac68kAlign = true;
1179 MaxFieldAlignment = 2 * 8;
1180 Alignment = 2 * 8;
1181 } else {
1182 if (const MaxFieldAlignmentAttr *MFAA = D->getAttr<MaxFieldAlignmentAttr>())
1183 MaxFieldAlignment = MFAA->getAlignment();
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001184
Alexis Huntdcfba7b2010-08-18 23:23:40 +00001185 if (unsigned MaxAlign = D->getMaxAlignment())
1186 UpdateAlignment(MaxAlign);
Daniel Dunbar6da10982010-05-27 05:45:51 +00001187 }
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001188}
Anders Carlsson6d9f6f32009-07-19 00:18:47 +00001189
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001190void RecordLayoutBuilder::Layout(const RecordDecl *D) {
1191 InitializeLayout(D);
Anders Carlsson118ce162009-07-18 21:48:39 +00001192 LayoutFields(D);
Mike Stump11289f42009-09-09 15:08:12 +00001193
Anders Carlsson79474332009-07-18 20:20:21 +00001194 // Finally, round the size of the total struct up to the alignment of the
1195 // struct itself.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001196 FinishLayout(D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001197}
1198
1199void RecordLayoutBuilder::Layout(const CXXRecordDecl *RD) {
1200 InitializeLayout(RD);
1201
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001202 // Lay out the vtable and the non-virtual bases.
1203 LayoutNonVirtualBases(RD);
1204
1205 LayoutFields(RD);
1206
1207 NonVirtualSize = Size;
1208 NonVirtualAlignment = Alignment;
1209
1210 // Lay out the virtual bases and add the primary virtual base offsets.
1211 LayoutVirtualBases(RD, RD);
1212
1213 VisitedVirtualBases.clear();
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001214
1215 // Finally, round the size of the total struct up to the alignment of the
1216 // struct itself.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001217 FinishLayout(RD);
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001218
Anders Carlsson5b441d72010-04-10 21:24:48 +00001219#ifndef NDEBUG
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001220 // Check that we have base offsets for all bases.
1221 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1222 E = RD->bases_end(); I != E; ++I) {
1223 if (I->isVirtual())
1224 continue;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001225
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001226 const CXXRecordDecl *BaseDecl =
1227 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1228
1229 assert(Bases.count(BaseDecl) && "Did not find base offset!");
1230 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001231
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001232 // And all virtual bases.
1233 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
1234 E = RD->vbases_end(); I != E; ++I) {
1235 const CXXRecordDecl *BaseDecl =
1236 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001237
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001238 assert(VBases.count(BaseDecl) && "Did not find base offset!");
Anders Carlsson5b441d72010-04-10 21:24:48 +00001239 }
1240#endif
Anders Carlsson79474332009-07-18 20:20:21 +00001241}
1242
Anders Carlssonc2226202010-05-26 05:58:59 +00001243void RecordLayoutBuilder::Layout(const ObjCInterfaceDecl *D) {
Anders Carlsson4f516282009-07-18 20:50:59 +00001244 if (ObjCInterfaceDecl *SD = D->getSuperClass()) {
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001245 const ASTRecordLayout &SL = Context.getASTObjCInterfaceLayout(SD);
Anders Carlsson4f516282009-07-18 20:50:59 +00001246
1247 UpdateAlignment(SL.getAlignment());
Mike Stump11289f42009-09-09 15:08:12 +00001248
Anders Carlsson4f516282009-07-18 20:50:59 +00001249 // We start laying out ivars not at the end of the superclass
1250 // structure, but at the next byte following the last field.
Anders Carlsson27b50132009-07-18 21:26:44 +00001251 Size = llvm::RoundUpToAlignment(SL.getDataSize(), 8);
Anders Carlsson47680d82009-09-26 01:34:51 +00001252 DataSize = Size;
Anders Carlsson4f516282009-07-18 20:50:59 +00001253 }
Mike Stump11289f42009-09-09 15:08:12 +00001254
Daniel Dunbar6da10982010-05-27 05:45:51 +00001255 InitializeLayout(D);
Daniel Dunbar40130442010-05-27 01:12:46 +00001256
Anders Carlsson4f516282009-07-18 20:50:59 +00001257 // Layout each ivar sequentially.
1258 llvm::SmallVector<ObjCIvarDecl*, 16> Ivars;
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001259 Context.ShallowCollectObjCIvars(D, Ivars);
Anders Carlsson4f516282009-07-18 20:50:59 +00001260 for (unsigned i = 0, e = Ivars.size(); i != e; ++i)
1261 LayoutField(Ivars[i]);
Mike Stump11289f42009-09-09 15:08:12 +00001262
Anders Carlsson4f516282009-07-18 20:50:59 +00001263 // Finally, round the size of the total struct up to the alignment of the
1264 // struct itself.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001265 FinishLayout(D);
Anders Carlsson4f516282009-07-18 20:50:59 +00001266}
1267
Anders Carlssonc2226202010-05-26 05:58:59 +00001268void RecordLayoutBuilder::LayoutFields(const RecordDecl *D) {
Anders Carlsson118ce162009-07-18 21:48:39 +00001269 // Layout each field, for now, just sequentially, respecting alignment. In
1270 // the future, this will need to be tweakable by targets.
Mike Stump11289f42009-09-09 15:08:12 +00001271 for (RecordDecl::field_iterator Field = D->field_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001272 FieldEnd = D->field_end(); Field != FieldEnd; ++Field)
Anders Carlsson118ce162009-07-18 21:48:39 +00001273 LayoutField(*Field);
1274}
1275
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001276void RecordLayoutBuilder::LayoutWideBitField(uint64_t FieldSize,
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001277 uint64_t TypeSize,
1278 bool FieldPacked,
1279 const FieldDecl *D) {
Anders Carlsson57235162010-04-16 15:57:11 +00001280 assert(Context.getLangOptions().CPlusPlus &&
1281 "Can only have wide bit-fields in C++!");
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001282
Anders Carlsson57235162010-04-16 15:57:11 +00001283 // Itanium C++ ABI 2.4:
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001284 // If sizeof(T)*8 < n, let T' be the largest integral POD type with
Anders Carlsson57235162010-04-16 15:57:11 +00001285 // sizeof(T')*8 <= n.
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001286
Anders Carlsson57235162010-04-16 15:57:11 +00001287 QualType IntegralPODTypes[] = {
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001288 Context.UnsignedCharTy, Context.UnsignedShortTy, Context.UnsignedIntTy,
Anders Carlsson57235162010-04-16 15:57:11 +00001289 Context.UnsignedLongTy, Context.UnsignedLongLongTy
1290 };
1291
Anders Carlsson57235162010-04-16 15:57:11 +00001292 QualType Type;
1293 for (unsigned I = 0, E = llvm::array_lengthof(IntegralPODTypes);
1294 I != E; ++I) {
1295 uint64_t Size = Context.getTypeSize(IntegralPODTypes[I]);
Anders Carlsson57235162010-04-16 15:57:11 +00001296
1297 if (Size > FieldSize)
1298 break;
1299
1300 Type = IntegralPODTypes[I];
1301 }
1302 assert(!Type.isNull() && "Did not find a type!");
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001303
Anders Carlsson57235162010-04-16 15:57:11 +00001304 unsigned TypeAlign = Context.getTypeAlign(Type);
1305
1306 // We're not going to use any of the unfilled bits in the last byte.
1307 UnfilledBitsInLastByte = 0;
1308
Anders Carlssonaad5fa82010-04-17 20:21:41 +00001309 uint64_t FieldOffset;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001310 uint64_t UnpaddedFieldOffset = DataSize - UnfilledBitsInLastByte;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001311
Anders Carlsson57235162010-04-16 15:57:11 +00001312 if (IsUnion) {
1313 DataSize = std::max(DataSize, FieldSize);
Anders Carlssonaad5fa82010-04-17 20:21:41 +00001314 FieldOffset = 0;
Anders Carlsson57235162010-04-16 15:57:11 +00001315 } else {
Anders Carlssonaad5fa82010-04-17 20:21:41 +00001316 // The bitfield is allocated starting at the next offset aligned appropriately
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001317 // for T', with length n bits.
Anders Carlssonaad5fa82010-04-17 20:21:41 +00001318 FieldOffset = llvm::RoundUpToAlignment(DataSize, TypeAlign);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001319
Anders Carlsson57235162010-04-16 15:57:11 +00001320 uint64_t NewSizeInBits = FieldOffset + FieldSize;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001321
Anders Carlsson57235162010-04-16 15:57:11 +00001322 DataSize = llvm::RoundUpToAlignment(NewSizeInBits, 8);
1323 UnfilledBitsInLastByte = DataSize - NewSizeInBits;
1324 }
1325
1326 // Place this field at the current location.
1327 FieldOffsets.push_back(FieldOffset);
1328
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001329 CheckFieldPadding(FieldOffset, UnpaddedFieldOffset, FieldOffset,
1330 TypeAlign, FieldPacked, D);
1331
Anders Carlsson57235162010-04-16 15:57:11 +00001332 // Update the size.
1333 Size = std::max(Size, DataSize);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001334
Anders Carlsson57235162010-04-16 15:57:11 +00001335 // Remember max struct/class alignment.
1336 UpdateAlignment(TypeAlign);
1337}
1338
Anders Carlssonc2226202010-05-26 05:58:59 +00001339void RecordLayoutBuilder::LayoutBitField(const FieldDecl *D) {
Anders Carlsson07209442009-11-22 17:37:31 +00001340 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001341 uint64_t UnpaddedFieldOffset = DataSize - UnfilledBitsInLastByte;
1342 uint64_t FieldOffset = IsUnion ? 0 : UnpaddedFieldOffset;
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001343 uint64_t FieldSize = D->getBitWidth()->EvaluateAsInt(Context).getZExtValue();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001344
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001345 std::pair<uint64_t, unsigned> FieldInfo = Context.getTypeInfo(D->getType());
Anders Carlsson07209442009-11-22 17:37:31 +00001346 uint64_t TypeSize = FieldInfo.first;
1347 unsigned FieldAlign = FieldInfo.second;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001348
Anders Carlsson57235162010-04-16 15:57:11 +00001349 if (FieldSize > TypeSize) {
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001350 LayoutWideBitField(FieldSize, TypeSize, FieldPacked, D);
Anders Carlsson57235162010-04-16 15:57:11 +00001351 return;
1352 }
1353
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001354 // The align if the field is not packed. This is to check if the attribute
1355 // was unnecessary (-Wpacked).
1356 unsigned UnpackedFieldAlign = FieldAlign;
1357 uint64_t UnpackedFieldOffset = FieldOffset;
1358 if (!Context.Target.useBitFieldTypeAlignment())
1359 UnpackedFieldAlign = 1;
1360
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001361 if (FieldPacked || !Context.Target.useBitFieldTypeAlignment())
Anders Carlsson07209442009-11-22 17:37:31 +00001362 FieldAlign = 1;
Alexis Huntdcfba7b2010-08-18 23:23:40 +00001363 FieldAlign = std::max(FieldAlign, D->getMaxAlignment());
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001364 UnpackedFieldAlign = std::max(UnpackedFieldAlign, D->getMaxAlignment());
Anders Carlsson07209442009-11-22 17:37:31 +00001365
1366 // The maximum field alignment overrides the aligned attribute.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001367 if (MaxFieldAlignment) {
Anders Carlsson07209442009-11-22 17:37:31 +00001368 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001369 UnpackedFieldAlign = std::min(UnpackedFieldAlign, MaxFieldAlignment);
1370 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001371
Daniel Dunbar3d9289c2010-04-15 06:18:39 +00001372 // Check if we need to add padding to give the field the correct alignment.
Anders Carlsson07209442009-11-22 17:37:31 +00001373 if (FieldSize == 0 || (FieldOffset & (FieldAlign-1)) + FieldSize > TypeSize)
Daniel Dunbarf35e7652010-06-29 18:34:35 +00001374 FieldOffset = llvm::RoundUpToAlignment(FieldOffset, FieldAlign);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001375
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001376 if (FieldSize == 0 ||
1377 (UnpackedFieldOffset & (UnpackedFieldAlign-1)) + FieldSize > TypeSize)
1378 UnpackedFieldOffset = llvm::RoundUpToAlignment(UnpackedFieldOffset,
1379 UnpackedFieldAlign);
1380
Daniel Dunbar3d9289c2010-04-15 06:18:39 +00001381 // Padding members don't affect overall alignment.
Anders Carlsson07209442009-11-22 17:37:31 +00001382 if (!D->getIdentifier())
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001383 FieldAlign = UnpackedFieldAlign = 1;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001384
Anders Carlsson07209442009-11-22 17:37:31 +00001385 // Place this field at the current location.
1386 FieldOffsets.push_back(FieldOffset);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001387
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001388 CheckFieldPadding(FieldOffset, UnpaddedFieldOffset, UnpackedFieldOffset,
1389 UnpackedFieldAlign, FieldPacked, D);
1390
Anders Carlssonba958402009-11-22 19:13:51 +00001391 // Update DataSize to include the last byte containing (part of) the bitfield.
1392 if (IsUnion) {
1393 // FIXME: I think FieldSize should be TypeSize here.
1394 DataSize = std::max(DataSize, FieldSize);
1395 } else {
1396 uint64_t NewSizeInBits = FieldOffset + FieldSize;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001397
Anders Carlssonba958402009-11-22 19:13:51 +00001398 DataSize = llvm::RoundUpToAlignment(NewSizeInBits, 8);
1399 UnfilledBitsInLastByte = DataSize - NewSizeInBits;
1400 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001401
Anders Carlssonba958402009-11-22 19:13:51 +00001402 // Update the size.
1403 Size = std::max(Size, DataSize);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001404
Anders Carlsson07209442009-11-22 17:37:31 +00001405 // Remember max struct/class alignment.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001406 UpdateAlignment(FieldAlign, UnpackedFieldAlign);
Anders Carlsson07209442009-11-22 17:37:31 +00001407}
1408
Anders Carlssonc2226202010-05-26 05:58:59 +00001409void RecordLayoutBuilder::LayoutField(const FieldDecl *D) {
Anders Carlsson07209442009-11-22 17:37:31 +00001410 if (D->isBitField()) {
1411 LayoutBitField(D);
1412 return;
1413 }
1414
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001415 uint64_t UnpaddedFieldOffset = DataSize - UnfilledBitsInLastByte;
1416
Anders Carlssonba958402009-11-22 19:13:51 +00001417 // Reset the unfilled bits.
1418 UnfilledBitsInLastByte = 0;
1419
Anders Carlsson07209442009-11-22 17:37:31 +00001420 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Anders Carlsson47680d82009-09-26 01:34:51 +00001421 uint64_t FieldOffset = IsUnion ? 0 : DataSize;
Anders Carlsson79474332009-07-18 20:20:21 +00001422 uint64_t FieldSize;
1423 unsigned FieldAlign;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001424
Anders Carlsson07209442009-11-22 17:37:31 +00001425 if (D->getType()->isIncompleteArrayType()) {
1426 // This is a flexible array member; we can't directly
1427 // query getTypeInfo about these, so we figure it out here.
1428 // Flexible array members don't have any size, but they
1429 // have to be aligned appropriately for their element type.
1430 FieldSize = 0;
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001431 const ArrayType* ATy = Context.getAsArrayType(D->getType());
1432 FieldAlign = Context.getTypeAlign(ATy->getElementType());
Anders Carlsson07209442009-11-22 17:37:31 +00001433 } else if (const ReferenceType *RT = D->getType()->getAs<ReferenceType>()) {
1434 unsigned AS = RT->getPointeeType().getAddressSpace();
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001435 FieldSize = Context.Target.getPointerWidth(AS);
1436 FieldAlign = Context.Target.getPointerAlign(AS);
Anders Carlsson79474332009-07-18 20:20:21 +00001437 } else {
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001438 std::pair<uint64_t, unsigned> FieldInfo = Context.getTypeInfo(D->getType());
Anders Carlsson07209442009-11-22 17:37:31 +00001439 FieldSize = FieldInfo.first;
1440 FieldAlign = FieldInfo.second;
Anders Carlsson79474332009-07-18 20:20:21 +00001441 }
Mike Stump11289f42009-09-09 15:08:12 +00001442
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001443 // The align if the field is not packed. This is to check if the attribute
1444 // was unnecessary (-Wpacked).
1445 unsigned UnpackedFieldAlign = FieldAlign;
1446 uint64_t UnpackedFieldOffset = FieldOffset;
1447
Anders Carlsson07209442009-11-22 17:37:31 +00001448 if (FieldPacked)
1449 FieldAlign = 8;
Alexis Huntdcfba7b2010-08-18 23:23:40 +00001450 FieldAlign = std::max(FieldAlign, D->getMaxAlignment());
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001451 UnpackedFieldAlign = std::max(UnpackedFieldAlign, D->getMaxAlignment());
Anders Carlsson07209442009-11-22 17:37:31 +00001452
1453 // The maximum field alignment overrides the aligned attribute.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001454 if (MaxFieldAlignment) {
Anders Carlsson07209442009-11-22 17:37:31 +00001455 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001456 UnpackedFieldAlign = std::min(UnpackedFieldAlign, MaxFieldAlignment);
1457 }
Anders Carlsson07209442009-11-22 17:37:31 +00001458
1459 // Round up the current record size to the field's alignment boundary.
1460 FieldOffset = llvm::RoundUpToAlignment(FieldOffset, FieldAlign);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001461 UnpackedFieldOffset = llvm::RoundUpToAlignment(UnpackedFieldOffset,
1462 UnpackedFieldAlign);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001463
Anders Carlssonb1fcdd02010-05-30 06:52:33 +00001464 if (!IsUnion && EmptySubobjects) {
1465 // Check if we can place the field at this offset.
Anders Carlsson28466ab2010-10-31 22:13:23 +00001466 while (!EmptySubobjects->CanPlaceFieldAtOffset(D,
1467 toCharUnits(FieldOffset))) {
Anders Carlsson07209442009-11-22 17:37:31 +00001468 // We couldn't place the field at the offset. Try again at a new offset.
1469 FieldOffset += FieldAlign;
1470 }
Anders Carlsson07209442009-11-22 17:37:31 +00001471 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001472
Anders Carlsson79474332009-07-18 20:20:21 +00001473 // Place this field at the current location.
1474 FieldOffsets.push_back(FieldOffset);
Mike Stump11289f42009-09-09 15:08:12 +00001475
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001476 CheckFieldPadding(FieldOffset, UnpaddedFieldOffset, UnpackedFieldOffset,
1477 UnpackedFieldAlign, FieldPacked, D);
1478
Anders Carlsson79474332009-07-18 20:20:21 +00001479 // Reserve space for this field.
1480 if (IsUnion)
1481 Size = std::max(Size, FieldSize);
1482 else
1483 Size = FieldOffset + FieldSize;
Mike Stump11289f42009-09-09 15:08:12 +00001484
Anders Carlsson47680d82009-09-26 01:34:51 +00001485 // Update the data size.
1486 DataSize = Size;
Mike Stump11289f42009-09-09 15:08:12 +00001487
Anders Carlsson79474332009-07-18 20:20:21 +00001488 // Remember max struct/class alignment.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001489 UpdateAlignment(FieldAlign, UnpackedFieldAlign);
Anders Carlsson79474332009-07-18 20:20:21 +00001490}
1491
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001492void RecordLayoutBuilder::FinishLayout(const NamedDecl *D) {
Anders Carlsson79474332009-07-18 20:20:21 +00001493 // In C++, records cannot be of size 0.
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001494 if (Context.getLangOptions().CPlusPlus && Size == 0)
Anders Carlsson79474332009-07-18 20:20:21 +00001495 Size = 8;
1496 // Finally, round the size of the record up to the alignment of the
1497 // record itself.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001498 uint64_t UnpaddedSize = Size - UnfilledBitsInLastByte;
1499 uint64_t UnpackedSize = llvm::RoundUpToAlignment(Size, UnpackedAlignment);
Anders Carlsson07209442009-11-22 17:37:31 +00001500 Size = llvm::RoundUpToAlignment(Size, Alignment);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001501
1502 unsigned CharBitNum = Context.Target.getCharWidth();
1503 if (const RecordDecl *RD = dyn_cast<RecordDecl>(D)) {
1504 // Warn if padding was introduced to the struct/class/union.
1505 if (Size > UnpaddedSize) {
1506 unsigned PadSize = Size - UnpaddedSize;
1507 bool InBits = true;
1508 if (PadSize % CharBitNum == 0) {
1509 PadSize = PadSize / CharBitNum;
1510 InBits = false;
1511 }
1512 Diag(RD->getLocation(), diag::warn_padded_struct_size)
1513 << Context.getTypeDeclType(RD)
1514 << PadSize
1515 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1); // plural or not
1516 }
1517
1518 // Warn if we packed it unnecessarily. If the alignment is 1 byte don't
1519 // bother since there won't be alignment issues.
1520 if (Packed && UnpackedAlignment > CharBitNum && Size == UnpackedSize)
1521 Diag(D->getLocation(), diag::warn_unnecessary_packed)
1522 << Context.getTypeDeclType(RD);
1523 }
Anders Carlsson79474332009-07-18 20:20:21 +00001524}
1525
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001526void RecordLayoutBuilder::UpdateAlignment(unsigned NewAlignment,
1527 unsigned UnpackedNewAlignment) {
Daniel Dunbar6da10982010-05-27 05:45:51 +00001528 // The alignment is not modified when using 'mac68k' alignment.
1529 if (IsMac68kAlign)
1530 return;
1531
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001532 if (NewAlignment > Alignment) {
1533 assert(llvm::isPowerOf2_32(NewAlignment && "Alignment not a power of 2"));
1534 Alignment = NewAlignment;
1535 }
1536
1537 if (UnpackedNewAlignment > UnpackedAlignment) {
1538 assert(llvm::isPowerOf2_32(UnpackedNewAlignment &&
1539 "Alignment not a power of 2"));
1540 UnpackedAlignment = UnpackedNewAlignment;
1541 }
1542}
1543
1544void RecordLayoutBuilder::CheckFieldPadding(uint64_t Offset,
1545 uint64_t UnpaddedOffset,
1546 uint64_t UnpackedOffset,
1547 unsigned UnpackedAlign,
1548 bool isPacked,
1549 const FieldDecl *D) {
1550 // We let objc ivars without warning, objc interfaces generally are not used
1551 // for padding tricks.
1552 if (isa<ObjCIvarDecl>(D))
Anders Carlsson79474332009-07-18 20:20:21 +00001553 return;
Mike Stump11289f42009-09-09 15:08:12 +00001554
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001555 unsigned CharBitNum = Context.Target.getCharWidth();
Mike Stump11289f42009-09-09 15:08:12 +00001556
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001557 // Warn if padding was introduced to the struct/class.
1558 if (!IsUnion && Offset > UnpaddedOffset) {
1559 unsigned PadSize = Offset - UnpaddedOffset;
1560 bool InBits = true;
1561 if (PadSize % CharBitNum == 0) {
1562 PadSize = PadSize / CharBitNum;
1563 InBits = false;
1564 }
1565 if (D->getIdentifier())
1566 Diag(D->getLocation(), diag::warn_padded_struct_field)
1567 << (D->getParent()->isStruct() ? 0 : 1) // struct|class
1568 << Context.getTypeDeclType(D->getParent())
1569 << PadSize
1570 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1) // plural or not
1571 << D->getIdentifier();
1572 else
1573 Diag(D->getLocation(), diag::warn_padded_struct_anon_field)
1574 << (D->getParent()->isStruct() ? 0 : 1) // struct|class
1575 << Context.getTypeDeclType(D->getParent())
1576 << PadSize
1577 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1); // plural or not
1578 }
1579
1580 // Warn if we packed it unnecessarily. If the alignment is 1 byte don't
1581 // bother since there won't be alignment issues.
1582 if (isPacked && UnpackedAlign > CharBitNum && Offset == UnpackedOffset)
1583 Diag(D->getLocation(), diag::warn_unnecessary_packed)
1584 << D->getIdentifier();
Anders Carlsson79474332009-07-18 20:20:21 +00001585}
Mike Stump11289f42009-09-09 15:08:12 +00001586
Anders Carlsson5ebf8b42009-12-07 04:35:11 +00001587const CXXMethodDecl *
Anders Carlssonc2226202010-05-26 05:58:59 +00001588RecordLayoutBuilder::ComputeKeyFunction(const CXXRecordDecl *RD) {
Daniel Dunbarccabe482010-04-19 20:44:53 +00001589 // If a class isn't polymorphic it doesn't have a key function.
Anders Carlsson5ebf8b42009-12-07 04:35:11 +00001590 if (!RD->isPolymorphic())
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001591 return 0;
Eli Friedmanf2c79b62009-12-08 03:56:49 +00001592
1593 // A class inside an anonymous namespace doesn't have a key function. (Or
1594 // at least, there's no point to assigning a key function to such a class;
1595 // this doesn't affect the ABI.)
1596 if (RD->isInAnonymousNamespace())
1597 return 0;
1598
Argyrios Kyrtzidis8c64bbe2010-10-13 02:39:41 +00001599 // Template instantiations don't have key functions,see Itanium C++ ABI 5.2.6.
1600 // Same behavior as GCC.
1601 TemplateSpecializationKind TSK = RD->getTemplateSpecializationKind();
1602 if (TSK == TSK_ImplicitInstantiation ||
1603 TSK == TSK_ExplicitInstantiationDefinition)
1604 return 0;
1605
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001606 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
1607 E = RD->method_end(); I != E; ++I) {
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001608 const CXXMethodDecl *MD = *I;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001609
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001610 if (!MD->isVirtual())
1611 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001612
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001613 if (MD->isPure())
1614 continue;
Eli Friedmanf2c79b62009-12-08 03:56:49 +00001615
Anders Carlssonf98849e2009-12-02 17:15:43 +00001616 // Ignore implicit member functions, they are always marked as inline, but
1617 // they don't have a body until they're defined.
1618 if (MD->isImplicit())
1619 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001620
Douglas Gregora318efd2010-01-05 19:06:31 +00001621 if (MD->isInlineSpecified())
1622 continue;
Eli Friedman71a26d82009-12-06 20:50:05 +00001623
1624 if (MD->hasInlineBody())
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001625 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001626
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001627 // We found it.
1628 return MD;
1629 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001630
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001631 return 0;
1632}
1633
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001634DiagnosticBuilder
1635RecordLayoutBuilder::Diag(SourceLocation Loc, unsigned DiagID) {
1636 return Context.getDiagnostics().Report(
1637 FullSourceLoc(Loc, Context.getSourceManager()), DiagID);
1638}
1639
Benjamin Kramer2fc373e2010-10-22 16:33:16 +00001640namespace {
1641 // This class implements layout specific to the Microsoft ABI.
1642 class MSRecordLayoutBuilder : public RecordLayoutBuilder {
1643 public:
1644 MSRecordLayoutBuilder(ASTContext& Ctx, EmptySubobjectMap *EmptySubobjects) :
1645 RecordLayoutBuilder(Ctx, EmptySubobjects) {}
Charles Davisc2c576a2010-08-19 00:55:19 +00001646
Benjamin Kramer2fc373e2010-10-22 16:33:16 +00001647 virtual bool IsNearlyEmpty(const CXXRecordDecl *RD) const;
1648 virtual uint64_t GetVirtualPointersSize(const CXXRecordDecl *RD) const;
1649 };
1650}
Charles Davisc2c576a2010-08-19 00:55:19 +00001651
1652bool MSRecordLayoutBuilder::IsNearlyEmpty(const CXXRecordDecl *RD) const {
1653 // FIXME: Audit the corners
1654 if (!RD->isDynamicClass())
1655 return false;
1656 const ASTRecordLayout &BaseInfo = Context.getASTRecordLayout(RD);
1657 // In the Microsoft ABI, classes can have one or two vtable pointers.
1658 if (BaseInfo.getNonVirtualSize() == Context.Target.getPointerWidth(0) ||
1659 BaseInfo.getNonVirtualSize() == Context.Target.getPointerWidth(0) * 2)
1660 return true;
1661 return false;
1662}
1663
1664uint64_t
1665MSRecordLayoutBuilder::GetVirtualPointersSize(const CXXRecordDecl *RD) const {
1666 // We should reserve space for two pointers if the class has both
1667 // virtual functions and virtual bases.
1668 if (RD->isPolymorphic() && RD->getNumVBases() > 0)
1669 return 2 * Context.Target.getPointerWidth(0);
1670 return Context.Target.getPointerWidth(0);
1671}
1672
Anders Carlssondf291d82010-05-26 04:56:53 +00001673/// getASTRecordLayout - Get or compute information about the layout of the
1674/// specified record (struct/union/class), which indicates its size and field
1675/// position information.
1676const ASTRecordLayout &ASTContext::getASTRecordLayout(const RecordDecl *D) {
1677 D = D->getDefinition();
1678 assert(D && "Cannot get layout of forward declarations!");
1679
1680 // Look up this layout, if already laid out, return what we have.
1681 // Note that we can't save a reference to the entry because this function
1682 // is recursive.
1683 const ASTRecordLayout *Entry = ASTRecordLayouts[D];
1684 if (Entry) return *Entry;
1685
Anders Carlssond2954862010-05-26 05:10:47 +00001686 const ASTRecordLayout *NewEntry;
1687
1688 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
Anders Carlssonc121b4e2010-05-27 00:07:01 +00001689 EmptySubobjectMap EmptySubobjects(*this, RD);
Anders Carlsson439edd12010-05-27 05:41:06 +00001690
Charles Davisc2c576a2010-08-19 00:55:19 +00001691 // When compiling for Microsoft, use the special MS builder.
Argyrios Kyrtzidis3c6cd172010-08-25 00:32:14 +00001692 llvm::OwningPtr<RecordLayoutBuilder> Builder;
Charles Davis6bcb07a2010-08-19 02:18:14 +00001693 switch (Target.getCXXABI()) {
1694 default:
Argyrios Kyrtzidis3c6cd172010-08-25 00:32:14 +00001695 Builder.reset(new RecordLayoutBuilder(*this, &EmptySubobjects));
Charles Davis6bcb07a2010-08-19 02:18:14 +00001696 break;
1697 case CXXABI_Microsoft:
Argyrios Kyrtzidis3c6cd172010-08-25 00:32:14 +00001698 Builder.reset(new MSRecordLayoutBuilder(*this, &EmptySubobjects));
Charles Davis6bcb07a2010-08-19 02:18:14 +00001699 }
Charles Davisc2c576a2010-08-19 00:55:19 +00001700 Builder->Layout(RD);
Anders Carlssond2954862010-05-26 05:10:47 +00001701
1702 // FIXME: This is not always correct. See the part about bitfields at
1703 // http://www.codesourcery.com/public/cxx-abi/abi.html#POD for more info.
1704 // FIXME: IsPODForThePurposeOfLayout should be stored in the record layout.
1705 bool IsPODForThePurposeOfLayout = cast<CXXRecordDecl>(D)->isPOD();
1706
1707 // FIXME: This should be done in FinalizeLayout.
1708 uint64_t DataSize =
Charles Davisc2c576a2010-08-19 00:55:19 +00001709 IsPODForThePurposeOfLayout ? Builder->Size : Builder->DataSize;
Anders Carlssond2954862010-05-26 05:10:47 +00001710 uint64_t NonVirtualSize =
Charles Davisc2c576a2010-08-19 00:55:19 +00001711 IsPODForThePurposeOfLayout ? DataSize : Builder->NonVirtualSize;
Anders Carlssond2954862010-05-26 05:10:47 +00001712
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001713 NewEntry =
Charles Davisc2c576a2010-08-19 00:55:19 +00001714 new (*this) ASTRecordLayout(*this, Builder->Size, Builder->Alignment,
1715 DataSize, Builder->FieldOffsets.data(),
1716 Builder->FieldOffsets.size(),
Anders Carlssond2954862010-05-26 05:10:47 +00001717 NonVirtualSize,
Charles Davisc2c576a2010-08-19 00:55:19 +00001718 Builder->NonVirtualAlignment,
Anders Carlssonc121b4e2010-05-27 00:07:01 +00001719 EmptySubobjects.SizeOfLargestEmptySubobject,
Charles Davisc2c576a2010-08-19 00:55:19 +00001720 Builder->PrimaryBase,
1721 Builder->PrimaryBaseIsVirtual,
1722 Builder->Bases, Builder->VBases);
Anders Carlssond2954862010-05-26 05:10:47 +00001723 } else {
Anders Carlssonc121b4e2010-05-27 00:07:01 +00001724 RecordLayoutBuilder Builder(*this, /*EmptySubobjects=*/0);
Anders Carlssond2954862010-05-26 05:10:47 +00001725 Builder.Layout(D);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001726
Anders Carlssond2954862010-05-26 05:10:47 +00001727 NewEntry =
1728 new (*this) ASTRecordLayout(*this, Builder.Size, Builder.Alignment,
1729 Builder.Size,
1730 Builder.FieldOffsets.data(),
1731 Builder.FieldOffsets.size());
1732 }
1733
Anders Carlssondf291d82010-05-26 04:56:53 +00001734 ASTRecordLayouts[D] = NewEntry;
1735
1736 if (getLangOptions().DumpRecordLayouts) {
1737 llvm::errs() << "\n*** Dumping AST Record Layout\n";
1738 DumpRecordLayout(D, llvm::errs());
1739 }
1740
1741 return *NewEntry;
1742}
1743
1744const CXXMethodDecl *ASTContext::getKeyFunction(const CXXRecordDecl *RD) {
1745 RD = cast<CXXRecordDecl>(RD->getDefinition());
1746 assert(RD && "Cannot get key function for forward declarations!");
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001747
Anders Carlssondf291d82010-05-26 04:56:53 +00001748 const CXXMethodDecl *&Entry = KeyFunctions[RD];
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001749 if (!Entry)
Anders Carlssonc2226202010-05-26 05:58:59 +00001750 Entry = RecordLayoutBuilder::ComputeKeyFunction(RD);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001751
Anders Carlssondf291d82010-05-26 04:56:53 +00001752 return Entry;
1753}
1754
1755/// getInterfaceLayoutImpl - Get or compute information about the
1756/// layout of the given interface.
1757///
1758/// \param Impl - If given, also include the layout of the interface's
1759/// implementation. This may differ by including synthesized ivars.
1760const ASTRecordLayout &
1761ASTContext::getObjCLayout(const ObjCInterfaceDecl *D,
1762 const ObjCImplementationDecl *Impl) {
1763 assert(!D->isForwardDecl() && "Invalid interface decl!");
1764
1765 // Look up this layout, if already laid out, return what we have.
1766 ObjCContainerDecl *Key =
1767 Impl ? (ObjCContainerDecl*) Impl : (ObjCContainerDecl*) D;
1768 if (const ASTRecordLayout *Entry = ObjCLayouts[Key])
1769 return *Entry;
1770
1771 // Add in synthesized ivar count if laying out an implementation.
1772 if (Impl) {
1773 unsigned SynthCount = CountNonClassIvars(D);
1774 // If there aren't any sythesized ivars then reuse the interface
1775 // entry. Note we can't cache this because we simply free all
1776 // entries later; however we shouldn't look up implementations
1777 // frequently.
1778 if (SynthCount == 0)
1779 return getObjCLayout(D, 0);
1780 }
1781
Anders Carlssonc121b4e2010-05-27 00:07:01 +00001782 RecordLayoutBuilder Builder(*this, /*EmptySubobjects=*/0);
Anders Carlsson6ed3a9a2010-05-26 05:04:25 +00001783 Builder.Layout(D);
1784
Anders Carlssondf291d82010-05-26 04:56:53 +00001785 const ASTRecordLayout *NewEntry =
Anders Carlsson6ed3a9a2010-05-26 05:04:25 +00001786 new (*this) ASTRecordLayout(*this, Builder.Size, Builder.Alignment,
1787 Builder.DataSize,
1788 Builder.FieldOffsets.data(),
1789 Builder.FieldOffsets.size());
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001790
Anders Carlssondf291d82010-05-26 04:56:53 +00001791 ObjCLayouts[Key] = NewEntry;
1792
1793 return *NewEntry;
1794}
1795
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001796static void PrintOffset(llvm::raw_ostream &OS,
Anders Carlsson3f018712010-10-31 23:45:59 +00001797 CharUnits Offset, unsigned IndentLevel) {
1798 OS << llvm::format("%4d | ", Offset.getQuantity());
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001799 OS.indent(IndentLevel * 2);
1800}
1801
1802static void DumpCXXRecordLayout(llvm::raw_ostream &OS,
1803 const CXXRecordDecl *RD, ASTContext &C,
Anders Carlsson3f018712010-10-31 23:45:59 +00001804 CharUnits Offset,
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001805 unsigned IndentLevel,
1806 const char* Description,
1807 bool IncludeVirtualBases) {
Anders Carlsson3f018712010-10-31 23:45:59 +00001808 const ASTRecordLayout &Layout = C.getASTRecordLayout(RD);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001809
1810 PrintOffset(OS, Offset, IndentLevel);
Dan Gohman145f3f12010-04-19 16:39:44 +00001811 OS << C.getTypeDeclType(const_cast<CXXRecordDecl *>(RD)).getAsString();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001812 if (Description)
1813 OS << ' ' << Description;
1814 if (RD->isEmpty())
1815 OS << " (empty)";
1816 OS << '\n';
1817
1818 IndentLevel++;
1819
Anders Carlsson3f018712010-10-31 23:45:59 +00001820 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001821
1822 // Vtable pointer.
1823 if (RD->isDynamicClass() && !PrimaryBase) {
1824 PrintOffset(OS, Offset, IndentLevel);
Benjamin Kramerb11416d2010-04-17 09:33:03 +00001825 OS << '(' << RD << " vtable pointer)\n";
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001826 }
1827 // Dump (non-virtual) bases
1828 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1829 E = RD->bases_end(); I != E; ++I) {
1830 assert(!I->getType()->isDependentType() &&
1831 "Cannot layout class with dependent bases.");
1832 if (I->isVirtual())
1833 continue;
1834
1835 const CXXRecordDecl *Base =
1836 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1837
Anders Carlsson3f018712010-10-31 23:45:59 +00001838 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001839
1840 DumpCXXRecordLayout(OS, Base, C, BaseOffset, IndentLevel,
1841 Base == PrimaryBase ? "(primary base)" : "(base)",
1842 /*IncludeVirtualBases=*/false);
1843 }
1844
1845 // Dump fields.
1846 uint64_t FieldNo = 0;
1847 for (CXXRecordDecl::field_iterator I = RD->field_begin(),
1848 E = RD->field_end(); I != E; ++I, ++FieldNo) {
1849 const FieldDecl *Field = *I;
Anders Carlsson3f018712010-10-31 23:45:59 +00001850 CharUnits FieldOffset = Offset +
1851 CharUnits::fromQuantity(Layout.getFieldOffset(FieldNo) /
1852 C.getCharWidth());
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001853
1854 if (const RecordType *RT = Field->getType()->getAs<RecordType>()) {
1855 if (const CXXRecordDecl *D = dyn_cast<CXXRecordDecl>(RT->getDecl())) {
1856 DumpCXXRecordLayout(OS, D, C, FieldOffset, IndentLevel,
Daniel Dunbar56df9772010-08-17 22:39:59 +00001857 Field->getName().data(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001858 /*IncludeVirtualBases=*/true);
1859 continue;
1860 }
1861 }
1862
1863 PrintOffset(OS, FieldOffset, IndentLevel);
Benjamin Kramerb11416d2010-04-17 09:33:03 +00001864 OS << Field->getType().getAsString() << ' ' << Field << '\n';
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001865 }
1866
1867 if (!IncludeVirtualBases)
1868 return;
1869
1870 // Dump virtual bases.
1871 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
1872 E = RD->vbases_end(); I != E; ++I) {
1873 assert(I->isVirtual() && "Found non-virtual class!");
1874 const CXXRecordDecl *VBase =
1875 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1876
Anders Carlsson3f018712010-10-31 23:45:59 +00001877 CharUnits VBaseOffset = Offset + Layout.getVBaseClassOffset(VBase);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001878 DumpCXXRecordLayout(OS, VBase, C, VBaseOffset, IndentLevel,
1879 VBase == PrimaryBase ?
1880 "(primary virtual base)" : "(virtual base)",
1881 /*IncludeVirtualBases=*/false);
1882 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001883
Anders Carlsson3f018712010-10-31 23:45:59 +00001884 OS << " sizeof=" << Layout.getSize() / 8;
1885 OS << ", dsize=" << Layout.getDataSize() / 8;
1886 OS << ", align=" << Layout.getAlignment() / 8 << '\n';
1887 OS << " nvsize=" << Layout.getNonVirtualSize() / 8;
1888 OS << ", nvalign=" << Layout.getNonVirtualAlign() / 8 << '\n';
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001889 OS << '\n';
1890}
Daniel Dunbarccabe482010-04-19 20:44:53 +00001891
1892void ASTContext::DumpRecordLayout(const RecordDecl *RD,
1893 llvm::raw_ostream &OS) {
1894 const ASTRecordLayout &Info = getASTRecordLayout(RD);
1895
1896 if (const CXXRecordDecl *CXXRD = dyn_cast<CXXRecordDecl>(RD))
Anders Carlsson3f018712010-10-31 23:45:59 +00001897 return DumpCXXRecordLayout(OS, CXXRD, *this, CharUnits(), 0, 0,
Daniel Dunbarccabe482010-04-19 20:44:53 +00001898 /*IncludeVirtualBases=*/true);
1899
1900 OS << "Type: " << getTypeDeclType(RD).getAsString() << "\n";
1901 OS << "Record: ";
1902 RD->dump();
1903 OS << "\nLayout: ";
1904 OS << "<ASTRecordLayout\n";
1905 OS << " Size:" << Info.getSize() << "\n";
1906 OS << " DataSize:" << Info.getDataSize() << "\n";
1907 OS << " Alignment:" << Info.getAlignment() << "\n";
1908 OS << " FieldOffsets: [";
1909 for (unsigned i = 0, e = Info.getFieldCount(); i != e; ++i) {
1910 if (i) OS << ", ";
1911 OS << Info.getFieldOffset(i);
1912 }
1913 OS << "]>\n";
1914}