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