1 //===--- MicrosoftMangle.cpp - Microsoft Visual C++ Name Mangling ---------===//
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 // This provides C++ name mangling targeting the Microsoft Visual C++ ABI.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "clang/AST/Mangle.h"
15 #include "clang/AST/ASTContext.h"
16 #include "clang/AST/Attr.h"
17 #include "clang/AST/CXXInheritance.h"
18 #include "clang/AST/CharUnits.h"
19 #include "clang/AST/Decl.h"
20 #include "clang/AST/DeclCXX.h"
21 #include "clang/AST/DeclObjC.h"
22 #include "clang/AST/DeclOpenMP.h"
23 #include "clang/AST/DeclTemplate.h"
24 #include "clang/AST/Expr.h"
25 #include "clang/AST/ExprCXX.h"
26 #include "clang/AST/VTableBuilder.h"
27 #include "clang/Basic/ABI.h"
28 #include "clang/Basic/DiagnosticOptions.h"
29 #include "clang/Basic/TargetInfo.h"
30 #include "llvm/ADT/StringExtras.h"
31 #include "llvm/Support/JamCRC.h"
32 #include "llvm/Support/MD5.h"
33 #include "llvm/Support/MathExtras.h"
34 
35 using namespace clang;
36 
37 namespace {
38 
39 struct msvc_hashing_ostream : public llvm::raw_svector_ostream {
40   raw_ostream &OS;
41   llvm::SmallString<64> Buffer;
42 
43   msvc_hashing_ostream(raw_ostream &OS)
44       : llvm::raw_svector_ostream(Buffer), OS(OS) {}
45   ~msvc_hashing_ostream() override {
46     StringRef MangledName = str();
47     bool StartsWithEscape = MangledName.startswith("\01");
48     if (StartsWithEscape)
49       MangledName = MangledName.drop_front(1);
50     if (MangledName.size() <= 4096) {
51       OS << str();
52       return;
53     }
54 
55     llvm::MD5 Hasher;
56     llvm::MD5::MD5Result Hash;
57     Hasher.update(MangledName);
58     Hasher.final(Hash);
59 
60     SmallString<32> HexString;
61     llvm::MD5::stringifyResult(Hash, HexString);
62 
63     if (StartsWithEscape)
64       OS << '\01';
65     OS << "??@" << HexString << '@';
66   }
67 };
68 
69 static const DeclContext *
70 getLambdaDefaultArgumentDeclContext(const Decl *D) {
71   if (const auto *RD = dyn_cast<CXXRecordDecl>(D))
72     if (RD->isLambda())
73       if (const auto *Parm =
74               dyn_cast_or_null<ParmVarDecl>(RD->getLambdaContextDecl()))
75         return Parm->getDeclContext();
76   return nullptr;
77 }
78 
79 /// \brief Retrieve the declaration context that should be used when mangling
80 /// the given declaration.
81 static const DeclContext *getEffectiveDeclContext(const Decl *D) {
82   // The ABI assumes that lambda closure types that occur within
83   // default arguments live in the context of the function. However, due to
84   // the way in which Clang parses and creates function declarations, this is
85   // not the case: the lambda closure type ends up living in the context
86   // where the function itself resides, because the function declaration itself
87   // had not yet been created. Fix the context here.
88   if (const auto *LDADC = getLambdaDefaultArgumentDeclContext(D))
89     return LDADC;
90 
91   // Perform the same check for block literals.
92   if (const BlockDecl *BD = dyn_cast<BlockDecl>(D)) {
93     if (ParmVarDecl *ContextParam =
94             dyn_cast_or_null<ParmVarDecl>(BD->getBlockManglingContextDecl()))
95       return ContextParam->getDeclContext();
96   }
97 
98   const DeclContext *DC = D->getDeclContext();
99   if (isa<CapturedDecl>(DC) || isa<OMPDeclareReductionDecl>(DC)) {
100     return getEffectiveDeclContext(cast<Decl>(DC));
101   }
102 
103   return DC->getRedeclContext();
104 }
105 
106 static const DeclContext *getEffectiveParentContext(const DeclContext *DC) {
107   return getEffectiveDeclContext(cast<Decl>(DC));
108 }
109 
110 static const FunctionDecl *getStructor(const NamedDecl *ND) {
111   if (const auto *FTD = dyn_cast<FunctionTemplateDecl>(ND))
112     return FTD->getTemplatedDecl()->getCanonicalDecl();
113 
114   const auto *FD = cast<FunctionDecl>(ND);
115   if (const auto *FTD = FD->getPrimaryTemplate())
116     return FTD->getTemplatedDecl()->getCanonicalDecl();
117 
118   return FD->getCanonicalDecl();
119 }
120 
121 /// MicrosoftMangleContextImpl - Overrides the default MangleContext for the
122 /// Microsoft Visual C++ ABI.
123 class MicrosoftMangleContextImpl : public MicrosoftMangleContext {
124   typedef std::pair<const DeclContext *, IdentifierInfo *> DiscriminatorKeyTy;
125   llvm::DenseMap<DiscriminatorKeyTy, unsigned> Discriminator;
126   llvm::DenseMap<const NamedDecl *, unsigned> Uniquifier;
127   llvm::DenseMap<const CXXRecordDecl *, unsigned> LambdaIds;
128   llvm::DenseMap<const NamedDecl *, unsigned> SEHFilterIds;
129   llvm::DenseMap<const NamedDecl *, unsigned> SEHFinallyIds;
130 
131 public:
132   MicrosoftMangleContextImpl(ASTContext &Context, DiagnosticsEngine &Diags)
133       : MicrosoftMangleContext(Context, Diags) {}
134   bool shouldMangleCXXName(const NamedDecl *D) override;
135   bool shouldMangleStringLiteral(const StringLiteral *SL) override;
136   void mangleCXXName(const NamedDecl *D, raw_ostream &Out) override;
137   void mangleVirtualMemPtrThunk(const CXXMethodDecl *MD,
138                                 raw_ostream &) override;
139   void mangleThunk(const CXXMethodDecl *MD, const ThunkInfo &Thunk,
140                    raw_ostream &) override;
141   void mangleCXXDtorThunk(const CXXDestructorDecl *DD, CXXDtorType Type,
142                           const ThisAdjustment &ThisAdjustment,
143                           raw_ostream &) override;
144   void mangleCXXVFTable(const CXXRecordDecl *Derived,
145                         ArrayRef<const CXXRecordDecl *> BasePath,
146                         raw_ostream &Out) override;
147   void mangleCXXVBTable(const CXXRecordDecl *Derived,
148                         ArrayRef<const CXXRecordDecl *> BasePath,
149                         raw_ostream &Out) override;
150   void mangleCXXVirtualDisplacementMap(const CXXRecordDecl *SrcRD,
151                                        const CXXRecordDecl *DstRD,
152                                        raw_ostream &Out) override;
153   void mangleCXXThrowInfo(QualType T, bool IsConst, bool IsVolatile,
154                           bool IsUnaligned, uint32_t NumEntries,
155                           raw_ostream &Out) override;
156   void mangleCXXCatchableTypeArray(QualType T, uint32_t NumEntries,
157                                    raw_ostream &Out) override;
158   void mangleCXXCatchableType(QualType T, const CXXConstructorDecl *CD,
159                               CXXCtorType CT, uint32_t Size, uint32_t NVOffset,
160                               int32_t VBPtrOffset, uint32_t VBIndex,
161                               raw_ostream &Out) override;
162   void mangleCXXRTTI(QualType T, raw_ostream &Out) override;
163   void mangleCXXRTTIName(QualType T, raw_ostream &Out) override;
164   void mangleCXXRTTIBaseClassDescriptor(const CXXRecordDecl *Derived,
165                                         uint32_t NVOffset, int32_t VBPtrOffset,
166                                         uint32_t VBTableOffset, uint32_t Flags,
167                                         raw_ostream &Out) override;
168   void mangleCXXRTTIBaseClassArray(const CXXRecordDecl *Derived,
169                                    raw_ostream &Out) override;
170   void mangleCXXRTTIClassHierarchyDescriptor(const CXXRecordDecl *Derived,
171                                              raw_ostream &Out) override;
172   void
173   mangleCXXRTTICompleteObjectLocator(const CXXRecordDecl *Derived,
174                                      ArrayRef<const CXXRecordDecl *> BasePath,
175                                      raw_ostream &Out) override;
176   void mangleTypeName(QualType T, raw_ostream &) override;
177   void mangleCXXCtor(const CXXConstructorDecl *D, CXXCtorType Type,
178                      raw_ostream &) override;
179   void mangleCXXDtor(const CXXDestructorDecl *D, CXXDtorType Type,
180                      raw_ostream &) override;
181   void mangleReferenceTemporary(const VarDecl *, unsigned ManglingNumber,
182                                 raw_ostream &) override;
183   void mangleStaticGuardVariable(const VarDecl *D, raw_ostream &Out) override;
184   void mangleThreadSafeStaticGuardVariable(const VarDecl *D, unsigned GuardNum,
185                                            raw_ostream &Out) override;
186   void mangleDynamicInitializer(const VarDecl *D, raw_ostream &Out) override;
187   void mangleDynamicAtExitDestructor(const VarDecl *D,
188                                      raw_ostream &Out) override;
189   void mangleSEHFilterExpression(const NamedDecl *EnclosingDecl,
190                                  raw_ostream &Out) override;
191   void mangleSEHFinallyBlock(const NamedDecl *EnclosingDecl,
192                              raw_ostream &Out) override;
193   void mangleStringLiteral(const StringLiteral *SL, raw_ostream &Out) override;
194   bool getNextDiscriminator(const NamedDecl *ND, unsigned &disc) {
195     const DeclContext *DC = getEffectiveDeclContext(ND);
196     if (!DC->isFunctionOrMethod())
197       return false;
198 
199     // Lambda closure types are already numbered, give out a phony number so
200     // that they demangle nicely.
201     if (const auto *RD = dyn_cast<CXXRecordDecl>(ND)) {
202       if (RD->isLambda()) {
203         disc = 1;
204         return true;
205       }
206     }
207 
208     // Use the canonical number for externally visible decls.
209     if (ND->isExternallyVisible()) {
210       disc = getASTContext().getManglingNumber(ND);
211       return true;
212     }
213 
214     // Anonymous tags are already numbered.
215     if (const TagDecl *Tag = dyn_cast<TagDecl>(ND)) {
216       if (!Tag->hasNameForLinkage() &&
217           !getASTContext().getDeclaratorForUnnamedTagDecl(Tag) &&
218           !getASTContext().getTypedefNameForUnnamedTagDecl(Tag))
219         return false;
220     }
221 
222     // Make up a reasonable number for internal decls.
223     unsigned &discriminator = Uniquifier[ND];
224     if (!discriminator)
225       discriminator = ++Discriminator[std::make_pair(DC, ND->getIdentifier())];
226     disc = discriminator + 1;
227     return true;
228   }
229 
230   unsigned getLambdaId(const CXXRecordDecl *RD) {
231     assert(RD->isLambda() && "RD must be a lambda!");
232     assert(!RD->isExternallyVisible() && "RD must not be visible!");
233     assert(RD->getLambdaManglingNumber() == 0 &&
234            "RD must not have a mangling number!");
235     std::pair<llvm::DenseMap<const CXXRecordDecl *, unsigned>::iterator, bool>
236         Result = LambdaIds.insert(std::make_pair(RD, LambdaIds.size()));
237     return Result.first->second;
238   }
239 
240 private:
241   void mangleInitFiniStub(const VarDecl *D, char CharCode, raw_ostream &Out);
242 };
243 
244 /// MicrosoftCXXNameMangler - Manage the mangling of a single name for the
245 /// Microsoft Visual C++ ABI.
246 class MicrosoftCXXNameMangler {
247   MicrosoftMangleContextImpl &Context;
248   raw_ostream &Out;
249 
250   /// The "structor" is the top-level declaration being mangled, if
251   /// that's not a template specialization; otherwise it's the pattern
252   /// for that specialization.
253   const NamedDecl *Structor;
254   unsigned StructorType;
255 
256   typedef llvm::SmallVector<std::string, 10> BackRefVec;
257   BackRefVec NameBackReferences;
258 
259   typedef llvm::DenseMap<const void *, unsigned> ArgBackRefMap;
260   ArgBackRefMap TypeBackReferences;
261 
262   typedef std::set<int> PassObjectSizeArgsSet;
263   PassObjectSizeArgsSet PassObjectSizeArgs;
264 
265   ASTContext &getASTContext() const { return Context.getASTContext(); }
266 
267   // FIXME: If we add support for __ptr32/64 qualifiers, then we should push
268   // this check into mangleQualifiers().
269   const bool PointersAre64Bit;
270 
271 public:
272   enum QualifierMangleMode { QMM_Drop, QMM_Mangle, QMM_Escape, QMM_Result };
273 
274   MicrosoftCXXNameMangler(MicrosoftMangleContextImpl &C, raw_ostream &Out_)
275       : Context(C), Out(Out_), Structor(nullptr), StructorType(-1),
276         PointersAre64Bit(C.getASTContext().getTargetInfo().getPointerWidth(0) ==
277                          64) {}
278 
279   MicrosoftCXXNameMangler(MicrosoftMangleContextImpl &C, raw_ostream &Out_,
280                           const CXXConstructorDecl *D, CXXCtorType Type)
281       : Context(C), Out(Out_), Structor(getStructor(D)), StructorType(Type),
282         PointersAre64Bit(C.getASTContext().getTargetInfo().getPointerWidth(0) ==
283                          64) {}
284 
285   MicrosoftCXXNameMangler(MicrosoftMangleContextImpl &C, raw_ostream &Out_,
286                           const CXXDestructorDecl *D, CXXDtorType Type)
287       : Context(C), Out(Out_), Structor(getStructor(D)), StructorType(Type),
288         PointersAre64Bit(C.getASTContext().getTargetInfo().getPointerWidth(0) ==
289                          64) {}
290 
291   raw_ostream &getStream() const { return Out; }
292 
293   void mangle(const NamedDecl *D, StringRef Prefix = "\01?");
294   void mangleName(const NamedDecl *ND);
295   void mangleFunctionEncoding(const FunctionDecl *FD, bool ShouldMangle);
296   void mangleVariableEncoding(const VarDecl *VD);
297   void mangleMemberDataPointer(const CXXRecordDecl *RD, const ValueDecl *VD);
298   void mangleMemberFunctionPointer(const CXXRecordDecl *RD,
299                                    const CXXMethodDecl *MD);
300   void mangleVirtualMemPtrThunk(
301       const CXXMethodDecl *MD,
302       const MicrosoftVTableContext::MethodVFTableLocation &ML);
303   void mangleNumber(int64_t Number);
304   void mangleTagTypeKind(TagTypeKind TK);
305   void mangleArtificalTagType(TagTypeKind TK, StringRef UnqualifiedName,
306                               ArrayRef<StringRef> NestedNames = None);
307   void mangleType(QualType T, SourceRange Range,
308                   QualifierMangleMode QMM = QMM_Mangle);
309   void mangleFunctionType(const FunctionType *T,
310                           const FunctionDecl *D = nullptr,
311                           bool ForceThisQuals = false);
312   void mangleNestedName(const NamedDecl *ND);
313 
314 private:
315   bool isStructorDecl(const NamedDecl *ND) const {
316     return ND == Structor || getStructor(ND) == Structor;
317   }
318 
319   void mangleUnqualifiedName(const NamedDecl *ND) {
320     mangleUnqualifiedName(ND, ND->getDeclName());
321   }
322   void mangleUnqualifiedName(const NamedDecl *ND, DeclarationName Name);
323   void mangleSourceName(StringRef Name);
324   void mangleOperatorName(OverloadedOperatorKind OO, SourceLocation Loc);
325   void mangleCXXDtorType(CXXDtorType T);
326   void mangleQualifiers(Qualifiers Quals, bool IsMember);
327   void mangleRefQualifier(RefQualifierKind RefQualifier);
328   void manglePointerCVQualifiers(Qualifiers Quals);
329   void manglePointerExtQualifiers(Qualifiers Quals, QualType PointeeType);
330 
331   void mangleUnscopedTemplateName(const TemplateDecl *ND);
332   void
333   mangleTemplateInstantiationName(const TemplateDecl *TD,
334                                   const TemplateArgumentList &TemplateArgs);
335   void mangleObjCMethodName(const ObjCMethodDecl *MD);
336 
337   void mangleArgumentType(QualType T, SourceRange Range);
338   void manglePassObjectSizeArg(const PassObjectSizeAttr *POSA);
339 
340   // Declare manglers for every type class.
341 #define ABSTRACT_TYPE(CLASS, PARENT)
342 #define NON_CANONICAL_TYPE(CLASS, PARENT)
343 #define TYPE(CLASS, PARENT) void mangleType(const CLASS##Type *T, \
344                                             Qualifiers Quals, \
345                                             SourceRange Range);
346 #include "clang/AST/TypeNodes.def"
347 #undef ABSTRACT_TYPE
348 #undef NON_CANONICAL_TYPE
349 #undef TYPE
350 
351   void mangleType(const TagDecl *TD);
352   void mangleDecayedArrayType(const ArrayType *T);
353   void mangleArrayType(const ArrayType *T);
354   void mangleFunctionClass(const FunctionDecl *FD);
355   void mangleCallingConvention(CallingConv CC);
356   void mangleCallingConvention(const FunctionType *T);
357   void mangleIntegerLiteral(const llvm::APSInt &Number, bool IsBoolean);
358   void mangleExpression(const Expr *E);
359   void mangleThrowSpecification(const FunctionProtoType *T);
360 
361   void mangleTemplateArgs(const TemplateDecl *TD,
362                           const TemplateArgumentList &TemplateArgs);
363   void mangleTemplateArg(const TemplateDecl *TD, const TemplateArgument &TA,
364                          const NamedDecl *Parm);
365 };
366 }
367 
368 bool MicrosoftMangleContextImpl::shouldMangleCXXName(const NamedDecl *D) {
369   if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
370     LanguageLinkage L = FD->getLanguageLinkage();
371     // Overloadable functions need mangling.
372     if (FD->hasAttr<OverloadableAttr>())
373       return true;
374 
375     // The ABI expects that we would never mangle "typical" user-defined entry
376     // points regardless of visibility or freestanding-ness.
377     //
378     // N.B. This is distinct from asking about "main".  "main" has a lot of
379     // special rules associated with it in the standard while these
380     // user-defined entry points are outside of the purview of the standard.
381     // For example, there can be only one definition for "main" in a standards
382     // compliant program; however nothing forbids the existence of wmain and
383     // WinMain in the same translation unit.
384     if (FD->isMSVCRTEntryPoint())
385       return false;
386 
387     // C++ functions and those whose names are not a simple identifier need
388     // mangling.
389     if (!FD->getDeclName().isIdentifier() || L == CXXLanguageLinkage)
390       return true;
391 
392     // C functions are not mangled.
393     if (L == CLanguageLinkage)
394       return false;
395   }
396 
397   // Otherwise, no mangling is done outside C++ mode.
398   if (!getASTContext().getLangOpts().CPlusPlus)
399     return false;
400 
401   const VarDecl *VD = dyn_cast<VarDecl>(D);
402   if (VD && !isa<DecompositionDecl>(D)) {
403     // C variables are not mangled.
404     if (VD->isExternC())
405       return false;
406 
407     // Variables at global scope with non-internal linkage are not mangled.
408     const DeclContext *DC = getEffectiveDeclContext(D);
409     // Check for extern variable declared locally.
410     if (DC->isFunctionOrMethod() && D->hasLinkage())
411       while (!DC->isNamespace() && !DC->isTranslationUnit())
412         DC = getEffectiveParentContext(DC);
413 
414     if (DC->isTranslationUnit() && D->getFormalLinkage() == InternalLinkage &&
415         !isa<VarTemplateSpecializationDecl>(D) &&
416         D->getIdentifier() != nullptr)
417       return false;
418   }
419 
420   return true;
421 }
422 
423 bool
424 MicrosoftMangleContextImpl::shouldMangleStringLiteral(const StringLiteral *SL) {
425   return true;
426 }
427 
428 void MicrosoftCXXNameMangler::mangle(const NamedDecl *D, StringRef Prefix) {
429   // MSVC doesn't mangle C++ names the same way it mangles extern "C" names.
430   // Therefore it's really important that we don't decorate the
431   // name with leading underscores or leading/trailing at signs. So, by
432   // default, we emit an asm marker at the start so we get the name right.
433   // Callers can override this with a custom prefix.
434 
435   // <mangled-name> ::= ? <name> <type-encoding>
436   Out << Prefix;
437   mangleName(D);
438   if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
439     mangleFunctionEncoding(FD, Context.shouldMangleDeclName(FD));
440   else if (const VarDecl *VD = dyn_cast<VarDecl>(D))
441     mangleVariableEncoding(VD);
442   else
443     llvm_unreachable("Tried to mangle unexpected NamedDecl!");
444 }
445 
446 void MicrosoftCXXNameMangler::mangleFunctionEncoding(const FunctionDecl *FD,
447                                                      bool ShouldMangle) {
448   // <type-encoding> ::= <function-class> <function-type>
449 
450   // Since MSVC operates on the type as written and not the canonical type, it
451   // actually matters which decl we have here.  MSVC appears to choose the
452   // first, since it is most likely to be the declaration in a header file.
453   FD = FD->getFirstDecl();
454 
455   // We should never ever see a FunctionNoProtoType at this point.
456   // We don't even know how to mangle their types anyway :).
457   const FunctionProtoType *FT = FD->getType()->castAs<FunctionProtoType>();
458 
459   // extern "C" functions can hold entities that must be mangled.
460   // As it stands, these functions still need to get expressed in the full
461   // external name.  They have their class and type omitted, replaced with '9'.
462   if (ShouldMangle) {
463     // We would like to mangle all extern "C" functions using this additional
464     // component but this would break compatibility with MSVC's behavior.
465     // Instead, do this when we know that compatibility isn't important (in
466     // other words, when it is an overloaded extern "C" function).
467     if (FD->isExternC() && FD->hasAttr<OverloadableAttr>())
468       Out << "$$J0";
469 
470     mangleFunctionClass(FD);
471 
472     mangleFunctionType(FT, FD);
473   } else {
474     Out << '9';
475   }
476 }
477 
478 void MicrosoftCXXNameMangler::mangleVariableEncoding(const VarDecl *VD) {
479   // <type-encoding> ::= <storage-class> <variable-type>
480   // <storage-class> ::= 0  # private static member
481   //                 ::= 1  # protected static member
482   //                 ::= 2  # public static member
483   //                 ::= 3  # global
484   //                 ::= 4  # static local
485 
486   // The first character in the encoding (after the name) is the storage class.
487   if (VD->isStaticDataMember()) {
488     // If it's a static member, it also encodes the access level.
489     switch (VD->getAccess()) {
490       default:
491       case AS_private: Out << '0'; break;
492       case AS_protected: Out << '1'; break;
493       case AS_public: Out << '2'; break;
494     }
495   }
496   else if (!VD->isStaticLocal())
497     Out << '3';
498   else
499     Out << '4';
500   // Now mangle the type.
501   // <variable-type> ::= <type> <cvr-qualifiers>
502   //                 ::= <type> <pointee-cvr-qualifiers> # pointers, references
503   // Pointers and references are odd. The type of 'int * const foo;' gets
504   // mangled as 'QAHA' instead of 'PAHB', for example.
505   SourceRange SR = VD->getSourceRange();
506   QualType Ty = VD->getType();
507   if (Ty->isPointerType() || Ty->isReferenceType() ||
508       Ty->isMemberPointerType()) {
509     mangleType(Ty, SR, QMM_Drop);
510     manglePointerExtQualifiers(
511         Ty.getDesugaredType(getASTContext()).getLocalQualifiers(), QualType());
512     if (const MemberPointerType *MPT = Ty->getAs<MemberPointerType>()) {
513       mangleQualifiers(MPT->getPointeeType().getQualifiers(), true);
514       // Member pointers are suffixed with a back reference to the member
515       // pointer's class name.
516       mangleName(MPT->getClass()->getAsCXXRecordDecl());
517     } else
518       mangleQualifiers(Ty->getPointeeType().getQualifiers(), false);
519   } else if (const ArrayType *AT = getASTContext().getAsArrayType(Ty)) {
520     // Global arrays are funny, too.
521     mangleDecayedArrayType(AT);
522     if (AT->getElementType()->isArrayType())
523       Out << 'A';
524     else
525       mangleQualifiers(Ty.getQualifiers(), false);
526   } else {
527     mangleType(Ty, SR, QMM_Drop);
528     mangleQualifiers(Ty.getQualifiers(), false);
529   }
530 }
531 
532 void MicrosoftCXXNameMangler::mangleMemberDataPointer(const CXXRecordDecl *RD,
533                                                       const ValueDecl *VD) {
534   // <member-data-pointer> ::= <integer-literal>
535   //                       ::= $F <number> <number>
536   //                       ::= $G <number> <number> <number>
537 
538   int64_t FieldOffset;
539   int64_t VBTableOffset;
540   MSInheritanceAttr::Spelling IM = RD->getMSInheritanceModel();
541   if (VD) {
542     FieldOffset = getASTContext().getFieldOffset(VD);
543     assert(FieldOffset % getASTContext().getCharWidth() == 0 &&
544            "cannot take address of bitfield");
545     FieldOffset /= getASTContext().getCharWidth();
546 
547     VBTableOffset = 0;
548 
549     if (IM == MSInheritanceAttr::Keyword_virtual_inheritance)
550       FieldOffset -= getASTContext().getOffsetOfBaseWithVBPtr(RD).getQuantity();
551   } else {
552     FieldOffset = RD->nullFieldOffsetIsZero() ? 0 : -1;
553 
554     VBTableOffset = -1;
555   }
556 
557   char Code = '\0';
558   switch (IM) {
559   case MSInheritanceAttr::Keyword_single_inheritance:      Code = '0'; break;
560   case MSInheritanceAttr::Keyword_multiple_inheritance:    Code = '0'; break;
561   case MSInheritanceAttr::Keyword_virtual_inheritance:     Code = 'F'; break;
562   case MSInheritanceAttr::Keyword_unspecified_inheritance: Code = 'G'; break;
563   }
564 
565   Out << '$' << Code;
566 
567   mangleNumber(FieldOffset);
568 
569   // The C++ standard doesn't allow base-to-derived member pointer conversions
570   // in template parameter contexts, so the vbptr offset of data member pointers
571   // is always zero.
572   if (MSInheritanceAttr::hasVBPtrOffsetField(IM))
573     mangleNumber(0);
574   if (MSInheritanceAttr::hasVBTableOffsetField(IM))
575     mangleNumber(VBTableOffset);
576 }
577 
578 void
579 MicrosoftCXXNameMangler::mangleMemberFunctionPointer(const CXXRecordDecl *RD,
580                                                      const CXXMethodDecl *MD) {
581   // <member-function-pointer> ::= $1? <name>
582   //                           ::= $H? <name> <number>
583   //                           ::= $I? <name> <number> <number>
584   //                           ::= $J? <name> <number> <number> <number>
585 
586   MSInheritanceAttr::Spelling IM = RD->getMSInheritanceModel();
587 
588   char Code = '\0';
589   switch (IM) {
590   case MSInheritanceAttr::Keyword_single_inheritance:      Code = '1'; break;
591   case MSInheritanceAttr::Keyword_multiple_inheritance:    Code = 'H'; break;
592   case MSInheritanceAttr::Keyword_virtual_inheritance:     Code = 'I'; break;
593   case MSInheritanceAttr::Keyword_unspecified_inheritance: Code = 'J'; break;
594   }
595 
596   // If non-virtual, mangle the name.  If virtual, mangle as a virtual memptr
597   // thunk.
598   uint64_t NVOffset = 0;
599   uint64_t VBTableOffset = 0;
600   uint64_t VBPtrOffset = 0;
601   if (MD) {
602     Out << '$' << Code << '?';
603     if (MD->isVirtual()) {
604       MicrosoftVTableContext *VTContext =
605           cast<MicrosoftVTableContext>(getASTContext().getVTableContext());
606       const MicrosoftVTableContext::MethodVFTableLocation &ML =
607           VTContext->getMethodVFTableLocation(GlobalDecl(MD));
608       mangleVirtualMemPtrThunk(MD, ML);
609       NVOffset = ML.VFPtrOffset.getQuantity();
610       VBTableOffset = ML.VBTableIndex * 4;
611       if (ML.VBase) {
612         const ASTRecordLayout &Layout = getASTContext().getASTRecordLayout(RD);
613         VBPtrOffset = Layout.getVBPtrOffset().getQuantity();
614       }
615     } else {
616       mangleName(MD);
617       mangleFunctionEncoding(MD, /*ShouldMangle=*/true);
618     }
619 
620     if (VBTableOffset == 0 &&
621         IM == MSInheritanceAttr::Keyword_virtual_inheritance)
622       NVOffset -= getASTContext().getOffsetOfBaseWithVBPtr(RD).getQuantity();
623   } else {
624     // Null single inheritance member functions are encoded as a simple nullptr.
625     if (IM == MSInheritanceAttr::Keyword_single_inheritance) {
626       Out << "$0A@";
627       return;
628     }
629     if (IM == MSInheritanceAttr::Keyword_unspecified_inheritance)
630       VBTableOffset = -1;
631     Out << '$' << Code;
632   }
633 
634   if (MSInheritanceAttr::hasNVOffsetField(/*IsMemberFunction=*/true, IM))
635     mangleNumber(static_cast<uint32_t>(NVOffset));
636   if (MSInheritanceAttr::hasVBPtrOffsetField(IM))
637     mangleNumber(VBPtrOffset);
638   if (MSInheritanceAttr::hasVBTableOffsetField(IM))
639     mangleNumber(VBTableOffset);
640 }
641 
642 void MicrosoftCXXNameMangler::mangleVirtualMemPtrThunk(
643     const CXXMethodDecl *MD,
644     const MicrosoftVTableContext::MethodVFTableLocation &ML) {
645   // Get the vftable offset.
646   CharUnits PointerWidth = getASTContext().toCharUnitsFromBits(
647       getASTContext().getTargetInfo().getPointerWidth(0));
648   uint64_t OffsetInVFTable = ML.Index * PointerWidth.getQuantity();
649 
650   Out << "?_9";
651   mangleName(MD->getParent());
652   Out << "$B";
653   mangleNumber(OffsetInVFTable);
654   Out << 'A';
655   mangleCallingConvention(MD->getType()->getAs<FunctionProtoType>());
656 }
657 
658 void MicrosoftCXXNameMangler::mangleName(const NamedDecl *ND) {
659   // <name> ::= <unscoped-name> {[<named-scope>]+ | [<nested-name>]}? @
660 
661   // Always start with the unqualified name.
662   mangleUnqualifiedName(ND);
663 
664   mangleNestedName(ND);
665 
666   // Terminate the whole name with an '@'.
667   Out << '@';
668 }
669 
670 void MicrosoftCXXNameMangler::mangleNumber(int64_t Number) {
671   // <non-negative integer> ::= A@              # when Number == 0
672   //                        ::= <decimal digit> # when 1 <= Number <= 10
673   //                        ::= <hex digit>+ @  # when Number >= 10
674   //
675   // <number>               ::= [?] <non-negative integer>
676 
677   uint64_t Value = static_cast<uint64_t>(Number);
678   if (Number < 0) {
679     Value = -Value;
680     Out << '?';
681   }
682 
683   if (Value == 0)
684     Out << "A@";
685   else if (Value >= 1 && Value <= 10)
686     Out << (Value - 1);
687   else {
688     // Numbers that are not encoded as decimal digits are represented as nibbles
689     // in the range of ASCII characters 'A' to 'P'.
690     // The number 0x123450 would be encoded as 'BCDEFA'
691     char EncodedNumberBuffer[sizeof(uint64_t) * 2];
692     MutableArrayRef<char> BufferRef(EncodedNumberBuffer);
693     MutableArrayRef<char>::reverse_iterator I = BufferRef.rbegin();
694     for (; Value != 0; Value >>= 4)
695       *I++ = 'A' + (Value & 0xf);
696     Out.write(I.base(), I - BufferRef.rbegin());
697     Out << '@';
698   }
699 }
700 
701 static const TemplateDecl *
702 isTemplate(const NamedDecl *ND, const TemplateArgumentList *&TemplateArgs) {
703   // Check if we have a function template.
704   if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)) {
705     if (const TemplateDecl *TD = FD->getPrimaryTemplate()) {
706       TemplateArgs = FD->getTemplateSpecializationArgs();
707       return TD;
708     }
709   }
710 
711   // Check if we have a class template.
712   if (const ClassTemplateSpecializationDecl *Spec =
713           dyn_cast<ClassTemplateSpecializationDecl>(ND)) {
714     TemplateArgs = &Spec->getTemplateArgs();
715     return Spec->getSpecializedTemplate();
716   }
717 
718   // Check if we have a variable template.
719   if (const VarTemplateSpecializationDecl *Spec =
720           dyn_cast<VarTemplateSpecializationDecl>(ND)) {
721     TemplateArgs = &Spec->getTemplateArgs();
722     return Spec->getSpecializedTemplate();
723   }
724 
725   return nullptr;
726 }
727 
728 void MicrosoftCXXNameMangler::mangleUnqualifiedName(const NamedDecl *ND,
729                                                     DeclarationName Name) {
730   //  <unqualified-name> ::= <operator-name>
731   //                     ::= <ctor-dtor-name>
732   //                     ::= <source-name>
733   //                     ::= <template-name>
734 
735   // Check if we have a template.
736   const TemplateArgumentList *TemplateArgs = nullptr;
737   if (const TemplateDecl *TD = isTemplate(ND, TemplateArgs)) {
738     // Function templates aren't considered for name back referencing.  This
739     // makes sense since function templates aren't likely to occur multiple
740     // times in a symbol.
741     if (isa<FunctionTemplateDecl>(TD)) {
742       mangleTemplateInstantiationName(TD, *TemplateArgs);
743       Out << '@';
744       return;
745     }
746 
747     // Here comes the tricky thing: if we need to mangle something like
748     //   void foo(A::X<Y>, B::X<Y>),
749     // the X<Y> part is aliased. However, if you need to mangle
750     //   void foo(A::X<A::Y>, A::X<B::Y>),
751     // the A::X<> part is not aliased.
752     // That said, from the mangler's perspective we have a structure like this:
753     //   namespace[s] -> type[ -> template-parameters]
754     // but from the Clang perspective we have
755     //   type [ -> template-parameters]
756     //      \-> namespace[s]
757     // What we do is we create a new mangler, mangle the same type (without
758     // a namespace suffix) to a string using the extra mangler and then use
759     // the mangled type name as a key to check the mangling of different types
760     // for aliasing.
761 
762     llvm::SmallString<64> TemplateMangling;
763     llvm::raw_svector_ostream Stream(TemplateMangling);
764     MicrosoftCXXNameMangler Extra(Context, Stream);
765     Extra.mangleTemplateInstantiationName(TD, *TemplateArgs);
766 
767     mangleSourceName(TemplateMangling);
768     return;
769   }
770 
771   switch (Name.getNameKind()) {
772     case DeclarationName::Identifier: {
773       if (const IdentifierInfo *II = Name.getAsIdentifierInfo()) {
774         mangleSourceName(II->getName());
775         break;
776       }
777 
778       // Otherwise, an anonymous entity.  We must have a declaration.
779       assert(ND && "mangling empty name without declaration");
780 
781       if (const NamespaceDecl *NS = dyn_cast<NamespaceDecl>(ND)) {
782         if (NS->isAnonymousNamespace()) {
783           Out << "?A@";
784           break;
785         }
786       }
787 
788       if (const DecompositionDecl *DD = dyn_cast<DecompositionDecl>(ND)) {
789         // FIXME: Invented mangling for decomposition declarations:
790         //   [X,Y,Z]
791         // where X,Y,Z are the names of the bindings.
792         llvm::SmallString<128> Name("[");
793         for (auto *BD : DD->bindings()) {
794           if (Name.size() > 1)
795             Name += ',';
796           Name += BD->getDeclName().getAsIdentifierInfo()->getName();
797         }
798         Name += ']';
799         mangleSourceName(Name);
800         break;
801       }
802 
803       if (const VarDecl *VD = dyn_cast<VarDecl>(ND)) {
804         // We must have an anonymous union or struct declaration.
805         const CXXRecordDecl *RD = VD->getType()->getAsCXXRecordDecl();
806         assert(RD && "expected variable decl to have a record type");
807         // Anonymous types with no tag or typedef get the name of their
808         // declarator mangled in.  If they have no declarator, number them with
809         // a $S prefix.
810         llvm::SmallString<64> Name("$S");
811         // Get a unique id for the anonymous struct.
812         Name += llvm::utostr(Context.getAnonymousStructId(RD) + 1);
813         mangleSourceName(Name.str());
814         break;
815       }
816 
817       // We must have an anonymous struct.
818       const TagDecl *TD = cast<TagDecl>(ND);
819       if (const TypedefNameDecl *D = TD->getTypedefNameForAnonDecl()) {
820         assert(TD->getDeclContext() == D->getDeclContext() &&
821                "Typedef should not be in another decl context!");
822         assert(D->getDeclName().getAsIdentifierInfo() &&
823                "Typedef was not named!");
824         mangleSourceName(D->getDeclName().getAsIdentifierInfo()->getName());
825         break;
826       }
827 
828       if (const CXXRecordDecl *Record = dyn_cast<CXXRecordDecl>(TD)) {
829         if (Record->isLambda()) {
830           llvm::SmallString<10> Name("<lambda_");
831 
832           Decl *LambdaContextDecl = Record->getLambdaContextDecl();
833           unsigned LambdaManglingNumber = Record->getLambdaManglingNumber();
834           unsigned LambdaId;
835           const ParmVarDecl *Parm =
836               dyn_cast_or_null<ParmVarDecl>(LambdaContextDecl);
837           const FunctionDecl *Func =
838               Parm ? dyn_cast<FunctionDecl>(Parm->getDeclContext()) : nullptr;
839 
840           if (Func) {
841             unsigned DefaultArgNo =
842                 Func->getNumParams() - Parm->getFunctionScopeIndex();
843             Name += llvm::utostr(DefaultArgNo);
844             Name += "_";
845           }
846 
847           if (LambdaManglingNumber)
848             LambdaId = LambdaManglingNumber;
849           else
850             LambdaId = Context.getLambdaId(Record);
851 
852           Name += llvm::utostr(LambdaId);
853           Name += ">";
854 
855           mangleSourceName(Name);
856 
857           // If the context of a closure type is an initializer for a class
858           // member (static or nonstatic), it is encoded in a qualified name.
859           if (LambdaManglingNumber && LambdaContextDecl) {
860             if ((isa<VarDecl>(LambdaContextDecl) ||
861                  isa<FieldDecl>(LambdaContextDecl)) &&
862                 LambdaContextDecl->getDeclContext()->isRecord()) {
863               mangleUnqualifiedName(cast<NamedDecl>(LambdaContextDecl));
864             }
865           }
866           break;
867         }
868       }
869 
870       llvm::SmallString<64> Name;
871       if (DeclaratorDecl *DD =
872               Context.getASTContext().getDeclaratorForUnnamedTagDecl(TD)) {
873         // Anonymous types without a name for linkage purposes have their
874         // declarator mangled in if they have one.
875         Name += "<unnamed-type-";
876         Name += DD->getName();
877       } else if (TypedefNameDecl *TND =
878                      Context.getASTContext().getTypedefNameForUnnamedTagDecl(
879                          TD)) {
880         // Anonymous types without a name for linkage purposes have their
881         // associate typedef mangled in if they have one.
882         Name += "<unnamed-type-";
883         Name += TND->getName();
884       } else if (auto *ED = dyn_cast<EnumDecl>(TD)) {
885         auto EnumeratorI = ED->enumerator_begin();
886         assert(EnumeratorI != ED->enumerator_end());
887         Name += "<unnamed-enum-";
888         Name += EnumeratorI->getName();
889       } else {
890         // Otherwise, number the types using a $S prefix.
891         Name += "<unnamed-type-$S";
892         Name += llvm::utostr(Context.getAnonymousStructId(TD) + 1);
893       }
894       Name += ">";
895       mangleSourceName(Name.str());
896       break;
897     }
898 
899     case DeclarationName::ObjCZeroArgSelector:
900     case DeclarationName::ObjCOneArgSelector:
901     case DeclarationName::ObjCMultiArgSelector:
902       llvm_unreachable("Can't mangle Objective-C selector names here!");
903 
904     case DeclarationName::CXXConstructorName:
905       if (isStructorDecl(ND)) {
906         if (StructorType == Ctor_CopyingClosure) {
907           Out << "?_O";
908           return;
909         }
910         if (StructorType == Ctor_DefaultClosure) {
911           Out << "?_F";
912           return;
913         }
914       }
915       Out << "?0";
916       return;
917 
918     case DeclarationName::CXXDestructorName:
919       if (isStructorDecl(ND))
920         // If the named decl is the C++ destructor we're mangling,
921         // use the type we were given.
922         mangleCXXDtorType(static_cast<CXXDtorType>(StructorType));
923       else
924         // Otherwise, use the base destructor name. This is relevant if a
925         // class with a destructor is declared within a destructor.
926         mangleCXXDtorType(Dtor_Base);
927       break;
928 
929     case DeclarationName::CXXConversionFunctionName:
930       // <operator-name> ::= ?B # (cast)
931       // The target type is encoded as the return type.
932       Out << "?B";
933       break;
934 
935     case DeclarationName::CXXOperatorName:
936       mangleOperatorName(Name.getCXXOverloadedOperator(), ND->getLocation());
937       break;
938 
939     case DeclarationName::CXXLiteralOperatorName: {
940       Out << "?__K";
941       mangleSourceName(Name.getCXXLiteralIdentifier()->getName());
942       break;
943     }
944 
945     case DeclarationName::CXXDeductionGuideName:
946       llvm_unreachable("Can't mangle a deduction guide name!");
947 
948     case DeclarationName::CXXUsingDirective:
949       llvm_unreachable("Can't mangle a using directive name!");
950   }
951 }
952 
953 void MicrosoftCXXNameMangler::mangleNestedName(const NamedDecl *ND) {
954   // <postfix> ::= <unqualified-name> [<postfix>]
955   //           ::= <substitution> [<postfix>]
956   const DeclContext *DC = getEffectiveDeclContext(ND);
957 
958   while (!DC->isTranslationUnit()) {
959     if (isa<TagDecl>(ND) || isa<VarDecl>(ND)) {
960       unsigned Disc;
961       if (Context.getNextDiscriminator(ND, Disc)) {
962         Out << '?';
963         mangleNumber(Disc);
964         Out << '?';
965       }
966     }
967 
968     if (const BlockDecl *BD = dyn_cast<BlockDecl>(DC)) {
969       DiagnosticsEngine &Diags = Context.getDiags();
970       unsigned DiagID =
971           Diags.getCustomDiagID(DiagnosticsEngine::Error,
972                                 "cannot mangle a local inside this block yet");
973       Diags.Report(BD->getLocation(), DiagID);
974 
975       // FIXME: This is completely, utterly, wrong; see ItaniumMangle
976       // for how this should be done.
977       Out << "__block_invoke" << Context.getBlockId(BD, false);
978       Out << '@';
979     } else if (const ObjCMethodDecl *Method = dyn_cast<ObjCMethodDecl>(DC)) {
980       mangleObjCMethodName(Method);
981     } else if (isa<NamedDecl>(DC)) {
982       ND = cast<NamedDecl>(DC);
983       if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)) {
984         mangle(FD, "?");
985         break;
986       } else {
987         mangleUnqualifiedName(ND);
988         // Lambdas in default arguments conceptually belong to the function the
989         // parameter corresponds to.
990         if (const auto *LDADC = getLambdaDefaultArgumentDeclContext(ND)) {
991           DC = LDADC;
992           continue;
993         }
994       }
995     }
996     DC = DC->getParent();
997   }
998 }
999 
1000 void MicrosoftCXXNameMangler::mangleCXXDtorType(CXXDtorType T) {
1001   // Microsoft uses the names on the case labels for these dtor variants.  Clang
1002   // uses the Itanium terminology internally.  Everything in this ABI delegates
1003   // towards the base dtor.
1004   switch (T) {
1005   // <operator-name> ::= ?1  # destructor
1006   case Dtor_Base: Out << "?1"; return;
1007   // <operator-name> ::= ?_D # vbase destructor
1008   case Dtor_Complete: Out << "?_D"; return;
1009   // <operator-name> ::= ?_G # scalar deleting destructor
1010   case Dtor_Deleting: Out << "?_G"; return;
1011   // <operator-name> ::= ?_E # vector deleting destructor
1012   // FIXME: Add a vector deleting dtor type.  It goes in the vtable, so we need
1013   // it.
1014   case Dtor_Comdat:
1015     llvm_unreachable("not expecting a COMDAT");
1016   }
1017   llvm_unreachable("Unsupported dtor type?");
1018 }
1019 
1020 void MicrosoftCXXNameMangler::mangleOperatorName(OverloadedOperatorKind OO,
1021                                                  SourceLocation Loc) {
1022   switch (OO) {
1023   //                     ?0 # constructor
1024   //                     ?1 # destructor
1025   // <operator-name> ::= ?2 # new
1026   case OO_New: Out << "?2"; break;
1027   // <operator-name> ::= ?3 # delete
1028   case OO_Delete: Out << "?3"; break;
1029   // <operator-name> ::= ?4 # =
1030   case OO_Equal: Out << "?4"; break;
1031   // <operator-name> ::= ?5 # >>
1032   case OO_GreaterGreater: Out << "?5"; break;
1033   // <operator-name> ::= ?6 # <<
1034   case OO_LessLess: Out << "?6"; break;
1035   // <operator-name> ::= ?7 # !
1036   case OO_Exclaim: Out << "?7"; break;
1037   // <operator-name> ::= ?8 # ==
1038   case OO_EqualEqual: Out << "?8"; break;
1039   // <operator-name> ::= ?9 # !=
1040   case OO_ExclaimEqual: Out << "?9"; break;
1041   // <operator-name> ::= ?A # []
1042   case OO_Subscript: Out << "?A"; break;
1043   //                     ?B # conversion
1044   // <operator-name> ::= ?C # ->
1045   case OO_Arrow: Out << "?C"; break;
1046   // <operator-name> ::= ?D # *
1047   case OO_Star: Out << "?D"; break;
1048   // <operator-name> ::= ?E # ++
1049   case OO_PlusPlus: Out << "?E"; break;
1050   // <operator-name> ::= ?F # --
1051   case OO_MinusMinus: Out << "?F"; break;
1052   // <operator-name> ::= ?G # -
1053   case OO_Minus: Out << "?G"; break;
1054   // <operator-name> ::= ?H # +
1055   case OO_Plus: Out << "?H"; break;
1056   // <operator-name> ::= ?I # &
1057   case OO_Amp: Out << "?I"; break;
1058   // <operator-name> ::= ?J # ->*
1059   case OO_ArrowStar: Out << "?J"; break;
1060   // <operator-name> ::= ?K # /
1061   case OO_Slash: Out << "?K"; break;
1062   // <operator-name> ::= ?L # %
1063   case OO_Percent: Out << "?L"; break;
1064   // <operator-name> ::= ?M # <
1065   case OO_Less: Out << "?M"; break;
1066   // <operator-name> ::= ?N # <=
1067   case OO_LessEqual: Out << "?N"; break;
1068   // <operator-name> ::= ?O # >
1069   case OO_Greater: Out << "?O"; break;
1070   // <operator-name> ::= ?P # >=
1071   case OO_GreaterEqual: Out << "?P"; break;
1072   // <operator-name> ::= ?Q # ,
1073   case OO_Comma: Out << "?Q"; break;
1074   // <operator-name> ::= ?R # ()
1075   case OO_Call: Out << "?R"; break;
1076   // <operator-name> ::= ?S # ~
1077   case OO_Tilde: Out << "?S"; break;
1078   // <operator-name> ::= ?T # ^
1079   case OO_Caret: Out << "?T"; break;
1080   // <operator-name> ::= ?U # |
1081   case OO_Pipe: Out << "?U"; break;
1082   // <operator-name> ::= ?V # &&
1083   case OO_AmpAmp: Out << "?V"; break;
1084   // <operator-name> ::= ?W # ||
1085   case OO_PipePipe: Out << "?W"; break;
1086   // <operator-name> ::= ?X # *=
1087   case OO_StarEqual: Out << "?X"; break;
1088   // <operator-name> ::= ?Y # +=
1089   case OO_PlusEqual: Out << "?Y"; break;
1090   // <operator-name> ::= ?Z # -=
1091   case OO_MinusEqual: Out << "?Z"; break;
1092   // <operator-name> ::= ?_0 # /=
1093   case OO_SlashEqual: Out << "?_0"; break;
1094   // <operator-name> ::= ?_1 # %=
1095   case OO_PercentEqual: Out << "?_1"; break;
1096   // <operator-name> ::= ?_2 # >>=
1097   case OO_GreaterGreaterEqual: Out << "?_2"; break;
1098   // <operator-name> ::= ?_3 # <<=
1099   case OO_LessLessEqual: Out << "?_3"; break;
1100   // <operator-name> ::= ?_4 # &=
1101   case OO_AmpEqual: Out << "?_4"; break;
1102   // <operator-name> ::= ?_5 # |=
1103   case OO_PipeEqual: Out << "?_5"; break;
1104   // <operator-name> ::= ?_6 # ^=
1105   case OO_CaretEqual: Out << "?_6"; break;
1106   //                     ?_7 # vftable
1107   //                     ?_8 # vbtable
1108   //                     ?_9 # vcall
1109   //                     ?_A # typeof
1110   //                     ?_B # local static guard
1111   //                     ?_C # string
1112   //                     ?_D # vbase destructor
1113   //                     ?_E # vector deleting destructor
1114   //                     ?_F # default constructor closure
1115   //                     ?_G # scalar deleting destructor
1116   //                     ?_H # vector constructor iterator
1117   //                     ?_I # vector destructor iterator
1118   //                     ?_J # vector vbase constructor iterator
1119   //                     ?_K # virtual displacement map
1120   //                     ?_L # eh vector constructor iterator
1121   //                     ?_M # eh vector destructor iterator
1122   //                     ?_N # eh vector vbase constructor iterator
1123   //                     ?_O # copy constructor closure
1124   //                     ?_P<name> # udt returning <name>
1125   //                     ?_Q # <unknown>
1126   //                     ?_R0 # RTTI Type Descriptor
1127   //                     ?_R1 # RTTI Base Class Descriptor at (a,b,c,d)
1128   //                     ?_R2 # RTTI Base Class Array
1129   //                     ?_R3 # RTTI Class Hierarchy Descriptor
1130   //                     ?_R4 # RTTI Complete Object Locator
1131   //                     ?_S # local vftable
1132   //                     ?_T # local vftable constructor closure
1133   // <operator-name> ::= ?_U # new[]
1134   case OO_Array_New: Out << "?_U"; break;
1135   // <operator-name> ::= ?_V # delete[]
1136   case OO_Array_Delete: Out << "?_V"; break;
1137   // <operator-name> ::= ?__L # co_await
1138   case OO_Coawait: Out << "?__L"; break;
1139 
1140   case OO_Conditional: {
1141     DiagnosticsEngine &Diags = Context.getDiags();
1142     unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
1143       "cannot mangle this conditional operator yet");
1144     Diags.Report(Loc, DiagID);
1145     break;
1146   }
1147 
1148   case OO_None:
1149   case NUM_OVERLOADED_OPERATORS:
1150     llvm_unreachable("Not an overloaded operator");
1151   }
1152 }
1153 
1154 void MicrosoftCXXNameMangler::mangleSourceName(StringRef Name) {
1155   // <source name> ::= <identifier> @
1156   BackRefVec::iterator Found =
1157       std::find(NameBackReferences.begin(), NameBackReferences.end(), Name);
1158   if (Found == NameBackReferences.end()) {
1159     if (NameBackReferences.size() < 10)
1160       NameBackReferences.push_back(Name);
1161     Out << Name << '@';
1162   } else {
1163     Out << (Found - NameBackReferences.begin());
1164   }
1165 }
1166 
1167 void MicrosoftCXXNameMangler::mangleObjCMethodName(const ObjCMethodDecl *MD) {
1168   Context.mangleObjCMethodName(MD, Out);
1169 }
1170 
1171 void MicrosoftCXXNameMangler::mangleTemplateInstantiationName(
1172     const TemplateDecl *TD, const TemplateArgumentList &TemplateArgs) {
1173   // <template-name> ::= <unscoped-template-name> <template-args>
1174   //                 ::= <substitution>
1175   // Always start with the unqualified name.
1176 
1177   // Templates have their own context for back references.
1178   ArgBackRefMap OuterArgsContext;
1179   BackRefVec OuterTemplateContext;
1180   PassObjectSizeArgsSet OuterPassObjectSizeArgs;
1181   NameBackReferences.swap(OuterTemplateContext);
1182   TypeBackReferences.swap(OuterArgsContext);
1183   PassObjectSizeArgs.swap(OuterPassObjectSizeArgs);
1184 
1185   mangleUnscopedTemplateName(TD);
1186   mangleTemplateArgs(TD, TemplateArgs);
1187 
1188   // Restore the previous back reference contexts.
1189   NameBackReferences.swap(OuterTemplateContext);
1190   TypeBackReferences.swap(OuterArgsContext);
1191   PassObjectSizeArgs.swap(OuterPassObjectSizeArgs);
1192 }
1193 
1194 void
1195 MicrosoftCXXNameMangler::mangleUnscopedTemplateName(const TemplateDecl *TD) {
1196   // <unscoped-template-name> ::= ?$ <unqualified-name>
1197   Out << "?$";
1198   mangleUnqualifiedName(TD);
1199 }
1200 
1201 void MicrosoftCXXNameMangler::mangleIntegerLiteral(const llvm::APSInt &Value,
1202                                                    bool IsBoolean) {
1203   // <integer-literal> ::= $0 <number>
1204   Out << "$0";
1205   // Make sure booleans are encoded as 0/1.
1206   if (IsBoolean && Value.getBoolValue())
1207     mangleNumber(1);
1208   else if (Value.isSigned())
1209     mangleNumber(Value.getSExtValue());
1210   else
1211     mangleNumber(Value.getZExtValue());
1212 }
1213 
1214 void MicrosoftCXXNameMangler::mangleExpression(const Expr *E) {
1215   // See if this is a constant expression.
1216   llvm::APSInt Value;
1217   if (E->isIntegerConstantExpr(Value, Context.getASTContext())) {
1218     mangleIntegerLiteral(Value, E->getType()->isBooleanType());
1219     return;
1220   }
1221 
1222   // Look through no-op casts like template parameter substitutions.
1223   E = E->IgnoreParenNoopCasts(Context.getASTContext());
1224 
1225   const CXXUuidofExpr *UE = nullptr;
1226   if (const UnaryOperator *UO = dyn_cast<UnaryOperator>(E)) {
1227     if (UO->getOpcode() == UO_AddrOf)
1228       UE = dyn_cast<CXXUuidofExpr>(UO->getSubExpr());
1229   } else
1230     UE = dyn_cast<CXXUuidofExpr>(E);
1231 
1232   if (UE) {
1233     // If we had to peek through an address-of operator, treat this like we are
1234     // dealing with a pointer type.  Otherwise, treat it like a const reference.
1235     //
1236     // N.B. This matches up with the handling of TemplateArgument::Declaration
1237     // in mangleTemplateArg
1238     if (UE == E)
1239       Out << "$E?";
1240     else
1241       Out << "$1?";
1242 
1243     // This CXXUuidofExpr is mangled as-if it were actually a VarDecl from
1244     // const __s_GUID _GUID_{lower case UUID with underscores}
1245     StringRef Uuid = UE->getUuidStr();
1246     std::string Name = "_GUID_" + Uuid.lower();
1247     std::replace(Name.begin(), Name.end(), '-', '_');
1248 
1249     mangleSourceName(Name);
1250     // Terminate the whole name with an '@'.
1251     Out << '@';
1252     // It's a global variable.
1253     Out << '3';
1254     // It's a struct called __s_GUID.
1255     mangleArtificalTagType(TTK_Struct, "__s_GUID");
1256     // It's const.
1257     Out << 'B';
1258     return;
1259   }
1260 
1261   // As bad as this diagnostic is, it's better than crashing.
1262   DiagnosticsEngine &Diags = Context.getDiags();
1263   unsigned DiagID = Diags.getCustomDiagID(
1264       DiagnosticsEngine::Error, "cannot yet mangle expression type %0");
1265   Diags.Report(E->getExprLoc(), DiagID) << E->getStmtClassName()
1266                                         << E->getSourceRange();
1267 }
1268 
1269 void MicrosoftCXXNameMangler::mangleTemplateArgs(
1270     const TemplateDecl *TD, const TemplateArgumentList &TemplateArgs) {
1271   // <template-args> ::= <template-arg>+
1272   const TemplateParameterList *TPL = TD->getTemplateParameters();
1273   assert(TPL->size() == TemplateArgs.size() &&
1274          "size mismatch between args and parms!");
1275 
1276   unsigned Idx = 0;
1277   for (const TemplateArgument &TA : TemplateArgs.asArray())
1278     mangleTemplateArg(TD, TA, TPL->getParam(Idx++));
1279 }
1280 
1281 void MicrosoftCXXNameMangler::mangleTemplateArg(const TemplateDecl *TD,
1282                                                 const TemplateArgument &TA,
1283                                                 const NamedDecl *Parm) {
1284   // <template-arg> ::= <type>
1285   //                ::= <integer-literal>
1286   //                ::= <member-data-pointer>
1287   //                ::= <member-function-pointer>
1288   //                ::= $E? <name> <type-encoding>
1289   //                ::= $1? <name> <type-encoding>
1290   //                ::= $0A@
1291   //                ::= <template-args>
1292 
1293   switch (TA.getKind()) {
1294   case TemplateArgument::Null:
1295     llvm_unreachable("Can't mangle null template arguments!");
1296   case TemplateArgument::TemplateExpansion:
1297     llvm_unreachable("Can't mangle template expansion arguments!");
1298   case TemplateArgument::Type: {
1299     QualType T = TA.getAsType();
1300     mangleType(T, SourceRange(), QMM_Escape);
1301     break;
1302   }
1303   case TemplateArgument::Declaration: {
1304     const NamedDecl *ND = cast<NamedDecl>(TA.getAsDecl());
1305     if (isa<FieldDecl>(ND) || isa<IndirectFieldDecl>(ND)) {
1306       mangleMemberDataPointer(
1307           cast<CXXRecordDecl>(ND->getDeclContext())->getMostRecentDecl(),
1308           cast<ValueDecl>(ND));
1309     } else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)) {
1310       const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD);
1311       if (MD && MD->isInstance()) {
1312         mangleMemberFunctionPointer(MD->getParent()->getMostRecentDecl(), MD);
1313       } else {
1314         Out << "$1?";
1315         mangleName(FD);
1316         mangleFunctionEncoding(FD, /*ShouldMangle=*/true);
1317       }
1318     } else {
1319       mangle(ND, TA.getParamTypeForDecl()->isReferenceType() ? "$E?" : "$1?");
1320     }
1321     break;
1322   }
1323   case TemplateArgument::Integral:
1324     mangleIntegerLiteral(TA.getAsIntegral(),
1325                          TA.getIntegralType()->isBooleanType());
1326     break;
1327   case TemplateArgument::NullPtr: {
1328     QualType T = TA.getNullPtrType();
1329     if (const MemberPointerType *MPT = T->getAs<MemberPointerType>()) {
1330       const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
1331       if (MPT->isMemberFunctionPointerType() &&
1332           !isa<FunctionTemplateDecl>(TD)) {
1333         mangleMemberFunctionPointer(RD, nullptr);
1334         return;
1335       }
1336       if (MPT->isMemberDataPointer()) {
1337         if (!isa<FunctionTemplateDecl>(TD)) {
1338           mangleMemberDataPointer(RD, nullptr);
1339           return;
1340         }
1341         // nullptr data pointers are always represented with a single field
1342         // which is initialized with either 0 or -1.  Why -1?  Well, we need to
1343         // distinguish the case where the data member is at offset zero in the
1344         // record.
1345         // However, we are free to use 0 *if* we would use multiple fields for
1346         // non-nullptr member pointers.
1347         if (!RD->nullFieldOffsetIsZero()) {
1348           mangleIntegerLiteral(llvm::APSInt::get(-1), /*IsBoolean=*/false);
1349           return;
1350         }
1351       }
1352     }
1353     mangleIntegerLiteral(llvm::APSInt::getUnsigned(0), /*IsBoolean=*/false);
1354     break;
1355   }
1356   case TemplateArgument::Expression:
1357     mangleExpression(TA.getAsExpr());
1358     break;
1359   case TemplateArgument::Pack: {
1360     ArrayRef<TemplateArgument> TemplateArgs = TA.getPackAsArray();
1361     if (TemplateArgs.empty()) {
1362       if (isa<TemplateTypeParmDecl>(Parm) ||
1363           isa<TemplateTemplateParmDecl>(Parm))
1364         // MSVC 2015 changed the mangling for empty expanded template packs,
1365         // use the old mangling for link compatibility for old versions.
1366         Out << (Context.getASTContext().getLangOpts().isCompatibleWithMSVC(
1367                     LangOptions::MSVC2015)
1368                     ? "$$V"
1369                     : "$$$V");
1370       else if (isa<NonTypeTemplateParmDecl>(Parm))
1371         Out << "$S";
1372       else
1373         llvm_unreachable("unexpected template parameter decl!");
1374     } else {
1375       for (const TemplateArgument &PA : TemplateArgs)
1376         mangleTemplateArg(TD, PA, Parm);
1377     }
1378     break;
1379   }
1380   case TemplateArgument::Template: {
1381     const NamedDecl *ND =
1382         TA.getAsTemplate().getAsTemplateDecl()->getTemplatedDecl();
1383     if (const auto *TD = dyn_cast<TagDecl>(ND)) {
1384       mangleType(TD);
1385     } else if (isa<TypeAliasDecl>(ND)) {
1386       Out << "$$Y";
1387       mangleName(ND);
1388     } else {
1389       llvm_unreachable("unexpected template template NamedDecl!");
1390     }
1391     break;
1392   }
1393   }
1394 }
1395 
1396 void MicrosoftCXXNameMangler::mangleQualifiers(Qualifiers Quals,
1397                                                bool IsMember) {
1398   // <cvr-qualifiers> ::= [E] [F] [I] <base-cvr-qualifiers>
1399   // 'E' means __ptr64 (32-bit only); 'F' means __unaligned (32/64-bit only);
1400   // 'I' means __restrict (32/64-bit).
1401   // Note that the MSVC __restrict keyword isn't the same as the C99 restrict
1402   // keyword!
1403   // <base-cvr-qualifiers> ::= A  # near
1404   //                       ::= B  # near const
1405   //                       ::= C  # near volatile
1406   //                       ::= D  # near const volatile
1407   //                       ::= E  # far (16-bit)
1408   //                       ::= F  # far const (16-bit)
1409   //                       ::= G  # far volatile (16-bit)
1410   //                       ::= H  # far const volatile (16-bit)
1411   //                       ::= I  # huge (16-bit)
1412   //                       ::= J  # huge const (16-bit)
1413   //                       ::= K  # huge volatile (16-bit)
1414   //                       ::= L  # huge const volatile (16-bit)
1415   //                       ::= M <basis> # based
1416   //                       ::= N <basis> # based const
1417   //                       ::= O <basis> # based volatile
1418   //                       ::= P <basis> # based const volatile
1419   //                       ::= Q  # near member
1420   //                       ::= R  # near const member
1421   //                       ::= S  # near volatile member
1422   //                       ::= T  # near const volatile member
1423   //                       ::= U  # far member (16-bit)
1424   //                       ::= V  # far const member (16-bit)
1425   //                       ::= W  # far volatile member (16-bit)
1426   //                       ::= X  # far const volatile member (16-bit)
1427   //                       ::= Y  # huge member (16-bit)
1428   //                       ::= Z  # huge const member (16-bit)
1429   //                       ::= 0  # huge volatile member (16-bit)
1430   //                       ::= 1  # huge const volatile member (16-bit)
1431   //                       ::= 2 <basis> # based member
1432   //                       ::= 3 <basis> # based const member
1433   //                       ::= 4 <basis> # based volatile member
1434   //                       ::= 5 <basis> # based const volatile member
1435   //                       ::= 6  # near function (pointers only)
1436   //                       ::= 7  # far function (pointers only)
1437   //                       ::= 8  # near method (pointers only)
1438   //                       ::= 9  # far method (pointers only)
1439   //                       ::= _A <basis> # based function (pointers only)
1440   //                       ::= _B <basis> # based function (far?) (pointers only)
1441   //                       ::= _C <basis> # based method (pointers only)
1442   //                       ::= _D <basis> # based method (far?) (pointers only)
1443   //                       ::= _E # block (Clang)
1444   // <basis> ::= 0 # __based(void)
1445   //         ::= 1 # __based(segment)?
1446   //         ::= 2 <name> # __based(name)
1447   //         ::= 3 # ?
1448   //         ::= 4 # ?
1449   //         ::= 5 # not really based
1450   bool HasConst = Quals.hasConst(),
1451        HasVolatile = Quals.hasVolatile();
1452 
1453   if (!IsMember) {
1454     if (HasConst && HasVolatile) {
1455       Out << 'D';
1456     } else if (HasVolatile) {
1457       Out << 'C';
1458     } else if (HasConst) {
1459       Out << 'B';
1460     } else {
1461       Out << 'A';
1462     }
1463   } else {
1464     if (HasConst && HasVolatile) {
1465       Out << 'T';
1466     } else if (HasVolatile) {
1467       Out << 'S';
1468     } else if (HasConst) {
1469       Out << 'R';
1470     } else {
1471       Out << 'Q';
1472     }
1473   }
1474 
1475   // FIXME: For now, just drop all extension qualifiers on the floor.
1476 }
1477 
1478 void
1479 MicrosoftCXXNameMangler::mangleRefQualifier(RefQualifierKind RefQualifier) {
1480   // <ref-qualifier> ::= G                # lvalue reference
1481   //                 ::= H                # rvalue-reference
1482   switch (RefQualifier) {
1483   case RQ_None:
1484     break;
1485 
1486   case RQ_LValue:
1487     Out << 'G';
1488     break;
1489 
1490   case RQ_RValue:
1491     Out << 'H';
1492     break;
1493   }
1494 }
1495 
1496 void MicrosoftCXXNameMangler::manglePointerExtQualifiers(Qualifiers Quals,
1497                                                          QualType PointeeType) {
1498   bool HasRestrict = Quals.hasRestrict();
1499   if (PointersAre64Bit &&
1500       (PointeeType.isNull() || !PointeeType->isFunctionType()))
1501     Out << 'E';
1502 
1503   if (HasRestrict)
1504     Out << 'I';
1505 
1506   if (Quals.hasUnaligned() ||
1507       (!PointeeType.isNull() && PointeeType.getLocalQualifiers().hasUnaligned()))
1508     Out << 'F';
1509 }
1510 
1511 void MicrosoftCXXNameMangler::manglePointerCVQualifiers(Qualifiers Quals) {
1512   // <pointer-cv-qualifiers> ::= P  # no qualifiers
1513   //                         ::= Q  # const
1514   //                         ::= R  # volatile
1515   //                         ::= S  # const volatile
1516   bool HasConst = Quals.hasConst(),
1517        HasVolatile = Quals.hasVolatile();
1518 
1519   if (HasConst && HasVolatile) {
1520     Out << 'S';
1521   } else if (HasVolatile) {
1522     Out << 'R';
1523   } else if (HasConst) {
1524     Out << 'Q';
1525   } else {
1526     Out << 'P';
1527   }
1528 }
1529 
1530 void MicrosoftCXXNameMangler::mangleArgumentType(QualType T,
1531                                                  SourceRange Range) {
1532   // MSVC will backreference two canonically equivalent types that have slightly
1533   // different manglings when mangled alone.
1534 
1535   // Decayed types do not match up with non-decayed versions of the same type.
1536   //
1537   // e.g.
1538   // void (*x)(void) will not form a backreference with void x(void)
1539   void *TypePtr;
1540   if (const auto *DT = T->getAs<DecayedType>()) {
1541     QualType OriginalType = DT->getOriginalType();
1542     // All decayed ArrayTypes should be treated identically; as-if they were
1543     // a decayed IncompleteArrayType.
1544     if (const auto *AT = getASTContext().getAsArrayType(OriginalType))
1545       OriginalType = getASTContext().getIncompleteArrayType(
1546           AT->getElementType(), AT->getSizeModifier(),
1547           AT->getIndexTypeCVRQualifiers());
1548 
1549     TypePtr = OriginalType.getCanonicalType().getAsOpaquePtr();
1550     // If the original parameter was textually written as an array,
1551     // instead treat the decayed parameter like it's const.
1552     //
1553     // e.g.
1554     // int [] -> int * const
1555     if (OriginalType->isArrayType())
1556       T = T.withConst();
1557   } else {
1558     TypePtr = T.getCanonicalType().getAsOpaquePtr();
1559   }
1560 
1561   ArgBackRefMap::iterator Found = TypeBackReferences.find(TypePtr);
1562 
1563   if (Found == TypeBackReferences.end()) {
1564     size_t OutSizeBefore = Out.tell();
1565 
1566     mangleType(T, Range, QMM_Drop);
1567 
1568     // See if it's worth creating a back reference.
1569     // Only types longer than 1 character are considered
1570     // and only 10 back references slots are available:
1571     bool LongerThanOneChar = (Out.tell() - OutSizeBefore > 1);
1572     if (LongerThanOneChar && TypeBackReferences.size() < 10) {
1573       size_t Size = TypeBackReferences.size();
1574       TypeBackReferences[TypePtr] = Size;
1575     }
1576   } else {
1577     Out << Found->second;
1578   }
1579 }
1580 
1581 void MicrosoftCXXNameMangler::manglePassObjectSizeArg(
1582     const PassObjectSizeAttr *POSA) {
1583   int Type = POSA->getType();
1584 
1585   auto Iter = PassObjectSizeArgs.insert(Type).first;
1586   auto *TypePtr = (const void *)&*Iter;
1587   ArgBackRefMap::iterator Found = TypeBackReferences.find(TypePtr);
1588 
1589   if (Found == TypeBackReferences.end()) {
1590     mangleArtificalTagType(TTK_Enum, "__pass_object_size" + llvm::utostr(Type),
1591                            {"__clang"});
1592 
1593     if (TypeBackReferences.size() < 10) {
1594       size_t Size = TypeBackReferences.size();
1595       TypeBackReferences[TypePtr] = Size;
1596     }
1597   } else {
1598     Out << Found->second;
1599   }
1600 }
1601 
1602 void MicrosoftCXXNameMangler::mangleType(QualType T, SourceRange Range,
1603                                          QualifierMangleMode QMM) {
1604   // Don't use the canonical types.  MSVC includes things like 'const' on
1605   // pointer arguments to function pointers that canonicalization strips away.
1606   T = T.getDesugaredType(getASTContext());
1607   Qualifiers Quals = T.getLocalQualifiers();
1608   if (const ArrayType *AT = getASTContext().getAsArrayType(T)) {
1609     // If there were any Quals, getAsArrayType() pushed them onto the array
1610     // element type.
1611     if (QMM == QMM_Mangle)
1612       Out << 'A';
1613     else if (QMM == QMM_Escape || QMM == QMM_Result)
1614       Out << "$$B";
1615     mangleArrayType(AT);
1616     return;
1617   }
1618 
1619   bool IsPointer = T->isAnyPointerType() || T->isMemberPointerType() ||
1620                    T->isReferenceType() || T->isBlockPointerType();
1621 
1622   switch (QMM) {
1623   case QMM_Drop:
1624     break;
1625   case QMM_Mangle:
1626     if (const FunctionType *FT = dyn_cast<FunctionType>(T)) {
1627       Out << '6';
1628       mangleFunctionType(FT);
1629       return;
1630     }
1631     mangleQualifiers(Quals, false);
1632     break;
1633   case QMM_Escape:
1634     if (!IsPointer && Quals) {
1635       Out << "$$C";
1636       mangleQualifiers(Quals, false);
1637     }
1638     break;
1639   case QMM_Result:
1640     // Presence of __unaligned qualifier shouldn't affect mangling here.
1641     Quals.removeUnaligned();
1642     if ((!IsPointer && Quals) || isa<TagType>(T)) {
1643       Out << '?';
1644       mangleQualifiers(Quals, false);
1645     }
1646     break;
1647   }
1648 
1649   const Type *ty = T.getTypePtr();
1650 
1651   switch (ty->getTypeClass()) {
1652 #define ABSTRACT_TYPE(CLASS, PARENT)
1653 #define NON_CANONICAL_TYPE(CLASS, PARENT) \
1654   case Type::CLASS: \
1655     llvm_unreachable("can't mangle non-canonical type " #CLASS "Type"); \
1656     return;
1657 #define TYPE(CLASS, PARENT) \
1658   case Type::CLASS: \
1659     mangleType(cast<CLASS##Type>(ty), Quals, Range); \
1660     break;
1661 #include "clang/AST/TypeNodes.def"
1662 #undef ABSTRACT_TYPE
1663 #undef NON_CANONICAL_TYPE
1664 #undef TYPE
1665   }
1666 }
1667 
1668 void MicrosoftCXXNameMangler::mangleType(const BuiltinType *T, Qualifiers,
1669                                          SourceRange Range) {
1670   //  <type>         ::= <builtin-type>
1671   //  <builtin-type> ::= X  # void
1672   //                 ::= C  # signed char
1673   //                 ::= D  # char
1674   //                 ::= E  # unsigned char
1675   //                 ::= F  # short
1676   //                 ::= G  # unsigned short (or wchar_t if it's not a builtin)
1677   //                 ::= H  # int
1678   //                 ::= I  # unsigned int
1679   //                 ::= J  # long
1680   //                 ::= K  # unsigned long
1681   //                     L  # <none>
1682   //                 ::= M  # float
1683   //                 ::= N  # double
1684   //                 ::= O  # long double (__float80 is mangled differently)
1685   //                 ::= _J # long long, __int64
1686   //                 ::= _K # unsigned long long, __int64
1687   //                 ::= _L # __int128
1688   //                 ::= _M # unsigned __int128
1689   //                 ::= _N # bool
1690   //                     _O # <array in parameter>
1691   //                 ::= _T # __float80 (Intel)
1692   //                 ::= _W # wchar_t
1693   //                 ::= _Z # __float80 (Digital Mars)
1694   switch (T->getKind()) {
1695   case BuiltinType::Void:
1696     Out << 'X';
1697     break;
1698   case BuiltinType::SChar:
1699     Out << 'C';
1700     break;
1701   case BuiltinType::Char_U:
1702   case BuiltinType::Char_S:
1703     Out << 'D';
1704     break;
1705   case BuiltinType::UChar:
1706     Out << 'E';
1707     break;
1708   case BuiltinType::Short:
1709     Out << 'F';
1710     break;
1711   case BuiltinType::UShort:
1712     Out << 'G';
1713     break;
1714   case BuiltinType::Int:
1715     Out << 'H';
1716     break;
1717   case BuiltinType::UInt:
1718     Out << 'I';
1719     break;
1720   case BuiltinType::Long:
1721     Out << 'J';
1722     break;
1723   case BuiltinType::ULong:
1724     Out << 'K';
1725     break;
1726   case BuiltinType::Float:
1727     Out << 'M';
1728     break;
1729   case BuiltinType::Double:
1730     Out << 'N';
1731     break;
1732   // TODO: Determine size and mangle accordingly
1733   case BuiltinType::LongDouble:
1734     Out << 'O';
1735     break;
1736   case BuiltinType::LongLong:
1737     Out << "_J";
1738     break;
1739   case BuiltinType::ULongLong:
1740     Out << "_K";
1741     break;
1742   case BuiltinType::Int128:
1743     Out << "_L";
1744     break;
1745   case BuiltinType::UInt128:
1746     Out << "_M";
1747     break;
1748   case BuiltinType::Bool:
1749     Out << "_N";
1750     break;
1751   case BuiltinType::Char16:
1752     Out << "_S";
1753     break;
1754   case BuiltinType::Char32:
1755     Out << "_U";
1756     break;
1757   case BuiltinType::WChar_S:
1758   case BuiltinType::WChar_U:
1759     Out << "_W";
1760     break;
1761 
1762 #define BUILTIN_TYPE(Id, SingletonId)
1763 #define PLACEHOLDER_TYPE(Id, SingletonId) \
1764   case BuiltinType::Id:
1765 #include "clang/AST/BuiltinTypes.def"
1766   case BuiltinType::Dependent:
1767     llvm_unreachable("placeholder types shouldn't get to name mangling");
1768 
1769   case BuiltinType::ObjCId:
1770     Out << "PA";
1771     mangleArtificalTagType(TTK_Struct, "objc_object");
1772     break;
1773   case BuiltinType::ObjCClass:
1774     Out << "PA";
1775     mangleArtificalTagType(TTK_Struct, "objc_class");
1776     break;
1777   case BuiltinType::ObjCSel:
1778     Out << "PA";
1779     mangleArtificalTagType(TTK_Struct, "objc_selector");
1780     break;
1781 
1782 #define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
1783   case BuiltinType::Id: \
1784     Out << "PAUocl_" #ImgType "_" #Suffix "@@"; \
1785     break;
1786 #include "clang/Basic/OpenCLImageTypes.def"
1787   case BuiltinType::OCLSampler:
1788     Out << "PA";
1789     mangleArtificalTagType(TTK_Struct, "ocl_sampler");
1790     break;
1791   case BuiltinType::OCLEvent:
1792     Out << "PA";
1793     mangleArtificalTagType(TTK_Struct, "ocl_event");
1794     break;
1795   case BuiltinType::OCLClkEvent:
1796     Out << "PA";
1797     mangleArtificalTagType(TTK_Struct, "ocl_clkevent");
1798     break;
1799   case BuiltinType::OCLQueue:
1800     Out << "PA";
1801     mangleArtificalTagType(TTK_Struct, "ocl_queue");
1802     break;
1803   case BuiltinType::OCLNDRange:
1804     Out << "PA";
1805     mangleArtificalTagType(TTK_Struct, "ocl_ndrange");
1806     break;
1807   case BuiltinType::OCLReserveID:
1808     Out << "PA";
1809     mangleArtificalTagType(TTK_Struct, "ocl_reserveid");
1810     break;
1811 
1812   case BuiltinType::NullPtr:
1813     Out << "$$T";
1814     break;
1815 
1816   case BuiltinType::Float128:
1817   case BuiltinType::Half: {
1818     DiagnosticsEngine &Diags = Context.getDiags();
1819     unsigned DiagID = Diags.getCustomDiagID(
1820         DiagnosticsEngine::Error, "cannot mangle this built-in %0 type yet");
1821     Diags.Report(Range.getBegin(), DiagID)
1822         << T->getName(Context.getASTContext().getPrintingPolicy()) << Range;
1823     break;
1824   }
1825   }
1826 }
1827 
1828 // <type>          ::= <function-type>
1829 void MicrosoftCXXNameMangler::mangleType(const FunctionProtoType *T, Qualifiers,
1830                                          SourceRange) {
1831   // Structors only appear in decls, so at this point we know it's not a
1832   // structor type.
1833   // FIXME: This may not be lambda-friendly.
1834   if (T->getTypeQuals() || T->getRefQualifier() != RQ_None) {
1835     Out << "$$A8@@";
1836     mangleFunctionType(T, /*D=*/nullptr, /*ForceThisQuals=*/true);
1837   } else {
1838     Out << "$$A6";
1839     mangleFunctionType(T);
1840   }
1841 }
1842 void MicrosoftCXXNameMangler::mangleType(const FunctionNoProtoType *T,
1843                                          Qualifiers, SourceRange) {
1844   Out << "$$A6";
1845   mangleFunctionType(T);
1846 }
1847 
1848 void MicrosoftCXXNameMangler::mangleFunctionType(const FunctionType *T,
1849                                                  const FunctionDecl *D,
1850                                                  bool ForceThisQuals) {
1851   // <function-type> ::= <this-cvr-qualifiers> <calling-convention>
1852   //                     <return-type> <argument-list> <throw-spec>
1853   const FunctionProtoType *Proto = dyn_cast<FunctionProtoType>(T);
1854 
1855   SourceRange Range;
1856   if (D) Range = D->getSourceRange();
1857 
1858   bool IsInLambda = false;
1859   bool IsStructor = false, HasThisQuals = ForceThisQuals, IsCtorClosure = false;
1860   CallingConv CC = T->getCallConv();
1861   if (const CXXMethodDecl *MD = dyn_cast_or_null<CXXMethodDecl>(D)) {
1862     if (MD->getParent()->isLambda())
1863       IsInLambda = true;
1864     if (MD->isInstance())
1865       HasThisQuals = true;
1866     if (isa<CXXDestructorDecl>(MD)) {
1867       IsStructor = true;
1868     } else if (isa<CXXConstructorDecl>(MD)) {
1869       IsStructor = true;
1870       IsCtorClosure = (StructorType == Ctor_CopyingClosure ||
1871                        StructorType == Ctor_DefaultClosure) &&
1872                       isStructorDecl(MD);
1873       if (IsCtorClosure)
1874         CC = getASTContext().getDefaultCallingConvention(
1875             /*IsVariadic=*/false, /*IsCXXMethod=*/true);
1876     }
1877   }
1878 
1879   // If this is a C++ instance method, mangle the CVR qualifiers for the
1880   // this pointer.
1881   if (HasThisQuals) {
1882     Qualifiers Quals = Qualifiers::fromCVRUMask(Proto->getTypeQuals());
1883     manglePointerExtQualifiers(Quals, /*PointeeType=*/QualType());
1884     mangleRefQualifier(Proto->getRefQualifier());
1885     mangleQualifiers(Quals, /*IsMember=*/false);
1886   }
1887 
1888   mangleCallingConvention(CC);
1889 
1890   // <return-type> ::= <type>
1891   //               ::= @ # structors (they have no declared return type)
1892   if (IsStructor) {
1893     if (isa<CXXDestructorDecl>(D) && isStructorDecl(D)) {
1894       // The scalar deleting destructor takes an extra int argument which is not
1895       // reflected in the AST.
1896       if (StructorType == Dtor_Deleting) {
1897         Out << (PointersAre64Bit ? "PEAXI@Z" : "PAXI@Z");
1898         return;
1899       }
1900       // The vbase destructor returns void which is not reflected in the AST.
1901       if (StructorType == Dtor_Complete) {
1902         Out << "XXZ";
1903         return;
1904       }
1905     }
1906     if (IsCtorClosure) {
1907       // Default constructor closure and copy constructor closure both return
1908       // void.
1909       Out << 'X';
1910 
1911       if (StructorType == Ctor_DefaultClosure) {
1912         // Default constructor closure always has no arguments.
1913         Out << 'X';
1914       } else if (StructorType == Ctor_CopyingClosure) {
1915         // Copy constructor closure always takes an unqualified reference.
1916         mangleArgumentType(getASTContext().getLValueReferenceType(
1917                                Proto->getParamType(0)
1918                                    ->getAs<LValueReferenceType>()
1919                                    ->getPointeeType(),
1920                                /*SpelledAsLValue=*/true),
1921                            Range);
1922         Out << '@';
1923       } else {
1924         llvm_unreachable("unexpected constructor closure!");
1925       }
1926       Out << 'Z';
1927       return;
1928     }
1929     Out << '@';
1930   } else {
1931     QualType ResultType = T->getReturnType();
1932     if (const auto *AT =
1933             dyn_cast_or_null<AutoType>(ResultType->getContainedAutoType())) {
1934       Out << '?';
1935       mangleQualifiers(ResultType.getLocalQualifiers(), /*IsMember=*/false);
1936       Out << '?';
1937       assert(AT->getKeyword() != AutoTypeKeyword::GNUAutoType &&
1938              "shouldn't need to mangle __auto_type!");
1939       mangleSourceName(AT->isDecltypeAuto() ? "<decltype-auto>" : "<auto>");
1940       Out << '@';
1941     } else if (IsInLambda) {
1942       Out << '@';
1943     } else {
1944       if (ResultType->isVoidType())
1945         ResultType = ResultType.getUnqualifiedType();
1946       mangleType(ResultType, Range, QMM_Result);
1947     }
1948   }
1949 
1950   // <argument-list> ::= X # void
1951   //                 ::= <type>+ @
1952   //                 ::= <type>* Z # varargs
1953   if (!Proto) {
1954     // Function types without prototypes can arise when mangling a function type
1955     // within an overloadable function in C. We mangle these as the absence of
1956     // any parameter types (not even an empty parameter list).
1957     Out << '@';
1958   } else if (Proto->getNumParams() == 0 && !Proto->isVariadic()) {
1959     Out << 'X';
1960   } else {
1961     // Happens for function pointer type arguments for example.
1962     for (unsigned I = 0, E = Proto->getNumParams(); I != E; ++I) {
1963       mangleArgumentType(Proto->getParamType(I), Range);
1964       // Mangle each pass_object_size parameter as if it's a paramater of enum
1965       // type passed directly after the parameter with the pass_object_size
1966       // attribute. The aforementioned enum's name is __pass_object_size, and we
1967       // pretend it resides in a top-level namespace called __clang.
1968       //
1969       // FIXME: Is there a defined extension notation for the MS ABI, or is it
1970       // necessary to just cross our fingers and hope this type+namespace
1971       // combination doesn't conflict with anything?
1972       if (D)
1973         if (const auto *P = D->getParamDecl(I)->getAttr<PassObjectSizeAttr>())
1974           manglePassObjectSizeArg(P);
1975     }
1976     // <builtin-type>      ::= Z  # ellipsis
1977     if (Proto->isVariadic())
1978       Out << 'Z';
1979     else
1980       Out << '@';
1981   }
1982 
1983   mangleThrowSpecification(Proto);
1984 }
1985 
1986 void MicrosoftCXXNameMangler::mangleFunctionClass(const FunctionDecl *FD) {
1987   // <function-class>  ::= <member-function> E? # E designates a 64-bit 'this'
1988   //                                            # pointer. in 64-bit mode *all*
1989   //                                            # 'this' pointers are 64-bit.
1990   //                   ::= <global-function>
1991   // <member-function> ::= A # private: near
1992   //                   ::= B # private: far
1993   //                   ::= C # private: static near
1994   //                   ::= D # private: static far
1995   //                   ::= E # private: virtual near
1996   //                   ::= F # private: virtual far
1997   //                   ::= I # protected: near
1998   //                   ::= J # protected: far
1999   //                   ::= K # protected: static near
2000   //                   ::= L # protected: static far
2001   //                   ::= M # protected: virtual near
2002   //                   ::= N # protected: virtual far
2003   //                   ::= Q # public: near
2004   //                   ::= R # public: far
2005   //                   ::= S # public: static near
2006   //                   ::= T # public: static far
2007   //                   ::= U # public: virtual near
2008   //                   ::= V # public: virtual far
2009   // <global-function> ::= Y # global near
2010   //                   ::= Z # global far
2011   if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD)) {
2012     bool IsVirtual = MD->isVirtual();
2013     // When mangling vbase destructor variants, ignore whether or not the
2014     // underlying destructor was defined to be virtual.
2015     if (isa<CXXDestructorDecl>(MD) && isStructorDecl(MD) &&
2016         StructorType == Dtor_Complete) {
2017       IsVirtual = false;
2018     }
2019     switch (MD->getAccess()) {
2020       case AS_none:
2021         llvm_unreachable("Unsupported access specifier");
2022       case AS_private:
2023         if (MD->isStatic())
2024           Out << 'C';
2025         else if (IsVirtual)
2026           Out << 'E';
2027         else
2028           Out << 'A';
2029         break;
2030       case AS_protected:
2031         if (MD->isStatic())
2032           Out << 'K';
2033         else if (IsVirtual)
2034           Out << 'M';
2035         else
2036           Out << 'I';
2037         break;
2038       case AS_public:
2039         if (MD->isStatic())
2040           Out << 'S';
2041         else if (IsVirtual)
2042           Out << 'U';
2043         else
2044           Out << 'Q';
2045     }
2046   } else {
2047     Out << 'Y';
2048   }
2049 }
2050 void MicrosoftCXXNameMangler::mangleCallingConvention(CallingConv CC) {
2051   // <calling-convention> ::= A # __cdecl
2052   //                      ::= B # __export __cdecl
2053   //                      ::= C # __pascal
2054   //                      ::= D # __export __pascal
2055   //                      ::= E # __thiscall
2056   //                      ::= F # __export __thiscall
2057   //                      ::= G # __stdcall
2058   //                      ::= H # __export __stdcall
2059   //                      ::= I # __fastcall
2060   //                      ::= J # __export __fastcall
2061   //                      ::= Q # __vectorcall
2062   //                      ::= w # __regcall
2063   // The 'export' calling conventions are from a bygone era
2064   // (*cough*Win16*cough*) when functions were declared for export with
2065   // that keyword. (It didn't actually export them, it just made them so
2066   // that they could be in a DLL and somebody from another module could call
2067   // them.)
2068 
2069   switch (CC) {
2070     default:
2071       llvm_unreachable("Unsupported CC for mangling");
2072     case CC_X86_64Win64:
2073     case CC_X86_64SysV:
2074     case CC_C: Out << 'A'; break;
2075     case CC_X86Pascal: Out << 'C'; break;
2076     case CC_X86ThisCall: Out << 'E'; break;
2077     case CC_X86StdCall: Out << 'G'; break;
2078     case CC_X86FastCall: Out << 'I'; break;
2079     case CC_X86VectorCall: Out << 'Q'; break;
2080     case CC_X86RegCall: Out << 'w'; break;
2081   }
2082 }
2083 void MicrosoftCXXNameMangler::mangleCallingConvention(const FunctionType *T) {
2084   mangleCallingConvention(T->getCallConv());
2085 }
2086 void MicrosoftCXXNameMangler::mangleThrowSpecification(
2087                                                 const FunctionProtoType *FT) {
2088   // <throw-spec> ::= Z # throw(...) (default)
2089   //              ::= @ # throw() or __declspec/__attribute__((nothrow))
2090   //              ::= <type>+
2091   // NOTE: Since the Microsoft compiler ignores throw specifications, they are
2092   // all actually mangled as 'Z'. (They're ignored because their associated
2093   // functionality isn't implemented, and probably never will be.)
2094   Out << 'Z';
2095 }
2096 
2097 void MicrosoftCXXNameMangler::mangleType(const UnresolvedUsingType *T,
2098                                          Qualifiers, SourceRange Range) {
2099   // Probably should be mangled as a template instantiation; need to see what
2100   // VC does first.
2101   DiagnosticsEngine &Diags = Context.getDiags();
2102   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2103     "cannot mangle this unresolved dependent type yet");
2104   Diags.Report(Range.getBegin(), DiagID)
2105     << Range;
2106 }
2107 
2108 // <type>        ::= <union-type> | <struct-type> | <class-type> | <enum-type>
2109 // <union-type>  ::= T <name>
2110 // <struct-type> ::= U <name>
2111 // <class-type>  ::= V <name>
2112 // <enum-type>   ::= W4 <name>
2113 void MicrosoftCXXNameMangler::mangleTagTypeKind(TagTypeKind TTK) {
2114   switch (TTK) {
2115     case TTK_Union:
2116       Out << 'T';
2117       break;
2118     case TTK_Struct:
2119     case TTK_Interface:
2120       Out << 'U';
2121       break;
2122     case TTK_Class:
2123       Out << 'V';
2124       break;
2125     case TTK_Enum:
2126       Out << "W4";
2127       break;
2128   }
2129 }
2130 void MicrosoftCXXNameMangler::mangleType(const EnumType *T, Qualifiers,
2131                                          SourceRange) {
2132   mangleType(cast<TagType>(T)->getDecl());
2133 }
2134 void MicrosoftCXXNameMangler::mangleType(const RecordType *T, Qualifiers,
2135                                          SourceRange) {
2136   mangleType(cast<TagType>(T)->getDecl());
2137 }
2138 void MicrosoftCXXNameMangler::mangleType(const TagDecl *TD) {
2139   mangleTagTypeKind(TD->getTagKind());
2140   mangleName(TD);
2141 }
2142 void MicrosoftCXXNameMangler::mangleArtificalTagType(
2143     TagTypeKind TK, StringRef UnqualifiedName, ArrayRef<StringRef> NestedNames) {
2144   // <name> ::= <unscoped-name> {[<named-scope>]+ | [<nested-name>]}? @
2145   mangleTagTypeKind(TK);
2146 
2147   // Always start with the unqualified name.
2148   mangleSourceName(UnqualifiedName);
2149 
2150   for (auto I = NestedNames.rbegin(), E = NestedNames.rend(); I != E; ++I)
2151     mangleSourceName(*I);
2152 
2153   // Terminate the whole name with an '@'.
2154   Out << '@';
2155 }
2156 
2157 // <type>       ::= <array-type>
2158 // <array-type> ::= <pointer-cvr-qualifiers> <cvr-qualifiers>
2159 //                  [Y <dimension-count> <dimension>+]
2160 //                  <element-type> # as global, E is never required
2161 // It's supposed to be the other way around, but for some strange reason, it
2162 // isn't. Today this behavior is retained for the sole purpose of backwards
2163 // compatibility.
2164 void MicrosoftCXXNameMangler::mangleDecayedArrayType(const ArrayType *T) {
2165   // This isn't a recursive mangling, so now we have to do it all in this
2166   // one call.
2167   manglePointerCVQualifiers(T->getElementType().getQualifiers());
2168   mangleType(T->getElementType(), SourceRange());
2169 }
2170 void MicrosoftCXXNameMangler::mangleType(const ConstantArrayType *T, Qualifiers,
2171                                          SourceRange) {
2172   llvm_unreachable("Should have been special cased");
2173 }
2174 void MicrosoftCXXNameMangler::mangleType(const VariableArrayType *T, Qualifiers,
2175                                          SourceRange) {
2176   llvm_unreachable("Should have been special cased");
2177 }
2178 void MicrosoftCXXNameMangler::mangleType(const DependentSizedArrayType *T,
2179                                          Qualifiers, SourceRange) {
2180   llvm_unreachable("Should have been special cased");
2181 }
2182 void MicrosoftCXXNameMangler::mangleType(const IncompleteArrayType *T,
2183                                          Qualifiers, SourceRange) {
2184   llvm_unreachable("Should have been special cased");
2185 }
2186 void MicrosoftCXXNameMangler::mangleArrayType(const ArrayType *T) {
2187   QualType ElementTy(T, 0);
2188   SmallVector<llvm::APInt, 3> Dimensions;
2189   for (;;) {
2190     if (ElementTy->isConstantArrayType()) {
2191       const ConstantArrayType *CAT =
2192           getASTContext().getAsConstantArrayType(ElementTy);
2193       Dimensions.push_back(CAT->getSize());
2194       ElementTy = CAT->getElementType();
2195     } else if (ElementTy->isIncompleteArrayType()) {
2196       const IncompleteArrayType *IAT =
2197           getASTContext().getAsIncompleteArrayType(ElementTy);
2198       Dimensions.push_back(llvm::APInt(32, 0));
2199       ElementTy = IAT->getElementType();
2200     } else if (ElementTy->isVariableArrayType()) {
2201       const VariableArrayType *VAT =
2202         getASTContext().getAsVariableArrayType(ElementTy);
2203       Dimensions.push_back(llvm::APInt(32, 0));
2204       ElementTy = VAT->getElementType();
2205     } else if (ElementTy->isDependentSizedArrayType()) {
2206       // The dependent expression has to be folded into a constant (TODO).
2207       const DependentSizedArrayType *DSAT =
2208         getASTContext().getAsDependentSizedArrayType(ElementTy);
2209       DiagnosticsEngine &Diags = Context.getDiags();
2210       unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2211         "cannot mangle this dependent-length array yet");
2212       Diags.Report(DSAT->getSizeExpr()->getExprLoc(), DiagID)
2213         << DSAT->getBracketsRange();
2214       return;
2215     } else {
2216       break;
2217     }
2218   }
2219   Out << 'Y';
2220   // <dimension-count> ::= <number> # number of extra dimensions
2221   mangleNumber(Dimensions.size());
2222   for (const llvm::APInt &Dimension : Dimensions)
2223     mangleNumber(Dimension.getLimitedValue());
2224   mangleType(ElementTy, SourceRange(), QMM_Escape);
2225 }
2226 
2227 // <type>                   ::= <pointer-to-member-type>
2228 // <pointer-to-member-type> ::= <pointer-cvr-qualifiers> <cvr-qualifiers>
2229 //                                                          <class name> <type>
2230 void MicrosoftCXXNameMangler::mangleType(const MemberPointerType *T, Qualifiers Quals,
2231                                          SourceRange Range) {
2232   QualType PointeeType = T->getPointeeType();
2233   manglePointerCVQualifiers(Quals);
2234   manglePointerExtQualifiers(Quals, PointeeType);
2235   if (const FunctionProtoType *FPT = PointeeType->getAs<FunctionProtoType>()) {
2236     Out << '8';
2237     mangleName(T->getClass()->castAs<RecordType>()->getDecl());
2238     mangleFunctionType(FPT, nullptr, true);
2239   } else {
2240     mangleQualifiers(PointeeType.getQualifiers(), true);
2241     mangleName(T->getClass()->castAs<RecordType>()->getDecl());
2242     mangleType(PointeeType, Range, QMM_Drop);
2243   }
2244 }
2245 
2246 void MicrosoftCXXNameMangler::mangleType(const TemplateTypeParmType *T,
2247                                          Qualifiers, SourceRange Range) {
2248   DiagnosticsEngine &Diags = Context.getDiags();
2249   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2250     "cannot mangle this template type parameter type yet");
2251   Diags.Report(Range.getBegin(), DiagID)
2252     << Range;
2253 }
2254 
2255 void MicrosoftCXXNameMangler::mangleType(const SubstTemplateTypeParmPackType *T,
2256                                          Qualifiers, SourceRange Range) {
2257   DiagnosticsEngine &Diags = Context.getDiags();
2258   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2259     "cannot mangle this substituted parameter pack yet");
2260   Diags.Report(Range.getBegin(), DiagID)
2261     << Range;
2262 }
2263 
2264 // <type> ::= <pointer-type>
2265 // <pointer-type> ::= E? <pointer-cvr-qualifiers> <cvr-qualifiers> <type>
2266 //                       # the E is required for 64-bit non-static pointers
2267 void MicrosoftCXXNameMangler::mangleType(const PointerType *T, Qualifiers Quals,
2268                                          SourceRange Range) {
2269   QualType PointeeType = T->getPointeeType();
2270   manglePointerCVQualifiers(Quals);
2271   manglePointerExtQualifiers(Quals, PointeeType);
2272   mangleType(PointeeType, Range);
2273 }
2274 void MicrosoftCXXNameMangler::mangleType(const ObjCObjectPointerType *T,
2275                                          Qualifiers Quals, SourceRange Range) {
2276   QualType PointeeType = T->getPointeeType();
2277   manglePointerCVQualifiers(Quals);
2278   manglePointerExtQualifiers(Quals, PointeeType);
2279   // Object pointers never have qualifiers.
2280   Out << 'A';
2281   mangleType(PointeeType, Range);
2282 }
2283 
2284 // <type> ::= <reference-type>
2285 // <reference-type> ::= A E? <cvr-qualifiers> <type>
2286 //                 # the E is required for 64-bit non-static lvalue references
2287 void MicrosoftCXXNameMangler::mangleType(const LValueReferenceType *T,
2288                                          Qualifiers Quals, SourceRange Range) {
2289   QualType PointeeType = T->getPointeeType();
2290   assert(!Quals.hasConst() && !Quals.hasVolatile() && "unexpected qualifier!");
2291   Out << 'A';
2292   manglePointerExtQualifiers(Quals, PointeeType);
2293   mangleType(PointeeType, Range);
2294 }
2295 
2296 // <type> ::= <r-value-reference-type>
2297 // <r-value-reference-type> ::= $$Q E? <cvr-qualifiers> <type>
2298 //                 # the E is required for 64-bit non-static rvalue references
2299 void MicrosoftCXXNameMangler::mangleType(const RValueReferenceType *T,
2300                                          Qualifiers Quals, SourceRange Range) {
2301   QualType PointeeType = T->getPointeeType();
2302   assert(!Quals.hasConst() && !Quals.hasVolatile() && "unexpected qualifier!");
2303   Out << "$$Q";
2304   manglePointerExtQualifiers(Quals, PointeeType);
2305   mangleType(PointeeType, Range);
2306 }
2307 
2308 void MicrosoftCXXNameMangler::mangleType(const ComplexType *T, Qualifiers,
2309                                          SourceRange Range) {
2310   QualType ElementType = T->getElementType();
2311 
2312   llvm::SmallString<64> TemplateMangling;
2313   llvm::raw_svector_ostream Stream(TemplateMangling);
2314   MicrosoftCXXNameMangler Extra(Context, Stream);
2315   Stream << "?$";
2316   Extra.mangleSourceName("_Complex");
2317   Extra.mangleType(ElementType, Range, QMM_Escape);
2318 
2319   mangleArtificalTagType(TTK_Struct, TemplateMangling, {"__clang"});
2320 }
2321 
2322 void MicrosoftCXXNameMangler::mangleType(const VectorType *T, Qualifiers Quals,
2323                                          SourceRange Range) {
2324   const BuiltinType *ET = T->getElementType()->getAs<BuiltinType>();
2325   assert(ET && "vectors with non-builtin elements are unsupported");
2326   uint64_t Width = getASTContext().getTypeSize(T);
2327   // Pattern match exactly the typedefs in our intrinsic headers.  Anything that
2328   // doesn't match the Intel types uses a custom mangling below.
2329   size_t OutSizeBefore = Out.tell();
2330   llvm::Triple::ArchType AT =
2331       getASTContext().getTargetInfo().getTriple().getArch();
2332   if (AT == llvm::Triple::x86 || AT == llvm::Triple::x86_64) {
2333     if (Width == 64 && ET->getKind() == BuiltinType::LongLong) {
2334       mangleArtificalTagType(TTK_Union, "__m64");
2335     } else if (Width >= 128) {
2336       if (ET->getKind() == BuiltinType::Float)
2337         mangleArtificalTagType(TTK_Union, "__m" + llvm::utostr(Width));
2338       else if (ET->getKind() == BuiltinType::LongLong)
2339         mangleArtificalTagType(TTK_Union, "__m" + llvm::utostr(Width) + 'i');
2340       else if (ET->getKind() == BuiltinType::Double)
2341         mangleArtificalTagType(TTK_Struct, "__m" + llvm::utostr(Width) + 'd');
2342     }
2343   }
2344 
2345   bool IsBuiltin = Out.tell() != OutSizeBefore;
2346   if (!IsBuiltin) {
2347     // The MS ABI doesn't have a special mangling for vector types, so we define
2348     // our own mangling to handle uses of __vector_size__ on user-specified
2349     // types, and for extensions like __v4sf.
2350 
2351     llvm::SmallString<64> TemplateMangling;
2352     llvm::raw_svector_ostream Stream(TemplateMangling);
2353     MicrosoftCXXNameMangler Extra(Context, Stream);
2354     Stream << "?$";
2355     Extra.mangleSourceName("__vector");
2356     Extra.mangleType(QualType(ET, 0), Range, QMM_Escape);
2357     Extra.mangleIntegerLiteral(llvm::APSInt::getUnsigned(T->getNumElements()),
2358                                /*IsBoolean=*/false);
2359 
2360     mangleArtificalTagType(TTK_Union, TemplateMangling, {"__clang"});
2361   }
2362 }
2363 
2364 void MicrosoftCXXNameMangler::mangleType(const ExtVectorType *T,
2365                                          Qualifiers Quals, SourceRange Range) {
2366   mangleType(static_cast<const VectorType *>(T), Quals, Range);
2367 }
2368 void MicrosoftCXXNameMangler::mangleType(const DependentSizedExtVectorType *T,
2369                                          Qualifiers, SourceRange Range) {
2370   DiagnosticsEngine &Diags = Context.getDiags();
2371   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2372     "cannot mangle this dependent-sized extended vector type yet");
2373   Diags.Report(Range.getBegin(), DiagID)
2374     << Range;
2375 }
2376 
2377 void MicrosoftCXXNameMangler::mangleType(const ObjCInterfaceType *T, Qualifiers,
2378                                          SourceRange) {
2379   // ObjC interfaces have structs underlying them.
2380   mangleTagTypeKind(TTK_Struct);
2381   mangleName(T->getDecl());
2382 }
2383 
2384 void MicrosoftCXXNameMangler::mangleType(const ObjCObjectType *T, Qualifiers,
2385                                          SourceRange Range) {
2386   // We don't allow overloading by different protocol qualification,
2387   // so mangling them isn't necessary.
2388   mangleType(T->getBaseType(), Range);
2389 }
2390 
2391 void MicrosoftCXXNameMangler::mangleType(const BlockPointerType *T,
2392                                          Qualifiers Quals, SourceRange Range) {
2393   QualType PointeeType = T->getPointeeType();
2394   manglePointerCVQualifiers(Quals);
2395   manglePointerExtQualifiers(Quals, PointeeType);
2396 
2397   Out << "_E";
2398 
2399   mangleFunctionType(PointeeType->castAs<FunctionProtoType>());
2400 }
2401 
2402 void MicrosoftCXXNameMangler::mangleType(const InjectedClassNameType *,
2403                                          Qualifiers, SourceRange) {
2404   llvm_unreachable("Cannot mangle injected class name type.");
2405 }
2406 
2407 void MicrosoftCXXNameMangler::mangleType(const TemplateSpecializationType *T,
2408                                          Qualifiers, SourceRange Range) {
2409   DiagnosticsEngine &Diags = Context.getDiags();
2410   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2411     "cannot mangle this template specialization type yet");
2412   Diags.Report(Range.getBegin(), DiagID)
2413     << Range;
2414 }
2415 
2416 void MicrosoftCXXNameMangler::mangleType(const DependentNameType *T, Qualifiers,
2417                                          SourceRange Range) {
2418   DiagnosticsEngine &Diags = Context.getDiags();
2419   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2420     "cannot mangle this dependent name type yet");
2421   Diags.Report(Range.getBegin(), DiagID)
2422     << Range;
2423 }
2424 
2425 void MicrosoftCXXNameMangler::mangleType(
2426     const DependentTemplateSpecializationType *T, Qualifiers,
2427     SourceRange Range) {
2428   DiagnosticsEngine &Diags = Context.getDiags();
2429   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2430     "cannot mangle this dependent template specialization type yet");
2431   Diags.Report(Range.getBegin(), DiagID)
2432     << Range;
2433 }
2434 
2435 void MicrosoftCXXNameMangler::mangleType(const PackExpansionType *T, Qualifiers,
2436                                          SourceRange Range) {
2437   DiagnosticsEngine &Diags = Context.getDiags();
2438   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2439     "cannot mangle this pack expansion yet");
2440   Diags.Report(Range.getBegin(), DiagID)
2441     << Range;
2442 }
2443 
2444 void MicrosoftCXXNameMangler::mangleType(const TypeOfType *T, Qualifiers,
2445                                          SourceRange Range) {
2446   DiagnosticsEngine &Diags = Context.getDiags();
2447   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2448     "cannot mangle this typeof(type) yet");
2449   Diags.Report(Range.getBegin(), DiagID)
2450     << Range;
2451 }
2452 
2453 void MicrosoftCXXNameMangler::mangleType(const TypeOfExprType *T, Qualifiers,
2454                                          SourceRange Range) {
2455   DiagnosticsEngine &Diags = Context.getDiags();
2456   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2457     "cannot mangle this typeof(expression) yet");
2458   Diags.Report(Range.getBegin(), DiagID)
2459     << Range;
2460 }
2461 
2462 void MicrosoftCXXNameMangler::mangleType(const DecltypeType *T, Qualifiers,
2463                                          SourceRange Range) {
2464   DiagnosticsEngine &Diags = Context.getDiags();
2465   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2466     "cannot mangle this decltype() yet");
2467   Diags.Report(Range.getBegin(), DiagID)
2468     << Range;
2469 }
2470 
2471 void MicrosoftCXXNameMangler::mangleType(const UnaryTransformType *T,
2472                                          Qualifiers, SourceRange Range) {
2473   DiagnosticsEngine &Diags = Context.getDiags();
2474   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2475     "cannot mangle this unary transform type yet");
2476   Diags.Report(Range.getBegin(), DiagID)
2477     << Range;
2478 }
2479 
2480 void MicrosoftCXXNameMangler::mangleType(const AutoType *T, Qualifiers,
2481                                          SourceRange Range) {
2482   assert(T->getDeducedType().isNull() && "expecting a dependent type!");
2483 
2484   DiagnosticsEngine &Diags = Context.getDiags();
2485   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2486     "cannot mangle this 'auto' type yet");
2487   Diags.Report(Range.getBegin(), DiagID)
2488     << Range;
2489 }
2490 
2491 void MicrosoftCXXNameMangler::mangleType(
2492     const DeducedTemplateSpecializationType *T, Qualifiers, SourceRange Range) {
2493   assert(T->getDeducedType().isNull() && "expecting a dependent type!");
2494 
2495   DiagnosticsEngine &Diags = Context.getDiags();
2496   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2497     "cannot mangle this deduced class template specialization type yet");
2498   Diags.Report(Range.getBegin(), DiagID)
2499     << Range;
2500 }
2501 
2502 void MicrosoftCXXNameMangler::mangleType(const AtomicType *T, Qualifiers,
2503                                          SourceRange Range) {
2504   QualType ValueType = T->getValueType();
2505 
2506   llvm::SmallString<64> TemplateMangling;
2507   llvm::raw_svector_ostream Stream(TemplateMangling);
2508   MicrosoftCXXNameMangler Extra(Context, Stream);
2509   Stream << "?$";
2510   Extra.mangleSourceName("_Atomic");
2511   Extra.mangleType(ValueType, Range, QMM_Escape);
2512 
2513   mangleArtificalTagType(TTK_Struct, TemplateMangling, {"__clang"});
2514 }
2515 
2516 void MicrosoftCXXNameMangler::mangleType(const PipeType *T, Qualifiers,
2517                                          SourceRange Range) {
2518   DiagnosticsEngine &Diags = Context.getDiags();
2519   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2520     "cannot mangle this OpenCL pipe type yet");
2521   Diags.Report(Range.getBegin(), DiagID)
2522     << Range;
2523 }
2524 
2525 void MicrosoftMangleContextImpl::mangleCXXName(const NamedDecl *D,
2526                                                raw_ostream &Out) {
2527   assert((isa<FunctionDecl>(D) || isa<VarDecl>(D)) &&
2528          "Invalid mangleName() call, argument is not a variable or function!");
2529   assert(!isa<CXXConstructorDecl>(D) && !isa<CXXDestructorDecl>(D) &&
2530          "Invalid mangleName() call on 'structor decl!");
2531 
2532   PrettyStackTraceDecl CrashInfo(D, SourceLocation(),
2533                                  getASTContext().getSourceManager(),
2534                                  "Mangling declaration");
2535 
2536   msvc_hashing_ostream MHO(Out);
2537   MicrosoftCXXNameMangler Mangler(*this, MHO);
2538   return Mangler.mangle(D);
2539 }
2540 
2541 // <this-adjustment> ::= <no-adjustment> | <static-adjustment> |
2542 //                       <virtual-adjustment>
2543 // <no-adjustment>      ::= A # private near
2544 //                      ::= B # private far
2545 //                      ::= I # protected near
2546 //                      ::= J # protected far
2547 //                      ::= Q # public near
2548 //                      ::= R # public far
2549 // <static-adjustment>  ::= G <static-offset> # private near
2550 //                      ::= H <static-offset> # private far
2551 //                      ::= O <static-offset> # protected near
2552 //                      ::= P <static-offset> # protected far
2553 //                      ::= W <static-offset> # public near
2554 //                      ::= X <static-offset> # public far
2555 // <virtual-adjustment> ::= $0 <virtual-shift> <static-offset> # private near
2556 //                      ::= $1 <virtual-shift> <static-offset> # private far
2557 //                      ::= $2 <virtual-shift> <static-offset> # protected near
2558 //                      ::= $3 <virtual-shift> <static-offset> # protected far
2559 //                      ::= $4 <virtual-shift> <static-offset> # public near
2560 //                      ::= $5 <virtual-shift> <static-offset> # public far
2561 // <virtual-shift>      ::= <vtordisp-shift> | <vtordispex-shift>
2562 // <vtordisp-shift>     ::= <offset-to-vtordisp>
2563 // <vtordispex-shift>   ::= <offset-to-vbptr> <vbase-offset-offset>
2564 //                          <offset-to-vtordisp>
2565 static void mangleThunkThisAdjustment(const CXXMethodDecl *MD,
2566                                       const ThisAdjustment &Adjustment,
2567                                       MicrosoftCXXNameMangler &Mangler,
2568                                       raw_ostream &Out) {
2569   if (!Adjustment.Virtual.isEmpty()) {
2570     Out << '$';
2571     char AccessSpec;
2572     switch (MD->getAccess()) {
2573     case AS_none:
2574       llvm_unreachable("Unsupported access specifier");
2575     case AS_private:
2576       AccessSpec = '0';
2577       break;
2578     case AS_protected:
2579       AccessSpec = '2';
2580       break;
2581     case AS_public:
2582       AccessSpec = '4';
2583     }
2584     if (Adjustment.Virtual.Microsoft.VBPtrOffset) {
2585       Out << 'R' << AccessSpec;
2586       Mangler.mangleNumber(
2587           static_cast<uint32_t>(Adjustment.Virtual.Microsoft.VBPtrOffset));
2588       Mangler.mangleNumber(
2589           static_cast<uint32_t>(Adjustment.Virtual.Microsoft.VBOffsetOffset));
2590       Mangler.mangleNumber(
2591           static_cast<uint32_t>(Adjustment.Virtual.Microsoft.VtordispOffset));
2592       Mangler.mangleNumber(static_cast<uint32_t>(Adjustment.NonVirtual));
2593     } else {
2594       Out << AccessSpec;
2595       Mangler.mangleNumber(
2596           static_cast<uint32_t>(Adjustment.Virtual.Microsoft.VtordispOffset));
2597       Mangler.mangleNumber(-static_cast<uint32_t>(Adjustment.NonVirtual));
2598     }
2599   } else if (Adjustment.NonVirtual != 0) {
2600     switch (MD->getAccess()) {
2601     case AS_none:
2602       llvm_unreachable("Unsupported access specifier");
2603     case AS_private:
2604       Out << 'G';
2605       break;
2606     case AS_protected:
2607       Out << 'O';
2608       break;
2609     case AS_public:
2610       Out << 'W';
2611     }
2612     Mangler.mangleNumber(-static_cast<uint32_t>(Adjustment.NonVirtual));
2613   } else {
2614     switch (MD->getAccess()) {
2615     case AS_none:
2616       llvm_unreachable("Unsupported access specifier");
2617     case AS_private:
2618       Out << 'A';
2619       break;
2620     case AS_protected:
2621       Out << 'I';
2622       break;
2623     case AS_public:
2624       Out << 'Q';
2625     }
2626   }
2627 }
2628 
2629 void
2630 MicrosoftMangleContextImpl::mangleVirtualMemPtrThunk(const CXXMethodDecl *MD,
2631                                                      raw_ostream &Out) {
2632   MicrosoftVTableContext *VTContext =
2633       cast<MicrosoftVTableContext>(getASTContext().getVTableContext());
2634   const MicrosoftVTableContext::MethodVFTableLocation &ML =
2635       VTContext->getMethodVFTableLocation(GlobalDecl(MD));
2636 
2637   msvc_hashing_ostream MHO(Out);
2638   MicrosoftCXXNameMangler Mangler(*this, MHO);
2639   Mangler.getStream() << "\01?";
2640   Mangler.mangleVirtualMemPtrThunk(MD, ML);
2641 }
2642 
2643 void MicrosoftMangleContextImpl::mangleThunk(const CXXMethodDecl *MD,
2644                                              const ThunkInfo &Thunk,
2645                                              raw_ostream &Out) {
2646   msvc_hashing_ostream MHO(Out);
2647   MicrosoftCXXNameMangler Mangler(*this, MHO);
2648   Mangler.getStream() << "\01?";
2649   Mangler.mangleName(MD);
2650   mangleThunkThisAdjustment(MD, Thunk.This, Mangler, MHO);
2651   if (!Thunk.Return.isEmpty())
2652     assert(Thunk.Method != nullptr &&
2653            "Thunk info should hold the overridee decl");
2654 
2655   const CXXMethodDecl *DeclForFPT = Thunk.Method ? Thunk.Method : MD;
2656   Mangler.mangleFunctionType(
2657       DeclForFPT->getType()->castAs<FunctionProtoType>(), MD);
2658 }
2659 
2660 void MicrosoftMangleContextImpl::mangleCXXDtorThunk(
2661     const CXXDestructorDecl *DD, CXXDtorType Type,
2662     const ThisAdjustment &Adjustment, raw_ostream &Out) {
2663   // FIXME: Actually, the dtor thunk should be emitted for vector deleting
2664   // dtors rather than scalar deleting dtors. Just use the vector deleting dtor
2665   // mangling manually until we support both deleting dtor types.
2666   assert(Type == Dtor_Deleting);
2667   msvc_hashing_ostream MHO(Out);
2668   MicrosoftCXXNameMangler Mangler(*this, MHO, DD, Type);
2669   Mangler.getStream() << "\01??_E";
2670   Mangler.mangleName(DD->getParent());
2671   mangleThunkThisAdjustment(DD, Adjustment, Mangler, MHO);
2672   Mangler.mangleFunctionType(DD->getType()->castAs<FunctionProtoType>(), DD);
2673 }
2674 
2675 void MicrosoftMangleContextImpl::mangleCXXVFTable(
2676     const CXXRecordDecl *Derived, ArrayRef<const CXXRecordDecl *> BasePath,
2677     raw_ostream &Out) {
2678   // <mangled-name> ::= ?_7 <class-name> <storage-class>
2679   //                    <cvr-qualifiers> [<name>] @
2680   // NOTE: <cvr-qualifiers> here is always 'B' (const). <storage-class>
2681   // is always '6' for vftables.
2682   msvc_hashing_ostream MHO(Out);
2683   MicrosoftCXXNameMangler Mangler(*this, MHO);
2684   if (Derived->hasAttr<DLLImportAttr>())
2685     Mangler.getStream() << "\01??_S";
2686   else
2687     Mangler.getStream() << "\01??_7";
2688   Mangler.mangleName(Derived);
2689   Mangler.getStream() << "6B"; // '6' for vftable, 'B' for const.
2690   for (const CXXRecordDecl *RD : BasePath)
2691     Mangler.mangleName(RD);
2692   Mangler.getStream() << '@';
2693 }
2694 
2695 void MicrosoftMangleContextImpl::mangleCXXVBTable(
2696     const CXXRecordDecl *Derived, ArrayRef<const CXXRecordDecl *> BasePath,
2697     raw_ostream &Out) {
2698   // <mangled-name> ::= ?_8 <class-name> <storage-class>
2699   //                    <cvr-qualifiers> [<name>] @
2700   // NOTE: <cvr-qualifiers> here is always 'B' (const). <storage-class>
2701   // is always '7' for vbtables.
2702   msvc_hashing_ostream MHO(Out);
2703   MicrosoftCXXNameMangler Mangler(*this, MHO);
2704   Mangler.getStream() << "\01??_8";
2705   Mangler.mangleName(Derived);
2706   Mangler.getStream() << "7B";  // '7' for vbtable, 'B' for const.
2707   for (const CXXRecordDecl *RD : BasePath)
2708     Mangler.mangleName(RD);
2709   Mangler.getStream() << '@';
2710 }
2711 
2712 void MicrosoftMangleContextImpl::mangleCXXRTTI(QualType T, raw_ostream &Out) {
2713   msvc_hashing_ostream MHO(Out);
2714   MicrosoftCXXNameMangler Mangler(*this, MHO);
2715   Mangler.getStream() << "\01??_R0";
2716   Mangler.mangleType(T, SourceRange(), MicrosoftCXXNameMangler::QMM_Result);
2717   Mangler.getStream() << "@8";
2718 }
2719 
2720 void MicrosoftMangleContextImpl::mangleCXXRTTIName(QualType T,
2721                                                    raw_ostream &Out) {
2722   MicrosoftCXXNameMangler Mangler(*this, Out);
2723   Mangler.getStream() << '.';
2724   Mangler.mangleType(T, SourceRange(), MicrosoftCXXNameMangler::QMM_Result);
2725 }
2726 
2727 void MicrosoftMangleContextImpl::mangleCXXVirtualDisplacementMap(
2728     const CXXRecordDecl *SrcRD, const CXXRecordDecl *DstRD, raw_ostream &Out) {
2729   msvc_hashing_ostream MHO(Out);
2730   MicrosoftCXXNameMangler Mangler(*this, MHO);
2731   Mangler.getStream() << "\01??_K";
2732   Mangler.mangleName(SrcRD);
2733   Mangler.getStream() << "$C";
2734   Mangler.mangleName(DstRD);
2735 }
2736 
2737 void MicrosoftMangleContextImpl::mangleCXXThrowInfo(QualType T, bool IsConst,
2738                                                     bool IsVolatile,
2739                                                     bool IsUnaligned,
2740                                                     uint32_t NumEntries,
2741                                                     raw_ostream &Out) {
2742   msvc_hashing_ostream MHO(Out);
2743   MicrosoftCXXNameMangler Mangler(*this, MHO);
2744   Mangler.getStream() << "_TI";
2745   if (IsConst)
2746     Mangler.getStream() << 'C';
2747   if (IsVolatile)
2748     Mangler.getStream() << 'V';
2749   if (IsUnaligned)
2750     Mangler.getStream() << 'U';
2751   Mangler.getStream() << NumEntries;
2752   Mangler.mangleType(T, SourceRange(), MicrosoftCXXNameMangler::QMM_Result);
2753 }
2754 
2755 void MicrosoftMangleContextImpl::mangleCXXCatchableTypeArray(
2756     QualType T, uint32_t NumEntries, raw_ostream &Out) {
2757   msvc_hashing_ostream MHO(Out);
2758   MicrosoftCXXNameMangler Mangler(*this, MHO);
2759   Mangler.getStream() << "_CTA";
2760   Mangler.getStream() << NumEntries;
2761   Mangler.mangleType(T, SourceRange(), MicrosoftCXXNameMangler::QMM_Result);
2762 }
2763 
2764 void MicrosoftMangleContextImpl::mangleCXXCatchableType(
2765     QualType T, const CXXConstructorDecl *CD, CXXCtorType CT, uint32_t Size,
2766     uint32_t NVOffset, int32_t VBPtrOffset, uint32_t VBIndex,
2767     raw_ostream &Out) {
2768   MicrosoftCXXNameMangler Mangler(*this, Out);
2769   Mangler.getStream() << "_CT";
2770 
2771   llvm::SmallString<64> RTTIMangling;
2772   {
2773     llvm::raw_svector_ostream Stream(RTTIMangling);
2774     msvc_hashing_ostream MHO(Stream);
2775     mangleCXXRTTI(T, MHO);
2776   }
2777   Mangler.getStream() << RTTIMangling.substr(1);
2778 
2779   // VS2015 CTP6 omits the copy-constructor in the mangled name.  This name is,
2780   // in fact, superfluous but I'm not sure the change was made consciously.
2781   llvm::SmallString<64> CopyCtorMangling;
2782   if (!getASTContext().getLangOpts().isCompatibleWithMSVC(
2783           LangOptions::MSVC2015) &&
2784       CD) {
2785     llvm::raw_svector_ostream Stream(CopyCtorMangling);
2786     msvc_hashing_ostream MHO(Stream);
2787     mangleCXXCtor(CD, CT, MHO);
2788   }
2789   Mangler.getStream() << CopyCtorMangling.substr(1);
2790 
2791   Mangler.getStream() << Size;
2792   if (VBPtrOffset == -1) {
2793     if (NVOffset) {
2794       Mangler.getStream() << NVOffset;
2795     }
2796   } else {
2797     Mangler.getStream() << NVOffset;
2798     Mangler.getStream() << VBPtrOffset;
2799     Mangler.getStream() << VBIndex;
2800   }
2801 }
2802 
2803 void MicrosoftMangleContextImpl::mangleCXXRTTIBaseClassDescriptor(
2804     const CXXRecordDecl *Derived, uint32_t NVOffset, int32_t VBPtrOffset,
2805     uint32_t VBTableOffset, uint32_t Flags, raw_ostream &Out) {
2806   msvc_hashing_ostream MHO(Out);
2807   MicrosoftCXXNameMangler Mangler(*this, MHO);
2808   Mangler.getStream() << "\01??_R1";
2809   Mangler.mangleNumber(NVOffset);
2810   Mangler.mangleNumber(VBPtrOffset);
2811   Mangler.mangleNumber(VBTableOffset);
2812   Mangler.mangleNumber(Flags);
2813   Mangler.mangleName(Derived);
2814   Mangler.getStream() << "8";
2815 }
2816 
2817 void MicrosoftMangleContextImpl::mangleCXXRTTIBaseClassArray(
2818     const CXXRecordDecl *Derived, raw_ostream &Out) {
2819   msvc_hashing_ostream MHO(Out);
2820   MicrosoftCXXNameMangler Mangler(*this, MHO);
2821   Mangler.getStream() << "\01??_R2";
2822   Mangler.mangleName(Derived);
2823   Mangler.getStream() << "8";
2824 }
2825 
2826 void MicrosoftMangleContextImpl::mangleCXXRTTIClassHierarchyDescriptor(
2827     const CXXRecordDecl *Derived, raw_ostream &Out) {
2828   msvc_hashing_ostream MHO(Out);
2829   MicrosoftCXXNameMangler Mangler(*this, MHO);
2830   Mangler.getStream() << "\01??_R3";
2831   Mangler.mangleName(Derived);
2832   Mangler.getStream() << "8";
2833 }
2834 
2835 void MicrosoftMangleContextImpl::mangleCXXRTTICompleteObjectLocator(
2836     const CXXRecordDecl *Derived, ArrayRef<const CXXRecordDecl *> BasePath,
2837     raw_ostream &Out) {
2838   // <mangled-name> ::= ?_R4 <class-name> <storage-class>
2839   //                    <cvr-qualifiers> [<name>] @
2840   // NOTE: <cvr-qualifiers> here is always 'B' (const). <storage-class>
2841   // is always '6' for vftables.
2842   llvm::SmallString<64> VFTableMangling;
2843   llvm::raw_svector_ostream Stream(VFTableMangling);
2844   mangleCXXVFTable(Derived, BasePath, Stream);
2845 
2846   if (VFTableMangling.startswith("\01??@")) {
2847     assert(VFTableMangling.endswith("@"));
2848     Out << VFTableMangling << "??_R4@";
2849     return;
2850   }
2851 
2852   assert(VFTableMangling.startswith("\01??_7") ||
2853          VFTableMangling.startswith("\01??_S"));
2854 
2855   Out << "\01??_R4" << StringRef(VFTableMangling).drop_front(5);
2856 }
2857 
2858 void MicrosoftMangleContextImpl::mangleSEHFilterExpression(
2859     const NamedDecl *EnclosingDecl, raw_ostream &Out) {
2860   msvc_hashing_ostream MHO(Out);
2861   MicrosoftCXXNameMangler Mangler(*this, MHO);
2862   // The function body is in the same comdat as the function with the handler,
2863   // so the numbering here doesn't have to be the same across TUs.
2864   //
2865   // <mangled-name> ::= ?filt$ <filter-number> @0
2866   Mangler.getStream() << "\01?filt$" << SEHFilterIds[EnclosingDecl]++ << "@0@";
2867   Mangler.mangleName(EnclosingDecl);
2868 }
2869 
2870 void MicrosoftMangleContextImpl::mangleSEHFinallyBlock(
2871     const NamedDecl *EnclosingDecl, raw_ostream &Out) {
2872   msvc_hashing_ostream MHO(Out);
2873   MicrosoftCXXNameMangler Mangler(*this, MHO);
2874   // The function body is in the same comdat as the function with the handler,
2875   // so the numbering here doesn't have to be the same across TUs.
2876   //
2877   // <mangled-name> ::= ?fin$ <filter-number> @0
2878   Mangler.getStream() << "\01?fin$" << SEHFinallyIds[EnclosingDecl]++ << "@0@";
2879   Mangler.mangleName(EnclosingDecl);
2880 }
2881 
2882 void MicrosoftMangleContextImpl::mangleTypeName(QualType T, raw_ostream &Out) {
2883   // This is just a made up unique string for the purposes of tbaa.  undname
2884   // does *not* know how to demangle it.
2885   MicrosoftCXXNameMangler Mangler(*this, Out);
2886   Mangler.getStream() << '?';
2887   Mangler.mangleType(T, SourceRange());
2888 }
2889 
2890 void MicrosoftMangleContextImpl::mangleCXXCtor(const CXXConstructorDecl *D,
2891                                                CXXCtorType Type,
2892                                                raw_ostream &Out) {
2893   msvc_hashing_ostream MHO(Out);
2894   MicrosoftCXXNameMangler mangler(*this, MHO, D, Type);
2895   mangler.mangle(D);
2896 }
2897 
2898 void MicrosoftMangleContextImpl::mangleCXXDtor(const CXXDestructorDecl *D,
2899                                                CXXDtorType Type,
2900                                                raw_ostream &Out) {
2901   msvc_hashing_ostream MHO(Out);
2902   MicrosoftCXXNameMangler mangler(*this, MHO, D, Type);
2903   mangler.mangle(D);
2904 }
2905 
2906 void MicrosoftMangleContextImpl::mangleReferenceTemporary(
2907     const VarDecl *VD, unsigned ManglingNumber, raw_ostream &Out) {
2908   msvc_hashing_ostream MHO(Out);
2909   MicrosoftCXXNameMangler Mangler(*this, MHO);
2910 
2911   Mangler.getStream() << "\01?$RT" << ManglingNumber << '@';
2912   Mangler.mangle(VD, "");
2913 }
2914 
2915 void MicrosoftMangleContextImpl::mangleThreadSafeStaticGuardVariable(
2916     const VarDecl *VD, unsigned GuardNum, raw_ostream &Out) {
2917   msvc_hashing_ostream MHO(Out);
2918   MicrosoftCXXNameMangler Mangler(*this, MHO);
2919 
2920   Mangler.getStream() << "\01?$TSS" << GuardNum << '@';
2921   Mangler.mangleNestedName(VD);
2922   Mangler.getStream() << "@4HA";
2923 }
2924 
2925 void MicrosoftMangleContextImpl::mangleStaticGuardVariable(const VarDecl *VD,
2926                                                            raw_ostream &Out) {
2927   // <guard-name> ::= ?_B <postfix> @5 <scope-depth>
2928   //              ::= ?__J <postfix> @5 <scope-depth>
2929   //              ::= ?$S <guard-num> @ <postfix> @4IA
2930 
2931   // The first mangling is what MSVC uses to guard static locals in inline
2932   // functions.  It uses a different mangling in external functions to support
2933   // guarding more than 32 variables.  MSVC rejects inline functions with more
2934   // than 32 static locals.  We don't fully implement the second mangling
2935   // because those guards are not externally visible, and instead use LLVM's
2936   // default renaming when creating a new guard variable.
2937   msvc_hashing_ostream MHO(Out);
2938   MicrosoftCXXNameMangler Mangler(*this, MHO);
2939 
2940   bool Visible = VD->isExternallyVisible();
2941   if (Visible) {
2942     Mangler.getStream() << (VD->getTLSKind() ? "\01??__J" : "\01??_B");
2943   } else {
2944     Mangler.getStream() << "\01?$S1@";
2945   }
2946   unsigned ScopeDepth = 0;
2947   if (Visible && !getNextDiscriminator(VD, ScopeDepth))
2948     // If we do not have a discriminator and are emitting a guard variable for
2949     // use at global scope, then mangling the nested name will not be enough to
2950     // remove ambiguities.
2951     Mangler.mangle(VD, "");
2952   else
2953     Mangler.mangleNestedName(VD);
2954   Mangler.getStream() << (Visible ? "@5" : "@4IA");
2955   if (ScopeDepth)
2956     Mangler.mangleNumber(ScopeDepth);
2957 }
2958 
2959 void MicrosoftMangleContextImpl::mangleInitFiniStub(const VarDecl *D,
2960                                                     char CharCode,
2961                                                     raw_ostream &Out) {
2962   msvc_hashing_ostream MHO(Out);
2963   MicrosoftCXXNameMangler Mangler(*this, MHO);
2964   Mangler.getStream() << "\01??__" << CharCode;
2965   Mangler.mangleName(D);
2966   if (D->isStaticDataMember()) {
2967     Mangler.mangleVariableEncoding(D);
2968     Mangler.getStream() << '@';
2969   }
2970   // This is the function class mangling.  These stubs are global, non-variadic,
2971   // cdecl functions that return void and take no args.
2972   Mangler.getStream() << "YAXXZ";
2973 }
2974 
2975 void MicrosoftMangleContextImpl::mangleDynamicInitializer(const VarDecl *D,
2976                                                           raw_ostream &Out) {
2977   // <initializer-name> ::= ?__E <name> YAXXZ
2978   mangleInitFiniStub(D, 'E', Out);
2979 }
2980 
2981 void
2982 MicrosoftMangleContextImpl::mangleDynamicAtExitDestructor(const VarDecl *D,
2983                                                           raw_ostream &Out) {
2984   // <destructor-name> ::= ?__F <name> YAXXZ
2985   mangleInitFiniStub(D, 'F', Out);
2986 }
2987 
2988 void MicrosoftMangleContextImpl::mangleStringLiteral(const StringLiteral *SL,
2989                                                      raw_ostream &Out) {
2990   // <char-type> ::= 0   # char
2991   //             ::= 1   # wchar_t
2992   //             ::= ??? # char16_t/char32_t will need a mangling too...
2993   //
2994   // <literal-length> ::= <non-negative integer>  # the length of the literal
2995   //
2996   // <encoded-crc>    ::= <hex digit>+ @          # crc of the literal including
2997   //                                              # null-terminator
2998   //
2999   // <encoded-string> ::= <simple character>           # uninteresting character
3000   //                  ::= '?$' <hex digit> <hex digit> # these two nibbles
3001   //                                                   # encode the byte for the
3002   //                                                   # character
3003   //                  ::= '?' [a-z]                    # \xe1 - \xfa
3004   //                  ::= '?' [A-Z]                    # \xc1 - \xda
3005   //                  ::= '?' [0-9]                    # [,/\:. \n\t'-]
3006   //
3007   // <literal> ::= '??_C@_' <char-type> <literal-length> <encoded-crc>
3008   //               <encoded-string> '@'
3009   MicrosoftCXXNameMangler Mangler(*this, Out);
3010   Mangler.getStream() << "\01??_C@_";
3011 
3012   // <char-type>: The "kind" of string literal is encoded into the mangled name.
3013   if (SL->isWide())
3014     Mangler.getStream() << '1';
3015   else
3016     Mangler.getStream() << '0';
3017 
3018   // <literal-length>: The next part of the mangled name consists of the length
3019   // of the string.
3020   // The StringLiteral does not consider the NUL terminator byte(s) but the
3021   // mangling does.
3022   // N.B. The length is in terms of bytes, not characters.
3023   Mangler.mangleNumber(SL->getByteLength() + SL->getCharByteWidth());
3024 
3025   auto GetLittleEndianByte = [&SL](unsigned Index) {
3026     unsigned CharByteWidth = SL->getCharByteWidth();
3027     uint32_t CodeUnit = SL->getCodeUnit(Index / CharByteWidth);
3028     unsigned OffsetInCodeUnit = Index % CharByteWidth;
3029     return static_cast<char>((CodeUnit >> (8 * OffsetInCodeUnit)) & 0xff);
3030   };
3031 
3032   auto GetBigEndianByte = [&SL](unsigned Index) {
3033     unsigned CharByteWidth = SL->getCharByteWidth();
3034     uint32_t CodeUnit = SL->getCodeUnit(Index / CharByteWidth);
3035     unsigned OffsetInCodeUnit = (CharByteWidth - 1) - (Index % CharByteWidth);
3036     return static_cast<char>((CodeUnit >> (8 * OffsetInCodeUnit)) & 0xff);
3037   };
3038 
3039   // CRC all the bytes of the StringLiteral.
3040   llvm::JamCRC JC;
3041   for (unsigned I = 0, E = SL->getByteLength(); I != E; ++I)
3042     JC.update(GetLittleEndianByte(I));
3043 
3044   // The NUL terminator byte(s) were not present earlier,
3045   // we need to manually process those bytes into the CRC.
3046   for (unsigned NullTerminator = 0; NullTerminator < SL->getCharByteWidth();
3047        ++NullTerminator)
3048     JC.update('\x00');
3049 
3050   // <encoded-crc>: The CRC is encoded utilizing the standard number mangling
3051   // scheme.
3052   Mangler.mangleNumber(JC.getCRC());
3053 
3054   // <encoded-string>: The mangled name also contains the first 32 _characters_
3055   // (including null-terminator bytes) of the StringLiteral.
3056   // Each character is encoded by splitting them into bytes and then encoding
3057   // the constituent bytes.
3058   auto MangleByte = [&Mangler](char Byte) {
3059     // There are five different manglings for characters:
3060     // - [a-zA-Z0-9_$]: A one-to-one mapping.
3061     // - ?[a-z]: The range from \xe1 to \xfa.
3062     // - ?[A-Z]: The range from \xc1 to \xda.
3063     // - ?[0-9]: The set of [,/\:. \n\t'-].
3064     // - ?$XX: A fallback which maps nibbles.
3065     if (isIdentifierBody(Byte, /*AllowDollar=*/true)) {
3066       Mangler.getStream() << Byte;
3067     } else if (isLetter(Byte & 0x7f)) {
3068       Mangler.getStream() << '?' << static_cast<char>(Byte & 0x7f);
3069     } else {
3070       const char SpecialChars[] = {',', '/',  '\\', ':',  '.',
3071                                    ' ', '\n', '\t', '\'', '-'};
3072       const char *Pos =
3073           std::find(std::begin(SpecialChars), std::end(SpecialChars), Byte);
3074       if (Pos != std::end(SpecialChars)) {
3075         Mangler.getStream() << '?' << (Pos - std::begin(SpecialChars));
3076       } else {
3077         Mangler.getStream() << "?$";
3078         Mangler.getStream() << static_cast<char>('A' + ((Byte >> 4) & 0xf));
3079         Mangler.getStream() << static_cast<char>('A' + (Byte & 0xf));
3080       }
3081     }
3082   };
3083 
3084   // Enforce our 32 character max.
3085   unsigned NumCharsToMangle = std::min(32U, SL->getLength());
3086   for (unsigned I = 0, E = NumCharsToMangle * SL->getCharByteWidth(); I != E;
3087        ++I)
3088     if (SL->isWide())
3089       MangleByte(GetBigEndianByte(I));
3090     else
3091       MangleByte(GetLittleEndianByte(I));
3092 
3093   // Encode the NUL terminator if there is room.
3094   if (NumCharsToMangle < 32)
3095     for (unsigned NullTerminator = 0; NullTerminator < SL->getCharByteWidth();
3096          ++NullTerminator)
3097       MangleByte(0);
3098 
3099   Mangler.getStream() << '@';
3100 }
3101 
3102 MicrosoftMangleContext *
3103 MicrosoftMangleContext::create(ASTContext &Context, DiagnosticsEngine &Diags) {
3104   return new MicrosoftMangleContextImpl(Context, Diags);
3105 }
3106