blob: 1fb0775dd4ccbc949d2170d79c41a0ed61f7d951 [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"
11#include "clang/AST/Decl.h"
Anders Carlsson74cbe222009-07-19 00:18:47 +000012#include "clang/AST/DeclCXX.h"
Anders Carlsson93fab9d2009-07-18 20:50:59 +000013#include "clang/AST/DeclObjC.h"
Anders Carlssonbda4c102009-07-18 20:20:21 +000014#include "clang/AST/Expr.h"
Anders Carlsson9392fa62010-05-26 05:41:04 +000015#include "clang/AST/RecordLayout.h"
Anders Carlssonbda4c102009-07-18 20:20:21 +000016#include "clang/Basic/TargetInfo.h"
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +000017#include "clang/Sema/SemaDiagnostic.h"
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +000018#include "llvm/Support/Format.h"
19#include "llvm/ADT/SmallSet.h"
20#include "llvm/Support/MathExtras.h"
Anders Carlsson9392fa62010-05-26 05:41:04 +000021#include <map>
Anders Carlssonbda4c102009-07-18 20:20:21 +000022
23using namespace clang;
24
Benjamin Kramer7e220282010-05-26 09:58:31 +000025namespace {
Anders Carlsson6a91c032010-05-26 15:32:58 +000026
Anders Carlssonea2f41c2010-05-28 21:24:37 +000027/// BaseSubobjectInfo - Represents a single base subobject in a complete class.
28/// For a class hierarchy like
29///
30/// class A { };
31/// class B : A { };
32/// class C : A, B { };
33///
34/// The BaseSubobjectInfo graph for C will have three BaseSubobjectInfo
35/// instances, one for B and two for A.
36///
37/// If a base is virtual, it will only have one BaseSubobjectInfo allocated.
38struct BaseSubobjectInfo {
39 /// Class - The class for this base info.
Anders Carlsson4a257992010-05-28 21:13:31 +000040 const CXXRecordDecl *Class;
Anders Carlssonea2f41c2010-05-28 21:24:37 +000041
42 /// IsVirtual - Whether the BaseInfo represents a virtual base or not.
Anders Carlsson4a257992010-05-28 21:13:31 +000043 bool IsVirtual;
44
Anders Carlssonea2f41c2010-05-28 21:24:37 +000045 /// Bases - Information about the base subobjects.
46 llvm::SmallVector<BaseSubobjectInfo*, 4> Bases;
47
Anders Carlsson6e264542010-05-29 17:35:14 +000048 /// PrimaryVirtualBaseInfo - Holds the base info for the primary virtual base
49 /// of this base info (if one exists).
50 BaseSubobjectInfo *PrimaryVirtualBaseInfo;
Anders Carlssonea2f41c2010-05-28 21:24:37 +000051
52 // FIXME: Document.
53 const BaseSubobjectInfo *Derived;
Anders Carlsson4a257992010-05-28 21:13:31 +000054};
55
Anders Carlsson6a91c032010-05-26 15:32:58 +000056/// EmptySubobjectMap - Keeps track of which empty subobjects exist at different
57/// offsets while laying out a C++ class.
58class EmptySubobjectMap {
59 ASTContext &Context;
Anders Carlsson8c6acc62010-10-31 21:54:55 +000060 uint64_t CharWidth;
61
Anders Carlsson6a91c032010-05-26 15:32:58 +000062 /// Class - The class whose empty entries we're keeping track of.
63 const CXXRecordDecl *Class;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +000064
Anders Carlsson58b16b62010-05-27 05:41:06 +000065 /// EmptyClassOffsets - A map from offsets to empty record decls.
66 typedef llvm::SmallVector<const CXXRecordDecl *, 1> ClassVectorTy;
Anders Carlssond8da7632010-10-31 21:22:43 +000067 typedef llvm::DenseMap<CharUnits, ClassVectorTy> EmptyClassOffsetsMapTy;
Anders Carlsson58b16b62010-05-27 05:41:06 +000068 EmptyClassOffsetsMapTy EmptyClassOffsets;
69
Anders Carlssonc8cb4622010-06-08 15:56:03 +000070 /// MaxEmptyClassOffset - The highest offset known to contain an empty
71 /// base subobject.
Anders Carlssonfe5ef732010-10-31 21:39:24 +000072 CharUnits MaxEmptyClassOffset;
Anders Carlssonc8cb4622010-06-08 15:56:03 +000073
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +000074 /// ComputeEmptySubobjectSizes - Compute the size of the largest base or
Anders Carlsson0c54fc92010-05-26 15:54:25 +000075 /// member subobject that is empty.
76 void ComputeEmptySubobjectSizes();
Anders Carlsson58b16b62010-05-27 05:41:06 +000077
Anders Carlssonfe5ef732010-10-31 21:39:24 +000078 void AddSubobjectAtOffset(const CXXRecordDecl *RD, CharUnits Offset);
Anders Carlsson812a3452010-05-27 18:20:57 +000079
Anders Carlssonea2f41c2010-05-28 21:24:37 +000080 void UpdateEmptyBaseSubobjects(const BaseSubobjectInfo *Info,
Anders Carlssona3d43802010-10-31 22:13:23 +000081 CharUnits Offset, bool PlacingEmptyBase);
Anders Carlsson58b16b62010-05-27 05:41:06 +000082
Anders Carlsson812a3452010-05-27 18:20:57 +000083 void UpdateEmptyFieldSubobjects(const CXXRecordDecl *RD,
84 const CXXRecordDecl *Class,
Anders Carlssona3d43802010-10-31 22:13:23 +000085 CharUnits Offset);
86 void UpdateEmptyFieldSubobjects(const FieldDecl *FD, CharUnits Offset);
Anders Carlsson812a3452010-05-27 18:20:57 +000087
Anders Carlssonc8cb4622010-06-08 15:56:03 +000088 /// AnyEmptySubobjectsBeyondOffset - Returns whether there are any empty
89 /// subobjects beyond the given offset.
Anders Carlssonfe5ef732010-10-31 21:39:24 +000090 bool AnyEmptySubobjectsBeyondOffset(CharUnits Offset) const {
Anders Carlssonc8cb4622010-06-08 15:56:03 +000091 return Offset <= MaxEmptyClassOffset;
92 }
93
Anders Carlsson8c6acc62010-10-31 21:54:55 +000094 CharUnits
95 getFieldOffset(const ASTRecordLayout &Layout, unsigned FieldNo) const {
96 uint64_t FieldOffset = Layout.getFieldOffset(FieldNo);
97 assert(FieldOffset % CharWidth == 0 &&
98 "Field offset not at char boundary!");
99
100 return CharUnits::fromQuantity(FieldOffset / CharWidth);
101 }
102
Anders Carlssona3d43802010-10-31 22:13:23 +0000103 // FIXME: Remove this.
Anders Carlssond8da7632010-10-31 21:22:43 +0000104 CharUnits toCharUnits(uint64_t Offset) const {
Anders Carlsson8c6acc62010-10-31 21:54:55 +0000105 return CharUnits::fromQuantity(Offset / CharWidth);
Anders Carlssond8da7632010-10-31 21:22:43 +0000106 }
Anders Carlssond8da7632010-10-31 21:22:43 +0000107
Charles Davisc9f8aec2010-08-19 00:55:19 +0000108protected:
Anders Carlssonfe5ef732010-10-31 21:39:24 +0000109 bool CanPlaceSubobjectAtOffset(const CXXRecordDecl *RD,
110 CharUnits Offset) const;
Charles Davisc9f8aec2010-08-19 00:55:19 +0000111
112 bool CanPlaceBaseSubobjectAtOffset(const BaseSubobjectInfo *Info,
Anders Carlssona3d43802010-10-31 22:13:23 +0000113 CharUnits Offset);
Charles Davisc9f8aec2010-08-19 00:55:19 +0000114
115 bool CanPlaceFieldSubobjectAtOffset(const CXXRecordDecl *RD,
116 const CXXRecordDecl *Class,
Anders Carlssona3d43802010-10-31 22:13:23 +0000117 CharUnits Offset) const;
Charles Davisc9f8aec2010-08-19 00:55:19 +0000118 bool CanPlaceFieldSubobjectAtOffset(const FieldDecl *FD,
Anders Carlsson8c6acc62010-10-31 21:54:55 +0000119 CharUnits Offset) const;
Charles Davisc9f8aec2010-08-19 00:55:19 +0000120
Anders Carlsson6a91c032010-05-26 15:32:58 +0000121public:
Anders Carlsson0c54fc92010-05-26 15:54:25 +0000122 /// This holds the size of the largest empty subobject (either a base
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000123 /// or a member). Will be zero if the record being built doesn't contain
Anders Carlsson0c54fc92010-05-26 15:54:25 +0000124 /// any empty classes.
Anders Carlssona3d43802010-10-31 22:13:23 +0000125 CharUnits SizeOfLargestEmptySubobject;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000126
Anders Carlsson6a91c032010-05-26 15:32:58 +0000127 EmptySubobjectMap(ASTContext &Context, const CXXRecordDecl *Class)
Anders Carlssona3d43802010-10-31 22:13:23 +0000128 : Context(Context), CharWidth(Context.getCharWidth()), Class(Class) {
Anders Carlsson261febd2010-05-27 00:07:01 +0000129 ComputeEmptySubobjectSizes();
130 }
131
132 /// CanPlaceBaseAtOffset - Return whether the given base class can be placed
133 /// at the given offset.
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000134 /// Returns false if placing the record will result in two components
Anders Carlsson261febd2010-05-27 00:07:01 +0000135 /// (direct or indirect) of the same type having the same offset.
Anders Carlssonc8cb4622010-06-08 15:56:03 +0000136 bool CanPlaceBaseAtOffset(const BaseSubobjectInfo *Info,
Anders Carlssona3d43802010-10-31 22:13:23 +0000137 CharUnits Offset);
Anders Carlsson812a3452010-05-27 18:20:57 +0000138
139 /// CanPlaceFieldAtOffset - Return whether a field can be placed at the given
140 /// offset.
Anders Carlssona3d43802010-10-31 22:13:23 +0000141 bool CanPlaceFieldAtOffset(const FieldDecl *FD, CharUnits Offset);
Anders Carlsson6a91c032010-05-26 15:32:58 +0000142};
Anders Carlsson0c54fc92010-05-26 15:54:25 +0000143
144void EmptySubobjectMap::ComputeEmptySubobjectSizes() {
145 // Check the bases.
146 for (CXXRecordDecl::base_class_const_iterator I = Class->bases_begin(),
147 E = Class->bases_end(); I != E; ++I) {
148 const CXXRecordDecl *BaseDecl =
149 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
150
Anders Carlssona3d43802010-10-31 22:13:23 +0000151 CharUnits EmptySize;
Anders Carlsson0c54fc92010-05-26 15:54:25 +0000152 const ASTRecordLayout &Layout = Context.getASTRecordLayout(BaseDecl);
153 if (BaseDecl->isEmpty()) {
154 // If the class decl is empty, get its size.
Anders Carlssona3d43802010-10-31 22:13:23 +0000155 EmptySize = toCharUnits(Layout.getSize());
Anders Carlsson0c54fc92010-05-26 15:54:25 +0000156 } else {
157 // Otherwise, we get the largest empty subobject for the decl.
158 EmptySize = Layout.getSizeOfLargestEmptySubobject();
159 }
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000160
Anders Carlssona3d43802010-10-31 22:13:23 +0000161 if (EmptySize > SizeOfLargestEmptySubobject)
162 SizeOfLargestEmptySubobject = EmptySize;
Anders Carlsson0c54fc92010-05-26 15:54:25 +0000163 }
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000164
Anders Carlsson0c54fc92010-05-26 15:54:25 +0000165 // Check the fields.
166 for (CXXRecordDecl::field_iterator I = Class->field_begin(),
167 E = Class->field_end(); I != E; ++I) {
168 const FieldDecl *FD = *I;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000169
170 const RecordType *RT =
Anders Carlsson0c54fc92010-05-26 15:54:25 +0000171 Context.getBaseElementType(FD->getType())->getAs<RecordType>();
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000172
Anders Carlsson0c54fc92010-05-26 15:54:25 +0000173 // We only care about record types.
174 if (!RT)
175 continue;
176
Anders Carlssona3d43802010-10-31 22:13:23 +0000177 CharUnits EmptySize;
Anders Carlsson0c54fc92010-05-26 15:54:25 +0000178 const CXXRecordDecl *MemberDecl = cast<CXXRecordDecl>(RT->getDecl());
179 const ASTRecordLayout &Layout = Context.getASTRecordLayout(MemberDecl);
180 if (MemberDecl->isEmpty()) {
181 // If the class decl is empty, get its size.
Anders Carlssona3d43802010-10-31 22:13:23 +0000182 EmptySize = toCharUnits(Layout.getSize());
Anders Carlsson0c54fc92010-05-26 15:54:25 +0000183 } else {
184 // Otherwise, we get the largest empty subobject for the decl.
185 EmptySize = Layout.getSizeOfLargestEmptySubobject();
186 }
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000187
Anders Carlssona3d43802010-10-31 22:13:23 +0000188 if (EmptySize > SizeOfLargestEmptySubobject)
189 SizeOfLargestEmptySubobject = EmptySize;
Anders Carlsson0c54fc92010-05-26 15:54:25 +0000190 }
191}
192
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000193bool
Anders Carlsson812a3452010-05-27 18:20:57 +0000194EmptySubobjectMap::CanPlaceSubobjectAtOffset(const CXXRecordDecl *RD,
Anders Carlssonfe5ef732010-10-31 21:39:24 +0000195 CharUnits Offset) const {
Anders Carlsson812a3452010-05-27 18:20:57 +0000196 // We only need to check empty bases.
197 if (!RD->isEmpty())
198 return true;
199
Anders Carlssonfe5ef732010-10-31 21:39:24 +0000200 EmptyClassOffsetsMapTy::const_iterator I = EmptyClassOffsets.find(Offset);
Anders Carlsson812a3452010-05-27 18:20:57 +0000201 if (I == EmptyClassOffsets.end())
202 return true;
203
204 const ClassVectorTy& Classes = I->second;
205 if (std::find(Classes.begin(), Classes.end(), RD) == Classes.end())
206 return true;
207
208 // There is already an empty class of the same type at this offset.
209 return false;
210}
211
212void EmptySubobjectMap::AddSubobjectAtOffset(const CXXRecordDecl *RD,
Anders Carlssonfe5ef732010-10-31 21:39:24 +0000213 CharUnits Offset) {
Anders Carlsson812a3452010-05-27 18:20:57 +0000214 // We only care about empty bases.
215 if (!RD->isEmpty())
216 return;
217
Anders Carlssonfe5ef732010-10-31 21:39:24 +0000218 ClassVectorTy& Classes = EmptyClassOffsets[Offset];
Anders Carlsson812a3452010-05-27 18:20:57 +0000219 assert(std::find(Classes.begin(), Classes.end(), RD) == Classes.end() &&
220 "Duplicate empty class detected!");
Anders Carlsson45f5b542010-06-08 19:09:24 +0000221
Anders Carlsson812a3452010-05-27 18:20:57 +0000222 Classes.push_back(RD);
Anders Carlssonc8cb4622010-06-08 15:56:03 +0000223
224 // Update the empty class offset.
Anders Carlssonfe5ef732010-10-31 21:39:24 +0000225 if (Offset > MaxEmptyClassOffset)
226 MaxEmptyClassOffset = Offset;
Anders Carlsson812a3452010-05-27 18:20:57 +0000227}
228
229bool
Anders Carlssona3d43802010-10-31 22:13:23 +0000230EmptySubobjectMap::CanPlaceBaseSubobjectAtOffset(const BaseSubobjectInfo *Info,
231 CharUnits Offset) {
Anders Carlsson2177ab72010-06-08 16:20:35 +0000232 // We don't have to keep looking past the maximum offset that's known to
233 // contain an empty class.
Anders Carlssona3d43802010-10-31 22:13:23 +0000234 if (!AnyEmptySubobjectsBeyondOffset(Offset))
Anders Carlsson2177ab72010-06-08 16:20:35 +0000235 return true;
236
Anders Carlssona3d43802010-10-31 22:13:23 +0000237 if (!CanPlaceSubobjectAtOffset(Info->Class, Offset))
Anders Carlsson812a3452010-05-27 18:20:57 +0000238 return false;
239
Anders Carlsson58b16b62010-05-27 05:41:06 +0000240 // Traverse all non-virtual bases.
Anders Carlsson4137d512010-05-29 21:10:24 +0000241 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Info->Class);
Anders Carlsson58b16b62010-05-27 05:41:06 +0000242 for (unsigned I = 0, E = Info->Bases.size(); I != E; ++I) {
Anders Carlssonea2f41c2010-05-28 21:24:37 +0000243 BaseSubobjectInfo* Base = Info->Bases[I];
Anders Carlsson58b16b62010-05-27 05:41:06 +0000244 if (Base->IsVirtual)
245 continue;
246
Anders Carlssona3d43802010-10-31 22:13:23 +0000247 CharUnits BaseOffset =
Anders Carlssona14f5972010-10-31 23:22:37 +0000248 Offset + toCharUnits(Layout.getBaseClassOffsetInBits(Base->Class));
Anders Carlsson58b16b62010-05-27 05:41:06 +0000249
250 if (!CanPlaceBaseSubobjectAtOffset(Base, BaseOffset))
251 return false;
252 }
253
Anders Carlsson6e264542010-05-29 17:35:14 +0000254 if (Info->PrimaryVirtualBaseInfo) {
255 BaseSubobjectInfo *PrimaryVirtualBaseInfo = Info->PrimaryVirtualBaseInfo;
Anders Carlsson58b16b62010-05-27 05:41:06 +0000256
257 if (Info == PrimaryVirtualBaseInfo->Derived) {
258 if (!CanPlaceBaseSubobjectAtOffset(PrimaryVirtualBaseInfo, Offset))
259 return false;
260 }
261 }
262
Anders Carlsson812a3452010-05-27 18:20:57 +0000263 // Traverse all member variables.
264 unsigned FieldNo = 0;
265 for (CXXRecordDecl::field_iterator I = Info->Class->field_begin(),
266 E = Info->Class->field_end(); I != E; ++I, ++FieldNo) {
267 const FieldDecl *FD = *I;
Anders Carlsson8c6acc62010-10-31 21:54:55 +0000268 if (FD->isBitField())
269 continue;
270
Anders Carlssona3d43802010-10-31 22:13:23 +0000271 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
Anders Carlsson812a3452010-05-27 18:20:57 +0000272 if (!CanPlaceFieldSubobjectAtOffset(FD, FieldOffset))
273 return false;
274 }
275
Anders Carlsson58b16b62010-05-27 05:41:06 +0000276 return true;
277}
278
Anders Carlssonea2f41c2010-05-28 21:24:37 +0000279void EmptySubobjectMap::UpdateEmptyBaseSubobjects(const BaseSubobjectInfo *Info,
Anders Carlssona3d43802010-10-31 22:13:23 +0000280 CharUnits Offset,
Anders Carlssone3362bc2010-06-13 18:00:18 +0000281 bool PlacingEmptyBase) {
282 if (!PlacingEmptyBase && Offset >= SizeOfLargestEmptySubobject) {
283 // We know that the only empty subobjects that can conflict with empty
284 // subobject of non-empty bases, are empty bases that can be placed at
285 // offset zero. Because of this, we only need to keep track of empty base
286 // subobjects with offsets less than the size of the largest empty
287 // subobject for our class.
288 return;
289 }
290
Anders Carlssona3d43802010-10-31 22:13:23 +0000291 AddSubobjectAtOffset(Info->Class, Offset);
Anders Carlsson4137d512010-05-29 21:10:24 +0000292
Anders Carlsson58b16b62010-05-27 05:41:06 +0000293 // Traverse all non-virtual bases.
Anders Carlsson4137d512010-05-29 21:10:24 +0000294 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Info->Class);
Anders Carlsson58b16b62010-05-27 05:41:06 +0000295 for (unsigned I = 0, E = Info->Bases.size(); I != E; ++I) {
Anders Carlssonea2f41c2010-05-28 21:24:37 +0000296 BaseSubobjectInfo* Base = Info->Bases[I];
Anders Carlsson58b16b62010-05-27 05:41:06 +0000297 if (Base->IsVirtual)
298 continue;
Anders Carlsson4137d512010-05-29 21:10:24 +0000299
Anders Carlssona3d43802010-10-31 22:13:23 +0000300 CharUnits BaseOffset =
Anders Carlssona14f5972010-10-31 23:22:37 +0000301 Offset + toCharUnits(Layout.getBaseClassOffsetInBits(Base->Class));
Anders Carlssone3362bc2010-06-13 18:00:18 +0000302 UpdateEmptyBaseSubobjects(Base, BaseOffset, PlacingEmptyBase);
Anders Carlsson58b16b62010-05-27 05:41:06 +0000303 }
304
Anders Carlsson6e264542010-05-29 17:35:14 +0000305 if (Info->PrimaryVirtualBaseInfo) {
306 BaseSubobjectInfo *PrimaryVirtualBaseInfo = Info->PrimaryVirtualBaseInfo;
Anders Carlsson58b16b62010-05-27 05:41:06 +0000307
308 if (Info == PrimaryVirtualBaseInfo->Derived)
Anders Carlssone3362bc2010-06-13 18:00:18 +0000309 UpdateEmptyBaseSubobjects(PrimaryVirtualBaseInfo, Offset,
310 PlacingEmptyBase);
Anders Carlsson58b16b62010-05-27 05:41:06 +0000311 }
Anders Carlsson812a3452010-05-27 18:20:57 +0000312
Anders Carlsson812a3452010-05-27 18:20:57 +0000313 // Traverse all member variables.
314 unsigned FieldNo = 0;
315 for (CXXRecordDecl::field_iterator I = Info->Class->field_begin(),
316 E = Info->Class->field_end(); I != E; ++I, ++FieldNo) {
317 const FieldDecl *FD = *I;
Anders Carlsson8c6acc62010-10-31 21:54:55 +0000318 if (FD->isBitField())
319 continue;
Anders Carlsson4137d512010-05-29 21:10:24 +0000320
Anders Carlssona3d43802010-10-31 22:13:23 +0000321 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
322 UpdateEmptyFieldSubobjects(FD, FieldOffset);
Anders Carlsson812a3452010-05-27 18:20:57 +0000323 }
Anders Carlsson58b16b62010-05-27 05:41:06 +0000324}
325
Anders Carlsson5b1319c2010-05-29 20:49:49 +0000326bool EmptySubobjectMap::CanPlaceBaseAtOffset(const BaseSubobjectInfo *Info,
Anders Carlssona3d43802010-10-31 22:13:23 +0000327 CharUnits Offset) {
Anders Carlsson261febd2010-05-27 00:07:01 +0000328 // If we know this class doesn't have any empty subobjects we don't need to
329 // bother checking.
Anders Carlssona3d43802010-10-31 22:13:23 +0000330 if (SizeOfLargestEmptySubobject.isZero())
Anders Carlsson261febd2010-05-27 00:07:01 +0000331 return true;
332
Anders Carlsson58b16b62010-05-27 05:41:06 +0000333 if (!CanPlaceBaseSubobjectAtOffset(Info, Offset))
334 return false;
Anders Carlsson812a3452010-05-27 18:20:57 +0000335
336 // We are able to place the base at this offset. Make sure to update the
337 // empty base subobject map.
Anders Carlssone3362bc2010-06-13 18:00:18 +0000338 UpdateEmptyBaseSubobjects(Info, Offset, Info->Class->isEmpty());
Anders Carlsson261febd2010-05-27 00:07:01 +0000339 return true;
340}
341
Anders Carlsson812a3452010-05-27 18:20:57 +0000342bool
343EmptySubobjectMap::CanPlaceFieldSubobjectAtOffset(const CXXRecordDecl *RD,
344 const CXXRecordDecl *Class,
Anders Carlssona3d43802010-10-31 22:13:23 +0000345 CharUnits Offset) const {
Anders Carlsson2177ab72010-06-08 16:20:35 +0000346 // We don't have to keep looking past the maximum offset that's known to
347 // contain an empty class.
Anders Carlssona3d43802010-10-31 22:13:23 +0000348 if (!AnyEmptySubobjectsBeyondOffset(Offset))
Anders Carlsson2177ab72010-06-08 16:20:35 +0000349 return true;
350
Anders Carlssona3d43802010-10-31 22:13:23 +0000351 if (!CanPlaceSubobjectAtOffset(RD, Offset))
Anders Carlsson812a3452010-05-27 18:20:57 +0000352 return false;
353
354 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
355
356 // Traverse all non-virtual bases.
357 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
358 E = RD->bases_end(); I != E; ++I) {
359 if (I->isVirtual())
360 continue;
361
362 const CXXRecordDecl *BaseDecl =
363 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
364
Anders Carlssona3d43802010-10-31 22:13:23 +0000365 CharUnits BaseOffset =
Anders Carlssona14f5972010-10-31 23:22:37 +0000366 Offset + toCharUnits(Layout.getBaseClassOffsetInBits(BaseDecl));
Anders Carlsson812a3452010-05-27 18:20:57 +0000367 if (!CanPlaceFieldSubobjectAtOffset(BaseDecl, Class, BaseOffset))
368 return false;
369 }
370
Anders Carlsson45f5b542010-06-08 19:09:24 +0000371 if (RD == Class) {
372 // This is the most derived class, traverse virtual bases as well.
373 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
374 E = RD->vbases_end(); I != E; ++I) {
375 const CXXRecordDecl *VBaseDecl =
376 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
377
Anders Carlsson3069a0d2010-10-31 23:45:59 +0000378 CharUnits VBaseOffset = Offset + Layout.getVBaseClassOffset(VBaseDecl);
Anders Carlsson45f5b542010-06-08 19:09:24 +0000379 if (!CanPlaceFieldSubobjectAtOffset(VBaseDecl, Class, VBaseOffset))
380 return false;
381 }
382 }
383
Anders Carlsson812a3452010-05-27 18:20:57 +0000384 // Traverse all member variables.
385 unsigned FieldNo = 0;
386 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
387 I != E; ++I, ++FieldNo) {
388 const FieldDecl *FD = *I;
Anders Carlsson8c6acc62010-10-31 21:54:55 +0000389 if (FD->isBitField())
390 continue;
391
Anders Carlssona3d43802010-10-31 22:13:23 +0000392 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
Anders Carlsson812a3452010-05-27 18:20:57 +0000393
394 if (!CanPlaceFieldSubobjectAtOffset(FD, FieldOffset))
395 return false;
396 }
397
398 return true;
399}
400
Anders Carlsson8c6acc62010-10-31 21:54:55 +0000401bool
402EmptySubobjectMap::CanPlaceFieldSubobjectAtOffset(const FieldDecl *FD,
403 CharUnits Offset) const {
Anders Carlsson2177ab72010-06-08 16:20:35 +0000404 // We don't have to keep looking past the maximum offset that's known to
405 // contain an empty class.
Anders Carlsson8c6acc62010-10-31 21:54:55 +0000406 if (!AnyEmptySubobjectsBeyondOffset(Offset))
Anders Carlsson2177ab72010-06-08 16:20:35 +0000407 return true;
408
Anders Carlsson812a3452010-05-27 18:20:57 +0000409 QualType T = FD->getType();
410 if (const RecordType *RT = T->getAs<RecordType>()) {
411 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
Anders Carlssona3d43802010-10-31 22:13:23 +0000412 return CanPlaceFieldSubobjectAtOffset(RD, RD, Offset);
Anders Carlsson812a3452010-05-27 18:20:57 +0000413 }
414
415 // If we have an array type we need to look at every element.
416 if (const ConstantArrayType *AT = Context.getAsConstantArrayType(T)) {
417 QualType ElemTy = Context.getBaseElementType(AT);
418 const RecordType *RT = ElemTy->getAs<RecordType>();
419 if (!RT)
420 return true;
421
422 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
423 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
424
425 uint64_t NumElements = Context.getConstantArrayElementCount(AT);
Anders Carlsson8c6acc62010-10-31 21:54:55 +0000426 CharUnits ElementOffset = Offset;
Anders Carlsson812a3452010-05-27 18:20:57 +0000427 for (uint64_t I = 0; I != NumElements; ++I) {
Anders Carlsson2177ab72010-06-08 16:20:35 +0000428 // We don't have to keep looking past the maximum offset that's known to
429 // contain an empty class.
Anders Carlsson8c6acc62010-10-31 21:54:55 +0000430 if (!AnyEmptySubobjectsBeyondOffset(ElementOffset))
Anders Carlsson2177ab72010-06-08 16:20:35 +0000431 return true;
432
Anders Carlssona3d43802010-10-31 22:13:23 +0000433 if (!CanPlaceFieldSubobjectAtOffset(RD, RD, ElementOffset))
Anders Carlsson812a3452010-05-27 18:20:57 +0000434 return false;
435
Anders Carlsson8c6acc62010-10-31 21:54:55 +0000436 ElementOffset += toCharUnits(Layout.getSize());
Anders Carlsson812a3452010-05-27 18:20:57 +0000437 }
438 }
439
440 return true;
441}
442
443bool
Anders Carlssona3d43802010-10-31 22:13:23 +0000444EmptySubobjectMap::CanPlaceFieldAtOffset(const FieldDecl *FD,
445 CharUnits Offset) {
446 if (!CanPlaceFieldSubobjectAtOffset(FD, Offset))
Anders Carlsson812a3452010-05-27 18:20:57 +0000447 return false;
448
449 // We are able to place the member variable at this offset.
450 // Make sure to update the empty base subobject map.
451 UpdateEmptyFieldSubobjects(FD, Offset);
452 return true;
453}
454
455void EmptySubobjectMap::UpdateEmptyFieldSubobjects(const CXXRecordDecl *RD,
456 const CXXRecordDecl *Class,
Anders Carlssona3d43802010-10-31 22:13:23 +0000457 CharUnits Offset) {
Anders Carlsson5ccfdd82010-06-13 17:49:16 +0000458 // We know that the only empty subobjects that can conflict with empty
Anders Carlssone3362bc2010-06-13 18:00:18 +0000459 // field subobjects are subobjects of empty bases that can be placed at offset
Anders Carlsson5ccfdd82010-06-13 17:49:16 +0000460 // zero. Because of this, we only need to keep track of empty field
461 // subobjects with offsets less than the size of the largest empty
462 // subobject for our class.
463 if (Offset >= SizeOfLargestEmptySubobject)
464 return;
465
Anders Carlssona3d43802010-10-31 22:13:23 +0000466 AddSubobjectAtOffset(RD, Offset);
Anders Carlsson812a3452010-05-27 18:20:57 +0000467
468 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
469
470 // Traverse all non-virtual bases.
471 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
472 E = RD->bases_end(); I != E; ++I) {
473 if (I->isVirtual())
474 continue;
475
476 const CXXRecordDecl *BaseDecl =
477 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
478
Anders Carlssona3d43802010-10-31 22:13:23 +0000479 CharUnits BaseOffset =
Anders Carlssona14f5972010-10-31 23:22:37 +0000480 Offset + toCharUnits(Layout.getBaseClassOffsetInBits(BaseDecl));
Anders Carlsson812a3452010-05-27 18:20:57 +0000481 UpdateEmptyFieldSubobjects(BaseDecl, Class, BaseOffset);
482 }
483
Anders Carlsson45f5b542010-06-08 19:09:24 +0000484 if (RD == Class) {
485 // This is the most derived class, traverse virtual bases as well.
486 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
487 E = RD->vbases_end(); I != E; ++I) {
488 const CXXRecordDecl *VBaseDecl =
489 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
490
Anders Carlsson3069a0d2010-10-31 23:45:59 +0000491 CharUnits VBaseOffset = Offset + Layout.getVBaseClassOffset(VBaseDecl);
Anders Carlsson45f5b542010-06-08 19:09:24 +0000492 UpdateEmptyFieldSubobjects(VBaseDecl, Class, VBaseOffset);
493 }
494 }
495
Anders Carlsson812a3452010-05-27 18:20:57 +0000496 // Traverse all member variables.
497 unsigned FieldNo = 0;
498 for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
499 I != E; ++I, ++FieldNo) {
500 const FieldDecl *FD = *I;
501
Anders Carlssona3d43802010-10-31 22:13:23 +0000502 CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
Anders Carlsson812a3452010-05-27 18:20:57 +0000503
Anders Carlssona3d43802010-10-31 22:13:23 +0000504 UpdateEmptyFieldSubobjects(FD, FieldOffset);
Anders Carlsson812a3452010-05-27 18:20:57 +0000505 }
506}
507
508void EmptySubobjectMap::UpdateEmptyFieldSubobjects(const FieldDecl *FD,
Anders Carlssona3d43802010-10-31 22:13:23 +0000509 CharUnits Offset) {
Anders Carlsson812a3452010-05-27 18:20:57 +0000510 QualType T = FD->getType();
511 if (const RecordType *RT = T->getAs<RecordType>()) {
512 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
513 UpdateEmptyFieldSubobjects(RD, RD, Offset);
514 return;
515 }
516
517 // If we have an array type we need to update every element.
518 if (const ConstantArrayType *AT = Context.getAsConstantArrayType(T)) {
519 QualType ElemTy = Context.getBaseElementType(AT);
520 const RecordType *RT = ElemTy->getAs<RecordType>();
521 if (!RT)
522 return;
523
524 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
525 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
526
527 uint64_t NumElements = Context.getConstantArrayElementCount(AT);
Anders Carlssona3d43802010-10-31 22:13:23 +0000528 CharUnits ElementOffset = Offset;
Anders Carlsson812a3452010-05-27 18:20:57 +0000529
530 for (uint64_t I = 0; I != NumElements; ++I) {
Anders Carlsson5ccfdd82010-06-13 17:49:16 +0000531 // We know that the only empty subobjects that can conflict with empty
Anders Carlssone3362bc2010-06-13 18:00:18 +0000532 // field subobjects are subobjects of empty bases that can be placed at
Anders Carlsson5ccfdd82010-06-13 17:49:16 +0000533 // offset zero. Because of this, we only need to keep track of empty field
534 // subobjects with offsets less than the size of the largest empty
535 // subobject for our class.
536 if (ElementOffset >= SizeOfLargestEmptySubobject)
537 return;
538
Anders Carlsson812a3452010-05-27 18:20:57 +0000539 UpdateEmptyFieldSubobjects(RD, RD, ElementOffset);
Anders Carlssona3d43802010-10-31 22:13:23 +0000540 ElementOffset += toCharUnits(Layout.getSize());
Anders Carlsson812a3452010-05-27 18:20:57 +0000541 }
542 }
543}
544
Anders Carlsson7d0918a2010-05-26 05:58:59 +0000545class RecordLayoutBuilder {
Charles Davisc9f8aec2010-08-19 00:55:19 +0000546protected:
Anders Carlsson9392fa62010-05-26 05:41:04 +0000547 // FIXME: Remove this and make the appropriate fields public.
548 friend class clang::ASTContext;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000549
Anders Carlsson9392fa62010-05-26 05:41:04 +0000550 ASTContext &Context;
551
Anders Carlsson6a91c032010-05-26 15:32:58 +0000552 EmptySubobjectMap *EmptySubobjects;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000553
Anders Carlsson9392fa62010-05-26 05:41:04 +0000554 /// Size - The current size of the record layout.
555 uint64_t Size;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000556
Anders Carlsson9392fa62010-05-26 05:41:04 +0000557 /// Alignment - The current alignment of the record layout.
558 unsigned Alignment;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000559
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +0000560 /// \brief The alignment if attribute packed is not used.
561 unsigned UnpackedAlignment;
562
Anders Carlsson9392fa62010-05-26 05:41:04 +0000563 llvm::SmallVector<uint64_t, 16> FieldOffsets;
564
565 /// Packed - Whether the record is packed or not.
Daniel Dunbarc6082fe2010-05-27 05:45:51 +0000566 unsigned Packed : 1;
567
568 unsigned IsUnion : 1;
569
570 unsigned IsMac68kAlign : 1;
Anders Carlsson9392fa62010-05-26 05:41:04 +0000571
572 /// UnfilledBitsInLastByte - If the last field laid out was a bitfield,
573 /// this contains the number of bits in the last byte that can be used for
574 /// an adjacent bitfield if necessary.
575 unsigned char UnfilledBitsInLastByte;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000576
Anders Carlsson9392fa62010-05-26 05:41:04 +0000577 /// MaxFieldAlignment - The maximum allowed field alignment. This is set by
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000578 /// #pragma pack.
Anders Carlsson9392fa62010-05-26 05:41:04 +0000579 unsigned MaxFieldAlignment;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000580
Anders Carlsson9392fa62010-05-26 05:41:04 +0000581 /// DataSize - The data size of the record being laid out.
582 uint64_t DataSize;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000583
Anders Carlsson9392fa62010-05-26 05:41:04 +0000584 uint64_t NonVirtualSize;
585 unsigned NonVirtualAlignment;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000586
Anders Carlsson9392fa62010-05-26 05:41:04 +0000587 /// PrimaryBase - the primary base class (if one exists) of the class
588 /// we're laying out.
589 const CXXRecordDecl *PrimaryBase;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000590
Anders Carlsson9392fa62010-05-26 05:41:04 +0000591 /// PrimaryBaseIsVirtual - Whether the primary base of the class we're laying
592 /// out is virtual.
593 bool PrimaryBaseIsVirtual;
594
Anders Carlsson376bda92010-10-31 21:01:46 +0000595 typedef llvm::DenseMap<const CXXRecordDecl *, CharUnits> BaseOffsetsMapTy;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000596
Anders Carlsson9392fa62010-05-26 05:41:04 +0000597 /// Bases - base classes and their offsets in the record.
598 BaseOffsetsMapTy Bases;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000599
Anders Carlsson9392fa62010-05-26 05:41:04 +0000600 // VBases - virtual base classes and their offsets in the record.
601 BaseOffsetsMapTy VBases;
602
603 /// IndirectPrimaryBases - Virtual base classes, direct or indirect, that are
604 /// primary base classes for some other direct or indirect base class.
605 llvm::SmallSet<const CXXRecordDecl*, 32> IndirectPrimaryBases;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000606
Anders Carlsson9392fa62010-05-26 05:41:04 +0000607 /// FirstNearlyEmptyVBase - The first nearly empty virtual base class in
608 /// inheritance graph order. Used for determining the primary base class.
609 const CXXRecordDecl *FirstNearlyEmptyVBase;
610
611 /// VisitedVirtualBases - A set of all the visited virtual bases, used to
612 /// avoid visiting virtual bases more than once.
613 llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBases;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000614
Anders Carlsson261febd2010-05-27 00:07:01 +0000615 RecordLayoutBuilder(ASTContext &Context, EmptySubobjectMap *EmptySubobjects)
616 : Context(Context), EmptySubobjects(EmptySubobjects), Size(0), Alignment(8),
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +0000617 UnpackedAlignment(Alignment), Packed(false), IsUnion(false),
618 IsMac68kAlign(false), UnfilledBitsInLastByte(0), MaxFieldAlignment(0),
619 DataSize(0), NonVirtualSize(0), NonVirtualAlignment(8), PrimaryBase(0),
Daniel Dunbarc6082fe2010-05-27 05:45:51 +0000620 PrimaryBaseIsVirtual(false), FirstNearlyEmptyVBase(0) { }
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000621
Anders Carlssonfe5ef732010-10-31 21:39:24 +0000622 // FIXME: Remove these.
623 CharUnits toCharUnits(uint64_t Offset) const {
624 return CharUnits::fromQuantity(Offset / Context.getCharWidth());
625 }
626 uint64_t toOffset(CharUnits Offset) const {
627 return Offset.getQuantity() * Context.getCharWidth();
628 }
629
Anders Carlsson9392fa62010-05-26 05:41:04 +0000630 void Layout(const RecordDecl *D);
Anders Carlssonc6cab682010-05-26 15:10:00 +0000631 void Layout(const CXXRecordDecl *D);
Anders Carlsson9392fa62010-05-26 05:41:04 +0000632 void Layout(const ObjCInterfaceDecl *D);
633
634 void LayoutFields(const RecordDecl *D);
635 void LayoutField(const FieldDecl *D);
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +0000636 void LayoutWideBitField(uint64_t FieldSize, uint64_t TypeSize,
637 bool FieldPacked, const FieldDecl *D);
Anders Carlsson9392fa62010-05-26 05:41:04 +0000638 void LayoutBitField(const FieldDecl *D);
639
Anders Carlsson6e264542010-05-29 17:35:14 +0000640 /// BaseSubobjectInfoAllocator - Allocator for BaseSubobjectInfo objects.
641 llvm::SpecificBumpPtrAllocator<BaseSubobjectInfo> BaseSubobjectInfoAllocator;
642
643 typedef llvm::DenseMap<const CXXRecordDecl *, BaseSubobjectInfo *>
644 BaseSubobjectInfoMapTy;
645
646 /// VirtualBaseInfo - Map from all the (direct or indirect) virtual bases
647 /// of the class we're laying out to their base subobject info.
648 BaseSubobjectInfoMapTy VirtualBaseInfo;
649
650 /// NonVirtualBaseInfo - Map from all the direct non-virtual bases of the
651 /// class we're laying out to their base subobject info.
652 BaseSubobjectInfoMapTy NonVirtualBaseInfo;
653
654 /// ComputeBaseSubobjectInfo - Compute the base subobject information for the
655 /// bases of the given class.
656 void ComputeBaseSubobjectInfo(const CXXRecordDecl *RD);
657
658 /// ComputeBaseSubobjectInfo - Compute the base subobject information for a
659 /// single class and all of its base classes.
660 BaseSubobjectInfo *ComputeBaseSubobjectInfo(const CXXRecordDecl *RD,
661 bool IsVirtual,
662 BaseSubobjectInfo *Derived);
Anders Carlsson9392fa62010-05-26 05:41:04 +0000663
664 /// DeterminePrimaryBase - Determine the primary base of the given class.
665 void DeterminePrimaryBase(const CXXRecordDecl *RD);
666
667 void SelectPrimaryVBase(const CXXRecordDecl *RD);
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000668
Charles Davisc9f8aec2010-08-19 00:55:19 +0000669 virtual uint64_t GetVirtualPointersSize(const CXXRecordDecl *RD) const;
670
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000671 /// IdentifyPrimaryBases - Identify all virtual base classes, direct or
672 /// indirect, that are primary base classes for some other direct or indirect
Anders Carlsson9392fa62010-05-26 05:41:04 +0000673 /// base class.
674 void IdentifyPrimaryBases(const CXXRecordDecl *RD);
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000675
Charles Davisc9f8aec2010-08-19 00:55:19 +0000676 virtual bool IsNearlyEmpty(const CXXRecordDecl *RD) const;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000677
678 /// LayoutNonVirtualBases - Determines the primary base class (if any) and
Anders Carlsson9392fa62010-05-26 05:41:04 +0000679 /// lays it out. Will then proceed to lay out all non-virtual base clasess.
680 void LayoutNonVirtualBases(const CXXRecordDecl *RD);
681
682 /// LayoutNonVirtualBase - Lays out a single non-virtual base.
Anders Carlsson07cebc52010-05-29 17:42:25 +0000683 void LayoutNonVirtualBase(const BaseSubobjectInfo *Base);
Anders Carlsson9392fa62010-05-26 05:41:04 +0000684
Anders Carlssona2311512010-10-31 22:20:42 +0000685 void AddPrimaryVirtualBaseOffsets(const BaseSubobjectInfo *Info,
686 CharUnits Offset);
Anders Carlsson9392fa62010-05-26 05:41:04 +0000687
688 /// LayoutVirtualBases - Lays out all the virtual bases.
689 void LayoutVirtualBases(const CXXRecordDecl *RD,
690 const CXXRecordDecl *MostDerivedClass);
691
692 /// LayoutVirtualBase - Lays out a single virtual base.
Anders Carlsson276b4912010-05-29 17:48:36 +0000693 void LayoutVirtualBase(const BaseSubobjectInfo *Base);
Anders Carlsson9392fa62010-05-26 05:41:04 +0000694
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000695 /// LayoutBase - Will lay out a base and return the offset where it was
Anders Carlssona2311512010-10-31 22:20:42 +0000696 /// placed, in chars.
697 CharUnits LayoutBase(const BaseSubobjectInfo *Base);
Anders Carlsson9392fa62010-05-26 05:41:04 +0000698
Anders Carlssonc6cab682010-05-26 15:10:00 +0000699 /// InitializeLayout - Initialize record layout for the given record decl.
Daniel Dunbarc6082fe2010-05-27 05:45:51 +0000700 void InitializeLayout(const Decl *D);
Anders Carlssonc6cab682010-05-26 15:10:00 +0000701
Anders Carlsson9392fa62010-05-26 05:41:04 +0000702 /// FinishLayout - Finalize record layout. Adjust record size based on the
703 /// alignment.
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +0000704 void FinishLayout(const NamedDecl *D);
Anders Carlsson9392fa62010-05-26 05:41:04 +0000705
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +0000706 void UpdateAlignment(unsigned NewAlignment, unsigned UnpackedNewAlignment);
707 void UpdateAlignment(unsigned NewAlignment) {
708 UpdateAlignment(NewAlignment, NewAlignment);
709 }
710
711 void CheckFieldPadding(uint64_t Offset, uint64_t UnpaddedOffset,
712 uint64_t UnpackedOffset, unsigned UnpackedAlign,
713 bool isPacked, const FieldDecl *D);
714
715 DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID);
Anders Carlsson9392fa62010-05-26 05:41:04 +0000716
Argyrios Kyrtzidisc83d2d72010-08-15 10:17:39 +0000717 RecordLayoutBuilder(const RecordLayoutBuilder&); // DO NOT IMPLEMENT
718 void operator=(const RecordLayoutBuilder&); // DO NOT IMPLEMENT
Anders Carlsson9392fa62010-05-26 05:41:04 +0000719public:
720 static const CXXMethodDecl *ComputeKeyFunction(const CXXRecordDecl *RD);
Argyrios Kyrtzidiscfe17e52010-08-25 00:32:14 +0000721
722 virtual ~RecordLayoutBuilder() { }
Anders Carlsson9392fa62010-05-26 05:41:04 +0000723};
Benjamin Kramer7e220282010-05-26 09:58:31 +0000724} // end anonymous namespace
Anders Carlsson9392fa62010-05-26 05:41:04 +0000725
Mike Stump6f376332009-08-05 22:37:18 +0000726/// IsNearlyEmpty - Indicates when a class has a vtable pointer, but
727/// no other data.
Anders Carlsson7d0918a2010-05-26 05:58:59 +0000728bool RecordLayoutBuilder::IsNearlyEmpty(const CXXRecordDecl *RD) const {
Mike Stump6f376332009-08-05 22:37:18 +0000729 // FIXME: Audit the corners
730 if (!RD->isDynamicClass())
731 return false;
Anders Carlsson0f0e9b02010-04-16 15:07:51 +0000732 const ASTRecordLayout &BaseInfo = Context.getASTRecordLayout(RD);
733 if (BaseInfo.getNonVirtualSize() == Context.Target.getPointerWidth(0))
Mike Stump6f376332009-08-05 22:37:18 +0000734 return true;
735 return false;
736}
737
Anders Carlsson7d0918a2010-05-26 05:58:59 +0000738void RecordLayoutBuilder::IdentifyPrimaryBases(const CXXRecordDecl *RD) {
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +0000739 const ASTRecordLayout::PrimaryBaseInfo &BaseInfo =
Anders Carlsson0f0e9b02010-04-16 15:07:51 +0000740 Context.getASTRecordLayout(RD).getPrimaryBaseInfo();
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +0000741
Anders Carlsson3f066522009-09-22 03:02:06 +0000742 // If the record has a primary base class that is virtual, add it to the set
743 // of primary bases.
Anders Carlsson261fba62009-11-27 22:14:40 +0000744 if (BaseInfo.isVirtual())
745 IndirectPrimaryBases.insert(BaseInfo.getBase());
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +0000746
Anders Carlsson3f066522009-09-22 03:02:06 +0000747 // Now traverse all bases and find primary bases for them.
Mike Stump6f376332009-08-05 22:37:18 +0000748 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +0000749 e = RD->bases_end(); i != e; ++i) {
Sebastian Redl9994a342009-10-25 17:03:50 +0000750 assert(!i->getType()->isDependentType() &&
751 "Cannot layout class with dependent bases.");
Mike Stump1eb44332009-09-09 15:08:12 +0000752 const CXXRecordDecl *Base =
Mike Stump49520942009-08-11 04:03:59 +0000753 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +0000754
Mike Stump49520942009-08-11 04:03:59 +0000755 // Only bases with virtual bases participate in computing the
756 // indirect primary virtual base classes.
Mike Stump4ef98092009-08-13 22:53:07 +0000757 if (Base->getNumVBases())
Anders Carlsson3f066522009-09-22 03:02:06 +0000758 IdentifyPrimaryBases(Base);
Mike Stump6f376332009-08-05 22:37:18 +0000759 }
760}
761
Anders Carlsson3f066522009-09-22 03:02:06 +0000762void
Anders Carlsson7d0918a2010-05-26 05:58:59 +0000763RecordLayoutBuilder::SelectPrimaryVBase(const CXXRecordDecl *RD) {
Anders Carlsson584e1df2010-03-11 03:39:12 +0000764 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +0000765 E = RD->bases_end(); I != E; ++I) {
Anders Carlsson584e1df2010-03-11 03:39:12 +0000766 assert(!I->getType()->isDependentType() &&
Sebastian Redl9994a342009-10-25 17:03:50 +0000767 "Cannot layout class with dependent bases.");
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +0000768
Mike Stump1eb44332009-09-09 15:08:12 +0000769 const CXXRecordDecl *Base =
Anders Carlsson584e1df2010-03-11 03:39:12 +0000770 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson200c5c22010-03-11 00:15:35 +0000771
Anders Carlsson584e1df2010-03-11 03:39:12 +0000772 // Check if this is a nearly empty virtual base.
773 if (I->isVirtual() && IsNearlyEmpty(Base)) {
774 // If it's not an indirect primary base, then we've found our primary
775 // base.
Anders Carlsson3f066522009-09-22 03:02:06 +0000776 if (!IndirectPrimaryBases.count(Base)) {
Anders Carlsson28fdd0a2010-05-26 05:20:58 +0000777 PrimaryBase = Base;
778 PrimaryBaseIsVirtual = true;
Mike Stumpd76264e2009-08-12 21:50:08 +0000779 return;
780 }
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +0000781
Anders Carlsson584e1df2010-03-11 03:39:12 +0000782 // Is this the first nearly empty virtual base?
783 if (!FirstNearlyEmptyVBase)
784 FirstNearlyEmptyVBase = Base;
Mike Stumpd76264e2009-08-12 21:50:08 +0000785 }
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +0000786
Anders Carlsson200c5c22010-03-11 00:15:35 +0000787 SelectPrimaryVBase(Base);
Anders Carlsson28fdd0a2010-05-26 05:20:58 +0000788 if (PrimaryBase)
Zhongxing Xu94ba3802010-02-15 04:28:35 +0000789 return;
Mike Stumpd76264e2009-08-12 21:50:08 +0000790 }
791}
792
Charles Davisc9f8aec2010-08-19 00:55:19 +0000793uint64_t
794RecordLayoutBuilder::GetVirtualPointersSize(const CXXRecordDecl *RD) const {
795 return Context.Target.getPointerWidth(0);
796}
797
Anders Carlsson200c5c22010-03-11 00:15:35 +0000798/// DeterminePrimaryBase - Determine the primary base of the given class.
Anders Carlsson7d0918a2010-05-26 05:58:59 +0000799void RecordLayoutBuilder::DeterminePrimaryBase(const CXXRecordDecl *RD) {
Anders Carlsson200c5c22010-03-11 00:15:35 +0000800 // If the class isn't dynamic, it won't have a primary base.
801 if (!RD->isDynamicClass())
802 return;
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +0000803
Anders Carlsson3f066522009-09-22 03:02:06 +0000804 // Compute all the primary virtual bases for all of our direct and
Mike Stump0880e752009-08-13 23:26:06 +0000805 // indirect bases, and record all their primary virtual base classes.
Mike Stump0880e752009-08-13 23:26:06 +0000806 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +0000807 e = RD->bases_end(); i != e; ++i) {
Sebastian Redl9994a342009-10-25 17:03:50 +0000808 assert(!i->getType()->isDependentType() &&
Anders Carlsson200c5c22010-03-11 00:15:35 +0000809 "Cannot lay out class with dependent bases.");
Mike Stump1eb44332009-09-09 15:08:12 +0000810 const CXXRecordDecl *Base =
Mike Stump0880e752009-08-13 23:26:06 +0000811 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
Anders Carlsson3f066522009-09-22 03:02:06 +0000812 IdentifyPrimaryBases(Base);
Mike Stump0880e752009-08-13 23:26:06 +0000813 }
814
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +0000815 // If the record has a dynamic base class, attempt to choose a primary base
816 // class. It is the first (in direct base class order) non-virtual dynamic
Anders Carlsson3f066522009-09-22 03:02:06 +0000817 // base class, if one exists.
Mike Stump6f376332009-08-05 22:37:18 +0000818 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +0000819 e = RD->bases_end(); i != e; ++i) {
Anders Carlssonce2009a2009-11-27 22:05:05 +0000820 // Ignore virtual bases.
821 if (i->isVirtual())
822 continue;
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +0000823
Anders Carlssonce2009a2009-11-27 22:05:05 +0000824 const CXXRecordDecl *Base =
825 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
826
827 if (Base->isDynamicClass()) {
828 // We found it.
Anders Carlsson28fdd0a2010-05-26 05:20:58 +0000829 PrimaryBase = Base;
830 PrimaryBaseIsVirtual = false;
Anders Carlssonce2009a2009-11-27 22:05:05 +0000831 return;
Mike Stump6f376332009-08-05 22:37:18 +0000832 }
833 }
834
835 // Otherwise, it is the first nearly empty virtual base that is not an
Mike Stump49520942009-08-11 04:03:59 +0000836 // indirect primary virtual base class, if one exists.
Anders Carlsson200c5c22010-03-11 00:15:35 +0000837 if (RD->getNumVBases() != 0) {
838 SelectPrimaryVBase(RD);
Anders Carlsson28fdd0a2010-05-26 05:20:58 +0000839 if (PrimaryBase)
Anders Carlsson200c5c22010-03-11 00:15:35 +0000840 return;
841 }
Mike Stump6f376332009-08-05 22:37:18 +0000842
Anders Carlsson200c5c22010-03-11 00:15:35 +0000843 // Otherwise, it is the first nearly empty virtual base that is not an
844 // indirect primary virtual base class, if one exists.
845 if (FirstNearlyEmptyVBase) {
Anders Carlsson28fdd0a2010-05-26 05:20:58 +0000846 PrimaryBase = FirstNearlyEmptyVBase;
847 PrimaryBaseIsVirtual = true;
Mike Stump6f376332009-08-05 22:37:18 +0000848 return;
Anders Carlsson200c5c22010-03-11 00:15:35 +0000849 }
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +0000850
Anders Carlsson200c5c22010-03-11 00:15:35 +0000851 // Otherwise there is no primary base class.
Anders Carlsson28fdd0a2010-05-26 05:20:58 +0000852 assert(!PrimaryBase && "Should not get here with a primary base!");
Mike Stump6f376332009-08-05 22:37:18 +0000853
Anders Carlsson200c5c22010-03-11 00:15:35 +0000854 // Allocate the virtual table pointer at offset zero.
855 assert(DataSize == 0 && "Vtable pointer must be at offset zero!");
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +0000856
Anders Carlsson200c5c22010-03-11 00:15:35 +0000857 // Update the size.
Charles Davisc9f8aec2010-08-19 00:55:19 +0000858 Size += GetVirtualPointersSize(RD);
Anders Carlsson200c5c22010-03-11 00:15:35 +0000859 DataSize = Size;
860
861 // Update the alignment.
Anders Carlsson0f0e9b02010-04-16 15:07:51 +0000862 UpdateAlignment(Context.Target.getPointerAlign(0));
Mike Stump6f376332009-08-05 22:37:18 +0000863}
864
Anders Carlsson6e264542010-05-29 17:35:14 +0000865BaseSubobjectInfo *
866RecordLayoutBuilder::ComputeBaseSubobjectInfo(const CXXRecordDecl *RD,
867 bool IsVirtual,
868 BaseSubobjectInfo *Derived) {
869 BaseSubobjectInfo *Info;
870
871 if (IsVirtual) {
872 // Check if we already have info about this virtual base.
873 BaseSubobjectInfo *&InfoSlot = VirtualBaseInfo[RD];
874 if (InfoSlot) {
875 assert(InfoSlot->Class == RD && "Wrong class for virtual base info!");
876 return InfoSlot;
877 }
878
879 // We don't, create it.
880 InfoSlot = new (BaseSubobjectInfoAllocator.Allocate()) BaseSubobjectInfo;
881 Info = InfoSlot;
882 } else {
883 Info = new (BaseSubobjectInfoAllocator.Allocate()) BaseSubobjectInfo;
884 }
885
886 Info->Class = RD;
887 Info->IsVirtual = IsVirtual;
888 Info->Derived = 0;
889 Info->PrimaryVirtualBaseInfo = 0;
890
891 const CXXRecordDecl *PrimaryVirtualBase = 0;
892 BaseSubobjectInfo *PrimaryVirtualBaseInfo = 0;
893
894 // Check if this base has a primary virtual base.
895 if (RD->getNumVBases()) {
896 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
897 if (Layout.getPrimaryBaseWasVirtual()) {
898 // This base does have a primary virtual base.
899 PrimaryVirtualBase = Layout.getPrimaryBase();
900 assert(PrimaryVirtualBase && "Didn't have a primary virtual base!");
901
902 // Now check if we have base subobject info about this primary base.
903 PrimaryVirtualBaseInfo = VirtualBaseInfo.lookup(PrimaryVirtualBase);
904
905 if (PrimaryVirtualBaseInfo) {
906 if (PrimaryVirtualBaseInfo->Derived) {
907 // We did have info about this primary base, and it turns out that it
908 // has already been claimed as a primary virtual base for another
909 // base.
910 PrimaryVirtualBase = 0;
911 } else {
912 // We can claim this base as our primary base.
913 Info->PrimaryVirtualBaseInfo = PrimaryVirtualBaseInfo;
914 PrimaryVirtualBaseInfo->Derived = Info;
915 }
916 }
917 }
918 }
919
920 // Now go through all direct bases.
921 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
922 E = RD->bases_end(); I != E; ++I) {
923 bool IsVirtual = I->isVirtual();
924
925 const CXXRecordDecl *BaseDecl =
926 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
927
928 Info->Bases.push_back(ComputeBaseSubobjectInfo(BaseDecl, IsVirtual, Info));
929 }
930
931 if (PrimaryVirtualBase && !PrimaryVirtualBaseInfo) {
932 // Traversing the bases must have created the base info for our primary
933 // virtual base.
934 PrimaryVirtualBaseInfo = VirtualBaseInfo.lookup(PrimaryVirtualBase);
935 assert(PrimaryVirtualBaseInfo &&
936 "Did not create a primary virtual base!");
937
938 // Claim the primary virtual base as our primary virtual base.
939 Info->PrimaryVirtualBaseInfo = PrimaryVirtualBaseInfo;
940 PrimaryVirtualBaseInfo->Derived = Info;
941 }
942
943 return Info;
944}
945
946void RecordLayoutBuilder::ComputeBaseSubobjectInfo(const CXXRecordDecl *RD) {
947 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
948 E = RD->bases_end(); I != E; ++I) {
949 bool IsVirtual = I->isVirtual();
950
951 const CXXRecordDecl *BaseDecl =
952 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
953
954 // Compute the base subobject info for this base.
955 BaseSubobjectInfo *Info = ComputeBaseSubobjectInfo(BaseDecl, IsVirtual, 0);
956
957 if (IsVirtual) {
958 // ComputeBaseInfo has already added this base for us.
959 assert(VirtualBaseInfo.count(BaseDecl) &&
960 "Did not add virtual base!");
961 } else {
962 // Add the base info to the map of non-virtual bases.
963 assert(!NonVirtualBaseInfo.count(BaseDecl) &&
964 "Non-virtual base already exists!");
965 NonVirtualBaseInfo.insert(std::make_pair(BaseDecl, Info));
966 }
967 }
968}
969
Anders Carlssone239b9d2010-03-10 22:21:28 +0000970void
Anders Carlsson7d0918a2010-05-26 05:58:59 +0000971RecordLayoutBuilder::LayoutNonVirtualBases(const CXXRecordDecl *RD) {
Anders Carlsson6e264542010-05-29 17:35:14 +0000972 // Then, determine the primary base class.
Anders Carlsson200c5c22010-03-11 00:15:35 +0000973 DeterminePrimaryBase(RD);
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +0000974
Anders Carlsson6e264542010-05-29 17:35:14 +0000975 // Compute base subobject info.
976 ComputeBaseSubobjectInfo(RD);
977
Anders Carlsson200c5c22010-03-11 00:15:35 +0000978 // If we have a primary base class, lay it out.
Anders Carlsson28fdd0a2010-05-26 05:20:58 +0000979 if (PrimaryBase) {
980 if (PrimaryBaseIsVirtual) {
Anders Carlsson6e264542010-05-29 17:35:14 +0000981 // If the primary virtual base was a primary virtual base of some other
982 // base class we'll have to steal it.
983 BaseSubobjectInfo *PrimaryBaseInfo = VirtualBaseInfo.lookup(PrimaryBase);
984 PrimaryBaseInfo->Derived = 0;
985
Anders Carlsson200c5c22010-03-11 00:15:35 +0000986 // We have a virtual primary base, insert it as an indirect primary base.
Anders Carlsson28fdd0a2010-05-26 05:20:58 +0000987 IndirectPrimaryBases.insert(PrimaryBase);
Anders Carlsson37147ea2010-03-11 05:42:17 +0000988
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000989 assert(!VisitedVirtualBases.count(PrimaryBase) &&
Anders Carlsson28fdd0a2010-05-26 05:20:58 +0000990 "vbase already visited!");
991 VisitedVirtualBases.insert(PrimaryBase);
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +0000992
Anders Carlsson276b4912010-05-29 17:48:36 +0000993 LayoutVirtualBase(PrimaryBaseInfo);
Anders Carlsson07cebc52010-05-29 17:42:25 +0000994 } else {
995 BaseSubobjectInfo *PrimaryBaseInfo =
996 NonVirtualBaseInfo.lookup(PrimaryBase);
997 assert(PrimaryBaseInfo &&
998 "Did not find base info for non-virtual primary base!");
999
1000 LayoutNonVirtualBase(PrimaryBaseInfo);
1001 }
Anders Carlsson200c5c22010-03-11 00:15:35 +00001002 }
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001003
Anders Carlsson200c5c22010-03-11 00:15:35 +00001004 // Now lay out the non-virtual bases.
1005 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001006 E = RD->bases_end(); I != E; ++I) {
Anders Carlsson200c5c22010-03-11 00:15:35 +00001007
1008 // Ignore virtual bases.
1009 if (I->isVirtual())
1010 continue;
1011
Anders Carlsson07cebc52010-05-29 17:42:25 +00001012 const CXXRecordDecl *BaseDecl =
Anders Carlsson200c5c22010-03-11 00:15:35 +00001013 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1014
1015 // Skip the primary base.
Anders Carlsson07cebc52010-05-29 17:42:25 +00001016 if (BaseDecl == PrimaryBase && !PrimaryBaseIsVirtual)
Anders Carlsson200c5c22010-03-11 00:15:35 +00001017 continue;
1018
1019 // Lay out the base.
Anders Carlsson07cebc52010-05-29 17:42:25 +00001020 BaseSubobjectInfo *BaseInfo = NonVirtualBaseInfo.lookup(BaseDecl);
1021 assert(BaseInfo && "Did not find base info for non-virtual base!");
1022
1023 LayoutNonVirtualBase(BaseInfo);
Anders Carlssone239b9d2010-03-10 22:21:28 +00001024 }
1025}
1026
Anders Carlsson07cebc52010-05-29 17:42:25 +00001027void RecordLayoutBuilder::LayoutNonVirtualBase(const BaseSubobjectInfo *Base) {
Anders Carlssone3bdbee2010-03-10 22:26:24 +00001028 // Layout the base.
Anders Carlssona2311512010-10-31 22:20:42 +00001029 CharUnits Offset = LayoutBase(Base);
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001030
Anders Carlssone3bdbee2010-03-10 22:26:24 +00001031 // Add its base class offset.
Anders Carlsson07cebc52010-05-29 17:42:25 +00001032 assert(!Bases.count(Base->Class) && "base offset already exists!");
Anders Carlssona2311512010-10-31 22:20:42 +00001033 Bases.insert(std::make_pair(Base->Class, Offset));
Anders Carlsson3cd09cc2010-05-29 19:44:50 +00001034
1035 AddPrimaryVirtualBaseOffsets(Base, Offset);
Anders Carlssone239b9d2010-03-10 22:21:28 +00001036}
Mike Stump968db332009-11-05 04:02:15 +00001037
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001038void
Anders Carlsson3cd09cc2010-05-29 19:44:50 +00001039RecordLayoutBuilder::AddPrimaryVirtualBaseOffsets(const BaseSubobjectInfo *Info,
Anders Carlssona2311512010-10-31 22:20:42 +00001040 CharUnits Offset) {
Anders Carlsson3cd09cc2010-05-29 19:44:50 +00001041 // This base isn't interesting, it has no virtual bases.
1042 if (!Info->Class->getNumVBases())
1043 return;
1044
1045 // First, check if we have a virtual primary base to add offsets for.
1046 if (Info->PrimaryVirtualBaseInfo) {
1047 assert(Info->PrimaryVirtualBaseInfo->IsVirtual &&
1048 "Primary virtual base is not virtual!");
1049 if (Info->PrimaryVirtualBaseInfo->Derived == Info) {
1050 // Add the offset.
1051 assert(!VBases.count(Info->PrimaryVirtualBaseInfo->Class) &&
1052 "primary vbase offset already exists!");
1053 VBases.insert(std::make_pair(Info->PrimaryVirtualBaseInfo->Class,
Anders Carlssona2311512010-10-31 22:20:42 +00001054 Offset));
Anders Carlsson97913572010-04-15 16:12:58 +00001055
Anders Carlsson3cd09cc2010-05-29 19:44:50 +00001056 // Traverse the primary virtual base.
1057 AddPrimaryVirtualBaseOffsets(Info->PrimaryVirtualBaseInfo, Offset);
1058 }
Anders Carlsson97913572010-04-15 16:12:58 +00001059 }
1060
Anders Carlsson3cd09cc2010-05-29 19:44:50 +00001061 // Now go through all direct non-virtual bases.
1062 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Info->Class);
1063 for (unsigned I = 0, E = Info->Bases.size(); I != E; ++I) {
1064 const BaseSubobjectInfo *Base = Info->Bases[I];
1065 if (Base->IsVirtual)
Anders Carlsson97913572010-04-15 16:12:58 +00001066 continue;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001067
Anders Carlssona2311512010-10-31 22:20:42 +00001068 CharUnits BaseOffset =
Anders Carlssona14f5972010-10-31 23:22:37 +00001069 Offset + toCharUnits(Layout.getBaseClassOffsetInBits(Base->Class));
Anders Carlsson3cd09cc2010-05-29 19:44:50 +00001070 AddPrimaryVirtualBaseOffsets(Base, BaseOffset);
Anders Carlsson97913572010-04-15 16:12:58 +00001071 }
1072}
1073
1074void
Anders Carlsson7d0918a2010-05-26 05:58:59 +00001075RecordLayoutBuilder::LayoutVirtualBases(const CXXRecordDecl *RD,
Anders Carlsson97913572010-04-15 16:12:58 +00001076 const CXXRecordDecl *MostDerivedClass) {
Anders Carlsson88f42962010-03-11 04:33:54 +00001077 const CXXRecordDecl *PrimaryBase;
Anders Carlssonbdda6c12010-04-10 18:42:27 +00001078 bool PrimaryBaseIsVirtual;
Anders Carlsson37147ea2010-03-11 05:42:17 +00001079
Anders Carlssonbdda6c12010-04-10 18:42:27 +00001080 if (MostDerivedClass == RD) {
Anders Carlsson28fdd0a2010-05-26 05:20:58 +00001081 PrimaryBase = this->PrimaryBase;
1082 PrimaryBaseIsVirtual = this->PrimaryBaseIsVirtual;
Anders Carlssonbdda6c12010-04-10 18:42:27 +00001083 } else {
Anders Carlsson0f0e9b02010-04-16 15:07:51 +00001084 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlsson88f42962010-03-11 04:33:54 +00001085 PrimaryBase = Layout.getPrimaryBase();
Anders Carlssonbdda6c12010-04-10 18:42:27 +00001086 PrimaryBaseIsVirtual = Layout.getPrimaryBaseWasVirtual();
1087 }
1088
Anders Carlsson622e2472010-03-11 04:24:02 +00001089 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1090 E = RD->bases_end(); I != E; ++I) {
1091 assert(!I->getType()->isDependentType() &&
Sebastian Redl9994a342009-10-25 17:03:50 +00001092 "Cannot layout class with dependent bases.");
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001093
Anders Carlsson276b4912010-05-29 17:48:36 +00001094 const CXXRecordDecl *BaseDecl =
Anders Carlsson622e2472010-03-11 04:24:02 +00001095 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1096
1097 if (I->isVirtual()) {
Anders Carlsson276b4912010-05-29 17:48:36 +00001098 if (PrimaryBase != BaseDecl || !PrimaryBaseIsVirtual) {
1099 bool IndirectPrimaryBase = IndirectPrimaryBases.count(BaseDecl);
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001100
Anders Carlssonbdda6c12010-04-10 18:42:27 +00001101 // Only lay out the virtual base if it's not an indirect primary base.
1102 if (!IndirectPrimaryBase) {
1103 // Only visit virtual bases once.
Anders Carlsson276b4912010-05-29 17:48:36 +00001104 if (!VisitedVirtualBases.insert(BaseDecl))
Anders Carlssonbdda6c12010-04-10 18:42:27 +00001105 continue;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001106
Anders Carlsson276b4912010-05-29 17:48:36 +00001107 const BaseSubobjectInfo *BaseInfo = VirtualBaseInfo.lookup(BaseDecl);
1108 assert(BaseInfo && "Did not find virtual base info!");
1109 LayoutVirtualBase(BaseInfo);
Anders Carlsson147b5dd2010-03-11 04:10:39 +00001110 }
Mike Stump968db332009-11-05 04:02:15 +00001111 }
Mike Stump4ef98092009-08-13 22:53:07 +00001112 }
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001113
Anders Carlsson276b4912010-05-29 17:48:36 +00001114 if (!BaseDecl->getNumVBases()) {
Anders Carlsson622e2472010-03-11 04:24:02 +00001115 // This base isn't interesting since it doesn't have any virtual bases.
1116 continue;
Mike Stumpfe3010d2009-08-16 19:04:13 +00001117 }
Anders Carlsson622e2472010-03-11 04:24:02 +00001118
Anders Carlsson276b4912010-05-29 17:48:36 +00001119 LayoutVirtualBases(BaseDecl, MostDerivedClass);
Mike Stumpeb19fa92009-08-06 13:41:24 +00001120 }
1121}
1122
Anders Carlsson276b4912010-05-29 17:48:36 +00001123void RecordLayoutBuilder::LayoutVirtualBase(const BaseSubobjectInfo *Base) {
Anders Carlsson3cd09cc2010-05-29 19:44:50 +00001124 assert(!Base->Derived && "Trying to lay out a primary virtual base!");
1125
Anders Carlssone3bdbee2010-03-10 22:26:24 +00001126 // Layout the base.
Anders Carlssona2311512010-10-31 22:20:42 +00001127 CharUnits Offset = LayoutBase(Base);
Anders Carlssone3bdbee2010-03-10 22:26:24 +00001128
1129 // Add its base class offset.
Anders Carlsson276b4912010-05-29 17:48:36 +00001130 assert(!VBases.count(Base->Class) && "vbase offset already exists!");
Anders Carlssona2311512010-10-31 22:20:42 +00001131 VBases.insert(std::make_pair(Base->Class, Offset));
Anders Carlsson3cd09cc2010-05-29 19:44:50 +00001132
1133 AddPrimaryVirtualBaseOffsets(Base, Offset);
Anders Carlssone239b9d2010-03-10 22:21:28 +00001134}
1135
Anders Carlssona2311512010-10-31 22:20:42 +00001136CharUnits RecordLayoutBuilder::LayoutBase(const BaseSubobjectInfo *Base) {
Anders Carlssonb1d880b2010-05-29 20:47:33 +00001137 const ASTRecordLayout &Layout = Context.getASTRecordLayout(Base->Class);
Anders Carlssone239b9d2010-03-10 22:21:28 +00001138
1139 // If we have an empty base class, try to place it at offset 0.
Anders Carlssonb1d880b2010-05-29 20:47:33 +00001140 if (Base->Class->isEmpty() &&
Anders Carlssona3d43802010-10-31 22:13:23 +00001141 EmptySubobjects->CanPlaceBaseAtOffset(Base, CharUnits::Zero())) {
Anders Carlssonc3fddeb2010-05-08 22:35:05 +00001142 Size = std::max(Size, Layout.getSize());
Anders Carlssone239b9d2010-03-10 22:21:28 +00001143
Anders Carlssona2311512010-10-31 22:20:42 +00001144 return CharUnits::Zero();
Anders Carlssone239b9d2010-03-10 22:21:28 +00001145 }
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001146
Anders Carlssonc3fddeb2010-05-08 22:35:05 +00001147 unsigned BaseAlign = Layout.getNonVirtualAlign();
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001148
Anders Carlssone239b9d2010-03-10 22:21:28 +00001149 // Round up the current record size to the base's alignment boundary.
1150 uint64_t Offset = llvm::RoundUpToAlignment(DataSize, BaseAlign);
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001151
Anders Carlssone239b9d2010-03-10 22:21:28 +00001152 // Try to place the base.
Anders Carlssona3d43802010-10-31 22:13:23 +00001153 while (!EmptySubobjects->CanPlaceBaseAtOffset(Base, toCharUnits(Offset)))
Anders Carlssone239b9d2010-03-10 22:21:28 +00001154 Offset += BaseAlign;
Anders Carlssone239b9d2010-03-10 22:21:28 +00001155
Anders Carlssonb1d880b2010-05-29 20:47:33 +00001156 if (!Base->Class->isEmpty()) {
Anders Carlssone239b9d2010-03-10 22:21:28 +00001157 // Update the data size.
Anders Carlssonc3fddeb2010-05-08 22:35:05 +00001158 DataSize = Offset + Layout.getNonVirtualSize();
Anders Carlssone239b9d2010-03-10 22:21:28 +00001159
1160 Size = std::max(Size, DataSize);
1161 } else
Anders Carlssonc3fddeb2010-05-08 22:35:05 +00001162 Size = std::max(Size, Offset + Layout.getSize());
Anders Carlssone239b9d2010-03-10 22:21:28 +00001163
1164 // Remember max struct/class alignment.
1165 UpdateAlignment(BaseAlign);
1166
Anders Carlssona2311512010-10-31 22:20:42 +00001167 return toCharUnits(Offset);
Anders Carlssone239b9d2010-03-10 22:21:28 +00001168}
1169
Daniel Dunbarc6082fe2010-05-27 05:45:51 +00001170void RecordLayoutBuilder::InitializeLayout(const Decl *D) {
1171 if (const RecordDecl *RD = dyn_cast<RecordDecl>(D))
1172 IsUnion = RD->isUnion();
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001173
Anders Carlssona5dd7222009-08-08 19:38:24 +00001174 Packed = D->hasAttr<PackedAttr>();
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001175
Daniel Dunbarc6082fe2010-05-27 05:45:51 +00001176 // mac68k alignment supersedes maximum field alignment and attribute aligned,
1177 // and forces all structures to have 2-byte alignment. The IBM docs on it
1178 // allude to additional (more complicated) semantics, especially with regard
1179 // to bit-fields, but gcc appears not to follow that.
1180 if (D->hasAttr<AlignMac68kAttr>()) {
1181 IsMac68kAlign = true;
1182 MaxFieldAlignment = 2 * 8;
1183 Alignment = 2 * 8;
1184 } else {
1185 if (const MaxFieldAlignmentAttr *MFAA = D->getAttr<MaxFieldAlignmentAttr>())
1186 MaxFieldAlignment = MFAA->getAlignment();
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001187
Sean Huntcf807c42010-08-18 23:23:40 +00001188 if (unsigned MaxAlign = D->getMaxAlignment())
1189 UpdateAlignment(MaxAlign);
Daniel Dunbarc6082fe2010-05-27 05:45:51 +00001190 }
Anders Carlssonc6cab682010-05-26 15:10:00 +00001191}
Anders Carlsson74cbe222009-07-19 00:18:47 +00001192
Anders Carlssonc6cab682010-05-26 15:10:00 +00001193void RecordLayoutBuilder::Layout(const RecordDecl *D) {
1194 InitializeLayout(D);
Anders Carlssona2df41c2009-07-18 21:48:39 +00001195 LayoutFields(D);
Mike Stump1eb44332009-09-09 15:08:12 +00001196
Anders Carlssonbda4c102009-07-18 20:20:21 +00001197 // Finally, round the size of the total struct up to the alignment of the
1198 // struct itself.
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001199 FinishLayout(D);
Anders Carlssonc6cab682010-05-26 15:10:00 +00001200}
1201
1202void RecordLayoutBuilder::Layout(const CXXRecordDecl *RD) {
1203 InitializeLayout(RD);
1204
Anders Carlssonc6cab682010-05-26 15:10:00 +00001205 // Lay out the vtable and the non-virtual bases.
1206 LayoutNonVirtualBases(RD);
1207
1208 LayoutFields(RD);
1209
1210 NonVirtualSize = Size;
1211 NonVirtualAlignment = Alignment;
1212
1213 // Lay out the virtual bases and add the primary virtual base offsets.
1214 LayoutVirtualBases(RD, RD);
1215
1216 VisitedVirtualBases.clear();
Anders Carlssonc6cab682010-05-26 15:10:00 +00001217
1218 // Finally, round the size of the total struct up to the alignment of the
1219 // struct itself.
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001220 FinishLayout(RD);
Anders Carlssonc6cab682010-05-26 15:10:00 +00001221
Anders Carlssona1e87162010-04-10 21:24:48 +00001222#ifndef NDEBUG
Anders Carlssonc6cab682010-05-26 15:10:00 +00001223 // Check that we have base offsets for all bases.
1224 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1225 E = RD->bases_end(); I != E; ++I) {
1226 if (I->isVirtual())
1227 continue;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001228
Anders Carlssonc6cab682010-05-26 15:10:00 +00001229 const CXXRecordDecl *BaseDecl =
1230 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1231
1232 assert(Bases.count(BaseDecl) && "Did not find base offset!");
1233 }
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001234
Anders Carlssonc6cab682010-05-26 15:10:00 +00001235 // And all virtual bases.
1236 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
1237 E = RD->vbases_end(); I != E; ++I) {
1238 const CXXRecordDecl *BaseDecl =
1239 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001240
Anders Carlssonc6cab682010-05-26 15:10:00 +00001241 assert(VBases.count(BaseDecl) && "Did not find base offset!");
Anders Carlssona1e87162010-04-10 21:24:48 +00001242 }
1243#endif
Anders Carlssonbda4c102009-07-18 20:20:21 +00001244}
1245
Anders Carlsson7d0918a2010-05-26 05:58:59 +00001246void RecordLayoutBuilder::Layout(const ObjCInterfaceDecl *D) {
Anders Carlsson93fab9d2009-07-18 20:50:59 +00001247 if (ObjCInterfaceDecl *SD = D->getSuperClass()) {
Anders Carlsson0f0e9b02010-04-16 15:07:51 +00001248 const ASTRecordLayout &SL = Context.getASTObjCInterfaceLayout(SD);
Anders Carlsson93fab9d2009-07-18 20:50:59 +00001249
1250 UpdateAlignment(SL.getAlignment());
Mike Stump1eb44332009-09-09 15:08:12 +00001251
Anders Carlsson93fab9d2009-07-18 20:50:59 +00001252 // We start laying out ivars not at the end of the superclass
1253 // structure, but at the next byte following the last field.
Anders Carlsson243a6852009-07-18 21:26:44 +00001254 Size = llvm::RoundUpToAlignment(SL.getDataSize(), 8);
Anders Carlssona2239352009-09-26 01:34:51 +00001255 DataSize = Size;
Anders Carlsson93fab9d2009-07-18 20:50:59 +00001256 }
Mike Stump1eb44332009-09-09 15:08:12 +00001257
Daniel Dunbarc6082fe2010-05-27 05:45:51 +00001258 InitializeLayout(D);
Daniel Dunbar8a2c92c2010-05-27 01:12:46 +00001259
Anders Carlsson93fab9d2009-07-18 20:50:59 +00001260 // Layout each ivar sequentially.
1261 llvm::SmallVector<ObjCIvarDecl*, 16> Ivars;
Anders Carlsson0f0e9b02010-04-16 15:07:51 +00001262 Context.ShallowCollectObjCIvars(D, Ivars);
Anders Carlsson93fab9d2009-07-18 20:50:59 +00001263 for (unsigned i = 0, e = Ivars.size(); i != e; ++i)
1264 LayoutField(Ivars[i]);
Mike Stump1eb44332009-09-09 15:08:12 +00001265
Anders Carlsson93fab9d2009-07-18 20:50:59 +00001266 // Finally, round the size of the total struct up to the alignment of the
1267 // struct itself.
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001268 FinishLayout(D);
Anders Carlsson93fab9d2009-07-18 20:50:59 +00001269}
1270
Anders Carlsson7d0918a2010-05-26 05:58:59 +00001271void RecordLayoutBuilder::LayoutFields(const RecordDecl *D) {
Anders Carlssona2df41c2009-07-18 21:48:39 +00001272 // Layout each field, for now, just sequentially, respecting alignment. In
1273 // the future, this will need to be tweakable by targets.
Mike Stump1eb44332009-09-09 15:08:12 +00001274 for (RecordDecl::field_iterator Field = D->field_begin(),
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001275 FieldEnd = D->field_end(); Field != FieldEnd; ++Field)
Anders Carlssona2df41c2009-07-18 21:48:39 +00001276 LayoutField(*Field);
1277}
1278
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001279void RecordLayoutBuilder::LayoutWideBitField(uint64_t FieldSize,
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001280 uint64_t TypeSize,
1281 bool FieldPacked,
1282 const FieldDecl *D) {
Anders Carlsson4cf6f5f2010-04-16 15:57:11 +00001283 assert(Context.getLangOptions().CPlusPlus &&
1284 "Can only have wide bit-fields in C++!");
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001285
Anders Carlsson4cf6f5f2010-04-16 15:57:11 +00001286 // Itanium C++ ABI 2.4:
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001287 // If sizeof(T)*8 < n, let T' be the largest integral POD type with
Anders Carlsson4cf6f5f2010-04-16 15:57:11 +00001288 // sizeof(T')*8 <= n.
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001289
Anders Carlsson4cf6f5f2010-04-16 15:57:11 +00001290 QualType IntegralPODTypes[] = {
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001291 Context.UnsignedCharTy, Context.UnsignedShortTy, Context.UnsignedIntTy,
Anders Carlsson4cf6f5f2010-04-16 15:57:11 +00001292 Context.UnsignedLongTy, Context.UnsignedLongLongTy
1293 };
1294
Anders Carlsson4cf6f5f2010-04-16 15:57:11 +00001295 QualType Type;
1296 for (unsigned I = 0, E = llvm::array_lengthof(IntegralPODTypes);
1297 I != E; ++I) {
1298 uint64_t Size = Context.getTypeSize(IntegralPODTypes[I]);
Anders Carlsson4cf6f5f2010-04-16 15:57:11 +00001299
1300 if (Size > FieldSize)
1301 break;
1302
1303 Type = IntegralPODTypes[I];
1304 }
1305 assert(!Type.isNull() && "Did not find a type!");
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001306
Anders Carlsson4cf6f5f2010-04-16 15:57:11 +00001307 unsigned TypeAlign = Context.getTypeAlign(Type);
1308
1309 // We're not going to use any of the unfilled bits in the last byte.
1310 UnfilledBitsInLastByte = 0;
1311
Anders Carlssonde9f1532010-04-17 20:21:41 +00001312 uint64_t FieldOffset;
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001313 uint64_t UnpaddedFieldOffset = DataSize - UnfilledBitsInLastByte;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001314
Anders Carlsson4cf6f5f2010-04-16 15:57:11 +00001315 if (IsUnion) {
1316 DataSize = std::max(DataSize, FieldSize);
Anders Carlssonde9f1532010-04-17 20:21:41 +00001317 FieldOffset = 0;
Anders Carlsson4cf6f5f2010-04-16 15:57:11 +00001318 } else {
Anders Carlssonde9f1532010-04-17 20:21:41 +00001319 // The bitfield is allocated starting at the next offset aligned appropriately
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001320 // for T', with length n bits.
Anders Carlssonde9f1532010-04-17 20:21:41 +00001321 FieldOffset = llvm::RoundUpToAlignment(DataSize, TypeAlign);
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001322
Anders Carlsson4cf6f5f2010-04-16 15:57:11 +00001323 uint64_t NewSizeInBits = FieldOffset + FieldSize;
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001324
Anders Carlsson4cf6f5f2010-04-16 15:57:11 +00001325 DataSize = llvm::RoundUpToAlignment(NewSizeInBits, 8);
1326 UnfilledBitsInLastByte = DataSize - NewSizeInBits;
1327 }
1328
1329 // Place this field at the current location.
1330 FieldOffsets.push_back(FieldOffset);
1331
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001332 CheckFieldPadding(FieldOffset, UnpaddedFieldOffset, FieldOffset,
1333 TypeAlign, FieldPacked, D);
1334
Anders Carlsson4cf6f5f2010-04-16 15:57:11 +00001335 // Update the size.
1336 Size = std::max(Size, DataSize);
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001337
Anders Carlsson4cf6f5f2010-04-16 15:57:11 +00001338 // Remember max struct/class alignment.
1339 UpdateAlignment(TypeAlign);
1340}
1341
Anders Carlsson7d0918a2010-05-26 05:58:59 +00001342void RecordLayoutBuilder::LayoutBitField(const FieldDecl *D) {
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001343 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001344 uint64_t UnpaddedFieldOffset = DataSize - UnfilledBitsInLastByte;
1345 uint64_t FieldOffset = IsUnion ? 0 : UnpaddedFieldOffset;
Anders Carlsson0f0e9b02010-04-16 15:07:51 +00001346 uint64_t FieldSize = D->getBitWidth()->EvaluateAsInt(Context).getZExtValue();
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001347
Anders Carlsson0f0e9b02010-04-16 15:07:51 +00001348 std::pair<uint64_t, unsigned> FieldInfo = Context.getTypeInfo(D->getType());
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001349 uint64_t TypeSize = FieldInfo.first;
1350 unsigned FieldAlign = FieldInfo.second;
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001351
Anders Carlsson4cf6f5f2010-04-16 15:57:11 +00001352 if (FieldSize > TypeSize) {
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001353 LayoutWideBitField(FieldSize, TypeSize, FieldPacked, D);
Anders Carlsson4cf6f5f2010-04-16 15:57:11 +00001354 return;
1355 }
1356
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001357 // The align if the field is not packed. This is to check if the attribute
1358 // was unnecessary (-Wpacked).
1359 unsigned UnpackedFieldAlign = FieldAlign;
1360 uint64_t UnpackedFieldOffset = FieldOffset;
1361 if (!Context.Target.useBitFieldTypeAlignment())
1362 UnpackedFieldAlign = 1;
1363
Anders Carlsson0f0e9b02010-04-16 15:07:51 +00001364 if (FieldPacked || !Context.Target.useBitFieldTypeAlignment())
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001365 FieldAlign = 1;
Sean Huntcf807c42010-08-18 23:23:40 +00001366 FieldAlign = std::max(FieldAlign, D->getMaxAlignment());
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001367 UnpackedFieldAlign = std::max(UnpackedFieldAlign, D->getMaxAlignment());
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001368
1369 // The maximum field alignment overrides the aligned attribute.
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001370 if (MaxFieldAlignment) {
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001371 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001372 UnpackedFieldAlign = std::min(UnpackedFieldAlign, MaxFieldAlignment);
1373 }
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001374
Daniel Dunbarb6a16932010-04-15 06:18:39 +00001375 // Check if we need to add padding to give the field the correct alignment.
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001376 if (FieldSize == 0 || (FieldOffset & (FieldAlign-1)) + FieldSize > TypeSize)
Daniel Dunbar84b03162010-06-29 18:34:35 +00001377 FieldOffset = llvm::RoundUpToAlignment(FieldOffset, FieldAlign);
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001378
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001379 if (FieldSize == 0 ||
1380 (UnpackedFieldOffset & (UnpackedFieldAlign-1)) + FieldSize > TypeSize)
1381 UnpackedFieldOffset = llvm::RoundUpToAlignment(UnpackedFieldOffset,
1382 UnpackedFieldAlign);
1383
Daniel Dunbarb6a16932010-04-15 06:18:39 +00001384 // Padding members don't affect overall alignment.
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001385 if (!D->getIdentifier())
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001386 FieldAlign = UnpackedFieldAlign = 1;
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001387
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001388 // Place this field at the current location.
1389 FieldOffsets.push_back(FieldOffset);
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001390
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001391 CheckFieldPadding(FieldOffset, UnpaddedFieldOffset, UnpackedFieldOffset,
1392 UnpackedFieldAlign, FieldPacked, D);
1393
Anders Carlssone4fc0d92009-11-22 19:13:51 +00001394 // Update DataSize to include the last byte containing (part of) the bitfield.
1395 if (IsUnion) {
1396 // FIXME: I think FieldSize should be TypeSize here.
1397 DataSize = std::max(DataSize, FieldSize);
1398 } else {
1399 uint64_t NewSizeInBits = FieldOffset + FieldSize;
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001400
Anders Carlssone4fc0d92009-11-22 19:13:51 +00001401 DataSize = llvm::RoundUpToAlignment(NewSizeInBits, 8);
1402 UnfilledBitsInLastByte = DataSize - NewSizeInBits;
1403 }
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001404
Anders Carlssone4fc0d92009-11-22 19:13:51 +00001405 // Update the size.
1406 Size = std::max(Size, DataSize);
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001407
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001408 // Remember max struct/class alignment.
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001409 UpdateAlignment(FieldAlign, UnpackedFieldAlign);
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001410}
1411
Anders Carlsson7d0918a2010-05-26 05:58:59 +00001412void RecordLayoutBuilder::LayoutField(const FieldDecl *D) {
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001413 if (D->isBitField()) {
1414 LayoutBitField(D);
1415 return;
1416 }
1417
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001418 uint64_t UnpaddedFieldOffset = DataSize - UnfilledBitsInLastByte;
1419
Anders Carlssone4fc0d92009-11-22 19:13:51 +00001420 // Reset the unfilled bits.
1421 UnfilledBitsInLastByte = 0;
1422
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001423 bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
Anders Carlssona2239352009-09-26 01:34:51 +00001424 uint64_t FieldOffset = IsUnion ? 0 : DataSize;
Anders Carlssonbda4c102009-07-18 20:20:21 +00001425 uint64_t FieldSize;
1426 unsigned FieldAlign;
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001427
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001428 if (D->getType()->isIncompleteArrayType()) {
1429 // This is a flexible array member; we can't directly
1430 // query getTypeInfo about these, so we figure it out here.
1431 // Flexible array members don't have any size, but they
1432 // have to be aligned appropriately for their element type.
1433 FieldSize = 0;
Anders Carlsson0f0e9b02010-04-16 15:07:51 +00001434 const ArrayType* ATy = Context.getAsArrayType(D->getType());
1435 FieldAlign = Context.getTypeAlign(ATy->getElementType());
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001436 } else if (const ReferenceType *RT = D->getType()->getAs<ReferenceType>()) {
1437 unsigned AS = RT->getPointeeType().getAddressSpace();
Anders Carlsson0f0e9b02010-04-16 15:07:51 +00001438 FieldSize = Context.Target.getPointerWidth(AS);
1439 FieldAlign = Context.Target.getPointerAlign(AS);
Anders Carlssonbda4c102009-07-18 20:20:21 +00001440 } else {
Anders Carlsson0f0e9b02010-04-16 15:07:51 +00001441 std::pair<uint64_t, unsigned> FieldInfo = Context.getTypeInfo(D->getType());
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001442 FieldSize = FieldInfo.first;
1443 FieldAlign = FieldInfo.second;
Anders Carlssonbda4c102009-07-18 20:20:21 +00001444 }
Mike Stump1eb44332009-09-09 15:08:12 +00001445
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001446 // The align if the field is not packed. This is to check if the attribute
1447 // was unnecessary (-Wpacked).
1448 unsigned UnpackedFieldAlign = FieldAlign;
1449 uint64_t UnpackedFieldOffset = FieldOffset;
1450
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001451 if (FieldPacked)
1452 FieldAlign = 8;
Sean Huntcf807c42010-08-18 23:23:40 +00001453 FieldAlign = std::max(FieldAlign, D->getMaxAlignment());
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001454 UnpackedFieldAlign = std::max(UnpackedFieldAlign, D->getMaxAlignment());
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001455
1456 // The maximum field alignment overrides the aligned attribute.
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001457 if (MaxFieldAlignment) {
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001458 FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001459 UnpackedFieldAlign = std::min(UnpackedFieldAlign, MaxFieldAlignment);
1460 }
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001461
1462 // Round up the current record size to the field's alignment boundary.
1463 FieldOffset = llvm::RoundUpToAlignment(FieldOffset, FieldAlign);
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001464 UnpackedFieldOffset = llvm::RoundUpToAlignment(UnpackedFieldOffset,
1465 UnpackedFieldAlign);
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001466
Anders Carlsson83a45e72010-05-30 06:52:33 +00001467 if (!IsUnion && EmptySubobjects) {
1468 // Check if we can place the field at this offset.
Anders Carlssona3d43802010-10-31 22:13:23 +00001469 while (!EmptySubobjects->CanPlaceFieldAtOffset(D,
1470 toCharUnits(FieldOffset))) {
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001471 // We couldn't place the field at the offset. Try again at a new offset.
1472 FieldOffset += FieldAlign;
1473 }
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001474 }
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001475
Anders Carlssonbda4c102009-07-18 20:20:21 +00001476 // Place this field at the current location.
1477 FieldOffsets.push_back(FieldOffset);
Mike Stump1eb44332009-09-09 15:08:12 +00001478
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001479 CheckFieldPadding(FieldOffset, UnpaddedFieldOffset, UnpackedFieldOffset,
1480 UnpackedFieldAlign, FieldPacked, D);
1481
Anders Carlssonbda4c102009-07-18 20:20:21 +00001482 // Reserve space for this field.
1483 if (IsUnion)
1484 Size = std::max(Size, FieldSize);
1485 else
1486 Size = FieldOffset + FieldSize;
Mike Stump1eb44332009-09-09 15:08:12 +00001487
Anders Carlssona2239352009-09-26 01:34:51 +00001488 // Update the data size.
1489 DataSize = Size;
Mike Stump1eb44332009-09-09 15:08:12 +00001490
Anders Carlssonbda4c102009-07-18 20:20:21 +00001491 // Remember max struct/class alignment.
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001492 UpdateAlignment(FieldAlign, UnpackedFieldAlign);
Anders Carlssonbda4c102009-07-18 20:20:21 +00001493}
1494
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001495void RecordLayoutBuilder::FinishLayout(const NamedDecl *D) {
Anders Carlssonbda4c102009-07-18 20:20:21 +00001496 // In C++, records cannot be of size 0.
Anders Carlsson0f0e9b02010-04-16 15:07:51 +00001497 if (Context.getLangOptions().CPlusPlus && Size == 0)
Anders Carlssonbda4c102009-07-18 20:20:21 +00001498 Size = 8;
1499 // Finally, round the size of the record up to the alignment of the
1500 // record itself.
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001501 uint64_t UnpaddedSize = Size - UnfilledBitsInLastByte;
1502 uint64_t UnpackedSize = llvm::RoundUpToAlignment(Size, UnpackedAlignment);
Anders Carlsson42dbcc42009-11-22 17:37:31 +00001503 Size = llvm::RoundUpToAlignment(Size, Alignment);
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001504
1505 unsigned CharBitNum = Context.Target.getCharWidth();
1506 if (const RecordDecl *RD = dyn_cast<RecordDecl>(D)) {
1507 // Warn if padding was introduced to the struct/class/union.
1508 if (Size > UnpaddedSize) {
1509 unsigned PadSize = Size - UnpaddedSize;
1510 bool InBits = true;
1511 if (PadSize % CharBitNum == 0) {
1512 PadSize = PadSize / CharBitNum;
1513 InBits = false;
1514 }
1515 Diag(RD->getLocation(), diag::warn_padded_struct_size)
1516 << Context.getTypeDeclType(RD)
1517 << PadSize
1518 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1); // plural or not
1519 }
1520
1521 // Warn if we packed it unnecessarily. If the alignment is 1 byte don't
1522 // bother since there won't be alignment issues.
1523 if (Packed && UnpackedAlignment > CharBitNum && Size == UnpackedSize)
1524 Diag(D->getLocation(), diag::warn_unnecessary_packed)
1525 << Context.getTypeDeclType(RD);
1526 }
Anders Carlssonbda4c102009-07-18 20:20:21 +00001527}
1528
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001529void RecordLayoutBuilder::UpdateAlignment(unsigned NewAlignment,
1530 unsigned UnpackedNewAlignment) {
Daniel Dunbarc6082fe2010-05-27 05:45:51 +00001531 // The alignment is not modified when using 'mac68k' alignment.
1532 if (IsMac68kAlign)
1533 return;
1534
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001535 if (NewAlignment > Alignment) {
1536 assert(llvm::isPowerOf2_32(NewAlignment && "Alignment not a power of 2"));
1537 Alignment = NewAlignment;
1538 }
1539
1540 if (UnpackedNewAlignment > UnpackedAlignment) {
1541 assert(llvm::isPowerOf2_32(UnpackedNewAlignment &&
1542 "Alignment not a power of 2"));
1543 UnpackedAlignment = UnpackedNewAlignment;
1544 }
1545}
1546
1547void RecordLayoutBuilder::CheckFieldPadding(uint64_t Offset,
1548 uint64_t UnpaddedOffset,
1549 uint64_t UnpackedOffset,
1550 unsigned UnpackedAlign,
1551 bool isPacked,
1552 const FieldDecl *D) {
1553 // We let objc ivars without warning, objc interfaces generally are not used
1554 // for padding tricks.
1555 if (isa<ObjCIvarDecl>(D))
Anders Carlssonbda4c102009-07-18 20:20:21 +00001556 return;
Mike Stump1eb44332009-09-09 15:08:12 +00001557
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001558 unsigned CharBitNum = Context.Target.getCharWidth();
Mike Stump1eb44332009-09-09 15:08:12 +00001559
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001560 // Warn if padding was introduced to the struct/class.
1561 if (!IsUnion && Offset > UnpaddedOffset) {
1562 unsigned PadSize = Offset - UnpaddedOffset;
1563 bool InBits = true;
1564 if (PadSize % CharBitNum == 0) {
1565 PadSize = PadSize / CharBitNum;
1566 InBits = false;
1567 }
1568 if (D->getIdentifier())
1569 Diag(D->getLocation(), diag::warn_padded_struct_field)
1570 << (D->getParent()->isStruct() ? 0 : 1) // struct|class
1571 << Context.getTypeDeclType(D->getParent())
1572 << PadSize
1573 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1) // plural or not
1574 << D->getIdentifier();
1575 else
1576 Diag(D->getLocation(), diag::warn_padded_struct_anon_field)
1577 << (D->getParent()->isStruct() ? 0 : 1) // struct|class
1578 << Context.getTypeDeclType(D->getParent())
1579 << PadSize
1580 << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1); // plural or not
1581 }
1582
1583 // Warn if we packed it unnecessarily. If the alignment is 1 byte don't
1584 // bother since there won't be alignment issues.
1585 if (isPacked && UnpackedAlign > CharBitNum && Offset == UnpackedOffset)
1586 Diag(D->getLocation(), diag::warn_unnecessary_packed)
1587 << D->getIdentifier();
Anders Carlssonbda4c102009-07-18 20:20:21 +00001588}
Mike Stump1eb44332009-09-09 15:08:12 +00001589
Anders Carlssonf53df232009-12-07 04:35:11 +00001590const CXXMethodDecl *
Anders Carlsson7d0918a2010-05-26 05:58:59 +00001591RecordLayoutBuilder::ComputeKeyFunction(const CXXRecordDecl *RD) {
Daniel Dunbar8d8ab742010-04-19 20:44:53 +00001592 // If a class isn't polymorphic it doesn't have a key function.
Anders Carlssonf53df232009-12-07 04:35:11 +00001593 if (!RD->isPolymorphic())
Anders Carlsson1a5e0d72009-11-30 23:41:22 +00001594 return 0;
Eli Friedman61eab882009-12-08 03:56:49 +00001595
1596 // A class inside an anonymous namespace doesn't have a key function. (Or
1597 // at least, there's no point to assigning a key function to such a class;
1598 // this doesn't affect the ABI.)
1599 if (RD->isInAnonymousNamespace())
1600 return 0;
1601
Argyrios Kyrtzidis3bd5b6c2010-10-13 02:39:41 +00001602 // Template instantiations don't have key functions,see Itanium C++ ABI 5.2.6.
1603 // Same behavior as GCC.
1604 TemplateSpecializationKind TSK = RD->getTemplateSpecializationKind();
1605 if (TSK == TSK_ImplicitInstantiation ||
1606 TSK == TSK_ExplicitInstantiationDefinition)
1607 return 0;
1608
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001609 for (CXXRecordDecl::method_iterator I = RD->method_begin(),
1610 E = RD->method_end(); I != E; ++I) {
Anders Carlsson1a5e0d72009-11-30 23:41:22 +00001611 const CXXMethodDecl *MD = *I;
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001612
Anders Carlsson1a5e0d72009-11-30 23:41:22 +00001613 if (!MD->isVirtual())
1614 continue;
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001615
Anders Carlsson1a5e0d72009-11-30 23:41:22 +00001616 if (MD->isPure())
1617 continue;
Eli Friedman61eab882009-12-08 03:56:49 +00001618
Anders Carlsson5ec02ae2009-12-02 17:15:43 +00001619 // Ignore implicit member functions, they are always marked as inline, but
1620 // they don't have a body until they're defined.
1621 if (MD->isImplicit())
1622 continue;
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001623
Douglas Gregorbd6d6192010-01-05 19:06:31 +00001624 if (MD->isInlineSpecified())
1625 continue;
Eli Friedmand7d7f672009-12-06 20:50:05 +00001626
1627 if (MD->hasInlineBody())
Anders Carlsson1a5e0d72009-11-30 23:41:22 +00001628 continue;
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001629
Anders Carlsson1a5e0d72009-11-30 23:41:22 +00001630 // We found it.
1631 return MD;
1632 }
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001633
Anders Carlsson1a5e0d72009-11-30 23:41:22 +00001634 return 0;
1635}
1636
Argyrios Kyrtzidis78a916e2010-09-22 14:32:24 +00001637DiagnosticBuilder
1638RecordLayoutBuilder::Diag(SourceLocation Loc, unsigned DiagID) {
1639 return Context.getDiagnostics().Report(
1640 FullSourceLoc(Loc, Context.getSourceManager()), DiagID);
1641}
1642
Benjamin Kramercb9c0742010-10-22 16:33:16 +00001643namespace {
1644 // This class implements layout specific to the Microsoft ABI.
1645 class MSRecordLayoutBuilder : public RecordLayoutBuilder {
1646 public:
1647 MSRecordLayoutBuilder(ASTContext& Ctx, EmptySubobjectMap *EmptySubobjects) :
1648 RecordLayoutBuilder(Ctx, EmptySubobjects) {}
Charles Davisc9f8aec2010-08-19 00:55:19 +00001649
Benjamin Kramercb9c0742010-10-22 16:33:16 +00001650 virtual bool IsNearlyEmpty(const CXXRecordDecl *RD) const;
1651 virtual uint64_t GetVirtualPointersSize(const CXXRecordDecl *RD) const;
1652 };
1653}
Charles Davisc9f8aec2010-08-19 00:55:19 +00001654
1655bool MSRecordLayoutBuilder::IsNearlyEmpty(const CXXRecordDecl *RD) const {
1656 // FIXME: Audit the corners
1657 if (!RD->isDynamicClass())
1658 return false;
1659 const ASTRecordLayout &BaseInfo = Context.getASTRecordLayout(RD);
1660 // In the Microsoft ABI, classes can have one or two vtable pointers.
1661 if (BaseInfo.getNonVirtualSize() == Context.Target.getPointerWidth(0) ||
1662 BaseInfo.getNonVirtualSize() == Context.Target.getPointerWidth(0) * 2)
1663 return true;
1664 return false;
1665}
1666
1667uint64_t
1668MSRecordLayoutBuilder::GetVirtualPointersSize(const CXXRecordDecl *RD) const {
1669 // We should reserve space for two pointers if the class has both
1670 // virtual functions and virtual bases.
1671 if (RD->isPolymorphic() && RD->getNumVBases() > 0)
1672 return 2 * Context.Target.getPointerWidth(0);
1673 return Context.Target.getPointerWidth(0);
1674}
1675
Anders Carlsson1e641ce2010-05-26 04:56:53 +00001676/// getASTRecordLayout - Get or compute information about the layout of the
1677/// specified record (struct/union/class), which indicates its size and field
1678/// position information.
1679const ASTRecordLayout &ASTContext::getASTRecordLayout(const RecordDecl *D) {
1680 D = D->getDefinition();
1681 assert(D && "Cannot get layout of forward declarations!");
1682
1683 // Look up this layout, if already laid out, return what we have.
1684 // Note that we can't save a reference to the entry because this function
1685 // is recursive.
1686 const ASTRecordLayout *Entry = ASTRecordLayouts[D];
1687 if (Entry) return *Entry;
1688
Anders Carlsson2f64e372010-05-26 05:10:47 +00001689 const ASTRecordLayout *NewEntry;
1690
1691 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
Anders Carlsson261febd2010-05-27 00:07:01 +00001692 EmptySubobjectMap EmptySubobjects(*this, RD);
Anders Carlsson58b16b62010-05-27 05:41:06 +00001693
Charles Davisc9f8aec2010-08-19 00:55:19 +00001694 // When compiling for Microsoft, use the special MS builder.
Argyrios Kyrtzidiscfe17e52010-08-25 00:32:14 +00001695 llvm::OwningPtr<RecordLayoutBuilder> Builder;
Charles Davis20cf7172010-08-19 02:18:14 +00001696 switch (Target.getCXXABI()) {
1697 default:
Argyrios Kyrtzidiscfe17e52010-08-25 00:32:14 +00001698 Builder.reset(new RecordLayoutBuilder(*this, &EmptySubobjects));
Charles Davis20cf7172010-08-19 02:18:14 +00001699 break;
1700 case CXXABI_Microsoft:
Argyrios Kyrtzidiscfe17e52010-08-25 00:32:14 +00001701 Builder.reset(new MSRecordLayoutBuilder(*this, &EmptySubobjects));
Charles Davis20cf7172010-08-19 02:18:14 +00001702 }
Charles Davisc9f8aec2010-08-19 00:55:19 +00001703 Builder->Layout(RD);
Anders Carlsson2f64e372010-05-26 05:10:47 +00001704
1705 // FIXME: This is not always correct. See the part about bitfields at
1706 // http://www.codesourcery.com/public/cxx-abi/abi.html#POD for more info.
1707 // FIXME: IsPODForThePurposeOfLayout should be stored in the record layout.
1708 bool IsPODForThePurposeOfLayout = cast<CXXRecordDecl>(D)->isPOD();
1709
1710 // FIXME: This should be done in FinalizeLayout.
1711 uint64_t DataSize =
Charles Davisc9f8aec2010-08-19 00:55:19 +00001712 IsPODForThePurposeOfLayout ? Builder->Size : Builder->DataSize;
Anders Carlsson2f64e372010-05-26 05:10:47 +00001713 uint64_t NonVirtualSize =
Charles Davisc9f8aec2010-08-19 00:55:19 +00001714 IsPODForThePurposeOfLayout ? DataSize : Builder->NonVirtualSize;
Anders Carlsson2f64e372010-05-26 05:10:47 +00001715
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001716 NewEntry =
Charles Davisc9f8aec2010-08-19 00:55:19 +00001717 new (*this) ASTRecordLayout(*this, Builder->Size, Builder->Alignment,
1718 DataSize, Builder->FieldOffsets.data(),
1719 Builder->FieldOffsets.size(),
Anders Carlsson2f64e372010-05-26 05:10:47 +00001720 NonVirtualSize,
Charles Davisc9f8aec2010-08-19 00:55:19 +00001721 Builder->NonVirtualAlignment,
Anders Carlsson261febd2010-05-27 00:07:01 +00001722 EmptySubobjects.SizeOfLargestEmptySubobject,
Charles Davisc9f8aec2010-08-19 00:55:19 +00001723 Builder->PrimaryBase,
1724 Builder->PrimaryBaseIsVirtual,
1725 Builder->Bases, Builder->VBases);
Anders Carlsson2f64e372010-05-26 05:10:47 +00001726 } else {
Anders Carlsson261febd2010-05-27 00:07:01 +00001727 RecordLayoutBuilder Builder(*this, /*EmptySubobjects=*/0);
Anders Carlsson2f64e372010-05-26 05:10:47 +00001728 Builder.Layout(D);
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001729
Anders Carlsson2f64e372010-05-26 05:10:47 +00001730 NewEntry =
1731 new (*this) ASTRecordLayout(*this, Builder.Size, Builder.Alignment,
1732 Builder.Size,
1733 Builder.FieldOffsets.data(),
1734 Builder.FieldOffsets.size());
1735 }
1736
Anders Carlsson1e641ce2010-05-26 04:56:53 +00001737 ASTRecordLayouts[D] = NewEntry;
1738
1739 if (getLangOptions().DumpRecordLayouts) {
1740 llvm::errs() << "\n*** Dumping AST Record Layout\n";
1741 DumpRecordLayout(D, llvm::errs());
1742 }
1743
1744 return *NewEntry;
1745}
1746
1747const CXXMethodDecl *ASTContext::getKeyFunction(const CXXRecordDecl *RD) {
1748 RD = cast<CXXRecordDecl>(RD->getDefinition());
1749 assert(RD && "Cannot get key function for forward declarations!");
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001750
Anders Carlsson1e641ce2010-05-26 04:56:53 +00001751 const CXXMethodDecl *&Entry = KeyFunctions[RD];
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001752 if (!Entry)
Anders Carlsson7d0918a2010-05-26 05:58:59 +00001753 Entry = RecordLayoutBuilder::ComputeKeyFunction(RD);
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001754
Anders Carlsson1e641ce2010-05-26 04:56:53 +00001755 return Entry;
1756}
1757
1758/// getInterfaceLayoutImpl - Get or compute information about the
1759/// layout of the given interface.
1760///
1761/// \param Impl - If given, also include the layout of the interface's
1762/// implementation. This may differ by including synthesized ivars.
1763const ASTRecordLayout &
1764ASTContext::getObjCLayout(const ObjCInterfaceDecl *D,
1765 const ObjCImplementationDecl *Impl) {
1766 assert(!D->isForwardDecl() && "Invalid interface decl!");
1767
1768 // Look up this layout, if already laid out, return what we have.
1769 ObjCContainerDecl *Key =
1770 Impl ? (ObjCContainerDecl*) Impl : (ObjCContainerDecl*) D;
1771 if (const ASTRecordLayout *Entry = ObjCLayouts[Key])
1772 return *Entry;
1773
1774 // Add in synthesized ivar count if laying out an implementation.
1775 if (Impl) {
1776 unsigned SynthCount = CountNonClassIvars(D);
1777 // If there aren't any sythesized ivars then reuse the interface
1778 // entry. Note we can't cache this because we simply free all
1779 // entries later; however we shouldn't look up implementations
1780 // frequently.
1781 if (SynthCount == 0)
1782 return getObjCLayout(D, 0);
1783 }
1784
Anders Carlsson261febd2010-05-27 00:07:01 +00001785 RecordLayoutBuilder Builder(*this, /*EmptySubobjects=*/0);
Anders Carlsson36cdc612010-05-26 05:04:25 +00001786 Builder.Layout(D);
1787
Anders Carlsson1e641ce2010-05-26 04:56:53 +00001788 const ASTRecordLayout *NewEntry =
Anders Carlsson36cdc612010-05-26 05:04:25 +00001789 new (*this) ASTRecordLayout(*this, Builder.Size, Builder.Alignment,
1790 Builder.DataSize,
1791 Builder.FieldOffsets.data(),
1792 Builder.FieldOffsets.size());
Daniel Dunbar0aa7edb2010-05-27 02:25:46 +00001793
Anders Carlsson1e641ce2010-05-26 04:56:53 +00001794 ObjCLayouts[Key] = NewEntry;
1795
1796 return *NewEntry;
1797}
1798
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001799static void PrintOffset(llvm::raw_ostream &OS,
Anders Carlsson3069a0d2010-10-31 23:45:59 +00001800 CharUnits Offset, unsigned IndentLevel) {
1801 OS << llvm::format("%4d | ", Offset.getQuantity());
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001802 OS.indent(IndentLevel * 2);
1803}
1804
1805static void DumpCXXRecordLayout(llvm::raw_ostream &OS,
1806 const CXXRecordDecl *RD, ASTContext &C,
Anders Carlsson3069a0d2010-10-31 23:45:59 +00001807 CharUnits Offset,
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001808 unsigned IndentLevel,
1809 const char* Description,
1810 bool IncludeVirtualBases) {
Anders Carlsson3069a0d2010-10-31 23:45:59 +00001811 const ASTRecordLayout &Layout = C.getASTRecordLayout(RD);
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001812
1813 PrintOffset(OS, Offset, IndentLevel);
Dan Gohmancb421fa2010-04-19 16:39:44 +00001814 OS << C.getTypeDeclType(const_cast<CXXRecordDecl *>(RD)).getAsString();
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001815 if (Description)
1816 OS << ' ' << Description;
1817 if (RD->isEmpty())
1818 OS << " (empty)";
1819 OS << '\n';
1820
1821 IndentLevel++;
1822
Anders Carlsson3069a0d2010-10-31 23:45:59 +00001823 const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001824
1825 // Vtable pointer.
1826 if (RD->isDynamicClass() && !PrimaryBase) {
1827 PrintOffset(OS, Offset, IndentLevel);
Benjamin Kramer900fc632010-04-17 09:33:03 +00001828 OS << '(' << RD << " vtable pointer)\n";
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001829 }
1830 // Dump (non-virtual) bases
1831 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1832 E = RD->bases_end(); I != E; ++I) {
1833 assert(!I->getType()->isDependentType() &&
1834 "Cannot layout class with dependent bases.");
1835 if (I->isVirtual())
1836 continue;
1837
1838 const CXXRecordDecl *Base =
1839 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1840
Anders Carlsson3069a0d2010-10-31 23:45:59 +00001841 CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base);
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001842
1843 DumpCXXRecordLayout(OS, Base, C, BaseOffset, IndentLevel,
1844 Base == PrimaryBase ? "(primary base)" : "(base)",
1845 /*IncludeVirtualBases=*/false);
1846 }
1847
1848 // Dump fields.
1849 uint64_t FieldNo = 0;
1850 for (CXXRecordDecl::field_iterator I = RD->field_begin(),
1851 E = RD->field_end(); I != E; ++I, ++FieldNo) {
1852 const FieldDecl *Field = *I;
Anders Carlsson3069a0d2010-10-31 23:45:59 +00001853 CharUnits FieldOffset = Offset +
1854 CharUnits::fromQuantity(Layout.getFieldOffset(FieldNo) /
1855 C.getCharWidth());
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001856
1857 if (const RecordType *RT = Field->getType()->getAs<RecordType>()) {
1858 if (const CXXRecordDecl *D = dyn_cast<CXXRecordDecl>(RT->getDecl())) {
1859 DumpCXXRecordLayout(OS, D, C, FieldOffset, IndentLevel,
Daniel Dunbar4087f272010-08-17 22:39:59 +00001860 Field->getName().data(),
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001861 /*IncludeVirtualBases=*/true);
1862 continue;
1863 }
1864 }
1865
1866 PrintOffset(OS, FieldOffset, IndentLevel);
Benjamin Kramer900fc632010-04-17 09:33:03 +00001867 OS << Field->getType().getAsString() << ' ' << Field << '\n';
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001868 }
1869
1870 if (!IncludeVirtualBases)
1871 return;
1872
1873 // Dump virtual bases.
1874 for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
1875 E = RD->vbases_end(); I != E; ++I) {
1876 assert(I->isVirtual() && "Found non-virtual class!");
1877 const CXXRecordDecl *VBase =
1878 cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1879
Anders Carlsson3069a0d2010-10-31 23:45:59 +00001880 CharUnits VBaseOffset = Offset + Layout.getVBaseClassOffset(VBase);
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001881 DumpCXXRecordLayout(OS, VBase, C, VBaseOffset, IndentLevel,
1882 VBase == PrimaryBase ?
1883 "(primary virtual base)" : "(virtual base)",
1884 /*IncludeVirtualBases=*/false);
1885 }
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001886
Anders Carlsson3069a0d2010-10-31 23:45:59 +00001887 OS << " sizeof=" << Layout.getSize() / 8;
1888 OS << ", dsize=" << Layout.getDataSize() / 8;
1889 OS << ", align=" << Layout.getAlignment() / 8 << '\n';
1890 OS << " nvsize=" << Layout.getNonVirtualSize() / 8;
1891 OS << ", nvalign=" << Layout.getNonVirtualAlign() / 8 << '\n';
Daniel Dunbarbf9e48c2010-04-08 02:59:49 +00001892 OS << '\n';
1893}
Daniel Dunbar8d8ab742010-04-19 20:44:53 +00001894
1895void ASTContext::DumpRecordLayout(const RecordDecl *RD,
1896 llvm::raw_ostream &OS) {
1897 const ASTRecordLayout &Info = getASTRecordLayout(RD);
1898
1899 if (const CXXRecordDecl *CXXRD = dyn_cast<CXXRecordDecl>(RD))
Anders Carlsson3069a0d2010-10-31 23:45:59 +00001900 return DumpCXXRecordLayout(OS, CXXRD, *this, CharUnits(), 0, 0,
Daniel Dunbar8d8ab742010-04-19 20:44:53 +00001901 /*IncludeVirtualBases=*/true);
1902
1903 OS << "Type: " << getTypeDeclType(RD).getAsString() << "\n";
1904 OS << "Record: ";
1905 RD->dump();
1906 OS << "\nLayout: ";
1907 OS << "<ASTRecordLayout\n";
1908 OS << " Size:" << Info.getSize() << "\n";
1909 OS << " DataSize:" << Info.getDataSize() << "\n";
1910 OS << " Alignment:" << Info.getAlignment() << "\n";
1911 OS << " FieldOffsets: [";
1912 for (unsigned i = 0, e = Info.getFieldCount(); i != e; ++i) {
1913 if (i) OS << ", ";
1914 OS << Info.getFieldOffset(i);
1915 }
1916 OS << "]>\n";
1917}