blob: 2203ed13243512a44fb861024c4a853159266a3d [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;
Fariborz Jahanianbcb23a12011-04-26 23:52:16 +0000567
568 unsigned IsMsStruct : 1;
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000569
570 /// UnfilledBitsInLastByte - If the last field laid out was a bitfield,
571 /// this contains the number of bits in the last byte that can be used for
572 /// an adjacent bitfield if necessary.
573 unsigned char UnfilledBitsInLastByte;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000574
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000575 /// MaxFieldAlignment - The maximum allowed field alignment. This is set by
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000576 /// #pragma pack.
Ken Dyck02ced6f2011-02-17 01:49:42 +0000577 CharUnits MaxFieldAlignment;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000578
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000579 /// DataSize - The data size of the record being laid out.
580 uint64_t DataSize;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000581
Ken Dyckaf1c83f2011-02-16 01:52:01 +0000582 CharUnits NonVirtualSize;
Ken Dycka2d3dda2011-02-16 01:43:15 +0000583 CharUnits NonVirtualAlignment;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000584
Fariborz Jahanianfc0fe6e2011-05-03 20:21:04 +0000585 FieldDecl *ZeroLengthBitfield;
Fariborz Jahanianeb397412011-05-02 17:20:56 +0000586
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000587 /// PrimaryBase - the primary base class (if one exists) of the class
588 /// we're laying out.
589 const CXXRecordDecl *PrimaryBase;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000590
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000591 /// PrimaryBaseIsVirtual - Whether the primary base of the class we're laying
592 /// out is virtual.
593 bool PrimaryBaseIsVirtual;
594
Anders Carlsson22f57202010-10-31 21:01:46 +0000595 typedef llvm::DenseMap<const CXXRecordDecl *, CharUnits> BaseOffsetsMapTy;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000596
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000597 /// Bases - base classes and their offsets in the record.
598 BaseOffsetsMapTy Bases;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000599
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000600 // VBases - virtual base classes and their offsets in the record.
601 BaseOffsetsMapTy VBases;
602
603 /// IndirectPrimaryBases - Virtual base classes, direct or indirect, that are
604 /// primary base classes for some other direct or indirect base class.
Anders Carlsson5adde292010-11-24 22:55:48 +0000605 CXXIndirectPrimaryBaseSet IndirectPrimaryBases;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000606
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000607 /// FirstNearlyEmptyVBase - The first nearly empty virtual base class in
608 /// inheritance graph order. Used for determining the primary base class.
609 const CXXRecordDecl *FirstNearlyEmptyVBase;
610
611 /// VisitedVirtualBases - A set of all the visited virtual bases, used to
612 /// avoid visiting virtual bases more than once.
613 llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBases;
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000614
Jay Foad39c79802011-01-12 09:06:06 +0000615 RecordLayoutBuilder(const ASTContext &Context, EmptySubobjectMap
616 *EmptySubobjects)
Ken Dyck4731d5b2011-02-16 02:05:21 +0000617 : Context(Context), EmptySubobjects(EmptySubobjects), Size(0),
Ken Dyck1300b3b2011-02-16 02:11:31 +0000618 Alignment(CharUnits::One()), UnpackedAlignment(Alignment),
Fariborz Jahanianbcb23a12011-04-26 23:52:16 +0000619 Packed(false), IsUnion(false),
620 IsMac68kAlign(false), IsMsStruct(false),
Ken Dyck02ced6f2011-02-17 01:49:42 +0000621 UnfilledBitsInLastByte(0), MaxFieldAlignment(CharUnits::Zero()),
622 DataSize(0), NonVirtualSize(CharUnits::Zero()),
Fariborz Jahanianeb397412011-05-02 17:20:56 +0000623 NonVirtualAlignment(CharUnits::One()),
Fariborz Jahanianfc0fe6e2011-05-03 20:21:04 +0000624 ZeroLengthBitfield(0), PrimaryBase(0),
Ken Dyck02ced6f2011-02-17 01:49:42 +0000625 PrimaryBaseIsVirtual(false), FirstNearlyEmptyVBase(0) { }
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000626
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000627 void Layout(const RecordDecl *D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000628 void Layout(const CXXRecordDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000629 void Layout(const ObjCInterfaceDecl *D);
630
631 void LayoutFields(const RecordDecl *D);
632 void LayoutField(const FieldDecl *D);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000633 void LayoutWideBitField(uint64_t FieldSize, uint64_t TypeSize,
634 bool FieldPacked, const FieldDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000635 void LayoutBitField(const FieldDecl *D);
636
Anders Carlssone3c24c72010-05-29 17:35:14 +0000637 /// BaseSubobjectInfoAllocator - Allocator for BaseSubobjectInfo objects.
638 llvm::SpecificBumpPtrAllocator<BaseSubobjectInfo> BaseSubobjectInfoAllocator;
639
640 typedef llvm::DenseMap<const CXXRecordDecl *, BaseSubobjectInfo *>
641 BaseSubobjectInfoMapTy;
642
643 /// VirtualBaseInfo - Map from all the (direct or indirect) virtual bases
644 /// of the class we're laying out to their base subobject info.
645 BaseSubobjectInfoMapTy VirtualBaseInfo;
646
647 /// NonVirtualBaseInfo - Map from all the direct non-virtual bases of the
648 /// class we're laying out to their base subobject info.
649 BaseSubobjectInfoMapTy NonVirtualBaseInfo;
650
651 /// ComputeBaseSubobjectInfo - Compute the base subobject information for the
652 /// bases of the given class.
653 void ComputeBaseSubobjectInfo(const CXXRecordDecl *RD);
654
655 /// ComputeBaseSubobjectInfo - Compute the base subobject information for a
656 /// single class and all of its base classes.
657 BaseSubobjectInfo *ComputeBaseSubobjectInfo(const CXXRecordDecl *RD,
658 bool IsVirtual,
659 BaseSubobjectInfo *Derived);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000660
661 /// DeterminePrimaryBase - Determine the primary base of the given class.
662 void DeterminePrimaryBase(const CXXRecordDecl *RD);
663
664 void SelectPrimaryVBase(const CXXRecordDecl *RD);
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000665
Ken Dyckaab635e2011-03-01 01:22:45 +0000666 virtual CharUnits GetVirtualPointersSize(const CXXRecordDecl *RD) const;
Charles Davisc2c576a2010-08-19 00:55:19 +0000667
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000668 /// LayoutNonVirtualBases - Determines the primary base class (if any) and
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000669 /// lays it out. Will then proceed to lay out all non-virtual base clasess.
670 void LayoutNonVirtualBases(const CXXRecordDecl *RD);
671
672 /// LayoutNonVirtualBase - Lays out a single non-virtual base.
Anders Carlssonbb0e6782010-05-29 17:42:25 +0000673 void LayoutNonVirtualBase(const BaseSubobjectInfo *Base);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000674
Anders Carlssona2f8e412010-10-31 22:20:42 +0000675 void AddPrimaryVirtualBaseOffsets(const BaseSubobjectInfo *Info,
676 CharUnits Offset);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000677
678 /// LayoutVirtualBases - Lays out all the virtual bases.
679 void LayoutVirtualBases(const CXXRecordDecl *RD,
680 const CXXRecordDecl *MostDerivedClass);
681
682 /// LayoutVirtualBase - Lays out a single virtual base.
Anders Carlssond6ff5d72010-05-29 17:48:36 +0000683 void LayoutVirtualBase(const BaseSubobjectInfo *Base);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000684
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000685 /// LayoutBase - Will lay out a base and return the offset where it was
Anders Carlssona2f8e412010-10-31 22:20:42 +0000686 /// placed, in chars.
687 CharUnits LayoutBase(const BaseSubobjectInfo *Base);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000688
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000689 /// InitializeLayout - Initialize record layout for the given record decl.
Daniel Dunbar6da10982010-05-27 05:45:51 +0000690 void InitializeLayout(const Decl *D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +0000691
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000692 /// FinishLayout - Finalize record layout. Adjust record size based on the
693 /// alignment.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000694 void FinishLayout(const NamedDecl *D);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000695
Ken Dyck85ef0432011-02-19 18:58:07 +0000696 void UpdateAlignment(CharUnits NewAlignment, CharUnits UnpackedNewAlignment);
697 void UpdateAlignment(CharUnits NewAlignment) {
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +0000698 UpdateAlignment(NewAlignment, NewAlignment);
699 }
700
701 void CheckFieldPadding(uint64_t Offset, uint64_t UnpaddedOffset,
702 uint64_t UnpackedOffset, unsigned UnpackedAlign,
703 bool isPacked, const FieldDecl *D);
704
705 DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID);
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000706
Ken Dyckecfc7552011-02-24 01:13:28 +0000707 CharUnits getSize() const {
Ken Dyck3c215f22011-02-24 01:33:05 +0000708 assert(Size % Context.getCharWidth() == 0);
Ken Dyckecfc7552011-02-24 01:13:28 +0000709 return Context.toCharUnitsFromBits(Size);
710 }
711 uint64_t getSizeInBits() const { return Size; }
712
713 void setSize(CharUnits NewSize) { Size = Context.toBits(NewSize); }
714 void setSize(uint64_t NewSize) { Size = NewSize; }
715
716 CharUnits getDataSize() const {
Ken Dyck3c215f22011-02-24 01:33:05 +0000717 assert(DataSize % Context.getCharWidth() == 0);
Ken Dyckecfc7552011-02-24 01:13:28 +0000718 return Context.toCharUnitsFromBits(DataSize);
719 }
720 uint64_t getDataSizeInBits() const { return DataSize; }
721
722 void setDataSize(CharUnits NewSize) { DataSize = Context.toBits(NewSize); }
723 void setDataSize(uint64_t NewSize) { DataSize = NewSize; }
724
725
Argyrios Kyrtzidis499e6e42010-08-15 10:17:39 +0000726 RecordLayoutBuilder(const RecordLayoutBuilder&); // DO NOT IMPLEMENT
727 void operator=(const RecordLayoutBuilder&); // DO NOT IMPLEMENT
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000728public:
729 static const CXXMethodDecl *ComputeKeyFunction(const CXXRecordDecl *RD);
Argyrios Kyrtzidis3c6cd172010-08-25 00:32:14 +0000730
731 virtual ~RecordLayoutBuilder() { }
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000732};
Benjamin Kramerc7656cd2010-05-26 09:58:31 +0000733} // end anonymous namespace
Anders Carlsson35a36eb2010-05-26 05:41:04 +0000734
Anders Carlsson81430692009-09-22 03:02:06 +0000735void
Anders Carlssonc2226202010-05-26 05:58:59 +0000736RecordLayoutBuilder::SelectPrimaryVBase(const CXXRecordDecl *RD) {
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000737 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000738 E = RD->bases_end(); I != E; ++I) {
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000739 assert(!I->getType()->isDependentType() &&
Sebastian Redl1054fae2009-10-25 17:03:50 +0000740 "Cannot layout class with dependent bases.");
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000741
Mike Stump11289f42009-09-09 15:08:12 +0000742 const CXXRecordDecl *Base =
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000743 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000744
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000745 // Check if this is a nearly empty virtual base.
Anders Carlsson60a62632010-11-25 01:51:53 +0000746 if (I->isVirtual() && Context.isNearlyEmpty(Base)) {
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000747 // If it's not an indirect primary base, then we've found our primary
748 // base.
Anders Carlsson81430692009-09-22 03:02:06 +0000749 if (!IndirectPrimaryBases.count(Base)) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000750 PrimaryBase = Base;
751 PrimaryBaseIsVirtual = true;
Mike Stump6f3793b2009-08-12 21:50:08 +0000752 return;
753 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000754
Anders Carlssonf2fa75b2010-03-11 03:39:12 +0000755 // Is this the first nearly empty virtual base?
756 if (!FirstNearlyEmptyVBase)
757 FirstNearlyEmptyVBase = Base;
Mike Stump6f3793b2009-08-12 21:50:08 +0000758 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000759
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000760 SelectPrimaryVBase(Base);
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000761 if (PrimaryBase)
Zhongxing Xuec345b72010-02-15 04:28:35 +0000762 return;
Mike Stump6f3793b2009-08-12 21:50:08 +0000763 }
764}
765
Ken Dyckaab635e2011-03-01 01:22:45 +0000766CharUnits
Charles Davisc2c576a2010-08-19 00:55:19 +0000767RecordLayoutBuilder::GetVirtualPointersSize(const CXXRecordDecl *RD) const {
Ken Dyckaab635e2011-03-01 01:22:45 +0000768 return Context.toCharUnitsFromBits(Context.Target.getPointerWidth(0));
Charles Davisc2c576a2010-08-19 00:55:19 +0000769}
770
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000771/// DeterminePrimaryBase - Determine the primary base of the given class.
Anders Carlssonc2226202010-05-26 05:58:59 +0000772void RecordLayoutBuilder::DeterminePrimaryBase(const CXXRecordDecl *RD) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000773 // If the class isn't dynamic, it won't have a primary base.
774 if (!RD->isDynamicClass())
775 return;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000776
Anders Carlsson81430692009-09-22 03:02:06 +0000777 // Compute all the primary virtual bases for all of our direct and
Mike Stump590a7c72009-08-13 23:26:06 +0000778 // indirect bases, and record all their primary virtual base classes.
Anders Carlsson5adde292010-11-24 22:55:48 +0000779 RD->getIndirectPrimaryBases(IndirectPrimaryBases);
Mike Stump590a7c72009-08-13 23:26:06 +0000780
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000781 // If the record has a dynamic base class, attempt to choose a primary base
782 // class. It is the first (in direct base class order) non-virtual dynamic
Anders Carlsson81430692009-09-22 03:02:06 +0000783 // base class, if one exists.
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000784 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000785 e = RD->bases_end(); i != e; ++i) {
Anders Carlsson03ff3792009-11-27 22:05:05 +0000786 // Ignore virtual bases.
787 if (i->isVirtual())
788 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000789
Anders Carlsson03ff3792009-11-27 22:05:05 +0000790 const CXXRecordDecl *Base =
791 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
792
793 if (Base->isDynamicClass()) {
794 // We found it.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000795 PrimaryBase = Base;
796 PrimaryBaseIsVirtual = false;
Anders Carlsson03ff3792009-11-27 22:05:05 +0000797 return;
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000798 }
799 }
800
801 // Otherwise, it is the first nearly empty virtual base that is not an
Mike Stump78696a72009-08-11 04:03:59 +0000802 // indirect primary virtual base class, if one exists.
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000803 if (RD->getNumVBases() != 0) {
804 SelectPrimaryVBase(RD);
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000805 if (PrimaryBase)
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000806 return;
807 }
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000808
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000809 // Otherwise, it is the first nearly empty virtual base that is not an
810 // indirect primary virtual base class, if one exists.
811 if (FirstNearlyEmptyVBase) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000812 PrimaryBase = FirstNearlyEmptyVBase;
813 PrimaryBaseIsVirtual = true;
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000814 return;
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000815 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000816
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000817 // Otherwise there is no primary base class.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000818 assert(!PrimaryBase && "Should not get here with a primary base!");
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000819
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000820 // Allocate the virtual table pointer at offset zero.
821 assert(DataSize == 0 && "Vtable pointer must be at offset zero!");
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000822
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000823 // Update the size.
Ken Dyckaab635e2011-03-01 01:22:45 +0000824 setSize(getSize() + GetVirtualPointersSize(RD));
Ken Dyck1b4420e2011-02-28 02:01:38 +0000825 setDataSize(getSize());
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000826
Ken Dyck85ef0432011-02-19 18:58:07 +0000827 CharUnits UnpackedBaseAlign =
828 Context.toCharUnitsFromBits(Context.Target.getPointerAlign(0));
829 CharUnits BaseAlign = (Packed) ? CharUnits::One() : UnpackedBaseAlign;
Argyrios Kyrtzidisd62c9be2010-12-09 02:47:58 +0000830
831 // The maximum field alignment overrides base align.
Ken Dyck02ced6f2011-02-17 01:49:42 +0000832 if (!MaxFieldAlignment.isZero()) {
Ken Dyck85ef0432011-02-19 18:58:07 +0000833 BaseAlign = std::min(BaseAlign, MaxFieldAlignment);
834 UnpackedBaseAlign = std::min(UnpackedBaseAlign, MaxFieldAlignment);
Argyrios Kyrtzidisd62c9be2010-12-09 02:47:58 +0000835 }
836
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000837 // Update the alignment.
Argyrios Kyrtzidisd62c9be2010-12-09 02:47:58 +0000838 UpdateAlignment(BaseAlign, UnpackedBaseAlign);
Mike Stumpd8fe7b22009-08-05 22:37:18 +0000839}
840
Anders Carlssone3c24c72010-05-29 17:35:14 +0000841BaseSubobjectInfo *
842RecordLayoutBuilder::ComputeBaseSubobjectInfo(const CXXRecordDecl *RD,
843 bool IsVirtual,
844 BaseSubobjectInfo *Derived) {
845 BaseSubobjectInfo *Info;
846
847 if (IsVirtual) {
848 // Check if we already have info about this virtual base.
849 BaseSubobjectInfo *&InfoSlot = VirtualBaseInfo[RD];
850 if (InfoSlot) {
851 assert(InfoSlot->Class == RD && "Wrong class for virtual base info!");
852 return InfoSlot;
853 }
854
855 // We don't, create it.
856 InfoSlot = new (BaseSubobjectInfoAllocator.Allocate()) BaseSubobjectInfo;
857 Info = InfoSlot;
858 } else {
859 Info = new (BaseSubobjectInfoAllocator.Allocate()) BaseSubobjectInfo;
860 }
861
862 Info->Class = RD;
863 Info->IsVirtual = IsVirtual;
864 Info->Derived = 0;
865 Info->PrimaryVirtualBaseInfo = 0;
866
867 const CXXRecordDecl *PrimaryVirtualBase = 0;
868 BaseSubobjectInfo *PrimaryVirtualBaseInfo = 0;
869
870 // Check if this base has a primary virtual base.
871 if (RD->getNumVBases()) {
872 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlsson7f95cd12010-11-24 23:12:57 +0000873 if (Layout.isPrimaryBaseVirtual()) {
Anders Carlssone3c24c72010-05-29 17:35:14 +0000874 // This base does have a primary virtual base.
875 PrimaryVirtualBase = Layout.getPrimaryBase();
876 assert(PrimaryVirtualBase && "Didn't have a primary virtual base!");
877
878 // Now check if we have base subobject info about this primary base.
879 PrimaryVirtualBaseInfo = VirtualBaseInfo.lookup(PrimaryVirtualBase);
880
881 if (PrimaryVirtualBaseInfo) {
882 if (PrimaryVirtualBaseInfo->Derived) {
883 // We did have info about this primary base, and it turns out that it
884 // has already been claimed as a primary virtual base for another
885 // base.
886 PrimaryVirtualBase = 0;
887 } else {
888 // We can claim this base as our primary base.
889 Info->PrimaryVirtualBaseInfo = PrimaryVirtualBaseInfo;
890 PrimaryVirtualBaseInfo->Derived = Info;
891 }
892 }
893 }
894 }
895
896 // Now go through all direct bases.
897 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
898 E = RD->bases_end(); I != E; ++I) {
899 bool IsVirtual = I->isVirtual();
900
901 const CXXRecordDecl *BaseDecl =
902 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
903
904 Info->Bases.push_back(ComputeBaseSubobjectInfo(BaseDecl, IsVirtual, Info));
905 }
906
907 if (PrimaryVirtualBase && !PrimaryVirtualBaseInfo) {
908 // Traversing the bases must have created the base info for our primary
909 // virtual base.
910 PrimaryVirtualBaseInfo = VirtualBaseInfo.lookup(PrimaryVirtualBase);
911 assert(PrimaryVirtualBaseInfo &&
912 "Did not create a primary virtual base!");
913
914 // Claim the primary virtual base as our primary virtual base.
915 Info->PrimaryVirtualBaseInfo = PrimaryVirtualBaseInfo;
916 PrimaryVirtualBaseInfo->Derived = Info;
917 }
918
919 return Info;
920}
921
922void RecordLayoutBuilder::ComputeBaseSubobjectInfo(const CXXRecordDecl *RD) {
923 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
924 E = RD->bases_end(); I != E; ++I) {
925 bool IsVirtual = I->isVirtual();
926
927 const CXXRecordDecl *BaseDecl =
928 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
929
930 // Compute the base subobject info for this base.
931 BaseSubobjectInfo *Info = ComputeBaseSubobjectInfo(BaseDecl, IsVirtual, 0);
932
933 if (IsVirtual) {
934 // ComputeBaseInfo has already added this base for us.
935 assert(VirtualBaseInfo.count(BaseDecl) &&
936 "Did not add virtual base!");
937 } else {
938 // Add the base info to the map of non-virtual bases.
939 assert(!NonVirtualBaseInfo.count(BaseDecl) &&
940 "Non-virtual base already exists!");
941 NonVirtualBaseInfo.insert(std::make_pair(BaseDecl, Info));
942 }
943 }
944}
945
Anders Carlsson09ffa322010-03-10 22:21:28 +0000946void
Anders Carlssonc2226202010-05-26 05:58:59 +0000947RecordLayoutBuilder::LayoutNonVirtualBases(const CXXRecordDecl *RD) {
Anders Carlssone3c24c72010-05-29 17:35:14 +0000948 // Then, determine the primary base class.
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000949 DeterminePrimaryBase(RD);
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000950
Anders Carlssone3c24c72010-05-29 17:35:14 +0000951 // Compute base subobject info.
952 ComputeBaseSubobjectInfo(RD);
953
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000954 // If we have a primary base class, lay it out.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000955 if (PrimaryBase) {
956 if (PrimaryBaseIsVirtual) {
Anders Carlssone3c24c72010-05-29 17:35:14 +0000957 // If the primary virtual base was a primary virtual base of some other
958 // base class we'll have to steal it.
959 BaseSubobjectInfo *PrimaryBaseInfo = VirtualBaseInfo.lookup(PrimaryBase);
960 PrimaryBaseInfo->Derived = 0;
961
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000962 // We have a virtual primary base, insert it as an indirect primary base.
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000963 IndirectPrimaryBases.insert(PrimaryBase);
Anders Carlssonfe900962010-03-11 05:42:17 +0000964
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000965 assert(!VisitedVirtualBases.count(PrimaryBase) &&
Anders Carlssond20e7cd2010-05-26 05:20:58 +0000966 "vbase already visited!");
967 VisitedVirtualBases.insert(PrimaryBase);
Daniel Dunbar592a85c2010-05-27 02:25:46 +0000968
Anders Carlssond6ff5d72010-05-29 17:48:36 +0000969 LayoutVirtualBase(PrimaryBaseInfo);
Anders Carlssonbb0e6782010-05-29 17:42:25 +0000970 } else {
971 BaseSubobjectInfo *PrimaryBaseInfo =
972 NonVirtualBaseInfo.lookup(PrimaryBase);
973 assert(PrimaryBaseInfo &&
974 "Did not find base info for non-virtual primary base!");
975
976 LayoutNonVirtualBase(PrimaryBaseInfo);
977 }
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000978 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000979
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000980 // Now lay out the non-virtual bases.
981 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +0000982 E = RD->bases_end(); I != E; ++I) {
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000983
984 // Ignore virtual bases.
985 if (I->isVirtual())
986 continue;
987
Anders Carlssonbb0e6782010-05-29 17:42:25 +0000988 const CXXRecordDecl *BaseDecl =
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000989 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
990
991 // Skip the primary base.
Anders Carlssonbb0e6782010-05-29 17:42:25 +0000992 if (BaseDecl == PrimaryBase && !PrimaryBaseIsVirtual)
Anders Carlsson8630b5b2010-03-11 00:15:35 +0000993 continue;
994
995 // Lay out the base.
Anders Carlssonbb0e6782010-05-29 17:42:25 +0000996 BaseSubobjectInfo *BaseInfo = NonVirtualBaseInfo.lookup(BaseDecl);
997 assert(BaseInfo && "Did not find base info for non-virtual base!");
998
999 LayoutNonVirtualBase(BaseInfo);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001000 }
1001}
1002
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001003void RecordLayoutBuilder::LayoutNonVirtualBase(const BaseSubobjectInfo *Base) {
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001004 // Layout the base.
Anders Carlssona2f8e412010-10-31 22:20:42 +00001005 CharUnits Offset = LayoutBase(Base);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001006
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001007 // Add its base class offset.
Anders Carlssonbb0e6782010-05-29 17:42:25 +00001008 assert(!Bases.count(Base->Class) && "base offset already exists!");
Anders Carlssona2f8e412010-10-31 22:20:42 +00001009 Bases.insert(std::make_pair(Base->Class, Offset));
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001010
1011 AddPrimaryVirtualBaseOffsets(Base, Offset);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001012}
Mike Stump2b84dd32009-11-05 04:02:15 +00001013
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001014void
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001015RecordLayoutBuilder::AddPrimaryVirtualBaseOffsets(const BaseSubobjectInfo *Info,
Anders Carlssona2f8e412010-10-31 22:20:42 +00001016 CharUnits Offset) {
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001017 // This base isn't interesting, it has no virtual bases.
1018 if (!Info->Class->getNumVBases())
1019 return;
1020
1021 // First, check if we have a virtual primary base to add offsets for.
1022 if (Info->PrimaryVirtualBaseInfo) {
1023 assert(Info->PrimaryVirtualBaseInfo->IsVirtual &&
1024 "Primary virtual base is not virtual!");
1025 if (Info->PrimaryVirtualBaseInfo->Derived == Info) {
1026 // Add the offset.
1027 assert(!VBases.count(Info->PrimaryVirtualBaseInfo->Class) &&
1028 "primary vbase offset already exists!");
1029 VBases.insert(std::make_pair(Info->PrimaryVirtualBaseInfo->Class,
Anders Carlssona2f8e412010-10-31 22:20:42 +00001030 Offset));
Anders Carlssonea7b1822010-04-15 16:12:58 +00001031
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001032 // Traverse the primary virtual base.
1033 AddPrimaryVirtualBaseOffsets(Info->PrimaryVirtualBaseInfo, Offset);
1034 }
Anders Carlssonea7b1822010-04-15 16:12:58 +00001035 }
1036
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001037 // Now go through all direct non-virtual bases.
1038 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Info->Class);
1039 for (unsigned I = 0, E = Info->Bases.size(); I != E; ++I) {
1040 const BaseSubobjectInfo *Base = Info->Bases[I];
1041 if (Base->IsVirtual)
Anders Carlssonea7b1822010-04-15 16:12:58 +00001042 continue;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001043
Anders Carlsson0a14ee92010-11-01 00:21:58 +00001044 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base->Class);
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001045 AddPrimaryVirtualBaseOffsets(Base, BaseOffset);
Anders Carlssonea7b1822010-04-15 16:12:58 +00001046 }
1047}
1048
1049void
Anders Carlssonc2226202010-05-26 05:58:59 +00001050RecordLayoutBuilder::LayoutVirtualBases(const CXXRecordDecl *RD,
Anders Carlssonea7b1822010-04-15 16:12:58 +00001051 const CXXRecordDecl *MostDerivedClass) {
Anders Carlssonde710c92010-03-11 04:33:54 +00001052 const CXXRecordDecl *PrimaryBase;
Anders Carlsson291279e2010-04-10 18:42:27 +00001053 bool PrimaryBaseIsVirtual;
Anders Carlssonfe900962010-03-11 05:42:17 +00001054
Anders Carlsson291279e2010-04-10 18:42:27 +00001055 if (MostDerivedClass == RD) {
Anders Carlssond20e7cd2010-05-26 05:20:58 +00001056 PrimaryBase = this->PrimaryBase;
1057 PrimaryBaseIsVirtual = this->PrimaryBaseIsVirtual;
Anders Carlsson291279e2010-04-10 18:42:27 +00001058 } else {
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001059 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlssonde710c92010-03-11 04:33:54 +00001060 PrimaryBase = Layout.getPrimaryBase();
Anders Carlsson7f95cd12010-11-24 23:12:57 +00001061 PrimaryBaseIsVirtual = Layout.isPrimaryBaseVirtual();
Anders Carlsson291279e2010-04-10 18:42:27 +00001062 }
1063
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001064 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1065 E = RD->bases_end(); I != E; ++I) {
1066 assert(!I->getType()->isDependentType() &&
Sebastian Redl1054fae2009-10-25 17:03:50 +00001067 "Cannot layout class with dependent bases.");
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001068
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001069 const CXXRecordDecl *BaseDecl =
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001070 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1071
1072 if (I->isVirtual()) {
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001073 if (PrimaryBase != BaseDecl || !PrimaryBaseIsVirtual) {
1074 bool IndirectPrimaryBase = IndirectPrimaryBases.count(BaseDecl);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001075
Anders Carlsson291279e2010-04-10 18:42:27 +00001076 // Only lay out the virtual base if it's not an indirect primary base.
1077 if (!IndirectPrimaryBase) {
1078 // Only visit virtual bases once.
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001079 if (!VisitedVirtualBases.insert(BaseDecl))
Anders Carlsson291279e2010-04-10 18:42:27 +00001080 continue;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001081
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001082 const BaseSubobjectInfo *BaseInfo = VirtualBaseInfo.lookup(BaseDecl);
1083 assert(BaseInfo && "Did not find virtual base info!");
1084 LayoutVirtualBase(BaseInfo);
Anders Carlsson6a848892010-03-11 04:10:39 +00001085 }
Mike Stump2b84dd32009-11-05 04:02:15 +00001086 }
Mike Stumpc2f591b2009-08-13 22:53:07 +00001087 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001088
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001089 if (!BaseDecl->getNumVBases()) {
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001090 // This base isn't interesting since it doesn't have any virtual bases.
1091 continue;
Mike Stump996576f32009-08-16 19:04:13 +00001092 }
Anders Carlssonf7b7a1e2010-03-11 04:24:02 +00001093
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001094 LayoutVirtualBases(BaseDecl, MostDerivedClass);
Mike Stump6b2556f2009-08-06 13:41:24 +00001095 }
1096}
1097
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001098void RecordLayoutBuilder::LayoutVirtualBase(const BaseSubobjectInfo *Base) {
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001099 assert(!Base->Derived && "Trying to lay out a primary virtual base!");
1100
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001101 // Layout the base.
Anders Carlssona2f8e412010-10-31 22:20:42 +00001102 CharUnits Offset = LayoutBase(Base);
Anders Carlsson0d0b5882010-03-10 22:26:24 +00001103
1104 // Add its base class offset.
Anders Carlssond6ff5d72010-05-29 17:48:36 +00001105 assert(!VBases.count(Base->Class) && "vbase offset already exists!");
Anders Carlssona2f8e412010-10-31 22:20:42 +00001106 VBases.insert(std::make_pair(Base->Class, Offset));
Anders Carlsson6b0d9142010-05-29 19:44:50 +00001107
1108 AddPrimaryVirtualBaseOffsets(Base, Offset);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001109}
1110
Anders Carlssona2f8e412010-10-31 22:20:42 +00001111CharUnits RecordLayoutBuilder::LayoutBase(const BaseSubobjectInfo *Base) {
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001112 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Base->Class);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001113
1114 // If we have an empty base class, try to place it at offset 0.
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001115 if (Base->Class->isEmpty() &&
Anders Carlsson28466ab2010-10-31 22:13:23 +00001116 EmptySubobjects->CanPlaceBaseAtOffset(Base, CharUnits::Zero())) {
Ken Dyck1b4420e2011-02-28 02:01:38 +00001117 setSize(std::max(getSize(), Layout.getSize()));
Anders Carlsson09ffa322010-03-10 22:21:28 +00001118
Anders Carlssona2f8e412010-10-31 22:20:42 +00001119 return CharUnits::Zero();
Anders Carlsson09ffa322010-03-10 22:21:28 +00001120 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001121
Ken Dyck85ef0432011-02-19 18:58:07 +00001122 CharUnits UnpackedBaseAlign = Layout.getNonVirtualAlign();
1123 CharUnits BaseAlign = (Packed) ? CharUnits::One() : UnpackedBaseAlign;
Argyrios Kyrtzidis8b542742010-12-09 00:35:20 +00001124
1125 // The maximum field alignment overrides base align.
Ken Dyck02ced6f2011-02-17 01:49:42 +00001126 if (!MaxFieldAlignment.isZero()) {
Ken Dyck85ef0432011-02-19 18:58:07 +00001127 BaseAlign = std::min(BaseAlign, MaxFieldAlignment);
1128 UnpackedBaseAlign = std::min(UnpackedBaseAlign, MaxFieldAlignment);
Argyrios Kyrtzidis8b542742010-12-09 00:35:20 +00001129 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001130
Anders Carlsson09ffa322010-03-10 22:21:28 +00001131 // Round up the current record size to the base's alignment boundary.
Ken Dyck1b4420e2011-02-28 02:01:38 +00001132 CharUnits Offset = getDataSize().RoundUpToAlignment(BaseAlign);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001133
Anders Carlsson09ffa322010-03-10 22:21:28 +00001134 // Try to place the base.
Ken Dyck1b4420e2011-02-28 02:01:38 +00001135 while (!EmptySubobjects->CanPlaceBaseAtOffset(Base, Offset))
1136 Offset += BaseAlign;
Anders Carlsson09ffa322010-03-10 22:21:28 +00001137
Anders Carlssond7f3fcf2010-05-29 20:47:33 +00001138 if (!Base->Class->isEmpty()) {
Anders Carlsson09ffa322010-03-10 22:21:28 +00001139 // Update the data size.
Ken Dyck1b4420e2011-02-28 02:01:38 +00001140 setDataSize(Offset + Layout.getNonVirtualSize());
Anders Carlsson09ffa322010-03-10 22:21:28 +00001141
Ken Dyck1b4420e2011-02-28 02:01:38 +00001142 setSize(std::max(getSize(), getDataSize()));
Anders Carlsson09ffa322010-03-10 22:21:28 +00001143 } else
Ken Dyck1b4420e2011-02-28 02:01:38 +00001144 setSize(std::max(getSize(), Offset + Layout.getSize()));
Anders Carlsson09ffa322010-03-10 22:21:28 +00001145
1146 // Remember max struct/class alignment.
Argyrios Kyrtzidis8b542742010-12-09 00:35:20 +00001147 UpdateAlignment(BaseAlign, UnpackedBaseAlign);
Anders Carlsson09ffa322010-03-10 22:21:28 +00001148
Ken Dyck1b4420e2011-02-28 02:01:38 +00001149 return Offset;
Anders Carlsson09ffa322010-03-10 22:21:28 +00001150}
1151
Daniel Dunbar6da10982010-05-27 05:45:51 +00001152void RecordLayoutBuilder::InitializeLayout(const Decl *D) {
1153 if (const RecordDecl *RD = dyn_cast<RecordDecl>(D))
1154 IsUnion = RD->isUnion();
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001155
Anders Carlsson28a5fa22009-08-08 19:38:24 +00001156 Packed = D->hasAttr<PackedAttr>();
Fariborz Jahanianbcb23a12011-04-26 23:52:16 +00001157
1158 IsMsStruct = D->hasAttr<MsStructAttr>();
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001159
Daniel Dunbar6da10982010-05-27 05:45:51 +00001160 // mac68k alignment supersedes maximum field alignment and attribute aligned,
1161 // and forces all structures to have 2-byte alignment. The IBM docs on it
1162 // allude to additional (more complicated) semantics, especially with regard
1163 // to bit-fields, but gcc appears not to follow that.
1164 if (D->hasAttr<AlignMac68kAttr>()) {
1165 IsMac68kAlign = true;
Ken Dyck02ced6f2011-02-17 01:49:42 +00001166 MaxFieldAlignment = CharUnits::fromQuantity(2);
Ken Dyck4731d5b2011-02-16 02:05:21 +00001167 Alignment = CharUnits::fromQuantity(2);
Daniel Dunbar6da10982010-05-27 05:45:51 +00001168 } else {
1169 if (const MaxFieldAlignmentAttr *MFAA = D->getAttr<MaxFieldAlignmentAttr>())
Ken Dyck02ced6f2011-02-17 01:49:42 +00001170 MaxFieldAlignment = Context.toCharUnitsFromBits(MFAA->getAlignment());
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001171
Alexis Huntdcfba7b2010-08-18 23:23:40 +00001172 if (unsigned MaxAlign = D->getMaxAlignment())
Ken Dyck85ef0432011-02-19 18:58:07 +00001173 UpdateAlignment(Context.toCharUnitsFromBits(MaxAlign));
Daniel Dunbar6da10982010-05-27 05:45:51 +00001174 }
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001175}
Anders Carlsson6d9f6f32009-07-19 00:18:47 +00001176
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001177void RecordLayoutBuilder::Layout(const RecordDecl *D) {
1178 InitializeLayout(D);
Anders Carlsson118ce162009-07-18 21:48:39 +00001179 LayoutFields(D);
Mike Stump11289f42009-09-09 15:08:12 +00001180
Anders Carlsson79474332009-07-18 20:20:21 +00001181 // Finally, round the size of the total struct up to the alignment of the
1182 // struct itself.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001183 FinishLayout(D);
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001184}
1185
1186void RecordLayoutBuilder::Layout(const CXXRecordDecl *RD) {
1187 InitializeLayout(RD);
1188
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001189 // Lay out the vtable and the non-virtual bases.
1190 LayoutNonVirtualBases(RD);
1191
1192 LayoutFields(RD);
1193
Ken Dycke7380752011-03-10 01:53:59 +00001194 NonVirtualSize = Context.toCharUnitsFromBits(
1195 llvm::RoundUpToAlignment(getSizeInBits(),
1196 Context.Target.getCharAlign()));
Ken Dyck4731d5b2011-02-16 02:05:21 +00001197 NonVirtualAlignment = Alignment;
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001198
1199 // Lay out the virtual bases and add the primary virtual base offsets.
1200 LayoutVirtualBases(RD, RD);
1201
1202 VisitedVirtualBases.clear();
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001203
1204 // Finally, round the size of the total struct up to the alignment of the
1205 // struct itself.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001206 FinishLayout(RD);
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001207
Anders Carlsson5b441d72010-04-10 21:24:48 +00001208#ifndef NDEBUG
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001209 // Check that we have base offsets for all bases.
1210 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1211 E = RD->bases_end(); I != E; ++I) {
1212 if (I->isVirtual())
1213 continue;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001214
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001215 const CXXRecordDecl *BaseDecl =
1216 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1217
1218 assert(Bases.count(BaseDecl) && "Did not find base offset!");
1219 }
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001220
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001221 // And all virtual bases.
1222 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
1223 E = RD->vbases_end(); I != E; ++I) {
1224 const CXXRecordDecl *BaseDecl =
1225 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001226
Anders Carlssonc28a6c92010-05-26 15:10:00 +00001227 assert(VBases.count(BaseDecl) && "Did not find base offset!");
Anders Carlsson5b441d72010-04-10 21:24:48 +00001228 }
1229#endif
Anders Carlsson79474332009-07-18 20:20:21 +00001230}
1231
Anders Carlssonc2226202010-05-26 05:58:59 +00001232void RecordLayoutBuilder::Layout(const ObjCInterfaceDecl *D) {
Anders Carlsson4f516282009-07-18 20:50:59 +00001233 if (ObjCInterfaceDecl *SD = D->getSuperClass()) {
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001234 const ASTRecordLayout &SL = Context.getASTObjCInterfaceLayout(SD);
Anders Carlsson4f516282009-07-18 20:50:59 +00001235
Ken Dyck85ef0432011-02-19 18:58:07 +00001236 UpdateAlignment(SL.getAlignment());
Mike Stump11289f42009-09-09 15:08:12 +00001237
Anders Carlsson4f516282009-07-18 20:50:59 +00001238 // We start laying out ivars not at the end of the superclass
1239 // structure, but at the next byte following the last field.
Ken Dyckecfc7552011-02-24 01:13:28 +00001240 setSize(SL.getDataSize());
Ken Dyck1b4420e2011-02-28 02:01:38 +00001241 setDataSize(getSize());
Anders Carlsson4f516282009-07-18 20:50:59 +00001242 }
Mike Stump11289f42009-09-09 15:08:12 +00001243
Daniel Dunbar6da10982010-05-27 05:45:51 +00001244 InitializeLayout(D);
Daniel Dunbar40130442010-05-27 01:12:46 +00001245
Anders Carlsson4f516282009-07-18 20:50:59 +00001246 // Layout each ivar sequentially.
1247 llvm::SmallVector<ObjCIvarDecl*, 16> Ivars;
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001248 Context.ShallowCollectObjCIvars(D, Ivars);
Anders Carlsson4f516282009-07-18 20:50:59 +00001249 for (unsigned i = 0, e = Ivars.size(); i != e; ++i)
1250 LayoutField(Ivars[i]);
Mike Stump11289f42009-09-09 15:08:12 +00001251
Anders Carlsson4f516282009-07-18 20:50:59 +00001252 // Finally, round the size of the total struct up to the alignment of the
1253 // struct itself.
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001254 FinishLayout(D);
Anders Carlsson4f516282009-07-18 20:50:59 +00001255}
1256
Anders Carlssonc2226202010-05-26 05:58:59 +00001257void RecordLayoutBuilder::LayoutFields(const RecordDecl *D) {
Anders Carlsson118ce162009-07-18 21:48:39 +00001258 // Layout each field, for now, just sequentially, respecting alignment. In
1259 // the future, this will need to be tweakable by targets.
Fariborz Jahanianbcb23a12011-04-26 23:52:16 +00001260 const FieldDecl *LastFD = 0;
Fariborz Jahanianfc0fe6e2011-05-03 20:21:04 +00001261 ZeroLengthBitfield = 0;
Mike Stump11289f42009-09-09 15:08:12 +00001262 for (RecordDecl::field_iterator Field = D->field_begin(),
Fariborz Jahanianbcb23a12011-04-26 23:52:16 +00001263 FieldEnd = D->field_end(); Field != FieldEnd; ++Field) {
1264 if (IsMsStruct) {
Fariborz Jahanianfc0fe6e2011-05-03 20:21:04 +00001265 FieldDecl *FD = (*Field);
1266 if (Context.ZeroBitfieldFollowsBitfield(FD, LastFD))
1267 ZeroLengthBitfield = FD;
Fariborz Jahanianbcb23a12011-04-26 23:52:16 +00001268 // Zero-length bitfields following non-bitfield members are
1269 // ignored:
Fariborz Jahanianfc0fe6e2011-05-03 20:21:04 +00001270 else if (Context.ZeroBitfieldFollowsNonBitfield(FD, LastFD))
Fariborz Jahanianbcb23a12011-04-26 23:52:16 +00001271 continue;
Fariborz Jahanianbcb23a12011-04-26 23:52:16 +00001272 LastFD = FD;
1273 }
Anders Carlsson118ce162009-07-18 21:48:39 +00001274 LayoutField(*Field);
Fariborz Jahanianbcb23a12011-04-26 23:52:16 +00001275 }
Anders Carlsson118ce162009-07-18 21:48:39 +00001276}
1277
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001278void RecordLayoutBuilder::LayoutWideBitField(uint64_t FieldSize,
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001279 uint64_t TypeSize,
1280 bool FieldPacked,
1281 const FieldDecl *D) {
Anders Carlsson57235162010-04-16 15:57:11 +00001282 assert(Context.getLangOptions().CPlusPlus &&
1283 "Can only have wide bit-fields in C++!");
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001284
Anders Carlsson57235162010-04-16 15:57:11 +00001285 // Itanium C++ ABI 2.4:
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001286 // If sizeof(T)*8 < n, let T' be the largest integral POD type with
Anders Carlsson57235162010-04-16 15:57:11 +00001287 // sizeof(T')*8 <= n.
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001288
Anders Carlsson57235162010-04-16 15:57:11 +00001289 QualType IntegralPODTypes[] = {
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001290 Context.UnsignedCharTy, Context.UnsignedShortTy, Context.UnsignedIntTy,
Anders Carlsson57235162010-04-16 15:57:11 +00001291 Context.UnsignedLongTy, Context.UnsignedLongLongTy
1292 };
1293
Anders Carlsson57235162010-04-16 15:57:11 +00001294 QualType Type;
1295 for (unsigned I = 0, E = llvm::array_lengthof(IntegralPODTypes);
1296 I != E; ++I) {
1297 uint64_t Size = Context.getTypeSize(IntegralPODTypes[I]);
Anders Carlsson57235162010-04-16 15:57:11 +00001298
1299 if (Size > FieldSize)
1300 break;
1301
1302 Type = IntegralPODTypes[I];
1303 }
1304 assert(!Type.isNull() && "Did not find a type!");
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001305
Ken Dyckdbe37f32011-03-01 01:36:00 +00001306 CharUnits TypeAlign = Context.getTypeAlignInChars(Type);
Anders Carlsson57235162010-04-16 15:57:11 +00001307
1308 // We're not going to use any of the unfilled bits in the last byte.
1309 UnfilledBitsInLastByte = 0;
1310
Anders Carlssonaad5fa82010-04-17 20:21:41 +00001311 uint64_t FieldOffset;
Ken Dyckecfc7552011-02-24 01:13:28 +00001312 uint64_t UnpaddedFieldOffset = getDataSizeInBits() - UnfilledBitsInLastByte;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001313
Anders Carlsson57235162010-04-16 15:57:11 +00001314 if (IsUnion) {
Ken Dyckecfc7552011-02-24 01:13:28 +00001315 setDataSize(std::max(getDataSizeInBits(), FieldSize));
Anders Carlssonaad5fa82010-04-17 20:21:41 +00001316 FieldOffset = 0;
Anders Carlsson57235162010-04-16 15:57:11 +00001317 } else {
Anders Carlssonaad5fa82010-04-17 20:21:41 +00001318 // The bitfield is allocated starting at the next offset aligned appropriately
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001319 // for T', with length n bits.
Ken Dyckdbe37f32011-03-01 01:36:00 +00001320 FieldOffset = llvm::RoundUpToAlignment(getDataSizeInBits(),
1321 Context.toBits(TypeAlign));
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001322
Anders Carlsson57235162010-04-16 15:57:11 +00001323 uint64_t NewSizeInBits = FieldOffset + FieldSize;
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001324
Ken Dycka1a2e8d2011-03-10 02:00:35 +00001325 setDataSize(llvm::RoundUpToAlignment(NewSizeInBits,
1326 Context.Target.getCharAlign()));
Ken Dyckecfc7552011-02-24 01:13:28 +00001327 UnfilledBitsInLastByte = getDataSizeInBits() - NewSizeInBits;
Anders Carlsson57235162010-04-16 15:57:11 +00001328 }
1329
1330 // Place this field at the current location.
1331 FieldOffsets.push_back(FieldOffset);
1332
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001333 CheckFieldPadding(FieldOffset, UnpaddedFieldOffset, FieldOffset,
Ken Dyckdbe37f32011-03-01 01:36:00 +00001334 Context.toBits(TypeAlign), FieldPacked, D);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001335
Anders Carlsson57235162010-04-16 15:57:11 +00001336 // Update the size.
Ken Dyckecfc7552011-02-24 01:13:28 +00001337 setSize(std::max(getSizeInBits(), getDataSizeInBits()));
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001338
Anders Carlsson57235162010-04-16 15:57:11 +00001339 // Remember max struct/class alignment.
Ken Dyckdbe37f32011-03-01 01:36:00 +00001340 UpdateAlignment(TypeAlign);
Anders Carlsson57235162010-04-16 15:57:11 +00001341}
1342
Anders Carlssonc2226202010-05-26 05:58:59 +00001343void RecordLayoutBuilder::LayoutBitField(const FieldDecl *D) {
Anders Carlsson07209442009-11-22 17:37:31 +00001344 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Ken Dyckecfc7552011-02-24 01:13:28 +00001345 uint64_t UnpaddedFieldOffset = getDataSizeInBits() - UnfilledBitsInLastByte;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001346 uint64_t FieldOffset = IsUnion ? 0 : UnpaddedFieldOffset;
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001347 uint64_t FieldSize = D->getBitWidth()->EvaluateAsInt(Context).getZExtValue();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001348
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001349 std::pair<uint64_t, unsigned> FieldInfo = Context.getTypeInfo(D->getType());
Anders Carlsson07209442009-11-22 17:37:31 +00001350 uint64_t TypeSize = FieldInfo.first;
1351 unsigned FieldAlign = FieldInfo.second;
Fariborz Jahanianfc0fe6e2011-05-03 20:21:04 +00001352
1353 if (ZeroLengthBitfield) {
1354 // If a zero-length bitfield is inserted after a bitfield,
1355 // and the alignment of the zero-length bitfield is
1356 // greater than the member that follows it, `bar', `bar'
1357 // will be aligned as the type of the zero-length bitfield.
1358 if (ZeroLengthBitfield != D) {
1359 std::pair<uint64_t, unsigned> FieldInfo =
1360 Context.getTypeInfo(ZeroLengthBitfield->getType());
1361 unsigned ZeroLengthBitfieldAlignment = FieldInfo.second;
Fariborz Jahanian759e4a12011-05-03 22:07:14 +00001362 // Ignore alignment of subsequent zero-length bitfields.
1363 if ((ZeroLengthBitfieldAlignment > FieldAlign) || (FieldSize == 0))
Fariborz Jahanianfc0fe6e2011-05-03 20:21:04 +00001364 FieldAlign = ZeroLengthBitfieldAlignment;
Fariborz Jahanian759e4a12011-05-03 22:07:14 +00001365 if (FieldSize)
1366 ZeroLengthBitfield = 0;
Fariborz Jahanianfc0fe6e2011-05-03 20:21:04 +00001367 }
1368 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001369
Anders Carlsson57235162010-04-16 15:57:11 +00001370 if (FieldSize > TypeSize) {
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001371 LayoutWideBitField(FieldSize, TypeSize, FieldPacked, D);
Anders Carlsson57235162010-04-16 15:57:11 +00001372 return;
1373 }
1374
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001375 // The align if the field is not packed. This is to check if the attribute
1376 // was unnecessary (-Wpacked).
1377 unsigned UnpackedFieldAlign = FieldAlign;
1378 uint64_t UnpackedFieldOffset = FieldOffset;
1379 if (!Context.Target.useBitFieldTypeAlignment())
1380 UnpackedFieldAlign = 1;
1381
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001382 if (FieldPacked || !Context.Target.useBitFieldTypeAlignment())
Anders Carlsson07209442009-11-22 17:37:31 +00001383 FieldAlign = 1;
Alexis Huntdcfba7b2010-08-18 23:23:40 +00001384 FieldAlign = std::max(FieldAlign, D->getMaxAlignment());
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001385 UnpackedFieldAlign = std::max(UnpackedFieldAlign, D->getMaxAlignment());
Anders Carlsson07209442009-11-22 17:37:31 +00001386
1387 // The maximum field alignment overrides the aligned attribute.
Ken Dyck02ced6f2011-02-17 01:49:42 +00001388 if (!MaxFieldAlignment.isZero()) {
1389 unsigned MaxFieldAlignmentInBits = Context.toBits(MaxFieldAlignment);
1390 FieldAlign = std::min(FieldAlign, MaxFieldAlignmentInBits);
1391 UnpackedFieldAlign = std::min(UnpackedFieldAlign, MaxFieldAlignmentInBits);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001392 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001393
Daniel Dunbar3d9289c2010-04-15 06:18:39 +00001394 // Check if we need to add padding to give the field the correct alignment.
Anders Carlsson07209442009-11-22 17:37:31 +00001395 if (FieldSize == 0 || (FieldOffset & (FieldAlign-1)) + FieldSize > TypeSize)
Daniel Dunbarf35e7652010-06-29 18:34:35 +00001396 FieldOffset = llvm::RoundUpToAlignment(FieldOffset, FieldAlign);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001397
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001398 if (FieldSize == 0 ||
1399 (UnpackedFieldOffset & (UnpackedFieldAlign-1)) + FieldSize > TypeSize)
1400 UnpackedFieldOffset = llvm::RoundUpToAlignment(UnpackedFieldOffset,
1401 UnpackedFieldAlign);
1402
Daniel Dunbar3d9289c2010-04-15 06:18:39 +00001403 // Padding members don't affect overall alignment.
Anders Carlsson07209442009-11-22 17:37:31 +00001404 if (!D->getIdentifier())
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001405 FieldAlign = UnpackedFieldAlign = 1;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001406
Anders Carlsson07209442009-11-22 17:37:31 +00001407 // Place this field at the current location.
1408 FieldOffsets.push_back(FieldOffset);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001409
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001410 CheckFieldPadding(FieldOffset, UnpaddedFieldOffset, UnpackedFieldOffset,
1411 UnpackedFieldAlign, FieldPacked, D);
1412
Anders Carlssonba958402009-11-22 19:13:51 +00001413 // Update DataSize to include the last byte containing (part of) the bitfield.
1414 if (IsUnion) {
1415 // FIXME: I think FieldSize should be TypeSize here.
Ken Dyckecfc7552011-02-24 01:13:28 +00001416 setDataSize(std::max(getDataSizeInBits(), FieldSize));
Anders Carlssonba958402009-11-22 19:13:51 +00001417 } else {
1418 uint64_t NewSizeInBits = FieldOffset + FieldSize;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001419
Ken Dycka1a2e8d2011-03-10 02:00:35 +00001420 setDataSize(llvm::RoundUpToAlignment(NewSizeInBits,
1421 Context.Target.getCharAlign()));
Ken Dyckecfc7552011-02-24 01:13:28 +00001422 UnfilledBitsInLastByte = getDataSizeInBits() - NewSizeInBits;
Anders Carlssonba958402009-11-22 19:13:51 +00001423 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001424
Anders Carlssonba958402009-11-22 19:13:51 +00001425 // Update the size.
Ken Dyckecfc7552011-02-24 01:13:28 +00001426 setSize(std::max(getSizeInBits(), getDataSizeInBits()));
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001427
Anders Carlsson07209442009-11-22 17:37:31 +00001428 // Remember max struct/class alignment.
Ken Dyck85ef0432011-02-19 18:58:07 +00001429 UpdateAlignment(Context.toCharUnitsFromBits(FieldAlign),
1430 Context.toCharUnitsFromBits(UnpackedFieldAlign));
Anders Carlsson07209442009-11-22 17:37:31 +00001431}
1432
Anders Carlssonc2226202010-05-26 05:58:59 +00001433void RecordLayoutBuilder::LayoutField(const FieldDecl *D) {
Anders Carlsson07209442009-11-22 17:37:31 +00001434 if (D->isBitField()) {
1435 LayoutBitField(D);
1436 return;
1437 }
1438
Ken Dyckecfc7552011-02-24 01:13:28 +00001439 uint64_t UnpaddedFieldOffset = getDataSizeInBits() - UnfilledBitsInLastByte;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001440
Anders Carlssonba958402009-11-22 19:13:51 +00001441 // Reset the unfilled bits.
1442 UnfilledBitsInLastByte = 0;
1443
Anders Carlsson07209442009-11-22 17:37:31 +00001444 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Ken Dyck6d90e892011-02-20 02:06:09 +00001445 CharUnits FieldOffset =
Ken Dyckecfc7552011-02-24 01:13:28 +00001446 IsUnion ? CharUnits::Zero() : getDataSize();
Ken Dyck6d90e892011-02-20 02:06:09 +00001447 CharUnits FieldSize;
1448 CharUnits FieldAlign;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001449
Anders Carlsson07209442009-11-22 17:37:31 +00001450 if (D->getType()->isIncompleteArrayType()) {
1451 // This is a flexible array member; we can't directly
1452 // query getTypeInfo about these, so we figure it out here.
1453 // Flexible array members don't have any size, but they
1454 // have to be aligned appropriately for their element type.
Ken Dyck6d90e892011-02-20 02:06:09 +00001455 FieldSize = CharUnits::Zero();
Anders Carlsson5efc56e2010-04-16 15:07:51 +00001456 const ArrayType* ATy = Context.getAsArrayType(D->getType());
Ken Dyck6d90e892011-02-20 02:06:09 +00001457 FieldAlign = Context.getTypeAlignInChars(ATy->getElementType());
Anders Carlsson07209442009-11-22 17:37:31 +00001458 } else if (const ReferenceType *RT = D->getType()->getAs<ReferenceType>()) {
1459 unsigned AS = RT->getPointeeType().getAddressSpace();
Ken Dyck6d90e892011-02-20 02:06:09 +00001460 FieldSize =
1461 Context.toCharUnitsFromBits(Context.Target.getPointerWidth(AS));
1462 FieldAlign =
1463 Context.toCharUnitsFromBits(Context.Target.getPointerAlign(AS));
Anders Carlsson79474332009-07-18 20:20:21 +00001464 } else {
Ken Dyck6d90e892011-02-20 02:06:09 +00001465 std::pair<CharUnits, CharUnits> FieldInfo =
1466 Context.getTypeInfoInChars(D->getType());
Anders Carlsson07209442009-11-22 17:37:31 +00001467 FieldSize = FieldInfo.first;
1468 FieldAlign = FieldInfo.second;
Fariborz Jahanianfc0fe6e2011-05-03 20:21:04 +00001469
1470 if (ZeroLengthBitfield) {
1471 // If a zero-length bitfield is inserted after a bitfield,
1472 // and the alignment of the zero-length bitfield is
1473 // greater than the member that follows it, `bar', `bar'
1474 // will be aligned as the type of the zero-length bitfield.
1475 std::pair<CharUnits, CharUnits> FieldInfo =
1476 Context.getTypeInfoInChars(ZeroLengthBitfield->getType());
1477 CharUnits ZeroLengthBitfieldAlignment = FieldInfo.second;
1478 if (ZeroLengthBitfieldAlignment > FieldAlign)
1479 FieldAlign = ZeroLengthBitfieldAlignment;
1480 ZeroLengthBitfield = 0;
1481 }
Douglas Gregordbe39272011-02-01 15:15:22 +00001482
1483 if (Context.getLangOptions().MSBitfields) {
1484 // If MS bitfield layout is required, figure out what type is being
1485 // laid out and align the field to the width of that type.
1486
1487 // Resolve all typedefs down to their base type and round up the field
1488 // alignment if necessary.
1489 QualType T = Context.getBaseElementType(D->getType());
1490 if (const BuiltinType *BTy = T->getAs<BuiltinType>()) {
Ken Dyck6d90e892011-02-20 02:06:09 +00001491 CharUnits TypeSize = Context.getTypeSizeInChars(BTy);
Douglas Gregordbe39272011-02-01 15:15:22 +00001492 if (TypeSize > FieldAlign)
1493 FieldAlign = TypeSize;
1494 }
1495 }
Anders Carlsson79474332009-07-18 20:20:21 +00001496 }
Mike Stump11289f42009-09-09 15:08:12 +00001497
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001498 // The align if the field is not packed. This is to check if the attribute
1499 // was unnecessary (-Wpacked).
Ken Dyck6d90e892011-02-20 02:06:09 +00001500 CharUnits UnpackedFieldAlign = FieldAlign;
1501 CharUnits UnpackedFieldOffset = FieldOffset;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001502
Anders Carlsson07209442009-11-22 17:37:31 +00001503 if (FieldPacked)
Ken Dyck6d90e892011-02-20 02:06:09 +00001504 FieldAlign = CharUnits::One();
1505 CharUnits MaxAlignmentInChars =
1506 Context.toCharUnitsFromBits(D->getMaxAlignment());
1507 FieldAlign = std::max(FieldAlign, MaxAlignmentInChars);
1508 UnpackedFieldAlign = std::max(UnpackedFieldAlign, MaxAlignmentInChars);
Anders Carlsson07209442009-11-22 17:37:31 +00001509
1510 // The maximum field alignment overrides the aligned attribute.
Ken Dyck02ced6f2011-02-17 01:49:42 +00001511 if (!MaxFieldAlignment.isZero()) {
Ken Dyck6d90e892011-02-20 02:06:09 +00001512 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
1513 UnpackedFieldAlign = std::min(UnpackedFieldAlign, MaxFieldAlignment);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001514 }
Anders Carlsson07209442009-11-22 17:37:31 +00001515
1516 // Round up the current record size to the field's alignment boundary.
Ken Dyck6d90e892011-02-20 02:06:09 +00001517 FieldOffset = FieldOffset.RoundUpToAlignment(FieldAlign);
1518 UnpackedFieldOffset =
1519 UnpackedFieldOffset.RoundUpToAlignment(UnpackedFieldAlign);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001520
Anders Carlssonb1fcdd02010-05-30 06:52:33 +00001521 if (!IsUnion && EmptySubobjects) {
1522 // Check if we can place the field at this offset.
Ken Dyck6d90e892011-02-20 02:06:09 +00001523 while (!EmptySubobjects->CanPlaceFieldAtOffset(D, FieldOffset)) {
Anders Carlsson07209442009-11-22 17:37:31 +00001524 // We couldn't place the field at the offset. Try again at a new offset.
1525 FieldOffset += FieldAlign;
1526 }
Anders Carlsson07209442009-11-22 17:37:31 +00001527 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001528
Anders Carlsson79474332009-07-18 20:20:21 +00001529 // Place this field at the current location.
Ken Dyck6d90e892011-02-20 02:06:09 +00001530 FieldOffsets.push_back(Context.toBits(FieldOffset));
Mike Stump11289f42009-09-09 15:08:12 +00001531
Ken Dyck6d90e892011-02-20 02:06:09 +00001532 CheckFieldPadding(Context.toBits(FieldOffset), UnpaddedFieldOffset,
1533 Context.toBits(UnpackedFieldOffset),
1534 Context.toBits(UnpackedFieldAlign), FieldPacked, D);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001535
Anders Carlsson79474332009-07-18 20:20:21 +00001536 // Reserve space for this field.
Daniel Dunbar30cdc702011-02-24 16:40:53 +00001537 uint64_t FieldSizeInBits = Context.toBits(FieldSize);
Anders Carlsson79474332009-07-18 20:20:21 +00001538 if (IsUnion)
Daniel Dunbar30cdc702011-02-24 16:40:53 +00001539 setSize(std::max(getSizeInBits(), FieldSizeInBits));
Anders Carlsson79474332009-07-18 20:20:21 +00001540 else
Ken Dyck1b4420e2011-02-28 02:01:38 +00001541 setSize(FieldOffset + FieldSize);
Mike Stump11289f42009-09-09 15:08:12 +00001542
Anders Carlsson47680d82009-09-26 01:34:51 +00001543 // Update the data size.
Daniel Dunbar30cdc702011-02-24 16:40:53 +00001544 setDataSize(getSizeInBits());
Mike Stump11289f42009-09-09 15:08:12 +00001545
Anders Carlsson79474332009-07-18 20:20:21 +00001546 // Remember max struct/class alignment.
Ken Dyck6d90e892011-02-20 02:06:09 +00001547 UpdateAlignment(FieldAlign, UnpackedFieldAlign);
Anders Carlsson79474332009-07-18 20:20:21 +00001548}
1549
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001550void RecordLayoutBuilder::FinishLayout(const NamedDecl *D) {
Anders Carlsson79474332009-07-18 20:20:21 +00001551 // In C++, records cannot be of size 0.
Ken Dyckecfc7552011-02-24 01:13:28 +00001552 if (Context.getLangOptions().CPlusPlus && getSizeInBits() == 0) {
Fariborz Jahanian09b23312011-02-02 19:36:18 +00001553 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
1554 // Compatibility with gcc requires a class (pod or non-pod)
1555 // which is not empty but of size 0; such as having fields of
1556 // array of zero-length, remains of Size 0
1557 if (RD->isEmpty())
Ken Dyck1b4420e2011-02-28 02:01:38 +00001558 setSize(CharUnits::One());
Fariborz Jahanian09b23312011-02-02 19:36:18 +00001559 }
1560 else
Ken Dyck1b4420e2011-02-28 02:01:38 +00001561 setSize(CharUnits::One());
Fariborz Jahanian09b23312011-02-02 19:36:18 +00001562 }
Anders Carlsson79474332009-07-18 20:20:21 +00001563 // Finally, round the size of the record up to the alignment of the
1564 // record itself.
Ken Dyckecfc7552011-02-24 01:13:28 +00001565 uint64_t UnpaddedSize = getSizeInBits() - UnfilledBitsInLastByte;
Ken Dyck1b4420e2011-02-28 02:01:38 +00001566 uint64_t UnpackedSizeInBits =
Ken Dyckecfc7552011-02-24 01:13:28 +00001567 llvm::RoundUpToAlignment(getSizeInBits(),
1568 Context.toBits(UnpackedAlignment));
Ken Dyck1b4420e2011-02-28 02:01:38 +00001569 CharUnits UnpackedSize = Context.toCharUnitsFromBits(UnpackedSizeInBits);
Ken Dyckecfc7552011-02-24 01:13:28 +00001570 setSize(llvm::RoundUpToAlignment(getSizeInBits(), Context.toBits(Alignment)));
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001571
1572 unsigned CharBitNum = Context.Target.getCharWidth();
1573 if (const RecordDecl *RD = dyn_cast<RecordDecl>(D)) {
1574 // Warn if padding was introduced to the struct/class/union.
Ken Dyckecfc7552011-02-24 01:13:28 +00001575 if (getSizeInBits() > UnpaddedSize) {
1576 unsigned PadSize = getSizeInBits() - UnpaddedSize;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001577 bool InBits = true;
1578 if (PadSize % CharBitNum == 0) {
1579 PadSize = PadSize / CharBitNum;
1580 InBits = false;
1581 }
1582 Diag(RD->getLocation(), diag::warn_padded_struct_size)
1583 << Context.getTypeDeclType(RD)
1584 << PadSize
1585 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1); // plural or not
1586 }
1587
1588 // Warn if we packed it unnecessarily. If the alignment is 1 byte don't
1589 // bother since there won't be alignment issues.
Ken Dyckecfc7552011-02-24 01:13:28 +00001590 if (Packed && UnpackedAlignment > CharUnits::One() &&
Ken Dyck1b4420e2011-02-28 02:01:38 +00001591 getSize() == UnpackedSize)
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001592 Diag(D->getLocation(), diag::warn_unnecessary_packed)
1593 << Context.getTypeDeclType(RD);
1594 }
Anders Carlsson79474332009-07-18 20:20:21 +00001595}
1596
Ken Dyck85ef0432011-02-19 18:58:07 +00001597void RecordLayoutBuilder::UpdateAlignment(CharUnits NewAlignment,
1598 CharUnits UnpackedNewAlignment) {
Daniel Dunbar6da10982010-05-27 05:45:51 +00001599 // The alignment is not modified when using 'mac68k' alignment.
1600 if (IsMac68kAlign)
1601 return;
1602
Ken Dyck85ef0432011-02-19 18:58:07 +00001603 if (NewAlignment > Alignment) {
1604 assert(llvm::isPowerOf2_32(NewAlignment.getQuantity() &&
1605 "Alignment not a power of 2"));
1606 Alignment = NewAlignment;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001607 }
1608
Ken Dyck85ef0432011-02-19 18:58:07 +00001609 if (UnpackedNewAlignment > UnpackedAlignment) {
1610 assert(llvm::isPowerOf2_32(UnpackedNewAlignment.getQuantity() &&
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001611 "Alignment not a power of 2"));
Ken Dyck85ef0432011-02-19 18:58:07 +00001612 UnpackedAlignment = UnpackedNewAlignment;
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001613 }
1614}
1615
1616void RecordLayoutBuilder::CheckFieldPadding(uint64_t Offset,
1617 uint64_t UnpaddedOffset,
1618 uint64_t UnpackedOffset,
1619 unsigned UnpackedAlign,
1620 bool isPacked,
1621 const FieldDecl *D) {
1622 // We let objc ivars without warning, objc interfaces generally are not used
1623 // for padding tricks.
1624 if (isa<ObjCIvarDecl>(D))
Anders Carlsson79474332009-07-18 20:20:21 +00001625 return;
Mike Stump11289f42009-09-09 15:08:12 +00001626
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001627 unsigned CharBitNum = Context.Target.getCharWidth();
Mike Stump11289f42009-09-09 15:08:12 +00001628
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001629 // Warn if padding was introduced to the struct/class.
1630 if (!IsUnion && Offset > UnpaddedOffset) {
1631 unsigned PadSize = Offset - UnpaddedOffset;
1632 bool InBits = true;
1633 if (PadSize % CharBitNum == 0) {
1634 PadSize = PadSize / CharBitNum;
1635 InBits = false;
1636 }
1637 if (D->getIdentifier())
1638 Diag(D->getLocation(), diag::warn_padded_struct_field)
1639 << (D->getParent()->isStruct() ? 0 : 1) // struct|class
1640 << Context.getTypeDeclType(D->getParent())
1641 << PadSize
1642 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1) // plural or not
1643 << D->getIdentifier();
1644 else
1645 Diag(D->getLocation(), diag::warn_padded_struct_anon_field)
1646 << (D->getParent()->isStruct() ? 0 : 1) // struct|class
1647 << Context.getTypeDeclType(D->getParent())
1648 << PadSize
1649 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1); // plural or not
1650 }
1651
1652 // Warn if we packed it unnecessarily. If the alignment is 1 byte don't
1653 // bother since there won't be alignment issues.
1654 if (isPacked && UnpackedAlign > CharBitNum && Offset == UnpackedOffset)
1655 Diag(D->getLocation(), diag::warn_unnecessary_packed)
1656 << D->getIdentifier();
Anders Carlsson79474332009-07-18 20:20:21 +00001657}
Mike Stump11289f42009-09-09 15:08:12 +00001658
Anders Carlsson5ebf8b42009-12-07 04:35:11 +00001659const CXXMethodDecl *
Anders Carlssonc2226202010-05-26 05:58:59 +00001660RecordLayoutBuilder::ComputeKeyFunction(const CXXRecordDecl *RD) {
Daniel Dunbarccabe482010-04-19 20:44:53 +00001661 // If a class isn't polymorphic it doesn't have a key function.
Anders Carlsson5ebf8b42009-12-07 04:35:11 +00001662 if (!RD->isPolymorphic())
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001663 return 0;
Eli Friedmanf2c79b62009-12-08 03:56:49 +00001664
1665 // A class inside an anonymous namespace doesn't have a key function. (Or
1666 // at least, there's no point to assigning a key function to such a class;
1667 // this doesn't affect the ABI.)
1668 if (RD->isInAnonymousNamespace())
1669 return 0;
1670
Argyrios Kyrtzidis8c64bbe2010-10-13 02:39:41 +00001671 // Template instantiations don't have key functions,see Itanium C++ ABI 5.2.6.
1672 // Same behavior as GCC.
1673 TemplateSpecializationKind TSK = RD->getTemplateSpecializationKind();
1674 if (TSK == TSK_ImplicitInstantiation ||
1675 TSK == TSK_ExplicitInstantiationDefinition)
1676 return 0;
1677
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001678 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
1679 E = RD->method_end(); I != E; ++I) {
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001680 const CXXMethodDecl *MD = *I;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001681
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001682 if (!MD->isVirtual())
1683 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001684
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001685 if (MD->isPure())
1686 continue;
Eli Friedmanf2c79b62009-12-08 03:56:49 +00001687
Anders Carlssonf98849e2009-12-02 17:15:43 +00001688 // Ignore implicit member functions, they are always marked as inline, but
1689 // they don't have a body until they're defined.
1690 if (MD->isImplicit())
1691 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001692
Douglas Gregora318efd2010-01-05 19:06:31 +00001693 if (MD->isInlineSpecified())
1694 continue;
Eli Friedman71a26d82009-12-06 20:50:05 +00001695
1696 if (MD->hasInlineBody())
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001697 continue;
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001698
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001699 // We found it.
1700 return MD;
1701 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001702
Anders Carlssonb1d3f7c2009-11-30 23:41:22 +00001703 return 0;
1704}
1705
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001706DiagnosticBuilder
1707RecordLayoutBuilder::Diag(SourceLocation Loc, unsigned DiagID) {
Argyrios Kyrtzidisd0040642010-11-18 20:06:41 +00001708 return Context.getDiagnostics().Report(Loc, DiagID);
Argyrios Kyrtzidisca0d0cd2010-09-22 14:32:24 +00001709}
1710
Benjamin Kramer2fc373e2010-10-22 16:33:16 +00001711namespace {
1712 // This class implements layout specific to the Microsoft ABI.
1713 class MSRecordLayoutBuilder : public RecordLayoutBuilder {
1714 public:
Jay Foad39c79802011-01-12 09:06:06 +00001715 MSRecordLayoutBuilder(const ASTContext& Ctx,
1716 EmptySubobjectMap *EmptySubobjects) :
Benjamin Kramer2fc373e2010-10-22 16:33:16 +00001717 RecordLayoutBuilder(Ctx, EmptySubobjects) {}
Charles Davisc2c576a2010-08-19 00:55:19 +00001718
Ken Dyckaab635e2011-03-01 01:22:45 +00001719 virtual CharUnits GetVirtualPointersSize(const CXXRecordDecl *RD) const;
Benjamin Kramer2fc373e2010-10-22 16:33:16 +00001720 };
1721}
Charles Davisc2c576a2010-08-19 00:55:19 +00001722
Ken Dyckaab635e2011-03-01 01:22:45 +00001723CharUnits
Charles Davisc2c576a2010-08-19 00:55:19 +00001724MSRecordLayoutBuilder::GetVirtualPointersSize(const CXXRecordDecl *RD) const {
1725 // We should reserve space for two pointers if the class has both
1726 // virtual functions and virtual bases.
Ken Dyckaab635e2011-03-01 01:22:45 +00001727 CharUnits PointerWidth =
1728 Context.toCharUnitsFromBits(Context.Target.getPointerWidth(0));
Charles Davisc2c576a2010-08-19 00:55:19 +00001729 if (RD->isPolymorphic() && RD->getNumVBases() > 0)
Ken Dyckaab635e2011-03-01 01:22:45 +00001730 return 2 * PointerWidth;
1731 return PointerWidth;
Charles Davisc2c576a2010-08-19 00:55:19 +00001732}
1733
Anders Carlssondf291d82010-05-26 04:56:53 +00001734/// getASTRecordLayout - Get or compute information about the layout of the
1735/// specified record (struct/union/class), which indicates its size and field
1736/// position information.
Jay Foad39c79802011-01-12 09:06:06 +00001737const ASTRecordLayout &
1738ASTContext::getASTRecordLayout(const RecordDecl *D) const {
Anders Carlssondf291d82010-05-26 04:56:53 +00001739 D = D->getDefinition();
1740 assert(D && "Cannot get layout of forward declarations!");
1741
1742 // Look up this layout, if already laid out, return what we have.
1743 // Note that we can't save a reference to the entry because this function
1744 // is recursive.
1745 const ASTRecordLayout *Entry = ASTRecordLayouts[D];
1746 if (Entry) return *Entry;
1747
Anders Carlssond2954862010-05-26 05:10:47 +00001748 const ASTRecordLayout *NewEntry;
1749
1750 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
Anders Carlssonc121b4e2010-05-27 00:07:01 +00001751 EmptySubobjectMap EmptySubobjects(*this, RD);
Anders Carlsson439edd12010-05-27 05:41:06 +00001752
Charles Davisc2c576a2010-08-19 00:55:19 +00001753 // When compiling for Microsoft, use the special MS builder.
Argyrios Kyrtzidis3c6cd172010-08-25 00:32:14 +00001754 llvm::OwningPtr<RecordLayoutBuilder> Builder;
Charles Davis6bcb07a2010-08-19 02:18:14 +00001755 switch (Target.getCXXABI()) {
1756 default:
Argyrios Kyrtzidis3c6cd172010-08-25 00:32:14 +00001757 Builder.reset(new RecordLayoutBuilder(*this, &EmptySubobjects));
Charles Davis6bcb07a2010-08-19 02:18:14 +00001758 break;
1759 case CXXABI_Microsoft:
Argyrios Kyrtzidis3c6cd172010-08-25 00:32:14 +00001760 Builder.reset(new MSRecordLayoutBuilder(*this, &EmptySubobjects));
Charles Davis6bcb07a2010-08-19 02:18:14 +00001761 }
Ted Kremenekf75d0892011-03-19 01:00:36 +00001762 // Recover resources if we crash before exiting this method.
Ted Kremenek022dbc12011-03-22 01:15:19 +00001763 llvm::CrashRecoveryContextCleanupRegistrar<RecordLayoutBuilder>
1764 RecordBuilderCleanup(Builder.get());
Ted Kremenekf75d0892011-03-19 01:00:36 +00001765
Charles Davisc2c576a2010-08-19 00:55:19 +00001766 Builder->Layout(RD);
Anders Carlssond2954862010-05-26 05:10:47 +00001767
1768 // FIXME: This is not always correct. See the part about bitfields at
1769 // http://www.codesourcery.com/public/cxx-abi/abi.html#POD for more info.
1770 // FIXME: IsPODForThePurposeOfLayout should be stored in the record layout.
1771 bool IsPODForThePurposeOfLayout = cast<CXXRecordDecl>(D)->isPOD();
1772
1773 // FIXME: This should be done in FinalizeLayout.
Ken Dyck1b4420e2011-02-28 02:01:38 +00001774 CharUnits DataSize =
1775 IsPODForThePurposeOfLayout ? Builder->getSize() : Builder->getDataSize();
1776 CharUnits NonVirtualSize =
1777 IsPODForThePurposeOfLayout ? DataSize : Builder->NonVirtualSize;
Anders Carlssond2954862010-05-26 05:10:47 +00001778
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001779 NewEntry =
Ken Dyck1b4420e2011-02-28 02:01:38 +00001780 new (*this) ASTRecordLayout(*this, Builder->getSize(),
Ken Dyck4731d5b2011-02-16 02:05:21 +00001781 Builder->Alignment,
Ken Dyck1b4420e2011-02-28 02:01:38 +00001782 DataSize,
Ken Dyckd5090c12011-02-11 02:20:09 +00001783 Builder->FieldOffsets.data(),
Charles Davisc2c576a2010-08-19 00:55:19 +00001784 Builder->FieldOffsets.size(),
Ken Dyckaf1c83f2011-02-16 01:52:01 +00001785 NonVirtualSize,
Ken Dycka2d3dda2011-02-16 01:43:15 +00001786 Builder->NonVirtualAlignment,
Anders Carlssonc121b4e2010-05-27 00:07:01 +00001787 EmptySubobjects.SizeOfLargestEmptySubobject,
Charles Davisc2c576a2010-08-19 00:55:19 +00001788 Builder->PrimaryBase,
1789 Builder->PrimaryBaseIsVirtual,
1790 Builder->Bases, Builder->VBases);
Anders Carlssond2954862010-05-26 05:10:47 +00001791 } else {
Anders Carlssonc121b4e2010-05-27 00:07:01 +00001792 RecordLayoutBuilder Builder(*this, /*EmptySubobjects=*/0);
Anders Carlssond2954862010-05-26 05:10:47 +00001793 Builder.Layout(D);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001794
Anders Carlssond2954862010-05-26 05:10:47 +00001795 NewEntry =
Ken Dyck1b4420e2011-02-28 02:01:38 +00001796 new (*this) ASTRecordLayout(*this, Builder.getSize(),
Ken Dyck4731d5b2011-02-16 02:05:21 +00001797 Builder.Alignment,
Ken Dyck1b4420e2011-02-28 02:01:38 +00001798 Builder.getSize(),
Anders Carlssond2954862010-05-26 05:10:47 +00001799 Builder.FieldOffsets.data(),
1800 Builder.FieldOffsets.size());
1801 }
1802
Anders Carlssondf291d82010-05-26 04:56:53 +00001803 ASTRecordLayouts[D] = NewEntry;
1804
1805 if (getLangOptions().DumpRecordLayouts) {
1806 llvm::errs() << "\n*** Dumping AST Record Layout\n";
1807 DumpRecordLayout(D, llvm::errs());
1808 }
1809
1810 return *NewEntry;
1811}
1812
1813const CXXMethodDecl *ASTContext::getKeyFunction(const CXXRecordDecl *RD) {
1814 RD = cast<CXXRecordDecl>(RD->getDefinition());
1815 assert(RD && "Cannot get key function for forward declarations!");
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001816
Anders Carlssondf291d82010-05-26 04:56:53 +00001817 const CXXMethodDecl *&Entry = KeyFunctions[RD];
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001818 if (!Entry)
Anders Carlssonc2226202010-05-26 05:58:59 +00001819 Entry = RecordLayoutBuilder::ComputeKeyFunction(RD);
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001820
Anders Carlssondf291d82010-05-26 04:56:53 +00001821 return Entry;
1822}
1823
1824/// getInterfaceLayoutImpl - Get or compute information about the
1825/// layout of the given interface.
1826///
1827/// \param Impl - If given, also include the layout of the interface's
1828/// implementation. This may differ by including synthesized ivars.
1829const ASTRecordLayout &
1830ASTContext::getObjCLayout(const ObjCInterfaceDecl *D,
Jay Foad39c79802011-01-12 09:06:06 +00001831 const ObjCImplementationDecl *Impl) const {
Anders Carlssondf291d82010-05-26 04:56:53 +00001832 assert(!D->isForwardDecl() && "Invalid interface decl!");
1833
1834 // Look up this layout, if already laid out, return what we have.
1835 ObjCContainerDecl *Key =
1836 Impl ? (ObjCContainerDecl*) Impl : (ObjCContainerDecl*) D;
1837 if (const ASTRecordLayout *Entry = ObjCLayouts[Key])
1838 return *Entry;
1839
1840 // Add in synthesized ivar count if laying out an implementation.
1841 if (Impl) {
1842 unsigned SynthCount = CountNonClassIvars(D);
1843 // If there aren't any sythesized ivars then reuse the interface
1844 // entry. Note we can't cache this because we simply free all
1845 // entries later; however we shouldn't look up implementations
1846 // frequently.
1847 if (SynthCount == 0)
1848 return getObjCLayout(D, 0);
1849 }
1850
Anders Carlssonc121b4e2010-05-27 00:07:01 +00001851 RecordLayoutBuilder Builder(*this, /*EmptySubobjects=*/0);
Anders Carlsson6ed3a9a2010-05-26 05:04:25 +00001852 Builder.Layout(D);
1853
Anders Carlssondf291d82010-05-26 04:56:53 +00001854 const ASTRecordLayout *NewEntry =
Ken Dyck1b4420e2011-02-28 02:01:38 +00001855 new (*this) ASTRecordLayout(*this, Builder.getSize(),
Ken Dyck4731d5b2011-02-16 02:05:21 +00001856 Builder.Alignment,
Ken Dyck1b4420e2011-02-28 02:01:38 +00001857 Builder.getDataSize(),
Anders Carlsson6ed3a9a2010-05-26 05:04:25 +00001858 Builder.FieldOffsets.data(),
1859 Builder.FieldOffsets.size());
Daniel Dunbar592a85c2010-05-27 02:25:46 +00001860
Anders Carlssondf291d82010-05-26 04:56:53 +00001861 ObjCLayouts[Key] = NewEntry;
1862
1863 return *NewEntry;
1864}
1865
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001866static void PrintOffset(llvm::raw_ostream &OS,
Anders Carlsson3f018712010-10-31 23:45:59 +00001867 CharUnits Offset, unsigned IndentLevel) {
1868 OS << llvm::format("%4d | ", Offset.getQuantity());
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001869 OS.indent(IndentLevel * 2);
1870}
1871
1872static void DumpCXXRecordLayout(llvm::raw_ostream &OS,
Jay Foad39c79802011-01-12 09:06:06 +00001873 const CXXRecordDecl *RD, const ASTContext &C,
Anders Carlsson3f018712010-10-31 23:45:59 +00001874 CharUnits Offset,
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001875 unsigned IndentLevel,
1876 const char* Description,
1877 bool IncludeVirtualBases) {
Anders Carlsson3f018712010-10-31 23:45:59 +00001878 const ASTRecordLayout &Layout = C.getASTRecordLayout(RD);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001879
1880 PrintOffset(OS, Offset, IndentLevel);
Dan Gohman145f3f12010-04-19 16:39:44 +00001881 OS << C.getTypeDeclType(const_cast<CXXRecordDecl *>(RD)).getAsString();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001882 if (Description)
1883 OS << ' ' << Description;
1884 if (RD->isEmpty())
1885 OS << " (empty)";
1886 OS << '\n';
1887
1888 IndentLevel++;
1889
Anders Carlsson3f018712010-10-31 23:45:59 +00001890 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001891
1892 // Vtable pointer.
1893 if (RD->isDynamicClass() && !PrimaryBase) {
1894 PrintOffset(OS, Offset, IndentLevel);
Benjamin Kramerb11416d2010-04-17 09:33:03 +00001895 OS << '(' << RD << " vtable pointer)\n";
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001896 }
1897 // Dump (non-virtual) bases
1898 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1899 E = RD->bases_end(); I != E; ++I) {
1900 assert(!I->getType()->isDependentType() &&
1901 "Cannot layout class with dependent bases.");
1902 if (I->isVirtual())
1903 continue;
1904
1905 const CXXRecordDecl *Base =
1906 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1907
Anders Carlsson3f018712010-10-31 23:45:59 +00001908 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001909
1910 DumpCXXRecordLayout(OS, Base, C, BaseOffset, IndentLevel,
1911 Base == PrimaryBase ? "(primary base)" : "(base)",
1912 /*IncludeVirtualBases=*/false);
1913 }
1914
1915 // Dump fields.
1916 uint64_t FieldNo = 0;
1917 for (CXXRecordDecl::field_iterator I = RD->field_begin(),
1918 E = RD->field_end(); I != E; ++I, ++FieldNo) {
1919 const FieldDecl *Field = *I;
Anders Carlsson3f018712010-10-31 23:45:59 +00001920 CharUnits FieldOffset = Offset +
Ken Dyck86a7fcc2011-01-18 01:56:16 +00001921 C.toCharUnitsFromBits(Layout.getFieldOffset(FieldNo));
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001922
1923 if (const RecordType *RT = Field->getType()->getAs<RecordType>()) {
1924 if (const CXXRecordDecl *D = dyn_cast<CXXRecordDecl>(RT->getDecl())) {
1925 DumpCXXRecordLayout(OS, D, C, FieldOffset, IndentLevel,
Daniel Dunbar56df9772010-08-17 22:39:59 +00001926 Field->getName().data(),
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001927 /*IncludeVirtualBases=*/true);
1928 continue;
1929 }
1930 }
1931
1932 PrintOffset(OS, FieldOffset, IndentLevel);
Benjamin Kramerb11416d2010-04-17 09:33:03 +00001933 OS << Field->getType().getAsString() << ' ' << Field << '\n';
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001934 }
1935
1936 if (!IncludeVirtualBases)
1937 return;
1938
1939 // Dump virtual bases.
1940 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
1941 E = RD->vbases_end(); I != E; ++I) {
1942 assert(I->isVirtual() && "Found non-virtual class!");
1943 const CXXRecordDecl *VBase =
1944 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1945
Anders Carlsson3f018712010-10-31 23:45:59 +00001946 CharUnits VBaseOffset = Offset + Layout.getVBaseClassOffset(VBase);
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001947 DumpCXXRecordLayout(OS, VBase, C, VBaseOffset, IndentLevel,
1948 VBase == PrimaryBase ?
1949 "(primary virtual base)" : "(virtual base)",
1950 /*IncludeVirtualBases=*/false);
1951 }
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001952
Ken Dyckc8ae5502011-02-09 01:59:34 +00001953 OS << " sizeof=" << Layout.getSize().getQuantity();
Ken Dyckd5090c12011-02-11 02:20:09 +00001954 OS << ", dsize=" << Layout.getDataSize().getQuantity();
Ken Dyck7ad11e72011-02-15 02:32:40 +00001955 OS << ", align=" << Layout.getAlignment().getQuantity() << '\n';
Ken Dyck316d6f62011-02-01 01:52:10 +00001956 OS << " nvsize=" << Layout.getNonVirtualSize().getQuantity();
Ken Dyckbec02852011-02-08 02:02:47 +00001957 OS << ", nvalign=" << Layout.getNonVirtualAlign().getQuantity() << '\n';
Daniel Dunbaraa423af2010-04-08 02:59:49 +00001958 OS << '\n';
1959}
Daniel Dunbarccabe482010-04-19 20:44:53 +00001960
1961void ASTContext::DumpRecordLayout(const RecordDecl *RD,
Jay Foad39c79802011-01-12 09:06:06 +00001962 llvm::raw_ostream &OS) const {
Daniel Dunbarccabe482010-04-19 20:44:53 +00001963 const ASTRecordLayout &Info = getASTRecordLayout(RD);
1964
1965 if (const CXXRecordDecl *CXXRD = dyn_cast<CXXRecordDecl>(RD))
Anders Carlsson3f018712010-10-31 23:45:59 +00001966 return DumpCXXRecordLayout(OS, CXXRD, *this, CharUnits(), 0, 0,
Daniel Dunbarccabe482010-04-19 20:44:53 +00001967 /*IncludeVirtualBases=*/true);
1968
1969 OS << "Type: " << getTypeDeclType(RD).getAsString() << "\n";
1970 OS << "Record: ";
1971 RD->dump();
1972 OS << "\nLayout: ";
1973 OS << "<ASTRecordLayout\n";
Ken Dyckb0fcc592011-02-11 01:54:29 +00001974 OS << " Size:" << toBits(Info.getSize()) << "\n";
Ken Dyckd5090c12011-02-11 02:20:09 +00001975 OS << " DataSize:" << toBits(Info.getDataSize()) << "\n";
Ken Dyck7ad11e72011-02-15 02:32:40 +00001976 OS << " Alignment:" << toBits(Info.getAlignment()) << "\n";
Daniel Dunbarccabe482010-04-19 20:44:53 +00001977 OS << " FieldOffsets: [";
1978 for (unsigned i = 0, e = Info.getFieldCount(); i != e; ++i) {
1979 if (i) OS << ", ";
1980 OS << Info.getFieldOffset(i);
1981 }
1982 OS << "]>\n";
1983}