blob: 2753a304c860f717310f2d13bf81beb7b5fd9774 [file] [log] [blame]
Anders Carlsson35a36eb2010-05-26 05:41:04 +00001//=== RecordLayoutBuilder.cpp - Helper class for building record layouts ---==//
Anders Carlsson79474332009-07-18 20:20:21 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9
Chandler Carruth3a022472012-12-04 09:13:33 +000010#include "clang/AST/RecordLayout.h"
Benjamin Kramer2ef30312012-07-04 18:45:14 +000011#include "clang/AST/ASTContext.h"
Anders Carlsson79474332009-07-18 20:20:21 +000012#include "clang/AST/Attr.h"
Anders Carlsson5adde292010-11-24 22:55:48 +000013#include "clang/AST/CXXInheritance.h"
Anders Carlsson79474332009-07-18 20:20:21 +000014#include "clang/AST/Decl.h"
Anders Carlsson6d9f6f32009-07-19 00:18:47 +000015#include "clang/AST/DeclCXX.h"
Anders Carlsson4f516282009-07-18 20:50:59 +000016#include "clang/AST/DeclObjC.h"
Anders Carlsson79474332009-07-18 20:20:21 +000017#include "clang/AST/Expr.h"
Anders Carlsson79474332009-07-18 20:20:21 +000018#include "clang/Basic/TargetInfo.h"
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +000019#include "clang/Sema/SemaDiagnostic.h"
Daniel Dunbaraa423af2010-04-08 02:59:49 +000020#include "llvm/ADT/SmallSet.h"
Ted Kremenekf75d0892011-03-19 01:00:36 +000021#include "llvm/Support/CrashRecoveryContext.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000022#include "llvm/Support/Format.h"
23#include "llvm/Support/MathExtras.h"
Anders Carlsson79474332009-07-18 20:20:21 +000024
25using namespace clang;
26
Benjamin Kramerc7656cd2010-05-26 09:58:31 +000027namespace {
Anders Carlssonf58de112010-05-26 15:32:58 +000028
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000029/// BaseSubobjectInfo - Represents a single base subobject in a complete class.
30/// For a class hierarchy like
31///
32/// class A { };
33/// class B : A { };
34/// class C : A, B { };
35///
36/// The BaseSubobjectInfo graph for C will have three BaseSubobjectInfo
37/// instances, one for B and two for A.
38///
39/// If a base is virtual, it will only have one BaseSubobjectInfo allocated.
40struct BaseSubobjectInfo {
41 /// Class - The class for this base info.
Anders Carlsson056818f2010-05-28 21:13:31 +000042 const CXXRecordDecl *Class;
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000043
44 /// IsVirtual - Whether the BaseInfo represents a virtual base or not.
Anders Carlsson056818f2010-05-28 21:13:31 +000045 bool IsVirtual;
46
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000047 /// Bases - Information about the base subobjects.
Chris Lattner0e62c1c2011-07-23 10:55:15 +000048 SmallVector<BaseSubobjectInfo*, 4> Bases;
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000049
Anders Carlssone3c24c72010-05-29 17:35:14 +000050 /// PrimaryVirtualBaseInfo - Holds the base info for the primary virtual base
51 /// of this base info (if one exists).
52 BaseSubobjectInfo *PrimaryVirtualBaseInfo;
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000053
54 // FIXME: Document.
55 const BaseSubobjectInfo *Derived;
Anders Carlsson056818f2010-05-28 21:13:31 +000056};
57
Anders Carlssonf58de112010-05-26 15:32:58 +000058/// EmptySubobjectMap - Keeps track of which empty subobjects exist at different
59/// offsets while laying out a C++ class.
60class EmptySubobjectMap {
Jay Foad39c79802011-01-12 09:06:06 +000061 const ASTContext &Context;
Anders Carlsson233e2722010-10-31 21:54:55 +000062 uint64_t CharWidth;
63
Anders Carlssonf58de112010-05-26 15:32:58 +000064 /// Class - The class whose empty entries we're keeping track of.
65 const CXXRecordDecl *Class;
Daniel Dunbar592a85c2010-05-27 02:25:46 +000066
Anders Carlsson439edd12010-05-27 05:41:06 +000067 /// EmptyClassOffsets - A map from offsets to empty record decls.
Benjamin Kramer834652a2014-05-03 18:44:26 +000068 typedef llvm::TinyPtrVector<const CXXRecordDecl *> ClassVectorTy;
Anders Carlssonf8f756d2010-10-31 21:22:43 +000069 typedef llvm::DenseMap<CharUnits, ClassVectorTy> EmptyClassOffsetsMapTy;
Anders Carlsson439edd12010-05-27 05:41:06 +000070 EmptyClassOffsetsMapTy EmptyClassOffsets;
71
Anders Carlssoncc5de092010-06-08 15:56:03 +000072 /// MaxEmptyClassOffset - The highest offset known to contain an empty
73 /// base subobject.
Anders Carlsson725190f2010-10-31 21:39:24 +000074 CharUnits MaxEmptyClassOffset;
Anders Carlssoncc5de092010-06-08 15:56:03 +000075
Daniel Dunbar592a85c2010-05-27 02:25:46 +000076 /// ComputeEmptySubobjectSizes - Compute the size of the largest base or
Anders Carlssonc5ca1f72010-05-26 15:54:25 +000077 /// member subobject that is empty.
78 void ComputeEmptySubobjectSizes();
Anders Carlsson439edd12010-05-27 05:41:06 +000079
Anders Carlsson725190f2010-10-31 21:39:24 +000080 void AddSubobjectAtOffset(const CXXRecordDecl *RD, CharUnits Offset);
Anders Carlssondb319762010-05-27 18:20:57 +000081
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000082 void UpdateEmptyBaseSubobjects(const BaseSubobjectInfo *Info,
Anders Carlsson28466ab2010-10-31 22:13:23 +000083 CharUnits Offset, bool PlacingEmptyBase);
Anders Carlsson439edd12010-05-27 05:41:06 +000084
Anders Carlssondb319762010-05-27 18:20:57 +000085 void UpdateEmptyFieldSubobjects(const CXXRecordDecl *RD,
86 const CXXRecordDecl *Class,
Anders Carlsson28466ab2010-10-31 22:13:23 +000087 CharUnits Offset);
88 void UpdateEmptyFieldSubobjects(const FieldDecl *FD, CharUnits Offset);
Anders Carlssondb319762010-05-27 18:20:57 +000089
Anders Carlssoncc5de092010-06-08 15:56:03 +000090 /// AnyEmptySubobjectsBeyondOffset - Returns whether there are any empty
91 /// subobjects beyond the given offset.
Anders Carlsson725190f2010-10-31 21:39:24 +000092 bool AnyEmptySubobjectsBeyondOffset(CharUnits Offset) const {
Anders Carlssoncc5de092010-06-08 15:56:03 +000093 return Offset <= MaxEmptyClassOffset;
94 }
95
Anders Carlsson233e2722010-10-31 21:54:55 +000096 CharUnits
97 getFieldOffset(const ASTRecordLayout &Layout, unsigned FieldNo) const {
98 uint64_t FieldOffset = Layout.getFieldOffset(FieldNo);
99 assert(FieldOffset % CharWidth == 0 &&
100 "Field offset not at char boundary!");
101
Ken Dyck7c4026b2011-01-24 01:28:50 +0000102 return Context.toCharUnitsFromBits(FieldOffset);
Anders Carlssonf8f756d2010-10-31 21:22:43 +0000103 }
Anders Carlssonf8f756d2010-10-31 21:22:43 +0000104
Charles Davisc2c576a2010-08-19 00:55:19 +0000105protected:
Anders Carlsson725190f2010-10-31 21:39:24 +0000106 bool CanPlaceSubobjectAtOffset(const CXXRecordDecl *RD,
107 CharUnits Offset) const;
Charles Davisc2c576a2010-08-19 00:55:19 +0000108
109 bool CanPlaceBaseSubobjectAtOffset(const BaseSubobjectInfo *Info,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000110 CharUnits Offset);
Charles Davisc2c576a2010-08-19 00:55:19 +0000111
112 bool CanPlaceFieldSubobjectAtOffset(const CXXRecordDecl *RD,
113 const CXXRecordDecl *Class,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000114 CharUnits Offset) const;
Charles Davisc2c576a2010-08-19 00:55:19 +0000115 bool CanPlaceFieldSubobjectAtOffset(const FieldDecl *FD,
Anders Carlsson233e2722010-10-31 21:54:55 +0000116 CharUnits Offset) const;
Charles Davisc2c576a2010-08-19 00:55:19 +0000117
Anders Carlssonf58de112010-05-26 15:32:58 +0000118public:
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000119 /// This holds the size of the largest empty subobject (either a base
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000120 /// or a member). Will be zero if the record being built doesn't contain
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000121 /// any empty classes.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000122 CharUnits SizeOfLargestEmptySubobject;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000123
Jay Foad39c79802011-01-12 09:06:06 +0000124 EmptySubobjectMap(const ASTContext &Context, const CXXRecordDecl *Class)
Anders Carlsson28466ab2010-10-31 22:13:23 +0000125 : Context(Context), CharWidth(Context.getCharWidth()), Class(Class) {
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000126 ComputeEmptySubobjectSizes();
127 }
128
129 /// CanPlaceBaseAtOffset - Return whether the given base class can be placed
130 /// at the given offset.
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000131 /// Returns false if placing the record will result in two components
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000132 /// (direct or indirect) of the same type having the same offset.
Anders Carlssoncc5de092010-06-08 15:56:03 +0000133 bool CanPlaceBaseAtOffset(const BaseSubobjectInfo *Info,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000134 CharUnits Offset);
Anders Carlssondb319762010-05-27 18:20:57 +0000135
136 /// CanPlaceFieldAtOffset - Return whether a field can be placed at the given
137 /// offset.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000138 bool CanPlaceFieldAtOffset(const FieldDecl *FD, CharUnits Offset);
Anders Carlssonf58de112010-05-26 15:32:58 +0000139};
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000140
141void EmptySubobjectMap::ComputeEmptySubobjectSizes() {
142 // Check the bases.
David Majnemerc964b4b2014-07-16 06:04:00 +0000143 for (const CXXBaseSpecifier &Base : Class->bases()) {
144 const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl();
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000145
Anders Carlsson28466ab2010-10-31 22:13:23 +0000146 CharUnits EmptySize;
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000147 const ASTRecordLayout &Layout = Context.getASTRecordLayout(BaseDecl);
148 if (BaseDecl->isEmpty()) {
149 // If the class decl is empty, get its size.
Ken Dyckc8ae5502011-02-09 01:59:34 +0000150 EmptySize = Layout.getSize();
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000151 } else {
152 // Otherwise, we get the largest empty subobject for the decl.
153 EmptySize = Layout.getSizeOfLargestEmptySubobject();
154 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000155
Anders Carlsson28466ab2010-10-31 22:13:23 +0000156 if (EmptySize > SizeOfLargestEmptySubobject)
157 SizeOfLargestEmptySubobject = EmptySize;
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000158 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000159
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000160 // Check the fields.
David Majnemerc964b4b2014-07-16 06:04:00 +0000161 for (const FieldDecl *FD : Class->fields()) {
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000162 const RecordType *RT =
David Majnemerc964b4b2014-07-16 06:04:00 +0000163 Context.getBaseElementType(FD->getType())->getAs<RecordType>();
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000164
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000165 // We only care about record types.
166 if (!RT)
167 continue;
168
Anders Carlsson28466ab2010-10-31 22:13:23 +0000169 CharUnits EmptySize;
Reid Klecknercd612ab2014-04-11 16:57:42 +0000170 const CXXRecordDecl *MemberDecl = RT->getAsCXXRecordDecl();
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000171 const ASTRecordLayout &Layout = Context.getASTRecordLayout(MemberDecl);
172 if (MemberDecl->isEmpty()) {
173 // If the class decl is empty, get its size.
Ken Dyckc8ae5502011-02-09 01:59:34 +0000174 EmptySize = Layout.getSize();
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000175 } else {
176 // Otherwise, we get the largest empty subobject for the decl.
177 EmptySize = Layout.getSizeOfLargestEmptySubobject();
178 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000179
Anders Carlsson28466ab2010-10-31 22:13:23 +0000180 if (EmptySize > SizeOfLargestEmptySubobject)
181 SizeOfLargestEmptySubobject = EmptySize;
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000182 }
183}
184
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000185bool
Anders Carlssondb319762010-05-27 18:20:57 +0000186EmptySubobjectMap::CanPlaceSubobjectAtOffset(const CXXRecordDecl *RD,
Anders Carlsson725190f2010-10-31 21:39:24 +0000187 CharUnits Offset) const {
Anders Carlssondb319762010-05-27 18:20:57 +0000188 // We only need to check empty bases.
189 if (!RD->isEmpty())
190 return true;
191
Anders Carlsson725190f2010-10-31 21:39:24 +0000192 EmptyClassOffsetsMapTy::const_iterator I = EmptyClassOffsets.find(Offset);
Anders Carlssondb319762010-05-27 18:20:57 +0000193 if (I == EmptyClassOffsets.end())
194 return true;
David Majnemerc964b4b2014-07-16 06:04:00 +0000195
196 const ClassVectorTy &Classes = I->second;
Anders Carlssondb319762010-05-27 18:20:57 +0000197 if (std::find(Classes.begin(), Classes.end(), RD) == Classes.end())
198 return true;
199
200 // There is already an empty class of the same type at this offset.
201 return false;
202}
203
204void EmptySubobjectMap::AddSubobjectAtOffset(const CXXRecordDecl *RD,
Anders Carlsson725190f2010-10-31 21:39:24 +0000205 CharUnits Offset) {
Anders Carlssondb319762010-05-27 18:20:57 +0000206 // We only care about empty bases.
207 if (!RD->isEmpty())
208 return;
209
Reid Kleckner369f3162013-05-14 20:30:42 +0000210 // If we have empty structures inside a union, we can assign both
Rafael Espindola7bcde192010-12-29 23:02:58 +0000211 // the same offset. Just avoid pushing them twice in the list.
David Majnemerc964b4b2014-07-16 06:04:00 +0000212 ClassVectorTy &Classes = EmptyClassOffsets[Offset];
Rafael Espindola7bcde192010-12-29 23:02:58 +0000213 if (std::find(Classes.begin(), Classes.end(), RD) != Classes.end())
214 return;
215
Anders Carlssondb319762010-05-27 18:20:57 +0000216 Classes.push_back(RD);
Anders Carlssoncc5de092010-06-08 15:56:03 +0000217
218 // Update the empty class offset.
Anders Carlsson725190f2010-10-31 21:39:24 +0000219 if (Offset > MaxEmptyClassOffset)
220 MaxEmptyClassOffset = Offset;
Anders Carlssondb319762010-05-27 18:20:57 +0000221}
222
223bool
Anders Carlsson28466ab2010-10-31 22:13:23 +0000224EmptySubobjectMap::CanPlaceBaseSubobjectAtOffset(const BaseSubobjectInfo *Info,
225 CharUnits Offset) {
Anders Carlsson45c1d282010-06-08 16:20:35 +0000226 // We don't have to keep looking past the maximum offset that's known to
227 // contain an empty class.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000228 if (!AnyEmptySubobjectsBeyondOffset(Offset))
Anders Carlsson45c1d282010-06-08 16:20:35 +0000229 return true;
230
Anders Carlsson28466ab2010-10-31 22:13:23 +0000231 if (!CanPlaceSubobjectAtOffset(Info->Class, Offset))
Anders Carlssondb319762010-05-27 18:20:57 +0000232 return false;
233
Anders Carlsson439edd12010-05-27 05:41:06 +0000234 // Traverse all non-virtual bases.
Anders Carlssona7774a62010-05-29 21:10:24 +0000235 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Info->Class);
David Majnemerc964b4b2014-07-16 06:04:00 +0000236 for (const BaseSubobjectInfo *Base : Info->Bases) {
Anders Carlsson439edd12010-05-27 05:41:06 +0000237 if (Base->IsVirtual)
238 continue;
239
Anders Carlsson0a14ee92010-11-01 00:21:58 +0000240 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base->Class);
Anders Carlsson439edd12010-05-27 05:41:06 +0000241
242 if (!CanPlaceBaseSubobjectAtOffset(Base, BaseOffset))
243 return false;
244 }
245
Anders Carlssone3c24c72010-05-29 17:35:14 +0000246 if (Info->PrimaryVirtualBaseInfo) {
247 BaseSubobjectInfo *PrimaryVirtualBaseInfo = Info->PrimaryVirtualBaseInfo;
Anders Carlsson439edd12010-05-27 05:41:06 +0000248
249 if (Info == PrimaryVirtualBaseInfo->Derived) {
250 if (!CanPlaceBaseSubobjectAtOffset(PrimaryVirtualBaseInfo, Offset))
251 return false;
252 }
253 }
254
Anders Carlssondb319762010-05-27 18:20:57 +0000255 // Traverse all member variables.
256 unsigned FieldNo = 0;
257 for (CXXRecordDecl::field_iterator I = Info->Class->field_begin(),
258 E = Info->Class->field_end(); I != E; ++I, ++FieldNo) {
David Blaikie40ed2972012-06-06 20:45:41 +0000259 if (I->isBitField())
Anders Carlsson233e2722010-10-31 21:54:55 +0000260 continue;
David Majnemerc964b4b2014-07-16 06:04:00 +0000261
Anders Carlsson28466ab2010-10-31 22:13:23 +0000262 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
David Blaikie40ed2972012-06-06 20:45:41 +0000263 if (!CanPlaceFieldSubobjectAtOffset(*I, FieldOffset))
Anders Carlssondb319762010-05-27 18:20:57 +0000264 return false;
265 }
David Majnemerc964b4b2014-07-16 06:04:00 +0000266
Anders Carlsson439edd12010-05-27 05:41:06 +0000267 return true;
268}
269
Anders Carlssona7f3cdb2010-05-28 21:24:37 +0000270void EmptySubobjectMap::UpdateEmptyBaseSubobjects(const BaseSubobjectInfo *Info,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000271 CharUnits Offset,
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000272 bool PlacingEmptyBase) {
273 if (!PlacingEmptyBase && Offset >= SizeOfLargestEmptySubobject) {
274 // We know that the only empty subobjects that can conflict with empty
275 // subobject of non-empty bases, are empty bases that can be placed at
276 // offset zero. Because of this, we only need to keep track of empty base
277 // subobjects with offsets less than the size of the largest empty
278 // subobject for our class.
279 return;
280 }
281
Anders Carlsson28466ab2010-10-31 22:13:23 +0000282 AddSubobjectAtOffset(Info->Class, Offset);
Anders Carlssona7774a62010-05-29 21:10:24 +0000283
Anders Carlsson439edd12010-05-27 05:41:06 +0000284 // Traverse all non-virtual bases.
Anders Carlssona7774a62010-05-29 21:10:24 +0000285 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Info->Class);
David Majnemerc964b4b2014-07-16 06:04:00 +0000286 for (const BaseSubobjectInfo *Base : Info->Bases) {
Anders Carlsson439edd12010-05-27 05:41:06 +0000287 if (Base->IsVirtual)
288 continue;
Anders Carlssona7774a62010-05-29 21:10:24 +0000289
Anders Carlsson0a14ee92010-11-01 00:21:58 +0000290 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base->Class);
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000291 UpdateEmptyBaseSubobjects(Base, BaseOffset, PlacingEmptyBase);
Anders Carlsson439edd12010-05-27 05:41:06 +0000292 }
293
Anders Carlssone3c24c72010-05-29 17:35:14 +0000294 if (Info->PrimaryVirtualBaseInfo) {
295 BaseSubobjectInfo *PrimaryVirtualBaseInfo = Info->PrimaryVirtualBaseInfo;
Anders Carlsson439edd12010-05-27 05:41:06 +0000296
297 if (Info == PrimaryVirtualBaseInfo->Derived)
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000298 UpdateEmptyBaseSubobjects(PrimaryVirtualBaseInfo, Offset,
299 PlacingEmptyBase);
Anders Carlsson439edd12010-05-27 05:41:06 +0000300 }
Anders Carlssondb319762010-05-27 18:20:57 +0000301
Anders Carlssondb319762010-05-27 18:20:57 +0000302 // Traverse all member variables.
303 unsigned FieldNo = 0;
304 for (CXXRecordDecl::field_iterator I = Info->Class->field_begin(),
305 E = Info->Class->field_end(); I != E; ++I, ++FieldNo) {
David Blaikie40ed2972012-06-06 20:45:41 +0000306 if (I->isBitField())
Anders Carlsson233e2722010-10-31 21:54:55 +0000307 continue;
Anders Carlssona7774a62010-05-29 21:10:24 +0000308
Anders Carlsson28466ab2010-10-31 22:13:23 +0000309 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
David Blaikie40ed2972012-06-06 20:45:41 +0000310 UpdateEmptyFieldSubobjects(*I, FieldOffset);
Anders Carlssondb319762010-05-27 18:20:57 +0000311 }
Anders Carlsson439edd12010-05-27 05:41:06 +0000312}
313
Anders Carlssona60b86a2010-05-29 20:49:49 +0000314bool EmptySubobjectMap::CanPlaceBaseAtOffset(const BaseSubobjectInfo *Info,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000315 CharUnits Offset) {
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000316 // If we know this class doesn't have any empty subobjects we don't need to
317 // bother checking.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000318 if (SizeOfLargestEmptySubobject.isZero())
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000319 return true;
320
Anders Carlsson439edd12010-05-27 05:41:06 +0000321 if (!CanPlaceBaseSubobjectAtOffset(Info, Offset))
322 return false;
Anders Carlssondb319762010-05-27 18:20:57 +0000323
324 // We are able to place the base at this offset. Make sure to update the
325 // empty base subobject map.
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000326 UpdateEmptyBaseSubobjects(Info, Offset, Info->Class->isEmpty());
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000327 return true;
328}
329
Anders Carlssondb319762010-05-27 18:20:57 +0000330bool
331EmptySubobjectMap::CanPlaceFieldSubobjectAtOffset(const CXXRecordDecl *RD,
332 const CXXRecordDecl *Class,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000333 CharUnits Offset) const {
Anders Carlsson45c1d282010-06-08 16:20:35 +0000334 // We don't have to keep looking past the maximum offset that's known to
335 // contain an empty class.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000336 if (!AnyEmptySubobjectsBeyondOffset(Offset))
Anders Carlsson45c1d282010-06-08 16:20:35 +0000337 return true;
338
Anders Carlsson28466ab2010-10-31 22:13:23 +0000339 if (!CanPlaceSubobjectAtOffset(RD, Offset))
Anders Carlssondb319762010-05-27 18:20:57 +0000340 return false;
341
342 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
343
344 // Traverse all non-virtual bases.
David Majnemerc964b4b2014-07-16 06:04:00 +0000345 for (const CXXBaseSpecifier &Base : RD->bases()) {
346 if (Base.isVirtual())
Anders Carlssondb319762010-05-27 18:20:57 +0000347 continue;
348
David Majnemerc964b4b2014-07-16 06:04:00 +0000349 const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl();
Anders Carlssondb319762010-05-27 18:20:57 +0000350
Anders Carlsson0a14ee92010-11-01 00:21:58 +0000351 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(BaseDecl);
Anders Carlssondb319762010-05-27 18:20:57 +0000352 if (!CanPlaceFieldSubobjectAtOffset(BaseDecl, Class, BaseOffset))
353 return false;
354 }
355
Anders Carlsson44687202010-06-08 19:09:24 +0000356 if (RD == Class) {
357 // This is the most derived class, traverse virtual bases as well.
David Majnemerc964b4b2014-07-16 06:04:00 +0000358 for (const CXXBaseSpecifier &Base : RD->vbases()) {
359 const CXXRecordDecl *VBaseDecl = Base.getType()->getAsCXXRecordDecl();
Reid Klecknercd612ab2014-04-11 16:57:42 +0000360
Anders Carlsson3f018712010-10-31 23:45:59 +0000361 CharUnits VBaseOffset = Offset + Layout.getVBaseClassOffset(VBaseDecl);
Anders Carlsson44687202010-06-08 19:09:24 +0000362 if (!CanPlaceFieldSubobjectAtOffset(VBaseDecl, Class, VBaseOffset))
363 return false;
364 }
365 }
366
Anders Carlssondb319762010-05-27 18:20:57 +0000367 // Traverse all member variables.
368 unsigned FieldNo = 0;
369 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
370 I != E; ++I, ++FieldNo) {
David Blaikie40ed2972012-06-06 20:45:41 +0000371 if (I->isBitField())
Anders Carlsson233e2722010-10-31 21:54:55 +0000372 continue;
373
Anders Carlsson28466ab2010-10-31 22:13:23 +0000374 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
Anders Carlssondb319762010-05-27 18:20:57 +0000375
David Blaikie40ed2972012-06-06 20:45:41 +0000376 if (!CanPlaceFieldSubobjectAtOffset(*I, FieldOffset))
Anders Carlssondb319762010-05-27 18:20:57 +0000377 return false;
378 }
379
380 return true;
381}
382
Anders Carlsson233e2722010-10-31 21:54:55 +0000383bool
384EmptySubobjectMap::CanPlaceFieldSubobjectAtOffset(const FieldDecl *FD,
385 CharUnits Offset) const {
Anders Carlsson45c1d282010-06-08 16:20:35 +0000386 // We don't have to keep looking past the maximum offset that's known to
387 // contain an empty class.
Anders Carlsson233e2722010-10-31 21:54:55 +0000388 if (!AnyEmptySubobjectsBeyondOffset(Offset))
Anders Carlsson45c1d282010-06-08 16:20:35 +0000389 return true;
390
Anders Carlssondb319762010-05-27 18:20:57 +0000391 QualType T = FD->getType();
Reid Klecknercd612ab2014-04-11 16:57:42 +0000392 if (const CXXRecordDecl *RD = T->getAsCXXRecordDecl())
Anders Carlsson28466ab2010-10-31 22:13:23 +0000393 return CanPlaceFieldSubobjectAtOffset(RD, RD, Offset);
Anders Carlssondb319762010-05-27 18:20:57 +0000394
395 // If we have an array type we need to look at every element.
396 if (const ConstantArrayType *AT = Context.getAsConstantArrayType(T)) {
397 QualType ElemTy = Context.getBaseElementType(AT);
398 const RecordType *RT = ElemTy->getAs<RecordType>();
399 if (!RT)
400 return true;
Reid Klecknercd612ab2014-04-11 16:57:42 +0000401
402 const CXXRecordDecl *RD = RT->getAsCXXRecordDecl();
Anders Carlssondb319762010-05-27 18:20:57 +0000403 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
404
405 uint64_t NumElements = Context.getConstantArrayElementCount(AT);
Anders Carlsson233e2722010-10-31 21:54:55 +0000406 CharUnits ElementOffset = Offset;
Anders Carlssondb319762010-05-27 18:20:57 +0000407 for (uint64_t I = 0; I != NumElements; ++I) {
Anders Carlsson45c1d282010-06-08 16:20:35 +0000408 // We don't have to keep looking past the maximum offset that's known to
409 // contain an empty class.
Anders Carlsson233e2722010-10-31 21:54:55 +0000410 if (!AnyEmptySubobjectsBeyondOffset(ElementOffset))
Anders Carlsson45c1d282010-06-08 16:20:35 +0000411 return true;
412
Anders Carlsson28466ab2010-10-31 22:13:23 +0000413 if (!CanPlaceFieldSubobjectAtOffset(RD, RD, ElementOffset))
Anders Carlssondb319762010-05-27 18:20:57 +0000414 return false;
415
Ken Dyckc8ae5502011-02-09 01:59:34 +0000416 ElementOffset += Layout.getSize();
Anders Carlssondb319762010-05-27 18:20:57 +0000417 }
418 }
419
420 return true;
421}
422
423bool
Anders Carlsson28466ab2010-10-31 22:13:23 +0000424EmptySubobjectMap::CanPlaceFieldAtOffset(const FieldDecl *FD,
425 CharUnits Offset) {
426 if (!CanPlaceFieldSubobjectAtOffset(FD, Offset))
Anders Carlssondb319762010-05-27 18:20:57 +0000427 return false;
428
429 // We are able to place the member variable at this offset.
430 // Make sure to update the empty base subobject map.
431 UpdateEmptyFieldSubobjects(FD, Offset);
432 return true;
433}
434
435void EmptySubobjectMap::UpdateEmptyFieldSubobjects(const CXXRecordDecl *RD,
436 const CXXRecordDecl *Class,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000437 CharUnits Offset) {
Anders Carlssonae111dc2010-06-13 17:49:16 +0000438 // We know that the only empty subobjects that can conflict with empty
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000439 // field subobjects are subobjects of empty bases that can be placed at offset
Anders Carlssonae111dc2010-06-13 17:49:16 +0000440 // zero. Because of this, we only need to keep track of empty field
441 // subobjects with offsets less than the size of the largest empty
442 // subobject for our class.
443 if (Offset >= SizeOfLargestEmptySubobject)
444 return;
445
Anders Carlsson28466ab2010-10-31 22:13:23 +0000446 AddSubobjectAtOffset(RD, Offset);
Anders Carlssondb319762010-05-27 18:20:57 +0000447
448 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
449
450 // Traverse all non-virtual bases.
David Majnemerc964b4b2014-07-16 06:04:00 +0000451 for (const CXXBaseSpecifier &Base : RD->bases()) {
452 if (Base.isVirtual())
Anders Carlssondb319762010-05-27 18:20:57 +0000453 continue;
454
David Majnemerc964b4b2014-07-16 06:04:00 +0000455 const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl();
Anders Carlssondb319762010-05-27 18:20:57 +0000456
Anders Carlsson0a14ee92010-11-01 00:21:58 +0000457 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(BaseDecl);
Anders Carlssondb319762010-05-27 18:20:57 +0000458 UpdateEmptyFieldSubobjects(BaseDecl, Class, BaseOffset);
459 }
460
Anders Carlsson44687202010-06-08 19:09:24 +0000461 if (RD == Class) {
462 // This is the most derived class, traverse virtual bases as well.
David Majnemerc964b4b2014-07-16 06:04:00 +0000463 for (const CXXBaseSpecifier &Base : RD->vbases()) {
464 const CXXRecordDecl *VBaseDecl = Base.getType()->getAsCXXRecordDecl();
Reid Klecknercd612ab2014-04-11 16:57:42 +0000465
Anders Carlsson3f018712010-10-31 23:45:59 +0000466 CharUnits VBaseOffset = Offset + Layout.getVBaseClassOffset(VBaseDecl);
Anders Carlsson44687202010-06-08 19:09:24 +0000467 UpdateEmptyFieldSubobjects(VBaseDecl, Class, VBaseOffset);
468 }
469 }
470
Anders Carlssondb319762010-05-27 18:20:57 +0000471 // Traverse all member variables.
472 unsigned FieldNo = 0;
473 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
474 I != E; ++I, ++FieldNo) {
David Blaikie40ed2972012-06-06 20:45:41 +0000475 if (I->isBitField())
Anders Carlsson09814d32010-11-01 15:14:51 +0000476 continue;
477
Anders Carlsson28466ab2010-10-31 22:13:23 +0000478 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
Anders Carlssondb319762010-05-27 18:20:57 +0000479
David Blaikie40ed2972012-06-06 20:45:41 +0000480 UpdateEmptyFieldSubobjects(*I, FieldOffset);
Anders Carlssondb319762010-05-27 18:20:57 +0000481 }
482}
483
484void EmptySubobjectMap::UpdateEmptyFieldSubobjects(const FieldDecl *FD,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000485 CharUnits Offset) {
Anders Carlssondb319762010-05-27 18:20:57 +0000486 QualType T = FD->getType();
Reid Klecknercd612ab2014-04-11 16:57:42 +0000487 if (const CXXRecordDecl *RD = T->getAsCXXRecordDecl()) {
Anders Carlssondb319762010-05-27 18:20:57 +0000488 UpdateEmptyFieldSubobjects(RD, RD, Offset);
489 return;
490 }
491
492 // If we have an array type we need to update every element.
493 if (const ConstantArrayType *AT = Context.getAsConstantArrayType(T)) {
494 QualType ElemTy = Context.getBaseElementType(AT);
495 const RecordType *RT = ElemTy->getAs<RecordType>();
496 if (!RT)
497 return;
Reid Klecknercd612ab2014-04-11 16:57:42 +0000498
499 const CXXRecordDecl *RD = RT->getAsCXXRecordDecl();
Anders Carlssondb319762010-05-27 18:20:57 +0000500 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
501
502 uint64_t NumElements = Context.getConstantArrayElementCount(AT);
Anders Carlsson28466ab2010-10-31 22:13:23 +0000503 CharUnits ElementOffset = Offset;
Anders Carlssondb319762010-05-27 18:20:57 +0000504
505 for (uint64_t I = 0; I != NumElements; ++I) {
Anders Carlssonae111dc2010-06-13 17:49:16 +0000506 // We know that the only empty subobjects that can conflict with empty
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000507 // field subobjects are subobjects of empty bases that can be placed at
Anders Carlssonae111dc2010-06-13 17:49:16 +0000508 // offset zero. Because of this, we only need to keep track of empty field
509 // subobjects with offsets less than the size of the largest empty
510 // subobject for our class.
511 if (ElementOffset >= SizeOfLargestEmptySubobject)
512 return;
513
Anders Carlssondb319762010-05-27 18:20:57 +0000514 UpdateEmptyFieldSubobjects(RD, RD, ElementOffset);
Ken Dyckc8ae5502011-02-09 01:59:34 +0000515 ElementOffset += Layout.getSize();
Anders Carlssondb319762010-05-27 18:20:57 +0000516 }
517 }
518}
519
John McCalle42a3362012-05-01 08:55:32 +0000520typedef llvm::SmallPtrSet<const CXXRecordDecl*, 4> ClassSetTy;
521
Anders Carlssonc2226202010-05-26 05:58:59 +0000522class RecordLayoutBuilder {
Charles Davisc2c576a2010-08-19 00:55:19 +0000523protected:
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000524 // FIXME: Remove this and make the appropriate fields public.
525 friend class clang::ASTContext;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000526
Jay Foad39c79802011-01-12 09:06:06 +0000527 const ASTContext &Context;
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000528
Anders Carlssonf58de112010-05-26 15:32:58 +0000529 EmptySubobjectMap *EmptySubobjects;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000530
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000531 /// Size - The current size of the record layout.
532 uint64_t Size;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000533
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000534 /// Alignment - The current alignment of the record layout.
Ken Dyck4731d5b2011-02-16 02:05:21 +0000535 CharUnits Alignment;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000536
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000537 /// \brief The alignment if attribute packed is not used.
Ken Dyck1300b3b2011-02-16 02:11:31 +0000538 CharUnits UnpackedAlignment;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000539
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000540 SmallVector<uint64_t, 16> FieldOffsets;
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000541
Douglas Gregore9fc3772012-01-26 07:55:45 +0000542 /// \brief Whether the external AST source has provided a layout for this
543 /// record.
544 unsigned ExternalLayout : 1;
Douglas Gregor44ba7892012-01-28 00:53:29 +0000545
546 /// \brief Whether we need to infer alignment, even when we have an
547 /// externally-provided layout.
548 unsigned InferAlignment : 1;
Douglas Gregore9fc3772012-01-26 07:55:45 +0000549
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000550 /// Packed - Whether the record is packed or not.
Daniel Dunbar6da10982010-05-27 05:45:51 +0000551 unsigned Packed : 1;
552
553 unsigned IsUnion : 1;
554
555 unsigned IsMac68kAlign : 1;
Fariborz Jahanianbcb23a12011-04-26 23:52:16 +0000556
557 unsigned IsMsStruct : 1;
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000558
Eli Friedman2782dac2013-06-26 20:50:34 +0000559 /// UnfilledBitsInLastUnit - If the last field laid out was a bitfield,
560 /// this contains the number of bits in the last unit that can be used for
561 /// an adjacent bitfield if necessary. The unit in question is usually
562 /// a byte, but larger units are used if IsMsStruct.
563 unsigned char UnfilledBitsInLastUnit;
564 /// LastBitfieldTypeSize - If IsMsStruct, represents the size of the type
565 /// of the previous field if it was a bitfield.
566 unsigned char LastBitfieldTypeSize;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000567
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000568 /// MaxFieldAlignment - The maximum allowed field alignment. This is set by
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000569 /// #pragma pack.
Ken Dyck02ced6f2011-02-17 01:49:42 +0000570 CharUnits MaxFieldAlignment;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000571
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000572 /// DataSize - The data size of the record being laid out.
573 uint64_t DataSize;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000574
Ken Dyckaf1c83f2011-02-16 01:52:01 +0000575 CharUnits NonVirtualSize;
Ken Dycka2d3dda2011-02-16 01:43:15 +0000576 CharUnits NonVirtualAlignment;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000577
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000578 /// PrimaryBase - the primary base class (if one exists) of the class
579 /// we're laying out.
580 const CXXRecordDecl *PrimaryBase;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000581
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000582 /// PrimaryBaseIsVirtual - Whether the primary base of the class we're laying
583 /// out is virtual.
584 bool PrimaryBaseIsVirtual;
585
John McCalle42a3362012-05-01 08:55:32 +0000586 /// HasOwnVFPtr - Whether the class provides its own vtable/vftbl
587 /// pointer, as opposed to inheriting one from a primary base class.
588 bool HasOwnVFPtr;
Eli Friedman43114f92011-10-21 22:49:56 +0000589
Anders Carlsson22f57202010-10-31 21:01:46 +0000590 typedef llvm::DenseMap<const CXXRecordDecl *, CharUnits> BaseOffsetsMapTy;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000591
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000592 /// Bases - base classes and their offsets in the record.
593 BaseOffsetsMapTy Bases;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000594
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000595 // VBases - virtual base classes and their offsets in the record.
John McCalle42a3362012-05-01 08:55:32 +0000596 ASTRecordLayout::VBaseOffsetsMapTy VBases;
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000597
598 /// IndirectPrimaryBases - Virtual base classes, direct or indirect, that are
599 /// primary base classes for some other direct or indirect base class.
Anders Carlsson5adde292010-11-24 22:55:48 +0000600 CXXIndirectPrimaryBaseSet IndirectPrimaryBases;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000601
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000602 /// FirstNearlyEmptyVBase - The first nearly empty virtual base class in
603 /// inheritance graph order. Used for determining the primary base class.
604 const CXXRecordDecl *FirstNearlyEmptyVBase;
605
606 /// VisitedVirtualBases - A set of all the visited virtual bases, used to
607 /// avoid visiting virtual bases more than once.
608 llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBases;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000609
Douglas Gregore9fc3772012-01-26 07:55:45 +0000610 /// \brief Externally-provided size.
611 uint64_t ExternalSize;
612
613 /// \brief Externally-provided alignment.
614 uint64_t ExternalAlign;
615
616 /// \brief Externally-provided field offsets.
617 llvm::DenseMap<const FieldDecl *, uint64_t> ExternalFieldOffsets;
618
619 /// \brief Externally-provided direct, non-virtual base offsets.
620 llvm::DenseMap<const CXXRecordDecl *, CharUnits> ExternalBaseOffsets;
621
622 /// \brief Externally-provided virtual base offsets.
623 llvm::DenseMap<const CXXRecordDecl *, CharUnits> ExternalVirtualBaseOffsets;
624
John McCall0153cd32011-11-08 04:01:03 +0000625 RecordLayoutBuilder(const ASTContext &Context,
626 EmptySubobjectMap *EmptySubobjects)
Ken Dyck4731d5b2011-02-16 02:05:21 +0000627 : Context(Context), EmptySubobjects(EmptySubobjects), Size(0),
John McCall0153cd32011-11-08 04:01:03 +0000628 Alignment(CharUnits::One()), UnpackedAlignment(CharUnits::One()),
Douglas Gregor44ba7892012-01-28 00:53:29 +0000629 ExternalLayout(false), InferAlignment(false),
630 Packed(false), IsUnion(false), IsMac68kAlign(false), IsMsStruct(false),
Eli Friedman2782dac2013-06-26 20:50:34 +0000631 UnfilledBitsInLastUnit(0), LastBitfieldTypeSize(0),
632 MaxFieldAlignment(CharUnits::Zero()),
Ken Dyck02ced6f2011-02-17 01:49:42 +0000633 DataSize(0), NonVirtualSize(CharUnits::Zero()),
Fariborz Jahanianeb397412011-05-02 17:20:56 +0000634 NonVirtualAlignment(CharUnits::One()),
Craig Topper36250ad2014-05-12 05:36:57 +0000635 PrimaryBase(nullptr), PrimaryBaseIsVirtual(false),
John McCalle42a3362012-05-01 08:55:32 +0000636 HasOwnVFPtr(false),
Craig Topper36250ad2014-05-12 05:36:57 +0000637 FirstNearlyEmptyVBase(nullptr) {}
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000638
John McCall0153cd32011-11-08 04:01:03 +0000639 /// Reset this RecordLayoutBuilder to a fresh state, using the given
640 /// alignment as the initial alignment. This is used for the
641 /// correct layout of vb-table pointers in MSVC.
642 void resetWithTargetAlignment(CharUnits TargetAlignment) {
643 const ASTContext &Context = this->Context;
644 EmptySubobjectMap *EmptySubobjects = this->EmptySubobjects;
645 this->~RecordLayoutBuilder();
646 new (this) RecordLayoutBuilder(Context, EmptySubobjects);
647 Alignment = UnpackedAlignment = TargetAlignment;
648 }
649
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000650 void Layout(const RecordDecl *D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000651 void Layout(const CXXRecordDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000652 void Layout(const ObjCInterfaceDecl *D);
653
654 void LayoutFields(const RecordDecl *D);
655 void LayoutField(const FieldDecl *D);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000656 void LayoutWideBitField(uint64_t FieldSize, uint64_t TypeSize,
657 bool FieldPacked, const FieldDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000658 void LayoutBitField(const FieldDecl *D);
John McCall0153cd32011-11-08 04:01:03 +0000659
John McCall359b8852013-01-25 22:30:49 +0000660 TargetCXXABI getCXXABI() const {
661 return Context.getTargetInfo().getCXXABI();
662 }
663
Anders Carlssone3c24c72010-05-29 17:35:14 +0000664 /// BaseSubobjectInfoAllocator - Allocator for BaseSubobjectInfo objects.
665 llvm::SpecificBumpPtrAllocator<BaseSubobjectInfo> BaseSubobjectInfoAllocator;
666
667 typedef llvm::DenseMap<const CXXRecordDecl *, BaseSubobjectInfo *>
668 BaseSubobjectInfoMapTy;
669
670 /// VirtualBaseInfo - Map from all the (direct or indirect) virtual bases
671 /// of the class we're laying out to their base subobject info.
672 BaseSubobjectInfoMapTy VirtualBaseInfo;
673
674 /// NonVirtualBaseInfo - Map from all the direct non-virtual bases of the
675 /// class we're laying out to their base subobject info.
676 BaseSubobjectInfoMapTy NonVirtualBaseInfo;
677
678 /// ComputeBaseSubobjectInfo - Compute the base subobject information for the
679 /// bases of the given class.
680 void ComputeBaseSubobjectInfo(const CXXRecordDecl *RD);
681
682 /// ComputeBaseSubobjectInfo - Compute the base subobject information for a
683 /// single class and all of its base classes.
684 BaseSubobjectInfo *ComputeBaseSubobjectInfo(const CXXRecordDecl *RD,
685 bool IsVirtual,
686 BaseSubobjectInfo *Derived);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000687
688 /// DeterminePrimaryBase - Determine the primary base of the given class.
689 void DeterminePrimaryBase(const CXXRecordDecl *RD);
690
691 void SelectPrimaryVBase(const CXXRecordDecl *RD);
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000692
Eli Friedman43114f92011-10-21 22:49:56 +0000693 void EnsureVTablePointerAlignment(CharUnits UnpackedBaseAlign);
Charles Davisc2c576a2010-08-19 00:55:19 +0000694
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000695 /// LayoutNonVirtualBases - Determines the primary base class (if any) and
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000696 /// lays it out. Will then proceed to lay out all non-virtual base clasess.
697 void LayoutNonVirtualBases(const CXXRecordDecl *RD);
698
699 /// LayoutNonVirtualBase - Lays out a single non-virtual base.
Anders Carlssonbb0e6782010-05-29 17:42:25 +0000700 void LayoutNonVirtualBase(const BaseSubobjectInfo *Base);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000701
Anders Carlssona2f8e412010-10-31 22:20:42 +0000702 void AddPrimaryVirtualBaseOffsets(const BaseSubobjectInfo *Info,
703 CharUnits Offset);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000704
705 /// LayoutVirtualBases - Lays out all the virtual bases.
706 void LayoutVirtualBases(const CXXRecordDecl *RD,
707 const CXXRecordDecl *MostDerivedClass);
708
709 /// LayoutVirtualBase - Lays out a single virtual base.
Warren Hunt55d8e822013-10-23 23:53:07 +0000710 void LayoutVirtualBase(const BaseSubobjectInfo *Base);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000711
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000712 /// LayoutBase - Will lay out a base and return the offset where it was
Anders Carlssona2f8e412010-10-31 22:20:42 +0000713 /// placed, in chars.
714 CharUnits LayoutBase(const BaseSubobjectInfo *Base);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000715
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000716 /// InitializeLayout - Initialize record layout for the given record decl.
Daniel Dunbar6da10982010-05-27 05:45:51 +0000717 void InitializeLayout(const Decl *D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000718
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000719 /// FinishLayout - Finalize record layout. Adjust record size based on the
720 /// alignment.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000721 void FinishLayout(const NamedDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000722
Ken Dyck85ef0432011-02-19 18:58:07 +0000723 void UpdateAlignment(CharUnits NewAlignment, CharUnits UnpackedNewAlignment);
724 void UpdateAlignment(CharUnits NewAlignment) {
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000725 UpdateAlignment(NewAlignment, NewAlignment);
726 }
727
Douglas Gregor44ba7892012-01-28 00:53:29 +0000728 /// \brief Retrieve the externally-supplied field offset for the given
729 /// field.
730 ///
731 /// \param Field The field whose offset is being queried.
732 /// \param ComputedOffset The offset that we've computed for this field.
733 uint64_t updateExternalFieldOffset(const FieldDecl *Field,
734 uint64_t ComputedOffset);
735
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000736 void CheckFieldPadding(uint64_t Offset, uint64_t UnpaddedOffset,
737 uint64_t UnpackedOffset, unsigned UnpackedAlign,
738 bool isPacked, const FieldDecl *D);
739
740 DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000741
Ken Dyckecfc7552011-02-24 01:13:28 +0000742 CharUnits getSize() const {
Ken Dyck3c215f22011-02-24 01:33:05 +0000743 assert(Size % Context.getCharWidth() == 0);
Ken Dyckecfc7552011-02-24 01:13:28 +0000744 return Context.toCharUnitsFromBits(Size);
745 }
746 uint64_t getSizeInBits() const { return Size; }
747
748 void setSize(CharUnits NewSize) { Size = Context.toBits(NewSize); }
749 void setSize(uint64_t NewSize) { Size = NewSize; }
750
Eli Friedman84d2d3a2011-09-27 19:12:27 +0000751 CharUnits getAligment() const { return Alignment; }
752
Ken Dyckecfc7552011-02-24 01:13:28 +0000753 CharUnits getDataSize() const {
Ken Dyck3c215f22011-02-24 01:33:05 +0000754 assert(DataSize % Context.getCharWidth() == 0);
Ken Dyckecfc7552011-02-24 01:13:28 +0000755 return Context.toCharUnitsFromBits(DataSize);
756 }
757 uint64_t getDataSizeInBits() const { return DataSize; }
758
759 void setDataSize(CharUnits NewSize) { DataSize = Context.toBits(NewSize); }
760 void setDataSize(uint64_t NewSize) { DataSize = NewSize; }
761
Dmitri Gribenkoa664e5b2012-09-15 20:20:27 +0000762 RecordLayoutBuilder(const RecordLayoutBuilder &) LLVM_DELETED_FUNCTION;
763 void operator=(const RecordLayoutBuilder &) LLVM_DELETED_FUNCTION;
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000764};
Benjamin Kramerc7656cd2010-05-26 09:58:31 +0000765} // end anonymous namespace
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000766
Anders Carlsson81430692009-09-22 03:02:06 +0000767void
Anders Carlssonc2226202010-05-26 05:58:59 +0000768RecordLayoutBuilder::SelectPrimaryVBase(const CXXRecordDecl *RD) {
Aaron Ballman574705e2014-03-13 15:41:46 +0000769 for (const auto &I : RD->bases()) {
770 assert(!I.getType()->isDependentType() &&
Sebastian Redl1054fae2009-10-25 17:03:50 +0000771 "Cannot layout class with dependent bases.");
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000772
Reid Klecknercd612ab2014-04-11 16:57:42 +0000773 const CXXRecordDecl *Base = I.getType()->getAsCXXRecordDecl();
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000774
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000775 // Check if this is a nearly empty virtual base.
Aaron Ballman574705e2014-03-13 15:41:46 +0000776 if (I.isVirtual() && Context.isNearlyEmpty(Base)) {
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000777 // If it's not an indirect primary base, then we've found our primary
778 // base.
Anders Carlsson81430692009-09-22 03:02:06 +0000779 if (!IndirectPrimaryBases.count(Base)) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000780 PrimaryBase = Base;
781 PrimaryBaseIsVirtual = true;
Mike Stump6f3793b2009-08-12 21:50:08 +0000782 return;
783 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000784
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000785 // Is this the first nearly empty virtual base?
786 if (!FirstNearlyEmptyVBase)
787 FirstNearlyEmptyVBase = Base;
Mike Stump6f3793b2009-08-12 21:50:08 +0000788 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000789
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000790 SelectPrimaryVBase(Base);
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000791 if (PrimaryBase)
Zhongxing Xuec345b72010-02-15 04:28:35 +0000792 return;
Mike Stump6f3793b2009-08-12 21:50:08 +0000793 }
794}
795
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000796/// DeterminePrimaryBase - Determine the primary base of the given class.
Anders Carlssonc2226202010-05-26 05:58:59 +0000797void RecordLayoutBuilder::DeterminePrimaryBase(const CXXRecordDecl *RD) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000798 // If the class isn't dynamic, it won't have a primary base.
799 if (!RD->isDynamicClass())
800 return;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000801
Anders Carlsson81430692009-09-22 03:02:06 +0000802 // Compute all the primary virtual bases for all of our direct and
Mike Stump590a7c72009-08-13 23:26:06 +0000803 // indirect bases, and record all their primary virtual base classes.
Anders Carlsson5adde292010-11-24 22:55:48 +0000804 RD->getIndirectPrimaryBases(IndirectPrimaryBases);
Mike Stump590a7c72009-08-13 23:26:06 +0000805
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000806 // If the record has a dynamic base class, attempt to choose a primary base
807 // class. It is the first (in direct base class order) non-virtual dynamic
Anders Carlsson81430692009-09-22 03:02:06 +0000808 // base class, if one exists.
Aaron Ballman574705e2014-03-13 15:41:46 +0000809 for (const auto &I : RD->bases()) {
Anders Carlsson03ff3792009-11-27 22:05:05 +0000810 // Ignore virtual bases.
Aaron Ballman574705e2014-03-13 15:41:46 +0000811 if (I.isVirtual())
Anders Carlsson03ff3792009-11-27 22:05:05 +0000812 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000813
Reid Klecknercd612ab2014-04-11 16:57:42 +0000814 const CXXRecordDecl *Base = I.getType()->getAsCXXRecordDecl();
Anders Carlsson03ff3792009-11-27 22:05:05 +0000815
Warren Hunt55d8e822013-10-23 23:53:07 +0000816 if (Base->isDynamicClass()) {
Anders Carlsson03ff3792009-11-27 22:05:05 +0000817 // We found it.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000818 PrimaryBase = Base;
819 PrimaryBaseIsVirtual = false;
Anders Carlsson03ff3792009-11-27 22:05:05 +0000820 return;
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000821 }
822 }
823
Eli Friedman5e9534b2011-10-18 00:55:28 +0000824 // Under the Itanium ABI, if there is no non-virtual primary base class,
825 // try to compute the primary virtual base. The primary virtual base is
826 // the first nearly empty virtual base that is not an indirect primary
827 // virtual base class, if one exists.
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000828 if (RD->getNumVBases() != 0) {
829 SelectPrimaryVBase(RD);
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000830 if (PrimaryBase)
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000831 return;
832 }
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000833
Eli Friedman5e9534b2011-10-18 00:55:28 +0000834 // Otherwise, it is the first indirect primary base class, if one exists.
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000835 if (FirstNearlyEmptyVBase) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000836 PrimaryBase = FirstNearlyEmptyVBase;
837 PrimaryBaseIsVirtual = true;
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000838 return;
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000839 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000840
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000841 assert(!PrimaryBase && "Should not get here with a primary base!");
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000842}
843
Anders Carlssone3c24c72010-05-29 17:35:14 +0000844BaseSubobjectInfo *
845RecordLayoutBuilder::ComputeBaseSubobjectInfo(const CXXRecordDecl *RD,
846 bool IsVirtual,
847 BaseSubobjectInfo *Derived) {
848 BaseSubobjectInfo *Info;
849
850 if (IsVirtual) {
851 // Check if we already have info about this virtual base.
852 BaseSubobjectInfo *&InfoSlot = VirtualBaseInfo[RD];
853 if (InfoSlot) {
854 assert(InfoSlot->Class == RD && "Wrong class for virtual base info!");
855 return InfoSlot;
856 }
857
858 // We don't, create it.
859 InfoSlot = new (BaseSubobjectInfoAllocator.Allocate()) BaseSubobjectInfo;
860 Info = InfoSlot;
861 } else {
862 Info = new (BaseSubobjectInfoAllocator.Allocate()) BaseSubobjectInfo;
863 }
864
865 Info->Class = RD;
866 Info->IsVirtual = IsVirtual;
Craig Topper36250ad2014-05-12 05:36:57 +0000867 Info->Derived = nullptr;
868 Info->PrimaryVirtualBaseInfo = nullptr;
869
870 const CXXRecordDecl *PrimaryVirtualBase = nullptr;
871 BaseSubobjectInfo *PrimaryVirtualBaseInfo = nullptr;
Anders Carlssone3c24c72010-05-29 17:35:14 +0000872
873 // Check if this base has a primary virtual base.
874 if (RD->getNumVBases()) {
875 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlsson7f95cd12010-11-24 23:12:57 +0000876 if (Layout.isPrimaryBaseVirtual()) {
Anders Carlssone3c24c72010-05-29 17:35:14 +0000877 // This base does have a primary virtual base.
878 PrimaryVirtualBase = Layout.getPrimaryBase();
879 assert(PrimaryVirtualBase && "Didn't have a primary virtual base!");
880
881 // Now check if we have base subobject info about this primary base.
882 PrimaryVirtualBaseInfo = VirtualBaseInfo.lookup(PrimaryVirtualBase);
883
884 if (PrimaryVirtualBaseInfo) {
885 if (PrimaryVirtualBaseInfo->Derived) {
886 // We did have info about this primary base, and it turns out that it
887 // has already been claimed as a primary virtual base for another
Craig Topper36250ad2014-05-12 05:36:57 +0000888 // base.
889 PrimaryVirtualBase = nullptr;
Anders Carlssone3c24c72010-05-29 17:35:14 +0000890 } else {
891 // We can claim this base as our primary base.
892 Info->PrimaryVirtualBaseInfo = PrimaryVirtualBaseInfo;
893 PrimaryVirtualBaseInfo->Derived = Info;
894 }
895 }
896 }
897 }
898
899 // Now go through all direct bases.
Aaron Ballman574705e2014-03-13 15:41:46 +0000900 for (const auto &I : RD->bases()) {
901 bool IsVirtual = I.isVirtual();
Reid Klecknercd612ab2014-04-11 16:57:42 +0000902
903 const CXXRecordDecl *BaseDecl = I.getType()->getAsCXXRecordDecl();
904
Anders Carlssone3c24c72010-05-29 17:35:14 +0000905 Info->Bases.push_back(ComputeBaseSubobjectInfo(BaseDecl, IsVirtual, Info));
906 }
907
908 if (PrimaryVirtualBase && !PrimaryVirtualBaseInfo) {
909 // Traversing the bases must have created the base info for our primary
910 // virtual base.
911 PrimaryVirtualBaseInfo = VirtualBaseInfo.lookup(PrimaryVirtualBase);
912 assert(PrimaryVirtualBaseInfo &&
913 "Did not create a primary virtual base!");
914
915 // Claim the primary virtual base as our primary virtual base.
916 Info->PrimaryVirtualBaseInfo = PrimaryVirtualBaseInfo;
917 PrimaryVirtualBaseInfo->Derived = Info;
918 }
919
920 return Info;
921}
922
923void RecordLayoutBuilder::ComputeBaseSubobjectInfo(const CXXRecordDecl *RD) {
Aaron Ballman574705e2014-03-13 15:41:46 +0000924 for (const auto &I : RD->bases()) {
925 bool IsVirtual = I.isVirtual();
Anders Carlssone3c24c72010-05-29 17:35:14 +0000926
Reid Klecknercd612ab2014-04-11 16:57:42 +0000927 const CXXRecordDecl *BaseDecl = I.getType()->getAsCXXRecordDecl();
928
Anders Carlssone3c24c72010-05-29 17:35:14 +0000929 // Compute the base subobject info for this base.
Craig Topper36250ad2014-05-12 05:36:57 +0000930 BaseSubobjectInfo *Info = ComputeBaseSubobjectInfo(BaseDecl, IsVirtual,
931 nullptr);
Anders Carlssone3c24c72010-05-29 17:35:14 +0000932
933 if (IsVirtual) {
934 // ComputeBaseInfo has already added this base for us.
935 assert(VirtualBaseInfo.count(BaseDecl) &&
936 "Did not add virtual base!");
937 } else {
938 // Add the base info to the map of non-virtual bases.
939 assert(!NonVirtualBaseInfo.count(BaseDecl) &&
940 "Non-virtual base already exists!");
941 NonVirtualBaseInfo.insert(std::make_pair(BaseDecl, Info));
942 }
943 }
944}
945
Anders Carlsson09ffa322010-03-10 22:21:28 +0000946void
Eli Friedman43114f92011-10-21 22:49:56 +0000947RecordLayoutBuilder::EnsureVTablePointerAlignment(CharUnits UnpackedBaseAlign) {
Eli Friedman5e9534b2011-10-18 00:55:28 +0000948 CharUnits BaseAlign = (Packed) ? CharUnits::One() : UnpackedBaseAlign;
949
950 // The maximum field alignment overrides base align.
951 if (!MaxFieldAlignment.isZero()) {
952 BaseAlign = std::min(BaseAlign, MaxFieldAlignment);
953 UnpackedBaseAlign = std::min(UnpackedBaseAlign, MaxFieldAlignment);
954 }
955
956 // Round up the current record size to pointer alignment.
Eli Friedman43114f92011-10-21 22:49:56 +0000957 setSize(getSize().RoundUpToAlignment(BaseAlign));
958 setDataSize(getSize());
Eli Friedman5e9534b2011-10-18 00:55:28 +0000959
960 // Update the alignment.
961 UpdateAlignment(BaseAlign, UnpackedBaseAlign);
962}
963
964void
Anders Carlssonc2226202010-05-26 05:58:59 +0000965RecordLayoutBuilder::LayoutNonVirtualBases(const CXXRecordDecl *RD) {
Anders Carlssone3c24c72010-05-29 17:35:14 +0000966 // Then, determine the primary base class.
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000967 DeterminePrimaryBase(RD);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000968
Anders Carlssone3c24c72010-05-29 17:35:14 +0000969 // Compute base subobject info.
970 ComputeBaseSubobjectInfo(RD);
971
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000972 // If we have a primary base class, lay it out.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000973 if (PrimaryBase) {
974 if (PrimaryBaseIsVirtual) {
Anders Carlssone3c24c72010-05-29 17:35:14 +0000975 // If the primary virtual base was a primary virtual base of some other
976 // base class we'll have to steal it.
977 BaseSubobjectInfo *PrimaryBaseInfo = VirtualBaseInfo.lookup(PrimaryBase);
Craig Topper36250ad2014-05-12 05:36:57 +0000978 PrimaryBaseInfo->Derived = nullptr;
979
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000980 // We have a virtual primary base, insert it as an indirect primary base.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000981 IndirectPrimaryBases.insert(PrimaryBase);
Anders Carlssonfe900962010-03-11 05:42:17 +0000982
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000983 assert(!VisitedVirtualBases.count(PrimaryBase) &&
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000984 "vbase already visited!");
985 VisitedVirtualBases.insert(PrimaryBase);
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000986
Anders Carlssond6ff5d72010-05-29 17:48:36 +0000987 LayoutVirtualBase(PrimaryBaseInfo);
Anders Carlssonbb0e6782010-05-29 17:42:25 +0000988 } else {
989 BaseSubobjectInfo *PrimaryBaseInfo =
990 NonVirtualBaseInfo.lookup(PrimaryBase);
991 assert(PrimaryBaseInfo &&
992 "Did not find base info for non-virtual primary base!");
993
994 LayoutNonVirtualBase(PrimaryBaseInfo);
995 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000996
John McCall0153cd32011-11-08 04:01:03 +0000997 // If this class needs a vtable/vf-table and didn't get one from a
998 // primary base, add it in now.
Warren Hunt55d8e822013-10-23 23:53:07 +0000999 } else if (RD->isDynamicClass()) {
Eli Friedman5e9534b2011-10-18 00:55:28 +00001000 assert(DataSize == 0 && "Vtable pointer must be at offset zero!");
Eli Friedman5e9534b2011-10-18 00:55:28 +00001001 CharUnits PtrWidth =
1002 Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerWidth(0));
Eli Friedman43114f92011-10-21 22:49:56 +00001003 CharUnits PtrAlign =
1004 Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerAlign(0));
1005 EnsureVTablePointerAlignment(PtrAlign);
John McCalle42a3362012-05-01 08:55:32 +00001006 HasOwnVFPtr = true;
Eli Friedman5e9534b2011-10-18 00:55:28 +00001007 setSize(getSize() + PtrWidth);
1008 setDataSize(getSize());
1009 }
1010
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001011 // Now lay out the non-virtual bases.
Aaron Ballman574705e2014-03-13 15:41:46 +00001012 for (const auto &I : RD->bases()) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001013
Benjamin Kramer273670a2013-10-25 07:40:50 +00001014 // Ignore virtual bases.
Aaron Ballman574705e2014-03-13 15:41:46 +00001015 if (I.isVirtual())
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001016 continue;
1017
Aaron Ballman574705e2014-03-13 15:41:46 +00001018 const CXXRecordDecl *BaseDecl = I.getType()->getAsCXXRecordDecl();
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001019
John McCall0153cd32011-11-08 04:01:03 +00001020 // Skip the primary base, because we've already laid it out. The
1021 // !PrimaryBaseIsVirtual check is required because we might have a
1022 // non-virtual base of the same type as a primary virtual base.
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001023 if (BaseDecl == PrimaryBase && !PrimaryBaseIsVirtual)
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001024 continue;
1025
1026 // Lay out the base.
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001027 BaseSubobjectInfo *BaseInfo = NonVirtualBaseInfo.lookup(BaseDecl);
1028 assert(BaseInfo && "Did not find base info for non-virtual base!");
1029
1030 LayoutNonVirtualBase(BaseInfo);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001031 }
1032}
1033
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001034void RecordLayoutBuilder::LayoutNonVirtualBase(const BaseSubobjectInfo *Base) {
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001035 // Layout the base.
Anders Carlssona2f8e412010-10-31 22:20:42 +00001036 CharUnits Offset = LayoutBase(Base);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001037
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001038 // Add its base class offset.
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001039 assert(!Bases.count(Base->Class) && "base offset already exists!");
Anders Carlssona2f8e412010-10-31 22:20:42 +00001040 Bases.insert(std::make_pair(Base->Class, Offset));
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001041
1042 AddPrimaryVirtualBaseOffsets(Base, Offset);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001043}
Mike Stump2b84dd32009-11-05 04:02:15 +00001044
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001045void
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001046RecordLayoutBuilder::AddPrimaryVirtualBaseOffsets(const BaseSubobjectInfo *Info,
Anders Carlssona2f8e412010-10-31 22:20:42 +00001047 CharUnits Offset) {
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001048 // This base isn't interesting, it has no virtual bases.
1049 if (!Info->Class->getNumVBases())
1050 return;
1051
1052 // First, check if we have a virtual primary base to add offsets for.
1053 if (Info->PrimaryVirtualBaseInfo) {
1054 assert(Info->PrimaryVirtualBaseInfo->IsVirtual &&
1055 "Primary virtual base is not virtual!");
1056 if (Info->PrimaryVirtualBaseInfo->Derived == Info) {
1057 // Add the offset.
1058 assert(!VBases.count(Info->PrimaryVirtualBaseInfo->Class) &&
1059 "primary vbase offset already exists!");
1060 VBases.insert(std::make_pair(Info->PrimaryVirtualBaseInfo->Class,
John McCalle42a3362012-05-01 08:55:32 +00001061 ASTRecordLayout::VBaseInfo(Offset, false)));
Anders Carlssonea7b1822010-04-15 16:12:58 +00001062
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001063 // Traverse the primary virtual base.
1064 AddPrimaryVirtualBaseOffsets(Info->PrimaryVirtualBaseInfo, Offset);
1065 }
Anders Carlssonea7b1822010-04-15 16:12:58 +00001066 }
1067
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001068 // Now go through all direct non-virtual bases.
1069 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Info->Class);
David Majnemerc964b4b2014-07-16 06:04:00 +00001070 for (const BaseSubobjectInfo *Base : Info->Bases) {
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001071 if (Base->IsVirtual)
Anders Carlssonea7b1822010-04-15 16:12:58 +00001072 continue;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001073
Anders Carlsson0a14ee92010-11-01 00:21:58 +00001074 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base->Class);
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001075 AddPrimaryVirtualBaseOffsets(Base, BaseOffset);
Anders Carlssonea7b1822010-04-15 16:12:58 +00001076 }
1077}
1078
1079void
Anders Carlssonc2226202010-05-26 05:58:59 +00001080RecordLayoutBuilder::LayoutVirtualBases(const CXXRecordDecl *RD,
Anders Carlssonea7b1822010-04-15 16:12:58 +00001081 const CXXRecordDecl *MostDerivedClass) {
Anders Carlssonde710c92010-03-11 04:33:54 +00001082 const CXXRecordDecl *PrimaryBase;
Anders Carlsson291279e2010-04-10 18:42:27 +00001083 bool PrimaryBaseIsVirtual;
Anders Carlssonfe900962010-03-11 05:42:17 +00001084
Anders Carlsson291279e2010-04-10 18:42:27 +00001085 if (MostDerivedClass == RD) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +00001086 PrimaryBase = this->PrimaryBase;
1087 PrimaryBaseIsVirtual = this->PrimaryBaseIsVirtual;
Anders Carlsson291279e2010-04-10 18:42:27 +00001088 } else {
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001089 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlssonde710c92010-03-11 04:33:54 +00001090 PrimaryBase = Layout.getPrimaryBase();
Anders Carlsson7f95cd12010-11-24 23:12:57 +00001091 PrimaryBaseIsVirtual = Layout.isPrimaryBaseVirtual();
Anders Carlsson291279e2010-04-10 18:42:27 +00001092 }
1093
David Majnemerc964b4b2014-07-16 06:04:00 +00001094 for (const CXXBaseSpecifier &Base : RD->bases()) {
1095 assert(!Base.getType()->isDependentType() &&
Sebastian Redl1054fae2009-10-25 17:03:50 +00001096 "Cannot layout class with dependent bases.");
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001097
David Majnemerc964b4b2014-07-16 06:04:00 +00001098 const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl();
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001099
David Majnemerc964b4b2014-07-16 06:04:00 +00001100 if (Base.isVirtual()) {
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001101 if (PrimaryBase != BaseDecl || !PrimaryBaseIsVirtual) {
1102 bool IndirectPrimaryBase = IndirectPrimaryBases.count(BaseDecl);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001103
Anders Carlsson291279e2010-04-10 18:42:27 +00001104 // Only lay out the virtual base if it's not an indirect primary base.
1105 if (!IndirectPrimaryBase) {
1106 // Only visit virtual bases once.
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001107 if (!VisitedVirtualBases.insert(BaseDecl))
Anders Carlsson291279e2010-04-10 18:42:27 +00001108 continue;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001109
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001110 const BaseSubobjectInfo *BaseInfo = VirtualBaseInfo.lookup(BaseDecl);
1111 assert(BaseInfo && "Did not find virtual base info!");
1112 LayoutVirtualBase(BaseInfo);
Anders Carlsson6a848892010-03-11 04:10:39 +00001113 }
Mike Stump2b84dd32009-11-05 04:02:15 +00001114 }
Mike Stumpc2f591b2009-08-13 22:53:07 +00001115 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001116
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001117 if (!BaseDecl->getNumVBases()) {
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001118 // This base isn't interesting since it doesn't have any virtual bases.
1119 continue;
Mike Stump996576f32009-08-16 19:04:13 +00001120 }
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001121
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001122 LayoutVirtualBases(BaseDecl, MostDerivedClass);
Mike Stump6b2556f2009-08-06 13:41:24 +00001123 }
1124}
1125
Warren Hunt55d8e822013-10-23 23:53:07 +00001126void RecordLayoutBuilder::LayoutVirtualBase(const BaseSubobjectInfo *Base) {
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001127 assert(!Base->Derived && "Trying to lay out a primary virtual base!");
1128
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001129 // Layout the base.
Anders Carlssona2f8e412010-10-31 22:20:42 +00001130 CharUnits Offset = LayoutBase(Base);
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001131
1132 // Add its base class offset.
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001133 assert(!VBases.count(Base->Class) && "vbase offset already exists!");
John McCalle42a3362012-05-01 08:55:32 +00001134 VBases.insert(std::make_pair(Base->Class,
Warren Hunt55d8e822013-10-23 23:53:07 +00001135 ASTRecordLayout::VBaseInfo(Offset, false)));
John McCalle42a3362012-05-01 08:55:32 +00001136
Warren Hunt55d8e822013-10-23 23:53:07 +00001137 AddPrimaryVirtualBaseOffsets(Base, Offset);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001138}
1139
Anders Carlssona2f8e412010-10-31 22:20:42 +00001140CharUnits RecordLayoutBuilder::LayoutBase(const BaseSubobjectInfo *Base) {
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001141 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Base->Class);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001142
Douglas Gregore9fc3772012-01-26 07:55:45 +00001143
1144 CharUnits Offset;
1145
1146 // Query the external layout to see if it provides an offset.
1147 bool HasExternalLayout = false;
1148 if (ExternalLayout) {
1149 llvm::DenseMap<const CXXRecordDecl *, CharUnits>::iterator Known;
1150 if (Base->IsVirtual) {
1151 Known = ExternalVirtualBaseOffsets.find(Base->Class);
1152 if (Known != ExternalVirtualBaseOffsets.end()) {
1153 Offset = Known->second;
1154 HasExternalLayout = true;
1155 }
1156 } else {
1157 Known = ExternalBaseOffsets.find(Base->Class);
1158 if (Known != ExternalBaseOffsets.end()) {
1159 Offset = Known->second;
1160 HasExternalLayout = true;
1161 }
1162 }
1163 }
1164
Warren Huntd640d7d2014-01-09 00:30:56 +00001165 CharUnits UnpackedBaseAlign = Layout.getNonVirtualAlignment();
Eli Friedman69d27d22013-07-16 00:21:28 +00001166 CharUnits BaseAlign = (Packed) ? CharUnits::One() : UnpackedBaseAlign;
1167
Anders Carlsson09ffa322010-03-10 22:21:28 +00001168 // If we have an empty base class, try to place it at offset 0.
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001169 if (Base->Class->isEmpty() &&
Douglas Gregore9fc3772012-01-26 07:55:45 +00001170 (!HasExternalLayout || Offset == CharUnits::Zero()) &&
Anders Carlsson28466ab2010-10-31 22:13:23 +00001171 EmptySubobjects->CanPlaceBaseAtOffset(Base, CharUnits::Zero())) {
Ken Dyck1b4420e2011-02-28 02:01:38 +00001172 setSize(std::max(getSize(), Layout.getSize()));
Eli Friedman69d27d22013-07-16 00:21:28 +00001173 UpdateAlignment(BaseAlign, UnpackedBaseAlign);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001174
Anders Carlssona2f8e412010-10-31 22:20:42 +00001175 return CharUnits::Zero();
Anders Carlsson09ffa322010-03-10 22:21:28 +00001176 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001177
Argyrios Kyrtzidis8b542742010-12-09 00:35:20 +00001178 // The maximum field alignment overrides base align.
Ken Dyck02ced6f2011-02-17 01:49:42 +00001179 if (!MaxFieldAlignment.isZero()) {
Ken Dyck85ef0432011-02-19 18:58:07 +00001180 BaseAlign = std::min(BaseAlign, MaxFieldAlignment);
1181 UnpackedBaseAlign = std::min(UnpackedBaseAlign, MaxFieldAlignment);
Argyrios Kyrtzidis8b542742010-12-09 00:35:20 +00001182 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001183
Douglas Gregore9fc3772012-01-26 07:55:45 +00001184 if (!HasExternalLayout) {
1185 // Round up the current record size to the base's alignment boundary.
1186 Offset = getDataSize().RoundUpToAlignment(BaseAlign);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001187
Douglas Gregore9fc3772012-01-26 07:55:45 +00001188 // Try to place the base.
1189 while (!EmptySubobjects->CanPlaceBaseAtOffset(Base, Offset))
1190 Offset += BaseAlign;
1191 } else {
1192 bool Allowed = EmptySubobjects->CanPlaceBaseAtOffset(Base, Offset);
1193 (void)Allowed;
1194 assert(Allowed && "Base subobject externally placed at overlapping offset");
Douglas Gregor1423a5c2012-10-26 22:31:14 +00001195
1196 if (InferAlignment && Offset < getDataSize().RoundUpToAlignment(BaseAlign)){
1197 // The externally-supplied base offset is before the base offset we
1198 // computed. Assume that the structure is packed.
1199 Alignment = CharUnits::One();
1200 InferAlignment = false;
1201 }
Douglas Gregore9fc3772012-01-26 07:55:45 +00001202 }
1203
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001204 if (!Base->Class->isEmpty()) {
Anders Carlsson09ffa322010-03-10 22:21:28 +00001205 // Update the data size.
Ken Dyck1b4420e2011-02-28 02:01:38 +00001206 setDataSize(Offset + Layout.getNonVirtualSize());
Anders Carlsson09ffa322010-03-10 22:21:28 +00001207
Ken Dyck1b4420e2011-02-28 02:01:38 +00001208 setSize(std::max(getSize(), getDataSize()));
Anders Carlsson09ffa322010-03-10 22:21:28 +00001209 } else
Ken Dyck1b4420e2011-02-28 02:01:38 +00001210 setSize(std::max(getSize(), Offset + Layout.getSize()));
Anders Carlsson09ffa322010-03-10 22:21:28 +00001211
1212 // Remember max struct/class alignment.
Argyrios Kyrtzidis8b542742010-12-09 00:35:20 +00001213 UpdateAlignment(BaseAlign, UnpackedBaseAlign);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001214
Ken Dyck1b4420e2011-02-28 02:01:38 +00001215 return Offset;
Anders Carlsson09ffa322010-03-10 22:21:28 +00001216}
1217
Daniel Dunbar6da10982010-05-27 05:45:51 +00001218void RecordLayoutBuilder::InitializeLayout(const Decl *D) {
Eli Friedman9ee2d0472012-10-12 23:29:20 +00001219 if (const RecordDecl *RD = dyn_cast<RecordDecl>(D)) {
Daniel Dunbar6da10982010-05-27 05:45:51 +00001220 IsUnion = RD->isUnion();
Eli Friedman9ee2d0472012-10-12 23:29:20 +00001221 IsMsStruct = RD->isMsStruct(Context);
1222 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001223
Eli Friedman9ee2d0472012-10-12 23:29:20 +00001224 Packed = D->hasAttr<PackedAttr>();
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001225
Daniel Dunbar096ed292011-10-05 21:04:55 +00001226 // Honor the default struct packing maximum alignment flag.
David Blaikiebbafb8a2012-03-11 07:00:24 +00001227 if (unsigned DefaultMaxFieldAlignment = Context.getLangOpts().PackStruct) {
Daniel Dunbar096ed292011-10-05 21:04:55 +00001228 MaxFieldAlignment = CharUnits::fromQuantity(DefaultMaxFieldAlignment);
1229 }
1230
Daniel Dunbar6da10982010-05-27 05:45:51 +00001231 // mac68k alignment supersedes maximum field alignment and attribute aligned,
1232 // and forces all structures to have 2-byte alignment. The IBM docs on it
1233 // allude to additional (more complicated) semantics, especially with regard
1234 // to bit-fields, but gcc appears not to follow that.
1235 if (D->hasAttr<AlignMac68kAttr>()) {
1236 IsMac68kAlign = true;
Ken Dyck02ced6f2011-02-17 01:49:42 +00001237 MaxFieldAlignment = CharUnits::fromQuantity(2);
Ken Dyck4731d5b2011-02-16 02:05:21 +00001238 Alignment = CharUnits::fromQuantity(2);
Daniel Dunbar6da10982010-05-27 05:45:51 +00001239 } else {
1240 if (const MaxFieldAlignmentAttr *MFAA = D->getAttr<MaxFieldAlignmentAttr>())
Ken Dyck02ced6f2011-02-17 01:49:42 +00001241 MaxFieldAlignment = Context.toCharUnitsFromBits(MFAA->getAlignment());
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001242
Alexis Huntdcfba7b2010-08-18 23:23:40 +00001243 if (unsigned MaxAlign = D->getMaxAlignment())
Ken Dyck85ef0432011-02-19 18:58:07 +00001244 UpdateAlignment(Context.toCharUnitsFromBits(MaxAlign));
Daniel Dunbar6da10982010-05-27 05:45:51 +00001245 }
Douglas Gregore9fc3772012-01-26 07:55:45 +00001246
1247 // If there is an external AST source, ask it for the various offsets.
1248 if (const RecordDecl *RD = dyn_cast<RecordDecl>(D))
1249 if (ExternalASTSource *External = Context.getExternalSource()) {
1250 ExternalLayout = External->layoutRecordType(RD,
1251 ExternalSize,
1252 ExternalAlign,
1253 ExternalFieldOffsets,
1254 ExternalBaseOffsets,
1255 ExternalVirtualBaseOffsets);
1256
1257 // Update based on external alignment.
1258 if (ExternalLayout) {
Douglas Gregor44ba7892012-01-28 00:53:29 +00001259 if (ExternalAlign > 0) {
1260 Alignment = Context.toCharUnitsFromBits(ExternalAlign);
Douglas Gregor44ba7892012-01-28 00:53:29 +00001261 } else {
1262 // The external source didn't have alignment information; infer it.
1263 InferAlignment = true;
1264 }
Douglas Gregore9fc3772012-01-26 07:55:45 +00001265 }
1266 }
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001267}
Anders Carlsson6d9f6f32009-07-19 00:18:47 +00001268
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001269void RecordLayoutBuilder::Layout(const RecordDecl *D) {
1270 InitializeLayout(D);
Anders Carlsson118ce162009-07-18 21:48:39 +00001271 LayoutFields(D);
Mike Stump11289f42009-09-09 15:08:12 +00001272
Anders Carlsson79474332009-07-18 20:20:21 +00001273 // Finally, round the size of the total struct up to the alignment of the
1274 // struct itself.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001275 FinishLayout(D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001276}
1277
1278void RecordLayoutBuilder::Layout(const CXXRecordDecl *RD) {
1279 InitializeLayout(RD);
1280
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001281 // Lay out the vtable and the non-virtual bases.
1282 LayoutNonVirtualBases(RD);
1283
1284 LayoutFields(RD);
1285
Ken Dycke7380752011-03-10 01:53:59 +00001286 NonVirtualSize = Context.toCharUnitsFromBits(
1287 llvm::RoundUpToAlignment(getSizeInBits(),
Douglas Gregore8bbc122011-09-02 00:18:52 +00001288 Context.getTargetInfo().getCharAlign()));
Ken Dyck4731d5b2011-02-16 02:05:21 +00001289 NonVirtualAlignment = Alignment;
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001290
Warren Hunt55d8e822013-10-23 23:53:07 +00001291 // Lay out the virtual bases and add the primary virtual base offsets.
1292 LayoutVirtualBases(RD, RD);
John McCall0153cd32011-11-08 04:01:03 +00001293
1294 // Finally, round the size of the total struct up to the alignment
Eli Friedman83a12582011-12-01 00:37:01 +00001295 // of the struct itself.
1296 FinishLayout(RD);
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001297
Anders Carlsson5b441d72010-04-10 21:24:48 +00001298#ifndef NDEBUG
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001299 // Check that we have base offsets for all bases.
David Majnemerc964b4b2014-07-16 06:04:00 +00001300 for (const CXXBaseSpecifier &Base : RD->bases()) {
1301 if (Base.isVirtual())
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001302 continue;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001303
David Majnemerc964b4b2014-07-16 06:04:00 +00001304 const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl();
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001305
1306 assert(Bases.count(BaseDecl) && "Did not find base offset!");
1307 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001308
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001309 // And all virtual bases.
David Majnemerc964b4b2014-07-16 06:04:00 +00001310 for (const CXXBaseSpecifier &Base : RD->vbases()) {
1311 const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl();
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001312
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001313 assert(VBases.count(BaseDecl) && "Did not find base offset!");
Anders Carlsson5b441d72010-04-10 21:24:48 +00001314 }
1315#endif
Anders Carlsson79474332009-07-18 20:20:21 +00001316}
1317
Anders Carlssonc2226202010-05-26 05:58:59 +00001318void RecordLayoutBuilder::Layout(const ObjCInterfaceDecl *D) {
Anders Carlsson4f516282009-07-18 20:50:59 +00001319 if (ObjCInterfaceDecl *SD = D->getSuperClass()) {
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001320 const ASTRecordLayout &SL = Context.getASTObjCInterfaceLayout(SD);
Anders Carlsson4f516282009-07-18 20:50:59 +00001321
Ken Dyck85ef0432011-02-19 18:58:07 +00001322 UpdateAlignment(SL.getAlignment());
Mike Stump11289f42009-09-09 15:08:12 +00001323
Anders Carlsson4f516282009-07-18 20:50:59 +00001324 // We start laying out ivars not at the end of the superclass
1325 // structure, but at the next byte following the last field.
Ken Dyckecfc7552011-02-24 01:13:28 +00001326 setSize(SL.getDataSize());
Ken Dyck1b4420e2011-02-28 02:01:38 +00001327 setDataSize(getSize());
Anders Carlsson4f516282009-07-18 20:50:59 +00001328 }
Mike Stump11289f42009-09-09 15:08:12 +00001329
Daniel Dunbar6da10982010-05-27 05:45:51 +00001330 InitializeLayout(D);
Anders Carlsson4f516282009-07-18 20:50:59 +00001331 // Layout each ivar sequentially.
Jordy Rosea91768e2011-07-22 02:08:32 +00001332 for (const ObjCIvarDecl *IVD = D->all_declared_ivar_begin(); IVD;
1333 IVD = IVD->getNextIvar())
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00001334 LayoutField(IVD);
Mike Stump11289f42009-09-09 15:08:12 +00001335
Anders Carlsson4f516282009-07-18 20:50:59 +00001336 // Finally, round the size of the total struct up to the alignment of the
1337 // struct itself.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001338 FinishLayout(D);
Anders Carlsson4f516282009-07-18 20:50:59 +00001339}
1340
Anders Carlssonc2226202010-05-26 05:58:59 +00001341void RecordLayoutBuilder::LayoutFields(const RecordDecl *D) {
Anders Carlsson118ce162009-07-18 21:48:39 +00001342 // Layout each field, for now, just sequentially, respecting alignment. In
1343 // the future, this will need to be tweakable by targets.
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00001344 for (const auto *Field : D->fields())
1345 LayoutField(Field);
Anders Carlsson118ce162009-07-18 21:48:39 +00001346}
1347
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001348void RecordLayoutBuilder::LayoutWideBitField(uint64_t FieldSize,
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001349 uint64_t TypeSize,
1350 bool FieldPacked,
1351 const FieldDecl *D) {
David Blaikiebbafb8a2012-03-11 07:00:24 +00001352 assert(Context.getLangOpts().CPlusPlus &&
Anders Carlsson57235162010-04-16 15:57:11 +00001353 "Can only have wide bit-fields in C++!");
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001354
Anders Carlsson57235162010-04-16 15:57:11 +00001355 // Itanium C++ ABI 2.4:
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001356 // If sizeof(T)*8 < n, let T' be the largest integral POD type with
Anders Carlsson57235162010-04-16 15:57:11 +00001357 // sizeof(T')*8 <= n.
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001358
Anders Carlsson57235162010-04-16 15:57:11 +00001359 QualType IntegralPODTypes[] = {
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001360 Context.UnsignedCharTy, Context.UnsignedShortTy, Context.UnsignedIntTy,
Anders Carlsson57235162010-04-16 15:57:11 +00001361 Context.UnsignedLongTy, Context.UnsignedLongLongTy
1362 };
1363
Anders Carlsson57235162010-04-16 15:57:11 +00001364 QualType Type;
David Majnemerc964b4b2014-07-16 06:04:00 +00001365 for (const QualType &QT : IntegralPODTypes) {
1366 uint64_t Size = Context.getTypeSize(QT);
Anders Carlsson57235162010-04-16 15:57:11 +00001367
1368 if (Size > FieldSize)
1369 break;
1370
David Majnemerc964b4b2014-07-16 06:04:00 +00001371 Type = QT;
Anders Carlsson57235162010-04-16 15:57:11 +00001372 }
1373 assert(!Type.isNull() && "Did not find a type!");
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001374
Ken Dyckdbe37f32011-03-01 01:36:00 +00001375 CharUnits TypeAlign = Context.getTypeAlignInChars(Type);
Anders Carlsson57235162010-04-16 15:57:11 +00001376
1377 // We're not going to use any of the unfilled bits in the last byte.
Eli Friedman2782dac2013-06-26 20:50:34 +00001378 UnfilledBitsInLastUnit = 0;
1379 LastBitfieldTypeSize = 0;
Anders Carlsson57235162010-04-16 15:57:11 +00001380
Anders Carlssonaad5fa82010-04-17 20:21:41 +00001381 uint64_t FieldOffset;
Eli Friedman2782dac2013-06-26 20:50:34 +00001382 uint64_t UnpaddedFieldOffset = getDataSizeInBits() - UnfilledBitsInLastUnit;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001383
Anders Carlsson57235162010-04-16 15:57:11 +00001384 if (IsUnion) {
Ken Dyckecfc7552011-02-24 01:13:28 +00001385 setDataSize(std::max(getDataSizeInBits(), FieldSize));
Anders Carlssonaad5fa82010-04-17 20:21:41 +00001386 FieldOffset = 0;
Anders Carlsson57235162010-04-16 15:57:11 +00001387 } else {
Chad Rosiere1a6a0e2011-08-05 22:38:04 +00001388 // The bitfield is allocated starting at the next offset aligned
1389 // appropriately for T', with length n bits.
Ken Dyckdbe37f32011-03-01 01:36:00 +00001390 FieldOffset = llvm::RoundUpToAlignment(getDataSizeInBits(),
1391 Context.toBits(TypeAlign));
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001392
Anders Carlsson57235162010-04-16 15:57:11 +00001393 uint64_t NewSizeInBits = FieldOffset + FieldSize;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001394
Ken Dycka1a2e8d2011-03-10 02:00:35 +00001395 setDataSize(llvm::RoundUpToAlignment(NewSizeInBits,
Douglas Gregore8bbc122011-09-02 00:18:52 +00001396 Context.getTargetInfo().getCharAlign()));
Eli Friedman2782dac2013-06-26 20:50:34 +00001397 UnfilledBitsInLastUnit = getDataSizeInBits() - NewSizeInBits;
Anders Carlsson57235162010-04-16 15:57:11 +00001398 }
1399
1400 // Place this field at the current location.
1401 FieldOffsets.push_back(FieldOffset);
1402
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001403 CheckFieldPadding(FieldOffset, UnpaddedFieldOffset, FieldOffset,
Ken Dyckdbe37f32011-03-01 01:36:00 +00001404 Context.toBits(TypeAlign), FieldPacked, D);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001405
Anders Carlsson57235162010-04-16 15:57:11 +00001406 // Update the size.
Ken Dyckecfc7552011-02-24 01:13:28 +00001407 setSize(std::max(getSizeInBits(), getDataSizeInBits()));
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001408
Anders Carlsson57235162010-04-16 15:57:11 +00001409 // Remember max struct/class alignment.
Ken Dyckdbe37f32011-03-01 01:36:00 +00001410 UpdateAlignment(TypeAlign);
Anders Carlsson57235162010-04-16 15:57:11 +00001411}
1412
Anders Carlssonc2226202010-05-26 05:58:59 +00001413void RecordLayoutBuilder::LayoutBitField(const FieldDecl *D) {
Anders Carlsson07209442009-11-22 17:37:31 +00001414 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Richard Smithcaf33902011-10-10 18:28:20 +00001415 uint64_t FieldSize = D->getBitWidthValue(Context);
David Majnemer34b57492014-07-30 01:30:47 +00001416 TypeInfo FieldInfo = Context.getTypeInfo(D->getType());
1417 uint64_t TypeSize = FieldInfo.Width;
1418 unsigned FieldAlign = FieldInfo.Align;
Eli Friedman2782dac2013-06-26 20:50:34 +00001419
John McCall30268ca2014-01-29 07:53:44 +00001420 // UnfilledBitsInLastUnit is the difference between the end of the
1421 // last allocated bitfield (i.e. the first bit offset available for
1422 // bitfields) and the end of the current data size in bits (i.e. the
1423 // first bit offset available for non-bitfields). The current data
1424 // size in bits is always a multiple of the char size; additionally,
1425 // for ms_struct records it's also a multiple of the
1426 // LastBitfieldTypeSize (if set).
1427
John McCall76e1818a2014-02-13 00:50:08 +00001428 // The struct-layout algorithm is dictated by the platform ABI,
1429 // which in principle could use almost any rules it likes. In
1430 // practice, UNIXy targets tend to inherit the algorithm described
1431 // in the System V generic ABI. The basic bitfield layout rule in
1432 // System V is to place bitfields at the next available bit offset
1433 // where the entire bitfield would fit in an aligned storage unit of
1434 // the declared type; it's okay if an earlier or later non-bitfield
1435 // is allocated in the same storage unit. However, some targets
1436 // (those that !useBitFieldTypeAlignment(), e.g. ARM APCS) don't
1437 // require this storage unit to be aligned, and therefore always put
1438 // the bitfield at the next available bit offset.
John McCall30268ca2014-01-29 07:53:44 +00001439
John McCall76e1818a2014-02-13 00:50:08 +00001440 // ms_struct basically requests a complete replacement of the
1441 // platform ABI's struct-layout algorithm, with the high-level goal
1442 // of duplicating MSVC's layout. For non-bitfields, this follows
1443 // the the standard algorithm. The basic bitfield layout rule is to
1444 // allocate an entire unit of the bitfield's declared type
1445 // (e.g. 'unsigned long'), then parcel it up among successive
1446 // bitfields whose declared types have the same size, making a new
1447 // unit as soon as the last can no longer store the whole value.
1448 // Since it completely replaces the platform ABI's algorithm,
1449 // settings like !useBitFieldTypeAlignment() do not apply.
1450
1451 // A zero-width bitfield forces the use of a new storage unit for
1452 // later bitfields. In general, this occurs by rounding up the
1453 // current size of the struct as if the algorithm were about to
1454 // place a non-bitfield of the field's formal type. Usually this
1455 // does not change the alignment of the struct itself, but it does
1456 // on some targets (those that useZeroLengthBitfieldAlignment(),
1457 // e.g. ARM). In ms_struct layout, zero-width bitfields are
1458 // ignored unless they follow a non-zero-width bitfield.
1459
1460 // A field alignment restriction (e.g. from #pragma pack) or
1461 // specification (e.g. from __attribute__((aligned))) changes the
1462 // formal alignment of the field. For System V, this alters the
1463 // required alignment of the notional storage unit that must contain
1464 // the bitfield. For ms_struct, this only affects the placement of
1465 // new storage units. In both cases, the effect of #pragma pack is
1466 // ignored on zero-width bitfields.
1467
1468 // On System V, a packed field (e.g. from #pragma pack or
1469 // __attribute__((packed))) always uses the next available bit
1470 // offset.
1471
John McCall95833f32014-02-27 20:30:49 +00001472 // In an ms_struct struct, the alignment of a fundamental type is
1473 // always equal to its size. This is necessary in order to mimic
1474 // the i386 alignment rules on targets which might not fully align
1475 // all types (e.g. Darwin PPC32, where alignof(long long) == 4).
John McCall30268ca2014-01-29 07:53:44 +00001476
1477 // First, some simple bookkeeping to perform for ms_struct structs.
Eli Friedman2782dac2013-06-26 20:50:34 +00001478 if (IsMsStruct) {
John McCall30268ca2014-01-29 07:53:44 +00001479 // The field alignment for integer types is always the size.
Fariborz Jahanian7adbed62011-05-09 22:03:17 +00001480 FieldAlign = TypeSize;
John McCall30268ca2014-01-29 07:53:44 +00001481
1482 // If the previous field was not a bitfield, or was a bitfield
1483 // with a different storage unit size, we're done with that
1484 // storage unit.
Eli Friedman2782dac2013-06-26 20:50:34 +00001485 if (LastBitfieldTypeSize != TypeSize) {
John McCall30268ca2014-01-29 07:53:44 +00001486 // Also, ignore zero-length bitfields after non-bitfields.
1487 if (!LastBitfieldTypeSize && !FieldSize)
1488 FieldAlign = 1;
1489
Eli Friedman2782dac2013-06-26 20:50:34 +00001490 UnfilledBitsInLastUnit = 0;
1491 LastBitfieldTypeSize = 0;
1492 }
1493 }
1494
John McCall30268ca2014-01-29 07:53:44 +00001495 // If the field is wider than its declared type, it follows
1496 // different rules in all cases.
Anders Carlsson57235162010-04-16 15:57:11 +00001497 if (FieldSize > TypeSize) {
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001498 LayoutWideBitField(FieldSize, TypeSize, FieldPacked, D);
Anders Carlsson57235162010-04-16 15:57:11 +00001499 return;
1500 }
1501
John McCall30268ca2014-01-29 07:53:44 +00001502 // Compute the next available bit offset.
1503 uint64_t FieldOffset =
1504 IsUnion ? 0 : (getDataSizeInBits() - UnfilledBitsInLastUnit);
1505
1506 // Handle targets that don't honor bitfield type alignment.
John McCall76e1818a2014-02-13 00:50:08 +00001507 if (!IsMsStruct && !Context.getTargetInfo().useBitFieldTypeAlignment()) {
John McCall30268ca2014-01-29 07:53:44 +00001508 // Some such targets do honor it on zero-width bitfields.
1509 if (FieldSize == 0 &&
1510 Context.getTargetInfo().useZeroLengthBitfieldAlignment()) {
1511 // The alignment to round up to is the max of the field's natural
1512 // alignment and a target-specific fixed value (sometimes zero).
1513 unsigned ZeroLengthBitfieldBoundary =
1514 Context.getTargetInfo().getZeroLengthBitfieldBoundary();
1515 FieldAlign = std::max(FieldAlign, ZeroLengthBitfieldBoundary);
1516
1517 // If that doesn't apply, just ignore the field alignment.
1518 } else {
1519 FieldAlign = 1;
1520 }
1521 }
1522
1523 // Remember the alignment we would have used if the field were not packed.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001524 unsigned UnpackedFieldAlign = FieldAlign;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001525
Yunzhong Gao5fd0c9d2014-02-13 02:45:10 +00001526 // Ignore the field alignment if the field is packed unless it has zero-size.
1527 if (!IsMsStruct && FieldPacked && FieldSize != 0)
Anders Carlsson07209442009-11-22 17:37:31 +00001528 FieldAlign = 1;
Anders Carlsson07209442009-11-22 17:37:31 +00001529
John McCall30268ca2014-01-29 07:53:44 +00001530 // But, if there's an 'aligned' attribute on the field, honor that.
1531 if (unsigned ExplicitFieldAlign = D->getMaxAlignment()) {
1532 FieldAlign = std::max(FieldAlign, ExplicitFieldAlign);
1533 UnpackedFieldAlign = std::max(UnpackedFieldAlign, ExplicitFieldAlign);
1534 }
1535
1536 // But, if there's a #pragma pack in play, that takes precedent over
1537 // even the 'aligned' attribute, for non-zero-width bitfields.
1538 if (!MaxFieldAlignment.isZero() && FieldSize) {
Ken Dyck02ced6f2011-02-17 01:49:42 +00001539 unsigned MaxFieldAlignmentInBits = Context.toBits(MaxFieldAlignment);
1540 FieldAlign = std::min(FieldAlign, MaxFieldAlignmentInBits);
1541 UnpackedFieldAlign = std::min(UnpackedFieldAlign, MaxFieldAlignmentInBits);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001542 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001543
John McCall30268ca2014-01-29 07:53:44 +00001544 // For purposes of diagnostics, we're going to simultaneously
1545 // compute the field offsets that we would have used if we weren't
1546 // adding any alignment padding or if the field weren't packed.
1547 uint64_t UnpaddedFieldOffset = FieldOffset;
1548 uint64_t UnpackedFieldOffset = FieldOffset;
1549
1550 // Check if we need to add padding to fit the bitfield within an
1551 // allocation unit with the right size and alignment. The rules are
1552 // somewhat different here for ms_struct structs.
1553 if (IsMsStruct) {
1554 // If it's not a zero-width bitfield, and we can fit the bitfield
1555 // into the active storage unit (and we haven't already decided to
1556 // start a new storage unit), just do so, regardless of any other
1557 // other consideration. Otherwise, round up to the right alignment.
1558 if (FieldSize == 0 || FieldSize > UnfilledBitsInLastUnit) {
1559 FieldOffset = llvm::RoundUpToAlignment(FieldOffset, FieldAlign);
1560 UnpackedFieldOffset = llvm::RoundUpToAlignment(UnpackedFieldOffset,
1561 UnpackedFieldAlign);
1562 UnfilledBitsInLastUnit = 0;
1563 }
1564
1565 } else {
1566 // #pragma pack, with any value, suppresses the insertion of padding.
1567 bool AllowPadding = MaxFieldAlignment.isZero();
1568
1569 // Compute the real offset.
1570 if (FieldSize == 0 ||
1571 (AllowPadding &&
1572 (FieldOffset & (FieldAlign-1)) + FieldSize > TypeSize)) {
1573 FieldOffset = llvm::RoundUpToAlignment(FieldOffset, FieldAlign);
1574 }
1575
1576 // Repeat the computation for diagnostic purposes.
1577 if (FieldSize == 0 ||
1578 (AllowPadding &&
1579 (UnpackedFieldOffset & (UnpackedFieldAlign-1)) + FieldSize > TypeSize))
1580 UnpackedFieldOffset = llvm::RoundUpToAlignment(UnpackedFieldOffset,
1581 UnpackedFieldAlign);
Eli Friedman2782dac2013-06-26 20:50:34 +00001582 }
1583
John McCall30268ca2014-01-29 07:53:44 +00001584 // If we're using external layout, give the external layout a chance
1585 // to override this information.
Douglas Gregor44ba7892012-01-28 00:53:29 +00001586 if (ExternalLayout)
1587 FieldOffset = updateExternalFieldOffset(D, FieldOffset);
1588
John McCall30268ca2014-01-29 07:53:44 +00001589 // Okay, place the bitfield at the calculated offset.
Anders Carlsson07209442009-11-22 17:37:31 +00001590 FieldOffsets.push_back(FieldOffset);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001591
John McCall30268ca2014-01-29 07:53:44 +00001592 // Bookkeeping:
1593
1594 // Anonymous members don't affect the overall record alignment,
1595 // except on targets where they do.
1596 if (!IsMsStruct &&
1597 !Context.getTargetInfo().useZeroLengthBitfieldAlignment() &&
1598 !D->getIdentifier())
1599 FieldAlign = UnpackedFieldAlign = 1;
1600
1601 // Diagnose differences in layout due to padding or packing.
Douglas Gregore9fc3772012-01-26 07:55:45 +00001602 if (!ExternalLayout)
1603 CheckFieldPadding(FieldOffset, UnpaddedFieldOffset, UnpackedFieldOffset,
1604 UnpackedFieldAlign, FieldPacked, D);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001605
Anders Carlssonba958402009-11-22 19:13:51 +00001606 // Update DataSize to include the last byte containing (part of) the bitfield.
John McCall30268ca2014-01-29 07:53:44 +00001607
1608 // For unions, this is just a max operation, as usual.
Anders Carlssonba958402009-11-22 19:13:51 +00001609 if (IsUnion) {
1610 // FIXME: I think FieldSize should be TypeSize here.
Ken Dyckecfc7552011-02-24 01:13:28 +00001611 setDataSize(std::max(getDataSizeInBits(), FieldSize));
John McCall30268ca2014-01-29 07:53:44 +00001612
1613 // For non-zero-width bitfields in ms_struct structs, allocate a new
1614 // storage unit if necessary.
1615 } else if (IsMsStruct && FieldSize) {
1616 // We should have cleared UnfilledBitsInLastUnit in every case
1617 // where we changed storage units.
1618 if (!UnfilledBitsInLastUnit) {
1619 setDataSize(FieldOffset + TypeSize);
1620 UnfilledBitsInLastUnit = TypeSize;
Eli Friedman2782dac2013-06-26 20:50:34 +00001621 }
John McCall30268ca2014-01-29 07:53:44 +00001622 UnfilledBitsInLastUnit -= FieldSize;
1623 LastBitfieldTypeSize = TypeSize;
1624
1625 // Otherwise, bump the data size up to include the bitfield,
1626 // including padding up to char alignment, and then remember how
1627 // bits we didn't use.
1628 } else {
1629 uint64_t NewSizeInBits = FieldOffset + FieldSize;
1630 uint64_t CharAlignment = Context.getTargetInfo().getCharAlign();
1631 setDataSize(llvm::RoundUpToAlignment(NewSizeInBits, CharAlignment));
1632 UnfilledBitsInLastUnit = getDataSizeInBits() - NewSizeInBits;
1633
1634 // The only time we can get here for an ms_struct is if this is a
1635 // zero-width bitfield, which doesn't count as anything for the
1636 // purposes of unfilled bits.
1637 LastBitfieldTypeSize = 0;
Anders Carlssonba958402009-11-22 19:13:51 +00001638 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001639
Anders Carlssonba958402009-11-22 19:13:51 +00001640 // Update the size.
Ken Dyckecfc7552011-02-24 01:13:28 +00001641 setSize(std::max(getSizeInBits(), getDataSizeInBits()));
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001642
Anders Carlsson07209442009-11-22 17:37:31 +00001643 // Remember max struct/class alignment.
Ken Dyck85ef0432011-02-19 18:58:07 +00001644 UpdateAlignment(Context.toCharUnitsFromBits(FieldAlign),
1645 Context.toCharUnitsFromBits(UnpackedFieldAlign));
Anders Carlsson07209442009-11-22 17:37:31 +00001646}
1647
Douglas Gregore9fc3772012-01-26 07:55:45 +00001648void RecordLayoutBuilder::LayoutField(const FieldDecl *D) {
Anders Carlsson07209442009-11-22 17:37:31 +00001649 if (D->isBitField()) {
1650 LayoutBitField(D);
1651 return;
1652 }
1653
Eli Friedman2782dac2013-06-26 20:50:34 +00001654 uint64_t UnpaddedFieldOffset = getDataSizeInBits() - UnfilledBitsInLastUnit;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001655
Anders Carlssonba958402009-11-22 19:13:51 +00001656 // Reset the unfilled bits.
Eli Friedman2782dac2013-06-26 20:50:34 +00001657 UnfilledBitsInLastUnit = 0;
1658 LastBitfieldTypeSize = 0;
Anders Carlssonba958402009-11-22 19:13:51 +00001659
Anders Carlsson07209442009-11-22 17:37:31 +00001660 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Ken Dyck6d90e892011-02-20 02:06:09 +00001661 CharUnits FieldOffset =
Ken Dyckecfc7552011-02-24 01:13:28 +00001662 IsUnion ? CharUnits::Zero() : getDataSize();
Ken Dyck6d90e892011-02-20 02:06:09 +00001663 CharUnits FieldSize;
1664 CharUnits FieldAlign;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001665
Anders Carlsson07209442009-11-22 17:37:31 +00001666 if (D->getType()->isIncompleteArrayType()) {
1667 // This is a flexible array member; we can't directly
1668 // query getTypeInfo about these, so we figure it out here.
1669 // Flexible array members don't have any size, but they
1670 // have to be aligned appropriately for their element type.
Ken Dyck6d90e892011-02-20 02:06:09 +00001671 FieldSize = CharUnits::Zero();
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001672 const ArrayType* ATy = Context.getAsArrayType(D->getType());
Ken Dyck6d90e892011-02-20 02:06:09 +00001673 FieldAlign = Context.getTypeAlignInChars(ATy->getElementType());
Anders Carlsson07209442009-11-22 17:37:31 +00001674 } else if (const ReferenceType *RT = D->getType()->getAs<ReferenceType>()) {
1675 unsigned AS = RT->getPointeeType().getAddressSpace();
Ken Dyck6d90e892011-02-20 02:06:09 +00001676 FieldSize =
Douglas Gregore8bbc122011-09-02 00:18:52 +00001677 Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerWidth(AS));
Ken Dyck6d90e892011-02-20 02:06:09 +00001678 FieldAlign =
Douglas Gregore8bbc122011-09-02 00:18:52 +00001679 Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerAlign(AS));
Anders Carlsson79474332009-07-18 20:20:21 +00001680 } else {
Ken Dyck6d90e892011-02-20 02:06:09 +00001681 std::pair<CharUnits, CharUnits> FieldInfo =
1682 Context.getTypeInfoInChars(D->getType());
Anders Carlsson07209442009-11-22 17:37:31 +00001683 FieldSize = FieldInfo.first;
1684 FieldAlign = FieldInfo.second;
Chad Rosier18903ee2011-08-04 01:21:14 +00001685
Eli Friedman9ee2d0472012-10-12 23:29:20 +00001686 if (IsMsStruct) {
Douglas Gregordbe39272011-02-01 15:15:22 +00001687 // If MS bitfield layout is required, figure out what type is being
1688 // laid out and align the field to the width of that type.
1689
1690 // Resolve all typedefs down to their base type and round up the field
1691 // alignment if necessary.
1692 QualType T = Context.getBaseElementType(D->getType());
1693 if (const BuiltinType *BTy = T->getAs<BuiltinType>()) {
Ken Dyck6d90e892011-02-20 02:06:09 +00001694 CharUnits TypeSize = Context.getTypeSizeInChars(BTy);
Douglas Gregordbe39272011-02-01 15:15:22 +00001695 if (TypeSize > FieldAlign)
1696 FieldAlign = TypeSize;
1697 }
1698 }
Anders Carlsson79474332009-07-18 20:20:21 +00001699 }
Mike Stump11289f42009-09-09 15:08:12 +00001700
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001701 // The align if the field is not packed. This is to check if the attribute
1702 // was unnecessary (-Wpacked).
Ken Dyck6d90e892011-02-20 02:06:09 +00001703 CharUnits UnpackedFieldAlign = FieldAlign;
1704 CharUnits UnpackedFieldOffset = FieldOffset;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001705
Anders Carlsson07209442009-11-22 17:37:31 +00001706 if (FieldPacked)
Ken Dyck6d90e892011-02-20 02:06:09 +00001707 FieldAlign = CharUnits::One();
1708 CharUnits MaxAlignmentInChars =
1709 Context.toCharUnitsFromBits(D->getMaxAlignment());
1710 FieldAlign = std::max(FieldAlign, MaxAlignmentInChars);
1711 UnpackedFieldAlign = std::max(UnpackedFieldAlign, MaxAlignmentInChars);
Anders Carlsson07209442009-11-22 17:37:31 +00001712
1713 // The maximum field alignment overrides the aligned attribute.
Ken Dyck02ced6f2011-02-17 01:49:42 +00001714 if (!MaxFieldAlignment.isZero()) {
Ken Dyck6d90e892011-02-20 02:06:09 +00001715 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
1716 UnpackedFieldAlign = std::min(UnpackedFieldAlign, MaxFieldAlignment);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001717 }
Anders Carlsson07209442009-11-22 17:37:31 +00001718
Douglas Gregor44ba7892012-01-28 00:53:29 +00001719 // Round up the current record size to the field's alignment boundary.
1720 FieldOffset = FieldOffset.RoundUpToAlignment(FieldAlign);
1721 UnpackedFieldOffset =
1722 UnpackedFieldOffset.RoundUpToAlignment(UnpackedFieldAlign);
1723
1724 if (ExternalLayout) {
1725 FieldOffset = Context.toCharUnitsFromBits(
1726 updateExternalFieldOffset(D, Context.toBits(FieldOffset)));
1727
1728 if (!IsUnion && EmptySubobjects) {
1729 // Record the fact that we're placing a field at this offset.
1730 bool Allowed = EmptySubobjects->CanPlaceFieldAtOffset(D, FieldOffset);
1731 (void)Allowed;
1732 assert(Allowed && "Externally-placed field cannot be placed here");
1733 }
1734 } else {
Douglas Gregore9fc3772012-01-26 07:55:45 +00001735 if (!IsUnion && EmptySubobjects) {
1736 // Check if we can place the field at this offset.
1737 while (!EmptySubobjects->CanPlaceFieldAtOffset(D, FieldOffset)) {
1738 // We couldn't place the field at the offset. Try again at a new offset.
1739 FieldOffset += FieldAlign;
1740 }
Anders Carlsson07209442009-11-22 17:37:31 +00001741 }
Anders Carlsson07209442009-11-22 17:37:31 +00001742 }
Douglas Gregore9fc3772012-01-26 07:55:45 +00001743
Anders Carlsson79474332009-07-18 20:20:21 +00001744 // Place this field at the current location.
Ken Dyck6d90e892011-02-20 02:06:09 +00001745 FieldOffsets.push_back(Context.toBits(FieldOffset));
Mike Stump11289f42009-09-09 15:08:12 +00001746
Douglas Gregore9fc3772012-01-26 07:55:45 +00001747 if (!ExternalLayout)
1748 CheckFieldPadding(Context.toBits(FieldOffset), UnpaddedFieldOffset,
1749 Context.toBits(UnpackedFieldOffset),
1750 Context.toBits(UnpackedFieldAlign), FieldPacked, D);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001751
Anders Carlsson79474332009-07-18 20:20:21 +00001752 // Reserve space for this field.
Eli Friedman43f18342012-01-12 23:27:03 +00001753 uint64_t FieldSizeInBits = Context.toBits(FieldSize);
Anders Carlsson79474332009-07-18 20:20:21 +00001754 if (IsUnion)
Eli Friedman2e108372012-01-12 23:48:56 +00001755 setDataSize(std::max(getDataSizeInBits(), FieldSizeInBits));
Anders Carlsson79474332009-07-18 20:20:21 +00001756 else
Eli Friedman2e108372012-01-12 23:48:56 +00001757 setDataSize(FieldOffset + FieldSize);
Mike Stump11289f42009-09-09 15:08:12 +00001758
Eli Friedman2e108372012-01-12 23:48:56 +00001759 // Update the size.
1760 setSize(std::max(getSizeInBits(), getDataSizeInBits()));
Mike Stump11289f42009-09-09 15:08:12 +00001761
Anders Carlsson79474332009-07-18 20:20:21 +00001762 // Remember max struct/class alignment.
Ken Dyck6d90e892011-02-20 02:06:09 +00001763 UpdateAlignment(FieldAlign, UnpackedFieldAlign);
Anders Carlsson79474332009-07-18 20:20:21 +00001764}
1765
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001766void RecordLayoutBuilder::FinishLayout(const NamedDecl *D) {
Anders Carlsson79474332009-07-18 20:20:21 +00001767 // In C++, records cannot be of size 0.
David Blaikiebbafb8a2012-03-11 07:00:24 +00001768 if (Context.getLangOpts().CPlusPlus && getSizeInBits() == 0) {
Fariborz Jahanian09b23312011-02-02 19:36:18 +00001769 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
1770 // Compatibility with gcc requires a class (pod or non-pod)
1771 // which is not empty but of size 0; such as having fields of
1772 // array of zero-length, remains of Size 0
1773 if (RD->isEmpty())
Ken Dyck1b4420e2011-02-28 02:01:38 +00001774 setSize(CharUnits::One());
Fariborz Jahanian09b23312011-02-02 19:36:18 +00001775 }
1776 else
Ken Dyck1b4420e2011-02-28 02:01:38 +00001777 setSize(CharUnits::One());
Fariborz Jahanian09b23312011-02-02 19:36:18 +00001778 }
Eli Friedman83a12582011-12-01 00:37:01 +00001779
Douglas Gregor1423a5c2012-10-26 22:31:14 +00001780 // Finally, round the size of the record up to the alignment of the
1781 // record itself.
Eli Friedman2782dac2013-06-26 20:50:34 +00001782 uint64_t UnpaddedSize = getSizeInBits() - UnfilledBitsInLastUnit;
Douglas Gregor1423a5c2012-10-26 22:31:14 +00001783 uint64_t UnpackedSizeInBits =
1784 llvm::RoundUpToAlignment(getSizeInBits(),
1785 Context.toBits(UnpackedAlignment));
1786 CharUnits UnpackedSize = Context.toCharUnitsFromBits(UnpackedSizeInBits);
1787 uint64_t RoundedSize
1788 = llvm::RoundUpToAlignment(getSizeInBits(), Context.toBits(Alignment));
1789
1790 if (ExternalLayout) {
1791 // If we're inferring alignment, and the external size is smaller than
1792 // our size after we've rounded up to alignment, conservatively set the
1793 // alignment to 1.
1794 if (InferAlignment && ExternalSize < RoundedSize) {
1795 Alignment = CharUnits::One();
1796 InferAlignment = false;
1797 }
1798 setSize(ExternalSize);
1799 return;
1800 }
1801
Douglas Gregor1423a5c2012-10-26 22:31:14 +00001802 // Set the size to the final size.
1803 setSize(RoundedSize);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001804
Douglas Gregore8bbc122011-09-02 00:18:52 +00001805 unsigned CharBitNum = Context.getTargetInfo().getCharWidth();
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001806 if (const RecordDecl *RD = dyn_cast<RecordDecl>(D)) {
1807 // Warn if padding was introduced to the struct/class/union.
Ken Dyckecfc7552011-02-24 01:13:28 +00001808 if (getSizeInBits() > UnpaddedSize) {
1809 unsigned PadSize = getSizeInBits() - UnpaddedSize;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001810 bool InBits = true;
1811 if (PadSize % CharBitNum == 0) {
1812 PadSize = PadSize / CharBitNum;
1813 InBits = false;
1814 }
1815 Diag(RD->getLocation(), diag::warn_padded_struct_size)
1816 << Context.getTypeDeclType(RD)
1817 << PadSize
1818 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1); // plural or not
1819 }
1820
1821 // Warn if we packed it unnecessarily. If the alignment is 1 byte don't
1822 // bother since there won't be alignment issues.
Ken Dyckecfc7552011-02-24 01:13:28 +00001823 if (Packed && UnpackedAlignment > CharUnits::One() &&
Ken Dyck1b4420e2011-02-28 02:01:38 +00001824 getSize() == UnpackedSize)
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001825 Diag(D->getLocation(), diag::warn_unnecessary_packed)
1826 << Context.getTypeDeclType(RD);
1827 }
Anders Carlsson79474332009-07-18 20:20:21 +00001828}
1829
Ken Dyck85ef0432011-02-19 18:58:07 +00001830void RecordLayoutBuilder::UpdateAlignment(CharUnits NewAlignment,
1831 CharUnits UnpackedNewAlignment) {
Douglas Gregore9fc3772012-01-26 07:55:45 +00001832 // The alignment is not modified when using 'mac68k' alignment or when
Douglas Gregor44ba7892012-01-28 00:53:29 +00001833 // we have an externally-supplied layout that also provides overall alignment.
1834 if (IsMac68kAlign || (ExternalLayout && !InferAlignment))
Daniel Dunbar6da10982010-05-27 05:45:51 +00001835 return;
1836
Ken Dyck85ef0432011-02-19 18:58:07 +00001837 if (NewAlignment > Alignment) {
1838 assert(llvm::isPowerOf2_32(NewAlignment.getQuantity() &&
1839 "Alignment not a power of 2"));
1840 Alignment = NewAlignment;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001841 }
1842
Ken Dyck85ef0432011-02-19 18:58:07 +00001843 if (UnpackedNewAlignment > UnpackedAlignment) {
1844 assert(llvm::isPowerOf2_32(UnpackedNewAlignment.getQuantity() &&
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001845 "Alignment not a power of 2"));
Ken Dyck85ef0432011-02-19 18:58:07 +00001846 UnpackedAlignment = UnpackedNewAlignment;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001847 }
1848}
1849
Douglas Gregor44ba7892012-01-28 00:53:29 +00001850uint64_t
1851RecordLayoutBuilder::updateExternalFieldOffset(const FieldDecl *Field,
1852 uint64_t ComputedOffset) {
1853 assert(ExternalFieldOffsets.find(Field) != ExternalFieldOffsets.end() &&
1854 "Field does not have an external offset");
1855
1856 uint64_t ExternalFieldOffset = ExternalFieldOffsets[Field];
1857
1858 if (InferAlignment && ExternalFieldOffset < ComputedOffset) {
1859 // The externally-supplied field offset is before the field offset we
1860 // computed. Assume that the structure is packed.
Douglas Gregor1423a5c2012-10-26 22:31:14 +00001861 Alignment = CharUnits::One();
Douglas Gregor44ba7892012-01-28 00:53:29 +00001862 InferAlignment = false;
1863 }
1864
1865 // Use the externally-supplied field offset.
Benjamin Kramer648e68b2012-08-31 22:14:25 +00001866 return ExternalFieldOffset;
1867}
1868
1869/// \brief Get diagnostic %select index for tag kind for
1870/// field padding diagnostic message.
1871/// WARNING: Indexes apply to particular diagnostics only!
1872///
1873/// \returns diagnostic %select index.
1874static unsigned getPaddingDiagFromTagKind(TagTypeKind Tag) {
1875 switch (Tag) {
1876 case TTK_Struct: return 0;
1877 case TTK_Interface: return 1;
1878 case TTK_Class: return 2;
1879 default: llvm_unreachable("Invalid tag kind for field padding diagnostic!");
1880 }
1881}
1882
1883void RecordLayoutBuilder::CheckFieldPadding(uint64_t Offset,
1884 uint64_t UnpaddedOffset,
1885 uint64_t UnpackedOffset,
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001886 unsigned UnpackedAlign,
1887 bool isPacked,
1888 const FieldDecl *D) {
1889 // We let objc ivars without warning, objc interfaces generally are not used
1890 // for padding tricks.
1891 if (isa<ObjCIvarDecl>(D))
Anders Carlsson79474332009-07-18 20:20:21 +00001892 return;
Mike Stump11289f42009-09-09 15:08:12 +00001893
Ted Kremenekfed48af2011-09-06 19:40:45 +00001894 // Don't warn about structs created without a SourceLocation. This can
1895 // be done by clients of the AST, such as codegen.
1896 if (D->getLocation().isInvalid())
1897 return;
1898
Douglas Gregore8bbc122011-09-02 00:18:52 +00001899 unsigned CharBitNum = Context.getTargetInfo().getCharWidth();
Mike Stump11289f42009-09-09 15:08:12 +00001900
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001901 // Warn if padding was introduced to the struct/class.
1902 if (!IsUnion && Offset > UnpaddedOffset) {
1903 unsigned PadSize = Offset - UnpaddedOffset;
1904 bool InBits = true;
1905 if (PadSize % CharBitNum == 0) {
1906 PadSize = PadSize / CharBitNum;
1907 InBits = false;
Benjamin Kramer648e68b2012-08-31 22:14:25 +00001908 }
1909 if (D->getIdentifier())
1910 Diag(D->getLocation(), diag::warn_padded_struct_field)
1911 << getPaddingDiagFromTagKind(D->getParent()->getTagKind())
1912 << Context.getTypeDeclType(D->getParent())
1913 << PadSize
1914 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1) // plural or not
1915 << D->getIdentifier();
1916 else
1917 Diag(D->getLocation(), diag::warn_padded_struct_anon_field)
1918 << getPaddingDiagFromTagKind(D->getParent()->getTagKind())
1919 << Context.getTypeDeclType(D->getParent())
1920 << PadSize
1921 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1); // plural or not
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001922 }
1923
1924 // Warn if we packed it unnecessarily. If the alignment is 1 byte don't
1925 // bother since there won't be alignment issues.
1926 if (isPacked && UnpackedAlign > CharBitNum && Offset == UnpackedOffset)
1927 Diag(D->getLocation(), diag::warn_unnecessary_packed)
1928 << D->getIdentifier();
Anders Carlsson79474332009-07-18 20:20:21 +00001929}
Mike Stump11289f42009-09-09 15:08:12 +00001930
John McCall6bd2a892013-01-25 22:31:03 +00001931static const CXXMethodDecl *computeKeyFunction(ASTContext &Context,
1932 const CXXRecordDecl *RD) {
Daniel Dunbarccabe482010-04-19 20:44:53 +00001933 // If a class isn't polymorphic it doesn't have a key function.
Anders Carlsson5ebf8b42009-12-07 04:35:11 +00001934 if (!RD->isPolymorphic())
Craig Topper36250ad2014-05-12 05:36:57 +00001935 return nullptr;
Eli Friedmanf2c79b62009-12-08 03:56:49 +00001936
Eli Friedman300f55d2011-06-10 21:53:06 +00001937 // A class that is not externally visible doesn't have a key function. (Or
Eli Friedmanf2c79b62009-12-08 03:56:49 +00001938 // at least, there's no point to assigning a key function to such a class;
1939 // this doesn't affect the ABI.)
Rafael Espindola3ae00052013-05-13 00:12:11 +00001940 if (!RD->isExternallyVisible())
Craig Topper36250ad2014-05-12 05:36:57 +00001941 return nullptr;
Eli Friedmanf2c79b62009-12-08 03:56:49 +00001942
Richard Smith750f5112014-03-24 23:54:09 +00001943 // Template instantiations don't have key functions per Itanium C++ ABI 5.2.6.
Argyrios Kyrtzidis8c64bbe2010-10-13 02:39:41 +00001944 // Same behavior as GCC.
1945 TemplateSpecializationKind TSK = RD->getTemplateSpecializationKind();
1946 if (TSK == TSK_ImplicitInstantiation ||
Richard Smith750f5112014-03-24 23:54:09 +00001947 TSK == TSK_ExplicitInstantiationDeclaration ||
Argyrios Kyrtzidis8c64bbe2010-10-13 02:39:41 +00001948 TSK == TSK_ExplicitInstantiationDefinition)
Craig Topper36250ad2014-05-12 05:36:57 +00001949 return nullptr;
Argyrios Kyrtzidis8c64bbe2010-10-13 02:39:41 +00001950
John McCall6bd2a892013-01-25 22:31:03 +00001951 bool allowInlineFunctions =
1952 Context.getTargetInfo().getCXXABI().canKeyFunctionBeInline();
1953
David Majnemerc964b4b2014-07-16 06:04:00 +00001954 for (const CXXMethodDecl *MD : RD->methods()) {
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001955 if (!MD->isVirtual())
1956 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001957
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001958 if (MD->isPure())
1959 continue;
Eli Friedmanf2c79b62009-12-08 03:56:49 +00001960
Anders Carlssonf98849e2009-12-02 17:15:43 +00001961 // Ignore implicit member functions, they are always marked as inline, but
1962 // they don't have a body until they're defined.
1963 if (MD->isImplicit())
1964 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001965
Douglas Gregora318efd2010-01-05 19:06:31 +00001966 if (MD->isInlineSpecified())
1967 continue;
Eli Friedman71a26d82009-12-06 20:50:05 +00001968
1969 if (MD->hasInlineBody())
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001970 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001971
Benjamin Kramer4a902082012-08-03 15:43:22 +00001972 // Ignore inline deleted or defaulted functions.
Benjamin Kramer73d1be72012-08-03 08:39:58 +00001973 if (!MD->isUserProvided())
1974 continue;
1975
John McCall6bd2a892013-01-25 22:31:03 +00001976 // In certain ABIs, ignore functions with out-of-line inline definitions.
1977 if (!allowInlineFunctions) {
1978 const FunctionDecl *Def;
1979 if (MD->hasBody(Def) && Def->isInlineSpecified())
1980 continue;
1981 }
1982
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001983 // We found it.
1984 return MD;
1985 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001986
Craig Topper36250ad2014-05-12 05:36:57 +00001987 return nullptr;
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001988}
1989
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001990DiagnosticBuilder
1991RecordLayoutBuilder::Diag(SourceLocation Loc, unsigned DiagID) {
Argyrios Kyrtzidisd0040642010-11-18 20:06:41 +00001992 return Context.getDiagnostics().Report(Loc, DiagID);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001993}
1994
John McCall5c1f1d02013-01-29 01:14:22 +00001995/// Does the target C++ ABI require us to skip over the tail-padding
1996/// of the given class (considering it as a base class) when allocating
1997/// objects?
1998static bool mustSkipTailPadding(TargetCXXABI ABI, const CXXRecordDecl *RD) {
1999 switch (ABI.getTailPaddingUseRules()) {
2000 case TargetCXXABI::AlwaysUseTailPadding:
2001 return false;
2002
2003 case TargetCXXABI::UseTailPaddingUnlessPOD03:
2004 // FIXME: To the extent that this is meant to cover the Itanium ABI
2005 // rules, we should implement the restrictions about over-sized
2006 // bitfields:
2007 //
2008 // http://mentorembedded.github.com/cxx-abi/abi.html#POD :
2009 // In general, a type is considered a POD for the purposes of
2010 // layout if it is a POD type (in the sense of ISO C++
2011 // [basic.types]). However, a POD-struct or POD-union (in the
2012 // sense of ISO C++ [class]) with a bitfield member whose
2013 // declared width is wider than the declared type of the
2014 // bitfield is not a POD for the purpose of layout. Similarly,
2015 // an array type is not a POD for the purpose of layout if the
2016 // element type of the array is not a POD for the purpose of
2017 // layout.
2018 //
2019 // Where references to the ISO C++ are made in this paragraph,
2020 // the Technical Corrigendum 1 version of the standard is
2021 // intended.
2022 return RD->isPOD();
2023
2024 case TargetCXXABI::UseTailPaddingUnlessPOD11:
2025 // This is equivalent to RD->getTypeForDecl().isCXX11PODType(),
2026 // but with a lot of abstraction penalty stripped off. This does
2027 // assume that these properties are set correctly even in C++98
2028 // mode; fortunately, that is true because we want to assign
2029 // consistently semantics to the type-traits intrinsics (or at
2030 // least as many of them as possible).
2031 return RD->isTrivial() && RD->isStandardLayout();
2032 }
2033
2034 llvm_unreachable("bad tail-padding use kind");
2035}
2036
Warren Hunt8f8bad72013-10-11 20:19:00 +00002037static bool isMsLayout(const RecordDecl* D) {
Warren Hunt55d8e822013-10-23 23:53:07 +00002038 return D->getASTContext().getTargetInfo().getCXXABI().isMicrosoft();
Warren Hunt8f8bad72013-10-11 20:19:00 +00002039}
2040
2041// This section contains an implementation of struct layout that is, up to the
Warren Hunt917f97f2014-04-11 00:54:15 +00002042// included tests, compatible with cl.exe (2013). The layout produced is
Warren Hunt8f8bad72013-10-11 20:19:00 +00002043// significantly different than those produced by the Itanium ABI. Here we note
2044// the most important differences.
2045//
2046// * The alignment of bitfields in unions is ignored when computing the
2047// alignment of the union.
Alp Tokerf6a24ce2013-12-05 16:25:25 +00002048// * The existence of zero-width bitfield that occurs after anything other than
Warren Hunt8f8bad72013-10-11 20:19:00 +00002049// a non-zero length bitfield is ignored.
Warren Hunt917f97f2014-04-11 00:54:15 +00002050// * There is no explicit primary base for the purposes of layout. All bases
2051// with vfptrs are laid out first, followed by all bases without vfptrs.
Warren Hunt8f8bad72013-10-11 20:19:00 +00002052// * The Itanium equivalent vtable pointers are split into a vfptr (virtual
2053// function pointer) and a vbptr (virtual base pointer). They can each be
Warren Hunt55d8e822013-10-23 23:53:07 +00002054// shared with a, non-virtual bases. These bases need not be the same. vfptrs
Warren Hunt917f97f2014-04-11 00:54:15 +00002055// always occur at offset 0. vbptrs can occur at an arbitrary offset and are
2056// placed after the lexiographically last non-virtual base. This placement
2057// is always before fields but can be in the middle of the non-virtual bases
2058// due to the two-pass layout scheme for non-virtual-bases.
Warren Hunt8f8bad72013-10-11 20:19:00 +00002059// * Virtual bases sometimes require a 'vtordisp' field that is laid out before
2060// the virtual base and is used in conjunction with virtual overrides during
Warren Hunt917f97f2014-04-11 00:54:15 +00002061// construction and destruction. This is always a 4 byte value and is used as
2062// an alternative to constructor vtables.
Warren Hunt8f8bad72013-10-11 20:19:00 +00002063// * vtordisps are allocated in a block of memory with size and alignment equal
2064// to the alignment of the completed structure (before applying __declspec(
Warren Hunt55d8e822013-10-23 23:53:07 +00002065// align())). The vtordisp always occur at the end of the allocation block,
2066// immediately prior to the virtual base.
Warren Hunt917f97f2014-04-11 00:54:15 +00002067// * vfptrs are injected after all bases and fields have been laid out. In
2068// order to guarantee proper alignment of all fields, the vfptr injection
2069// pushes all bases and fields back by the alignment imposed by those bases
2070// and fields. This can potentially add a significant amount of padding.
2071// vfptrs are always injected at offset 0.
2072// * vbptrs are injected after all bases and fields have been laid out. In
2073// order to guarantee proper alignment of all fields, the vfptr injection
2074// pushes all bases and fields back by the alignment imposed by those bases
2075// and fields. This can potentially add a significant amount of padding.
2076// vbptrs are injected immediately after the last non-virtual base as
2077// lexiographically ordered in the code. If this site isn't pointer aligned
2078// the vbptr is placed at the next properly aligned location. Enough padding
2079// is added to guarantee a fit.
2080// * The last zero sized non-virtual base can be placed at the end of the
2081// struct (potentially aliasing another object), or may alias with the first
2082// field, even if they are of the same type.
2083// * The last zero size virtual base may be placed at the end of the struct
2084// potentially aliasing another object.
Warren Hunt049f6732013-12-06 19:54:25 +00002085// * The ABI attempts to avoid aliasing of zero sized bases by adding padding
2086// between bases or vbases with specific properties. The criteria for
2087// additional padding between two bases is that the first base is zero sized
Warren Hunt39a907b2014-04-09 21:57:24 +00002088// or ends with a zero sized subobject and the second base is zero sized or
Warren Hunt917f97f2014-04-11 00:54:15 +00002089// trails with a zero sized base or field (sharing of vfptrs can reorder the
2090// layout of the so the leading base is not always the first one declared).
2091// This rule does take into account fields that are not records, so padding
2092// will occur even if the last field is, e.g. an int. The padding added for
2093// bases is 1 byte. The padding added between vbases depends on the alignment
2094// of the object but is at least 4 bytes (in both 32 and 64 bit modes).
2095// * There is no concept of non-virtual alignment, non-virtual alignment and
2096// alignment are always identical.
2097// * There is a distinction between alignment and required alignment.
2098// __declspec(align) changes the required alignment of a struct. This
2099// alignment is _always_ obeyed, even in the presence of #pragma pack. A
2100// record inherites required alignment from all of its fields an bases.
Warren Huntf4518def2014-01-10 01:28:05 +00002101// * __declspec(align) on bitfields has the effect of changing the bitfield's
Warren Hunt917f97f2014-04-11 00:54:15 +00002102// alignment instead of its required alignment. This is the only known way
2103// to make the alignment of a struct bigger than 8. Interestingly enough
2104// this alignment is also immune to the effects of #pragma pack and can be
2105// used to create structures with large alignment under #pragma pack.
2106// However, because it does not impact required alignment, such a structure,
2107// when used as a field or base, will not be aligned if #pragma pack is
2108// still active at the time of use.
2109//
Alp Toker08f6e9e2014-05-05 19:53:42 +00002110// Known incompatibilities:
Warren Hunt917f97f2014-04-11 00:54:15 +00002111// * all: #pragma pack between fields in a record
2112// * 2010 and back: If the last field in a record is a bitfield, every object
2113// laid out after the record will have extra padding inserted before it. The
2114// extra padding will have size equal to the size of the storage class of the
2115// bitfield. 0 sized bitfields don't exhibit this behavior and the extra
2116// padding can be avoided by adding a 0 sized bitfield after the non-zero-
2117// sized bitfield.
2118// * 2012 and back: In 64-bit mode, if the alignment of a record is 16 or
2119// greater due to __declspec(align()) then a second layout phase occurs after
2120// The locations of the vf and vb pointers are known. This layout phase
2121// suffers from the "last field is a bitfield" bug in 2010 and results in
2122// _every_ field getting padding put in front of it, potentially including the
2123// vfptr, leaving the vfprt at a non-zero location which results in a fault if
2124// anything tries to read the vftbl. The second layout phase also treats
Alp Toker08f6e9e2014-05-05 19:53:42 +00002125// bitfields as separate entities and gives them each storage rather than
Warren Hunt917f97f2014-04-11 00:54:15 +00002126// packing them. Additionally, because this phase appears to perform a
2127// (an unstable) sort on the members before laying them out and because merged
2128// bitfields have the same address, the bitfields end up in whatever order
2129// the sort left them in, a behavior we could never hope to replicate.
Warren Hunt8f8bad72013-10-11 20:19:00 +00002130
2131namespace {
2132struct MicrosoftRecordLayoutBuilder {
Warren Huntd640d7d2014-01-09 00:30:56 +00002133 struct ElementInfo {
2134 CharUnits Size;
2135 CharUnits Alignment;
2136 };
Warren Hunt8f8bad72013-10-11 20:19:00 +00002137 typedef llvm::DenseMap<const CXXRecordDecl *, CharUnits> BaseOffsetsMapTy;
2138 MicrosoftRecordLayoutBuilder(const ASTContext &Context) : Context(Context) {}
2139private:
2140 MicrosoftRecordLayoutBuilder(const MicrosoftRecordLayoutBuilder &)
2141 LLVM_DELETED_FUNCTION;
2142 void operator=(const MicrosoftRecordLayoutBuilder &) LLVM_DELETED_FUNCTION;
2143public:
Warren Hunt8f8bad72013-10-11 20:19:00 +00002144 void layout(const RecordDecl *RD);
2145 void cxxLayout(const CXXRecordDecl *RD);
2146 /// \brief Initializes size and alignment and honors some flags.
2147 void initializeLayout(const RecordDecl *RD);
2148 /// \brief Initialized C++ layout, compute alignment and virtual alignment and
Alp Tokerf6a24ce2013-12-05 16:25:25 +00002149 /// existence of vfptrs and vbptrs. Alignment is needed before the vfptr is
Warren Hunt8f8bad72013-10-11 20:19:00 +00002150 /// laid out.
2151 void initializeCXXLayout(const CXXRecordDecl *RD);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002152 void layoutNonVirtualBases(const CXXRecordDecl *RD);
Warren Huntd640d7d2014-01-09 00:30:56 +00002153 void layoutNonVirtualBase(const CXXRecordDecl *BaseDecl,
2154 const ASTRecordLayout &BaseLayout,
2155 const ASTRecordLayout *&PreviousBaseLayout);
2156 void injectVFPtr(const CXXRecordDecl *RD);
2157 void injectVBPtr(const CXXRecordDecl *RD);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002158 /// \brief Lays out the fields of the record. Also rounds size up to
2159 /// alignment.
2160 void layoutFields(const RecordDecl *RD);
2161 void layoutField(const FieldDecl *FD);
2162 void layoutBitField(const FieldDecl *FD);
2163 /// \brief Lays out a single zero-width bit-field in the record and handles
2164 /// special cases associated with zero-width bit-fields.
2165 void layoutZeroWidthBitField(const FieldDecl *FD);
2166 void layoutVirtualBases(const CXXRecordDecl *RD);
Warren Hunt1603e522013-12-10 01:44:39 +00002167 void finalizeLayout(const RecordDecl *RD);
Warren Huntd640d7d2014-01-09 00:30:56 +00002168 /// \brief Gets the size and alignment of a base taking pragma pack and
2169 /// __declspec(align) into account.
Warren Hunt5d9eebf2014-04-10 22:15:18 +00002170 ElementInfo getAdjustedElementInfo(const ASTRecordLayout &Layout);
Warren Huntd640d7d2014-01-09 00:30:56 +00002171 /// \brief Gets the size and alignment of a field taking pragma pack and
2172 /// __declspec(align) into account. It also updates RequiredAlignment as a
2173 /// side effect because it is most convenient to do so here.
2174 ElementInfo getAdjustedElementInfo(const FieldDecl *FD);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002175 /// \brief Places a field at an offset in CharUnits.
2176 void placeFieldAtOffset(CharUnits FieldOffset) {
2177 FieldOffsets.push_back(Context.toBits(FieldOffset));
2178 }
2179 /// \brief Places a bitfield at a bit offset.
2180 void placeFieldAtBitOffset(uint64_t FieldOffset) {
2181 FieldOffsets.push_back(FieldOffset);
2182 }
2183 /// \brief Compute the set of virtual bases for which vtordisps are required.
2184 llvm::SmallPtrSet<const CXXRecordDecl *, 2>
2185 computeVtorDispSet(const CXXRecordDecl *RD);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002186 const ASTContext &Context;
2187 /// \brief The size of the record being laid out.
2188 CharUnits Size;
Warren Huntf6ec7482014-02-21 01:40:35 +00002189 /// \brief The non-virtual size of the record layout.
2190 CharUnits NonVirtualSize;
2191 /// \brief The data size of the record layout.
Warren Huntd640d7d2014-01-09 00:30:56 +00002192 CharUnits DataSize;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002193 /// \brief The current alignment of the record layout.
2194 CharUnits Alignment;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002195 /// \brief The maximum allowed field alignment. This is set by #pragma pack.
2196 CharUnits MaxFieldAlignment;
Warren Hunt7b252d22013-12-06 00:01:17 +00002197 /// \brief The alignment that this record must obey. This is imposed by
2198 /// __declspec(align()) on the record itself or one of its fields or bases.
2199 CharUnits RequiredAlignment;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002200 /// \brief The size of the allocation of the currently active bitfield.
2201 /// This value isn't meaningful unless LastFieldIsNonZeroWidthBitfield
2202 /// is true.
2203 CharUnits CurrentBitfieldSize;
Warren Huntd640d7d2014-01-09 00:30:56 +00002204 /// \brief Offset to the virtual base table pointer (if one exists).
2205 CharUnits VBPtrOffset;
2206 /// \brief The size and alignment info of a pointer.
2207 ElementInfo PointerInfo;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002208 /// \brief The primary base class (if one exists).
2209 const CXXRecordDecl *PrimaryBase;
2210 /// \brief The class we share our vb-pointer with.
2211 const CXXRecordDecl *SharedVBPtrBase;
Warren Huntd640d7d2014-01-09 00:30:56 +00002212 /// \brief The collection of field offsets.
2213 SmallVector<uint64_t, 16> FieldOffsets;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002214 /// \brief Base classes and their offsets in the record.
2215 BaseOffsetsMapTy Bases;
2216 /// \brief virtual base classes and their offsets in the record.
2217 ASTRecordLayout::VBaseOffsetsMapTy VBases;
Warren Huntd640d7d2014-01-09 00:30:56 +00002218 /// \brief The number of remaining bits in our last bitfield allocation.
2219 /// This value isn't meaningful unless LastFieldIsNonZeroWidthBitfield is
2220 /// true.
2221 unsigned RemainingBitsInField;
2222 bool IsUnion : 1;
2223 /// \brief True if the last field laid out was a bitfield and was not 0
2224 /// width.
2225 bool LastFieldIsNonZeroWidthBitfield : 1;
2226 /// \brief True if the class has its own vftable pointer.
2227 bool HasOwnVFPtr : 1;
2228 /// \brief True if the class has a vbtable pointer.
2229 bool HasVBPtr : 1;
Warren Hunt39a907b2014-04-09 21:57:24 +00002230 /// \brief True if the last sub-object within the type is zero sized or the
2231 /// object itself is zero sized. This *does not* count members that are not
2232 /// records. Only used for MS-ABI.
2233 bool EndsWithZeroSizedObject : 1;
Warren Hunt049f6732013-12-06 19:54:25 +00002234 /// \brief True if this class is zero sized or first base is zero sized or
2235 /// has this property. Only used for MS-ABI.
2236 bool LeadsWithZeroSizedBase : 1;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002237};
2238} // namespace
2239
Warren Huntd640d7d2014-01-09 00:30:56 +00002240MicrosoftRecordLayoutBuilder::ElementInfo
2241MicrosoftRecordLayoutBuilder::getAdjustedElementInfo(
Warren Hunt5d9eebf2014-04-10 22:15:18 +00002242 const ASTRecordLayout &Layout) {
Warren Huntd640d7d2014-01-09 00:30:56 +00002243 ElementInfo Info;
2244 Info.Alignment = Layout.getAlignment();
2245 // Respect pragma pack.
Warren Hunt7b252d22013-12-06 00:01:17 +00002246 if (!MaxFieldAlignment.isZero())
Warren Huntd640d7d2014-01-09 00:30:56 +00002247 Info.Alignment = std::min(Info.Alignment, MaxFieldAlignment);
2248 // Track zero-sized subobjects here where it's already available.
Warren Hunt39a907b2014-04-09 21:57:24 +00002249 EndsWithZeroSizedObject = Layout.hasZeroSizedSubObject();
Warren Huntd640d7d2014-01-09 00:30:56 +00002250 // Respect required alignment, this is necessary because we may have adjusted
Warren Hunt94258912014-01-11 01:16:40 +00002251 // the alignment in the case of pragam pack. Note that the required alignment
2252 // doesn't actually apply to the struct alignment at this point.
2253 Alignment = std::max(Alignment, Info.Alignment);
Warren Hunt5d9eebf2014-04-10 22:15:18 +00002254 RequiredAlignment = std::max(RequiredAlignment, Layout.getRequiredAlignment());
Warren Huntd640d7d2014-01-09 00:30:56 +00002255 Info.Alignment = std::max(Info.Alignment, Layout.getRequiredAlignment());
Warren Hunt5d9eebf2014-04-10 22:15:18 +00002256 Info.Size = Layout.getNonVirtualSize();
Warren Huntd640d7d2014-01-09 00:30:56 +00002257 return Info;
Warren Hunt7b252d22013-12-06 00:01:17 +00002258}
2259
Warren Huntd640d7d2014-01-09 00:30:56 +00002260MicrosoftRecordLayoutBuilder::ElementInfo
2261MicrosoftRecordLayoutBuilder::getAdjustedElementInfo(
2262 const FieldDecl *FD) {
David Majnemer34b57492014-07-30 01:30:47 +00002263 // Get the alignment of the field type's natural alignment, ignore any
2264 // alignment attributes.
Warren Huntd640d7d2014-01-09 00:30:56 +00002265 ElementInfo Info;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00002266 std::tie(Info.Size, Info.Alignment) =
David Majnemer34b57492014-07-30 01:30:47 +00002267 Context.getTypeInfoInChars(FD->getType()->getUnqualifiedDesugaredType());
2268 // Respect align attributes on the field.
2269 CharUnits FieldRequiredAlignment =
Warren Huntf4518def2014-01-10 01:28:05 +00002270 Context.toCharUnitsFromBits(FD->getMaxAlignment());
David Majnemer34b57492014-07-30 01:30:47 +00002271 // Respect align attributes on the type.
2272 if (Context.isAlignmentRequired(FD->getType()))
2273 FieldRequiredAlignment = std::max(
2274 Context.getTypeAlignInChars(FD->getType()), FieldRequiredAlignment);
Warren Hunt049f6732013-12-06 19:54:25 +00002275 // Respect attributes applied to subobjects of the field.
Warren Hunt5d9eebf2014-04-10 22:15:18 +00002276 if (FD->isBitField())
2277 // For some reason __declspec align impacts alignment rather than required
2278 // alignment when it is applied to bitfields.
Warren Huntf4518def2014-01-10 01:28:05 +00002279 Info.Alignment = std::max(Info.Alignment, FieldRequiredAlignment);
Warren Hunt5d9eebf2014-04-10 22:15:18 +00002280 else {
2281 if (auto RT =
2282 FD->getType()->getBaseElementTypeUnsafe()->getAs<RecordType>()) {
2283 auto const &Layout = Context.getASTRecordLayout(RT->getDecl());
2284 EndsWithZeroSizedObject = Layout.hasZeroSizedSubObject();
2285 FieldRequiredAlignment = std::max(FieldRequiredAlignment,
2286 Layout.getRequiredAlignment());
2287 }
Warren Huntf4518def2014-01-10 01:28:05 +00002288 // Capture required alignment as a side-effect.
2289 RequiredAlignment = std::max(RequiredAlignment, FieldRequiredAlignment);
2290 }
Warren Hunt5d9eebf2014-04-10 22:15:18 +00002291 // Respect pragma pack, attribute pack and declspec align
2292 if (!MaxFieldAlignment.isZero())
2293 Info.Alignment = std::min(Info.Alignment, MaxFieldAlignment);
2294 if (FD->hasAttr<PackedAttr>())
2295 Info.Alignment = CharUnits::One();
2296 Info.Alignment = std::max(Info.Alignment, FieldRequiredAlignment);
Warren Huntd640d7d2014-01-09 00:30:56 +00002297 return Info;
2298}
2299
2300void MicrosoftRecordLayoutBuilder::layout(const RecordDecl *RD) {
2301 initializeLayout(RD);
2302 layoutFields(RD);
2303 DataSize = Size = Size.RoundUpToAlignment(Alignment);
David Majnemer79a1c892014-02-12 00:43:02 +00002304 RequiredAlignment = std::max(
2305 RequiredAlignment, Context.toCharUnitsFromBits(RD->getMaxAlignment()));
Warren Huntd640d7d2014-01-09 00:30:56 +00002306 finalizeLayout(RD);
2307}
2308
2309void MicrosoftRecordLayoutBuilder::cxxLayout(const CXXRecordDecl *RD) {
2310 initializeLayout(RD);
2311 initializeCXXLayout(RD);
2312 layoutNonVirtualBases(RD);
2313 layoutFields(RD);
Warren Huntc89450e2014-03-24 21:37:27 +00002314 injectVBPtr(RD);
2315 injectVFPtr(RD);
2316 if (HasOwnVFPtr || (HasVBPtr && !SharedVBPtrBase))
2317 Alignment = std::max(Alignment, PointerInfo.Alignment);
Warren Hunt5d9eebf2014-04-10 22:15:18 +00002318 auto RoundingAlignment = Alignment;
2319 if (!MaxFieldAlignment.isZero())
2320 RoundingAlignment = std::min(RoundingAlignment, MaxFieldAlignment);
2321 NonVirtualSize = Size = Size.RoundUpToAlignment(RoundingAlignment);
David Majnemer79a1c892014-02-12 00:43:02 +00002322 RequiredAlignment = std::max(
2323 RequiredAlignment, Context.toCharUnitsFromBits(RD->getMaxAlignment()));
Warren Huntd640d7d2014-01-09 00:30:56 +00002324 layoutVirtualBases(RD);
2325 finalizeLayout(RD);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002326}
2327
2328void MicrosoftRecordLayoutBuilder::initializeLayout(const RecordDecl *RD) {
2329 IsUnion = RD->isUnion();
Warren Hunt8f8bad72013-10-11 20:19:00 +00002330 Size = CharUnits::Zero();
2331 Alignment = CharUnits::One();
Warren Hunt7b252d22013-12-06 00:01:17 +00002332 // In 64-bit mode we always perform an alignment step after laying out vbases.
2333 // In 32-bit mode we do not. The check to see if we need to perform alignment
2334 // checks the RequiredAlignment field and performs alignment if it isn't 0.
Warren Huntbb9c3c32014-04-10 23:23:34 +00002335 RequiredAlignment = Context.getTargetInfo().getPointerWidth(0) == 64 ?
2336 CharUnits::One() : CharUnits::Zero();
Warren Hunt8f8bad72013-10-11 20:19:00 +00002337 // Compute the maximum field alignment.
2338 MaxFieldAlignment = CharUnits::Zero();
2339 // Honor the default struct packing maximum alignment flag.
2340 if (unsigned DefaultMaxFieldAlignment = Context.getLangOpts().PackStruct)
Warren Huntf4518def2014-01-10 01:28:05 +00002341 MaxFieldAlignment = CharUnits::fromQuantity(DefaultMaxFieldAlignment);
2342 // Honor the packing attribute. The MS-ABI ignores pragma pack if its larger
2343 // than the pointer size.
2344 if (const MaxFieldAlignmentAttr *MFAA = RD->getAttr<MaxFieldAlignmentAttr>()){
2345 unsigned PackedAlignment = MFAA->getAlignment();
2346 if (PackedAlignment <= Context.getTargetInfo().getPointerWidth(0))
2347 MaxFieldAlignment = Context.toCharUnitsFromBits(PackedAlignment);
2348 }
Warren Hunt8f8bad72013-10-11 20:19:00 +00002349 // Packed attribute forces max field alignment to be 1.
2350 if (RD->hasAttr<PackedAttr>())
2351 MaxFieldAlignment = CharUnits::One();
2352}
2353
Warren Hunt8f8bad72013-10-11 20:19:00 +00002354void
2355MicrosoftRecordLayoutBuilder::initializeCXXLayout(const CXXRecordDecl *RD) {
Warren Hunt39a907b2014-04-09 21:57:24 +00002356 EndsWithZeroSizedObject = false;
Warren Hunt049f6732013-12-06 19:54:25 +00002357 LeadsWithZeroSizedBase = false;
Warren Huntd640d7d2014-01-09 00:30:56 +00002358 HasOwnVFPtr = false;
2359 HasVBPtr = false;
Craig Topper36250ad2014-05-12 05:36:57 +00002360 PrimaryBase = nullptr;
2361 SharedVBPtrBase = nullptr;
Warren Huntd640d7d2014-01-09 00:30:56 +00002362 // Calculate pointer size and alignment. These are used for vfptr and vbprt
2363 // injection.
2364 PointerInfo.Size =
2365 Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerWidth(0));
2366 PointerInfo.Alignment = PointerInfo.Size;
2367 // Respect pragma pack.
2368 if (!MaxFieldAlignment.isZero())
2369 PointerInfo.Alignment = std::min(PointerInfo.Alignment, MaxFieldAlignment);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002370}
2371
2372void
2373MicrosoftRecordLayoutBuilder::layoutNonVirtualBases(const CXXRecordDecl *RD) {
Warren Huntd640d7d2014-01-09 00:30:56 +00002374 // The MS-ABI lays out all bases that contain leading vfptrs before it lays
2375 // out any bases that do not contain vfptrs. We implement this as two passes
2376 // over the bases. This approach guarantees that the primary base is laid out
2377 // first. We use these passes to calculate some additional aggregated
2378 // information about the bases, such as reqruied alignment and the presence of
2379 // zero sized members.
Craig Topper36250ad2014-05-12 05:36:57 +00002380 const ASTRecordLayout *PreviousBaseLayout = nullptr;
Warren Huntd640d7d2014-01-09 00:30:56 +00002381 // Iterate through the bases and lay out the non-virtual ones.
David Majnemerc964b4b2014-07-16 06:04:00 +00002382 for (const CXXBaseSpecifier &Base : RD->bases()) {
2383 const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl();
Warren Huntd640d7d2014-01-09 00:30:56 +00002384 const ASTRecordLayout &BaseLayout = Context.getASTRecordLayout(BaseDecl);
Warren Huntd640d7d2014-01-09 00:30:56 +00002385 // Mark and skip virtual bases.
David Majnemerc964b4b2014-07-16 06:04:00 +00002386 if (Base.isVirtual()) {
Warren Huntd640d7d2014-01-09 00:30:56 +00002387 HasVBPtr = true;
2388 continue;
2389 }
2390 // Check fo a base to share a VBPtr with.
2391 if (!SharedVBPtrBase && BaseLayout.hasVBPtr()) {
2392 SharedVBPtrBase = BaseDecl;
2393 HasVBPtr = true;
2394 }
2395 // Only lay out bases with extendable VFPtrs on the first pass.
2396 if (!BaseLayout.hasExtendableVFPtr())
2397 continue;
2398 // If we don't have a primary base, this one qualifies.
Warren Huntbadf9e02014-01-13 19:55:52 +00002399 if (!PrimaryBase) {
Warren Huntd640d7d2014-01-09 00:30:56 +00002400 PrimaryBase = BaseDecl;
Warren Huntbadf9e02014-01-13 19:55:52 +00002401 LeadsWithZeroSizedBase = BaseLayout.leadsWithZeroSizedBase();
2402 }
Warren Huntd640d7d2014-01-09 00:30:56 +00002403 // Lay out the base.
2404 layoutNonVirtualBase(BaseDecl, BaseLayout, PreviousBaseLayout);
2405 }
2406 // Figure out if we need a fresh VFPtr for this class.
2407 if (!PrimaryBase && RD->isDynamicClass())
2408 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
2409 e = RD->method_end();
2410 !HasOwnVFPtr && i != e; ++i)
2411 HasOwnVFPtr = i->isVirtual() && i->size_overridden_methods() == 0;
2412 // If we don't have a primary base then we have a leading object that could
2413 // itself lead with a zero-sized object, something we track.
2414 bool CheckLeadingLayout = !PrimaryBase;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002415 // Iterate through the bases and lay out the non-virtual ones.
David Majnemerc964b4b2014-07-16 06:04:00 +00002416 for (const CXXBaseSpecifier &Base : RD->bases()) {
2417 if (Base.isVirtual())
Warren Hunt8f8bad72013-10-11 20:19:00 +00002418 continue;
David Majnemerc964b4b2014-07-16 06:04:00 +00002419 const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl();
Warren Huntd640d7d2014-01-09 00:30:56 +00002420 const ASTRecordLayout &BaseLayout = Context.getASTRecordLayout(BaseDecl);
2421 // Only lay out bases without extendable VFPtrs on the second pass.
Warren Huntbb9c3c32014-04-10 23:23:34 +00002422 if (BaseLayout.hasExtendableVFPtr()) {
2423 VBPtrOffset = Bases[BaseDecl] + BaseLayout.getNonVirtualSize();
Warren Hunt4431fe62013-12-12 22:33:37 +00002424 continue;
Warren Huntbb9c3c32014-04-10 23:23:34 +00002425 }
Warren Huntd640d7d2014-01-09 00:30:56 +00002426 // If this is the first layout, check to see if it leads with a zero sized
2427 // object. If it does, so do we.
2428 if (CheckLeadingLayout) {
2429 CheckLeadingLayout = false;
2430 LeadsWithZeroSizedBase = BaseLayout.leadsWithZeroSizedBase();
Warren Hunt049f6732013-12-06 19:54:25 +00002431 }
Warren Huntd640d7d2014-01-09 00:30:56 +00002432 // Lay out the base.
2433 layoutNonVirtualBase(BaseDecl, BaseLayout, PreviousBaseLayout);
Warren Huntbb9c3c32014-04-10 23:23:34 +00002434 VBPtrOffset = Bases[BaseDecl] + BaseLayout.getNonVirtualSize();
Warren Hunt8f8bad72013-10-11 20:19:00 +00002435 }
Warren Huntd640d7d2014-01-09 00:30:56 +00002436 // Set our VBPtroffset if we know it at this point.
Warren Hunt8f8bad72013-10-11 20:19:00 +00002437 if (!HasVBPtr)
2438 VBPtrOffset = CharUnits::fromQuantity(-1);
Warren Hunt6eba9072014-01-14 00:31:30 +00002439 else if (SharedVBPtrBase) {
2440 const ASTRecordLayout &Layout = Context.getASTRecordLayout(SharedVBPtrBase);
2441 VBPtrOffset = Bases[SharedVBPtrBase] + Layout.getVBPtrOffset();
2442 }
Warren Huntd640d7d2014-01-09 00:30:56 +00002443}
2444
2445void MicrosoftRecordLayoutBuilder::layoutNonVirtualBase(
2446 const CXXRecordDecl *BaseDecl,
2447 const ASTRecordLayout &BaseLayout,
2448 const ASTRecordLayout *&PreviousBaseLayout) {
Warren Huntf4518def2014-01-10 01:28:05 +00002449 // Insert padding between two bases if the left first one is zero sized or
2450 // contains a zero sized subobject and the right is zero sized or one leads
2451 // with a zero sized base.
2452 if (PreviousBaseLayout && PreviousBaseLayout->hasZeroSizedSubObject() &&
2453 BaseLayout.leadsWithZeroSizedBase())
2454 Size++;
2455 ElementInfo Info = getAdjustedElementInfo(BaseLayout);
2456 CharUnits BaseOffset = Size.RoundUpToAlignment(Info.Alignment);
2457 Bases.insert(std::make_pair(BaseDecl, BaseOffset));
Warren Huntf6ec7482014-02-21 01:40:35 +00002458 Size = BaseOffset + BaseLayout.getNonVirtualSize();
Warren Huntf4518def2014-01-10 01:28:05 +00002459 PreviousBaseLayout = &BaseLayout;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002460}
2461
2462void MicrosoftRecordLayoutBuilder::layoutFields(const RecordDecl *RD) {
2463 LastFieldIsNonZeroWidthBitfield = false;
David Majnemerc964b4b2014-07-16 06:04:00 +00002464 for (const FieldDecl *Field : RD->fields())
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00002465 layoutField(Field);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002466}
2467
2468void MicrosoftRecordLayoutBuilder::layoutField(const FieldDecl *FD) {
2469 if (FD->isBitField()) {
2470 layoutBitField(FD);
2471 return;
2472 }
2473 LastFieldIsNonZeroWidthBitfield = false;
Warren Huntd640d7d2014-01-09 00:30:56 +00002474 ElementInfo Info = getAdjustedElementInfo(FD);
David Majnemeradc45bb2014-04-13 08:15:50 +00002475 Alignment = std::max(Alignment, Info.Alignment);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002476 if (IsUnion) {
Warren Huntd640d7d2014-01-09 00:30:56 +00002477 placeFieldAtOffset(CharUnits::Zero());
2478 Size = std::max(Size, Info.Size);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002479 } else {
Warren Huntd640d7d2014-01-09 00:30:56 +00002480 CharUnits FieldOffset = Size.RoundUpToAlignment(Info.Alignment);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002481 placeFieldAtOffset(FieldOffset);
Warren Huntd640d7d2014-01-09 00:30:56 +00002482 Size = FieldOffset + Info.Size;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002483 }
2484}
2485
2486void MicrosoftRecordLayoutBuilder::layoutBitField(const FieldDecl *FD) {
2487 unsigned Width = FD->getBitWidthValue(Context);
2488 if (Width == 0) {
2489 layoutZeroWidthBitField(FD);
2490 return;
2491 }
Warren Huntd640d7d2014-01-09 00:30:56 +00002492 ElementInfo Info = getAdjustedElementInfo(FD);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002493 // Clamp the bitfield to a containable size for the sake of being able
2494 // to lay them out. Sema will throw an error.
Warren Huntd640d7d2014-01-09 00:30:56 +00002495 if (Width > Context.toBits(Info.Size))
2496 Width = Context.toBits(Info.Size);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002497 // Check to see if this bitfield fits into an existing allocation. Note:
2498 // MSVC refuses to pack bitfields of formal types with different sizes
2499 // into the same allocation.
2500 if (!IsUnion && LastFieldIsNonZeroWidthBitfield &&
Warren Huntd640d7d2014-01-09 00:30:56 +00002501 CurrentBitfieldSize == Info.Size && Width <= RemainingBitsInField) {
Warren Hunt8f8bad72013-10-11 20:19:00 +00002502 placeFieldAtBitOffset(Context.toBits(Size) - RemainingBitsInField);
2503 RemainingBitsInField -= Width;
2504 return;
2505 }
Warren Hunt8f8bad72013-10-11 20:19:00 +00002506 LastFieldIsNonZeroWidthBitfield = true;
Warren Huntd640d7d2014-01-09 00:30:56 +00002507 CurrentBitfieldSize = Info.Size;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002508 if (IsUnion) {
Warren Huntd640d7d2014-01-09 00:30:56 +00002509 placeFieldAtOffset(CharUnits::Zero());
2510 Size = std::max(Size, Info.Size);
David Majnemeradc45bb2014-04-13 08:15:50 +00002511 // TODO: Add a Sema warning that MS ignores bitfield alignment in unions.
Warren Hunt8f8bad72013-10-11 20:19:00 +00002512 } else {
2513 // Allocate a new block of memory and place the bitfield in it.
Warren Huntd640d7d2014-01-09 00:30:56 +00002514 CharUnits FieldOffset = Size.RoundUpToAlignment(Info.Alignment);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002515 placeFieldAtOffset(FieldOffset);
Warren Huntd640d7d2014-01-09 00:30:56 +00002516 Size = FieldOffset + Info.Size;
David Majnemeradc45bb2014-04-13 08:15:50 +00002517 Alignment = std::max(Alignment, Info.Alignment);
Warren Huntd640d7d2014-01-09 00:30:56 +00002518 RemainingBitsInField = Context.toBits(Info.Size) - Width;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002519 }
2520}
2521
2522void
2523MicrosoftRecordLayoutBuilder::layoutZeroWidthBitField(const FieldDecl *FD) {
2524 // Zero-width bitfields are ignored unless they follow a non-zero-width
2525 // bitfield.
Warren Hunt8f8bad72013-10-11 20:19:00 +00002526 if (!LastFieldIsNonZeroWidthBitfield) {
2527 placeFieldAtOffset(IsUnion ? CharUnits::Zero() : Size);
2528 // TODO: Add a Sema warning that MS ignores alignment for zero
Alp Tokerd4733632013-12-05 04:47:09 +00002529 // sized bitfields that occur after zero-size bitfields or non-bitfields.
Warren Hunt8f8bad72013-10-11 20:19:00 +00002530 return;
2531 }
Warren Hunt8f8bad72013-10-11 20:19:00 +00002532 LastFieldIsNonZeroWidthBitfield = false;
Warren Huntd640d7d2014-01-09 00:30:56 +00002533 ElementInfo Info = getAdjustedElementInfo(FD);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002534 if (IsUnion) {
Warren Huntd640d7d2014-01-09 00:30:56 +00002535 placeFieldAtOffset(CharUnits::Zero());
2536 Size = std::max(Size, Info.Size);
David Majnemeradc45bb2014-04-13 08:15:50 +00002537 // TODO: Add a Sema warning that MS ignores bitfield alignment in unions.
Warren Hunt8f8bad72013-10-11 20:19:00 +00002538 } else {
2539 // Round up the current record size to the field's alignment boundary.
Warren Huntd640d7d2014-01-09 00:30:56 +00002540 CharUnits FieldOffset = Size.RoundUpToAlignment(Info.Alignment);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002541 placeFieldAtOffset(FieldOffset);
2542 Size = FieldOffset;
David Majnemeradc45bb2014-04-13 08:15:50 +00002543 Alignment = std::max(Alignment, Info.Alignment);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002544 }
2545}
2546
Warren Huntd640d7d2014-01-09 00:30:56 +00002547void MicrosoftRecordLayoutBuilder::injectVBPtr(const CXXRecordDecl *RD) {
Warren Hunt6eba9072014-01-14 00:31:30 +00002548 if (!HasVBPtr || SharedVBPtrBase)
Warren Huntd640d7d2014-01-09 00:30:56 +00002549 return;
Warren Huntd640d7d2014-01-09 00:30:56 +00002550 // Inject the VBPointer at the injection site.
2551 CharUnits InjectionSite = VBPtrOffset;
2552 // But before we do, make sure it's properly aligned.
2553 VBPtrOffset = VBPtrOffset.RoundUpToAlignment(PointerInfo.Alignment);
2554 // Determine where the first field should be laid out after the vbptr.
2555 CharUnits FieldStart = VBPtrOffset + PointerInfo.Size;
2556 // Make sure that the amount we push the fields back by is a multiple of the
2557 // alignment.
David Majnemer79a1c892014-02-12 00:43:02 +00002558 CharUnits Offset = (FieldStart - InjectionSite).RoundUpToAlignment(
2559 std::max(RequiredAlignment, Alignment));
Warren Huntd640d7d2014-01-09 00:30:56 +00002560 // Increase the size of the object and push back all fields by the offset
2561 // amount.
2562 Size += Offset;
David Majnemerc964b4b2014-07-16 06:04:00 +00002563 for (uint64_t &FieldOffset : FieldOffsets)
2564 FieldOffset += Context.toBits(Offset);
2565 for (BaseOffsetsMapTy::value_type &Base : Bases)
2566 if (Base.second >= InjectionSite)
2567 Base.second += Offset;
Warren Huntd640d7d2014-01-09 00:30:56 +00002568}
2569
2570void MicrosoftRecordLayoutBuilder::injectVFPtr(const CXXRecordDecl *RD) {
2571 if (!HasOwnVFPtr)
2572 return;
2573 // Make sure that the amount we push the struct back by is a multiple of the
2574 // alignment.
David Majnemer79a1c892014-02-12 00:43:02 +00002575 CharUnits Offset = PointerInfo.Size.RoundUpToAlignment(
2576 std::max(RequiredAlignment, Alignment));
Warren Huntd640d7d2014-01-09 00:30:56 +00002577 // Increase the size of the object and push back all fields, the vbptr and all
2578 // bases by the offset amount.
2579 Size += Offset;
David Majnemerc964b4b2014-07-16 06:04:00 +00002580 for (uint64_t &FieldOffset : FieldOffsets)
2581 FieldOffset += Context.toBits(Offset);
Warren Huntd640d7d2014-01-09 00:30:56 +00002582 if (HasVBPtr)
2583 VBPtrOffset += Offset;
David Majnemerc964b4b2014-07-16 06:04:00 +00002584 for (BaseOffsetsMapTy::value_type &Base : Bases)
2585 Base.second += Offset;
Warren Huntd640d7d2014-01-09 00:30:56 +00002586}
2587
Warren Hunt8f8bad72013-10-11 20:19:00 +00002588void MicrosoftRecordLayoutBuilder::layoutVirtualBases(const CXXRecordDecl *RD) {
2589 if (!HasVBPtr)
2590 return;
Warren Huntd640d7d2014-01-09 00:30:56 +00002591 // Vtordisps are always 4 bytes (even in 64-bit mode)
2592 CharUnits VtorDispSize = CharUnits::fromQuantity(4);
2593 CharUnits VtorDispAlignment = VtorDispSize;
2594 // vtordisps respect pragma pack.
2595 if (!MaxFieldAlignment.isZero())
2596 VtorDispAlignment = std::min(VtorDispAlignment, MaxFieldAlignment);
2597 // The alignment of the vtordisp is at least the required alignment of the
2598 // entire record. This requirement may be present to support vtordisp
2599 // injection.
David Majnemerc964b4b2014-07-16 06:04:00 +00002600 for (const CXXBaseSpecifier &VBase : RD->vbases()) {
2601 const CXXRecordDecl *BaseDecl = VBase.getType()->getAsCXXRecordDecl();
David Majnemer79a1c892014-02-12 00:43:02 +00002602 const ASTRecordLayout &BaseLayout = Context.getASTRecordLayout(BaseDecl);
2603 RequiredAlignment =
2604 std::max(RequiredAlignment, BaseLayout.getRequiredAlignment());
2605 }
Warren Huntd640d7d2014-01-09 00:30:56 +00002606 VtorDispAlignment = std::max(VtorDispAlignment, RequiredAlignment);
2607 // Compute the vtordisp set.
2608 llvm::SmallPtrSet<const CXXRecordDecl *, 2> HasVtordispSet =
Warren Hunt8f8bad72013-10-11 20:19:00 +00002609 computeVtorDispSet(RD);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002610 // Iterate through the virtual bases and lay them out.
Craig Topper36250ad2014-05-12 05:36:57 +00002611 const ASTRecordLayout *PreviousBaseLayout = nullptr;
David Majnemerc964b4b2014-07-16 06:04:00 +00002612 for (const CXXBaseSpecifier &VBase : RD->vbases()) {
2613 const CXXRecordDecl *BaseDecl = VBase.getType()->getAsCXXRecordDecl();
Warren Huntd640d7d2014-01-09 00:30:56 +00002614 const ASTRecordLayout &BaseLayout = Context.getASTRecordLayout(BaseDecl);
2615 bool HasVtordisp = HasVtordispSet.count(BaseDecl);
Warren Huntd640d7d2014-01-09 00:30:56 +00002616 // Insert padding between two bases if the left first one is zero sized or
2617 // contains a zero sized subobject and the right is zero sized or one leads
2618 // with a zero sized base. The padding between virtual bases is 4
2619 // bytes (in both 32 and 64 bits modes) and always involves rounding up to
2620 // the required alignment, we don't know why.
Warren Hunt4f7efb72014-04-12 00:20:50 +00002621 if ((PreviousBaseLayout && PreviousBaseLayout->hasZeroSizedSubObject() &&
David Majnemerbf3d4302014-07-16 07:16:58 +00002622 BaseLayout.leadsWithZeroSizedBase()) || HasVtordisp) {
Warren Huntd640d7d2014-01-09 00:30:56 +00002623 Size = Size.RoundUpToAlignment(VtorDispAlignment) + VtorDispSize;
David Majnemera2464682014-07-17 00:55:19 +00002624 Alignment = std::max(VtorDispAlignment, Alignment);
David Majnemerbf3d4302014-07-16 07:16:58 +00002625 }
Warren Huntd640d7d2014-01-09 00:30:56 +00002626 // Insert the virtual base.
2627 ElementInfo Info = getAdjustedElementInfo(BaseLayout);
Warren Huntf4518def2014-01-10 01:28:05 +00002628 CharUnits BaseOffset = Size.RoundUpToAlignment(Info.Alignment);
Warren Huntd640d7d2014-01-09 00:30:56 +00002629 VBases.insert(std::make_pair(BaseDecl,
2630 ASTRecordLayout::VBaseInfo(BaseOffset, HasVtordisp)));
Warren Huntf6ec7482014-02-21 01:40:35 +00002631 Size = BaseOffset + BaseLayout.getNonVirtualSize();
Warren Huntd640d7d2014-01-09 00:30:56 +00002632 PreviousBaseLayout = &BaseLayout;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002633 }
2634}
2635
Warren Huntc3384312013-12-11 22:28:32 +00002636void MicrosoftRecordLayoutBuilder::finalizeLayout(const RecordDecl *RD) {
Warren Huntd640d7d2014-01-09 00:30:56 +00002637 // Respect required alignment. Note that in 32-bit mode Required alignment
2638 // may be 0 nad cause size not to be updated.
Warren Huntf6ec7482014-02-21 01:40:35 +00002639 DataSize = Size;
Warren Huntd640d7d2014-01-09 00:30:56 +00002640 if (!RequiredAlignment.isZero()) {
2641 Alignment = std::max(Alignment, RequiredAlignment);
Warren Hunt5d9eebf2014-04-10 22:15:18 +00002642 auto RoundingAlignment = Alignment;
2643 if (!MaxFieldAlignment.isZero())
2644 RoundingAlignment = std::min(RoundingAlignment, MaxFieldAlignment);
2645 RoundingAlignment = std::max(RoundingAlignment, RequiredAlignment);
2646 Size = Size.RoundUpToAlignment(RoundingAlignment);
Warren Huntd640d7d2014-01-09 00:30:56 +00002647 }
2648 // Zero-sized structures have size equal to their alignment.
Warren Hunt049f6732013-12-06 19:54:25 +00002649 if (Size.isZero()) {
Warren Hunt39a907b2014-04-09 21:57:24 +00002650 EndsWithZeroSizedObject = true;
Warren Hunt049f6732013-12-06 19:54:25 +00002651 LeadsWithZeroSizedBase = true;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002652 Size = Alignment;
Warren Hunt049f6732013-12-06 19:54:25 +00002653 }
Warren Hunt8f8bad72013-10-11 20:19:00 +00002654}
2655
Warren Hunt73f43982014-04-11 22:05:28 +00002656// Recursively walks the non-virtual bases of a class and determines if any of
2657// them are in the bases with overridden methods set.
David Majnemer12727642014-07-16 06:30:31 +00002658static bool
2659RequiresVtordisp(const llvm::SmallPtrSetImpl<const CXXRecordDecl *> &
2660 BasesWithOverriddenMethods,
2661 const CXXRecordDecl *RD) {
Warren Hunt73f43982014-04-11 22:05:28 +00002662 if (BasesWithOverriddenMethods.count(RD))
Warren Hunt8f8bad72013-10-11 20:19:00 +00002663 return true;
2664 // If any of a virtual bases non-virtual bases (recursively) requires a
2665 // vtordisp than so does this virtual base.
David Majnemerc964b4b2014-07-16 06:04:00 +00002666 for (const CXXBaseSpecifier &Base : RD->bases())
2667 if (!Base.isVirtual() &&
Warren Hunt73f43982014-04-11 22:05:28 +00002668 RequiresVtordisp(BasesWithOverriddenMethods,
David Majnemerc964b4b2014-07-16 06:04:00 +00002669 Base.getType()->getAsCXXRecordDecl()))
Warren Hunt8f8bad72013-10-11 20:19:00 +00002670 return true;
2671 return false;
2672}
2673
2674llvm::SmallPtrSet<const CXXRecordDecl *, 2>
2675MicrosoftRecordLayoutBuilder::computeVtorDispSet(const CXXRecordDecl *RD) {
Warren Huntd640d7d2014-01-09 00:30:56 +00002676 llvm::SmallPtrSet<const CXXRecordDecl *, 2> HasVtordispSet;
Reid Klecknerc0dca6d2014-02-12 23:50:26 +00002677
Reid Klecknerc0dca6d2014-02-12 23:50:26 +00002678 // /vd2 or #pragma vtordisp(2): Always use vtordisps for virtual bases with
2679 // vftables.
2680 if (RD->getMSVtorDispMode() == MSVtorDispAttr::ForVFTable) {
David Majnemerc964b4b2014-07-16 06:04:00 +00002681 for (const CXXBaseSpecifier &Base : RD->vbases()) {
2682 const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl();
Reid Klecknerc0dca6d2014-02-12 23:50:26 +00002683 const ASTRecordLayout &Layout = Context.getASTRecordLayout(BaseDecl);
2684 if (Layout.hasExtendableVFPtr())
2685 HasVtordispSet.insert(BaseDecl);
2686 }
2687 return HasVtordispSet;
2688 }
2689
Warren Hunt8f8bad72013-10-11 20:19:00 +00002690 // If any of our bases need a vtordisp for this type, so do we. Check our
2691 // direct bases for vtordisp requirements.
David Majnemerc964b4b2014-07-16 06:04:00 +00002692 for (const CXXBaseSpecifier &Base : RD->bases()) {
2693 const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl();
Warren Hunt8f8bad72013-10-11 20:19:00 +00002694 const ASTRecordLayout &Layout = Context.getASTRecordLayout(BaseDecl);
Reid Klecknercd612ab2014-04-11 16:57:42 +00002695 for (const auto &bi : Layout.getVBaseOffsetsMap())
2696 if (bi.second.hasVtorDisp())
2697 HasVtordispSet.insert(bi.first);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002698 }
David Majnemerd43388c2014-04-13 02:27:32 +00002699 // We don't introduce any additional vtordisps if either:
2700 // * A user declared constructor or destructor aren't declared.
2701 // * #pragma vtordisp(0) or the /vd0 flag are in use.
2702 if ((!RD->hasUserDeclaredConstructor() && !RD->hasUserDeclaredDestructor()) ||
2703 RD->getMSVtorDispMode() == MSVtorDispAttr::Never)
Warren Hunt73f43982014-04-11 22:05:28 +00002704 return HasVtordispSet;
David Majnemerd43388c2014-04-13 02:27:32 +00002705 // /vd1 or #pragma vtordisp(1): Try to guess based on whether we think it's
2706 // possible for a partially constructed object with virtual base overrides to
2707 // escape a non-trivial constructor.
2708 assert(RD->getMSVtorDispMode() == MSVtorDispAttr::ForVBaseOverride);
Warren Hunt73f43982014-04-11 22:05:28 +00002709 // Compute a set of base classes which define methods we override. A virtual
2710 // base in this set will require a vtordisp. A virtual base that transitively
2711 // contains one of these bases as a non-virtual base will also require a
2712 // vtordisp.
2713 llvm::SmallPtrSet<const CXXMethodDecl *, 8> Work;
2714 llvm::SmallPtrSet<const CXXRecordDecl *, 2> BasesWithOverriddenMethods;
2715 // Seed the working set with our non-destructor virtual methods.
David Majnemerc964b4b2014-07-16 06:04:00 +00002716 for (const CXXMethodDecl *MD : RD->methods())
2717 if (MD->isVirtual() && !isa<CXXDestructorDecl>(MD))
2718 Work.insert(MD);
Warren Hunt73f43982014-04-11 22:05:28 +00002719 while (!Work.empty()) {
2720 const CXXMethodDecl *MD = *Work.begin();
2721 CXXMethodDecl::method_iterator i = MD->begin_overridden_methods(),
2722 e = MD->end_overridden_methods();
2723 // If a virtual method has no-overrides it lives in its parent's vtable.
2724 if (i == e)
2725 BasesWithOverriddenMethods.insert(MD->getParent());
2726 else
2727 Work.insert(i, e);
2728 // We've finished processing this element, remove it from the working set.
2729 Work.erase(MD);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002730 }
Warren Hunt73f43982014-04-11 22:05:28 +00002731 // For each of our virtual bases, check if it is in the set of overridden
2732 // bases or if it transitively contains a non-virtual base that is.
David Majnemerc964b4b2014-07-16 06:04:00 +00002733 for (const CXXBaseSpecifier &Base : RD->vbases()) {
2734 const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl();
Warren Huntd640d7d2014-01-09 00:30:56 +00002735 if (!HasVtordispSet.count(BaseDecl) &&
Warren Hunt73f43982014-04-11 22:05:28 +00002736 RequiresVtordisp(BasesWithOverriddenMethods, BaseDecl))
Warren Huntd640d7d2014-01-09 00:30:56 +00002737 HasVtordispSet.insert(BaseDecl);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002738 }
Warren Huntd640d7d2014-01-09 00:30:56 +00002739 return HasVtordispSet;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002740}
2741
2742/// \brief Get or compute information about the layout of the specified record
2743/// (struct/union/class), which indicates its size and field position
2744/// information.
2745const ASTRecordLayout *
2746ASTContext::BuildMicrosoftASTRecordLayout(const RecordDecl *D) const {
2747 MicrosoftRecordLayoutBuilder Builder(*this);
2748 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
2749 Builder.cxxLayout(RD);
2750 return new (*this) ASTRecordLayout(
Warren Hunt7b252d22013-12-06 00:01:17 +00002751 *this, Builder.Size, Builder.Alignment, Builder.RequiredAlignment,
Warren Huntd640d7d2014-01-09 00:30:56 +00002752 Builder.HasOwnVFPtr,
2753 Builder.HasOwnVFPtr || Builder.PrimaryBase,
Warren Huntf6ec7482014-02-21 01:40:35 +00002754 Builder.VBPtrOffset, Builder.NonVirtualSize, Builder.FieldOffsets.data(),
2755 Builder.FieldOffsets.size(), Builder.NonVirtualSize,
Warren Huntd640d7d2014-01-09 00:30:56 +00002756 Builder.Alignment, CharUnits::Zero(), Builder.PrimaryBase,
Warren Hunt049f6732013-12-06 19:54:25 +00002757 false, Builder.SharedVBPtrBase,
Warren Hunt39a907b2014-04-09 21:57:24 +00002758 Builder.EndsWithZeroSizedObject, Builder.LeadsWithZeroSizedBase,
Warren Hunt049f6732013-12-06 19:54:25 +00002759 Builder.Bases, Builder.VBases);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002760 } else {
2761 Builder.layout(D);
2762 return new (*this) ASTRecordLayout(
Warren Hunt7b252d22013-12-06 00:01:17 +00002763 *this, Builder.Size, Builder.Alignment, Builder.RequiredAlignment,
2764 Builder.Size, Builder.FieldOffsets.data(), Builder.FieldOffsets.size());
Warren Hunt8f8bad72013-10-11 20:19:00 +00002765 }
2766}
2767
Anders Carlssondf291d82010-05-26 04:56:53 +00002768/// getASTRecordLayout - Get or compute information about the layout of the
2769/// specified record (struct/union/class), which indicates its size and field
2770/// position information.
Jay Foad39c79802011-01-12 09:06:06 +00002771const ASTRecordLayout &
2772ASTContext::getASTRecordLayout(const RecordDecl *D) const {
John McCall0710e552011-10-07 02:39:22 +00002773 // These asserts test different things. A record has a definition
2774 // as soon as we begin to parse the definition. That definition is
2775 // not a complete definition (which is what isDefinition() tests)
2776 // until we *finish* parsing the definition.
Sean Callanan56c19892012-02-08 00:04:52 +00002777
2778 if (D->hasExternalLexicalStorage() && !D->getDefinition())
2779 getExternalSource()->CompleteType(const_cast<RecordDecl*>(D));
2780
Anders Carlssondf291d82010-05-26 04:56:53 +00002781 D = D->getDefinition();
2782 assert(D && "Cannot get layout of forward declarations!");
Matt Beaumont-Gay35779952013-06-25 22:19:15 +00002783 assert(!D->isInvalidDecl() && "Cannot get layout of invalid decl!");
John McCallf937c022011-10-07 06:10:15 +00002784 assert(D->isCompleteDefinition() && "Cannot layout type before complete!");
Anders Carlssondf291d82010-05-26 04:56:53 +00002785
2786 // Look up this layout, if already laid out, return what we have.
2787 // Note that we can't save a reference to the entry because this function
2788 // is recursive.
2789 const ASTRecordLayout *Entry = ASTRecordLayouts[D];
2790 if (Entry) return *Entry;
2791
Craig Topper36250ad2014-05-12 05:36:57 +00002792 const ASTRecordLayout *NewEntry = nullptr;
Anders Carlssond2954862010-05-26 05:10:47 +00002793
Reid Kleckneraf1465c2014-02-20 23:07:29 +00002794 if (isMsLayout(D) && !D->getASTContext().getExternalSource()) {
Warren Hunt8f8bad72013-10-11 20:19:00 +00002795 NewEntry = BuildMicrosoftASTRecordLayout(D);
2796 } else if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
Anders Carlssonc121b4e2010-05-27 00:07:01 +00002797 EmptySubobjectMap EmptySubobjects(*this, RD);
John McCall0153cd32011-11-08 04:01:03 +00002798 RecordLayoutBuilder Builder(*this, &EmptySubobjects);
2799 Builder.Layout(RD);
Anders Carlsson439edd12010-05-27 05:41:06 +00002800
John McCall5c1f1d02013-01-29 01:14:22 +00002801 // In certain situations, we are allowed to lay out objects in the
2802 // tail-padding of base classes. This is ABI-dependent.
2803 // FIXME: this should be stored in the record layout.
2804 bool skipTailPadding =
2805 mustSkipTailPadding(getTargetInfo().getCXXABI(), cast<CXXRecordDecl>(D));
Anders Carlssond2954862010-05-26 05:10:47 +00002806
2807 // FIXME: This should be done in FinalizeLayout.
Ken Dyck1b4420e2011-02-28 02:01:38 +00002808 CharUnits DataSize =
John McCall5c1f1d02013-01-29 01:14:22 +00002809 skipTailPadding ? Builder.getSize() : Builder.getDataSize();
Ken Dyck1b4420e2011-02-28 02:01:38 +00002810 CharUnits NonVirtualSize =
John McCall5c1f1d02013-01-29 01:14:22 +00002811 skipTailPadding ? DataSize : Builder.NonVirtualSize;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00002812 NewEntry =
John McCall0153cd32011-11-08 04:01:03 +00002813 new (*this) ASTRecordLayout(*this, Builder.getSize(),
2814 Builder.Alignment,
Warren Hunt7b252d22013-12-06 00:01:17 +00002815 /*RequiredAlignment : used by MS-ABI)*/
2816 Builder.Alignment,
John McCalle42a3362012-05-01 08:55:32 +00002817 Builder.HasOwnVFPtr,
Warren Hunt8f8bad72013-10-11 20:19:00 +00002818 RD->isDynamicClass(),
Warren Hunt55d8e822013-10-23 23:53:07 +00002819 CharUnits::fromQuantity(-1),
Ken Dyck1b4420e2011-02-28 02:01:38 +00002820 DataSize,
John McCall0153cd32011-11-08 04:01:03 +00002821 Builder.FieldOffsets.data(),
2822 Builder.FieldOffsets.size(),
Ken Dyckaf1c83f2011-02-16 01:52:01 +00002823 NonVirtualSize,
John McCall0153cd32011-11-08 04:01:03 +00002824 Builder.NonVirtualAlignment,
Anders Carlssonc121b4e2010-05-27 00:07:01 +00002825 EmptySubobjects.SizeOfLargestEmptySubobject,
John McCall0153cd32011-11-08 04:01:03 +00002826 Builder.PrimaryBase,
2827 Builder.PrimaryBaseIsVirtual,
Craig Topper36250ad2014-05-12 05:36:57 +00002828 nullptr, false, false,
John McCall0153cd32011-11-08 04:01:03 +00002829 Builder.Bases, Builder.VBases);
Anders Carlssond2954862010-05-26 05:10:47 +00002830 } else {
Craig Topper36250ad2014-05-12 05:36:57 +00002831 RecordLayoutBuilder Builder(*this, /*EmptySubobjects=*/nullptr);
Anders Carlssond2954862010-05-26 05:10:47 +00002832 Builder.Layout(D);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00002833
Anders Carlssond2954862010-05-26 05:10:47 +00002834 NewEntry =
Ken Dyck1b4420e2011-02-28 02:01:38 +00002835 new (*this) ASTRecordLayout(*this, Builder.getSize(),
Ken Dyck4731d5b2011-02-16 02:05:21 +00002836 Builder.Alignment,
Warren Hunt7b252d22013-12-06 00:01:17 +00002837 /*RequiredAlignment : used by MS-ABI)*/
2838 Builder.Alignment,
Ken Dyck1b4420e2011-02-28 02:01:38 +00002839 Builder.getSize(),
Anders Carlssond2954862010-05-26 05:10:47 +00002840 Builder.FieldOffsets.data(),
2841 Builder.FieldOffsets.size());
2842 }
2843
Anders Carlssondf291d82010-05-26 04:56:53 +00002844 ASTRecordLayouts[D] = NewEntry;
2845
David Blaikiebbafb8a2012-03-11 07:00:24 +00002846 if (getLangOpts().DumpRecordLayouts) {
Argyrios Kyrtzidis8ade08e2013-07-12 22:30:03 +00002847 llvm::outs() << "\n*** Dumping AST Record Layout\n";
2848 DumpRecordLayout(D, llvm::outs(), getLangOpts().DumpRecordLayoutsSimple);
Anders Carlssondf291d82010-05-26 04:56:53 +00002849 }
2850
2851 return *NewEntry;
2852}
2853
John McCall6bd2a892013-01-25 22:31:03 +00002854const CXXMethodDecl *ASTContext::getCurrentKeyFunction(const CXXRecordDecl *RD) {
Reid Kleckner5d7f2982013-05-29 16:18:30 +00002855 if (!getTargetInfo().getCXXABI().hasKeyFunctions())
Craig Topper36250ad2014-05-12 05:36:57 +00002856 return nullptr;
Reid Kleckner5d7f2982013-05-29 16:18:30 +00002857
John McCall6bd2a892013-01-25 22:31:03 +00002858 assert(RD->getDefinition() && "Cannot get key function for forward decl!");
Anders Carlssondf291d82010-05-26 04:56:53 +00002859 RD = cast<CXXRecordDecl>(RD->getDefinition());
Daniel Dunbar592a85c2010-05-27 02:25:46 +00002860
Richard Smitha9a1c682014-07-07 06:38:20 +00002861 // Beware:
2862 // 1) computing the key function might trigger deserialization, which might
2863 // invalidate iterators into KeyFunctions
2864 // 2) 'get' on the LazyDeclPtr might also trigger deserialization and
2865 // invalidate the LazyDeclPtr within the map itself
2866 LazyDeclPtr Entry = KeyFunctions[RD];
2867 const Decl *Result =
2868 Entry ? Entry.get(getExternalSource()) : computeKeyFunction(*this, RD);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00002869
Richard Smitha9a1c682014-07-07 06:38:20 +00002870 // Store it back if it changed.
2871 if (Entry.isOffset() || Entry.isValid() != bool(Result))
2872 KeyFunctions[RD] = const_cast<Decl*>(Result);
2873
2874 return cast_or_null<CXXMethodDecl>(Result);
John McCall6bd2a892013-01-25 22:31:03 +00002875}
2876
Richard Smith676c4042013-08-29 23:59:27 +00002877void ASTContext::setNonKeyFunction(const CXXMethodDecl *Method) {
Rafael Espindola8db352d2013-10-17 15:37:26 +00002878 assert(Method == Method->getFirstDecl() &&
John McCall6bd2a892013-01-25 22:31:03 +00002879 "not working with method declaration from class definition");
2880
2881 // Look up the cache entry. Since we're working with the first
2882 // declaration, its parent must be the class definition, which is
2883 // the correct key for the KeyFunctions hash.
Richard Smith676c4042013-08-29 23:59:27 +00002884 llvm::DenseMap<const CXXRecordDecl*, LazyDeclPtr>::iterator
2885 I = KeyFunctions.find(Method->getParent());
John McCall6bd2a892013-01-25 22:31:03 +00002886
2887 // If it's not cached, there's nothing to do.
Richard Smith676c4042013-08-29 23:59:27 +00002888 if (I == KeyFunctions.end()) return;
John McCall6bd2a892013-01-25 22:31:03 +00002889
2890 // If it is cached, check whether it's the target method, and if so,
Richard Smitha9a1c682014-07-07 06:38:20 +00002891 // remove it from the cache. Note, the call to 'get' might invalidate
2892 // the iterator and the LazyDeclPtr object within the map.
2893 LazyDeclPtr Ptr = I->second;
2894 if (Ptr.get(getExternalSource()) == Method) {
John McCall6bd2a892013-01-25 22:31:03 +00002895 // FIXME: remember that we did this for module / chained PCH state?
Richard Smitha9a1c682014-07-07 06:38:20 +00002896 KeyFunctions.erase(Method->getParent());
John McCall6bd2a892013-01-25 22:31:03 +00002897 }
Anders Carlssondf291d82010-05-26 04:56:53 +00002898}
2899
Richard Smithdafff942012-01-14 04:30:29 +00002900static uint64_t getFieldOffset(const ASTContext &C, const FieldDecl *FD) {
2901 const ASTRecordLayout &Layout = C.getASTRecordLayout(FD->getParent());
2902 return Layout.getFieldOffset(FD->getFieldIndex());
2903}
2904
2905uint64_t ASTContext::getFieldOffset(const ValueDecl *VD) const {
2906 uint64_t OffsetInBits;
2907 if (const FieldDecl *FD = dyn_cast<FieldDecl>(VD)) {
2908 OffsetInBits = ::getFieldOffset(*this, FD);
2909 } else {
2910 const IndirectFieldDecl *IFD = cast<IndirectFieldDecl>(VD);
2911
2912 OffsetInBits = 0;
David Majnemerc964b4b2014-07-16 06:04:00 +00002913 for (const NamedDecl *ND : IFD->chain())
2914 OffsetInBits += ::getFieldOffset(*this, cast<FieldDecl>(ND));
Richard Smithdafff942012-01-14 04:30:29 +00002915 }
2916
2917 return OffsetInBits;
2918}
2919
Eric Christopher8a39a012011-10-05 06:00:51 +00002920/// getObjCLayout - Get or compute information about the layout of the
2921/// given interface.
Anders Carlssondf291d82010-05-26 04:56:53 +00002922///
2923/// \param Impl - If given, also include the layout of the interface's
2924/// implementation. This may differ by including synthesized ivars.
2925const ASTRecordLayout &
2926ASTContext::getObjCLayout(const ObjCInterfaceDecl *D,
Jay Foad39c79802011-01-12 09:06:06 +00002927 const ObjCImplementationDecl *Impl) const {
Douglas Gregor64d92572011-12-20 15:50:13 +00002928 // Retrieve the definition
Sean Callanand9a909c2012-03-15 16:33:08 +00002929 if (D->hasExternalLexicalStorage() && !D->getDefinition())
2930 getExternalSource()->CompleteType(const_cast<ObjCInterfaceDecl*>(D));
Douglas Gregor64d92572011-12-20 15:50:13 +00002931 D = D->getDefinition();
2932 assert(D && D->isThisDeclarationADefinition() && "Invalid interface decl!");
Anders Carlssondf291d82010-05-26 04:56:53 +00002933
2934 // Look up this layout, if already laid out, return what we have.
Roman Divackye6377112012-09-06 15:59:27 +00002935 const ObjCContainerDecl *Key =
2936 Impl ? (const ObjCContainerDecl*) Impl : (const ObjCContainerDecl*) D;
Anders Carlssondf291d82010-05-26 04:56:53 +00002937 if (const ASTRecordLayout *Entry = ObjCLayouts[Key])
2938 return *Entry;
2939
2940 // Add in synthesized ivar count if laying out an implementation.
2941 if (Impl) {
2942 unsigned SynthCount = CountNonClassIvars(D);
2943 // If there aren't any sythesized ivars then reuse the interface
2944 // entry. Note we can't cache this because we simply free all
2945 // entries later; however we shouldn't look up implementations
2946 // frequently.
2947 if (SynthCount == 0)
Craig Topper36250ad2014-05-12 05:36:57 +00002948 return getObjCLayout(D, nullptr);
Anders Carlssondf291d82010-05-26 04:56:53 +00002949 }
2950
Craig Topper36250ad2014-05-12 05:36:57 +00002951 RecordLayoutBuilder Builder(*this, /*EmptySubobjects=*/nullptr);
Anders Carlsson6ed3a9a2010-05-26 05:04:25 +00002952 Builder.Layout(D);
2953
Anders Carlssondf291d82010-05-26 04:56:53 +00002954 const ASTRecordLayout *NewEntry =
Ken Dyck1b4420e2011-02-28 02:01:38 +00002955 new (*this) ASTRecordLayout(*this, Builder.getSize(),
Ken Dyck4731d5b2011-02-16 02:05:21 +00002956 Builder.Alignment,
Warren Hunt7b252d22013-12-06 00:01:17 +00002957 /*RequiredAlignment : used by MS-ABI)*/
2958 Builder.Alignment,
Ken Dyck1b4420e2011-02-28 02:01:38 +00002959 Builder.getDataSize(),
Anders Carlsson6ed3a9a2010-05-26 05:04:25 +00002960 Builder.FieldOffsets.data(),
2961 Builder.FieldOffsets.size());
Daniel Dunbar592a85c2010-05-27 02:25:46 +00002962
Anders Carlssondf291d82010-05-26 04:56:53 +00002963 ObjCLayouts[Key] = NewEntry;
2964
2965 return *NewEntry;
2966}
2967
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002968static void PrintOffset(raw_ostream &OS,
Anders Carlsson3f018712010-10-31 23:45:59 +00002969 CharUnits Offset, unsigned IndentLevel) {
Benjamin Kramer96ad7172011-11-05 09:02:52 +00002970 OS << llvm::format("%4" PRId64 " | ", (int64_t)Offset.getQuantity());
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002971 OS.indent(IndentLevel * 2);
2972}
2973
Eli Benderskyf6f93ee2012-12-08 00:07:24 +00002974static void PrintIndentNoOffset(raw_ostream &OS, unsigned IndentLevel) {
2975 OS << " | ";
2976 OS.indent(IndentLevel * 2);
2977}
2978
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002979static void DumpCXXRecordLayout(raw_ostream &OS,
Jay Foad39c79802011-01-12 09:06:06 +00002980 const CXXRecordDecl *RD, const ASTContext &C,
Anders Carlsson3f018712010-10-31 23:45:59 +00002981 CharUnits Offset,
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002982 unsigned IndentLevel,
2983 const char* Description,
2984 bool IncludeVirtualBases) {
Anders Carlsson3f018712010-10-31 23:45:59 +00002985 const ASTRecordLayout &Layout = C.getASTRecordLayout(RD);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002986
2987 PrintOffset(OS, Offset, IndentLevel);
Dan Gohman145f3f12010-04-19 16:39:44 +00002988 OS << C.getTypeDeclType(const_cast<CXXRecordDecl *>(RD)).getAsString();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002989 if (Description)
2990 OS << ' ' << Description;
2991 if (RD->isEmpty())
2992 OS << " (empty)";
2993 OS << '\n';
2994
2995 IndentLevel++;
2996
Anders Carlsson3f018712010-10-31 23:45:59 +00002997 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
Warren Hunt8f8bad72013-10-11 20:19:00 +00002998 bool HasOwnVFPtr = Layout.hasOwnVFPtr();
2999 bool HasOwnVBPtr = Layout.hasOwnVBPtr();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003000
3001 // Vtable pointer.
Warren Hunt8f8bad72013-10-11 20:19:00 +00003002 if (RD->isDynamicClass() && !PrimaryBase && !isMsLayout(RD)) {
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003003 PrintOffset(OS, Offset, IndentLevel);
Benjamin Kramerb89514a2011-10-14 18:45:37 +00003004 OS << '(' << *RD << " vtable pointer)\n";
Warren Hunt8f8bad72013-10-11 20:19:00 +00003005 } else if (HasOwnVFPtr) {
3006 PrintOffset(OS, Offset, IndentLevel);
3007 // vfptr (for Microsoft C++ ABI)
3008 OS << '(' << *RD << " vftable pointer)\n";
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003009 }
Warren Hunt8f8bad72013-10-11 20:19:00 +00003010
Reid Klecknerad59deb2014-02-28 01:03:09 +00003011 // Collect nvbases.
3012 SmallVector<const CXXRecordDecl *, 4> Bases;
David Majnemerc964b4b2014-07-16 06:04:00 +00003013 for (const CXXBaseSpecifier &Base : RD->bases()) {
3014 assert(!Base.getType()->isDependentType() &&
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003015 "Cannot layout class with dependent bases.");
David Majnemerc964b4b2014-07-16 06:04:00 +00003016 if (!Base.isVirtual())
3017 Bases.push_back(Base.getType()->getAsCXXRecordDecl());
Reid Klecknerad59deb2014-02-28 01:03:09 +00003018 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003019
Reid Klecknerad59deb2014-02-28 01:03:09 +00003020 // Sort nvbases by offset.
Benjamin Kramerbbdd7642014-03-01 14:48:57 +00003021 std::stable_sort(Bases.begin(), Bases.end(),
3022 [&](const CXXRecordDecl *L, const CXXRecordDecl *R) {
3023 return Layout.getBaseClassOffset(L) < Layout.getBaseClassOffset(R);
3024 });
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003025
Reid Klecknerad59deb2014-02-28 01:03:09 +00003026 // Dump (non-virtual) bases
David Majnemerc964b4b2014-07-16 06:04:00 +00003027 for (const CXXRecordDecl *Base : Bases) {
Anders Carlsson3f018712010-10-31 23:45:59 +00003028 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003029 DumpCXXRecordLayout(OS, Base, C, BaseOffset, IndentLevel,
3030 Base == PrimaryBase ? "(primary base)" : "(base)",
3031 /*IncludeVirtualBases=*/false);
3032 }
Eli Friedman43114f92011-10-21 22:49:56 +00003033
Warren Hunt8f8bad72013-10-11 20:19:00 +00003034 // vbptr (for Microsoft C++ ABI)
3035 if (HasOwnVBPtr) {
Eli Friedman84d2d3a2011-09-27 19:12:27 +00003036 PrintOffset(OS, Offset + Layout.getVBPtrOffset(), IndentLevel);
Benjamin Kramerb89514a2011-10-14 18:45:37 +00003037 OS << '(' << *RD << " vbtable pointer)\n";
Eli Friedman84d2d3a2011-09-27 19:12:27 +00003038 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003039
3040 // Dump fields.
3041 uint64_t FieldNo = 0;
3042 for (CXXRecordDecl::field_iterator I = RD->field_begin(),
3043 E = RD->field_end(); I != E; ++I, ++FieldNo) {
David Blaikie40ed2972012-06-06 20:45:41 +00003044 const FieldDecl &Field = **I;
Anders Carlsson3f018712010-10-31 23:45:59 +00003045 CharUnits FieldOffset = Offset +
Ken Dyck86a7fcc2011-01-18 01:56:16 +00003046 C.toCharUnitsFromBits(Layout.getFieldOffset(FieldNo));
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003047
Reid Klecknercd612ab2014-04-11 16:57:42 +00003048 if (const CXXRecordDecl *D = Field.getType()->getAsCXXRecordDecl()) {
3049 DumpCXXRecordLayout(OS, D, C, FieldOffset, IndentLevel,
3050 Field.getName().data(),
3051 /*IncludeVirtualBases=*/true);
3052 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003053 }
3054
3055 PrintOffset(OS, FieldOffset, IndentLevel);
David Blaikie2d7c57e2012-04-30 02:36:29 +00003056 OS << Field.getType().getAsString() << ' ' << Field << '\n';
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003057 }
3058
3059 if (!IncludeVirtualBases)
3060 return;
3061
3062 // Dump virtual bases.
John McCalle42a3362012-05-01 08:55:32 +00003063 const ASTRecordLayout::VBaseOffsetsMapTy &vtordisps =
3064 Layout.getVBaseOffsetsMap();
David Majnemerc964b4b2014-07-16 06:04:00 +00003065 for (const CXXBaseSpecifier &Base : RD->vbases()) {
3066 assert(Base.isVirtual() && "Found non-virtual class!");
3067 const CXXRecordDecl *VBase = Base.getType()->getAsCXXRecordDecl();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003068
Anders Carlsson3f018712010-10-31 23:45:59 +00003069 CharUnits VBaseOffset = Offset + Layout.getVBaseClassOffset(VBase);
John McCalle42a3362012-05-01 08:55:32 +00003070
3071 if (vtordisps.find(VBase)->second.hasVtorDisp()) {
3072 PrintOffset(OS, VBaseOffset - CharUnits::fromQuantity(4), IndentLevel);
3073 OS << "(vtordisp for vbase " << *VBase << ")\n";
3074 }
3075
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003076 DumpCXXRecordLayout(OS, VBase, C, VBaseOffset, IndentLevel,
3077 VBase == PrimaryBase ?
3078 "(primary virtual base)" : "(virtual base)",
3079 /*IncludeVirtualBases=*/false);
3080 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003081
Eli Benderskyf6f93ee2012-12-08 00:07:24 +00003082 PrintIndentNoOffset(OS, IndentLevel - 1);
3083 OS << "[sizeof=" << Layout.getSize().getQuantity();
Warren Hunt8f8bad72013-10-11 20:19:00 +00003084 if (!isMsLayout(RD))
3085 OS << ", dsize=" << Layout.getDataSize().getQuantity();
Ken Dyck7ad11e72011-02-15 02:32:40 +00003086 OS << ", align=" << Layout.getAlignment().getQuantity() << '\n';
Eli Benderskyf6f93ee2012-12-08 00:07:24 +00003087
3088 PrintIndentNoOffset(OS, IndentLevel - 1);
3089 OS << " nvsize=" << Layout.getNonVirtualSize().getQuantity();
Warren Huntd640d7d2014-01-09 00:30:56 +00003090 OS << ", nvalign=" << Layout.getNonVirtualAlignment().getQuantity() << "]\n";
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003091}
Daniel Dunbarccabe482010-04-19 20:44:53 +00003092
3093void ASTContext::DumpRecordLayout(const RecordDecl *RD,
Douglas Gregore9fc3772012-01-26 07:55:45 +00003094 raw_ostream &OS,
3095 bool Simple) const {
Daniel Dunbarccabe482010-04-19 20:44:53 +00003096 const ASTRecordLayout &Info = getASTRecordLayout(RD);
3097
3098 if (const CXXRecordDecl *CXXRD = dyn_cast<CXXRecordDecl>(RD))
Douglas Gregore9fc3772012-01-26 07:55:45 +00003099 if (!Simple)
Craig Topper36250ad2014-05-12 05:36:57 +00003100 return DumpCXXRecordLayout(OS, CXXRD, *this, CharUnits(), 0, nullptr,
Douglas Gregore9fc3772012-01-26 07:55:45 +00003101 /*IncludeVirtualBases=*/true);
Daniel Dunbarccabe482010-04-19 20:44:53 +00003102
3103 OS << "Type: " << getTypeDeclType(RD).getAsString() << "\n";
Douglas Gregore9fc3772012-01-26 07:55:45 +00003104 if (!Simple) {
3105 OS << "Record: ";
3106 RD->dump();
3107 }
Daniel Dunbarccabe482010-04-19 20:44:53 +00003108 OS << "\nLayout: ";
3109 OS << "<ASTRecordLayout\n";
Ken Dyckb0fcc592011-02-11 01:54:29 +00003110 OS << " Size:" << toBits(Info.getSize()) << "\n";
Warren Hunt8f8bad72013-10-11 20:19:00 +00003111 if (!isMsLayout(RD))
3112 OS << " DataSize:" << toBits(Info.getDataSize()) << "\n";
Ken Dyck7ad11e72011-02-15 02:32:40 +00003113 OS << " Alignment:" << toBits(Info.getAlignment()) << "\n";
Daniel Dunbarccabe482010-04-19 20:44:53 +00003114 OS << " FieldOffsets: [";
3115 for (unsigned i = 0, e = Info.getFieldCount(); i != e; ++i) {
3116 if (i) OS << ", ";
3117 OS << Info.getFieldOffset(i);
3118 }
3119 OS << "]>\n";
3120}