blob: ff6b950474d47ec8d03eb607da77eb1fca7715fd [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
Chandler Carruth3a022472012-12-04 09:13:33 +000010#include "clang/AST/RecordLayout.h"
Benjamin Kramer2ef30312012-07-04 18:45:14 +000011#include "clang/AST/ASTContext.h"
Anders Carlsson79474332009-07-18 20:20:21 +000012#include "clang/AST/Attr.h"
Anders Carlsson5adde292010-11-24 22:55:48 +000013#include "clang/AST/CXXInheritance.h"
Anders Carlsson79474332009-07-18 20:20:21 +000014#include "clang/AST/Decl.h"
Anders Carlsson6d9f6f32009-07-19 00:18:47 +000015#include "clang/AST/DeclCXX.h"
Anders Carlsson4f516282009-07-18 20:50:59 +000016#include "clang/AST/DeclObjC.h"
Anders Carlsson79474332009-07-18 20:20:21 +000017#include "clang/AST/Expr.h"
Anders Carlsson79474332009-07-18 20:20:21 +000018#include "clang/Basic/TargetInfo.h"
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +000019#include "clang/Sema/SemaDiagnostic.h"
Daniel Dunbaraa423af2010-04-08 02:59:49 +000020#include "llvm/ADT/SmallSet.h"
Ted Kremenekf75d0892011-03-19 01:00:36 +000021#include "llvm/Support/CrashRecoveryContext.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000022#include "llvm/Support/Format.h"
23#include "llvm/Support/MathExtras.h"
Anders Carlsson79474332009-07-18 20:20:21 +000024
25using namespace clang;
26
Benjamin Kramerc7656cd2010-05-26 09:58:31 +000027namespace {
Anders Carlssonf58de112010-05-26 15:32:58 +000028
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000029/// BaseSubobjectInfo - Represents a single base subobject in a complete class.
30/// For a class hierarchy like
31///
32/// class A { };
33/// class B : A { };
34/// class C : A, B { };
35///
36/// The BaseSubobjectInfo graph for C will have three BaseSubobjectInfo
37/// instances, one for B and two for A.
38///
39/// If a base is virtual, it will only have one BaseSubobjectInfo allocated.
40struct BaseSubobjectInfo {
41 /// Class - The class for this base info.
Anders Carlsson056818f2010-05-28 21:13:31 +000042 const CXXRecordDecl *Class;
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000043
44 /// IsVirtual - Whether the BaseInfo represents a virtual base or not.
Anders Carlsson056818f2010-05-28 21:13:31 +000045 bool IsVirtual;
46
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000047 /// Bases - Information about the base subobjects.
Chris Lattner0e62c1c2011-07-23 10:55:15 +000048 SmallVector<BaseSubobjectInfo*, 4> Bases;
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000049
Anders Carlssone3c24c72010-05-29 17:35:14 +000050 /// PrimaryVirtualBaseInfo - Holds the base info for the primary virtual base
51 /// of this base info (if one exists).
52 BaseSubobjectInfo *PrimaryVirtualBaseInfo;
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000053
54 // FIXME: Document.
55 const BaseSubobjectInfo *Derived;
Anders Carlsson056818f2010-05-28 21:13:31 +000056};
57
Anders Carlssonf58de112010-05-26 15:32:58 +000058/// EmptySubobjectMap - Keeps track of which empty subobjects exist at different
59/// offsets while laying out a C++ class.
60class EmptySubobjectMap {
Jay Foad39c79802011-01-12 09:06:06 +000061 const ASTContext &Context;
Anders Carlsson233e2722010-10-31 21:54:55 +000062 uint64_t CharWidth;
63
Anders Carlssonf58de112010-05-26 15:32:58 +000064 /// Class - The class whose empty entries we're keeping track of.
65 const CXXRecordDecl *Class;
Daniel Dunbar592a85c2010-05-27 02:25:46 +000066
Anders Carlsson439edd12010-05-27 05:41:06 +000067 /// EmptyClassOffsets - A map from offsets to empty record decls.
Chris Lattner0e62c1c2011-07-23 10:55:15 +000068 typedef SmallVector<const CXXRecordDecl *, 1> ClassVectorTy;
Anders Carlssonf8f756d2010-10-31 21:22:43 +000069 typedef llvm::DenseMap<CharUnits, ClassVectorTy> EmptyClassOffsetsMapTy;
Anders Carlsson439edd12010-05-27 05:41:06 +000070 EmptyClassOffsetsMapTy EmptyClassOffsets;
71
Anders Carlssoncc5de092010-06-08 15:56:03 +000072 /// MaxEmptyClassOffset - The highest offset known to contain an empty
73 /// base subobject.
Anders Carlsson725190f2010-10-31 21:39:24 +000074 CharUnits MaxEmptyClassOffset;
Anders Carlssoncc5de092010-06-08 15:56:03 +000075
Daniel Dunbar592a85c2010-05-27 02:25:46 +000076 /// ComputeEmptySubobjectSizes - Compute the size of the largest base or
Anders Carlssonc5ca1f72010-05-26 15:54:25 +000077 /// member subobject that is empty.
78 void ComputeEmptySubobjectSizes();
Anders Carlsson439edd12010-05-27 05:41:06 +000079
Anders Carlsson725190f2010-10-31 21:39:24 +000080 void AddSubobjectAtOffset(const CXXRecordDecl *RD, CharUnits Offset);
Anders Carlssondb319762010-05-27 18:20:57 +000081
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000082 void UpdateEmptyBaseSubobjects(const BaseSubobjectInfo *Info,
Anders Carlsson28466ab2010-10-31 22:13:23 +000083 CharUnits Offset, bool PlacingEmptyBase);
Anders Carlsson439edd12010-05-27 05:41:06 +000084
Anders Carlssondb319762010-05-27 18:20:57 +000085 void UpdateEmptyFieldSubobjects(const CXXRecordDecl *RD,
86 const CXXRecordDecl *Class,
Anders Carlsson28466ab2010-10-31 22:13:23 +000087 CharUnits Offset);
88 void UpdateEmptyFieldSubobjects(const FieldDecl *FD, CharUnits Offset);
Anders Carlssondb319762010-05-27 18:20:57 +000089
Anders Carlssoncc5de092010-06-08 15:56:03 +000090 /// AnyEmptySubobjectsBeyondOffset - Returns whether there are any empty
91 /// subobjects beyond the given offset.
Anders Carlsson725190f2010-10-31 21:39:24 +000092 bool AnyEmptySubobjectsBeyondOffset(CharUnits Offset) const {
Anders Carlssoncc5de092010-06-08 15:56:03 +000093 return Offset <= MaxEmptyClassOffset;
94 }
95
Anders Carlsson233e2722010-10-31 21:54:55 +000096 CharUnits
97 getFieldOffset(const ASTRecordLayout &Layout, unsigned FieldNo) const {
98 uint64_t FieldOffset = Layout.getFieldOffset(FieldNo);
99 assert(FieldOffset % CharWidth == 0 &&
100 "Field offset not at char boundary!");
101
Ken Dyck7c4026b2011-01-24 01:28:50 +0000102 return Context.toCharUnitsFromBits(FieldOffset);
Anders Carlssonf8f756d2010-10-31 21:22:43 +0000103 }
Anders Carlssonf8f756d2010-10-31 21:22:43 +0000104
Charles Davisc2c576a2010-08-19 00:55:19 +0000105protected:
Anders Carlsson725190f2010-10-31 21:39:24 +0000106 bool CanPlaceSubobjectAtOffset(const CXXRecordDecl *RD,
107 CharUnits Offset) const;
Charles Davisc2c576a2010-08-19 00:55:19 +0000108
109 bool CanPlaceBaseSubobjectAtOffset(const BaseSubobjectInfo *Info,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000110 CharUnits Offset);
Charles Davisc2c576a2010-08-19 00:55:19 +0000111
112 bool CanPlaceFieldSubobjectAtOffset(const CXXRecordDecl *RD,
113 const CXXRecordDecl *Class,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000114 CharUnits Offset) const;
Charles Davisc2c576a2010-08-19 00:55:19 +0000115 bool CanPlaceFieldSubobjectAtOffset(const FieldDecl *FD,
Anders Carlsson233e2722010-10-31 21:54:55 +0000116 CharUnits Offset) const;
Charles Davisc2c576a2010-08-19 00:55:19 +0000117
Anders Carlssonf58de112010-05-26 15:32:58 +0000118public:
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000119 /// This holds the size of the largest empty subobject (either a base
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000120 /// or a member). Will be zero if the record being built doesn't contain
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000121 /// any empty classes.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000122 CharUnits SizeOfLargestEmptySubobject;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000123
Jay Foad39c79802011-01-12 09:06:06 +0000124 EmptySubobjectMap(const ASTContext &Context, const CXXRecordDecl *Class)
Anders Carlsson28466ab2010-10-31 22:13:23 +0000125 : Context(Context), CharWidth(Context.getCharWidth()), Class(Class) {
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000126 ComputeEmptySubobjectSizes();
127 }
128
129 /// CanPlaceBaseAtOffset - Return whether the given base class can be placed
130 /// at the given offset.
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000131 /// Returns false if placing the record will result in two components
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000132 /// (direct or indirect) of the same type having the same offset.
Anders Carlssoncc5de092010-06-08 15:56:03 +0000133 bool CanPlaceBaseAtOffset(const BaseSubobjectInfo *Info,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000134 CharUnits Offset);
Anders Carlssondb319762010-05-27 18:20:57 +0000135
136 /// CanPlaceFieldAtOffset - Return whether a field can be placed at the given
137 /// offset.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000138 bool CanPlaceFieldAtOffset(const FieldDecl *FD, CharUnits Offset);
Anders Carlssonf58de112010-05-26 15:32:58 +0000139};
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000140
141void EmptySubobjectMap::ComputeEmptySubobjectSizes() {
142 // Check the bases.
143 for (CXXRecordDecl::base_class_const_iterator I = Class->bases_begin(),
144 E = Class->bases_end(); I != E; ++I) {
145 const CXXRecordDecl *BaseDecl =
146 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
147
Anders Carlsson28466ab2010-10-31 22:13:23 +0000148 CharUnits EmptySize;
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000149 const ASTRecordLayout &Layout = Context.getASTRecordLayout(BaseDecl);
150 if (BaseDecl->isEmpty()) {
151 // If the class decl is empty, get its size.
Ken Dyckc8ae5502011-02-09 01:59:34 +0000152 EmptySize = Layout.getSize();
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000153 } else {
154 // Otherwise, we get the largest empty subobject for the decl.
155 EmptySize = Layout.getSizeOfLargestEmptySubobject();
156 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000157
Anders Carlsson28466ab2010-10-31 22:13:23 +0000158 if (EmptySize > SizeOfLargestEmptySubobject)
159 SizeOfLargestEmptySubobject = EmptySize;
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000160 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000161
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000162 // Check the fields.
163 for (CXXRecordDecl::field_iterator I = Class->field_begin(),
164 E = Class->field_end(); I != E; ++I) {
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000165
166 const RecordType *RT =
David Blaikie40ed2972012-06-06 20:45:41 +0000167 Context.getBaseElementType(I->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
Reid Kleckner369f3162013-05-14 20:30:42 +0000214 // If we have empty structures inside a union, we can assign both
Rafael Espindola7bcde192010-12-29 23:02:58 +0000215 // 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) {
David Blaikie40ed2972012-06-06 20:45:41 +0000264 if (I->isBitField())
Anders Carlsson233e2722010-10-31 21:54:55 +0000265 continue;
266
Anders Carlsson28466ab2010-10-31 22:13:23 +0000267 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
David Blaikie40ed2972012-06-06 20:45:41 +0000268 if (!CanPlaceFieldSubobjectAtOffset(*I, FieldOffset))
Anders Carlssondb319762010-05-27 18:20:57 +0000269 return false;
270 }
271
Anders Carlsson439edd12010-05-27 05:41:06 +0000272 return true;
273}
274
Anders Carlssona7f3cdb2010-05-28 21:24:37 +0000275void EmptySubobjectMap::UpdateEmptyBaseSubobjects(const BaseSubobjectInfo *Info,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000276 CharUnits Offset,
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000277 bool PlacingEmptyBase) {
278 if (!PlacingEmptyBase && Offset >= SizeOfLargestEmptySubobject) {
279 // We know that the only empty subobjects that can conflict with empty
280 // subobject of non-empty bases, are empty bases that can be placed at
281 // offset zero. Because of this, we only need to keep track of empty base
282 // subobjects with offsets less than the size of the largest empty
283 // subobject for our class.
284 return;
285 }
286
Anders Carlsson28466ab2010-10-31 22:13:23 +0000287 AddSubobjectAtOffset(Info->Class, Offset);
Anders Carlssona7774a62010-05-29 21:10:24 +0000288
Anders Carlsson439edd12010-05-27 05:41:06 +0000289 // Traverse all non-virtual bases.
Anders Carlssona7774a62010-05-29 21:10:24 +0000290 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Info->Class);
Anders Carlsson439edd12010-05-27 05:41:06 +0000291 for (unsigned I = 0, E = Info->Bases.size(); I != E; ++I) {
Anders Carlssona7f3cdb2010-05-28 21:24:37 +0000292 BaseSubobjectInfo* Base = Info->Bases[I];
Anders Carlsson439edd12010-05-27 05:41:06 +0000293 if (Base->IsVirtual)
294 continue;
Anders Carlssona7774a62010-05-29 21:10:24 +0000295
Anders Carlsson0a14ee92010-11-01 00:21:58 +0000296 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base->Class);
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000297 UpdateEmptyBaseSubobjects(Base, BaseOffset, PlacingEmptyBase);
Anders Carlsson439edd12010-05-27 05:41:06 +0000298 }
299
Anders Carlssone3c24c72010-05-29 17:35:14 +0000300 if (Info->PrimaryVirtualBaseInfo) {
301 BaseSubobjectInfo *PrimaryVirtualBaseInfo = Info->PrimaryVirtualBaseInfo;
Anders Carlsson439edd12010-05-27 05:41:06 +0000302
303 if (Info == PrimaryVirtualBaseInfo->Derived)
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000304 UpdateEmptyBaseSubobjects(PrimaryVirtualBaseInfo, Offset,
305 PlacingEmptyBase);
Anders Carlsson439edd12010-05-27 05:41:06 +0000306 }
Anders Carlssondb319762010-05-27 18:20:57 +0000307
Anders Carlssondb319762010-05-27 18:20:57 +0000308 // Traverse all member variables.
309 unsigned FieldNo = 0;
310 for (CXXRecordDecl::field_iterator I = Info->Class->field_begin(),
311 E = Info->Class->field_end(); I != E; ++I, ++FieldNo) {
David Blaikie40ed2972012-06-06 20:45:41 +0000312 if (I->isBitField())
Anders Carlsson233e2722010-10-31 21:54:55 +0000313 continue;
Anders Carlssona7774a62010-05-29 21:10:24 +0000314
Anders Carlsson28466ab2010-10-31 22:13:23 +0000315 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
David Blaikie40ed2972012-06-06 20:45:41 +0000316 UpdateEmptyFieldSubobjects(*I, FieldOffset);
Anders Carlssondb319762010-05-27 18:20:57 +0000317 }
Anders Carlsson439edd12010-05-27 05:41:06 +0000318}
319
Anders Carlssona60b86a2010-05-29 20:49:49 +0000320bool EmptySubobjectMap::CanPlaceBaseAtOffset(const BaseSubobjectInfo *Info,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000321 CharUnits Offset) {
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000322 // If we know this class doesn't have any empty subobjects we don't need to
323 // bother checking.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000324 if (SizeOfLargestEmptySubobject.isZero())
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000325 return true;
326
Anders Carlsson439edd12010-05-27 05:41:06 +0000327 if (!CanPlaceBaseSubobjectAtOffset(Info, Offset))
328 return false;
Anders Carlssondb319762010-05-27 18:20:57 +0000329
330 // We are able to place the base at this offset. Make sure to update the
331 // empty base subobject map.
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000332 UpdateEmptyBaseSubobjects(Info, Offset, Info->Class->isEmpty());
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000333 return true;
334}
335
Anders Carlssondb319762010-05-27 18:20:57 +0000336bool
337EmptySubobjectMap::CanPlaceFieldSubobjectAtOffset(const CXXRecordDecl *RD,
338 const CXXRecordDecl *Class,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000339 CharUnits Offset) const {
Anders Carlsson45c1d282010-06-08 16:20:35 +0000340 // We don't have to keep looking past the maximum offset that's known to
341 // contain an empty class.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000342 if (!AnyEmptySubobjectsBeyondOffset(Offset))
Anders Carlsson45c1d282010-06-08 16:20:35 +0000343 return true;
344
Anders Carlsson28466ab2010-10-31 22:13:23 +0000345 if (!CanPlaceSubobjectAtOffset(RD, Offset))
Anders Carlssondb319762010-05-27 18:20:57 +0000346 return false;
347
348 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
349
350 // Traverse all non-virtual bases.
351 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
352 E = RD->bases_end(); I != E; ++I) {
353 if (I->isVirtual())
354 continue;
355
356 const CXXRecordDecl *BaseDecl =
357 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
358
Anders Carlsson0a14ee92010-11-01 00:21:58 +0000359 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(BaseDecl);
Anders Carlssondb319762010-05-27 18:20:57 +0000360 if (!CanPlaceFieldSubobjectAtOffset(BaseDecl, Class, BaseOffset))
361 return false;
362 }
363
Anders Carlsson44687202010-06-08 19:09:24 +0000364 if (RD == Class) {
365 // This is the most derived class, traverse virtual bases as well.
366 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
367 E = RD->vbases_end(); I != E; ++I) {
368 const CXXRecordDecl *VBaseDecl =
369 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
370
Anders Carlsson3f018712010-10-31 23:45:59 +0000371 CharUnits VBaseOffset = Offset + Layout.getVBaseClassOffset(VBaseDecl);
Anders Carlsson44687202010-06-08 19:09:24 +0000372 if (!CanPlaceFieldSubobjectAtOffset(VBaseDecl, Class, VBaseOffset))
373 return false;
374 }
375 }
376
Anders Carlssondb319762010-05-27 18:20:57 +0000377 // Traverse all member variables.
378 unsigned FieldNo = 0;
379 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
380 I != E; ++I, ++FieldNo) {
David Blaikie40ed2972012-06-06 20:45:41 +0000381 if (I->isBitField())
Anders Carlsson233e2722010-10-31 21:54:55 +0000382 continue;
383
Anders Carlsson28466ab2010-10-31 22:13:23 +0000384 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
Anders Carlssondb319762010-05-27 18:20:57 +0000385
David Blaikie40ed2972012-06-06 20:45:41 +0000386 if (!CanPlaceFieldSubobjectAtOffset(*I, FieldOffset))
Anders Carlssondb319762010-05-27 18:20:57 +0000387 return false;
388 }
389
390 return true;
391}
392
Anders Carlsson233e2722010-10-31 21:54:55 +0000393bool
394EmptySubobjectMap::CanPlaceFieldSubobjectAtOffset(const FieldDecl *FD,
395 CharUnits Offset) const {
Anders Carlsson45c1d282010-06-08 16:20:35 +0000396 // We don't have to keep looking past the maximum offset that's known to
397 // contain an empty class.
Anders Carlsson233e2722010-10-31 21:54:55 +0000398 if (!AnyEmptySubobjectsBeyondOffset(Offset))
Anders Carlsson45c1d282010-06-08 16:20:35 +0000399 return true;
400
Anders Carlssondb319762010-05-27 18:20:57 +0000401 QualType T = FD->getType();
402 if (const RecordType *RT = T->getAs<RecordType>()) {
403 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
Anders Carlsson28466ab2010-10-31 22:13:23 +0000404 return CanPlaceFieldSubobjectAtOffset(RD, RD, Offset);
Anders Carlssondb319762010-05-27 18:20:57 +0000405 }
406
407 // If we have an array type we need to look at every element.
408 if (const ConstantArrayType *AT = Context.getAsConstantArrayType(T)) {
409 QualType ElemTy = Context.getBaseElementType(AT);
410 const RecordType *RT = ElemTy->getAs<RecordType>();
411 if (!RT)
412 return true;
413
414 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
415 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
416
417 uint64_t NumElements = Context.getConstantArrayElementCount(AT);
Anders Carlsson233e2722010-10-31 21:54:55 +0000418 CharUnits ElementOffset = Offset;
Anders Carlssondb319762010-05-27 18:20:57 +0000419 for (uint64_t I = 0; I != NumElements; ++I) {
Anders Carlsson45c1d282010-06-08 16:20:35 +0000420 // We don't have to keep looking past the maximum offset that's known to
421 // contain an empty class.
Anders Carlsson233e2722010-10-31 21:54:55 +0000422 if (!AnyEmptySubobjectsBeyondOffset(ElementOffset))
Anders Carlsson45c1d282010-06-08 16:20:35 +0000423 return true;
424
Anders Carlsson28466ab2010-10-31 22:13:23 +0000425 if (!CanPlaceFieldSubobjectAtOffset(RD, RD, ElementOffset))
Anders Carlssondb319762010-05-27 18:20:57 +0000426 return false;
427
Ken Dyckc8ae5502011-02-09 01:59:34 +0000428 ElementOffset += Layout.getSize();
Anders Carlssondb319762010-05-27 18:20:57 +0000429 }
430 }
431
432 return true;
433}
434
435bool
Anders Carlsson28466ab2010-10-31 22:13:23 +0000436EmptySubobjectMap::CanPlaceFieldAtOffset(const FieldDecl *FD,
437 CharUnits Offset) {
438 if (!CanPlaceFieldSubobjectAtOffset(FD, Offset))
Anders Carlssondb319762010-05-27 18:20:57 +0000439 return false;
440
441 // We are able to place the member variable at this offset.
442 // Make sure to update the empty base subobject map.
443 UpdateEmptyFieldSubobjects(FD, Offset);
444 return true;
445}
446
447void EmptySubobjectMap::UpdateEmptyFieldSubobjects(const CXXRecordDecl *RD,
448 const CXXRecordDecl *Class,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000449 CharUnits Offset) {
Anders Carlssonae111dc2010-06-13 17:49:16 +0000450 // We know that the only empty subobjects that can conflict with empty
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000451 // field subobjects are subobjects of empty bases that can be placed at offset
Anders Carlssonae111dc2010-06-13 17:49:16 +0000452 // zero. Because of this, we only need to keep track of empty field
453 // subobjects with offsets less than the size of the largest empty
454 // subobject for our class.
455 if (Offset >= SizeOfLargestEmptySubobject)
456 return;
457
Anders Carlsson28466ab2010-10-31 22:13:23 +0000458 AddSubobjectAtOffset(RD, Offset);
Anders Carlssondb319762010-05-27 18:20:57 +0000459
460 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
461
462 // Traverse all non-virtual bases.
463 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
464 E = RD->bases_end(); I != E; ++I) {
465 if (I->isVirtual())
466 continue;
467
468 const CXXRecordDecl *BaseDecl =
469 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
470
Anders Carlsson0a14ee92010-11-01 00:21:58 +0000471 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(BaseDecl);
Anders Carlssondb319762010-05-27 18:20:57 +0000472 UpdateEmptyFieldSubobjects(BaseDecl, Class, BaseOffset);
473 }
474
Anders Carlsson44687202010-06-08 19:09:24 +0000475 if (RD == Class) {
476 // This is the most derived class, traverse virtual bases as well.
477 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
478 E = RD->vbases_end(); I != E; ++I) {
479 const CXXRecordDecl *VBaseDecl =
480 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
481
Anders Carlsson3f018712010-10-31 23:45:59 +0000482 CharUnits VBaseOffset = Offset + Layout.getVBaseClassOffset(VBaseDecl);
Anders Carlsson44687202010-06-08 19:09:24 +0000483 UpdateEmptyFieldSubobjects(VBaseDecl, Class, VBaseOffset);
484 }
485 }
486
Anders Carlssondb319762010-05-27 18:20:57 +0000487 // Traverse all member variables.
488 unsigned FieldNo = 0;
489 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
490 I != E; ++I, ++FieldNo) {
David Blaikie40ed2972012-06-06 20:45:41 +0000491 if (I->isBitField())
Anders Carlsson09814d32010-11-01 15:14:51 +0000492 continue;
493
Anders Carlsson28466ab2010-10-31 22:13:23 +0000494 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
Anders Carlssondb319762010-05-27 18:20:57 +0000495
David Blaikie40ed2972012-06-06 20:45:41 +0000496 UpdateEmptyFieldSubobjects(*I, FieldOffset);
Anders Carlssondb319762010-05-27 18:20:57 +0000497 }
498}
499
500void EmptySubobjectMap::UpdateEmptyFieldSubobjects(const FieldDecl *FD,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000501 CharUnits Offset) {
Anders Carlssondb319762010-05-27 18:20:57 +0000502 QualType T = FD->getType();
503 if (const RecordType *RT = T->getAs<RecordType>()) {
504 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
505 UpdateEmptyFieldSubobjects(RD, RD, Offset);
506 return;
507 }
508
509 // If we have an array type we need to update every element.
510 if (const ConstantArrayType *AT = Context.getAsConstantArrayType(T)) {
511 QualType ElemTy = Context.getBaseElementType(AT);
512 const RecordType *RT = ElemTy->getAs<RecordType>();
513 if (!RT)
514 return;
515
516 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
517 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
518
519 uint64_t NumElements = Context.getConstantArrayElementCount(AT);
Anders Carlsson28466ab2010-10-31 22:13:23 +0000520 CharUnits ElementOffset = Offset;
Anders Carlssondb319762010-05-27 18:20:57 +0000521
522 for (uint64_t I = 0; I != NumElements; ++I) {
Anders Carlssonae111dc2010-06-13 17:49:16 +0000523 // We know that the only empty subobjects that can conflict with empty
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000524 // field subobjects are subobjects of empty bases that can be placed at
Anders Carlssonae111dc2010-06-13 17:49:16 +0000525 // offset zero. Because of this, we only need to keep track of empty field
526 // subobjects with offsets less than the size of the largest empty
527 // subobject for our class.
528 if (ElementOffset >= SizeOfLargestEmptySubobject)
529 return;
530
Anders Carlssondb319762010-05-27 18:20:57 +0000531 UpdateEmptyFieldSubobjects(RD, RD, ElementOffset);
Ken Dyckc8ae5502011-02-09 01:59:34 +0000532 ElementOffset += Layout.getSize();
Anders Carlssondb319762010-05-27 18:20:57 +0000533 }
534 }
535}
536
John McCalle42a3362012-05-01 08:55:32 +0000537typedef llvm::SmallPtrSet<const CXXRecordDecl*, 4> ClassSetTy;
538
Anders Carlssonc2226202010-05-26 05:58:59 +0000539class RecordLayoutBuilder {
Charles Davisc2c576a2010-08-19 00:55:19 +0000540protected:
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000541 // FIXME: Remove this and make the appropriate fields public.
542 friend class clang::ASTContext;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000543
Jay Foad39c79802011-01-12 09:06:06 +0000544 const ASTContext &Context;
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000545
Anders Carlssonf58de112010-05-26 15:32:58 +0000546 EmptySubobjectMap *EmptySubobjects;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000547
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000548 /// Size - The current size of the record layout.
549 uint64_t Size;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000550
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000551 /// Alignment - The current alignment of the record layout.
Ken Dyck4731d5b2011-02-16 02:05:21 +0000552 CharUnits Alignment;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000553
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000554 /// \brief The alignment if attribute packed is not used.
Ken Dyck1300b3b2011-02-16 02:11:31 +0000555 CharUnits UnpackedAlignment;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000556
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000557 SmallVector<uint64_t, 16> FieldOffsets;
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000558
Douglas Gregore9fc3772012-01-26 07:55:45 +0000559 /// \brief Whether the external AST source has provided a layout for this
560 /// record.
561 unsigned ExternalLayout : 1;
Douglas Gregor44ba7892012-01-28 00:53:29 +0000562
563 /// \brief Whether we need to infer alignment, even when we have an
564 /// externally-provided layout.
565 unsigned InferAlignment : 1;
Douglas Gregore9fc3772012-01-26 07:55:45 +0000566
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000567 /// Packed - Whether the record is packed or not.
Daniel Dunbar6da10982010-05-27 05:45:51 +0000568 unsigned Packed : 1;
569
570 unsigned IsUnion : 1;
571
572 unsigned IsMac68kAlign : 1;
Fariborz Jahanianbcb23a12011-04-26 23:52:16 +0000573
574 unsigned IsMsStruct : 1;
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000575
Eli Friedman2782dac2013-06-26 20:50:34 +0000576 /// UnfilledBitsInLastUnit - If the last field laid out was a bitfield,
577 /// this contains the number of bits in the last unit that can be used for
578 /// an adjacent bitfield if necessary. The unit in question is usually
579 /// a byte, but larger units are used if IsMsStruct.
580 unsigned char UnfilledBitsInLastUnit;
581 /// LastBitfieldTypeSize - If IsMsStruct, represents the size of the type
582 /// of the previous field if it was a bitfield.
583 unsigned char LastBitfieldTypeSize;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000584
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000585 /// MaxFieldAlignment - The maximum allowed field alignment. This is set by
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000586 /// #pragma pack.
Ken Dyck02ced6f2011-02-17 01:49:42 +0000587 CharUnits MaxFieldAlignment;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000588
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000589 /// DataSize - The data size of the record being laid out.
590 uint64_t DataSize;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000591
Ken Dyckaf1c83f2011-02-16 01:52:01 +0000592 CharUnits NonVirtualSize;
Ken Dycka2d3dda2011-02-16 01:43:15 +0000593 CharUnits NonVirtualAlignment;
Daniel Dunbar592a85c2010-05-27 02:25:46 +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
John McCalle42a3362012-05-01 08:55:32 +0000603 /// HasOwnVFPtr - Whether the class provides its own vtable/vftbl
604 /// pointer, as opposed to inheriting one from a primary base class.
605 bool HasOwnVFPtr;
Eli Friedman43114f92011-10-21 22:49:56 +0000606
Anders Carlsson22f57202010-10-31 21:01:46 +0000607 typedef llvm::DenseMap<const CXXRecordDecl *, CharUnits> BaseOffsetsMapTy;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000608
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000609 /// Bases - base classes and their offsets in the record.
610 BaseOffsetsMapTy Bases;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000611
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000612 // VBases - virtual base classes and their offsets in the record.
John McCalle42a3362012-05-01 08:55:32 +0000613 ASTRecordLayout::VBaseOffsetsMapTy VBases;
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000614
615 /// IndirectPrimaryBases - Virtual base classes, direct or indirect, that are
616 /// primary base classes for some other direct or indirect base class.
Anders Carlsson5adde292010-11-24 22:55:48 +0000617 CXXIndirectPrimaryBaseSet IndirectPrimaryBases;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000618
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000619 /// FirstNearlyEmptyVBase - The first nearly empty virtual base class in
620 /// inheritance graph order. Used for determining the primary base class.
621 const CXXRecordDecl *FirstNearlyEmptyVBase;
622
623 /// VisitedVirtualBases - A set of all the visited virtual bases, used to
624 /// avoid visiting virtual bases more than once.
625 llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBases;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000626
Douglas Gregore9fc3772012-01-26 07:55:45 +0000627 /// \brief Externally-provided size.
628 uint64_t ExternalSize;
629
630 /// \brief Externally-provided alignment.
631 uint64_t ExternalAlign;
632
633 /// \brief Externally-provided field offsets.
634 llvm::DenseMap<const FieldDecl *, uint64_t> ExternalFieldOffsets;
635
636 /// \brief Externally-provided direct, non-virtual base offsets.
637 llvm::DenseMap<const CXXRecordDecl *, CharUnits> ExternalBaseOffsets;
638
639 /// \brief Externally-provided virtual base offsets.
640 llvm::DenseMap<const CXXRecordDecl *, CharUnits> ExternalVirtualBaseOffsets;
641
John McCall0153cd32011-11-08 04:01:03 +0000642 RecordLayoutBuilder(const ASTContext &Context,
643 EmptySubobjectMap *EmptySubobjects)
Ken Dyck4731d5b2011-02-16 02:05:21 +0000644 : Context(Context), EmptySubobjects(EmptySubobjects), Size(0),
John McCall0153cd32011-11-08 04:01:03 +0000645 Alignment(CharUnits::One()), UnpackedAlignment(CharUnits::One()),
Douglas Gregor44ba7892012-01-28 00:53:29 +0000646 ExternalLayout(false), InferAlignment(false),
647 Packed(false), IsUnion(false), IsMac68kAlign(false), IsMsStruct(false),
Eli Friedman2782dac2013-06-26 20:50:34 +0000648 UnfilledBitsInLastUnit(0), LastBitfieldTypeSize(0),
649 MaxFieldAlignment(CharUnits::Zero()),
Ken Dyck02ced6f2011-02-17 01:49:42 +0000650 DataSize(0), NonVirtualSize(CharUnits::Zero()),
Fariborz Jahanianeb397412011-05-02 17:20:56 +0000651 NonVirtualAlignment(CharUnits::One()),
Eli Friedman481673f2013-06-26 23:47:39 +0000652 PrimaryBase(0), PrimaryBaseIsVirtual(false),
John McCalle42a3362012-05-01 08:55:32 +0000653 HasOwnVFPtr(false),
Eli Friedman84d2d3a2011-09-27 19:12:27 +0000654 FirstNearlyEmptyVBase(0) { }
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000655
John McCall0153cd32011-11-08 04:01:03 +0000656 /// Reset this RecordLayoutBuilder to a fresh state, using the given
657 /// alignment as the initial alignment. This is used for the
658 /// correct layout of vb-table pointers in MSVC.
659 void resetWithTargetAlignment(CharUnits TargetAlignment) {
660 const ASTContext &Context = this->Context;
661 EmptySubobjectMap *EmptySubobjects = this->EmptySubobjects;
662 this->~RecordLayoutBuilder();
663 new (this) RecordLayoutBuilder(Context, EmptySubobjects);
664 Alignment = UnpackedAlignment = TargetAlignment;
665 }
666
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000667 void Layout(const RecordDecl *D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000668 void Layout(const CXXRecordDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000669 void Layout(const ObjCInterfaceDecl *D);
670
671 void LayoutFields(const RecordDecl *D);
672 void LayoutField(const FieldDecl *D);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000673 void LayoutWideBitField(uint64_t FieldSize, uint64_t TypeSize,
674 bool FieldPacked, const FieldDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000675 void LayoutBitField(const FieldDecl *D);
John McCall0153cd32011-11-08 04:01:03 +0000676
John McCall359b8852013-01-25 22:30:49 +0000677 TargetCXXABI getCXXABI() const {
678 return Context.getTargetInfo().getCXXABI();
679 }
680
Anders Carlssone3c24c72010-05-29 17:35:14 +0000681 /// BaseSubobjectInfoAllocator - Allocator for BaseSubobjectInfo objects.
682 llvm::SpecificBumpPtrAllocator<BaseSubobjectInfo> BaseSubobjectInfoAllocator;
683
684 typedef llvm::DenseMap<const CXXRecordDecl *, BaseSubobjectInfo *>
685 BaseSubobjectInfoMapTy;
686
687 /// VirtualBaseInfo - Map from all the (direct or indirect) virtual bases
688 /// of the class we're laying out to their base subobject info.
689 BaseSubobjectInfoMapTy VirtualBaseInfo;
690
691 /// NonVirtualBaseInfo - Map from all the direct non-virtual bases of the
692 /// class we're laying out to their base subobject info.
693 BaseSubobjectInfoMapTy NonVirtualBaseInfo;
694
695 /// ComputeBaseSubobjectInfo - Compute the base subobject information for the
696 /// bases of the given class.
697 void ComputeBaseSubobjectInfo(const CXXRecordDecl *RD);
698
699 /// ComputeBaseSubobjectInfo - Compute the base subobject information for a
700 /// single class and all of its base classes.
701 BaseSubobjectInfo *ComputeBaseSubobjectInfo(const CXXRecordDecl *RD,
702 bool IsVirtual,
703 BaseSubobjectInfo *Derived);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000704
705 /// DeterminePrimaryBase - Determine the primary base of the given class.
706 void DeterminePrimaryBase(const CXXRecordDecl *RD);
707
708 void SelectPrimaryVBase(const CXXRecordDecl *RD);
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000709
Eli Friedman43114f92011-10-21 22:49:56 +0000710 void EnsureVTablePointerAlignment(CharUnits UnpackedBaseAlign);
Charles Davisc2c576a2010-08-19 00:55:19 +0000711
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000712 /// LayoutNonVirtualBases - Determines the primary base class (if any) and
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000713 /// lays it out. Will then proceed to lay out all non-virtual base clasess.
714 void LayoutNonVirtualBases(const CXXRecordDecl *RD);
715
716 /// LayoutNonVirtualBase - Lays out a single non-virtual base.
Anders Carlssonbb0e6782010-05-29 17:42:25 +0000717 void LayoutNonVirtualBase(const BaseSubobjectInfo *Base);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000718
Anders Carlssona2f8e412010-10-31 22:20:42 +0000719 void AddPrimaryVirtualBaseOffsets(const BaseSubobjectInfo *Info,
720 CharUnits Offset);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000721
722 /// LayoutVirtualBases - Lays out all the virtual bases.
723 void LayoutVirtualBases(const CXXRecordDecl *RD,
724 const CXXRecordDecl *MostDerivedClass);
725
726 /// LayoutVirtualBase - Lays out a single virtual base.
Warren Hunt55d8e822013-10-23 23:53:07 +0000727 void LayoutVirtualBase(const BaseSubobjectInfo *Base);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000728
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000729 /// LayoutBase - Will lay out a base and return the offset where it was
Anders Carlssona2f8e412010-10-31 22:20:42 +0000730 /// placed, in chars.
731 CharUnits LayoutBase(const BaseSubobjectInfo *Base);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000732
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000733 /// InitializeLayout - Initialize record layout for the given record decl.
Daniel Dunbar6da10982010-05-27 05:45:51 +0000734 void InitializeLayout(const Decl *D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000735
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000736 /// FinishLayout - Finalize record layout. Adjust record size based on the
737 /// alignment.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000738 void FinishLayout(const NamedDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000739
Ken Dyck85ef0432011-02-19 18:58:07 +0000740 void UpdateAlignment(CharUnits NewAlignment, CharUnits UnpackedNewAlignment);
741 void UpdateAlignment(CharUnits NewAlignment) {
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000742 UpdateAlignment(NewAlignment, NewAlignment);
743 }
744
Douglas Gregor44ba7892012-01-28 00:53:29 +0000745 /// \brief Retrieve the externally-supplied field offset for the given
746 /// field.
747 ///
748 /// \param Field The field whose offset is being queried.
749 /// \param ComputedOffset The offset that we've computed for this field.
750 uint64_t updateExternalFieldOffset(const FieldDecl *Field,
751 uint64_t ComputedOffset);
752
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000753 void CheckFieldPadding(uint64_t Offset, uint64_t UnpaddedOffset,
754 uint64_t UnpackedOffset, unsigned UnpackedAlign,
755 bool isPacked, const FieldDecl *D);
756
757 DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000758
Ken Dyckecfc7552011-02-24 01:13:28 +0000759 CharUnits getSize() const {
Ken Dyck3c215f22011-02-24 01:33:05 +0000760 assert(Size % Context.getCharWidth() == 0);
Ken Dyckecfc7552011-02-24 01:13:28 +0000761 return Context.toCharUnitsFromBits(Size);
762 }
763 uint64_t getSizeInBits() const { return Size; }
764
765 void setSize(CharUnits NewSize) { Size = Context.toBits(NewSize); }
766 void setSize(uint64_t NewSize) { Size = NewSize; }
767
Eli Friedman84d2d3a2011-09-27 19:12:27 +0000768 CharUnits getAligment() const { return Alignment; }
769
Ken Dyckecfc7552011-02-24 01:13:28 +0000770 CharUnits getDataSize() const {
Ken Dyck3c215f22011-02-24 01:33:05 +0000771 assert(DataSize % Context.getCharWidth() == 0);
Ken Dyckecfc7552011-02-24 01:13:28 +0000772 return Context.toCharUnitsFromBits(DataSize);
773 }
774 uint64_t getDataSizeInBits() const { return DataSize; }
775
776 void setDataSize(CharUnits NewSize) { DataSize = Context.toBits(NewSize); }
777 void setDataSize(uint64_t NewSize) { DataSize = NewSize; }
778
Dmitri Gribenkoa664e5b2012-09-15 20:20:27 +0000779 RecordLayoutBuilder(const RecordLayoutBuilder &) LLVM_DELETED_FUNCTION;
780 void operator=(const RecordLayoutBuilder &) LLVM_DELETED_FUNCTION;
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000781};
Benjamin Kramerc7656cd2010-05-26 09:58:31 +0000782} // end anonymous namespace
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000783
Anders Carlsson81430692009-09-22 03:02:06 +0000784void
Anders Carlssonc2226202010-05-26 05:58:59 +0000785RecordLayoutBuilder::SelectPrimaryVBase(const CXXRecordDecl *RD) {
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000786 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000787 E = RD->bases_end(); I != E; ++I) {
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000788 assert(!I->getType()->isDependentType() &&
Sebastian Redl1054fae2009-10-25 17:03:50 +0000789 "Cannot layout class with dependent bases.");
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000790
Mike Stump11289f42009-09-09 15:08:12 +0000791 const CXXRecordDecl *Base =
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000792 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000793
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000794 // Check if this is a nearly empty virtual base.
Anders Carlsson60a62632010-11-25 01:51:53 +0000795 if (I->isVirtual() && Context.isNearlyEmpty(Base)) {
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000796 // If it's not an indirect primary base, then we've found our primary
797 // base.
Anders Carlsson81430692009-09-22 03:02:06 +0000798 if (!IndirectPrimaryBases.count(Base)) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000799 PrimaryBase = Base;
800 PrimaryBaseIsVirtual = true;
Mike Stump6f3793b2009-08-12 21:50:08 +0000801 return;
802 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000803
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000804 // Is this the first nearly empty virtual base?
805 if (!FirstNearlyEmptyVBase)
806 FirstNearlyEmptyVBase = Base;
Mike Stump6f3793b2009-08-12 21:50:08 +0000807 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000808
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000809 SelectPrimaryVBase(Base);
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000810 if (PrimaryBase)
Zhongxing Xuec345b72010-02-15 04:28:35 +0000811 return;
Mike Stump6f3793b2009-08-12 21:50:08 +0000812 }
813}
814
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000815/// DeterminePrimaryBase - Determine the primary base of the given class.
Anders Carlssonc2226202010-05-26 05:58:59 +0000816void RecordLayoutBuilder::DeterminePrimaryBase(const CXXRecordDecl *RD) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000817 // If the class isn't dynamic, it won't have a primary base.
818 if (!RD->isDynamicClass())
819 return;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000820
Anders Carlsson81430692009-09-22 03:02:06 +0000821 // Compute all the primary virtual bases for all of our direct and
Mike Stump590a7c72009-08-13 23:26:06 +0000822 // indirect bases, and record all their primary virtual base classes.
Anders Carlsson5adde292010-11-24 22:55:48 +0000823 RD->getIndirectPrimaryBases(IndirectPrimaryBases);
Mike Stump590a7c72009-08-13 23:26:06 +0000824
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000825 // If the record has a dynamic base class, attempt to choose a primary base
826 // class. It is the first (in direct base class order) non-virtual dynamic
Anders Carlsson81430692009-09-22 03:02:06 +0000827 // base class, if one exists.
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000828 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000829 e = RD->bases_end(); i != e; ++i) {
Anders Carlsson03ff3792009-11-27 22:05:05 +0000830 // Ignore virtual bases.
831 if (i->isVirtual())
832 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000833
Anders Carlsson03ff3792009-11-27 22:05:05 +0000834 const CXXRecordDecl *Base =
835 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
836
Warren Hunt55d8e822013-10-23 23:53:07 +0000837 if (Base->isDynamicClass()) {
Anders Carlsson03ff3792009-11-27 22:05:05 +0000838 // We found it.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000839 PrimaryBase = Base;
840 PrimaryBaseIsVirtual = false;
Anders Carlsson03ff3792009-11-27 22:05:05 +0000841 return;
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000842 }
843 }
844
Eli Friedman5e9534b2011-10-18 00:55:28 +0000845 // Under the Itanium ABI, if there is no non-virtual primary base class,
846 // try to compute the primary virtual base. The primary virtual base is
847 // the first nearly empty virtual base that is not an indirect primary
848 // virtual base class, if one exists.
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000849 if (RD->getNumVBases() != 0) {
850 SelectPrimaryVBase(RD);
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000851 if (PrimaryBase)
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000852 return;
853 }
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000854
Eli Friedman5e9534b2011-10-18 00:55:28 +0000855 // Otherwise, it is the first indirect primary base class, if one exists.
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000856 if (FirstNearlyEmptyVBase) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000857 PrimaryBase = FirstNearlyEmptyVBase;
858 PrimaryBaseIsVirtual = true;
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000859 return;
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000860 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000861
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000862 assert(!PrimaryBase && "Should not get here with a primary base!");
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000863}
864
Anders Carlssone3c24c72010-05-29 17:35:14 +0000865BaseSubobjectInfo *
866RecordLayoutBuilder::ComputeBaseSubobjectInfo(const CXXRecordDecl *RD,
867 bool IsVirtual,
868 BaseSubobjectInfo *Derived) {
869 BaseSubobjectInfo *Info;
870
871 if (IsVirtual) {
872 // Check if we already have info about this virtual base.
873 BaseSubobjectInfo *&InfoSlot = VirtualBaseInfo[RD];
874 if (InfoSlot) {
875 assert(InfoSlot->Class == RD && "Wrong class for virtual base info!");
876 return InfoSlot;
877 }
878
879 // We don't, create it.
880 InfoSlot = new (BaseSubobjectInfoAllocator.Allocate()) BaseSubobjectInfo;
881 Info = InfoSlot;
882 } else {
883 Info = new (BaseSubobjectInfoAllocator.Allocate()) BaseSubobjectInfo;
884 }
885
886 Info->Class = RD;
887 Info->IsVirtual = IsVirtual;
888 Info->Derived = 0;
889 Info->PrimaryVirtualBaseInfo = 0;
890
891 const CXXRecordDecl *PrimaryVirtualBase = 0;
892 BaseSubobjectInfo *PrimaryVirtualBaseInfo = 0;
893
894 // Check if this base has a primary virtual base.
895 if (RD->getNumVBases()) {
896 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlsson7f95cd12010-11-24 23:12:57 +0000897 if (Layout.isPrimaryBaseVirtual()) {
Anders Carlssone3c24c72010-05-29 17:35:14 +0000898 // This base does have a primary virtual base.
899 PrimaryVirtualBase = Layout.getPrimaryBase();
900 assert(PrimaryVirtualBase && "Didn't have a primary virtual base!");
901
902 // Now check if we have base subobject info about this primary base.
903 PrimaryVirtualBaseInfo = VirtualBaseInfo.lookup(PrimaryVirtualBase);
904
905 if (PrimaryVirtualBaseInfo) {
906 if (PrimaryVirtualBaseInfo->Derived) {
907 // We did have info about this primary base, and it turns out that it
908 // has already been claimed as a primary virtual base for another
909 // base.
910 PrimaryVirtualBase = 0;
911 } else {
912 // We can claim this base as our primary base.
913 Info->PrimaryVirtualBaseInfo = PrimaryVirtualBaseInfo;
914 PrimaryVirtualBaseInfo->Derived = Info;
915 }
916 }
917 }
918 }
919
920 // Now go through all direct bases.
921 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
922 E = RD->bases_end(); I != E; ++I) {
923 bool IsVirtual = I->isVirtual();
924
925 const CXXRecordDecl *BaseDecl =
926 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
927
928 Info->Bases.push_back(ComputeBaseSubobjectInfo(BaseDecl, IsVirtual, Info));
929 }
930
931 if (PrimaryVirtualBase && !PrimaryVirtualBaseInfo) {
932 // Traversing the bases must have created the base info for our primary
933 // virtual base.
934 PrimaryVirtualBaseInfo = VirtualBaseInfo.lookup(PrimaryVirtualBase);
935 assert(PrimaryVirtualBaseInfo &&
936 "Did not create a primary virtual base!");
937
938 // Claim the primary virtual base as our primary virtual base.
939 Info->PrimaryVirtualBaseInfo = PrimaryVirtualBaseInfo;
940 PrimaryVirtualBaseInfo->Derived = Info;
941 }
942
943 return Info;
944}
945
946void RecordLayoutBuilder::ComputeBaseSubobjectInfo(const CXXRecordDecl *RD) {
947 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
948 E = RD->bases_end(); I != E; ++I) {
949 bool IsVirtual = I->isVirtual();
950
951 const CXXRecordDecl *BaseDecl =
952 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
953
954 // Compute the base subobject info for this base.
955 BaseSubobjectInfo *Info = ComputeBaseSubobjectInfo(BaseDecl, IsVirtual, 0);
956
957 if (IsVirtual) {
958 // ComputeBaseInfo has already added this base for us.
959 assert(VirtualBaseInfo.count(BaseDecl) &&
960 "Did not add virtual base!");
961 } else {
962 // Add the base info to the map of non-virtual bases.
963 assert(!NonVirtualBaseInfo.count(BaseDecl) &&
964 "Non-virtual base already exists!");
965 NonVirtualBaseInfo.insert(std::make_pair(BaseDecl, Info));
966 }
967 }
968}
969
Anders Carlsson09ffa322010-03-10 22:21:28 +0000970void
Eli Friedman43114f92011-10-21 22:49:56 +0000971RecordLayoutBuilder::EnsureVTablePointerAlignment(CharUnits UnpackedBaseAlign) {
Eli Friedman5e9534b2011-10-18 00:55:28 +0000972 CharUnits BaseAlign = (Packed) ? CharUnits::One() : UnpackedBaseAlign;
973
974 // The maximum field alignment overrides base align.
975 if (!MaxFieldAlignment.isZero()) {
976 BaseAlign = std::min(BaseAlign, MaxFieldAlignment);
977 UnpackedBaseAlign = std::min(UnpackedBaseAlign, MaxFieldAlignment);
978 }
979
980 // Round up the current record size to pointer alignment.
Eli Friedman43114f92011-10-21 22:49:56 +0000981 setSize(getSize().RoundUpToAlignment(BaseAlign));
982 setDataSize(getSize());
Eli Friedman5e9534b2011-10-18 00:55:28 +0000983
984 // Update the alignment.
985 UpdateAlignment(BaseAlign, UnpackedBaseAlign);
986}
987
988void
Anders Carlssonc2226202010-05-26 05:58:59 +0000989RecordLayoutBuilder::LayoutNonVirtualBases(const CXXRecordDecl *RD) {
Anders Carlssone3c24c72010-05-29 17:35:14 +0000990 // Then, determine the primary base class.
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000991 DeterminePrimaryBase(RD);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000992
Anders Carlssone3c24c72010-05-29 17:35:14 +0000993 // Compute base subobject info.
994 ComputeBaseSubobjectInfo(RD);
995
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000996 // If we have a primary base class, lay it out.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000997 if (PrimaryBase) {
998 if (PrimaryBaseIsVirtual) {
Anders Carlssone3c24c72010-05-29 17:35:14 +0000999 // If the primary virtual base was a primary virtual base of some other
1000 // base class we'll have to steal it.
1001 BaseSubobjectInfo *PrimaryBaseInfo = VirtualBaseInfo.lookup(PrimaryBase);
1002 PrimaryBaseInfo->Derived = 0;
1003
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001004 // We have a virtual primary base, insert it as an indirect primary base.
Anders Carlssond20e7cd2010-05-26 05:20:58 +00001005 IndirectPrimaryBases.insert(PrimaryBase);
Anders Carlssonfe900962010-03-11 05:42:17 +00001006
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001007 assert(!VisitedVirtualBases.count(PrimaryBase) &&
Anders Carlssond20e7cd2010-05-26 05:20:58 +00001008 "vbase already visited!");
1009 VisitedVirtualBases.insert(PrimaryBase);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001010
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001011 LayoutVirtualBase(PrimaryBaseInfo);
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001012 } else {
1013 BaseSubobjectInfo *PrimaryBaseInfo =
1014 NonVirtualBaseInfo.lookup(PrimaryBase);
1015 assert(PrimaryBaseInfo &&
1016 "Did not find base info for non-virtual primary base!");
1017
1018 LayoutNonVirtualBase(PrimaryBaseInfo);
1019 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001020
John McCall0153cd32011-11-08 04:01:03 +00001021 // If this class needs a vtable/vf-table and didn't get one from a
1022 // primary base, add it in now.
Warren Hunt55d8e822013-10-23 23:53:07 +00001023 } else if (RD->isDynamicClass()) {
Eli Friedman5e9534b2011-10-18 00:55:28 +00001024 assert(DataSize == 0 && "Vtable pointer must be at offset zero!");
Eli Friedman5e9534b2011-10-18 00:55:28 +00001025 CharUnits PtrWidth =
1026 Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerWidth(0));
Eli Friedman43114f92011-10-21 22:49:56 +00001027 CharUnits PtrAlign =
1028 Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerAlign(0));
1029 EnsureVTablePointerAlignment(PtrAlign);
John McCalle42a3362012-05-01 08:55:32 +00001030 HasOwnVFPtr = true;
Eli Friedman5e9534b2011-10-18 00:55:28 +00001031 setSize(getSize() + PtrWidth);
1032 setDataSize(getSize());
1033 }
1034
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001035 // Now lay out the non-virtual bases.
1036 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001037 E = RD->bases_end(); I != E; ++I) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001038
Benjamin Kramer273670a2013-10-25 07:40:50 +00001039 // Ignore virtual bases.
1040 if (I->isVirtual())
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001041 continue;
1042
Reid Klecknere7106c92013-12-18 23:17:05 +00001043 const CXXRecordDecl *BaseDecl = I->getType()->getAsCXXRecordDecl();
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001044
John McCall0153cd32011-11-08 04:01:03 +00001045 // Skip the primary base, because we've already laid it out. The
1046 // !PrimaryBaseIsVirtual check is required because we might have a
1047 // non-virtual base of the same type as a primary virtual base.
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001048 if (BaseDecl == PrimaryBase && !PrimaryBaseIsVirtual)
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001049 continue;
1050
1051 // Lay out the base.
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001052 BaseSubobjectInfo *BaseInfo = NonVirtualBaseInfo.lookup(BaseDecl);
1053 assert(BaseInfo && "Did not find base info for non-virtual base!");
1054
1055 LayoutNonVirtualBase(BaseInfo);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001056 }
1057}
1058
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001059void RecordLayoutBuilder::LayoutNonVirtualBase(const BaseSubobjectInfo *Base) {
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001060 // Layout the base.
Anders Carlssona2f8e412010-10-31 22:20:42 +00001061 CharUnits Offset = LayoutBase(Base);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001062
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001063 // Add its base class offset.
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001064 assert(!Bases.count(Base->Class) && "base offset already exists!");
Anders Carlssona2f8e412010-10-31 22:20:42 +00001065 Bases.insert(std::make_pair(Base->Class, Offset));
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001066
1067 AddPrimaryVirtualBaseOffsets(Base, Offset);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001068}
Mike Stump2b84dd32009-11-05 04:02:15 +00001069
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001070void
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001071RecordLayoutBuilder::AddPrimaryVirtualBaseOffsets(const BaseSubobjectInfo *Info,
Anders Carlssona2f8e412010-10-31 22:20:42 +00001072 CharUnits Offset) {
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001073 // This base isn't interesting, it has no virtual bases.
1074 if (!Info->Class->getNumVBases())
1075 return;
1076
1077 // First, check if we have a virtual primary base to add offsets for.
1078 if (Info->PrimaryVirtualBaseInfo) {
1079 assert(Info->PrimaryVirtualBaseInfo->IsVirtual &&
1080 "Primary virtual base is not virtual!");
1081 if (Info->PrimaryVirtualBaseInfo->Derived == Info) {
1082 // Add the offset.
1083 assert(!VBases.count(Info->PrimaryVirtualBaseInfo->Class) &&
1084 "primary vbase offset already exists!");
1085 VBases.insert(std::make_pair(Info->PrimaryVirtualBaseInfo->Class,
John McCalle42a3362012-05-01 08:55:32 +00001086 ASTRecordLayout::VBaseInfo(Offset, false)));
Anders Carlssonea7b1822010-04-15 16:12:58 +00001087
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001088 // Traverse the primary virtual base.
1089 AddPrimaryVirtualBaseOffsets(Info->PrimaryVirtualBaseInfo, Offset);
1090 }
Anders Carlssonea7b1822010-04-15 16:12:58 +00001091 }
1092
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001093 // Now go through all direct non-virtual bases.
1094 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Info->Class);
1095 for (unsigned I = 0, E = Info->Bases.size(); I != E; ++I) {
1096 const BaseSubobjectInfo *Base = Info->Bases[I];
1097 if (Base->IsVirtual)
Anders Carlssonea7b1822010-04-15 16:12:58 +00001098 continue;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001099
Anders Carlsson0a14ee92010-11-01 00:21:58 +00001100 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base->Class);
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001101 AddPrimaryVirtualBaseOffsets(Base, BaseOffset);
Anders Carlssonea7b1822010-04-15 16:12:58 +00001102 }
1103}
1104
1105void
Anders Carlssonc2226202010-05-26 05:58:59 +00001106RecordLayoutBuilder::LayoutVirtualBases(const CXXRecordDecl *RD,
Anders Carlssonea7b1822010-04-15 16:12:58 +00001107 const CXXRecordDecl *MostDerivedClass) {
Anders Carlssonde710c92010-03-11 04:33:54 +00001108 const CXXRecordDecl *PrimaryBase;
Anders Carlsson291279e2010-04-10 18:42:27 +00001109 bool PrimaryBaseIsVirtual;
Anders Carlssonfe900962010-03-11 05:42:17 +00001110
Anders Carlsson291279e2010-04-10 18:42:27 +00001111 if (MostDerivedClass == RD) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +00001112 PrimaryBase = this->PrimaryBase;
1113 PrimaryBaseIsVirtual = this->PrimaryBaseIsVirtual;
Anders Carlsson291279e2010-04-10 18:42:27 +00001114 } else {
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001115 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlssonde710c92010-03-11 04:33:54 +00001116 PrimaryBase = Layout.getPrimaryBase();
Anders Carlsson7f95cd12010-11-24 23:12:57 +00001117 PrimaryBaseIsVirtual = Layout.isPrimaryBaseVirtual();
Anders Carlsson291279e2010-04-10 18:42:27 +00001118 }
1119
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001120 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1121 E = RD->bases_end(); I != E; ++I) {
1122 assert(!I->getType()->isDependentType() &&
Sebastian Redl1054fae2009-10-25 17:03:50 +00001123 "Cannot layout class with dependent bases.");
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001124
Reid Klecknere7106c92013-12-18 23:17:05 +00001125 const CXXRecordDecl *BaseDecl = I->getType()->getAsCXXRecordDecl();
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001126
1127 if (I->isVirtual()) {
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001128 if (PrimaryBase != BaseDecl || !PrimaryBaseIsVirtual) {
1129 bool IndirectPrimaryBase = IndirectPrimaryBases.count(BaseDecl);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001130
Anders Carlsson291279e2010-04-10 18:42:27 +00001131 // Only lay out the virtual base if it's not an indirect primary base.
1132 if (!IndirectPrimaryBase) {
1133 // Only visit virtual bases once.
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001134 if (!VisitedVirtualBases.insert(BaseDecl))
Anders Carlsson291279e2010-04-10 18:42:27 +00001135 continue;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001136
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001137 const BaseSubobjectInfo *BaseInfo = VirtualBaseInfo.lookup(BaseDecl);
1138 assert(BaseInfo && "Did not find virtual base info!");
1139 LayoutVirtualBase(BaseInfo);
Anders Carlsson6a848892010-03-11 04:10:39 +00001140 }
Mike Stump2b84dd32009-11-05 04:02:15 +00001141 }
Mike Stumpc2f591b2009-08-13 22:53:07 +00001142 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001143
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001144 if (!BaseDecl->getNumVBases()) {
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001145 // This base isn't interesting since it doesn't have any virtual bases.
1146 continue;
Mike Stump996576f32009-08-16 19:04:13 +00001147 }
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001148
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001149 LayoutVirtualBases(BaseDecl, MostDerivedClass);
Mike Stump6b2556f2009-08-06 13:41:24 +00001150 }
1151}
1152
Warren Hunt55d8e822013-10-23 23:53:07 +00001153void RecordLayoutBuilder::LayoutVirtualBase(const BaseSubobjectInfo *Base) {
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001154 assert(!Base->Derived && "Trying to lay out a primary virtual base!");
1155
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001156 // Layout the base.
Anders Carlssona2f8e412010-10-31 22:20:42 +00001157 CharUnits Offset = LayoutBase(Base);
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001158
1159 // Add its base class offset.
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001160 assert(!VBases.count(Base->Class) && "vbase offset already exists!");
John McCalle42a3362012-05-01 08:55:32 +00001161 VBases.insert(std::make_pair(Base->Class,
Warren Hunt55d8e822013-10-23 23:53:07 +00001162 ASTRecordLayout::VBaseInfo(Offset, false)));
John McCalle42a3362012-05-01 08:55:32 +00001163
Warren Hunt55d8e822013-10-23 23:53:07 +00001164 AddPrimaryVirtualBaseOffsets(Base, Offset);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001165}
1166
Anders Carlssona2f8e412010-10-31 22:20:42 +00001167CharUnits RecordLayoutBuilder::LayoutBase(const BaseSubobjectInfo *Base) {
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001168 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Base->Class);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001169
Douglas Gregore9fc3772012-01-26 07:55:45 +00001170
1171 CharUnits Offset;
1172
1173 // Query the external layout to see if it provides an offset.
1174 bool HasExternalLayout = false;
1175 if (ExternalLayout) {
1176 llvm::DenseMap<const CXXRecordDecl *, CharUnits>::iterator Known;
1177 if (Base->IsVirtual) {
1178 Known = ExternalVirtualBaseOffsets.find(Base->Class);
1179 if (Known != ExternalVirtualBaseOffsets.end()) {
1180 Offset = Known->second;
1181 HasExternalLayout = true;
1182 }
1183 } else {
1184 Known = ExternalBaseOffsets.find(Base->Class);
1185 if (Known != ExternalBaseOffsets.end()) {
1186 Offset = Known->second;
1187 HasExternalLayout = true;
1188 }
1189 }
1190 }
1191
Warren Huntd640d7d2014-01-09 00:30:56 +00001192 CharUnits UnpackedBaseAlign = Layout.getNonVirtualAlignment();
Eli Friedman69d27d22013-07-16 00:21:28 +00001193 CharUnits BaseAlign = (Packed) ? CharUnits::One() : UnpackedBaseAlign;
1194
Anders Carlsson09ffa322010-03-10 22:21:28 +00001195 // If we have an empty base class, try to place it at offset 0.
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001196 if (Base->Class->isEmpty() &&
Douglas Gregore9fc3772012-01-26 07:55:45 +00001197 (!HasExternalLayout || Offset == CharUnits::Zero()) &&
Anders Carlsson28466ab2010-10-31 22:13:23 +00001198 EmptySubobjects->CanPlaceBaseAtOffset(Base, CharUnits::Zero())) {
Ken Dyck1b4420e2011-02-28 02:01:38 +00001199 setSize(std::max(getSize(), Layout.getSize()));
Eli Friedman69d27d22013-07-16 00:21:28 +00001200 UpdateAlignment(BaseAlign, UnpackedBaseAlign);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001201
Anders Carlssona2f8e412010-10-31 22:20:42 +00001202 return CharUnits::Zero();
Anders Carlsson09ffa322010-03-10 22:21:28 +00001203 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001204
Argyrios Kyrtzidis8b542742010-12-09 00:35:20 +00001205 // The maximum field alignment overrides base align.
Ken Dyck02ced6f2011-02-17 01:49:42 +00001206 if (!MaxFieldAlignment.isZero()) {
Ken Dyck85ef0432011-02-19 18:58:07 +00001207 BaseAlign = std::min(BaseAlign, MaxFieldAlignment);
1208 UnpackedBaseAlign = std::min(UnpackedBaseAlign, MaxFieldAlignment);
Argyrios Kyrtzidis8b542742010-12-09 00:35:20 +00001209 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001210
Douglas Gregore9fc3772012-01-26 07:55:45 +00001211 if (!HasExternalLayout) {
1212 // Round up the current record size to the base's alignment boundary.
1213 Offset = getDataSize().RoundUpToAlignment(BaseAlign);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001214
Douglas Gregore9fc3772012-01-26 07:55:45 +00001215 // Try to place the base.
1216 while (!EmptySubobjects->CanPlaceBaseAtOffset(Base, Offset))
1217 Offset += BaseAlign;
1218 } else {
1219 bool Allowed = EmptySubobjects->CanPlaceBaseAtOffset(Base, Offset);
1220 (void)Allowed;
1221 assert(Allowed && "Base subobject externally placed at overlapping offset");
Douglas Gregor1423a5c2012-10-26 22:31:14 +00001222
1223 if (InferAlignment && Offset < getDataSize().RoundUpToAlignment(BaseAlign)){
1224 // The externally-supplied base offset is before the base offset we
1225 // computed. Assume that the structure is packed.
1226 Alignment = CharUnits::One();
1227 InferAlignment = false;
1228 }
Douglas Gregore9fc3772012-01-26 07:55:45 +00001229 }
1230
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001231 if (!Base->Class->isEmpty()) {
Anders Carlsson09ffa322010-03-10 22:21:28 +00001232 // Update the data size.
Ken Dyck1b4420e2011-02-28 02:01:38 +00001233 setDataSize(Offset + Layout.getNonVirtualSize());
Anders Carlsson09ffa322010-03-10 22:21:28 +00001234
Ken Dyck1b4420e2011-02-28 02:01:38 +00001235 setSize(std::max(getSize(), getDataSize()));
Anders Carlsson09ffa322010-03-10 22:21:28 +00001236 } else
Ken Dyck1b4420e2011-02-28 02:01:38 +00001237 setSize(std::max(getSize(), Offset + Layout.getSize()));
Anders Carlsson09ffa322010-03-10 22:21:28 +00001238
1239 // Remember max struct/class alignment.
Argyrios Kyrtzidis8b542742010-12-09 00:35:20 +00001240 UpdateAlignment(BaseAlign, UnpackedBaseAlign);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001241
Ken Dyck1b4420e2011-02-28 02:01:38 +00001242 return Offset;
Anders Carlsson09ffa322010-03-10 22:21:28 +00001243}
1244
Daniel Dunbar6da10982010-05-27 05:45:51 +00001245void RecordLayoutBuilder::InitializeLayout(const Decl *D) {
Eli Friedman9ee2d0472012-10-12 23:29:20 +00001246 if (const RecordDecl *RD = dyn_cast<RecordDecl>(D)) {
Daniel Dunbar6da10982010-05-27 05:45:51 +00001247 IsUnion = RD->isUnion();
Eli Friedman9ee2d0472012-10-12 23:29:20 +00001248 IsMsStruct = RD->isMsStruct(Context);
1249 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001250
Eli Friedman9ee2d0472012-10-12 23:29:20 +00001251 Packed = D->hasAttr<PackedAttr>();
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001252
Daniel Dunbar096ed292011-10-05 21:04:55 +00001253 // Honor the default struct packing maximum alignment flag.
David Blaikiebbafb8a2012-03-11 07:00:24 +00001254 if (unsigned DefaultMaxFieldAlignment = Context.getLangOpts().PackStruct) {
Daniel Dunbar096ed292011-10-05 21:04:55 +00001255 MaxFieldAlignment = CharUnits::fromQuantity(DefaultMaxFieldAlignment);
1256 }
1257
Daniel Dunbar6da10982010-05-27 05:45:51 +00001258 // mac68k alignment supersedes maximum field alignment and attribute aligned,
1259 // and forces all structures to have 2-byte alignment. The IBM docs on it
1260 // allude to additional (more complicated) semantics, especially with regard
1261 // to bit-fields, but gcc appears not to follow that.
1262 if (D->hasAttr<AlignMac68kAttr>()) {
1263 IsMac68kAlign = true;
Ken Dyck02ced6f2011-02-17 01:49:42 +00001264 MaxFieldAlignment = CharUnits::fromQuantity(2);
Ken Dyck4731d5b2011-02-16 02:05:21 +00001265 Alignment = CharUnits::fromQuantity(2);
Daniel Dunbar6da10982010-05-27 05:45:51 +00001266 } else {
1267 if (const MaxFieldAlignmentAttr *MFAA = D->getAttr<MaxFieldAlignmentAttr>())
Ken Dyck02ced6f2011-02-17 01:49:42 +00001268 MaxFieldAlignment = Context.toCharUnitsFromBits(MFAA->getAlignment());
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001269
Alexis Huntdcfba7b2010-08-18 23:23:40 +00001270 if (unsigned MaxAlign = D->getMaxAlignment())
Ken Dyck85ef0432011-02-19 18:58:07 +00001271 UpdateAlignment(Context.toCharUnitsFromBits(MaxAlign));
Daniel Dunbar6da10982010-05-27 05:45:51 +00001272 }
Douglas Gregore9fc3772012-01-26 07:55:45 +00001273
1274 // If there is an external AST source, ask it for the various offsets.
1275 if (const RecordDecl *RD = dyn_cast<RecordDecl>(D))
1276 if (ExternalASTSource *External = Context.getExternalSource()) {
1277 ExternalLayout = External->layoutRecordType(RD,
1278 ExternalSize,
1279 ExternalAlign,
1280 ExternalFieldOffsets,
1281 ExternalBaseOffsets,
1282 ExternalVirtualBaseOffsets);
1283
1284 // Update based on external alignment.
1285 if (ExternalLayout) {
Douglas Gregor44ba7892012-01-28 00:53:29 +00001286 if (ExternalAlign > 0) {
1287 Alignment = Context.toCharUnitsFromBits(ExternalAlign);
Douglas Gregor44ba7892012-01-28 00:53:29 +00001288 } else {
1289 // The external source didn't have alignment information; infer it.
1290 InferAlignment = true;
1291 }
Douglas Gregore9fc3772012-01-26 07:55:45 +00001292 }
1293 }
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001294}
Anders Carlsson6d9f6f32009-07-19 00:18:47 +00001295
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001296void RecordLayoutBuilder::Layout(const RecordDecl *D) {
1297 InitializeLayout(D);
Anders Carlsson118ce162009-07-18 21:48:39 +00001298 LayoutFields(D);
Mike Stump11289f42009-09-09 15:08:12 +00001299
Anders Carlsson79474332009-07-18 20:20:21 +00001300 // Finally, round the size of the total struct up to the alignment of the
1301 // struct itself.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001302 FinishLayout(D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001303}
1304
1305void RecordLayoutBuilder::Layout(const CXXRecordDecl *RD) {
1306 InitializeLayout(RD);
1307
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001308 // Lay out the vtable and the non-virtual bases.
1309 LayoutNonVirtualBases(RD);
1310
1311 LayoutFields(RD);
1312
Ken Dycke7380752011-03-10 01:53:59 +00001313 NonVirtualSize = Context.toCharUnitsFromBits(
1314 llvm::RoundUpToAlignment(getSizeInBits(),
Douglas Gregore8bbc122011-09-02 00:18:52 +00001315 Context.getTargetInfo().getCharAlign()));
Ken Dyck4731d5b2011-02-16 02:05:21 +00001316 NonVirtualAlignment = Alignment;
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001317
Warren Hunt55d8e822013-10-23 23:53:07 +00001318 // Lay out the virtual bases and add the primary virtual base offsets.
1319 LayoutVirtualBases(RD, RD);
John McCall0153cd32011-11-08 04:01:03 +00001320
1321 // Finally, round the size of the total struct up to the alignment
Eli Friedman83a12582011-12-01 00:37:01 +00001322 // of the struct itself.
1323 FinishLayout(RD);
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001324
Anders Carlsson5b441d72010-04-10 21:24:48 +00001325#ifndef NDEBUG
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001326 // Check that we have base offsets for all bases.
1327 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1328 E = RD->bases_end(); I != E; ++I) {
1329 if (I->isVirtual())
1330 continue;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001331
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001332 const CXXRecordDecl *BaseDecl =
1333 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1334
1335 assert(Bases.count(BaseDecl) && "Did not find base offset!");
1336 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001337
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001338 // And all virtual bases.
1339 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
1340 E = RD->vbases_end(); I != E; ++I) {
1341 const CXXRecordDecl *BaseDecl =
1342 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001343
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001344 assert(VBases.count(BaseDecl) && "Did not find base offset!");
Anders Carlsson5b441d72010-04-10 21:24:48 +00001345 }
1346#endif
Anders Carlsson79474332009-07-18 20:20:21 +00001347}
1348
Anders Carlssonc2226202010-05-26 05:58:59 +00001349void RecordLayoutBuilder::Layout(const ObjCInterfaceDecl *D) {
Anders Carlsson4f516282009-07-18 20:50:59 +00001350 if (ObjCInterfaceDecl *SD = D->getSuperClass()) {
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001351 const ASTRecordLayout &SL = Context.getASTObjCInterfaceLayout(SD);
Anders Carlsson4f516282009-07-18 20:50:59 +00001352
Ken Dyck85ef0432011-02-19 18:58:07 +00001353 UpdateAlignment(SL.getAlignment());
Mike Stump11289f42009-09-09 15:08:12 +00001354
Anders Carlsson4f516282009-07-18 20:50:59 +00001355 // We start laying out ivars not at the end of the superclass
1356 // structure, but at the next byte following the last field.
Ken Dyckecfc7552011-02-24 01:13:28 +00001357 setSize(SL.getDataSize());
Ken Dyck1b4420e2011-02-28 02:01:38 +00001358 setDataSize(getSize());
Anders Carlsson4f516282009-07-18 20:50:59 +00001359 }
Mike Stump11289f42009-09-09 15:08:12 +00001360
Daniel Dunbar6da10982010-05-27 05:45:51 +00001361 InitializeLayout(D);
Anders Carlsson4f516282009-07-18 20:50:59 +00001362 // Layout each ivar sequentially.
Jordy Rosea91768e2011-07-22 02:08:32 +00001363 for (const ObjCIvarDecl *IVD = D->all_declared_ivar_begin(); IVD;
1364 IVD = IVD->getNextIvar())
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00001365 LayoutField(IVD);
Mike Stump11289f42009-09-09 15:08:12 +00001366
Anders Carlsson4f516282009-07-18 20:50:59 +00001367 // Finally, round the size of the total struct up to the alignment of the
1368 // struct itself.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001369 FinishLayout(D);
Anders Carlsson4f516282009-07-18 20:50:59 +00001370}
1371
Anders Carlssonc2226202010-05-26 05:58:59 +00001372void RecordLayoutBuilder::LayoutFields(const RecordDecl *D) {
Anders Carlsson118ce162009-07-18 21:48:39 +00001373 // Layout each field, for now, just sequentially, respecting alignment. In
1374 // the future, this will need to be tweakable by targets.
Mike Stump11289f42009-09-09 15:08:12 +00001375 for (RecordDecl::field_iterator Field = D->field_begin(),
Eli Friedman481673f2013-06-26 23:47:39 +00001376 FieldEnd = D->field_end(); Field != FieldEnd; ++Field)
David Blaikie40ed2972012-06-06 20:45:41 +00001377 LayoutField(*Field);
Anders Carlsson118ce162009-07-18 21:48:39 +00001378}
1379
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001380void RecordLayoutBuilder::LayoutWideBitField(uint64_t FieldSize,
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001381 uint64_t TypeSize,
1382 bool FieldPacked,
1383 const FieldDecl *D) {
David Blaikiebbafb8a2012-03-11 07:00:24 +00001384 assert(Context.getLangOpts().CPlusPlus &&
Anders Carlsson57235162010-04-16 15:57:11 +00001385 "Can only have wide bit-fields in C++!");
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001386
Anders Carlsson57235162010-04-16 15:57:11 +00001387 // Itanium C++ ABI 2.4:
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001388 // If sizeof(T)*8 < n, let T' be the largest integral POD type with
Anders Carlsson57235162010-04-16 15:57:11 +00001389 // sizeof(T')*8 <= n.
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001390
Anders Carlsson57235162010-04-16 15:57:11 +00001391 QualType IntegralPODTypes[] = {
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001392 Context.UnsignedCharTy, Context.UnsignedShortTy, Context.UnsignedIntTy,
Anders Carlsson57235162010-04-16 15:57:11 +00001393 Context.UnsignedLongTy, Context.UnsignedLongLongTy
1394 };
1395
Anders Carlsson57235162010-04-16 15:57:11 +00001396 QualType Type;
1397 for (unsigned I = 0, E = llvm::array_lengthof(IntegralPODTypes);
1398 I != E; ++I) {
1399 uint64_t Size = Context.getTypeSize(IntegralPODTypes[I]);
Anders Carlsson57235162010-04-16 15:57:11 +00001400
1401 if (Size > FieldSize)
1402 break;
1403
1404 Type = IntegralPODTypes[I];
1405 }
1406 assert(!Type.isNull() && "Did not find a type!");
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001407
Ken Dyckdbe37f32011-03-01 01:36:00 +00001408 CharUnits TypeAlign = Context.getTypeAlignInChars(Type);
Anders Carlsson57235162010-04-16 15:57:11 +00001409
1410 // We're not going to use any of the unfilled bits in the last byte.
Eli Friedman2782dac2013-06-26 20:50:34 +00001411 UnfilledBitsInLastUnit = 0;
1412 LastBitfieldTypeSize = 0;
Anders Carlsson57235162010-04-16 15:57:11 +00001413
Anders Carlssonaad5fa82010-04-17 20:21:41 +00001414 uint64_t FieldOffset;
Eli Friedman2782dac2013-06-26 20:50:34 +00001415 uint64_t UnpaddedFieldOffset = getDataSizeInBits() - UnfilledBitsInLastUnit;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001416
Anders Carlsson57235162010-04-16 15:57:11 +00001417 if (IsUnion) {
Ken Dyckecfc7552011-02-24 01:13:28 +00001418 setDataSize(std::max(getDataSizeInBits(), FieldSize));
Anders Carlssonaad5fa82010-04-17 20:21:41 +00001419 FieldOffset = 0;
Anders Carlsson57235162010-04-16 15:57:11 +00001420 } else {
Chad Rosiere1a6a0e2011-08-05 22:38:04 +00001421 // The bitfield is allocated starting at the next offset aligned
1422 // appropriately for T', with length n bits.
Ken Dyckdbe37f32011-03-01 01:36:00 +00001423 FieldOffset = llvm::RoundUpToAlignment(getDataSizeInBits(),
1424 Context.toBits(TypeAlign));
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001425
Anders Carlsson57235162010-04-16 15:57:11 +00001426 uint64_t NewSizeInBits = FieldOffset + FieldSize;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001427
Ken Dycka1a2e8d2011-03-10 02:00:35 +00001428 setDataSize(llvm::RoundUpToAlignment(NewSizeInBits,
Douglas Gregore8bbc122011-09-02 00:18:52 +00001429 Context.getTargetInfo().getCharAlign()));
Eli Friedman2782dac2013-06-26 20:50:34 +00001430 UnfilledBitsInLastUnit = getDataSizeInBits() - NewSizeInBits;
Anders Carlsson57235162010-04-16 15:57:11 +00001431 }
1432
1433 // Place this field at the current location.
1434 FieldOffsets.push_back(FieldOffset);
1435
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001436 CheckFieldPadding(FieldOffset, UnpaddedFieldOffset, FieldOffset,
Ken Dyckdbe37f32011-03-01 01:36:00 +00001437 Context.toBits(TypeAlign), FieldPacked, D);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001438
Anders Carlsson57235162010-04-16 15:57:11 +00001439 // Update the size.
Ken Dyckecfc7552011-02-24 01:13:28 +00001440 setSize(std::max(getSizeInBits(), getDataSizeInBits()));
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001441
Anders Carlsson57235162010-04-16 15:57:11 +00001442 // Remember max struct/class alignment.
Ken Dyckdbe37f32011-03-01 01:36:00 +00001443 UpdateAlignment(TypeAlign);
Anders Carlsson57235162010-04-16 15:57:11 +00001444}
1445
Anders Carlssonc2226202010-05-26 05:58:59 +00001446void RecordLayoutBuilder::LayoutBitField(const FieldDecl *D) {
Anders Carlsson07209442009-11-22 17:37:31 +00001447 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Richard Smithcaf33902011-10-10 18:28:20 +00001448 uint64_t FieldSize = D->getBitWidthValue(Context);
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001449 std::pair<uint64_t, unsigned> FieldInfo = Context.getTypeInfo(D->getType());
Anders Carlsson07209442009-11-22 17:37:31 +00001450 uint64_t TypeSize = FieldInfo.first;
1451 unsigned FieldAlign = FieldInfo.second;
Eli Friedman2782dac2013-06-26 20:50:34 +00001452
1453 if (IsMsStruct) {
1454 // The field alignment for integer types in ms_struct structs is
1455 // always the size.
Fariborz Jahanian7adbed62011-05-09 22:03:17 +00001456 FieldAlign = TypeSize;
Eli Friedman2782dac2013-06-26 20:50:34 +00001457 // Ignore zero-length bitfields after non-bitfields in ms_struct structs.
1458 if (!FieldSize && !LastBitfieldTypeSize)
1459 FieldAlign = 1;
1460 // If a bitfield is followed by a bitfield of a different size, don't
1461 // pack the bits together in ms_struct structs.
1462 if (LastBitfieldTypeSize != TypeSize) {
1463 UnfilledBitsInLastUnit = 0;
1464 LastBitfieldTypeSize = 0;
1465 }
1466 }
1467
1468 uint64_t UnpaddedFieldOffset = getDataSizeInBits() - UnfilledBitsInLastUnit;
1469 uint64_t FieldOffset = IsUnion ? 0 : UnpaddedFieldOffset;
Chad Rosier18903ee2011-08-04 01:21:14 +00001470
Eli Friedman481673f2013-06-26 23:47:39 +00001471 bool ZeroLengthBitfield = false;
1472 if (!Context.getTargetInfo().useBitFieldTypeAlignment() &&
1473 Context.getTargetInfo().useZeroLengthBitfieldAlignment() &&
1474 FieldSize == 0) {
Eli Friedman2782dac2013-06-26 20:50:34 +00001475 // The alignment of a zero-length bitfield affects the alignment
1476 // of the next member. The alignment is the max of the zero
1477 // length bitfield's alignment and a target specific fixed value.
Eli Friedman481673f2013-06-26 23:47:39 +00001478 ZeroLengthBitfield = true;
Eli Friedman2782dac2013-06-26 20:50:34 +00001479 unsigned ZeroLengthBitfieldBoundary =
1480 Context.getTargetInfo().getZeroLengthBitfieldBoundary();
1481 if (ZeroLengthBitfieldBoundary > FieldAlign)
1482 FieldAlign = ZeroLengthBitfieldBoundary;
Fariborz Jahanianfc0fe6e2011-05-03 20:21:04 +00001483 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001484
Anders Carlsson57235162010-04-16 15:57:11 +00001485 if (FieldSize > TypeSize) {
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001486 LayoutWideBitField(FieldSize, TypeSize, FieldPacked, D);
Anders Carlsson57235162010-04-16 15:57:11 +00001487 return;
1488 }
1489
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001490 // The align if the field is not packed. This is to check if the attribute
1491 // was unnecessary (-Wpacked).
1492 unsigned UnpackedFieldAlign = FieldAlign;
1493 uint64_t UnpackedFieldOffset = FieldOffset;
Douglas Gregore8bbc122011-09-02 00:18:52 +00001494 if (!Context.getTargetInfo().useBitFieldTypeAlignment() && !ZeroLengthBitfield)
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001495 UnpackedFieldAlign = 1;
1496
Chad Rosiere1a6a0e2011-08-05 22:38:04 +00001497 if (FieldPacked ||
Douglas Gregore8bbc122011-09-02 00:18:52 +00001498 (!Context.getTargetInfo().useBitFieldTypeAlignment() && !ZeroLengthBitfield))
Anders Carlsson07209442009-11-22 17:37:31 +00001499 FieldAlign = 1;
Alexis Huntdcfba7b2010-08-18 23:23:40 +00001500 FieldAlign = std::max(FieldAlign, D->getMaxAlignment());
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001501 UnpackedFieldAlign = std::max(UnpackedFieldAlign, D->getMaxAlignment());
Anders Carlsson07209442009-11-22 17:37:31 +00001502
1503 // The maximum field alignment overrides the aligned attribute.
Eli Friedmana91d38a2011-12-02 02:38:48 +00001504 if (!MaxFieldAlignment.isZero() && FieldSize != 0) {
Ken Dyck02ced6f2011-02-17 01:49:42 +00001505 unsigned MaxFieldAlignmentInBits = Context.toBits(MaxFieldAlignment);
1506 FieldAlign = std::min(FieldAlign, MaxFieldAlignmentInBits);
1507 UnpackedFieldAlign = std::min(UnpackedFieldAlign, MaxFieldAlignmentInBits);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001508 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001509
Eli Friedman2782dac2013-06-26 20:50:34 +00001510 // ms_struct bitfields always have to start at a round alignment.
1511 if (IsMsStruct && !LastBitfieldTypeSize) {
1512 FieldOffset = llvm::RoundUpToAlignment(FieldOffset, FieldAlign);
1513 UnpackedFieldOffset = llvm::RoundUpToAlignment(UnpackedFieldOffset,
1514 UnpackedFieldAlign);
1515 }
1516
Douglas Gregor44ba7892012-01-28 00:53:29 +00001517 // Check if we need to add padding to give the field the correct alignment.
1518 if (FieldSize == 0 ||
1519 (MaxFieldAlignment.isZero() &&
1520 (FieldOffset & (FieldAlign-1)) + FieldSize > TypeSize))
1521 FieldOffset = llvm::RoundUpToAlignment(FieldOffset, FieldAlign);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001522
Douglas Gregor44ba7892012-01-28 00:53:29 +00001523 if (FieldSize == 0 ||
1524 (MaxFieldAlignment.isZero() &&
1525 (UnpackedFieldOffset & (UnpackedFieldAlign-1)) + FieldSize > TypeSize))
1526 UnpackedFieldOffset = llvm::RoundUpToAlignment(UnpackedFieldOffset,
1527 UnpackedFieldAlign);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001528
Chad Rosiere1a6a0e2011-08-05 22:38:04 +00001529 // Padding members don't affect overall alignment, unless zero length bitfield
1530 // alignment is enabled.
Eli Friedman2782dac2013-06-26 20:50:34 +00001531 if (!D->getIdentifier() &&
1532 !Context.getTargetInfo().useZeroLengthBitfieldAlignment() &&
1533 !IsMsStruct)
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001534 FieldAlign = UnpackedFieldAlign = 1;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001535
Douglas Gregor44ba7892012-01-28 00:53:29 +00001536 if (ExternalLayout)
1537 FieldOffset = updateExternalFieldOffset(D, FieldOffset);
1538
Anders Carlsson07209442009-11-22 17:37:31 +00001539 // Place this field at the current location.
1540 FieldOffsets.push_back(FieldOffset);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001541
Douglas Gregore9fc3772012-01-26 07:55:45 +00001542 if (!ExternalLayout)
1543 CheckFieldPadding(FieldOffset, UnpaddedFieldOffset, UnpackedFieldOffset,
1544 UnpackedFieldAlign, FieldPacked, D);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001545
Anders Carlssonba958402009-11-22 19:13:51 +00001546 // Update DataSize to include the last byte containing (part of) the bitfield.
1547 if (IsUnion) {
1548 // FIXME: I think FieldSize should be TypeSize here.
Ken Dyckecfc7552011-02-24 01:13:28 +00001549 setDataSize(std::max(getDataSizeInBits(), FieldSize));
Anders Carlssonba958402009-11-22 19:13:51 +00001550 } else {
Eli Friedman2782dac2013-06-26 20:50:34 +00001551 if (IsMsStruct && FieldSize) {
1552 // Under ms_struct, a bitfield always takes up space equal to the size
1553 // of the type. We can't just change the alignment computation on the
1554 // other codepath because of the way this interacts with #pragma pack:
1555 // in a packed struct, we need to allocate misaligned space in the
1556 // struct to hold the bitfield.
1557 if (!UnfilledBitsInLastUnit) {
1558 setDataSize(FieldOffset + TypeSize);
1559 UnfilledBitsInLastUnit = TypeSize - FieldSize;
1560 } else if (UnfilledBitsInLastUnit < FieldSize) {
1561 setDataSize(getDataSizeInBits() + TypeSize);
1562 UnfilledBitsInLastUnit = TypeSize - FieldSize;
1563 } else {
1564 UnfilledBitsInLastUnit -= FieldSize;
1565 }
1566 LastBitfieldTypeSize = TypeSize;
1567 } else {
1568 uint64_t NewSizeInBits = FieldOffset + FieldSize;
1569 uint64_t BitfieldAlignment = Context.getTargetInfo().getCharAlign();
1570 setDataSize(llvm::RoundUpToAlignment(NewSizeInBits, BitfieldAlignment));
1571 UnfilledBitsInLastUnit = getDataSizeInBits() - NewSizeInBits;
1572 LastBitfieldTypeSize = 0;
1573 }
Anders Carlssonba958402009-11-22 19:13:51 +00001574 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001575
Anders Carlssonba958402009-11-22 19:13:51 +00001576 // Update the size.
Ken Dyckecfc7552011-02-24 01:13:28 +00001577 setSize(std::max(getSizeInBits(), getDataSizeInBits()));
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001578
Anders Carlsson07209442009-11-22 17:37:31 +00001579 // Remember max struct/class alignment.
Ken Dyck85ef0432011-02-19 18:58:07 +00001580 UpdateAlignment(Context.toCharUnitsFromBits(FieldAlign),
1581 Context.toCharUnitsFromBits(UnpackedFieldAlign));
Anders Carlsson07209442009-11-22 17:37:31 +00001582}
1583
Douglas Gregore9fc3772012-01-26 07:55:45 +00001584void RecordLayoutBuilder::LayoutField(const FieldDecl *D) {
Anders Carlsson07209442009-11-22 17:37:31 +00001585 if (D->isBitField()) {
1586 LayoutBitField(D);
1587 return;
1588 }
1589
Eli Friedman2782dac2013-06-26 20:50:34 +00001590 uint64_t UnpaddedFieldOffset = getDataSizeInBits() - UnfilledBitsInLastUnit;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001591
Anders Carlssonba958402009-11-22 19:13:51 +00001592 // Reset the unfilled bits.
Eli Friedman2782dac2013-06-26 20:50:34 +00001593 UnfilledBitsInLastUnit = 0;
1594 LastBitfieldTypeSize = 0;
Anders Carlssonba958402009-11-22 19:13:51 +00001595
Anders Carlsson07209442009-11-22 17:37:31 +00001596 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Ken Dyck6d90e892011-02-20 02:06:09 +00001597 CharUnits FieldOffset =
Ken Dyckecfc7552011-02-24 01:13:28 +00001598 IsUnion ? CharUnits::Zero() : getDataSize();
Ken Dyck6d90e892011-02-20 02:06:09 +00001599 CharUnits FieldSize;
1600 CharUnits FieldAlign;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001601
Anders Carlsson07209442009-11-22 17:37:31 +00001602 if (D->getType()->isIncompleteArrayType()) {
1603 // This is a flexible array member; we can't directly
1604 // query getTypeInfo about these, so we figure it out here.
1605 // Flexible array members don't have any size, but they
1606 // have to be aligned appropriately for their element type.
Ken Dyck6d90e892011-02-20 02:06:09 +00001607 FieldSize = CharUnits::Zero();
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001608 const ArrayType* ATy = Context.getAsArrayType(D->getType());
Ken Dyck6d90e892011-02-20 02:06:09 +00001609 FieldAlign = Context.getTypeAlignInChars(ATy->getElementType());
Anders Carlsson07209442009-11-22 17:37:31 +00001610 } else if (const ReferenceType *RT = D->getType()->getAs<ReferenceType>()) {
1611 unsigned AS = RT->getPointeeType().getAddressSpace();
Ken Dyck6d90e892011-02-20 02:06:09 +00001612 FieldSize =
Douglas Gregore8bbc122011-09-02 00:18:52 +00001613 Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerWidth(AS));
Ken Dyck6d90e892011-02-20 02:06:09 +00001614 FieldAlign =
Douglas Gregore8bbc122011-09-02 00:18:52 +00001615 Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerAlign(AS));
Anders Carlsson79474332009-07-18 20:20:21 +00001616 } else {
Ken Dyck6d90e892011-02-20 02:06:09 +00001617 std::pair<CharUnits, CharUnits> FieldInfo =
1618 Context.getTypeInfoInChars(D->getType());
Anders Carlsson07209442009-11-22 17:37:31 +00001619 FieldSize = FieldInfo.first;
1620 FieldAlign = FieldInfo.second;
Chad Rosier18903ee2011-08-04 01:21:14 +00001621
Eli Friedman9ee2d0472012-10-12 23:29:20 +00001622 if (IsMsStruct) {
Douglas Gregordbe39272011-02-01 15:15:22 +00001623 // If MS bitfield layout is required, figure out what type is being
1624 // laid out and align the field to the width of that type.
1625
1626 // Resolve all typedefs down to their base type and round up the field
1627 // alignment if necessary.
1628 QualType T = Context.getBaseElementType(D->getType());
1629 if (const BuiltinType *BTy = T->getAs<BuiltinType>()) {
Ken Dyck6d90e892011-02-20 02:06:09 +00001630 CharUnits TypeSize = Context.getTypeSizeInChars(BTy);
Douglas Gregordbe39272011-02-01 15:15:22 +00001631 if (TypeSize > FieldAlign)
1632 FieldAlign = TypeSize;
1633 }
1634 }
Anders Carlsson79474332009-07-18 20:20:21 +00001635 }
Mike Stump11289f42009-09-09 15:08:12 +00001636
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001637 // The align if the field is not packed. This is to check if the attribute
1638 // was unnecessary (-Wpacked).
Ken Dyck6d90e892011-02-20 02:06:09 +00001639 CharUnits UnpackedFieldAlign = FieldAlign;
1640 CharUnits UnpackedFieldOffset = FieldOffset;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001641
Anders Carlsson07209442009-11-22 17:37:31 +00001642 if (FieldPacked)
Ken Dyck6d90e892011-02-20 02:06:09 +00001643 FieldAlign = CharUnits::One();
1644 CharUnits MaxAlignmentInChars =
1645 Context.toCharUnitsFromBits(D->getMaxAlignment());
1646 FieldAlign = std::max(FieldAlign, MaxAlignmentInChars);
1647 UnpackedFieldAlign = std::max(UnpackedFieldAlign, MaxAlignmentInChars);
Anders Carlsson07209442009-11-22 17:37:31 +00001648
1649 // The maximum field alignment overrides the aligned attribute.
Ken Dyck02ced6f2011-02-17 01:49:42 +00001650 if (!MaxFieldAlignment.isZero()) {
Ken Dyck6d90e892011-02-20 02:06:09 +00001651 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
1652 UnpackedFieldAlign = std::min(UnpackedFieldAlign, MaxFieldAlignment);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001653 }
Anders Carlsson07209442009-11-22 17:37:31 +00001654
Douglas Gregor44ba7892012-01-28 00:53:29 +00001655 // Round up the current record size to the field's alignment boundary.
1656 FieldOffset = FieldOffset.RoundUpToAlignment(FieldAlign);
1657 UnpackedFieldOffset =
1658 UnpackedFieldOffset.RoundUpToAlignment(UnpackedFieldAlign);
1659
1660 if (ExternalLayout) {
1661 FieldOffset = Context.toCharUnitsFromBits(
1662 updateExternalFieldOffset(D, Context.toBits(FieldOffset)));
1663
1664 if (!IsUnion && EmptySubobjects) {
1665 // Record the fact that we're placing a field at this offset.
1666 bool Allowed = EmptySubobjects->CanPlaceFieldAtOffset(D, FieldOffset);
1667 (void)Allowed;
1668 assert(Allowed && "Externally-placed field cannot be placed here");
1669 }
1670 } else {
Douglas Gregore9fc3772012-01-26 07:55:45 +00001671 if (!IsUnion && EmptySubobjects) {
1672 // Check if we can place the field at this offset.
1673 while (!EmptySubobjects->CanPlaceFieldAtOffset(D, FieldOffset)) {
1674 // We couldn't place the field at the offset. Try again at a new offset.
1675 FieldOffset += FieldAlign;
1676 }
Anders Carlsson07209442009-11-22 17:37:31 +00001677 }
Anders Carlsson07209442009-11-22 17:37:31 +00001678 }
Douglas Gregore9fc3772012-01-26 07:55:45 +00001679
Anders Carlsson79474332009-07-18 20:20:21 +00001680 // Place this field at the current location.
Ken Dyck6d90e892011-02-20 02:06:09 +00001681 FieldOffsets.push_back(Context.toBits(FieldOffset));
Mike Stump11289f42009-09-09 15:08:12 +00001682
Douglas Gregore9fc3772012-01-26 07:55:45 +00001683 if (!ExternalLayout)
1684 CheckFieldPadding(Context.toBits(FieldOffset), UnpaddedFieldOffset,
1685 Context.toBits(UnpackedFieldOffset),
1686 Context.toBits(UnpackedFieldAlign), FieldPacked, D);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001687
Anders Carlsson79474332009-07-18 20:20:21 +00001688 // Reserve space for this field.
Eli Friedman43f18342012-01-12 23:27:03 +00001689 uint64_t FieldSizeInBits = Context.toBits(FieldSize);
Anders Carlsson79474332009-07-18 20:20:21 +00001690 if (IsUnion)
Eli Friedman2e108372012-01-12 23:48:56 +00001691 setDataSize(std::max(getDataSizeInBits(), FieldSizeInBits));
Anders Carlsson79474332009-07-18 20:20:21 +00001692 else
Eli Friedman2e108372012-01-12 23:48:56 +00001693 setDataSize(FieldOffset + FieldSize);
Mike Stump11289f42009-09-09 15:08:12 +00001694
Eli Friedman2e108372012-01-12 23:48:56 +00001695 // Update the size.
1696 setSize(std::max(getSizeInBits(), getDataSizeInBits()));
Mike Stump11289f42009-09-09 15:08:12 +00001697
Anders Carlsson79474332009-07-18 20:20:21 +00001698 // Remember max struct/class alignment.
Ken Dyck6d90e892011-02-20 02:06:09 +00001699 UpdateAlignment(FieldAlign, UnpackedFieldAlign);
Anders Carlsson79474332009-07-18 20:20:21 +00001700}
1701
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001702void RecordLayoutBuilder::FinishLayout(const NamedDecl *D) {
Anders Carlsson79474332009-07-18 20:20:21 +00001703 // In C++, records cannot be of size 0.
David Blaikiebbafb8a2012-03-11 07:00:24 +00001704 if (Context.getLangOpts().CPlusPlus && getSizeInBits() == 0) {
Fariborz Jahanian09b23312011-02-02 19:36:18 +00001705 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
1706 // Compatibility with gcc requires a class (pod or non-pod)
1707 // which is not empty but of size 0; such as having fields of
1708 // array of zero-length, remains of Size 0
1709 if (RD->isEmpty())
Ken Dyck1b4420e2011-02-28 02:01:38 +00001710 setSize(CharUnits::One());
Fariborz Jahanian09b23312011-02-02 19:36:18 +00001711 }
1712 else
Ken Dyck1b4420e2011-02-28 02:01:38 +00001713 setSize(CharUnits::One());
Fariborz Jahanian09b23312011-02-02 19:36:18 +00001714 }
Eli Friedman83a12582011-12-01 00:37:01 +00001715
Douglas Gregor1423a5c2012-10-26 22:31:14 +00001716 // Finally, round the size of the record up to the alignment of the
1717 // record itself.
Eli Friedman2782dac2013-06-26 20:50:34 +00001718 uint64_t UnpaddedSize = getSizeInBits() - UnfilledBitsInLastUnit;
Douglas Gregor1423a5c2012-10-26 22:31:14 +00001719 uint64_t UnpackedSizeInBits =
1720 llvm::RoundUpToAlignment(getSizeInBits(),
1721 Context.toBits(UnpackedAlignment));
1722 CharUnits UnpackedSize = Context.toCharUnitsFromBits(UnpackedSizeInBits);
1723 uint64_t RoundedSize
1724 = llvm::RoundUpToAlignment(getSizeInBits(), Context.toBits(Alignment));
1725
1726 if (ExternalLayout) {
1727 // If we're inferring alignment, and the external size is smaller than
1728 // our size after we've rounded up to alignment, conservatively set the
1729 // alignment to 1.
1730 if (InferAlignment && ExternalSize < RoundedSize) {
1731 Alignment = CharUnits::One();
1732 InferAlignment = false;
1733 }
1734 setSize(ExternalSize);
1735 return;
1736 }
1737
Douglas Gregor1423a5c2012-10-26 22:31:14 +00001738 // Set the size to the final size.
1739 setSize(RoundedSize);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001740
Douglas Gregore8bbc122011-09-02 00:18:52 +00001741 unsigned CharBitNum = Context.getTargetInfo().getCharWidth();
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001742 if (const RecordDecl *RD = dyn_cast<RecordDecl>(D)) {
1743 // Warn if padding was introduced to the struct/class/union.
Ken Dyckecfc7552011-02-24 01:13:28 +00001744 if (getSizeInBits() > UnpaddedSize) {
1745 unsigned PadSize = getSizeInBits() - UnpaddedSize;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001746 bool InBits = true;
1747 if (PadSize % CharBitNum == 0) {
1748 PadSize = PadSize / CharBitNum;
1749 InBits = false;
1750 }
1751 Diag(RD->getLocation(), diag::warn_padded_struct_size)
1752 << Context.getTypeDeclType(RD)
1753 << PadSize
1754 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1); // plural or not
1755 }
1756
1757 // Warn if we packed it unnecessarily. If the alignment is 1 byte don't
1758 // bother since there won't be alignment issues.
Ken Dyckecfc7552011-02-24 01:13:28 +00001759 if (Packed && UnpackedAlignment > CharUnits::One() &&
Ken Dyck1b4420e2011-02-28 02:01:38 +00001760 getSize() == UnpackedSize)
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001761 Diag(D->getLocation(), diag::warn_unnecessary_packed)
1762 << Context.getTypeDeclType(RD);
1763 }
Anders Carlsson79474332009-07-18 20:20:21 +00001764}
1765
Ken Dyck85ef0432011-02-19 18:58:07 +00001766void RecordLayoutBuilder::UpdateAlignment(CharUnits NewAlignment,
1767 CharUnits UnpackedNewAlignment) {
Douglas Gregore9fc3772012-01-26 07:55:45 +00001768 // The alignment is not modified when using 'mac68k' alignment or when
Douglas Gregor44ba7892012-01-28 00:53:29 +00001769 // we have an externally-supplied layout that also provides overall alignment.
1770 if (IsMac68kAlign || (ExternalLayout && !InferAlignment))
Daniel Dunbar6da10982010-05-27 05:45:51 +00001771 return;
1772
Ken Dyck85ef0432011-02-19 18:58:07 +00001773 if (NewAlignment > Alignment) {
1774 assert(llvm::isPowerOf2_32(NewAlignment.getQuantity() &&
1775 "Alignment not a power of 2"));
1776 Alignment = NewAlignment;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001777 }
1778
Ken Dyck85ef0432011-02-19 18:58:07 +00001779 if (UnpackedNewAlignment > UnpackedAlignment) {
1780 assert(llvm::isPowerOf2_32(UnpackedNewAlignment.getQuantity() &&
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001781 "Alignment not a power of 2"));
Ken Dyck85ef0432011-02-19 18:58:07 +00001782 UnpackedAlignment = UnpackedNewAlignment;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001783 }
1784}
1785
Douglas Gregor44ba7892012-01-28 00:53:29 +00001786uint64_t
1787RecordLayoutBuilder::updateExternalFieldOffset(const FieldDecl *Field,
1788 uint64_t ComputedOffset) {
1789 assert(ExternalFieldOffsets.find(Field) != ExternalFieldOffsets.end() &&
1790 "Field does not have an external offset");
1791
1792 uint64_t ExternalFieldOffset = ExternalFieldOffsets[Field];
1793
1794 if (InferAlignment && ExternalFieldOffset < ComputedOffset) {
1795 // The externally-supplied field offset is before the field offset we
1796 // computed. Assume that the structure is packed.
Douglas Gregor1423a5c2012-10-26 22:31:14 +00001797 Alignment = CharUnits::One();
Douglas Gregor44ba7892012-01-28 00:53:29 +00001798 InferAlignment = false;
1799 }
1800
1801 // Use the externally-supplied field offset.
Benjamin Kramer648e68b2012-08-31 22:14:25 +00001802 return ExternalFieldOffset;
1803}
1804
1805/// \brief Get diagnostic %select index for tag kind for
1806/// field padding diagnostic message.
1807/// WARNING: Indexes apply to particular diagnostics only!
1808///
1809/// \returns diagnostic %select index.
1810static unsigned getPaddingDiagFromTagKind(TagTypeKind Tag) {
1811 switch (Tag) {
1812 case TTK_Struct: return 0;
1813 case TTK_Interface: return 1;
1814 case TTK_Class: return 2;
1815 default: llvm_unreachable("Invalid tag kind for field padding diagnostic!");
1816 }
1817}
1818
1819void RecordLayoutBuilder::CheckFieldPadding(uint64_t Offset,
1820 uint64_t UnpaddedOffset,
1821 uint64_t UnpackedOffset,
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001822 unsigned UnpackedAlign,
1823 bool isPacked,
1824 const FieldDecl *D) {
1825 // We let objc ivars without warning, objc interfaces generally are not used
1826 // for padding tricks.
1827 if (isa<ObjCIvarDecl>(D))
Anders Carlsson79474332009-07-18 20:20:21 +00001828 return;
Mike Stump11289f42009-09-09 15:08:12 +00001829
Ted Kremenekfed48af2011-09-06 19:40:45 +00001830 // Don't warn about structs created without a SourceLocation. This can
1831 // be done by clients of the AST, such as codegen.
1832 if (D->getLocation().isInvalid())
1833 return;
1834
Douglas Gregore8bbc122011-09-02 00:18:52 +00001835 unsigned CharBitNum = Context.getTargetInfo().getCharWidth();
Mike Stump11289f42009-09-09 15:08:12 +00001836
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001837 // Warn if padding was introduced to the struct/class.
1838 if (!IsUnion && Offset > UnpaddedOffset) {
1839 unsigned PadSize = Offset - UnpaddedOffset;
1840 bool InBits = true;
1841 if (PadSize % CharBitNum == 0) {
1842 PadSize = PadSize / CharBitNum;
1843 InBits = false;
Benjamin Kramer648e68b2012-08-31 22:14:25 +00001844 }
1845 if (D->getIdentifier())
1846 Diag(D->getLocation(), diag::warn_padded_struct_field)
1847 << getPaddingDiagFromTagKind(D->getParent()->getTagKind())
1848 << Context.getTypeDeclType(D->getParent())
1849 << PadSize
1850 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1) // plural or not
1851 << D->getIdentifier();
1852 else
1853 Diag(D->getLocation(), diag::warn_padded_struct_anon_field)
1854 << getPaddingDiagFromTagKind(D->getParent()->getTagKind())
1855 << Context.getTypeDeclType(D->getParent())
1856 << PadSize
1857 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1); // plural or not
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001858 }
1859
1860 // Warn if we packed it unnecessarily. If the alignment is 1 byte don't
1861 // bother since there won't be alignment issues.
1862 if (isPacked && UnpackedAlign > CharBitNum && Offset == UnpackedOffset)
1863 Diag(D->getLocation(), diag::warn_unnecessary_packed)
1864 << D->getIdentifier();
Anders Carlsson79474332009-07-18 20:20:21 +00001865}
Mike Stump11289f42009-09-09 15:08:12 +00001866
John McCall6bd2a892013-01-25 22:31:03 +00001867static const CXXMethodDecl *computeKeyFunction(ASTContext &Context,
1868 const CXXRecordDecl *RD) {
Daniel Dunbarccabe482010-04-19 20:44:53 +00001869 // If a class isn't polymorphic it doesn't have a key function.
Anders Carlsson5ebf8b42009-12-07 04:35:11 +00001870 if (!RD->isPolymorphic())
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001871 return 0;
Eli Friedmanf2c79b62009-12-08 03:56:49 +00001872
Eli Friedman300f55d2011-06-10 21:53:06 +00001873 // A class that is not externally visible doesn't have a key function. (Or
Eli Friedmanf2c79b62009-12-08 03:56:49 +00001874 // at least, there's no point to assigning a key function to such a class;
1875 // this doesn't affect the ABI.)
Rafael Espindola3ae00052013-05-13 00:12:11 +00001876 if (!RD->isExternallyVisible())
Eli Friedmanf2c79b62009-12-08 03:56:49 +00001877 return 0;
1878
Argyrios Kyrtzidis8c64bbe2010-10-13 02:39:41 +00001879 // Template instantiations don't have key functions,see Itanium C++ ABI 5.2.6.
1880 // Same behavior as GCC.
1881 TemplateSpecializationKind TSK = RD->getTemplateSpecializationKind();
1882 if (TSK == TSK_ImplicitInstantiation ||
1883 TSK == TSK_ExplicitInstantiationDefinition)
1884 return 0;
1885
John McCall6bd2a892013-01-25 22:31:03 +00001886 bool allowInlineFunctions =
1887 Context.getTargetInfo().getCXXABI().canKeyFunctionBeInline();
1888
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001889 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
1890 E = RD->method_end(); I != E; ++I) {
David Blaikie40ed2972012-06-06 20:45:41 +00001891 const CXXMethodDecl *MD = *I;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001892
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001893 if (!MD->isVirtual())
1894 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001895
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001896 if (MD->isPure())
1897 continue;
Eli Friedmanf2c79b62009-12-08 03:56:49 +00001898
Anders Carlssonf98849e2009-12-02 17:15:43 +00001899 // Ignore implicit member functions, they are always marked as inline, but
1900 // they don't have a body until they're defined.
1901 if (MD->isImplicit())
1902 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001903
Douglas Gregora318efd2010-01-05 19:06:31 +00001904 if (MD->isInlineSpecified())
1905 continue;
Eli Friedman71a26d82009-12-06 20:50:05 +00001906
1907 if (MD->hasInlineBody())
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001908 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001909
Benjamin Kramer4a902082012-08-03 15:43:22 +00001910 // Ignore inline deleted or defaulted functions.
Benjamin Kramer73d1be72012-08-03 08:39:58 +00001911 if (!MD->isUserProvided())
1912 continue;
1913
John McCall6bd2a892013-01-25 22:31:03 +00001914 // In certain ABIs, ignore functions with out-of-line inline definitions.
1915 if (!allowInlineFunctions) {
1916 const FunctionDecl *Def;
1917 if (MD->hasBody(Def) && Def->isInlineSpecified())
1918 continue;
1919 }
1920
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001921 // We found it.
1922 return MD;
1923 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001924
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001925 return 0;
1926}
1927
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001928DiagnosticBuilder
1929RecordLayoutBuilder::Diag(SourceLocation Loc, unsigned DiagID) {
Argyrios Kyrtzidisd0040642010-11-18 20:06:41 +00001930 return Context.getDiagnostics().Report(Loc, DiagID);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001931}
1932
John McCall5c1f1d02013-01-29 01:14:22 +00001933/// Does the target C++ ABI require us to skip over the tail-padding
1934/// of the given class (considering it as a base class) when allocating
1935/// objects?
1936static bool mustSkipTailPadding(TargetCXXABI ABI, const CXXRecordDecl *RD) {
1937 switch (ABI.getTailPaddingUseRules()) {
1938 case TargetCXXABI::AlwaysUseTailPadding:
1939 return false;
1940
1941 case TargetCXXABI::UseTailPaddingUnlessPOD03:
1942 // FIXME: To the extent that this is meant to cover the Itanium ABI
1943 // rules, we should implement the restrictions about over-sized
1944 // bitfields:
1945 //
1946 // http://mentorembedded.github.com/cxx-abi/abi.html#POD :
1947 // In general, a type is considered a POD for the purposes of
1948 // layout if it is a POD type (in the sense of ISO C++
1949 // [basic.types]). However, a POD-struct or POD-union (in the
1950 // sense of ISO C++ [class]) with a bitfield member whose
1951 // declared width is wider than the declared type of the
1952 // bitfield is not a POD for the purpose of layout. Similarly,
1953 // an array type is not a POD for the purpose of layout if the
1954 // element type of the array is not a POD for the purpose of
1955 // layout.
1956 //
1957 // Where references to the ISO C++ are made in this paragraph,
1958 // the Technical Corrigendum 1 version of the standard is
1959 // intended.
1960 return RD->isPOD();
1961
1962 case TargetCXXABI::UseTailPaddingUnlessPOD11:
1963 // This is equivalent to RD->getTypeForDecl().isCXX11PODType(),
1964 // but with a lot of abstraction penalty stripped off. This does
1965 // assume that these properties are set correctly even in C++98
1966 // mode; fortunately, that is true because we want to assign
1967 // consistently semantics to the type-traits intrinsics (or at
1968 // least as many of them as possible).
1969 return RD->isTrivial() && RD->isStandardLayout();
1970 }
1971
1972 llvm_unreachable("bad tail-padding use kind");
1973}
1974
Warren Hunt8f8bad72013-10-11 20:19:00 +00001975static bool isMsLayout(const RecordDecl* D) {
Warren Hunt55d8e822013-10-23 23:53:07 +00001976 return D->getASTContext().getTargetInfo().getCXXABI().isMicrosoft();
Warren Hunt8f8bad72013-10-11 20:19:00 +00001977}
1978
1979// This section contains an implementation of struct layout that is, up to the
1980// included tests, compatible with cl.exe (2012). The layout produced is
1981// significantly different than those produced by the Itanium ABI. Here we note
1982// the most important differences.
1983//
1984// * The alignment of bitfields in unions is ignored when computing the
1985// alignment of the union.
Alp Tokerf6a24ce2013-12-05 16:25:25 +00001986// * The existence of zero-width bitfield that occurs after anything other than
Warren Hunt8f8bad72013-10-11 20:19:00 +00001987// a non-zero length bitfield is ignored.
1988// * The Itanium equivalent vtable pointers are split into a vfptr (virtual
1989// function pointer) and a vbptr (virtual base pointer). They can each be
Warren Hunt55d8e822013-10-23 23:53:07 +00001990// shared with a, non-virtual bases. These bases need not be the same. vfptrs
1991// always occur at offset 0. vbptrs can occur at an
Warren Hunt8f8bad72013-10-11 20:19:00 +00001992// arbitrary offset and are placed after non-virtual bases but before fields.
1993// * Virtual bases sometimes require a 'vtordisp' field that is laid out before
1994// the virtual base and is used in conjunction with virtual overrides during
1995// construction and destruction.
1996// * vfptrs are allocated in a block of memory equal to the alignment of the
Warren Hunt55d8e822013-10-23 23:53:07 +00001997// fields and non-virtual bases at offset 0 in 32 bit mode and in a pointer
1998// sized block of memory in 64 bit mode.
Warren Hunt8f8bad72013-10-11 20:19:00 +00001999// * vbptrs are allocated in a block of memory equal to the alignment of the
Warren Hunt55d8e822013-10-23 23:53:07 +00002000// fields and non-virtual bases. This block is at a potentially unaligned
2001// offset. If the allocation slot is unaligned and the alignment is less than
2002// or equal to the pointer size, additional space is allocated so that the
2003// pointer can be aligned properly. This causes very strange effects on the
2004// placement of objects after the allocated block. (see the code).
Warren Hunt8f8bad72013-10-11 20:19:00 +00002005// * vtordisps are allocated in a block of memory with size and alignment equal
2006// to the alignment of the completed structure (before applying __declspec(
Warren Hunt55d8e822013-10-23 23:53:07 +00002007// align())). The vtordisp always occur at the end of the allocation block,
2008// immediately prior to the virtual base.
Warren Hunt8f8bad72013-10-11 20:19:00 +00002009// * The last zero sized non-virtual base is allocated after the placement of
2010// vbptr if one exists and can be placed at the end of the struct, potentially
2011// aliasing either the first member or another struct allocated after this
2012// one.
2013// * The last zero size virtual base may be placed at the end of the struct.
2014// and can potentially alias a zero sized type in the next struct.
Warren Hunt71140d62013-12-06 20:16:49 +00002015// * If the last field is a non-zero length bitfield, all virtual bases will
2016// have extra padding added before them for no obvious reason. The padding
2017// has the same number of bits as the type of the bitfield.
Warren Huntc0df47d2013-11-19 22:11:09 +00002018// * When laying out empty non-virtual bases, an extra byte of padding is added
2019// if the non-virtual base before the empty non-virtual base has a vbptr.
Warren Hunt049f6732013-12-06 19:54:25 +00002020// * The ABI attempts to avoid aliasing of zero sized bases by adding padding
2021// between bases or vbases with specific properties. The criteria for
2022// additional padding between two bases is that the first base is zero sized
2023// or has a zero sized subobject and the second base is zero sized or leads
2024// with a zero sized base (sharing of vfptrs can reorder the layout of the
2025// so the leading base is not always the first one declared). The padding
2026// added for bases is 1 byte. The padding added for vbases depends on the
2027// alignment of the object but is at least 4 bytes (in both 32 and 64 bit
2028// modes).
Warren Huntd640d7d2014-01-09 00:30:56 +00002029// * There is no concept of non-virtual alignment or any distinction between
2030// data size and non-virtual size.
Warren Huntf4518def2014-01-10 01:28:05 +00002031// * __declspec(align) on bitfields has the effect of changing the bitfield's
2032// alignment instead of its required alignment. This has implications on how
2033// it interacts with pragam pack.
Warren Hunt8f8bad72013-10-11 20:19:00 +00002034
2035namespace {
2036struct MicrosoftRecordLayoutBuilder {
Warren Huntd640d7d2014-01-09 00:30:56 +00002037 struct ElementInfo {
2038 CharUnits Size;
2039 CharUnits Alignment;
2040 };
Warren Hunt8f8bad72013-10-11 20:19:00 +00002041 typedef llvm::DenseMap<const CXXRecordDecl *, CharUnits> BaseOffsetsMapTy;
2042 MicrosoftRecordLayoutBuilder(const ASTContext &Context) : Context(Context) {}
2043private:
2044 MicrosoftRecordLayoutBuilder(const MicrosoftRecordLayoutBuilder &)
2045 LLVM_DELETED_FUNCTION;
2046 void operator=(const MicrosoftRecordLayoutBuilder &) LLVM_DELETED_FUNCTION;
2047public:
Warren Hunt8f8bad72013-10-11 20:19:00 +00002048 void layout(const RecordDecl *RD);
2049 void cxxLayout(const CXXRecordDecl *RD);
2050 /// \brief Initializes size and alignment and honors some flags.
2051 void initializeLayout(const RecordDecl *RD);
2052 /// \brief Initialized C++ layout, compute alignment and virtual alignment and
Alp Tokerf6a24ce2013-12-05 16:25:25 +00002053 /// existence of vfptrs and vbptrs. Alignment is needed before the vfptr is
Warren Hunt8f8bad72013-10-11 20:19:00 +00002054 /// laid out.
2055 void initializeCXXLayout(const CXXRecordDecl *RD);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002056 void layoutNonVirtualBases(const CXXRecordDecl *RD);
Warren Huntd640d7d2014-01-09 00:30:56 +00002057 void layoutNonVirtualBase(const CXXRecordDecl *BaseDecl,
2058 const ASTRecordLayout &BaseLayout,
2059 const ASTRecordLayout *&PreviousBaseLayout);
2060 void injectVFPtr(const CXXRecordDecl *RD);
2061 void injectVBPtr(const CXXRecordDecl *RD);
2062 void injectVPtrs(const CXXRecordDecl *RD);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002063 /// \brief Lays out the fields of the record. Also rounds size up to
2064 /// alignment.
2065 void layoutFields(const RecordDecl *RD);
2066 void layoutField(const FieldDecl *FD);
2067 void layoutBitField(const FieldDecl *FD);
2068 /// \brief Lays out a single zero-width bit-field in the record and handles
2069 /// special cases associated with zero-width bit-fields.
2070 void layoutZeroWidthBitField(const FieldDecl *FD);
2071 void layoutVirtualBases(const CXXRecordDecl *RD);
Warren Hunt1603e522013-12-10 01:44:39 +00002072 void finalizeLayout(const RecordDecl *RD);
Warren Huntd640d7d2014-01-09 00:30:56 +00002073 /// \brief Gets the size and alignment of a base taking pragma pack and
2074 /// __declspec(align) into account.
2075 ElementInfo getAdjustedElementInfo(const ASTRecordLayout &Layout);
2076 /// \brief Gets the size and alignment of a field taking pragma pack and
2077 /// __declspec(align) into account. It also updates RequiredAlignment as a
2078 /// side effect because it is most convenient to do so here.
2079 ElementInfo getAdjustedElementInfo(const FieldDecl *FD);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002080 /// \brief Places a field at an offset in CharUnits.
2081 void placeFieldAtOffset(CharUnits FieldOffset) {
2082 FieldOffsets.push_back(Context.toBits(FieldOffset));
2083 }
2084 /// \brief Places a bitfield at a bit offset.
2085 void placeFieldAtBitOffset(uint64_t FieldOffset) {
2086 FieldOffsets.push_back(FieldOffset);
2087 }
2088 /// \brief Compute the set of virtual bases for which vtordisps are required.
2089 llvm::SmallPtrSet<const CXXRecordDecl *, 2>
2090 computeVtorDispSet(const CXXRecordDecl *RD);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002091 const ASTContext &Context;
2092 /// \brief The size of the record being laid out.
2093 CharUnits Size;
Warren Huntd640d7d2014-01-09 00:30:56 +00002094 /// \brief The data alignment of the record layout.
2095 CharUnits DataSize;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002096 /// \brief The current alignment of the record layout.
2097 CharUnits Alignment;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002098 /// \brief The maximum allowed field alignment. This is set by #pragma pack.
2099 CharUnits MaxFieldAlignment;
Warren Hunt7b252d22013-12-06 00:01:17 +00002100 /// \brief The alignment that this record must obey. This is imposed by
2101 /// __declspec(align()) on the record itself or one of its fields or bases.
2102 CharUnits RequiredAlignment;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002103 /// \brief The size of the allocation of the currently active bitfield.
2104 /// This value isn't meaningful unless LastFieldIsNonZeroWidthBitfield
2105 /// is true.
2106 CharUnits CurrentBitfieldSize;
Warren Huntd640d7d2014-01-09 00:30:56 +00002107 /// \brief Offset to the virtual base table pointer (if one exists).
2108 CharUnits VBPtrOffset;
2109 /// \brief The size and alignment info of a pointer.
2110 ElementInfo PointerInfo;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002111 /// \brief The primary base class (if one exists).
2112 const CXXRecordDecl *PrimaryBase;
2113 /// \brief The class we share our vb-pointer with.
2114 const CXXRecordDecl *SharedVBPtrBase;
Warren Huntd640d7d2014-01-09 00:30:56 +00002115 /// \brief The collection of field offsets.
2116 SmallVector<uint64_t, 16> FieldOffsets;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002117 /// \brief Base classes and their offsets in the record.
2118 BaseOffsetsMapTy Bases;
2119 /// \brief virtual base classes and their offsets in the record.
2120 ASTRecordLayout::VBaseOffsetsMapTy VBases;
Warren Huntd640d7d2014-01-09 00:30:56 +00002121 /// \brief The number of remaining bits in our last bitfield allocation.
2122 /// This value isn't meaningful unless LastFieldIsNonZeroWidthBitfield is
2123 /// true.
2124 unsigned RemainingBitsInField;
2125 bool IsUnion : 1;
2126 /// \brief True if the last field laid out was a bitfield and was not 0
2127 /// width.
2128 bool LastFieldIsNonZeroWidthBitfield : 1;
2129 /// \brief True if the class has its own vftable pointer.
2130 bool HasOwnVFPtr : 1;
2131 /// \brief True if the class has a vbtable pointer.
2132 bool HasVBPtr : 1;
Warren Hunt55d8e822013-10-23 23:53:07 +00002133 /// \brief Lets us know if we're in 64-bit mode
Warren Hunt049f6732013-12-06 19:54:25 +00002134 bool Is64BitMode : 1;
2135 /// \brief True if this class contains a zero sized member or base or a base
2136 /// with a zero sized member or base. Only used for MS-ABI.
2137 bool HasZeroSizedSubObject : 1;
2138 /// \brief True if this class is zero sized or first base is zero sized or
2139 /// has this property. Only used for MS-ABI.
2140 bool LeadsWithZeroSizedBase : 1;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002141};
2142} // namespace
2143
Warren Huntd640d7d2014-01-09 00:30:56 +00002144MicrosoftRecordLayoutBuilder::ElementInfo
2145MicrosoftRecordLayoutBuilder::getAdjustedElementInfo(
2146 const ASTRecordLayout &Layout) {
2147 ElementInfo Info;
2148 Info.Alignment = Layout.getAlignment();
2149 // Respect pragma pack.
Warren Hunt7b252d22013-12-06 00:01:17 +00002150 if (!MaxFieldAlignment.isZero())
Warren Huntd640d7d2014-01-09 00:30:56 +00002151 Info.Alignment = std::min(Info.Alignment, MaxFieldAlignment);
2152 // Track zero-sized subobjects here where it's already available.
2153 if (Layout.hasZeroSizedSubObject())
2154 HasZeroSizedSubObject = true;
2155 // Respect required alignment, this is necessary because we may have adjusted
Warren Hunt94258912014-01-11 01:16:40 +00002156 // the alignment in the case of pragam pack. Note that the required alignment
2157 // doesn't actually apply to the struct alignment at this point.
2158 Alignment = std::max(Alignment, Info.Alignment);
Warren Huntd640d7d2014-01-09 00:30:56 +00002159 Info.Alignment = std::max(Info.Alignment, Layout.getRequiredAlignment());
Warren Hunt640015cb2014-01-09 23:51:31 +00002160 Info.Size = Layout.getDataSize();
Warren Huntd640d7d2014-01-09 00:30:56 +00002161 return Info;
Warren Hunt7b252d22013-12-06 00:01:17 +00002162}
2163
Warren Huntd640d7d2014-01-09 00:30:56 +00002164MicrosoftRecordLayoutBuilder::ElementInfo
2165MicrosoftRecordLayoutBuilder::getAdjustedElementInfo(
2166 const FieldDecl *FD) {
2167 ElementInfo Info;
Warren Huntf4518def2014-01-10 01:28:05 +00002168 // Respect align attributes.
2169 CharUnits FieldRequiredAlignment =
2170 Context.toCharUnitsFromBits(FD->getMaxAlignment());
Warren Hunt049f6732013-12-06 19:54:25 +00002171 // Respect attributes applied to subobjects of the field.
Warren Hunt7b252d22013-12-06 00:01:17 +00002172 if (const RecordType *RT =
2173 FD->getType()->getBaseElementTypeUnsafe()->getAs<RecordType>()) {
2174 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RT->getDecl());
Warren Huntd640d7d2014-01-09 00:30:56 +00002175 // Get the element info for a layout, respecting pack.
2176 Info = getAdjustedElementInfo(Layout);
2177 // Nomally getAdjustedElementInfo returns the non-virtual size, which is
2178 // correct for bases but not for fields.
2179 Info.Size = Layout.getSize();
2180 // Capture required alignment as a side-effect.
Warren Hunt7b252d22013-12-06 00:01:17 +00002181 RequiredAlignment = std::max(RequiredAlignment,
2182 Layout.getRequiredAlignment());
Warren Hunt7b252d22013-12-06 00:01:17 +00002183 }
Warren Huntd640d7d2014-01-09 00:30:56 +00002184 else {
2185 std::pair<CharUnits, CharUnits> FieldInfo =
2186 Context.getTypeInfoInChars(FD->getType());
2187 Info.Size = FieldInfo.first;
2188 Info.Alignment = FieldInfo.second;
Warren Huntf4518def2014-01-10 01:28:05 +00002189 if (FD->isBitField() && FD->getMaxAlignment() != 0)
2190 Info.Alignment = std::max(Info.Alignment, FieldRequiredAlignment);
Warren Huntd640d7d2014-01-09 00:30:56 +00002191 // Respect pragma pack.
2192 if (!MaxFieldAlignment.isZero())
2193 Info.Alignment = std::min(Info.Alignment, MaxFieldAlignment);
2194 }
2195 // Respect packed field attribute.
2196 if (FD->hasAttr<PackedAttr>())
2197 Info.Alignment = CharUnits::One();
Warren Huntf4518def2014-01-10 01:28:05 +00002198 // Take required alignment into account. __declspec(align) on bitfields
2199 // impacts the alignment rather than the required alignment.
2200 if (!FD->isBitField()) {
2201 Info.Alignment = std::max(Info.Alignment, FieldRequiredAlignment);
2202 // Capture required alignment as a side-effect.
2203 RequiredAlignment = std::max(RequiredAlignment, FieldRequiredAlignment);
2204 }
Warren Hunt94258912014-01-11 01:16:40 +00002205 // TODO: Add a Sema warning that MS ignores bitfield alignment in unions.
2206 if (!(FD->isBitField() && IsUnion))
2207 Alignment = std::max(Alignment, Info.Alignment);
Warren Huntd640d7d2014-01-09 00:30:56 +00002208 return Info;
2209}
2210
2211void MicrosoftRecordLayoutBuilder::layout(const RecordDecl *RD) {
2212 initializeLayout(RD);
2213 layoutFields(RD);
2214 DataSize = Size = Size.RoundUpToAlignment(Alignment);
2215 finalizeLayout(RD);
2216}
2217
2218void MicrosoftRecordLayoutBuilder::cxxLayout(const CXXRecordDecl *RD) {
2219 initializeLayout(RD);
2220 initializeCXXLayout(RD);
2221 layoutNonVirtualBases(RD);
2222 layoutFields(RD);
2223 injectVPtrs(RD);
2224 DataSize = Size = Size.RoundUpToAlignment(Alignment);
2225 layoutVirtualBases(RD);
2226 finalizeLayout(RD);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002227}
2228
2229void MicrosoftRecordLayoutBuilder::initializeLayout(const RecordDecl *RD) {
2230 IsUnion = RD->isUnion();
Warren Hunt5ae586a2013-11-01 23:59:41 +00002231 Is64BitMode = Context.getTargetInfo().getPointerWidth(0) == 64;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002232 Size = CharUnits::Zero();
2233 Alignment = CharUnits::One();
Warren Hunt7b252d22013-12-06 00:01:17 +00002234 // In 64-bit mode we always perform an alignment step after laying out vbases.
2235 // In 32-bit mode we do not. The check to see if we need to perform alignment
2236 // checks the RequiredAlignment field and performs alignment if it isn't 0.
2237 RequiredAlignment = Is64BitMode ? CharUnits::One() : CharUnits::Zero();
Warren Huntd640d7d2014-01-09 00:30:56 +00002238 RequiredAlignment = std::max(RequiredAlignment,
2239 Context.toCharUnitsFromBits(RD->getMaxAlignment()));
Warren Hunt8f8bad72013-10-11 20:19:00 +00002240 // Compute the maximum field alignment.
2241 MaxFieldAlignment = CharUnits::Zero();
2242 // Honor the default struct packing maximum alignment flag.
2243 if (unsigned DefaultMaxFieldAlignment = Context.getLangOpts().PackStruct)
Warren Huntf4518def2014-01-10 01:28:05 +00002244 MaxFieldAlignment = CharUnits::fromQuantity(DefaultMaxFieldAlignment);
2245 // Honor the packing attribute. The MS-ABI ignores pragma pack if its larger
2246 // than the pointer size.
2247 if (const MaxFieldAlignmentAttr *MFAA = RD->getAttr<MaxFieldAlignmentAttr>()){
2248 unsigned PackedAlignment = MFAA->getAlignment();
2249 if (PackedAlignment <= Context.getTargetInfo().getPointerWidth(0))
2250 MaxFieldAlignment = Context.toCharUnitsFromBits(PackedAlignment);
2251 }
Warren Hunt8f8bad72013-10-11 20:19:00 +00002252 // Packed attribute forces max field alignment to be 1.
2253 if (RD->hasAttr<PackedAttr>())
2254 MaxFieldAlignment = CharUnits::One();
2255}
2256
Warren Hunt8f8bad72013-10-11 20:19:00 +00002257void
2258MicrosoftRecordLayoutBuilder::initializeCXXLayout(const CXXRecordDecl *RD) {
Warren Huntd640d7d2014-01-09 00:30:56 +00002259 HasZeroSizedSubObject = false;
Warren Hunt049f6732013-12-06 19:54:25 +00002260 LeadsWithZeroSizedBase = false;
Warren Huntd640d7d2014-01-09 00:30:56 +00002261 HasOwnVFPtr = false;
2262 HasVBPtr = false;
2263 PrimaryBase = 0;
2264 SharedVBPtrBase = 0;
2265 // Calculate pointer size and alignment. These are used for vfptr and vbprt
2266 // injection.
2267 PointerInfo.Size =
2268 Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerWidth(0));
2269 PointerInfo.Alignment = PointerInfo.Size;
2270 // Respect pragma pack.
2271 if (!MaxFieldAlignment.isZero())
2272 PointerInfo.Alignment = std::min(PointerInfo.Alignment, MaxFieldAlignment);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002273}
2274
2275void
2276MicrosoftRecordLayoutBuilder::layoutNonVirtualBases(const CXXRecordDecl *RD) {
Warren Huntd640d7d2014-01-09 00:30:56 +00002277 // The MS-ABI lays out all bases that contain leading vfptrs before it lays
2278 // out any bases that do not contain vfptrs. We implement this as two passes
2279 // over the bases. This approach guarantees that the primary base is laid out
2280 // first. We use these passes to calculate some additional aggregated
2281 // information about the bases, such as reqruied alignment and the presence of
2282 // zero sized members.
2283 const ASTRecordLayout* PreviousBaseLayout = 0;
2284 // Iterate through the bases and lay out the non-virtual ones.
2285 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
2286 e = RD->bases_end();
2287 i != e; ++i) {
2288 const CXXRecordDecl *BaseDecl = i->getType()->getAsCXXRecordDecl();
2289 const ASTRecordLayout &BaseLayout = Context.getASTRecordLayout(BaseDecl);
2290 // Track RequiredAlignment for all bases in this pass.
2291 RequiredAlignment = std::max(RequiredAlignment,
2292 BaseLayout.getRequiredAlignment());
2293 // Mark and skip virtual bases.
2294 if (i->isVirtual()) {
2295 HasVBPtr = true;
2296 continue;
2297 }
2298 // Check fo a base to share a VBPtr with.
2299 if (!SharedVBPtrBase && BaseLayout.hasVBPtr()) {
2300 SharedVBPtrBase = BaseDecl;
2301 HasVBPtr = true;
2302 }
2303 // Only lay out bases with extendable VFPtrs on the first pass.
2304 if (!BaseLayout.hasExtendableVFPtr())
2305 continue;
2306 // If we don't have a primary base, this one qualifies.
2307 if (!PrimaryBase)
2308 PrimaryBase = BaseDecl;
2309 // Lay out the base.
2310 layoutNonVirtualBase(BaseDecl, BaseLayout, PreviousBaseLayout);
2311 }
2312 // Figure out if we need a fresh VFPtr for this class.
2313 if (!PrimaryBase && RD->isDynamicClass())
2314 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
2315 e = RD->method_end();
2316 !HasOwnVFPtr && i != e; ++i)
2317 HasOwnVFPtr = i->isVirtual() && i->size_overridden_methods() == 0;
2318 // If we don't have a primary base then we have a leading object that could
2319 // itself lead with a zero-sized object, something we track.
2320 bool CheckLeadingLayout = !PrimaryBase;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002321 // Iterate through the bases and lay out the non-virtual ones.
2322 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
2323 e = RD->bases_end();
2324 i != e; ++i) {
2325 if (i->isVirtual())
2326 continue;
Reid Klecknere7106c92013-12-18 23:17:05 +00002327 const CXXRecordDecl *BaseDecl = i->getType()->getAsCXXRecordDecl();
Warren Huntd640d7d2014-01-09 00:30:56 +00002328 const ASTRecordLayout &BaseLayout = Context.getASTRecordLayout(BaseDecl);
2329 // Only lay out bases without extendable VFPtrs on the second pass.
2330 if (BaseLayout.hasExtendableVFPtr())
Warren Hunt4431fe62013-12-12 22:33:37 +00002331 continue;
Warren Huntd640d7d2014-01-09 00:30:56 +00002332 // If this is the first layout, check to see if it leads with a zero sized
2333 // object. If it does, so do we.
2334 if (CheckLeadingLayout) {
2335 CheckLeadingLayout = false;
2336 LeadsWithZeroSizedBase = BaseLayout.leadsWithZeroSizedBase();
Warren Hunt049f6732013-12-06 19:54:25 +00002337 }
Warren Huntd640d7d2014-01-09 00:30:56 +00002338 // Lay out the base.
2339 layoutNonVirtualBase(BaseDecl, BaseLayout, PreviousBaseLayout);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002340 }
Warren Huntd640d7d2014-01-09 00:30:56 +00002341 // Set our VBPtroffset if we know it at this point.
Warren Hunt8f8bad72013-10-11 20:19:00 +00002342 if (!HasVBPtr)
2343 VBPtrOffset = CharUnits::fromQuantity(-1);
Warren Huntd640d7d2014-01-09 00:30:56 +00002344}
2345
2346void MicrosoftRecordLayoutBuilder::layoutNonVirtualBase(
2347 const CXXRecordDecl *BaseDecl,
2348 const ASTRecordLayout &BaseLayout,
2349 const ASTRecordLayout *&PreviousBaseLayout) {
Warren Huntf4518def2014-01-10 01:28:05 +00002350 // Insert padding between two bases if the left first one is zero sized or
2351 // contains a zero sized subobject and the right is zero sized or one leads
2352 // with a zero sized base.
2353 if (PreviousBaseLayout && PreviousBaseLayout->hasZeroSizedSubObject() &&
2354 BaseLayout.leadsWithZeroSizedBase())
2355 Size++;
2356 ElementInfo Info = getAdjustedElementInfo(BaseLayout);
2357 CharUnits BaseOffset = Size.RoundUpToAlignment(Info.Alignment);
2358 Bases.insert(std::make_pair(BaseDecl, BaseOffset));
2359 Size = BaseOffset + BaseLayout.getDataSize();
Warren Huntf4518def2014-01-10 01:28:05 +00002360 PreviousBaseLayout = &BaseLayout;
Warren Huntd640d7d2014-01-09 00:30:56 +00002361 VBPtrOffset = Size;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002362}
2363
2364void MicrosoftRecordLayoutBuilder::layoutFields(const RecordDecl *RD) {
2365 LastFieldIsNonZeroWidthBitfield = false;
2366 for (RecordDecl::field_iterator Field = RD->field_begin(),
2367 FieldEnd = RD->field_end();
2368 Field != FieldEnd; ++Field)
2369 layoutField(*Field);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002370}
2371
2372void MicrosoftRecordLayoutBuilder::layoutField(const FieldDecl *FD) {
2373 if (FD->isBitField()) {
2374 layoutBitField(FD);
2375 return;
2376 }
2377 LastFieldIsNonZeroWidthBitfield = false;
Warren Huntd640d7d2014-01-09 00:30:56 +00002378 ElementInfo Info = getAdjustedElementInfo(FD);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002379 if (IsUnion) {
Warren Huntd640d7d2014-01-09 00:30:56 +00002380 placeFieldAtOffset(CharUnits::Zero());
2381 Size = std::max(Size, Info.Size);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002382 } else {
Warren Huntd640d7d2014-01-09 00:30:56 +00002383 CharUnits FieldOffset = Size.RoundUpToAlignment(Info.Alignment);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002384 placeFieldAtOffset(FieldOffset);
Warren Huntd640d7d2014-01-09 00:30:56 +00002385 Size = FieldOffset + Info.Size;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002386 }
2387}
2388
2389void MicrosoftRecordLayoutBuilder::layoutBitField(const FieldDecl *FD) {
2390 unsigned Width = FD->getBitWidthValue(Context);
2391 if (Width == 0) {
2392 layoutZeroWidthBitField(FD);
2393 return;
2394 }
Warren Huntd640d7d2014-01-09 00:30:56 +00002395 ElementInfo Info = getAdjustedElementInfo(FD);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002396 // Clamp the bitfield to a containable size for the sake of being able
2397 // to lay them out. Sema will throw an error.
Warren Huntd640d7d2014-01-09 00:30:56 +00002398 if (Width > Context.toBits(Info.Size))
2399 Width = Context.toBits(Info.Size);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002400 // Check to see if this bitfield fits into an existing allocation. Note:
2401 // MSVC refuses to pack bitfields of formal types with different sizes
2402 // into the same allocation.
2403 if (!IsUnion && LastFieldIsNonZeroWidthBitfield &&
Warren Huntd640d7d2014-01-09 00:30:56 +00002404 CurrentBitfieldSize == Info.Size && Width <= RemainingBitsInField) {
Warren Hunt8f8bad72013-10-11 20:19:00 +00002405 placeFieldAtBitOffset(Context.toBits(Size) - RemainingBitsInField);
2406 RemainingBitsInField -= Width;
2407 return;
2408 }
Warren Hunt8f8bad72013-10-11 20:19:00 +00002409 LastFieldIsNonZeroWidthBitfield = true;
Warren Huntd640d7d2014-01-09 00:30:56 +00002410 CurrentBitfieldSize = Info.Size;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002411 if (IsUnion) {
Warren Huntd640d7d2014-01-09 00:30:56 +00002412 placeFieldAtOffset(CharUnits::Zero());
2413 Size = std::max(Size, Info.Size);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002414 } else {
2415 // Allocate a new block of memory and place the bitfield in it.
Warren Huntd640d7d2014-01-09 00:30:56 +00002416 CharUnits FieldOffset = Size.RoundUpToAlignment(Info.Alignment);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002417 placeFieldAtOffset(FieldOffset);
Warren Huntd640d7d2014-01-09 00:30:56 +00002418 Size = FieldOffset + Info.Size;
Warren Huntd640d7d2014-01-09 00:30:56 +00002419 RemainingBitsInField = Context.toBits(Info.Size) - Width;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002420 }
2421}
2422
2423void
2424MicrosoftRecordLayoutBuilder::layoutZeroWidthBitField(const FieldDecl *FD) {
2425 // Zero-width bitfields are ignored unless they follow a non-zero-width
2426 // bitfield.
Warren Hunt8f8bad72013-10-11 20:19:00 +00002427 if (!LastFieldIsNonZeroWidthBitfield) {
2428 placeFieldAtOffset(IsUnion ? CharUnits::Zero() : Size);
2429 // TODO: Add a Sema warning that MS ignores alignment for zero
Alp Tokerd4733632013-12-05 04:47:09 +00002430 // sized bitfields that occur after zero-size bitfields or non-bitfields.
Warren Hunt8f8bad72013-10-11 20:19:00 +00002431 return;
2432 }
Warren Hunt8f8bad72013-10-11 20:19:00 +00002433 LastFieldIsNonZeroWidthBitfield = false;
Warren Huntd640d7d2014-01-09 00:30:56 +00002434 ElementInfo Info = getAdjustedElementInfo(FD);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002435 if (IsUnion) {
Warren Huntd640d7d2014-01-09 00:30:56 +00002436 placeFieldAtOffset(CharUnits::Zero());
2437 Size = std::max(Size, Info.Size);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002438 } else {
2439 // Round up the current record size to the field's alignment boundary.
Warren Huntd640d7d2014-01-09 00:30:56 +00002440 CharUnits FieldOffset = Size.RoundUpToAlignment(Info.Alignment);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002441 placeFieldAtOffset(FieldOffset);
2442 Size = FieldOffset;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002443 }
2444}
2445
Warren Huntd640d7d2014-01-09 00:30:56 +00002446void MicrosoftRecordLayoutBuilder::injectVBPtr(const CXXRecordDecl *RD) {
2447 if (!HasVBPtr)
2448 return;
2449 if (SharedVBPtrBase) {
2450 const ASTRecordLayout &Layout = Context.getASTRecordLayout(SharedVBPtrBase);
2451 VBPtrOffset = Bases[SharedVBPtrBase] + Layout.getVBPtrOffset();
2452 return;
2453 }
2454 // Inject the VBPointer at the injection site.
2455 CharUnits InjectionSite = VBPtrOffset;
2456 // But before we do, make sure it's properly aligned.
2457 VBPtrOffset = VBPtrOffset.RoundUpToAlignment(PointerInfo.Alignment);
2458 // Determine where the first field should be laid out after the vbptr.
2459 CharUnits FieldStart = VBPtrOffset + PointerInfo.Size;
2460 // Make sure that the amount we push the fields back by is a multiple of the
2461 // alignment.
2462 CharUnits Offset = (FieldStart - InjectionSite).RoundUpToAlignment(Alignment);
2463 // Increase the size of the object and push back all fields by the offset
2464 // amount.
2465 Size += Offset;
2466 for (SmallVector<uint64_t, 16>::iterator i = FieldOffsets.begin(),
2467 e = FieldOffsets.end();
2468 i != e; ++i)
2469 *i += Context.toBits(Offset);
2470 for (BaseOffsetsMapTy::iterator i = Bases.begin(), e = Bases.end();
2471 i != e; ++i)
2472 if (i->second >= InjectionSite)
2473 i->second += Offset;
Warren Hunt87c2b042014-01-10 23:32:32 +00002474 // The presence of a vbptr suppresses zero sized objects that are not in
2475 // virtual bases.
2476 HasZeroSizedSubObject = false;
Warren Huntd640d7d2014-01-09 00:30:56 +00002477}
2478
2479void MicrosoftRecordLayoutBuilder::injectVFPtr(const CXXRecordDecl *RD) {
2480 if (!HasOwnVFPtr)
2481 return;
2482 // Make sure that the amount we push the struct back by is a multiple of the
2483 // alignment.
2484 CharUnits Offset = PointerInfo.Size.RoundUpToAlignment(Alignment);
2485 // Increase the size of the object and push back all fields, the vbptr and all
2486 // bases by the offset amount.
2487 Size += Offset;
2488 for (SmallVector<uint64_t, 16>::iterator i = FieldOffsets.begin(),
2489 e = FieldOffsets.end();
2490 i != e; ++i)
2491 *i += Context.toBits(Offset);
2492 if (HasVBPtr)
2493 VBPtrOffset += Offset;
2494 for (BaseOffsetsMapTy::iterator i = Bases.begin(), e = Bases.end();
2495 i != e; ++i)
2496 i->second += Offset;
Warren Huntd640d7d2014-01-09 00:30:56 +00002497}
2498
2499void MicrosoftRecordLayoutBuilder::injectVPtrs(const CXXRecordDecl *RD) {
David Blaikie461f1ea2014-01-09 02:34:06 +00002500 if (!(HasOwnVFPtr || (HasVBPtr && !SharedVBPtrBase)))
Warren Huntd640d7d2014-01-09 00:30:56 +00002501 return;
2502 if (!Is64BitMode || RequiredAlignment <= CharUnits::fromQuantity(8)) {
2503 // Note that the VBPtr is injected first. It depends on the alignment of
2504 // the object *before* the alignment is updated by inserting a pointer into
2505 // the record.
2506 injectVBPtr(RD);
2507 injectVFPtr(RD);
Warren Hunt94258912014-01-11 01:16:40 +00002508 Alignment = std::max(Alignment, PointerInfo.Alignment);
Warren Huntd640d7d2014-01-09 00:30:56 +00002509 return;
2510 }
2511 // In 64-bit mode, structs with RequiredAlignment greater than 8 get special
2512 // layout rules. Likely this is to avoid excessive padding intruced around
2513 // the vfptrs and vbptrs. The special rules involve re-laying out the struct
2514 // and inserting the vfptr and vbptr as if they were fields/bases.
2515 FieldOffsets.clear();
2516 Bases.clear();
2517 Size = CharUnits::Zero();
Warren Hunt94258912014-01-11 01:16:40 +00002518 Alignment = std::max(Alignment, PointerInfo.Alignment);
Warren Huntd640d7d2014-01-09 00:30:56 +00002519 if (HasOwnVFPtr)
2520 Size = PointerInfo.Size;
2521 layoutNonVirtualBases(RD);
2522 if (HasVBPtr && !SharedVBPtrBase) {
2523 const CXXRecordDecl *PenultBaseDecl = 0;
2524 const CXXRecordDecl *LastBaseDecl = 0;
2525 // Iterate through the bases and find the last two non-virtual bases.
2526 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
2527 e = RD->bases_end();
2528 i != e; ++i) {
2529 if (i->isVirtual())
2530 continue;
2531 const CXXRecordDecl *BaseDecl = i->getType()->getAsCXXRecordDecl();
2532 if (!LastBaseDecl || Bases[BaseDecl] > Bases[LastBaseDecl]) {
2533 PenultBaseDecl = LastBaseDecl;
2534 LastBaseDecl = BaseDecl;
2535 }
2536 }
2537 const ASTRecordLayout *PenultBaseLayout = PenultBaseDecl ?
2538 &Context.getASTRecordLayout(PenultBaseDecl) : 0;
2539 const ASTRecordLayout *LastBaseLayout = LastBaseDecl ?
2540 &Context.getASTRecordLayout(LastBaseDecl) : 0;
2541 // Calculate the vbptr offset. The rule is different than in the general
2542 // case layout. Particularly, if the last two non-virtual bases are both
2543 // zero sized, the site of the vbptr is *before* the padding that occurs
2544 // between the two zero sized bases and the vbptr potentially aliases with
2545 // the first of these two bases. We have no understanding of why this is
2546 // different from the general case layout but it may have to do with lazy
2547 // placement of zero sized bases.
2548 VBPtrOffset = Size;
Warren Hunt640015cb2014-01-09 23:51:31 +00002549 if (LastBaseLayout && LastBaseLayout->getDataSize().isZero()) {
Warren Huntd640d7d2014-01-09 00:30:56 +00002550 VBPtrOffset = Bases[LastBaseDecl];
Warren Hunt640015cb2014-01-09 23:51:31 +00002551 if (PenultBaseLayout && PenultBaseLayout->getDataSize().isZero())
Warren Huntd640d7d2014-01-09 00:30:56 +00002552 VBPtrOffset = Bases[PenultBaseDecl];
2553 }
2554 // Once we've located a spot for the vbptr, place it.
2555 VBPtrOffset = VBPtrOffset.RoundUpToAlignment(PointerInfo.Alignment);
2556 Size = VBPtrOffset + PointerInfo.Size;
Warren Hunt640015cb2014-01-09 23:51:31 +00002557 if (LastBaseLayout && LastBaseLayout->getDataSize().isZero()) {
Warren Huntd640d7d2014-01-09 00:30:56 +00002558 // Add the padding between zero sized bases after the vbptr.
Warren Hunt640015cb2014-01-09 23:51:31 +00002559 if (PenultBaseLayout && PenultBaseLayout->getDataSize().isZero())
Warren Huntd640d7d2014-01-09 00:30:56 +00002560 Size += CharUnits::One();
2561 Size = Size.RoundUpToAlignment(LastBaseLayout->getRequiredAlignment());
2562 Bases[LastBaseDecl] = Size;
2563 }
2564 }
2565 layoutFields(RD);
Warren Hunt87c2b042014-01-10 23:32:32 +00002566 // The presence of a vbptr suppresses zero sized objects that are not in
2567 // virtual bases.
2568 HasZeroSizedSubObject = false;
Warren Hunt1603e522013-12-10 01:44:39 +00002569}
2570
Warren Hunt8f8bad72013-10-11 20:19:00 +00002571void MicrosoftRecordLayoutBuilder::layoutVirtualBases(const CXXRecordDecl *RD) {
2572 if (!HasVBPtr)
2573 return;
Warren Huntd640d7d2014-01-09 00:30:56 +00002574 // Vtordisps are always 4 bytes (even in 64-bit mode)
2575 CharUnits VtorDispSize = CharUnits::fromQuantity(4);
2576 CharUnits VtorDispAlignment = VtorDispSize;
2577 // vtordisps respect pragma pack.
2578 if (!MaxFieldAlignment.isZero())
2579 VtorDispAlignment = std::min(VtorDispAlignment, MaxFieldAlignment);
2580 // The alignment of the vtordisp is at least the required alignment of the
2581 // entire record. This requirement may be present to support vtordisp
2582 // injection.
2583 VtorDispAlignment = std::max(VtorDispAlignment, RequiredAlignment);
2584 // Compute the vtordisp set.
2585 llvm::SmallPtrSet<const CXXRecordDecl *, 2> HasVtordispSet =
Warren Hunt8f8bad72013-10-11 20:19:00 +00002586 computeVtorDispSet(RD);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002587 // Iterate through the virtual bases and lay them out.
Warren Huntd640d7d2014-01-09 00:30:56 +00002588 const ASTRecordLayout* PreviousBaseLayout = 0;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002589 for (CXXRecordDecl::base_class_const_iterator i = RD->vbases_begin(),
2590 e = RD->vbases_end();
2591 i != e; ++i) {
Reid Klecknere7106c92013-12-18 23:17:05 +00002592 const CXXRecordDecl *BaseDecl = i->getType()->getAsCXXRecordDecl();
Warren Huntd640d7d2014-01-09 00:30:56 +00002593 const ASTRecordLayout &BaseLayout = Context.getASTRecordLayout(BaseDecl);
2594 bool HasVtordisp = HasVtordispSet.count(BaseDecl);
Warren Hunt71140d62013-12-06 20:16:49 +00002595 // If the last field we laid out was a non-zero length bitfield then add
2596 // some extra padding for no obvious reason.
2597 if (LastFieldIsNonZeroWidthBitfield)
2598 Size += CurrentBitfieldSize;
Warren Huntd640d7d2014-01-09 00:30:56 +00002599 // Insert padding between two bases if the left first one is zero sized or
2600 // contains a zero sized subobject and the right is zero sized or one leads
2601 // with a zero sized base. The padding between virtual bases is 4
2602 // bytes (in both 32 and 64 bits modes) and always involves rounding up to
2603 // the required alignment, we don't know why.
2604 if (PreviousBaseLayout && PreviousBaseLayout->hasZeroSizedSubObject() &&
2605 BaseLayout.leadsWithZeroSizedBase())
2606 Size = Size.RoundUpToAlignment(VtorDispAlignment) + VtorDispSize;
2607 // Insert the vtordisp.
2608 if (HasVtordisp)
2609 Size = Size.RoundUpToAlignment(VtorDispAlignment) + VtorDispSize;
2610 // Insert the virtual base.
2611 ElementInfo Info = getAdjustedElementInfo(BaseLayout);
Warren Huntf4518def2014-01-10 01:28:05 +00002612 CharUnits BaseOffset = Size.RoundUpToAlignment(Info.Alignment);
Warren Huntd640d7d2014-01-09 00:30:56 +00002613 VBases.insert(std::make_pair(BaseDecl,
2614 ASTRecordLayout::VBaseInfo(BaseOffset, HasVtordisp)));
Warren Hunt640015cb2014-01-09 23:51:31 +00002615 Size = BaseOffset + BaseLayout.getDataSize();
Warren Huntd640d7d2014-01-09 00:30:56 +00002616 PreviousBaseLayout = &BaseLayout;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002617 }
2618}
2619
Warren Huntc3384312013-12-11 22:28:32 +00002620void MicrosoftRecordLayoutBuilder::finalizeLayout(const RecordDecl *RD) {
Warren Huntd640d7d2014-01-09 00:30:56 +00002621 // Respect required alignment. Note that in 32-bit mode Required alignment
2622 // may be 0 nad cause size not to be updated.
2623 if (!RequiredAlignment.isZero()) {
2624 Alignment = std::max(Alignment, RequiredAlignment);
2625 Size = Size.RoundUpToAlignment(Alignment);
2626 }
2627 // Zero-sized structures have size equal to their alignment.
Warren Hunt049f6732013-12-06 19:54:25 +00002628 if (Size.isZero()) {
2629 HasZeroSizedSubObject = true;
2630 LeadsWithZeroSizedBase = true;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002631 Size = Alignment;
Warren Hunt049f6732013-12-06 19:54:25 +00002632 }
Warren Hunt8f8bad72013-10-11 20:19:00 +00002633}
2634
2635static bool
2636RequiresVtordisp(const llvm::SmallPtrSet<const CXXRecordDecl *, 2> &HasVtordisp,
2637 const CXXRecordDecl *RD) {
2638 if (HasVtordisp.count(RD))
2639 return true;
2640 // If any of a virtual bases non-virtual bases (recursively) requires a
2641 // vtordisp than so does this virtual base.
2642 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
2643 e = RD->bases_end();
2644 i != e; ++i)
2645 if (!i->isVirtual() &&
2646 RequiresVtordisp(
2647 HasVtordisp,
2648 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl())))
2649 return true;
2650 return false;
2651}
2652
2653llvm::SmallPtrSet<const CXXRecordDecl *, 2>
2654MicrosoftRecordLayoutBuilder::computeVtorDispSet(const CXXRecordDecl *RD) {
Warren Huntd640d7d2014-01-09 00:30:56 +00002655 llvm::SmallPtrSet<const CXXRecordDecl *, 2> HasVtordispSet;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002656 // If any of our bases need a vtordisp for this type, so do we. Check our
2657 // direct bases for vtordisp requirements.
2658 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
2659 e = RD->bases_end();
2660 i != e; ++i) {
2661 const CXXRecordDecl *BaseDecl =
2662 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
2663 const ASTRecordLayout &Layout = Context.getASTRecordLayout(BaseDecl);
2664 for (ASTRecordLayout::VBaseOffsetsMapTy::const_iterator
2665 bi = Layout.getVBaseOffsetsMap().begin(),
2666 be = Layout.getVBaseOffsetsMap().end();
2667 bi != be; ++bi)
2668 if (bi->second.hasVtorDisp())
Warren Huntd640d7d2014-01-09 00:30:56 +00002669 HasVtordispSet.insert(bi->first);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002670 }
Warren Hunt8f8bad72013-10-11 20:19:00 +00002671 // If we define a constructor or destructor and override a function that is
2672 // defined in a virtual base's vtable, that virtual bases need a vtordisp.
2673 // Here we collect a list of classes with vtables for which our virtual bases
2674 // actually live. The virtual bases with this property will require
2675 // vtordisps. In addition, virtual bases that contain non-virtual bases that
2676 // define functions we override also require vtordisps, this case is checked
2677 // explicitly below.
2678 if (RD->hasUserDeclaredConstructor() || RD->hasUserDeclaredDestructor()) {
2679 llvm::SmallPtrSet<const CXXMethodDecl *, 8> Work;
2680 // Seed the working set with our non-destructor virtual methods.
2681 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
2682 e = RD->method_end();
2683 i != e; ++i)
Warren Hunt42be7762013-10-14 20:14:09 +00002684 if ((*i)->isVirtual() && !isa<CXXDestructorDecl>(*i))
Warren Hunt8f8bad72013-10-11 20:19:00 +00002685 Work.insert(*i);
2686 while (!Work.empty()) {
2687 const CXXMethodDecl *MD = *Work.begin();
2688 CXXMethodDecl::method_iterator i = MD->begin_overridden_methods(),
2689 e = MD->end_overridden_methods();
2690 if (i == e)
2691 // If a virtual method has no-overrides it lives in its parent's vtable.
Warren Huntd640d7d2014-01-09 00:30:56 +00002692 HasVtordispSet.insert(MD->getParent());
Warren Hunt8f8bad72013-10-11 20:19:00 +00002693 else
2694 Work.insert(i, e);
2695 // We've finished processing this element, remove it from the working set.
2696 Work.erase(MD);
2697 }
2698 }
Warren Hunt8f8bad72013-10-11 20:19:00 +00002699 // Re-check all of our vbases for vtordisp requirements (in case their
2700 // non-virtual bases have vtordisp requirements).
2701 for (CXXRecordDecl::base_class_const_iterator i = RD->vbases_begin(),
2702 e = RD->vbases_end();
2703 i != e; ++i) {
2704 const CXXRecordDecl *BaseDecl = i->getType()->getAsCXXRecordDecl();
Warren Huntd640d7d2014-01-09 00:30:56 +00002705 if (!HasVtordispSet.count(BaseDecl) &&
2706 RequiresVtordisp(HasVtordispSet, BaseDecl))
2707 HasVtordispSet.insert(BaseDecl);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002708 }
Warren Huntd640d7d2014-01-09 00:30:56 +00002709 return HasVtordispSet;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002710}
2711
2712/// \brief Get or compute information about the layout of the specified record
2713/// (struct/union/class), which indicates its size and field position
2714/// information.
2715const ASTRecordLayout *
2716ASTContext::BuildMicrosoftASTRecordLayout(const RecordDecl *D) const {
2717 MicrosoftRecordLayoutBuilder Builder(*this);
2718 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
2719 Builder.cxxLayout(RD);
2720 return new (*this) ASTRecordLayout(
Warren Hunt7b252d22013-12-06 00:01:17 +00002721 *this, Builder.Size, Builder.Alignment, Builder.RequiredAlignment,
Warren Huntd640d7d2014-01-09 00:30:56 +00002722 Builder.HasOwnVFPtr,
2723 Builder.HasOwnVFPtr || Builder.PrimaryBase,
Timur Iskhodzhanov2c9341f2013-11-08 11:45:35 +00002724 Builder.VBPtrOffset, Builder.DataSize, Builder.FieldOffsets.data(),
Warren Hunt8f8bad72013-10-11 20:19:00 +00002725 Builder.FieldOffsets.size(), Builder.DataSize,
Warren Huntd640d7d2014-01-09 00:30:56 +00002726 Builder.Alignment, CharUnits::Zero(), Builder.PrimaryBase,
Warren Hunt049f6732013-12-06 19:54:25 +00002727 false, Builder.SharedVBPtrBase,
2728 Builder.HasZeroSizedSubObject, Builder.LeadsWithZeroSizedBase,
2729 Builder.Bases, Builder.VBases);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002730 } else {
2731 Builder.layout(D);
2732 return new (*this) ASTRecordLayout(
Warren Hunt7b252d22013-12-06 00:01:17 +00002733 *this, Builder.Size, Builder.Alignment, Builder.RequiredAlignment,
2734 Builder.Size, Builder.FieldOffsets.data(), Builder.FieldOffsets.size());
Warren Hunt8f8bad72013-10-11 20:19:00 +00002735 }
2736}
2737
Anders Carlssondf291d82010-05-26 04:56:53 +00002738/// getASTRecordLayout - Get or compute information about the layout of the
2739/// specified record (struct/union/class), which indicates its size and field
2740/// position information.
Jay Foad39c79802011-01-12 09:06:06 +00002741const ASTRecordLayout &
2742ASTContext::getASTRecordLayout(const RecordDecl *D) const {
John McCall0710e552011-10-07 02:39:22 +00002743 // These asserts test different things. A record has a definition
2744 // as soon as we begin to parse the definition. That definition is
2745 // not a complete definition (which is what isDefinition() tests)
2746 // until we *finish* parsing the definition.
Sean Callanan56c19892012-02-08 00:04:52 +00002747
2748 if (D->hasExternalLexicalStorage() && !D->getDefinition())
2749 getExternalSource()->CompleteType(const_cast<RecordDecl*>(D));
2750
Anders Carlssondf291d82010-05-26 04:56:53 +00002751 D = D->getDefinition();
2752 assert(D && "Cannot get layout of forward declarations!");
Matt Beaumont-Gay35779952013-06-25 22:19:15 +00002753 assert(!D->isInvalidDecl() && "Cannot get layout of invalid decl!");
John McCallf937c022011-10-07 06:10:15 +00002754 assert(D->isCompleteDefinition() && "Cannot layout type before complete!");
Anders Carlssondf291d82010-05-26 04:56:53 +00002755
2756 // Look up this layout, if already laid out, return what we have.
2757 // Note that we can't save a reference to the entry because this function
2758 // is recursive.
2759 const ASTRecordLayout *Entry = ASTRecordLayouts[D];
2760 if (Entry) return *Entry;
2761
Warren Hunt8f8bad72013-10-11 20:19:00 +00002762 const ASTRecordLayout *NewEntry = 0;
Anders Carlssond2954862010-05-26 05:10:47 +00002763
Warren Hunt8f8bad72013-10-11 20:19:00 +00002764 if (isMsLayout(D) && !D->getASTContext().getExternalSource()) {
2765 NewEntry = BuildMicrosoftASTRecordLayout(D);
2766 } else if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
Anders Carlssonc121b4e2010-05-27 00:07:01 +00002767 EmptySubobjectMap EmptySubobjects(*this, RD);
John McCall0153cd32011-11-08 04:01:03 +00002768 RecordLayoutBuilder Builder(*this, &EmptySubobjects);
2769 Builder.Layout(RD);
Anders Carlsson439edd12010-05-27 05:41:06 +00002770
John McCall5c1f1d02013-01-29 01:14:22 +00002771 // In certain situations, we are allowed to lay out objects in the
2772 // tail-padding of base classes. This is ABI-dependent.
2773 // FIXME: this should be stored in the record layout.
2774 bool skipTailPadding =
2775 mustSkipTailPadding(getTargetInfo().getCXXABI(), cast<CXXRecordDecl>(D));
Anders Carlssond2954862010-05-26 05:10:47 +00002776
2777 // FIXME: This should be done in FinalizeLayout.
Ken Dyck1b4420e2011-02-28 02:01:38 +00002778 CharUnits DataSize =
John McCall5c1f1d02013-01-29 01:14:22 +00002779 skipTailPadding ? Builder.getSize() : Builder.getDataSize();
Ken Dyck1b4420e2011-02-28 02:01:38 +00002780 CharUnits NonVirtualSize =
John McCall5c1f1d02013-01-29 01:14:22 +00002781 skipTailPadding ? DataSize : Builder.NonVirtualSize;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00002782 NewEntry =
John McCall0153cd32011-11-08 04:01:03 +00002783 new (*this) ASTRecordLayout(*this, Builder.getSize(),
2784 Builder.Alignment,
Warren Hunt7b252d22013-12-06 00:01:17 +00002785 /*RequiredAlignment : used by MS-ABI)*/
2786 Builder.Alignment,
John McCalle42a3362012-05-01 08:55:32 +00002787 Builder.HasOwnVFPtr,
Warren Hunt8f8bad72013-10-11 20:19:00 +00002788 RD->isDynamicClass(),
Warren Hunt55d8e822013-10-23 23:53:07 +00002789 CharUnits::fromQuantity(-1),
Ken Dyck1b4420e2011-02-28 02:01:38 +00002790 DataSize,
John McCall0153cd32011-11-08 04:01:03 +00002791 Builder.FieldOffsets.data(),
2792 Builder.FieldOffsets.size(),
Ken Dyckaf1c83f2011-02-16 01:52:01 +00002793 NonVirtualSize,
John McCall0153cd32011-11-08 04:01:03 +00002794 Builder.NonVirtualAlignment,
Anders Carlssonc121b4e2010-05-27 00:07:01 +00002795 EmptySubobjects.SizeOfLargestEmptySubobject,
John McCall0153cd32011-11-08 04:01:03 +00002796 Builder.PrimaryBase,
2797 Builder.PrimaryBaseIsVirtual,
Warren Hunt049f6732013-12-06 19:54:25 +00002798 0, false, false,
John McCall0153cd32011-11-08 04:01:03 +00002799 Builder.Bases, Builder.VBases);
Anders Carlssond2954862010-05-26 05:10:47 +00002800 } else {
John McCall0153cd32011-11-08 04:01:03 +00002801 RecordLayoutBuilder Builder(*this, /*EmptySubobjects=*/0);
Anders Carlssond2954862010-05-26 05:10:47 +00002802 Builder.Layout(D);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00002803
Anders Carlssond2954862010-05-26 05:10:47 +00002804 NewEntry =
Ken Dyck1b4420e2011-02-28 02:01:38 +00002805 new (*this) ASTRecordLayout(*this, Builder.getSize(),
Ken Dyck4731d5b2011-02-16 02:05:21 +00002806 Builder.Alignment,
Warren Hunt7b252d22013-12-06 00:01:17 +00002807 /*RequiredAlignment : used by MS-ABI)*/
2808 Builder.Alignment,
Ken Dyck1b4420e2011-02-28 02:01:38 +00002809 Builder.getSize(),
Anders Carlssond2954862010-05-26 05:10:47 +00002810 Builder.FieldOffsets.data(),
2811 Builder.FieldOffsets.size());
2812 }
2813
Anders Carlssondf291d82010-05-26 04:56:53 +00002814 ASTRecordLayouts[D] = NewEntry;
2815
David Blaikiebbafb8a2012-03-11 07:00:24 +00002816 if (getLangOpts().DumpRecordLayouts) {
Argyrios Kyrtzidis8ade08e2013-07-12 22:30:03 +00002817 llvm::outs() << "\n*** Dumping AST Record Layout\n";
2818 DumpRecordLayout(D, llvm::outs(), getLangOpts().DumpRecordLayoutsSimple);
Anders Carlssondf291d82010-05-26 04:56:53 +00002819 }
2820
2821 return *NewEntry;
2822}
2823
John McCall6bd2a892013-01-25 22:31:03 +00002824const CXXMethodDecl *ASTContext::getCurrentKeyFunction(const CXXRecordDecl *RD) {
Reid Kleckner5d7f2982013-05-29 16:18:30 +00002825 if (!getTargetInfo().getCXXABI().hasKeyFunctions())
2826 return 0;
2827
John McCall6bd2a892013-01-25 22:31:03 +00002828 assert(RD->getDefinition() && "Cannot get key function for forward decl!");
Anders Carlssondf291d82010-05-26 04:56:53 +00002829 RD = cast<CXXRecordDecl>(RD->getDefinition());
Daniel Dunbar592a85c2010-05-27 02:25:46 +00002830
Richard Smith676c4042013-08-29 23:59:27 +00002831 LazyDeclPtr &Entry = KeyFunctions[RD];
2832 if (!Entry)
2833 Entry = const_cast<CXXMethodDecl*>(computeKeyFunction(*this, RD));
Daniel Dunbar592a85c2010-05-27 02:25:46 +00002834
Richard Smith676c4042013-08-29 23:59:27 +00002835 return cast_or_null<CXXMethodDecl>(Entry.get(getExternalSource()));
John McCall6bd2a892013-01-25 22:31:03 +00002836}
2837
Richard Smith676c4042013-08-29 23:59:27 +00002838void ASTContext::setNonKeyFunction(const CXXMethodDecl *Method) {
Rafael Espindola8db352d2013-10-17 15:37:26 +00002839 assert(Method == Method->getFirstDecl() &&
John McCall6bd2a892013-01-25 22:31:03 +00002840 "not working with method declaration from class definition");
2841
2842 // Look up the cache entry. Since we're working with the first
2843 // declaration, its parent must be the class definition, which is
2844 // the correct key for the KeyFunctions hash.
Richard Smith676c4042013-08-29 23:59:27 +00002845 llvm::DenseMap<const CXXRecordDecl*, LazyDeclPtr>::iterator
2846 I = KeyFunctions.find(Method->getParent());
John McCall6bd2a892013-01-25 22:31:03 +00002847
2848 // If it's not cached, there's nothing to do.
Richard Smith676c4042013-08-29 23:59:27 +00002849 if (I == KeyFunctions.end()) return;
John McCall6bd2a892013-01-25 22:31:03 +00002850
2851 // If it is cached, check whether it's the target method, and if so,
2852 // remove it from the cache.
Richard Smith676c4042013-08-29 23:59:27 +00002853 if (I->second.get(getExternalSource()) == Method) {
John McCall6bd2a892013-01-25 22:31:03 +00002854 // FIXME: remember that we did this for module / chained PCH state?
Richard Smith676c4042013-08-29 23:59:27 +00002855 KeyFunctions.erase(I);
John McCall6bd2a892013-01-25 22:31:03 +00002856 }
Anders Carlssondf291d82010-05-26 04:56:53 +00002857}
2858
Richard Smithdafff942012-01-14 04:30:29 +00002859static uint64_t getFieldOffset(const ASTContext &C, const FieldDecl *FD) {
2860 const ASTRecordLayout &Layout = C.getASTRecordLayout(FD->getParent());
2861 return Layout.getFieldOffset(FD->getFieldIndex());
2862}
2863
2864uint64_t ASTContext::getFieldOffset(const ValueDecl *VD) const {
2865 uint64_t OffsetInBits;
2866 if (const FieldDecl *FD = dyn_cast<FieldDecl>(VD)) {
2867 OffsetInBits = ::getFieldOffset(*this, FD);
2868 } else {
2869 const IndirectFieldDecl *IFD = cast<IndirectFieldDecl>(VD);
2870
2871 OffsetInBits = 0;
2872 for (IndirectFieldDecl::chain_iterator CI = IFD->chain_begin(),
2873 CE = IFD->chain_end();
2874 CI != CE; ++CI)
2875 OffsetInBits += ::getFieldOffset(*this, cast<FieldDecl>(*CI));
2876 }
2877
2878 return OffsetInBits;
2879}
2880
Eric Christopher8a39a012011-10-05 06:00:51 +00002881/// getObjCLayout - Get or compute information about the layout of the
2882/// given interface.
Anders Carlssondf291d82010-05-26 04:56:53 +00002883///
2884/// \param Impl - If given, also include the layout of the interface's
2885/// implementation. This may differ by including synthesized ivars.
2886const ASTRecordLayout &
2887ASTContext::getObjCLayout(const ObjCInterfaceDecl *D,
Jay Foad39c79802011-01-12 09:06:06 +00002888 const ObjCImplementationDecl *Impl) const {
Douglas Gregor64d92572011-12-20 15:50:13 +00002889 // Retrieve the definition
Sean Callanand9a909c2012-03-15 16:33:08 +00002890 if (D->hasExternalLexicalStorage() && !D->getDefinition())
2891 getExternalSource()->CompleteType(const_cast<ObjCInterfaceDecl*>(D));
Douglas Gregor64d92572011-12-20 15:50:13 +00002892 D = D->getDefinition();
2893 assert(D && D->isThisDeclarationADefinition() && "Invalid interface decl!");
Anders Carlssondf291d82010-05-26 04:56:53 +00002894
2895 // Look up this layout, if already laid out, return what we have.
Roman Divackye6377112012-09-06 15:59:27 +00002896 const ObjCContainerDecl *Key =
2897 Impl ? (const ObjCContainerDecl*) Impl : (const ObjCContainerDecl*) D;
Anders Carlssondf291d82010-05-26 04:56:53 +00002898 if (const ASTRecordLayout *Entry = ObjCLayouts[Key])
2899 return *Entry;
2900
2901 // Add in synthesized ivar count if laying out an implementation.
2902 if (Impl) {
2903 unsigned SynthCount = CountNonClassIvars(D);
2904 // If there aren't any sythesized ivars then reuse the interface
2905 // entry. Note we can't cache this because we simply free all
2906 // entries later; however we shouldn't look up implementations
2907 // frequently.
2908 if (SynthCount == 0)
2909 return getObjCLayout(D, 0);
2910 }
2911
John McCall0153cd32011-11-08 04:01:03 +00002912 RecordLayoutBuilder Builder(*this, /*EmptySubobjects=*/0);
Anders Carlsson6ed3a9a2010-05-26 05:04:25 +00002913 Builder.Layout(D);
2914
Anders Carlssondf291d82010-05-26 04:56:53 +00002915 const ASTRecordLayout *NewEntry =
Ken Dyck1b4420e2011-02-28 02:01:38 +00002916 new (*this) ASTRecordLayout(*this, Builder.getSize(),
Ken Dyck4731d5b2011-02-16 02:05:21 +00002917 Builder.Alignment,
Warren Hunt7b252d22013-12-06 00:01:17 +00002918 /*RequiredAlignment : used by MS-ABI)*/
2919 Builder.Alignment,
Ken Dyck1b4420e2011-02-28 02:01:38 +00002920 Builder.getDataSize(),
Anders Carlsson6ed3a9a2010-05-26 05:04:25 +00002921 Builder.FieldOffsets.data(),
2922 Builder.FieldOffsets.size());
Daniel Dunbar592a85c2010-05-27 02:25:46 +00002923
Anders Carlssondf291d82010-05-26 04:56:53 +00002924 ObjCLayouts[Key] = NewEntry;
2925
2926 return *NewEntry;
2927}
2928
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002929static void PrintOffset(raw_ostream &OS,
Anders Carlsson3f018712010-10-31 23:45:59 +00002930 CharUnits Offset, unsigned IndentLevel) {
Benjamin Kramer96ad7172011-11-05 09:02:52 +00002931 OS << llvm::format("%4" PRId64 " | ", (int64_t)Offset.getQuantity());
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002932 OS.indent(IndentLevel * 2);
2933}
2934
Eli Benderskyf6f93ee2012-12-08 00:07:24 +00002935static void PrintIndentNoOffset(raw_ostream &OS, unsigned IndentLevel) {
2936 OS << " | ";
2937 OS.indent(IndentLevel * 2);
2938}
2939
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002940static void DumpCXXRecordLayout(raw_ostream &OS,
Jay Foad39c79802011-01-12 09:06:06 +00002941 const CXXRecordDecl *RD, const ASTContext &C,
Anders Carlsson3f018712010-10-31 23:45:59 +00002942 CharUnits Offset,
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002943 unsigned IndentLevel,
2944 const char* Description,
2945 bool IncludeVirtualBases) {
Anders Carlsson3f018712010-10-31 23:45:59 +00002946 const ASTRecordLayout &Layout = C.getASTRecordLayout(RD);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002947
2948 PrintOffset(OS, Offset, IndentLevel);
Dan Gohman145f3f12010-04-19 16:39:44 +00002949 OS << C.getTypeDeclType(const_cast<CXXRecordDecl *>(RD)).getAsString();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002950 if (Description)
2951 OS << ' ' << Description;
2952 if (RD->isEmpty())
2953 OS << " (empty)";
2954 OS << '\n';
2955
2956 IndentLevel++;
2957
Anders Carlsson3f018712010-10-31 23:45:59 +00002958 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
Warren Hunt8f8bad72013-10-11 20:19:00 +00002959 bool HasOwnVFPtr = Layout.hasOwnVFPtr();
2960 bool HasOwnVBPtr = Layout.hasOwnVBPtr();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002961
2962 // Vtable pointer.
Warren Hunt8f8bad72013-10-11 20:19:00 +00002963 if (RD->isDynamicClass() && !PrimaryBase && !isMsLayout(RD)) {
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002964 PrintOffset(OS, Offset, IndentLevel);
Benjamin Kramerb89514a2011-10-14 18:45:37 +00002965 OS << '(' << *RD << " vtable pointer)\n";
Warren Hunt8f8bad72013-10-11 20:19:00 +00002966 } else if (HasOwnVFPtr) {
2967 PrintOffset(OS, Offset, IndentLevel);
2968 // vfptr (for Microsoft C++ ABI)
2969 OS << '(' << *RD << " vftable pointer)\n";
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002970 }
Warren Hunt8f8bad72013-10-11 20:19:00 +00002971
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002972 // Dump (non-virtual) bases
2973 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
2974 E = RD->bases_end(); I != E; ++I) {
2975 assert(!I->getType()->isDependentType() &&
2976 "Cannot layout class with dependent bases.");
2977 if (I->isVirtual())
2978 continue;
2979
2980 const CXXRecordDecl *Base =
2981 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
2982
Anders Carlsson3f018712010-10-31 23:45:59 +00002983 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002984
2985 DumpCXXRecordLayout(OS, Base, C, BaseOffset, IndentLevel,
2986 Base == PrimaryBase ? "(primary base)" : "(base)",
2987 /*IncludeVirtualBases=*/false);
2988 }
Eli Friedman43114f92011-10-21 22:49:56 +00002989
Warren Hunt8f8bad72013-10-11 20:19:00 +00002990 // vbptr (for Microsoft C++ ABI)
2991 if (HasOwnVBPtr) {
Eli Friedman84d2d3a2011-09-27 19:12:27 +00002992 PrintOffset(OS, Offset + Layout.getVBPtrOffset(), IndentLevel);
Benjamin Kramerb89514a2011-10-14 18:45:37 +00002993 OS << '(' << *RD << " vbtable pointer)\n";
Eli Friedman84d2d3a2011-09-27 19:12:27 +00002994 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002995
2996 // Dump fields.
2997 uint64_t FieldNo = 0;
2998 for (CXXRecordDecl::field_iterator I = RD->field_begin(),
2999 E = RD->field_end(); I != E; ++I, ++FieldNo) {
David Blaikie40ed2972012-06-06 20:45:41 +00003000 const FieldDecl &Field = **I;
Anders Carlsson3f018712010-10-31 23:45:59 +00003001 CharUnits FieldOffset = Offset +
Ken Dyck86a7fcc2011-01-18 01:56:16 +00003002 C.toCharUnitsFromBits(Layout.getFieldOffset(FieldNo));
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003003
David Blaikie2d7c57e2012-04-30 02:36:29 +00003004 if (const RecordType *RT = Field.getType()->getAs<RecordType>()) {
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003005 if (const CXXRecordDecl *D = dyn_cast<CXXRecordDecl>(RT->getDecl())) {
3006 DumpCXXRecordLayout(OS, D, C, FieldOffset, IndentLevel,
David Blaikie2d7c57e2012-04-30 02:36:29 +00003007 Field.getName().data(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003008 /*IncludeVirtualBases=*/true);
3009 continue;
3010 }
3011 }
3012
3013 PrintOffset(OS, FieldOffset, IndentLevel);
David Blaikie2d7c57e2012-04-30 02:36:29 +00003014 OS << Field.getType().getAsString() << ' ' << Field << '\n';
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003015 }
3016
3017 if (!IncludeVirtualBases)
3018 return;
3019
3020 // Dump virtual bases.
John McCalle42a3362012-05-01 08:55:32 +00003021 const ASTRecordLayout::VBaseOffsetsMapTy &vtordisps =
3022 Layout.getVBaseOffsetsMap();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003023 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
3024 E = RD->vbases_end(); I != E; ++I) {
3025 assert(I->isVirtual() && "Found non-virtual class!");
3026 const CXXRecordDecl *VBase =
3027 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
3028
Anders Carlsson3f018712010-10-31 23:45:59 +00003029 CharUnits VBaseOffset = Offset + Layout.getVBaseClassOffset(VBase);
John McCalle42a3362012-05-01 08:55:32 +00003030
3031 if (vtordisps.find(VBase)->second.hasVtorDisp()) {
3032 PrintOffset(OS, VBaseOffset - CharUnits::fromQuantity(4), IndentLevel);
3033 OS << "(vtordisp for vbase " << *VBase << ")\n";
3034 }
3035
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003036 DumpCXXRecordLayout(OS, VBase, C, VBaseOffset, IndentLevel,
3037 VBase == PrimaryBase ?
3038 "(primary virtual base)" : "(virtual base)",
3039 /*IncludeVirtualBases=*/false);
3040 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003041
Eli Benderskyf6f93ee2012-12-08 00:07:24 +00003042 PrintIndentNoOffset(OS, IndentLevel - 1);
3043 OS << "[sizeof=" << Layout.getSize().getQuantity();
Warren Hunt8f8bad72013-10-11 20:19:00 +00003044 if (!isMsLayout(RD))
3045 OS << ", dsize=" << Layout.getDataSize().getQuantity();
Ken Dyck7ad11e72011-02-15 02:32:40 +00003046 OS << ", align=" << Layout.getAlignment().getQuantity() << '\n';
Eli Benderskyf6f93ee2012-12-08 00:07:24 +00003047
3048 PrintIndentNoOffset(OS, IndentLevel - 1);
3049 OS << " nvsize=" << Layout.getNonVirtualSize().getQuantity();
Warren Huntd640d7d2014-01-09 00:30:56 +00003050 OS << ", nvalign=" << Layout.getNonVirtualAlignment().getQuantity() << "]\n";
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003051 OS << '\n';
3052}
Daniel Dunbarccabe482010-04-19 20:44:53 +00003053
3054void ASTContext::DumpRecordLayout(const RecordDecl *RD,
Douglas Gregore9fc3772012-01-26 07:55:45 +00003055 raw_ostream &OS,
3056 bool Simple) const {
Daniel Dunbarccabe482010-04-19 20:44:53 +00003057 const ASTRecordLayout &Info = getASTRecordLayout(RD);
3058
3059 if (const CXXRecordDecl *CXXRD = dyn_cast<CXXRecordDecl>(RD))
Douglas Gregore9fc3772012-01-26 07:55:45 +00003060 if (!Simple)
3061 return DumpCXXRecordLayout(OS, CXXRD, *this, CharUnits(), 0, 0,
3062 /*IncludeVirtualBases=*/true);
Daniel Dunbarccabe482010-04-19 20:44:53 +00003063
3064 OS << "Type: " << getTypeDeclType(RD).getAsString() << "\n";
Douglas Gregore9fc3772012-01-26 07:55:45 +00003065 if (!Simple) {
3066 OS << "Record: ";
3067 RD->dump();
3068 }
Daniel Dunbarccabe482010-04-19 20:44:53 +00003069 OS << "\nLayout: ";
3070 OS << "<ASTRecordLayout\n";
Ken Dyckb0fcc592011-02-11 01:54:29 +00003071 OS << " Size:" << toBits(Info.getSize()) << "\n";
Warren Hunt8f8bad72013-10-11 20:19:00 +00003072 if (!isMsLayout(RD))
3073 OS << " DataSize:" << toBits(Info.getDataSize()) << "\n";
Ken Dyck7ad11e72011-02-15 02:32:40 +00003074 OS << " Alignment:" << toBits(Info.getAlignment()) << "\n";
Daniel Dunbarccabe482010-04-19 20:44:53 +00003075 OS << " FieldOffsets: [";
3076 for (unsigned i = 0, e = Info.getFieldCount(); i != e; ++i) {
3077 if (i) OS << ", ";
3078 OS << Info.getFieldOffset(i);
3079 }
3080 OS << "]>\n";
3081}