blob: 62306894ab640ded23b419cb3aa0dcc1b87831c8 [file] [log] [blame]
Anders Carlsson9392fa62010-05-26 05:41:04 +00001//=== RecordLayoutBuilder.cpp - Helper class for building record layouts ---==//
Anders Carlssonbda4c102009-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 Carlssonbda4c102009-07-18 20:20:21 +000010#include "clang/AST/Attr.h"
Anders Carlsson245656e2010-11-24 22:55:48 +000011#include "clang/AST/CXXInheritance.h"
Anders Carlssonbda4c102009-07-18 20:20:21 +000012#include "clang/AST/Decl.h"
Anders Carlsson74cbe222009-07-19 00:18:47 +000013#include "clang/AST/DeclCXX.h"
Anders Carlsson93fab9d2009-07-18 20:50:59 +000014#include "clang/AST/DeclObjC.h"
Anders Carlssonbda4c102009-07-18 20:20:21 +000015#include "clang/AST/Expr.h"
Anders Carlsson9392fa62010-05-26 05:41:04 +000016#include "clang/AST/RecordLayout.h"
Anders Carlssonbda4c102009-07-18 20:20:21 +000017#include "clang/Basic/TargetInfo.h"
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +000018#include "clang/Sema/SemaDiagnostic.h"
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +000019#include "llvm/Support/Format.h"
20#include "llvm/ADT/SmallSet.h"
21#include "llvm/Support/MathExtras.h"
Anders Carlsson9392fa62010-05-26 05:41:04 +000022#include <map>
Anders Carlssonbda4c102009-07-18 20:20:21 +000023
24using namespace clang;
25
Benjamin Kramer7e220282010-05-26 09:58:31 +000026namespace {
Anders Carlsson6a91c032010-05-26 15:32:58 +000027
Anders Carlssonea2f41c2010-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 Carlsson4a257992010-05-28 21:13:31 +000041 const CXXRecordDecl *Class;
Anders Carlssonea2f41c2010-05-28 21:24:37 +000042
43 /// IsVirtual - Whether the BaseInfo represents a virtual base or not.
Anders Carlsson4a257992010-05-28 21:13:31 +000044 bool IsVirtual;
45
Anders Carlssonea2f41c2010-05-28 21:24:37 +000046 /// Bases - Information about the base subobjects.
47 llvm::SmallVector<BaseSubobjectInfo*, 4> Bases;
48
Anders Carlsson6e264542010-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 Carlssonea2f41c2010-05-28 21:24:37 +000052
53 // FIXME: Document.
54 const BaseSubobjectInfo *Derived;
Anders Carlsson4a257992010-05-28 21:13:31 +000055};
56
Anders Carlsson6a91c032010-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 Foad4ba2a172011-01-12 09:06:06 +000060 const ASTContext &Context;
Anders Carlsson8c6acc62010-10-31 21:54:55 +000061 uint64_t CharWidth;
62
Anders Carlsson6a91c032010-05-26 15:32:58 +000063 /// Class - The class whose empty entries we're keeping track of.
64 const CXXRecordDecl *Class;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +000065
Anders Carlsson58b16b62010-05-27 05:41:06 +000066 /// EmptyClassOffsets - A map from offsets to empty record decls.
67 typedef llvm::SmallVector<const CXXRecordDecl *, 1> ClassVectorTy;
Anders Carlssond8da7632010-10-31 21:22:43 +000068 typedef llvm::DenseMap<CharUnits, ClassVectorTy> EmptyClassOffsetsMapTy;
Anders Carlsson58b16b62010-05-27 05:41:06 +000069 EmptyClassOffsetsMapTy EmptyClassOffsets;
70
Anders Carlssonc8cb4622010-06-08 15:56:03 +000071 /// MaxEmptyClassOffset - The highest offset known to contain an empty
72 /// base subobject.
Anders Carlssonfe5ef732010-10-31 21:39:24 +000073 CharUnits MaxEmptyClassOffset;
Anders Carlssonc8cb4622010-06-08 15:56:03 +000074
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +000075 /// ComputeEmptySubobjectSizes - Compute the size of the largest base or
Anders Carlsson0c54fc92010-05-26 15:54:25 +000076 /// member subobject that is empty.
77 void ComputeEmptySubobjectSizes();
Anders Carlsson58b16b62010-05-27 05:41:06 +000078
Anders Carlssonfe5ef732010-10-31 21:39:24 +000079 void AddSubobjectAtOffset(const CXXRecordDecl *RD, CharUnits Offset);
Anders Carlsson812a3452010-05-27 18:20:57 +000080
Anders Carlssonea2f41c2010-05-28 21:24:37 +000081 void UpdateEmptyBaseSubobjects(const BaseSubobjectInfo *Info,
Anders Carlssona3d43802010-10-31 22:13:23 +000082 CharUnits Offset, bool PlacingEmptyBase);
Anders Carlsson58b16b62010-05-27 05:41:06 +000083
Anders Carlsson812a3452010-05-27 18:20:57 +000084 void UpdateEmptyFieldSubobjects(const CXXRecordDecl *RD,
85 const CXXRecordDecl *Class,
Anders Carlssona3d43802010-10-31 22:13:23 +000086 CharUnits Offset);
87 void UpdateEmptyFieldSubobjects(const FieldDecl *FD, CharUnits Offset);
Anders Carlsson812a3452010-05-27 18:20:57 +000088
Anders Carlssonc8cb4622010-06-08 15:56:03 +000089 /// AnyEmptySubobjectsBeyondOffset - Returns whether there are any empty
90 /// subobjects beyond the given offset.
Anders Carlssonfe5ef732010-10-31 21:39:24 +000091 bool AnyEmptySubobjectsBeyondOffset(CharUnits Offset) const {
Anders Carlssonc8cb4622010-06-08 15:56:03 +000092 return Offset <= MaxEmptyClassOffset;
93 }
94
Anders Carlsson8c6acc62010-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 Dyckff3a5172011-01-24 01:28:50 +0000101 return Context.toCharUnitsFromBits(FieldOffset);
Anders Carlssond8da7632010-10-31 21:22:43 +0000102 }
Anders Carlssond8da7632010-10-31 21:22:43 +0000103
Charles Davisc9f8aec2010-08-19 00:55:19 +0000104protected:
Anders Carlssonfe5ef732010-10-31 21:39:24 +0000105 bool CanPlaceSubobjectAtOffset(const CXXRecordDecl *RD,
106 CharUnits Offset) const;
Charles Davisc9f8aec2010-08-19 00:55:19 +0000107
108 bool CanPlaceBaseSubobjectAtOffset(const BaseSubobjectInfo *Info,
Anders Carlssona3d43802010-10-31 22:13:23 +0000109 CharUnits Offset);
Charles Davisc9f8aec2010-08-19 00:55:19 +0000110
111 bool CanPlaceFieldSubobjectAtOffset(const CXXRecordDecl *RD,
112 const CXXRecordDecl *Class,
Anders Carlssona3d43802010-10-31 22:13:23 +0000113 CharUnits Offset) const;
Charles Davisc9f8aec2010-08-19 00:55:19 +0000114 bool CanPlaceFieldSubobjectAtOffset(const FieldDecl *FD,
Anders Carlsson8c6acc62010-10-31 21:54:55 +0000115 CharUnits Offset) const;
Charles Davisc9f8aec2010-08-19 00:55:19 +0000116
Anders Carlsson6a91c032010-05-26 15:32:58 +0000117public:
Anders Carlsson0c54fc92010-05-26 15:54:25 +0000118 /// This holds the size of the largest empty subobject (either a base
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000119 /// or a member). Will be zero if the record being built doesn't contain
Anders Carlsson0c54fc92010-05-26 15:54:25 +0000120 /// any empty classes.
Anders Carlssona3d43802010-10-31 22:13:23 +0000121 CharUnits SizeOfLargestEmptySubobject;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000122
Jay Foad4ba2a172011-01-12 09:06:06 +0000123 EmptySubobjectMap(const ASTContext &Context, const CXXRecordDecl *Class)
Anders Carlssona3d43802010-10-31 22:13:23 +0000124 : Context(Context), CharWidth(Context.getCharWidth()), Class(Class) {
Anders Carlsson261febd2010-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 Dunbar0aa7edb2010-05-27 02:25:46 +0000130 /// Returns false if placing the record will result in two components
Anders Carlsson261febd2010-05-27 00:07:01 +0000131 /// (direct or indirect) of the same type having the same offset.
Anders Carlssonc8cb4622010-06-08 15:56:03 +0000132 bool CanPlaceBaseAtOffset(const BaseSubobjectInfo *Info,
Anders Carlssona3d43802010-10-31 22:13:23 +0000133 CharUnits Offset);
Anders Carlsson812a3452010-05-27 18:20:57 +0000134
135 /// CanPlaceFieldAtOffset - Return whether a field can be placed at the given
136 /// offset.
Anders Carlssona3d43802010-10-31 22:13:23 +0000137 bool CanPlaceFieldAtOffset(const FieldDecl *FD, CharUnits Offset);
Anders Carlsson6a91c032010-05-26 15:32:58 +0000138};
Anders Carlsson0c54fc92010-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 Carlssona3d43802010-10-31 22:13:23 +0000147 CharUnits EmptySize;
Anders Carlsson0c54fc92010-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 Dyck5f022d82011-02-09 01:59:34 +0000151 EmptySize = Layout.getSize();
Anders Carlsson0c54fc92010-05-26 15:54:25 +0000152 } else {
153 // Otherwise, we get the largest empty subobject for the decl.
154 EmptySize = Layout.getSizeOfLargestEmptySubobject();
155 }
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000156
Anders Carlssona3d43802010-10-31 22:13:23 +0000157 if (EmptySize > SizeOfLargestEmptySubobject)
158 SizeOfLargestEmptySubobject = EmptySize;
Anders Carlsson0c54fc92010-05-26 15:54:25 +0000159 }
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000160
Anders Carlsson0c54fc92010-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 Dunbar0aa7edb2010-05-27 02:25:46 +0000165
166 const RecordType *RT =
Anders Carlsson0c54fc92010-05-26 15:54:25 +0000167 Context.getBaseElementType(FD->getType())->getAs<RecordType>();
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000168
Anders Carlsson0c54fc92010-05-26 15:54:25 +0000169 // We only care about record types.
170 if (!RT)
171 continue;
172
Anders Carlssona3d43802010-10-31 22:13:23 +0000173 CharUnits EmptySize;
Anders Carlsson0c54fc92010-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 Dyck5f022d82011-02-09 01:59:34 +0000178 EmptySize = Layout.getSize();
Anders Carlsson0c54fc92010-05-26 15:54:25 +0000179 } else {
180 // Otherwise, we get the largest empty subobject for the decl.
181 EmptySize = Layout.getSizeOfLargestEmptySubobject();
182 }
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000183
Anders Carlssona3d43802010-10-31 22:13:23 +0000184 if (EmptySize > SizeOfLargestEmptySubobject)
185 SizeOfLargestEmptySubobject = EmptySize;
Anders Carlsson0c54fc92010-05-26 15:54:25 +0000186 }
187}
188
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000189bool
Anders Carlsson812a3452010-05-27 18:20:57 +0000190EmptySubobjectMap::CanPlaceSubobjectAtOffset(const CXXRecordDecl *RD,
Anders Carlssonfe5ef732010-10-31 21:39:24 +0000191 CharUnits Offset) const {
Anders Carlsson812a3452010-05-27 18:20:57 +0000192 // We only need to check empty bases.
193 if (!RD->isEmpty())
194 return true;
195
Anders Carlssonfe5ef732010-10-31 21:39:24 +0000196 EmptyClassOffsetsMapTy::const_iterator I = EmptyClassOffsets.find(Offset);
Anders Carlsson812a3452010-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 Carlssonfe5ef732010-10-31 21:39:24 +0000209 CharUnits Offset) {
Anders Carlsson812a3452010-05-27 18:20:57 +0000210 // We only care about empty bases.
211 if (!RD->isEmpty())
212 return;
213
Rafael Espindola272324b2010-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 Carlssonfe5ef732010-10-31 21:39:24 +0000216 ClassVectorTy& Classes = EmptyClassOffsets[Offset];
Rafael Espindola272324b2010-12-29 23:02:58 +0000217 if (std::find(Classes.begin(), Classes.end(), RD) != Classes.end())
218 return;
219
Anders Carlsson812a3452010-05-27 18:20:57 +0000220 Classes.push_back(RD);
Anders Carlssonc8cb4622010-06-08 15:56:03 +0000221
222 // Update the empty class offset.
Anders Carlssonfe5ef732010-10-31 21:39:24 +0000223 if (Offset > MaxEmptyClassOffset)
224 MaxEmptyClassOffset = Offset;
Anders Carlsson812a3452010-05-27 18:20:57 +0000225}
226
227bool
Anders Carlssona3d43802010-10-31 22:13:23 +0000228EmptySubobjectMap::CanPlaceBaseSubobjectAtOffset(const BaseSubobjectInfo *Info,
229 CharUnits Offset) {
Anders Carlsson2177ab72010-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 Carlssona3d43802010-10-31 22:13:23 +0000232 if (!AnyEmptySubobjectsBeyondOffset(Offset))
Anders Carlsson2177ab72010-06-08 16:20:35 +0000233 return true;
234
Anders Carlssona3d43802010-10-31 22:13:23 +0000235 if (!CanPlaceSubobjectAtOffset(Info->Class, Offset))
Anders Carlsson812a3452010-05-27 18:20:57 +0000236 return false;
237
Anders Carlsson58b16b62010-05-27 05:41:06 +0000238 // Traverse all non-virtual bases.
Anders Carlsson4137d512010-05-29 21:10:24 +0000239 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Info->Class);
Anders Carlsson58b16b62010-05-27 05:41:06 +0000240 for (unsigned I = 0, E = Info->Bases.size(); I != E; ++I) {
Anders Carlssonea2f41c2010-05-28 21:24:37 +0000241 BaseSubobjectInfo* Base = Info->Bases[I];
Anders Carlsson58b16b62010-05-27 05:41:06 +0000242 if (Base->IsVirtual)
243 continue;
244
Anders Carlsson6a356742010-11-01 00:21:58 +0000245 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base->Class);
Anders Carlsson58b16b62010-05-27 05:41:06 +0000246
247 if (!CanPlaceBaseSubobjectAtOffset(Base, BaseOffset))
248 return false;
249 }
250
Anders Carlsson6e264542010-05-29 17:35:14 +0000251 if (Info->PrimaryVirtualBaseInfo) {
252 BaseSubobjectInfo *PrimaryVirtualBaseInfo = Info->PrimaryVirtualBaseInfo;
Anders Carlsson58b16b62010-05-27 05:41:06 +0000253
254 if (Info == PrimaryVirtualBaseInfo->Derived) {
255 if (!CanPlaceBaseSubobjectAtOffset(PrimaryVirtualBaseInfo, Offset))
256 return false;
257 }
258 }
259
Anders Carlsson812a3452010-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 Carlsson8c6acc62010-10-31 21:54:55 +0000265 if (FD->isBitField())
266 continue;
267
Anders Carlssona3d43802010-10-31 22:13:23 +0000268 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
Anders Carlsson812a3452010-05-27 18:20:57 +0000269 if (!CanPlaceFieldSubobjectAtOffset(FD, FieldOffset))
270 return false;
271 }
272
Anders Carlsson58b16b62010-05-27 05:41:06 +0000273 return true;
274}
275
Anders Carlssonea2f41c2010-05-28 21:24:37 +0000276void EmptySubobjectMap::UpdateEmptyBaseSubobjects(const BaseSubobjectInfo *Info,
Anders Carlssona3d43802010-10-31 22:13:23 +0000277 CharUnits Offset,
Anders Carlssone3362bc2010-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 Carlssona3d43802010-10-31 22:13:23 +0000288 AddSubobjectAtOffset(Info->Class, Offset);
Anders Carlsson4137d512010-05-29 21:10:24 +0000289
Anders Carlsson58b16b62010-05-27 05:41:06 +0000290 // Traverse all non-virtual bases.
Anders Carlsson4137d512010-05-29 21:10:24 +0000291 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Info->Class);
Anders Carlsson58b16b62010-05-27 05:41:06 +0000292 for (unsigned I = 0, E = Info->Bases.size(); I != E; ++I) {
Anders Carlssonea2f41c2010-05-28 21:24:37 +0000293 BaseSubobjectInfo* Base = Info->Bases[I];
Anders Carlsson58b16b62010-05-27 05:41:06 +0000294 if (Base->IsVirtual)
295 continue;
Anders Carlsson4137d512010-05-29 21:10:24 +0000296
Anders Carlsson6a356742010-11-01 00:21:58 +0000297 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base->Class);
Anders Carlssone3362bc2010-06-13 18:00:18 +0000298 UpdateEmptyBaseSubobjects(Base, BaseOffset, PlacingEmptyBase);
Anders Carlsson58b16b62010-05-27 05:41:06 +0000299 }
300
Anders Carlsson6e264542010-05-29 17:35:14 +0000301 if (Info->PrimaryVirtualBaseInfo) {
302 BaseSubobjectInfo *PrimaryVirtualBaseInfo = Info->PrimaryVirtualBaseInfo;
Anders Carlsson58b16b62010-05-27 05:41:06 +0000303
304 if (Info == PrimaryVirtualBaseInfo->Derived)
Anders Carlssone3362bc2010-06-13 18:00:18 +0000305 UpdateEmptyBaseSubobjects(PrimaryVirtualBaseInfo, Offset,
306 PlacingEmptyBase);
Anders Carlsson58b16b62010-05-27 05:41:06 +0000307 }
Anders Carlsson812a3452010-05-27 18:20:57 +0000308
Anders Carlsson812a3452010-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 Carlsson8c6acc62010-10-31 21:54:55 +0000314 if (FD->isBitField())
315 continue;
Anders Carlsson4137d512010-05-29 21:10:24 +0000316
Anders Carlssona3d43802010-10-31 22:13:23 +0000317 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
318 UpdateEmptyFieldSubobjects(FD, FieldOffset);
Anders Carlsson812a3452010-05-27 18:20:57 +0000319 }
Anders Carlsson58b16b62010-05-27 05:41:06 +0000320}
321
Anders Carlsson5b1319c2010-05-29 20:49:49 +0000322bool EmptySubobjectMap::CanPlaceBaseAtOffset(const BaseSubobjectInfo *Info,
Anders Carlssona3d43802010-10-31 22:13:23 +0000323 CharUnits Offset) {
Anders Carlsson261febd2010-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 Carlssona3d43802010-10-31 22:13:23 +0000326 if (SizeOfLargestEmptySubobject.isZero())
Anders Carlsson261febd2010-05-27 00:07:01 +0000327 return true;
328
Anders Carlsson58b16b62010-05-27 05:41:06 +0000329 if (!CanPlaceBaseSubobjectAtOffset(Info, Offset))
330 return false;
Anders Carlsson812a3452010-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 Carlssone3362bc2010-06-13 18:00:18 +0000334 UpdateEmptyBaseSubobjects(Info, Offset, Info->Class->isEmpty());
Anders Carlsson261febd2010-05-27 00:07:01 +0000335 return true;
336}
337
Anders Carlsson812a3452010-05-27 18:20:57 +0000338bool
339EmptySubobjectMap::CanPlaceFieldSubobjectAtOffset(const CXXRecordDecl *RD,
340 const CXXRecordDecl *Class,
Anders Carlssona3d43802010-10-31 22:13:23 +0000341 CharUnits Offset) const {
Anders Carlsson2177ab72010-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 Carlssona3d43802010-10-31 22:13:23 +0000344 if (!AnyEmptySubobjectsBeyondOffset(Offset))
Anders Carlsson2177ab72010-06-08 16:20:35 +0000345 return true;
346
Anders Carlssona3d43802010-10-31 22:13:23 +0000347 if (!CanPlaceSubobjectAtOffset(RD, Offset))
Anders Carlsson812a3452010-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 Carlsson6a356742010-11-01 00:21:58 +0000361 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(BaseDecl);
Anders Carlsson812a3452010-05-27 18:20:57 +0000362 if (!CanPlaceFieldSubobjectAtOffset(BaseDecl, Class, BaseOffset))
363 return false;
364 }
365
Anders Carlsson45f5b542010-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 Carlsson3069a0d2010-10-31 23:45:59 +0000373 CharUnits VBaseOffset = Offset + Layout.getVBaseClassOffset(VBaseDecl);
Anders Carlsson45f5b542010-06-08 19:09:24 +0000374 if (!CanPlaceFieldSubobjectAtOffset(VBaseDecl, Class, VBaseOffset))
375 return false;
376 }
377 }
378
Anders Carlsson812a3452010-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 Carlsson8c6acc62010-10-31 21:54:55 +0000384 if (FD->isBitField())
385 continue;
386
Anders Carlssona3d43802010-10-31 22:13:23 +0000387 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
Anders Carlsson812a3452010-05-27 18:20:57 +0000388
389 if (!CanPlaceFieldSubobjectAtOffset(FD, FieldOffset))
390 return false;
391 }
392
393 return true;
394}
395
Anders Carlsson8c6acc62010-10-31 21:54:55 +0000396bool
397EmptySubobjectMap::CanPlaceFieldSubobjectAtOffset(const FieldDecl *FD,
398 CharUnits Offset) const {
Anders Carlsson2177ab72010-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 Carlsson8c6acc62010-10-31 21:54:55 +0000401 if (!AnyEmptySubobjectsBeyondOffset(Offset))
Anders Carlsson2177ab72010-06-08 16:20:35 +0000402 return true;
403
Anders Carlsson812a3452010-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 Carlssona3d43802010-10-31 22:13:23 +0000407 return CanPlaceFieldSubobjectAtOffset(RD, RD, Offset);
Anders Carlsson812a3452010-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 Carlsson8c6acc62010-10-31 21:54:55 +0000421 CharUnits ElementOffset = Offset;
Anders Carlsson812a3452010-05-27 18:20:57 +0000422 for (uint64_t I = 0; I != NumElements; ++I) {
Anders Carlsson2177ab72010-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 Carlsson8c6acc62010-10-31 21:54:55 +0000425 if (!AnyEmptySubobjectsBeyondOffset(ElementOffset))
Anders Carlsson2177ab72010-06-08 16:20:35 +0000426 return true;
427
Anders Carlssona3d43802010-10-31 22:13:23 +0000428 if (!CanPlaceFieldSubobjectAtOffset(RD, RD, ElementOffset))
Anders Carlsson812a3452010-05-27 18:20:57 +0000429 return false;
430
Ken Dyck5f022d82011-02-09 01:59:34 +0000431 ElementOffset += Layout.getSize();
Anders Carlsson812a3452010-05-27 18:20:57 +0000432 }
433 }
434
435 return true;
436}
437
438bool
Anders Carlssona3d43802010-10-31 22:13:23 +0000439EmptySubobjectMap::CanPlaceFieldAtOffset(const FieldDecl *FD,
440 CharUnits Offset) {
441 if (!CanPlaceFieldSubobjectAtOffset(FD, Offset))
Anders Carlsson812a3452010-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 Carlssona3d43802010-10-31 22:13:23 +0000452 CharUnits Offset) {
Anders Carlsson5ccfdd82010-06-13 17:49:16 +0000453 // We know that the only empty subobjects that can conflict with empty
Anders Carlssone3362bc2010-06-13 18:00:18 +0000454 // field subobjects are subobjects of empty bases that can be placed at offset
Anders Carlsson5ccfdd82010-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 Carlssona3d43802010-10-31 22:13:23 +0000461 AddSubobjectAtOffset(RD, Offset);
Anders Carlsson812a3452010-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 Carlsson6a356742010-11-01 00:21:58 +0000474 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(BaseDecl);
Anders Carlsson812a3452010-05-27 18:20:57 +0000475 UpdateEmptyFieldSubobjects(BaseDecl, Class, BaseOffset);
476 }
477
Anders Carlsson45f5b542010-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 Carlsson3069a0d2010-10-31 23:45:59 +0000485 CharUnits VBaseOffset = Offset + Layout.getVBaseClassOffset(VBaseDecl);
Anders Carlsson45f5b542010-06-08 19:09:24 +0000486 UpdateEmptyFieldSubobjects(VBaseDecl, Class, VBaseOffset);
487 }
488 }
489
Anders Carlsson812a3452010-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 Carlssonfa84fba2010-11-01 15:14:51 +0000495 if (FD->isBitField())
496 continue;
497
Anders Carlssona3d43802010-10-31 22:13:23 +0000498 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
Anders Carlsson812a3452010-05-27 18:20:57 +0000499
Anders Carlssona3d43802010-10-31 22:13:23 +0000500 UpdateEmptyFieldSubobjects(FD, FieldOffset);
Anders Carlsson812a3452010-05-27 18:20:57 +0000501 }
502}
503
504void EmptySubobjectMap::UpdateEmptyFieldSubobjects(const FieldDecl *FD,
Anders Carlssona3d43802010-10-31 22:13:23 +0000505 CharUnits Offset) {
Anders Carlsson812a3452010-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 Carlssona3d43802010-10-31 22:13:23 +0000524 CharUnits ElementOffset = Offset;
Anders Carlsson812a3452010-05-27 18:20:57 +0000525
526 for (uint64_t I = 0; I != NumElements; ++I) {
Anders Carlsson5ccfdd82010-06-13 17:49:16 +0000527 // We know that the only empty subobjects that can conflict with empty
Anders Carlssone3362bc2010-06-13 18:00:18 +0000528 // field subobjects are subobjects of empty bases that can be placed at
Anders Carlsson5ccfdd82010-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 Carlsson812a3452010-05-27 18:20:57 +0000535 UpdateEmptyFieldSubobjects(RD, RD, ElementOffset);
Ken Dyck5f022d82011-02-09 01:59:34 +0000536 ElementOffset += Layout.getSize();
Anders Carlsson812a3452010-05-27 18:20:57 +0000537 }
538 }
539}
540
Anders Carlsson7d0918a2010-05-26 05:58:59 +0000541class RecordLayoutBuilder {
Charles Davisc9f8aec2010-08-19 00:55:19 +0000542protected:
Anders Carlsson9392fa62010-05-26 05:41:04 +0000543 // FIXME: Remove this and make the appropriate fields public.
544 friend class clang::ASTContext;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000545
Jay Foad4ba2a172011-01-12 09:06:06 +0000546 const ASTContext &Context;
Anders Carlsson9392fa62010-05-26 05:41:04 +0000547
Anders Carlsson6a91c032010-05-26 15:32:58 +0000548 EmptySubobjectMap *EmptySubobjects;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000549
Anders Carlsson9392fa62010-05-26 05:41:04 +0000550 /// Size - The current size of the record layout.
551 uint64_t Size;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000552
Anders Carlsson9392fa62010-05-26 05:41:04 +0000553 /// Alignment - The current alignment of the record layout.
554 unsigned Alignment;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000555
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +0000556 /// \brief The alignment if attribute packed is not used.
557 unsigned UnpackedAlignment;
558
Anders Carlsson9392fa62010-05-26 05:41:04 +0000559 llvm::SmallVector<uint64_t, 16> FieldOffsets;
560
561 /// Packed - Whether the record is packed or not.
Daniel Dunbarc6082fe2010-05-27 05:45:51 +0000562 unsigned Packed : 1;
563
564 unsigned IsUnion : 1;
565
566 unsigned IsMac68kAlign : 1;
Anders Carlsson9392fa62010-05-26 05:41:04 +0000567
568 /// UnfilledBitsInLastByte - If the last field laid out was a bitfield,
569 /// this contains the number of bits in the last byte that can be used for
570 /// an adjacent bitfield if necessary.
571 unsigned char UnfilledBitsInLastByte;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000572
Anders Carlsson9392fa62010-05-26 05:41:04 +0000573 /// MaxFieldAlignment - The maximum allowed field alignment. This is set by
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000574 /// #pragma pack.
Anders Carlsson9392fa62010-05-26 05:41:04 +0000575 unsigned MaxFieldAlignment;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000576
Anders Carlsson9392fa62010-05-26 05:41:04 +0000577 /// DataSize - The data size of the record being laid out.
578 uint64_t DataSize;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000579
Anders Carlsson9392fa62010-05-26 05:41:04 +0000580 uint64_t NonVirtualSize;
581 unsigned NonVirtualAlignment;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000582
Anders Carlsson9392fa62010-05-26 05:41:04 +0000583 /// PrimaryBase - the primary base class (if one exists) of the class
584 /// we're laying out.
585 const CXXRecordDecl *PrimaryBase;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000586
Anders Carlsson9392fa62010-05-26 05:41:04 +0000587 /// PrimaryBaseIsVirtual - Whether the primary base of the class we're laying
588 /// out is virtual.
589 bool PrimaryBaseIsVirtual;
590
Anders Carlsson376bda92010-10-31 21:01:46 +0000591 typedef llvm::DenseMap<const CXXRecordDecl *, CharUnits> BaseOffsetsMapTy;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000592
Anders Carlsson9392fa62010-05-26 05:41:04 +0000593 /// Bases - base classes and their offsets in the record.
594 BaseOffsetsMapTy Bases;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000595
Anders Carlsson9392fa62010-05-26 05:41:04 +0000596 // VBases - virtual base classes and their offsets in the record.
597 BaseOffsetsMapTy VBases;
598
599 /// IndirectPrimaryBases - Virtual base classes, direct or indirect, that are
600 /// primary base classes for some other direct or indirect base class.
Anders Carlsson245656e2010-11-24 22:55:48 +0000601 CXXIndirectPrimaryBaseSet IndirectPrimaryBases;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000602
Anders Carlsson9392fa62010-05-26 05:41:04 +0000603 /// FirstNearlyEmptyVBase - The first nearly empty virtual base class in
604 /// inheritance graph order. Used for determining the primary base class.
605 const CXXRecordDecl *FirstNearlyEmptyVBase;
606
607 /// VisitedVirtualBases - A set of all the visited virtual bases, used to
608 /// avoid visiting virtual bases more than once.
609 llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBases;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000610
Jay Foad4ba2a172011-01-12 09:06:06 +0000611 RecordLayoutBuilder(const ASTContext &Context, EmptySubobjectMap
612 *EmptySubobjects)
Anders Carlsson261febd2010-05-27 00:07:01 +0000613 : Context(Context), EmptySubobjects(EmptySubobjects), Size(0), Alignment(8),
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +0000614 UnpackedAlignment(Alignment), Packed(false), IsUnion(false),
615 IsMac68kAlign(false), UnfilledBitsInLastByte(0), MaxFieldAlignment(0),
616 DataSize(0), NonVirtualSize(0), NonVirtualAlignment(8), PrimaryBase(0),
Daniel Dunbarc6082fe2010-05-27 05:45:51 +0000617 PrimaryBaseIsVirtual(false), FirstNearlyEmptyVBase(0) { }
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000618
Ken Dyckff3a5172011-01-24 01:28:50 +0000619 // FIXME: Remove this.
Anders Carlssonfe5ef732010-10-31 21:39:24 +0000620 uint64_t toOffset(CharUnits Offset) const {
621 return Offset.getQuantity() * Context.getCharWidth();
622 }
623
Anders Carlsson9392fa62010-05-26 05:41:04 +0000624 void Layout(const RecordDecl *D);
Anders Carlssonc6cab682010-05-26 15:10:00 +0000625 void Layout(const CXXRecordDecl *D);
Anders Carlsson9392fa62010-05-26 05:41:04 +0000626 void Layout(const ObjCInterfaceDecl *D);
627
628 void LayoutFields(const RecordDecl *D);
629 void LayoutField(const FieldDecl *D);
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +0000630 void LayoutWideBitField(uint64_t FieldSize, uint64_t TypeSize,
631 bool FieldPacked, const FieldDecl *D);
Anders Carlsson9392fa62010-05-26 05:41:04 +0000632 void LayoutBitField(const FieldDecl *D);
633
Anders Carlsson6e264542010-05-29 17:35:14 +0000634 /// BaseSubobjectInfoAllocator - Allocator for BaseSubobjectInfo objects.
635 llvm::SpecificBumpPtrAllocator<BaseSubobjectInfo> BaseSubobjectInfoAllocator;
636
637 typedef llvm::DenseMap<const CXXRecordDecl *, BaseSubobjectInfo *>
638 BaseSubobjectInfoMapTy;
639
640 /// VirtualBaseInfo - Map from all the (direct or indirect) virtual bases
641 /// of the class we're laying out to their base subobject info.
642 BaseSubobjectInfoMapTy VirtualBaseInfo;
643
644 /// NonVirtualBaseInfo - Map from all the direct non-virtual bases of the
645 /// class we're laying out to their base subobject info.
646 BaseSubobjectInfoMapTy NonVirtualBaseInfo;
647
648 /// ComputeBaseSubobjectInfo - Compute the base subobject information for the
649 /// bases of the given class.
650 void ComputeBaseSubobjectInfo(const CXXRecordDecl *RD);
651
652 /// ComputeBaseSubobjectInfo - Compute the base subobject information for a
653 /// single class and all of its base classes.
654 BaseSubobjectInfo *ComputeBaseSubobjectInfo(const CXXRecordDecl *RD,
655 bool IsVirtual,
656 BaseSubobjectInfo *Derived);
Anders Carlsson9392fa62010-05-26 05:41:04 +0000657
658 /// DeterminePrimaryBase - Determine the primary base of the given class.
659 void DeterminePrimaryBase(const CXXRecordDecl *RD);
660
661 void SelectPrimaryVBase(const CXXRecordDecl *RD);
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000662
Charles Davisc9f8aec2010-08-19 00:55:19 +0000663 virtual uint64_t GetVirtualPointersSize(const CXXRecordDecl *RD) const;
664
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000665 /// LayoutNonVirtualBases - Determines the primary base class (if any) and
Anders Carlsson9392fa62010-05-26 05:41:04 +0000666 /// lays it out. Will then proceed to lay out all non-virtual base clasess.
667 void LayoutNonVirtualBases(const CXXRecordDecl *RD);
668
669 /// LayoutNonVirtualBase - Lays out a single non-virtual base.
Anders Carlsson07cebc52010-05-29 17:42:25 +0000670 void LayoutNonVirtualBase(const BaseSubobjectInfo *Base);
Anders Carlsson9392fa62010-05-26 05:41:04 +0000671
Anders Carlssona2311512010-10-31 22:20:42 +0000672 void AddPrimaryVirtualBaseOffsets(const BaseSubobjectInfo *Info,
673 CharUnits Offset);
Anders Carlsson9392fa62010-05-26 05:41:04 +0000674
675 /// LayoutVirtualBases - Lays out all the virtual bases.
676 void LayoutVirtualBases(const CXXRecordDecl *RD,
677 const CXXRecordDecl *MostDerivedClass);
678
679 /// LayoutVirtualBase - Lays out a single virtual base.
Anders Carlsson276b4912010-05-29 17:48:36 +0000680 void LayoutVirtualBase(const BaseSubobjectInfo *Base);
Anders Carlsson9392fa62010-05-26 05:41:04 +0000681
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000682 /// LayoutBase - Will lay out a base and return the offset where it was
Anders Carlssona2311512010-10-31 22:20:42 +0000683 /// placed, in chars.
684 CharUnits LayoutBase(const BaseSubobjectInfo *Base);
Anders Carlsson9392fa62010-05-26 05:41:04 +0000685
Anders Carlssonc6cab682010-05-26 15:10:00 +0000686 /// InitializeLayout - Initialize record layout for the given record decl.
Daniel Dunbarc6082fe2010-05-27 05:45:51 +0000687 void InitializeLayout(const Decl *D);
Anders Carlssonc6cab682010-05-26 15:10:00 +0000688
Anders Carlsson9392fa62010-05-26 05:41:04 +0000689 /// FinishLayout - Finalize record layout. Adjust record size based on the
690 /// alignment.
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +0000691 void FinishLayout(const NamedDecl *D);
Anders Carlsson9392fa62010-05-26 05:41:04 +0000692
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +0000693 void UpdateAlignment(unsigned NewAlignment, unsigned UnpackedNewAlignment);
694 void UpdateAlignment(unsigned NewAlignment) {
695 UpdateAlignment(NewAlignment, NewAlignment);
696 }
697
698 void CheckFieldPadding(uint64_t Offset, uint64_t UnpaddedOffset,
699 uint64_t UnpackedOffset, unsigned UnpackedAlign,
700 bool isPacked, const FieldDecl *D);
701
702 DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID);
Anders Carlsson9392fa62010-05-26 05:41:04 +0000703
Argyrios Kyrtzidisc83d2d72010-08-15 10:17:39 +0000704 RecordLayoutBuilder(const RecordLayoutBuilder&); // DO NOT IMPLEMENT
705 void operator=(const RecordLayoutBuilder&); // DO NOT IMPLEMENT
Anders Carlsson9392fa62010-05-26 05:41:04 +0000706public:
707 static const CXXMethodDecl *ComputeKeyFunction(const CXXRecordDecl *RD);
Argyrios Kyrtzidiscfe17e52010-08-25 00:32:14 +0000708
709 virtual ~RecordLayoutBuilder() { }
Anders Carlsson9392fa62010-05-26 05:41:04 +0000710};
Benjamin Kramer7e220282010-05-26 09:58:31 +0000711} // end anonymous namespace
Anders Carlsson9392fa62010-05-26 05:41:04 +0000712
Anders Carlsson3f066522009-09-22 03:02:06 +0000713void
Anders Carlsson7d0918a2010-05-26 05:58:59 +0000714RecordLayoutBuilder::SelectPrimaryVBase(const CXXRecordDecl *RD) {
Anders Carlsson584e1df2010-03-11 03:39:12 +0000715 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +0000716 E = RD->bases_end(); I != E; ++I) {
Anders Carlsson584e1df2010-03-11 03:39:12 +0000717 assert(!I->getType()->isDependentType() &&
Sebastian Redl9994a342009-10-25 17:03:50 +0000718 "Cannot layout class with dependent bases.");
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +0000719
Mike Stump1eb44332009-09-09 15:08:12 +0000720 const CXXRecordDecl *Base =
Anders Carlsson584e1df2010-03-11 03:39:12 +0000721 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson200c5c22010-03-11 00:15:35 +0000722
Anders Carlsson584e1df2010-03-11 03:39:12 +0000723 // Check if this is a nearly empty virtual base.
Anders Carlssondae0cb52010-11-25 01:51:53 +0000724 if (I->isVirtual() && Context.isNearlyEmpty(Base)) {
Anders Carlsson584e1df2010-03-11 03:39:12 +0000725 // If it's not an indirect primary base, then we've found our primary
726 // base.
Anders Carlsson3f066522009-09-22 03:02:06 +0000727 if (!IndirectPrimaryBases.count(Base)) {
Anders Carlsson28fdd0a2010-05-26 05:20:58 +0000728 PrimaryBase = Base;
729 PrimaryBaseIsVirtual = true;
Mike Stumpd76264e2009-08-12 21:50:08 +0000730 return;
731 }
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +0000732
Anders Carlsson584e1df2010-03-11 03:39:12 +0000733 // Is this the first nearly empty virtual base?
734 if (!FirstNearlyEmptyVBase)
735 FirstNearlyEmptyVBase = Base;
Mike Stumpd76264e2009-08-12 21:50:08 +0000736 }
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +0000737
Anders Carlsson200c5c22010-03-11 00:15:35 +0000738 SelectPrimaryVBase(Base);
Anders Carlsson28fdd0a2010-05-26 05:20:58 +0000739 if (PrimaryBase)
Zhongxing Xu94ba3802010-02-15 04:28:35 +0000740 return;
Mike Stumpd76264e2009-08-12 21:50:08 +0000741 }
742}
743
Charles Davisc9f8aec2010-08-19 00:55:19 +0000744uint64_t
745RecordLayoutBuilder::GetVirtualPointersSize(const CXXRecordDecl *RD) const {
746 return Context.Target.getPointerWidth(0);
747}
748
Anders Carlsson200c5c22010-03-11 00:15:35 +0000749/// DeterminePrimaryBase - Determine the primary base of the given class.
Anders Carlsson7d0918a2010-05-26 05:58:59 +0000750void RecordLayoutBuilder::DeterminePrimaryBase(const CXXRecordDecl *RD) {
Anders Carlsson200c5c22010-03-11 00:15:35 +0000751 // If the class isn't dynamic, it won't have a primary base.
752 if (!RD->isDynamicClass())
753 return;
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +0000754
Anders Carlsson3f066522009-09-22 03:02:06 +0000755 // Compute all the primary virtual bases for all of our direct and
Mike Stump0880e752009-08-13 23:26:06 +0000756 // indirect bases, and record all their primary virtual base classes.
Anders Carlsson245656e2010-11-24 22:55:48 +0000757 RD->getIndirectPrimaryBases(IndirectPrimaryBases);
Mike Stump0880e752009-08-13 23:26:06 +0000758
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +0000759 // If the record has a dynamic base class, attempt to choose a primary base
760 // class. It is the first (in direct base class order) non-virtual dynamic
Anders Carlsson3f066522009-09-22 03:02:06 +0000761 // base class, if one exists.
Mike Stump6f376332009-08-05 22:37:18 +0000762 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +0000763 e = RD->bases_end(); i != e; ++i) {
Anders Carlssonce2009a2009-11-27 22:05:05 +0000764 // Ignore virtual bases.
765 if (i->isVirtual())
766 continue;
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +0000767
Anders Carlssonce2009a2009-11-27 22:05:05 +0000768 const CXXRecordDecl *Base =
769 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
770
771 if (Base->isDynamicClass()) {
772 // We found it.
Anders Carlsson28fdd0a2010-05-26 05:20:58 +0000773 PrimaryBase = Base;
774 PrimaryBaseIsVirtual = false;
Anders Carlssonce2009a2009-11-27 22:05:05 +0000775 return;
Mike Stump6f376332009-08-05 22:37:18 +0000776 }
777 }
778
779 // Otherwise, it is the first nearly empty virtual base that is not an
Mike Stump49520942009-08-11 04:03:59 +0000780 // indirect primary virtual base class, if one exists.
Anders Carlsson200c5c22010-03-11 00:15:35 +0000781 if (RD->getNumVBases() != 0) {
782 SelectPrimaryVBase(RD);
Anders Carlsson28fdd0a2010-05-26 05:20:58 +0000783 if (PrimaryBase)
Anders Carlsson200c5c22010-03-11 00:15:35 +0000784 return;
785 }
Mike Stump6f376332009-08-05 22:37:18 +0000786
Anders Carlsson200c5c22010-03-11 00:15:35 +0000787 // Otherwise, it is the first nearly empty virtual base that is not an
788 // indirect primary virtual base class, if one exists.
789 if (FirstNearlyEmptyVBase) {
Anders Carlsson28fdd0a2010-05-26 05:20:58 +0000790 PrimaryBase = FirstNearlyEmptyVBase;
791 PrimaryBaseIsVirtual = true;
Mike Stump6f376332009-08-05 22:37:18 +0000792 return;
Anders Carlsson200c5c22010-03-11 00:15:35 +0000793 }
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +0000794
Anders Carlsson200c5c22010-03-11 00:15:35 +0000795 // Otherwise there is no primary base class.
Anders Carlsson28fdd0a2010-05-26 05:20:58 +0000796 assert(!PrimaryBase && "Should not get here with a primary base!");
Mike Stump6f376332009-08-05 22:37:18 +0000797
Anders Carlsson200c5c22010-03-11 00:15:35 +0000798 // Allocate the virtual table pointer at offset zero.
799 assert(DataSize == 0 && "Vtable pointer must be at offset zero!");
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +0000800
Anders Carlsson200c5c22010-03-11 00:15:35 +0000801 // Update the size.
Charles Davisc9f8aec2010-08-19 00:55:19 +0000802 Size += GetVirtualPointersSize(RD);
Anders Carlsson200c5c22010-03-11 00:15:35 +0000803 DataSize = Size;
804
Argyrios Kyrtzidis5a821192010-12-09 02:47:58 +0000805 unsigned UnpackedBaseAlign = Context.Target.getPointerAlign(0);
806 unsigned BaseAlign = (Packed) ? 8 : UnpackedBaseAlign;
807
808 // The maximum field alignment overrides base align.
809 if (MaxFieldAlignment) {
810 BaseAlign = std::min(BaseAlign, MaxFieldAlignment);
811 UnpackedBaseAlign = std::min(UnpackedBaseAlign, MaxFieldAlignment);
812 }
813
Anders Carlsson200c5c22010-03-11 00:15:35 +0000814 // Update the alignment.
Argyrios Kyrtzidis5a821192010-12-09 02:47:58 +0000815 UpdateAlignment(BaseAlign, UnpackedBaseAlign);
Mike Stump6f376332009-08-05 22:37:18 +0000816}
817
Anders Carlsson6e264542010-05-29 17:35:14 +0000818BaseSubobjectInfo *
819RecordLayoutBuilder::ComputeBaseSubobjectInfo(const CXXRecordDecl *RD,
820 bool IsVirtual,
821 BaseSubobjectInfo *Derived) {
822 BaseSubobjectInfo *Info;
823
824 if (IsVirtual) {
825 // Check if we already have info about this virtual base.
826 BaseSubobjectInfo *&InfoSlot = VirtualBaseInfo[RD];
827 if (InfoSlot) {
828 assert(InfoSlot->Class == RD && "Wrong class for virtual base info!");
829 return InfoSlot;
830 }
831
832 // We don't, create it.
833 InfoSlot = new (BaseSubobjectInfoAllocator.Allocate()) BaseSubobjectInfo;
834 Info = InfoSlot;
835 } else {
836 Info = new (BaseSubobjectInfoAllocator.Allocate()) BaseSubobjectInfo;
837 }
838
839 Info->Class = RD;
840 Info->IsVirtual = IsVirtual;
841 Info->Derived = 0;
842 Info->PrimaryVirtualBaseInfo = 0;
843
844 const CXXRecordDecl *PrimaryVirtualBase = 0;
845 BaseSubobjectInfo *PrimaryVirtualBaseInfo = 0;
846
847 // Check if this base has a primary virtual base.
848 if (RD->getNumVBases()) {
849 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlssonc9e814b2010-11-24 23:12:57 +0000850 if (Layout.isPrimaryBaseVirtual()) {
Anders Carlsson6e264542010-05-29 17:35:14 +0000851 // This base does have a primary virtual base.
852 PrimaryVirtualBase = Layout.getPrimaryBase();
853 assert(PrimaryVirtualBase && "Didn't have a primary virtual base!");
854
855 // Now check if we have base subobject info about this primary base.
856 PrimaryVirtualBaseInfo = VirtualBaseInfo.lookup(PrimaryVirtualBase);
857
858 if (PrimaryVirtualBaseInfo) {
859 if (PrimaryVirtualBaseInfo->Derived) {
860 // We did have info about this primary base, and it turns out that it
861 // has already been claimed as a primary virtual base for another
862 // base.
863 PrimaryVirtualBase = 0;
864 } else {
865 // We can claim this base as our primary base.
866 Info->PrimaryVirtualBaseInfo = PrimaryVirtualBaseInfo;
867 PrimaryVirtualBaseInfo->Derived = Info;
868 }
869 }
870 }
871 }
872
873 // Now go through all direct bases.
874 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
875 E = RD->bases_end(); I != E; ++I) {
876 bool IsVirtual = I->isVirtual();
877
878 const CXXRecordDecl *BaseDecl =
879 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
880
881 Info->Bases.push_back(ComputeBaseSubobjectInfo(BaseDecl, IsVirtual, Info));
882 }
883
884 if (PrimaryVirtualBase && !PrimaryVirtualBaseInfo) {
885 // Traversing the bases must have created the base info for our primary
886 // virtual base.
887 PrimaryVirtualBaseInfo = VirtualBaseInfo.lookup(PrimaryVirtualBase);
888 assert(PrimaryVirtualBaseInfo &&
889 "Did not create a primary virtual base!");
890
891 // Claim the primary virtual base as our primary virtual base.
892 Info->PrimaryVirtualBaseInfo = PrimaryVirtualBaseInfo;
893 PrimaryVirtualBaseInfo->Derived = Info;
894 }
895
896 return Info;
897}
898
899void RecordLayoutBuilder::ComputeBaseSubobjectInfo(const CXXRecordDecl *RD) {
900 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
901 E = RD->bases_end(); I != E; ++I) {
902 bool IsVirtual = I->isVirtual();
903
904 const CXXRecordDecl *BaseDecl =
905 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
906
907 // Compute the base subobject info for this base.
908 BaseSubobjectInfo *Info = ComputeBaseSubobjectInfo(BaseDecl, IsVirtual, 0);
909
910 if (IsVirtual) {
911 // ComputeBaseInfo has already added this base for us.
912 assert(VirtualBaseInfo.count(BaseDecl) &&
913 "Did not add virtual base!");
914 } else {
915 // Add the base info to the map of non-virtual bases.
916 assert(!NonVirtualBaseInfo.count(BaseDecl) &&
917 "Non-virtual base already exists!");
918 NonVirtualBaseInfo.insert(std::make_pair(BaseDecl, Info));
919 }
920 }
921}
922
Anders Carlssone239b9d2010-03-10 22:21:28 +0000923void
Anders Carlsson7d0918a2010-05-26 05:58:59 +0000924RecordLayoutBuilder::LayoutNonVirtualBases(const CXXRecordDecl *RD) {
Anders Carlsson6e264542010-05-29 17:35:14 +0000925 // Then, determine the primary base class.
Anders Carlsson200c5c22010-03-11 00:15:35 +0000926 DeterminePrimaryBase(RD);
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +0000927
Anders Carlsson6e264542010-05-29 17:35:14 +0000928 // Compute base subobject info.
929 ComputeBaseSubobjectInfo(RD);
930
Anders Carlsson200c5c22010-03-11 00:15:35 +0000931 // If we have a primary base class, lay it out.
Anders Carlsson28fdd0a2010-05-26 05:20:58 +0000932 if (PrimaryBase) {
933 if (PrimaryBaseIsVirtual) {
Anders Carlsson6e264542010-05-29 17:35:14 +0000934 // If the primary virtual base was a primary virtual base of some other
935 // base class we'll have to steal it.
936 BaseSubobjectInfo *PrimaryBaseInfo = VirtualBaseInfo.lookup(PrimaryBase);
937 PrimaryBaseInfo->Derived = 0;
938
Anders Carlsson200c5c22010-03-11 00:15:35 +0000939 // We have a virtual primary base, insert it as an indirect primary base.
Anders Carlsson28fdd0a2010-05-26 05:20:58 +0000940 IndirectPrimaryBases.insert(PrimaryBase);
Anders Carlsson37147ea2010-03-11 05:42:17 +0000941
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000942 assert(!VisitedVirtualBases.count(PrimaryBase) &&
Anders Carlsson28fdd0a2010-05-26 05:20:58 +0000943 "vbase already visited!");
944 VisitedVirtualBases.insert(PrimaryBase);
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000945
Anders Carlsson276b4912010-05-29 17:48:36 +0000946 LayoutVirtualBase(PrimaryBaseInfo);
Anders Carlsson07cebc52010-05-29 17:42:25 +0000947 } else {
948 BaseSubobjectInfo *PrimaryBaseInfo =
949 NonVirtualBaseInfo.lookup(PrimaryBase);
950 assert(PrimaryBaseInfo &&
951 "Did not find base info for non-virtual primary base!");
952
953 LayoutNonVirtualBase(PrimaryBaseInfo);
954 }
Anders Carlsson200c5c22010-03-11 00:15:35 +0000955 }
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +0000956
Anders Carlsson200c5c22010-03-11 00:15:35 +0000957 // Now lay out the non-virtual bases.
958 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +0000959 E = RD->bases_end(); I != E; ++I) {
Anders Carlsson200c5c22010-03-11 00:15:35 +0000960
961 // Ignore virtual bases.
962 if (I->isVirtual())
963 continue;
964
Anders Carlsson07cebc52010-05-29 17:42:25 +0000965 const CXXRecordDecl *BaseDecl =
Anders Carlsson200c5c22010-03-11 00:15:35 +0000966 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
967
968 // Skip the primary base.
Anders Carlsson07cebc52010-05-29 17:42:25 +0000969 if (BaseDecl == PrimaryBase && !PrimaryBaseIsVirtual)
Anders Carlsson200c5c22010-03-11 00:15:35 +0000970 continue;
971
972 // Lay out the base.
Anders Carlsson07cebc52010-05-29 17:42:25 +0000973 BaseSubobjectInfo *BaseInfo = NonVirtualBaseInfo.lookup(BaseDecl);
974 assert(BaseInfo && "Did not find base info for non-virtual base!");
975
976 LayoutNonVirtualBase(BaseInfo);
Anders Carlssone239b9d2010-03-10 22:21:28 +0000977 }
978}
979
Anders Carlsson07cebc52010-05-29 17:42:25 +0000980void RecordLayoutBuilder::LayoutNonVirtualBase(const BaseSubobjectInfo *Base) {
Anders Carlssone3bdbee2010-03-10 22:26:24 +0000981 // Layout the base.
Anders Carlssona2311512010-10-31 22:20:42 +0000982 CharUnits Offset = LayoutBase(Base);
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +0000983
Anders Carlssone3bdbee2010-03-10 22:26:24 +0000984 // Add its base class offset.
Anders Carlsson07cebc52010-05-29 17:42:25 +0000985 assert(!Bases.count(Base->Class) && "base offset already exists!");
Anders Carlssona2311512010-10-31 22:20:42 +0000986 Bases.insert(std::make_pair(Base->Class, Offset));
Anders Carlsson3cd09cc2010-05-29 19:44:50 +0000987
988 AddPrimaryVirtualBaseOffsets(Base, Offset);
Anders Carlssone239b9d2010-03-10 22:21:28 +0000989}
Mike Stump968db332009-11-05 04:02:15 +0000990
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +0000991void
Anders Carlsson3cd09cc2010-05-29 19:44:50 +0000992RecordLayoutBuilder::AddPrimaryVirtualBaseOffsets(const BaseSubobjectInfo *Info,
Anders Carlssona2311512010-10-31 22:20:42 +0000993 CharUnits Offset) {
Anders Carlsson3cd09cc2010-05-29 19:44:50 +0000994 // This base isn't interesting, it has no virtual bases.
995 if (!Info->Class->getNumVBases())
996 return;
997
998 // First, check if we have a virtual primary base to add offsets for.
999 if (Info->PrimaryVirtualBaseInfo) {
1000 assert(Info->PrimaryVirtualBaseInfo->IsVirtual &&
1001 "Primary virtual base is not virtual!");
1002 if (Info->PrimaryVirtualBaseInfo->Derived == Info) {
1003 // Add the offset.
1004 assert(!VBases.count(Info->PrimaryVirtualBaseInfo->Class) &&
1005 "primary vbase offset already exists!");
1006 VBases.insert(std::make_pair(Info->PrimaryVirtualBaseInfo->Class,
Anders Carlssona2311512010-10-31 22:20:42 +00001007 Offset));
Anders Carlsson97913572010-04-15 16:12:58 +00001008
Anders Carlsson3cd09cc2010-05-29 19:44:50 +00001009 // Traverse the primary virtual base.
1010 AddPrimaryVirtualBaseOffsets(Info->PrimaryVirtualBaseInfo, Offset);
1011 }
Anders Carlsson97913572010-04-15 16:12:58 +00001012 }
1013
Anders Carlsson3cd09cc2010-05-29 19:44:50 +00001014 // Now go through all direct non-virtual bases.
1015 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Info->Class);
1016 for (unsigned I = 0, E = Info->Bases.size(); I != E; ++I) {
1017 const BaseSubobjectInfo *Base = Info->Bases[I];
1018 if (Base->IsVirtual)
Anders Carlsson97913572010-04-15 16:12:58 +00001019 continue;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001020
Anders Carlsson6a356742010-11-01 00:21:58 +00001021 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base->Class);
Anders Carlsson3cd09cc2010-05-29 19:44:50 +00001022 AddPrimaryVirtualBaseOffsets(Base, BaseOffset);
Anders Carlsson97913572010-04-15 16:12:58 +00001023 }
1024}
1025
1026void
Anders Carlsson7d0918a2010-05-26 05:58:59 +00001027RecordLayoutBuilder::LayoutVirtualBases(const CXXRecordDecl *RD,
Anders Carlsson97913572010-04-15 16:12:58 +00001028 const CXXRecordDecl *MostDerivedClass) {
Anders Carlsson88f42962010-03-11 04:33:54 +00001029 const CXXRecordDecl *PrimaryBase;
Anders Carlssonbdda6c12010-04-10 18:42:27 +00001030 bool PrimaryBaseIsVirtual;
Anders Carlsson37147ea2010-03-11 05:42:17 +00001031
Anders Carlssonbdda6c12010-04-10 18:42:27 +00001032 if (MostDerivedClass == RD) {
Anders Carlsson28fdd0a2010-05-26 05:20:58 +00001033 PrimaryBase = this->PrimaryBase;
1034 PrimaryBaseIsVirtual = this->PrimaryBaseIsVirtual;
Anders Carlssonbdda6c12010-04-10 18:42:27 +00001035 } else {
Anders Carlsson0f0e9b02010-04-16 15:07:51 +00001036 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlsson88f42962010-03-11 04:33:54 +00001037 PrimaryBase = Layout.getPrimaryBase();
Anders Carlssonc9e814b2010-11-24 23:12:57 +00001038 PrimaryBaseIsVirtual = Layout.isPrimaryBaseVirtual();
Anders Carlssonbdda6c12010-04-10 18:42:27 +00001039 }
1040
Anders Carlsson622e2472010-03-11 04:24:02 +00001041 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1042 E = RD->bases_end(); I != E; ++I) {
1043 assert(!I->getType()->isDependentType() &&
Sebastian Redl9994a342009-10-25 17:03:50 +00001044 "Cannot layout class with dependent bases.");
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001045
Anders Carlsson276b4912010-05-29 17:48:36 +00001046 const CXXRecordDecl *BaseDecl =
Anders Carlsson622e2472010-03-11 04:24:02 +00001047 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1048
1049 if (I->isVirtual()) {
Anders Carlsson276b4912010-05-29 17:48:36 +00001050 if (PrimaryBase != BaseDecl || !PrimaryBaseIsVirtual) {
1051 bool IndirectPrimaryBase = IndirectPrimaryBases.count(BaseDecl);
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001052
Anders Carlssonbdda6c12010-04-10 18:42:27 +00001053 // Only lay out the virtual base if it's not an indirect primary base.
1054 if (!IndirectPrimaryBase) {
1055 // Only visit virtual bases once.
Anders Carlsson276b4912010-05-29 17:48:36 +00001056 if (!VisitedVirtualBases.insert(BaseDecl))
Anders Carlssonbdda6c12010-04-10 18:42:27 +00001057 continue;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001058
Anders Carlsson276b4912010-05-29 17:48:36 +00001059 const BaseSubobjectInfo *BaseInfo = VirtualBaseInfo.lookup(BaseDecl);
1060 assert(BaseInfo && "Did not find virtual base info!");
1061 LayoutVirtualBase(BaseInfo);
Anders Carlsson147b5dd2010-03-11 04:10:39 +00001062 }
Mike Stump968db332009-11-05 04:02:15 +00001063 }
Mike Stump4ef98092009-08-13 22:53:07 +00001064 }
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001065
Anders Carlsson276b4912010-05-29 17:48:36 +00001066 if (!BaseDecl->getNumVBases()) {
Anders Carlsson622e2472010-03-11 04:24:02 +00001067 // This base isn't interesting since it doesn't have any virtual bases.
1068 continue;
Mike Stumpfe3010d2009-08-16 19:04:13 +00001069 }
Anders Carlsson622e2472010-03-11 04:24:02 +00001070
Anders Carlsson276b4912010-05-29 17:48:36 +00001071 LayoutVirtualBases(BaseDecl, MostDerivedClass);
Mike Stumpeb19fa92009-08-06 13:41:24 +00001072 }
1073}
1074
Anders Carlsson276b4912010-05-29 17:48:36 +00001075void RecordLayoutBuilder::LayoutVirtualBase(const BaseSubobjectInfo *Base) {
Anders Carlsson3cd09cc2010-05-29 19:44:50 +00001076 assert(!Base->Derived && "Trying to lay out a primary virtual base!");
1077
Anders Carlssone3bdbee2010-03-10 22:26:24 +00001078 // Layout the base.
Anders Carlssona2311512010-10-31 22:20:42 +00001079 CharUnits Offset = LayoutBase(Base);
Anders Carlssone3bdbee2010-03-10 22:26:24 +00001080
1081 // Add its base class offset.
Anders Carlsson276b4912010-05-29 17:48:36 +00001082 assert(!VBases.count(Base->Class) && "vbase offset already exists!");
Anders Carlssona2311512010-10-31 22:20:42 +00001083 VBases.insert(std::make_pair(Base->Class, Offset));
Anders Carlsson3cd09cc2010-05-29 19:44:50 +00001084
1085 AddPrimaryVirtualBaseOffsets(Base, Offset);
Anders Carlssone239b9d2010-03-10 22:21:28 +00001086}
1087
Anders Carlssona2311512010-10-31 22:20:42 +00001088CharUnits RecordLayoutBuilder::LayoutBase(const BaseSubobjectInfo *Base) {
Anders Carlssonb1d880b2010-05-29 20:47:33 +00001089 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Base->Class);
Anders Carlssone239b9d2010-03-10 22:21:28 +00001090
1091 // If we have an empty base class, try to place it at offset 0.
Anders Carlssonb1d880b2010-05-29 20:47:33 +00001092 if (Base->Class->isEmpty() &&
Anders Carlssona3d43802010-10-31 22:13:23 +00001093 EmptySubobjects->CanPlaceBaseAtOffset(Base, CharUnits::Zero())) {
Ken Dyck5f022d82011-02-09 01:59:34 +00001094 Size = std::max(Size,
1095 Layout.getSize().getQuantity() * Context.getCharWidth());
Anders Carlssone239b9d2010-03-10 22:21:28 +00001096
Anders Carlssona2311512010-10-31 22:20:42 +00001097 return CharUnits::Zero();
Anders Carlssone239b9d2010-03-10 22:21:28 +00001098 }
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001099
Ken Dyck68cf1a52011-02-08 02:02:47 +00001100 unsigned UnpackedBaseAlign =
1101 Layout.getNonVirtualAlign().getQuantity() * Context.getCharWidth();
Argyrios Kyrtzidis43ddd9f2010-12-09 00:35:20 +00001102 unsigned BaseAlign = (Packed) ? 8 : UnpackedBaseAlign;
1103
1104 // The maximum field alignment overrides base align.
1105 if (MaxFieldAlignment) {
1106 BaseAlign = std::min(BaseAlign, MaxFieldAlignment);
1107 UnpackedBaseAlign = std::min(UnpackedBaseAlign, MaxFieldAlignment);
1108 }
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001109
Anders Carlssone239b9d2010-03-10 22:21:28 +00001110 // Round up the current record size to the base's alignment boundary.
1111 uint64_t Offset = llvm::RoundUpToAlignment(DataSize, BaseAlign);
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001112
Anders Carlssone239b9d2010-03-10 22:21:28 +00001113 // Try to place the base.
Ken Dyckff3a5172011-01-24 01:28:50 +00001114 while (!EmptySubobjects->CanPlaceBaseAtOffset(Base,
1115 Context.toCharUnitsFromBits(Offset)))
Anders Carlssone239b9d2010-03-10 22:21:28 +00001116 Offset += BaseAlign;
Anders Carlssone239b9d2010-03-10 22:21:28 +00001117
Anders Carlssonb1d880b2010-05-29 20:47:33 +00001118 if (!Base->Class->isEmpty()) {
Anders Carlssone239b9d2010-03-10 22:21:28 +00001119 // Update the data size.
Ken Dyck5c3633f2011-02-01 01:52:10 +00001120 DataSize = Offset +
1121 (Layout.getNonVirtualSize().getQuantity() * Context.getCharWidth());
Anders Carlssone239b9d2010-03-10 22:21:28 +00001122
1123 Size = std::max(Size, DataSize);
1124 } else
Ken Dyck5f022d82011-02-09 01:59:34 +00001125 Size = std::max(Size,
1126 Offset + (Layout.getSize().getQuantity() * Context.getCharWidth()));
Anders Carlssone239b9d2010-03-10 22:21:28 +00001127
1128 // Remember max struct/class alignment.
Argyrios Kyrtzidis43ddd9f2010-12-09 00:35:20 +00001129 UpdateAlignment(BaseAlign, UnpackedBaseAlign);
Anders Carlssone239b9d2010-03-10 22:21:28 +00001130
Ken Dyckff3a5172011-01-24 01:28:50 +00001131 return Context.toCharUnitsFromBits(Offset);
Anders Carlssone239b9d2010-03-10 22:21:28 +00001132}
1133
Daniel Dunbarc6082fe2010-05-27 05:45:51 +00001134void RecordLayoutBuilder::InitializeLayout(const Decl *D) {
1135 if (const RecordDecl *RD = dyn_cast<RecordDecl>(D))
1136 IsUnion = RD->isUnion();
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001137
Anders Carlssona5dd7222009-08-08 19:38:24 +00001138 Packed = D->hasAttr<PackedAttr>();
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001139
Daniel Dunbarc6082fe2010-05-27 05:45:51 +00001140 // mac68k alignment supersedes maximum field alignment and attribute aligned,
1141 // and forces all structures to have 2-byte alignment. The IBM docs on it
1142 // allude to additional (more complicated) semantics, especially with regard
1143 // to bit-fields, but gcc appears not to follow that.
1144 if (D->hasAttr<AlignMac68kAttr>()) {
1145 IsMac68kAlign = true;
1146 MaxFieldAlignment = 2 * 8;
1147 Alignment = 2 * 8;
1148 } else {
1149 if (const MaxFieldAlignmentAttr *MFAA = D->getAttr<MaxFieldAlignmentAttr>())
1150 MaxFieldAlignment = MFAA->getAlignment();
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001151
Sean Huntcf807c42010-08-18 23:23:40 +00001152 if (unsigned MaxAlign = D->getMaxAlignment())
1153 UpdateAlignment(MaxAlign);
Daniel Dunbarc6082fe2010-05-27 05:45:51 +00001154 }
Anders Carlssonc6cab682010-05-26 15:10:00 +00001155}
Anders Carlsson74cbe222009-07-19 00:18:47 +00001156
Anders Carlssonc6cab682010-05-26 15:10:00 +00001157void RecordLayoutBuilder::Layout(const RecordDecl *D) {
1158 InitializeLayout(D);
Anders Carlssona2df41c2009-07-18 21:48:39 +00001159 LayoutFields(D);
Mike Stump1eb44332009-09-09 15:08:12 +00001160
Anders Carlssonbda4c102009-07-18 20:20:21 +00001161 // Finally, round the size of the total struct up to the alignment of the
1162 // struct itself.
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001163 FinishLayout(D);
Anders Carlssonc6cab682010-05-26 15:10:00 +00001164}
1165
1166void RecordLayoutBuilder::Layout(const CXXRecordDecl *RD) {
1167 InitializeLayout(RD);
1168
Anders Carlssonc6cab682010-05-26 15:10:00 +00001169 // Lay out the vtable and the non-virtual bases.
1170 LayoutNonVirtualBases(RD);
1171
1172 LayoutFields(RD);
1173
1174 NonVirtualSize = Size;
1175 NonVirtualAlignment = Alignment;
1176
1177 // Lay out the virtual bases and add the primary virtual base offsets.
1178 LayoutVirtualBases(RD, RD);
1179
1180 VisitedVirtualBases.clear();
Anders Carlssonc6cab682010-05-26 15:10:00 +00001181
1182 // Finally, round the size of the total struct up to the alignment of the
1183 // struct itself.
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001184 FinishLayout(RD);
Anders Carlssonc6cab682010-05-26 15:10:00 +00001185
Anders Carlssona1e87162010-04-10 21:24:48 +00001186#ifndef NDEBUG
Anders Carlssonc6cab682010-05-26 15:10:00 +00001187 // Check that we have base offsets for all bases.
1188 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1189 E = RD->bases_end(); I != E; ++I) {
1190 if (I->isVirtual())
1191 continue;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001192
Anders Carlssonc6cab682010-05-26 15:10:00 +00001193 const CXXRecordDecl *BaseDecl =
1194 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1195
1196 assert(Bases.count(BaseDecl) && "Did not find base offset!");
1197 }
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001198
Anders Carlssonc6cab682010-05-26 15:10:00 +00001199 // And all virtual bases.
1200 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
1201 E = RD->vbases_end(); I != E; ++I) {
1202 const CXXRecordDecl *BaseDecl =
1203 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001204
Anders Carlssonc6cab682010-05-26 15:10:00 +00001205 assert(VBases.count(BaseDecl) && "Did not find base offset!");
Anders Carlssona1e87162010-04-10 21:24:48 +00001206 }
1207#endif
Anders Carlssonbda4c102009-07-18 20:20:21 +00001208}
1209
Anders Carlsson7d0918a2010-05-26 05:58:59 +00001210void RecordLayoutBuilder::Layout(const ObjCInterfaceDecl *D) {
Anders Carlsson93fab9d2009-07-18 20:50:59 +00001211 if (ObjCInterfaceDecl *SD = D->getSuperClass()) {
Anders Carlsson0f0e9b02010-04-16 15:07:51 +00001212 const ASTRecordLayout &SL = Context.getASTObjCInterfaceLayout(SD);
Anders Carlsson93fab9d2009-07-18 20:50:59 +00001213
1214 UpdateAlignment(SL.getAlignment());
Mike Stump1eb44332009-09-09 15:08:12 +00001215
Anders Carlsson93fab9d2009-07-18 20:50:59 +00001216 // We start laying out ivars not at the end of the superclass
1217 // structure, but at the next byte following the last field.
Anders Carlsson243a6852009-07-18 21:26:44 +00001218 Size = llvm::RoundUpToAlignment(SL.getDataSize(), 8);
Anders Carlssona2239352009-09-26 01:34:51 +00001219 DataSize = Size;
Anders Carlsson93fab9d2009-07-18 20:50:59 +00001220 }
Mike Stump1eb44332009-09-09 15:08:12 +00001221
Daniel Dunbarc6082fe2010-05-27 05:45:51 +00001222 InitializeLayout(D);
Daniel Dunbar8a2c92c2010-05-27 01:12:46 +00001223
Anders Carlsson93fab9d2009-07-18 20:50:59 +00001224 // Layout each ivar sequentially.
1225 llvm::SmallVector<ObjCIvarDecl*, 16> Ivars;
Anders Carlsson0f0e9b02010-04-16 15:07:51 +00001226 Context.ShallowCollectObjCIvars(D, Ivars);
Anders Carlsson93fab9d2009-07-18 20:50:59 +00001227 for (unsigned i = 0, e = Ivars.size(); i != e; ++i)
1228 LayoutField(Ivars[i]);
Mike Stump1eb44332009-09-09 15:08:12 +00001229
Anders Carlsson93fab9d2009-07-18 20:50:59 +00001230 // Finally, round the size of the total struct up to the alignment of the
1231 // struct itself.
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001232 FinishLayout(D);
Anders Carlsson93fab9d2009-07-18 20:50:59 +00001233}
1234
Anders Carlsson7d0918a2010-05-26 05:58:59 +00001235void RecordLayoutBuilder::LayoutFields(const RecordDecl *D) {
Anders Carlssona2df41c2009-07-18 21:48:39 +00001236 // Layout each field, for now, just sequentially, respecting alignment. In
1237 // the future, this will need to be tweakable by targets.
Mike Stump1eb44332009-09-09 15:08:12 +00001238 for (RecordDecl::field_iterator Field = D->field_begin(),
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001239 FieldEnd = D->field_end(); Field != FieldEnd; ++Field)
Anders Carlssona2df41c2009-07-18 21:48:39 +00001240 LayoutField(*Field);
1241}
1242
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001243void RecordLayoutBuilder::LayoutWideBitField(uint64_t FieldSize,
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001244 uint64_t TypeSize,
1245 bool FieldPacked,
1246 const FieldDecl *D) {
Anders Carlsson4cf6f5f2010-04-16 15:57:11 +00001247 assert(Context.getLangOptions().CPlusPlus &&
1248 "Can only have wide bit-fields in C++!");
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001249
Anders Carlsson4cf6f5f2010-04-16 15:57:11 +00001250 // Itanium C++ ABI 2.4:
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001251 // If sizeof(T)*8 < n, let T' be the largest integral POD type with
Anders Carlsson4cf6f5f2010-04-16 15:57:11 +00001252 // sizeof(T')*8 <= n.
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001253
Anders Carlsson4cf6f5f2010-04-16 15:57:11 +00001254 QualType IntegralPODTypes[] = {
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001255 Context.UnsignedCharTy, Context.UnsignedShortTy, Context.UnsignedIntTy,
Anders Carlsson4cf6f5f2010-04-16 15:57:11 +00001256 Context.UnsignedLongTy, Context.UnsignedLongLongTy
1257 };
1258
Anders Carlsson4cf6f5f2010-04-16 15:57:11 +00001259 QualType Type;
1260 for (unsigned I = 0, E = llvm::array_lengthof(IntegralPODTypes);
1261 I != E; ++I) {
1262 uint64_t Size = Context.getTypeSize(IntegralPODTypes[I]);
Anders Carlsson4cf6f5f2010-04-16 15:57:11 +00001263
1264 if (Size > FieldSize)
1265 break;
1266
1267 Type = IntegralPODTypes[I];
1268 }
1269 assert(!Type.isNull() && "Did not find a type!");
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001270
Anders Carlsson4cf6f5f2010-04-16 15:57:11 +00001271 unsigned TypeAlign = Context.getTypeAlign(Type);
1272
1273 // We're not going to use any of the unfilled bits in the last byte.
1274 UnfilledBitsInLastByte = 0;
1275
Anders Carlssonde9f1532010-04-17 20:21:41 +00001276 uint64_t FieldOffset;
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001277 uint64_t UnpaddedFieldOffset = DataSize - UnfilledBitsInLastByte;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001278
Anders Carlsson4cf6f5f2010-04-16 15:57:11 +00001279 if (IsUnion) {
1280 DataSize = std::max(DataSize, FieldSize);
Anders Carlssonde9f1532010-04-17 20:21:41 +00001281 FieldOffset = 0;
Anders Carlsson4cf6f5f2010-04-16 15:57:11 +00001282 } else {
Anders Carlssonde9f1532010-04-17 20:21:41 +00001283 // The bitfield is allocated starting at the next offset aligned appropriately
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001284 // for T', with length n bits.
Anders Carlssonde9f1532010-04-17 20:21:41 +00001285 FieldOffset = llvm::RoundUpToAlignment(DataSize, TypeAlign);
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001286
Anders Carlsson4cf6f5f2010-04-16 15:57:11 +00001287 uint64_t NewSizeInBits = FieldOffset + FieldSize;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001288
Anders Carlsson4cf6f5f2010-04-16 15:57:11 +00001289 DataSize = llvm::RoundUpToAlignment(NewSizeInBits, 8);
1290 UnfilledBitsInLastByte = DataSize - NewSizeInBits;
1291 }
1292
1293 // Place this field at the current location.
1294 FieldOffsets.push_back(FieldOffset);
1295
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001296 CheckFieldPadding(FieldOffset, UnpaddedFieldOffset, FieldOffset,
1297 TypeAlign, FieldPacked, D);
1298
Anders Carlsson4cf6f5f2010-04-16 15:57:11 +00001299 // Update the size.
1300 Size = std::max(Size, DataSize);
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001301
Anders Carlsson4cf6f5f2010-04-16 15:57:11 +00001302 // Remember max struct/class alignment.
1303 UpdateAlignment(TypeAlign);
1304}
1305
Anders Carlsson7d0918a2010-05-26 05:58:59 +00001306void RecordLayoutBuilder::LayoutBitField(const FieldDecl *D) {
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001307 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001308 uint64_t UnpaddedFieldOffset = DataSize - UnfilledBitsInLastByte;
1309 uint64_t FieldOffset = IsUnion ? 0 : UnpaddedFieldOffset;
Anders Carlsson0f0e9b02010-04-16 15:07:51 +00001310 uint64_t FieldSize = D->getBitWidth()->EvaluateAsInt(Context).getZExtValue();
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001311
Anders Carlsson0f0e9b02010-04-16 15:07:51 +00001312 std::pair<uint64_t, unsigned> FieldInfo = Context.getTypeInfo(D->getType());
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001313 uint64_t TypeSize = FieldInfo.first;
1314 unsigned FieldAlign = FieldInfo.second;
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001315
Anders Carlsson4cf6f5f2010-04-16 15:57:11 +00001316 if (FieldSize > TypeSize) {
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001317 LayoutWideBitField(FieldSize, TypeSize, FieldPacked, D);
Anders Carlsson4cf6f5f2010-04-16 15:57:11 +00001318 return;
1319 }
1320
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001321 // The align if the field is not packed. This is to check if the attribute
1322 // was unnecessary (-Wpacked).
1323 unsigned UnpackedFieldAlign = FieldAlign;
1324 uint64_t UnpackedFieldOffset = FieldOffset;
1325 if (!Context.Target.useBitFieldTypeAlignment())
1326 UnpackedFieldAlign = 1;
1327
Anders Carlsson0f0e9b02010-04-16 15:07:51 +00001328 if (FieldPacked || !Context.Target.useBitFieldTypeAlignment())
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001329 FieldAlign = 1;
Sean Huntcf807c42010-08-18 23:23:40 +00001330 FieldAlign = std::max(FieldAlign, D->getMaxAlignment());
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001331 UnpackedFieldAlign = std::max(UnpackedFieldAlign, D->getMaxAlignment());
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001332
1333 // The maximum field alignment overrides the aligned attribute.
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001334 if (MaxFieldAlignment) {
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001335 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001336 UnpackedFieldAlign = std::min(UnpackedFieldAlign, MaxFieldAlignment);
1337 }
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001338
Daniel Dunbarb6a16932010-04-15 06:18:39 +00001339 // Check if we need to add padding to give the field the correct alignment.
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001340 if (FieldSize == 0 || (FieldOffset & (FieldAlign-1)) + FieldSize > TypeSize)
Daniel Dunbar84b03162010-06-29 18:34:35 +00001341 FieldOffset = llvm::RoundUpToAlignment(FieldOffset, FieldAlign);
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001342
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001343 if (FieldSize == 0 ||
1344 (UnpackedFieldOffset & (UnpackedFieldAlign-1)) + FieldSize > TypeSize)
1345 UnpackedFieldOffset = llvm::RoundUpToAlignment(UnpackedFieldOffset,
1346 UnpackedFieldAlign);
1347
Daniel Dunbarb6a16932010-04-15 06:18:39 +00001348 // Padding members don't affect overall alignment.
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001349 if (!D->getIdentifier())
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001350 FieldAlign = UnpackedFieldAlign = 1;
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001351
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001352 // Place this field at the current location.
1353 FieldOffsets.push_back(FieldOffset);
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001354
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001355 CheckFieldPadding(FieldOffset, UnpaddedFieldOffset, UnpackedFieldOffset,
1356 UnpackedFieldAlign, FieldPacked, D);
1357
Anders Carlssone4fc0d92009-11-22 19:13:51 +00001358 // Update DataSize to include the last byte containing (part of) the bitfield.
1359 if (IsUnion) {
1360 // FIXME: I think FieldSize should be TypeSize here.
1361 DataSize = std::max(DataSize, FieldSize);
1362 } else {
1363 uint64_t NewSizeInBits = FieldOffset + FieldSize;
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001364
Anders Carlssone4fc0d92009-11-22 19:13:51 +00001365 DataSize = llvm::RoundUpToAlignment(NewSizeInBits, 8);
1366 UnfilledBitsInLastByte = DataSize - NewSizeInBits;
1367 }
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001368
Anders Carlssone4fc0d92009-11-22 19:13:51 +00001369 // Update the size.
1370 Size = std::max(Size, DataSize);
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001371
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001372 // Remember max struct/class alignment.
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001373 UpdateAlignment(FieldAlign, UnpackedFieldAlign);
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001374}
1375
Anders Carlsson7d0918a2010-05-26 05:58:59 +00001376void RecordLayoutBuilder::LayoutField(const FieldDecl *D) {
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001377 if (D->isBitField()) {
1378 LayoutBitField(D);
1379 return;
1380 }
1381
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001382 uint64_t UnpaddedFieldOffset = DataSize - UnfilledBitsInLastByte;
1383
Anders Carlssone4fc0d92009-11-22 19:13:51 +00001384 // Reset the unfilled bits.
1385 UnfilledBitsInLastByte = 0;
1386
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001387 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Anders Carlssona2239352009-09-26 01:34:51 +00001388 uint64_t FieldOffset = IsUnion ? 0 : DataSize;
Anders Carlssonbda4c102009-07-18 20:20:21 +00001389 uint64_t FieldSize;
1390 unsigned FieldAlign;
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001391
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001392 if (D->getType()->isIncompleteArrayType()) {
1393 // This is a flexible array member; we can't directly
1394 // query getTypeInfo about these, so we figure it out here.
1395 // Flexible array members don't have any size, but they
1396 // have to be aligned appropriately for their element type.
1397 FieldSize = 0;
Anders Carlsson0f0e9b02010-04-16 15:07:51 +00001398 const ArrayType* ATy = Context.getAsArrayType(D->getType());
1399 FieldAlign = Context.getTypeAlign(ATy->getElementType());
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001400 } else if (const ReferenceType *RT = D->getType()->getAs<ReferenceType>()) {
1401 unsigned AS = RT->getPointeeType().getAddressSpace();
Anders Carlsson0f0e9b02010-04-16 15:07:51 +00001402 FieldSize = Context.Target.getPointerWidth(AS);
1403 FieldAlign = Context.Target.getPointerAlign(AS);
Anders Carlssonbda4c102009-07-18 20:20:21 +00001404 } else {
Anders Carlsson0f0e9b02010-04-16 15:07:51 +00001405 std::pair<uint64_t, unsigned> FieldInfo = Context.getTypeInfo(D->getType());
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001406 FieldSize = FieldInfo.first;
1407 FieldAlign = FieldInfo.second;
Douglas Gregor6f755502011-02-01 15:15:22 +00001408
1409 if (Context.getLangOptions().MSBitfields) {
1410 // If MS bitfield layout is required, figure out what type is being
1411 // laid out and align the field to the width of that type.
1412
1413 // Resolve all typedefs down to their base type and round up the field
1414 // alignment if necessary.
1415 QualType T = Context.getBaseElementType(D->getType());
1416 if (const BuiltinType *BTy = T->getAs<BuiltinType>()) {
1417 uint64_t TypeSize = Context.getTypeSize(BTy);
1418 if (TypeSize > FieldAlign)
1419 FieldAlign = TypeSize;
1420 }
1421 }
Anders Carlssonbda4c102009-07-18 20:20:21 +00001422 }
Mike Stump1eb44332009-09-09 15:08:12 +00001423
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001424 // The align if the field is not packed. This is to check if the attribute
1425 // was unnecessary (-Wpacked).
1426 unsigned UnpackedFieldAlign = FieldAlign;
1427 uint64_t UnpackedFieldOffset = FieldOffset;
1428
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001429 if (FieldPacked)
1430 FieldAlign = 8;
Sean Huntcf807c42010-08-18 23:23:40 +00001431 FieldAlign = std::max(FieldAlign, D->getMaxAlignment());
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001432 UnpackedFieldAlign = std::max(UnpackedFieldAlign, D->getMaxAlignment());
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001433
1434 // The maximum field alignment overrides the aligned attribute.
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001435 if (MaxFieldAlignment) {
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001436 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001437 UnpackedFieldAlign = std::min(UnpackedFieldAlign, MaxFieldAlignment);
1438 }
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001439
1440 // Round up the current record size to the field's alignment boundary.
1441 FieldOffset = llvm::RoundUpToAlignment(FieldOffset, FieldAlign);
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001442 UnpackedFieldOffset = llvm::RoundUpToAlignment(UnpackedFieldOffset,
1443 UnpackedFieldAlign);
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001444
Anders Carlsson83a45e72010-05-30 06:52:33 +00001445 if (!IsUnion && EmptySubobjects) {
1446 // Check if we can place the field at this offset.
Anders Carlssona3d43802010-10-31 22:13:23 +00001447 while (!EmptySubobjects->CanPlaceFieldAtOffset(D,
Ken Dyckff3a5172011-01-24 01:28:50 +00001448 Context.toCharUnitsFromBits(FieldOffset))) {
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001449 // We couldn't place the field at the offset. Try again at a new offset.
1450 FieldOffset += FieldAlign;
1451 }
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001452 }
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001453
Anders Carlssonbda4c102009-07-18 20:20:21 +00001454 // Place this field at the current location.
1455 FieldOffsets.push_back(FieldOffset);
Mike Stump1eb44332009-09-09 15:08:12 +00001456
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001457 CheckFieldPadding(FieldOffset, UnpaddedFieldOffset, UnpackedFieldOffset,
1458 UnpackedFieldAlign, FieldPacked, D);
1459
Anders Carlssonbda4c102009-07-18 20:20:21 +00001460 // Reserve space for this field.
1461 if (IsUnion)
1462 Size = std::max(Size, FieldSize);
1463 else
1464 Size = FieldOffset + FieldSize;
Mike Stump1eb44332009-09-09 15:08:12 +00001465
Anders Carlssona2239352009-09-26 01:34:51 +00001466 // Update the data size.
1467 DataSize = Size;
Mike Stump1eb44332009-09-09 15:08:12 +00001468
Anders Carlssonbda4c102009-07-18 20:20:21 +00001469 // Remember max struct/class alignment.
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001470 UpdateAlignment(FieldAlign, UnpackedFieldAlign);
Anders Carlssonbda4c102009-07-18 20:20:21 +00001471}
1472
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001473void RecordLayoutBuilder::FinishLayout(const NamedDecl *D) {
Anders Carlssonbda4c102009-07-18 20:20:21 +00001474 // In C++, records cannot be of size 0.
Fariborz Jahanianadf082e2011-02-02 19:36:18 +00001475 if (Context.getLangOptions().CPlusPlus && Size == 0) {
1476 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
1477 // Compatibility with gcc requires a class (pod or non-pod)
1478 // which is not empty but of size 0; such as having fields of
1479 // array of zero-length, remains of Size 0
1480 if (RD->isEmpty())
1481 Size = 8;
1482 }
1483 else
1484 Size = 8;
1485 }
Anders Carlssonbda4c102009-07-18 20:20:21 +00001486 // Finally, round the size of the record up to the alignment of the
1487 // record itself.
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001488 uint64_t UnpaddedSize = Size - UnfilledBitsInLastByte;
1489 uint64_t UnpackedSize = llvm::RoundUpToAlignment(Size, UnpackedAlignment);
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001490 Size = llvm::RoundUpToAlignment(Size, Alignment);
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001491
1492 unsigned CharBitNum = Context.Target.getCharWidth();
1493 if (const RecordDecl *RD = dyn_cast<RecordDecl>(D)) {
1494 // Warn if padding was introduced to the struct/class/union.
1495 if (Size > UnpaddedSize) {
1496 unsigned PadSize = Size - UnpaddedSize;
1497 bool InBits = true;
1498 if (PadSize % CharBitNum == 0) {
1499 PadSize = PadSize / CharBitNum;
1500 InBits = false;
1501 }
1502 Diag(RD->getLocation(), diag::warn_padded_struct_size)
1503 << Context.getTypeDeclType(RD)
1504 << PadSize
1505 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1); // plural or not
1506 }
1507
1508 // Warn if we packed it unnecessarily. If the alignment is 1 byte don't
1509 // bother since there won't be alignment issues.
1510 if (Packed && UnpackedAlignment > CharBitNum && Size == UnpackedSize)
1511 Diag(D->getLocation(), diag::warn_unnecessary_packed)
1512 << Context.getTypeDeclType(RD);
1513 }
Anders Carlssonbda4c102009-07-18 20:20:21 +00001514}
1515
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001516void RecordLayoutBuilder::UpdateAlignment(unsigned NewAlignment,
1517 unsigned UnpackedNewAlignment) {
Daniel Dunbarc6082fe2010-05-27 05:45:51 +00001518 // The alignment is not modified when using 'mac68k' alignment.
1519 if (IsMac68kAlign)
1520 return;
1521
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001522 if (NewAlignment > Alignment) {
1523 assert(llvm::isPowerOf2_32(NewAlignment && "Alignment not a power of 2"));
1524 Alignment = NewAlignment;
1525 }
1526
1527 if (UnpackedNewAlignment > UnpackedAlignment) {
1528 assert(llvm::isPowerOf2_32(UnpackedNewAlignment &&
1529 "Alignment not a power of 2"));
1530 UnpackedAlignment = UnpackedNewAlignment;
1531 }
1532}
1533
1534void RecordLayoutBuilder::CheckFieldPadding(uint64_t Offset,
1535 uint64_t UnpaddedOffset,
1536 uint64_t UnpackedOffset,
1537 unsigned UnpackedAlign,
1538 bool isPacked,
1539 const FieldDecl *D) {
1540 // We let objc ivars without warning, objc interfaces generally are not used
1541 // for padding tricks.
1542 if (isa<ObjCIvarDecl>(D))
Anders Carlssonbda4c102009-07-18 20:20:21 +00001543 return;
Mike Stump1eb44332009-09-09 15:08:12 +00001544
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001545 unsigned CharBitNum = Context.Target.getCharWidth();
Mike Stump1eb44332009-09-09 15:08:12 +00001546
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001547 // Warn if padding was introduced to the struct/class.
1548 if (!IsUnion && Offset > UnpaddedOffset) {
1549 unsigned PadSize = Offset - UnpaddedOffset;
1550 bool InBits = true;
1551 if (PadSize % CharBitNum == 0) {
1552 PadSize = PadSize / CharBitNum;
1553 InBits = false;
1554 }
1555 if (D->getIdentifier())
1556 Diag(D->getLocation(), diag::warn_padded_struct_field)
1557 << (D->getParent()->isStruct() ? 0 : 1) // struct|class
1558 << Context.getTypeDeclType(D->getParent())
1559 << PadSize
1560 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1) // plural or not
1561 << D->getIdentifier();
1562 else
1563 Diag(D->getLocation(), diag::warn_padded_struct_anon_field)
1564 << (D->getParent()->isStruct() ? 0 : 1) // struct|class
1565 << Context.getTypeDeclType(D->getParent())
1566 << PadSize
1567 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1); // plural or not
1568 }
1569
1570 // Warn if we packed it unnecessarily. If the alignment is 1 byte don't
1571 // bother since there won't be alignment issues.
1572 if (isPacked && UnpackedAlign > CharBitNum && Offset == UnpackedOffset)
1573 Diag(D->getLocation(), diag::warn_unnecessary_packed)
1574 << D->getIdentifier();
Anders Carlssonbda4c102009-07-18 20:20:21 +00001575}
Mike Stump1eb44332009-09-09 15:08:12 +00001576
Anders Carlssonf53df232009-12-07 04:35:11 +00001577const CXXMethodDecl *
Anders Carlsson7d0918a2010-05-26 05:58:59 +00001578RecordLayoutBuilder::ComputeKeyFunction(const CXXRecordDecl *RD) {
Daniel Dunbar8d8ab742010-04-19 20:44:53 +00001579 // If a class isn't polymorphic it doesn't have a key function.
Anders Carlssonf53df232009-12-07 04:35:11 +00001580 if (!RD->isPolymorphic())
Anders Carlsson1a5e0d72009-11-30 23:41:22 +00001581 return 0;
Eli Friedman61eab882009-12-08 03:56:49 +00001582
1583 // A class inside an anonymous namespace doesn't have a key function. (Or
1584 // at least, there's no point to assigning a key function to such a class;
1585 // this doesn't affect the ABI.)
1586 if (RD->isInAnonymousNamespace())
1587 return 0;
1588
Argyrios Kyrtzidis3bd5b6c2010-10-13 02:39:41 +00001589 // Template instantiations don't have key functions,see Itanium C++ ABI 5.2.6.
1590 // Same behavior as GCC.
1591 TemplateSpecializationKind TSK = RD->getTemplateSpecializationKind();
1592 if (TSK == TSK_ImplicitInstantiation ||
1593 TSK == TSK_ExplicitInstantiationDefinition)
1594 return 0;
1595
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001596 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
1597 E = RD->method_end(); I != E; ++I) {
Anders Carlsson1a5e0d72009-11-30 23:41:22 +00001598 const CXXMethodDecl *MD = *I;
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001599
Anders Carlsson1a5e0d72009-11-30 23:41:22 +00001600 if (!MD->isVirtual())
1601 continue;
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001602
Anders Carlsson1a5e0d72009-11-30 23:41:22 +00001603 if (MD->isPure())
1604 continue;
Eli Friedman61eab882009-12-08 03:56:49 +00001605
Anders Carlsson5ec02ae2009-12-02 17:15:43 +00001606 // Ignore implicit member functions, they are always marked as inline, but
1607 // they don't have a body until they're defined.
1608 if (MD->isImplicit())
1609 continue;
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001610
Douglas Gregorbd6d6192010-01-05 19:06:31 +00001611 if (MD->isInlineSpecified())
1612 continue;
Eli Friedmand7d7f672009-12-06 20:50:05 +00001613
1614 if (MD->hasInlineBody())
Anders Carlsson1a5e0d72009-11-30 23:41:22 +00001615 continue;
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001616
Anders Carlsson1a5e0d72009-11-30 23:41:22 +00001617 // We found it.
1618 return MD;
1619 }
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001620
Anders Carlsson1a5e0d72009-11-30 23:41:22 +00001621 return 0;
1622}
1623
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001624DiagnosticBuilder
1625RecordLayoutBuilder::Diag(SourceLocation Loc, unsigned DiagID) {
Argyrios Kyrtzidis33e4e702010-11-18 20:06:41 +00001626 return Context.getDiagnostics().Report(Loc, DiagID);
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001627}
1628
Benjamin Kramercb9c0742010-10-22 16:33:16 +00001629namespace {
1630 // This class implements layout specific to the Microsoft ABI.
1631 class MSRecordLayoutBuilder : public RecordLayoutBuilder {
1632 public:
Jay Foad4ba2a172011-01-12 09:06:06 +00001633 MSRecordLayoutBuilder(const ASTContext& Ctx,
1634 EmptySubobjectMap *EmptySubobjects) :
Benjamin Kramercb9c0742010-10-22 16:33:16 +00001635 RecordLayoutBuilder(Ctx, EmptySubobjects) {}
Charles Davisc9f8aec2010-08-19 00:55:19 +00001636
Benjamin Kramercb9c0742010-10-22 16:33:16 +00001637 virtual uint64_t GetVirtualPointersSize(const CXXRecordDecl *RD) const;
1638 };
1639}
Charles Davisc9f8aec2010-08-19 00:55:19 +00001640
Charles Davisc9f8aec2010-08-19 00:55:19 +00001641uint64_t
1642MSRecordLayoutBuilder::GetVirtualPointersSize(const CXXRecordDecl *RD) const {
1643 // We should reserve space for two pointers if the class has both
1644 // virtual functions and virtual bases.
1645 if (RD->isPolymorphic() && RD->getNumVBases() > 0)
1646 return 2 * Context.Target.getPointerWidth(0);
1647 return Context.Target.getPointerWidth(0);
1648}
1649
Anders Carlsson1e641ce2010-05-26 04:56:53 +00001650/// getASTRecordLayout - Get or compute information about the layout of the
1651/// specified record (struct/union/class), which indicates its size and field
1652/// position information.
Jay Foad4ba2a172011-01-12 09:06:06 +00001653const ASTRecordLayout &
1654ASTContext::getASTRecordLayout(const RecordDecl *D) const {
Anders Carlsson1e641ce2010-05-26 04:56:53 +00001655 D = D->getDefinition();
1656 assert(D && "Cannot get layout of forward declarations!");
1657
1658 // Look up this layout, if already laid out, return what we have.
1659 // Note that we can't save a reference to the entry because this function
1660 // is recursive.
1661 const ASTRecordLayout *Entry = ASTRecordLayouts[D];
1662 if (Entry) return *Entry;
1663
Anders Carlsson2f64e372010-05-26 05:10:47 +00001664 const ASTRecordLayout *NewEntry;
1665
1666 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
Anders Carlsson261febd2010-05-27 00:07:01 +00001667 EmptySubobjectMap EmptySubobjects(*this, RD);
Anders Carlsson58b16b62010-05-27 05:41:06 +00001668
Charles Davisc9f8aec2010-08-19 00:55:19 +00001669 // When compiling for Microsoft, use the special MS builder.
Argyrios Kyrtzidiscfe17e52010-08-25 00:32:14 +00001670 llvm::OwningPtr<RecordLayoutBuilder> Builder;
Charles Davis20cf7172010-08-19 02:18:14 +00001671 switch (Target.getCXXABI()) {
1672 default:
Argyrios Kyrtzidiscfe17e52010-08-25 00:32:14 +00001673 Builder.reset(new RecordLayoutBuilder(*this, &EmptySubobjects));
Charles Davis20cf7172010-08-19 02:18:14 +00001674 break;
1675 case CXXABI_Microsoft:
Argyrios Kyrtzidiscfe17e52010-08-25 00:32:14 +00001676 Builder.reset(new MSRecordLayoutBuilder(*this, &EmptySubobjects));
Charles Davis20cf7172010-08-19 02:18:14 +00001677 }
Charles Davisc9f8aec2010-08-19 00:55:19 +00001678 Builder->Layout(RD);
Anders Carlsson2f64e372010-05-26 05:10:47 +00001679
1680 // FIXME: This is not always correct. See the part about bitfields at
1681 // http://www.codesourcery.com/public/cxx-abi/abi.html#POD for more info.
1682 // FIXME: IsPODForThePurposeOfLayout should be stored in the record layout.
1683 bool IsPODForThePurposeOfLayout = cast<CXXRecordDecl>(D)->isPOD();
1684
1685 // FIXME: This should be done in FinalizeLayout.
1686 uint64_t DataSize =
Charles Davisc9f8aec2010-08-19 00:55:19 +00001687 IsPODForThePurposeOfLayout ? Builder->Size : Builder->DataSize;
Anders Carlsson2f64e372010-05-26 05:10:47 +00001688 uint64_t NonVirtualSize =
Charles Davisc9f8aec2010-08-19 00:55:19 +00001689 IsPODForThePurposeOfLayout ? DataSize : Builder->NonVirtualSize;
Ken Dyck68cf1a52011-02-08 02:02:47 +00001690 uint64_t NonVirtualAlign = Builder->NonVirtualAlignment;
Anders Carlsson2f64e372010-05-26 05:10:47 +00001691
Ken Dyck5f022d82011-02-09 01:59:34 +00001692 CharUnits RecordSize = toCharUnitsFromBits(Builder->Size);
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001693 NewEntry =
Ken Dyck5f022d82011-02-09 01:59:34 +00001694 new (*this) ASTRecordLayout(*this, RecordSize, Builder->Alignment,
Charles Davisc9f8aec2010-08-19 00:55:19 +00001695 DataSize, Builder->FieldOffsets.data(),
1696 Builder->FieldOffsets.size(),
Ken Dyck5c3633f2011-02-01 01:52:10 +00001697 toCharUnitsFromBits(NonVirtualSize),
Ken Dyck68cf1a52011-02-08 02:02:47 +00001698 toCharUnitsFromBits(NonVirtualAlign),
Anders Carlsson261febd2010-05-27 00:07:01 +00001699 EmptySubobjects.SizeOfLargestEmptySubobject,
Charles Davisc9f8aec2010-08-19 00:55:19 +00001700 Builder->PrimaryBase,
1701 Builder->PrimaryBaseIsVirtual,
1702 Builder->Bases, Builder->VBases);
Anders Carlsson2f64e372010-05-26 05:10:47 +00001703 } else {
Anders Carlsson261febd2010-05-27 00:07:01 +00001704 RecordLayoutBuilder Builder(*this, /*EmptySubobjects=*/0);
Anders Carlsson2f64e372010-05-26 05:10:47 +00001705 Builder.Layout(D);
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001706
Ken Dyck5f022d82011-02-09 01:59:34 +00001707 CharUnits RecordSize = toCharUnitsFromBits(Builder.Size);
1708
Anders Carlsson2f64e372010-05-26 05:10:47 +00001709 NewEntry =
Ken Dyck5f022d82011-02-09 01:59:34 +00001710 new (*this) ASTRecordLayout(*this, RecordSize, Builder.Alignment,
Anders Carlsson2f64e372010-05-26 05:10:47 +00001711 Builder.Size,
1712 Builder.FieldOffsets.data(),
1713 Builder.FieldOffsets.size());
1714 }
1715
Anders Carlsson1e641ce2010-05-26 04:56:53 +00001716 ASTRecordLayouts[D] = NewEntry;
1717
1718 if (getLangOptions().DumpRecordLayouts) {
1719 llvm::errs() << "\n*** Dumping AST Record Layout\n";
1720 DumpRecordLayout(D, llvm::errs());
1721 }
1722
1723 return *NewEntry;
1724}
1725
1726const CXXMethodDecl *ASTContext::getKeyFunction(const CXXRecordDecl *RD) {
1727 RD = cast<CXXRecordDecl>(RD->getDefinition());
1728 assert(RD && "Cannot get key function for forward declarations!");
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001729
Anders Carlsson1e641ce2010-05-26 04:56:53 +00001730 const CXXMethodDecl *&Entry = KeyFunctions[RD];
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001731 if (!Entry)
Anders Carlsson7d0918a2010-05-26 05:58:59 +00001732 Entry = RecordLayoutBuilder::ComputeKeyFunction(RD);
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001733
Anders Carlsson1e641ce2010-05-26 04:56:53 +00001734 return Entry;
1735}
1736
1737/// getInterfaceLayoutImpl - Get or compute information about the
1738/// layout of the given interface.
1739///
1740/// \param Impl - If given, also include the layout of the interface's
1741/// implementation. This may differ by including synthesized ivars.
1742const ASTRecordLayout &
1743ASTContext::getObjCLayout(const ObjCInterfaceDecl *D,
Jay Foad4ba2a172011-01-12 09:06:06 +00001744 const ObjCImplementationDecl *Impl) const {
Anders Carlsson1e641ce2010-05-26 04:56:53 +00001745 assert(!D->isForwardDecl() && "Invalid interface decl!");
1746
1747 // Look up this layout, if already laid out, return what we have.
1748 ObjCContainerDecl *Key =
1749 Impl ? (ObjCContainerDecl*) Impl : (ObjCContainerDecl*) D;
1750 if (const ASTRecordLayout *Entry = ObjCLayouts[Key])
1751 return *Entry;
1752
1753 // Add in synthesized ivar count if laying out an implementation.
1754 if (Impl) {
1755 unsigned SynthCount = CountNonClassIvars(D);
1756 // If there aren't any sythesized ivars then reuse the interface
1757 // entry. Note we can't cache this because we simply free all
1758 // entries later; however we shouldn't look up implementations
1759 // frequently.
1760 if (SynthCount == 0)
1761 return getObjCLayout(D, 0);
1762 }
1763
Anders Carlsson261febd2010-05-27 00:07:01 +00001764 RecordLayoutBuilder Builder(*this, /*EmptySubobjects=*/0);
Anders Carlsson36cdc612010-05-26 05:04:25 +00001765 Builder.Layout(D);
1766
Ken Dyck5f022d82011-02-09 01:59:34 +00001767 CharUnits RecordSize = toCharUnitsFromBits(Builder.Size);
1768
Anders Carlsson1e641ce2010-05-26 04:56:53 +00001769 const ASTRecordLayout *NewEntry =
Ken Dyck5f022d82011-02-09 01:59:34 +00001770 new (*this) ASTRecordLayout(*this, RecordSize, Builder.Alignment,
Anders Carlsson36cdc612010-05-26 05:04:25 +00001771 Builder.DataSize,
1772 Builder.FieldOffsets.data(),
1773 Builder.FieldOffsets.size());
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001774
Anders Carlsson1e641ce2010-05-26 04:56:53 +00001775 ObjCLayouts[Key] = NewEntry;
1776
1777 return *NewEntry;
1778}
1779
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001780static void PrintOffset(llvm::raw_ostream &OS,
Anders Carlsson3069a0d2010-10-31 23:45:59 +00001781 CharUnits Offset, unsigned IndentLevel) {
1782 OS << llvm::format("%4d | ", Offset.getQuantity());
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001783 OS.indent(IndentLevel * 2);
1784}
1785
1786static void DumpCXXRecordLayout(llvm::raw_ostream &OS,
Jay Foad4ba2a172011-01-12 09:06:06 +00001787 const CXXRecordDecl *RD, const ASTContext &C,
Anders Carlsson3069a0d2010-10-31 23:45:59 +00001788 CharUnits Offset,
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001789 unsigned IndentLevel,
1790 const char* Description,
1791 bool IncludeVirtualBases) {
Anders Carlsson3069a0d2010-10-31 23:45:59 +00001792 const ASTRecordLayout &Layout = C.getASTRecordLayout(RD);
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001793
1794 PrintOffset(OS, Offset, IndentLevel);
Dan Gohmancb421fa2010-04-19 16:39:44 +00001795 OS << C.getTypeDeclType(const_cast<CXXRecordDecl *>(RD)).getAsString();
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001796 if (Description)
1797 OS << ' ' << Description;
1798 if (RD->isEmpty())
1799 OS << " (empty)";
1800 OS << '\n';
1801
1802 IndentLevel++;
1803
Anders Carlsson3069a0d2010-10-31 23:45:59 +00001804 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001805
1806 // Vtable pointer.
1807 if (RD->isDynamicClass() && !PrimaryBase) {
1808 PrintOffset(OS, Offset, IndentLevel);
Benjamin Kramer900fc632010-04-17 09:33:03 +00001809 OS << '(' << RD << " vtable pointer)\n";
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001810 }
1811 // Dump (non-virtual) bases
1812 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1813 E = RD->bases_end(); I != E; ++I) {
1814 assert(!I->getType()->isDependentType() &&
1815 "Cannot layout class with dependent bases.");
1816 if (I->isVirtual())
1817 continue;
1818
1819 const CXXRecordDecl *Base =
1820 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1821
Anders Carlsson3069a0d2010-10-31 23:45:59 +00001822 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base);
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001823
1824 DumpCXXRecordLayout(OS, Base, C, BaseOffset, IndentLevel,
1825 Base == PrimaryBase ? "(primary base)" : "(base)",
1826 /*IncludeVirtualBases=*/false);
1827 }
1828
1829 // Dump fields.
1830 uint64_t FieldNo = 0;
1831 for (CXXRecordDecl::field_iterator I = RD->field_begin(),
1832 E = RD->field_end(); I != E; ++I, ++FieldNo) {
1833 const FieldDecl *Field = *I;
Anders Carlsson3069a0d2010-10-31 23:45:59 +00001834 CharUnits FieldOffset = Offset +
Ken Dyckfb1e3bc2011-01-18 01:56:16 +00001835 C.toCharUnitsFromBits(Layout.getFieldOffset(FieldNo));
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001836
1837 if (const RecordType *RT = Field->getType()->getAs<RecordType>()) {
1838 if (const CXXRecordDecl *D = dyn_cast<CXXRecordDecl>(RT->getDecl())) {
1839 DumpCXXRecordLayout(OS, D, C, FieldOffset, IndentLevel,
Daniel Dunbar4087f272010-08-17 22:39:59 +00001840 Field->getName().data(),
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001841 /*IncludeVirtualBases=*/true);
1842 continue;
1843 }
1844 }
1845
1846 PrintOffset(OS, FieldOffset, IndentLevel);
Benjamin Kramer900fc632010-04-17 09:33:03 +00001847 OS << Field->getType().getAsString() << ' ' << Field << '\n';
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001848 }
1849
1850 if (!IncludeVirtualBases)
1851 return;
1852
1853 // Dump virtual bases.
1854 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
1855 E = RD->vbases_end(); I != E; ++I) {
1856 assert(I->isVirtual() && "Found non-virtual class!");
1857 const CXXRecordDecl *VBase =
1858 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1859
Anders Carlsson3069a0d2010-10-31 23:45:59 +00001860 CharUnits VBaseOffset = Offset + Layout.getVBaseClassOffset(VBase);
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001861 DumpCXXRecordLayout(OS, VBase, C, VBaseOffset, IndentLevel,
1862 VBase == PrimaryBase ?
1863 "(primary virtual base)" : "(virtual base)",
1864 /*IncludeVirtualBases=*/false);
1865 }
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001866
Ken Dyck5f022d82011-02-09 01:59:34 +00001867 OS << " sizeof=" << Layout.getSize().getQuantity();
Anders Carlsson3069a0d2010-10-31 23:45:59 +00001868 OS << ", dsize=" << Layout.getDataSize() / 8;
1869 OS << ", align=" << Layout.getAlignment() / 8 << '\n';
Ken Dyck5c3633f2011-02-01 01:52:10 +00001870 OS << " nvsize=" << Layout.getNonVirtualSize().getQuantity();
Ken Dyck68cf1a52011-02-08 02:02:47 +00001871 OS << ", nvalign=" << Layout.getNonVirtualAlign().getQuantity() << '\n';
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001872 OS << '\n';
1873}
Daniel Dunbar8d8ab742010-04-19 20:44:53 +00001874
1875void ASTContext::DumpRecordLayout(const RecordDecl *RD,
Jay Foad4ba2a172011-01-12 09:06:06 +00001876 llvm::raw_ostream &OS) const {
Daniel Dunbar8d8ab742010-04-19 20:44:53 +00001877 const ASTRecordLayout &Info = getASTRecordLayout(RD);
1878
1879 if (const CXXRecordDecl *CXXRD = dyn_cast<CXXRecordDecl>(RD))
Anders Carlsson3069a0d2010-10-31 23:45:59 +00001880 return DumpCXXRecordLayout(OS, CXXRD, *this, CharUnits(), 0, 0,
Daniel Dunbar8d8ab742010-04-19 20:44:53 +00001881 /*IncludeVirtualBases=*/true);
1882
1883 OS << "Type: " << getTypeDeclType(RD).getAsString() << "\n";
1884 OS << "Record: ";
1885 RD->dump();
1886 OS << "\nLayout: ";
1887 OS << "<ASTRecordLayout\n";
Ken Dyck5f022d82011-02-09 01:59:34 +00001888 OS << " Size:" << Info.getSize().getQuantity() * getCharWidth() << "\n";
Daniel Dunbar8d8ab742010-04-19 20:44:53 +00001889 OS << " DataSize:" << Info.getDataSize() << "\n";
1890 OS << " Alignment:" << Info.getAlignment() << "\n";
1891 OS << " FieldOffsets: [";
1892 for (unsigned i = 0, e = Info.getFieldCount(); i != e; ++i) {
1893 if (i) OS << ", ";
1894 OS << Info.getFieldOffset(i);
1895 }
1896 OS << "]>\n";
1897}