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