blob: f73287503efcaf5b900ded14d0e2b32b5288ba3d [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"
Anders Carlsson5adde292010-11-24 22:55:48 +000011#include "clang/AST/CXXInheritance.h"
Anders Carlsson79474332009-07-18 20:20:21 +000012#include "clang/AST/Decl.h"
Anders Carlsson6d9f6f32009-07-19 00:18:47 +000013#include "clang/AST/DeclCXX.h"
Anders Carlsson4f516282009-07-18 20:50:59 +000014#include "clang/AST/DeclObjC.h"
Anders Carlsson79474332009-07-18 20:20:21 +000015#include "clang/AST/Expr.h"
Anders Carlsson35a36eb2010-05-26 05:41:04 +000016#include "clang/AST/RecordLayout.h"
Anders Carlsson79474332009-07-18 20:20:21 +000017#include "clang/Basic/TargetInfo.h"
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +000018#include "clang/Sema/SemaDiagnostic.h"
Daniel Dunbaraa423af2010-04-08 02:59:49 +000019#include "llvm/Support/Format.h"
20#include "llvm/ADT/SmallSet.h"
21#include "llvm/Support/MathExtras.h"
Ted Kremenekf75d0892011-03-19 01:00:36 +000022#include "llvm/Support/CrashRecoveryContext.h"
Anders Carlsson79474332009-07-18 20:20:21 +000023
24using namespace clang;
25
Benjamin Kramerc7656cd2010-05-26 09:58:31 +000026namespace {
Anders Carlssonf58de112010-05-26 15:32:58 +000027
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000028/// BaseSubobjectInfo - Represents a single base subobject in a complete class.
29/// For a class hierarchy like
30///
31/// class A { };
32/// class B : A { };
33/// class C : A, B { };
34///
35/// The BaseSubobjectInfo graph for C will have three BaseSubobjectInfo
36/// instances, one for B and two for A.
37///
38/// If a base is virtual, it will only have one BaseSubobjectInfo allocated.
39struct BaseSubobjectInfo {
40 /// Class - The class for this base info.
Anders Carlsson056818f2010-05-28 21:13:31 +000041 const CXXRecordDecl *Class;
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000042
43 /// IsVirtual - Whether the BaseInfo represents a virtual base or not.
Anders Carlsson056818f2010-05-28 21:13:31 +000044 bool IsVirtual;
45
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000046 /// Bases - Information about the base subobjects.
Chris Lattner0e62c1c2011-07-23 10:55:15 +000047 SmallVector<BaseSubobjectInfo*, 4> Bases;
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000048
Anders Carlssone3c24c72010-05-29 17:35:14 +000049 /// PrimaryVirtualBaseInfo - Holds the base info for the primary virtual base
50 /// of this base info (if one exists).
51 BaseSubobjectInfo *PrimaryVirtualBaseInfo;
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000052
53 // FIXME: Document.
54 const BaseSubobjectInfo *Derived;
Anders Carlsson056818f2010-05-28 21:13:31 +000055};
56
Anders Carlssonf58de112010-05-26 15:32:58 +000057/// EmptySubobjectMap - Keeps track of which empty subobjects exist at different
58/// offsets while laying out a C++ class.
59class EmptySubobjectMap {
Jay Foad39c79802011-01-12 09:06:06 +000060 const ASTContext &Context;
Anders Carlsson233e2722010-10-31 21:54:55 +000061 uint64_t CharWidth;
62
Anders Carlssonf58de112010-05-26 15:32:58 +000063 /// Class - The class whose empty entries we're keeping track of.
64 const CXXRecordDecl *Class;
Daniel Dunbar592a85c2010-05-27 02:25:46 +000065
Anders Carlsson439edd12010-05-27 05:41:06 +000066 /// EmptyClassOffsets - A map from offsets to empty record decls.
Chris Lattner0e62c1c2011-07-23 10:55:15 +000067 typedef SmallVector<const CXXRecordDecl *, 1> ClassVectorTy;
Anders Carlssonf8f756d2010-10-31 21:22:43 +000068 typedef llvm::DenseMap<CharUnits, ClassVectorTy> EmptyClassOffsetsMapTy;
Anders Carlsson439edd12010-05-27 05:41:06 +000069 EmptyClassOffsetsMapTy EmptyClassOffsets;
70
Anders Carlssoncc5de092010-06-08 15:56:03 +000071 /// MaxEmptyClassOffset - The highest offset known to contain an empty
72 /// base subobject.
Anders Carlsson725190f2010-10-31 21:39:24 +000073 CharUnits MaxEmptyClassOffset;
Anders Carlssoncc5de092010-06-08 15:56:03 +000074
Daniel Dunbar592a85c2010-05-27 02:25:46 +000075 /// ComputeEmptySubobjectSizes - Compute the size of the largest base or
Anders Carlssonc5ca1f72010-05-26 15:54:25 +000076 /// member subobject that is empty.
77 void ComputeEmptySubobjectSizes();
Anders Carlsson439edd12010-05-27 05:41:06 +000078
Anders Carlsson725190f2010-10-31 21:39:24 +000079 void AddSubobjectAtOffset(const CXXRecordDecl *RD, CharUnits Offset);
Anders Carlssondb319762010-05-27 18:20:57 +000080
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000081 void UpdateEmptyBaseSubobjects(const BaseSubobjectInfo *Info,
Anders Carlsson28466ab2010-10-31 22:13:23 +000082 CharUnits Offset, bool PlacingEmptyBase);
Anders Carlsson439edd12010-05-27 05:41:06 +000083
Anders Carlssondb319762010-05-27 18:20:57 +000084 void UpdateEmptyFieldSubobjects(const CXXRecordDecl *RD,
85 const CXXRecordDecl *Class,
Anders Carlsson28466ab2010-10-31 22:13:23 +000086 CharUnits Offset);
87 void UpdateEmptyFieldSubobjects(const FieldDecl *FD, CharUnits Offset);
Anders Carlssondb319762010-05-27 18:20:57 +000088
Anders Carlssoncc5de092010-06-08 15:56:03 +000089 /// AnyEmptySubobjectsBeyondOffset - Returns whether there are any empty
90 /// subobjects beyond the given offset.
Anders Carlsson725190f2010-10-31 21:39:24 +000091 bool AnyEmptySubobjectsBeyondOffset(CharUnits Offset) const {
Anders Carlssoncc5de092010-06-08 15:56:03 +000092 return Offset <= MaxEmptyClassOffset;
93 }
94
Anders Carlsson233e2722010-10-31 21:54:55 +000095 CharUnits
96 getFieldOffset(const ASTRecordLayout &Layout, unsigned FieldNo) const {
97 uint64_t FieldOffset = Layout.getFieldOffset(FieldNo);
98 assert(FieldOffset % CharWidth == 0 &&
99 "Field offset not at char boundary!");
100
Ken Dyck7c4026b2011-01-24 01:28:50 +0000101 return Context.toCharUnitsFromBits(FieldOffset);
Anders Carlssonf8f756d2010-10-31 21:22:43 +0000102 }
Anders Carlssonf8f756d2010-10-31 21:22:43 +0000103
Charles Davisc2c576a2010-08-19 00:55:19 +0000104protected:
Anders Carlsson725190f2010-10-31 21:39:24 +0000105 bool CanPlaceSubobjectAtOffset(const CXXRecordDecl *RD,
106 CharUnits Offset) const;
Charles Davisc2c576a2010-08-19 00:55:19 +0000107
108 bool CanPlaceBaseSubobjectAtOffset(const BaseSubobjectInfo *Info,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000109 CharUnits Offset);
Charles Davisc2c576a2010-08-19 00:55:19 +0000110
111 bool CanPlaceFieldSubobjectAtOffset(const CXXRecordDecl *RD,
112 const CXXRecordDecl *Class,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000113 CharUnits Offset) const;
Charles Davisc2c576a2010-08-19 00:55:19 +0000114 bool CanPlaceFieldSubobjectAtOffset(const FieldDecl *FD,
Anders Carlsson233e2722010-10-31 21:54:55 +0000115 CharUnits Offset) const;
Charles Davisc2c576a2010-08-19 00:55:19 +0000116
Anders Carlssonf58de112010-05-26 15:32:58 +0000117public:
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000118 /// This holds the size of the largest empty subobject (either a base
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000119 /// or a member). Will be zero if the record being built doesn't contain
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000120 /// any empty classes.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000121 CharUnits SizeOfLargestEmptySubobject;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000122
Jay Foad39c79802011-01-12 09:06:06 +0000123 EmptySubobjectMap(const ASTContext &Context, const CXXRecordDecl *Class)
Anders Carlsson28466ab2010-10-31 22:13:23 +0000124 : Context(Context), CharWidth(Context.getCharWidth()), Class(Class) {
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000125 ComputeEmptySubobjectSizes();
126 }
127
128 /// CanPlaceBaseAtOffset - Return whether the given base class can be placed
129 /// at the given offset.
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000130 /// Returns false if placing the record will result in two components
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000131 /// (direct or indirect) of the same type having the same offset.
Anders Carlssoncc5de092010-06-08 15:56:03 +0000132 bool CanPlaceBaseAtOffset(const BaseSubobjectInfo *Info,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000133 CharUnits Offset);
Anders Carlssondb319762010-05-27 18:20:57 +0000134
135 /// CanPlaceFieldAtOffset - Return whether a field can be placed at the given
136 /// offset.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000137 bool CanPlaceFieldAtOffset(const FieldDecl *FD, CharUnits Offset);
Anders Carlssonf58de112010-05-26 15:32:58 +0000138};
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000139
140void EmptySubobjectMap::ComputeEmptySubobjectSizes() {
141 // Check the bases.
142 for (CXXRecordDecl::base_class_const_iterator I = Class->bases_begin(),
143 E = Class->bases_end(); I != E; ++I) {
144 const CXXRecordDecl *BaseDecl =
145 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
146
Anders Carlsson28466ab2010-10-31 22:13:23 +0000147 CharUnits EmptySize;
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000148 const ASTRecordLayout &Layout = Context.getASTRecordLayout(BaseDecl);
149 if (BaseDecl->isEmpty()) {
150 // If the class decl is empty, get its size.
Ken Dyckc8ae5502011-02-09 01:59:34 +0000151 EmptySize = Layout.getSize();
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000152 } else {
153 // Otherwise, we get the largest empty subobject for the decl.
154 EmptySize = Layout.getSizeOfLargestEmptySubobject();
155 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000156
Anders Carlsson28466ab2010-10-31 22:13:23 +0000157 if (EmptySize > SizeOfLargestEmptySubobject)
158 SizeOfLargestEmptySubobject = EmptySize;
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000159 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000160
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000161 // Check the fields.
162 for (CXXRecordDecl::field_iterator I = Class->field_begin(),
163 E = Class->field_end(); I != E; ++I) {
164 const FieldDecl *FD = *I;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000165
166 const RecordType *RT =
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000167 Context.getBaseElementType(FD->getType())->getAs<RecordType>();
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000168
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000169 // We only care about record types.
170 if (!RT)
171 continue;
172
Anders Carlsson28466ab2010-10-31 22:13:23 +0000173 CharUnits EmptySize;
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000174 const CXXRecordDecl *MemberDecl = cast<CXXRecordDecl>(RT->getDecl());
175 const ASTRecordLayout &Layout = Context.getASTRecordLayout(MemberDecl);
176 if (MemberDecl->isEmpty()) {
177 // If the class decl is empty, get its size.
Ken Dyckc8ae5502011-02-09 01:59:34 +0000178 EmptySize = Layout.getSize();
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000179 } else {
180 // Otherwise, we get the largest empty subobject for the decl.
181 EmptySize = Layout.getSizeOfLargestEmptySubobject();
182 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000183
Anders Carlsson28466ab2010-10-31 22:13:23 +0000184 if (EmptySize > SizeOfLargestEmptySubobject)
185 SizeOfLargestEmptySubobject = EmptySize;
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000186 }
187}
188
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000189bool
Anders Carlssondb319762010-05-27 18:20:57 +0000190EmptySubobjectMap::CanPlaceSubobjectAtOffset(const CXXRecordDecl *RD,
Anders Carlsson725190f2010-10-31 21:39:24 +0000191 CharUnits Offset) const {
Anders Carlssondb319762010-05-27 18:20:57 +0000192 // We only need to check empty bases.
193 if (!RD->isEmpty())
194 return true;
195
Anders Carlsson725190f2010-10-31 21:39:24 +0000196 EmptyClassOffsetsMapTy::const_iterator I = EmptyClassOffsets.find(Offset);
Anders Carlssondb319762010-05-27 18:20:57 +0000197 if (I == EmptyClassOffsets.end())
198 return true;
199
200 const ClassVectorTy& Classes = I->second;
201 if (std::find(Classes.begin(), Classes.end(), RD) == Classes.end())
202 return true;
203
204 // There is already an empty class of the same type at this offset.
205 return false;
206}
207
208void EmptySubobjectMap::AddSubobjectAtOffset(const CXXRecordDecl *RD,
Anders Carlsson725190f2010-10-31 21:39:24 +0000209 CharUnits Offset) {
Anders Carlssondb319762010-05-27 18:20:57 +0000210 // We only care about empty bases.
211 if (!RD->isEmpty())
212 return;
213
Rafael Espindola7bcde192010-12-29 23:02:58 +0000214 // If we have empty structures inside an union, we can assign both
215 // the same offset. Just avoid pushing them twice in the list.
Anders Carlsson725190f2010-10-31 21:39:24 +0000216 ClassVectorTy& Classes = EmptyClassOffsets[Offset];
Rafael Espindola7bcde192010-12-29 23:02:58 +0000217 if (std::find(Classes.begin(), Classes.end(), RD) != Classes.end())
218 return;
219
Anders Carlssondb319762010-05-27 18:20:57 +0000220 Classes.push_back(RD);
Anders Carlssoncc5de092010-06-08 15:56:03 +0000221
222 // Update the empty class offset.
Anders Carlsson725190f2010-10-31 21:39:24 +0000223 if (Offset > MaxEmptyClassOffset)
224 MaxEmptyClassOffset = Offset;
Anders Carlssondb319762010-05-27 18:20:57 +0000225}
226
227bool
Anders Carlsson28466ab2010-10-31 22:13:23 +0000228EmptySubobjectMap::CanPlaceBaseSubobjectAtOffset(const BaseSubobjectInfo *Info,
229 CharUnits Offset) {
Anders Carlsson45c1d282010-06-08 16:20:35 +0000230 // We don't have to keep looking past the maximum offset that's known to
231 // contain an empty class.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000232 if (!AnyEmptySubobjectsBeyondOffset(Offset))
Anders Carlsson45c1d282010-06-08 16:20:35 +0000233 return true;
234
Anders Carlsson28466ab2010-10-31 22:13:23 +0000235 if (!CanPlaceSubobjectAtOffset(Info->Class, Offset))
Anders Carlssondb319762010-05-27 18:20:57 +0000236 return false;
237
Anders Carlsson439edd12010-05-27 05:41:06 +0000238 // Traverse all non-virtual bases.
Anders Carlssona7774a62010-05-29 21:10:24 +0000239 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Info->Class);
Anders Carlsson439edd12010-05-27 05:41:06 +0000240 for (unsigned I = 0, E = Info->Bases.size(); I != E; ++I) {
Anders Carlssona7f3cdb2010-05-28 21:24:37 +0000241 BaseSubobjectInfo* Base = Info->Bases[I];
Anders Carlsson439edd12010-05-27 05:41:06 +0000242 if (Base->IsVirtual)
243 continue;
244
Anders Carlsson0a14ee92010-11-01 00:21:58 +0000245 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base->Class);
Anders Carlsson439edd12010-05-27 05:41:06 +0000246
247 if (!CanPlaceBaseSubobjectAtOffset(Base, BaseOffset))
248 return false;
249 }
250
Anders Carlssone3c24c72010-05-29 17:35:14 +0000251 if (Info->PrimaryVirtualBaseInfo) {
252 BaseSubobjectInfo *PrimaryVirtualBaseInfo = Info->PrimaryVirtualBaseInfo;
Anders Carlsson439edd12010-05-27 05:41:06 +0000253
254 if (Info == PrimaryVirtualBaseInfo->Derived) {
255 if (!CanPlaceBaseSubobjectAtOffset(PrimaryVirtualBaseInfo, Offset))
256 return false;
257 }
258 }
259
Anders Carlssondb319762010-05-27 18:20:57 +0000260 // Traverse all member variables.
261 unsigned FieldNo = 0;
262 for (CXXRecordDecl::field_iterator I = Info->Class->field_begin(),
263 E = Info->Class->field_end(); I != E; ++I, ++FieldNo) {
264 const FieldDecl *FD = *I;
Anders Carlsson233e2722010-10-31 21:54:55 +0000265 if (FD->isBitField())
266 continue;
267
Anders Carlsson28466ab2010-10-31 22:13:23 +0000268 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
Anders Carlssondb319762010-05-27 18:20:57 +0000269 if (!CanPlaceFieldSubobjectAtOffset(FD, FieldOffset))
270 return false;
271 }
272
Anders Carlsson439edd12010-05-27 05:41:06 +0000273 return true;
274}
275
Anders Carlssona7f3cdb2010-05-28 21:24:37 +0000276void EmptySubobjectMap::UpdateEmptyBaseSubobjects(const BaseSubobjectInfo *Info,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000277 CharUnits Offset,
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000278 bool PlacingEmptyBase) {
279 if (!PlacingEmptyBase && Offset >= SizeOfLargestEmptySubobject) {
280 // We know that the only empty subobjects that can conflict with empty
281 // subobject of non-empty bases, are empty bases that can be placed at
282 // offset zero. Because of this, we only need to keep track of empty base
283 // subobjects with offsets less than the size of the largest empty
284 // subobject for our class.
285 return;
286 }
287
Anders Carlsson28466ab2010-10-31 22:13:23 +0000288 AddSubobjectAtOffset(Info->Class, Offset);
Anders Carlssona7774a62010-05-29 21:10:24 +0000289
Anders Carlsson439edd12010-05-27 05:41:06 +0000290 // Traverse all non-virtual bases.
Anders Carlssona7774a62010-05-29 21:10:24 +0000291 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Info->Class);
Anders Carlsson439edd12010-05-27 05:41:06 +0000292 for (unsigned I = 0, E = Info->Bases.size(); I != E; ++I) {
Anders Carlssona7f3cdb2010-05-28 21:24:37 +0000293 BaseSubobjectInfo* Base = Info->Bases[I];
Anders Carlsson439edd12010-05-27 05:41:06 +0000294 if (Base->IsVirtual)
295 continue;
Anders Carlssona7774a62010-05-29 21:10:24 +0000296
Anders Carlsson0a14ee92010-11-01 00:21:58 +0000297 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base->Class);
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000298 UpdateEmptyBaseSubobjects(Base, BaseOffset, PlacingEmptyBase);
Anders Carlsson439edd12010-05-27 05:41:06 +0000299 }
300
Anders Carlssone3c24c72010-05-29 17:35:14 +0000301 if (Info->PrimaryVirtualBaseInfo) {
302 BaseSubobjectInfo *PrimaryVirtualBaseInfo = Info->PrimaryVirtualBaseInfo;
Anders Carlsson439edd12010-05-27 05:41:06 +0000303
304 if (Info == PrimaryVirtualBaseInfo->Derived)
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000305 UpdateEmptyBaseSubobjects(PrimaryVirtualBaseInfo, Offset,
306 PlacingEmptyBase);
Anders Carlsson439edd12010-05-27 05:41:06 +0000307 }
Anders Carlssondb319762010-05-27 18:20:57 +0000308
Anders Carlssondb319762010-05-27 18:20:57 +0000309 // Traverse all member variables.
310 unsigned FieldNo = 0;
311 for (CXXRecordDecl::field_iterator I = Info->Class->field_begin(),
312 E = Info->Class->field_end(); I != E; ++I, ++FieldNo) {
313 const FieldDecl *FD = *I;
Anders Carlsson233e2722010-10-31 21:54:55 +0000314 if (FD->isBitField())
315 continue;
Anders Carlssona7774a62010-05-29 21:10:24 +0000316
Anders Carlsson28466ab2010-10-31 22:13:23 +0000317 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
318 UpdateEmptyFieldSubobjects(FD, FieldOffset);
Anders Carlssondb319762010-05-27 18:20:57 +0000319 }
Anders Carlsson439edd12010-05-27 05:41:06 +0000320}
321
Anders Carlssona60b86a2010-05-29 20:49:49 +0000322bool EmptySubobjectMap::CanPlaceBaseAtOffset(const BaseSubobjectInfo *Info,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000323 CharUnits Offset) {
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000324 // If we know this class doesn't have any empty subobjects we don't need to
325 // bother checking.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000326 if (SizeOfLargestEmptySubobject.isZero())
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000327 return true;
328
Anders Carlsson439edd12010-05-27 05:41:06 +0000329 if (!CanPlaceBaseSubobjectAtOffset(Info, Offset))
330 return false;
Anders Carlssondb319762010-05-27 18:20:57 +0000331
332 // We are able to place the base at this offset. Make sure to update the
333 // empty base subobject map.
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000334 UpdateEmptyBaseSubobjects(Info, Offset, Info->Class->isEmpty());
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000335 return true;
336}
337
Anders Carlssondb319762010-05-27 18:20:57 +0000338bool
339EmptySubobjectMap::CanPlaceFieldSubobjectAtOffset(const CXXRecordDecl *RD,
340 const CXXRecordDecl *Class,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000341 CharUnits Offset) const {
Anders Carlsson45c1d282010-06-08 16:20:35 +0000342 // We don't have to keep looking past the maximum offset that's known to
343 // contain an empty class.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000344 if (!AnyEmptySubobjectsBeyondOffset(Offset))
Anders Carlsson45c1d282010-06-08 16:20:35 +0000345 return true;
346
Anders Carlsson28466ab2010-10-31 22:13:23 +0000347 if (!CanPlaceSubobjectAtOffset(RD, Offset))
Anders Carlssondb319762010-05-27 18:20:57 +0000348 return false;
349
350 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
351
352 // Traverse all non-virtual bases.
353 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
354 E = RD->bases_end(); I != E; ++I) {
355 if (I->isVirtual())
356 continue;
357
358 const CXXRecordDecl *BaseDecl =
359 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
360
Anders Carlsson0a14ee92010-11-01 00:21:58 +0000361 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(BaseDecl);
Anders Carlssondb319762010-05-27 18:20:57 +0000362 if (!CanPlaceFieldSubobjectAtOffset(BaseDecl, Class, BaseOffset))
363 return false;
364 }
365
Anders Carlsson44687202010-06-08 19:09:24 +0000366 if (RD == Class) {
367 // This is the most derived class, traverse virtual bases as well.
368 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
369 E = RD->vbases_end(); I != E; ++I) {
370 const CXXRecordDecl *VBaseDecl =
371 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
372
Anders Carlsson3f018712010-10-31 23:45:59 +0000373 CharUnits VBaseOffset = Offset + Layout.getVBaseClassOffset(VBaseDecl);
Anders Carlsson44687202010-06-08 19:09:24 +0000374 if (!CanPlaceFieldSubobjectAtOffset(VBaseDecl, Class, VBaseOffset))
375 return false;
376 }
377 }
378
Anders Carlssondb319762010-05-27 18:20:57 +0000379 // Traverse all member variables.
380 unsigned FieldNo = 0;
381 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
382 I != E; ++I, ++FieldNo) {
383 const FieldDecl *FD = *I;
Anders Carlsson233e2722010-10-31 21:54:55 +0000384 if (FD->isBitField())
385 continue;
386
Anders Carlsson28466ab2010-10-31 22:13:23 +0000387 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
Anders Carlssondb319762010-05-27 18:20:57 +0000388
389 if (!CanPlaceFieldSubobjectAtOffset(FD, FieldOffset))
390 return false;
391 }
392
393 return true;
394}
395
Anders Carlsson233e2722010-10-31 21:54:55 +0000396bool
397EmptySubobjectMap::CanPlaceFieldSubobjectAtOffset(const FieldDecl *FD,
398 CharUnits Offset) const {
Anders Carlsson45c1d282010-06-08 16:20:35 +0000399 // We don't have to keep looking past the maximum offset that's known to
400 // contain an empty class.
Anders Carlsson233e2722010-10-31 21:54:55 +0000401 if (!AnyEmptySubobjectsBeyondOffset(Offset))
Anders Carlsson45c1d282010-06-08 16:20:35 +0000402 return true;
403
Anders Carlssondb319762010-05-27 18:20:57 +0000404 QualType T = FD->getType();
405 if (const RecordType *RT = T->getAs<RecordType>()) {
406 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
Anders Carlsson28466ab2010-10-31 22:13:23 +0000407 return CanPlaceFieldSubobjectAtOffset(RD, RD, Offset);
Anders Carlssondb319762010-05-27 18:20:57 +0000408 }
409
410 // If we have an array type we need to look at every element.
411 if (const ConstantArrayType *AT = Context.getAsConstantArrayType(T)) {
412 QualType ElemTy = Context.getBaseElementType(AT);
413 const RecordType *RT = ElemTy->getAs<RecordType>();
414 if (!RT)
415 return true;
416
417 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
418 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
419
420 uint64_t NumElements = Context.getConstantArrayElementCount(AT);
Anders Carlsson233e2722010-10-31 21:54:55 +0000421 CharUnits ElementOffset = Offset;
Anders Carlssondb319762010-05-27 18:20:57 +0000422 for (uint64_t I = 0; I != NumElements; ++I) {
Anders Carlsson45c1d282010-06-08 16:20:35 +0000423 // We don't have to keep looking past the maximum offset that's known to
424 // contain an empty class.
Anders Carlsson233e2722010-10-31 21:54:55 +0000425 if (!AnyEmptySubobjectsBeyondOffset(ElementOffset))
Anders Carlsson45c1d282010-06-08 16:20:35 +0000426 return true;
427
Anders Carlsson28466ab2010-10-31 22:13:23 +0000428 if (!CanPlaceFieldSubobjectAtOffset(RD, RD, ElementOffset))
Anders Carlssondb319762010-05-27 18:20:57 +0000429 return false;
430
Ken Dyckc8ae5502011-02-09 01:59:34 +0000431 ElementOffset += Layout.getSize();
Anders Carlssondb319762010-05-27 18:20:57 +0000432 }
433 }
434
435 return true;
436}
437
438bool
Anders Carlsson28466ab2010-10-31 22:13:23 +0000439EmptySubobjectMap::CanPlaceFieldAtOffset(const FieldDecl *FD,
440 CharUnits Offset) {
441 if (!CanPlaceFieldSubobjectAtOffset(FD, Offset))
Anders Carlssondb319762010-05-27 18:20:57 +0000442 return false;
443
444 // We are able to place the member variable at this offset.
445 // Make sure to update the empty base subobject map.
446 UpdateEmptyFieldSubobjects(FD, Offset);
447 return true;
448}
449
450void EmptySubobjectMap::UpdateEmptyFieldSubobjects(const CXXRecordDecl *RD,
451 const CXXRecordDecl *Class,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000452 CharUnits Offset) {
Anders Carlssonae111dc2010-06-13 17:49:16 +0000453 // We know that the only empty subobjects that can conflict with empty
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000454 // field subobjects are subobjects of empty bases that can be placed at offset
Anders Carlssonae111dc2010-06-13 17:49:16 +0000455 // zero. Because of this, we only need to keep track of empty field
456 // subobjects with offsets less than the size of the largest empty
457 // subobject for our class.
458 if (Offset >= SizeOfLargestEmptySubobject)
459 return;
460
Anders Carlsson28466ab2010-10-31 22:13:23 +0000461 AddSubobjectAtOffset(RD, Offset);
Anders Carlssondb319762010-05-27 18:20:57 +0000462
463 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
464
465 // Traverse all non-virtual bases.
466 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
467 E = RD->bases_end(); I != E; ++I) {
468 if (I->isVirtual())
469 continue;
470
471 const CXXRecordDecl *BaseDecl =
472 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
473
Anders Carlsson0a14ee92010-11-01 00:21:58 +0000474 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(BaseDecl);
Anders Carlssondb319762010-05-27 18:20:57 +0000475 UpdateEmptyFieldSubobjects(BaseDecl, Class, BaseOffset);
476 }
477
Anders Carlsson44687202010-06-08 19:09:24 +0000478 if (RD == Class) {
479 // This is the most derived class, traverse virtual bases as well.
480 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
481 E = RD->vbases_end(); I != E; ++I) {
482 const CXXRecordDecl *VBaseDecl =
483 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
484
Anders Carlsson3f018712010-10-31 23:45:59 +0000485 CharUnits VBaseOffset = Offset + Layout.getVBaseClassOffset(VBaseDecl);
Anders Carlsson44687202010-06-08 19:09:24 +0000486 UpdateEmptyFieldSubobjects(VBaseDecl, Class, VBaseOffset);
487 }
488 }
489
Anders Carlssondb319762010-05-27 18:20:57 +0000490 // Traverse all member variables.
491 unsigned FieldNo = 0;
492 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
493 I != E; ++I, ++FieldNo) {
494 const FieldDecl *FD = *I;
Anders Carlsson09814d32010-11-01 15:14:51 +0000495 if (FD->isBitField())
496 continue;
497
Anders Carlsson28466ab2010-10-31 22:13:23 +0000498 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
Anders Carlssondb319762010-05-27 18:20:57 +0000499
Anders Carlsson28466ab2010-10-31 22:13:23 +0000500 UpdateEmptyFieldSubobjects(FD, FieldOffset);
Anders Carlssondb319762010-05-27 18:20:57 +0000501 }
502}
503
504void EmptySubobjectMap::UpdateEmptyFieldSubobjects(const FieldDecl *FD,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000505 CharUnits Offset) {
Anders Carlssondb319762010-05-27 18:20:57 +0000506 QualType T = FD->getType();
507 if (const RecordType *RT = T->getAs<RecordType>()) {
508 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
509 UpdateEmptyFieldSubobjects(RD, RD, Offset);
510 return;
511 }
512
513 // If we have an array type we need to update every element.
514 if (const ConstantArrayType *AT = Context.getAsConstantArrayType(T)) {
515 QualType ElemTy = Context.getBaseElementType(AT);
516 const RecordType *RT = ElemTy->getAs<RecordType>();
517 if (!RT)
518 return;
519
520 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
521 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
522
523 uint64_t NumElements = Context.getConstantArrayElementCount(AT);
Anders Carlsson28466ab2010-10-31 22:13:23 +0000524 CharUnits ElementOffset = Offset;
Anders Carlssondb319762010-05-27 18:20:57 +0000525
526 for (uint64_t I = 0; I != NumElements; ++I) {
Anders Carlssonae111dc2010-06-13 17:49:16 +0000527 // We know that the only empty subobjects that can conflict with empty
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000528 // field subobjects are subobjects of empty bases that can be placed at
Anders Carlssonae111dc2010-06-13 17:49:16 +0000529 // offset zero. Because of this, we only need to keep track of empty field
530 // subobjects with offsets less than the size of the largest empty
531 // subobject for our class.
532 if (ElementOffset >= SizeOfLargestEmptySubobject)
533 return;
534
Anders Carlssondb319762010-05-27 18:20:57 +0000535 UpdateEmptyFieldSubobjects(RD, RD, ElementOffset);
Ken Dyckc8ae5502011-02-09 01:59:34 +0000536 ElementOffset += Layout.getSize();
Anders Carlssondb319762010-05-27 18:20:57 +0000537 }
538 }
539}
540
Anders Carlssonc2226202010-05-26 05:58:59 +0000541class RecordLayoutBuilder {
Charles Davisc2c576a2010-08-19 00:55:19 +0000542protected:
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000543 // FIXME: Remove this and make the appropriate fields public.
544 friend class clang::ASTContext;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000545
Jay Foad39c79802011-01-12 09:06:06 +0000546 const ASTContext &Context;
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000547
Anders Carlssonf58de112010-05-26 15:32:58 +0000548 EmptySubobjectMap *EmptySubobjects;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000549
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000550 /// Size - The current size of the record layout.
551 uint64_t Size;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000552
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000553 /// Alignment - The current alignment of the record layout.
Ken Dyck4731d5b2011-02-16 02:05:21 +0000554 CharUnits Alignment;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000555
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000556 /// \brief The alignment if attribute packed is not used.
Ken Dyck1300b3b2011-02-16 02:11:31 +0000557 CharUnits UnpackedAlignment;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000558
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000559 SmallVector<uint64_t, 16> FieldOffsets;
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000560
Douglas Gregore9fc3772012-01-26 07:55:45 +0000561 /// \brief Whether the external AST source has provided a layout for this
562 /// record.
563 unsigned ExternalLayout : 1;
Douglas Gregor44ba7892012-01-28 00:53:29 +0000564
565 /// \brief Whether we need to infer alignment, even when we have an
566 /// externally-provided layout.
567 unsigned InferAlignment : 1;
Douglas Gregore9fc3772012-01-26 07:55:45 +0000568
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000569 /// Packed - Whether the record is packed or not.
Daniel Dunbar6da10982010-05-27 05:45:51 +0000570 unsigned Packed : 1;
571
572 unsigned IsUnion : 1;
573
574 unsigned IsMac68kAlign : 1;
Fariborz Jahanianbcb23a12011-04-26 23:52:16 +0000575
576 unsigned IsMsStruct : 1;
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000577
578 /// UnfilledBitsInLastByte - If the last field laid out was a bitfield,
579 /// this contains the number of bits in the last byte that can be used for
580 /// an adjacent bitfield if necessary.
581 unsigned char UnfilledBitsInLastByte;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000582
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000583 /// MaxFieldAlignment - The maximum allowed field alignment. This is set by
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000584 /// #pragma pack.
Ken Dyck02ced6f2011-02-17 01:49:42 +0000585 CharUnits MaxFieldAlignment;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000586
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000587 /// DataSize - The data size of the record being laid out.
588 uint64_t DataSize;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000589
Ken Dyckaf1c83f2011-02-16 01:52:01 +0000590 CharUnits NonVirtualSize;
Ken Dycka2d3dda2011-02-16 01:43:15 +0000591 CharUnits NonVirtualAlignment;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000592
Fariborz Jahanianfc0fe6e2011-05-03 20:21:04 +0000593 FieldDecl *ZeroLengthBitfield;
Fariborz Jahanianeb397412011-05-02 17:20:56 +0000594
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000595 /// PrimaryBase - the primary base class (if one exists) of the class
596 /// we're laying out.
597 const CXXRecordDecl *PrimaryBase;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000598
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000599 /// PrimaryBaseIsVirtual - Whether the primary base of the class we're laying
600 /// out is virtual.
601 bool PrimaryBaseIsVirtual;
602
Eli Friedman43114f92011-10-21 22:49:56 +0000603 /// VFPtrOffset - Virtual function table offset. Only for MS layout.
604 CharUnits VFPtrOffset;
605
Eli Friedman84d2d3a2011-09-27 19:12:27 +0000606 /// VBPtrOffset - Virtual base table offset. Only for MS layout.
607 CharUnits VBPtrOffset;
608
Anders Carlsson22f57202010-10-31 21:01:46 +0000609 typedef llvm::DenseMap<const CXXRecordDecl *, CharUnits> BaseOffsetsMapTy;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000610
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000611 /// Bases - base classes and their offsets in the record.
612 BaseOffsetsMapTy Bases;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000613
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000614 // VBases - virtual base classes and their offsets in the record.
615 BaseOffsetsMapTy VBases;
616
617 /// IndirectPrimaryBases - Virtual base classes, direct or indirect, that are
618 /// primary base classes for some other direct or indirect base class.
Anders Carlsson5adde292010-11-24 22:55:48 +0000619 CXXIndirectPrimaryBaseSet IndirectPrimaryBases;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000620
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000621 /// FirstNearlyEmptyVBase - The first nearly empty virtual base class in
622 /// inheritance graph order. Used for determining the primary base class.
623 const CXXRecordDecl *FirstNearlyEmptyVBase;
624
625 /// VisitedVirtualBases - A set of all the visited virtual bases, used to
626 /// avoid visiting virtual bases more than once.
627 llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBases;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000628
Douglas Gregore9fc3772012-01-26 07:55:45 +0000629 /// \brief Externally-provided size.
630 uint64_t ExternalSize;
631
632 /// \brief Externally-provided alignment.
633 uint64_t ExternalAlign;
634
635 /// \brief Externally-provided field offsets.
636 llvm::DenseMap<const FieldDecl *, uint64_t> ExternalFieldOffsets;
637
638 /// \brief Externally-provided direct, non-virtual base offsets.
639 llvm::DenseMap<const CXXRecordDecl *, CharUnits> ExternalBaseOffsets;
640
641 /// \brief Externally-provided virtual base offsets.
642 llvm::DenseMap<const CXXRecordDecl *, CharUnits> ExternalVirtualBaseOffsets;
643
John McCall0153cd32011-11-08 04:01:03 +0000644 RecordLayoutBuilder(const ASTContext &Context,
645 EmptySubobjectMap *EmptySubobjects)
Ken Dyck4731d5b2011-02-16 02:05:21 +0000646 : Context(Context), EmptySubobjects(EmptySubobjects), Size(0),
John McCall0153cd32011-11-08 04:01:03 +0000647 Alignment(CharUnits::One()), UnpackedAlignment(CharUnits::One()),
Douglas Gregor44ba7892012-01-28 00:53:29 +0000648 ExternalLayout(false), InferAlignment(false),
649 Packed(false), IsUnion(false), IsMac68kAlign(false), IsMsStruct(false),
Ken Dyck02ced6f2011-02-17 01:49:42 +0000650 UnfilledBitsInLastByte(0), MaxFieldAlignment(CharUnits::Zero()),
651 DataSize(0), NonVirtualSize(CharUnits::Zero()),
Fariborz Jahanianeb397412011-05-02 17:20:56 +0000652 NonVirtualAlignment(CharUnits::One()),
Fariborz Jahanianfc0fe6e2011-05-03 20:21:04 +0000653 ZeroLengthBitfield(0), PrimaryBase(0),
Eli Friedman43114f92011-10-21 22:49:56 +0000654 PrimaryBaseIsVirtual(false),
655 VFPtrOffset(CharUnits::fromQuantity(-1)),
656 VBPtrOffset(CharUnits::fromQuantity(-1)),
Eli Friedman84d2d3a2011-09-27 19:12:27 +0000657 FirstNearlyEmptyVBase(0) { }
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000658
John McCall0153cd32011-11-08 04:01:03 +0000659 /// Reset this RecordLayoutBuilder to a fresh state, using the given
660 /// alignment as the initial alignment. This is used for the
661 /// correct layout of vb-table pointers in MSVC.
662 void resetWithTargetAlignment(CharUnits TargetAlignment) {
663 const ASTContext &Context = this->Context;
664 EmptySubobjectMap *EmptySubobjects = this->EmptySubobjects;
665 this->~RecordLayoutBuilder();
666 new (this) RecordLayoutBuilder(Context, EmptySubobjects);
667 Alignment = UnpackedAlignment = TargetAlignment;
668 }
669
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000670 void Layout(const RecordDecl *D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000671 void Layout(const CXXRecordDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000672 void Layout(const ObjCInterfaceDecl *D);
673
674 void LayoutFields(const RecordDecl *D);
675 void LayoutField(const FieldDecl *D);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000676 void LayoutWideBitField(uint64_t FieldSize, uint64_t TypeSize,
677 bool FieldPacked, const FieldDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000678 void LayoutBitField(const FieldDecl *D);
John McCall0153cd32011-11-08 04:01:03 +0000679
680 bool isMicrosoftCXXABI() const {
681 return Context.getTargetInfo().getCXXABI() == CXXABI_Microsoft;
682 }
683
Eli Friedman84d2d3a2011-09-27 19:12:27 +0000684 void MSLayoutVirtualBases(const CXXRecordDecl *RD);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000685
Anders Carlssone3c24c72010-05-29 17:35:14 +0000686 /// BaseSubobjectInfoAllocator - Allocator for BaseSubobjectInfo objects.
687 llvm::SpecificBumpPtrAllocator<BaseSubobjectInfo> BaseSubobjectInfoAllocator;
688
689 typedef llvm::DenseMap<const CXXRecordDecl *, BaseSubobjectInfo *>
690 BaseSubobjectInfoMapTy;
691
692 /// VirtualBaseInfo - Map from all the (direct or indirect) virtual bases
693 /// of the class we're laying out to their base subobject info.
694 BaseSubobjectInfoMapTy VirtualBaseInfo;
695
696 /// NonVirtualBaseInfo - Map from all the direct non-virtual bases of the
697 /// class we're laying out to their base subobject info.
698 BaseSubobjectInfoMapTy NonVirtualBaseInfo;
699
700 /// ComputeBaseSubobjectInfo - Compute the base subobject information for the
701 /// bases of the given class.
702 void ComputeBaseSubobjectInfo(const CXXRecordDecl *RD);
703
704 /// ComputeBaseSubobjectInfo - Compute the base subobject information for a
705 /// single class and all of its base classes.
706 BaseSubobjectInfo *ComputeBaseSubobjectInfo(const CXXRecordDecl *RD,
707 bool IsVirtual,
708 BaseSubobjectInfo *Derived);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000709
710 /// DeterminePrimaryBase - Determine the primary base of the given class.
711 void DeterminePrimaryBase(const CXXRecordDecl *RD);
712
713 void SelectPrimaryVBase(const CXXRecordDecl *RD);
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000714
Eli Friedman43114f92011-10-21 22:49:56 +0000715 void EnsureVTablePointerAlignment(CharUnits UnpackedBaseAlign);
Charles Davisc2c576a2010-08-19 00:55:19 +0000716
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000717 /// LayoutNonVirtualBases - Determines the primary base class (if any) and
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000718 /// lays it out. Will then proceed to lay out all non-virtual base clasess.
719 void LayoutNonVirtualBases(const CXXRecordDecl *RD);
720
721 /// LayoutNonVirtualBase - Lays out a single non-virtual base.
Anders Carlssonbb0e6782010-05-29 17:42:25 +0000722 void LayoutNonVirtualBase(const BaseSubobjectInfo *Base);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000723
Anders Carlssona2f8e412010-10-31 22:20:42 +0000724 void AddPrimaryVirtualBaseOffsets(const BaseSubobjectInfo *Info,
725 CharUnits Offset);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000726
John McCall0153cd32011-11-08 04:01:03 +0000727 bool needsVFTable(const CXXRecordDecl *RD) const;
728 bool hasNewVirtualFunction(const CXXRecordDecl *RD) const;
729 bool isPossiblePrimaryBase(const CXXRecordDecl *Base) const;
Eli Friedman5e9534b2011-10-18 00:55:28 +0000730
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000731 /// LayoutVirtualBases - Lays out all the virtual bases.
732 void LayoutVirtualBases(const CXXRecordDecl *RD,
733 const CXXRecordDecl *MostDerivedClass);
734
735 /// LayoutVirtualBase - Lays out a single virtual base.
Anders Carlssond6ff5d72010-05-29 17:48:36 +0000736 void LayoutVirtualBase(const BaseSubobjectInfo *Base);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000737
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000738 /// LayoutBase - Will lay out a base and return the offset where it was
Anders Carlssona2f8e412010-10-31 22:20:42 +0000739 /// placed, in chars.
740 CharUnits LayoutBase(const BaseSubobjectInfo *Base);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000741
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000742 /// InitializeLayout - Initialize record layout for the given record decl.
Daniel Dunbar6da10982010-05-27 05:45:51 +0000743 void InitializeLayout(const Decl *D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000744
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000745 /// FinishLayout - Finalize record layout. Adjust record size based on the
746 /// alignment.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000747 void FinishLayout(const NamedDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000748
Ken Dyck85ef0432011-02-19 18:58:07 +0000749 void UpdateAlignment(CharUnits NewAlignment, CharUnits UnpackedNewAlignment);
750 void UpdateAlignment(CharUnits NewAlignment) {
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000751 UpdateAlignment(NewAlignment, NewAlignment);
752 }
753
Douglas Gregor44ba7892012-01-28 00:53:29 +0000754 /// \brief Retrieve the externally-supplied field offset for the given
755 /// field.
756 ///
757 /// \param Field The field whose offset is being queried.
758 /// \param ComputedOffset The offset that we've computed for this field.
759 uint64_t updateExternalFieldOffset(const FieldDecl *Field,
760 uint64_t ComputedOffset);
761
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000762 void CheckFieldPadding(uint64_t Offset, uint64_t UnpaddedOffset,
763 uint64_t UnpackedOffset, unsigned UnpackedAlign,
764 bool isPacked, const FieldDecl *D);
765
766 DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000767
Ken Dyckecfc7552011-02-24 01:13:28 +0000768 CharUnits getSize() const {
Ken Dyck3c215f22011-02-24 01:33:05 +0000769 assert(Size % Context.getCharWidth() == 0);
Ken Dyckecfc7552011-02-24 01:13:28 +0000770 return Context.toCharUnitsFromBits(Size);
771 }
772 uint64_t getSizeInBits() const { return Size; }
773
774 void setSize(CharUnits NewSize) { Size = Context.toBits(NewSize); }
775 void setSize(uint64_t NewSize) { Size = NewSize; }
776
Eli Friedman84d2d3a2011-09-27 19:12:27 +0000777 CharUnits getAligment() const { return Alignment; }
778
Ken Dyckecfc7552011-02-24 01:13:28 +0000779 CharUnits getDataSize() const {
Ken Dyck3c215f22011-02-24 01:33:05 +0000780 assert(DataSize % Context.getCharWidth() == 0);
Ken Dyckecfc7552011-02-24 01:13:28 +0000781 return Context.toCharUnitsFromBits(DataSize);
782 }
783 uint64_t getDataSizeInBits() const { return DataSize; }
784
785 void setDataSize(CharUnits NewSize) { DataSize = Context.toBits(NewSize); }
786 void setDataSize(uint64_t NewSize) { DataSize = NewSize; }
787
Argyrios Kyrtzidis499e6e42010-08-15 10:17:39 +0000788 RecordLayoutBuilder(const RecordLayoutBuilder&); // DO NOT IMPLEMENT
789 void operator=(const RecordLayoutBuilder&); // DO NOT IMPLEMENT
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000790public:
791 static const CXXMethodDecl *ComputeKeyFunction(const CXXRecordDecl *RD);
792};
Benjamin Kramerc7656cd2010-05-26 09:58:31 +0000793} // end anonymous namespace
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000794
Anders Carlsson81430692009-09-22 03:02:06 +0000795void
Anders Carlssonc2226202010-05-26 05:58:59 +0000796RecordLayoutBuilder::SelectPrimaryVBase(const CXXRecordDecl *RD) {
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000797 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000798 E = RD->bases_end(); I != E; ++I) {
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000799 assert(!I->getType()->isDependentType() &&
Sebastian Redl1054fae2009-10-25 17:03:50 +0000800 "Cannot layout class with dependent bases.");
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000801
Mike Stump11289f42009-09-09 15:08:12 +0000802 const CXXRecordDecl *Base =
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000803 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000804
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000805 // Check if this is a nearly empty virtual base.
Anders Carlsson60a62632010-11-25 01:51:53 +0000806 if (I->isVirtual() && Context.isNearlyEmpty(Base)) {
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000807 // If it's not an indirect primary base, then we've found our primary
808 // base.
Anders Carlsson81430692009-09-22 03:02:06 +0000809 if (!IndirectPrimaryBases.count(Base)) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000810 PrimaryBase = Base;
811 PrimaryBaseIsVirtual = true;
Mike Stump6f3793b2009-08-12 21:50:08 +0000812 return;
813 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000814
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000815 // Is this the first nearly empty virtual base?
816 if (!FirstNearlyEmptyVBase)
817 FirstNearlyEmptyVBase = Base;
Mike Stump6f3793b2009-08-12 21:50:08 +0000818 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000819
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000820 SelectPrimaryVBase(Base);
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000821 if (PrimaryBase)
Zhongxing Xuec345b72010-02-15 04:28:35 +0000822 return;
Mike Stump6f3793b2009-08-12 21:50:08 +0000823 }
824}
825
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000826/// DeterminePrimaryBase - Determine the primary base of the given class.
Anders Carlssonc2226202010-05-26 05:58:59 +0000827void RecordLayoutBuilder::DeterminePrimaryBase(const CXXRecordDecl *RD) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000828 // If the class isn't dynamic, it won't have a primary base.
829 if (!RD->isDynamicClass())
830 return;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000831
Anders Carlsson81430692009-09-22 03:02:06 +0000832 // Compute all the primary virtual bases for all of our direct and
Mike Stump590a7c72009-08-13 23:26:06 +0000833 // indirect bases, and record all their primary virtual base classes.
Anders Carlsson5adde292010-11-24 22:55:48 +0000834 RD->getIndirectPrimaryBases(IndirectPrimaryBases);
Mike Stump590a7c72009-08-13 23:26:06 +0000835
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000836 // If the record has a dynamic base class, attempt to choose a primary base
837 // class. It is the first (in direct base class order) non-virtual dynamic
Anders Carlsson81430692009-09-22 03:02:06 +0000838 // base class, if one exists.
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000839 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000840 e = RD->bases_end(); i != e; ++i) {
Anders Carlsson03ff3792009-11-27 22:05:05 +0000841 // Ignore virtual bases.
842 if (i->isVirtual())
843 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000844
Anders Carlsson03ff3792009-11-27 22:05:05 +0000845 const CXXRecordDecl *Base =
846 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
847
John McCall0153cd32011-11-08 04:01:03 +0000848 if (isPossiblePrimaryBase(Base)) {
Anders Carlsson03ff3792009-11-27 22:05:05 +0000849 // We found it.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000850 PrimaryBase = Base;
851 PrimaryBaseIsVirtual = false;
Anders Carlsson03ff3792009-11-27 22:05:05 +0000852 return;
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000853 }
854 }
855
Eli Friedman5e9534b2011-10-18 00:55:28 +0000856 // The Microsoft ABI doesn't have primary virtual bases.
John McCall0153cd32011-11-08 04:01:03 +0000857 if (isMicrosoftCXXABI()) {
Eli Friedman5e9534b2011-10-18 00:55:28 +0000858 assert(!PrimaryBase && "Should not get here with a primary base!");
859 return;
860 }
861
862 // Under the Itanium ABI, if there is no non-virtual primary base class,
863 // try to compute the primary virtual base. The primary virtual base is
864 // the first nearly empty virtual base that is not an indirect primary
865 // virtual base class, if one exists.
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000866 if (RD->getNumVBases() != 0) {
867 SelectPrimaryVBase(RD);
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000868 if (PrimaryBase)
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000869 return;
870 }
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000871
Eli Friedman5e9534b2011-10-18 00:55:28 +0000872 // Otherwise, it is the first indirect primary base class, if one exists.
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000873 if (FirstNearlyEmptyVBase) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000874 PrimaryBase = FirstNearlyEmptyVBase;
875 PrimaryBaseIsVirtual = true;
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000876 return;
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000877 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000878
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000879 assert(!PrimaryBase && "Should not get here with a primary base!");
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000880}
881
Anders Carlssone3c24c72010-05-29 17:35:14 +0000882BaseSubobjectInfo *
883RecordLayoutBuilder::ComputeBaseSubobjectInfo(const CXXRecordDecl *RD,
884 bool IsVirtual,
885 BaseSubobjectInfo *Derived) {
886 BaseSubobjectInfo *Info;
887
888 if (IsVirtual) {
889 // Check if we already have info about this virtual base.
890 BaseSubobjectInfo *&InfoSlot = VirtualBaseInfo[RD];
891 if (InfoSlot) {
892 assert(InfoSlot->Class == RD && "Wrong class for virtual base info!");
893 return InfoSlot;
894 }
895
896 // We don't, create it.
897 InfoSlot = new (BaseSubobjectInfoAllocator.Allocate()) BaseSubobjectInfo;
898 Info = InfoSlot;
899 } else {
900 Info = new (BaseSubobjectInfoAllocator.Allocate()) BaseSubobjectInfo;
901 }
902
903 Info->Class = RD;
904 Info->IsVirtual = IsVirtual;
905 Info->Derived = 0;
906 Info->PrimaryVirtualBaseInfo = 0;
907
908 const CXXRecordDecl *PrimaryVirtualBase = 0;
909 BaseSubobjectInfo *PrimaryVirtualBaseInfo = 0;
910
911 // Check if this base has a primary virtual base.
912 if (RD->getNumVBases()) {
913 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlsson7f95cd12010-11-24 23:12:57 +0000914 if (Layout.isPrimaryBaseVirtual()) {
Anders Carlssone3c24c72010-05-29 17:35:14 +0000915 // This base does have a primary virtual base.
916 PrimaryVirtualBase = Layout.getPrimaryBase();
917 assert(PrimaryVirtualBase && "Didn't have a primary virtual base!");
918
919 // Now check if we have base subobject info about this primary base.
920 PrimaryVirtualBaseInfo = VirtualBaseInfo.lookup(PrimaryVirtualBase);
921
922 if (PrimaryVirtualBaseInfo) {
923 if (PrimaryVirtualBaseInfo->Derived) {
924 // We did have info about this primary base, and it turns out that it
925 // has already been claimed as a primary virtual base for another
926 // base.
927 PrimaryVirtualBase = 0;
928 } else {
929 // We can claim this base as our primary base.
930 Info->PrimaryVirtualBaseInfo = PrimaryVirtualBaseInfo;
931 PrimaryVirtualBaseInfo->Derived = Info;
932 }
933 }
934 }
935 }
936
937 // Now go through all direct bases.
938 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
939 E = RD->bases_end(); I != E; ++I) {
940 bool IsVirtual = I->isVirtual();
941
942 const CXXRecordDecl *BaseDecl =
943 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
944
945 Info->Bases.push_back(ComputeBaseSubobjectInfo(BaseDecl, IsVirtual, Info));
946 }
947
948 if (PrimaryVirtualBase && !PrimaryVirtualBaseInfo) {
949 // Traversing the bases must have created the base info for our primary
950 // virtual base.
951 PrimaryVirtualBaseInfo = VirtualBaseInfo.lookup(PrimaryVirtualBase);
952 assert(PrimaryVirtualBaseInfo &&
953 "Did not create a primary virtual base!");
954
955 // Claim the primary virtual base as our primary virtual base.
956 Info->PrimaryVirtualBaseInfo = PrimaryVirtualBaseInfo;
957 PrimaryVirtualBaseInfo->Derived = Info;
958 }
959
960 return Info;
961}
962
963void RecordLayoutBuilder::ComputeBaseSubobjectInfo(const CXXRecordDecl *RD) {
964 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
965 E = RD->bases_end(); I != E; ++I) {
966 bool IsVirtual = I->isVirtual();
967
968 const CXXRecordDecl *BaseDecl =
969 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
970
971 // Compute the base subobject info for this base.
972 BaseSubobjectInfo *Info = ComputeBaseSubobjectInfo(BaseDecl, IsVirtual, 0);
973
974 if (IsVirtual) {
975 // ComputeBaseInfo has already added this base for us.
976 assert(VirtualBaseInfo.count(BaseDecl) &&
977 "Did not add virtual base!");
978 } else {
979 // Add the base info to the map of non-virtual bases.
980 assert(!NonVirtualBaseInfo.count(BaseDecl) &&
981 "Non-virtual base already exists!");
982 NonVirtualBaseInfo.insert(std::make_pair(BaseDecl, Info));
983 }
984 }
985}
986
Anders Carlsson09ffa322010-03-10 22:21:28 +0000987void
Eli Friedman43114f92011-10-21 22:49:56 +0000988RecordLayoutBuilder::EnsureVTablePointerAlignment(CharUnits UnpackedBaseAlign) {
Eli Friedman5e9534b2011-10-18 00:55:28 +0000989 CharUnits BaseAlign = (Packed) ? CharUnits::One() : UnpackedBaseAlign;
990
991 // The maximum field alignment overrides base align.
992 if (!MaxFieldAlignment.isZero()) {
993 BaseAlign = std::min(BaseAlign, MaxFieldAlignment);
994 UnpackedBaseAlign = std::min(UnpackedBaseAlign, MaxFieldAlignment);
995 }
996
997 // Round up the current record size to pointer alignment.
Eli Friedman43114f92011-10-21 22:49:56 +0000998 setSize(getSize().RoundUpToAlignment(BaseAlign));
999 setDataSize(getSize());
Eli Friedman5e9534b2011-10-18 00:55:28 +00001000
1001 // Update the alignment.
1002 UpdateAlignment(BaseAlign, UnpackedBaseAlign);
1003}
1004
1005void
Anders Carlssonc2226202010-05-26 05:58:59 +00001006RecordLayoutBuilder::LayoutNonVirtualBases(const CXXRecordDecl *RD) {
Anders Carlssone3c24c72010-05-29 17:35:14 +00001007 // Then, determine the primary base class.
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001008 DeterminePrimaryBase(RD);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001009
Anders Carlssone3c24c72010-05-29 17:35:14 +00001010 // Compute base subobject info.
1011 ComputeBaseSubobjectInfo(RD);
1012
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001013 // If we have a primary base class, lay it out.
Anders Carlssond20e7cd2010-05-26 05:20:58 +00001014 if (PrimaryBase) {
1015 if (PrimaryBaseIsVirtual) {
Anders Carlssone3c24c72010-05-29 17:35:14 +00001016 // If the primary virtual base was a primary virtual base of some other
1017 // base class we'll have to steal it.
1018 BaseSubobjectInfo *PrimaryBaseInfo = VirtualBaseInfo.lookup(PrimaryBase);
1019 PrimaryBaseInfo->Derived = 0;
1020
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001021 // We have a virtual primary base, insert it as an indirect primary base.
Anders Carlssond20e7cd2010-05-26 05:20:58 +00001022 IndirectPrimaryBases.insert(PrimaryBase);
Anders Carlssonfe900962010-03-11 05:42:17 +00001023
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001024 assert(!VisitedVirtualBases.count(PrimaryBase) &&
Anders Carlssond20e7cd2010-05-26 05:20:58 +00001025 "vbase already visited!");
1026 VisitedVirtualBases.insert(PrimaryBase);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001027
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001028 LayoutVirtualBase(PrimaryBaseInfo);
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001029 } else {
1030 BaseSubobjectInfo *PrimaryBaseInfo =
1031 NonVirtualBaseInfo.lookup(PrimaryBase);
1032 assert(PrimaryBaseInfo &&
1033 "Did not find base info for non-virtual primary base!");
1034
1035 LayoutNonVirtualBase(PrimaryBaseInfo);
1036 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001037
John McCall0153cd32011-11-08 04:01:03 +00001038 // If this class needs a vtable/vf-table and didn't get one from a
1039 // primary base, add it in now.
1040 } else if (needsVFTable(RD)) {
Eli Friedman5e9534b2011-10-18 00:55:28 +00001041 assert(DataSize == 0 && "Vtable pointer must be at offset zero!");
Eli Friedman5e9534b2011-10-18 00:55:28 +00001042 CharUnits PtrWidth =
1043 Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerWidth(0));
Eli Friedman43114f92011-10-21 22:49:56 +00001044 CharUnits PtrAlign =
1045 Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerAlign(0));
1046 EnsureVTablePointerAlignment(PtrAlign);
John McCall0153cd32011-11-08 04:01:03 +00001047 if (isMicrosoftCXXABI())
1048 VFPtrOffset = getSize();
Eli Friedman5e9534b2011-10-18 00:55:28 +00001049 setSize(getSize() + PtrWidth);
1050 setDataSize(getSize());
1051 }
1052
John McCall0153cd32011-11-08 04:01:03 +00001053 bool HasDirectVirtualBases = false;
1054 bool HasNonVirtualBaseWithVBTable = false;
1055
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001056 // Now lay out the non-virtual bases.
1057 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001058 E = RD->bases_end(); I != E; ++I) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001059
John McCall0153cd32011-11-08 04:01:03 +00001060 // Ignore virtual bases, but remember that we saw one.
1061 if (I->isVirtual()) {
1062 HasDirectVirtualBases = true;
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001063 continue;
John McCall0153cd32011-11-08 04:01:03 +00001064 }
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001065
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001066 const CXXRecordDecl *BaseDecl =
John McCall0153cd32011-11-08 04:01:03 +00001067 cast<CXXRecordDecl>(I->getType()->castAs<RecordType>()->getDecl());
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001068
John McCall0153cd32011-11-08 04:01:03 +00001069 // Remember if this base has virtual bases itself.
1070 if (BaseDecl->getNumVBases())
1071 HasNonVirtualBaseWithVBTable = true;
1072
1073 // Skip the primary base, because we've already laid it out. The
1074 // !PrimaryBaseIsVirtual check is required because we might have a
1075 // non-virtual base of the same type as a primary virtual base.
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001076 if (BaseDecl == PrimaryBase && !PrimaryBaseIsVirtual)
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001077 continue;
1078
1079 // Lay out the base.
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001080 BaseSubobjectInfo *BaseInfo = NonVirtualBaseInfo.lookup(BaseDecl);
1081 assert(BaseInfo && "Did not find base info for non-virtual base!");
1082
1083 LayoutNonVirtualBase(BaseInfo);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001084 }
Eli Friedman5e9534b2011-10-18 00:55:28 +00001085
John McCall0153cd32011-11-08 04:01:03 +00001086 // In the MS ABI, add the vb-table pointer if we need one, which is
1087 // whenever we have a virtual base and we can't re-use a vb-table
1088 // pointer from a non-virtual base.
1089 if (isMicrosoftCXXABI() &&
1090 HasDirectVirtualBases && !HasNonVirtualBaseWithVBTable) {
Eli Friedman5e9534b2011-10-18 00:55:28 +00001091 CharUnits PtrWidth =
1092 Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerWidth(0));
Eli Friedman43114f92011-10-21 22:49:56 +00001093 CharUnits PtrAlign =
1094 Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerAlign(0));
John McCall0153cd32011-11-08 04:01:03 +00001095
1096 // MSVC potentially over-aligns the vb-table pointer by giving it
1097 // the max alignment of all the non-virtual objects in the class.
1098 // This is completely unnecessary, but we're not here to pass
1099 // judgment.
1100 //
1101 // Note that we've only laid out the non-virtual bases, so on the
1102 // first pass Alignment won't be set correctly here, but if the
1103 // vb-table doesn't end up aligned correctly we'll come through
1104 // and redo the layout from scratch with the right alignment.
1105 //
1106 // TODO: Instead of doing this, just lay out the fields as if the
1107 // vb-table were at offset zero, then retroactively bump the field
1108 // offsets up.
Eli Friedman43114f92011-10-21 22:49:56 +00001109 PtrAlign = std::max(PtrAlign, Alignment);
John McCall0153cd32011-11-08 04:01:03 +00001110
1111 EnsureVTablePointerAlignment(PtrAlign);
1112 VBPtrOffset = getSize();
1113 setSize(getSize() + PtrWidth);
1114 setDataSize(getSize());
Eli Friedman5e9534b2011-10-18 00:55:28 +00001115 }
Anders Carlsson09ffa322010-03-10 22:21:28 +00001116}
1117
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001118void RecordLayoutBuilder::LayoutNonVirtualBase(const BaseSubobjectInfo *Base) {
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001119 // Layout the base.
Anders Carlssona2f8e412010-10-31 22:20:42 +00001120 CharUnits Offset = LayoutBase(Base);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001121
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001122 // Add its base class offset.
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001123 assert(!Bases.count(Base->Class) && "base offset already exists!");
Anders Carlssona2f8e412010-10-31 22:20:42 +00001124 Bases.insert(std::make_pair(Base->Class, Offset));
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001125
1126 AddPrimaryVirtualBaseOffsets(Base, Offset);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001127}
Mike Stump2b84dd32009-11-05 04:02:15 +00001128
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001129void
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001130RecordLayoutBuilder::AddPrimaryVirtualBaseOffsets(const BaseSubobjectInfo *Info,
Anders Carlssona2f8e412010-10-31 22:20:42 +00001131 CharUnits Offset) {
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001132 // This base isn't interesting, it has no virtual bases.
1133 if (!Info->Class->getNumVBases())
1134 return;
1135
1136 // First, check if we have a virtual primary base to add offsets for.
1137 if (Info->PrimaryVirtualBaseInfo) {
1138 assert(Info->PrimaryVirtualBaseInfo->IsVirtual &&
1139 "Primary virtual base is not virtual!");
1140 if (Info->PrimaryVirtualBaseInfo->Derived == Info) {
1141 // Add the offset.
1142 assert(!VBases.count(Info->PrimaryVirtualBaseInfo->Class) &&
1143 "primary vbase offset already exists!");
1144 VBases.insert(std::make_pair(Info->PrimaryVirtualBaseInfo->Class,
Anders Carlssona2f8e412010-10-31 22:20:42 +00001145 Offset));
Anders Carlssonea7b1822010-04-15 16:12:58 +00001146
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001147 // Traverse the primary virtual base.
1148 AddPrimaryVirtualBaseOffsets(Info->PrimaryVirtualBaseInfo, Offset);
1149 }
Anders Carlssonea7b1822010-04-15 16:12:58 +00001150 }
1151
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001152 // Now go through all direct non-virtual bases.
1153 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Info->Class);
1154 for (unsigned I = 0, E = Info->Bases.size(); I != E; ++I) {
1155 const BaseSubobjectInfo *Base = Info->Bases[I];
1156 if (Base->IsVirtual)
Anders Carlssonea7b1822010-04-15 16:12:58 +00001157 continue;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001158
Anders Carlsson0a14ee92010-11-01 00:21:58 +00001159 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base->Class);
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001160 AddPrimaryVirtualBaseOffsets(Base, BaseOffset);
Anders Carlssonea7b1822010-04-15 16:12:58 +00001161 }
1162}
1163
John McCall0153cd32011-11-08 04:01:03 +00001164/// needsVFTable - Return true if this class needs a vtable or vf-table
1165/// when laid out as a base class. These are treated the same because
1166/// they're both always laid out at offset zero.
1167///
1168/// This function assumes that the class has no primary base.
1169bool RecordLayoutBuilder::needsVFTable(const CXXRecordDecl *RD) const {
1170 assert(!PrimaryBase);
1171
1172 // In the Itanium ABI, every dynamic class needs a vtable: even if
1173 // this class has no virtual functions as a base class (i.e. it's
1174 // non-polymorphic or only has virtual functions from virtual
1175 // bases),x it still needs a vtable to locate its virtual bases.
1176 if (!isMicrosoftCXXABI())
1177 return RD->isDynamicClass();
1178
1179 // In the MS ABI, we need a vfptr if the class has virtual functions
1180 // other than those declared by its virtual bases. The AST doesn't
1181 // tell us that directly, and checking manually for virtual
1182 // functions that aren't overrides is expensive, but there are
1183 // some important shortcuts:
1184
1185 // - Non-polymorphic classes have no virtual functions at all.
1186 if (!RD->isPolymorphic()) return false;
1187
1188 // - Polymorphic classes with no virtual bases must either declare
1189 // virtual functions directly or inherit them, but in the latter
1190 // case we would have a primary base.
1191 if (RD->getNumVBases() == 0) return true;
1192
1193 return hasNewVirtualFunction(RD);
1194}
1195
1196/// hasNewVirtualFunction - Does the given polymorphic class declare a
1197/// virtual function that does not override a method from any of its
1198/// base classes?
Eli Friedman84d2d3a2011-09-27 19:12:27 +00001199bool
John McCall0153cd32011-11-08 04:01:03 +00001200RecordLayoutBuilder::hasNewVirtualFunction(const CXXRecordDecl *RD) const {
1201 assert(RD->isPolymorphic());
1202 if (!RD->getNumBases())
1203 return true;
1204
Eli Friedman84d2d3a2011-09-27 19:12:27 +00001205 for (CXXRecordDecl::method_iterator method = RD->method_begin();
1206 method != RD->method_end();
1207 ++method) {
John McCall0153cd32011-11-08 04:01:03 +00001208 if (method->isVirtual() && !method->size_overridden_methods()) {
Eli Friedman84d2d3a2011-09-27 19:12:27 +00001209 return true;
1210 }
1211 }
1212 return false;
1213}
1214
John McCall0153cd32011-11-08 04:01:03 +00001215/// isPossiblePrimaryBase - Is the given base class an acceptable
1216/// primary base class?
Eli Friedman5e9534b2011-10-18 00:55:28 +00001217bool
John McCall0153cd32011-11-08 04:01:03 +00001218RecordLayoutBuilder::isPossiblePrimaryBase(const CXXRecordDecl *Base) const {
1219 // In the Itanium ABI, a class can be a primary base class if it has
1220 // a vtable for any reason.
1221 if (!isMicrosoftCXXABI())
1222 return Base->isDynamicClass();
1223
1224 // In the MS ABI, a class can only be a primary base class if it
1225 // provides a vf-table at a static offset. That means it has to be
1226 // non-virtual base. The existence of a separate vb-table means
1227 // that it's possible to get virtual functions only from a virtual
1228 // base, which we have to guard against.
1229
1230 // First off, it has to have virtual functions.
1231 if (!Base->isPolymorphic()) return false;
1232
1233 // If it has no virtual bases, then everything is at a static offset.
1234 if (!Base->getNumVBases()) return true;
1235
1236 // Okay, just ask the base class's layout.
1237 return (Context.getASTRecordLayout(Base).getVFPtrOffset()
1238 != CharUnits::fromQuantity(-1));
Eli Friedman84d2d3a2011-09-27 19:12:27 +00001239}
1240
Anders Carlssonea7b1822010-04-15 16:12:58 +00001241void
Anders Carlssonc2226202010-05-26 05:58:59 +00001242RecordLayoutBuilder::LayoutVirtualBases(const CXXRecordDecl *RD,
Anders Carlssonea7b1822010-04-15 16:12:58 +00001243 const CXXRecordDecl *MostDerivedClass) {
Anders Carlssonde710c92010-03-11 04:33:54 +00001244 const CXXRecordDecl *PrimaryBase;
Anders Carlsson291279e2010-04-10 18:42:27 +00001245 bool PrimaryBaseIsVirtual;
Anders Carlssonfe900962010-03-11 05:42:17 +00001246
Anders Carlsson291279e2010-04-10 18:42:27 +00001247 if (MostDerivedClass == RD) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +00001248 PrimaryBase = this->PrimaryBase;
1249 PrimaryBaseIsVirtual = this->PrimaryBaseIsVirtual;
Anders Carlsson291279e2010-04-10 18:42:27 +00001250 } else {
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001251 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlssonde710c92010-03-11 04:33:54 +00001252 PrimaryBase = Layout.getPrimaryBase();
Anders Carlsson7f95cd12010-11-24 23:12:57 +00001253 PrimaryBaseIsVirtual = Layout.isPrimaryBaseVirtual();
Anders Carlsson291279e2010-04-10 18:42:27 +00001254 }
1255
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001256 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1257 E = RD->bases_end(); I != E; ++I) {
1258 assert(!I->getType()->isDependentType() &&
Sebastian Redl1054fae2009-10-25 17:03:50 +00001259 "Cannot layout class with dependent bases.");
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001260
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001261 const CXXRecordDecl *BaseDecl =
John McCall0153cd32011-11-08 04:01:03 +00001262 cast<CXXRecordDecl>(I->getType()->castAs<RecordType>()->getDecl());
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001263
1264 if (I->isVirtual()) {
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001265 if (PrimaryBase != BaseDecl || !PrimaryBaseIsVirtual) {
1266 bool IndirectPrimaryBase = IndirectPrimaryBases.count(BaseDecl);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001267
Anders Carlsson291279e2010-04-10 18:42:27 +00001268 // Only lay out the virtual base if it's not an indirect primary base.
1269 if (!IndirectPrimaryBase) {
1270 // Only visit virtual bases once.
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001271 if (!VisitedVirtualBases.insert(BaseDecl))
Anders Carlsson291279e2010-04-10 18:42:27 +00001272 continue;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001273
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001274 const BaseSubobjectInfo *BaseInfo = VirtualBaseInfo.lookup(BaseDecl);
1275 assert(BaseInfo && "Did not find virtual base info!");
1276 LayoutVirtualBase(BaseInfo);
Anders Carlsson6a848892010-03-11 04:10:39 +00001277 }
Mike Stump2b84dd32009-11-05 04:02:15 +00001278 }
Mike Stumpc2f591b2009-08-13 22:53:07 +00001279 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001280
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001281 if (!BaseDecl->getNumVBases()) {
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001282 // This base isn't interesting since it doesn't have any virtual bases.
1283 continue;
Mike Stump996576f32009-08-16 19:04:13 +00001284 }
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001285
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001286 LayoutVirtualBases(BaseDecl, MostDerivedClass);
Mike Stump6b2556f2009-08-06 13:41:24 +00001287 }
1288}
1289
John McCall0153cd32011-11-08 04:01:03 +00001290void RecordLayoutBuilder::MSLayoutVirtualBases(const CXXRecordDecl *RD) {
1291
1292 if (!RD->getNumVBases())
1293 return;
1294
1295 // This is substantially simplified because there are no virtual
1296 // primary bases.
1297 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
1298 E = RD->vbases_end(); I != E; ++I) {
1299 const CXXRecordDecl *BaseDecl = I->getType()->getAsCXXRecordDecl();
1300 const BaseSubobjectInfo *BaseInfo = VirtualBaseInfo.lookup(BaseDecl);
1301 assert(BaseInfo && "Did not find virtual base info!");
1302
1303 LayoutVirtualBase(BaseInfo);
1304 }
1305}
1306
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001307void RecordLayoutBuilder::LayoutVirtualBase(const BaseSubobjectInfo *Base) {
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001308 assert(!Base->Derived && "Trying to lay out a primary virtual base!");
1309
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001310 // Layout the base.
Anders Carlssona2f8e412010-10-31 22:20:42 +00001311 CharUnits Offset = LayoutBase(Base);
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001312
1313 // Add its base class offset.
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001314 assert(!VBases.count(Base->Class) && "vbase offset already exists!");
Anders Carlssona2f8e412010-10-31 22:20:42 +00001315 VBases.insert(std::make_pair(Base->Class, Offset));
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001316
1317 AddPrimaryVirtualBaseOffsets(Base, Offset);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001318}
1319
Anders Carlssona2f8e412010-10-31 22:20:42 +00001320CharUnits RecordLayoutBuilder::LayoutBase(const BaseSubobjectInfo *Base) {
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001321 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Base->Class);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001322
Douglas Gregore9fc3772012-01-26 07:55:45 +00001323
1324 CharUnits Offset;
1325
1326 // Query the external layout to see if it provides an offset.
1327 bool HasExternalLayout = false;
1328 if (ExternalLayout) {
1329 llvm::DenseMap<const CXXRecordDecl *, CharUnits>::iterator Known;
1330 if (Base->IsVirtual) {
1331 Known = ExternalVirtualBaseOffsets.find(Base->Class);
1332 if (Known != ExternalVirtualBaseOffsets.end()) {
1333 Offset = Known->second;
1334 HasExternalLayout = true;
1335 }
1336 } else {
1337 Known = ExternalBaseOffsets.find(Base->Class);
1338 if (Known != ExternalBaseOffsets.end()) {
1339 Offset = Known->second;
1340 HasExternalLayout = true;
1341 }
1342 }
1343 }
1344
Anders Carlsson09ffa322010-03-10 22:21:28 +00001345 // If we have an empty base class, try to place it at offset 0.
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001346 if (Base->Class->isEmpty() &&
Douglas Gregore9fc3772012-01-26 07:55:45 +00001347 (!HasExternalLayout || Offset == CharUnits::Zero()) &&
Anders Carlsson28466ab2010-10-31 22:13:23 +00001348 EmptySubobjects->CanPlaceBaseAtOffset(Base, CharUnits::Zero())) {
Ken Dyck1b4420e2011-02-28 02:01:38 +00001349 setSize(std::max(getSize(), Layout.getSize()));
Anders Carlsson09ffa322010-03-10 22:21:28 +00001350
Anders Carlssona2f8e412010-10-31 22:20:42 +00001351 return CharUnits::Zero();
Anders Carlsson09ffa322010-03-10 22:21:28 +00001352 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001353
Ken Dyck85ef0432011-02-19 18:58:07 +00001354 CharUnits UnpackedBaseAlign = Layout.getNonVirtualAlign();
1355 CharUnits BaseAlign = (Packed) ? CharUnits::One() : UnpackedBaseAlign;
Argyrios Kyrtzidis8b542742010-12-09 00:35:20 +00001356
1357 // The maximum field alignment overrides base align.
Ken Dyck02ced6f2011-02-17 01:49:42 +00001358 if (!MaxFieldAlignment.isZero()) {
Ken Dyck85ef0432011-02-19 18:58:07 +00001359 BaseAlign = std::min(BaseAlign, MaxFieldAlignment);
1360 UnpackedBaseAlign = std::min(UnpackedBaseAlign, MaxFieldAlignment);
Argyrios Kyrtzidis8b542742010-12-09 00:35:20 +00001361 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001362
Douglas Gregore9fc3772012-01-26 07:55:45 +00001363 if (!HasExternalLayout) {
1364 // Round up the current record size to the base's alignment boundary.
1365 Offset = getDataSize().RoundUpToAlignment(BaseAlign);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001366
Douglas Gregore9fc3772012-01-26 07:55:45 +00001367 // Try to place the base.
1368 while (!EmptySubobjects->CanPlaceBaseAtOffset(Base, Offset))
1369 Offset += BaseAlign;
1370 } else {
1371 bool Allowed = EmptySubobjects->CanPlaceBaseAtOffset(Base, Offset);
1372 (void)Allowed;
1373 assert(Allowed && "Base subobject externally placed at overlapping offset");
1374 }
1375
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001376 if (!Base->Class->isEmpty()) {
Anders Carlsson09ffa322010-03-10 22:21:28 +00001377 // Update the data size.
Ken Dyck1b4420e2011-02-28 02:01:38 +00001378 setDataSize(Offset + Layout.getNonVirtualSize());
Anders Carlsson09ffa322010-03-10 22:21:28 +00001379
Ken Dyck1b4420e2011-02-28 02:01:38 +00001380 setSize(std::max(getSize(), getDataSize()));
Anders Carlsson09ffa322010-03-10 22:21:28 +00001381 } else
Ken Dyck1b4420e2011-02-28 02:01:38 +00001382 setSize(std::max(getSize(), Offset + Layout.getSize()));
Anders Carlsson09ffa322010-03-10 22:21:28 +00001383
1384 // Remember max struct/class alignment.
Argyrios Kyrtzidis8b542742010-12-09 00:35:20 +00001385 UpdateAlignment(BaseAlign, UnpackedBaseAlign);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001386
Ken Dyck1b4420e2011-02-28 02:01:38 +00001387 return Offset;
Anders Carlsson09ffa322010-03-10 22:21:28 +00001388}
1389
Daniel Dunbar6da10982010-05-27 05:45:51 +00001390void RecordLayoutBuilder::InitializeLayout(const Decl *D) {
1391 if (const RecordDecl *RD = dyn_cast<RecordDecl>(D))
1392 IsUnion = RD->isUnion();
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001393
Anders Carlsson28a5fa22009-08-08 19:38:24 +00001394 Packed = D->hasAttr<PackedAttr>();
Fariborz Jahanianbcb23a12011-04-26 23:52:16 +00001395
1396 IsMsStruct = D->hasAttr<MsStructAttr>();
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001397
Daniel Dunbar096ed292011-10-05 21:04:55 +00001398 // Honor the default struct packing maximum alignment flag.
David Blaikiebbafb8a2012-03-11 07:00:24 +00001399 if (unsigned DefaultMaxFieldAlignment = Context.getLangOpts().PackStruct) {
Daniel Dunbar096ed292011-10-05 21:04:55 +00001400 MaxFieldAlignment = CharUnits::fromQuantity(DefaultMaxFieldAlignment);
1401 }
1402
Daniel Dunbar6da10982010-05-27 05:45:51 +00001403 // mac68k alignment supersedes maximum field alignment and attribute aligned,
1404 // and forces all structures to have 2-byte alignment. The IBM docs on it
1405 // allude to additional (more complicated) semantics, especially with regard
1406 // to bit-fields, but gcc appears not to follow that.
1407 if (D->hasAttr<AlignMac68kAttr>()) {
1408 IsMac68kAlign = true;
Ken Dyck02ced6f2011-02-17 01:49:42 +00001409 MaxFieldAlignment = CharUnits::fromQuantity(2);
Ken Dyck4731d5b2011-02-16 02:05:21 +00001410 Alignment = CharUnits::fromQuantity(2);
Daniel Dunbar6da10982010-05-27 05:45:51 +00001411 } else {
1412 if (const MaxFieldAlignmentAttr *MFAA = D->getAttr<MaxFieldAlignmentAttr>())
Ken Dyck02ced6f2011-02-17 01:49:42 +00001413 MaxFieldAlignment = Context.toCharUnitsFromBits(MFAA->getAlignment());
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001414
Alexis Huntdcfba7b2010-08-18 23:23:40 +00001415 if (unsigned MaxAlign = D->getMaxAlignment())
Ken Dyck85ef0432011-02-19 18:58:07 +00001416 UpdateAlignment(Context.toCharUnitsFromBits(MaxAlign));
Daniel Dunbar6da10982010-05-27 05:45:51 +00001417 }
Douglas Gregore9fc3772012-01-26 07:55:45 +00001418
1419 // If there is an external AST source, ask it for the various offsets.
1420 if (const RecordDecl *RD = dyn_cast<RecordDecl>(D))
1421 if (ExternalASTSource *External = Context.getExternalSource()) {
1422 ExternalLayout = External->layoutRecordType(RD,
1423 ExternalSize,
1424 ExternalAlign,
1425 ExternalFieldOffsets,
1426 ExternalBaseOffsets,
1427 ExternalVirtualBaseOffsets);
1428
1429 // Update based on external alignment.
1430 if (ExternalLayout) {
Douglas Gregor44ba7892012-01-28 00:53:29 +00001431 if (ExternalAlign > 0) {
1432 Alignment = Context.toCharUnitsFromBits(ExternalAlign);
1433 UnpackedAlignment = Alignment;
1434 } else {
1435 // The external source didn't have alignment information; infer it.
1436 InferAlignment = true;
1437 }
Douglas Gregore9fc3772012-01-26 07:55:45 +00001438 }
1439 }
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001440}
Anders Carlsson6d9f6f32009-07-19 00:18:47 +00001441
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001442void RecordLayoutBuilder::Layout(const RecordDecl *D) {
1443 InitializeLayout(D);
Anders Carlsson118ce162009-07-18 21:48:39 +00001444 LayoutFields(D);
Mike Stump11289f42009-09-09 15:08:12 +00001445
Anders Carlsson79474332009-07-18 20:20:21 +00001446 // Finally, round the size of the total struct up to the alignment of the
1447 // struct itself.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001448 FinishLayout(D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001449}
1450
1451void RecordLayoutBuilder::Layout(const CXXRecordDecl *RD) {
1452 InitializeLayout(RD);
1453
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001454 // Lay out the vtable and the non-virtual bases.
1455 LayoutNonVirtualBases(RD);
1456
1457 LayoutFields(RD);
1458
Ken Dycke7380752011-03-10 01:53:59 +00001459 NonVirtualSize = Context.toCharUnitsFromBits(
1460 llvm::RoundUpToAlignment(getSizeInBits(),
Douglas Gregore8bbc122011-09-02 00:18:52 +00001461 Context.getTargetInfo().getCharAlign()));
Ken Dyck4731d5b2011-02-16 02:05:21 +00001462 NonVirtualAlignment = Alignment;
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001463
John McCall0153cd32011-11-08 04:01:03 +00001464 if (isMicrosoftCXXABI() &&
1465 NonVirtualSize != NonVirtualSize.RoundUpToAlignment(Alignment)) {
1466 CharUnits AlignMember =
1467 NonVirtualSize.RoundUpToAlignment(Alignment) - NonVirtualSize;
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001468
John McCall0153cd32011-11-08 04:01:03 +00001469 setSize(getSize() + AlignMember);
1470 setDataSize(getSize());
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001471
John McCall0153cd32011-11-08 04:01:03 +00001472 NonVirtualSize = Context.toCharUnitsFromBits(
1473 llvm::RoundUpToAlignment(getSizeInBits(),
1474 Context.getTargetInfo().getCharAlign()));
1475
1476 MSLayoutVirtualBases(RD);
1477
1478 } else {
1479 // Lay out the virtual bases and add the primary virtual base offsets.
1480 LayoutVirtualBases(RD, RD);
1481 }
1482
1483 // Finally, round the size of the total struct up to the alignment
Eli Friedman83a12582011-12-01 00:37:01 +00001484 // of the struct itself.
1485 FinishLayout(RD);
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001486
Anders Carlsson5b441d72010-04-10 21:24:48 +00001487#ifndef NDEBUG
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001488 // Check that we have base offsets for all bases.
1489 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1490 E = RD->bases_end(); I != E; ++I) {
1491 if (I->isVirtual())
1492 continue;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001493
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001494 const CXXRecordDecl *BaseDecl =
1495 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1496
1497 assert(Bases.count(BaseDecl) && "Did not find base offset!");
1498 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001499
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001500 // And all virtual bases.
1501 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
1502 E = RD->vbases_end(); I != E; ++I) {
1503 const CXXRecordDecl *BaseDecl =
1504 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001505
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001506 assert(VBases.count(BaseDecl) && "Did not find base offset!");
Anders Carlsson5b441d72010-04-10 21:24:48 +00001507 }
1508#endif
Anders Carlsson79474332009-07-18 20:20:21 +00001509}
1510
Anders Carlssonc2226202010-05-26 05:58:59 +00001511void RecordLayoutBuilder::Layout(const ObjCInterfaceDecl *D) {
Anders Carlsson4f516282009-07-18 20:50:59 +00001512 if (ObjCInterfaceDecl *SD = D->getSuperClass()) {
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001513 const ASTRecordLayout &SL = Context.getASTObjCInterfaceLayout(SD);
Anders Carlsson4f516282009-07-18 20:50:59 +00001514
Ken Dyck85ef0432011-02-19 18:58:07 +00001515 UpdateAlignment(SL.getAlignment());
Mike Stump11289f42009-09-09 15:08:12 +00001516
Anders Carlsson4f516282009-07-18 20:50:59 +00001517 // We start laying out ivars not at the end of the superclass
1518 // structure, but at the next byte following the last field.
Ken Dyckecfc7552011-02-24 01:13:28 +00001519 setSize(SL.getDataSize());
Ken Dyck1b4420e2011-02-28 02:01:38 +00001520 setDataSize(getSize());
Anders Carlsson4f516282009-07-18 20:50:59 +00001521 }
Mike Stump11289f42009-09-09 15:08:12 +00001522
Daniel Dunbar6da10982010-05-27 05:45:51 +00001523 InitializeLayout(D);
Anders Carlsson4f516282009-07-18 20:50:59 +00001524 // Layout each ivar sequentially.
Jordy Rosea91768e2011-07-22 02:08:32 +00001525 for (const ObjCIvarDecl *IVD = D->all_declared_ivar_begin(); IVD;
1526 IVD = IVD->getNextIvar())
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00001527 LayoutField(IVD);
Mike Stump11289f42009-09-09 15:08:12 +00001528
Anders Carlsson4f516282009-07-18 20:50:59 +00001529 // Finally, round the size of the total struct up to the alignment of the
1530 // struct itself.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001531 FinishLayout(D);
Anders Carlsson4f516282009-07-18 20:50:59 +00001532}
1533
Anders Carlssonc2226202010-05-26 05:58:59 +00001534void RecordLayoutBuilder::LayoutFields(const RecordDecl *D) {
Anders Carlsson118ce162009-07-18 21:48:39 +00001535 // Layout each field, for now, just sequentially, respecting alignment. In
1536 // the future, this will need to be tweakable by targets.
Fariborz Jahanianbcb23a12011-04-26 23:52:16 +00001537 const FieldDecl *LastFD = 0;
Fariborz Jahanianfc0fe6e2011-05-03 20:21:04 +00001538 ZeroLengthBitfield = 0;
Fariborz Jahanian783243b2011-05-11 16:58:31 +00001539 unsigned RemainingInAlignment = 0;
Mike Stump11289f42009-09-09 15:08:12 +00001540 for (RecordDecl::field_iterator Field = D->field_begin(),
Fariborz Jahanianbcb23a12011-04-26 23:52:16 +00001541 FieldEnd = D->field_end(); Field != FieldEnd; ++Field) {
1542 if (IsMsStruct) {
Fariborz Jahanianfc0fe6e2011-05-03 20:21:04 +00001543 FieldDecl *FD = (*Field);
1544 if (Context.ZeroBitfieldFollowsBitfield(FD, LastFD))
1545 ZeroLengthBitfield = FD;
Fariborz Jahanianbcb23a12011-04-26 23:52:16 +00001546 // Zero-length bitfields following non-bitfield members are
1547 // ignored:
Fariborz Jahanianfc0fe6e2011-05-03 20:21:04 +00001548 else if (Context.ZeroBitfieldFollowsNonBitfield(FD, LastFD))
Fariborz Jahanianbcb23a12011-04-26 23:52:16 +00001549 continue;
Fariborz Jahanian307eace2011-05-06 22:42:22 +00001550 // FIXME. streamline these conditions into a simple one.
Fariborz Jahanianb7a28792011-05-06 21:56:12 +00001551 else if (Context.BitfieldFollowsBitfield(FD, LastFD) ||
Chad Rosierf01a7dd2011-08-04 23:34:15 +00001552 Context.BitfieldFollowsNonBitfield(FD, LastFD) ||
1553 Context.NonBitfieldFollowsBitfield(FD, LastFD)) {
Fariborz Jahanian307eace2011-05-06 22:42:22 +00001554 // 1) Adjacent bit fields are packed into the same 1-, 2-, or
Fariborz Jahanian84335f72011-05-04 18:51:37 +00001555 // 4-byte allocation unit if the integral types are the same
1556 // size and if the next bit field fits into the current
1557 // allocation unit without crossing the boundary imposed by the
1558 // common alignment requirements of the bit fields.
Fariborz Jahanian307eace2011-05-06 22:42:22 +00001559 // 2) Establish a new alignment for a bitfield following
Fariborz Jahanianb7a28792011-05-06 21:56:12 +00001560 // a non-bitfield if size of their types differ.
Fariborz Jahanian307eace2011-05-06 22:42:22 +00001561 // 3) Establish a new alignment for a non-bitfield following
1562 // a bitfield if size of their types differ.
Fariborz Jahanian84335f72011-05-04 18:51:37 +00001563 std::pair<uint64_t, unsigned> FieldInfo =
1564 Context.getTypeInfo(FD->getType());
1565 uint64_t TypeSize = FieldInfo.first;
1566 unsigned FieldAlign = FieldInfo.second;
Fariborz Jahanian7adbed62011-05-09 22:03:17 +00001567 // This check is needed for 'long long' in -m32 mode.
Fariborz Jahanian0586df42011-12-12 21:16:36 +00001568 if (TypeSize > FieldAlign &&
1569 (Context.hasSameType(FD->getType(),
1570 Context.UnsignedLongLongTy)
1571 ||Context.hasSameType(FD->getType(),
1572 Context.LongLongTy)))
Fariborz Jahanian7adbed62011-05-09 22:03:17 +00001573 FieldAlign = TypeSize;
Fariborz Jahanian84335f72011-05-04 18:51:37 +00001574 FieldInfo = Context.getTypeInfo(LastFD->getType());
1575 uint64_t TypeSizeLastFD = FieldInfo.first;
1576 unsigned FieldAlignLastFD = FieldInfo.second;
Fariborz Jahanian7adbed62011-05-09 22:03:17 +00001577 // This check is needed for 'long long' in -m32 mode.
Fariborz Jahanian0586df42011-12-12 21:16:36 +00001578 if (TypeSizeLastFD > FieldAlignLastFD &&
1579 (Context.hasSameType(LastFD->getType(),
1580 Context.UnsignedLongLongTy)
1581 || Context.hasSameType(LastFD->getType(),
1582 Context.LongLongTy)))
Fariborz Jahanian7adbed62011-05-09 22:03:17 +00001583 FieldAlignLastFD = TypeSizeLastFD;
Fariborz Jahanian783243b2011-05-11 16:58:31 +00001584
Fariborz Jahanian84335f72011-05-04 18:51:37 +00001585 if (TypeSizeLastFD != TypeSize) {
Fariborz Jahanian783243b2011-05-11 16:58:31 +00001586 if (RemainingInAlignment &&
1587 LastFD && LastFD->isBitField() &&
Richard Smithcaf33902011-10-10 18:28:20 +00001588 LastFD->getBitWidthValue(Context)) {
Fariborz Jahanian783243b2011-05-11 16:58:31 +00001589 // If previous field was a bitfield with some remaining unfilled
1590 // bits, pad the field so current field starts on its type boundary.
1591 uint64_t FieldOffset =
1592 getDataSizeInBits() - UnfilledBitsInLastByte;
1593 uint64_t NewSizeInBits = RemainingInAlignment + FieldOffset;
1594 setDataSize(llvm::RoundUpToAlignment(NewSizeInBits,
Douglas Gregore8bbc122011-09-02 00:18:52 +00001595 Context.getTargetInfo().getCharAlign()));
Fariborz Jahanian783243b2011-05-11 16:58:31 +00001596 setSize(std::max(getSizeInBits(), getDataSizeInBits()));
1597 RemainingInAlignment = 0;
1598 }
1599
Fariborz Jahanian84335f72011-05-04 18:51:37 +00001600 uint64_t UnpaddedFieldOffset =
1601 getDataSizeInBits() - UnfilledBitsInLastByte;
1602 FieldAlign = std::max(FieldAlign, FieldAlignLastFD);
Fariborz Jahanian783243b2011-05-11 16:58:31 +00001603
Fariborz Jahanian07ceb0a2011-05-10 19:00:50 +00001604 // The maximum field alignment overrides the aligned attribute.
1605 if (!MaxFieldAlignment.isZero()) {
1606 unsigned MaxFieldAlignmentInBits =
1607 Context.toBits(MaxFieldAlignment);
1608 FieldAlign = std::min(FieldAlign, MaxFieldAlignmentInBits);
1609 }
Fariborz Jahanian783243b2011-05-11 16:58:31 +00001610
Fariborz Jahanian84335f72011-05-04 18:51:37 +00001611 uint64_t NewSizeInBits =
1612 llvm::RoundUpToAlignment(UnpaddedFieldOffset, FieldAlign);
1613 setDataSize(llvm::RoundUpToAlignment(NewSizeInBits,
Douglas Gregore8bbc122011-09-02 00:18:52 +00001614 Context.getTargetInfo().getCharAlign()));
Fariborz Jahanian84335f72011-05-04 18:51:37 +00001615 UnfilledBitsInLastByte = getDataSizeInBits() - NewSizeInBits;
1616 setSize(std::max(getSizeInBits(), getDataSizeInBits()));
1617 }
Fariborz Jahanian783243b2011-05-11 16:58:31 +00001618 if (FD->isBitField()) {
Richard Smithcaf33902011-10-10 18:28:20 +00001619 uint64_t FieldSize = FD->getBitWidthValue(Context);
Fariborz Jahanian783243b2011-05-11 16:58:31 +00001620 assert (FieldSize > 0 && "LayoutFields - ms_struct layout");
1621 if (RemainingInAlignment < FieldSize)
1622 RemainingInAlignment = TypeSize - FieldSize;
1623 else
1624 RemainingInAlignment -= FieldSize;
1625 }
1626 }
1627 else if (FD->isBitField()) {
Richard Smithcaf33902011-10-10 18:28:20 +00001628 uint64_t FieldSize = FD->getBitWidthValue(Context);
Fariborz Jahanian783243b2011-05-11 16:58:31 +00001629 std::pair<uint64_t, unsigned> FieldInfo =
1630 Context.getTypeInfo(FD->getType());
1631 uint64_t TypeSize = FieldInfo.first;
1632 RemainingInAlignment = TypeSize - FieldSize;
Fariborz Jahanian84335f72011-05-04 18:51:37 +00001633 }
Fariborz Jahanianbcb23a12011-04-26 23:52:16 +00001634 LastFD = FD;
1635 }
Douglas Gregore8bbc122011-09-02 00:18:52 +00001636 else if (!Context.getTargetInfo().useBitFieldTypeAlignment() &&
1637 Context.getTargetInfo().useZeroLengthBitfieldAlignment()) {
Chad Rosier18903ee2011-08-04 01:21:14 +00001638 FieldDecl *FD = (*Field);
Richard Smithcaf33902011-10-10 18:28:20 +00001639 if (FD->isBitField() && FD->getBitWidthValue(Context) == 0)
Chad Rosier18903ee2011-08-04 01:21:14 +00001640 ZeroLengthBitfield = FD;
Chad Rosier18903ee2011-08-04 01:21:14 +00001641 }
Anders Carlsson118ce162009-07-18 21:48:39 +00001642 LayoutField(*Field);
Fariborz Jahanianbcb23a12011-04-26 23:52:16 +00001643 }
Fariborz Jahanian783243b2011-05-11 16:58:31 +00001644 if (IsMsStruct && RemainingInAlignment &&
Richard Smithcaf33902011-10-10 18:28:20 +00001645 LastFD && LastFD->isBitField() && LastFD->getBitWidthValue(Context)) {
Fariborz Jahanian783243b2011-05-11 16:58:31 +00001646 // If we ended a bitfield before the full length of the type then
1647 // pad the struct out to the full length of the last type.
1648 uint64_t FieldOffset =
1649 getDataSizeInBits() - UnfilledBitsInLastByte;
1650 uint64_t NewSizeInBits = RemainingInAlignment + FieldOffset;
1651 setDataSize(llvm::RoundUpToAlignment(NewSizeInBits,
Douglas Gregore8bbc122011-09-02 00:18:52 +00001652 Context.getTargetInfo().getCharAlign()));
Fariborz Jahanian783243b2011-05-11 16:58:31 +00001653 setSize(std::max(getSizeInBits(), getDataSizeInBits()));
1654 }
Anders Carlsson118ce162009-07-18 21:48:39 +00001655}
1656
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001657void RecordLayoutBuilder::LayoutWideBitField(uint64_t FieldSize,
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001658 uint64_t TypeSize,
1659 bool FieldPacked,
1660 const FieldDecl *D) {
David Blaikiebbafb8a2012-03-11 07:00:24 +00001661 assert(Context.getLangOpts().CPlusPlus &&
Anders Carlsson57235162010-04-16 15:57:11 +00001662 "Can only have wide bit-fields in C++!");
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001663
Anders Carlsson57235162010-04-16 15:57:11 +00001664 // Itanium C++ ABI 2.4:
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001665 // If sizeof(T)*8 < n, let T' be the largest integral POD type with
Anders Carlsson57235162010-04-16 15:57:11 +00001666 // sizeof(T')*8 <= n.
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001667
Anders Carlsson57235162010-04-16 15:57:11 +00001668 QualType IntegralPODTypes[] = {
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001669 Context.UnsignedCharTy, Context.UnsignedShortTy, Context.UnsignedIntTy,
Anders Carlsson57235162010-04-16 15:57:11 +00001670 Context.UnsignedLongTy, Context.UnsignedLongLongTy
1671 };
1672
Anders Carlsson57235162010-04-16 15:57:11 +00001673 QualType Type;
1674 for (unsigned I = 0, E = llvm::array_lengthof(IntegralPODTypes);
1675 I != E; ++I) {
1676 uint64_t Size = Context.getTypeSize(IntegralPODTypes[I]);
Anders Carlsson57235162010-04-16 15:57:11 +00001677
1678 if (Size > FieldSize)
1679 break;
1680
1681 Type = IntegralPODTypes[I];
1682 }
1683 assert(!Type.isNull() && "Did not find a type!");
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001684
Ken Dyckdbe37f32011-03-01 01:36:00 +00001685 CharUnits TypeAlign = Context.getTypeAlignInChars(Type);
Anders Carlsson57235162010-04-16 15:57:11 +00001686
1687 // We're not going to use any of the unfilled bits in the last byte.
1688 UnfilledBitsInLastByte = 0;
1689
Anders Carlssonaad5fa82010-04-17 20:21:41 +00001690 uint64_t FieldOffset;
Ken Dyckecfc7552011-02-24 01:13:28 +00001691 uint64_t UnpaddedFieldOffset = getDataSizeInBits() - UnfilledBitsInLastByte;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001692
Anders Carlsson57235162010-04-16 15:57:11 +00001693 if (IsUnion) {
Ken Dyckecfc7552011-02-24 01:13:28 +00001694 setDataSize(std::max(getDataSizeInBits(), FieldSize));
Anders Carlssonaad5fa82010-04-17 20:21:41 +00001695 FieldOffset = 0;
Anders Carlsson57235162010-04-16 15:57:11 +00001696 } else {
Chad Rosiere1a6a0e2011-08-05 22:38:04 +00001697 // The bitfield is allocated starting at the next offset aligned
1698 // appropriately for T', with length n bits.
Ken Dyckdbe37f32011-03-01 01:36:00 +00001699 FieldOffset = llvm::RoundUpToAlignment(getDataSizeInBits(),
1700 Context.toBits(TypeAlign));
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001701
Anders Carlsson57235162010-04-16 15:57:11 +00001702 uint64_t NewSizeInBits = FieldOffset + FieldSize;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001703
Ken Dycka1a2e8d2011-03-10 02:00:35 +00001704 setDataSize(llvm::RoundUpToAlignment(NewSizeInBits,
Douglas Gregore8bbc122011-09-02 00:18:52 +00001705 Context.getTargetInfo().getCharAlign()));
Ken Dyckecfc7552011-02-24 01:13:28 +00001706 UnfilledBitsInLastByte = getDataSizeInBits() - NewSizeInBits;
Anders Carlsson57235162010-04-16 15:57:11 +00001707 }
1708
1709 // Place this field at the current location.
1710 FieldOffsets.push_back(FieldOffset);
1711
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001712 CheckFieldPadding(FieldOffset, UnpaddedFieldOffset, FieldOffset,
Ken Dyckdbe37f32011-03-01 01:36:00 +00001713 Context.toBits(TypeAlign), FieldPacked, D);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001714
Anders Carlsson57235162010-04-16 15:57:11 +00001715 // Update the size.
Ken Dyckecfc7552011-02-24 01:13:28 +00001716 setSize(std::max(getSizeInBits(), getDataSizeInBits()));
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001717
Anders Carlsson57235162010-04-16 15:57:11 +00001718 // Remember max struct/class alignment.
Ken Dyckdbe37f32011-03-01 01:36:00 +00001719 UpdateAlignment(TypeAlign);
Anders Carlsson57235162010-04-16 15:57:11 +00001720}
1721
Anders Carlssonc2226202010-05-26 05:58:59 +00001722void RecordLayoutBuilder::LayoutBitField(const FieldDecl *D) {
Anders Carlsson07209442009-11-22 17:37:31 +00001723 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Ken Dyckecfc7552011-02-24 01:13:28 +00001724 uint64_t UnpaddedFieldOffset = getDataSizeInBits() - UnfilledBitsInLastByte;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001725 uint64_t FieldOffset = IsUnion ? 0 : UnpaddedFieldOffset;
Richard Smithcaf33902011-10-10 18:28:20 +00001726 uint64_t FieldSize = D->getBitWidthValue(Context);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001727
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001728 std::pair<uint64_t, unsigned> FieldInfo = Context.getTypeInfo(D->getType());
Anders Carlsson07209442009-11-22 17:37:31 +00001729 uint64_t TypeSize = FieldInfo.first;
1730 unsigned FieldAlign = FieldInfo.second;
Fariborz Jahanianfc0fe6e2011-05-03 20:21:04 +00001731
Fariborz Jahanian7adbed62011-05-09 22:03:17 +00001732 // This check is needed for 'long long' in -m32 mode.
Fariborz Jahanian0586df42011-12-12 21:16:36 +00001733 if (IsMsStruct && (TypeSize > FieldAlign) &&
1734 (Context.hasSameType(D->getType(),
1735 Context.UnsignedLongLongTy)
1736 || Context.hasSameType(D->getType(), Context.LongLongTy)))
Fariborz Jahanian7adbed62011-05-09 22:03:17 +00001737 FieldAlign = TypeSize;
Chad Rosier18903ee2011-08-04 01:21:14 +00001738
Fariborz Jahanianfc0fe6e2011-05-03 20:21:04 +00001739 if (ZeroLengthBitfield) {
Chad Rosiere1a6a0e2011-08-05 22:38:04 +00001740 std::pair<uint64_t, unsigned> FieldInfo;
1741 unsigned ZeroLengthBitfieldAlignment;
1742 if (IsMsStruct) {
1743 // If a zero-length bitfield is inserted after a bitfield,
1744 // and the alignment of the zero-length bitfield is
1745 // greater than the member that follows it, `bar', `bar'
1746 // will be aligned as the type of the zero-length bitfield.
1747 if (ZeroLengthBitfield != D) {
1748 FieldInfo = Context.getTypeInfo(ZeroLengthBitfield->getType());
1749 ZeroLengthBitfieldAlignment = FieldInfo.second;
1750 // Ignore alignment of subsequent zero-length bitfields.
1751 if ((ZeroLengthBitfieldAlignment > FieldAlign) || (FieldSize == 0))
1752 FieldAlign = ZeroLengthBitfieldAlignment;
1753 if (FieldSize)
1754 ZeroLengthBitfield = 0;
1755 }
1756 } else {
1757 // The alignment of a zero-length bitfield affects the alignment
1758 // of the next member. The alignment is the max of the zero
1759 // length bitfield's alignment and a target specific fixed value.
1760 unsigned ZeroLengthBitfieldBoundary =
Douglas Gregore8bbc122011-09-02 00:18:52 +00001761 Context.getTargetInfo().getZeroLengthBitfieldBoundary();
Chad Rosiere1a6a0e2011-08-05 22:38:04 +00001762 if (ZeroLengthBitfieldBoundary > FieldAlign)
1763 FieldAlign = ZeroLengthBitfieldBoundary;
Fariborz Jahanianfc0fe6e2011-05-03 20:21:04 +00001764 }
1765 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001766
Anders Carlsson57235162010-04-16 15:57:11 +00001767 if (FieldSize > TypeSize) {
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001768 LayoutWideBitField(FieldSize, TypeSize, FieldPacked, D);
Anders Carlsson57235162010-04-16 15:57:11 +00001769 return;
1770 }
1771
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001772 // The align if the field is not packed. This is to check if the attribute
1773 // was unnecessary (-Wpacked).
1774 unsigned UnpackedFieldAlign = FieldAlign;
1775 uint64_t UnpackedFieldOffset = FieldOffset;
Douglas Gregore8bbc122011-09-02 00:18:52 +00001776 if (!Context.getTargetInfo().useBitFieldTypeAlignment() && !ZeroLengthBitfield)
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001777 UnpackedFieldAlign = 1;
1778
Chad Rosiere1a6a0e2011-08-05 22:38:04 +00001779 if (FieldPacked ||
Douglas Gregore8bbc122011-09-02 00:18:52 +00001780 (!Context.getTargetInfo().useBitFieldTypeAlignment() && !ZeroLengthBitfield))
Anders Carlsson07209442009-11-22 17:37:31 +00001781 FieldAlign = 1;
Alexis Huntdcfba7b2010-08-18 23:23:40 +00001782 FieldAlign = std::max(FieldAlign, D->getMaxAlignment());
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001783 UnpackedFieldAlign = std::max(UnpackedFieldAlign, D->getMaxAlignment());
Anders Carlsson07209442009-11-22 17:37:31 +00001784
1785 // The maximum field alignment overrides the aligned attribute.
Eli Friedmana91d38a2011-12-02 02:38:48 +00001786 if (!MaxFieldAlignment.isZero() && FieldSize != 0) {
Ken Dyck02ced6f2011-02-17 01:49:42 +00001787 unsigned MaxFieldAlignmentInBits = Context.toBits(MaxFieldAlignment);
1788 FieldAlign = std::min(FieldAlign, MaxFieldAlignmentInBits);
1789 UnpackedFieldAlign = std::min(UnpackedFieldAlign, MaxFieldAlignmentInBits);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001790 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001791
Douglas Gregor44ba7892012-01-28 00:53:29 +00001792 // Check if we need to add padding to give the field the correct alignment.
1793 if (FieldSize == 0 ||
1794 (MaxFieldAlignment.isZero() &&
1795 (FieldOffset & (FieldAlign-1)) + FieldSize > TypeSize))
1796 FieldOffset = llvm::RoundUpToAlignment(FieldOffset, FieldAlign);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001797
Douglas Gregor44ba7892012-01-28 00:53:29 +00001798 if (FieldSize == 0 ||
1799 (MaxFieldAlignment.isZero() &&
1800 (UnpackedFieldOffset & (UnpackedFieldAlign-1)) + FieldSize > TypeSize))
1801 UnpackedFieldOffset = llvm::RoundUpToAlignment(UnpackedFieldOffset,
1802 UnpackedFieldAlign);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001803
Chad Rosiere1a6a0e2011-08-05 22:38:04 +00001804 // Padding members don't affect overall alignment, unless zero length bitfield
1805 // alignment is enabled.
Douglas Gregore8bbc122011-09-02 00:18:52 +00001806 if (!D->getIdentifier() && !Context.getTargetInfo().useZeroLengthBitfieldAlignment())
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001807 FieldAlign = UnpackedFieldAlign = 1;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001808
Chad Rosiere1a6a0e2011-08-05 22:38:04 +00001809 if (!IsMsStruct)
1810 ZeroLengthBitfield = 0;
1811
Douglas Gregor44ba7892012-01-28 00:53:29 +00001812 if (ExternalLayout)
1813 FieldOffset = updateExternalFieldOffset(D, FieldOffset);
1814
Anders Carlsson07209442009-11-22 17:37:31 +00001815 // Place this field at the current location.
1816 FieldOffsets.push_back(FieldOffset);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001817
Douglas Gregore9fc3772012-01-26 07:55:45 +00001818 if (!ExternalLayout)
1819 CheckFieldPadding(FieldOffset, UnpaddedFieldOffset, UnpackedFieldOffset,
1820 UnpackedFieldAlign, FieldPacked, D);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001821
Anders Carlssonba958402009-11-22 19:13:51 +00001822 // Update DataSize to include the last byte containing (part of) the bitfield.
1823 if (IsUnion) {
1824 // FIXME: I think FieldSize should be TypeSize here.
Ken Dyckecfc7552011-02-24 01:13:28 +00001825 setDataSize(std::max(getDataSizeInBits(), FieldSize));
Anders Carlssonba958402009-11-22 19:13:51 +00001826 } else {
1827 uint64_t NewSizeInBits = FieldOffset + FieldSize;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001828
Ken Dycka1a2e8d2011-03-10 02:00:35 +00001829 setDataSize(llvm::RoundUpToAlignment(NewSizeInBits,
Douglas Gregore8bbc122011-09-02 00:18:52 +00001830 Context.getTargetInfo().getCharAlign()));
Ken Dyckecfc7552011-02-24 01:13:28 +00001831 UnfilledBitsInLastByte = getDataSizeInBits() - NewSizeInBits;
Anders Carlssonba958402009-11-22 19:13:51 +00001832 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001833
Anders Carlssonba958402009-11-22 19:13:51 +00001834 // Update the size.
Ken Dyckecfc7552011-02-24 01:13:28 +00001835 setSize(std::max(getSizeInBits(), getDataSizeInBits()));
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001836
Anders Carlsson07209442009-11-22 17:37:31 +00001837 // Remember max struct/class alignment.
Ken Dyck85ef0432011-02-19 18:58:07 +00001838 UpdateAlignment(Context.toCharUnitsFromBits(FieldAlign),
1839 Context.toCharUnitsFromBits(UnpackedFieldAlign));
Anders Carlsson07209442009-11-22 17:37:31 +00001840}
1841
Douglas Gregore9fc3772012-01-26 07:55:45 +00001842void RecordLayoutBuilder::LayoutField(const FieldDecl *D) {
Anders Carlsson07209442009-11-22 17:37:31 +00001843 if (D->isBitField()) {
1844 LayoutBitField(D);
1845 return;
1846 }
1847
Ken Dyckecfc7552011-02-24 01:13:28 +00001848 uint64_t UnpaddedFieldOffset = getDataSizeInBits() - UnfilledBitsInLastByte;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001849
Anders Carlssonba958402009-11-22 19:13:51 +00001850 // Reset the unfilled bits.
1851 UnfilledBitsInLastByte = 0;
1852
Anders Carlsson07209442009-11-22 17:37:31 +00001853 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Ken Dyck6d90e892011-02-20 02:06:09 +00001854 CharUnits FieldOffset =
Ken Dyckecfc7552011-02-24 01:13:28 +00001855 IsUnion ? CharUnits::Zero() : getDataSize();
Ken Dyck6d90e892011-02-20 02:06:09 +00001856 CharUnits FieldSize;
1857 CharUnits FieldAlign;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001858
Anders Carlsson07209442009-11-22 17:37:31 +00001859 if (D->getType()->isIncompleteArrayType()) {
1860 // This is a flexible array member; we can't directly
1861 // query getTypeInfo about these, so we figure it out here.
1862 // Flexible array members don't have any size, but they
1863 // have to be aligned appropriately for their element type.
Ken Dyck6d90e892011-02-20 02:06:09 +00001864 FieldSize = CharUnits::Zero();
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001865 const ArrayType* ATy = Context.getAsArrayType(D->getType());
Ken Dyck6d90e892011-02-20 02:06:09 +00001866 FieldAlign = Context.getTypeAlignInChars(ATy->getElementType());
Anders Carlsson07209442009-11-22 17:37:31 +00001867 } else if (const ReferenceType *RT = D->getType()->getAs<ReferenceType>()) {
1868 unsigned AS = RT->getPointeeType().getAddressSpace();
Ken Dyck6d90e892011-02-20 02:06:09 +00001869 FieldSize =
Douglas Gregore8bbc122011-09-02 00:18:52 +00001870 Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerWidth(AS));
Ken Dyck6d90e892011-02-20 02:06:09 +00001871 FieldAlign =
Douglas Gregore8bbc122011-09-02 00:18:52 +00001872 Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerAlign(AS));
Anders Carlsson79474332009-07-18 20:20:21 +00001873 } else {
Ken Dyck6d90e892011-02-20 02:06:09 +00001874 std::pair<CharUnits, CharUnits> FieldInfo =
1875 Context.getTypeInfoInChars(D->getType());
Anders Carlsson07209442009-11-22 17:37:31 +00001876 FieldSize = FieldInfo.first;
1877 FieldAlign = FieldInfo.second;
Chad Rosier18903ee2011-08-04 01:21:14 +00001878
Fariborz Jahanianfc0fe6e2011-05-03 20:21:04 +00001879 if (ZeroLengthBitfield) {
Chad Rosier18903ee2011-08-04 01:21:14 +00001880 CharUnits ZeroLengthBitfieldBoundary =
1881 Context.toCharUnitsFromBits(
Douglas Gregore8bbc122011-09-02 00:18:52 +00001882 Context.getTargetInfo().getZeroLengthBitfieldBoundary());
Chad Rosier18903ee2011-08-04 01:21:14 +00001883 if (ZeroLengthBitfieldBoundary == CharUnits::Zero()) {
1884 // If a zero-length bitfield is inserted after a bitfield,
1885 // and the alignment of the zero-length bitfield is
1886 // greater than the member that follows it, `bar', `bar'
1887 // will be aligned as the type of the zero-length bitfield.
1888 std::pair<CharUnits, CharUnits> FieldInfo =
1889 Context.getTypeInfoInChars(ZeroLengthBitfield->getType());
1890 CharUnits ZeroLengthBitfieldAlignment = FieldInfo.second;
1891 if (ZeroLengthBitfieldAlignment > FieldAlign)
1892 FieldAlign = ZeroLengthBitfieldAlignment;
Chad Rosier64b18ee2011-08-04 19:25:14 +00001893 } else if (ZeroLengthBitfieldBoundary > FieldAlign) {
Chad Rosier18903ee2011-08-04 01:21:14 +00001894 // Align 'bar' based on a fixed alignment specified by the target.
Douglas Gregore8bbc122011-09-02 00:18:52 +00001895 assert(Context.getTargetInfo().useZeroLengthBitfieldAlignment() &&
Chad Rosiera336c6f2011-08-04 17:52:43 +00001896 "ZeroLengthBitfieldBoundary should only be used in conjunction"
1897 " with useZeroLengthBitfieldAlignment.");
Chad Rosier18903ee2011-08-04 01:21:14 +00001898 FieldAlign = ZeroLengthBitfieldBoundary;
1899 }
Fariborz Jahanianfc0fe6e2011-05-03 20:21:04 +00001900 ZeroLengthBitfield = 0;
1901 }
Douglas Gregordbe39272011-02-01 15:15:22 +00001902
David Blaikiebbafb8a2012-03-11 07:00:24 +00001903 if (Context.getLangOpts().MSBitfields || IsMsStruct) {
Douglas Gregordbe39272011-02-01 15:15:22 +00001904 // If MS bitfield layout is required, figure out what type is being
1905 // laid out and align the field to the width of that type.
1906
1907 // Resolve all typedefs down to their base type and round up the field
1908 // alignment if necessary.
1909 QualType T = Context.getBaseElementType(D->getType());
1910 if (const BuiltinType *BTy = T->getAs<BuiltinType>()) {
Ken Dyck6d90e892011-02-20 02:06:09 +00001911 CharUnits TypeSize = Context.getTypeSizeInChars(BTy);
Douglas Gregordbe39272011-02-01 15:15:22 +00001912 if (TypeSize > FieldAlign)
1913 FieldAlign = TypeSize;
1914 }
1915 }
Anders Carlsson79474332009-07-18 20:20:21 +00001916 }
Mike Stump11289f42009-09-09 15:08:12 +00001917
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001918 // The align if the field is not packed. This is to check if the attribute
1919 // was unnecessary (-Wpacked).
Ken Dyck6d90e892011-02-20 02:06:09 +00001920 CharUnits UnpackedFieldAlign = FieldAlign;
1921 CharUnits UnpackedFieldOffset = FieldOffset;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001922
Anders Carlsson07209442009-11-22 17:37:31 +00001923 if (FieldPacked)
Ken Dyck6d90e892011-02-20 02:06:09 +00001924 FieldAlign = CharUnits::One();
1925 CharUnits MaxAlignmentInChars =
1926 Context.toCharUnitsFromBits(D->getMaxAlignment());
1927 FieldAlign = std::max(FieldAlign, MaxAlignmentInChars);
1928 UnpackedFieldAlign = std::max(UnpackedFieldAlign, MaxAlignmentInChars);
Anders Carlsson07209442009-11-22 17:37:31 +00001929
1930 // The maximum field alignment overrides the aligned attribute.
Ken Dyck02ced6f2011-02-17 01:49:42 +00001931 if (!MaxFieldAlignment.isZero()) {
Ken Dyck6d90e892011-02-20 02:06:09 +00001932 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
1933 UnpackedFieldAlign = std::min(UnpackedFieldAlign, MaxFieldAlignment);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001934 }
Anders Carlsson07209442009-11-22 17:37:31 +00001935
Douglas Gregor44ba7892012-01-28 00:53:29 +00001936 // Round up the current record size to the field's alignment boundary.
1937 FieldOffset = FieldOffset.RoundUpToAlignment(FieldAlign);
1938 UnpackedFieldOffset =
1939 UnpackedFieldOffset.RoundUpToAlignment(UnpackedFieldAlign);
1940
1941 if (ExternalLayout) {
1942 FieldOffset = Context.toCharUnitsFromBits(
1943 updateExternalFieldOffset(D, Context.toBits(FieldOffset)));
1944
1945 if (!IsUnion && EmptySubobjects) {
1946 // Record the fact that we're placing a field at this offset.
1947 bool Allowed = EmptySubobjects->CanPlaceFieldAtOffset(D, FieldOffset);
1948 (void)Allowed;
1949 assert(Allowed && "Externally-placed field cannot be placed here");
1950 }
1951 } else {
Douglas Gregore9fc3772012-01-26 07:55:45 +00001952 if (!IsUnion && EmptySubobjects) {
1953 // Check if we can place the field at this offset.
1954 while (!EmptySubobjects->CanPlaceFieldAtOffset(D, FieldOffset)) {
1955 // We couldn't place the field at the offset. Try again at a new offset.
1956 FieldOffset += FieldAlign;
1957 }
Anders Carlsson07209442009-11-22 17:37:31 +00001958 }
Anders Carlsson07209442009-11-22 17:37:31 +00001959 }
Douglas Gregore9fc3772012-01-26 07:55:45 +00001960
Anders Carlsson79474332009-07-18 20:20:21 +00001961 // Place this field at the current location.
Ken Dyck6d90e892011-02-20 02:06:09 +00001962 FieldOffsets.push_back(Context.toBits(FieldOffset));
Mike Stump11289f42009-09-09 15:08:12 +00001963
Douglas Gregore9fc3772012-01-26 07:55:45 +00001964 if (!ExternalLayout)
1965 CheckFieldPadding(Context.toBits(FieldOffset), UnpaddedFieldOffset,
1966 Context.toBits(UnpackedFieldOffset),
1967 Context.toBits(UnpackedFieldAlign), FieldPacked, D);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001968
Anders Carlsson79474332009-07-18 20:20:21 +00001969 // Reserve space for this field.
Eli Friedman43f18342012-01-12 23:27:03 +00001970 uint64_t FieldSizeInBits = Context.toBits(FieldSize);
Anders Carlsson79474332009-07-18 20:20:21 +00001971 if (IsUnion)
Eli Friedman2e108372012-01-12 23:48:56 +00001972 setDataSize(std::max(getDataSizeInBits(), FieldSizeInBits));
Anders Carlsson79474332009-07-18 20:20:21 +00001973 else
Eli Friedman2e108372012-01-12 23:48:56 +00001974 setDataSize(FieldOffset + FieldSize);
Mike Stump11289f42009-09-09 15:08:12 +00001975
Eli Friedman2e108372012-01-12 23:48:56 +00001976 // Update the size.
1977 setSize(std::max(getSizeInBits(), getDataSizeInBits()));
Mike Stump11289f42009-09-09 15:08:12 +00001978
Anders Carlsson79474332009-07-18 20:20:21 +00001979 // Remember max struct/class alignment.
Ken Dyck6d90e892011-02-20 02:06:09 +00001980 UpdateAlignment(FieldAlign, UnpackedFieldAlign);
Anders Carlsson79474332009-07-18 20:20:21 +00001981}
1982
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001983void RecordLayoutBuilder::FinishLayout(const NamedDecl *D) {
Douglas Gregor44ba7892012-01-28 00:53:29 +00001984 if (ExternalLayout) {
1985 setSize(ExternalSize);
1986 return;
1987 }
1988
Anders Carlsson79474332009-07-18 20:20:21 +00001989 // In C++, records cannot be of size 0.
David Blaikiebbafb8a2012-03-11 07:00:24 +00001990 if (Context.getLangOpts().CPlusPlus && getSizeInBits() == 0) {
Fariborz Jahanian09b23312011-02-02 19:36:18 +00001991 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
1992 // Compatibility with gcc requires a class (pod or non-pod)
1993 // which is not empty but of size 0; such as having fields of
1994 // array of zero-length, remains of Size 0
1995 if (RD->isEmpty())
Ken Dyck1b4420e2011-02-28 02:01:38 +00001996 setSize(CharUnits::One());
Fariborz Jahanian09b23312011-02-02 19:36:18 +00001997 }
1998 else
Ken Dyck1b4420e2011-02-28 02:01:38 +00001999 setSize(CharUnits::One());
Fariborz Jahanian09b23312011-02-02 19:36:18 +00002000 }
Eli Friedman83a12582011-12-01 00:37:01 +00002001
2002 // MSVC doesn't round up to the alignment of the record with virtual bases.
2003 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
2004 if (isMicrosoftCXXABI() && RD->getNumVBases())
2005 return;
2006 }
2007
Anders Carlsson79474332009-07-18 20:20:21 +00002008 // Finally, round the size of the record up to the alignment of the
2009 // record itself.
Ken Dyckecfc7552011-02-24 01:13:28 +00002010 uint64_t UnpaddedSize = getSizeInBits() - UnfilledBitsInLastByte;
Ken Dyck1b4420e2011-02-28 02:01:38 +00002011 uint64_t UnpackedSizeInBits =
Ken Dyckecfc7552011-02-24 01:13:28 +00002012 llvm::RoundUpToAlignment(getSizeInBits(),
2013 Context.toBits(UnpackedAlignment));
Ken Dyck1b4420e2011-02-28 02:01:38 +00002014 CharUnits UnpackedSize = Context.toCharUnitsFromBits(UnpackedSizeInBits);
Ken Dyckecfc7552011-02-24 01:13:28 +00002015 setSize(llvm::RoundUpToAlignment(getSizeInBits(), Context.toBits(Alignment)));
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00002016
Douglas Gregore8bbc122011-09-02 00:18:52 +00002017 unsigned CharBitNum = Context.getTargetInfo().getCharWidth();
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00002018 if (const RecordDecl *RD = dyn_cast<RecordDecl>(D)) {
2019 // Warn if padding was introduced to the struct/class/union.
Ken Dyckecfc7552011-02-24 01:13:28 +00002020 if (getSizeInBits() > UnpaddedSize) {
2021 unsigned PadSize = getSizeInBits() - UnpaddedSize;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00002022 bool InBits = true;
2023 if (PadSize % CharBitNum == 0) {
2024 PadSize = PadSize / CharBitNum;
2025 InBits = false;
2026 }
2027 Diag(RD->getLocation(), diag::warn_padded_struct_size)
2028 << Context.getTypeDeclType(RD)
2029 << PadSize
2030 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1); // plural or not
2031 }
2032
2033 // Warn if we packed it unnecessarily. If the alignment is 1 byte don't
2034 // bother since there won't be alignment issues.
Ken Dyckecfc7552011-02-24 01:13:28 +00002035 if (Packed && UnpackedAlignment > CharUnits::One() &&
Ken Dyck1b4420e2011-02-28 02:01:38 +00002036 getSize() == UnpackedSize)
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00002037 Diag(D->getLocation(), diag::warn_unnecessary_packed)
2038 << Context.getTypeDeclType(RD);
2039 }
Anders Carlsson79474332009-07-18 20:20:21 +00002040}
2041
Ken Dyck85ef0432011-02-19 18:58:07 +00002042void RecordLayoutBuilder::UpdateAlignment(CharUnits NewAlignment,
2043 CharUnits UnpackedNewAlignment) {
Douglas Gregore9fc3772012-01-26 07:55:45 +00002044 // The alignment is not modified when using 'mac68k' alignment or when
Douglas Gregor44ba7892012-01-28 00:53:29 +00002045 // we have an externally-supplied layout that also provides overall alignment.
2046 if (IsMac68kAlign || (ExternalLayout && !InferAlignment))
Daniel Dunbar6da10982010-05-27 05:45:51 +00002047 return;
2048
Ken Dyck85ef0432011-02-19 18:58:07 +00002049 if (NewAlignment > Alignment) {
2050 assert(llvm::isPowerOf2_32(NewAlignment.getQuantity() &&
2051 "Alignment not a power of 2"));
2052 Alignment = NewAlignment;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00002053 }
2054
Ken Dyck85ef0432011-02-19 18:58:07 +00002055 if (UnpackedNewAlignment > UnpackedAlignment) {
2056 assert(llvm::isPowerOf2_32(UnpackedNewAlignment.getQuantity() &&
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00002057 "Alignment not a power of 2"));
Ken Dyck85ef0432011-02-19 18:58:07 +00002058 UnpackedAlignment = UnpackedNewAlignment;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00002059 }
2060}
2061
Douglas Gregor44ba7892012-01-28 00:53:29 +00002062uint64_t
2063RecordLayoutBuilder::updateExternalFieldOffset(const FieldDecl *Field,
2064 uint64_t ComputedOffset) {
2065 assert(ExternalFieldOffsets.find(Field) != ExternalFieldOffsets.end() &&
2066 "Field does not have an external offset");
2067
2068 uint64_t ExternalFieldOffset = ExternalFieldOffsets[Field];
2069
2070 if (InferAlignment && ExternalFieldOffset < ComputedOffset) {
2071 // The externally-supplied field offset is before the field offset we
2072 // computed. Assume that the structure is packed.
2073 Alignment = CharUnits::fromQuantity(1);
2074 InferAlignment = false;
2075 }
2076
2077 // Use the externally-supplied field offset.
2078 return ExternalFieldOffset;
2079}
2080
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00002081void RecordLayoutBuilder::CheckFieldPadding(uint64_t Offset,
2082 uint64_t UnpaddedOffset,
2083 uint64_t UnpackedOffset,
2084 unsigned UnpackedAlign,
2085 bool isPacked,
2086 const FieldDecl *D) {
2087 // We let objc ivars without warning, objc interfaces generally are not used
2088 // for padding tricks.
2089 if (isa<ObjCIvarDecl>(D))
Anders Carlsson79474332009-07-18 20:20:21 +00002090 return;
Mike Stump11289f42009-09-09 15:08:12 +00002091
Ted Kremenekfed48af2011-09-06 19:40:45 +00002092 // Don't warn about structs created without a SourceLocation. This can
2093 // be done by clients of the AST, such as codegen.
2094 if (D->getLocation().isInvalid())
2095 return;
2096
Douglas Gregore8bbc122011-09-02 00:18:52 +00002097 unsigned CharBitNum = Context.getTargetInfo().getCharWidth();
Mike Stump11289f42009-09-09 15:08:12 +00002098
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00002099 // Warn if padding was introduced to the struct/class.
2100 if (!IsUnion && Offset > UnpaddedOffset) {
2101 unsigned PadSize = Offset - UnpaddedOffset;
2102 bool InBits = true;
2103 if (PadSize % CharBitNum == 0) {
2104 PadSize = PadSize / CharBitNum;
2105 InBits = false;
2106 }
2107 if (D->getIdentifier())
2108 Diag(D->getLocation(), diag::warn_padded_struct_field)
2109 << (D->getParent()->isStruct() ? 0 : 1) // struct|class
2110 << Context.getTypeDeclType(D->getParent())
2111 << PadSize
2112 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1) // plural or not
2113 << D->getIdentifier();
2114 else
2115 Diag(D->getLocation(), diag::warn_padded_struct_anon_field)
2116 << (D->getParent()->isStruct() ? 0 : 1) // struct|class
2117 << Context.getTypeDeclType(D->getParent())
2118 << PadSize
2119 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1); // plural or not
2120 }
2121
2122 // Warn if we packed it unnecessarily. If the alignment is 1 byte don't
2123 // bother since there won't be alignment issues.
2124 if (isPacked && UnpackedAlign > CharBitNum && Offset == UnpackedOffset)
2125 Diag(D->getLocation(), diag::warn_unnecessary_packed)
2126 << D->getIdentifier();
Anders Carlsson79474332009-07-18 20:20:21 +00002127}
Mike Stump11289f42009-09-09 15:08:12 +00002128
Anders Carlsson5ebf8b42009-12-07 04:35:11 +00002129const CXXMethodDecl *
Anders Carlssonc2226202010-05-26 05:58:59 +00002130RecordLayoutBuilder::ComputeKeyFunction(const CXXRecordDecl *RD) {
Daniel Dunbarccabe482010-04-19 20:44:53 +00002131 // If a class isn't polymorphic it doesn't have a key function.
Anders Carlsson5ebf8b42009-12-07 04:35:11 +00002132 if (!RD->isPolymorphic())
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002133 return 0;
Eli Friedmanf2c79b62009-12-08 03:56:49 +00002134
Eli Friedman300f55d2011-06-10 21:53:06 +00002135 // A class that is not externally visible doesn't have a key function. (Or
Eli Friedmanf2c79b62009-12-08 03:56:49 +00002136 // at least, there's no point to assigning a key function to such a class;
2137 // this doesn't affect the ABI.)
Eli Friedman300f55d2011-06-10 21:53:06 +00002138 if (RD->getLinkage() != ExternalLinkage)
Eli Friedmanf2c79b62009-12-08 03:56:49 +00002139 return 0;
2140
Argyrios Kyrtzidis8c64bbe2010-10-13 02:39:41 +00002141 // Template instantiations don't have key functions,see Itanium C++ ABI 5.2.6.
2142 // Same behavior as GCC.
2143 TemplateSpecializationKind TSK = RD->getTemplateSpecializationKind();
2144 if (TSK == TSK_ImplicitInstantiation ||
2145 TSK == TSK_ExplicitInstantiationDefinition)
2146 return 0;
2147
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002148 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
2149 E = RD->method_end(); I != E; ++I) {
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002150 const CXXMethodDecl *MD = *I;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002151
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002152 if (!MD->isVirtual())
2153 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002154
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002155 if (MD->isPure())
2156 continue;
Eli Friedmanf2c79b62009-12-08 03:56:49 +00002157
Anders Carlssonf98849e2009-12-02 17:15:43 +00002158 // Ignore implicit member functions, they are always marked as inline, but
2159 // they don't have a body until they're defined.
2160 if (MD->isImplicit())
2161 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002162
Douglas Gregora318efd2010-01-05 19:06:31 +00002163 if (MD->isInlineSpecified())
2164 continue;
Eli Friedman71a26d82009-12-06 20:50:05 +00002165
2166 if (MD->hasInlineBody())
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002167 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002168
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002169 // We found it.
2170 return MD;
2171 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002172
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002173 return 0;
2174}
2175
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00002176DiagnosticBuilder
2177RecordLayoutBuilder::Diag(SourceLocation Loc, unsigned DiagID) {
Argyrios Kyrtzidisd0040642010-11-18 20:06:41 +00002178 return Context.getDiagnostics().Report(Loc, DiagID);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00002179}
2180
Anders Carlssondf291d82010-05-26 04:56:53 +00002181/// getASTRecordLayout - Get or compute information about the layout of the
2182/// specified record (struct/union/class), which indicates its size and field
2183/// position information.
Jay Foad39c79802011-01-12 09:06:06 +00002184const ASTRecordLayout &
2185ASTContext::getASTRecordLayout(const RecordDecl *D) const {
John McCall0710e552011-10-07 02:39:22 +00002186 // These asserts test different things. A record has a definition
2187 // as soon as we begin to parse the definition. That definition is
2188 // not a complete definition (which is what isDefinition() tests)
2189 // until we *finish* parsing the definition.
Sean Callanan56c19892012-02-08 00:04:52 +00002190
2191 if (D->hasExternalLexicalStorage() && !D->getDefinition())
2192 getExternalSource()->CompleteType(const_cast<RecordDecl*>(D));
2193
Anders Carlssondf291d82010-05-26 04:56:53 +00002194 D = D->getDefinition();
2195 assert(D && "Cannot get layout of forward declarations!");
John McCallf937c022011-10-07 06:10:15 +00002196 assert(D->isCompleteDefinition() && "Cannot layout type before complete!");
Anders Carlssondf291d82010-05-26 04:56:53 +00002197
2198 // Look up this layout, if already laid out, return what we have.
2199 // Note that we can't save a reference to the entry because this function
2200 // is recursive.
2201 const ASTRecordLayout *Entry = ASTRecordLayouts[D];
2202 if (Entry) return *Entry;
2203
Anders Carlssond2954862010-05-26 05:10:47 +00002204 const ASTRecordLayout *NewEntry;
2205
2206 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
Anders Carlssonc121b4e2010-05-27 00:07:01 +00002207 EmptySubobjectMap EmptySubobjects(*this, RD);
John McCall0153cd32011-11-08 04:01:03 +00002208 RecordLayoutBuilder Builder(*this, &EmptySubobjects);
2209 Builder.Layout(RD);
Anders Carlsson439edd12010-05-27 05:41:06 +00002210
John McCall0153cd32011-11-08 04:01:03 +00002211 // MSVC gives the vb-table pointer an alignment equal to that of
2212 // the non-virtual part of the structure. That's an inherently
2213 // multi-pass operation. If our first pass doesn't give us
2214 // adequate alignment, try again with the specified minimum
2215 // alignment. This is *much* more maintainable than computing the
2216 // alignment in advance in a separately-coded pass; it's also
2217 // significantly more efficient in the common case where the
2218 // vb-table doesn't need extra padding.
2219 if (Builder.VBPtrOffset != CharUnits::fromQuantity(-1) &&
2220 (Builder.VBPtrOffset % Builder.NonVirtualAlignment) != 0) {
2221 Builder.resetWithTargetAlignment(Builder.NonVirtualAlignment);
2222 Builder.Layout(RD);
Eli Friedman84d2d3a2011-09-27 19:12:27 +00002223 }
2224
Anders Carlssond2954862010-05-26 05:10:47 +00002225 // FIXME: This is not always correct. See the part about bitfields at
2226 // http://www.codesourcery.com/public/cxx-abi/abi.html#POD for more info.
2227 // FIXME: IsPODForThePurposeOfLayout should be stored in the record layout.
Eli Friedman84d2d3a2011-09-27 19:12:27 +00002228 // This does not affect the calculations of MSVC layouts
2229 bool IsPODForThePurposeOfLayout =
John McCall0153cd32011-11-08 04:01:03 +00002230 (!Builder.isMicrosoftCXXABI() && cast<CXXRecordDecl>(D)->isPOD());
Anders Carlssond2954862010-05-26 05:10:47 +00002231
2232 // FIXME: This should be done in FinalizeLayout.
Ken Dyck1b4420e2011-02-28 02:01:38 +00002233 CharUnits DataSize =
John McCall0153cd32011-11-08 04:01:03 +00002234 IsPODForThePurposeOfLayout ? Builder.getSize() : Builder.getDataSize();
Ken Dyck1b4420e2011-02-28 02:01:38 +00002235 CharUnits NonVirtualSize =
John McCall0153cd32011-11-08 04:01:03 +00002236 IsPODForThePurposeOfLayout ? DataSize : Builder.NonVirtualSize;
Anders Carlssond2954862010-05-26 05:10:47 +00002237
Daniel Dunbar592a85c2010-05-27 02:25:46 +00002238 NewEntry =
John McCall0153cd32011-11-08 04:01:03 +00002239 new (*this) ASTRecordLayout(*this, Builder.getSize(),
2240 Builder.Alignment,
2241 Builder.VFPtrOffset,
2242 Builder.VBPtrOffset,
Ken Dyck1b4420e2011-02-28 02:01:38 +00002243 DataSize,
John McCall0153cd32011-11-08 04:01:03 +00002244 Builder.FieldOffsets.data(),
2245 Builder.FieldOffsets.size(),
Ken Dyckaf1c83f2011-02-16 01:52:01 +00002246 NonVirtualSize,
John McCall0153cd32011-11-08 04:01:03 +00002247 Builder.NonVirtualAlignment,
Anders Carlssonc121b4e2010-05-27 00:07:01 +00002248 EmptySubobjects.SizeOfLargestEmptySubobject,
John McCall0153cd32011-11-08 04:01:03 +00002249 Builder.PrimaryBase,
2250 Builder.PrimaryBaseIsVirtual,
2251 Builder.Bases, Builder.VBases);
Anders Carlssond2954862010-05-26 05:10:47 +00002252 } else {
John McCall0153cd32011-11-08 04:01:03 +00002253 RecordLayoutBuilder Builder(*this, /*EmptySubobjects=*/0);
Anders Carlssond2954862010-05-26 05:10:47 +00002254 Builder.Layout(D);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00002255
Anders Carlssond2954862010-05-26 05:10:47 +00002256 NewEntry =
Ken Dyck1b4420e2011-02-28 02:01:38 +00002257 new (*this) ASTRecordLayout(*this, Builder.getSize(),
Ken Dyck4731d5b2011-02-16 02:05:21 +00002258 Builder.Alignment,
Ken Dyck1b4420e2011-02-28 02:01:38 +00002259 Builder.getSize(),
Anders Carlssond2954862010-05-26 05:10:47 +00002260 Builder.FieldOffsets.data(),
2261 Builder.FieldOffsets.size());
2262 }
2263
Anders Carlssondf291d82010-05-26 04:56:53 +00002264 ASTRecordLayouts[D] = NewEntry;
2265
David Blaikiebbafb8a2012-03-11 07:00:24 +00002266 if (getLangOpts().DumpRecordLayouts) {
Anders Carlssondf291d82010-05-26 04:56:53 +00002267 llvm::errs() << "\n*** Dumping AST Record Layout\n";
David Blaikiebbafb8a2012-03-11 07:00:24 +00002268 DumpRecordLayout(D, llvm::errs(), getLangOpts().DumpRecordLayoutsSimple);
Anders Carlssondf291d82010-05-26 04:56:53 +00002269 }
2270
2271 return *NewEntry;
2272}
2273
2274const CXXMethodDecl *ASTContext::getKeyFunction(const CXXRecordDecl *RD) {
2275 RD = cast<CXXRecordDecl>(RD->getDefinition());
2276 assert(RD && "Cannot get key function for forward declarations!");
Daniel Dunbar592a85c2010-05-27 02:25:46 +00002277
Anders Carlssondf291d82010-05-26 04:56:53 +00002278 const CXXMethodDecl *&Entry = KeyFunctions[RD];
Daniel Dunbar592a85c2010-05-27 02:25:46 +00002279 if (!Entry)
Anders Carlssonc2226202010-05-26 05:58:59 +00002280 Entry = RecordLayoutBuilder::ComputeKeyFunction(RD);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00002281
Anders Carlssondf291d82010-05-26 04:56:53 +00002282 return Entry;
2283}
2284
Richard Smithdafff942012-01-14 04:30:29 +00002285static uint64_t getFieldOffset(const ASTContext &C, const FieldDecl *FD) {
2286 const ASTRecordLayout &Layout = C.getASTRecordLayout(FD->getParent());
2287 return Layout.getFieldOffset(FD->getFieldIndex());
2288}
2289
2290uint64_t ASTContext::getFieldOffset(const ValueDecl *VD) const {
2291 uint64_t OffsetInBits;
2292 if (const FieldDecl *FD = dyn_cast<FieldDecl>(VD)) {
2293 OffsetInBits = ::getFieldOffset(*this, FD);
2294 } else {
2295 const IndirectFieldDecl *IFD = cast<IndirectFieldDecl>(VD);
2296
2297 OffsetInBits = 0;
2298 for (IndirectFieldDecl::chain_iterator CI = IFD->chain_begin(),
2299 CE = IFD->chain_end();
2300 CI != CE; ++CI)
2301 OffsetInBits += ::getFieldOffset(*this, cast<FieldDecl>(*CI));
2302 }
2303
2304 return OffsetInBits;
2305}
2306
Eric Christopher8a39a012011-10-05 06:00:51 +00002307/// getObjCLayout - Get or compute information about the layout of the
2308/// given interface.
Anders Carlssondf291d82010-05-26 04:56:53 +00002309///
2310/// \param Impl - If given, also include the layout of the interface's
2311/// implementation. This may differ by including synthesized ivars.
2312const ASTRecordLayout &
2313ASTContext::getObjCLayout(const ObjCInterfaceDecl *D,
Jay Foad39c79802011-01-12 09:06:06 +00002314 const ObjCImplementationDecl *Impl) const {
Douglas Gregor64d92572011-12-20 15:50:13 +00002315 // Retrieve the definition
2316 D = D->getDefinition();
2317 assert(D && D->isThisDeclarationADefinition() && "Invalid interface decl!");
Anders Carlssondf291d82010-05-26 04:56:53 +00002318
2319 // Look up this layout, if already laid out, return what we have.
2320 ObjCContainerDecl *Key =
2321 Impl ? (ObjCContainerDecl*) Impl : (ObjCContainerDecl*) D;
2322 if (const ASTRecordLayout *Entry = ObjCLayouts[Key])
2323 return *Entry;
2324
2325 // Add in synthesized ivar count if laying out an implementation.
2326 if (Impl) {
2327 unsigned SynthCount = CountNonClassIvars(D);
2328 // If there aren't any sythesized ivars then reuse the interface
2329 // entry. Note we can't cache this because we simply free all
2330 // entries later; however we shouldn't look up implementations
2331 // frequently.
2332 if (SynthCount == 0)
2333 return getObjCLayout(D, 0);
2334 }
2335
John McCall0153cd32011-11-08 04:01:03 +00002336 RecordLayoutBuilder Builder(*this, /*EmptySubobjects=*/0);
Anders Carlsson6ed3a9a2010-05-26 05:04:25 +00002337 Builder.Layout(D);
2338
Anders Carlssondf291d82010-05-26 04:56:53 +00002339 const ASTRecordLayout *NewEntry =
Ken Dyck1b4420e2011-02-28 02:01:38 +00002340 new (*this) ASTRecordLayout(*this, Builder.getSize(),
Ken Dyck4731d5b2011-02-16 02:05:21 +00002341 Builder.Alignment,
Ken Dyck1b4420e2011-02-28 02:01:38 +00002342 Builder.getDataSize(),
Anders Carlsson6ed3a9a2010-05-26 05:04:25 +00002343 Builder.FieldOffsets.data(),
2344 Builder.FieldOffsets.size());
Daniel Dunbar592a85c2010-05-27 02:25:46 +00002345
Anders Carlssondf291d82010-05-26 04:56:53 +00002346 ObjCLayouts[Key] = NewEntry;
2347
2348 return *NewEntry;
2349}
2350
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002351static void PrintOffset(raw_ostream &OS,
Anders Carlsson3f018712010-10-31 23:45:59 +00002352 CharUnits Offset, unsigned IndentLevel) {
Benjamin Kramer96ad7172011-11-05 09:02:52 +00002353 OS << llvm::format("%4" PRId64 " | ", (int64_t)Offset.getQuantity());
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002354 OS.indent(IndentLevel * 2);
2355}
2356
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002357static void DumpCXXRecordLayout(raw_ostream &OS,
Jay Foad39c79802011-01-12 09:06:06 +00002358 const CXXRecordDecl *RD, const ASTContext &C,
Anders Carlsson3f018712010-10-31 23:45:59 +00002359 CharUnits Offset,
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002360 unsigned IndentLevel,
2361 const char* Description,
2362 bool IncludeVirtualBases) {
Anders Carlsson3f018712010-10-31 23:45:59 +00002363 const ASTRecordLayout &Layout = C.getASTRecordLayout(RD);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002364
2365 PrintOffset(OS, Offset, IndentLevel);
Dan Gohman145f3f12010-04-19 16:39:44 +00002366 OS << C.getTypeDeclType(const_cast<CXXRecordDecl *>(RD)).getAsString();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002367 if (Description)
2368 OS << ' ' << Description;
2369 if (RD->isEmpty())
2370 OS << " (empty)";
2371 OS << '\n';
2372
2373 IndentLevel++;
2374
Anders Carlsson3f018712010-10-31 23:45:59 +00002375 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
Eli Friedman43114f92011-10-21 22:49:56 +00002376 bool HasVfptr = Layout.getVFPtrOffset() != CharUnits::fromQuantity(-1);
Eli Friedman84d2d3a2011-09-27 19:12:27 +00002377 bool HasVbptr = Layout.getVBPtrOffset() != CharUnits::fromQuantity(-1);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002378
2379 // Vtable pointer.
Eli Friedman43114f92011-10-21 22:49:56 +00002380 if (RD->isDynamicClass() && !PrimaryBase &&
2381 C.getTargetInfo().getCXXABI() != CXXABI_Microsoft) {
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002382 PrintOffset(OS, Offset, IndentLevel);
Benjamin Kramerb89514a2011-10-14 18:45:37 +00002383 OS << '(' << *RD << " vtable pointer)\n";
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002384 }
Eli Friedman84d2d3a2011-09-27 19:12:27 +00002385
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002386 // Dump (non-virtual) bases
2387 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
2388 E = RD->bases_end(); I != E; ++I) {
2389 assert(!I->getType()->isDependentType() &&
2390 "Cannot layout class with dependent bases.");
2391 if (I->isVirtual())
2392 continue;
2393
2394 const CXXRecordDecl *Base =
2395 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
2396
Anders Carlsson3f018712010-10-31 23:45:59 +00002397 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002398
2399 DumpCXXRecordLayout(OS, Base, C, BaseOffset, IndentLevel,
2400 Base == PrimaryBase ? "(primary base)" : "(base)",
2401 /*IncludeVirtualBases=*/false);
2402 }
Eli Friedman43114f92011-10-21 22:49:56 +00002403
2404 // vfptr and vbptr (for Microsoft C++ ABI)
2405 if (HasVfptr) {
2406 PrintOffset(OS, Offset + Layout.getVFPtrOffset(), IndentLevel);
2407 OS << '(' << *RD << " vftable pointer)\n";
2408 }
Eli Friedman84d2d3a2011-09-27 19:12:27 +00002409 if (HasVbptr) {
2410 PrintOffset(OS, Offset + Layout.getVBPtrOffset(), IndentLevel);
Benjamin Kramerb89514a2011-10-14 18:45:37 +00002411 OS << '(' << *RD << " vbtable pointer)\n";
Eli Friedman84d2d3a2011-09-27 19:12:27 +00002412 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002413
2414 // Dump fields.
2415 uint64_t FieldNo = 0;
2416 for (CXXRecordDecl::field_iterator I = RD->field_begin(),
2417 E = RD->field_end(); I != E; ++I, ++FieldNo) {
2418 const FieldDecl *Field = *I;
Anders Carlsson3f018712010-10-31 23:45:59 +00002419 CharUnits FieldOffset = Offset +
Ken Dyck86a7fcc2011-01-18 01:56:16 +00002420 C.toCharUnitsFromBits(Layout.getFieldOffset(FieldNo));
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002421
2422 if (const RecordType *RT = Field->getType()->getAs<RecordType>()) {
2423 if (const CXXRecordDecl *D = dyn_cast<CXXRecordDecl>(RT->getDecl())) {
2424 DumpCXXRecordLayout(OS, D, C, FieldOffset, IndentLevel,
Daniel Dunbar56df9772010-08-17 22:39:59 +00002425 Field->getName().data(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002426 /*IncludeVirtualBases=*/true);
2427 continue;
2428 }
2429 }
2430
2431 PrintOffset(OS, FieldOffset, IndentLevel);
Benjamin Kramerb89514a2011-10-14 18:45:37 +00002432 OS << Field->getType().getAsString() << ' ' << *Field << '\n';
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002433 }
2434
2435 if (!IncludeVirtualBases)
2436 return;
2437
2438 // Dump virtual bases.
2439 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
2440 E = RD->vbases_end(); I != E; ++I) {
2441 assert(I->isVirtual() && "Found non-virtual class!");
2442 const CXXRecordDecl *VBase =
2443 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
2444
Anders Carlsson3f018712010-10-31 23:45:59 +00002445 CharUnits VBaseOffset = Offset + Layout.getVBaseClassOffset(VBase);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002446 DumpCXXRecordLayout(OS, VBase, C, VBaseOffset, IndentLevel,
2447 VBase == PrimaryBase ?
2448 "(primary virtual base)" : "(virtual base)",
2449 /*IncludeVirtualBases=*/false);
2450 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002451
Ken Dyckc8ae5502011-02-09 01:59:34 +00002452 OS << " sizeof=" << Layout.getSize().getQuantity();
Ken Dyckd5090c12011-02-11 02:20:09 +00002453 OS << ", dsize=" << Layout.getDataSize().getQuantity();
Ken Dyck7ad11e72011-02-15 02:32:40 +00002454 OS << ", align=" << Layout.getAlignment().getQuantity() << '\n';
Ken Dyck316d6f62011-02-01 01:52:10 +00002455 OS << " nvsize=" << Layout.getNonVirtualSize().getQuantity();
Ken Dyckbec02852011-02-08 02:02:47 +00002456 OS << ", nvalign=" << Layout.getNonVirtualAlign().getQuantity() << '\n';
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002457 OS << '\n';
2458}
Daniel Dunbarccabe482010-04-19 20:44:53 +00002459
2460void ASTContext::DumpRecordLayout(const RecordDecl *RD,
Douglas Gregore9fc3772012-01-26 07:55:45 +00002461 raw_ostream &OS,
2462 bool Simple) const {
Daniel Dunbarccabe482010-04-19 20:44:53 +00002463 const ASTRecordLayout &Info = getASTRecordLayout(RD);
2464
2465 if (const CXXRecordDecl *CXXRD = dyn_cast<CXXRecordDecl>(RD))
Douglas Gregore9fc3772012-01-26 07:55:45 +00002466 if (!Simple)
2467 return DumpCXXRecordLayout(OS, CXXRD, *this, CharUnits(), 0, 0,
2468 /*IncludeVirtualBases=*/true);
Daniel Dunbarccabe482010-04-19 20:44:53 +00002469
2470 OS << "Type: " << getTypeDeclType(RD).getAsString() << "\n";
Douglas Gregore9fc3772012-01-26 07:55:45 +00002471 if (!Simple) {
2472 OS << "Record: ";
2473 RD->dump();
2474 }
Daniel Dunbarccabe482010-04-19 20:44:53 +00002475 OS << "\nLayout: ";
2476 OS << "<ASTRecordLayout\n";
Ken Dyckb0fcc592011-02-11 01:54:29 +00002477 OS << " Size:" << toBits(Info.getSize()) << "\n";
Ken Dyckd5090c12011-02-11 02:20:09 +00002478 OS << " DataSize:" << toBits(Info.getDataSize()) << "\n";
Ken Dyck7ad11e72011-02-15 02:32:40 +00002479 OS << " Alignment:" << toBits(Info.getAlignment()) << "\n";
Daniel Dunbarccabe482010-04-19 20:44:53 +00002480 OS << " FieldOffsets: [";
2481 for (unsigned i = 0, e = Info.getFieldCount(); i != e; ++i) {
2482 if (i) OS << ", ";
2483 OS << Info.getFieldOffset(i);
2484 }
2485 OS << "]>\n";
2486}