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