1 //=== RecordLayoutBuilder.cpp - Helper class for building record layouts ---==//
2 //
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 
10 #include "clang/AST/RecordLayout.h"
11 #include "clang/AST/ASTContext.h"
12 #include "clang/AST/Attr.h"
13 #include "clang/AST/CXXInheritance.h"
14 #include "clang/AST/Decl.h"
15 #include "clang/AST/DeclCXX.h"
16 #include "clang/AST/DeclObjC.h"
17 #include "clang/AST/Expr.h"
18 #include "clang/Basic/TargetInfo.h"
19 #include "clang/Sema/SemaDiagnostic.h"
20 #include "llvm/ADT/SmallSet.h"
21 #include "llvm/Support/CrashRecoveryContext.h"
22 #include "llvm/Support/Format.h"
23 #include "llvm/Support/MathExtras.h"
24 
25 using namespace clang;
26 
27 namespace {
28 
29 /// BaseSubobjectInfo - Represents a single base subobject in a complete class.
30 /// For a class hierarchy like
31 ///
32 /// class A { };
33 /// class B : A { };
34 /// class C : A, B { };
35 ///
36 /// The BaseSubobjectInfo graph for C will have three BaseSubobjectInfo
37 /// instances, one for B and two for A.
38 ///
39 /// If a base is virtual, it will only have one BaseSubobjectInfo allocated.
40 struct BaseSubobjectInfo {
41   /// Class - The class for this base info.
42   const CXXRecordDecl *Class;
43 
44   /// IsVirtual - Whether the BaseInfo represents a virtual base or not.
45   bool IsVirtual;
46 
47   /// Bases - Information about the base subobjects.
48   SmallVector<BaseSubobjectInfo*, 4> Bases;
49 
50   /// PrimaryVirtualBaseInfo - Holds the base info for the primary virtual base
51   /// of this base info (if one exists).
52   BaseSubobjectInfo *PrimaryVirtualBaseInfo;
53 
54   // FIXME: Document.
55   const BaseSubobjectInfo *Derived;
56 };
57 
58 /// EmptySubobjectMap - Keeps track of which empty subobjects exist at different
59 /// offsets while laying out a C++ class.
60 class EmptySubobjectMap {
61   const ASTContext &Context;
62   uint64_t CharWidth;
63 
64   /// Class - The class whose empty entries we're keeping track of.
65   const CXXRecordDecl *Class;
66 
67   /// EmptyClassOffsets - A map from offsets to empty record decls.
68   typedef SmallVector<const CXXRecordDecl *, 1> ClassVectorTy;
69   typedef llvm::DenseMap<CharUnits, ClassVectorTy> EmptyClassOffsetsMapTy;
70   EmptyClassOffsetsMapTy EmptyClassOffsets;
71 
72   /// MaxEmptyClassOffset - The highest offset known to contain an empty
73   /// base subobject.
74   CharUnits MaxEmptyClassOffset;
75 
76   /// ComputeEmptySubobjectSizes - Compute the size of the largest base or
77   /// member subobject that is empty.
78   void ComputeEmptySubobjectSizes();
79 
80   void AddSubobjectAtOffset(const CXXRecordDecl *RD, CharUnits Offset);
81 
82   void UpdateEmptyBaseSubobjects(const BaseSubobjectInfo *Info,
83                                  CharUnits Offset, bool PlacingEmptyBase);
84 
85   void UpdateEmptyFieldSubobjects(const CXXRecordDecl *RD,
86                                   const CXXRecordDecl *Class,
87                                   CharUnits Offset);
88   void UpdateEmptyFieldSubobjects(const FieldDecl *FD, CharUnits Offset);
89 
90   /// AnyEmptySubobjectsBeyondOffset - Returns whether there are any empty
91   /// subobjects beyond the given offset.
92   bool AnyEmptySubobjectsBeyondOffset(CharUnits Offset) const {
93     return Offset <= MaxEmptyClassOffset;
94   }
95 
96   CharUnits
97   getFieldOffset(const ASTRecordLayout &Layout, unsigned FieldNo) const {
98     uint64_t FieldOffset = Layout.getFieldOffset(FieldNo);
99     assert(FieldOffset % CharWidth == 0 &&
100            "Field offset not at char boundary!");
101 
102     return Context.toCharUnitsFromBits(FieldOffset);
103   }
104 
105 protected:
106   bool CanPlaceSubobjectAtOffset(const CXXRecordDecl *RD,
107                                  CharUnits Offset) const;
108 
109   bool CanPlaceBaseSubobjectAtOffset(const BaseSubobjectInfo *Info,
110                                      CharUnits Offset);
111 
112   bool CanPlaceFieldSubobjectAtOffset(const CXXRecordDecl *RD,
113                                       const CXXRecordDecl *Class,
114                                       CharUnits Offset) const;
115   bool CanPlaceFieldSubobjectAtOffset(const FieldDecl *FD,
116                                       CharUnits Offset) const;
117 
118 public:
119   /// This holds the size of the largest empty subobject (either a base
120   /// or a member). Will be zero if the record being built doesn't contain
121   /// any empty classes.
122   CharUnits SizeOfLargestEmptySubobject;
123 
124   EmptySubobjectMap(const ASTContext &Context, const CXXRecordDecl *Class)
125   : Context(Context), CharWidth(Context.getCharWidth()), Class(Class) {
126       ComputeEmptySubobjectSizes();
127   }
128 
129   /// CanPlaceBaseAtOffset - Return whether the given base class can be placed
130   /// at the given offset.
131   /// Returns false if placing the record will result in two components
132   /// (direct or indirect) of the same type having the same offset.
133   bool CanPlaceBaseAtOffset(const BaseSubobjectInfo *Info,
134                             CharUnits Offset);
135 
136   /// CanPlaceFieldAtOffset - Return whether a field can be placed at the given
137   /// offset.
138   bool CanPlaceFieldAtOffset(const FieldDecl *FD, CharUnits Offset);
139 };
140 
141 void EmptySubobjectMap::ComputeEmptySubobjectSizes() {
142   // Check the bases.
143   for (CXXRecordDecl::base_class_const_iterator I = Class->bases_begin(),
144        E = Class->bases_end(); I != E; ++I) {
145     const CXXRecordDecl *BaseDecl =
146       cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
147 
148     CharUnits EmptySize;
149     const ASTRecordLayout &Layout = Context.getASTRecordLayout(BaseDecl);
150     if (BaseDecl->isEmpty()) {
151       // If the class decl is empty, get its size.
152       EmptySize = Layout.getSize();
153     } else {
154       // Otherwise, we get the largest empty subobject for the decl.
155       EmptySize = Layout.getSizeOfLargestEmptySubobject();
156     }
157 
158     if (EmptySize > SizeOfLargestEmptySubobject)
159       SizeOfLargestEmptySubobject = EmptySize;
160   }
161 
162   // Check the fields.
163   for (CXXRecordDecl::field_iterator I = Class->field_begin(),
164        E = Class->field_end(); I != E; ++I) {
165 
166     const RecordType *RT =
167       Context.getBaseElementType(I->getType())->getAs<RecordType>();
168 
169     // We only care about record types.
170     if (!RT)
171       continue;
172 
173     CharUnits EmptySize;
174     const CXXRecordDecl *MemberDecl = cast<CXXRecordDecl>(RT->getDecl());
175     const ASTRecordLayout &Layout = Context.getASTRecordLayout(MemberDecl);
176     if (MemberDecl->isEmpty()) {
177       // If the class decl is empty, get its size.
178       EmptySize = Layout.getSize();
179     } else {
180       // Otherwise, we get the largest empty subobject for the decl.
181       EmptySize = Layout.getSizeOfLargestEmptySubobject();
182     }
183 
184     if (EmptySize > SizeOfLargestEmptySubobject)
185       SizeOfLargestEmptySubobject = EmptySize;
186   }
187 }
188 
189 bool
190 EmptySubobjectMap::CanPlaceSubobjectAtOffset(const CXXRecordDecl *RD,
191                                              CharUnits Offset) const {
192   // We only need to check empty bases.
193   if (!RD->isEmpty())
194     return true;
195 
196   EmptyClassOffsetsMapTy::const_iterator I = EmptyClassOffsets.find(Offset);
197   if (I == EmptyClassOffsets.end())
198     return true;
199 
200   const ClassVectorTy& Classes = I->second;
201   if (std::find(Classes.begin(), Classes.end(), RD) == Classes.end())
202     return true;
203 
204   // There is already an empty class of the same type at this offset.
205   return false;
206 }
207 
208 void EmptySubobjectMap::AddSubobjectAtOffset(const CXXRecordDecl *RD,
209                                              CharUnits Offset) {
210   // We only care about empty bases.
211   if (!RD->isEmpty())
212     return;
213 
214   // If we have empty structures inside a union, we can assign both
215   // the same offset. Just avoid pushing them twice in the list.
216   ClassVectorTy& Classes = EmptyClassOffsets[Offset];
217   if (std::find(Classes.begin(), Classes.end(), RD) != Classes.end())
218     return;
219 
220   Classes.push_back(RD);
221 
222   // Update the empty class offset.
223   if (Offset > MaxEmptyClassOffset)
224     MaxEmptyClassOffset = Offset;
225 }
226 
227 bool
228 EmptySubobjectMap::CanPlaceBaseSubobjectAtOffset(const BaseSubobjectInfo *Info,
229                                                  CharUnits Offset) {
230   // We don't have to keep looking past the maximum offset that's known to
231   // contain an empty class.
232   if (!AnyEmptySubobjectsBeyondOffset(Offset))
233     return true;
234 
235   if (!CanPlaceSubobjectAtOffset(Info->Class, Offset))
236     return false;
237 
238   // Traverse all non-virtual bases.
239   const ASTRecordLayout &Layout = Context.getASTRecordLayout(Info->Class);
240   for (unsigned I = 0, E = Info->Bases.size(); I != E; ++I) {
241     BaseSubobjectInfo* Base = Info->Bases[I];
242     if (Base->IsVirtual)
243       continue;
244 
245     CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base->Class);
246 
247     if (!CanPlaceBaseSubobjectAtOffset(Base, BaseOffset))
248       return false;
249   }
250 
251   if (Info->PrimaryVirtualBaseInfo) {
252     BaseSubobjectInfo *PrimaryVirtualBaseInfo = Info->PrimaryVirtualBaseInfo;
253 
254     if (Info == PrimaryVirtualBaseInfo->Derived) {
255       if (!CanPlaceBaseSubobjectAtOffset(PrimaryVirtualBaseInfo, Offset))
256         return false;
257     }
258   }
259 
260   // Traverse all member variables.
261   unsigned FieldNo = 0;
262   for (CXXRecordDecl::field_iterator I = Info->Class->field_begin(),
263        E = Info->Class->field_end(); I != E; ++I, ++FieldNo) {
264     if (I->isBitField())
265       continue;
266 
267     CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
268     if (!CanPlaceFieldSubobjectAtOffset(*I, FieldOffset))
269       return false;
270   }
271 
272   return true;
273 }
274 
275 void EmptySubobjectMap::UpdateEmptyBaseSubobjects(const BaseSubobjectInfo *Info,
276                                                   CharUnits Offset,
277                                                   bool PlacingEmptyBase) {
278   if (!PlacingEmptyBase && Offset >= SizeOfLargestEmptySubobject) {
279     // We know that the only empty subobjects that can conflict with empty
280     // subobject of non-empty bases, are empty bases that can be placed at
281     // offset zero. Because of this, we only need to keep track of empty base
282     // subobjects with offsets less than the size of the largest empty
283     // subobject for our class.
284     return;
285   }
286 
287   AddSubobjectAtOffset(Info->Class, Offset);
288 
289   // Traverse all non-virtual bases.
290   const ASTRecordLayout &Layout = Context.getASTRecordLayout(Info->Class);
291   for (unsigned I = 0, E = Info->Bases.size(); I != E; ++I) {
292     BaseSubobjectInfo* Base = Info->Bases[I];
293     if (Base->IsVirtual)
294       continue;
295 
296     CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base->Class);
297     UpdateEmptyBaseSubobjects(Base, BaseOffset, PlacingEmptyBase);
298   }
299 
300   if (Info->PrimaryVirtualBaseInfo) {
301     BaseSubobjectInfo *PrimaryVirtualBaseInfo = Info->PrimaryVirtualBaseInfo;
302 
303     if (Info == PrimaryVirtualBaseInfo->Derived)
304       UpdateEmptyBaseSubobjects(PrimaryVirtualBaseInfo, Offset,
305                                 PlacingEmptyBase);
306   }
307 
308   // Traverse all member variables.
309   unsigned FieldNo = 0;
310   for (CXXRecordDecl::field_iterator I = Info->Class->field_begin(),
311        E = Info->Class->field_end(); I != E; ++I, ++FieldNo) {
312     if (I->isBitField())
313       continue;
314 
315     CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
316     UpdateEmptyFieldSubobjects(*I, FieldOffset);
317   }
318 }
319 
320 bool EmptySubobjectMap::CanPlaceBaseAtOffset(const BaseSubobjectInfo *Info,
321                                              CharUnits Offset) {
322   // If we know this class doesn't have any empty subobjects we don't need to
323   // bother checking.
324   if (SizeOfLargestEmptySubobject.isZero())
325     return true;
326 
327   if (!CanPlaceBaseSubobjectAtOffset(Info, Offset))
328     return false;
329 
330   // We are able to place the base at this offset. Make sure to update the
331   // empty base subobject map.
332   UpdateEmptyBaseSubobjects(Info, Offset, Info->Class->isEmpty());
333   return true;
334 }
335 
336 bool
337 EmptySubobjectMap::CanPlaceFieldSubobjectAtOffset(const CXXRecordDecl *RD,
338                                                   const CXXRecordDecl *Class,
339                                                   CharUnits Offset) const {
340   // We don't have to keep looking past the maximum offset that's known to
341   // contain an empty class.
342   if (!AnyEmptySubobjectsBeyondOffset(Offset))
343     return true;
344 
345   if (!CanPlaceSubobjectAtOffset(RD, Offset))
346     return false;
347 
348   const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
349 
350   // Traverse all non-virtual bases.
351   for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
352        E = RD->bases_end(); I != E; ++I) {
353     if (I->isVirtual())
354       continue;
355 
356     const CXXRecordDecl *BaseDecl =
357       cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
358 
359     CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(BaseDecl);
360     if (!CanPlaceFieldSubobjectAtOffset(BaseDecl, Class, BaseOffset))
361       return false;
362   }
363 
364   if (RD == Class) {
365     // This is the most derived class, traverse virtual bases as well.
366     for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
367          E = RD->vbases_end(); I != E; ++I) {
368       const CXXRecordDecl *VBaseDecl =
369         cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
370 
371       CharUnits VBaseOffset = Offset + Layout.getVBaseClassOffset(VBaseDecl);
372       if (!CanPlaceFieldSubobjectAtOffset(VBaseDecl, Class, VBaseOffset))
373         return false;
374     }
375   }
376 
377   // Traverse all member variables.
378   unsigned FieldNo = 0;
379   for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
380        I != E; ++I, ++FieldNo) {
381     if (I->isBitField())
382       continue;
383 
384     CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
385 
386     if (!CanPlaceFieldSubobjectAtOffset(*I, FieldOffset))
387       return false;
388   }
389 
390   return true;
391 }
392 
393 bool
394 EmptySubobjectMap::CanPlaceFieldSubobjectAtOffset(const FieldDecl *FD,
395                                                   CharUnits Offset) const {
396   // We don't have to keep looking past the maximum offset that's known to
397   // contain an empty class.
398   if (!AnyEmptySubobjectsBeyondOffset(Offset))
399     return true;
400 
401   QualType T = FD->getType();
402   if (const RecordType *RT = T->getAs<RecordType>()) {
403     const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
404     return CanPlaceFieldSubobjectAtOffset(RD, RD, Offset);
405   }
406 
407   // If we have an array type we need to look at every element.
408   if (const ConstantArrayType *AT = Context.getAsConstantArrayType(T)) {
409     QualType ElemTy = Context.getBaseElementType(AT);
410     const RecordType *RT = ElemTy->getAs<RecordType>();
411     if (!RT)
412       return true;
413 
414     const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
415     const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
416 
417     uint64_t NumElements = Context.getConstantArrayElementCount(AT);
418     CharUnits ElementOffset = Offset;
419     for (uint64_t I = 0; I != NumElements; ++I) {
420       // We don't have to keep looking past the maximum offset that's known to
421       // contain an empty class.
422       if (!AnyEmptySubobjectsBeyondOffset(ElementOffset))
423         return true;
424 
425       if (!CanPlaceFieldSubobjectAtOffset(RD, RD, ElementOffset))
426         return false;
427 
428       ElementOffset += Layout.getSize();
429     }
430   }
431 
432   return true;
433 }
434 
435 bool
436 EmptySubobjectMap::CanPlaceFieldAtOffset(const FieldDecl *FD,
437                                          CharUnits Offset) {
438   if (!CanPlaceFieldSubobjectAtOffset(FD, Offset))
439     return false;
440 
441   // We are able to place the member variable at this offset.
442   // Make sure to update the empty base subobject map.
443   UpdateEmptyFieldSubobjects(FD, Offset);
444   return true;
445 }
446 
447 void EmptySubobjectMap::UpdateEmptyFieldSubobjects(const CXXRecordDecl *RD,
448                                                    const CXXRecordDecl *Class,
449                                                    CharUnits Offset) {
450   // We know that the only empty subobjects that can conflict with empty
451   // field subobjects are subobjects of empty bases that can be placed at offset
452   // zero. Because of this, we only need to keep track of empty field
453   // subobjects with offsets less than the size of the largest empty
454   // subobject for our class.
455   if (Offset >= SizeOfLargestEmptySubobject)
456     return;
457 
458   AddSubobjectAtOffset(RD, Offset);
459 
460   const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
461 
462   // Traverse all non-virtual bases.
463   for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
464        E = RD->bases_end(); I != E; ++I) {
465     if (I->isVirtual())
466       continue;
467 
468     const CXXRecordDecl *BaseDecl =
469       cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
470 
471     CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(BaseDecl);
472     UpdateEmptyFieldSubobjects(BaseDecl, Class, BaseOffset);
473   }
474 
475   if (RD == Class) {
476     // This is the most derived class, traverse virtual bases as well.
477     for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
478          E = RD->vbases_end(); I != E; ++I) {
479       const CXXRecordDecl *VBaseDecl =
480       cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
481 
482       CharUnits VBaseOffset = Offset + Layout.getVBaseClassOffset(VBaseDecl);
483       UpdateEmptyFieldSubobjects(VBaseDecl, Class, VBaseOffset);
484     }
485   }
486 
487   // Traverse all member variables.
488   unsigned FieldNo = 0;
489   for (CXXRecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
490        I != E; ++I, ++FieldNo) {
491     if (I->isBitField())
492       continue;
493 
494     CharUnits FieldOffset = Offset + getFieldOffset(Layout, FieldNo);
495 
496     UpdateEmptyFieldSubobjects(*I, FieldOffset);
497   }
498 }
499 
500 void EmptySubobjectMap::UpdateEmptyFieldSubobjects(const FieldDecl *FD,
501                                                    CharUnits Offset) {
502   QualType T = FD->getType();
503   if (const RecordType *RT = T->getAs<RecordType>()) {
504     const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
505     UpdateEmptyFieldSubobjects(RD, RD, Offset);
506     return;
507   }
508 
509   // If we have an array type we need to update every element.
510   if (const ConstantArrayType *AT = Context.getAsConstantArrayType(T)) {
511     QualType ElemTy = Context.getBaseElementType(AT);
512     const RecordType *RT = ElemTy->getAs<RecordType>();
513     if (!RT)
514       return;
515 
516     const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
517     const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
518 
519     uint64_t NumElements = Context.getConstantArrayElementCount(AT);
520     CharUnits ElementOffset = Offset;
521 
522     for (uint64_t I = 0; I != NumElements; ++I) {
523       // We know that the only empty subobjects that can conflict with empty
524       // field subobjects are subobjects of empty bases that can be placed at
525       // offset zero. Because of this, we only need to keep track of empty field
526       // subobjects with offsets less than the size of the largest empty
527       // subobject for our class.
528       if (ElementOffset >= SizeOfLargestEmptySubobject)
529         return;
530 
531       UpdateEmptyFieldSubobjects(RD, RD, ElementOffset);
532       ElementOffset += Layout.getSize();
533     }
534   }
535 }
536 
537 typedef llvm::SmallPtrSet<const CXXRecordDecl*, 4> ClassSetTy;
538 
539 class RecordLayoutBuilder {
540 protected:
541   // FIXME: Remove this and make the appropriate fields public.
542   friend class clang::ASTContext;
543 
544   const ASTContext &Context;
545 
546   EmptySubobjectMap *EmptySubobjects;
547 
548   /// Size - The current size of the record layout.
549   uint64_t Size;
550 
551   /// Alignment - The current alignment of the record layout.
552   CharUnits Alignment;
553 
554   /// \brief The alignment if attribute packed is not used.
555   CharUnits UnpackedAlignment;
556 
557   SmallVector<uint64_t, 16> FieldOffsets;
558 
559   /// \brief Whether the external AST source has provided a layout for this
560   /// record.
561   unsigned ExternalLayout : 1;
562 
563   /// \brief Whether we need to infer alignment, even when we have an
564   /// externally-provided layout.
565   unsigned InferAlignment : 1;
566 
567   /// Packed - Whether the record is packed or not.
568   unsigned Packed : 1;
569 
570   unsigned IsUnion : 1;
571 
572   unsigned IsMac68kAlign : 1;
573 
574   unsigned IsMsStruct : 1;
575 
576   /// UnfilledBitsInLastUnit - If the last field laid out was a bitfield,
577   /// this contains the number of bits in the last unit that can be used for
578   /// an adjacent bitfield if necessary.  The unit in question is usually
579   /// a byte, but larger units are used if IsMsStruct.
580   unsigned char UnfilledBitsInLastUnit;
581   /// LastBitfieldTypeSize - If IsMsStruct, represents the size of the type
582   /// of the previous field if it was a bitfield.
583   unsigned char LastBitfieldTypeSize;
584 
585   /// MaxFieldAlignment - The maximum allowed field alignment. This is set by
586   /// #pragma pack.
587   CharUnits MaxFieldAlignment;
588 
589   /// DataSize - The data size of the record being laid out.
590   uint64_t DataSize;
591 
592   CharUnits NonVirtualSize;
593   CharUnits NonVirtualAlignment;
594 
595   /// PrimaryBase - the primary base class (if one exists) of the class
596   /// we're laying out.
597   const CXXRecordDecl *PrimaryBase;
598 
599   /// PrimaryBaseIsVirtual - Whether the primary base of the class we're laying
600   /// out is virtual.
601   bool PrimaryBaseIsVirtual;
602 
603   /// HasOwnVFPtr - Whether the class provides its own vtable/vftbl
604   /// pointer, as opposed to inheriting one from a primary base class.
605   bool HasOwnVFPtr;
606 
607   typedef llvm::DenseMap<const CXXRecordDecl *, CharUnits> BaseOffsetsMapTy;
608 
609   /// Bases - base classes and their offsets in the record.
610   BaseOffsetsMapTy Bases;
611 
612   // VBases - virtual base classes and their offsets in the record.
613   ASTRecordLayout::VBaseOffsetsMapTy VBases;
614 
615   /// IndirectPrimaryBases - Virtual base classes, direct or indirect, that are
616   /// primary base classes for some other direct or indirect base class.
617   CXXIndirectPrimaryBaseSet IndirectPrimaryBases;
618 
619   /// FirstNearlyEmptyVBase - The first nearly empty virtual base class in
620   /// inheritance graph order. Used for determining the primary base class.
621   const CXXRecordDecl *FirstNearlyEmptyVBase;
622 
623   /// VisitedVirtualBases - A set of all the visited virtual bases, used to
624   /// avoid visiting virtual bases more than once.
625   llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBases;
626 
627   /// \brief Externally-provided size.
628   uint64_t ExternalSize;
629 
630   /// \brief Externally-provided alignment.
631   uint64_t ExternalAlign;
632 
633   /// \brief Externally-provided field offsets.
634   llvm::DenseMap<const FieldDecl *, uint64_t> ExternalFieldOffsets;
635 
636   /// \brief Externally-provided direct, non-virtual base offsets.
637   llvm::DenseMap<const CXXRecordDecl *, CharUnits> ExternalBaseOffsets;
638 
639   /// \brief Externally-provided virtual base offsets.
640   llvm::DenseMap<const CXXRecordDecl *, CharUnits> ExternalVirtualBaseOffsets;
641 
642   RecordLayoutBuilder(const ASTContext &Context,
643                       EmptySubobjectMap *EmptySubobjects)
644     : Context(Context), EmptySubobjects(EmptySubobjects), Size(0),
645       Alignment(CharUnits::One()), UnpackedAlignment(CharUnits::One()),
646       ExternalLayout(false), InferAlignment(false),
647       Packed(false), IsUnion(false), IsMac68kAlign(false), IsMsStruct(false),
648       UnfilledBitsInLastUnit(0), LastBitfieldTypeSize(0),
649       MaxFieldAlignment(CharUnits::Zero()),
650       DataSize(0), NonVirtualSize(CharUnits::Zero()),
651       NonVirtualAlignment(CharUnits::One()),
652       PrimaryBase(0), PrimaryBaseIsVirtual(false),
653       HasOwnVFPtr(false),
654       FirstNearlyEmptyVBase(0) { }
655 
656   /// Reset this RecordLayoutBuilder to a fresh state, using the given
657   /// alignment as the initial alignment.  This is used for the
658   /// correct layout of vb-table pointers in MSVC.
659   void resetWithTargetAlignment(CharUnits TargetAlignment) {
660     const ASTContext &Context = this->Context;
661     EmptySubobjectMap *EmptySubobjects = this->EmptySubobjects;
662     this->~RecordLayoutBuilder();
663     new (this) RecordLayoutBuilder(Context, EmptySubobjects);
664     Alignment = UnpackedAlignment = TargetAlignment;
665   }
666 
667   void Layout(const RecordDecl *D);
668   void Layout(const CXXRecordDecl *D);
669   void Layout(const ObjCInterfaceDecl *D);
670 
671   void LayoutFields(const RecordDecl *D);
672   void LayoutField(const FieldDecl *D);
673   void LayoutWideBitField(uint64_t FieldSize, uint64_t TypeSize,
674                           bool FieldPacked, const FieldDecl *D);
675   void LayoutBitField(const FieldDecl *D);
676 
677   TargetCXXABI getCXXABI() const {
678     return Context.getTargetInfo().getCXXABI();
679   }
680 
681   /// BaseSubobjectInfoAllocator - Allocator for BaseSubobjectInfo objects.
682   llvm::SpecificBumpPtrAllocator<BaseSubobjectInfo> BaseSubobjectInfoAllocator;
683 
684   typedef llvm::DenseMap<const CXXRecordDecl *, BaseSubobjectInfo *>
685     BaseSubobjectInfoMapTy;
686 
687   /// VirtualBaseInfo - Map from all the (direct or indirect) virtual bases
688   /// of the class we're laying out to their base subobject info.
689   BaseSubobjectInfoMapTy VirtualBaseInfo;
690 
691   /// NonVirtualBaseInfo - Map from all the direct non-virtual bases of the
692   /// class we're laying out to their base subobject info.
693   BaseSubobjectInfoMapTy NonVirtualBaseInfo;
694 
695   /// ComputeBaseSubobjectInfo - Compute the base subobject information for the
696   /// bases of the given class.
697   void ComputeBaseSubobjectInfo(const CXXRecordDecl *RD);
698 
699   /// ComputeBaseSubobjectInfo - Compute the base subobject information for a
700   /// single class and all of its base classes.
701   BaseSubobjectInfo *ComputeBaseSubobjectInfo(const CXXRecordDecl *RD,
702                                               bool IsVirtual,
703                                               BaseSubobjectInfo *Derived);
704 
705   /// DeterminePrimaryBase - Determine the primary base of the given class.
706   void DeterminePrimaryBase(const CXXRecordDecl *RD);
707 
708   void SelectPrimaryVBase(const CXXRecordDecl *RD);
709 
710   void EnsureVTablePointerAlignment(CharUnits UnpackedBaseAlign);
711 
712   /// LayoutNonVirtualBases - Determines the primary base class (if any) and
713   /// lays it out. Will then proceed to lay out all non-virtual base clasess.
714   void LayoutNonVirtualBases(const CXXRecordDecl *RD);
715 
716   /// LayoutNonVirtualBase - Lays out a single non-virtual base.
717   void LayoutNonVirtualBase(const BaseSubobjectInfo *Base);
718 
719   void AddPrimaryVirtualBaseOffsets(const BaseSubobjectInfo *Info,
720                                     CharUnits Offset);
721 
722   /// LayoutVirtualBases - Lays out all the virtual bases.
723   void LayoutVirtualBases(const CXXRecordDecl *RD,
724                           const CXXRecordDecl *MostDerivedClass);
725 
726   /// LayoutVirtualBase - Lays out a single virtual base.
727   void LayoutVirtualBase(const BaseSubobjectInfo *Base);
728 
729   /// LayoutBase - Will lay out a base and return the offset where it was
730   /// placed, in chars.
731   CharUnits LayoutBase(const BaseSubobjectInfo *Base);
732 
733   /// InitializeLayout - Initialize record layout for the given record decl.
734   void InitializeLayout(const Decl *D);
735 
736   /// FinishLayout - Finalize record layout. Adjust record size based on the
737   /// alignment.
738   void FinishLayout(const NamedDecl *D);
739 
740   void UpdateAlignment(CharUnits NewAlignment, CharUnits UnpackedNewAlignment);
741   void UpdateAlignment(CharUnits NewAlignment) {
742     UpdateAlignment(NewAlignment, NewAlignment);
743   }
744 
745   /// \brief Retrieve the externally-supplied field offset for the given
746   /// field.
747   ///
748   /// \param Field The field whose offset is being queried.
749   /// \param ComputedOffset The offset that we've computed for this field.
750   uint64_t updateExternalFieldOffset(const FieldDecl *Field,
751                                      uint64_t ComputedOffset);
752 
753   void CheckFieldPadding(uint64_t Offset, uint64_t UnpaddedOffset,
754                           uint64_t UnpackedOffset, unsigned UnpackedAlign,
755                           bool isPacked, const FieldDecl *D);
756 
757   DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID);
758 
759   CharUnits getSize() const {
760     assert(Size % Context.getCharWidth() == 0);
761     return Context.toCharUnitsFromBits(Size);
762   }
763   uint64_t getSizeInBits() const { return Size; }
764 
765   void setSize(CharUnits NewSize) { Size = Context.toBits(NewSize); }
766   void setSize(uint64_t NewSize) { Size = NewSize; }
767 
768   CharUnits getAligment() const { return Alignment; }
769 
770   CharUnits getDataSize() const {
771     assert(DataSize % Context.getCharWidth() == 0);
772     return Context.toCharUnitsFromBits(DataSize);
773   }
774   uint64_t getDataSizeInBits() const { return DataSize; }
775 
776   void setDataSize(CharUnits NewSize) { DataSize = Context.toBits(NewSize); }
777   void setDataSize(uint64_t NewSize) { DataSize = NewSize; }
778 
779   RecordLayoutBuilder(const RecordLayoutBuilder &) LLVM_DELETED_FUNCTION;
780   void operator=(const RecordLayoutBuilder &) LLVM_DELETED_FUNCTION;
781 };
782 } // end anonymous namespace
783 
784 void
785 RecordLayoutBuilder::SelectPrimaryVBase(const CXXRecordDecl *RD) {
786   for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
787          E = RD->bases_end(); I != E; ++I) {
788     assert(!I->getType()->isDependentType() &&
789            "Cannot layout class with dependent bases.");
790 
791     const CXXRecordDecl *Base =
792       cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
793 
794     // Check if this is a nearly empty virtual base.
795     if (I->isVirtual() && Context.isNearlyEmpty(Base)) {
796       // If it's not an indirect primary base, then we've found our primary
797       // base.
798       if (!IndirectPrimaryBases.count(Base)) {
799         PrimaryBase = Base;
800         PrimaryBaseIsVirtual = true;
801         return;
802       }
803 
804       // Is this the first nearly empty virtual base?
805       if (!FirstNearlyEmptyVBase)
806         FirstNearlyEmptyVBase = Base;
807     }
808 
809     SelectPrimaryVBase(Base);
810     if (PrimaryBase)
811       return;
812   }
813 }
814 
815 /// DeterminePrimaryBase - Determine the primary base of the given class.
816 void RecordLayoutBuilder::DeterminePrimaryBase(const CXXRecordDecl *RD) {
817   // If the class isn't dynamic, it won't have a primary base.
818   if (!RD->isDynamicClass())
819     return;
820 
821   // Compute all the primary virtual bases for all of our direct and
822   // indirect bases, and record all their primary virtual base classes.
823   RD->getIndirectPrimaryBases(IndirectPrimaryBases);
824 
825   // If the record has a dynamic base class, attempt to choose a primary base
826   // class. It is the first (in direct base class order) non-virtual dynamic
827   // base class, if one exists.
828   for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
829          e = RD->bases_end(); i != e; ++i) {
830     // Ignore virtual bases.
831     if (i->isVirtual())
832       continue;
833 
834     const CXXRecordDecl *Base =
835       cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
836 
837     if (Base->isDynamicClass()) {
838       // We found it.
839       PrimaryBase = Base;
840       PrimaryBaseIsVirtual = false;
841       return;
842     }
843   }
844 
845   // Under the Itanium ABI, if there is no non-virtual primary base class,
846   // try to compute the primary virtual base.  The primary virtual base is
847   // the first nearly empty virtual base that is not an indirect primary
848   // virtual base class, if one exists.
849   if (RD->getNumVBases() != 0) {
850     SelectPrimaryVBase(RD);
851     if (PrimaryBase)
852       return;
853   }
854 
855   // Otherwise, it is the first indirect primary base class, if one exists.
856   if (FirstNearlyEmptyVBase) {
857     PrimaryBase = FirstNearlyEmptyVBase;
858     PrimaryBaseIsVirtual = true;
859     return;
860   }
861 
862   assert(!PrimaryBase && "Should not get here with a primary base!");
863 }
864 
865 BaseSubobjectInfo *
866 RecordLayoutBuilder::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.isPrimaryBaseVirtual()) {
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 
946 void 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 
970 void
971 RecordLayoutBuilder::EnsureVTablePointerAlignment(CharUnits UnpackedBaseAlign) {
972   CharUnits BaseAlign = (Packed) ? CharUnits::One() : UnpackedBaseAlign;
973 
974   // The maximum field alignment overrides base align.
975   if (!MaxFieldAlignment.isZero()) {
976     BaseAlign = std::min(BaseAlign, MaxFieldAlignment);
977     UnpackedBaseAlign = std::min(UnpackedBaseAlign, MaxFieldAlignment);
978   }
979 
980   // Round up the current record size to pointer alignment.
981   setSize(getSize().RoundUpToAlignment(BaseAlign));
982   setDataSize(getSize());
983 
984   // Update the alignment.
985   UpdateAlignment(BaseAlign, UnpackedBaseAlign);
986 }
987 
988 void
989 RecordLayoutBuilder::LayoutNonVirtualBases(const CXXRecordDecl *RD) {
990   // Then, determine the primary base class.
991   DeterminePrimaryBase(RD);
992 
993   // Compute base subobject info.
994   ComputeBaseSubobjectInfo(RD);
995 
996   // If we have a primary base class, lay it out.
997   if (PrimaryBase) {
998     if (PrimaryBaseIsVirtual) {
999       // If the primary virtual base was a primary virtual base of some other
1000       // base class we'll have to steal it.
1001       BaseSubobjectInfo *PrimaryBaseInfo = VirtualBaseInfo.lookup(PrimaryBase);
1002       PrimaryBaseInfo->Derived = 0;
1003 
1004       // We have a virtual primary base, insert it as an indirect primary base.
1005       IndirectPrimaryBases.insert(PrimaryBase);
1006 
1007       assert(!VisitedVirtualBases.count(PrimaryBase) &&
1008              "vbase already visited!");
1009       VisitedVirtualBases.insert(PrimaryBase);
1010 
1011       LayoutVirtualBase(PrimaryBaseInfo);
1012     } else {
1013       BaseSubobjectInfo *PrimaryBaseInfo =
1014         NonVirtualBaseInfo.lookup(PrimaryBase);
1015       assert(PrimaryBaseInfo &&
1016              "Did not find base info for non-virtual primary base!");
1017 
1018       LayoutNonVirtualBase(PrimaryBaseInfo);
1019     }
1020 
1021   // If this class needs a vtable/vf-table and didn't get one from a
1022   // primary base, add it in now.
1023   } else if (RD->isDynamicClass()) {
1024     assert(DataSize == 0 && "Vtable pointer must be at offset zero!");
1025     CharUnits PtrWidth =
1026       Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerWidth(0));
1027     CharUnits PtrAlign =
1028       Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerAlign(0));
1029     EnsureVTablePointerAlignment(PtrAlign);
1030     HasOwnVFPtr = true;
1031     setSize(getSize() + PtrWidth);
1032     setDataSize(getSize());
1033   }
1034 
1035   // Now lay out the non-virtual bases.
1036   for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1037          E = RD->bases_end(); I != E; ++I) {
1038 
1039     // Ignore virtual bases.
1040     if (I->isVirtual())
1041       continue;
1042 
1043     const CXXRecordDecl *BaseDecl = I->getType()->getAsCXXRecordDecl();
1044 
1045     // Skip the primary base, because we've already laid it out.  The
1046     // !PrimaryBaseIsVirtual check is required because we might have a
1047     // non-virtual base of the same type as a primary virtual base.
1048     if (BaseDecl == PrimaryBase && !PrimaryBaseIsVirtual)
1049       continue;
1050 
1051     // Lay out the base.
1052     BaseSubobjectInfo *BaseInfo = NonVirtualBaseInfo.lookup(BaseDecl);
1053     assert(BaseInfo && "Did not find base info for non-virtual base!");
1054 
1055     LayoutNonVirtualBase(BaseInfo);
1056   }
1057 }
1058 
1059 void RecordLayoutBuilder::LayoutNonVirtualBase(const BaseSubobjectInfo *Base) {
1060   // Layout the base.
1061   CharUnits Offset = LayoutBase(Base);
1062 
1063   // Add its base class offset.
1064   assert(!Bases.count(Base->Class) && "base offset already exists!");
1065   Bases.insert(std::make_pair(Base->Class, Offset));
1066 
1067   AddPrimaryVirtualBaseOffsets(Base, Offset);
1068 }
1069 
1070 void
1071 RecordLayoutBuilder::AddPrimaryVirtualBaseOffsets(const BaseSubobjectInfo *Info,
1072                                                   CharUnits Offset) {
1073   // This base isn't interesting, it has no virtual bases.
1074   if (!Info->Class->getNumVBases())
1075     return;
1076 
1077   // First, check if we have a virtual primary base to add offsets for.
1078   if (Info->PrimaryVirtualBaseInfo) {
1079     assert(Info->PrimaryVirtualBaseInfo->IsVirtual &&
1080            "Primary virtual base is not virtual!");
1081     if (Info->PrimaryVirtualBaseInfo->Derived == Info) {
1082       // Add the offset.
1083       assert(!VBases.count(Info->PrimaryVirtualBaseInfo->Class) &&
1084              "primary vbase offset already exists!");
1085       VBases.insert(std::make_pair(Info->PrimaryVirtualBaseInfo->Class,
1086                                    ASTRecordLayout::VBaseInfo(Offset, false)));
1087 
1088       // Traverse the primary virtual base.
1089       AddPrimaryVirtualBaseOffsets(Info->PrimaryVirtualBaseInfo, Offset);
1090     }
1091   }
1092 
1093   // Now go through all direct non-virtual bases.
1094   const ASTRecordLayout &Layout = Context.getASTRecordLayout(Info->Class);
1095   for (unsigned I = 0, E = Info->Bases.size(); I != E; ++I) {
1096     const BaseSubobjectInfo *Base = Info->Bases[I];
1097     if (Base->IsVirtual)
1098       continue;
1099 
1100     CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base->Class);
1101     AddPrimaryVirtualBaseOffsets(Base, BaseOffset);
1102   }
1103 }
1104 
1105 void
1106 RecordLayoutBuilder::LayoutVirtualBases(const CXXRecordDecl *RD,
1107                                         const CXXRecordDecl *MostDerivedClass) {
1108   const CXXRecordDecl *PrimaryBase;
1109   bool PrimaryBaseIsVirtual;
1110 
1111   if (MostDerivedClass == RD) {
1112     PrimaryBase = this->PrimaryBase;
1113     PrimaryBaseIsVirtual = this->PrimaryBaseIsVirtual;
1114   } else {
1115     const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
1116     PrimaryBase = Layout.getPrimaryBase();
1117     PrimaryBaseIsVirtual = Layout.isPrimaryBaseVirtual();
1118   }
1119 
1120   for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1121          E = RD->bases_end(); I != E; ++I) {
1122     assert(!I->getType()->isDependentType() &&
1123            "Cannot layout class with dependent bases.");
1124 
1125     const CXXRecordDecl *BaseDecl = I->getType()->getAsCXXRecordDecl();
1126 
1127     if (I->isVirtual()) {
1128       if (PrimaryBase != BaseDecl || !PrimaryBaseIsVirtual) {
1129         bool IndirectPrimaryBase = IndirectPrimaryBases.count(BaseDecl);
1130 
1131         // Only lay out the virtual base if it's not an indirect primary base.
1132         if (!IndirectPrimaryBase) {
1133           // Only visit virtual bases once.
1134           if (!VisitedVirtualBases.insert(BaseDecl))
1135             continue;
1136 
1137           const BaseSubobjectInfo *BaseInfo = VirtualBaseInfo.lookup(BaseDecl);
1138           assert(BaseInfo && "Did not find virtual base info!");
1139           LayoutVirtualBase(BaseInfo);
1140         }
1141       }
1142     }
1143 
1144     if (!BaseDecl->getNumVBases()) {
1145       // This base isn't interesting since it doesn't have any virtual bases.
1146       continue;
1147     }
1148 
1149     LayoutVirtualBases(BaseDecl, MostDerivedClass);
1150   }
1151 }
1152 
1153 void RecordLayoutBuilder::LayoutVirtualBase(const BaseSubobjectInfo *Base) {
1154   assert(!Base->Derived && "Trying to lay out a primary virtual base!");
1155 
1156   // Layout the base.
1157   CharUnits Offset = LayoutBase(Base);
1158 
1159   // Add its base class offset.
1160   assert(!VBases.count(Base->Class) && "vbase offset already exists!");
1161   VBases.insert(std::make_pair(Base->Class,
1162                        ASTRecordLayout::VBaseInfo(Offset, false)));
1163 
1164   AddPrimaryVirtualBaseOffsets(Base, Offset);
1165 }
1166 
1167 CharUnits RecordLayoutBuilder::LayoutBase(const BaseSubobjectInfo *Base) {
1168   const ASTRecordLayout &Layout = Context.getASTRecordLayout(Base->Class);
1169 
1170 
1171   CharUnits Offset;
1172 
1173   // Query the external layout to see if it provides an offset.
1174   bool HasExternalLayout = false;
1175   if (ExternalLayout) {
1176     llvm::DenseMap<const CXXRecordDecl *, CharUnits>::iterator Known;
1177     if (Base->IsVirtual) {
1178       Known = ExternalVirtualBaseOffsets.find(Base->Class);
1179       if (Known != ExternalVirtualBaseOffsets.end()) {
1180         Offset = Known->second;
1181         HasExternalLayout = true;
1182       }
1183     } else {
1184       Known = ExternalBaseOffsets.find(Base->Class);
1185       if (Known != ExternalBaseOffsets.end()) {
1186         Offset = Known->second;
1187         HasExternalLayout = true;
1188       }
1189     }
1190   }
1191 
1192   CharUnits UnpackedBaseAlign = Layout.getNonVirtualAlignment();
1193   CharUnits BaseAlign = (Packed) ? CharUnits::One() : UnpackedBaseAlign;
1194 
1195   // If we have an empty base class, try to place it at offset 0.
1196   if (Base->Class->isEmpty() &&
1197       (!HasExternalLayout || Offset == CharUnits::Zero()) &&
1198       EmptySubobjects->CanPlaceBaseAtOffset(Base, CharUnits::Zero())) {
1199     setSize(std::max(getSize(), Layout.getSize()));
1200     UpdateAlignment(BaseAlign, UnpackedBaseAlign);
1201 
1202     return CharUnits::Zero();
1203   }
1204 
1205   // The maximum field alignment overrides base align.
1206   if (!MaxFieldAlignment.isZero()) {
1207     BaseAlign = std::min(BaseAlign, MaxFieldAlignment);
1208     UnpackedBaseAlign = std::min(UnpackedBaseAlign, MaxFieldAlignment);
1209   }
1210 
1211   if (!HasExternalLayout) {
1212     // Round up the current record size to the base's alignment boundary.
1213     Offset = getDataSize().RoundUpToAlignment(BaseAlign);
1214 
1215     // Try to place the base.
1216     while (!EmptySubobjects->CanPlaceBaseAtOffset(Base, Offset))
1217       Offset += BaseAlign;
1218   } else {
1219     bool Allowed = EmptySubobjects->CanPlaceBaseAtOffset(Base, Offset);
1220     (void)Allowed;
1221     assert(Allowed && "Base subobject externally placed at overlapping offset");
1222 
1223     if (InferAlignment && Offset < getDataSize().RoundUpToAlignment(BaseAlign)){
1224       // The externally-supplied base offset is before the base offset we
1225       // computed. Assume that the structure is packed.
1226       Alignment = CharUnits::One();
1227       InferAlignment = false;
1228     }
1229   }
1230 
1231   if (!Base->Class->isEmpty()) {
1232     // Update the data size.
1233     setDataSize(Offset + Layout.getNonVirtualSize());
1234 
1235     setSize(std::max(getSize(), getDataSize()));
1236   } else
1237     setSize(std::max(getSize(), Offset + Layout.getSize()));
1238 
1239   // Remember max struct/class alignment.
1240   UpdateAlignment(BaseAlign, UnpackedBaseAlign);
1241 
1242   return Offset;
1243 }
1244 
1245 void RecordLayoutBuilder::InitializeLayout(const Decl *D) {
1246   if (const RecordDecl *RD = dyn_cast<RecordDecl>(D)) {
1247     IsUnion = RD->isUnion();
1248     IsMsStruct = RD->isMsStruct(Context);
1249   }
1250 
1251   Packed = D->hasAttr<PackedAttr>();
1252 
1253   // Honor the default struct packing maximum alignment flag.
1254   if (unsigned DefaultMaxFieldAlignment = Context.getLangOpts().PackStruct) {
1255     MaxFieldAlignment = CharUnits::fromQuantity(DefaultMaxFieldAlignment);
1256   }
1257 
1258   // mac68k alignment supersedes maximum field alignment and attribute aligned,
1259   // and forces all structures to have 2-byte alignment. The IBM docs on it
1260   // allude to additional (more complicated) semantics, especially with regard
1261   // to bit-fields, but gcc appears not to follow that.
1262   if (D->hasAttr<AlignMac68kAttr>()) {
1263     IsMac68kAlign = true;
1264     MaxFieldAlignment = CharUnits::fromQuantity(2);
1265     Alignment = CharUnits::fromQuantity(2);
1266   } else {
1267     if (const MaxFieldAlignmentAttr *MFAA = D->getAttr<MaxFieldAlignmentAttr>())
1268       MaxFieldAlignment = Context.toCharUnitsFromBits(MFAA->getAlignment());
1269 
1270     if (unsigned MaxAlign = D->getMaxAlignment())
1271       UpdateAlignment(Context.toCharUnitsFromBits(MaxAlign));
1272   }
1273 
1274   // If there is an external AST source, ask it for the various offsets.
1275   if (const RecordDecl *RD = dyn_cast<RecordDecl>(D))
1276     if (ExternalASTSource *External = Context.getExternalSource()) {
1277       ExternalLayout = External->layoutRecordType(RD,
1278                                                   ExternalSize,
1279                                                   ExternalAlign,
1280                                                   ExternalFieldOffsets,
1281                                                   ExternalBaseOffsets,
1282                                                   ExternalVirtualBaseOffsets);
1283 
1284       // Update based on external alignment.
1285       if (ExternalLayout) {
1286         if (ExternalAlign > 0) {
1287           Alignment = Context.toCharUnitsFromBits(ExternalAlign);
1288         } else {
1289           // The external source didn't have alignment information; infer it.
1290           InferAlignment = true;
1291         }
1292       }
1293     }
1294 }
1295 
1296 void RecordLayoutBuilder::Layout(const RecordDecl *D) {
1297   InitializeLayout(D);
1298   LayoutFields(D);
1299 
1300   // Finally, round the size of the total struct up to the alignment of the
1301   // struct itself.
1302   FinishLayout(D);
1303 }
1304 
1305 void RecordLayoutBuilder::Layout(const CXXRecordDecl *RD) {
1306   InitializeLayout(RD);
1307 
1308   // Lay out the vtable and the non-virtual bases.
1309   LayoutNonVirtualBases(RD);
1310 
1311   LayoutFields(RD);
1312 
1313   NonVirtualSize = Context.toCharUnitsFromBits(
1314         llvm::RoundUpToAlignment(getSizeInBits(),
1315                                  Context.getTargetInfo().getCharAlign()));
1316   NonVirtualAlignment = Alignment;
1317 
1318   // Lay out the virtual bases and add the primary virtual base offsets.
1319   LayoutVirtualBases(RD, RD);
1320 
1321   // Finally, round the size of the total struct up to the alignment
1322   // of the struct itself.
1323   FinishLayout(RD);
1324 
1325 #ifndef NDEBUG
1326   // Check that we have base offsets for all bases.
1327   for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
1328        E = RD->bases_end(); I != E; ++I) {
1329     if (I->isVirtual())
1330       continue;
1331 
1332     const CXXRecordDecl *BaseDecl =
1333       cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1334 
1335     assert(Bases.count(BaseDecl) && "Did not find base offset!");
1336   }
1337 
1338   // And all virtual bases.
1339   for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
1340        E = RD->vbases_end(); I != E; ++I) {
1341     const CXXRecordDecl *BaseDecl =
1342       cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
1343 
1344     assert(VBases.count(BaseDecl) && "Did not find base offset!");
1345   }
1346 #endif
1347 }
1348 
1349 void RecordLayoutBuilder::Layout(const ObjCInterfaceDecl *D) {
1350   if (ObjCInterfaceDecl *SD = D->getSuperClass()) {
1351     const ASTRecordLayout &SL = Context.getASTObjCInterfaceLayout(SD);
1352 
1353     UpdateAlignment(SL.getAlignment());
1354 
1355     // We start laying out ivars not at the end of the superclass
1356     // structure, but at the next byte following the last field.
1357     setSize(SL.getDataSize());
1358     setDataSize(getSize());
1359   }
1360 
1361   InitializeLayout(D);
1362   // Layout each ivar sequentially.
1363   for (const ObjCIvarDecl *IVD = D->all_declared_ivar_begin(); IVD;
1364        IVD = IVD->getNextIvar())
1365     LayoutField(IVD);
1366 
1367   // Finally, round the size of the total struct up to the alignment of the
1368   // struct itself.
1369   FinishLayout(D);
1370 }
1371 
1372 void RecordLayoutBuilder::LayoutFields(const RecordDecl *D) {
1373   // Layout each field, for now, just sequentially, respecting alignment.  In
1374   // the future, this will need to be tweakable by targets.
1375   for (RecordDecl::field_iterator Field = D->field_begin(),
1376        FieldEnd = D->field_end(); Field != FieldEnd; ++Field)
1377     LayoutField(*Field);
1378 }
1379 
1380 void RecordLayoutBuilder::LayoutWideBitField(uint64_t FieldSize,
1381                                              uint64_t TypeSize,
1382                                              bool FieldPacked,
1383                                              const FieldDecl *D) {
1384   assert(Context.getLangOpts().CPlusPlus &&
1385          "Can only have wide bit-fields in C++!");
1386 
1387   // Itanium C++ ABI 2.4:
1388   //   If sizeof(T)*8 < n, let T' be the largest integral POD type with
1389   //   sizeof(T')*8 <= n.
1390 
1391   QualType IntegralPODTypes[] = {
1392     Context.UnsignedCharTy, Context.UnsignedShortTy, Context.UnsignedIntTy,
1393     Context.UnsignedLongTy, Context.UnsignedLongLongTy
1394   };
1395 
1396   QualType Type;
1397   for (unsigned I = 0, E = llvm::array_lengthof(IntegralPODTypes);
1398        I != E; ++I) {
1399     uint64_t Size = Context.getTypeSize(IntegralPODTypes[I]);
1400 
1401     if (Size > FieldSize)
1402       break;
1403 
1404     Type = IntegralPODTypes[I];
1405   }
1406   assert(!Type.isNull() && "Did not find a type!");
1407 
1408   CharUnits TypeAlign = Context.getTypeAlignInChars(Type);
1409 
1410   // We're not going to use any of the unfilled bits in the last byte.
1411   UnfilledBitsInLastUnit = 0;
1412   LastBitfieldTypeSize = 0;
1413 
1414   uint64_t FieldOffset;
1415   uint64_t UnpaddedFieldOffset = getDataSizeInBits() - UnfilledBitsInLastUnit;
1416 
1417   if (IsUnion) {
1418     setDataSize(std::max(getDataSizeInBits(), FieldSize));
1419     FieldOffset = 0;
1420   } else {
1421     // The bitfield is allocated starting at the next offset aligned
1422     // appropriately for T', with length n bits.
1423     FieldOffset = llvm::RoundUpToAlignment(getDataSizeInBits(),
1424                                            Context.toBits(TypeAlign));
1425 
1426     uint64_t NewSizeInBits = FieldOffset + FieldSize;
1427 
1428     setDataSize(llvm::RoundUpToAlignment(NewSizeInBits,
1429                                          Context.getTargetInfo().getCharAlign()));
1430     UnfilledBitsInLastUnit = getDataSizeInBits() - NewSizeInBits;
1431   }
1432 
1433   // Place this field at the current location.
1434   FieldOffsets.push_back(FieldOffset);
1435 
1436   CheckFieldPadding(FieldOffset, UnpaddedFieldOffset, FieldOffset,
1437                     Context.toBits(TypeAlign), FieldPacked, D);
1438 
1439   // Update the size.
1440   setSize(std::max(getSizeInBits(), getDataSizeInBits()));
1441 
1442   // Remember max struct/class alignment.
1443   UpdateAlignment(TypeAlign);
1444 }
1445 
1446 void RecordLayoutBuilder::LayoutBitField(const FieldDecl *D) {
1447   bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
1448   uint64_t FieldSize = D->getBitWidthValue(Context);
1449   std::pair<uint64_t, unsigned> FieldInfo = Context.getTypeInfo(D->getType());
1450   uint64_t TypeSize = FieldInfo.first;
1451   unsigned FieldAlign = FieldInfo.second;
1452 
1453   // UnfilledBitsInLastUnit is the difference between the end of the
1454   // last allocated bitfield (i.e. the first bit offset available for
1455   // bitfields) and the end of the current data size in bits (i.e. the
1456   // first bit offset available for non-bitfields).  The current data
1457   // size in bits is always a multiple of the char size; additionally,
1458   // for ms_struct records it's also a multiple of the
1459   // LastBitfieldTypeSize (if set).
1460 
1461   // The struct-layout algorithm is dictated by the platform ABI,
1462   // which in principle could use almost any rules it likes.  In
1463   // practice, UNIXy targets tend to inherit the algorithm described
1464   // in the System V generic ABI.  The basic bitfield layout rule in
1465   // System V is to place bitfields at the next available bit offset
1466   // where the entire bitfield would fit in an aligned storage unit of
1467   // the declared type; it's okay if an earlier or later non-bitfield
1468   // is allocated in the same storage unit.  However, some targets
1469   // (those that !useBitFieldTypeAlignment(), e.g. ARM APCS) don't
1470   // require this storage unit to be aligned, and therefore always put
1471   // the bitfield at the next available bit offset.
1472 
1473   // ms_struct basically requests a complete replacement of the
1474   // platform ABI's struct-layout algorithm, with the high-level goal
1475   // of duplicating MSVC's layout.  For non-bitfields, this follows
1476   // the the standard algorithm.  The basic bitfield layout rule is to
1477   // allocate an entire unit of the bitfield's declared type
1478   // (e.g. 'unsigned long'), then parcel it up among successive
1479   // bitfields whose declared types have the same size, making a new
1480   // unit as soon as the last can no longer store the whole value.
1481   // Since it completely replaces the platform ABI's algorithm,
1482   // settings like !useBitFieldTypeAlignment() do not apply.
1483 
1484   // A zero-width bitfield forces the use of a new storage unit for
1485   // later bitfields.  In general, this occurs by rounding up the
1486   // current size of the struct as if the algorithm were about to
1487   // place a non-bitfield of the field's formal type.  Usually this
1488   // does not change the alignment of the struct itself, but it does
1489   // on some targets (those that useZeroLengthBitfieldAlignment(),
1490   // e.g. ARM).  In ms_struct layout, zero-width bitfields are
1491   // ignored unless they follow a non-zero-width bitfield.
1492 
1493   // A field alignment restriction (e.g. from #pragma pack) or
1494   // specification (e.g. from __attribute__((aligned))) changes the
1495   // formal alignment of the field.  For System V, this alters the
1496   // required alignment of the notional storage unit that must contain
1497   // the bitfield.  For ms_struct, this only affects the placement of
1498   // new storage units.  In both cases, the effect of #pragma pack is
1499   // ignored on zero-width bitfields.
1500 
1501   // On System V, a packed field (e.g. from #pragma pack or
1502   // __attribute__((packed))) always uses the next available bit
1503   // offset.
1504 
1505   // In an ms_struct struct, the alignment of a fundamental type is
1506   // always equal to its size.  This is necessary in order to mimic
1507   // the i386 alignment rules on targets which might not fully align
1508   // all types (e.g. Darwin PPC32, where alignof(long long) == 4).
1509 
1510   // First, some simple bookkeeping to perform for ms_struct structs.
1511   if (IsMsStruct) {
1512     // The field alignment for integer types is always the size.
1513     FieldAlign = TypeSize;
1514 
1515     // If the previous field was not a bitfield, or was a bitfield
1516     // with a different storage unit size, we're done with that
1517     // storage unit.
1518     if (LastBitfieldTypeSize != TypeSize) {
1519       // Also, ignore zero-length bitfields after non-bitfields.
1520       if (!LastBitfieldTypeSize && !FieldSize)
1521         FieldAlign = 1;
1522 
1523       UnfilledBitsInLastUnit = 0;
1524       LastBitfieldTypeSize = 0;
1525     }
1526   }
1527 
1528   // If the field is wider than its declared type, it follows
1529   // different rules in all cases.
1530   if (FieldSize > TypeSize) {
1531     LayoutWideBitField(FieldSize, TypeSize, FieldPacked, D);
1532     return;
1533   }
1534 
1535   // Compute the next available bit offset.
1536   uint64_t FieldOffset =
1537     IsUnion ? 0 : (getDataSizeInBits() - UnfilledBitsInLastUnit);
1538 
1539   // Handle targets that don't honor bitfield type alignment.
1540   if (!IsMsStruct && !Context.getTargetInfo().useBitFieldTypeAlignment()) {
1541     // Some such targets do honor it on zero-width bitfields.
1542     if (FieldSize == 0 &&
1543         Context.getTargetInfo().useZeroLengthBitfieldAlignment()) {
1544       // The alignment to round up to is the max of the field's natural
1545       // alignment and a target-specific fixed value (sometimes zero).
1546       unsigned ZeroLengthBitfieldBoundary =
1547         Context.getTargetInfo().getZeroLengthBitfieldBoundary();
1548       FieldAlign = std::max(FieldAlign, ZeroLengthBitfieldBoundary);
1549 
1550     // If that doesn't apply, just ignore the field alignment.
1551     } else {
1552       FieldAlign = 1;
1553     }
1554   }
1555 
1556   // Remember the alignment we would have used if the field were not packed.
1557   unsigned UnpackedFieldAlign = FieldAlign;
1558 
1559   // Ignore the field alignment if the field is packed unless it has zero-size.
1560   if (!IsMsStruct && FieldPacked && FieldSize != 0)
1561     FieldAlign = 1;
1562 
1563   // But, if there's an 'aligned' attribute on the field, honor that.
1564   if (unsigned ExplicitFieldAlign = D->getMaxAlignment()) {
1565     FieldAlign = std::max(FieldAlign, ExplicitFieldAlign);
1566     UnpackedFieldAlign = std::max(UnpackedFieldAlign, ExplicitFieldAlign);
1567   }
1568 
1569   // But, if there's a #pragma pack in play, that takes precedent over
1570   // even the 'aligned' attribute, for non-zero-width bitfields.
1571   if (!MaxFieldAlignment.isZero() && FieldSize) {
1572     unsigned MaxFieldAlignmentInBits = Context.toBits(MaxFieldAlignment);
1573     FieldAlign = std::min(FieldAlign, MaxFieldAlignmentInBits);
1574     UnpackedFieldAlign = std::min(UnpackedFieldAlign, MaxFieldAlignmentInBits);
1575   }
1576 
1577   // For purposes of diagnostics, we're going to simultaneously
1578   // compute the field offsets that we would have used if we weren't
1579   // adding any alignment padding or if the field weren't packed.
1580   uint64_t UnpaddedFieldOffset = FieldOffset;
1581   uint64_t UnpackedFieldOffset = FieldOffset;
1582 
1583   // Check if we need to add padding to fit the bitfield within an
1584   // allocation unit with the right size and alignment.  The rules are
1585   // somewhat different here for ms_struct structs.
1586   if (IsMsStruct) {
1587     // If it's not a zero-width bitfield, and we can fit the bitfield
1588     // into the active storage unit (and we haven't already decided to
1589     // start a new storage unit), just do so, regardless of any other
1590     // other consideration.  Otherwise, round up to the right alignment.
1591     if (FieldSize == 0 || FieldSize > UnfilledBitsInLastUnit) {
1592       FieldOffset = llvm::RoundUpToAlignment(FieldOffset, FieldAlign);
1593       UnpackedFieldOffset = llvm::RoundUpToAlignment(UnpackedFieldOffset,
1594                                                      UnpackedFieldAlign);
1595       UnfilledBitsInLastUnit = 0;
1596     }
1597 
1598   } else {
1599     // #pragma pack, with any value, suppresses the insertion of padding.
1600     bool AllowPadding = MaxFieldAlignment.isZero();
1601 
1602     // Compute the real offset.
1603     if (FieldSize == 0 ||
1604         (AllowPadding &&
1605          (FieldOffset & (FieldAlign-1)) + FieldSize > TypeSize)) {
1606       FieldOffset = llvm::RoundUpToAlignment(FieldOffset, FieldAlign);
1607     }
1608 
1609     // Repeat the computation for diagnostic purposes.
1610     if (FieldSize == 0 ||
1611         (AllowPadding &&
1612          (UnpackedFieldOffset & (UnpackedFieldAlign-1)) + FieldSize > TypeSize))
1613       UnpackedFieldOffset = llvm::RoundUpToAlignment(UnpackedFieldOffset,
1614                                                      UnpackedFieldAlign);
1615   }
1616 
1617   // If we're using external layout, give the external layout a chance
1618   // to override this information.
1619   if (ExternalLayout)
1620     FieldOffset = updateExternalFieldOffset(D, FieldOffset);
1621 
1622   // Okay, place the bitfield at the calculated offset.
1623   FieldOffsets.push_back(FieldOffset);
1624 
1625   // Bookkeeping:
1626 
1627   // Anonymous members don't affect the overall record alignment,
1628   // except on targets where they do.
1629   if (!IsMsStruct &&
1630       !Context.getTargetInfo().useZeroLengthBitfieldAlignment() &&
1631       !D->getIdentifier())
1632     FieldAlign = UnpackedFieldAlign = 1;
1633 
1634   // Diagnose differences in layout due to padding or packing.
1635   if (!ExternalLayout)
1636     CheckFieldPadding(FieldOffset, UnpaddedFieldOffset, UnpackedFieldOffset,
1637                       UnpackedFieldAlign, FieldPacked, D);
1638 
1639   // Update DataSize to include the last byte containing (part of) the bitfield.
1640 
1641   // For unions, this is just a max operation, as usual.
1642   if (IsUnion) {
1643     // FIXME: I think FieldSize should be TypeSize here.
1644     setDataSize(std::max(getDataSizeInBits(), FieldSize));
1645 
1646   // For non-zero-width bitfields in ms_struct structs, allocate a new
1647   // storage unit if necessary.
1648   } else if (IsMsStruct && FieldSize) {
1649     // We should have cleared UnfilledBitsInLastUnit in every case
1650     // where we changed storage units.
1651     if (!UnfilledBitsInLastUnit) {
1652       setDataSize(FieldOffset + TypeSize);
1653       UnfilledBitsInLastUnit = TypeSize;
1654     }
1655     UnfilledBitsInLastUnit -= FieldSize;
1656     LastBitfieldTypeSize = TypeSize;
1657 
1658   // Otherwise, bump the data size up to include the bitfield,
1659   // including padding up to char alignment, and then remember how
1660   // bits we didn't use.
1661   } else {
1662     uint64_t NewSizeInBits = FieldOffset + FieldSize;
1663     uint64_t CharAlignment = Context.getTargetInfo().getCharAlign();
1664     setDataSize(llvm::RoundUpToAlignment(NewSizeInBits, CharAlignment));
1665     UnfilledBitsInLastUnit = getDataSizeInBits() - NewSizeInBits;
1666 
1667     // The only time we can get here for an ms_struct is if this is a
1668     // zero-width bitfield, which doesn't count as anything for the
1669     // purposes of unfilled bits.
1670     LastBitfieldTypeSize = 0;
1671   }
1672 
1673   // Update the size.
1674   setSize(std::max(getSizeInBits(), getDataSizeInBits()));
1675 
1676   // Remember max struct/class alignment.
1677   UpdateAlignment(Context.toCharUnitsFromBits(FieldAlign),
1678                   Context.toCharUnitsFromBits(UnpackedFieldAlign));
1679 }
1680 
1681 void RecordLayoutBuilder::LayoutField(const FieldDecl *D) {
1682   if (D->isBitField()) {
1683     LayoutBitField(D);
1684     return;
1685   }
1686 
1687   uint64_t UnpaddedFieldOffset = getDataSizeInBits() - UnfilledBitsInLastUnit;
1688 
1689   // Reset the unfilled bits.
1690   UnfilledBitsInLastUnit = 0;
1691   LastBitfieldTypeSize = 0;
1692 
1693   bool FieldPacked = Packed || D->hasAttr<PackedAttr>();
1694   CharUnits FieldOffset =
1695     IsUnion ? CharUnits::Zero() : getDataSize();
1696   CharUnits FieldSize;
1697   CharUnits FieldAlign;
1698 
1699   if (D->getType()->isIncompleteArrayType()) {
1700     // This is a flexible array member; we can't directly
1701     // query getTypeInfo about these, so we figure it out here.
1702     // Flexible array members don't have any size, but they
1703     // have to be aligned appropriately for their element type.
1704     FieldSize = CharUnits::Zero();
1705     const ArrayType* ATy = Context.getAsArrayType(D->getType());
1706     FieldAlign = Context.getTypeAlignInChars(ATy->getElementType());
1707   } else if (const ReferenceType *RT = D->getType()->getAs<ReferenceType>()) {
1708     unsigned AS = RT->getPointeeType().getAddressSpace();
1709     FieldSize =
1710       Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerWidth(AS));
1711     FieldAlign =
1712       Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerAlign(AS));
1713   } else {
1714     std::pair<CharUnits, CharUnits> FieldInfo =
1715       Context.getTypeInfoInChars(D->getType());
1716     FieldSize = FieldInfo.first;
1717     FieldAlign = FieldInfo.second;
1718 
1719     if (IsMsStruct) {
1720       // If MS bitfield layout is required, figure out what type is being
1721       // laid out and align the field to the width of that type.
1722 
1723       // Resolve all typedefs down to their base type and round up the field
1724       // alignment if necessary.
1725       QualType T = Context.getBaseElementType(D->getType());
1726       if (const BuiltinType *BTy = T->getAs<BuiltinType>()) {
1727         CharUnits TypeSize = Context.getTypeSizeInChars(BTy);
1728         if (TypeSize > FieldAlign)
1729           FieldAlign = TypeSize;
1730       }
1731     }
1732   }
1733 
1734   // The align if the field is not packed. This is to check if the attribute
1735   // was unnecessary (-Wpacked).
1736   CharUnits UnpackedFieldAlign = FieldAlign;
1737   CharUnits UnpackedFieldOffset = FieldOffset;
1738 
1739   if (FieldPacked)
1740     FieldAlign = CharUnits::One();
1741   CharUnits MaxAlignmentInChars =
1742     Context.toCharUnitsFromBits(D->getMaxAlignment());
1743   FieldAlign = std::max(FieldAlign, MaxAlignmentInChars);
1744   UnpackedFieldAlign = std::max(UnpackedFieldAlign, MaxAlignmentInChars);
1745 
1746   // The maximum field alignment overrides the aligned attribute.
1747   if (!MaxFieldAlignment.isZero()) {
1748     FieldAlign = std::min(FieldAlign, MaxFieldAlignment);
1749     UnpackedFieldAlign = std::min(UnpackedFieldAlign, MaxFieldAlignment);
1750   }
1751 
1752   // Round up the current record size to the field's alignment boundary.
1753   FieldOffset = FieldOffset.RoundUpToAlignment(FieldAlign);
1754   UnpackedFieldOffset =
1755     UnpackedFieldOffset.RoundUpToAlignment(UnpackedFieldAlign);
1756 
1757   if (ExternalLayout) {
1758     FieldOffset = Context.toCharUnitsFromBits(
1759                     updateExternalFieldOffset(D, Context.toBits(FieldOffset)));
1760 
1761     if (!IsUnion && EmptySubobjects) {
1762       // Record the fact that we're placing a field at this offset.
1763       bool Allowed = EmptySubobjects->CanPlaceFieldAtOffset(D, FieldOffset);
1764       (void)Allowed;
1765       assert(Allowed && "Externally-placed field cannot be placed here");
1766     }
1767   } else {
1768     if (!IsUnion && EmptySubobjects) {
1769       // Check if we can place the field at this offset.
1770       while (!EmptySubobjects->CanPlaceFieldAtOffset(D, FieldOffset)) {
1771         // We couldn't place the field at the offset. Try again at a new offset.
1772         FieldOffset += FieldAlign;
1773       }
1774     }
1775   }
1776 
1777   // Place this field at the current location.
1778   FieldOffsets.push_back(Context.toBits(FieldOffset));
1779 
1780   if (!ExternalLayout)
1781     CheckFieldPadding(Context.toBits(FieldOffset), UnpaddedFieldOffset,
1782                       Context.toBits(UnpackedFieldOffset),
1783                       Context.toBits(UnpackedFieldAlign), FieldPacked, D);
1784 
1785   // Reserve space for this field.
1786   uint64_t FieldSizeInBits = Context.toBits(FieldSize);
1787   if (IsUnion)
1788     setDataSize(std::max(getDataSizeInBits(), FieldSizeInBits));
1789   else
1790     setDataSize(FieldOffset + FieldSize);
1791 
1792   // Update the size.
1793   setSize(std::max(getSizeInBits(), getDataSizeInBits()));
1794 
1795   // Remember max struct/class alignment.
1796   UpdateAlignment(FieldAlign, UnpackedFieldAlign);
1797 }
1798 
1799 void RecordLayoutBuilder::FinishLayout(const NamedDecl *D) {
1800   // In C++, records cannot be of size 0.
1801   if (Context.getLangOpts().CPlusPlus && getSizeInBits() == 0) {
1802     if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
1803       // Compatibility with gcc requires a class (pod or non-pod)
1804       // which is not empty but of size 0; such as having fields of
1805       // array of zero-length, remains of Size 0
1806       if (RD->isEmpty())
1807         setSize(CharUnits::One());
1808     }
1809     else
1810       setSize(CharUnits::One());
1811   }
1812 
1813   // Finally, round the size of the record up to the alignment of the
1814   // record itself.
1815   uint64_t UnpaddedSize = getSizeInBits() - UnfilledBitsInLastUnit;
1816   uint64_t UnpackedSizeInBits =
1817   llvm::RoundUpToAlignment(getSizeInBits(),
1818                            Context.toBits(UnpackedAlignment));
1819   CharUnits UnpackedSize = Context.toCharUnitsFromBits(UnpackedSizeInBits);
1820   uint64_t RoundedSize
1821     = llvm::RoundUpToAlignment(getSizeInBits(), Context.toBits(Alignment));
1822 
1823   if (ExternalLayout) {
1824     // If we're inferring alignment, and the external size is smaller than
1825     // our size after we've rounded up to alignment, conservatively set the
1826     // alignment to 1.
1827     if (InferAlignment && ExternalSize < RoundedSize) {
1828       Alignment = CharUnits::One();
1829       InferAlignment = false;
1830     }
1831     setSize(ExternalSize);
1832     return;
1833   }
1834 
1835   // Set the size to the final size.
1836   setSize(RoundedSize);
1837 
1838   unsigned CharBitNum = Context.getTargetInfo().getCharWidth();
1839   if (const RecordDecl *RD = dyn_cast<RecordDecl>(D)) {
1840     // Warn if padding was introduced to the struct/class/union.
1841     if (getSizeInBits() > UnpaddedSize) {
1842       unsigned PadSize = getSizeInBits() - UnpaddedSize;
1843       bool InBits = true;
1844       if (PadSize % CharBitNum == 0) {
1845         PadSize = PadSize / CharBitNum;
1846         InBits = false;
1847       }
1848       Diag(RD->getLocation(), diag::warn_padded_struct_size)
1849           << Context.getTypeDeclType(RD)
1850           << PadSize
1851           << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1); // plural or not
1852     }
1853 
1854     // Warn if we packed it unnecessarily. If the alignment is 1 byte don't
1855     // bother since there won't be alignment issues.
1856     if (Packed && UnpackedAlignment > CharUnits::One() &&
1857         getSize() == UnpackedSize)
1858       Diag(D->getLocation(), diag::warn_unnecessary_packed)
1859           << Context.getTypeDeclType(RD);
1860   }
1861 }
1862 
1863 void RecordLayoutBuilder::UpdateAlignment(CharUnits NewAlignment,
1864                                           CharUnits UnpackedNewAlignment) {
1865   // The alignment is not modified when using 'mac68k' alignment or when
1866   // we have an externally-supplied layout that also provides overall alignment.
1867   if (IsMac68kAlign || (ExternalLayout && !InferAlignment))
1868     return;
1869 
1870   if (NewAlignment > Alignment) {
1871     assert(llvm::isPowerOf2_32(NewAlignment.getQuantity() &&
1872            "Alignment not a power of 2"));
1873     Alignment = NewAlignment;
1874   }
1875 
1876   if (UnpackedNewAlignment > UnpackedAlignment) {
1877     assert(llvm::isPowerOf2_32(UnpackedNewAlignment.getQuantity() &&
1878            "Alignment not a power of 2"));
1879     UnpackedAlignment = UnpackedNewAlignment;
1880   }
1881 }
1882 
1883 uint64_t
1884 RecordLayoutBuilder::updateExternalFieldOffset(const FieldDecl *Field,
1885                                                uint64_t ComputedOffset) {
1886   assert(ExternalFieldOffsets.find(Field) != ExternalFieldOffsets.end() &&
1887          "Field does not have an external offset");
1888 
1889   uint64_t ExternalFieldOffset = ExternalFieldOffsets[Field];
1890 
1891   if (InferAlignment && ExternalFieldOffset < ComputedOffset) {
1892     // The externally-supplied field offset is before the field offset we
1893     // computed. Assume that the structure is packed.
1894     Alignment = CharUnits::One();
1895     InferAlignment = false;
1896   }
1897 
1898   // Use the externally-supplied field offset.
1899   return ExternalFieldOffset;
1900 }
1901 
1902 /// \brief Get diagnostic %select index for tag kind for
1903 /// field padding diagnostic message.
1904 /// WARNING: Indexes apply to particular diagnostics only!
1905 ///
1906 /// \returns diagnostic %select index.
1907 static unsigned getPaddingDiagFromTagKind(TagTypeKind Tag) {
1908   switch (Tag) {
1909   case TTK_Struct: return 0;
1910   case TTK_Interface: return 1;
1911   case TTK_Class: return 2;
1912   default: llvm_unreachable("Invalid tag kind for field padding diagnostic!");
1913   }
1914 }
1915 
1916 void RecordLayoutBuilder::CheckFieldPadding(uint64_t Offset,
1917                                             uint64_t UnpaddedOffset,
1918                                             uint64_t UnpackedOffset,
1919                                             unsigned UnpackedAlign,
1920                                             bool isPacked,
1921                                             const FieldDecl *D) {
1922   // We let objc ivars without warning, objc interfaces generally are not used
1923   // for padding tricks.
1924   if (isa<ObjCIvarDecl>(D))
1925     return;
1926 
1927   // Don't warn about structs created without a SourceLocation.  This can
1928   // be done by clients of the AST, such as codegen.
1929   if (D->getLocation().isInvalid())
1930     return;
1931 
1932   unsigned CharBitNum = Context.getTargetInfo().getCharWidth();
1933 
1934   // Warn if padding was introduced to the struct/class.
1935   if (!IsUnion && Offset > UnpaddedOffset) {
1936     unsigned PadSize = Offset - UnpaddedOffset;
1937     bool InBits = true;
1938     if (PadSize % CharBitNum == 0) {
1939       PadSize = PadSize / CharBitNum;
1940       InBits = false;
1941     }
1942     if (D->getIdentifier())
1943       Diag(D->getLocation(), diag::warn_padded_struct_field)
1944           << getPaddingDiagFromTagKind(D->getParent()->getTagKind())
1945           << Context.getTypeDeclType(D->getParent())
1946           << PadSize
1947           << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1) // plural or not
1948           << D->getIdentifier();
1949     else
1950       Diag(D->getLocation(), diag::warn_padded_struct_anon_field)
1951           << getPaddingDiagFromTagKind(D->getParent()->getTagKind())
1952           << Context.getTypeDeclType(D->getParent())
1953           << PadSize
1954           << (InBits ? 1 : 0) /*(byte|bit)*/ << (PadSize > 1); // plural or not
1955   }
1956 
1957   // Warn if we packed it unnecessarily. If the alignment is 1 byte don't
1958   // bother since there won't be alignment issues.
1959   if (isPacked && UnpackedAlign > CharBitNum && Offset == UnpackedOffset)
1960     Diag(D->getLocation(), diag::warn_unnecessary_packed)
1961         << D->getIdentifier();
1962 }
1963 
1964 static const CXXMethodDecl *computeKeyFunction(ASTContext &Context,
1965                                                const CXXRecordDecl *RD) {
1966   // If a class isn't polymorphic it doesn't have a key function.
1967   if (!RD->isPolymorphic())
1968     return 0;
1969 
1970   // A class that is not externally visible doesn't have a key function. (Or
1971   // at least, there's no point to assigning a key function to such a class;
1972   // this doesn't affect the ABI.)
1973   if (!RD->isExternallyVisible())
1974     return 0;
1975 
1976   // Template instantiations don't have key functions,see Itanium C++ ABI 5.2.6.
1977   // Same behavior as GCC.
1978   TemplateSpecializationKind TSK = RD->getTemplateSpecializationKind();
1979   if (TSK == TSK_ImplicitInstantiation ||
1980       TSK == TSK_ExplicitInstantiationDefinition)
1981     return 0;
1982 
1983   bool allowInlineFunctions =
1984     Context.getTargetInfo().getCXXABI().canKeyFunctionBeInline();
1985 
1986   for (CXXRecordDecl::method_iterator I = RD->method_begin(),
1987          E = RD->method_end(); I != E; ++I) {
1988     const CXXMethodDecl *MD = *I;
1989 
1990     if (!MD->isVirtual())
1991       continue;
1992 
1993     if (MD->isPure())
1994       continue;
1995 
1996     // Ignore implicit member functions, they are always marked as inline, but
1997     // they don't have a body until they're defined.
1998     if (MD->isImplicit())
1999       continue;
2000 
2001     if (MD->isInlineSpecified())
2002       continue;
2003 
2004     if (MD->hasInlineBody())
2005       continue;
2006 
2007     // Ignore inline deleted or defaulted functions.
2008     if (!MD->isUserProvided())
2009       continue;
2010 
2011     // In certain ABIs, ignore functions with out-of-line inline definitions.
2012     if (!allowInlineFunctions) {
2013       const FunctionDecl *Def;
2014       if (MD->hasBody(Def) && Def->isInlineSpecified())
2015         continue;
2016     }
2017 
2018     // We found it.
2019     return MD;
2020   }
2021 
2022   return 0;
2023 }
2024 
2025 DiagnosticBuilder
2026 RecordLayoutBuilder::Diag(SourceLocation Loc, unsigned DiagID) {
2027   return Context.getDiagnostics().Report(Loc, DiagID);
2028 }
2029 
2030 /// Does the target C++ ABI require us to skip over the tail-padding
2031 /// of the given class (considering it as a base class) when allocating
2032 /// objects?
2033 static bool mustSkipTailPadding(TargetCXXABI ABI, const CXXRecordDecl *RD) {
2034   switch (ABI.getTailPaddingUseRules()) {
2035   case TargetCXXABI::AlwaysUseTailPadding:
2036     return false;
2037 
2038   case TargetCXXABI::UseTailPaddingUnlessPOD03:
2039     // FIXME: To the extent that this is meant to cover the Itanium ABI
2040     // rules, we should implement the restrictions about over-sized
2041     // bitfields:
2042     //
2043     // http://mentorembedded.github.com/cxx-abi/abi.html#POD :
2044     //   In general, a type is considered a POD for the purposes of
2045     //   layout if it is a POD type (in the sense of ISO C++
2046     //   [basic.types]). However, a POD-struct or POD-union (in the
2047     //   sense of ISO C++ [class]) with a bitfield member whose
2048     //   declared width is wider than the declared type of the
2049     //   bitfield is not a POD for the purpose of layout.  Similarly,
2050     //   an array type is not a POD for the purpose of layout if the
2051     //   element type of the array is not a POD for the purpose of
2052     //   layout.
2053     //
2054     //   Where references to the ISO C++ are made in this paragraph,
2055     //   the Technical Corrigendum 1 version of the standard is
2056     //   intended.
2057     return RD->isPOD();
2058 
2059   case TargetCXXABI::UseTailPaddingUnlessPOD11:
2060     // This is equivalent to RD->getTypeForDecl().isCXX11PODType(),
2061     // but with a lot of abstraction penalty stripped off.  This does
2062     // assume that these properties are set correctly even in C++98
2063     // mode; fortunately, that is true because we want to assign
2064     // consistently semantics to the type-traits intrinsics (or at
2065     // least as many of them as possible).
2066     return RD->isTrivial() && RD->isStandardLayout();
2067   }
2068 
2069   llvm_unreachable("bad tail-padding use kind");
2070 }
2071 
2072 static bool isMsLayout(const RecordDecl* D) {
2073   return D->getASTContext().getTargetInfo().getCXXABI().isMicrosoft();
2074 }
2075 
2076 // This section contains an implementation of struct layout that is, up to the
2077 // included tests, compatible with cl.exe (2012).  The layout produced is
2078 // significantly different than those produced by the Itanium ABI.  Here we note
2079 // the most important differences.
2080 //
2081 // * The alignment of bitfields in unions is ignored when computing the
2082 //   alignment of the union.
2083 // * The existence of zero-width bitfield that occurs after anything other than
2084 //   a non-zero length bitfield is ignored.
2085 // * The Itanium equivalent vtable pointers are split into a vfptr (virtual
2086 //   function pointer) and a vbptr (virtual base pointer).  They can each be
2087 //   shared with a, non-virtual bases. These bases need not be the same.  vfptrs
2088 //   always occur at offset 0.  vbptrs can occur at an
2089 //   arbitrary offset and are placed after non-virtual bases but before fields.
2090 // * Virtual bases sometimes require a 'vtordisp' field that is laid out before
2091 //   the virtual base and is used in conjunction with virtual overrides during
2092 //   construction and destruction.
2093 // * vfptrs are allocated in a block of memory equal to the alignment of the
2094 //   fields and non-virtual bases at offset 0 in 32 bit mode and in a pointer
2095 //   sized block of memory in 64 bit mode.
2096 // * vbptrs are allocated in a block of memory equal to the alignment of the
2097 //   fields and non-virtual bases.  This block is at a potentially unaligned
2098 //   offset.  If the allocation slot is unaligned and the alignment is less than
2099 //   or equal to the pointer size, additional space is allocated so that the
2100 //   pointer can be aligned properly.  This causes very strange effects on the
2101 //   placement of objects after the allocated block. (see the code).
2102 // * vtordisps are allocated in a block of memory with size and alignment equal
2103 //   to the alignment of the completed structure (before applying __declspec(
2104 //   align())).  The vtordisp always occur at the end of the allocation block,
2105 //   immediately prior to the virtual base.
2106 // * The last zero sized non-virtual base is allocated after the placement of
2107 //   vbptr if one exists and can be placed at the end of the struct, potentially
2108 //   aliasing either the first member or another struct allocated after this
2109 //   one.
2110 // * The last zero size virtual base may be placed at the end of the struct.
2111 //   and can potentially alias a zero sized type in the next struct.
2112 // * If the last field is a non-zero length bitfield, all virtual bases will
2113 //   have extra padding added before them for no obvious reason.  The padding
2114 //   has the same number of bits as the type of the bitfield.
2115 // * When laying out empty non-virtual bases, an extra byte of padding is added
2116 //   if the non-virtual base before the empty non-virtual base has a vbptr.
2117 // * The ABI attempts to avoid aliasing of zero sized bases by adding padding
2118 //   between bases or vbases with specific properties.  The criteria for
2119 //   additional padding between two bases is that the first base is zero sized
2120 //   or has a zero sized subobject and the second base is zero sized or leads
2121 //   with a zero sized base (sharing of vfptrs can reorder the layout of the
2122 //   so the leading base is not always the first one declared).  The padding
2123 //   added for bases is 1 byte.  The padding added for vbases depends on the
2124 //   alignment of the object but is at least 4 bytes (in both 32 and 64 bit
2125 //   modes).
2126 // * There is no concept of non-virtual alignment or any distinction between
2127 //   data size and non-virtual size.
2128 // * __declspec(align) on bitfields has the effect of changing the bitfield's
2129 //   alignment instead of its required alignment.  This has implications on how
2130 //   it interacts with pragam pack.
2131 
2132 namespace {
2133 struct MicrosoftRecordLayoutBuilder {
2134   struct ElementInfo {
2135     CharUnits Size;
2136     CharUnits Alignment;
2137   };
2138   typedef llvm::DenseMap<const CXXRecordDecl *, CharUnits> BaseOffsetsMapTy;
2139   MicrosoftRecordLayoutBuilder(const ASTContext &Context) : Context(Context) {}
2140 private:
2141   MicrosoftRecordLayoutBuilder(const MicrosoftRecordLayoutBuilder &)
2142   LLVM_DELETED_FUNCTION;
2143   void operator=(const MicrosoftRecordLayoutBuilder &) LLVM_DELETED_FUNCTION;
2144 public:
2145   void layout(const RecordDecl *RD);
2146   void cxxLayout(const CXXRecordDecl *RD);
2147   /// \brief Initializes size and alignment and honors some flags.
2148   void initializeLayout(const RecordDecl *RD);
2149   /// \brief Initialized C++ layout, compute alignment and virtual alignment and
2150   /// existence of vfptrs and vbptrs.  Alignment is needed before the vfptr is
2151   /// laid out.
2152   void initializeCXXLayout(const CXXRecordDecl *RD);
2153   void layoutNonVirtualBases(const CXXRecordDecl *RD);
2154   void layoutNonVirtualBase(const CXXRecordDecl *BaseDecl,
2155                             const ASTRecordLayout &BaseLayout,
2156                             const ASTRecordLayout *&PreviousBaseLayout);
2157   void injectVFPtr(const CXXRecordDecl *RD);
2158   void injectVBPtr(const CXXRecordDecl *RD);
2159   void injectVPtrs(const CXXRecordDecl *RD);
2160   /// \brief Lays out the fields of the record.  Also rounds size up to
2161   /// alignment.
2162   void layoutFields(const RecordDecl *RD);
2163   void layoutField(const FieldDecl *FD);
2164   void layoutBitField(const FieldDecl *FD);
2165   /// \brief Lays out a single zero-width bit-field in the record and handles
2166   /// special cases associated with zero-width bit-fields.
2167   void layoutZeroWidthBitField(const FieldDecl *FD);
2168   void layoutVirtualBases(const CXXRecordDecl *RD);
2169   void finalizeLayout(const RecordDecl *RD);
2170   /// \brief Gets the size and alignment of a base taking pragma pack and
2171   /// __declspec(align) into account.
2172   ElementInfo getAdjustedElementInfo(const ASTRecordLayout &Layout,
2173                                      bool AsBase = true);
2174   /// \brief Gets the size and alignment of a field taking pragma  pack and
2175   /// __declspec(align) into account.  It also updates RequiredAlignment as a
2176   /// side effect because it is most convenient to do so here.
2177   ElementInfo getAdjustedElementInfo(const FieldDecl *FD);
2178   /// \brief Places a field at an offset in CharUnits.
2179   void placeFieldAtOffset(CharUnits FieldOffset) {
2180     FieldOffsets.push_back(Context.toBits(FieldOffset));
2181   }
2182   /// \brief Places a bitfield at a bit offset.
2183   void placeFieldAtBitOffset(uint64_t FieldOffset) {
2184     FieldOffsets.push_back(FieldOffset);
2185   }
2186   /// \brief Compute the set of virtual bases for which vtordisps are required.
2187   llvm::SmallPtrSet<const CXXRecordDecl *, 2>
2188   computeVtorDispSet(const CXXRecordDecl *RD);
2189   const ASTContext &Context;
2190   /// \brief The size of the record being laid out.
2191   CharUnits Size;
2192   /// \brief The non-virtual size of the record layout.
2193   CharUnits NonVirtualSize;
2194   /// \brief The data size of the record layout.
2195   CharUnits DataSize;
2196   /// \brief The current alignment of the record layout.
2197   CharUnits Alignment;
2198   /// \brief The maximum allowed field alignment. This is set by #pragma pack.
2199   CharUnits MaxFieldAlignment;
2200   /// \brief The alignment that this record must obey.  This is imposed by
2201   /// __declspec(align()) on the record itself or one of its fields or bases.
2202   CharUnits RequiredAlignment;
2203   /// \brief The size of the allocation of the currently active bitfield.
2204   /// This value isn't meaningful unless LastFieldIsNonZeroWidthBitfield
2205   /// is true.
2206   CharUnits CurrentBitfieldSize;
2207   /// \brief Offset to the virtual base table pointer (if one exists).
2208   CharUnits VBPtrOffset;
2209   /// \brief The size and alignment info of a pointer.
2210   ElementInfo PointerInfo;
2211   /// \brief The primary base class (if one exists).
2212   const CXXRecordDecl *PrimaryBase;
2213   /// \brief The class we share our vb-pointer with.
2214   const CXXRecordDecl *SharedVBPtrBase;
2215   /// \brief The collection of field offsets.
2216   SmallVector<uint64_t, 16> FieldOffsets;
2217   /// \brief Base classes and their offsets in the record.
2218   BaseOffsetsMapTy Bases;
2219   /// \brief virtual base classes and their offsets in the record.
2220   ASTRecordLayout::VBaseOffsetsMapTy VBases;
2221   /// \brief The number of remaining bits in our last bitfield allocation.
2222   /// This value isn't meaningful unless LastFieldIsNonZeroWidthBitfield is
2223   /// true.
2224   unsigned RemainingBitsInField;
2225   bool IsUnion : 1;
2226   /// \brief True if the last field laid out was a bitfield and was not 0
2227   /// width.
2228   bool LastFieldIsNonZeroWidthBitfield : 1;
2229   /// \brief True if the class has its own vftable pointer.
2230   bool HasOwnVFPtr : 1;
2231   /// \brief True if the class has a vbtable pointer.
2232   bool HasVBPtr : 1;
2233   /// \brief Lets us know if we're in 64-bit mode
2234   bool Is64BitMode : 1;
2235   /// \brief True if this class contains a zero sized member or base or a base
2236   /// with a zero sized member or base.  Only used for MS-ABI.
2237   bool HasZeroSizedSubObject : 1;
2238   /// \brief True if this class is zero sized or first base is zero sized or
2239   /// has this property.  Only used for MS-ABI.
2240   bool LeadsWithZeroSizedBase : 1;
2241 };
2242 } // namespace
2243 
2244 MicrosoftRecordLayoutBuilder::ElementInfo
2245 MicrosoftRecordLayoutBuilder::getAdjustedElementInfo(
2246     const ASTRecordLayout &Layout, bool AsBase) {
2247   ElementInfo Info;
2248   Info.Alignment = Layout.getAlignment();
2249   // Respect pragma pack.
2250   if (!MaxFieldAlignment.isZero())
2251     Info.Alignment = std::min(Info.Alignment, MaxFieldAlignment);
2252   // Track zero-sized subobjects here where it's already available.
2253   if (Layout.hasZeroSizedSubObject())
2254     HasZeroSizedSubObject = true;
2255   // Respect required alignment, this is necessary because we may have adjusted
2256   // the alignment in the case of pragam pack.  Note that the required alignment
2257   // doesn't actually apply to the struct alignment at this point.
2258   Alignment = std::max(Alignment, Info.Alignment);
2259   Info.Alignment = std::max(Info.Alignment, Layout.getRequiredAlignment());
2260   Info.Size = AsBase ? Layout.getNonVirtualSize() : Layout.getSize();
2261   return Info;
2262 }
2263 
2264 MicrosoftRecordLayoutBuilder::ElementInfo
2265 MicrosoftRecordLayoutBuilder::getAdjustedElementInfo(
2266     const FieldDecl *FD) {
2267   ElementInfo Info;
2268   std::tie(Info.Size, Info.Alignment) =
2269       Context.getTypeInfoInChars(FD->getType());
2270   // Respect align attributes.
2271   CharUnits FieldRequiredAlignment =
2272       Context.toCharUnitsFromBits(FD->getMaxAlignment());
2273   // Respect attributes applied to subobjects of the field.
2274   if (const RecordType *RT =
2275       FD->getType()->getBaseElementTypeUnsafe()->getAs<RecordType>()) {
2276     const ASTRecordLayout &Layout = Context.getASTRecordLayout(RT->getDecl());
2277     // Get the element info for a layout, respecting pack.
2278     Info.Alignment = getAdjustedElementInfo(Layout, false).Alignment;
2279     // Capture required alignment as a side-effect.
2280     RequiredAlignment = std::max(RequiredAlignment,
2281                                  Layout.getRequiredAlignment());
2282   } else {
2283     if (FD->isBitField() && FD->getMaxAlignment() != 0)
2284       Info.Alignment = std::max(Info.Alignment, FieldRequiredAlignment);
2285     // Respect pragma pack.
2286     if (!MaxFieldAlignment.isZero())
2287       Info.Alignment = std::min(Info.Alignment, MaxFieldAlignment);
2288   }
2289   // Respect packed field attribute.
2290   if (FD->hasAttr<PackedAttr>())
2291     Info.Alignment = CharUnits::One();
2292   // Take required alignment into account.  __declspec(align) on bitfields
2293   // impacts the alignment rather than the required alignment.
2294   if (!FD->isBitField()) {
2295     Info.Alignment = std::max(Info.Alignment, FieldRequiredAlignment);
2296     // Capture required alignment as a side-effect.
2297     RequiredAlignment = std::max(RequiredAlignment, FieldRequiredAlignment);
2298   }
2299   // TODO: Add a Sema warning that MS ignores bitfield alignment in unions.
2300   if (!(FD->isBitField() && IsUnion)) {
2301     Alignment = std::max(Alignment, Info.Alignment);
2302     if (!MaxFieldAlignment.isZero())
2303       Alignment = std::min(Alignment, MaxFieldAlignment);
2304   }
2305   return Info;
2306 }
2307 
2308 void MicrosoftRecordLayoutBuilder::layout(const RecordDecl *RD) {
2309   initializeLayout(RD);
2310   layoutFields(RD);
2311   DataSize = Size = Size.RoundUpToAlignment(Alignment);
2312   RequiredAlignment = std::max(
2313       RequiredAlignment, Context.toCharUnitsFromBits(RD->getMaxAlignment()));
2314   finalizeLayout(RD);
2315 }
2316 
2317 void MicrosoftRecordLayoutBuilder::cxxLayout(const CXXRecordDecl *RD) {
2318   initializeLayout(RD);
2319   initializeCXXLayout(RD);
2320   layoutNonVirtualBases(RD);
2321   layoutFields(RD);
2322   injectVPtrs(RD);
2323   NonVirtualSize = Size = Size.RoundUpToAlignment(Alignment);
2324   RequiredAlignment = std::max(
2325       RequiredAlignment, Context.toCharUnitsFromBits(RD->getMaxAlignment()));
2326   layoutVirtualBases(RD);
2327   finalizeLayout(RD);
2328 }
2329 
2330 void MicrosoftRecordLayoutBuilder::initializeLayout(const RecordDecl *RD) {
2331   IsUnion = RD->isUnion();
2332   Is64BitMode = Context.getTargetInfo().getPointerWidth(0) == 64;
2333   Size = CharUnits::Zero();
2334   Alignment = CharUnits::One();
2335   // In 64-bit mode we always perform an alignment step after laying out vbases.
2336   // In 32-bit mode we do not.  The check to see if we need to perform alignment
2337   // checks the RequiredAlignment field and performs alignment if it isn't 0.
2338   RequiredAlignment = Is64BitMode ? CharUnits::One() : CharUnits::Zero();
2339   // Compute the maximum field alignment.
2340   MaxFieldAlignment = CharUnits::Zero();
2341   // Honor the default struct packing maximum alignment flag.
2342   if (unsigned DefaultMaxFieldAlignment = Context.getLangOpts().PackStruct)
2343       MaxFieldAlignment = CharUnits::fromQuantity(DefaultMaxFieldAlignment);
2344   // Honor the packing attribute.  The MS-ABI ignores pragma pack if its larger
2345   // than the pointer size.
2346   if (const MaxFieldAlignmentAttr *MFAA = RD->getAttr<MaxFieldAlignmentAttr>()){
2347     unsigned PackedAlignment = MFAA->getAlignment();
2348     if (PackedAlignment <= Context.getTargetInfo().getPointerWidth(0))
2349       MaxFieldAlignment = Context.toCharUnitsFromBits(PackedAlignment);
2350   }
2351   // Packed attribute forces max field alignment to be 1.
2352   if (RD->hasAttr<PackedAttr>())
2353     MaxFieldAlignment = CharUnits::One();
2354 }
2355 
2356 void
2357 MicrosoftRecordLayoutBuilder::initializeCXXLayout(const CXXRecordDecl *RD) {
2358   HasZeroSizedSubObject = false;
2359   LeadsWithZeroSizedBase = false;
2360   HasOwnVFPtr = false;
2361   HasVBPtr = false;
2362   PrimaryBase = 0;
2363   SharedVBPtrBase = 0;
2364   // Calculate pointer size and alignment.  These are used for vfptr and vbprt
2365   // injection.
2366   PointerInfo.Size =
2367       Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerWidth(0));
2368   PointerInfo.Alignment = PointerInfo.Size;
2369   // Respect pragma pack.
2370   if (!MaxFieldAlignment.isZero())
2371     PointerInfo.Alignment = std::min(PointerInfo.Alignment, MaxFieldAlignment);
2372 }
2373 
2374 void
2375 MicrosoftRecordLayoutBuilder::layoutNonVirtualBases(const CXXRecordDecl *RD) {
2376   // The MS-ABI lays out all bases that contain leading vfptrs before it lays
2377   // out any bases that do not contain vfptrs.  We implement this as two passes
2378   // over the bases.  This approach guarantees that the primary base is laid out
2379   // first.  We use these passes to calculate some additional aggregated
2380   // information about the bases, such as reqruied alignment and the presence of
2381   // zero sized members.
2382   const ASTRecordLayout* PreviousBaseLayout = 0;
2383   // Iterate through the bases and lay out the non-virtual ones.
2384   for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
2385                                                 e = RD->bases_end();
2386        i != e; ++i) {
2387     const CXXRecordDecl *BaseDecl = i->getType()->getAsCXXRecordDecl();
2388     const ASTRecordLayout &BaseLayout = Context.getASTRecordLayout(BaseDecl);
2389     // Mark and skip virtual bases.
2390     if (i->isVirtual()) {
2391       HasVBPtr = true;
2392       continue;
2393     }
2394     // Track RequiredAlignment for all bases in this pass.
2395     RequiredAlignment = std::max(RequiredAlignment,
2396                                  BaseLayout.getRequiredAlignment());
2397     // Check fo a base to share a VBPtr with.
2398     if (!SharedVBPtrBase && BaseLayout.hasVBPtr()) {
2399       SharedVBPtrBase = BaseDecl;
2400       HasVBPtr = true;
2401     }
2402     // Only lay out bases with extendable VFPtrs on the first pass.
2403     if (!BaseLayout.hasExtendableVFPtr())
2404       continue;
2405     // If we don't have a primary base, this one qualifies.
2406     if (!PrimaryBase) {
2407       PrimaryBase = BaseDecl;
2408       LeadsWithZeroSizedBase = BaseLayout.leadsWithZeroSizedBase();
2409     }
2410     // Lay out the base.
2411     layoutNonVirtualBase(BaseDecl, BaseLayout, PreviousBaseLayout);
2412   }
2413   // Figure out if we need a fresh VFPtr for this class.
2414   if (!PrimaryBase && RD->isDynamicClass())
2415     for (CXXRecordDecl::method_iterator i = RD->method_begin(),
2416                                         e = RD->method_end();
2417          !HasOwnVFPtr && i != e; ++i)
2418       HasOwnVFPtr = i->isVirtual() && i->size_overridden_methods() == 0;
2419   // If we don't have a primary base then we have a leading object that could
2420   // itself lead with a zero-sized object, something we track.
2421   bool CheckLeadingLayout = !PrimaryBase;
2422   // Iterate through the bases and lay out the non-virtual ones.
2423   for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
2424                                                 e = RD->bases_end();
2425        i != e; ++i) {
2426     if (i->isVirtual())
2427       continue;
2428     const CXXRecordDecl *BaseDecl = i->getType()->getAsCXXRecordDecl();
2429     const ASTRecordLayout &BaseLayout = Context.getASTRecordLayout(BaseDecl);
2430     // Only lay out bases without extendable VFPtrs on the second pass.
2431     if (BaseLayout.hasExtendableVFPtr())
2432       continue;
2433     // If this is the first layout, check to see if it leads with a zero sized
2434     // object.  If it does, so do we.
2435     if (CheckLeadingLayout) {
2436       CheckLeadingLayout = false;
2437       LeadsWithZeroSizedBase = BaseLayout.leadsWithZeroSizedBase();
2438     }
2439     // Lay out the base.
2440     layoutNonVirtualBase(BaseDecl, BaseLayout, PreviousBaseLayout);
2441   }
2442   // Set our VBPtroffset if we know it at this point.
2443   if (!HasVBPtr)
2444     VBPtrOffset = CharUnits::fromQuantity(-1);
2445   else if (SharedVBPtrBase) {
2446     const ASTRecordLayout &Layout = Context.getASTRecordLayout(SharedVBPtrBase);
2447     VBPtrOffset = Bases[SharedVBPtrBase] + Layout.getVBPtrOffset();
2448   }
2449 }
2450 
2451 void MicrosoftRecordLayoutBuilder::layoutNonVirtualBase(
2452     const CXXRecordDecl *BaseDecl,
2453     const ASTRecordLayout &BaseLayout,
2454     const ASTRecordLayout *&PreviousBaseLayout) {
2455   // Insert padding between two bases if the left first one is zero sized or
2456   // contains a zero sized subobject and the right is zero sized or one leads
2457   // with a zero sized base.
2458   if (PreviousBaseLayout && PreviousBaseLayout->hasZeroSizedSubObject() &&
2459       BaseLayout.leadsWithZeroSizedBase())
2460     Size++;
2461   ElementInfo Info = getAdjustedElementInfo(BaseLayout);
2462   CharUnits BaseOffset = Size.RoundUpToAlignment(Info.Alignment);
2463   Bases.insert(std::make_pair(BaseDecl, BaseOffset));
2464   Size = BaseOffset + BaseLayout.getNonVirtualSize();
2465   PreviousBaseLayout = &BaseLayout;
2466   VBPtrOffset = Size;
2467 }
2468 
2469 void MicrosoftRecordLayoutBuilder::layoutFields(const RecordDecl *RD) {
2470   LastFieldIsNonZeroWidthBitfield = false;
2471   for (RecordDecl::field_iterator Field = RD->field_begin(),
2472                                   FieldEnd = RD->field_end();
2473        Field != FieldEnd; ++Field)
2474     layoutField(*Field);
2475 }
2476 
2477 void MicrosoftRecordLayoutBuilder::layoutField(const FieldDecl *FD) {
2478   if (FD->isBitField()) {
2479     layoutBitField(FD);
2480     return;
2481   }
2482   LastFieldIsNonZeroWidthBitfield = false;
2483   ElementInfo Info = getAdjustedElementInfo(FD);
2484   if (IsUnion) {
2485     placeFieldAtOffset(CharUnits::Zero());
2486     Size = std::max(Size, Info.Size);
2487   } else {
2488     CharUnits FieldOffset = Size.RoundUpToAlignment(Info.Alignment);
2489     placeFieldAtOffset(FieldOffset);
2490     Size = FieldOffset + Info.Size;
2491   }
2492 }
2493 
2494 void MicrosoftRecordLayoutBuilder::layoutBitField(const FieldDecl *FD) {
2495   unsigned Width = FD->getBitWidthValue(Context);
2496   if (Width == 0) {
2497     layoutZeroWidthBitField(FD);
2498     return;
2499   }
2500   ElementInfo Info = getAdjustedElementInfo(FD);
2501   // Clamp the bitfield to a containable size for the sake of being able
2502   // to lay them out.  Sema will throw an error.
2503   if (Width > Context.toBits(Info.Size))
2504     Width = Context.toBits(Info.Size);
2505   // Check to see if this bitfield fits into an existing allocation.  Note:
2506   // MSVC refuses to pack bitfields of formal types with different sizes
2507   // into the same allocation.
2508   if (!IsUnion && LastFieldIsNonZeroWidthBitfield &&
2509       CurrentBitfieldSize == Info.Size && Width <= RemainingBitsInField) {
2510     placeFieldAtBitOffset(Context.toBits(Size) - RemainingBitsInField);
2511     RemainingBitsInField -= Width;
2512     return;
2513   }
2514   LastFieldIsNonZeroWidthBitfield = true;
2515   CurrentBitfieldSize = Info.Size;
2516   if (IsUnion) {
2517     placeFieldAtOffset(CharUnits::Zero());
2518     Size = std::max(Size, Info.Size);
2519   } else {
2520     // Allocate a new block of memory and place the bitfield in it.
2521     CharUnits FieldOffset = Size.RoundUpToAlignment(Info.Alignment);
2522     placeFieldAtOffset(FieldOffset);
2523     Size = FieldOffset + Info.Size;
2524     RemainingBitsInField = Context.toBits(Info.Size) - Width;
2525   }
2526 }
2527 
2528 void
2529 MicrosoftRecordLayoutBuilder::layoutZeroWidthBitField(const FieldDecl *FD) {
2530   // Zero-width bitfields are ignored unless they follow a non-zero-width
2531   // bitfield.
2532   if (!LastFieldIsNonZeroWidthBitfield) {
2533     placeFieldAtOffset(IsUnion ? CharUnits::Zero() : Size);
2534     // TODO: Add a Sema warning that MS ignores alignment for zero
2535     // sized bitfields that occur after zero-size bitfields or non-bitfields.
2536     return;
2537   }
2538   LastFieldIsNonZeroWidthBitfield = false;
2539   ElementInfo Info = getAdjustedElementInfo(FD);
2540   if (IsUnion) {
2541     placeFieldAtOffset(CharUnits::Zero());
2542     Size = std::max(Size, Info.Size);
2543   } else {
2544     // Round up the current record size to the field's alignment boundary.
2545     CharUnits FieldOffset = Size.RoundUpToAlignment(Info.Alignment);
2546     placeFieldAtOffset(FieldOffset);
2547     Size = FieldOffset;
2548   }
2549 }
2550 
2551 void MicrosoftRecordLayoutBuilder::injectVBPtr(const CXXRecordDecl *RD) {
2552   if (!HasVBPtr || SharedVBPtrBase)
2553     return;
2554   // Inject the VBPointer at the injection site.
2555   CharUnits InjectionSite = VBPtrOffset;
2556   // But before we do, make sure it's properly aligned.
2557   VBPtrOffset = VBPtrOffset.RoundUpToAlignment(PointerInfo.Alignment);
2558   // Determine where the first field should be laid out after the vbptr.
2559   CharUnits FieldStart = VBPtrOffset + PointerInfo.Size;
2560   // Make sure that the amount we push the fields back by is a multiple of the
2561   // alignment.
2562   CharUnits Offset = (FieldStart - InjectionSite).RoundUpToAlignment(
2563       std::max(RequiredAlignment, Alignment));
2564   // Increase the size of the object and push back all fields by the offset
2565   // amount.
2566   Size += Offset;
2567   for (SmallVector<uint64_t, 16>::iterator i = FieldOffsets.begin(),
2568                                            e = FieldOffsets.end();
2569        i != e; ++i)
2570     *i += Context.toBits(Offset);
2571   for (BaseOffsetsMapTy::iterator i = Bases.begin(), e = Bases.end();
2572        i != e; ++i)
2573        if (i->second >= InjectionSite)
2574          i->second += Offset;
2575 }
2576 
2577 void MicrosoftRecordLayoutBuilder::injectVFPtr(const CXXRecordDecl *RD) {
2578   if (!HasOwnVFPtr)
2579     return;
2580   // Make sure that the amount we push the struct back by is a multiple of the
2581   // alignment.
2582   CharUnits Offset = PointerInfo.Size.RoundUpToAlignment(
2583       std::max(RequiredAlignment, Alignment));
2584   // Increase the size of the object and push back all fields, the vbptr and all
2585   // bases by the offset amount.
2586   Size += Offset;
2587   for (SmallVectorImpl<uint64_t>::iterator i = FieldOffsets.begin(),
2588                                            e = FieldOffsets.end();
2589        i != e; ++i)
2590     *i += Context.toBits(Offset);
2591   if (HasVBPtr)
2592     VBPtrOffset += Offset;
2593   for (BaseOffsetsMapTy::iterator i = Bases.begin(), e = Bases.end();
2594        i != e; ++i)
2595     i->second += Offset;
2596 }
2597 
2598 void MicrosoftRecordLayoutBuilder::injectVPtrs(const CXXRecordDecl *RD) {
2599   if (!(HasOwnVFPtr || (HasVBPtr && !SharedVBPtrBase)))
2600     return;
2601   if (!Is64BitMode || RequiredAlignment <= CharUnits::fromQuantity(8)) {
2602     // Note that the VBPtr is injected first.  It depends on the alignment of
2603     // the object *before* the alignment is updated by inserting a pointer into
2604     // the record.
2605     injectVBPtr(RD);
2606     injectVFPtr(RD);
2607     Alignment = std::max(Alignment, PointerInfo.Alignment);
2608     return;
2609   }
2610   // In 64-bit mode, structs with RequiredAlignment greater than 8 get special
2611   // layout rules.  Likely this is to avoid excessive padding intruced around
2612   // the vfptrs and vbptrs.  The special rules involve re-laying out the struct
2613   // and inserting the vfptr and vbptr as if they were fields/bases.
2614   FieldOffsets.clear();
2615   Bases.clear();
2616   Size = CharUnits::Zero();
2617   Alignment = std::max(Alignment, PointerInfo.Alignment);
2618   if (HasOwnVFPtr)
2619     Size = PointerInfo.Size;
2620   layoutNonVirtualBases(RD);
2621   if (HasVBPtr && !SharedVBPtrBase) {
2622     const CXXRecordDecl *PenultBaseDecl = 0;
2623     const CXXRecordDecl *LastBaseDecl = 0;
2624     // Iterate through the bases and find the last two non-virtual bases.
2625     for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
2626                                                   e = RD->bases_end();
2627           i != e; ++i) {
2628       if (i->isVirtual())
2629         continue;
2630       const CXXRecordDecl *BaseDecl = i->getType()->getAsCXXRecordDecl();
2631       if (!LastBaseDecl || Bases[BaseDecl] > Bases[LastBaseDecl]) {
2632         PenultBaseDecl = LastBaseDecl;
2633         LastBaseDecl = BaseDecl;
2634       }
2635     }
2636     const ASTRecordLayout *PenultBaseLayout = PenultBaseDecl ?
2637         &Context.getASTRecordLayout(PenultBaseDecl) : 0;
2638     const ASTRecordLayout *LastBaseLayout = LastBaseDecl ?
2639         &Context.getASTRecordLayout(LastBaseDecl) : 0;
2640     // Calculate the vbptr offset.  The rule is different than in the general
2641     // case layout.  Particularly, if the last two non-virtual bases are both
2642     // zero sized, the site of the vbptr is *before* the padding that occurs
2643     // between the two zero sized bases and the vbptr potentially aliases with
2644     // the first of these two bases.  We have no understanding of why this is
2645     // different from the general case layout but it may have to do with lazy
2646     // placement of zero sized bases.
2647     VBPtrOffset = Size;
2648     if (LastBaseLayout && LastBaseLayout->getNonVirtualSize().isZero()) {
2649       VBPtrOffset = Bases[LastBaseDecl];
2650       if (PenultBaseLayout && PenultBaseLayout->getNonVirtualSize().isZero())
2651         VBPtrOffset = Bases[PenultBaseDecl];
2652     }
2653     // Once we've located a spot for the vbptr, place it.
2654     VBPtrOffset = VBPtrOffset.RoundUpToAlignment(PointerInfo.Alignment);
2655     Size = VBPtrOffset + PointerInfo.Size;
2656     if (LastBaseLayout && LastBaseLayout->getNonVirtualSize().isZero()) {
2657       // Add the padding between zero sized bases after the vbptr.
2658       if (PenultBaseLayout && PenultBaseLayout->getNonVirtualSize().isZero())
2659         Size += CharUnits::One();
2660       Size = Size.RoundUpToAlignment(LastBaseLayout->getRequiredAlignment());
2661       Bases[LastBaseDecl] = Size;
2662     }
2663   }
2664   layoutFields(RD);
2665   // The presence of a vbptr suppresses zero sized objects that are not in
2666   // virtual bases.
2667   HasZeroSizedSubObject = false;
2668 }
2669 
2670 void MicrosoftRecordLayoutBuilder::layoutVirtualBases(const CXXRecordDecl *RD) {
2671   if (!HasVBPtr)
2672     return;
2673   // Vtordisps are always 4 bytes (even in 64-bit mode)
2674   CharUnits VtorDispSize = CharUnits::fromQuantity(4);
2675   CharUnits VtorDispAlignment = VtorDispSize;
2676   // vtordisps respect pragma pack.
2677   if (!MaxFieldAlignment.isZero())
2678     VtorDispAlignment = std::min(VtorDispAlignment, MaxFieldAlignment);
2679   // The alignment of the vtordisp is at least the required alignment of the
2680   // entire record.  This requirement may be present to support vtordisp
2681   // injection.
2682   for (CXXRecordDecl::base_class_const_iterator i = RD->vbases_begin(),
2683                                                 e = RD->vbases_end();
2684        i != e; ++i) {
2685     const CXXRecordDecl *BaseDecl = i->getType()->getAsCXXRecordDecl();
2686     const ASTRecordLayout &BaseLayout = Context.getASTRecordLayout(BaseDecl);
2687     RequiredAlignment =
2688         std::max(RequiredAlignment, BaseLayout.getRequiredAlignment());
2689   }
2690   VtorDispAlignment = std::max(VtorDispAlignment, RequiredAlignment);
2691   // Compute the vtordisp set.
2692   llvm::SmallPtrSet<const CXXRecordDecl *, 2> HasVtordispSet =
2693       computeVtorDispSet(RD);
2694   // Iterate through the virtual bases and lay them out.
2695   const ASTRecordLayout* PreviousBaseLayout = 0;
2696   for (CXXRecordDecl::base_class_const_iterator i = RD->vbases_begin(),
2697                                                 e = RD->vbases_end();
2698        i != e; ++i) {
2699     const CXXRecordDecl *BaseDecl = i->getType()->getAsCXXRecordDecl();
2700     const ASTRecordLayout &BaseLayout = Context.getASTRecordLayout(BaseDecl);
2701     bool HasVtordisp = HasVtordispSet.count(BaseDecl);
2702     // If the last field we laid out was a non-zero length bitfield then add
2703     // some extra padding for no obvious reason.
2704     if (LastFieldIsNonZeroWidthBitfield)
2705       Size += CurrentBitfieldSize;
2706     // Insert padding between two bases if the left first one is zero sized or
2707     // contains a zero sized subobject and the right is zero sized or one leads
2708     // with a zero sized base.  The padding between virtual bases is 4
2709     // bytes (in both 32 and 64 bits modes) and always involves rounding up to
2710     // the required alignment, we don't know why.
2711     if (PreviousBaseLayout && PreviousBaseLayout->hasZeroSizedSubObject() &&
2712         BaseLayout.leadsWithZeroSizedBase())
2713       Size = Size.RoundUpToAlignment(VtorDispAlignment) + VtorDispSize;
2714     // Insert the vtordisp.
2715     if (HasVtordisp)
2716       Size = Size.RoundUpToAlignment(VtorDispAlignment) + VtorDispSize;
2717     // Insert the virtual base.
2718     HasZeroSizedSubObject = false;
2719     ElementInfo Info = getAdjustedElementInfo(BaseLayout);
2720     CharUnits BaseOffset = Size.RoundUpToAlignment(Info.Alignment);
2721     VBases.insert(std::make_pair(BaseDecl,
2722         ASTRecordLayout::VBaseInfo(BaseOffset, HasVtordisp)));
2723     Size = BaseOffset + BaseLayout.getNonVirtualSize();
2724     PreviousBaseLayout = &BaseLayout;
2725   }
2726 }
2727 
2728 void MicrosoftRecordLayoutBuilder::finalizeLayout(const RecordDecl *RD) {
2729   // Respect required alignment.  Note that in 32-bit mode Required alignment
2730   // may be 0 nad cause size not to be updated.
2731   DataSize = Size;
2732   if (!RequiredAlignment.isZero()) {
2733     Alignment = std::max(Alignment, RequiredAlignment);
2734     Size = Size.RoundUpToAlignment(Alignment);
2735   }
2736   // Zero-sized structures have size equal to their alignment.
2737   if (Size.isZero()) {
2738     HasZeroSizedSubObject = true;
2739     LeadsWithZeroSizedBase = true;
2740     Size = Alignment;
2741   }
2742 }
2743 
2744 static bool
2745 RequiresVtordisp(const llvm::SmallPtrSet<const CXXRecordDecl *, 2> &HasVtordisp,
2746                  const CXXRecordDecl *RD) {
2747   if (HasVtordisp.count(RD))
2748     return true;
2749   // If any of a virtual bases non-virtual bases (recursively) requires a
2750   // vtordisp than so does this virtual base.
2751   for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
2752                                                 e = RD->bases_end();
2753        i != e; ++i)
2754     if (!i->isVirtual() &&
2755         RequiresVtordisp(
2756             HasVtordisp,
2757             cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl())))
2758       return true;
2759   return false;
2760 }
2761 
2762 llvm::SmallPtrSet<const CXXRecordDecl *, 2>
2763 MicrosoftRecordLayoutBuilder::computeVtorDispSet(const CXXRecordDecl *RD) {
2764   llvm::SmallPtrSet<const CXXRecordDecl *, 2> HasVtordispSet;
2765 
2766   // /vd0 or #pragma vtordisp(0): Never use vtordisps when used as a vbase.
2767   if (RD->getMSVtorDispMode() == MSVtorDispAttr::Never)
2768     return HasVtordispSet;
2769 
2770   // /vd2 or #pragma vtordisp(2): Always use vtordisps for virtual bases with
2771   // vftables.
2772   if (RD->getMSVtorDispMode() == MSVtorDispAttr::ForVFTable) {
2773     for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
2774                                                   E = RD->vbases_end();
2775          I != E; ++I) {
2776       const CXXRecordDecl *BaseDecl = I->getType()->getAsCXXRecordDecl();
2777       const ASTRecordLayout &Layout = Context.getASTRecordLayout(BaseDecl);
2778       if (Layout.hasExtendableVFPtr())
2779         HasVtordispSet.insert(BaseDecl);
2780     }
2781     return HasVtordispSet;
2782   }
2783 
2784   // /vd1 or #pragma vtordisp(1): Try to guess based on whether we think it's
2785   // possible for a partially constructed object with virtual base overrides to
2786   // escape a non-trivial constructor.
2787   assert(RD->getMSVtorDispMode() == MSVtorDispAttr::ForVBaseOverride);
2788 
2789   // If any of our bases need a vtordisp for this type, so do we.  Check our
2790   // direct bases for vtordisp requirements.
2791   for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
2792                                                 e = RD->bases_end();
2793        i != e; ++i) {
2794     const CXXRecordDecl *BaseDecl =
2795         cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
2796     const ASTRecordLayout &Layout = Context.getASTRecordLayout(BaseDecl);
2797     for (ASTRecordLayout::VBaseOffsetsMapTy::const_iterator
2798              bi = Layout.getVBaseOffsetsMap().begin(),
2799              be = Layout.getVBaseOffsetsMap().end();
2800          bi != be; ++bi)
2801       if (bi->second.hasVtorDisp())
2802         HasVtordispSet.insert(bi->first);
2803   }
2804   // If we define a constructor or destructor and override a function that is
2805   // defined in a virtual base's vtable, that virtual bases need a vtordisp.
2806   // Here we collect a list of classes with vtables for which our virtual bases
2807   // actually live.  The virtual bases with this property will require
2808   // vtordisps.  In addition, virtual bases that contain non-virtual bases that
2809   // define functions we override also require vtordisps, this case is checked
2810   // explicitly below.
2811   if (RD->hasUserDeclaredConstructor() || RD->hasUserDeclaredDestructor()) {
2812     llvm::SmallPtrSet<const CXXMethodDecl *, 8> Work;
2813     // Seed the working set with our non-destructor virtual methods.
2814     for (CXXRecordDecl::method_iterator i = RD->method_begin(),
2815                                         e = RD->method_end();
2816          i != e; ++i)
2817       if ((*i)->isVirtual() && !isa<CXXDestructorDecl>(*i))
2818         Work.insert(*i);
2819     while (!Work.empty()) {
2820       const CXXMethodDecl *MD = *Work.begin();
2821       CXXMethodDecl::method_iterator i = MD->begin_overridden_methods(),
2822                                      e = MD->end_overridden_methods();
2823       if (i == e)
2824         // If a virtual method has no-overrides it lives in its parent's vtable.
2825         HasVtordispSet.insert(MD->getParent());
2826       else
2827         Work.insert(i, e);
2828       // We've finished processing this element, remove it from the working set.
2829       Work.erase(MD);
2830     }
2831   }
2832   // Re-check all of our vbases for vtordisp requirements (in case their
2833   // non-virtual bases have vtordisp requirements).
2834   for (CXXRecordDecl::base_class_const_iterator i = RD->vbases_begin(),
2835                                                 e = RD->vbases_end();
2836        i != e; ++i) {
2837     const CXXRecordDecl *BaseDecl =  i->getType()->getAsCXXRecordDecl();
2838     if (!HasVtordispSet.count(BaseDecl) &&
2839         RequiresVtordisp(HasVtordispSet, BaseDecl))
2840       HasVtordispSet.insert(BaseDecl);
2841   }
2842   return HasVtordispSet;
2843 }
2844 
2845 /// \brief Get or compute information about the layout of the specified record
2846 /// (struct/union/class), which indicates its size and field position
2847 /// information.
2848 const ASTRecordLayout *
2849 ASTContext::BuildMicrosoftASTRecordLayout(const RecordDecl *D) const {
2850   MicrosoftRecordLayoutBuilder Builder(*this);
2851   if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
2852     Builder.cxxLayout(RD);
2853     return new (*this) ASTRecordLayout(
2854         *this, Builder.Size, Builder.Alignment, Builder.RequiredAlignment,
2855         Builder.HasOwnVFPtr,
2856         Builder.HasOwnVFPtr || Builder.PrimaryBase,
2857         Builder.VBPtrOffset, Builder.NonVirtualSize, Builder.FieldOffsets.data(),
2858         Builder.FieldOffsets.size(), Builder.NonVirtualSize,
2859         Builder.Alignment, CharUnits::Zero(), Builder.PrimaryBase,
2860         false, Builder.SharedVBPtrBase,
2861         Builder.HasZeroSizedSubObject, Builder.LeadsWithZeroSizedBase,
2862         Builder.Bases, Builder.VBases);
2863   } else {
2864     Builder.layout(D);
2865     return new (*this) ASTRecordLayout(
2866         *this, Builder.Size, Builder.Alignment, Builder.RequiredAlignment,
2867         Builder.Size, Builder.FieldOffsets.data(), Builder.FieldOffsets.size());
2868   }
2869 }
2870 
2871 /// getASTRecordLayout - Get or compute information about the layout of the
2872 /// specified record (struct/union/class), which indicates its size and field
2873 /// position information.
2874 const ASTRecordLayout &
2875 ASTContext::getASTRecordLayout(const RecordDecl *D) const {
2876   // These asserts test different things.  A record has a definition
2877   // as soon as we begin to parse the definition.  That definition is
2878   // not a complete definition (which is what isDefinition() tests)
2879   // until we *finish* parsing the definition.
2880 
2881   if (D->hasExternalLexicalStorage() && !D->getDefinition())
2882     getExternalSource()->CompleteType(const_cast<RecordDecl*>(D));
2883 
2884   D = D->getDefinition();
2885   assert(D && "Cannot get layout of forward declarations!");
2886   assert(!D->isInvalidDecl() && "Cannot get layout of invalid decl!");
2887   assert(D->isCompleteDefinition() && "Cannot layout type before complete!");
2888 
2889   // Look up this layout, if already laid out, return what we have.
2890   // Note that we can't save a reference to the entry because this function
2891   // is recursive.
2892   const ASTRecordLayout *Entry = ASTRecordLayouts[D];
2893   if (Entry) return *Entry;
2894 
2895   const ASTRecordLayout *NewEntry = 0;
2896 
2897   if (isMsLayout(D) && !D->getASTContext().getExternalSource()) {
2898     NewEntry = BuildMicrosoftASTRecordLayout(D);
2899   } else if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
2900     EmptySubobjectMap EmptySubobjects(*this, RD);
2901     RecordLayoutBuilder Builder(*this, &EmptySubobjects);
2902     Builder.Layout(RD);
2903 
2904     // In certain situations, we are allowed to lay out objects in the
2905     // tail-padding of base classes.  This is ABI-dependent.
2906     // FIXME: this should be stored in the record layout.
2907     bool skipTailPadding =
2908       mustSkipTailPadding(getTargetInfo().getCXXABI(), cast<CXXRecordDecl>(D));
2909 
2910     // FIXME: This should be done in FinalizeLayout.
2911     CharUnits DataSize =
2912       skipTailPadding ? Builder.getSize() : Builder.getDataSize();
2913     CharUnits NonVirtualSize =
2914       skipTailPadding ? DataSize : Builder.NonVirtualSize;
2915     NewEntry =
2916       new (*this) ASTRecordLayout(*this, Builder.getSize(),
2917                                   Builder.Alignment,
2918                                   /*RequiredAlignment : used by MS-ABI)*/
2919                                   Builder.Alignment,
2920                                   Builder.HasOwnVFPtr,
2921                                   RD->isDynamicClass(),
2922                                   CharUnits::fromQuantity(-1),
2923                                   DataSize,
2924                                   Builder.FieldOffsets.data(),
2925                                   Builder.FieldOffsets.size(),
2926                                   NonVirtualSize,
2927                                   Builder.NonVirtualAlignment,
2928                                   EmptySubobjects.SizeOfLargestEmptySubobject,
2929                                   Builder.PrimaryBase,
2930                                   Builder.PrimaryBaseIsVirtual,
2931                                   0, false, false,
2932                                   Builder.Bases, Builder.VBases);
2933   } else {
2934     RecordLayoutBuilder Builder(*this, /*EmptySubobjects=*/0);
2935     Builder.Layout(D);
2936 
2937     NewEntry =
2938       new (*this) ASTRecordLayout(*this, Builder.getSize(),
2939                                   Builder.Alignment,
2940                                   /*RequiredAlignment : used by MS-ABI)*/
2941                                   Builder.Alignment,
2942                                   Builder.getSize(),
2943                                   Builder.FieldOffsets.data(),
2944                                   Builder.FieldOffsets.size());
2945   }
2946 
2947   ASTRecordLayouts[D] = NewEntry;
2948 
2949   if (getLangOpts().DumpRecordLayouts) {
2950     llvm::outs() << "\n*** Dumping AST Record Layout\n";
2951     DumpRecordLayout(D, llvm::outs(), getLangOpts().DumpRecordLayoutsSimple);
2952   }
2953 
2954   return *NewEntry;
2955 }
2956 
2957 const CXXMethodDecl *ASTContext::getCurrentKeyFunction(const CXXRecordDecl *RD) {
2958   if (!getTargetInfo().getCXXABI().hasKeyFunctions())
2959     return 0;
2960 
2961   assert(RD->getDefinition() && "Cannot get key function for forward decl!");
2962   RD = cast<CXXRecordDecl>(RD->getDefinition());
2963 
2964   LazyDeclPtr &Entry = KeyFunctions[RD];
2965   if (!Entry)
2966     Entry = const_cast<CXXMethodDecl*>(computeKeyFunction(*this, RD));
2967 
2968   return cast_or_null<CXXMethodDecl>(Entry.get(getExternalSource()));
2969 }
2970 
2971 void ASTContext::setNonKeyFunction(const CXXMethodDecl *Method) {
2972   assert(Method == Method->getFirstDecl() &&
2973          "not working with method declaration from class definition");
2974 
2975   // Look up the cache entry.  Since we're working with the first
2976   // declaration, its parent must be the class definition, which is
2977   // the correct key for the KeyFunctions hash.
2978   llvm::DenseMap<const CXXRecordDecl*, LazyDeclPtr>::iterator
2979     I = KeyFunctions.find(Method->getParent());
2980 
2981   // If it's not cached, there's nothing to do.
2982   if (I == KeyFunctions.end()) return;
2983 
2984   // If it is cached, check whether it's the target method, and if so,
2985   // remove it from the cache.
2986   if (I->second.get(getExternalSource()) == Method) {
2987     // FIXME: remember that we did this for module / chained PCH state?
2988     KeyFunctions.erase(I);
2989   }
2990 }
2991 
2992 static uint64_t getFieldOffset(const ASTContext &C, const FieldDecl *FD) {
2993   const ASTRecordLayout &Layout = C.getASTRecordLayout(FD->getParent());
2994   return Layout.getFieldOffset(FD->getFieldIndex());
2995 }
2996 
2997 uint64_t ASTContext::getFieldOffset(const ValueDecl *VD) const {
2998   uint64_t OffsetInBits;
2999   if (const FieldDecl *FD = dyn_cast<FieldDecl>(VD)) {
3000     OffsetInBits = ::getFieldOffset(*this, FD);
3001   } else {
3002     const IndirectFieldDecl *IFD = cast<IndirectFieldDecl>(VD);
3003 
3004     OffsetInBits = 0;
3005     for (IndirectFieldDecl::chain_iterator CI = IFD->chain_begin(),
3006                                            CE = IFD->chain_end();
3007          CI != CE; ++CI)
3008       OffsetInBits += ::getFieldOffset(*this, cast<FieldDecl>(*CI));
3009   }
3010 
3011   return OffsetInBits;
3012 }
3013 
3014 /// getObjCLayout - Get or compute information about the layout of the
3015 /// given interface.
3016 ///
3017 /// \param Impl - If given, also include the layout of the interface's
3018 /// implementation. This may differ by including synthesized ivars.
3019 const ASTRecordLayout &
3020 ASTContext::getObjCLayout(const ObjCInterfaceDecl *D,
3021                           const ObjCImplementationDecl *Impl) const {
3022   // Retrieve the definition
3023   if (D->hasExternalLexicalStorage() && !D->getDefinition())
3024     getExternalSource()->CompleteType(const_cast<ObjCInterfaceDecl*>(D));
3025   D = D->getDefinition();
3026   assert(D && D->isThisDeclarationADefinition() && "Invalid interface decl!");
3027 
3028   // Look up this layout, if already laid out, return what we have.
3029   const ObjCContainerDecl *Key =
3030     Impl ? (const ObjCContainerDecl*) Impl : (const ObjCContainerDecl*) D;
3031   if (const ASTRecordLayout *Entry = ObjCLayouts[Key])
3032     return *Entry;
3033 
3034   // Add in synthesized ivar count if laying out an implementation.
3035   if (Impl) {
3036     unsigned SynthCount = CountNonClassIvars(D);
3037     // If there aren't any sythesized ivars then reuse the interface
3038     // entry. Note we can't cache this because we simply free all
3039     // entries later; however we shouldn't look up implementations
3040     // frequently.
3041     if (SynthCount == 0)
3042       return getObjCLayout(D, 0);
3043   }
3044 
3045   RecordLayoutBuilder Builder(*this, /*EmptySubobjects=*/0);
3046   Builder.Layout(D);
3047 
3048   const ASTRecordLayout *NewEntry =
3049     new (*this) ASTRecordLayout(*this, Builder.getSize(),
3050                                 Builder.Alignment,
3051                                 /*RequiredAlignment : used by MS-ABI)*/
3052                                 Builder.Alignment,
3053                                 Builder.getDataSize(),
3054                                 Builder.FieldOffsets.data(),
3055                                 Builder.FieldOffsets.size());
3056 
3057   ObjCLayouts[Key] = NewEntry;
3058 
3059   return *NewEntry;
3060 }
3061 
3062 static void PrintOffset(raw_ostream &OS,
3063                         CharUnits Offset, unsigned IndentLevel) {
3064   OS << llvm::format("%4" PRId64 " | ", (int64_t)Offset.getQuantity());
3065   OS.indent(IndentLevel * 2);
3066 }
3067 
3068 static void PrintIndentNoOffset(raw_ostream &OS, unsigned IndentLevel) {
3069   OS << "     | ";
3070   OS.indent(IndentLevel * 2);
3071 }
3072 
3073 static void DumpCXXRecordLayout(raw_ostream &OS,
3074                                 const CXXRecordDecl *RD, const ASTContext &C,
3075                                 CharUnits Offset,
3076                                 unsigned IndentLevel,
3077                                 const char* Description,
3078                                 bool IncludeVirtualBases) {
3079   const ASTRecordLayout &Layout = C.getASTRecordLayout(RD);
3080 
3081   PrintOffset(OS, Offset, IndentLevel);
3082   OS << C.getTypeDeclType(const_cast<CXXRecordDecl *>(RD)).getAsString();
3083   if (Description)
3084     OS << ' ' << Description;
3085   if (RD->isEmpty())
3086     OS << " (empty)";
3087   OS << '\n';
3088 
3089   IndentLevel++;
3090 
3091   const CXXRecordDecl *PrimaryBase = Layout.getPrimaryBase();
3092   bool HasOwnVFPtr = Layout.hasOwnVFPtr();
3093   bool HasOwnVBPtr = Layout.hasOwnVBPtr();
3094 
3095   // Vtable pointer.
3096   if (RD->isDynamicClass() && !PrimaryBase && !isMsLayout(RD)) {
3097     PrintOffset(OS, Offset, IndentLevel);
3098     OS << '(' << *RD << " vtable pointer)\n";
3099   } else if (HasOwnVFPtr) {
3100     PrintOffset(OS, Offset, IndentLevel);
3101     // vfptr (for Microsoft C++ ABI)
3102     OS << '(' << *RD << " vftable pointer)\n";
3103   }
3104 
3105   // Collect nvbases.
3106   SmallVector<const CXXRecordDecl *, 4> Bases;
3107   for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
3108                                                 E = RD->bases_end();
3109        I != E; ++I) {
3110     assert(!I->getType()->isDependentType() &&
3111            "Cannot layout class with dependent bases.");
3112     if (!I->isVirtual())
3113       Bases.push_back(I->getType()->getAsCXXRecordDecl());
3114   }
3115 
3116   // Sort nvbases by offset.
3117   std::stable_sort(Bases.begin(), Bases.end(),
3118                    [&](const CXXRecordDecl *L, const CXXRecordDecl *R) {
3119     return Layout.getBaseClassOffset(L) < Layout.getBaseClassOffset(R);
3120   });
3121 
3122   // Dump (non-virtual) bases
3123   for (SmallVectorImpl<const CXXRecordDecl *>::iterator I = Bases.begin(),
3124                                                         E = Bases.end();
3125        I != E; ++I) {
3126     const CXXRecordDecl *Base = *I;
3127     CharUnits BaseOffset = Offset + Layout.getBaseClassOffset(Base);
3128     DumpCXXRecordLayout(OS, Base, C, BaseOffset, IndentLevel,
3129                         Base == PrimaryBase ? "(primary base)" : "(base)",
3130                         /*IncludeVirtualBases=*/false);
3131   }
3132 
3133   // vbptr (for Microsoft C++ ABI)
3134   if (HasOwnVBPtr) {
3135     PrintOffset(OS, Offset + Layout.getVBPtrOffset(), IndentLevel);
3136     OS << '(' << *RD << " vbtable pointer)\n";
3137   }
3138 
3139   // Dump fields.
3140   uint64_t FieldNo = 0;
3141   for (CXXRecordDecl::field_iterator I = RD->field_begin(),
3142          E = RD->field_end(); I != E; ++I, ++FieldNo) {
3143     const FieldDecl &Field = **I;
3144     CharUnits FieldOffset = Offset +
3145       C.toCharUnitsFromBits(Layout.getFieldOffset(FieldNo));
3146 
3147     if (const RecordType *RT = Field.getType()->getAs<RecordType>()) {
3148       if (const CXXRecordDecl *D = dyn_cast<CXXRecordDecl>(RT->getDecl())) {
3149         DumpCXXRecordLayout(OS, D, C, FieldOffset, IndentLevel,
3150                             Field.getName().data(),
3151                             /*IncludeVirtualBases=*/true);
3152         continue;
3153       }
3154     }
3155 
3156     PrintOffset(OS, FieldOffset, IndentLevel);
3157     OS << Field.getType().getAsString() << ' ' << Field << '\n';
3158   }
3159 
3160   if (!IncludeVirtualBases)
3161     return;
3162 
3163   // Dump virtual bases.
3164   const ASTRecordLayout::VBaseOffsetsMapTy &vtordisps =
3165     Layout.getVBaseOffsetsMap();
3166   for (CXXRecordDecl::base_class_const_iterator I = RD->vbases_begin(),
3167          E = RD->vbases_end(); I != E; ++I) {
3168     assert(I->isVirtual() && "Found non-virtual class!");
3169     const CXXRecordDecl *VBase =
3170       cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl());
3171 
3172     CharUnits VBaseOffset = Offset + Layout.getVBaseClassOffset(VBase);
3173 
3174     if (vtordisps.find(VBase)->second.hasVtorDisp()) {
3175       PrintOffset(OS, VBaseOffset - CharUnits::fromQuantity(4), IndentLevel);
3176       OS << "(vtordisp for vbase " << *VBase << ")\n";
3177     }
3178 
3179     DumpCXXRecordLayout(OS, VBase, C, VBaseOffset, IndentLevel,
3180                         VBase == PrimaryBase ?
3181                         "(primary virtual base)" : "(virtual base)",
3182                         /*IncludeVirtualBases=*/false);
3183   }
3184 
3185   PrintIndentNoOffset(OS, IndentLevel - 1);
3186   OS << "[sizeof=" << Layout.getSize().getQuantity();
3187   if (!isMsLayout(RD))
3188     OS << ", dsize=" << Layout.getDataSize().getQuantity();
3189   OS << ", align=" << Layout.getAlignment().getQuantity() << '\n';
3190 
3191   PrintIndentNoOffset(OS, IndentLevel - 1);
3192   OS << " nvsize=" << Layout.getNonVirtualSize().getQuantity();
3193   OS << ", nvalign=" << Layout.getNonVirtualAlignment().getQuantity() << "]\n";
3194   OS << '\n';
3195 }
3196 
3197 void ASTContext::DumpRecordLayout(const RecordDecl *RD,
3198                                   raw_ostream &OS,
3199                                   bool Simple) const {
3200   const ASTRecordLayout &Info = getASTRecordLayout(RD);
3201 
3202   if (const CXXRecordDecl *CXXRD = dyn_cast<CXXRecordDecl>(RD))
3203     if (!Simple)
3204       return DumpCXXRecordLayout(OS, CXXRD, *this, CharUnits(), 0, 0,
3205                                  /*IncludeVirtualBases=*/true);
3206 
3207   OS << "Type: " << getTypeDeclType(RD).getAsString() << "\n";
3208   if (!Simple) {
3209     OS << "Record: ";
3210     RD->dump();
3211   }
3212   OS << "\nLayout: ";
3213   OS << "<ASTRecordLayout\n";
3214   OS << "  Size:" << toBits(Info.getSize()) << "\n";
3215   if (!isMsLayout(RD))
3216     OS << "  DataSize:" << toBits(Info.getDataSize()) << "\n";
3217   OS << "  Alignment:" << toBits(Info.getAlignment()) << "\n";
3218   OS << "  FieldOffsets: [";
3219   for (unsigned i = 0, e = Info.getFieldCount(); i != e; ++i) {
3220     if (i) OS << ", ";
3221     OS << Info.getFieldOffset(i);
3222   }
3223   OS << "]>\n";
3224 }
3225