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