blob: 3c7e26d413702234c65275a5d3133615cdefea34 [file] [log] [blame]
Guy Benyei11169dd2012-12-18 14:30:41 +00001//===--- ItaniumMangle.cpp - Itanium C++ Name Mangling ----------*- C++ -*-===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// Implements C++ name mangling according to the Itanium C++ ABI,
11// which is used in GCC 3.2 and newer (and many compilers that are
12// ABI-compatible with GCC):
13//
Vlad Tsyrklevichb1bb99d2017-09-12 00:21:17 +000014// http://itanium-cxx-abi.github.io/cxx-abi/abi.html#mangling
Guy Benyei11169dd2012-12-18 14:30:41 +000015//
16//===----------------------------------------------------------------------===//
17#include "clang/AST/Mangle.h"
18#include "clang/AST/ASTContext.h"
19#include "clang/AST/Attr.h"
20#include "clang/AST/Decl.h"
21#include "clang/AST/DeclCXX.h"
22#include "clang/AST/DeclObjC.h"
Alexey Bataev94a4f0c2016-03-03 05:21:39 +000023#include "clang/AST/DeclOpenMP.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000024#include "clang/AST/DeclTemplate.h"
David Majnemer58e5bee2014-03-24 21:43:36 +000025#include "clang/AST/Expr.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000026#include "clang/AST/ExprCXX.h"
27#include "clang/AST/ExprObjC.h"
28#include "clang/AST/TypeLoc.h"
29#include "clang/Basic/ABI.h"
30#include "clang/Basic/SourceManager.h"
31#include "clang/Basic/TargetInfo.h"
32#include "llvm/ADT/StringExtras.h"
33#include "llvm/Support/ErrorHandling.h"
34#include "llvm/Support/raw_ostream.h"
35
36#define MANGLE_CHECKER 0
37
38#if MANGLE_CHECKER
39#include <cxxabi.h>
40#endif
41
42using namespace clang;
43
44namespace {
45
Justin Bognere8d762e2015-05-22 06:48:13 +000046/// Retrieve the declaration context that should be used when mangling the given
47/// declaration.
Guy Benyei11169dd2012-12-18 14:30:41 +000048static const DeclContext *getEffectiveDeclContext(const Decl *D) {
49 // The ABI assumes that lambda closure types that occur within
50 // default arguments live in the context of the function. However, due to
51 // the way in which Clang parses and creates function declarations, this is
52 // not the case: the lambda closure type ends up living in the context
53 // where the function itself resides, because the function declaration itself
54 // had not yet been created. Fix the context here.
55 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
56 if (RD->isLambda())
57 if (ParmVarDecl *ContextParam
58 = dyn_cast_or_null<ParmVarDecl>(RD->getLambdaContextDecl()))
59 return ContextParam->getDeclContext();
60 }
Eli Friedman0cd23352013-07-10 01:33:19 +000061
62 // Perform the same check for block literals.
63 if (const BlockDecl *BD = dyn_cast<BlockDecl>(D)) {
64 if (ParmVarDecl *ContextParam
65 = dyn_cast_or_null<ParmVarDecl>(BD->getBlockManglingContextDecl()))
66 return ContextParam->getDeclContext();
67 }
Guy Benyei11169dd2012-12-18 14:30:41 +000068
Eli Friedman95f50122013-07-02 17:52:28 +000069 const DeclContext *DC = D->getDeclContext();
Alexey Bataev94a4f0c2016-03-03 05:21:39 +000070 if (isa<CapturedDecl>(DC) || isa<OMPDeclareReductionDecl>(DC)) {
71 return getEffectiveDeclContext(cast<Decl>(DC));
72 }
Eli Friedman95f50122013-07-02 17:52:28 +000073
David Majnemerf8c02e62015-02-18 19:08:11 +000074 if (const auto *VD = dyn_cast<VarDecl>(D))
75 if (VD->isExternC())
76 return VD->getASTContext().getTranslationUnitDecl();
77
78 if (const auto *FD = dyn_cast<FunctionDecl>(D))
79 if (FD->isExternC())
80 return FD->getASTContext().getTranslationUnitDecl();
81
Richard Smithec24bbe2016-04-29 01:23:20 +000082 return DC->getRedeclContext();
Guy Benyei11169dd2012-12-18 14:30:41 +000083}
84
85static const DeclContext *getEffectiveParentContext(const DeclContext *DC) {
86 return getEffectiveDeclContext(cast<Decl>(DC));
87}
Eli Friedman95f50122013-07-02 17:52:28 +000088
89static bool isLocalContainerContext(const DeclContext *DC) {
90 return isa<FunctionDecl>(DC) || isa<ObjCMethodDecl>(DC) || isa<BlockDecl>(DC);
91}
92
Eli Friedmaneecc09a2013-07-05 20:27:40 +000093static const RecordDecl *GetLocalClassDecl(const Decl *D) {
Eli Friedman92821742013-07-02 02:01:18 +000094 const DeclContext *DC = getEffectiveDeclContext(D);
Guy Benyei11169dd2012-12-18 14:30:41 +000095 while (!DC->isNamespace() && !DC->isTranslationUnit()) {
Eli Friedman95f50122013-07-02 17:52:28 +000096 if (isLocalContainerContext(DC))
Eli Friedmaneecc09a2013-07-05 20:27:40 +000097 return dyn_cast<RecordDecl>(D);
Eli Friedman92821742013-07-02 02:01:18 +000098 D = cast<Decl>(DC);
99 DC = getEffectiveDeclContext(D);
Guy Benyei11169dd2012-12-18 14:30:41 +0000100 }
Craig Topper36250ad2014-05-12 05:36:57 +0000101 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +0000102}
103
104static const FunctionDecl *getStructor(const FunctionDecl *fn) {
105 if (const FunctionTemplateDecl *ftd = fn->getPrimaryTemplate())
106 return ftd->getTemplatedDecl();
107
108 return fn;
109}
110
111static const NamedDecl *getStructor(const NamedDecl *decl) {
112 const FunctionDecl *fn = dyn_cast_or_null<FunctionDecl>(decl);
113 return (fn ? getStructor(fn) : decl);
114}
David Majnemer2206bf52014-03-05 08:57:59 +0000115
116static bool isLambda(const NamedDecl *ND) {
117 const CXXRecordDecl *Record = dyn_cast<CXXRecordDecl>(ND);
118 if (!Record)
119 return false;
120
121 return Record->isLambda();
122}
123
Guy Benyei11169dd2012-12-18 14:30:41 +0000124static const unsigned UnknownArity = ~0U;
125
Timur Iskhodzhanov67455222013-10-03 06:26:13 +0000126class ItaniumMangleContextImpl : public ItaniumMangleContext {
Eli Friedman3b7d46c2013-07-10 00:30:46 +0000127 typedef std::pair<const DeclContext*, IdentifierInfo*> DiscriminatorKeyTy;
128 llvm::DenseMap<DiscriminatorKeyTy, unsigned> Discriminator;
Guy Benyei11169dd2012-12-18 14:30:41 +0000129 llvm::DenseMap<const NamedDecl*, unsigned> Uniquifier;
Evgeny Astigeevich665027d2014-12-12 16:17:46 +0000130
Guy Benyei11169dd2012-12-18 14:30:41 +0000131public:
Timur Iskhodzhanov67455222013-10-03 06:26:13 +0000132 explicit ItaniumMangleContextImpl(ASTContext &Context,
133 DiagnosticsEngine &Diags)
134 : ItaniumMangleContext(Context, Diags) {}
Guy Benyei11169dd2012-12-18 14:30:41 +0000135
Guy Benyei11169dd2012-12-18 14:30:41 +0000136 /// @name Mangler Entry Points
137 /// @{
138
Craig Toppercbce6e92014-03-11 06:22:39 +0000139 bool shouldMangleCXXName(const NamedDecl *D) override;
David Majnemer58e5bee2014-03-24 21:43:36 +0000140 bool shouldMangleStringLiteral(const StringLiteral *) override {
141 return false;
142 }
Craig Toppercbce6e92014-03-11 06:22:39 +0000143 void mangleCXXName(const NamedDecl *D, raw_ostream &) override;
144 void mangleThunk(const CXXMethodDecl *MD, const ThunkInfo &Thunk,
145 raw_ostream &) override;
Guy Benyei11169dd2012-12-18 14:30:41 +0000146 void mangleCXXDtorThunk(const CXXDestructorDecl *DD, CXXDtorType Type,
147 const ThisAdjustment &ThisAdjustment,
Craig Toppercbce6e92014-03-11 06:22:39 +0000148 raw_ostream &) override;
David Majnemerdaff3702014-05-01 17:50:17 +0000149 void mangleReferenceTemporary(const VarDecl *D, unsigned ManglingNumber,
150 raw_ostream &) override;
Craig Toppercbce6e92014-03-11 06:22:39 +0000151 void mangleCXXVTable(const CXXRecordDecl *RD, raw_ostream &) override;
152 void mangleCXXVTT(const CXXRecordDecl *RD, raw_ostream &) override;
Guy Benyei11169dd2012-12-18 14:30:41 +0000153 void mangleCXXCtorVTable(const CXXRecordDecl *RD, int64_t Offset,
Craig Toppercbce6e92014-03-11 06:22:39 +0000154 const CXXRecordDecl *Type, raw_ostream &) override;
155 void mangleCXXRTTI(QualType T, raw_ostream &) override;
156 void mangleCXXRTTIName(QualType T, raw_ostream &) override;
157 void mangleTypeName(QualType T, raw_ostream &) override;
Guy Benyei11169dd2012-12-18 14:30:41 +0000158 void mangleCXXCtor(const CXXConstructorDecl *D, CXXCtorType Type,
Craig Toppercbce6e92014-03-11 06:22:39 +0000159 raw_ostream &) override;
Guy Benyei11169dd2012-12-18 14:30:41 +0000160 void mangleCXXDtor(const CXXDestructorDecl *D, CXXDtorType Type,
Craig Toppercbce6e92014-03-11 06:22:39 +0000161 raw_ostream &) override;
Guy Benyei11169dd2012-12-18 14:30:41 +0000162
Rafael Espindola1e4df922014-09-16 15:18:21 +0000163 void mangleCXXCtorComdat(const CXXConstructorDecl *D, raw_ostream &) override;
164 void mangleCXXDtorComdat(const CXXDestructorDecl *D, raw_ostream &) override;
Craig Toppercbce6e92014-03-11 06:22:39 +0000165 void mangleStaticGuardVariable(const VarDecl *D, raw_ostream &) override;
166 void mangleDynamicInitializer(const VarDecl *D, raw_ostream &Out) override;
167 void mangleDynamicAtExitDestructor(const VarDecl *D,
168 raw_ostream &Out) override;
Reid Kleckner1d59f992015-01-22 01:36:17 +0000169 void mangleSEHFilterExpression(const NamedDecl *EnclosingDecl,
170 raw_ostream &Out) override;
Reid Klecknerebaf28d2015-04-14 20:59:00 +0000171 void mangleSEHFinallyBlock(const NamedDecl *EnclosingDecl,
172 raw_ostream &Out) override;
Craig Toppercbce6e92014-03-11 06:22:39 +0000173 void mangleItaniumThreadLocalInit(const VarDecl *D, raw_ostream &) override;
174 void mangleItaniumThreadLocalWrapper(const VarDecl *D,
175 raw_ostream &) override;
Guy Benyei11169dd2012-12-18 14:30:41 +0000176
David Majnemer58e5bee2014-03-24 21:43:36 +0000177 void mangleStringLiteral(const StringLiteral *, raw_ostream &) override;
178
Guy Benyei11169dd2012-12-18 14:30:41 +0000179 bool getNextDiscriminator(const NamedDecl *ND, unsigned &disc) {
Eli Friedman3b7d46c2013-07-10 00:30:46 +0000180 // Lambda closure types are already numbered.
David Majnemer2206bf52014-03-05 08:57:59 +0000181 if (isLambda(ND))
182 return false;
Eli Friedman3b7d46c2013-07-10 00:30:46 +0000183
184 // Anonymous tags are already numbered.
185 if (const TagDecl *Tag = dyn_cast<TagDecl>(ND)) {
186 if (Tag->getName().empty() && !Tag->getTypedefNameForAnonDecl())
187 return false;
188 }
189
190 // Use the canonical number for externally visible decls.
191 if (ND->isExternallyVisible()) {
192 unsigned discriminator = getASTContext().getManglingNumber(ND);
193 if (discriminator == 1)
194 return false;
195 disc = discriminator - 2;
196 return true;
197 }
198
199 // Make up a reasonable number for internal decls.
Guy Benyei11169dd2012-12-18 14:30:41 +0000200 unsigned &discriminator = Uniquifier[ND];
Eli Friedman3b7d46c2013-07-10 00:30:46 +0000201 if (!discriminator) {
202 const DeclContext *DC = getEffectiveDeclContext(ND);
203 discriminator = ++Discriminator[std::make_pair(DC, ND->getIdentifier())];
204 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000205 if (discriminator == 1)
206 return false;
207 disc = discriminator-2;
208 return true;
209 }
210 /// @}
211};
212
Justin Bognere8d762e2015-05-22 06:48:13 +0000213/// Manage the mangling of a single name.
Guy Benyei11169dd2012-12-18 14:30:41 +0000214class CXXNameMangler {
Timur Iskhodzhanov67455222013-10-03 06:26:13 +0000215 ItaniumMangleContextImpl &Context;
Guy Benyei11169dd2012-12-18 14:30:41 +0000216 raw_ostream &Out;
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +0000217 bool NullOut = false;
218 /// In the "DisableDerivedAbiTags" mode derived ABI tags are not calculated.
219 /// This mode is used when mangler creates another mangler recursively to
220 /// calculate ABI tags for the function return value or the variable type.
221 /// Also it is required to avoid infinite recursion in some cases.
222 bool DisableDerivedAbiTags = false;
Guy Benyei11169dd2012-12-18 14:30:41 +0000223
224 /// The "structor" is the top-level declaration being mangled, if
225 /// that's not a template specialization; otherwise it's the pattern
226 /// for that specialization.
227 const NamedDecl *Structor;
228 unsigned StructorType;
229
Justin Bognere8d762e2015-05-22 06:48:13 +0000230 /// The next substitution sequence number.
Guy Benyei11169dd2012-12-18 14:30:41 +0000231 unsigned SeqID;
232
233 class FunctionTypeDepthState {
234 unsigned Bits;
235
236 enum { InResultTypeMask = 1 };
237
238 public:
239 FunctionTypeDepthState() : Bits(0) {}
240
241 /// The number of function types we're inside.
242 unsigned getDepth() const {
243 return Bits >> 1;
244 }
245
246 /// True if we're in the return type of the innermost function type.
247 bool isInResultType() const {
248 return Bits & InResultTypeMask;
249 }
250
251 FunctionTypeDepthState push() {
252 FunctionTypeDepthState tmp = *this;
253 Bits = (Bits & ~InResultTypeMask) + 2;
254 return tmp;
255 }
256
257 void enterResultType() {
258 Bits |= InResultTypeMask;
259 }
260
261 void leaveResultType() {
262 Bits &= ~InResultTypeMask;
263 }
264
265 void pop(FunctionTypeDepthState saved) {
266 assert(getDepth() == saved.getDepth() + 1);
267 Bits = saved.Bits;
268 }
269
270 } FunctionTypeDepth;
271
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +0000272 // abi_tag is a gcc attribute, taking one or more strings called "tags".
273 // The goal is to annotate against which version of a library an object was
274 // built and to be able to provide backwards compatibility ("dual abi").
275 // For more information see docs/ItaniumMangleAbiTags.rst.
276 typedef SmallVector<StringRef, 4> AbiTagList;
277
278 // State to gather all implicit and explicit tags used in a mangled name.
279 // Must always have an instance of this while emitting any name to keep
280 // track.
281 class AbiTagState final {
282 public:
283 explicit AbiTagState(AbiTagState *&Head) : LinkHead(Head) {
284 Parent = LinkHead;
285 LinkHead = this;
286 }
287
288 // No copy, no move.
289 AbiTagState(const AbiTagState &) = delete;
290 AbiTagState &operator=(const AbiTagState &) = delete;
291
292 ~AbiTagState() { pop(); }
293
294 void write(raw_ostream &Out, const NamedDecl *ND,
295 const AbiTagList *AdditionalAbiTags) {
296 ND = cast<NamedDecl>(ND->getCanonicalDecl());
297 if (!isa<FunctionDecl>(ND) && !isa<VarDecl>(ND)) {
298 assert(
299 !AdditionalAbiTags &&
300 "only function and variables need a list of additional abi tags");
301 if (const auto *NS = dyn_cast<NamespaceDecl>(ND)) {
302 if (const auto *AbiTag = NS->getAttr<AbiTagAttr>()) {
303 UsedAbiTags.insert(UsedAbiTags.end(), AbiTag->tags().begin(),
304 AbiTag->tags().end());
305 }
306 // Don't emit abi tags for namespaces.
307 return;
308 }
309 }
310
311 AbiTagList TagList;
312 if (const auto *AbiTag = ND->getAttr<AbiTagAttr>()) {
313 UsedAbiTags.insert(UsedAbiTags.end(), AbiTag->tags().begin(),
314 AbiTag->tags().end());
315 TagList.insert(TagList.end(), AbiTag->tags().begin(),
316 AbiTag->tags().end());
317 }
318
319 if (AdditionalAbiTags) {
320 UsedAbiTags.insert(UsedAbiTags.end(), AdditionalAbiTags->begin(),
321 AdditionalAbiTags->end());
322 TagList.insert(TagList.end(), AdditionalAbiTags->begin(),
323 AdditionalAbiTags->end());
324 }
325
326 std::sort(TagList.begin(), TagList.end());
327 TagList.erase(std::unique(TagList.begin(), TagList.end()), TagList.end());
328
329 writeSortedUniqueAbiTags(Out, TagList);
330 }
331
332 const AbiTagList &getUsedAbiTags() const { return UsedAbiTags; }
333 void setUsedAbiTags(const AbiTagList &AbiTags) {
334 UsedAbiTags = AbiTags;
335 }
336
337 const AbiTagList &getEmittedAbiTags() const {
338 return EmittedAbiTags;
339 }
340
341 const AbiTagList &getSortedUniqueUsedAbiTags() {
342 std::sort(UsedAbiTags.begin(), UsedAbiTags.end());
343 UsedAbiTags.erase(std::unique(UsedAbiTags.begin(), UsedAbiTags.end()),
344 UsedAbiTags.end());
345 return UsedAbiTags;
346 }
347
348 private:
349 //! All abi tags used implicitly or explicitly.
350 AbiTagList UsedAbiTags;
351 //! All explicit abi tags (i.e. not from namespace).
352 AbiTagList EmittedAbiTags;
353
354 AbiTagState *&LinkHead;
355 AbiTagState *Parent = nullptr;
356
357 void pop() {
358 assert(LinkHead == this &&
359 "abi tag link head must point to us on destruction");
360 if (Parent) {
361 Parent->UsedAbiTags.insert(Parent->UsedAbiTags.end(),
362 UsedAbiTags.begin(), UsedAbiTags.end());
363 Parent->EmittedAbiTags.insert(Parent->EmittedAbiTags.end(),
364 EmittedAbiTags.begin(),
365 EmittedAbiTags.end());
366 }
367 LinkHead = Parent;
368 }
369
370 void writeSortedUniqueAbiTags(raw_ostream &Out, const AbiTagList &AbiTags) {
371 for (const auto &Tag : AbiTags) {
372 EmittedAbiTags.push_back(Tag);
373 Out << "B";
374 Out << Tag.size();
375 Out << Tag;
376 }
377 }
378 };
379
380 AbiTagState *AbiTags = nullptr;
381 AbiTagState AbiTagsRoot;
382
Guy Benyei11169dd2012-12-18 14:30:41 +0000383 llvm::DenseMap<uintptr_t, unsigned> Substitutions;
Richard Smithdd8b5332017-09-04 05:37:53 +0000384 llvm::DenseMap<StringRef, unsigned> ModuleSubstitutions;
Guy Benyei11169dd2012-12-18 14:30:41 +0000385
386 ASTContext &getASTContext() const { return Context.getASTContext(); }
387
388public:
Timur Iskhodzhanov67455222013-10-03 06:26:13 +0000389 CXXNameMangler(ItaniumMangleContextImpl &C, raw_ostream &Out_,
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +0000390 const NamedDecl *D = nullptr, bool NullOut_ = false)
391 : Context(C), Out(Out_), NullOut(NullOut_), Structor(getStructor(D)),
392 StructorType(0), SeqID(0), AbiTagsRoot(AbiTags) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000393 // These can't be mangled without a ctor type or dtor type.
394 assert(!D || (!isa<CXXDestructorDecl>(D) &&
395 !isa<CXXConstructorDecl>(D)));
396 }
Timur Iskhodzhanov67455222013-10-03 06:26:13 +0000397 CXXNameMangler(ItaniumMangleContextImpl &C, raw_ostream &Out_,
Guy Benyei11169dd2012-12-18 14:30:41 +0000398 const CXXConstructorDecl *D, CXXCtorType Type)
399 : Context(C), Out(Out_), Structor(getStructor(D)), StructorType(Type),
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +0000400 SeqID(0), AbiTagsRoot(AbiTags) { }
Timur Iskhodzhanov67455222013-10-03 06:26:13 +0000401 CXXNameMangler(ItaniumMangleContextImpl &C, raw_ostream &Out_,
Guy Benyei11169dd2012-12-18 14:30:41 +0000402 const CXXDestructorDecl *D, CXXDtorType Type)
403 : Context(C), Out(Out_), Structor(getStructor(D)), StructorType(Type),
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +0000404 SeqID(0), AbiTagsRoot(AbiTags) { }
405
406 CXXNameMangler(CXXNameMangler &Outer, raw_ostream &Out_)
407 : Context(Outer.Context), Out(Out_), NullOut(false),
408 Structor(Outer.Structor), StructorType(Outer.StructorType),
Alex Lorenz7ba609a2016-10-06 09:37:15 +0000409 SeqID(Outer.SeqID), FunctionTypeDepth(Outer.FunctionTypeDepth),
410 AbiTagsRoot(AbiTags), Substitutions(Outer.Substitutions) {}
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +0000411
412 CXXNameMangler(CXXNameMangler &Outer, llvm::raw_null_ostream &Out_)
413 : Context(Outer.Context), Out(Out_), NullOut(true),
414 Structor(Outer.Structor), StructorType(Outer.StructorType),
Alex Lorenz7ba609a2016-10-06 09:37:15 +0000415 SeqID(Outer.SeqID), FunctionTypeDepth(Outer.FunctionTypeDepth),
416 AbiTagsRoot(AbiTags), Substitutions(Outer.Substitutions) {}
Guy Benyei11169dd2012-12-18 14:30:41 +0000417
418#if MANGLE_CHECKER
419 ~CXXNameMangler() {
420 if (Out.str()[0] == '\01')
421 return;
422
423 int status = 0;
424 char *result = abi::__cxa_demangle(Out.str().str().c_str(), 0, 0, &status);
425 assert(status == 0 && "Could not demangle mangled name!");
426 free(result);
427 }
428#endif
429 raw_ostream &getStream() { return Out; }
430
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +0000431 void disableDerivedAbiTags() { DisableDerivedAbiTags = true; }
432 static bool shouldHaveAbiTags(ItaniumMangleContextImpl &C, const VarDecl *VD);
433
David Majnemer7ff7eb72015-02-18 07:47:09 +0000434 void mangle(const NamedDecl *D);
Guy Benyei11169dd2012-12-18 14:30:41 +0000435 void mangleCallOffset(int64_t NonVirtual, int64_t Virtual);
436 void mangleNumber(const llvm::APSInt &I);
437 void mangleNumber(int64_t Number);
438 void mangleFloat(const llvm::APFloat &F);
439 void mangleFunctionEncoding(const FunctionDecl *FD);
David Majnemer3b3bdb52014-05-06 22:49:16 +0000440 void mangleSeqID(unsigned SeqID);
Guy Benyei11169dd2012-12-18 14:30:41 +0000441 void mangleName(const NamedDecl *ND);
442 void mangleType(QualType T);
443 void mangleNameOrStandardSubstitution(const NamedDecl *ND);
444
445private:
David Majnemer3b3bdb52014-05-06 22:49:16 +0000446
Guy Benyei11169dd2012-12-18 14:30:41 +0000447 bool mangleSubstitution(const NamedDecl *ND);
448 bool mangleSubstitution(QualType T);
449 bool mangleSubstitution(TemplateName Template);
450 bool mangleSubstitution(uintptr_t Ptr);
451
Guy Benyei11169dd2012-12-18 14:30:41 +0000452 void mangleExistingSubstitution(TemplateName name);
453
454 bool mangleStandardSubstitution(const NamedDecl *ND);
455
456 void addSubstitution(const NamedDecl *ND) {
457 ND = cast<NamedDecl>(ND->getCanonicalDecl());
458
459 addSubstitution(reinterpret_cast<uintptr_t>(ND));
460 }
461 void addSubstitution(QualType T);
462 void addSubstitution(TemplateName Template);
463 void addSubstitution(uintptr_t Ptr);
Dmitry Polukhinfda467b2016-09-21 08:27:03 +0000464 // Destructive copy substitutions from other mangler.
465 void extendSubstitutions(CXXNameMangler* Other);
Guy Benyei11169dd2012-12-18 14:30:41 +0000466
467 void mangleUnresolvedPrefix(NestedNameSpecifier *qualifier,
Guy Benyei11169dd2012-12-18 14:30:41 +0000468 bool recursive = false);
469 void mangleUnresolvedName(NestedNameSpecifier *qualifier,
Guy Benyei11169dd2012-12-18 14:30:41 +0000470 DeclarationName name,
Richard Smithafecd832016-10-24 20:47:04 +0000471 const TemplateArgumentLoc *TemplateArgs,
472 unsigned NumTemplateArgs,
Guy Benyei11169dd2012-12-18 14:30:41 +0000473 unsigned KnownArity = UnknownArity);
474
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +0000475 void mangleFunctionEncodingBareType(const FunctionDecl *FD);
476
477 void mangleNameWithAbiTags(const NamedDecl *ND,
478 const AbiTagList *AdditionalAbiTags);
Richard Smithdd8b5332017-09-04 05:37:53 +0000479 void mangleModuleName(const Module *M);
480 void mangleModuleNamePrefix(StringRef Name);
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +0000481 void mangleTemplateName(const TemplateDecl *TD,
482 const TemplateArgument *TemplateArgs,
483 unsigned NumTemplateArgs);
484 void mangleUnqualifiedName(const NamedDecl *ND,
485 const AbiTagList *AdditionalAbiTags) {
486 mangleUnqualifiedName(ND, ND->getDeclName(), UnknownArity,
487 AdditionalAbiTags);
Guy Benyei11169dd2012-12-18 14:30:41 +0000488 }
489 void mangleUnqualifiedName(const NamedDecl *ND, DeclarationName Name,
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +0000490 unsigned KnownArity,
491 const AbiTagList *AdditionalAbiTags);
492 void mangleUnscopedName(const NamedDecl *ND,
493 const AbiTagList *AdditionalAbiTags);
494 void mangleUnscopedTemplateName(const TemplateDecl *ND,
495 const AbiTagList *AdditionalAbiTags);
496 void mangleUnscopedTemplateName(TemplateName,
497 const AbiTagList *AdditionalAbiTags);
Guy Benyei11169dd2012-12-18 14:30:41 +0000498 void mangleSourceName(const IdentifierInfo *II);
Erich Keane757d3172016-11-02 18:29:35 +0000499 void mangleRegCallName(const IdentifierInfo *II);
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +0000500 void mangleSourceNameWithAbiTags(
501 const NamedDecl *ND, const AbiTagList *AdditionalAbiTags = nullptr);
502 void mangleLocalName(const Decl *D,
503 const AbiTagList *AdditionalAbiTags);
Eli Friedman95f50122013-07-02 17:52:28 +0000504 void mangleBlockForPrefix(const BlockDecl *Block);
505 void mangleUnqualifiedBlock(const BlockDecl *Block);
Guy Benyei11169dd2012-12-18 14:30:41 +0000506 void mangleLambda(const CXXRecordDecl *Lambda);
507 void mangleNestedName(const NamedDecl *ND, const DeclContext *DC,
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +0000508 const AbiTagList *AdditionalAbiTags,
Guy Benyei11169dd2012-12-18 14:30:41 +0000509 bool NoFunction=false);
510 void mangleNestedName(const TemplateDecl *TD,
511 const TemplateArgument *TemplateArgs,
512 unsigned NumTemplateArgs);
513 void manglePrefix(NestedNameSpecifier *qualifier);
514 void manglePrefix(const DeclContext *DC, bool NoFunction=false);
515 void manglePrefix(QualType type);
Eli Friedman86af13f02013-07-05 18:41:30 +0000516 void mangleTemplatePrefix(const TemplateDecl *ND, bool NoFunction=false);
Guy Benyei11169dd2012-12-18 14:30:41 +0000517 void mangleTemplatePrefix(TemplateName Template);
David Majnemerb8014dd2015-02-19 02:16:16 +0000518 bool mangleUnresolvedTypeOrSimpleId(QualType DestroyedType,
519 StringRef Prefix = "");
David Majnemera88b3592015-02-18 02:28:01 +0000520 void mangleOperatorName(DeclarationName Name, unsigned Arity);
Guy Benyei11169dd2012-12-18 14:30:41 +0000521 void mangleOperatorName(OverloadedOperatorKind OO, unsigned Arity);
John McCall07daf722016-03-01 22:18:03 +0000522 void mangleVendorQualifier(StringRef qualifier);
Andrew Gozillon572bbb02017-10-02 06:25:51 +0000523 void mangleQualifiers(Qualifiers Quals, const DependentAddressSpaceType *DAST = nullptr);
Guy Benyei11169dd2012-12-18 14:30:41 +0000524 void mangleRefQualifier(RefQualifierKind RefQualifier);
525
526 void mangleObjCMethodName(const ObjCMethodDecl *MD);
527
528 // Declare manglers for every type class.
529#define ABSTRACT_TYPE(CLASS, PARENT)
530#define NON_CANONICAL_TYPE(CLASS, PARENT)
531#define TYPE(CLASS, PARENT) void mangleType(const CLASS##Type *T);
532#include "clang/AST/TypeNodes.def"
533
534 void mangleType(const TagType*);
535 void mangleType(TemplateName);
John McCall07daf722016-03-01 22:18:03 +0000536 static StringRef getCallingConvQualifierName(CallingConv CC);
537 void mangleExtParameterInfo(FunctionProtoType::ExtParameterInfo info);
538 void mangleExtFunctionInfo(const FunctionType *T);
539 void mangleBareFunctionType(const FunctionProtoType *T, bool MangleReturnType,
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000540 const FunctionDecl *FD = nullptr);
Guy Benyei11169dd2012-12-18 14:30:41 +0000541 void mangleNeonVectorType(const VectorType *T);
Tim Northover2fe823a2013-08-01 09:23:19 +0000542 void mangleAArch64NeonVectorType(const VectorType *T);
Guy Benyei11169dd2012-12-18 14:30:41 +0000543
544 void mangleIntegerLiteral(QualType T, const llvm::APSInt &Value);
David Majnemer1dabfdc2015-02-14 13:23:54 +0000545 void mangleMemberExprBase(const Expr *base, bool isArrow);
Guy Benyei11169dd2012-12-18 14:30:41 +0000546 void mangleMemberExpr(const Expr *base, bool isArrow,
547 NestedNameSpecifier *qualifier,
548 NamedDecl *firstQualifierLookup,
549 DeclarationName name,
Richard Smithafecd832016-10-24 20:47:04 +0000550 const TemplateArgumentLoc *TemplateArgs,
551 unsigned NumTemplateArgs,
Guy Benyei11169dd2012-12-18 14:30:41 +0000552 unsigned knownArity);
David Majnemer9c775c72014-09-23 04:27:55 +0000553 void mangleCastExpression(const Expr *E, StringRef CastEncoding);
Richard Smith520449d2015-02-05 06:15:50 +0000554 void mangleInitListElements(const InitListExpr *InitList);
Guy Benyei11169dd2012-12-18 14:30:41 +0000555 void mangleExpression(const Expr *E, unsigned Arity = UnknownArity);
Richard Smith5179eb72016-06-28 19:03:57 +0000556 void mangleCXXCtorType(CXXCtorType T, const CXXRecordDecl *InheritedFrom);
Guy Benyei11169dd2012-12-18 14:30:41 +0000557 void mangleCXXDtorType(CXXDtorType T);
558
James Y Knight04ec5bf2015-12-24 02:59:37 +0000559 void mangleTemplateArgs(const TemplateArgumentLoc *TemplateArgs,
560 unsigned NumTemplateArgs);
Guy Benyei11169dd2012-12-18 14:30:41 +0000561 void mangleTemplateArgs(const TemplateArgument *TemplateArgs,
562 unsigned NumTemplateArgs);
563 void mangleTemplateArgs(const TemplateArgumentList &AL);
564 void mangleTemplateArg(TemplateArgument A);
565
566 void mangleTemplateParameter(unsigned Index);
567
568 void mangleFunctionParam(const ParmVarDecl *parm);
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +0000569
570 void writeAbiTags(const NamedDecl *ND,
571 const AbiTagList *AdditionalAbiTags);
572
573 // Returns sorted unique list of ABI tags.
574 AbiTagList makeFunctionReturnTypeTags(const FunctionDecl *FD);
575 // Returns sorted unique list of ABI tags.
576 AbiTagList makeVariableTypeTags(const VarDecl *VD);
Guy Benyei11169dd2012-12-18 14:30:41 +0000577};
578
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000579}
Guy Benyei11169dd2012-12-18 14:30:41 +0000580
Rafael Espindola002667c2013-10-16 01:40:34 +0000581bool ItaniumMangleContextImpl::shouldMangleCXXName(const NamedDecl *D) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000582 const FunctionDecl *FD = dyn_cast<FunctionDecl>(D);
Rafael Espindola5bda63f2013-02-14 01:47:04 +0000583 if (FD) {
584 LanguageLinkage L = FD->getLanguageLinkage();
585 // Overloadable functions need mangling.
586 if (FD->hasAttr<OverloadableAttr>())
587 return true;
588
Rafael Espindola3e0e33d2013-02-14 15:38:59 +0000589 // "main" is not mangled.
590 if (FD->isMain())
Rafael Espindola5bda63f2013-02-14 01:47:04 +0000591 return false;
592
593 // C++ functions and those whose names are not a simple identifier need
594 // mangling.
595 if (!FD->getDeclName().isIdentifier() || L == CXXLanguageLinkage)
596 return true;
Rafael Espindola46d2b6b2013-02-14 03:31:26 +0000597
Rafael Espindola3e0e33d2013-02-14 15:38:59 +0000598 // C functions are not mangled.
599 if (L == CLanguageLinkage)
600 return false;
Rafael Espindola5bda63f2013-02-14 01:47:04 +0000601 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000602
603 // Otherwise, no mangling is done outside C++ mode.
604 if (!getASTContext().getLangOpts().CPlusPlus)
605 return false;
606
Rafael Espindola5bda63f2013-02-14 01:47:04 +0000607 const VarDecl *VD = dyn_cast<VarDecl>(D);
Richard Smithbdb84f32016-07-22 23:36:59 +0000608 if (VD && !isa<DecompositionDecl>(D)) {
Rafael Espindola5bda63f2013-02-14 01:47:04 +0000609 // C variables are not mangled.
610 if (VD->isExternC())
611 return false;
612
613 // Variables at global scope with non-internal linkage are not mangled
Guy Benyei11169dd2012-12-18 14:30:41 +0000614 const DeclContext *DC = getEffectiveDeclContext(D);
615 // Check for extern variable declared locally.
616 if (DC->isFunctionOrMethod() && D->hasLinkage())
617 while (!DC->isNamespace() && !DC->isTranslationUnit())
618 DC = getEffectiveParentContext(DC);
Larisse Voufo39a1e502013-08-06 01:03:05 +0000619 if (DC->isTranslationUnit() && D->getFormalLinkage() != InternalLinkage &&
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +0000620 !CXXNameMangler::shouldHaveAbiTags(*this, VD) &&
Larisse Voufo39a1e502013-08-06 01:03:05 +0000621 !isa<VarTemplateSpecializationDecl>(D))
Guy Benyei11169dd2012-12-18 14:30:41 +0000622 return false;
623 }
624
Guy Benyei11169dd2012-12-18 14:30:41 +0000625 return true;
626}
627
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +0000628void CXXNameMangler::writeAbiTags(const NamedDecl *ND,
629 const AbiTagList *AdditionalAbiTags) {
630 assert(AbiTags && "require AbiTagState");
631 AbiTags->write(Out, ND, DisableDerivedAbiTags ? nullptr : AdditionalAbiTags);
632}
633
634void CXXNameMangler::mangleSourceNameWithAbiTags(
635 const NamedDecl *ND, const AbiTagList *AdditionalAbiTags) {
636 mangleSourceName(ND->getIdentifier());
637 writeAbiTags(ND, AdditionalAbiTags);
638}
639
David Majnemer7ff7eb72015-02-18 07:47:09 +0000640void CXXNameMangler::mangle(const NamedDecl *D) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000641 // <mangled-name> ::= _Z <encoding>
642 // ::= <data name>
643 // ::= <special-name>
David Majnemer7ff7eb72015-02-18 07:47:09 +0000644 Out << "_Z";
Guy Benyei11169dd2012-12-18 14:30:41 +0000645 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
646 mangleFunctionEncoding(FD);
647 else if (const VarDecl *VD = dyn_cast<VarDecl>(D))
648 mangleName(VD);
David Majnemer0eb8bbd2013-10-23 20:52:43 +0000649 else if (const IndirectFieldDecl *IFD = dyn_cast<IndirectFieldDecl>(D))
650 mangleName(IFD->getAnonField());
Guy Benyei11169dd2012-12-18 14:30:41 +0000651 else
652 mangleName(cast<FieldDecl>(D));
653}
654
655void CXXNameMangler::mangleFunctionEncoding(const FunctionDecl *FD) {
656 // <encoding> ::= <function name> <bare-function-type>
Guy Benyei11169dd2012-12-18 14:30:41 +0000657
658 // Don't mangle in the type if this isn't a decl we should typically mangle.
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +0000659 if (!Context.shouldMangleDeclName(FD)) {
660 mangleName(FD);
Guy Benyei11169dd2012-12-18 14:30:41 +0000661 return;
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +0000662 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000663
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +0000664 AbiTagList ReturnTypeAbiTags = makeFunctionReturnTypeTags(FD);
665 if (ReturnTypeAbiTags.empty()) {
666 // There are no tags for return type, the simplest case.
667 mangleName(FD);
668 mangleFunctionEncodingBareType(FD);
669 return;
670 }
671
672 // Mangle function name and encoding to temporary buffer.
673 // We have to output name and encoding to the same mangler to get the same
674 // substitution as it will be in final mangling.
675 SmallString<256> FunctionEncodingBuf;
676 llvm::raw_svector_ostream FunctionEncodingStream(FunctionEncodingBuf);
677 CXXNameMangler FunctionEncodingMangler(*this, FunctionEncodingStream);
678 // Output name of the function.
679 FunctionEncodingMangler.disableDerivedAbiTags();
680 FunctionEncodingMangler.mangleNameWithAbiTags(FD, nullptr);
681
682 // Remember length of the function name in the buffer.
683 size_t EncodingPositionStart = FunctionEncodingStream.str().size();
684 FunctionEncodingMangler.mangleFunctionEncodingBareType(FD);
685
686 // Get tags from return type that are not present in function name or
687 // encoding.
688 const AbiTagList &UsedAbiTags =
689 FunctionEncodingMangler.AbiTagsRoot.getSortedUniqueUsedAbiTags();
690 AbiTagList AdditionalAbiTags(ReturnTypeAbiTags.size());
691 AdditionalAbiTags.erase(
692 std::set_difference(ReturnTypeAbiTags.begin(), ReturnTypeAbiTags.end(),
693 UsedAbiTags.begin(), UsedAbiTags.end(),
694 AdditionalAbiTags.begin()),
695 AdditionalAbiTags.end());
696
697 // Output name with implicit tags and function encoding from temporary buffer.
698 mangleNameWithAbiTags(FD, &AdditionalAbiTags);
699 Out << FunctionEncodingStream.str().substr(EncodingPositionStart);
Dmitry Polukhinfda467b2016-09-21 08:27:03 +0000700
701 // Function encoding could create new substitutions so we have to add
702 // temp mangled substitutions to main mangler.
703 extendSubstitutions(&FunctionEncodingMangler);
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +0000704}
705
706void CXXNameMangler::mangleFunctionEncodingBareType(const FunctionDecl *FD) {
Nick Lewycky0c2986f2014-04-26 00:14:00 +0000707 if (FD->hasAttr<EnableIfAttr>()) {
708 FunctionTypeDepthState Saved = FunctionTypeDepth.push();
709 Out << "Ua9enable_ifI";
710 // FIXME: specific_attr_iterator iterates in reverse order. Fix that and use
711 // it here.
712 for (AttrVec::const_reverse_iterator I = FD->getAttrs().rbegin(),
713 E = FD->getAttrs().rend();
714 I != E; ++I) {
715 EnableIfAttr *EIA = dyn_cast<EnableIfAttr>(*I);
716 if (!EIA)
717 continue;
718 Out << 'X';
719 mangleExpression(EIA->getCond());
720 Out << 'E';
721 }
722 Out << 'E';
723 FunctionTypeDepth.pop(Saved);
724 }
725
Richard Smith5179eb72016-06-28 19:03:57 +0000726 // When mangling an inheriting constructor, the bare function type used is
727 // that of the inherited constructor.
728 if (auto *CD = dyn_cast<CXXConstructorDecl>(FD))
729 if (auto Inherited = CD->getInheritedConstructor())
730 FD = Inherited.getConstructor();
731
Guy Benyei11169dd2012-12-18 14:30:41 +0000732 // Whether the mangling of a function type includes the return type depends on
733 // the context and the nature of the function. The rules for deciding whether
734 // the return type is included are:
735 //
736 // 1. Template functions (names or types) have return types encoded, with
737 // the exceptions listed below.
738 // 2. Function types not appearing as part of a function name mangling,
739 // e.g. parameters, pointer types, etc., have return type encoded, with the
740 // exceptions listed below.
741 // 3. Non-template function names do not have return types encoded.
742 //
743 // The exceptions mentioned in (1) and (2) above, for which the return type is
744 // never included, are
745 // 1. Constructors.
746 // 2. Destructors.
747 // 3. Conversion operator functions, e.g. operator int.
748 bool MangleReturnType = false;
749 if (FunctionTemplateDecl *PrimaryTemplate = FD->getPrimaryTemplate()) {
750 if (!(isa<CXXConstructorDecl>(FD) || isa<CXXDestructorDecl>(FD) ||
751 isa<CXXConversionDecl>(FD)))
752 MangleReturnType = true;
753
754 // Mangle the type of the primary template.
755 FD = PrimaryTemplate->getTemplatedDecl();
756 }
757
John McCall07daf722016-03-01 22:18:03 +0000758 mangleBareFunctionType(FD->getType()->castAs<FunctionProtoType>(),
George Burgess IV3e3bb95b2015-12-02 21:58:08 +0000759 MangleReturnType, FD);
Guy Benyei11169dd2012-12-18 14:30:41 +0000760}
761
762static const DeclContext *IgnoreLinkageSpecDecls(const DeclContext *DC) {
763 while (isa<LinkageSpecDecl>(DC)) {
764 DC = getEffectiveParentContext(DC);
765 }
766
767 return DC;
768}
769
Justin Bognere8d762e2015-05-22 06:48:13 +0000770/// Return whether a given namespace is the 'std' namespace.
Guy Benyei11169dd2012-12-18 14:30:41 +0000771static bool isStd(const NamespaceDecl *NS) {
772 if (!IgnoreLinkageSpecDecls(getEffectiveParentContext(NS))
773 ->isTranslationUnit())
774 return false;
775
776 const IdentifierInfo *II = NS->getOriginalNamespace()->getIdentifier();
777 return II && II->isStr("std");
778}
779
780// isStdNamespace - Return whether a given decl context is a toplevel 'std'
781// namespace.
782static bool isStdNamespace(const DeclContext *DC) {
783 if (!DC->isNamespace())
784 return false;
785
786 return isStd(cast<NamespaceDecl>(DC));
787}
788
789static const TemplateDecl *
790isTemplate(const NamedDecl *ND, const TemplateArgumentList *&TemplateArgs) {
791 // Check if we have a function template.
Richard Smith5179eb72016-06-28 19:03:57 +0000792 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000793 if (const TemplateDecl *TD = FD->getPrimaryTemplate()) {
794 TemplateArgs = FD->getTemplateSpecializationArgs();
795 return TD;
796 }
797 }
798
799 // Check if we have a class template.
800 if (const ClassTemplateSpecializationDecl *Spec =
801 dyn_cast<ClassTemplateSpecializationDecl>(ND)) {
802 TemplateArgs = &Spec->getTemplateArgs();
803 return Spec->getSpecializedTemplate();
804 }
805
Larisse Voufo39a1e502013-08-06 01:03:05 +0000806 // Check if we have a variable template.
807 if (const VarTemplateSpecializationDecl *Spec =
808 dyn_cast<VarTemplateSpecializationDecl>(ND)) {
809 TemplateArgs = &Spec->getTemplateArgs();
810 return Spec->getSpecializedTemplate();
811 }
812
Craig Topper36250ad2014-05-12 05:36:57 +0000813 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +0000814}
815
Guy Benyei11169dd2012-12-18 14:30:41 +0000816void CXXNameMangler::mangleName(const NamedDecl *ND) {
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +0000817 if (const VarDecl *VD = dyn_cast<VarDecl>(ND)) {
818 // Variables should have implicit tags from its type.
819 AbiTagList VariableTypeAbiTags = makeVariableTypeTags(VD);
820 if (VariableTypeAbiTags.empty()) {
821 // Simple case no variable type tags.
822 mangleNameWithAbiTags(VD, nullptr);
823 return;
824 }
825
826 // Mangle variable name to null stream to collect tags.
827 llvm::raw_null_ostream NullOutStream;
828 CXXNameMangler VariableNameMangler(*this, NullOutStream);
829 VariableNameMangler.disableDerivedAbiTags();
830 VariableNameMangler.mangleNameWithAbiTags(VD, nullptr);
831
832 // Get tags from variable type that are not present in its name.
833 const AbiTagList &UsedAbiTags =
834 VariableNameMangler.AbiTagsRoot.getSortedUniqueUsedAbiTags();
835 AbiTagList AdditionalAbiTags(VariableTypeAbiTags.size());
836 AdditionalAbiTags.erase(
837 std::set_difference(VariableTypeAbiTags.begin(),
838 VariableTypeAbiTags.end(), UsedAbiTags.begin(),
839 UsedAbiTags.end(), AdditionalAbiTags.begin()),
840 AdditionalAbiTags.end());
841
842 // Output name with implicit tags.
843 mangleNameWithAbiTags(VD, &AdditionalAbiTags);
844 } else {
845 mangleNameWithAbiTags(ND, nullptr);
846 }
847}
848
849void CXXNameMangler::mangleNameWithAbiTags(const NamedDecl *ND,
850 const AbiTagList *AdditionalAbiTags) {
Richard Smithdd8b5332017-09-04 05:37:53 +0000851 // <name> ::= [<module-name>] <nested-name>
852 // ::= [<module-name>] <unscoped-name>
853 // ::= [<module-name>] <unscoped-template-name> <template-args>
Guy Benyei11169dd2012-12-18 14:30:41 +0000854 // ::= <local-name>
855 //
856 const DeclContext *DC = getEffectiveDeclContext(ND);
857
858 // If this is an extern variable declared locally, the relevant DeclContext
859 // is that of the containing namespace, or the translation unit.
860 // FIXME: This is a hack; extern variables declared locally should have
861 // a proper semantic declaration context!
Eli Friedman95f50122013-07-02 17:52:28 +0000862 if (isLocalContainerContext(DC) && ND->hasLinkage() && !isLambda(ND))
Guy Benyei11169dd2012-12-18 14:30:41 +0000863 while (!DC->isNamespace() && !DC->isTranslationUnit())
864 DC = getEffectiveParentContext(DC);
865 else if (GetLocalClassDecl(ND)) {
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +0000866 mangleLocalName(ND, AdditionalAbiTags);
Guy Benyei11169dd2012-12-18 14:30:41 +0000867 return;
868 }
869
870 DC = IgnoreLinkageSpecDecls(DC);
871
Richard Smithdd8b5332017-09-04 05:37:53 +0000872 if (isLocalContainerContext(DC)) {
873 mangleLocalName(ND, AdditionalAbiTags);
874 return;
875 }
876
877 // Do not mangle the owning module for an external linkage declaration.
878 // This enables backwards-compatibility with non-modular code, and is
879 // a valid choice since conflicts are not permitted by C++ Modules TS
880 // [basic.def.odr]/6.2.
881 if (!ND->hasExternalFormalLinkage())
882 if (Module *M = ND->getOwningModuleForLinkage())
883 mangleModuleName(M);
884
Guy Benyei11169dd2012-12-18 14:30:41 +0000885 if (DC->isTranslationUnit() || isStdNamespace(DC)) {
886 // Check if we have a template.
Craig Topper36250ad2014-05-12 05:36:57 +0000887 const TemplateArgumentList *TemplateArgs = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +0000888 if (const TemplateDecl *TD = isTemplate(ND, TemplateArgs)) {
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +0000889 mangleUnscopedTemplateName(TD, AdditionalAbiTags);
Guy Benyei11169dd2012-12-18 14:30:41 +0000890 mangleTemplateArgs(*TemplateArgs);
891 return;
892 }
893
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +0000894 mangleUnscopedName(ND, AdditionalAbiTags);
Guy Benyei11169dd2012-12-18 14:30:41 +0000895 return;
896 }
897
Richard Smithdd8b5332017-09-04 05:37:53 +0000898 mangleNestedName(ND, DC, AdditionalAbiTags);
899}
900
901void CXXNameMangler::mangleModuleName(const Module *M) {
902 // Implement the C++ Modules TS name mangling proposal; see
903 // https://gcc.gnu.org/wiki/cxx-modules?action=AttachFile
904 //
905 // <module-name> ::= W <unscoped-name>+ E
906 // ::= W <module-subst> <unscoped-name>* E
907 Out << 'W';
908 mangleModuleNamePrefix(M->Name);
909 Out << 'E';
910}
911
912void CXXNameMangler::mangleModuleNamePrefix(StringRef Name) {
913 // <module-subst> ::= _ <seq-id> # 0 < seq-id < 10
914 // ::= W <seq-id - 10> _ # otherwise
915 auto It = ModuleSubstitutions.find(Name);
916 if (It != ModuleSubstitutions.end()) {
917 if (It->second < 10)
918 Out << '_' << static_cast<char>('0' + It->second);
919 else
920 Out << 'W' << (It->second - 10) << '_';
Guy Benyei11169dd2012-12-18 14:30:41 +0000921 return;
922 }
923
Richard Smithdd8b5332017-09-04 05:37:53 +0000924 // FIXME: Preserve hierarchy in module names rather than flattening
925 // them to strings; use Module*s as substitution keys.
926 auto Parts = Name.rsplit('.');
927 if (Parts.second.empty())
928 Parts.second = Parts.first;
929 else
930 mangleModuleNamePrefix(Parts.first);
931
932 Out << Parts.second.size() << Parts.second;
933 ModuleSubstitutions.insert({Name, ModuleSubstitutions.size()});
Guy Benyei11169dd2012-12-18 14:30:41 +0000934}
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +0000935
936void CXXNameMangler::mangleTemplateName(const TemplateDecl *TD,
937 const TemplateArgument *TemplateArgs,
938 unsigned NumTemplateArgs) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000939 const DeclContext *DC = IgnoreLinkageSpecDecls(getEffectiveDeclContext(TD));
940
941 if (DC->isTranslationUnit() || isStdNamespace(DC)) {
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +0000942 mangleUnscopedTemplateName(TD, nullptr);
Guy Benyei11169dd2012-12-18 14:30:41 +0000943 mangleTemplateArgs(TemplateArgs, NumTemplateArgs);
944 } else {
945 mangleNestedName(TD, TemplateArgs, NumTemplateArgs);
946 }
947}
948
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +0000949void CXXNameMangler::mangleUnscopedName(const NamedDecl *ND,
950 const AbiTagList *AdditionalAbiTags) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000951 // <unscoped-name> ::= <unqualified-name>
952 // ::= St <unqualified-name> # ::std::
953
954 if (isStdNamespace(IgnoreLinkageSpecDecls(getEffectiveDeclContext(ND))))
955 Out << "St";
956
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +0000957 mangleUnqualifiedName(ND, AdditionalAbiTags);
Guy Benyei11169dd2012-12-18 14:30:41 +0000958}
959
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +0000960void CXXNameMangler::mangleUnscopedTemplateName(
961 const TemplateDecl *ND, const AbiTagList *AdditionalAbiTags) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000962 // <unscoped-template-name> ::= <unscoped-name>
963 // ::= <substitution>
964 if (mangleSubstitution(ND))
965 return;
966
967 // <template-template-param> ::= <template-param>
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +0000968 if (const auto *TTP = dyn_cast<TemplateTemplateParmDecl>(ND)) {
969 assert(!AdditionalAbiTags &&
970 "template template param cannot have abi tags");
Guy Benyei11169dd2012-12-18 14:30:41 +0000971 mangleTemplateParameter(TTP->getIndex());
David Majnemer6d2b60a2016-07-12 16:48:17 +0000972 } else if (isa<BuiltinTemplateDecl>(ND)) {
973 mangleUnscopedName(ND, AdditionalAbiTags);
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +0000974 } else {
975 mangleUnscopedName(ND->getTemplatedDecl(), AdditionalAbiTags);
976 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000977
Guy Benyei11169dd2012-12-18 14:30:41 +0000978 addSubstitution(ND);
979}
980
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +0000981void CXXNameMangler::mangleUnscopedTemplateName(
982 TemplateName Template, const AbiTagList *AdditionalAbiTags) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000983 // <unscoped-template-name> ::= <unscoped-name>
984 // ::= <substitution>
985 if (TemplateDecl *TD = Template.getAsTemplateDecl())
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +0000986 return mangleUnscopedTemplateName(TD, AdditionalAbiTags);
Guy Benyei11169dd2012-12-18 14:30:41 +0000987
988 if (mangleSubstitution(Template))
989 return;
990
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +0000991 assert(!AdditionalAbiTags &&
992 "dependent template name cannot have abi tags");
993
Guy Benyei11169dd2012-12-18 14:30:41 +0000994 DependentTemplateName *Dependent = Template.getAsDependentTemplateName();
995 assert(Dependent && "Not a dependent template name?");
996 if (const IdentifierInfo *Id = Dependent->getIdentifier())
997 mangleSourceName(Id);
998 else
999 mangleOperatorName(Dependent->getOperator(), UnknownArity);
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00001000
Guy Benyei11169dd2012-12-18 14:30:41 +00001001 addSubstitution(Template);
1002}
1003
1004void CXXNameMangler::mangleFloat(const llvm::APFloat &f) {
1005 // ABI:
1006 // Floating-point literals are encoded using a fixed-length
1007 // lowercase hexadecimal string corresponding to the internal
1008 // representation (IEEE on Itanium), high-order bytes first,
1009 // without leading zeroes. For example: "Lf bf800000 E" is -1.0f
1010 // on Itanium.
1011 // The 'without leading zeroes' thing seems to be an editorial
1012 // mistake; see the discussion on cxx-abi-dev beginning on
1013 // 2012-01-16.
1014
1015 // Our requirements here are just barely weird enough to justify
1016 // using a custom algorithm instead of post-processing APInt::toString().
1017
1018 llvm::APInt valueBits = f.bitcastToAPInt();
1019 unsigned numCharacters = (valueBits.getBitWidth() + 3) / 4;
1020 assert(numCharacters != 0);
1021
1022 // Allocate a buffer of the right number of characters.
Benjamin Kramerc9ba1bd2015-08-04 13:34:50 +00001023 SmallVector<char, 20> buffer(numCharacters);
Guy Benyei11169dd2012-12-18 14:30:41 +00001024
1025 // Fill the buffer left-to-right.
1026 for (unsigned stringIndex = 0; stringIndex != numCharacters; ++stringIndex) {
1027 // The bit-index of the next hex digit.
1028 unsigned digitBitIndex = 4 * (numCharacters - stringIndex - 1);
1029
1030 // Project out 4 bits starting at 'digitIndex'.
Craig Topperc396c532017-03-30 05:48:58 +00001031 uint64_t hexDigit = valueBits.getRawData()[digitBitIndex / 64];
1032 hexDigit >>= (digitBitIndex % 64);
Guy Benyei11169dd2012-12-18 14:30:41 +00001033 hexDigit &= 0xF;
1034
1035 // Map that over to a lowercase hex digit.
1036 static const char charForHex[16] = {
1037 '0', '1', '2', '3', '4', '5', '6', '7',
1038 '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'
1039 };
1040 buffer[stringIndex] = charForHex[hexDigit];
1041 }
1042
1043 Out.write(buffer.data(), numCharacters);
1044}
1045
1046void CXXNameMangler::mangleNumber(const llvm::APSInt &Value) {
1047 if (Value.isSigned() && Value.isNegative()) {
1048 Out << 'n';
1049 Value.abs().print(Out, /*signed*/ false);
1050 } else {
1051 Value.print(Out, /*signed*/ false);
1052 }
1053}
1054
1055void CXXNameMangler::mangleNumber(int64_t Number) {
1056 // <number> ::= [n] <non-negative decimal integer>
1057 if (Number < 0) {
1058 Out << 'n';
1059 Number = -Number;
1060 }
1061
1062 Out << Number;
1063}
1064
1065void CXXNameMangler::mangleCallOffset(int64_t NonVirtual, int64_t Virtual) {
1066 // <call-offset> ::= h <nv-offset> _
1067 // ::= v <v-offset> _
1068 // <nv-offset> ::= <offset number> # non-virtual base override
1069 // <v-offset> ::= <offset number> _ <virtual offset number>
1070 // # virtual base override, with vcall offset
1071 if (!Virtual) {
1072 Out << 'h';
1073 mangleNumber(NonVirtual);
1074 Out << '_';
1075 return;
1076 }
1077
1078 Out << 'v';
1079 mangleNumber(NonVirtual);
1080 Out << '_';
1081 mangleNumber(Virtual);
1082 Out << '_';
1083}
1084
1085void CXXNameMangler::manglePrefix(QualType type) {
David Majnemera88b3592015-02-18 02:28:01 +00001086 if (const auto *TST = type->getAs<TemplateSpecializationType>()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001087 if (!mangleSubstitution(QualType(TST, 0))) {
1088 mangleTemplatePrefix(TST->getTemplateName());
1089
1090 // FIXME: GCC does not appear to mangle the template arguments when
1091 // the template in question is a dependent template name. Should we
1092 // emulate that badness?
1093 mangleTemplateArgs(TST->getArgs(), TST->getNumArgs());
1094 addSubstitution(QualType(TST, 0));
1095 }
David Majnemera88b3592015-02-18 02:28:01 +00001096 } else if (const auto *DTST =
1097 type->getAs<DependentTemplateSpecializationType>()) {
1098 if (!mangleSubstitution(QualType(DTST, 0))) {
1099 TemplateName Template = getASTContext().getDependentTemplateName(
1100 DTST->getQualifier(), DTST->getIdentifier());
1101 mangleTemplatePrefix(Template);
Guy Benyei11169dd2012-12-18 14:30:41 +00001102
David Majnemera88b3592015-02-18 02:28:01 +00001103 // FIXME: GCC does not appear to mangle the template arguments when
1104 // the template in question is a dependent template name. Should we
1105 // emulate that badness?
1106 mangleTemplateArgs(DTST->getArgs(), DTST->getNumArgs());
1107 addSubstitution(QualType(DTST, 0));
1108 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001109 } else {
1110 // We use the QualType mangle type variant here because it handles
1111 // substitutions.
1112 mangleType(type);
1113 }
1114}
1115
1116/// Mangle everything prior to the base-unresolved-name in an unresolved-name.
1117///
Guy Benyei11169dd2012-12-18 14:30:41 +00001118/// \param recursive - true if this is being called recursively,
1119/// i.e. if there is more prefix "to the right".
1120void CXXNameMangler::mangleUnresolvedPrefix(NestedNameSpecifier *qualifier,
Guy Benyei11169dd2012-12-18 14:30:41 +00001121 bool recursive) {
1122
1123 // x, ::x
1124 // <unresolved-name> ::= [gs] <base-unresolved-name>
1125
1126 // T::x / decltype(p)::x
1127 // <unresolved-name> ::= sr <unresolved-type> <base-unresolved-name>
1128
1129 // T::N::x /decltype(p)::N::x
1130 // <unresolved-name> ::= srN <unresolved-type> <unresolved-qualifier-level>+ E
1131 // <base-unresolved-name>
1132
1133 // A::x, N::y, A<T>::z; "gs" means leading "::"
1134 // <unresolved-name> ::= [gs] sr <unresolved-qualifier-level>+ E
1135 // <base-unresolved-name>
1136
1137 switch (qualifier->getKind()) {
1138 case NestedNameSpecifier::Global:
1139 Out << "gs";
1140
1141 // We want an 'sr' unless this is the entire NNS.
1142 if (recursive)
1143 Out << "sr";
1144
1145 // We never want an 'E' here.
1146 return;
1147
Nikola Smiljanic67860242014-09-26 00:28:20 +00001148 case NestedNameSpecifier::Super:
1149 llvm_unreachable("Can't mangle __super specifier");
1150
Guy Benyei11169dd2012-12-18 14:30:41 +00001151 case NestedNameSpecifier::Namespace:
1152 if (qualifier->getPrefix())
David Majnemerb8014dd2015-02-19 02:16:16 +00001153 mangleUnresolvedPrefix(qualifier->getPrefix(),
Guy Benyei11169dd2012-12-18 14:30:41 +00001154 /*recursive*/ true);
1155 else
1156 Out << "sr";
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00001157 mangleSourceNameWithAbiTags(qualifier->getAsNamespace());
Guy Benyei11169dd2012-12-18 14:30:41 +00001158 break;
1159 case NestedNameSpecifier::NamespaceAlias:
1160 if (qualifier->getPrefix())
David Majnemerb8014dd2015-02-19 02:16:16 +00001161 mangleUnresolvedPrefix(qualifier->getPrefix(),
Guy Benyei11169dd2012-12-18 14:30:41 +00001162 /*recursive*/ true);
1163 else
1164 Out << "sr";
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00001165 mangleSourceNameWithAbiTags(qualifier->getAsNamespaceAlias());
Guy Benyei11169dd2012-12-18 14:30:41 +00001166 break;
1167
1168 case NestedNameSpecifier::TypeSpec:
1169 case NestedNameSpecifier::TypeSpecWithTemplate: {
1170 const Type *type = qualifier->getAsType();
1171
1172 // We only want to use an unresolved-type encoding if this is one of:
1173 // - a decltype
1174 // - a template type parameter
1175 // - a template template parameter with arguments
1176 // In all of these cases, we should have no prefix.
1177 if (qualifier->getPrefix()) {
David Majnemerb8014dd2015-02-19 02:16:16 +00001178 mangleUnresolvedPrefix(qualifier->getPrefix(),
Guy Benyei11169dd2012-12-18 14:30:41 +00001179 /*recursive*/ true);
1180 } else {
1181 // Otherwise, all the cases want this.
1182 Out << "sr";
1183 }
1184
David Majnemerb8014dd2015-02-19 02:16:16 +00001185 if (mangleUnresolvedTypeOrSimpleId(QualType(type, 0), recursive ? "N" : ""))
Guy Benyei11169dd2012-12-18 14:30:41 +00001186 return;
1187
Guy Benyei11169dd2012-12-18 14:30:41 +00001188 break;
1189 }
1190
1191 case NestedNameSpecifier::Identifier:
1192 // Member expressions can have these without prefixes.
David Majnemerb8014dd2015-02-19 02:16:16 +00001193 if (qualifier->getPrefix())
1194 mangleUnresolvedPrefix(qualifier->getPrefix(),
Guy Benyei11169dd2012-12-18 14:30:41 +00001195 /*recursive*/ true);
David Majnemerb8014dd2015-02-19 02:16:16 +00001196 else
Guy Benyei11169dd2012-12-18 14:30:41 +00001197 Out << "sr";
Guy Benyei11169dd2012-12-18 14:30:41 +00001198
1199 mangleSourceName(qualifier->getAsIdentifier());
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00001200 // An Identifier has no type information, so we can't emit abi tags for it.
Guy Benyei11169dd2012-12-18 14:30:41 +00001201 break;
1202 }
1203
1204 // If this was the innermost part of the NNS, and we fell out to
1205 // here, append an 'E'.
1206 if (!recursive)
1207 Out << 'E';
1208}
1209
1210/// Mangle an unresolved-name, which is generally used for names which
1211/// weren't resolved to specific entities.
Richard Smithafecd832016-10-24 20:47:04 +00001212void CXXNameMangler::mangleUnresolvedName(
1213 NestedNameSpecifier *qualifier, DeclarationName name,
1214 const TemplateArgumentLoc *TemplateArgs, unsigned NumTemplateArgs,
1215 unsigned knownArity) {
David Majnemerb8014dd2015-02-19 02:16:16 +00001216 if (qualifier) mangleUnresolvedPrefix(qualifier);
David Majnemer1dabfdc2015-02-14 13:23:54 +00001217 switch (name.getNameKind()) {
1218 // <base-unresolved-name> ::= <simple-id>
1219 case DeclarationName::Identifier:
David Majnemera88b3592015-02-18 02:28:01 +00001220 mangleSourceName(name.getAsIdentifierInfo());
1221 break;
1222 // <base-unresolved-name> ::= dn <destructor-name>
1223 case DeclarationName::CXXDestructorName:
1224 Out << "dn";
David Majnemerb8014dd2015-02-19 02:16:16 +00001225 mangleUnresolvedTypeOrSimpleId(name.getCXXNameType());
David Majnemer1dabfdc2015-02-14 13:23:54 +00001226 break;
1227 // <base-unresolved-name> ::= on <operator-name>
1228 case DeclarationName::CXXConversionFunctionName:
1229 case DeclarationName::CXXLiteralOperatorName:
1230 case DeclarationName::CXXOperatorName:
1231 Out << "on";
David Majnemera88b3592015-02-18 02:28:01 +00001232 mangleOperatorName(name, knownArity);
David Majnemer1dabfdc2015-02-14 13:23:54 +00001233 break;
David Majnemer1dabfdc2015-02-14 13:23:54 +00001234 case DeclarationName::CXXConstructorName:
1235 llvm_unreachable("Can't mangle a constructor name!");
1236 case DeclarationName::CXXUsingDirective:
1237 llvm_unreachable("Can't mangle a using directive name!");
Richard Smith35845152017-02-07 01:37:30 +00001238 case DeclarationName::CXXDeductionGuideName:
1239 llvm_unreachable("Can't mangle a deduction guide name!");
David Majnemer1dabfdc2015-02-14 13:23:54 +00001240 case DeclarationName::ObjCMultiArgSelector:
1241 case DeclarationName::ObjCOneArgSelector:
1242 case DeclarationName::ObjCZeroArgSelector:
1243 llvm_unreachable("Can't mangle Objective-C selector names here!");
1244 }
Richard Smithafecd832016-10-24 20:47:04 +00001245
1246 // The <simple-id> and on <operator-name> productions end in an optional
1247 // <template-args>.
1248 if (TemplateArgs)
1249 mangleTemplateArgs(TemplateArgs, NumTemplateArgs);
Guy Benyei11169dd2012-12-18 14:30:41 +00001250}
1251
Guy Benyei11169dd2012-12-18 14:30:41 +00001252void CXXNameMangler::mangleUnqualifiedName(const NamedDecl *ND,
1253 DeclarationName Name,
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00001254 unsigned KnownArity,
1255 const AbiTagList *AdditionalAbiTags) {
David Majnemera88b3592015-02-18 02:28:01 +00001256 unsigned Arity = KnownArity;
Guy Benyei11169dd2012-12-18 14:30:41 +00001257 // <unqualified-name> ::= <operator-name>
1258 // ::= <ctor-dtor-name>
1259 // ::= <source-name>
1260 switch (Name.getNameKind()) {
1261 case DeclarationName::Identifier: {
Richard Smithbdb84f32016-07-22 23:36:59 +00001262 const IdentifierInfo *II = Name.getAsIdentifierInfo();
1263
Richard Smithda383632016-08-15 01:33:41 +00001264 // We mangle decomposition declarations as the names of their bindings.
Richard Smithbdb84f32016-07-22 23:36:59 +00001265 if (auto *DD = dyn_cast<DecompositionDecl>(ND)) {
Richard Smithda383632016-08-15 01:33:41 +00001266 // FIXME: Non-standard mangling for decomposition declarations:
1267 //
1268 // <unqualified-name> ::= DC <source-name>* E
1269 //
1270 // These can never be referenced across translation units, so we do
1271 // not need a cross-vendor mangling for anything other than demanglers.
1272 // Proposed on cxx-abi-dev on 2016-08-12
1273 Out << "DC";
1274 for (auto *BD : DD->bindings())
1275 mangleSourceName(BD->getDeclName().getAsIdentifierInfo());
1276 Out << 'E';
1277 writeAbiTags(ND, AdditionalAbiTags);
1278 break;
Richard Smithbdb84f32016-07-22 23:36:59 +00001279 }
1280
1281 if (II) {
Richard Smithdd8b5332017-09-04 05:37:53 +00001282 // Match GCC's naming convention for internal linkage symbols, for
1283 // symbols that are not actually visible outside of this TU. GCC
1284 // distinguishes between internal and external linkage symbols in
1285 // its mangling, to support cases like this that were valid C++ prior
1286 // to DR426:
1287 //
Guy Benyei11169dd2012-12-18 14:30:41 +00001288 // void test() { extern void foo(); }
1289 // static void foo();
Richard Smithdf963a32017-09-22 22:21:44 +00001290 //
1291 // Don't bother with the L marker for names in anonymous namespaces; the
1292 // 12_GLOBAL__N_1 mangling is quite sufficient there, and this better
1293 // matches GCC anyway, because GCC does not treat anonymous namespaces as
1294 // implying internal linkage.
Rafael Espindola3ae00052013-05-13 00:12:11 +00001295 if (ND && ND->getFormalLinkage() == InternalLinkage &&
Richard Smithdd8b5332017-09-04 05:37:53 +00001296 !ND->isExternallyVisible() &&
Richard Smithdf963a32017-09-22 22:21:44 +00001297 getEffectiveDeclContext(ND)->isFileContext() &&
1298 !ND->isInAnonymousNamespace())
Guy Benyei11169dd2012-12-18 14:30:41 +00001299 Out << 'L';
1300
Erich Keane757d3172016-11-02 18:29:35 +00001301 auto *FD = dyn_cast<FunctionDecl>(ND);
1302 bool IsRegCall = FD &&
1303 FD->getType()->castAs<FunctionType>()->getCallConv() ==
1304 clang::CC_X86RegCall;
1305 if (IsRegCall)
1306 mangleRegCallName(II);
1307 else
1308 mangleSourceName(II);
1309
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00001310 writeAbiTags(ND, AdditionalAbiTags);
Guy Benyei11169dd2012-12-18 14:30:41 +00001311 break;
1312 }
1313
1314 // Otherwise, an anonymous entity. We must have a declaration.
1315 assert(ND && "mangling empty name without declaration");
1316
1317 if (const NamespaceDecl *NS = dyn_cast<NamespaceDecl>(ND)) {
1318 if (NS->isAnonymousNamespace()) {
1319 // This is how gcc mangles these names.
1320 Out << "12_GLOBAL__N_1";
1321 break;
1322 }
1323 }
1324
1325 if (const VarDecl *VD = dyn_cast<VarDecl>(ND)) {
1326 // We must have an anonymous union or struct declaration.
Evgeny Astigeevich665027d2014-12-12 16:17:46 +00001327 const RecordDecl *RD =
Guy Benyei11169dd2012-12-18 14:30:41 +00001328 cast<RecordDecl>(VD->getType()->getAs<RecordType>()->getDecl());
Evgeny Astigeevich665027d2014-12-12 16:17:46 +00001329
Guy Benyei11169dd2012-12-18 14:30:41 +00001330 // Itanium C++ ABI 5.1.2:
1331 //
1332 // For the purposes of mangling, the name of an anonymous union is
1333 // considered to be the name of the first named data member found by a
1334 // pre-order, depth-first, declaration-order walk of the data members of
1335 // the anonymous union. If there is no such data member (i.e., if all of
1336 // the data members in the union are unnamed), then there is no way for
1337 // a program to refer to the anonymous union, and there is therefore no
1338 // need to mangle its name.
Evgeny Astigeevich665027d2014-12-12 16:17:46 +00001339 assert(RD->isAnonymousStructOrUnion()
1340 && "Expected anonymous struct or union!");
1341 const FieldDecl *FD = RD->findFirstNamedDataMember();
Guy Benyei11169dd2012-12-18 14:30:41 +00001342
1343 // It's actually possible for various reasons for us to get here
1344 // with an empty anonymous struct / union. Fortunately, it
1345 // doesn't really matter what name we generate.
1346 if (!FD) break;
1347 assert(FD->getIdentifier() && "Data member name isn't an identifier!");
Evgeny Astigeevich665027d2014-12-12 16:17:46 +00001348
Guy Benyei11169dd2012-12-18 14:30:41 +00001349 mangleSourceName(FD->getIdentifier());
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00001350 // Not emitting abi tags: internal name anyway.
Guy Benyei11169dd2012-12-18 14:30:41 +00001351 break;
1352 }
John McCall924046f2013-04-10 06:08:21 +00001353
1354 // Class extensions have no name as a category, and it's possible
1355 // for them to be the semantic parent of certain declarations
1356 // (primarily, tag decls defined within declarations). Such
1357 // declarations will always have internal linkage, so the name
1358 // doesn't really matter, but we shouldn't crash on them. For
1359 // safety, just handle all ObjC containers here.
1360 if (isa<ObjCContainerDecl>(ND))
1361 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00001362
1363 // We must have an anonymous struct.
1364 const TagDecl *TD = cast<TagDecl>(ND);
1365 if (const TypedefNameDecl *D = TD->getTypedefNameForAnonDecl()) {
1366 assert(TD->getDeclContext() == D->getDeclContext() &&
1367 "Typedef should not be in another decl context!");
1368 assert(D->getDeclName().getAsIdentifierInfo() &&
1369 "Typedef was not named!");
1370 mangleSourceName(D->getDeclName().getAsIdentifierInfo());
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00001371 assert(!AdditionalAbiTags && "Type cannot have additional abi tags");
1372 // Explicit abi tags are still possible; take from underlying type, not
1373 // from typedef.
1374 writeAbiTags(TD, nullptr);
Guy Benyei11169dd2012-12-18 14:30:41 +00001375 break;
1376 }
1377
1378 // <unnamed-type-name> ::= <closure-type-name>
1379 //
1380 // <closure-type-name> ::= Ul <lambda-sig> E [ <nonnegative number> ] _
1381 // <lambda-sig> ::= <parameter-type>+ # Parameter types or 'v' for 'void'.
1382 if (const CXXRecordDecl *Record = dyn_cast<CXXRecordDecl>(TD)) {
1383 if (Record->isLambda() && Record->getLambdaManglingNumber()) {
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00001384 assert(!AdditionalAbiTags &&
1385 "Lambda type cannot have additional abi tags");
Guy Benyei11169dd2012-12-18 14:30:41 +00001386 mangleLambda(Record);
1387 break;
1388 }
1389 }
1390
Eli Friedman3b7d46c2013-07-10 00:30:46 +00001391 if (TD->isExternallyVisible()) {
1392 unsigned UnnamedMangle = getASTContext().getManglingNumber(TD);
Guy Benyei11169dd2012-12-18 14:30:41 +00001393 Out << "Ut";
Eli Friedman3b7d46c2013-07-10 00:30:46 +00001394 if (UnnamedMangle > 1)
Benjamin Kramerb42d9a52015-12-24 10:07:37 +00001395 Out << UnnamedMangle - 2;
Guy Benyei11169dd2012-12-18 14:30:41 +00001396 Out << '_';
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00001397 writeAbiTags(TD, AdditionalAbiTags);
Guy Benyei11169dd2012-12-18 14:30:41 +00001398 break;
1399 }
1400
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00001401 // Get a unique id for the anonymous struct. If it is not a real output
1402 // ID doesn't matter so use fake one.
1403 unsigned AnonStructId = NullOut ? 0 : Context.getAnonymousStructId(TD);
Guy Benyei11169dd2012-12-18 14:30:41 +00001404
1405 // Mangle it as a source name in the form
1406 // [n] $_<id>
1407 // where n is the length of the string.
1408 SmallString<8> Str;
1409 Str += "$_";
1410 Str += llvm::utostr(AnonStructId);
1411
1412 Out << Str.size();
Yaron Keren09fb7c62015-03-10 07:33:23 +00001413 Out << Str;
Guy Benyei11169dd2012-12-18 14:30:41 +00001414 break;
1415 }
1416
1417 case DeclarationName::ObjCZeroArgSelector:
1418 case DeclarationName::ObjCOneArgSelector:
1419 case DeclarationName::ObjCMultiArgSelector:
1420 llvm_unreachable("Can't mangle Objective-C selector names here!");
1421
Richard Smith5179eb72016-06-28 19:03:57 +00001422 case DeclarationName::CXXConstructorName: {
1423 const CXXRecordDecl *InheritedFrom = nullptr;
1424 const TemplateArgumentList *InheritedTemplateArgs = nullptr;
1425 if (auto Inherited =
1426 cast<CXXConstructorDecl>(ND)->getInheritedConstructor()) {
1427 InheritedFrom = Inherited.getConstructor()->getParent();
1428 InheritedTemplateArgs =
1429 Inherited.getConstructor()->getTemplateSpecializationArgs();
1430 }
1431
Guy Benyei11169dd2012-12-18 14:30:41 +00001432 if (ND == Structor)
1433 // If the named decl is the C++ constructor we're mangling, use the type
1434 // we were given.
Richard Smith5179eb72016-06-28 19:03:57 +00001435 mangleCXXCtorType(static_cast<CXXCtorType>(StructorType), InheritedFrom);
Guy Benyei11169dd2012-12-18 14:30:41 +00001436 else
1437 // Otherwise, use the complete constructor name. This is relevant if a
1438 // class with a constructor is declared within a constructor.
Richard Smith5179eb72016-06-28 19:03:57 +00001439 mangleCXXCtorType(Ctor_Complete, InheritedFrom);
1440
1441 // FIXME: The template arguments are part of the enclosing prefix or
1442 // nested-name, but it's more convenient to mangle them here.
1443 if (InheritedTemplateArgs)
1444 mangleTemplateArgs(*InheritedTemplateArgs);
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00001445
1446 writeAbiTags(ND, AdditionalAbiTags);
Guy Benyei11169dd2012-12-18 14:30:41 +00001447 break;
Richard Smith5179eb72016-06-28 19:03:57 +00001448 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001449
1450 case DeclarationName::CXXDestructorName:
1451 if (ND == Structor)
1452 // If the named decl is the C++ destructor we're mangling, use the type we
1453 // were given.
1454 mangleCXXDtorType(static_cast<CXXDtorType>(StructorType));
1455 else
1456 // Otherwise, use the complete destructor name. This is relevant if a
1457 // class with a destructor is declared within a destructor.
1458 mangleCXXDtorType(Dtor_Complete);
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00001459 writeAbiTags(ND, AdditionalAbiTags);
Guy Benyei11169dd2012-12-18 14:30:41 +00001460 break;
1461
David Majnemera88b3592015-02-18 02:28:01 +00001462 case DeclarationName::CXXOperatorName:
1463 if (ND && Arity == UnknownArity) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001464 Arity = cast<FunctionDecl>(ND)->getNumParams();
1465
David Majnemera88b3592015-02-18 02:28:01 +00001466 // If we have a member function, we need to include the 'this' pointer.
1467 if (const auto *MD = dyn_cast<CXXMethodDecl>(ND))
1468 if (!MD->isStatic())
1469 Arity++;
1470 }
Adrian Prantlf3b3ccd2017-12-19 22:06:11 +00001471 LLVM_FALLTHROUGH;
David Majnemera88b3592015-02-18 02:28:01 +00001472 case DeclarationName::CXXConversionFunctionName:
Guy Benyei11169dd2012-12-18 14:30:41 +00001473 case DeclarationName::CXXLiteralOperatorName:
David Majnemera88b3592015-02-18 02:28:01 +00001474 mangleOperatorName(Name, Arity);
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00001475 writeAbiTags(ND, AdditionalAbiTags);
Guy Benyei11169dd2012-12-18 14:30:41 +00001476 break;
1477
Richard Smith35845152017-02-07 01:37:30 +00001478 case DeclarationName::CXXDeductionGuideName:
1479 llvm_unreachable("Can't mangle a deduction guide name!");
1480
Guy Benyei11169dd2012-12-18 14:30:41 +00001481 case DeclarationName::CXXUsingDirective:
1482 llvm_unreachable("Can't mangle a using directive name!");
1483 }
1484}
1485
Erich Keane757d3172016-11-02 18:29:35 +00001486void CXXNameMangler::mangleRegCallName(const IdentifierInfo *II) {
1487 // <source-name> ::= <positive length number> __regcall3__ <identifier>
1488 // <number> ::= [n] <non-negative decimal integer>
1489 // <identifier> ::= <unqualified source code identifier>
1490 Out << II->getLength() + sizeof("__regcall3__") - 1 << "__regcall3__"
1491 << II->getName();
1492}
1493
Guy Benyei11169dd2012-12-18 14:30:41 +00001494void CXXNameMangler::mangleSourceName(const IdentifierInfo *II) {
1495 // <source-name> ::= <positive length number> <identifier>
1496 // <number> ::= [n] <non-negative decimal integer>
1497 // <identifier> ::= <unqualified source code identifier>
1498 Out << II->getLength() << II->getName();
1499}
1500
1501void CXXNameMangler::mangleNestedName(const NamedDecl *ND,
1502 const DeclContext *DC,
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00001503 const AbiTagList *AdditionalAbiTags,
Guy Benyei11169dd2012-12-18 14:30:41 +00001504 bool NoFunction) {
1505 // <nested-name>
1506 // ::= N [<CV-qualifiers>] [<ref-qualifier>] <prefix> <unqualified-name> E
1507 // ::= N [<CV-qualifiers>] [<ref-qualifier>] <template-prefix>
1508 // <template-args> E
1509
1510 Out << 'N';
1511 if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(ND)) {
David Majnemer42350df2013-11-03 23:51:28 +00001512 Qualifiers MethodQuals =
Roger Ferrer Ibanezcb895132017-04-19 12:23:28 +00001513 Qualifiers::fromCVRUMask(Method->getTypeQualifiers());
David Majnemer42350df2013-11-03 23:51:28 +00001514 // We do not consider restrict a distinguishing attribute for overloading
1515 // purposes so we must not mangle it.
1516 MethodQuals.removeRestrict();
1517 mangleQualifiers(MethodQuals);
Guy Benyei11169dd2012-12-18 14:30:41 +00001518 mangleRefQualifier(Method->getRefQualifier());
1519 }
1520
1521 // Check if we have a template.
Craig Topper36250ad2014-05-12 05:36:57 +00001522 const TemplateArgumentList *TemplateArgs = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00001523 if (const TemplateDecl *TD = isTemplate(ND, TemplateArgs)) {
Eli Friedman86af13f02013-07-05 18:41:30 +00001524 mangleTemplatePrefix(TD, NoFunction);
Guy Benyei11169dd2012-12-18 14:30:41 +00001525 mangleTemplateArgs(*TemplateArgs);
1526 }
1527 else {
1528 manglePrefix(DC, NoFunction);
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00001529 mangleUnqualifiedName(ND, AdditionalAbiTags);
Guy Benyei11169dd2012-12-18 14:30:41 +00001530 }
1531
1532 Out << 'E';
1533}
1534void CXXNameMangler::mangleNestedName(const TemplateDecl *TD,
1535 const TemplateArgument *TemplateArgs,
1536 unsigned NumTemplateArgs) {
1537 // <nested-name> ::= N [<CV-qualifiers>] <template-prefix> <template-args> E
1538
1539 Out << 'N';
1540
1541 mangleTemplatePrefix(TD);
1542 mangleTemplateArgs(TemplateArgs, NumTemplateArgs);
1543
1544 Out << 'E';
1545}
1546
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00001547void CXXNameMangler::mangleLocalName(const Decl *D,
1548 const AbiTagList *AdditionalAbiTags) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001549 // <local-name> := Z <function encoding> E <entity name> [<discriminator>]
1550 // := Z <function encoding> E s [<discriminator>]
1551 // <local-name> := Z <function encoding> E d [ <parameter number> ]
1552 // _ <entity name>
1553 // <discriminator> := _ <non-negative number>
Eli Friedman95f50122013-07-02 17:52:28 +00001554 assert(isa<NamedDecl>(D) || isa<BlockDecl>(D));
Eli Friedmaneecc09a2013-07-05 20:27:40 +00001555 const RecordDecl *RD = GetLocalClassDecl(D);
Eli Friedman95f50122013-07-02 17:52:28 +00001556 const DeclContext *DC = getEffectiveDeclContext(RD ? RD : D);
Guy Benyei11169dd2012-12-18 14:30:41 +00001557
1558 Out << 'Z';
1559
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00001560 {
1561 AbiTagState LocalAbiTags(AbiTags);
1562
1563 if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(DC))
1564 mangleObjCMethodName(MD);
1565 else if (const BlockDecl *BD = dyn_cast<BlockDecl>(DC))
1566 mangleBlockForPrefix(BD);
1567 else
1568 mangleFunctionEncoding(cast<FunctionDecl>(DC));
1569
1570 // Implicit ABI tags (from namespace) are not available in the following
1571 // entity; reset to actually emitted tags, which are available.
1572 LocalAbiTags.setUsedAbiTags(LocalAbiTags.getEmittedAbiTags());
1573 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001574
Eli Friedman92821742013-07-02 02:01:18 +00001575 Out << 'E';
1576
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00001577 // GCC 5.3.0 doesn't emit derived ABI tags for local names but that seems to
1578 // be a bug that is fixed in trunk.
1579
Eli Friedman92821742013-07-02 02:01:18 +00001580 if (RD) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001581 // The parameter number is omitted for the last parameter, 0 for the
1582 // second-to-last parameter, 1 for the third-to-last parameter, etc. The
1583 // <entity name> will of course contain a <closure-type-name>: Its
1584 // numbering will be local to the particular argument in which it appears
1585 // -- other default arguments do not affect its encoding.
Eli Friedmaneecc09a2013-07-05 20:27:40 +00001586 const CXXRecordDecl *CXXRD = dyn_cast<CXXRecordDecl>(RD);
Richard Smithcb2ba5a2016-07-18 22:37:35 +00001587 if (CXXRD && CXXRD->isLambda()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001588 if (const ParmVarDecl *Parm
Eli Friedmaneecc09a2013-07-05 20:27:40 +00001589 = dyn_cast_or_null<ParmVarDecl>(CXXRD->getLambdaContextDecl())) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001590 if (const FunctionDecl *Func
1591 = dyn_cast<FunctionDecl>(Parm->getDeclContext())) {
1592 Out << 'd';
1593 unsigned Num = Func->getNumParams() - Parm->getFunctionScopeIndex();
1594 if (Num > 1)
1595 mangleNumber(Num - 2);
1596 Out << '_';
Guy Benyei11169dd2012-12-18 14:30:41 +00001597 }
1598 }
1599 }
1600
1601 // Mangle the name relative to the closest enclosing function.
Eli Friedman95f50122013-07-02 17:52:28 +00001602 // equality ok because RD derived from ND above
1603 if (D == RD) {
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00001604 mangleUnqualifiedName(RD, AdditionalAbiTags);
Eli Friedman95f50122013-07-02 17:52:28 +00001605 } else if (const BlockDecl *BD = dyn_cast<BlockDecl>(D)) {
1606 manglePrefix(getEffectiveDeclContext(BD), true /*NoFunction*/);
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00001607 assert(!AdditionalAbiTags && "Block cannot have additional abi tags");
Eli Friedman95f50122013-07-02 17:52:28 +00001608 mangleUnqualifiedBlock(BD);
1609 } else {
1610 const NamedDecl *ND = cast<NamedDecl>(D);
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00001611 mangleNestedName(ND, getEffectiveDeclContext(ND), AdditionalAbiTags,
1612 true /*NoFunction*/);
Eli Friedman95f50122013-07-02 17:52:28 +00001613 }
Eli Friedman0cd23352013-07-10 01:33:19 +00001614 } else if (const BlockDecl *BD = dyn_cast<BlockDecl>(D)) {
1615 // Mangle a block in a default parameter; see above explanation for
1616 // lambdas.
1617 if (const ParmVarDecl *Parm
1618 = dyn_cast_or_null<ParmVarDecl>(BD->getBlockManglingContextDecl())) {
1619 if (const FunctionDecl *Func
1620 = dyn_cast<FunctionDecl>(Parm->getDeclContext())) {
1621 Out << 'd';
1622 unsigned Num = Func->getNumParams() - Parm->getFunctionScopeIndex();
1623 if (Num > 1)
1624 mangleNumber(Num - 2);
1625 Out << '_';
1626 }
1627 }
1628
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00001629 assert(!AdditionalAbiTags && "Block cannot have additional abi tags");
Eli Friedman0cd23352013-07-10 01:33:19 +00001630 mangleUnqualifiedBlock(BD);
Eli Friedman3b7d46c2013-07-10 00:30:46 +00001631 } else {
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00001632 mangleUnqualifiedName(cast<NamedDecl>(D), AdditionalAbiTags);
Guy Benyei11169dd2012-12-18 14:30:41 +00001633 }
Eli Friedman0cd23352013-07-10 01:33:19 +00001634
Eli Friedman3b7d46c2013-07-10 00:30:46 +00001635 if (const NamedDecl *ND = dyn_cast<NamedDecl>(RD ? RD : D)) {
1636 unsigned disc;
1637 if (Context.getNextDiscriminator(ND, disc)) {
1638 if (disc < 10)
1639 Out << '_' << disc;
1640 else
1641 Out << "__" << disc << '_';
1642 }
1643 }
Eli Friedman95f50122013-07-02 17:52:28 +00001644}
1645
1646void CXXNameMangler::mangleBlockForPrefix(const BlockDecl *Block) {
1647 if (GetLocalClassDecl(Block)) {
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00001648 mangleLocalName(Block, /* AdditionalAbiTags */ nullptr);
Eli Friedman95f50122013-07-02 17:52:28 +00001649 return;
1650 }
1651 const DeclContext *DC = getEffectiveDeclContext(Block);
1652 if (isLocalContainerContext(DC)) {
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00001653 mangleLocalName(Block, /* AdditionalAbiTags */ nullptr);
Eli Friedman95f50122013-07-02 17:52:28 +00001654 return;
1655 }
1656 manglePrefix(getEffectiveDeclContext(Block));
1657 mangleUnqualifiedBlock(Block);
1658}
1659
1660void CXXNameMangler::mangleUnqualifiedBlock(const BlockDecl *Block) {
1661 if (Decl *Context = Block->getBlockManglingContextDecl()) {
1662 if ((isa<VarDecl>(Context) || isa<FieldDecl>(Context)) &&
1663 Context->getDeclContext()->isRecord()) {
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00001664 const auto *ND = cast<NamedDecl>(Context);
1665 if (ND->getIdentifier()) {
1666 mangleSourceNameWithAbiTags(ND);
1667 Out << 'M';
Eli Friedman95f50122013-07-02 17:52:28 +00001668 }
1669 }
1670 }
1671
1672 // If we have a block mangling number, use it.
1673 unsigned Number = Block->getBlockManglingNumber();
1674 // Otherwise, just make up a number. It doesn't matter what it is because
1675 // the symbol in question isn't externally visible.
1676 if (!Number)
1677 Number = Context.getBlockId(Block, false);
Richard Smith48b35d92017-09-07 05:41:24 +00001678 else {
1679 // Stored mangling numbers are 1-based.
1680 --Number;
1681 }
Eli Friedman95f50122013-07-02 17:52:28 +00001682 Out << "Ub";
David Majnemer11d24272014-08-04 06:16:50 +00001683 if (Number > 0)
1684 Out << Number - 1;
Eli Friedman95f50122013-07-02 17:52:28 +00001685 Out << '_';
Guy Benyei11169dd2012-12-18 14:30:41 +00001686}
1687
1688void CXXNameMangler::mangleLambda(const CXXRecordDecl *Lambda) {
1689 // If the context of a closure type is an initializer for a class member
1690 // (static or nonstatic), it is encoded in a qualified name with a final
1691 // <prefix> of the form:
1692 //
1693 // <data-member-prefix> := <member source-name> M
1694 //
1695 // Technically, the data-member-prefix is part of the <prefix>. However,
1696 // since a closure type will always be mangled with a prefix, it's easier
1697 // to emit that last part of the prefix here.
1698 if (Decl *Context = Lambda->getLambdaContextDecl()) {
1699 if ((isa<VarDecl>(Context) || isa<FieldDecl>(Context)) &&
Richard Smithc95d2c52017-09-22 04:25:05 +00001700 !isa<ParmVarDecl>(Context)) {
1701 // FIXME: 'inline auto [a, b] = []{ return ... };' does not get a
1702 // reasonable mangling here.
Guy Benyei11169dd2012-12-18 14:30:41 +00001703 if (const IdentifierInfo *Name
1704 = cast<NamedDecl>(Context)->getIdentifier()) {
1705 mangleSourceName(Name);
Richard Smithc95d2c52017-09-22 04:25:05 +00001706 const TemplateArgumentList *TemplateArgs = nullptr;
Simon Pilgrimb2eda762017-09-22 16:26:17 +00001707 if (isTemplate(cast<NamedDecl>(Context), TemplateArgs))
Richard Smithc95d2c52017-09-22 04:25:05 +00001708 mangleTemplateArgs(*TemplateArgs);
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00001709 Out << 'M';
Guy Benyei11169dd2012-12-18 14:30:41 +00001710 }
1711 }
1712 }
1713
1714 Out << "Ul";
1715 const FunctionProtoType *Proto = Lambda->getLambdaTypeInfo()->getType()->
1716 getAs<FunctionProtoType>();
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00001717 mangleBareFunctionType(Proto, /*MangleReturnType=*/false,
1718 Lambda->getLambdaStaticInvoker());
Guy Benyei11169dd2012-12-18 14:30:41 +00001719 Out << "E";
1720
1721 // The number is omitted for the first closure type with a given
1722 // <lambda-sig> in a given context; it is n-2 for the nth closure type
1723 // (in lexical order) with that same <lambda-sig> and context.
1724 //
1725 // The AST keeps track of the number for us.
1726 unsigned Number = Lambda->getLambdaManglingNumber();
1727 assert(Number > 0 && "Lambda should be mangled as an unnamed class");
1728 if (Number > 1)
1729 mangleNumber(Number - 2);
1730 Out << '_';
1731}
1732
1733void CXXNameMangler::manglePrefix(NestedNameSpecifier *qualifier) {
1734 switch (qualifier->getKind()) {
1735 case NestedNameSpecifier::Global:
1736 // nothing
1737 return;
1738
Nikola Smiljanic67860242014-09-26 00:28:20 +00001739 case NestedNameSpecifier::Super:
1740 llvm_unreachable("Can't mangle __super specifier");
1741
Guy Benyei11169dd2012-12-18 14:30:41 +00001742 case NestedNameSpecifier::Namespace:
1743 mangleName(qualifier->getAsNamespace());
1744 return;
1745
1746 case NestedNameSpecifier::NamespaceAlias:
1747 mangleName(qualifier->getAsNamespaceAlias()->getNamespace());
1748 return;
1749
1750 case NestedNameSpecifier::TypeSpec:
1751 case NestedNameSpecifier::TypeSpecWithTemplate:
1752 manglePrefix(QualType(qualifier->getAsType(), 0));
1753 return;
1754
1755 case NestedNameSpecifier::Identifier:
1756 // Member expressions can have these without prefixes, but that
1757 // should end up in mangleUnresolvedPrefix instead.
1758 assert(qualifier->getPrefix());
1759 manglePrefix(qualifier->getPrefix());
1760
1761 mangleSourceName(qualifier->getAsIdentifier());
1762 return;
1763 }
1764
1765 llvm_unreachable("unexpected nested name specifier");
1766}
1767
1768void CXXNameMangler::manglePrefix(const DeclContext *DC, bool NoFunction) {
1769 // <prefix> ::= <prefix> <unqualified-name>
1770 // ::= <template-prefix> <template-args>
1771 // ::= <template-param>
1772 // ::= # empty
1773 // ::= <substitution>
1774
1775 DC = IgnoreLinkageSpecDecls(DC);
1776
1777 if (DC->isTranslationUnit())
1778 return;
1779
Eli Friedman95f50122013-07-02 17:52:28 +00001780 if (NoFunction && isLocalContainerContext(DC))
1781 return;
Eli Friedman7e346a82013-07-01 20:22:57 +00001782
Eli Friedman95f50122013-07-02 17:52:28 +00001783 assert(!isLocalContainerContext(DC));
1784
Guy Benyei11169dd2012-12-18 14:30:41 +00001785 const NamedDecl *ND = cast<NamedDecl>(DC);
1786 if (mangleSubstitution(ND))
1787 return;
1788
1789 // Check if we have a template.
Craig Topper36250ad2014-05-12 05:36:57 +00001790 const TemplateArgumentList *TemplateArgs = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00001791 if (const TemplateDecl *TD = isTemplate(ND, TemplateArgs)) {
1792 mangleTemplatePrefix(TD);
1793 mangleTemplateArgs(*TemplateArgs);
Eli Friedman95f50122013-07-02 17:52:28 +00001794 } else {
Guy Benyei11169dd2012-12-18 14:30:41 +00001795 manglePrefix(getEffectiveDeclContext(ND), NoFunction);
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00001796 mangleUnqualifiedName(ND, nullptr);
Guy Benyei11169dd2012-12-18 14:30:41 +00001797 }
1798
1799 addSubstitution(ND);
1800}
1801
1802void CXXNameMangler::mangleTemplatePrefix(TemplateName Template) {
1803 // <template-prefix> ::= <prefix> <template unqualified-name>
1804 // ::= <template-param>
1805 // ::= <substitution>
1806 if (TemplateDecl *TD = Template.getAsTemplateDecl())
1807 return mangleTemplatePrefix(TD);
1808
1809 if (QualifiedTemplateName *Qualified = Template.getAsQualifiedTemplateName())
1810 manglePrefix(Qualified->getQualifier());
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00001811
Guy Benyei11169dd2012-12-18 14:30:41 +00001812 if (OverloadedTemplateStorage *Overloaded
1813 = Template.getAsOverloadedTemplate()) {
Craig Topper36250ad2014-05-12 05:36:57 +00001814 mangleUnqualifiedName(nullptr, (*Overloaded->begin())->getDeclName(),
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00001815 UnknownArity, nullptr);
Guy Benyei11169dd2012-12-18 14:30:41 +00001816 return;
1817 }
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00001818
Guy Benyei11169dd2012-12-18 14:30:41 +00001819 DependentTemplateName *Dependent = Template.getAsDependentTemplateName();
1820 assert(Dependent && "Unknown template name kind?");
David Majnemer1dabfdc2015-02-14 13:23:54 +00001821 if (NestedNameSpecifier *Qualifier = Dependent->getQualifier())
1822 manglePrefix(Qualifier);
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00001823 mangleUnscopedTemplateName(Template, /* AdditionalAbiTags */ nullptr);
Guy Benyei11169dd2012-12-18 14:30:41 +00001824}
1825
Eli Friedman86af13f02013-07-05 18:41:30 +00001826void CXXNameMangler::mangleTemplatePrefix(const TemplateDecl *ND,
1827 bool NoFunction) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001828 // <template-prefix> ::= <prefix> <template unqualified-name>
1829 // ::= <template-param>
1830 // ::= <substitution>
1831 // <template-template-param> ::= <template-param>
1832 // <substitution>
1833
1834 if (mangleSubstitution(ND))
1835 return;
1836
1837 // <template-template-param> ::= <template-param>
David Majnemer90a3b192014-10-24 20:22:57 +00001838 if (const auto *TTP = dyn_cast<TemplateTemplateParmDecl>(ND)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001839 mangleTemplateParameter(TTP->getIndex());
David Majnemer90a3b192014-10-24 20:22:57 +00001840 } else {
1841 manglePrefix(getEffectiveDeclContext(ND), NoFunction);
David Majnemer6d2b60a2016-07-12 16:48:17 +00001842 if (isa<BuiltinTemplateDecl>(ND))
1843 mangleUnqualifiedName(ND, nullptr);
1844 else
1845 mangleUnqualifiedName(ND->getTemplatedDecl(), nullptr);
Guy Benyei11169dd2012-12-18 14:30:41 +00001846 }
1847
Guy Benyei11169dd2012-12-18 14:30:41 +00001848 addSubstitution(ND);
1849}
1850
1851/// Mangles a template name under the production <type>. Required for
1852/// template template arguments.
1853/// <type> ::= <class-enum-type>
1854/// ::= <template-param>
1855/// ::= <substitution>
1856void CXXNameMangler::mangleType(TemplateName TN) {
1857 if (mangleSubstitution(TN))
1858 return;
Craig Topper36250ad2014-05-12 05:36:57 +00001859
1860 TemplateDecl *TD = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00001861
1862 switch (TN.getKind()) {
1863 case TemplateName::QualifiedTemplate:
1864 TD = TN.getAsQualifiedTemplateName()->getTemplateDecl();
1865 goto HaveDecl;
1866
1867 case TemplateName::Template:
1868 TD = TN.getAsTemplateDecl();
1869 goto HaveDecl;
1870
1871 HaveDecl:
1872 if (isa<TemplateTemplateParmDecl>(TD))
1873 mangleTemplateParameter(cast<TemplateTemplateParmDecl>(TD)->getIndex());
1874 else
1875 mangleName(TD);
1876 break;
1877
1878 case TemplateName::OverloadedTemplate:
1879 llvm_unreachable("can't mangle an overloaded template name as a <type>");
1880
1881 case TemplateName::DependentTemplate: {
1882 const DependentTemplateName *Dependent = TN.getAsDependentTemplateName();
1883 assert(Dependent->isIdentifier());
1884
1885 // <class-enum-type> ::= <name>
1886 // <name> ::= <nested-name>
David Majnemercb34c672015-02-19 05:51:14 +00001887 mangleUnresolvedPrefix(Dependent->getQualifier());
Guy Benyei11169dd2012-12-18 14:30:41 +00001888 mangleSourceName(Dependent->getIdentifier());
1889 break;
1890 }
1891
1892 case TemplateName::SubstTemplateTemplateParm: {
1893 // Substituted template parameters are mangled as the substituted
1894 // template. This will check for the substitution twice, which is
1895 // fine, but we have to return early so that we don't try to *add*
1896 // the substitution twice.
1897 SubstTemplateTemplateParmStorage *subst
1898 = TN.getAsSubstTemplateTemplateParm();
1899 mangleType(subst->getReplacement());
1900 return;
1901 }
1902
1903 case TemplateName::SubstTemplateTemplateParmPack: {
1904 // FIXME: not clear how to mangle this!
1905 // template <template <class> class T...> class A {
1906 // template <template <class> class U...> void foo(B<T,U> x...);
1907 // };
1908 Out << "_SUBSTPACK_";
1909 break;
1910 }
1911 }
1912
1913 addSubstitution(TN);
1914}
1915
David Majnemerb8014dd2015-02-19 02:16:16 +00001916bool CXXNameMangler::mangleUnresolvedTypeOrSimpleId(QualType Ty,
1917 StringRef Prefix) {
1918 // Only certain other types are valid as prefixes; enumerate them.
1919 switch (Ty->getTypeClass()) {
1920 case Type::Builtin:
1921 case Type::Complex:
1922 case Type::Adjusted:
1923 case Type::Decayed:
1924 case Type::Pointer:
1925 case Type::BlockPointer:
1926 case Type::LValueReference:
1927 case Type::RValueReference:
1928 case Type::MemberPointer:
1929 case Type::ConstantArray:
1930 case Type::IncompleteArray:
1931 case Type::VariableArray:
1932 case Type::DependentSizedArray:
Andrew Gozillon572bbb02017-10-02 06:25:51 +00001933 case Type::DependentAddressSpace:
David Majnemerb8014dd2015-02-19 02:16:16 +00001934 case Type::DependentSizedExtVector:
1935 case Type::Vector:
1936 case Type::ExtVector:
1937 case Type::FunctionProto:
1938 case Type::FunctionNoProto:
1939 case Type::Paren:
1940 case Type::Attributed:
1941 case Type::Auto:
Richard Smith600b5262017-01-26 20:40:47 +00001942 case Type::DeducedTemplateSpecialization:
David Majnemerb8014dd2015-02-19 02:16:16 +00001943 case Type::PackExpansion:
1944 case Type::ObjCObject:
1945 case Type::ObjCInterface:
1946 case Type::ObjCObjectPointer:
Manman Rene6be26c2016-09-13 17:25:08 +00001947 case Type::ObjCTypeParam:
David Majnemerb8014dd2015-02-19 02:16:16 +00001948 case Type::Atomic:
Xiuli Pan9c14e282016-01-09 12:53:17 +00001949 case Type::Pipe:
David Majnemerb8014dd2015-02-19 02:16:16 +00001950 llvm_unreachable("type is illegal as a nested name specifier");
1951
1952 case Type::SubstTemplateTypeParmPack:
1953 // FIXME: not clear how to mangle this!
1954 // template <class T...> class A {
1955 // template <class U...> void foo(decltype(T::foo(U())) x...);
1956 // };
1957 Out << "_SUBSTPACK_";
1958 break;
1959
1960 // <unresolved-type> ::= <template-param>
1961 // ::= <decltype>
1962 // ::= <template-template-param> <template-args>
1963 // (this last is not official yet)
1964 case Type::TypeOfExpr:
1965 case Type::TypeOf:
1966 case Type::Decltype:
1967 case Type::TemplateTypeParm:
1968 case Type::UnaryTransform:
1969 case Type::SubstTemplateTypeParm:
1970 unresolvedType:
1971 // Some callers want a prefix before the mangled type.
1972 Out << Prefix;
1973
1974 // This seems to do everything we want. It's not really
1975 // sanctioned for a substituted template parameter, though.
1976 mangleType(Ty);
1977
1978 // We never want to print 'E' directly after an unresolved-type,
1979 // so we return directly.
1980 return true;
1981
1982 case Type::Typedef:
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00001983 mangleSourceNameWithAbiTags(cast<TypedefType>(Ty)->getDecl());
David Majnemerb8014dd2015-02-19 02:16:16 +00001984 break;
1985
1986 case Type::UnresolvedUsing:
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00001987 mangleSourceNameWithAbiTags(
1988 cast<UnresolvedUsingType>(Ty)->getDecl());
David Majnemerb8014dd2015-02-19 02:16:16 +00001989 break;
1990
1991 case Type::Enum:
1992 case Type::Record:
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00001993 mangleSourceNameWithAbiTags(cast<TagType>(Ty)->getDecl());
David Majnemerb8014dd2015-02-19 02:16:16 +00001994 break;
1995
1996 case Type::TemplateSpecialization: {
1997 const TemplateSpecializationType *TST =
1998 cast<TemplateSpecializationType>(Ty);
David Majnemera88b3592015-02-18 02:28:01 +00001999 TemplateName TN = TST->getTemplateName();
David Majnemerb8014dd2015-02-19 02:16:16 +00002000 switch (TN.getKind()) {
2001 case TemplateName::Template:
2002 case TemplateName::QualifiedTemplate: {
2003 TemplateDecl *TD = TN.getAsTemplateDecl();
2004
2005 // If the base is a template template parameter, this is an
2006 // unresolved type.
2007 assert(TD && "no template for template specialization type");
2008 if (isa<TemplateTemplateParmDecl>(TD))
2009 goto unresolvedType;
2010
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00002011 mangleSourceNameWithAbiTags(TD);
David Majnemerb8014dd2015-02-19 02:16:16 +00002012 break;
David Majnemera88b3592015-02-18 02:28:01 +00002013 }
David Majnemerb8014dd2015-02-19 02:16:16 +00002014
2015 case TemplateName::OverloadedTemplate:
2016 case TemplateName::DependentTemplate:
2017 llvm_unreachable("invalid base for a template specialization type");
2018
2019 case TemplateName::SubstTemplateTemplateParm: {
2020 SubstTemplateTemplateParmStorage *subst =
2021 TN.getAsSubstTemplateTemplateParm();
2022 mangleExistingSubstitution(subst->getReplacement());
2023 break;
2024 }
2025
2026 case TemplateName::SubstTemplateTemplateParmPack: {
2027 // FIXME: not clear how to mangle this!
2028 // template <template <class U> class T...> class A {
2029 // template <class U...> void foo(decltype(T<U>::foo) x...);
2030 // };
2031 Out << "_SUBSTPACK_";
2032 break;
2033 }
2034 }
2035
David Majnemera88b3592015-02-18 02:28:01 +00002036 mangleTemplateArgs(TST->getArgs(), TST->getNumArgs());
David Majnemerb8014dd2015-02-19 02:16:16 +00002037 break;
David Majnemera88b3592015-02-18 02:28:01 +00002038 }
David Majnemerb8014dd2015-02-19 02:16:16 +00002039
2040 case Type::InjectedClassName:
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00002041 mangleSourceNameWithAbiTags(
2042 cast<InjectedClassNameType>(Ty)->getDecl());
David Majnemerb8014dd2015-02-19 02:16:16 +00002043 break;
2044
2045 case Type::DependentName:
2046 mangleSourceName(cast<DependentNameType>(Ty)->getIdentifier());
2047 break;
2048
2049 case Type::DependentTemplateSpecialization: {
2050 const DependentTemplateSpecializationType *DTST =
2051 cast<DependentTemplateSpecializationType>(Ty);
2052 mangleSourceName(DTST->getIdentifier());
2053 mangleTemplateArgs(DTST->getArgs(), DTST->getNumArgs());
2054 break;
2055 }
2056
2057 case Type::Elaborated:
2058 return mangleUnresolvedTypeOrSimpleId(
2059 cast<ElaboratedType>(Ty)->getNamedType(), Prefix);
2060 }
2061
2062 return false;
David Majnemera88b3592015-02-18 02:28:01 +00002063}
2064
2065void CXXNameMangler::mangleOperatorName(DeclarationName Name, unsigned Arity) {
2066 switch (Name.getNameKind()) {
2067 case DeclarationName::CXXConstructorName:
2068 case DeclarationName::CXXDestructorName:
Richard Smith35845152017-02-07 01:37:30 +00002069 case DeclarationName::CXXDeductionGuideName:
David Majnemera88b3592015-02-18 02:28:01 +00002070 case DeclarationName::CXXUsingDirective:
2071 case DeclarationName::Identifier:
2072 case DeclarationName::ObjCMultiArgSelector:
2073 case DeclarationName::ObjCOneArgSelector:
2074 case DeclarationName::ObjCZeroArgSelector:
2075 llvm_unreachable("Not an operator name");
2076
2077 case DeclarationName::CXXConversionFunctionName:
2078 // <operator-name> ::= cv <type> # (cast)
2079 Out << "cv";
2080 mangleType(Name.getCXXNameType());
2081 break;
2082
2083 case DeclarationName::CXXLiteralOperatorName:
2084 Out << "li";
2085 mangleSourceName(Name.getCXXLiteralIdentifier());
2086 return;
2087
2088 case DeclarationName::CXXOperatorName:
2089 mangleOperatorName(Name.getCXXOverloadedOperator(), Arity);
2090 break;
2091 }
2092}
2093
Guy Benyei11169dd2012-12-18 14:30:41 +00002094void
2095CXXNameMangler::mangleOperatorName(OverloadedOperatorKind OO, unsigned Arity) {
2096 switch (OO) {
2097 // <operator-name> ::= nw # new
2098 case OO_New: Out << "nw"; break;
2099 // ::= na # new[]
2100 case OO_Array_New: Out << "na"; break;
2101 // ::= dl # delete
2102 case OO_Delete: Out << "dl"; break;
2103 // ::= da # delete[]
2104 case OO_Array_Delete: Out << "da"; break;
2105 // ::= ps # + (unary)
2106 // ::= pl # + (binary or unknown)
2107 case OO_Plus:
2108 Out << (Arity == 1? "ps" : "pl"); break;
2109 // ::= ng # - (unary)
2110 // ::= mi # - (binary or unknown)
2111 case OO_Minus:
2112 Out << (Arity == 1? "ng" : "mi"); break;
2113 // ::= ad # & (unary)
2114 // ::= an # & (binary or unknown)
2115 case OO_Amp:
2116 Out << (Arity == 1? "ad" : "an"); break;
2117 // ::= de # * (unary)
2118 // ::= ml # * (binary or unknown)
2119 case OO_Star:
2120 // Use binary when unknown.
2121 Out << (Arity == 1? "de" : "ml"); break;
2122 // ::= co # ~
2123 case OO_Tilde: Out << "co"; break;
2124 // ::= dv # /
2125 case OO_Slash: Out << "dv"; break;
2126 // ::= rm # %
2127 case OO_Percent: Out << "rm"; break;
2128 // ::= or # |
2129 case OO_Pipe: Out << "or"; break;
2130 // ::= eo # ^
2131 case OO_Caret: Out << "eo"; break;
2132 // ::= aS # =
2133 case OO_Equal: Out << "aS"; break;
2134 // ::= pL # +=
2135 case OO_PlusEqual: Out << "pL"; break;
2136 // ::= mI # -=
2137 case OO_MinusEqual: Out << "mI"; break;
2138 // ::= mL # *=
2139 case OO_StarEqual: Out << "mL"; break;
2140 // ::= dV # /=
2141 case OO_SlashEqual: Out << "dV"; break;
2142 // ::= rM # %=
2143 case OO_PercentEqual: Out << "rM"; break;
2144 // ::= aN # &=
2145 case OO_AmpEqual: Out << "aN"; break;
2146 // ::= oR # |=
2147 case OO_PipeEqual: Out << "oR"; break;
2148 // ::= eO # ^=
2149 case OO_CaretEqual: Out << "eO"; break;
2150 // ::= ls # <<
2151 case OO_LessLess: Out << "ls"; break;
2152 // ::= rs # >>
2153 case OO_GreaterGreater: Out << "rs"; break;
2154 // ::= lS # <<=
2155 case OO_LessLessEqual: Out << "lS"; break;
2156 // ::= rS # >>=
2157 case OO_GreaterGreaterEqual: Out << "rS"; break;
2158 // ::= eq # ==
2159 case OO_EqualEqual: Out << "eq"; break;
2160 // ::= ne # !=
2161 case OO_ExclaimEqual: Out << "ne"; break;
2162 // ::= lt # <
2163 case OO_Less: Out << "lt"; break;
2164 // ::= gt # >
2165 case OO_Greater: Out << "gt"; break;
2166 // ::= le # <=
2167 case OO_LessEqual: Out << "le"; break;
2168 // ::= ge # >=
2169 case OO_GreaterEqual: Out << "ge"; break;
2170 // ::= nt # !
2171 case OO_Exclaim: Out << "nt"; break;
2172 // ::= aa # &&
2173 case OO_AmpAmp: Out << "aa"; break;
2174 // ::= oo # ||
2175 case OO_PipePipe: Out << "oo"; break;
2176 // ::= pp # ++
2177 case OO_PlusPlus: Out << "pp"; break;
2178 // ::= mm # --
2179 case OO_MinusMinus: Out << "mm"; break;
2180 // ::= cm # ,
2181 case OO_Comma: Out << "cm"; break;
2182 // ::= pm # ->*
2183 case OO_ArrowStar: Out << "pm"; break;
2184 // ::= pt # ->
2185 case OO_Arrow: Out << "pt"; break;
2186 // ::= cl # ()
2187 case OO_Call: Out << "cl"; break;
2188 // ::= ix # []
2189 case OO_Subscript: Out << "ix"; break;
2190
2191 // ::= qu # ?
2192 // The conditional operator can't be overloaded, but we still handle it when
2193 // mangling expressions.
2194 case OO_Conditional: Out << "qu"; break;
Richard Smith9be594e2015-10-22 05:12:22 +00002195 // Proposal on cxx-abi-dev, 2015-10-21.
2196 // ::= aw # co_await
2197 case OO_Coawait: Out << "aw"; break;
Richard Smithd30b23d2017-12-01 02:13:10 +00002198 // Proposed in cxx-abi github issue 43.
2199 // ::= ss # <=>
2200 case OO_Spaceship: Out << "ss"; break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002201
2202 case OO_None:
2203 case NUM_OVERLOADED_OPERATORS:
2204 llvm_unreachable("Not an overloaded operator");
2205 }
2206}
2207
Andrew Gozillon572bbb02017-10-02 06:25:51 +00002208void CXXNameMangler::mangleQualifiers(Qualifiers Quals, const DependentAddressSpaceType *DAST) {
Roger Ferrer Ibanezfd9384a2017-06-02 07:14:34 +00002209 // Vendor qualifiers come first and if they are order-insensitive they must
2210 // be emitted in reversed alphabetical order, see Itanium ABI 5.1.5.
Guy Benyei11169dd2012-12-18 14:30:41 +00002211
Andrew Gozillon572bbb02017-10-02 06:25:51 +00002212 // <type> ::= U <addrspace-expr>
2213 if (DAST) {
2214 Out << "U2ASI";
2215 mangleExpression(DAST->getAddrSpaceExpr());
2216 Out << "E";
2217 }
2218
John McCall07daf722016-03-01 22:18:03 +00002219 // Address space qualifiers start with an ordinary letter.
Guy Benyei11169dd2012-12-18 14:30:41 +00002220 if (Quals.hasAddressSpace()) {
David Tweed31d09b02013-09-13 12:04:22 +00002221 // Address space extension:
Guy Benyei11169dd2012-12-18 14:30:41 +00002222 //
David Tweed31d09b02013-09-13 12:04:22 +00002223 // <type> ::= U <target-addrspace>
2224 // <type> ::= U <OpenCL-addrspace>
2225 // <type> ::= U <CUDA-addrspace>
2226
Guy Benyei11169dd2012-12-18 14:30:41 +00002227 SmallString<64> ASString;
Alexander Richardson6d989432017-10-15 18:48:14 +00002228 LangAS AS = Quals.getAddressSpace();
David Tweed31d09b02013-09-13 12:04:22 +00002229
2230 if (Context.getASTContext().addressSpaceMapManglingFor(AS)) {
2231 // <target-addrspace> ::= "AS" <address-space-number>
2232 unsigned TargetAS = Context.getASTContext().getTargetAddressSpace(AS);
Yaxun Liub7318e02017-10-13 03:37:48 +00002233 if (TargetAS != 0)
2234 ASString = "AS" + llvm::utostr(TargetAS);
David Tweed31d09b02013-09-13 12:04:22 +00002235 } else {
2236 switch (AS) {
2237 default: llvm_unreachable("Not a language specific address space");
Yaxun Liub7318e02017-10-13 03:37:48 +00002238 // <OpenCL-addrspace> ::= "CL" [ "global" | "local" | "constant" |
2239 // "private"| "generic" ]
David Tweed31d09b02013-09-13 12:04:22 +00002240 case LangAS::opencl_global: ASString = "CLglobal"; break;
2241 case LangAS::opencl_local: ASString = "CLlocal"; break;
2242 case LangAS::opencl_constant: ASString = "CLconstant"; break;
Yaxun Liub7318e02017-10-13 03:37:48 +00002243 case LangAS::opencl_private: ASString = "CLprivate"; break;
Anastasia Stulova81a25e352017-03-10 15:23:07 +00002244 case LangAS::opencl_generic: ASString = "CLgeneric"; break;
David Tweed31d09b02013-09-13 12:04:22 +00002245 // <CUDA-addrspace> ::= "CU" [ "device" | "constant" | "shared" ]
2246 case LangAS::cuda_device: ASString = "CUdevice"; break;
2247 case LangAS::cuda_constant: ASString = "CUconstant"; break;
2248 case LangAS::cuda_shared: ASString = "CUshared"; break;
2249 }
2250 }
Yaxun Liub7318e02017-10-13 03:37:48 +00002251 if (!ASString.empty())
2252 mangleVendorQualifier(ASString);
Guy Benyei11169dd2012-12-18 14:30:41 +00002253 }
John McCall07daf722016-03-01 22:18:03 +00002254
2255 // The ARC ownership qualifiers start with underscores.
Guy Benyei11169dd2012-12-18 14:30:41 +00002256 // Objective-C ARC Extension:
2257 //
2258 // <type> ::= U "__strong"
2259 // <type> ::= U "__weak"
2260 // <type> ::= U "__autoreleasing"
Roger Ferrer Ibanezfd9384a2017-06-02 07:14:34 +00002261 //
2262 // Note: we emit __weak first to preserve the order as
2263 // required by the Itanium ABI.
2264 if (Quals.getObjCLifetime() == Qualifiers::OCL_Weak)
2265 mangleVendorQualifier("__weak");
2266
2267 // __unaligned (from -fms-extensions)
2268 if (Quals.hasUnaligned())
2269 mangleVendorQualifier("__unaligned");
2270
2271 // Remaining ARC ownership qualifiers.
2272 switch (Quals.getObjCLifetime()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002273 case Qualifiers::OCL_None:
2274 break;
2275
2276 case Qualifiers::OCL_Weak:
Roger Ferrer Ibanezfd9384a2017-06-02 07:14:34 +00002277 // Do nothing as we already handled this case above.
Guy Benyei11169dd2012-12-18 14:30:41 +00002278 break;
2279
2280 case Qualifiers::OCL_Strong:
John McCall07daf722016-03-01 22:18:03 +00002281 mangleVendorQualifier("__strong");
Guy Benyei11169dd2012-12-18 14:30:41 +00002282 break;
2283
2284 case Qualifiers::OCL_Autoreleasing:
John McCall07daf722016-03-01 22:18:03 +00002285 mangleVendorQualifier("__autoreleasing");
Guy Benyei11169dd2012-12-18 14:30:41 +00002286 break;
2287
2288 case Qualifiers::OCL_ExplicitNone:
2289 // The __unsafe_unretained qualifier is *not* mangled, so that
2290 // __unsafe_unretained types in ARC produce the same manglings as the
2291 // equivalent (but, naturally, unqualified) types in non-ARC, providing
2292 // better ABI compatibility.
2293 //
2294 // It's safe to do this because unqualified 'id' won't show up
2295 // in any type signatures that need to be mangled.
2296 break;
2297 }
John McCall07daf722016-03-01 22:18:03 +00002298
2299 // <CV-qualifiers> ::= [r] [V] [K] # restrict (C99), volatile, const
2300 if (Quals.hasRestrict())
2301 Out << 'r';
2302 if (Quals.hasVolatile())
2303 Out << 'V';
2304 if (Quals.hasConst())
2305 Out << 'K';
2306}
2307
2308void CXXNameMangler::mangleVendorQualifier(StringRef name) {
2309 Out << 'U' << name.size() << name;
Guy Benyei11169dd2012-12-18 14:30:41 +00002310}
2311
2312void CXXNameMangler::mangleRefQualifier(RefQualifierKind RefQualifier) {
2313 // <ref-qualifier> ::= R # lvalue reference
2314 // ::= O # rvalue-reference
Guy Benyei11169dd2012-12-18 14:30:41 +00002315 switch (RefQualifier) {
2316 case RQ_None:
2317 break;
2318
2319 case RQ_LValue:
2320 Out << 'R';
2321 break;
2322
2323 case RQ_RValue:
2324 Out << 'O';
2325 break;
2326 }
2327}
2328
2329void CXXNameMangler::mangleObjCMethodName(const ObjCMethodDecl *MD) {
2330 Context.mangleObjCMethodName(MD, Out);
2331}
2332
David Majnemereea02ee2014-11-28 22:22:46 +00002333static bool isTypeSubstitutable(Qualifiers Quals, const Type *Ty) {
2334 if (Quals)
2335 return true;
2336 if (Ty->isSpecificBuiltinType(BuiltinType::ObjCSel))
2337 return true;
2338 if (Ty->isOpenCLSpecificType())
2339 return true;
2340 if (Ty->isBuiltinType())
2341 return false;
2342
2343 return true;
2344}
2345
Guy Benyei11169dd2012-12-18 14:30:41 +00002346void CXXNameMangler::mangleType(QualType T) {
2347 // If our type is instantiation-dependent but not dependent, we mangle
2348 // it as it was written in the source, removing any top-level sugar.
2349 // Otherwise, use the canonical type.
2350 //
2351 // FIXME: This is an approximation of the instantiation-dependent name
2352 // mangling rules, since we should really be using the type as written and
2353 // augmented via semantic analysis (i.e., with implicit conversions and
2354 // default template arguments) for any instantiation-dependent type.
2355 // Unfortunately, that requires several changes to our AST:
2356 // - Instantiation-dependent TemplateSpecializationTypes will need to be
2357 // uniqued, so that we can handle substitutions properly
2358 // - Default template arguments will need to be represented in the
2359 // TemplateSpecializationType, since they need to be mangled even though
2360 // they aren't written.
2361 // - Conversions on non-type template arguments need to be expressed, since
2362 // they can affect the mangling of sizeof/alignof.
Richard Smithfda59e52016-10-26 01:05:54 +00002363 //
2364 // FIXME: This is wrong when mapping to the canonical type for a dependent
2365 // type discards instantiation-dependent portions of the type, such as for:
2366 //
2367 // template<typename T, int N> void f(T (&)[sizeof(N)]);
2368 // template<typename T> void f(T() throw(typename T::type)); (pre-C++17)
2369 //
2370 // It's also wrong in the opposite direction when instantiation-dependent,
2371 // canonically-equivalent types differ in some irrelevant portion of inner
2372 // type sugar. In such cases, we fail to form correct substitutions, eg:
2373 //
2374 // template<int N> void f(A<sizeof(N)> *, A<sizeof(N)> (*));
2375 //
2376 // We should instead canonicalize the non-instantiation-dependent parts,
2377 // regardless of whether the type as a whole is dependent or instantiation
2378 // dependent.
Guy Benyei11169dd2012-12-18 14:30:41 +00002379 if (!T->isInstantiationDependentType() || T->isDependentType())
2380 T = T.getCanonicalType();
2381 else {
2382 // Desugar any types that are purely sugar.
2383 do {
2384 // Don't desugar through template specialization types that aren't
2385 // type aliases. We need to mangle the template arguments as written.
2386 if (const TemplateSpecializationType *TST
2387 = dyn_cast<TemplateSpecializationType>(T))
2388 if (!TST->isTypeAlias())
2389 break;
2390
2391 QualType Desugared
2392 = T.getSingleStepDesugaredType(Context.getASTContext());
2393 if (Desugared == T)
2394 break;
2395
2396 T = Desugared;
2397 } while (true);
2398 }
2399 SplitQualType split = T.split();
2400 Qualifiers quals = split.Quals;
2401 const Type *ty = split.Ty;
2402
David Majnemereea02ee2014-11-28 22:22:46 +00002403 bool isSubstitutable = isTypeSubstitutable(quals, ty);
Guy Benyei11169dd2012-12-18 14:30:41 +00002404 if (isSubstitutable && mangleSubstitution(T))
2405 return;
2406
2407 // If we're mangling a qualified array type, push the qualifiers to
2408 // the element type.
2409 if (quals && isa<ArrayType>(T)) {
2410 ty = Context.getASTContext().getAsArrayType(T);
2411 quals = Qualifiers();
2412
2413 // Note that we don't update T: we want to add the
2414 // substitution at the original type.
2415 }
2416
Andrew Gozillon572bbb02017-10-02 06:25:51 +00002417 if (quals || ty->isDependentAddressSpaceType()) {
2418 if (const DependentAddressSpaceType *DAST =
2419 dyn_cast<DependentAddressSpaceType>(ty)) {
2420 SplitQualType splitDAST = DAST->getPointeeType().split();
2421 mangleQualifiers(splitDAST.Quals, DAST);
2422 mangleType(QualType(splitDAST.Ty, 0));
2423 } else {
2424 mangleQualifiers(quals);
2425
2426 // Recurse: even if the qualified type isn't yet substitutable,
2427 // the unqualified type might be.
2428 mangleType(QualType(ty, 0));
2429 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002430 } else {
2431 switch (ty->getTypeClass()) {
2432#define ABSTRACT_TYPE(CLASS, PARENT)
2433#define NON_CANONICAL_TYPE(CLASS, PARENT) \
2434 case Type::CLASS: \
2435 llvm_unreachable("can't mangle non-canonical type " #CLASS "Type"); \
2436 return;
2437#define TYPE(CLASS, PARENT) \
2438 case Type::CLASS: \
2439 mangleType(static_cast<const CLASS##Type*>(ty)); \
2440 break;
2441#include "clang/AST/TypeNodes.def"
2442 }
2443 }
2444
2445 // Add the substitution.
2446 if (isSubstitutable)
2447 addSubstitution(T);
2448}
2449
2450void CXXNameMangler::mangleNameOrStandardSubstitution(const NamedDecl *ND) {
2451 if (!mangleStandardSubstitution(ND))
2452 mangleName(ND);
2453}
2454
2455void CXXNameMangler::mangleType(const BuiltinType *T) {
2456 // <type> ::= <builtin-type>
2457 // <builtin-type> ::= v # void
2458 // ::= w # wchar_t
2459 // ::= b # bool
2460 // ::= c # char
2461 // ::= a # signed char
2462 // ::= h # unsigned char
2463 // ::= s # short
2464 // ::= t # unsigned short
2465 // ::= i # int
2466 // ::= j # unsigned int
2467 // ::= l # long
2468 // ::= m # unsigned long
2469 // ::= x # long long, __int64
2470 // ::= y # unsigned long long, __int64
2471 // ::= n # __int128
Ekaterina Romanova91b655b2013-11-21 22:25:24 +00002472 // ::= o # unsigned __int128
Guy Benyei11169dd2012-12-18 14:30:41 +00002473 // ::= f # float
2474 // ::= d # double
2475 // ::= e # long double, __float80
Nemanja Ivanovicbb1ea2d2016-05-09 08:52:33 +00002476 // ::= g # __float128
Guy Benyei11169dd2012-12-18 14:30:41 +00002477 // UNSUPPORTED: ::= Dd # IEEE 754r decimal floating point (64 bits)
2478 // UNSUPPORTED: ::= De # IEEE 754r decimal floating point (128 bits)
2479 // UNSUPPORTED: ::= Df # IEEE 754r decimal floating point (32 bits)
2480 // ::= Dh # IEEE 754r half-precision floating point (16 bits)
Sjoerd Meijercc623ad2017-09-08 15:15:00 +00002481 // ::= DF <number> _ # ISO/IEC TS 18661 binary floating point type _FloatN (N bits);
Guy Benyei11169dd2012-12-18 14:30:41 +00002482 // ::= Di # char32_t
2483 // ::= Ds # char16_t
2484 // ::= Dn # std::nullptr_t (i.e., decltype(nullptr))
2485 // ::= u <source-name> # vendor extended type
Alexey Bader954ba212016-04-08 13:40:33 +00002486 std::string type_name;
Guy Benyei11169dd2012-12-18 14:30:41 +00002487 switch (T->getKind()) {
Alexey Baderbdf7c842015-09-15 12:18:29 +00002488 case BuiltinType::Void:
2489 Out << 'v';
2490 break;
2491 case BuiltinType::Bool:
2492 Out << 'b';
2493 break;
2494 case BuiltinType::Char_U:
2495 case BuiltinType::Char_S:
2496 Out << 'c';
2497 break;
2498 case BuiltinType::UChar:
2499 Out << 'h';
2500 break;
2501 case BuiltinType::UShort:
2502 Out << 't';
2503 break;
2504 case BuiltinType::UInt:
2505 Out << 'j';
2506 break;
2507 case BuiltinType::ULong:
2508 Out << 'm';
2509 break;
2510 case BuiltinType::ULongLong:
2511 Out << 'y';
2512 break;
2513 case BuiltinType::UInt128:
2514 Out << 'o';
2515 break;
2516 case BuiltinType::SChar:
2517 Out << 'a';
2518 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002519 case BuiltinType::WChar_S:
Alexey Baderbdf7c842015-09-15 12:18:29 +00002520 case BuiltinType::WChar_U:
2521 Out << 'w';
2522 break;
2523 case BuiltinType::Char16:
2524 Out << "Ds";
2525 break;
2526 case BuiltinType::Char32:
2527 Out << "Di";
2528 break;
2529 case BuiltinType::Short:
2530 Out << 's';
2531 break;
2532 case BuiltinType::Int:
2533 Out << 'i';
2534 break;
2535 case BuiltinType::Long:
2536 Out << 'l';
2537 break;
2538 case BuiltinType::LongLong:
2539 Out << 'x';
2540 break;
2541 case BuiltinType::Int128:
2542 Out << 'n';
2543 break;
Sjoerd Meijercc623ad2017-09-08 15:15:00 +00002544 case BuiltinType::Float16:
2545 Out << "DF16_";
2546 break;
Alexey Baderbdf7c842015-09-15 12:18:29 +00002547 case BuiltinType::Half:
2548 Out << "Dh";
2549 break;
2550 case BuiltinType::Float:
2551 Out << 'f';
2552 break;
2553 case BuiltinType::Double:
2554 Out << 'd';
2555 break;
David Majnemer2617ea62015-06-09 18:05:33 +00002556 case BuiltinType::LongDouble:
2557 Out << (getASTContext().getTargetInfo().useFloat128ManglingForLongDouble()
2558 ? 'g'
2559 : 'e');
2560 break;
Nemanja Ivanovicbb1ea2d2016-05-09 08:52:33 +00002561 case BuiltinType::Float128:
2562 if (getASTContext().getTargetInfo().useFloat128ManglingForLongDouble())
2563 Out << "U10__float128"; // Match the GCC mangling
2564 else
2565 Out << 'g';
2566 break;
Alexey Baderbdf7c842015-09-15 12:18:29 +00002567 case BuiltinType::NullPtr:
2568 Out << "Dn";
2569 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002570
2571#define BUILTIN_TYPE(Id, SingletonId)
2572#define PLACEHOLDER_TYPE(Id, SingletonId) \
2573 case BuiltinType::Id:
2574#include "clang/AST/BuiltinTypes.def"
2575 case BuiltinType::Dependent:
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00002576 if (!NullOut)
2577 llvm_unreachable("mangling a placeholder type");
2578 break;
Alexey Baderbdf7c842015-09-15 12:18:29 +00002579 case BuiltinType::ObjCId:
2580 Out << "11objc_object";
2581 break;
2582 case BuiltinType::ObjCClass:
2583 Out << "10objc_class";
2584 break;
2585 case BuiltinType::ObjCSel:
2586 Out << "13objc_selector";
2587 break;
Alexey Bader954ba212016-04-08 13:40:33 +00002588#define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
2589 case BuiltinType::Id: \
2590 type_name = "ocl_" #ImgType "_" #Suffix; \
2591 Out << type_name.size() << type_name; \
Alexey Baderbdf7c842015-09-15 12:18:29 +00002592 break;
Alexey Baderb62f1442016-04-13 08:33:41 +00002593#include "clang/Basic/OpenCLImageTypes.def"
Alexey Baderbdf7c842015-09-15 12:18:29 +00002594 case BuiltinType::OCLSampler:
2595 Out << "11ocl_sampler";
2596 break;
2597 case BuiltinType::OCLEvent:
2598 Out << "9ocl_event";
2599 break;
Alexey Bader9c8453f2015-09-15 11:18:52 +00002600 case BuiltinType::OCLClkEvent:
2601 Out << "12ocl_clkevent";
2602 break;
2603 case BuiltinType::OCLQueue:
2604 Out << "9ocl_queue";
2605 break;
Alexey Bader9c8453f2015-09-15 11:18:52 +00002606 case BuiltinType::OCLReserveID:
2607 Out << "13ocl_reserveid";
2608 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002609 }
2610}
2611
John McCall07daf722016-03-01 22:18:03 +00002612StringRef CXXNameMangler::getCallingConvQualifierName(CallingConv CC) {
2613 switch (CC) {
2614 case CC_C:
2615 return "";
2616
2617 case CC_X86StdCall:
2618 case CC_X86FastCall:
2619 case CC_X86ThisCall:
2620 case CC_X86VectorCall:
2621 case CC_X86Pascal:
Martin Storsjo022e7822017-07-17 20:49:45 +00002622 case CC_Win64:
John McCall07daf722016-03-01 22:18:03 +00002623 case CC_X86_64SysV:
Erich Keane757d3172016-11-02 18:29:35 +00002624 case CC_X86RegCall:
John McCall07daf722016-03-01 22:18:03 +00002625 case CC_AAPCS:
2626 case CC_AAPCS_VFP:
2627 case CC_IntelOclBicc:
2628 case CC_SpirFunction:
Nikolay Haustov8c6538b2016-06-30 09:06:33 +00002629 case CC_OpenCLKernel:
Roman Levenstein35aa5ce2016-03-16 18:00:46 +00002630 case CC_PreserveMost:
2631 case CC_PreserveAll:
John McCall07daf722016-03-01 22:18:03 +00002632 // FIXME: we should be mangling all of the above.
2633 return "";
John McCall477f2bb2016-03-03 06:39:32 +00002634
2635 case CC_Swift:
2636 return "swiftcall";
John McCall07daf722016-03-01 22:18:03 +00002637 }
2638 llvm_unreachable("bad calling convention");
2639}
2640
2641void CXXNameMangler::mangleExtFunctionInfo(const FunctionType *T) {
2642 // Fast path.
2643 if (T->getExtInfo() == FunctionType::ExtInfo())
2644 return;
2645
2646 // Vendor-specific qualifiers are emitted in reverse alphabetical order.
2647 // This will get more complicated in the future if we mangle other
2648 // things here; but for now, since we mangle ns_returns_retained as
2649 // a qualifier on the result type, we can get away with this:
2650 StringRef CCQualifier = getCallingConvQualifierName(T->getExtInfo().getCC());
2651 if (!CCQualifier.empty())
2652 mangleVendorQualifier(CCQualifier);
2653
2654 // FIXME: regparm
2655 // FIXME: noreturn
2656}
2657
2658void
2659CXXNameMangler::mangleExtParameterInfo(FunctionProtoType::ExtParameterInfo PI) {
2660 // Vendor-specific qualifiers are emitted in reverse alphabetical order.
2661
2662 // Note that these are *not* substitution candidates. Demanglers might
2663 // have trouble with this if the parameter type is fully substituted.
2664
John McCall477f2bb2016-03-03 06:39:32 +00002665 switch (PI.getABI()) {
2666 case ParameterABI::Ordinary:
2667 break;
2668
2669 // All of these start with "swift", so they come before "ns_consumed".
2670 case ParameterABI::SwiftContext:
2671 case ParameterABI::SwiftErrorResult:
2672 case ParameterABI::SwiftIndirectResult:
2673 mangleVendorQualifier(getParameterABISpelling(PI.getABI()));
2674 break;
2675 }
2676
John McCall07daf722016-03-01 22:18:03 +00002677 if (PI.isConsumed())
John McCall477f2bb2016-03-03 06:39:32 +00002678 mangleVendorQualifier("ns_consumed");
Akira Hatanaka98a49332017-09-22 00:41:05 +00002679
2680 if (PI.isNoEscape())
2681 mangleVendorQualifier("noescape");
John McCall07daf722016-03-01 22:18:03 +00002682}
2683
Guy Benyei11169dd2012-12-18 14:30:41 +00002684// <type> ::= <function-type>
2685// <function-type> ::= [<CV-qualifiers>] F [Y]
2686// <bare-function-type> [<ref-qualifier>] E
Guy Benyei11169dd2012-12-18 14:30:41 +00002687void CXXNameMangler::mangleType(const FunctionProtoType *T) {
John McCall07daf722016-03-01 22:18:03 +00002688 mangleExtFunctionInfo(T);
2689
Guy Benyei11169dd2012-12-18 14:30:41 +00002690 // Mangle CV-qualifiers, if present. These are 'this' qualifiers,
2691 // e.g. "const" in "int (A::*)() const".
2692 mangleQualifiers(Qualifiers::fromCVRMask(T->getTypeQuals()));
2693
Richard Smithfda59e52016-10-26 01:05:54 +00002694 // Mangle instantiation-dependent exception-specification, if present,
2695 // per cxx-abi-dev proposal on 2016-10-11.
2696 if (T->hasInstantiationDependentExceptionSpec()) {
2697 if (T->getExceptionSpecType() == EST_ComputedNoexcept) {
Richard Smithef09aa92016-11-03 00:27:54 +00002698 Out << "DO";
Richard Smithfda59e52016-10-26 01:05:54 +00002699 mangleExpression(T->getNoexceptExpr());
2700 Out << "E";
2701 } else {
2702 assert(T->getExceptionSpecType() == EST_Dynamic);
Richard Smithef09aa92016-11-03 00:27:54 +00002703 Out << "Dw";
Richard Smithfda59e52016-10-26 01:05:54 +00002704 for (auto ExceptTy : T->exceptions())
2705 mangleType(ExceptTy);
2706 Out << "E";
2707 }
2708 } else if (T->isNothrow(getASTContext())) {
Richard Smithef09aa92016-11-03 00:27:54 +00002709 Out << "Do";
Richard Smithfda59e52016-10-26 01:05:54 +00002710 }
2711
Guy Benyei11169dd2012-12-18 14:30:41 +00002712 Out << 'F';
2713
2714 // FIXME: We don't have enough information in the AST to produce the 'Y'
2715 // encoding for extern "C" function types.
2716 mangleBareFunctionType(T, /*MangleReturnType=*/true);
2717
2718 // Mangle the ref-qualifier, if present.
2719 mangleRefQualifier(T->getRefQualifier());
2720
2721 Out << 'E';
2722}
Peter Collingbourneeeebc412015-08-07 23:25:47 +00002723
Guy Benyei11169dd2012-12-18 14:30:41 +00002724void CXXNameMangler::mangleType(const FunctionNoProtoType *T) {
Peter Collingbourneeeebc412015-08-07 23:25:47 +00002725 // Function types without prototypes can arise when mangling a function type
2726 // within an overloadable function in C. We mangle these as the absence of any
2727 // parameter types (not even an empty parameter list).
2728 Out << 'F';
2729
2730 FunctionTypeDepthState saved = FunctionTypeDepth.push();
2731
2732 FunctionTypeDepth.enterResultType();
2733 mangleType(T->getReturnType());
2734 FunctionTypeDepth.leaveResultType();
2735
2736 FunctionTypeDepth.pop(saved);
2737 Out << 'E';
Guy Benyei11169dd2012-12-18 14:30:41 +00002738}
Peter Collingbourneeeebc412015-08-07 23:25:47 +00002739
John McCall07daf722016-03-01 22:18:03 +00002740void CXXNameMangler::mangleBareFunctionType(const FunctionProtoType *Proto,
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00002741 bool MangleReturnType,
2742 const FunctionDecl *FD) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002743 // Record that we're in a function type. See mangleFunctionParam
2744 // for details on what we're trying to achieve here.
2745 FunctionTypeDepthState saved = FunctionTypeDepth.push();
2746
2747 // <bare-function-type> ::= <signature type>+
2748 if (MangleReturnType) {
2749 FunctionTypeDepth.enterResultType();
John McCall07daf722016-03-01 22:18:03 +00002750
2751 // Mangle ns_returns_retained as an order-sensitive qualifier here.
Nico Weberfb420782016-05-25 14:15:08 +00002752 if (Proto->getExtInfo().getProducesResult() && FD == nullptr)
John McCall07daf722016-03-01 22:18:03 +00002753 mangleVendorQualifier("ns_returns_retained");
2754
2755 // Mangle the return type without any direct ARC ownership qualifiers.
2756 QualType ReturnTy = Proto->getReturnType();
2757 if (ReturnTy.getObjCLifetime()) {
2758 auto SplitReturnTy = ReturnTy.split();
2759 SplitReturnTy.Quals.removeObjCLifetime();
2760 ReturnTy = getASTContext().getQualifiedType(SplitReturnTy);
2761 }
2762 mangleType(ReturnTy);
2763
Guy Benyei11169dd2012-12-18 14:30:41 +00002764 FunctionTypeDepth.leaveResultType();
2765 }
2766
Alp Toker9cacbab2014-01-20 20:26:09 +00002767 if (Proto->getNumParams() == 0 && !Proto->isVariadic()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002768 // <builtin-type> ::= v # void
2769 Out << 'v';
2770
2771 FunctionTypeDepth.pop(saved);
2772 return;
2773 }
2774
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00002775 assert(!FD || FD->getNumParams() == Proto->getNumParams());
2776 for (unsigned I = 0, E = Proto->getNumParams(); I != E; ++I) {
John McCall07daf722016-03-01 22:18:03 +00002777 // Mangle extended parameter info as order-sensitive qualifiers here.
Nico Weberfb420782016-05-25 14:15:08 +00002778 if (Proto->hasExtParameterInfos() && FD == nullptr) {
John McCall07daf722016-03-01 22:18:03 +00002779 mangleExtParameterInfo(Proto->getExtParameterInfo(I));
2780 }
2781
2782 // Mangle the type.
2783 QualType ParamTy = Proto->getParamType(I);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00002784 mangleType(Context.getASTContext().getSignatureParameterType(ParamTy));
2785
2786 if (FD) {
2787 if (auto *Attr = FD->getParamDecl(I)->getAttr<PassObjectSizeAttr>()) {
2788 // Attr can only take 1 character, so we can hardcode the length below.
2789 assert(Attr->getType() <= 9 && Attr->getType() >= 0);
2790 Out << "U17pass_object_size" << Attr->getType();
2791 }
2792 }
2793 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002794
2795 FunctionTypeDepth.pop(saved);
2796
2797 // <builtin-type> ::= z # ellipsis
2798 if (Proto->isVariadic())
2799 Out << 'z';
2800}
2801
2802// <type> ::= <class-enum-type>
2803// <class-enum-type> ::= <name>
2804void CXXNameMangler::mangleType(const UnresolvedUsingType *T) {
2805 mangleName(T->getDecl());
2806}
2807
2808// <type> ::= <class-enum-type>
2809// <class-enum-type> ::= <name>
2810void CXXNameMangler::mangleType(const EnumType *T) {
2811 mangleType(static_cast<const TagType*>(T));
2812}
2813void CXXNameMangler::mangleType(const RecordType *T) {
2814 mangleType(static_cast<const TagType*>(T));
2815}
2816void CXXNameMangler::mangleType(const TagType *T) {
2817 mangleName(T->getDecl());
2818}
2819
2820// <type> ::= <array-type>
2821// <array-type> ::= A <positive dimension number> _ <element type>
2822// ::= A [<dimension expression>] _ <element type>
2823void CXXNameMangler::mangleType(const ConstantArrayType *T) {
2824 Out << 'A' << T->getSize() << '_';
2825 mangleType(T->getElementType());
2826}
2827void CXXNameMangler::mangleType(const VariableArrayType *T) {
2828 Out << 'A';
2829 // decayed vla types (size 0) will just be skipped.
2830 if (T->getSizeExpr())
2831 mangleExpression(T->getSizeExpr());
2832 Out << '_';
2833 mangleType(T->getElementType());
2834}
2835void CXXNameMangler::mangleType(const DependentSizedArrayType *T) {
2836 Out << 'A';
2837 mangleExpression(T->getSizeExpr());
2838 Out << '_';
2839 mangleType(T->getElementType());
2840}
2841void CXXNameMangler::mangleType(const IncompleteArrayType *T) {
2842 Out << "A_";
2843 mangleType(T->getElementType());
2844}
2845
2846// <type> ::= <pointer-to-member-type>
2847// <pointer-to-member-type> ::= M <class type> <member type>
2848void CXXNameMangler::mangleType(const MemberPointerType *T) {
2849 Out << 'M';
2850 mangleType(QualType(T->getClass(), 0));
2851 QualType PointeeType = T->getPointeeType();
2852 if (const FunctionProtoType *FPT = dyn_cast<FunctionProtoType>(PointeeType)) {
2853 mangleType(FPT);
2854
2855 // Itanium C++ ABI 5.1.8:
2856 //
2857 // The type of a non-static member function is considered to be different,
2858 // for the purposes of substitution, from the type of a namespace-scope or
2859 // static member function whose type appears similar. The types of two
2860 // non-static member functions are considered to be different, for the
2861 // purposes of substitution, if the functions are members of different
2862 // classes. In other words, for the purposes of substitution, the class of
2863 // which the function is a member is considered part of the type of
2864 // function.
2865
2866 // Given that we already substitute member function pointers as a
2867 // whole, the net effect of this rule is just to unconditionally
2868 // suppress substitution on the function type in a member pointer.
2869 // We increment the SeqID here to emulate adding an entry to the
2870 // substitution table.
2871 ++SeqID;
2872 } else
2873 mangleType(PointeeType);
2874}
2875
2876// <type> ::= <template-param>
2877void CXXNameMangler::mangleType(const TemplateTypeParmType *T) {
2878 mangleTemplateParameter(T->getIndex());
2879}
2880
2881// <type> ::= <template-param>
2882void CXXNameMangler::mangleType(const SubstTemplateTypeParmPackType *T) {
2883 // FIXME: not clear how to mangle this!
2884 // template <class T...> class A {
2885 // template <class U...> void foo(T(*)(U) x...);
2886 // };
2887 Out << "_SUBSTPACK_";
2888}
2889
2890// <type> ::= P <type> # pointer-to
2891void CXXNameMangler::mangleType(const PointerType *T) {
2892 Out << 'P';
2893 mangleType(T->getPointeeType());
2894}
2895void CXXNameMangler::mangleType(const ObjCObjectPointerType *T) {
2896 Out << 'P';
2897 mangleType(T->getPointeeType());
2898}
2899
2900// <type> ::= R <type> # reference-to
2901void CXXNameMangler::mangleType(const LValueReferenceType *T) {
2902 Out << 'R';
2903 mangleType(T->getPointeeType());
2904}
2905
2906// <type> ::= O <type> # rvalue reference-to (C++0x)
2907void CXXNameMangler::mangleType(const RValueReferenceType *T) {
2908 Out << 'O';
2909 mangleType(T->getPointeeType());
2910}
2911
2912// <type> ::= C <type> # complex pair (C 2000)
2913void CXXNameMangler::mangleType(const ComplexType *T) {
2914 Out << 'C';
2915 mangleType(T->getElementType());
2916}
2917
2918// ARM's ABI for Neon vector types specifies that they should be mangled as
2919// if they are structs (to match ARM's initial implementation). The
2920// vector type must be one of the special types predefined by ARM.
2921void CXXNameMangler::mangleNeonVectorType(const VectorType *T) {
2922 QualType EltType = T->getElementType();
2923 assert(EltType->isBuiltinType() && "Neon vector element not a BuiltinType");
Craig Topper36250ad2014-05-12 05:36:57 +00002924 const char *EltName = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002925 if (T->getVectorKind() == VectorType::NeonPolyVector) {
2926 switch (cast<BuiltinType>(EltType)->getKind()) {
Tim Northovera2ee4332014-03-29 15:09:45 +00002927 case BuiltinType::SChar:
2928 case BuiltinType::UChar:
2929 EltName = "poly8_t";
2930 break;
2931 case BuiltinType::Short:
2932 case BuiltinType::UShort:
2933 EltName = "poly16_t";
2934 break;
2935 case BuiltinType::ULongLong:
2936 EltName = "poly64_t";
2937 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002938 default: llvm_unreachable("unexpected Neon polynomial vector element type");
2939 }
2940 } else {
2941 switch (cast<BuiltinType>(EltType)->getKind()) {
2942 case BuiltinType::SChar: EltName = "int8_t"; break;
2943 case BuiltinType::UChar: EltName = "uint8_t"; break;
2944 case BuiltinType::Short: EltName = "int16_t"; break;
2945 case BuiltinType::UShort: EltName = "uint16_t"; break;
2946 case BuiltinType::Int: EltName = "int32_t"; break;
2947 case BuiltinType::UInt: EltName = "uint32_t"; break;
2948 case BuiltinType::LongLong: EltName = "int64_t"; break;
2949 case BuiltinType::ULongLong: EltName = "uint64_t"; break;
Tim Northovera2ee4332014-03-29 15:09:45 +00002950 case BuiltinType::Double: EltName = "float64_t"; break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002951 case BuiltinType::Float: EltName = "float32_t"; break;
Tim Northover2fe823a2013-08-01 09:23:19 +00002952 case BuiltinType::Half: EltName = "float16_t";break;
2953 default:
2954 llvm_unreachable("unexpected Neon vector element type");
Guy Benyei11169dd2012-12-18 14:30:41 +00002955 }
2956 }
Craig Topper36250ad2014-05-12 05:36:57 +00002957 const char *BaseName = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00002958 unsigned BitSize = (T->getNumElements() *
2959 getASTContext().getTypeSize(EltType));
2960 if (BitSize == 64)
2961 BaseName = "__simd64_";
2962 else {
2963 assert(BitSize == 128 && "Neon vector type not 64 or 128 bits");
2964 BaseName = "__simd128_";
2965 }
2966 Out << strlen(BaseName) + strlen(EltName);
2967 Out << BaseName << EltName;
2968}
2969
Tim Northover2fe823a2013-08-01 09:23:19 +00002970static StringRef mangleAArch64VectorBase(const BuiltinType *EltType) {
2971 switch (EltType->getKind()) {
2972 case BuiltinType::SChar:
2973 return "Int8";
2974 case BuiltinType::Short:
2975 return "Int16";
2976 case BuiltinType::Int:
2977 return "Int32";
Kevin Qinad64f6d2014-02-24 02:45:03 +00002978 case BuiltinType::Long:
Tim Northovera2ee4332014-03-29 15:09:45 +00002979 case BuiltinType::LongLong:
Tim Northover2fe823a2013-08-01 09:23:19 +00002980 return "Int64";
2981 case BuiltinType::UChar:
2982 return "Uint8";
2983 case BuiltinType::UShort:
2984 return "Uint16";
2985 case BuiltinType::UInt:
2986 return "Uint32";
Kevin Qinad64f6d2014-02-24 02:45:03 +00002987 case BuiltinType::ULong:
Tim Northovera2ee4332014-03-29 15:09:45 +00002988 case BuiltinType::ULongLong:
Tim Northover2fe823a2013-08-01 09:23:19 +00002989 return "Uint64";
2990 case BuiltinType::Half:
2991 return "Float16";
2992 case BuiltinType::Float:
2993 return "Float32";
2994 case BuiltinType::Double:
2995 return "Float64";
2996 default:
2997 llvm_unreachable("Unexpected vector element base type");
2998 }
2999}
3000
3001// AArch64's ABI for Neon vector types specifies that they should be mangled as
3002// the equivalent internal name. The vector type must be one of the special
3003// types predefined by ARM.
3004void CXXNameMangler::mangleAArch64NeonVectorType(const VectorType *T) {
3005 QualType EltType = T->getElementType();
3006 assert(EltType->isBuiltinType() && "Neon vector element not a BuiltinType");
3007 unsigned BitSize =
3008 (T->getNumElements() * getASTContext().getTypeSize(EltType));
Daniel Jasper8698af42013-08-01 10:30:11 +00003009 (void)BitSize; // Silence warning.
Tim Northover2fe823a2013-08-01 09:23:19 +00003010
3011 assert((BitSize == 64 || BitSize == 128) &&
3012 "Neon vector type not 64 or 128 bits");
3013
Tim Northover2fe823a2013-08-01 09:23:19 +00003014 StringRef EltName;
3015 if (T->getVectorKind() == VectorType::NeonPolyVector) {
3016 switch (cast<BuiltinType>(EltType)->getKind()) {
3017 case BuiltinType::UChar:
3018 EltName = "Poly8";
3019 break;
3020 case BuiltinType::UShort:
3021 EltName = "Poly16";
3022 break;
Kevin Qinad64f6d2014-02-24 02:45:03 +00003023 case BuiltinType::ULong:
Kevin Qin78b86532015-05-14 08:18:05 +00003024 case BuiltinType::ULongLong:
Hao Liu90ee2f12013-11-17 09:14:46 +00003025 EltName = "Poly64";
3026 break;
Tim Northover2fe823a2013-08-01 09:23:19 +00003027 default:
3028 llvm_unreachable("unexpected Neon polynomial vector element type");
3029 }
3030 } else
3031 EltName = mangleAArch64VectorBase(cast<BuiltinType>(EltType));
3032
3033 std::string TypeName =
Benjamin Kramerb42d9a52015-12-24 10:07:37 +00003034 ("__" + EltName + "x" + Twine(T->getNumElements()) + "_t").str();
Tim Northover2fe823a2013-08-01 09:23:19 +00003035 Out << TypeName.length() << TypeName;
3036}
3037
Guy Benyei11169dd2012-12-18 14:30:41 +00003038// GNU extension: vector types
3039// <type> ::= <vector-type>
3040// <vector-type> ::= Dv <positive dimension number> _
3041// <extended element type>
3042// ::= Dv [<dimension expression>] _ <element type>
3043// <extended element type> ::= <element type>
3044// ::= p # AltiVec vector pixel
3045// ::= b # Altivec vector bool
3046void CXXNameMangler::mangleType(const VectorType *T) {
3047 if ((T->getVectorKind() == VectorType::NeonVector ||
3048 T->getVectorKind() == VectorType::NeonPolyVector)) {
Tim Northovera2ee4332014-03-29 15:09:45 +00003049 llvm::Triple Target = getASTContext().getTargetInfo().getTriple();
Christian Pirker9b019ae2014-02-25 13:51:00 +00003050 llvm::Triple::ArchType Arch =
3051 getASTContext().getTargetInfo().getTriple().getArch();
Tim Northover25e8a672014-05-24 12:51:25 +00003052 if ((Arch == llvm::Triple::aarch64 ||
Tim Northover40956e62014-07-23 12:32:58 +00003053 Arch == llvm::Triple::aarch64_be) && !Target.isOSDarwin())
Tim Northover2fe823a2013-08-01 09:23:19 +00003054 mangleAArch64NeonVectorType(T);
3055 else
3056 mangleNeonVectorType(T);
Guy Benyei11169dd2012-12-18 14:30:41 +00003057 return;
3058 }
3059 Out << "Dv" << T->getNumElements() << '_';
3060 if (T->getVectorKind() == VectorType::AltiVecPixel)
3061 Out << 'p';
3062 else if (T->getVectorKind() == VectorType::AltiVecBool)
3063 Out << 'b';
3064 else
3065 mangleType(T->getElementType());
3066}
3067void CXXNameMangler::mangleType(const ExtVectorType *T) {
3068 mangleType(static_cast<const VectorType*>(T));
3069}
3070void CXXNameMangler::mangleType(const DependentSizedExtVectorType *T) {
3071 Out << "Dv";
3072 mangleExpression(T->getSizeExpr());
3073 Out << '_';
3074 mangleType(T->getElementType());
3075}
3076
Andrew Gozillon572bbb02017-10-02 06:25:51 +00003077void CXXNameMangler::mangleType(const DependentAddressSpaceType *T) {
3078 SplitQualType split = T->getPointeeType().split();
3079 mangleQualifiers(split.Quals, T);
3080 mangleType(QualType(split.Ty, 0));
3081}
3082
Guy Benyei11169dd2012-12-18 14:30:41 +00003083void CXXNameMangler::mangleType(const PackExpansionType *T) {
3084 // <type> ::= Dp <type> # pack expansion (C++0x)
3085 Out << "Dp";
3086 mangleType(T->getPattern());
3087}
3088
3089void CXXNameMangler::mangleType(const ObjCInterfaceType *T) {
3090 mangleSourceName(T->getDecl()->getIdentifier());
3091}
3092
3093void CXXNameMangler::mangleType(const ObjCObjectType *T) {
Douglas Gregorab209d82015-07-07 03:58:42 +00003094 // Treat __kindof as a vendor extended type qualifier.
3095 if (T->isKindOfType())
3096 Out << "U8__kindof";
3097
Eli Friedman5f508952013-06-18 22:41:37 +00003098 if (!T->qual_empty()) {
3099 // Mangle protocol qualifiers.
3100 SmallString<64> QualStr;
3101 llvm::raw_svector_ostream QualOS(QualStr);
3102 QualOS << "objcproto";
Aaron Ballman1683f7b2014-03-17 15:55:30 +00003103 for (const auto *I : T->quals()) {
3104 StringRef name = I->getName();
Eli Friedman5f508952013-06-18 22:41:37 +00003105 QualOS << name.size() << name;
3106 }
Eli Friedman5f508952013-06-18 22:41:37 +00003107 Out << 'U' << QualStr.size() << QualStr;
3108 }
Douglas Gregorab209d82015-07-07 03:58:42 +00003109
Guy Benyei11169dd2012-12-18 14:30:41 +00003110 mangleType(T->getBaseType());
Douglas Gregorab209d82015-07-07 03:58:42 +00003111
3112 if (T->isSpecialized()) {
3113 // Mangle type arguments as I <type>+ E
3114 Out << 'I';
3115 for (auto typeArg : T->getTypeArgs())
3116 mangleType(typeArg);
3117 Out << 'E';
3118 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003119}
3120
3121void CXXNameMangler::mangleType(const BlockPointerType *T) {
3122 Out << "U13block_pointer";
3123 mangleType(T->getPointeeType());
3124}
3125
3126void CXXNameMangler::mangleType(const InjectedClassNameType *T) {
3127 // Mangle injected class name types as if the user had written the
3128 // specialization out fully. It may not actually be possible to see
3129 // this mangling, though.
3130 mangleType(T->getInjectedSpecializationType());
3131}
3132
3133void CXXNameMangler::mangleType(const TemplateSpecializationType *T) {
3134 if (TemplateDecl *TD = T->getTemplateName().getAsTemplateDecl()) {
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00003135 mangleTemplateName(TD, T->getArgs(), T->getNumArgs());
Guy Benyei11169dd2012-12-18 14:30:41 +00003136 } else {
3137 if (mangleSubstitution(QualType(T, 0)))
3138 return;
3139
3140 mangleTemplatePrefix(T->getTemplateName());
3141
3142 // FIXME: GCC does not appear to mangle the template arguments when
3143 // the template in question is a dependent template name. Should we
3144 // emulate that badness?
3145 mangleTemplateArgs(T->getArgs(), T->getNumArgs());
3146 addSubstitution(QualType(T, 0));
3147 }
3148}
3149
3150void CXXNameMangler::mangleType(const DependentNameType *T) {
David Majnemer64e40c52014-04-10 00:49:24 +00003151 // Proposal by cxx-abi-dev, 2014-03-26
3152 // <class-enum-type> ::= <name> # non-dependent or dependent type name or
3153 // # dependent elaborated type specifier using
David Majnemer61182a82014-04-10 00:59:44 +00003154 // # 'typename'
David Majnemer64e40c52014-04-10 00:49:24 +00003155 // ::= Ts <name> # dependent elaborated type specifier using
David Majnemer61182a82014-04-10 00:59:44 +00003156 // # 'struct' or 'class'
David Majnemer64e40c52014-04-10 00:49:24 +00003157 // ::= Tu <name> # dependent elaborated type specifier using
David Majnemer61182a82014-04-10 00:59:44 +00003158 // # 'union'
David Majnemer64e40c52014-04-10 00:49:24 +00003159 // ::= Te <name> # dependent elaborated type specifier using
David Majnemer61182a82014-04-10 00:59:44 +00003160 // # 'enum'
David Majnemer64e40c52014-04-10 00:49:24 +00003161 switch (T->getKeyword()) {
Richard Smith91fb1f42017-01-20 18:50:12 +00003162 case ETK_None:
David Majnemer64e40c52014-04-10 00:49:24 +00003163 case ETK_Typename:
3164 break;
3165 case ETK_Struct:
3166 case ETK_Class:
3167 case ETK_Interface:
3168 Out << "Ts";
3169 break;
3170 case ETK_Union:
3171 Out << "Tu";
3172 break;
3173 case ETK_Enum:
3174 Out << "Te";
3175 break;
David Majnemer64e40c52014-04-10 00:49:24 +00003176 }
David Majnemer2e159fb2014-04-15 05:51:25 +00003177 // Typename types are always nested
3178 Out << 'N';
Guy Benyei11169dd2012-12-18 14:30:41 +00003179 manglePrefix(T->getQualifier());
David Majnemer64e40c52014-04-10 00:49:24 +00003180 mangleSourceName(T->getIdentifier());
Guy Benyei11169dd2012-12-18 14:30:41 +00003181 Out << 'E';
3182}
3183
3184void CXXNameMangler::mangleType(const DependentTemplateSpecializationType *T) {
3185 // Dependently-scoped template types are nested if they have a prefix.
3186 Out << 'N';
3187
3188 // TODO: avoid making this TemplateName.
3189 TemplateName Prefix =
3190 getASTContext().getDependentTemplateName(T->getQualifier(),
3191 T->getIdentifier());
3192 mangleTemplatePrefix(Prefix);
3193
3194 // FIXME: GCC does not appear to mangle the template arguments when
3195 // the template in question is a dependent template name. Should we
3196 // emulate that badness?
3197 mangleTemplateArgs(T->getArgs(), T->getNumArgs());
3198 Out << 'E';
3199}
3200
3201void CXXNameMangler::mangleType(const TypeOfType *T) {
3202 // FIXME: this is pretty unsatisfactory, but there isn't an obvious
3203 // "extension with parameters" mangling.
3204 Out << "u6typeof";
3205}
3206
3207void CXXNameMangler::mangleType(const TypeOfExprType *T) {
3208 // FIXME: this is pretty unsatisfactory, but there isn't an obvious
3209 // "extension with parameters" mangling.
3210 Out << "u6typeof";
3211}
3212
3213void CXXNameMangler::mangleType(const DecltypeType *T) {
3214 Expr *E = T->getUnderlyingExpr();
3215
3216 // type ::= Dt <expression> E # decltype of an id-expression
3217 // # or class member access
3218 // ::= DT <expression> E # decltype of an expression
3219
3220 // This purports to be an exhaustive list of id-expressions and
3221 // class member accesses. Note that we do not ignore parentheses;
3222 // parentheses change the semantics of decltype for these
3223 // expressions (and cause the mangler to use the other form).
3224 if (isa<DeclRefExpr>(E) ||
3225 isa<MemberExpr>(E) ||
3226 isa<UnresolvedLookupExpr>(E) ||
3227 isa<DependentScopeDeclRefExpr>(E) ||
3228 isa<CXXDependentScopeMemberExpr>(E) ||
3229 isa<UnresolvedMemberExpr>(E))
3230 Out << "Dt";
3231 else
3232 Out << "DT";
3233 mangleExpression(E);
3234 Out << 'E';
3235}
3236
3237void CXXNameMangler::mangleType(const UnaryTransformType *T) {
3238 // If this is dependent, we need to record that. If not, we simply
3239 // mangle it as the underlying type since they are equivalent.
3240 if (T->isDependentType()) {
3241 Out << 'U';
3242
3243 switch (T->getUTTKind()) {
3244 case UnaryTransformType::EnumUnderlyingType:
3245 Out << "3eut";
3246 break;
3247 }
3248 }
3249
David Majnemer140065a2016-06-08 00:34:15 +00003250 mangleType(T->getBaseType());
Guy Benyei11169dd2012-12-18 14:30:41 +00003251}
3252
3253void CXXNameMangler::mangleType(const AutoType *T) {
3254 QualType D = T->getDeducedType();
3255 // <builtin-type> ::= Da # dependent auto
Richard Smithe301ba22015-11-11 02:02:15 +00003256 if (D.isNull()) {
3257 assert(T->getKeyword() != AutoTypeKeyword::GNUAutoType &&
3258 "shouldn't need to mangle __auto_type!");
Richard Smith74aeef52013-04-26 16:15:35 +00003259 Out << (T->isDecltypeAuto() ? "Dc" : "Da");
Richard Smithe301ba22015-11-11 02:02:15 +00003260 } else
Guy Benyei11169dd2012-12-18 14:30:41 +00003261 mangleType(D);
3262}
3263
Richard Smith600b5262017-01-26 20:40:47 +00003264void CXXNameMangler::mangleType(const DeducedTemplateSpecializationType *T) {
3265 // FIXME: This is not the right mangling. We also need to include a scope
3266 // here in some cases.
3267 QualType D = T->getDeducedType();
3268 if (D.isNull())
3269 mangleUnscopedTemplateName(T->getTemplateName(), nullptr);
3270 else
3271 mangleType(D);
3272}
3273
Guy Benyei11169dd2012-12-18 14:30:41 +00003274void CXXNameMangler::mangleType(const AtomicType *T) {
Nick Lewycky206cc2d2014-03-09 17:09:28 +00003275 // <type> ::= U <source-name> <type> # vendor extended type qualifier
Guy Benyei11169dd2012-12-18 14:30:41 +00003276 // (Until there's a standardized mangling...)
3277 Out << "U7_Atomic";
3278 mangleType(T->getValueType());
3279}
3280
Xiuli Pan9c14e282016-01-09 12:53:17 +00003281void CXXNameMangler::mangleType(const PipeType *T) {
3282 // Pipe type mangling rules are described in SPIR 2.0 specification
3283 // A.1 Data types and A.3 Summary of changes
3284 // <type> ::= 8ocl_pipe
3285 Out << "8ocl_pipe";
3286}
3287
Guy Benyei11169dd2012-12-18 14:30:41 +00003288void CXXNameMangler::mangleIntegerLiteral(QualType T,
3289 const llvm::APSInt &Value) {
3290 // <expr-primary> ::= L <type> <value number> E # integer literal
3291 Out << 'L';
3292
3293 mangleType(T);
3294 if (T->isBooleanType()) {
3295 // Boolean values are encoded as 0/1.
3296 Out << (Value.getBoolValue() ? '1' : '0');
3297 } else {
3298 mangleNumber(Value);
3299 }
3300 Out << 'E';
3301
3302}
3303
David Majnemer1dabfdc2015-02-14 13:23:54 +00003304void CXXNameMangler::mangleMemberExprBase(const Expr *Base, bool IsArrow) {
3305 // Ignore member expressions involving anonymous unions.
3306 while (const auto *RT = Base->getType()->getAs<RecordType>()) {
3307 if (!RT->getDecl()->isAnonymousStructOrUnion())
3308 break;
3309 const auto *ME = dyn_cast<MemberExpr>(Base);
3310 if (!ME)
3311 break;
3312 Base = ME->getBase();
3313 IsArrow = ME->isArrow();
3314 }
3315
3316 if (Base->isImplicitCXXThis()) {
3317 // Note: GCC mangles member expressions to the implicit 'this' as
3318 // *this., whereas we represent them as this->. The Itanium C++ ABI
3319 // does not specify anything here, so we follow GCC.
3320 Out << "dtdefpT";
3321 } else {
3322 Out << (IsArrow ? "pt" : "dt");
3323 mangleExpression(Base);
3324 }
3325}
3326
Guy Benyei11169dd2012-12-18 14:30:41 +00003327/// Mangles a member expression.
3328void CXXNameMangler::mangleMemberExpr(const Expr *base,
3329 bool isArrow,
3330 NestedNameSpecifier *qualifier,
3331 NamedDecl *firstQualifierLookup,
3332 DeclarationName member,
Richard Smithafecd832016-10-24 20:47:04 +00003333 const TemplateArgumentLoc *TemplateArgs,
3334 unsigned NumTemplateArgs,
Guy Benyei11169dd2012-12-18 14:30:41 +00003335 unsigned arity) {
3336 // <expression> ::= dt <expression> <unresolved-name>
3337 // ::= pt <expression> <unresolved-name>
David Majnemer1dabfdc2015-02-14 13:23:54 +00003338 if (base)
3339 mangleMemberExprBase(base, isArrow);
Richard Smithafecd832016-10-24 20:47:04 +00003340 mangleUnresolvedName(qualifier, member, TemplateArgs, NumTemplateArgs, arity);
Guy Benyei11169dd2012-12-18 14:30:41 +00003341}
3342
3343/// Look at the callee of the given call expression and determine if
3344/// it's a parenthesized id-expression which would have triggered ADL
3345/// otherwise.
3346static bool isParenthesizedADLCallee(const CallExpr *call) {
3347 const Expr *callee = call->getCallee();
3348 const Expr *fn = callee->IgnoreParens();
3349
3350 // Must be parenthesized. IgnoreParens() skips __extension__ nodes,
3351 // too, but for those to appear in the callee, it would have to be
3352 // parenthesized.
3353 if (callee == fn) return false;
3354
3355 // Must be an unresolved lookup.
3356 const UnresolvedLookupExpr *lookup = dyn_cast<UnresolvedLookupExpr>(fn);
3357 if (!lookup) return false;
3358
3359 assert(!lookup->requiresADL());
3360
3361 // Must be an unqualified lookup.
3362 if (lookup->getQualifier()) return false;
3363
3364 // Must not have found a class member. Note that if one is a class
3365 // member, they're all class members.
3366 if (lookup->getNumDecls() > 0 &&
3367 (*lookup->decls_begin())->isCXXClassMember())
3368 return false;
3369
3370 // Otherwise, ADL would have been triggered.
3371 return true;
3372}
3373
David Majnemer9c775c72014-09-23 04:27:55 +00003374void CXXNameMangler::mangleCastExpression(const Expr *E, StringRef CastEncoding) {
3375 const ExplicitCastExpr *ECE = cast<ExplicitCastExpr>(E);
3376 Out << CastEncoding;
3377 mangleType(ECE->getType());
3378 mangleExpression(ECE->getSubExpr());
3379}
3380
Richard Smith520449d2015-02-05 06:15:50 +00003381void CXXNameMangler::mangleInitListElements(const InitListExpr *InitList) {
3382 if (auto *Syntactic = InitList->getSyntacticForm())
3383 InitList = Syntactic;
3384 for (unsigned i = 0, e = InitList->getNumInits(); i != e; ++i)
3385 mangleExpression(InitList->getInit(i));
3386}
3387
Guy Benyei11169dd2012-12-18 14:30:41 +00003388void CXXNameMangler::mangleExpression(const Expr *E, unsigned Arity) {
3389 // <expression> ::= <unary operator-name> <expression>
3390 // ::= <binary operator-name> <expression> <expression>
3391 // ::= <trinary operator-name> <expression> <expression> <expression>
3392 // ::= cv <type> expression # conversion with one argument
3393 // ::= cv <type> _ <expression>* E # conversion with a different number of arguments
David Majnemer9c775c72014-09-23 04:27:55 +00003394 // ::= dc <type> <expression> # dynamic_cast<type> (expression)
3395 // ::= sc <type> <expression> # static_cast<type> (expression)
3396 // ::= cc <type> <expression> # const_cast<type> (expression)
3397 // ::= rc <type> <expression> # reinterpret_cast<type> (expression)
Guy Benyei11169dd2012-12-18 14:30:41 +00003398 // ::= st <type> # sizeof (a type)
3399 // ::= at <type> # alignof (a type)
3400 // ::= <template-param>
3401 // ::= <function-param>
3402 // ::= sr <type> <unqualified-name> # dependent name
3403 // ::= sr <type> <unqualified-name> <template-args> # dependent template-id
3404 // ::= ds <expression> <expression> # expr.*expr
3405 // ::= sZ <template-param> # size of a parameter pack
3406 // ::= sZ <function-param> # size of a function parameter pack
3407 // ::= <expr-primary>
3408 // <expr-primary> ::= L <type> <value number> E # integer literal
3409 // ::= L <type <value float> E # floating literal
3410 // ::= L <mangled-name> E # external name
3411 // ::= fpT # 'this' expression
3412 QualType ImplicitlyConvertedToType;
3413
3414recurse:
3415 switch (E->getStmtClass()) {
3416 case Expr::NoStmtClass:
3417#define ABSTRACT_STMT(Type)
3418#define EXPR(Type, Base)
3419#define STMT(Type, Base) \
3420 case Expr::Type##Class:
3421#include "clang/AST/StmtNodes.inc"
3422 // fallthrough
3423
3424 // These all can only appear in local or variable-initialization
3425 // contexts and so should never appear in a mangling.
3426 case Expr::AddrLabelExprClass:
Yunzhong Gaocb779302015-06-10 00:27:52 +00003427 case Expr::DesignatedInitUpdateExprClass:
Guy Benyei11169dd2012-12-18 14:30:41 +00003428 case Expr::ImplicitValueInitExprClass:
Richard Smith410306b2016-12-12 02:53:20 +00003429 case Expr::ArrayInitLoopExprClass:
3430 case Expr::ArrayInitIndexExprClass:
Yunzhong Gaocb779302015-06-10 00:27:52 +00003431 case Expr::NoInitExprClass:
Guy Benyei11169dd2012-12-18 14:30:41 +00003432 case Expr::ParenListExprClass:
3433 case Expr::LambdaExprClass:
John McCall5e77d762013-04-16 07:28:30 +00003434 case Expr::MSPropertyRefExprClass:
Alexey Bataevf7630272015-11-25 12:01:00 +00003435 case Expr::MSPropertySubscriptExprClass:
Kaelyn Takatae1f49d52014-10-27 18:07:20 +00003436 case Expr::TypoExprClass: // This should no longer exist in the AST by now.
Alexey Bataev1a3320e2015-08-25 14:24:04 +00003437 case Expr::OMPArraySectionExprClass:
Richard Smith5179eb72016-06-28 19:03:57 +00003438 case Expr::CXXInheritedCtorInitExprClass:
Guy Benyei11169dd2012-12-18 14:30:41 +00003439 llvm_unreachable("unexpected statement kind");
3440
3441 // FIXME: invent manglings for all these.
3442 case Expr::BlockExprClass:
Guy Benyei11169dd2012-12-18 14:30:41 +00003443 case Expr::ChooseExprClass:
3444 case Expr::CompoundLiteralExprClass:
3445 case Expr::ExtVectorElementExprClass:
3446 case Expr::GenericSelectionExprClass:
3447 case Expr::ObjCEncodeExprClass:
3448 case Expr::ObjCIsaExprClass:
3449 case Expr::ObjCIvarRefExprClass:
3450 case Expr::ObjCMessageExprClass:
3451 case Expr::ObjCPropertyRefExprClass:
3452 case Expr::ObjCProtocolExprClass:
3453 case Expr::ObjCSelectorExprClass:
3454 case Expr::ObjCStringLiteralClass:
3455 case Expr::ObjCBoxedExprClass:
3456 case Expr::ObjCArrayLiteralClass:
3457 case Expr::ObjCDictionaryLiteralClass:
3458 case Expr::ObjCSubscriptRefExprClass:
3459 case Expr::ObjCIndirectCopyRestoreExprClass:
Erik Pilkington29099de2016-07-16 00:35:23 +00003460 case Expr::ObjCAvailabilityCheckExprClass:
Guy Benyei11169dd2012-12-18 14:30:41 +00003461 case Expr::OffsetOfExprClass:
3462 case Expr::PredefinedExprClass:
3463 case Expr::ShuffleVectorExprClass:
Hal Finkelc4d7c822013-09-18 03:29:45 +00003464 case Expr::ConvertVectorExprClass:
Guy Benyei11169dd2012-12-18 14:30:41 +00003465 case Expr::StmtExprClass:
Guy Benyei11169dd2012-12-18 14:30:41 +00003466 case Expr::TypeTraitExprClass:
3467 case Expr::ArrayTypeTraitExprClass:
3468 case Expr::ExpressionTraitExprClass:
3469 case Expr::VAArgExprClass:
Guy Benyei11169dd2012-12-18 14:30:41 +00003470 case Expr::CUDAKernelCallExprClass:
3471 case Expr::AsTypeExprClass:
3472 case Expr::PseudoObjectExprClass:
3473 case Expr::AtomicExprClass:
3474 {
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00003475 if (!NullOut) {
3476 // As bad as this diagnostic is, it's better than crashing.
3477 DiagnosticsEngine &Diags = Context.getDiags();
3478 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
3479 "cannot yet mangle expression type %0");
3480 Diags.Report(E->getExprLoc(), DiagID)
3481 << E->getStmtClassName() << E->getSourceRange();
3482 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003483 break;
3484 }
3485
Fariborz Jahanian945a08d2014-09-24 16:28:40 +00003486 case Expr::CXXUuidofExprClass: {
3487 const CXXUuidofExpr *UE = cast<CXXUuidofExpr>(E);
3488 if (UE->isTypeOperand()) {
3489 QualType UuidT = UE->getTypeOperand(Context.getASTContext());
3490 Out << "u8__uuidoft";
3491 mangleType(UuidT);
3492 } else {
3493 Expr *UuidExp = UE->getExprOperand();
3494 Out << "u8__uuidofz";
3495 mangleExpression(UuidExp, Arity);
3496 }
3497 break;
3498 }
3499
Guy Benyei11169dd2012-12-18 14:30:41 +00003500 // Even gcc-4.5 doesn't mangle this.
3501 case Expr::BinaryConditionalOperatorClass: {
3502 DiagnosticsEngine &Diags = Context.getDiags();
3503 unsigned DiagID =
3504 Diags.getCustomDiagID(DiagnosticsEngine::Error,
3505 "?: operator with omitted middle operand cannot be mangled");
3506 Diags.Report(E->getExprLoc(), DiagID)
3507 << E->getStmtClassName() << E->getSourceRange();
3508 break;
3509 }
3510
3511 // These are used for internal purposes and cannot be meaningfully mangled.
3512 case Expr::OpaqueValueExprClass:
3513 llvm_unreachable("cannot mangle opaque value; mangling wrong thing?");
3514
3515 case Expr::InitListExprClass: {
Guy Benyei11169dd2012-12-18 14:30:41 +00003516 Out << "il";
Richard Smith520449d2015-02-05 06:15:50 +00003517 mangleInitListElements(cast<InitListExpr>(E));
Guy Benyei11169dd2012-12-18 14:30:41 +00003518 Out << "E";
3519 break;
3520 }
3521
Richard Smith39eca9b2017-08-23 22:12:08 +00003522 case Expr::DesignatedInitExprClass: {
3523 auto *DIE = cast<DesignatedInitExpr>(E);
3524 for (const auto &Designator : DIE->designators()) {
3525 if (Designator.isFieldDesignator()) {
3526 Out << "di";
3527 mangleSourceName(Designator.getFieldName());
3528 } else if (Designator.isArrayDesignator()) {
3529 Out << "dx";
3530 mangleExpression(DIE->getArrayIndex(Designator));
3531 } else {
3532 assert(Designator.isArrayRangeDesignator() &&
3533 "unknown designator kind");
3534 Out << "dX";
3535 mangleExpression(DIE->getArrayRangeStart(Designator));
3536 mangleExpression(DIE->getArrayRangeEnd(Designator));
3537 }
3538 }
3539 mangleExpression(DIE->getInit());
3540 break;
3541 }
3542
Guy Benyei11169dd2012-12-18 14:30:41 +00003543 case Expr::CXXDefaultArgExprClass:
3544 mangleExpression(cast<CXXDefaultArgExpr>(E)->getExpr(), Arity);
3545 break;
3546
Richard Smith852c9db2013-04-20 22:23:05 +00003547 case Expr::CXXDefaultInitExprClass:
3548 mangleExpression(cast<CXXDefaultInitExpr>(E)->getExpr(), Arity);
3549 break;
3550
Richard Smithcc1b96d2013-06-12 22:31:48 +00003551 case Expr::CXXStdInitializerListExprClass:
3552 mangleExpression(cast<CXXStdInitializerListExpr>(E)->getSubExpr(), Arity);
3553 break;
3554
Guy Benyei11169dd2012-12-18 14:30:41 +00003555 case Expr::SubstNonTypeTemplateParmExprClass:
3556 mangleExpression(cast<SubstNonTypeTemplateParmExpr>(E)->getReplacement(),
3557 Arity);
3558 break;
3559
3560 case Expr::UserDefinedLiteralClass:
3561 // We follow g++'s approach of mangling a UDL as a call to the literal
3562 // operator.
3563 case Expr::CXXMemberCallExprClass: // fallthrough
3564 case Expr::CallExprClass: {
3565 const CallExpr *CE = cast<CallExpr>(E);
3566
3567 // <expression> ::= cp <simple-id> <expression>* E
3568 // We use this mangling only when the call would use ADL except
3569 // for being parenthesized. Per discussion with David
3570 // Vandervoorde, 2011.04.25.
3571 if (isParenthesizedADLCallee(CE)) {
3572 Out << "cp";
3573 // The callee here is a parenthesized UnresolvedLookupExpr with
3574 // no qualifier and should always get mangled as a <simple-id>
3575 // anyway.
3576
3577 // <expression> ::= cl <expression>* E
3578 } else {
3579 Out << "cl";
3580 }
3581
David Majnemer67a8ec62015-02-19 21:41:48 +00003582 unsigned CallArity = CE->getNumArgs();
3583 for (const Expr *Arg : CE->arguments())
3584 if (isa<PackExpansionExpr>(Arg))
3585 CallArity = UnknownArity;
3586
3587 mangleExpression(CE->getCallee(), CallArity);
3588 for (const Expr *Arg : CE->arguments())
3589 mangleExpression(Arg);
Guy Benyei11169dd2012-12-18 14:30:41 +00003590 Out << 'E';
3591 break;
3592 }
3593
3594 case Expr::CXXNewExprClass: {
3595 const CXXNewExpr *New = cast<CXXNewExpr>(E);
3596 if (New->isGlobalNew()) Out << "gs";
3597 Out << (New->isArray() ? "na" : "nw");
3598 for (CXXNewExpr::const_arg_iterator I = New->placement_arg_begin(),
3599 E = New->placement_arg_end(); I != E; ++I)
3600 mangleExpression(*I);
3601 Out << '_';
3602 mangleType(New->getAllocatedType());
3603 if (New->hasInitializer()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003604 if (New->getInitializationStyle() == CXXNewExpr::ListInit)
3605 Out << "il";
3606 else
3607 Out << "pi";
3608 const Expr *Init = New->getInitializer();
3609 if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(Init)) {
3610 // Directly inline the initializers.
3611 for (CXXConstructExpr::const_arg_iterator I = CCE->arg_begin(),
3612 E = CCE->arg_end();
3613 I != E; ++I)
3614 mangleExpression(*I);
3615 } else if (const ParenListExpr *PLE = dyn_cast<ParenListExpr>(Init)) {
3616 for (unsigned i = 0, e = PLE->getNumExprs(); i != e; ++i)
3617 mangleExpression(PLE->getExpr(i));
3618 } else if (New->getInitializationStyle() == CXXNewExpr::ListInit &&
3619 isa<InitListExpr>(Init)) {
3620 // Only take InitListExprs apart for list-initialization.
Richard Smith520449d2015-02-05 06:15:50 +00003621 mangleInitListElements(cast<InitListExpr>(Init));
Guy Benyei11169dd2012-12-18 14:30:41 +00003622 } else
3623 mangleExpression(Init);
3624 }
3625 Out << 'E';
3626 break;
3627 }
3628
David Majnemer1dabfdc2015-02-14 13:23:54 +00003629 case Expr::CXXPseudoDestructorExprClass: {
3630 const auto *PDE = cast<CXXPseudoDestructorExpr>(E);
3631 if (const Expr *Base = PDE->getBase())
3632 mangleMemberExprBase(Base, PDE->isArrow());
David Majnemerb8014dd2015-02-19 02:16:16 +00003633 NestedNameSpecifier *Qualifier = PDE->getQualifier();
David Majnemerb8014dd2015-02-19 02:16:16 +00003634 if (TypeSourceInfo *ScopeInfo = PDE->getScopeTypeInfo()) {
3635 if (Qualifier) {
3636 mangleUnresolvedPrefix(Qualifier,
3637 /*Recursive=*/true);
3638 mangleUnresolvedTypeOrSimpleId(ScopeInfo->getType());
3639 Out << 'E';
3640 } else {
3641 Out << "sr";
3642 if (!mangleUnresolvedTypeOrSimpleId(ScopeInfo->getType()))
3643 Out << 'E';
3644 }
3645 } else if (Qualifier) {
3646 mangleUnresolvedPrefix(Qualifier);
3647 }
David Majnemer1dabfdc2015-02-14 13:23:54 +00003648 // <base-unresolved-name> ::= dn <destructor-name>
3649 Out << "dn";
David Majnemera88b3592015-02-18 02:28:01 +00003650 QualType DestroyedType = PDE->getDestroyedType();
David Majnemerb8014dd2015-02-19 02:16:16 +00003651 mangleUnresolvedTypeOrSimpleId(DestroyedType);
David Majnemer1dabfdc2015-02-14 13:23:54 +00003652 break;
3653 }
3654
Guy Benyei11169dd2012-12-18 14:30:41 +00003655 case Expr::MemberExprClass: {
3656 const MemberExpr *ME = cast<MemberExpr>(E);
3657 mangleMemberExpr(ME->getBase(), ME->isArrow(),
Craig Topper36250ad2014-05-12 05:36:57 +00003658 ME->getQualifier(), nullptr,
Richard Smithafecd832016-10-24 20:47:04 +00003659 ME->getMemberDecl()->getDeclName(),
3660 ME->getTemplateArgs(), ME->getNumTemplateArgs(),
3661 Arity);
Guy Benyei11169dd2012-12-18 14:30:41 +00003662 break;
3663 }
3664
3665 case Expr::UnresolvedMemberExprClass: {
3666 const UnresolvedMemberExpr *ME = cast<UnresolvedMemberExpr>(E);
Douglas Gregor3c523c42015-05-21 18:28:18 +00003667 mangleMemberExpr(ME->isImplicitAccess() ? nullptr : ME->getBase(),
3668 ME->isArrow(), ME->getQualifier(), nullptr,
Richard Smithafecd832016-10-24 20:47:04 +00003669 ME->getMemberName(),
3670 ME->getTemplateArgs(), ME->getNumTemplateArgs(),
3671 Arity);
Guy Benyei11169dd2012-12-18 14:30:41 +00003672 break;
3673 }
3674
3675 case Expr::CXXDependentScopeMemberExprClass: {
3676 const CXXDependentScopeMemberExpr *ME
3677 = cast<CXXDependentScopeMemberExpr>(E);
Douglas Gregor3c523c42015-05-21 18:28:18 +00003678 mangleMemberExpr(ME->isImplicitAccess() ? nullptr : ME->getBase(),
3679 ME->isArrow(), ME->getQualifier(),
3680 ME->getFirstQualifierFoundInScope(),
Richard Smithafecd832016-10-24 20:47:04 +00003681 ME->getMember(),
3682 ME->getTemplateArgs(), ME->getNumTemplateArgs(),
3683 Arity);
Guy Benyei11169dd2012-12-18 14:30:41 +00003684 break;
3685 }
3686
3687 case Expr::UnresolvedLookupExprClass: {
3688 const UnresolvedLookupExpr *ULE = cast<UnresolvedLookupExpr>(E);
Richard Smithafecd832016-10-24 20:47:04 +00003689 mangleUnresolvedName(ULE->getQualifier(), ULE->getName(),
3690 ULE->getTemplateArgs(), ULE->getNumTemplateArgs(),
3691 Arity);
Guy Benyei11169dd2012-12-18 14:30:41 +00003692 break;
3693 }
3694
3695 case Expr::CXXUnresolvedConstructExprClass: {
3696 const CXXUnresolvedConstructExpr *CE = cast<CXXUnresolvedConstructExpr>(E);
3697 unsigned N = CE->arg_size();
3698
Richard Smith39eca9b2017-08-23 22:12:08 +00003699 if (CE->isListInitialization()) {
3700 assert(N == 1 && "unexpected form for list initialization");
3701 auto *IL = cast<InitListExpr>(CE->getArg(0));
3702 Out << "tl";
3703 mangleType(CE->getType());
3704 mangleInitListElements(IL);
3705 Out << "E";
3706 return;
3707 }
3708
Guy Benyei11169dd2012-12-18 14:30:41 +00003709 Out << "cv";
3710 mangleType(CE->getType());
3711 if (N != 1) Out << '_';
3712 for (unsigned I = 0; I != N; ++I) mangleExpression(CE->getArg(I));
3713 if (N != 1) Out << 'E';
3714 break;
3715 }
3716
Guy Benyei11169dd2012-12-18 14:30:41 +00003717 case Expr::CXXConstructExprClass: {
Richard Smith520449d2015-02-05 06:15:50 +00003718 const auto *CE = cast<CXXConstructExpr>(E);
Richard Smithed83ebd2015-02-05 07:02:11 +00003719 if (!CE->isListInitialization() || CE->isStdInitListInitialization()) {
Richard Smith520449d2015-02-05 06:15:50 +00003720 assert(
3721 CE->getNumArgs() >= 1 &&
3722 (CE->getNumArgs() == 1 || isa<CXXDefaultArgExpr>(CE->getArg(1))) &&
3723 "implicit CXXConstructExpr must have one argument");
3724 return mangleExpression(cast<CXXConstructExpr>(E)->getArg(0));
3725 }
3726 Out << "il";
3727 for (auto *E : CE->arguments())
3728 mangleExpression(E);
3729 Out << "E";
3730 break;
3731 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003732
Richard Smith520449d2015-02-05 06:15:50 +00003733 case Expr::CXXTemporaryObjectExprClass: {
3734 const auto *CE = cast<CXXTemporaryObjectExpr>(E);
3735 unsigned N = CE->getNumArgs();
3736 bool List = CE->isListInitialization();
3737
3738 if (List)
Guy Benyei11169dd2012-12-18 14:30:41 +00003739 Out << "tl";
3740 else
3741 Out << "cv";
3742 mangleType(CE->getType());
Richard Smith520449d2015-02-05 06:15:50 +00003743 if (!List && N != 1)
3744 Out << '_';
Richard Smithed83ebd2015-02-05 07:02:11 +00003745 if (CE->isStdInitListInitialization()) {
3746 // We implicitly created a std::initializer_list<T> for the first argument
3747 // of a constructor of type U in an expression of the form U{a, b, c}.
3748 // Strip all the semantic gunk off the initializer list.
3749 auto *SILE =
3750 cast<CXXStdInitializerListExpr>(CE->getArg(0)->IgnoreImplicit());
3751 auto *ILE = cast<InitListExpr>(SILE->getSubExpr()->IgnoreImplicit());
3752 mangleInitListElements(ILE);
3753 } else {
3754 for (auto *E : CE->arguments())
3755 mangleExpression(E);
3756 }
Richard Smith520449d2015-02-05 06:15:50 +00003757 if (List || N != 1)
3758 Out << 'E';
Guy Benyei11169dd2012-12-18 14:30:41 +00003759 break;
3760 }
3761
3762 case Expr::CXXScalarValueInitExprClass:
Richard Smith520449d2015-02-05 06:15:50 +00003763 Out << "cv";
Guy Benyei11169dd2012-12-18 14:30:41 +00003764 mangleType(E->getType());
Richard Smith520449d2015-02-05 06:15:50 +00003765 Out << "_E";
Guy Benyei11169dd2012-12-18 14:30:41 +00003766 break;
3767
3768 case Expr::CXXNoexceptExprClass:
3769 Out << "nx";
3770 mangleExpression(cast<CXXNoexceptExpr>(E)->getOperand());
3771 break;
3772
3773 case Expr::UnaryExprOrTypeTraitExprClass: {
3774 const UnaryExprOrTypeTraitExpr *SAE = cast<UnaryExprOrTypeTraitExpr>(E);
3775
3776 if (!SAE->isInstantiationDependent()) {
3777 // Itanium C++ ABI:
3778 // If the operand of a sizeof or alignof operator is not
3779 // instantiation-dependent it is encoded as an integer literal
3780 // reflecting the result of the operator.
3781 //
3782 // If the result of the operator is implicitly converted to a known
3783 // integer type, that type is used for the literal; otherwise, the type
3784 // of std::size_t or std::ptrdiff_t is used.
3785 QualType T = (ImplicitlyConvertedToType.isNull() ||
3786 !ImplicitlyConvertedToType->isIntegerType())? SAE->getType()
3787 : ImplicitlyConvertedToType;
3788 llvm::APSInt V = SAE->EvaluateKnownConstInt(Context.getASTContext());
3789 mangleIntegerLiteral(T, V);
3790 break;
3791 }
3792
3793 switch(SAE->getKind()) {
3794 case UETT_SizeOf:
3795 Out << 's';
3796 break;
3797 case UETT_AlignOf:
3798 Out << 'a';
3799 break;
Alexey Bataev00396512015-07-02 03:40:19 +00003800 case UETT_VecStep: {
Guy Benyei11169dd2012-12-18 14:30:41 +00003801 DiagnosticsEngine &Diags = Context.getDiags();
3802 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
3803 "cannot yet mangle vec_step expression");
3804 Diags.Report(DiagID);
3805 return;
3806 }
Alexey Bataev00396512015-07-02 03:40:19 +00003807 case UETT_OpenMPRequiredSimdAlign:
3808 DiagnosticsEngine &Diags = Context.getDiags();
3809 unsigned DiagID = Diags.getCustomDiagID(
3810 DiagnosticsEngine::Error,
3811 "cannot yet mangle __builtin_omp_required_simd_align expression");
3812 Diags.Report(DiagID);
3813 return;
3814 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003815 if (SAE->isArgumentType()) {
3816 Out << 't';
3817 mangleType(SAE->getArgumentType());
3818 } else {
3819 Out << 'z';
3820 mangleExpression(SAE->getArgumentExpr());
3821 }
3822 break;
3823 }
3824
3825 case Expr::CXXThrowExprClass: {
3826 const CXXThrowExpr *TE = cast<CXXThrowExpr>(E);
Richard Smitheb0133c2013-08-27 01:03:46 +00003827 // <expression> ::= tw <expression> # throw expression
3828 // ::= tr # rethrow
Guy Benyei11169dd2012-12-18 14:30:41 +00003829 if (TE->getSubExpr()) {
3830 Out << "tw";
3831 mangleExpression(TE->getSubExpr());
3832 } else {
3833 Out << "tr";
3834 }
3835 break;
3836 }
3837
3838 case Expr::CXXTypeidExprClass: {
3839 const CXXTypeidExpr *TIE = cast<CXXTypeidExpr>(E);
Richard Smitheb0133c2013-08-27 01:03:46 +00003840 // <expression> ::= ti <type> # typeid (type)
3841 // ::= te <expression> # typeid (expression)
Guy Benyei11169dd2012-12-18 14:30:41 +00003842 if (TIE->isTypeOperand()) {
3843 Out << "ti";
David Majnemer143c55e2013-09-27 07:04:31 +00003844 mangleType(TIE->getTypeOperand(Context.getASTContext()));
Guy Benyei11169dd2012-12-18 14:30:41 +00003845 } else {
3846 Out << "te";
3847 mangleExpression(TIE->getExprOperand());
3848 }
3849 break;
3850 }
3851
3852 case Expr::CXXDeleteExprClass: {
3853 const CXXDeleteExpr *DE = cast<CXXDeleteExpr>(E);
Richard Smitheb0133c2013-08-27 01:03:46 +00003854 // <expression> ::= [gs] dl <expression> # [::] delete expr
3855 // ::= [gs] da <expression> # [::] delete [] expr
Guy Benyei11169dd2012-12-18 14:30:41 +00003856 if (DE->isGlobalDelete()) Out << "gs";
3857 Out << (DE->isArrayForm() ? "da" : "dl");
3858 mangleExpression(DE->getArgument());
3859 break;
3860 }
3861
3862 case Expr::UnaryOperatorClass: {
3863 const UnaryOperator *UO = cast<UnaryOperator>(E);
3864 mangleOperatorName(UnaryOperator::getOverloadedOperator(UO->getOpcode()),
3865 /*Arity=*/1);
3866 mangleExpression(UO->getSubExpr());
3867 break;
3868 }
3869
3870 case Expr::ArraySubscriptExprClass: {
3871 const ArraySubscriptExpr *AE = cast<ArraySubscriptExpr>(E);
3872
3873 // Array subscript is treated as a syntactically weird form of
3874 // binary operator.
3875 Out << "ix";
3876 mangleExpression(AE->getLHS());
3877 mangleExpression(AE->getRHS());
3878 break;
3879 }
3880
3881 case Expr::CompoundAssignOperatorClass: // fallthrough
3882 case Expr::BinaryOperatorClass: {
3883 const BinaryOperator *BO = cast<BinaryOperator>(E);
3884 if (BO->getOpcode() == BO_PtrMemD)
3885 Out << "ds";
3886 else
3887 mangleOperatorName(BinaryOperator::getOverloadedOperator(BO->getOpcode()),
3888 /*Arity=*/2);
3889 mangleExpression(BO->getLHS());
3890 mangleExpression(BO->getRHS());
3891 break;
3892 }
3893
3894 case Expr::ConditionalOperatorClass: {
3895 const ConditionalOperator *CO = cast<ConditionalOperator>(E);
3896 mangleOperatorName(OO_Conditional, /*Arity=*/3);
3897 mangleExpression(CO->getCond());
3898 mangleExpression(CO->getLHS(), Arity);
3899 mangleExpression(CO->getRHS(), Arity);
3900 break;
3901 }
3902
3903 case Expr::ImplicitCastExprClass: {
3904 ImplicitlyConvertedToType = E->getType();
3905 E = cast<ImplicitCastExpr>(E)->getSubExpr();
3906 goto recurse;
3907 }
3908
3909 case Expr::ObjCBridgedCastExprClass: {
3910 // Mangle ownership casts as a vendor extended operator __bridge,
3911 // __bridge_transfer, or __bridge_retain.
3912 StringRef Kind = cast<ObjCBridgedCastExpr>(E)->getBridgeKindName();
3913 Out << "v1U" << Kind.size() << Kind;
3914 }
3915 // Fall through to mangle the cast itself.
Galina Kistanovaf87496d2017-06-03 06:31:42 +00003916 LLVM_FALLTHROUGH;
Guy Benyei11169dd2012-12-18 14:30:41 +00003917
3918 case Expr::CStyleCastExprClass:
David Majnemer9c775c72014-09-23 04:27:55 +00003919 mangleCastExpression(E, "cv");
Guy Benyei11169dd2012-12-18 14:30:41 +00003920 break;
David Majnemer9c775c72014-09-23 04:27:55 +00003921
Richard Smith520449d2015-02-05 06:15:50 +00003922 case Expr::CXXFunctionalCastExprClass: {
3923 auto *Sub = cast<ExplicitCastExpr>(E)->getSubExpr()->IgnoreImplicit();
3924 // FIXME: Add isImplicit to CXXConstructExpr.
3925 if (auto *CCE = dyn_cast<CXXConstructExpr>(Sub))
3926 if (CCE->getParenOrBraceRange().isInvalid())
3927 Sub = CCE->getArg(0)->IgnoreImplicit();
3928 if (auto *StdInitList = dyn_cast<CXXStdInitializerListExpr>(Sub))
3929 Sub = StdInitList->getSubExpr()->IgnoreImplicit();
3930 if (auto *IL = dyn_cast<InitListExpr>(Sub)) {
3931 Out << "tl";
3932 mangleType(E->getType());
3933 mangleInitListElements(IL);
3934 Out << "E";
3935 } else {
3936 mangleCastExpression(E, "cv");
3937 }
3938 break;
3939 }
3940
David Majnemer9c775c72014-09-23 04:27:55 +00003941 case Expr::CXXStaticCastExprClass:
3942 mangleCastExpression(E, "sc");
3943 break;
3944 case Expr::CXXDynamicCastExprClass:
3945 mangleCastExpression(E, "dc");
3946 break;
3947 case Expr::CXXReinterpretCastExprClass:
3948 mangleCastExpression(E, "rc");
3949 break;
3950 case Expr::CXXConstCastExprClass:
3951 mangleCastExpression(E, "cc");
3952 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00003953
3954 case Expr::CXXOperatorCallExprClass: {
3955 const CXXOperatorCallExpr *CE = cast<CXXOperatorCallExpr>(E);
3956 unsigned NumArgs = CE->getNumArgs();
Richard Smith4631be72016-10-24 20:29:40 +00003957 // A CXXOperatorCallExpr for OO_Arrow models only semantics, not syntax
3958 // (the enclosing MemberExpr covers the syntactic portion).
3959 if (CE->getOperator() != OO_Arrow)
3960 mangleOperatorName(CE->getOperator(), /*Arity=*/NumArgs);
Guy Benyei11169dd2012-12-18 14:30:41 +00003961 // Mangle the arguments.
3962 for (unsigned i = 0; i != NumArgs; ++i)
3963 mangleExpression(CE->getArg(i));
3964 break;
3965 }
3966
3967 case Expr::ParenExprClass:
3968 mangleExpression(cast<ParenExpr>(E)->getSubExpr(), Arity);
3969 break;
3970
3971 case Expr::DeclRefExprClass: {
3972 const NamedDecl *D = cast<DeclRefExpr>(E)->getDecl();
3973
3974 switch (D->getKind()) {
3975 default:
3976 // <expr-primary> ::= L <mangled-name> E # external name
3977 Out << 'L';
David Majnemer7ff7eb72015-02-18 07:47:09 +00003978 mangle(D);
Guy Benyei11169dd2012-12-18 14:30:41 +00003979 Out << 'E';
3980 break;
3981
3982 case Decl::ParmVar:
3983 mangleFunctionParam(cast<ParmVarDecl>(D));
3984 break;
3985
3986 case Decl::EnumConstant: {
3987 const EnumConstantDecl *ED = cast<EnumConstantDecl>(D);
3988 mangleIntegerLiteral(ED->getType(), ED->getInitVal());
3989 break;
3990 }
3991
3992 case Decl::NonTypeTemplateParm: {
3993 const NonTypeTemplateParmDecl *PD = cast<NonTypeTemplateParmDecl>(D);
3994 mangleTemplateParameter(PD->getIndex());
3995 break;
3996 }
3997
3998 }
3999
4000 break;
4001 }
4002
4003 case Expr::SubstNonTypeTemplateParmPackExprClass:
4004 // FIXME: not clear how to mangle this!
4005 // template <unsigned N...> class A {
4006 // template <class U...> void foo(U (&x)[N]...);
4007 // };
4008 Out << "_SUBSTPACK_";
4009 break;
4010
4011 case Expr::FunctionParmPackExprClass: {
4012 // FIXME: not clear how to mangle this!
4013 const FunctionParmPackExpr *FPPE = cast<FunctionParmPackExpr>(E);
4014 Out << "v110_SUBSTPACK";
4015 mangleFunctionParam(FPPE->getParameterPack());
4016 break;
4017 }
4018
4019 case Expr::DependentScopeDeclRefExprClass: {
4020 const DependentScopeDeclRefExpr *DRE = cast<DependentScopeDeclRefExpr>(E);
Richard Smithafecd832016-10-24 20:47:04 +00004021 mangleUnresolvedName(DRE->getQualifier(), DRE->getDeclName(),
4022 DRE->getTemplateArgs(), DRE->getNumTemplateArgs(),
4023 Arity);
Guy Benyei11169dd2012-12-18 14:30:41 +00004024 break;
4025 }
4026
4027 case Expr::CXXBindTemporaryExprClass:
4028 mangleExpression(cast<CXXBindTemporaryExpr>(E)->getSubExpr());
4029 break;
4030
4031 case Expr::ExprWithCleanupsClass:
4032 mangleExpression(cast<ExprWithCleanups>(E)->getSubExpr(), Arity);
4033 break;
4034
4035 case Expr::FloatingLiteralClass: {
4036 const FloatingLiteral *FL = cast<FloatingLiteral>(E);
4037 Out << 'L';
4038 mangleType(FL->getType());
4039 mangleFloat(FL->getValue());
4040 Out << 'E';
4041 break;
4042 }
4043
4044 case Expr::CharacterLiteralClass:
4045 Out << 'L';
4046 mangleType(E->getType());
4047 Out << cast<CharacterLiteral>(E)->getValue();
4048 Out << 'E';
4049 break;
4050
4051 // FIXME. __objc_yes/__objc_no are mangled same as true/false
4052 case Expr::ObjCBoolLiteralExprClass:
4053 Out << "Lb";
4054 Out << (cast<ObjCBoolLiteralExpr>(E)->getValue() ? '1' : '0');
4055 Out << 'E';
4056 break;
4057
4058 case Expr::CXXBoolLiteralExprClass:
4059 Out << "Lb";
4060 Out << (cast<CXXBoolLiteralExpr>(E)->getValue() ? '1' : '0');
4061 Out << 'E';
4062 break;
4063
4064 case Expr::IntegerLiteralClass: {
4065 llvm::APSInt Value(cast<IntegerLiteral>(E)->getValue());
4066 if (E->getType()->isSignedIntegerType())
4067 Value.setIsSigned(true);
4068 mangleIntegerLiteral(E->getType(), Value);
4069 break;
4070 }
4071
4072 case Expr::ImaginaryLiteralClass: {
4073 const ImaginaryLiteral *IE = cast<ImaginaryLiteral>(E);
4074 // Mangle as if a complex literal.
4075 // Proposal from David Vandevoorde, 2010.06.30.
4076 Out << 'L';
4077 mangleType(E->getType());
4078 if (const FloatingLiteral *Imag =
4079 dyn_cast<FloatingLiteral>(IE->getSubExpr())) {
4080 // Mangle a floating-point zero of the appropriate type.
4081 mangleFloat(llvm::APFloat(Imag->getValue().getSemantics()));
4082 Out << '_';
4083 mangleFloat(Imag->getValue());
4084 } else {
4085 Out << "0_";
4086 llvm::APSInt Value(cast<IntegerLiteral>(IE->getSubExpr())->getValue());
4087 if (IE->getSubExpr()->getType()->isSignedIntegerType())
4088 Value.setIsSigned(true);
4089 mangleNumber(Value);
4090 }
4091 Out << 'E';
4092 break;
4093 }
4094
4095 case Expr::StringLiteralClass: {
4096 // Revised proposal from David Vandervoorde, 2010.07.15.
4097 Out << 'L';
4098 assert(isa<ConstantArrayType>(E->getType()));
4099 mangleType(E->getType());
4100 Out << 'E';
4101 break;
4102 }
4103
4104 case Expr::GNUNullExprClass:
4105 // FIXME: should this really be mangled the same as nullptr?
4106 // fallthrough
4107
4108 case Expr::CXXNullPtrLiteralExprClass: {
Guy Benyei11169dd2012-12-18 14:30:41 +00004109 Out << "LDnE";
4110 break;
4111 }
4112
4113 case Expr::PackExpansionExprClass:
4114 Out << "sp";
4115 mangleExpression(cast<PackExpansionExpr>(E)->getPattern());
4116 break;
4117
4118 case Expr::SizeOfPackExprClass: {
Richard Smithd784e682015-09-23 21:41:42 +00004119 auto *SPE = cast<SizeOfPackExpr>(E);
4120 if (SPE->isPartiallySubstituted()) {
4121 Out << "sP";
4122 for (const auto &A : SPE->getPartialArguments())
4123 mangleTemplateArg(A);
4124 Out << "E";
4125 break;
4126 }
4127
Guy Benyei11169dd2012-12-18 14:30:41 +00004128 Out << "sZ";
Richard Smithd784e682015-09-23 21:41:42 +00004129 const NamedDecl *Pack = SPE->getPack();
Guy Benyei11169dd2012-12-18 14:30:41 +00004130 if (const TemplateTypeParmDecl *TTP = dyn_cast<TemplateTypeParmDecl>(Pack))
4131 mangleTemplateParameter(TTP->getIndex());
4132 else if (const NonTypeTemplateParmDecl *NTTP
4133 = dyn_cast<NonTypeTemplateParmDecl>(Pack))
4134 mangleTemplateParameter(NTTP->getIndex());
4135 else if (const TemplateTemplateParmDecl *TempTP
4136 = dyn_cast<TemplateTemplateParmDecl>(Pack))
4137 mangleTemplateParameter(TempTP->getIndex());
4138 else
4139 mangleFunctionParam(cast<ParmVarDecl>(Pack));
4140 break;
4141 }
Richard Smith0f0af192014-11-08 05:07:16 +00004142
Guy Benyei11169dd2012-12-18 14:30:41 +00004143 case Expr::MaterializeTemporaryExprClass: {
4144 mangleExpression(cast<MaterializeTemporaryExpr>(E)->GetTemporaryExpr());
4145 break;
4146 }
Richard Smith0f0af192014-11-08 05:07:16 +00004147
4148 case Expr::CXXFoldExprClass: {
4149 auto *FE = cast<CXXFoldExpr>(E);
Richard Smith8e6923b2014-11-10 19:44:15 +00004150 if (FE->isLeftFold())
4151 Out << (FE->getInit() ? "fL" : "fl");
Richard Smith0f0af192014-11-08 05:07:16 +00004152 else
Richard Smith8e6923b2014-11-10 19:44:15 +00004153 Out << (FE->getInit() ? "fR" : "fr");
Richard Smith0f0af192014-11-08 05:07:16 +00004154
4155 if (FE->getOperator() == BO_PtrMemD)
4156 Out << "ds";
4157 else
4158 mangleOperatorName(
4159 BinaryOperator::getOverloadedOperator(FE->getOperator()),
4160 /*Arity=*/2);
4161
4162 if (FE->getLHS())
4163 mangleExpression(FE->getLHS());
4164 if (FE->getRHS())
4165 mangleExpression(FE->getRHS());
4166 break;
4167 }
4168
Guy Benyei11169dd2012-12-18 14:30:41 +00004169 case Expr::CXXThisExprClass:
4170 Out << "fpT";
4171 break;
Richard Smith9f690bd2015-10-27 06:02:45 +00004172
4173 case Expr::CoawaitExprClass:
4174 // FIXME: Propose a non-vendor mangling.
4175 Out << "v18co_await";
4176 mangleExpression(cast<CoawaitExpr>(E)->getOperand());
4177 break;
4178
Eric Fiselier20f25cb2017-03-06 23:38:15 +00004179 case Expr::DependentCoawaitExprClass:
4180 // FIXME: Propose a non-vendor mangling.
4181 Out << "v18co_await";
4182 mangleExpression(cast<DependentCoawaitExpr>(E)->getOperand());
4183 break;
4184
Richard Smith9f690bd2015-10-27 06:02:45 +00004185 case Expr::CoyieldExprClass:
4186 // FIXME: Propose a non-vendor mangling.
4187 Out << "v18co_yield";
4188 mangleExpression(cast<CoawaitExpr>(E)->getOperand());
4189 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00004190 }
4191}
4192
4193/// Mangle an expression which refers to a parameter variable.
4194///
4195/// <expression> ::= <function-param>
4196/// <function-param> ::= fp <top-level CV-qualifiers> _ # L == 0, I == 0
4197/// <function-param> ::= fp <top-level CV-qualifiers>
4198/// <parameter-2 non-negative number> _ # L == 0, I > 0
4199/// <function-param> ::= fL <L-1 non-negative number>
4200/// p <top-level CV-qualifiers> _ # L > 0, I == 0
4201/// <function-param> ::= fL <L-1 non-negative number>
4202/// p <top-level CV-qualifiers>
4203/// <I-1 non-negative number> _ # L > 0, I > 0
4204///
4205/// L is the nesting depth of the parameter, defined as 1 if the
4206/// parameter comes from the innermost function prototype scope
4207/// enclosing the current context, 2 if from the next enclosing
4208/// function prototype scope, and so on, with one special case: if
4209/// we've processed the full parameter clause for the innermost
4210/// function type, then L is one less. This definition conveniently
4211/// makes it irrelevant whether a function's result type was written
4212/// trailing or leading, but is otherwise overly complicated; the
4213/// numbering was first designed without considering references to
4214/// parameter in locations other than return types, and then the
4215/// mangling had to be generalized without changing the existing
4216/// manglings.
4217///
4218/// I is the zero-based index of the parameter within its parameter
4219/// declaration clause. Note that the original ABI document describes
4220/// this using 1-based ordinals.
4221void CXXNameMangler::mangleFunctionParam(const ParmVarDecl *parm) {
4222 unsigned parmDepth = parm->getFunctionScopeDepth();
4223 unsigned parmIndex = parm->getFunctionScopeIndex();
4224
4225 // Compute 'L'.
4226 // parmDepth does not include the declaring function prototype.
4227 // FunctionTypeDepth does account for that.
4228 assert(parmDepth < FunctionTypeDepth.getDepth());
4229 unsigned nestingDepth = FunctionTypeDepth.getDepth() - parmDepth;
4230 if (FunctionTypeDepth.isInResultType())
4231 nestingDepth--;
4232
4233 if (nestingDepth == 0) {
4234 Out << "fp";
4235 } else {
4236 Out << "fL" << (nestingDepth - 1) << 'p';
4237 }
4238
4239 // Top-level qualifiers. We don't have to worry about arrays here,
4240 // because parameters declared as arrays should already have been
4241 // transformed to have pointer type. FIXME: apparently these don't
4242 // get mangled if used as an rvalue of a known non-class type?
4243 assert(!parm->getType()->isArrayType()
4244 && "parameter's type is still an array type?");
Andrew Gozillon572bbb02017-10-02 06:25:51 +00004245
4246 if (const DependentAddressSpaceType *DAST =
4247 dyn_cast<DependentAddressSpaceType>(parm->getType())) {
4248 mangleQualifiers(DAST->getPointeeType().getQualifiers(), DAST);
4249 } else {
4250 mangleQualifiers(parm->getType().getQualifiers());
4251 }
Guy Benyei11169dd2012-12-18 14:30:41 +00004252
4253 // Parameter index.
4254 if (parmIndex != 0) {
4255 Out << (parmIndex - 1);
4256 }
4257 Out << '_';
4258}
4259
Richard Smith5179eb72016-06-28 19:03:57 +00004260void CXXNameMangler::mangleCXXCtorType(CXXCtorType T,
4261 const CXXRecordDecl *InheritedFrom) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004262 // <ctor-dtor-name> ::= C1 # complete object constructor
4263 // ::= C2 # base object constructor
Richard Smith5179eb72016-06-28 19:03:57 +00004264 // ::= CI1 <type> # complete inheriting constructor
4265 // ::= CI2 <type> # base inheriting constructor
Guy Benyei11169dd2012-12-18 14:30:41 +00004266 //
Rafael Espindola1e4df922014-09-16 15:18:21 +00004267 // In addition, C5 is a comdat name with C1 and C2 in it.
Richard Smith5179eb72016-06-28 19:03:57 +00004268 Out << 'C';
4269 if (InheritedFrom)
4270 Out << 'I';
Guy Benyei11169dd2012-12-18 14:30:41 +00004271 switch (T) {
4272 case Ctor_Complete:
Richard Smith5179eb72016-06-28 19:03:57 +00004273 Out << '1';
Guy Benyei11169dd2012-12-18 14:30:41 +00004274 break;
4275 case Ctor_Base:
Richard Smith5179eb72016-06-28 19:03:57 +00004276 Out << '2';
Guy Benyei11169dd2012-12-18 14:30:41 +00004277 break;
Rafael Espindola1e4df922014-09-16 15:18:21 +00004278 case Ctor_Comdat:
Richard Smith5179eb72016-06-28 19:03:57 +00004279 Out << '5';
Guy Benyei11169dd2012-12-18 14:30:41 +00004280 break;
David Majnemerdfa6d202015-03-11 18:36:39 +00004281 case Ctor_DefaultClosure:
4282 case Ctor_CopyingClosure:
4283 llvm_unreachable("closure constructors don't exist for the Itanium ABI!");
Guy Benyei11169dd2012-12-18 14:30:41 +00004284 }
Richard Smith5179eb72016-06-28 19:03:57 +00004285 if (InheritedFrom)
4286 mangleName(InheritedFrom);
Guy Benyei11169dd2012-12-18 14:30:41 +00004287}
4288
4289void CXXNameMangler::mangleCXXDtorType(CXXDtorType T) {
4290 // <ctor-dtor-name> ::= D0 # deleting destructor
4291 // ::= D1 # complete object destructor
4292 // ::= D2 # base object destructor
4293 //
Rafael Espindola1e4df922014-09-16 15:18:21 +00004294 // In addition, D5 is a comdat name with D1, D2 and, if virtual, D0 in it.
Guy Benyei11169dd2012-12-18 14:30:41 +00004295 switch (T) {
4296 case Dtor_Deleting:
4297 Out << "D0";
4298 break;
4299 case Dtor_Complete:
4300 Out << "D1";
4301 break;
4302 case Dtor_Base:
4303 Out << "D2";
4304 break;
Rafael Espindola1e4df922014-09-16 15:18:21 +00004305 case Dtor_Comdat:
4306 Out << "D5";
4307 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00004308 }
4309}
4310
James Y Knight04ec5bf2015-12-24 02:59:37 +00004311void CXXNameMangler::mangleTemplateArgs(const TemplateArgumentLoc *TemplateArgs,
4312 unsigned NumTemplateArgs) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004313 // <template-args> ::= I <template-arg>+ E
4314 Out << 'I';
James Y Knight04ec5bf2015-12-24 02:59:37 +00004315 for (unsigned i = 0; i != NumTemplateArgs; ++i)
4316 mangleTemplateArg(TemplateArgs[i].getArgument());
Guy Benyei11169dd2012-12-18 14:30:41 +00004317 Out << 'E';
4318}
4319
4320void CXXNameMangler::mangleTemplateArgs(const TemplateArgumentList &AL) {
4321 // <template-args> ::= I <template-arg>+ E
4322 Out << 'I';
4323 for (unsigned i = 0, e = AL.size(); i != e; ++i)
4324 mangleTemplateArg(AL[i]);
4325 Out << 'E';
4326}
4327
4328void CXXNameMangler::mangleTemplateArgs(const TemplateArgument *TemplateArgs,
4329 unsigned NumTemplateArgs) {
4330 // <template-args> ::= I <template-arg>+ E
4331 Out << 'I';
4332 for (unsigned i = 0; i != NumTemplateArgs; ++i)
4333 mangleTemplateArg(TemplateArgs[i]);
4334 Out << 'E';
4335}
4336
4337void CXXNameMangler::mangleTemplateArg(TemplateArgument A) {
4338 // <template-arg> ::= <type> # type or template
4339 // ::= X <expression> E # expression
4340 // ::= <expr-primary> # simple expressions
4341 // ::= J <template-arg>* E # argument pack
Guy Benyei11169dd2012-12-18 14:30:41 +00004342 if (!A.isInstantiationDependent() || A.isDependent())
4343 A = Context.getASTContext().getCanonicalTemplateArgument(A);
4344
4345 switch (A.getKind()) {
4346 case TemplateArgument::Null:
4347 llvm_unreachable("Cannot mangle NULL template argument");
4348
4349 case TemplateArgument::Type:
4350 mangleType(A.getAsType());
4351 break;
4352 case TemplateArgument::Template:
4353 // This is mangled as <type>.
4354 mangleType(A.getAsTemplate());
4355 break;
4356 case TemplateArgument::TemplateExpansion:
4357 // <type> ::= Dp <type> # pack expansion (C++0x)
4358 Out << "Dp";
4359 mangleType(A.getAsTemplateOrTemplatePattern());
4360 break;
4361 case TemplateArgument::Expression: {
4362 // It's possible to end up with a DeclRefExpr here in certain
4363 // dependent cases, in which case we should mangle as a
4364 // declaration.
4365 const Expr *E = A.getAsExpr()->IgnoreParens();
4366 if (const DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(E)) {
4367 const ValueDecl *D = DRE->getDecl();
4368 if (isa<VarDecl>(D) || isa<FunctionDecl>(D)) {
David Majnemera16d4702015-02-18 19:08:14 +00004369 Out << 'L';
David Majnemer7ff7eb72015-02-18 07:47:09 +00004370 mangle(D);
Guy Benyei11169dd2012-12-18 14:30:41 +00004371 Out << 'E';
4372 break;
4373 }
4374 }
4375
4376 Out << 'X';
4377 mangleExpression(E);
4378 Out << 'E';
4379 break;
4380 }
4381 case TemplateArgument::Integral:
4382 mangleIntegerLiteral(A.getIntegralType(), A.getAsIntegral());
4383 break;
4384 case TemplateArgument::Declaration: {
4385 // <expr-primary> ::= L <mangled-name> E # external name
4386 // Clang produces AST's where pointer-to-member-function expressions
4387 // and pointer-to-function expressions are represented as a declaration not
4388 // an expression. We compensate for it here to produce the correct mangling.
4389 ValueDecl *D = A.getAsDecl();
David Blaikie952a9b12014-10-17 18:00:12 +00004390 bool compensateMangling = !A.getParamTypeForDecl()->isReferenceType();
Guy Benyei11169dd2012-12-18 14:30:41 +00004391 if (compensateMangling) {
4392 Out << 'X';
4393 mangleOperatorName(OO_Amp, 1);
4394 }
4395
4396 Out << 'L';
4397 // References to external entities use the mangled name; if the name would
Nico Weberfb420782016-05-25 14:15:08 +00004398 // not normally be mangled then mangle it as unqualified.
David Majnemer7ff7eb72015-02-18 07:47:09 +00004399 mangle(D);
Guy Benyei11169dd2012-12-18 14:30:41 +00004400 Out << 'E';
4401
4402 if (compensateMangling)
4403 Out << 'E';
4404
4405 break;
4406 }
4407 case TemplateArgument::NullPtr: {
4408 // <expr-primary> ::= L <type> 0 E
4409 Out << 'L';
4410 mangleType(A.getNullPtrType());
4411 Out << "0E";
4412 break;
4413 }
4414 case TemplateArgument::Pack: {
Richard Smitheb0133c2013-08-27 01:03:46 +00004415 // <template-arg> ::= J <template-arg>* E
Guy Benyei11169dd2012-12-18 14:30:41 +00004416 Out << 'J';
Aaron Ballman2a89e852014-07-15 21:32:31 +00004417 for (const auto &P : A.pack_elements())
4418 mangleTemplateArg(P);
Guy Benyei11169dd2012-12-18 14:30:41 +00004419 Out << 'E';
4420 }
4421 }
4422}
4423
4424void CXXNameMangler::mangleTemplateParameter(unsigned Index) {
4425 // <template-param> ::= T_ # first template parameter
4426 // ::= T <parameter-2 non-negative number> _
4427 if (Index == 0)
4428 Out << "T_";
4429 else
4430 Out << 'T' << (Index - 1) << '_';
4431}
4432
David Majnemer3b3bdb52014-05-06 22:49:16 +00004433void CXXNameMangler::mangleSeqID(unsigned SeqID) {
4434 if (SeqID == 1)
4435 Out << '0';
4436 else if (SeqID > 1) {
4437 SeqID--;
4438
4439 // <seq-id> is encoded in base-36, using digits and upper case letters.
4440 char Buffer[7]; // log(2**32) / log(36) ~= 7
Craig Toppere3d2ecbe2014-06-28 23:22:33 +00004441 MutableArrayRef<char> BufferRef(Buffer);
4442 MutableArrayRef<char>::reverse_iterator I = BufferRef.rbegin();
David Majnemer3b3bdb52014-05-06 22:49:16 +00004443
4444 for (; SeqID != 0; SeqID /= 36) {
4445 unsigned C = SeqID % 36;
4446 *I++ = (C < 10 ? '0' + C : 'A' + C - 10);
4447 }
4448
4449 Out.write(I.base(), I - BufferRef.rbegin());
4450 }
4451 Out << '_';
4452}
4453
Guy Benyei11169dd2012-12-18 14:30:41 +00004454void CXXNameMangler::mangleExistingSubstitution(TemplateName tname) {
4455 bool result = mangleSubstitution(tname);
4456 assert(result && "no existing substitution for template name");
4457 (void) result;
4458}
4459
4460// <substitution> ::= S <seq-id> _
4461// ::= S_
4462bool CXXNameMangler::mangleSubstitution(const NamedDecl *ND) {
4463 // Try one of the standard substitutions first.
4464 if (mangleStandardSubstitution(ND))
4465 return true;
4466
4467 ND = cast<NamedDecl>(ND->getCanonicalDecl());
4468 return mangleSubstitution(reinterpret_cast<uintptr_t>(ND));
4469}
4470
Justin Bognere8d762e2015-05-22 06:48:13 +00004471/// Determine whether the given type has any qualifiers that are relevant for
4472/// substitutions.
Guy Benyei11169dd2012-12-18 14:30:41 +00004473static bool hasMangledSubstitutionQualifiers(QualType T) {
4474 Qualifiers Qs = T.getQualifiers();
Roger Ferrer Ibanezfd9384a2017-06-02 07:14:34 +00004475 return Qs.getCVRQualifiers() || Qs.hasAddressSpace() || Qs.hasUnaligned();
Guy Benyei11169dd2012-12-18 14:30:41 +00004476}
4477
4478bool CXXNameMangler::mangleSubstitution(QualType T) {
4479 if (!hasMangledSubstitutionQualifiers(T)) {
4480 if (const RecordType *RT = T->getAs<RecordType>())
4481 return mangleSubstitution(RT->getDecl());
4482 }
4483
4484 uintptr_t TypePtr = reinterpret_cast<uintptr_t>(T.getAsOpaquePtr());
4485
4486 return mangleSubstitution(TypePtr);
4487}
4488
4489bool CXXNameMangler::mangleSubstitution(TemplateName Template) {
4490 if (TemplateDecl *TD = Template.getAsTemplateDecl())
4491 return mangleSubstitution(TD);
4492
4493 Template = Context.getASTContext().getCanonicalTemplateName(Template);
4494 return mangleSubstitution(
4495 reinterpret_cast<uintptr_t>(Template.getAsVoidPointer()));
4496}
4497
4498bool CXXNameMangler::mangleSubstitution(uintptr_t Ptr) {
4499 llvm::DenseMap<uintptr_t, unsigned>::iterator I = Substitutions.find(Ptr);
4500 if (I == Substitutions.end())
4501 return false;
4502
4503 unsigned SeqID = I->second;
David Majnemer3b3bdb52014-05-06 22:49:16 +00004504 Out << 'S';
4505 mangleSeqID(SeqID);
Guy Benyei11169dd2012-12-18 14:30:41 +00004506
4507 return true;
4508}
4509
4510static bool isCharType(QualType T) {
4511 if (T.isNull())
4512 return false;
4513
4514 return T->isSpecificBuiltinType(BuiltinType::Char_S) ||
4515 T->isSpecificBuiltinType(BuiltinType::Char_U);
4516}
4517
Justin Bognere8d762e2015-05-22 06:48:13 +00004518/// Returns whether a given type is a template specialization of a given name
4519/// with a single argument of type char.
Guy Benyei11169dd2012-12-18 14:30:41 +00004520static bool isCharSpecialization(QualType T, const char *Name) {
4521 if (T.isNull())
4522 return false;
4523
4524 const RecordType *RT = T->getAs<RecordType>();
4525 if (!RT)
4526 return false;
4527
4528 const ClassTemplateSpecializationDecl *SD =
4529 dyn_cast<ClassTemplateSpecializationDecl>(RT->getDecl());
4530 if (!SD)
4531 return false;
4532
4533 if (!isStdNamespace(getEffectiveDeclContext(SD)))
4534 return false;
4535
4536 const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
4537 if (TemplateArgs.size() != 1)
4538 return false;
4539
4540 if (!isCharType(TemplateArgs[0].getAsType()))
4541 return false;
4542
4543 return SD->getIdentifier()->getName() == Name;
4544}
4545
4546template <std::size_t StrLen>
4547static bool isStreamCharSpecialization(const ClassTemplateSpecializationDecl*SD,
4548 const char (&Str)[StrLen]) {
4549 if (!SD->getIdentifier()->isStr(Str))
4550 return false;
4551
4552 const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
4553 if (TemplateArgs.size() != 2)
4554 return false;
4555
4556 if (!isCharType(TemplateArgs[0].getAsType()))
4557 return false;
4558
4559 if (!isCharSpecialization(TemplateArgs[1].getAsType(), "char_traits"))
4560 return false;
4561
4562 return true;
4563}
4564
4565bool CXXNameMangler::mangleStandardSubstitution(const NamedDecl *ND) {
4566 // <substitution> ::= St # ::std::
4567 if (const NamespaceDecl *NS = dyn_cast<NamespaceDecl>(ND)) {
4568 if (isStd(NS)) {
4569 Out << "St";
4570 return true;
4571 }
4572 }
4573
4574 if (const ClassTemplateDecl *TD = dyn_cast<ClassTemplateDecl>(ND)) {
4575 if (!isStdNamespace(getEffectiveDeclContext(TD)))
4576 return false;
4577
4578 // <substitution> ::= Sa # ::std::allocator
4579 if (TD->getIdentifier()->isStr("allocator")) {
4580 Out << "Sa";
4581 return true;
4582 }
4583
4584 // <<substitution> ::= Sb # ::std::basic_string
4585 if (TD->getIdentifier()->isStr("basic_string")) {
4586 Out << "Sb";
4587 return true;
4588 }
4589 }
4590
4591 if (const ClassTemplateSpecializationDecl *SD =
4592 dyn_cast<ClassTemplateSpecializationDecl>(ND)) {
4593 if (!isStdNamespace(getEffectiveDeclContext(SD)))
4594 return false;
4595
4596 // <substitution> ::= Ss # ::std::basic_string<char,
4597 // ::std::char_traits<char>,
4598 // ::std::allocator<char> >
4599 if (SD->getIdentifier()->isStr("basic_string")) {
4600 const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
4601
4602 if (TemplateArgs.size() != 3)
4603 return false;
4604
4605 if (!isCharType(TemplateArgs[0].getAsType()))
4606 return false;
4607
4608 if (!isCharSpecialization(TemplateArgs[1].getAsType(), "char_traits"))
4609 return false;
4610
4611 if (!isCharSpecialization(TemplateArgs[2].getAsType(), "allocator"))
4612 return false;
4613
4614 Out << "Ss";
4615 return true;
4616 }
4617
4618 // <substitution> ::= Si # ::std::basic_istream<char,
4619 // ::std::char_traits<char> >
4620 if (isStreamCharSpecialization(SD, "basic_istream")) {
4621 Out << "Si";
4622 return true;
4623 }
4624
4625 // <substitution> ::= So # ::std::basic_ostream<char,
4626 // ::std::char_traits<char> >
4627 if (isStreamCharSpecialization(SD, "basic_ostream")) {
4628 Out << "So";
4629 return true;
4630 }
4631
4632 // <substitution> ::= Sd # ::std::basic_iostream<char,
4633 // ::std::char_traits<char> >
4634 if (isStreamCharSpecialization(SD, "basic_iostream")) {
4635 Out << "Sd";
4636 return true;
4637 }
4638 }
4639 return false;
4640}
4641
4642void CXXNameMangler::addSubstitution(QualType T) {
4643 if (!hasMangledSubstitutionQualifiers(T)) {
4644 if (const RecordType *RT = T->getAs<RecordType>()) {
4645 addSubstitution(RT->getDecl());
4646 return;
4647 }
4648 }
4649
4650 uintptr_t TypePtr = reinterpret_cast<uintptr_t>(T.getAsOpaquePtr());
4651 addSubstitution(TypePtr);
4652}
4653
4654void CXXNameMangler::addSubstitution(TemplateName Template) {
4655 if (TemplateDecl *TD = Template.getAsTemplateDecl())
4656 return addSubstitution(TD);
4657
4658 Template = Context.getASTContext().getCanonicalTemplateName(Template);
4659 addSubstitution(reinterpret_cast<uintptr_t>(Template.getAsVoidPointer()));
4660}
4661
4662void CXXNameMangler::addSubstitution(uintptr_t Ptr) {
4663 assert(!Substitutions.count(Ptr) && "Substitution already exists!");
4664 Substitutions[Ptr] = SeqID++;
4665}
4666
Dmitry Polukhinfda467b2016-09-21 08:27:03 +00004667void CXXNameMangler::extendSubstitutions(CXXNameMangler* Other) {
4668 assert(Other->SeqID >= SeqID && "Must be superset of substitutions!");
4669 if (Other->SeqID > SeqID) {
4670 Substitutions.swap(Other->Substitutions);
4671 SeqID = Other->SeqID;
4672 }
4673}
4674
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00004675CXXNameMangler::AbiTagList
4676CXXNameMangler::makeFunctionReturnTypeTags(const FunctionDecl *FD) {
4677 // When derived abi tags are disabled there is no need to make any list.
4678 if (DisableDerivedAbiTags)
4679 return AbiTagList();
4680
4681 llvm::raw_null_ostream NullOutStream;
4682 CXXNameMangler TrackReturnTypeTags(*this, NullOutStream);
4683 TrackReturnTypeTags.disableDerivedAbiTags();
4684
4685 const FunctionProtoType *Proto =
4686 cast<FunctionProtoType>(FD->getType()->getAs<FunctionType>());
Dmitry Polukhind4b3bbc2017-06-14 09:47:47 +00004687 FunctionTypeDepthState saved = TrackReturnTypeTags.FunctionTypeDepth.push();
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00004688 TrackReturnTypeTags.FunctionTypeDepth.enterResultType();
4689 TrackReturnTypeTags.mangleType(Proto->getReturnType());
4690 TrackReturnTypeTags.FunctionTypeDepth.leaveResultType();
Dmitry Polukhind4b3bbc2017-06-14 09:47:47 +00004691 TrackReturnTypeTags.FunctionTypeDepth.pop(saved);
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00004692
4693 return TrackReturnTypeTags.AbiTagsRoot.getSortedUniqueUsedAbiTags();
4694}
4695
4696CXXNameMangler::AbiTagList
4697CXXNameMangler::makeVariableTypeTags(const VarDecl *VD) {
4698 // When derived abi tags are disabled there is no need to make any list.
4699 if (DisableDerivedAbiTags)
4700 return AbiTagList();
4701
4702 llvm::raw_null_ostream NullOutStream;
4703 CXXNameMangler TrackVariableType(*this, NullOutStream);
4704 TrackVariableType.disableDerivedAbiTags();
4705
4706 TrackVariableType.mangleType(VD->getType());
4707
4708 return TrackVariableType.AbiTagsRoot.getSortedUniqueUsedAbiTags();
4709}
4710
4711bool CXXNameMangler::shouldHaveAbiTags(ItaniumMangleContextImpl &C,
4712 const VarDecl *VD) {
4713 llvm::raw_null_ostream NullOutStream;
4714 CXXNameMangler TrackAbiTags(C, NullOutStream, nullptr, true);
4715 TrackAbiTags.mangle(VD);
4716 return TrackAbiTags.AbiTagsRoot.getUsedAbiTags().size();
4717}
4718
Guy Benyei11169dd2012-12-18 14:30:41 +00004719//
4720
Justin Bognere8d762e2015-05-22 06:48:13 +00004721/// Mangles the name of the declaration D and emits that name to the given
4722/// output stream.
Guy Benyei11169dd2012-12-18 14:30:41 +00004723///
4724/// If the declaration D requires a mangled name, this routine will emit that
4725/// mangled name to \p os and return true. Otherwise, \p os will be unchanged
4726/// and this routine will return false. In this case, the caller should just
4727/// emit the identifier of the declaration (\c D->getIdentifier()) as its
4728/// name.
Rafael Espindola002667c2013-10-16 01:40:34 +00004729void ItaniumMangleContextImpl::mangleCXXName(const NamedDecl *D,
4730 raw_ostream &Out) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004731 assert((isa<FunctionDecl>(D) || isa<VarDecl>(D)) &&
4732 "Invalid mangleName() call, argument is not a variable or function!");
4733 assert(!isa<CXXConstructorDecl>(D) && !isa<CXXDestructorDecl>(D) &&
4734 "Invalid mangleName() call on 'structor decl!");
4735
4736 PrettyStackTraceDecl CrashInfo(D, SourceLocation(),
4737 getASTContext().getSourceManager(),
4738 "Mangling declaration");
4739
4740 CXXNameMangler Mangler(*this, Out, D);
Evgeny Astigeevich665027d2014-12-12 16:17:46 +00004741 Mangler.mangle(D);
Guy Benyei11169dd2012-12-18 14:30:41 +00004742}
4743
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00004744void ItaniumMangleContextImpl::mangleCXXCtor(const CXXConstructorDecl *D,
4745 CXXCtorType Type,
4746 raw_ostream &Out) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004747 CXXNameMangler Mangler(*this, Out, D, Type);
4748 Mangler.mangle(D);
4749}
4750
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00004751void ItaniumMangleContextImpl::mangleCXXDtor(const CXXDestructorDecl *D,
4752 CXXDtorType Type,
4753 raw_ostream &Out) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004754 CXXNameMangler Mangler(*this, Out, D, Type);
4755 Mangler.mangle(D);
4756}
4757
Rafael Espindola1e4df922014-09-16 15:18:21 +00004758void ItaniumMangleContextImpl::mangleCXXCtorComdat(const CXXConstructorDecl *D,
4759 raw_ostream &Out) {
4760 CXXNameMangler Mangler(*this, Out, D, Ctor_Comdat);
4761 Mangler.mangle(D);
4762}
4763
4764void ItaniumMangleContextImpl::mangleCXXDtorComdat(const CXXDestructorDecl *D,
4765 raw_ostream &Out) {
4766 CXXNameMangler Mangler(*this, Out, D, Dtor_Comdat);
4767 Mangler.mangle(D);
4768}
4769
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00004770void ItaniumMangleContextImpl::mangleThunk(const CXXMethodDecl *MD,
4771 const ThunkInfo &Thunk,
4772 raw_ostream &Out) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004773 // <special-name> ::= T <call-offset> <base encoding>
4774 // # base is the nominal target function of thunk
4775 // <special-name> ::= Tc <call-offset> <call-offset> <base encoding>
4776 // # base is the nominal target function of thunk
4777 // # first call-offset is 'this' adjustment
4778 // # second call-offset is result adjustment
4779
4780 assert(!isa<CXXDestructorDecl>(MD) &&
4781 "Use mangleCXXDtor for destructor decls!");
4782 CXXNameMangler Mangler(*this, Out);
4783 Mangler.getStream() << "_ZT";
4784 if (!Thunk.Return.isEmpty())
4785 Mangler.getStream() << 'c';
4786
4787 // Mangle the 'this' pointer adjustment.
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00004788 Mangler.mangleCallOffset(Thunk.This.NonVirtual,
4789 Thunk.This.Virtual.Itanium.VCallOffsetOffset);
4790
Guy Benyei11169dd2012-12-18 14:30:41 +00004791 // Mangle the return pointer adjustment if there is one.
4792 if (!Thunk.Return.isEmpty())
4793 Mangler.mangleCallOffset(Thunk.Return.NonVirtual,
Timur Iskhodzhanov02014322013-10-30 11:55:43 +00004794 Thunk.Return.Virtual.Itanium.VBaseOffsetOffset);
4795
Guy Benyei11169dd2012-12-18 14:30:41 +00004796 Mangler.mangleFunctionEncoding(MD);
4797}
4798
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00004799void ItaniumMangleContextImpl::mangleCXXDtorThunk(
4800 const CXXDestructorDecl *DD, CXXDtorType Type,
4801 const ThisAdjustment &ThisAdjustment, raw_ostream &Out) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004802 // <special-name> ::= T <call-offset> <base encoding>
4803 // # base is the nominal target function of thunk
4804 CXXNameMangler Mangler(*this, Out, DD, Type);
4805 Mangler.getStream() << "_ZT";
4806
4807 // Mangle the 'this' pointer adjustment.
4808 Mangler.mangleCallOffset(ThisAdjustment.NonVirtual,
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00004809 ThisAdjustment.Virtual.Itanium.VCallOffsetOffset);
Guy Benyei11169dd2012-12-18 14:30:41 +00004810
4811 Mangler.mangleFunctionEncoding(DD);
4812}
4813
Justin Bognere8d762e2015-05-22 06:48:13 +00004814/// Returns the mangled name for a guard variable for the passed in VarDecl.
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00004815void ItaniumMangleContextImpl::mangleStaticGuardVariable(const VarDecl *D,
4816 raw_ostream &Out) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004817 // <special-name> ::= GV <object name> # Guard variable for one-time
4818 // # initialization
4819 CXXNameMangler Mangler(*this, Out);
Dmitry Polukhin90bb49e2016-06-30 09:40:38 +00004820 // GCC 5.3.0 doesn't emit derived ABI tags for local names but that seems to
4821 // be a bug that is fixed in trunk.
Guy Benyei11169dd2012-12-18 14:30:41 +00004822 Mangler.getStream() << "_ZGV";
4823 Mangler.mangleName(D);
4824}
4825
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00004826void ItaniumMangleContextImpl::mangleDynamicInitializer(const VarDecl *MD,
4827 raw_ostream &Out) {
Reid Kleckner1ece9fc2013-09-10 20:43:12 +00004828 // These symbols are internal in the Itanium ABI, so the names don't matter.
4829 // Clang has traditionally used this symbol and allowed LLVM to adjust it to
4830 // avoid duplicate symbols.
4831 Out << "__cxx_global_var_init";
4832}
4833
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00004834void ItaniumMangleContextImpl::mangleDynamicAtExitDestructor(const VarDecl *D,
4835 raw_ostream &Out) {
Reid Klecknerd8110b62013-09-10 20:14:30 +00004836 // Prefix the mangling of D with __dtor_.
4837 CXXNameMangler Mangler(*this, Out);
4838 Mangler.getStream() << "__dtor_";
4839 if (shouldMangleDeclName(D))
4840 Mangler.mangle(D);
4841 else
4842 Mangler.getStream() << D->getName();
4843}
4844
Reid Kleckner1d59f992015-01-22 01:36:17 +00004845void ItaniumMangleContextImpl::mangleSEHFilterExpression(
4846 const NamedDecl *EnclosingDecl, raw_ostream &Out) {
4847 CXXNameMangler Mangler(*this, Out);
4848 Mangler.getStream() << "__filt_";
4849 if (shouldMangleDeclName(EnclosingDecl))
4850 Mangler.mangle(EnclosingDecl);
4851 else
4852 Mangler.getStream() << EnclosingDecl->getName();
4853}
4854
Reid Klecknerebaf28d2015-04-14 20:59:00 +00004855void ItaniumMangleContextImpl::mangleSEHFinallyBlock(
4856 const NamedDecl *EnclosingDecl, raw_ostream &Out) {
4857 CXXNameMangler Mangler(*this, Out);
4858 Mangler.getStream() << "__fin_";
4859 if (shouldMangleDeclName(EnclosingDecl))
4860 Mangler.mangle(EnclosingDecl);
4861 else
4862 Mangler.getStream() << EnclosingDecl->getName();
4863}
4864
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00004865void ItaniumMangleContextImpl::mangleItaniumThreadLocalInit(const VarDecl *D,
4866 raw_ostream &Out) {
Richard Smith2fd1d7a2013-04-19 16:42:07 +00004867 // <special-name> ::= TH <object name>
4868 CXXNameMangler Mangler(*this, Out);
4869 Mangler.getStream() << "_ZTH";
4870 Mangler.mangleName(D);
4871}
4872
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00004873void
4874ItaniumMangleContextImpl::mangleItaniumThreadLocalWrapper(const VarDecl *D,
4875 raw_ostream &Out) {
Richard Smith2fd1d7a2013-04-19 16:42:07 +00004876 // <special-name> ::= TW <object name>
4877 CXXNameMangler Mangler(*this, Out);
4878 Mangler.getStream() << "_ZTW";
4879 Mangler.mangleName(D);
4880}
4881
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00004882void ItaniumMangleContextImpl::mangleReferenceTemporary(const VarDecl *D,
David Majnemerdaff3702014-05-01 17:50:17 +00004883 unsigned ManglingNumber,
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00004884 raw_ostream &Out) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004885 // We match the GCC mangling here.
4886 // <special-name> ::= GR <object name>
4887 CXXNameMangler Mangler(*this, Out);
4888 Mangler.getStream() << "_ZGR";
4889 Mangler.mangleName(D);
David Majnemerdaff3702014-05-01 17:50:17 +00004890 assert(ManglingNumber > 0 && "Reference temporary mangling number is zero!");
David Majnemer3b3bdb52014-05-06 22:49:16 +00004891 Mangler.mangleSeqID(ManglingNumber - 1);
Guy Benyei11169dd2012-12-18 14:30:41 +00004892}
4893
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00004894void ItaniumMangleContextImpl::mangleCXXVTable(const CXXRecordDecl *RD,
4895 raw_ostream &Out) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004896 // <special-name> ::= TV <type> # virtual table
4897 CXXNameMangler Mangler(*this, Out);
4898 Mangler.getStream() << "_ZTV";
4899 Mangler.mangleNameOrStandardSubstitution(RD);
4900}
4901
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00004902void ItaniumMangleContextImpl::mangleCXXVTT(const CXXRecordDecl *RD,
4903 raw_ostream &Out) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004904 // <special-name> ::= TT <type> # VTT structure
4905 CXXNameMangler Mangler(*this, Out);
4906 Mangler.getStream() << "_ZTT";
4907 Mangler.mangleNameOrStandardSubstitution(RD);
4908}
4909
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00004910void ItaniumMangleContextImpl::mangleCXXCtorVTable(const CXXRecordDecl *RD,
4911 int64_t Offset,
4912 const CXXRecordDecl *Type,
4913 raw_ostream &Out) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004914 // <special-name> ::= TC <type> <offset number> _ <base type>
4915 CXXNameMangler Mangler(*this, Out);
4916 Mangler.getStream() << "_ZTC";
4917 Mangler.mangleNameOrStandardSubstitution(RD);
4918 Mangler.getStream() << Offset;
4919 Mangler.getStream() << '_';
4920 Mangler.mangleNameOrStandardSubstitution(Type);
4921}
4922
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00004923void ItaniumMangleContextImpl::mangleCXXRTTI(QualType Ty, raw_ostream &Out) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004924 // <special-name> ::= TI <type> # typeinfo structure
4925 assert(!Ty.hasQualifiers() && "RTTI info cannot have top-level qualifiers");
4926 CXXNameMangler Mangler(*this, Out);
4927 Mangler.getStream() << "_ZTI";
4928 Mangler.mangleType(Ty);
4929}
4930
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00004931void ItaniumMangleContextImpl::mangleCXXRTTIName(QualType Ty,
4932 raw_ostream &Out) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004933 // <special-name> ::= TS <type> # typeinfo name (null terminated byte string)
4934 CXXNameMangler Mangler(*this, Out);
4935 Mangler.getStream() << "_ZTS";
4936 Mangler.mangleType(Ty);
4937}
4938
Reid Klecknercc99e262013-11-19 23:23:00 +00004939void ItaniumMangleContextImpl::mangleTypeName(QualType Ty, raw_ostream &Out) {
4940 mangleCXXRTTIName(Ty, Out);
4941}
4942
David Majnemer58e5bee2014-03-24 21:43:36 +00004943void ItaniumMangleContextImpl::mangleStringLiteral(const StringLiteral *, raw_ostream &) {
4944 llvm_unreachable("Can't mangle string literals");
4945}
4946
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00004947ItaniumMangleContext *
4948ItaniumMangleContext::create(ASTContext &Context, DiagnosticsEngine &Diags) {
4949 return new ItaniumMangleContextImpl(Context, Diags);
Guy Benyei11169dd2012-12-18 14:30:41 +00004950}