1 //===--- ItaniumMangle.cpp - Itanium C++ Name Mangling ----------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // Implements C++ name mangling according to the Itanium C++ ABI,
10 // which is used in GCC 3.2 and newer (and many compilers that are
11 // ABI-compatible with GCC):
12 //
13 //   http://itanium-cxx-abi.github.io/cxx-abi/abi.html#mangling
14 //
15 //===----------------------------------------------------------------------===//
16 
17 #include "clang/AST/ASTContext.h"
18 #include "clang/AST/Attr.h"
19 #include "clang/AST/Decl.h"
20 #include "clang/AST/DeclCXX.h"
21 #include "clang/AST/DeclObjC.h"
22 #include "clang/AST/DeclOpenMP.h"
23 #include "clang/AST/DeclTemplate.h"
24 #include "clang/AST/Expr.h"
25 #include "clang/AST/ExprCXX.h"
26 #include "clang/AST/ExprConcepts.h"
27 #include "clang/AST/ExprObjC.h"
28 #include "clang/AST/Mangle.h"
29 #include "clang/AST/TypeLoc.h"
30 #include "clang/Basic/ABI.h"
31 #include "clang/Basic/Module.h"
32 #include "clang/Basic/SourceManager.h"
33 #include "clang/Basic/TargetInfo.h"
34 #include "clang/Basic/Thunk.h"
35 #include "llvm/ADT/StringExtras.h"
36 #include "llvm/Support/ErrorHandling.h"
37 #include "llvm/Support/raw_ostream.h"
38 
39 using namespace clang;
40 
41 namespace {
42 
43 /// Retrieve the declaration context that should be used when mangling the given
44 /// declaration.
45 static const DeclContext *getEffectiveDeclContext(const Decl *D) {
46   // The ABI assumes that lambda closure types that occur within
47   // default arguments live in the context of the function. However, due to
48   // the way in which Clang parses and creates function declarations, this is
49   // not the case: the lambda closure type ends up living in the context
50   // where the function itself resides, because the function declaration itself
51   // had not yet been created. Fix the context here.
52   if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
53     if (RD->isLambda())
54       if (ParmVarDecl *ContextParam
55             = dyn_cast_or_null<ParmVarDecl>(RD->getLambdaContextDecl()))
56         return ContextParam->getDeclContext();
57   }
58 
59   // Perform the same check for block literals.
60   if (const BlockDecl *BD = dyn_cast<BlockDecl>(D)) {
61     if (ParmVarDecl *ContextParam
62           = dyn_cast_or_null<ParmVarDecl>(BD->getBlockManglingContextDecl()))
63       return ContextParam->getDeclContext();
64   }
65 
66   const DeclContext *DC = D->getDeclContext();
67   if (isa<CapturedDecl>(DC) || isa<OMPDeclareReductionDecl>(DC) ||
68       isa<OMPDeclareMapperDecl>(DC)) {
69     return getEffectiveDeclContext(cast<Decl>(DC));
70   }
71 
72   if (const auto *VD = dyn_cast<VarDecl>(D))
73     if (VD->isExternC())
74       return VD->getASTContext().getTranslationUnitDecl();
75 
76   if (const auto *FD = dyn_cast<FunctionDecl>(D))
77     if (FD->isExternC())
78       return FD->getASTContext().getTranslationUnitDecl();
79 
80   return DC->getRedeclContext();
81 }
82 
83 static const DeclContext *getEffectiveParentContext(const DeclContext *DC) {
84   return getEffectiveDeclContext(cast<Decl>(DC));
85 }
86 
87 static bool isLocalContainerContext(const DeclContext *DC) {
88   return isa<FunctionDecl>(DC) || isa<ObjCMethodDecl>(DC) || isa<BlockDecl>(DC);
89 }
90 
91 static const RecordDecl *GetLocalClassDecl(const Decl *D) {
92   const DeclContext *DC = getEffectiveDeclContext(D);
93   while (!DC->isNamespace() && !DC->isTranslationUnit()) {
94     if (isLocalContainerContext(DC))
95       return dyn_cast<RecordDecl>(D);
96     D = cast<Decl>(DC);
97     DC = getEffectiveDeclContext(D);
98   }
99   return nullptr;
100 }
101 
102 static const FunctionDecl *getStructor(const FunctionDecl *fn) {
103   if (const FunctionTemplateDecl *ftd = fn->getPrimaryTemplate())
104     return ftd->getTemplatedDecl();
105 
106   return fn;
107 }
108 
109 static const NamedDecl *getStructor(const NamedDecl *decl) {
110   const FunctionDecl *fn = dyn_cast_or_null<FunctionDecl>(decl);
111   return (fn ? getStructor(fn) : decl);
112 }
113 
114 static bool isLambda(const NamedDecl *ND) {
115   const CXXRecordDecl *Record = dyn_cast<CXXRecordDecl>(ND);
116   if (!Record)
117     return false;
118 
119   return Record->isLambda();
120 }
121 
122 static const unsigned UnknownArity = ~0U;
123 
124 class ItaniumMangleContextImpl : public ItaniumMangleContext {
125   typedef std::pair<const DeclContext*, IdentifierInfo*> DiscriminatorKeyTy;
126   llvm::DenseMap<DiscriminatorKeyTy, unsigned> Discriminator;
127   llvm::DenseMap<const NamedDecl*, unsigned> Uniquifier;
128   const DiscriminatorOverrideTy DiscriminatorOverride = nullptr;
129 
130   bool NeedsUniqueInternalLinkageNames = false;
131 
132 public:
133   explicit ItaniumMangleContextImpl(
134       ASTContext &Context, DiagnosticsEngine &Diags,
135       DiscriminatorOverrideTy DiscriminatorOverride)
136       : ItaniumMangleContext(Context, Diags),
137         DiscriminatorOverride(DiscriminatorOverride) {}
138 
139   /// @name Mangler Entry Points
140   /// @{
141 
142   bool shouldMangleCXXName(const NamedDecl *D) override;
143   bool shouldMangleStringLiteral(const StringLiteral *) override {
144     return false;
145   }
146 
147   bool isUniqueInternalLinkageDecl(const NamedDecl *ND) override;
148   void needsUniqueInternalLinkageNames() override {
149     NeedsUniqueInternalLinkageNames = true;
150   }
151 
152   void mangleCXXName(GlobalDecl GD, raw_ostream &) override;
153   void mangleThunk(const CXXMethodDecl *MD, const ThunkInfo &Thunk,
154                    raw_ostream &) override;
155   void mangleCXXDtorThunk(const CXXDestructorDecl *DD, CXXDtorType Type,
156                           const ThisAdjustment &ThisAdjustment,
157                           raw_ostream &) override;
158   void mangleReferenceTemporary(const VarDecl *D, unsigned ManglingNumber,
159                                 raw_ostream &) override;
160   void mangleCXXVTable(const CXXRecordDecl *RD, raw_ostream &) override;
161   void mangleCXXVTT(const CXXRecordDecl *RD, raw_ostream &) override;
162   void mangleCXXCtorVTable(const CXXRecordDecl *RD, int64_t Offset,
163                            const CXXRecordDecl *Type, raw_ostream &) override;
164   void mangleCXXRTTI(QualType T, raw_ostream &) override;
165   void mangleCXXRTTIName(QualType T, raw_ostream &) override;
166   void mangleTypeName(QualType T, raw_ostream &) override;
167 
168   void mangleCXXCtorComdat(const CXXConstructorDecl *D, raw_ostream &) override;
169   void mangleCXXDtorComdat(const CXXDestructorDecl *D, raw_ostream &) override;
170   void mangleStaticGuardVariable(const VarDecl *D, raw_ostream &) override;
171   void mangleDynamicInitializer(const VarDecl *D, raw_ostream &Out) override;
172   void mangleDynamicAtExitDestructor(const VarDecl *D,
173                                      raw_ostream &Out) override;
174   void mangleDynamicStermFinalizer(const VarDecl *D, raw_ostream &Out) override;
175   void mangleSEHFilterExpression(const NamedDecl *EnclosingDecl,
176                                  raw_ostream &Out) override;
177   void mangleSEHFinallyBlock(const NamedDecl *EnclosingDecl,
178                              raw_ostream &Out) override;
179   void mangleItaniumThreadLocalInit(const VarDecl *D, raw_ostream &) override;
180   void mangleItaniumThreadLocalWrapper(const VarDecl *D,
181                                        raw_ostream &) override;
182 
183   void mangleStringLiteral(const StringLiteral *, raw_ostream &) override;
184 
185   void mangleLambdaSig(const CXXRecordDecl *Lambda, raw_ostream &) override;
186 
187   bool getNextDiscriminator(const NamedDecl *ND, unsigned &disc) {
188     // Lambda closure types are already numbered.
189     if (isLambda(ND))
190       return false;
191 
192     // Anonymous tags are already numbered.
193     if (const TagDecl *Tag = dyn_cast<TagDecl>(ND)) {
194       if (Tag->getName().empty() && !Tag->getTypedefNameForAnonDecl())
195         return false;
196     }
197 
198     // Use the canonical number for externally visible decls.
199     if (ND->isExternallyVisible()) {
200       unsigned discriminator = getASTContext().getManglingNumber(ND);
201       if (discriminator == 1)
202         return false;
203       disc = discriminator - 2;
204       return true;
205     }
206 
207     // Make up a reasonable number for internal decls.
208     unsigned &discriminator = Uniquifier[ND];
209     if (!discriminator) {
210       const DeclContext *DC = getEffectiveDeclContext(ND);
211       discriminator = ++Discriminator[std::make_pair(DC, ND->getIdentifier())];
212     }
213     if (discriminator == 1)
214       return false;
215     disc = discriminator-2;
216     return true;
217   }
218 
219   std::string getLambdaString(const CXXRecordDecl *Lambda) override {
220     // This function matches the one in MicrosoftMangle, which returns
221     // the string that is used in lambda mangled names.
222     assert(Lambda->isLambda() && "RD must be a lambda!");
223     std::string Name("<lambda");
224     Decl *LambdaContextDecl = Lambda->getLambdaContextDecl();
225     unsigned LambdaManglingNumber = Lambda->getLambdaManglingNumber();
226     unsigned LambdaId;
227     const ParmVarDecl *Parm = dyn_cast_or_null<ParmVarDecl>(LambdaContextDecl);
228     const FunctionDecl *Func =
229         Parm ? dyn_cast<FunctionDecl>(Parm->getDeclContext()) : nullptr;
230 
231     if (Func) {
232       unsigned DefaultArgNo =
233           Func->getNumParams() - Parm->getFunctionScopeIndex();
234       Name += llvm::utostr(DefaultArgNo);
235       Name += "_";
236     }
237 
238     if (LambdaManglingNumber)
239       LambdaId = LambdaManglingNumber;
240     else
241       LambdaId = getAnonymousStructIdForDebugInfo(Lambda);
242 
243     Name += llvm::utostr(LambdaId);
244     Name += '>';
245     return Name;
246   }
247 
248   DiscriminatorOverrideTy getDiscriminatorOverride() const override {
249     return DiscriminatorOverride;
250   }
251 
252   /// @}
253 };
254 
255 /// Manage the mangling of a single name.
256 class CXXNameMangler {
257   ItaniumMangleContextImpl &Context;
258   raw_ostream &Out;
259   bool NullOut = false;
260   /// In the "DisableDerivedAbiTags" mode derived ABI tags are not calculated.
261   /// This mode is used when mangler creates another mangler recursively to
262   /// calculate ABI tags for the function return value or the variable type.
263   /// Also it is required to avoid infinite recursion in some cases.
264   bool DisableDerivedAbiTags = false;
265 
266   /// The "structor" is the top-level declaration being mangled, if
267   /// that's not a template specialization; otherwise it's the pattern
268   /// for that specialization.
269   const NamedDecl *Structor;
270   unsigned StructorType;
271 
272   /// The next substitution sequence number.
273   unsigned SeqID;
274 
275   class FunctionTypeDepthState {
276     unsigned Bits;
277 
278     enum { InResultTypeMask = 1 };
279 
280   public:
281     FunctionTypeDepthState() : Bits(0) {}
282 
283     /// The number of function types we're inside.
284     unsigned getDepth() const {
285       return Bits >> 1;
286     }
287 
288     /// True if we're in the return type of the innermost function type.
289     bool isInResultType() const {
290       return Bits & InResultTypeMask;
291     }
292 
293     FunctionTypeDepthState push() {
294       FunctionTypeDepthState tmp = *this;
295       Bits = (Bits & ~InResultTypeMask) + 2;
296       return tmp;
297     }
298 
299     void enterResultType() {
300       Bits |= InResultTypeMask;
301     }
302 
303     void leaveResultType() {
304       Bits &= ~InResultTypeMask;
305     }
306 
307     void pop(FunctionTypeDepthState saved) {
308       assert(getDepth() == saved.getDepth() + 1);
309       Bits = saved.Bits;
310     }
311 
312   } FunctionTypeDepth;
313 
314   // abi_tag is a gcc attribute, taking one or more strings called "tags".
315   // The goal is to annotate against which version of a library an object was
316   // built and to be able to provide backwards compatibility ("dual abi").
317   // For more information see docs/ItaniumMangleAbiTags.rst.
318   typedef SmallVector<StringRef, 4> AbiTagList;
319 
320   // State to gather all implicit and explicit tags used in a mangled name.
321   // Must always have an instance of this while emitting any name to keep
322   // track.
323   class AbiTagState final {
324   public:
325     explicit AbiTagState(AbiTagState *&Head) : LinkHead(Head) {
326       Parent = LinkHead;
327       LinkHead = this;
328     }
329 
330     // No copy, no move.
331     AbiTagState(const AbiTagState &) = delete;
332     AbiTagState &operator=(const AbiTagState &) = delete;
333 
334     ~AbiTagState() { pop(); }
335 
336     void write(raw_ostream &Out, const NamedDecl *ND,
337                const AbiTagList *AdditionalAbiTags) {
338       ND = cast<NamedDecl>(ND->getCanonicalDecl());
339       if (!isa<FunctionDecl>(ND) && !isa<VarDecl>(ND)) {
340         assert(
341             !AdditionalAbiTags &&
342             "only function and variables need a list of additional abi tags");
343         if (const auto *NS = dyn_cast<NamespaceDecl>(ND)) {
344           if (const auto *AbiTag = NS->getAttr<AbiTagAttr>()) {
345             UsedAbiTags.insert(UsedAbiTags.end(), AbiTag->tags().begin(),
346                                AbiTag->tags().end());
347           }
348           // Don't emit abi tags for namespaces.
349           return;
350         }
351       }
352 
353       AbiTagList TagList;
354       if (const auto *AbiTag = ND->getAttr<AbiTagAttr>()) {
355         UsedAbiTags.insert(UsedAbiTags.end(), AbiTag->tags().begin(),
356                            AbiTag->tags().end());
357         TagList.insert(TagList.end(), AbiTag->tags().begin(),
358                        AbiTag->tags().end());
359       }
360 
361       if (AdditionalAbiTags) {
362         UsedAbiTags.insert(UsedAbiTags.end(), AdditionalAbiTags->begin(),
363                            AdditionalAbiTags->end());
364         TagList.insert(TagList.end(), AdditionalAbiTags->begin(),
365                        AdditionalAbiTags->end());
366       }
367 
368       llvm::sort(TagList);
369       TagList.erase(std::unique(TagList.begin(), TagList.end()), TagList.end());
370 
371       writeSortedUniqueAbiTags(Out, TagList);
372     }
373 
374     const AbiTagList &getUsedAbiTags() const { return UsedAbiTags; }
375     void setUsedAbiTags(const AbiTagList &AbiTags) {
376       UsedAbiTags = AbiTags;
377     }
378 
379     const AbiTagList &getEmittedAbiTags() const {
380       return EmittedAbiTags;
381     }
382 
383     const AbiTagList &getSortedUniqueUsedAbiTags() {
384       llvm::sort(UsedAbiTags);
385       UsedAbiTags.erase(std::unique(UsedAbiTags.begin(), UsedAbiTags.end()),
386                         UsedAbiTags.end());
387       return UsedAbiTags;
388     }
389 
390   private:
391     //! All abi tags used implicitly or explicitly.
392     AbiTagList UsedAbiTags;
393     //! All explicit abi tags (i.e. not from namespace).
394     AbiTagList EmittedAbiTags;
395 
396     AbiTagState *&LinkHead;
397     AbiTagState *Parent = nullptr;
398 
399     void pop() {
400       assert(LinkHead == this &&
401              "abi tag link head must point to us on destruction");
402       if (Parent) {
403         Parent->UsedAbiTags.insert(Parent->UsedAbiTags.end(),
404                                    UsedAbiTags.begin(), UsedAbiTags.end());
405         Parent->EmittedAbiTags.insert(Parent->EmittedAbiTags.end(),
406                                       EmittedAbiTags.begin(),
407                                       EmittedAbiTags.end());
408       }
409       LinkHead = Parent;
410     }
411 
412     void writeSortedUniqueAbiTags(raw_ostream &Out, const AbiTagList &AbiTags) {
413       for (const auto &Tag : AbiTags) {
414         EmittedAbiTags.push_back(Tag);
415         Out << "B";
416         Out << Tag.size();
417         Out << Tag;
418       }
419     }
420   };
421 
422   AbiTagState *AbiTags = nullptr;
423   AbiTagState AbiTagsRoot;
424 
425   llvm::DenseMap<uintptr_t, unsigned> Substitutions;
426   llvm::DenseMap<StringRef, unsigned> ModuleSubstitutions;
427 
428   ASTContext &getASTContext() const { return Context.getASTContext(); }
429 
430 public:
431   CXXNameMangler(ItaniumMangleContextImpl &C, raw_ostream &Out_,
432                  const NamedDecl *D = nullptr, bool NullOut_ = false)
433     : Context(C), Out(Out_), NullOut(NullOut_),  Structor(getStructor(D)),
434       StructorType(0), SeqID(0), AbiTagsRoot(AbiTags) {
435     // These can't be mangled without a ctor type or dtor type.
436     assert(!D || (!isa<CXXDestructorDecl>(D) &&
437                   !isa<CXXConstructorDecl>(D)));
438   }
439   CXXNameMangler(ItaniumMangleContextImpl &C, raw_ostream &Out_,
440                  const CXXConstructorDecl *D, CXXCtorType Type)
441     : Context(C), Out(Out_), Structor(getStructor(D)), StructorType(Type),
442       SeqID(0), AbiTagsRoot(AbiTags) { }
443   CXXNameMangler(ItaniumMangleContextImpl &C, raw_ostream &Out_,
444                  const CXXDestructorDecl *D, CXXDtorType Type)
445     : Context(C), Out(Out_), Structor(getStructor(D)), StructorType(Type),
446       SeqID(0), AbiTagsRoot(AbiTags) { }
447 
448   CXXNameMangler(CXXNameMangler &Outer, raw_ostream &Out_)
449       : Context(Outer.Context), Out(Out_), NullOut(false),
450         Structor(Outer.Structor), StructorType(Outer.StructorType),
451         SeqID(Outer.SeqID), FunctionTypeDepth(Outer.FunctionTypeDepth),
452         AbiTagsRoot(AbiTags), Substitutions(Outer.Substitutions) {}
453 
454   CXXNameMangler(CXXNameMangler &Outer, llvm::raw_null_ostream &Out_)
455       : Context(Outer.Context), Out(Out_), NullOut(true),
456         Structor(Outer.Structor), StructorType(Outer.StructorType),
457         SeqID(Outer.SeqID), FunctionTypeDepth(Outer.FunctionTypeDepth),
458         AbiTagsRoot(AbiTags), Substitutions(Outer.Substitutions) {}
459 
460   raw_ostream &getStream() { return Out; }
461 
462   void disableDerivedAbiTags() { DisableDerivedAbiTags = true; }
463   static bool shouldHaveAbiTags(ItaniumMangleContextImpl &C, const VarDecl *VD);
464 
465   void mangle(GlobalDecl GD);
466   void mangleCallOffset(int64_t NonVirtual, int64_t Virtual);
467   void mangleNumber(const llvm::APSInt &I);
468   void mangleNumber(int64_t Number);
469   void mangleFloat(const llvm::APFloat &F);
470   void mangleFunctionEncoding(GlobalDecl GD);
471   void mangleSeqID(unsigned SeqID);
472   void mangleName(GlobalDecl GD);
473   void mangleType(QualType T);
474   void mangleNameOrStandardSubstitution(const NamedDecl *ND);
475   void mangleLambdaSig(const CXXRecordDecl *Lambda);
476 
477 private:
478 
479   bool mangleSubstitution(const NamedDecl *ND);
480   bool mangleSubstitution(QualType T);
481   bool mangleSubstitution(TemplateName Template);
482   bool mangleSubstitution(uintptr_t Ptr);
483 
484   void mangleExistingSubstitution(TemplateName name);
485 
486   bool mangleStandardSubstitution(const NamedDecl *ND);
487 
488   void addSubstitution(const NamedDecl *ND) {
489     ND = cast<NamedDecl>(ND->getCanonicalDecl());
490 
491     addSubstitution(reinterpret_cast<uintptr_t>(ND));
492   }
493   void addSubstitution(QualType T);
494   void addSubstitution(TemplateName Template);
495   void addSubstitution(uintptr_t Ptr);
496   // Destructive copy substitutions from other mangler.
497   void extendSubstitutions(CXXNameMangler* Other);
498 
499   void mangleUnresolvedPrefix(NestedNameSpecifier *qualifier,
500                               bool recursive = false);
501   void mangleUnresolvedName(NestedNameSpecifier *qualifier,
502                             DeclarationName name,
503                             const TemplateArgumentLoc *TemplateArgs,
504                             unsigned NumTemplateArgs,
505                             unsigned KnownArity = UnknownArity);
506 
507   void mangleFunctionEncodingBareType(const FunctionDecl *FD);
508 
509   void mangleNameWithAbiTags(GlobalDecl GD,
510                              const AbiTagList *AdditionalAbiTags);
511   void mangleModuleName(const Module *M);
512   void mangleModuleNamePrefix(StringRef Name);
513   void mangleTemplateName(const TemplateDecl *TD,
514                           const TemplateArgument *TemplateArgs,
515                           unsigned NumTemplateArgs);
516   void mangleUnqualifiedName(GlobalDecl GD,
517                              const AbiTagList *AdditionalAbiTags) {
518     mangleUnqualifiedName(GD, cast<NamedDecl>(GD.getDecl())->getDeclName(), UnknownArity,
519                           AdditionalAbiTags);
520   }
521   void mangleUnqualifiedName(GlobalDecl GD, DeclarationName Name,
522                              unsigned KnownArity,
523                              const AbiTagList *AdditionalAbiTags);
524   void mangleUnscopedName(GlobalDecl GD,
525                           const AbiTagList *AdditionalAbiTags);
526   void mangleUnscopedTemplateName(GlobalDecl GD,
527                                   const AbiTagList *AdditionalAbiTags);
528   void mangleSourceName(const IdentifierInfo *II);
529   void mangleRegCallName(const IdentifierInfo *II);
530   void mangleDeviceStubName(const IdentifierInfo *II);
531   void mangleSourceNameWithAbiTags(
532       const NamedDecl *ND, const AbiTagList *AdditionalAbiTags = nullptr);
533   void mangleLocalName(GlobalDecl GD,
534                        const AbiTagList *AdditionalAbiTags);
535   void mangleBlockForPrefix(const BlockDecl *Block);
536   void mangleUnqualifiedBlock(const BlockDecl *Block);
537   void mangleTemplateParamDecl(const NamedDecl *Decl);
538   void mangleLambda(const CXXRecordDecl *Lambda);
539   void mangleNestedName(GlobalDecl GD, const DeclContext *DC,
540                         const AbiTagList *AdditionalAbiTags,
541                         bool NoFunction=false);
542   void mangleNestedName(const TemplateDecl *TD,
543                         const TemplateArgument *TemplateArgs,
544                         unsigned NumTemplateArgs);
545   void mangleNestedNameWithClosurePrefix(GlobalDecl GD,
546                                          const NamedDecl *PrefixND,
547                                          const AbiTagList *AdditionalAbiTags);
548   void manglePrefix(NestedNameSpecifier *qualifier);
549   void manglePrefix(const DeclContext *DC, bool NoFunction=false);
550   void manglePrefix(QualType type);
551   void mangleTemplatePrefix(GlobalDecl GD, bool NoFunction=false);
552   void mangleTemplatePrefix(TemplateName Template);
553   const NamedDecl *getClosurePrefix(const Decl *ND);
554   void mangleClosurePrefix(const NamedDecl *ND, bool NoFunction = false);
555   bool mangleUnresolvedTypeOrSimpleId(QualType DestroyedType,
556                                       StringRef Prefix = "");
557   void mangleOperatorName(DeclarationName Name, unsigned Arity);
558   void mangleOperatorName(OverloadedOperatorKind OO, unsigned Arity);
559   void mangleVendorQualifier(StringRef qualifier);
560   void mangleQualifiers(Qualifiers Quals, const DependentAddressSpaceType *DAST = nullptr);
561   void mangleRefQualifier(RefQualifierKind RefQualifier);
562 
563   void mangleObjCMethodName(const ObjCMethodDecl *MD);
564 
565   // Declare manglers for every type class.
566 #define ABSTRACT_TYPE(CLASS, PARENT)
567 #define NON_CANONICAL_TYPE(CLASS, PARENT)
568 #define TYPE(CLASS, PARENT) void mangleType(const CLASS##Type *T);
569 #include "clang/AST/TypeNodes.inc"
570 
571   void mangleType(const TagType*);
572   void mangleType(TemplateName);
573   static StringRef getCallingConvQualifierName(CallingConv CC);
574   void mangleExtParameterInfo(FunctionProtoType::ExtParameterInfo info);
575   void mangleExtFunctionInfo(const FunctionType *T);
576   void mangleBareFunctionType(const FunctionProtoType *T, bool MangleReturnType,
577                               const FunctionDecl *FD = nullptr);
578   void mangleNeonVectorType(const VectorType *T);
579   void mangleNeonVectorType(const DependentVectorType *T);
580   void mangleAArch64NeonVectorType(const VectorType *T);
581   void mangleAArch64NeonVectorType(const DependentVectorType *T);
582   void mangleAArch64FixedSveVectorType(const VectorType *T);
583   void mangleAArch64FixedSveVectorType(const DependentVectorType *T);
584 
585   void mangleIntegerLiteral(QualType T, const llvm::APSInt &Value);
586   void mangleFloatLiteral(QualType T, const llvm::APFloat &V);
587   void mangleFixedPointLiteral();
588   void mangleNullPointer(QualType T);
589 
590   void mangleMemberExprBase(const Expr *base, bool isArrow);
591   void mangleMemberExpr(const Expr *base, bool isArrow,
592                         NestedNameSpecifier *qualifier,
593                         NamedDecl *firstQualifierLookup,
594                         DeclarationName name,
595                         const TemplateArgumentLoc *TemplateArgs,
596                         unsigned NumTemplateArgs,
597                         unsigned knownArity);
598   void mangleCastExpression(const Expr *E, StringRef CastEncoding);
599   void mangleInitListElements(const InitListExpr *InitList);
600   void mangleExpression(const Expr *E, unsigned Arity = UnknownArity,
601                         bool AsTemplateArg = false);
602   void mangleCXXCtorType(CXXCtorType T, const CXXRecordDecl *InheritedFrom);
603   void mangleCXXDtorType(CXXDtorType T);
604 
605   void mangleTemplateArgs(TemplateName TN,
606                           const TemplateArgumentLoc *TemplateArgs,
607                           unsigned NumTemplateArgs);
608   void mangleTemplateArgs(TemplateName TN, const TemplateArgument *TemplateArgs,
609                           unsigned NumTemplateArgs);
610   void mangleTemplateArgs(TemplateName TN, const TemplateArgumentList &AL);
611   void mangleTemplateArg(TemplateArgument A, bool NeedExactType);
612   void mangleTemplateArgExpr(const Expr *E);
613   void mangleValueInTemplateArg(QualType T, const APValue &V, bool TopLevel,
614                                 bool NeedExactType = false);
615 
616   void mangleTemplateParameter(unsigned Depth, unsigned Index);
617 
618   void mangleFunctionParam(const ParmVarDecl *parm);
619 
620   void writeAbiTags(const NamedDecl *ND,
621                     const AbiTagList *AdditionalAbiTags);
622 
623   // Returns sorted unique list of ABI tags.
624   AbiTagList makeFunctionReturnTypeTags(const FunctionDecl *FD);
625   // Returns sorted unique list of ABI tags.
626   AbiTagList makeVariableTypeTags(const VarDecl *VD);
627 };
628 
629 }
630 
631 static bool isInternalLinkageDecl(const NamedDecl *ND) {
632   if (ND && ND->getFormalLinkage() == InternalLinkage &&
633       !ND->isExternallyVisible() &&
634       getEffectiveDeclContext(ND)->isFileContext() &&
635       !ND->isInAnonymousNamespace())
636     return true;
637   return false;
638 }
639 
640 // Check if this Function Decl needs a unique internal linkage name.
641 bool ItaniumMangleContextImpl::isUniqueInternalLinkageDecl(
642     const NamedDecl *ND) {
643   if (!NeedsUniqueInternalLinkageNames || !ND)
644     return false;
645 
646   const auto *FD = dyn_cast<FunctionDecl>(ND);
647   if (!FD)
648     return false;
649 
650   // For C functions without prototypes, return false as their
651   // names should not be mangled.
652   if (!FD->hasPrototype())
653     return false;
654 
655   if (isInternalLinkageDecl(ND))
656     return true;
657 
658   return false;
659 }
660 
661 bool ItaniumMangleContextImpl::shouldMangleCXXName(const NamedDecl *D) {
662   const FunctionDecl *FD = dyn_cast<FunctionDecl>(D);
663   if (FD) {
664     LanguageLinkage L = FD->getLanguageLinkage();
665     // Overloadable functions need mangling.
666     if (FD->hasAttr<OverloadableAttr>())
667       return true;
668 
669     // "main" is not mangled.
670     if (FD->isMain())
671       return false;
672 
673     // The Windows ABI expects that we would never mangle "typical"
674     // user-defined entry points regardless of visibility or freestanding-ness.
675     //
676     // N.B. This is distinct from asking about "main".  "main" has a lot of
677     // special rules associated with it in the standard while these
678     // user-defined entry points are outside of the purview of the standard.
679     // For example, there can be only one definition for "main" in a standards
680     // compliant program; however nothing forbids the existence of wmain and
681     // WinMain in the same translation unit.
682     if (FD->isMSVCRTEntryPoint())
683       return false;
684 
685     // C++ functions and those whose names are not a simple identifier need
686     // mangling.
687     if (!FD->getDeclName().isIdentifier() || L == CXXLanguageLinkage)
688       return true;
689 
690     // C functions are not mangled.
691     if (L == CLanguageLinkage)
692       return false;
693   }
694 
695   // Otherwise, no mangling is done outside C++ mode.
696   if (!getASTContext().getLangOpts().CPlusPlus)
697     return false;
698 
699   const VarDecl *VD = dyn_cast<VarDecl>(D);
700   if (VD && !isa<DecompositionDecl>(D)) {
701     // C variables are not mangled.
702     if (VD->isExternC())
703       return false;
704 
705     // Variables at global scope with non-internal linkage are not mangled
706     const DeclContext *DC = getEffectiveDeclContext(D);
707     // Check for extern variable declared locally.
708     if (DC->isFunctionOrMethod() && D->hasLinkage())
709       while (!DC->isNamespace() && !DC->isTranslationUnit())
710         DC = getEffectiveParentContext(DC);
711     if (DC->isTranslationUnit() && D->getFormalLinkage() != InternalLinkage &&
712         !CXXNameMangler::shouldHaveAbiTags(*this, VD) &&
713         !isa<VarTemplateSpecializationDecl>(D))
714       return false;
715   }
716 
717   return true;
718 }
719 
720 void CXXNameMangler::writeAbiTags(const NamedDecl *ND,
721                                   const AbiTagList *AdditionalAbiTags) {
722   assert(AbiTags && "require AbiTagState");
723   AbiTags->write(Out, ND, DisableDerivedAbiTags ? nullptr : AdditionalAbiTags);
724 }
725 
726 void CXXNameMangler::mangleSourceNameWithAbiTags(
727     const NamedDecl *ND, const AbiTagList *AdditionalAbiTags) {
728   mangleSourceName(ND->getIdentifier());
729   writeAbiTags(ND, AdditionalAbiTags);
730 }
731 
732 void CXXNameMangler::mangle(GlobalDecl GD) {
733   // <mangled-name> ::= _Z <encoding>
734   //            ::= <data name>
735   //            ::= <special-name>
736   Out << "_Z";
737   if (isa<FunctionDecl>(GD.getDecl()))
738     mangleFunctionEncoding(GD);
739   else if (isa<VarDecl, FieldDecl, MSGuidDecl, TemplateParamObjectDecl,
740                BindingDecl>(GD.getDecl()))
741     mangleName(GD);
742   else if (const IndirectFieldDecl *IFD =
743                dyn_cast<IndirectFieldDecl>(GD.getDecl()))
744     mangleName(IFD->getAnonField());
745   else
746     llvm_unreachable("unexpected kind of global decl");
747 }
748 
749 void CXXNameMangler::mangleFunctionEncoding(GlobalDecl GD) {
750   const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl());
751   // <encoding> ::= <function name> <bare-function-type>
752 
753   // Don't mangle in the type if this isn't a decl we should typically mangle.
754   if (!Context.shouldMangleDeclName(FD)) {
755     mangleName(GD);
756     return;
757   }
758 
759   AbiTagList ReturnTypeAbiTags = makeFunctionReturnTypeTags(FD);
760   if (ReturnTypeAbiTags.empty()) {
761     // There are no tags for return type, the simplest case.
762     mangleName(GD);
763     mangleFunctionEncodingBareType(FD);
764     return;
765   }
766 
767   // Mangle function name and encoding to temporary buffer.
768   // We have to output name and encoding to the same mangler to get the same
769   // substitution as it will be in final mangling.
770   SmallString<256> FunctionEncodingBuf;
771   llvm::raw_svector_ostream FunctionEncodingStream(FunctionEncodingBuf);
772   CXXNameMangler FunctionEncodingMangler(*this, FunctionEncodingStream);
773   // Output name of the function.
774   FunctionEncodingMangler.disableDerivedAbiTags();
775   FunctionEncodingMangler.mangleNameWithAbiTags(FD, nullptr);
776 
777   // Remember length of the function name in the buffer.
778   size_t EncodingPositionStart = FunctionEncodingStream.str().size();
779   FunctionEncodingMangler.mangleFunctionEncodingBareType(FD);
780 
781   // Get tags from return type that are not present in function name or
782   // encoding.
783   const AbiTagList &UsedAbiTags =
784       FunctionEncodingMangler.AbiTagsRoot.getSortedUniqueUsedAbiTags();
785   AbiTagList AdditionalAbiTags(ReturnTypeAbiTags.size());
786   AdditionalAbiTags.erase(
787       std::set_difference(ReturnTypeAbiTags.begin(), ReturnTypeAbiTags.end(),
788                           UsedAbiTags.begin(), UsedAbiTags.end(),
789                           AdditionalAbiTags.begin()),
790       AdditionalAbiTags.end());
791 
792   // Output name with implicit tags and function encoding from temporary buffer.
793   mangleNameWithAbiTags(FD, &AdditionalAbiTags);
794   Out << FunctionEncodingStream.str().substr(EncodingPositionStart);
795 
796   // Function encoding could create new substitutions so we have to add
797   // temp mangled substitutions to main mangler.
798   extendSubstitutions(&FunctionEncodingMangler);
799 }
800 
801 void CXXNameMangler::mangleFunctionEncodingBareType(const FunctionDecl *FD) {
802   if (FD->hasAttr<EnableIfAttr>()) {
803     FunctionTypeDepthState Saved = FunctionTypeDepth.push();
804     Out << "Ua9enable_ifI";
805     for (AttrVec::const_iterator I = FD->getAttrs().begin(),
806                                  E = FD->getAttrs().end();
807          I != E; ++I) {
808       EnableIfAttr *EIA = dyn_cast<EnableIfAttr>(*I);
809       if (!EIA)
810         continue;
811       if (Context.getASTContext().getLangOpts().getClangABICompat() >
812           LangOptions::ClangABI::Ver11) {
813         mangleTemplateArgExpr(EIA->getCond());
814       } else {
815         // Prior to Clang 12, we hardcoded the X/E around enable-if's argument,
816         // even though <template-arg> should not include an X/E around
817         // <expr-primary>.
818         Out << 'X';
819         mangleExpression(EIA->getCond());
820         Out << 'E';
821       }
822     }
823     Out << 'E';
824     FunctionTypeDepth.pop(Saved);
825   }
826 
827   // When mangling an inheriting constructor, the bare function type used is
828   // that of the inherited constructor.
829   if (auto *CD = dyn_cast<CXXConstructorDecl>(FD))
830     if (auto Inherited = CD->getInheritedConstructor())
831       FD = Inherited.getConstructor();
832 
833   // Whether the mangling of a function type includes the return type depends on
834   // the context and the nature of the function. The rules for deciding whether
835   // the return type is included are:
836   //
837   //   1. Template functions (names or types) have return types encoded, with
838   //   the exceptions listed below.
839   //   2. Function types not appearing as part of a function name mangling,
840   //   e.g. parameters, pointer types, etc., have return type encoded, with the
841   //   exceptions listed below.
842   //   3. Non-template function names do not have return types encoded.
843   //
844   // The exceptions mentioned in (1) and (2) above, for which the return type is
845   // never included, are
846   //   1. Constructors.
847   //   2. Destructors.
848   //   3. Conversion operator functions, e.g. operator int.
849   bool MangleReturnType = false;
850   if (FunctionTemplateDecl *PrimaryTemplate = FD->getPrimaryTemplate()) {
851     if (!(isa<CXXConstructorDecl>(FD) || isa<CXXDestructorDecl>(FD) ||
852           isa<CXXConversionDecl>(FD)))
853       MangleReturnType = true;
854 
855     // Mangle the type of the primary template.
856     FD = PrimaryTemplate->getTemplatedDecl();
857   }
858 
859   mangleBareFunctionType(FD->getType()->castAs<FunctionProtoType>(),
860                          MangleReturnType, FD);
861 }
862 
863 static const DeclContext *IgnoreLinkageSpecDecls(const DeclContext *DC) {
864   while (isa<LinkageSpecDecl>(DC)) {
865     DC = getEffectiveParentContext(DC);
866   }
867 
868   return DC;
869 }
870 
871 /// Return whether a given namespace is the 'std' namespace.
872 static bool isStd(const NamespaceDecl *NS) {
873   if (!IgnoreLinkageSpecDecls(getEffectiveParentContext(NS))
874                                 ->isTranslationUnit())
875     return false;
876 
877   const IdentifierInfo *II = NS->getOriginalNamespace()->getIdentifier();
878   return II && II->isStr("std");
879 }
880 
881 // isStdNamespace - Return whether a given decl context is a toplevel 'std'
882 // namespace.
883 static bool isStdNamespace(const DeclContext *DC) {
884   if (!DC->isNamespace())
885     return false;
886 
887   return isStd(cast<NamespaceDecl>(DC));
888 }
889 
890 static const GlobalDecl
891 isTemplate(GlobalDecl GD, const TemplateArgumentList *&TemplateArgs) {
892   const NamedDecl *ND = cast<NamedDecl>(GD.getDecl());
893   // Check if we have a function template.
894   if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)) {
895     if (const TemplateDecl *TD = FD->getPrimaryTemplate()) {
896       TemplateArgs = FD->getTemplateSpecializationArgs();
897       return GD.getWithDecl(TD);
898     }
899   }
900 
901   // Check if we have a class template.
902   if (const ClassTemplateSpecializationDecl *Spec =
903         dyn_cast<ClassTemplateSpecializationDecl>(ND)) {
904     TemplateArgs = &Spec->getTemplateArgs();
905     return GD.getWithDecl(Spec->getSpecializedTemplate());
906   }
907 
908   // Check if we have a variable template.
909   if (const VarTemplateSpecializationDecl *Spec =
910           dyn_cast<VarTemplateSpecializationDecl>(ND)) {
911     TemplateArgs = &Spec->getTemplateArgs();
912     return GD.getWithDecl(Spec->getSpecializedTemplate());
913   }
914 
915   return GlobalDecl();
916 }
917 
918 static TemplateName asTemplateName(GlobalDecl GD) {
919   const TemplateDecl *TD = dyn_cast_or_null<TemplateDecl>(GD.getDecl());
920   return TemplateName(const_cast<TemplateDecl*>(TD));
921 }
922 
923 void CXXNameMangler::mangleName(GlobalDecl GD) {
924   const NamedDecl *ND = cast<NamedDecl>(GD.getDecl());
925   if (const VarDecl *VD = dyn_cast<VarDecl>(ND)) {
926     // Variables should have implicit tags from its type.
927     AbiTagList VariableTypeAbiTags = makeVariableTypeTags(VD);
928     if (VariableTypeAbiTags.empty()) {
929       // Simple case no variable type tags.
930       mangleNameWithAbiTags(VD, nullptr);
931       return;
932     }
933 
934     // Mangle variable name to null stream to collect tags.
935     llvm::raw_null_ostream NullOutStream;
936     CXXNameMangler VariableNameMangler(*this, NullOutStream);
937     VariableNameMangler.disableDerivedAbiTags();
938     VariableNameMangler.mangleNameWithAbiTags(VD, nullptr);
939 
940     // Get tags from variable type that are not present in its name.
941     const AbiTagList &UsedAbiTags =
942         VariableNameMangler.AbiTagsRoot.getSortedUniqueUsedAbiTags();
943     AbiTagList AdditionalAbiTags(VariableTypeAbiTags.size());
944     AdditionalAbiTags.erase(
945         std::set_difference(VariableTypeAbiTags.begin(),
946                             VariableTypeAbiTags.end(), UsedAbiTags.begin(),
947                             UsedAbiTags.end(), AdditionalAbiTags.begin()),
948         AdditionalAbiTags.end());
949 
950     // Output name with implicit tags.
951     mangleNameWithAbiTags(VD, &AdditionalAbiTags);
952   } else {
953     mangleNameWithAbiTags(GD, nullptr);
954   }
955 }
956 
957 void CXXNameMangler::mangleNameWithAbiTags(GlobalDecl GD,
958                                            const AbiTagList *AdditionalAbiTags) {
959   const NamedDecl *ND = cast<NamedDecl>(GD.getDecl());
960   //  <name> ::= [<module-name>] <nested-name>
961   //         ::= [<module-name>] <unscoped-name>
962   //         ::= [<module-name>] <unscoped-template-name> <template-args>
963   //         ::= <local-name>
964   //
965   const DeclContext *DC = getEffectiveDeclContext(ND);
966 
967   // If this is an extern variable declared locally, the relevant DeclContext
968   // is that of the containing namespace, or the translation unit.
969   // FIXME: This is a hack; extern variables declared locally should have
970   // a proper semantic declaration context!
971   if (isLocalContainerContext(DC) && ND->hasLinkage() && !isLambda(ND))
972     while (!DC->isNamespace() && !DC->isTranslationUnit())
973       DC = getEffectiveParentContext(DC);
974   else if (GetLocalClassDecl(ND)) {
975     mangleLocalName(GD, AdditionalAbiTags);
976     return;
977   }
978 
979   DC = IgnoreLinkageSpecDecls(DC);
980 
981   if (isLocalContainerContext(DC)) {
982     mangleLocalName(GD, AdditionalAbiTags);
983     return;
984   }
985 
986   // Do not mangle the owning module for an external linkage declaration.
987   // This enables backwards-compatibility with non-modular code, and is
988   // a valid choice since conflicts are not permitted by C++ Modules TS
989   // [basic.def.odr]/6.2.
990   if (!ND->hasExternalFormalLinkage())
991     if (Module *M = ND->getOwningModuleForLinkage())
992       mangleModuleName(M);
993 
994   // Closures can require a nested-name mangling even if they're semantically
995   // in the global namespace.
996   if (const NamedDecl *PrefixND = getClosurePrefix(ND)) {
997     mangleNestedNameWithClosurePrefix(GD, PrefixND, AdditionalAbiTags);
998     return;
999   }
1000 
1001   if (DC->isTranslationUnit() || isStdNamespace(DC)) {
1002     // Check if we have a template.
1003     const TemplateArgumentList *TemplateArgs = nullptr;
1004     if (GlobalDecl TD = isTemplate(GD, TemplateArgs)) {
1005       mangleUnscopedTemplateName(TD, AdditionalAbiTags);
1006       mangleTemplateArgs(asTemplateName(TD), *TemplateArgs);
1007       return;
1008     }
1009 
1010     mangleUnscopedName(GD, AdditionalAbiTags);
1011     return;
1012   }
1013 
1014   mangleNestedName(GD, DC, AdditionalAbiTags);
1015 }
1016 
1017 void CXXNameMangler::mangleModuleName(const Module *M) {
1018   // Implement the C++ Modules TS name mangling proposal; see
1019   //     https://gcc.gnu.org/wiki/cxx-modules?action=AttachFile
1020   //
1021   //   <module-name> ::= W <unscoped-name>+ E
1022   //                 ::= W <module-subst> <unscoped-name>* E
1023   Out << 'W';
1024   mangleModuleNamePrefix(M->Name);
1025   Out << 'E';
1026 }
1027 
1028 void CXXNameMangler::mangleModuleNamePrefix(StringRef Name) {
1029   //  <module-subst> ::= _ <seq-id>          # 0 < seq-id < 10
1030   //                 ::= W <seq-id - 10> _   # otherwise
1031   auto It = ModuleSubstitutions.find(Name);
1032   if (It != ModuleSubstitutions.end()) {
1033     if (It->second < 10)
1034       Out << '_' << static_cast<char>('0' + It->second);
1035     else
1036       Out << 'W' << (It->second - 10) << '_';
1037     return;
1038   }
1039 
1040   // FIXME: Preserve hierarchy in module names rather than flattening
1041   // them to strings; use Module*s as substitution keys.
1042   auto Parts = Name.rsplit('.');
1043   if (Parts.second.empty())
1044     Parts.second = Parts.first;
1045   else
1046     mangleModuleNamePrefix(Parts.first);
1047 
1048   Out << Parts.second.size() << Parts.second;
1049   ModuleSubstitutions.insert({Name, ModuleSubstitutions.size()});
1050 }
1051 
1052 void CXXNameMangler::mangleTemplateName(const TemplateDecl *TD,
1053                                         const TemplateArgument *TemplateArgs,
1054                                         unsigned NumTemplateArgs) {
1055   const DeclContext *DC = IgnoreLinkageSpecDecls(getEffectiveDeclContext(TD));
1056 
1057   if (DC->isTranslationUnit() || isStdNamespace(DC)) {
1058     mangleUnscopedTemplateName(TD, nullptr);
1059     mangleTemplateArgs(asTemplateName(TD), TemplateArgs, NumTemplateArgs);
1060   } else {
1061     mangleNestedName(TD, TemplateArgs, NumTemplateArgs);
1062   }
1063 }
1064 
1065 void CXXNameMangler::mangleUnscopedName(GlobalDecl GD,
1066                                         const AbiTagList *AdditionalAbiTags) {
1067   const NamedDecl *ND = cast<NamedDecl>(GD.getDecl());
1068   //  <unscoped-name> ::= <unqualified-name>
1069   //                  ::= St <unqualified-name>   # ::std::
1070 
1071   if (isStdNamespace(IgnoreLinkageSpecDecls(getEffectiveDeclContext(ND))))
1072     Out << "St";
1073 
1074   mangleUnqualifiedName(GD, AdditionalAbiTags);
1075 }
1076 
1077 void CXXNameMangler::mangleUnscopedTemplateName(
1078     GlobalDecl GD, const AbiTagList *AdditionalAbiTags) {
1079   const TemplateDecl *ND = cast<TemplateDecl>(GD.getDecl());
1080   //     <unscoped-template-name> ::= <unscoped-name>
1081   //                              ::= <substitution>
1082   if (mangleSubstitution(ND))
1083     return;
1084 
1085   // <template-template-param> ::= <template-param>
1086   if (const auto *TTP = dyn_cast<TemplateTemplateParmDecl>(ND)) {
1087     assert(!AdditionalAbiTags &&
1088            "template template param cannot have abi tags");
1089     mangleTemplateParameter(TTP->getDepth(), TTP->getIndex());
1090   } else if (isa<BuiltinTemplateDecl>(ND) || isa<ConceptDecl>(ND)) {
1091     mangleUnscopedName(GD, AdditionalAbiTags);
1092   } else {
1093     mangleUnscopedName(GD.getWithDecl(ND->getTemplatedDecl()), AdditionalAbiTags);
1094   }
1095 
1096   addSubstitution(ND);
1097 }
1098 
1099 void CXXNameMangler::mangleFloat(const llvm::APFloat &f) {
1100   // ABI:
1101   //   Floating-point literals are encoded using a fixed-length
1102   //   lowercase hexadecimal string corresponding to the internal
1103   //   representation (IEEE on Itanium), high-order bytes first,
1104   //   without leading zeroes. For example: "Lf bf800000 E" is -1.0f
1105   //   on Itanium.
1106   // The 'without leading zeroes' thing seems to be an editorial
1107   // mistake; see the discussion on cxx-abi-dev beginning on
1108   // 2012-01-16.
1109 
1110   // Our requirements here are just barely weird enough to justify
1111   // using a custom algorithm instead of post-processing APInt::toString().
1112 
1113   llvm::APInt valueBits = f.bitcastToAPInt();
1114   unsigned numCharacters = (valueBits.getBitWidth() + 3) / 4;
1115   assert(numCharacters != 0);
1116 
1117   // Allocate a buffer of the right number of characters.
1118   SmallVector<char, 20> buffer(numCharacters);
1119 
1120   // Fill the buffer left-to-right.
1121   for (unsigned stringIndex = 0; stringIndex != numCharacters; ++stringIndex) {
1122     // The bit-index of the next hex digit.
1123     unsigned digitBitIndex = 4 * (numCharacters - stringIndex - 1);
1124 
1125     // Project out 4 bits starting at 'digitIndex'.
1126     uint64_t hexDigit = valueBits.getRawData()[digitBitIndex / 64];
1127     hexDigit >>= (digitBitIndex % 64);
1128     hexDigit &= 0xF;
1129 
1130     // Map that over to a lowercase hex digit.
1131     static const char charForHex[16] = {
1132       '0', '1', '2', '3', '4', '5', '6', '7',
1133       '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'
1134     };
1135     buffer[stringIndex] = charForHex[hexDigit];
1136   }
1137 
1138   Out.write(buffer.data(), numCharacters);
1139 }
1140 
1141 void CXXNameMangler::mangleFloatLiteral(QualType T, const llvm::APFloat &V) {
1142   Out << 'L';
1143   mangleType(T);
1144   mangleFloat(V);
1145   Out << 'E';
1146 }
1147 
1148 void CXXNameMangler::mangleFixedPointLiteral() {
1149   DiagnosticsEngine &Diags = Context.getDiags();
1150   unsigned DiagID = Diags.getCustomDiagID(
1151       DiagnosticsEngine::Error, "cannot mangle fixed point literals yet");
1152   Diags.Report(DiagID);
1153 }
1154 
1155 void CXXNameMangler::mangleNullPointer(QualType T) {
1156   //  <expr-primary> ::= L <type> 0 E
1157   Out << 'L';
1158   mangleType(T);
1159   Out << "0E";
1160 }
1161 
1162 void CXXNameMangler::mangleNumber(const llvm::APSInt &Value) {
1163   if (Value.isSigned() && Value.isNegative()) {
1164     Out << 'n';
1165     Value.abs().print(Out, /*signed*/ false);
1166   } else {
1167     Value.print(Out, /*signed*/ false);
1168   }
1169 }
1170 
1171 void CXXNameMangler::mangleNumber(int64_t Number) {
1172   //  <number> ::= [n] <non-negative decimal integer>
1173   if (Number < 0) {
1174     Out << 'n';
1175     Number = -Number;
1176   }
1177 
1178   Out << Number;
1179 }
1180 
1181 void CXXNameMangler::mangleCallOffset(int64_t NonVirtual, int64_t Virtual) {
1182   //  <call-offset>  ::= h <nv-offset> _
1183   //                 ::= v <v-offset> _
1184   //  <nv-offset>    ::= <offset number>        # non-virtual base override
1185   //  <v-offset>     ::= <offset number> _ <virtual offset number>
1186   //                      # virtual base override, with vcall offset
1187   if (!Virtual) {
1188     Out << 'h';
1189     mangleNumber(NonVirtual);
1190     Out << '_';
1191     return;
1192   }
1193 
1194   Out << 'v';
1195   mangleNumber(NonVirtual);
1196   Out << '_';
1197   mangleNumber(Virtual);
1198   Out << '_';
1199 }
1200 
1201 void CXXNameMangler::manglePrefix(QualType type) {
1202   if (const auto *TST = type->getAs<TemplateSpecializationType>()) {
1203     if (!mangleSubstitution(QualType(TST, 0))) {
1204       mangleTemplatePrefix(TST->getTemplateName());
1205 
1206       // FIXME: GCC does not appear to mangle the template arguments when
1207       // the template in question is a dependent template name. Should we
1208       // emulate that badness?
1209       mangleTemplateArgs(TST->getTemplateName(), TST->getArgs(),
1210                          TST->getNumArgs());
1211       addSubstitution(QualType(TST, 0));
1212     }
1213   } else if (const auto *DTST =
1214                  type->getAs<DependentTemplateSpecializationType>()) {
1215     if (!mangleSubstitution(QualType(DTST, 0))) {
1216       TemplateName Template = getASTContext().getDependentTemplateName(
1217           DTST->getQualifier(), DTST->getIdentifier());
1218       mangleTemplatePrefix(Template);
1219 
1220       // FIXME: GCC does not appear to mangle the template arguments when
1221       // the template in question is a dependent template name. Should we
1222       // emulate that badness?
1223       mangleTemplateArgs(Template, DTST->getArgs(), DTST->getNumArgs());
1224       addSubstitution(QualType(DTST, 0));
1225     }
1226   } else {
1227     // We use the QualType mangle type variant here because it handles
1228     // substitutions.
1229     mangleType(type);
1230   }
1231 }
1232 
1233 /// Mangle everything prior to the base-unresolved-name in an unresolved-name.
1234 ///
1235 /// \param recursive - true if this is being called recursively,
1236 ///   i.e. if there is more prefix "to the right".
1237 void CXXNameMangler::mangleUnresolvedPrefix(NestedNameSpecifier *qualifier,
1238                                             bool recursive) {
1239 
1240   // x, ::x
1241   // <unresolved-name> ::= [gs] <base-unresolved-name>
1242 
1243   // T::x / decltype(p)::x
1244   // <unresolved-name> ::= sr <unresolved-type> <base-unresolved-name>
1245 
1246   // T::N::x /decltype(p)::N::x
1247   // <unresolved-name> ::= srN <unresolved-type> <unresolved-qualifier-level>+ E
1248   //                       <base-unresolved-name>
1249 
1250   // A::x, N::y, A<T>::z; "gs" means leading "::"
1251   // <unresolved-name> ::= [gs] sr <unresolved-qualifier-level>+ E
1252   //                       <base-unresolved-name>
1253 
1254   switch (qualifier->getKind()) {
1255   case NestedNameSpecifier::Global:
1256     Out << "gs";
1257 
1258     // We want an 'sr' unless this is the entire NNS.
1259     if (recursive)
1260       Out << "sr";
1261 
1262     // We never want an 'E' here.
1263     return;
1264 
1265   case NestedNameSpecifier::Super:
1266     llvm_unreachable("Can't mangle __super specifier");
1267 
1268   case NestedNameSpecifier::Namespace:
1269     if (qualifier->getPrefix())
1270       mangleUnresolvedPrefix(qualifier->getPrefix(),
1271                              /*recursive*/ true);
1272     else
1273       Out << "sr";
1274     mangleSourceNameWithAbiTags(qualifier->getAsNamespace());
1275     break;
1276   case NestedNameSpecifier::NamespaceAlias:
1277     if (qualifier->getPrefix())
1278       mangleUnresolvedPrefix(qualifier->getPrefix(),
1279                              /*recursive*/ true);
1280     else
1281       Out << "sr";
1282     mangleSourceNameWithAbiTags(qualifier->getAsNamespaceAlias());
1283     break;
1284 
1285   case NestedNameSpecifier::TypeSpec:
1286   case NestedNameSpecifier::TypeSpecWithTemplate: {
1287     const Type *type = qualifier->getAsType();
1288 
1289     // We only want to use an unresolved-type encoding if this is one of:
1290     //   - a decltype
1291     //   - a template type parameter
1292     //   - a template template parameter with arguments
1293     // In all of these cases, we should have no prefix.
1294     if (qualifier->getPrefix()) {
1295       mangleUnresolvedPrefix(qualifier->getPrefix(),
1296                              /*recursive*/ true);
1297     } else {
1298       // Otherwise, all the cases want this.
1299       Out << "sr";
1300     }
1301 
1302     if (mangleUnresolvedTypeOrSimpleId(QualType(type, 0), recursive ? "N" : ""))
1303       return;
1304 
1305     break;
1306   }
1307 
1308   case NestedNameSpecifier::Identifier:
1309     // Member expressions can have these without prefixes.
1310     if (qualifier->getPrefix())
1311       mangleUnresolvedPrefix(qualifier->getPrefix(),
1312                              /*recursive*/ true);
1313     else
1314       Out << "sr";
1315 
1316     mangleSourceName(qualifier->getAsIdentifier());
1317     // An Identifier has no type information, so we can't emit abi tags for it.
1318     break;
1319   }
1320 
1321   // If this was the innermost part of the NNS, and we fell out to
1322   // here, append an 'E'.
1323   if (!recursive)
1324     Out << 'E';
1325 }
1326 
1327 /// Mangle an unresolved-name, which is generally used for names which
1328 /// weren't resolved to specific entities.
1329 void CXXNameMangler::mangleUnresolvedName(
1330     NestedNameSpecifier *qualifier, DeclarationName name,
1331     const TemplateArgumentLoc *TemplateArgs, unsigned NumTemplateArgs,
1332     unsigned knownArity) {
1333   if (qualifier) mangleUnresolvedPrefix(qualifier);
1334   switch (name.getNameKind()) {
1335     // <base-unresolved-name> ::= <simple-id>
1336     case DeclarationName::Identifier:
1337       mangleSourceName(name.getAsIdentifierInfo());
1338       break;
1339     // <base-unresolved-name> ::= dn <destructor-name>
1340     case DeclarationName::CXXDestructorName:
1341       Out << "dn";
1342       mangleUnresolvedTypeOrSimpleId(name.getCXXNameType());
1343       break;
1344     // <base-unresolved-name> ::= on <operator-name>
1345     case DeclarationName::CXXConversionFunctionName:
1346     case DeclarationName::CXXLiteralOperatorName:
1347     case DeclarationName::CXXOperatorName:
1348       Out << "on";
1349       mangleOperatorName(name, knownArity);
1350       break;
1351     case DeclarationName::CXXConstructorName:
1352       llvm_unreachable("Can't mangle a constructor name!");
1353     case DeclarationName::CXXUsingDirective:
1354       llvm_unreachable("Can't mangle a using directive name!");
1355     case DeclarationName::CXXDeductionGuideName:
1356       llvm_unreachable("Can't mangle a deduction guide name!");
1357     case DeclarationName::ObjCMultiArgSelector:
1358     case DeclarationName::ObjCOneArgSelector:
1359     case DeclarationName::ObjCZeroArgSelector:
1360       llvm_unreachable("Can't mangle Objective-C selector names here!");
1361   }
1362 
1363   // The <simple-id> and on <operator-name> productions end in an optional
1364   // <template-args>.
1365   if (TemplateArgs)
1366     mangleTemplateArgs(TemplateName(), TemplateArgs, NumTemplateArgs);
1367 }
1368 
1369 void CXXNameMangler::mangleUnqualifiedName(GlobalDecl GD,
1370                                            DeclarationName Name,
1371                                            unsigned KnownArity,
1372                                            const AbiTagList *AdditionalAbiTags) {
1373   const NamedDecl *ND = cast_or_null<NamedDecl>(GD.getDecl());
1374   unsigned Arity = KnownArity;
1375   //  <unqualified-name> ::= <operator-name>
1376   //                     ::= <ctor-dtor-name>
1377   //                     ::= <source-name>
1378   switch (Name.getNameKind()) {
1379   case DeclarationName::Identifier: {
1380     const IdentifierInfo *II = Name.getAsIdentifierInfo();
1381 
1382     // We mangle decomposition declarations as the names of their bindings.
1383     if (auto *DD = dyn_cast<DecompositionDecl>(ND)) {
1384       // FIXME: Non-standard mangling for decomposition declarations:
1385       //
1386       //  <unqualified-name> ::= DC <source-name>* E
1387       //
1388       // These can never be referenced across translation units, so we do
1389       // not need a cross-vendor mangling for anything other than demanglers.
1390       // Proposed on cxx-abi-dev on 2016-08-12
1391       Out << "DC";
1392       for (auto *BD : DD->bindings())
1393         mangleSourceName(BD->getDeclName().getAsIdentifierInfo());
1394       Out << 'E';
1395       writeAbiTags(ND, AdditionalAbiTags);
1396       break;
1397     }
1398 
1399     if (auto *GD = dyn_cast<MSGuidDecl>(ND)) {
1400       // We follow MSVC in mangling GUID declarations as if they were variables
1401       // with a particular reserved name. Continue the pretense here.
1402       SmallString<sizeof("_GUID_12345678_1234_1234_1234_1234567890ab")> GUID;
1403       llvm::raw_svector_ostream GUIDOS(GUID);
1404       Context.mangleMSGuidDecl(GD, GUIDOS);
1405       Out << GUID.size() << GUID;
1406       break;
1407     }
1408 
1409     if (auto *TPO = dyn_cast<TemplateParamObjectDecl>(ND)) {
1410       // Proposed in https://github.com/itanium-cxx-abi/cxx-abi/issues/63.
1411       Out << "TA";
1412       mangleValueInTemplateArg(TPO->getType().getUnqualifiedType(),
1413                                TPO->getValue(), /*TopLevel=*/true);
1414       break;
1415     }
1416 
1417     if (II) {
1418       // Match GCC's naming convention for internal linkage symbols, for
1419       // symbols that are not actually visible outside of this TU. GCC
1420       // distinguishes between internal and external linkage symbols in
1421       // its mangling, to support cases like this that were valid C++ prior
1422       // to DR426:
1423       //
1424       //   void test() { extern void foo(); }
1425       //   static void foo();
1426       //
1427       // Don't bother with the L marker for names in anonymous namespaces; the
1428       // 12_GLOBAL__N_1 mangling is quite sufficient there, and this better
1429       // matches GCC anyway, because GCC does not treat anonymous namespaces as
1430       // implying internal linkage.
1431       if (isInternalLinkageDecl(ND))
1432         Out << 'L';
1433 
1434       auto *FD = dyn_cast<FunctionDecl>(ND);
1435       bool IsRegCall = FD &&
1436                        FD->getType()->castAs<FunctionType>()->getCallConv() ==
1437                            clang::CC_X86RegCall;
1438       bool IsDeviceStub =
1439           FD && FD->hasAttr<CUDAGlobalAttr>() &&
1440           GD.getKernelReferenceKind() == KernelReferenceKind::Stub;
1441       if (IsDeviceStub)
1442         mangleDeviceStubName(II);
1443       else if (IsRegCall)
1444         mangleRegCallName(II);
1445       else
1446         mangleSourceName(II);
1447 
1448       writeAbiTags(ND, AdditionalAbiTags);
1449       break;
1450     }
1451 
1452     // Otherwise, an anonymous entity.  We must have a declaration.
1453     assert(ND && "mangling empty name without declaration");
1454 
1455     if (const NamespaceDecl *NS = dyn_cast<NamespaceDecl>(ND)) {
1456       if (NS->isAnonymousNamespace()) {
1457         // This is how gcc mangles these names.
1458         Out << "12_GLOBAL__N_1";
1459         break;
1460       }
1461     }
1462 
1463     if (const VarDecl *VD = dyn_cast<VarDecl>(ND)) {
1464       // We must have an anonymous union or struct declaration.
1465       const RecordDecl *RD = VD->getType()->castAs<RecordType>()->getDecl();
1466 
1467       // Itanium C++ ABI 5.1.2:
1468       //
1469       //   For the purposes of mangling, the name of an anonymous union is
1470       //   considered to be the name of the first named data member found by a
1471       //   pre-order, depth-first, declaration-order walk of the data members of
1472       //   the anonymous union. If there is no such data member (i.e., if all of
1473       //   the data members in the union are unnamed), then there is no way for
1474       //   a program to refer to the anonymous union, and there is therefore no
1475       //   need to mangle its name.
1476       assert(RD->isAnonymousStructOrUnion()
1477              && "Expected anonymous struct or union!");
1478       const FieldDecl *FD = RD->findFirstNamedDataMember();
1479 
1480       // It's actually possible for various reasons for us to get here
1481       // with an empty anonymous struct / union.  Fortunately, it
1482       // doesn't really matter what name we generate.
1483       if (!FD) break;
1484       assert(FD->getIdentifier() && "Data member name isn't an identifier!");
1485 
1486       mangleSourceName(FD->getIdentifier());
1487       // Not emitting abi tags: internal name anyway.
1488       break;
1489     }
1490 
1491     // Class extensions have no name as a category, and it's possible
1492     // for them to be the semantic parent of certain declarations
1493     // (primarily, tag decls defined within declarations).  Such
1494     // declarations will always have internal linkage, so the name
1495     // doesn't really matter, but we shouldn't crash on them.  For
1496     // safety, just handle all ObjC containers here.
1497     if (isa<ObjCContainerDecl>(ND))
1498       break;
1499 
1500     // We must have an anonymous struct.
1501     const TagDecl *TD = cast<TagDecl>(ND);
1502     if (const TypedefNameDecl *D = TD->getTypedefNameForAnonDecl()) {
1503       assert(TD->getDeclContext() == D->getDeclContext() &&
1504              "Typedef should not be in another decl context!");
1505       assert(D->getDeclName().getAsIdentifierInfo() &&
1506              "Typedef was not named!");
1507       mangleSourceName(D->getDeclName().getAsIdentifierInfo());
1508       assert(!AdditionalAbiTags && "Type cannot have additional abi tags");
1509       // Explicit abi tags are still possible; take from underlying type, not
1510       // from typedef.
1511       writeAbiTags(TD, nullptr);
1512       break;
1513     }
1514 
1515     // <unnamed-type-name> ::= <closure-type-name>
1516     //
1517     // <closure-type-name> ::= Ul <lambda-sig> E [ <nonnegative number> ] _
1518     // <lambda-sig> ::= <template-param-decl>* <parameter-type>+
1519     //     # Parameter types or 'v' for 'void'.
1520     if (const CXXRecordDecl *Record = dyn_cast<CXXRecordDecl>(TD)) {
1521       if (Record->isLambda() && (Record->getLambdaManglingNumber() ||
1522                                  Context.getDiscriminatorOverride()(
1523                                      Context.getASTContext(), Record))) {
1524         assert(!AdditionalAbiTags &&
1525                "Lambda type cannot have additional abi tags");
1526         mangleLambda(Record);
1527         break;
1528       }
1529     }
1530 
1531     if (TD->isExternallyVisible()) {
1532       unsigned UnnamedMangle = getASTContext().getManglingNumber(TD);
1533       Out << "Ut";
1534       if (UnnamedMangle > 1)
1535         Out << UnnamedMangle - 2;
1536       Out << '_';
1537       writeAbiTags(TD, AdditionalAbiTags);
1538       break;
1539     }
1540 
1541     // Get a unique id for the anonymous struct. If it is not a real output
1542     // ID doesn't matter so use fake one.
1543     unsigned AnonStructId = NullOut ? 0 : Context.getAnonymousStructId(TD);
1544 
1545     // Mangle it as a source name in the form
1546     // [n] $_<id>
1547     // where n is the length of the string.
1548     SmallString<8> Str;
1549     Str += "$_";
1550     Str += llvm::utostr(AnonStructId);
1551 
1552     Out << Str.size();
1553     Out << Str;
1554     break;
1555   }
1556 
1557   case DeclarationName::ObjCZeroArgSelector:
1558   case DeclarationName::ObjCOneArgSelector:
1559   case DeclarationName::ObjCMultiArgSelector:
1560     llvm_unreachable("Can't mangle Objective-C selector names here!");
1561 
1562   case DeclarationName::CXXConstructorName: {
1563     const CXXRecordDecl *InheritedFrom = nullptr;
1564     TemplateName InheritedTemplateName;
1565     const TemplateArgumentList *InheritedTemplateArgs = nullptr;
1566     if (auto Inherited =
1567             cast<CXXConstructorDecl>(ND)->getInheritedConstructor()) {
1568       InheritedFrom = Inherited.getConstructor()->getParent();
1569       InheritedTemplateName =
1570           TemplateName(Inherited.getConstructor()->getPrimaryTemplate());
1571       InheritedTemplateArgs =
1572           Inherited.getConstructor()->getTemplateSpecializationArgs();
1573     }
1574 
1575     if (ND == Structor)
1576       // If the named decl is the C++ constructor we're mangling, use the type
1577       // we were given.
1578       mangleCXXCtorType(static_cast<CXXCtorType>(StructorType), InheritedFrom);
1579     else
1580       // Otherwise, use the complete constructor name. This is relevant if a
1581       // class with a constructor is declared within a constructor.
1582       mangleCXXCtorType(Ctor_Complete, InheritedFrom);
1583 
1584     // FIXME: The template arguments are part of the enclosing prefix or
1585     // nested-name, but it's more convenient to mangle them here.
1586     if (InheritedTemplateArgs)
1587       mangleTemplateArgs(InheritedTemplateName, *InheritedTemplateArgs);
1588 
1589     writeAbiTags(ND, AdditionalAbiTags);
1590     break;
1591   }
1592 
1593   case DeclarationName::CXXDestructorName:
1594     if (ND == Structor)
1595       // If the named decl is the C++ destructor we're mangling, use the type we
1596       // were given.
1597       mangleCXXDtorType(static_cast<CXXDtorType>(StructorType));
1598     else
1599       // Otherwise, use the complete destructor name. This is relevant if a
1600       // class with a destructor is declared within a destructor.
1601       mangleCXXDtorType(Dtor_Complete);
1602     writeAbiTags(ND, AdditionalAbiTags);
1603     break;
1604 
1605   case DeclarationName::CXXOperatorName:
1606     if (ND && Arity == UnknownArity) {
1607       Arity = cast<FunctionDecl>(ND)->getNumParams();
1608 
1609       // If we have a member function, we need to include the 'this' pointer.
1610       if (const auto *MD = dyn_cast<CXXMethodDecl>(ND))
1611         if (!MD->isStatic())
1612           Arity++;
1613     }
1614     LLVM_FALLTHROUGH;
1615   case DeclarationName::CXXConversionFunctionName:
1616   case DeclarationName::CXXLiteralOperatorName:
1617     mangleOperatorName(Name, Arity);
1618     writeAbiTags(ND, AdditionalAbiTags);
1619     break;
1620 
1621   case DeclarationName::CXXDeductionGuideName:
1622     llvm_unreachable("Can't mangle a deduction guide name!");
1623 
1624   case DeclarationName::CXXUsingDirective:
1625     llvm_unreachable("Can't mangle a using directive name!");
1626   }
1627 }
1628 
1629 void CXXNameMangler::mangleRegCallName(const IdentifierInfo *II) {
1630   // <source-name> ::= <positive length number> __regcall3__ <identifier>
1631   // <number> ::= [n] <non-negative decimal integer>
1632   // <identifier> ::= <unqualified source code identifier>
1633   Out << II->getLength() + sizeof("__regcall3__") - 1 << "__regcall3__"
1634       << II->getName();
1635 }
1636 
1637 void CXXNameMangler::mangleDeviceStubName(const IdentifierInfo *II) {
1638   // <source-name> ::= <positive length number> __device_stub__ <identifier>
1639   // <number> ::= [n] <non-negative decimal integer>
1640   // <identifier> ::= <unqualified source code identifier>
1641   Out << II->getLength() + sizeof("__device_stub__") - 1 << "__device_stub__"
1642       << II->getName();
1643 }
1644 
1645 void CXXNameMangler::mangleSourceName(const IdentifierInfo *II) {
1646   // <source-name> ::= <positive length number> <identifier>
1647   // <number> ::= [n] <non-negative decimal integer>
1648   // <identifier> ::= <unqualified source code identifier>
1649   Out << II->getLength() << II->getName();
1650 }
1651 
1652 void CXXNameMangler::mangleNestedName(GlobalDecl GD,
1653                                       const DeclContext *DC,
1654                                       const AbiTagList *AdditionalAbiTags,
1655                                       bool NoFunction) {
1656   const NamedDecl *ND = cast<NamedDecl>(GD.getDecl());
1657   // <nested-name>
1658   //   ::= N [<CV-qualifiers>] [<ref-qualifier>] <prefix> <unqualified-name> E
1659   //   ::= N [<CV-qualifiers>] [<ref-qualifier>] <template-prefix>
1660   //       <template-args> E
1661 
1662   Out << 'N';
1663   if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(ND)) {
1664     Qualifiers MethodQuals = Method->getMethodQualifiers();
1665     // We do not consider restrict a distinguishing attribute for overloading
1666     // purposes so we must not mangle it.
1667     MethodQuals.removeRestrict();
1668     mangleQualifiers(MethodQuals);
1669     mangleRefQualifier(Method->getRefQualifier());
1670   }
1671 
1672   // Check if we have a template.
1673   const TemplateArgumentList *TemplateArgs = nullptr;
1674   if (GlobalDecl TD = isTemplate(GD, TemplateArgs)) {
1675     mangleTemplatePrefix(TD, NoFunction);
1676     mangleTemplateArgs(asTemplateName(TD), *TemplateArgs);
1677   } else {
1678     manglePrefix(DC, NoFunction);
1679     mangleUnqualifiedName(GD, AdditionalAbiTags);
1680   }
1681 
1682   Out << 'E';
1683 }
1684 void CXXNameMangler::mangleNestedName(const TemplateDecl *TD,
1685                                       const TemplateArgument *TemplateArgs,
1686                                       unsigned NumTemplateArgs) {
1687   // <nested-name> ::= N [<CV-qualifiers>] <template-prefix> <template-args> E
1688 
1689   Out << 'N';
1690 
1691   mangleTemplatePrefix(TD);
1692   mangleTemplateArgs(asTemplateName(TD), TemplateArgs, NumTemplateArgs);
1693 
1694   Out << 'E';
1695 }
1696 
1697 void CXXNameMangler::mangleNestedNameWithClosurePrefix(
1698     GlobalDecl GD, const NamedDecl *PrefixND,
1699     const AbiTagList *AdditionalAbiTags) {
1700   // A <closure-prefix> represents a variable or field, not a regular
1701   // DeclContext, so needs special handling. In this case we're mangling a
1702   // limited form of <nested-name>:
1703   //
1704   // <nested-name> ::= N <closure-prefix> <closure-type-name> E
1705 
1706   Out << 'N';
1707 
1708   mangleClosurePrefix(PrefixND);
1709   mangleUnqualifiedName(GD, AdditionalAbiTags);
1710 
1711   Out << 'E';
1712 }
1713 
1714 static GlobalDecl getParentOfLocalEntity(const DeclContext *DC) {
1715   GlobalDecl GD;
1716   // The Itanium spec says:
1717   // For entities in constructors and destructors, the mangling of the
1718   // complete object constructor or destructor is used as the base function
1719   // name, i.e. the C1 or D1 version.
1720   if (auto *CD = dyn_cast<CXXConstructorDecl>(DC))
1721     GD = GlobalDecl(CD, Ctor_Complete);
1722   else if (auto *DD = dyn_cast<CXXDestructorDecl>(DC))
1723     GD = GlobalDecl(DD, Dtor_Complete);
1724   else
1725     GD = GlobalDecl(cast<FunctionDecl>(DC));
1726   return GD;
1727 }
1728 
1729 void CXXNameMangler::mangleLocalName(GlobalDecl GD,
1730                                      const AbiTagList *AdditionalAbiTags) {
1731   const Decl *D = GD.getDecl();
1732   // <local-name> := Z <function encoding> E <entity name> [<discriminator>]
1733   //              := Z <function encoding> E s [<discriminator>]
1734   // <local-name> := Z <function encoding> E d [ <parameter number> ]
1735   //                 _ <entity name>
1736   // <discriminator> := _ <non-negative number>
1737   assert(isa<NamedDecl>(D) || isa<BlockDecl>(D));
1738   const RecordDecl *RD = GetLocalClassDecl(D);
1739   const DeclContext *DC = getEffectiveDeclContext(RD ? RD : D);
1740 
1741   Out << 'Z';
1742 
1743   {
1744     AbiTagState LocalAbiTags(AbiTags);
1745 
1746     if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(DC))
1747       mangleObjCMethodName(MD);
1748     else if (const BlockDecl *BD = dyn_cast<BlockDecl>(DC))
1749       mangleBlockForPrefix(BD);
1750     else
1751       mangleFunctionEncoding(getParentOfLocalEntity(DC));
1752 
1753     // Implicit ABI tags (from namespace) are not available in the following
1754     // entity; reset to actually emitted tags, which are available.
1755     LocalAbiTags.setUsedAbiTags(LocalAbiTags.getEmittedAbiTags());
1756   }
1757 
1758   Out << 'E';
1759 
1760   // GCC 5.3.0 doesn't emit derived ABI tags for local names but that seems to
1761   // be a bug that is fixed in trunk.
1762 
1763   if (RD) {
1764     // The parameter number is omitted for the last parameter, 0 for the
1765     // second-to-last parameter, 1 for the third-to-last parameter, etc. The
1766     // <entity name> will of course contain a <closure-type-name>: Its
1767     // numbering will be local to the particular argument in which it appears
1768     // -- other default arguments do not affect its encoding.
1769     const CXXRecordDecl *CXXRD = dyn_cast<CXXRecordDecl>(RD);
1770     if (CXXRD && CXXRD->isLambda()) {
1771       if (const ParmVarDecl *Parm
1772               = dyn_cast_or_null<ParmVarDecl>(CXXRD->getLambdaContextDecl())) {
1773         if (const FunctionDecl *Func
1774               = dyn_cast<FunctionDecl>(Parm->getDeclContext())) {
1775           Out << 'd';
1776           unsigned Num = Func->getNumParams() - Parm->getFunctionScopeIndex();
1777           if (Num > 1)
1778             mangleNumber(Num - 2);
1779           Out << '_';
1780         }
1781       }
1782     }
1783 
1784     // Mangle the name relative to the closest enclosing function.
1785     // equality ok because RD derived from ND above
1786     if (D == RD)  {
1787       mangleUnqualifiedName(RD, AdditionalAbiTags);
1788     } else if (const BlockDecl *BD = dyn_cast<BlockDecl>(D)) {
1789       if (const NamedDecl *PrefixND = getClosurePrefix(BD))
1790         mangleClosurePrefix(PrefixND, true /*NoFunction*/);
1791       else
1792         manglePrefix(getEffectiveDeclContext(BD), true /*NoFunction*/);
1793       assert(!AdditionalAbiTags && "Block cannot have additional abi tags");
1794       mangleUnqualifiedBlock(BD);
1795     } else {
1796       const NamedDecl *ND = cast<NamedDecl>(D);
1797       mangleNestedName(GD, getEffectiveDeclContext(ND), AdditionalAbiTags,
1798                        true /*NoFunction*/);
1799     }
1800   } else if (const BlockDecl *BD = dyn_cast<BlockDecl>(D)) {
1801     // Mangle a block in a default parameter; see above explanation for
1802     // lambdas.
1803     if (const ParmVarDecl *Parm
1804             = dyn_cast_or_null<ParmVarDecl>(BD->getBlockManglingContextDecl())) {
1805       if (const FunctionDecl *Func
1806             = dyn_cast<FunctionDecl>(Parm->getDeclContext())) {
1807         Out << 'd';
1808         unsigned Num = Func->getNumParams() - Parm->getFunctionScopeIndex();
1809         if (Num > 1)
1810           mangleNumber(Num - 2);
1811         Out << '_';
1812       }
1813     }
1814 
1815     assert(!AdditionalAbiTags && "Block cannot have additional abi tags");
1816     mangleUnqualifiedBlock(BD);
1817   } else {
1818     mangleUnqualifiedName(GD, AdditionalAbiTags);
1819   }
1820 
1821   if (const NamedDecl *ND = dyn_cast<NamedDecl>(RD ? RD : D)) {
1822     unsigned disc;
1823     if (Context.getNextDiscriminator(ND, disc)) {
1824       if (disc < 10)
1825         Out << '_' << disc;
1826       else
1827         Out << "__" << disc << '_';
1828     }
1829   }
1830 }
1831 
1832 void CXXNameMangler::mangleBlockForPrefix(const BlockDecl *Block) {
1833   if (GetLocalClassDecl(Block)) {
1834     mangleLocalName(Block, /* AdditionalAbiTags */ nullptr);
1835     return;
1836   }
1837   const DeclContext *DC = getEffectiveDeclContext(Block);
1838   if (isLocalContainerContext(DC)) {
1839     mangleLocalName(Block, /* AdditionalAbiTags */ nullptr);
1840     return;
1841   }
1842   if (const NamedDecl *PrefixND = getClosurePrefix(Block))
1843     mangleClosurePrefix(PrefixND);
1844   else
1845     manglePrefix(DC);
1846   mangleUnqualifiedBlock(Block);
1847 }
1848 
1849 void CXXNameMangler::mangleUnqualifiedBlock(const BlockDecl *Block) {
1850   // When trying to be ABI-compatibility with clang 12 and before, mangle a
1851   // <data-member-prefix> now, with no substitutions and no <template-args>.
1852   if (Decl *Context = Block->getBlockManglingContextDecl()) {
1853     if (getASTContext().getLangOpts().getClangABICompat() <=
1854             LangOptions::ClangABI::Ver12 &&
1855         (isa<VarDecl>(Context) || isa<FieldDecl>(Context)) &&
1856         Context->getDeclContext()->isRecord()) {
1857       const auto *ND = cast<NamedDecl>(Context);
1858       if (ND->getIdentifier()) {
1859         mangleSourceNameWithAbiTags(ND);
1860         Out << 'M';
1861       }
1862     }
1863   }
1864 
1865   // If we have a block mangling number, use it.
1866   unsigned Number = Block->getBlockManglingNumber();
1867   // Otherwise, just make up a number. It doesn't matter what it is because
1868   // the symbol in question isn't externally visible.
1869   if (!Number)
1870     Number = Context.getBlockId(Block, false);
1871   else {
1872     // Stored mangling numbers are 1-based.
1873     --Number;
1874   }
1875   Out << "Ub";
1876   if (Number > 0)
1877     Out << Number - 1;
1878   Out << '_';
1879 }
1880 
1881 // <template-param-decl>
1882 //   ::= Ty                              # template type parameter
1883 //   ::= Tn <type>                       # template non-type parameter
1884 //   ::= Tt <template-param-decl>* E     # template template parameter
1885 //   ::= Tp <template-param-decl>        # template parameter pack
1886 void CXXNameMangler::mangleTemplateParamDecl(const NamedDecl *Decl) {
1887   if (auto *Ty = dyn_cast<TemplateTypeParmDecl>(Decl)) {
1888     if (Ty->isParameterPack())
1889       Out << "Tp";
1890     Out << "Ty";
1891   } else if (auto *Tn = dyn_cast<NonTypeTemplateParmDecl>(Decl)) {
1892     if (Tn->isExpandedParameterPack()) {
1893       for (unsigned I = 0, N = Tn->getNumExpansionTypes(); I != N; ++I) {
1894         Out << "Tn";
1895         mangleType(Tn->getExpansionType(I));
1896       }
1897     } else {
1898       QualType T = Tn->getType();
1899       if (Tn->isParameterPack()) {
1900         Out << "Tp";
1901         if (auto *PackExpansion = T->getAs<PackExpansionType>())
1902           T = PackExpansion->getPattern();
1903       }
1904       Out << "Tn";
1905       mangleType(T);
1906     }
1907   } else if (auto *Tt = dyn_cast<TemplateTemplateParmDecl>(Decl)) {
1908     if (Tt->isExpandedParameterPack()) {
1909       for (unsigned I = 0, N = Tt->getNumExpansionTemplateParameters(); I != N;
1910            ++I) {
1911         Out << "Tt";
1912         for (auto *Param : *Tt->getExpansionTemplateParameters(I))
1913           mangleTemplateParamDecl(Param);
1914         Out << "E";
1915       }
1916     } else {
1917       if (Tt->isParameterPack())
1918         Out << "Tp";
1919       Out << "Tt";
1920       for (auto *Param : *Tt->getTemplateParameters())
1921         mangleTemplateParamDecl(Param);
1922       Out << "E";
1923     }
1924   }
1925 }
1926 
1927 void CXXNameMangler::mangleLambda(const CXXRecordDecl *Lambda) {
1928   // When trying to be ABI-compatibility with clang 12 and before, mangle a
1929   // <data-member-prefix> now, with no substitutions.
1930   if (Decl *Context = Lambda->getLambdaContextDecl()) {
1931     if (getASTContext().getLangOpts().getClangABICompat() <=
1932             LangOptions::ClangABI::Ver12 &&
1933         (isa<VarDecl>(Context) || isa<FieldDecl>(Context)) &&
1934         !isa<ParmVarDecl>(Context)) {
1935       if (const IdentifierInfo *Name
1936             = cast<NamedDecl>(Context)->getIdentifier()) {
1937         mangleSourceName(Name);
1938         const TemplateArgumentList *TemplateArgs = nullptr;
1939         if (GlobalDecl TD = isTemplate(cast<NamedDecl>(Context), TemplateArgs))
1940           mangleTemplateArgs(asTemplateName(TD), *TemplateArgs);
1941         Out << 'M';
1942       }
1943     }
1944   }
1945 
1946   Out << "Ul";
1947   mangleLambdaSig(Lambda);
1948   Out << "E";
1949 
1950   // The number is omitted for the first closure type with a given
1951   // <lambda-sig> in a given context; it is n-2 for the nth closure type
1952   // (in lexical order) with that same <lambda-sig> and context.
1953   //
1954   // The AST keeps track of the number for us.
1955   //
1956   // In CUDA/HIP, to ensure the consistent lamba numbering between the device-
1957   // and host-side compilations, an extra device mangle context may be created
1958   // if the host-side CXX ABI has different numbering for lambda. In such case,
1959   // if the mangle context is that device-side one, use the device-side lambda
1960   // mangling number for this lambda.
1961   llvm::Optional<unsigned> DeviceNumber =
1962       Context.getDiscriminatorOverride()(Context.getASTContext(), Lambda);
1963   unsigned Number = DeviceNumber.hasValue() ? *DeviceNumber
1964                                             : Lambda->getLambdaManglingNumber();
1965 
1966   assert(Number > 0 && "Lambda should be mangled as an unnamed class");
1967   if (Number > 1)
1968     mangleNumber(Number - 2);
1969   Out << '_';
1970 }
1971 
1972 void CXXNameMangler::mangleLambdaSig(const CXXRecordDecl *Lambda) {
1973   for (auto *D : Lambda->getLambdaExplicitTemplateParameters())
1974     mangleTemplateParamDecl(D);
1975   auto *Proto =
1976       Lambda->getLambdaTypeInfo()->getType()->castAs<FunctionProtoType>();
1977   mangleBareFunctionType(Proto, /*MangleReturnType=*/false,
1978                          Lambda->getLambdaStaticInvoker());
1979 }
1980 
1981 void CXXNameMangler::manglePrefix(NestedNameSpecifier *qualifier) {
1982   switch (qualifier->getKind()) {
1983   case NestedNameSpecifier::Global:
1984     // nothing
1985     return;
1986 
1987   case NestedNameSpecifier::Super:
1988     llvm_unreachable("Can't mangle __super specifier");
1989 
1990   case NestedNameSpecifier::Namespace:
1991     mangleName(qualifier->getAsNamespace());
1992     return;
1993 
1994   case NestedNameSpecifier::NamespaceAlias:
1995     mangleName(qualifier->getAsNamespaceAlias()->getNamespace());
1996     return;
1997 
1998   case NestedNameSpecifier::TypeSpec:
1999   case NestedNameSpecifier::TypeSpecWithTemplate:
2000     manglePrefix(QualType(qualifier->getAsType(), 0));
2001     return;
2002 
2003   case NestedNameSpecifier::Identifier:
2004     // Member expressions can have these without prefixes, but that
2005     // should end up in mangleUnresolvedPrefix instead.
2006     assert(qualifier->getPrefix());
2007     manglePrefix(qualifier->getPrefix());
2008 
2009     mangleSourceName(qualifier->getAsIdentifier());
2010     return;
2011   }
2012 
2013   llvm_unreachable("unexpected nested name specifier");
2014 }
2015 
2016 void CXXNameMangler::manglePrefix(const DeclContext *DC, bool NoFunction) {
2017   //  <prefix> ::= <prefix> <unqualified-name>
2018   //           ::= <template-prefix> <template-args>
2019   //           ::= <closure-prefix>
2020   //           ::= <template-param>
2021   //           ::= # empty
2022   //           ::= <substitution>
2023 
2024   DC = IgnoreLinkageSpecDecls(DC);
2025 
2026   if (DC->isTranslationUnit())
2027     return;
2028 
2029   if (NoFunction && isLocalContainerContext(DC))
2030     return;
2031 
2032   assert(!isLocalContainerContext(DC));
2033 
2034   const NamedDecl *ND = cast<NamedDecl>(DC);
2035   if (mangleSubstitution(ND))
2036     return;
2037 
2038   // Check if we have a template-prefix or a closure-prefix.
2039   const TemplateArgumentList *TemplateArgs = nullptr;
2040   if (GlobalDecl TD = isTemplate(ND, TemplateArgs)) {
2041     mangleTemplatePrefix(TD);
2042     mangleTemplateArgs(asTemplateName(TD), *TemplateArgs);
2043   } else if (const NamedDecl *PrefixND = getClosurePrefix(ND)) {
2044     mangleClosurePrefix(PrefixND, NoFunction);
2045     mangleUnqualifiedName(ND, nullptr);
2046   } else {
2047     manglePrefix(getEffectiveDeclContext(ND), NoFunction);
2048     mangleUnqualifiedName(ND, nullptr);
2049   }
2050 
2051   addSubstitution(ND);
2052 }
2053 
2054 void CXXNameMangler::mangleTemplatePrefix(TemplateName Template) {
2055   // <template-prefix> ::= <prefix> <template unqualified-name>
2056   //                   ::= <template-param>
2057   //                   ::= <substitution>
2058   if (TemplateDecl *TD = Template.getAsTemplateDecl())
2059     return mangleTemplatePrefix(TD);
2060 
2061   DependentTemplateName *Dependent = Template.getAsDependentTemplateName();
2062   assert(Dependent && "unexpected template name kind");
2063 
2064   // Clang 11 and before mangled the substitution for a dependent template name
2065   // after already having emitted (a substitution for) the prefix.
2066   bool Clang11Compat = getASTContext().getLangOpts().getClangABICompat() <=
2067                        LangOptions::ClangABI::Ver11;
2068   if (!Clang11Compat && mangleSubstitution(Template))
2069     return;
2070 
2071   if (NestedNameSpecifier *Qualifier = Dependent->getQualifier())
2072     manglePrefix(Qualifier);
2073 
2074   if (Clang11Compat && mangleSubstitution(Template))
2075     return;
2076 
2077   if (const IdentifierInfo *Id = Dependent->getIdentifier())
2078     mangleSourceName(Id);
2079   else
2080     mangleOperatorName(Dependent->getOperator(), UnknownArity);
2081 
2082   addSubstitution(Template);
2083 }
2084 
2085 void CXXNameMangler::mangleTemplatePrefix(GlobalDecl GD,
2086                                           bool NoFunction) {
2087   const TemplateDecl *ND = cast<TemplateDecl>(GD.getDecl());
2088   // <template-prefix> ::= <prefix> <template unqualified-name>
2089   //                   ::= <template-param>
2090   //                   ::= <substitution>
2091   // <template-template-param> ::= <template-param>
2092   //                               <substitution>
2093 
2094   if (mangleSubstitution(ND))
2095     return;
2096 
2097   // <template-template-param> ::= <template-param>
2098   if (const auto *TTP = dyn_cast<TemplateTemplateParmDecl>(ND)) {
2099     mangleTemplateParameter(TTP->getDepth(), TTP->getIndex());
2100   } else {
2101     manglePrefix(getEffectiveDeclContext(ND), NoFunction);
2102     if (isa<BuiltinTemplateDecl>(ND) || isa<ConceptDecl>(ND))
2103       mangleUnqualifiedName(GD, nullptr);
2104     else
2105       mangleUnqualifiedName(GD.getWithDecl(ND->getTemplatedDecl()), nullptr);
2106   }
2107 
2108   addSubstitution(ND);
2109 }
2110 
2111 const NamedDecl *CXXNameMangler::getClosurePrefix(const Decl *ND) {
2112   if (getASTContext().getLangOpts().getClangABICompat() <=
2113       LangOptions::ClangABI::Ver12)
2114     return nullptr;
2115 
2116   const NamedDecl *Context = nullptr;
2117   if (auto *Block = dyn_cast<BlockDecl>(ND)) {
2118     Context = dyn_cast_or_null<NamedDecl>(Block->getBlockManglingContextDecl());
2119   } else if (auto *RD = dyn_cast<CXXRecordDecl>(ND)) {
2120     if (RD->isLambda())
2121       Context = dyn_cast_or_null<NamedDecl>(RD->getLambdaContextDecl());
2122   }
2123   if (!Context)
2124     return nullptr;
2125 
2126   // Only lambdas within the initializer of a non-local variable or non-static
2127   // data member get a <closure-prefix>.
2128   if ((isa<VarDecl>(Context) && cast<VarDecl>(Context)->hasGlobalStorage()) ||
2129       isa<FieldDecl>(Context))
2130     return Context;
2131 
2132   return nullptr;
2133 }
2134 
2135 void CXXNameMangler::mangleClosurePrefix(const NamedDecl *ND, bool NoFunction) {
2136   //  <closure-prefix> ::= [ <prefix> ] <unqualified-name> M
2137   //                   ::= <template-prefix> <template-args> M
2138   if (mangleSubstitution(ND))
2139     return;
2140 
2141   const TemplateArgumentList *TemplateArgs = nullptr;
2142   if (GlobalDecl TD = isTemplate(ND, TemplateArgs)) {
2143     mangleTemplatePrefix(TD, NoFunction);
2144     mangleTemplateArgs(asTemplateName(TD), *TemplateArgs);
2145   } else {
2146     manglePrefix(getEffectiveDeclContext(ND), NoFunction);
2147     mangleUnqualifiedName(ND, nullptr);
2148   }
2149 
2150   Out << 'M';
2151 
2152   addSubstitution(ND);
2153 }
2154 
2155 /// Mangles a template name under the production <type>.  Required for
2156 /// template template arguments.
2157 ///   <type> ::= <class-enum-type>
2158 ///          ::= <template-param>
2159 ///          ::= <substitution>
2160 void CXXNameMangler::mangleType(TemplateName TN) {
2161   if (mangleSubstitution(TN))
2162     return;
2163 
2164   TemplateDecl *TD = nullptr;
2165 
2166   switch (TN.getKind()) {
2167   case TemplateName::QualifiedTemplate:
2168     TD = TN.getAsQualifiedTemplateName()->getTemplateDecl();
2169     goto HaveDecl;
2170 
2171   case TemplateName::Template:
2172     TD = TN.getAsTemplateDecl();
2173     goto HaveDecl;
2174 
2175   HaveDecl:
2176     if (auto *TTP = dyn_cast<TemplateTemplateParmDecl>(TD))
2177       mangleTemplateParameter(TTP->getDepth(), TTP->getIndex());
2178     else
2179       mangleName(TD);
2180     break;
2181 
2182   case TemplateName::OverloadedTemplate:
2183   case TemplateName::AssumedTemplate:
2184     llvm_unreachable("can't mangle an overloaded template name as a <type>");
2185 
2186   case TemplateName::DependentTemplate: {
2187     const DependentTemplateName *Dependent = TN.getAsDependentTemplateName();
2188     assert(Dependent->isIdentifier());
2189 
2190     // <class-enum-type> ::= <name>
2191     // <name> ::= <nested-name>
2192     mangleUnresolvedPrefix(Dependent->getQualifier());
2193     mangleSourceName(Dependent->getIdentifier());
2194     break;
2195   }
2196 
2197   case TemplateName::SubstTemplateTemplateParm: {
2198     // Substituted template parameters are mangled as the substituted
2199     // template.  This will check for the substitution twice, which is
2200     // fine, but we have to return early so that we don't try to *add*
2201     // the substitution twice.
2202     SubstTemplateTemplateParmStorage *subst
2203       = TN.getAsSubstTemplateTemplateParm();
2204     mangleType(subst->getReplacement());
2205     return;
2206   }
2207 
2208   case TemplateName::SubstTemplateTemplateParmPack: {
2209     // FIXME: not clear how to mangle this!
2210     // template <template <class> class T...> class A {
2211     //   template <template <class> class U...> void foo(B<T,U> x...);
2212     // };
2213     Out << "_SUBSTPACK_";
2214     break;
2215   }
2216   }
2217 
2218   addSubstitution(TN);
2219 }
2220 
2221 bool CXXNameMangler::mangleUnresolvedTypeOrSimpleId(QualType Ty,
2222                                                     StringRef Prefix) {
2223   // Only certain other types are valid as prefixes;  enumerate them.
2224   switch (Ty->getTypeClass()) {
2225   case Type::Builtin:
2226   case Type::Complex:
2227   case Type::Adjusted:
2228   case Type::Decayed:
2229   case Type::Pointer:
2230   case Type::BlockPointer:
2231   case Type::LValueReference:
2232   case Type::RValueReference:
2233   case Type::MemberPointer:
2234   case Type::ConstantArray:
2235   case Type::IncompleteArray:
2236   case Type::VariableArray:
2237   case Type::DependentSizedArray:
2238   case Type::DependentAddressSpace:
2239   case Type::DependentVector:
2240   case Type::DependentSizedExtVector:
2241   case Type::Vector:
2242   case Type::ExtVector:
2243   case Type::ConstantMatrix:
2244   case Type::DependentSizedMatrix:
2245   case Type::FunctionProto:
2246   case Type::FunctionNoProto:
2247   case Type::Paren:
2248   case Type::Attributed:
2249   case Type::Auto:
2250   case Type::DeducedTemplateSpecialization:
2251   case Type::PackExpansion:
2252   case Type::ObjCObject:
2253   case Type::ObjCInterface:
2254   case Type::ObjCObjectPointer:
2255   case Type::ObjCTypeParam:
2256   case Type::Atomic:
2257   case Type::Pipe:
2258   case Type::MacroQualified:
2259   case Type::ExtInt:
2260   case Type::DependentExtInt:
2261     llvm_unreachable("type is illegal as a nested name specifier");
2262 
2263   case Type::SubstTemplateTypeParmPack:
2264     // FIXME: not clear how to mangle this!
2265     // template <class T...> class A {
2266     //   template <class U...> void foo(decltype(T::foo(U())) x...);
2267     // };
2268     Out << "_SUBSTPACK_";
2269     break;
2270 
2271   // <unresolved-type> ::= <template-param>
2272   //                   ::= <decltype>
2273   //                   ::= <template-template-param> <template-args>
2274   // (this last is not official yet)
2275   case Type::TypeOfExpr:
2276   case Type::TypeOf:
2277   case Type::Decltype:
2278   case Type::TemplateTypeParm:
2279   case Type::UnaryTransform:
2280   case Type::SubstTemplateTypeParm:
2281   unresolvedType:
2282     // Some callers want a prefix before the mangled type.
2283     Out << Prefix;
2284 
2285     // This seems to do everything we want.  It's not really
2286     // sanctioned for a substituted template parameter, though.
2287     mangleType(Ty);
2288 
2289     // We never want to print 'E' directly after an unresolved-type,
2290     // so we return directly.
2291     return true;
2292 
2293   case Type::Typedef:
2294     mangleSourceNameWithAbiTags(cast<TypedefType>(Ty)->getDecl());
2295     break;
2296 
2297   case Type::UnresolvedUsing:
2298     mangleSourceNameWithAbiTags(
2299         cast<UnresolvedUsingType>(Ty)->getDecl());
2300     break;
2301 
2302   case Type::Enum:
2303   case Type::Record:
2304     mangleSourceNameWithAbiTags(cast<TagType>(Ty)->getDecl());
2305     break;
2306 
2307   case Type::TemplateSpecialization: {
2308     const TemplateSpecializationType *TST =
2309         cast<TemplateSpecializationType>(Ty);
2310     TemplateName TN = TST->getTemplateName();
2311     switch (TN.getKind()) {
2312     case TemplateName::Template:
2313     case TemplateName::QualifiedTemplate: {
2314       TemplateDecl *TD = TN.getAsTemplateDecl();
2315 
2316       // If the base is a template template parameter, this is an
2317       // unresolved type.
2318       assert(TD && "no template for template specialization type");
2319       if (isa<TemplateTemplateParmDecl>(TD))
2320         goto unresolvedType;
2321 
2322       mangleSourceNameWithAbiTags(TD);
2323       break;
2324     }
2325 
2326     case TemplateName::OverloadedTemplate:
2327     case TemplateName::AssumedTemplate:
2328     case TemplateName::DependentTemplate:
2329       llvm_unreachable("invalid base for a template specialization type");
2330 
2331     case TemplateName::SubstTemplateTemplateParm: {
2332       SubstTemplateTemplateParmStorage *subst =
2333           TN.getAsSubstTemplateTemplateParm();
2334       mangleExistingSubstitution(subst->getReplacement());
2335       break;
2336     }
2337 
2338     case TemplateName::SubstTemplateTemplateParmPack: {
2339       // FIXME: not clear how to mangle this!
2340       // template <template <class U> class T...> class A {
2341       //   template <class U...> void foo(decltype(T<U>::foo) x...);
2342       // };
2343       Out << "_SUBSTPACK_";
2344       break;
2345     }
2346     }
2347 
2348     // Note: we don't pass in the template name here. We are mangling the
2349     // original source-level template arguments, so we shouldn't consider
2350     // conversions to the corresponding template parameter.
2351     // FIXME: Other compilers mangle partially-resolved template arguments in
2352     // unresolved-qualifier-levels.
2353     mangleTemplateArgs(TemplateName(), TST->getArgs(), TST->getNumArgs());
2354     break;
2355   }
2356 
2357   case Type::InjectedClassName:
2358     mangleSourceNameWithAbiTags(
2359         cast<InjectedClassNameType>(Ty)->getDecl());
2360     break;
2361 
2362   case Type::DependentName:
2363     mangleSourceName(cast<DependentNameType>(Ty)->getIdentifier());
2364     break;
2365 
2366   case Type::DependentTemplateSpecialization: {
2367     const DependentTemplateSpecializationType *DTST =
2368         cast<DependentTemplateSpecializationType>(Ty);
2369     TemplateName Template = getASTContext().getDependentTemplateName(
2370         DTST->getQualifier(), DTST->getIdentifier());
2371     mangleSourceName(DTST->getIdentifier());
2372     mangleTemplateArgs(Template, DTST->getArgs(), DTST->getNumArgs());
2373     break;
2374   }
2375 
2376   case Type::Elaborated:
2377     return mangleUnresolvedTypeOrSimpleId(
2378         cast<ElaboratedType>(Ty)->getNamedType(), Prefix);
2379   }
2380 
2381   return false;
2382 }
2383 
2384 void CXXNameMangler::mangleOperatorName(DeclarationName Name, unsigned Arity) {
2385   switch (Name.getNameKind()) {
2386   case DeclarationName::CXXConstructorName:
2387   case DeclarationName::CXXDestructorName:
2388   case DeclarationName::CXXDeductionGuideName:
2389   case DeclarationName::CXXUsingDirective:
2390   case DeclarationName::Identifier:
2391   case DeclarationName::ObjCMultiArgSelector:
2392   case DeclarationName::ObjCOneArgSelector:
2393   case DeclarationName::ObjCZeroArgSelector:
2394     llvm_unreachable("Not an operator name");
2395 
2396   case DeclarationName::CXXConversionFunctionName:
2397     // <operator-name> ::= cv <type>    # (cast)
2398     Out << "cv";
2399     mangleType(Name.getCXXNameType());
2400     break;
2401 
2402   case DeclarationName::CXXLiteralOperatorName:
2403     Out << "li";
2404     mangleSourceName(Name.getCXXLiteralIdentifier());
2405     return;
2406 
2407   case DeclarationName::CXXOperatorName:
2408     mangleOperatorName(Name.getCXXOverloadedOperator(), Arity);
2409     break;
2410   }
2411 }
2412 
2413 void
2414 CXXNameMangler::mangleOperatorName(OverloadedOperatorKind OO, unsigned Arity) {
2415   switch (OO) {
2416   // <operator-name> ::= nw     # new
2417   case OO_New: Out << "nw"; break;
2418   //              ::= na        # new[]
2419   case OO_Array_New: Out << "na"; break;
2420   //              ::= dl        # delete
2421   case OO_Delete: Out << "dl"; break;
2422   //              ::= da        # delete[]
2423   case OO_Array_Delete: Out << "da"; break;
2424   //              ::= ps        # + (unary)
2425   //              ::= pl        # + (binary or unknown)
2426   case OO_Plus:
2427     Out << (Arity == 1? "ps" : "pl"); break;
2428   //              ::= ng        # - (unary)
2429   //              ::= mi        # - (binary or unknown)
2430   case OO_Minus:
2431     Out << (Arity == 1? "ng" : "mi"); break;
2432   //              ::= ad        # & (unary)
2433   //              ::= an        # & (binary or unknown)
2434   case OO_Amp:
2435     Out << (Arity == 1? "ad" : "an"); break;
2436   //              ::= de        # * (unary)
2437   //              ::= ml        # * (binary or unknown)
2438   case OO_Star:
2439     // Use binary when unknown.
2440     Out << (Arity == 1? "de" : "ml"); break;
2441   //              ::= co        # ~
2442   case OO_Tilde: Out << "co"; break;
2443   //              ::= dv        # /
2444   case OO_Slash: Out << "dv"; break;
2445   //              ::= rm        # %
2446   case OO_Percent: Out << "rm"; break;
2447   //              ::= or        # |
2448   case OO_Pipe: Out << "or"; break;
2449   //              ::= eo        # ^
2450   case OO_Caret: Out << "eo"; break;
2451   //              ::= aS        # =
2452   case OO_Equal: Out << "aS"; break;
2453   //              ::= pL        # +=
2454   case OO_PlusEqual: Out << "pL"; break;
2455   //              ::= mI        # -=
2456   case OO_MinusEqual: Out << "mI"; break;
2457   //              ::= mL        # *=
2458   case OO_StarEqual: Out << "mL"; break;
2459   //              ::= dV        # /=
2460   case OO_SlashEqual: Out << "dV"; break;
2461   //              ::= rM        # %=
2462   case OO_PercentEqual: Out << "rM"; break;
2463   //              ::= aN        # &=
2464   case OO_AmpEqual: Out << "aN"; break;
2465   //              ::= oR        # |=
2466   case OO_PipeEqual: Out << "oR"; break;
2467   //              ::= eO        # ^=
2468   case OO_CaretEqual: Out << "eO"; break;
2469   //              ::= ls        # <<
2470   case OO_LessLess: Out << "ls"; break;
2471   //              ::= rs        # >>
2472   case OO_GreaterGreater: Out << "rs"; break;
2473   //              ::= lS        # <<=
2474   case OO_LessLessEqual: Out << "lS"; break;
2475   //              ::= rS        # >>=
2476   case OO_GreaterGreaterEqual: Out << "rS"; break;
2477   //              ::= eq        # ==
2478   case OO_EqualEqual: Out << "eq"; break;
2479   //              ::= ne        # !=
2480   case OO_ExclaimEqual: Out << "ne"; break;
2481   //              ::= lt        # <
2482   case OO_Less: Out << "lt"; break;
2483   //              ::= gt        # >
2484   case OO_Greater: Out << "gt"; break;
2485   //              ::= le        # <=
2486   case OO_LessEqual: Out << "le"; break;
2487   //              ::= ge        # >=
2488   case OO_GreaterEqual: Out << "ge"; break;
2489   //              ::= nt        # !
2490   case OO_Exclaim: Out << "nt"; break;
2491   //              ::= aa        # &&
2492   case OO_AmpAmp: Out << "aa"; break;
2493   //              ::= oo        # ||
2494   case OO_PipePipe: Out << "oo"; break;
2495   //              ::= pp        # ++
2496   case OO_PlusPlus: Out << "pp"; break;
2497   //              ::= mm        # --
2498   case OO_MinusMinus: Out << "mm"; break;
2499   //              ::= cm        # ,
2500   case OO_Comma: Out << "cm"; break;
2501   //              ::= pm        # ->*
2502   case OO_ArrowStar: Out << "pm"; break;
2503   //              ::= pt        # ->
2504   case OO_Arrow: Out << "pt"; break;
2505   //              ::= cl        # ()
2506   case OO_Call: Out << "cl"; break;
2507   //              ::= ix        # []
2508   case OO_Subscript: Out << "ix"; break;
2509 
2510   //              ::= qu        # ?
2511   // The conditional operator can't be overloaded, but we still handle it when
2512   // mangling expressions.
2513   case OO_Conditional: Out << "qu"; break;
2514   // Proposal on cxx-abi-dev, 2015-10-21.
2515   //              ::= aw        # co_await
2516   case OO_Coawait: Out << "aw"; break;
2517   // Proposed in cxx-abi github issue 43.
2518   //              ::= ss        # <=>
2519   case OO_Spaceship: Out << "ss"; break;
2520 
2521   case OO_None:
2522   case NUM_OVERLOADED_OPERATORS:
2523     llvm_unreachable("Not an overloaded operator");
2524   }
2525 }
2526 
2527 void CXXNameMangler::mangleQualifiers(Qualifiers Quals, const DependentAddressSpaceType *DAST) {
2528   // Vendor qualifiers come first and if they are order-insensitive they must
2529   // be emitted in reversed alphabetical order, see Itanium ABI 5.1.5.
2530 
2531   // <type> ::= U <addrspace-expr>
2532   if (DAST) {
2533     Out << "U2ASI";
2534     mangleExpression(DAST->getAddrSpaceExpr());
2535     Out << "E";
2536   }
2537 
2538   // Address space qualifiers start with an ordinary letter.
2539   if (Quals.hasAddressSpace()) {
2540     // Address space extension:
2541     //
2542     //   <type> ::= U <target-addrspace>
2543     //   <type> ::= U <OpenCL-addrspace>
2544     //   <type> ::= U <CUDA-addrspace>
2545 
2546     SmallString<64> ASString;
2547     LangAS AS = Quals.getAddressSpace();
2548 
2549     if (Context.getASTContext().addressSpaceMapManglingFor(AS)) {
2550       //  <target-addrspace> ::= "AS" <address-space-number>
2551       unsigned TargetAS = Context.getASTContext().getTargetAddressSpace(AS);
2552       if (TargetAS != 0 ||
2553           Context.getASTContext().getTargetAddressSpace(LangAS::Default) != 0)
2554         ASString = "AS" + llvm::utostr(TargetAS);
2555     } else {
2556       switch (AS) {
2557       default: llvm_unreachable("Not a language specific address space");
2558       //  <OpenCL-addrspace> ::= "CL" [ "global" | "local" | "constant" |
2559       //                                "private"| "generic" | "device" |
2560       //                                "host" ]
2561       case LangAS::opencl_global:
2562         ASString = "CLglobal";
2563         break;
2564       case LangAS::opencl_global_device:
2565         ASString = "CLdevice";
2566         break;
2567       case LangAS::opencl_global_host:
2568         ASString = "CLhost";
2569         break;
2570       case LangAS::opencl_local:
2571         ASString = "CLlocal";
2572         break;
2573       case LangAS::opencl_constant:
2574         ASString = "CLconstant";
2575         break;
2576       case LangAS::opencl_private:
2577         ASString = "CLprivate";
2578         break;
2579       case LangAS::opencl_generic:
2580         ASString = "CLgeneric";
2581         break;
2582       //  <SYCL-addrspace> ::= "SY" [ "global" | "local" | "private" |
2583       //                              "device" | "host" ]
2584       case LangAS::sycl_global:
2585         ASString = "SYglobal";
2586         break;
2587       case LangAS::sycl_global_device:
2588         ASString = "SYdevice";
2589         break;
2590       case LangAS::sycl_global_host:
2591         ASString = "SYhost";
2592         break;
2593       case LangAS::sycl_local:
2594         ASString = "SYlocal";
2595         break;
2596       case LangAS::sycl_private:
2597         ASString = "SYprivate";
2598         break;
2599       //  <CUDA-addrspace> ::= "CU" [ "device" | "constant" | "shared" ]
2600       case LangAS::cuda_device:
2601         ASString = "CUdevice";
2602         break;
2603       case LangAS::cuda_constant:
2604         ASString = "CUconstant";
2605         break;
2606       case LangAS::cuda_shared:
2607         ASString = "CUshared";
2608         break;
2609       //  <ptrsize-addrspace> ::= [ "ptr32_sptr" | "ptr32_uptr" | "ptr64" ]
2610       case LangAS::ptr32_sptr:
2611         ASString = "ptr32_sptr";
2612         break;
2613       case LangAS::ptr32_uptr:
2614         ASString = "ptr32_uptr";
2615         break;
2616       case LangAS::ptr64:
2617         ASString = "ptr64";
2618         break;
2619       }
2620     }
2621     if (!ASString.empty())
2622       mangleVendorQualifier(ASString);
2623   }
2624 
2625   // The ARC ownership qualifiers start with underscores.
2626   // Objective-C ARC Extension:
2627   //
2628   //   <type> ::= U "__strong"
2629   //   <type> ::= U "__weak"
2630   //   <type> ::= U "__autoreleasing"
2631   //
2632   // Note: we emit __weak first to preserve the order as
2633   // required by the Itanium ABI.
2634   if (Quals.getObjCLifetime() == Qualifiers::OCL_Weak)
2635     mangleVendorQualifier("__weak");
2636 
2637   // __unaligned (from -fms-extensions)
2638   if (Quals.hasUnaligned())
2639     mangleVendorQualifier("__unaligned");
2640 
2641   // Remaining ARC ownership qualifiers.
2642   switch (Quals.getObjCLifetime()) {
2643   case Qualifiers::OCL_None:
2644     break;
2645 
2646   case Qualifiers::OCL_Weak:
2647     // Do nothing as we already handled this case above.
2648     break;
2649 
2650   case Qualifiers::OCL_Strong:
2651     mangleVendorQualifier("__strong");
2652     break;
2653 
2654   case Qualifiers::OCL_Autoreleasing:
2655     mangleVendorQualifier("__autoreleasing");
2656     break;
2657 
2658   case Qualifiers::OCL_ExplicitNone:
2659     // The __unsafe_unretained qualifier is *not* mangled, so that
2660     // __unsafe_unretained types in ARC produce the same manglings as the
2661     // equivalent (but, naturally, unqualified) types in non-ARC, providing
2662     // better ABI compatibility.
2663     //
2664     // It's safe to do this because unqualified 'id' won't show up
2665     // in any type signatures that need to be mangled.
2666     break;
2667   }
2668 
2669   // <CV-qualifiers> ::= [r] [V] [K]    # restrict (C99), volatile, const
2670   if (Quals.hasRestrict())
2671     Out << 'r';
2672   if (Quals.hasVolatile())
2673     Out << 'V';
2674   if (Quals.hasConst())
2675     Out << 'K';
2676 }
2677 
2678 void CXXNameMangler::mangleVendorQualifier(StringRef name) {
2679   Out << 'U' << name.size() << name;
2680 }
2681 
2682 void CXXNameMangler::mangleRefQualifier(RefQualifierKind RefQualifier) {
2683   // <ref-qualifier> ::= R                # lvalue reference
2684   //                 ::= O                # rvalue-reference
2685   switch (RefQualifier) {
2686   case RQ_None:
2687     break;
2688 
2689   case RQ_LValue:
2690     Out << 'R';
2691     break;
2692 
2693   case RQ_RValue:
2694     Out << 'O';
2695     break;
2696   }
2697 }
2698 
2699 void CXXNameMangler::mangleObjCMethodName(const ObjCMethodDecl *MD) {
2700   Context.mangleObjCMethodNameAsSourceName(MD, Out);
2701 }
2702 
2703 static bool isTypeSubstitutable(Qualifiers Quals, const Type *Ty,
2704                                 ASTContext &Ctx) {
2705   if (Quals)
2706     return true;
2707   if (Ty->isSpecificBuiltinType(BuiltinType::ObjCSel))
2708     return true;
2709   if (Ty->isOpenCLSpecificType())
2710     return true;
2711   if (Ty->isBuiltinType())
2712     return false;
2713   // Through to Clang 6.0, we accidentally treated undeduced auto types as
2714   // substitution candidates.
2715   if (Ctx.getLangOpts().getClangABICompat() > LangOptions::ClangABI::Ver6 &&
2716       isa<AutoType>(Ty))
2717     return false;
2718   // A placeholder type for class template deduction is substitutable with
2719   // its corresponding template name; this is handled specially when mangling
2720   // the type.
2721   if (auto *DeducedTST = Ty->getAs<DeducedTemplateSpecializationType>())
2722     if (DeducedTST->getDeducedType().isNull())
2723       return false;
2724   return true;
2725 }
2726 
2727 void CXXNameMangler::mangleType(QualType T) {
2728   // If our type is instantiation-dependent but not dependent, we mangle
2729   // it as it was written in the source, removing any top-level sugar.
2730   // Otherwise, use the canonical type.
2731   //
2732   // FIXME: This is an approximation of the instantiation-dependent name
2733   // mangling rules, since we should really be using the type as written and
2734   // augmented via semantic analysis (i.e., with implicit conversions and
2735   // default template arguments) for any instantiation-dependent type.
2736   // Unfortunately, that requires several changes to our AST:
2737   //   - Instantiation-dependent TemplateSpecializationTypes will need to be
2738   //     uniqued, so that we can handle substitutions properly
2739   //   - Default template arguments will need to be represented in the
2740   //     TemplateSpecializationType, since they need to be mangled even though
2741   //     they aren't written.
2742   //   - Conversions on non-type template arguments need to be expressed, since
2743   //     they can affect the mangling of sizeof/alignof.
2744   //
2745   // FIXME: This is wrong when mapping to the canonical type for a dependent
2746   // type discards instantiation-dependent portions of the type, such as for:
2747   //
2748   //   template<typename T, int N> void f(T (&)[sizeof(N)]);
2749   //   template<typename T> void f(T() throw(typename T::type)); (pre-C++17)
2750   //
2751   // It's also wrong in the opposite direction when instantiation-dependent,
2752   // canonically-equivalent types differ in some irrelevant portion of inner
2753   // type sugar. In such cases, we fail to form correct substitutions, eg:
2754   //
2755   //   template<int N> void f(A<sizeof(N)> *, A<sizeof(N)> (*));
2756   //
2757   // We should instead canonicalize the non-instantiation-dependent parts,
2758   // regardless of whether the type as a whole is dependent or instantiation
2759   // dependent.
2760   if (!T->isInstantiationDependentType() || T->isDependentType())
2761     T = T.getCanonicalType();
2762   else {
2763     // Desugar any types that are purely sugar.
2764     do {
2765       // Don't desugar through template specialization types that aren't
2766       // type aliases. We need to mangle the template arguments as written.
2767       if (const TemplateSpecializationType *TST
2768                                       = dyn_cast<TemplateSpecializationType>(T))
2769         if (!TST->isTypeAlias())
2770           break;
2771 
2772       // FIXME: We presumably shouldn't strip off ElaboratedTypes with
2773       // instantation-dependent qualifiers. See
2774       // https://github.com/itanium-cxx-abi/cxx-abi/issues/114.
2775 
2776       QualType Desugared
2777         = T.getSingleStepDesugaredType(Context.getASTContext());
2778       if (Desugared == T)
2779         break;
2780 
2781       T = Desugared;
2782     } while (true);
2783   }
2784   SplitQualType split = T.split();
2785   Qualifiers quals = split.Quals;
2786   const Type *ty = split.Ty;
2787 
2788   bool isSubstitutable =
2789     isTypeSubstitutable(quals, ty, Context.getASTContext());
2790   if (isSubstitutable && mangleSubstitution(T))
2791     return;
2792 
2793   // If we're mangling a qualified array type, push the qualifiers to
2794   // the element type.
2795   if (quals && isa<ArrayType>(T)) {
2796     ty = Context.getASTContext().getAsArrayType(T);
2797     quals = Qualifiers();
2798 
2799     // Note that we don't update T: we want to add the
2800     // substitution at the original type.
2801   }
2802 
2803   if (quals || ty->isDependentAddressSpaceType()) {
2804     if (const DependentAddressSpaceType *DAST =
2805         dyn_cast<DependentAddressSpaceType>(ty)) {
2806       SplitQualType splitDAST = DAST->getPointeeType().split();
2807       mangleQualifiers(splitDAST.Quals, DAST);
2808       mangleType(QualType(splitDAST.Ty, 0));
2809     } else {
2810       mangleQualifiers(quals);
2811 
2812       // Recurse:  even if the qualified type isn't yet substitutable,
2813       // the unqualified type might be.
2814       mangleType(QualType(ty, 0));
2815     }
2816   } else {
2817     switch (ty->getTypeClass()) {
2818 #define ABSTRACT_TYPE(CLASS, PARENT)
2819 #define NON_CANONICAL_TYPE(CLASS, PARENT) \
2820     case Type::CLASS: \
2821       llvm_unreachable("can't mangle non-canonical type " #CLASS "Type"); \
2822       return;
2823 #define TYPE(CLASS, PARENT) \
2824     case Type::CLASS: \
2825       mangleType(static_cast<const CLASS##Type*>(ty)); \
2826       break;
2827 #include "clang/AST/TypeNodes.inc"
2828     }
2829   }
2830 
2831   // Add the substitution.
2832   if (isSubstitutable)
2833     addSubstitution(T);
2834 }
2835 
2836 void CXXNameMangler::mangleNameOrStandardSubstitution(const NamedDecl *ND) {
2837   if (!mangleStandardSubstitution(ND))
2838     mangleName(ND);
2839 }
2840 
2841 void CXXNameMangler::mangleType(const BuiltinType *T) {
2842   //  <type>         ::= <builtin-type>
2843   //  <builtin-type> ::= v  # void
2844   //                 ::= w  # wchar_t
2845   //                 ::= b  # bool
2846   //                 ::= c  # char
2847   //                 ::= a  # signed char
2848   //                 ::= h  # unsigned char
2849   //                 ::= s  # short
2850   //                 ::= t  # unsigned short
2851   //                 ::= i  # int
2852   //                 ::= j  # unsigned int
2853   //                 ::= l  # long
2854   //                 ::= m  # unsigned long
2855   //                 ::= x  # long long, __int64
2856   //                 ::= y  # unsigned long long, __int64
2857   //                 ::= n  # __int128
2858   //                 ::= o  # unsigned __int128
2859   //                 ::= f  # float
2860   //                 ::= d  # double
2861   //                 ::= e  # long double, __float80
2862   //                 ::= g  # __float128
2863   // UNSUPPORTED:    ::= Dd # IEEE 754r decimal floating point (64 bits)
2864   // UNSUPPORTED:    ::= De # IEEE 754r decimal floating point (128 bits)
2865   // UNSUPPORTED:    ::= Df # IEEE 754r decimal floating point (32 bits)
2866   //                 ::= Dh # IEEE 754r half-precision floating point (16 bits)
2867   //                 ::= DF <number> _ # ISO/IEC TS 18661 binary floating point type _FloatN (N bits);
2868   //                 ::= Di # char32_t
2869   //                 ::= Ds # char16_t
2870   //                 ::= Dn # std::nullptr_t (i.e., decltype(nullptr))
2871   //                 ::= u <source-name>    # vendor extended type
2872   std::string type_name;
2873   switch (T->getKind()) {
2874   case BuiltinType::Void:
2875     Out << 'v';
2876     break;
2877   case BuiltinType::Bool:
2878     Out << 'b';
2879     break;
2880   case BuiltinType::Char_U:
2881   case BuiltinType::Char_S:
2882     Out << 'c';
2883     break;
2884   case BuiltinType::UChar:
2885     Out << 'h';
2886     break;
2887   case BuiltinType::UShort:
2888     Out << 't';
2889     break;
2890   case BuiltinType::UInt:
2891     Out << 'j';
2892     break;
2893   case BuiltinType::ULong:
2894     Out << 'm';
2895     break;
2896   case BuiltinType::ULongLong:
2897     Out << 'y';
2898     break;
2899   case BuiltinType::UInt128:
2900     Out << 'o';
2901     break;
2902   case BuiltinType::SChar:
2903     Out << 'a';
2904     break;
2905   case BuiltinType::WChar_S:
2906   case BuiltinType::WChar_U:
2907     Out << 'w';
2908     break;
2909   case BuiltinType::Char8:
2910     Out << "Du";
2911     break;
2912   case BuiltinType::Char16:
2913     Out << "Ds";
2914     break;
2915   case BuiltinType::Char32:
2916     Out << "Di";
2917     break;
2918   case BuiltinType::Short:
2919     Out << 's';
2920     break;
2921   case BuiltinType::Int:
2922     Out << 'i';
2923     break;
2924   case BuiltinType::Long:
2925     Out << 'l';
2926     break;
2927   case BuiltinType::LongLong:
2928     Out << 'x';
2929     break;
2930   case BuiltinType::Int128:
2931     Out << 'n';
2932     break;
2933   case BuiltinType::Float16:
2934     Out << "DF16_";
2935     break;
2936   case BuiltinType::ShortAccum:
2937   case BuiltinType::Accum:
2938   case BuiltinType::LongAccum:
2939   case BuiltinType::UShortAccum:
2940   case BuiltinType::UAccum:
2941   case BuiltinType::ULongAccum:
2942   case BuiltinType::ShortFract:
2943   case BuiltinType::Fract:
2944   case BuiltinType::LongFract:
2945   case BuiltinType::UShortFract:
2946   case BuiltinType::UFract:
2947   case BuiltinType::ULongFract:
2948   case BuiltinType::SatShortAccum:
2949   case BuiltinType::SatAccum:
2950   case BuiltinType::SatLongAccum:
2951   case BuiltinType::SatUShortAccum:
2952   case BuiltinType::SatUAccum:
2953   case BuiltinType::SatULongAccum:
2954   case BuiltinType::SatShortFract:
2955   case BuiltinType::SatFract:
2956   case BuiltinType::SatLongFract:
2957   case BuiltinType::SatUShortFract:
2958   case BuiltinType::SatUFract:
2959   case BuiltinType::SatULongFract:
2960     llvm_unreachable("Fixed point types are disabled for c++");
2961   case BuiltinType::Half:
2962     Out << "Dh";
2963     break;
2964   case BuiltinType::Float:
2965     Out << 'f';
2966     break;
2967   case BuiltinType::Double:
2968     Out << 'd';
2969     break;
2970   case BuiltinType::LongDouble: {
2971     const TargetInfo *TI = getASTContext().getLangOpts().OpenMP &&
2972                                    getASTContext().getLangOpts().OpenMPIsDevice
2973                                ? getASTContext().getAuxTargetInfo()
2974                                : &getASTContext().getTargetInfo();
2975     Out << TI->getLongDoubleMangling();
2976     break;
2977   }
2978   case BuiltinType::Float128: {
2979     const TargetInfo *TI = getASTContext().getLangOpts().OpenMP &&
2980                                    getASTContext().getLangOpts().OpenMPIsDevice
2981                                ? getASTContext().getAuxTargetInfo()
2982                                : &getASTContext().getTargetInfo();
2983     Out << TI->getFloat128Mangling();
2984     break;
2985   }
2986   case BuiltinType::BFloat16: {
2987     const TargetInfo *TI = &getASTContext().getTargetInfo();
2988     Out << TI->getBFloat16Mangling();
2989     break;
2990   }
2991   case BuiltinType::NullPtr:
2992     Out << "Dn";
2993     break;
2994 
2995 #define BUILTIN_TYPE(Id, SingletonId)
2996 #define PLACEHOLDER_TYPE(Id, SingletonId) \
2997   case BuiltinType::Id:
2998 #include "clang/AST/BuiltinTypes.def"
2999   case BuiltinType::Dependent:
3000     if (!NullOut)
3001       llvm_unreachable("mangling a placeholder type");
3002     break;
3003   case BuiltinType::ObjCId:
3004     Out << "11objc_object";
3005     break;
3006   case BuiltinType::ObjCClass:
3007     Out << "10objc_class";
3008     break;
3009   case BuiltinType::ObjCSel:
3010     Out << "13objc_selector";
3011     break;
3012 #define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
3013   case BuiltinType::Id: \
3014     type_name = "ocl_" #ImgType "_" #Suffix; \
3015     Out << type_name.size() << type_name; \
3016     break;
3017 #include "clang/Basic/OpenCLImageTypes.def"
3018   case BuiltinType::OCLSampler:
3019     Out << "11ocl_sampler";
3020     break;
3021   case BuiltinType::OCLEvent:
3022     Out << "9ocl_event";
3023     break;
3024   case BuiltinType::OCLClkEvent:
3025     Out << "12ocl_clkevent";
3026     break;
3027   case BuiltinType::OCLQueue:
3028     Out << "9ocl_queue";
3029     break;
3030   case BuiltinType::OCLReserveID:
3031     Out << "13ocl_reserveid";
3032     break;
3033 #define EXT_OPAQUE_TYPE(ExtType, Id, Ext) \
3034   case BuiltinType::Id: \
3035     type_name = "ocl_" #ExtType; \
3036     Out << type_name.size() << type_name; \
3037     break;
3038 #include "clang/Basic/OpenCLExtensionTypes.def"
3039   // The SVE types are effectively target-specific.  The mangling scheme
3040   // is defined in the appendices to the Procedure Call Standard for the
3041   // Arm Architecture.
3042 #define SVE_VECTOR_TYPE(InternalName, MangledName, Id, SingletonId, NumEls,    \
3043                         ElBits, IsSigned, IsFP, IsBF)                          \
3044   case BuiltinType::Id:                                                        \
3045     type_name = MangledName;                                                   \
3046     Out << (type_name == InternalName ? "u" : "") << type_name.size()          \
3047         << type_name;                                                          \
3048     break;
3049 #define SVE_PREDICATE_TYPE(InternalName, MangledName, Id, SingletonId, NumEls) \
3050   case BuiltinType::Id:                                                        \
3051     type_name = MangledName;                                                   \
3052     Out << (type_name == InternalName ? "u" : "") << type_name.size()          \
3053         << type_name;                                                          \
3054     break;
3055 #include "clang/Basic/AArch64SVEACLETypes.def"
3056 #define PPC_VECTOR_TYPE(Name, Id, Size) \
3057   case BuiltinType::Id: \
3058     type_name = #Name; \
3059     Out << 'u' << type_name.size() << type_name; \
3060     break;
3061 #include "clang/Basic/PPCTypes.def"
3062     // TODO: Check the mangling scheme for RISC-V V.
3063 #define RVV_TYPE(Name, Id, SingletonId)                                        \
3064   case BuiltinType::Id:                                                        \
3065     type_name = Name;                                                          \
3066     Out << 'u' << type_name.size() << type_name;                               \
3067     break;
3068 #include "clang/Basic/RISCVVTypes.def"
3069   }
3070 }
3071 
3072 StringRef CXXNameMangler::getCallingConvQualifierName(CallingConv CC) {
3073   switch (CC) {
3074   case CC_C:
3075     return "";
3076 
3077   case CC_X86VectorCall:
3078   case CC_X86Pascal:
3079   case CC_X86RegCall:
3080   case CC_AAPCS:
3081   case CC_AAPCS_VFP:
3082   case CC_AArch64VectorCall:
3083   case CC_IntelOclBicc:
3084   case CC_SpirFunction:
3085   case CC_OpenCLKernel:
3086   case CC_PreserveMost:
3087   case CC_PreserveAll:
3088     // FIXME: we should be mangling all of the above.
3089     return "";
3090 
3091   case CC_X86ThisCall:
3092     // FIXME: To match mingw GCC, thiscall should only be mangled in when it is
3093     // used explicitly. At this point, we don't have that much information in
3094     // the AST, since clang tends to bake the convention into the canonical
3095     // function type. thiscall only rarely used explicitly, so don't mangle it
3096     // for now.
3097     return "";
3098 
3099   case CC_X86StdCall:
3100     return "stdcall";
3101   case CC_X86FastCall:
3102     return "fastcall";
3103   case CC_X86_64SysV:
3104     return "sysv_abi";
3105   case CC_Win64:
3106     return "ms_abi";
3107   case CC_Swift:
3108     return "swiftcall";
3109   }
3110   llvm_unreachable("bad calling convention");
3111 }
3112 
3113 void CXXNameMangler::mangleExtFunctionInfo(const FunctionType *T) {
3114   // Fast path.
3115   if (T->getExtInfo() == FunctionType::ExtInfo())
3116     return;
3117 
3118   // Vendor-specific qualifiers are emitted in reverse alphabetical order.
3119   // This will get more complicated in the future if we mangle other
3120   // things here; but for now, since we mangle ns_returns_retained as
3121   // a qualifier on the result type, we can get away with this:
3122   StringRef CCQualifier = getCallingConvQualifierName(T->getExtInfo().getCC());
3123   if (!CCQualifier.empty())
3124     mangleVendorQualifier(CCQualifier);
3125 
3126   // FIXME: regparm
3127   // FIXME: noreturn
3128 }
3129 
3130 void
3131 CXXNameMangler::mangleExtParameterInfo(FunctionProtoType::ExtParameterInfo PI) {
3132   // Vendor-specific qualifiers are emitted in reverse alphabetical order.
3133 
3134   // Note that these are *not* substitution candidates.  Demanglers might
3135   // have trouble with this if the parameter type is fully substituted.
3136 
3137   switch (PI.getABI()) {
3138   case ParameterABI::Ordinary:
3139     break;
3140 
3141   // All of these start with "swift", so they come before "ns_consumed".
3142   case ParameterABI::SwiftContext:
3143   case ParameterABI::SwiftErrorResult:
3144   case ParameterABI::SwiftIndirectResult:
3145     mangleVendorQualifier(getParameterABISpelling(PI.getABI()));
3146     break;
3147   }
3148 
3149   if (PI.isConsumed())
3150     mangleVendorQualifier("ns_consumed");
3151 
3152   if (PI.isNoEscape())
3153     mangleVendorQualifier("noescape");
3154 }
3155 
3156 // <type>          ::= <function-type>
3157 // <function-type> ::= [<CV-qualifiers>] F [Y]
3158 //                      <bare-function-type> [<ref-qualifier>] E
3159 void CXXNameMangler::mangleType(const FunctionProtoType *T) {
3160   mangleExtFunctionInfo(T);
3161 
3162   // Mangle CV-qualifiers, if present.  These are 'this' qualifiers,
3163   // e.g. "const" in "int (A::*)() const".
3164   mangleQualifiers(T->getMethodQuals());
3165 
3166   // Mangle instantiation-dependent exception-specification, if present,
3167   // per cxx-abi-dev proposal on 2016-10-11.
3168   if (T->hasInstantiationDependentExceptionSpec()) {
3169     if (isComputedNoexcept(T->getExceptionSpecType())) {
3170       Out << "DO";
3171       mangleExpression(T->getNoexceptExpr());
3172       Out << "E";
3173     } else {
3174       assert(T->getExceptionSpecType() == EST_Dynamic);
3175       Out << "Dw";
3176       for (auto ExceptTy : T->exceptions())
3177         mangleType(ExceptTy);
3178       Out << "E";
3179     }
3180   } else if (T->isNothrow()) {
3181     Out << "Do";
3182   }
3183 
3184   Out << 'F';
3185 
3186   // FIXME: We don't have enough information in the AST to produce the 'Y'
3187   // encoding for extern "C" function types.
3188   mangleBareFunctionType(T, /*MangleReturnType=*/true);
3189 
3190   // Mangle the ref-qualifier, if present.
3191   mangleRefQualifier(T->getRefQualifier());
3192 
3193   Out << 'E';
3194 }
3195 
3196 void CXXNameMangler::mangleType(const FunctionNoProtoType *T) {
3197   // Function types without prototypes can arise when mangling a function type
3198   // within an overloadable function in C. We mangle these as the absence of any
3199   // parameter types (not even an empty parameter list).
3200   Out << 'F';
3201 
3202   FunctionTypeDepthState saved = FunctionTypeDepth.push();
3203 
3204   FunctionTypeDepth.enterResultType();
3205   mangleType(T->getReturnType());
3206   FunctionTypeDepth.leaveResultType();
3207 
3208   FunctionTypeDepth.pop(saved);
3209   Out << 'E';
3210 }
3211 
3212 void CXXNameMangler::mangleBareFunctionType(const FunctionProtoType *Proto,
3213                                             bool MangleReturnType,
3214                                             const FunctionDecl *FD) {
3215   // Record that we're in a function type.  See mangleFunctionParam
3216   // for details on what we're trying to achieve here.
3217   FunctionTypeDepthState saved = FunctionTypeDepth.push();
3218 
3219   // <bare-function-type> ::= <signature type>+
3220   if (MangleReturnType) {
3221     FunctionTypeDepth.enterResultType();
3222 
3223     // Mangle ns_returns_retained as an order-sensitive qualifier here.
3224     if (Proto->getExtInfo().getProducesResult() && FD == nullptr)
3225       mangleVendorQualifier("ns_returns_retained");
3226 
3227     // Mangle the return type without any direct ARC ownership qualifiers.
3228     QualType ReturnTy = Proto->getReturnType();
3229     if (ReturnTy.getObjCLifetime()) {
3230       auto SplitReturnTy = ReturnTy.split();
3231       SplitReturnTy.Quals.removeObjCLifetime();
3232       ReturnTy = getASTContext().getQualifiedType(SplitReturnTy);
3233     }
3234     mangleType(ReturnTy);
3235 
3236     FunctionTypeDepth.leaveResultType();
3237   }
3238 
3239   if (Proto->getNumParams() == 0 && !Proto->isVariadic()) {
3240     //   <builtin-type> ::= v   # void
3241     Out << 'v';
3242 
3243     FunctionTypeDepth.pop(saved);
3244     return;
3245   }
3246 
3247   assert(!FD || FD->getNumParams() == Proto->getNumParams());
3248   for (unsigned I = 0, E = Proto->getNumParams(); I != E; ++I) {
3249     // Mangle extended parameter info as order-sensitive qualifiers here.
3250     if (Proto->hasExtParameterInfos() && FD == nullptr) {
3251       mangleExtParameterInfo(Proto->getExtParameterInfo(I));
3252     }
3253 
3254     // Mangle the type.
3255     QualType ParamTy = Proto->getParamType(I);
3256     mangleType(Context.getASTContext().getSignatureParameterType(ParamTy));
3257 
3258     if (FD) {
3259       if (auto *Attr = FD->getParamDecl(I)->getAttr<PassObjectSizeAttr>()) {
3260         // Attr can only take 1 character, so we can hardcode the length below.
3261         assert(Attr->getType() <= 9 && Attr->getType() >= 0);
3262         if (Attr->isDynamic())
3263           Out << "U25pass_dynamic_object_size" << Attr->getType();
3264         else
3265           Out << "U17pass_object_size" << Attr->getType();
3266       }
3267     }
3268   }
3269 
3270   FunctionTypeDepth.pop(saved);
3271 
3272   // <builtin-type>      ::= z  # ellipsis
3273   if (Proto->isVariadic())
3274     Out << 'z';
3275 }
3276 
3277 // <type>            ::= <class-enum-type>
3278 // <class-enum-type> ::= <name>
3279 void CXXNameMangler::mangleType(const UnresolvedUsingType *T) {
3280   mangleName(T->getDecl());
3281 }
3282 
3283 // <type>            ::= <class-enum-type>
3284 // <class-enum-type> ::= <name>
3285 void CXXNameMangler::mangleType(const EnumType *T) {
3286   mangleType(static_cast<const TagType*>(T));
3287 }
3288 void CXXNameMangler::mangleType(const RecordType *T) {
3289   mangleType(static_cast<const TagType*>(T));
3290 }
3291 void CXXNameMangler::mangleType(const TagType *T) {
3292   mangleName(T->getDecl());
3293 }
3294 
3295 // <type>       ::= <array-type>
3296 // <array-type> ::= A <positive dimension number> _ <element type>
3297 //              ::= A [<dimension expression>] _ <element type>
3298 void CXXNameMangler::mangleType(const ConstantArrayType *T) {
3299   Out << 'A' << T->getSize() << '_';
3300   mangleType(T->getElementType());
3301 }
3302 void CXXNameMangler::mangleType(const VariableArrayType *T) {
3303   Out << 'A';
3304   // decayed vla types (size 0) will just be skipped.
3305   if (T->getSizeExpr())
3306     mangleExpression(T->getSizeExpr());
3307   Out << '_';
3308   mangleType(T->getElementType());
3309 }
3310 void CXXNameMangler::mangleType(const DependentSizedArrayType *T) {
3311   Out << 'A';
3312   // A DependentSizedArrayType might not have size expression as below
3313   //
3314   // template<int ...N> int arr[] = {N...};
3315   if (T->getSizeExpr())
3316     mangleExpression(T->getSizeExpr());
3317   Out << '_';
3318   mangleType(T->getElementType());
3319 }
3320 void CXXNameMangler::mangleType(const IncompleteArrayType *T) {
3321   Out << "A_";
3322   mangleType(T->getElementType());
3323 }
3324 
3325 // <type>                   ::= <pointer-to-member-type>
3326 // <pointer-to-member-type> ::= M <class type> <member type>
3327 void CXXNameMangler::mangleType(const MemberPointerType *T) {
3328   Out << 'M';
3329   mangleType(QualType(T->getClass(), 0));
3330   QualType PointeeType = T->getPointeeType();
3331   if (const FunctionProtoType *FPT = dyn_cast<FunctionProtoType>(PointeeType)) {
3332     mangleType(FPT);
3333 
3334     // Itanium C++ ABI 5.1.8:
3335     //
3336     //   The type of a non-static member function is considered to be different,
3337     //   for the purposes of substitution, from the type of a namespace-scope or
3338     //   static member function whose type appears similar. The types of two
3339     //   non-static member functions are considered to be different, for the
3340     //   purposes of substitution, if the functions are members of different
3341     //   classes. In other words, for the purposes of substitution, the class of
3342     //   which the function is a member is considered part of the type of
3343     //   function.
3344 
3345     // Given that we already substitute member function pointers as a
3346     // whole, the net effect of this rule is just to unconditionally
3347     // suppress substitution on the function type in a member pointer.
3348     // We increment the SeqID here to emulate adding an entry to the
3349     // substitution table.
3350     ++SeqID;
3351   } else
3352     mangleType(PointeeType);
3353 }
3354 
3355 // <type>           ::= <template-param>
3356 void CXXNameMangler::mangleType(const TemplateTypeParmType *T) {
3357   mangleTemplateParameter(T->getDepth(), T->getIndex());
3358 }
3359 
3360 // <type>           ::= <template-param>
3361 void CXXNameMangler::mangleType(const SubstTemplateTypeParmPackType *T) {
3362   // FIXME: not clear how to mangle this!
3363   // template <class T...> class A {
3364   //   template <class U...> void foo(T(*)(U) x...);
3365   // };
3366   Out << "_SUBSTPACK_";
3367 }
3368 
3369 // <type> ::= P <type>   # pointer-to
3370 void CXXNameMangler::mangleType(const PointerType *T) {
3371   Out << 'P';
3372   mangleType(T->getPointeeType());
3373 }
3374 void CXXNameMangler::mangleType(const ObjCObjectPointerType *T) {
3375   Out << 'P';
3376   mangleType(T->getPointeeType());
3377 }
3378 
3379 // <type> ::= R <type>   # reference-to
3380 void CXXNameMangler::mangleType(const LValueReferenceType *T) {
3381   Out << 'R';
3382   mangleType(T->getPointeeType());
3383 }
3384 
3385 // <type> ::= O <type>   # rvalue reference-to (C++0x)
3386 void CXXNameMangler::mangleType(const RValueReferenceType *T) {
3387   Out << 'O';
3388   mangleType(T->getPointeeType());
3389 }
3390 
3391 // <type> ::= C <type>   # complex pair (C 2000)
3392 void CXXNameMangler::mangleType(const ComplexType *T) {
3393   Out << 'C';
3394   mangleType(T->getElementType());
3395 }
3396 
3397 // ARM's ABI for Neon vector types specifies that they should be mangled as
3398 // if they are structs (to match ARM's initial implementation).  The
3399 // vector type must be one of the special types predefined by ARM.
3400 void CXXNameMangler::mangleNeonVectorType(const VectorType *T) {
3401   QualType EltType = T->getElementType();
3402   assert(EltType->isBuiltinType() && "Neon vector element not a BuiltinType");
3403   const char *EltName = nullptr;
3404   if (T->getVectorKind() == VectorType::NeonPolyVector) {
3405     switch (cast<BuiltinType>(EltType)->getKind()) {
3406     case BuiltinType::SChar:
3407     case BuiltinType::UChar:
3408       EltName = "poly8_t";
3409       break;
3410     case BuiltinType::Short:
3411     case BuiltinType::UShort:
3412       EltName = "poly16_t";
3413       break;
3414     case BuiltinType::LongLong:
3415     case BuiltinType::ULongLong:
3416       EltName = "poly64_t";
3417       break;
3418     default: llvm_unreachable("unexpected Neon polynomial vector element type");
3419     }
3420   } else {
3421     switch (cast<BuiltinType>(EltType)->getKind()) {
3422     case BuiltinType::SChar:     EltName = "int8_t"; break;
3423     case BuiltinType::UChar:     EltName = "uint8_t"; break;
3424     case BuiltinType::Short:     EltName = "int16_t"; break;
3425     case BuiltinType::UShort:    EltName = "uint16_t"; break;
3426     case BuiltinType::Int:       EltName = "int32_t"; break;
3427     case BuiltinType::UInt:      EltName = "uint32_t"; break;
3428     case BuiltinType::LongLong:  EltName = "int64_t"; break;
3429     case BuiltinType::ULongLong: EltName = "uint64_t"; break;
3430     case BuiltinType::Double:    EltName = "float64_t"; break;
3431     case BuiltinType::Float:     EltName = "float32_t"; break;
3432     case BuiltinType::Half:      EltName = "float16_t"; break;
3433     case BuiltinType::BFloat16:  EltName = "bfloat16_t"; break;
3434     default:
3435       llvm_unreachable("unexpected Neon vector element type");
3436     }
3437   }
3438   const char *BaseName = nullptr;
3439   unsigned BitSize = (T->getNumElements() *
3440                       getASTContext().getTypeSize(EltType));
3441   if (BitSize == 64)
3442     BaseName = "__simd64_";
3443   else {
3444     assert(BitSize == 128 && "Neon vector type not 64 or 128 bits");
3445     BaseName = "__simd128_";
3446   }
3447   Out << strlen(BaseName) + strlen(EltName);
3448   Out << BaseName << EltName;
3449 }
3450 
3451 void CXXNameMangler::mangleNeonVectorType(const DependentVectorType *T) {
3452   DiagnosticsEngine &Diags = Context.getDiags();
3453   unsigned DiagID = Diags.getCustomDiagID(
3454       DiagnosticsEngine::Error,
3455       "cannot mangle this dependent neon vector type yet");
3456   Diags.Report(T->getAttributeLoc(), DiagID);
3457 }
3458 
3459 static StringRef mangleAArch64VectorBase(const BuiltinType *EltType) {
3460   switch (EltType->getKind()) {
3461   case BuiltinType::SChar:
3462     return "Int8";
3463   case BuiltinType::Short:
3464     return "Int16";
3465   case BuiltinType::Int:
3466     return "Int32";
3467   case BuiltinType::Long:
3468   case BuiltinType::LongLong:
3469     return "Int64";
3470   case BuiltinType::UChar:
3471     return "Uint8";
3472   case BuiltinType::UShort:
3473     return "Uint16";
3474   case BuiltinType::UInt:
3475     return "Uint32";
3476   case BuiltinType::ULong:
3477   case BuiltinType::ULongLong:
3478     return "Uint64";
3479   case BuiltinType::Half:
3480     return "Float16";
3481   case BuiltinType::Float:
3482     return "Float32";
3483   case BuiltinType::Double:
3484     return "Float64";
3485   case BuiltinType::BFloat16:
3486     return "Bfloat16";
3487   default:
3488     llvm_unreachable("Unexpected vector element base type");
3489   }
3490 }
3491 
3492 // AArch64's ABI for Neon vector types specifies that they should be mangled as
3493 // the equivalent internal name. The vector type must be one of the special
3494 // types predefined by ARM.
3495 void CXXNameMangler::mangleAArch64NeonVectorType(const VectorType *T) {
3496   QualType EltType = T->getElementType();
3497   assert(EltType->isBuiltinType() && "Neon vector element not a BuiltinType");
3498   unsigned BitSize =
3499       (T->getNumElements() * getASTContext().getTypeSize(EltType));
3500   (void)BitSize; // Silence warning.
3501 
3502   assert((BitSize == 64 || BitSize == 128) &&
3503          "Neon vector type not 64 or 128 bits");
3504 
3505   StringRef EltName;
3506   if (T->getVectorKind() == VectorType::NeonPolyVector) {
3507     switch (cast<BuiltinType>(EltType)->getKind()) {
3508     case BuiltinType::UChar:
3509       EltName = "Poly8";
3510       break;
3511     case BuiltinType::UShort:
3512       EltName = "Poly16";
3513       break;
3514     case BuiltinType::ULong:
3515     case BuiltinType::ULongLong:
3516       EltName = "Poly64";
3517       break;
3518     default:
3519       llvm_unreachable("unexpected Neon polynomial vector element type");
3520     }
3521   } else
3522     EltName = mangleAArch64VectorBase(cast<BuiltinType>(EltType));
3523 
3524   std::string TypeName =
3525       ("__" + EltName + "x" + Twine(T->getNumElements()) + "_t").str();
3526   Out << TypeName.length() << TypeName;
3527 }
3528 void CXXNameMangler::mangleAArch64NeonVectorType(const DependentVectorType *T) {
3529   DiagnosticsEngine &Diags = Context.getDiags();
3530   unsigned DiagID = Diags.getCustomDiagID(
3531       DiagnosticsEngine::Error,
3532       "cannot mangle this dependent neon vector type yet");
3533   Diags.Report(T->getAttributeLoc(), DiagID);
3534 }
3535 
3536 // The AArch64 ACLE specifies that fixed-length SVE vector and predicate types
3537 // defined with the 'arm_sve_vector_bits' attribute map to the same AAPCS64
3538 // type as the sizeless variants.
3539 //
3540 // The mangling scheme for VLS types is implemented as a "pseudo" template:
3541 //
3542 //   '__SVE_VLS<<type>, <vector length>>'
3543 //
3544 // Combining the existing SVE type and a specific vector length (in bits).
3545 // For example:
3546 //
3547 //   typedef __SVInt32_t foo __attribute__((arm_sve_vector_bits(512)));
3548 //
3549 // is described as '__SVE_VLS<__SVInt32_t, 512u>' and mangled as:
3550 //
3551 //   "9__SVE_VLSI" + base type mangling + "Lj" + __ARM_FEATURE_SVE_BITS + "EE"
3552 //
3553 //   i.e. 9__SVE_VLSIu11__SVInt32_tLj512EE
3554 //
3555 // The latest ACLE specification (00bet5) does not contain details of this
3556 // mangling scheme, it will be specified in the next revision. The mangling
3557 // scheme is otherwise defined in the appendices to the Procedure Call Standard
3558 // for the Arm Architecture, see
3559 // https://github.com/ARM-software/abi-aa/blob/master/aapcs64/aapcs64.rst#appendix-c-mangling
3560 void CXXNameMangler::mangleAArch64FixedSveVectorType(const VectorType *T) {
3561   assert((T->getVectorKind() == VectorType::SveFixedLengthDataVector ||
3562           T->getVectorKind() == VectorType::SveFixedLengthPredicateVector) &&
3563          "expected fixed-length SVE vector!");
3564 
3565   QualType EltType = T->getElementType();
3566   assert(EltType->isBuiltinType() &&
3567          "expected builtin type for fixed-length SVE vector!");
3568 
3569   StringRef TypeName;
3570   switch (cast<BuiltinType>(EltType)->getKind()) {
3571   case BuiltinType::SChar:
3572     TypeName = "__SVInt8_t";
3573     break;
3574   case BuiltinType::UChar: {
3575     if (T->getVectorKind() == VectorType::SveFixedLengthDataVector)
3576       TypeName = "__SVUint8_t";
3577     else
3578       TypeName = "__SVBool_t";
3579     break;
3580   }
3581   case BuiltinType::Short:
3582     TypeName = "__SVInt16_t";
3583     break;
3584   case BuiltinType::UShort:
3585     TypeName = "__SVUint16_t";
3586     break;
3587   case BuiltinType::Int:
3588     TypeName = "__SVInt32_t";
3589     break;
3590   case BuiltinType::UInt:
3591     TypeName = "__SVUint32_t";
3592     break;
3593   case BuiltinType::Long:
3594     TypeName = "__SVInt64_t";
3595     break;
3596   case BuiltinType::ULong:
3597     TypeName = "__SVUint64_t";
3598     break;
3599   case BuiltinType::Half:
3600     TypeName = "__SVFloat16_t";
3601     break;
3602   case BuiltinType::Float:
3603     TypeName = "__SVFloat32_t";
3604     break;
3605   case BuiltinType::Double:
3606     TypeName = "__SVFloat64_t";
3607     break;
3608   case BuiltinType::BFloat16:
3609     TypeName = "__SVBfloat16_t";
3610     break;
3611   default:
3612     llvm_unreachable("unexpected element type for fixed-length SVE vector!");
3613   }
3614 
3615   unsigned VecSizeInBits = getASTContext().getTypeInfo(T).Width;
3616 
3617   if (T->getVectorKind() == VectorType::SveFixedLengthPredicateVector)
3618     VecSizeInBits *= 8;
3619 
3620   Out << "9__SVE_VLSI" << 'u' << TypeName.size() << TypeName << "Lj"
3621       << VecSizeInBits << "EE";
3622 }
3623 
3624 void CXXNameMangler::mangleAArch64FixedSveVectorType(
3625     const DependentVectorType *T) {
3626   DiagnosticsEngine &Diags = Context.getDiags();
3627   unsigned DiagID = Diags.getCustomDiagID(
3628       DiagnosticsEngine::Error,
3629       "cannot mangle this dependent fixed-length SVE vector type yet");
3630   Diags.Report(T->getAttributeLoc(), DiagID);
3631 }
3632 
3633 // GNU extension: vector types
3634 // <type>                  ::= <vector-type>
3635 // <vector-type>           ::= Dv <positive dimension number> _
3636 //                                    <extended element type>
3637 //                         ::= Dv [<dimension expression>] _ <element type>
3638 // <extended element type> ::= <element type>
3639 //                         ::= p # AltiVec vector pixel
3640 //                         ::= b # Altivec vector bool
3641 void CXXNameMangler::mangleType(const VectorType *T) {
3642   if ((T->getVectorKind() == VectorType::NeonVector ||
3643        T->getVectorKind() == VectorType::NeonPolyVector)) {
3644     llvm::Triple Target = getASTContext().getTargetInfo().getTriple();
3645     llvm::Triple::ArchType Arch =
3646         getASTContext().getTargetInfo().getTriple().getArch();
3647     if ((Arch == llvm::Triple::aarch64 ||
3648          Arch == llvm::Triple::aarch64_be) && !Target.isOSDarwin())
3649       mangleAArch64NeonVectorType(T);
3650     else
3651       mangleNeonVectorType(T);
3652     return;
3653   } else if (T->getVectorKind() == VectorType::SveFixedLengthDataVector ||
3654              T->getVectorKind() == VectorType::SveFixedLengthPredicateVector) {
3655     mangleAArch64FixedSveVectorType(T);
3656     return;
3657   }
3658   Out << "Dv" << T->getNumElements() << '_';
3659   if (T->getVectorKind() == VectorType::AltiVecPixel)
3660     Out << 'p';
3661   else if (T->getVectorKind() == VectorType::AltiVecBool)
3662     Out << 'b';
3663   else
3664     mangleType(T->getElementType());
3665 }
3666 
3667 void CXXNameMangler::mangleType(const DependentVectorType *T) {
3668   if ((T->getVectorKind() == VectorType::NeonVector ||
3669        T->getVectorKind() == VectorType::NeonPolyVector)) {
3670     llvm::Triple Target = getASTContext().getTargetInfo().getTriple();
3671     llvm::Triple::ArchType Arch =
3672         getASTContext().getTargetInfo().getTriple().getArch();
3673     if ((Arch == llvm::Triple::aarch64 || Arch == llvm::Triple::aarch64_be) &&
3674         !Target.isOSDarwin())
3675       mangleAArch64NeonVectorType(T);
3676     else
3677       mangleNeonVectorType(T);
3678     return;
3679   } else if (T->getVectorKind() == VectorType::SveFixedLengthDataVector ||
3680              T->getVectorKind() == VectorType::SveFixedLengthPredicateVector) {
3681     mangleAArch64FixedSveVectorType(T);
3682     return;
3683   }
3684 
3685   Out << "Dv";
3686   mangleExpression(T->getSizeExpr());
3687   Out << '_';
3688   if (T->getVectorKind() == VectorType::AltiVecPixel)
3689     Out << 'p';
3690   else if (T->getVectorKind() == VectorType::AltiVecBool)
3691     Out << 'b';
3692   else
3693     mangleType(T->getElementType());
3694 }
3695 
3696 void CXXNameMangler::mangleType(const ExtVectorType *T) {
3697   mangleType(static_cast<const VectorType*>(T));
3698 }
3699 void CXXNameMangler::mangleType(const DependentSizedExtVectorType *T) {
3700   Out << "Dv";
3701   mangleExpression(T->getSizeExpr());
3702   Out << '_';
3703   mangleType(T->getElementType());
3704 }
3705 
3706 void CXXNameMangler::mangleType(const ConstantMatrixType *T) {
3707   // Mangle matrix types as a vendor extended type:
3708   // u<Len>matrix_typeI<Rows><Columns><element type>E
3709 
3710   StringRef VendorQualifier = "matrix_type";
3711   Out << "u" << VendorQualifier.size() << VendorQualifier;
3712 
3713   Out << "I";
3714   auto &ASTCtx = getASTContext();
3715   unsigned BitWidth = ASTCtx.getTypeSize(ASTCtx.getSizeType());
3716   llvm::APSInt Rows(BitWidth);
3717   Rows = T->getNumRows();
3718   mangleIntegerLiteral(ASTCtx.getSizeType(), Rows);
3719   llvm::APSInt Columns(BitWidth);
3720   Columns = T->getNumColumns();
3721   mangleIntegerLiteral(ASTCtx.getSizeType(), Columns);
3722   mangleType(T->getElementType());
3723   Out << "E";
3724 }
3725 
3726 void CXXNameMangler::mangleType(const DependentSizedMatrixType *T) {
3727   // Mangle matrix types as a vendor extended type:
3728   // u<Len>matrix_typeI<row expr><column expr><element type>E
3729   StringRef VendorQualifier = "matrix_type";
3730   Out << "u" << VendorQualifier.size() << VendorQualifier;
3731 
3732   Out << "I";
3733   mangleTemplateArgExpr(T->getRowExpr());
3734   mangleTemplateArgExpr(T->getColumnExpr());
3735   mangleType(T->getElementType());
3736   Out << "E";
3737 }
3738 
3739 void CXXNameMangler::mangleType(const DependentAddressSpaceType *T) {
3740   SplitQualType split = T->getPointeeType().split();
3741   mangleQualifiers(split.Quals, T);
3742   mangleType(QualType(split.Ty, 0));
3743 }
3744 
3745 void CXXNameMangler::mangleType(const PackExpansionType *T) {
3746   // <type>  ::= Dp <type>          # pack expansion (C++0x)
3747   Out << "Dp";
3748   mangleType(T->getPattern());
3749 }
3750 
3751 void CXXNameMangler::mangleType(const ObjCInterfaceType *T) {
3752   mangleSourceName(T->getDecl()->getIdentifier());
3753 }
3754 
3755 void CXXNameMangler::mangleType(const ObjCObjectType *T) {
3756   // Treat __kindof as a vendor extended type qualifier.
3757   if (T->isKindOfType())
3758     Out << "U8__kindof";
3759 
3760   if (!T->qual_empty()) {
3761     // Mangle protocol qualifiers.
3762     SmallString<64> QualStr;
3763     llvm::raw_svector_ostream QualOS(QualStr);
3764     QualOS << "objcproto";
3765     for (const auto *I : T->quals()) {
3766       StringRef name = I->getName();
3767       QualOS << name.size() << name;
3768     }
3769     Out << 'U' << QualStr.size() << QualStr;
3770   }
3771 
3772   mangleType(T->getBaseType());
3773 
3774   if (T->isSpecialized()) {
3775     // Mangle type arguments as I <type>+ E
3776     Out << 'I';
3777     for (auto typeArg : T->getTypeArgs())
3778       mangleType(typeArg);
3779     Out << 'E';
3780   }
3781 }
3782 
3783 void CXXNameMangler::mangleType(const BlockPointerType *T) {
3784   Out << "U13block_pointer";
3785   mangleType(T->getPointeeType());
3786 }
3787 
3788 void CXXNameMangler::mangleType(const InjectedClassNameType *T) {
3789   // Mangle injected class name types as if the user had written the
3790   // specialization out fully.  It may not actually be possible to see
3791   // this mangling, though.
3792   mangleType(T->getInjectedSpecializationType());
3793 }
3794 
3795 void CXXNameMangler::mangleType(const TemplateSpecializationType *T) {
3796   if (TemplateDecl *TD = T->getTemplateName().getAsTemplateDecl()) {
3797     mangleTemplateName(TD, T->getArgs(), T->getNumArgs());
3798   } else {
3799     if (mangleSubstitution(QualType(T, 0)))
3800       return;
3801 
3802     mangleTemplatePrefix(T->getTemplateName());
3803 
3804     // FIXME: GCC does not appear to mangle the template arguments when
3805     // the template in question is a dependent template name. Should we
3806     // emulate that badness?
3807     mangleTemplateArgs(T->getTemplateName(), T->getArgs(), T->getNumArgs());
3808     addSubstitution(QualType(T, 0));
3809   }
3810 }
3811 
3812 void CXXNameMangler::mangleType(const DependentNameType *T) {
3813   // Proposal by cxx-abi-dev, 2014-03-26
3814   // <class-enum-type> ::= <name>    # non-dependent or dependent type name or
3815   //                                 # dependent elaborated type specifier using
3816   //                                 # 'typename'
3817   //                   ::= Ts <name> # dependent elaborated type specifier using
3818   //                                 # 'struct' or 'class'
3819   //                   ::= Tu <name> # dependent elaborated type specifier using
3820   //                                 # 'union'
3821   //                   ::= Te <name> # dependent elaborated type specifier using
3822   //                                 # 'enum'
3823   switch (T->getKeyword()) {
3824     case ETK_None:
3825     case ETK_Typename:
3826       break;
3827     case ETK_Struct:
3828     case ETK_Class:
3829     case ETK_Interface:
3830       Out << "Ts";
3831       break;
3832     case ETK_Union:
3833       Out << "Tu";
3834       break;
3835     case ETK_Enum:
3836       Out << "Te";
3837       break;
3838   }
3839   // Typename types are always nested
3840   Out << 'N';
3841   manglePrefix(T->getQualifier());
3842   mangleSourceName(T->getIdentifier());
3843   Out << 'E';
3844 }
3845 
3846 void CXXNameMangler::mangleType(const DependentTemplateSpecializationType *T) {
3847   // Dependently-scoped template types are nested if they have a prefix.
3848   Out << 'N';
3849 
3850   // TODO: avoid making this TemplateName.
3851   TemplateName Prefix =
3852     getASTContext().getDependentTemplateName(T->getQualifier(),
3853                                              T->getIdentifier());
3854   mangleTemplatePrefix(Prefix);
3855 
3856   // FIXME: GCC does not appear to mangle the template arguments when
3857   // the template in question is a dependent template name. Should we
3858   // emulate that badness?
3859   mangleTemplateArgs(Prefix, T->getArgs(), T->getNumArgs());
3860   Out << 'E';
3861 }
3862 
3863 void CXXNameMangler::mangleType(const TypeOfType *T) {
3864   // FIXME: this is pretty unsatisfactory, but there isn't an obvious
3865   // "extension with parameters" mangling.
3866   Out << "u6typeof";
3867 }
3868 
3869 void CXXNameMangler::mangleType(const TypeOfExprType *T) {
3870   // FIXME: this is pretty unsatisfactory, but there isn't an obvious
3871   // "extension with parameters" mangling.
3872   Out << "u6typeof";
3873 }
3874 
3875 void CXXNameMangler::mangleType(const DecltypeType *T) {
3876   Expr *E = T->getUnderlyingExpr();
3877 
3878   // type ::= Dt <expression> E  # decltype of an id-expression
3879   //                             #   or class member access
3880   //      ::= DT <expression> E  # decltype of an expression
3881 
3882   // This purports to be an exhaustive list of id-expressions and
3883   // class member accesses.  Note that we do not ignore parentheses;
3884   // parentheses change the semantics of decltype for these
3885   // expressions (and cause the mangler to use the other form).
3886   if (isa<DeclRefExpr>(E) ||
3887       isa<MemberExpr>(E) ||
3888       isa<UnresolvedLookupExpr>(E) ||
3889       isa<DependentScopeDeclRefExpr>(E) ||
3890       isa<CXXDependentScopeMemberExpr>(E) ||
3891       isa<UnresolvedMemberExpr>(E))
3892     Out << "Dt";
3893   else
3894     Out << "DT";
3895   mangleExpression(E);
3896   Out << 'E';
3897 }
3898 
3899 void CXXNameMangler::mangleType(const UnaryTransformType *T) {
3900   // If this is dependent, we need to record that. If not, we simply
3901   // mangle it as the underlying type since they are equivalent.
3902   if (T->isDependentType()) {
3903     Out << 'U';
3904 
3905     switch (T->getUTTKind()) {
3906       case UnaryTransformType::EnumUnderlyingType:
3907         Out << "3eut";
3908         break;
3909     }
3910   }
3911 
3912   mangleType(T->getBaseType());
3913 }
3914 
3915 void CXXNameMangler::mangleType(const AutoType *T) {
3916   assert(T->getDeducedType().isNull() &&
3917          "Deduced AutoType shouldn't be handled here!");
3918   assert(T->getKeyword() != AutoTypeKeyword::GNUAutoType &&
3919          "shouldn't need to mangle __auto_type!");
3920   // <builtin-type> ::= Da # auto
3921   //                ::= Dc # decltype(auto)
3922   Out << (T->isDecltypeAuto() ? "Dc" : "Da");
3923 }
3924 
3925 void CXXNameMangler::mangleType(const DeducedTemplateSpecializationType *T) {
3926   QualType Deduced = T->getDeducedType();
3927   if (!Deduced.isNull())
3928     return mangleType(Deduced);
3929 
3930   TemplateDecl *TD = T->getTemplateName().getAsTemplateDecl();
3931   assert(TD && "shouldn't form deduced TST unless we know we have a template");
3932 
3933   if (mangleSubstitution(TD))
3934     return;
3935 
3936   mangleName(GlobalDecl(TD));
3937   addSubstitution(TD);
3938 }
3939 
3940 void CXXNameMangler::mangleType(const AtomicType *T) {
3941   // <type> ::= U <source-name> <type>  # vendor extended type qualifier
3942   // (Until there's a standardized mangling...)
3943   Out << "U7_Atomic";
3944   mangleType(T->getValueType());
3945 }
3946 
3947 void CXXNameMangler::mangleType(const PipeType *T) {
3948   // Pipe type mangling rules are described in SPIR 2.0 specification
3949   // A.1 Data types and A.3 Summary of changes
3950   // <type> ::= 8ocl_pipe
3951   Out << "8ocl_pipe";
3952 }
3953 
3954 void CXXNameMangler::mangleType(const ExtIntType *T) {
3955   Out << "U7_ExtInt";
3956   llvm::APSInt BW(32, true);
3957   BW = T->getNumBits();
3958   TemplateArgument TA(Context.getASTContext(), BW, getASTContext().IntTy);
3959   mangleTemplateArgs(TemplateName(), &TA, 1);
3960   if (T->isUnsigned())
3961     Out << "j";
3962   else
3963     Out << "i";
3964 }
3965 
3966 void CXXNameMangler::mangleType(const DependentExtIntType *T) {
3967   Out << "U7_ExtInt";
3968   TemplateArgument TA(T->getNumBitsExpr());
3969   mangleTemplateArgs(TemplateName(), &TA, 1);
3970   if (T->isUnsigned())
3971     Out << "j";
3972   else
3973     Out << "i";
3974 }
3975 
3976 void CXXNameMangler::mangleIntegerLiteral(QualType T,
3977                                           const llvm::APSInt &Value) {
3978   //  <expr-primary> ::= L <type> <value number> E # integer literal
3979   Out << 'L';
3980 
3981   mangleType(T);
3982   if (T->isBooleanType()) {
3983     // Boolean values are encoded as 0/1.
3984     Out << (Value.getBoolValue() ? '1' : '0');
3985   } else {
3986     mangleNumber(Value);
3987   }
3988   Out << 'E';
3989 
3990 }
3991 
3992 void CXXNameMangler::mangleMemberExprBase(const Expr *Base, bool IsArrow) {
3993   // Ignore member expressions involving anonymous unions.
3994   while (const auto *RT = Base->getType()->getAs<RecordType>()) {
3995     if (!RT->getDecl()->isAnonymousStructOrUnion())
3996       break;
3997     const auto *ME = dyn_cast<MemberExpr>(Base);
3998     if (!ME)
3999       break;
4000     Base = ME->getBase();
4001     IsArrow = ME->isArrow();
4002   }
4003 
4004   if (Base->isImplicitCXXThis()) {
4005     // Note: GCC mangles member expressions to the implicit 'this' as
4006     // *this., whereas we represent them as this->. The Itanium C++ ABI
4007     // does not specify anything here, so we follow GCC.
4008     Out << "dtdefpT";
4009   } else {
4010     Out << (IsArrow ? "pt" : "dt");
4011     mangleExpression(Base);
4012   }
4013 }
4014 
4015 /// Mangles a member expression.
4016 void CXXNameMangler::mangleMemberExpr(const Expr *base,
4017                                       bool isArrow,
4018                                       NestedNameSpecifier *qualifier,
4019                                       NamedDecl *firstQualifierLookup,
4020                                       DeclarationName member,
4021                                       const TemplateArgumentLoc *TemplateArgs,
4022                                       unsigned NumTemplateArgs,
4023                                       unsigned arity) {
4024   // <expression> ::= dt <expression> <unresolved-name>
4025   //              ::= pt <expression> <unresolved-name>
4026   if (base)
4027     mangleMemberExprBase(base, isArrow);
4028   mangleUnresolvedName(qualifier, member, TemplateArgs, NumTemplateArgs, arity);
4029 }
4030 
4031 /// Look at the callee of the given call expression and determine if
4032 /// it's a parenthesized id-expression which would have triggered ADL
4033 /// otherwise.
4034 static bool isParenthesizedADLCallee(const CallExpr *call) {
4035   const Expr *callee = call->getCallee();
4036   const Expr *fn = callee->IgnoreParens();
4037 
4038   // Must be parenthesized.  IgnoreParens() skips __extension__ nodes,
4039   // too, but for those to appear in the callee, it would have to be
4040   // parenthesized.
4041   if (callee == fn) return false;
4042 
4043   // Must be an unresolved lookup.
4044   const UnresolvedLookupExpr *lookup = dyn_cast<UnresolvedLookupExpr>(fn);
4045   if (!lookup) return false;
4046 
4047   assert(!lookup->requiresADL());
4048 
4049   // Must be an unqualified lookup.
4050   if (lookup->getQualifier()) return false;
4051 
4052   // Must not have found a class member.  Note that if one is a class
4053   // member, they're all class members.
4054   if (lookup->getNumDecls() > 0 &&
4055       (*lookup->decls_begin())->isCXXClassMember())
4056     return false;
4057 
4058   // Otherwise, ADL would have been triggered.
4059   return true;
4060 }
4061 
4062 void CXXNameMangler::mangleCastExpression(const Expr *E, StringRef CastEncoding) {
4063   const ExplicitCastExpr *ECE = cast<ExplicitCastExpr>(E);
4064   Out << CastEncoding;
4065   mangleType(ECE->getType());
4066   mangleExpression(ECE->getSubExpr());
4067 }
4068 
4069 void CXXNameMangler::mangleInitListElements(const InitListExpr *InitList) {
4070   if (auto *Syntactic = InitList->getSyntacticForm())
4071     InitList = Syntactic;
4072   for (unsigned i = 0, e = InitList->getNumInits(); i != e; ++i)
4073     mangleExpression(InitList->getInit(i));
4074 }
4075 
4076 void CXXNameMangler::mangleExpression(const Expr *E, unsigned Arity,
4077                                       bool AsTemplateArg) {
4078   // <expression> ::= <unary operator-name> <expression>
4079   //              ::= <binary operator-name> <expression> <expression>
4080   //              ::= <trinary operator-name> <expression> <expression> <expression>
4081   //              ::= cv <type> expression           # conversion with one argument
4082   //              ::= cv <type> _ <expression>* E # conversion with a different number of arguments
4083   //              ::= dc <type> <expression>         # dynamic_cast<type> (expression)
4084   //              ::= sc <type> <expression>         # static_cast<type> (expression)
4085   //              ::= cc <type> <expression>         # const_cast<type> (expression)
4086   //              ::= rc <type> <expression>         # reinterpret_cast<type> (expression)
4087   //              ::= st <type>                      # sizeof (a type)
4088   //              ::= at <type>                      # alignof (a type)
4089   //              ::= <template-param>
4090   //              ::= <function-param>
4091   //              ::= fpT                            # 'this' expression (part of <function-param>)
4092   //              ::= sr <type> <unqualified-name>                   # dependent name
4093   //              ::= sr <type> <unqualified-name> <template-args>   # dependent template-id
4094   //              ::= ds <expression> <expression>                   # expr.*expr
4095   //              ::= sZ <template-param>                            # size of a parameter pack
4096   //              ::= sZ <function-param>    # size of a function parameter pack
4097   //              ::= u <source-name> <template-arg>* E # vendor extended expression
4098   //              ::= <expr-primary>
4099   // <expr-primary> ::= L <type> <value number> E    # integer literal
4100   //                ::= L <type> <value float> E     # floating literal
4101   //                ::= L <type> <string type> E     # string literal
4102   //                ::= L <nullptr type> E           # nullptr literal "LDnE"
4103   //                ::= L <pointer type> 0 E         # null pointer template argument
4104   //                ::= L <type> <real-part float> _ <imag-part float> E    # complex floating point literal (C99); not used by clang
4105   //                ::= L <mangled-name> E           # external name
4106   QualType ImplicitlyConvertedToType;
4107 
4108   // A top-level expression that's not <expr-primary> needs to be wrapped in
4109   // X...E in a template arg.
4110   bool IsPrimaryExpr = true;
4111   auto NotPrimaryExpr = [&] {
4112     if (AsTemplateArg && IsPrimaryExpr)
4113       Out << 'X';
4114     IsPrimaryExpr = false;
4115   };
4116 
4117   auto MangleDeclRefExpr = [&](const NamedDecl *D) {
4118     switch (D->getKind()) {
4119     default:
4120       //  <expr-primary> ::= L <mangled-name> E # external name
4121       Out << 'L';
4122       mangle(D);
4123       Out << 'E';
4124       break;
4125 
4126     case Decl::ParmVar:
4127       NotPrimaryExpr();
4128       mangleFunctionParam(cast<ParmVarDecl>(D));
4129       break;
4130 
4131     case Decl::EnumConstant: {
4132       // <expr-primary>
4133       const EnumConstantDecl *ED = cast<EnumConstantDecl>(D);
4134       mangleIntegerLiteral(ED->getType(), ED->getInitVal());
4135       break;
4136     }
4137 
4138     case Decl::NonTypeTemplateParm:
4139       NotPrimaryExpr();
4140       const NonTypeTemplateParmDecl *PD = cast<NonTypeTemplateParmDecl>(D);
4141       mangleTemplateParameter(PD->getDepth(), PD->getIndex());
4142       break;
4143     }
4144   };
4145 
4146   // 'goto recurse' is used when handling a simple "unwrapping" node which
4147   // produces no output, where ImplicitlyConvertedToType and AsTemplateArg need
4148   // to be preserved.
4149 recurse:
4150   switch (E->getStmtClass()) {
4151   case Expr::NoStmtClass:
4152 #define ABSTRACT_STMT(Type)
4153 #define EXPR(Type, Base)
4154 #define STMT(Type, Base) \
4155   case Expr::Type##Class:
4156 #include "clang/AST/StmtNodes.inc"
4157     // fallthrough
4158 
4159   // These all can only appear in local or variable-initialization
4160   // contexts and so should never appear in a mangling.
4161   case Expr::AddrLabelExprClass:
4162   case Expr::DesignatedInitUpdateExprClass:
4163   case Expr::ImplicitValueInitExprClass:
4164   case Expr::ArrayInitLoopExprClass:
4165   case Expr::ArrayInitIndexExprClass:
4166   case Expr::NoInitExprClass:
4167   case Expr::ParenListExprClass:
4168   case Expr::LambdaExprClass:
4169   case Expr::MSPropertyRefExprClass:
4170   case Expr::MSPropertySubscriptExprClass:
4171   case Expr::TypoExprClass: // This should no longer exist in the AST by now.
4172   case Expr::RecoveryExprClass:
4173   case Expr::OMPArraySectionExprClass:
4174   case Expr::OMPArrayShapingExprClass:
4175   case Expr::OMPIteratorExprClass:
4176   case Expr::CXXInheritedCtorInitExprClass:
4177     llvm_unreachable("unexpected statement kind");
4178 
4179   case Expr::ConstantExprClass:
4180     E = cast<ConstantExpr>(E)->getSubExpr();
4181     goto recurse;
4182 
4183   // FIXME: invent manglings for all these.
4184   case Expr::BlockExprClass:
4185   case Expr::ChooseExprClass:
4186   case Expr::CompoundLiteralExprClass:
4187   case Expr::ExtVectorElementExprClass:
4188   case Expr::GenericSelectionExprClass:
4189   case Expr::ObjCEncodeExprClass:
4190   case Expr::ObjCIsaExprClass:
4191   case Expr::ObjCIvarRefExprClass:
4192   case Expr::ObjCMessageExprClass:
4193   case Expr::ObjCPropertyRefExprClass:
4194   case Expr::ObjCProtocolExprClass:
4195   case Expr::ObjCSelectorExprClass:
4196   case Expr::ObjCStringLiteralClass:
4197   case Expr::ObjCBoxedExprClass:
4198   case Expr::ObjCArrayLiteralClass:
4199   case Expr::ObjCDictionaryLiteralClass:
4200   case Expr::ObjCSubscriptRefExprClass:
4201   case Expr::ObjCIndirectCopyRestoreExprClass:
4202   case Expr::ObjCAvailabilityCheckExprClass:
4203   case Expr::OffsetOfExprClass:
4204   case Expr::PredefinedExprClass:
4205   case Expr::ShuffleVectorExprClass:
4206   case Expr::ConvertVectorExprClass:
4207   case Expr::StmtExprClass:
4208   case Expr::TypeTraitExprClass:
4209   case Expr::RequiresExprClass:
4210   case Expr::ArrayTypeTraitExprClass:
4211   case Expr::ExpressionTraitExprClass:
4212   case Expr::VAArgExprClass:
4213   case Expr::CUDAKernelCallExprClass:
4214   case Expr::AsTypeExprClass:
4215   case Expr::PseudoObjectExprClass:
4216   case Expr::AtomicExprClass:
4217   case Expr::SourceLocExprClass:
4218   case Expr::BuiltinBitCastExprClass:
4219   {
4220     NotPrimaryExpr();
4221     if (!NullOut) {
4222       // As bad as this diagnostic is, it's better than crashing.
4223       DiagnosticsEngine &Diags = Context.getDiags();
4224       unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
4225                                        "cannot yet mangle expression type %0");
4226       Diags.Report(E->getExprLoc(), DiagID)
4227         << E->getStmtClassName() << E->getSourceRange();
4228       return;
4229     }
4230     break;
4231   }
4232 
4233   case Expr::CXXUuidofExprClass: {
4234     NotPrimaryExpr();
4235     const CXXUuidofExpr *UE = cast<CXXUuidofExpr>(E);
4236     // As of clang 12, uuidof uses the vendor extended expression
4237     // mangling. Previously, it used a special-cased nonstandard extension.
4238     if (Context.getASTContext().getLangOpts().getClangABICompat() >
4239         LangOptions::ClangABI::Ver11) {
4240       Out << "u8__uuidof";
4241       if (UE->isTypeOperand())
4242         mangleType(UE->getTypeOperand(Context.getASTContext()));
4243       else
4244         mangleTemplateArgExpr(UE->getExprOperand());
4245       Out << 'E';
4246     } else {
4247       if (UE->isTypeOperand()) {
4248         QualType UuidT = UE->getTypeOperand(Context.getASTContext());
4249         Out << "u8__uuidoft";
4250         mangleType(UuidT);
4251       } else {
4252         Expr *UuidExp = UE->getExprOperand();
4253         Out << "u8__uuidofz";
4254         mangleExpression(UuidExp);
4255       }
4256     }
4257     break;
4258   }
4259 
4260   // Even gcc-4.5 doesn't mangle this.
4261   case Expr::BinaryConditionalOperatorClass: {
4262     NotPrimaryExpr();
4263     DiagnosticsEngine &Diags = Context.getDiags();
4264     unsigned DiagID =
4265       Diags.getCustomDiagID(DiagnosticsEngine::Error,
4266                 "?: operator with omitted middle operand cannot be mangled");
4267     Diags.Report(E->getExprLoc(), DiagID)
4268       << E->getStmtClassName() << E->getSourceRange();
4269     return;
4270   }
4271 
4272   // These are used for internal purposes and cannot be meaningfully mangled.
4273   case Expr::OpaqueValueExprClass:
4274     llvm_unreachable("cannot mangle opaque value; mangling wrong thing?");
4275 
4276   case Expr::InitListExprClass: {
4277     NotPrimaryExpr();
4278     Out << "il";
4279     mangleInitListElements(cast<InitListExpr>(E));
4280     Out << "E";
4281     break;
4282   }
4283 
4284   case Expr::DesignatedInitExprClass: {
4285     NotPrimaryExpr();
4286     auto *DIE = cast<DesignatedInitExpr>(E);
4287     for (const auto &Designator : DIE->designators()) {
4288       if (Designator.isFieldDesignator()) {
4289         Out << "di";
4290         mangleSourceName(Designator.getFieldName());
4291       } else if (Designator.isArrayDesignator()) {
4292         Out << "dx";
4293         mangleExpression(DIE->getArrayIndex(Designator));
4294       } else {
4295         assert(Designator.isArrayRangeDesignator() &&
4296                "unknown designator kind");
4297         Out << "dX";
4298         mangleExpression(DIE->getArrayRangeStart(Designator));
4299         mangleExpression(DIE->getArrayRangeEnd(Designator));
4300       }
4301     }
4302     mangleExpression(DIE->getInit());
4303     break;
4304   }
4305 
4306   case Expr::CXXDefaultArgExprClass:
4307     E = cast<CXXDefaultArgExpr>(E)->getExpr();
4308     goto recurse;
4309 
4310   case Expr::CXXDefaultInitExprClass:
4311     E = cast<CXXDefaultInitExpr>(E)->getExpr();
4312     goto recurse;
4313 
4314   case Expr::CXXStdInitializerListExprClass:
4315     E = cast<CXXStdInitializerListExpr>(E)->getSubExpr();
4316     goto recurse;
4317 
4318   case Expr::SubstNonTypeTemplateParmExprClass:
4319     E = cast<SubstNonTypeTemplateParmExpr>(E)->getReplacement();
4320     goto recurse;
4321 
4322   case Expr::UserDefinedLiteralClass:
4323     // We follow g++'s approach of mangling a UDL as a call to the literal
4324     // operator.
4325   case Expr::CXXMemberCallExprClass: // fallthrough
4326   case Expr::CallExprClass: {
4327     NotPrimaryExpr();
4328     const CallExpr *CE = cast<CallExpr>(E);
4329 
4330     // <expression> ::= cp <simple-id> <expression>* E
4331     // We use this mangling only when the call would use ADL except
4332     // for being parenthesized.  Per discussion with David
4333     // Vandervoorde, 2011.04.25.
4334     if (isParenthesizedADLCallee(CE)) {
4335       Out << "cp";
4336       // The callee here is a parenthesized UnresolvedLookupExpr with
4337       // no qualifier and should always get mangled as a <simple-id>
4338       // anyway.
4339 
4340     // <expression> ::= cl <expression>* E
4341     } else {
4342       Out << "cl";
4343     }
4344 
4345     unsigned CallArity = CE->getNumArgs();
4346     for (const Expr *Arg : CE->arguments())
4347       if (isa<PackExpansionExpr>(Arg))
4348         CallArity = UnknownArity;
4349 
4350     mangleExpression(CE->getCallee(), CallArity);
4351     for (const Expr *Arg : CE->arguments())
4352       mangleExpression(Arg);
4353     Out << 'E';
4354     break;
4355   }
4356 
4357   case Expr::CXXNewExprClass: {
4358     NotPrimaryExpr();
4359     const CXXNewExpr *New = cast<CXXNewExpr>(E);
4360     if (New->isGlobalNew()) Out << "gs";
4361     Out << (New->isArray() ? "na" : "nw");
4362     for (CXXNewExpr::const_arg_iterator I = New->placement_arg_begin(),
4363            E = New->placement_arg_end(); I != E; ++I)
4364       mangleExpression(*I);
4365     Out << '_';
4366     mangleType(New->getAllocatedType());
4367     if (New->hasInitializer()) {
4368       if (New->getInitializationStyle() == CXXNewExpr::ListInit)
4369         Out << "il";
4370       else
4371         Out << "pi";
4372       const Expr *Init = New->getInitializer();
4373       if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(Init)) {
4374         // Directly inline the initializers.
4375         for (CXXConstructExpr::const_arg_iterator I = CCE->arg_begin(),
4376                                                   E = CCE->arg_end();
4377              I != E; ++I)
4378           mangleExpression(*I);
4379       } else if (const ParenListExpr *PLE = dyn_cast<ParenListExpr>(Init)) {
4380         for (unsigned i = 0, e = PLE->getNumExprs(); i != e; ++i)
4381           mangleExpression(PLE->getExpr(i));
4382       } else if (New->getInitializationStyle() == CXXNewExpr::ListInit &&
4383                  isa<InitListExpr>(Init)) {
4384         // Only take InitListExprs apart for list-initialization.
4385         mangleInitListElements(cast<InitListExpr>(Init));
4386       } else
4387         mangleExpression(Init);
4388     }
4389     Out << 'E';
4390     break;
4391   }
4392 
4393   case Expr::CXXPseudoDestructorExprClass: {
4394     NotPrimaryExpr();
4395     const auto *PDE = cast<CXXPseudoDestructorExpr>(E);
4396     if (const Expr *Base = PDE->getBase())
4397       mangleMemberExprBase(Base, PDE->isArrow());
4398     NestedNameSpecifier *Qualifier = PDE->getQualifier();
4399     if (TypeSourceInfo *ScopeInfo = PDE->getScopeTypeInfo()) {
4400       if (Qualifier) {
4401         mangleUnresolvedPrefix(Qualifier,
4402                                /*recursive=*/true);
4403         mangleUnresolvedTypeOrSimpleId(ScopeInfo->getType());
4404         Out << 'E';
4405       } else {
4406         Out << "sr";
4407         if (!mangleUnresolvedTypeOrSimpleId(ScopeInfo->getType()))
4408           Out << 'E';
4409       }
4410     } else if (Qualifier) {
4411       mangleUnresolvedPrefix(Qualifier);
4412     }
4413     // <base-unresolved-name> ::= dn <destructor-name>
4414     Out << "dn";
4415     QualType DestroyedType = PDE->getDestroyedType();
4416     mangleUnresolvedTypeOrSimpleId(DestroyedType);
4417     break;
4418   }
4419 
4420   case Expr::MemberExprClass: {
4421     NotPrimaryExpr();
4422     const MemberExpr *ME = cast<MemberExpr>(E);
4423     mangleMemberExpr(ME->getBase(), ME->isArrow(),
4424                      ME->getQualifier(), nullptr,
4425                      ME->getMemberDecl()->getDeclName(),
4426                      ME->getTemplateArgs(), ME->getNumTemplateArgs(),
4427                      Arity);
4428     break;
4429   }
4430 
4431   case Expr::UnresolvedMemberExprClass: {
4432     NotPrimaryExpr();
4433     const UnresolvedMemberExpr *ME = cast<UnresolvedMemberExpr>(E);
4434     mangleMemberExpr(ME->isImplicitAccess() ? nullptr : ME->getBase(),
4435                      ME->isArrow(), ME->getQualifier(), nullptr,
4436                      ME->getMemberName(),
4437                      ME->getTemplateArgs(), ME->getNumTemplateArgs(),
4438                      Arity);
4439     break;
4440   }
4441 
4442   case Expr::CXXDependentScopeMemberExprClass: {
4443     NotPrimaryExpr();
4444     const CXXDependentScopeMemberExpr *ME
4445       = cast<CXXDependentScopeMemberExpr>(E);
4446     mangleMemberExpr(ME->isImplicitAccess() ? nullptr : ME->getBase(),
4447                      ME->isArrow(), ME->getQualifier(),
4448                      ME->getFirstQualifierFoundInScope(),
4449                      ME->getMember(),
4450                      ME->getTemplateArgs(), ME->getNumTemplateArgs(),
4451                      Arity);
4452     break;
4453   }
4454 
4455   case Expr::UnresolvedLookupExprClass: {
4456     NotPrimaryExpr();
4457     const UnresolvedLookupExpr *ULE = cast<UnresolvedLookupExpr>(E);
4458     mangleUnresolvedName(ULE->getQualifier(), ULE->getName(),
4459                          ULE->getTemplateArgs(), ULE->getNumTemplateArgs(),
4460                          Arity);
4461     break;
4462   }
4463 
4464   case Expr::CXXUnresolvedConstructExprClass: {
4465     NotPrimaryExpr();
4466     const CXXUnresolvedConstructExpr *CE = cast<CXXUnresolvedConstructExpr>(E);
4467     unsigned N = CE->getNumArgs();
4468 
4469     if (CE->isListInitialization()) {
4470       assert(N == 1 && "unexpected form for list initialization");
4471       auto *IL = cast<InitListExpr>(CE->getArg(0));
4472       Out << "tl";
4473       mangleType(CE->getType());
4474       mangleInitListElements(IL);
4475       Out << "E";
4476       break;
4477     }
4478 
4479     Out << "cv";
4480     mangleType(CE->getType());
4481     if (N != 1) Out << '_';
4482     for (unsigned I = 0; I != N; ++I) mangleExpression(CE->getArg(I));
4483     if (N != 1) Out << 'E';
4484     break;
4485   }
4486 
4487   case Expr::CXXConstructExprClass: {
4488     // An implicit cast is silent, thus may contain <expr-primary>.
4489     const auto *CE = cast<CXXConstructExpr>(E);
4490     if (!CE->isListInitialization() || CE->isStdInitListInitialization()) {
4491       assert(
4492           CE->getNumArgs() >= 1 &&
4493           (CE->getNumArgs() == 1 || isa<CXXDefaultArgExpr>(CE->getArg(1))) &&
4494           "implicit CXXConstructExpr must have one argument");
4495       E = cast<CXXConstructExpr>(E)->getArg(0);
4496       goto recurse;
4497     }
4498     NotPrimaryExpr();
4499     Out << "il";
4500     for (auto *E : CE->arguments())
4501       mangleExpression(E);
4502     Out << "E";
4503     break;
4504   }
4505 
4506   case Expr::CXXTemporaryObjectExprClass: {
4507     NotPrimaryExpr();
4508     const auto *CE = cast<CXXTemporaryObjectExpr>(E);
4509     unsigned N = CE->getNumArgs();
4510     bool List = CE->isListInitialization();
4511 
4512     if (List)
4513       Out << "tl";
4514     else
4515       Out << "cv";
4516     mangleType(CE->getType());
4517     if (!List && N != 1)
4518       Out << '_';
4519     if (CE->isStdInitListInitialization()) {
4520       // We implicitly created a std::initializer_list<T> for the first argument
4521       // of a constructor of type U in an expression of the form U{a, b, c}.
4522       // Strip all the semantic gunk off the initializer list.
4523       auto *SILE =
4524           cast<CXXStdInitializerListExpr>(CE->getArg(0)->IgnoreImplicit());
4525       auto *ILE = cast<InitListExpr>(SILE->getSubExpr()->IgnoreImplicit());
4526       mangleInitListElements(ILE);
4527     } else {
4528       for (auto *E : CE->arguments())
4529         mangleExpression(E);
4530     }
4531     if (List || N != 1)
4532       Out << 'E';
4533     break;
4534   }
4535 
4536   case Expr::CXXScalarValueInitExprClass:
4537     NotPrimaryExpr();
4538     Out << "cv";
4539     mangleType(E->getType());
4540     Out << "_E";
4541     break;
4542 
4543   case Expr::CXXNoexceptExprClass:
4544     NotPrimaryExpr();
4545     Out << "nx";
4546     mangleExpression(cast<CXXNoexceptExpr>(E)->getOperand());
4547     break;
4548 
4549   case Expr::UnaryExprOrTypeTraitExprClass: {
4550     // Non-instantiation-dependent traits are an <expr-primary> integer literal.
4551     const UnaryExprOrTypeTraitExpr *SAE = cast<UnaryExprOrTypeTraitExpr>(E);
4552 
4553     if (!SAE->isInstantiationDependent()) {
4554       // Itanium C++ ABI:
4555       //   If the operand of a sizeof or alignof operator is not
4556       //   instantiation-dependent it is encoded as an integer literal
4557       //   reflecting the result of the operator.
4558       //
4559       //   If the result of the operator is implicitly converted to a known
4560       //   integer type, that type is used for the literal; otherwise, the type
4561       //   of std::size_t or std::ptrdiff_t is used.
4562       QualType T = (ImplicitlyConvertedToType.isNull() ||
4563                     !ImplicitlyConvertedToType->isIntegerType())? SAE->getType()
4564                                                     : ImplicitlyConvertedToType;
4565       llvm::APSInt V = SAE->EvaluateKnownConstInt(Context.getASTContext());
4566       mangleIntegerLiteral(T, V);
4567       break;
4568     }
4569 
4570     NotPrimaryExpr(); // But otherwise, they are not.
4571 
4572     auto MangleAlignofSizeofArg = [&] {
4573       if (SAE->isArgumentType()) {
4574         Out << 't';
4575         mangleType(SAE->getArgumentType());
4576       } else {
4577         Out << 'z';
4578         mangleExpression(SAE->getArgumentExpr());
4579       }
4580     };
4581 
4582     switch(SAE->getKind()) {
4583     case UETT_SizeOf:
4584       Out << 's';
4585       MangleAlignofSizeofArg();
4586       break;
4587     case UETT_PreferredAlignOf:
4588       // As of clang 12, we mangle __alignof__ differently than alignof. (They
4589       // have acted differently since Clang 8, but were previously mangled the
4590       // same.)
4591       if (Context.getASTContext().getLangOpts().getClangABICompat() >
4592           LangOptions::ClangABI::Ver11) {
4593         Out << "u11__alignof__";
4594         if (SAE->isArgumentType())
4595           mangleType(SAE->getArgumentType());
4596         else
4597           mangleTemplateArgExpr(SAE->getArgumentExpr());
4598         Out << 'E';
4599         break;
4600       }
4601       LLVM_FALLTHROUGH;
4602     case UETT_AlignOf:
4603       Out << 'a';
4604       MangleAlignofSizeofArg();
4605       break;
4606     case UETT_VecStep: {
4607       DiagnosticsEngine &Diags = Context.getDiags();
4608       unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
4609                                      "cannot yet mangle vec_step expression");
4610       Diags.Report(DiagID);
4611       return;
4612     }
4613     case UETT_OpenMPRequiredSimdAlign: {
4614       DiagnosticsEngine &Diags = Context.getDiags();
4615       unsigned DiagID = Diags.getCustomDiagID(
4616           DiagnosticsEngine::Error,
4617           "cannot yet mangle __builtin_omp_required_simd_align expression");
4618       Diags.Report(DiagID);
4619       return;
4620     }
4621     }
4622     break;
4623   }
4624 
4625   case Expr::CXXThrowExprClass: {
4626     NotPrimaryExpr();
4627     const CXXThrowExpr *TE = cast<CXXThrowExpr>(E);
4628     //  <expression> ::= tw <expression>  # throw expression
4629     //               ::= tr               # rethrow
4630     if (TE->getSubExpr()) {
4631       Out << "tw";
4632       mangleExpression(TE->getSubExpr());
4633     } else {
4634       Out << "tr";
4635     }
4636     break;
4637   }
4638 
4639   case Expr::CXXTypeidExprClass: {
4640     NotPrimaryExpr();
4641     const CXXTypeidExpr *TIE = cast<CXXTypeidExpr>(E);
4642     //  <expression> ::= ti <type>        # typeid (type)
4643     //               ::= te <expression>  # typeid (expression)
4644     if (TIE->isTypeOperand()) {
4645       Out << "ti";
4646       mangleType(TIE->getTypeOperand(Context.getASTContext()));
4647     } else {
4648       Out << "te";
4649       mangleExpression(TIE->getExprOperand());
4650     }
4651     break;
4652   }
4653 
4654   case Expr::CXXDeleteExprClass: {
4655     NotPrimaryExpr();
4656     const CXXDeleteExpr *DE = cast<CXXDeleteExpr>(E);
4657     //  <expression> ::= [gs] dl <expression>  # [::] delete expr
4658     //               ::= [gs] da <expression>  # [::] delete [] expr
4659     if (DE->isGlobalDelete()) Out << "gs";
4660     Out << (DE->isArrayForm() ? "da" : "dl");
4661     mangleExpression(DE->getArgument());
4662     break;
4663   }
4664 
4665   case Expr::UnaryOperatorClass: {
4666     NotPrimaryExpr();
4667     const UnaryOperator *UO = cast<UnaryOperator>(E);
4668     mangleOperatorName(UnaryOperator::getOverloadedOperator(UO->getOpcode()),
4669                        /*Arity=*/1);
4670     mangleExpression(UO->getSubExpr());
4671     break;
4672   }
4673 
4674   case Expr::ArraySubscriptExprClass: {
4675     NotPrimaryExpr();
4676     const ArraySubscriptExpr *AE = cast<ArraySubscriptExpr>(E);
4677 
4678     // Array subscript is treated as a syntactically weird form of
4679     // binary operator.
4680     Out << "ix";
4681     mangleExpression(AE->getLHS());
4682     mangleExpression(AE->getRHS());
4683     break;
4684   }
4685 
4686   case Expr::MatrixSubscriptExprClass: {
4687     NotPrimaryExpr();
4688     const MatrixSubscriptExpr *ME = cast<MatrixSubscriptExpr>(E);
4689     Out << "ixix";
4690     mangleExpression(ME->getBase());
4691     mangleExpression(ME->getRowIdx());
4692     mangleExpression(ME->getColumnIdx());
4693     break;
4694   }
4695 
4696   case Expr::CompoundAssignOperatorClass: // fallthrough
4697   case Expr::BinaryOperatorClass: {
4698     NotPrimaryExpr();
4699     const BinaryOperator *BO = cast<BinaryOperator>(E);
4700     if (BO->getOpcode() == BO_PtrMemD)
4701       Out << "ds";
4702     else
4703       mangleOperatorName(BinaryOperator::getOverloadedOperator(BO->getOpcode()),
4704                          /*Arity=*/2);
4705     mangleExpression(BO->getLHS());
4706     mangleExpression(BO->getRHS());
4707     break;
4708   }
4709 
4710   case Expr::CXXRewrittenBinaryOperatorClass: {
4711     NotPrimaryExpr();
4712     // The mangled form represents the original syntax.
4713     CXXRewrittenBinaryOperator::DecomposedForm Decomposed =
4714         cast<CXXRewrittenBinaryOperator>(E)->getDecomposedForm();
4715     mangleOperatorName(BinaryOperator::getOverloadedOperator(Decomposed.Opcode),
4716                        /*Arity=*/2);
4717     mangleExpression(Decomposed.LHS);
4718     mangleExpression(Decomposed.RHS);
4719     break;
4720   }
4721 
4722   case Expr::ConditionalOperatorClass: {
4723     NotPrimaryExpr();
4724     const ConditionalOperator *CO = cast<ConditionalOperator>(E);
4725     mangleOperatorName(OO_Conditional, /*Arity=*/3);
4726     mangleExpression(CO->getCond());
4727     mangleExpression(CO->getLHS(), Arity);
4728     mangleExpression(CO->getRHS(), Arity);
4729     break;
4730   }
4731 
4732   case Expr::ImplicitCastExprClass: {
4733     ImplicitlyConvertedToType = E->getType();
4734     E = cast<ImplicitCastExpr>(E)->getSubExpr();
4735     goto recurse;
4736   }
4737 
4738   case Expr::ObjCBridgedCastExprClass: {
4739     NotPrimaryExpr();
4740     // Mangle ownership casts as a vendor extended operator __bridge,
4741     // __bridge_transfer, or __bridge_retain.
4742     StringRef Kind = cast<ObjCBridgedCastExpr>(E)->getBridgeKindName();
4743     Out << "v1U" << Kind.size() << Kind;
4744     mangleCastExpression(E, "cv");
4745     break;
4746   }
4747 
4748   case Expr::CStyleCastExprClass:
4749     NotPrimaryExpr();
4750     mangleCastExpression(E, "cv");
4751     break;
4752 
4753   case Expr::CXXFunctionalCastExprClass: {
4754     NotPrimaryExpr();
4755     auto *Sub = cast<ExplicitCastExpr>(E)->getSubExpr()->IgnoreImplicit();
4756     // FIXME: Add isImplicit to CXXConstructExpr.
4757     if (auto *CCE = dyn_cast<CXXConstructExpr>(Sub))
4758       if (CCE->getParenOrBraceRange().isInvalid())
4759         Sub = CCE->getArg(0)->IgnoreImplicit();
4760     if (auto *StdInitList = dyn_cast<CXXStdInitializerListExpr>(Sub))
4761       Sub = StdInitList->getSubExpr()->IgnoreImplicit();
4762     if (auto *IL = dyn_cast<InitListExpr>(Sub)) {
4763       Out << "tl";
4764       mangleType(E->getType());
4765       mangleInitListElements(IL);
4766       Out << "E";
4767     } else {
4768       mangleCastExpression(E, "cv");
4769     }
4770     break;
4771   }
4772 
4773   case Expr::CXXStaticCastExprClass:
4774     NotPrimaryExpr();
4775     mangleCastExpression(E, "sc");
4776     break;
4777   case Expr::CXXDynamicCastExprClass:
4778     NotPrimaryExpr();
4779     mangleCastExpression(E, "dc");
4780     break;
4781   case Expr::CXXReinterpretCastExprClass:
4782     NotPrimaryExpr();
4783     mangleCastExpression(E, "rc");
4784     break;
4785   case Expr::CXXConstCastExprClass:
4786     NotPrimaryExpr();
4787     mangleCastExpression(E, "cc");
4788     break;
4789   case Expr::CXXAddrspaceCastExprClass:
4790     NotPrimaryExpr();
4791     mangleCastExpression(E, "ac");
4792     break;
4793 
4794   case Expr::CXXOperatorCallExprClass: {
4795     NotPrimaryExpr();
4796     const CXXOperatorCallExpr *CE = cast<CXXOperatorCallExpr>(E);
4797     unsigned NumArgs = CE->getNumArgs();
4798     // A CXXOperatorCallExpr for OO_Arrow models only semantics, not syntax
4799     // (the enclosing MemberExpr covers the syntactic portion).
4800     if (CE->getOperator() != OO_Arrow)
4801       mangleOperatorName(CE->getOperator(), /*Arity=*/NumArgs);
4802     // Mangle the arguments.
4803     for (unsigned i = 0; i != NumArgs; ++i)
4804       mangleExpression(CE->getArg(i));
4805     break;
4806   }
4807 
4808   case Expr::ParenExprClass:
4809     E = cast<ParenExpr>(E)->getSubExpr();
4810     goto recurse;
4811 
4812   case Expr::ConceptSpecializationExprClass: {
4813     //  <expr-primary> ::= L <mangled-name> E # external name
4814     Out << "L_Z";
4815     auto *CSE = cast<ConceptSpecializationExpr>(E);
4816     mangleTemplateName(CSE->getNamedConcept(),
4817                        CSE->getTemplateArguments().data(),
4818                        CSE->getTemplateArguments().size());
4819     Out << 'E';
4820     break;
4821   }
4822 
4823   case Expr::DeclRefExprClass:
4824     // MangleDeclRefExpr helper handles primary-vs-nonprimary
4825     MangleDeclRefExpr(cast<DeclRefExpr>(E)->getDecl());
4826     break;
4827 
4828   case Expr::SubstNonTypeTemplateParmPackExprClass:
4829     NotPrimaryExpr();
4830     // FIXME: not clear how to mangle this!
4831     // template <unsigned N...> class A {
4832     //   template <class U...> void foo(U (&x)[N]...);
4833     // };
4834     Out << "_SUBSTPACK_";
4835     break;
4836 
4837   case Expr::FunctionParmPackExprClass: {
4838     NotPrimaryExpr();
4839     // FIXME: not clear how to mangle this!
4840     const FunctionParmPackExpr *FPPE = cast<FunctionParmPackExpr>(E);
4841     Out << "v110_SUBSTPACK";
4842     MangleDeclRefExpr(FPPE->getParameterPack());
4843     break;
4844   }
4845 
4846   case Expr::DependentScopeDeclRefExprClass: {
4847     NotPrimaryExpr();
4848     const DependentScopeDeclRefExpr *DRE = cast<DependentScopeDeclRefExpr>(E);
4849     mangleUnresolvedName(DRE->getQualifier(), DRE->getDeclName(),
4850                          DRE->getTemplateArgs(), DRE->getNumTemplateArgs(),
4851                          Arity);
4852     break;
4853   }
4854 
4855   case Expr::CXXBindTemporaryExprClass:
4856     E = cast<CXXBindTemporaryExpr>(E)->getSubExpr();
4857     goto recurse;
4858 
4859   case Expr::ExprWithCleanupsClass:
4860     E = cast<ExprWithCleanups>(E)->getSubExpr();
4861     goto recurse;
4862 
4863   case Expr::FloatingLiteralClass: {
4864     // <expr-primary>
4865     const FloatingLiteral *FL = cast<FloatingLiteral>(E);
4866     mangleFloatLiteral(FL->getType(), FL->getValue());
4867     break;
4868   }
4869 
4870   case Expr::FixedPointLiteralClass:
4871     // Currently unimplemented -- might be <expr-primary> in future?
4872     mangleFixedPointLiteral();
4873     break;
4874 
4875   case Expr::CharacterLiteralClass:
4876     // <expr-primary>
4877     Out << 'L';
4878     mangleType(E->getType());
4879     Out << cast<CharacterLiteral>(E)->getValue();
4880     Out << 'E';
4881     break;
4882 
4883   // FIXME. __objc_yes/__objc_no are mangled same as true/false
4884   case Expr::ObjCBoolLiteralExprClass:
4885     // <expr-primary>
4886     Out << "Lb";
4887     Out << (cast<ObjCBoolLiteralExpr>(E)->getValue() ? '1' : '0');
4888     Out << 'E';
4889     break;
4890 
4891   case Expr::CXXBoolLiteralExprClass:
4892     // <expr-primary>
4893     Out << "Lb";
4894     Out << (cast<CXXBoolLiteralExpr>(E)->getValue() ? '1' : '0');
4895     Out << 'E';
4896     break;
4897 
4898   case Expr::IntegerLiteralClass: {
4899     // <expr-primary>
4900     llvm::APSInt Value(cast<IntegerLiteral>(E)->getValue());
4901     if (E->getType()->isSignedIntegerType())
4902       Value.setIsSigned(true);
4903     mangleIntegerLiteral(E->getType(), Value);
4904     break;
4905   }
4906 
4907   case Expr::ImaginaryLiteralClass: {
4908     // <expr-primary>
4909     const ImaginaryLiteral *IE = cast<ImaginaryLiteral>(E);
4910     // Mangle as if a complex literal.
4911     // Proposal from David Vandevoorde, 2010.06.30.
4912     Out << 'L';
4913     mangleType(E->getType());
4914     if (const FloatingLiteral *Imag =
4915           dyn_cast<FloatingLiteral>(IE->getSubExpr())) {
4916       // Mangle a floating-point zero of the appropriate type.
4917       mangleFloat(llvm::APFloat(Imag->getValue().getSemantics()));
4918       Out << '_';
4919       mangleFloat(Imag->getValue());
4920     } else {
4921       Out << "0_";
4922       llvm::APSInt Value(cast<IntegerLiteral>(IE->getSubExpr())->getValue());
4923       if (IE->getSubExpr()->getType()->isSignedIntegerType())
4924         Value.setIsSigned(true);
4925       mangleNumber(Value);
4926     }
4927     Out << 'E';
4928     break;
4929   }
4930 
4931   case Expr::StringLiteralClass: {
4932     // <expr-primary>
4933     // Revised proposal from David Vandervoorde, 2010.07.15.
4934     Out << 'L';
4935     assert(isa<ConstantArrayType>(E->getType()));
4936     mangleType(E->getType());
4937     Out << 'E';
4938     break;
4939   }
4940 
4941   case Expr::GNUNullExprClass:
4942     // <expr-primary>
4943     // Mangle as if an integer literal 0.
4944     mangleIntegerLiteral(E->getType(), llvm::APSInt(32));
4945     break;
4946 
4947   case Expr::CXXNullPtrLiteralExprClass: {
4948     // <expr-primary>
4949     Out << "LDnE";
4950     break;
4951   }
4952 
4953   case Expr::PackExpansionExprClass:
4954     NotPrimaryExpr();
4955     Out << "sp";
4956     mangleExpression(cast<PackExpansionExpr>(E)->getPattern());
4957     break;
4958 
4959   case Expr::SizeOfPackExprClass: {
4960     NotPrimaryExpr();
4961     auto *SPE = cast<SizeOfPackExpr>(E);
4962     if (SPE->isPartiallySubstituted()) {
4963       Out << "sP";
4964       for (const auto &A : SPE->getPartialArguments())
4965         mangleTemplateArg(A, false);
4966       Out << "E";
4967       break;
4968     }
4969 
4970     Out << "sZ";
4971     const NamedDecl *Pack = SPE->getPack();
4972     if (const TemplateTypeParmDecl *TTP = dyn_cast<TemplateTypeParmDecl>(Pack))
4973       mangleTemplateParameter(TTP->getDepth(), TTP->getIndex());
4974     else if (const NonTypeTemplateParmDecl *NTTP
4975                 = dyn_cast<NonTypeTemplateParmDecl>(Pack))
4976       mangleTemplateParameter(NTTP->getDepth(), NTTP->getIndex());
4977     else if (const TemplateTemplateParmDecl *TempTP
4978                                     = dyn_cast<TemplateTemplateParmDecl>(Pack))
4979       mangleTemplateParameter(TempTP->getDepth(), TempTP->getIndex());
4980     else
4981       mangleFunctionParam(cast<ParmVarDecl>(Pack));
4982     break;
4983   }
4984 
4985   case Expr::MaterializeTemporaryExprClass:
4986     E = cast<MaterializeTemporaryExpr>(E)->getSubExpr();
4987     goto recurse;
4988 
4989   case Expr::CXXFoldExprClass: {
4990     NotPrimaryExpr();
4991     auto *FE = cast<CXXFoldExpr>(E);
4992     if (FE->isLeftFold())
4993       Out << (FE->getInit() ? "fL" : "fl");
4994     else
4995       Out << (FE->getInit() ? "fR" : "fr");
4996 
4997     if (FE->getOperator() == BO_PtrMemD)
4998       Out << "ds";
4999     else
5000       mangleOperatorName(
5001           BinaryOperator::getOverloadedOperator(FE->getOperator()),
5002           /*Arity=*/2);
5003 
5004     if (FE->getLHS())
5005       mangleExpression(FE->getLHS());
5006     if (FE->getRHS())
5007       mangleExpression(FE->getRHS());
5008     break;
5009   }
5010 
5011   case Expr::CXXThisExprClass:
5012     NotPrimaryExpr();
5013     Out << "fpT";
5014     break;
5015 
5016   case Expr::CoawaitExprClass:
5017     // FIXME: Propose a non-vendor mangling.
5018     NotPrimaryExpr();
5019     Out << "v18co_await";
5020     mangleExpression(cast<CoawaitExpr>(E)->getOperand());
5021     break;
5022 
5023   case Expr::DependentCoawaitExprClass:
5024     // FIXME: Propose a non-vendor mangling.
5025     NotPrimaryExpr();
5026     Out << "v18co_await";
5027     mangleExpression(cast<DependentCoawaitExpr>(E)->getOperand());
5028     break;
5029 
5030   case Expr::CoyieldExprClass:
5031     // FIXME: Propose a non-vendor mangling.
5032     NotPrimaryExpr();
5033     Out << "v18co_yield";
5034     mangleExpression(cast<CoawaitExpr>(E)->getOperand());
5035     break;
5036   case Expr::SYCLUniqueStableNameExprClass: {
5037     const auto *USN = cast<SYCLUniqueStableNameExpr>(E);
5038     NotPrimaryExpr();
5039 
5040     Out << "u33__builtin_sycl_unique_stable_name";
5041     mangleType(USN->getTypeSourceInfo()->getType());
5042 
5043     Out << "E";
5044     break;
5045   }
5046   }
5047 
5048   if (AsTemplateArg && !IsPrimaryExpr)
5049     Out << 'E';
5050 }
5051 
5052 /// Mangle an expression which refers to a parameter variable.
5053 ///
5054 /// <expression>     ::= <function-param>
5055 /// <function-param> ::= fp <top-level CV-qualifiers> _      # L == 0, I == 0
5056 /// <function-param> ::= fp <top-level CV-qualifiers>
5057 ///                      <parameter-2 non-negative number> _ # L == 0, I > 0
5058 /// <function-param> ::= fL <L-1 non-negative number>
5059 ///                      p <top-level CV-qualifiers> _       # L > 0, I == 0
5060 /// <function-param> ::= fL <L-1 non-negative number>
5061 ///                      p <top-level CV-qualifiers>
5062 ///                      <I-1 non-negative number> _         # L > 0, I > 0
5063 ///
5064 /// L is the nesting depth of the parameter, defined as 1 if the
5065 /// parameter comes from the innermost function prototype scope
5066 /// enclosing the current context, 2 if from the next enclosing
5067 /// function prototype scope, and so on, with one special case: if
5068 /// we've processed the full parameter clause for the innermost
5069 /// function type, then L is one less.  This definition conveniently
5070 /// makes it irrelevant whether a function's result type was written
5071 /// trailing or leading, but is otherwise overly complicated; the
5072 /// numbering was first designed without considering references to
5073 /// parameter in locations other than return types, and then the
5074 /// mangling had to be generalized without changing the existing
5075 /// manglings.
5076 ///
5077 /// I is the zero-based index of the parameter within its parameter
5078 /// declaration clause.  Note that the original ABI document describes
5079 /// this using 1-based ordinals.
5080 void CXXNameMangler::mangleFunctionParam(const ParmVarDecl *parm) {
5081   unsigned parmDepth = parm->getFunctionScopeDepth();
5082   unsigned parmIndex = parm->getFunctionScopeIndex();
5083 
5084   // Compute 'L'.
5085   // parmDepth does not include the declaring function prototype.
5086   // FunctionTypeDepth does account for that.
5087   assert(parmDepth < FunctionTypeDepth.getDepth());
5088   unsigned nestingDepth = FunctionTypeDepth.getDepth() - parmDepth;
5089   if (FunctionTypeDepth.isInResultType())
5090     nestingDepth--;
5091 
5092   if (nestingDepth == 0) {
5093     Out << "fp";
5094   } else {
5095     Out << "fL" << (nestingDepth - 1) << 'p';
5096   }
5097 
5098   // Top-level qualifiers.  We don't have to worry about arrays here,
5099   // because parameters declared as arrays should already have been
5100   // transformed to have pointer type. FIXME: apparently these don't
5101   // get mangled if used as an rvalue of a known non-class type?
5102   assert(!parm->getType()->isArrayType()
5103          && "parameter's type is still an array type?");
5104 
5105   if (const DependentAddressSpaceType *DAST =
5106       dyn_cast<DependentAddressSpaceType>(parm->getType())) {
5107     mangleQualifiers(DAST->getPointeeType().getQualifiers(), DAST);
5108   } else {
5109     mangleQualifiers(parm->getType().getQualifiers());
5110   }
5111 
5112   // Parameter index.
5113   if (parmIndex != 0) {
5114     Out << (parmIndex - 1);
5115   }
5116   Out << '_';
5117 }
5118 
5119 void CXXNameMangler::mangleCXXCtorType(CXXCtorType T,
5120                                        const CXXRecordDecl *InheritedFrom) {
5121   // <ctor-dtor-name> ::= C1  # complete object constructor
5122   //                  ::= C2  # base object constructor
5123   //                  ::= CI1 <type> # complete inheriting constructor
5124   //                  ::= CI2 <type> # base inheriting constructor
5125   //
5126   // In addition, C5 is a comdat name with C1 and C2 in it.
5127   Out << 'C';
5128   if (InheritedFrom)
5129     Out << 'I';
5130   switch (T) {
5131   case Ctor_Complete:
5132     Out << '1';
5133     break;
5134   case Ctor_Base:
5135     Out << '2';
5136     break;
5137   case Ctor_Comdat:
5138     Out << '5';
5139     break;
5140   case Ctor_DefaultClosure:
5141   case Ctor_CopyingClosure:
5142     llvm_unreachable("closure constructors don't exist for the Itanium ABI!");
5143   }
5144   if (InheritedFrom)
5145     mangleName(InheritedFrom);
5146 }
5147 
5148 void CXXNameMangler::mangleCXXDtorType(CXXDtorType T) {
5149   // <ctor-dtor-name> ::= D0  # deleting destructor
5150   //                  ::= D1  # complete object destructor
5151   //                  ::= D2  # base object destructor
5152   //
5153   // In addition, D5 is a comdat name with D1, D2 and, if virtual, D0 in it.
5154   switch (T) {
5155   case Dtor_Deleting:
5156     Out << "D0";
5157     break;
5158   case Dtor_Complete:
5159     Out << "D1";
5160     break;
5161   case Dtor_Base:
5162     Out << "D2";
5163     break;
5164   case Dtor_Comdat:
5165     Out << "D5";
5166     break;
5167   }
5168 }
5169 
5170 namespace {
5171 // Helper to provide ancillary information on a template used to mangle its
5172 // arguments.
5173 struct TemplateArgManglingInfo {
5174   TemplateDecl *ResolvedTemplate = nullptr;
5175   bool SeenPackExpansionIntoNonPack = false;
5176   const NamedDecl *UnresolvedExpandedPack = nullptr;
5177 
5178   TemplateArgManglingInfo(TemplateName TN) {
5179     if (TemplateDecl *TD = TN.getAsTemplateDecl())
5180       ResolvedTemplate = TD;
5181   }
5182 
5183   /// Do we need to mangle template arguments with exactly correct types?
5184   ///
5185   /// This should be called exactly once for each parameter / argument pair, in
5186   /// order.
5187   bool needExactType(unsigned ParamIdx, const TemplateArgument &Arg) {
5188     // We need correct types when the template-name is unresolved or when it
5189     // names a template that is able to be overloaded.
5190     if (!ResolvedTemplate || SeenPackExpansionIntoNonPack)
5191       return true;
5192 
5193     // Move to the next parameter.
5194     const NamedDecl *Param = UnresolvedExpandedPack;
5195     if (!Param) {
5196       assert(ParamIdx < ResolvedTemplate->getTemplateParameters()->size() &&
5197              "no parameter for argument");
5198       Param = ResolvedTemplate->getTemplateParameters()->getParam(ParamIdx);
5199 
5200       // If we reach an expanded parameter pack whose argument isn't in pack
5201       // form, that means Sema couldn't figure out which arguments belonged to
5202       // it, because it contains a pack expansion. Track the expanded pack for
5203       // all further template arguments until we hit that pack expansion.
5204       if (Param->isParameterPack() && Arg.getKind() != TemplateArgument::Pack) {
5205         assert(getExpandedPackSize(Param) &&
5206                "failed to form pack argument for parameter pack");
5207         UnresolvedExpandedPack = Param;
5208       }
5209     }
5210 
5211     // If we encounter a pack argument that is expanded into a non-pack
5212     // parameter, we can no longer track parameter / argument correspondence,
5213     // and need to use exact types from this point onwards.
5214     if (Arg.isPackExpansion() &&
5215         (!Param->isParameterPack() || UnresolvedExpandedPack)) {
5216       SeenPackExpansionIntoNonPack = true;
5217       return true;
5218     }
5219 
5220     // We need exact types for function template arguments because they might be
5221     // overloaded on template parameter type. As a special case, a member
5222     // function template of a generic lambda is not overloadable.
5223     if (auto *FTD = dyn_cast<FunctionTemplateDecl>(ResolvedTemplate)) {
5224       auto *RD = dyn_cast<CXXRecordDecl>(FTD->getDeclContext());
5225       if (!RD || !RD->isGenericLambda())
5226         return true;
5227     }
5228 
5229     // Otherwise, we only need a correct type if the parameter has a deduced
5230     // type.
5231     //
5232     // Note: for an expanded parameter pack, getType() returns the type prior
5233     // to expansion. We could ask for the expanded type with getExpansionType(),
5234     // but it doesn't matter because substitution and expansion don't affect
5235     // whether a deduced type appears in the type.
5236     auto *NTTP = dyn_cast<NonTypeTemplateParmDecl>(Param);
5237     return NTTP && NTTP->getType()->getContainedDeducedType();
5238   }
5239 };
5240 }
5241 
5242 void CXXNameMangler::mangleTemplateArgs(TemplateName TN,
5243                                         const TemplateArgumentLoc *TemplateArgs,
5244                                         unsigned NumTemplateArgs) {
5245   // <template-args> ::= I <template-arg>+ E
5246   Out << 'I';
5247   TemplateArgManglingInfo Info(TN);
5248   for (unsigned i = 0; i != NumTemplateArgs; ++i)
5249     mangleTemplateArg(TemplateArgs[i].getArgument(),
5250                       Info.needExactType(i, TemplateArgs[i].getArgument()));
5251   Out << 'E';
5252 }
5253 
5254 void CXXNameMangler::mangleTemplateArgs(TemplateName TN,
5255                                         const TemplateArgumentList &AL) {
5256   // <template-args> ::= I <template-arg>+ E
5257   Out << 'I';
5258   TemplateArgManglingInfo Info(TN);
5259   for (unsigned i = 0, e = AL.size(); i != e; ++i)
5260     mangleTemplateArg(AL[i], Info.needExactType(i, AL[i]));
5261   Out << 'E';
5262 }
5263 
5264 void CXXNameMangler::mangleTemplateArgs(TemplateName TN,
5265                                         const TemplateArgument *TemplateArgs,
5266                                         unsigned NumTemplateArgs) {
5267   // <template-args> ::= I <template-arg>+ E
5268   Out << 'I';
5269   TemplateArgManglingInfo Info(TN);
5270   for (unsigned i = 0; i != NumTemplateArgs; ++i)
5271     mangleTemplateArg(TemplateArgs[i], Info.needExactType(i, TemplateArgs[i]));
5272   Out << 'E';
5273 }
5274 
5275 void CXXNameMangler::mangleTemplateArg(TemplateArgument A, bool NeedExactType) {
5276   // <template-arg> ::= <type>              # type or template
5277   //                ::= X <expression> E    # expression
5278   //                ::= <expr-primary>      # simple expressions
5279   //                ::= J <template-arg>* E # argument pack
5280   if (!A.isInstantiationDependent() || A.isDependent())
5281     A = Context.getASTContext().getCanonicalTemplateArgument(A);
5282 
5283   switch (A.getKind()) {
5284   case TemplateArgument::Null:
5285     llvm_unreachable("Cannot mangle NULL template argument");
5286 
5287   case TemplateArgument::Type:
5288     mangleType(A.getAsType());
5289     break;
5290   case TemplateArgument::Template:
5291     // This is mangled as <type>.
5292     mangleType(A.getAsTemplate());
5293     break;
5294   case TemplateArgument::TemplateExpansion:
5295     // <type>  ::= Dp <type>          # pack expansion (C++0x)
5296     Out << "Dp";
5297     mangleType(A.getAsTemplateOrTemplatePattern());
5298     break;
5299   case TemplateArgument::Expression:
5300     mangleTemplateArgExpr(A.getAsExpr());
5301     break;
5302   case TemplateArgument::Integral:
5303     mangleIntegerLiteral(A.getIntegralType(), A.getAsIntegral());
5304     break;
5305   case TemplateArgument::Declaration: {
5306     //  <expr-primary> ::= L <mangled-name> E # external name
5307     ValueDecl *D = A.getAsDecl();
5308 
5309     // Template parameter objects are modeled by reproducing a source form
5310     // produced as if by aggregate initialization.
5311     if (A.getParamTypeForDecl()->isRecordType()) {
5312       auto *TPO = cast<TemplateParamObjectDecl>(D);
5313       mangleValueInTemplateArg(TPO->getType().getUnqualifiedType(),
5314                                TPO->getValue(), /*TopLevel=*/true,
5315                                NeedExactType);
5316       break;
5317     }
5318 
5319     ASTContext &Ctx = Context.getASTContext();
5320     APValue Value;
5321     if (D->isCXXInstanceMember())
5322       // Simple pointer-to-member with no conversion.
5323       Value = APValue(D, /*IsDerivedMember=*/false, /*Path=*/{});
5324     else if (D->getType()->isArrayType() &&
5325              Ctx.hasSimilarType(Ctx.getDecayedType(D->getType()),
5326                                 A.getParamTypeForDecl()) &&
5327              Ctx.getLangOpts().getClangABICompat() >
5328                  LangOptions::ClangABI::Ver11)
5329       // Build a value corresponding to this implicit array-to-pointer decay.
5330       Value = APValue(APValue::LValueBase(D), CharUnits::Zero(),
5331                       {APValue::LValuePathEntry::ArrayIndex(0)},
5332                       /*OnePastTheEnd=*/false);
5333     else
5334       // Regular pointer or reference to a declaration.
5335       Value = APValue(APValue::LValueBase(D), CharUnits::Zero(),
5336                       ArrayRef<APValue::LValuePathEntry>(),
5337                       /*OnePastTheEnd=*/false);
5338     mangleValueInTemplateArg(A.getParamTypeForDecl(), Value, /*TopLevel=*/true,
5339                              NeedExactType);
5340     break;
5341   }
5342   case TemplateArgument::NullPtr: {
5343     mangleNullPointer(A.getNullPtrType());
5344     break;
5345   }
5346   case TemplateArgument::Pack: {
5347     //  <template-arg> ::= J <template-arg>* E
5348     Out << 'J';
5349     for (const auto &P : A.pack_elements())
5350       mangleTemplateArg(P, NeedExactType);
5351     Out << 'E';
5352   }
5353   }
5354 }
5355 
5356 void CXXNameMangler::mangleTemplateArgExpr(const Expr *E) {
5357   ASTContext &Ctx = Context.getASTContext();
5358   if (Ctx.getLangOpts().getClangABICompat() > LangOptions::ClangABI::Ver11) {
5359     mangleExpression(E, UnknownArity, /*AsTemplateArg=*/true);
5360     return;
5361   }
5362 
5363   // Prior to Clang 12, we didn't omit the X .. E around <expr-primary>
5364   // correctly in cases where the template argument was
5365   // constructed from an expression rather than an already-evaluated
5366   // literal. In such a case, we would then e.g. emit 'XLi0EE' instead of
5367   // 'Li0E'.
5368   //
5369   // We did special-case DeclRefExpr to attempt to DTRT for that one
5370   // expression-kind, but while doing so, unfortunately handled ParmVarDecl
5371   // (subtype of VarDecl) _incorrectly_, and emitted 'L_Z .. E' instead of
5372   // the proper 'Xfp_E'.
5373   E = E->IgnoreParenImpCasts();
5374   if (const DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(E)) {
5375     const ValueDecl *D = DRE->getDecl();
5376     if (isa<VarDecl>(D) || isa<FunctionDecl>(D)) {
5377       Out << 'L';
5378       mangle(D);
5379       Out << 'E';
5380       return;
5381     }
5382   }
5383   Out << 'X';
5384   mangleExpression(E);
5385   Out << 'E';
5386 }
5387 
5388 /// Determine whether a given value is equivalent to zero-initialization for
5389 /// the purpose of discarding a trailing portion of a 'tl' mangling.
5390 ///
5391 /// Note that this is not in general equivalent to determining whether the
5392 /// value has an all-zeroes bit pattern.
5393 static bool isZeroInitialized(QualType T, const APValue &V) {
5394   // FIXME: mangleValueInTemplateArg has quadratic time complexity in
5395   // pathological cases due to using this, but it's a little awkward
5396   // to do this in linear time in general.
5397   switch (V.getKind()) {
5398   case APValue::None:
5399   case APValue::Indeterminate:
5400   case APValue::AddrLabelDiff:
5401     return false;
5402 
5403   case APValue::Struct: {
5404     const CXXRecordDecl *RD = T->getAsCXXRecordDecl();
5405     assert(RD && "unexpected type for record value");
5406     unsigned I = 0;
5407     for (const CXXBaseSpecifier &BS : RD->bases()) {
5408       if (!isZeroInitialized(BS.getType(), V.getStructBase(I)))
5409         return false;
5410       ++I;
5411     }
5412     I = 0;
5413     for (const FieldDecl *FD : RD->fields()) {
5414       if (!FD->isUnnamedBitfield() &&
5415           !isZeroInitialized(FD->getType(), V.getStructField(I)))
5416         return false;
5417       ++I;
5418     }
5419     return true;
5420   }
5421 
5422   case APValue::Union: {
5423     const CXXRecordDecl *RD = T->getAsCXXRecordDecl();
5424     assert(RD && "unexpected type for union value");
5425     // Zero-initialization zeroes the first non-unnamed-bitfield field, if any.
5426     for (const FieldDecl *FD : RD->fields()) {
5427       if (!FD->isUnnamedBitfield())
5428         return V.getUnionField() && declaresSameEntity(FD, V.getUnionField()) &&
5429                isZeroInitialized(FD->getType(), V.getUnionValue());
5430     }
5431     // If there are no fields (other than unnamed bitfields), the value is
5432     // necessarily zero-initialized.
5433     return true;
5434   }
5435 
5436   case APValue::Array: {
5437     QualType ElemT(T->getArrayElementTypeNoTypeQual(), 0);
5438     for (unsigned I = 0, N = V.getArrayInitializedElts(); I != N; ++I)
5439       if (!isZeroInitialized(ElemT, V.getArrayInitializedElt(I)))
5440         return false;
5441     return !V.hasArrayFiller() || isZeroInitialized(ElemT, V.getArrayFiller());
5442   }
5443 
5444   case APValue::Vector: {
5445     const VectorType *VT = T->castAs<VectorType>();
5446     for (unsigned I = 0, N = V.getVectorLength(); I != N; ++I)
5447       if (!isZeroInitialized(VT->getElementType(), V.getVectorElt(I)))
5448         return false;
5449     return true;
5450   }
5451 
5452   case APValue::Int:
5453     return !V.getInt();
5454 
5455   case APValue::Float:
5456     return V.getFloat().isPosZero();
5457 
5458   case APValue::FixedPoint:
5459     return !V.getFixedPoint().getValue();
5460 
5461   case APValue::ComplexFloat:
5462     return V.getComplexFloatReal().isPosZero() &&
5463            V.getComplexFloatImag().isPosZero();
5464 
5465   case APValue::ComplexInt:
5466     return !V.getComplexIntReal() && !V.getComplexIntImag();
5467 
5468   case APValue::LValue:
5469     return V.isNullPointer();
5470 
5471   case APValue::MemberPointer:
5472     return !V.getMemberPointerDecl();
5473   }
5474 
5475   llvm_unreachable("Unhandled APValue::ValueKind enum");
5476 }
5477 
5478 static QualType getLValueType(ASTContext &Ctx, const APValue &LV) {
5479   QualType T = LV.getLValueBase().getType();
5480   for (APValue::LValuePathEntry E : LV.getLValuePath()) {
5481     if (const ArrayType *AT = Ctx.getAsArrayType(T))
5482       T = AT->getElementType();
5483     else if (const FieldDecl *FD =
5484                  dyn_cast<FieldDecl>(E.getAsBaseOrMember().getPointer()))
5485       T = FD->getType();
5486     else
5487       T = Ctx.getRecordType(
5488           cast<CXXRecordDecl>(E.getAsBaseOrMember().getPointer()));
5489   }
5490   return T;
5491 }
5492 
5493 void CXXNameMangler::mangleValueInTemplateArg(QualType T, const APValue &V,
5494                                               bool TopLevel,
5495                                               bool NeedExactType) {
5496   // Ignore all top-level cv-qualifiers, to match GCC.
5497   Qualifiers Quals;
5498   T = getASTContext().getUnqualifiedArrayType(T, Quals);
5499 
5500   // A top-level expression that's not a primary expression is wrapped in X...E.
5501   bool IsPrimaryExpr = true;
5502   auto NotPrimaryExpr = [&] {
5503     if (TopLevel && IsPrimaryExpr)
5504       Out << 'X';
5505     IsPrimaryExpr = false;
5506   };
5507 
5508   // Proposed in https://github.com/itanium-cxx-abi/cxx-abi/issues/63.
5509   switch (V.getKind()) {
5510   case APValue::None:
5511   case APValue::Indeterminate:
5512     Out << 'L';
5513     mangleType(T);
5514     Out << 'E';
5515     break;
5516 
5517   case APValue::AddrLabelDiff:
5518     llvm_unreachable("unexpected value kind in template argument");
5519 
5520   case APValue::Struct: {
5521     const CXXRecordDecl *RD = T->getAsCXXRecordDecl();
5522     assert(RD && "unexpected type for record value");
5523 
5524     // Drop trailing zero-initialized elements.
5525     llvm::SmallVector<const FieldDecl *, 16> Fields(RD->field_begin(),
5526                                                     RD->field_end());
5527     while (
5528         !Fields.empty() &&
5529         (Fields.back()->isUnnamedBitfield() ||
5530          isZeroInitialized(Fields.back()->getType(),
5531                            V.getStructField(Fields.back()->getFieldIndex())))) {
5532       Fields.pop_back();
5533     }
5534     llvm::ArrayRef<CXXBaseSpecifier> Bases(RD->bases_begin(), RD->bases_end());
5535     if (Fields.empty()) {
5536       while (!Bases.empty() &&
5537              isZeroInitialized(Bases.back().getType(),
5538                                V.getStructBase(Bases.size() - 1)))
5539         Bases = Bases.drop_back();
5540     }
5541 
5542     // <expression> ::= tl <type> <braced-expression>* E
5543     NotPrimaryExpr();
5544     Out << "tl";
5545     mangleType(T);
5546     for (unsigned I = 0, N = Bases.size(); I != N; ++I)
5547       mangleValueInTemplateArg(Bases[I].getType(), V.getStructBase(I), false);
5548     for (unsigned I = 0, N = Fields.size(); I != N; ++I) {
5549       if (Fields[I]->isUnnamedBitfield())
5550         continue;
5551       mangleValueInTemplateArg(Fields[I]->getType(),
5552                                V.getStructField(Fields[I]->getFieldIndex()),
5553                                false);
5554     }
5555     Out << 'E';
5556     break;
5557   }
5558 
5559   case APValue::Union: {
5560     assert(T->getAsCXXRecordDecl() && "unexpected type for union value");
5561     const FieldDecl *FD = V.getUnionField();
5562 
5563     if (!FD) {
5564       Out << 'L';
5565       mangleType(T);
5566       Out << 'E';
5567       break;
5568     }
5569 
5570     // <braced-expression> ::= di <field source-name> <braced-expression>
5571     NotPrimaryExpr();
5572     Out << "tl";
5573     mangleType(T);
5574     if (!isZeroInitialized(T, V)) {
5575       Out << "di";
5576       mangleSourceName(FD->getIdentifier());
5577       mangleValueInTemplateArg(FD->getType(), V.getUnionValue(), false);
5578     }
5579     Out << 'E';
5580     break;
5581   }
5582 
5583   case APValue::Array: {
5584     QualType ElemT(T->getArrayElementTypeNoTypeQual(), 0);
5585 
5586     NotPrimaryExpr();
5587     Out << "tl";
5588     mangleType(T);
5589 
5590     // Drop trailing zero-initialized elements.
5591     unsigned N = V.getArraySize();
5592     if (!V.hasArrayFiller() || isZeroInitialized(ElemT, V.getArrayFiller())) {
5593       N = V.getArrayInitializedElts();
5594       while (N && isZeroInitialized(ElemT, V.getArrayInitializedElt(N - 1)))
5595         --N;
5596     }
5597 
5598     for (unsigned I = 0; I != N; ++I) {
5599       const APValue &Elem = I < V.getArrayInitializedElts()
5600                                 ? V.getArrayInitializedElt(I)
5601                                 : V.getArrayFiller();
5602       mangleValueInTemplateArg(ElemT, Elem, false);
5603     }
5604     Out << 'E';
5605     break;
5606   }
5607 
5608   case APValue::Vector: {
5609     const VectorType *VT = T->castAs<VectorType>();
5610 
5611     NotPrimaryExpr();
5612     Out << "tl";
5613     mangleType(T);
5614     unsigned N = V.getVectorLength();
5615     while (N && isZeroInitialized(VT->getElementType(), V.getVectorElt(N - 1)))
5616       --N;
5617     for (unsigned I = 0; I != N; ++I)
5618       mangleValueInTemplateArg(VT->getElementType(), V.getVectorElt(I), false);
5619     Out << 'E';
5620     break;
5621   }
5622 
5623   case APValue::Int:
5624     mangleIntegerLiteral(T, V.getInt());
5625     break;
5626 
5627   case APValue::Float:
5628     mangleFloatLiteral(T, V.getFloat());
5629     break;
5630 
5631   case APValue::FixedPoint:
5632     mangleFixedPointLiteral();
5633     break;
5634 
5635   case APValue::ComplexFloat: {
5636     const ComplexType *CT = T->castAs<ComplexType>();
5637     NotPrimaryExpr();
5638     Out << "tl";
5639     mangleType(T);
5640     if (!V.getComplexFloatReal().isPosZero() ||
5641         !V.getComplexFloatImag().isPosZero())
5642       mangleFloatLiteral(CT->getElementType(), V.getComplexFloatReal());
5643     if (!V.getComplexFloatImag().isPosZero())
5644       mangleFloatLiteral(CT->getElementType(), V.getComplexFloatImag());
5645     Out << 'E';
5646     break;
5647   }
5648 
5649   case APValue::ComplexInt: {
5650     const ComplexType *CT = T->castAs<ComplexType>();
5651     NotPrimaryExpr();
5652     Out << "tl";
5653     mangleType(T);
5654     if (V.getComplexIntReal().getBoolValue() ||
5655         V.getComplexIntImag().getBoolValue())
5656       mangleIntegerLiteral(CT->getElementType(), V.getComplexIntReal());
5657     if (V.getComplexIntImag().getBoolValue())
5658       mangleIntegerLiteral(CT->getElementType(), V.getComplexIntImag());
5659     Out << 'E';
5660     break;
5661   }
5662 
5663   case APValue::LValue: {
5664     // Proposed in https://github.com/itanium-cxx-abi/cxx-abi/issues/47.
5665     assert((T->isPointerType() || T->isReferenceType()) &&
5666            "unexpected type for LValue template arg");
5667 
5668     if (V.isNullPointer()) {
5669       mangleNullPointer(T);
5670       break;
5671     }
5672 
5673     APValue::LValueBase B = V.getLValueBase();
5674     if (!B) {
5675       // Non-standard mangling for integer cast to a pointer; this can only
5676       // occur as an extension.
5677       CharUnits Offset = V.getLValueOffset();
5678       if (Offset.isZero()) {
5679         // This is reinterpret_cast<T*>(0), not a null pointer. Mangle this as
5680         // a cast, because L <type> 0 E means something else.
5681         NotPrimaryExpr();
5682         Out << "rc";
5683         mangleType(T);
5684         Out << "Li0E";
5685         if (TopLevel)
5686           Out << 'E';
5687       } else {
5688         Out << "L";
5689         mangleType(T);
5690         Out << Offset.getQuantity() << 'E';
5691       }
5692       break;
5693     }
5694 
5695     ASTContext &Ctx = Context.getASTContext();
5696 
5697     enum { Base, Offset, Path } Kind;
5698     if (!V.hasLValuePath()) {
5699       // Mangle as (T*)((char*)&base + N).
5700       if (T->isReferenceType()) {
5701         NotPrimaryExpr();
5702         Out << "decvP";
5703         mangleType(T->getPointeeType());
5704       } else {
5705         NotPrimaryExpr();
5706         Out << "cv";
5707         mangleType(T);
5708       }
5709       Out << "plcvPcad";
5710       Kind = Offset;
5711     } else {
5712       if (!V.getLValuePath().empty() || V.isLValueOnePastTheEnd()) {
5713         NotPrimaryExpr();
5714         // A final conversion to the template parameter's type is usually
5715         // folded into the 'so' mangling, but we can't do that for 'void*'
5716         // parameters without introducing collisions.
5717         if (NeedExactType && T->isVoidPointerType()) {
5718           Out << "cv";
5719           mangleType(T);
5720         }
5721         if (T->isPointerType())
5722           Out << "ad";
5723         Out << "so";
5724         mangleType(T->isVoidPointerType()
5725                        ? getLValueType(Ctx, V).getUnqualifiedType()
5726                        : T->getPointeeType());
5727         Kind = Path;
5728       } else {
5729         if (NeedExactType &&
5730             !Ctx.hasSameType(T->getPointeeType(), getLValueType(Ctx, V)) &&
5731             Ctx.getLangOpts().getClangABICompat() >
5732                 LangOptions::ClangABI::Ver11) {
5733           NotPrimaryExpr();
5734           Out << "cv";
5735           mangleType(T);
5736         }
5737         if (T->isPointerType()) {
5738           NotPrimaryExpr();
5739           Out << "ad";
5740         }
5741         Kind = Base;
5742       }
5743     }
5744 
5745     QualType TypeSoFar = B.getType();
5746     if (auto *VD = B.dyn_cast<const ValueDecl*>()) {
5747       Out << 'L';
5748       mangle(VD);
5749       Out << 'E';
5750     } else if (auto *E = B.dyn_cast<const Expr*>()) {
5751       NotPrimaryExpr();
5752       mangleExpression(E);
5753     } else if (auto TI = B.dyn_cast<TypeInfoLValue>()) {
5754       NotPrimaryExpr();
5755       Out << "ti";
5756       mangleType(QualType(TI.getType(), 0));
5757     } else {
5758       // We should never see dynamic allocations here.
5759       llvm_unreachable("unexpected lvalue base kind in template argument");
5760     }
5761 
5762     switch (Kind) {
5763     case Base:
5764       break;
5765 
5766     case Offset:
5767       Out << 'L';
5768       mangleType(Ctx.getPointerDiffType());
5769       mangleNumber(V.getLValueOffset().getQuantity());
5770       Out << 'E';
5771       break;
5772 
5773     case Path:
5774       // <expression> ::= so <referent type> <expr> [<offset number>]
5775       //                  <union-selector>* [p] E
5776       if (!V.getLValueOffset().isZero())
5777         mangleNumber(V.getLValueOffset().getQuantity());
5778 
5779       // We model a past-the-end array pointer as array indexing with index N,
5780       // not with the "past the end" flag. Compensate for that.
5781       bool OnePastTheEnd = V.isLValueOnePastTheEnd();
5782 
5783       for (APValue::LValuePathEntry E : V.getLValuePath()) {
5784         if (auto *AT = TypeSoFar->getAsArrayTypeUnsafe()) {
5785           if (auto *CAT = dyn_cast<ConstantArrayType>(AT))
5786             OnePastTheEnd |= CAT->getSize() == E.getAsArrayIndex();
5787           TypeSoFar = AT->getElementType();
5788         } else {
5789           const Decl *D = E.getAsBaseOrMember().getPointer();
5790           if (auto *FD = dyn_cast<FieldDecl>(D)) {
5791             // <union-selector> ::= _ <number>
5792             if (FD->getParent()->isUnion()) {
5793               Out << '_';
5794               if (FD->getFieldIndex())
5795                 Out << (FD->getFieldIndex() - 1);
5796             }
5797             TypeSoFar = FD->getType();
5798           } else {
5799             TypeSoFar = Ctx.getRecordType(cast<CXXRecordDecl>(D));
5800           }
5801         }
5802       }
5803 
5804       if (OnePastTheEnd)
5805         Out << 'p';
5806       Out << 'E';
5807       break;
5808     }
5809 
5810     break;
5811   }
5812 
5813   case APValue::MemberPointer:
5814     // Proposed in https://github.com/itanium-cxx-abi/cxx-abi/issues/47.
5815     if (!V.getMemberPointerDecl()) {
5816       mangleNullPointer(T);
5817       break;
5818     }
5819 
5820     ASTContext &Ctx = Context.getASTContext();
5821 
5822     NotPrimaryExpr();
5823     if (!V.getMemberPointerPath().empty()) {
5824       Out << "mc";
5825       mangleType(T);
5826     } else if (NeedExactType &&
5827                !Ctx.hasSameType(
5828                    T->castAs<MemberPointerType>()->getPointeeType(),
5829                    V.getMemberPointerDecl()->getType()) &&
5830                Ctx.getLangOpts().getClangABICompat() >
5831                    LangOptions::ClangABI::Ver11) {
5832       Out << "cv";
5833       mangleType(T);
5834     }
5835     Out << "adL";
5836     mangle(V.getMemberPointerDecl());
5837     Out << 'E';
5838     if (!V.getMemberPointerPath().empty()) {
5839       CharUnits Offset =
5840           Context.getASTContext().getMemberPointerPathAdjustment(V);
5841       if (!Offset.isZero())
5842         mangleNumber(Offset.getQuantity());
5843       Out << 'E';
5844     }
5845     break;
5846   }
5847 
5848   if (TopLevel && !IsPrimaryExpr)
5849     Out << 'E';
5850 }
5851 
5852 void CXXNameMangler::mangleTemplateParameter(unsigned Depth, unsigned Index) {
5853   // <template-param> ::= T_    # first template parameter
5854   //                  ::= T <parameter-2 non-negative number> _
5855   //                  ::= TL <L-1 non-negative number> __
5856   //                  ::= TL <L-1 non-negative number> _
5857   //                         <parameter-2 non-negative number> _
5858   //
5859   // The latter two manglings are from a proposal here:
5860   // https://github.com/itanium-cxx-abi/cxx-abi/issues/31#issuecomment-528122117
5861   Out << 'T';
5862   if (Depth != 0)
5863     Out << 'L' << (Depth - 1) << '_';
5864   if (Index != 0)
5865     Out << (Index - 1);
5866   Out << '_';
5867 }
5868 
5869 void CXXNameMangler::mangleSeqID(unsigned SeqID) {
5870   if (SeqID == 1)
5871     Out << '0';
5872   else if (SeqID > 1) {
5873     SeqID--;
5874 
5875     // <seq-id> is encoded in base-36, using digits and upper case letters.
5876     char Buffer[7]; // log(2**32) / log(36) ~= 7
5877     MutableArrayRef<char> BufferRef(Buffer);
5878     MutableArrayRef<char>::reverse_iterator I = BufferRef.rbegin();
5879 
5880     for (; SeqID != 0; SeqID /= 36) {
5881       unsigned C = SeqID % 36;
5882       *I++ = (C < 10 ? '0' + C : 'A' + C - 10);
5883     }
5884 
5885     Out.write(I.base(), I - BufferRef.rbegin());
5886   }
5887   Out << '_';
5888 }
5889 
5890 void CXXNameMangler::mangleExistingSubstitution(TemplateName tname) {
5891   bool result = mangleSubstitution(tname);
5892   assert(result && "no existing substitution for template name");
5893   (void) result;
5894 }
5895 
5896 // <substitution> ::= S <seq-id> _
5897 //                ::= S_
5898 bool CXXNameMangler::mangleSubstitution(const NamedDecl *ND) {
5899   // Try one of the standard substitutions first.
5900   if (mangleStandardSubstitution(ND))
5901     return true;
5902 
5903   ND = cast<NamedDecl>(ND->getCanonicalDecl());
5904   return mangleSubstitution(reinterpret_cast<uintptr_t>(ND));
5905 }
5906 
5907 /// Determine whether the given type has any qualifiers that are relevant for
5908 /// substitutions.
5909 static bool hasMangledSubstitutionQualifiers(QualType T) {
5910   Qualifiers Qs = T.getQualifiers();
5911   return Qs.getCVRQualifiers() || Qs.hasAddressSpace() || Qs.hasUnaligned();
5912 }
5913 
5914 bool CXXNameMangler::mangleSubstitution(QualType T) {
5915   if (!hasMangledSubstitutionQualifiers(T)) {
5916     if (const RecordType *RT = T->getAs<RecordType>())
5917       return mangleSubstitution(RT->getDecl());
5918   }
5919 
5920   uintptr_t TypePtr = reinterpret_cast<uintptr_t>(T.getAsOpaquePtr());
5921 
5922   return mangleSubstitution(TypePtr);
5923 }
5924 
5925 bool CXXNameMangler::mangleSubstitution(TemplateName Template) {
5926   if (TemplateDecl *TD = Template.getAsTemplateDecl())
5927     return mangleSubstitution(TD);
5928 
5929   Template = Context.getASTContext().getCanonicalTemplateName(Template);
5930   return mangleSubstitution(
5931                       reinterpret_cast<uintptr_t>(Template.getAsVoidPointer()));
5932 }
5933 
5934 bool CXXNameMangler::mangleSubstitution(uintptr_t Ptr) {
5935   llvm::DenseMap<uintptr_t, unsigned>::iterator I = Substitutions.find(Ptr);
5936   if (I == Substitutions.end())
5937     return false;
5938 
5939   unsigned SeqID = I->second;
5940   Out << 'S';
5941   mangleSeqID(SeqID);
5942 
5943   return true;
5944 }
5945 
5946 static bool isCharType(QualType T) {
5947   if (T.isNull())
5948     return false;
5949 
5950   return T->isSpecificBuiltinType(BuiltinType::Char_S) ||
5951     T->isSpecificBuiltinType(BuiltinType::Char_U);
5952 }
5953 
5954 /// Returns whether a given type is a template specialization of a given name
5955 /// with a single argument of type char.
5956 static bool isCharSpecialization(QualType T, const char *Name) {
5957   if (T.isNull())
5958     return false;
5959 
5960   const RecordType *RT = T->getAs<RecordType>();
5961   if (!RT)
5962     return false;
5963 
5964   const ClassTemplateSpecializationDecl *SD =
5965     dyn_cast<ClassTemplateSpecializationDecl>(RT->getDecl());
5966   if (!SD)
5967     return false;
5968 
5969   if (!isStdNamespace(getEffectiveDeclContext(SD)))
5970     return false;
5971 
5972   const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
5973   if (TemplateArgs.size() != 1)
5974     return false;
5975 
5976   if (!isCharType(TemplateArgs[0].getAsType()))
5977     return false;
5978 
5979   return SD->getIdentifier()->getName() == Name;
5980 }
5981 
5982 template <std::size_t StrLen>
5983 static bool isStreamCharSpecialization(const ClassTemplateSpecializationDecl*SD,
5984                                        const char (&Str)[StrLen]) {
5985   if (!SD->getIdentifier()->isStr(Str))
5986     return false;
5987 
5988   const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
5989   if (TemplateArgs.size() != 2)
5990     return false;
5991 
5992   if (!isCharType(TemplateArgs[0].getAsType()))
5993     return false;
5994 
5995   if (!isCharSpecialization(TemplateArgs[1].getAsType(), "char_traits"))
5996     return false;
5997 
5998   return true;
5999 }
6000 
6001 bool CXXNameMangler::mangleStandardSubstitution(const NamedDecl *ND) {
6002   // <substitution> ::= St # ::std::
6003   if (const NamespaceDecl *NS = dyn_cast<NamespaceDecl>(ND)) {
6004     if (isStd(NS)) {
6005       Out << "St";
6006       return true;
6007     }
6008   }
6009 
6010   if (const ClassTemplateDecl *TD = dyn_cast<ClassTemplateDecl>(ND)) {
6011     if (!isStdNamespace(getEffectiveDeclContext(TD)))
6012       return false;
6013 
6014     // <substitution> ::= Sa # ::std::allocator
6015     if (TD->getIdentifier()->isStr("allocator")) {
6016       Out << "Sa";
6017       return true;
6018     }
6019 
6020     // <<substitution> ::= Sb # ::std::basic_string
6021     if (TD->getIdentifier()->isStr("basic_string")) {
6022       Out << "Sb";
6023       return true;
6024     }
6025   }
6026 
6027   if (const ClassTemplateSpecializationDecl *SD =
6028         dyn_cast<ClassTemplateSpecializationDecl>(ND)) {
6029     if (!isStdNamespace(getEffectiveDeclContext(SD)))
6030       return false;
6031 
6032     //    <substitution> ::= Ss # ::std::basic_string<char,
6033     //                            ::std::char_traits<char>,
6034     //                            ::std::allocator<char> >
6035     if (SD->getIdentifier()->isStr("basic_string")) {
6036       const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
6037 
6038       if (TemplateArgs.size() != 3)
6039         return false;
6040 
6041       if (!isCharType(TemplateArgs[0].getAsType()))
6042         return false;
6043 
6044       if (!isCharSpecialization(TemplateArgs[1].getAsType(), "char_traits"))
6045         return false;
6046 
6047       if (!isCharSpecialization(TemplateArgs[2].getAsType(), "allocator"))
6048         return false;
6049 
6050       Out << "Ss";
6051       return true;
6052     }
6053 
6054     //    <substitution> ::= Si # ::std::basic_istream<char,
6055     //                            ::std::char_traits<char> >
6056     if (isStreamCharSpecialization(SD, "basic_istream")) {
6057       Out << "Si";
6058       return true;
6059     }
6060 
6061     //    <substitution> ::= So # ::std::basic_ostream<char,
6062     //                            ::std::char_traits<char> >
6063     if (isStreamCharSpecialization(SD, "basic_ostream")) {
6064       Out << "So";
6065       return true;
6066     }
6067 
6068     //    <substitution> ::= Sd # ::std::basic_iostream<char,
6069     //                            ::std::char_traits<char> >
6070     if (isStreamCharSpecialization(SD, "basic_iostream")) {
6071       Out << "Sd";
6072       return true;
6073     }
6074   }
6075   return false;
6076 }
6077 
6078 void CXXNameMangler::addSubstitution(QualType T) {
6079   if (!hasMangledSubstitutionQualifiers(T)) {
6080     if (const RecordType *RT = T->getAs<RecordType>()) {
6081       addSubstitution(RT->getDecl());
6082       return;
6083     }
6084   }
6085 
6086   uintptr_t TypePtr = reinterpret_cast<uintptr_t>(T.getAsOpaquePtr());
6087   addSubstitution(TypePtr);
6088 }
6089 
6090 void CXXNameMangler::addSubstitution(TemplateName Template) {
6091   if (TemplateDecl *TD = Template.getAsTemplateDecl())
6092     return addSubstitution(TD);
6093 
6094   Template = Context.getASTContext().getCanonicalTemplateName(Template);
6095   addSubstitution(reinterpret_cast<uintptr_t>(Template.getAsVoidPointer()));
6096 }
6097 
6098 void CXXNameMangler::addSubstitution(uintptr_t Ptr) {
6099   assert(!Substitutions.count(Ptr) && "Substitution already exists!");
6100   Substitutions[Ptr] = SeqID++;
6101 }
6102 
6103 void CXXNameMangler::extendSubstitutions(CXXNameMangler* Other) {
6104   assert(Other->SeqID >= SeqID && "Must be superset of substitutions!");
6105   if (Other->SeqID > SeqID) {
6106     Substitutions.swap(Other->Substitutions);
6107     SeqID = Other->SeqID;
6108   }
6109 }
6110 
6111 CXXNameMangler::AbiTagList
6112 CXXNameMangler::makeFunctionReturnTypeTags(const FunctionDecl *FD) {
6113   // When derived abi tags are disabled there is no need to make any list.
6114   if (DisableDerivedAbiTags)
6115     return AbiTagList();
6116 
6117   llvm::raw_null_ostream NullOutStream;
6118   CXXNameMangler TrackReturnTypeTags(*this, NullOutStream);
6119   TrackReturnTypeTags.disableDerivedAbiTags();
6120 
6121   const FunctionProtoType *Proto =
6122       cast<FunctionProtoType>(FD->getType()->getAs<FunctionType>());
6123   FunctionTypeDepthState saved = TrackReturnTypeTags.FunctionTypeDepth.push();
6124   TrackReturnTypeTags.FunctionTypeDepth.enterResultType();
6125   TrackReturnTypeTags.mangleType(Proto->getReturnType());
6126   TrackReturnTypeTags.FunctionTypeDepth.leaveResultType();
6127   TrackReturnTypeTags.FunctionTypeDepth.pop(saved);
6128 
6129   return TrackReturnTypeTags.AbiTagsRoot.getSortedUniqueUsedAbiTags();
6130 }
6131 
6132 CXXNameMangler::AbiTagList
6133 CXXNameMangler::makeVariableTypeTags(const VarDecl *VD) {
6134   // When derived abi tags are disabled there is no need to make any list.
6135   if (DisableDerivedAbiTags)
6136     return AbiTagList();
6137 
6138   llvm::raw_null_ostream NullOutStream;
6139   CXXNameMangler TrackVariableType(*this, NullOutStream);
6140   TrackVariableType.disableDerivedAbiTags();
6141 
6142   TrackVariableType.mangleType(VD->getType());
6143 
6144   return TrackVariableType.AbiTagsRoot.getSortedUniqueUsedAbiTags();
6145 }
6146 
6147 bool CXXNameMangler::shouldHaveAbiTags(ItaniumMangleContextImpl &C,
6148                                        const VarDecl *VD) {
6149   llvm::raw_null_ostream NullOutStream;
6150   CXXNameMangler TrackAbiTags(C, NullOutStream, nullptr, true);
6151   TrackAbiTags.mangle(VD);
6152   return TrackAbiTags.AbiTagsRoot.getUsedAbiTags().size();
6153 }
6154 
6155 //
6156 
6157 /// Mangles the name of the declaration D and emits that name to the given
6158 /// output stream.
6159 ///
6160 /// If the declaration D requires a mangled name, this routine will emit that
6161 /// mangled name to \p os and return true. Otherwise, \p os will be unchanged
6162 /// and this routine will return false. In this case, the caller should just
6163 /// emit the identifier of the declaration (\c D->getIdentifier()) as its
6164 /// name.
6165 void ItaniumMangleContextImpl::mangleCXXName(GlobalDecl GD,
6166                                              raw_ostream &Out) {
6167   const NamedDecl *D = cast<NamedDecl>(GD.getDecl());
6168   assert((isa<FunctionDecl, VarDecl, TemplateParamObjectDecl>(D)) &&
6169          "Invalid mangleName() call, argument is not a variable or function!");
6170 
6171   PrettyStackTraceDecl CrashInfo(D, SourceLocation(),
6172                                  getASTContext().getSourceManager(),
6173                                  "Mangling declaration");
6174 
6175   if (auto *CD = dyn_cast<CXXConstructorDecl>(D)) {
6176     auto Type = GD.getCtorType();
6177     CXXNameMangler Mangler(*this, Out, CD, Type);
6178     return Mangler.mangle(GlobalDecl(CD, Type));
6179   }
6180 
6181   if (auto *DD = dyn_cast<CXXDestructorDecl>(D)) {
6182     auto Type = GD.getDtorType();
6183     CXXNameMangler Mangler(*this, Out, DD, Type);
6184     return Mangler.mangle(GlobalDecl(DD, Type));
6185   }
6186 
6187   CXXNameMangler Mangler(*this, Out, D);
6188   Mangler.mangle(GD);
6189 }
6190 
6191 void ItaniumMangleContextImpl::mangleCXXCtorComdat(const CXXConstructorDecl *D,
6192                                                    raw_ostream &Out) {
6193   CXXNameMangler Mangler(*this, Out, D, Ctor_Comdat);
6194   Mangler.mangle(GlobalDecl(D, Ctor_Comdat));
6195 }
6196 
6197 void ItaniumMangleContextImpl::mangleCXXDtorComdat(const CXXDestructorDecl *D,
6198                                                    raw_ostream &Out) {
6199   CXXNameMangler Mangler(*this, Out, D, Dtor_Comdat);
6200   Mangler.mangle(GlobalDecl(D, Dtor_Comdat));
6201 }
6202 
6203 void ItaniumMangleContextImpl::mangleThunk(const CXXMethodDecl *MD,
6204                                            const ThunkInfo &Thunk,
6205                                            raw_ostream &Out) {
6206   //  <special-name> ::= T <call-offset> <base encoding>
6207   //                      # base is the nominal target function of thunk
6208   //  <special-name> ::= Tc <call-offset> <call-offset> <base encoding>
6209   //                      # base is the nominal target function of thunk
6210   //                      # first call-offset is 'this' adjustment
6211   //                      # second call-offset is result adjustment
6212 
6213   assert(!isa<CXXDestructorDecl>(MD) &&
6214          "Use mangleCXXDtor for destructor decls!");
6215   CXXNameMangler Mangler(*this, Out);
6216   Mangler.getStream() << "_ZT";
6217   if (!Thunk.Return.isEmpty())
6218     Mangler.getStream() << 'c';
6219 
6220   // Mangle the 'this' pointer adjustment.
6221   Mangler.mangleCallOffset(Thunk.This.NonVirtual,
6222                            Thunk.This.Virtual.Itanium.VCallOffsetOffset);
6223 
6224   // Mangle the return pointer adjustment if there is one.
6225   if (!Thunk.Return.isEmpty())
6226     Mangler.mangleCallOffset(Thunk.Return.NonVirtual,
6227                              Thunk.Return.Virtual.Itanium.VBaseOffsetOffset);
6228 
6229   Mangler.mangleFunctionEncoding(MD);
6230 }
6231 
6232 void ItaniumMangleContextImpl::mangleCXXDtorThunk(
6233     const CXXDestructorDecl *DD, CXXDtorType Type,
6234     const ThisAdjustment &ThisAdjustment, raw_ostream &Out) {
6235   //  <special-name> ::= T <call-offset> <base encoding>
6236   //                      # base is the nominal target function of thunk
6237   CXXNameMangler Mangler(*this, Out, DD, Type);
6238   Mangler.getStream() << "_ZT";
6239 
6240   // Mangle the 'this' pointer adjustment.
6241   Mangler.mangleCallOffset(ThisAdjustment.NonVirtual,
6242                            ThisAdjustment.Virtual.Itanium.VCallOffsetOffset);
6243 
6244   Mangler.mangleFunctionEncoding(GlobalDecl(DD, Type));
6245 }
6246 
6247 /// Returns the mangled name for a guard variable for the passed in VarDecl.
6248 void ItaniumMangleContextImpl::mangleStaticGuardVariable(const VarDecl *D,
6249                                                          raw_ostream &Out) {
6250   //  <special-name> ::= GV <object name>       # Guard variable for one-time
6251   //                                            # initialization
6252   CXXNameMangler Mangler(*this, Out);
6253   // GCC 5.3.0 doesn't emit derived ABI tags for local names but that seems to
6254   // be a bug that is fixed in trunk.
6255   Mangler.getStream() << "_ZGV";
6256   Mangler.mangleName(D);
6257 }
6258 
6259 void ItaniumMangleContextImpl::mangleDynamicInitializer(const VarDecl *MD,
6260                                                         raw_ostream &Out) {
6261   // These symbols are internal in the Itanium ABI, so the names don't matter.
6262   // Clang has traditionally used this symbol and allowed LLVM to adjust it to
6263   // avoid duplicate symbols.
6264   Out << "__cxx_global_var_init";
6265 }
6266 
6267 void ItaniumMangleContextImpl::mangleDynamicAtExitDestructor(const VarDecl *D,
6268                                                              raw_ostream &Out) {
6269   // Prefix the mangling of D with __dtor_.
6270   CXXNameMangler Mangler(*this, Out);
6271   Mangler.getStream() << "__dtor_";
6272   if (shouldMangleDeclName(D))
6273     Mangler.mangle(D);
6274   else
6275     Mangler.getStream() << D->getName();
6276 }
6277 
6278 void ItaniumMangleContextImpl::mangleDynamicStermFinalizer(const VarDecl *D,
6279                                                            raw_ostream &Out) {
6280   // Clang generates these internal-linkage functions as part of its
6281   // implementation of the XL ABI.
6282   CXXNameMangler Mangler(*this, Out);
6283   Mangler.getStream() << "__finalize_";
6284   if (shouldMangleDeclName(D))
6285     Mangler.mangle(D);
6286   else
6287     Mangler.getStream() << D->getName();
6288 }
6289 
6290 void ItaniumMangleContextImpl::mangleSEHFilterExpression(
6291     const NamedDecl *EnclosingDecl, raw_ostream &Out) {
6292   CXXNameMangler Mangler(*this, Out);
6293   Mangler.getStream() << "__filt_";
6294   if (shouldMangleDeclName(EnclosingDecl))
6295     Mangler.mangle(EnclosingDecl);
6296   else
6297     Mangler.getStream() << EnclosingDecl->getName();
6298 }
6299 
6300 void ItaniumMangleContextImpl::mangleSEHFinallyBlock(
6301     const NamedDecl *EnclosingDecl, raw_ostream &Out) {
6302   CXXNameMangler Mangler(*this, Out);
6303   Mangler.getStream() << "__fin_";
6304   if (shouldMangleDeclName(EnclosingDecl))
6305     Mangler.mangle(EnclosingDecl);
6306   else
6307     Mangler.getStream() << EnclosingDecl->getName();
6308 }
6309 
6310 void ItaniumMangleContextImpl::mangleItaniumThreadLocalInit(const VarDecl *D,
6311                                                             raw_ostream &Out) {
6312   //  <special-name> ::= TH <object name>
6313   CXXNameMangler Mangler(*this, Out);
6314   Mangler.getStream() << "_ZTH";
6315   Mangler.mangleName(D);
6316 }
6317 
6318 void
6319 ItaniumMangleContextImpl::mangleItaniumThreadLocalWrapper(const VarDecl *D,
6320                                                           raw_ostream &Out) {
6321   //  <special-name> ::= TW <object name>
6322   CXXNameMangler Mangler(*this, Out);
6323   Mangler.getStream() << "_ZTW";
6324   Mangler.mangleName(D);
6325 }
6326 
6327 void ItaniumMangleContextImpl::mangleReferenceTemporary(const VarDecl *D,
6328                                                         unsigned ManglingNumber,
6329                                                         raw_ostream &Out) {
6330   // We match the GCC mangling here.
6331   //  <special-name> ::= GR <object name>
6332   CXXNameMangler Mangler(*this, Out);
6333   Mangler.getStream() << "_ZGR";
6334   Mangler.mangleName(D);
6335   assert(ManglingNumber > 0 && "Reference temporary mangling number is zero!");
6336   Mangler.mangleSeqID(ManglingNumber - 1);
6337 }
6338 
6339 void ItaniumMangleContextImpl::mangleCXXVTable(const CXXRecordDecl *RD,
6340                                                raw_ostream &Out) {
6341   // <special-name> ::= TV <type>  # virtual table
6342   CXXNameMangler Mangler(*this, Out);
6343   Mangler.getStream() << "_ZTV";
6344   Mangler.mangleNameOrStandardSubstitution(RD);
6345 }
6346 
6347 void ItaniumMangleContextImpl::mangleCXXVTT(const CXXRecordDecl *RD,
6348                                             raw_ostream &Out) {
6349   // <special-name> ::= TT <type>  # VTT structure
6350   CXXNameMangler Mangler(*this, Out);
6351   Mangler.getStream() << "_ZTT";
6352   Mangler.mangleNameOrStandardSubstitution(RD);
6353 }
6354 
6355 void ItaniumMangleContextImpl::mangleCXXCtorVTable(const CXXRecordDecl *RD,
6356                                                    int64_t Offset,
6357                                                    const CXXRecordDecl *Type,
6358                                                    raw_ostream &Out) {
6359   // <special-name> ::= TC <type> <offset number> _ <base type>
6360   CXXNameMangler Mangler(*this, Out);
6361   Mangler.getStream() << "_ZTC";
6362   Mangler.mangleNameOrStandardSubstitution(RD);
6363   Mangler.getStream() << Offset;
6364   Mangler.getStream() << '_';
6365   Mangler.mangleNameOrStandardSubstitution(Type);
6366 }
6367 
6368 void ItaniumMangleContextImpl::mangleCXXRTTI(QualType Ty, raw_ostream &Out) {
6369   // <special-name> ::= TI <type>  # typeinfo structure
6370   assert(!Ty.hasQualifiers() && "RTTI info cannot have top-level qualifiers");
6371   CXXNameMangler Mangler(*this, Out);
6372   Mangler.getStream() << "_ZTI";
6373   Mangler.mangleType(Ty);
6374 }
6375 
6376 void ItaniumMangleContextImpl::mangleCXXRTTIName(QualType Ty,
6377                                                  raw_ostream &Out) {
6378   // <special-name> ::= TS <type>  # typeinfo name (null terminated byte string)
6379   CXXNameMangler Mangler(*this, Out);
6380   Mangler.getStream() << "_ZTS";
6381   Mangler.mangleType(Ty);
6382 }
6383 
6384 void ItaniumMangleContextImpl::mangleTypeName(QualType Ty, raw_ostream &Out) {
6385   mangleCXXRTTIName(Ty, Out);
6386 }
6387 
6388 void ItaniumMangleContextImpl::mangleStringLiteral(const StringLiteral *, raw_ostream &) {
6389   llvm_unreachable("Can't mangle string literals");
6390 }
6391 
6392 void ItaniumMangleContextImpl::mangleLambdaSig(const CXXRecordDecl *Lambda,
6393                                                raw_ostream &Out) {
6394   CXXNameMangler Mangler(*this, Out);
6395   Mangler.mangleLambdaSig(Lambda);
6396 }
6397 
6398 ItaniumMangleContext *ItaniumMangleContext::create(ASTContext &Context,
6399                                                    DiagnosticsEngine &Diags) {
6400   return new ItaniumMangleContextImpl(
6401       Context, Diags,
6402       [](ASTContext &, const NamedDecl *) -> llvm::Optional<unsigned> {
6403         return llvm::None;
6404       });
6405 }
6406 
6407 ItaniumMangleContext *
6408 ItaniumMangleContext::create(ASTContext &Context, DiagnosticsEngine &Diags,
6409                              DiscriminatorOverrideTy DiscriminatorOverride) {
6410   return new ItaniumMangleContextImpl(Context, Diags, DiscriminatorOverride);
6411 }
6412