blob: edef526fa66c60374b814d12c7f1460e1245c0ad [file] [log] [blame]
Anders Carlsson35a36eb2010-05-26 05:41:04 +00001//=== RecordLayoutBuilder.cpp - Helper class for building record layouts ---==//
Anders Carlsson79474332009-07-18 20:20:21 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9
Chandler Carruth3a022472012-12-04 09:13:33 +000010#include "clang/AST/RecordLayout.h"
Benjamin Kramer2ef30312012-07-04 18:45:14 +000011#include "clang/AST/ASTContext.h"
Anders Carlsson79474332009-07-18 20:20:21 +000012#include "clang/AST/Attr.h"
Anders Carlsson5adde292010-11-24 22:55:48 +000013#include "clang/AST/CXXInheritance.h"
Anders Carlsson79474332009-07-18 20:20:21 +000014#include "clang/AST/Decl.h"
Anders Carlsson6d9f6f32009-07-19 00:18:47 +000015#include "clang/AST/DeclCXX.h"
Anders Carlsson4f516282009-07-18 20:50:59 +000016#include "clang/AST/DeclObjC.h"
Anders Carlsson79474332009-07-18 20:20:21 +000017#include "clang/AST/Expr.h"
Anders Carlsson79474332009-07-18 20:20:21 +000018#include "clang/Basic/TargetInfo.h"
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +000019#include "clang/Sema/SemaDiagnostic.h"
Daniel Dunbaraa423af2010-04-08 02:59:49 +000020#include "llvm/ADT/SmallSet.h"
Ted Kremenekf75d0892011-03-19 01:00:36 +000021#include "llvm/Support/CrashRecoveryContext.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000022#include "llvm/Support/Format.h"
23#include "llvm/Support/MathExtras.h"
Anders Carlsson79474332009-07-18 20:20:21 +000024
25using namespace clang;
26
Benjamin Kramerc7656cd2010-05-26 09:58:31 +000027namespace {
Anders Carlssonf58de112010-05-26 15:32:58 +000028
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000029/// BaseSubobjectInfo - Represents a single base subobject in a complete class.
30/// For a class hierarchy like
31///
32/// class A { };
33/// class B : A { };
34/// class C : A, B { };
35///
36/// The BaseSubobjectInfo graph for C will have three BaseSubobjectInfo
37/// instances, one for B and two for A.
38///
39/// If a base is virtual, it will only have one BaseSubobjectInfo allocated.
40struct BaseSubobjectInfo {
41 /// Class - The class for this base info.
Anders Carlsson056818f2010-05-28 21:13:31 +000042 const CXXRecordDecl *Class;
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000043
44 /// IsVirtual - Whether the BaseInfo represents a virtual base or not.
Anders Carlsson056818f2010-05-28 21:13:31 +000045 bool IsVirtual;
46
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000047 /// Bases - Information about the base subobjects.
Chris Lattner0e62c1c2011-07-23 10:55:15 +000048 SmallVector<BaseSubobjectInfo*, 4> Bases;
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000049
Anders Carlssone3c24c72010-05-29 17:35:14 +000050 /// PrimaryVirtualBaseInfo - Holds the base info for the primary virtual base
51 /// of this base info (if one exists).
52 BaseSubobjectInfo *PrimaryVirtualBaseInfo;
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000053
54 // FIXME: Document.
55 const BaseSubobjectInfo *Derived;
Anders Carlsson056818f2010-05-28 21:13:31 +000056};
57
Anders Carlssonf58de112010-05-26 15:32:58 +000058/// EmptySubobjectMap - Keeps track of which empty subobjects exist at different
59/// offsets while laying out a C++ class.
60class EmptySubobjectMap {
Jay Foad39c79802011-01-12 09:06:06 +000061 const ASTContext &Context;
Anders Carlsson233e2722010-10-31 21:54:55 +000062 uint64_t CharWidth;
63
Anders Carlssonf58de112010-05-26 15:32:58 +000064 /// Class - The class whose empty entries we're keeping track of.
65 const CXXRecordDecl *Class;
Daniel Dunbar592a85c2010-05-27 02:25:46 +000066
Anders Carlsson439edd12010-05-27 05:41:06 +000067 /// EmptyClassOffsets - A map from offsets to empty record decls.
Chris Lattner0e62c1c2011-07-23 10:55:15 +000068 typedef SmallVector<const CXXRecordDecl *, 1> ClassVectorTy;
Anders Carlssonf8f756d2010-10-31 21:22:43 +000069 typedef llvm::DenseMap<CharUnits, ClassVectorTy> EmptyClassOffsetsMapTy;
Anders Carlsson439edd12010-05-27 05:41:06 +000070 EmptyClassOffsetsMapTy EmptyClassOffsets;
71
Anders Carlssoncc5de092010-06-08 15:56:03 +000072 /// MaxEmptyClassOffset - The highest offset known to contain an empty
73 /// base subobject.
Anders Carlsson725190f2010-10-31 21:39:24 +000074 CharUnits MaxEmptyClassOffset;
Anders Carlssoncc5de092010-06-08 15:56:03 +000075
Daniel Dunbar592a85c2010-05-27 02:25:46 +000076 /// ComputeEmptySubobjectSizes - Compute the size of the largest base or
Anders Carlssonc5ca1f72010-05-26 15:54:25 +000077 /// member subobject that is empty.
78 void ComputeEmptySubobjectSizes();
Anders Carlsson439edd12010-05-27 05:41:06 +000079
Anders Carlsson725190f2010-10-31 21:39:24 +000080 void AddSubobjectAtOffset(const CXXRecordDecl *RD, CharUnits Offset);
Anders Carlssondb319762010-05-27 18:20:57 +000081
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000082 void UpdateEmptyBaseSubobjects(const BaseSubobjectInfo *Info,
Anders Carlsson28466ab2010-10-31 22:13:23 +000083 CharUnits Offset, bool PlacingEmptyBase);
Anders Carlsson439edd12010-05-27 05:41:06 +000084
Anders Carlssondb319762010-05-27 18:20:57 +000085 void UpdateEmptyFieldSubobjects(const CXXRecordDecl *RD,
86 const CXXRecordDecl *Class,
Anders Carlsson28466ab2010-10-31 22:13:23 +000087 CharUnits Offset);
88 void UpdateEmptyFieldSubobjects(const FieldDecl *FD, CharUnits Offset);
Anders Carlssondb319762010-05-27 18:20:57 +000089
Anders Carlssoncc5de092010-06-08 15:56:03 +000090 /// AnyEmptySubobjectsBeyondOffset - Returns whether there are any empty
91 /// subobjects beyond the given offset.
Anders Carlsson725190f2010-10-31 21:39:24 +000092 bool AnyEmptySubobjectsBeyondOffset(CharUnits Offset) const {
Anders Carlssoncc5de092010-06-08 15:56:03 +000093 return Offset <= MaxEmptyClassOffset;
94 }
95
Anders Carlsson233e2722010-10-31 21:54:55 +000096 CharUnits
97 getFieldOffset(const ASTRecordLayout &Layout, unsigned FieldNo) const {
98 uint64_t FieldOffset = Layout.getFieldOffset(FieldNo);
99 assert(FieldOffset % CharWidth == 0 &&
100 "Field offset not at char boundary!");
101
Ken Dyck7c4026b2011-01-24 01:28:50 +0000102 return Context.toCharUnitsFromBits(FieldOffset);
Anders Carlssonf8f756d2010-10-31 21:22:43 +0000103 }
Anders Carlssonf8f756d2010-10-31 21:22:43 +0000104
Charles Davisc2c576a2010-08-19 00:55:19 +0000105protected:
Anders Carlsson725190f2010-10-31 21:39:24 +0000106 bool CanPlaceSubobjectAtOffset(const CXXRecordDecl *RD,
107 CharUnits Offset) const;
Charles Davisc2c576a2010-08-19 00:55:19 +0000108
109 bool CanPlaceBaseSubobjectAtOffset(const BaseSubobjectInfo *Info,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000110 CharUnits Offset);
Charles Davisc2c576a2010-08-19 00:55:19 +0000111
112 bool CanPlaceFieldSubobjectAtOffset(const CXXRecordDecl *RD,
113 const CXXRecordDecl *Class,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000114 CharUnits Offset) const;
Charles Davisc2c576a2010-08-19 00:55:19 +0000115 bool CanPlaceFieldSubobjectAtOffset(const FieldDecl *FD,
Anders Carlsson233e2722010-10-31 21:54:55 +0000116 CharUnits Offset) const;
Charles Davisc2c576a2010-08-19 00:55:19 +0000117
Anders Carlssonf58de112010-05-26 15:32:58 +0000118public:
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000119 /// This holds the size of the largest empty subobject (either a base
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000120 /// or a member). Will be zero if the record being built doesn't contain
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000121 /// any empty classes.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000122 CharUnits SizeOfLargestEmptySubobject;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000123
Jay Foad39c79802011-01-12 09:06:06 +0000124 EmptySubobjectMap(const ASTContext &Context, const CXXRecordDecl *Class)
Anders Carlsson28466ab2010-10-31 22:13:23 +0000125 : Context(Context), CharWidth(Context.getCharWidth()), Class(Class) {
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000126 ComputeEmptySubobjectSizes();
127 }
128
129 /// CanPlaceBaseAtOffset - Return whether the given base class can be placed
130 /// at the given offset.
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000131 /// Returns false if placing the record will result in two components
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000132 /// (direct or indirect) of the same type having the same offset.
Anders Carlssoncc5de092010-06-08 15:56:03 +0000133 bool CanPlaceBaseAtOffset(const BaseSubobjectInfo *Info,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000134 CharUnits Offset);
Anders Carlssondb319762010-05-27 18:20:57 +0000135
136 /// CanPlaceFieldAtOffset - Return whether a field can be placed at the given
137 /// offset.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000138 bool CanPlaceFieldAtOffset(const FieldDecl *FD, CharUnits Offset);
Anders Carlssonf58de112010-05-26 15:32:58 +0000139};
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000140
141void EmptySubobjectMap::ComputeEmptySubobjectSizes() {
142 // Check the bases.
143 for (CXXRecordDecl::base_class_const_iterator I = Class->bases_begin(),
144 E = Class->bases_end(); I != E; ++I) {
145 const CXXRecordDecl *BaseDecl =
146 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
147
Anders Carlsson28466ab2010-10-31 22:13:23 +0000148 CharUnits EmptySize;
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000149 const ASTRecordLayout &Layout = Context.getASTRecordLayout(BaseDecl);
150 if (BaseDecl->isEmpty()) {
151 // If the class decl is empty, get its size.
Ken Dyckc8ae5502011-02-09 01:59:34 +0000152 EmptySize = Layout.getSize();
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000153 } else {
154 // Otherwise, we get the largest empty subobject for the decl.
155 EmptySize = Layout.getSizeOfLargestEmptySubobject();
156 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000157
Anders Carlsson28466ab2010-10-31 22:13:23 +0000158 if (EmptySize > SizeOfLargestEmptySubobject)
159 SizeOfLargestEmptySubobject = EmptySize;
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000160 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000161
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000162 // Check the fields.
163 for (CXXRecordDecl::field_iterator I = Class->field_begin(),
164 E = Class->field_end(); I != E; ++I) {
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000165
166 const RecordType *RT =
David Blaikie40ed2972012-06-06 20:45:41 +0000167 Context.getBaseElementType(I->getType())->getAs<RecordType>();
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000168
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000169 // We only care about record types.
170 if (!RT)
171 continue;
172
Anders Carlsson28466ab2010-10-31 22:13:23 +0000173 CharUnits EmptySize;
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000174 const CXXRecordDecl *MemberDecl = cast<CXXRecordDecl>(RT->getDecl());
175 const ASTRecordLayout &Layout = Context.getASTRecordLayout(MemberDecl);
176 if (MemberDecl->isEmpty()) {
177 // If the class decl is empty, get its size.
Ken Dyckc8ae5502011-02-09 01:59:34 +0000178 EmptySize = Layout.getSize();
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000179 } else {
180 // Otherwise, we get the largest empty subobject for the decl.
181 EmptySize = Layout.getSizeOfLargestEmptySubobject();
182 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000183
Anders Carlsson28466ab2010-10-31 22:13:23 +0000184 if (EmptySize > SizeOfLargestEmptySubobject)
185 SizeOfLargestEmptySubobject = EmptySize;
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000186 }
187}
188
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000189bool
Anders Carlssondb319762010-05-27 18:20:57 +0000190EmptySubobjectMap::CanPlaceSubobjectAtOffset(const CXXRecordDecl *RD,
Anders Carlsson725190f2010-10-31 21:39:24 +0000191 CharUnits Offset) const {
Anders Carlssondb319762010-05-27 18:20:57 +0000192 // We only need to check empty bases.
193 if (!RD->isEmpty())
194 return true;
195
Anders Carlsson725190f2010-10-31 21:39:24 +0000196 EmptyClassOffsetsMapTy::const_iterator I = EmptyClassOffsets.find(Offset);
Anders Carlssondb319762010-05-27 18:20:57 +0000197 if (I == EmptyClassOffsets.end())
198 return true;
199
200 const ClassVectorTy& Classes = I->second;
201 if (std::find(Classes.begin(), Classes.end(), RD) == Classes.end())
202 return true;
203
204 // There is already an empty class of the same type at this offset.
205 return false;
206}
207
208void EmptySubobjectMap::AddSubobjectAtOffset(const CXXRecordDecl *RD,
Anders Carlsson725190f2010-10-31 21:39:24 +0000209 CharUnits Offset) {
Anders Carlssondb319762010-05-27 18:20:57 +0000210 // We only care about empty bases.
211 if (!RD->isEmpty())
212 return;
213
Reid Kleckner369f3162013-05-14 20:30:42 +0000214 // If we have empty structures inside a union, we can assign both
Rafael Espindola7bcde192010-12-29 23:02:58 +0000215 // the same offset. Just avoid pushing them twice in the list.
Anders Carlsson725190f2010-10-31 21:39:24 +0000216 ClassVectorTy& Classes = EmptyClassOffsets[Offset];
Rafael Espindola7bcde192010-12-29 23:02:58 +0000217 if (std::find(Classes.begin(), Classes.end(), RD) != Classes.end())
218 return;
219
Anders Carlssondb319762010-05-27 18:20:57 +0000220 Classes.push_back(RD);
Anders Carlssoncc5de092010-06-08 15:56:03 +0000221
222 // Update the empty class offset.
Anders Carlsson725190f2010-10-31 21:39:24 +0000223 if (Offset > MaxEmptyClassOffset)
224 MaxEmptyClassOffset = Offset;
Anders Carlssondb319762010-05-27 18:20:57 +0000225}
226
227bool
Anders Carlsson28466ab2010-10-31 22:13:23 +0000228EmptySubobjectMap::CanPlaceBaseSubobjectAtOffset(const BaseSubobjectInfo *Info,
229 CharUnits Offset) {
Anders Carlsson45c1d282010-06-08 16:20:35 +0000230 // We don't have to keep looking past the maximum offset that's known to
231 // contain an empty class.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000232 if (!AnyEmptySubobjectsBeyondOffset(Offset))
Anders Carlsson45c1d282010-06-08 16:20:35 +0000233 return true;
234
Anders Carlsson28466ab2010-10-31 22:13:23 +0000235 if (!CanPlaceSubobjectAtOffset(Info->Class, Offset))
Anders Carlssondb319762010-05-27 18:20:57 +0000236 return false;
237
Anders Carlsson439edd12010-05-27 05:41:06 +0000238 // Traverse all non-virtual bases.
Anders Carlssona7774a62010-05-29 21:10:24 +0000239 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Info->Class);
Anders Carlsson439edd12010-05-27 05:41:06 +0000240 for (unsigned I = 0, E = Info->Bases.size(); I != E; ++I) {
Anders Carlssona7f3cdb2010-05-28 21:24:37 +0000241 BaseSubobjectInfo* Base = Info->Bases[I];
Anders Carlsson439edd12010-05-27 05:41:06 +0000242 if (Base->IsVirtual)
243 continue;
244
Anders Carlsson0a14ee92010-11-01 00:21:58 +0000245 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base->Class);
Anders Carlsson439edd12010-05-27 05:41:06 +0000246
247 if (!CanPlaceBaseSubobjectAtOffset(Base, BaseOffset))
248 return false;
249 }
250
Anders Carlssone3c24c72010-05-29 17:35:14 +0000251 if (Info->PrimaryVirtualBaseInfo) {
252 BaseSubobjectInfo *PrimaryVirtualBaseInfo = Info->PrimaryVirtualBaseInfo;
Anders Carlsson439edd12010-05-27 05:41:06 +0000253
254 if (Info == PrimaryVirtualBaseInfo->Derived) {
255 if (!CanPlaceBaseSubobjectAtOffset(PrimaryVirtualBaseInfo, Offset))
256 return false;
257 }
258 }
259
Anders Carlssondb319762010-05-27 18:20:57 +0000260 // Traverse all member variables.
261 unsigned FieldNo = 0;
262 for (CXXRecordDecl::field_iterator I = Info->Class->field_begin(),
263 E = Info->Class->field_end(); I != E; ++I, ++FieldNo) {
David Blaikie40ed2972012-06-06 20:45:41 +0000264 if (I->isBitField())
Anders Carlsson233e2722010-10-31 21:54:55 +0000265 continue;
266
Anders Carlsson28466ab2010-10-31 22:13:23 +0000267 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
David Blaikie40ed2972012-06-06 20:45:41 +0000268 if (!CanPlaceFieldSubobjectAtOffset(*I, FieldOffset))
Anders Carlssondb319762010-05-27 18:20:57 +0000269 return false;
270 }
271
Anders Carlsson439edd12010-05-27 05:41:06 +0000272 return true;
273}
274
Anders Carlssona7f3cdb2010-05-28 21:24:37 +0000275void EmptySubobjectMap::UpdateEmptyBaseSubobjects(const BaseSubobjectInfo *Info,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000276 CharUnits Offset,
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000277 bool PlacingEmptyBase) {
278 if (!PlacingEmptyBase && Offset >= SizeOfLargestEmptySubobject) {
279 // We know that the only empty subobjects that can conflict with empty
280 // subobject of non-empty bases, are empty bases that can be placed at
281 // offset zero. Because of this, we only need to keep track of empty base
282 // subobjects with offsets less than the size of the largest empty
283 // subobject for our class.
284 return;
285 }
286
Anders Carlsson28466ab2010-10-31 22:13:23 +0000287 AddSubobjectAtOffset(Info->Class, Offset);
Anders Carlssona7774a62010-05-29 21:10:24 +0000288
Anders Carlsson439edd12010-05-27 05:41:06 +0000289 // Traverse all non-virtual bases.
Anders Carlssona7774a62010-05-29 21:10:24 +0000290 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Info->Class);
Anders Carlsson439edd12010-05-27 05:41:06 +0000291 for (unsigned I = 0, E = Info->Bases.size(); I != E; ++I) {
Anders Carlssona7f3cdb2010-05-28 21:24:37 +0000292 BaseSubobjectInfo* Base = Info->Bases[I];
Anders Carlsson439edd12010-05-27 05:41:06 +0000293 if (Base->IsVirtual)
294 continue;
Anders Carlssona7774a62010-05-29 21:10:24 +0000295
Anders Carlsson0a14ee92010-11-01 00:21:58 +0000296 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base->Class);
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000297 UpdateEmptyBaseSubobjects(Base, BaseOffset, PlacingEmptyBase);
Anders Carlsson439edd12010-05-27 05:41:06 +0000298 }
299
Anders Carlssone3c24c72010-05-29 17:35:14 +0000300 if (Info->PrimaryVirtualBaseInfo) {
301 BaseSubobjectInfo *PrimaryVirtualBaseInfo = Info->PrimaryVirtualBaseInfo;
Anders Carlsson439edd12010-05-27 05:41:06 +0000302
303 if (Info == PrimaryVirtualBaseInfo->Derived)
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000304 UpdateEmptyBaseSubobjects(PrimaryVirtualBaseInfo, Offset,
305 PlacingEmptyBase);
Anders Carlsson439edd12010-05-27 05:41:06 +0000306 }
Anders Carlssondb319762010-05-27 18:20:57 +0000307
Anders Carlssondb319762010-05-27 18:20:57 +0000308 // Traverse all member variables.
309 unsigned FieldNo = 0;
310 for (CXXRecordDecl::field_iterator I = Info->Class->field_begin(),
311 E = Info->Class->field_end(); I != E; ++I, ++FieldNo) {
David Blaikie40ed2972012-06-06 20:45:41 +0000312 if (I->isBitField())
Anders Carlsson233e2722010-10-31 21:54:55 +0000313 continue;
Anders Carlssona7774a62010-05-29 21:10:24 +0000314
Anders Carlsson28466ab2010-10-31 22:13:23 +0000315 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
David Blaikie40ed2972012-06-06 20:45:41 +0000316 UpdateEmptyFieldSubobjects(*I, FieldOffset);
Anders Carlssondb319762010-05-27 18:20:57 +0000317 }
Anders Carlsson439edd12010-05-27 05:41:06 +0000318}
319
Anders Carlssona60b86a2010-05-29 20:49:49 +0000320bool EmptySubobjectMap::CanPlaceBaseAtOffset(const BaseSubobjectInfo *Info,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000321 CharUnits Offset) {
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000322 // If we know this class doesn't have any empty subobjects we don't need to
323 // bother checking.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000324 if (SizeOfLargestEmptySubobject.isZero())
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000325 return true;
326
Anders Carlsson439edd12010-05-27 05:41:06 +0000327 if (!CanPlaceBaseSubobjectAtOffset(Info, Offset))
328 return false;
Anders Carlssondb319762010-05-27 18:20:57 +0000329
330 // We are able to place the base at this offset. Make sure to update the
331 // empty base subobject map.
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000332 UpdateEmptyBaseSubobjects(Info, Offset, Info->Class->isEmpty());
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000333 return true;
334}
335
Anders Carlssondb319762010-05-27 18:20:57 +0000336bool
337EmptySubobjectMap::CanPlaceFieldSubobjectAtOffset(const CXXRecordDecl *RD,
338 const CXXRecordDecl *Class,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000339 CharUnits Offset) const {
Anders Carlsson45c1d282010-06-08 16:20:35 +0000340 // We don't have to keep looking past the maximum offset that's known to
341 // contain an empty class.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000342 if (!AnyEmptySubobjectsBeyondOffset(Offset))
Anders Carlsson45c1d282010-06-08 16:20:35 +0000343 return true;
344
Anders Carlsson28466ab2010-10-31 22:13:23 +0000345 if (!CanPlaceSubobjectAtOffset(RD, Offset))
Anders Carlssondb319762010-05-27 18:20:57 +0000346 return false;
347
348 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
349
350 // Traverse all non-virtual bases.
351 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
352 E = RD->bases_end(); I != E; ++I) {
353 if (I->isVirtual())
354 continue;
355
356 const CXXRecordDecl *BaseDecl =
357 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
358
Anders Carlsson0a14ee92010-11-01 00:21:58 +0000359 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(BaseDecl);
Anders Carlssondb319762010-05-27 18:20:57 +0000360 if (!CanPlaceFieldSubobjectAtOffset(BaseDecl, Class, BaseOffset))
361 return false;
362 }
363
Anders Carlsson44687202010-06-08 19:09:24 +0000364 if (RD == Class) {
365 // This is the most derived class, traverse virtual bases as well.
366 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
367 E = RD->vbases_end(); I != E; ++I) {
368 const CXXRecordDecl *VBaseDecl =
369 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
370
Anders Carlsson3f018712010-10-31 23:45:59 +0000371 CharUnits VBaseOffset = Offset + Layout.getVBaseClassOffset(VBaseDecl);
Anders Carlsson44687202010-06-08 19:09:24 +0000372 if (!CanPlaceFieldSubobjectAtOffset(VBaseDecl, Class, VBaseOffset))
373 return false;
374 }
375 }
376
Anders Carlssondb319762010-05-27 18:20:57 +0000377 // Traverse all member variables.
378 unsigned FieldNo = 0;
379 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
380 I != E; ++I, ++FieldNo) {
David Blaikie40ed2972012-06-06 20:45:41 +0000381 if (I->isBitField())
Anders Carlsson233e2722010-10-31 21:54:55 +0000382 continue;
383
Anders Carlsson28466ab2010-10-31 22:13:23 +0000384 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
Anders Carlssondb319762010-05-27 18:20:57 +0000385
David Blaikie40ed2972012-06-06 20:45:41 +0000386 if (!CanPlaceFieldSubobjectAtOffset(*I, FieldOffset))
Anders Carlssondb319762010-05-27 18:20:57 +0000387 return false;
388 }
389
390 return true;
391}
392
Anders Carlsson233e2722010-10-31 21:54:55 +0000393bool
394EmptySubobjectMap::CanPlaceFieldSubobjectAtOffset(const FieldDecl *FD,
395 CharUnits Offset) const {
Anders Carlsson45c1d282010-06-08 16:20:35 +0000396 // We don't have to keep looking past the maximum offset that's known to
397 // contain an empty class.
Anders Carlsson233e2722010-10-31 21:54:55 +0000398 if (!AnyEmptySubobjectsBeyondOffset(Offset))
Anders Carlsson45c1d282010-06-08 16:20:35 +0000399 return true;
400
Anders Carlssondb319762010-05-27 18:20:57 +0000401 QualType T = FD->getType();
402 if (const RecordType *RT = T->getAs<RecordType>()) {
403 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
Anders Carlsson28466ab2010-10-31 22:13:23 +0000404 return CanPlaceFieldSubobjectAtOffset(RD, RD, Offset);
Anders Carlssondb319762010-05-27 18:20:57 +0000405 }
406
407 // If we have an array type we need to look at every element.
408 if (const ConstantArrayType *AT = Context.getAsConstantArrayType(T)) {
409 QualType ElemTy = Context.getBaseElementType(AT);
410 const RecordType *RT = ElemTy->getAs<RecordType>();
411 if (!RT)
412 return true;
413
414 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
415 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
416
417 uint64_t NumElements = Context.getConstantArrayElementCount(AT);
Anders Carlsson233e2722010-10-31 21:54:55 +0000418 CharUnits ElementOffset = Offset;
Anders Carlssondb319762010-05-27 18:20:57 +0000419 for (uint64_t I = 0; I != NumElements; ++I) {
Anders Carlsson45c1d282010-06-08 16:20:35 +0000420 // We don't have to keep looking past the maximum offset that's known to
421 // contain an empty class.
Anders Carlsson233e2722010-10-31 21:54:55 +0000422 if (!AnyEmptySubobjectsBeyondOffset(ElementOffset))
Anders Carlsson45c1d282010-06-08 16:20:35 +0000423 return true;
424
Anders Carlsson28466ab2010-10-31 22:13:23 +0000425 if (!CanPlaceFieldSubobjectAtOffset(RD, RD, ElementOffset))
Anders Carlssondb319762010-05-27 18:20:57 +0000426 return false;
427
Ken Dyckc8ae5502011-02-09 01:59:34 +0000428 ElementOffset += Layout.getSize();
Anders Carlssondb319762010-05-27 18:20:57 +0000429 }
430 }
431
432 return true;
433}
434
435bool
Anders Carlsson28466ab2010-10-31 22:13:23 +0000436EmptySubobjectMap::CanPlaceFieldAtOffset(const FieldDecl *FD,
437 CharUnits Offset) {
438 if (!CanPlaceFieldSubobjectAtOffset(FD, Offset))
Anders Carlssondb319762010-05-27 18:20:57 +0000439 return false;
440
441 // We are able to place the member variable at this offset.
442 // Make sure to update the empty base subobject map.
443 UpdateEmptyFieldSubobjects(FD, Offset);
444 return true;
445}
446
447void EmptySubobjectMap::UpdateEmptyFieldSubobjects(const CXXRecordDecl *RD,
448 const CXXRecordDecl *Class,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000449 CharUnits Offset) {
Anders Carlssonae111dc2010-06-13 17:49:16 +0000450 // We know that the only empty subobjects that can conflict with empty
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000451 // field subobjects are subobjects of empty bases that can be placed at offset
Anders Carlssonae111dc2010-06-13 17:49:16 +0000452 // zero. Because of this, we only need to keep track of empty field
453 // subobjects with offsets less than the size of the largest empty
454 // subobject for our class.
455 if (Offset >= SizeOfLargestEmptySubobject)
456 return;
457
Anders Carlsson28466ab2010-10-31 22:13:23 +0000458 AddSubobjectAtOffset(RD, Offset);
Anders Carlssondb319762010-05-27 18:20:57 +0000459
460 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
461
462 // Traverse all non-virtual bases.
463 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
464 E = RD->bases_end(); I != E; ++I) {
465 if (I->isVirtual())
466 continue;
467
468 const CXXRecordDecl *BaseDecl =
469 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
470
Anders Carlsson0a14ee92010-11-01 00:21:58 +0000471 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(BaseDecl);
Anders Carlssondb319762010-05-27 18:20:57 +0000472 UpdateEmptyFieldSubobjects(BaseDecl, Class, BaseOffset);
473 }
474
Anders Carlsson44687202010-06-08 19:09:24 +0000475 if (RD == Class) {
476 // This is the most derived class, traverse virtual bases as well.
477 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
478 E = RD->vbases_end(); I != E; ++I) {
479 const CXXRecordDecl *VBaseDecl =
480 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
481
Anders Carlsson3f018712010-10-31 23:45:59 +0000482 CharUnits VBaseOffset = Offset + Layout.getVBaseClassOffset(VBaseDecl);
Anders Carlsson44687202010-06-08 19:09:24 +0000483 UpdateEmptyFieldSubobjects(VBaseDecl, Class, VBaseOffset);
484 }
485 }
486
Anders Carlssondb319762010-05-27 18:20:57 +0000487 // Traverse all member variables.
488 unsigned FieldNo = 0;
489 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
490 I != E; ++I, ++FieldNo) {
David Blaikie40ed2972012-06-06 20:45:41 +0000491 if (I->isBitField())
Anders Carlsson09814d32010-11-01 15:14:51 +0000492 continue;
493
Anders Carlsson28466ab2010-10-31 22:13:23 +0000494 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
Anders Carlssondb319762010-05-27 18:20:57 +0000495
David Blaikie40ed2972012-06-06 20:45:41 +0000496 UpdateEmptyFieldSubobjects(*I, FieldOffset);
Anders Carlssondb319762010-05-27 18:20:57 +0000497 }
498}
499
500void EmptySubobjectMap::UpdateEmptyFieldSubobjects(const FieldDecl *FD,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000501 CharUnits Offset) {
Anders Carlssondb319762010-05-27 18:20:57 +0000502 QualType T = FD->getType();
503 if (const RecordType *RT = T->getAs<RecordType>()) {
504 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
505 UpdateEmptyFieldSubobjects(RD, RD, Offset);
506 return;
507 }
508
509 // If we have an array type we need to update every element.
510 if (const ConstantArrayType *AT = Context.getAsConstantArrayType(T)) {
511 QualType ElemTy = Context.getBaseElementType(AT);
512 const RecordType *RT = ElemTy->getAs<RecordType>();
513 if (!RT)
514 return;
515
516 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
517 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
518
519 uint64_t NumElements = Context.getConstantArrayElementCount(AT);
Anders Carlsson28466ab2010-10-31 22:13:23 +0000520 CharUnits ElementOffset = Offset;
Anders Carlssondb319762010-05-27 18:20:57 +0000521
522 for (uint64_t I = 0; I != NumElements; ++I) {
Anders Carlssonae111dc2010-06-13 17:49:16 +0000523 // We know that the only empty subobjects that can conflict with empty
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000524 // field subobjects are subobjects of empty bases that can be placed at
Anders Carlssonae111dc2010-06-13 17:49:16 +0000525 // offset zero. Because of this, we only need to keep track of empty field
526 // subobjects with offsets less than the size of the largest empty
527 // subobject for our class.
528 if (ElementOffset >= SizeOfLargestEmptySubobject)
529 return;
530
Anders Carlssondb319762010-05-27 18:20:57 +0000531 UpdateEmptyFieldSubobjects(RD, RD, ElementOffset);
Ken Dyckc8ae5502011-02-09 01:59:34 +0000532 ElementOffset += Layout.getSize();
Anders Carlssondb319762010-05-27 18:20:57 +0000533 }
534 }
535}
536
John McCalle42a3362012-05-01 08:55:32 +0000537typedef llvm::SmallPtrSet<const CXXRecordDecl*, 4> ClassSetTy;
538
Anders Carlssonc2226202010-05-26 05:58:59 +0000539class RecordLayoutBuilder {
Charles Davisc2c576a2010-08-19 00:55:19 +0000540protected:
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000541 // FIXME: Remove this and make the appropriate fields public.
542 friend class clang::ASTContext;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000543
Jay Foad39c79802011-01-12 09:06:06 +0000544 const ASTContext &Context;
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000545
Anders Carlssonf58de112010-05-26 15:32:58 +0000546 EmptySubobjectMap *EmptySubobjects;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000547
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000548 /// Size - The current size of the record layout.
549 uint64_t Size;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000550
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000551 /// Alignment - The current alignment of the record layout.
Ken Dyck4731d5b2011-02-16 02:05:21 +0000552 CharUnits Alignment;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000553
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000554 /// \brief The alignment if attribute packed is not used.
Ken Dyck1300b3b2011-02-16 02:11:31 +0000555 CharUnits UnpackedAlignment;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000556
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000557 SmallVector<uint64_t, 16> FieldOffsets;
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000558
Douglas Gregore9fc3772012-01-26 07:55:45 +0000559 /// \brief Whether the external AST source has provided a layout for this
560 /// record.
561 unsigned ExternalLayout : 1;
Douglas Gregor44ba7892012-01-28 00:53:29 +0000562
563 /// \brief Whether we need to infer alignment, even when we have an
564 /// externally-provided layout.
565 unsigned InferAlignment : 1;
Douglas Gregore9fc3772012-01-26 07:55:45 +0000566
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000567 /// Packed - Whether the record is packed or not.
Daniel Dunbar6da10982010-05-27 05:45:51 +0000568 unsigned Packed : 1;
569
570 unsigned IsUnion : 1;
571
572 unsigned IsMac68kAlign : 1;
Fariborz Jahanianbcb23a12011-04-26 23:52:16 +0000573
574 unsigned IsMsStruct : 1;
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000575
Eli Friedman2782dac2013-06-26 20:50:34 +0000576 /// UnfilledBitsInLastUnit - If the last field laid out was a bitfield,
577 /// this contains the number of bits in the last unit that can be used for
578 /// an adjacent bitfield if necessary. The unit in question is usually
579 /// a byte, but larger units are used if IsMsStruct.
580 unsigned char UnfilledBitsInLastUnit;
581 /// LastBitfieldTypeSize - If IsMsStruct, represents the size of the type
582 /// of the previous field if it was a bitfield.
583 unsigned char LastBitfieldTypeSize;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000584
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000585 /// MaxFieldAlignment - The maximum allowed field alignment. This is set by
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000586 /// #pragma pack.
Ken Dyck02ced6f2011-02-17 01:49:42 +0000587 CharUnits MaxFieldAlignment;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000588
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000589 /// DataSize - The data size of the record being laid out.
590 uint64_t DataSize;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000591
Ken Dyckaf1c83f2011-02-16 01:52:01 +0000592 CharUnits NonVirtualSize;
Ken Dycka2d3dda2011-02-16 01:43:15 +0000593 CharUnits NonVirtualAlignment;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000594
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000595 /// PrimaryBase - the primary base class (if one exists) of the class
596 /// we're laying out.
597 const CXXRecordDecl *PrimaryBase;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000598
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000599 /// PrimaryBaseIsVirtual - Whether the primary base of the class we're laying
600 /// out is virtual.
601 bool PrimaryBaseIsVirtual;
602
John McCalle42a3362012-05-01 08:55:32 +0000603 /// HasOwnVFPtr - Whether the class provides its own vtable/vftbl
604 /// pointer, as opposed to inheriting one from a primary base class.
605 bool HasOwnVFPtr;
Eli Friedman43114f92011-10-21 22:49:56 +0000606
Anders Carlsson22f57202010-10-31 21:01:46 +0000607 typedef llvm::DenseMap<const CXXRecordDecl *, CharUnits> BaseOffsetsMapTy;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000608
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000609 /// Bases - base classes and their offsets in the record.
610 BaseOffsetsMapTy Bases;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000611
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000612 // VBases - virtual base classes and their offsets in the record.
John McCalle42a3362012-05-01 08:55:32 +0000613 ASTRecordLayout::VBaseOffsetsMapTy VBases;
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000614
615 /// IndirectPrimaryBases - Virtual base classes, direct or indirect, that are
616 /// primary base classes for some other direct or indirect base class.
Anders Carlsson5adde292010-11-24 22:55:48 +0000617 CXXIndirectPrimaryBaseSet IndirectPrimaryBases;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000618
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000619 /// FirstNearlyEmptyVBase - The first nearly empty virtual base class in
620 /// inheritance graph order. Used for determining the primary base class.
621 const CXXRecordDecl *FirstNearlyEmptyVBase;
622
623 /// VisitedVirtualBases - A set of all the visited virtual bases, used to
624 /// avoid visiting virtual bases more than once.
625 llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBases;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000626
Douglas Gregore9fc3772012-01-26 07:55:45 +0000627 /// \brief Externally-provided size.
628 uint64_t ExternalSize;
629
630 /// \brief Externally-provided alignment.
631 uint64_t ExternalAlign;
632
633 /// \brief Externally-provided field offsets.
634 llvm::DenseMap<const FieldDecl *, uint64_t> ExternalFieldOffsets;
635
636 /// \brief Externally-provided direct, non-virtual base offsets.
637 llvm::DenseMap<const CXXRecordDecl *, CharUnits> ExternalBaseOffsets;
638
639 /// \brief Externally-provided virtual base offsets.
640 llvm::DenseMap<const CXXRecordDecl *, CharUnits> ExternalVirtualBaseOffsets;
641
John McCall0153cd32011-11-08 04:01:03 +0000642 RecordLayoutBuilder(const ASTContext &Context,
643 EmptySubobjectMap *EmptySubobjects)
Ken Dyck4731d5b2011-02-16 02:05:21 +0000644 : Context(Context), EmptySubobjects(EmptySubobjects), Size(0),
John McCall0153cd32011-11-08 04:01:03 +0000645 Alignment(CharUnits::One()), UnpackedAlignment(CharUnits::One()),
Douglas Gregor44ba7892012-01-28 00:53:29 +0000646 ExternalLayout(false), InferAlignment(false),
647 Packed(false), IsUnion(false), IsMac68kAlign(false), IsMsStruct(false),
Eli Friedman2782dac2013-06-26 20:50:34 +0000648 UnfilledBitsInLastUnit(0), LastBitfieldTypeSize(0),
649 MaxFieldAlignment(CharUnits::Zero()),
Ken Dyck02ced6f2011-02-17 01:49:42 +0000650 DataSize(0), NonVirtualSize(CharUnits::Zero()),
Fariborz Jahanianeb397412011-05-02 17:20:56 +0000651 NonVirtualAlignment(CharUnits::One()),
Eli Friedman481673f2013-06-26 23:47:39 +0000652 PrimaryBase(0), PrimaryBaseIsVirtual(false),
John McCalle42a3362012-05-01 08:55:32 +0000653 HasOwnVFPtr(false),
Eli Friedman84d2d3a2011-09-27 19:12:27 +0000654 FirstNearlyEmptyVBase(0) { }
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000655
John McCall0153cd32011-11-08 04:01:03 +0000656 /// Reset this RecordLayoutBuilder to a fresh state, using the given
657 /// alignment as the initial alignment. This is used for the
658 /// correct layout of vb-table pointers in MSVC.
659 void resetWithTargetAlignment(CharUnits TargetAlignment) {
660 const ASTContext &Context = this->Context;
661 EmptySubobjectMap *EmptySubobjects = this->EmptySubobjects;
662 this->~RecordLayoutBuilder();
663 new (this) RecordLayoutBuilder(Context, EmptySubobjects);
664 Alignment = UnpackedAlignment = TargetAlignment;
665 }
666
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000667 void Layout(const RecordDecl *D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000668 void Layout(const CXXRecordDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000669 void Layout(const ObjCInterfaceDecl *D);
670
671 void LayoutFields(const RecordDecl *D);
672 void LayoutField(const FieldDecl *D);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000673 void LayoutWideBitField(uint64_t FieldSize, uint64_t TypeSize,
674 bool FieldPacked, const FieldDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000675 void LayoutBitField(const FieldDecl *D);
John McCall0153cd32011-11-08 04:01:03 +0000676
John McCall359b8852013-01-25 22:30:49 +0000677 TargetCXXABI getCXXABI() const {
678 return Context.getTargetInfo().getCXXABI();
679 }
680
Anders Carlssone3c24c72010-05-29 17:35:14 +0000681 /// BaseSubobjectInfoAllocator - Allocator for BaseSubobjectInfo objects.
682 llvm::SpecificBumpPtrAllocator<BaseSubobjectInfo> BaseSubobjectInfoAllocator;
683
684 typedef llvm::DenseMap<const CXXRecordDecl *, BaseSubobjectInfo *>
685 BaseSubobjectInfoMapTy;
686
687 /// VirtualBaseInfo - Map from all the (direct or indirect) virtual bases
688 /// of the class we're laying out to their base subobject info.
689 BaseSubobjectInfoMapTy VirtualBaseInfo;
690
691 /// NonVirtualBaseInfo - Map from all the direct non-virtual bases of the
692 /// class we're laying out to their base subobject info.
693 BaseSubobjectInfoMapTy NonVirtualBaseInfo;
694
695 /// ComputeBaseSubobjectInfo - Compute the base subobject information for the
696 /// bases of the given class.
697 void ComputeBaseSubobjectInfo(const CXXRecordDecl *RD);
698
699 /// ComputeBaseSubobjectInfo - Compute the base subobject information for a
700 /// single class and all of its base classes.
701 BaseSubobjectInfo *ComputeBaseSubobjectInfo(const CXXRecordDecl *RD,
702 bool IsVirtual,
703 BaseSubobjectInfo *Derived);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000704
705 /// DeterminePrimaryBase - Determine the primary base of the given class.
706 void DeterminePrimaryBase(const CXXRecordDecl *RD);
707
708 void SelectPrimaryVBase(const CXXRecordDecl *RD);
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000709
Eli Friedman43114f92011-10-21 22:49:56 +0000710 void EnsureVTablePointerAlignment(CharUnits UnpackedBaseAlign);
Charles Davisc2c576a2010-08-19 00:55:19 +0000711
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000712 /// LayoutNonVirtualBases - Determines the primary base class (if any) and
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000713 /// lays it out. Will then proceed to lay out all non-virtual base clasess.
714 void LayoutNonVirtualBases(const CXXRecordDecl *RD);
715
716 /// LayoutNonVirtualBase - Lays out a single non-virtual base.
Anders Carlssonbb0e6782010-05-29 17:42:25 +0000717 void LayoutNonVirtualBase(const BaseSubobjectInfo *Base);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000718
Anders Carlssona2f8e412010-10-31 22:20:42 +0000719 void AddPrimaryVirtualBaseOffsets(const BaseSubobjectInfo *Info,
720 CharUnits Offset);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000721
722 /// LayoutVirtualBases - Lays out all the virtual bases.
723 void LayoutVirtualBases(const CXXRecordDecl *RD,
724 const CXXRecordDecl *MostDerivedClass);
725
726 /// LayoutVirtualBase - Lays out a single virtual base.
Warren Hunt55d8e822013-10-23 23:53:07 +0000727 void LayoutVirtualBase(const BaseSubobjectInfo *Base);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000728
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000729 /// LayoutBase - Will lay out a base and return the offset where it was
Anders Carlssona2f8e412010-10-31 22:20:42 +0000730 /// placed, in chars.
731 CharUnits LayoutBase(const BaseSubobjectInfo *Base);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000732
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000733 /// InitializeLayout - Initialize record layout for the given record decl.
Daniel Dunbar6da10982010-05-27 05:45:51 +0000734 void InitializeLayout(const Decl *D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000735
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000736 /// FinishLayout - Finalize record layout. Adjust record size based on the
737 /// alignment.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000738 void FinishLayout(const NamedDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000739
Ken Dyck85ef0432011-02-19 18:58:07 +0000740 void UpdateAlignment(CharUnits NewAlignment, CharUnits UnpackedNewAlignment);
741 void UpdateAlignment(CharUnits NewAlignment) {
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000742 UpdateAlignment(NewAlignment, NewAlignment);
743 }
744
Douglas Gregor44ba7892012-01-28 00:53:29 +0000745 /// \brief Retrieve the externally-supplied field offset for the given
746 /// field.
747 ///
748 /// \param Field The field whose offset is being queried.
749 /// \param ComputedOffset The offset that we've computed for this field.
750 uint64_t updateExternalFieldOffset(const FieldDecl *Field,
751 uint64_t ComputedOffset);
752
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000753 void CheckFieldPadding(uint64_t Offset, uint64_t UnpaddedOffset,
754 uint64_t UnpackedOffset, unsigned UnpackedAlign,
755 bool isPacked, const FieldDecl *D);
756
757 DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000758
Ken Dyckecfc7552011-02-24 01:13:28 +0000759 CharUnits getSize() const {
Ken Dyck3c215f22011-02-24 01:33:05 +0000760 assert(Size % Context.getCharWidth() == 0);
Ken Dyckecfc7552011-02-24 01:13:28 +0000761 return Context.toCharUnitsFromBits(Size);
762 }
763 uint64_t getSizeInBits() const { return Size; }
764
765 void setSize(CharUnits NewSize) { Size = Context.toBits(NewSize); }
766 void setSize(uint64_t NewSize) { Size = NewSize; }
767
Eli Friedman84d2d3a2011-09-27 19:12:27 +0000768 CharUnits getAligment() const { return Alignment; }
769
Ken Dyckecfc7552011-02-24 01:13:28 +0000770 CharUnits getDataSize() const {
Ken Dyck3c215f22011-02-24 01:33:05 +0000771 assert(DataSize % Context.getCharWidth() == 0);
Ken Dyckecfc7552011-02-24 01:13:28 +0000772 return Context.toCharUnitsFromBits(DataSize);
773 }
774 uint64_t getDataSizeInBits() const { return DataSize; }
775
776 void setDataSize(CharUnits NewSize) { DataSize = Context.toBits(NewSize); }
777 void setDataSize(uint64_t NewSize) { DataSize = NewSize; }
778
Dmitri Gribenkoa664e5b2012-09-15 20:20:27 +0000779 RecordLayoutBuilder(const RecordLayoutBuilder &) LLVM_DELETED_FUNCTION;
780 void operator=(const RecordLayoutBuilder &) LLVM_DELETED_FUNCTION;
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000781};
Benjamin Kramerc7656cd2010-05-26 09:58:31 +0000782} // end anonymous namespace
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000783
Anders Carlsson81430692009-09-22 03:02:06 +0000784void
Anders Carlssonc2226202010-05-26 05:58:59 +0000785RecordLayoutBuilder::SelectPrimaryVBase(const CXXRecordDecl *RD) {
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000786 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000787 E = RD->bases_end(); I != E; ++I) {
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000788 assert(!I->getType()->isDependentType() &&
Sebastian Redl1054fae2009-10-25 17:03:50 +0000789 "Cannot layout class with dependent bases.");
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000790
Mike Stump11289f42009-09-09 15:08:12 +0000791 const CXXRecordDecl *Base =
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000792 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000793
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000794 // Check if this is a nearly empty virtual base.
Anders Carlsson60a62632010-11-25 01:51:53 +0000795 if (I->isVirtual() && Context.isNearlyEmpty(Base)) {
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000796 // If it's not an indirect primary base, then we've found our primary
797 // base.
Anders Carlsson81430692009-09-22 03:02:06 +0000798 if (!IndirectPrimaryBases.count(Base)) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000799 PrimaryBase = Base;
800 PrimaryBaseIsVirtual = true;
Mike Stump6f3793b2009-08-12 21:50:08 +0000801 return;
802 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000803
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000804 // Is this the first nearly empty virtual base?
805 if (!FirstNearlyEmptyVBase)
806 FirstNearlyEmptyVBase = Base;
Mike Stump6f3793b2009-08-12 21:50:08 +0000807 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000808
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000809 SelectPrimaryVBase(Base);
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000810 if (PrimaryBase)
Zhongxing Xuec345b72010-02-15 04:28:35 +0000811 return;
Mike Stump6f3793b2009-08-12 21:50:08 +0000812 }
813}
814
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000815/// DeterminePrimaryBase - Determine the primary base of the given class.
Anders Carlssonc2226202010-05-26 05:58:59 +0000816void RecordLayoutBuilder::DeterminePrimaryBase(const CXXRecordDecl *RD) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000817 // If the class isn't dynamic, it won't have a primary base.
818 if (!RD->isDynamicClass())
819 return;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000820
Anders Carlsson81430692009-09-22 03:02:06 +0000821 // Compute all the primary virtual bases for all of our direct and
Mike Stump590a7c72009-08-13 23:26:06 +0000822 // indirect bases, and record all their primary virtual base classes.
Anders Carlsson5adde292010-11-24 22:55:48 +0000823 RD->getIndirectPrimaryBases(IndirectPrimaryBases);
Mike Stump590a7c72009-08-13 23:26:06 +0000824
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000825 // If the record has a dynamic base class, attempt to choose a primary base
826 // class. It is the first (in direct base class order) non-virtual dynamic
Anders Carlsson81430692009-09-22 03:02:06 +0000827 // base class, if one exists.
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000828 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000829 e = RD->bases_end(); i != e; ++i) {
Anders Carlsson03ff3792009-11-27 22:05:05 +0000830 // Ignore virtual bases.
831 if (i->isVirtual())
832 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000833
Anders Carlsson03ff3792009-11-27 22:05:05 +0000834 const CXXRecordDecl *Base =
835 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
836
Warren Hunt55d8e822013-10-23 23:53:07 +0000837 if (Base->isDynamicClass()) {
Anders Carlsson03ff3792009-11-27 22:05:05 +0000838 // We found it.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000839 PrimaryBase = Base;
840 PrimaryBaseIsVirtual = false;
Anders Carlsson03ff3792009-11-27 22:05:05 +0000841 return;
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000842 }
843 }
844
Eli Friedman5e9534b2011-10-18 00:55:28 +0000845 // Under the Itanium ABI, if there is no non-virtual primary base class,
846 // try to compute the primary virtual base. The primary virtual base is
847 // the first nearly empty virtual base that is not an indirect primary
848 // virtual base class, if one exists.
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000849 if (RD->getNumVBases() != 0) {
850 SelectPrimaryVBase(RD);
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000851 if (PrimaryBase)
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000852 return;
853 }
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000854
Eli Friedman5e9534b2011-10-18 00:55:28 +0000855 // Otherwise, it is the first indirect primary base class, if one exists.
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000856 if (FirstNearlyEmptyVBase) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000857 PrimaryBase = FirstNearlyEmptyVBase;
858 PrimaryBaseIsVirtual = true;
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000859 return;
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000860 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000861
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000862 assert(!PrimaryBase && "Should not get here with a primary base!");
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000863}
864
Anders Carlssone3c24c72010-05-29 17:35:14 +0000865BaseSubobjectInfo *
866RecordLayoutBuilder::ComputeBaseSubobjectInfo(const CXXRecordDecl *RD,
867 bool IsVirtual,
868 BaseSubobjectInfo *Derived) {
869 BaseSubobjectInfo *Info;
870
871 if (IsVirtual) {
872 // Check if we already have info about this virtual base.
873 BaseSubobjectInfo *&InfoSlot = VirtualBaseInfo[RD];
874 if (InfoSlot) {
875 assert(InfoSlot->Class == RD && "Wrong class for virtual base info!");
876 return InfoSlot;
877 }
878
879 // We don't, create it.
880 InfoSlot = new (BaseSubobjectInfoAllocator.Allocate()) BaseSubobjectInfo;
881 Info = InfoSlot;
882 } else {
883 Info = new (BaseSubobjectInfoAllocator.Allocate()) BaseSubobjectInfo;
884 }
885
886 Info->Class = RD;
887 Info->IsVirtual = IsVirtual;
888 Info->Derived = 0;
889 Info->PrimaryVirtualBaseInfo = 0;
890
891 const CXXRecordDecl *PrimaryVirtualBase = 0;
892 BaseSubobjectInfo *PrimaryVirtualBaseInfo = 0;
893
894 // Check if this base has a primary virtual base.
895 if (RD->getNumVBases()) {
896 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlsson7f95cd12010-11-24 23:12:57 +0000897 if (Layout.isPrimaryBaseVirtual()) {
Anders Carlssone3c24c72010-05-29 17:35:14 +0000898 // This base does have a primary virtual base.
899 PrimaryVirtualBase = Layout.getPrimaryBase();
900 assert(PrimaryVirtualBase && "Didn't have a primary virtual base!");
901
902 // Now check if we have base subobject info about this primary base.
903 PrimaryVirtualBaseInfo = VirtualBaseInfo.lookup(PrimaryVirtualBase);
904
905 if (PrimaryVirtualBaseInfo) {
906 if (PrimaryVirtualBaseInfo->Derived) {
907 // We did have info about this primary base, and it turns out that it
908 // has already been claimed as a primary virtual base for another
909 // base.
910 PrimaryVirtualBase = 0;
911 } else {
912 // We can claim this base as our primary base.
913 Info->PrimaryVirtualBaseInfo = PrimaryVirtualBaseInfo;
914 PrimaryVirtualBaseInfo->Derived = Info;
915 }
916 }
917 }
918 }
919
920 // Now go through all direct bases.
921 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
922 E = RD->bases_end(); I != E; ++I) {
923 bool IsVirtual = I->isVirtual();
924
925 const CXXRecordDecl *BaseDecl =
926 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
927
928 Info->Bases.push_back(ComputeBaseSubobjectInfo(BaseDecl, IsVirtual, Info));
929 }
930
931 if (PrimaryVirtualBase && !PrimaryVirtualBaseInfo) {
932 // Traversing the bases must have created the base info for our primary
933 // virtual base.
934 PrimaryVirtualBaseInfo = VirtualBaseInfo.lookup(PrimaryVirtualBase);
935 assert(PrimaryVirtualBaseInfo &&
936 "Did not create a primary virtual base!");
937
938 // Claim the primary virtual base as our primary virtual base.
939 Info->PrimaryVirtualBaseInfo = PrimaryVirtualBaseInfo;
940 PrimaryVirtualBaseInfo->Derived = Info;
941 }
942
943 return Info;
944}
945
946void RecordLayoutBuilder::ComputeBaseSubobjectInfo(const CXXRecordDecl *RD) {
947 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
948 E = RD->bases_end(); I != E; ++I) {
949 bool IsVirtual = I->isVirtual();
950
951 const CXXRecordDecl *BaseDecl =
952 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
953
954 // Compute the base subobject info for this base.
955 BaseSubobjectInfo *Info = ComputeBaseSubobjectInfo(BaseDecl, IsVirtual, 0);
956
957 if (IsVirtual) {
958 // ComputeBaseInfo has already added this base for us.
959 assert(VirtualBaseInfo.count(BaseDecl) &&
960 "Did not add virtual base!");
961 } else {
962 // Add the base info to the map of non-virtual bases.
963 assert(!NonVirtualBaseInfo.count(BaseDecl) &&
964 "Non-virtual base already exists!");
965 NonVirtualBaseInfo.insert(std::make_pair(BaseDecl, Info));
966 }
967 }
968}
969
Anders Carlsson09ffa322010-03-10 22:21:28 +0000970void
Eli Friedman43114f92011-10-21 22:49:56 +0000971RecordLayoutBuilder::EnsureVTablePointerAlignment(CharUnits UnpackedBaseAlign) {
Eli Friedman5e9534b2011-10-18 00:55:28 +0000972 CharUnits BaseAlign = (Packed) ? CharUnits::One() : UnpackedBaseAlign;
973
974 // The maximum field alignment overrides base align.
975 if (!MaxFieldAlignment.isZero()) {
976 BaseAlign = std::min(BaseAlign, MaxFieldAlignment);
977 UnpackedBaseAlign = std::min(UnpackedBaseAlign, MaxFieldAlignment);
978 }
979
980 // Round up the current record size to pointer alignment.
Eli Friedman43114f92011-10-21 22:49:56 +0000981 setSize(getSize().RoundUpToAlignment(BaseAlign));
982 setDataSize(getSize());
Eli Friedman5e9534b2011-10-18 00:55:28 +0000983
984 // Update the alignment.
985 UpdateAlignment(BaseAlign, UnpackedBaseAlign);
986}
987
988void
Anders Carlssonc2226202010-05-26 05:58:59 +0000989RecordLayoutBuilder::LayoutNonVirtualBases(const CXXRecordDecl *RD) {
Anders Carlssone3c24c72010-05-29 17:35:14 +0000990 // Then, determine the primary base class.
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000991 DeterminePrimaryBase(RD);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000992
Anders Carlssone3c24c72010-05-29 17:35:14 +0000993 // Compute base subobject info.
994 ComputeBaseSubobjectInfo(RD);
995
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000996 // If we have a primary base class, lay it out.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000997 if (PrimaryBase) {
998 if (PrimaryBaseIsVirtual) {
Anders Carlssone3c24c72010-05-29 17:35:14 +0000999 // If the primary virtual base was a primary virtual base of some other
1000 // base class we'll have to steal it.
1001 BaseSubobjectInfo *PrimaryBaseInfo = VirtualBaseInfo.lookup(PrimaryBase);
1002 PrimaryBaseInfo->Derived = 0;
1003
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001004 // We have a virtual primary base, insert it as an indirect primary base.
Anders Carlssond20e7cd2010-05-26 05:20:58 +00001005 IndirectPrimaryBases.insert(PrimaryBase);
Anders Carlssonfe900962010-03-11 05:42:17 +00001006
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001007 assert(!VisitedVirtualBases.count(PrimaryBase) &&
Anders Carlssond20e7cd2010-05-26 05:20:58 +00001008 "vbase already visited!");
1009 VisitedVirtualBases.insert(PrimaryBase);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001010
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001011 LayoutVirtualBase(PrimaryBaseInfo);
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001012 } else {
1013 BaseSubobjectInfo *PrimaryBaseInfo =
1014 NonVirtualBaseInfo.lookup(PrimaryBase);
1015 assert(PrimaryBaseInfo &&
1016 "Did not find base info for non-virtual primary base!");
1017
1018 LayoutNonVirtualBase(PrimaryBaseInfo);
1019 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001020
John McCall0153cd32011-11-08 04:01:03 +00001021 // If this class needs a vtable/vf-table and didn't get one from a
1022 // primary base, add it in now.
Warren Hunt55d8e822013-10-23 23:53:07 +00001023 } else if (RD->isDynamicClass()) {
Eli Friedman5e9534b2011-10-18 00:55:28 +00001024 assert(DataSize == 0 && "Vtable pointer must be at offset zero!");
Eli Friedman5e9534b2011-10-18 00:55:28 +00001025 CharUnits PtrWidth =
1026 Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerWidth(0));
Eli Friedman43114f92011-10-21 22:49:56 +00001027 CharUnits PtrAlign =
1028 Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerAlign(0));
1029 EnsureVTablePointerAlignment(PtrAlign);
John McCalle42a3362012-05-01 08:55:32 +00001030 HasOwnVFPtr = true;
Eli Friedman5e9534b2011-10-18 00:55:28 +00001031 setSize(getSize() + PtrWidth);
1032 setDataSize(getSize());
1033 }
1034
John McCall0153cd32011-11-08 04:01:03 +00001035 bool HasDirectVirtualBases = false;
1036 bool HasNonVirtualBaseWithVBTable = false;
1037
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001038 // Now lay out the non-virtual bases.
1039 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001040 E = RD->bases_end(); I != E; ++I) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001041
John McCall0153cd32011-11-08 04:01:03 +00001042 // Ignore virtual bases, but remember that we saw one.
1043 if (I->isVirtual()) {
1044 HasDirectVirtualBases = true;
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001045 continue;
John McCall0153cd32011-11-08 04:01:03 +00001046 }
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001047
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001048 const CXXRecordDecl *BaseDecl =
John McCall0153cd32011-11-08 04:01:03 +00001049 cast<CXXRecordDecl>(I->getType()->castAs<RecordType>()->getDecl());
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001050
John McCall0153cd32011-11-08 04:01:03 +00001051 // Remember if this base has virtual bases itself.
Reid Klecknerf5370dd2013-10-11 20:41:08 +00001052 if (BaseDecl->getNumVBases())
John McCall0153cd32011-11-08 04:01:03 +00001053 HasNonVirtualBaseWithVBTable = true;
1054
1055 // Skip the primary base, because we've already laid it out. The
1056 // !PrimaryBaseIsVirtual check is required because we might have a
1057 // non-virtual base of the same type as a primary virtual base.
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001058 if (BaseDecl == PrimaryBase && !PrimaryBaseIsVirtual)
Anders Carlsson8630b5b2010-03-11 00:15:35 +00001059 continue;
1060
1061 // Lay out the base.
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001062 BaseSubobjectInfo *BaseInfo = NonVirtualBaseInfo.lookup(BaseDecl);
1063 assert(BaseInfo && "Did not find base info for non-virtual base!");
1064
1065 LayoutNonVirtualBase(BaseInfo);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001066 }
1067}
1068
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001069void RecordLayoutBuilder::LayoutNonVirtualBase(const BaseSubobjectInfo *Base) {
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001070 // Layout the base.
Anders Carlssona2f8e412010-10-31 22:20:42 +00001071 CharUnits Offset = LayoutBase(Base);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001072
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001073 // Add its base class offset.
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001074 assert(!Bases.count(Base->Class) && "base offset already exists!");
Anders Carlssona2f8e412010-10-31 22:20:42 +00001075 Bases.insert(std::make_pair(Base->Class, Offset));
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001076
1077 AddPrimaryVirtualBaseOffsets(Base, Offset);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001078}
Mike Stump2b84dd32009-11-05 04:02:15 +00001079
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001080void
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001081RecordLayoutBuilder::AddPrimaryVirtualBaseOffsets(const BaseSubobjectInfo *Info,
Anders Carlssona2f8e412010-10-31 22:20:42 +00001082 CharUnits Offset) {
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001083 // This base isn't interesting, it has no virtual bases.
1084 if (!Info->Class->getNumVBases())
1085 return;
1086
1087 // First, check if we have a virtual primary base to add offsets for.
1088 if (Info->PrimaryVirtualBaseInfo) {
1089 assert(Info->PrimaryVirtualBaseInfo->IsVirtual &&
1090 "Primary virtual base is not virtual!");
1091 if (Info->PrimaryVirtualBaseInfo->Derived == Info) {
1092 // Add the offset.
1093 assert(!VBases.count(Info->PrimaryVirtualBaseInfo->Class) &&
1094 "primary vbase offset already exists!");
1095 VBases.insert(std::make_pair(Info->PrimaryVirtualBaseInfo->Class,
John McCalle42a3362012-05-01 08:55:32 +00001096 ASTRecordLayout::VBaseInfo(Offset, false)));
Anders Carlssonea7b1822010-04-15 16:12:58 +00001097
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001098 // Traverse the primary virtual base.
1099 AddPrimaryVirtualBaseOffsets(Info->PrimaryVirtualBaseInfo, Offset);
1100 }
Anders Carlssonea7b1822010-04-15 16:12:58 +00001101 }
1102
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001103 // Now go through all direct non-virtual bases.
1104 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Info->Class);
1105 for (unsigned I = 0, E = Info->Bases.size(); I != E; ++I) {
1106 const BaseSubobjectInfo *Base = Info->Bases[I];
1107 if (Base->IsVirtual)
Anders Carlssonea7b1822010-04-15 16:12:58 +00001108 continue;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001109
Anders Carlsson0a14ee92010-11-01 00:21:58 +00001110 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base->Class);
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001111 AddPrimaryVirtualBaseOffsets(Base, BaseOffset);
Anders Carlssonea7b1822010-04-15 16:12:58 +00001112 }
1113}
1114
John McCalle42a3362012-05-01 08:55:32 +00001115/// Does the given class inherit non-virtually from any of the classes
1116/// in the given set?
1117static bool hasNonVirtualBaseInSet(const CXXRecordDecl *RD,
1118 const ClassSetTy &set) {
1119 for (CXXRecordDecl::base_class_const_iterator
1120 I = RD->bases_begin(), E = RD->bases_end(); I != E; ++I) {
1121 // Ignore virtual links.
1122 if (I->isVirtual()) continue;
1123
1124 // Check whether the set contains the base.
1125 const CXXRecordDecl *base = I->getType()->getAsCXXRecordDecl();
1126 if (set.count(base))
1127 return true;
1128
1129 // Otherwise, recurse and propagate.
1130 if (hasNonVirtualBaseInSet(base, set))
1131 return true;
1132 }
1133
1134 return false;
1135}
1136
Anders Carlssonea7b1822010-04-15 16:12:58 +00001137void
Anders Carlssonc2226202010-05-26 05:58:59 +00001138RecordLayoutBuilder::LayoutVirtualBases(const CXXRecordDecl *RD,
Anders Carlssonea7b1822010-04-15 16:12:58 +00001139 const CXXRecordDecl *MostDerivedClass) {
Anders Carlssonde710c92010-03-11 04:33:54 +00001140 const CXXRecordDecl *PrimaryBase;
Anders Carlsson291279e2010-04-10 18:42:27 +00001141 bool PrimaryBaseIsVirtual;
Anders Carlssonfe900962010-03-11 05:42:17 +00001142
Anders Carlsson291279e2010-04-10 18:42:27 +00001143 if (MostDerivedClass == RD) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +00001144 PrimaryBase = this->PrimaryBase;
1145 PrimaryBaseIsVirtual = this->PrimaryBaseIsVirtual;
Anders Carlsson291279e2010-04-10 18:42:27 +00001146 } else {
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001147 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlssonde710c92010-03-11 04:33:54 +00001148 PrimaryBase = Layout.getPrimaryBase();
Anders Carlsson7f95cd12010-11-24 23:12:57 +00001149 PrimaryBaseIsVirtual = Layout.isPrimaryBaseVirtual();
Anders Carlsson291279e2010-04-10 18:42:27 +00001150 }
1151
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001152 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1153 E = RD->bases_end(); I != E; ++I) {
1154 assert(!I->getType()->isDependentType() &&
Sebastian Redl1054fae2009-10-25 17:03:50 +00001155 "Cannot layout class with dependent bases.");
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001156
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001157 const CXXRecordDecl *BaseDecl =
John McCall0153cd32011-11-08 04:01:03 +00001158 cast<CXXRecordDecl>(I->getType()->castAs<RecordType>()->getDecl());
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001159
1160 if (I->isVirtual()) {
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001161 if (PrimaryBase != BaseDecl || !PrimaryBaseIsVirtual) {
1162 bool IndirectPrimaryBase = IndirectPrimaryBases.count(BaseDecl);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001163
Anders Carlsson291279e2010-04-10 18:42:27 +00001164 // Only lay out the virtual base if it's not an indirect primary base.
1165 if (!IndirectPrimaryBase) {
1166 // Only visit virtual bases once.
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001167 if (!VisitedVirtualBases.insert(BaseDecl))
Anders Carlsson291279e2010-04-10 18:42:27 +00001168 continue;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001169
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001170 const BaseSubobjectInfo *BaseInfo = VirtualBaseInfo.lookup(BaseDecl);
1171 assert(BaseInfo && "Did not find virtual base info!");
1172 LayoutVirtualBase(BaseInfo);
Anders Carlsson6a848892010-03-11 04:10:39 +00001173 }
Mike Stump2b84dd32009-11-05 04:02:15 +00001174 }
Mike Stumpc2f591b2009-08-13 22:53:07 +00001175 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001176
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001177 if (!BaseDecl->getNumVBases()) {
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001178 // This base isn't interesting since it doesn't have any virtual bases.
1179 continue;
Mike Stump996576f32009-08-16 19:04:13 +00001180 }
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001181
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001182 LayoutVirtualBases(BaseDecl, MostDerivedClass);
Mike Stump6b2556f2009-08-06 13:41:24 +00001183 }
1184}
1185
Warren Hunt55d8e822013-10-23 23:53:07 +00001186void RecordLayoutBuilder::LayoutVirtualBase(const BaseSubobjectInfo *Base) {
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001187 assert(!Base->Derived && "Trying to lay out a primary virtual base!");
1188
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001189 // Layout the base.
Anders Carlssona2f8e412010-10-31 22:20:42 +00001190 CharUnits Offset = LayoutBase(Base);
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001191
1192 // Add its base class offset.
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001193 assert(!VBases.count(Base->Class) && "vbase offset already exists!");
John McCalle42a3362012-05-01 08:55:32 +00001194 VBases.insert(std::make_pair(Base->Class,
Warren Hunt55d8e822013-10-23 23:53:07 +00001195 ASTRecordLayout::VBaseInfo(Offset, false)));
John McCalle42a3362012-05-01 08:55:32 +00001196
Warren Hunt55d8e822013-10-23 23:53:07 +00001197 AddPrimaryVirtualBaseOffsets(Base, Offset);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001198}
1199
Anders Carlssona2f8e412010-10-31 22:20:42 +00001200CharUnits RecordLayoutBuilder::LayoutBase(const BaseSubobjectInfo *Base) {
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001201 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Base->Class);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001202
Douglas Gregore9fc3772012-01-26 07:55:45 +00001203
1204 CharUnits Offset;
1205
1206 // Query the external layout to see if it provides an offset.
1207 bool HasExternalLayout = false;
1208 if (ExternalLayout) {
1209 llvm::DenseMap<const CXXRecordDecl *, CharUnits>::iterator Known;
1210 if (Base->IsVirtual) {
1211 Known = ExternalVirtualBaseOffsets.find(Base->Class);
1212 if (Known != ExternalVirtualBaseOffsets.end()) {
1213 Offset = Known->second;
1214 HasExternalLayout = true;
1215 }
1216 } else {
1217 Known = ExternalBaseOffsets.find(Base->Class);
1218 if (Known != ExternalBaseOffsets.end()) {
1219 Offset = Known->second;
1220 HasExternalLayout = true;
1221 }
1222 }
1223 }
1224
Eli Friedman69d27d22013-07-16 00:21:28 +00001225 CharUnits UnpackedBaseAlign = Layout.getNonVirtualAlign();
1226 CharUnits BaseAlign = (Packed) ? CharUnits::One() : UnpackedBaseAlign;
1227
Anders Carlsson09ffa322010-03-10 22:21:28 +00001228 // If we have an empty base class, try to place it at offset 0.
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001229 if (Base->Class->isEmpty() &&
Douglas Gregore9fc3772012-01-26 07:55:45 +00001230 (!HasExternalLayout || Offset == CharUnits::Zero()) &&
Anders Carlsson28466ab2010-10-31 22:13:23 +00001231 EmptySubobjects->CanPlaceBaseAtOffset(Base, CharUnits::Zero())) {
Ken Dyck1b4420e2011-02-28 02:01:38 +00001232 setSize(std::max(getSize(), Layout.getSize()));
Eli Friedman69d27d22013-07-16 00:21:28 +00001233 UpdateAlignment(BaseAlign, UnpackedBaseAlign);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001234
Anders Carlssona2f8e412010-10-31 22:20:42 +00001235 return CharUnits::Zero();
Anders Carlsson09ffa322010-03-10 22:21:28 +00001236 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001237
Argyrios Kyrtzidis8b542742010-12-09 00:35:20 +00001238 // The maximum field alignment overrides base align.
Ken Dyck02ced6f2011-02-17 01:49:42 +00001239 if (!MaxFieldAlignment.isZero()) {
Ken Dyck85ef0432011-02-19 18:58:07 +00001240 BaseAlign = std::min(BaseAlign, MaxFieldAlignment);
1241 UnpackedBaseAlign = std::min(UnpackedBaseAlign, MaxFieldAlignment);
Argyrios Kyrtzidis8b542742010-12-09 00:35:20 +00001242 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001243
Douglas Gregore9fc3772012-01-26 07:55:45 +00001244 if (!HasExternalLayout) {
1245 // Round up the current record size to the base's alignment boundary.
1246 Offset = getDataSize().RoundUpToAlignment(BaseAlign);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001247
Douglas Gregore9fc3772012-01-26 07:55:45 +00001248 // Try to place the base.
1249 while (!EmptySubobjects->CanPlaceBaseAtOffset(Base, Offset))
1250 Offset += BaseAlign;
1251 } else {
1252 bool Allowed = EmptySubobjects->CanPlaceBaseAtOffset(Base, Offset);
1253 (void)Allowed;
1254 assert(Allowed && "Base subobject externally placed at overlapping offset");
Douglas Gregor1423a5c2012-10-26 22:31:14 +00001255
1256 if (InferAlignment && Offset < getDataSize().RoundUpToAlignment(BaseAlign)){
1257 // The externally-supplied base offset is before the base offset we
1258 // computed. Assume that the structure is packed.
1259 Alignment = CharUnits::One();
1260 InferAlignment = false;
1261 }
Douglas Gregore9fc3772012-01-26 07:55:45 +00001262 }
1263
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001264 if (!Base->Class->isEmpty()) {
Anders Carlsson09ffa322010-03-10 22:21:28 +00001265 // Update the data size.
Ken Dyck1b4420e2011-02-28 02:01:38 +00001266 setDataSize(Offset + Layout.getNonVirtualSize());
Anders Carlsson09ffa322010-03-10 22:21:28 +00001267
Ken Dyck1b4420e2011-02-28 02:01:38 +00001268 setSize(std::max(getSize(), getDataSize()));
Anders Carlsson09ffa322010-03-10 22:21:28 +00001269 } else
Ken Dyck1b4420e2011-02-28 02:01:38 +00001270 setSize(std::max(getSize(), Offset + Layout.getSize()));
Anders Carlsson09ffa322010-03-10 22:21:28 +00001271
1272 // Remember max struct/class alignment.
Argyrios Kyrtzidis8b542742010-12-09 00:35:20 +00001273 UpdateAlignment(BaseAlign, UnpackedBaseAlign);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001274
Ken Dyck1b4420e2011-02-28 02:01:38 +00001275 return Offset;
Anders Carlsson09ffa322010-03-10 22:21:28 +00001276}
1277
Daniel Dunbar6da10982010-05-27 05:45:51 +00001278void RecordLayoutBuilder::InitializeLayout(const Decl *D) {
Eli Friedman9ee2d0472012-10-12 23:29:20 +00001279 if (const RecordDecl *RD = dyn_cast<RecordDecl>(D)) {
Daniel Dunbar6da10982010-05-27 05:45:51 +00001280 IsUnion = RD->isUnion();
Eli Friedman9ee2d0472012-10-12 23:29:20 +00001281 IsMsStruct = RD->isMsStruct(Context);
1282 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001283
Eli Friedman9ee2d0472012-10-12 23:29:20 +00001284 Packed = D->hasAttr<PackedAttr>();
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001285
Daniel Dunbar096ed292011-10-05 21:04:55 +00001286 // Honor the default struct packing maximum alignment flag.
David Blaikiebbafb8a2012-03-11 07:00:24 +00001287 if (unsigned DefaultMaxFieldAlignment = Context.getLangOpts().PackStruct) {
Daniel Dunbar096ed292011-10-05 21:04:55 +00001288 MaxFieldAlignment = CharUnits::fromQuantity(DefaultMaxFieldAlignment);
1289 }
1290
Daniel Dunbar6da10982010-05-27 05:45:51 +00001291 // mac68k alignment supersedes maximum field alignment and attribute aligned,
1292 // and forces all structures to have 2-byte alignment. The IBM docs on it
1293 // allude to additional (more complicated) semantics, especially with regard
1294 // to bit-fields, but gcc appears not to follow that.
1295 if (D->hasAttr<AlignMac68kAttr>()) {
1296 IsMac68kAlign = true;
Ken Dyck02ced6f2011-02-17 01:49:42 +00001297 MaxFieldAlignment = CharUnits::fromQuantity(2);
Ken Dyck4731d5b2011-02-16 02:05:21 +00001298 Alignment = CharUnits::fromQuantity(2);
Daniel Dunbar6da10982010-05-27 05:45:51 +00001299 } else {
1300 if (const MaxFieldAlignmentAttr *MFAA = D->getAttr<MaxFieldAlignmentAttr>())
Ken Dyck02ced6f2011-02-17 01:49:42 +00001301 MaxFieldAlignment = Context.toCharUnitsFromBits(MFAA->getAlignment());
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001302
Alexis Huntdcfba7b2010-08-18 23:23:40 +00001303 if (unsigned MaxAlign = D->getMaxAlignment())
Ken Dyck85ef0432011-02-19 18:58:07 +00001304 UpdateAlignment(Context.toCharUnitsFromBits(MaxAlign));
Daniel Dunbar6da10982010-05-27 05:45:51 +00001305 }
Douglas Gregore9fc3772012-01-26 07:55:45 +00001306
1307 // If there is an external AST source, ask it for the various offsets.
1308 if (const RecordDecl *RD = dyn_cast<RecordDecl>(D))
1309 if (ExternalASTSource *External = Context.getExternalSource()) {
1310 ExternalLayout = External->layoutRecordType(RD,
1311 ExternalSize,
1312 ExternalAlign,
1313 ExternalFieldOffsets,
1314 ExternalBaseOffsets,
1315 ExternalVirtualBaseOffsets);
1316
1317 // Update based on external alignment.
1318 if (ExternalLayout) {
Douglas Gregor44ba7892012-01-28 00:53:29 +00001319 if (ExternalAlign > 0) {
1320 Alignment = Context.toCharUnitsFromBits(ExternalAlign);
Douglas Gregor44ba7892012-01-28 00:53:29 +00001321 } else {
1322 // The external source didn't have alignment information; infer it.
1323 InferAlignment = true;
1324 }
Douglas Gregore9fc3772012-01-26 07:55:45 +00001325 }
1326 }
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001327}
Anders Carlsson6d9f6f32009-07-19 00:18:47 +00001328
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001329void RecordLayoutBuilder::Layout(const RecordDecl *D) {
1330 InitializeLayout(D);
Anders Carlsson118ce162009-07-18 21:48:39 +00001331 LayoutFields(D);
Mike Stump11289f42009-09-09 15:08:12 +00001332
Anders Carlsson79474332009-07-18 20:20:21 +00001333 // Finally, round the size of the total struct up to the alignment of the
1334 // struct itself.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001335 FinishLayout(D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001336}
1337
1338void RecordLayoutBuilder::Layout(const CXXRecordDecl *RD) {
1339 InitializeLayout(RD);
1340
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001341 // Lay out the vtable and the non-virtual bases.
1342 LayoutNonVirtualBases(RD);
1343
1344 LayoutFields(RD);
1345
Ken Dycke7380752011-03-10 01:53:59 +00001346 NonVirtualSize = Context.toCharUnitsFromBits(
1347 llvm::RoundUpToAlignment(getSizeInBits(),
Douglas Gregore8bbc122011-09-02 00:18:52 +00001348 Context.getTargetInfo().getCharAlign()));
Ken Dyck4731d5b2011-02-16 02:05:21 +00001349 NonVirtualAlignment = Alignment;
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001350
Warren Hunt55d8e822013-10-23 23:53:07 +00001351 // Lay out the virtual bases and add the primary virtual base offsets.
1352 LayoutVirtualBases(RD, RD);
John McCall0153cd32011-11-08 04:01:03 +00001353
1354 // Finally, round the size of the total struct up to the alignment
Eli Friedman83a12582011-12-01 00:37:01 +00001355 // of the struct itself.
1356 FinishLayout(RD);
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001357
Anders Carlsson5b441d72010-04-10 21:24:48 +00001358#ifndef NDEBUG
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001359 // Check that we have base offsets for all bases.
1360 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1361 E = RD->bases_end(); I != E; ++I) {
1362 if (I->isVirtual())
1363 continue;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001364
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001365 const CXXRecordDecl *BaseDecl =
1366 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1367
1368 assert(Bases.count(BaseDecl) && "Did not find base offset!");
1369 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001370
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001371 // And all virtual bases.
1372 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
1373 E = RD->vbases_end(); I != E; ++I) {
1374 const CXXRecordDecl *BaseDecl =
1375 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001376
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001377 assert(VBases.count(BaseDecl) && "Did not find base offset!");
Anders Carlsson5b441d72010-04-10 21:24:48 +00001378 }
1379#endif
Anders Carlsson79474332009-07-18 20:20:21 +00001380}
1381
Anders Carlssonc2226202010-05-26 05:58:59 +00001382void RecordLayoutBuilder::Layout(const ObjCInterfaceDecl *D) {
Anders Carlsson4f516282009-07-18 20:50:59 +00001383 if (ObjCInterfaceDecl *SD = D->getSuperClass()) {
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001384 const ASTRecordLayout &SL = Context.getASTObjCInterfaceLayout(SD);
Anders Carlsson4f516282009-07-18 20:50:59 +00001385
Ken Dyck85ef0432011-02-19 18:58:07 +00001386 UpdateAlignment(SL.getAlignment());
Mike Stump11289f42009-09-09 15:08:12 +00001387
Anders Carlsson4f516282009-07-18 20:50:59 +00001388 // We start laying out ivars not at the end of the superclass
1389 // structure, but at the next byte following the last field.
Ken Dyckecfc7552011-02-24 01:13:28 +00001390 setSize(SL.getDataSize());
Ken Dyck1b4420e2011-02-28 02:01:38 +00001391 setDataSize(getSize());
Anders Carlsson4f516282009-07-18 20:50:59 +00001392 }
Mike Stump11289f42009-09-09 15:08:12 +00001393
Daniel Dunbar6da10982010-05-27 05:45:51 +00001394 InitializeLayout(D);
Anders Carlsson4f516282009-07-18 20:50:59 +00001395 // Layout each ivar sequentially.
Jordy Rosea91768e2011-07-22 02:08:32 +00001396 for (const ObjCIvarDecl *IVD = D->all_declared_ivar_begin(); IVD;
1397 IVD = IVD->getNextIvar())
Fariborz Jahanianb26d5782011-06-28 18:05:25 +00001398 LayoutField(IVD);
Mike Stump11289f42009-09-09 15:08:12 +00001399
Anders Carlsson4f516282009-07-18 20:50:59 +00001400 // Finally, round the size of the total struct up to the alignment of the
1401 // struct itself.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001402 FinishLayout(D);
Anders Carlsson4f516282009-07-18 20:50:59 +00001403}
1404
Anders Carlssonc2226202010-05-26 05:58:59 +00001405void RecordLayoutBuilder::LayoutFields(const RecordDecl *D) {
Anders Carlsson118ce162009-07-18 21:48:39 +00001406 // Layout each field, for now, just sequentially, respecting alignment. In
1407 // the future, this will need to be tweakable by targets.
Mike Stump11289f42009-09-09 15:08:12 +00001408 for (RecordDecl::field_iterator Field = D->field_begin(),
Eli Friedman481673f2013-06-26 23:47:39 +00001409 FieldEnd = D->field_end(); Field != FieldEnd; ++Field)
David Blaikie40ed2972012-06-06 20:45:41 +00001410 LayoutField(*Field);
Anders Carlsson118ce162009-07-18 21:48:39 +00001411}
1412
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001413void RecordLayoutBuilder::LayoutWideBitField(uint64_t FieldSize,
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001414 uint64_t TypeSize,
1415 bool FieldPacked,
1416 const FieldDecl *D) {
David Blaikiebbafb8a2012-03-11 07:00:24 +00001417 assert(Context.getLangOpts().CPlusPlus &&
Anders Carlsson57235162010-04-16 15:57:11 +00001418 "Can only have wide bit-fields in C++!");
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001419
Anders Carlsson57235162010-04-16 15:57:11 +00001420 // Itanium C++ ABI 2.4:
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001421 // If sizeof(T)*8 < n, let T' be the largest integral POD type with
Anders Carlsson57235162010-04-16 15:57:11 +00001422 // sizeof(T')*8 <= n.
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001423
Anders Carlsson57235162010-04-16 15:57:11 +00001424 QualType IntegralPODTypes[] = {
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001425 Context.UnsignedCharTy, Context.UnsignedShortTy, Context.UnsignedIntTy,
Anders Carlsson57235162010-04-16 15:57:11 +00001426 Context.UnsignedLongTy, Context.UnsignedLongLongTy
1427 };
1428
Anders Carlsson57235162010-04-16 15:57:11 +00001429 QualType Type;
1430 for (unsigned I = 0, E = llvm::array_lengthof(IntegralPODTypes);
1431 I != E; ++I) {
1432 uint64_t Size = Context.getTypeSize(IntegralPODTypes[I]);
Anders Carlsson57235162010-04-16 15:57:11 +00001433
1434 if (Size > FieldSize)
1435 break;
1436
1437 Type = IntegralPODTypes[I];
1438 }
1439 assert(!Type.isNull() && "Did not find a type!");
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001440
Ken Dyckdbe37f32011-03-01 01:36:00 +00001441 CharUnits TypeAlign = Context.getTypeAlignInChars(Type);
Anders Carlsson57235162010-04-16 15:57:11 +00001442
1443 // We're not going to use any of the unfilled bits in the last byte.
Eli Friedman2782dac2013-06-26 20:50:34 +00001444 UnfilledBitsInLastUnit = 0;
1445 LastBitfieldTypeSize = 0;
Anders Carlsson57235162010-04-16 15:57:11 +00001446
Anders Carlssonaad5fa82010-04-17 20:21:41 +00001447 uint64_t FieldOffset;
Eli Friedman2782dac2013-06-26 20:50:34 +00001448 uint64_t UnpaddedFieldOffset = getDataSizeInBits() - UnfilledBitsInLastUnit;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001449
Anders Carlsson57235162010-04-16 15:57:11 +00001450 if (IsUnion) {
Ken Dyckecfc7552011-02-24 01:13:28 +00001451 setDataSize(std::max(getDataSizeInBits(), FieldSize));
Anders Carlssonaad5fa82010-04-17 20:21:41 +00001452 FieldOffset = 0;
Anders Carlsson57235162010-04-16 15:57:11 +00001453 } else {
Chad Rosiere1a6a0e2011-08-05 22:38:04 +00001454 // The bitfield is allocated starting at the next offset aligned
1455 // appropriately for T', with length n bits.
Ken Dyckdbe37f32011-03-01 01:36:00 +00001456 FieldOffset = llvm::RoundUpToAlignment(getDataSizeInBits(),
1457 Context.toBits(TypeAlign));
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001458
Anders Carlsson57235162010-04-16 15:57:11 +00001459 uint64_t NewSizeInBits = FieldOffset + FieldSize;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001460
Ken Dycka1a2e8d2011-03-10 02:00:35 +00001461 setDataSize(llvm::RoundUpToAlignment(NewSizeInBits,
Douglas Gregore8bbc122011-09-02 00:18:52 +00001462 Context.getTargetInfo().getCharAlign()));
Eli Friedman2782dac2013-06-26 20:50:34 +00001463 UnfilledBitsInLastUnit = getDataSizeInBits() - NewSizeInBits;
Anders Carlsson57235162010-04-16 15:57:11 +00001464 }
1465
1466 // Place this field at the current location.
1467 FieldOffsets.push_back(FieldOffset);
1468
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001469 CheckFieldPadding(FieldOffset, UnpaddedFieldOffset, FieldOffset,
Ken Dyckdbe37f32011-03-01 01:36:00 +00001470 Context.toBits(TypeAlign), FieldPacked, D);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001471
Anders Carlsson57235162010-04-16 15:57:11 +00001472 // Update the size.
Ken Dyckecfc7552011-02-24 01:13:28 +00001473 setSize(std::max(getSizeInBits(), getDataSizeInBits()));
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001474
Anders Carlsson57235162010-04-16 15:57:11 +00001475 // Remember max struct/class alignment.
Ken Dyckdbe37f32011-03-01 01:36:00 +00001476 UpdateAlignment(TypeAlign);
Anders Carlsson57235162010-04-16 15:57:11 +00001477}
1478
Anders Carlssonc2226202010-05-26 05:58:59 +00001479void RecordLayoutBuilder::LayoutBitField(const FieldDecl *D) {
Anders Carlsson07209442009-11-22 17:37:31 +00001480 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Richard Smithcaf33902011-10-10 18:28:20 +00001481 uint64_t FieldSize = D->getBitWidthValue(Context);
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001482 std::pair<uint64_t, unsigned> FieldInfo = Context.getTypeInfo(D->getType());
Anders Carlsson07209442009-11-22 17:37:31 +00001483 uint64_t TypeSize = FieldInfo.first;
1484 unsigned FieldAlign = FieldInfo.second;
Eli Friedman2782dac2013-06-26 20:50:34 +00001485
1486 if (IsMsStruct) {
1487 // The field alignment for integer types in ms_struct structs is
1488 // always the size.
Fariborz Jahanian7adbed62011-05-09 22:03:17 +00001489 FieldAlign = TypeSize;
Eli Friedman2782dac2013-06-26 20:50:34 +00001490 // Ignore zero-length bitfields after non-bitfields in ms_struct structs.
1491 if (!FieldSize && !LastBitfieldTypeSize)
1492 FieldAlign = 1;
1493 // If a bitfield is followed by a bitfield of a different size, don't
1494 // pack the bits together in ms_struct structs.
1495 if (LastBitfieldTypeSize != TypeSize) {
1496 UnfilledBitsInLastUnit = 0;
1497 LastBitfieldTypeSize = 0;
1498 }
1499 }
1500
1501 uint64_t UnpaddedFieldOffset = getDataSizeInBits() - UnfilledBitsInLastUnit;
1502 uint64_t FieldOffset = IsUnion ? 0 : UnpaddedFieldOffset;
Chad Rosier18903ee2011-08-04 01:21:14 +00001503
Eli Friedman481673f2013-06-26 23:47:39 +00001504 bool ZeroLengthBitfield = false;
1505 if (!Context.getTargetInfo().useBitFieldTypeAlignment() &&
1506 Context.getTargetInfo().useZeroLengthBitfieldAlignment() &&
1507 FieldSize == 0) {
Eli Friedman2782dac2013-06-26 20:50:34 +00001508 // The alignment of a zero-length bitfield affects the alignment
1509 // of the next member. The alignment is the max of the zero
1510 // length bitfield's alignment and a target specific fixed value.
Eli Friedman481673f2013-06-26 23:47:39 +00001511 ZeroLengthBitfield = true;
Eli Friedman2782dac2013-06-26 20:50:34 +00001512 unsigned ZeroLengthBitfieldBoundary =
1513 Context.getTargetInfo().getZeroLengthBitfieldBoundary();
1514 if (ZeroLengthBitfieldBoundary > FieldAlign)
1515 FieldAlign = ZeroLengthBitfieldBoundary;
Fariborz Jahanianfc0fe6e2011-05-03 20:21:04 +00001516 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001517
Anders Carlsson57235162010-04-16 15:57:11 +00001518 if (FieldSize > TypeSize) {
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001519 LayoutWideBitField(FieldSize, TypeSize, FieldPacked, D);
Anders Carlsson57235162010-04-16 15:57:11 +00001520 return;
1521 }
1522
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001523 // The align if the field is not packed. This is to check if the attribute
1524 // was unnecessary (-Wpacked).
1525 unsigned UnpackedFieldAlign = FieldAlign;
1526 uint64_t UnpackedFieldOffset = FieldOffset;
Douglas Gregore8bbc122011-09-02 00:18:52 +00001527 if (!Context.getTargetInfo().useBitFieldTypeAlignment() && !ZeroLengthBitfield)
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001528 UnpackedFieldAlign = 1;
1529
Chad Rosiere1a6a0e2011-08-05 22:38:04 +00001530 if (FieldPacked ||
Douglas Gregore8bbc122011-09-02 00:18:52 +00001531 (!Context.getTargetInfo().useBitFieldTypeAlignment() && !ZeroLengthBitfield))
Anders Carlsson07209442009-11-22 17:37:31 +00001532 FieldAlign = 1;
Alexis Huntdcfba7b2010-08-18 23:23:40 +00001533 FieldAlign = std::max(FieldAlign, D->getMaxAlignment());
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001534 UnpackedFieldAlign = std::max(UnpackedFieldAlign, D->getMaxAlignment());
Anders Carlsson07209442009-11-22 17:37:31 +00001535
1536 // The maximum field alignment overrides the aligned attribute.
Eli Friedmana91d38a2011-12-02 02:38:48 +00001537 if (!MaxFieldAlignment.isZero() && FieldSize != 0) {
Ken Dyck02ced6f2011-02-17 01:49:42 +00001538 unsigned MaxFieldAlignmentInBits = Context.toBits(MaxFieldAlignment);
1539 FieldAlign = std::min(FieldAlign, MaxFieldAlignmentInBits);
1540 UnpackedFieldAlign = std::min(UnpackedFieldAlign, MaxFieldAlignmentInBits);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001541 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001542
Eli Friedman2782dac2013-06-26 20:50:34 +00001543 // ms_struct bitfields always have to start at a round alignment.
1544 if (IsMsStruct && !LastBitfieldTypeSize) {
1545 FieldOffset = llvm::RoundUpToAlignment(FieldOffset, FieldAlign);
1546 UnpackedFieldOffset = llvm::RoundUpToAlignment(UnpackedFieldOffset,
1547 UnpackedFieldAlign);
1548 }
1549
Douglas Gregor44ba7892012-01-28 00:53:29 +00001550 // Check if we need to add padding to give the field the correct alignment.
1551 if (FieldSize == 0 ||
1552 (MaxFieldAlignment.isZero() &&
1553 (FieldOffset & (FieldAlign-1)) + FieldSize > TypeSize))
1554 FieldOffset = llvm::RoundUpToAlignment(FieldOffset, FieldAlign);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001555
Douglas Gregor44ba7892012-01-28 00:53:29 +00001556 if (FieldSize == 0 ||
1557 (MaxFieldAlignment.isZero() &&
1558 (UnpackedFieldOffset & (UnpackedFieldAlign-1)) + FieldSize > TypeSize))
1559 UnpackedFieldOffset = llvm::RoundUpToAlignment(UnpackedFieldOffset,
1560 UnpackedFieldAlign);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001561
Chad Rosiere1a6a0e2011-08-05 22:38:04 +00001562 // Padding members don't affect overall alignment, unless zero length bitfield
1563 // alignment is enabled.
Eli Friedman2782dac2013-06-26 20:50:34 +00001564 if (!D->getIdentifier() &&
1565 !Context.getTargetInfo().useZeroLengthBitfieldAlignment() &&
1566 !IsMsStruct)
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001567 FieldAlign = UnpackedFieldAlign = 1;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001568
Douglas Gregor44ba7892012-01-28 00:53:29 +00001569 if (ExternalLayout)
1570 FieldOffset = updateExternalFieldOffset(D, FieldOffset);
1571
Anders Carlsson07209442009-11-22 17:37:31 +00001572 // Place this field at the current location.
1573 FieldOffsets.push_back(FieldOffset);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001574
Douglas Gregore9fc3772012-01-26 07:55:45 +00001575 if (!ExternalLayout)
1576 CheckFieldPadding(FieldOffset, UnpaddedFieldOffset, UnpackedFieldOffset,
1577 UnpackedFieldAlign, FieldPacked, D);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001578
Anders Carlssonba958402009-11-22 19:13:51 +00001579 // Update DataSize to include the last byte containing (part of) the bitfield.
1580 if (IsUnion) {
1581 // FIXME: I think FieldSize should be TypeSize here.
Ken Dyckecfc7552011-02-24 01:13:28 +00001582 setDataSize(std::max(getDataSizeInBits(), FieldSize));
Anders Carlssonba958402009-11-22 19:13:51 +00001583 } else {
Eli Friedman2782dac2013-06-26 20:50:34 +00001584 if (IsMsStruct && FieldSize) {
1585 // Under ms_struct, a bitfield always takes up space equal to the size
1586 // of the type. We can't just change the alignment computation on the
1587 // other codepath because of the way this interacts with #pragma pack:
1588 // in a packed struct, we need to allocate misaligned space in the
1589 // struct to hold the bitfield.
1590 if (!UnfilledBitsInLastUnit) {
1591 setDataSize(FieldOffset + TypeSize);
1592 UnfilledBitsInLastUnit = TypeSize - FieldSize;
1593 } else if (UnfilledBitsInLastUnit < FieldSize) {
1594 setDataSize(getDataSizeInBits() + TypeSize);
1595 UnfilledBitsInLastUnit = TypeSize - FieldSize;
1596 } else {
1597 UnfilledBitsInLastUnit -= FieldSize;
1598 }
1599 LastBitfieldTypeSize = TypeSize;
1600 } else {
1601 uint64_t NewSizeInBits = FieldOffset + FieldSize;
1602 uint64_t BitfieldAlignment = Context.getTargetInfo().getCharAlign();
1603 setDataSize(llvm::RoundUpToAlignment(NewSizeInBits, BitfieldAlignment));
1604 UnfilledBitsInLastUnit = getDataSizeInBits() - NewSizeInBits;
1605 LastBitfieldTypeSize = 0;
1606 }
Anders Carlssonba958402009-11-22 19:13:51 +00001607 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001608
Anders Carlssonba958402009-11-22 19:13:51 +00001609 // Update the size.
Ken Dyckecfc7552011-02-24 01:13:28 +00001610 setSize(std::max(getSizeInBits(), getDataSizeInBits()));
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001611
Anders Carlsson07209442009-11-22 17:37:31 +00001612 // Remember max struct/class alignment.
Ken Dyck85ef0432011-02-19 18:58:07 +00001613 UpdateAlignment(Context.toCharUnitsFromBits(FieldAlign),
1614 Context.toCharUnitsFromBits(UnpackedFieldAlign));
Anders Carlsson07209442009-11-22 17:37:31 +00001615}
1616
Douglas Gregore9fc3772012-01-26 07:55:45 +00001617void RecordLayoutBuilder::LayoutField(const FieldDecl *D) {
Anders Carlsson07209442009-11-22 17:37:31 +00001618 if (D->isBitField()) {
1619 LayoutBitField(D);
1620 return;
1621 }
1622
Eli Friedman2782dac2013-06-26 20:50:34 +00001623 uint64_t UnpaddedFieldOffset = getDataSizeInBits() - UnfilledBitsInLastUnit;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001624
Anders Carlssonba958402009-11-22 19:13:51 +00001625 // Reset the unfilled bits.
Eli Friedman2782dac2013-06-26 20:50:34 +00001626 UnfilledBitsInLastUnit = 0;
1627 LastBitfieldTypeSize = 0;
Anders Carlssonba958402009-11-22 19:13:51 +00001628
Anders Carlsson07209442009-11-22 17:37:31 +00001629 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Ken Dyck6d90e892011-02-20 02:06:09 +00001630 CharUnits FieldOffset =
Ken Dyckecfc7552011-02-24 01:13:28 +00001631 IsUnion ? CharUnits::Zero() : getDataSize();
Ken Dyck6d90e892011-02-20 02:06:09 +00001632 CharUnits FieldSize;
1633 CharUnits FieldAlign;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001634
Anders Carlsson07209442009-11-22 17:37:31 +00001635 if (D->getType()->isIncompleteArrayType()) {
1636 // This is a flexible array member; we can't directly
1637 // query getTypeInfo about these, so we figure it out here.
1638 // Flexible array members don't have any size, but they
1639 // have to be aligned appropriately for their element type.
Ken Dyck6d90e892011-02-20 02:06:09 +00001640 FieldSize = CharUnits::Zero();
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001641 const ArrayType* ATy = Context.getAsArrayType(D->getType());
Ken Dyck6d90e892011-02-20 02:06:09 +00001642 FieldAlign = Context.getTypeAlignInChars(ATy->getElementType());
Anders Carlsson07209442009-11-22 17:37:31 +00001643 } else if (const ReferenceType *RT = D->getType()->getAs<ReferenceType>()) {
1644 unsigned AS = RT->getPointeeType().getAddressSpace();
Ken Dyck6d90e892011-02-20 02:06:09 +00001645 FieldSize =
Douglas Gregore8bbc122011-09-02 00:18:52 +00001646 Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerWidth(AS));
Ken Dyck6d90e892011-02-20 02:06:09 +00001647 FieldAlign =
Douglas Gregore8bbc122011-09-02 00:18:52 +00001648 Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerAlign(AS));
Anders Carlsson79474332009-07-18 20:20:21 +00001649 } else {
Ken Dyck6d90e892011-02-20 02:06:09 +00001650 std::pair<CharUnits, CharUnits> FieldInfo =
1651 Context.getTypeInfoInChars(D->getType());
Anders Carlsson07209442009-11-22 17:37:31 +00001652 FieldSize = FieldInfo.first;
1653 FieldAlign = FieldInfo.second;
Chad Rosier18903ee2011-08-04 01:21:14 +00001654
Eli Friedman9ee2d0472012-10-12 23:29:20 +00001655 if (IsMsStruct) {
Douglas Gregordbe39272011-02-01 15:15:22 +00001656 // If MS bitfield layout is required, figure out what type is being
1657 // laid out and align the field to the width of that type.
1658
1659 // Resolve all typedefs down to their base type and round up the field
1660 // alignment if necessary.
1661 QualType T = Context.getBaseElementType(D->getType());
1662 if (const BuiltinType *BTy = T->getAs<BuiltinType>()) {
Ken Dyck6d90e892011-02-20 02:06:09 +00001663 CharUnits TypeSize = Context.getTypeSizeInChars(BTy);
Douglas Gregordbe39272011-02-01 15:15:22 +00001664 if (TypeSize > FieldAlign)
1665 FieldAlign = TypeSize;
1666 }
1667 }
Anders Carlsson79474332009-07-18 20:20:21 +00001668 }
Mike Stump11289f42009-09-09 15:08:12 +00001669
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001670 // The align if the field is not packed. This is to check if the attribute
1671 // was unnecessary (-Wpacked).
Ken Dyck6d90e892011-02-20 02:06:09 +00001672 CharUnits UnpackedFieldAlign = FieldAlign;
1673 CharUnits UnpackedFieldOffset = FieldOffset;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001674
Anders Carlsson07209442009-11-22 17:37:31 +00001675 if (FieldPacked)
Ken Dyck6d90e892011-02-20 02:06:09 +00001676 FieldAlign = CharUnits::One();
1677 CharUnits MaxAlignmentInChars =
1678 Context.toCharUnitsFromBits(D->getMaxAlignment());
1679 FieldAlign = std::max(FieldAlign, MaxAlignmentInChars);
1680 UnpackedFieldAlign = std::max(UnpackedFieldAlign, MaxAlignmentInChars);
Anders Carlsson07209442009-11-22 17:37:31 +00001681
1682 // The maximum field alignment overrides the aligned attribute.
Ken Dyck02ced6f2011-02-17 01:49:42 +00001683 if (!MaxFieldAlignment.isZero()) {
Ken Dyck6d90e892011-02-20 02:06:09 +00001684 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
1685 UnpackedFieldAlign = std::min(UnpackedFieldAlign, MaxFieldAlignment);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001686 }
Anders Carlsson07209442009-11-22 17:37:31 +00001687
Douglas Gregor44ba7892012-01-28 00:53:29 +00001688 // Round up the current record size to the field's alignment boundary.
1689 FieldOffset = FieldOffset.RoundUpToAlignment(FieldAlign);
1690 UnpackedFieldOffset =
1691 UnpackedFieldOffset.RoundUpToAlignment(UnpackedFieldAlign);
1692
1693 if (ExternalLayout) {
1694 FieldOffset = Context.toCharUnitsFromBits(
1695 updateExternalFieldOffset(D, Context.toBits(FieldOffset)));
1696
1697 if (!IsUnion && EmptySubobjects) {
1698 // Record the fact that we're placing a field at this offset.
1699 bool Allowed = EmptySubobjects->CanPlaceFieldAtOffset(D, FieldOffset);
1700 (void)Allowed;
1701 assert(Allowed && "Externally-placed field cannot be placed here");
1702 }
1703 } else {
Douglas Gregore9fc3772012-01-26 07:55:45 +00001704 if (!IsUnion && EmptySubobjects) {
1705 // Check if we can place the field at this offset.
1706 while (!EmptySubobjects->CanPlaceFieldAtOffset(D, FieldOffset)) {
1707 // We couldn't place the field at the offset. Try again at a new offset.
1708 FieldOffset += FieldAlign;
1709 }
Anders Carlsson07209442009-11-22 17:37:31 +00001710 }
Anders Carlsson07209442009-11-22 17:37:31 +00001711 }
Douglas Gregore9fc3772012-01-26 07:55:45 +00001712
Anders Carlsson79474332009-07-18 20:20:21 +00001713 // Place this field at the current location.
Ken Dyck6d90e892011-02-20 02:06:09 +00001714 FieldOffsets.push_back(Context.toBits(FieldOffset));
Mike Stump11289f42009-09-09 15:08:12 +00001715
Douglas Gregore9fc3772012-01-26 07:55:45 +00001716 if (!ExternalLayout)
1717 CheckFieldPadding(Context.toBits(FieldOffset), UnpaddedFieldOffset,
1718 Context.toBits(UnpackedFieldOffset),
1719 Context.toBits(UnpackedFieldAlign), FieldPacked, D);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001720
Anders Carlsson79474332009-07-18 20:20:21 +00001721 // Reserve space for this field.
Eli Friedman43f18342012-01-12 23:27:03 +00001722 uint64_t FieldSizeInBits = Context.toBits(FieldSize);
Anders Carlsson79474332009-07-18 20:20:21 +00001723 if (IsUnion)
Eli Friedman2e108372012-01-12 23:48:56 +00001724 setDataSize(std::max(getDataSizeInBits(), FieldSizeInBits));
Anders Carlsson79474332009-07-18 20:20:21 +00001725 else
Eli Friedman2e108372012-01-12 23:48:56 +00001726 setDataSize(FieldOffset + FieldSize);
Mike Stump11289f42009-09-09 15:08:12 +00001727
Eli Friedman2e108372012-01-12 23:48:56 +00001728 // Update the size.
1729 setSize(std::max(getSizeInBits(), getDataSizeInBits()));
Mike Stump11289f42009-09-09 15:08:12 +00001730
Anders Carlsson79474332009-07-18 20:20:21 +00001731 // Remember max struct/class alignment.
Ken Dyck6d90e892011-02-20 02:06:09 +00001732 UpdateAlignment(FieldAlign, UnpackedFieldAlign);
Anders Carlsson79474332009-07-18 20:20:21 +00001733}
1734
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001735void RecordLayoutBuilder::FinishLayout(const NamedDecl *D) {
Anders Carlsson79474332009-07-18 20:20:21 +00001736 // In C++, records cannot be of size 0.
David Blaikiebbafb8a2012-03-11 07:00:24 +00001737 if (Context.getLangOpts().CPlusPlus && getSizeInBits() == 0) {
Fariborz Jahanian09b23312011-02-02 19:36:18 +00001738 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
1739 // Compatibility with gcc requires a class (pod or non-pod)
1740 // which is not empty but of size 0; such as having fields of
1741 // array of zero-length, remains of Size 0
1742 if (RD->isEmpty())
Ken Dyck1b4420e2011-02-28 02:01:38 +00001743 setSize(CharUnits::One());
Fariborz Jahanian09b23312011-02-02 19:36:18 +00001744 }
1745 else
Ken Dyck1b4420e2011-02-28 02:01:38 +00001746 setSize(CharUnits::One());
Fariborz Jahanian09b23312011-02-02 19:36:18 +00001747 }
Eli Friedman83a12582011-12-01 00:37:01 +00001748
Douglas Gregor1423a5c2012-10-26 22:31:14 +00001749 // Finally, round the size of the record up to the alignment of the
1750 // record itself.
Eli Friedman2782dac2013-06-26 20:50:34 +00001751 uint64_t UnpaddedSize = getSizeInBits() - UnfilledBitsInLastUnit;
Douglas Gregor1423a5c2012-10-26 22:31:14 +00001752 uint64_t UnpackedSizeInBits =
1753 llvm::RoundUpToAlignment(getSizeInBits(),
1754 Context.toBits(UnpackedAlignment));
1755 CharUnits UnpackedSize = Context.toCharUnitsFromBits(UnpackedSizeInBits);
1756 uint64_t RoundedSize
1757 = llvm::RoundUpToAlignment(getSizeInBits(), Context.toBits(Alignment));
1758
1759 if (ExternalLayout) {
1760 // If we're inferring alignment, and the external size is smaller than
1761 // our size after we've rounded up to alignment, conservatively set the
1762 // alignment to 1.
1763 if (InferAlignment && ExternalSize < RoundedSize) {
1764 Alignment = CharUnits::One();
1765 InferAlignment = false;
1766 }
1767 setSize(ExternalSize);
1768 return;
1769 }
1770
Douglas Gregor1423a5c2012-10-26 22:31:14 +00001771 // Set the size to the final size.
1772 setSize(RoundedSize);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001773
Douglas Gregore8bbc122011-09-02 00:18:52 +00001774 unsigned CharBitNum = Context.getTargetInfo().getCharWidth();
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001775 if (const RecordDecl *RD = dyn_cast<RecordDecl>(D)) {
1776 // Warn if padding was introduced to the struct/class/union.
Ken Dyckecfc7552011-02-24 01:13:28 +00001777 if (getSizeInBits() > UnpaddedSize) {
1778 unsigned PadSize = getSizeInBits() - UnpaddedSize;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001779 bool InBits = true;
1780 if (PadSize % CharBitNum == 0) {
1781 PadSize = PadSize / CharBitNum;
1782 InBits = false;
1783 }
1784 Diag(RD->getLocation(), diag::warn_padded_struct_size)
1785 << Context.getTypeDeclType(RD)
1786 << PadSize
1787 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1); // plural or not
1788 }
1789
1790 // Warn if we packed it unnecessarily. If the alignment is 1 byte don't
1791 // bother since there won't be alignment issues.
Ken Dyckecfc7552011-02-24 01:13:28 +00001792 if (Packed && UnpackedAlignment > CharUnits::One() &&
Ken Dyck1b4420e2011-02-28 02:01:38 +00001793 getSize() == UnpackedSize)
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001794 Diag(D->getLocation(), diag::warn_unnecessary_packed)
1795 << Context.getTypeDeclType(RD);
1796 }
Anders Carlsson79474332009-07-18 20:20:21 +00001797}
1798
Ken Dyck85ef0432011-02-19 18:58:07 +00001799void RecordLayoutBuilder::UpdateAlignment(CharUnits NewAlignment,
1800 CharUnits UnpackedNewAlignment) {
Douglas Gregore9fc3772012-01-26 07:55:45 +00001801 // The alignment is not modified when using 'mac68k' alignment or when
Douglas Gregor44ba7892012-01-28 00:53:29 +00001802 // we have an externally-supplied layout that also provides overall alignment.
1803 if (IsMac68kAlign || (ExternalLayout && !InferAlignment))
Daniel Dunbar6da10982010-05-27 05:45:51 +00001804 return;
1805
Ken Dyck85ef0432011-02-19 18:58:07 +00001806 if (NewAlignment > Alignment) {
1807 assert(llvm::isPowerOf2_32(NewAlignment.getQuantity() &&
1808 "Alignment not a power of 2"));
1809 Alignment = NewAlignment;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001810 }
1811
Ken Dyck85ef0432011-02-19 18:58:07 +00001812 if (UnpackedNewAlignment > UnpackedAlignment) {
1813 assert(llvm::isPowerOf2_32(UnpackedNewAlignment.getQuantity() &&
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001814 "Alignment not a power of 2"));
Ken Dyck85ef0432011-02-19 18:58:07 +00001815 UnpackedAlignment = UnpackedNewAlignment;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001816 }
1817}
1818
Douglas Gregor44ba7892012-01-28 00:53:29 +00001819uint64_t
1820RecordLayoutBuilder::updateExternalFieldOffset(const FieldDecl *Field,
1821 uint64_t ComputedOffset) {
1822 assert(ExternalFieldOffsets.find(Field) != ExternalFieldOffsets.end() &&
1823 "Field does not have an external offset");
1824
1825 uint64_t ExternalFieldOffset = ExternalFieldOffsets[Field];
1826
1827 if (InferAlignment && ExternalFieldOffset < ComputedOffset) {
1828 // The externally-supplied field offset is before the field offset we
1829 // computed. Assume that the structure is packed.
Douglas Gregor1423a5c2012-10-26 22:31:14 +00001830 Alignment = CharUnits::One();
Douglas Gregor44ba7892012-01-28 00:53:29 +00001831 InferAlignment = false;
1832 }
1833
1834 // Use the externally-supplied field offset.
Benjamin Kramer648e68b2012-08-31 22:14:25 +00001835 return ExternalFieldOffset;
1836}
1837
1838/// \brief Get diagnostic %select index for tag kind for
1839/// field padding diagnostic message.
1840/// WARNING: Indexes apply to particular diagnostics only!
1841///
1842/// \returns diagnostic %select index.
1843static unsigned getPaddingDiagFromTagKind(TagTypeKind Tag) {
1844 switch (Tag) {
1845 case TTK_Struct: return 0;
1846 case TTK_Interface: return 1;
1847 case TTK_Class: return 2;
1848 default: llvm_unreachable("Invalid tag kind for field padding diagnostic!");
1849 }
1850}
1851
1852void RecordLayoutBuilder::CheckFieldPadding(uint64_t Offset,
1853 uint64_t UnpaddedOffset,
1854 uint64_t UnpackedOffset,
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001855 unsigned UnpackedAlign,
1856 bool isPacked,
1857 const FieldDecl *D) {
1858 // We let objc ivars without warning, objc interfaces generally are not used
1859 // for padding tricks.
1860 if (isa<ObjCIvarDecl>(D))
Anders Carlsson79474332009-07-18 20:20:21 +00001861 return;
Mike Stump11289f42009-09-09 15:08:12 +00001862
Ted Kremenekfed48af2011-09-06 19:40:45 +00001863 // Don't warn about structs created without a SourceLocation. This can
1864 // be done by clients of the AST, such as codegen.
1865 if (D->getLocation().isInvalid())
1866 return;
1867
Douglas Gregore8bbc122011-09-02 00:18:52 +00001868 unsigned CharBitNum = Context.getTargetInfo().getCharWidth();
Mike Stump11289f42009-09-09 15:08:12 +00001869
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001870 // Warn if padding was introduced to the struct/class.
1871 if (!IsUnion && Offset > UnpaddedOffset) {
1872 unsigned PadSize = Offset - UnpaddedOffset;
1873 bool InBits = true;
1874 if (PadSize % CharBitNum == 0) {
1875 PadSize = PadSize / CharBitNum;
1876 InBits = false;
Benjamin Kramer648e68b2012-08-31 22:14:25 +00001877 }
1878 if (D->getIdentifier())
1879 Diag(D->getLocation(), diag::warn_padded_struct_field)
1880 << getPaddingDiagFromTagKind(D->getParent()->getTagKind())
1881 << Context.getTypeDeclType(D->getParent())
1882 << PadSize
1883 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1) // plural or not
1884 << D->getIdentifier();
1885 else
1886 Diag(D->getLocation(), diag::warn_padded_struct_anon_field)
1887 << getPaddingDiagFromTagKind(D->getParent()->getTagKind())
1888 << Context.getTypeDeclType(D->getParent())
1889 << PadSize
1890 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1); // plural or not
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001891 }
1892
1893 // Warn if we packed it unnecessarily. If the alignment is 1 byte don't
1894 // bother since there won't be alignment issues.
1895 if (isPacked && UnpackedAlign > CharBitNum && Offset == UnpackedOffset)
1896 Diag(D->getLocation(), diag::warn_unnecessary_packed)
1897 << D->getIdentifier();
Anders Carlsson79474332009-07-18 20:20:21 +00001898}
Mike Stump11289f42009-09-09 15:08:12 +00001899
John McCall6bd2a892013-01-25 22:31:03 +00001900static const CXXMethodDecl *computeKeyFunction(ASTContext &Context,
1901 const CXXRecordDecl *RD) {
Daniel Dunbarccabe482010-04-19 20:44:53 +00001902 // If a class isn't polymorphic it doesn't have a key function.
Anders Carlsson5ebf8b42009-12-07 04:35:11 +00001903 if (!RD->isPolymorphic())
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001904 return 0;
Eli Friedmanf2c79b62009-12-08 03:56:49 +00001905
Eli Friedman300f55d2011-06-10 21:53:06 +00001906 // A class that is not externally visible doesn't have a key function. (Or
Eli Friedmanf2c79b62009-12-08 03:56:49 +00001907 // at least, there's no point to assigning a key function to such a class;
1908 // this doesn't affect the ABI.)
Rafael Espindola3ae00052013-05-13 00:12:11 +00001909 if (!RD->isExternallyVisible())
Eli Friedmanf2c79b62009-12-08 03:56:49 +00001910 return 0;
1911
Argyrios Kyrtzidis8c64bbe2010-10-13 02:39:41 +00001912 // Template instantiations don't have key functions,see Itanium C++ ABI 5.2.6.
1913 // Same behavior as GCC.
1914 TemplateSpecializationKind TSK = RD->getTemplateSpecializationKind();
1915 if (TSK == TSK_ImplicitInstantiation ||
1916 TSK == TSK_ExplicitInstantiationDefinition)
1917 return 0;
1918
John McCall6bd2a892013-01-25 22:31:03 +00001919 bool allowInlineFunctions =
1920 Context.getTargetInfo().getCXXABI().canKeyFunctionBeInline();
1921
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001922 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
1923 E = RD->method_end(); I != E; ++I) {
David Blaikie40ed2972012-06-06 20:45:41 +00001924 const CXXMethodDecl *MD = *I;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001925
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001926 if (!MD->isVirtual())
1927 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001928
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001929 if (MD->isPure())
1930 continue;
Eli Friedmanf2c79b62009-12-08 03:56:49 +00001931
Anders Carlssonf98849e2009-12-02 17:15:43 +00001932 // Ignore implicit member functions, they are always marked as inline, but
1933 // they don't have a body until they're defined.
1934 if (MD->isImplicit())
1935 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001936
Douglas Gregora318efd2010-01-05 19:06:31 +00001937 if (MD->isInlineSpecified())
1938 continue;
Eli Friedman71a26d82009-12-06 20:50:05 +00001939
1940 if (MD->hasInlineBody())
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001941 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001942
Benjamin Kramer4a902082012-08-03 15:43:22 +00001943 // Ignore inline deleted or defaulted functions.
Benjamin Kramer73d1be72012-08-03 08:39:58 +00001944 if (!MD->isUserProvided())
1945 continue;
1946
John McCall6bd2a892013-01-25 22:31:03 +00001947 // In certain ABIs, ignore functions with out-of-line inline definitions.
1948 if (!allowInlineFunctions) {
1949 const FunctionDecl *Def;
1950 if (MD->hasBody(Def) && Def->isInlineSpecified())
1951 continue;
1952 }
1953
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001954 // We found it.
1955 return MD;
1956 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001957
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001958 return 0;
1959}
1960
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001961DiagnosticBuilder
1962RecordLayoutBuilder::Diag(SourceLocation Loc, unsigned DiagID) {
Argyrios Kyrtzidisd0040642010-11-18 20:06:41 +00001963 return Context.getDiagnostics().Report(Loc, DiagID);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001964}
1965
John McCall5c1f1d02013-01-29 01:14:22 +00001966/// Does the target C++ ABI require us to skip over the tail-padding
1967/// of the given class (considering it as a base class) when allocating
1968/// objects?
1969static bool mustSkipTailPadding(TargetCXXABI ABI, const CXXRecordDecl *RD) {
1970 switch (ABI.getTailPaddingUseRules()) {
1971 case TargetCXXABI::AlwaysUseTailPadding:
1972 return false;
1973
1974 case TargetCXXABI::UseTailPaddingUnlessPOD03:
1975 // FIXME: To the extent that this is meant to cover the Itanium ABI
1976 // rules, we should implement the restrictions about over-sized
1977 // bitfields:
1978 //
1979 // http://mentorembedded.github.com/cxx-abi/abi.html#POD :
1980 // In general, a type is considered a POD for the purposes of
1981 // layout if it is a POD type (in the sense of ISO C++
1982 // [basic.types]). However, a POD-struct or POD-union (in the
1983 // sense of ISO C++ [class]) with a bitfield member whose
1984 // declared width is wider than the declared type of the
1985 // bitfield is not a POD for the purpose of layout. Similarly,
1986 // an array type is not a POD for the purpose of layout if the
1987 // element type of the array is not a POD for the purpose of
1988 // layout.
1989 //
1990 // Where references to the ISO C++ are made in this paragraph,
1991 // the Technical Corrigendum 1 version of the standard is
1992 // intended.
1993 return RD->isPOD();
1994
1995 case TargetCXXABI::UseTailPaddingUnlessPOD11:
1996 // This is equivalent to RD->getTypeForDecl().isCXX11PODType(),
1997 // but with a lot of abstraction penalty stripped off. This does
1998 // assume that these properties are set correctly even in C++98
1999 // mode; fortunately, that is true because we want to assign
2000 // consistently semantics to the type-traits intrinsics (or at
2001 // least as many of them as possible).
2002 return RD->isTrivial() && RD->isStandardLayout();
2003 }
2004
2005 llvm_unreachable("bad tail-padding use kind");
2006}
2007
Warren Hunt8f8bad72013-10-11 20:19:00 +00002008static bool isMsLayout(const RecordDecl* D) {
Warren Hunt55d8e822013-10-23 23:53:07 +00002009 return D->getASTContext().getTargetInfo().getCXXABI().isMicrosoft();
Warren Hunt8f8bad72013-10-11 20:19:00 +00002010}
2011
2012// This section contains an implementation of struct layout that is, up to the
2013// included tests, compatible with cl.exe (2012). The layout produced is
2014// significantly different than those produced by the Itanium ABI. Here we note
2015// the most important differences.
2016//
2017// * The alignment of bitfields in unions is ignored when computing the
2018// alignment of the union.
2019// * The existance of zero-width bitfield that occurs after anything other than
2020// a non-zero length bitfield is ignored.
2021// * The Itanium equivalent vtable pointers are split into a vfptr (virtual
2022// function pointer) and a vbptr (virtual base pointer). They can each be
Warren Hunt55d8e822013-10-23 23:53:07 +00002023// shared with a, non-virtual bases. These bases need not be the same. vfptrs
2024// always occur at offset 0. vbptrs can occur at an
Warren Hunt8f8bad72013-10-11 20:19:00 +00002025// arbitrary offset and are placed after non-virtual bases but before fields.
2026// * Virtual bases sometimes require a 'vtordisp' field that is laid out before
2027// the virtual base and is used in conjunction with virtual overrides during
2028// construction and destruction.
2029// * vfptrs are allocated in a block of memory equal to the alignment of the
Warren Hunt55d8e822013-10-23 23:53:07 +00002030// fields and non-virtual bases at offset 0 in 32 bit mode and in a pointer
2031// sized block of memory in 64 bit mode.
Warren Hunt8f8bad72013-10-11 20:19:00 +00002032// * vbptrs are allocated in a block of memory equal to the alignment of the
Warren Hunt55d8e822013-10-23 23:53:07 +00002033// fields and non-virtual bases. This block is at a potentially unaligned
2034// offset. If the allocation slot is unaligned and the alignment is less than
2035// or equal to the pointer size, additional space is allocated so that the
2036// pointer can be aligned properly. This causes very strange effects on the
2037// placement of objects after the allocated block. (see the code).
Warren Hunt8f8bad72013-10-11 20:19:00 +00002038// * vtordisps are allocated in a block of memory with size and alignment equal
2039// to the alignment of the completed structure (before applying __declspec(
Warren Hunt55d8e822013-10-23 23:53:07 +00002040// align())). The vtordisp always occur at the end of the allocation block,
2041// immediately prior to the virtual base.
Warren Hunt8f8bad72013-10-11 20:19:00 +00002042// * The last zero sized non-virtual base is allocated after the placement of
2043// vbptr if one exists and can be placed at the end of the struct, potentially
2044// aliasing either the first member or another struct allocated after this
2045// one.
2046// * The last zero size virtual base may be placed at the end of the struct.
2047// and can potentially alias a zero sized type in the next struct.
2048
2049namespace {
2050struct MicrosoftRecordLayoutBuilder {
2051 typedef llvm::DenseMap<const CXXRecordDecl *, CharUnits> BaseOffsetsMapTy;
2052 MicrosoftRecordLayoutBuilder(const ASTContext &Context) : Context(Context) {}
2053private:
2054 MicrosoftRecordLayoutBuilder(const MicrosoftRecordLayoutBuilder &)
2055 LLVM_DELETED_FUNCTION;
2056 void operator=(const MicrosoftRecordLayoutBuilder &) LLVM_DELETED_FUNCTION;
2057public:
2058
2059 void layout(const RecordDecl *RD);
2060 void cxxLayout(const CXXRecordDecl *RD);
2061 /// \brief Initializes size and alignment and honors some flags.
2062 void initializeLayout(const RecordDecl *RD);
2063 /// \brief Initialized C++ layout, compute alignment and virtual alignment and
2064 /// existance of vfptrs and vbptrs. Alignment is needed before the vfptr is
2065 /// laid out.
2066 void initializeCXXLayout(const CXXRecordDecl *RD);
2067 void layoutVFPtr(const CXXRecordDecl *RD);
2068 void layoutNonVirtualBases(const CXXRecordDecl *RD);
2069 void layoutNonVirtualBase(const CXXRecordDecl *RD);
2070 void layoutVBPtr(const CXXRecordDecl *RD);
2071 /// \brief Lays out the fields of the record. Also rounds size up to
2072 /// alignment.
2073 void layoutFields(const RecordDecl *RD);
2074 void layoutField(const FieldDecl *FD);
2075 void layoutBitField(const FieldDecl *FD);
2076 /// \brief Lays out a single zero-width bit-field in the record and handles
2077 /// special cases associated with zero-width bit-fields.
2078 void layoutZeroWidthBitField(const FieldDecl *FD);
2079 void layoutVirtualBases(const CXXRecordDecl *RD);
2080 void layoutVirtualBase(const CXXRecordDecl *RD, bool HasVtordisp);
2081 /// \brief Flushes the lazy virtual base and conditionally rounds up to
2082 /// alignment.
2083 void finalizeCXXLayout(const CXXRecordDecl *RD);
2084 void honorDeclspecAlign(const RecordDecl *RD);
2085
2086 /// \brief Updates the alignment of the type. This function doesn't take any
2087 /// properties (such as packedness) into account. getAdjustedFieldInfo()
2088 /// adjustes for packedness.
2089 void updateAlignment(CharUnits NewAlignment) {
2090 Alignment = std::max(Alignment, NewAlignment);
2091 }
2092 /// \brief Gets the size and alignment taking attributes into account.
2093 std::pair<CharUnits, CharUnits> getAdjustedFieldInfo(const FieldDecl *FD);
2094 /// \brief Places a field at offset 0.
2095 void placeFieldAtZero() { FieldOffsets.push_back(0); }
2096 /// \brief Places a field at an offset in CharUnits.
2097 void placeFieldAtOffset(CharUnits FieldOffset) {
2098 FieldOffsets.push_back(Context.toBits(FieldOffset));
2099 }
2100 /// \brief Places a bitfield at a bit offset.
2101 void placeFieldAtBitOffset(uint64_t FieldOffset) {
2102 FieldOffsets.push_back(FieldOffset);
2103 }
2104 /// \brief Compute the set of virtual bases for which vtordisps are required.
2105 llvm::SmallPtrSet<const CXXRecordDecl *, 2>
2106 computeVtorDispSet(const CXXRecordDecl *RD);
2107
2108 const ASTContext &Context;
2109 /// \brief The size of the record being laid out.
2110 CharUnits Size;
2111 /// \brief The current alignment of the record layout.
2112 CharUnits Alignment;
2113 /// \brief The collection of field offsets.
2114 SmallVector<uint64_t, 16> FieldOffsets;
2115 /// \brief The maximum allowed field alignment. This is set by #pragma pack.
2116 CharUnits MaxFieldAlignment;
2117 /// \brief Alignment does not occur for virtual bases unless something
2118 /// forces it to by explicitly using __declspec(align())
2119 bool AlignAfterVBases : 1;
2120 bool IsUnion : 1;
2121 /// \brief True if the last field laid out was a bitfield and was not 0
2122 /// width.
2123 bool LastFieldIsNonZeroWidthBitfield : 1;
2124 /// \brief The size of the allocation of the currently active bitfield.
2125 /// This value isn't meaningful unless LastFieldIsNonZeroWidthBitfield
2126 /// is true.
2127 CharUnits CurrentBitfieldSize;
2128 /// \brief The number of remaining bits in our last bitfield allocation.
2129 /// This value isn't meaningful unless LastFieldIsNonZeroWidthBitfield is
2130 /// true.
2131 unsigned RemainingBitsInField;
2132
2133 /// \brief The data alignment of the record layout.
2134 CharUnits DataSize;
2135 /// \brief The alignment of the non-virtual portion of the record layout
Warren Hunt55d8e822013-10-23 23:53:07 +00002136 /// without the impact of the virtual pointers.
2137 /// Only used for C++ layouts.
2138 CharUnits BasesAndFieldsAlignment;
2139 /// \brief The alignment of the non-virtual portion of the record layout
2140 /// Only used for C++ layouts.
Warren Hunt8f8bad72013-10-11 20:19:00 +00002141 CharUnits NonVirtualAlignment;
2142 /// \brief The additional alignment imposed by the virtual bases.
2143 CharUnits VirtualAlignment;
2144 /// \brief The primary base class (if one exists).
2145 const CXXRecordDecl *PrimaryBase;
2146 /// \brief The class we share our vb-pointer with.
2147 const CXXRecordDecl *SharedVBPtrBase;
2148 /// \brief True if the class has a (not necessarily its own) vftable pointer.
2149 bool HasVFPtr : 1;
2150 /// \brief True if the class has a (not necessarily its own) vbtable pointer.
2151 bool HasVBPtr : 1;
2152 /// \brief Offset to the virtual base table pointer (if one exists).
2153 CharUnits VBPtrOffset;
2154 /// \brief Base classes and their offsets in the record.
2155 BaseOffsetsMapTy Bases;
2156 /// \brief virtual base classes and their offsets in the record.
2157 ASTRecordLayout::VBaseOffsetsMapTy VBases;
2158 /// \brief The size of a pointer.
2159 CharUnits PointerSize;
2160 /// \brief The alignment of a pointer.
2161 CharUnits PointerAlignment;
2162 /// \brief Holds an empty base we haven't yet laid out.
2163 const CXXRecordDecl *LazyEmptyBase;
Warren Hunt55d8e822013-10-23 23:53:07 +00002164 /// \brief Lets us know if the last base we laid out was empty. Only used
2165 /// when adjusting the placement of a last zero-sized base in 64 bit mode.
2166 bool LastBaseWasEmpty;
2167 /// \brief Lets us know if we're in 64-bit mode
2168 bool Is64BitMode;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002169};
2170} // namespace
2171
2172std::pair<CharUnits, CharUnits>
2173MicrosoftRecordLayoutBuilder::getAdjustedFieldInfo(const FieldDecl *FD) {
2174 std::pair<CharUnits, CharUnits> FieldInfo;
2175 if (FD->getType()->isIncompleteArrayType()) {
2176 // This is a flexible array member; we can't directly
2177 // query getTypeInfo about these, so we figure it out here.
2178 // Flexible array members don't have any size, but they
2179 // have to be aligned appropriately for their element type.
2180 FieldInfo.first = CharUnits::Zero();
2181 const ArrayType *ATy = Context.getAsArrayType(FD->getType());
2182 FieldInfo.second = Context.getTypeAlignInChars(ATy->getElementType());
2183 } else if (const ReferenceType *RT = FD->getType()->getAs<ReferenceType>()) {
2184 unsigned AS = RT->getPointeeType().getAddressSpace();
2185 FieldInfo.first = Context
2186 .toCharUnitsFromBits(Context.getTargetInfo().getPointerWidth(AS));
2187 FieldInfo.second = Context
2188 .toCharUnitsFromBits(Context.getTargetInfo().getPointerAlign(AS));
2189 } else
2190 FieldInfo = Context.getTypeInfoInChars(FD->getType());
2191
2192 // If we're not on win32 and using ms_struct the field alignment will be wrong
2193 // for 64 bit types, so we fix that here.
2194 if (FD->getASTContext().getTargetInfo().getTriple().getOS() !=
2195 llvm::Triple::Win32) {
2196 QualType T = Context.getBaseElementType(FD->getType());
2197 if (const BuiltinType *BTy = T->getAs<BuiltinType>()) {
2198 CharUnits TypeSize = Context.getTypeSizeInChars(BTy);
2199 if (TypeSize > FieldInfo.second)
2200 FieldInfo.second = TypeSize;
2201 }
2202 }
2203
2204 // Respect packed attribute.
2205 if (FD->hasAttr<PackedAttr>())
2206 FieldInfo.second = CharUnits::One();
2207 // Respect pack pragma.
2208 else if (!MaxFieldAlignment.isZero())
2209 FieldInfo.second = std::min(FieldInfo.second, MaxFieldAlignment);
2210 // Respect alignment attributes.
2211 if (unsigned fieldAlign = FD->getMaxAlignment()) {
2212 CharUnits FieldAlign = Context.toCharUnitsFromBits(fieldAlign);
2213 AlignAfterVBases = true;
2214 FieldInfo.second = std::max(FieldInfo.second, FieldAlign);
2215 }
2216 return FieldInfo;
2217}
2218
2219void MicrosoftRecordLayoutBuilder::initializeLayout(const RecordDecl *RD) {
2220 IsUnion = RD->isUnion();
Warren Hunt55d8e822013-10-23 23:53:07 +00002221 Is64BitMode = RD->getASTContext().getTargetInfo().getTriple().getArch() ==
2222 llvm::Triple::x86_64;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002223
2224 Size = CharUnits::Zero();
2225 Alignment = CharUnits::One();
2226 AlignAfterVBases = false;
2227
2228 // Compute the maximum field alignment.
2229 MaxFieldAlignment = CharUnits::Zero();
2230 // Honor the default struct packing maximum alignment flag.
2231 if (unsigned DefaultMaxFieldAlignment = Context.getLangOpts().PackStruct)
2232 MaxFieldAlignment = CharUnits::fromQuantity(DefaultMaxFieldAlignment);
2233 // Honor the packing attribute.
2234 if (const MaxFieldAlignmentAttr *MFAA = RD->getAttr<MaxFieldAlignmentAttr>())
2235 MaxFieldAlignment = Context.toCharUnitsFromBits(MFAA->getAlignment());
2236 // Packed attribute forces max field alignment to be 1.
2237 if (RD->hasAttr<PackedAttr>())
2238 MaxFieldAlignment = CharUnits::One();
2239}
2240
2241void MicrosoftRecordLayoutBuilder::layout(const RecordDecl *RD) {
2242 initializeLayout(RD);
2243 layoutFields(RD);
2244 honorDeclspecAlign(RD);
2245}
2246
2247void MicrosoftRecordLayoutBuilder::cxxLayout(const CXXRecordDecl *RD) {
2248 initializeLayout(RD);
2249 initializeCXXLayout(RD);
2250 layoutVFPtr(RD);
2251 layoutNonVirtualBases(RD);
2252 layoutVBPtr(RD);
2253 layoutFields(RD);
2254 DataSize = Size;
2255 NonVirtualAlignment = Alignment;
2256 layoutVirtualBases(RD);
2257 finalizeCXXLayout(RD);
2258 honorDeclspecAlign(RD);
2259}
2260
2261void
2262MicrosoftRecordLayoutBuilder::initializeCXXLayout(const CXXRecordDecl *RD) {
2263 // Calculate pointer size and alignment.
2264 PointerSize =
2265 Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerWidth(0));
2266 PointerAlignment = PointerSize;
2267 if (!MaxFieldAlignment.isZero())
2268 PointerAlignment = std::min(PointerAlignment, MaxFieldAlignment);
2269
2270 // Initialize information about the bases.
2271 HasVBPtr = false;
2272 HasVFPtr = false;
2273 SharedVBPtrBase = 0;
2274 PrimaryBase = 0;
2275 VirtualAlignment = CharUnits::One();
Warren Hunt55d8e822013-10-23 23:53:07 +00002276 AlignAfterVBases = Is64BitMode;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002277
2278 // If the record has a dynamic base class, attempt to choose a primary base
2279 // class. It is the first (in direct base class order) non-virtual dynamic
2280 // base class, if one exists.
2281 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
2282 e = RD->bases_end();
2283 i != e; ++i) {
2284 const CXXRecordDecl *BaseDecl =
2285 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
2286 const ASTRecordLayout &Layout = Context.getASTRecordLayout(BaseDecl);
2287 // Handle forced alignment.
2288 if (Layout.getAlignAfterVBases())
2289 AlignAfterVBases = true;
2290 // Handle virtual bases.
2291 if (i->isVirtual()) {
2292 VirtualAlignment = std::max(VirtualAlignment, Layout.getAlignment());
2293 HasVBPtr = true;
2294 continue;
2295 }
2296 // We located a primary base class!
2297 if (!PrimaryBase && Layout.hasVFPtr()) {
2298 PrimaryBase = BaseDecl;
2299 HasVFPtr = true;
2300 }
2301 // We located a base to share a VBPtr with!
2302 if (!SharedVBPtrBase && Layout.hasVBPtr()) {
2303 SharedVBPtrBase = BaseDecl;
2304 HasVBPtr = true;
2305 }
2306 updateAlignment(Layout.getAlignment());
2307 }
2308
2309 // Use LayoutFields to compute the alignment of the fields. The layout
2310 // is discarded. This is the simplest way to get all of the bit-field
2311 // behavior correct and is not actually very expensive.
2312 layoutFields(RD);
2313 Size = CharUnits::Zero();
Warren Hunt55d8e822013-10-23 23:53:07 +00002314 BasesAndFieldsAlignment = Alignment;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002315 FieldOffsets.clear();
2316}
2317
2318void MicrosoftRecordLayoutBuilder::layoutVFPtr(const CXXRecordDecl *RD) {
2319 // If we have a primary base then our VFPtr was already laid out
2320 if (PrimaryBase)
2321 return;
2322
2323 // Look at all of our methods to determine if we need a VFPtr. We need a
2324 // vfptr if we define a new virtual function.
2325 if (!HasVFPtr && RD->isDynamicClass())
2326 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
2327 e = RD->method_end();
2328 !HasVFPtr && i != e; ++i)
2329 HasVFPtr = i->isVirtual() && i->size_overridden_methods() == 0;
2330 if (!HasVFPtr)
2331 return;
2332
Warren Hunt55d8e822013-10-23 23:53:07 +00002333 // MSVC 32 (but not 64) potentially over-aligns the vf-table pointer by giving
2334 // it the max alignment of all the non-virtual data in the class. The
2335 // resulting layout is essentially { vftbl, { nvdata } }. This is completely
Warren Hunt8f8bad72013-10-11 20:19:00 +00002336 // unnecessary, but we're not here to pass judgment.
Warren Hunt8f8bad72013-10-11 20:19:00 +00002337 updateAlignment(PointerAlignment);
Warren Hunt55d8e822013-10-23 23:53:07 +00002338 if (Is64BitMode)
2339 Size = Size.RoundUpToAlignment(PointerAlignment) + PointerSize;
2340 else
2341 Size = Size.RoundUpToAlignment(PointerAlignment) + Alignment;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002342}
2343
2344void
2345MicrosoftRecordLayoutBuilder::layoutNonVirtualBases(const CXXRecordDecl *RD) {
2346 LazyEmptyBase = 0;
Warren Hunt55d8e822013-10-23 23:53:07 +00002347 LastBaseWasEmpty = false;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002348
2349 // Lay out the primary base first.
2350 if (PrimaryBase)
2351 layoutNonVirtualBase(PrimaryBase);
2352
2353 // Iterate through the bases and lay out the non-virtual ones.
2354 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
2355 e = RD->bases_end();
2356 i != e; ++i) {
2357 if (i->isVirtual())
2358 continue;
2359 const CXXRecordDecl *BaseDecl =
2360 cast<CXXRecordDecl>(i->getType()->castAs<RecordType>()->getDecl());
2361 if (BaseDecl != PrimaryBase)
2362 layoutNonVirtualBase(BaseDecl);
2363 }
2364}
2365
2366void
2367MicrosoftRecordLayoutBuilder::layoutNonVirtualBase(const CXXRecordDecl *RD) {
2368 const ASTRecordLayout *Layout = RD ? &Context.getASTRecordLayout(RD) : 0;
2369
2370 // If we have a lazy empty base we haven't laid out yet, do that now.
2371 if (LazyEmptyBase) {
2372 const ASTRecordLayout &LazyLayout =
2373 Context.getASTRecordLayout(LazyEmptyBase);
2374 Size = Size.RoundUpToAlignment(LazyLayout.getAlignment());
2375 Bases.insert(std::make_pair(LazyEmptyBase, Size));
2376 // Empty bases only consume space when followed by another empty base.
Warren Hunt55d8e822013-10-23 23:53:07 +00002377 if (RD && Layout->getNonVirtualSize().isZero()) {
2378 LastBaseWasEmpty = true;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002379 Size++;
Warren Hunt55d8e822013-10-23 23:53:07 +00002380 }
Warren Hunt8f8bad72013-10-11 20:19:00 +00002381 LazyEmptyBase = 0;
2382 }
2383
2384 // RD is null when flushing the final lazy base.
2385 if (!RD)
2386 return;
2387
2388 if (Layout->getNonVirtualSize().isZero()) {
2389 LazyEmptyBase = RD;
2390 return;
2391 }
2392
2393 // Insert the base here.
2394 CharUnits BaseOffset = Size.RoundUpToAlignment(Layout->getAlignment());
2395 Bases.insert(std::make_pair(RD, BaseOffset));
2396 Size = BaseOffset + Layout->getDataSize();
2397 // Note: we don't update alignment here because it was accounted
2398 // for during initalization.
Warren Hunt55d8e822013-10-23 23:53:07 +00002399 LastBaseWasEmpty = false;
Warren Hunt8f8bad72013-10-11 20:19:00 +00002400}
2401
2402void MicrosoftRecordLayoutBuilder::layoutVBPtr(const CXXRecordDecl *RD) {
2403 if (!HasVBPtr)
2404 VBPtrOffset = CharUnits::fromQuantity(-1);
2405 else if (SharedVBPtrBase) {
2406 const ASTRecordLayout &Layout = Context.getASTRecordLayout(SharedVBPtrBase);
2407 VBPtrOffset = Bases[SharedVBPtrBase] + Layout.getVBPtrOffset();
2408 } else {
Warren Hunt8f8bad72013-10-11 20:19:00 +00002409 VBPtrOffset = Size.RoundUpToAlignment(PointerAlignment);
Warren Hunt55d8e822013-10-23 23:53:07 +00002410 CharUnits OldSize = Size;
2411 Size = VBPtrOffset + PointerSize;
2412 if (BasesAndFieldsAlignment <= PointerAlignment) {
2413 // Handle strange padding rules for the lazily placed base. I have no
2414 // explanation for why the last virtual base is padded in such an odd way.
2415 // Two things to note about this padding are that the rules are different
2416 // if the alignment of the bases+fields is <= to the alignemnt of a
2417 // pointer and that the rule in 64-bit mode behaves differently depending
2418 // on if the second to last base was also zero sized.
2419 Size += OldSize % BasesAndFieldsAlignment.getQuantity();
2420 } else {
2421 if (Is64BitMode)
2422 Size += LastBaseWasEmpty ? CharUnits::One() : CharUnits::Zero();
2423 else
2424 Size = OldSize + BasesAndFieldsAlignment;
2425 }
2426 updateAlignment(PointerAlignment);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002427 }
2428
2429 // Flush the lazy empty base.
2430 layoutNonVirtualBase(0);
2431}
2432
2433void MicrosoftRecordLayoutBuilder::layoutFields(const RecordDecl *RD) {
2434 LastFieldIsNonZeroWidthBitfield = false;
2435 for (RecordDecl::field_iterator Field = RD->field_begin(),
2436 FieldEnd = RD->field_end();
2437 Field != FieldEnd; ++Field)
2438 layoutField(*Field);
2439 Size = Size.RoundUpToAlignment(Alignment);
2440}
2441
2442void MicrosoftRecordLayoutBuilder::layoutField(const FieldDecl *FD) {
2443 if (FD->isBitField()) {
2444 layoutBitField(FD);
2445 return;
2446 }
2447 LastFieldIsNonZeroWidthBitfield = false;
2448
2449 std::pair<CharUnits, CharUnits> FieldInfo = getAdjustedFieldInfo(FD);
2450 CharUnits FieldSize = FieldInfo.first;
2451 CharUnits FieldAlign = FieldInfo.second;
2452
2453 updateAlignment(FieldAlign);
2454 if (IsUnion) {
2455 placeFieldAtZero();
2456 Size = std::max(Size, FieldSize);
2457 } else {
2458 // Round up the current record size to the field's alignment boundary.
2459 CharUnits FieldOffset = Size.RoundUpToAlignment(FieldAlign);
2460 placeFieldAtOffset(FieldOffset);
2461 Size = FieldOffset + FieldSize;
2462 }
2463}
2464
2465void MicrosoftRecordLayoutBuilder::layoutBitField(const FieldDecl *FD) {
2466 unsigned Width = FD->getBitWidthValue(Context);
2467 if (Width == 0) {
2468 layoutZeroWidthBitField(FD);
2469 return;
2470 }
2471
2472 std::pair<CharUnits, CharUnits> FieldInfo = getAdjustedFieldInfo(FD);
2473 CharUnits FieldSize = FieldInfo.first;
2474 CharUnits FieldAlign = FieldInfo.second;
2475
2476 // Clamp the bitfield to a containable size for the sake of being able
2477 // to lay them out. Sema will throw an error.
2478 if (Width > Context.toBits(FieldSize))
2479 Width = Context.toBits(FieldSize);
2480
2481 // Check to see if this bitfield fits into an existing allocation. Note:
2482 // MSVC refuses to pack bitfields of formal types with different sizes
2483 // into the same allocation.
2484 if (!IsUnion && LastFieldIsNonZeroWidthBitfield &&
2485 CurrentBitfieldSize == FieldSize && Width <= RemainingBitsInField) {
2486 placeFieldAtBitOffset(Context.toBits(Size) - RemainingBitsInField);
2487 RemainingBitsInField -= Width;
2488 return;
2489 }
2490
2491 LastFieldIsNonZeroWidthBitfield = true;
2492 CurrentBitfieldSize = FieldSize;
2493 if (IsUnion) {
2494 placeFieldAtZero();
2495 Size = std::max(Size, FieldSize);
2496 // TODO: Add a Sema warning that MS ignores bitfield alignment in unions.
2497 } else {
2498 // Allocate a new block of memory and place the bitfield in it.
2499 CharUnits FieldOffset = Size.RoundUpToAlignment(FieldAlign);
2500 placeFieldAtOffset(FieldOffset);
2501 Size = FieldOffset + FieldSize;
2502 updateAlignment(FieldAlign);
2503 RemainingBitsInField = Context.toBits(FieldSize) - Width;
2504 }
2505}
2506
2507void
2508MicrosoftRecordLayoutBuilder::layoutZeroWidthBitField(const FieldDecl *FD) {
2509 // Zero-width bitfields are ignored unless they follow a non-zero-width
2510 // bitfield.
2511 std::pair<CharUnits, CharUnits> FieldInfo = getAdjustedFieldInfo(FD);
2512 CharUnits FieldSize = FieldInfo.first;
2513 CharUnits FieldAlign = FieldInfo.second;
2514
2515 if (!LastFieldIsNonZeroWidthBitfield) {
2516 placeFieldAtOffset(IsUnion ? CharUnits::Zero() : Size);
2517 // TODO: Add a Sema warning that MS ignores alignment for zero
2518 // sized bitfields that occur after zero-size bitfields or non bitfields.
2519 return;
2520 }
2521
2522 LastFieldIsNonZeroWidthBitfield = false;
2523 if (IsUnion) {
2524 placeFieldAtZero();
2525 Size = std::max(Size, FieldSize);
2526 } else {
2527 // Round up the current record size to the field's alignment boundary.
2528 CharUnits FieldOffset = Size.RoundUpToAlignment(FieldAlign);
2529 placeFieldAtOffset(FieldOffset);
2530 Size = FieldOffset;
2531 updateAlignment(FieldAlign);
2532 }
2533}
2534
2535void MicrosoftRecordLayoutBuilder::layoutVirtualBases(const CXXRecordDecl *RD) {
2536 if (!HasVBPtr)
2537 return;
2538
2539 updateAlignment(VirtualAlignment);
2540
2541 // Zero-sized v-bases obey the alignment attribute so apply it here. The
2542 // alignment attribute is normally accounted for in FinalizeLayout.
2543 if (unsigned MaxAlign = RD->getMaxAlignment())
2544 updateAlignment(Context.toCharUnitsFromBits(MaxAlign));
2545
2546 llvm::SmallPtrSet<const CXXRecordDecl *, 2> HasVtordisp =
2547 computeVtorDispSet(RD);
2548
2549 // Iterate through the virtual bases and lay them out.
2550 for (CXXRecordDecl::base_class_const_iterator i = RD->vbases_begin(),
2551 e = RD->vbases_end();
2552 i != e; ++i) {
2553 const CXXRecordDecl *BaseDecl =
2554 cast<CXXRecordDecl>(i->getType()->castAs<RecordType>()->getDecl());
2555 layoutVirtualBase(BaseDecl, HasVtordisp.count(BaseDecl));
2556 }
2557}
2558
2559void MicrosoftRecordLayoutBuilder::layoutVirtualBase(const CXXRecordDecl *RD,
2560 bool HasVtordisp) {
2561 if (LazyEmptyBase) {
2562 const ASTRecordLayout &LazyLayout =
2563 Context.getASTRecordLayout(LazyEmptyBase);
2564 Size = Size.RoundUpToAlignment(LazyLayout.getAlignment());
2565 VBases.insert(
2566 std::make_pair(LazyEmptyBase, ASTRecordLayout::VBaseInfo(Size, false)));
2567 // Empty bases only consume space when followed by another empty base.
2568 // The space consumed is in an Alignment sized/aligned block and the v-base
2569 // is placed at its alignment offset into the chunk, unless its alignment
Warren Hunt55d8e822013-10-23 23:53:07 +00002570 // is less than 4 bytes, at which it is placed at 4 byte offset in the
2571 // chunk. We have no idea why.
Warren Hunt8f8bad72013-10-11 20:19:00 +00002572 if (RD && Context.getASTRecordLayout(RD).getNonVirtualSize().isZero())
Warren Hunt55d8e822013-10-23 23:53:07 +00002573 Size = Size.RoundUpToAlignment(Alignment) + CharUnits::fromQuantity(4);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002574 LazyEmptyBase = 0;
2575 }
2576
2577 // RD is null when flushing the final lazy virtual base.
2578 if (!RD)
2579 return;
2580
2581 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
2582 if (Layout.getNonVirtualSize().isZero() && !HasVtordisp) {
2583 LazyEmptyBase = RD;
2584 return;
2585 }
2586
2587 CharUnits BaseNVSize = Layout.getNonVirtualSize();
2588 CharUnits BaseAlign = Layout.getAlignment();
2589
Warren Hunt55d8e822013-10-23 23:53:07 +00002590 // vtordisps are always 4 bytes (even in 64-bit mode)
Warren Hunt8f8bad72013-10-11 20:19:00 +00002591 if (HasVtordisp)
Warren Hunt55d8e822013-10-23 23:53:07 +00002592 Size = Size.RoundUpToAlignment(Alignment) + CharUnits::fromQuantity(4);
Warren Hunt8f8bad72013-10-11 20:19:00 +00002593 Size = Size.RoundUpToAlignment(BaseAlign);
2594
2595 // Insert the base here.
2596 CharUnits BaseOffset = Size.RoundUpToAlignment(BaseAlign);
2597 VBases.insert(
2598 std::make_pair(RD, ASTRecordLayout::VBaseInfo(BaseOffset, HasVtordisp)));
2599 Size = BaseOffset + BaseNVSize;
2600 // Note: we don't update alignment here because it was accounted for in
2601 // InitializeLayout.
2602}
2603
2604void MicrosoftRecordLayoutBuilder::finalizeCXXLayout(const CXXRecordDecl *RD) {
2605 // Flush the lazy virtual base.
2606 layoutVirtualBase(0, false);
2607
2608 if (RD->vbases_begin() == RD->vbases_end() || AlignAfterVBases)
2609 Size = Size.RoundUpToAlignment(Alignment);
2610
2611 if (Size.isZero())
2612 Size = Alignment;
2613}
2614
2615void MicrosoftRecordLayoutBuilder::honorDeclspecAlign(const RecordDecl *RD) {
2616 if (unsigned MaxAlign = RD->getMaxAlignment()) {
2617 AlignAfterVBases = true;
2618 updateAlignment(Context.toCharUnitsFromBits(MaxAlign));
2619 Size = Size.RoundUpToAlignment(Alignment);
2620 }
2621}
2622
2623static bool
2624RequiresVtordisp(const llvm::SmallPtrSet<const CXXRecordDecl *, 2> &HasVtordisp,
2625 const CXXRecordDecl *RD) {
2626 if (HasVtordisp.count(RD))
2627 return true;
2628 // If any of a virtual bases non-virtual bases (recursively) requires a
2629 // vtordisp than so does this virtual base.
2630 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
2631 e = RD->bases_end();
2632 i != e; ++i)
2633 if (!i->isVirtual() &&
2634 RequiresVtordisp(
2635 HasVtordisp,
2636 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl())))
2637 return true;
2638 return false;
2639}
2640
2641llvm::SmallPtrSet<const CXXRecordDecl *, 2>
2642MicrosoftRecordLayoutBuilder::computeVtorDispSet(const CXXRecordDecl *RD) {
2643 llvm::SmallPtrSet<const CXXRecordDecl *, 2> HasVtordisp;
2644
2645 // If any of our bases need a vtordisp for this type, so do we. Check our
2646 // direct bases for vtordisp requirements.
2647 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
2648 e = RD->bases_end();
2649 i != e; ++i) {
2650 const CXXRecordDecl *BaseDecl =
2651 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
2652 const ASTRecordLayout &Layout = Context.getASTRecordLayout(BaseDecl);
2653 for (ASTRecordLayout::VBaseOffsetsMapTy::const_iterator
2654 bi = Layout.getVBaseOffsetsMap().begin(),
2655 be = Layout.getVBaseOffsetsMap().end();
2656 bi != be; ++bi)
2657 if (bi->second.hasVtorDisp())
2658 HasVtordisp.insert(bi->first);
2659 }
2660
2661 // If we define a constructor or destructor and override a function that is
2662 // defined in a virtual base's vtable, that virtual bases need a vtordisp.
2663 // Here we collect a list of classes with vtables for which our virtual bases
2664 // actually live. The virtual bases with this property will require
2665 // vtordisps. In addition, virtual bases that contain non-virtual bases that
2666 // define functions we override also require vtordisps, this case is checked
2667 // explicitly below.
2668 if (RD->hasUserDeclaredConstructor() || RD->hasUserDeclaredDestructor()) {
2669 llvm::SmallPtrSet<const CXXMethodDecl *, 8> Work;
2670 // Seed the working set with our non-destructor virtual methods.
2671 for (CXXRecordDecl::method_iterator i = RD->method_begin(),
2672 e = RD->method_end();
2673 i != e; ++i)
Warren Hunt42be7762013-10-14 20:14:09 +00002674 if ((*i)->isVirtual() && !isa<CXXDestructorDecl>(*i))
Warren Hunt8f8bad72013-10-11 20:19:00 +00002675 Work.insert(*i);
2676 while (!Work.empty()) {
2677 const CXXMethodDecl *MD = *Work.begin();
2678 CXXMethodDecl::method_iterator i = MD->begin_overridden_methods(),
2679 e = MD->end_overridden_methods();
2680 if (i == e)
2681 // If a virtual method has no-overrides it lives in its parent's vtable.
2682 HasVtordisp.insert(MD->getParent());
2683 else
2684 Work.insert(i, e);
2685 // We've finished processing this element, remove it from the working set.
2686 Work.erase(MD);
2687 }
2688 }
2689
2690 // Re-check all of our vbases for vtordisp requirements (in case their
2691 // non-virtual bases have vtordisp requirements).
2692 for (CXXRecordDecl::base_class_const_iterator i = RD->vbases_begin(),
2693 e = RD->vbases_end();
2694 i != e; ++i) {
2695 const CXXRecordDecl *BaseDecl = i->getType()->getAsCXXRecordDecl();
2696 if (!HasVtordisp.count(BaseDecl) && RequiresVtordisp(HasVtordisp, BaseDecl))
2697 HasVtordisp.insert(BaseDecl);
2698 }
2699
2700 return HasVtordisp;
2701}
2702
2703/// \brief Get or compute information about the layout of the specified record
2704/// (struct/union/class), which indicates its size and field position
2705/// information.
2706const ASTRecordLayout *
2707ASTContext::BuildMicrosoftASTRecordLayout(const RecordDecl *D) const {
2708 MicrosoftRecordLayoutBuilder Builder(*this);
2709 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
2710 Builder.cxxLayout(RD);
2711 return new (*this) ASTRecordLayout(
2712 *this, Builder.Size, Builder.Alignment,
2713 Builder.HasVFPtr && !Builder.PrimaryBase, Builder.HasVFPtr,
2714 Builder.HasVBPtr && !Builder.SharedVBPtrBase, Builder.VBPtrOffset,
2715 Builder.DataSize, Builder.FieldOffsets.data(),
2716 Builder.FieldOffsets.size(), Builder.DataSize,
2717 Builder.NonVirtualAlignment, CharUnits::Zero(), Builder.PrimaryBase,
2718 false, Builder.AlignAfterVBases, Builder.Bases, Builder.VBases);
2719 } else {
2720 Builder.layout(D);
2721 return new (*this) ASTRecordLayout(
2722 *this, Builder.Size, Builder.Alignment, Builder.Size,
2723 Builder.FieldOffsets.data(), Builder.FieldOffsets.size());
2724 }
2725}
2726
Anders Carlssondf291d82010-05-26 04:56:53 +00002727/// getASTRecordLayout - Get or compute information about the layout of the
2728/// specified record (struct/union/class), which indicates its size and field
2729/// position information.
Jay Foad39c79802011-01-12 09:06:06 +00002730const ASTRecordLayout &
2731ASTContext::getASTRecordLayout(const RecordDecl *D) const {
John McCall0710e552011-10-07 02:39:22 +00002732 // These asserts test different things. A record has a definition
2733 // as soon as we begin to parse the definition. That definition is
2734 // not a complete definition (which is what isDefinition() tests)
2735 // until we *finish* parsing the definition.
Sean Callanan56c19892012-02-08 00:04:52 +00002736
2737 if (D->hasExternalLexicalStorage() && !D->getDefinition())
2738 getExternalSource()->CompleteType(const_cast<RecordDecl*>(D));
2739
Anders Carlssondf291d82010-05-26 04:56:53 +00002740 D = D->getDefinition();
2741 assert(D && "Cannot get layout of forward declarations!");
Matt Beaumont-Gay35779952013-06-25 22:19:15 +00002742 assert(!D->isInvalidDecl() && "Cannot get layout of invalid decl!");
John McCallf937c022011-10-07 06:10:15 +00002743 assert(D->isCompleteDefinition() && "Cannot layout type before complete!");
Anders Carlssondf291d82010-05-26 04:56:53 +00002744
2745 // Look up this layout, if already laid out, return what we have.
2746 // Note that we can't save a reference to the entry because this function
2747 // is recursive.
2748 const ASTRecordLayout *Entry = ASTRecordLayouts[D];
2749 if (Entry) return *Entry;
2750
Warren Hunt8f8bad72013-10-11 20:19:00 +00002751 const ASTRecordLayout *NewEntry = 0;
Anders Carlssond2954862010-05-26 05:10:47 +00002752
Warren Hunt8f8bad72013-10-11 20:19:00 +00002753 if (isMsLayout(D) && !D->getASTContext().getExternalSource()) {
2754 NewEntry = BuildMicrosoftASTRecordLayout(D);
2755 } else if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
Anders Carlssonc121b4e2010-05-27 00:07:01 +00002756 EmptySubobjectMap EmptySubobjects(*this, RD);
John McCall0153cd32011-11-08 04:01:03 +00002757 RecordLayoutBuilder Builder(*this, &EmptySubobjects);
2758 Builder.Layout(RD);
Anders Carlsson439edd12010-05-27 05:41:06 +00002759
John McCall5c1f1d02013-01-29 01:14:22 +00002760 // In certain situations, we are allowed to lay out objects in the
2761 // tail-padding of base classes. This is ABI-dependent.
2762 // FIXME: this should be stored in the record layout.
2763 bool skipTailPadding =
2764 mustSkipTailPadding(getTargetInfo().getCXXABI(), cast<CXXRecordDecl>(D));
Anders Carlssond2954862010-05-26 05:10:47 +00002765
2766 // FIXME: This should be done in FinalizeLayout.
Ken Dyck1b4420e2011-02-28 02:01:38 +00002767 CharUnits DataSize =
John McCall5c1f1d02013-01-29 01:14:22 +00002768 skipTailPadding ? Builder.getSize() : Builder.getDataSize();
Ken Dyck1b4420e2011-02-28 02:01:38 +00002769 CharUnits NonVirtualSize =
John McCall5c1f1d02013-01-29 01:14:22 +00002770 skipTailPadding ? DataSize : Builder.NonVirtualSize;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00002771 NewEntry =
John McCall0153cd32011-11-08 04:01:03 +00002772 new (*this) ASTRecordLayout(*this, Builder.getSize(),
2773 Builder.Alignment,
John McCalle42a3362012-05-01 08:55:32 +00002774 Builder.HasOwnVFPtr,
Warren Hunt8f8bad72013-10-11 20:19:00 +00002775 RD->isDynamicClass(),
Warren Hunt55d8e822013-10-23 23:53:07 +00002776 false,
2777 CharUnits::fromQuantity(-1),
Ken Dyck1b4420e2011-02-28 02:01:38 +00002778 DataSize,
John McCall0153cd32011-11-08 04:01:03 +00002779 Builder.FieldOffsets.data(),
2780 Builder.FieldOffsets.size(),
Ken Dyckaf1c83f2011-02-16 01:52:01 +00002781 NonVirtualSize,
John McCall0153cd32011-11-08 04:01:03 +00002782 Builder.NonVirtualAlignment,
Anders Carlssonc121b4e2010-05-27 00:07:01 +00002783 EmptySubobjects.SizeOfLargestEmptySubobject,
John McCall0153cd32011-11-08 04:01:03 +00002784 Builder.PrimaryBase,
2785 Builder.PrimaryBaseIsVirtual,
Warren Hunt8f8bad72013-10-11 20:19:00 +00002786 true,
John McCall0153cd32011-11-08 04:01:03 +00002787 Builder.Bases, Builder.VBases);
Anders Carlssond2954862010-05-26 05:10:47 +00002788 } else {
John McCall0153cd32011-11-08 04:01:03 +00002789 RecordLayoutBuilder Builder(*this, /*EmptySubobjects=*/0);
Anders Carlssond2954862010-05-26 05:10:47 +00002790 Builder.Layout(D);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00002791
Anders Carlssond2954862010-05-26 05:10:47 +00002792 NewEntry =
Ken Dyck1b4420e2011-02-28 02:01:38 +00002793 new (*this) ASTRecordLayout(*this, Builder.getSize(),
Ken Dyck4731d5b2011-02-16 02:05:21 +00002794 Builder.Alignment,
Ken Dyck1b4420e2011-02-28 02:01:38 +00002795 Builder.getSize(),
Anders Carlssond2954862010-05-26 05:10:47 +00002796 Builder.FieldOffsets.data(),
2797 Builder.FieldOffsets.size());
2798 }
2799
Anders Carlssondf291d82010-05-26 04:56:53 +00002800 ASTRecordLayouts[D] = NewEntry;
2801
David Blaikiebbafb8a2012-03-11 07:00:24 +00002802 if (getLangOpts().DumpRecordLayouts) {
Argyrios Kyrtzidis8ade08e2013-07-12 22:30:03 +00002803 llvm::outs() << "\n*** Dumping AST Record Layout\n";
2804 DumpRecordLayout(D, llvm::outs(), getLangOpts().DumpRecordLayoutsSimple);
Anders Carlssondf291d82010-05-26 04:56:53 +00002805 }
2806
2807 return *NewEntry;
2808}
2809
John McCall6bd2a892013-01-25 22:31:03 +00002810const CXXMethodDecl *ASTContext::getCurrentKeyFunction(const CXXRecordDecl *RD) {
Reid Kleckner5d7f2982013-05-29 16:18:30 +00002811 if (!getTargetInfo().getCXXABI().hasKeyFunctions())
2812 return 0;
2813
John McCall6bd2a892013-01-25 22:31:03 +00002814 assert(RD->getDefinition() && "Cannot get key function for forward decl!");
Anders Carlssondf291d82010-05-26 04:56:53 +00002815 RD = cast<CXXRecordDecl>(RD->getDefinition());
Daniel Dunbar592a85c2010-05-27 02:25:46 +00002816
Richard Smith676c4042013-08-29 23:59:27 +00002817 LazyDeclPtr &Entry = KeyFunctions[RD];
2818 if (!Entry)
2819 Entry = const_cast<CXXMethodDecl*>(computeKeyFunction(*this, RD));
Daniel Dunbar592a85c2010-05-27 02:25:46 +00002820
Richard Smith676c4042013-08-29 23:59:27 +00002821 return cast_or_null<CXXMethodDecl>(Entry.get(getExternalSource()));
John McCall6bd2a892013-01-25 22:31:03 +00002822}
2823
Richard Smith676c4042013-08-29 23:59:27 +00002824void ASTContext::setNonKeyFunction(const CXXMethodDecl *Method) {
Rafael Espindola8db352d2013-10-17 15:37:26 +00002825 assert(Method == Method->getFirstDecl() &&
John McCall6bd2a892013-01-25 22:31:03 +00002826 "not working with method declaration from class definition");
2827
2828 // Look up the cache entry. Since we're working with the first
2829 // declaration, its parent must be the class definition, which is
2830 // the correct key for the KeyFunctions hash.
Richard Smith676c4042013-08-29 23:59:27 +00002831 llvm::DenseMap<const CXXRecordDecl*, LazyDeclPtr>::iterator
2832 I = KeyFunctions.find(Method->getParent());
John McCall6bd2a892013-01-25 22:31:03 +00002833
2834 // If it's not cached, there's nothing to do.
Richard Smith676c4042013-08-29 23:59:27 +00002835 if (I == KeyFunctions.end()) return;
John McCall6bd2a892013-01-25 22:31:03 +00002836
2837 // If it is cached, check whether it's the target method, and if so,
2838 // remove it from the cache.
Richard Smith676c4042013-08-29 23:59:27 +00002839 if (I->second.get(getExternalSource()) == Method) {
John McCall6bd2a892013-01-25 22:31:03 +00002840 // FIXME: remember that we did this for module / chained PCH state?
Richard Smith676c4042013-08-29 23:59:27 +00002841 KeyFunctions.erase(I);
John McCall6bd2a892013-01-25 22:31:03 +00002842 }
Anders Carlssondf291d82010-05-26 04:56:53 +00002843}
2844
Richard Smithdafff942012-01-14 04:30:29 +00002845static uint64_t getFieldOffset(const ASTContext &C, const FieldDecl *FD) {
2846 const ASTRecordLayout &Layout = C.getASTRecordLayout(FD->getParent());
2847 return Layout.getFieldOffset(FD->getFieldIndex());
2848}
2849
2850uint64_t ASTContext::getFieldOffset(const ValueDecl *VD) const {
2851 uint64_t OffsetInBits;
2852 if (const FieldDecl *FD = dyn_cast<FieldDecl>(VD)) {
2853 OffsetInBits = ::getFieldOffset(*this, FD);
2854 } else {
2855 const IndirectFieldDecl *IFD = cast<IndirectFieldDecl>(VD);
2856
2857 OffsetInBits = 0;
2858 for (IndirectFieldDecl::chain_iterator CI = IFD->chain_begin(),
2859 CE = IFD->chain_end();
2860 CI != CE; ++CI)
2861 OffsetInBits += ::getFieldOffset(*this, cast<FieldDecl>(*CI));
2862 }
2863
2864 return OffsetInBits;
2865}
2866
Eric Christopher8a39a012011-10-05 06:00:51 +00002867/// getObjCLayout - Get or compute information about the layout of the
2868/// given interface.
Anders Carlssondf291d82010-05-26 04:56:53 +00002869///
2870/// \param Impl - If given, also include the layout of the interface's
2871/// implementation. This may differ by including synthesized ivars.
2872const ASTRecordLayout &
2873ASTContext::getObjCLayout(const ObjCInterfaceDecl *D,
Jay Foad39c79802011-01-12 09:06:06 +00002874 const ObjCImplementationDecl *Impl) const {
Douglas Gregor64d92572011-12-20 15:50:13 +00002875 // Retrieve the definition
Sean Callanand9a909c2012-03-15 16:33:08 +00002876 if (D->hasExternalLexicalStorage() && !D->getDefinition())
2877 getExternalSource()->CompleteType(const_cast<ObjCInterfaceDecl*>(D));
Douglas Gregor64d92572011-12-20 15:50:13 +00002878 D = D->getDefinition();
2879 assert(D && D->isThisDeclarationADefinition() && "Invalid interface decl!");
Anders Carlssondf291d82010-05-26 04:56:53 +00002880
2881 // Look up this layout, if already laid out, return what we have.
Roman Divackye6377112012-09-06 15:59:27 +00002882 const ObjCContainerDecl *Key =
2883 Impl ? (const ObjCContainerDecl*) Impl : (const ObjCContainerDecl*) D;
Anders Carlssondf291d82010-05-26 04:56:53 +00002884 if (const ASTRecordLayout *Entry = ObjCLayouts[Key])
2885 return *Entry;
2886
2887 // Add in synthesized ivar count if laying out an implementation.
2888 if (Impl) {
2889 unsigned SynthCount = CountNonClassIvars(D);
2890 // If there aren't any sythesized ivars then reuse the interface
2891 // entry. Note we can't cache this because we simply free all
2892 // entries later; however we shouldn't look up implementations
2893 // frequently.
2894 if (SynthCount == 0)
2895 return getObjCLayout(D, 0);
2896 }
2897
John McCall0153cd32011-11-08 04:01:03 +00002898 RecordLayoutBuilder Builder(*this, /*EmptySubobjects=*/0);
Anders Carlsson6ed3a9a2010-05-26 05:04:25 +00002899 Builder.Layout(D);
2900
Anders Carlssondf291d82010-05-26 04:56:53 +00002901 const ASTRecordLayout *NewEntry =
Ken Dyck1b4420e2011-02-28 02:01:38 +00002902 new (*this) ASTRecordLayout(*this, Builder.getSize(),
Ken Dyck4731d5b2011-02-16 02:05:21 +00002903 Builder.Alignment,
Ken Dyck1b4420e2011-02-28 02:01:38 +00002904 Builder.getDataSize(),
Anders Carlsson6ed3a9a2010-05-26 05:04:25 +00002905 Builder.FieldOffsets.data(),
2906 Builder.FieldOffsets.size());
Daniel Dunbar592a85c2010-05-27 02:25:46 +00002907
Anders Carlssondf291d82010-05-26 04:56:53 +00002908 ObjCLayouts[Key] = NewEntry;
2909
2910 return *NewEntry;
2911}
2912
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002913static void PrintOffset(raw_ostream &OS,
Anders Carlsson3f018712010-10-31 23:45:59 +00002914 CharUnits Offset, unsigned IndentLevel) {
Benjamin Kramer96ad7172011-11-05 09:02:52 +00002915 OS << llvm::format("%4" PRId64 " | ", (int64_t)Offset.getQuantity());
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002916 OS.indent(IndentLevel * 2);
2917}
2918
Eli Benderskyf6f93ee2012-12-08 00:07:24 +00002919static void PrintIndentNoOffset(raw_ostream &OS, unsigned IndentLevel) {
2920 OS << " | ";
2921 OS.indent(IndentLevel * 2);
2922}
2923
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002924static void DumpCXXRecordLayout(raw_ostream &OS,
Jay Foad39c79802011-01-12 09:06:06 +00002925 const CXXRecordDecl *RD, const ASTContext &C,
Anders Carlsson3f018712010-10-31 23:45:59 +00002926 CharUnits Offset,
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002927 unsigned IndentLevel,
2928 const char* Description,
2929 bool IncludeVirtualBases) {
Anders Carlsson3f018712010-10-31 23:45:59 +00002930 const ASTRecordLayout &Layout = C.getASTRecordLayout(RD);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002931
2932 PrintOffset(OS, Offset, IndentLevel);
Dan Gohman145f3f12010-04-19 16:39:44 +00002933 OS << C.getTypeDeclType(const_cast<CXXRecordDecl *>(RD)).getAsString();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002934 if (Description)
2935 OS << ' ' << Description;
2936 if (RD->isEmpty())
2937 OS << " (empty)";
2938 OS << '\n';
2939
2940 IndentLevel++;
2941
Anders Carlsson3f018712010-10-31 23:45:59 +00002942 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
Warren Hunt8f8bad72013-10-11 20:19:00 +00002943 bool HasOwnVFPtr = Layout.hasOwnVFPtr();
2944 bool HasOwnVBPtr = Layout.hasOwnVBPtr();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002945
2946 // Vtable pointer.
Warren Hunt8f8bad72013-10-11 20:19:00 +00002947 if (RD->isDynamicClass() && !PrimaryBase && !isMsLayout(RD)) {
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002948 PrintOffset(OS, Offset, IndentLevel);
Benjamin Kramerb89514a2011-10-14 18:45:37 +00002949 OS << '(' << *RD << " vtable pointer)\n";
Warren Hunt8f8bad72013-10-11 20:19:00 +00002950 } else if (HasOwnVFPtr) {
2951 PrintOffset(OS, Offset, IndentLevel);
2952 // vfptr (for Microsoft C++ ABI)
2953 OS << '(' << *RD << " vftable pointer)\n";
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002954 }
Warren Hunt8f8bad72013-10-11 20:19:00 +00002955
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002956 // Dump (non-virtual) bases
2957 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
2958 E = RD->bases_end(); I != E; ++I) {
2959 assert(!I->getType()->isDependentType() &&
2960 "Cannot layout class with dependent bases.");
2961 if (I->isVirtual())
2962 continue;
2963
2964 const CXXRecordDecl *Base =
2965 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
2966
Anders Carlsson3f018712010-10-31 23:45:59 +00002967 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002968
2969 DumpCXXRecordLayout(OS, Base, C, BaseOffset, IndentLevel,
2970 Base == PrimaryBase ? "(primary base)" : "(base)",
2971 /*IncludeVirtualBases=*/false);
2972 }
Eli Friedman43114f92011-10-21 22:49:56 +00002973
Warren Hunt8f8bad72013-10-11 20:19:00 +00002974 // vbptr (for Microsoft C++ ABI)
2975 if (HasOwnVBPtr) {
Eli Friedman84d2d3a2011-09-27 19:12:27 +00002976 PrintOffset(OS, Offset + Layout.getVBPtrOffset(), IndentLevel);
Benjamin Kramerb89514a2011-10-14 18:45:37 +00002977 OS << '(' << *RD << " vbtable pointer)\n";
Eli Friedman84d2d3a2011-09-27 19:12:27 +00002978 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002979
2980 // Dump fields.
2981 uint64_t FieldNo = 0;
2982 for (CXXRecordDecl::field_iterator I = RD->field_begin(),
2983 E = RD->field_end(); I != E; ++I, ++FieldNo) {
David Blaikie40ed2972012-06-06 20:45:41 +00002984 const FieldDecl &Field = **I;
Anders Carlsson3f018712010-10-31 23:45:59 +00002985 CharUnits FieldOffset = Offset +
Ken Dyck86a7fcc2011-01-18 01:56:16 +00002986 C.toCharUnitsFromBits(Layout.getFieldOffset(FieldNo));
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002987
David Blaikie2d7c57e2012-04-30 02:36:29 +00002988 if (const RecordType *RT = Field.getType()->getAs<RecordType>()) {
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002989 if (const CXXRecordDecl *D = dyn_cast<CXXRecordDecl>(RT->getDecl())) {
2990 DumpCXXRecordLayout(OS, D, C, FieldOffset, IndentLevel,
David Blaikie2d7c57e2012-04-30 02:36:29 +00002991 Field.getName().data(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002992 /*IncludeVirtualBases=*/true);
2993 continue;
2994 }
2995 }
2996
2997 PrintOffset(OS, FieldOffset, IndentLevel);
David Blaikie2d7c57e2012-04-30 02:36:29 +00002998 OS << Field.getType().getAsString() << ' ' << Field << '\n';
Daniel Dunbaraa423af2010-04-08 02:59:49 +00002999 }
3000
3001 if (!IncludeVirtualBases)
3002 return;
3003
3004 // Dump virtual bases.
John McCalle42a3362012-05-01 08:55:32 +00003005 const ASTRecordLayout::VBaseOffsetsMapTy &vtordisps =
3006 Layout.getVBaseOffsetsMap();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003007 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
3008 E = RD->vbases_end(); I != E; ++I) {
3009 assert(I->isVirtual() && "Found non-virtual class!");
3010 const CXXRecordDecl *VBase =
3011 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
3012
Anders Carlsson3f018712010-10-31 23:45:59 +00003013 CharUnits VBaseOffset = Offset + Layout.getVBaseClassOffset(VBase);
John McCalle42a3362012-05-01 08:55:32 +00003014
3015 if (vtordisps.find(VBase)->second.hasVtorDisp()) {
3016 PrintOffset(OS, VBaseOffset - CharUnits::fromQuantity(4), IndentLevel);
3017 OS << "(vtordisp for vbase " << *VBase << ")\n";
3018 }
3019
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003020 DumpCXXRecordLayout(OS, VBase, C, VBaseOffset, IndentLevel,
3021 VBase == PrimaryBase ?
3022 "(primary virtual base)" : "(virtual base)",
3023 /*IncludeVirtualBases=*/false);
3024 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003025
Eli Benderskyf6f93ee2012-12-08 00:07:24 +00003026 PrintIndentNoOffset(OS, IndentLevel - 1);
3027 OS << "[sizeof=" << Layout.getSize().getQuantity();
Warren Hunt8f8bad72013-10-11 20:19:00 +00003028 if (!isMsLayout(RD))
3029 OS << ", dsize=" << Layout.getDataSize().getQuantity();
Ken Dyck7ad11e72011-02-15 02:32:40 +00003030 OS << ", align=" << Layout.getAlignment().getQuantity() << '\n';
Eli Benderskyf6f93ee2012-12-08 00:07:24 +00003031
3032 PrintIndentNoOffset(OS, IndentLevel - 1);
3033 OS << " nvsize=" << Layout.getNonVirtualSize().getQuantity();
3034 OS << ", nvalign=" << Layout.getNonVirtualAlign().getQuantity() << "]\n";
Daniel Dunbaraa423af2010-04-08 02:59:49 +00003035 OS << '\n';
3036}
Daniel Dunbarccabe482010-04-19 20:44:53 +00003037
3038void ASTContext::DumpRecordLayout(const RecordDecl *RD,
Douglas Gregore9fc3772012-01-26 07:55:45 +00003039 raw_ostream &OS,
3040 bool Simple) const {
Daniel Dunbarccabe482010-04-19 20:44:53 +00003041 const ASTRecordLayout &Info = getASTRecordLayout(RD);
3042
3043 if (const CXXRecordDecl *CXXRD = dyn_cast<CXXRecordDecl>(RD))
Douglas Gregore9fc3772012-01-26 07:55:45 +00003044 if (!Simple)
3045 return DumpCXXRecordLayout(OS, CXXRD, *this, CharUnits(), 0, 0,
3046 /*IncludeVirtualBases=*/true);
Daniel Dunbarccabe482010-04-19 20:44:53 +00003047
3048 OS << "Type: " << getTypeDeclType(RD).getAsString() << "\n";
Douglas Gregore9fc3772012-01-26 07:55:45 +00003049 if (!Simple) {
3050 OS << "Record: ";
3051 RD->dump();
3052 }
Daniel Dunbarccabe482010-04-19 20:44:53 +00003053 OS << "\nLayout: ";
3054 OS << "<ASTRecordLayout\n";
Ken Dyckb0fcc592011-02-11 01:54:29 +00003055 OS << " Size:" << toBits(Info.getSize()) << "\n";
Warren Hunt8f8bad72013-10-11 20:19:00 +00003056 if (!isMsLayout(RD))
3057 OS << " DataSize:" << toBits(Info.getDataSize()) << "\n";
Ken Dyck7ad11e72011-02-15 02:32:40 +00003058 OS << " Alignment:" << toBits(Info.getAlignment()) << "\n";
Daniel Dunbarccabe482010-04-19 20:44:53 +00003059 OS << " FieldOffsets: [";
3060 for (unsigned i = 0, e = Info.getFieldCount(); i != e; ++i) {
3061 if (i) OS << ", ";
3062 OS << Info.getFieldOffset(i);
3063 }
3064 OS << "]>\n";
3065}