blob: 5c1d43b0f4ba13ae1a4796938f0fbd1ac0b5d7b0 [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"
Chandler Carruth3a022472012-12-04 09:13:33 +000021#include "llvm/Support/Format.h"
22#include "llvm/Support/MathExtras.h"
Anders Carlsson79474332009-07-18 20:20:21 +000023
24using namespace clang;
25
Benjamin Kramerc7656cd2010-05-26 09:58:31 +000026namespace {
Anders Carlssonf58de112010-05-26 15:32:58 +000027
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000028/// BaseSubobjectInfo - Represents a single base subobject in a complete class.
29/// For a class hierarchy like
30///
31/// class A { };
32/// class B : A { };
33/// class C : A, B { };
34///
35/// The BaseSubobjectInfo graph for C will have three BaseSubobjectInfo
36/// instances, one for B and two for A.
37///
38/// If a base is virtual, it will only have one BaseSubobjectInfo allocated.
39struct BaseSubobjectInfo {
40 /// Class - The class for this base info.
Anders Carlsson056818f2010-05-28 21:13:31 +000041 const CXXRecordDecl *Class;
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000042
43 /// IsVirtual - Whether the BaseInfo represents a virtual base or not.
Anders Carlsson056818f2010-05-28 21:13:31 +000044 bool IsVirtual;
45
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000046 /// Bases - Information about the base subobjects.
Chris Lattner0e62c1c2011-07-23 10:55:15 +000047 SmallVector<BaseSubobjectInfo*, 4> Bases;
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000048
Anders Carlssone3c24c72010-05-29 17:35:14 +000049 /// PrimaryVirtualBaseInfo - Holds the base info for the primary virtual base
50 /// of this base info (if one exists).
51 BaseSubobjectInfo *PrimaryVirtualBaseInfo;
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000052
53 // FIXME: Document.
54 const BaseSubobjectInfo *Derived;
Anders Carlsson056818f2010-05-28 21:13:31 +000055};
56
Reid Kleckner8b6d0342015-02-25 19:17:45 +000057/// \brief Externally provided layout. Typically used when the AST source, such
58/// as DWARF, lacks all the information that was available at compile time, such
59/// as alignment attributes on fields and pragmas in effect.
60struct ExternalLayout {
61 ExternalLayout() : Size(0), Align(0) {}
62
63 /// \brief Overall record size in bits.
64 uint64_t Size;
65
66 /// \brief Overall record alignment in bits.
67 uint64_t Align;
68
69 /// \brief Record field offsets in bits.
70 llvm::DenseMap<const FieldDecl *, uint64_t> FieldOffsets;
71
72 /// \brief Direct, non-virtual base offsets.
73 llvm::DenseMap<const CXXRecordDecl *, CharUnits> BaseOffsets;
74
75 /// \brief Virtual base offsets.
76 llvm::DenseMap<const CXXRecordDecl *, CharUnits> VirtualBaseOffsets;
77
78 /// Get the offset of the given field. The external source must provide
79 /// entries for all fields in the record.
80 uint64_t getExternalFieldOffset(const FieldDecl *FD) {
81 assert(FieldOffsets.count(FD) &&
82 "Field does not have an external offset");
83 return FieldOffsets[FD];
84 }
85
86 bool getExternalNVBaseOffset(const CXXRecordDecl *RD, CharUnits &BaseOffset) {
87 auto Known = BaseOffsets.find(RD);
88 if (Known == BaseOffsets.end())
89 return false;
90 BaseOffset = Known->second;
91 return true;
92 }
93
94 bool getExternalVBaseOffset(const CXXRecordDecl *RD, CharUnits &BaseOffset) {
95 auto Known = VirtualBaseOffsets.find(RD);
96 if (Known == VirtualBaseOffsets.end())
97 return false;
98 BaseOffset = Known->second;
99 return true;
100 }
101};
102
Anders Carlssonf58de112010-05-26 15:32:58 +0000103/// EmptySubobjectMap - Keeps track of which empty subobjects exist at different
104/// offsets while laying out a C++ class.
105class EmptySubobjectMap {
Jay Foad39c79802011-01-12 09:06:06 +0000106 const ASTContext &Context;
Anders Carlsson233e2722010-10-31 21:54:55 +0000107 uint64_t CharWidth;
108
Anders Carlssonf58de112010-05-26 15:32:58 +0000109 /// Class - The class whose empty entries we're keeping track of.
110 const CXXRecordDecl *Class;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000111
Anders Carlsson439edd12010-05-27 05:41:06 +0000112 /// EmptyClassOffsets - A map from offsets to empty record decls.
Benjamin Kramer834652a2014-05-03 18:44:26 +0000113 typedef llvm::TinyPtrVector<const CXXRecordDecl *> ClassVectorTy;
Anders Carlssonf8f756d2010-10-31 21:22:43 +0000114 typedef llvm::DenseMap<CharUnits, ClassVectorTy> EmptyClassOffsetsMapTy;
Anders Carlsson439edd12010-05-27 05:41:06 +0000115 EmptyClassOffsetsMapTy EmptyClassOffsets;
116
Anders Carlssoncc5de092010-06-08 15:56:03 +0000117 /// MaxEmptyClassOffset - The highest offset known to contain an empty
118 /// base subobject.
Anders Carlsson725190f2010-10-31 21:39:24 +0000119 CharUnits MaxEmptyClassOffset;
Anders Carlssoncc5de092010-06-08 15:56:03 +0000120
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000121 /// ComputeEmptySubobjectSizes - Compute the size of the largest base or
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000122 /// member subobject that is empty.
123 void ComputeEmptySubobjectSizes();
Anders Carlsson439edd12010-05-27 05:41:06 +0000124
Anders Carlsson725190f2010-10-31 21:39:24 +0000125 void AddSubobjectAtOffset(const CXXRecordDecl *RD, CharUnits Offset);
Anders Carlssondb319762010-05-27 18:20:57 +0000126
Anders Carlssona7f3cdb2010-05-28 21:24:37 +0000127 void UpdateEmptyBaseSubobjects(const BaseSubobjectInfo *Info,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000128 CharUnits Offset, bool PlacingEmptyBase);
Anders Carlsson439edd12010-05-27 05:41:06 +0000129
Anders Carlssondb319762010-05-27 18:20:57 +0000130 void UpdateEmptyFieldSubobjects(const CXXRecordDecl *RD,
131 const CXXRecordDecl *Class,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000132 CharUnits Offset);
133 void UpdateEmptyFieldSubobjects(const FieldDecl *FD, CharUnits Offset);
Anders Carlssondb319762010-05-27 18:20:57 +0000134
Anders Carlssoncc5de092010-06-08 15:56:03 +0000135 /// AnyEmptySubobjectsBeyondOffset - Returns whether there are any empty
136 /// subobjects beyond the given offset.
Anders Carlsson725190f2010-10-31 21:39:24 +0000137 bool AnyEmptySubobjectsBeyondOffset(CharUnits Offset) const {
Anders Carlssoncc5de092010-06-08 15:56:03 +0000138 return Offset <= MaxEmptyClassOffset;
139 }
140
Anders Carlsson233e2722010-10-31 21:54:55 +0000141 CharUnits
142 getFieldOffset(const ASTRecordLayout &Layout, unsigned FieldNo) const {
143 uint64_t FieldOffset = Layout.getFieldOffset(FieldNo);
144 assert(FieldOffset % CharWidth == 0 &&
145 "Field offset not at char boundary!");
146
Ken Dyck7c4026b2011-01-24 01:28:50 +0000147 return Context.toCharUnitsFromBits(FieldOffset);
Anders Carlssonf8f756d2010-10-31 21:22:43 +0000148 }
Anders Carlssonf8f756d2010-10-31 21:22:43 +0000149
Charles Davisc2c576a2010-08-19 00:55:19 +0000150protected:
Anders Carlsson725190f2010-10-31 21:39:24 +0000151 bool CanPlaceSubobjectAtOffset(const CXXRecordDecl *RD,
152 CharUnits Offset) const;
Charles Davisc2c576a2010-08-19 00:55:19 +0000153
154 bool CanPlaceBaseSubobjectAtOffset(const BaseSubobjectInfo *Info,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000155 CharUnits Offset);
Charles Davisc2c576a2010-08-19 00:55:19 +0000156
157 bool CanPlaceFieldSubobjectAtOffset(const CXXRecordDecl *RD,
158 const CXXRecordDecl *Class,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000159 CharUnits Offset) const;
Charles Davisc2c576a2010-08-19 00:55:19 +0000160 bool CanPlaceFieldSubobjectAtOffset(const FieldDecl *FD,
Anders Carlsson233e2722010-10-31 21:54:55 +0000161 CharUnits Offset) const;
Charles Davisc2c576a2010-08-19 00:55:19 +0000162
Anders Carlssonf58de112010-05-26 15:32:58 +0000163public:
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000164 /// This holds the size of the largest empty subobject (either a base
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000165 /// or a member). Will be zero if the record being built doesn't contain
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000166 /// any empty classes.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000167 CharUnits SizeOfLargestEmptySubobject;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000168
Jay Foad39c79802011-01-12 09:06:06 +0000169 EmptySubobjectMap(const ASTContext &Context, const CXXRecordDecl *Class)
Anders Carlsson28466ab2010-10-31 22:13:23 +0000170 : Context(Context), CharWidth(Context.getCharWidth()), Class(Class) {
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000171 ComputeEmptySubobjectSizes();
172 }
173
174 /// CanPlaceBaseAtOffset - Return whether the given base class can be placed
175 /// at the given offset.
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000176 /// Returns false if placing the record will result in two components
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000177 /// (direct or indirect) of the same type having the same offset.
Anders Carlssoncc5de092010-06-08 15:56:03 +0000178 bool CanPlaceBaseAtOffset(const BaseSubobjectInfo *Info,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000179 CharUnits Offset);
Anders Carlssondb319762010-05-27 18:20:57 +0000180
181 /// CanPlaceFieldAtOffset - Return whether a field can be placed at the given
182 /// offset.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000183 bool CanPlaceFieldAtOffset(const FieldDecl *FD, CharUnits Offset);
Anders Carlssonf58de112010-05-26 15:32:58 +0000184};
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000185
186void EmptySubobjectMap::ComputeEmptySubobjectSizes() {
187 // Check the bases.
David Majnemerc964b4b2014-07-16 06:04:00 +0000188 for (const CXXBaseSpecifier &Base : Class->bases()) {
189 const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl();
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000190
Anders Carlsson28466ab2010-10-31 22:13:23 +0000191 CharUnits EmptySize;
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000192 const ASTRecordLayout &Layout = Context.getASTRecordLayout(BaseDecl);
193 if (BaseDecl->isEmpty()) {
194 // If the class decl is empty, get its size.
Ken Dyckc8ae5502011-02-09 01:59:34 +0000195 EmptySize = Layout.getSize();
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000196 } else {
197 // Otherwise, we get the largest empty subobject for the decl.
198 EmptySize = Layout.getSizeOfLargestEmptySubobject();
199 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000200
Anders Carlsson28466ab2010-10-31 22:13:23 +0000201 if (EmptySize > SizeOfLargestEmptySubobject)
202 SizeOfLargestEmptySubobject = EmptySize;
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000203 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000204
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000205 // Check the fields.
David Majnemerc964b4b2014-07-16 06:04:00 +0000206 for (const FieldDecl *FD : Class->fields()) {
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000207 const RecordType *RT =
David Majnemerc964b4b2014-07-16 06:04:00 +0000208 Context.getBaseElementType(FD->getType())->getAs<RecordType>();
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000209
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000210 // We only care about record types.
211 if (!RT)
212 continue;
213
Anders Carlsson28466ab2010-10-31 22:13:23 +0000214 CharUnits EmptySize;
Reid Klecknercd612ab2014-04-11 16:57:42 +0000215 const CXXRecordDecl *MemberDecl = RT->getAsCXXRecordDecl();
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000216 const ASTRecordLayout &Layout = Context.getASTRecordLayout(MemberDecl);
217 if (MemberDecl->isEmpty()) {
218 // If the class decl is empty, get its size.
Ken Dyckc8ae5502011-02-09 01:59:34 +0000219 EmptySize = Layout.getSize();
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000220 } else {
221 // Otherwise, we get the largest empty subobject for the decl.
222 EmptySize = Layout.getSizeOfLargestEmptySubobject();
223 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000224
Anders Carlsson28466ab2010-10-31 22:13:23 +0000225 if (EmptySize > SizeOfLargestEmptySubobject)
226 SizeOfLargestEmptySubobject = EmptySize;
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000227 }
228}
229
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000230bool
Anders Carlssondb319762010-05-27 18:20:57 +0000231EmptySubobjectMap::CanPlaceSubobjectAtOffset(const CXXRecordDecl *RD,
Anders Carlsson725190f2010-10-31 21:39:24 +0000232 CharUnits Offset) const {
Anders Carlssondb319762010-05-27 18:20:57 +0000233 // We only need to check empty bases.
234 if (!RD->isEmpty())
235 return true;
236
Anders Carlsson725190f2010-10-31 21:39:24 +0000237 EmptyClassOffsetsMapTy::const_iterator I = EmptyClassOffsets.find(Offset);
Anders Carlssondb319762010-05-27 18:20:57 +0000238 if (I == EmptyClassOffsets.end())
239 return true;
David Majnemerc964b4b2014-07-16 06:04:00 +0000240
241 const ClassVectorTy &Classes = I->second;
Anders Carlssondb319762010-05-27 18:20:57 +0000242 if (std::find(Classes.begin(), Classes.end(), RD) == Classes.end())
243 return true;
244
245 // There is already an empty class of the same type at this offset.
246 return false;
247}
248
249void EmptySubobjectMap::AddSubobjectAtOffset(const CXXRecordDecl *RD,
Anders Carlsson725190f2010-10-31 21:39:24 +0000250 CharUnits Offset) {
Anders Carlssondb319762010-05-27 18:20:57 +0000251 // We only care about empty bases.
252 if (!RD->isEmpty())
253 return;
254
Reid Kleckner369f3162013-05-14 20:30:42 +0000255 // If we have empty structures inside a union, we can assign both
Rafael Espindola7bcde192010-12-29 23:02:58 +0000256 // the same offset. Just avoid pushing them twice in the list.
David Majnemerc964b4b2014-07-16 06:04:00 +0000257 ClassVectorTy &Classes = EmptyClassOffsets[Offset];
Rafael Espindola7bcde192010-12-29 23:02:58 +0000258 if (std::find(Classes.begin(), Classes.end(), RD) != Classes.end())
259 return;
260
Anders Carlssondb319762010-05-27 18:20:57 +0000261 Classes.push_back(RD);
Anders Carlssoncc5de092010-06-08 15:56:03 +0000262
263 // Update the empty class offset.
Anders Carlsson725190f2010-10-31 21:39:24 +0000264 if (Offset > MaxEmptyClassOffset)
265 MaxEmptyClassOffset = Offset;
Anders Carlssondb319762010-05-27 18:20:57 +0000266}
267
268bool
Anders Carlsson28466ab2010-10-31 22:13:23 +0000269EmptySubobjectMap::CanPlaceBaseSubobjectAtOffset(const BaseSubobjectInfo *Info,
270 CharUnits Offset) {
Anders Carlsson45c1d282010-06-08 16:20:35 +0000271 // We don't have to keep looking past the maximum offset that's known to
272 // contain an empty class.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000273 if (!AnyEmptySubobjectsBeyondOffset(Offset))
Anders Carlsson45c1d282010-06-08 16:20:35 +0000274 return true;
275
Anders Carlsson28466ab2010-10-31 22:13:23 +0000276 if (!CanPlaceSubobjectAtOffset(Info->Class, Offset))
Anders Carlssondb319762010-05-27 18:20:57 +0000277 return false;
278
Anders Carlsson439edd12010-05-27 05:41:06 +0000279 // Traverse all non-virtual bases.
Anders Carlssona7774a62010-05-29 21:10:24 +0000280 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Info->Class);
David Majnemerc964b4b2014-07-16 06:04:00 +0000281 for (const BaseSubobjectInfo *Base : Info->Bases) {
Anders Carlsson439edd12010-05-27 05:41:06 +0000282 if (Base->IsVirtual)
283 continue;
284
Anders Carlsson0a14ee92010-11-01 00:21:58 +0000285 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base->Class);
Anders Carlsson439edd12010-05-27 05:41:06 +0000286
287 if (!CanPlaceBaseSubobjectAtOffset(Base, BaseOffset))
288 return false;
289 }
290
Anders Carlssone3c24c72010-05-29 17:35:14 +0000291 if (Info->PrimaryVirtualBaseInfo) {
292 BaseSubobjectInfo *PrimaryVirtualBaseInfo = Info->PrimaryVirtualBaseInfo;
Anders Carlsson439edd12010-05-27 05:41:06 +0000293
294 if (Info == PrimaryVirtualBaseInfo->Derived) {
295 if (!CanPlaceBaseSubobjectAtOffset(PrimaryVirtualBaseInfo, Offset))
296 return false;
297 }
298 }
299
Anders Carlssondb319762010-05-27 18:20:57 +0000300 // Traverse all member variables.
301 unsigned FieldNo = 0;
302 for (CXXRecordDecl::field_iterator I = Info->Class->field_begin(),
303 E = Info->Class->field_end(); I != E; ++I, ++FieldNo) {
David Blaikie40ed2972012-06-06 20:45:41 +0000304 if (I->isBitField())
Anders Carlsson233e2722010-10-31 21:54:55 +0000305 continue;
David Majnemerc964b4b2014-07-16 06:04:00 +0000306
Anders Carlsson28466ab2010-10-31 22:13:23 +0000307 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
David Blaikie40ed2972012-06-06 20:45:41 +0000308 if (!CanPlaceFieldSubobjectAtOffset(*I, FieldOffset))
Anders Carlssondb319762010-05-27 18:20:57 +0000309 return false;
310 }
David Majnemerc964b4b2014-07-16 06:04:00 +0000311
Anders Carlsson439edd12010-05-27 05:41:06 +0000312 return true;
313}
314
Anders Carlssona7f3cdb2010-05-28 21:24:37 +0000315void EmptySubobjectMap::UpdateEmptyBaseSubobjects(const BaseSubobjectInfo *Info,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000316 CharUnits Offset,
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000317 bool PlacingEmptyBase) {
318 if (!PlacingEmptyBase && Offset >= SizeOfLargestEmptySubobject) {
319 // We know that the only empty subobjects that can conflict with empty
320 // subobject of non-empty bases, are empty bases that can be placed at
321 // offset zero. Because of this, we only need to keep track of empty base
322 // subobjects with offsets less than the size of the largest empty
323 // subobject for our class.
324 return;
325 }
326
Anders Carlsson28466ab2010-10-31 22:13:23 +0000327 AddSubobjectAtOffset(Info->Class, Offset);
Anders Carlssona7774a62010-05-29 21:10:24 +0000328
Anders Carlsson439edd12010-05-27 05:41:06 +0000329 // Traverse all non-virtual bases.
Anders Carlssona7774a62010-05-29 21:10:24 +0000330 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Info->Class);
David Majnemerc964b4b2014-07-16 06:04:00 +0000331 for (const BaseSubobjectInfo *Base : Info->Bases) {
Anders Carlsson439edd12010-05-27 05:41:06 +0000332 if (Base->IsVirtual)
333 continue;
Anders Carlssona7774a62010-05-29 21:10:24 +0000334
Anders Carlsson0a14ee92010-11-01 00:21:58 +0000335 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base->Class);
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000336 UpdateEmptyBaseSubobjects(Base, BaseOffset, PlacingEmptyBase);
Anders Carlsson439edd12010-05-27 05:41:06 +0000337 }
338
Anders Carlssone3c24c72010-05-29 17:35:14 +0000339 if (Info->PrimaryVirtualBaseInfo) {
340 BaseSubobjectInfo *PrimaryVirtualBaseInfo = Info->PrimaryVirtualBaseInfo;
Anders Carlsson439edd12010-05-27 05:41:06 +0000341
342 if (Info == PrimaryVirtualBaseInfo->Derived)
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000343 UpdateEmptyBaseSubobjects(PrimaryVirtualBaseInfo, Offset,
344 PlacingEmptyBase);
Anders Carlsson439edd12010-05-27 05:41:06 +0000345 }
Anders Carlssondb319762010-05-27 18:20:57 +0000346
Anders Carlssondb319762010-05-27 18:20:57 +0000347 // Traverse all member variables.
348 unsigned FieldNo = 0;
349 for (CXXRecordDecl::field_iterator I = Info->Class->field_begin(),
350 E = Info->Class->field_end(); I != E; ++I, ++FieldNo) {
David Blaikie40ed2972012-06-06 20:45:41 +0000351 if (I->isBitField())
Anders Carlsson233e2722010-10-31 21:54:55 +0000352 continue;
Anders Carlssona7774a62010-05-29 21:10:24 +0000353
Anders Carlsson28466ab2010-10-31 22:13:23 +0000354 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
David Blaikie40ed2972012-06-06 20:45:41 +0000355 UpdateEmptyFieldSubobjects(*I, FieldOffset);
Anders Carlssondb319762010-05-27 18:20:57 +0000356 }
Anders Carlsson439edd12010-05-27 05:41:06 +0000357}
358
Anders Carlssona60b86a2010-05-29 20:49:49 +0000359bool EmptySubobjectMap::CanPlaceBaseAtOffset(const BaseSubobjectInfo *Info,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000360 CharUnits Offset) {
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000361 // If we know this class doesn't have any empty subobjects we don't need to
362 // bother checking.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000363 if (SizeOfLargestEmptySubobject.isZero())
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000364 return true;
365
Anders Carlsson439edd12010-05-27 05:41:06 +0000366 if (!CanPlaceBaseSubobjectAtOffset(Info, Offset))
367 return false;
Anders Carlssondb319762010-05-27 18:20:57 +0000368
369 // We are able to place the base at this offset. Make sure to update the
370 // empty base subobject map.
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000371 UpdateEmptyBaseSubobjects(Info, Offset, Info->Class->isEmpty());
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000372 return true;
373}
374
Anders Carlssondb319762010-05-27 18:20:57 +0000375bool
376EmptySubobjectMap::CanPlaceFieldSubobjectAtOffset(const CXXRecordDecl *RD,
377 const CXXRecordDecl *Class,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000378 CharUnits Offset) const {
Anders Carlsson45c1d282010-06-08 16:20:35 +0000379 // We don't have to keep looking past the maximum offset that's known to
380 // contain an empty class.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000381 if (!AnyEmptySubobjectsBeyondOffset(Offset))
Anders Carlsson45c1d282010-06-08 16:20:35 +0000382 return true;
383
Anders Carlsson28466ab2010-10-31 22:13:23 +0000384 if (!CanPlaceSubobjectAtOffset(RD, Offset))
Anders Carlssondb319762010-05-27 18:20:57 +0000385 return false;
386
387 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
388
389 // Traverse all non-virtual bases.
David Majnemerc964b4b2014-07-16 06:04:00 +0000390 for (const CXXBaseSpecifier &Base : RD->bases()) {
391 if (Base.isVirtual())
Anders Carlssondb319762010-05-27 18:20:57 +0000392 continue;
393
David Majnemerc964b4b2014-07-16 06:04:00 +0000394 const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl();
Anders Carlssondb319762010-05-27 18:20:57 +0000395
Anders Carlsson0a14ee92010-11-01 00:21:58 +0000396 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(BaseDecl);
Anders Carlssondb319762010-05-27 18:20:57 +0000397 if (!CanPlaceFieldSubobjectAtOffset(BaseDecl, Class, BaseOffset))
398 return false;
399 }
400
Anders Carlsson44687202010-06-08 19:09:24 +0000401 if (RD == Class) {
402 // This is the most derived class, traverse virtual bases as well.
David Majnemerc964b4b2014-07-16 06:04:00 +0000403 for (const CXXBaseSpecifier &Base : RD->vbases()) {
404 const CXXRecordDecl *VBaseDecl = Base.getType()->getAsCXXRecordDecl();
Reid Klecknercd612ab2014-04-11 16:57:42 +0000405
Anders Carlsson3f018712010-10-31 23:45:59 +0000406 CharUnits VBaseOffset = Offset + Layout.getVBaseClassOffset(VBaseDecl);
Anders Carlsson44687202010-06-08 19:09:24 +0000407 if (!CanPlaceFieldSubobjectAtOffset(VBaseDecl, Class, VBaseOffset))
408 return false;
409 }
410 }
411
Anders Carlssondb319762010-05-27 18:20:57 +0000412 // Traverse all member variables.
413 unsigned FieldNo = 0;
414 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
415 I != E; ++I, ++FieldNo) {
David Blaikie40ed2972012-06-06 20:45:41 +0000416 if (I->isBitField())
Anders Carlsson233e2722010-10-31 21:54:55 +0000417 continue;
418
Anders Carlsson28466ab2010-10-31 22:13:23 +0000419 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
Anders Carlssondb319762010-05-27 18:20:57 +0000420
David Blaikie40ed2972012-06-06 20:45:41 +0000421 if (!CanPlaceFieldSubobjectAtOffset(*I, FieldOffset))
Anders Carlssondb319762010-05-27 18:20:57 +0000422 return false;
423 }
424
425 return true;
426}
427
Anders Carlsson233e2722010-10-31 21:54:55 +0000428bool
429EmptySubobjectMap::CanPlaceFieldSubobjectAtOffset(const FieldDecl *FD,
430 CharUnits Offset) const {
Anders Carlsson45c1d282010-06-08 16:20:35 +0000431 // We don't have to keep looking past the maximum offset that's known to
432 // contain an empty class.
Anders Carlsson233e2722010-10-31 21:54:55 +0000433 if (!AnyEmptySubobjectsBeyondOffset(Offset))
Anders Carlsson45c1d282010-06-08 16:20:35 +0000434 return true;
435
Anders Carlssondb319762010-05-27 18:20:57 +0000436 QualType T = FD->getType();
Reid Klecknercd612ab2014-04-11 16:57:42 +0000437 if (const CXXRecordDecl *RD = T->getAsCXXRecordDecl())
Anders Carlsson28466ab2010-10-31 22:13:23 +0000438 return CanPlaceFieldSubobjectAtOffset(RD, RD, Offset);
Anders Carlssondb319762010-05-27 18:20:57 +0000439
440 // If we have an array type we need to look at every element.
441 if (const ConstantArrayType *AT = Context.getAsConstantArrayType(T)) {
442 QualType ElemTy = Context.getBaseElementType(AT);
443 const RecordType *RT = ElemTy->getAs<RecordType>();
444 if (!RT)
445 return true;
Reid Klecknercd612ab2014-04-11 16:57:42 +0000446
447 const CXXRecordDecl *RD = RT->getAsCXXRecordDecl();
Anders Carlssondb319762010-05-27 18:20:57 +0000448 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
449
450 uint64_t NumElements = Context.getConstantArrayElementCount(AT);
Anders Carlsson233e2722010-10-31 21:54:55 +0000451 CharUnits ElementOffset = Offset;
Anders Carlssondb319762010-05-27 18:20:57 +0000452 for (uint64_t I = 0; I != NumElements; ++I) {
Anders Carlsson45c1d282010-06-08 16:20:35 +0000453 // We don't have to keep looking past the maximum offset that's known to
454 // contain an empty class.
Anders Carlsson233e2722010-10-31 21:54:55 +0000455 if (!AnyEmptySubobjectsBeyondOffset(ElementOffset))
Anders Carlsson45c1d282010-06-08 16:20:35 +0000456 return true;
457
Anders Carlsson28466ab2010-10-31 22:13:23 +0000458 if (!CanPlaceFieldSubobjectAtOffset(RD, RD, ElementOffset))
Anders Carlssondb319762010-05-27 18:20:57 +0000459 return false;
460
Ken Dyckc8ae5502011-02-09 01:59:34 +0000461 ElementOffset += Layout.getSize();
Anders Carlssondb319762010-05-27 18:20:57 +0000462 }
463 }
464
465 return true;
466}
467
468bool
Anders Carlsson28466ab2010-10-31 22:13:23 +0000469EmptySubobjectMap::CanPlaceFieldAtOffset(const FieldDecl *FD,
470 CharUnits Offset) {
471 if (!CanPlaceFieldSubobjectAtOffset(FD, Offset))
Anders Carlssondb319762010-05-27 18:20:57 +0000472 return false;
473
474 // We are able to place the member variable at this offset.
475 // Make sure to update the empty base subobject map.
476 UpdateEmptyFieldSubobjects(FD, Offset);
477 return true;
478}
479
480void EmptySubobjectMap::UpdateEmptyFieldSubobjects(const CXXRecordDecl *RD,
481 const CXXRecordDecl *Class,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000482 CharUnits Offset) {
Anders Carlssonae111dc2010-06-13 17:49:16 +0000483 // We know that the only empty subobjects that can conflict with empty
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000484 // field subobjects are subobjects of empty bases that can be placed at offset
Anders Carlssonae111dc2010-06-13 17:49:16 +0000485 // zero. Because of this, we only need to keep track of empty field
486 // subobjects with offsets less than the size of the largest empty
487 // subobject for our class.
488 if (Offset >= SizeOfLargestEmptySubobject)
489 return;
490
Anders Carlsson28466ab2010-10-31 22:13:23 +0000491 AddSubobjectAtOffset(RD, Offset);
Anders Carlssondb319762010-05-27 18:20:57 +0000492
493 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
494
495 // Traverse all non-virtual bases.
David Majnemerc964b4b2014-07-16 06:04:00 +0000496 for (const CXXBaseSpecifier &Base : RD->bases()) {
497 if (Base.isVirtual())
Anders Carlssondb319762010-05-27 18:20:57 +0000498 continue;
499
David Majnemerc964b4b2014-07-16 06:04:00 +0000500 const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl();
Anders Carlssondb319762010-05-27 18:20:57 +0000501
Anders Carlsson0a14ee92010-11-01 00:21:58 +0000502 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(BaseDecl);
Anders Carlssondb319762010-05-27 18:20:57 +0000503 UpdateEmptyFieldSubobjects(BaseDecl, Class, BaseOffset);
504 }
505
Anders Carlsson44687202010-06-08 19:09:24 +0000506 if (RD == Class) {
507 // This is the most derived class, traverse virtual bases as well.
David Majnemerc964b4b2014-07-16 06:04:00 +0000508 for (const CXXBaseSpecifier &Base : RD->vbases()) {
509 const CXXRecordDecl *VBaseDecl = Base.getType()->getAsCXXRecordDecl();
Reid Klecknercd612ab2014-04-11 16:57:42 +0000510
Anders Carlsson3f018712010-10-31 23:45:59 +0000511 CharUnits VBaseOffset = Offset + Layout.getVBaseClassOffset(VBaseDecl);
Anders Carlsson44687202010-06-08 19:09:24 +0000512 UpdateEmptyFieldSubobjects(VBaseDecl, Class, VBaseOffset);
513 }
514 }
515
Anders Carlssondb319762010-05-27 18:20:57 +0000516 // Traverse all member variables.
517 unsigned FieldNo = 0;
518 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
519 I != E; ++I, ++FieldNo) {
David Blaikie40ed2972012-06-06 20:45:41 +0000520 if (I->isBitField())
Anders Carlsson09814d32010-11-01 15:14:51 +0000521 continue;
522
Anders Carlsson28466ab2010-10-31 22:13:23 +0000523 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
Anders Carlssondb319762010-05-27 18:20:57 +0000524
David Blaikie40ed2972012-06-06 20:45:41 +0000525 UpdateEmptyFieldSubobjects(*I, FieldOffset);
Anders Carlssondb319762010-05-27 18:20:57 +0000526 }
527}
528
529void EmptySubobjectMap::UpdateEmptyFieldSubobjects(const FieldDecl *FD,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000530 CharUnits Offset) {
Anders Carlssondb319762010-05-27 18:20:57 +0000531 QualType T = FD->getType();
Reid Klecknercd612ab2014-04-11 16:57:42 +0000532 if (const CXXRecordDecl *RD = T->getAsCXXRecordDecl()) {
Anders Carlssondb319762010-05-27 18:20:57 +0000533 UpdateEmptyFieldSubobjects(RD, RD, Offset);
534 return;
535 }
536
537 // If we have an array type we need to update every element.
538 if (const ConstantArrayType *AT = Context.getAsConstantArrayType(T)) {
539 QualType ElemTy = Context.getBaseElementType(AT);
540 const RecordType *RT = ElemTy->getAs<RecordType>();
541 if (!RT)
542 return;
Reid Klecknercd612ab2014-04-11 16:57:42 +0000543
544 const CXXRecordDecl *RD = RT->getAsCXXRecordDecl();
Anders Carlssondb319762010-05-27 18:20:57 +0000545 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
546
547 uint64_t NumElements = Context.getConstantArrayElementCount(AT);
Anders Carlsson28466ab2010-10-31 22:13:23 +0000548 CharUnits ElementOffset = Offset;
Anders Carlssondb319762010-05-27 18:20:57 +0000549
550 for (uint64_t I = 0; I != NumElements; ++I) {
Anders Carlssonae111dc2010-06-13 17:49:16 +0000551 // We know that the only empty subobjects that can conflict with empty
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000552 // field subobjects are subobjects of empty bases that can be placed at
Anders Carlssonae111dc2010-06-13 17:49:16 +0000553 // offset zero. Because of this, we only need to keep track of empty field
554 // subobjects with offsets less than the size of the largest empty
555 // subobject for our class.
556 if (ElementOffset >= SizeOfLargestEmptySubobject)
557 return;
558
Anders Carlssondb319762010-05-27 18:20:57 +0000559 UpdateEmptyFieldSubobjects(RD, RD, ElementOffset);
Ken Dyckc8ae5502011-02-09 01:59:34 +0000560 ElementOffset += Layout.getSize();
Anders Carlssondb319762010-05-27 18:20:57 +0000561 }
562 }
563}
564
John McCalle42a3362012-05-01 08:55:32 +0000565typedef llvm::SmallPtrSet<const CXXRecordDecl*, 4> ClassSetTy;
566
David Majnemer3b1c9902015-07-25 20:18:14 +0000567class ItaniumRecordLayoutBuilder {
Charles Davisc2c576a2010-08-19 00:55:19 +0000568protected:
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000569 // FIXME: Remove this and make the appropriate fields public.
570 friend class clang::ASTContext;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000571
Jay Foad39c79802011-01-12 09:06:06 +0000572 const ASTContext &Context;
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000573
Anders Carlssonf58de112010-05-26 15:32:58 +0000574 EmptySubobjectMap *EmptySubobjects;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000575
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000576 /// Size - The current size of the record layout.
577 uint64_t Size;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000578
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000579 /// Alignment - The current alignment of the record layout.
Ken Dyck4731d5b2011-02-16 02:05:21 +0000580 CharUnits Alignment;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000581
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000582 /// \brief The alignment if attribute packed is not used.
Ken Dyck1300b3b2011-02-16 02:11:31 +0000583 CharUnits UnpackedAlignment;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000584
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000585 SmallVector<uint64_t, 16> FieldOffsets;
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000586
Douglas Gregore9fc3772012-01-26 07:55:45 +0000587 /// \brief Whether the external AST source has provided a layout for this
588 /// record.
Reid Kleckner8b6d0342015-02-25 19:17:45 +0000589 unsigned UseExternalLayout : 1;
Douglas Gregor44ba7892012-01-28 00:53:29 +0000590
591 /// \brief Whether we need to infer alignment, even when we have an
592 /// externally-provided layout.
593 unsigned InferAlignment : 1;
Douglas Gregore9fc3772012-01-26 07:55:45 +0000594
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000595 /// Packed - Whether the record is packed or not.
Daniel Dunbar6da10982010-05-27 05:45:51 +0000596 unsigned Packed : 1;
597
598 unsigned IsUnion : 1;
599
600 unsigned IsMac68kAlign : 1;
Fariborz Jahanianbcb23a12011-04-26 23:52:16 +0000601
602 unsigned IsMsStruct : 1;
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000603
Eli Friedman2782dac2013-06-26 20:50:34 +0000604 /// UnfilledBitsInLastUnit - If the last field laid out was a bitfield,
605 /// this contains the number of bits in the last unit that can be used for
606 /// an adjacent bitfield if necessary. The unit in question is usually
607 /// a byte, but larger units are used if IsMsStruct.
608 unsigned char UnfilledBitsInLastUnit;
609 /// LastBitfieldTypeSize - If IsMsStruct, represents the size of the type
610 /// of the previous field if it was a bitfield.
611 unsigned char LastBitfieldTypeSize;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000612
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000613 /// MaxFieldAlignment - The maximum allowed field alignment. This is set by
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000614 /// #pragma pack.
Ken Dyck02ced6f2011-02-17 01:49:42 +0000615 CharUnits MaxFieldAlignment;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000616
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000617 /// DataSize - The data size of the record being laid out.
618 uint64_t DataSize;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000619
Ken Dyckaf1c83f2011-02-16 01:52:01 +0000620 CharUnits NonVirtualSize;
Ken Dycka2d3dda2011-02-16 01:43:15 +0000621 CharUnits NonVirtualAlignment;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000622
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000623 /// PrimaryBase - the primary base class (if one exists) of the class
624 /// we're laying out.
625 const CXXRecordDecl *PrimaryBase;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000626
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000627 /// PrimaryBaseIsVirtual - Whether the primary base of the class we're laying
628 /// out is virtual.
629 bool PrimaryBaseIsVirtual;
630
John McCalle42a3362012-05-01 08:55:32 +0000631 /// HasOwnVFPtr - Whether the class provides its own vtable/vftbl
632 /// pointer, as opposed to inheriting one from a primary base class.
633 bool HasOwnVFPtr;
Eli Friedman43114f92011-10-21 22:49:56 +0000634
Yan Wangd79f3f62017-08-01 21:41:39 +0000635 /// \brief the flag of field offset changing due to packed attribute.
636 bool HasPackedField;
637
Anders Carlsson22f57202010-10-31 21:01:46 +0000638 typedef llvm::DenseMap<const CXXRecordDecl *, CharUnits> BaseOffsetsMapTy;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000639
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000640 /// Bases - base classes and their offsets in the record.
641 BaseOffsetsMapTy Bases;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000642
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000643 // VBases - virtual base classes and their offsets in the record.
John McCalle42a3362012-05-01 08:55:32 +0000644 ASTRecordLayout::VBaseOffsetsMapTy VBases;
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000645
646 /// IndirectPrimaryBases - Virtual base classes, direct or indirect, that are
647 /// primary base classes for some other direct or indirect base class.
Anders Carlsson5adde292010-11-24 22:55:48 +0000648 CXXIndirectPrimaryBaseSet IndirectPrimaryBases;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000649
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000650 /// FirstNearlyEmptyVBase - The first nearly empty virtual base class in
651 /// inheritance graph order. Used for determining the primary base class.
652 const CXXRecordDecl *FirstNearlyEmptyVBase;
653
654 /// VisitedVirtualBases - A set of all the visited virtual bases, used to
655 /// avoid visiting virtual bases more than once.
656 llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBases;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000657
Reid Kleckner8b6d0342015-02-25 19:17:45 +0000658 /// Valid if UseExternalLayout is true.
659 ExternalLayout External;
Douglas Gregore9fc3772012-01-26 07:55:45 +0000660
David Majnemer3b1c9902015-07-25 20:18:14 +0000661 ItaniumRecordLayoutBuilder(const ASTContext &Context,
662 EmptySubobjectMap *EmptySubobjects)
663 : Context(Context), EmptySubobjects(EmptySubobjects), Size(0),
664 Alignment(CharUnits::One()), UnpackedAlignment(CharUnits::One()),
665 UseExternalLayout(false), InferAlignment(false), Packed(false),
666 IsUnion(false), IsMac68kAlign(false), IsMsStruct(false),
667 UnfilledBitsInLastUnit(0), LastBitfieldTypeSize(0),
668 MaxFieldAlignment(CharUnits::Zero()), DataSize(0),
669 NonVirtualSize(CharUnits::Zero()),
670 NonVirtualAlignment(CharUnits::One()), PrimaryBase(nullptr),
671 PrimaryBaseIsVirtual(false), HasOwnVFPtr(false),
Yan Wangd79f3f62017-08-01 21:41:39 +0000672 HasPackedField(false), FirstNearlyEmptyVBase(nullptr) {}
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000673
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000674 void Layout(const RecordDecl *D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000675 void Layout(const CXXRecordDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000676 void Layout(const ObjCInterfaceDecl *D);
677
678 void LayoutFields(const RecordDecl *D);
Kostya Serebryany293dc9b2014-10-16 20:54:52 +0000679 void LayoutField(const FieldDecl *D, bool InsertExtraPadding);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000680 void LayoutWideBitField(uint64_t FieldSize, uint64_t TypeSize,
681 bool FieldPacked, const FieldDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000682 void LayoutBitField(const FieldDecl *D);
John McCall0153cd32011-11-08 04:01:03 +0000683
John McCall359b8852013-01-25 22:30:49 +0000684 TargetCXXABI getCXXABI() const {
685 return Context.getTargetInfo().getCXXABI();
686 }
687
Anders Carlssone3c24c72010-05-29 17:35:14 +0000688 /// BaseSubobjectInfoAllocator - Allocator for BaseSubobjectInfo objects.
689 llvm::SpecificBumpPtrAllocator<BaseSubobjectInfo> BaseSubobjectInfoAllocator;
690
691 typedef llvm::DenseMap<const CXXRecordDecl *, BaseSubobjectInfo *>
692 BaseSubobjectInfoMapTy;
693
694 /// VirtualBaseInfo - Map from all the (direct or indirect) virtual bases
695 /// of the class we're laying out to their base subobject info.
696 BaseSubobjectInfoMapTy VirtualBaseInfo;
697
698 /// NonVirtualBaseInfo - Map from all the direct non-virtual bases of the
699 /// class we're laying out to their base subobject info.
700 BaseSubobjectInfoMapTy NonVirtualBaseInfo;
701
702 /// ComputeBaseSubobjectInfo - Compute the base subobject information for the
703 /// bases of the given class.
704 void ComputeBaseSubobjectInfo(const CXXRecordDecl *RD);
705
706 /// ComputeBaseSubobjectInfo - Compute the base subobject information for a
707 /// single class and all of its base classes.
708 BaseSubobjectInfo *ComputeBaseSubobjectInfo(const CXXRecordDecl *RD,
709 bool IsVirtual,
710 BaseSubobjectInfo *Derived);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000711
712 /// DeterminePrimaryBase - Determine the primary base of the given class.
713 void DeterminePrimaryBase(const CXXRecordDecl *RD);
714
715 void SelectPrimaryVBase(const CXXRecordDecl *RD);
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000716
Eli Friedman43114f92011-10-21 22:49:56 +0000717 void EnsureVTablePointerAlignment(CharUnits UnpackedBaseAlign);
Charles Davisc2c576a2010-08-19 00:55:19 +0000718
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000719 /// LayoutNonVirtualBases - Determines the primary base class (if any) and
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000720 /// lays it out. Will then proceed to lay out all non-virtual base clasess.
721 void LayoutNonVirtualBases(const CXXRecordDecl *RD);
722
723 /// LayoutNonVirtualBase - Lays out a single non-virtual base.
Anders Carlssonbb0e6782010-05-29 17:42:25 +0000724 void LayoutNonVirtualBase(const BaseSubobjectInfo *Base);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000725
Anders Carlssona2f8e412010-10-31 22:20:42 +0000726 void AddPrimaryVirtualBaseOffsets(const BaseSubobjectInfo *Info,
727 CharUnits Offset);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000728
729 /// LayoutVirtualBases - Lays out all the virtual bases.
730 void LayoutVirtualBases(const CXXRecordDecl *RD,
731 const CXXRecordDecl *MostDerivedClass);
732
733 /// LayoutVirtualBase - Lays out a single virtual base.
Warren Hunt55d8e822013-10-23 23:53:07 +0000734 void LayoutVirtualBase(const BaseSubobjectInfo *Base);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000735
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000736 /// LayoutBase - Will lay out a base and return the offset where it was
Anders Carlssona2f8e412010-10-31 22:20:42 +0000737 /// placed, in chars.
738 CharUnits LayoutBase(const BaseSubobjectInfo *Base);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000739
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000740 /// InitializeLayout - Initialize record layout for the given record decl.
Daniel Dunbar6da10982010-05-27 05:45:51 +0000741 void InitializeLayout(const Decl *D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000742
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000743 /// FinishLayout - Finalize record layout. Adjust record size based on the
744 /// alignment.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000745 void FinishLayout(const NamedDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000746
Ken Dyck85ef0432011-02-19 18:58:07 +0000747 void UpdateAlignment(CharUnits NewAlignment, CharUnits UnpackedNewAlignment);
748 void UpdateAlignment(CharUnits NewAlignment) {
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000749 UpdateAlignment(NewAlignment, NewAlignment);
750 }
751
Douglas Gregor44ba7892012-01-28 00:53:29 +0000752 /// \brief Retrieve the externally-supplied field offset for the given
753 /// field.
754 ///
755 /// \param Field The field whose offset is being queried.
756 /// \param ComputedOffset The offset that we've computed for this field.
757 uint64_t updateExternalFieldOffset(const FieldDecl *Field,
758 uint64_t ComputedOffset);
759
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000760 void CheckFieldPadding(uint64_t Offset, uint64_t UnpaddedOffset,
761 uint64_t UnpackedOffset, unsigned UnpackedAlign,
762 bool isPacked, const FieldDecl *D);
763
764 DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000765
Ken Dyckecfc7552011-02-24 01:13:28 +0000766 CharUnits getSize() const {
Ken Dyck3c215f22011-02-24 01:33:05 +0000767 assert(Size % Context.getCharWidth() == 0);
Ken Dyckecfc7552011-02-24 01:13:28 +0000768 return Context.toCharUnitsFromBits(Size);
769 }
770 uint64_t getSizeInBits() const { return Size; }
771
772 void setSize(CharUnits NewSize) { Size = Context.toBits(NewSize); }
773 void setSize(uint64_t NewSize) { Size = NewSize; }
774
Eli Friedman84d2d3a2011-09-27 19:12:27 +0000775 CharUnits getAligment() const { return Alignment; }
776
Ken Dyckecfc7552011-02-24 01:13:28 +0000777 CharUnits getDataSize() const {
Ken Dyck3c215f22011-02-24 01:33:05 +0000778 assert(DataSize % Context.getCharWidth() == 0);
Ken Dyckecfc7552011-02-24 01:13:28 +0000779 return Context.toCharUnitsFromBits(DataSize);
780 }
781 uint64_t getDataSizeInBits() const { return DataSize; }
782
783 void setDataSize(CharUnits NewSize) { DataSize = Context.toBits(NewSize); }
784 void setDataSize(uint64_t NewSize) { DataSize = NewSize; }
785
David Majnemer3b1c9902015-07-25 20:18:14 +0000786 ItaniumRecordLayoutBuilder(const ItaniumRecordLayoutBuilder &) = delete;
787 void operator=(const ItaniumRecordLayoutBuilder &) = delete;
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000788};
Benjamin Kramerc7656cd2010-05-26 09:58:31 +0000789} // end anonymous namespace
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000790
David Majnemer3b1c9902015-07-25 20:18:14 +0000791void ItaniumRecordLayoutBuilder::SelectPrimaryVBase(const CXXRecordDecl *RD) {
Aaron Ballman574705e2014-03-13 15:41:46 +0000792 for (const auto &I : RD->bases()) {
793 assert(!I.getType()->isDependentType() &&
Sebastian Redl1054fae2009-10-25 17:03:50 +0000794 "Cannot layout class with dependent bases.");
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000795
Reid Klecknercd612ab2014-04-11 16:57:42 +0000796 const CXXRecordDecl *Base = I.getType()->getAsCXXRecordDecl();
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000797
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000798 // Check if this is a nearly empty virtual base.
Aaron Ballman574705e2014-03-13 15:41:46 +0000799 if (I.isVirtual() && Context.isNearlyEmpty(Base)) {
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000800 // If it's not an indirect primary base, then we've found our primary
801 // base.
Anders Carlsson81430692009-09-22 03:02:06 +0000802 if (!IndirectPrimaryBases.count(Base)) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000803 PrimaryBase = Base;
804 PrimaryBaseIsVirtual = true;
Mike Stump6f3793b2009-08-12 21:50:08 +0000805 return;
806 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000807
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000808 // Is this the first nearly empty virtual base?
809 if (!FirstNearlyEmptyVBase)
810 FirstNearlyEmptyVBase = Base;
Mike Stump6f3793b2009-08-12 21:50:08 +0000811 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000812
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000813 SelectPrimaryVBase(Base);
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000814 if (PrimaryBase)
Zhongxing Xuec345b72010-02-15 04:28:35 +0000815 return;
Mike Stump6f3793b2009-08-12 21:50:08 +0000816 }
817}
818
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000819/// DeterminePrimaryBase - Determine the primary base of the given class.
David Majnemer3b1c9902015-07-25 20:18:14 +0000820void ItaniumRecordLayoutBuilder::DeterminePrimaryBase(const CXXRecordDecl *RD) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000821 // If the class isn't dynamic, it won't have a primary base.
822 if (!RD->isDynamicClass())
823 return;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000824
Anders Carlsson81430692009-09-22 03:02:06 +0000825 // Compute all the primary virtual bases for all of our direct and
Mike Stump590a7c72009-08-13 23:26:06 +0000826 // indirect bases, and record all their primary virtual base classes.
Anders Carlsson5adde292010-11-24 22:55:48 +0000827 RD->getIndirectPrimaryBases(IndirectPrimaryBases);
Mike Stump590a7c72009-08-13 23:26:06 +0000828
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000829 // If the record has a dynamic base class, attempt to choose a primary base
830 // class. It is the first (in direct base class order) non-virtual dynamic
Anders Carlsson81430692009-09-22 03:02:06 +0000831 // base class, if one exists.
Aaron Ballman574705e2014-03-13 15:41:46 +0000832 for (const auto &I : RD->bases()) {
Anders Carlsson03ff3792009-11-27 22:05:05 +0000833 // Ignore virtual bases.
Aaron Ballman574705e2014-03-13 15:41:46 +0000834 if (I.isVirtual())
Anders Carlsson03ff3792009-11-27 22:05:05 +0000835 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000836
Reid Klecknercd612ab2014-04-11 16:57:42 +0000837 const CXXRecordDecl *Base = I.getType()->getAsCXXRecordDecl();
Anders Carlsson03ff3792009-11-27 22:05:05 +0000838
Warren Hunt55d8e822013-10-23 23:53:07 +0000839 if (Base->isDynamicClass()) {
Anders Carlsson03ff3792009-11-27 22:05:05 +0000840 // We found it.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000841 PrimaryBase = Base;
842 PrimaryBaseIsVirtual = false;
Anders Carlsson03ff3792009-11-27 22:05:05 +0000843 return;
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000844 }
845 }
846
Eli Friedman5e9534b2011-10-18 00:55:28 +0000847 // Under the Itanium ABI, if there is no non-virtual primary base class,
848 // try to compute the primary virtual base. The primary virtual base is
849 // the first nearly empty virtual base that is not an indirect primary
850 // virtual base class, if one exists.
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000851 if (RD->getNumVBases() != 0) {
852 SelectPrimaryVBase(RD);
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000853 if (PrimaryBase)
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000854 return;
855 }
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000856
Eli Friedman5e9534b2011-10-18 00:55:28 +0000857 // Otherwise, it is the first indirect primary base class, if one exists.
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000858 if (FirstNearlyEmptyVBase) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000859 PrimaryBase = FirstNearlyEmptyVBase;
860 PrimaryBaseIsVirtual = true;
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000861 return;
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000862 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000863
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000864 assert(!PrimaryBase && "Should not get here with a primary base!");
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000865}
866
David Majnemer3b1c9902015-07-25 20:18:14 +0000867BaseSubobjectInfo *ItaniumRecordLayoutBuilder::ComputeBaseSubobjectInfo(
868 const CXXRecordDecl *RD, bool IsVirtual, BaseSubobjectInfo *Derived) {
Anders Carlssone3c24c72010-05-29 17:35:14 +0000869 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;
Craig Topper36250ad2014-05-12 05:36:57 +0000888 Info->Derived = nullptr;
889 Info->PrimaryVirtualBaseInfo = nullptr;
890
891 const CXXRecordDecl *PrimaryVirtualBase = nullptr;
892 BaseSubobjectInfo *PrimaryVirtualBaseInfo = nullptr;
Anders Carlssone3c24c72010-05-29 17:35:14 +0000893
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
Craig Topper36250ad2014-05-12 05:36:57 +0000909 // base.
910 PrimaryVirtualBase = nullptr;
Anders Carlssone3c24c72010-05-29 17:35:14 +0000911 } 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.
Aaron Ballman574705e2014-03-13 15:41:46 +0000921 for (const auto &I : RD->bases()) {
922 bool IsVirtual = I.isVirtual();
Reid Klecknercd612ab2014-04-11 16:57:42 +0000923
924 const CXXRecordDecl *BaseDecl = I.getType()->getAsCXXRecordDecl();
925
Anders Carlssone3c24c72010-05-29 17:35:14 +0000926 Info->Bases.push_back(ComputeBaseSubobjectInfo(BaseDecl, IsVirtual, Info));
927 }
928
929 if (PrimaryVirtualBase && !PrimaryVirtualBaseInfo) {
930 // Traversing the bases must have created the base info for our primary
931 // virtual base.
932 PrimaryVirtualBaseInfo = VirtualBaseInfo.lookup(PrimaryVirtualBase);
933 assert(PrimaryVirtualBaseInfo &&
934 "Did not create a primary virtual base!");
935
936 // Claim the primary virtual base as our primary virtual base.
937 Info->PrimaryVirtualBaseInfo = PrimaryVirtualBaseInfo;
938 PrimaryVirtualBaseInfo->Derived = Info;
939 }
940
941 return Info;
942}
943
David Majnemer3b1c9902015-07-25 20:18:14 +0000944void ItaniumRecordLayoutBuilder::ComputeBaseSubobjectInfo(
945 const CXXRecordDecl *RD) {
Aaron Ballman574705e2014-03-13 15:41:46 +0000946 for (const auto &I : RD->bases()) {
947 bool IsVirtual = I.isVirtual();
Anders Carlssone3c24c72010-05-29 17:35:14 +0000948
Reid Klecknercd612ab2014-04-11 16:57:42 +0000949 const CXXRecordDecl *BaseDecl = I.getType()->getAsCXXRecordDecl();
950
Anders Carlssone3c24c72010-05-29 17:35:14 +0000951 // Compute the base subobject info for this base.
Craig Topper36250ad2014-05-12 05:36:57 +0000952 BaseSubobjectInfo *Info = ComputeBaseSubobjectInfo(BaseDecl, IsVirtual,
953 nullptr);
Anders Carlssone3c24c72010-05-29 17:35:14 +0000954
955 if (IsVirtual) {
956 // ComputeBaseInfo has already added this base for us.
957 assert(VirtualBaseInfo.count(BaseDecl) &&
958 "Did not add virtual base!");
959 } else {
960 // Add the base info to the map of non-virtual bases.
961 assert(!NonVirtualBaseInfo.count(BaseDecl) &&
962 "Non-virtual base already exists!");
963 NonVirtualBaseInfo.insert(std::make_pair(BaseDecl, Info));
964 }
965 }
966}
967
David Majnemer3b1c9902015-07-25 20:18:14 +0000968void ItaniumRecordLayoutBuilder::EnsureVTablePointerAlignment(
969 CharUnits UnpackedBaseAlign) {
Eli Friedman5e9534b2011-10-18 00:55:28 +0000970 CharUnits BaseAlign = (Packed) ? CharUnits::One() : UnpackedBaseAlign;
971
972 // The maximum field alignment overrides base align.
973 if (!MaxFieldAlignment.isZero()) {
974 BaseAlign = std::min(BaseAlign, MaxFieldAlignment);
975 UnpackedBaseAlign = std::min(UnpackedBaseAlign, MaxFieldAlignment);
976 }
977
978 // Round up the current record size to pointer alignment.
Rui Ueyama83aa9792016-01-14 21:00:27 +0000979 setSize(getSize().alignTo(BaseAlign));
Eli Friedman43114f92011-10-21 22:49:56 +0000980 setDataSize(getSize());
Eli Friedman5e9534b2011-10-18 00:55:28 +0000981
982 // Update the alignment.
983 UpdateAlignment(BaseAlign, UnpackedBaseAlign);
984}
985
David Majnemer3b1c9902015-07-25 20:18:14 +0000986void ItaniumRecordLayoutBuilder::LayoutNonVirtualBases(
987 const CXXRecordDecl *RD) {
Anders Carlssone3c24c72010-05-29 17:35:14 +0000988 // Then, determine the primary base class.
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000989 DeterminePrimaryBase(RD);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000990
Anders Carlssone3c24c72010-05-29 17:35:14 +0000991 // Compute base subobject info.
992 ComputeBaseSubobjectInfo(RD);
993
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000994 // If we have a primary base class, lay it out.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000995 if (PrimaryBase) {
996 if (PrimaryBaseIsVirtual) {
Anders Carlssone3c24c72010-05-29 17:35:14 +0000997 // If the primary virtual base was a primary virtual base of some other
998 // base class we'll have to steal it.
999 BaseSubobjectInfo *PrimaryBaseInfo = VirtualBaseInfo.lookup(PrimaryBase);
Craig Topper36250ad2014-05-12 05:36:57 +00001000 PrimaryBaseInfo->Derived = nullptr;
1001
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001002 // We have a virtual primary base, insert it as an indirect primary base.
Anders Carlssond20e7cd2010-05-26 05:20:58 +00001003 IndirectPrimaryBases.insert(PrimaryBase);
Anders Carlssonfe900962010-03-11 05:42:17 +00001004
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001005 assert(!VisitedVirtualBases.count(PrimaryBase) &&
Anders Carlssond20e7cd2010-05-26 05:20:58 +00001006 "vbase already visited!");
1007 VisitedVirtualBases.insert(PrimaryBase);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001008
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001009 LayoutVirtualBase(PrimaryBaseInfo);
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001010 } else {
1011 BaseSubobjectInfo *PrimaryBaseInfo =
1012 NonVirtualBaseInfo.lookup(PrimaryBase);
1013 assert(PrimaryBaseInfo &&
1014 "Did not find base info for non-virtual primary base!");
1015
1016 LayoutNonVirtualBase(PrimaryBaseInfo);
1017 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001018
John McCall0153cd32011-11-08 04:01:03 +00001019 // If this class needs a vtable/vf-table and didn't get one from a
1020 // primary base, add it in now.
Warren Hunt55d8e822013-10-23 23:53:07 +00001021 } else if (RD->isDynamicClass()) {
Eli Friedman5e9534b2011-10-18 00:55:28 +00001022 assert(DataSize == 0 && "Vtable pointer must be at offset zero!");
Eli Friedman5e9534b2011-10-18 00:55:28 +00001023 CharUnits PtrWidth =
1024 Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerWidth(0));
Eli Friedman43114f92011-10-21 22:49:56 +00001025 CharUnits PtrAlign =
1026 Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerAlign(0));
1027 EnsureVTablePointerAlignment(PtrAlign);
John McCalle42a3362012-05-01 08:55:32 +00001028 HasOwnVFPtr = true;
Eli Friedman5e9534b2011-10-18 00:55:28 +00001029 setSize(getSize() + PtrWidth);
1030 setDataSize(getSize());
1031 }
1032
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001033 // Now lay out the non-virtual bases.
Aaron Ballman574705e2014-03-13 15:41:46 +00001034 for (const auto &I : RD->bases()) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001035
Benjamin Kramer273670a2013-10-25 07:40:50 +00001036 // Ignore virtual bases.
Aaron Ballman574705e2014-03-13 15:41:46 +00001037 if (I.isVirtual())
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001038 continue;
1039
Aaron Ballman574705e2014-03-13 15:41:46 +00001040 const CXXRecordDecl *BaseDecl = I.getType()->getAsCXXRecordDecl();
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001041
John McCall0153cd32011-11-08 04:01:03 +00001042 // Skip the primary base, because we've already laid it out. The
1043 // !PrimaryBaseIsVirtual check is required because we might have a
1044 // non-virtual base of the same type as a primary virtual base.
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001045 if (BaseDecl == PrimaryBase && !PrimaryBaseIsVirtual)
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001046 continue;
1047
1048 // Lay out the base.
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001049 BaseSubobjectInfo *BaseInfo = NonVirtualBaseInfo.lookup(BaseDecl);
1050 assert(BaseInfo && "Did not find base info for non-virtual base!");
1051
1052 LayoutNonVirtualBase(BaseInfo);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001053 }
1054}
1055
David Majnemer3b1c9902015-07-25 20:18:14 +00001056void ItaniumRecordLayoutBuilder::LayoutNonVirtualBase(
1057 const BaseSubobjectInfo *Base) {
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001058 // Layout the base.
Anders Carlssona2f8e412010-10-31 22:20:42 +00001059 CharUnits Offset = LayoutBase(Base);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001060
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001061 // Add its base class offset.
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001062 assert(!Bases.count(Base->Class) && "base offset already exists!");
Anders Carlssona2f8e412010-10-31 22:20:42 +00001063 Bases.insert(std::make_pair(Base->Class, Offset));
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001064
1065 AddPrimaryVirtualBaseOffsets(Base, Offset);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001066}
Mike Stump2b84dd32009-11-05 04:02:15 +00001067
David Majnemer3b1c9902015-07-25 20:18:14 +00001068void ItaniumRecordLayoutBuilder::AddPrimaryVirtualBaseOffsets(
1069 const BaseSubobjectInfo *Info, CharUnits Offset) {
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001070 // This base isn't interesting, it has no virtual bases.
1071 if (!Info->Class->getNumVBases())
1072 return;
1073
1074 // First, check if we have a virtual primary base to add offsets for.
1075 if (Info->PrimaryVirtualBaseInfo) {
1076 assert(Info->PrimaryVirtualBaseInfo->IsVirtual &&
1077 "Primary virtual base is not virtual!");
1078 if (Info->PrimaryVirtualBaseInfo->Derived == Info) {
1079 // Add the offset.
1080 assert(!VBases.count(Info->PrimaryVirtualBaseInfo->Class) &&
1081 "primary vbase offset already exists!");
1082 VBases.insert(std::make_pair(Info->PrimaryVirtualBaseInfo->Class,
John McCalle42a3362012-05-01 08:55:32 +00001083 ASTRecordLayout::VBaseInfo(Offset, false)));
Anders Carlssonea7b1822010-04-15 16:12:58 +00001084
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001085 // Traverse the primary virtual base.
1086 AddPrimaryVirtualBaseOffsets(Info->PrimaryVirtualBaseInfo, Offset);
1087 }
Anders Carlssonea7b1822010-04-15 16:12:58 +00001088 }
1089
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001090 // Now go through all direct non-virtual bases.
1091 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Info->Class);
David Majnemerc964b4b2014-07-16 06:04:00 +00001092 for (const BaseSubobjectInfo *Base : Info->Bases) {
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001093 if (Base->IsVirtual)
Anders Carlssonea7b1822010-04-15 16:12:58 +00001094 continue;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001095
Anders Carlsson0a14ee92010-11-01 00:21:58 +00001096 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base->Class);
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001097 AddPrimaryVirtualBaseOffsets(Base, BaseOffset);
Anders Carlssonea7b1822010-04-15 16:12:58 +00001098 }
1099}
1100
David Majnemer3b1c9902015-07-25 20:18:14 +00001101void ItaniumRecordLayoutBuilder::LayoutVirtualBases(
1102 const CXXRecordDecl *RD, const CXXRecordDecl *MostDerivedClass) {
Anders Carlssonde710c92010-03-11 04:33:54 +00001103 const CXXRecordDecl *PrimaryBase;
Anders Carlsson291279e2010-04-10 18:42:27 +00001104 bool PrimaryBaseIsVirtual;
Anders Carlssonfe900962010-03-11 05:42:17 +00001105
Anders Carlsson291279e2010-04-10 18:42:27 +00001106 if (MostDerivedClass == RD) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +00001107 PrimaryBase = this->PrimaryBase;
1108 PrimaryBaseIsVirtual = this->PrimaryBaseIsVirtual;
Anders Carlsson291279e2010-04-10 18:42:27 +00001109 } else {
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001110 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlssonde710c92010-03-11 04:33:54 +00001111 PrimaryBase = Layout.getPrimaryBase();
Anders Carlsson7f95cd12010-11-24 23:12:57 +00001112 PrimaryBaseIsVirtual = Layout.isPrimaryBaseVirtual();
Anders Carlsson291279e2010-04-10 18:42:27 +00001113 }
1114
David Majnemerc964b4b2014-07-16 06:04:00 +00001115 for (const CXXBaseSpecifier &Base : RD->bases()) {
1116 assert(!Base.getType()->isDependentType() &&
Sebastian Redl1054fae2009-10-25 17:03:50 +00001117 "Cannot layout class with dependent bases.");
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001118
David Majnemerc964b4b2014-07-16 06:04:00 +00001119 const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl();
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001120
David Majnemerc964b4b2014-07-16 06:04:00 +00001121 if (Base.isVirtual()) {
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001122 if (PrimaryBase != BaseDecl || !PrimaryBaseIsVirtual) {
1123 bool IndirectPrimaryBase = IndirectPrimaryBases.count(BaseDecl);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001124
Anders Carlsson291279e2010-04-10 18:42:27 +00001125 // Only lay out the virtual base if it's not an indirect primary base.
1126 if (!IndirectPrimaryBase) {
1127 // Only visit virtual bases once.
David Blaikie82e95a32014-11-19 07:49:47 +00001128 if (!VisitedVirtualBases.insert(BaseDecl).second)
Anders Carlsson291279e2010-04-10 18:42:27 +00001129 continue;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001130
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001131 const BaseSubobjectInfo *BaseInfo = VirtualBaseInfo.lookup(BaseDecl);
1132 assert(BaseInfo && "Did not find virtual base info!");
1133 LayoutVirtualBase(BaseInfo);
Anders Carlsson6a848892010-03-11 04:10:39 +00001134 }
Mike Stump2b84dd32009-11-05 04:02:15 +00001135 }
Mike Stumpc2f591b2009-08-13 22:53:07 +00001136 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001137
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001138 if (!BaseDecl->getNumVBases()) {
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001139 // This base isn't interesting since it doesn't have any virtual bases.
1140 continue;
Mike Stump996576f32009-08-16 19:04:13 +00001141 }
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001142
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001143 LayoutVirtualBases(BaseDecl, MostDerivedClass);
Mike Stump6b2556f2009-08-06 13:41:24 +00001144 }
1145}
1146
David Majnemer3b1c9902015-07-25 20:18:14 +00001147void ItaniumRecordLayoutBuilder::LayoutVirtualBase(
1148 const BaseSubobjectInfo *Base) {
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001149 assert(!Base->Derived && "Trying to lay out a primary virtual base!");
1150
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001151 // Layout the base.
Anders Carlssona2f8e412010-10-31 22:20:42 +00001152 CharUnits Offset = LayoutBase(Base);
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001153
1154 // Add its base class offset.
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001155 assert(!VBases.count(Base->Class) && "vbase offset already exists!");
John McCalle42a3362012-05-01 08:55:32 +00001156 VBases.insert(std::make_pair(Base->Class,
Warren Hunt55d8e822013-10-23 23:53:07 +00001157 ASTRecordLayout::VBaseInfo(Offset, false)));
John McCalle42a3362012-05-01 08:55:32 +00001158
Warren Hunt55d8e822013-10-23 23:53:07 +00001159 AddPrimaryVirtualBaseOffsets(Base, Offset);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001160}
1161
David Majnemer3b1c9902015-07-25 20:18:14 +00001162CharUnits
1163ItaniumRecordLayoutBuilder::LayoutBase(const BaseSubobjectInfo *Base) {
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001164 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Base->Class);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001165
Douglas Gregore9fc3772012-01-26 07:55:45 +00001166
1167 CharUnits Offset;
1168
1169 // Query the external layout to see if it provides an offset.
1170 bool HasExternalLayout = false;
Reid Kleckner8b6d0342015-02-25 19:17:45 +00001171 if (UseExternalLayout) {
Douglas Gregore9fc3772012-01-26 07:55:45 +00001172 llvm::DenseMap<const CXXRecordDecl *, CharUnits>::iterator Known;
Reid Kleckner8b6d0342015-02-25 19:17:45 +00001173 if (Base->IsVirtual)
1174 HasExternalLayout = External.getExternalNVBaseOffset(Base->Class, Offset);
1175 else
1176 HasExternalLayout = External.getExternalVBaseOffset(Base->Class, Offset);
Douglas Gregore9fc3772012-01-26 07:55:45 +00001177 }
1178
Warren Huntd640d7d2014-01-09 00:30:56 +00001179 CharUnits UnpackedBaseAlign = Layout.getNonVirtualAlignment();
Eli Friedman69d27d22013-07-16 00:21:28 +00001180 CharUnits BaseAlign = (Packed) ? CharUnits::One() : UnpackedBaseAlign;
1181
Anders Carlsson09ffa322010-03-10 22:21:28 +00001182 // If we have an empty base class, try to place it at offset 0.
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001183 if (Base->Class->isEmpty() &&
Douglas Gregore9fc3772012-01-26 07:55:45 +00001184 (!HasExternalLayout || Offset == CharUnits::Zero()) &&
Anders Carlsson28466ab2010-10-31 22:13:23 +00001185 EmptySubobjects->CanPlaceBaseAtOffset(Base, CharUnits::Zero())) {
Ken Dyck1b4420e2011-02-28 02:01:38 +00001186 setSize(std::max(getSize(), Layout.getSize()));
Eli Friedman69d27d22013-07-16 00:21:28 +00001187 UpdateAlignment(BaseAlign, UnpackedBaseAlign);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001188
Anders Carlssona2f8e412010-10-31 22:20:42 +00001189 return CharUnits::Zero();
Anders Carlsson09ffa322010-03-10 22:21:28 +00001190 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001191
Argyrios Kyrtzidis8b542742010-12-09 00:35:20 +00001192 // The maximum field alignment overrides base align.
Ken Dyck02ced6f2011-02-17 01:49:42 +00001193 if (!MaxFieldAlignment.isZero()) {
Ken Dyck85ef0432011-02-19 18:58:07 +00001194 BaseAlign = std::min(BaseAlign, MaxFieldAlignment);
1195 UnpackedBaseAlign = std::min(UnpackedBaseAlign, MaxFieldAlignment);
Argyrios Kyrtzidis8b542742010-12-09 00:35:20 +00001196 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001197
Douglas Gregore9fc3772012-01-26 07:55:45 +00001198 if (!HasExternalLayout) {
1199 // Round up the current record size to the base's alignment boundary.
Rui Ueyama83aa9792016-01-14 21:00:27 +00001200 Offset = getDataSize().alignTo(BaseAlign);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001201
Douglas Gregore9fc3772012-01-26 07:55:45 +00001202 // Try to place the base.
1203 while (!EmptySubobjects->CanPlaceBaseAtOffset(Base, Offset))
1204 Offset += BaseAlign;
1205 } else {
1206 bool Allowed = EmptySubobjects->CanPlaceBaseAtOffset(Base, Offset);
1207 (void)Allowed;
1208 assert(Allowed && "Base subobject externally placed at overlapping offset");
Douglas Gregor1423a5c2012-10-26 22:31:14 +00001209
Rui Ueyama83aa9792016-01-14 21:00:27 +00001210 if (InferAlignment && Offset < getDataSize().alignTo(BaseAlign)) {
Douglas Gregor1423a5c2012-10-26 22:31:14 +00001211 // The externally-supplied base offset is before the base offset we
1212 // computed. Assume that the structure is packed.
1213 Alignment = CharUnits::One();
1214 InferAlignment = false;
1215 }
Douglas Gregore9fc3772012-01-26 07:55:45 +00001216 }
1217
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001218 if (!Base->Class->isEmpty()) {
Anders Carlsson09ffa322010-03-10 22:21:28 +00001219 // Update the data size.
Ken Dyck1b4420e2011-02-28 02:01:38 +00001220 setDataSize(Offset + Layout.getNonVirtualSize());
Anders Carlsson09ffa322010-03-10 22:21:28 +00001221
Ken Dyck1b4420e2011-02-28 02:01:38 +00001222 setSize(std::max(getSize(), getDataSize()));
Anders Carlsson09ffa322010-03-10 22:21:28 +00001223 } else
Ken Dyck1b4420e2011-02-28 02:01:38 +00001224 setSize(std::max(getSize(), Offset + Layout.getSize()));
Anders Carlsson09ffa322010-03-10 22:21:28 +00001225
1226 // Remember max struct/class alignment.
Argyrios Kyrtzidis8b542742010-12-09 00:35:20 +00001227 UpdateAlignment(BaseAlign, UnpackedBaseAlign);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001228
Ken Dyck1b4420e2011-02-28 02:01:38 +00001229 return Offset;
Anders Carlsson09ffa322010-03-10 22:21:28 +00001230}
1231
David Majnemer3b1c9902015-07-25 20:18:14 +00001232void ItaniumRecordLayoutBuilder::InitializeLayout(const Decl *D) {
Eli Friedman9ee2d0472012-10-12 23:29:20 +00001233 if (const RecordDecl *RD = dyn_cast<RecordDecl>(D)) {
Daniel Dunbar6da10982010-05-27 05:45:51 +00001234 IsUnion = RD->isUnion();
Eli Friedman9ee2d0472012-10-12 23:29:20 +00001235 IsMsStruct = RD->isMsStruct(Context);
1236 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001237
Eli Friedman9ee2d0472012-10-12 23:29:20 +00001238 Packed = D->hasAttr<PackedAttr>();
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001239
Daniel Dunbar096ed292011-10-05 21:04:55 +00001240 // Honor the default struct packing maximum alignment flag.
David Blaikiebbafb8a2012-03-11 07:00:24 +00001241 if (unsigned DefaultMaxFieldAlignment = Context.getLangOpts().PackStruct) {
Daniel Dunbar096ed292011-10-05 21:04:55 +00001242 MaxFieldAlignment = CharUnits::fromQuantity(DefaultMaxFieldAlignment);
1243 }
1244
Daniel Dunbar6da10982010-05-27 05:45:51 +00001245 // mac68k alignment supersedes maximum field alignment and attribute aligned,
1246 // and forces all structures to have 2-byte alignment. The IBM docs on it
1247 // allude to additional (more complicated) semantics, especially with regard
1248 // to bit-fields, but gcc appears not to follow that.
1249 if (D->hasAttr<AlignMac68kAttr>()) {
1250 IsMac68kAlign = true;
Ken Dyck02ced6f2011-02-17 01:49:42 +00001251 MaxFieldAlignment = CharUnits::fromQuantity(2);
Ken Dyck4731d5b2011-02-16 02:05:21 +00001252 Alignment = CharUnits::fromQuantity(2);
Daniel Dunbar6da10982010-05-27 05:45:51 +00001253 } else {
1254 if (const MaxFieldAlignmentAttr *MFAA = D->getAttr<MaxFieldAlignmentAttr>())
Ken Dyck02ced6f2011-02-17 01:49:42 +00001255 MaxFieldAlignment = Context.toCharUnitsFromBits(MFAA->getAlignment());
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001256
Alexis Huntdcfba7b2010-08-18 23:23:40 +00001257 if (unsigned MaxAlign = D->getMaxAlignment())
Ken Dyck85ef0432011-02-19 18:58:07 +00001258 UpdateAlignment(Context.toCharUnitsFromBits(MaxAlign));
Daniel Dunbar6da10982010-05-27 05:45:51 +00001259 }
Douglas Gregore9fc3772012-01-26 07:55:45 +00001260
1261 // If there is an external AST source, ask it for the various offsets.
1262 if (const RecordDecl *RD = dyn_cast<RecordDecl>(D))
Reid Kleckner8b6d0342015-02-25 19:17:45 +00001263 if (ExternalASTSource *Source = Context.getExternalSource()) {
1264 UseExternalLayout = Source->layoutRecordType(
1265 RD, External.Size, External.Align, External.FieldOffsets,
1266 External.BaseOffsets, External.VirtualBaseOffsets);
NAKAMURA Takumi472041f2015-02-25 10:32:20 +00001267
Douglas Gregore9fc3772012-01-26 07:55:45 +00001268 // Update based on external alignment.
Reid Kleckner8b6d0342015-02-25 19:17:45 +00001269 if (UseExternalLayout) {
1270 if (External.Align > 0) {
1271 Alignment = Context.toCharUnitsFromBits(External.Align);
Douglas Gregor44ba7892012-01-28 00:53:29 +00001272 } else {
1273 // The external source didn't have alignment information; infer it.
1274 InferAlignment = true;
1275 }
Douglas Gregore9fc3772012-01-26 07:55:45 +00001276 }
1277 }
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001278}
Anders Carlsson6d9f6f32009-07-19 00:18:47 +00001279
David Majnemer3b1c9902015-07-25 20:18:14 +00001280void ItaniumRecordLayoutBuilder::Layout(const RecordDecl *D) {
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001281 InitializeLayout(D);
Anders Carlsson118ce162009-07-18 21:48:39 +00001282 LayoutFields(D);
Mike Stump11289f42009-09-09 15:08:12 +00001283
Anders Carlsson79474332009-07-18 20:20:21 +00001284 // Finally, round the size of the total struct up to the alignment of the
1285 // struct itself.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001286 FinishLayout(D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001287}
1288
David Majnemer3b1c9902015-07-25 20:18:14 +00001289void ItaniumRecordLayoutBuilder::Layout(const CXXRecordDecl *RD) {
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001290 InitializeLayout(RD);
1291
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001292 // Lay out the vtable and the non-virtual bases.
1293 LayoutNonVirtualBases(RD);
1294
1295 LayoutFields(RD);
1296
Ken Dycke7380752011-03-10 01:53:59 +00001297 NonVirtualSize = Context.toCharUnitsFromBits(
Rui Ueyama83aa9792016-01-14 21:00:27 +00001298 llvm::alignTo(getSizeInBits(), Context.getTargetInfo().getCharAlign()));
Ken Dyck4731d5b2011-02-16 02:05:21 +00001299 NonVirtualAlignment = Alignment;
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001300
Warren Hunt55d8e822013-10-23 23:53:07 +00001301 // Lay out the virtual bases and add the primary virtual base offsets.
1302 LayoutVirtualBases(RD, RD);
John McCall0153cd32011-11-08 04:01:03 +00001303
1304 // Finally, round the size of the total struct up to the alignment
Eli Friedman83a12582011-12-01 00:37:01 +00001305 // of the struct itself.
1306 FinishLayout(RD);
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001307
Anders Carlsson5b441d72010-04-10 21:24:48 +00001308#ifndef NDEBUG
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001309 // Check that we have base offsets for all bases.
David Majnemerc964b4b2014-07-16 06:04:00 +00001310 for (const CXXBaseSpecifier &Base : RD->bases()) {
1311 if (Base.isVirtual())
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001312 continue;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001313
David Majnemerc964b4b2014-07-16 06:04:00 +00001314 const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl();
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001315
1316 assert(Bases.count(BaseDecl) && "Did not find base offset!");
1317 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001318
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001319 // And all virtual bases.
David Majnemerc964b4b2014-07-16 06:04:00 +00001320 for (const CXXBaseSpecifier &Base : RD->vbases()) {
1321 const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl();
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001322
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001323 assert(VBases.count(BaseDecl) && "Did not find base offset!");
Anders Carlsson5b441d72010-04-10 21:24:48 +00001324 }
1325#endif
Anders Carlsson79474332009-07-18 20:20:21 +00001326}
1327
David Majnemer3b1c9902015-07-25 20:18:14 +00001328void ItaniumRecordLayoutBuilder::Layout(const ObjCInterfaceDecl *D) {
Anders Carlsson4f516282009-07-18 20:50:59 +00001329 if (ObjCInterfaceDecl *SD = D->getSuperClass()) {
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001330 const ASTRecordLayout &SL = Context.getASTObjCInterfaceLayout(SD);
Anders Carlsson4f516282009-07-18 20:50:59 +00001331
Ken Dyck85ef0432011-02-19 18:58:07 +00001332 UpdateAlignment(SL.getAlignment());
Mike Stump11289f42009-09-09 15:08:12 +00001333
Anders Carlsson4f516282009-07-18 20:50:59 +00001334 // We start laying out ivars not at the end of the superclass
1335 // structure, but at the next byte following the last field.
Ken Dyckecfc7552011-02-24 01:13:28 +00001336 setSize(SL.getDataSize());
Ken Dyck1b4420e2011-02-28 02:01:38 +00001337 setDataSize(getSize());
Anders Carlsson4f516282009-07-18 20:50:59 +00001338 }
Mike Stump11289f42009-09-09 15:08:12 +00001339
Daniel Dunbar6da10982010-05-27 05:45:51 +00001340 InitializeLayout(D);
Anders Carlsson4f516282009-07-18 20:50:59 +00001341 // Layout each ivar sequentially.
Jordy Rosea91768e2011-07-22 02:08:32 +00001342 for (const ObjCIvarDecl *IVD = D->all_declared_ivar_begin(); IVD;
1343 IVD = IVD->getNextIvar())
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001344 LayoutField(IVD, false);
Mike Stump11289f42009-09-09 15:08:12 +00001345
Anders Carlsson4f516282009-07-18 20:50:59 +00001346 // Finally, round the size of the total struct up to the alignment of the
1347 // struct itself.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001348 FinishLayout(D);
Anders Carlsson4f516282009-07-18 20:50:59 +00001349}
1350
David Majnemer3b1c9902015-07-25 20:18:14 +00001351void ItaniumRecordLayoutBuilder::LayoutFields(const RecordDecl *D) {
Anders Carlsson118ce162009-07-18 21:48:39 +00001352 // Layout each field, for now, just sequentially, respecting alignment. In
1353 // the future, this will need to be tweakable by targets.
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001354 bool InsertExtraPadding = D->mayInsertExtraPadding(/*EmitRemark=*/true);
Kostya Serebryany68c29da2014-10-27 19:34:10 +00001355 bool HasFlexibleArrayMember = D->hasFlexibleArrayMember();
1356 for (auto I = D->field_begin(), End = D->field_end(); I != End; ++I) {
1357 auto Next(I);
1358 ++Next;
1359 LayoutField(*I,
1360 InsertExtraPadding && (Next != End || !HasFlexibleArrayMember));
1361 }
Anders Carlsson118ce162009-07-18 21:48:39 +00001362}
1363
Artyom Skrobov5e63acc2014-10-17 10:22:03 +00001364// Rounds the specified size to have it a multiple of the char size.
1365static uint64_t
1366roundUpSizeToCharAlignment(uint64_t Size,
1367 const ASTContext &Context) {
1368 uint64_t CharAlignment = Context.getTargetInfo().getCharAlign();
Rui Ueyama83aa9792016-01-14 21:00:27 +00001369 return llvm::alignTo(Size, CharAlignment);
Artyom Skrobov5e63acc2014-10-17 10:22:03 +00001370}
1371
David Majnemer3b1c9902015-07-25 20:18:14 +00001372void ItaniumRecordLayoutBuilder::LayoutWideBitField(uint64_t FieldSize,
1373 uint64_t TypeSize,
1374 bool FieldPacked,
1375 const FieldDecl *D) {
David Blaikiebbafb8a2012-03-11 07:00:24 +00001376 assert(Context.getLangOpts().CPlusPlus &&
Anders Carlsson57235162010-04-16 15:57:11 +00001377 "Can only have wide bit-fields in C++!");
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001378
Anders Carlsson57235162010-04-16 15:57:11 +00001379 // Itanium C++ ABI 2.4:
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001380 // If sizeof(T)*8 < n, let T' be the largest integral POD type with
Anders Carlsson57235162010-04-16 15:57:11 +00001381 // sizeof(T')*8 <= n.
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001382
Anders Carlsson57235162010-04-16 15:57:11 +00001383 QualType IntegralPODTypes[] = {
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001384 Context.UnsignedCharTy, Context.UnsignedShortTy, Context.UnsignedIntTy,
Anders Carlsson57235162010-04-16 15:57:11 +00001385 Context.UnsignedLongTy, Context.UnsignedLongLongTy
1386 };
1387
Anders Carlsson57235162010-04-16 15:57:11 +00001388 QualType Type;
David Majnemerc964b4b2014-07-16 06:04:00 +00001389 for (const QualType &QT : IntegralPODTypes) {
1390 uint64_t Size = Context.getTypeSize(QT);
Anders Carlsson57235162010-04-16 15:57:11 +00001391
1392 if (Size > FieldSize)
1393 break;
1394
David Majnemerc964b4b2014-07-16 06:04:00 +00001395 Type = QT;
Anders Carlsson57235162010-04-16 15:57:11 +00001396 }
1397 assert(!Type.isNull() && "Did not find a type!");
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001398
Ken Dyckdbe37f32011-03-01 01:36:00 +00001399 CharUnits TypeAlign = Context.getTypeAlignInChars(Type);
Anders Carlsson57235162010-04-16 15:57:11 +00001400
1401 // We're not going to use any of the unfilled bits in the last byte.
Eli Friedman2782dac2013-06-26 20:50:34 +00001402 UnfilledBitsInLastUnit = 0;
1403 LastBitfieldTypeSize = 0;
Anders Carlsson57235162010-04-16 15:57:11 +00001404
Anders Carlssonaad5fa82010-04-17 20:21:41 +00001405 uint64_t FieldOffset;
Eli Friedman2782dac2013-06-26 20:50:34 +00001406 uint64_t UnpaddedFieldOffset = getDataSizeInBits() - UnfilledBitsInLastUnit;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001407
Anders Carlsson57235162010-04-16 15:57:11 +00001408 if (IsUnion) {
Artyom Skrobov5e63acc2014-10-17 10:22:03 +00001409 uint64_t RoundedFieldSize = roundUpSizeToCharAlignment(FieldSize,
1410 Context);
1411 setDataSize(std::max(getDataSizeInBits(), RoundedFieldSize));
Anders Carlssonaad5fa82010-04-17 20:21:41 +00001412 FieldOffset = 0;
Anders Carlsson57235162010-04-16 15:57:11 +00001413 } else {
Chad Rosiere1a6a0e2011-08-05 22:38:04 +00001414 // The bitfield is allocated starting at the next offset aligned
1415 // appropriately for T', with length n bits.
Rui Ueyama83aa9792016-01-14 21:00:27 +00001416 FieldOffset = llvm::alignTo(getDataSizeInBits(), Context.toBits(TypeAlign));
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001417
Anders Carlsson57235162010-04-16 15:57:11 +00001418 uint64_t NewSizeInBits = FieldOffset + FieldSize;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001419
Rui Ueyama83aa9792016-01-14 21:00:27 +00001420 setDataSize(
1421 llvm::alignTo(NewSizeInBits, Context.getTargetInfo().getCharAlign()));
Eli Friedman2782dac2013-06-26 20:50:34 +00001422 UnfilledBitsInLastUnit = getDataSizeInBits() - NewSizeInBits;
Anders Carlsson57235162010-04-16 15:57:11 +00001423 }
1424
1425 // Place this field at the current location.
1426 FieldOffsets.push_back(FieldOffset);
1427
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001428 CheckFieldPadding(FieldOffset, UnpaddedFieldOffset, FieldOffset,
Ken Dyckdbe37f32011-03-01 01:36:00 +00001429 Context.toBits(TypeAlign), FieldPacked, D);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001430
Anders Carlsson57235162010-04-16 15:57:11 +00001431 // Update the size.
Ken Dyckecfc7552011-02-24 01:13:28 +00001432 setSize(std::max(getSizeInBits(), getDataSizeInBits()));
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001433
Anders Carlsson57235162010-04-16 15:57:11 +00001434 // Remember max struct/class alignment.
Ken Dyckdbe37f32011-03-01 01:36:00 +00001435 UpdateAlignment(TypeAlign);
Anders Carlsson57235162010-04-16 15:57:11 +00001436}
1437
David Majnemer3b1c9902015-07-25 20:18:14 +00001438void ItaniumRecordLayoutBuilder::LayoutBitField(const FieldDecl *D) {
Anders Carlsson07209442009-11-22 17:37:31 +00001439 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Richard Smithcaf33902011-10-10 18:28:20 +00001440 uint64_t FieldSize = D->getBitWidthValue(Context);
David Majnemer34b57492014-07-30 01:30:47 +00001441 TypeInfo FieldInfo = Context.getTypeInfo(D->getType());
1442 uint64_t TypeSize = FieldInfo.Width;
1443 unsigned FieldAlign = FieldInfo.Align;
Eli Friedman2782dac2013-06-26 20:50:34 +00001444
John McCall30268ca2014-01-29 07:53:44 +00001445 // UnfilledBitsInLastUnit is the difference between the end of the
1446 // last allocated bitfield (i.e. the first bit offset available for
1447 // bitfields) and the end of the current data size in bits (i.e. the
1448 // first bit offset available for non-bitfields). The current data
1449 // size in bits is always a multiple of the char size; additionally,
1450 // for ms_struct records it's also a multiple of the
1451 // LastBitfieldTypeSize (if set).
1452
John McCall76e1818a2014-02-13 00:50:08 +00001453 // The struct-layout algorithm is dictated by the platform ABI,
1454 // which in principle could use almost any rules it likes. In
1455 // practice, UNIXy targets tend to inherit the algorithm described
1456 // in the System V generic ABI. The basic bitfield layout rule in
1457 // System V is to place bitfields at the next available bit offset
1458 // where the entire bitfield would fit in an aligned storage unit of
1459 // the declared type; it's okay if an earlier or later non-bitfield
1460 // is allocated in the same storage unit. However, some targets
1461 // (those that !useBitFieldTypeAlignment(), e.g. ARM APCS) don't
1462 // require this storage unit to be aligned, and therefore always put
1463 // the bitfield at the next available bit offset.
John McCall30268ca2014-01-29 07:53:44 +00001464
John McCall76e1818a2014-02-13 00:50:08 +00001465 // ms_struct basically requests a complete replacement of the
1466 // platform ABI's struct-layout algorithm, with the high-level goal
1467 // of duplicating MSVC's layout. For non-bitfields, this follows
Eric Christopher2c4555a2015-06-19 01:52:53 +00001468 // the standard algorithm. The basic bitfield layout rule is to
John McCall76e1818a2014-02-13 00:50:08 +00001469 // allocate an entire unit of the bitfield's declared type
1470 // (e.g. 'unsigned long'), then parcel it up among successive
1471 // bitfields whose declared types have the same size, making a new
1472 // unit as soon as the last can no longer store the whole value.
1473 // Since it completely replaces the platform ABI's algorithm,
1474 // settings like !useBitFieldTypeAlignment() do not apply.
1475
1476 // A zero-width bitfield forces the use of a new storage unit for
1477 // later bitfields. In general, this occurs by rounding up the
1478 // current size of the struct as if the algorithm were about to
1479 // place a non-bitfield of the field's formal type. Usually this
1480 // does not change the alignment of the struct itself, but it does
1481 // on some targets (those that useZeroLengthBitfieldAlignment(),
1482 // e.g. ARM). In ms_struct layout, zero-width bitfields are
1483 // ignored unless they follow a non-zero-width bitfield.
1484
1485 // A field alignment restriction (e.g. from #pragma pack) or
1486 // specification (e.g. from __attribute__((aligned))) changes the
1487 // formal alignment of the field. For System V, this alters the
1488 // required alignment of the notional storage unit that must contain
1489 // the bitfield. For ms_struct, this only affects the placement of
1490 // new storage units. In both cases, the effect of #pragma pack is
1491 // ignored on zero-width bitfields.
1492
1493 // On System V, a packed field (e.g. from #pragma pack or
1494 // __attribute__((packed))) always uses the next available bit
1495 // offset.
1496
John McCall95833f32014-02-27 20:30:49 +00001497 // In an ms_struct struct, the alignment of a fundamental type is
1498 // always equal to its size. This is necessary in order to mimic
1499 // the i386 alignment rules on targets which might not fully align
1500 // all types (e.g. Darwin PPC32, where alignof(long long) == 4).
John McCall30268ca2014-01-29 07:53:44 +00001501
1502 // First, some simple bookkeeping to perform for ms_struct structs.
Eli Friedman2782dac2013-06-26 20:50:34 +00001503 if (IsMsStruct) {
John McCall30268ca2014-01-29 07:53:44 +00001504 // The field alignment for integer types is always the size.
Fariborz Jahanian7adbed62011-05-09 22:03:17 +00001505 FieldAlign = TypeSize;
John McCall30268ca2014-01-29 07:53:44 +00001506
1507 // If the previous field was not a bitfield, or was a bitfield
1508 // with a different storage unit size, we're done with that
1509 // storage unit.
Eli Friedman2782dac2013-06-26 20:50:34 +00001510 if (LastBitfieldTypeSize != TypeSize) {
John McCall30268ca2014-01-29 07:53:44 +00001511 // Also, ignore zero-length bitfields after non-bitfields.
1512 if (!LastBitfieldTypeSize && !FieldSize)
1513 FieldAlign = 1;
1514
Eli Friedman2782dac2013-06-26 20:50:34 +00001515 UnfilledBitsInLastUnit = 0;
1516 LastBitfieldTypeSize = 0;
1517 }
1518 }
1519
John McCall30268ca2014-01-29 07:53:44 +00001520 // If the field is wider than its declared type, it follows
1521 // different rules in all cases.
Anders Carlsson57235162010-04-16 15:57:11 +00001522 if (FieldSize > TypeSize) {
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001523 LayoutWideBitField(FieldSize, TypeSize, FieldPacked, D);
Anders Carlsson57235162010-04-16 15:57:11 +00001524 return;
1525 }
1526
John McCall30268ca2014-01-29 07:53:44 +00001527 // Compute the next available bit offset.
1528 uint64_t FieldOffset =
1529 IsUnion ? 0 : (getDataSizeInBits() - UnfilledBitsInLastUnit);
1530
1531 // Handle targets that don't honor bitfield type alignment.
John McCall76e1818a2014-02-13 00:50:08 +00001532 if (!IsMsStruct && !Context.getTargetInfo().useBitFieldTypeAlignment()) {
John McCall30268ca2014-01-29 07:53:44 +00001533 // Some such targets do honor it on zero-width bitfields.
1534 if (FieldSize == 0 &&
1535 Context.getTargetInfo().useZeroLengthBitfieldAlignment()) {
1536 // The alignment to round up to is the max of the field's natural
1537 // alignment and a target-specific fixed value (sometimes zero).
1538 unsigned ZeroLengthBitfieldBoundary =
1539 Context.getTargetInfo().getZeroLengthBitfieldBoundary();
1540 FieldAlign = std::max(FieldAlign, ZeroLengthBitfieldBoundary);
1541
1542 // If that doesn't apply, just ignore the field alignment.
1543 } else {
1544 FieldAlign = 1;
1545 }
1546 }
1547
1548 // Remember the alignment we would have used if the field were not packed.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001549 unsigned UnpackedFieldAlign = FieldAlign;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001550
Yunzhong Gao5fd0c9d2014-02-13 02:45:10 +00001551 // Ignore the field alignment if the field is packed unless it has zero-size.
1552 if (!IsMsStruct && FieldPacked && FieldSize != 0)
Anders Carlsson07209442009-11-22 17:37:31 +00001553 FieldAlign = 1;
Anders Carlsson07209442009-11-22 17:37:31 +00001554
John McCall30268ca2014-01-29 07:53:44 +00001555 // But, if there's an 'aligned' attribute on the field, honor that.
Alexey Bataev567e30f2016-01-12 09:12:20 +00001556 unsigned ExplicitFieldAlign = D->getMaxAlignment();
1557 if (ExplicitFieldAlign) {
John McCall30268ca2014-01-29 07:53:44 +00001558 FieldAlign = std::max(FieldAlign, ExplicitFieldAlign);
1559 UnpackedFieldAlign = std::max(UnpackedFieldAlign, ExplicitFieldAlign);
1560 }
1561
1562 // But, if there's a #pragma pack in play, that takes precedent over
1563 // even the 'aligned' attribute, for non-zero-width bitfields.
Alexey Bataev455bdd92016-02-19 11:23:28 +00001564 unsigned MaxFieldAlignmentInBits = Context.toBits(MaxFieldAlignment);
John McCall30268ca2014-01-29 07:53:44 +00001565 if (!MaxFieldAlignment.isZero() && FieldSize) {
Ken Dyck02ced6f2011-02-17 01:49:42 +00001566 UnpackedFieldAlign = std::min(UnpackedFieldAlign, MaxFieldAlignmentInBits);
Alexey Bataev455bdd92016-02-19 11:23:28 +00001567 if (FieldPacked)
1568 FieldAlign = UnpackedFieldAlign;
1569 else
1570 FieldAlign = std::min(FieldAlign, MaxFieldAlignmentInBits);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001571 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001572
John McCall0d461692015-08-19 22:42:36 +00001573 // But, ms_struct just ignores all of that in unions, even explicit
1574 // alignment attributes.
1575 if (IsMsStruct && IsUnion) {
1576 FieldAlign = UnpackedFieldAlign = 1;
1577 }
1578
John McCall30268ca2014-01-29 07:53:44 +00001579 // For purposes of diagnostics, we're going to simultaneously
1580 // compute the field offsets that we would have used if we weren't
1581 // adding any alignment padding or if the field weren't packed.
1582 uint64_t UnpaddedFieldOffset = FieldOffset;
1583 uint64_t UnpackedFieldOffset = FieldOffset;
1584
1585 // Check if we need to add padding to fit the bitfield within an
1586 // allocation unit with the right size and alignment. The rules are
1587 // somewhat different here for ms_struct structs.
1588 if (IsMsStruct) {
1589 // If it's not a zero-width bitfield, and we can fit the bitfield
1590 // into the active storage unit (and we haven't already decided to
1591 // start a new storage unit), just do so, regardless of any other
1592 // other consideration. Otherwise, round up to the right alignment.
1593 if (FieldSize == 0 || FieldSize > UnfilledBitsInLastUnit) {
Rui Ueyama83aa9792016-01-14 21:00:27 +00001594 FieldOffset = llvm::alignTo(FieldOffset, FieldAlign);
1595 UnpackedFieldOffset =
1596 llvm::alignTo(UnpackedFieldOffset, UnpackedFieldAlign);
John McCall30268ca2014-01-29 07:53:44 +00001597 UnfilledBitsInLastUnit = 0;
1598 }
1599
1600 } else {
1601 // #pragma pack, with any value, suppresses the insertion of padding.
1602 bool AllowPadding = MaxFieldAlignment.isZero();
1603
1604 // Compute the real offset.
1605 if (FieldSize == 0 ||
1606 (AllowPadding &&
1607 (FieldOffset & (FieldAlign-1)) + FieldSize > TypeSize)) {
Rui Ueyama83aa9792016-01-14 21:00:27 +00001608 FieldOffset = llvm::alignTo(FieldOffset, FieldAlign);
Sunil Srivastava0ce2f222016-02-05 20:50:02 +00001609 } else if (ExplicitFieldAlign &&
Alexey Bataev455bdd92016-02-19 11:23:28 +00001610 (MaxFieldAlignmentInBits == 0 ||
1611 ExplicitFieldAlign <= MaxFieldAlignmentInBits) &&
Sunil Srivastava0ce2f222016-02-05 20:50:02 +00001612 Context.getTargetInfo().useExplicitBitFieldAlignment()) {
Alexey Bataev567e30f2016-01-12 09:12:20 +00001613 // TODO: figure it out what needs to be done on targets that don't honor
1614 // bit-field type alignment like ARM APCS ABI.
Rui Ueyama83aa9792016-01-14 21:00:27 +00001615 FieldOffset = llvm::alignTo(FieldOffset, ExplicitFieldAlign);
John McCall30268ca2014-01-29 07:53:44 +00001616 }
1617
1618 // Repeat the computation for diagnostic purposes.
1619 if (FieldSize == 0 ||
1620 (AllowPadding &&
1621 (UnpackedFieldOffset & (UnpackedFieldAlign-1)) + FieldSize > TypeSize))
Rui Ueyama83aa9792016-01-14 21:00:27 +00001622 UnpackedFieldOffset =
1623 llvm::alignTo(UnpackedFieldOffset, UnpackedFieldAlign);
Sunil Srivastava0ce2f222016-02-05 20:50:02 +00001624 else if (ExplicitFieldAlign &&
Alexey Bataev455bdd92016-02-19 11:23:28 +00001625 (MaxFieldAlignmentInBits == 0 ||
1626 ExplicitFieldAlign <= MaxFieldAlignmentInBits) &&
Sunil Srivastava0ce2f222016-02-05 20:50:02 +00001627 Context.getTargetInfo().useExplicitBitFieldAlignment())
Rui Ueyama83aa9792016-01-14 21:00:27 +00001628 UnpackedFieldOffset =
1629 llvm::alignTo(UnpackedFieldOffset, ExplicitFieldAlign);
Eli Friedman2782dac2013-06-26 20:50:34 +00001630 }
1631
John McCall30268ca2014-01-29 07:53:44 +00001632 // If we're using external layout, give the external layout a chance
1633 // to override this information.
Reid Kleckner8b6d0342015-02-25 19:17:45 +00001634 if (UseExternalLayout)
Douglas Gregor44ba7892012-01-28 00:53:29 +00001635 FieldOffset = updateExternalFieldOffset(D, FieldOffset);
1636
John McCall30268ca2014-01-29 07:53:44 +00001637 // Okay, place the bitfield at the calculated offset.
Anders Carlsson07209442009-11-22 17:37:31 +00001638 FieldOffsets.push_back(FieldOffset);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001639
John McCall30268ca2014-01-29 07:53:44 +00001640 // Bookkeeping:
1641
1642 // Anonymous members don't affect the overall record alignment,
1643 // except on targets where they do.
1644 if (!IsMsStruct &&
1645 !Context.getTargetInfo().useZeroLengthBitfieldAlignment() &&
1646 !D->getIdentifier())
1647 FieldAlign = UnpackedFieldAlign = 1;
1648
1649 // Diagnose differences in layout due to padding or packing.
Reid Kleckner8b6d0342015-02-25 19:17:45 +00001650 if (!UseExternalLayout)
Douglas Gregore9fc3772012-01-26 07:55:45 +00001651 CheckFieldPadding(FieldOffset, UnpaddedFieldOffset, UnpackedFieldOffset,
1652 UnpackedFieldAlign, FieldPacked, D);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001653
Anders Carlssonba958402009-11-22 19:13:51 +00001654 // Update DataSize to include the last byte containing (part of) the bitfield.
John McCall30268ca2014-01-29 07:53:44 +00001655
1656 // For unions, this is just a max operation, as usual.
Anders Carlssonba958402009-11-22 19:13:51 +00001657 if (IsUnion) {
John McCall0d461692015-08-19 22:42:36 +00001658 // For ms_struct, allocate the entire storage unit --- unless this
1659 // is a zero-width bitfield, in which case just use a size of 1.
1660 uint64_t RoundedFieldSize;
1661 if (IsMsStruct) {
1662 RoundedFieldSize =
1663 (FieldSize ? TypeSize : Context.getTargetInfo().getCharWidth());
1664
1665 // Otherwise, allocate just the number of bytes required to store
1666 // the bitfield.
1667 } else {
1668 RoundedFieldSize = roundUpSizeToCharAlignment(FieldSize, Context);
1669 }
Artyom Skrobov5e63acc2014-10-17 10:22:03 +00001670 setDataSize(std::max(getDataSizeInBits(), RoundedFieldSize));
John McCall0d461692015-08-19 22:42:36 +00001671
John McCall30268ca2014-01-29 07:53:44 +00001672 // For non-zero-width bitfields in ms_struct structs, allocate a new
1673 // storage unit if necessary.
1674 } else if (IsMsStruct && FieldSize) {
1675 // We should have cleared UnfilledBitsInLastUnit in every case
1676 // where we changed storage units.
1677 if (!UnfilledBitsInLastUnit) {
1678 setDataSize(FieldOffset + TypeSize);
1679 UnfilledBitsInLastUnit = TypeSize;
Eli Friedman2782dac2013-06-26 20:50:34 +00001680 }
John McCall30268ca2014-01-29 07:53:44 +00001681 UnfilledBitsInLastUnit -= FieldSize;
1682 LastBitfieldTypeSize = TypeSize;
1683
1684 // Otherwise, bump the data size up to include the bitfield,
1685 // including padding up to char alignment, and then remember how
1686 // bits we didn't use.
1687 } else {
1688 uint64_t NewSizeInBits = FieldOffset + FieldSize;
1689 uint64_t CharAlignment = Context.getTargetInfo().getCharAlign();
Rui Ueyama83aa9792016-01-14 21:00:27 +00001690 setDataSize(llvm::alignTo(NewSizeInBits, CharAlignment));
John McCall30268ca2014-01-29 07:53:44 +00001691 UnfilledBitsInLastUnit = getDataSizeInBits() - NewSizeInBits;
1692
1693 // The only time we can get here for an ms_struct is if this is a
1694 // zero-width bitfield, which doesn't count as anything for the
1695 // purposes of unfilled bits.
1696 LastBitfieldTypeSize = 0;
Anders Carlssonba958402009-11-22 19:13:51 +00001697 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001698
Anders Carlssonba958402009-11-22 19:13:51 +00001699 // Update the size.
Ken Dyckecfc7552011-02-24 01:13:28 +00001700 setSize(std::max(getSizeInBits(), getDataSizeInBits()));
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001701
Anders Carlsson07209442009-11-22 17:37:31 +00001702 // Remember max struct/class alignment.
Ken Dyck85ef0432011-02-19 18:58:07 +00001703 UpdateAlignment(Context.toCharUnitsFromBits(FieldAlign),
1704 Context.toCharUnitsFromBits(UnpackedFieldAlign));
Anders Carlsson07209442009-11-22 17:37:31 +00001705}
1706
David Majnemer3b1c9902015-07-25 20:18:14 +00001707void ItaniumRecordLayoutBuilder::LayoutField(const FieldDecl *D,
1708 bool InsertExtraPadding) {
Anders Carlsson07209442009-11-22 17:37:31 +00001709 if (D->isBitField()) {
1710 LayoutBitField(D);
1711 return;
1712 }
1713
Eli Friedman2782dac2013-06-26 20:50:34 +00001714 uint64_t UnpaddedFieldOffset = getDataSizeInBits() - UnfilledBitsInLastUnit;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001715
Anders Carlssonba958402009-11-22 19:13:51 +00001716 // Reset the unfilled bits.
Eli Friedman2782dac2013-06-26 20:50:34 +00001717 UnfilledBitsInLastUnit = 0;
1718 LastBitfieldTypeSize = 0;
Anders Carlssonba958402009-11-22 19:13:51 +00001719
Anders Carlsson07209442009-11-22 17:37:31 +00001720 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Ken Dyck6d90e892011-02-20 02:06:09 +00001721 CharUnits FieldOffset =
Ken Dyckecfc7552011-02-24 01:13:28 +00001722 IsUnion ? CharUnits::Zero() : getDataSize();
Ken Dyck6d90e892011-02-20 02:06:09 +00001723 CharUnits FieldSize;
1724 CharUnits FieldAlign;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001725
Anders Carlsson07209442009-11-22 17:37:31 +00001726 if (D->getType()->isIncompleteArrayType()) {
1727 // This is a flexible array member; we can't directly
1728 // query getTypeInfo about these, so we figure it out here.
1729 // Flexible array members don't have any size, but they
1730 // have to be aligned appropriately for their element type.
Ken Dyck6d90e892011-02-20 02:06:09 +00001731 FieldSize = CharUnits::Zero();
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001732 const ArrayType* ATy = Context.getAsArrayType(D->getType());
Ken Dyck6d90e892011-02-20 02:06:09 +00001733 FieldAlign = Context.getTypeAlignInChars(ATy->getElementType());
Anders Carlsson07209442009-11-22 17:37:31 +00001734 } else if (const ReferenceType *RT = D->getType()->getAs<ReferenceType>()) {
1735 unsigned AS = RT->getPointeeType().getAddressSpace();
Ken Dyck6d90e892011-02-20 02:06:09 +00001736 FieldSize =
Douglas Gregore8bbc122011-09-02 00:18:52 +00001737 Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerWidth(AS));
Ken Dyck6d90e892011-02-20 02:06:09 +00001738 FieldAlign =
Douglas Gregore8bbc122011-09-02 00:18:52 +00001739 Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerAlign(AS));
Anders Carlsson79474332009-07-18 20:20:21 +00001740 } else {
Ken Dyck6d90e892011-02-20 02:06:09 +00001741 std::pair<CharUnits, CharUnits> FieldInfo =
1742 Context.getTypeInfoInChars(D->getType());
Anders Carlsson07209442009-11-22 17:37:31 +00001743 FieldSize = FieldInfo.first;
1744 FieldAlign = FieldInfo.second;
Chad Rosier18903ee2011-08-04 01:21:14 +00001745
Eli Friedman9ee2d0472012-10-12 23:29:20 +00001746 if (IsMsStruct) {
Douglas Gregordbe39272011-02-01 15:15:22 +00001747 // If MS bitfield layout is required, figure out what type is being
1748 // laid out and align the field to the width of that type.
1749
1750 // Resolve all typedefs down to their base type and round up the field
1751 // alignment if necessary.
1752 QualType T = Context.getBaseElementType(D->getType());
1753 if (const BuiltinType *BTy = T->getAs<BuiltinType>()) {
Ken Dyck6d90e892011-02-20 02:06:09 +00001754 CharUnits TypeSize = Context.getTypeSizeInChars(BTy);
Douglas Gregordbe39272011-02-01 15:15:22 +00001755 if (TypeSize > FieldAlign)
1756 FieldAlign = TypeSize;
1757 }
1758 }
Anders Carlsson79474332009-07-18 20:20:21 +00001759 }
Mike Stump11289f42009-09-09 15:08:12 +00001760
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001761 // The align if the field is not packed. This is to check if the attribute
1762 // was unnecessary (-Wpacked).
Ken Dyck6d90e892011-02-20 02:06:09 +00001763 CharUnits UnpackedFieldAlign = FieldAlign;
1764 CharUnits UnpackedFieldOffset = FieldOffset;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001765
Anders Carlsson07209442009-11-22 17:37:31 +00001766 if (FieldPacked)
Ken Dyck6d90e892011-02-20 02:06:09 +00001767 FieldAlign = CharUnits::One();
1768 CharUnits MaxAlignmentInChars =
1769 Context.toCharUnitsFromBits(D->getMaxAlignment());
1770 FieldAlign = std::max(FieldAlign, MaxAlignmentInChars);
1771 UnpackedFieldAlign = std::max(UnpackedFieldAlign, MaxAlignmentInChars);
Anders Carlsson07209442009-11-22 17:37:31 +00001772
1773 // The maximum field alignment overrides the aligned attribute.
Ken Dyck02ced6f2011-02-17 01:49:42 +00001774 if (!MaxFieldAlignment.isZero()) {
Ken Dyck6d90e892011-02-20 02:06:09 +00001775 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
1776 UnpackedFieldAlign = std::min(UnpackedFieldAlign, MaxFieldAlignment);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001777 }
Anders Carlsson07209442009-11-22 17:37:31 +00001778
Douglas Gregor44ba7892012-01-28 00:53:29 +00001779 // Round up the current record size to the field's alignment boundary.
Rui Ueyama83aa9792016-01-14 21:00:27 +00001780 FieldOffset = FieldOffset.alignTo(FieldAlign);
1781 UnpackedFieldOffset = UnpackedFieldOffset.alignTo(UnpackedFieldAlign);
Douglas Gregor44ba7892012-01-28 00:53:29 +00001782
Reid Kleckner8b6d0342015-02-25 19:17:45 +00001783 if (UseExternalLayout) {
Douglas Gregor44ba7892012-01-28 00:53:29 +00001784 FieldOffset = Context.toCharUnitsFromBits(
1785 updateExternalFieldOffset(D, Context.toBits(FieldOffset)));
1786
1787 if (!IsUnion && EmptySubobjects) {
1788 // Record the fact that we're placing a field at this offset.
1789 bool Allowed = EmptySubobjects->CanPlaceFieldAtOffset(D, FieldOffset);
1790 (void)Allowed;
1791 assert(Allowed && "Externally-placed field cannot be placed here");
1792 }
1793 } else {
Douglas Gregore9fc3772012-01-26 07:55:45 +00001794 if (!IsUnion && EmptySubobjects) {
1795 // Check if we can place the field at this offset.
1796 while (!EmptySubobjects->CanPlaceFieldAtOffset(D, FieldOffset)) {
1797 // We couldn't place the field at the offset. Try again at a new offset.
1798 FieldOffset += FieldAlign;
1799 }
Anders Carlsson07209442009-11-22 17:37:31 +00001800 }
Anders Carlsson07209442009-11-22 17:37:31 +00001801 }
Douglas Gregore9fc3772012-01-26 07:55:45 +00001802
Anders Carlsson79474332009-07-18 20:20:21 +00001803 // Place this field at the current location.
Ken Dyck6d90e892011-02-20 02:06:09 +00001804 FieldOffsets.push_back(Context.toBits(FieldOffset));
Mike Stump11289f42009-09-09 15:08:12 +00001805
Reid Kleckner8b6d0342015-02-25 19:17:45 +00001806 if (!UseExternalLayout)
1807 CheckFieldPadding(Context.toBits(FieldOffset), UnpaddedFieldOffset,
Douglas Gregore9fc3772012-01-26 07:55:45 +00001808 Context.toBits(UnpackedFieldOffset),
1809 Context.toBits(UnpackedFieldAlign), FieldPacked, D);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001810
Kostya Serebryany68c29da2014-10-27 19:34:10 +00001811 if (InsertExtraPadding) {
Kostya Serebryany293dc9b2014-10-16 20:54:52 +00001812 CharUnits ASanAlignment = CharUnits::fromQuantity(8);
1813 CharUnits ExtraSizeForAsan = ASanAlignment;
1814 if (FieldSize % ASanAlignment)
1815 ExtraSizeForAsan +=
1816 ASanAlignment - CharUnits::fromQuantity(FieldSize % ASanAlignment);
1817 FieldSize += ExtraSizeForAsan;
1818 }
1819
Anders Carlsson79474332009-07-18 20:20:21 +00001820 // Reserve space for this field.
Eli Friedman43f18342012-01-12 23:27:03 +00001821 uint64_t FieldSizeInBits = Context.toBits(FieldSize);
Anders Carlsson79474332009-07-18 20:20:21 +00001822 if (IsUnion)
Eli Friedman2e108372012-01-12 23:48:56 +00001823 setDataSize(std::max(getDataSizeInBits(), FieldSizeInBits));
Anders Carlsson79474332009-07-18 20:20:21 +00001824 else
Eli Friedman2e108372012-01-12 23:48:56 +00001825 setDataSize(FieldOffset + FieldSize);
Mike Stump11289f42009-09-09 15:08:12 +00001826
Eli Friedman2e108372012-01-12 23:48:56 +00001827 // Update the size.
1828 setSize(std::max(getSizeInBits(), getDataSizeInBits()));
Mike Stump11289f42009-09-09 15:08:12 +00001829
Anders Carlsson79474332009-07-18 20:20:21 +00001830 // Remember max struct/class alignment.
Ken Dyck6d90e892011-02-20 02:06:09 +00001831 UpdateAlignment(FieldAlign, UnpackedFieldAlign);
Anders Carlsson79474332009-07-18 20:20:21 +00001832}
1833
David Majnemer3b1c9902015-07-25 20:18:14 +00001834void ItaniumRecordLayoutBuilder::FinishLayout(const NamedDecl *D) {
Anders Carlsson79474332009-07-18 20:20:21 +00001835 // In C++, records cannot be of size 0.
David Blaikiebbafb8a2012-03-11 07:00:24 +00001836 if (Context.getLangOpts().CPlusPlus && getSizeInBits() == 0) {
Fariborz Jahanian09b23312011-02-02 19:36:18 +00001837 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
1838 // Compatibility with gcc requires a class (pod or non-pod)
1839 // which is not empty but of size 0; such as having fields of
1840 // array of zero-length, remains of Size 0
1841 if (RD->isEmpty())
Ken Dyck1b4420e2011-02-28 02:01:38 +00001842 setSize(CharUnits::One());
Fariborz Jahanian09b23312011-02-02 19:36:18 +00001843 }
1844 else
Ken Dyck1b4420e2011-02-28 02:01:38 +00001845 setSize(CharUnits::One());
Fariborz Jahanian09b23312011-02-02 19:36:18 +00001846 }
Eli Friedman83a12582011-12-01 00:37:01 +00001847
Douglas Gregor1423a5c2012-10-26 22:31:14 +00001848 // Finally, round the size of the record up to the alignment of the
1849 // record itself.
Eli Friedman2782dac2013-06-26 20:50:34 +00001850 uint64_t UnpaddedSize = getSizeInBits() - UnfilledBitsInLastUnit;
Douglas Gregor1423a5c2012-10-26 22:31:14 +00001851 uint64_t UnpackedSizeInBits =
Rui Ueyama83aa9792016-01-14 21:00:27 +00001852 llvm::alignTo(getSizeInBits(), Context.toBits(UnpackedAlignment));
Rui Ueyama83aa9792016-01-14 21:00:27 +00001853 uint64_t RoundedSize =
1854 llvm::alignTo(getSizeInBits(), Context.toBits(Alignment));
Douglas Gregor1423a5c2012-10-26 22:31:14 +00001855
Reid Kleckner8b6d0342015-02-25 19:17:45 +00001856 if (UseExternalLayout) {
Douglas Gregor1423a5c2012-10-26 22:31:14 +00001857 // If we're inferring alignment, and the external size is smaller than
1858 // our size after we've rounded up to alignment, conservatively set the
1859 // alignment to 1.
Reid Kleckner8b6d0342015-02-25 19:17:45 +00001860 if (InferAlignment && External.Size < RoundedSize) {
Douglas Gregor1423a5c2012-10-26 22:31:14 +00001861 Alignment = CharUnits::One();
1862 InferAlignment = false;
1863 }
Reid Kleckner8b6d0342015-02-25 19:17:45 +00001864 setSize(External.Size);
Douglas Gregor1423a5c2012-10-26 22:31:14 +00001865 return;
1866 }
1867
Douglas Gregor1423a5c2012-10-26 22:31:14 +00001868 // Set the size to the final size.
1869 setSize(RoundedSize);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001870
Douglas Gregore8bbc122011-09-02 00:18:52 +00001871 unsigned CharBitNum = Context.getTargetInfo().getCharWidth();
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001872 if (const RecordDecl *RD = dyn_cast<RecordDecl>(D)) {
1873 // Warn if padding was introduced to the struct/class/union.
Ken Dyckecfc7552011-02-24 01:13:28 +00001874 if (getSizeInBits() > UnpaddedSize) {
1875 unsigned PadSize = getSizeInBits() - UnpaddedSize;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001876 bool InBits = true;
1877 if (PadSize % CharBitNum == 0) {
1878 PadSize = PadSize / CharBitNum;
1879 InBits = false;
1880 }
1881 Diag(RD->getLocation(), diag::warn_padded_struct_size)
1882 << Context.getTypeDeclType(RD)
1883 << PadSize
Benjamin Kramerc06b6bd2015-08-21 12:51:01 +00001884 << (InBits ? 1 : 0); // (byte|bit)
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001885 }
1886
Yan Wangd79f3f62017-08-01 21:41:39 +00001887 // Warn if we packed it unnecessarily, when the unpacked alignment is not
1888 // greater than the one after packing, the size in bits doesn't change and
1889 // the offset of each field is identical.
1890 if (Packed && UnpackedAlignment <= Alignment &&
1891 UnpackedSizeInBits == getSizeInBits() && !HasPackedField)
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001892 Diag(D->getLocation(), diag::warn_unnecessary_packed)
1893 << Context.getTypeDeclType(RD);
1894 }
Anders Carlsson79474332009-07-18 20:20:21 +00001895}
1896
David Majnemer3b1c9902015-07-25 20:18:14 +00001897void ItaniumRecordLayoutBuilder::UpdateAlignment(
1898 CharUnits NewAlignment, CharUnits UnpackedNewAlignment) {
Douglas Gregore9fc3772012-01-26 07:55:45 +00001899 // The alignment is not modified when using 'mac68k' alignment or when
Douglas Gregor44ba7892012-01-28 00:53:29 +00001900 // we have an externally-supplied layout that also provides overall alignment.
Reid Kleckner8b6d0342015-02-25 19:17:45 +00001901 if (IsMac68kAlign || (UseExternalLayout && !InferAlignment))
Daniel Dunbar6da10982010-05-27 05:45:51 +00001902 return;
1903
Ken Dyck85ef0432011-02-19 18:58:07 +00001904 if (NewAlignment > Alignment) {
Reid Kleckner5a63d702015-03-24 23:46:25 +00001905 assert(llvm::isPowerOf2_64(NewAlignment.getQuantity()) &&
1906 "Alignment not a power of 2");
Ken Dyck85ef0432011-02-19 18:58:07 +00001907 Alignment = NewAlignment;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001908 }
1909
Ken Dyck85ef0432011-02-19 18:58:07 +00001910 if (UnpackedNewAlignment > UnpackedAlignment) {
Reid Kleckner5a63d702015-03-24 23:46:25 +00001911 assert(llvm::isPowerOf2_64(UnpackedNewAlignment.getQuantity()) &&
1912 "Alignment not a power of 2");
Ken Dyck85ef0432011-02-19 18:58:07 +00001913 UnpackedAlignment = UnpackedNewAlignment;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001914 }
1915}
1916
Douglas Gregor44ba7892012-01-28 00:53:29 +00001917uint64_t
David Majnemer3b1c9902015-07-25 20:18:14 +00001918ItaniumRecordLayoutBuilder::updateExternalFieldOffset(const FieldDecl *Field,
1919 uint64_t ComputedOffset) {
Reid Kleckner8b6d0342015-02-25 19:17:45 +00001920 uint64_t ExternalFieldOffset = External.getExternalFieldOffset(Field);
NAKAMURA Takumi472041f2015-02-25 10:32:20 +00001921
Douglas Gregor44ba7892012-01-28 00:53:29 +00001922 if (InferAlignment && ExternalFieldOffset < ComputedOffset) {
1923 // The externally-supplied field offset is before the field offset we
1924 // computed. Assume that the structure is packed.
Douglas Gregor1423a5c2012-10-26 22:31:14 +00001925 Alignment = CharUnits::One();
Douglas Gregor44ba7892012-01-28 00:53:29 +00001926 InferAlignment = false;
1927 }
1928
1929 // Use the externally-supplied field offset.
Benjamin Kramer648e68b2012-08-31 22:14:25 +00001930 return ExternalFieldOffset;
1931}
1932
1933/// \brief Get diagnostic %select index for tag kind for
1934/// field padding diagnostic message.
1935/// WARNING: Indexes apply to particular diagnostics only!
1936///
1937/// \returns diagnostic %select index.
1938static unsigned getPaddingDiagFromTagKind(TagTypeKind Tag) {
1939 switch (Tag) {
1940 case TTK_Struct: return 0;
1941 case TTK_Interface: return 1;
1942 case TTK_Class: return 2;
1943 default: llvm_unreachable("Invalid tag kind for field padding diagnostic!");
1944 }
1945}
1946
David Majnemer3b1c9902015-07-25 20:18:14 +00001947void ItaniumRecordLayoutBuilder::CheckFieldPadding(
1948 uint64_t Offset, uint64_t UnpaddedOffset, uint64_t UnpackedOffset,
1949 unsigned UnpackedAlign, bool isPacked, const FieldDecl *D) {
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001950 // We let objc ivars without warning, objc interfaces generally are not used
1951 // for padding tricks.
1952 if (isa<ObjCIvarDecl>(D))
Anders Carlsson79474332009-07-18 20:20:21 +00001953 return;
Mike Stump11289f42009-09-09 15:08:12 +00001954
Ted Kremenekfed48af2011-09-06 19:40:45 +00001955 // Don't warn about structs created without a SourceLocation. This can
1956 // be done by clients of the AST, such as codegen.
1957 if (D->getLocation().isInvalid())
1958 return;
1959
Douglas Gregore8bbc122011-09-02 00:18:52 +00001960 unsigned CharBitNum = Context.getTargetInfo().getCharWidth();
Mike Stump11289f42009-09-09 15:08:12 +00001961
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001962 // Warn if padding was introduced to the struct/class.
1963 if (!IsUnion && Offset > UnpaddedOffset) {
1964 unsigned PadSize = Offset - UnpaddedOffset;
1965 bool InBits = true;
1966 if (PadSize % CharBitNum == 0) {
1967 PadSize = PadSize / CharBitNum;
1968 InBits = false;
Benjamin Kramer648e68b2012-08-31 22:14:25 +00001969 }
1970 if (D->getIdentifier())
1971 Diag(D->getLocation(), diag::warn_padded_struct_field)
1972 << getPaddingDiagFromTagKind(D->getParent()->getTagKind())
1973 << Context.getTypeDeclType(D->getParent())
1974 << PadSize
Benjamin Kramerc06b6bd2015-08-21 12:51:01 +00001975 << (InBits ? 1 : 0) // (byte|bit)
Benjamin Kramer648e68b2012-08-31 22:14:25 +00001976 << D->getIdentifier();
1977 else
1978 Diag(D->getLocation(), diag::warn_padded_struct_anon_field)
1979 << getPaddingDiagFromTagKind(D->getParent()->getTagKind())
1980 << Context.getTypeDeclType(D->getParent())
1981 << PadSize
Benjamin Kramerc06b6bd2015-08-21 12:51:01 +00001982 << (InBits ? 1 : 0); // (byte|bit)
Yan Wangd79f3f62017-08-01 21:41:39 +00001983 }
1984 if (isPacked && Offset != UnpackedOffset) {
1985 HasPackedField = true;
1986 }
Anders Carlsson79474332009-07-18 20:20:21 +00001987}
Mike Stump11289f42009-09-09 15:08:12 +00001988
John McCall6bd2a892013-01-25 22:31:03 +00001989static const CXXMethodDecl *computeKeyFunction(ASTContext &Context,
1990 const CXXRecordDecl *RD) {
Daniel Dunbarccabe482010-04-19 20:44:53 +00001991 // If a class isn't polymorphic it doesn't have a key function.
Anders Carlsson5ebf8b42009-12-07 04:35:11 +00001992 if (!RD->isPolymorphic())
Craig Topper36250ad2014-05-12 05:36:57 +00001993 return nullptr;
Eli Friedmanf2c79b62009-12-08 03:56:49 +00001994
Eli Friedman300f55d2011-06-10 21:53:06 +00001995 // A class that is not externally visible doesn't have a key function. (Or
Eli Friedmanf2c79b62009-12-08 03:56:49 +00001996 // at least, there's no point to assigning a key function to such a class;
1997 // this doesn't affect the ABI.)
Rafael Espindola3ae00052013-05-13 00:12:11 +00001998 if (!RD->isExternallyVisible())
Craig Topper36250ad2014-05-12 05:36:57 +00001999 return nullptr;
Eli Friedmanf2c79b62009-12-08 03:56:49 +00002000
Richard Smith750f5112014-03-24 23:54:09 +00002001 // Template instantiations don't have key functions per Itanium C++ ABI 5.2.6.
Argyrios Kyrtzidis8c64bbe2010-10-13 02:39:41 +00002002 // Same behavior as GCC.
2003 TemplateSpecializationKind TSK = RD->getTemplateSpecializationKind();
2004 if (TSK == TSK_ImplicitInstantiation ||
Richard Smith750f5112014-03-24 23:54:09 +00002005 TSK == TSK_ExplicitInstantiationDeclaration ||
Argyrios Kyrtzidis8c64bbe2010-10-13 02:39:41 +00002006 TSK == TSK_ExplicitInstantiationDefinition)
Craig Topper36250ad2014-05-12 05:36:57 +00002007 return nullptr;
Argyrios Kyrtzidis8c64bbe2010-10-13 02:39:41 +00002008
John McCall6bd2a892013-01-25 22:31:03 +00002009 bool allowInlineFunctions =
2010 Context.getTargetInfo().getCXXABI().canKeyFunctionBeInline();
2011
David Majnemerc964b4b2014-07-16 06:04:00 +00002012 for (const CXXMethodDecl *MD : RD->methods()) {
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002013 if (!MD->isVirtual())
2014 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002015
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002016 if (MD->isPure())
2017 continue;
Eli Friedmanf2c79b62009-12-08 03:56:49 +00002018
Anders Carlssonf98849e2009-12-02 17:15:43 +00002019 // Ignore implicit member functions, they are always marked as inline, but
2020 // they don't have a body until they're defined.
2021 if (MD->isImplicit())
2022 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002023
Douglas Gregora318efd2010-01-05 19:06:31 +00002024 if (MD->isInlineSpecified())
2025 continue;
Eli Friedman71a26d82009-12-06 20:50:05 +00002026
2027 if (MD->hasInlineBody())
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002028 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002029
Benjamin Kramer4a902082012-08-03 15:43:22 +00002030 // Ignore inline deleted or defaulted functions.
Benjamin Kramer73d1be72012-08-03 08:39:58 +00002031 if (!MD->isUserProvided())
2032 continue;
2033
John McCall6bd2a892013-01-25 22:31:03 +00002034 // In certain ABIs, ignore functions with out-of-line inline definitions.
2035 if (!allowInlineFunctions) {
2036 const FunctionDecl *Def;
2037 if (MD->hasBody(Def) && Def->isInlineSpecified())
2038 continue;
2039 }
2040
Artem Belevich9b929462015-12-17 18:12:36 +00002041 if (Context.getLangOpts().CUDA) {
2042 // While compiler may see key method in this TU, during CUDA
2043 // compilation we should ignore methods that are not accessible
2044 // on this side of compilation.
2045 if (Context.getLangOpts().CUDAIsDevice) {
2046 // In device mode ignore methods without __device__ attribute.
2047 if (!MD->hasAttr<CUDADeviceAttr>())
2048 continue;
2049 } else {
2050 // In host mode ignore __device__-only methods.
2051 if (!MD->hasAttr<CUDAHostAttr>() && MD->hasAttr<CUDADeviceAttr>())
2052 continue;
2053 }
2054 }
2055
Reid Klecknerc2e3ba42015-08-10 19:39:01 +00002056 // If the key function is dllimport but the class isn't, then the class has
2057 // no key function. The DLL that exports the key function won't export the
2058 // vtable in this case.
2059 if (MD->hasAttr<DLLImportAttr>() && !RD->hasAttr<DLLImportAttr>())
2060 return nullptr;
2061
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002062 // We found it.
2063 return MD;
2064 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002065
Craig Topper36250ad2014-05-12 05:36:57 +00002066 return nullptr;
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00002067}
2068
David Majnemer3b1c9902015-07-25 20:18:14 +00002069DiagnosticBuilder ItaniumRecordLayoutBuilder::Diag(SourceLocation Loc,
2070 unsigned DiagID) {
Argyrios Kyrtzidisd0040642010-11-18 20:06:41 +00002071 return Context.getDiagnostics().Report(Loc, DiagID);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00002072}
2073
John McCall5c1f1d02013-01-29 01:14:22 +00002074/// Does the target C++ ABI require us to skip over the tail-padding
2075/// of the given class (considering it as a base class) when allocating
2076/// objects?
2077static bool mustSkipTailPadding(TargetCXXABI ABI, const CXXRecordDecl *RD) {
2078 switch (ABI.getTailPaddingUseRules()) {
2079 case TargetCXXABI::AlwaysUseTailPadding:
2080 return false;
2081
2082 case TargetCXXABI::UseTailPaddingUnlessPOD03:
2083 // FIXME: To the extent that this is meant to cover the Itanium ABI
2084 // rules, we should implement the restrictions about over-sized
2085 // bitfields:
2086 //
2087 // http://mentorembedded.github.com/cxx-abi/abi.html#POD :
2088 // In general, a type is considered a POD for the purposes of
2089 // layout if it is a POD type (in the sense of ISO C++
2090 // [basic.types]). However, a POD-struct or POD-union (in the
2091 // sense of ISO C++ [class]) with a bitfield member whose
2092 // declared width is wider than the declared type of the
2093 // bitfield is not a POD for the purpose of layout. Similarly,
2094 // an array type is not a POD for the purpose of layout if the
2095 // element type of the array is not a POD for the purpose of
2096 // layout.
2097 //
2098 // Where references to the ISO C++ are made in this paragraph,
2099 // the Technical Corrigendum 1 version of the standard is
2100 // intended.
2101 return RD->isPOD();
2102
2103 case TargetCXXABI::UseTailPaddingUnlessPOD11:
2104 // This is equivalent to RD->getTypeForDecl().isCXX11PODType(),
2105 // but with a lot of abstraction penalty stripped off. This does
2106 // assume that these properties are set correctly even in C++98
2107 // mode; fortunately, that is true because we want to assign
2108 // consistently semantics to the type-traits intrinsics (or at
2109 // least as many of them as possible).
2110 return RD->isTrivial() && RD->isStandardLayout();
2111 }
2112
2113 llvm_unreachable("bad tail-padding use kind");
2114}
2115
David Majnemer3b1c9902015-07-25 20:18:14 +00002116static bool isMsLayout(const ASTContext &Context) {
2117 return Context.getTargetInfo().getCXXABI().isMicrosoft();
Warren Hunt8f8bad72013-10-11 20:19:00 +00002118}
2119
2120// This section contains an implementation of struct layout that is, up to the
Warren Hunt917f97f2014-04-11 00:54:15 +00002121// included tests, compatible with cl.exe (2013). The layout produced is
Warren Hunt8f8bad72013-10-11 20:19:00 +00002122// significantly different than those produced by the Itanium ABI. Here we note
2123// the most important differences.
2124//
2125// * The alignment of bitfields in unions is ignored when computing the
2126// alignment of the union.
Alp Tokerf6a24ce2013-12-05 16:25:25 +00002127// * The existence of zero-width bitfield that occurs after anything other than
Warren Hunt8f8bad72013-10-11 20:19:00 +00002128// a non-zero length bitfield is ignored.
Warren Hunt917f97f2014-04-11 00:54:15 +00002129// * There is no explicit primary base for the purposes of layout. All bases
2130// with vfptrs are laid out first, followed by all bases without vfptrs.
Warren Hunt8f8bad72013-10-11 20:19:00 +00002131// * The Itanium equivalent vtable pointers are split into a vfptr (virtual
2132// function pointer) and a vbptr (virtual base pointer). They can each be
Warren Hunt55d8e822013-10-23 23:53:07 +00002133// shared with a, non-virtual bases. These bases need not be the same. vfptrs
Warren Hunt917f97f2014-04-11 00:54:15 +00002134// always occur at offset 0. vbptrs can occur at an arbitrary offset and are
David Majnemer07639702016-02-12 19:21:02 +00002135// placed after the lexicographically last non-virtual base. This placement
Warren Hunt917f97f2014-04-11 00:54:15 +00002136// is always before fields but can be in the middle of the non-virtual bases
2137// due to the two-pass layout scheme for non-virtual-bases.
Warren Hunt8f8bad72013-10-11 20:19:00 +00002138// * Virtual bases sometimes require a 'vtordisp' field that is laid out before
2139// the virtual base and is used in conjunction with virtual overrides during
Warren Hunt917f97f2014-04-11 00:54:15 +00002140// construction and destruction. This is always a 4 byte value and is used as
2141// an alternative to constructor vtables.
Warren Hunt8f8bad72013-10-11 20:19:00 +00002142// * vtordisps are allocated in a block of memory with size and alignment equal
2143// to the alignment of the completed structure (before applying __declspec(
Warren Hunt55d8e822013-10-23 23:53:07 +00002144// align())). The vtordisp always occur at the end of the allocation block,
2145// immediately prior to the virtual base.
Warren Hunt917f97f2014-04-11 00:54:15 +00002146// * vfptrs are injected after all bases and fields have been laid out. In
2147// order to guarantee proper alignment of all fields, the vfptr injection
2148// pushes all bases and fields back by the alignment imposed by those bases
2149// and fields. This can potentially add a significant amount of padding.
2150// vfptrs are always injected at offset 0.
2151// * vbptrs are injected after all bases and fields have been laid out. In
2152// order to guarantee proper alignment of all fields, the vfptr injection
2153// pushes all bases and fields back by the alignment imposed by those bases
2154// and fields. This can potentially add a significant amount of padding.
2155// vbptrs are injected immediately after the last non-virtual base as
David Majnemer07639702016-02-12 19:21:02 +00002156// lexicographically ordered in the code. If this site isn't pointer aligned
Warren Hunt917f97f2014-04-11 00:54:15 +00002157// the vbptr is placed at the next properly aligned location. Enough padding
2158// is added to guarantee a fit.
2159// * The last zero sized non-virtual base can be placed at the end of the
2160// struct (potentially aliasing another object), or may alias with the first
2161// field, even if they are of the same type.
2162// * The last zero size virtual base may be placed at the end of the struct
2163// potentially aliasing another object.
Warren Hunt049f6732013-12-06 19:54:25 +00002164// * The ABI attempts to avoid aliasing of zero sized bases by adding padding
2165// between bases or vbases with specific properties. The criteria for
2166// additional padding between two bases is that the first base is zero sized
Warren Hunt39a907b2014-04-09 21:57:24 +00002167// or ends with a zero sized subobject and the second base is zero sized or
Warren Hunt917f97f2014-04-11 00:54:15 +00002168// trails with a zero sized base or field (sharing of vfptrs can reorder the
2169// layout of the so the leading base is not always the first one declared).
2170// This rule does take into account fields that are not records, so padding
2171// will occur even if the last field is, e.g. an int. The padding added for
2172// bases is 1 byte. The padding added between vbases depends on the alignment
2173// of the object but is at least 4 bytes (in both 32 and 64 bit modes).
2174// * There is no concept of non-virtual alignment, non-virtual alignment and
2175// alignment are always identical.
2176// * There is a distinction between alignment and required alignment.
2177// __declspec(align) changes the required alignment of a struct. This
2178// alignment is _always_ obeyed, even in the presence of #pragma pack. A
Justin Bogner2ca9a4a2014-10-08 05:45:39 +00002179// record inherits required alignment from all of its fields and bases.
Warren Huntf4518def2014-01-10 01:28:05 +00002180// * __declspec(align) on bitfields has the effect of changing the bitfield's
Warren Hunt917f97f2014-04-11 00:54:15 +00002181// alignment instead of its required alignment. This is the only known way
2182// to make the alignment of a struct bigger than 8. Interestingly enough
2183// this alignment is also immune to the effects of #pragma pack and can be
2184// used to create structures with large alignment under #pragma pack.
2185// However, because it does not impact required alignment, such a structure,
2186// when used as a field or base, will not be aligned if #pragma pack is
2187// still active at the time of use.
2188//
Alp Toker08f6e9e2014-05-05 19:53:42 +00002189// Known incompatibilities:
Warren Hunt917f97f2014-04-11 00:54:15 +00002190// * all: #pragma pack between fields in a record
2191// * 2010 and back: If the last field in a record is a bitfield, every object
2192// laid out after the record will have extra padding inserted before it. The
2193// extra padding will have size equal to the size of the storage class of the
2194// bitfield. 0 sized bitfields don't exhibit this behavior and the extra
2195// padding can be avoided by adding a 0 sized bitfield after the non-zero-
2196// sized bitfield.
2197// * 2012 and back: In 64-bit mode, if the alignment of a record is 16 or
2198// greater due to __declspec(align()) then a second layout phase occurs after
2199// The locations of the vf and vb pointers are known. This layout phase
2200// suffers from the "last field is a bitfield" bug in 2010 and results in
2201// _every_ field getting padding put in front of it, potentially including the
2202// vfptr, leaving the vfprt at a non-zero location which results in a fault if
2203// anything tries to read the vftbl. The second layout phase also treats
Alp Toker08f6e9e2014-05-05 19:53:42 +00002204// bitfields as separate entities and gives them each storage rather than
Warren Hunt917f97f2014-04-11 00:54:15 +00002205// packing them. Additionally, because this phase appears to perform a
2206// (an unstable) sort on the members before laying them out and because merged
2207// bitfields have the same address, the bitfields end up in whatever order
2208// the sort left them in, a behavior we could never hope to replicate.
Warren Hunt8f8bad72013-10-11 20:19:00 +00002209
2210namespace {
2211struct MicrosoftRecordLayoutBuilder {
Warren Huntd640d7d2014-01-09 00:30:56 +00002212 struct ElementInfo {
2213 CharUnits Size;
2214 CharUnits Alignment;
2215 };
Warren Hunt8f8bad72013-10-11 20:19:00 +00002216 typedef llvm::DenseMap<const CXXRecordDecl *, CharUnits> BaseOffsetsMapTy;
2217 MicrosoftRecordLayoutBuilder(const ASTContext &Context) : Context(Context) {}
2218private:
Aaron Ballmanabc18922015-02-15 22:54:08 +00002219 MicrosoftRecordLayoutBuilder(const MicrosoftRecordLayoutBuilder &) = delete;
2220 void operator=(const MicrosoftRecordLayoutBuilder &) = delete;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002221public:
Warren Hunt8f8bad72013-10-11 20:19:00 +00002222 void layout(const RecordDecl *RD);
2223 void cxxLayout(const CXXRecordDecl *RD);
2224 /// \brief Initializes size and alignment and honors some flags.
2225 void initializeLayout(const RecordDecl *RD);
2226 /// \brief Initialized C++ layout, compute alignment and virtual alignment and
Alp Tokerf6a24ce2013-12-05 16:25:25 +00002227 /// existence of vfptrs and vbptrs. Alignment is needed before the vfptr is
Warren Hunt8f8bad72013-10-11 20:19:00 +00002228 /// laid out.
2229 void initializeCXXLayout(const CXXRecordDecl *RD);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002230 void layoutNonVirtualBases(const CXXRecordDecl *RD);
David Majnemercd3ebfe2016-05-23 17:16:12 +00002231 void layoutNonVirtualBase(const CXXRecordDecl *RD,
2232 const CXXRecordDecl *BaseDecl,
Warren Huntd640d7d2014-01-09 00:30:56 +00002233 const ASTRecordLayout &BaseLayout,
2234 const ASTRecordLayout *&PreviousBaseLayout);
2235 void injectVFPtr(const CXXRecordDecl *RD);
2236 void injectVBPtr(const CXXRecordDecl *RD);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002237 /// \brief Lays out the fields of the record. Also rounds size up to
2238 /// alignment.
2239 void layoutFields(const RecordDecl *RD);
2240 void layoutField(const FieldDecl *FD);
2241 void layoutBitField(const FieldDecl *FD);
2242 /// \brief Lays out a single zero-width bit-field in the record and handles
2243 /// special cases associated with zero-width bit-fields.
2244 void layoutZeroWidthBitField(const FieldDecl *FD);
2245 void layoutVirtualBases(const CXXRecordDecl *RD);
Warren Hunt1603e522013-12-10 01:44:39 +00002246 void finalizeLayout(const RecordDecl *RD);
Warren Huntd640d7d2014-01-09 00:30:56 +00002247 /// \brief Gets the size and alignment of a base taking pragma pack and
2248 /// __declspec(align) into account.
Warren Hunt5d9eebf2014-04-10 22:15:18 +00002249 ElementInfo getAdjustedElementInfo(const ASTRecordLayout &Layout);
Warren Huntd640d7d2014-01-09 00:30:56 +00002250 /// \brief Gets the size and alignment of a field taking pragma pack and
2251 /// __declspec(align) into account. It also updates RequiredAlignment as a
2252 /// side effect because it is most convenient to do so here.
2253 ElementInfo getAdjustedElementInfo(const FieldDecl *FD);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002254 /// \brief Places a field at an offset in CharUnits.
2255 void placeFieldAtOffset(CharUnits FieldOffset) {
2256 FieldOffsets.push_back(Context.toBits(FieldOffset));
2257 }
2258 /// \brief Places a bitfield at a bit offset.
2259 void placeFieldAtBitOffset(uint64_t FieldOffset) {
2260 FieldOffsets.push_back(FieldOffset);
2261 }
2262 /// \brief Compute the set of virtual bases for which vtordisps are required.
David Majnemerc2e67532014-09-23 22:58:15 +00002263 void computeVtorDispSet(
2264 llvm::SmallPtrSetImpl<const CXXRecordDecl *> &HasVtorDispSet,
2265 const CXXRecordDecl *RD) const;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002266 const ASTContext &Context;
2267 /// \brief The size of the record being laid out.
2268 CharUnits Size;
Warren Huntf6ec7482014-02-21 01:40:35 +00002269 /// \brief The non-virtual size of the record layout.
2270 CharUnits NonVirtualSize;
2271 /// \brief The data size of the record layout.
Warren Huntd640d7d2014-01-09 00:30:56 +00002272 CharUnits DataSize;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002273 /// \brief The current alignment of the record layout.
2274 CharUnits Alignment;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002275 /// \brief The maximum allowed field alignment. This is set by #pragma pack.
2276 CharUnits MaxFieldAlignment;
Warren Hunt7b252d22013-12-06 00:01:17 +00002277 /// \brief The alignment that this record must obey. This is imposed by
2278 /// __declspec(align()) on the record itself or one of its fields or bases.
2279 CharUnits RequiredAlignment;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002280 /// \brief The size of the allocation of the currently active bitfield.
2281 /// This value isn't meaningful unless LastFieldIsNonZeroWidthBitfield
2282 /// is true.
2283 CharUnits CurrentBitfieldSize;
Warren Huntd640d7d2014-01-09 00:30:56 +00002284 /// \brief Offset to the virtual base table pointer (if one exists).
2285 CharUnits VBPtrOffset;
David Majnemer00a061d2014-09-30 06:45:43 +00002286 /// \brief Minimum record size possible.
2287 CharUnits MinEmptyStructSize;
Warren Huntd640d7d2014-01-09 00:30:56 +00002288 /// \brief The size and alignment info of a pointer.
2289 ElementInfo PointerInfo;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002290 /// \brief The primary base class (if one exists).
2291 const CXXRecordDecl *PrimaryBase;
2292 /// \brief The class we share our vb-pointer with.
2293 const CXXRecordDecl *SharedVBPtrBase;
Warren Huntd640d7d2014-01-09 00:30:56 +00002294 /// \brief The collection of field offsets.
2295 SmallVector<uint64_t, 16> FieldOffsets;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002296 /// \brief Base classes and their offsets in the record.
2297 BaseOffsetsMapTy Bases;
2298 /// \brief virtual base classes and their offsets in the record.
2299 ASTRecordLayout::VBaseOffsetsMapTy VBases;
Warren Huntd640d7d2014-01-09 00:30:56 +00002300 /// \brief The number of remaining bits in our last bitfield allocation.
2301 /// This value isn't meaningful unless LastFieldIsNonZeroWidthBitfield is
2302 /// true.
2303 unsigned RemainingBitsInField;
2304 bool IsUnion : 1;
2305 /// \brief True if the last field laid out was a bitfield and was not 0
2306 /// width.
2307 bool LastFieldIsNonZeroWidthBitfield : 1;
2308 /// \brief True if the class has its own vftable pointer.
2309 bool HasOwnVFPtr : 1;
2310 /// \brief True if the class has a vbtable pointer.
2311 bool HasVBPtr : 1;
Warren Hunt39a907b2014-04-09 21:57:24 +00002312 /// \brief True if the last sub-object within the type is zero sized or the
2313 /// object itself is zero sized. This *does not* count members that are not
2314 /// records. Only used for MS-ABI.
2315 bool EndsWithZeroSizedObject : 1;
Warren Hunt049f6732013-12-06 19:54:25 +00002316 /// \brief True if this class is zero sized or first base is zero sized or
2317 /// has this property. Only used for MS-ABI.
2318 bool LeadsWithZeroSizedBase : 1;
Reid Kleckner8b6d0342015-02-25 19:17:45 +00002319
2320 /// \brief True if the external AST source provided a layout for this record.
2321 bool UseExternalLayout : 1;
2322
2323 /// \brief The layout provided by the external AST source. Only active if
2324 /// UseExternalLayout is true.
2325 ExternalLayout External;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002326};
2327} // namespace
2328
Warren Huntd640d7d2014-01-09 00:30:56 +00002329MicrosoftRecordLayoutBuilder::ElementInfo
2330MicrosoftRecordLayoutBuilder::getAdjustedElementInfo(
Warren Hunt5d9eebf2014-04-10 22:15:18 +00002331 const ASTRecordLayout &Layout) {
Warren Huntd640d7d2014-01-09 00:30:56 +00002332 ElementInfo Info;
2333 Info.Alignment = Layout.getAlignment();
2334 // Respect pragma pack.
Warren Hunt7b252d22013-12-06 00:01:17 +00002335 if (!MaxFieldAlignment.isZero())
Warren Huntd640d7d2014-01-09 00:30:56 +00002336 Info.Alignment = std::min(Info.Alignment, MaxFieldAlignment);
2337 // Track zero-sized subobjects here where it's already available.
David Majnemercd3ebfe2016-05-23 17:16:12 +00002338 EndsWithZeroSizedObject = Layout.endsWithZeroSizedObject();
Warren Huntd640d7d2014-01-09 00:30:56 +00002339 // Respect required alignment, this is necessary because we may have adjusted
Warren Hunt94258912014-01-11 01:16:40 +00002340 // the alignment in the case of pragam pack. Note that the required alignment
2341 // doesn't actually apply to the struct alignment at this point.
2342 Alignment = std::max(Alignment, Info.Alignment);
Warren Hunt5d9eebf2014-04-10 22:15:18 +00002343 RequiredAlignment = std::max(RequiredAlignment, Layout.getRequiredAlignment());
Warren Huntd640d7d2014-01-09 00:30:56 +00002344 Info.Alignment = std::max(Info.Alignment, Layout.getRequiredAlignment());
Warren Hunt5d9eebf2014-04-10 22:15:18 +00002345 Info.Size = Layout.getNonVirtualSize();
Warren Huntd640d7d2014-01-09 00:30:56 +00002346 return Info;
Warren Hunt7b252d22013-12-06 00:01:17 +00002347}
2348
Warren Huntd640d7d2014-01-09 00:30:56 +00002349MicrosoftRecordLayoutBuilder::ElementInfo
2350MicrosoftRecordLayoutBuilder::getAdjustedElementInfo(
2351 const FieldDecl *FD) {
David Majnemer34b57492014-07-30 01:30:47 +00002352 // Get the alignment of the field type's natural alignment, ignore any
2353 // alignment attributes.
Warren Huntd640d7d2014-01-09 00:30:56 +00002354 ElementInfo Info;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00002355 std::tie(Info.Size, Info.Alignment) =
David Majnemer34b57492014-07-30 01:30:47 +00002356 Context.getTypeInfoInChars(FD->getType()->getUnqualifiedDesugaredType());
2357 // Respect align attributes on the field.
2358 CharUnits FieldRequiredAlignment =
Warren Huntf4518def2014-01-10 01:28:05 +00002359 Context.toCharUnitsFromBits(FD->getMaxAlignment());
David Majnemer34b57492014-07-30 01:30:47 +00002360 // Respect align attributes on the type.
2361 if (Context.isAlignmentRequired(FD->getType()))
2362 FieldRequiredAlignment = std::max(
2363 Context.getTypeAlignInChars(FD->getType()), FieldRequiredAlignment);
Warren Hunt049f6732013-12-06 19:54:25 +00002364 // Respect attributes applied to subobjects of the field.
Warren Hunt5d9eebf2014-04-10 22:15:18 +00002365 if (FD->isBitField())
2366 // For some reason __declspec align impacts alignment rather than required
2367 // alignment when it is applied to bitfields.
Warren Huntf4518def2014-01-10 01:28:05 +00002368 Info.Alignment = std::max(Info.Alignment, FieldRequiredAlignment);
Warren Hunt5d9eebf2014-04-10 22:15:18 +00002369 else {
2370 if (auto RT =
2371 FD->getType()->getBaseElementTypeUnsafe()->getAs<RecordType>()) {
2372 auto const &Layout = Context.getASTRecordLayout(RT->getDecl());
David Majnemercd3ebfe2016-05-23 17:16:12 +00002373 EndsWithZeroSizedObject = Layout.endsWithZeroSizedObject();
Warren Hunt5d9eebf2014-04-10 22:15:18 +00002374 FieldRequiredAlignment = std::max(FieldRequiredAlignment,
2375 Layout.getRequiredAlignment());
2376 }
Warren Huntf4518def2014-01-10 01:28:05 +00002377 // Capture required alignment as a side-effect.
2378 RequiredAlignment = std::max(RequiredAlignment, FieldRequiredAlignment);
2379 }
Warren Hunt5d9eebf2014-04-10 22:15:18 +00002380 // Respect pragma pack, attribute pack and declspec align
2381 if (!MaxFieldAlignment.isZero())
2382 Info.Alignment = std::min(Info.Alignment, MaxFieldAlignment);
2383 if (FD->hasAttr<PackedAttr>())
2384 Info.Alignment = CharUnits::One();
2385 Info.Alignment = std::max(Info.Alignment, FieldRequiredAlignment);
Warren Huntd640d7d2014-01-09 00:30:56 +00002386 return Info;
2387}
2388
2389void MicrosoftRecordLayoutBuilder::layout(const RecordDecl *RD) {
David Majnemer00a061d2014-09-30 06:45:43 +00002390 // For C record layout, zero-sized records always have size 4.
2391 MinEmptyStructSize = CharUnits::fromQuantity(4);
Warren Huntd640d7d2014-01-09 00:30:56 +00002392 initializeLayout(RD);
2393 layoutFields(RD);
Rui Ueyama83aa9792016-01-14 21:00:27 +00002394 DataSize = Size = Size.alignTo(Alignment);
David Majnemer79a1c892014-02-12 00:43:02 +00002395 RequiredAlignment = std::max(
2396 RequiredAlignment, Context.toCharUnitsFromBits(RD->getMaxAlignment()));
Warren Huntd640d7d2014-01-09 00:30:56 +00002397 finalizeLayout(RD);
2398}
2399
2400void MicrosoftRecordLayoutBuilder::cxxLayout(const CXXRecordDecl *RD) {
David Majnemer00a061d2014-09-30 06:45:43 +00002401 // The C++ standard says that empty structs have size 1.
2402 MinEmptyStructSize = CharUnits::One();
Warren Huntd640d7d2014-01-09 00:30:56 +00002403 initializeLayout(RD);
2404 initializeCXXLayout(RD);
2405 layoutNonVirtualBases(RD);
2406 layoutFields(RD);
Warren Huntc89450e2014-03-24 21:37:27 +00002407 injectVBPtr(RD);
2408 injectVFPtr(RD);
2409 if (HasOwnVFPtr || (HasVBPtr && !SharedVBPtrBase))
2410 Alignment = std::max(Alignment, PointerInfo.Alignment);
Warren Hunt5d9eebf2014-04-10 22:15:18 +00002411 auto RoundingAlignment = Alignment;
2412 if (!MaxFieldAlignment.isZero())
2413 RoundingAlignment = std::min(RoundingAlignment, MaxFieldAlignment);
Rui Ueyama83aa9792016-01-14 21:00:27 +00002414 NonVirtualSize = Size = Size.alignTo(RoundingAlignment);
David Majnemer79a1c892014-02-12 00:43:02 +00002415 RequiredAlignment = std::max(
2416 RequiredAlignment, Context.toCharUnitsFromBits(RD->getMaxAlignment()));
Warren Huntd640d7d2014-01-09 00:30:56 +00002417 layoutVirtualBases(RD);
2418 finalizeLayout(RD);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002419}
2420
2421void MicrosoftRecordLayoutBuilder::initializeLayout(const RecordDecl *RD) {
2422 IsUnion = RD->isUnion();
Warren Hunt8f8bad72013-10-11 20:19:00 +00002423 Size = CharUnits::Zero();
2424 Alignment = CharUnits::One();
Warren Hunt7b252d22013-12-06 00:01:17 +00002425 // In 64-bit mode we always perform an alignment step after laying out vbases.
2426 // In 32-bit mode we do not. The check to see if we need to perform alignment
2427 // checks the RequiredAlignment field and performs alignment if it isn't 0.
David Majnemer37ea5782015-04-24 01:24:59 +00002428 RequiredAlignment = Context.getTargetInfo().getTriple().isArch64Bit()
2429 ? CharUnits::One()
2430 : CharUnits::Zero();
Warren Hunt8f8bad72013-10-11 20:19:00 +00002431 // Compute the maximum field alignment.
2432 MaxFieldAlignment = CharUnits::Zero();
2433 // Honor the default struct packing maximum alignment flag.
2434 if (unsigned DefaultMaxFieldAlignment = Context.getLangOpts().PackStruct)
Warren Huntf4518def2014-01-10 01:28:05 +00002435 MaxFieldAlignment = CharUnits::fromQuantity(DefaultMaxFieldAlignment);
2436 // Honor the packing attribute. The MS-ABI ignores pragma pack if its larger
2437 // than the pointer size.
2438 if (const MaxFieldAlignmentAttr *MFAA = RD->getAttr<MaxFieldAlignmentAttr>()){
2439 unsigned PackedAlignment = MFAA->getAlignment();
2440 if (PackedAlignment <= Context.getTargetInfo().getPointerWidth(0))
2441 MaxFieldAlignment = Context.toCharUnitsFromBits(PackedAlignment);
2442 }
Warren Hunt8f8bad72013-10-11 20:19:00 +00002443 // Packed attribute forces max field alignment to be 1.
2444 if (RD->hasAttr<PackedAttr>())
2445 MaxFieldAlignment = CharUnits::One();
Reid Kleckner8b6d0342015-02-25 19:17:45 +00002446
2447 // Try to respect the external layout if present.
2448 UseExternalLayout = false;
2449 if (ExternalASTSource *Source = Context.getExternalSource())
2450 UseExternalLayout = Source->layoutRecordType(
2451 RD, External.Size, External.Align, External.FieldOffsets,
2452 External.BaseOffsets, External.VirtualBaseOffsets);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002453}
2454
Warren Hunt8f8bad72013-10-11 20:19:00 +00002455void
2456MicrosoftRecordLayoutBuilder::initializeCXXLayout(const CXXRecordDecl *RD) {
Warren Hunt39a907b2014-04-09 21:57:24 +00002457 EndsWithZeroSizedObject = false;
Warren Hunt049f6732013-12-06 19:54:25 +00002458 LeadsWithZeroSizedBase = false;
Warren Huntd640d7d2014-01-09 00:30:56 +00002459 HasOwnVFPtr = false;
2460 HasVBPtr = false;
Craig Topper36250ad2014-05-12 05:36:57 +00002461 PrimaryBase = nullptr;
2462 SharedVBPtrBase = nullptr;
Warren Huntd640d7d2014-01-09 00:30:56 +00002463 // Calculate pointer size and alignment. These are used for vfptr and vbprt
2464 // injection.
2465 PointerInfo.Size =
2466 Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerWidth(0));
David Majnemer37ea5782015-04-24 01:24:59 +00002467 PointerInfo.Alignment =
2468 Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerAlign(0));
Warren Huntd640d7d2014-01-09 00:30:56 +00002469 // Respect pragma pack.
2470 if (!MaxFieldAlignment.isZero())
2471 PointerInfo.Alignment = std::min(PointerInfo.Alignment, MaxFieldAlignment);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002472}
2473
2474void
2475MicrosoftRecordLayoutBuilder::layoutNonVirtualBases(const CXXRecordDecl *RD) {
Warren Huntd640d7d2014-01-09 00:30:56 +00002476 // The MS-ABI lays out all bases that contain leading vfptrs before it lays
2477 // out any bases that do not contain vfptrs. We implement this as two passes
2478 // over the bases. This approach guarantees that the primary base is laid out
2479 // first. We use these passes to calculate some additional aggregated
David Majnemer07639702016-02-12 19:21:02 +00002480 // information about the bases, such as required alignment and the presence of
Warren Huntd640d7d2014-01-09 00:30:56 +00002481 // zero sized members.
Craig Topper36250ad2014-05-12 05:36:57 +00002482 const ASTRecordLayout *PreviousBaseLayout = nullptr;
Warren Huntd640d7d2014-01-09 00:30:56 +00002483 // Iterate through the bases and lay out the non-virtual ones.
David Majnemerc964b4b2014-07-16 06:04:00 +00002484 for (const CXXBaseSpecifier &Base : RD->bases()) {
2485 const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl();
Warren Huntd640d7d2014-01-09 00:30:56 +00002486 const ASTRecordLayout &BaseLayout = Context.getASTRecordLayout(BaseDecl);
Warren Huntd640d7d2014-01-09 00:30:56 +00002487 // Mark and skip virtual bases.
David Majnemerc964b4b2014-07-16 06:04:00 +00002488 if (Base.isVirtual()) {
Warren Huntd640d7d2014-01-09 00:30:56 +00002489 HasVBPtr = true;
2490 continue;
2491 }
David Majnemer07639702016-02-12 19:21:02 +00002492 // Check for a base to share a VBPtr with.
Warren Huntd640d7d2014-01-09 00:30:56 +00002493 if (!SharedVBPtrBase && BaseLayout.hasVBPtr()) {
2494 SharedVBPtrBase = BaseDecl;
2495 HasVBPtr = true;
2496 }
2497 // Only lay out bases with extendable VFPtrs on the first pass.
2498 if (!BaseLayout.hasExtendableVFPtr())
2499 continue;
2500 // If we don't have a primary base, this one qualifies.
Warren Huntbadf9e02014-01-13 19:55:52 +00002501 if (!PrimaryBase) {
Warren Huntd640d7d2014-01-09 00:30:56 +00002502 PrimaryBase = BaseDecl;
Warren Huntbadf9e02014-01-13 19:55:52 +00002503 LeadsWithZeroSizedBase = BaseLayout.leadsWithZeroSizedBase();
2504 }
Warren Huntd640d7d2014-01-09 00:30:56 +00002505 // Lay out the base.
David Majnemercd3ebfe2016-05-23 17:16:12 +00002506 layoutNonVirtualBase(RD, BaseDecl, BaseLayout, PreviousBaseLayout);
Warren Huntd640d7d2014-01-09 00:30:56 +00002507 }
2508 // Figure out if we need a fresh VFPtr for this class.
2509 if (!PrimaryBase && RD->isDynamicClass())
2510 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
2511 e = RD->method_end();
2512 !HasOwnVFPtr && i != e; ++i)
2513 HasOwnVFPtr = i->isVirtual() && i->size_overridden_methods() == 0;
2514 // If we don't have a primary base then we have a leading object that could
2515 // itself lead with a zero-sized object, something we track.
2516 bool CheckLeadingLayout = !PrimaryBase;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002517 // Iterate through the bases and lay out the non-virtual ones.
David Majnemerc964b4b2014-07-16 06:04:00 +00002518 for (const CXXBaseSpecifier &Base : RD->bases()) {
2519 if (Base.isVirtual())
Warren Hunt8f8bad72013-10-11 20:19:00 +00002520 continue;
David Majnemerc964b4b2014-07-16 06:04:00 +00002521 const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl();
Warren Huntd640d7d2014-01-09 00:30:56 +00002522 const ASTRecordLayout &BaseLayout = Context.getASTRecordLayout(BaseDecl);
2523 // Only lay out bases without extendable VFPtrs on the second pass.
Warren Huntbb9c3c32014-04-10 23:23:34 +00002524 if (BaseLayout.hasExtendableVFPtr()) {
2525 VBPtrOffset = Bases[BaseDecl] + BaseLayout.getNonVirtualSize();
Warren Hunt4431fe62013-12-12 22:33:37 +00002526 continue;
Warren Huntbb9c3c32014-04-10 23:23:34 +00002527 }
Warren Huntd640d7d2014-01-09 00:30:56 +00002528 // If this is the first layout, check to see if it leads with a zero sized
2529 // object. If it does, so do we.
2530 if (CheckLeadingLayout) {
2531 CheckLeadingLayout = false;
2532 LeadsWithZeroSizedBase = BaseLayout.leadsWithZeroSizedBase();
Warren Hunt049f6732013-12-06 19:54:25 +00002533 }
Warren Huntd640d7d2014-01-09 00:30:56 +00002534 // Lay out the base.
David Majnemercd3ebfe2016-05-23 17:16:12 +00002535 layoutNonVirtualBase(RD, BaseDecl, BaseLayout, PreviousBaseLayout);
Warren Huntbb9c3c32014-04-10 23:23:34 +00002536 VBPtrOffset = Bases[BaseDecl] + BaseLayout.getNonVirtualSize();
Warren Hunt8f8bad72013-10-11 20:19:00 +00002537 }
Warren Huntd640d7d2014-01-09 00:30:56 +00002538 // Set our VBPtroffset if we know it at this point.
Warren Hunt8f8bad72013-10-11 20:19:00 +00002539 if (!HasVBPtr)
2540 VBPtrOffset = CharUnits::fromQuantity(-1);
Warren Hunt6eba9072014-01-14 00:31:30 +00002541 else if (SharedVBPtrBase) {
2542 const ASTRecordLayout &Layout = Context.getASTRecordLayout(SharedVBPtrBase);
2543 VBPtrOffset = Bases[SharedVBPtrBase] + Layout.getVBPtrOffset();
2544 }
Warren Huntd640d7d2014-01-09 00:30:56 +00002545}
2546
David Majnemercd3ebfe2016-05-23 17:16:12 +00002547static bool recordUsesEBO(const RecordDecl *RD) {
2548 if (!isa<CXXRecordDecl>(RD))
2549 return false;
2550 if (RD->hasAttr<EmptyBasesAttr>())
2551 return true;
2552 if (auto *LVA = RD->getAttr<LayoutVersionAttr>())
2553 // TODO: Double check with the next version of MSVC.
2554 if (LVA->getVersion() <= LangOptions::MSVC2015)
2555 return false;
2556 // TODO: Some later version of MSVC will change the default behavior of the
2557 // compiler to enable EBO by default. When this happens, we will need an
2558 // additional isCompatibleWithMSVC check.
2559 return false;
2560}
2561
Warren Huntd640d7d2014-01-09 00:30:56 +00002562void MicrosoftRecordLayoutBuilder::layoutNonVirtualBase(
David Majnemercd3ebfe2016-05-23 17:16:12 +00002563 const CXXRecordDecl *RD,
Warren Huntd640d7d2014-01-09 00:30:56 +00002564 const CXXRecordDecl *BaseDecl,
2565 const ASTRecordLayout &BaseLayout,
2566 const ASTRecordLayout *&PreviousBaseLayout) {
Warren Huntf4518def2014-01-10 01:28:05 +00002567 // Insert padding between two bases if the left first one is zero sized or
2568 // contains a zero sized subobject and the right is zero sized or one leads
2569 // with a zero sized base.
David Majnemercd3ebfe2016-05-23 17:16:12 +00002570 bool MDCUsesEBO = recordUsesEBO(RD);
2571 if (PreviousBaseLayout && PreviousBaseLayout->endsWithZeroSizedObject() &&
2572 BaseLayout.leadsWithZeroSizedBase() && !MDCUsesEBO)
Warren Huntf4518def2014-01-10 01:28:05 +00002573 Size++;
2574 ElementInfo Info = getAdjustedElementInfo(BaseLayout);
Reid Kleckner8b6d0342015-02-25 19:17:45 +00002575 CharUnits BaseOffset;
2576
2577 // Respect the external AST source base offset, if present.
2578 bool FoundBase = false;
2579 if (UseExternalLayout) {
2580 FoundBase = External.getExternalNVBaseOffset(BaseDecl, BaseOffset);
David Majnemercd3ebfe2016-05-23 17:16:12 +00002581 if (FoundBase) {
Reid Kleckner8b6d0342015-02-25 19:17:45 +00002582 assert(BaseOffset >= Size && "base offset already allocated");
David Majnemercd3ebfe2016-05-23 17:16:12 +00002583 Size = BaseOffset;
2584 }
Reid Kleckner8b6d0342015-02-25 19:17:45 +00002585 }
2586
David Majnemercd3ebfe2016-05-23 17:16:12 +00002587 if (!FoundBase) {
2588 if (MDCUsesEBO && BaseDecl->isEmpty() &&
2589 BaseLayout.getNonVirtualSize() == CharUnits::Zero()) {
2590 BaseOffset = CharUnits::Zero();
2591 } else {
2592 // Otherwise, lay the base out at the end of the MDC.
2593 BaseOffset = Size = Size.alignTo(Info.Alignment);
2594 }
2595 }
Warren Huntf4518def2014-01-10 01:28:05 +00002596 Bases.insert(std::make_pair(BaseDecl, BaseOffset));
David Majnemercd3ebfe2016-05-23 17:16:12 +00002597 Size += BaseLayout.getNonVirtualSize();
Warren Huntf4518def2014-01-10 01:28:05 +00002598 PreviousBaseLayout = &BaseLayout;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002599}
2600
2601void MicrosoftRecordLayoutBuilder::layoutFields(const RecordDecl *RD) {
2602 LastFieldIsNonZeroWidthBitfield = false;
David Majnemerc964b4b2014-07-16 06:04:00 +00002603 for (const FieldDecl *Field : RD->fields())
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00002604 layoutField(Field);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002605}
2606
2607void MicrosoftRecordLayoutBuilder::layoutField(const FieldDecl *FD) {
2608 if (FD->isBitField()) {
2609 layoutBitField(FD);
2610 return;
2611 }
2612 LastFieldIsNonZeroWidthBitfield = false;
Warren Huntd640d7d2014-01-09 00:30:56 +00002613 ElementInfo Info = getAdjustedElementInfo(FD);
David Majnemeradc45bb2014-04-13 08:15:50 +00002614 Alignment = std::max(Alignment, Info.Alignment);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002615 if (IsUnion) {
Warren Huntd640d7d2014-01-09 00:30:56 +00002616 placeFieldAtOffset(CharUnits::Zero());
2617 Size = std::max(Size, Info.Size);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002618 } else {
Reid Kleckner8b6d0342015-02-25 19:17:45 +00002619 CharUnits FieldOffset;
2620 if (UseExternalLayout) {
2621 FieldOffset =
2622 Context.toCharUnitsFromBits(External.getExternalFieldOffset(FD));
2623 assert(FieldOffset >= Size && "field offset already allocated");
2624 } else {
Rui Ueyama83aa9792016-01-14 21:00:27 +00002625 FieldOffset = Size.alignTo(Info.Alignment);
Reid Kleckner8b6d0342015-02-25 19:17:45 +00002626 }
Warren Hunt8f8bad72013-10-11 20:19:00 +00002627 placeFieldAtOffset(FieldOffset);
Warren Huntd640d7d2014-01-09 00:30:56 +00002628 Size = FieldOffset + Info.Size;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002629 }
2630}
2631
2632void MicrosoftRecordLayoutBuilder::layoutBitField(const FieldDecl *FD) {
2633 unsigned Width = FD->getBitWidthValue(Context);
2634 if (Width == 0) {
2635 layoutZeroWidthBitField(FD);
2636 return;
2637 }
Warren Huntd640d7d2014-01-09 00:30:56 +00002638 ElementInfo Info = getAdjustedElementInfo(FD);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002639 // Clamp the bitfield to a containable size for the sake of being able
2640 // to lay them out. Sema will throw an error.
Warren Huntd640d7d2014-01-09 00:30:56 +00002641 if (Width > Context.toBits(Info.Size))
2642 Width = Context.toBits(Info.Size);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002643 // Check to see if this bitfield fits into an existing allocation. Note:
2644 // MSVC refuses to pack bitfields of formal types with different sizes
2645 // into the same allocation.
2646 if (!IsUnion && LastFieldIsNonZeroWidthBitfield &&
Warren Huntd640d7d2014-01-09 00:30:56 +00002647 CurrentBitfieldSize == Info.Size && Width <= RemainingBitsInField) {
Warren Hunt8f8bad72013-10-11 20:19:00 +00002648 placeFieldAtBitOffset(Context.toBits(Size) - RemainingBitsInField);
2649 RemainingBitsInField -= Width;
2650 return;
2651 }
Warren Hunt8f8bad72013-10-11 20:19:00 +00002652 LastFieldIsNonZeroWidthBitfield = true;
Warren Huntd640d7d2014-01-09 00:30:56 +00002653 CurrentBitfieldSize = Info.Size;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002654 if (IsUnion) {
Warren Huntd640d7d2014-01-09 00:30:56 +00002655 placeFieldAtOffset(CharUnits::Zero());
2656 Size = std::max(Size, Info.Size);
David Majnemeradc45bb2014-04-13 08:15:50 +00002657 // TODO: Add a Sema warning that MS ignores bitfield alignment in unions.
Warren Hunt8f8bad72013-10-11 20:19:00 +00002658 } else {
2659 // Allocate a new block of memory and place the bitfield in it.
Rui Ueyama83aa9792016-01-14 21:00:27 +00002660 CharUnits FieldOffset = Size.alignTo(Info.Alignment);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002661 placeFieldAtOffset(FieldOffset);
Warren Huntd640d7d2014-01-09 00:30:56 +00002662 Size = FieldOffset + Info.Size;
David Majnemeradc45bb2014-04-13 08:15:50 +00002663 Alignment = std::max(Alignment, Info.Alignment);
Warren Huntd640d7d2014-01-09 00:30:56 +00002664 RemainingBitsInField = Context.toBits(Info.Size) - Width;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002665 }
2666}
2667
2668void
2669MicrosoftRecordLayoutBuilder::layoutZeroWidthBitField(const FieldDecl *FD) {
2670 // Zero-width bitfields are ignored unless they follow a non-zero-width
2671 // bitfield.
Warren Hunt8f8bad72013-10-11 20:19:00 +00002672 if (!LastFieldIsNonZeroWidthBitfield) {
2673 placeFieldAtOffset(IsUnion ? CharUnits::Zero() : Size);
2674 // TODO: Add a Sema warning that MS ignores alignment for zero
Alp Tokerd4733632013-12-05 04:47:09 +00002675 // sized bitfields that occur after zero-size bitfields or non-bitfields.
Warren Hunt8f8bad72013-10-11 20:19:00 +00002676 return;
2677 }
Warren Hunt8f8bad72013-10-11 20:19:00 +00002678 LastFieldIsNonZeroWidthBitfield = false;
Warren Huntd640d7d2014-01-09 00:30:56 +00002679 ElementInfo Info = getAdjustedElementInfo(FD);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002680 if (IsUnion) {
Warren Huntd640d7d2014-01-09 00:30:56 +00002681 placeFieldAtOffset(CharUnits::Zero());
2682 Size = std::max(Size, Info.Size);
David Majnemeradc45bb2014-04-13 08:15:50 +00002683 // TODO: Add a Sema warning that MS ignores bitfield alignment in unions.
Warren Hunt8f8bad72013-10-11 20:19:00 +00002684 } else {
2685 // Round up the current record size to the field's alignment boundary.
Rui Ueyama83aa9792016-01-14 21:00:27 +00002686 CharUnits FieldOffset = Size.alignTo(Info.Alignment);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002687 placeFieldAtOffset(FieldOffset);
2688 Size = FieldOffset;
David Majnemeradc45bb2014-04-13 08:15:50 +00002689 Alignment = std::max(Alignment, Info.Alignment);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002690 }
2691}
2692
Warren Huntd640d7d2014-01-09 00:30:56 +00002693void MicrosoftRecordLayoutBuilder::injectVBPtr(const CXXRecordDecl *RD) {
Warren Hunt6eba9072014-01-14 00:31:30 +00002694 if (!HasVBPtr || SharedVBPtrBase)
Warren Huntd640d7d2014-01-09 00:30:56 +00002695 return;
Warren Huntd640d7d2014-01-09 00:30:56 +00002696 // Inject the VBPointer at the injection site.
2697 CharUnits InjectionSite = VBPtrOffset;
2698 // But before we do, make sure it's properly aligned.
Rui Ueyama83aa9792016-01-14 21:00:27 +00002699 VBPtrOffset = VBPtrOffset.alignTo(PointerInfo.Alignment);
Reid Kleckner8b6d0342015-02-25 19:17:45 +00002700 // Shift everything after the vbptr down, unless we're using an external
2701 // layout.
2702 if (UseExternalLayout)
2703 return;
Warren Huntd640d7d2014-01-09 00:30:56 +00002704 // Determine where the first field should be laid out after the vbptr.
2705 CharUnits FieldStart = VBPtrOffset + PointerInfo.Size;
2706 // Make sure that the amount we push the fields back by is a multiple of the
2707 // alignment.
Rui Ueyama83aa9792016-01-14 21:00:27 +00002708 CharUnits Offset = (FieldStart - InjectionSite)
2709 .alignTo(std::max(RequiredAlignment, Alignment));
Warren Huntd640d7d2014-01-09 00:30:56 +00002710 Size += Offset;
David Majnemerc964b4b2014-07-16 06:04:00 +00002711 for (uint64_t &FieldOffset : FieldOffsets)
2712 FieldOffset += Context.toBits(Offset);
2713 for (BaseOffsetsMapTy::value_type &Base : Bases)
2714 if (Base.second >= InjectionSite)
2715 Base.second += Offset;
Warren Huntd640d7d2014-01-09 00:30:56 +00002716}
2717
2718void MicrosoftRecordLayoutBuilder::injectVFPtr(const CXXRecordDecl *RD) {
2719 if (!HasOwnVFPtr)
2720 return;
2721 // Make sure that the amount we push the struct back by is a multiple of the
2722 // alignment.
Rui Ueyama83aa9792016-01-14 21:00:27 +00002723 CharUnits Offset =
2724 PointerInfo.Size.alignTo(std::max(RequiredAlignment, Alignment));
Zachary Turnerf686a442015-10-01 22:08:02 +00002725 // Push back the vbptr, but increase the size of the object and push back
2726 // regular fields by the offset only if not using external record layout.
Warren Huntd640d7d2014-01-09 00:30:56 +00002727 if (HasVBPtr)
2728 VBPtrOffset += Offset;
Zachary Turnerf686a442015-10-01 22:08:02 +00002729
2730 if (UseExternalLayout)
2731 return;
2732
2733 Size += Offset;
2734
2735 // If we're using an external layout, the fields offsets have already
2736 // accounted for this adjustment.
2737 for (uint64_t &FieldOffset : FieldOffsets)
2738 FieldOffset += Context.toBits(Offset);
David Majnemerc964b4b2014-07-16 06:04:00 +00002739 for (BaseOffsetsMapTy::value_type &Base : Bases)
2740 Base.second += Offset;
Warren Huntd640d7d2014-01-09 00:30:56 +00002741}
2742
Warren Hunt8f8bad72013-10-11 20:19:00 +00002743void MicrosoftRecordLayoutBuilder::layoutVirtualBases(const CXXRecordDecl *RD) {
2744 if (!HasVBPtr)
2745 return;
Warren Huntd640d7d2014-01-09 00:30:56 +00002746 // Vtordisps are always 4 bytes (even in 64-bit mode)
2747 CharUnits VtorDispSize = CharUnits::fromQuantity(4);
2748 CharUnits VtorDispAlignment = VtorDispSize;
2749 // vtordisps respect pragma pack.
2750 if (!MaxFieldAlignment.isZero())
2751 VtorDispAlignment = std::min(VtorDispAlignment, MaxFieldAlignment);
2752 // The alignment of the vtordisp is at least the required alignment of the
2753 // entire record. This requirement may be present to support vtordisp
2754 // injection.
David Majnemerc964b4b2014-07-16 06:04:00 +00002755 for (const CXXBaseSpecifier &VBase : RD->vbases()) {
2756 const CXXRecordDecl *BaseDecl = VBase.getType()->getAsCXXRecordDecl();
David Majnemer79a1c892014-02-12 00:43:02 +00002757 const ASTRecordLayout &BaseLayout = Context.getASTRecordLayout(BaseDecl);
2758 RequiredAlignment =
2759 std::max(RequiredAlignment, BaseLayout.getRequiredAlignment());
2760 }
Warren Huntd640d7d2014-01-09 00:30:56 +00002761 VtorDispAlignment = std::max(VtorDispAlignment, RequiredAlignment);
2762 // Compute the vtordisp set.
David Majnemerc2e67532014-09-23 22:58:15 +00002763 llvm::SmallPtrSet<const CXXRecordDecl *, 2> HasVtorDispSet;
2764 computeVtorDispSet(HasVtorDispSet, RD);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002765 // Iterate through the virtual bases and lay them out.
Craig Topper36250ad2014-05-12 05:36:57 +00002766 const ASTRecordLayout *PreviousBaseLayout = nullptr;
David Majnemerc964b4b2014-07-16 06:04:00 +00002767 for (const CXXBaseSpecifier &VBase : RD->vbases()) {
2768 const CXXRecordDecl *BaseDecl = VBase.getType()->getAsCXXRecordDecl();
Warren Huntd640d7d2014-01-09 00:30:56 +00002769 const ASTRecordLayout &BaseLayout = Context.getASTRecordLayout(BaseDecl);
David Majnemerc2e67532014-09-23 22:58:15 +00002770 bool HasVtordisp = HasVtorDispSet.count(BaseDecl) > 0;
Warren Huntd640d7d2014-01-09 00:30:56 +00002771 // Insert padding between two bases if the left first one is zero sized or
2772 // contains a zero sized subobject and the right is zero sized or one leads
2773 // with a zero sized base. The padding between virtual bases is 4
2774 // bytes (in both 32 and 64 bits modes) and always involves rounding up to
2775 // the required alignment, we don't know why.
David Majnemercd3ebfe2016-05-23 17:16:12 +00002776 if ((PreviousBaseLayout && PreviousBaseLayout->endsWithZeroSizedObject() &&
2777 BaseLayout.leadsWithZeroSizedBase() && !recordUsesEBO(RD)) ||
2778 HasVtordisp) {
Rui Ueyama83aa9792016-01-14 21:00:27 +00002779 Size = Size.alignTo(VtorDispAlignment) + VtorDispSize;
David Majnemera2464682014-07-17 00:55:19 +00002780 Alignment = std::max(VtorDispAlignment, Alignment);
David Majnemerbf3d4302014-07-16 07:16:58 +00002781 }
Warren Huntd640d7d2014-01-09 00:30:56 +00002782 // Insert the virtual base.
2783 ElementInfo Info = getAdjustedElementInfo(BaseLayout);
Reid Kleckner8b6d0342015-02-25 19:17:45 +00002784 CharUnits BaseOffset;
2785
2786 // Respect the external AST source base offset, if present.
2787 bool FoundBase = false;
2788 if (UseExternalLayout) {
2789 FoundBase = External.getExternalVBaseOffset(BaseDecl, BaseOffset);
2790 if (FoundBase)
2791 assert(BaseOffset >= Size && "base offset already allocated");
2792 }
2793 if (!FoundBase)
Rui Ueyama83aa9792016-01-14 21:00:27 +00002794 BaseOffset = Size.alignTo(Info.Alignment);
Reid Kleckner8b6d0342015-02-25 19:17:45 +00002795
Warren Huntd640d7d2014-01-09 00:30:56 +00002796 VBases.insert(std::make_pair(BaseDecl,
2797 ASTRecordLayout::VBaseInfo(BaseOffset, HasVtordisp)));
Warren Huntf6ec7482014-02-21 01:40:35 +00002798 Size = BaseOffset + BaseLayout.getNonVirtualSize();
Warren Huntd640d7d2014-01-09 00:30:56 +00002799 PreviousBaseLayout = &BaseLayout;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002800 }
2801}
2802
Warren Huntc3384312013-12-11 22:28:32 +00002803void MicrosoftRecordLayoutBuilder::finalizeLayout(const RecordDecl *RD) {
Warren Huntd640d7d2014-01-09 00:30:56 +00002804 // Respect required alignment. Note that in 32-bit mode Required alignment
David Majnemer00a061d2014-09-30 06:45:43 +00002805 // may be 0 and cause size not to be updated.
Warren Huntf6ec7482014-02-21 01:40:35 +00002806 DataSize = Size;
Warren Huntd640d7d2014-01-09 00:30:56 +00002807 if (!RequiredAlignment.isZero()) {
2808 Alignment = std::max(Alignment, RequiredAlignment);
Warren Hunt5d9eebf2014-04-10 22:15:18 +00002809 auto RoundingAlignment = Alignment;
2810 if (!MaxFieldAlignment.isZero())
2811 RoundingAlignment = std::min(RoundingAlignment, MaxFieldAlignment);
2812 RoundingAlignment = std::max(RoundingAlignment, RequiredAlignment);
Rui Ueyama83aa9792016-01-14 21:00:27 +00002813 Size = Size.alignTo(RoundingAlignment);
Warren Huntd640d7d2014-01-09 00:30:56 +00002814 }
Warren Hunt049f6732013-12-06 19:54:25 +00002815 if (Size.isZero()) {
David Majnemercd3ebfe2016-05-23 17:16:12 +00002816 if (!recordUsesEBO(RD) || !cast<CXXRecordDecl>(RD)->isEmpty()) {
2817 EndsWithZeroSizedObject = true;
2818 LeadsWithZeroSizedBase = true;
2819 }
David Majnemer00a061d2014-09-30 06:45:43 +00002820 // Zero-sized structures have size equal to their alignment if a
2821 // __declspec(align) came into play.
2822 if (RequiredAlignment >= MinEmptyStructSize)
2823 Size = Alignment;
2824 else
2825 Size = MinEmptyStructSize;
Warren Hunt049f6732013-12-06 19:54:25 +00002826 }
Reid Kleckner8b6d0342015-02-25 19:17:45 +00002827
2828 if (UseExternalLayout) {
2829 Size = Context.toCharUnitsFromBits(External.Size);
2830 if (External.Align)
2831 Alignment = Context.toCharUnitsFromBits(External.Align);
2832 }
Warren Hunt8f8bad72013-10-11 20:19:00 +00002833}
2834
Warren Hunt73f43982014-04-11 22:05:28 +00002835// Recursively walks the non-virtual bases of a class and determines if any of
2836// them are in the bases with overridden methods set.
David Majnemer12727642014-07-16 06:30:31 +00002837static bool
2838RequiresVtordisp(const llvm::SmallPtrSetImpl<const CXXRecordDecl *> &
2839 BasesWithOverriddenMethods,
2840 const CXXRecordDecl *RD) {
Warren Hunt73f43982014-04-11 22:05:28 +00002841 if (BasesWithOverriddenMethods.count(RD))
Warren Hunt8f8bad72013-10-11 20:19:00 +00002842 return true;
2843 // If any of a virtual bases non-virtual bases (recursively) requires a
2844 // vtordisp than so does this virtual base.
David Majnemerc964b4b2014-07-16 06:04:00 +00002845 for (const CXXBaseSpecifier &Base : RD->bases())
2846 if (!Base.isVirtual() &&
Warren Hunt73f43982014-04-11 22:05:28 +00002847 RequiresVtordisp(BasesWithOverriddenMethods,
David Majnemerc964b4b2014-07-16 06:04:00 +00002848 Base.getType()->getAsCXXRecordDecl()))
Warren Hunt8f8bad72013-10-11 20:19:00 +00002849 return true;
2850 return false;
2851}
2852
David Majnemerc2e67532014-09-23 22:58:15 +00002853void MicrosoftRecordLayoutBuilder::computeVtorDispSet(
2854 llvm::SmallPtrSetImpl<const CXXRecordDecl *> &HasVtordispSet,
2855 const CXXRecordDecl *RD) const {
Reid Klecknerc0dca6d2014-02-12 23:50:26 +00002856 // /vd2 or #pragma vtordisp(2): Always use vtordisps for virtual bases with
2857 // vftables.
2858 if (RD->getMSVtorDispMode() == MSVtorDispAttr::ForVFTable) {
David Majnemerc964b4b2014-07-16 06:04:00 +00002859 for (const CXXBaseSpecifier &Base : RD->vbases()) {
2860 const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl();
Reid Klecknerc0dca6d2014-02-12 23:50:26 +00002861 const ASTRecordLayout &Layout = Context.getASTRecordLayout(BaseDecl);
2862 if (Layout.hasExtendableVFPtr())
2863 HasVtordispSet.insert(BaseDecl);
2864 }
David Majnemerc2e67532014-09-23 22:58:15 +00002865 return;
Reid Klecknerc0dca6d2014-02-12 23:50:26 +00002866 }
2867
Warren Hunt8f8bad72013-10-11 20:19:00 +00002868 // If any of our bases need a vtordisp for this type, so do we. Check our
2869 // direct bases for vtordisp requirements.
David Majnemerc964b4b2014-07-16 06:04:00 +00002870 for (const CXXBaseSpecifier &Base : RD->bases()) {
2871 const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl();
Warren Hunt8f8bad72013-10-11 20:19:00 +00002872 const ASTRecordLayout &Layout = Context.getASTRecordLayout(BaseDecl);
Reid Klecknercd612ab2014-04-11 16:57:42 +00002873 for (const auto &bi : Layout.getVBaseOffsetsMap())
2874 if (bi.second.hasVtorDisp())
2875 HasVtordispSet.insert(bi.first);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002876 }
David Majnemerd43388c2014-04-13 02:27:32 +00002877 // We don't introduce any additional vtordisps if either:
2878 // * A user declared constructor or destructor aren't declared.
2879 // * #pragma vtordisp(0) or the /vd0 flag are in use.
2880 if ((!RD->hasUserDeclaredConstructor() && !RD->hasUserDeclaredDestructor()) ||
2881 RD->getMSVtorDispMode() == MSVtorDispAttr::Never)
David Majnemerc2e67532014-09-23 22:58:15 +00002882 return;
David Majnemerd43388c2014-04-13 02:27:32 +00002883 // /vd1 or #pragma vtordisp(1): Try to guess based on whether we think it's
2884 // possible for a partially constructed object with virtual base overrides to
2885 // escape a non-trivial constructor.
2886 assert(RD->getMSVtorDispMode() == MSVtorDispAttr::ForVBaseOverride);
Warren Hunt73f43982014-04-11 22:05:28 +00002887 // Compute a set of base classes which define methods we override. A virtual
2888 // base in this set will require a vtordisp. A virtual base that transitively
2889 // contains one of these bases as a non-virtual base will also require a
2890 // vtordisp.
2891 llvm::SmallPtrSet<const CXXMethodDecl *, 8> Work;
2892 llvm::SmallPtrSet<const CXXRecordDecl *, 2> BasesWithOverriddenMethods;
David Majnemerc2e67532014-09-23 22:58:15 +00002893 // Seed the working set with our non-destructor, non-pure virtual methods.
David Majnemerc964b4b2014-07-16 06:04:00 +00002894 for (const CXXMethodDecl *MD : RD->methods())
David Majnemerc2e67532014-09-23 22:58:15 +00002895 if (MD->isVirtual() && !isa<CXXDestructorDecl>(MD) && !MD->isPure())
David Majnemerc964b4b2014-07-16 06:04:00 +00002896 Work.insert(MD);
Warren Hunt73f43982014-04-11 22:05:28 +00002897 while (!Work.empty()) {
2898 const CXXMethodDecl *MD = *Work.begin();
2899 CXXMethodDecl::method_iterator i = MD->begin_overridden_methods(),
2900 e = MD->end_overridden_methods();
2901 // If a virtual method has no-overrides it lives in its parent's vtable.
2902 if (i == e)
2903 BasesWithOverriddenMethods.insert(MD->getParent());
2904 else
2905 Work.insert(i, e);
2906 // We've finished processing this element, remove it from the working set.
2907 Work.erase(MD);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002908 }
Warren Hunt73f43982014-04-11 22:05:28 +00002909 // For each of our virtual bases, check if it is in the set of overridden
2910 // bases or if it transitively contains a non-virtual base that is.
David Majnemerc964b4b2014-07-16 06:04:00 +00002911 for (const CXXBaseSpecifier &Base : RD->vbases()) {
2912 const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl();
Warren Huntd640d7d2014-01-09 00:30:56 +00002913 if (!HasVtordispSet.count(BaseDecl) &&
Warren Hunt73f43982014-04-11 22:05:28 +00002914 RequiresVtordisp(BasesWithOverriddenMethods, BaseDecl))
Warren Huntd640d7d2014-01-09 00:30:56 +00002915 HasVtordispSet.insert(BaseDecl);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002916 }
Warren Hunt8f8bad72013-10-11 20:19:00 +00002917}
2918
Anders Carlssondf291d82010-05-26 04:56:53 +00002919/// getASTRecordLayout - Get or compute information about the layout of the
2920/// specified record (struct/union/class), which indicates its size and field
2921/// position information.
Jay Foad39c79802011-01-12 09:06:06 +00002922const ASTRecordLayout &
2923ASTContext::getASTRecordLayout(const RecordDecl *D) const {
John McCall0710e552011-10-07 02:39:22 +00002924 // These asserts test different things. A record has a definition
2925 // as soon as we begin to parse the definition. That definition is
2926 // not a complete definition (which is what isDefinition() tests)
2927 // until we *finish* parsing the definition.
Sean Callanan56c19892012-02-08 00:04:52 +00002928
2929 if (D->hasExternalLexicalStorage() && !D->getDefinition())
2930 getExternalSource()->CompleteType(const_cast<RecordDecl*>(D));
2931
Anders Carlssondf291d82010-05-26 04:56:53 +00002932 D = D->getDefinition();
2933 assert(D && "Cannot get layout of forward declarations!");
Matt Beaumont-Gay35779952013-06-25 22:19:15 +00002934 assert(!D->isInvalidDecl() && "Cannot get layout of invalid decl!");
John McCallf937c022011-10-07 06:10:15 +00002935 assert(D->isCompleteDefinition() && "Cannot layout type before complete!");
Anders Carlssondf291d82010-05-26 04:56:53 +00002936
2937 // Look up this layout, if already laid out, return what we have.
2938 // Note that we can't save a reference to the entry because this function
2939 // is recursive.
2940 const ASTRecordLayout *Entry = ASTRecordLayouts[D];
2941 if (Entry) return *Entry;
2942
Craig Topper36250ad2014-05-12 05:36:57 +00002943 const ASTRecordLayout *NewEntry = nullptr;
Anders Carlssond2954862010-05-26 05:10:47 +00002944
David Majnemer3b1c9902015-07-25 20:18:14 +00002945 if (isMsLayout(*this)) {
2946 MicrosoftRecordLayoutBuilder Builder(*this);
2947 if (const auto *RD = dyn_cast<CXXRecordDecl>(D)) {
2948 Builder.cxxLayout(RD);
2949 NewEntry = new (*this) ASTRecordLayout(
2950 *this, Builder.Size, Builder.Alignment, Builder.RequiredAlignment,
2951 Builder.HasOwnVFPtr, Builder.HasOwnVFPtr || Builder.PrimaryBase,
David Majnemer97276c82016-05-24 18:10:50 +00002952 Builder.VBPtrOffset, Builder.DataSize, Builder.FieldOffsets,
David Majnemer3b1c9902015-07-25 20:18:14 +00002953 Builder.NonVirtualSize, Builder.Alignment, CharUnits::Zero(),
2954 Builder.PrimaryBase, false, Builder.SharedVBPtrBase,
2955 Builder.EndsWithZeroSizedObject, Builder.LeadsWithZeroSizedBase,
2956 Builder.Bases, Builder.VBases);
2957 } else {
2958 Builder.layout(D);
2959 NewEntry = new (*this) ASTRecordLayout(
2960 *this, Builder.Size, Builder.Alignment, Builder.RequiredAlignment,
David Majnemer97276c82016-05-24 18:10:50 +00002961 Builder.Size, Builder.FieldOffsets);
David Majnemer3b1c9902015-07-25 20:18:14 +00002962 }
Anders Carlssond2954862010-05-26 05:10:47 +00002963 } else {
David Majnemer3b1c9902015-07-25 20:18:14 +00002964 if (const auto *RD = dyn_cast<CXXRecordDecl>(D)) {
2965 EmptySubobjectMap EmptySubobjects(*this, RD);
2966 ItaniumRecordLayoutBuilder Builder(*this, &EmptySubobjects);
2967 Builder.Layout(RD);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00002968
David Majnemer3b1c9902015-07-25 20:18:14 +00002969 // In certain situations, we are allowed to lay out objects in the
2970 // tail-padding of base classes. This is ABI-dependent.
2971 // FIXME: this should be stored in the record layout.
2972 bool skipTailPadding =
2973 mustSkipTailPadding(getTargetInfo().getCXXABI(), RD);
2974
2975 // FIXME: This should be done in FinalizeLayout.
2976 CharUnits DataSize =
2977 skipTailPadding ? Builder.getSize() : Builder.getDataSize();
2978 CharUnits NonVirtualSize =
2979 skipTailPadding ? DataSize : Builder.NonVirtualSize;
2980 NewEntry = new (*this) ASTRecordLayout(
2981 *this, Builder.getSize(), Builder.Alignment,
2982 /*RequiredAlignment : used by MS-ABI)*/
2983 Builder.Alignment, Builder.HasOwnVFPtr, RD->isDynamicClass(),
David Majnemer97276c82016-05-24 18:10:50 +00002984 CharUnits::fromQuantity(-1), DataSize, Builder.FieldOffsets,
2985 NonVirtualSize, Builder.NonVirtualAlignment,
David Majnemer3b1c9902015-07-25 20:18:14 +00002986 EmptySubobjects.SizeOfLargestEmptySubobject, Builder.PrimaryBase,
2987 Builder.PrimaryBaseIsVirtual, nullptr, false, false, Builder.Bases,
2988 Builder.VBases);
2989 } else {
2990 ItaniumRecordLayoutBuilder Builder(*this, /*EmptySubobjects=*/nullptr);
2991 Builder.Layout(D);
2992
2993 NewEntry = new (*this) ASTRecordLayout(
2994 *this, Builder.getSize(), Builder.Alignment,
2995 /*RequiredAlignment : used by MS-ABI)*/
David Majnemer97276c82016-05-24 18:10:50 +00002996 Builder.Alignment, Builder.getSize(), Builder.FieldOffsets);
David Majnemer3b1c9902015-07-25 20:18:14 +00002997 }
Anders Carlssond2954862010-05-26 05:10:47 +00002998 }
2999
Anders Carlssondf291d82010-05-26 04:56:53 +00003000 ASTRecordLayouts[D] = NewEntry;
3001
David Blaikiebbafb8a2012-03-11 07:00:24 +00003002 if (getLangOpts().DumpRecordLayouts) {
Argyrios Kyrtzidis8ade08e2013-07-12 22:30:03 +00003003 llvm::outs() << "\n*** Dumping AST Record Layout\n";
3004 DumpRecordLayout(D, llvm::outs(), getLangOpts().DumpRecordLayoutsSimple);
Anders Carlssondf291d82010-05-26 04:56:53 +00003005 }
3006
3007 return *NewEntry;
3008}
3009
John McCall6bd2a892013-01-25 22:31:03 +00003010const CXXMethodDecl *ASTContext::getCurrentKeyFunction(const CXXRecordDecl *RD) {
Reid Kleckner5d7f2982013-05-29 16:18:30 +00003011 if (!getTargetInfo().getCXXABI().hasKeyFunctions())
Craig Topper36250ad2014-05-12 05:36:57 +00003012 return nullptr;
Reid Kleckner5d7f2982013-05-29 16:18:30 +00003013
John McCall6bd2a892013-01-25 22:31:03 +00003014 assert(RD->getDefinition() && "Cannot get key function for forward decl!");
Anders Carlssondf291d82010-05-26 04:56:53 +00003015 RD = cast<CXXRecordDecl>(RD->getDefinition());
Daniel Dunbar592a85c2010-05-27 02:25:46 +00003016
Richard Smitha9a1c682014-07-07 06:38:20 +00003017 // Beware:
3018 // 1) computing the key function might trigger deserialization, which might
3019 // invalidate iterators into KeyFunctions
3020 // 2) 'get' on the LazyDeclPtr might also trigger deserialization and
3021 // invalidate the LazyDeclPtr within the map itself
3022 LazyDeclPtr Entry = KeyFunctions[RD];
3023 const Decl *Result =
3024 Entry ? Entry.get(getExternalSource()) : computeKeyFunction(*this, RD);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00003025
Richard Smitha9a1c682014-07-07 06:38:20 +00003026 // Store it back if it changed.
3027 if (Entry.isOffset() || Entry.isValid() != bool(Result))
3028 KeyFunctions[RD] = const_cast<Decl*>(Result);
3029
3030 return cast_or_null<CXXMethodDecl>(Result);
John McCall6bd2a892013-01-25 22:31:03 +00003031}
3032
Richard Smith676c4042013-08-29 23:59:27 +00003033void ASTContext::setNonKeyFunction(const CXXMethodDecl *Method) {
Rafael Espindola8db352d2013-10-17 15:37:26 +00003034 assert(Method == Method->getFirstDecl() &&
John McCall6bd2a892013-01-25 22:31:03 +00003035 "not working with method declaration from class definition");
3036
3037 // Look up the cache entry. Since we're working with the first
3038 // declaration, its parent must be the class definition, which is
3039 // the correct key for the KeyFunctions hash.
Reid Klecknerb4a26ed2015-05-21 00:12:53 +00003040 const auto &Map = KeyFunctions;
3041 auto I = Map.find(Method->getParent());
John McCall6bd2a892013-01-25 22:31:03 +00003042
3043 // If it's not cached, there's nothing to do.
Reid Klecknerb4a26ed2015-05-21 00:12:53 +00003044 if (I == Map.end()) return;
John McCall6bd2a892013-01-25 22:31:03 +00003045
3046 // If it is cached, check whether it's the target method, and if so,
Richard Smitha9a1c682014-07-07 06:38:20 +00003047 // remove it from the cache. Note, the call to 'get' might invalidate
3048 // the iterator and the LazyDeclPtr object within the map.
3049 LazyDeclPtr Ptr = I->second;
3050 if (Ptr.get(getExternalSource()) == Method) {
John McCall6bd2a892013-01-25 22:31:03 +00003051 // FIXME: remember that we did this for module / chained PCH state?
Richard Smitha9a1c682014-07-07 06:38:20 +00003052 KeyFunctions.erase(Method->getParent());
John McCall6bd2a892013-01-25 22:31:03 +00003053 }
Anders Carlssondf291d82010-05-26 04:56:53 +00003054}
3055
Richard Smithdafff942012-01-14 04:30:29 +00003056static uint64_t getFieldOffset(const ASTContext &C, const FieldDecl *FD) {
3057 const ASTRecordLayout &Layout = C.getASTRecordLayout(FD->getParent());
3058 return Layout.getFieldOffset(FD->getFieldIndex());
3059}
3060
3061uint64_t ASTContext::getFieldOffset(const ValueDecl *VD) const {
3062 uint64_t OffsetInBits;
3063 if (const FieldDecl *FD = dyn_cast<FieldDecl>(VD)) {
3064 OffsetInBits = ::getFieldOffset(*this, FD);
3065 } else {
3066 const IndirectFieldDecl *IFD = cast<IndirectFieldDecl>(VD);
3067
3068 OffsetInBits = 0;
David Majnemerc964b4b2014-07-16 06:04:00 +00003069 for (const NamedDecl *ND : IFD->chain())
3070 OffsetInBits += ::getFieldOffset(*this, cast<FieldDecl>(ND));
Richard Smithdafff942012-01-14 04:30:29 +00003071 }
3072
3073 return OffsetInBits;
3074}
3075
Akira Hatanaka4b1c4842017-06-27 04:34:04 +00003076uint64_t ASTContext::lookupFieldBitOffset(const ObjCInterfaceDecl *OID,
3077 const ObjCImplementationDecl *ID,
3078 const ObjCIvarDecl *Ivar) const {
3079 const ObjCInterfaceDecl *Container = Ivar->getContainingInterface();
3080
3081 // FIXME: We should eliminate the need to have ObjCImplementationDecl passed
3082 // in here; it should never be necessary because that should be the lexical
3083 // decl context for the ivar.
3084
3085 // If we know have an implementation (and the ivar is in it) then
3086 // look up in the implementation layout.
3087 const ASTRecordLayout *RL;
3088 if (ID && declaresSameEntity(ID->getClassInterface(), Container))
3089 RL = &getASTObjCImplementationLayout(ID);
3090 else
3091 RL = &getASTObjCInterfaceLayout(Container);
3092
3093 // Compute field index.
3094 //
3095 // FIXME: The index here is closely tied to how ASTContext::getObjCLayout is
3096 // implemented. This should be fixed to get the information from the layout
3097 // directly.
3098 unsigned Index = 0;
3099
3100 for (const ObjCIvarDecl *IVD = Container->all_declared_ivar_begin();
3101 IVD; IVD = IVD->getNextIvar()) {
3102 if (Ivar == IVD)
3103 break;
3104 ++Index;
3105 }
3106 assert(Index < RL->getFieldCount() && "Ivar is not inside record layout!");
3107
3108 return RL->getFieldOffset(Index);
3109}
3110
Eric Christopher8a39a012011-10-05 06:00:51 +00003111/// getObjCLayout - Get or compute information about the layout of the
3112/// given interface.
Anders Carlssondf291d82010-05-26 04:56:53 +00003113///
3114/// \param Impl - If given, also include the layout of the interface's
3115/// implementation. This may differ by including synthesized ivars.
3116const ASTRecordLayout &
3117ASTContext::getObjCLayout(const ObjCInterfaceDecl *D,
Jay Foad39c79802011-01-12 09:06:06 +00003118 const ObjCImplementationDecl *Impl) const {
Douglas Gregor64d92572011-12-20 15:50:13 +00003119 // Retrieve the definition
Sean Callanand9a909c2012-03-15 16:33:08 +00003120 if (D->hasExternalLexicalStorage() && !D->getDefinition())
3121 getExternalSource()->CompleteType(const_cast<ObjCInterfaceDecl*>(D));
Douglas Gregor64d92572011-12-20 15:50:13 +00003122 D = D->getDefinition();
3123 assert(D && D->isThisDeclarationADefinition() && "Invalid interface decl!");
Anders Carlssondf291d82010-05-26 04:56:53 +00003124
3125 // Look up this layout, if already laid out, return what we have.
Roman Divackye6377112012-09-06 15:59:27 +00003126 const ObjCContainerDecl *Key =
3127 Impl ? (const ObjCContainerDecl*) Impl : (const ObjCContainerDecl*) D;
Anders Carlssondf291d82010-05-26 04:56:53 +00003128 if (const ASTRecordLayout *Entry = ObjCLayouts[Key])
3129 return *Entry;
3130
3131 // Add in synthesized ivar count if laying out an implementation.
3132 if (Impl) {
3133 unsigned SynthCount = CountNonClassIvars(D);
David Majnemer07639702016-02-12 19:21:02 +00003134 // If there aren't any synthesized ivars then reuse the interface
Anders Carlssondf291d82010-05-26 04:56:53 +00003135 // entry. Note we can't cache this because we simply free all
3136 // entries later; however we shouldn't look up implementations
3137 // frequently.
3138 if (SynthCount == 0)
Craig Topper36250ad2014-05-12 05:36:57 +00003139 return getObjCLayout(D, nullptr);
Anders Carlssondf291d82010-05-26 04:56:53 +00003140 }
3141
David Majnemer3b1c9902015-07-25 20:18:14 +00003142 ItaniumRecordLayoutBuilder Builder(*this, /*EmptySubobjects=*/nullptr);
Anders Carlsson6ed3a9a2010-05-26 05:04:25 +00003143 Builder.Layout(D);
3144
Anders Carlssondf291d82010-05-26 04:56:53 +00003145 const ASTRecordLayout *NewEntry =
David Majnemer97276c82016-05-24 18:10:50 +00003146 new (*this) ASTRecordLayout(*this, Builder.getSize(),
Ken Dyck4731d5b2011-02-16 02:05:21 +00003147 Builder.Alignment,
Warren Hunt7b252d22013-12-06 00:01:17 +00003148 /*RequiredAlignment : used by MS-ABI)*/
3149 Builder.Alignment,
Ken Dyck1b4420e2011-02-28 02:01:38 +00003150 Builder.getDataSize(),
David Majnemer97276c82016-05-24 18:10:50 +00003151 Builder.FieldOffsets);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00003152
Anders Carlssondf291d82010-05-26 04:56:53 +00003153 ObjCLayouts[Key] = NewEntry;
3154
3155 return *NewEntry;
3156}
3157
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003158static void PrintOffset(raw_ostream &OS,
Anders Carlsson3f018712010-10-31 23:45:59 +00003159 CharUnits Offset, unsigned IndentLevel) {
John McCall0d461692015-08-19 22:42:36 +00003160 OS << llvm::format("%10" PRId64 " | ", (int64_t)Offset.getQuantity());
3161 OS.indent(IndentLevel * 2);
3162}
3163
3164static void PrintBitFieldOffset(raw_ostream &OS, CharUnits Offset,
3165 unsigned Begin, unsigned Width,
3166 unsigned IndentLevel) {
3167 llvm::SmallString<10> Buffer;
3168 {
3169 llvm::raw_svector_ostream BufferOS(Buffer);
3170 BufferOS << Offset.getQuantity() << ':';
3171 if (Width == 0) {
3172 BufferOS << '-';
3173 } else {
3174 BufferOS << Begin << '-' << (Begin + Width - 1);
3175 }
3176 }
3177
3178 OS << llvm::right_justify(Buffer, 10) << " | ";
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003179 OS.indent(IndentLevel * 2);
3180}
3181
Eli Benderskyf6f93ee2012-12-08 00:07:24 +00003182static void PrintIndentNoOffset(raw_ostream &OS, unsigned IndentLevel) {
John McCall0d461692015-08-19 22:42:36 +00003183 OS << " | ";
Eli Benderskyf6f93ee2012-12-08 00:07:24 +00003184 OS.indent(IndentLevel * 2);
3185}
3186
John McCall0d461692015-08-19 22:42:36 +00003187static void DumpRecordLayout(raw_ostream &OS, const RecordDecl *RD,
3188 const ASTContext &C,
3189 CharUnits Offset,
3190 unsigned IndentLevel,
3191 const char* Description,
3192 bool PrintSizeInfo,
3193 bool IncludeVirtualBases) {
Anders Carlsson3f018712010-10-31 23:45:59 +00003194 const ASTRecordLayout &Layout = C.getASTRecordLayout(RD);
John McCall0d461692015-08-19 22:42:36 +00003195 auto CXXRD = dyn_cast<CXXRecordDecl>(RD);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003196
3197 PrintOffset(OS, Offset, IndentLevel);
John McCall0d461692015-08-19 22:42:36 +00003198 OS << C.getTypeDeclType(const_cast<RecordDecl*>(RD)).getAsString();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003199 if (Description)
3200 OS << ' ' << Description;
John McCall0d461692015-08-19 22:42:36 +00003201 if (CXXRD && CXXRD->isEmpty())
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003202 OS << " (empty)";
3203 OS << '\n';
3204
3205 IndentLevel++;
3206
John McCall0d461692015-08-19 22:42:36 +00003207 // Dump bases.
3208 if (CXXRD) {
3209 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
3210 bool HasOwnVFPtr = Layout.hasOwnVFPtr();
3211 bool HasOwnVBPtr = Layout.hasOwnVBPtr();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003212
John McCall0d461692015-08-19 22:42:36 +00003213 // Vtable pointer.
3214 if (CXXRD->isDynamicClass() && !PrimaryBase && !isMsLayout(C)) {
3215 PrintOffset(OS, Offset, IndentLevel);
3216 OS << '(' << *RD << " vtable pointer)\n";
3217 } else if (HasOwnVFPtr) {
3218 PrintOffset(OS, Offset, IndentLevel);
3219 // vfptr (for Microsoft C++ ABI)
3220 OS << '(' << *RD << " vftable pointer)\n";
3221 }
Warren Hunt8f8bad72013-10-11 20:19:00 +00003222
John McCall0d461692015-08-19 22:42:36 +00003223 // Collect nvbases.
3224 SmallVector<const CXXRecordDecl *, 4> Bases;
3225 for (const CXXBaseSpecifier &Base : CXXRD->bases()) {
3226 assert(!Base.getType()->isDependentType() &&
3227 "Cannot layout class with dependent bases.");
3228 if (!Base.isVirtual())
3229 Bases.push_back(Base.getType()->getAsCXXRecordDecl());
3230 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003231
John McCall0d461692015-08-19 22:42:36 +00003232 // Sort nvbases by offset.
3233 std::stable_sort(Bases.begin(), Bases.end(),
3234 [&](const CXXRecordDecl *L, const CXXRecordDecl *R) {
3235 return Layout.getBaseClassOffset(L) < Layout.getBaseClassOffset(R);
3236 });
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003237
John McCall0d461692015-08-19 22:42:36 +00003238 // Dump (non-virtual) bases
3239 for (const CXXRecordDecl *Base : Bases) {
3240 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base);
3241 DumpRecordLayout(OS, Base, C, BaseOffset, IndentLevel,
3242 Base == PrimaryBase ? "(primary base)" : "(base)",
3243 /*PrintSizeInfo=*/false,
3244 /*IncludeVirtualBases=*/false);
3245 }
Eli Friedman43114f92011-10-21 22:49:56 +00003246
John McCall0d461692015-08-19 22:42:36 +00003247 // vbptr (for Microsoft C++ ABI)
3248 if (HasOwnVBPtr) {
3249 PrintOffset(OS, Offset + Layout.getVBPtrOffset(), IndentLevel);
3250 OS << '(' << *RD << " vbtable pointer)\n";
3251 }
Eli Friedman84d2d3a2011-09-27 19:12:27 +00003252 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003253
3254 // Dump fields.
3255 uint64_t FieldNo = 0;
John McCall0d461692015-08-19 22:42:36 +00003256 for (RecordDecl::field_iterator I = RD->field_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003257 E = RD->field_end(); I != E; ++I, ++FieldNo) {
David Blaikie40ed2972012-06-06 20:45:41 +00003258 const FieldDecl &Field = **I;
John McCall0d461692015-08-19 22:42:36 +00003259 uint64_t LocalFieldOffsetInBits = Layout.getFieldOffset(FieldNo);
3260 CharUnits FieldOffset =
3261 Offset + C.toCharUnitsFromBits(LocalFieldOffsetInBits);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003262
John McCall0d461692015-08-19 22:42:36 +00003263 // Recursively dump fields of record type.
3264 if (auto RT = Field.getType()->getAs<RecordType>()) {
3265 DumpRecordLayout(OS, RT->getDecl(), C, FieldOffset, IndentLevel,
3266 Field.getName().data(),
3267 /*PrintSizeInfo=*/false,
3268 /*IncludeVirtualBases=*/true);
Reid Klecknercd612ab2014-04-11 16:57:42 +00003269 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003270 }
3271
John McCall0d461692015-08-19 22:42:36 +00003272 if (Field.isBitField()) {
3273 uint64_t LocalFieldByteOffsetInBits = C.toBits(FieldOffset - Offset);
3274 unsigned Begin = LocalFieldOffsetInBits - LocalFieldByteOffsetInBits;
3275 unsigned Width = Field.getBitWidthValue(C);
3276 PrintBitFieldOffset(OS, FieldOffset, Begin, Width, IndentLevel);
3277 } else {
3278 PrintOffset(OS, FieldOffset, IndentLevel);
3279 }
David Blaikie2d7c57e2012-04-30 02:36:29 +00003280 OS << Field.getType().getAsString() << ' ' << Field << '\n';
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003281 }
3282
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003283 // Dump virtual bases.
John McCall0d461692015-08-19 22:42:36 +00003284 if (CXXRD && IncludeVirtualBases) {
3285 const ASTRecordLayout::VBaseOffsetsMapTy &VtorDisps =
3286 Layout.getVBaseOffsetsMap();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003287
John McCall0d461692015-08-19 22:42:36 +00003288 for (const CXXBaseSpecifier &Base : CXXRD->vbases()) {
3289 assert(Base.isVirtual() && "Found non-virtual class!");
3290 const CXXRecordDecl *VBase = Base.getType()->getAsCXXRecordDecl();
John McCalle42a3362012-05-01 08:55:32 +00003291
John McCall0d461692015-08-19 22:42:36 +00003292 CharUnits VBaseOffset = Offset + Layout.getVBaseClassOffset(VBase);
3293
3294 if (VtorDisps.find(VBase)->second.hasVtorDisp()) {
3295 PrintOffset(OS, VBaseOffset - CharUnits::fromQuantity(4), IndentLevel);
3296 OS << "(vtordisp for vbase " << *VBase << ")\n";
3297 }
3298
3299 DumpRecordLayout(OS, VBase, C, VBaseOffset, IndentLevel,
3300 VBase == Layout.getPrimaryBase() ?
3301 "(primary virtual base)" : "(virtual base)",
3302 /*PrintSizeInfo=*/false,
3303 /*IncludeVirtualBases=*/false);
John McCalle42a3362012-05-01 08:55:32 +00003304 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003305 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003306
John McCall0d461692015-08-19 22:42:36 +00003307 if (!PrintSizeInfo) return;
3308
Eli Benderskyf6f93ee2012-12-08 00:07:24 +00003309 PrintIndentNoOffset(OS, IndentLevel - 1);
3310 OS << "[sizeof=" << Layout.getSize().getQuantity();
John McCall0d461692015-08-19 22:42:36 +00003311 if (CXXRD && !isMsLayout(C))
Warren Hunt8f8bad72013-10-11 20:19:00 +00003312 OS << ", dsize=" << Layout.getDataSize().getQuantity();
John McCall0d461692015-08-19 22:42:36 +00003313 OS << ", align=" << Layout.getAlignment().getQuantity();
Eli Benderskyf6f93ee2012-12-08 00:07:24 +00003314
John McCall0d461692015-08-19 22:42:36 +00003315 if (CXXRD) {
3316 OS << ",\n";
3317 PrintIndentNoOffset(OS, IndentLevel - 1);
3318 OS << " nvsize=" << Layout.getNonVirtualSize().getQuantity();
3319 OS << ", nvalign=" << Layout.getNonVirtualAlignment().getQuantity();
3320 }
3321 OS << "]\n";
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003322}
Daniel Dunbarccabe482010-04-19 20:44:53 +00003323
3324void ASTContext::DumpRecordLayout(const RecordDecl *RD,
Douglas Gregore9fc3772012-01-26 07:55:45 +00003325 raw_ostream &OS,
3326 bool Simple) const {
Douglas Gregore9fc3772012-01-26 07:55:45 +00003327 if (!Simple) {
John McCall0d461692015-08-19 22:42:36 +00003328 ::DumpRecordLayout(OS, RD, *this, CharUnits(), 0, nullptr,
3329 /*PrintSizeInfo*/true,
3330 /*IncludeVirtualBases=*/true);
3331 return;
Douglas Gregore9fc3772012-01-26 07:55:45 +00003332 }
John McCall0d461692015-08-19 22:42:36 +00003333
3334 // The "simple" format is designed to be parsed by the
3335 // layout-override testing code. There shouldn't be any external
3336 // uses of this format --- when LLDB overrides a layout, it sets up
3337 // the data structures directly --- so feel free to adjust this as
3338 // you like as long as you also update the rudimentary parser for it
3339 // in libFrontend.
3340
3341 const ASTRecordLayout &Info = getASTRecordLayout(RD);
3342 OS << "Type: " << getTypeDeclType(RD).getAsString() << "\n";
Daniel Dunbarccabe482010-04-19 20:44:53 +00003343 OS << "\nLayout: ";
3344 OS << "<ASTRecordLayout\n";
Ken Dyckb0fcc592011-02-11 01:54:29 +00003345 OS << " Size:" << toBits(Info.getSize()) << "\n";
David Majnemer3b1c9902015-07-25 20:18:14 +00003346 if (!isMsLayout(*this))
Warren Hunt8f8bad72013-10-11 20:19:00 +00003347 OS << " DataSize:" << toBits(Info.getDataSize()) << "\n";
Ken Dyck7ad11e72011-02-15 02:32:40 +00003348 OS << " Alignment:" << toBits(Info.getAlignment()) << "\n";
Daniel Dunbarccabe482010-04-19 20:44:53 +00003349 OS << " FieldOffsets: [";
3350 for (unsigned i = 0, e = Info.getFieldCount(); i != e; ++i) {
3351 if (i) OS << ", ";
3352 OS << Info.getFieldOffset(i);
3353 }
3354 OS << "]>\n";
3355}