1 //===--- ItaniumMangle.cpp - Itanium C++ Name Mangling ----------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // Implements C++ name mangling according to the Itanium C++ ABI,
11 // which is used in GCC 3.2 and newer (and many compilers that are
12 // ABI-compatible with GCC):
13 //
14 //   http://itanium-cxx-abi.github.io/cxx-abi/abi.html#mangling
15 //
16 //===----------------------------------------------------------------------===//
17 #include "clang/AST/Mangle.h"
18 #include "clang/AST/ASTContext.h"
19 #include "clang/AST/Attr.h"
20 #include "clang/AST/Decl.h"
21 #include "clang/AST/DeclCXX.h"
22 #include "clang/AST/DeclObjC.h"
23 #include "clang/AST/DeclOpenMP.h"
24 #include "clang/AST/DeclTemplate.h"
25 #include "clang/AST/Expr.h"
26 #include "clang/AST/ExprCXX.h"
27 #include "clang/AST/ExprObjC.h"
28 #include "clang/AST/TypeLoc.h"
29 #include "clang/Basic/ABI.h"
30 #include "clang/Basic/SourceManager.h"
31 #include "clang/Basic/TargetInfo.h"
32 #include "llvm/ADT/StringExtras.h"
33 #include "llvm/Support/ErrorHandling.h"
34 #include "llvm/Support/raw_ostream.h"
35 
36 #define MANGLE_CHECKER 0
37 
38 #if MANGLE_CHECKER
39 #include <cxxabi.h>
40 #endif
41 
42 using namespace clang;
43 
44 namespace {
45 
46 /// Retrieve the declaration context that should be used when mangling the given
47 /// declaration.
48 static const DeclContext *getEffectiveDeclContext(const Decl *D) {
49   // The ABI assumes that lambda closure types that occur within
50   // default arguments live in the context of the function. However, due to
51   // the way in which Clang parses and creates function declarations, this is
52   // not the case: the lambda closure type ends up living in the context
53   // where the function itself resides, because the function declaration itself
54   // had not yet been created. Fix the context here.
55   if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
56     if (RD->isLambda())
57       if (ParmVarDecl *ContextParam
58             = dyn_cast_or_null<ParmVarDecl>(RD->getLambdaContextDecl()))
59         return ContextParam->getDeclContext();
60   }
61 
62   // Perform the same check for block literals.
63   if (const BlockDecl *BD = dyn_cast<BlockDecl>(D)) {
64     if (ParmVarDecl *ContextParam
65           = dyn_cast_or_null<ParmVarDecl>(BD->getBlockManglingContextDecl()))
66       return ContextParam->getDeclContext();
67   }
68 
69   const DeclContext *DC = D->getDeclContext();
70   if (isa<CapturedDecl>(DC) || isa<OMPDeclareReductionDecl>(DC)) {
71     return getEffectiveDeclContext(cast<Decl>(DC));
72   }
73 
74   if (const auto *VD = dyn_cast<VarDecl>(D))
75     if (VD->isExternC())
76       return VD->getASTContext().getTranslationUnitDecl();
77 
78   if (const auto *FD = dyn_cast<FunctionDecl>(D))
79     if (FD->isExternC())
80       return FD->getASTContext().getTranslationUnitDecl();
81 
82   return DC->getRedeclContext();
83 }
84 
85 static const DeclContext *getEffectiveParentContext(const DeclContext *DC) {
86   return getEffectiveDeclContext(cast<Decl>(DC));
87 }
88 
89 static bool isLocalContainerContext(const DeclContext *DC) {
90   return isa<FunctionDecl>(DC) || isa<ObjCMethodDecl>(DC) || isa<BlockDecl>(DC);
91 }
92 
93 static const RecordDecl *GetLocalClassDecl(const Decl *D) {
94   const DeclContext *DC = getEffectiveDeclContext(D);
95   while (!DC->isNamespace() && !DC->isTranslationUnit()) {
96     if (isLocalContainerContext(DC))
97       return dyn_cast<RecordDecl>(D);
98     D = cast<Decl>(DC);
99     DC = getEffectiveDeclContext(D);
100   }
101   return nullptr;
102 }
103 
104 static const FunctionDecl *getStructor(const FunctionDecl *fn) {
105   if (const FunctionTemplateDecl *ftd = fn->getPrimaryTemplate())
106     return ftd->getTemplatedDecl();
107 
108   return fn;
109 }
110 
111 static const NamedDecl *getStructor(const NamedDecl *decl) {
112   const FunctionDecl *fn = dyn_cast_or_null<FunctionDecl>(decl);
113   return (fn ? getStructor(fn) : decl);
114 }
115 
116 static bool isLambda(const NamedDecl *ND) {
117   const CXXRecordDecl *Record = dyn_cast<CXXRecordDecl>(ND);
118   if (!Record)
119     return false;
120 
121   return Record->isLambda();
122 }
123 
124 static const unsigned UnknownArity = ~0U;
125 
126 class ItaniumMangleContextImpl : public ItaniumMangleContext {
127   typedef std::pair<const DeclContext*, IdentifierInfo*> DiscriminatorKeyTy;
128   llvm::DenseMap<DiscriminatorKeyTy, unsigned> Discriminator;
129   llvm::DenseMap<const NamedDecl*, unsigned> Uniquifier;
130 
131 public:
132   explicit ItaniumMangleContextImpl(ASTContext &Context,
133                                     DiagnosticsEngine &Diags)
134       : ItaniumMangleContext(Context, Diags) {}
135 
136   /// @name Mangler Entry Points
137   /// @{
138 
139   bool shouldMangleCXXName(const NamedDecl *D) override;
140   bool shouldMangleStringLiteral(const StringLiteral *) override {
141     return false;
142   }
143   void mangleCXXName(const NamedDecl *D, raw_ostream &) override;
144   void mangleThunk(const CXXMethodDecl *MD, const ThunkInfo &Thunk,
145                    raw_ostream &) override;
146   void mangleCXXDtorThunk(const CXXDestructorDecl *DD, CXXDtorType Type,
147                           const ThisAdjustment &ThisAdjustment,
148                           raw_ostream &) override;
149   void mangleReferenceTemporary(const VarDecl *D, unsigned ManglingNumber,
150                                 raw_ostream &) override;
151   void mangleCXXVTable(const CXXRecordDecl *RD, raw_ostream &) override;
152   void mangleCXXVTT(const CXXRecordDecl *RD, raw_ostream &) override;
153   void mangleCXXCtorVTable(const CXXRecordDecl *RD, int64_t Offset,
154                            const CXXRecordDecl *Type, raw_ostream &) override;
155   void mangleCXXRTTI(QualType T, raw_ostream &) override;
156   void mangleCXXRTTIName(QualType T, raw_ostream &) override;
157   void mangleTypeName(QualType T, raw_ostream &) override;
158   void mangleCXXCtor(const CXXConstructorDecl *D, CXXCtorType Type,
159                      raw_ostream &) override;
160   void mangleCXXDtor(const CXXDestructorDecl *D, CXXDtorType Type,
161                      raw_ostream &) override;
162 
163   void mangleCXXCtorComdat(const CXXConstructorDecl *D, raw_ostream &) override;
164   void mangleCXXDtorComdat(const CXXDestructorDecl *D, raw_ostream &) override;
165   void mangleStaticGuardVariable(const VarDecl *D, raw_ostream &) override;
166   void mangleDynamicInitializer(const VarDecl *D, raw_ostream &Out) override;
167   void mangleDynamicAtExitDestructor(const VarDecl *D,
168                                      raw_ostream &Out) override;
169   void mangleSEHFilterExpression(const NamedDecl *EnclosingDecl,
170                                  raw_ostream &Out) override;
171   void mangleSEHFinallyBlock(const NamedDecl *EnclosingDecl,
172                              raw_ostream &Out) override;
173   void mangleItaniumThreadLocalInit(const VarDecl *D, raw_ostream &) override;
174   void mangleItaniumThreadLocalWrapper(const VarDecl *D,
175                                        raw_ostream &) override;
176 
177   void mangleStringLiteral(const StringLiteral *, raw_ostream &) override;
178 
179   bool getNextDiscriminator(const NamedDecl *ND, unsigned &disc) {
180     // Lambda closure types are already numbered.
181     if (isLambda(ND))
182       return false;
183 
184     // Anonymous tags are already numbered.
185     if (const TagDecl *Tag = dyn_cast<TagDecl>(ND)) {
186       if (Tag->getName().empty() && !Tag->getTypedefNameForAnonDecl())
187         return false;
188     }
189 
190     // Use the canonical number for externally visible decls.
191     if (ND->isExternallyVisible()) {
192       unsigned discriminator = getASTContext().getManglingNumber(ND);
193       if (discriminator == 1)
194         return false;
195       disc = discriminator - 2;
196       return true;
197     }
198 
199     // Make up a reasonable number for internal decls.
200     unsigned &discriminator = Uniquifier[ND];
201     if (!discriminator) {
202       const DeclContext *DC = getEffectiveDeclContext(ND);
203       discriminator = ++Discriminator[std::make_pair(DC, ND->getIdentifier())];
204     }
205     if (discriminator == 1)
206       return false;
207     disc = discriminator-2;
208     return true;
209   }
210   /// @}
211 };
212 
213 /// Manage the mangling of a single name.
214 class CXXNameMangler {
215   ItaniumMangleContextImpl &Context;
216   raw_ostream &Out;
217   bool NullOut = false;
218   /// In the "DisableDerivedAbiTags" mode derived ABI tags are not calculated.
219   /// This mode is used when mangler creates another mangler recursively to
220   /// calculate ABI tags for the function return value or the variable type.
221   /// Also it is required to avoid infinite recursion in some cases.
222   bool DisableDerivedAbiTags = false;
223 
224   /// The "structor" is the top-level declaration being mangled, if
225   /// that's not a template specialization; otherwise it's the pattern
226   /// for that specialization.
227   const NamedDecl *Structor;
228   unsigned StructorType;
229 
230   /// The next substitution sequence number.
231   unsigned SeqID;
232 
233   class FunctionTypeDepthState {
234     unsigned Bits;
235 
236     enum { InResultTypeMask = 1 };
237 
238   public:
239     FunctionTypeDepthState() : Bits(0) {}
240 
241     /// The number of function types we're inside.
242     unsigned getDepth() const {
243       return Bits >> 1;
244     }
245 
246     /// True if we're in the return type of the innermost function type.
247     bool isInResultType() const {
248       return Bits & InResultTypeMask;
249     }
250 
251     FunctionTypeDepthState push() {
252       FunctionTypeDepthState tmp = *this;
253       Bits = (Bits & ~InResultTypeMask) + 2;
254       return tmp;
255     }
256 
257     void enterResultType() {
258       Bits |= InResultTypeMask;
259     }
260 
261     void leaveResultType() {
262       Bits &= ~InResultTypeMask;
263     }
264 
265     void pop(FunctionTypeDepthState saved) {
266       assert(getDepth() == saved.getDepth() + 1);
267       Bits = saved.Bits;
268     }
269 
270   } FunctionTypeDepth;
271 
272   // abi_tag is a gcc attribute, taking one or more strings called "tags".
273   // The goal is to annotate against which version of a library an object was
274   // built and to be able to provide backwards compatibility ("dual abi").
275   // For more information see docs/ItaniumMangleAbiTags.rst.
276   typedef SmallVector<StringRef, 4> AbiTagList;
277 
278   // State to gather all implicit and explicit tags used in a mangled name.
279   // Must always have an instance of this while emitting any name to keep
280   // track.
281   class AbiTagState final {
282   public:
283     explicit AbiTagState(AbiTagState *&Head) : LinkHead(Head) {
284       Parent = LinkHead;
285       LinkHead = this;
286     }
287 
288     // No copy, no move.
289     AbiTagState(const AbiTagState &) = delete;
290     AbiTagState &operator=(const AbiTagState &) = delete;
291 
292     ~AbiTagState() { pop(); }
293 
294     void write(raw_ostream &Out, const NamedDecl *ND,
295                const AbiTagList *AdditionalAbiTags) {
296       ND = cast<NamedDecl>(ND->getCanonicalDecl());
297       if (!isa<FunctionDecl>(ND) && !isa<VarDecl>(ND)) {
298         assert(
299             !AdditionalAbiTags &&
300             "only function and variables need a list of additional abi tags");
301         if (const auto *NS = dyn_cast<NamespaceDecl>(ND)) {
302           if (const auto *AbiTag = NS->getAttr<AbiTagAttr>()) {
303             UsedAbiTags.insert(UsedAbiTags.end(), AbiTag->tags().begin(),
304                                AbiTag->tags().end());
305           }
306           // Don't emit abi tags for namespaces.
307           return;
308         }
309       }
310 
311       AbiTagList TagList;
312       if (const auto *AbiTag = ND->getAttr<AbiTagAttr>()) {
313         UsedAbiTags.insert(UsedAbiTags.end(), AbiTag->tags().begin(),
314                            AbiTag->tags().end());
315         TagList.insert(TagList.end(), AbiTag->tags().begin(),
316                        AbiTag->tags().end());
317       }
318 
319       if (AdditionalAbiTags) {
320         UsedAbiTags.insert(UsedAbiTags.end(), AdditionalAbiTags->begin(),
321                            AdditionalAbiTags->end());
322         TagList.insert(TagList.end(), AdditionalAbiTags->begin(),
323                        AdditionalAbiTags->end());
324       }
325 
326       std::sort(TagList.begin(), TagList.end());
327       TagList.erase(std::unique(TagList.begin(), TagList.end()), TagList.end());
328 
329       writeSortedUniqueAbiTags(Out, TagList);
330     }
331 
332     const AbiTagList &getUsedAbiTags() const { return UsedAbiTags; }
333     void setUsedAbiTags(const AbiTagList &AbiTags) {
334       UsedAbiTags = AbiTags;
335     }
336 
337     const AbiTagList &getEmittedAbiTags() const {
338       return EmittedAbiTags;
339     }
340 
341     const AbiTagList &getSortedUniqueUsedAbiTags() {
342       std::sort(UsedAbiTags.begin(), UsedAbiTags.end());
343       UsedAbiTags.erase(std::unique(UsedAbiTags.begin(), UsedAbiTags.end()),
344                         UsedAbiTags.end());
345       return UsedAbiTags;
346     }
347 
348   private:
349     //! All abi tags used implicitly or explicitly.
350     AbiTagList UsedAbiTags;
351     //! All explicit abi tags (i.e. not from namespace).
352     AbiTagList EmittedAbiTags;
353 
354     AbiTagState *&LinkHead;
355     AbiTagState *Parent = nullptr;
356 
357     void pop() {
358       assert(LinkHead == this &&
359              "abi tag link head must point to us on destruction");
360       if (Parent) {
361         Parent->UsedAbiTags.insert(Parent->UsedAbiTags.end(),
362                                    UsedAbiTags.begin(), UsedAbiTags.end());
363         Parent->EmittedAbiTags.insert(Parent->EmittedAbiTags.end(),
364                                       EmittedAbiTags.begin(),
365                                       EmittedAbiTags.end());
366       }
367       LinkHead = Parent;
368     }
369 
370     void writeSortedUniqueAbiTags(raw_ostream &Out, const AbiTagList &AbiTags) {
371       for (const auto &Tag : AbiTags) {
372         EmittedAbiTags.push_back(Tag);
373         Out << "B";
374         Out << Tag.size();
375         Out << Tag;
376       }
377     }
378   };
379 
380   AbiTagState *AbiTags = nullptr;
381   AbiTagState AbiTagsRoot;
382 
383   llvm::DenseMap<uintptr_t, unsigned> Substitutions;
384   llvm::DenseMap<StringRef, unsigned> ModuleSubstitutions;
385 
386   ASTContext &getASTContext() const { return Context.getASTContext(); }
387 
388 public:
389   CXXNameMangler(ItaniumMangleContextImpl &C, raw_ostream &Out_,
390                  const NamedDecl *D = nullptr, bool NullOut_ = false)
391     : Context(C), Out(Out_), NullOut(NullOut_),  Structor(getStructor(D)),
392       StructorType(0), SeqID(0), AbiTagsRoot(AbiTags) {
393     // These can't be mangled without a ctor type or dtor type.
394     assert(!D || (!isa<CXXDestructorDecl>(D) &&
395                   !isa<CXXConstructorDecl>(D)));
396   }
397   CXXNameMangler(ItaniumMangleContextImpl &C, raw_ostream &Out_,
398                  const CXXConstructorDecl *D, CXXCtorType Type)
399     : Context(C), Out(Out_), Structor(getStructor(D)), StructorType(Type),
400       SeqID(0), AbiTagsRoot(AbiTags) { }
401   CXXNameMangler(ItaniumMangleContextImpl &C, raw_ostream &Out_,
402                  const CXXDestructorDecl *D, CXXDtorType Type)
403     : Context(C), Out(Out_), Structor(getStructor(D)), StructorType(Type),
404       SeqID(0), AbiTagsRoot(AbiTags) { }
405 
406   CXXNameMangler(CXXNameMangler &Outer, raw_ostream &Out_)
407       : Context(Outer.Context), Out(Out_), NullOut(false),
408         Structor(Outer.Structor), StructorType(Outer.StructorType),
409         SeqID(Outer.SeqID), FunctionTypeDepth(Outer.FunctionTypeDepth),
410         AbiTagsRoot(AbiTags), Substitutions(Outer.Substitutions) {}
411 
412   CXXNameMangler(CXXNameMangler &Outer, llvm::raw_null_ostream &Out_)
413       : Context(Outer.Context), Out(Out_), NullOut(true),
414         Structor(Outer.Structor), StructorType(Outer.StructorType),
415         SeqID(Outer.SeqID), FunctionTypeDepth(Outer.FunctionTypeDepth),
416         AbiTagsRoot(AbiTags), Substitutions(Outer.Substitutions) {}
417 
418 #if MANGLE_CHECKER
419   ~CXXNameMangler() {
420     if (Out.str()[0] == '\01')
421       return;
422 
423     int status = 0;
424     char *result = abi::__cxa_demangle(Out.str().str().c_str(), 0, 0, &status);
425     assert(status == 0 && "Could not demangle mangled name!");
426     free(result);
427   }
428 #endif
429   raw_ostream &getStream() { return Out; }
430 
431   void disableDerivedAbiTags() { DisableDerivedAbiTags = true; }
432   static bool shouldHaveAbiTags(ItaniumMangleContextImpl &C, const VarDecl *VD);
433 
434   void mangle(const NamedDecl *D);
435   void mangleCallOffset(int64_t NonVirtual, int64_t Virtual);
436   void mangleNumber(const llvm::APSInt &I);
437   void mangleNumber(int64_t Number);
438   void mangleFloat(const llvm::APFloat &F);
439   void mangleFunctionEncoding(const FunctionDecl *FD);
440   void mangleSeqID(unsigned SeqID);
441   void mangleName(const NamedDecl *ND);
442   void mangleType(QualType T);
443   void mangleNameOrStandardSubstitution(const NamedDecl *ND);
444 
445 private:
446 
447   bool mangleSubstitution(const NamedDecl *ND);
448   bool mangleSubstitution(QualType T);
449   bool mangleSubstitution(TemplateName Template);
450   bool mangleSubstitution(uintptr_t Ptr);
451 
452   void mangleExistingSubstitution(TemplateName name);
453 
454   bool mangleStandardSubstitution(const NamedDecl *ND);
455 
456   void addSubstitution(const NamedDecl *ND) {
457     ND = cast<NamedDecl>(ND->getCanonicalDecl());
458 
459     addSubstitution(reinterpret_cast<uintptr_t>(ND));
460   }
461   void addSubstitution(QualType T);
462   void addSubstitution(TemplateName Template);
463   void addSubstitution(uintptr_t Ptr);
464   // Destructive copy substitutions from other mangler.
465   void extendSubstitutions(CXXNameMangler* Other);
466 
467   void mangleUnresolvedPrefix(NestedNameSpecifier *qualifier,
468                               bool recursive = false);
469   void mangleUnresolvedName(NestedNameSpecifier *qualifier,
470                             DeclarationName name,
471                             const TemplateArgumentLoc *TemplateArgs,
472                             unsigned NumTemplateArgs,
473                             unsigned KnownArity = UnknownArity);
474 
475   void mangleFunctionEncodingBareType(const FunctionDecl *FD);
476 
477   void mangleNameWithAbiTags(const NamedDecl *ND,
478                              const AbiTagList *AdditionalAbiTags);
479   void mangleModuleName(const Module *M);
480   void mangleModuleNamePrefix(StringRef Name);
481   void mangleTemplateName(const TemplateDecl *TD,
482                           const TemplateArgument *TemplateArgs,
483                           unsigned NumTemplateArgs);
484   void mangleUnqualifiedName(const NamedDecl *ND,
485                              const AbiTagList *AdditionalAbiTags) {
486     mangleUnqualifiedName(ND, ND->getDeclName(), UnknownArity,
487                           AdditionalAbiTags);
488   }
489   void mangleUnqualifiedName(const NamedDecl *ND, DeclarationName Name,
490                              unsigned KnownArity,
491                              const AbiTagList *AdditionalAbiTags);
492   void mangleUnscopedName(const NamedDecl *ND,
493                           const AbiTagList *AdditionalAbiTags);
494   void mangleUnscopedTemplateName(const TemplateDecl *ND,
495                                   const AbiTagList *AdditionalAbiTags);
496   void mangleUnscopedTemplateName(TemplateName,
497                                   const AbiTagList *AdditionalAbiTags);
498   void mangleSourceName(const IdentifierInfo *II);
499   void mangleRegCallName(const IdentifierInfo *II);
500   void mangleSourceNameWithAbiTags(
501       const NamedDecl *ND, const AbiTagList *AdditionalAbiTags = nullptr);
502   void mangleLocalName(const Decl *D,
503                        const AbiTagList *AdditionalAbiTags);
504   void mangleBlockForPrefix(const BlockDecl *Block);
505   void mangleUnqualifiedBlock(const BlockDecl *Block);
506   void mangleLambda(const CXXRecordDecl *Lambda);
507   void mangleNestedName(const NamedDecl *ND, const DeclContext *DC,
508                         const AbiTagList *AdditionalAbiTags,
509                         bool NoFunction=false);
510   void mangleNestedName(const TemplateDecl *TD,
511                         const TemplateArgument *TemplateArgs,
512                         unsigned NumTemplateArgs);
513   void manglePrefix(NestedNameSpecifier *qualifier);
514   void manglePrefix(const DeclContext *DC, bool NoFunction=false);
515   void manglePrefix(QualType type);
516   void mangleTemplatePrefix(const TemplateDecl *ND, bool NoFunction=false);
517   void mangleTemplatePrefix(TemplateName Template);
518   bool mangleUnresolvedTypeOrSimpleId(QualType DestroyedType,
519                                       StringRef Prefix = "");
520   void mangleOperatorName(DeclarationName Name, unsigned Arity);
521   void mangleOperatorName(OverloadedOperatorKind OO, unsigned Arity);
522   void mangleVendorQualifier(StringRef qualifier);
523   void mangleQualifiers(Qualifiers Quals, const DependentAddressSpaceType *DAST = nullptr);
524   void mangleRefQualifier(RefQualifierKind RefQualifier);
525 
526   void mangleObjCMethodName(const ObjCMethodDecl *MD);
527 
528   // Declare manglers for every type class.
529 #define ABSTRACT_TYPE(CLASS, PARENT)
530 #define NON_CANONICAL_TYPE(CLASS, PARENT)
531 #define TYPE(CLASS, PARENT) void mangleType(const CLASS##Type *T);
532 #include "clang/AST/TypeNodes.def"
533 
534   void mangleType(const TagType*);
535   void mangleType(TemplateName);
536   static StringRef getCallingConvQualifierName(CallingConv CC);
537   void mangleExtParameterInfo(FunctionProtoType::ExtParameterInfo info);
538   void mangleExtFunctionInfo(const FunctionType *T);
539   void mangleBareFunctionType(const FunctionProtoType *T, bool MangleReturnType,
540                               const FunctionDecl *FD = nullptr);
541   void mangleNeonVectorType(const VectorType *T);
542   void mangleAArch64NeonVectorType(const VectorType *T);
543 
544   void mangleIntegerLiteral(QualType T, const llvm::APSInt &Value);
545   void mangleMemberExprBase(const Expr *base, bool isArrow);
546   void mangleMemberExpr(const Expr *base, bool isArrow,
547                         NestedNameSpecifier *qualifier,
548                         NamedDecl *firstQualifierLookup,
549                         DeclarationName name,
550                         const TemplateArgumentLoc *TemplateArgs,
551                         unsigned NumTemplateArgs,
552                         unsigned knownArity);
553   void mangleCastExpression(const Expr *E, StringRef CastEncoding);
554   void mangleInitListElements(const InitListExpr *InitList);
555   void mangleExpression(const Expr *E, unsigned Arity = UnknownArity);
556   void mangleCXXCtorType(CXXCtorType T, const CXXRecordDecl *InheritedFrom);
557   void mangleCXXDtorType(CXXDtorType T);
558 
559   void mangleTemplateArgs(const TemplateArgumentLoc *TemplateArgs,
560                           unsigned NumTemplateArgs);
561   void mangleTemplateArgs(const TemplateArgument *TemplateArgs,
562                           unsigned NumTemplateArgs);
563   void mangleTemplateArgs(const TemplateArgumentList &AL);
564   void mangleTemplateArg(TemplateArgument A);
565 
566   void mangleTemplateParameter(unsigned Index);
567 
568   void mangleFunctionParam(const ParmVarDecl *parm);
569 
570   void writeAbiTags(const NamedDecl *ND,
571                     const AbiTagList *AdditionalAbiTags);
572 
573   // Returns sorted unique list of ABI tags.
574   AbiTagList makeFunctionReturnTypeTags(const FunctionDecl *FD);
575   // Returns sorted unique list of ABI tags.
576   AbiTagList makeVariableTypeTags(const VarDecl *VD);
577 };
578 
579 }
580 
581 bool ItaniumMangleContextImpl::shouldMangleCXXName(const NamedDecl *D) {
582   const FunctionDecl *FD = dyn_cast<FunctionDecl>(D);
583   if (FD) {
584     LanguageLinkage L = FD->getLanguageLinkage();
585     // Overloadable functions need mangling.
586     if (FD->hasAttr<OverloadableAttr>())
587       return true;
588 
589     // "main" is not mangled.
590     if (FD->isMain())
591       return false;
592 
593     // C++ functions and those whose names are not a simple identifier need
594     // mangling.
595     if (!FD->getDeclName().isIdentifier() || L == CXXLanguageLinkage)
596       return true;
597 
598     // C functions are not mangled.
599     if (L == CLanguageLinkage)
600       return false;
601   }
602 
603   // Otherwise, no mangling is done outside C++ mode.
604   if (!getASTContext().getLangOpts().CPlusPlus)
605     return false;
606 
607   const VarDecl *VD = dyn_cast<VarDecl>(D);
608   if (VD && !isa<DecompositionDecl>(D)) {
609     // C variables are not mangled.
610     if (VD->isExternC())
611       return false;
612 
613     // Variables at global scope with non-internal linkage are not mangled
614     const DeclContext *DC = getEffectiveDeclContext(D);
615     // Check for extern variable declared locally.
616     if (DC->isFunctionOrMethod() && D->hasLinkage())
617       while (!DC->isNamespace() && !DC->isTranslationUnit())
618         DC = getEffectiveParentContext(DC);
619     if (DC->isTranslationUnit() && D->getFormalLinkage() != InternalLinkage &&
620         !CXXNameMangler::shouldHaveAbiTags(*this, VD) &&
621         !isa<VarTemplateSpecializationDecl>(D))
622       return false;
623   }
624 
625   return true;
626 }
627 
628 void CXXNameMangler::writeAbiTags(const NamedDecl *ND,
629                                   const AbiTagList *AdditionalAbiTags) {
630   assert(AbiTags && "require AbiTagState");
631   AbiTags->write(Out, ND, DisableDerivedAbiTags ? nullptr : AdditionalAbiTags);
632 }
633 
634 void CXXNameMangler::mangleSourceNameWithAbiTags(
635     const NamedDecl *ND, const AbiTagList *AdditionalAbiTags) {
636   mangleSourceName(ND->getIdentifier());
637   writeAbiTags(ND, AdditionalAbiTags);
638 }
639 
640 void CXXNameMangler::mangle(const NamedDecl *D) {
641   // <mangled-name> ::= _Z <encoding>
642   //            ::= <data name>
643   //            ::= <special-name>
644   Out << "_Z";
645   if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
646     mangleFunctionEncoding(FD);
647   else if (const VarDecl *VD = dyn_cast<VarDecl>(D))
648     mangleName(VD);
649   else if (const IndirectFieldDecl *IFD = dyn_cast<IndirectFieldDecl>(D))
650     mangleName(IFD->getAnonField());
651   else
652     mangleName(cast<FieldDecl>(D));
653 }
654 
655 void CXXNameMangler::mangleFunctionEncoding(const FunctionDecl *FD) {
656   // <encoding> ::= <function name> <bare-function-type>
657 
658   // Don't mangle in the type if this isn't a decl we should typically mangle.
659   if (!Context.shouldMangleDeclName(FD)) {
660     mangleName(FD);
661     return;
662   }
663 
664   AbiTagList ReturnTypeAbiTags = makeFunctionReturnTypeTags(FD);
665   if (ReturnTypeAbiTags.empty()) {
666     // There are no tags for return type, the simplest case.
667     mangleName(FD);
668     mangleFunctionEncodingBareType(FD);
669     return;
670   }
671 
672   // Mangle function name and encoding to temporary buffer.
673   // We have to output name and encoding to the same mangler to get the same
674   // substitution as it will be in final mangling.
675   SmallString<256> FunctionEncodingBuf;
676   llvm::raw_svector_ostream FunctionEncodingStream(FunctionEncodingBuf);
677   CXXNameMangler FunctionEncodingMangler(*this, FunctionEncodingStream);
678   // Output name of the function.
679   FunctionEncodingMangler.disableDerivedAbiTags();
680   FunctionEncodingMangler.mangleNameWithAbiTags(FD, nullptr);
681 
682   // Remember length of the function name in the buffer.
683   size_t EncodingPositionStart = FunctionEncodingStream.str().size();
684   FunctionEncodingMangler.mangleFunctionEncodingBareType(FD);
685 
686   // Get tags from return type that are not present in function name or
687   // encoding.
688   const AbiTagList &UsedAbiTags =
689       FunctionEncodingMangler.AbiTagsRoot.getSortedUniqueUsedAbiTags();
690   AbiTagList AdditionalAbiTags(ReturnTypeAbiTags.size());
691   AdditionalAbiTags.erase(
692       std::set_difference(ReturnTypeAbiTags.begin(), ReturnTypeAbiTags.end(),
693                           UsedAbiTags.begin(), UsedAbiTags.end(),
694                           AdditionalAbiTags.begin()),
695       AdditionalAbiTags.end());
696 
697   // Output name with implicit tags and function encoding from temporary buffer.
698   mangleNameWithAbiTags(FD, &AdditionalAbiTags);
699   Out << FunctionEncodingStream.str().substr(EncodingPositionStart);
700 
701   // Function encoding could create new substitutions so we have to add
702   // temp mangled substitutions to main mangler.
703   extendSubstitutions(&FunctionEncodingMangler);
704 }
705 
706 void CXXNameMangler::mangleFunctionEncodingBareType(const FunctionDecl *FD) {
707   if (FD->hasAttr<EnableIfAttr>()) {
708     FunctionTypeDepthState Saved = FunctionTypeDepth.push();
709     Out << "Ua9enable_ifI";
710     // FIXME: specific_attr_iterator iterates in reverse order. Fix that and use
711     // it here.
712     for (AttrVec::const_reverse_iterator I = FD->getAttrs().rbegin(),
713                                          E = FD->getAttrs().rend();
714          I != E; ++I) {
715       EnableIfAttr *EIA = dyn_cast<EnableIfAttr>(*I);
716       if (!EIA)
717         continue;
718       Out << 'X';
719       mangleExpression(EIA->getCond());
720       Out << 'E';
721     }
722     Out << 'E';
723     FunctionTypeDepth.pop(Saved);
724   }
725 
726   // When mangling an inheriting constructor, the bare function type used is
727   // that of the inherited constructor.
728   if (auto *CD = dyn_cast<CXXConstructorDecl>(FD))
729     if (auto Inherited = CD->getInheritedConstructor())
730       FD = Inherited.getConstructor();
731 
732   // Whether the mangling of a function type includes the return type depends on
733   // the context and the nature of the function. The rules for deciding whether
734   // the return type is included are:
735   //
736   //   1. Template functions (names or types) have return types encoded, with
737   //   the exceptions listed below.
738   //   2. Function types not appearing as part of a function name mangling,
739   //   e.g. parameters, pointer types, etc., have return type encoded, with the
740   //   exceptions listed below.
741   //   3. Non-template function names do not have return types encoded.
742   //
743   // The exceptions mentioned in (1) and (2) above, for which the return type is
744   // never included, are
745   //   1. Constructors.
746   //   2. Destructors.
747   //   3. Conversion operator functions, e.g. operator int.
748   bool MangleReturnType = false;
749   if (FunctionTemplateDecl *PrimaryTemplate = FD->getPrimaryTemplate()) {
750     if (!(isa<CXXConstructorDecl>(FD) || isa<CXXDestructorDecl>(FD) ||
751           isa<CXXConversionDecl>(FD)))
752       MangleReturnType = true;
753 
754     // Mangle the type of the primary template.
755     FD = PrimaryTemplate->getTemplatedDecl();
756   }
757 
758   mangleBareFunctionType(FD->getType()->castAs<FunctionProtoType>(),
759                          MangleReturnType, FD);
760 }
761 
762 static const DeclContext *IgnoreLinkageSpecDecls(const DeclContext *DC) {
763   while (isa<LinkageSpecDecl>(DC)) {
764     DC = getEffectiveParentContext(DC);
765   }
766 
767   return DC;
768 }
769 
770 /// Return whether a given namespace is the 'std' namespace.
771 static bool isStd(const NamespaceDecl *NS) {
772   if (!IgnoreLinkageSpecDecls(getEffectiveParentContext(NS))
773                                 ->isTranslationUnit())
774     return false;
775 
776   const IdentifierInfo *II = NS->getOriginalNamespace()->getIdentifier();
777   return II && II->isStr("std");
778 }
779 
780 // isStdNamespace - Return whether a given decl context is a toplevel 'std'
781 // namespace.
782 static bool isStdNamespace(const DeclContext *DC) {
783   if (!DC->isNamespace())
784     return false;
785 
786   return isStd(cast<NamespaceDecl>(DC));
787 }
788 
789 static const TemplateDecl *
790 isTemplate(const NamedDecl *ND, const TemplateArgumentList *&TemplateArgs) {
791   // Check if we have a function template.
792   if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)) {
793     if (const TemplateDecl *TD = FD->getPrimaryTemplate()) {
794       TemplateArgs = FD->getTemplateSpecializationArgs();
795       return TD;
796     }
797   }
798 
799   // Check if we have a class template.
800   if (const ClassTemplateSpecializationDecl *Spec =
801         dyn_cast<ClassTemplateSpecializationDecl>(ND)) {
802     TemplateArgs = &Spec->getTemplateArgs();
803     return Spec->getSpecializedTemplate();
804   }
805 
806   // Check if we have a variable template.
807   if (const VarTemplateSpecializationDecl *Spec =
808           dyn_cast<VarTemplateSpecializationDecl>(ND)) {
809     TemplateArgs = &Spec->getTemplateArgs();
810     return Spec->getSpecializedTemplate();
811   }
812 
813   return nullptr;
814 }
815 
816 void CXXNameMangler::mangleName(const NamedDecl *ND) {
817   if (const VarDecl *VD = dyn_cast<VarDecl>(ND)) {
818     // Variables should have implicit tags from its type.
819     AbiTagList VariableTypeAbiTags = makeVariableTypeTags(VD);
820     if (VariableTypeAbiTags.empty()) {
821       // Simple case no variable type tags.
822       mangleNameWithAbiTags(VD, nullptr);
823       return;
824     }
825 
826     // Mangle variable name to null stream to collect tags.
827     llvm::raw_null_ostream NullOutStream;
828     CXXNameMangler VariableNameMangler(*this, NullOutStream);
829     VariableNameMangler.disableDerivedAbiTags();
830     VariableNameMangler.mangleNameWithAbiTags(VD, nullptr);
831 
832     // Get tags from variable type that are not present in its name.
833     const AbiTagList &UsedAbiTags =
834         VariableNameMangler.AbiTagsRoot.getSortedUniqueUsedAbiTags();
835     AbiTagList AdditionalAbiTags(VariableTypeAbiTags.size());
836     AdditionalAbiTags.erase(
837         std::set_difference(VariableTypeAbiTags.begin(),
838                             VariableTypeAbiTags.end(), UsedAbiTags.begin(),
839                             UsedAbiTags.end(), AdditionalAbiTags.begin()),
840         AdditionalAbiTags.end());
841 
842     // Output name with implicit tags.
843     mangleNameWithAbiTags(VD, &AdditionalAbiTags);
844   } else {
845     mangleNameWithAbiTags(ND, nullptr);
846   }
847 }
848 
849 void CXXNameMangler::mangleNameWithAbiTags(const NamedDecl *ND,
850                                            const AbiTagList *AdditionalAbiTags) {
851   //  <name> ::= [<module-name>] <nested-name>
852   //         ::= [<module-name>] <unscoped-name>
853   //         ::= [<module-name>] <unscoped-template-name> <template-args>
854   //         ::= <local-name>
855   //
856   const DeclContext *DC = getEffectiveDeclContext(ND);
857 
858   // If this is an extern variable declared locally, the relevant DeclContext
859   // is that of the containing namespace, or the translation unit.
860   // FIXME: This is a hack; extern variables declared locally should have
861   // a proper semantic declaration context!
862   if (isLocalContainerContext(DC) && ND->hasLinkage() && !isLambda(ND))
863     while (!DC->isNamespace() && !DC->isTranslationUnit())
864       DC = getEffectiveParentContext(DC);
865   else if (GetLocalClassDecl(ND)) {
866     mangleLocalName(ND, AdditionalAbiTags);
867     return;
868   }
869 
870   DC = IgnoreLinkageSpecDecls(DC);
871 
872   if (isLocalContainerContext(DC)) {
873     mangleLocalName(ND, AdditionalAbiTags);
874     return;
875   }
876 
877   // Do not mangle the owning module for an external linkage declaration.
878   // This enables backwards-compatibility with non-modular code, and is
879   // a valid choice since conflicts are not permitted by C++ Modules TS
880   // [basic.def.odr]/6.2.
881   if (!ND->hasExternalFormalLinkage())
882     if (Module *M = ND->getOwningModuleForLinkage())
883       mangleModuleName(M);
884 
885   if (DC->isTranslationUnit() || isStdNamespace(DC)) {
886     // Check if we have a template.
887     const TemplateArgumentList *TemplateArgs = nullptr;
888     if (const TemplateDecl *TD = isTemplate(ND, TemplateArgs)) {
889       mangleUnscopedTemplateName(TD, AdditionalAbiTags);
890       mangleTemplateArgs(*TemplateArgs);
891       return;
892     }
893 
894     mangleUnscopedName(ND, AdditionalAbiTags);
895     return;
896   }
897 
898   mangleNestedName(ND, DC, AdditionalAbiTags);
899 }
900 
901 void CXXNameMangler::mangleModuleName(const Module *M) {
902   // Implement the C++ Modules TS name mangling proposal; see
903   //     https://gcc.gnu.org/wiki/cxx-modules?action=AttachFile
904   //
905   //   <module-name> ::= W <unscoped-name>+ E
906   //                 ::= W <module-subst> <unscoped-name>* E
907   Out << 'W';
908   mangleModuleNamePrefix(M->Name);
909   Out << 'E';
910 }
911 
912 void CXXNameMangler::mangleModuleNamePrefix(StringRef Name) {
913   //  <module-subst> ::= _ <seq-id>          # 0 < seq-id < 10
914   //                 ::= W <seq-id - 10> _   # otherwise
915   auto It = ModuleSubstitutions.find(Name);
916   if (It != ModuleSubstitutions.end()) {
917     if (It->second < 10)
918       Out << '_' << static_cast<char>('0' + It->second);
919     else
920       Out << 'W' << (It->second - 10) << '_';
921     return;
922   }
923 
924   // FIXME: Preserve hierarchy in module names rather than flattening
925   // them to strings; use Module*s as substitution keys.
926   auto Parts = Name.rsplit('.');
927   if (Parts.second.empty())
928     Parts.second = Parts.first;
929   else
930     mangleModuleNamePrefix(Parts.first);
931 
932   Out << Parts.second.size() << Parts.second;
933   ModuleSubstitutions.insert({Name, ModuleSubstitutions.size()});
934 }
935 
936 void CXXNameMangler::mangleTemplateName(const TemplateDecl *TD,
937                                         const TemplateArgument *TemplateArgs,
938                                         unsigned NumTemplateArgs) {
939   const DeclContext *DC = IgnoreLinkageSpecDecls(getEffectiveDeclContext(TD));
940 
941   if (DC->isTranslationUnit() || isStdNamespace(DC)) {
942     mangleUnscopedTemplateName(TD, nullptr);
943     mangleTemplateArgs(TemplateArgs, NumTemplateArgs);
944   } else {
945     mangleNestedName(TD, TemplateArgs, NumTemplateArgs);
946   }
947 }
948 
949 void CXXNameMangler::mangleUnscopedName(const NamedDecl *ND,
950                                         const AbiTagList *AdditionalAbiTags) {
951   //  <unscoped-name> ::= <unqualified-name>
952   //                  ::= St <unqualified-name>   # ::std::
953 
954   if (isStdNamespace(IgnoreLinkageSpecDecls(getEffectiveDeclContext(ND))))
955     Out << "St";
956 
957   mangleUnqualifiedName(ND, AdditionalAbiTags);
958 }
959 
960 void CXXNameMangler::mangleUnscopedTemplateName(
961     const TemplateDecl *ND, const AbiTagList *AdditionalAbiTags) {
962   //     <unscoped-template-name> ::= <unscoped-name>
963   //                              ::= <substitution>
964   if (mangleSubstitution(ND))
965     return;
966 
967   // <template-template-param> ::= <template-param>
968   if (const auto *TTP = dyn_cast<TemplateTemplateParmDecl>(ND)) {
969     assert(!AdditionalAbiTags &&
970            "template template param cannot have abi tags");
971     mangleTemplateParameter(TTP->getIndex());
972   } else if (isa<BuiltinTemplateDecl>(ND)) {
973     mangleUnscopedName(ND, AdditionalAbiTags);
974   } else {
975     mangleUnscopedName(ND->getTemplatedDecl(), AdditionalAbiTags);
976   }
977 
978   addSubstitution(ND);
979 }
980 
981 void CXXNameMangler::mangleUnscopedTemplateName(
982     TemplateName Template, const AbiTagList *AdditionalAbiTags) {
983   //     <unscoped-template-name> ::= <unscoped-name>
984   //                              ::= <substitution>
985   if (TemplateDecl *TD = Template.getAsTemplateDecl())
986     return mangleUnscopedTemplateName(TD, AdditionalAbiTags);
987 
988   if (mangleSubstitution(Template))
989     return;
990 
991   assert(!AdditionalAbiTags &&
992          "dependent template name cannot have abi tags");
993 
994   DependentTemplateName *Dependent = Template.getAsDependentTemplateName();
995   assert(Dependent && "Not a dependent template name?");
996   if (const IdentifierInfo *Id = Dependent->getIdentifier())
997     mangleSourceName(Id);
998   else
999     mangleOperatorName(Dependent->getOperator(), UnknownArity);
1000 
1001   addSubstitution(Template);
1002 }
1003 
1004 void CXXNameMangler::mangleFloat(const llvm::APFloat &f) {
1005   // ABI:
1006   //   Floating-point literals are encoded using a fixed-length
1007   //   lowercase hexadecimal string corresponding to the internal
1008   //   representation (IEEE on Itanium), high-order bytes first,
1009   //   without leading zeroes. For example: "Lf bf800000 E" is -1.0f
1010   //   on Itanium.
1011   // The 'without leading zeroes' thing seems to be an editorial
1012   // mistake; see the discussion on cxx-abi-dev beginning on
1013   // 2012-01-16.
1014 
1015   // Our requirements here are just barely weird enough to justify
1016   // using a custom algorithm instead of post-processing APInt::toString().
1017 
1018   llvm::APInt valueBits = f.bitcastToAPInt();
1019   unsigned numCharacters = (valueBits.getBitWidth() + 3) / 4;
1020   assert(numCharacters != 0);
1021 
1022   // Allocate a buffer of the right number of characters.
1023   SmallVector<char, 20> buffer(numCharacters);
1024 
1025   // Fill the buffer left-to-right.
1026   for (unsigned stringIndex = 0; stringIndex != numCharacters; ++stringIndex) {
1027     // The bit-index of the next hex digit.
1028     unsigned digitBitIndex = 4 * (numCharacters - stringIndex - 1);
1029 
1030     // Project out 4 bits starting at 'digitIndex'.
1031     uint64_t hexDigit = valueBits.getRawData()[digitBitIndex / 64];
1032     hexDigit >>= (digitBitIndex % 64);
1033     hexDigit &= 0xF;
1034 
1035     // Map that over to a lowercase hex digit.
1036     static const char charForHex[16] = {
1037       '0', '1', '2', '3', '4', '5', '6', '7',
1038       '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'
1039     };
1040     buffer[stringIndex] = charForHex[hexDigit];
1041   }
1042 
1043   Out.write(buffer.data(), numCharacters);
1044 }
1045 
1046 void CXXNameMangler::mangleNumber(const llvm::APSInt &Value) {
1047   if (Value.isSigned() && Value.isNegative()) {
1048     Out << 'n';
1049     Value.abs().print(Out, /*signed*/ false);
1050   } else {
1051     Value.print(Out, /*signed*/ false);
1052   }
1053 }
1054 
1055 void CXXNameMangler::mangleNumber(int64_t Number) {
1056   //  <number> ::= [n] <non-negative decimal integer>
1057   if (Number < 0) {
1058     Out << 'n';
1059     Number = -Number;
1060   }
1061 
1062   Out << Number;
1063 }
1064 
1065 void CXXNameMangler::mangleCallOffset(int64_t NonVirtual, int64_t Virtual) {
1066   //  <call-offset>  ::= h <nv-offset> _
1067   //                 ::= v <v-offset> _
1068   //  <nv-offset>    ::= <offset number>        # non-virtual base override
1069   //  <v-offset>     ::= <offset number> _ <virtual offset number>
1070   //                      # virtual base override, with vcall offset
1071   if (!Virtual) {
1072     Out << 'h';
1073     mangleNumber(NonVirtual);
1074     Out << '_';
1075     return;
1076   }
1077 
1078   Out << 'v';
1079   mangleNumber(NonVirtual);
1080   Out << '_';
1081   mangleNumber(Virtual);
1082   Out << '_';
1083 }
1084 
1085 void CXXNameMangler::manglePrefix(QualType type) {
1086   if (const auto *TST = type->getAs<TemplateSpecializationType>()) {
1087     if (!mangleSubstitution(QualType(TST, 0))) {
1088       mangleTemplatePrefix(TST->getTemplateName());
1089 
1090       // FIXME: GCC does not appear to mangle the template arguments when
1091       // the template in question is a dependent template name. Should we
1092       // emulate that badness?
1093       mangleTemplateArgs(TST->getArgs(), TST->getNumArgs());
1094       addSubstitution(QualType(TST, 0));
1095     }
1096   } else if (const auto *DTST =
1097                  type->getAs<DependentTemplateSpecializationType>()) {
1098     if (!mangleSubstitution(QualType(DTST, 0))) {
1099       TemplateName Template = getASTContext().getDependentTemplateName(
1100           DTST->getQualifier(), DTST->getIdentifier());
1101       mangleTemplatePrefix(Template);
1102 
1103       // FIXME: GCC does not appear to mangle the template arguments when
1104       // the template in question is a dependent template name. Should we
1105       // emulate that badness?
1106       mangleTemplateArgs(DTST->getArgs(), DTST->getNumArgs());
1107       addSubstitution(QualType(DTST, 0));
1108     }
1109   } else {
1110     // We use the QualType mangle type variant here because it handles
1111     // substitutions.
1112     mangleType(type);
1113   }
1114 }
1115 
1116 /// Mangle everything prior to the base-unresolved-name in an unresolved-name.
1117 ///
1118 /// \param recursive - true if this is being called recursively,
1119 ///   i.e. if there is more prefix "to the right".
1120 void CXXNameMangler::mangleUnresolvedPrefix(NestedNameSpecifier *qualifier,
1121                                             bool recursive) {
1122 
1123   // x, ::x
1124   // <unresolved-name> ::= [gs] <base-unresolved-name>
1125 
1126   // T::x / decltype(p)::x
1127   // <unresolved-name> ::= sr <unresolved-type> <base-unresolved-name>
1128 
1129   // T::N::x /decltype(p)::N::x
1130   // <unresolved-name> ::= srN <unresolved-type> <unresolved-qualifier-level>+ E
1131   //                       <base-unresolved-name>
1132 
1133   // A::x, N::y, A<T>::z; "gs" means leading "::"
1134   // <unresolved-name> ::= [gs] sr <unresolved-qualifier-level>+ E
1135   //                       <base-unresolved-name>
1136 
1137   switch (qualifier->getKind()) {
1138   case NestedNameSpecifier::Global:
1139     Out << "gs";
1140 
1141     // We want an 'sr' unless this is the entire NNS.
1142     if (recursive)
1143       Out << "sr";
1144 
1145     // We never want an 'E' here.
1146     return;
1147 
1148   case NestedNameSpecifier::Super:
1149     llvm_unreachable("Can't mangle __super specifier");
1150 
1151   case NestedNameSpecifier::Namespace:
1152     if (qualifier->getPrefix())
1153       mangleUnresolvedPrefix(qualifier->getPrefix(),
1154                              /*recursive*/ true);
1155     else
1156       Out << "sr";
1157     mangleSourceNameWithAbiTags(qualifier->getAsNamespace());
1158     break;
1159   case NestedNameSpecifier::NamespaceAlias:
1160     if (qualifier->getPrefix())
1161       mangleUnresolvedPrefix(qualifier->getPrefix(),
1162                              /*recursive*/ true);
1163     else
1164       Out << "sr";
1165     mangleSourceNameWithAbiTags(qualifier->getAsNamespaceAlias());
1166     break;
1167 
1168   case NestedNameSpecifier::TypeSpec:
1169   case NestedNameSpecifier::TypeSpecWithTemplate: {
1170     const Type *type = qualifier->getAsType();
1171 
1172     // We only want to use an unresolved-type encoding if this is one of:
1173     //   - a decltype
1174     //   - a template type parameter
1175     //   - a template template parameter with arguments
1176     // In all of these cases, we should have no prefix.
1177     if (qualifier->getPrefix()) {
1178       mangleUnresolvedPrefix(qualifier->getPrefix(),
1179                              /*recursive*/ true);
1180     } else {
1181       // Otherwise, all the cases want this.
1182       Out << "sr";
1183     }
1184 
1185     if (mangleUnresolvedTypeOrSimpleId(QualType(type, 0), recursive ? "N" : ""))
1186       return;
1187 
1188     break;
1189   }
1190 
1191   case NestedNameSpecifier::Identifier:
1192     // Member expressions can have these without prefixes.
1193     if (qualifier->getPrefix())
1194       mangleUnresolvedPrefix(qualifier->getPrefix(),
1195                              /*recursive*/ true);
1196     else
1197       Out << "sr";
1198 
1199     mangleSourceName(qualifier->getAsIdentifier());
1200     // An Identifier has no type information, so we can't emit abi tags for it.
1201     break;
1202   }
1203 
1204   // If this was the innermost part of the NNS, and we fell out to
1205   // here, append an 'E'.
1206   if (!recursive)
1207     Out << 'E';
1208 }
1209 
1210 /// Mangle an unresolved-name, which is generally used for names which
1211 /// weren't resolved to specific entities.
1212 void CXXNameMangler::mangleUnresolvedName(
1213     NestedNameSpecifier *qualifier, DeclarationName name,
1214     const TemplateArgumentLoc *TemplateArgs, unsigned NumTemplateArgs,
1215     unsigned knownArity) {
1216   if (qualifier) mangleUnresolvedPrefix(qualifier);
1217   switch (name.getNameKind()) {
1218     // <base-unresolved-name> ::= <simple-id>
1219     case DeclarationName::Identifier:
1220       mangleSourceName(name.getAsIdentifierInfo());
1221       break;
1222     // <base-unresolved-name> ::= dn <destructor-name>
1223     case DeclarationName::CXXDestructorName:
1224       Out << "dn";
1225       mangleUnresolvedTypeOrSimpleId(name.getCXXNameType());
1226       break;
1227     // <base-unresolved-name> ::= on <operator-name>
1228     case DeclarationName::CXXConversionFunctionName:
1229     case DeclarationName::CXXLiteralOperatorName:
1230     case DeclarationName::CXXOperatorName:
1231       Out << "on";
1232       mangleOperatorName(name, knownArity);
1233       break;
1234     case DeclarationName::CXXConstructorName:
1235       llvm_unreachable("Can't mangle a constructor name!");
1236     case DeclarationName::CXXUsingDirective:
1237       llvm_unreachable("Can't mangle a using directive name!");
1238     case DeclarationName::CXXDeductionGuideName:
1239       llvm_unreachable("Can't mangle a deduction guide name!");
1240     case DeclarationName::ObjCMultiArgSelector:
1241     case DeclarationName::ObjCOneArgSelector:
1242     case DeclarationName::ObjCZeroArgSelector:
1243       llvm_unreachable("Can't mangle Objective-C selector names here!");
1244   }
1245 
1246   // The <simple-id> and on <operator-name> productions end in an optional
1247   // <template-args>.
1248   if (TemplateArgs)
1249     mangleTemplateArgs(TemplateArgs, NumTemplateArgs);
1250 }
1251 
1252 void CXXNameMangler::mangleUnqualifiedName(const NamedDecl *ND,
1253                                            DeclarationName Name,
1254                                            unsigned KnownArity,
1255                                            const AbiTagList *AdditionalAbiTags) {
1256   unsigned Arity = KnownArity;
1257   //  <unqualified-name> ::= <operator-name>
1258   //                     ::= <ctor-dtor-name>
1259   //                     ::= <source-name>
1260   switch (Name.getNameKind()) {
1261   case DeclarationName::Identifier: {
1262     const IdentifierInfo *II = Name.getAsIdentifierInfo();
1263 
1264     // We mangle decomposition declarations as the names of their bindings.
1265     if (auto *DD = dyn_cast<DecompositionDecl>(ND)) {
1266       // FIXME: Non-standard mangling for decomposition declarations:
1267       //
1268       //  <unqualified-name> ::= DC <source-name>* E
1269       //
1270       // These can never be referenced across translation units, so we do
1271       // not need a cross-vendor mangling for anything other than demanglers.
1272       // Proposed on cxx-abi-dev on 2016-08-12
1273       Out << "DC";
1274       for (auto *BD : DD->bindings())
1275         mangleSourceName(BD->getDeclName().getAsIdentifierInfo());
1276       Out << 'E';
1277       writeAbiTags(ND, AdditionalAbiTags);
1278       break;
1279     }
1280 
1281     if (II) {
1282       // Match GCC's naming convention for internal linkage symbols, for
1283       // symbols that are not actually visible outside of this TU. GCC
1284       // distinguishes between internal and external linkage symbols in
1285       // its mangling, to support cases like this that were valid C++ prior
1286       // to DR426:
1287       //
1288       //   void test() { extern void foo(); }
1289       //   static void foo();
1290       //
1291       // Don't bother with the L marker for names in anonymous namespaces; the
1292       // 12_GLOBAL__N_1 mangling is quite sufficient there, and this better
1293       // matches GCC anyway, because GCC does not treat anonymous namespaces as
1294       // implying internal linkage.
1295       if (ND && ND->getFormalLinkage() == InternalLinkage &&
1296           !ND->isExternallyVisible() &&
1297           getEffectiveDeclContext(ND)->isFileContext() &&
1298           !ND->isInAnonymousNamespace())
1299         Out << 'L';
1300 
1301       auto *FD = dyn_cast<FunctionDecl>(ND);
1302       bool IsRegCall = FD &&
1303                        FD->getType()->castAs<FunctionType>()->getCallConv() ==
1304                            clang::CC_X86RegCall;
1305       if (IsRegCall)
1306         mangleRegCallName(II);
1307       else
1308         mangleSourceName(II);
1309 
1310       writeAbiTags(ND, AdditionalAbiTags);
1311       break;
1312     }
1313 
1314     // Otherwise, an anonymous entity.  We must have a declaration.
1315     assert(ND && "mangling empty name without declaration");
1316 
1317     if (const NamespaceDecl *NS = dyn_cast<NamespaceDecl>(ND)) {
1318       if (NS->isAnonymousNamespace()) {
1319         // This is how gcc mangles these names.
1320         Out << "12_GLOBAL__N_1";
1321         break;
1322       }
1323     }
1324 
1325     if (const VarDecl *VD = dyn_cast<VarDecl>(ND)) {
1326       // We must have an anonymous union or struct declaration.
1327       const RecordDecl *RD =
1328         cast<RecordDecl>(VD->getType()->getAs<RecordType>()->getDecl());
1329 
1330       // Itanium C++ ABI 5.1.2:
1331       //
1332       //   For the purposes of mangling, the name of an anonymous union is
1333       //   considered to be the name of the first named data member found by a
1334       //   pre-order, depth-first, declaration-order walk of the data members of
1335       //   the anonymous union. If there is no such data member (i.e., if all of
1336       //   the data members in the union are unnamed), then there is no way for
1337       //   a program to refer to the anonymous union, and there is therefore no
1338       //   need to mangle its name.
1339       assert(RD->isAnonymousStructOrUnion()
1340              && "Expected anonymous struct or union!");
1341       const FieldDecl *FD = RD->findFirstNamedDataMember();
1342 
1343       // It's actually possible for various reasons for us to get here
1344       // with an empty anonymous struct / union.  Fortunately, it
1345       // doesn't really matter what name we generate.
1346       if (!FD) break;
1347       assert(FD->getIdentifier() && "Data member name isn't an identifier!");
1348 
1349       mangleSourceName(FD->getIdentifier());
1350       // Not emitting abi tags: internal name anyway.
1351       break;
1352     }
1353 
1354     // Class extensions have no name as a category, and it's possible
1355     // for them to be the semantic parent of certain declarations
1356     // (primarily, tag decls defined within declarations).  Such
1357     // declarations will always have internal linkage, so the name
1358     // doesn't really matter, but we shouldn't crash on them.  For
1359     // safety, just handle all ObjC containers here.
1360     if (isa<ObjCContainerDecl>(ND))
1361       break;
1362 
1363     // We must have an anonymous struct.
1364     const TagDecl *TD = cast<TagDecl>(ND);
1365     if (const TypedefNameDecl *D = TD->getTypedefNameForAnonDecl()) {
1366       assert(TD->getDeclContext() == D->getDeclContext() &&
1367              "Typedef should not be in another decl context!");
1368       assert(D->getDeclName().getAsIdentifierInfo() &&
1369              "Typedef was not named!");
1370       mangleSourceName(D->getDeclName().getAsIdentifierInfo());
1371       assert(!AdditionalAbiTags && "Type cannot have additional abi tags");
1372       // Explicit abi tags are still possible; take from underlying type, not
1373       // from typedef.
1374       writeAbiTags(TD, nullptr);
1375       break;
1376     }
1377 
1378     // <unnamed-type-name> ::= <closure-type-name>
1379     //
1380     // <closure-type-name> ::= Ul <lambda-sig> E [ <nonnegative number> ] _
1381     // <lambda-sig> ::= <parameter-type>+   # Parameter types or 'v' for 'void'.
1382     if (const CXXRecordDecl *Record = dyn_cast<CXXRecordDecl>(TD)) {
1383       if (Record->isLambda() && Record->getLambdaManglingNumber()) {
1384         assert(!AdditionalAbiTags &&
1385                "Lambda type cannot have additional abi tags");
1386         mangleLambda(Record);
1387         break;
1388       }
1389     }
1390 
1391     if (TD->isExternallyVisible()) {
1392       unsigned UnnamedMangle = getASTContext().getManglingNumber(TD);
1393       Out << "Ut";
1394       if (UnnamedMangle > 1)
1395         Out << UnnamedMangle - 2;
1396       Out << '_';
1397       writeAbiTags(TD, AdditionalAbiTags);
1398       break;
1399     }
1400 
1401     // Get a unique id for the anonymous struct. If it is not a real output
1402     // ID doesn't matter so use fake one.
1403     unsigned AnonStructId = NullOut ? 0 : Context.getAnonymousStructId(TD);
1404 
1405     // Mangle it as a source name in the form
1406     // [n] $_<id>
1407     // where n is the length of the string.
1408     SmallString<8> Str;
1409     Str += "$_";
1410     Str += llvm::utostr(AnonStructId);
1411 
1412     Out << Str.size();
1413     Out << Str;
1414     break;
1415   }
1416 
1417   case DeclarationName::ObjCZeroArgSelector:
1418   case DeclarationName::ObjCOneArgSelector:
1419   case DeclarationName::ObjCMultiArgSelector:
1420     llvm_unreachable("Can't mangle Objective-C selector names here!");
1421 
1422   case DeclarationName::CXXConstructorName: {
1423     const CXXRecordDecl *InheritedFrom = nullptr;
1424     const TemplateArgumentList *InheritedTemplateArgs = nullptr;
1425     if (auto Inherited =
1426             cast<CXXConstructorDecl>(ND)->getInheritedConstructor()) {
1427       InheritedFrom = Inherited.getConstructor()->getParent();
1428       InheritedTemplateArgs =
1429           Inherited.getConstructor()->getTemplateSpecializationArgs();
1430     }
1431 
1432     if (ND == Structor)
1433       // If the named decl is the C++ constructor we're mangling, use the type
1434       // we were given.
1435       mangleCXXCtorType(static_cast<CXXCtorType>(StructorType), InheritedFrom);
1436     else
1437       // Otherwise, use the complete constructor name. This is relevant if a
1438       // class with a constructor is declared within a constructor.
1439       mangleCXXCtorType(Ctor_Complete, InheritedFrom);
1440 
1441     // FIXME: The template arguments are part of the enclosing prefix or
1442     // nested-name, but it's more convenient to mangle them here.
1443     if (InheritedTemplateArgs)
1444       mangleTemplateArgs(*InheritedTemplateArgs);
1445 
1446     writeAbiTags(ND, AdditionalAbiTags);
1447     break;
1448   }
1449 
1450   case DeclarationName::CXXDestructorName:
1451     if (ND == Structor)
1452       // If the named decl is the C++ destructor we're mangling, use the type we
1453       // were given.
1454       mangleCXXDtorType(static_cast<CXXDtorType>(StructorType));
1455     else
1456       // Otherwise, use the complete destructor name. This is relevant if a
1457       // class with a destructor is declared within a destructor.
1458       mangleCXXDtorType(Dtor_Complete);
1459     writeAbiTags(ND, AdditionalAbiTags);
1460     break;
1461 
1462   case DeclarationName::CXXOperatorName:
1463     if (ND && Arity == UnknownArity) {
1464       Arity = cast<FunctionDecl>(ND)->getNumParams();
1465 
1466       // If we have a member function, we need to include the 'this' pointer.
1467       if (const auto *MD = dyn_cast<CXXMethodDecl>(ND))
1468         if (!MD->isStatic())
1469           Arity++;
1470     }
1471   // FALLTHROUGH
1472   case DeclarationName::CXXConversionFunctionName:
1473   case DeclarationName::CXXLiteralOperatorName:
1474     mangleOperatorName(Name, Arity);
1475     writeAbiTags(ND, AdditionalAbiTags);
1476     break;
1477 
1478   case DeclarationName::CXXDeductionGuideName:
1479     llvm_unreachable("Can't mangle a deduction guide name!");
1480 
1481   case DeclarationName::CXXUsingDirective:
1482     llvm_unreachable("Can't mangle a using directive name!");
1483   }
1484 }
1485 
1486 void CXXNameMangler::mangleRegCallName(const IdentifierInfo *II) {
1487   // <source-name> ::= <positive length number> __regcall3__ <identifier>
1488   // <number> ::= [n] <non-negative decimal integer>
1489   // <identifier> ::= <unqualified source code identifier>
1490   Out << II->getLength() + sizeof("__regcall3__") - 1 << "__regcall3__"
1491       << II->getName();
1492 }
1493 
1494 void CXXNameMangler::mangleSourceName(const IdentifierInfo *II) {
1495   // <source-name> ::= <positive length number> <identifier>
1496   // <number> ::= [n] <non-negative decimal integer>
1497   // <identifier> ::= <unqualified source code identifier>
1498   Out << II->getLength() << II->getName();
1499 }
1500 
1501 void CXXNameMangler::mangleNestedName(const NamedDecl *ND,
1502                                       const DeclContext *DC,
1503                                       const AbiTagList *AdditionalAbiTags,
1504                                       bool NoFunction) {
1505   // <nested-name>
1506   //   ::= N [<CV-qualifiers>] [<ref-qualifier>] <prefix> <unqualified-name> E
1507   //   ::= N [<CV-qualifiers>] [<ref-qualifier>] <template-prefix>
1508   //       <template-args> E
1509 
1510   Out << 'N';
1511   if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(ND)) {
1512     Qualifiers MethodQuals =
1513         Qualifiers::fromCVRUMask(Method->getTypeQualifiers());
1514     // We do not consider restrict a distinguishing attribute for overloading
1515     // purposes so we must not mangle it.
1516     MethodQuals.removeRestrict();
1517     mangleQualifiers(MethodQuals);
1518     mangleRefQualifier(Method->getRefQualifier());
1519   }
1520 
1521   // Check if we have a template.
1522   const TemplateArgumentList *TemplateArgs = nullptr;
1523   if (const TemplateDecl *TD = isTemplate(ND, TemplateArgs)) {
1524     mangleTemplatePrefix(TD, NoFunction);
1525     mangleTemplateArgs(*TemplateArgs);
1526   }
1527   else {
1528     manglePrefix(DC, NoFunction);
1529     mangleUnqualifiedName(ND, AdditionalAbiTags);
1530   }
1531 
1532   Out << 'E';
1533 }
1534 void CXXNameMangler::mangleNestedName(const TemplateDecl *TD,
1535                                       const TemplateArgument *TemplateArgs,
1536                                       unsigned NumTemplateArgs) {
1537   // <nested-name> ::= N [<CV-qualifiers>] <template-prefix> <template-args> E
1538 
1539   Out << 'N';
1540 
1541   mangleTemplatePrefix(TD);
1542   mangleTemplateArgs(TemplateArgs, NumTemplateArgs);
1543 
1544   Out << 'E';
1545 }
1546 
1547 void CXXNameMangler::mangleLocalName(const Decl *D,
1548                                      const AbiTagList *AdditionalAbiTags) {
1549   // <local-name> := Z <function encoding> E <entity name> [<discriminator>]
1550   //              := Z <function encoding> E s [<discriminator>]
1551   // <local-name> := Z <function encoding> E d [ <parameter number> ]
1552   //                 _ <entity name>
1553   // <discriminator> := _ <non-negative number>
1554   assert(isa<NamedDecl>(D) || isa<BlockDecl>(D));
1555   const RecordDecl *RD = GetLocalClassDecl(D);
1556   const DeclContext *DC = getEffectiveDeclContext(RD ? RD : D);
1557 
1558   Out << 'Z';
1559 
1560   {
1561     AbiTagState LocalAbiTags(AbiTags);
1562 
1563     if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(DC))
1564       mangleObjCMethodName(MD);
1565     else if (const BlockDecl *BD = dyn_cast<BlockDecl>(DC))
1566       mangleBlockForPrefix(BD);
1567     else
1568       mangleFunctionEncoding(cast<FunctionDecl>(DC));
1569 
1570     // Implicit ABI tags (from namespace) are not available in the following
1571     // entity; reset to actually emitted tags, which are available.
1572     LocalAbiTags.setUsedAbiTags(LocalAbiTags.getEmittedAbiTags());
1573   }
1574 
1575   Out << 'E';
1576 
1577   // GCC 5.3.0 doesn't emit derived ABI tags for local names but that seems to
1578   // be a bug that is fixed in trunk.
1579 
1580   if (RD) {
1581     // The parameter number is omitted for the last parameter, 0 for the
1582     // second-to-last parameter, 1 for the third-to-last parameter, etc. The
1583     // <entity name> will of course contain a <closure-type-name>: Its
1584     // numbering will be local to the particular argument in which it appears
1585     // -- other default arguments do not affect its encoding.
1586     const CXXRecordDecl *CXXRD = dyn_cast<CXXRecordDecl>(RD);
1587     if (CXXRD && CXXRD->isLambda()) {
1588       if (const ParmVarDecl *Parm
1589               = dyn_cast_or_null<ParmVarDecl>(CXXRD->getLambdaContextDecl())) {
1590         if (const FunctionDecl *Func
1591               = dyn_cast<FunctionDecl>(Parm->getDeclContext())) {
1592           Out << 'd';
1593           unsigned Num = Func->getNumParams() - Parm->getFunctionScopeIndex();
1594           if (Num > 1)
1595             mangleNumber(Num - 2);
1596           Out << '_';
1597         }
1598       }
1599     }
1600 
1601     // Mangle the name relative to the closest enclosing function.
1602     // equality ok because RD derived from ND above
1603     if (D == RD)  {
1604       mangleUnqualifiedName(RD, AdditionalAbiTags);
1605     } else if (const BlockDecl *BD = dyn_cast<BlockDecl>(D)) {
1606       manglePrefix(getEffectiveDeclContext(BD), true /*NoFunction*/);
1607       assert(!AdditionalAbiTags && "Block cannot have additional abi tags");
1608       mangleUnqualifiedBlock(BD);
1609     } else {
1610       const NamedDecl *ND = cast<NamedDecl>(D);
1611       mangleNestedName(ND, getEffectiveDeclContext(ND), AdditionalAbiTags,
1612                        true /*NoFunction*/);
1613     }
1614   } else if (const BlockDecl *BD = dyn_cast<BlockDecl>(D)) {
1615     // Mangle a block in a default parameter; see above explanation for
1616     // lambdas.
1617     if (const ParmVarDecl *Parm
1618             = dyn_cast_or_null<ParmVarDecl>(BD->getBlockManglingContextDecl())) {
1619       if (const FunctionDecl *Func
1620             = dyn_cast<FunctionDecl>(Parm->getDeclContext())) {
1621         Out << 'd';
1622         unsigned Num = Func->getNumParams() - Parm->getFunctionScopeIndex();
1623         if (Num > 1)
1624           mangleNumber(Num - 2);
1625         Out << '_';
1626       }
1627     }
1628 
1629     assert(!AdditionalAbiTags && "Block cannot have additional abi tags");
1630     mangleUnqualifiedBlock(BD);
1631   } else {
1632     mangleUnqualifiedName(cast<NamedDecl>(D), AdditionalAbiTags);
1633   }
1634 
1635   if (const NamedDecl *ND = dyn_cast<NamedDecl>(RD ? RD : D)) {
1636     unsigned disc;
1637     if (Context.getNextDiscriminator(ND, disc)) {
1638       if (disc < 10)
1639         Out << '_' << disc;
1640       else
1641         Out << "__" << disc << '_';
1642     }
1643   }
1644 }
1645 
1646 void CXXNameMangler::mangleBlockForPrefix(const BlockDecl *Block) {
1647   if (GetLocalClassDecl(Block)) {
1648     mangleLocalName(Block, /* AdditionalAbiTags */ nullptr);
1649     return;
1650   }
1651   const DeclContext *DC = getEffectiveDeclContext(Block);
1652   if (isLocalContainerContext(DC)) {
1653     mangleLocalName(Block, /* AdditionalAbiTags */ nullptr);
1654     return;
1655   }
1656   manglePrefix(getEffectiveDeclContext(Block));
1657   mangleUnqualifiedBlock(Block);
1658 }
1659 
1660 void CXXNameMangler::mangleUnqualifiedBlock(const BlockDecl *Block) {
1661   if (Decl *Context = Block->getBlockManglingContextDecl()) {
1662     if ((isa<VarDecl>(Context) || isa<FieldDecl>(Context)) &&
1663         Context->getDeclContext()->isRecord()) {
1664       const auto *ND = cast<NamedDecl>(Context);
1665       if (ND->getIdentifier()) {
1666         mangleSourceNameWithAbiTags(ND);
1667         Out << 'M';
1668       }
1669     }
1670   }
1671 
1672   // If we have a block mangling number, use it.
1673   unsigned Number = Block->getBlockManglingNumber();
1674   // Otherwise, just make up a number. It doesn't matter what it is because
1675   // the symbol in question isn't externally visible.
1676   if (!Number)
1677     Number = Context.getBlockId(Block, false);
1678   else {
1679     // Stored mangling numbers are 1-based.
1680     --Number;
1681   }
1682   Out << "Ub";
1683   if (Number > 0)
1684     Out << Number - 1;
1685   Out << '_';
1686 }
1687 
1688 void CXXNameMangler::mangleLambda(const CXXRecordDecl *Lambda) {
1689   // If the context of a closure type is an initializer for a class member
1690   // (static or nonstatic), it is encoded in a qualified name with a final
1691   // <prefix> of the form:
1692   //
1693   //   <data-member-prefix> := <member source-name> M
1694   //
1695   // Technically, the data-member-prefix is part of the <prefix>. However,
1696   // since a closure type will always be mangled with a prefix, it's easier
1697   // to emit that last part of the prefix here.
1698   if (Decl *Context = Lambda->getLambdaContextDecl()) {
1699     if ((isa<VarDecl>(Context) || isa<FieldDecl>(Context)) &&
1700         !isa<ParmVarDecl>(Context)) {
1701       // FIXME: 'inline auto [a, b] = []{ return ... };' does not get a
1702       // reasonable mangling here.
1703       if (const IdentifierInfo *Name
1704             = cast<NamedDecl>(Context)->getIdentifier()) {
1705         mangleSourceName(Name);
1706         const TemplateArgumentList *TemplateArgs = nullptr;
1707         if (isTemplate(cast<NamedDecl>(Context), TemplateArgs))
1708           mangleTemplateArgs(*TemplateArgs);
1709         Out << 'M';
1710       }
1711     }
1712   }
1713 
1714   Out << "Ul";
1715   const FunctionProtoType *Proto = Lambda->getLambdaTypeInfo()->getType()->
1716                                    getAs<FunctionProtoType>();
1717   mangleBareFunctionType(Proto, /*MangleReturnType=*/false,
1718                          Lambda->getLambdaStaticInvoker());
1719   Out << "E";
1720 
1721   // The number is omitted for the first closure type with a given
1722   // <lambda-sig> in a given context; it is n-2 for the nth closure type
1723   // (in lexical order) with that same <lambda-sig> and context.
1724   //
1725   // The AST keeps track of the number for us.
1726   unsigned Number = Lambda->getLambdaManglingNumber();
1727   assert(Number > 0 && "Lambda should be mangled as an unnamed class");
1728   if (Number > 1)
1729     mangleNumber(Number - 2);
1730   Out << '_';
1731 }
1732 
1733 void CXXNameMangler::manglePrefix(NestedNameSpecifier *qualifier) {
1734   switch (qualifier->getKind()) {
1735   case NestedNameSpecifier::Global:
1736     // nothing
1737     return;
1738 
1739   case NestedNameSpecifier::Super:
1740     llvm_unreachable("Can't mangle __super specifier");
1741 
1742   case NestedNameSpecifier::Namespace:
1743     mangleName(qualifier->getAsNamespace());
1744     return;
1745 
1746   case NestedNameSpecifier::NamespaceAlias:
1747     mangleName(qualifier->getAsNamespaceAlias()->getNamespace());
1748     return;
1749 
1750   case NestedNameSpecifier::TypeSpec:
1751   case NestedNameSpecifier::TypeSpecWithTemplate:
1752     manglePrefix(QualType(qualifier->getAsType(), 0));
1753     return;
1754 
1755   case NestedNameSpecifier::Identifier:
1756     // Member expressions can have these without prefixes, but that
1757     // should end up in mangleUnresolvedPrefix instead.
1758     assert(qualifier->getPrefix());
1759     manglePrefix(qualifier->getPrefix());
1760 
1761     mangleSourceName(qualifier->getAsIdentifier());
1762     return;
1763   }
1764 
1765   llvm_unreachable("unexpected nested name specifier");
1766 }
1767 
1768 void CXXNameMangler::manglePrefix(const DeclContext *DC, bool NoFunction) {
1769   //  <prefix> ::= <prefix> <unqualified-name>
1770   //           ::= <template-prefix> <template-args>
1771   //           ::= <template-param>
1772   //           ::= # empty
1773   //           ::= <substitution>
1774 
1775   DC = IgnoreLinkageSpecDecls(DC);
1776 
1777   if (DC->isTranslationUnit())
1778     return;
1779 
1780   if (NoFunction && isLocalContainerContext(DC))
1781     return;
1782 
1783   assert(!isLocalContainerContext(DC));
1784 
1785   const NamedDecl *ND = cast<NamedDecl>(DC);
1786   if (mangleSubstitution(ND))
1787     return;
1788 
1789   // Check if we have a template.
1790   const TemplateArgumentList *TemplateArgs = nullptr;
1791   if (const TemplateDecl *TD = isTemplate(ND, TemplateArgs)) {
1792     mangleTemplatePrefix(TD);
1793     mangleTemplateArgs(*TemplateArgs);
1794   } else {
1795     manglePrefix(getEffectiveDeclContext(ND), NoFunction);
1796     mangleUnqualifiedName(ND, nullptr);
1797   }
1798 
1799   addSubstitution(ND);
1800 }
1801 
1802 void CXXNameMangler::mangleTemplatePrefix(TemplateName Template) {
1803   // <template-prefix> ::= <prefix> <template unqualified-name>
1804   //                   ::= <template-param>
1805   //                   ::= <substitution>
1806   if (TemplateDecl *TD = Template.getAsTemplateDecl())
1807     return mangleTemplatePrefix(TD);
1808 
1809   if (QualifiedTemplateName *Qualified = Template.getAsQualifiedTemplateName())
1810     manglePrefix(Qualified->getQualifier());
1811 
1812   if (OverloadedTemplateStorage *Overloaded
1813                                       = Template.getAsOverloadedTemplate()) {
1814     mangleUnqualifiedName(nullptr, (*Overloaded->begin())->getDeclName(),
1815                           UnknownArity, nullptr);
1816     return;
1817   }
1818 
1819   DependentTemplateName *Dependent = Template.getAsDependentTemplateName();
1820   assert(Dependent && "Unknown template name kind?");
1821   if (NestedNameSpecifier *Qualifier = Dependent->getQualifier())
1822     manglePrefix(Qualifier);
1823   mangleUnscopedTemplateName(Template, /* AdditionalAbiTags */ nullptr);
1824 }
1825 
1826 void CXXNameMangler::mangleTemplatePrefix(const TemplateDecl *ND,
1827                                           bool NoFunction) {
1828   // <template-prefix> ::= <prefix> <template unqualified-name>
1829   //                   ::= <template-param>
1830   //                   ::= <substitution>
1831   // <template-template-param> ::= <template-param>
1832   //                               <substitution>
1833 
1834   if (mangleSubstitution(ND))
1835     return;
1836 
1837   // <template-template-param> ::= <template-param>
1838   if (const auto *TTP = dyn_cast<TemplateTemplateParmDecl>(ND)) {
1839     mangleTemplateParameter(TTP->getIndex());
1840   } else {
1841     manglePrefix(getEffectiveDeclContext(ND), NoFunction);
1842     if (isa<BuiltinTemplateDecl>(ND))
1843       mangleUnqualifiedName(ND, nullptr);
1844     else
1845       mangleUnqualifiedName(ND->getTemplatedDecl(), nullptr);
1846   }
1847 
1848   addSubstitution(ND);
1849 }
1850 
1851 /// Mangles a template name under the production <type>.  Required for
1852 /// template template arguments.
1853 ///   <type> ::= <class-enum-type>
1854 ///          ::= <template-param>
1855 ///          ::= <substitution>
1856 void CXXNameMangler::mangleType(TemplateName TN) {
1857   if (mangleSubstitution(TN))
1858     return;
1859 
1860   TemplateDecl *TD = nullptr;
1861 
1862   switch (TN.getKind()) {
1863   case TemplateName::QualifiedTemplate:
1864     TD = TN.getAsQualifiedTemplateName()->getTemplateDecl();
1865     goto HaveDecl;
1866 
1867   case TemplateName::Template:
1868     TD = TN.getAsTemplateDecl();
1869     goto HaveDecl;
1870 
1871   HaveDecl:
1872     if (isa<TemplateTemplateParmDecl>(TD))
1873       mangleTemplateParameter(cast<TemplateTemplateParmDecl>(TD)->getIndex());
1874     else
1875       mangleName(TD);
1876     break;
1877 
1878   case TemplateName::OverloadedTemplate:
1879     llvm_unreachable("can't mangle an overloaded template name as a <type>");
1880 
1881   case TemplateName::DependentTemplate: {
1882     const DependentTemplateName *Dependent = TN.getAsDependentTemplateName();
1883     assert(Dependent->isIdentifier());
1884 
1885     // <class-enum-type> ::= <name>
1886     // <name> ::= <nested-name>
1887     mangleUnresolvedPrefix(Dependent->getQualifier());
1888     mangleSourceName(Dependent->getIdentifier());
1889     break;
1890   }
1891 
1892   case TemplateName::SubstTemplateTemplateParm: {
1893     // Substituted template parameters are mangled as the substituted
1894     // template.  This will check for the substitution twice, which is
1895     // fine, but we have to return early so that we don't try to *add*
1896     // the substitution twice.
1897     SubstTemplateTemplateParmStorage *subst
1898       = TN.getAsSubstTemplateTemplateParm();
1899     mangleType(subst->getReplacement());
1900     return;
1901   }
1902 
1903   case TemplateName::SubstTemplateTemplateParmPack: {
1904     // FIXME: not clear how to mangle this!
1905     // template <template <class> class T...> class A {
1906     //   template <template <class> class U...> void foo(B<T,U> x...);
1907     // };
1908     Out << "_SUBSTPACK_";
1909     break;
1910   }
1911   }
1912 
1913   addSubstitution(TN);
1914 }
1915 
1916 bool CXXNameMangler::mangleUnresolvedTypeOrSimpleId(QualType Ty,
1917                                                     StringRef Prefix) {
1918   // Only certain other types are valid as prefixes;  enumerate them.
1919   switch (Ty->getTypeClass()) {
1920   case Type::Builtin:
1921   case Type::Complex:
1922   case Type::Adjusted:
1923   case Type::Decayed:
1924   case Type::Pointer:
1925   case Type::BlockPointer:
1926   case Type::LValueReference:
1927   case Type::RValueReference:
1928   case Type::MemberPointer:
1929   case Type::ConstantArray:
1930   case Type::IncompleteArray:
1931   case Type::VariableArray:
1932   case Type::DependentSizedArray:
1933   case Type::DependentAddressSpace:
1934   case Type::DependentSizedExtVector:
1935   case Type::Vector:
1936   case Type::ExtVector:
1937   case Type::FunctionProto:
1938   case Type::FunctionNoProto:
1939   case Type::Paren:
1940   case Type::Attributed:
1941   case Type::Auto:
1942   case Type::DeducedTemplateSpecialization:
1943   case Type::PackExpansion:
1944   case Type::ObjCObject:
1945   case Type::ObjCInterface:
1946   case Type::ObjCObjectPointer:
1947   case Type::ObjCTypeParam:
1948   case Type::Atomic:
1949   case Type::Pipe:
1950     llvm_unreachable("type is illegal as a nested name specifier");
1951 
1952   case Type::SubstTemplateTypeParmPack:
1953     // FIXME: not clear how to mangle this!
1954     // template <class T...> class A {
1955     //   template <class U...> void foo(decltype(T::foo(U())) x...);
1956     // };
1957     Out << "_SUBSTPACK_";
1958     break;
1959 
1960   // <unresolved-type> ::= <template-param>
1961   //                   ::= <decltype>
1962   //                   ::= <template-template-param> <template-args>
1963   // (this last is not official yet)
1964   case Type::TypeOfExpr:
1965   case Type::TypeOf:
1966   case Type::Decltype:
1967   case Type::TemplateTypeParm:
1968   case Type::UnaryTransform:
1969   case Type::SubstTemplateTypeParm:
1970   unresolvedType:
1971     // Some callers want a prefix before the mangled type.
1972     Out << Prefix;
1973 
1974     // This seems to do everything we want.  It's not really
1975     // sanctioned for a substituted template parameter, though.
1976     mangleType(Ty);
1977 
1978     // We never want to print 'E' directly after an unresolved-type,
1979     // so we return directly.
1980     return true;
1981 
1982   case Type::Typedef:
1983     mangleSourceNameWithAbiTags(cast<TypedefType>(Ty)->getDecl());
1984     break;
1985 
1986   case Type::UnresolvedUsing:
1987     mangleSourceNameWithAbiTags(
1988         cast<UnresolvedUsingType>(Ty)->getDecl());
1989     break;
1990 
1991   case Type::Enum:
1992   case Type::Record:
1993     mangleSourceNameWithAbiTags(cast<TagType>(Ty)->getDecl());
1994     break;
1995 
1996   case Type::TemplateSpecialization: {
1997     const TemplateSpecializationType *TST =
1998         cast<TemplateSpecializationType>(Ty);
1999     TemplateName TN = TST->getTemplateName();
2000     switch (TN.getKind()) {
2001     case TemplateName::Template:
2002     case TemplateName::QualifiedTemplate: {
2003       TemplateDecl *TD = TN.getAsTemplateDecl();
2004 
2005       // If the base is a template template parameter, this is an
2006       // unresolved type.
2007       assert(TD && "no template for template specialization type");
2008       if (isa<TemplateTemplateParmDecl>(TD))
2009         goto unresolvedType;
2010 
2011       mangleSourceNameWithAbiTags(TD);
2012       break;
2013     }
2014 
2015     case TemplateName::OverloadedTemplate:
2016     case TemplateName::DependentTemplate:
2017       llvm_unreachable("invalid base for a template specialization type");
2018 
2019     case TemplateName::SubstTemplateTemplateParm: {
2020       SubstTemplateTemplateParmStorage *subst =
2021           TN.getAsSubstTemplateTemplateParm();
2022       mangleExistingSubstitution(subst->getReplacement());
2023       break;
2024     }
2025 
2026     case TemplateName::SubstTemplateTemplateParmPack: {
2027       // FIXME: not clear how to mangle this!
2028       // template <template <class U> class T...> class A {
2029       //   template <class U...> void foo(decltype(T<U>::foo) x...);
2030       // };
2031       Out << "_SUBSTPACK_";
2032       break;
2033     }
2034     }
2035 
2036     mangleTemplateArgs(TST->getArgs(), TST->getNumArgs());
2037     break;
2038   }
2039 
2040   case Type::InjectedClassName:
2041     mangleSourceNameWithAbiTags(
2042         cast<InjectedClassNameType>(Ty)->getDecl());
2043     break;
2044 
2045   case Type::DependentName:
2046     mangleSourceName(cast<DependentNameType>(Ty)->getIdentifier());
2047     break;
2048 
2049   case Type::DependentTemplateSpecialization: {
2050     const DependentTemplateSpecializationType *DTST =
2051         cast<DependentTemplateSpecializationType>(Ty);
2052     mangleSourceName(DTST->getIdentifier());
2053     mangleTemplateArgs(DTST->getArgs(), DTST->getNumArgs());
2054     break;
2055   }
2056 
2057   case Type::Elaborated:
2058     return mangleUnresolvedTypeOrSimpleId(
2059         cast<ElaboratedType>(Ty)->getNamedType(), Prefix);
2060   }
2061 
2062   return false;
2063 }
2064 
2065 void CXXNameMangler::mangleOperatorName(DeclarationName Name, unsigned Arity) {
2066   switch (Name.getNameKind()) {
2067   case DeclarationName::CXXConstructorName:
2068   case DeclarationName::CXXDestructorName:
2069   case DeclarationName::CXXDeductionGuideName:
2070   case DeclarationName::CXXUsingDirective:
2071   case DeclarationName::Identifier:
2072   case DeclarationName::ObjCMultiArgSelector:
2073   case DeclarationName::ObjCOneArgSelector:
2074   case DeclarationName::ObjCZeroArgSelector:
2075     llvm_unreachable("Not an operator name");
2076 
2077   case DeclarationName::CXXConversionFunctionName:
2078     // <operator-name> ::= cv <type>    # (cast)
2079     Out << "cv";
2080     mangleType(Name.getCXXNameType());
2081     break;
2082 
2083   case DeclarationName::CXXLiteralOperatorName:
2084     Out << "li";
2085     mangleSourceName(Name.getCXXLiteralIdentifier());
2086     return;
2087 
2088   case DeclarationName::CXXOperatorName:
2089     mangleOperatorName(Name.getCXXOverloadedOperator(), Arity);
2090     break;
2091   }
2092 }
2093 
2094 void
2095 CXXNameMangler::mangleOperatorName(OverloadedOperatorKind OO, unsigned Arity) {
2096   switch (OO) {
2097   // <operator-name> ::= nw     # new
2098   case OO_New: Out << "nw"; break;
2099   //              ::= na        # new[]
2100   case OO_Array_New: Out << "na"; break;
2101   //              ::= dl        # delete
2102   case OO_Delete: Out << "dl"; break;
2103   //              ::= da        # delete[]
2104   case OO_Array_Delete: Out << "da"; break;
2105   //              ::= ps        # + (unary)
2106   //              ::= pl        # + (binary or unknown)
2107   case OO_Plus:
2108     Out << (Arity == 1? "ps" : "pl"); break;
2109   //              ::= ng        # - (unary)
2110   //              ::= mi        # - (binary or unknown)
2111   case OO_Minus:
2112     Out << (Arity == 1? "ng" : "mi"); break;
2113   //              ::= ad        # & (unary)
2114   //              ::= an        # & (binary or unknown)
2115   case OO_Amp:
2116     Out << (Arity == 1? "ad" : "an"); break;
2117   //              ::= de        # * (unary)
2118   //              ::= ml        # * (binary or unknown)
2119   case OO_Star:
2120     // Use binary when unknown.
2121     Out << (Arity == 1? "de" : "ml"); break;
2122   //              ::= co        # ~
2123   case OO_Tilde: Out << "co"; break;
2124   //              ::= dv        # /
2125   case OO_Slash: Out << "dv"; break;
2126   //              ::= rm        # %
2127   case OO_Percent: Out << "rm"; break;
2128   //              ::= or        # |
2129   case OO_Pipe: Out << "or"; break;
2130   //              ::= eo        # ^
2131   case OO_Caret: Out << "eo"; break;
2132   //              ::= aS        # =
2133   case OO_Equal: Out << "aS"; break;
2134   //              ::= pL        # +=
2135   case OO_PlusEqual: Out << "pL"; break;
2136   //              ::= mI        # -=
2137   case OO_MinusEqual: Out << "mI"; break;
2138   //              ::= mL        # *=
2139   case OO_StarEqual: Out << "mL"; break;
2140   //              ::= dV        # /=
2141   case OO_SlashEqual: Out << "dV"; break;
2142   //              ::= rM        # %=
2143   case OO_PercentEqual: Out << "rM"; break;
2144   //              ::= aN        # &=
2145   case OO_AmpEqual: Out << "aN"; break;
2146   //              ::= oR        # |=
2147   case OO_PipeEqual: Out << "oR"; break;
2148   //              ::= eO        # ^=
2149   case OO_CaretEqual: Out << "eO"; break;
2150   //              ::= ls        # <<
2151   case OO_LessLess: Out << "ls"; break;
2152   //              ::= rs        # >>
2153   case OO_GreaterGreater: Out << "rs"; break;
2154   //              ::= lS        # <<=
2155   case OO_LessLessEqual: Out << "lS"; break;
2156   //              ::= rS        # >>=
2157   case OO_GreaterGreaterEqual: Out << "rS"; break;
2158   //              ::= eq        # ==
2159   case OO_EqualEqual: Out << "eq"; break;
2160   //              ::= ne        # !=
2161   case OO_ExclaimEqual: Out << "ne"; break;
2162   //              ::= lt        # <
2163   case OO_Less: Out << "lt"; break;
2164   //              ::= gt        # >
2165   case OO_Greater: Out << "gt"; break;
2166   //              ::= le        # <=
2167   case OO_LessEqual: Out << "le"; break;
2168   //              ::= ge        # >=
2169   case OO_GreaterEqual: Out << "ge"; break;
2170   //              ::= nt        # !
2171   case OO_Exclaim: Out << "nt"; break;
2172   //              ::= aa        # &&
2173   case OO_AmpAmp: Out << "aa"; break;
2174   //              ::= oo        # ||
2175   case OO_PipePipe: Out << "oo"; break;
2176   //              ::= pp        # ++
2177   case OO_PlusPlus: Out << "pp"; break;
2178   //              ::= mm        # --
2179   case OO_MinusMinus: Out << "mm"; break;
2180   //              ::= cm        # ,
2181   case OO_Comma: Out << "cm"; break;
2182   //              ::= pm        # ->*
2183   case OO_ArrowStar: Out << "pm"; break;
2184   //              ::= pt        # ->
2185   case OO_Arrow: Out << "pt"; break;
2186   //              ::= cl        # ()
2187   case OO_Call: Out << "cl"; break;
2188   //              ::= ix        # []
2189   case OO_Subscript: Out << "ix"; break;
2190 
2191   //              ::= qu        # ?
2192   // The conditional operator can't be overloaded, but we still handle it when
2193   // mangling expressions.
2194   case OO_Conditional: Out << "qu"; break;
2195   // Proposal on cxx-abi-dev, 2015-10-21.
2196   //              ::= aw        # co_await
2197   case OO_Coawait: Out << "aw"; break;
2198 
2199   case OO_None:
2200   case NUM_OVERLOADED_OPERATORS:
2201     llvm_unreachable("Not an overloaded operator");
2202   }
2203 }
2204 
2205 void CXXNameMangler::mangleQualifiers(Qualifiers Quals, const DependentAddressSpaceType *DAST) {
2206   // Vendor qualifiers come first and if they are order-insensitive they must
2207   // be emitted in reversed alphabetical order, see Itanium ABI 5.1.5.
2208 
2209   // <type> ::= U <addrspace-expr>
2210   if (DAST) {
2211     Out << "U2ASI";
2212     mangleExpression(DAST->getAddrSpaceExpr());
2213     Out << "E";
2214   }
2215 
2216   // Address space qualifiers start with an ordinary letter.
2217   if (Quals.hasAddressSpace()) {
2218     // Address space extension:
2219     //
2220     //   <type> ::= U <target-addrspace>
2221     //   <type> ::= U <OpenCL-addrspace>
2222     //   <type> ::= U <CUDA-addrspace>
2223 
2224     SmallString<64> ASString;
2225     unsigned AS = Quals.getAddressSpace();
2226 
2227     if (Context.getASTContext().addressSpaceMapManglingFor(AS)) {
2228       //  <target-addrspace> ::= "AS" <address-space-number>
2229       unsigned TargetAS = Context.getASTContext().getTargetAddressSpace(AS);
2230       ASString = "AS" + llvm::utostr(TargetAS);
2231     } else {
2232       switch (AS) {
2233       default: llvm_unreachable("Not a language specific address space");
2234       //  <OpenCL-addrspace> ::= "CL" [ "global" | "local" | "constant |
2235       //                                "generic" ]
2236       case LangAS::opencl_global:   ASString = "CLglobal";   break;
2237       case LangAS::opencl_local:    ASString = "CLlocal";    break;
2238       case LangAS::opencl_constant: ASString = "CLconstant"; break;
2239       case LangAS::opencl_generic:  ASString = "CLgeneric";  break;
2240       //  <CUDA-addrspace> ::= "CU" [ "device" | "constant" | "shared" ]
2241       case LangAS::cuda_device:     ASString = "CUdevice";   break;
2242       case LangAS::cuda_constant:   ASString = "CUconstant"; break;
2243       case LangAS::cuda_shared:     ASString = "CUshared";   break;
2244       }
2245     }
2246     mangleVendorQualifier(ASString);
2247   }
2248 
2249   // The ARC ownership qualifiers start with underscores.
2250   // Objective-C ARC Extension:
2251   //
2252   //   <type> ::= U "__strong"
2253   //   <type> ::= U "__weak"
2254   //   <type> ::= U "__autoreleasing"
2255   //
2256   // Note: we emit __weak first to preserve the order as
2257   // required by the Itanium ABI.
2258   if (Quals.getObjCLifetime() == Qualifiers::OCL_Weak)
2259     mangleVendorQualifier("__weak");
2260 
2261   // __unaligned (from -fms-extensions)
2262   if (Quals.hasUnaligned())
2263     mangleVendorQualifier("__unaligned");
2264 
2265   // Remaining ARC ownership qualifiers.
2266   switch (Quals.getObjCLifetime()) {
2267   case Qualifiers::OCL_None:
2268     break;
2269 
2270   case Qualifiers::OCL_Weak:
2271     // Do nothing as we already handled this case above.
2272     break;
2273 
2274   case Qualifiers::OCL_Strong:
2275     mangleVendorQualifier("__strong");
2276     break;
2277 
2278   case Qualifiers::OCL_Autoreleasing:
2279     mangleVendorQualifier("__autoreleasing");
2280     break;
2281 
2282   case Qualifiers::OCL_ExplicitNone:
2283     // The __unsafe_unretained qualifier is *not* mangled, so that
2284     // __unsafe_unretained types in ARC produce the same manglings as the
2285     // equivalent (but, naturally, unqualified) types in non-ARC, providing
2286     // better ABI compatibility.
2287     //
2288     // It's safe to do this because unqualified 'id' won't show up
2289     // in any type signatures that need to be mangled.
2290     break;
2291   }
2292 
2293   // <CV-qualifiers> ::= [r] [V] [K]    # restrict (C99), volatile, const
2294   if (Quals.hasRestrict())
2295     Out << 'r';
2296   if (Quals.hasVolatile())
2297     Out << 'V';
2298   if (Quals.hasConst())
2299     Out << 'K';
2300 }
2301 
2302 void CXXNameMangler::mangleVendorQualifier(StringRef name) {
2303   Out << 'U' << name.size() << name;
2304 }
2305 
2306 void CXXNameMangler::mangleRefQualifier(RefQualifierKind RefQualifier) {
2307   // <ref-qualifier> ::= R                # lvalue reference
2308   //                 ::= O                # rvalue-reference
2309   switch (RefQualifier) {
2310   case RQ_None:
2311     break;
2312 
2313   case RQ_LValue:
2314     Out << 'R';
2315     break;
2316 
2317   case RQ_RValue:
2318     Out << 'O';
2319     break;
2320   }
2321 }
2322 
2323 void CXXNameMangler::mangleObjCMethodName(const ObjCMethodDecl *MD) {
2324   Context.mangleObjCMethodName(MD, Out);
2325 }
2326 
2327 static bool isTypeSubstitutable(Qualifiers Quals, const Type *Ty) {
2328   if (Quals)
2329     return true;
2330   if (Ty->isSpecificBuiltinType(BuiltinType::ObjCSel))
2331     return true;
2332   if (Ty->isOpenCLSpecificType())
2333     return true;
2334   if (Ty->isBuiltinType())
2335     return false;
2336 
2337   return true;
2338 }
2339 
2340 void CXXNameMangler::mangleType(QualType T) {
2341   // If our type is instantiation-dependent but not dependent, we mangle
2342   // it as it was written in the source, removing any top-level sugar.
2343   // Otherwise, use the canonical type.
2344   //
2345   // FIXME: This is an approximation of the instantiation-dependent name
2346   // mangling rules, since we should really be using the type as written and
2347   // augmented via semantic analysis (i.e., with implicit conversions and
2348   // default template arguments) for any instantiation-dependent type.
2349   // Unfortunately, that requires several changes to our AST:
2350   //   - Instantiation-dependent TemplateSpecializationTypes will need to be
2351   //     uniqued, so that we can handle substitutions properly
2352   //   - Default template arguments will need to be represented in the
2353   //     TemplateSpecializationType, since they need to be mangled even though
2354   //     they aren't written.
2355   //   - Conversions on non-type template arguments need to be expressed, since
2356   //     they can affect the mangling of sizeof/alignof.
2357   //
2358   // FIXME: This is wrong when mapping to the canonical type for a dependent
2359   // type discards instantiation-dependent portions of the type, such as for:
2360   //
2361   //   template<typename T, int N> void f(T (&)[sizeof(N)]);
2362   //   template<typename T> void f(T() throw(typename T::type)); (pre-C++17)
2363   //
2364   // It's also wrong in the opposite direction when instantiation-dependent,
2365   // canonically-equivalent types differ in some irrelevant portion of inner
2366   // type sugar. In such cases, we fail to form correct substitutions, eg:
2367   //
2368   //   template<int N> void f(A<sizeof(N)> *, A<sizeof(N)> (*));
2369   //
2370   // We should instead canonicalize the non-instantiation-dependent parts,
2371   // regardless of whether the type as a whole is dependent or instantiation
2372   // dependent.
2373   if (!T->isInstantiationDependentType() || T->isDependentType())
2374     T = T.getCanonicalType();
2375   else {
2376     // Desugar any types that are purely sugar.
2377     do {
2378       // Don't desugar through template specialization types that aren't
2379       // type aliases. We need to mangle the template arguments as written.
2380       if (const TemplateSpecializationType *TST
2381                                       = dyn_cast<TemplateSpecializationType>(T))
2382         if (!TST->isTypeAlias())
2383           break;
2384 
2385       QualType Desugared
2386         = T.getSingleStepDesugaredType(Context.getASTContext());
2387       if (Desugared == T)
2388         break;
2389 
2390       T = Desugared;
2391     } while (true);
2392   }
2393   SplitQualType split = T.split();
2394   Qualifiers quals = split.Quals;
2395   const Type *ty = split.Ty;
2396 
2397   bool isSubstitutable = isTypeSubstitutable(quals, ty);
2398   if (isSubstitutable && mangleSubstitution(T))
2399     return;
2400 
2401   // If we're mangling a qualified array type, push the qualifiers to
2402   // the element type.
2403   if (quals && isa<ArrayType>(T)) {
2404     ty = Context.getASTContext().getAsArrayType(T);
2405     quals = Qualifiers();
2406 
2407     // Note that we don't update T: we want to add the
2408     // substitution at the original type.
2409   }
2410 
2411   if (quals || ty->isDependentAddressSpaceType()) {
2412     if (const DependentAddressSpaceType *DAST =
2413         dyn_cast<DependentAddressSpaceType>(ty)) {
2414       SplitQualType splitDAST = DAST->getPointeeType().split();
2415       mangleQualifiers(splitDAST.Quals, DAST);
2416       mangleType(QualType(splitDAST.Ty, 0));
2417     } else {
2418       mangleQualifiers(quals);
2419 
2420       // Recurse:  even if the qualified type isn't yet substitutable,
2421       // the unqualified type might be.
2422       mangleType(QualType(ty, 0));
2423     }
2424   } else {
2425     switch (ty->getTypeClass()) {
2426 #define ABSTRACT_TYPE(CLASS, PARENT)
2427 #define NON_CANONICAL_TYPE(CLASS, PARENT) \
2428     case Type::CLASS: \
2429       llvm_unreachable("can't mangle non-canonical type " #CLASS "Type"); \
2430       return;
2431 #define TYPE(CLASS, PARENT) \
2432     case Type::CLASS: \
2433       mangleType(static_cast<const CLASS##Type*>(ty)); \
2434       break;
2435 #include "clang/AST/TypeNodes.def"
2436     }
2437   }
2438 
2439   // Add the substitution.
2440   if (isSubstitutable)
2441     addSubstitution(T);
2442 }
2443 
2444 void CXXNameMangler::mangleNameOrStandardSubstitution(const NamedDecl *ND) {
2445   if (!mangleStandardSubstitution(ND))
2446     mangleName(ND);
2447 }
2448 
2449 void CXXNameMangler::mangleType(const BuiltinType *T) {
2450   //  <type>         ::= <builtin-type>
2451   //  <builtin-type> ::= v  # void
2452   //                 ::= w  # wchar_t
2453   //                 ::= b  # bool
2454   //                 ::= c  # char
2455   //                 ::= a  # signed char
2456   //                 ::= h  # unsigned char
2457   //                 ::= s  # short
2458   //                 ::= t  # unsigned short
2459   //                 ::= i  # int
2460   //                 ::= j  # unsigned int
2461   //                 ::= l  # long
2462   //                 ::= m  # unsigned long
2463   //                 ::= x  # long long, __int64
2464   //                 ::= y  # unsigned long long, __int64
2465   //                 ::= n  # __int128
2466   //                 ::= o  # unsigned __int128
2467   //                 ::= f  # float
2468   //                 ::= d  # double
2469   //                 ::= e  # long double, __float80
2470   //                 ::= g  # __float128
2471   // UNSUPPORTED:    ::= Dd # IEEE 754r decimal floating point (64 bits)
2472   // UNSUPPORTED:    ::= De # IEEE 754r decimal floating point (128 bits)
2473   // UNSUPPORTED:    ::= Df # IEEE 754r decimal floating point (32 bits)
2474   //                 ::= Dh # IEEE 754r half-precision floating point (16 bits)
2475   //                 ::= DF <number> _ # ISO/IEC TS 18661 binary floating point type _FloatN (N bits);
2476   //                 ::= Di # char32_t
2477   //                 ::= Ds # char16_t
2478   //                 ::= Dn # std::nullptr_t (i.e., decltype(nullptr))
2479   //                 ::= u <source-name>    # vendor extended type
2480   std::string type_name;
2481   switch (T->getKind()) {
2482   case BuiltinType::Void:
2483     Out << 'v';
2484     break;
2485   case BuiltinType::Bool:
2486     Out << 'b';
2487     break;
2488   case BuiltinType::Char_U:
2489   case BuiltinType::Char_S:
2490     Out << 'c';
2491     break;
2492   case BuiltinType::UChar:
2493     Out << 'h';
2494     break;
2495   case BuiltinType::UShort:
2496     Out << 't';
2497     break;
2498   case BuiltinType::UInt:
2499     Out << 'j';
2500     break;
2501   case BuiltinType::ULong:
2502     Out << 'm';
2503     break;
2504   case BuiltinType::ULongLong:
2505     Out << 'y';
2506     break;
2507   case BuiltinType::UInt128:
2508     Out << 'o';
2509     break;
2510   case BuiltinType::SChar:
2511     Out << 'a';
2512     break;
2513   case BuiltinType::WChar_S:
2514   case BuiltinType::WChar_U:
2515     Out << 'w';
2516     break;
2517   case BuiltinType::Char16:
2518     Out << "Ds";
2519     break;
2520   case BuiltinType::Char32:
2521     Out << "Di";
2522     break;
2523   case BuiltinType::Short:
2524     Out << 's';
2525     break;
2526   case BuiltinType::Int:
2527     Out << 'i';
2528     break;
2529   case BuiltinType::Long:
2530     Out << 'l';
2531     break;
2532   case BuiltinType::LongLong:
2533     Out << 'x';
2534     break;
2535   case BuiltinType::Int128:
2536     Out << 'n';
2537     break;
2538   case BuiltinType::Float16:
2539     Out << "DF16_";
2540     break;
2541   case BuiltinType::Half:
2542     Out << "Dh";
2543     break;
2544   case BuiltinType::Float:
2545     Out << 'f';
2546     break;
2547   case BuiltinType::Double:
2548     Out << 'd';
2549     break;
2550   case BuiltinType::LongDouble:
2551     Out << (getASTContext().getTargetInfo().useFloat128ManglingForLongDouble()
2552                 ? 'g'
2553                 : 'e');
2554     break;
2555   case BuiltinType::Float128:
2556     if (getASTContext().getTargetInfo().useFloat128ManglingForLongDouble())
2557       Out << "U10__float128"; // Match the GCC mangling
2558     else
2559       Out << 'g';
2560     break;
2561   case BuiltinType::NullPtr:
2562     Out << "Dn";
2563     break;
2564 
2565 #define BUILTIN_TYPE(Id, SingletonId)
2566 #define PLACEHOLDER_TYPE(Id, SingletonId) \
2567   case BuiltinType::Id:
2568 #include "clang/AST/BuiltinTypes.def"
2569   case BuiltinType::Dependent:
2570     if (!NullOut)
2571       llvm_unreachable("mangling a placeholder type");
2572     break;
2573   case BuiltinType::ObjCId:
2574     Out << "11objc_object";
2575     break;
2576   case BuiltinType::ObjCClass:
2577     Out << "10objc_class";
2578     break;
2579   case BuiltinType::ObjCSel:
2580     Out << "13objc_selector";
2581     break;
2582 #define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
2583   case BuiltinType::Id: \
2584     type_name = "ocl_" #ImgType "_" #Suffix; \
2585     Out << type_name.size() << type_name; \
2586     break;
2587 #include "clang/Basic/OpenCLImageTypes.def"
2588   case BuiltinType::OCLSampler:
2589     Out << "11ocl_sampler";
2590     break;
2591   case BuiltinType::OCLEvent:
2592     Out << "9ocl_event";
2593     break;
2594   case BuiltinType::OCLClkEvent:
2595     Out << "12ocl_clkevent";
2596     break;
2597   case BuiltinType::OCLQueue:
2598     Out << "9ocl_queue";
2599     break;
2600   case BuiltinType::OCLReserveID:
2601     Out << "13ocl_reserveid";
2602     break;
2603   }
2604 }
2605 
2606 StringRef CXXNameMangler::getCallingConvQualifierName(CallingConv CC) {
2607   switch (CC) {
2608   case CC_C:
2609     return "";
2610 
2611   case CC_X86StdCall:
2612   case CC_X86FastCall:
2613   case CC_X86ThisCall:
2614   case CC_X86VectorCall:
2615   case CC_X86Pascal:
2616   case CC_Win64:
2617   case CC_X86_64SysV:
2618   case CC_X86RegCall:
2619   case CC_AAPCS:
2620   case CC_AAPCS_VFP:
2621   case CC_IntelOclBicc:
2622   case CC_SpirFunction:
2623   case CC_OpenCLKernel:
2624   case CC_PreserveMost:
2625   case CC_PreserveAll:
2626     // FIXME: we should be mangling all of the above.
2627     return "";
2628 
2629   case CC_Swift:
2630     return "swiftcall";
2631   }
2632   llvm_unreachable("bad calling convention");
2633 }
2634 
2635 void CXXNameMangler::mangleExtFunctionInfo(const FunctionType *T) {
2636   // Fast path.
2637   if (T->getExtInfo() == FunctionType::ExtInfo())
2638     return;
2639 
2640   // Vendor-specific qualifiers are emitted in reverse alphabetical order.
2641   // This will get more complicated in the future if we mangle other
2642   // things here; but for now, since we mangle ns_returns_retained as
2643   // a qualifier on the result type, we can get away with this:
2644   StringRef CCQualifier = getCallingConvQualifierName(T->getExtInfo().getCC());
2645   if (!CCQualifier.empty())
2646     mangleVendorQualifier(CCQualifier);
2647 
2648   // FIXME: regparm
2649   // FIXME: noreturn
2650 }
2651 
2652 void
2653 CXXNameMangler::mangleExtParameterInfo(FunctionProtoType::ExtParameterInfo PI) {
2654   // Vendor-specific qualifiers are emitted in reverse alphabetical order.
2655 
2656   // Note that these are *not* substitution candidates.  Demanglers might
2657   // have trouble with this if the parameter type is fully substituted.
2658 
2659   switch (PI.getABI()) {
2660   case ParameterABI::Ordinary:
2661     break;
2662 
2663   // All of these start with "swift", so they come before "ns_consumed".
2664   case ParameterABI::SwiftContext:
2665   case ParameterABI::SwiftErrorResult:
2666   case ParameterABI::SwiftIndirectResult:
2667     mangleVendorQualifier(getParameterABISpelling(PI.getABI()));
2668     break;
2669   }
2670 
2671   if (PI.isConsumed())
2672     mangleVendorQualifier("ns_consumed");
2673 
2674   if (PI.isNoEscape())
2675     mangleVendorQualifier("noescape");
2676 }
2677 
2678 // <type>          ::= <function-type>
2679 // <function-type> ::= [<CV-qualifiers>] F [Y]
2680 //                      <bare-function-type> [<ref-qualifier>] E
2681 void CXXNameMangler::mangleType(const FunctionProtoType *T) {
2682   mangleExtFunctionInfo(T);
2683 
2684   // Mangle CV-qualifiers, if present.  These are 'this' qualifiers,
2685   // e.g. "const" in "int (A::*)() const".
2686   mangleQualifiers(Qualifiers::fromCVRMask(T->getTypeQuals()));
2687 
2688   // Mangle instantiation-dependent exception-specification, if present,
2689   // per cxx-abi-dev proposal on 2016-10-11.
2690   if (T->hasInstantiationDependentExceptionSpec()) {
2691     if (T->getExceptionSpecType() == EST_ComputedNoexcept) {
2692       Out << "DO";
2693       mangleExpression(T->getNoexceptExpr());
2694       Out << "E";
2695     } else {
2696       assert(T->getExceptionSpecType() == EST_Dynamic);
2697       Out << "Dw";
2698       for (auto ExceptTy : T->exceptions())
2699         mangleType(ExceptTy);
2700       Out << "E";
2701     }
2702   } else if (T->isNothrow(getASTContext())) {
2703     Out << "Do";
2704   }
2705 
2706   Out << 'F';
2707 
2708   // FIXME: We don't have enough information in the AST to produce the 'Y'
2709   // encoding for extern "C" function types.
2710   mangleBareFunctionType(T, /*MangleReturnType=*/true);
2711 
2712   // Mangle the ref-qualifier, if present.
2713   mangleRefQualifier(T->getRefQualifier());
2714 
2715   Out << 'E';
2716 }
2717 
2718 void CXXNameMangler::mangleType(const FunctionNoProtoType *T) {
2719   // Function types without prototypes can arise when mangling a function type
2720   // within an overloadable function in C. We mangle these as the absence of any
2721   // parameter types (not even an empty parameter list).
2722   Out << 'F';
2723 
2724   FunctionTypeDepthState saved = FunctionTypeDepth.push();
2725 
2726   FunctionTypeDepth.enterResultType();
2727   mangleType(T->getReturnType());
2728   FunctionTypeDepth.leaveResultType();
2729 
2730   FunctionTypeDepth.pop(saved);
2731   Out << 'E';
2732 }
2733 
2734 void CXXNameMangler::mangleBareFunctionType(const FunctionProtoType *Proto,
2735                                             bool MangleReturnType,
2736                                             const FunctionDecl *FD) {
2737   // Record that we're in a function type.  See mangleFunctionParam
2738   // for details on what we're trying to achieve here.
2739   FunctionTypeDepthState saved = FunctionTypeDepth.push();
2740 
2741   // <bare-function-type> ::= <signature type>+
2742   if (MangleReturnType) {
2743     FunctionTypeDepth.enterResultType();
2744 
2745     // Mangle ns_returns_retained as an order-sensitive qualifier here.
2746     if (Proto->getExtInfo().getProducesResult() && FD == nullptr)
2747       mangleVendorQualifier("ns_returns_retained");
2748 
2749     // Mangle the return type without any direct ARC ownership qualifiers.
2750     QualType ReturnTy = Proto->getReturnType();
2751     if (ReturnTy.getObjCLifetime()) {
2752       auto SplitReturnTy = ReturnTy.split();
2753       SplitReturnTy.Quals.removeObjCLifetime();
2754       ReturnTy = getASTContext().getQualifiedType(SplitReturnTy);
2755     }
2756     mangleType(ReturnTy);
2757 
2758     FunctionTypeDepth.leaveResultType();
2759   }
2760 
2761   if (Proto->getNumParams() == 0 && !Proto->isVariadic()) {
2762     //   <builtin-type> ::= v   # void
2763     Out << 'v';
2764 
2765     FunctionTypeDepth.pop(saved);
2766     return;
2767   }
2768 
2769   assert(!FD || FD->getNumParams() == Proto->getNumParams());
2770   for (unsigned I = 0, E = Proto->getNumParams(); I != E; ++I) {
2771     // Mangle extended parameter info as order-sensitive qualifiers here.
2772     if (Proto->hasExtParameterInfos() && FD == nullptr) {
2773       mangleExtParameterInfo(Proto->getExtParameterInfo(I));
2774     }
2775 
2776     // Mangle the type.
2777     QualType ParamTy = Proto->getParamType(I);
2778     mangleType(Context.getASTContext().getSignatureParameterType(ParamTy));
2779 
2780     if (FD) {
2781       if (auto *Attr = FD->getParamDecl(I)->getAttr<PassObjectSizeAttr>()) {
2782         // Attr can only take 1 character, so we can hardcode the length below.
2783         assert(Attr->getType() <= 9 && Attr->getType() >= 0);
2784         Out << "U17pass_object_size" << Attr->getType();
2785       }
2786     }
2787   }
2788 
2789   FunctionTypeDepth.pop(saved);
2790 
2791   // <builtin-type>      ::= z  # ellipsis
2792   if (Proto->isVariadic())
2793     Out << 'z';
2794 }
2795 
2796 // <type>            ::= <class-enum-type>
2797 // <class-enum-type> ::= <name>
2798 void CXXNameMangler::mangleType(const UnresolvedUsingType *T) {
2799   mangleName(T->getDecl());
2800 }
2801 
2802 // <type>            ::= <class-enum-type>
2803 // <class-enum-type> ::= <name>
2804 void CXXNameMangler::mangleType(const EnumType *T) {
2805   mangleType(static_cast<const TagType*>(T));
2806 }
2807 void CXXNameMangler::mangleType(const RecordType *T) {
2808   mangleType(static_cast<const TagType*>(T));
2809 }
2810 void CXXNameMangler::mangleType(const TagType *T) {
2811   mangleName(T->getDecl());
2812 }
2813 
2814 // <type>       ::= <array-type>
2815 // <array-type> ::= A <positive dimension number> _ <element type>
2816 //              ::= A [<dimension expression>] _ <element type>
2817 void CXXNameMangler::mangleType(const ConstantArrayType *T) {
2818   Out << 'A' << T->getSize() << '_';
2819   mangleType(T->getElementType());
2820 }
2821 void CXXNameMangler::mangleType(const VariableArrayType *T) {
2822   Out << 'A';
2823   // decayed vla types (size 0) will just be skipped.
2824   if (T->getSizeExpr())
2825     mangleExpression(T->getSizeExpr());
2826   Out << '_';
2827   mangleType(T->getElementType());
2828 }
2829 void CXXNameMangler::mangleType(const DependentSizedArrayType *T) {
2830   Out << 'A';
2831   mangleExpression(T->getSizeExpr());
2832   Out << '_';
2833   mangleType(T->getElementType());
2834 }
2835 void CXXNameMangler::mangleType(const IncompleteArrayType *T) {
2836   Out << "A_";
2837   mangleType(T->getElementType());
2838 }
2839 
2840 // <type>                   ::= <pointer-to-member-type>
2841 // <pointer-to-member-type> ::= M <class type> <member type>
2842 void CXXNameMangler::mangleType(const MemberPointerType *T) {
2843   Out << 'M';
2844   mangleType(QualType(T->getClass(), 0));
2845   QualType PointeeType = T->getPointeeType();
2846   if (const FunctionProtoType *FPT = dyn_cast<FunctionProtoType>(PointeeType)) {
2847     mangleType(FPT);
2848 
2849     // Itanium C++ ABI 5.1.8:
2850     //
2851     //   The type of a non-static member function is considered to be different,
2852     //   for the purposes of substitution, from the type of a namespace-scope or
2853     //   static member function whose type appears similar. The types of two
2854     //   non-static member functions are considered to be different, for the
2855     //   purposes of substitution, if the functions are members of different
2856     //   classes. In other words, for the purposes of substitution, the class of
2857     //   which the function is a member is considered part of the type of
2858     //   function.
2859 
2860     // Given that we already substitute member function pointers as a
2861     // whole, the net effect of this rule is just to unconditionally
2862     // suppress substitution on the function type in a member pointer.
2863     // We increment the SeqID here to emulate adding an entry to the
2864     // substitution table.
2865     ++SeqID;
2866   } else
2867     mangleType(PointeeType);
2868 }
2869 
2870 // <type>           ::= <template-param>
2871 void CXXNameMangler::mangleType(const TemplateTypeParmType *T) {
2872   mangleTemplateParameter(T->getIndex());
2873 }
2874 
2875 // <type>           ::= <template-param>
2876 void CXXNameMangler::mangleType(const SubstTemplateTypeParmPackType *T) {
2877   // FIXME: not clear how to mangle this!
2878   // template <class T...> class A {
2879   //   template <class U...> void foo(T(*)(U) x...);
2880   // };
2881   Out << "_SUBSTPACK_";
2882 }
2883 
2884 // <type> ::= P <type>   # pointer-to
2885 void CXXNameMangler::mangleType(const PointerType *T) {
2886   Out << 'P';
2887   mangleType(T->getPointeeType());
2888 }
2889 void CXXNameMangler::mangleType(const ObjCObjectPointerType *T) {
2890   Out << 'P';
2891   mangleType(T->getPointeeType());
2892 }
2893 
2894 // <type> ::= R <type>   # reference-to
2895 void CXXNameMangler::mangleType(const LValueReferenceType *T) {
2896   Out << 'R';
2897   mangleType(T->getPointeeType());
2898 }
2899 
2900 // <type> ::= O <type>   # rvalue reference-to (C++0x)
2901 void CXXNameMangler::mangleType(const RValueReferenceType *T) {
2902   Out << 'O';
2903   mangleType(T->getPointeeType());
2904 }
2905 
2906 // <type> ::= C <type>   # complex pair (C 2000)
2907 void CXXNameMangler::mangleType(const ComplexType *T) {
2908   Out << 'C';
2909   mangleType(T->getElementType());
2910 }
2911 
2912 // ARM's ABI for Neon vector types specifies that they should be mangled as
2913 // if they are structs (to match ARM's initial implementation).  The
2914 // vector type must be one of the special types predefined by ARM.
2915 void CXXNameMangler::mangleNeonVectorType(const VectorType *T) {
2916   QualType EltType = T->getElementType();
2917   assert(EltType->isBuiltinType() && "Neon vector element not a BuiltinType");
2918   const char *EltName = nullptr;
2919   if (T->getVectorKind() == VectorType::NeonPolyVector) {
2920     switch (cast<BuiltinType>(EltType)->getKind()) {
2921     case BuiltinType::SChar:
2922     case BuiltinType::UChar:
2923       EltName = "poly8_t";
2924       break;
2925     case BuiltinType::Short:
2926     case BuiltinType::UShort:
2927       EltName = "poly16_t";
2928       break;
2929     case BuiltinType::ULongLong:
2930       EltName = "poly64_t";
2931       break;
2932     default: llvm_unreachable("unexpected Neon polynomial vector element type");
2933     }
2934   } else {
2935     switch (cast<BuiltinType>(EltType)->getKind()) {
2936     case BuiltinType::SChar:     EltName = "int8_t"; break;
2937     case BuiltinType::UChar:     EltName = "uint8_t"; break;
2938     case BuiltinType::Short:     EltName = "int16_t"; break;
2939     case BuiltinType::UShort:    EltName = "uint16_t"; break;
2940     case BuiltinType::Int:       EltName = "int32_t"; break;
2941     case BuiltinType::UInt:      EltName = "uint32_t"; break;
2942     case BuiltinType::LongLong:  EltName = "int64_t"; break;
2943     case BuiltinType::ULongLong: EltName = "uint64_t"; break;
2944     case BuiltinType::Double:    EltName = "float64_t"; break;
2945     case BuiltinType::Float:     EltName = "float32_t"; break;
2946     case BuiltinType::Half:      EltName = "float16_t";break;
2947     default:
2948       llvm_unreachable("unexpected Neon vector element type");
2949     }
2950   }
2951   const char *BaseName = nullptr;
2952   unsigned BitSize = (T->getNumElements() *
2953                       getASTContext().getTypeSize(EltType));
2954   if (BitSize == 64)
2955     BaseName = "__simd64_";
2956   else {
2957     assert(BitSize == 128 && "Neon vector type not 64 or 128 bits");
2958     BaseName = "__simd128_";
2959   }
2960   Out << strlen(BaseName) + strlen(EltName);
2961   Out << BaseName << EltName;
2962 }
2963 
2964 static StringRef mangleAArch64VectorBase(const BuiltinType *EltType) {
2965   switch (EltType->getKind()) {
2966   case BuiltinType::SChar:
2967     return "Int8";
2968   case BuiltinType::Short:
2969     return "Int16";
2970   case BuiltinType::Int:
2971     return "Int32";
2972   case BuiltinType::Long:
2973   case BuiltinType::LongLong:
2974     return "Int64";
2975   case BuiltinType::UChar:
2976     return "Uint8";
2977   case BuiltinType::UShort:
2978     return "Uint16";
2979   case BuiltinType::UInt:
2980     return "Uint32";
2981   case BuiltinType::ULong:
2982   case BuiltinType::ULongLong:
2983     return "Uint64";
2984   case BuiltinType::Half:
2985     return "Float16";
2986   case BuiltinType::Float:
2987     return "Float32";
2988   case BuiltinType::Double:
2989     return "Float64";
2990   default:
2991     llvm_unreachable("Unexpected vector element base type");
2992   }
2993 }
2994 
2995 // AArch64's ABI for Neon vector types specifies that they should be mangled as
2996 // the equivalent internal name. The vector type must be one of the special
2997 // types predefined by ARM.
2998 void CXXNameMangler::mangleAArch64NeonVectorType(const VectorType *T) {
2999   QualType EltType = T->getElementType();
3000   assert(EltType->isBuiltinType() && "Neon vector element not a BuiltinType");
3001   unsigned BitSize =
3002       (T->getNumElements() * getASTContext().getTypeSize(EltType));
3003   (void)BitSize; // Silence warning.
3004 
3005   assert((BitSize == 64 || BitSize == 128) &&
3006          "Neon vector type not 64 or 128 bits");
3007 
3008   StringRef EltName;
3009   if (T->getVectorKind() == VectorType::NeonPolyVector) {
3010     switch (cast<BuiltinType>(EltType)->getKind()) {
3011     case BuiltinType::UChar:
3012       EltName = "Poly8";
3013       break;
3014     case BuiltinType::UShort:
3015       EltName = "Poly16";
3016       break;
3017     case BuiltinType::ULong:
3018     case BuiltinType::ULongLong:
3019       EltName = "Poly64";
3020       break;
3021     default:
3022       llvm_unreachable("unexpected Neon polynomial vector element type");
3023     }
3024   } else
3025     EltName = mangleAArch64VectorBase(cast<BuiltinType>(EltType));
3026 
3027   std::string TypeName =
3028       ("__" + EltName + "x" + Twine(T->getNumElements()) + "_t").str();
3029   Out << TypeName.length() << TypeName;
3030 }
3031 
3032 // GNU extension: vector types
3033 // <type>                  ::= <vector-type>
3034 // <vector-type>           ::= Dv <positive dimension number> _
3035 //                                    <extended element type>
3036 //                         ::= Dv [<dimension expression>] _ <element type>
3037 // <extended element type> ::= <element type>
3038 //                         ::= p # AltiVec vector pixel
3039 //                         ::= b # Altivec vector bool
3040 void CXXNameMangler::mangleType(const VectorType *T) {
3041   if ((T->getVectorKind() == VectorType::NeonVector ||
3042        T->getVectorKind() == VectorType::NeonPolyVector)) {
3043     llvm::Triple Target = getASTContext().getTargetInfo().getTriple();
3044     llvm::Triple::ArchType Arch =
3045         getASTContext().getTargetInfo().getTriple().getArch();
3046     if ((Arch == llvm::Triple::aarch64 ||
3047          Arch == llvm::Triple::aarch64_be) && !Target.isOSDarwin())
3048       mangleAArch64NeonVectorType(T);
3049     else
3050       mangleNeonVectorType(T);
3051     return;
3052   }
3053   Out << "Dv" << T->getNumElements() << '_';
3054   if (T->getVectorKind() == VectorType::AltiVecPixel)
3055     Out << 'p';
3056   else if (T->getVectorKind() == VectorType::AltiVecBool)
3057     Out << 'b';
3058   else
3059     mangleType(T->getElementType());
3060 }
3061 void CXXNameMangler::mangleType(const ExtVectorType *T) {
3062   mangleType(static_cast<const VectorType*>(T));
3063 }
3064 void CXXNameMangler::mangleType(const DependentSizedExtVectorType *T) {
3065   Out << "Dv";
3066   mangleExpression(T->getSizeExpr());
3067   Out << '_';
3068   mangleType(T->getElementType());
3069 }
3070 
3071 void CXXNameMangler::mangleType(const DependentAddressSpaceType *T) {
3072   SplitQualType split = T->getPointeeType().split();
3073   mangleQualifiers(split.Quals, T);
3074   mangleType(QualType(split.Ty, 0));
3075 }
3076 
3077 void CXXNameMangler::mangleType(const PackExpansionType *T) {
3078   // <type>  ::= Dp <type>          # pack expansion (C++0x)
3079   Out << "Dp";
3080   mangleType(T->getPattern());
3081 }
3082 
3083 void CXXNameMangler::mangleType(const ObjCInterfaceType *T) {
3084   mangleSourceName(T->getDecl()->getIdentifier());
3085 }
3086 
3087 void CXXNameMangler::mangleType(const ObjCObjectType *T) {
3088   // Treat __kindof as a vendor extended type qualifier.
3089   if (T->isKindOfType())
3090     Out << "U8__kindof";
3091 
3092   if (!T->qual_empty()) {
3093     // Mangle protocol qualifiers.
3094     SmallString<64> QualStr;
3095     llvm::raw_svector_ostream QualOS(QualStr);
3096     QualOS << "objcproto";
3097     for (const auto *I : T->quals()) {
3098       StringRef name = I->getName();
3099       QualOS << name.size() << name;
3100     }
3101     Out << 'U' << QualStr.size() << QualStr;
3102   }
3103 
3104   mangleType(T->getBaseType());
3105 
3106   if (T->isSpecialized()) {
3107     // Mangle type arguments as I <type>+ E
3108     Out << 'I';
3109     for (auto typeArg : T->getTypeArgs())
3110       mangleType(typeArg);
3111     Out << 'E';
3112   }
3113 }
3114 
3115 void CXXNameMangler::mangleType(const BlockPointerType *T) {
3116   Out << "U13block_pointer";
3117   mangleType(T->getPointeeType());
3118 }
3119 
3120 void CXXNameMangler::mangleType(const InjectedClassNameType *T) {
3121   // Mangle injected class name types as if the user had written the
3122   // specialization out fully.  It may not actually be possible to see
3123   // this mangling, though.
3124   mangleType(T->getInjectedSpecializationType());
3125 }
3126 
3127 void CXXNameMangler::mangleType(const TemplateSpecializationType *T) {
3128   if (TemplateDecl *TD = T->getTemplateName().getAsTemplateDecl()) {
3129     mangleTemplateName(TD, T->getArgs(), T->getNumArgs());
3130   } else {
3131     if (mangleSubstitution(QualType(T, 0)))
3132       return;
3133 
3134     mangleTemplatePrefix(T->getTemplateName());
3135 
3136     // FIXME: GCC does not appear to mangle the template arguments when
3137     // the template in question is a dependent template name. Should we
3138     // emulate that badness?
3139     mangleTemplateArgs(T->getArgs(), T->getNumArgs());
3140     addSubstitution(QualType(T, 0));
3141   }
3142 }
3143 
3144 void CXXNameMangler::mangleType(const DependentNameType *T) {
3145   // Proposal by cxx-abi-dev, 2014-03-26
3146   // <class-enum-type> ::= <name>    # non-dependent or dependent type name or
3147   //                                 # dependent elaborated type specifier using
3148   //                                 # 'typename'
3149   //                   ::= Ts <name> # dependent elaborated type specifier using
3150   //                                 # 'struct' or 'class'
3151   //                   ::= Tu <name> # dependent elaborated type specifier using
3152   //                                 # 'union'
3153   //                   ::= Te <name> # dependent elaborated type specifier using
3154   //                                 # 'enum'
3155   switch (T->getKeyword()) {
3156     case ETK_None:
3157     case ETK_Typename:
3158       break;
3159     case ETK_Struct:
3160     case ETK_Class:
3161     case ETK_Interface:
3162       Out << "Ts";
3163       break;
3164     case ETK_Union:
3165       Out << "Tu";
3166       break;
3167     case ETK_Enum:
3168       Out << "Te";
3169       break;
3170   }
3171   // Typename types are always nested
3172   Out << 'N';
3173   manglePrefix(T->getQualifier());
3174   mangleSourceName(T->getIdentifier());
3175   Out << 'E';
3176 }
3177 
3178 void CXXNameMangler::mangleType(const DependentTemplateSpecializationType *T) {
3179   // Dependently-scoped template types are nested if they have a prefix.
3180   Out << 'N';
3181 
3182   // TODO: avoid making this TemplateName.
3183   TemplateName Prefix =
3184     getASTContext().getDependentTemplateName(T->getQualifier(),
3185                                              T->getIdentifier());
3186   mangleTemplatePrefix(Prefix);
3187 
3188   // FIXME: GCC does not appear to mangle the template arguments when
3189   // the template in question is a dependent template name. Should we
3190   // emulate that badness?
3191   mangleTemplateArgs(T->getArgs(), T->getNumArgs());
3192   Out << 'E';
3193 }
3194 
3195 void CXXNameMangler::mangleType(const TypeOfType *T) {
3196   // FIXME: this is pretty unsatisfactory, but there isn't an obvious
3197   // "extension with parameters" mangling.
3198   Out << "u6typeof";
3199 }
3200 
3201 void CXXNameMangler::mangleType(const TypeOfExprType *T) {
3202   // FIXME: this is pretty unsatisfactory, but there isn't an obvious
3203   // "extension with parameters" mangling.
3204   Out << "u6typeof";
3205 }
3206 
3207 void CXXNameMangler::mangleType(const DecltypeType *T) {
3208   Expr *E = T->getUnderlyingExpr();
3209 
3210   // type ::= Dt <expression> E  # decltype of an id-expression
3211   //                             #   or class member access
3212   //      ::= DT <expression> E  # decltype of an expression
3213 
3214   // This purports to be an exhaustive list of id-expressions and
3215   // class member accesses.  Note that we do not ignore parentheses;
3216   // parentheses change the semantics of decltype for these
3217   // expressions (and cause the mangler to use the other form).
3218   if (isa<DeclRefExpr>(E) ||
3219       isa<MemberExpr>(E) ||
3220       isa<UnresolvedLookupExpr>(E) ||
3221       isa<DependentScopeDeclRefExpr>(E) ||
3222       isa<CXXDependentScopeMemberExpr>(E) ||
3223       isa<UnresolvedMemberExpr>(E))
3224     Out << "Dt";
3225   else
3226     Out << "DT";
3227   mangleExpression(E);
3228   Out << 'E';
3229 }
3230 
3231 void CXXNameMangler::mangleType(const UnaryTransformType *T) {
3232   // If this is dependent, we need to record that. If not, we simply
3233   // mangle it as the underlying type since they are equivalent.
3234   if (T->isDependentType()) {
3235     Out << 'U';
3236 
3237     switch (T->getUTTKind()) {
3238       case UnaryTransformType::EnumUnderlyingType:
3239         Out << "3eut";
3240         break;
3241     }
3242   }
3243 
3244   mangleType(T->getBaseType());
3245 }
3246 
3247 void CXXNameMangler::mangleType(const AutoType *T) {
3248   QualType D = T->getDeducedType();
3249   // <builtin-type> ::= Da  # dependent auto
3250   if (D.isNull()) {
3251     assert(T->getKeyword() != AutoTypeKeyword::GNUAutoType &&
3252            "shouldn't need to mangle __auto_type!");
3253     Out << (T->isDecltypeAuto() ? "Dc" : "Da");
3254   } else
3255     mangleType(D);
3256 }
3257 
3258 void CXXNameMangler::mangleType(const DeducedTemplateSpecializationType *T) {
3259   // FIXME: This is not the right mangling. We also need to include a scope
3260   // here in some cases.
3261   QualType D = T->getDeducedType();
3262   if (D.isNull())
3263     mangleUnscopedTemplateName(T->getTemplateName(), nullptr);
3264   else
3265     mangleType(D);
3266 }
3267 
3268 void CXXNameMangler::mangleType(const AtomicType *T) {
3269   // <type> ::= U <source-name> <type>  # vendor extended type qualifier
3270   // (Until there's a standardized mangling...)
3271   Out << "U7_Atomic";
3272   mangleType(T->getValueType());
3273 }
3274 
3275 void CXXNameMangler::mangleType(const PipeType *T) {
3276   // Pipe type mangling rules are described in SPIR 2.0 specification
3277   // A.1 Data types and A.3 Summary of changes
3278   // <type> ::= 8ocl_pipe
3279   Out << "8ocl_pipe";
3280 }
3281 
3282 void CXXNameMangler::mangleIntegerLiteral(QualType T,
3283                                           const llvm::APSInt &Value) {
3284   //  <expr-primary> ::= L <type> <value number> E # integer literal
3285   Out << 'L';
3286 
3287   mangleType(T);
3288   if (T->isBooleanType()) {
3289     // Boolean values are encoded as 0/1.
3290     Out << (Value.getBoolValue() ? '1' : '0');
3291   } else {
3292     mangleNumber(Value);
3293   }
3294   Out << 'E';
3295 
3296 }
3297 
3298 void CXXNameMangler::mangleMemberExprBase(const Expr *Base, bool IsArrow) {
3299   // Ignore member expressions involving anonymous unions.
3300   while (const auto *RT = Base->getType()->getAs<RecordType>()) {
3301     if (!RT->getDecl()->isAnonymousStructOrUnion())
3302       break;
3303     const auto *ME = dyn_cast<MemberExpr>(Base);
3304     if (!ME)
3305       break;
3306     Base = ME->getBase();
3307     IsArrow = ME->isArrow();
3308   }
3309 
3310   if (Base->isImplicitCXXThis()) {
3311     // Note: GCC mangles member expressions to the implicit 'this' as
3312     // *this., whereas we represent them as this->. The Itanium C++ ABI
3313     // does not specify anything here, so we follow GCC.
3314     Out << "dtdefpT";
3315   } else {
3316     Out << (IsArrow ? "pt" : "dt");
3317     mangleExpression(Base);
3318   }
3319 }
3320 
3321 /// Mangles a member expression.
3322 void CXXNameMangler::mangleMemberExpr(const Expr *base,
3323                                       bool isArrow,
3324                                       NestedNameSpecifier *qualifier,
3325                                       NamedDecl *firstQualifierLookup,
3326                                       DeclarationName member,
3327                                       const TemplateArgumentLoc *TemplateArgs,
3328                                       unsigned NumTemplateArgs,
3329                                       unsigned arity) {
3330   // <expression> ::= dt <expression> <unresolved-name>
3331   //              ::= pt <expression> <unresolved-name>
3332   if (base)
3333     mangleMemberExprBase(base, isArrow);
3334   mangleUnresolvedName(qualifier, member, TemplateArgs, NumTemplateArgs, arity);
3335 }
3336 
3337 /// Look at the callee of the given call expression and determine if
3338 /// it's a parenthesized id-expression which would have triggered ADL
3339 /// otherwise.
3340 static bool isParenthesizedADLCallee(const CallExpr *call) {
3341   const Expr *callee = call->getCallee();
3342   const Expr *fn = callee->IgnoreParens();
3343 
3344   // Must be parenthesized.  IgnoreParens() skips __extension__ nodes,
3345   // too, but for those to appear in the callee, it would have to be
3346   // parenthesized.
3347   if (callee == fn) return false;
3348 
3349   // Must be an unresolved lookup.
3350   const UnresolvedLookupExpr *lookup = dyn_cast<UnresolvedLookupExpr>(fn);
3351   if (!lookup) return false;
3352 
3353   assert(!lookup->requiresADL());
3354 
3355   // Must be an unqualified lookup.
3356   if (lookup->getQualifier()) return false;
3357 
3358   // Must not have found a class member.  Note that if one is a class
3359   // member, they're all class members.
3360   if (lookup->getNumDecls() > 0 &&
3361       (*lookup->decls_begin())->isCXXClassMember())
3362     return false;
3363 
3364   // Otherwise, ADL would have been triggered.
3365   return true;
3366 }
3367 
3368 void CXXNameMangler::mangleCastExpression(const Expr *E, StringRef CastEncoding) {
3369   const ExplicitCastExpr *ECE = cast<ExplicitCastExpr>(E);
3370   Out << CastEncoding;
3371   mangleType(ECE->getType());
3372   mangleExpression(ECE->getSubExpr());
3373 }
3374 
3375 void CXXNameMangler::mangleInitListElements(const InitListExpr *InitList) {
3376   if (auto *Syntactic = InitList->getSyntacticForm())
3377     InitList = Syntactic;
3378   for (unsigned i = 0, e = InitList->getNumInits(); i != e; ++i)
3379     mangleExpression(InitList->getInit(i));
3380 }
3381 
3382 void CXXNameMangler::mangleExpression(const Expr *E, unsigned Arity) {
3383   // <expression> ::= <unary operator-name> <expression>
3384   //              ::= <binary operator-name> <expression> <expression>
3385   //              ::= <trinary operator-name> <expression> <expression> <expression>
3386   //              ::= cv <type> expression           # conversion with one argument
3387   //              ::= cv <type> _ <expression>* E # conversion with a different number of arguments
3388   //              ::= dc <type> <expression>         # dynamic_cast<type> (expression)
3389   //              ::= sc <type> <expression>         # static_cast<type> (expression)
3390   //              ::= cc <type> <expression>         # const_cast<type> (expression)
3391   //              ::= rc <type> <expression>         # reinterpret_cast<type> (expression)
3392   //              ::= st <type>                      # sizeof (a type)
3393   //              ::= at <type>                      # alignof (a type)
3394   //              ::= <template-param>
3395   //              ::= <function-param>
3396   //              ::= sr <type> <unqualified-name>                   # dependent name
3397   //              ::= sr <type> <unqualified-name> <template-args>   # dependent template-id
3398   //              ::= ds <expression> <expression>                   # expr.*expr
3399   //              ::= sZ <template-param>                            # size of a parameter pack
3400   //              ::= sZ <function-param>    # size of a function parameter pack
3401   //              ::= <expr-primary>
3402   // <expr-primary> ::= L <type> <value number> E    # integer literal
3403   //                ::= L <type <value float> E      # floating literal
3404   //                ::= L <mangled-name> E           # external name
3405   //                ::= fpT                          # 'this' expression
3406   QualType ImplicitlyConvertedToType;
3407 
3408 recurse:
3409   switch (E->getStmtClass()) {
3410   case Expr::NoStmtClass:
3411 #define ABSTRACT_STMT(Type)
3412 #define EXPR(Type, Base)
3413 #define STMT(Type, Base) \
3414   case Expr::Type##Class:
3415 #include "clang/AST/StmtNodes.inc"
3416     // fallthrough
3417 
3418   // These all can only appear in local or variable-initialization
3419   // contexts and so should never appear in a mangling.
3420   case Expr::AddrLabelExprClass:
3421   case Expr::DesignatedInitUpdateExprClass:
3422   case Expr::ImplicitValueInitExprClass:
3423   case Expr::ArrayInitLoopExprClass:
3424   case Expr::ArrayInitIndexExprClass:
3425   case Expr::NoInitExprClass:
3426   case Expr::ParenListExprClass:
3427   case Expr::LambdaExprClass:
3428   case Expr::MSPropertyRefExprClass:
3429   case Expr::MSPropertySubscriptExprClass:
3430   case Expr::TypoExprClass:  // This should no longer exist in the AST by now.
3431   case Expr::OMPArraySectionExprClass:
3432   case Expr::CXXInheritedCtorInitExprClass:
3433     llvm_unreachable("unexpected statement kind");
3434 
3435   // FIXME: invent manglings for all these.
3436   case Expr::BlockExprClass:
3437   case Expr::ChooseExprClass:
3438   case Expr::CompoundLiteralExprClass:
3439   case Expr::ExtVectorElementExprClass:
3440   case Expr::GenericSelectionExprClass:
3441   case Expr::ObjCEncodeExprClass:
3442   case Expr::ObjCIsaExprClass:
3443   case Expr::ObjCIvarRefExprClass:
3444   case Expr::ObjCMessageExprClass:
3445   case Expr::ObjCPropertyRefExprClass:
3446   case Expr::ObjCProtocolExprClass:
3447   case Expr::ObjCSelectorExprClass:
3448   case Expr::ObjCStringLiteralClass:
3449   case Expr::ObjCBoxedExprClass:
3450   case Expr::ObjCArrayLiteralClass:
3451   case Expr::ObjCDictionaryLiteralClass:
3452   case Expr::ObjCSubscriptRefExprClass:
3453   case Expr::ObjCIndirectCopyRestoreExprClass:
3454   case Expr::ObjCAvailabilityCheckExprClass:
3455   case Expr::OffsetOfExprClass:
3456   case Expr::PredefinedExprClass:
3457   case Expr::ShuffleVectorExprClass:
3458   case Expr::ConvertVectorExprClass:
3459   case Expr::StmtExprClass:
3460   case Expr::TypeTraitExprClass:
3461   case Expr::ArrayTypeTraitExprClass:
3462   case Expr::ExpressionTraitExprClass:
3463   case Expr::VAArgExprClass:
3464   case Expr::CUDAKernelCallExprClass:
3465   case Expr::AsTypeExprClass:
3466   case Expr::PseudoObjectExprClass:
3467   case Expr::AtomicExprClass:
3468   {
3469     if (!NullOut) {
3470       // As bad as this diagnostic is, it's better than crashing.
3471       DiagnosticsEngine &Diags = Context.getDiags();
3472       unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
3473                                        "cannot yet mangle expression type %0");
3474       Diags.Report(E->getExprLoc(), DiagID)
3475         << E->getStmtClassName() << E->getSourceRange();
3476     }
3477     break;
3478   }
3479 
3480   case Expr::CXXUuidofExprClass: {
3481     const CXXUuidofExpr *UE = cast<CXXUuidofExpr>(E);
3482     if (UE->isTypeOperand()) {
3483       QualType UuidT = UE->getTypeOperand(Context.getASTContext());
3484       Out << "u8__uuidoft";
3485       mangleType(UuidT);
3486     } else {
3487       Expr *UuidExp = UE->getExprOperand();
3488       Out << "u8__uuidofz";
3489       mangleExpression(UuidExp, Arity);
3490     }
3491     break;
3492   }
3493 
3494   // Even gcc-4.5 doesn't mangle this.
3495   case Expr::BinaryConditionalOperatorClass: {
3496     DiagnosticsEngine &Diags = Context.getDiags();
3497     unsigned DiagID =
3498       Diags.getCustomDiagID(DiagnosticsEngine::Error,
3499                 "?: operator with omitted middle operand cannot be mangled");
3500     Diags.Report(E->getExprLoc(), DiagID)
3501       << E->getStmtClassName() << E->getSourceRange();
3502     break;
3503   }
3504 
3505   // These are used for internal purposes and cannot be meaningfully mangled.
3506   case Expr::OpaqueValueExprClass:
3507     llvm_unreachable("cannot mangle opaque value; mangling wrong thing?");
3508 
3509   case Expr::InitListExprClass: {
3510     Out << "il";
3511     mangleInitListElements(cast<InitListExpr>(E));
3512     Out << "E";
3513     break;
3514   }
3515 
3516   case Expr::DesignatedInitExprClass: {
3517     auto *DIE = cast<DesignatedInitExpr>(E);
3518     for (const auto &Designator : DIE->designators()) {
3519       if (Designator.isFieldDesignator()) {
3520         Out << "di";
3521         mangleSourceName(Designator.getFieldName());
3522       } else if (Designator.isArrayDesignator()) {
3523         Out << "dx";
3524         mangleExpression(DIE->getArrayIndex(Designator));
3525       } else {
3526         assert(Designator.isArrayRangeDesignator() &&
3527                "unknown designator kind");
3528         Out << "dX";
3529         mangleExpression(DIE->getArrayRangeStart(Designator));
3530         mangleExpression(DIE->getArrayRangeEnd(Designator));
3531       }
3532     }
3533     mangleExpression(DIE->getInit());
3534     break;
3535   }
3536 
3537   case Expr::CXXDefaultArgExprClass:
3538     mangleExpression(cast<CXXDefaultArgExpr>(E)->getExpr(), Arity);
3539     break;
3540 
3541   case Expr::CXXDefaultInitExprClass:
3542     mangleExpression(cast<CXXDefaultInitExpr>(E)->getExpr(), Arity);
3543     break;
3544 
3545   case Expr::CXXStdInitializerListExprClass:
3546     mangleExpression(cast<CXXStdInitializerListExpr>(E)->getSubExpr(), Arity);
3547     break;
3548 
3549   case Expr::SubstNonTypeTemplateParmExprClass:
3550     mangleExpression(cast<SubstNonTypeTemplateParmExpr>(E)->getReplacement(),
3551                      Arity);
3552     break;
3553 
3554   case Expr::UserDefinedLiteralClass:
3555     // We follow g++'s approach of mangling a UDL as a call to the literal
3556     // operator.
3557   case Expr::CXXMemberCallExprClass: // fallthrough
3558   case Expr::CallExprClass: {
3559     const CallExpr *CE = cast<CallExpr>(E);
3560 
3561     // <expression> ::= cp <simple-id> <expression>* E
3562     // We use this mangling only when the call would use ADL except
3563     // for being parenthesized.  Per discussion with David
3564     // Vandervoorde, 2011.04.25.
3565     if (isParenthesizedADLCallee(CE)) {
3566       Out << "cp";
3567       // The callee here is a parenthesized UnresolvedLookupExpr with
3568       // no qualifier and should always get mangled as a <simple-id>
3569       // anyway.
3570 
3571     // <expression> ::= cl <expression>* E
3572     } else {
3573       Out << "cl";
3574     }
3575 
3576     unsigned CallArity = CE->getNumArgs();
3577     for (const Expr *Arg : CE->arguments())
3578       if (isa<PackExpansionExpr>(Arg))
3579         CallArity = UnknownArity;
3580 
3581     mangleExpression(CE->getCallee(), CallArity);
3582     for (const Expr *Arg : CE->arguments())
3583       mangleExpression(Arg);
3584     Out << 'E';
3585     break;
3586   }
3587 
3588   case Expr::CXXNewExprClass: {
3589     const CXXNewExpr *New = cast<CXXNewExpr>(E);
3590     if (New->isGlobalNew()) Out << "gs";
3591     Out << (New->isArray() ? "na" : "nw");
3592     for (CXXNewExpr::const_arg_iterator I = New->placement_arg_begin(),
3593            E = New->placement_arg_end(); I != E; ++I)
3594       mangleExpression(*I);
3595     Out << '_';
3596     mangleType(New->getAllocatedType());
3597     if (New->hasInitializer()) {
3598       if (New->getInitializationStyle() == CXXNewExpr::ListInit)
3599         Out << "il";
3600       else
3601         Out << "pi";
3602       const Expr *Init = New->getInitializer();
3603       if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(Init)) {
3604         // Directly inline the initializers.
3605         for (CXXConstructExpr::const_arg_iterator I = CCE->arg_begin(),
3606                                                   E = CCE->arg_end();
3607              I != E; ++I)
3608           mangleExpression(*I);
3609       } else if (const ParenListExpr *PLE = dyn_cast<ParenListExpr>(Init)) {
3610         for (unsigned i = 0, e = PLE->getNumExprs(); i != e; ++i)
3611           mangleExpression(PLE->getExpr(i));
3612       } else if (New->getInitializationStyle() == CXXNewExpr::ListInit &&
3613                  isa<InitListExpr>(Init)) {
3614         // Only take InitListExprs apart for list-initialization.
3615         mangleInitListElements(cast<InitListExpr>(Init));
3616       } else
3617         mangleExpression(Init);
3618     }
3619     Out << 'E';
3620     break;
3621   }
3622 
3623   case Expr::CXXPseudoDestructorExprClass: {
3624     const auto *PDE = cast<CXXPseudoDestructorExpr>(E);
3625     if (const Expr *Base = PDE->getBase())
3626       mangleMemberExprBase(Base, PDE->isArrow());
3627     NestedNameSpecifier *Qualifier = PDE->getQualifier();
3628     QualType ScopeType;
3629     if (TypeSourceInfo *ScopeInfo = PDE->getScopeTypeInfo()) {
3630       if (Qualifier) {
3631         mangleUnresolvedPrefix(Qualifier,
3632                                /*Recursive=*/true);
3633         mangleUnresolvedTypeOrSimpleId(ScopeInfo->getType());
3634         Out << 'E';
3635       } else {
3636         Out << "sr";
3637         if (!mangleUnresolvedTypeOrSimpleId(ScopeInfo->getType()))
3638           Out << 'E';
3639       }
3640     } else if (Qualifier) {
3641       mangleUnresolvedPrefix(Qualifier);
3642     }
3643     // <base-unresolved-name> ::= dn <destructor-name>
3644     Out << "dn";
3645     QualType DestroyedType = PDE->getDestroyedType();
3646     mangleUnresolvedTypeOrSimpleId(DestroyedType);
3647     break;
3648   }
3649 
3650   case Expr::MemberExprClass: {
3651     const MemberExpr *ME = cast<MemberExpr>(E);
3652     mangleMemberExpr(ME->getBase(), ME->isArrow(),
3653                      ME->getQualifier(), nullptr,
3654                      ME->getMemberDecl()->getDeclName(),
3655                      ME->getTemplateArgs(), ME->getNumTemplateArgs(),
3656                      Arity);
3657     break;
3658   }
3659 
3660   case Expr::UnresolvedMemberExprClass: {
3661     const UnresolvedMemberExpr *ME = cast<UnresolvedMemberExpr>(E);
3662     mangleMemberExpr(ME->isImplicitAccess() ? nullptr : ME->getBase(),
3663                      ME->isArrow(), ME->getQualifier(), nullptr,
3664                      ME->getMemberName(),
3665                      ME->getTemplateArgs(), ME->getNumTemplateArgs(),
3666                      Arity);
3667     break;
3668   }
3669 
3670   case Expr::CXXDependentScopeMemberExprClass: {
3671     const CXXDependentScopeMemberExpr *ME
3672       = cast<CXXDependentScopeMemberExpr>(E);
3673     mangleMemberExpr(ME->isImplicitAccess() ? nullptr : ME->getBase(),
3674                      ME->isArrow(), ME->getQualifier(),
3675                      ME->getFirstQualifierFoundInScope(),
3676                      ME->getMember(),
3677                      ME->getTemplateArgs(), ME->getNumTemplateArgs(),
3678                      Arity);
3679     break;
3680   }
3681 
3682   case Expr::UnresolvedLookupExprClass: {
3683     const UnresolvedLookupExpr *ULE = cast<UnresolvedLookupExpr>(E);
3684     mangleUnresolvedName(ULE->getQualifier(), ULE->getName(),
3685                          ULE->getTemplateArgs(), ULE->getNumTemplateArgs(),
3686                          Arity);
3687     break;
3688   }
3689 
3690   case Expr::CXXUnresolvedConstructExprClass: {
3691     const CXXUnresolvedConstructExpr *CE = cast<CXXUnresolvedConstructExpr>(E);
3692     unsigned N = CE->arg_size();
3693 
3694     if (CE->isListInitialization()) {
3695       assert(N == 1 && "unexpected form for list initialization");
3696       auto *IL = cast<InitListExpr>(CE->getArg(0));
3697       Out << "tl";
3698       mangleType(CE->getType());
3699       mangleInitListElements(IL);
3700       Out << "E";
3701       return;
3702     }
3703 
3704     Out << "cv";
3705     mangleType(CE->getType());
3706     if (N != 1) Out << '_';
3707     for (unsigned I = 0; I != N; ++I) mangleExpression(CE->getArg(I));
3708     if (N != 1) Out << 'E';
3709     break;
3710   }
3711 
3712   case Expr::CXXConstructExprClass: {
3713     const auto *CE = cast<CXXConstructExpr>(E);
3714     if (!CE->isListInitialization() || CE->isStdInitListInitialization()) {
3715       assert(
3716           CE->getNumArgs() >= 1 &&
3717           (CE->getNumArgs() == 1 || isa<CXXDefaultArgExpr>(CE->getArg(1))) &&
3718           "implicit CXXConstructExpr must have one argument");
3719       return mangleExpression(cast<CXXConstructExpr>(E)->getArg(0));
3720     }
3721     Out << "il";
3722     for (auto *E : CE->arguments())
3723       mangleExpression(E);
3724     Out << "E";
3725     break;
3726   }
3727 
3728   case Expr::CXXTemporaryObjectExprClass: {
3729     const auto *CE = cast<CXXTemporaryObjectExpr>(E);
3730     unsigned N = CE->getNumArgs();
3731     bool List = CE->isListInitialization();
3732 
3733     if (List)
3734       Out << "tl";
3735     else
3736       Out << "cv";
3737     mangleType(CE->getType());
3738     if (!List && N != 1)
3739       Out << '_';
3740     if (CE->isStdInitListInitialization()) {
3741       // We implicitly created a std::initializer_list<T> for the first argument
3742       // of a constructor of type U in an expression of the form U{a, b, c}.
3743       // Strip all the semantic gunk off the initializer list.
3744       auto *SILE =
3745           cast<CXXStdInitializerListExpr>(CE->getArg(0)->IgnoreImplicit());
3746       auto *ILE = cast<InitListExpr>(SILE->getSubExpr()->IgnoreImplicit());
3747       mangleInitListElements(ILE);
3748     } else {
3749       for (auto *E : CE->arguments())
3750         mangleExpression(E);
3751     }
3752     if (List || N != 1)
3753       Out << 'E';
3754     break;
3755   }
3756 
3757   case Expr::CXXScalarValueInitExprClass:
3758     Out << "cv";
3759     mangleType(E->getType());
3760     Out << "_E";
3761     break;
3762 
3763   case Expr::CXXNoexceptExprClass:
3764     Out << "nx";
3765     mangleExpression(cast<CXXNoexceptExpr>(E)->getOperand());
3766     break;
3767 
3768   case Expr::UnaryExprOrTypeTraitExprClass: {
3769     const UnaryExprOrTypeTraitExpr *SAE = cast<UnaryExprOrTypeTraitExpr>(E);
3770 
3771     if (!SAE->isInstantiationDependent()) {
3772       // Itanium C++ ABI:
3773       //   If the operand of a sizeof or alignof operator is not
3774       //   instantiation-dependent it is encoded as an integer literal
3775       //   reflecting the result of the operator.
3776       //
3777       //   If the result of the operator is implicitly converted to a known
3778       //   integer type, that type is used for the literal; otherwise, the type
3779       //   of std::size_t or std::ptrdiff_t is used.
3780       QualType T = (ImplicitlyConvertedToType.isNull() ||
3781                     !ImplicitlyConvertedToType->isIntegerType())? SAE->getType()
3782                                                     : ImplicitlyConvertedToType;
3783       llvm::APSInt V = SAE->EvaluateKnownConstInt(Context.getASTContext());
3784       mangleIntegerLiteral(T, V);
3785       break;
3786     }
3787 
3788     switch(SAE->getKind()) {
3789     case UETT_SizeOf:
3790       Out << 's';
3791       break;
3792     case UETT_AlignOf:
3793       Out << 'a';
3794       break;
3795     case UETT_VecStep: {
3796       DiagnosticsEngine &Diags = Context.getDiags();
3797       unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
3798                                      "cannot yet mangle vec_step expression");
3799       Diags.Report(DiagID);
3800       return;
3801     }
3802     case UETT_OpenMPRequiredSimdAlign:
3803       DiagnosticsEngine &Diags = Context.getDiags();
3804       unsigned DiagID = Diags.getCustomDiagID(
3805           DiagnosticsEngine::Error,
3806           "cannot yet mangle __builtin_omp_required_simd_align expression");
3807       Diags.Report(DiagID);
3808       return;
3809     }
3810     if (SAE->isArgumentType()) {
3811       Out << 't';
3812       mangleType(SAE->getArgumentType());
3813     } else {
3814       Out << 'z';
3815       mangleExpression(SAE->getArgumentExpr());
3816     }
3817     break;
3818   }
3819 
3820   case Expr::CXXThrowExprClass: {
3821     const CXXThrowExpr *TE = cast<CXXThrowExpr>(E);
3822     //  <expression> ::= tw <expression>  # throw expression
3823     //               ::= tr               # rethrow
3824     if (TE->getSubExpr()) {
3825       Out << "tw";
3826       mangleExpression(TE->getSubExpr());
3827     } else {
3828       Out << "tr";
3829     }
3830     break;
3831   }
3832 
3833   case Expr::CXXTypeidExprClass: {
3834     const CXXTypeidExpr *TIE = cast<CXXTypeidExpr>(E);
3835     //  <expression> ::= ti <type>        # typeid (type)
3836     //               ::= te <expression>  # typeid (expression)
3837     if (TIE->isTypeOperand()) {
3838       Out << "ti";
3839       mangleType(TIE->getTypeOperand(Context.getASTContext()));
3840     } else {
3841       Out << "te";
3842       mangleExpression(TIE->getExprOperand());
3843     }
3844     break;
3845   }
3846 
3847   case Expr::CXXDeleteExprClass: {
3848     const CXXDeleteExpr *DE = cast<CXXDeleteExpr>(E);
3849     //  <expression> ::= [gs] dl <expression>  # [::] delete expr
3850     //               ::= [gs] da <expression>  # [::] delete [] expr
3851     if (DE->isGlobalDelete()) Out << "gs";
3852     Out << (DE->isArrayForm() ? "da" : "dl");
3853     mangleExpression(DE->getArgument());
3854     break;
3855   }
3856 
3857   case Expr::UnaryOperatorClass: {
3858     const UnaryOperator *UO = cast<UnaryOperator>(E);
3859     mangleOperatorName(UnaryOperator::getOverloadedOperator(UO->getOpcode()),
3860                        /*Arity=*/1);
3861     mangleExpression(UO->getSubExpr());
3862     break;
3863   }
3864 
3865   case Expr::ArraySubscriptExprClass: {
3866     const ArraySubscriptExpr *AE = cast<ArraySubscriptExpr>(E);
3867 
3868     // Array subscript is treated as a syntactically weird form of
3869     // binary operator.
3870     Out << "ix";
3871     mangleExpression(AE->getLHS());
3872     mangleExpression(AE->getRHS());
3873     break;
3874   }
3875 
3876   case Expr::CompoundAssignOperatorClass: // fallthrough
3877   case Expr::BinaryOperatorClass: {
3878     const BinaryOperator *BO = cast<BinaryOperator>(E);
3879     if (BO->getOpcode() == BO_PtrMemD)
3880       Out << "ds";
3881     else
3882       mangleOperatorName(BinaryOperator::getOverloadedOperator(BO->getOpcode()),
3883                          /*Arity=*/2);
3884     mangleExpression(BO->getLHS());
3885     mangleExpression(BO->getRHS());
3886     break;
3887   }
3888 
3889   case Expr::ConditionalOperatorClass: {
3890     const ConditionalOperator *CO = cast<ConditionalOperator>(E);
3891     mangleOperatorName(OO_Conditional, /*Arity=*/3);
3892     mangleExpression(CO->getCond());
3893     mangleExpression(CO->getLHS(), Arity);
3894     mangleExpression(CO->getRHS(), Arity);
3895     break;
3896   }
3897 
3898   case Expr::ImplicitCastExprClass: {
3899     ImplicitlyConvertedToType = E->getType();
3900     E = cast<ImplicitCastExpr>(E)->getSubExpr();
3901     goto recurse;
3902   }
3903 
3904   case Expr::ObjCBridgedCastExprClass: {
3905     // Mangle ownership casts as a vendor extended operator __bridge,
3906     // __bridge_transfer, or __bridge_retain.
3907     StringRef Kind = cast<ObjCBridgedCastExpr>(E)->getBridgeKindName();
3908     Out << "v1U" << Kind.size() << Kind;
3909   }
3910   // Fall through to mangle the cast itself.
3911   LLVM_FALLTHROUGH;
3912 
3913   case Expr::CStyleCastExprClass:
3914     mangleCastExpression(E, "cv");
3915     break;
3916 
3917   case Expr::CXXFunctionalCastExprClass: {
3918     auto *Sub = cast<ExplicitCastExpr>(E)->getSubExpr()->IgnoreImplicit();
3919     // FIXME: Add isImplicit to CXXConstructExpr.
3920     if (auto *CCE = dyn_cast<CXXConstructExpr>(Sub))
3921       if (CCE->getParenOrBraceRange().isInvalid())
3922         Sub = CCE->getArg(0)->IgnoreImplicit();
3923     if (auto *StdInitList = dyn_cast<CXXStdInitializerListExpr>(Sub))
3924       Sub = StdInitList->getSubExpr()->IgnoreImplicit();
3925     if (auto *IL = dyn_cast<InitListExpr>(Sub)) {
3926       Out << "tl";
3927       mangleType(E->getType());
3928       mangleInitListElements(IL);
3929       Out << "E";
3930     } else {
3931       mangleCastExpression(E, "cv");
3932     }
3933     break;
3934   }
3935 
3936   case Expr::CXXStaticCastExprClass:
3937     mangleCastExpression(E, "sc");
3938     break;
3939   case Expr::CXXDynamicCastExprClass:
3940     mangleCastExpression(E, "dc");
3941     break;
3942   case Expr::CXXReinterpretCastExprClass:
3943     mangleCastExpression(E, "rc");
3944     break;
3945   case Expr::CXXConstCastExprClass:
3946     mangleCastExpression(E, "cc");
3947     break;
3948 
3949   case Expr::CXXOperatorCallExprClass: {
3950     const CXXOperatorCallExpr *CE = cast<CXXOperatorCallExpr>(E);
3951     unsigned NumArgs = CE->getNumArgs();
3952     // A CXXOperatorCallExpr for OO_Arrow models only semantics, not syntax
3953     // (the enclosing MemberExpr covers the syntactic portion).
3954     if (CE->getOperator() != OO_Arrow)
3955       mangleOperatorName(CE->getOperator(), /*Arity=*/NumArgs);
3956     // Mangle the arguments.
3957     for (unsigned i = 0; i != NumArgs; ++i)
3958       mangleExpression(CE->getArg(i));
3959     break;
3960   }
3961 
3962   case Expr::ParenExprClass:
3963     mangleExpression(cast<ParenExpr>(E)->getSubExpr(), Arity);
3964     break;
3965 
3966   case Expr::DeclRefExprClass: {
3967     const NamedDecl *D = cast<DeclRefExpr>(E)->getDecl();
3968 
3969     switch (D->getKind()) {
3970     default:
3971       //  <expr-primary> ::= L <mangled-name> E # external name
3972       Out << 'L';
3973       mangle(D);
3974       Out << 'E';
3975       break;
3976 
3977     case Decl::ParmVar:
3978       mangleFunctionParam(cast<ParmVarDecl>(D));
3979       break;
3980 
3981     case Decl::EnumConstant: {
3982       const EnumConstantDecl *ED = cast<EnumConstantDecl>(D);
3983       mangleIntegerLiteral(ED->getType(), ED->getInitVal());
3984       break;
3985     }
3986 
3987     case Decl::NonTypeTemplateParm: {
3988       const NonTypeTemplateParmDecl *PD = cast<NonTypeTemplateParmDecl>(D);
3989       mangleTemplateParameter(PD->getIndex());
3990       break;
3991     }
3992 
3993     }
3994 
3995     break;
3996   }
3997 
3998   case Expr::SubstNonTypeTemplateParmPackExprClass:
3999     // FIXME: not clear how to mangle this!
4000     // template <unsigned N...> class A {
4001     //   template <class U...> void foo(U (&x)[N]...);
4002     // };
4003     Out << "_SUBSTPACK_";
4004     break;
4005 
4006   case Expr::FunctionParmPackExprClass: {
4007     // FIXME: not clear how to mangle this!
4008     const FunctionParmPackExpr *FPPE = cast<FunctionParmPackExpr>(E);
4009     Out << "v110_SUBSTPACK";
4010     mangleFunctionParam(FPPE->getParameterPack());
4011     break;
4012   }
4013 
4014   case Expr::DependentScopeDeclRefExprClass: {
4015     const DependentScopeDeclRefExpr *DRE = cast<DependentScopeDeclRefExpr>(E);
4016     mangleUnresolvedName(DRE->getQualifier(), DRE->getDeclName(),
4017                          DRE->getTemplateArgs(), DRE->getNumTemplateArgs(),
4018                          Arity);
4019     break;
4020   }
4021 
4022   case Expr::CXXBindTemporaryExprClass:
4023     mangleExpression(cast<CXXBindTemporaryExpr>(E)->getSubExpr());
4024     break;
4025 
4026   case Expr::ExprWithCleanupsClass:
4027     mangleExpression(cast<ExprWithCleanups>(E)->getSubExpr(), Arity);
4028     break;
4029 
4030   case Expr::FloatingLiteralClass: {
4031     const FloatingLiteral *FL = cast<FloatingLiteral>(E);
4032     Out << 'L';
4033     mangleType(FL->getType());
4034     mangleFloat(FL->getValue());
4035     Out << 'E';
4036     break;
4037   }
4038 
4039   case Expr::CharacterLiteralClass:
4040     Out << 'L';
4041     mangleType(E->getType());
4042     Out << cast<CharacterLiteral>(E)->getValue();
4043     Out << 'E';
4044     break;
4045 
4046   // FIXME. __objc_yes/__objc_no are mangled same as true/false
4047   case Expr::ObjCBoolLiteralExprClass:
4048     Out << "Lb";
4049     Out << (cast<ObjCBoolLiteralExpr>(E)->getValue() ? '1' : '0');
4050     Out << 'E';
4051     break;
4052 
4053   case Expr::CXXBoolLiteralExprClass:
4054     Out << "Lb";
4055     Out << (cast<CXXBoolLiteralExpr>(E)->getValue() ? '1' : '0');
4056     Out << 'E';
4057     break;
4058 
4059   case Expr::IntegerLiteralClass: {
4060     llvm::APSInt Value(cast<IntegerLiteral>(E)->getValue());
4061     if (E->getType()->isSignedIntegerType())
4062       Value.setIsSigned(true);
4063     mangleIntegerLiteral(E->getType(), Value);
4064     break;
4065   }
4066 
4067   case Expr::ImaginaryLiteralClass: {
4068     const ImaginaryLiteral *IE = cast<ImaginaryLiteral>(E);
4069     // Mangle as if a complex literal.
4070     // Proposal from David Vandevoorde, 2010.06.30.
4071     Out << 'L';
4072     mangleType(E->getType());
4073     if (const FloatingLiteral *Imag =
4074           dyn_cast<FloatingLiteral>(IE->getSubExpr())) {
4075       // Mangle a floating-point zero of the appropriate type.
4076       mangleFloat(llvm::APFloat(Imag->getValue().getSemantics()));
4077       Out << '_';
4078       mangleFloat(Imag->getValue());
4079     } else {
4080       Out << "0_";
4081       llvm::APSInt Value(cast<IntegerLiteral>(IE->getSubExpr())->getValue());
4082       if (IE->getSubExpr()->getType()->isSignedIntegerType())
4083         Value.setIsSigned(true);
4084       mangleNumber(Value);
4085     }
4086     Out << 'E';
4087     break;
4088   }
4089 
4090   case Expr::StringLiteralClass: {
4091     // Revised proposal from David Vandervoorde, 2010.07.15.
4092     Out << 'L';
4093     assert(isa<ConstantArrayType>(E->getType()));
4094     mangleType(E->getType());
4095     Out << 'E';
4096     break;
4097   }
4098 
4099   case Expr::GNUNullExprClass:
4100     // FIXME: should this really be mangled the same as nullptr?
4101     // fallthrough
4102 
4103   case Expr::CXXNullPtrLiteralExprClass: {
4104     Out << "LDnE";
4105     break;
4106   }
4107 
4108   case Expr::PackExpansionExprClass:
4109     Out << "sp";
4110     mangleExpression(cast<PackExpansionExpr>(E)->getPattern());
4111     break;
4112 
4113   case Expr::SizeOfPackExprClass: {
4114     auto *SPE = cast<SizeOfPackExpr>(E);
4115     if (SPE->isPartiallySubstituted()) {
4116       Out << "sP";
4117       for (const auto &A : SPE->getPartialArguments())
4118         mangleTemplateArg(A);
4119       Out << "E";
4120       break;
4121     }
4122 
4123     Out << "sZ";
4124     const NamedDecl *Pack = SPE->getPack();
4125     if (const TemplateTypeParmDecl *TTP = dyn_cast<TemplateTypeParmDecl>(Pack))
4126       mangleTemplateParameter(TTP->getIndex());
4127     else if (const NonTypeTemplateParmDecl *NTTP
4128                 = dyn_cast<NonTypeTemplateParmDecl>(Pack))
4129       mangleTemplateParameter(NTTP->getIndex());
4130     else if (const TemplateTemplateParmDecl *TempTP
4131                                     = dyn_cast<TemplateTemplateParmDecl>(Pack))
4132       mangleTemplateParameter(TempTP->getIndex());
4133     else
4134       mangleFunctionParam(cast<ParmVarDecl>(Pack));
4135     break;
4136   }
4137 
4138   case Expr::MaterializeTemporaryExprClass: {
4139     mangleExpression(cast<MaterializeTemporaryExpr>(E)->GetTemporaryExpr());
4140     break;
4141   }
4142 
4143   case Expr::CXXFoldExprClass: {
4144     auto *FE = cast<CXXFoldExpr>(E);
4145     if (FE->isLeftFold())
4146       Out << (FE->getInit() ? "fL" : "fl");
4147     else
4148       Out << (FE->getInit() ? "fR" : "fr");
4149 
4150     if (FE->getOperator() == BO_PtrMemD)
4151       Out << "ds";
4152     else
4153       mangleOperatorName(
4154           BinaryOperator::getOverloadedOperator(FE->getOperator()),
4155           /*Arity=*/2);
4156 
4157     if (FE->getLHS())
4158       mangleExpression(FE->getLHS());
4159     if (FE->getRHS())
4160       mangleExpression(FE->getRHS());
4161     break;
4162   }
4163 
4164   case Expr::CXXThisExprClass:
4165     Out << "fpT";
4166     break;
4167 
4168   case Expr::CoawaitExprClass:
4169     // FIXME: Propose a non-vendor mangling.
4170     Out << "v18co_await";
4171     mangleExpression(cast<CoawaitExpr>(E)->getOperand());
4172     break;
4173 
4174   case Expr::DependentCoawaitExprClass:
4175     // FIXME: Propose a non-vendor mangling.
4176     Out << "v18co_await";
4177     mangleExpression(cast<DependentCoawaitExpr>(E)->getOperand());
4178     break;
4179 
4180   case Expr::CoyieldExprClass:
4181     // FIXME: Propose a non-vendor mangling.
4182     Out << "v18co_yield";
4183     mangleExpression(cast<CoawaitExpr>(E)->getOperand());
4184     break;
4185   }
4186 }
4187 
4188 /// Mangle an expression which refers to a parameter variable.
4189 ///
4190 /// <expression>     ::= <function-param>
4191 /// <function-param> ::= fp <top-level CV-qualifiers> _      # L == 0, I == 0
4192 /// <function-param> ::= fp <top-level CV-qualifiers>
4193 ///                      <parameter-2 non-negative number> _ # L == 0, I > 0
4194 /// <function-param> ::= fL <L-1 non-negative number>
4195 ///                      p <top-level CV-qualifiers> _       # L > 0, I == 0
4196 /// <function-param> ::= fL <L-1 non-negative number>
4197 ///                      p <top-level CV-qualifiers>
4198 ///                      <I-1 non-negative number> _         # L > 0, I > 0
4199 ///
4200 /// L is the nesting depth of the parameter, defined as 1 if the
4201 /// parameter comes from the innermost function prototype scope
4202 /// enclosing the current context, 2 if from the next enclosing
4203 /// function prototype scope, and so on, with one special case: if
4204 /// we've processed the full parameter clause for the innermost
4205 /// function type, then L is one less.  This definition conveniently
4206 /// makes it irrelevant whether a function's result type was written
4207 /// trailing or leading, but is otherwise overly complicated; the
4208 /// numbering was first designed without considering references to
4209 /// parameter in locations other than return types, and then the
4210 /// mangling had to be generalized without changing the existing
4211 /// manglings.
4212 ///
4213 /// I is the zero-based index of the parameter within its parameter
4214 /// declaration clause.  Note that the original ABI document describes
4215 /// this using 1-based ordinals.
4216 void CXXNameMangler::mangleFunctionParam(const ParmVarDecl *parm) {
4217   unsigned parmDepth = parm->getFunctionScopeDepth();
4218   unsigned parmIndex = parm->getFunctionScopeIndex();
4219 
4220   // Compute 'L'.
4221   // parmDepth does not include the declaring function prototype.
4222   // FunctionTypeDepth does account for that.
4223   assert(parmDepth < FunctionTypeDepth.getDepth());
4224   unsigned nestingDepth = FunctionTypeDepth.getDepth() - parmDepth;
4225   if (FunctionTypeDepth.isInResultType())
4226     nestingDepth--;
4227 
4228   if (nestingDepth == 0) {
4229     Out << "fp";
4230   } else {
4231     Out << "fL" << (nestingDepth - 1) << 'p';
4232   }
4233 
4234   // Top-level qualifiers.  We don't have to worry about arrays here,
4235   // because parameters declared as arrays should already have been
4236   // transformed to have pointer type. FIXME: apparently these don't
4237   // get mangled if used as an rvalue of a known non-class type?
4238   assert(!parm->getType()->isArrayType()
4239          && "parameter's type is still an array type?");
4240 
4241   if (const DependentAddressSpaceType *DAST =
4242       dyn_cast<DependentAddressSpaceType>(parm->getType())) {
4243     mangleQualifiers(DAST->getPointeeType().getQualifiers(), DAST);
4244   } else {
4245     mangleQualifiers(parm->getType().getQualifiers());
4246   }
4247 
4248   // Parameter index.
4249   if (parmIndex != 0) {
4250     Out << (parmIndex - 1);
4251   }
4252   Out << '_';
4253 }
4254 
4255 void CXXNameMangler::mangleCXXCtorType(CXXCtorType T,
4256                                        const CXXRecordDecl *InheritedFrom) {
4257   // <ctor-dtor-name> ::= C1  # complete object constructor
4258   //                  ::= C2  # base object constructor
4259   //                  ::= CI1 <type> # complete inheriting constructor
4260   //                  ::= CI2 <type> # base inheriting constructor
4261   //
4262   // In addition, C5 is a comdat name with C1 and C2 in it.
4263   Out << 'C';
4264   if (InheritedFrom)
4265     Out << 'I';
4266   switch (T) {
4267   case Ctor_Complete:
4268     Out << '1';
4269     break;
4270   case Ctor_Base:
4271     Out << '2';
4272     break;
4273   case Ctor_Comdat:
4274     Out << '5';
4275     break;
4276   case Ctor_DefaultClosure:
4277   case Ctor_CopyingClosure:
4278     llvm_unreachable("closure constructors don't exist for the Itanium ABI!");
4279   }
4280   if (InheritedFrom)
4281     mangleName(InheritedFrom);
4282 }
4283 
4284 void CXXNameMangler::mangleCXXDtorType(CXXDtorType T) {
4285   // <ctor-dtor-name> ::= D0  # deleting destructor
4286   //                  ::= D1  # complete object destructor
4287   //                  ::= D2  # base object destructor
4288   //
4289   // In addition, D5 is a comdat name with D1, D2 and, if virtual, D0 in it.
4290   switch (T) {
4291   case Dtor_Deleting:
4292     Out << "D0";
4293     break;
4294   case Dtor_Complete:
4295     Out << "D1";
4296     break;
4297   case Dtor_Base:
4298     Out << "D2";
4299     break;
4300   case Dtor_Comdat:
4301     Out << "D5";
4302     break;
4303   }
4304 }
4305 
4306 void CXXNameMangler::mangleTemplateArgs(const TemplateArgumentLoc *TemplateArgs,
4307                                         unsigned NumTemplateArgs) {
4308   // <template-args> ::= I <template-arg>+ E
4309   Out << 'I';
4310   for (unsigned i = 0; i != NumTemplateArgs; ++i)
4311     mangleTemplateArg(TemplateArgs[i].getArgument());
4312   Out << 'E';
4313 }
4314 
4315 void CXXNameMangler::mangleTemplateArgs(const TemplateArgumentList &AL) {
4316   // <template-args> ::= I <template-arg>+ E
4317   Out << 'I';
4318   for (unsigned i = 0, e = AL.size(); i != e; ++i)
4319     mangleTemplateArg(AL[i]);
4320   Out << 'E';
4321 }
4322 
4323 void CXXNameMangler::mangleTemplateArgs(const TemplateArgument *TemplateArgs,
4324                                         unsigned NumTemplateArgs) {
4325   // <template-args> ::= I <template-arg>+ E
4326   Out << 'I';
4327   for (unsigned i = 0; i != NumTemplateArgs; ++i)
4328     mangleTemplateArg(TemplateArgs[i]);
4329   Out << 'E';
4330 }
4331 
4332 void CXXNameMangler::mangleTemplateArg(TemplateArgument A) {
4333   // <template-arg> ::= <type>              # type or template
4334   //                ::= X <expression> E    # expression
4335   //                ::= <expr-primary>      # simple expressions
4336   //                ::= J <template-arg>* E # argument pack
4337   if (!A.isInstantiationDependent() || A.isDependent())
4338     A = Context.getASTContext().getCanonicalTemplateArgument(A);
4339 
4340   switch (A.getKind()) {
4341   case TemplateArgument::Null:
4342     llvm_unreachable("Cannot mangle NULL template argument");
4343 
4344   case TemplateArgument::Type:
4345     mangleType(A.getAsType());
4346     break;
4347   case TemplateArgument::Template:
4348     // This is mangled as <type>.
4349     mangleType(A.getAsTemplate());
4350     break;
4351   case TemplateArgument::TemplateExpansion:
4352     // <type>  ::= Dp <type>          # pack expansion (C++0x)
4353     Out << "Dp";
4354     mangleType(A.getAsTemplateOrTemplatePattern());
4355     break;
4356   case TemplateArgument::Expression: {
4357     // It's possible to end up with a DeclRefExpr here in certain
4358     // dependent cases, in which case we should mangle as a
4359     // declaration.
4360     const Expr *E = A.getAsExpr()->IgnoreParens();
4361     if (const DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(E)) {
4362       const ValueDecl *D = DRE->getDecl();
4363       if (isa<VarDecl>(D) || isa<FunctionDecl>(D)) {
4364         Out << 'L';
4365         mangle(D);
4366         Out << 'E';
4367         break;
4368       }
4369     }
4370 
4371     Out << 'X';
4372     mangleExpression(E);
4373     Out << 'E';
4374     break;
4375   }
4376   case TemplateArgument::Integral:
4377     mangleIntegerLiteral(A.getIntegralType(), A.getAsIntegral());
4378     break;
4379   case TemplateArgument::Declaration: {
4380     //  <expr-primary> ::= L <mangled-name> E # external name
4381     // Clang produces AST's where pointer-to-member-function expressions
4382     // and pointer-to-function expressions are represented as a declaration not
4383     // an expression. We compensate for it here to produce the correct mangling.
4384     ValueDecl *D = A.getAsDecl();
4385     bool compensateMangling = !A.getParamTypeForDecl()->isReferenceType();
4386     if (compensateMangling) {
4387       Out << 'X';
4388       mangleOperatorName(OO_Amp, 1);
4389     }
4390 
4391     Out << 'L';
4392     // References to external entities use the mangled name; if the name would
4393     // not normally be mangled then mangle it as unqualified.
4394     mangle(D);
4395     Out << 'E';
4396 
4397     if (compensateMangling)
4398       Out << 'E';
4399 
4400     break;
4401   }
4402   case TemplateArgument::NullPtr: {
4403     //  <expr-primary> ::= L <type> 0 E
4404     Out << 'L';
4405     mangleType(A.getNullPtrType());
4406     Out << "0E";
4407     break;
4408   }
4409   case TemplateArgument::Pack: {
4410     //  <template-arg> ::= J <template-arg>* E
4411     Out << 'J';
4412     for (const auto &P : A.pack_elements())
4413       mangleTemplateArg(P);
4414     Out << 'E';
4415   }
4416   }
4417 }
4418 
4419 void CXXNameMangler::mangleTemplateParameter(unsigned Index) {
4420   // <template-param> ::= T_    # first template parameter
4421   //                  ::= T <parameter-2 non-negative number> _
4422   if (Index == 0)
4423     Out << "T_";
4424   else
4425     Out << 'T' << (Index - 1) << '_';
4426 }
4427 
4428 void CXXNameMangler::mangleSeqID(unsigned SeqID) {
4429   if (SeqID == 1)
4430     Out << '0';
4431   else if (SeqID > 1) {
4432     SeqID--;
4433 
4434     // <seq-id> is encoded in base-36, using digits and upper case letters.
4435     char Buffer[7]; // log(2**32) / log(36) ~= 7
4436     MutableArrayRef<char> BufferRef(Buffer);
4437     MutableArrayRef<char>::reverse_iterator I = BufferRef.rbegin();
4438 
4439     for (; SeqID != 0; SeqID /= 36) {
4440       unsigned C = SeqID % 36;
4441       *I++ = (C < 10 ? '0' + C : 'A' + C - 10);
4442     }
4443 
4444     Out.write(I.base(), I - BufferRef.rbegin());
4445   }
4446   Out << '_';
4447 }
4448 
4449 void CXXNameMangler::mangleExistingSubstitution(TemplateName tname) {
4450   bool result = mangleSubstitution(tname);
4451   assert(result && "no existing substitution for template name");
4452   (void) result;
4453 }
4454 
4455 // <substitution> ::= S <seq-id> _
4456 //                ::= S_
4457 bool CXXNameMangler::mangleSubstitution(const NamedDecl *ND) {
4458   // Try one of the standard substitutions first.
4459   if (mangleStandardSubstitution(ND))
4460     return true;
4461 
4462   ND = cast<NamedDecl>(ND->getCanonicalDecl());
4463   return mangleSubstitution(reinterpret_cast<uintptr_t>(ND));
4464 }
4465 
4466 /// Determine whether the given type has any qualifiers that are relevant for
4467 /// substitutions.
4468 static bool hasMangledSubstitutionQualifiers(QualType T) {
4469   Qualifiers Qs = T.getQualifiers();
4470   return Qs.getCVRQualifiers() || Qs.hasAddressSpace() || Qs.hasUnaligned();
4471 }
4472 
4473 bool CXXNameMangler::mangleSubstitution(QualType T) {
4474   if (!hasMangledSubstitutionQualifiers(T)) {
4475     if (const RecordType *RT = T->getAs<RecordType>())
4476       return mangleSubstitution(RT->getDecl());
4477   }
4478 
4479   uintptr_t TypePtr = reinterpret_cast<uintptr_t>(T.getAsOpaquePtr());
4480 
4481   return mangleSubstitution(TypePtr);
4482 }
4483 
4484 bool CXXNameMangler::mangleSubstitution(TemplateName Template) {
4485   if (TemplateDecl *TD = Template.getAsTemplateDecl())
4486     return mangleSubstitution(TD);
4487 
4488   Template = Context.getASTContext().getCanonicalTemplateName(Template);
4489   return mangleSubstitution(
4490                       reinterpret_cast<uintptr_t>(Template.getAsVoidPointer()));
4491 }
4492 
4493 bool CXXNameMangler::mangleSubstitution(uintptr_t Ptr) {
4494   llvm::DenseMap<uintptr_t, unsigned>::iterator I = Substitutions.find(Ptr);
4495   if (I == Substitutions.end())
4496     return false;
4497 
4498   unsigned SeqID = I->second;
4499   Out << 'S';
4500   mangleSeqID(SeqID);
4501 
4502   return true;
4503 }
4504 
4505 static bool isCharType(QualType T) {
4506   if (T.isNull())
4507     return false;
4508 
4509   return T->isSpecificBuiltinType(BuiltinType::Char_S) ||
4510     T->isSpecificBuiltinType(BuiltinType::Char_U);
4511 }
4512 
4513 /// Returns whether a given type is a template specialization of a given name
4514 /// with a single argument of type char.
4515 static bool isCharSpecialization(QualType T, const char *Name) {
4516   if (T.isNull())
4517     return false;
4518 
4519   const RecordType *RT = T->getAs<RecordType>();
4520   if (!RT)
4521     return false;
4522 
4523   const ClassTemplateSpecializationDecl *SD =
4524     dyn_cast<ClassTemplateSpecializationDecl>(RT->getDecl());
4525   if (!SD)
4526     return false;
4527 
4528   if (!isStdNamespace(getEffectiveDeclContext(SD)))
4529     return false;
4530 
4531   const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
4532   if (TemplateArgs.size() != 1)
4533     return false;
4534 
4535   if (!isCharType(TemplateArgs[0].getAsType()))
4536     return false;
4537 
4538   return SD->getIdentifier()->getName() == Name;
4539 }
4540 
4541 template <std::size_t StrLen>
4542 static bool isStreamCharSpecialization(const ClassTemplateSpecializationDecl*SD,
4543                                        const char (&Str)[StrLen]) {
4544   if (!SD->getIdentifier()->isStr(Str))
4545     return false;
4546 
4547   const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
4548   if (TemplateArgs.size() != 2)
4549     return false;
4550 
4551   if (!isCharType(TemplateArgs[0].getAsType()))
4552     return false;
4553 
4554   if (!isCharSpecialization(TemplateArgs[1].getAsType(), "char_traits"))
4555     return false;
4556 
4557   return true;
4558 }
4559 
4560 bool CXXNameMangler::mangleStandardSubstitution(const NamedDecl *ND) {
4561   // <substitution> ::= St # ::std::
4562   if (const NamespaceDecl *NS = dyn_cast<NamespaceDecl>(ND)) {
4563     if (isStd(NS)) {
4564       Out << "St";
4565       return true;
4566     }
4567   }
4568 
4569   if (const ClassTemplateDecl *TD = dyn_cast<ClassTemplateDecl>(ND)) {
4570     if (!isStdNamespace(getEffectiveDeclContext(TD)))
4571       return false;
4572 
4573     // <substitution> ::= Sa # ::std::allocator
4574     if (TD->getIdentifier()->isStr("allocator")) {
4575       Out << "Sa";
4576       return true;
4577     }
4578 
4579     // <<substitution> ::= Sb # ::std::basic_string
4580     if (TD->getIdentifier()->isStr("basic_string")) {
4581       Out << "Sb";
4582       return true;
4583     }
4584   }
4585 
4586   if (const ClassTemplateSpecializationDecl *SD =
4587         dyn_cast<ClassTemplateSpecializationDecl>(ND)) {
4588     if (!isStdNamespace(getEffectiveDeclContext(SD)))
4589       return false;
4590 
4591     //    <substitution> ::= Ss # ::std::basic_string<char,
4592     //                            ::std::char_traits<char>,
4593     //                            ::std::allocator<char> >
4594     if (SD->getIdentifier()->isStr("basic_string")) {
4595       const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
4596 
4597       if (TemplateArgs.size() != 3)
4598         return false;
4599 
4600       if (!isCharType(TemplateArgs[0].getAsType()))
4601         return false;
4602 
4603       if (!isCharSpecialization(TemplateArgs[1].getAsType(), "char_traits"))
4604         return false;
4605 
4606       if (!isCharSpecialization(TemplateArgs[2].getAsType(), "allocator"))
4607         return false;
4608 
4609       Out << "Ss";
4610       return true;
4611     }
4612 
4613     //    <substitution> ::= Si # ::std::basic_istream<char,
4614     //                            ::std::char_traits<char> >
4615     if (isStreamCharSpecialization(SD, "basic_istream")) {
4616       Out << "Si";
4617       return true;
4618     }
4619 
4620     //    <substitution> ::= So # ::std::basic_ostream<char,
4621     //                            ::std::char_traits<char> >
4622     if (isStreamCharSpecialization(SD, "basic_ostream")) {
4623       Out << "So";
4624       return true;
4625     }
4626 
4627     //    <substitution> ::= Sd # ::std::basic_iostream<char,
4628     //                            ::std::char_traits<char> >
4629     if (isStreamCharSpecialization(SD, "basic_iostream")) {
4630       Out << "Sd";
4631       return true;
4632     }
4633   }
4634   return false;
4635 }
4636 
4637 void CXXNameMangler::addSubstitution(QualType T) {
4638   if (!hasMangledSubstitutionQualifiers(T)) {
4639     if (const RecordType *RT = T->getAs<RecordType>()) {
4640       addSubstitution(RT->getDecl());
4641       return;
4642     }
4643   }
4644 
4645   uintptr_t TypePtr = reinterpret_cast<uintptr_t>(T.getAsOpaquePtr());
4646   addSubstitution(TypePtr);
4647 }
4648 
4649 void CXXNameMangler::addSubstitution(TemplateName Template) {
4650   if (TemplateDecl *TD = Template.getAsTemplateDecl())
4651     return addSubstitution(TD);
4652 
4653   Template = Context.getASTContext().getCanonicalTemplateName(Template);
4654   addSubstitution(reinterpret_cast<uintptr_t>(Template.getAsVoidPointer()));
4655 }
4656 
4657 void CXXNameMangler::addSubstitution(uintptr_t Ptr) {
4658   assert(!Substitutions.count(Ptr) && "Substitution already exists!");
4659   Substitutions[Ptr] = SeqID++;
4660 }
4661 
4662 void CXXNameMangler::extendSubstitutions(CXXNameMangler* Other) {
4663   assert(Other->SeqID >= SeqID && "Must be superset of substitutions!");
4664   if (Other->SeqID > SeqID) {
4665     Substitutions.swap(Other->Substitutions);
4666     SeqID = Other->SeqID;
4667   }
4668 }
4669 
4670 CXXNameMangler::AbiTagList
4671 CXXNameMangler::makeFunctionReturnTypeTags(const FunctionDecl *FD) {
4672   // When derived abi tags are disabled there is no need to make any list.
4673   if (DisableDerivedAbiTags)
4674     return AbiTagList();
4675 
4676   llvm::raw_null_ostream NullOutStream;
4677   CXXNameMangler TrackReturnTypeTags(*this, NullOutStream);
4678   TrackReturnTypeTags.disableDerivedAbiTags();
4679 
4680   const FunctionProtoType *Proto =
4681       cast<FunctionProtoType>(FD->getType()->getAs<FunctionType>());
4682   FunctionTypeDepthState saved = TrackReturnTypeTags.FunctionTypeDepth.push();
4683   TrackReturnTypeTags.FunctionTypeDepth.enterResultType();
4684   TrackReturnTypeTags.mangleType(Proto->getReturnType());
4685   TrackReturnTypeTags.FunctionTypeDepth.leaveResultType();
4686   TrackReturnTypeTags.FunctionTypeDepth.pop(saved);
4687 
4688   return TrackReturnTypeTags.AbiTagsRoot.getSortedUniqueUsedAbiTags();
4689 }
4690 
4691 CXXNameMangler::AbiTagList
4692 CXXNameMangler::makeVariableTypeTags(const VarDecl *VD) {
4693   // When derived abi tags are disabled there is no need to make any list.
4694   if (DisableDerivedAbiTags)
4695     return AbiTagList();
4696 
4697   llvm::raw_null_ostream NullOutStream;
4698   CXXNameMangler TrackVariableType(*this, NullOutStream);
4699   TrackVariableType.disableDerivedAbiTags();
4700 
4701   TrackVariableType.mangleType(VD->getType());
4702 
4703   return TrackVariableType.AbiTagsRoot.getSortedUniqueUsedAbiTags();
4704 }
4705 
4706 bool CXXNameMangler::shouldHaveAbiTags(ItaniumMangleContextImpl &C,
4707                                        const VarDecl *VD) {
4708   llvm::raw_null_ostream NullOutStream;
4709   CXXNameMangler TrackAbiTags(C, NullOutStream, nullptr, true);
4710   TrackAbiTags.mangle(VD);
4711   return TrackAbiTags.AbiTagsRoot.getUsedAbiTags().size();
4712 }
4713 
4714 //
4715 
4716 /// Mangles the name of the declaration D and emits that name to the given
4717 /// output stream.
4718 ///
4719 /// If the declaration D requires a mangled name, this routine will emit that
4720 /// mangled name to \p os and return true. Otherwise, \p os will be unchanged
4721 /// and this routine will return false. In this case, the caller should just
4722 /// emit the identifier of the declaration (\c D->getIdentifier()) as its
4723 /// name.
4724 void ItaniumMangleContextImpl::mangleCXXName(const NamedDecl *D,
4725                                              raw_ostream &Out) {
4726   assert((isa<FunctionDecl>(D) || isa<VarDecl>(D)) &&
4727           "Invalid mangleName() call, argument is not a variable or function!");
4728   assert(!isa<CXXConstructorDecl>(D) && !isa<CXXDestructorDecl>(D) &&
4729          "Invalid mangleName() call on 'structor decl!");
4730 
4731   PrettyStackTraceDecl CrashInfo(D, SourceLocation(),
4732                                  getASTContext().getSourceManager(),
4733                                  "Mangling declaration");
4734 
4735   CXXNameMangler Mangler(*this, Out, D);
4736   Mangler.mangle(D);
4737 }
4738 
4739 void ItaniumMangleContextImpl::mangleCXXCtor(const CXXConstructorDecl *D,
4740                                              CXXCtorType Type,
4741                                              raw_ostream &Out) {
4742   CXXNameMangler Mangler(*this, Out, D, Type);
4743   Mangler.mangle(D);
4744 }
4745 
4746 void ItaniumMangleContextImpl::mangleCXXDtor(const CXXDestructorDecl *D,
4747                                              CXXDtorType Type,
4748                                              raw_ostream &Out) {
4749   CXXNameMangler Mangler(*this, Out, D, Type);
4750   Mangler.mangle(D);
4751 }
4752 
4753 void ItaniumMangleContextImpl::mangleCXXCtorComdat(const CXXConstructorDecl *D,
4754                                                    raw_ostream &Out) {
4755   CXXNameMangler Mangler(*this, Out, D, Ctor_Comdat);
4756   Mangler.mangle(D);
4757 }
4758 
4759 void ItaniumMangleContextImpl::mangleCXXDtorComdat(const CXXDestructorDecl *D,
4760                                                    raw_ostream &Out) {
4761   CXXNameMangler Mangler(*this, Out, D, Dtor_Comdat);
4762   Mangler.mangle(D);
4763 }
4764 
4765 void ItaniumMangleContextImpl::mangleThunk(const CXXMethodDecl *MD,
4766                                            const ThunkInfo &Thunk,
4767                                            raw_ostream &Out) {
4768   //  <special-name> ::= T <call-offset> <base encoding>
4769   //                      # base is the nominal target function of thunk
4770   //  <special-name> ::= Tc <call-offset> <call-offset> <base encoding>
4771   //                      # base is the nominal target function of thunk
4772   //                      # first call-offset is 'this' adjustment
4773   //                      # second call-offset is result adjustment
4774 
4775   assert(!isa<CXXDestructorDecl>(MD) &&
4776          "Use mangleCXXDtor for destructor decls!");
4777   CXXNameMangler Mangler(*this, Out);
4778   Mangler.getStream() << "_ZT";
4779   if (!Thunk.Return.isEmpty())
4780     Mangler.getStream() << 'c';
4781 
4782   // Mangle the 'this' pointer adjustment.
4783   Mangler.mangleCallOffset(Thunk.This.NonVirtual,
4784                            Thunk.This.Virtual.Itanium.VCallOffsetOffset);
4785 
4786   // Mangle the return pointer adjustment if there is one.
4787   if (!Thunk.Return.isEmpty())
4788     Mangler.mangleCallOffset(Thunk.Return.NonVirtual,
4789                              Thunk.Return.Virtual.Itanium.VBaseOffsetOffset);
4790 
4791   Mangler.mangleFunctionEncoding(MD);
4792 }
4793 
4794 void ItaniumMangleContextImpl::mangleCXXDtorThunk(
4795     const CXXDestructorDecl *DD, CXXDtorType Type,
4796     const ThisAdjustment &ThisAdjustment, raw_ostream &Out) {
4797   //  <special-name> ::= T <call-offset> <base encoding>
4798   //                      # base is the nominal target function of thunk
4799   CXXNameMangler Mangler(*this, Out, DD, Type);
4800   Mangler.getStream() << "_ZT";
4801 
4802   // Mangle the 'this' pointer adjustment.
4803   Mangler.mangleCallOffset(ThisAdjustment.NonVirtual,
4804                            ThisAdjustment.Virtual.Itanium.VCallOffsetOffset);
4805 
4806   Mangler.mangleFunctionEncoding(DD);
4807 }
4808 
4809 /// Returns the mangled name for a guard variable for the passed in VarDecl.
4810 void ItaniumMangleContextImpl::mangleStaticGuardVariable(const VarDecl *D,
4811                                                          raw_ostream &Out) {
4812   //  <special-name> ::= GV <object name>       # Guard variable for one-time
4813   //                                            # initialization
4814   CXXNameMangler Mangler(*this, Out);
4815   // GCC 5.3.0 doesn't emit derived ABI tags for local names but that seems to
4816   // be a bug that is fixed in trunk.
4817   Mangler.getStream() << "_ZGV";
4818   Mangler.mangleName(D);
4819 }
4820 
4821 void ItaniumMangleContextImpl::mangleDynamicInitializer(const VarDecl *MD,
4822                                                         raw_ostream &Out) {
4823   // These symbols are internal in the Itanium ABI, so the names don't matter.
4824   // Clang has traditionally used this symbol and allowed LLVM to adjust it to
4825   // avoid duplicate symbols.
4826   Out << "__cxx_global_var_init";
4827 }
4828 
4829 void ItaniumMangleContextImpl::mangleDynamicAtExitDestructor(const VarDecl *D,
4830                                                              raw_ostream &Out) {
4831   // Prefix the mangling of D with __dtor_.
4832   CXXNameMangler Mangler(*this, Out);
4833   Mangler.getStream() << "__dtor_";
4834   if (shouldMangleDeclName(D))
4835     Mangler.mangle(D);
4836   else
4837     Mangler.getStream() << D->getName();
4838 }
4839 
4840 void ItaniumMangleContextImpl::mangleSEHFilterExpression(
4841     const NamedDecl *EnclosingDecl, raw_ostream &Out) {
4842   CXXNameMangler Mangler(*this, Out);
4843   Mangler.getStream() << "__filt_";
4844   if (shouldMangleDeclName(EnclosingDecl))
4845     Mangler.mangle(EnclosingDecl);
4846   else
4847     Mangler.getStream() << EnclosingDecl->getName();
4848 }
4849 
4850 void ItaniumMangleContextImpl::mangleSEHFinallyBlock(
4851     const NamedDecl *EnclosingDecl, raw_ostream &Out) {
4852   CXXNameMangler Mangler(*this, Out);
4853   Mangler.getStream() << "__fin_";
4854   if (shouldMangleDeclName(EnclosingDecl))
4855     Mangler.mangle(EnclosingDecl);
4856   else
4857     Mangler.getStream() << EnclosingDecl->getName();
4858 }
4859 
4860 void ItaniumMangleContextImpl::mangleItaniumThreadLocalInit(const VarDecl *D,
4861                                                             raw_ostream &Out) {
4862   //  <special-name> ::= TH <object name>
4863   CXXNameMangler Mangler(*this, Out);
4864   Mangler.getStream() << "_ZTH";
4865   Mangler.mangleName(D);
4866 }
4867 
4868 void
4869 ItaniumMangleContextImpl::mangleItaniumThreadLocalWrapper(const VarDecl *D,
4870                                                           raw_ostream &Out) {
4871   //  <special-name> ::= TW <object name>
4872   CXXNameMangler Mangler(*this, Out);
4873   Mangler.getStream() << "_ZTW";
4874   Mangler.mangleName(D);
4875 }
4876 
4877 void ItaniumMangleContextImpl::mangleReferenceTemporary(const VarDecl *D,
4878                                                         unsigned ManglingNumber,
4879                                                         raw_ostream &Out) {
4880   // We match the GCC mangling here.
4881   //  <special-name> ::= GR <object name>
4882   CXXNameMangler Mangler(*this, Out);
4883   Mangler.getStream() << "_ZGR";
4884   Mangler.mangleName(D);
4885   assert(ManglingNumber > 0 && "Reference temporary mangling number is zero!");
4886   Mangler.mangleSeqID(ManglingNumber - 1);
4887 }
4888 
4889 void ItaniumMangleContextImpl::mangleCXXVTable(const CXXRecordDecl *RD,
4890                                                raw_ostream &Out) {
4891   // <special-name> ::= TV <type>  # virtual table
4892   CXXNameMangler Mangler(*this, Out);
4893   Mangler.getStream() << "_ZTV";
4894   Mangler.mangleNameOrStandardSubstitution(RD);
4895 }
4896 
4897 void ItaniumMangleContextImpl::mangleCXXVTT(const CXXRecordDecl *RD,
4898                                             raw_ostream &Out) {
4899   // <special-name> ::= TT <type>  # VTT structure
4900   CXXNameMangler Mangler(*this, Out);
4901   Mangler.getStream() << "_ZTT";
4902   Mangler.mangleNameOrStandardSubstitution(RD);
4903 }
4904 
4905 void ItaniumMangleContextImpl::mangleCXXCtorVTable(const CXXRecordDecl *RD,
4906                                                    int64_t Offset,
4907                                                    const CXXRecordDecl *Type,
4908                                                    raw_ostream &Out) {
4909   // <special-name> ::= TC <type> <offset number> _ <base type>
4910   CXXNameMangler Mangler(*this, Out);
4911   Mangler.getStream() << "_ZTC";
4912   Mangler.mangleNameOrStandardSubstitution(RD);
4913   Mangler.getStream() << Offset;
4914   Mangler.getStream() << '_';
4915   Mangler.mangleNameOrStandardSubstitution(Type);
4916 }
4917 
4918 void ItaniumMangleContextImpl::mangleCXXRTTI(QualType Ty, raw_ostream &Out) {
4919   // <special-name> ::= TI <type>  # typeinfo structure
4920   assert(!Ty.hasQualifiers() && "RTTI info cannot have top-level qualifiers");
4921   CXXNameMangler Mangler(*this, Out);
4922   Mangler.getStream() << "_ZTI";
4923   Mangler.mangleType(Ty);
4924 }
4925 
4926 void ItaniumMangleContextImpl::mangleCXXRTTIName(QualType Ty,
4927                                                  raw_ostream &Out) {
4928   // <special-name> ::= TS <type>  # typeinfo name (null terminated byte string)
4929   CXXNameMangler Mangler(*this, Out);
4930   Mangler.getStream() << "_ZTS";
4931   Mangler.mangleType(Ty);
4932 }
4933 
4934 void ItaniumMangleContextImpl::mangleTypeName(QualType Ty, raw_ostream &Out) {
4935   mangleCXXRTTIName(Ty, Out);
4936 }
4937 
4938 void ItaniumMangleContextImpl::mangleStringLiteral(const StringLiteral *, raw_ostream &) {
4939   llvm_unreachable("Can't mangle string literals");
4940 }
4941 
4942 ItaniumMangleContext *
4943 ItaniumMangleContext::create(ASTContext &Context, DiagnosticsEngine &Diags) {
4944   return new ItaniumMangleContextImpl(Context, Diags);
4945 }
4946