clang  6.0.0svn
CGRecordLayoutBuilder.cpp
Go to the documentation of this file.
1 //===--- CGRecordLayoutBuilder.cpp - CGRecordLayout builder ----*- C++ -*-===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // Builder implementation for CGRecordLayout objects.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "CGRecordLayout.h"
15 #include "CGCXXABI.h"
16 #include "CodeGenTypes.h"
17 #include "clang/AST/ASTContext.h"
18 #include "clang/AST/Attr.h"
20 #include "clang/AST/DeclCXX.h"
21 #include "clang/AST/Expr.h"
22 #include "clang/AST/RecordLayout.h"
24 #include "llvm/IR/DataLayout.h"
25 #include "llvm/IR/DerivedTypes.h"
26 #include "llvm/IR/Type.h"
27 #include "llvm/Support/Debug.h"
28 #include "llvm/Support/MathExtras.h"
29 #include "llvm/Support/raw_ostream.h"
30 using namespace clang;
31 using namespace CodeGen;
32 
33 namespace {
34 /// The CGRecordLowering is responsible for lowering an ASTRecordLayout to an
35 /// llvm::Type. Some of the lowering is straightforward, some is not. Here we
36 /// detail some of the complexities and weirdnesses here.
37 /// * LLVM does not have unions - Unions can, in theory be represented by any
38 /// llvm::Type with correct size. We choose a field via a specific heuristic
39 /// and add padding if necessary.
40 /// * LLVM does not have bitfields - Bitfields are collected into contiguous
41 /// runs and allocated as a single storage type for the run. ASTRecordLayout
42 /// contains enough information to determine where the runs break. Microsoft
43 /// and Itanium follow different rules and use different codepaths.
44 /// * It is desired that, when possible, bitfields use the appropriate iN type
45 /// when lowered to llvm types. For example unsigned x : 24 gets lowered to
46 /// i24. This isn't always possible because i24 has storage size of 32 bit
47 /// and if it is possible to use that extra byte of padding we must use
48 /// [i8 x 3] instead of i24. The function clipTailPadding does this.
49 /// C++ examples that require clipping:
50 /// struct { int a : 24; char b; }; // a must be clipped, b goes at offset 3
51 /// struct A { int a : 24; }; // a must be clipped because a struct like B
52 // could exist: struct B : A { char b; }; // b goes at offset 3
53 /// * Clang ignores 0 sized bitfields and 0 sized bases but *not* zero sized
54 /// fields. The existing asserts suggest that LLVM assumes that *every* field
55 /// has an underlying storage type. Therefore empty structures containing
56 /// zero sized subobjects such as empty records or zero sized arrays still get
57 /// a zero sized (empty struct) storage type.
58 /// * Clang reads the complete type rather than the base type when generating
59 /// code to access fields. Bitfields in tail position with tail padding may
60 /// be clipped in the base class but not the complete class (we may discover
61 /// that the tail padding is not used in the complete class.) However,
62 /// because LLVM reads from the complete type it can generate incorrect code
63 /// if we do not clip the tail padding off of the bitfield in the complete
64 /// layout. This introduces a somewhat awkward extra unnecessary clip stage.
65 /// The location of the clip is stored internally as a sentinal of type
66 /// SCISSOR. If LLVM were updated to read base types (which it probably
67 /// should because locations of things such as VBases are bogus in the llvm
68 /// type anyway) then we could eliminate the SCISSOR.
69 /// * Itanium allows nearly empty primary virtual bases. These bases don't get
70 /// get their own storage because they're laid out as part of another base
71 /// or at the beginning of the structure. Determining if a VBase actually
72 /// gets storage awkwardly involves a walk of all bases.
73 /// * VFPtrs and VBPtrs do *not* make a record NotZeroInitializable.
74 struct CGRecordLowering {
75  // MemberInfo is a helper structure that contains information about a record
76  // member. In additional to the standard member types, there exists a
77  // sentinal member type that ensures correct rounding.
78  struct MemberInfo {
80  enum InfoKind { VFPtr, VBPtr, Field, Base, VBase, Scissor } Kind;
81  llvm::Type *Data;
82  union {
83  const FieldDecl *FD;
84  const CXXRecordDecl *RD;
85  };
86  MemberInfo(CharUnits Offset, InfoKind Kind, llvm::Type *Data,
87  const FieldDecl *FD = nullptr)
88  : Offset(Offset), Kind(Kind), Data(Data), FD(FD) {}
89  MemberInfo(CharUnits Offset, InfoKind Kind, llvm::Type *Data,
90  const CXXRecordDecl *RD)
91  : Offset(Offset), Kind(Kind), Data(Data), RD(RD) {}
92  // MemberInfos are sorted so we define a < operator.
93  bool operator <(const MemberInfo& a) const { return Offset < a.Offset; }
94  };
95  // The constructor.
96  CGRecordLowering(CodeGenTypes &Types, const RecordDecl *D, bool Packed);
97  // Short helper routines.
98  /// \brief Constructs a MemberInfo instance from an offset and llvm::Type *.
99  MemberInfo StorageInfo(CharUnits Offset, llvm::Type *Data) {
100  return MemberInfo(Offset, MemberInfo::Field, Data);
101  }
102 
103  /// The Microsoft bitfield layout rule allocates discrete storage
104  /// units of the field's formal type and only combines adjacent
105  /// fields of the same formal type. We want to emit a layout with
106  /// these discrete storage units instead of combining them into a
107  /// continuous run.
108  bool isDiscreteBitFieldABI() {
109  return Context.getTargetInfo().getCXXABI().isMicrosoft() ||
110  D->isMsStruct(Context);
111  }
112 
113  /// The Itanium base layout rule allows virtual bases to overlap
114  /// other bases, which complicates layout in specific ways.
115  ///
116  /// Note specifically that the ms_struct attribute doesn't change this.
117  bool isOverlappingVBaseABI() {
118  return !Context.getTargetInfo().getCXXABI().isMicrosoft();
119  }
120 
121  /// \brief Wraps llvm::Type::getIntNTy with some implicit arguments.
122  llvm::Type *getIntNType(uint64_t NumBits) {
123  return llvm::Type::getIntNTy(Types.getLLVMContext(),
124  (unsigned)llvm::alignTo(NumBits, 8));
125  }
126  /// \brief Gets an llvm type of size NumBytes and alignment 1.
127  llvm::Type *getByteArrayType(CharUnits NumBytes) {
128  assert(!NumBytes.isZero() && "Empty byte arrays aren't allowed.");
129  llvm::Type *Type = llvm::Type::getInt8Ty(Types.getLLVMContext());
130  return NumBytes == CharUnits::One() ? Type :
131  (llvm::Type *)llvm::ArrayType::get(Type, NumBytes.getQuantity());
132  }
133  /// \brief Gets the storage type for a field decl and handles storage
134  /// for itanium bitfields that are smaller than their declared type.
135  llvm::Type *getStorageType(const FieldDecl *FD) {
136  llvm::Type *Type = Types.ConvertTypeForMem(FD->getType());
137  if (!FD->isBitField()) return Type;
138  if (isDiscreteBitFieldABI()) return Type;
139  return getIntNType(std::min(FD->getBitWidthValue(Context),
140  (unsigned)Context.toBits(getSize(Type))));
141  }
142  /// \brief Gets the llvm Basesubobject type from a CXXRecordDecl.
143  llvm::Type *getStorageType(const CXXRecordDecl *RD) {
144  return Types.getCGRecordLayout(RD).getBaseSubobjectLLVMType();
145  }
146  CharUnits bitsToCharUnits(uint64_t BitOffset) {
147  return Context.toCharUnitsFromBits(BitOffset);
148  }
149  CharUnits getSize(llvm::Type *Type) {
150  return CharUnits::fromQuantity(DataLayout.getTypeAllocSize(Type));
151  }
152  CharUnits getAlignment(llvm::Type *Type) {
153  return CharUnits::fromQuantity(DataLayout.getABITypeAlignment(Type));
154  }
155  bool isZeroInitializable(const FieldDecl *FD) {
156  return Types.isZeroInitializable(FD->getType());
157  }
158  bool isZeroInitializable(const RecordDecl *RD) {
159  return Types.isZeroInitializable(RD);
160  }
161  void appendPaddingBytes(CharUnits Size) {
162  if (!Size.isZero())
163  FieldTypes.push_back(getByteArrayType(Size));
164  }
165  uint64_t getFieldBitOffset(const FieldDecl *FD) {
166  return Layout.getFieldOffset(FD->getFieldIndex());
167  }
168  // Layout routines.
169  void setBitFieldInfo(const FieldDecl *FD, CharUnits StartOffset,
170  llvm::Type *StorageType);
171  /// \brief Lowers an ASTRecordLayout to a llvm type.
172  void lower(bool NonVirtualBaseType);
173  void lowerUnion();
174  void accumulateFields();
175  void accumulateBitFields(RecordDecl::field_iterator Field,
176  RecordDecl::field_iterator FieldEnd);
177  void accumulateBases();
178  void accumulateVPtrs();
179  void accumulateVBases();
180  /// \brief Recursively searches all of the bases to find out if a vbase is
181  /// not the primary vbase of some base class.
182  bool hasOwnStorage(const CXXRecordDecl *Decl, const CXXRecordDecl *Query);
183  void calculateZeroInit();
184  /// \brief Lowers bitfield storage types to I8 arrays for bitfields with tail
185  /// padding that is or can potentially be used.
186  void clipTailPadding();
187  /// \brief Determines if we need a packed llvm struct.
188  void determinePacked(bool NVBaseType);
189  /// \brief Inserts padding everwhere it's needed.
190  void insertPadding();
191  /// \brief Fills out the structures that are ultimately consumed.
192  void fillOutputFields();
193  // Input memoization fields.
194  CodeGenTypes &Types;
195  const ASTContext &Context;
196  const RecordDecl *D;
197  const CXXRecordDecl *RD;
198  const ASTRecordLayout &Layout;
199  const llvm::DataLayout &DataLayout;
200  // Helpful intermediate data-structures.
201  std::vector<MemberInfo> Members;
202  // Output fields, consumed by CodeGenTypes::ComputeRecordLayout.
204  llvm::DenseMap<const FieldDecl *, unsigned> Fields;
205  llvm::DenseMap<const FieldDecl *, CGBitFieldInfo> BitFields;
206  llvm::DenseMap<const CXXRecordDecl *, unsigned> NonVirtualBases;
207  llvm::DenseMap<const CXXRecordDecl *, unsigned> VirtualBases;
208  bool IsZeroInitializable : 1;
209  bool IsZeroInitializableAsBase : 1;
210  bool Packed : 1;
211 private:
212  CGRecordLowering(const CGRecordLowering &) = delete;
213  void operator =(const CGRecordLowering &) = delete;
214 };
215 } // namespace {
216 
217 CGRecordLowering::CGRecordLowering(CodeGenTypes &Types, const RecordDecl *D, bool Packed)
218  : Types(Types), Context(Types.getContext()), D(D),
219  RD(dyn_cast<CXXRecordDecl>(D)),
220  Layout(Types.getContext().getASTRecordLayout(D)),
221  DataLayout(Types.getDataLayout()), IsZeroInitializable(true),
222  IsZeroInitializableAsBase(true), Packed(Packed) {}
223 
224 void CGRecordLowering::setBitFieldInfo(
225  const FieldDecl *FD, CharUnits StartOffset, llvm::Type *StorageType) {
226  CGBitFieldInfo &Info = BitFields[FD->getCanonicalDecl()];
228  Info.Offset = (unsigned)(getFieldBitOffset(FD) - Context.toBits(StartOffset));
229  Info.Size = FD->getBitWidthValue(Context);
230  Info.StorageSize = (unsigned)DataLayout.getTypeAllocSizeInBits(StorageType);
231  Info.StorageOffset = StartOffset;
232  if (Info.Size > Info.StorageSize)
233  Info.Size = Info.StorageSize;
234  // Reverse the bit offsets for big endian machines. Because we represent
235  // a bitfield as a single large integer load, we can imagine the bits
236  // counting from the most-significant-bit instead of the
237  // least-significant-bit.
238  if (DataLayout.isBigEndian())
239  Info.Offset = Info.StorageSize - (Info.Offset + Info.Size);
240 }
241 
242 void CGRecordLowering::lower(bool NVBaseType) {
243  // The lowering process implemented in this function takes a variety of
244  // carefully ordered phases.
245  // 1) Store all members (fields and bases) in a list and sort them by offset.
246  // 2) Add a 1-byte capstone member at the Size of the structure.
247  // 3) Clip bitfield storages members if their tail padding is or might be
248  // used by another field or base. The clipping process uses the capstone
249  // by treating it as another object that occurs after the record.
250  // 4) Determine if the llvm-struct requires packing. It's important that this
251  // phase occur after clipping, because clipping changes the llvm type.
252  // This phase reads the offset of the capstone when determining packedness
253  // and updates the alignment of the capstone to be equal of the alignment
254  // of the record after doing so.
255  // 5) Insert padding everywhere it is needed. This phase requires 'Packed' to
256  // have been computed and needs to know the alignment of the record in
257  // order to understand if explicit tail padding is needed.
258  // 6) Remove the capstone, we don't need it anymore.
259  // 7) Determine if this record can be zero-initialized. This phase could have
260  // been placed anywhere after phase 1.
261  // 8) Format the complete list of members in a way that can be consumed by
262  // CodeGenTypes::ComputeRecordLayout.
263  CharUnits Size = NVBaseType ? Layout.getNonVirtualSize() : Layout.getSize();
264  if (D->isUnion())
265  return lowerUnion();
266  accumulateFields();
267  // RD implies C++.
268  if (RD) {
269  accumulateVPtrs();
270  accumulateBases();
271  if (Members.empty())
272  return appendPaddingBytes(Size);
273  if (!NVBaseType)
274  accumulateVBases();
275  }
276  std::stable_sort(Members.begin(), Members.end());
277  Members.push_back(StorageInfo(Size, getIntNType(8)));
278  clipTailPadding();
279  determinePacked(NVBaseType);
280  insertPadding();
281  Members.pop_back();
282  calculateZeroInit();
283  fillOutputFields();
284 }
285 
286 void CGRecordLowering::lowerUnion() {
287  CharUnits LayoutSize = Layout.getSize();
288  llvm::Type *StorageType = nullptr;
289  bool SeenNamedMember = false;
290  // Iterate through the fields setting bitFieldInfo and the Fields array. Also
291  // locate the "most appropriate" storage type. The heuristic for finding the
292  // storage type isn't necessary, the first (non-0-length-bitfield) field's
293  // type would work fine and be simpler but would be different than what we've
294  // been doing and cause lit tests to change.
295  for (const auto *Field : D->fields()) {
296  if (Field->isBitField()) {
297  // Skip 0 sized bitfields.
298  if (Field->getBitWidthValue(Context) == 0)
299  continue;
300  llvm::Type *FieldType = getStorageType(Field);
301  if (LayoutSize < getSize(FieldType))
302  FieldType = getByteArrayType(LayoutSize);
303  setBitFieldInfo(Field, CharUnits::Zero(), FieldType);
304  }
305  Fields[Field->getCanonicalDecl()] = 0;
306  llvm::Type *FieldType = getStorageType(Field);
307  // Compute zero-initializable status.
308  // This union might not be zero initialized: it may contain a pointer to
309  // data member which might have some exotic initialization sequence.
310  // If this is the case, then we aught not to try and come up with a "better"
311  // type, it might not be very easy to come up with a Constant which
312  // correctly initializes it.
313  if (!SeenNamedMember) {
314  SeenNamedMember = Field->getIdentifier();
315  if (!SeenNamedMember)
316  if (const auto *FieldRD =
317  dyn_cast_or_null<RecordDecl>(Field->getType()->getAsTagDecl()))
318  SeenNamedMember = FieldRD->findFirstNamedDataMember();
319  if (SeenNamedMember && !isZeroInitializable(Field)) {
320  IsZeroInitializable = IsZeroInitializableAsBase = false;
321  StorageType = FieldType;
322  }
323  }
324  // Because our union isn't zero initializable, we won't be getting a better
325  // storage type.
326  if (!IsZeroInitializable)
327  continue;
328  // Conditionally update our storage type if we've got a new "better" one.
329  if (!StorageType ||
330  getAlignment(FieldType) > getAlignment(StorageType) ||
331  (getAlignment(FieldType) == getAlignment(StorageType) &&
332  getSize(FieldType) > getSize(StorageType)))
333  StorageType = FieldType;
334  }
335  // If we have no storage type just pad to the appropriate size and return.
336  if (!StorageType)
337  return appendPaddingBytes(LayoutSize);
338  // If our storage size was bigger than our required size (can happen in the
339  // case of packed bitfields on Itanium) then just use an I8 array.
340  if (LayoutSize < getSize(StorageType))
341  StorageType = getByteArrayType(LayoutSize);
342  FieldTypes.push_back(StorageType);
343  appendPaddingBytes(LayoutSize - getSize(StorageType));
344  // Set packed if we need it.
345  if (LayoutSize % getAlignment(StorageType))
346  Packed = true;
347 }
348 
349 void CGRecordLowering::accumulateFields() {
350  for (RecordDecl::field_iterator Field = D->field_begin(),
351  FieldEnd = D->field_end();
352  Field != FieldEnd;)
353  if (Field->isBitField()) {
355  // Iterate to gather the list of bitfields.
356  for (++Field; Field != FieldEnd && Field->isBitField(); ++Field);
357  accumulateBitFields(Start, Field);
358  } else {
359  Members.push_back(MemberInfo(
360  bitsToCharUnits(getFieldBitOffset(*Field)), MemberInfo::Field,
361  getStorageType(*Field), *Field));
362  ++Field;
363  }
364 }
365 
366 void
367 CGRecordLowering::accumulateBitFields(RecordDecl::field_iterator Field,
368  RecordDecl::field_iterator FieldEnd) {
369  // Run stores the first element of the current run of bitfields. FieldEnd is
370  // used as a special value to note that we don't have a current run. A
371  // bitfield run is a contiguous collection of bitfields that can be stored in
372  // the same storage block. Zero-sized bitfields and bitfields that would
373  // cross an alignment boundary break a run and start a new one.
374  RecordDecl::field_iterator Run = FieldEnd;
375  // Tail is the offset of the first bit off the end of the current run. It's
376  // used to determine if the ASTRecordLayout is treating these two bitfields as
377  // contiguous. StartBitOffset is offset of the beginning of the Run.
378  uint64_t StartBitOffset, Tail = 0;
379  if (isDiscreteBitFieldABI()) {
380  for (; Field != FieldEnd; ++Field) {
381  uint64_t BitOffset = getFieldBitOffset(*Field);
382  // Zero-width bitfields end runs.
383  if (Field->getBitWidthValue(Context) == 0) {
384  Run = FieldEnd;
385  continue;
386  }
387  llvm::Type *Type = Types.ConvertTypeForMem(Field->getType());
388  // If we don't have a run yet, or don't live within the previous run's
389  // allocated storage then we allocate some storage and start a new run.
390  if (Run == FieldEnd || BitOffset >= Tail) {
391  Run = Field;
392  StartBitOffset = BitOffset;
393  Tail = StartBitOffset + DataLayout.getTypeAllocSizeInBits(Type);
394  // Add the storage member to the record. This must be added to the
395  // record before the bitfield members so that it gets laid out before
396  // the bitfields it contains get laid out.
397  Members.push_back(StorageInfo(bitsToCharUnits(StartBitOffset), Type));
398  }
399  // Bitfields get the offset of their storage but come afterward and remain
400  // there after a stable sort.
401  Members.push_back(MemberInfo(bitsToCharUnits(StartBitOffset),
402  MemberInfo::Field, nullptr, *Field));
403  }
404  return;
405  }
406 
407  // Check if current Field is better as a single field run. When current field
408  // has legal integer width, and its bitfield offset is naturally aligned, it
409  // is better to make the bitfield a separate storage component so as it can be
410  // accessed directly with lower cost.
411  auto IsBetterAsSingleFieldRun = [&](RecordDecl::field_iterator Field) {
412  if (!Types.getCodeGenOpts().FineGrainedBitfieldAccesses)
413  return false;
414  unsigned Width = Field->getBitWidthValue(Context);
415  if (!DataLayout.isLegalInteger(Width))
416  return false;
417  // Make sure Field is natually aligned if it is treated as an IType integer.
418  if (getFieldBitOffset(*Field) %
419  Context.toBits(getAlignment(getIntNType(Width))) !=
420  0)
421  return false;
422  return true;
423  };
424 
425  // The start field is better as a single field run.
426  bool StartFieldAsSingleRun = false;
427  for (;;) {
428  // Check to see if we need to start a new run.
429  if (Run == FieldEnd) {
430  // If we're out of fields, return.
431  if (Field == FieldEnd)
432  break;
433  // Any non-zero-length bitfield can start a new run.
434  if (Field->getBitWidthValue(Context) != 0) {
435  Run = Field;
436  StartBitOffset = getFieldBitOffset(*Field);
437  Tail = StartBitOffset + Field->getBitWidthValue(Context);
438  StartFieldAsSingleRun = IsBetterAsSingleFieldRun(Run);
439  }
440  ++Field;
441  continue;
442  }
443 
444  // If the start field of a new run is better as a single run, or
445  // if current field is better as a single run, or
446  // if current field has zero width bitfield, or
447  // if the offset of current field is inconsistent with the offset of
448  // previous field plus its offset,
449  // skip the block below and go ahead to emit the storage.
450  // Otherwise, try to add bitfields to the run.
451  if (!StartFieldAsSingleRun && Field != FieldEnd &&
452  !IsBetterAsSingleFieldRun(Field) &&
453  Field->getBitWidthValue(Context) != 0 &&
454  Tail == getFieldBitOffset(*Field)) {
455  Tail += Field->getBitWidthValue(Context);
456  ++Field;
457  continue;
458  }
459 
460  // We've hit a break-point in the run and need to emit a storage field.
461  llvm::Type *Type = getIntNType(Tail - StartBitOffset);
462  // Add the storage member to the record and set the bitfield info for all of
463  // the bitfields in the run. Bitfields get the offset of their storage but
464  // come afterward and remain there after a stable sort.
465  Members.push_back(StorageInfo(bitsToCharUnits(StartBitOffset), Type));
466  for (; Run != Field; ++Run)
467  Members.push_back(MemberInfo(bitsToCharUnits(StartBitOffset),
468  MemberInfo::Field, nullptr, *Run));
469  Run = FieldEnd;
470  StartFieldAsSingleRun = false;
471  }
472 }
473 
474 void CGRecordLowering::accumulateBases() {
475  // If we've got a primary virtual base, we need to add it with the bases.
476  if (Layout.isPrimaryBaseVirtual()) {
477  const CXXRecordDecl *BaseDecl = Layout.getPrimaryBase();
478  Members.push_back(MemberInfo(CharUnits::Zero(), MemberInfo::Base,
479  getStorageType(BaseDecl), BaseDecl));
480  }
481  // Accumulate the non-virtual bases.
482  for (const auto &Base : RD->bases()) {
483  if (Base.isVirtual())
484  continue;
485 
486  // Bases can be zero-sized even if not technically empty if they
487  // contain only a trailing array member.
488  const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl();
489  if (!BaseDecl->isEmpty() &&
490  !Context.getASTRecordLayout(BaseDecl).getNonVirtualSize().isZero())
491  Members.push_back(MemberInfo(Layout.getBaseClassOffset(BaseDecl),
492  MemberInfo::Base, getStorageType(BaseDecl), BaseDecl));
493  }
494 }
495 
496 void CGRecordLowering::accumulateVPtrs() {
497  if (Layout.hasOwnVFPtr())
498  Members.push_back(MemberInfo(CharUnits::Zero(), MemberInfo::VFPtr,
499  llvm::FunctionType::get(getIntNType(32), /*isVarArg=*/true)->
500  getPointerTo()->getPointerTo()));
501  if (Layout.hasOwnVBPtr())
502  Members.push_back(MemberInfo(Layout.getVBPtrOffset(), MemberInfo::VBPtr,
503  llvm::Type::getInt32PtrTy(Types.getLLVMContext())));
504 }
505 
506 void CGRecordLowering::accumulateVBases() {
507  CharUnits ScissorOffset = Layout.getNonVirtualSize();
508  // In the itanium ABI, it's possible to place a vbase at a dsize that is
509  // smaller than the nvsize. Here we check to see if such a base is placed
510  // before the nvsize and set the scissor offset to that, instead of the
511  // nvsize.
512  if (isOverlappingVBaseABI())
513  for (const auto &Base : RD->vbases()) {
514  const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl();
515  if (BaseDecl->isEmpty())
516  continue;
517  // If the vbase is a primary virtual base of some base, then it doesn't
518  // get its own storage location but instead lives inside of that base.
519  if (Context.isNearlyEmpty(BaseDecl) && !hasOwnStorage(RD, BaseDecl))
520  continue;
521  ScissorOffset = std::min(ScissorOffset,
522  Layout.getVBaseClassOffset(BaseDecl));
523  }
524  Members.push_back(MemberInfo(ScissorOffset, MemberInfo::Scissor, nullptr,
525  RD));
526  for (const auto &Base : RD->vbases()) {
527  const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl();
528  if (BaseDecl->isEmpty())
529  continue;
530  CharUnits Offset = Layout.getVBaseClassOffset(BaseDecl);
531  // If the vbase is a primary virtual base of some base, then it doesn't
532  // get its own storage location but instead lives inside of that base.
533  if (isOverlappingVBaseABI() &&
534  Context.isNearlyEmpty(BaseDecl) &&
535  !hasOwnStorage(RD, BaseDecl)) {
536  Members.push_back(MemberInfo(Offset, MemberInfo::VBase, nullptr,
537  BaseDecl));
538  continue;
539  }
540  // If we've got a vtordisp, add it as a storage type.
541  if (Layout.getVBaseOffsetsMap().find(BaseDecl)->second.hasVtorDisp())
542  Members.push_back(StorageInfo(Offset - CharUnits::fromQuantity(4),
543  getIntNType(32)));
544  Members.push_back(MemberInfo(Offset, MemberInfo::VBase,
545  getStorageType(BaseDecl), BaseDecl));
546  }
547 }
548 
549 bool CGRecordLowering::hasOwnStorage(const CXXRecordDecl *Decl,
550  const CXXRecordDecl *Query) {
551  const ASTRecordLayout &DeclLayout = Context.getASTRecordLayout(Decl);
552  if (DeclLayout.isPrimaryBaseVirtual() && DeclLayout.getPrimaryBase() == Query)
553  return false;
554  for (const auto &Base : Decl->bases())
555  if (!hasOwnStorage(Base.getType()->getAsCXXRecordDecl(), Query))
556  return false;
557  return true;
558 }
559 
560 void CGRecordLowering::calculateZeroInit() {
561  for (std::vector<MemberInfo>::const_iterator Member = Members.begin(),
562  MemberEnd = Members.end();
563  IsZeroInitializableAsBase && Member != MemberEnd; ++Member) {
564  if (Member->Kind == MemberInfo::Field) {
565  if (!Member->FD || isZeroInitializable(Member->FD))
566  continue;
567  IsZeroInitializable = IsZeroInitializableAsBase = false;
568  } else if (Member->Kind == MemberInfo::Base ||
569  Member->Kind == MemberInfo::VBase) {
570  if (isZeroInitializable(Member->RD))
571  continue;
572  IsZeroInitializable = false;
573  if (Member->Kind == MemberInfo::Base)
574  IsZeroInitializableAsBase = false;
575  }
576  }
577 }
578 
579 void CGRecordLowering::clipTailPadding() {
580  std::vector<MemberInfo>::iterator Prior = Members.begin();
581  CharUnits Tail = getSize(Prior->Data);
582  for (std::vector<MemberInfo>::iterator Member = Prior + 1,
583  MemberEnd = Members.end();
584  Member != MemberEnd; ++Member) {
585  // Only members with data and the scissor can cut into tail padding.
586  if (!Member->Data && Member->Kind != MemberInfo::Scissor)
587  continue;
588  if (Member->Offset < Tail) {
589  assert(Prior->Kind == MemberInfo::Field && !Prior->FD &&
590  "Only storage fields have tail padding!");
591  Prior->Data = getByteArrayType(bitsToCharUnits(llvm::alignTo(
592  cast<llvm::IntegerType>(Prior->Data)->getIntegerBitWidth(), 8)));
593  }
594  if (Member->Data)
595  Prior = Member;
596  Tail = Prior->Offset + getSize(Prior->Data);
597  }
598 }
599 
600 void CGRecordLowering::determinePacked(bool NVBaseType) {
601  if (Packed)
602  return;
603  CharUnits Alignment = CharUnits::One();
604  CharUnits NVAlignment = CharUnits::One();
605  CharUnits NVSize =
606  !NVBaseType && RD ? Layout.getNonVirtualSize() : CharUnits::Zero();
607  for (std::vector<MemberInfo>::const_iterator Member = Members.begin(),
608  MemberEnd = Members.end();
609  Member != MemberEnd; ++Member) {
610  if (!Member->Data)
611  continue;
612  // If any member falls at an offset that it not a multiple of its alignment,
613  // then the entire record must be packed.
614  if (Member->Offset % getAlignment(Member->Data))
615  Packed = true;
616  if (Member->Offset < NVSize)
617  NVAlignment = std::max(NVAlignment, getAlignment(Member->Data));
618  Alignment = std::max(Alignment, getAlignment(Member->Data));
619  }
620  // If the size of the record (the capstone's offset) is not a multiple of the
621  // record's alignment, it must be packed.
622  if (Members.back().Offset % Alignment)
623  Packed = true;
624  // If the non-virtual sub-object is not a multiple of the non-virtual
625  // sub-object's alignment, it must be packed. We cannot have a packed
626  // non-virtual sub-object and an unpacked complete object or vise versa.
627  if (NVSize % NVAlignment)
628  Packed = true;
629  // Update the alignment of the sentinal.
630  if (!Packed)
631  Members.back().Data = getIntNType(Context.toBits(Alignment));
632 }
633 
634 void CGRecordLowering::insertPadding() {
635  std::vector<std::pair<CharUnits, CharUnits> > Padding;
636  CharUnits Size = CharUnits::Zero();
637  for (std::vector<MemberInfo>::const_iterator Member = Members.begin(),
638  MemberEnd = Members.end();
639  Member != MemberEnd; ++Member) {
640  if (!Member->Data)
641  continue;
642  CharUnits Offset = Member->Offset;
643  assert(Offset >= Size);
644  // Insert padding if we need to.
645  if (Offset !=
646  Size.alignTo(Packed ? CharUnits::One() : getAlignment(Member->Data)))
647  Padding.push_back(std::make_pair(Size, Offset - Size));
648  Size = Offset + getSize(Member->Data);
649  }
650  if (Padding.empty())
651  return;
652  // Add the padding to the Members list and sort it.
653  for (std::vector<std::pair<CharUnits, CharUnits> >::const_iterator
654  Pad = Padding.begin(), PadEnd = Padding.end();
655  Pad != PadEnd; ++Pad)
656  Members.push_back(StorageInfo(Pad->first, getByteArrayType(Pad->second)));
657  std::stable_sort(Members.begin(), Members.end());
658 }
659 
660 void CGRecordLowering::fillOutputFields() {
661  for (std::vector<MemberInfo>::const_iterator Member = Members.begin(),
662  MemberEnd = Members.end();
663  Member != MemberEnd; ++Member) {
664  if (Member->Data)
665  FieldTypes.push_back(Member->Data);
666  if (Member->Kind == MemberInfo::Field) {
667  if (Member->FD)
668  Fields[Member->FD->getCanonicalDecl()] = FieldTypes.size() - 1;
669  // A field without storage must be a bitfield.
670  if (!Member->Data)
671  setBitFieldInfo(Member->FD, Member->Offset, FieldTypes.back());
672  } else if (Member->Kind == MemberInfo::Base)
673  NonVirtualBases[Member->RD] = FieldTypes.size() - 1;
674  else if (Member->Kind == MemberInfo::VBase)
675  VirtualBases[Member->RD] = FieldTypes.size() - 1;
676  }
677 }
678 
680  const FieldDecl *FD,
681  uint64_t Offset, uint64_t Size,
682  uint64_t StorageSize,
683  CharUnits StorageOffset) {
684  // This function is vestigial from CGRecordLayoutBuilder days but is still
685  // used in GCObjCRuntime.cpp. That usage has a "fixme" attached to it that
686  // when addressed will allow for the removal of this function.
687  llvm::Type *Ty = Types.ConvertTypeForMem(FD->getType());
688  CharUnits TypeSizeInBytes =
689  CharUnits::fromQuantity(Types.getDataLayout().getTypeAllocSize(Ty));
690  uint64_t TypeSizeInBits = Types.getContext().toBits(TypeSizeInBytes);
691 
692  bool IsSigned = FD->getType()->isSignedIntegerOrEnumerationType();
693 
694  if (Size > TypeSizeInBits) {
695  // We have a wide bit-field. The extra bits are only used for padding, so
696  // if we have a bitfield of type T, with size N:
697  //
698  // T t : N;
699  //
700  // We can just assume that it's:
701  //
702  // T t : sizeof(T);
703  //
704  Size = TypeSizeInBits;
705  }
706 
707  // Reverse the bit offsets for big endian machines. Because we represent
708  // a bitfield as a single large integer load, we can imagine the bits
709  // counting from the most-significant-bit instead of the
710  // least-significant-bit.
711  if (Types.getDataLayout().isBigEndian()) {
712  Offset = StorageSize - (Offset + Size);
713  }
714 
715  return CGBitFieldInfo(Offset, Size, IsSigned, StorageSize, StorageOffset);
716 }
717 
719  llvm::StructType *Ty) {
720  CGRecordLowering Builder(*this, D, /*Packed=*/false);
721 
722  Builder.lower(/*NonVirtualBaseType=*/false);
723 
724  // If we're in C++, compute the base subobject type.
725  llvm::StructType *BaseTy = nullptr;
726  if (isa<CXXRecordDecl>(D) && !D->isUnion() && !D->hasAttr<FinalAttr>()) {
727  BaseTy = Ty;
728  if (Builder.Layout.getNonVirtualSize() != Builder.Layout.getSize()) {
729  CGRecordLowering BaseBuilder(*this, D, /*Packed=*/Builder.Packed);
730  BaseBuilder.lower(/*NonVirtualBaseType=*/true);
731  BaseTy = llvm::StructType::create(
732  getLLVMContext(), BaseBuilder.FieldTypes, "", BaseBuilder.Packed);
733  addRecordTypeName(D, BaseTy, ".base");
734  // BaseTy and Ty must agree on their packedness for getLLVMFieldNo to work
735  // on both of them with the same index.
736  assert(Builder.Packed == BaseBuilder.Packed &&
737  "Non-virtual and complete types must agree on packedness");
738  }
739  }
740 
741  // Fill in the struct *after* computing the base type. Filling in the body
742  // signifies that the type is no longer opaque and record layout is complete,
743  // but we may need to recursively layout D while laying D out as a base type.
744  Ty->setBody(Builder.FieldTypes, Builder.Packed);
745 
746  CGRecordLayout *RL =
747  new CGRecordLayout(Ty, BaseTy, Builder.IsZeroInitializable,
748  Builder.IsZeroInitializableAsBase);
749 
750  RL->NonVirtualBases.swap(Builder.NonVirtualBases);
751  RL->CompleteObjectVirtualBases.swap(Builder.VirtualBases);
752 
753  // Add all the field numbers.
754  RL->FieldInfo.swap(Builder.Fields);
755 
756  // Add bitfield info.
757  RL->BitFields.swap(Builder.BitFields);
758 
759  // Dump the layout, if requested.
760  if (getContext().getLangOpts().DumpRecordLayouts) {
761  llvm::outs() << "\n*** Dumping IRgen Record Layout\n";
762  llvm::outs() << "Record: ";
763  D->dump(llvm::outs());
764  llvm::outs() << "\nLayout: ";
765  RL->print(llvm::outs());
766  }
767 
768 #ifndef NDEBUG
769  // Verify that the computed LLVM struct size matches the AST layout size.
770  const ASTRecordLayout &Layout = getContext().getASTRecordLayout(D);
771 
772  uint64_t TypeSizeInBits = getContext().toBits(Layout.getSize());
773  assert(TypeSizeInBits == getDataLayout().getTypeAllocSizeInBits(Ty) &&
774  "Type size mismatch!");
775 
776  if (BaseTy) {
777  CharUnits NonVirtualSize = Layout.getNonVirtualSize();
778 
779  uint64_t AlignedNonVirtualTypeSizeInBits =
780  getContext().toBits(NonVirtualSize);
781 
782  assert(AlignedNonVirtualTypeSizeInBits ==
783  getDataLayout().getTypeAllocSizeInBits(BaseTy) &&
784  "Type size mismatch!");
785  }
786 
787  // Verify that the LLVM and AST field offsets agree.
788  llvm::StructType *ST =
789  dyn_cast<llvm::StructType>(RL->getLLVMType());
790  const llvm::StructLayout *SL = getDataLayout().getStructLayout(ST);
791 
792  const ASTRecordLayout &AST_RL = getContext().getASTRecordLayout(D);
794  for (unsigned i = 0, e = AST_RL.getFieldCount(); i != e; ++i, ++it) {
795  const FieldDecl *FD = *it;
796 
797  // For non-bit-fields, just check that the LLVM struct offset matches the
798  // AST offset.
799  if (!FD->isBitField()) {
800  unsigned FieldNo = RL->getLLVMFieldNo(FD);
801  assert(AST_RL.getFieldOffset(i) == SL->getElementOffsetInBits(FieldNo) &&
802  "Invalid field offset!");
803  continue;
804  }
805 
806  // Ignore unnamed bit-fields.
807  if (!FD->getDeclName())
808  continue;
809 
810  // Don't inspect zero-length bitfields.
811  if (FD->getBitWidthValue(getContext()) == 0)
812  continue;
813 
814  const CGBitFieldInfo &Info = RL->getBitFieldInfo(FD);
815  llvm::Type *ElementTy = ST->getTypeAtIndex(RL->getLLVMFieldNo(FD));
816 
817  // Unions have overlapping elements dictating their layout, but for
818  // non-unions we can verify that this section of the layout is the exact
819  // expected size.
820  if (D->isUnion()) {
821  // For unions we verify that the start is zero and the size
822  // is in-bounds. However, on BE systems, the offset may be non-zero, but
823  // the size + offset should match the storage size in that case as it
824  // "starts" at the back.
825  if (getDataLayout().isBigEndian())
826  assert(static_cast<unsigned>(Info.Offset + Info.Size) ==
827  Info.StorageSize &&
828  "Big endian union bitfield does not end at the back");
829  else
830  assert(Info.Offset == 0 &&
831  "Little endian union bitfield with a non-zero offset");
832  assert(Info.StorageSize <= SL->getSizeInBits() &&
833  "Union not large enough for bitfield storage");
834  } else {
835  assert(Info.StorageSize ==
836  getDataLayout().getTypeAllocSizeInBits(ElementTy) &&
837  "Storage size does not match the element type size");
838  }
839  assert(Info.Size > 0 && "Empty bitfield!");
840  assert(static_cast<unsigned>(Info.Offset) + Info.Size <= Info.StorageSize &&
841  "Bitfield outside of its allocated storage");
842  }
843 #endif
844 
845  return RL;
846 }
847 
848 void CGRecordLayout::print(raw_ostream &OS) const {
849  OS << "<CGRecordLayout\n";
850  OS << " LLVMType:" << *CompleteObjectType << "\n";
851  if (BaseSubobjectType)
852  OS << " NonVirtualBaseLLVMType:" << *BaseSubobjectType << "\n";
853  OS << " IsZeroInitializable:" << IsZeroInitializable << "\n";
854  OS << " BitFields:[\n";
855 
856  // Print bit-field infos in declaration order.
857  std::vector<std::pair<unsigned, const CGBitFieldInfo*> > BFIs;
858  for (llvm::DenseMap<const FieldDecl*, CGBitFieldInfo>::const_iterator
859  it = BitFields.begin(), ie = BitFields.end();
860  it != ie; ++it) {
861  const RecordDecl *RD = it->first->getParent();
862  unsigned Index = 0;
864  it2 = RD->field_begin(); *it2 != it->first; ++it2)
865  ++Index;
866  BFIs.push_back(std::make_pair(Index, &it->second));
867  }
868  llvm::array_pod_sort(BFIs.begin(), BFIs.end());
869  for (unsigned i = 0, e = BFIs.size(); i != e; ++i) {
870  OS.indent(4);
871  BFIs[i].second->print(OS);
872  OS << "\n";
873  }
874 
875  OS << "]>\n";
876 }
877 
878 LLVM_DUMP_METHOD void CGRecordLayout::dump() const {
879  print(llvm::errs());
880 }
881 
882 void CGBitFieldInfo::print(raw_ostream &OS) const {
883  OS << "<CGBitFieldInfo"
884  << " Offset:" << Offset
885  << " Size:" << Size
886  << " IsSigned:" << IsSigned
887  << " StorageSize:" << StorageSize
888  << " StorageOffset:" << StorageOffset.getQuantity() << ">";
889 }
890 
891 LLVM_DUMP_METHOD void CGBitFieldInfo::dump() const {
892  print(llvm::errs());
893 }
Defines the clang::ASTContext interface.
CharUnits alignTo(const CharUnits &Align) const
alignTo - Returns the next integer (mod 2**64) that is greater than or equal to this quantity and is ...
Definition: CharUnits.h:184
bool isPrimaryBaseVirtual() const
isPrimaryBaseVirtual - Get whether the primary base for this record is virtual or not...
Definition: RecordLayout.h:216
const CGBitFieldInfo & getBitFieldInfo(const FieldDecl *FD) const
Return the BitFieldInfo that corresponds to the field FD.
base_class_range bases()
Definition: DeclCXX.h:773
CGRecordLayout - This class handles struct and union layout info while lowering AST types to LLVM typ...
const ASTRecordLayout & getASTRecordLayout(const RecordDecl *D) const
Get or compute information about the layout of the specified record (struct/union/class) D...
Decl - This represents one declaration (or definition), e.g.
Definition: DeclBase.h:86
const llvm::DataLayout & getDataLayout() const
Definition: CodeGenTypes.h:171
unsigned getFieldIndex() const
getFieldIndex - Returns the index of this field within its record, as appropriate for passing to ASTR...
Definition: Decl.cpp:3638
The base class of the type hierarchy.
Definition: Type.h:1353
bool isZero() const
isZero - Test whether the quantity equals zero.
Definition: CharUnits.h:116
const TargetInfo & getTargetInfo() const
Definition: ASTContext.h:671
llvm::Type * ConvertTypeForMem(QualType T)
ConvertTypeForMem - Convert type T into a llvm::Type.
RecordDecl - Represents a struct/union/class.
Definition: Decl.h:3478
bool isEmpty() const
Determine whether this is an empty class in the sense of (C++11 [meta.unary.prop]).
Definition: DeclCXX.h:1279
DeclarationName getDeclName() const
getDeclName - Get the actual, stored name of the declaration, which may be a special name...
Definition: Decl.h:291
TargetCXXABI getCXXABI() const
Get the C++ ABI currently in use.
Definition: TargetInfo.h:859
FieldDecl * getCanonicalDecl() override
Retrieves the canonical declaration of this field.
Definition: Decl.h:2649
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
Definition: ASTContext.h:149
FieldDecl - An instance of this class is created by Sema::ActOnField to represent a member of a struc...
Definition: Decl.h:2457
static CharUnits Zero()
Zero - Construct a CharUnits quantity of zero.
Definition: CharUnits.h:53
unsigned Size
The total size of the bit-field, in bits.
bool isBitField() const
Determines whether this field is a bitfield.
Definition: Decl.h:2535
CharUnits - This is an opaque type for sizes expressed in character units.
Definition: CharUnits.h:38
uint32_t Offset
Definition: CacheTokens.cpp:43
CharUnits StorageOffset
The offset of the bitfield storage from the start of the struct.
field_iterator field_begin() const
Definition: Decl.cpp:3937
unsigned getBitWidthValue(const ASTContext &Ctx) const
Definition: Decl.cpp:3633
unsigned Offset
The offset within a contiguous run of bitfields that are represented as a single "field" within the L...
bool isZeroInitializable() const
Check whether this struct can be C++ zero-initialized with a zeroinitializer.
bool hasAttr() const
Definition: DeclBase.h:535
static CharUnits One()
One - Construct a CharUnits quantity of one.
Definition: CharUnits.h:58
static CGBitFieldInfo MakeInfo(class CodeGenTypes &Types, const FieldDecl *FD, uint64_t Offset, uint64_t Size, uint64_t StorageSize, CharUnits StorageOffset)
Given a bit-field decl, build an appropriate helper object for accessing that field (which is expecte...
QuantityType getQuantity() const
getQuantity - Get the raw integer representation of this quantity.
Definition: CharUnits.h:179
ASTRecordLayout - This class contains layout information for one RecordDecl, which is a struct/union/...
Definition: RecordLayout.h:39
bool isNearlyEmpty(const CXXRecordDecl *RD) const
const CXXRecordDecl * getPrimaryBase() const
getPrimaryBase - Get the primary base for this record.
Definition: RecordLayout.h:208
static CharUnits fromQuantity(QuantityType Quantity)
fromQuantity - Construct a CharUnits quantity from a raw integer type.
Definition: CharUnits.h:63
unsigned getFieldCount() const
getFieldCount - Get the number of fields in the layout.
Definition: RecordLayout.h:177
char __ovld __cnfn min(char x, char y)
Returns y if y < x, otherwise it returns x.
DeclContext * getParent()
getParent - Returns the containing DeclContext.
Definition: DeclBase.h:1331
void print(raw_ostream &OS) const
The l-value was considered opaque, so the alignment was determined from a type.
uint64_t getFieldOffset(unsigned FieldNo) const
getFieldOffset - Get the offset of the given field index, in bits.
Definition: RecordLayout.h:181
Kind
bool isSignedIntegerOrEnumerationType() const
Determines whether this is an integer type that is signed or an enumeration types whose underlying ty...
Definition: Type.cpp:1816
bool operator<(DeclarationName LHS, DeclarationName RHS)
Ordering on two declaration names.
Dataflow Directional Tag Classes.
CharUnits getSize() const
getSize - Get the record size in characters.
Definition: RecordLayout.h:174
unsigned IsSigned
Whether the bit-field is signed.
std::unique_ptr< DiagnosticConsumer > create(StringRef OutputFile, DiagnosticOptions *Diags, bool MergeChildRecords=false)
Returns a DiagnosticConsumer that serializes diagnostics to a bitcode file.
unsigned StorageSize
The storage size in bits which should be used when accessing this bitfield.
specific_decl_iterator - Iterates over a subrange of declarations stored in a DeclContext, providing only those that are of type SpecificDecl (or a class derived from it).
Definition: DeclBase.h:1596
void print(raw_ostream &OS) const
This class organizes the cross-module state that is used while lowering AST types to LLVM types...
Definition: CodeGenTypes.h:120
llvm::StructType * getLLVMType() const
Return the "complete object" LLVM type associated with this record.
char __ovld __cnfn max(char x, char y)
Returns y if x < y, otherwise it returns x.
ASTContext & getContext() const
Definition: CodeGenTypes.h:174
CharUnits toCharUnitsFromBits(int64_t BitSize) const
Convert a size in bits to a size in characters.
Defines the C++ Decl subclasses, other than those for templates (found in DeclTemplate.h) and friends (in DeclFriend.h).
int64_t toBits(CharUnits CharSize) const
Convert a size in characters to a size in bits.
true
A convenience builder class for complex constant initializers, especially for anonymous global struct...
Represents a C++ struct/union/class.
Definition: DeclCXX.h:299
CharUnits getNonVirtualSize() const
getNonVirtualSize - Get the non-virtual size (in chars) of an object, which is the size of the object...
Definition: RecordLayout.h:193
bool isMicrosoft() const
Is this ABI an MSVC-compatible ABI?
Definition: TargetCXXABI.h:154
void dump() const
Definition: ASTDumper.cpp:2683
bool isUnion() const
Definition: Decl.h:3155
CGRecordLayout * ComputeRecordLayout(const RecordDecl *D, llvm::StructType *Ty)
Compute a new LLVM record layout object for the given record.
QualType getType() const
Definition: Decl.h:638
bool isZeroInitializable(QualType T)
IsZeroInitializable - Return whether a type can be zero-initialized (in the C++ sense) with an LLVM z...
Structure with information about how a bitfield should be accessed.
unsigned getLLVMFieldNo(const FieldDecl *FD) const
Return llvm::StructType element number that corresponds to the field FD.