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