DebugInfo/PDB/UDTLayout.h

0001 //===- UDTLayout.h - UDT layout info ----------------------------*- C++ -*-===//
0002 //
0003 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0004 // See https://llvm.org/LICENSE.txt for license information.
0005 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0006 //
0007 //===----------------------------------------------------------------------===//
0008
0009 #ifndef LLVM_DEBUGINFO_PDB_UDTLAYOUT_H
0010 #define LLVM_DEBUGINFO_PDB_UDTLAYOUT_H
0011
0012 #include "llvm/ADT/ArrayRef.h"
0013 #include "llvm/ADT/BitVector.h"
0014 #include "llvm/ADT/StringRef.h"
0015 #include "llvm/DebugInfo/PDB/PDBSymbol.h"
0016 #include "llvm/DebugInfo/PDB/PDBSymbolData.h"
0017 #include "llvm/DebugInfo/PDB/PDBSymbolTypeBaseClass.h"
0018 #include "llvm/DebugInfo/PDB/PDBSymbolTypeBuiltin.h"
0019 #include "llvm/DebugInfo/PDB/PDBSymbolTypeUDT.h"
0020 #include "llvm/DebugInfo/PDB/PDBSymbolTypeVTable.h"
0021 #include <cstdint>
0022 #include <memory>
0023 #include <string>
0024 #include <vector>
0025
0026 namespace llvm {
0027 namespace pdb {
0028
0029 class BaseClassLayout;
0030 class ClassLayout;
0031 class UDTLayoutBase;
0032
0033 class LayoutItemBase {
0034 public:
0035   LayoutItemBase(const UDTLayoutBase *Parent, const PDBSymbol *Symbol,
0036                  const std::string &Name, uint32_t OffsetInParent,
0037                  uint32_t Size, bool IsElided);
0038   virtual ~LayoutItemBase() = default;
0039
0040   uint32_t deepPaddingSize() const;
0041   virtual uint32_t immediatePadding() const { return 0; }
0042   virtual uint32_t tailPadding() const;
0043
0044   const UDTLayoutBase *getParent() const { return Parent; }
0045   StringRef getName() const { return Name; }
0046   uint32_t getOffsetInParent() const { return OffsetInParent; }
0047   uint32_t getSize() const { return SizeOf; }
0048   uint32_t getLayoutSize() const { return LayoutSize; }
0049   const PDBSymbol *getSymbol() const { return Symbol; }
0050   const BitVector &usedBytes() const { return UsedBytes; }
0051   bool isElided() const { return IsElided; }
0052   virtual bool isVBPtr() const { return false; }
0053
0054   uint32_t containsOffset(uint32_t Off) const {
0055     uint32_t Begin = getOffsetInParent();
0056     uint32_t End = Begin + getSize();
0057     return (Off >= Begin && Off < End);
0058   }
0059
0060 protected:
0061   const PDBSymbol *Symbol = nullptr;
0062   const UDTLayoutBase *Parent = nullptr;
0063   BitVector UsedBytes;
0064   std::string Name;
0065   uint32_t OffsetInParent = 0;
0066   uint32_t SizeOf = 0;
0067   uint32_t LayoutSize = 0;
0068   bool IsElided = false;
0069 };
0070
0071 class VBPtrLayoutItem : public LayoutItemBase {
0072 public:
0073   VBPtrLayoutItem(const UDTLayoutBase &Parent,
0074                   std::unique_ptr<PDBSymbolTypeBuiltin> Sym, uint32_t Offset,
0075                   uint32_t Size);
0076
0077   bool isVBPtr() const override { return true; }
0078
0079 private:
0080   std::unique_ptr<PDBSymbolTypeBuiltin> Type;
0081 };
0082
0083 class DataMemberLayoutItem : public LayoutItemBase {
0084 public:
0085   DataMemberLayoutItem(const UDTLayoutBase &Parent,
0086                        std::unique_ptr<PDBSymbolData> DataMember);
0087
0088   const PDBSymbolData &getDataMember();
0089   bool hasUDTLayout() const;
0090   const ClassLayout &getUDTLayout() const;
0091
0092 private:
0093   std::unique_ptr<PDBSymbolData> DataMember;
0094   std::unique_ptr<ClassLayout> UdtLayout;
0095 };
0096
0097 class VTableLayoutItem : public LayoutItemBase {
0098 public:
0099   VTableLayoutItem(const UDTLayoutBase &Parent,
0100                    std::unique_ptr<PDBSymbolTypeVTable> VTable);
0101
0102   uint32_t getElementSize() const { return ElementSize; }
0103
0104 private:
0105   uint32_t ElementSize = 0;
0106   std::unique_ptr<PDBSymbolTypeVTable> VTable;
0107 };
0108
0109 class UDTLayoutBase : public LayoutItemBase {
0110   template <typename T> using UniquePtrVector = std::vector<std::unique_ptr<T>>;
0111
0112 public:
0113   UDTLayoutBase(const UDTLayoutBase *Parent, const PDBSymbol &Sym,
0114                 const std::string &Name, uint32_t OffsetInParent, uint32_t Size,
0115                 bool IsElided);
0116
0117   uint32_t tailPadding() const override;
0118   ArrayRef<LayoutItemBase *> layout_items() const { return LayoutItems; }
0119   ArrayRef<BaseClassLayout *> bases() const { return AllBases; }
0120   ArrayRef<BaseClassLayout *> regular_bases() const { return NonVirtualBases; }
0121   ArrayRef<BaseClassLayout *> virtual_bases() const { return VirtualBases; }
0122   uint32_t directVirtualBaseCount() const { return DirectVBaseCount; }
0123   ArrayRef<std::unique_ptr<PDBSymbolFunc>> funcs() const { return Funcs; }
0124   ArrayRef<std::unique_ptr<PDBSymbol>> other_items() const { return Other; }
0125
0126 protected:
0127   bool hasVBPtrAtOffset(uint32_t Off) const;
0128   void initializeChildren(const PDBSymbol &Sym);
0129
0130   void addChildToLayout(std::unique_ptr<LayoutItemBase> Child);
0131
0132   uint32_t DirectVBaseCount = 0;
0133
0134   UniquePtrVector<PDBSymbol> Other;
0135   UniquePtrVector<PDBSymbolFunc> Funcs;
0136   UniquePtrVector<LayoutItemBase> ChildStorage;
0137   std::vector<LayoutItemBase *> LayoutItems;
0138
0139   std::vector<BaseClassLayout *> AllBases;
0140   ArrayRef<BaseClassLayout *> NonVirtualBases;
0141   ArrayRef<BaseClassLayout *> VirtualBases;
0142
0143   VTableLayoutItem *VTable = nullptr;
0144   VBPtrLayoutItem *VBPtr = nullptr;
0145 };
0146
0147 class BaseClassLayout : public UDTLayoutBase {
0148 public:
0149   BaseClassLayout(const UDTLayoutBase &Parent, uint32_t OffsetInParent,
0150                   bool Elide, std::unique_ptr<PDBSymbolTypeBaseClass> Base);
0151
0152   const PDBSymbolTypeBaseClass &getBase() const { return *Base; }
0153   bool isVirtualBase() const { return IsVirtualBase; }
0154   bool isEmptyBase() { return SizeOf == 1 && LayoutSize == 0; }
0155
0156 private:
0157   std::unique_ptr<PDBSymbolTypeBaseClass> Base;
0158   bool IsVirtualBase;
0159 };
0160
0161 class ClassLayout : public UDTLayoutBase {
0162 public:
0163   explicit ClassLayout(const PDBSymbolTypeUDT &UDT);
0164   explicit ClassLayout(std::unique_ptr<PDBSymbolTypeUDT> UDT);
0165
0166   ClassLayout(ClassLayout &&Other) = default;
0167
0168   const PDBSymbolTypeUDT &getClass() const { return UDT; }
0169   uint32_t immediatePadding() const override;
0170
0171 private:
0172   BitVector ImmediateUsedBytes;
0173   std::unique_ptr<PDBSymbolTypeUDT> OwnedStorage;
0174   const PDBSymbolTypeUDT &UDT;
0175 };
0176
0177 } // end namespace pdb
0178 } // end namespace llvm
0179
0180 #endif // LLVM_DEBUGINFO_PDB_UDTLAYOUT_H