clang  14.0.0git
ItaniumCXXABI.cpp
Go to the documentation of this file.
1 //===------- ItaniumCXXABI.cpp - AST support for the Itanium C++ ABI ------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This provides C++ AST support targeting the Itanium C++ ABI, which is
10 // documented at:
11 // http://www.codesourcery.com/public/cxx-abi/abi.html
12 // http://www.codesourcery.com/public/cxx-abi/abi-eh.html
13 //
14 // It also supports the closely-related ARM C++ ABI, documented at:
15 // http://infocenter.arm.com/help/topic/com.arm.doc.ihi0041c/IHI0041C_cppabi.pdf
16 //
17 //===----------------------------------------------------------------------===//
18 
19 #include "CXXABI.h"
20 #include "clang/AST/ASTContext.h"
21 #include "clang/AST/DeclCXX.h"
22 #include "clang/AST/Mangle.h"
24 #include "clang/AST/RecordLayout.h"
25 #include "clang/AST/Type.h"
26 #include "clang/Basic/TargetInfo.h"
27 #include "llvm/ADT/FoldingSet.h"
28 #include "llvm/ADT/iterator.h"
29 
30 using namespace clang;
31 
32 namespace {
33 
34 /// According to Itanium C++ ABI 5.1.2:
35 /// the name of an anonymous union is considered to be
36 /// the name of the first named data member found by a pre-order,
37 /// depth-first, declaration-order walk of the data members of
38 /// the anonymous union.
39 /// If there is no such data member (i.e., if all of the data members
40 /// in the union are unnamed), then there is no way for a program to
41 /// refer to the anonymous union, and there is therefore no need to mangle its name.
42 ///
43 /// Returns the name of anonymous union VarDecl or nullptr if it is not found.
44 static const IdentifierInfo *findAnonymousUnionVarDeclName(const VarDecl& VD) {
45  const RecordType *RT = VD.getType()->getAs<RecordType>();
46  assert(RT && "type of VarDecl is expected to be RecordType.");
47  assert(RT->getDecl()->isUnion() && "RecordType is expected to be a union.");
48  if (const FieldDecl *FD = RT->getDecl()->findFirstNamedDataMember()) {
49  return FD->getIdentifier();
50  }
51 
52  return nullptr;
53 }
54 
55 /// The name of a decomposition declaration.
56 struct DecompositionDeclName {
57  using BindingArray = ArrayRef<const BindingDecl*>;
58 
59  /// Representative example of a set of bindings with these names.
60  BindingArray Bindings;
61 
62  /// Iterators over the sequence of identifiers in the name.
63  struct Iterator
64  : llvm::iterator_adaptor_base<Iterator, BindingArray::const_iterator,
65  std::random_access_iterator_tag,
66  const IdentifierInfo *> {
67  Iterator(BindingArray::const_iterator It) : iterator_adaptor_base(It) {}
68  const IdentifierInfo *operator*() const {
69  return (*this->I)->getIdentifier();
70  }
71  };
72  Iterator begin() const { return Iterator(Bindings.begin()); }
73  Iterator end() const { return Iterator(Bindings.end()); }
74 };
75 }
76 
77 namespace llvm {
78 template<typename T> bool isDenseMapKeyEmpty(T V) {
81 }
82 template<typename T> bool isDenseMapKeyTombstone(T V) {
85 }
86 
87 template<typename T>
89  bool LHSEmpty = isDenseMapKeyEmpty(LHS);
90  bool RHSEmpty = isDenseMapKeyEmpty(RHS);
91  if (LHSEmpty || RHSEmpty)
92  return LHSEmpty && RHSEmpty;
93 
94  bool LHSTombstone = isDenseMapKeyTombstone(LHS);
95  bool RHSTombstone = isDenseMapKeyTombstone(RHS);
96  if (LHSTombstone || RHSTombstone)
97  return LHSTombstone && RHSTombstone;
98 
99  return None;
100 }
101 
102 template<>
103 struct DenseMapInfo<DecompositionDeclName> {
105  static DecompositionDeclName getEmptyKey() {
106  return {ArrayInfo::getEmptyKey()};
107  }
108  static DecompositionDeclName getTombstoneKey() {
109  return {ArrayInfo::getTombstoneKey()};
110  }
111  static unsigned getHashValue(DecompositionDeclName Key) {
112  assert(!isEqual(Key, getEmptyKey()) && !isEqual(Key, getTombstoneKey()));
113  return llvm::hash_combine_range(Key.begin(), Key.end());
114  }
115  static bool isEqual(DecompositionDeclName LHS, DecompositionDeclName RHS) {
117  LHS.Bindings, RHS.Bindings))
118  return *Result;
119 
120  return LHS.Bindings.size() == RHS.Bindings.size() &&
121  std::equal(LHS.begin(), LHS.end(), RHS.begin());
122  }
123 };
124 }
125 
126 namespace {
127 
128 /// Keeps track of the mangled names of lambda expressions and block
129 /// literals within a particular context.
130 class ItaniumNumberingContext : public MangleNumberingContext {
131  ItaniumMangleContext *Mangler;
132  llvm::StringMap<unsigned> LambdaManglingNumbers;
133  unsigned BlockManglingNumber = 0;
134  llvm::DenseMap<const IdentifierInfo *, unsigned> VarManglingNumbers;
135  llvm::DenseMap<const IdentifierInfo *, unsigned> TagManglingNumbers;
136  llvm::DenseMap<DecompositionDeclName, unsigned>
137  DecompsitionDeclManglingNumbers;
138 
139 public:
140  ItaniumNumberingContext(ItaniumMangleContext *Mangler) : Mangler(Mangler) {}
141 
142  unsigned getManglingNumber(const CXXMethodDecl *CallOperator) override {
143  const CXXRecordDecl *Lambda = CallOperator->getParent();
144  assert(Lambda->isLambda());
145 
146  // Computation of the <lambda-sig> is non-trivial and subtle. Rather than
147  // duplicating it here, just mangle the <lambda-sig> directly.
148  llvm::SmallString<128> LambdaSig;
149  llvm::raw_svector_ostream Out(LambdaSig);
150  Mangler->mangleLambdaSig(Lambda, Out);
151 
152  return ++LambdaManglingNumbers[LambdaSig];
153  }
154 
155  unsigned getManglingNumber(const BlockDecl *BD) override {
156  return ++BlockManglingNumber;
157  }
158 
159  unsigned getStaticLocalNumber(const VarDecl *VD) override {
160  return 0;
161  }
162 
163  /// Variable decls are numbered by identifier.
164  unsigned getManglingNumber(const VarDecl *VD, unsigned) override {
165  if (auto *DD = dyn_cast<DecompositionDecl>(VD)) {
166  DecompositionDeclName Name{DD->bindings()};
167  return ++DecompsitionDeclManglingNumbers[Name];
168  }
169 
170  const IdentifierInfo *Identifier = VD->getIdentifier();
171  if (!Identifier) {
172  // VarDecl without an identifier represents an anonymous union
173  // declaration.
174  Identifier = findAnonymousUnionVarDeclName(*VD);
175  }
176  return ++VarManglingNumbers[Identifier];
177  }
178 
179  unsigned getManglingNumber(const TagDecl *TD, unsigned) override {
180  return ++TagManglingNumbers[TD->getIdentifier()];
181  }
182 };
183 
184 // A version of this for SYCL that makes sure that 'device' mangling context
185 // matches the lambda mangling number, so that __builtin_sycl_unique_stable_name
186 // can be consistently generated between a MS and Itanium host by just referring
187 // to the device mangling number.
188 class ItaniumSYCLNumberingContext : public ItaniumNumberingContext {
189  llvm::DenseMap<const CXXMethodDecl *, unsigned> ManglingNumbers;
190  using ManglingItr = decltype(ManglingNumbers)::iterator;
191 
192 public:
193  ItaniumSYCLNumberingContext(ItaniumMangleContext *Mangler)
194  : ItaniumNumberingContext(Mangler) {}
195 
196  unsigned getManglingNumber(const CXXMethodDecl *CallOperator) override {
197  unsigned Number = ItaniumNumberingContext::getManglingNumber(CallOperator);
198  std::pair<ManglingItr, bool> emplace_result =
199  ManglingNumbers.try_emplace(CallOperator, Number);
200  (void)emplace_result;
201  assert(emplace_result.second && "Lambda number set multiple times?");
202  return Number;
203  }
204 
205  using ItaniumNumberingContext::getManglingNumber;
206 
207  unsigned getDeviceManglingNumber(const CXXMethodDecl *CallOperator) override {
208  ManglingItr Itr = ManglingNumbers.find(CallOperator);
209  assert(Itr != ManglingNumbers.end() && "Lambda not yet mangled?");
210 
211  return Itr->second;
212  }
213 };
214 
215 class ItaniumCXXABI : public CXXABI {
216 private:
217  std::unique_ptr<MangleContext> Mangler;
218 protected:
219  ASTContext &Context;
220 public:
221  ItaniumCXXABI(ASTContext &Ctx)
222  : Mangler(Ctx.createMangleContext()), Context(Ctx) {}
223 
224  MemberPointerInfo
225  getMemberPointerInfo(const MemberPointerType *MPT) const override {
226  const TargetInfo &Target = Context.getTargetInfo();
227  TargetInfo::IntType PtrDiff = Target.getPtrDiffType(0);
228  MemberPointerInfo MPI;
229  MPI.Width = Target.getTypeWidth(PtrDiff);
230  MPI.Align = Target.getTypeAlign(PtrDiff);
231  MPI.HasPadding = false;
232  if (MPT->isMemberFunctionPointer())
233  MPI.Width *= 2;
234  return MPI;
235  }
236 
237  CallingConv getDefaultMethodCallConv(bool isVariadic) const override {
238  const llvm::Triple &T = Context.getTargetInfo().getTriple();
239  if (!isVariadic && T.isWindowsGNUEnvironment() &&
240  T.getArch() == llvm::Triple::x86)
241  return CC_X86ThisCall;
242  return Context.getTargetInfo().getDefaultCallingConv();
243  }
244 
245  // We cheat and just check that the class has a vtable pointer, and that it's
246  // only big enough to have a vtable pointer and nothing more (or less).
247  bool isNearlyEmpty(const CXXRecordDecl *RD) const override {
248 
249  // Check that the class has a vtable pointer.
250  if (!RD->isDynamicClass())
251  return false;
252 
253  const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
254  CharUnits PointerSize =
255  Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerWidth(0));
256  return Layout.getNonVirtualSize() == PointerSize;
257  }
258 
259  const CXXConstructorDecl *
260  getCopyConstructorForExceptionObject(CXXRecordDecl *RD) override {
261  return nullptr;
262  }
263 
264  void addCopyConstructorForExceptionObject(CXXRecordDecl *RD,
265  CXXConstructorDecl *CD) override {}
266 
267  void addTypedefNameForUnnamedTagDecl(TagDecl *TD,
268  TypedefNameDecl *DD) override {}
269 
270  TypedefNameDecl *getTypedefNameForUnnamedTagDecl(const TagDecl *TD) override {
271  return nullptr;
272  }
273 
274  void addDeclaratorForUnnamedTagDecl(TagDecl *TD,
275  DeclaratorDecl *DD) override {}
276 
277  DeclaratorDecl *getDeclaratorForUnnamedTagDecl(const TagDecl *TD) override {
278  return nullptr;
279  }
280 
281  std::unique_ptr<MangleNumberingContext>
282  createMangleNumberingContext() const override {
283  if (Context.getLangOpts().isSYCL())
284  return std::make_unique<ItaniumSYCLNumberingContext>(
285  cast<ItaniumMangleContext>(Mangler.get()));
286  return std::make_unique<ItaniumNumberingContext>(
287  cast<ItaniumMangleContext>(Mangler.get()));
288  }
289 };
290 }
291 
293  return new ItaniumCXXABI(Ctx);
294 }
295 
296 std::unique_ptr<MangleNumberingContext>
298  return std::make_unique<ItaniumNumberingContext>(
299  cast<ItaniumMangleContext>(Mangler));
300 }
llvm
Definition: Dominators.h:30
clang::CXXConstructorDecl
Represents a C++ constructor within a class.
Definition: DeclCXX.h:2401
llvm::DenseMapInfo< DecompositionDeclName >::isEqual
static bool isEqual(DecompositionDeclName LHS, DecompositionDeclName RHS)
Definition: ItaniumCXXABI.cpp:115
llvm::SmallVector
Definition: LLVM.h:38
TargetInfo.h
clang::MultiVersionKind::Target
@ Target
clang::FieldDecl
Represents a member of a struct/union/class.
Definition: Decl.h:2835
clang::TargetInfo
Exposes information about the current target.
Definition: TargetInfo.h:189
DeclCXX.h
clang::ItaniumMangleContext
Definition: Mangle.h:171
llvm::Optional< bool >
clang::MemberPointerType::isMemberFunctionPointer
bool isMemberFunctionPointer() const
Returns true if the member type (i.e.
Definition: Type.h:2851
clang::CC_X86ThisCall
@ CC_X86ThisCall
Definition: Specifiers.h:267
Identifier
StringRef Identifier
Definition: Format.cpp:2341
Bindings
llvm::SmallVector< std::pair< const MemRegion *, SVal >, 4 > Bindings
Definition: RetainCountDiagnostics.cpp:616
llvm::DenseMapInfo< DecompositionDeclName >::getHashValue
static unsigned getHashValue(DecompositionDeclName Key)
Definition: ItaniumCXXABI.cpp:111
llvm::isDenseMapKeyEmpty
bool isDenseMapKeyEmpty(T V)
Definition: ItaniumCXXABI.cpp:78
llvm::DenseMapInfo
Definition: TypeOrdering.h:37
V
#define V(N, I)
Definition: ASTContext.h:3121
clang::ItaniumMangleContext::mangleLambdaSig
virtual void mangleLambdaSig(const CXXRecordDecl *Lambda, raw_ostream &)=0
clang::TargetInfo::getDefaultCallingConv
virtual CallingConv getDefaultCallingConv() const
Gets the default calling convention for the given target and declaration context.
Definition: TargetInfo.h:1452
clang::RecordType
A helper class that allows the use of isa/cast/dyncast to detect TagType objects of structs/unions/cl...
Definition: Type.h:4613
clang::MangleContext
MangleContext - Context for tracking state which persists across multiple calls to the C++ name mangl...
Definition: Mangle.h:44
clang::BlockDecl
Represents a block literal declaration, which is like an unnamed FunctionDecl.
Definition: Decl.h:4157
llvm::DenseMapInfo< DecompositionDeclName >::getEmptyKey
static DecompositionDeclName getEmptyKey()
Definition: ItaniumCXXABI.cpp:105
clang::ASTContext
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
Definition: ASTContext.h:212
clang::RecordDecl::findFirstNamedDataMember
const FieldDecl * findFirstNamedDataMember() const
Finds the first data member which has a name.
Definition: Decl.cpp:4714
clang::Type::getAs
const T * getAs() const
Member-template getAs<specific type>'.
Definition: Type.h:7161
clang::ASTRecordLayout::getNonVirtualSize
CharUnits getNonVirtualSize() const
getNonVirtualSize - Get the non-virtual size (in chars) of an object, which is the size of the object...
Definition: RecordLayout.h:210
llvm::areDenseMapKeysEqualSpecialValues
Optional< bool > areDenseMapKeysEqualSpecialValues(T LHS, T RHS)
Definition: ItaniumCXXABI.cpp:88
Type.h
llvm::SmallString< 128 >
ASTContext.h
clang::CallingConv
CallingConv
CallingConv - Specifies the calling convention that a function uses.
Definition: Specifiers.h:263
clang::VarDecl
Represents a variable declaration or definition.
Definition: Decl.h:876
clang::TagDecl
Represents the declaration of a struct/union/class/enum.
Definition: Decl.h:3328
clang::CXXABI
Implements C++ ABI-specific semantic analysis functions.
Definition: CXXABI.h:30
clang::TagDecl::isUnion
bool isUnion() const
Definition: Decl.h:3516
llvm::isDenseMapKeyTombstone
bool isDenseMapKeyTombstone(T V)
Definition: ItaniumCXXABI.cpp:82
CXXABI.h
operator*
clang::CharUnits operator*(clang::CharUnits::QuantityType Scale, const clang::CharUnits &CU)
Definition: CharUnits.h:212
clang::TargetInfo::getTriple
const llvm::Triple & getTriple() const
Returns the target triple of the primary target.
Definition: TargetInfo.h:1130
clang::ASTRecordLayout
ASTRecordLayout - This class contains layout information for one RecordDecl, which is a struct/union/...
Definition: RecordLayout.h:38
clang::CXXRecordDecl
Represents a C++ struct/union/class.
Definition: DeclCXX.h:255
clang::NamedDecl::getIdentifier
IdentifierInfo * getIdentifier() const
Get the identifier that names this declaration, if there is one.
Definition: Decl.h:270
llvm::ArrayRef
Definition: LLVM.h:34
clang::DeclaratorDecl
Represents a ValueDecl that came out of a declarator.
Definition: Decl.h:728
llvm::DenseMapInfo< DecompositionDeclName >::getTombstoneKey
static DecompositionDeclName getTombstoneKey()
Definition: ItaniumCXXABI.cpp:108
clang::IdentifierInfo
One of these records is kept for each identifier that is lexed.
Definition: IdentifierTable.h:84
clang::ASTContext::getTargetInfo
const TargetInfo & getTargetInfo() const
Definition: ASTContext.h:747
clang::LangOptions::isSYCL
bool isSYCL() const
Definition: LangOptions.h:472
clang::MemberPointerType
A pointer to member type per C++ 8.3.3 - Pointers to members.
Definition: Type.h:2831
clang::TransferrableTargetInfo::IntType
IntType
===-— Target Data Type Query Methods ----------------------------—===//
Definition: TargetInfo.h:119
clang::MangleNumberingContext
Keeps track of the mangled names of lambda expressions and block literals within a particular context...
Definition: MangleNumberingContext.h:31
clang::CreateItaniumCXXABI
CXXABI * CreateItaniumCXXABI(ASTContext &Ctx)
Creates an instance of a C++ ABI class.
Definition: ItaniumCXXABI.cpp:292
clang
Definition: CalledOnceCheck.h:17
clang::ASTContext::toCharUnitsFromBits
CharUnits toCharUnitsFromBits(int64_t BitSize) const
Convert a size in bits to a size in characters.
Definition: ASTContext.cpp:2439
clang::TargetInfo::getPointerWidth
uint64_t getPointerWidth(unsigned AddrSpace) const
Return the width of pointers on this target, for the specified address space.
Definition: TargetInfo.h:417
clang::TypedefNameDecl
Base class for declarations which introduce a typedef-name.
Definition: Decl.h:3180
clang::ASTContext::getASTRecordLayout
const ASTRecordLayout & getASTRecordLayout(const RecordDecl *D) const
Get or compute information about the layout of the specified record (struct/union/class) D,...
Definition: RecordLayoutBuilder.cpp:3246
clang::CXXRecordDecl::isDynamicClass
bool isDynamicClass() const
Definition: DeclCXX.h:555
clang::RecordType::getDecl
RecordDecl * getDecl() const
Definition: Type.h:4623
clang::CharUnits
CharUnits - This is an opaque type for sizes expressed in character units.
Definition: CharUnits.h:38
Mangle.h
clang::CXXRecordDecl::isLambda
bool isLambda() const
Determine whether this class describes a lambda function object.
Definition: DeclCXX.h:992
clang::ValueDecl::getType
QualType getType() const
Definition: Decl.h:687
MangleNumberingContext.h
clang::ASTContext::getLangOpts
const LangOptions & getLangOpts() const
Definition: ASTContext.h:765
clang::createItaniumNumberingContext
std::unique_ptr< MangleNumberingContext > createItaniumNumberingContext(MangleContext *)
Definition: ItaniumCXXABI.cpp:297
RecordLayout.h
clang::CXXMethodDecl::getParent
const CXXRecordDecl * getParent() const
Return the parent of this method declaration, which is the class in which this method is defined.
Definition: DeclCXX.h:2063
clang::CXXMethodDecl
Represents a static or instance method of a struct/union/class.
Definition: DeclCXX.h:1948