1 //===--- ItaniumMangle.cpp - Itanium C++ Name Mangling ----------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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):
14 // http://mentorembedded.github.io/cxx-abi/abi.html#mangling
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"
23 #include "clang/AST/DeclOpenMP.h"
24 #include "clang/AST/DeclTemplate.h"
25 #include "clang/AST/Expr.h"
26 #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"
36 #define MANGLE_CHECKER 0
42 using namespace clang;
46 /// Retrieve the declaration context that should be used when mangling the given
48 static 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)) {
57 if (ParmVarDecl *ContextParam
58 = dyn_cast_or_null<ParmVarDecl>(RD->getLambdaContextDecl()))
59 return ContextParam->getDeclContext();
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();
69 const DeclContext *DC = D->getDeclContext();
70 if (isa<CapturedDecl>(DC) || isa<OMPDeclareReductionDecl>(DC)) {
71 return getEffectiveDeclContext(cast<Decl>(DC));
74 if (const auto *VD = dyn_cast<VarDecl>(D))
76 return VD->getASTContext().getTranslationUnitDecl();
78 if (const auto *FD = dyn_cast<FunctionDecl>(D))
80 return FD->getASTContext().getTranslationUnitDecl();
82 return DC->getRedeclContext();
85 static const DeclContext *getEffectiveParentContext(const DeclContext *DC) {
86 return getEffectiveDeclContext(cast<Decl>(DC));
89 static bool isLocalContainerContext(const DeclContext *DC) {
90 return isa<FunctionDecl>(DC) || isa<ObjCMethodDecl>(DC) || isa<BlockDecl>(DC);
93 static const RecordDecl *GetLocalClassDecl(const Decl *D) {
94 const DeclContext *DC = getEffectiveDeclContext(D);
95 while (!DC->isNamespace() && !DC->isTranslationUnit()) {
96 if (isLocalContainerContext(DC))
97 return dyn_cast<RecordDecl>(D);
99 DC = getEffectiveDeclContext(D);
104 static const FunctionDecl *getStructor(const FunctionDecl *fn) {
105 if (const FunctionTemplateDecl *ftd = fn->getPrimaryTemplate())
106 return ftd->getTemplatedDecl();
111 static const NamedDecl *getStructor(const NamedDecl *decl) {
112 const FunctionDecl *fn = dyn_cast_or_null<FunctionDecl>(decl);
113 return (fn ? getStructor(fn) : decl);
116 static bool isLambda(const NamedDecl *ND) {
117 const CXXRecordDecl *Record = dyn_cast<CXXRecordDecl>(ND);
121 return Record->isLambda();
124 static const unsigned UnknownArity = ~0U;
126 class ItaniumMangleContextImpl : public ItaniumMangleContext {
127 typedef std::pair<const DeclContext*, IdentifierInfo*> DiscriminatorKeyTy;
128 llvm::DenseMap<DiscriminatorKeyTy, unsigned> Discriminator;
129 llvm::DenseMap<const NamedDecl*, unsigned> Uniquifier;
132 explicit ItaniumMangleContextImpl(ASTContext &Context,
133 DiagnosticsEngine &Diags)
134 : ItaniumMangleContext(Context, Diags) {}
136 /// @name Mangler Entry Points
139 bool shouldMangleCXXName(const NamedDecl *D) override;
140 bool shouldMangleStringLiteral(const StringLiteral *) override {
143 void mangleCXXName(const NamedDecl *D, raw_ostream &) override;
144 void mangleThunk(const CXXMethodDecl *MD, const ThunkInfo &Thunk,
145 raw_ostream &) override;
146 void mangleCXXDtorThunk(const CXXDestructorDecl *DD, CXXDtorType Type,
147 const ThisAdjustment &ThisAdjustment,
148 raw_ostream &) override;
149 void mangleReferenceTemporary(const VarDecl *D, unsigned ManglingNumber,
150 raw_ostream &) override;
151 void mangleCXXVTable(const CXXRecordDecl *RD, raw_ostream &) override;
152 void mangleCXXVTT(const CXXRecordDecl *RD, raw_ostream &) override;
153 void mangleCXXCtorVTable(const CXXRecordDecl *RD, int64_t Offset,
154 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;
158 void mangleCXXCtor(const CXXConstructorDecl *D, CXXCtorType Type,
159 raw_ostream &) override;
160 void mangleCXXDtor(const CXXDestructorDecl *D, CXXDtorType Type,
161 raw_ostream &) override;
163 void mangleCXXCtorComdat(const CXXConstructorDecl *D, raw_ostream &) override;
164 void mangleCXXDtorComdat(const CXXDestructorDecl *D, raw_ostream &) override;
165 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;
169 void mangleSEHFilterExpression(const NamedDecl *EnclosingDecl,
170 raw_ostream &Out) override;
171 void mangleSEHFinallyBlock(const NamedDecl *EnclosingDecl,
172 raw_ostream &Out) override;
173 void mangleItaniumThreadLocalInit(const VarDecl *D, raw_ostream &) override;
174 void mangleItaniumThreadLocalWrapper(const VarDecl *D,
175 raw_ostream &) override;
177 void mangleStringLiteral(const StringLiteral *, raw_ostream &) override;
179 bool getNextDiscriminator(const NamedDecl *ND, unsigned &disc) {
180 // Lambda closure types are already numbered.
184 // Anonymous tags are already numbered.
185 if (const TagDecl *Tag = dyn_cast<TagDecl>(ND)) {
186 if (Tag->getName().empty() && !Tag->getTypedefNameForAnonDecl())
190 // Use the canonical number for externally visible decls.
191 if (ND->isExternallyVisible()) {
192 unsigned discriminator = getASTContext().getManglingNumber(ND);
193 if (discriminator == 1)
195 disc = discriminator - 2;
199 // Make up a reasonable number for internal decls.
200 unsigned &discriminator = Uniquifier[ND];
201 if (!discriminator) {
202 const DeclContext *DC = getEffectiveDeclContext(ND);
203 discriminator = ++Discriminator[std::make_pair(DC, ND->getIdentifier())];
205 if (discriminator == 1)
207 disc = discriminator-2;
213 /// Manage the mangling of a single name.
214 class CXXNameMangler {
215 ItaniumMangleContextImpl &Context;
217 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;
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;
230 /// The next substitution sequence number.
233 class FunctionTypeDepthState {
236 enum { InResultTypeMask = 1 };
239 FunctionTypeDepthState() : Bits(0) {}
241 /// The number of function types we're inside.
242 unsigned getDepth() const {
246 /// True if we're in the return type of the innermost function type.
247 bool isInResultType() const {
248 return Bits & InResultTypeMask;
251 FunctionTypeDepthState push() {
252 FunctionTypeDepthState tmp = *this;
253 Bits = (Bits & ~InResultTypeMask) + 2;
257 void enterResultType() {
258 Bits |= InResultTypeMask;
261 void leaveResultType() {
262 Bits &= ~InResultTypeMask;
265 void pop(FunctionTypeDepthState saved) {
266 assert(getDepth() == saved.getDepth() + 1);
272 // 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;
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
281 class AbiTagState final {
283 explicit AbiTagState(AbiTagState *&Head) : LinkHead(Head) {
289 AbiTagState(const AbiTagState &) = delete;
290 AbiTagState &operator=(const AbiTagState &) = delete;
292 ~AbiTagState() { pop(); }
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)) {
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());
306 // Don't emit abi tags for namespaces.
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());
319 if (AdditionalAbiTags) {
320 UsedAbiTags.insert(UsedAbiTags.end(), AdditionalAbiTags->begin(),
321 AdditionalAbiTags->end());
322 TagList.insert(TagList.end(), AdditionalAbiTags->begin(),
323 AdditionalAbiTags->end());
326 std::sort(TagList.begin(), TagList.end());
327 TagList.erase(std::unique(TagList.begin(), TagList.end()), TagList.end());
329 writeSortedUniqueAbiTags(Out, TagList);
332 const AbiTagList &getUsedAbiTags() const { return UsedAbiTags; }
333 void setUsedAbiTags(const AbiTagList &AbiTags) {
334 UsedAbiTags = AbiTags;
337 const AbiTagList &getEmittedAbiTags() const {
338 return EmittedAbiTags;
341 const AbiTagList &getSortedUniqueUsedAbiTags() {
342 std::sort(UsedAbiTags.begin(), UsedAbiTags.end());
343 UsedAbiTags.erase(std::unique(UsedAbiTags.begin(), UsedAbiTags.end()),
349 //! All abi tags used implicitly or explicitly.
350 AbiTagList UsedAbiTags;
351 //! All explicit abi tags (i.e. not from namespace).
352 AbiTagList EmittedAbiTags;
354 AbiTagState *&LinkHead;
355 AbiTagState *Parent = nullptr;
358 assert(LinkHead == this &&
359 "abi tag link head must point to us on destruction");
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());
370 void writeSortedUniqueAbiTags(raw_ostream &Out, const AbiTagList &AbiTags) {
371 for (const auto &Tag : AbiTags) {
372 EmittedAbiTags.push_back(Tag);
380 AbiTagState *AbiTags = nullptr;
381 AbiTagState AbiTagsRoot;
383 llvm::DenseMap<uintptr_t, unsigned> Substitutions;
385 ASTContext &getASTContext() const { return Context.getASTContext(); }
388 CXXNameMangler(ItaniumMangleContextImpl &C, raw_ostream &Out_,
389 const NamedDecl *D = nullptr, bool NullOut_ = false)
390 : Context(C), Out(Out_), NullOut(NullOut_), Structor(getStructor(D)),
391 StructorType(0), SeqID(0), AbiTagsRoot(AbiTags) {
392 // These can't be mangled without a ctor type or dtor type.
393 assert(!D || (!isa<CXXDestructorDecl>(D) &&
394 !isa<CXXConstructorDecl>(D)));
396 CXXNameMangler(ItaniumMangleContextImpl &C, raw_ostream &Out_,
397 const CXXConstructorDecl *D, CXXCtorType Type)
398 : Context(C), Out(Out_), Structor(getStructor(D)), StructorType(Type),
399 SeqID(0), AbiTagsRoot(AbiTags) { }
400 CXXNameMangler(ItaniumMangleContextImpl &C, raw_ostream &Out_,
401 const CXXDestructorDecl *D, CXXDtorType Type)
402 : Context(C), Out(Out_), Structor(getStructor(D)), StructorType(Type),
403 SeqID(0), AbiTagsRoot(AbiTags) { }
405 CXXNameMangler(CXXNameMangler &Outer, raw_ostream &Out_)
406 : Context(Outer.Context), Out(Out_), NullOut(false),
407 Structor(Outer.Structor), StructorType(Outer.StructorType),
408 SeqID(Outer.SeqID), FunctionTypeDepth(Outer.FunctionTypeDepth),
409 AbiTagsRoot(AbiTags), Substitutions(Outer.Substitutions) {}
411 CXXNameMangler(CXXNameMangler &Outer, llvm::raw_null_ostream &Out_)
412 : Context(Outer.Context), Out(Out_), NullOut(true),
413 Structor(Outer.Structor), StructorType(Outer.StructorType),
414 SeqID(Outer.SeqID), FunctionTypeDepth(Outer.FunctionTypeDepth),
415 AbiTagsRoot(AbiTags), Substitutions(Outer.Substitutions) {}
419 if (Out.str()[0] == '\01')
423 char *result = abi::__cxa_demangle(Out.str().str().c_str(), 0, 0, &status);
424 assert(status == 0 && "Could not demangle mangled name!");
428 raw_ostream &getStream() { return Out; }
430 void disableDerivedAbiTags() { DisableDerivedAbiTags = true; }
431 static bool shouldHaveAbiTags(ItaniumMangleContextImpl &C, const VarDecl *VD);
433 void mangle(const NamedDecl *D);
434 void mangleCallOffset(int64_t NonVirtual, int64_t Virtual);
435 void mangleNumber(const llvm::APSInt &I);
436 void mangleNumber(int64_t Number);
437 void mangleFloat(const llvm::APFloat &F);
438 void mangleFunctionEncoding(const FunctionDecl *FD);
439 void mangleSeqID(unsigned SeqID);
440 void mangleName(const NamedDecl *ND);
441 void mangleType(QualType T);
442 void mangleNameOrStandardSubstitution(const NamedDecl *ND);
446 bool mangleSubstitution(const NamedDecl *ND);
447 bool mangleSubstitution(QualType T);
448 bool mangleSubstitution(TemplateName Template);
449 bool mangleSubstitution(uintptr_t Ptr);
451 void mangleExistingSubstitution(TemplateName name);
453 bool mangleStandardSubstitution(const NamedDecl *ND);
455 void addSubstitution(const NamedDecl *ND) {
456 ND = cast<NamedDecl>(ND->getCanonicalDecl());
458 addSubstitution(reinterpret_cast<uintptr_t>(ND));
460 void addSubstitution(QualType T);
461 void addSubstitution(TemplateName Template);
462 void addSubstitution(uintptr_t Ptr);
463 // Destructive copy substitutions from other mangler.
464 void extendSubstitutions(CXXNameMangler* Other);
466 void mangleUnresolvedPrefix(NestedNameSpecifier *qualifier,
467 bool recursive = false);
468 void mangleUnresolvedName(NestedNameSpecifier *qualifier,
469 DeclarationName name,
470 const TemplateArgumentLoc *TemplateArgs,
471 unsigned NumTemplateArgs,
472 unsigned KnownArity = UnknownArity);
474 void mangleFunctionEncodingBareType(const FunctionDecl *FD);
476 void mangleNameWithAbiTags(const NamedDecl *ND,
477 const AbiTagList *AdditionalAbiTags);
478 void mangleTemplateName(const TemplateDecl *TD,
479 const TemplateArgument *TemplateArgs,
480 unsigned NumTemplateArgs);
481 void mangleUnqualifiedName(const NamedDecl *ND,
482 const AbiTagList *AdditionalAbiTags) {
483 mangleUnqualifiedName(ND, ND->getDeclName(), UnknownArity,
486 void mangleUnqualifiedName(const NamedDecl *ND, DeclarationName Name,
488 const AbiTagList *AdditionalAbiTags);
489 void mangleUnscopedName(const NamedDecl *ND,
490 const AbiTagList *AdditionalAbiTags);
491 void mangleUnscopedTemplateName(const TemplateDecl *ND,
492 const AbiTagList *AdditionalAbiTags);
493 void mangleUnscopedTemplateName(TemplateName,
494 const AbiTagList *AdditionalAbiTags);
495 void mangleSourceName(const IdentifierInfo *II);
496 void mangleRegCallName(const IdentifierInfo *II);
497 void mangleSourceNameWithAbiTags(
498 const NamedDecl *ND, const AbiTagList *AdditionalAbiTags = nullptr);
499 void mangleLocalName(const Decl *D,
500 const AbiTagList *AdditionalAbiTags);
501 void mangleBlockForPrefix(const BlockDecl *Block);
502 void mangleUnqualifiedBlock(const BlockDecl *Block);
503 void mangleLambda(const CXXRecordDecl *Lambda);
504 void mangleNestedName(const NamedDecl *ND, const DeclContext *DC,
505 const AbiTagList *AdditionalAbiTags,
506 bool NoFunction=false);
507 void mangleNestedName(const TemplateDecl *TD,
508 const TemplateArgument *TemplateArgs,
509 unsigned NumTemplateArgs);
510 void manglePrefix(NestedNameSpecifier *qualifier);
511 void manglePrefix(const DeclContext *DC, bool NoFunction=false);
512 void manglePrefix(QualType type);
513 void mangleTemplatePrefix(const TemplateDecl *ND, bool NoFunction=false);
514 void mangleTemplatePrefix(TemplateName Template);
515 bool mangleUnresolvedTypeOrSimpleId(QualType DestroyedType,
516 StringRef Prefix = "");
517 void mangleOperatorName(DeclarationName Name, unsigned Arity);
518 void mangleOperatorName(OverloadedOperatorKind OO, unsigned Arity);
519 void mangleVendorQualifier(StringRef qualifier);
520 void mangleQualifiers(Qualifiers Quals);
521 void mangleRefQualifier(RefQualifierKind RefQualifier);
523 void mangleObjCMethodName(const ObjCMethodDecl *MD);
525 // Declare manglers for every type class.
526 #define ABSTRACT_TYPE(CLASS, PARENT)
527 #define NON_CANONICAL_TYPE(CLASS, PARENT)
528 #define TYPE(CLASS, PARENT) void mangleType(const CLASS##Type *T);
529 #include "clang/AST/TypeNodes.def"
531 void mangleType(const TagType*);
532 void mangleType(TemplateName);
533 static StringRef getCallingConvQualifierName(CallingConv CC);
534 void mangleExtParameterInfo(FunctionProtoType::ExtParameterInfo info);
535 void mangleExtFunctionInfo(const FunctionType *T);
536 void mangleBareFunctionType(const FunctionProtoType *T, bool MangleReturnType,
537 const FunctionDecl *FD = nullptr);
538 void mangleNeonVectorType(const VectorType *T);
539 void mangleAArch64NeonVectorType(const VectorType *T);
541 void mangleIntegerLiteral(QualType T, const llvm::APSInt &Value);
542 void mangleMemberExprBase(const Expr *base, bool isArrow);
543 void mangleMemberExpr(const Expr *base, bool isArrow,
544 NestedNameSpecifier *qualifier,
545 NamedDecl *firstQualifierLookup,
546 DeclarationName name,
547 const TemplateArgumentLoc *TemplateArgs,
548 unsigned NumTemplateArgs,
549 unsigned knownArity);
550 void mangleCastExpression(const Expr *E, StringRef CastEncoding);
551 void mangleInitListElements(const InitListExpr *InitList);
552 void mangleExpression(const Expr *E, unsigned Arity = UnknownArity);
553 void mangleCXXCtorType(CXXCtorType T, const CXXRecordDecl *InheritedFrom);
554 void mangleCXXDtorType(CXXDtorType T);
556 void mangleTemplateArgs(const TemplateArgumentLoc *TemplateArgs,
557 unsigned NumTemplateArgs);
558 void mangleTemplateArgs(const TemplateArgument *TemplateArgs,
559 unsigned NumTemplateArgs);
560 void mangleTemplateArgs(const TemplateArgumentList &AL);
561 void mangleTemplateArg(TemplateArgument A);
563 void mangleTemplateParameter(unsigned Index);
565 void mangleFunctionParam(const ParmVarDecl *parm);
567 void writeAbiTags(const NamedDecl *ND,
568 const AbiTagList *AdditionalAbiTags);
570 // Returns sorted unique list of ABI tags.
571 AbiTagList makeFunctionReturnTypeTags(const FunctionDecl *FD);
572 // Returns sorted unique list of ABI tags.
573 AbiTagList makeVariableTypeTags(const VarDecl *VD);
578 bool ItaniumMangleContextImpl::shouldMangleCXXName(const NamedDecl *D) {
579 const FunctionDecl *FD = dyn_cast<FunctionDecl>(D);
581 LanguageLinkage L = FD->getLanguageLinkage();
582 // Overloadable functions need mangling.
583 if (FD->hasAttr<OverloadableAttr>())
586 // "main" is not mangled.
590 // C++ functions and those whose names are not a simple identifier need
592 if (!FD->getDeclName().isIdentifier() || L == CXXLanguageLinkage)
595 // C functions are not mangled.
596 if (L == CLanguageLinkage)
600 // Otherwise, no mangling is done outside C++ mode.
601 if (!getASTContext().getLangOpts().CPlusPlus)
604 const VarDecl *VD = dyn_cast<VarDecl>(D);
605 if (VD && !isa<DecompositionDecl>(D)) {
606 // C variables are not mangled.
610 // Variables at global scope with non-internal linkage are not mangled
611 const DeclContext *DC = getEffectiveDeclContext(D);
612 // Check for extern variable declared locally.
613 if (DC->isFunctionOrMethod() && D->hasLinkage())
614 while (!DC->isNamespace() && !DC->isTranslationUnit())
615 DC = getEffectiveParentContext(DC);
616 if (DC->isTranslationUnit() && D->getFormalLinkage() != InternalLinkage &&
617 !CXXNameMangler::shouldHaveAbiTags(*this, VD) &&
618 !isa<VarTemplateSpecializationDecl>(D))
625 void CXXNameMangler::writeAbiTags(const NamedDecl *ND,
626 const AbiTagList *AdditionalAbiTags) {
627 assert(AbiTags && "require AbiTagState");
628 AbiTags->write(Out, ND, DisableDerivedAbiTags ? nullptr : AdditionalAbiTags);
631 void CXXNameMangler::mangleSourceNameWithAbiTags(
632 const NamedDecl *ND, const AbiTagList *AdditionalAbiTags) {
633 mangleSourceName(ND->getIdentifier());
634 writeAbiTags(ND, AdditionalAbiTags);
637 void CXXNameMangler::mangle(const NamedDecl *D) {
638 // <mangled-name> ::= _Z <encoding>
640 // ::= <special-name>
642 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
643 mangleFunctionEncoding(FD);
644 else if (const VarDecl *VD = dyn_cast<VarDecl>(D))
646 else if (const IndirectFieldDecl *IFD = dyn_cast<IndirectFieldDecl>(D))
647 mangleName(IFD->getAnonField());
649 mangleName(cast<FieldDecl>(D));
652 void CXXNameMangler::mangleFunctionEncoding(const FunctionDecl *FD) {
653 // <encoding> ::= <function name> <bare-function-type>
655 // Don't mangle in the type if this isn't a decl we should typically mangle.
656 if (!Context.shouldMangleDeclName(FD)) {
661 AbiTagList ReturnTypeAbiTags = makeFunctionReturnTypeTags(FD);
662 if (ReturnTypeAbiTags.empty()) {
663 // There are no tags for return type, the simplest case.
665 mangleFunctionEncodingBareType(FD);
669 // Mangle function name and encoding to temporary buffer.
670 // We have to output name and encoding to the same mangler to get the same
671 // substitution as it will be in final mangling.
672 SmallString<256> FunctionEncodingBuf;
673 llvm::raw_svector_ostream FunctionEncodingStream(FunctionEncodingBuf);
674 CXXNameMangler FunctionEncodingMangler(*this, FunctionEncodingStream);
675 // Output name of the function.
676 FunctionEncodingMangler.disableDerivedAbiTags();
677 FunctionEncodingMangler.mangleNameWithAbiTags(FD, nullptr);
679 // Remember length of the function name in the buffer.
680 size_t EncodingPositionStart = FunctionEncodingStream.str().size();
681 FunctionEncodingMangler.mangleFunctionEncodingBareType(FD);
683 // Get tags from return type that are not present in function name or
685 const AbiTagList &UsedAbiTags =
686 FunctionEncodingMangler.AbiTagsRoot.getSortedUniqueUsedAbiTags();
687 AbiTagList AdditionalAbiTags(ReturnTypeAbiTags.size());
688 AdditionalAbiTags.erase(
689 std::set_difference(ReturnTypeAbiTags.begin(), ReturnTypeAbiTags.end(),
690 UsedAbiTags.begin(), UsedAbiTags.end(),
691 AdditionalAbiTags.begin()),
692 AdditionalAbiTags.end());
694 // Output name with implicit tags and function encoding from temporary buffer.
695 mangleNameWithAbiTags(FD, &AdditionalAbiTags);
696 Out << FunctionEncodingStream.str().substr(EncodingPositionStart);
698 // Function encoding could create new substitutions so we have to add
699 // temp mangled substitutions to main mangler.
700 extendSubstitutions(&FunctionEncodingMangler);
703 void CXXNameMangler::mangleFunctionEncodingBareType(const FunctionDecl *FD) {
704 if (FD->hasAttr<EnableIfAttr>()) {
705 FunctionTypeDepthState Saved = FunctionTypeDepth.push();
706 Out << "Ua9enable_ifI";
707 // FIXME: specific_attr_iterator iterates in reverse order. Fix that and use
709 for (AttrVec::const_reverse_iterator I = FD->getAttrs().rbegin(),
710 E = FD->getAttrs().rend();
712 EnableIfAttr *EIA = dyn_cast<EnableIfAttr>(*I);
716 mangleExpression(EIA->getCond());
720 FunctionTypeDepth.pop(Saved);
723 // When mangling an inheriting constructor, the bare function type used is
724 // that of the inherited constructor.
725 if (auto *CD = dyn_cast<CXXConstructorDecl>(FD))
726 if (auto Inherited = CD->getInheritedConstructor())
727 FD = Inherited.getConstructor();
729 // Whether the mangling of a function type includes the return type depends on
730 // the context and the nature of the function. The rules for deciding whether
731 // the return type is included are:
733 // 1. Template functions (names or types) have return types encoded, with
734 // the exceptions listed below.
735 // 2. Function types not appearing as part of a function name mangling,
736 // e.g. parameters, pointer types, etc., have return type encoded, with the
737 // exceptions listed below.
738 // 3. Non-template function names do not have return types encoded.
740 // The exceptions mentioned in (1) and (2) above, for which the return type is
741 // never included, are
744 // 3. Conversion operator functions, e.g. operator int.
745 bool MangleReturnType = false;
746 if (FunctionTemplateDecl *PrimaryTemplate = FD->getPrimaryTemplate()) {
747 if (!(isa<CXXConstructorDecl>(FD) || isa<CXXDestructorDecl>(FD) ||
748 isa<CXXConversionDecl>(FD)))
749 MangleReturnType = true;
751 // Mangle the type of the primary template.
752 FD = PrimaryTemplate->getTemplatedDecl();
755 mangleBareFunctionType(FD->getType()->castAs<FunctionProtoType>(),
756 MangleReturnType, FD);
759 static const DeclContext *IgnoreLinkageSpecDecls(const DeclContext *DC) {
760 while (isa<LinkageSpecDecl>(DC)) {
761 DC = getEffectiveParentContext(DC);
767 /// Return whether a given namespace is the 'std' namespace.
768 static bool isStd(const NamespaceDecl *NS) {
769 if (!IgnoreLinkageSpecDecls(getEffectiveParentContext(NS))
770 ->isTranslationUnit())
773 const IdentifierInfo *II = NS->getOriginalNamespace()->getIdentifier();
774 return II && II->isStr("std");
777 // isStdNamespace - Return whether a given decl context is a toplevel 'std'
779 static bool isStdNamespace(const DeclContext *DC) {
780 if (!DC->isNamespace())
783 return isStd(cast<NamespaceDecl>(DC));
786 static const TemplateDecl *
787 isTemplate(const NamedDecl *ND, const TemplateArgumentList *&TemplateArgs) {
788 // Check if we have a function template.
789 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)) {
790 if (const TemplateDecl *TD = FD->getPrimaryTemplate()) {
791 TemplateArgs = FD->getTemplateSpecializationArgs();
796 // Check if we have a class template.
797 if (const ClassTemplateSpecializationDecl *Spec =
798 dyn_cast<ClassTemplateSpecializationDecl>(ND)) {
799 TemplateArgs = &Spec->getTemplateArgs();
800 return Spec->getSpecializedTemplate();
803 // Check if we have a variable template.
804 if (const VarTemplateSpecializationDecl *Spec =
805 dyn_cast<VarTemplateSpecializationDecl>(ND)) {
806 TemplateArgs = &Spec->getTemplateArgs();
807 return Spec->getSpecializedTemplate();
813 void CXXNameMangler::mangleName(const NamedDecl *ND) {
814 if (const VarDecl *VD = dyn_cast<VarDecl>(ND)) {
815 // Variables should have implicit tags from its type.
816 AbiTagList VariableTypeAbiTags = makeVariableTypeTags(VD);
817 if (VariableTypeAbiTags.empty()) {
818 // Simple case no variable type tags.
819 mangleNameWithAbiTags(VD, nullptr);
823 // Mangle variable name to null stream to collect tags.
824 llvm::raw_null_ostream NullOutStream;
825 CXXNameMangler VariableNameMangler(*this, NullOutStream);
826 VariableNameMangler.disableDerivedAbiTags();
827 VariableNameMangler.mangleNameWithAbiTags(VD, nullptr);
829 // Get tags from variable type that are not present in its name.
830 const AbiTagList &UsedAbiTags =
831 VariableNameMangler.AbiTagsRoot.getSortedUniqueUsedAbiTags();
832 AbiTagList AdditionalAbiTags(VariableTypeAbiTags.size());
833 AdditionalAbiTags.erase(
834 std::set_difference(VariableTypeAbiTags.begin(),
835 VariableTypeAbiTags.end(), UsedAbiTags.begin(),
836 UsedAbiTags.end(), AdditionalAbiTags.begin()),
837 AdditionalAbiTags.end());
839 // Output name with implicit tags.
840 mangleNameWithAbiTags(VD, &AdditionalAbiTags);
842 mangleNameWithAbiTags(ND, nullptr);
846 void CXXNameMangler::mangleNameWithAbiTags(const NamedDecl *ND,
847 const AbiTagList *AdditionalAbiTags) {
848 // <name> ::= <nested-name>
849 // ::= <unscoped-name>
850 // ::= <unscoped-template-name> <template-args>
853 const DeclContext *DC = getEffectiveDeclContext(ND);
855 // If this is an extern variable declared locally, the relevant DeclContext
856 // is that of the containing namespace, or the translation unit.
857 // FIXME: This is a hack; extern variables declared locally should have
858 // a proper semantic declaration context!
859 if (isLocalContainerContext(DC) && ND->hasLinkage() && !isLambda(ND))
860 while (!DC->isNamespace() && !DC->isTranslationUnit())
861 DC = getEffectiveParentContext(DC);
862 else if (GetLocalClassDecl(ND)) {
863 mangleLocalName(ND, AdditionalAbiTags);
867 DC = IgnoreLinkageSpecDecls(DC);
869 if (DC->isTranslationUnit() || isStdNamespace(DC)) {
870 // Check if we have a template.
871 const TemplateArgumentList *TemplateArgs = nullptr;
872 if (const TemplateDecl *TD = isTemplate(ND, TemplateArgs)) {
873 mangleUnscopedTemplateName(TD, AdditionalAbiTags);
874 mangleTemplateArgs(*TemplateArgs);
878 mangleUnscopedName(ND, AdditionalAbiTags);
882 if (isLocalContainerContext(DC)) {
883 mangleLocalName(ND, AdditionalAbiTags);
887 mangleNestedName(ND, DC, AdditionalAbiTags);
890 void CXXNameMangler::mangleTemplateName(const TemplateDecl *TD,
891 const TemplateArgument *TemplateArgs,
892 unsigned NumTemplateArgs) {
893 const DeclContext *DC = IgnoreLinkageSpecDecls(getEffectiveDeclContext(TD));
895 if (DC->isTranslationUnit() || isStdNamespace(DC)) {
896 mangleUnscopedTemplateName(TD, nullptr);
897 mangleTemplateArgs(TemplateArgs, NumTemplateArgs);
899 mangleNestedName(TD, TemplateArgs, NumTemplateArgs);
903 void CXXNameMangler::mangleUnscopedName(const NamedDecl *ND,
904 const AbiTagList *AdditionalAbiTags) {
905 // <unscoped-name> ::= <unqualified-name>
906 // ::= St <unqualified-name> # ::std::
908 if (isStdNamespace(IgnoreLinkageSpecDecls(getEffectiveDeclContext(ND))))
911 mangleUnqualifiedName(ND, AdditionalAbiTags);
914 void CXXNameMangler::mangleUnscopedTemplateName(
915 const TemplateDecl *ND, const AbiTagList *AdditionalAbiTags) {
916 // <unscoped-template-name> ::= <unscoped-name>
917 // ::= <substitution>
918 if (mangleSubstitution(ND))
921 // <template-template-param> ::= <template-param>
922 if (const auto *TTP = dyn_cast<TemplateTemplateParmDecl>(ND)) {
923 assert(!AdditionalAbiTags &&
924 "template template param cannot have abi tags");
925 mangleTemplateParameter(TTP->getIndex());
926 } else if (isa<BuiltinTemplateDecl>(ND)) {
927 mangleUnscopedName(ND, AdditionalAbiTags);
929 mangleUnscopedName(ND->getTemplatedDecl(), AdditionalAbiTags);
935 void CXXNameMangler::mangleUnscopedTemplateName(
936 TemplateName Template, const AbiTagList *AdditionalAbiTags) {
937 // <unscoped-template-name> ::= <unscoped-name>
938 // ::= <substitution>
939 if (TemplateDecl *TD = Template.getAsTemplateDecl())
940 return mangleUnscopedTemplateName(TD, AdditionalAbiTags);
942 if (mangleSubstitution(Template))
945 assert(!AdditionalAbiTags &&
946 "dependent template name cannot have abi tags");
948 DependentTemplateName *Dependent = Template.getAsDependentTemplateName();
949 assert(Dependent && "Not a dependent template name?");
950 if (const IdentifierInfo *Id = Dependent->getIdentifier())
951 mangleSourceName(Id);
953 mangleOperatorName(Dependent->getOperator(), UnknownArity);
955 addSubstitution(Template);
958 void CXXNameMangler::mangleFloat(const llvm::APFloat &f) {
960 // Floating-point literals are encoded using a fixed-length
961 // lowercase hexadecimal string corresponding to the internal
962 // representation (IEEE on Itanium), high-order bytes first,
963 // without leading zeroes. For example: "Lf bf800000 E" is -1.0f
965 // The 'without leading zeroes' thing seems to be an editorial
966 // mistake; see the discussion on cxx-abi-dev beginning on
969 // Our requirements here are just barely weird enough to justify
970 // using a custom algorithm instead of post-processing APInt::toString().
972 llvm::APInt valueBits = f.bitcastToAPInt();
973 unsigned numCharacters = (valueBits.getBitWidth() + 3) / 4;
974 assert(numCharacters != 0);
976 // Allocate a buffer of the right number of characters.
977 SmallVector<char, 20> buffer(numCharacters);
979 // Fill the buffer left-to-right.
980 for (unsigned stringIndex = 0; stringIndex != numCharacters; ++stringIndex) {
981 // The bit-index of the next hex digit.
982 unsigned digitBitIndex = 4 * (numCharacters - stringIndex - 1);
984 // Project out 4 bits starting at 'digitIndex'.
985 uint64_t hexDigit = valueBits.getRawData()[digitBitIndex / 64];
986 hexDigit >>= (digitBitIndex % 64);
989 // Map that over to a lowercase hex digit.
990 static const char charForHex[16] = {
991 '0', '1', '2', '3', '4', '5', '6', '7',
992 '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'
994 buffer[stringIndex] = charForHex[hexDigit];
997 Out.write(buffer.data(), numCharacters);
1000 void CXXNameMangler::mangleNumber(const llvm::APSInt &Value) {
1001 if (Value.isSigned() && Value.isNegative()) {
1003 Value.abs().print(Out, /*signed*/ false);
1005 Value.print(Out, /*signed*/ false);
1009 void CXXNameMangler::mangleNumber(int64_t Number) {
1010 // <number> ::= [n] <non-negative decimal integer>
1019 void CXXNameMangler::mangleCallOffset(int64_t NonVirtual, int64_t Virtual) {
1020 // <call-offset> ::= h <nv-offset> _
1021 // ::= v <v-offset> _
1022 // <nv-offset> ::= <offset number> # non-virtual base override
1023 // <v-offset> ::= <offset number> _ <virtual offset number>
1024 // # virtual base override, with vcall offset
1027 mangleNumber(NonVirtual);
1033 mangleNumber(NonVirtual);
1035 mangleNumber(Virtual);
1039 void CXXNameMangler::manglePrefix(QualType type) {
1040 if (const auto *TST = type->getAs<TemplateSpecializationType>()) {
1041 if (!mangleSubstitution(QualType(TST, 0))) {
1042 mangleTemplatePrefix(TST->getTemplateName());
1044 // FIXME: GCC does not appear to mangle the template arguments when
1045 // the template in question is a dependent template name. Should we
1046 // emulate that badness?
1047 mangleTemplateArgs(TST->getArgs(), TST->getNumArgs());
1048 addSubstitution(QualType(TST, 0));
1050 } else if (const auto *DTST =
1051 type->getAs<DependentTemplateSpecializationType>()) {
1052 if (!mangleSubstitution(QualType(DTST, 0))) {
1053 TemplateName Template = getASTContext().getDependentTemplateName(
1054 DTST->getQualifier(), DTST->getIdentifier());
1055 mangleTemplatePrefix(Template);
1057 // FIXME: GCC does not appear to mangle the template arguments when
1058 // the template in question is a dependent template name. Should we
1059 // emulate that badness?
1060 mangleTemplateArgs(DTST->getArgs(), DTST->getNumArgs());
1061 addSubstitution(QualType(DTST, 0));
1064 // We use the QualType mangle type variant here because it handles
1070 /// Mangle everything prior to the base-unresolved-name in an unresolved-name.
1072 /// \param recursive - true if this is being called recursively,
1073 /// i.e. if there is more prefix "to the right".
1074 void CXXNameMangler::mangleUnresolvedPrefix(NestedNameSpecifier *qualifier,
1078 // <unresolved-name> ::= [gs] <base-unresolved-name>
1080 // T::x / decltype(p)::x
1081 // <unresolved-name> ::= sr <unresolved-type> <base-unresolved-name>
1083 // T::N::x /decltype(p)::N::x
1084 // <unresolved-name> ::= srN <unresolved-type> <unresolved-qualifier-level>+ E
1085 // <base-unresolved-name>
1087 // A::x, N::y, A<T>::z; "gs" means leading "::"
1088 // <unresolved-name> ::= [gs] sr <unresolved-qualifier-level>+ E
1089 // <base-unresolved-name>
1091 switch (qualifier->getKind()) {
1092 case NestedNameSpecifier::Global:
1095 // We want an 'sr' unless this is the entire NNS.
1099 // We never want an 'E' here.
1102 case NestedNameSpecifier::Super:
1103 llvm_unreachable("Can't mangle __super specifier");
1105 case NestedNameSpecifier::Namespace:
1106 if (qualifier->getPrefix())
1107 mangleUnresolvedPrefix(qualifier->getPrefix(),
1108 /*recursive*/ true);
1111 mangleSourceNameWithAbiTags(qualifier->getAsNamespace());
1113 case NestedNameSpecifier::NamespaceAlias:
1114 if (qualifier->getPrefix())
1115 mangleUnresolvedPrefix(qualifier->getPrefix(),
1116 /*recursive*/ true);
1119 mangleSourceNameWithAbiTags(qualifier->getAsNamespaceAlias());
1122 case NestedNameSpecifier::TypeSpec:
1123 case NestedNameSpecifier::TypeSpecWithTemplate: {
1124 const Type *type = qualifier->getAsType();
1126 // We only want to use an unresolved-type encoding if this is one of:
1128 // - a template type parameter
1129 // - a template template parameter with arguments
1130 // In all of these cases, we should have no prefix.
1131 if (qualifier->getPrefix()) {
1132 mangleUnresolvedPrefix(qualifier->getPrefix(),
1133 /*recursive*/ true);
1135 // Otherwise, all the cases want this.
1139 if (mangleUnresolvedTypeOrSimpleId(QualType(type, 0), recursive ? "N" : ""))
1145 case NestedNameSpecifier::Identifier:
1146 // Member expressions can have these without prefixes.
1147 if (qualifier->getPrefix())
1148 mangleUnresolvedPrefix(qualifier->getPrefix(),
1149 /*recursive*/ true);
1153 mangleSourceName(qualifier->getAsIdentifier());
1154 // An Identifier has no type information, so we can't emit abi tags for it.
1158 // If this was the innermost part of the NNS, and we fell out to
1159 // here, append an 'E'.
1164 /// Mangle an unresolved-name, which is generally used for names which
1165 /// weren't resolved to specific entities.
1166 void CXXNameMangler::mangleUnresolvedName(
1167 NestedNameSpecifier *qualifier, DeclarationName name,
1168 const TemplateArgumentLoc *TemplateArgs, unsigned NumTemplateArgs,
1169 unsigned knownArity) {
1170 if (qualifier) mangleUnresolvedPrefix(qualifier);
1171 switch (name.getNameKind()) {
1172 // <base-unresolved-name> ::= <simple-id>
1173 case DeclarationName::Identifier:
1174 mangleSourceName(name.getAsIdentifierInfo());
1176 // <base-unresolved-name> ::= dn <destructor-name>
1177 case DeclarationName::CXXDestructorName:
1179 mangleUnresolvedTypeOrSimpleId(name.getCXXNameType());
1181 // <base-unresolved-name> ::= on <operator-name>
1182 case DeclarationName::CXXConversionFunctionName:
1183 case DeclarationName::CXXLiteralOperatorName:
1184 case DeclarationName::CXXOperatorName:
1186 mangleOperatorName(name, knownArity);
1188 case DeclarationName::CXXConstructorName:
1189 llvm_unreachable("Can't mangle a constructor name!");
1190 case DeclarationName::CXXUsingDirective:
1191 llvm_unreachable("Can't mangle a using directive name!");
1192 case DeclarationName::CXXDeductionGuideName:
1193 llvm_unreachable("Can't mangle a deduction guide name!");
1194 case DeclarationName::ObjCMultiArgSelector:
1195 case DeclarationName::ObjCOneArgSelector:
1196 case DeclarationName::ObjCZeroArgSelector:
1197 llvm_unreachable("Can't mangle Objective-C selector names here!");
1200 // The <simple-id> and on <operator-name> productions end in an optional
1203 mangleTemplateArgs(TemplateArgs, NumTemplateArgs);
1206 void CXXNameMangler::mangleUnqualifiedName(const NamedDecl *ND,
1207 DeclarationName Name,
1208 unsigned KnownArity,
1209 const AbiTagList *AdditionalAbiTags) {
1210 unsigned Arity = KnownArity;
1211 // <unqualified-name> ::= <operator-name>
1212 // ::= <ctor-dtor-name>
1213 // ::= <source-name>
1214 switch (Name.getNameKind()) {
1215 case DeclarationName::Identifier: {
1216 const IdentifierInfo *II = Name.getAsIdentifierInfo();
1218 // We mangle decomposition declarations as the names of their bindings.
1219 if (auto *DD = dyn_cast<DecompositionDecl>(ND)) {
1220 // FIXME: Non-standard mangling for decomposition declarations:
1222 // <unqualified-name> ::= DC <source-name>* E
1224 // These can never be referenced across translation units, so we do
1225 // not need a cross-vendor mangling for anything other than demanglers.
1226 // Proposed on cxx-abi-dev on 2016-08-12
1228 for (auto *BD : DD->bindings())
1229 mangleSourceName(BD->getDeclName().getAsIdentifierInfo());
1231 writeAbiTags(ND, AdditionalAbiTags);
1236 // We must avoid conflicts between internally- and externally-
1237 // linked variable and function declaration names in the same TU:
1238 // void test() { extern void foo(); }
1239 // static void foo();
1240 // This naming convention is the same as that followed by GCC,
1241 // though it shouldn't actually matter.
1242 if (ND && ND->getFormalLinkage() == InternalLinkage &&
1243 getEffectiveDeclContext(ND)->isFileContext())
1246 auto *FD = dyn_cast<FunctionDecl>(ND);
1247 bool IsRegCall = FD &&
1248 FD->getType()->castAs<FunctionType>()->getCallConv() ==
1249 clang::CC_X86RegCall;
1251 mangleRegCallName(II);
1253 mangleSourceName(II);
1255 writeAbiTags(ND, AdditionalAbiTags);
1259 // Otherwise, an anonymous entity. We must have a declaration.
1260 assert(ND && "mangling empty name without declaration");
1262 if (const NamespaceDecl *NS = dyn_cast<NamespaceDecl>(ND)) {
1263 if (NS->isAnonymousNamespace()) {
1264 // This is how gcc mangles these names.
1265 Out << "12_GLOBAL__N_1";
1270 if (const VarDecl *VD = dyn_cast<VarDecl>(ND)) {
1271 // We must have an anonymous union or struct declaration.
1272 const RecordDecl *RD =
1273 cast<RecordDecl>(VD->getType()->getAs<RecordType>()->getDecl());
1275 // Itanium C++ ABI 5.1.2:
1277 // For the purposes of mangling, the name of an anonymous union is
1278 // considered to be the name of the first named data member found by a
1279 // pre-order, depth-first, declaration-order walk of the data members of
1280 // the anonymous union. If there is no such data member (i.e., if all of
1281 // the data members in the union are unnamed), then there is no way for
1282 // a program to refer to the anonymous union, and there is therefore no
1283 // need to mangle its name.
1284 assert(RD->isAnonymousStructOrUnion()
1285 && "Expected anonymous struct or union!");
1286 const FieldDecl *FD = RD->findFirstNamedDataMember();
1288 // It's actually possible for various reasons for us to get here
1289 // with an empty anonymous struct / union. Fortunately, it
1290 // doesn't really matter what name we generate.
1292 assert(FD->getIdentifier() && "Data member name isn't an identifier!");
1294 mangleSourceName(FD->getIdentifier());
1295 // Not emitting abi tags: internal name anyway.
1299 // Class extensions have no name as a category, and it's possible
1300 // for them to be the semantic parent of certain declarations
1301 // (primarily, tag decls defined within declarations). Such
1302 // declarations will always have internal linkage, so the name
1303 // doesn't really matter, but we shouldn't crash on them. For
1304 // safety, just handle all ObjC containers here.
1305 if (isa<ObjCContainerDecl>(ND))
1308 // We must have an anonymous struct.
1309 const TagDecl *TD = cast<TagDecl>(ND);
1310 if (const TypedefNameDecl *D = TD->getTypedefNameForAnonDecl()) {
1311 assert(TD->getDeclContext() == D->getDeclContext() &&
1312 "Typedef should not be in another decl context!");
1313 assert(D->getDeclName().getAsIdentifierInfo() &&
1314 "Typedef was not named!");
1315 mangleSourceName(D->getDeclName().getAsIdentifierInfo());
1316 assert(!AdditionalAbiTags && "Type cannot have additional abi tags");
1317 // Explicit abi tags are still possible; take from underlying type, not
1319 writeAbiTags(TD, nullptr);
1323 // <unnamed-type-name> ::= <closure-type-name>
1325 // <closure-type-name> ::= Ul <lambda-sig> E [ <nonnegative number> ] _
1326 // <lambda-sig> ::= <parameter-type>+ # Parameter types or 'v' for 'void'.
1327 if (const CXXRecordDecl *Record = dyn_cast<CXXRecordDecl>(TD)) {
1328 if (Record->isLambda() && Record->getLambdaManglingNumber()) {
1329 assert(!AdditionalAbiTags &&
1330 "Lambda type cannot have additional abi tags");
1331 mangleLambda(Record);
1336 if (TD->isExternallyVisible()) {
1337 unsigned UnnamedMangle = getASTContext().getManglingNumber(TD);
1339 if (UnnamedMangle > 1)
1340 Out << UnnamedMangle - 2;
1342 writeAbiTags(TD, AdditionalAbiTags);
1346 // Get a unique id for the anonymous struct. If it is not a real output
1347 // ID doesn't matter so use fake one.
1348 unsigned AnonStructId = NullOut ? 0 : Context.getAnonymousStructId(TD);
1350 // Mangle it as a source name in the form
1352 // where n is the length of the string.
1355 Str += llvm::utostr(AnonStructId);
1362 case DeclarationName::ObjCZeroArgSelector:
1363 case DeclarationName::ObjCOneArgSelector:
1364 case DeclarationName::ObjCMultiArgSelector:
1365 llvm_unreachable("Can't mangle Objective-C selector names here!");
1367 case DeclarationName::CXXConstructorName: {
1368 const CXXRecordDecl *InheritedFrom = nullptr;
1369 const TemplateArgumentList *InheritedTemplateArgs = nullptr;
1370 if (auto Inherited =
1371 cast<CXXConstructorDecl>(ND)->getInheritedConstructor()) {
1372 InheritedFrom = Inherited.getConstructor()->getParent();
1373 InheritedTemplateArgs =
1374 Inherited.getConstructor()->getTemplateSpecializationArgs();
1378 // If the named decl is the C++ constructor we're mangling, use the type
1380 mangleCXXCtorType(static_cast<CXXCtorType>(StructorType), InheritedFrom);
1382 // Otherwise, use the complete constructor name. This is relevant if a
1383 // class with a constructor is declared within a constructor.
1384 mangleCXXCtorType(Ctor_Complete, InheritedFrom);
1386 // FIXME: The template arguments are part of the enclosing prefix or
1387 // nested-name, but it's more convenient to mangle them here.
1388 if (InheritedTemplateArgs)
1389 mangleTemplateArgs(*InheritedTemplateArgs);
1391 writeAbiTags(ND, AdditionalAbiTags);
1395 case DeclarationName::CXXDestructorName:
1397 // If the named decl is the C++ destructor we're mangling, use the type we
1399 mangleCXXDtorType(static_cast<CXXDtorType>(StructorType));
1401 // Otherwise, use the complete destructor name. This is relevant if a
1402 // class with a destructor is declared within a destructor.
1403 mangleCXXDtorType(Dtor_Complete);
1404 writeAbiTags(ND, AdditionalAbiTags);
1407 case DeclarationName::CXXOperatorName:
1408 if (ND && Arity == UnknownArity) {
1409 Arity = cast<FunctionDecl>(ND)->getNumParams();
1411 // If we have a member function, we need to include the 'this' pointer.
1412 if (const auto *MD = dyn_cast<CXXMethodDecl>(ND))
1413 if (!MD->isStatic())
1417 case DeclarationName::CXXConversionFunctionName:
1418 case DeclarationName::CXXLiteralOperatorName:
1419 mangleOperatorName(Name, Arity);
1420 writeAbiTags(ND, AdditionalAbiTags);
1423 case DeclarationName::CXXDeductionGuideName:
1424 llvm_unreachable("Can't mangle a deduction guide name!");
1426 case DeclarationName::CXXUsingDirective:
1427 llvm_unreachable("Can't mangle a using directive name!");
1431 void CXXNameMangler::mangleRegCallName(const IdentifierInfo *II) {
1432 // <source-name> ::= <positive length number> __regcall3__ <identifier>
1433 // <number> ::= [n] <non-negative decimal integer>
1434 // <identifier> ::= <unqualified source code identifier>
1435 Out << II->getLength() + sizeof("__regcall3__") - 1 << "__regcall3__"
1439 void CXXNameMangler::mangleSourceName(const IdentifierInfo *II) {
1440 // <source-name> ::= <positive length number> <identifier>
1441 // <number> ::= [n] <non-negative decimal integer>
1442 // <identifier> ::= <unqualified source code identifier>
1443 Out << II->getLength() << II->getName();
1446 void CXXNameMangler::mangleNestedName(const NamedDecl *ND,
1447 const DeclContext *DC,
1448 const AbiTagList *AdditionalAbiTags,
1451 // ::= N [<CV-qualifiers>] [<ref-qualifier>] <prefix> <unqualified-name> E
1452 // ::= N [<CV-qualifiers>] [<ref-qualifier>] <template-prefix>
1453 // <template-args> E
1456 if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(ND)) {
1457 Qualifiers MethodQuals =
1458 Qualifiers::fromCVRUMask(Method->getTypeQualifiers());
1459 // We do not consider restrict a distinguishing attribute for overloading
1460 // purposes so we must not mangle it.
1461 MethodQuals.removeRestrict();
1462 mangleQualifiers(MethodQuals);
1463 mangleRefQualifier(Method->getRefQualifier());
1466 // Check if we have a template.
1467 const TemplateArgumentList *TemplateArgs = nullptr;
1468 if (const TemplateDecl *TD = isTemplate(ND, TemplateArgs)) {
1469 mangleTemplatePrefix(TD, NoFunction);
1470 mangleTemplateArgs(*TemplateArgs);
1473 manglePrefix(DC, NoFunction);
1474 mangleUnqualifiedName(ND, AdditionalAbiTags);
1479 void CXXNameMangler::mangleNestedName(const TemplateDecl *TD,
1480 const TemplateArgument *TemplateArgs,
1481 unsigned NumTemplateArgs) {
1482 // <nested-name> ::= N [<CV-qualifiers>] <template-prefix> <template-args> E
1486 mangleTemplatePrefix(TD);
1487 mangleTemplateArgs(TemplateArgs, NumTemplateArgs);
1492 void CXXNameMangler::mangleLocalName(const Decl *D,
1493 const AbiTagList *AdditionalAbiTags) {
1494 // <local-name> := Z <function encoding> E <entity name> [<discriminator>]
1495 // := Z <function encoding> E s [<discriminator>]
1496 // <local-name> := Z <function encoding> E d [ <parameter number> ]
1498 // <discriminator> := _ <non-negative number>
1499 assert(isa<NamedDecl>(D) || isa<BlockDecl>(D));
1500 const RecordDecl *RD = GetLocalClassDecl(D);
1501 const DeclContext *DC = getEffectiveDeclContext(RD ? RD : D);
1506 AbiTagState LocalAbiTags(AbiTags);
1508 if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(DC))
1509 mangleObjCMethodName(MD);
1510 else if (const BlockDecl *BD = dyn_cast<BlockDecl>(DC))
1511 mangleBlockForPrefix(BD);
1513 mangleFunctionEncoding(cast<FunctionDecl>(DC));
1515 // Implicit ABI tags (from namespace) are not available in the following
1516 // entity; reset to actually emitted tags, which are available.
1517 LocalAbiTags.setUsedAbiTags(LocalAbiTags.getEmittedAbiTags());
1522 // GCC 5.3.0 doesn't emit derived ABI tags for local names but that seems to
1523 // be a bug that is fixed in trunk.
1526 // The parameter number is omitted for the last parameter, 0 for the
1527 // second-to-last parameter, 1 for the third-to-last parameter, etc. The
1528 // <entity name> will of course contain a <closure-type-name>: Its
1529 // numbering will be local to the particular argument in which it appears
1530 // -- other default arguments do not affect its encoding.
1531 const CXXRecordDecl *CXXRD = dyn_cast<CXXRecordDecl>(RD);
1532 if (CXXRD && CXXRD->isLambda()) {
1533 if (const ParmVarDecl *Parm
1534 = dyn_cast_or_null<ParmVarDecl>(CXXRD->getLambdaContextDecl())) {
1535 if (const FunctionDecl *Func
1536 = dyn_cast<FunctionDecl>(Parm->getDeclContext())) {
1538 unsigned Num = Func->getNumParams() - Parm->getFunctionScopeIndex();
1540 mangleNumber(Num - 2);
1546 // Mangle the name relative to the closest enclosing function.
1547 // equality ok because RD derived from ND above
1549 mangleUnqualifiedName(RD, AdditionalAbiTags);
1550 } else if (const BlockDecl *BD = dyn_cast<BlockDecl>(D)) {
1551 manglePrefix(getEffectiveDeclContext(BD), true /*NoFunction*/);
1552 assert(!AdditionalAbiTags && "Block cannot have additional abi tags");
1553 mangleUnqualifiedBlock(BD);
1555 const NamedDecl *ND = cast<NamedDecl>(D);
1556 mangleNestedName(ND, getEffectiveDeclContext(ND), AdditionalAbiTags,
1557 true /*NoFunction*/);
1559 } else if (const BlockDecl *BD = dyn_cast<BlockDecl>(D)) {
1560 // Mangle a block in a default parameter; see above explanation for
1562 if (const ParmVarDecl *Parm
1563 = dyn_cast_or_null<ParmVarDecl>(BD->getBlockManglingContextDecl())) {
1564 if (const FunctionDecl *Func
1565 = dyn_cast<FunctionDecl>(Parm->getDeclContext())) {
1567 unsigned Num = Func->getNumParams() - Parm->getFunctionScopeIndex();
1569 mangleNumber(Num - 2);
1574 assert(!AdditionalAbiTags && "Block cannot have additional abi tags");
1575 mangleUnqualifiedBlock(BD);
1577 mangleUnqualifiedName(cast<NamedDecl>(D), AdditionalAbiTags);
1580 if (const NamedDecl *ND = dyn_cast<NamedDecl>(RD ? RD : D)) {
1582 if (Context.getNextDiscriminator(ND, disc)) {
1586 Out << "__" << disc << '_';
1591 void CXXNameMangler::mangleBlockForPrefix(const BlockDecl *Block) {
1592 if (GetLocalClassDecl(Block)) {
1593 mangleLocalName(Block, /* AdditionalAbiTags */ nullptr);
1596 const DeclContext *DC = getEffectiveDeclContext(Block);
1597 if (isLocalContainerContext(DC)) {
1598 mangleLocalName(Block, /* AdditionalAbiTags */ nullptr);
1601 manglePrefix(getEffectiveDeclContext(Block));
1602 mangleUnqualifiedBlock(Block);
1605 void CXXNameMangler::mangleUnqualifiedBlock(const BlockDecl *Block) {
1606 if (Decl *Context = Block->getBlockManglingContextDecl()) {
1607 if ((isa<VarDecl>(Context) || isa<FieldDecl>(Context)) &&
1608 Context->getDeclContext()->isRecord()) {
1609 const auto *ND = cast<NamedDecl>(Context);
1610 if (ND->getIdentifier()) {
1611 mangleSourceNameWithAbiTags(ND);
1617 // If we have a block mangling number, use it.
1618 unsigned Number = Block->getBlockManglingNumber();
1619 // Otherwise, just make up a number. It doesn't matter what it is because
1620 // the symbol in question isn't externally visible.
1622 Number = Context.getBlockId(Block, false);
1629 void CXXNameMangler::mangleLambda(const CXXRecordDecl *Lambda) {
1630 // If the context of a closure type is an initializer for a class member
1631 // (static or nonstatic), it is encoded in a qualified name with a final
1632 // <prefix> of the form:
1634 // <data-member-prefix> := <member source-name> M
1636 // Technically, the data-member-prefix is part of the <prefix>. However,
1637 // since a closure type will always be mangled with a prefix, it's easier
1638 // to emit that last part of the prefix here.
1639 if (Decl *Context = Lambda->getLambdaContextDecl()) {
1640 if ((isa<VarDecl>(Context) || isa<FieldDecl>(Context)) &&
1641 Context->getDeclContext()->isRecord()) {
1642 if (const IdentifierInfo *Name
1643 = cast<NamedDecl>(Context)->getIdentifier()) {
1644 mangleSourceName(Name);
1651 const FunctionProtoType *Proto = Lambda->getLambdaTypeInfo()->getType()->
1652 getAs<FunctionProtoType>();
1653 mangleBareFunctionType(Proto, /*MangleReturnType=*/false,
1654 Lambda->getLambdaStaticInvoker());
1657 // The number is omitted for the first closure type with a given
1658 // <lambda-sig> in a given context; it is n-2 for the nth closure type
1659 // (in lexical order) with that same <lambda-sig> and context.
1661 // The AST keeps track of the number for us.
1662 unsigned Number = Lambda->getLambdaManglingNumber();
1663 assert(Number > 0 && "Lambda should be mangled as an unnamed class");
1665 mangleNumber(Number - 2);
1669 void CXXNameMangler::manglePrefix(NestedNameSpecifier *qualifier) {
1670 switch (qualifier->getKind()) {
1671 case NestedNameSpecifier::Global:
1675 case NestedNameSpecifier::Super:
1676 llvm_unreachable("Can't mangle __super specifier");
1678 case NestedNameSpecifier::Namespace:
1679 mangleName(qualifier->getAsNamespace());
1682 case NestedNameSpecifier::NamespaceAlias:
1683 mangleName(qualifier->getAsNamespaceAlias()->getNamespace());
1686 case NestedNameSpecifier::TypeSpec:
1687 case NestedNameSpecifier::TypeSpecWithTemplate:
1688 manglePrefix(QualType(qualifier->getAsType(), 0));
1691 case NestedNameSpecifier::Identifier:
1692 // Member expressions can have these without prefixes, but that
1693 // should end up in mangleUnresolvedPrefix instead.
1694 assert(qualifier->getPrefix());
1695 manglePrefix(qualifier->getPrefix());
1697 mangleSourceName(qualifier->getAsIdentifier());
1701 llvm_unreachable("unexpected nested name specifier");
1704 void CXXNameMangler::manglePrefix(const DeclContext *DC, bool NoFunction) {
1705 // <prefix> ::= <prefix> <unqualified-name>
1706 // ::= <template-prefix> <template-args>
1707 // ::= <template-param>
1709 // ::= <substitution>
1711 DC = IgnoreLinkageSpecDecls(DC);
1713 if (DC->isTranslationUnit())
1716 if (NoFunction && isLocalContainerContext(DC))
1719 assert(!isLocalContainerContext(DC));
1721 const NamedDecl *ND = cast<NamedDecl>(DC);
1722 if (mangleSubstitution(ND))
1725 // Check if we have a template.
1726 const TemplateArgumentList *TemplateArgs = nullptr;
1727 if (const TemplateDecl *TD = isTemplate(ND, TemplateArgs)) {
1728 mangleTemplatePrefix(TD);
1729 mangleTemplateArgs(*TemplateArgs);
1731 manglePrefix(getEffectiveDeclContext(ND), NoFunction);
1732 mangleUnqualifiedName(ND, nullptr);
1735 addSubstitution(ND);
1738 void CXXNameMangler::mangleTemplatePrefix(TemplateName Template) {
1739 // <template-prefix> ::= <prefix> <template unqualified-name>
1740 // ::= <template-param>
1741 // ::= <substitution>
1742 if (TemplateDecl *TD = Template.getAsTemplateDecl())
1743 return mangleTemplatePrefix(TD);
1745 if (QualifiedTemplateName *Qualified = Template.getAsQualifiedTemplateName())
1746 manglePrefix(Qualified->getQualifier());
1748 if (OverloadedTemplateStorage *Overloaded
1749 = Template.getAsOverloadedTemplate()) {
1750 mangleUnqualifiedName(nullptr, (*Overloaded->begin())->getDeclName(),
1751 UnknownArity, nullptr);
1755 DependentTemplateName *Dependent = Template.getAsDependentTemplateName();
1756 assert(Dependent && "Unknown template name kind?");
1757 if (NestedNameSpecifier *Qualifier = Dependent->getQualifier())
1758 manglePrefix(Qualifier);
1759 mangleUnscopedTemplateName(Template, /* AdditionalAbiTags */ nullptr);
1762 void CXXNameMangler::mangleTemplatePrefix(const TemplateDecl *ND,
1764 // <template-prefix> ::= <prefix> <template unqualified-name>
1765 // ::= <template-param>
1766 // ::= <substitution>
1767 // <template-template-param> ::= <template-param>
1770 if (mangleSubstitution(ND))
1773 // <template-template-param> ::= <template-param>
1774 if (const auto *TTP = dyn_cast<TemplateTemplateParmDecl>(ND)) {
1775 mangleTemplateParameter(TTP->getIndex());
1777 manglePrefix(getEffectiveDeclContext(ND), NoFunction);
1778 if (isa<BuiltinTemplateDecl>(ND))
1779 mangleUnqualifiedName(ND, nullptr);
1781 mangleUnqualifiedName(ND->getTemplatedDecl(), nullptr);
1784 addSubstitution(ND);
1787 /// Mangles a template name under the production <type>. Required for
1788 /// template template arguments.
1789 /// <type> ::= <class-enum-type>
1790 /// ::= <template-param>
1791 /// ::= <substitution>
1792 void CXXNameMangler::mangleType(TemplateName TN) {
1793 if (mangleSubstitution(TN))
1796 TemplateDecl *TD = nullptr;
1798 switch (TN.getKind()) {
1799 case TemplateName::QualifiedTemplate:
1800 TD = TN.getAsQualifiedTemplateName()->getTemplateDecl();
1803 case TemplateName::Template:
1804 TD = TN.getAsTemplateDecl();
1808 if (isa<TemplateTemplateParmDecl>(TD))
1809 mangleTemplateParameter(cast<TemplateTemplateParmDecl>(TD)->getIndex());
1814 case TemplateName::OverloadedTemplate:
1815 llvm_unreachable("can't mangle an overloaded template name as a <type>");
1817 case TemplateName::DependentTemplate: {
1818 const DependentTemplateName *Dependent = TN.getAsDependentTemplateName();
1819 assert(Dependent->isIdentifier());
1821 // <class-enum-type> ::= <name>
1822 // <name> ::= <nested-name>
1823 mangleUnresolvedPrefix(Dependent->getQualifier());
1824 mangleSourceName(Dependent->getIdentifier());
1828 case TemplateName::SubstTemplateTemplateParm: {
1829 // Substituted template parameters are mangled as the substituted
1830 // template. This will check for the substitution twice, which is
1831 // fine, but we have to return early so that we don't try to *add*
1832 // the substitution twice.
1833 SubstTemplateTemplateParmStorage *subst
1834 = TN.getAsSubstTemplateTemplateParm();
1835 mangleType(subst->getReplacement());
1839 case TemplateName::SubstTemplateTemplateParmPack: {
1840 // FIXME: not clear how to mangle this!
1841 // template <template <class> class T...> class A {
1842 // template <template <class> class U...> void foo(B<T,U> x...);
1844 Out << "_SUBSTPACK_";
1849 addSubstitution(TN);
1852 bool CXXNameMangler::mangleUnresolvedTypeOrSimpleId(QualType Ty,
1854 // Only certain other types are valid as prefixes; enumerate them.
1855 switch (Ty->getTypeClass()) {
1858 case Type::Adjusted:
1861 case Type::BlockPointer:
1862 case Type::LValueReference:
1863 case Type::RValueReference:
1864 case Type::MemberPointer:
1865 case Type::ConstantArray:
1866 case Type::IncompleteArray:
1867 case Type::VariableArray:
1868 case Type::DependentSizedArray:
1869 case Type::DependentSizedExtVector:
1871 case Type::ExtVector:
1872 case Type::FunctionProto:
1873 case Type::FunctionNoProto:
1875 case Type::Attributed:
1877 case Type::DeducedTemplateSpecialization:
1878 case Type::PackExpansion:
1879 case Type::ObjCObject:
1880 case Type::ObjCInterface:
1881 case Type::ObjCObjectPointer:
1882 case Type::ObjCTypeParam:
1885 llvm_unreachable("type is illegal as a nested name specifier");
1887 case Type::SubstTemplateTypeParmPack:
1888 // FIXME: not clear how to mangle this!
1889 // template <class T...> class A {
1890 // template <class U...> void foo(decltype(T::foo(U())) x...);
1892 Out << "_SUBSTPACK_";
1895 // <unresolved-type> ::= <template-param>
1897 // ::= <template-template-param> <template-args>
1898 // (this last is not official yet)
1899 case Type::TypeOfExpr:
1901 case Type::Decltype:
1902 case Type::TemplateTypeParm:
1903 case Type::UnaryTransform:
1904 case Type::SubstTemplateTypeParm:
1906 // Some callers want a prefix before the mangled type.
1909 // This seems to do everything we want. It's not really
1910 // sanctioned for a substituted template parameter, though.
1913 // We never want to print 'E' directly after an unresolved-type,
1914 // so we return directly.
1918 mangleSourceNameWithAbiTags(cast<TypedefType>(Ty)->getDecl());
1921 case Type::UnresolvedUsing:
1922 mangleSourceNameWithAbiTags(
1923 cast<UnresolvedUsingType>(Ty)->getDecl());
1928 mangleSourceNameWithAbiTags(cast<TagType>(Ty)->getDecl());
1931 case Type::TemplateSpecialization: {
1932 const TemplateSpecializationType *TST =
1933 cast<TemplateSpecializationType>(Ty);
1934 TemplateName TN = TST->getTemplateName();
1935 switch (TN.getKind()) {
1936 case TemplateName::Template:
1937 case TemplateName::QualifiedTemplate: {
1938 TemplateDecl *TD = TN.getAsTemplateDecl();
1940 // If the base is a template template parameter, this is an
1942 assert(TD && "no template for template specialization type");
1943 if (isa<TemplateTemplateParmDecl>(TD))
1944 goto unresolvedType;
1946 mangleSourceNameWithAbiTags(TD);
1950 case TemplateName::OverloadedTemplate:
1951 case TemplateName::DependentTemplate:
1952 llvm_unreachable("invalid base for a template specialization type");
1954 case TemplateName::SubstTemplateTemplateParm: {
1955 SubstTemplateTemplateParmStorage *subst =
1956 TN.getAsSubstTemplateTemplateParm();
1957 mangleExistingSubstitution(subst->getReplacement());
1961 case TemplateName::SubstTemplateTemplateParmPack: {
1962 // FIXME: not clear how to mangle this!
1963 // template <template <class U> class T...> class A {
1964 // template <class U...> void foo(decltype(T<U>::foo) x...);
1966 Out << "_SUBSTPACK_";
1971 mangleTemplateArgs(TST->getArgs(), TST->getNumArgs());
1975 case Type::InjectedClassName:
1976 mangleSourceNameWithAbiTags(
1977 cast<InjectedClassNameType>(Ty)->getDecl());
1980 case Type::DependentName:
1981 mangleSourceName(cast<DependentNameType>(Ty)->getIdentifier());
1984 case Type::DependentTemplateSpecialization: {
1985 const DependentTemplateSpecializationType *DTST =
1986 cast<DependentTemplateSpecializationType>(Ty);
1987 mangleSourceName(DTST->getIdentifier());
1988 mangleTemplateArgs(DTST->getArgs(), DTST->getNumArgs());
1992 case Type::Elaborated:
1993 return mangleUnresolvedTypeOrSimpleId(
1994 cast<ElaboratedType>(Ty)->getNamedType(), Prefix);
2000 void CXXNameMangler::mangleOperatorName(DeclarationName Name, unsigned Arity) {
2001 switch (Name.getNameKind()) {
2002 case DeclarationName::CXXConstructorName:
2003 case DeclarationName::CXXDestructorName:
2004 case DeclarationName::CXXDeductionGuideName:
2005 case DeclarationName::CXXUsingDirective:
2006 case DeclarationName::Identifier:
2007 case DeclarationName::ObjCMultiArgSelector:
2008 case DeclarationName::ObjCOneArgSelector:
2009 case DeclarationName::ObjCZeroArgSelector:
2010 llvm_unreachable("Not an operator name");
2012 case DeclarationName::CXXConversionFunctionName:
2013 // <operator-name> ::= cv <type> # (cast)
2015 mangleType(Name.getCXXNameType());
2018 case DeclarationName::CXXLiteralOperatorName:
2020 mangleSourceName(Name.getCXXLiteralIdentifier());
2023 case DeclarationName::CXXOperatorName:
2024 mangleOperatorName(Name.getCXXOverloadedOperator(), Arity);
2030 CXXNameMangler::mangleOperatorName(OverloadedOperatorKind OO, unsigned Arity) {
2032 // <operator-name> ::= nw # new
2033 case OO_New: Out << "nw"; break;
2035 case OO_Array_New: Out << "na"; break;
2037 case OO_Delete: Out << "dl"; break;
2038 // ::= da # delete[]
2039 case OO_Array_Delete: Out << "da"; break;
2040 // ::= ps # + (unary)
2041 // ::= pl # + (binary or unknown)
2043 Out << (Arity == 1? "ps" : "pl"); break;
2044 // ::= ng # - (unary)
2045 // ::= mi # - (binary or unknown)
2047 Out << (Arity == 1? "ng" : "mi"); break;
2048 // ::= ad # & (unary)
2049 // ::= an # & (binary or unknown)
2051 Out << (Arity == 1? "ad" : "an"); break;
2052 // ::= de # * (unary)
2053 // ::= ml # * (binary or unknown)
2055 // Use binary when unknown.
2056 Out << (Arity == 1? "de" : "ml"); break;
2058 case OO_Tilde: Out << "co"; break;
2060 case OO_Slash: Out << "dv"; break;
2062 case OO_Percent: Out << "rm"; break;
2064 case OO_Pipe: Out << "or"; break;
2066 case OO_Caret: Out << "eo"; break;
2068 case OO_Equal: Out << "aS"; break;
2070 case OO_PlusEqual: Out << "pL"; break;
2072 case OO_MinusEqual: Out << "mI"; break;
2074 case OO_StarEqual: Out << "mL"; break;
2076 case OO_SlashEqual: Out << "dV"; break;
2078 case OO_PercentEqual: Out << "rM"; break;
2080 case OO_AmpEqual: Out << "aN"; break;
2082 case OO_PipeEqual: Out << "oR"; break;
2084 case OO_CaretEqual: Out << "eO"; break;
2086 case OO_LessLess: Out << "ls"; break;
2088 case OO_GreaterGreater: Out << "rs"; break;
2090 case OO_LessLessEqual: Out << "lS"; break;
2092 case OO_GreaterGreaterEqual: Out << "rS"; break;
2094 case OO_EqualEqual: Out << "eq"; break;
2096 case OO_ExclaimEqual: Out << "ne"; break;
2098 case OO_Less: Out << "lt"; break;
2100 case OO_Greater: Out << "gt"; break;
2102 case OO_LessEqual: Out << "le"; break;
2104 case OO_GreaterEqual: Out << "ge"; break;
2106 case OO_Exclaim: Out << "nt"; break;
2108 case OO_AmpAmp: Out << "aa"; break;
2110 case OO_PipePipe: Out << "oo"; break;
2112 case OO_PlusPlus: Out << "pp"; break;
2114 case OO_MinusMinus: Out << "mm"; break;
2116 case OO_Comma: Out << "cm"; break;
2118 case OO_ArrowStar: Out << "pm"; break;
2120 case OO_Arrow: Out << "pt"; break;
2122 case OO_Call: Out << "cl"; break;
2124 case OO_Subscript: Out << "ix"; break;
2127 // The conditional operator can't be overloaded, but we still handle it when
2128 // mangling expressions.
2129 case OO_Conditional: Out << "qu"; break;
2130 // Proposal on cxx-abi-dev, 2015-10-21.
2131 // ::= aw # co_await
2132 case OO_Coawait: Out << "aw"; break;
2135 case NUM_OVERLOADED_OPERATORS:
2136 llvm_unreachable("Not an overloaded operator");
2140 void CXXNameMangler::mangleQualifiers(Qualifiers Quals) {
2141 // Vendor qualifiers come first and if they are order-insensitive they must
2142 // be emitted in reversed alphabetical order, see Itanium ABI 5.1.5.
2144 // Address space qualifiers start with an ordinary letter.
2145 if (Quals.hasAddressSpace()) {
2146 // Address space extension:
2148 // <type> ::= U <target-addrspace>
2149 // <type> ::= U <OpenCL-addrspace>
2150 // <type> ::= U <CUDA-addrspace>
2152 SmallString<64> ASString;
2153 unsigned AS = Quals.getAddressSpace();
2155 if (Context.getASTContext().addressSpaceMapManglingFor(AS)) {
2156 // <target-addrspace> ::= "AS" <address-space-number>
2157 unsigned TargetAS = Context.getASTContext().getTargetAddressSpace(AS);
2158 ASString = "AS" + llvm::utostr(TargetAS);
2161 default: llvm_unreachable("Not a language specific address space");
2162 // <OpenCL-addrspace> ::= "CL" [ "global" | "local" | "constant |
2164 case LangAS::opencl_global: ASString = "CLglobal"; break;
2165 case LangAS::opencl_local: ASString = "CLlocal"; break;
2166 case LangAS::opencl_constant: ASString = "CLconstant"; break;
2167 case LangAS::opencl_generic: ASString = "CLgeneric"; break;
2168 // <CUDA-addrspace> ::= "CU" [ "device" | "constant" | "shared" ]
2169 case LangAS::cuda_device: ASString = "CUdevice"; break;
2170 case LangAS::cuda_constant: ASString = "CUconstant"; break;
2171 case LangAS::cuda_shared: ASString = "CUshared"; break;
2174 mangleVendorQualifier(ASString);
2177 // The ARC ownership qualifiers start with underscores.
2178 // Objective-C ARC Extension:
2180 // <type> ::= U "__strong"
2181 // <type> ::= U "__weak"
2182 // <type> ::= U "__autoreleasing"
2184 // Note: we emit __weak first to preserve the order as
2185 // required by the Itanium ABI.
2186 if (Quals.getObjCLifetime() == Qualifiers::OCL_Weak)
2187 mangleVendorQualifier("__weak");
2189 // __unaligned (from -fms-extensions)
2190 if (Quals.hasUnaligned())
2191 mangleVendorQualifier("__unaligned");
2193 // Remaining ARC ownership qualifiers.
2194 switch (Quals.getObjCLifetime()) {
2195 case Qualifiers::OCL_None:
2198 case Qualifiers::OCL_Weak:
2199 // Do nothing as we already handled this case above.
2202 case Qualifiers::OCL_Strong:
2203 mangleVendorQualifier("__strong");
2206 case Qualifiers::OCL_Autoreleasing:
2207 mangleVendorQualifier("__autoreleasing");
2210 case Qualifiers::OCL_ExplicitNone:
2211 // The __unsafe_unretained qualifier is *not* mangled, so that
2212 // __unsafe_unretained types in ARC produce the same manglings as the
2213 // equivalent (but, naturally, unqualified) types in non-ARC, providing
2214 // better ABI compatibility.
2216 // It's safe to do this because unqualified 'id' won't show up
2217 // in any type signatures that need to be mangled.
2221 // <CV-qualifiers> ::= [r] [V] [K] # restrict (C99), volatile, const
2222 if (Quals.hasRestrict())
2224 if (Quals.hasVolatile())
2226 if (Quals.hasConst())
2230 void CXXNameMangler::mangleVendorQualifier(StringRef name) {
2231 Out << 'U' << name.size() << name;
2234 void CXXNameMangler::mangleRefQualifier(RefQualifierKind RefQualifier) {
2235 // <ref-qualifier> ::= R # lvalue reference
2236 // ::= O # rvalue-reference
2237 switch (RefQualifier) {
2251 void CXXNameMangler::mangleObjCMethodName(const ObjCMethodDecl *MD) {
2252 Context.mangleObjCMethodName(MD, Out);
2255 static bool isTypeSubstitutable(Qualifiers Quals, const Type *Ty) {
2258 if (Ty->isSpecificBuiltinType(BuiltinType::ObjCSel))
2260 if (Ty->isOpenCLSpecificType())
2262 if (Ty->isBuiltinType())
2268 void CXXNameMangler::mangleType(QualType T) {
2269 // If our type is instantiation-dependent but not dependent, we mangle
2270 // it as it was written in the source, removing any top-level sugar.
2271 // Otherwise, use the canonical type.
2273 // FIXME: This is an approximation of the instantiation-dependent name
2274 // mangling rules, since we should really be using the type as written and
2275 // augmented via semantic analysis (i.e., with implicit conversions and
2276 // default template arguments) for any instantiation-dependent type.
2277 // Unfortunately, that requires several changes to our AST:
2278 // - Instantiation-dependent TemplateSpecializationTypes will need to be
2279 // uniqued, so that we can handle substitutions properly
2280 // - Default template arguments will need to be represented in the
2281 // TemplateSpecializationType, since they need to be mangled even though
2282 // they aren't written.
2283 // - Conversions on non-type template arguments need to be expressed, since
2284 // they can affect the mangling of sizeof/alignof.
2286 // FIXME: This is wrong when mapping to the canonical type for a dependent
2287 // type discards instantiation-dependent portions of the type, such as for:
2289 // template<typename T, int N> void f(T (&)[sizeof(N)]);
2290 // template<typename T> void f(T() throw(typename T::type)); (pre-C++17)
2292 // It's also wrong in the opposite direction when instantiation-dependent,
2293 // canonically-equivalent types differ in some irrelevant portion of inner
2294 // type sugar. In such cases, we fail to form correct substitutions, eg:
2296 // template<int N> void f(A<sizeof(N)> *, A<sizeof(N)> (*));
2298 // We should instead canonicalize the non-instantiation-dependent parts,
2299 // regardless of whether the type as a whole is dependent or instantiation
2301 if (!T->isInstantiationDependentType() || T->isDependentType())
2302 T = T.getCanonicalType();
2304 // Desugar any types that are purely sugar.
2306 // Don't desugar through template specialization types that aren't
2307 // type aliases. We need to mangle the template arguments as written.
2308 if (const TemplateSpecializationType *TST
2309 = dyn_cast<TemplateSpecializationType>(T))
2310 if (!TST->isTypeAlias())
2314 = T.getSingleStepDesugaredType(Context.getASTContext());
2321 SplitQualType split = T.split();
2322 Qualifiers quals = split.Quals;
2323 const Type *ty = split.Ty;
2325 bool isSubstitutable = isTypeSubstitutable(quals, ty);
2326 if (isSubstitutable && mangleSubstitution(T))
2329 // If we're mangling a qualified array type, push the qualifiers to
2330 // the element type.
2331 if (quals && isa<ArrayType>(T)) {
2332 ty = Context.getASTContext().getAsArrayType(T);
2333 quals = Qualifiers();
2335 // Note that we don't update T: we want to add the
2336 // substitution at the original type.
2340 mangleQualifiers(quals);
2341 // Recurse: even if the qualified type isn't yet substitutable,
2342 // the unqualified type might be.
2343 mangleType(QualType(ty, 0));
2345 switch (ty->getTypeClass()) {
2346 #define ABSTRACT_TYPE(CLASS, PARENT)
2347 #define NON_CANONICAL_TYPE(CLASS, PARENT) \
2349 llvm_unreachable("can't mangle non-canonical type " #CLASS "Type"); \
2351 #define TYPE(CLASS, PARENT) \
2353 mangleType(static_cast<const CLASS##Type*>(ty)); \
2355 #include "clang/AST/TypeNodes.def"
2359 // Add the substitution.
2360 if (isSubstitutable)
2364 void CXXNameMangler::mangleNameOrStandardSubstitution(const NamedDecl *ND) {
2365 if (!mangleStandardSubstitution(ND))
2369 void CXXNameMangler::mangleType(const BuiltinType *T) {
2370 // <type> ::= <builtin-type>
2371 // <builtin-type> ::= v # void
2375 // ::= a # signed char
2376 // ::= h # unsigned char
2378 // ::= t # unsigned short
2380 // ::= j # unsigned int
2382 // ::= m # unsigned long
2383 // ::= x # long long, __int64
2384 // ::= y # unsigned long long, __int64
2386 // ::= o # unsigned __int128
2389 // ::= e # long double, __float80
2390 // ::= g # __float128
2391 // UNSUPPORTED: ::= Dd # IEEE 754r decimal floating point (64 bits)
2392 // UNSUPPORTED: ::= De # IEEE 754r decimal floating point (128 bits)
2393 // UNSUPPORTED: ::= Df # IEEE 754r decimal floating point (32 bits)
2394 // ::= Dh # IEEE 754r half-precision floating point (16 bits)
2395 // ::= Di # char32_t
2396 // ::= Ds # char16_t
2397 // ::= Dn # std::nullptr_t (i.e., decltype(nullptr))
2398 // ::= u <source-name> # vendor extended type
2399 std::string type_name;
2400 switch (T->getKind()) {
2401 case BuiltinType::Void:
2404 case BuiltinType::Bool:
2407 case BuiltinType::Char_U:
2408 case BuiltinType::Char_S:
2411 case BuiltinType::UChar:
2414 case BuiltinType::UShort:
2417 case BuiltinType::UInt:
2420 case BuiltinType::ULong:
2423 case BuiltinType::ULongLong:
2426 case BuiltinType::UInt128:
2429 case BuiltinType::SChar:
2432 case BuiltinType::WChar_S:
2433 case BuiltinType::WChar_U:
2436 case BuiltinType::Char16:
2439 case BuiltinType::Char32:
2442 case BuiltinType::Short:
2445 case BuiltinType::Int:
2448 case BuiltinType::Long:
2451 case BuiltinType::LongLong:
2454 case BuiltinType::Int128:
2457 case BuiltinType::Half:
2460 case BuiltinType::Float:
2463 case BuiltinType::Double:
2466 case BuiltinType::LongDouble:
2467 Out << (getASTContext().getTargetInfo().useFloat128ManglingForLongDouble()
2471 case BuiltinType::Float128:
2472 if (getASTContext().getTargetInfo().useFloat128ManglingForLongDouble())
2473 Out << "U10__float128"; // Match the GCC mangling
2477 case BuiltinType::NullPtr:
2481 #define BUILTIN_TYPE(Id, SingletonId)
2482 #define PLACEHOLDER_TYPE(Id, SingletonId) \
2483 case BuiltinType::Id:
2484 #include "clang/AST/BuiltinTypes.def"
2485 case BuiltinType::Dependent:
2487 llvm_unreachable("mangling a placeholder type");
2489 case BuiltinType::ObjCId:
2490 Out << "11objc_object";
2492 case BuiltinType::ObjCClass:
2493 Out << "10objc_class";
2495 case BuiltinType::ObjCSel:
2496 Out << "13objc_selector";
2498 #define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
2499 case BuiltinType::Id: \
2500 type_name = "ocl_" #ImgType "_" #Suffix; \
2501 Out << type_name.size() << type_name; \
2503 #include "clang/Basic/OpenCLImageTypes.def"
2504 case BuiltinType::OCLSampler:
2505 Out << "11ocl_sampler";
2507 case BuiltinType::OCLEvent:
2508 Out << "9ocl_event";
2510 case BuiltinType::OCLClkEvent:
2511 Out << "12ocl_clkevent";
2513 case BuiltinType::OCLQueue:
2514 Out << "9ocl_queue";
2516 case BuiltinType::OCLReserveID:
2517 Out << "13ocl_reserveid";
2522 StringRef CXXNameMangler::getCallingConvQualifierName(CallingConv CC) {
2528 case CC_X86FastCall:
2529 case CC_X86ThisCall:
2530 case CC_X86VectorCall:
2532 case CC_X86_64Win64:
2537 case CC_IntelOclBicc:
2538 case CC_SpirFunction:
2539 case CC_OpenCLKernel:
2540 case CC_PreserveMost:
2541 case CC_PreserveAll:
2542 // FIXME: we should be mangling all of the above.
2548 llvm_unreachable("bad calling convention");
2551 void CXXNameMangler::mangleExtFunctionInfo(const FunctionType *T) {
2553 if (T->getExtInfo() == FunctionType::ExtInfo())
2556 // Vendor-specific qualifiers are emitted in reverse alphabetical order.
2557 // This will get more complicated in the future if we mangle other
2558 // things here; but for now, since we mangle ns_returns_retained as
2559 // a qualifier on the result type, we can get away with this:
2560 StringRef CCQualifier = getCallingConvQualifierName(T->getExtInfo().getCC());
2561 if (!CCQualifier.empty())
2562 mangleVendorQualifier(CCQualifier);
2569 CXXNameMangler::mangleExtParameterInfo(FunctionProtoType::ExtParameterInfo PI) {
2570 // Vendor-specific qualifiers are emitted in reverse alphabetical order.
2572 // Note that these are *not* substitution candidates. Demanglers might
2573 // have trouble with this if the parameter type is fully substituted.
2575 switch (PI.getABI()) {
2576 case ParameterABI::Ordinary:
2579 // All of these start with "swift", so they come before "ns_consumed".
2580 case ParameterABI::SwiftContext:
2581 case ParameterABI::SwiftErrorResult:
2582 case ParameterABI::SwiftIndirectResult:
2583 mangleVendorQualifier(getParameterABISpelling(PI.getABI()));
2587 if (PI.isConsumed())
2588 mangleVendorQualifier("ns_consumed");
2591 // <type> ::= <function-type>
2592 // <function-type> ::= [<CV-qualifiers>] F [Y]
2593 // <bare-function-type> [<ref-qualifier>] E
2594 void CXXNameMangler::mangleType(const FunctionProtoType *T) {
2595 mangleExtFunctionInfo(T);
2597 // Mangle CV-qualifiers, if present. These are 'this' qualifiers,
2598 // e.g. "const" in "int (A::*)() const".
2599 mangleQualifiers(Qualifiers::fromCVRMask(T->getTypeQuals()));
2601 // Mangle instantiation-dependent exception-specification, if present,
2602 // per cxx-abi-dev proposal on 2016-10-11.
2603 if (T->hasInstantiationDependentExceptionSpec()) {
2604 if (T->getExceptionSpecType() == EST_ComputedNoexcept) {
2606 mangleExpression(T->getNoexceptExpr());
2609 assert(T->getExceptionSpecType() == EST_Dynamic);
2611 for (auto ExceptTy : T->exceptions())
2612 mangleType(ExceptTy);
2615 } else if (T->isNothrow(getASTContext())) {
2621 // FIXME: We don't have enough information in the AST to produce the 'Y'
2622 // encoding for extern "C" function types.
2623 mangleBareFunctionType(T, /*MangleReturnType=*/true);
2625 // Mangle the ref-qualifier, if present.
2626 mangleRefQualifier(T->getRefQualifier());
2631 void CXXNameMangler::mangleType(const FunctionNoProtoType *T) {
2632 // Function types without prototypes can arise when mangling a function type
2633 // within an overloadable function in C. We mangle these as the absence of any
2634 // parameter types (not even an empty parameter list).
2637 FunctionTypeDepthState saved = FunctionTypeDepth.push();
2639 FunctionTypeDepth.enterResultType();
2640 mangleType(T->getReturnType());
2641 FunctionTypeDepth.leaveResultType();
2643 FunctionTypeDepth.pop(saved);
2647 void CXXNameMangler::mangleBareFunctionType(const FunctionProtoType *Proto,
2648 bool MangleReturnType,
2649 const FunctionDecl *FD) {
2650 // Record that we're in a function type. See mangleFunctionParam
2651 // for details on what we're trying to achieve here.
2652 FunctionTypeDepthState saved = FunctionTypeDepth.push();
2654 // <bare-function-type> ::= <signature type>+
2655 if (MangleReturnType) {
2656 FunctionTypeDepth.enterResultType();
2658 // Mangle ns_returns_retained as an order-sensitive qualifier here.
2659 if (Proto->getExtInfo().getProducesResult() && FD == nullptr)
2660 mangleVendorQualifier("ns_returns_retained");
2662 // Mangle the return type without any direct ARC ownership qualifiers.
2663 QualType ReturnTy = Proto->getReturnType();
2664 if (ReturnTy.getObjCLifetime()) {
2665 auto SplitReturnTy = ReturnTy.split();
2666 SplitReturnTy.Quals.removeObjCLifetime();
2667 ReturnTy = getASTContext().getQualifiedType(SplitReturnTy);
2669 mangleType(ReturnTy);
2671 FunctionTypeDepth.leaveResultType();
2674 if (Proto->getNumParams() == 0 && !Proto->isVariadic()) {
2675 // <builtin-type> ::= v # void
2678 FunctionTypeDepth.pop(saved);
2682 assert(!FD || FD->getNumParams() == Proto->getNumParams());
2683 for (unsigned I = 0, E = Proto->getNumParams(); I != E; ++I) {
2684 // Mangle extended parameter info as order-sensitive qualifiers here.
2685 if (Proto->hasExtParameterInfos() && FD == nullptr) {
2686 mangleExtParameterInfo(Proto->getExtParameterInfo(I));
2690 QualType ParamTy = Proto->getParamType(I);
2691 mangleType(Context.getASTContext().getSignatureParameterType(ParamTy));
2694 if (auto *Attr = FD->getParamDecl(I)->getAttr<PassObjectSizeAttr>()) {
2695 // Attr can only take 1 character, so we can hardcode the length below.
2696 assert(Attr->getType() <= 9 && Attr->getType() >= 0);
2697 Out << "U17pass_object_size" << Attr->getType();
2702 FunctionTypeDepth.pop(saved);
2704 // <builtin-type> ::= z # ellipsis
2705 if (Proto->isVariadic())
2709 // <type> ::= <class-enum-type>
2710 // <class-enum-type> ::= <name>
2711 void CXXNameMangler::mangleType(const UnresolvedUsingType *T) {
2712 mangleName(T->getDecl());
2715 // <type> ::= <class-enum-type>
2716 // <class-enum-type> ::= <name>
2717 void CXXNameMangler::mangleType(const EnumType *T) {
2718 mangleType(static_cast<const TagType*>(T));
2720 void CXXNameMangler::mangleType(const RecordType *T) {
2721 mangleType(static_cast<const TagType*>(T));
2723 void CXXNameMangler::mangleType(const TagType *T) {
2724 mangleName(T->getDecl());
2727 // <type> ::= <array-type>
2728 // <array-type> ::= A <positive dimension number> _ <element type>
2729 // ::= A [<dimension expression>] _ <element type>
2730 void CXXNameMangler::mangleType(const ConstantArrayType *T) {
2731 Out << 'A' << T->getSize() << '_';
2732 mangleType(T->getElementType());
2734 void CXXNameMangler::mangleType(const VariableArrayType *T) {
2736 // decayed vla types (size 0) will just be skipped.
2737 if (T->getSizeExpr())
2738 mangleExpression(T->getSizeExpr());
2740 mangleType(T->getElementType());
2742 void CXXNameMangler::mangleType(const DependentSizedArrayType *T) {
2744 mangleExpression(T->getSizeExpr());
2746 mangleType(T->getElementType());
2748 void CXXNameMangler::mangleType(const IncompleteArrayType *T) {
2750 mangleType(T->getElementType());
2753 // <type> ::= <pointer-to-member-type>
2754 // <pointer-to-member-type> ::= M <class type> <member type>
2755 void CXXNameMangler::mangleType(const MemberPointerType *T) {
2757 mangleType(QualType(T->getClass(), 0));
2758 QualType PointeeType = T->getPointeeType();
2759 if (const FunctionProtoType *FPT = dyn_cast<FunctionProtoType>(PointeeType)) {
2762 // Itanium C++ ABI 5.1.8:
2764 // The type of a non-static member function is considered to be different,
2765 // for the purposes of substitution, from the type of a namespace-scope or
2766 // static member function whose type appears similar. The types of two
2767 // non-static member functions are considered to be different, for the
2768 // purposes of substitution, if the functions are members of different
2769 // classes. In other words, for the purposes of substitution, the class of
2770 // which the function is a member is considered part of the type of
2773 // Given that we already substitute member function pointers as a
2774 // whole, the net effect of this rule is just to unconditionally
2775 // suppress substitution on the function type in a member pointer.
2776 // We increment the SeqID here to emulate adding an entry to the
2777 // substitution table.
2780 mangleType(PointeeType);
2783 // <type> ::= <template-param>
2784 void CXXNameMangler::mangleType(const TemplateTypeParmType *T) {
2785 mangleTemplateParameter(T->getIndex());
2788 // <type> ::= <template-param>
2789 void CXXNameMangler::mangleType(const SubstTemplateTypeParmPackType *T) {
2790 // FIXME: not clear how to mangle this!
2791 // template <class T...> class A {
2792 // template <class U...> void foo(T(*)(U) x...);
2794 Out << "_SUBSTPACK_";
2797 // <type> ::= P <type> # pointer-to
2798 void CXXNameMangler::mangleType(const PointerType *T) {
2800 mangleType(T->getPointeeType());
2802 void CXXNameMangler::mangleType(const ObjCObjectPointerType *T) {
2804 mangleType(T->getPointeeType());
2807 // <type> ::= R <type> # reference-to
2808 void CXXNameMangler::mangleType(const LValueReferenceType *T) {
2810 mangleType(T->getPointeeType());
2813 // <type> ::= O <type> # rvalue reference-to (C++0x)
2814 void CXXNameMangler::mangleType(const RValueReferenceType *T) {
2816 mangleType(T->getPointeeType());
2819 // <type> ::= C <type> # complex pair (C 2000)
2820 void CXXNameMangler::mangleType(const ComplexType *T) {
2822 mangleType(T->getElementType());
2825 // ARM's ABI for Neon vector types specifies that they should be mangled as
2826 // if they are structs (to match ARM's initial implementation). The
2827 // vector type must be one of the special types predefined by ARM.
2828 void CXXNameMangler::mangleNeonVectorType(const VectorType *T) {
2829 QualType EltType = T->getElementType();
2830 assert(EltType->isBuiltinType() && "Neon vector element not a BuiltinType");
2831 const char *EltName = nullptr;
2832 if (T->getVectorKind() == VectorType::NeonPolyVector) {
2833 switch (cast<BuiltinType>(EltType)->getKind()) {
2834 case BuiltinType::SChar:
2835 case BuiltinType::UChar:
2836 EltName = "poly8_t";
2838 case BuiltinType::Short:
2839 case BuiltinType::UShort:
2840 EltName = "poly16_t";
2842 case BuiltinType::ULongLong:
2843 EltName = "poly64_t";
2845 default: llvm_unreachable("unexpected Neon polynomial vector element type");
2848 switch (cast<BuiltinType>(EltType)->getKind()) {
2849 case BuiltinType::SChar: EltName = "int8_t"; break;
2850 case BuiltinType::UChar: EltName = "uint8_t"; break;
2851 case BuiltinType::Short: EltName = "int16_t"; break;
2852 case BuiltinType::UShort: EltName = "uint16_t"; break;
2853 case BuiltinType::Int: EltName = "int32_t"; break;
2854 case BuiltinType::UInt: EltName = "uint32_t"; break;
2855 case BuiltinType::LongLong: EltName = "int64_t"; break;
2856 case BuiltinType::ULongLong: EltName = "uint64_t"; break;
2857 case BuiltinType::Double: EltName = "float64_t"; break;
2858 case BuiltinType::Float: EltName = "float32_t"; break;
2859 case BuiltinType::Half: EltName = "float16_t";break;
2861 llvm_unreachable("unexpected Neon vector element type");
2864 const char *BaseName = nullptr;
2865 unsigned BitSize = (T->getNumElements() *
2866 getASTContext().getTypeSize(EltType));
2868 BaseName = "__simd64_";
2870 assert(BitSize == 128 && "Neon vector type not 64 or 128 bits");
2871 BaseName = "__simd128_";
2873 Out << strlen(BaseName) + strlen(EltName);
2874 Out << BaseName << EltName;
2877 static StringRef mangleAArch64VectorBase(const BuiltinType *EltType) {
2878 switch (EltType->getKind()) {
2879 case BuiltinType::SChar:
2881 case BuiltinType::Short:
2883 case BuiltinType::Int:
2885 case BuiltinType::Long:
2886 case BuiltinType::LongLong:
2888 case BuiltinType::UChar:
2890 case BuiltinType::UShort:
2892 case BuiltinType::UInt:
2894 case BuiltinType::ULong:
2895 case BuiltinType::ULongLong:
2897 case BuiltinType::Half:
2899 case BuiltinType::Float:
2901 case BuiltinType::Double:
2904 llvm_unreachable("Unexpected vector element base type");
2908 // AArch64's ABI for Neon vector types specifies that they should be mangled as
2909 // the equivalent internal name. The vector type must be one of the special
2910 // types predefined by ARM.
2911 void CXXNameMangler::mangleAArch64NeonVectorType(const VectorType *T) {
2912 QualType EltType = T->getElementType();
2913 assert(EltType->isBuiltinType() && "Neon vector element not a BuiltinType");
2915 (T->getNumElements() * getASTContext().getTypeSize(EltType));
2916 (void)BitSize; // Silence warning.
2918 assert((BitSize == 64 || BitSize == 128) &&
2919 "Neon vector type not 64 or 128 bits");
2922 if (T->getVectorKind() == VectorType::NeonPolyVector) {
2923 switch (cast<BuiltinType>(EltType)->getKind()) {
2924 case BuiltinType::UChar:
2927 case BuiltinType::UShort:
2930 case BuiltinType::ULong:
2931 case BuiltinType::ULongLong:
2935 llvm_unreachable("unexpected Neon polynomial vector element type");
2938 EltName = mangleAArch64VectorBase(cast<BuiltinType>(EltType));
2940 std::string TypeName =
2941 ("__" + EltName + "x" + Twine(T->getNumElements()) + "_t").str();
2942 Out << TypeName.length() << TypeName;
2945 // GNU extension: vector types
2946 // <type> ::= <vector-type>
2947 // <vector-type> ::= Dv <positive dimension number> _
2948 // <extended element type>
2949 // ::= Dv [<dimension expression>] _ <element type>
2950 // <extended element type> ::= <element type>
2951 // ::= p # AltiVec vector pixel
2952 // ::= b # Altivec vector bool
2953 void CXXNameMangler::mangleType(const VectorType *T) {
2954 if ((T->getVectorKind() == VectorType::NeonVector ||
2955 T->getVectorKind() == VectorType::NeonPolyVector)) {
2956 llvm::Triple Target = getASTContext().getTargetInfo().getTriple();
2957 llvm::Triple::ArchType Arch =
2958 getASTContext().getTargetInfo().getTriple().getArch();
2959 if ((Arch == llvm::Triple::aarch64 ||
2960 Arch == llvm::Triple::aarch64_be) && !Target.isOSDarwin())
2961 mangleAArch64NeonVectorType(T);
2963 mangleNeonVectorType(T);
2966 Out << "Dv" << T->getNumElements() << '_';
2967 if (T->getVectorKind() == VectorType::AltiVecPixel)
2969 else if (T->getVectorKind() == VectorType::AltiVecBool)
2972 mangleType(T->getElementType());
2974 void CXXNameMangler::mangleType(const ExtVectorType *T) {
2975 mangleType(static_cast<const VectorType*>(T));
2977 void CXXNameMangler::mangleType(const DependentSizedExtVectorType *T) {
2979 mangleExpression(T->getSizeExpr());
2981 mangleType(T->getElementType());
2984 void CXXNameMangler::mangleType(const PackExpansionType *T) {
2985 // <type> ::= Dp <type> # pack expansion (C++0x)
2987 mangleType(T->getPattern());
2990 void CXXNameMangler::mangleType(const ObjCInterfaceType *T) {
2991 mangleSourceName(T->getDecl()->getIdentifier());
2994 void CXXNameMangler::mangleType(const ObjCObjectType *T) {
2995 // Treat __kindof as a vendor extended type qualifier.
2996 if (T->isKindOfType())
2997 Out << "U8__kindof";
2999 if (!T->qual_empty()) {
3000 // Mangle protocol qualifiers.
3001 SmallString<64> QualStr;
3002 llvm::raw_svector_ostream QualOS(QualStr);
3003 QualOS << "objcproto";
3004 for (const auto *I : T->quals()) {
3005 StringRef name = I->getName();
3006 QualOS << name.size() << name;
3008 Out << 'U' << QualStr.size() << QualStr;
3011 mangleType(T->getBaseType());
3013 if (T->isSpecialized()) {
3014 // Mangle type arguments as I <type>+ E
3016 for (auto typeArg : T->getTypeArgs())
3017 mangleType(typeArg);
3022 void CXXNameMangler::mangleType(const BlockPointerType *T) {
3023 Out << "U13block_pointer";
3024 mangleType(T->getPointeeType());
3027 void CXXNameMangler::mangleType(const InjectedClassNameType *T) {
3028 // Mangle injected class name types as if the user had written the
3029 // specialization out fully. It may not actually be possible to see
3030 // this mangling, though.
3031 mangleType(T->getInjectedSpecializationType());
3034 void CXXNameMangler::mangleType(const TemplateSpecializationType *T) {
3035 if (TemplateDecl *TD = T->getTemplateName().getAsTemplateDecl()) {
3036 mangleTemplateName(TD, T->getArgs(), T->getNumArgs());
3038 if (mangleSubstitution(QualType(T, 0)))
3041 mangleTemplatePrefix(T->getTemplateName());
3043 // FIXME: GCC does not appear to mangle the template arguments when
3044 // the template in question is a dependent template name. Should we
3045 // emulate that badness?
3046 mangleTemplateArgs(T->getArgs(), T->getNumArgs());
3047 addSubstitution(QualType(T, 0));
3051 void CXXNameMangler::mangleType(const DependentNameType *T) {
3052 // Proposal by cxx-abi-dev, 2014-03-26
3053 // <class-enum-type> ::= <name> # non-dependent or dependent type name or
3054 // # dependent elaborated type specifier using
3056 // ::= Ts <name> # dependent elaborated type specifier using
3057 // # 'struct' or 'class'
3058 // ::= Tu <name> # dependent elaborated type specifier using
3060 // ::= Te <name> # dependent elaborated type specifier using
3062 switch (T->getKeyword()) {
3078 // Typename types are always nested
3080 manglePrefix(T->getQualifier());
3081 mangleSourceName(T->getIdentifier());
3085 void CXXNameMangler::mangleType(const DependentTemplateSpecializationType *T) {
3086 // Dependently-scoped template types are nested if they have a prefix.
3089 // TODO: avoid making this TemplateName.
3090 TemplateName Prefix =
3091 getASTContext().getDependentTemplateName(T->getQualifier(),
3092 T->getIdentifier());
3093 mangleTemplatePrefix(Prefix);
3095 // FIXME: GCC does not appear to mangle the template arguments when
3096 // the template in question is a dependent template name. Should we
3097 // emulate that badness?
3098 mangleTemplateArgs(T->getArgs(), T->getNumArgs());
3102 void CXXNameMangler::mangleType(const TypeOfType *T) {
3103 // FIXME: this is pretty unsatisfactory, but there isn't an obvious
3104 // "extension with parameters" mangling.
3108 void CXXNameMangler::mangleType(const TypeOfExprType *T) {
3109 // FIXME: this is pretty unsatisfactory, but there isn't an obvious
3110 // "extension with parameters" mangling.
3114 void CXXNameMangler::mangleType(const DecltypeType *T) {
3115 Expr *E = T->getUnderlyingExpr();
3117 // type ::= Dt <expression> E # decltype of an id-expression
3118 // # or class member access
3119 // ::= DT <expression> E # decltype of an expression
3121 // This purports to be an exhaustive list of id-expressions and
3122 // class member accesses. Note that we do not ignore parentheses;
3123 // parentheses change the semantics of decltype for these
3124 // expressions (and cause the mangler to use the other form).
3125 if (isa<DeclRefExpr>(E) ||
3126 isa<MemberExpr>(E) ||
3127 isa<UnresolvedLookupExpr>(E) ||
3128 isa<DependentScopeDeclRefExpr>(E) ||
3129 isa<CXXDependentScopeMemberExpr>(E) ||
3130 isa<UnresolvedMemberExpr>(E))
3134 mangleExpression(E);
3138 void CXXNameMangler::mangleType(const UnaryTransformType *T) {
3139 // If this is dependent, we need to record that. If not, we simply
3140 // mangle it as the underlying type since they are equivalent.
3141 if (T->isDependentType()) {
3144 switch (T->getUTTKind()) {
3145 case UnaryTransformType::EnumUnderlyingType:
3151 mangleType(T->getBaseType());
3154 void CXXNameMangler::mangleType(const AutoType *T) {
3155 QualType D = T->getDeducedType();
3156 // <builtin-type> ::= Da # dependent auto
3158 assert(T->getKeyword() != AutoTypeKeyword::GNUAutoType &&
3159 "shouldn't need to mangle __auto_type!");
3160 Out << (T->isDecltypeAuto() ? "Dc" : "Da");
3165 void CXXNameMangler::mangleType(const DeducedTemplateSpecializationType *T) {
3166 // FIXME: This is not the right mangling. We also need to include a scope
3167 // here in some cases.
3168 QualType D = T->getDeducedType();
3170 mangleUnscopedTemplateName(T->getTemplateName(), nullptr);
3175 void CXXNameMangler::mangleType(const AtomicType *T) {
3176 // <type> ::= U <source-name> <type> # vendor extended type qualifier
3177 // (Until there's a standardized mangling...)
3179 mangleType(T->getValueType());
3182 void CXXNameMangler::mangleType(const PipeType *T) {
3183 // Pipe type mangling rules are described in SPIR 2.0 specification
3184 // A.1 Data types and A.3 Summary of changes
3185 // <type> ::= 8ocl_pipe
3189 void CXXNameMangler::mangleIntegerLiteral(QualType T,
3190 const llvm::APSInt &Value) {
3191 // <expr-primary> ::= L <type> <value number> E # integer literal
3195 if (T->isBooleanType()) {
3196 // Boolean values are encoded as 0/1.
3197 Out << (Value.getBoolValue() ? '1' : '0');
3199 mangleNumber(Value);
3205 void CXXNameMangler::mangleMemberExprBase(const Expr *Base, bool IsArrow) {
3206 // Ignore member expressions involving anonymous unions.
3207 while (const auto *RT = Base->getType()->getAs<RecordType>()) {
3208 if (!RT->getDecl()->isAnonymousStructOrUnion())
3210 const auto *ME = dyn_cast<MemberExpr>(Base);
3213 Base = ME->getBase();
3214 IsArrow = ME->isArrow();
3217 if (Base->isImplicitCXXThis()) {
3218 // Note: GCC mangles member expressions to the implicit 'this' as
3219 // *this., whereas we represent them as this->. The Itanium C++ ABI
3220 // does not specify anything here, so we follow GCC.
3223 Out << (IsArrow ? "pt" : "dt");
3224 mangleExpression(Base);
3228 /// Mangles a member expression.
3229 void CXXNameMangler::mangleMemberExpr(const Expr *base,
3231 NestedNameSpecifier *qualifier,
3232 NamedDecl *firstQualifierLookup,
3233 DeclarationName member,
3234 const TemplateArgumentLoc *TemplateArgs,
3235 unsigned NumTemplateArgs,
3237 // <expression> ::= dt <expression> <unresolved-name>
3238 // ::= pt <expression> <unresolved-name>
3240 mangleMemberExprBase(base, isArrow);
3241 mangleUnresolvedName(qualifier, member, TemplateArgs, NumTemplateArgs, arity);
3244 /// Look at the callee of the given call expression and determine if
3245 /// it's a parenthesized id-expression which would have triggered ADL
3247 static bool isParenthesizedADLCallee(const CallExpr *call) {
3248 const Expr *callee = call->getCallee();
3249 const Expr *fn = callee->IgnoreParens();
3251 // Must be parenthesized. IgnoreParens() skips __extension__ nodes,
3252 // too, but for those to appear in the callee, it would have to be
3254 if (callee == fn) return false;
3256 // Must be an unresolved lookup.
3257 const UnresolvedLookupExpr *lookup = dyn_cast<UnresolvedLookupExpr>(fn);
3258 if (!lookup) return false;
3260 assert(!lookup->requiresADL());
3262 // Must be an unqualified lookup.
3263 if (lookup->getQualifier()) return false;
3265 // Must not have found a class member. Note that if one is a class
3266 // member, they're all class members.
3267 if (lookup->getNumDecls() > 0 &&
3268 (*lookup->decls_begin())->isCXXClassMember())
3271 // Otherwise, ADL would have been triggered.
3275 void CXXNameMangler::mangleCastExpression(const Expr *E, StringRef CastEncoding) {
3276 const ExplicitCastExpr *ECE = cast<ExplicitCastExpr>(E);
3277 Out << CastEncoding;
3278 mangleType(ECE->getType());
3279 mangleExpression(ECE->getSubExpr());
3282 void CXXNameMangler::mangleInitListElements(const InitListExpr *InitList) {
3283 if (auto *Syntactic = InitList->getSyntacticForm())
3284 InitList = Syntactic;
3285 for (unsigned i = 0, e = InitList->getNumInits(); i != e; ++i)
3286 mangleExpression(InitList->getInit(i));
3289 void CXXNameMangler::mangleExpression(const Expr *E, unsigned Arity) {
3290 // <expression> ::= <unary operator-name> <expression>
3291 // ::= <binary operator-name> <expression> <expression>
3292 // ::= <trinary operator-name> <expression> <expression> <expression>
3293 // ::= cv <type> expression # conversion with one argument
3294 // ::= cv <type> _ <expression>* E # conversion with a different number of arguments
3295 // ::= dc <type> <expression> # dynamic_cast<type> (expression)
3296 // ::= sc <type> <expression> # static_cast<type> (expression)
3297 // ::= cc <type> <expression> # const_cast<type> (expression)
3298 // ::= rc <type> <expression> # reinterpret_cast<type> (expression)
3299 // ::= st <type> # sizeof (a type)
3300 // ::= at <type> # alignof (a type)
3301 // ::= <template-param>
3302 // ::= <function-param>
3303 // ::= sr <type> <unqualified-name> # dependent name
3304 // ::= sr <type> <unqualified-name> <template-args> # dependent template-id
3305 // ::= ds <expression> <expression> # expr.*expr
3306 // ::= sZ <template-param> # size of a parameter pack
3307 // ::= sZ <function-param> # size of a function parameter pack
3308 // ::= <expr-primary>
3309 // <expr-primary> ::= L <type> <value number> E # integer literal
3310 // ::= L <type <value float> E # floating literal
3311 // ::= L <mangled-name> E # external name
3312 // ::= fpT # 'this' expression
3313 QualType ImplicitlyConvertedToType;
3316 switch (E->getStmtClass()) {
3317 case Expr::NoStmtClass:
3318 #define ABSTRACT_STMT(Type)
3319 #define EXPR(Type, Base)
3320 #define STMT(Type, Base) \
3321 case Expr::Type##Class:
3322 #include "clang/AST/StmtNodes.inc"
3325 // These all can only appear in local or variable-initialization
3326 // contexts and so should never appear in a mangling.
3327 case Expr::AddrLabelExprClass:
3328 case Expr::DesignatedInitUpdateExprClass:
3329 case Expr::ImplicitValueInitExprClass:
3330 case Expr::ArrayInitLoopExprClass:
3331 case Expr::ArrayInitIndexExprClass:
3332 case Expr::NoInitExprClass:
3333 case Expr::ParenListExprClass:
3334 case Expr::LambdaExprClass:
3335 case Expr::MSPropertyRefExprClass:
3336 case Expr::MSPropertySubscriptExprClass:
3337 case Expr::TypoExprClass: // This should no longer exist in the AST by now.
3338 case Expr::OMPArraySectionExprClass:
3339 case Expr::CXXInheritedCtorInitExprClass:
3340 llvm_unreachable("unexpected statement kind");
3342 // FIXME: invent manglings for all these.
3343 case Expr::BlockExprClass:
3344 case Expr::ChooseExprClass:
3345 case Expr::CompoundLiteralExprClass:
3346 case Expr::DesignatedInitExprClass:
3347 case Expr::ExtVectorElementExprClass:
3348 case Expr::GenericSelectionExprClass:
3349 case Expr::ObjCEncodeExprClass:
3350 case Expr::ObjCIsaExprClass:
3351 case Expr::ObjCIvarRefExprClass:
3352 case Expr::ObjCMessageExprClass:
3353 case Expr::ObjCPropertyRefExprClass:
3354 case Expr::ObjCProtocolExprClass:
3355 case Expr::ObjCSelectorExprClass:
3356 case Expr::ObjCStringLiteralClass:
3357 case Expr::ObjCBoxedExprClass:
3358 case Expr::ObjCArrayLiteralClass:
3359 case Expr::ObjCDictionaryLiteralClass:
3360 case Expr::ObjCSubscriptRefExprClass:
3361 case Expr::ObjCIndirectCopyRestoreExprClass:
3362 case Expr::ObjCAvailabilityCheckExprClass:
3363 case Expr::OffsetOfExprClass:
3364 case Expr::PredefinedExprClass:
3365 case Expr::ShuffleVectorExprClass:
3366 case Expr::ConvertVectorExprClass:
3367 case Expr::StmtExprClass:
3368 case Expr::TypeTraitExprClass:
3369 case Expr::ArrayTypeTraitExprClass:
3370 case Expr::ExpressionTraitExprClass:
3371 case Expr::VAArgExprClass:
3372 case Expr::CUDAKernelCallExprClass:
3373 case Expr::AsTypeExprClass:
3374 case Expr::PseudoObjectExprClass:
3375 case Expr::AtomicExprClass:
3378 // As bad as this diagnostic is, it's better than crashing.
3379 DiagnosticsEngine &Diags = Context.getDiags();
3380 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
3381 "cannot yet mangle expression type %0");
3382 Diags.Report(E->getExprLoc(), DiagID)
3383 << E->getStmtClassName() << E->getSourceRange();
3388 case Expr::CXXUuidofExprClass: {
3389 const CXXUuidofExpr *UE = cast<CXXUuidofExpr>(E);
3390 if (UE->isTypeOperand()) {
3391 QualType UuidT = UE->getTypeOperand(Context.getASTContext());
3392 Out << "u8__uuidoft";
3395 Expr *UuidExp = UE->getExprOperand();
3396 Out << "u8__uuidofz";
3397 mangleExpression(UuidExp, Arity);
3402 // Even gcc-4.5 doesn't mangle this.
3403 case Expr::BinaryConditionalOperatorClass: {
3404 DiagnosticsEngine &Diags = Context.getDiags();
3406 Diags.getCustomDiagID(DiagnosticsEngine::Error,
3407 "?: operator with omitted middle operand cannot be mangled");
3408 Diags.Report(E->getExprLoc(), DiagID)
3409 << E->getStmtClassName() << E->getSourceRange();
3413 // These are used for internal purposes and cannot be meaningfully mangled.
3414 case Expr::OpaqueValueExprClass:
3415 llvm_unreachable("cannot mangle opaque value; mangling wrong thing?");
3417 case Expr::InitListExprClass: {
3419 mangleInitListElements(cast<InitListExpr>(E));
3424 case Expr::CXXDefaultArgExprClass:
3425 mangleExpression(cast<CXXDefaultArgExpr>(E)->getExpr(), Arity);
3428 case Expr::CXXDefaultInitExprClass:
3429 mangleExpression(cast<CXXDefaultInitExpr>(E)->getExpr(), Arity);
3432 case Expr::CXXStdInitializerListExprClass:
3433 mangleExpression(cast<CXXStdInitializerListExpr>(E)->getSubExpr(), Arity);
3436 case Expr::SubstNonTypeTemplateParmExprClass:
3437 mangleExpression(cast<SubstNonTypeTemplateParmExpr>(E)->getReplacement(),
3441 case Expr::UserDefinedLiteralClass:
3442 // We follow g++'s approach of mangling a UDL as a call to the literal
3444 case Expr::CXXMemberCallExprClass: // fallthrough
3445 case Expr::CallExprClass: {
3446 const CallExpr *CE = cast<CallExpr>(E);
3448 // <expression> ::= cp <simple-id> <expression>* E
3449 // We use this mangling only when the call would use ADL except
3450 // for being parenthesized. Per discussion with David
3451 // Vandervoorde, 2011.04.25.
3452 if (isParenthesizedADLCallee(CE)) {
3454 // The callee here is a parenthesized UnresolvedLookupExpr with
3455 // no qualifier and should always get mangled as a <simple-id>
3458 // <expression> ::= cl <expression>* E
3463 unsigned CallArity = CE->getNumArgs();
3464 for (const Expr *Arg : CE->arguments())
3465 if (isa<PackExpansionExpr>(Arg))
3466 CallArity = UnknownArity;
3468 mangleExpression(CE->getCallee(), CallArity);
3469 for (const Expr *Arg : CE->arguments())
3470 mangleExpression(Arg);
3475 case Expr::CXXNewExprClass: {
3476 const CXXNewExpr *New = cast<CXXNewExpr>(E);
3477 if (New->isGlobalNew()) Out << "gs";
3478 Out << (New->isArray() ? "na" : "nw");
3479 for (CXXNewExpr::const_arg_iterator I = New->placement_arg_begin(),
3480 E = New->placement_arg_end(); I != E; ++I)
3481 mangleExpression(*I);
3483 mangleType(New->getAllocatedType());
3484 if (New->hasInitializer()) {
3485 if (New->getInitializationStyle() == CXXNewExpr::ListInit)
3489 const Expr *Init = New->getInitializer();
3490 if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(Init)) {
3491 // Directly inline the initializers.
3492 for (CXXConstructExpr::const_arg_iterator I = CCE->arg_begin(),
3495 mangleExpression(*I);
3496 } else if (const ParenListExpr *PLE = dyn_cast<ParenListExpr>(Init)) {
3497 for (unsigned i = 0, e = PLE->getNumExprs(); i != e; ++i)
3498 mangleExpression(PLE->getExpr(i));
3499 } else if (New->getInitializationStyle() == CXXNewExpr::ListInit &&
3500 isa<InitListExpr>(Init)) {
3501 // Only take InitListExprs apart for list-initialization.
3502 mangleInitListElements(cast<InitListExpr>(Init));
3504 mangleExpression(Init);
3510 case Expr::CXXPseudoDestructorExprClass: {
3511 const auto *PDE = cast<CXXPseudoDestructorExpr>(E);
3512 if (const Expr *Base = PDE->getBase())
3513 mangleMemberExprBase(Base, PDE->isArrow());
3514 NestedNameSpecifier *Qualifier = PDE->getQualifier();
3516 if (TypeSourceInfo *ScopeInfo = PDE->getScopeTypeInfo()) {
3518 mangleUnresolvedPrefix(Qualifier,
3519 /*Recursive=*/true);
3520 mangleUnresolvedTypeOrSimpleId(ScopeInfo->getType());
3524 if (!mangleUnresolvedTypeOrSimpleId(ScopeInfo->getType()))
3527 } else if (Qualifier) {
3528 mangleUnresolvedPrefix(Qualifier);
3530 // <base-unresolved-name> ::= dn <destructor-name>
3532 QualType DestroyedType = PDE->getDestroyedType();
3533 mangleUnresolvedTypeOrSimpleId(DestroyedType);
3537 case Expr::MemberExprClass: {
3538 const MemberExpr *ME = cast<MemberExpr>(E);
3539 mangleMemberExpr(ME->getBase(), ME->isArrow(),
3540 ME->getQualifier(), nullptr,
3541 ME->getMemberDecl()->getDeclName(),
3542 ME->getTemplateArgs(), ME->getNumTemplateArgs(),
3547 case Expr::UnresolvedMemberExprClass: {
3548 const UnresolvedMemberExpr *ME = cast<UnresolvedMemberExpr>(E);
3549 mangleMemberExpr(ME->isImplicitAccess() ? nullptr : ME->getBase(),
3550 ME->isArrow(), ME->getQualifier(), nullptr,
3551 ME->getMemberName(),
3552 ME->getTemplateArgs(), ME->getNumTemplateArgs(),
3557 case Expr::CXXDependentScopeMemberExprClass: {
3558 const CXXDependentScopeMemberExpr *ME
3559 = cast<CXXDependentScopeMemberExpr>(E);
3560 mangleMemberExpr(ME->isImplicitAccess() ? nullptr : ME->getBase(),
3561 ME->isArrow(), ME->getQualifier(),
3562 ME->getFirstQualifierFoundInScope(),
3564 ME->getTemplateArgs(), ME->getNumTemplateArgs(),
3569 case Expr::UnresolvedLookupExprClass: {
3570 const UnresolvedLookupExpr *ULE = cast<UnresolvedLookupExpr>(E);
3571 mangleUnresolvedName(ULE->getQualifier(), ULE->getName(),
3572 ULE->getTemplateArgs(), ULE->getNumTemplateArgs(),
3577 case Expr::CXXUnresolvedConstructExprClass: {
3578 const CXXUnresolvedConstructExpr *CE = cast<CXXUnresolvedConstructExpr>(E);
3579 unsigned N = CE->arg_size();
3582 mangleType(CE->getType());
3583 if (N != 1) Out << '_';
3584 for (unsigned I = 0; I != N; ++I) mangleExpression(CE->getArg(I));
3585 if (N != 1) Out << 'E';
3589 case Expr::CXXConstructExprClass: {
3590 const auto *CE = cast<CXXConstructExpr>(E);
3591 if (!CE->isListInitialization() || CE->isStdInitListInitialization()) {
3593 CE->getNumArgs() >= 1 &&
3594 (CE->getNumArgs() == 1 || isa<CXXDefaultArgExpr>(CE->getArg(1))) &&
3595 "implicit CXXConstructExpr must have one argument");
3596 return mangleExpression(cast<CXXConstructExpr>(E)->getArg(0));
3599 for (auto *E : CE->arguments())
3600 mangleExpression(E);
3605 case Expr::CXXTemporaryObjectExprClass: {
3606 const auto *CE = cast<CXXTemporaryObjectExpr>(E);
3607 unsigned N = CE->getNumArgs();
3608 bool List = CE->isListInitialization();
3614 mangleType(CE->getType());
3615 if (!List && N != 1)
3617 if (CE->isStdInitListInitialization()) {
3618 // We implicitly created a std::initializer_list<T> for the first argument
3619 // of a constructor of type U in an expression of the form U{a, b, c}.
3620 // Strip all the semantic gunk off the initializer list.
3622 cast<CXXStdInitializerListExpr>(CE->getArg(0)->IgnoreImplicit());
3623 auto *ILE = cast<InitListExpr>(SILE->getSubExpr()->IgnoreImplicit());
3624 mangleInitListElements(ILE);
3626 for (auto *E : CE->arguments())
3627 mangleExpression(E);
3634 case Expr::CXXScalarValueInitExprClass:
3636 mangleType(E->getType());
3640 case Expr::CXXNoexceptExprClass:
3642 mangleExpression(cast<CXXNoexceptExpr>(E)->getOperand());
3645 case Expr::UnaryExprOrTypeTraitExprClass: {
3646 const UnaryExprOrTypeTraitExpr *SAE = cast<UnaryExprOrTypeTraitExpr>(E);
3648 if (!SAE->isInstantiationDependent()) {
3650 // If the operand of a sizeof or alignof operator is not
3651 // instantiation-dependent it is encoded as an integer literal
3652 // reflecting the result of the operator.
3654 // If the result of the operator is implicitly converted to a known
3655 // integer type, that type is used for the literal; otherwise, the type
3656 // of std::size_t or std::ptrdiff_t is used.
3657 QualType T = (ImplicitlyConvertedToType.isNull() ||
3658 !ImplicitlyConvertedToType->isIntegerType())? SAE->getType()
3659 : ImplicitlyConvertedToType;
3660 llvm::APSInt V = SAE->EvaluateKnownConstInt(Context.getASTContext());
3661 mangleIntegerLiteral(T, V);
3665 switch(SAE->getKind()) {
3672 case UETT_VecStep: {
3673 DiagnosticsEngine &Diags = Context.getDiags();
3674 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
3675 "cannot yet mangle vec_step expression");
3676 Diags.Report(DiagID);
3679 case UETT_OpenMPRequiredSimdAlign:
3680 DiagnosticsEngine &Diags = Context.getDiags();
3681 unsigned DiagID = Diags.getCustomDiagID(
3682 DiagnosticsEngine::Error,
3683 "cannot yet mangle __builtin_omp_required_simd_align expression");
3684 Diags.Report(DiagID);
3687 if (SAE->isArgumentType()) {
3689 mangleType(SAE->getArgumentType());
3692 mangleExpression(SAE->getArgumentExpr());
3697 case Expr::CXXThrowExprClass: {
3698 const CXXThrowExpr *TE = cast<CXXThrowExpr>(E);
3699 // <expression> ::= tw <expression> # throw expression
3701 if (TE->getSubExpr()) {
3703 mangleExpression(TE->getSubExpr());
3710 case Expr::CXXTypeidExprClass: {
3711 const CXXTypeidExpr *TIE = cast<CXXTypeidExpr>(E);
3712 // <expression> ::= ti <type> # typeid (type)
3713 // ::= te <expression> # typeid (expression)
3714 if (TIE->isTypeOperand()) {
3716 mangleType(TIE->getTypeOperand(Context.getASTContext()));
3719 mangleExpression(TIE->getExprOperand());
3724 case Expr::CXXDeleteExprClass: {
3725 const CXXDeleteExpr *DE = cast<CXXDeleteExpr>(E);
3726 // <expression> ::= [gs] dl <expression> # [::] delete expr
3727 // ::= [gs] da <expression> # [::] delete [] expr
3728 if (DE->isGlobalDelete()) Out << "gs";
3729 Out << (DE->isArrayForm() ? "da" : "dl");
3730 mangleExpression(DE->getArgument());
3734 case Expr::UnaryOperatorClass: {
3735 const UnaryOperator *UO = cast<UnaryOperator>(E);
3736 mangleOperatorName(UnaryOperator::getOverloadedOperator(UO->getOpcode()),
3738 mangleExpression(UO->getSubExpr());
3742 case Expr::ArraySubscriptExprClass: {
3743 const ArraySubscriptExpr *AE = cast<ArraySubscriptExpr>(E);
3745 // Array subscript is treated as a syntactically weird form of
3748 mangleExpression(AE->getLHS());
3749 mangleExpression(AE->getRHS());
3753 case Expr::CompoundAssignOperatorClass: // fallthrough
3754 case Expr::BinaryOperatorClass: {
3755 const BinaryOperator *BO = cast<BinaryOperator>(E);
3756 if (BO->getOpcode() == BO_PtrMemD)
3759 mangleOperatorName(BinaryOperator::getOverloadedOperator(BO->getOpcode()),
3761 mangleExpression(BO->getLHS());
3762 mangleExpression(BO->getRHS());
3766 case Expr::ConditionalOperatorClass: {
3767 const ConditionalOperator *CO = cast<ConditionalOperator>(E);
3768 mangleOperatorName(OO_Conditional, /*Arity=*/3);
3769 mangleExpression(CO->getCond());
3770 mangleExpression(CO->getLHS(), Arity);
3771 mangleExpression(CO->getRHS(), Arity);
3775 case Expr::ImplicitCastExprClass: {
3776 ImplicitlyConvertedToType = E->getType();
3777 E = cast<ImplicitCastExpr>(E)->getSubExpr();
3781 case Expr::ObjCBridgedCastExprClass: {
3782 // Mangle ownership casts as a vendor extended operator __bridge,
3783 // __bridge_transfer, or __bridge_retain.
3784 StringRef Kind = cast<ObjCBridgedCastExpr>(E)->getBridgeKindName();
3785 Out << "v1U" << Kind.size() << Kind;
3787 // Fall through to mangle the cast itself.
3790 case Expr::CStyleCastExprClass:
3791 mangleCastExpression(E, "cv");
3794 case Expr::CXXFunctionalCastExprClass: {
3795 auto *Sub = cast<ExplicitCastExpr>(E)->getSubExpr()->IgnoreImplicit();
3796 // FIXME: Add isImplicit to CXXConstructExpr.
3797 if (auto *CCE = dyn_cast<CXXConstructExpr>(Sub))
3798 if (CCE->getParenOrBraceRange().isInvalid())
3799 Sub = CCE->getArg(0)->IgnoreImplicit();
3800 if (auto *StdInitList = dyn_cast<CXXStdInitializerListExpr>(Sub))
3801 Sub = StdInitList->getSubExpr()->IgnoreImplicit();
3802 if (auto *IL = dyn_cast<InitListExpr>(Sub)) {
3804 mangleType(E->getType());
3805 mangleInitListElements(IL);
3808 mangleCastExpression(E, "cv");
3813 case Expr::CXXStaticCastExprClass:
3814 mangleCastExpression(E, "sc");
3816 case Expr::CXXDynamicCastExprClass:
3817 mangleCastExpression(E, "dc");
3819 case Expr::CXXReinterpretCastExprClass:
3820 mangleCastExpression(E, "rc");
3822 case Expr::CXXConstCastExprClass:
3823 mangleCastExpression(E, "cc");
3826 case Expr::CXXOperatorCallExprClass: {
3827 const CXXOperatorCallExpr *CE = cast<CXXOperatorCallExpr>(E);
3828 unsigned NumArgs = CE->getNumArgs();
3829 // A CXXOperatorCallExpr for OO_Arrow models only semantics, not syntax
3830 // (the enclosing MemberExpr covers the syntactic portion).
3831 if (CE->getOperator() != OO_Arrow)
3832 mangleOperatorName(CE->getOperator(), /*Arity=*/NumArgs);
3833 // Mangle the arguments.
3834 for (unsigned i = 0; i != NumArgs; ++i)
3835 mangleExpression(CE->getArg(i));
3839 case Expr::ParenExprClass:
3840 mangleExpression(cast<ParenExpr>(E)->getSubExpr(), Arity);
3843 case Expr::DeclRefExprClass: {
3844 const NamedDecl *D = cast<DeclRefExpr>(E)->getDecl();
3846 switch (D->getKind()) {
3848 // <expr-primary> ::= L <mangled-name> E # external name
3855 mangleFunctionParam(cast<ParmVarDecl>(D));
3858 case Decl::EnumConstant: {
3859 const EnumConstantDecl *ED = cast<EnumConstantDecl>(D);
3860 mangleIntegerLiteral(ED->getType(), ED->getInitVal());
3864 case Decl::NonTypeTemplateParm: {
3865 const NonTypeTemplateParmDecl *PD = cast<NonTypeTemplateParmDecl>(D);
3866 mangleTemplateParameter(PD->getIndex());
3875 case Expr::SubstNonTypeTemplateParmPackExprClass:
3876 // FIXME: not clear how to mangle this!
3877 // template <unsigned N...> class A {
3878 // template <class U...> void foo(U (&x)[N]...);
3880 Out << "_SUBSTPACK_";
3883 case Expr::FunctionParmPackExprClass: {
3884 // FIXME: not clear how to mangle this!
3885 const FunctionParmPackExpr *FPPE = cast<FunctionParmPackExpr>(E);
3886 Out << "v110_SUBSTPACK";
3887 mangleFunctionParam(FPPE->getParameterPack());
3891 case Expr::DependentScopeDeclRefExprClass: {
3892 const DependentScopeDeclRefExpr *DRE = cast<DependentScopeDeclRefExpr>(E);
3893 mangleUnresolvedName(DRE->getQualifier(), DRE->getDeclName(),
3894 DRE->getTemplateArgs(), DRE->getNumTemplateArgs(),
3899 case Expr::CXXBindTemporaryExprClass:
3900 mangleExpression(cast<CXXBindTemporaryExpr>(E)->getSubExpr());
3903 case Expr::ExprWithCleanupsClass:
3904 mangleExpression(cast<ExprWithCleanups>(E)->getSubExpr(), Arity);
3907 case Expr::FloatingLiteralClass: {
3908 const FloatingLiteral *FL = cast<FloatingLiteral>(E);
3910 mangleType(FL->getType());
3911 mangleFloat(FL->getValue());
3916 case Expr::CharacterLiteralClass:
3918 mangleType(E->getType());
3919 Out << cast<CharacterLiteral>(E)->getValue();
3923 // FIXME. __objc_yes/__objc_no are mangled same as true/false
3924 case Expr::ObjCBoolLiteralExprClass:
3926 Out << (cast<ObjCBoolLiteralExpr>(E)->getValue() ? '1' : '0');
3930 case Expr::CXXBoolLiteralExprClass:
3932 Out << (cast<CXXBoolLiteralExpr>(E)->getValue() ? '1' : '0');
3936 case Expr::IntegerLiteralClass: {
3937 llvm::APSInt Value(cast<IntegerLiteral>(E)->getValue());
3938 if (E->getType()->isSignedIntegerType())
3939 Value.setIsSigned(true);
3940 mangleIntegerLiteral(E->getType(), Value);
3944 case Expr::ImaginaryLiteralClass: {
3945 const ImaginaryLiteral *IE = cast<ImaginaryLiteral>(E);
3946 // Mangle as if a complex literal.
3947 // Proposal from David Vandevoorde, 2010.06.30.
3949 mangleType(E->getType());
3950 if (const FloatingLiteral *Imag =
3951 dyn_cast<FloatingLiteral>(IE->getSubExpr())) {
3952 // Mangle a floating-point zero of the appropriate type.
3953 mangleFloat(llvm::APFloat(Imag->getValue().getSemantics()));
3955 mangleFloat(Imag->getValue());
3958 llvm::APSInt Value(cast<IntegerLiteral>(IE->getSubExpr())->getValue());
3959 if (IE->getSubExpr()->getType()->isSignedIntegerType())
3960 Value.setIsSigned(true);
3961 mangleNumber(Value);
3967 case Expr::StringLiteralClass: {
3968 // Revised proposal from David Vandervoorde, 2010.07.15.
3970 assert(isa<ConstantArrayType>(E->getType()));
3971 mangleType(E->getType());
3976 case Expr::GNUNullExprClass:
3977 // FIXME: should this really be mangled the same as nullptr?
3980 case Expr::CXXNullPtrLiteralExprClass: {
3985 case Expr::PackExpansionExprClass:
3987 mangleExpression(cast<PackExpansionExpr>(E)->getPattern());
3990 case Expr::SizeOfPackExprClass: {
3991 auto *SPE = cast<SizeOfPackExpr>(E);
3992 if (SPE->isPartiallySubstituted()) {
3994 for (const auto &A : SPE->getPartialArguments())
3995 mangleTemplateArg(A);
4001 const NamedDecl *Pack = SPE->getPack();
4002 if (const TemplateTypeParmDecl *TTP = dyn_cast<TemplateTypeParmDecl>(Pack))
4003 mangleTemplateParameter(TTP->getIndex());
4004 else if (const NonTypeTemplateParmDecl *NTTP
4005 = dyn_cast<NonTypeTemplateParmDecl>(Pack))
4006 mangleTemplateParameter(NTTP->getIndex());
4007 else if (const TemplateTemplateParmDecl *TempTP
4008 = dyn_cast<TemplateTemplateParmDecl>(Pack))
4009 mangleTemplateParameter(TempTP->getIndex());
4011 mangleFunctionParam(cast<ParmVarDecl>(Pack));
4015 case Expr::MaterializeTemporaryExprClass: {
4016 mangleExpression(cast<MaterializeTemporaryExpr>(E)->GetTemporaryExpr());
4020 case Expr::CXXFoldExprClass: {
4021 auto *FE = cast<CXXFoldExpr>(E);
4022 if (FE->isLeftFold())
4023 Out << (FE->getInit() ? "fL" : "fl");
4025 Out << (FE->getInit() ? "fR" : "fr");
4027 if (FE->getOperator() == BO_PtrMemD)
4031 BinaryOperator::getOverloadedOperator(FE->getOperator()),
4035 mangleExpression(FE->getLHS());
4037 mangleExpression(FE->getRHS());
4041 case Expr::CXXThisExprClass:
4045 case Expr::CoawaitExprClass:
4046 // FIXME: Propose a non-vendor mangling.
4047 Out << "v18co_await";
4048 mangleExpression(cast<CoawaitExpr>(E)->getOperand());
4051 case Expr::DependentCoawaitExprClass:
4052 // FIXME: Propose a non-vendor mangling.
4053 Out << "v18co_await";
4054 mangleExpression(cast<DependentCoawaitExpr>(E)->getOperand());
4057 case Expr::CoyieldExprClass:
4058 // FIXME: Propose a non-vendor mangling.
4059 Out << "v18co_yield";
4060 mangleExpression(cast<CoawaitExpr>(E)->getOperand());
4065 /// Mangle an expression which refers to a parameter variable.
4067 /// <expression> ::= <function-param>
4068 /// <function-param> ::= fp <top-level CV-qualifiers> _ # L == 0, I == 0
4069 /// <function-param> ::= fp <top-level CV-qualifiers>
4070 /// <parameter-2 non-negative number> _ # L == 0, I > 0
4071 /// <function-param> ::= fL <L-1 non-negative number>
4072 /// p <top-level CV-qualifiers> _ # L > 0, I == 0
4073 /// <function-param> ::= fL <L-1 non-negative number>
4074 /// p <top-level CV-qualifiers>
4075 /// <I-1 non-negative number> _ # L > 0, I > 0
4077 /// L is the nesting depth of the parameter, defined as 1 if the
4078 /// parameter comes from the innermost function prototype scope
4079 /// enclosing the current context, 2 if from the next enclosing
4080 /// function prototype scope, and so on, with one special case: if
4081 /// we've processed the full parameter clause for the innermost
4082 /// function type, then L is one less. This definition conveniently
4083 /// makes it irrelevant whether a function's result type was written
4084 /// trailing or leading, but is otherwise overly complicated; the
4085 /// numbering was first designed without considering references to
4086 /// parameter in locations other than return types, and then the
4087 /// mangling had to be generalized without changing the existing
4090 /// I is the zero-based index of the parameter within its parameter
4091 /// declaration clause. Note that the original ABI document describes
4092 /// this using 1-based ordinals.
4093 void CXXNameMangler::mangleFunctionParam(const ParmVarDecl *parm) {
4094 unsigned parmDepth = parm->getFunctionScopeDepth();
4095 unsigned parmIndex = parm->getFunctionScopeIndex();
4098 // parmDepth does not include the declaring function prototype.
4099 // FunctionTypeDepth does account for that.
4100 assert(parmDepth < FunctionTypeDepth.getDepth());
4101 unsigned nestingDepth = FunctionTypeDepth.getDepth() - parmDepth;
4102 if (FunctionTypeDepth.isInResultType())
4105 if (nestingDepth == 0) {
4108 Out << "fL" << (nestingDepth - 1) << 'p';
4111 // Top-level qualifiers. We don't have to worry about arrays here,
4112 // because parameters declared as arrays should already have been
4113 // transformed to have pointer type. FIXME: apparently these don't
4114 // get mangled if used as an rvalue of a known non-class type?
4115 assert(!parm->getType()->isArrayType()
4116 && "parameter's type is still an array type?");
4117 mangleQualifiers(parm->getType().getQualifiers());
4120 if (parmIndex != 0) {
4121 Out << (parmIndex - 1);
4126 void CXXNameMangler::mangleCXXCtorType(CXXCtorType T,
4127 const CXXRecordDecl *InheritedFrom) {
4128 // <ctor-dtor-name> ::= C1 # complete object constructor
4129 // ::= C2 # base object constructor
4130 // ::= CI1 <type> # complete inheriting constructor
4131 // ::= CI2 <type> # base inheriting constructor
4133 // In addition, C5 is a comdat name with C1 and C2 in it.
4147 case Ctor_DefaultClosure:
4148 case Ctor_CopyingClosure:
4149 llvm_unreachable("closure constructors don't exist for the Itanium ABI!");
4152 mangleName(InheritedFrom);
4155 void CXXNameMangler::mangleCXXDtorType(CXXDtorType T) {
4156 // <ctor-dtor-name> ::= D0 # deleting destructor
4157 // ::= D1 # complete object destructor
4158 // ::= D2 # base object destructor
4160 // In addition, D5 is a comdat name with D1, D2 and, if virtual, D0 in it.
4177 void CXXNameMangler::mangleTemplateArgs(const TemplateArgumentLoc *TemplateArgs,
4178 unsigned NumTemplateArgs) {
4179 // <template-args> ::= I <template-arg>+ E
4181 for (unsigned i = 0; i != NumTemplateArgs; ++i)
4182 mangleTemplateArg(TemplateArgs[i].getArgument());
4186 void CXXNameMangler::mangleTemplateArgs(const TemplateArgumentList &AL) {
4187 // <template-args> ::= I <template-arg>+ E
4189 for (unsigned i = 0, e = AL.size(); i != e; ++i)
4190 mangleTemplateArg(AL[i]);
4194 void CXXNameMangler::mangleTemplateArgs(const TemplateArgument *TemplateArgs,
4195 unsigned NumTemplateArgs) {
4196 // <template-args> ::= I <template-arg>+ E
4198 for (unsigned i = 0; i != NumTemplateArgs; ++i)
4199 mangleTemplateArg(TemplateArgs[i]);
4203 void CXXNameMangler::mangleTemplateArg(TemplateArgument A) {
4204 // <template-arg> ::= <type> # type or template
4205 // ::= X <expression> E # expression
4206 // ::= <expr-primary> # simple expressions
4207 // ::= J <template-arg>* E # argument pack
4208 if (!A.isInstantiationDependent() || A.isDependent())
4209 A = Context.getASTContext().getCanonicalTemplateArgument(A);
4211 switch (A.getKind()) {
4212 case TemplateArgument::Null:
4213 llvm_unreachable("Cannot mangle NULL template argument");
4215 case TemplateArgument::Type:
4216 mangleType(A.getAsType());
4218 case TemplateArgument::Template:
4219 // This is mangled as <type>.
4220 mangleType(A.getAsTemplate());
4222 case TemplateArgument::TemplateExpansion:
4223 // <type> ::= Dp <type> # pack expansion (C++0x)
4225 mangleType(A.getAsTemplateOrTemplatePattern());
4227 case TemplateArgument::Expression: {
4228 // It's possible to end up with a DeclRefExpr here in certain
4229 // dependent cases, in which case we should mangle as a
4231 const Expr *E = A.getAsExpr()->IgnoreParens();
4232 if (const DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(E)) {
4233 const ValueDecl *D = DRE->getDecl();
4234 if (isa<VarDecl>(D) || isa<FunctionDecl>(D)) {
4243 mangleExpression(E);
4247 case TemplateArgument::Integral:
4248 mangleIntegerLiteral(A.getIntegralType(), A.getAsIntegral());
4250 case TemplateArgument::Declaration: {
4251 // <expr-primary> ::= L <mangled-name> E # external name
4252 // Clang produces AST's where pointer-to-member-function expressions
4253 // and pointer-to-function expressions are represented as a declaration not
4254 // an expression. We compensate for it here to produce the correct mangling.
4255 ValueDecl *D = A.getAsDecl();
4256 bool compensateMangling = !A.getParamTypeForDecl()->isReferenceType();
4257 if (compensateMangling) {
4259 mangleOperatorName(OO_Amp, 1);
4263 // References to external entities use the mangled name; if the name would
4264 // not normally be mangled then mangle it as unqualified.
4268 if (compensateMangling)
4273 case TemplateArgument::NullPtr: {
4274 // <expr-primary> ::= L <type> 0 E
4276 mangleType(A.getNullPtrType());
4280 case TemplateArgument::Pack: {
4281 // <template-arg> ::= J <template-arg>* E
4283 for (const auto &P : A.pack_elements())
4284 mangleTemplateArg(P);
4290 void CXXNameMangler::mangleTemplateParameter(unsigned Index) {
4291 // <template-param> ::= T_ # first template parameter
4292 // ::= T <parameter-2 non-negative number> _
4296 Out << 'T' << (Index - 1) << '_';
4299 void CXXNameMangler::mangleSeqID(unsigned SeqID) {
4302 else if (SeqID > 1) {
4305 // <seq-id> is encoded in base-36, using digits and upper case letters.
4306 char Buffer[7]; // log(2**32) / log(36) ~= 7
4307 MutableArrayRef<char> BufferRef(Buffer);
4308 MutableArrayRef<char>::reverse_iterator I = BufferRef.rbegin();
4310 for (; SeqID != 0; SeqID /= 36) {
4311 unsigned C = SeqID % 36;
4312 *I++ = (C < 10 ? '0' + C : 'A' + C - 10);
4315 Out.write(I.base(), I - BufferRef.rbegin());
4320 void CXXNameMangler::mangleExistingSubstitution(TemplateName tname) {
4321 bool result = mangleSubstitution(tname);
4322 assert(result && "no existing substitution for template name");
4326 // <substitution> ::= S <seq-id> _
4328 bool CXXNameMangler::mangleSubstitution(const NamedDecl *ND) {
4329 // Try one of the standard substitutions first.
4330 if (mangleStandardSubstitution(ND))
4333 ND = cast<NamedDecl>(ND->getCanonicalDecl());
4334 return mangleSubstitution(reinterpret_cast<uintptr_t>(ND));
4337 /// Determine whether the given type has any qualifiers that are relevant for
4339 static bool hasMangledSubstitutionQualifiers(QualType T) {
4340 Qualifiers Qs = T.getQualifiers();
4341 return Qs.getCVRQualifiers() || Qs.hasAddressSpace() || Qs.hasUnaligned();
4344 bool CXXNameMangler::mangleSubstitution(QualType T) {
4345 if (!hasMangledSubstitutionQualifiers(T)) {
4346 if (const RecordType *RT = T->getAs<RecordType>())
4347 return mangleSubstitution(RT->getDecl());
4350 uintptr_t TypePtr = reinterpret_cast<uintptr_t>(T.getAsOpaquePtr());
4352 return mangleSubstitution(TypePtr);
4355 bool CXXNameMangler::mangleSubstitution(TemplateName Template) {
4356 if (TemplateDecl *TD = Template.getAsTemplateDecl())
4357 return mangleSubstitution(TD);
4359 Template = Context.getASTContext().getCanonicalTemplateName(Template);
4360 return mangleSubstitution(
4361 reinterpret_cast<uintptr_t>(Template.getAsVoidPointer()));
4364 bool CXXNameMangler::mangleSubstitution(uintptr_t Ptr) {
4365 llvm::DenseMap<uintptr_t, unsigned>::iterator I = Substitutions.find(Ptr);
4366 if (I == Substitutions.end())
4369 unsigned SeqID = I->second;
4376 static bool isCharType(QualType T) {
4380 return T->isSpecificBuiltinType(BuiltinType::Char_S) ||
4381 T->isSpecificBuiltinType(BuiltinType::Char_U);
4384 /// Returns whether a given type is a template specialization of a given name
4385 /// with a single argument of type char.
4386 static bool isCharSpecialization(QualType T, const char *Name) {
4390 const RecordType *RT = T->getAs<RecordType>();
4394 const ClassTemplateSpecializationDecl *SD =
4395 dyn_cast<ClassTemplateSpecializationDecl>(RT->getDecl());
4399 if (!isStdNamespace(getEffectiveDeclContext(SD)))
4402 const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
4403 if (TemplateArgs.size() != 1)
4406 if (!isCharType(TemplateArgs[0].getAsType()))
4409 return SD->getIdentifier()->getName() == Name;
4412 template <std::size_t StrLen>
4413 static bool isStreamCharSpecialization(const ClassTemplateSpecializationDecl*SD,
4414 const char (&Str)[StrLen]) {
4415 if (!SD->getIdentifier()->isStr(Str))
4418 const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
4419 if (TemplateArgs.size() != 2)
4422 if (!isCharType(TemplateArgs[0].getAsType()))
4425 if (!isCharSpecialization(TemplateArgs[1].getAsType(), "char_traits"))
4431 bool CXXNameMangler::mangleStandardSubstitution(const NamedDecl *ND) {
4432 // <substitution> ::= St # ::std::
4433 if (const NamespaceDecl *NS = dyn_cast<NamespaceDecl>(ND)) {
4440 if (const ClassTemplateDecl *TD = dyn_cast<ClassTemplateDecl>(ND)) {
4441 if (!isStdNamespace(getEffectiveDeclContext(TD)))
4444 // <substitution> ::= Sa # ::std::allocator
4445 if (TD->getIdentifier()->isStr("allocator")) {
4450 // <<substitution> ::= Sb # ::std::basic_string
4451 if (TD->getIdentifier()->isStr("basic_string")) {
4457 if (const ClassTemplateSpecializationDecl *SD =
4458 dyn_cast<ClassTemplateSpecializationDecl>(ND)) {
4459 if (!isStdNamespace(getEffectiveDeclContext(SD)))
4462 // <substitution> ::= Ss # ::std::basic_string<char,
4463 // ::std::char_traits<char>,
4464 // ::std::allocator<char> >
4465 if (SD->getIdentifier()->isStr("basic_string")) {
4466 const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
4468 if (TemplateArgs.size() != 3)
4471 if (!isCharType(TemplateArgs[0].getAsType()))
4474 if (!isCharSpecialization(TemplateArgs[1].getAsType(), "char_traits"))
4477 if (!isCharSpecialization(TemplateArgs[2].getAsType(), "allocator"))
4484 // <substitution> ::= Si # ::std::basic_istream<char,
4485 // ::std::char_traits<char> >
4486 if (isStreamCharSpecialization(SD, "basic_istream")) {
4491 // <substitution> ::= So # ::std::basic_ostream<char,
4492 // ::std::char_traits<char> >
4493 if (isStreamCharSpecialization(SD, "basic_ostream")) {
4498 // <substitution> ::= Sd # ::std::basic_iostream<char,
4499 // ::std::char_traits<char> >
4500 if (isStreamCharSpecialization(SD, "basic_iostream")) {
4508 void CXXNameMangler::addSubstitution(QualType T) {
4509 if (!hasMangledSubstitutionQualifiers(T)) {
4510 if (const RecordType *RT = T->getAs<RecordType>()) {
4511 addSubstitution(RT->getDecl());
4516 uintptr_t TypePtr = reinterpret_cast<uintptr_t>(T.getAsOpaquePtr());
4517 addSubstitution(TypePtr);
4520 void CXXNameMangler::addSubstitution(TemplateName Template) {
4521 if (TemplateDecl *TD = Template.getAsTemplateDecl())
4522 return addSubstitution(TD);
4524 Template = Context.getASTContext().getCanonicalTemplateName(Template);
4525 addSubstitution(reinterpret_cast<uintptr_t>(Template.getAsVoidPointer()));
4528 void CXXNameMangler::addSubstitution(uintptr_t Ptr) {
4529 assert(!Substitutions.count(Ptr) && "Substitution already exists!");
4530 Substitutions[Ptr] = SeqID++;
4533 void CXXNameMangler::extendSubstitutions(CXXNameMangler* Other) {
4534 assert(Other->SeqID >= SeqID && "Must be superset of substitutions!");
4535 if (Other->SeqID > SeqID) {
4536 Substitutions.swap(Other->Substitutions);
4537 SeqID = Other->SeqID;
4541 CXXNameMangler::AbiTagList
4542 CXXNameMangler::makeFunctionReturnTypeTags(const FunctionDecl *FD) {
4543 // When derived abi tags are disabled there is no need to make any list.
4544 if (DisableDerivedAbiTags)
4545 return AbiTagList();
4547 llvm::raw_null_ostream NullOutStream;
4548 CXXNameMangler TrackReturnTypeTags(*this, NullOutStream);
4549 TrackReturnTypeTags.disableDerivedAbiTags();
4551 const FunctionProtoType *Proto =
4552 cast<FunctionProtoType>(FD->getType()->getAs<FunctionType>());
4553 TrackReturnTypeTags.FunctionTypeDepth.enterResultType();
4554 TrackReturnTypeTags.mangleType(Proto->getReturnType());
4555 TrackReturnTypeTags.FunctionTypeDepth.leaveResultType();
4557 return TrackReturnTypeTags.AbiTagsRoot.getSortedUniqueUsedAbiTags();
4560 CXXNameMangler::AbiTagList
4561 CXXNameMangler::makeVariableTypeTags(const VarDecl *VD) {
4562 // When derived abi tags are disabled there is no need to make any list.
4563 if (DisableDerivedAbiTags)
4564 return AbiTagList();
4566 llvm::raw_null_ostream NullOutStream;
4567 CXXNameMangler TrackVariableType(*this, NullOutStream);
4568 TrackVariableType.disableDerivedAbiTags();
4570 TrackVariableType.mangleType(VD->getType());
4572 return TrackVariableType.AbiTagsRoot.getSortedUniqueUsedAbiTags();
4575 bool CXXNameMangler::shouldHaveAbiTags(ItaniumMangleContextImpl &C,
4576 const VarDecl *VD) {
4577 llvm::raw_null_ostream NullOutStream;
4578 CXXNameMangler TrackAbiTags(C, NullOutStream, nullptr, true);
4579 TrackAbiTags.mangle(VD);
4580 return TrackAbiTags.AbiTagsRoot.getUsedAbiTags().size();
4585 /// Mangles the name of the declaration D and emits that name to the given
4588 /// If the declaration D requires a mangled name, this routine will emit that
4589 /// mangled name to \p os and return true. Otherwise, \p os will be unchanged
4590 /// and this routine will return false. In this case, the caller should just
4591 /// emit the identifier of the declaration (\c D->getIdentifier()) as its
4593 void ItaniumMangleContextImpl::mangleCXXName(const NamedDecl *D,
4595 assert((isa<FunctionDecl>(D) || isa<VarDecl>(D)) &&
4596 "Invalid mangleName() call, argument is not a variable or function!");
4597 assert(!isa<CXXConstructorDecl>(D) && !isa<CXXDestructorDecl>(D) &&
4598 "Invalid mangleName() call on 'structor decl!");
4600 PrettyStackTraceDecl CrashInfo(D, SourceLocation(),
4601 getASTContext().getSourceManager(),
4602 "Mangling declaration");
4604 CXXNameMangler Mangler(*this, Out, D);
4608 void ItaniumMangleContextImpl::mangleCXXCtor(const CXXConstructorDecl *D,
4611 CXXNameMangler Mangler(*this, Out, D, Type);
4615 void ItaniumMangleContextImpl::mangleCXXDtor(const CXXDestructorDecl *D,
4618 CXXNameMangler Mangler(*this, Out, D, Type);
4622 void ItaniumMangleContextImpl::mangleCXXCtorComdat(const CXXConstructorDecl *D,
4624 CXXNameMangler Mangler(*this, Out, D, Ctor_Comdat);
4628 void ItaniumMangleContextImpl::mangleCXXDtorComdat(const CXXDestructorDecl *D,
4630 CXXNameMangler Mangler(*this, Out, D, Dtor_Comdat);
4634 void ItaniumMangleContextImpl::mangleThunk(const CXXMethodDecl *MD,
4635 const ThunkInfo &Thunk,
4637 // <special-name> ::= T <call-offset> <base encoding>
4638 // # base is the nominal target function of thunk
4639 // <special-name> ::= Tc <call-offset> <call-offset> <base encoding>
4640 // # base is the nominal target function of thunk
4641 // # first call-offset is 'this' adjustment
4642 // # second call-offset is result adjustment
4644 assert(!isa<CXXDestructorDecl>(MD) &&
4645 "Use mangleCXXDtor for destructor decls!");
4646 CXXNameMangler Mangler(*this, Out);
4647 Mangler.getStream() << "_ZT";
4648 if (!Thunk.Return.isEmpty())
4649 Mangler.getStream() << 'c';
4651 // Mangle the 'this' pointer adjustment.
4652 Mangler.mangleCallOffset(Thunk.This.NonVirtual,
4653 Thunk.This.Virtual.Itanium.VCallOffsetOffset);
4655 // Mangle the return pointer adjustment if there is one.
4656 if (!Thunk.Return.isEmpty())
4657 Mangler.mangleCallOffset(Thunk.Return.NonVirtual,
4658 Thunk.Return.Virtual.Itanium.VBaseOffsetOffset);
4660 Mangler.mangleFunctionEncoding(MD);
4663 void ItaniumMangleContextImpl::mangleCXXDtorThunk(
4664 const CXXDestructorDecl *DD, CXXDtorType Type,
4665 const ThisAdjustment &ThisAdjustment, raw_ostream &Out) {
4666 // <special-name> ::= T <call-offset> <base encoding>
4667 // # base is the nominal target function of thunk
4668 CXXNameMangler Mangler(*this, Out, DD, Type);
4669 Mangler.getStream() << "_ZT";
4671 // Mangle the 'this' pointer adjustment.
4672 Mangler.mangleCallOffset(ThisAdjustment.NonVirtual,
4673 ThisAdjustment.Virtual.Itanium.VCallOffsetOffset);
4675 Mangler.mangleFunctionEncoding(DD);
4678 /// Returns the mangled name for a guard variable for the passed in VarDecl.
4679 void ItaniumMangleContextImpl::mangleStaticGuardVariable(const VarDecl *D,
4681 // <special-name> ::= GV <object name> # Guard variable for one-time
4683 CXXNameMangler Mangler(*this, Out);
4684 // GCC 5.3.0 doesn't emit derived ABI tags for local names but that seems to
4685 // be a bug that is fixed in trunk.
4686 Mangler.getStream() << "_ZGV";
4687 Mangler.mangleName(D);
4690 void ItaniumMangleContextImpl::mangleDynamicInitializer(const VarDecl *MD,
4692 // These symbols are internal in the Itanium ABI, so the names don't matter.
4693 // Clang has traditionally used this symbol and allowed LLVM to adjust it to
4694 // avoid duplicate symbols.
4695 Out << "__cxx_global_var_init";
4698 void ItaniumMangleContextImpl::mangleDynamicAtExitDestructor(const VarDecl *D,
4700 // Prefix the mangling of D with __dtor_.
4701 CXXNameMangler Mangler(*this, Out);
4702 Mangler.getStream() << "__dtor_";
4703 if (shouldMangleDeclName(D))
4706 Mangler.getStream() << D->getName();
4709 void ItaniumMangleContextImpl::mangleSEHFilterExpression(
4710 const NamedDecl *EnclosingDecl, raw_ostream &Out) {
4711 CXXNameMangler Mangler(*this, Out);
4712 Mangler.getStream() << "__filt_";
4713 if (shouldMangleDeclName(EnclosingDecl))
4714 Mangler.mangle(EnclosingDecl);
4716 Mangler.getStream() << EnclosingDecl->getName();
4719 void ItaniumMangleContextImpl::mangleSEHFinallyBlock(
4720 const NamedDecl *EnclosingDecl, raw_ostream &Out) {
4721 CXXNameMangler Mangler(*this, Out);
4722 Mangler.getStream() << "__fin_";
4723 if (shouldMangleDeclName(EnclosingDecl))
4724 Mangler.mangle(EnclosingDecl);
4726 Mangler.getStream() << EnclosingDecl->getName();
4729 void ItaniumMangleContextImpl::mangleItaniumThreadLocalInit(const VarDecl *D,
4731 // <special-name> ::= TH <object name>
4732 CXXNameMangler Mangler(*this, Out);
4733 Mangler.getStream() << "_ZTH";
4734 Mangler.mangleName(D);
4738 ItaniumMangleContextImpl::mangleItaniumThreadLocalWrapper(const VarDecl *D,
4740 // <special-name> ::= TW <object name>
4741 CXXNameMangler Mangler(*this, Out);
4742 Mangler.getStream() << "_ZTW";
4743 Mangler.mangleName(D);
4746 void ItaniumMangleContextImpl::mangleReferenceTemporary(const VarDecl *D,
4747 unsigned ManglingNumber,
4749 // We match the GCC mangling here.
4750 // <special-name> ::= GR <object name>
4751 CXXNameMangler Mangler(*this, Out);
4752 Mangler.getStream() << "_ZGR";
4753 Mangler.mangleName(D);
4754 assert(ManglingNumber > 0 && "Reference temporary mangling number is zero!");
4755 Mangler.mangleSeqID(ManglingNumber - 1);
4758 void ItaniumMangleContextImpl::mangleCXXVTable(const CXXRecordDecl *RD,
4760 // <special-name> ::= TV <type> # virtual table
4761 CXXNameMangler Mangler(*this, Out);
4762 Mangler.getStream() << "_ZTV";
4763 Mangler.mangleNameOrStandardSubstitution(RD);
4766 void ItaniumMangleContextImpl::mangleCXXVTT(const CXXRecordDecl *RD,
4768 // <special-name> ::= TT <type> # VTT structure
4769 CXXNameMangler Mangler(*this, Out);
4770 Mangler.getStream() << "_ZTT";
4771 Mangler.mangleNameOrStandardSubstitution(RD);
4774 void ItaniumMangleContextImpl::mangleCXXCtorVTable(const CXXRecordDecl *RD,
4776 const CXXRecordDecl *Type,
4778 // <special-name> ::= TC <type> <offset number> _ <base type>
4779 CXXNameMangler Mangler(*this, Out);
4780 Mangler.getStream() << "_ZTC";
4781 Mangler.mangleNameOrStandardSubstitution(RD);
4782 Mangler.getStream() << Offset;
4783 Mangler.getStream() << '_';
4784 Mangler.mangleNameOrStandardSubstitution(Type);
4787 void ItaniumMangleContextImpl::mangleCXXRTTI(QualType Ty, raw_ostream &Out) {
4788 // <special-name> ::= TI <type> # typeinfo structure
4789 assert(!Ty.hasQualifiers() && "RTTI info cannot have top-level qualifiers");
4790 CXXNameMangler Mangler(*this, Out);
4791 Mangler.getStream() << "_ZTI";
4792 Mangler.mangleType(Ty);
4795 void ItaniumMangleContextImpl::mangleCXXRTTIName(QualType Ty,
4797 // <special-name> ::= TS <type> # typeinfo name (null terminated byte string)
4798 CXXNameMangler Mangler(*this, Out);
4799 Mangler.getStream() << "_ZTS";
4800 Mangler.mangleType(Ty);
4803 void ItaniumMangleContextImpl::mangleTypeName(QualType Ty, raw_ostream &Out) {
4804 mangleCXXRTTIName(Ty, Out);
4807 void ItaniumMangleContextImpl::mangleStringLiteral(const StringLiteral *, raw_ostream &) {
4808 llvm_unreachable("Can't mangle string literals");
4811 ItaniumMangleContext *
4812 ItaniumMangleContext::create(ASTContext &Context, DiagnosticsEngine &Diags) {
4813 return new ItaniumMangleContextImpl(Context, Diags);