blob: 17e3fe69f4a62c601b5aaed8547b83cc69ceaf08 [file] [log] [blame]
Anders Carlsson35a36eb2010-05-26 05:41:04 +00001//=== RecordLayoutBuilder.cpp - Helper class for building record layouts ---==//
Anders Carlsson79474332009-07-18 20:20:21 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9
Anders Carlsson79474332009-07-18 20:20:21 +000010#include "clang/AST/Attr.h"
Anders Carlsson5adde292010-11-24 22:55:48 +000011#include "clang/AST/CXXInheritance.h"
Anders Carlsson79474332009-07-18 20:20:21 +000012#include "clang/AST/Decl.h"
Anders Carlsson6d9f6f32009-07-19 00:18:47 +000013#include "clang/AST/DeclCXX.h"
Anders Carlsson4f516282009-07-18 20:50:59 +000014#include "clang/AST/DeclObjC.h"
Anders Carlsson79474332009-07-18 20:20:21 +000015#include "clang/AST/Expr.h"
Anders Carlsson35a36eb2010-05-26 05:41:04 +000016#include "clang/AST/RecordLayout.h"
Anders Carlsson79474332009-07-18 20:20:21 +000017#include "clang/Basic/TargetInfo.h"
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +000018#include "clang/Sema/SemaDiagnostic.h"
Daniel Dunbaraa423af2010-04-08 02:59:49 +000019#include "llvm/Support/Format.h"
20#include "llvm/ADT/SmallSet.h"
21#include "llvm/Support/MathExtras.h"
Anders Carlsson35a36eb2010-05-26 05:41:04 +000022#include <map>
Anders Carlsson79474332009-07-18 20:20:21 +000023
24using namespace clang;
25
Benjamin Kramerc7656cd2010-05-26 09:58:31 +000026namespace {
Anders Carlssonf58de112010-05-26 15:32:58 +000027
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000028/// BaseSubobjectInfo - Represents a single base subobject in a complete class.
29/// For a class hierarchy like
30///
31/// class A { };
32/// class B : A { };
33/// class C : A, B { };
34///
35/// The BaseSubobjectInfo graph for C will have three BaseSubobjectInfo
36/// instances, one for B and two for A.
37///
38/// If a base is virtual, it will only have one BaseSubobjectInfo allocated.
39struct BaseSubobjectInfo {
40 /// Class - The class for this base info.
Anders Carlsson056818f2010-05-28 21:13:31 +000041 const CXXRecordDecl *Class;
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000042
43 /// IsVirtual - Whether the BaseInfo represents a virtual base or not.
Anders Carlsson056818f2010-05-28 21:13:31 +000044 bool IsVirtual;
45
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000046 /// Bases - Information about the base subobjects.
47 llvm::SmallVector<BaseSubobjectInfo*, 4> Bases;
48
Anders Carlssone3c24c72010-05-29 17:35:14 +000049 /// PrimaryVirtualBaseInfo - Holds the base info for the primary virtual base
50 /// of this base info (if one exists).
51 BaseSubobjectInfo *PrimaryVirtualBaseInfo;
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000052
53 // FIXME: Document.
54 const BaseSubobjectInfo *Derived;
Anders Carlsson056818f2010-05-28 21:13:31 +000055};
56
Anders Carlssonf58de112010-05-26 15:32:58 +000057/// EmptySubobjectMap - Keeps track of which empty subobjects exist at different
58/// offsets while laying out a C++ class.
59class EmptySubobjectMap {
Jay Foad39c79802011-01-12 09:06:06 +000060 const ASTContext &Context;
Anders Carlsson233e2722010-10-31 21:54:55 +000061 uint64_t CharWidth;
62
Anders Carlssonf58de112010-05-26 15:32:58 +000063 /// Class - The class whose empty entries we're keeping track of.
64 const CXXRecordDecl *Class;
Daniel Dunbar592a85c2010-05-27 02:25:46 +000065
Anders Carlsson439edd12010-05-27 05:41:06 +000066 /// EmptyClassOffsets - A map from offsets to empty record decls.
67 typedef llvm::SmallVector<const CXXRecordDecl *, 1> ClassVectorTy;
Anders Carlssonf8f756d2010-10-31 21:22:43 +000068 typedef llvm::DenseMap<CharUnits, ClassVectorTy> EmptyClassOffsetsMapTy;
Anders Carlsson439edd12010-05-27 05:41:06 +000069 EmptyClassOffsetsMapTy EmptyClassOffsets;
70
Anders Carlssoncc5de092010-06-08 15:56:03 +000071 /// MaxEmptyClassOffset - The highest offset known to contain an empty
72 /// base subobject.
Anders Carlsson725190f2010-10-31 21:39:24 +000073 CharUnits MaxEmptyClassOffset;
Anders Carlssoncc5de092010-06-08 15:56:03 +000074
Daniel Dunbar592a85c2010-05-27 02:25:46 +000075 /// ComputeEmptySubobjectSizes - Compute the size of the largest base or
Anders Carlssonc5ca1f72010-05-26 15:54:25 +000076 /// member subobject that is empty.
77 void ComputeEmptySubobjectSizes();
Anders Carlsson439edd12010-05-27 05:41:06 +000078
Anders Carlsson725190f2010-10-31 21:39:24 +000079 void AddSubobjectAtOffset(const CXXRecordDecl *RD, CharUnits Offset);
Anders Carlssondb319762010-05-27 18:20:57 +000080
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000081 void UpdateEmptyBaseSubobjects(const BaseSubobjectInfo *Info,
Anders Carlsson28466ab2010-10-31 22:13:23 +000082 CharUnits Offset, bool PlacingEmptyBase);
Anders Carlsson439edd12010-05-27 05:41:06 +000083
Anders Carlssondb319762010-05-27 18:20:57 +000084 void UpdateEmptyFieldSubobjects(const CXXRecordDecl *RD,
85 const CXXRecordDecl *Class,
Anders Carlsson28466ab2010-10-31 22:13:23 +000086 CharUnits Offset);
87 void UpdateEmptyFieldSubobjects(const FieldDecl *FD, CharUnits Offset);
Anders Carlssondb319762010-05-27 18:20:57 +000088
Anders Carlssoncc5de092010-06-08 15:56:03 +000089 /// AnyEmptySubobjectsBeyondOffset - Returns whether there are any empty
90 /// subobjects beyond the given offset.
Anders Carlsson725190f2010-10-31 21:39:24 +000091 bool AnyEmptySubobjectsBeyondOffset(CharUnits Offset) const {
Anders Carlssoncc5de092010-06-08 15:56:03 +000092 return Offset <= MaxEmptyClassOffset;
93 }
94
Anders Carlsson233e2722010-10-31 21:54:55 +000095 CharUnits
96 getFieldOffset(const ASTRecordLayout &Layout, unsigned FieldNo) const {
97 uint64_t FieldOffset = Layout.getFieldOffset(FieldNo);
98 assert(FieldOffset % CharWidth == 0 &&
99 "Field offset not at char boundary!");
100
Ken Dyck7c4026b2011-01-24 01:28:50 +0000101 return Context.toCharUnitsFromBits(FieldOffset);
Anders Carlssonf8f756d2010-10-31 21:22:43 +0000102 }
Anders Carlssonf8f756d2010-10-31 21:22:43 +0000103
Charles Davisc2c576a2010-08-19 00:55:19 +0000104protected:
Anders Carlsson725190f2010-10-31 21:39:24 +0000105 bool CanPlaceSubobjectAtOffset(const CXXRecordDecl *RD,
106 CharUnits Offset) const;
Charles Davisc2c576a2010-08-19 00:55:19 +0000107
108 bool CanPlaceBaseSubobjectAtOffset(const BaseSubobjectInfo *Info,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000109 CharUnits Offset);
Charles Davisc2c576a2010-08-19 00:55:19 +0000110
111 bool CanPlaceFieldSubobjectAtOffset(const CXXRecordDecl *RD,
112 const CXXRecordDecl *Class,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000113 CharUnits Offset) const;
Charles Davisc2c576a2010-08-19 00:55:19 +0000114 bool CanPlaceFieldSubobjectAtOffset(const FieldDecl *FD,
Anders Carlsson233e2722010-10-31 21:54:55 +0000115 CharUnits Offset) const;
Charles Davisc2c576a2010-08-19 00:55:19 +0000116
Anders Carlssonf58de112010-05-26 15:32:58 +0000117public:
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000118 /// This holds the size of the largest empty subobject (either a base
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000119 /// or a member). Will be zero if the record being built doesn't contain
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000120 /// any empty classes.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000121 CharUnits SizeOfLargestEmptySubobject;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000122
Jay Foad39c79802011-01-12 09:06:06 +0000123 EmptySubobjectMap(const ASTContext &Context, const CXXRecordDecl *Class)
Anders Carlsson28466ab2010-10-31 22:13:23 +0000124 : Context(Context), CharWidth(Context.getCharWidth()), Class(Class) {
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000125 ComputeEmptySubobjectSizes();
126 }
127
128 /// CanPlaceBaseAtOffset - Return whether the given base class can be placed
129 /// at the given offset.
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000130 /// Returns false if placing the record will result in two components
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000131 /// (direct or indirect) of the same type having the same offset.
Anders Carlssoncc5de092010-06-08 15:56:03 +0000132 bool CanPlaceBaseAtOffset(const BaseSubobjectInfo *Info,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000133 CharUnits Offset);
Anders Carlssondb319762010-05-27 18:20:57 +0000134
135 /// CanPlaceFieldAtOffset - Return whether a field can be placed at the given
136 /// offset.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000137 bool CanPlaceFieldAtOffset(const FieldDecl *FD, CharUnits Offset);
Anders Carlssonf58de112010-05-26 15:32:58 +0000138};
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000139
140void EmptySubobjectMap::ComputeEmptySubobjectSizes() {
141 // Check the bases.
142 for (CXXRecordDecl::base_class_const_iterator I = Class->bases_begin(),
143 E = Class->bases_end(); I != E; ++I) {
144 const CXXRecordDecl *BaseDecl =
145 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
146
Anders Carlsson28466ab2010-10-31 22:13:23 +0000147 CharUnits EmptySize;
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000148 const ASTRecordLayout &Layout = Context.getASTRecordLayout(BaseDecl);
149 if (BaseDecl->isEmpty()) {
150 // If the class decl is empty, get its size.
Ken Dyckc8ae5502011-02-09 01:59:34 +0000151 EmptySize = Layout.getSize();
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000152 } else {
153 // Otherwise, we get the largest empty subobject for the decl.
154 EmptySize = Layout.getSizeOfLargestEmptySubobject();
155 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000156
Anders Carlsson28466ab2010-10-31 22:13:23 +0000157 if (EmptySize > SizeOfLargestEmptySubobject)
158 SizeOfLargestEmptySubobject = EmptySize;
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000159 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000160
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000161 // Check the fields.
162 for (CXXRecordDecl::field_iterator I = Class->field_begin(),
163 E = Class->field_end(); I != E; ++I) {
164 const FieldDecl *FD = *I;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000165
166 const RecordType *RT =
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000167 Context.getBaseElementType(FD->getType())->getAs<RecordType>();
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000168
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000169 // We only care about record types.
170 if (!RT)
171 continue;
172
Anders Carlsson28466ab2010-10-31 22:13:23 +0000173 CharUnits EmptySize;
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000174 const CXXRecordDecl *MemberDecl = cast<CXXRecordDecl>(RT->getDecl());
175 const ASTRecordLayout &Layout = Context.getASTRecordLayout(MemberDecl);
176 if (MemberDecl->isEmpty()) {
177 // If the class decl is empty, get its size.
Ken Dyckc8ae5502011-02-09 01:59:34 +0000178 EmptySize = Layout.getSize();
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000179 } else {
180 // Otherwise, we get the largest empty subobject for the decl.
181 EmptySize = Layout.getSizeOfLargestEmptySubobject();
182 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000183
Anders Carlsson28466ab2010-10-31 22:13:23 +0000184 if (EmptySize > SizeOfLargestEmptySubobject)
185 SizeOfLargestEmptySubobject = EmptySize;
Anders Carlssonc5ca1f72010-05-26 15:54:25 +0000186 }
187}
188
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000189bool
Anders Carlssondb319762010-05-27 18:20:57 +0000190EmptySubobjectMap::CanPlaceSubobjectAtOffset(const CXXRecordDecl *RD,
Anders Carlsson725190f2010-10-31 21:39:24 +0000191 CharUnits Offset) const {
Anders Carlssondb319762010-05-27 18:20:57 +0000192 // We only need to check empty bases.
193 if (!RD->isEmpty())
194 return true;
195
Anders Carlsson725190f2010-10-31 21:39:24 +0000196 EmptyClassOffsetsMapTy::const_iterator I = EmptyClassOffsets.find(Offset);
Anders Carlssondb319762010-05-27 18:20:57 +0000197 if (I == EmptyClassOffsets.end())
198 return true;
199
200 const ClassVectorTy& Classes = I->second;
201 if (std::find(Classes.begin(), Classes.end(), RD) == Classes.end())
202 return true;
203
204 // There is already an empty class of the same type at this offset.
205 return false;
206}
207
208void EmptySubobjectMap::AddSubobjectAtOffset(const CXXRecordDecl *RD,
Anders Carlsson725190f2010-10-31 21:39:24 +0000209 CharUnits Offset) {
Anders Carlssondb319762010-05-27 18:20:57 +0000210 // We only care about empty bases.
211 if (!RD->isEmpty())
212 return;
213
Rafael Espindola7bcde192010-12-29 23:02:58 +0000214 // If we have empty structures inside an union, we can assign both
215 // the same offset. Just avoid pushing them twice in the list.
Anders Carlsson725190f2010-10-31 21:39:24 +0000216 ClassVectorTy& Classes = EmptyClassOffsets[Offset];
Rafael Espindola7bcde192010-12-29 23:02:58 +0000217 if (std::find(Classes.begin(), Classes.end(), RD) != Classes.end())
218 return;
219
Anders Carlssondb319762010-05-27 18:20:57 +0000220 Classes.push_back(RD);
Anders Carlssoncc5de092010-06-08 15:56:03 +0000221
222 // Update the empty class offset.
Anders Carlsson725190f2010-10-31 21:39:24 +0000223 if (Offset > MaxEmptyClassOffset)
224 MaxEmptyClassOffset = Offset;
Anders Carlssondb319762010-05-27 18:20:57 +0000225}
226
227bool
Anders Carlsson28466ab2010-10-31 22:13:23 +0000228EmptySubobjectMap::CanPlaceBaseSubobjectAtOffset(const BaseSubobjectInfo *Info,
229 CharUnits Offset) {
Anders Carlsson45c1d282010-06-08 16:20:35 +0000230 // We don't have to keep looking past the maximum offset that's known to
231 // contain an empty class.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000232 if (!AnyEmptySubobjectsBeyondOffset(Offset))
Anders Carlsson45c1d282010-06-08 16:20:35 +0000233 return true;
234
Anders Carlsson28466ab2010-10-31 22:13:23 +0000235 if (!CanPlaceSubobjectAtOffset(Info->Class, Offset))
Anders Carlssondb319762010-05-27 18:20:57 +0000236 return false;
237
Anders Carlsson439edd12010-05-27 05:41:06 +0000238 // Traverse all non-virtual bases.
Anders Carlssona7774a62010-05-29 21:10:24 +0000239 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Info->Class);
Anders Carlsson439edd12010-05-27 05:41:06 +0000240 for (unsigned I = 0, E = Info->Bases.size(); I != E; ++I) {
Anders Carlssona7f3cdb2010-05-28 21:24:37 +0000241 BaseSubobjectInfo* Base = Info->Bases[I];
Anders Carlsson439edd12010-05-27 05:41:06 +0000242 if (Base->IsVirtual)
243 continue;
244
Anders Carlsson0a14ee92010-11-01 00:21:58 +0000245 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base->Class);
Anders Carlsson439edd12010-05-27 05:41:06 +0000246
247 if (!CanPlaceBaseSubobjectAtOffset(Base, BaseOffset))
248 return false;
249 }
250
Anders Carlssone3c24c72010-05-29 17:35:14 +0000251 if (Info->PrimaryVirtualBaseInfo) {
252 BaseSubobjectInfo *PrimaryVirtualBaseInfo = Info->PrimaryVirtualBaseInfo;
Anders Carlsson439edd12010-05-27 05:41:06 +0000253
254 if (Info == PrimaryVirtualBaseInfo->Derived) {
255 if (!CanPlaceBaseSubobjectAtOffset(PrimaryVirtualBaseInfo, Offset))
256 return false;
257 }
258 }
259
Anders Carlssondb319762010-05-27 18:20:57 +0000260 // Traverse all member variables.
261 unsigned FieldNo = 0;
262 for (CXXRecordDecl::field_iterator I = Info->Class->field_begin(),
263 E = Info->Class->field_end(); I != E; ++I, ++FieldNo) {
264 const FieldDecl *FD = *I;
Anders Carlsson233e2722010-10-31 21:54:55 +0000265 if (FD->isBitField())
266 continue;
267
Anders Carlsson28466ab2010-10-31 22:13:23 +0000268 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
Anders Carlssondb319762010-05-27 18:20:57 +0000269 if (!CanPlaceFieldSubobjectAtOffset(FD, FieldOffset))
270 return false;
271 }
272
Anders Carlsson439edd12010-05-27 05:41:06 +0000273 return true;
274}
275
Anders Carlssona7f3cdb2010-05-28 21:24:37 +0000276void EmptySubobjectMap::UpdateEmptyBaseSubobjects(const BaseSubobjectInfo *Info,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000277 CharUnits Offset,
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000278 bool PlacingEmptyBase) {
279 if (!PlacingEmptyBase && Offset >= SizeOfLargestEmptySubobject) {
280 // We know that the only empty subobjects that can conflict with empty
281 // subobject of non-empty bases, are empty bases that can be placed at
282 // offset zero. Because of this, we only need to keep track of empty base
283 // subobjects with offsets less than the size of the largest empty
284 // subobject for our class.
285 return;
286 }
287
Anders Carlsson28466ab2010-10-31 22:13:23 +0000288 AddSubobjectAtOffset(Info->Class, Offset);
Anders Carlssona7774a62010-05-29 21:10:24 +0000289
Anders Carlsson439edd12010-05-27 05:41:06 +0000290 // Traverse all non-virtual bases.
Anders Carlssona7774a62010-05-29 21:10:24 +0000291 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Info->Class);
Anders Carlsson439edd12010-05-27 05:41:06 +0000292 for (unsigned I = 0, E = Info->Bases.size(); I != E; ++I) {
Anders Carlssona7f3cdb2010-05-28 21:24:37 +0000293 BaseSubobjectInfo* Base = Info->Bases[I];
Anders Carlsson439edd12010-05-27 05:41:06 +0000294 if (Base->IsVirtual)
295 continue;
Anders Carlssona7774a62010-05-29 21:10:24 +0000296
Anders Carlsson0a14ee92010-11-01 00:21:58 +0000297 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base->Class);
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000298 UpdateEmptyBaseSubobjects(Base, BaseOffset, PlacingEmptyBase);
Anders Carlsson439edd12010-05-27 05:41:06 +0000299 }
300
Anders Carlssone3c24c72010-05-29 17:35:14 +0000301 if (Info->PrimaryVirtualBaseInfo) {
302 BaseSubobjectInfo *PrimaryVirtualBaseInfo = Info->PrimaryVirtualBaseInfo;
Anders Carlsson439edd12010-05-27 05:41:06 +0000303
304 if (Info == PrimaryVirtualBaseInfo->Derived)
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000305 UpdateEmptyBaseSubobjects(PrimaryVirtualBaseInfo, Offset,
306 PlacingEmptyBase);
Anders Carlsson439edd12010-05-27 05:41:06 +0000307 }
Anders Carlssondb319762010-05-27 18:20:57 +0000308
Anders Carlssondb319762010-05-27 18:20:57 +0000309 // Traverse all member variables.
310 unsigned FieldNo = 0;
311 for (CXXRecordDecl::field_iterator I = Info->Class->field_begin(),
312 E = Info->Class->field_end(); I != E; ++I, ++FieldNo) {
313 const FieldDecl *FD = *I;
Anders Carlsson233e2722010-10-31 21:54:55 +0000314 if (FD->isBitField())
315 continue;
Anders Carlssona7774a62010-05-29 21:10:24 +0000316
Anders Carlsson28466ab2010-10-31 22:13:23 +0000317 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
318 UpdateEmptyFieldSubobjects(FD, FieldOffset);
Anders Carlssondb319762010-05-27 18:20:57 +0000319 }
Anders Carlsson439edd12010-05-27 05:41:06 +0000320}
321
Anders Carlssona60b86a2010-05-29 20:49:49 +0000322bool EmptySubobjectMap::CanPlaceBaseAtOffset(const BaseSubobjectInfo *Info,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000323 CharUnits Offset) {
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000324 // If we know this class doesn't have any empty subobjects we don't need to
325 // bother checking.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000326 if (SizeOfLargestEmptySubobject.isZero())
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000327 return true;
328
Anders Carlsson439edd12010-05-27 05:41:06 +0000329 if (!CanPlaceBaseSubobjectAtOffset(Info, Offset))
330 return false;
Anders Carlssondb319762010-05-27 18:20:57 +0000331
332 // We are able to place the base at this offset. Make sure to update the
333 // empty base subobject map.
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000334 UpdateEmptyBaseSubobjects(Info, Offset, Info->Class->isEmpty());
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000335 return true;
336}
337
Anders Carlssondb319762010-05-27 18:20:57 +0000338bool
339EmptySubobjectMap::CanPlaceFieldSubobjectAtOffset(const CXXRecordDecl *RD,
340 const CXXRecordDecl *Class,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000341 CharUnits Offset) const {
Anders Carlsson45c1d282010-06-08 16:20:35 +0000342 // We don't have to keep looking past the maximum offset that's known to
343 // contain an empty class.
Anders Carlsson28466ab2010-10-31 22:13:23 +0000344 if (!AnyEmptySubobjectsBeyondOffset(Offset))
Anders Carlsson45c1d282010-06-08 16:20:35 +0000345 return true;
346
Anders Carlsson28466ab2010-10-31 22:13:23 +0000347 if (!CanPlaceSubobjectAtOffset(RD, Offset))
Anders Carlssondb319762010-05-27 18:20:57 +0000348 return false;
349
350 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
351
352 // Traverse all non-virtual bases.
353 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
354 E = RD->bases_end(); I != E; ++I) {
355 if (I->isVirtual())
356 continue;
357
358 const CXXRecordDecl *BaseDecl =
359 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
360
Anders Carlsson0a14ee92010-11-01 00:21:58 +0000361 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(BaseDecl);
Anders Carlssondb319762010-05-27 18:20:57 +0000362 if (!CanPlaceFieldSubobjectAtOffset(BaseDecl, Class, BaseOffset))
363 return false;
364 }
365
Anders Carlsson44687202010-06-08 19:09:24 +0000366 if (RD == Class) {
367 // This is the most derived class, traverse virtual bases as well.
368 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
369 E = RD->vbases_end(); I != E; ++I) {
370 const CXXRecordDecl *VBaseDecl =
371 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
372
Anders Carlsson3f018712010-10-31 23:45:59 +0000373 CharUnits VBaseOffset = Offset + Layout.getVBaseClassOffset(VBaseDecl);
Anders Carlsson44687202010-06-08 19:09:24 +0000374 if (!CanPlaceFieldSubobjectAtOffset(VBaseDecl, Class, VBaseOffset))
375 return false;
376 }
377 }
378
Anders Carlssondb319762010-05-27 18:20:57 +0000379 // Traverse all member variables.
380 unsigned FieldNo = 0;
381 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
382 I != E; ++I, ++FieldNo) {
383 const FieldDecl *FD = *I;
Anders Carlsson233e2722010-10-31 21:54:55 +0000384 if (FD->isBitField())
385 continue;
386
Anders Carlsson28466ab2010-10-31 22:13:23 +0000387 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
Anders Carlssondb319762010-05-27 18:20:57 +0000388
389 if (!CanPlaceFieldSubobjectAtOffset(FD, FieldOffset))
390 return false;
391 }
392
393 return true;
394}
395
Anders Carlsson233e2722010-10-31 21:54:55 +0000396bool
397EmptySubobjectMap::CanPlaceFieldSubobjectAtOffset(const FieldDecl *FD,
398 CharUnits Offset) const {
Anders Carlsson45c1d282010-06-08 16:20:35 +0000399 // We don't have to keep looking past the maximum offset that's known to
400 // contain an empty class.
Anders Carlsson233e2722010-10-31 21:54:55 +0000401 if (!AnyEmptySubobjectsBeyondOffset(Offset))
Anders Carlsson45c1d282010-06-08 16:20:35 +0000402 return true;
403
Anders Carlssondb319762010-05-27 18:20:57 +0000404 QualType T = FD->getType();
405 if (const RecordType *RT = T->getAs<RecordType>()) {
406 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
Anders Carlsson28466ab2010-10-31 22:13:23 +0000407 return CanPlaceFieldSubobjectAtOffset(RD, RD, Offset);
Anders Carlssondb319762010-05-27 18:20:57 +0000408 }
409
410 // If we have an array type we need to look at every element.
411 if (const ConstantArrayType *AT = Context.getAsConstantArrayType(T)) {
412 QualType ElemTy = Context.getBaseElementType(AT);
413 const RecordType *RT = ElemTy->getAs<RecordType>();
414 if (!RT)
415 return true;
416
417 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
418 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
419
420 uint64_t NumElements = Context.getConstantArrayElementCount(AT);
Anders Carlsson233e2722010-10-31 21:54:55 +0000421 CharUnits ElementOffset = Offset;
Anders Carlssondb319762010-05-27 18:20:57 +0000422 for (uint64_t I = 0; I != NumElements; ++I) {
Anders Carlsson45c1d282010-06-08 16:20:35 +0000423 // We don't have to keep looking past the maximum offset that's known to
424 // contain an empty class.
Anders Carlsson233e2722010-10-31 21:54:55 +0000425 if (!AnyEmptySubobjectsBeyondOffset(ElementOffset))
Anders Carlsson45c1d282010-06-08 16:20:35 +0000426 return true;
427
Anders Carlsson28466ab2010-10-31 22:13:23 +0000428 if (!CanPlaceFieldSubobjectAtOffset(RD, RD, ElementOffset))
Anders Carlssondb319762010-05-27 18:20:57 +0000429 return false;
430
Ken Dyckc8ae5502011-02-09 01:59:34 +0000431 ElementOffset += Layout.getSize();
Anders Carlssondb319762010-05-27 18:20:57 +0000432 }
433 }
434
435 return true;
436}
437
438bool
Anders Carlsson28466ab2010-10-31 22:13:23 +0000439EmptySubobjectMap::CanPlaceFieldAtOffset(const FieldDecl *FD,
440 CharUnits Offset) {
441 if (!CanPlaceFieldSubobjectAtOffset(FD, Offset))
Anders Carlssondb319762010-05-27 18:20:57 +0000442 return false;
443
444 // We are able to place the member variable at this offset.
445 // Make sure to update the empty base subobject map.
446 UpdateEmptyFieldSubobjects(FD, Offset);
447 return true;
448}
449
450void EmptySubobjectMap::UpdateEmptyFieldSubobjects(const CXXRecordDecl *RD,
451 const CXXRecordDecl *Class,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000452 CharUnits Offset) {
Anders Carlssonae111dc2010-06-13 17:49:16 +0000453 // We know that the only empty subobjects that can conflict with empty
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000454 // field subobjects are subobjects of empty bases that can be placed at offset
Anders Carlssonae111dc2010-06-13 17:49:16 +0000455 // zero. Because of this, we only need to keep track of empty field
456 // subobjects with offsets less than the size of the largest empty
457 // subobject for our class.
458 if (Offset >= SizeOfLargestEmptySubobject)
459 return;
460
Anders Carlsson28466ab2010-10-31 22:13:23 +0000461 AddSubobjectAtOffset(RD, Offset);
Anders Carlssondb319762010-05-27 18:20:57 +0000462
463 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
464
465 // Traverse all non-virtual bases.
466 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
467 E = RD->bases_end(); I != E; ++I) {
468 if (I->isVirtual())
469 continue;
470
471 const CXXRecordDecl *BaseDecl =
472 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
473
Anders Carlsson0a14ee92010-11-01 00:21:58 +0000474 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(BaseDecl);
Anders Carlssondb319762010-05-27 18:20:57 +0000475 UpdateEmptyFieldSubobjects(BaseDecl, Class, BaseOffset);
476 }
477
Anders Carlsson44687202010-06-08 19:09:24 +0000478 if (RD == Class) {
479 // This is the most derived class, traverse virtual bases as well.
480 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
481 E = RD->vbases_end(); I != E; ++I) {
482 const CXXRecordDecl *VBaseDecl =
483 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
484
Anders Carlsson3f018712010-10-31 23:45:59 +0000485 CharUnits VBaseOffset = Offset + Layout.getVBaseClassOffset(VBaseDecl);
Anders Carlsson44687202010-06-08 19:09:24 +0000486 UpdateEmptyFieldSubobjects(VBaseDecl, Class, VBaseOffset);
487 }
488 }
489
Anders Carlssondb319762010-05-27 18:20:57 +0000490 // Traverse all member variables.
491 unsigned FieldNo = 0;
492 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
493 I != E; ++I, ++FieldNo) {
494 const FieldDecl *FD = *I;
Anders Carlsson09814d32010-11-01 15:14:51 +0000495 if (FD->isBitField())
496 continue;
497
Anders Carlsson28466ab2010-10-31 22:13:23 +0000498 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
Anders Carlssondb319762010-05-27 18:20:57 +0000499
Anders Carlsson28466ab2010-10-31 22:13:23 +0000500 UpdateEmptyFieldSubobjects(FD, FieldOffset);
Anders Carlssondb319762010-05-27 18:20:57 +0000501 }
502}
503
504void EmptySubobjectMap::UpdateEmptyFieldSubobjects(const FieldDecl *FD,
Anders Carlsson28466ab2010-10-31 22:13:23 +0000505 CharUnits Offset) {
Anders Carlssondb319762010-05-27 18:20:57 +0000506 QualType T = FD->getType();
507 if (const RecordType *RT = T->getAs<RecordType>()) {
508 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
509 UpdateEmptyFieldSubobjects(RD, RD, Offset);
510 return;
511 }
512
513 // If we have an array type we need to update every element.
514 if (const ConstantArrayType *AT = Context.getAsConstantArrayType(T)) {
515 QualType ElemTy = Context.getBaseElementType(AT);
516 const RecordType *RT = ElemTy->getAs<RecordType>();
517 if (!RT)
518 return;
519
520 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
521 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
522
523 uint64_t NumElements = Context.getConstantArrayElementCount(AT);
Anders Carlsson28466ab2010-10-31 22:13:23 +0000524 CharUnits ElementOffset = Offset;
Anders Carlssondb319762010-05-27 18:20:57 +0000525
526 for (uint64_t I = 0; I != NumElements; ++I) {
Anders Carlssonae111dc2010-06-13 17:49:16 +0000527 // We know that the only empty subobjects that can conflict with empty
Anders Carlssoncc59cc52010-06-13 18:00:18 +0000528 // field subobjects are subobjects of empty bases that can be placed at
Anders Carlssonae111dc2010-06-13 17:49:16 +0000529 // offset zero. Because of this, we only need to keep track of empty field
530 // subobjects with offsets less than the size of the largest empty
531 // subobject for our class.
532 if (ElementOffset >= SizeOfLargestEmptySubobject)
533 return;
534
Anders Carlssondb319762010-05-27 18:20:57 +0000535 UpdateEmptyFieldSubobjects(RD, RD, ElementOffset);
Ken Dyckc8ae5502011-02-09 01:59:34 +0000536 ElementOffset += Layout.getSize();
Anders Carlssondb319762010-05-27 18:20:57 +0000537 }
538 }
539}
540
Anders Carlssonc2226202010-05-26 05:58:59 +0000541class RecordLayoutBuilder {
Charles Davisc2c576a2010-08-19 00:55:19 +0000542protected:
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000543 // FIXME: Remove this and make the appropriate fields public.
544 friend class clang::ASTContext;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000545
Jay Foad39c79802011-01-12 09:06:06 +0000546 const ASTContext &Context;
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000547
Anders Carlssonf58de112010-05-26 15:32:58 +0000548 EmptySubobjectMap *EmptySubobjects;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000549
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000550 /// Size - The current size of the record layout.
551 uint64_t Size;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000552
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000553 /// Alignment - The current alignment of the record layout.
554 unsigned Alignment;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000555
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000556 /// \brief The alignment if attribute packed is not used.
557 unsigned UnpackedAlignment;
558
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000559 llvm::SmallVector<uint64_t, 16> FieldOffsets;
560
561 /// Packed - Whether the record is packed or not.
Daniel Dunbar6da10982010-05-27 05:45:51 +0000562 unsigned Packed : 1;
563
564 unsigned IsUnion : 1;
565
566 unsigned IsMac68kAlign : 1;
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000567
568 /// UnfilledBitsInLastByte - If the last field laid out was a bitfield,
569 /// this contains the number of bits in the last byte that can be used for
570 /// an adjacent bitfield if necessary.
571 unsigned char UnfilledBitsInLastByte;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000572
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000573 /// MaxFieldAlignment - The maximum allowed field alignment. This is set by
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000574 /// #pragma pack.
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000575 unsigned MaxFieldAlignment;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000576
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000577 /// DataSize - The data size of the record being laid out.
578 uint64_t DataSize;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000579
Ken Dyckaf1c83f2011-02-16 01:52:01 +0000580 CharUnits NonVirtualSize;
Ken Dycka2d3dda2011-02-16 01:43:15 +0000581 CharUnits NonVirtualAlignment;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000582
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000583 /// PrimaryBase - the primary base class (if one exists) of the class
584 /// we're laying out.
585 const CXXRecordDecl *PrimaryBase;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000586
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000587 /// PrimaryBaseIsVirtual - Whether the primary base of the class we're laying
588 /// out is virtual.
589 bool PrimaryBaseIsVirtual;
590
Anders Carlsson22f57202010-10-31 21:01:46 +0000591 typedef llvm::DenseMap<const CXXRecordDecl *, CharUnits> BaseOffsetsMapTy;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000592
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000593 /// Bases - base classes and their offsets in the record.
594 BaseOffsetsMapTy Bases;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000595
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000596 // VBases - virtual base classes and their offsets in the record.
597 BaseOffsetsMapTy VBases;
598
599 /// IndirectPrimaryBases - Virtual base classes, direct or indirect, that are
600 /// primary base classes for some other direct or indirect base class.
Anders Carlsson5adde292010-11-24 22:55:48 +0000601 CXXIndirectPrimaryBaseSet IndirectPrimaryBases;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000602
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000603 /// FirstNearlyEmptyVBase - The first nearly empty virtual base class in
604 /// inheritance graph order. Used for determining the primary base class.
605 const CXXRecordDecl *FirstNearlyEmptyVBase;
606
607 /// VisitedVirtualBases - A set of all the visited virtual bases, used to
608 /// avoid visiting virtual bases more than once.
609 llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBases;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000610
Jay Foad39c79802011-01-12 09:06:06 +0000611 RecordLayoutBuilder(const ASTContext &Context, EmptySubobjectMap
612 *EmptySubobjects)
Anders Carlssonc121b4e2010-05-27 00:07:01 +0000613 : Context(Context), EmptySubobjects(EmptySubobjects), Size(0), Alignment(8),
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000614 UnpackedAlignment(Alignment), Packed(false), IsUnion(false),
615 IsMac68kAlign(false), UnfilledBitsInLastByte(0), MaxFieldAlignment(0),
Ken Dyckaf1c83f2011-02-16 01:52:01 +0000616 DataSize(0), NonVirtualSize(CharUnits::Zero()),
617 NonVirtualAlignment(CharUnits::One()), PrimaryBase(0),
618 PrimaryBaseIsVirtual(false), FirstNearlyEmptyVBase(0) { }
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000619
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000620 void Layout(const RecordDecl *D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000621 void Layout(const CXXRecordDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000622 void Layout(const ObjCInterfaceDecl *D);
623
624 void LayoutFields(const RecordDecl *D);
625 void LayoutField(const FieldDecl *D);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000626 void LayoutWideBitField(uint64_t FieldSize, uint64_t TypeSize,
627 bool FieldPacked, const FieldDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000628 void LayoutBitField(const FieldDecl *D);
629
Anders Carlssone3c24c72010-05-29 17:35:14 +0000630 /// BaseSubobjectInfoAllocator - Allocator for BaseSubobjectInfo objects.
631 llvm::SpecificBumpPtrAllocator<BaseSubobjectInfo> BaseSubobjectInfoAllocator;
632
633 typedef llvm::DenseMap<const CXXRecordDecl *, BaseSubobjectInfo *>
634 BaseSubobjectInfoMapTy;
635
636 /// VirtualBaseInfo - Map from all the (direct or indirect) virtual bases
637 /// of the class we're laying out to their base subobject info.
638 BaseSubobjectInfoMapTy VirtualBaseInfo;
639
640 /// NonVirtualBaseInfo - Map from all the direct non-virtual bases of the
641 /// class we're laying out to their base subobject info.
642 BaseSubobjectInfoMapTy NonVirtualBaseInfo;
643
644 /// ComputeBaseSubobjectInfo - Compute the base subobject information for the
645 /// bases of the given class.
646 void ComputeBaseSubobjectInfo(const CXXRecordDecl *RD);
647
648 /// ComputeBaseSubobjectInfo - Compute the base subobject information for a
649 /// single class and all of its base classes.
650 BaseSubobjectInfo *ComputeBaseSubobjectInfo(const CXXRecordDecl *RD,
651 bool IsVirtual,
652 BaseSubobjectInfo *Derived);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000653
654 /// DeterminePrimaryBase - Determine the primary base of the given class.
655 void DeterminePrimaryBase(const CXXRecordDecl *RD);
656
657 void SelectPrimaryVBase(const CXXRecordDecl *RD);
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000658
Charles Davisc2c576a2010-08-19 00:55:19 +0000659 virtual uint64_t GetVirtualPointersSize(const CXXRecordDecl *RD) const;
660
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000661 /// LayoutNonVirtualBases - Determines the primary base class (if any) and
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000662 /// lays it out. Will then proceed to lay out all non-virtual base clasess.
663 void LayoutNonVirtualBases(const CXXRecordDecl *RD);
664
665 /// LayoutNonVirtualBase - Lays out a single non-virtual base.
Anders Carlssonbb0e6782010-05-29 17:42:25 +0000666 void LayoutNonVirtualBase(const BaseSubobjectInfo *Base);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000667
Anders Carlssona2f8e412010-10-31 22:20:42 +0000668 void AddPrimaryVirtualBaseOffsets(const BaseSubobjectInfo *Info,
669 CharUnits Offset);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000670
671 /// LayoutVirtualBases - Lays out all the virtual bases.
672 void LayoutVirtualBases(const CXXRecordDecl *RD,
673 const CXXRecordDecl *MostDerivedClass);
674
675 /// LayoutVirtualBase - Lays out a single virtual base.
Anders Carlssond6ff5d72010-05-29 17:48:36 +0000676 void LayoutVirtualBase(const BaseSubobjectInfo *Base);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000677
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000678 /// LayoutBase - Will lay out a base and return the offset where it was
Anders Carlssona2f8e412010-10-31 22:20:42 +0000679 /// placed, in chars.
680 CharUnits LayoutBase(const BaseSubobjectInfo *Base);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000681
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000682 /// InitializeLayout - Initialize record layout for the given record decl.
Daniel Dunbar6da10982010-05-27 05:45:51 +0000683 void InitializeLayout(const Decl *D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000684
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000685 /// FinishLayout - Finalize record layout. Adjust record size based on the
686 /// alignment.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000687 void FinishLayout(const NamedDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000688
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000689 void UpdateAlignment(unsigned NewAlignment, unsigned UnpackedNewAlignment);
690 void UpdateAlignment(unsigned NewAlignment) {
691 UpdateAlignment(NewAlignment, NewAlignment);
692 }
693
694 void CheckFieldPadding(uint64_t Offset, uint64_t UnpaddedOffset,
695 uint64_t UnpackedOffset, unsigned UnpackedAlign,
696 bool isPacked, const FieldDecl *D);
697
698 DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000699
Argyrios Kyrtzidis499e6e42010-08-15 10:17:39 +0000700 RecordLayoutBuilder(const RecordLayoutBuilder&); // DO NOT IMPLEMENT
701 void operator=(const RecordLayoutBuilder&); // DO NOT IMPLEMENT
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000702public:
703 static const CXXMethodDecl *ComputeKeyFunction(const CXXRecordDecl *RD);
Argyrios Kyrtzidis3c6cd172010-08-25 00:32:14 +0000704
705 virtual ~RecordLayoutBuilder() { }
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000706};
Benjamin Kramerc7656cd2010-05-26 09:58:31 +0000707} // end anonymous namespace
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000708
Anders Carlsson81430692009-09-22 03:02:06 +0000709void
Anders Carlssonc2226202010-05-26 05:58:59 +0000710RecordLayoutBuilder::SelectPrimaryVBase(const CXXRecordDecl *RD) {
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000711 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000712 E = RD->bases_end(); I != E; ++I) {
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000713 assert(!I->getType()->isDependentType() &&
Sebastian Redl1054fae2009-10-25 17:03:50 +0000714 "Cannot layout class with dependent bases.");
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000715
Mike Stump11289f42009-09-09 15:08:12 +0000716 const CXXRecordDecl *Base =
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000717 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000718
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000719 // Check if this is a nearly empty virtual base.
Anders Carlsson60a62632010-11-25 01:51:53 +0000720 if (I->isVirtual() && Context.isNearlyEmpty(Base)) {
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000721 // If it's not an indirect primary base, then we've found our primary
722 // base.
Anders Carlsson81430692009-09-22 03:02:06 +0000723 if (!IndirectPrimaryBases.count(Base)) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000724 PrimaryBase = Base;
725 PrimaryBaseIsVirtual = true;
Mike Stump6f3793b2009-08-12 21:50:08 +0000726 return;
727 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000728
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000729 // Is this the first nearly empty virtual base?
730 if (!FirstNearlyEmptyVBase)
731 FirstNearlyEmptyVBase = Base;
Mike Stump6f3793b2009-08-12 21:50:08 +0000732 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000733
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000734 SelectPrimaryVBase(Base);
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000735 if (PrimaryBase)
Zhongxing Xuec345b72010-02-15 04:28:35 +0000736 return;
Mike Stump6f3793b2009-08-12 21:50:08 +0000737 }
738}
739
Charles Davisc2c576a2010-08-19 00:55:19 +0000740uint64_t
741RecordLayoutBuilder::GetVirtualPointersSize(const CXXRecordDecl *RD) const {
742 return Context.Target.getPointerWidth(0);
743}
744
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000745/// DeterminePrimaryBase - Determine the primary base of the given class.
Anders Carlssonc2226202010-05-26 05:58:59 +0000746void RecordLayoutBuilder::DeterminePrimaryBase(const CXXRecordDecl *RD) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000747 // If the class isn't dynamic, it won't have a primary base.
748 if (!RD->isDynamicClass())
749 return;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000750
Anders Carlsson81430692009-09-22 03:02:06 +0000751 // Compute all the primary virtual bases for all of our direct and
Mike Stump590a7c72009-08-13 23:26:06 +0000752 // indirect bases, and record all their primary virtual base classes.
Anders Carlsson5adde292010-11-24 22:55:48 +0000753 RD->getIndirectPrimaryBases(IndirectPrimaryBases);
Mike Stump590a7c72009-08-13 23:26:06 +0000754
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000755 // If the record has a dynamic base class, attempt to choose a primary base
756 // class. It is the first (in direct base class order) non-virtual dynamic
Anders Carlsson81430692009-09-22 03:02:06 +0000757 // base class, if one exists.
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000758 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000759 e = RD->bases_end(); i != e; ++i) {
Anders Carlsson03ff3792009-11-27 22:05:05 +0000760 // Ignore virtual bases.
761 if (i->isVirtual())
762 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000763
Anders Carlsson03ff3792009-11-27 22:05:05 +0000764 const CXXRecordDecl *Base =
765 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
766
767 if (Base->isDynamicClass()) {
768 // We found it.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000769 PrimaryBase = Base;
770 PrimaryBaseIsVirtual = false;
Anders Carlsson03ff3792009-11-27 22:05:05 +0000771 return;
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000772 }
773 }
774
775 // Otherwise, it is the first nearly empty virtual base that is not an
Mike Stump78696a72009-08-11 04:03:59 +0000776 // indirect primary virtual base class, if one exists.
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000777 if (RD->getNumVBases() != 0) {
778 SelectPrimaryVBase(RD);
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000779 if (PrimaryBase)
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000780 return;
781 }
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000782
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000783 // Otherwise, it is the first nearly empty virtual base that is not an
784 // indirect primary virtual base class, if one exists.
785 if (FirstNearlyEmptyVBase) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000786 PrimaryBase = FirstNearlyEmptyVBase;
787 PrimaryBaseIsVirtual = true;
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000788 return;
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000789 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000790
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000791 // Otherwise there is no primary base class.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000792 assert(!PrimaryBase && "Should not get here with a primary base!");
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000793
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000794 // Allocate the virtual table pointer at offset zero.
795 assert(DataSize == 0 && "Vtable pointer must be at offset zero!");
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000796
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000797 // Update the size.
Charles Davisc2c576a2010-08-19 00:55:19 +0000798 Size += GetVirtualPointersSize(RD);
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000799 DataSize = Size;
800
Argyrios Kyrtzidisd62c9be2010-12-09 02:47:58 +0000801 unsigned UnpackedBaseAlign = Context.Target.getPointerAlign(0);
802 unsigned BaseAlign = (Packed) ? 8 : UnpackedBaseAlign;
803
804 // The maximum field alignment overrides base align.
805 if (MaxFieldAlignment) {
806 BaseAlign = std::min(BaseAlign, MaxFieldAlignment);
807 UnpackedBaseAlign = std::min(UnpackedBaseAlign, MaxFieldAlignment);
808 }
809
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000810 // Update the alignment.
Argyrios Kyrtzidisd62c9be2010-12-09 02:47:58 +0000811 UpdateAlignment(BaseAlign, UnpackedBaseAlign);
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000812}
813
Anders Carlssone3c24c72010-05-29 17:35:14 +0000814BaseSubobjectInfo *
815RecordLayoutBuilder::ComputeBaseSubobjectInfo(const CXXRecordDecl *RD,
816 bool IsVirtual,
817 BaseSubobjectInfo *Derived) {
818 BaseSubobjectInfo *Info;
819
820 if (IsVirtual) {
821 // Check if we already have info about this virtual base.
822 BaseSubobjectInfo *&InfoSlot = VirtualBaseInfo[RD];
823 if (InfoSlot) {
824 assert(InfoSlot->Class == RD && "Wrong class for virtual base info!");
825 return InfoSlot;
826 }
827
828 // We don't, create it.
829 InfoSlot = new (BaseSubobjectInfoAllocator.Allocate()) BaseSubobjectInfo;
830 Info = InfoSlot;
831 } else {
832 Info = new (BaseSubobjectInfoAllocator.Allocate()) BaseSubobjectInfo;
833 }
834
835 Info->Class = RD;
836 Info->IsVirtual = IsVirtual;
837 Info->Derived = 0;
838 Info->PrimaryVirtualBaseInfo = 0;
839
840 const CXXRecordDecl *PrimaryVirtualBase = 0;
841 BaseSubobjectInfo *PrimaryVirtualBaseInfo = 0;
842
843 // Check if this base has a primary virtual base.
844 if (RD->getNumVBases()) {
845 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlsson7f95cd12010-11-24 23:12:57 +0000846 if (Layout.isPrimaryBaseVirtual()) {
Anders Carlssone3c24c72010-05-29 17:35:14 +0000847 // This base does have a primary virtual base.
848 PrimaryVirtualBase = Layout.getPrimaryBase();
849 assert(PrimaryVirtualBase && "Didn't have a primary virtual base!");
850
851 // Now check if we have base subobject info about this primary base.
852 PrimaryVirtualBaseInfo = VirtualBaseInfo.lookup(PrimaryVirtualBase);
853
854 if (PrimaryVirtualBaseInfo) {
855 if (PrimaryVirtualBaseInfo->Derived) {
856 // We did have info about this primary base, and it turns out that it
857 // has already been claimed as a primary virtual base for another
858 // base.
859 PrimaryVirtualBase = 0;
860 } else {
861 // We can claim this base as our primary base.
862 Info->PrimaryVirtualBaseInfo = PrimaryVirtualBaseInfo;
863 PrimaryVirtualBaseInfo->Derived = Info;
864 }
865 }
866 }
867 }
868
869 // Now go through all direct bases.
870 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
871 E = RD->bases_end(); I != E; ++I) {
872 bool IsVirtual = I->isVirtual();
873
874 const CXXRecordDecl *BaseDecl =
875 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
876
877 Info->Bases.push_back(ComputeBaseSubobjectInfo(BaseDecl, IsVirtual, Info));
878 }
879
880 if (PrimaryVirtualBase && !PrimaryVirtualBaseInfo) {
881 // Traversing the bases must have created the base info for our primary
882 // virtual base.
883 PrimaryVirtualBaseInfo = VirtualBaseInfo.lookup(PrimaryVirtualBase);
884 assert(PrimaryVirtualBaseInfo &&
885 "Did not create a primary virtual base!");
886
887 // Claim the primary virtual base as our primary virtual base.
888 Info->PrimaryVirtualBaseInfo = PrimaryVirtualBaseInfo;
889 PrimaryVirtualBaseInfo->Derived = Info;
890 }
891
892 return Info;
893}
894
895void RecordLayoutBuilder::ComputeBaseSubobjectInfo(const CXXRecordDecl *RD) {
896 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
897 E = RD->bases_end(); I != E; ++I) {
898 bool IsVirtual = I->isVirtual();
899
900 const CXXRecordDecl *BaseDecl =
901 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
902
903 // Compute the base subobject info for this base.
904 BaseSubobjectInfo *Info = ComputeBaseSubobjectInfo(BaseDecl, IsVirtual, 0);
905
906 if (IsVirtual) {
907 // ComputeBaseInfo has already added this base for us.
908 assert(VirtualBaseInfo.count(BaseDecl) &&
909 "Did not add virtual base!");
910 } else {
911 // Add the base info to the map of non-virtual bases.
912 assert(!NonVirtualBaseInfo.count(BaseDecl) &&
913 "Non-virtual base already exists!");
914 NonVirtualBaseInfo.insert(std::make_pair(BaseDecl, Info));
915 }
916 }
917}
918
Anders Carlsson09ffa322010-03-10 22:21:28 +0000919void
Anders Carlssonc2226202010-05-26 05:58:59 +0000920RecordLayoutBuilder::LayoutNonVirtualBases(const CXXRecordDecl *RD) {
Anders Carlssone3c24c72010-05-29 17:35:14 +0000921 // Then, determine the primary base class.
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000922 DeterminePrimaryBase(RD);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000923
Anders Carlssone3c24c72010-05-29 17:35:14 +0000924 // Compute base subobject info.
925 ComputeBaseSubobjectInfo(RD);
926
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000927 // If we have a primary base class, lay it out.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000928 if (PrimaryBase) {
929 if (PrimaryBaseIsVirtual) {
Anders Carlssone3c24c72010-05-29 17:35:14 +0000930 // If the primary virtual base was a primary virtual base of some other
931 // base class we'll have to steal it.
932 BaseSubobjectInfo *PrimaryBaseInfo = VirtualBaseInfo.lookup(PrimaryBase);
933 PrimaryBaseInfo->Derived = 0;
934
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000935 // We have a virtual primary base, insert it as an indirect primary base.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000936 IndirectPrimaryBases.insert(PrimaryBase);
Anders Carlssonfe900962010-03-11 05:42:17 +0000937
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000938 assert(!VisitedVirtualBases.count(PrimaryBase) &&
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000939 "vbase already visited!");
940 VisitedVirtualBases.insert(PrimaryBase);
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000941
Anders Carlssond6ff5d72010-05-29 17:48:36 +0000942 LayoutVirtualBase(PrimaryBaseInfo);
Anders Carlssonbb0e6782010-05-29 17:42:25 +0000943 } else {
944 BaseSubobjectInfo *PrimaryBaseInfo =
945 NonVirtualBaseInfo.lookup(PrimaryBase);
946 assert(PrimaryBaseInfo &&
947 "Did not find base info for non-virtual primary base!");
948
949 LayoutNonVirtualBase(PrimaryBaseInfo);
950 }
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000951 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000952
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000953 // Now lay out the non-virtual bases.
954 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000955 E = RD->bases_end(); I != E; ++I) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000956
957 // Ignore virtual bases.
958 if (I->isVirtual())
959 continue;
960
Anders Carlssonbb0e6782010-05-29 17:42:25 +0000961 const CXXRecordDecl *BaseDecl =
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000962 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
963
964 // Skip the primary base.
Anders Carlssonbb0e6782010-05-29 17:42:25 +0000965 if (BaseDecl == PrimaryBase && !PrimaryBaseIsVirtual)
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000966 continue;
967
968 // Lay out the base.
Anders Carlssonbb0e6782010-05-29 17:42:25 +0000969 BaseSubobjectInfo *BaseInfo = NonVirtualBaseInfo.lookup(BaseDecl);
970 assert(BaseInfo && "Did not find base info for non-virtual base!");
971
972 LayoutNonVirtualBase(BaseInfo);
Anders Carlsson09ffa322010-03-10 22:21:28 +0000973 }
974}
975
Anders Carlssonbb0e6782010-05-29 17:42:25 +0000976void RecordLayoutBuilder::LayoutNonVirtualBase(const BaseSubobjectInfo *Base) {
Anders Carlsson0d0b5882010-03-10 22:26:24 +0000977 // Layout the base.
Anders Carlssona2f8e412010-10-31 22:20:42 +0000978 CharUnits Offset = LayoutBase(Base);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000979
Anders Carlsson0d0b5882010-03-10 22:26:24 +0000980 // Add its base class offset.
Anders Carlssonbb0e6782010-05-29 17:42:25 +0000981 assert(!Bases.count(Base->Class) && "base offset already exists!");
Anders Carlssona2f8e412010-10-31 22:20:42 +0000982 Bases.insert(std::make_pair(Base->Class, Offset));
Anders Carlsson6b0d9142010-05-29 19:44:50 +0000983
984 AddPrimaryVirtualBaseOffsets(Base, Offset);
Anders Carlsson09ffa322010-03-10 22:21:28 +0000985}
Mike Stump2b84dd32009-11-05 04:02:15 +0000986
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000987void
Anders Carlsson6b0d9142010-05-29 19:44:50 +0000988RecordLayoutBuilder::AddPrimaryVirtualBaseOffsets(const BaseSubobjectInfo *Info,
Anders Carlssona2f8e412010-10-31 22:20:42 +0000989 CharUnits Offset) {
Anders Carlsson6b0d9142010-05-29 19:44:50 +0000990 // This base isn't interesting, it has no virtual bases.
991 if (!Info->Class->getNumVBases())
992 return;
993
994 // First, check if we have a virtual primary base to add offsets for.
995 if (Info->PrimaryVirtualBaseInfo) {
996 assert(Info->PrimaryVirtualBaseInfo->IsVirtual &&
997 "Primary virtual base is not virtual!");
998 if (Info->PrimaryVirtualBaseInfo->Derived == Info) {
999 // Add the offset.
1000 assert(!VBases.count(Info->PrimaryVirtualBaseInfo->Class) &&
1001 "primary vbase offset already exists!");
1002 VBases.insert(std::make_pair(Info->PrimaryVirtualBaseInfo->Class,
Anders Carlssona2f8e412010-10-31 22:20:42 +00001003 Offset));
Anders Carlssonea7b1822010-04-15 16:12:58 +00001004
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001005 // Traverse the primary virtual base.
1006 AddPrimaryVirtualBaseOffsets(Info->PrimaryVirtualBaseInfo, Offset);
1007 }
Anders Carlssonea7b1822010-04-15 16:12:58 +00001008 }
1009
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001010 // Now go through all direct non-virtual bases.
1011 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Info->Class);
1012 for (unsigned I = 0, E = Info->Bases.size(); I != E; ++I) {
1013 const BaseSubobjectInfo *Base = Info->Bases[I];
1014 if (Base->IsVirtual)
Anders Carlssonea7b1822010-04-15 16:12:58 +00001015 continue;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001016
Anders Carlsson0a14ee92010-11-01 00:21:58 +00001017 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base->Class);
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001018 AddPrimaryVirtualBaseOffsets(Base, BaseOffset);
Anders Carlssonea7b1822010-04-15 16:12:58 +00001019 }
1020}
1021
1022void
Anders Carlssonc2226202010-05-26 05:58:59 +00001023RecordLayoutBuilder::LayoutVirtualBases(const CXXRecordDecl *RD,
Anders Carlssonea7b1822010-04-15 16:12:58 +00001024 const CXXRecordDecl *MostDerivedClass) {
Anders Carlssonde710c92010-03-11 04:33:54 +00001025 const CXXRecordDecl *PrimaryBase;
Anders Carlsson291279e2010-04-10 18:42:27 +00001026 bool PrimaryBaseIsVirtual;
Anders Carlssonfe900962010-03-11 05:42:17 +00001027
Anders Carlsson291279e2010-04-10 18:42:27 +00001028 if (MostDerivedClass == RD) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +00001029 PrimaryBase = this->PrimaryBase;
1030 PrimaryBaseIsVirtual = this->PrimaryBaseIsVirtual;
Anders Carlsson291279e2010-04-10 18:42:27 +00001031 } else {
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001032 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlssonde710c92010-03-11 04:33:54 +00001033 PrimaryBase = Layout.getPrimaryBase();
Anders Carlsson7f95cd12010-11-24 23:12:57 +00001034 PrimaryBaseIsVirtual = Layout.isPrimaryBaseVirtual();
Anders Carlsson291279e2010-04-10 18:42:27 +00001035 }
1036
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001037 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1038 E = RD->bases_end(); I != E; ++I) {
1039 assert(!I->getType()->isDependentType() &&
Sebastian Redl1054fae2009-10-25 17:03:50 +00001040 "Cannot layout class with dependent bases.");
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001041
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001042 const CXXRecordDecl *BaseDecl =
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001043 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1044
1045 if (I->isVirtual()) {
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001046 if (PrimaryBase != BaseDecl || !PrimaryBaseIsVirtual) {
1047 bool IndirectPrimaryBase = IndirectPrimaryBases.count(BaseDecl);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001048
Anders Carlsson291279e2010-04-10 18:42:27 +00001049 // Only lay out the virtual base if it's not an indirect primary base.
1050 if (!IndirectPrimaryBase) {
1051 // Only visit virtual bases once.
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001052 if (!VisitedVirtualBases.insert(BaseDecl))
Anders Carlsson291279e2010-04-10 18:42:27 +00001053 continue;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001054
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001055 const BaseSubobjectInfo *BaseInfo = VirtualBaseInfo.lookup(BaseDecl);
1056 assert(BaseInfo && "Did not find virtual base info!");
1057 LayoutVirtualBase(BaseInfo);
Anders Carlsson6a848892010-03-11 04:10:39 +00001058 }
Mike Stump2b84dd32009-11-05 04:02:15 +00001059 }
Mike Stumpc2f591b2009-08-13 22:53:07 +00001060 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001061
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001062 if (!BaseDecl->getNumVBases()) {
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001063 // This base isn't interesting since it doesn't have any virtual bases.
1064 continue;
Mike Stump996576f32009-08-16 19:04:13 +00001065 }
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001066
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001067 LayoutVirtualBases(BaseDecl, MostDerivedClass);
Mike Stump6b2556f2009-08-06 13:41:24 +00001068 }
1069}
1070
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001071void RecordLayoutBuilder::LayoutVirtualBase(const BaseSubobjectInfo *Base) {
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001072 assert(!Base->Derived && "Trying to lay out a primary virtual base!");
1073
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001074 // Layout the base.
Anders Carlssona2f8e412010-10-31 22:20:42 +00001075 CharUnits Offset = LayoutBase(Base);
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001076
1077 // Add its base class offset.
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001078 assert(!VBases.count(Base->Class) && "vbase offset already exists!");
Anders Carlssona2f8e412010-10-31 22:20:42 +00001079 VBases.insert(std::make_pair(Base->Class, Offset));
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001080
1081 AddPrimaryVirtualBaseOffsets(Base, Offset);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001082}
1083
Anders Carlssona2f8e412010-10-31 22:20:42 +00001084CharUnits RecordLayoutBuilder::LayoutBase(const BaseSubobjectInfo *Base) {
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001085 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Base->Class);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001086
1087 // If we have an empty base class, try to place it at offset 0.
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001088 if (Base->Class->isEmpty() &&
Anders Carlsson28466ab2010-10-31 22:13:23 +00001089 EmptySubobjects->CanPlaceBaseAtOffset(Base, CharUnits::Zero())) {
Ken Dyckb0fcc592011-02-11 01:54:29 +00001090 uint64_t RecordSizeInBits = Context.toBits(Layout.getSize());
1091 Size = std::max(Size, RecordSizeInBits);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001092
Anders Carlssona2f8e412010-10-31 22:20:42 +00001093 return CharUnits::Zero();
Anders Carlsson09ffa322010-03-10 22:21:28 +00001094 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001095
Ken Dyckb0fcc592011-02-11 01:54:29 +00001096 unsigned UnpackedBaseAlign = Context.toBits(Layout.getNonVirtualAlign());
Argyrios Kyrtzidis8b542742010-12-09 00:35:20 +00001097 unsigned BaseAlign = (Packed) ? 8 : UnpackedBaseAlign;
1098
1099 // The maximum field alignment overrides base align.
1100 if (MaxFieldAlignment) {
1101 BaseAlign = std::min(BaseAlign, MaxFieldAlignment);
1102 UnpackedBaseAlign = std::min(UnpackedBaseAlign, MaxFieldAlignment);
1103 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001104
Anders Carlsson09ffa322010-03-10 22:21:28 +00001105 // Round up the current record size to the base's alignment boundary.
1106 uint64_t Offset = llvm::RoundUpToAlignment(DataSize, BaseAlign);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001107
Anders Carlsson09ffa322010-03-10 22:21:28 +00001108 // Try to place the base.
Ken Dyck7c4026b2011-01-24 01:28:50 +00001109 while (!EmptySubobjects->CanPlaceBaseAtOffset(Base,
1110 Context.toCharUnitsFromBits(Offset)))
Anders Carlsson09ffa322010-03-10 22:21:28 +00001111 Offset += BaseAlign;
Anders Carlsson09ffa322010-03-10 22:21:28 +00001112
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001113 if (!Base->Class->isEmpty()) {
Anders Carlsson09ffa322010-03-10 22:21:28 +00001114 // Update the data size.
Ken Dyckb0fcc592011-02-11 01:54:29 +00001115 DataSize = Offset + Context.toBits(Layout.getNonVirtualSize());
Anders Carlsson09ffa322010-03-10 22:21:28 +00001116
1117 Size = std::max(Size, DataSize);
1118 } else
Ken Dyckb0fcc592011-02-11 01:54:29 +00001119 Size = std::max(Size, Offset + Context.toBits(Layout.getSize()));
Anders Carlsson09ffa322010-03-10 22:21:28 +00001120
1121 // Remember max struct/class alignment.
Argyrios Kyrtzidis8b542742010-12-09 00:35:20 +00001122 UpdateAlignment(BaseAlign, UnpackedBaseAlign);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001123
Ken Dyck7c4026b2011-01-24 01:28:50 +00001124 return Context.toCharUnitsFromBits(Offset);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001125}
1126
Daniel Dunbar6da10982010-05-27 05:45:51 +00001127void RecordLayoutBuilder::InitializeLayout(const Decl *D) {
1128 if (const RecordDecl *RD = dyn_cast<RecordDecl>(D))
1129 IsUnion = RD->isUnion();
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001130
Anders Carlsson28a5fa22009-08-08 19:38:24 +00001131 Packed = D->hasAttr<PackedAttr>();
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001132
Daniel Dunbar6da10982010-05-27 05:45:51 +00001133 // mac68k alignment supersedes maximum field alignment and attribute aligned,
1134 // and forces all structures to have 2-byte alignment. The IBM docs on it
1135 // allude to additional (more complicated) semantics, especially with regard
1136 // to bit-fields, but gcc appears not to follow that.
1137 if (D->hasAttr<AlignMac68kAttr>()) {
1138 IsMac68kAlign = true;
1139 MaxFieldAlignment = 2 * 8;
1140 Alignment = 2 * 8;
1141 } else {
1142 if (const MaxFieldAlignmentAttr *MFAA = D->getAttr<MaxFieldAlignmentAttr>())
1143 MaxFieldAlignment = MFAA->getAlignment();
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001144
Alexis Huntdcfba7b2010-08-18 23:23:40 +00001145 if (unsigned MaxAlign = D->getMaxAlignment())
1146 UpdateAlignment(MaxAlign);
Daniel Dunbar6da10982010-05-27 05:45:51 +00001147 }
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001148}
Anders Carlsson6d9f6f32009-07-19 00:18:47 +00001149
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001150void RecordLayoutBuilder::Layout(const RecordDecl *D) {
1151 InitializeLayout(D);
Anders Carlsson118ce162009-07-18 21:48:39 +00001152 LayoutFields(D);
Mike Stump11289f42009-09-09 15:08:12 +00001153
Anders Carlsson79474332009-07-18 20:20:21 +00001154 // Finally, round the size of the total struct up to the alignment of the
1155 // struct itself.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001156 FinishLayout(D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001157}
1158
1159void RecordLayoutBuilder::Layout(const CXXRecordDecl *RD) {
1160 InitializeLayout(RD);
1161
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001162 // Lay out the vtable and the non-virtual bases.
1163 LayoutNonVirtualBases(RD);
1164
1165 LayoutFields(RD);
1166
Ken Dyckaf1c83f2011-02-16 01:52:01 +00001167 NonVirtualSize = Context.toCharUnitsFromBits(Size);
Ken Dycka2d3dda2011-02-16 01:43:15 +00001168 NonVirtualAlignment = Context.toCharUnitsFromBits(Alignment);
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001169
1170 // Lay out the virtual bases and add the primary virtual base offsets.
1171 LayoutVirtualBases(RD, RD);
1172
1173 VisitedVirtualBases.clear();
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001174
1175 // Finally, round the size of the total struct up to the alignment of the
1176 // struct itself.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001177 FinishLayout(RD);
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001178
Anders Carlsson5b441d72010-04-10 21:24:48 +00001179#ifndef NDEBUG
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001180 // Check that we have base offsets for all bases.
1181 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1182 E = RD->bases_end(); I != E; ++I) {
1183 if (I->isVirtual())
1184 continue;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001185
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001186 const CXXRecordDecl *BaseDecl =
1187 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1188
1189 assert(Bases.count(BaseDecl) && "Did not find base offset!");
1190 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001191
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001192 // And all virtual bases.
1193 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
1194 E = RD->vbases_end(); I != E; ++I) {
1195 const CXXRecordDecl *BaseDecl =
1196 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001197
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001198 assert(VBases.count(BaseDecl) && "Did not find base offset!");
Anders Carlsson5b441d72010-04-10 21:24:48 +00001199 }
1200#endif
Anders Carlsson79474332009-07-18 20:20:21 +00001201}
1202
Anders Carlssonc2226202010-05-26 05:58:59 +00001203void RecordLayoutBuilder::Layout(const ObjCInterfaceDecl *D) {
Anders Carlsson4f516282009-07-18 20:50:59 +00001204 if (ObjCInterfaceDecl *SD = D->getSuperClass()) {
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001205 const ASTRecordLayout &SL = Context.getASTObjCInterfaceLayout(SD);
Anders Carlsson4f516282009-07-18 20:50:59 +00001206
Ken Dyck7ad11e72011-02-15 02:32:40 +00001207 UpdateAlignment(Context.toBits(SL.getAlignment()));
Mike Stump11289f42009-09-09 15:08:12 +00001208
Anders Carlsson4f516282009-07-18 20:50:59 +00001209 // We start laying out ivars not at the end of the superclass
1210 // structure, but at the next byte following the last field.
Ken Dyckd5090c12011-02-11 02:20:09 +00001211 Size = Context.toBits(SL.getDataSize());
Anders Carlsson47680d82009-09-26 01:34:51 +00001212 DataSize = Size;
Anders Carlsson4f516282009-07-18 20:50:59 +00001213 }
Mike Stump11289f42009-09-09 15:08:12 +00001214
Daniel Dunbar6da10982010-05-27 05:45:51 +00001215 InitializeLayout(D);
Daniel Dunbar40130442010-05-27 01:12:46 +00001216
Anders Carlsson4f516282009-07-18 20:50:59 +00001217 // Layout each ivar sequentially.
1218 llvm::SmallVector<ObjCIvarDecl*, 16> Ivars;
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001219 Context.ShallowCollectObjCIvars(D, Ivars);
Anders Carlsson4f516282009-07-18 20:50:59 +00001220 for (unsigned i = 0, e = Ivars.size(); i != e; ++i)
1221 LayoutField(Ivars[i]);
Mike Stump11289f42009-09-09 15:08:12 +00001222
Anders Carlsson4f516282009-07-18 20:50:59 +00001223 // Finally, round the size of the total struct up to the alignment of the
1224 // struct itself.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001225 FinishLayout(D);
Anders Carlsson4f516282009-07-18 20:50:59 +00001226}
1227
Anders Carlssonc2226202010-05-26 05:58:59 +00001228void RecordLayoutBuilder::LayoutFields(const RecordDecl *D) {
Anders Carlsson118ce162009-07-18 21:48:39 +00001229 // Layout each field, for now, just sequentially, respecting alignment. In
1230 // the future, this will need to be tweakable by targets.
Mike Stump11289f42009-09-09 15:08:12 +00001231 for (RecordDecl::field_iterator Field = D->field_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001232 FieldEnd = D->field_end(); Field != FieldEnd; ++Field)
Anders Carlsson118ce162009-07-18 21:48:39 +00001233 LayoutField(*Field);
1234}
1235
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001236void RecordLayoutBuilder::LayoutWideBitField(uint64_t FieldSize,
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001237 uint64_t TypeSize,
1238 bool FieldPacked,
1239 const FieldDecl *D) {
Anders Carlsson57235162010-04-16 15:57:11 +00001240 assert(Context.getLangOptions().CPlusPlus &&
1241 "Can only have wide bit-fields in C++!");
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001242
Anders Carlsson57235162010-04-16 15:57:11 +00001243 // Itanium C++ ABI 2.4:
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001244 // If sizeof(T)*8 < n, let T' be the largest integral POD type with
Anders Carlsson57235162010-04-16 15:57:11 +00001245 // sizeof(T')*8 <= n.
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001246
Anders Carlsson57235162010-04-16 15:57:11 +00001247 QualType IntegralPODTypes[] = {
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001248 Context.UnsignedCharTy, Context.UnsignedShortTy, Context.UnsignedIntTy,
Anders Carlsson57235162010-04-16 15:57:11 +00001249 Context.UnsignedLongTy, Context.UnsignedLongLongTy
1250 };
1251
Anders Carlsson57235162010-04-16 15:57:11 +00001252 QualType Type;
1253 for (unsigned I = 0, E = llvm::array_lengthof(IntegralPODTypes);
1254 I != E; ++I) {
1255 uint64_t Size = Context.getTypeSize(IntegralPODTypes[I]);
Anders Carlsson57235162010-04-16 15:57:11 +00001256
1257 if (Size > FieldSize)
1258 break;
1259
1260 Type = IntegralPODTypes[I];
1261 }
1262 assert(!Type.isNull() && "Did not find a type!");
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001263
Anders Carlsson57235162010-04-16 15:57:11 +00001264 unsigned TypeAlign = Context.getTypeAlign(Type);
1265
1266 // We're not going to use any of the unfilled bits in the last byte.
1267 UnfilledBitsInLastByte = 0;
1268
Anders Carlssonaad5fa82010-04-17 20:21:41 +00001269 uint64_t FieldOffset;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001270 uint64_t UnpaddedFieldOffset = DataSize - UnfilledBitsInLastByte;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001271
Anders Carlsson57235162010-04-16 15:57:11 +00001272 if (IsUnion) {
1273 DataSize = std::max(DataSize, FieldSize);
Anders Carlssonaad5fa82010-04-17 20:21:41 +00001274 FieldOffset = 0;
Anders Carlsson57235162010-04-16 15:57:11 +00001275 } else {
Anders Carlssonaad5fa82010-04-17 20:21:41 +00001276 // The bitfield is allocated starting at the next offset aligned appropriately
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001277 // for T', with length n bits.
Anders Carlssonaad5fa82010-04-17 20:21:41 +00001278 FieldOffset = llvm::RoundUpToAlignment(DataSize, TypeAlign);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001279
Anders Carlsson57235162010-04-16 15:57:11 +00001280 uint64_t NewSizeInBits = FieldOffset + FieldSize;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001281
Anders Carlsson57235162010-04-16 15:57:11 +00001282 DataSize = llvm::RoundUpToAlignment(NewSizeInBits, 8);
1283 UnfilledBitsInLastByte = DataSize - NewSizeInBits;
1284 }
1285
1286 // Place this field at the current location.
1287 FieldOffsets.push_back(FieldOffset);
1288
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001289 CheckFieldPadding(FieldOffset, UnpaddedFieldOffset, FieldOffset,
1290 TypeAlign, FieldPacked, D);
1291
Anders Carlsson57235162010-04-16 15:57:11 +00001292 // Update the size.
1293 Size = std::max(Size, DataSize);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001294
Anders Carlsson57235162010-04-16 15:57:11 +00001295 // Remember max struct/class alignment.
1296 UpdateAlignment(TypeAlign);
1297}
1298
Anders Carlssonc2226202010-05-26 05:58:59 +00001299void RecordLayoutBuilder::LayoutBitField(const FieldDecl *D) {
Anders Carlsson07209442009-11-22 17:37:31 +00001300 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001301 uint64_t UnpaddedFieldOffset = DataSize - UnfilledBitsInLastByte;
1302 uint64_t FieldOffset = IsUnion ? 0 : UnpaddedFieldOffset;
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001303 uint64_t FieldSize = D->getBitWidth()->EvaluateAsInt(Context).getZExtValue();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001304
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001305 std::pair<uint64_t, unsigned> FieldInfo = Context.getTypeInfo(D->getType());
Anders Carlsson07209442009-11-22 17:37:31 +00001306 uint64_t TypeSize = FieldInfo.first;
1307 unsigned FieldAlign = FieldInfo.second;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001308
Anders Carlsson57235162010-04-16 15:57:11 +00001309 if (FieldSize > TypeSize) {
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001310 LayoutWideBitField(FieldSize, TypeSize, FieldPacked, D);
Anders Carlsson57235162010-04-16 15:57:11 +00001311 return;
1312 }
1313
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001314 // The align if the field is not packed. This is to check if the attribute
1315 // was unnecessary (-Wpacked).
1316 unsigned UnpackedFieldAlign = FieldAlign;
1317 uint64_t UnpackedFieldOffset = FieldOffset;
1318 if (!Context.Target.useBitFieldTypeAlignment())
1319 UnpackedFieldAlign = 1;
1320
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001321 if (FieldPacked || !Context.Target.useBitFieldTypeAlignment())
Anders Carlsson07209442009-11-22 17:37:31 +00001322 FieldAlign = 1;
Alexis Huntdcfba7b2010-08-18 23:23:40 +00001323 FieldAlign = std::max(FieldAlign, D->getMaxAlignment());
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001324 UnpackedFieldAlign = std::max(UnpackedFieldAlign, D->getMaxAlignment());
Anders Carlsson07209442009-11-22 17:37:31 +00001325
1326 // The maximum field alignment overrides the aligned attribute.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001327 if (MaxFieldAlignment) {
Anders Carlsson07209442009-11-22 17:37:31 +00001328 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001329 UnpackedFieldAlign = std::min(UnpackedFieldAlign, MaxFieldAlignment);
1330 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001331
Daniel Dunbar3d9289c2010-04-15 06:18:39 +00001332 // Check if we need to add padding to give the field the correct alignment.
Anders Carlsson07209442009-11-22 17:37:31 +00001333 if (FieldSize == 0 || (FieldOffset & (FieldAlign-1)) + FieldSize > TypeSize)
Daniel Dunbarf35e7652010-06-29 18:34:35 +00001334 FieldOffset = llvm::RoundUpToAlignment(FieldOffset, FieldAlign);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001335
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001336 if (FieldSize == 0 ||
1337 (UnpackedFieldOffset & (UnpackedFieldAlign-1)) + FieldSize > TypeSize)
1338 UnpackedFieldOffset = llvm::RoundUpToAlignment(UnpackedFieldOffset,
1339 UnpackedFieldAlign);
1340
Daniel Dunbar3d9289c2010-04-15 06:18:39 +00001341 // Padding members don't affect overall alignment.
Anders Carlsson07209442009-11-22 17:37:31 +00001342 if (!D->getIdentifier())
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001343 FieldAlign = UnpackedFieldAlign = 1;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001344
Anders Carlsson07209442009-11-22 17:37:31 +00001345 // Place this field at the current location.
1346 FieldOffsets.push_back(FieldOffset);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001347
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001348 CheckFieldPadding(FieldOffset, UnpaddedFieldOffset, UnpackedFieldOffset,
1349 UnpackedFieldAlign, FieldPacked, D);
1350
Anders Carlssonba958402009-11-22 19:13:51 +00001351 // Update DataSize to include the last byte containing (part of) the bitfield.
1352 if (IsUnion) {
1353 // FIXME: I think FieldSize should be TypeSize here.
1354 DataSize = std::max(DataSize, FieldSize);
1355 } else {
1356 uint64_t NewSizeInBits = FieldOffset + FieldSize;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001357
Anders Carlssonba958402009-11-22 19:13:51 +00001358 DataSize = llvm::RoundUpToAlignment(NewSizeInBits, 8);
1359 UnfilledBitsInLastByte = DataSize - NewSizeInBits;
1360 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001361
Anders Carlssonba958402009-11-22 19:13:51 +00001362 // Update the size.
1363 Size = std::max(Size, DataSize);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001364
Anders Carlsson07209442009-11-22 17:37:31 +00001365 // Remember max struct/class alignment.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001366 UpdateAlignment(FieldAlign, UnpackedFieldAlign);
Anders Carlsson07209442009-11-22 17:37:31 +00001367}
1368
Anders Carlssonc2226202010-05-26 05:58:59 +00001369void RecordLayoutBuilder::LayoutField(const FieldDecl *D) {
Anders Carlsson07209442009-11-22 17:37:31 +00001370 if (D->isBitField()) {
1371 LayoutBitField(D);
1372 return;
1373 }
1374
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001375 uint64_t UnpaddedFieldOffset = DataSize - UnfilledBitsInLastByte;
1376
Anders Carlssonba958402009-11-22 19:13:51 +00001377 // Reset the unfilled bits.
1378 UnfilledBitsInLastByte = 0;
1379
Anders Carlsson07209442009-11-22 17:37:31 +00001380 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Anders Carlsson47680d82009-09-26 01:34:51 +00001381 uint64_t FieldOffset = IsUnion ? 0 : DataSize;
Anders Carlsson79474332009-07-18 20:20:21 +00001382 uint64_t FieldSize;
1383 unsigned FieldAlign;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001384
Anders Carlsson07209442009-11-22 17:37:31 +00001385 if (D->getType()->isIncompleteArrayType()) {
1386 // This is a flexible array member; we can't directly
1387 // query getTypeInfo about these, so we figure it out here.
1388 // Flexible array members don't have any size, but they
1389 // have to be aligned appropriately for their element type.
1390 FieldSize = 0;
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001391 const ArrayType* ATy = Context.getAsArrayType(D->getType());
1392 FieldAlign = Context.getTypeAlign(ATy->getElementType());
Anders Carlsson07209442009-11-22 17:37:31 +00001393 } else if (const ReferenceType *RT = D->getType()->getAs<ReferenceType>()) {
1394 unsigned AS = RT->getPointeeType().getAddressSpace();
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001395 FieldSize = Context.Target.getPointerWidth(AS);
1396 FieldAlign = Context.Target.getPointerAlign(AS);
Anders Carlsson79474332009-07-18 20:20:21 +00001397 } else {
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001398 std::pair<uint64_t, unsigned> FieldInfo = Context.getTypeInfo(D->getType());
Anders Carlsson07209442009-11-22 17:37:31 +00001399 FieldSize = FieldInfo.first;
1400 FieldAlign = FieldInfo.second;
Douglas Gregordbe39272011-02-01 15:15:22 +00001401
1402 if (Context.getLangOptions().MSBitfields) {
1403 // If MS bitfield layout is required, figure out what type is being
1404 // laid out and align the field to the width of that type.
1405
1406 // Resolve all typedefs down to their base type and round up the field
1407 // alignment if necessary.
1408 QualType T = Context.getBaseElementType(D->getType());
1409 if (const BuiltinType *BTy = T->getAs<BuiltinType>()) {
1410 uint64_t TypeSize = Context.getTypeSize(BTy);
1411 if (TypeSize > FieldAlign)
1412 FieldAlign = TypeSize;
1413 }
1414 }
Anders Carlsson79474332009-07-18 20:20:21 +00001415 }
Mike Stump11289f42009-09-09 15:08:12 +00001416
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001417 // The align if the field is not packed. This is to check if the attribute
1418 // was unnecessary (-Wpacked).
1419 unsigned UnpackedFieldAlign = FieldAlign;
1420 uint64_t UnpackedFieldOffset = FieldOffset;
1421
Anders Carlsson07209442009-11-22 17:37:31 +00001422 if (FieldPacked)
1423 FieldAlign = 8;
Alexis Huntdcfba7b2010-08-18 23:23:40 +00001424 FieldAlign = std::max(FieldAlign, D->getMaxAlignment());
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001425 UnpackedFieldAlign = std::max(UnpackedFieldAlign, D->getMaxAlignment());
Anders Carlsson07209442009-11-22 17:37:31 +00001426
1427 // The maximum field alignment overrides the aligned attribute.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001428 if (MaxFieldAlignment) {
Anders Carlsson07209442009-11-22 17:37:31 +00001429 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001430 UnpackedFieldAlign = std::min(UnpackedFieldAlign, MaxFieldAlignment);
1431 }
Anders Carlsson07209442009-11-22 17:37:31 +00001432
1433 // Round up the current record size to the field's alignment boundary.
1434 FieldOffset = llvm::RoundUpToAlignment(FieldOffset, FieldAlign);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001435 UnpackedFieldOffset = llvm::RoundUpToAlignment(UnpackedFieldOffset,
1436 UnpackedFieldAlign);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001437
Anders Carlssonb1fcdd02010-05-30 06:52:33 +00001438 if (!IsUnion && EmptySubobjects) {
1439 // Check if we can place the field at this offset.
Anders Carlsson28466ab2010-10-31 22:13:23 +00001440 while (!EmptySubobjects->CanPlaceFieldAtOffset(D,
Ken Dyck7c4026b2011-01-24 01:28:50 +00001441 Context.toCharUnitsFromBits(FieldOffset))) {
Anders Carlsson07209442009-11-22 17:37:31 +00001442 // We couldn't place the field at the offset. Try again at a new offset.
1443 FieldOffset += FieldAlign;
1444 }
Anders Carlsson07209442009-11-22 17:37:31 +00001445 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001446
Anders Carlsson79474332009-07-18 20:20:21 +00001447 // Place this field at the current location.
1448 FieldOffsets.push_back(FieldOffset);
Mike Stump11289f42009-09-09 15:08:12 +00001449
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001450 CheckFieldPadding(FieldOffset, UnpaddedFieldOffset, UnpackedFieldOffset,
1451 UnpackedFieldAlign, FieldPacked, D);
1452
Anders Carlsson79474332009-07-18 20:20:21 +00001453 // Reserve space for this field.
1454 if (IsUnion)
1455 Size = std::max(Size, FieldSize);
1456 else
1457 Size = FieldOffset + FieldSize;
Mike Stump11289f42009-09-09 15:08:12 +00001458
Anders Carlsson47680d82009-09-26 01:34:51 +00001459 // Update the data size.
1460 DataSize = Size;
Mike Stump11289f42009-09-09 15:08:12 +00001461
Anders Carlsson79474332009-07-18 20:20:21 +00001462 // Remember max struct/class alignment.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001463 UpdateAlignment(FieldAlign, UnpackedFieldAlign);
Anders Carlsson79474332009-07-18 20:20:21 +00001464}
1465
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001466void RecordLayoutBuilder::FinishLayout(const NamedDecl *D) {
Anders Carlsson79474332009-07-18 20:20:21 +00001467 // In C++, records cannot be of size 0.
Fariborz Jahanian09b23312011-02-02 19:36:18 +00001468 if (Context.getLangOptions().CPlusPlus && Size == 0) {
1469 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
1470 // Compatibility with gcc requires a class (pod or non-pod)
1471 // which is not empty but of size 0; such as having fields of
1472 // array of zero-length, remains of Size 0
1473 if (RD->isEmpty())
1474 Size = 8;
1475 }
1476 else
1477 Size = 8;
1478 }
Anders Carlsson79474332009-07-18 20:20:21 +00001479 // Finally, round the size of the record up to the alignment of the
1480 // record itself.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001481 uint64_t UnpaddedSize = Size - UnfilledBitsInLastByte;
1482 uint64_t UnpackedSize = llvm::RoundUpToAlignment(Size, UnpackedAlignment);
Anders Carlsson07209442009-11-22 17:37:31 +00001483 Size = llvm::RoundUpToAlignment(Size, Alignment);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001484
1485 unsigned CharBitNum = Context.Target.getCharWidth();
1486 if (const RecordDecl *RD = dyn_cast<RecordDecl>(D)) {
1487 // Warn if padding was introduced to the struct/class/union.
1488 if (Size > UnpaddedSize) {
1489 unsigned PadSize = Size - UnpaddedSize;
1490 bool InBits = true;
1491 if (PadSize % CharBitNum == 0) {
1492 PadSize = PadSize / CharBitNum;
1493 InBits = false;
1494 }
1495 Diag(RD->getLocation(), diag::warn_padded_struct_size)
1496 << Context.getTypeDeclType(RD)
1497 << PadSize
1498 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1); // plural or not
1499 }
1500
1501 // Warn if we packed it unnecessarily. If the alignment is 1 byte don't
1502 // bother since there won't be alignment issues.
1503 if (Packed && UnpackedAlignment > CharBitNum && Size == UnpackedSize)
1504 Diag(D->getLocation(), diag::warn_unnecessary_packed)
1505 << Context.getTypeDeclType(RD);
1506 }
Anders Carlsson79474332009-07-18 20:20:21 +00001507}
1508
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001509void RecordLayoutBuilder::UpdateAlignment(unsigned NewAlignment,
1510 unsigned UnpackedNewAlignment) {
Daniel Dunbar6da10982010-05-27 05:45:51 +00001511 // The alignment is not modified when using 'mac68k' alignment.
1512 if (IsMac68kAlign)
1513 return;
1514
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001515 if (NewAlignment > Alignment) {
1516 assert(llvm::isPowerOf2_32(NewAlignment && "Alignment not a power of 2"));
1517 Alignment = NewAlignment;
1518 }
1519
1520 if (UnpackedNewAlignment > UnpackedAlignment) {
1521 assert(llvm::isPowerOf2_32(UnpackedNewAlignment &&
1522 "Alignment not a power of 2"));
1523 UnpackedAlignment = UnpackedNewAlignment;
1524 }
1525}
1526
1527void RecordLayoutBuilder::CheckFieldPadding(uint64_t Offset,
1528 uint64_t UnpaddedOffset,
1529 uint64_t UnpackedOffset,
1530 unsigned UnpackedAlign,
1531 bool isPacked,
1532 const FieldDecl *D) {
1533 // We let objc ivars without warning, objc interfaces generally are not used
1534 // for padding tricks.
1535 if (isa<ObjCIvarDecl>(D))
Anders Carlsson79474332009-07-18 20:20:21 +00001536 return;
Mike Stump11289f42009-09-09 15:08:12 +00001537
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001538 unsigned CharBitNum = Context.Target.getCharWidth();
Mike Stump11289f42009-09-09 15:08:12 +00001539
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001540 // Warn if padding was introduced to the struct/class.
1541 if (!IsUnion && Offset > UnpaddedOffset) {
1542 unsigned PadSize = Offset - UnpaddedOffset;
1543 bool InBits = true;
1544 if (PadSize % CharBitNum == 0) {
1545 PadSize = PadSize / CharBitNum;
1546 InBits = false;
1547 }
1548 if (D->getIdentifier())
1549 Diag(D->getLocation(), diag::warn_padded_struct_field)
1550 << (D->getParent()->isStruct() ? 0 : 1) // struct|class
1551 << Context.getTypeDeclType(D->getParent())
1552 << PadSize
1553 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1) // plural or not
1554 << D->getIdentifier();
1555 else
1556 Diag(D->getLocation(), diag::warn_padded_struct_anon_field)
1557 << (D->getParent()->isStruct() ? 0 : 1) // struct|class
1558 << Context.getTypeDeclType(D->getParent())
1559 << PadSize
1560 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1); // plural or not
1561 }
1562
1563 // Warn if we packed it unnecessarily. If the alignment is 1 byte don't
1564 // bother since there won't be alignment issues.
1565 if (isPacked && UnpackedAlign > CharBitNum && Offset == UnpackedOffset)
1566 Diag(D->getLocation(), diag::warn_unnecessary_packed)
1567 << D->getIdentifier();
Anders Carlsson79474332009-07-18 20:20:21 +00001568}
Mike Stump11289f42009-09-09 15:08:12 +00001569
Anders Carlsson5ebf8b42009-12-07 04:35:11 +00001570const CXXMethodDecl *
Anders Carlssonc2226202010-05-26 05:58:59 +00001571RecordLayoutBuilder::ComputeKeyFunction(const CXXRecordDecl *RD) {
Daniel Dunbarccabe482010-04-19 20:44:53 +00001572 // If a class isn't polymorphic it doesn't have a key function.
Anders Carlsson5ebf8b42009-12-07 04:35:11 +00001573 if (!RD->isPolymorphic())
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001574 return 0;
Eli Friedmanf2c79b62009-12-08 03:56:49 +00001575
1576 // A class inside an anonymous namespace doesn't have a key function. (Or
1577 // at least, there's no point to assigning a key function to such a class;
1578 // this doesn't affect the ABI.)
1579 if (RD->isInAnonymousNamespace())
1580 return 0;
1581
Argyrios Kyrtzidis8c64bbe2010-10-13 02:39:41 +00001582 // Template instantiations don't have key functions,see Itanium C++ ABI 5.2.6.
1583 // Same behavior as GCC.
1584 TemplateSpecializationKind TSK = RD->getTemplateSpecializationKind();
1585 if (TSK == TSK_ImplicitInstantiation ||
1586 TSK == TSK_ExplicitInstantiationDefinition)
1587 return 0;
1588
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001589 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
1590 E = RD->method_end(); I != E; ++I) {
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001591 const CXXMethodDecl *MD = *I;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001592
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001593 if (!MD->isVirtual())
1594 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001595
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001596 if (MD->isPure())
1597 continue;
Eli Friedmanf2c79b62009-12-08 03:56:49 +00001598
Anders Carlssonf98849e2009-12-02 17:15:43 +00001599 // Ignore implicit member functions, they are always marked as inline, but
1600 // they don't have a body until they're defined.
1601 if (MD->isImplicit())
1602 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001603
Douglas Gregora318efd2010-01-05 19:06:31 +00001604 if (MD->isInlineSpecified())
1605 continue;
Eli Friedman71a26d82009-12-06 20:50:05 +00001606
1607 if (MD->hasInlineBody())
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001608 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001609
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001610 // We found it.
1611 return MD;
1612 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001613
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001614 return 0;
1615}
1616
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001617DiagnosticBuilder
1618RecordLayoutBuilder::Diag(SourceLocation Loc, unsigned DiagID) {
Argyrios Kyrtzidisd0040642010-11-18 20:06:41 +00001619 return Context.getDiagnostics().Report(Loc, DiagID);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001620}
1621
Benjamin Kramer2fc373e2010-10-22 16:33:16 +00001622namespace {
1623 // This class implements layout specific to the Microsoft ABI.
1624 class MSRecordLayoutBuilder : public RecordLayoutBuilder {
1625 public:
Jay Foad39c79802011-01-12 09:06:06 +00001626 MSRecordLayoutBuilder(const ASTContext& Ctx,
1627 EmptySubobjectMap *EmptySubobjects) :
Benjamin Kramer2fc373e2010-10-22 16:33:16 +00001628 RecordLayoutBuilder(Ctx, EmptySubobjects) {}
Charles Davisc2c576a2010-08-19 00:55:19 +00001629
Benjamin Kramer2fc373e2010-10-22 16:33:16 +00001630 virtual uint64_t GetVirtualPointersSize(const CXXRecordDecl *RD) const;
1631 };
1632}
Charles Davisc2c576a2010-08-19 00:55:19 +00001633
Charles Davisc2c576a2010-08-19 00:55:19 +00001634uint64_t
1635MSRecordLayoutBuilder::GetVirtualPointersSize(const CXXRecordDecl *RD) const {
1636 // We should reserve space for two pointers if the class has both
1637 // virtual functions and virtual bases.
1638 if (RD->isPolymorphic() && RD->getNumVBases() > 0)
1639 return 2 * Context.Target.getPointerWidth(0);
1640 return Context.Target.getPointerWidth(0);
1641}
1642
Anders Carlssondf291d82010-05-26 04:56:53 +00001643/// getASTRecordLayout - Get or compute information about the layout of the
1644/// specified record (struct/union/class), which indicates its size and field
1645/// position information.
Jay Foad39c79802011-01-12 09:06:06 +00001646const ASTRecordLayout &
1647ASTContext::getASTRecordLayout(const RecordDecl *D) const {
Anders Carlssondf291d82010-05-26 04:56:53 +00001648 D = D->getDefinition();
1649 assert(D && "Cannot get layout of forward declarations!");
1650
1651 // Look up this layout, if already laid out, return what we have.
1652 // Note that we can't save a reference to the entry because this function
1653 // is recursive.
1654 const ASTRecordLayout *Entry = ASTRecordLayouts[D];
1655 if (Entry) return *Entry;
1656
Anders Carlssond2954862010-05-26 05:10:47 +00001657 const ASTRecordLayout *NewEntry;
1658
1659 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
Anders Carlssonc121b4e2010-05-27 00:07:01 +00001660 EmptySubobjectMap EmptySubobjects(*this, RD);
Anders Carlsson439edd12010-05-27 05:41:06 +00001661
Charles Davisc2c576a2010-08-19 00:55:19 +00001662 // When compiling for Microsoft, use the special MS builder.
Argyrios Kyrtzidis3c6cd172010-08-25 00:32:14 +00001663 llvm::OwningPtr<RecordLayoutBuilder> Builder;
Charles Davis6bcb07a2010-08-19 02:18:14 +00001664 switch (Target.getCXXABI()) {
1665 default:
Argyrios Kyrtzidis3c6cd172010-08-25 00:32:14 +00001666 Builder.reset(new RecordLayoutBuilder(*this, &EmptySubobjects));
Charles Davis6bcb07a2010-08-19 02:18:14 +00001667 break;
1668 case CXXABI_Microsoft:
Argyrios Kyrtzidis3c6cd172010-08-25 00:32:14 +00001669 Builder.reset(new MSRecordLayoutBuilder(*this, &EmptySubobjects));
Charles Davis6bcb07a2010-08-19 02:18:14 +00001670 }
Charles Davisc2c576a2010-08-19 00:55:19 +00001671 Builder->Layout(RD);
Anders Carlssond2954862010-05-26 05:10:47 +00001672
1673 // FIXME: This is not always correct. See the part about bitfields at
1674 // http://www.codesourcery.com/public/cxx-abi/abi.html#POD for more info.
1675 // FIXME: IsPODForThePurposeOfLayout should be stored in the record layout.
1676 bool IsPODForThePurposeOfLayout = cast<CXXRecordDecl>(D)->isPOD();
1677
1678 // FIXME: This should be done in FinalizeLayout.
1679 uint64_t DataSize =
Charles Davisc2c576a2010-08-19 00:55:19 +00001680 IsPODForThePurposeOfLayout ? Builder->Size : Builder->DataSize;
Ken Dyckaf1c83f2011-02-16 01:52:01 +00001681 CharUnits NonVirtualSize =
1682 IsPODForThePurposeOfLayout ?
1683 toCharUnitsFromBits(DataSize) : Builder->NonVirtualSize;
Anders Carlssond2954862010-05-26 05:10:47 +00001684
Ken Dyckc8ae5502011-02-09 01:59:34 +00001685 CharUnits RecordSize = toCharUnitsFromBits(Builder->Size);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001686 NewEntry =
Ken Dyck7ad11e72011-02-15 02:32:40 +00001687 new (*this) ASTRecordLayout(*this, RecordSize,
1688 toCharUnitsFromBits(Builder->Alignment),
Ken Dyckd5090c12011-02-11 02:20:09 +00001689 toCharUnitsFromBits(DataSize),
1690 Builder->FieldOffsets.data(),
Charles Davisc2c576a2010-08-19 00:55:19 +00001691 Builder->FieldOffsets.size(),
Ken Dyckaf1c83f2011-02-16 01:52:01 +00001692 NonVirtualSize,
Ken Dycka2d3dda2011-02-16 01:43:15 +00001693 Builder->NonVirtualAlignment,
Anders Carlssonc121b4e2010-05-27 00:07:01 +00001694 EmptySubobjects.SizeOfLargestEmptySubobject,
Charles Davisc2c576a2010-08-19 00:55:19 +00001695 Builder->PrimaryBase,
1696 Builder->PrimaryBaseIsVirtual,
1697 Builder->Bases, Builder->VBases);
Anders Carlssond2954862010-05-26 05:10:47 +00001698 } else {
Anders Carlssonc121b4e2010-05-27 00:07:01 +00001699 RecordLayoutBuilder Builder(*this, /*EmptySubobjects=*/0);
Anders Carlssond2954862010-05-26 05:10:47 +00001700 Builder.Layout(D);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001701
Ken Dyckc8ae5502011-02-09 01:59:34 +00001702 CharUnits RecordSize = toCharUnitsFromBits(Builder.Size);
1703
Anders Carlssond2954862010-05-26 05:10:47 +00001704 NewEntry =
Ken Dyck7ad11e72011-02-15 02:32:40 +00001705 new (*this) ASTRecordLayout(*this, RecordSize,
1706 toCharUnitsFromBits(Builder.Alignment),
Ken Dyckd5090c12011-02-11 02:20:09 +00001707 toCharUnitsFromBits(Builder.Size),
Anders Carlssond2954862010-05-26 05:10:47 +00001708 Builder.FieldOffsets.data(),
1709 Builder.FieldOffsets.size());
1710 }
1711
Anders Carlssondf291d82010-05-26 04:56:53 +00001712 ASTRecordLayouts[D] = NewEntry;
1713
1714 if (getLangOptions().DumpRecordLayouts) {
1715 llvm::errs() << "\n*** Dumping AST Record Layout\n";
1716 DumpRecordLayout(D, llvm::errs());
1717 }
1718
1719 return *NewEntry;
1720}
1721
1722const CXXMethodDecl *ASTContext::getKeyFunction(const CXXRecordDecl *RD) {
1723 RD = cast<CXXRecordDecl>(RD->getDefinition());
1724 assert(RD && "Cannot get key function for forward declarations!");
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001725
Anders Carlssondf291d82010-05-26 04:56:53 +00001726 const CXXMethodDecl *&Entry = KeyFunctions[RD];
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001727 if (!Entry)
Anders Carlssonc2226202010-05-26 05:58:59 +00001728 Entry = RecordLayoutBuilder::ComputeKeyFunction(RD);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001729
Anders Carlssondf291d82010-05-26 04:56:53 +00001730 return Entry;
1731}
1732
1733/// getInterfaceLayoutImpl - Get or compute information about the
1734/// layout of the given interface.
1735///
1736/// \param Impl - If given, also include the layout of the interface's
1737/// implementation. This may differ by including synthesized ivars.
1738const ASTRecordLayout &
1739ASTContext::getObjCLayout(const ObjCInterfaceDecl *D,
Jay Foad39c79802011-01-12 09:06:06 +00001740 const ObjCImplementationDecl *Impl) const {
Anders Carlssondf291d82010-05-26 04:56:53 +00001741 assert(!D->isForwardDecl() && "Invalid interface decl!");
1742
1743 // Look up this layout, if already laid out, return what we have.
1744 ObjCContainerDecl *Key =
1745 Impl ? (ObjCContainerDecl*) Impl : (ObjCContainerDecl*) D;
1746 if (const ASTRecordLayout *Entry = ObjCLayouts[Key])
1747 return *Entry;
1748
1749 // Add in synthesized ivar count if laying out an implementation.
1750 if (Impl) {
1751 unsigned SynthCount = CountNonClassIvars(D);
1752 // If there aren't any sythesized ivars then reuse the interface
1753 // entry. Note we can't cache this because we simply free all
1754 // entries later; however we shouldn't look up implementations
1755 // frequently.
1756 if (SynthCount == 0)
1757 return getObjCLayout(D, 0);
1758 }
1759
Anders Carlssonc121b4e2010-05-27 00:07:01 +00001760 RecordLayoutBuilder Builder(*this, /*EmptySubobjects=*/0);
Anders Carlsson6ed3a9a2010-05-26 05:04:25 +00001761 Builder.Layout(D);
1762
Ken Dyckc8ae5502011-02-09 01:59:34 +00001763 CharUnits RecordSize = toCharUnitsFromBits(Builder.Size);
1764
Anders Carlssondf291d82010-05-26 04:56:53 +00001765 const ASTRecordLayout *NewEntry =
Ken Dyck7ad11e72011-02-15 02:32:40 +00001766 new (*this) ASTRecordLayout(*this, RecordSize,
1767 toCharUnitsFromBits(Builder.Alignment),
Ken Dyckd5090c12011-02-11 02:20:09 +00001768 toCharUnitsFromBits(Builder.DataSize),
Anders Carlsson6ed3a9a2010-05-26 05:04:25 +00001769 Builder.FieldOffsets.data(),
1770 Builder.FieldOffsets.size());
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001771
Anders Carlssondf291d82010-05-26 04:56:53 +00001772 ObjCLayouts[Key] = NewEntry;
1773
1774 return *NewEntry;
1775}
1776
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001777static void PrintOffset(llvm::raw_ostream &OS,
Anders Carlsson3f018712010-10-31 23:45:59 +00001778 CharUnits Offset, unsigned IndentLevel) {
1779 OS << llvm::format("%4d | ", Offset.getQuantity());
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001780 OS.indent(IndentLevel * 2);
1781}
1782
1783static void DumpCXXRecordLayout(llvm::raw_ostream &OS,
Jay Foad39c79802011-01-12 09:06:06 +00001784 const CXXRecordDecl *RD, const ASTContext &C,
Anders Carlsson3f018712010-10-31 23:45:59 +00001785 CharUnits Offset,
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001786 unsigned IndentLevel,
1787 const char* Description,
1788 bool IncludeVirtualBases) {
Anders Carlsson3f018712010-10-31 23:45:59 +00001789 const ASTRecordLayout &Layout = C.getASTRecordLayout(RD);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001790
1791 PrintOffset(OS, Offset, IndentLevel);
Dan Gohman145f3f12010-04-19 16:39:44 +00001792 OS << C.getTypeDeclType(const_cast<CXXRecordDecl *>(RD)).getAsString();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001793 if (Description)
1794 OS << ' ' << Description;
1795 if (RD->isEmpty())
1796 OS << " (empty)";
1797 OS << '\n';
1798
1799 IndentLevel++;
1800
Anders Carlsson3f018712010-10-31 23:45:59 +00001801 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001802
1803 // Vtable pointer.
1804 if (RD->isDynamicClass() && !PrimaryBase) {
1805 PrintOffset(OS, Offset, IndentLevel);
Benjamin Kramerb11416d2010-04-17 09:33:03 +00001806 OS << '(' << RD << " vtable pointer)\n";
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001807 }
1808 // Dump (non-virtual) bases
1809 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1810 E = RD->bases_end(); I != E; ++I) {
1811 assert(!I->getType()->isDependentType() &&
1812 "Cannot layout class with dependent bases.");
1813 if (I->isVirtual())
1814 continue;
1815
1816 const CXXRecordDecl *Base =
1817 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1818
Anders Carlsson3f018712010-10-31 23:45:59 +00001819 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001820
1821 DumpCXXRecordLayout(OS, Base, C, BaseOffset, IndentLevel,
1822 Base == PrimaryBase ? "(primary base)" : "(base)",
1823 /*IncludeVirtualBases=*/false);
1824 }
1825
1826 // Dump fields.
1827 uint64_t FieldNo = 0;
1828 for (CXXRecordDecl::field_iterator I = RD->field_begin(),
1829 E = RD->field_end(); I != E; ++I, ++FieldNo) {
1830 const FieldDecl *Field = *I;
Anders Carlsson3f018712010-10-31 23:45:59 +00001831 CharUnits FieldOffset = Offset +
Ken Dyck86a7fcc2011-01-18 01:56:16 +00001832 C.toCharUnitsFromBits(Layout.getFieldOffset(FieldNo));
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001833
1834 if (const RecordType *RT = Field->getType()->getAs<RecordType>()) {
1835 if (const CXXRecordDecl *D = dyn_cast<CXXRecordDecl>(RT->getDecl())) {
1836 DumpCXXRecordLayout(OS, D, C, FieldOffset, IndentLevel,
Daniel Dunbar56df9772010-08-17 22:39:59 +00001837 Field->getName().data(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001838 /*IncludeVirtualBases=*/true);
1839 continue;
1840 }
1841 }
1842
1843 PrintOffset(OS, FieldOffset, IndentLevel);
Benjamin Kramerb11416d2010-04-17 09:33:03 +00001844 OS << Field->getType().getAsString() << ' ' << Field << '\n';
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001845 }
1846
1847 if (!IncludeVirtualBases)
1848 return;
1849
1850 // Dump virtual bases.
1851 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
1852 E = RD->vbases_end(); I != E; ++I) {
1853 assert(I->isVirtual() && "Found non-virtual class!");
1854 const CXXRecordDecl *VBase =
1855 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1856
Anders Carlsson3f018712010-10-31 23:45:59 +00001857 CharUnits VBaseOffset = Offset + Layout.getVBaseClassOffset(VBase);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001858 DumpCXXRecordLayout(OS, VBase, C, VBaseOffset, IndentLevel,
1859 VBase == PrimaryBase ?
1860 "(primary virtual base)" : "(virtual base)",
1861 /*IncludeVirtualBases=*/false);
1862 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001863
Ken Dyckc8ae5502011-02-09 01:59:34 +00001864 OS << " sizeof=" << Layout.getSize().getQuantity();
Ken Dyckd5090c12011-02-11 02:20:09 +00001865 OS << ", dsize=" << Layout.getDataSize().getQuantity();
Ken Dyck7ad11e72011-02-15 02:32:40 +00001866 OS << ", align=" << Layout.getAlignment().getQuantity() << '\n';
Ken Dyck316d6f62011-02-01 01:52:10 +00001867 OS << " nvsize=" << Layout.getNonVirtualSize().getQuantity();
Ken Dyckbec02852011-02-08 02:02:47 +00001868 OS << ", nvalign=" << Layout.getNonVirtualAlign().getQuantity() << '\n';
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001869 OS << '\n';
1870}
Daniel Dunbarccabe482010-04-19 20:44:53 +00001871
1872void ASTContext::DumpRecordLayout(const RecordDecl *RD,
Jay Foad39c79802011-01-12 09:06:06 +00001873 llvm::raw_ostream &OS) const {
Daniel Dunbarccabe482010-04-19 20:44:53 +00001874 const ASTRecordLayout &Info = getASTRecordLayout(RD);
1875
1876 if (const CXXRecordDecl *CXXRD = dyn_cast<CXXRecordDecl>(RD))
Anders Carlsson3f018712010-10-31 23:45:59 +00001877 return DumpCXXRecordLayout(OS, CXXRD, *this, CharUnits(), 0, 0,
Daniel Dunbarccabe482010-04-19 20:44:53 +00001878 /*IncludeVirtualBases=*/true);
1879
1880 OS << "Type: " << getTypeDeclType(RD).getAsString() << "\n";
1881 OS << "Record: ";
1882 RD->dump();
1883 OS << "\nLayout: ";
1884 OS << "<ASTRecordLayout\n";
Ken Dyckb0fcc592011-02-11 01:54:29 +00001885 OS << " Size:" << toBits(Info.getSize()) << "\n";
Ken Dyckd5090c12011-02-11 02:20:09 +00001886 OS << " DataSize:" << toBits(Info.getDataSize()) << "\n";
Ken Dyck7ad11e72011-02-15 02:32:40 +00001887 OS << " Alignment:" << toBits(Info.getAlignment()) << "\n";
Daniel Dunbarccabe482010-04-19 20:44:53 +00001888 OS << " FieldOffsets: [";
1889 for (unsigned i = 0, e = Info.getFieldCount(); i != e; ++i) {
1890 if (i) OS << ", ";
1891 OS << Info.getFieldOffset(i);
1892 }
1893 OS << "]>\n";
1894}