blob: 75228a2b7b625347c1c5ec6d6da69bfd97d374c6 [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"
Ted Kremenekf75d0892011-03-19 01:00:36 +000022#include "llvm/Support/CrashRecoveryContext.h"
Anders Carlsson79474332009-07-18 20:20:21 +000023
24using namespace clang;
25
Benjamin Kramerc7656cd2010-05-26 09:58:31 +000026namespace {
Anders Carlssonf58de112010-05-26 15:32:58 +000027
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000028/// BaseSubobjectInfo - Represents a single base subobject in a complete class.
29/// For a class hierarchy like
30///
31/// class A { };
32/// class B : A { };
33/// class C : A, B { };
34///
35/// The BaseSubobjectInfo graph for C will have three BaseSubobjectInfo
36/// instances, one for B and two for A.
37///
38/// If a base is virtual, it will only have one BaseSubobjectInfo allocated.
39struct BaseSubobjectInfo {
40 /// Class - The class for this base info.
Anders Carlsson056818f2010-05-28 21:13:31 +000041 const CXXRecordDecl *Class;
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000042
43 /// IsVirtual - Whether the BaseInfo represents a virtual base or not.
Anders Carlsson056818f2010-05-28 21:13:31 +000044 bool IsVirtual;
45
Anders Carlssona7f3cdb2010-05-28 21:24:37 +000046 /// Bases - Information about the base subobjects.
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.
Ken Dyck4731d5b2011-02-16 02:05:21 +0000554 CharUnits 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.
Ken Dyck1300b3b2011-02-16 02:11:31 +0000557 CharUnits UnpackedAlignment;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000558
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.
Ken Dyck02ced6f2011-02-17 01:49:42 +0000575 CharUnits 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)
Ken Dyck4731d5b2011-02-16 02:05:21 +0000613 : Context(Context), EmptySubobjects(EmptySubobjects), Size(0),
Ken Dyck1300b3b2011-02-16 02:11:31 +0000614 Alignment(CharUnits::One()), UnpackedAlignment(Alignment),
Ken Dyck4731d5b2011-02-16 02:05:21 +0000615 Packed(false), IsUnion(false), IsMac68kAlign(false),
Ken Dyck02ced6f2011-02-17 01:49:42 +0000616 UnfilledBitsInLastByte(0), MaxFieldAlignment(CharUnits::Zero()),
617 DataSize(0), NonVirtualSize(CharUnits::Zero()),
618 NonVirtualAlignment(CharUnits::One()), PrimaryBase(0),
619 PrimaryBaseIsVirtual(false), FirstNearlyEmptyVBase(0) { }
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000620
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000621 void Layout(const RecordDecl *D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000622 void Layout(const CXXRecordDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000623 void Layout(const ObjCInterfaceDecl *D);
624
625 void LayoutFields(const RecordDecl *D);
626 void LayoutField(const FieldDecl *D);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000627 void LayoutWideBitField(uint64_t FieldSize, uint64_t TypeSize,
628 bool FieldPacked, const FieldDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000629 void LayoutBitField(const FieldDecl *D);
630
Anders Carlssone3c24c72010-05-29 17:35:14 +0000631 /// BaseSubobjectInfoAllocator - Allocator for BaseSubobjectInfo objects.
632 llvm::SpecificBumpPtrAllocator<BaseSubobjectInfo> BaseSubobjectInfoAllocator;
633
634 typedef llvm::DenseMap<const CXXRecordDecl *, BaseSubobjectInfo *>
635 BaseSubobjectInfoMapTy;
636
637 /// VirtualBaseInfo - Map from all the (direct or indirect) virtual bases
638 /// of the class we're laying out to their base subobject info.
639 BaseSubobjectInfoMapTy VirtualBaseInfo;
640
641 /// NonVirtualBaseInfo - Map from all the direct non-virtual bases of the
642 /// class we're laying out to their base subobject info.
643 BaseSubobjectInfoMapTy NonVirtualBaseInfo;
644
645 /// ComputeBaseSubobjectInfo - Compute the base subobject information for the
646 /// bases of the given class.
647 void ComputeBaseSubobjectInfo(const CXXRecordDecl *RD);
648
649 /// ComputeBaseSubobjectInfo - Compute the base subobject information for a
650 /// single class and all of its base classes.
651 BaseSubobjectInfo *ComputeBaseSubobjectInfo(const CXXRecordDecl *RD,
652 bool IsVirtual,
653 BaseSubobjectInfo *Derived);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000654
655 /// DeterminePrimaryBase - Determine the primary base of the given class.
656 void DeterminePrimaryBase(const CXXRecordDecl *RD);
657
658 void SelectPrimaryVBase(const CXXRecordDecl *RD);
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000659
Ken Dyckaab635e2011-03-01 01:22:45 +0000660 virtual CharUnits GetVirtualPointersSize(const CXXRecordDecl *RD) const;
Charles Davisc2c576a2010-08-19 00:55:19 +0000661
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000662 /// LayoutNonVirtualBases - Determines the primary base class (if any) and
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000663 /// lays it out. Will then proceed to lay out all non-virtual base clasess.
664 void LayoutNonVirtualBases(const CXXRecordDecl *RD);
665
666 /// LayoutNonVirtualBase - Lays out a single non-virtual base.
Anders Carlssonbb0e6782010-05-29 17:42:25 +0000667 void LayoutNonVirtualBase(const BaseSubobjectInfo *Base);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000668
Anders Carlssona2f8e412010-10-31 22:20:42 +0000669 void AddPrimaryVirtualBaseOffsets(const BaseSubobjectInfo *Info,
670 CharUnits Offset);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000671
672 /// LayoutVirtualBases - Lays out all the virtual bases.
673 void LayoutVirtualBases(const CXXRecordDecl *RD,
674 const CXXRecordDecl *MostDerivedClass);
675
676 /// LayoutVirtualBase - Lays out a single virtual base.
Anders Carlssond6ff5d72010-05-29 17:48:36 +0000677 void LayoutVirtualBase(const BaseSubobjectInfo *Base);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000678
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000679 /// LayoutBase - Will lay out a base and return the offset where it was
Anders Carlssona2f8e412010-10-31 22:20:42 +0000680 /// placed, in chars.
681 CharUnits LayoutBase(const BaseSubobjectInfo *Base);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000682
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000683 /// InitializeLayout - Initialize record layout for the given record decl.
Daniel Dunbar6da10982010-05-27 05:45:51 +0000684 void InitializeLayout(const Decl *D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000685
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000686 /// FinishLayout - Finalize record layout. Adjust record size based on the
687 /// alignment.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000688 void FinishLayout(const NamedDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000689
Ken Dyck85ef0432011-02-19 18:58:07 +0000690 void UpdateAlignment(CharUnits NewAlignment, CharUnits UnpackedNewAlignment);
691 void UpdateAlignment(CharUnits NewAlignment) {
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000692 UpdateAlignment(NewAlignment, NewAlignment);
693 }
694
695 void CheckFieldPadding(uint64_t Offset, uint64_t UnpaddedOffset,
696 uint64_t UnpackedOffset, unsigned UnpackedAlign,
697 bool isPacked, const FieldDecl *D);
698
699 DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000700
Ken Dyckecfc7552011-02-24 01:13:28 +0000701 CharUnits getSize() const {
Ken Dyck3c215f22011-02-24 01:33:05 +0000702 assert(Size % Context.getCharWidth() == 0);
Ken Dyckecfc7552011-02-24 01:13:28 +0000703 return Context.toCharUnitsFromBits(Size);
704 }
705 uint64_t getSizeInBits() const { return Size; }
706
707 void setSize(CharUnits NewSize) { Size = Context.toBits(NewSize); }
708 void setSize(uint64_t NewSize) { Size = NewSize; }
709
710 CharUnits getDataSize() const {
Ken Dyck3c215f22011-02-24 01:33:05 +0000711 assert(DataSize % Context.getCharWidth() == 0);
Ken Dyckecfc7552011-02-24 01:13:28 +0000712 return Context.toCharUnitsFromBits(DataSize);
713 }
714 uint64_t getDataSizeInBits() const { return DataSize; }
715
716 void setDataSize(CharUnits NewSize) { DataSize = Context.toBits(NewSize); }
717 void setDataSize(uint64_t NewSize) { DataSize = NewSize; }
718
719
Argyrios Kyrtzidis499e6e42010-08-15 10:17:39 +0000720 RecordLayoutBuilder(const RecordLayoutBuilder&); // DO NOT IMPLEMENT
721 void operator=(const RecordLayoutBuilder&); // DO NOT IMPLEMENT
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000722public:
723 static const CXXMethodDecl *ComputeKeyFunction(const CXXRecordDecl *RD);
Argyrios Kyrtzidis3c6cd172010-08-25 00:32:14 +0000724
725 virtual ~RecordLayoutBuilder() { }
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000726};
Benjamin Kramerc7656cd2010-05-26 09:58:31 +0000727} // end anonymous namespace
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000728
Anders Carlsson81430692009-09-22 03:02:06 +0000729void
Anders Carlssonc2226202010-05-26 05:58:59 +0000730RecordLayoutBuilder::SelectPrimaryVBase(const CXXRecordDecl *RD) {
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000731 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000732 E = RD->bases_end(); I != E; ++I) {
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000733 assert(!I->getType()->isDependentType() &&
Sebastian Redl1054fae2009-10-25 17:03:50 +0000734 "Cannot layout class with dependent bases.");
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000735
Mike Stump11289f42009-09-09 15:08:12 +0000736 const CXXRecordDecl *Base =
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000737 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000738
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000739 // Check if this is a nearly empty virtual base.
Anders Carlsson60a62632010-11-25 01:51:53 +0000740 if (I->isVirtual() && Context.isNearlyEmpty(Base)) {
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000741 // If it's not an indirect primary base, then we've found our primary
742 // base.
Anders Carlsson81430692009-09-22 03:02:06 +0000743 if (!IndirectPrimaryBases.count(Base)) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000744 PrimaryBase = Base;
745 PrimaryBaseIsVirtual = true;
Mike Stump6f3793b2009-08-12 21:50:08 +0000746 return;
747 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000748
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000749 // Is this the first nearly empty virtual base?
750 if (!FirstNearlyEmptyVBase)
751 FirstNearlyEmptyVBase = Base;
Mike Stump6f3793b2009-08-12 21:50:08 +0000752 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000753
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000754 SelectPrimaryVBase(Base);
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000755 if (PrimaryBase)
Zhongxing Xuec345b72010-02-15 04:28:35 +0000756 return;
Mike Stump6f3793b2009-08-12 21:50:08 +0000757 }
758}
759
Ken Dyckaab635e2011-03-01 01:22:45 +0000760CharUnits
Charles Davisc2c576a2010-08-19 00:55:19 +0000761RecordLayoutBuilder::GetVirtualPointersSize(const CXXRecordDecl *RD) const {
Ken Dyckaab635e2011-03-01 01:22:45 +0000762 return Context.toCharUnitsFromBits(Context.Target.getPointerWidth(0));
Charles Davisc2c576a2010-08-19 00:55:19 +0000763}
764
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000765/// DeterminePrimaryBase - Determine the primary base of the given class.
Anders Carlssonc2226202010-05-26 05:58:59 +0000766void RecordLayoutBuilder::DeterminePrimaryBase(const CXXRecordDecl *RD) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000767 // If the class isn't dynamic, it won't have a primary base.
768 if (!RD->isDynamicClass())
769 return;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000770
Anders Carlsson81430692009-09-22 03:02:06 +0000771 // Compute all the primary virtual bases for all of our direct and
Mike Stump590a7c72009-08-13 23:26:06 +0000772 // indirect bases, and record all their primary virtual base classes.
Anders Carlsson5adde292010-11-24 22:55:48 +0000773 RD->getIndirectPrimaryBases(IndirectPrimaryBases);
Mike Stump590a7c72009-08-13 23:26:06 +0000774
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000775 // If the record has a dynamic base class, attempt to choose a primary base
776 // class. It is the first (in direct base class order) non-virtual dynamic
Anders Carlsson81430692009-09-22 03:02:06 +0000777 // base class, if one exists.
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000778 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000779 e = RD->bases_end(); i != e; ++i) {
Anders Carlsson03ff3792009-11-27 22:05:05 +0000780 // Ignore virtual bases.
781 if (i->isVirtual())
782 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000783
Anders Carlsson03ff3792009-11-27 22:05:05 +0000784 const CXXRecordDecl *Base =
785 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
786
787 if (Base->isDynamicClass()) {
788 // We found it.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000789 PrimaryBase = Base;
790 PrimaryBaseIsVirtual = false;
Anders Carlsson03ff3792009-11-27 22:05:05 +0000791 return;
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000792 }
793 }
794
795 // Otherwise, it is the first nearly empty virtual base that is not an
Mike Stump78696a72009-08-11 04:03:59 +0000796 // indirect primary virtual base class, if one exists.
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000797 if (RD->getNumVBases() != 0) {
798 SelectPrimaryVBase(RD);
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000799 if (PrimaryBase)
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000800 return;
801 }
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000802
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000803 // Otherwise, it is the first nearly empty virtual base that is not an
804 // indirect primary virtual base class, if one exists.
805 if (FirstNearlyEmptyVBase) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000806 PrimaryBase = FirstNearlyEmptyVBase;
807 PrimaryBaseIsVirtual = true;
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000808 return;
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000809 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000810
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000811 // Otherwise there is no primary base class.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000812 assert(!PrimaryBase && "Should not get here with a primary base!");
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000813
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000814 // Allocate the virtual table pointer at offset zero.
815 assert(DataSize == 0 && "Vtable pointer must be at offset zero!");
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000816
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000817 // Update the size.
Ken Dyckaab635e2011-03-01 01:22:45 +0000818 setSize(getSize() + GetVirtualPointersSize(RD));
Ken Dyck1b4420e2011-02-28 02:01:38 +0000819 setDataSize(getSize());
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000820
Ken Dyck85ef0432011-02-19 18:58:07 +0000821 CharUnits UnpackedBaseAlign =
822 Context.toCharUnitsFromBits(Context.Target.getPointerAlign(0));
823 CharUnits BaseAlign = (Packed) ? CharUnits::One() : UnpackedBaseAlign;
Argyrios Kyrtzidisd62c9be2010-12-09 02:47:58 +0000824
825 // The maximum field alignment overrides base align.
Ken Dyck02ced6f2011-02-17 01:49:42 +0000826 if (!MaxFieldAlignment.isZero()) {
Ken Dyck85ef0432011-02-19 18:58:07 +0000827 BaseAlign = std::min(BaseAlign, MaxFieldAlignment);
828 UnpackedBaseAlign = std::min(UnpackedBaseAlign, MaxFieldAlignment);
Argyrios Kyrtzidisd62c9be2010-12-09 02:47:58 +0000829 }
830
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000831 // Update the alignment.
Argyrios Kyrtzidisd62c9be2010-12-09 02:47:58 +0000832 UpdateAlignment(BaseAlign, UnpackedBaseAlign);
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000833}
834
Anders Carlssone3c24c72010-05-29 17:35:14 +0000835BaseSubobjectInfo *
836RecordLayoutBuilder::ComputeBaseSubobjectInfo(const CXXRecordDecl *RD,
837 bool IsVirtual,
838 BaseSubobjectInfo *Derived) {
839 BaseSubobjectInfo *Info;
840
841 if (IsVirtual) {
842 // Check if we already have info about this virtual base.
843 BaseSubobjectInfo *&InfoSlot = VirtualBaseInfo[RD];
844 if (InfoSlot) {
845 assert(InfoSlot->Class == RD && "Wrong class for virtual base info!");
846 return InfoSlot;
847 }
848
849 // We don't, create it.
850 InfoSlot = new (BaseSubobjectInfoAllocator.Allocate()) BaseSubobjectInfo;
851 Info = InfoSlot;
852 } else {
853 Info = new (BaseSubobjectInfoAllocator.Allocate()) BaseSubobjectInfo;
854 }
855
856 Info->Class = RD;
857 Info->IsVirtual = IsVirtual;
858 Info->Derived = 0;
859 Info->PrimaryVirtualBaseInfo = 0;
860
861 const CXXRecordDecl *PrimaryVirtualBase = 0;
862 BaseSubobjectInfo *PrimaryVirtualBaseInfo = 0;
863
864 // Check if this base has a primary virtual base.
865 if (RD->getNumVBases()) {
866 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlsson7f95cd12010-11-24 23:12:57 +0000867 if (Layout.isPrimaryBaseVirtual()) {
Anders Carlssone3c24c72010-05-29 17:35:14 +0000868 // This base does have a primary virtual base.
869 PrimaryVirtualBase = Layout.getPrimaryBase();
870 assert(PrimaryVirtualBase && "Didn't have a primary virtual base!");
871
872 // Now check if we have base subobject info about this primary base.
873 PrimaryVirtualBaseInfo = VirtualBaseInfo.lookup(PrimaryVirtualBase);
874
875 if (PrimaryVirtualBaseInfo) {
876 if (PrimaryVirtualBaseInfo->Derived) {
877 // We did have info about this primary base, and it turns out that it
878 // has already been claimed as a primary virtual base for another
879 // base.
880 PrimaryVirtualBase = 0;
881 } else {
882 // We can claim this base as our primary base.
883 Info->PrimaryVirtualBaseInfo = PrimaryVirtualBaseInfo;
884 PrimaryVirtualBaseInfo->Derived = Info;
885 }
886 }
887 }
888 }
889
890 // Now go through all direct bases.
891 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
892 E = RD->bases_end(); I != E; ++I) {
893 bool IsVirtual = I->isVirtual();
894
895 const CXXRecordDecl *BaseDecl =
896 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
897
898 Info->Bases.push_back(ComputeBaseSubobjectInfo(BaseDecl, IsVirtual, Info));
899 }
900
901 if (PrimaryVirtualBase && !PrimaryVirtualBaseInfo) {
902 // Traversing the bases must have created the base info for our primary
903 // virtual base.
904 PrimaryVirtualBaseInfo = VirtualBaseInfo.lookup(PrimaryVirtualBase);
905 assert(PrimaryVirtualBaseInfo &&
906 "Did not create a primary virtual base!");
907
908 // Claim the primary virtual base as our primary virtual base.
909 Info->PrimaryVirtualBaseInfo = PrimaryVirtualBaseInfo;
910 PrimaryVirtualBaseInfo->Derived = Info;
911 }
912
913 return Info;
914}
915
916void RecordLayoutBuilder::ComputeBaseSubobjectInfo(const CXXRecordDecl *RD) {
917 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
918 E = RD->bases_end(); I != E; ++I) {
919 bool IsVirtual = I->isVirtual();
920
921 const CXXRecordDecl *BaseDecl =
922 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
923
924 // Compute the base subobject info for this base.
925 BaseSubobjectInfo *Info = ComputeBaseSubobjectInfo(BaseDecl, IsVirtual, 0);
926
927 if (IsVirtual) {
928 // ComputeBaseInfo has already added this base for us.
929 assert(VirtualBaseInfo.count(BaseDecl) &&
930 "Did not add virtual base!");
931 } else {
932 // Add the base info to the map of non-virtual bases.
933 assert(!NonVirtualBaseInfo.count(BaseDecl) &&
934 "Non-virtual base already exists!");
935 NonVirtualBaseInfo.insert(std::make_pair(BaseDecl, Info));
936 }
937 }
938}
939
Anders Carlsson09ffa322010-03-10 22:21:28 +0000940void
Anders Carlssonc2226202010-05-26 05:58:59 +0000941RecordLayoutBuilder::LayoutNonVirtualBases(const CXXRecordDecl *RD) {
Anders Carlssone3c24c72010-05-29 17:35:14 +0000942 // Then, determine the primary base class.
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000943 DeterminePrimaryBase(RD);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000944
Anders Carlssone3c24c72010-05-29 17:35:14 +0000945 // Compute base subobject info.
946 ComputeBaseSubobjectInfo(RD);
947
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000948 // If we have a primary base class, lay it out.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000949 if (PrimaryBase) {
950 if (PrimaryBaseIsVirtual) {
Anders Carlssone3c24c72010-05-29 17:35:14 +0000951 // If the primary virtual base was a primary virtual base of some other
952 // base class we'll have to steal it.
953 BaseSubobjectInfo *PrimaryBaseInfo = VirtualBaseInfo.lookup(PrimaryBase);
954 PrimaryBaseInfo->Derived = 0;
955
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000956 // We have a virtual primary base, insert it as an indirect primary base.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000957 IndirectPrimaryBases.insert(PrimaryBase);
Anders Carlssonfe900962010-03-11 05:42:17 +0000958
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000959 assert(!VisitedVirtualBases.count(PrimaryBase) &&
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000960 "vbase already visited!");
961 VisitedVirtualBases.insert(PrimaryBase);
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000962
Anders Carlssond6ff5d72010-05-29 17:48:36 +0000963 LayoutVirtualBase(PrimaryBaseInfo);
Anders Carlssonbb0e6782010-05-29 17:42:25 +0000964 } else {
965 BaseSubobjectInfo *PrimaryBaseInfo =
966 NonVirtualBaseInfo.lookup(PrimaryBase);
967 assert(PrimaryBaseInfo &&
968 "Did not find base info for non-virtual primary base!");
969
970 LayoutNonVirtualBase(PrimaryBaseInfo);
971 }
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000972 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000973
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000974 // Now lay out the non-virtual bases.
975 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000976 E = RD->bases_end(); I != E; ++I) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000977
978 // Ignore virtual bases.
979 if (I->isVirtual())
980 continue;
981
Anders Carlssonbb0e6782010-05-29 17:42:25 +0000982 const CXXRecordDecl *BaseDecl =
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000983 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
984
985 // Skip the primary base.
Anders Carlssonbb0e6782010-05-29 17:42:25 +0000986 if (BaseDecl == PrimaryBase && !PrimaryBaseIsVirtual)
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000987 continue;
988
989 // Lay out the base.
Anders Carlssonbb0e6782010-05-29 17:42:25 +0000990 BaseSubobjectInfo *BaseInfo = NonVirtualBaseInfo.lookup(BaseDecl);
991 assert(BaseInfo && "Did not find base info for non-virtual base!");
992
993 LayoutNonVirtualBase(BaseInfo);
Anders Carlsson09ffa322010-03-10 22:21:28 +0000994 }
995}
996
Anders Carlssonbb0e6782010-05-29 17:42:25 +0000997void RecordLayoutBuilder::LayoutNonVirtualBase(const BaseSubobjectInfo *Base) {
Anders Carlsson0d0b5882010-03-10 22:26:24 +0000998 // Layout the base.
Anders Carlssona2f8e412010-10-31 22:20:42 +0000999 CharUnits Offset = LayoutBase(Base);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001000
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001001 // Add its base class offset.
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001002 assert(!Bases.count(Base->Class) && "base offset already exists!");
Anders Carlssona2f8e412010-10-31 22:20:42 +00001003 Bases.insert(std::make_pair(Base->Class, Offset));
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001004
1005 AddPrimaryVirtualBaseOffsets(Base, Offset);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001006}
Mike Stump2b84dd32009-11-05 04:02:15 +00001007
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001008void
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001009RecordLayoutBuilder::AddPrimaryVirtualBaseOffsets(const BaseSubobjectInfo *Info,
Anders Carlssona2f8e412010-10-31 22:20:42 +00001010 CharUnits Offset) {
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001011 // This base isn't interesting, it has no virtual bases.
1012 if (!Info->Class->getNumVBases())
1013 return;
1014
1015 // First, check if we have a virtual primary base to add offsets for.
1016 if (Info->PrimaryVirtualBaseInfo) {
1017 assert(Info->PrimaryVirtualBaseInfo->IsVirtual &&
1018 "Primary virtual base is not virtual!");
1019 if (Info->PrimaryVirtualBaseInfo->Derived == Info) {
1020 // Add the offset.
1021 assert(!VBases.count(Info->PrimaryVirtualBaseInfo->Class) &&
1022 "primary vbase offset already exists!");
1023 VBases.insert(std::make_pair(Info->PrimaryVirtualBaseInfo->Class,
Anders Carlssona2f8e412010-10-31 22:20:42 +00001024 Offset));
Anders Carlssonea7b1822010-04-15 16:12:58 +00001025
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001026 // Traverse the primary virtual base.
1027 AddPrimaryVirtualBaseOffsets(Info->PrimaryVirtualBaseInfo, Offset);
1028 }
Anders Carlssonea7b1822010-04-15 16:12:58 +00001029 }
1030
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001031 // Now go through all direct non-virtual bases.
1032 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Info->Class);
1033 for (unsigned I = 0, E = Info->Bases.size(); I != E; ++I) {
1034 const BaseSubobjectInfo *Base = Info->Bases[I];
1035 if (Base->IsVirtual)
Anders Carlssonea7b1822010-04-15 16:12:58 +00001036 continue;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001037
Anders Carlsson0a14ee92010-11-01 00:21:58 +00001038 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base->Class);
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001039 AddPrimaryVirtualBaseOffsets(Base, BaseOffset);
Anders Carlssonea7b1822010-04-15 16:12:58 +00001040 }
1041}
1042
1043void
Anders Carlssonc2226202010-05-26 05:58:59 +00001044RecordLayoutBuilder::LayoutVirtualBases(const CXXRecordDecl *RD,
Anders Carlssonea7b1822010-04-15 16:12:58 +00001045 const CXXRecordDecl *MostDerivedClass) {
Anders Carlssonde710c92010-03-11 04:33:54 +00001046 const CXXRecordDecl *PrimaryBase;
Anders Carlsson291279e2010-04-10 18:42:27 +00001047 bool PrimaryBaseIsVirtual;
Anders Carlssonfe900962010-03-11 05:42:17 +00001048
Anders Carlsson291279e2010-04-10 18:42:27 +00001049 if (MostDerivedClass == RD) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +00001050 PrimaryBase = this->PrimaryBase;
1051 PrimaryBaseIsVirtual = this->PrimaryBaseIsVirtual;
Anders Carlsson291279e2010-04-10 18:42:27 +00001052 } else {
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001053 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlssonde710c92010-03-11 04:33:54 +00001054 PrimaryBase = Layout.getPrimaryBase();
Anders Carlsson7f95cd12010-11-24 23:12:57 +00001055 PrimaryBaseIsVirtual = Layout.isPrimaryBaseVirtual();
Anders Carlsson291279e2010-04-10 18:42:27 +00001056 }
1057
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001058 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1059 E = RD->bases_end(); I != E; ++I) {
1060 assert(!I->getType()->isDependentType() &&
Sebastian Redl1054fae2009-10-25 17:03:50 +00001061 "Cannot layout class with dependent bases.");
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001062
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001063 const CXXRecordDecl *BaseDecl =
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001064 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1065
1066 if (I->isVirtual()) {
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001067 if (PrimaryBase != BaseDecl || !PrimaryBaseIsVirtual) {
1068 bool IndirectPrimaryBase = IndirectPrimaryBases.count(BaseDecl);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001069
Anders Carlsson291279e2010-04-10 18:42:27 +00001070 // Only lay out the virtual base if it's not an indirect primary base.
1071 if (!IndirectPrimaryBase) {
1072 // Only visit virtual bases once.
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001073 if (!VisitedVirtualBases.insert(BaseDecl))
Anders Carlsson291279e2010-04-10 18:42:27 +00001074 continue;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001075
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001076 const BaseSubobjectInfo *BaseInfo = VirtualBaseInfo.lookup(BaseDecl);
1077 assert(BaseInfo && "Did not find virtual base info!");
1078 LayoutVirtualBase(BaseInfo);
Anders Carlsson6a848892010-03-11 04:10:39 +00001079 }
Mike Stump2b84dd32009-11-05 04:02:15 +00001080 }
Mike Stumpc2f591b2009-08-13 22:53:07 +00001081 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001082
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001083 if (!BaseDecl->getNumVBases()) {
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001084 // This base isn't interesting since it doesn't have any virtual bases.
1085 continue;
Mike Stump996576f32009-08-16 19:04:13 +00001086 }
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001087
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001088 LayoutVirtualBases(BaseDecl, MostDerivedClass);
Mike Stump6b2556f2009-08-06 13:41:24 +00001089 }
1090}
1091
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001092void RecordLayoutBuilder::LayoutVirtualBase(const BaseSubobjectInfo *Base) {
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001093 assert(!Base->Derived && "Trying to lay out a primary virtual base!");
1094
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001095 // Layout the base.
Anders Carlssona2f8e412010-10-31 22:20:42 +00001096 CharUnits Offset = LayoutBase(Base);
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001097
1098 // Add its base class offset.
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001099 assert(!VBases.count(Base->Class) && "vbase offset already exists!");
Anders Carlssona2f8e412010-10-31 22:20:42 +00001100 VBases.insert(std::make_pair(Base->Class, Offset));
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001101
1102 AddPrimaryVirtualBaseOffsets(Base, Offset);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001103}
1104
Anders Carlssona2f8e412010-10-31 22:20:42 +00001105CharUnits RecordLayoutBuilder::LayoutBase(const BaseSubobjectInfo *Base) {
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001106 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Base->Class);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001107
1108 // If we have an empty base class, try to place it at offset 0.
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001109 if (Base->Class->isEmpty() &&
Anders Carlsson28466ab2010-10-31 22:13:23 +00001110 EmptySubobjects->CanPlaceBaseAtOffset(Base, CharUnits::Zero())) {
Ken Dyck1b4420e2011-02-28 02:01:38 +00001111 setSize(std::max(getSize(), Layout.getSize()));
Anders Carlsson09ffa322010-03-10 22:21:28 +00001112
Anders Carlssona2f8e412010-10-31 22:20:42 +00001113 return CharUnits::Zero();
Anders Carlsson09ffa322010-03-10 22:21:28 +00001114 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001115
Ken Dyck85ef0432011-02-19 18:58:07 +00001116 CharUnits UnpackedBaseAlign = Layout.getNonVirtualAlign();
1117 CharUnits BaseAlign = (Packed) ? CharUnits::One() : UnpackedBaseAlign;
Argyrios Kyrtzidis8b542742010-12-09 00:35:20 +00001118
1119 // The maximum field alignment overrides base align.
Ken Dyck02ced6f2011-02-17 01:49:42 +00001120 if (!MaxFieldAlignment.isZero()) {
Ken Dyck85ef0432011-02-19 18:58:07 +00001121 BaseAlign = std::min(BaseAlign, MaxFieldAlignment);
1122 UnpackedBaseAlign = std::min(UnpackedBaseAlign, MaxFieldAlignment);
Argyrios Kyrtzidis8b542742010-12-09 00:35:20 +00001123 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001124
Anders Carlsson09ffa322010-03-10 22:21:28 +00001125 // Round up the current record size to the base's alignment boundary.
Ken Dyck1b4420e2011-02-28 02:01:38 +00001126 CharUnits Offset = getDataSize().RoundUpToAlignment(BaseAlign);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001127
Anders Carlsson09ffa322010-03-10 22:21:28 +00001128 // Try to place the base.
Ken Dyck1b4420e2011-02-28 02:01:38 +00001129 while (!EmptySubobjects->CanPlaceBaseAtOffset(Base, Offset))
1130 Offset += BaseAlign;
Anders Carlsson09ffa322010-03-10 22:21:28 +00001131
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001132 if (!Base->Class->isEmpty()) {
Anders Carlsson09ffa322010-03-10 22:21:28 +00001133 // Update the data size.
Ken Dyck1b4420e2011-02-28 02:01:38 +00001134 setDataSize(Offset + Layout.getNonVirtualSize());
Anders Carlsson09ffa322010-03-10 22:21:28 +00001135
Ken Dyck1b4420e2011-02-28 02:01:38 +00001136 setSize(std::max(getSize(), getDataSize()));
Anders Carlsson09ffa322010-03-10 22:21:28 +00001137 } else
Ken Dyck1b4420e2011-02-28 02:01:38 +00001138 setSize(std::max(getSize(), Offset + Layout.getSize()));
Anders Carlsson09ffa322010-03-10 22:21:28 +00001139
1140 // Remember max struct/class alignment.
Argyrios Kyrtzidis8b542742010-12-09 00:35:20 +00001141 UpdateAlignment(BaseAlign, UnpackedBaseAlign);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001142
Ken Dyck1b4420e2011-02-28 02:01:38 +00001143 return Offset;
Anders Carlsson09ffa322010-03-10 22:21:28 +00001144}
1145
Daniel Dunbar6da10982010-05-27 05:45:51 +00001146void RecordLayoutBuilder::InitializeLayout(const Decl *D) {
1147 if (const RecordDecl *RD = dyn_cast<RecordDecl>(D))
1148 IsUnion = RD->isUnion();
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001149
Anders Carlsson28a5fa22009-08-08 19:38:24 +00001150 Packed = D->hasAttr<PackedAttr>();
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001151
Daniel Dunbar6da10982010-05-27 05:45:51 +00001152 // mac68k alignment supersedes maximum field alignment and attribute aligned,
1153 // and forces all structures to have 2-byte alignment. The IBM docs on it
1154 // allude to additional (more complicated) semantics, especially with regard
1155 // to bit-fields, but gcc appears not to follow that.
1156 if (D->hasAttr<AlignMac68kAttr>()) {
1157 IsMac68kAlign = true;
Ken Dyck02ced6f2011-02-17 01:49:42 +00001158 MaxFieldAlignment = CharUnits::fromQuantity(2);
Ken Dyck4731d5b2011-02-16 02:05:21 +00001159 Alignment = CharUnits::fromQuantity(2);
Daniel Dunbar6da10982010-05-27 05:45:51 +00001160 } else {
1161 if (const MaxFieldAlignmentAttr *MFAA = D->getAttr<MaxFieldAlignmentAttr>())
Ken Dyck02ced6f2011-02-17 01:49:42 +00001162 MaxFieldAlignment = Context.toCharUnitsFromBits(MFAA->getAlignment());
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001163
Alexis Huntdcfba7b2010-08-18 23:23:40 +00001164 if (unsigned MaxAlign = D->getMaxAlignment())
Ken Dyck85ef0432011-02-19 18:58:07 +00001165 UpdateAlignment(Context.toCharUnitsFromBits(MaxAlign));
Daniel Dunbar6da10982010-05-27 05:45:51 +00001166 }
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001167}
Anders Carlsson6d9f6f32009-07-19 00:18:47 +00001168
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001169void RecordLayoutBuilder::Layout(const RecordDecl *D) {
1170 InitializeLayout(D);
Anders Carlsson118ce162009-07-18 21:48:39 +00001171 LayoutFields(D);
Mike Stump11289f42009-09-09 15:08:12 +00001172
Anders Carlsson79474332009-07-18 20:20:21 +00001173 // Finally, round the size of the total struct up to the alignment of the
1174 // struct itself.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001175 FinishLayout(D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001176}
1177
1178void RecordLayoutBuilder::Layout(const CXXRecordDecl *RD) {
1179 InitializeLayout(RD);
1180
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001181 // Lay out the vtable and the non-virtual bases.
1182 LayoutNonVirtualBases(RD);
1183
1184 LayoutFields(RD);
1185
Ken Dycke7380752011-03-10 01:53:59 +00001186 NonVirtualSize = Context.toCharUnitsFromBits(
1187 llvm::RoundUpToAlignment(getSizeInBits(),
1188 Context.Target.getCharAlign()));
Ken Dyck4731d5b2011-02-16 02:05:21 +00001189 NonVirtualAlignment = Alignment;
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001190
1191 // Lay out the virtual bases and add the primary virtual base offsets.
1192 LayoutVirtualBases(RD, RD);
1193
1194 VisitedVirtualBases.clear();
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001195
1196 // Finally, round the size of the total struct up to the alignment of the
1197 // struct itself.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001198 FinishLayout(RD);
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001199
Anders Carlsson5b441d72010-04-10 21:24:48 +00001200#ifndef NDEBUG
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001201 // Check that we have base offsets for all bases.
1202 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1203 E = RD->bases_end(); I != E; ++I) {
1204 if (I->isVirtual())
1205 continue;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001206
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001207 const CXXRecordDecl *BaseDecl =
1208 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1209
1210 assert(Bases.count(BaseDecl) && "Did not find base offset!");
1211 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001212
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001213 // And all virtual bases.
1214 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
1215 E = RD->vbases_end(); I != E; ++I) {
1216 const CXXRecordDecl *BaseDecl =
1217 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001218
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001219 assert(VBases.count(BaseDecl) && "Did not find base offset!");
Anders Carlsson5b441d72010-04-10 21:24:48 +00001220 }
1221#endif
Anders Carlsson79474332009-07-18 20:20:21 +00001222}
1223
Anders Carlssonc2226202010-05-26 05:58:59 +00001224void RecordLayoutBuilder::Layout(const ObjCInterfaceDecl *D) {
Anders Carlsson4f516282009-07-18 20:50:59 +00001225 if (ObjCInterfaceDecl *SD = D->getSuperClass()) {
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001226 const ASTRecordLayout &SL = Context.getASTObjCInterfaceLayout(SD);
Anders Carlsson4f516282009-07-18 20:50:59 +00001227
Ken Dyck85ef0432011-02-19 18:58:07 +00001228 UpdateAlignment(SL.getAlignment());
Mike Stump11289f42009-09-09 15:08:12 +00001229
Anders Carlsson4f516282009-07-18 20:50:59 +00001230 // We start laying out ivars not at the end of the superclass
1231 // structure, but at the next byte following the last field.
Ken Dyckecfc7552011-02-24 01:13:28 +00001232 setSize(SL.getDataSize());
Ken Dyck1b4420e2011-02-28 02:01:38 +00001233 setDataSize(getSize());
Anders Carlsson4f516282009-07-18 20:50:59 +00001234 }
Mike Stump11289f42009-09-09 15:08:12 +00001235
Daniel Dunbar6da10982010-05-27 05:45:51 +00001236 InitializeLayout(D);
Daniel Dunbar40130442010-05-27 01:12:46 +00001237
Anders Carlsson4f516282009-07-18 20:50:59 +00001238 // Layout each ivar sequentially.
1239 llvm::SmallVector<ObjCIvarDecl*, 16> Ivars;
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001240 Context.ShallowCollectObjCIvars(D, Ivars);
Anders Carlsson4f516282009-07-18 20:50:59 +00001241 for (unsigned i = 0, e = Ivars.size(); i != e; ++i)
1242 LayoutField(Ivars[i]);
Mike Stump11289f42009-09-09 15:08:12 +00001243
Anders Carlsson4f516282009-07-18 20:50:59 +00001244 // Finally, round the size of the total struct up to the alignment of the
1245 // struct itself.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001246 FinishLayout(D);
Anders Carlsson4f516282009-07-18 20:50:59 +00001247}
1248
Anders Carlssonc2226202010-05-26 05:58:59 +00001249void RecordLayoutBuilder::LayoutFields(const RecordDecl *D) {
Anders Carlsson118ce162009-07-18 21:48:39 +00001250 // Layout each field, for now, just sequentially, respecting alignment. In
1251 // the future, this will need to be tweakable by targets.
Mike Stump11289f42009-09-09 15:08:12 +00001252 for (RecordDecl::field_iterator Field = D->field_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001253 FieldEnd = D->field_end(); Field != FieldEnd; ++Field)
Anders Carlsson118ce162009-07-18 21:48:39 +00001254 LayoutField(*Field);
1255}
1256
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001257void RecordLayoutBuilder::LayoutWideBitField(uint64_t FieldSize,
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001258 uint64_t TypeSize,
1259 bool FieldPacked,
1260 const FieldDecl *D) {
Anders Carlsson57235162010-04-16 15:57:11 +00001261 assert(Context.getLangOptions().CPlusPlus &&
1262 "Can only have wide bit-fields in C++!");
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001263
Anders Carlsson57235162010-04-16 15:57:11 +00001264 // Itanium C++ ABI 2.4:
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001265 // If sizeof(T)*8 < n, let T' be the largest integral POD type with
Anders Carlsson57235162010-04-16 15:57:11 +00001266 // sizeof(T')*8 <= n.
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001267
Anders Carlsson57235162010-04-16 15:57:11 +00001268 QualType IntegralPODTypes[] = {
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001269 Context.UnsignedCharTy, Context.UnsignedShortTy, Context.UnsignedIntTy,
Anders Carlsson57235162010-04-16 15:57:11 +00001270 Context.UnsignedLongTy, Context.UnsignedLongLongTy
1271 };
1272
Anders Carlsson57235162010-04-16 15:57:11 +00001273 QualType Type;
1274 for (unsigned I = 0, E = llvm::array_lengthof(IntegralPODTypes);
1275 I != E; ++I) {
1276 uint64_t Size = Context.getTypeSize(IntegralPODTypes[I]);
Anders Carlsson57235162010-04-16 15:57:11 +00001277
1278 if (Size > FieldSize)
1279 break;
1280
1281 Type = IntegralPODTypes[I];
1282 }
1283 assert(!Type.isNull() && "Did not find a type!");
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001284
Ken Dyckdbe37f32011-03-01 01:36:00 +00001285 CharUnits TypeAlign = Context.getTypeAlignInChars(Type);
Anders Carlsson57235162010-04-16 15:57:11 +00001286
1287 // We're not going to use any of the unfilled bits in the last byte.
1288 UnfilledBitsInLastByte = 0;
1289
Anders Carlssonaad5fa82010-04-17 20:21:41 +00001290 uint64_t FieldOffset;
Ken Dyckecfc7552011-02-24 01:13:28 +00001291 uint64_t UnpaddedFieldOffset = getDataSizeInBits() - UnfilledBitsInLastByte;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001292
Anders Carlsson57235162010-04-16 15:57:11 +00001293 if (IsUnion) {
Ken Dyckecfc7552011-02-24 01:13:28 +00001294 setDataSize(std::max(getDataSizeInBits(), FieldSize));
Anders Carlssonaad5fa82010-04-17 20:21:41 +00001295 FieldOffset = 0;
Anders Carlsson57235162010-04-16 15:57:11 +00001296 } else {
Anders Carlssonaad5fa82010-04-17 20:21:41 +00001297 // The bitfield is allocated starting at the next offset aligned appropriately
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001298 // for T', with length n bits.
Ken Dyckdbe37f32011-03-01 01:36:00 +00001299 FieldOffset = llvm::RoundUpToAlignment(getDataSizeInBits(),
1300 Context.toBits(TypeAlign));
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001301
Anders Carlsson57235162010-04-16 15:57:11 +00001302 uint64_t NewSizeInBits = FieldOffset + FieldSize;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001303
Ken Dycka1a2e8d2011-03-10 02:00:35 +00001304 setDataSize(llvm::RoundUpToAlignment(NewSizeInBits,
1305 Context.Target.getCharAlign()));
Ken Dyckecfc7552011-02-24 01:13:28 +00001306 UnfilledBitsInLastByte = getDataSizeInBits() - NewSizeInBits;
Anders Carlsson57235162010-04-16 15:57:11 +00001307 }
1308
1309 // Place this field at the current location.
1310 FieldOffsets.push_back(FieldOffset);
1311
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001312 CheckFieldPadding(FieldOffset, UnpaddedFieldOffset, FieldOffset,
Ken Dyckdbe37f32011-03-01 01:36:00 +00001313 Context.toBits(TypeAlign), FieldPacked, D);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001314
Anders Carlsson57235162010-04-16 15:57:11 +00001315 // Update the size.
Ken Dyckecfc7552011-02-24 01:13:28 +00001316 setSize(std::max(getSizeInBits(), getDataSizeInBits()));
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001317
Anders Carlsson57235162010-04-16 15:57:11 +00001318 // Remember max struct/class alignment.
Ken Dyckdbe37f32011-03-01 01:36:00 +00001319 UpdateAlignment(TypeAlign);
Anders Carlsson57235162010-04-16 15:57:11 +00001320}
1321
Anders Carlssonc2226202010-05-26 05:58:59 +00001322void RecordLayoutBuilder::LayoutBitField(const FieldDecl *D) {
Anders Carlsson07209442009-11-22 17:37:31 +00001323 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Ken Dyckecfc7552011-02-24 01:13:28 +00001324 uint64_t UnpaddedFieldOffset = getDataSizeInBits() - UnfilledBitsInLastByte;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001325 uint64_t FieldOffset = IsUnion ? 0 : UnpaddedFieldOffset;
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001326 uint64_t FieldSize = D->getBitWidth()->EvaluateAsInt(Context).getZExtValue();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001327
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001328 std::pair<uint64_t, unsigned> FieldInfo = Context.getTypeInfo(D->getType());
Anders Carlsson07209442009-11-22 17:37:31 +00001329 uint64_t TypeSize = FieldInfo.first;
1330 unsigned FieldAlign = FieldInfo.second;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001331
Anders Carlsson57235162010-04-16 15:57:11 +00001332 if (FieldSize > TypeSize) {
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001333 LayoutWideBitField(FieldSize, TypeSize, FieldPacked, D);
Anders Carlsson57235162010-04-16 15:57:11 +00001334 return;
1335 }
1336
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001337 // The align if the field is not packed. This is to check if the attribute
1338 // was unnecessary (-Wpacked).
1339 unsigned UnpackedFieldAlign = FieldAlign;
1340 uint64_t UnpackedFieldOffset = FieldOffset;
1341 if (!Context.Target.useBitFieldTypeAlignment())
1342 UnpackedFieldAlign = 1;
1343
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001344 if (FieldPacked || !Context.Target.useBitFieldTypeAlignment())
Anders Carlsson07209442009-11-22 17:37:31 +00001345 FieldAlign = 1;
Alexis Huntdcfba7b2010-08-18 23:23:40 +00001346 FieldAlign = std::max(FieldAlign, D->getMaxAlignment());
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001347 UnpackedFieldAlign = std::max(UnpackedFieldAlign, D->getMaxAlignment());
Anders Carlsson07209442009-11-22 17:37:31 +00001348
1349 // The maximum field alignment overrides the aligned attribute.
Ken Dyck02ced6f2011-02-17 01:49:42 +00001350 if (!MaxFieldAlignment.isZero()) {
1351 unsigned MaxFieldAlignmentInBits = Context.toBits(MaxFieldAlignment);
1352 FieldAlign = std::min(FieldAlign, MaxFieldAlignmentInBits);
1353 UnpackedFieldAlign = std::min(UnpackedFieldAlign, MaxFieldAlignmentInBits);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001354 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001355
Daniel Dunbar3d9289c2010-04-15 06:18:39 +00001356 // Check if we need to add padding to give the field the correct alignment.
Anders Carlsson07209442009-11-22 17:37:31 +00001357 if (FieldSize == 0 || (FieldOffset & (FieldAlign-1)) + FieldSize > TypeSize)
Daniel Dunbarf35e7652010-06-29 18:34:35 +00001358 FieldOffset = llvm::RoundUpToAlignment(FieldOffset, FieldAlign);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001359
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001360 if (FieldSize == 0 ||
1361 (UnpackedFieldOffset & (UnpackedFieldAlign-1)) + FieldSize > TypeSize)
1362 UnpackedFieldOffset = llvm::RoundUpToAlignment(UnpackedFieldOffset,
1363 UnpackedFieldAlign);
1364
Daniel Dunbar3d9289c2010-04-15 06:18:39 +00001365 // Padding members don't affect overall alignment.
Anders Carlsson07209442009-11-22 17:37:31 +00001366 if (!D->getIdentifier())
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001367 FieldAlign = UnpackedFieldAlign = 1;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001368
Anders Carlsson07209442009-11-22 17:37:31 +00001369 // Place this field at the current location.
1370 FieldOffsets.push_back(FieldOffset);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001371
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001372 CheckFieldPadding(FieldOffset, UnpaddedFieldOffset, UnpackedFieldOffset,
1373 UnpackedFieldAlign, FieldPacked, D);
1374
Anders Carlssonba958402009-11-22 19:13:51 +00001375 // Update DataSize to include the last byte containing (part of) the bitfield.
1376 if (IsUnion) {
1377 // FIXME: I think FieldSize should be TypeSize here.
Ken Dyckecfc7552011-02-24 01:13:28 +00001378 setDataSize(std::max(getDataSizeInBits(), FieldSize));
Anders Carlssonba958402009-11-22 19:13:51 +00001379 } else {
1380 uint64_t NewSizeInBits = FieldOffset + FieldSize;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001381
Ken Dycka1a2e8d2011-03-10 02:00:35 +00001382 setDataSize(llvm::RoundUpToAlignment(NewSizeInBits,
1383 Context.Target.getCharAlign()));
Ken Dyckecfc7552011-02-24 01:13:28 +00001384 UnfilledBitsInLastByte = getDataSizeInBits() - NewSizeInBits;
Anders Carlssonba958402009-11-22 19:13:51 +00001385 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001386
Anders Carlssonba958402009-11-22 19:13:51 +00001387 // Update the size.
Ken Dyckecfc7552011-02-24 01:13:28 +00001388 setSize(std::max(getSizeInBits(), getDataSizeInBits()));
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001389
Anders Carlsson07209442009-11-22 17:37:31 +00001390 // Remember max struct/class alignment.
Ken Dyck85ef0432011-02-19 18:58:07 +00001391 UpdateAlignment(Context.toCharUnitsFromBits(FieldAlign),
1392 Context.toCharUnitsFromBits(UnpackedFieldAlign));
Anders Carlsson07209442009-11-22 17:37:31 +00001393}
1394
Anders Carlssonc2226202010-05-26 05:58:59 +00001395void RecordLayoutBuilder::LayoutField(const FieldDecl *D) {
Anders Carlsson07209442009-11-22 17:37:31 +00001396 if (D->isBitField()) {
1397 LayoutBitField(D);
1398 return;
1399 }
1400
Ken Dyckecfc7552011-02-24 01:13:28 +00001401 uint64_t UnpaddedFieldOffset = getDataSizeInBits() - UnfilledBitsInLastByte;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001402
Anders Carlssonba958402009-11-22 19:13:51 +00001403 // Reset the unfilled bits.
1404 UnfilledBitsInLastByte = 0;
1405
Anders Carlsson07209442009-11-22 17:37:31 +00001406 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Ken Dyck6d90e892011-02-20 02:06:09 +00001407 CharUnits FieldOffset =
Ken Dyckecfc7552011-02-24 01:13:28 +00001408 IsUnion ? CharUnits::Zero() : getDataSize();
Ken Dyck6d90e892011-02-20 02:06:09 +00001409 CharUnits FieldSize;
1410 CharUnits FieldAlign;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001411
Anders Carlsson07209442009-11-22 17:37:31 +00001412 if (D->getType()->isIncompleteArrayType()) {
1413 // This is a flexible array member; we can't directly
1414 // query getTypeInfo about these, so we figure it out here.
1415 // Flexible array members don't have any size, but they
1416 // have to be aligned appropriately for their element type.
Ken Dyck6d90e892011-02-20 02:06:09 +00001417 FieldSize = CharUnits::Zero();
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001418 const ArrayType* ATy = Context.getAsArrayType(D->getType());
Ken Dyck6d90e892011-02-20 02:06:09 +00001419 FieldAlign = Context.getTypeAlignInChars(ATy->getElementType());
Anders Carlsson07209442009-11-22 17:37:31 +00001420 } else if (const ReferenceType *RT = D->getType()->getAs<ReferenceType>()) {
1421 unsigned AS = RT->getPointeeType().getAddressSpace();
Ken Dyck6d90e892011-02-20 02:06:09 +00001422 FieldSize =
1423 Context.toCharUnitsFromBits(Context.Target.getPointerWidth(AS));
1424 FieldAlign =
1425 Context.toCharUnitsFromBits(Context.Target.getPointerAlign(AS));
Anders Carlsson79474332009-07-18 20:20:21 +00001426 } else {
Ken Dyck6d90e892011-02-20 02:06:09 +00001427 std::pair<CharUnits, CharUnits> FieldInfo =
1428 Context.getTypeInfoInChars(D->getType());
Anders Carlsson07209442009-11-22 17:37:31 +00001429 FieldSize = FieldInfo.first;
1430 FieldAlign = FieldInfo.second;
Douglas Gregordbe39272011-02-01 15:15:22 +00001431
1432 if (Context.getLangOptions().MSBitfields) {
1433 // If MS bitfield layout is required, figure out what type is being
1434 // laid out and align the field to the width of that type.
1435
1436 // Resolve all typedefs down to their base type and round up the field
1437 // alignment if necessary.
1438 QualType T = Context.getBaseElementType(D->getType());
1439 if (const BuiltinType *BTy = T->getAs<BuiltinType>()) {
Ken Dyck6d90e892011-02-20 02:06:09 +00001440 CharUnits TypeSize = Context.getTypeSizeInChars(BTy);
Douglas Gregordbe39272011-02-01 15:15:22 +00001441 if (TypeSize > FieldAlign)
1442 FieldAlign = TypeSize;
1443 }
1444 }
Anders Carlsson79474332009-07-18 20:20:21 +00001445 }
Mike Stump11289f42009-09-09 15:08:12 +00001446
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001447 // The align if the field is not packed. This is to check if the attribute
1448 // was unnecessary (-Wpacked).
Ken Dyck6d90e892011-02-20 02:06:09 +00001449 CharUnits UnpackedFieldAlign = FieldAlign;
1450 CharUnits UnpackedFieldOffset = FieldOffset;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001451
Anders Carlsson07209442009-11-22 17:37:31 +00001452 if (FieldPacked)
Ken Dyck6d90e892011-02-20 02:06:09 +00001453 FieldAlign = CharUnits::One();
1454 CharUnits MaxAlignmentInChars =
1455 Context.toCharUnitsFromBits(D->getMaxAlignment());
1456 FieldAlign = std::max(FieldAlign, MaxAlignmentInChars);
1457 UnpackedFieldAlign = std::max(UnpackedFieldAlign, MaxAlignmentInChars);
Anders Carlsson07209442009-11-22 17:37:31 +00001458
1459 // The maximum field alignment overrides the aligned attribute.
Ken Dyck02ced6f2011-02-17 01:49:42 +00001460 if (!MaxFieldAlignment.isZero()) {
Ken Dyck6d90e892011-02-20 02:06:09 +00001461 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
1462 UnpackedFieldAlign = std::min(UnpackedFieldAlign, MaxFieldAlignment);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001463 }
Anders Carlsson07209442009-11-22 17:37:31 +00001464
1465 // Round up the current record size to the field's alignment boundary.
Ken Dyck6d90e892011-02-20 02:06:09 +00001466 FieldOffset = FieldOffset.RoundUpToAlignment(FieldAlign);
1467 UnpackedFieldOffset =
1468 UnpackedFieldOffset.RoundUpToAlignment(UnpackedFieldAlign);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001469
Anders Carlssonb1fcdd02010-05-30 06:52:33 +00001470 if (!IsUnion && EmptySubobjects) {
1471 // Check if we can place the field at this offset.
Ken Dyck6d90e892011-02-20 02:06:09 +00001472 while (!EmptySubobjects->CanPlaceFieldAtOffset(D, FieldOffset)) {
Anders Carlsson07209442009-11-22 17:37:31 +00001473 // We couldn't place the field at the offset. Try again at a new offset.
1474 FieldOffset += FieldAlign;
1475 }
Anders Carlsson07209442009-11-22 17:37:31 +00001476 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001477
Anders Carlsson79474332009-07-18 20:20:21 +00001478 // Place this field at the current location.
Ken Dyck6d90e892011-02-20 02:06:09 +00001479 FieldOffsets.push_back(Context.toBits(FieldOffset));
Mike Stump11289f42009-09-09 15:08:12 +00001480
Ken Dyck6d90e892011-02-20 02:06:09 +00001481 CheckFieldPadding(Context.toBits(FieldOffset), UnpaddedFieldOffset,
1482 Context.toBits(UnpackedFieldOffset),
1483 Context.toBits(UnpackedFieldAlign), FieldPacked, D);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001484
Anders Carlsson79474332009-07-18 20:20:21 +00001485 // Reserve space for this field.
Daniel Dunbar30cdc702011-02-24 16:40:53 +00001486 uint64_t FieldSizeInBits = Context.toBits(FieldSize);
Anders Carlsson79474332009-07-18 20:20:21 +00001487 if (IsUnion)
Daniel Dunbar30cdc702011-02-24 16:40:53 +00001488 setSize(std::max(getSizeInBits(), FieldSizeInBits));
Anders Carlsson79474332009-07-18 20:20:21 +00001489 else
Ken Dyck1b4420e2011-02-28 02:01:38 +00001490 setSize(FieldOffset + FieldSize);
Mike Stump11289f42009-09-09 15:08:12 +00001491
Anders Carlsson47680d82009-09-26 01:34:51 +00001492 // Update the data size.
Daniel Dunbar30cdc702011-02-24 16:40:53 +00001493 setDataSize(getSizeInBits());
Mike Stump11289f42009-09-09 15:08:12 +00001494
Anders Carlsson79474332009-07-18 20:20:21 +00001495 // Remember max struct/class alignment.
Ken Dyck6d90e892011-02-20 02:06:09 +00001496 UpdateAlignment(FieldAlign, UnpackedFieldAlign);
Anders Carlsson79474332009-07-18 20:20:21 +00001497}
1498
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001499void RecordLayoutBuilder::FinishLayout(const NamedDecl *D) {
Anders Carlsson79474332009-07-18 20:20:21 +00001500 // In C++, records cannot be of size 0.
Ken Dyckecfc7552011-02-24 01:13:28 +00001501 if (Context.getLangOptions().CPlusPlus && getSizeInBits() == 0) {
Fariborz Jahanian09b23312011-02-02 19:36:18 +00001502 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
1503 // Compatibility with gcc requires a class (pod or non-pod)
1504 // which is not empty but of size 0; such as having fields of
1505 // array of zero-length, remains of Size 0
1506 if (RD->isEmpty())
Ken Dyck1b4420e2011-02-28 02:01:38 +00001507 setSize(CharUnits::One());
Fariborz Jahanian09b23312011-02-02 19:36:18 +00001508 }
1509 else
Ken Dyck1b4420e2011-02-28 02:01:38 +00001510 setSize(CharUnits::One());
Fariborz Jahanian09b23312011-02-02 19:36:18 +00001511 }
Anders Carlsson79474332009-07-18 20:20:21 +00001512 // Finally, round the size of the record up to the alignment of the
1513 // record itself.
Ken Dyckecfc7552011-02-24 01:13:28 +00001514 uint64_t UnpaddedSize = getSizeInBits() - UnfilledBitsInLastByte;
Ken Dyck1b4420e2011-02-28 02:01:38 +00001515 uint64_t UnpackedSizeInBits =
Ken Dyckecfc7552011-02-24 01:13:28 +00001516 llvm::RoundUpToAlignment(getSizeInBits(),
1517 Context.toBits(UnpackedAlignment));
Ken Dyck1b4420e2011-02-28 02:01:38 +00001518 CharUnits UnpackedSize = Context.toCharUnitsFromBits(UnpackedSizeInBits);
Ken Dyckecfc7552011-02-24 01:13:28 +00001519 setSize(llvm::RoundUpToAlignment(getSizeInBits(), Context.toBits(Alignment)));
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001520
1521 unsigned CharBitNum = Context.Target.getCharWidth();
1522 if (const RecordDecl *RD = dyn_cast<RecordDecl>(D)) {
1523 // Warn if padding was introduced to the struct/class/union.
Ken Dyckecfc7552011-02-24 01:13:28 +00001524 if (getSizeInBits() > UnpaddedSize) {
1525 unsigned PadSize = getSizeInBits() - UnpaddedSize;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001526 bool InBits = true;
1527 if (PadSize % CharBitNum == 0) {
1528 PadSize = PadSize / CharBitNum;
1529 InBits = false;
1530 }
1531 Diag(RD->getLocation(), diag::warn_padded_struct_size)
1532 << Context.getTypeDeclType(RD)
1533 << PadSize
1534 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1); // plural or not
1535 }
1536
1537 // Warn if we packed it unnecessarily. If the alignment is 1 byte don't
1538 // bother since there won't be alignment issues.
Ken Dyckecfc7552011-02-24 01:13:28 +00001539 if (Packed && UnpackedAlignment > CharUnits::One() &&
Ken Dyck1b4420e2011-02-28 02:01:38 +00001540 getSize() == UnpackedSize)
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001541 Diag(D->getLocation(), diag::warn_unnecessary_packed)
1542 << Context.getTypeDeclType(RD);
1543 }
Anders Carlsson79474332009-07-18 20:20:21 +00001544}
1545
Ken Dyck85ef0432011-02-19 18:58:07 +00001546void RecordLayoutBuilder::UpdateAlignment(CharUnits NewAlignment,
1547 CharUnits UnpackedNewAlignment) {
Daniel Dunbar6da10982010-05-27 05:45:51 +00001548 // The alignment is not modified when using 'mac68k' alignment.
1549 if (IsMac68kAlign)
1550 return;
1551
Ken Dyck85ef0432011-02-19 18:58:07 +00001552 if (NewAlignment > Alignment) {
1553 assert(llvm::isPowerOf2_32(NewAlignment.getQuantity() &&
1554 "Alignment not a power of 2"));
1555 Alignment = NewAlignment;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001556 }
1557
Ken Dyck85ef0432011-02-19 18:58:07 +00001558 if (UnpackedNewAlignment > UnpackedAlignment) {
1559 assert(llvm::isPowerOf2_32(UnpackedNewAlignment.getQuantity() &&
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001560 "Alignment not a power of 2"));
Ken Dyck85ef0432011-02-19 18:58:07 +00001561 UnpackedAlignment = UnpackedNewAlignment;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001562 }
1563}
1564
1565void RecordLayoutBuilder::CheckFieldPadding(uint64_t Offset,
1566 uint64_t UnpaddedOffset,
1567 uint64_t UnpackedOffset,
1568 unsigned UnpackedAlign,
1569 bool isPacked,
1570 const FieldDecl *D) {
1571 // We let objc ivars without warning, objc interfaces generally are not used
1572 // for padding tricks.
1573 if (isa<ObjCIvarDecl>(D))
Anders Carlsson79474332009-07-18 20:20:21 +00001574 return;
Mike Stump11289f42009-09-09 15:08:12 +00001575
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001576 unsigned CharBitNum = Context.Target.getCharWidth();
Mike Stump11289f42009-09-09 15:08:12 +00001577
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001578 // Warn if padding was introduced to the struct/class.
1579 if (!IsUnion && Offset > UnpaddedOffset) {
1580 unsigned PadSize = Offset - UnpaddedOffset;
1581 bool InBits = true;
1582 if (PadSize % CharBitNum == 0) {
1583 PadSize = PadSize / CharBitNum;
1584 InBits = false;
1585 }
1586 if (D->getIdentifier())
1587 Diag(D->getLocation(), diag::warn_padded_struct_field)
1588 << (D->getParent()->isStruct() ? 0 : 1) // struct|class
1589 << Context.getTypeDeclType(D->getParent())
1590 << PadSize
1591 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1) // plural or not
1592 << D->getIdentifier();
1593 else
1594 Diag(D->getLocation(), diag::warn_padded_struct_anon_field)
1595 << (D->getParent()->isStruct() ? 0 : 1) // struct|class
1596 << Context.getTypeDeclType(D->getParent())
1597 << PadSize
1598 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1); // plural or not
1599 }
1600
1601 // Warn if we packed it unnecessarily. If the alignment is 1 byte don't
1602 // bother since there won't be alignment issues.
1603 if (isPacked && UnpackedAlign > CharBitNum && Offset == UnpackedOffset)
1604 Diag(D->getLocation(), diag::warn_unnecessary_packed)
1605 << D->getIdentifier();
Anders Carlsson79474332009-07-18 20:20:21 +00001606}
Mike Stump11289f42009-09-09 15:08:12 +00001607
Anders Carlsson5ebf8b42009-12-07 04:35:11 +00001608const CXXMethodDecl *
Anders Carlssonc2226202010-05-26 05:58:59 +00001609RecordLayoutBuilder::ComputeKeyFunction(const CXXRecordDecl *RD) {
Daniel Dunbarccabe482010-04-19 20:44:53 +00001610 // If a class isn't polymorphic it doesn't have a key function.
Anders Carlsson5ebf8b42009-12-07 04:35:11 +00001611 if (!RD->isPolymorphic())
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001612 return 0;
Eli Friedmanf2c79b62009-12-08 03:56:49 +00001613
1614 // A class inside an anonymous namespace doesn't have a key function. (Or
1615 // at least, there's no point to assigning a key function to such a class;
1616 // this doesn't affect the ABI.)
1617 if (RD->isInAnonymousNamespace())
1618 return 0;
1619
Argyrios Kyrtzidis8c64bbe2010-10-13 02:39:41 +00001620 // Template instantiations don't have key functions,see Itanium C++ ABI 5.2.6.
1621 // Same behavior as GCC.
1622 TemplateSpecializationKind TSK = RD->getTemplateSpecializationKind();
1623 if (TSK == TSK_ImplicitInstantiation ||
1624 TSK == TSK_ExplicitInstantiationDefinition)
1625 return 0;
1626
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001627 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
1628 E = RD->method_end(); I != E; ++I) {
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001629 const CXXMethodDecl *MD = *I;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001630
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001631 if (!MD->isVirtual())
1632 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001633
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001634 if (MD->isPure())
1635 continue;
Eli Friedmanf2c79b62009-12-08 03:56:49 +00001636
Anders Carlssonf98849e2009-12-02 17:15:43 +00001637 // Ignore implicit member functions, they are always marked as inline, but
1638 // they don't have a body until they're defined.
1639 if (MD->isImplicit())
1640 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001641
Douglas Gregora318efd2010-01-05 19:06:31 +00001642 if (MD->isInlineSpecified())
1643 continue;
Eli Friedman71a26d82009-12-06 20:50:05 +00001644
1645 if (MD->hasInlineBody())
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001646 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001647
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001648 // We found it.
1649 return MD;
1650 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001651
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001652 return 0;
1653}
1654
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001655DiagnosticBuilder
1656RecordLayoutBuilder::Diag(SourceLocation Loc, unsigned DiagID) {
Argyrios Kyrtzidisd0040642010-11-18 20:06:41 +00001657 return Context.getDiagnostics().Report(Loc, DiagID);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001658}
1659
Benjamin Kramer2fc373e2010-10-22 16:33:16 +00001660namespace {
1661 // This class implements layout specific to the Microsoft ABI.
1662 class MSRecordLayoutBuilder : public RecordLayoutBuilder {
1663 public:
Jay Foad39c79802011-01-12 09:06:06 +00001664 MSRecordLayoutBuilder(const ASTContext& Ctx,
1665 EmptySubobjectMap *EmptySubobjects) :
Benjamin Kramer2fc373e2010-10-22 16:33:16 +00001666 RecordLayoutBuilder(Ctx, EmptySubobjects) {}
Charles Davisc2c576a2010-08-19 00:55:19 +00001667
Ken Dyckaab635e2011-03-01 01:22:45 +00001668 virtual CharUnits GetVirtualPointersSize(const CXXRecordDecl *RD) const;
Benjamin Kramer2fc373e2010-10-22 16:33:16 +00001669 };
1670}
Charles Davisc2c576a2010-08-19 00:55:19 +00001671
Ken Dyckaab635e2011-03-01 01:22:45 +00001672CharUnits
Charles Davisc2c576a2010-08-19 00:55:19 +00001673MSRecordLayoutBuilder::GetVirtualPointersSize(const CXXRecordDecl *RD) const {
1674 // We should reserve space for two pointers if the class has both
1675 // virtual functions and virtual bases.
Ken Dyckaab635e2011-03-01 01:22:45 +00001676 CharUnits PointerWidth =
1677 Context.toCharUnitsFromBits(Context.Target.getPointerWidth(0));
Charles Davisc2c576a2010-08-19 00:55:19 +00001678 if (RD->isPolymorphic() && RD->getNumVBases() > 0)
Ken Dyckaab635e2011-03-01 01:22:45 +00001679 return 2 * PointerWidth;
1680 return PointerWidth;
Charles Davisc2c576a2010-08-19 00:55:19 +00001681}
1682
Anders Carlssondf291d82010-05-26 04:56:53 +00001683/// getASTRecordLayout - Get or compute information about the layout of the
1684/// specified record (struct/union/class), which indicates its size and field
1685/// position information.
Jay Foad39c79802011-01-12 09:06:06 +00001686const ASTRecordLayout &
1687ASTContext::getASTRecordLayout(const RecordDecl *D) const {
Anders Carlssondf291d82010-05-26 04:56:53 +00001688 D = D->getDefinition();
1689 assert(D && "Cannot get layout of forward declarations!");
1690
1691 // Look up this layout, if already laid out, return what we have.
1692 // Note that we can't save a reference to the entry because this function
1693 // is recursive.
1694 const ASTRecordLayout *Entry = ASTRecordLayouts[D];
1695 if (Entry) return *Entry;
1696
Anders Carlssond2954862010-05-26 05:10:47 +00001697 const ASTRecordLayout *NewEntry;
1698
1699 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
Anders Carlssonc121b4e2010-05-27 00:07:01 +00001700 EmptySubobjectMap EmptySubobjects(*this, RD);
Anders Carlsson439edd12010-05-27 05:41:06 +00001701
Charles Davisc2c576a2010-08-19 00:55:19 +00001702 // When compiling for Microsoft, use the special MS builder.
Argyrios Kyrtzidis3c6cd172010-08-25 00:32:14 +00001703 llvm::OwningPtr<RecordLayoutBuilder> Builder;
Charles Davis6bcb07a2010-08-19 02:18:14 +00001704 switch (Target.getCXXABI()) {
1705 default:
Argyrios Kyrtzidis3c6cd172010-08-25 00:32:14 +00001706 Builder.reset(new RecordLayoutBuilder(*this, &EmptySubobjects));
Charles Davis6bcb07a2010-08-19 02:18:14 +00001707 break;
1708 case CXXABI_Microsoft:
Argyrios Kyrtzidis3c6cd172010-08-25 00:32:14 +00001709 Builder.reset(new MSRecordLayoutBuilder(*this, &EmptySubobjects));
Charles Davis6bcb07a2010-08-19 02:18:14 +00001710 }
Ted Kremenekf75d0892011-03-19 01:00:36 +00001711 // Recover resources if we crash before exiting this method.
Ted Kremenek022dbc12011-03-22 01:15:19 +00001712 llvm::CrashRecoveryContextCleanupRegistrar<RecordLayoutBuilder>
1713 RecordBuilderCleanup(Builder.get());
Ted Kremenekf75d0892011-03-19 01:00:36 +00001714
Charles Davisc2c576a2010-08-19 00:55:19 +00001715 Builder->Layout(RD);
Anders Carlssond2954862010-05-26 05:10:47 +00001716
1717 // FIXME: This is not always correct. See the part about bitfields at
1718 // http://www.codesourcery.com/public/cxx-abi/abi.html#POD for more info.
1719 // FIXME: IsPODForThePurposeOfLayout should be stored in the record layout.
1720 bool IsPODForThePurposeOfLayout = cast<CXXRecordDecl>(D)->isPOD();
1721
1722 // FIXME: This should be done in FinalizeLayout.
Ken Dyck1b4420e2011-02-28 02:01:38 +00001723 CharUnits DataSize =
1724 IsPODForThePurposeOfLayout ? Builder->getSize() : Builder->getDataSize();
1725 CharUnits NonVirtualSize =
1726 IsPODForThePurposeOfLayout ? DataSize : Builder->NonVirtualSize;
Anders Carlssond2954862010-05-26 05:10:47 +00001727
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001728 NewEntry =
Ken Dyck1b4420e2011-02-28 02:01:38 +00001729 new (*this) ASTRecordLayout(*this, Builder->getSize(),
Ken Dyck4731d5b2011-02-16 02:05:21 +00001730 Builder->Alignment,
Ken Dyck1b4420e2011-02-28 02:01:38 +00001731 DataSize,
Ken Dyckd5090c12011-02-11 02:20:09 +00001732 Builder->FieldOffsets.data(),
Charles Davisc2c576a2010-08-19 00:55:19 +00001733 Builder->FieldOffsets.size(),
Ken Dyckaf1c83f2011-02-16 01:52:01 +00001734 NonVirtualSize,
Ken Dycka2d3dda2011-02-16 01:43:15 +00001735 Builder->NonVirtualAlignment,
Anders Carlssonc121b4e2010-05-27 00:07:01 +00001736 EmptySubobjects.SizeOfLargestEmptySubobject,
Charles Davisc2c576a2010-08-19 00:55:19 +00001737 Builder->PrimaryBase,
1738 Builder->PrimaryBaseIsVirtual,
1739 Builder->Bases, Builder->VBases);
Anders Carlssond2954862010-05-26 05:10:47 +00001740 } else {
Anders Carlssonc121b4e2010-05-27 00:07:01 +00001741 RecordLayoutBuilder Builder(*this, /*EmptySubobjects=*/0);
Anders Carlssond2954862010-05-26 05:10:47 +00001742 Builder.Layout(D);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001743
Anders Carlssond2954862010-05-26 05:10:47 +00001744 NewEntry =
Ken Dyck1b4420e2011-02-28 02:01:38 +00001745 new (*this) ASTRecordLayout(*this, Builder.getSize(),
Ken Dyck4731d5b2011-02-16 02:05:21 +00001746 Builder.Alignment,
Ken Dyck1b4420e2011-02-28 02:01:38 +00001747 Builder.getSize(),
Anders Carlssond2954862010-05-26 05:10:47 +00001748 Builder.FieldOffsets.data(),
1749 Builder.FieldOffsets.size());
1750 }
1751
Anders Carlssondf291d82010-05-26 04:56:53 +00001752 ASTRecordLayouts[D] = NewEntry;
1753
1754 if (getLangOptions().DumpRecordLayouts) {
1755 llvm::errs() << "\n*** Dumping AST Record Layout\n";
1756 DumpRecordLayout(D, llvm::errs());
1757 }
1758
1759 return *NewEntry;
1760}
1761
1762const CXXMethodDecl *ASTContext::getKeyFunction(const CXXRecordDecl *RD) {
1763 RD = cast<CXXRecordDecl>(RD->getDefinition());
1764 assert(RD && "Cannot get key function for forward declarations!");
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001765
Anders Carlssondf291d82010-05-26 04:56:53 +00001766 const CXXMethodDecl *&Entry = KeyFunctions[RD];
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001767 if (!Entry)
Anders Carlssonc2226202010-05-26 05:58:59 +00001768 Entry = RecordLayoutBuilder::ComputeKeyFunction(RD);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001769
Anders Carlssondf291d82010-05-26 04:56:53 +00001770 return Entry;
1771}
1772
1773/// getInterfaceLayoutImpl - Get or compute information about the
1774/// layout of the given interface.
1775///
1776/// \param Impl - If given, also include the layout of the interface's
1777/// implementation. This may differ by including synthesized ivars.
1778const ASTRecordLayout &
1779ASTContext::getObjCLayout(const ObjCInterfaceDecl *D,
Jay Foad39c79802011-01-12 09:06:06 +00001780 const ObjCImplementationDecl *Impl) const {
Anders Carlssondf291d82010-05-26 04:56:53 +00001781 assert(!D->isForwardDecl() && "Invalid interface decl!");
1782
1783 // Look up this layout, if already laid out, return what we have.
1784 ObjCContainerDecl *Key =
1785 Impl ? (ObjCContainerDecl*) Impl : (ObjCContainerDecl*) D;
1786 if (const ASTRecordLayout *Entry = ObjCLayouts[Key])
1787 return *Entry;
1788
1789 // Add in synthesized ivar count if laying out an implementation.
1790 if (Impl) {
1791 unsigned SynthCount = CountNonClassIvars(D);
1792 // If there aren't any sythesized ivars then reuse the interface
1793 // entry. Note we can't cache this because we simply free all
1794 // entries later; however we shouldn't look up implementations
1795 // frequently.
1796 if (SynthCount == 0)
1797 return getObjCLayout(D, 0);
1798 }
1799
Anders Carlssonc121b4e2010-05-27 00:07:01 +00001800 RecordLayoutBuilder Builder(*this, /*EmptySubobjects=*/0);
Anders Carlsson6ed3a9a2010-05-26 05:04:25 +00001801 Builder.Layout(D);
1802
Anders Carlssondf291d82010-05-26 04:56:53 +00001803 const ASTRecordLayout *NewEntry =
Ken Dyck1b4420e2011-02-28 02:01:38 +00001804 new (*this) ASTRecordLayout(*this, Builder.getSize(),
Ken Dyck4731d5b2011-02-16 02:05:21 +00001805 Builder.Alignment,
Ken Dyck1b4420e2011-02-28 02:01:38 +00001806 Builder.getDataSize(),
Anders Carlsson6ed3a9a2010-05-26 05:04:25 +00001807 Builder.FieldOffsets.data(),
1808 Builder.FieldOffsets.size());
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001809
Anders Carlssondf291d82010-05-26 04:56:53 +00001810 ObjCLayouts[Key] = NewEntry;
1811
1812 return *NewEntry;
1813}
1814
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001815static void PrintOffset(llvm::raw_ostream &OS,
Anders Carlsson3f018712010-10-31 23:45:59 +00001816 CharUnits Offset, unsigned IndentLevel) {
1817 OS << llvm::format("%4d | ", Offset.getQuantity());
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001818 OS.indent(IndentLevel * 2);
1819}
1820
1821static void DumpCXXRecordLayout(llvm::raw_ostream &OS,
Jay Foad39c79802011-01-12 09:06:06 +00001822 const CXXRecordDecl *RD, const ASTContext &C,
Anders Carlsson3f018712010-10-31 23:45:59 +00001823 CharUnits Offset,
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001824 unsigned IndentLevel,
1825 const char* Description,
1826 bool IncludeVirtualBases) {
Anders Carlsson3f018712010-10-31 23:45:59 +00001827 const ASTRecordLayout &Layout = C.getASTRecordLayout(RD);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001828
1829 PrintOffset(OS, Offset, IndentLevel);
Dan Gohman145f3f12010-04-19 16:39:44 +00001830 OS << C.getTypeDeclType(const_cast<CXXRecordDecl *>(RD)).getAsString();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001831 if (Description)
1832 OS << ' ' << Description;
1833 if (RD->isEmpty())
1834 OS << " (empty)";
1835 OS << '\n';
1836
1837 IndentLevel++;
1838
Anders Carlsson3f018712010-10-31 23:45:59 +00001839 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001840
1841 // Vtable pointer.
1842 if (RD->isDynamicClass() && !PrimaryBase) {
1843 PrintOffset(OS, Offset, IndentLevel);
Benjamin Kramerb11416d2010-04-17 09:33:03 +00001844 OS << '(' << RD << " vtable pointer)\n";
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001845 }
1846 // Dump (non-virtual) bases
1847 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1848 E = RD->bases_end(); I != E; ++I) {
1849 assert(!I->getType()->isDependentType() &&
1850 "Cannot layout class with dependent bases.");
1851 if (I->isVirtual())
1852 continue;
1853
1854 const CXXRecordDecl *Base =
1855 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1856
Anders Carlsson3f018712010-10-31 23:45:59 +00001857 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001858
1859 DumpCXXRecordLayout(OS, Base, C, BaseOffset, IndentLevel,
1860 Base == PrimaryBase ? "(primary base)" : "(base)",
1861 /*IncludeVirtualBases=*/false);
1862 }
1863
1864 // Dump fields.
1865 uint64_t FieldNo = 0;
1866 for (CXXRecordDecl::field_iterator I = RD->field_begin(),
1867 E = RD->field_end(); I != E; ++I, ++FieldNo) {
1868 const FieldDecl *Field = *I;
Anders Carlsson3f018712010-10-31 23:45:59 +00001869 CharUnits FieldOffset = Offset +
Ken Dyck86a7fcc2011-01-18 01:56:16 +00001870 C.toCharUnitsFromBits(Layout.getFieldOffset(FieldNo));
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001871
1872 if (const RecordType *RT = Field->getType()->getAs<RecordType>()) {
1873 if (const CXXRecordDecl *D = dyn_cast<CXXRecordDecl>(RT->getDecl())) {
1874 DumpCXXRecordLayout(OS, D, C, FieldOffset, IndentLevel,
Daniel Dunbar56df9772010-08-17 22:39:59 +00001875 Field->getName().data(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001876 /*IncludeVirtualBases=*/true);
1877 continue;
1878 }
1879 }
1880
1881 PrintOffset(OS, FieldOffset, IndentLevel);
Benjamin Kramerb11416d2010-04-17 09:33:03 +00001882 OS << Field->getType().getAsString() << ' ' << Field << '\n';
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001883 }
1884
1885 if (!IncludeVirtualBases)
1886 return;
1887
1888 // Dump virtual bases.
1889 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
1890 E = RD->vbases_end(); I != E; ++I) {
1891 assert(I->isVirtual() && "Found non-virtual class!");
1892 const CXXRecordDecl *VBase =
1893 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1894
Anders Carlsson3f018712010-10-31 23:45:59 +00001895 CharUnits VBaseOffset = Offset + Layout.getVBaseClassOffset(VBase);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001896 DumpCXXRecordLayout(OS, VBase, C, VBaseOffset, IndentLevel,
1897 VBase == PrimaryBase ?
1898 "(primary virtual base)" : "(virtual base)",
1899 /*IncludeVirtualBases=*/false);
1900 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001901
Ken Dyckc8ae5502011-02-09 01:59:34 +00001902 OS << " sizeof=" << Layout.getSize().getQuantity();
Ken Dyckd5090c12011-02-11 02:20:09 +00001903 OS << ", dsize=" << Layout.getDataSize().getQuantity();
Ken Dyck7ad11e72011-02-15 02:32:40 +00001904 OS << ", align=" << Layout.getAlignment().getQuantity() << '\n';
Ken Dyck316d6f62011-02-01 01:52:10 +00001905 OS << " nvsize=" << Layout.getNonVirtualSize().getQuantity();
Ken Dyckbec02852011-02-08 02:02:47 +00001906 OS << ", nvalign=" << Layout.getNonVirtualAlign().getQuantity() << '\n';
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001907 OS << '\n';
1908}
Daniel Dunbarccabe482010-04-19 20:44:53 +00001909
1910void ASTContext::DumpRecordLayout(const RecordDecl *RD,
Jay Foad39c79802011-01-12 09:06:06 +00001911 llvm::raw_ostream &OS) const {
Daniel Dunbarccabe482010-04-19 20:44:53 +00001912 const ASTRecordLayout &Info = getASTRecordLayout(RD);
1913
1914 if (const CXXRecordDecl *CXXRD = dyn_cast<CXXRecordDecl>(RD))
Anders Carlsson3f018712010-10-31 23:45:59 +00001915 return DumpCXXRecordLayout(OS, CXXRD, *this, CharUnits(), 0, 0,
Daniel Dunbarccabe482010-04-19 20:44:53 +00001916 /*IncludeVirtualBases=*/true);
1917
1918 OS << "Type: " << getTypeDeclType(RD).getAsString() << "\n";
1919 OS << "Record: ";
1920 RD->dump();
1921 OS << "\nLayout: ";
1922 OS << "<ASTRecordLayout\n";
Ken Dyckb0fcc592011-02-11 01:54:29 +00001923 OS << " Size:" << toBits(Info.getSize()) << "\n";
Ken Dyckd5090c12011-02-11 02:20:09 +00001924 OS << " DataSize:" << toBits(Info.getDataSize()) << "\n";
Ken Dyck7ad11e72011-02-15 02:32:40 +00001925 OS << " Alignment:" << toBits(Info.getAlignment()) << "\n";
Daniel Dunbarccabe482010-04-19 20:44:53 +00001926 OS << " FieldOffsets: [";
1927 for (unsigned i = 0, e = Info.getFieldCount(); i != e; ++i) {
1928 if (i) OS << ", ";
1929 OS << Info.getFieldOffset(i);
1930 }
1931 OS << "]>\n";
1932}