xref: /netbsd-src/external/apache2/llvm/dist/clang/lib/AST/MicrosoftMangle.cpp (revision e038c9c4676b0f19b1b7dd08a940c6ed64a6d5ae)
1 //===--- MicrosoftMangle.cpp - Microsoft Visual C++ Name Mangling ---------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This provides C++ name mangling targeting the Microsoft Visual C++ ABI.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "clang/AST/ASTContext.h"
14 #include "clang/AST/Attr.h"
15 #include "clang/AST/CXXInheritance.h"
16 #include "clang/AST/CharUnits.h"
17 #include "clang/AST/Decl.h"
18 #include "clang/AST/DeclCXX.h"
19 #include "clang/AST/DeclObjC.h"
20 #include "clang/AST/DeclOpenMP.h"
21 #include "clang/AST/DeclTemplate.h"
22 #include "clang/AST/Expr.h"
23 #include "clang/AST/ExprCXX.h"
24 #include "clang/AST/Mangle.h"
25 #include "clang/AST/VTableBuilder.h"
26 #include "clang/Basic/ABI.h"
27 #include "clang/Basic/DiagnosticOptions.h"
28 #include "clang/Basic/FileManager.h"
29 #include "clang/Basic/SourceManager.h"
30 #include "clang/Basic/TargetInfo.h"
31 #include "llvm/ADT/StringExtras.h"
32 #include "llvm/Support/CRC.h"
33 #include "llvm/Support/MD5.h"
34 #include "llvm/Support/MathExtras.h"
35 #include "llvm/Support/StringSaver.h"
36 #include "llvm/Support/xxhash.h"
37 
38 using namespace clang;
39 
40 namespace {
41 
42 struct msvc_hashing_ostream : public llvm::raw_svector_ostream {
43   raw_ostream &OS;
44   llvm::SmallString<64> Buffer;
45 
msvc_hashing_ostream__anon113ba3c60111::msvc_hashing_ostream46   msvc_hashing_ostream(raw_ostream &OS)
47       : llvm::raw_svector_ostream(Buffer), OS(OS) {}
~msvc_hashing_ostream__anon113ba3c60111::msvc_hashing_ostream48   ~msvc_hashing_ostream() override {
49     StringRef MangledName = str();
50     bool StartsWithEscape = MangledName.startswith("\01");
51     if (StartsWithEscape)
52       MangledName = MangledName.drop_front(1);
53     if (MangledName.size() < 4096) {
54       OS << str();
55       return;
56     }
57 
58     llvm::MD5 Hasher;
59     llvm::MD5::MD5Result Hash;
60     Hasher.update(MangledName);
61     Hasher.final(Hash);
62 
63     SmallString<32> HexString;
64     llvm::MD5::stringifyResult(Hash, HexString);
65 
66     if (StartsWithEscape)
67       OS << '\01';
68     OS << "??@" << HexString << '@';
69   }
70 };
71 
72 static const DeclContext *
getLambdaDefaultArgumentDeclContext(const Decl * D)73 getLambdaDefaultArgumentDeclContext(const Decl *D) {
74   if (const auto *RD = dyn_cast<CXXRecordDecl>(D))
75     if (RD->isLambda())
76       if (const auto *Parm =
77               dyn_cast_or_null<ParmVarDecl>(RD->getLambdaContextDecl()))
78         return Parm->getDeclContext();
79   return nullptr;
80 }
81 
82 /// Retrieve the declaration context that should be used when mangling
83 /// the given declaration.
getEffectiveDeclContext(const Decl * D)84 static const DeclContext *getEffectiveDeclContext(const Decl *D) {
85   // The ABI assumes that lambda closure types that occur within
86   // default arguments live in the context of the function. However, due to
87   // the way in which Clang parses and creates function declarations, this is
88   // not the case: the lambda closure type ends up living in the context
89   // where the function itself resides, because the function declaration itself
90   // had not yet been created. Fix the context here.
91   if (const auto *LDADC = getLambdaDefaultArgumentDeclContext(D))
92     return LDADC;
93 
94   // Perform the same check for block literals.
95   if (const BlockDecl *BD = dyn_cast<BlockDecl>(D)) {
96     if (ParmVarDecl *ContextParam =
97             dyn_cast_or_null<ParmVarDecl>(BD->getBlockManglingContextDecl()))
98       return ContextParam->getDeclContext();
99   }
100 
101   const DeclContext *DC = D->getDeclContext();
102   if (isa<CapturedDecl>(DC) || isa<OMPDeclareReductionDecl>(DC) ||
103       isa<OMPDeclareMapperDecl>(DC)) {
104     return getEffectiveDeclContext(cast<Decl>(DC));
105   }
106 
107   return DC->getRedeclContext();
108 }
109 
getEffectiveParentContext(const DeclContext * DC)110 static const DeclContext *getEffectiveParentContext(const DeclContext *DC) {
111   return getEffectiveDeclContext(cast<Decl>(DC));
112 }
113 
getStructor(const NamedDecl * ND)114 static const FunctionDecl *getStructor(const NamedDecl *ND) {
115   if (const auto *FTD = dyn_cast<FunctionTemplateDecl>(ND))
116     return FTD->getTemplatedDecl()->getCanonicalDecl();
117 
118   const auto *FD = cast<FunctionDecl>(ND);
119   if (const auto *FTD = FD->getPrimaryTemplate())
120     return FTD->getTemplatedDecl()->getCanonicalDecl();
121 
122   return FD->getCanonicalDecl();
123 }
124 
125 /// MicrosoftMangleContextImpl - Overrides the default MangleContext for the
126 /// Microsoft Visual C++ ABI.
127 class MicrosoftMangleContextImpl : public MicrosoftMangleContext {
128   typedef std::pair<const DeclContext *, IdentifierInfo *> DiscriminatorKeyTy;
129   llvm::DenseMap<DiscriminatorKeyTy, unsigned> Discriminator;
130   llvm::DenseMap<const NamedDecl *, unsigned> Uniquifier;
131   llvm::DenseMap<const CXXRecordDecl *, unsigned> LambdaIds;
132   llvm::DenseMap<const NamedDecl *, unsigned> SEHFilterIds;
133   llvm::DenseMap<const NamedDecl *, unsigned> SEHFinallyIds;
134   SmallString<16> AnonymousNamespaceHash;
135 
136 public:
137   MicrosoftMangleContextImpl(ASTContext &Context, DiagnosticsEngine &Diags);
138   bool shouldMangleCXXName(const NamedDecl *D) override;
139   bool shouldMangleStringLiteral(const StringLiteral *SL) override;
140   void mangleCXXName(GlobalDecl GD, raw_ostream &Out) override;
141   void mangleVirtualMemPtrThunk(const CXXMethodDecl *MD,
142                                 const MethodVFTableLocation &ML,
143                                 raw_ostream &Out) override;
144   void mangleThunk(const CXXMethodDecl *MD, const ThunkInfo &Thunk,
145                    raw_ostream &) override;
146   void mangleCXXDtorThunk(const CXXDestructorDecl *DD, CXXDtorType Type,
147                           const ThisAdjustment &ThisAdjustment,
148                           raw_ostream &) override;
149   void mangleCXXVFTable(const CXXRecordDecl *Derived,
150                         ArrayRef<const CXXRecordDecl *> BasePath,
151                         raw_ostream &Out) override;
152   void mangleCXXVBTable(const CXXRecordDecl *Derived,
153                         ArrayRef<const CXXRecordDecl *> BasePath,
154                         raw_ostream &Out) override;
155   void mangleCXXVirtualDisplacementMap(const CXXRecordDecl *SrcRD,
156                                        const CXXRecordDecl *DstRD,
157                                        raw_ostream &Out) override;
158   void mangleCXXThrowInfo(QualType T, bool IsConst, bool IsVolatile,
159                           bool IsUnaligned, uint32_t NumEntries,
160                           raw_ostream &Out) override;
161   void mangleCXXCatchableTypeArray(QualType T, uint32_t NumEntries,
162                                    raw_ostream &Out) override;
163   void mangleCXXCatchableType(QualType T, const CXXConstructorDecl *CD,
164                               CXXCtorType CT, uint32_t Size, uint32_t NVOffset,
165                               int32_t VBPtrOffset, uint32_t VBIndex,
166                               raw_ostream &Out) override;
167   void mangleCXXRTTI(QualType T, raw_ostream &Out) override;
168   void mangleCXXRTTIName(QualType T, raw_ostream &Out) override;
169   void mangleCXXRTTIBaseClassDescriptor(const CXXRecordDecl *Derived,
170                                         uint32_t NVOffset, int32_t VBPtrOffset,
171                                         uint32_t VBTableOffset, uint32_t Flags,
172                                         raw_ostream &Out) override;
173   void mangleCXXRTTIBaseClassArray(const CXXRecordDecl *Derived,
174                                    raw_ostream &Out) override;
175   void mangleCXXRTTIClassHierarchyDescriptor(const CXXRecordDecl *Derived,
176                                              raw_ostream &Out) override;
177   void
178   mangleCXXRTTICompleteObjectLocator(const CXXRecordDecl *Derived,
179                                      ArrayRef<const CXXRecordDecl *> BasePath,
180                                      raw_ostream &Out) override;
181   void mangleTypeName(QualType T, raw_ostream &) override;
182   void mangleReferenceTemporary(const VarDecl *, unsigned ManglingNumber,
183                                 raw_ostream &) override;
184   void mangleStaticGuardVariable(const VarDecl *D, raw_ostream &Out) override;
185   void mangleThreadSafeStaticGuardVariable(const VarDecl *D, unsigned GuardNum,
186                                            raw_ostream &Out) override;
187   void mangleDynamicInitializer(const VarDecl *D, raw_ostream &Out) override;
188   void mangleDynamicAtExitDestructor(const VarDecl *D,
189                                      raw_ostream &Out) override;
190   void mangleSEHFilterExpression(const NamedDecl *EnclosingDecl,
191                                  raw_ostream &Out) override;
192   void mangleSEHFinallyBlock(const NamedDecl *EnclosingDecl,
193                              raw_ostream &Out) override;
194   void mangleStringLiteral(const StringLiteral *SL, raw_ostream &Out) override;
getNextDiscriminator(const NamedDecl * ND,unsigned & disc)195   bool getNextDiscriminator(const NamedDecl *ND, unsigned &disc) {
196     const DeclContext *DC = getEffectiveDeclContext(ND);
197     if (!DC->isFunctionOrMethod())
198       return false;
199 
200     // Lambda closure types are already numbered, give out a phony number so
201     // that they demangle nicely.
202     if (const auto *RD = dyn_cast<CXXRecordDecl>(ND)) {
203       if (RD->isLambda()) {
204         disc = 1;
205         return true;
206       }
207     }
208 
209     // Use the canonical number for externally visible decls.
210     if (ND->isExternallyVisible()) {
211       disc = getASTContext().getManglingNumber(ND);
212       return true;
213     }
214 
215     // Anonymous tags are already numbered.
216     if (const TagDecl *Tag = dyn_cast<TagDecl>(ND)) {
217       if (!Tag->hasNameForLinkage() &&
218           !getASTContext().getDeclaratorForUnnamedTagDecl(Tag) &&
219           !getASTContext().getTypedefNameForUnnamedTagDecl(Tag))
220         return false;
221     }
222 
223     // Make up a reasonable number for internal decls.
224     unsigned &discriminator = Uniquifier[ND];
225     if (!discriminator)
226       discriminator = ++Discriminator[std::make_pair(DC, ND->getIdentifier())];
227     disc = discriminator + 1;
228     return true;
229   }
230 
getLambdaString(const CXXRecordDecl * Lambda)231   std::string getLambdaString(const CXXRecordDecl *Lambda) override {
232     assert(Lambda->isLambda() && "RD must be a lambda!");
233     std::string Name("<lambda_");
234 
235     Decl *LambdaContextDecl = Lambda->getLambdaContextDecl();
236     unsigned LambdaManglingNumber = Lambda->getLambdaManglingNumber();
237     unsigned LambdaId;
238     const ParmVarDecl *Parm = dyn_cast_or_null<ParmVarDecl>(LambdaContextDecl);
239     const FunctionDecl *Func =
240         Parm ? dyn_cast<FunctionDecl>(Parm->getDeclContext()) : nullptr;
241 
242     if (Func) {
243       unsigned DefaultArgNo =
244           Func->getNumParams() - Parm->getFunctionScopeIndex();
245       Name += llvm::utostr(DefaultArgNo);
246       Name += "_";
247     }
248 
249     if (LambdaManglingNumber)
250       LambdaId = LambdaManglingNumber;
251     else
252       LambdaId = getLambdaIdForDebugInfo(Lambda);
253 
254     Name += llvm::utostr(LambdaId);
255     Name += ">";
256     return Name;
257   }
258 
getLambdaId(const CXXRecordDecl * RD)259   unsigned getLambdaId(const CXXRecordDecl *RD) {
260     assert(RD->isLambda() && "RD must be a lambda!");
261     assert(!RD->isExternallyVisible() && "RD must not be visible!");
262     assert(RD->getLambdaManglingNumber() == 0 &&
263            "RD must not have a mangling number!");
264     std::pair<llvm::DenseMap<const CXXRecordDecl *, unsigned>::iterator, bool>
265         Result = LambdaIds.insert(std::make_pair(RD, LambdaIds.size()));
266     return Result.first->second;
267   }
268 
getLambdaIdForDebugInfo(const CXXRecordDecl * RD)269   unsigned getLambdaIdForDebugInfo(const CXXRecordDecl *RD) {
270     assert(RD->isLambda() && "RD must be a lambda!");
271     assert(!RD->isExternallyVisible() && "RD must not be visible!");
272     assert(RD->getLambdaManglingNumber() == 0 &&
273            "RD must not have a mangling number!");
274     llvm::DenseMap<const CXXRecordDecl *, unsigned>::iterator Result =
275         LambdaIds.find(RD);
276     // The lambda should exist, but return 0 in case it doesn't.
277     if (Result == LambdaIds.end())
278       return 0;
279     return Result->second;
280   }
281 
282   /// Return a character sequence that is (somewhat) unique to the TU suitable
283   /// for mangling anonymous namespaces.
getAnonymousNamespaceHash() const284   StringRef getAnonymousNamespaceHash() const {
285     return AnonymousNamespaceHash;
286   }
287 
288 private:
289   void mangleInitFiniStub(const VarDecl *D, char CharCode, raw_ostream &Out);
290 };
291 
292 /// MicrosoftCXXNameMangler - Manage the mangling of a single name for the
293 /// Microsoft Visual C++ ABI.
294 class MicrosoftCXXNameMangler {
295   MicrosoftMangleContextImpl &Context;
296   raw_ostream &Out;
297 
298   /// The "structor" is the top-level declaration being mangled, if
299   /// that's not a template specialization; otherwise it's the pattern
300   /// for that specialization.
301   const NamedDecl *Structor;
302   unsigned StructorType;
303 
304   typedef llvm::SmallVector<std::string, 10> BackRefVec;
305   BackRefVec NameBackReferences;
306 
307   typedef llvm::DenseMap<const void *, unsigned> ArgBackRefMap;
308   ArgBackRefMap FunArgBackReferences;
309   ArgBackRefMap TemplateArgBackReferences;
310 
311   typedef llvm::DenseMap<const void *, StringRef> TemplateArgStringMap;
312   TemplateArgStringMap TemplateArgStrings;
313   llvm::StringSaver TemplateArgStringStorage;
314   llvm::BumpPtrAllocator TemplateArgStringStorageAlloc;
315 
316   typedef std::set<std::pair<int, bool>> PassObjectSizeArgsSet;
317   PassObjectSizeArgsSet PassObjectSizeArgs;
318 
getASTContext() const319   ASTContext &getASTContext() const { return Context.getASTContext(); }
320 
321   const bool PointersAre64Bit;
322 
323 public:
324   enum QualifierMangleMode { QMM_Drop, QMM_Mangle, QMM_Escape, QMM_Result };
325 
MicrosoftCXXNameMangler(MicrosoftMangleContextImpl & C,raw_ostream & Out_)326   MicrosoftCXXNameMangler(MicrosoftMangleContextImpl &C, raw_ostream &Out_)
327       : Context(C), Out(Out_), Structor(nullptr), StructorType(-1),
328         TemplateArgStringStorage(TemplateArgStringStorageAlloc),
329         PointersAre64Bit(C.getASTContext().getTargetInfo().getPointerWidth(0) ==
330                          64) {}
331 
MicrosoftCXXNameMangler(MicrosoftMangleContextImpl & C,raw_ostream & Out_,const CXXConstructorDecl * D,CXXCtorType Type)332   MicrosoftCXXNameMangler(MicrosoftMangleContextImpl &C, raw_ostream &Out_,
333                           const CXXConstructorDecl *D, CXXCtorType Type)
334       : Context(C), Out(Out_), Structor(getStructor(D)), StructorType(Type),
335         TemplateArgStringStorage(TemplateArgStringStorageAlloc),
336         PointersAre64Bit(C.getASTContext().getTargetInfo().getPointerWidth(0) ==
337                          64) {}
338 
MicrosoftCXXNameMangler(MicrosoftMangleContextImpl & C,raw_ostream & Out_,const CXXDestructorDecl * D,CXXDtorType Type)339   MicrosoftCXXNameMangler(MicrosoftMangleContextImpl &C, raw_ostream &Out_,
340                           const CXXDestructorDecl *D, CXXDtorType Type)
341       : Context(C), Out(Out_), Structor(getStructor(D)), StructorType(Type),
342         TemplateArgStringStorage(TemplateArgStringStorageAlloc),
343         PointersAre64Bit(C.getASTContext().getTargetInfo().getPointerWidth(0) ==
344                          64) {}
345 
getStream() const346   raw_ostream &getStream() const { return Out; }
347 
348   void mangle(const NamedDecl *D, StringRef Prefix = "?");
349   void mangleName(const NamedDecl *ND);
350   void mangleFunctionEncoding(const FunctionDecl *FD, bool ShouldMangle);
351   void mangleVariableEncoding(const VarDecl *VD);
352   void mangleMemberDataPointer(const CXXRecordDecl *RD, const ValueDecl *VD,
353                                StringRef Prefix = "$");
354   void mangleMemberFunctionPointer(const CXXRecordDecl *RD,
355                                    const CXXMethodDecl *MD,
356                                    StringRef Prefix = "$");
357   void mangleVirtualMemPtrThunk(const CXXMethodDecl *MD,
358                                 const MethodVFTableLocation &ML);
359   void mangleNumber(int64_t Number);
360   void mangleNumber(llvm::APSInt Number);
361   void mangleFloat(llvm::APFloat Number);
362   void mangleBits(llvm::APInt Number);
363   void mangleTagTypeKind(TagTypeKind TK);
364   void mangleArtificialTagType(TagTypeKind TK, StringRef UnqualifiedName,
365                               ArrayRef<StringRef> NestedNames = None);
366   void mangleAddressSpaceType(QualType T, Qualifiers Quals, SourceRange Range);
367   void mangleType(QualType T, SourceRange Range,
368                   QualifierMangleMode QMM = QMM_Mangle);
369   void mangleFunctionType(const FunctionType *T,
370                           const FunctionDecl *D = nullptr,
371                           bool ForceThisQuals = false,
372                           bool MangleExceptionSpec = true);
373   void mangleNestedName(const NamedDecl *ND);
374 
375 private:
isStructorDecl(const NamedDecl * ND) const376   bool isStructorDecl(const NamedDecl *ND) const {
377     return ND == Structor || getStructor(ND) == Structor;
378   }
379 
is64BitPointer(Qualifiers Quals) const380   bool is64BitPointer(Qualifiers Quals) const {
381     LangAS AddrSpace = Quals.getAddressSpace();
382     return AddrSpace == LangAS::ptr64 ||
383            (PointersAre64Bit && !(AddrSpace == LangAS::ptr32_sptr ||
384                                   AddrSpace == LangAS::ptr32_uptr));
385   }
386 
mangleUnqualifiedName(const NamedDecl * ND)387   void mangleUnqualifiedName(const NamedDecl *ND) {
388     mangleUnqualifiedName(ND, ND->getDeclName());
389   }
390   void mangleUnqualifiedName(const NamedDecl *ND, DeclarationName Name);
391   void mangleSourceName(StringRef Name);
392   void mangleOperatorName(OverloadedOperatorKind OO, SourceLocation Loc);
393   void mangleCXXDtorType(CXXDtorType T);
394   void mangleQualifiers(Qualifiers Quals, bool IsMember);
395   void mangleRefQualifier(RefQualifierKind RefQualifier);
396   void manglePointerCVQualifiers(Qualifiers Quals);
397   void manglePointerExtQualifiers(Qualifiers Quals, QualType PointeeType);
398 
399   void mangleUnscopedTemplateName(const TemplateDecl *ND);
400   void
401   mangleTemplateInstantiationName(const TemplateDecl *TD,
402                                   const TemplateArgumentList &TemplateArgs);
403   void mangleObjCMethodName(const ObjCMethodDecl *MD);
404 
405   void mangleFunctionArgumentType(QualType T, SourceRange Range);
406   void manglePassObjectSizeArg(const PassObjectSizeAttr *POSA);
407 
408   bool isArtificialTagType(QualType T) const;
409 
410   // Declare manglers for every type class.
411 #define ABSTRACT_TYPE(CLASS, PARENT)
412 #define NON_CANONICAL_TYPE(CLASS, PARENT)
413 #define TYPE(CLASS, PARENT) void mangleType(const CLASS##Type *T, \
414                                             Qualifiers Quals, \
415                                             SourceRange Range);
416 #include "clang/AST/TypeNodes.inc"
417 #undef ABSTRACT_TYPE
418 #undef NON_CANONICAL_TYPE
419 #undef TYPE
420 
421   void mangleType(const TagDecl *TD);
422   void mangleDecayedArrayType(const ArrayType *T);
423   void mangleArrayType(const ArrayType *T);
424   void mangleFunctionClass(const FunctionDecl *FD);
425   void mangleCallingConvention(CallingConv CC);
426   void mangleCallingConvention(const FunctionType *T);
427   void mangleIntegerLiteral(const llvm::APSInt &Number,
428                             const NonTypeTemplateParmDecl *PD = nullptr,
429                             QualType TemplateArgType = QualType());
430   void mangleExpression(const Expr *E, const NonTypeTemplateParmDecl *PD);
431   void mangleThrowSpecification(const FunctionProtoType *T);
432 
433   void mangleTemplateArgs(const TemplateDecl *TD,
434                           const TemplateArgumentList &TemplateArgs);
435   void mangleTemplateArg(const TemplateDecl *TD, const TemplateArgument &TA,
436                          const NamedDecl *Parm);
437   void mangleTemplateArgValue(QualType T, const APValue &V,
438                               bool WithScalarType = false);
439 
440   void mangleObjCProtocol(const ObjCProtocolDecl *PD);
441   void mangleObjCLifetime(const QualType T, Qualifiers Quals,
442                           SourceRange Range);
443   void mangleObjCKindOfType(const ObjCObjectType *T, Qualifiers Quals,
444                             SourceRange Range);
445 };
446 }
447 
MicrosoftMangleContextImpl(ASTContext & Context,DiagnosticsEngine & Diags)448 MicrosoftMangleContextImpl::MicrosoftMangleContextImpl(ASTContext &Context,
449                                                        DiagnosticsEngine &Diags)
450     : MicrosoftMangleContext(Context, Diags) {
451   // To mangle anonymous namespaces, hash the path to the main source file. The
452   // path should be whatever (probably relative) path was passed on the command
453   // line. The goal is for the compiler to produce the same output regardless of
454   // working directory, so use the uncanonicalized relative path.
455   //
456   // It's important to make the mangled names unique because, when CodeView
457   // debug info is in use, the debugger uses mangled type names to distinguish
458   // between otherwise identically named types in anonymous namespaces.
459   //
460   // These symbols are always internal, so there is no need for the hash to
461   // match what MSVC produces. For the same reason, clang is free to change the
462   // hash at any time without breaking compatibility with old versions of clang.
463   // The generated names are intended to look similar to what MSVC generates,
464   // which are something like "?A0x01234567@".
465   SourceManager &SM = Context.getSourceManager();
466   if (const FileEntry *FE = SM.getFileEntryForID(SM.getMainFileID())) {
467     // Truncate the hash so we get 8 characters of hexadecimal.
468     uint32_t TruncatedHash = uint32_t(xxHash64(FE->getName()));
469     AnonymousNamespaceHash = llvm::utohexstr(TruncatedHash);
470   } else {
471     // If we don't have a path to the main file, we'll just use 0.
472     AnonymousNamespaceHash = "0";
473   }
474 }
475 
shouldMangleCXXName(const NamedDecl * D)476 bool MicrosoftMangleContextImpl::shouldMangleCXXName(const NamedDecl *D) {
477   if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
478     LanguageLinkage L = FD->getLanguageLinkage();
479     // Overloadable functions need mangling.
480     if (FD->hasAttr<OverloadableAttr>())
481       return true;
482 
483     // The ABI expects that we would never mangle "typical" user-defined entry
484     // points regardless of visibility or freestanding-ness.
485     //
486     // N.B. This is distinct from asking about "main".  "main" has a lot of
487     // special rules associated with it in the standard while these
488     // user-defined entry points are outside of the purview of the standard.
489     // For example, there can be only one definition for "main" in a standards
490     // compliant program; however nothing forbids the existence of wmain and
491     // WinMain in the same translation unit.
492     if (FD->isMSVCRTEntryPoint())
493       return false;
494 
495     // C++ functions and those whose names are not a simple identifier need
496     // mangling.
497     if (!FD->getDeclName().isIdentifier() || L == CXXLanguageLinkage)
498       return true;
499 
500     // C functions are not mangled.
501     if (L == CLanguageLinkage)
502       return false;
503   }
504 
505   // Otherwise, no mangling is done outside C++ mode.
506   if (!getASTContext().getLangOpts().CPlusPlus)
507     return false;
508 
509   const VarDecl *VD = dyn_cast<VarDecl>(D);
510   if (VD && !isa<DecompositionDecl>(D)) {
511     // C variables are not mangled.
512     if (VD->isExternC())
513       return false;
514 
515     // Variables at global scope with internal linkage are not mangled.
516     const DeclContext *DC = getEffectiveDeclContext(D);
517     // Check for extern variable declared locally.
518     if (DC->isFunctionOrMethod() && D->hasLinkage())
519       while (!DC->isNamespace() && !DC->isTranslationUnit())
520         DC = getEffectiveParentContext(DC);
521 
522     if (DC->isTranslationUnit() && D->getFormalLinkage() == InternalLinkage &&
523         !isa<VarTemplateSpecializationDecl>(D) &&
524         D->getIdentifier() != nullptr)
525       return false;
526   }
527 
528   return true;
529 }
530 
531 bool
shouldMangleStringLiteral(const StringLiteral * SL)532 MicrosoftMangleContextImpl::shouldMangleStringLiteral(const StringLiteral *SL) {
533   return true;
534 }
535 
mangle(const NamedDecl * D,StringRef Prefix)536 void MicrosoftCXXNameMangler::mangle(const NamedDecl *D, StringRef Prefix) {
537   // MSVC doesn't mangle C++ names the same way it mangles extern "C" names.
538   // Therefore it's really important that we don't decorate the
539   // name with leading underscores or leading/trailing at signs. So, by
540   // default, we emit an asm marker at the start so we get the name right.
541   // Callers can override this with a custom prefix.
542 
543   // <mangled-name> ::= ? <name> <type-encoding>
544   Out << Prefix;
545   mangleName(D);
546   if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
547     mangleFunctionEncoding(FD, Context.shouldMangleDeclName(FD));
548   else if (const VarDecl *VD = dyn_cast<VarDecl>(D))
549     mangleVariableEncoding(VD);
550   else if (isa<MSGuidDecl>(D))
551     // MSVC appears to mangle GUIDs as if they were variables of type
552     // 'const struct __s_GUID'.
553     Out << "3U__s_GUID@@B";
554   else if (isa<TemplateParamObjectDecl>(D)) {
555     // Template parameter objects don't get a <type-encoding>; their type is
556     // specified as part of their value.
557   } else
558     llvm_unreachable("Tried to mangle unexpected NamedDecl!");
559 }
560 
mangleFunctionEncoding(const FunctionDecl * FD,bool ShouldMangle)561 void MicrosoftCXXNameMangler::mangleFunctionEncoding(const FunctionDecl *FD,
562                                                      bool ShouldMangle) {
563   // <type-encoding> ::= <function-class> <function-type>
564 
565   // Since MSVC operates on the type as written and not the canonical type, it
566   // actually matters which decl we have here.  MSVC appears to choose the
567   // first, since it is most likely to be the declaration in a header file.
568   FD = FD->getFirstDecl();
569 
570   // We should never ever see a FunctionNoProtoType at this point.
571   // We don't even know how to mangle their types anyway :).
572   const FunctionProtoType *FT = FD->getType()->castAs<FunctionProtoType>();
573 
574   // extern "C" functions can hold entities that must be mangled.
575   // As it stands, these functions still need to get expressed in the full
576   // external name.  They have their class and type omitted, replaced with '9'.
577   if (ShouldMangle) {
578     // We would like to mangle all extern "C" functions using this additional
579     // component but this would break compatibility with MSVC's behavior.
580     // Instead, do this when we know that compatibility isn't important (in
581     // other words, when it is an overloaded extern "C" function).
582     if (FD->isExternC() && FD->hasAttr<OverloadableAttr>())
583       Out << "$$J0";
584 
585     mangleFunctionClass(FD);
586 
587     mangleFunctionType(FT, FD, false, false);
588   } else {
589     Out << '9';
590   }
591 }
592 
mangleVariableEncoding(const VarDecl * VD)593 void MicrosoftCXXNameMangler::mangleVariableEncoding(const VarDecl *VD) {
594   // <type-encoding> ::= <storage-class> <variable-type>
595   // <storage-class> ::= 0  # private static member
596   //                 ::= 1  # protected static member
597   //                 ::= 2  # public static member
598   //                 ::= 3  # global
599   //                 ::= 4  # static local
600 
601   // The first character in the encoding (after the name) is the storage class.
602   if (VD->isStaticDataMember()) {
603     // If it's a static member, it also encodes the access level.
604     switch (VD->getAccess()) {
605       default:
606       case AS_private: Out << '0'; break;
607       case AS_protected: Out << '1'; break;
608       case AS_public: Out << '2'; break;
609     }
610   }
611   else if (!VD->isStaticLocal())
612     Out << '3';
613   else
614     Out << '4';
615   // Now mangle the type.
616   // <variable-type> ::= <type> <cvr-qualifiers>
617   //                 ::= <type> <pointee-cvr-qualifiers> # pointers, references
618   // Pointers and references are odd. The type of 'int * const foo;' gets
619   // mangled as 'QAHA' instead of 'PAHB', for example.
620   SourceRange SR = VD->getSourceRange();
621   QualType Ty = VD->getType();
622   if (Ty->isPointerType() || Ty->isReferenceType() ||
623       Ty->isMemberPointerType()) {
624     mangleType(Ty, SR, QMM_Drop);
625     manglePointerExtQualifiers(
626         Ty.getDesugaredType(getASTContext()).getLocalQualifiers(), QualType());
627     if (const MemberPointerType *MPT = Ty->getAs<MemberPointerType>()) {
628       mangleQualifiers(MPT->getPointeeType().getQualifiers(), true);
629       // Member pointers are suffixed with a back reference to the member
630       // pointer's class name.
631       mangleName(MPT->getClass()->getAsCXXRecordDecl());
632     } else
633       mangleQualifiers(Ty->getPointeeType().getQualifiers(), false);
634   } else if (const ArrayType *AT = getASTContext().getAsArrayType(Ty)) {
635     // Global arrays are funny, too.
636     mangleDecayedArrayType(AT);
637     if (AT->getElementType()->isArrayType())
638       Out << 'A';
639     else
640       mangleQualifiers(Ty.getQualifiers(), false);
641   } else {
642     mangleType(Ty, SR, QMM_Drop);
643     mangleQualifiers(Ty.getQualifiers(), false);
644   }
645 }
646 
mangleMemberDataPointer(const CXXRecordDecl * RD,const ValueDecl * VD,StringRef Prefix)647 void MicrosoftCXXNameMangler::mangleMemberDataPointer(const CXXRecordDecl *RD,
648                                                       const ValueDecl *VD,
649                                                       StringRef Prefix) {
650   // <member-data-pointer> ::= <integer-literal>
651   //                       ::= $F <number> <number>
652   //                       ::= $G <number> <number> <number>
653 
654   int64_t FieldOffset;
655   int64_t VBTableOffset;
656   MSInheritanceModel IM = RD->getMSInheritanceModel();
657   if (VD) {
658     FieldOffset = getASTContext().getFieldOffset(VD);
659     assert(FieldOffset % getASTContext().getCharWidth() == 0 &&
660            "cannot take address of bitfield");
661     FieldOffset /= getASTContext().getCharWidth();
662 
663     VBTableOffset = 0;
664 
665     if (IM == MSInheritanceModel::Virtual)
666       FieldOffset -= getASTContext().getOffsetOfBaseWithVBPtr(RD).getQuantity();
667   } else {
668     FieldOffset = RD->nullFieldOffsetIsZero() ? 0 : -1;
669 
670     VBTableOffset = -1;
671   }
672 
673   char Code = '\0';
674   switch (IM) {
675   case MSInheritanceModel::Single:      Code = '0'; break;
676   case MSInheritanceModel::Multiple:    Code = '0'; break;
677   case MSInheritanceModel::Virtual:     Code = 'F'; break;
678   case MSInheritanceModel::Unspecified: Code = 'G'; break;
679   }
680 
681   Out << Prefix << Code;
682 
683   mangleNumber(FieldOffset);
684 
685   // The C++ standard doesn't allow base-to-derived member pointer conversions
686   // in template parameter contexts, so the vbptr offset of data member pointers
687   // is always zero.
688   if (inheritanceModelHasVBPtrOffsetField(IM))
689     mangleNumber(0);
690   if (inheritanceModelHasVBTableOffsetField(IM))
691     mangleNumber(VBTableOffset);
692 }
693 
694 void
mangleMemberFunctionPointer(const CXXRecordDecl * RD,const CXXMethodDecl * MD,StringRef Prefix)695 MicrosoftCXXNameMangler::mangleMemberFunctionPointer(const CXXRecordDecl *RD,
696                                                      const CXXMethodDecl *MD,
697                                                      StringRef Prefix) {
698   // <member-function-pointer> ::= $1? <name>
699   //                           ::= $H? <name> <number>
700   //                           ::= $I? <name> <number> <number>
701   //                           ::= $J? <name> <number> <number> <number>
702 
703   MSInheritanceModel IM = RD->getMSInheritanceModel();
704 
705   char Code = '\0';
706   switch (IM) {
707   case MSInheritanceModel::Single:      Code = '1'; break;
708   case MSInheritanceModel::Multiple:    Code = 'H'; break;
709   case MSInheritanceModel::Virtual:     Code = 'I'; break;
710   case MSInheritanceModel::Unspecified: Code = 'J'; break;
711   }
712 
713   // If non-virtual, mangle the name.  If virtual, mangle as a virtual memptr
714   // thunk.
715   uint64_t NVOffset = 0;
716   uint64_t VBTableOffset = 0;
717   uint64_t VBPtrOffset = 0;
718   if (MD) {
719     Out << Prefix << Code << '?';
720     if (MD->isVirtual()) {
721       MicrosoftVTableContext *VTContext =
722           cast<MicrosoftVTableContext>(getASTContext().getVTableContext());
723       MethodVFTableLocation ML =
724           VTContext->getMethodVFTableLocation(GlobalDecl(MD));
725       mangleVirtualMemPtrThunk(MD, ML);
726       NVOffset = ML.VFPtrOffset.getQuantity();
727       VBTableOffset = ML.VBTableIndex * 4;
728       if (ML.VBase) {
729         const ASTRecordLayout &Layout = getASTContext().getASTRecordLayout(RD);
730         VBPtrOffset = Layout.getVBPtrOffset().getQuantity();
731       }
732     } else {
733       mangleName(MD);
734       mangleFunctionEncoding(MD, /*ShouldMangle=*/true);
735     }
736 
737     if (VBTableOffset == 0 && IM == MSInheritanceModel::Virtual)
738       NVOffset -= getASTContext().getOffsetOfBaseWithVBPtr(RD).getQuantity();
739   } else {
740     // Null single inheritance member functions are encoded as a simple nullptr.
741     if (IM == MSInheritanceModel::Single) {
742       Out << Prefix << "0A@";
743       return;
744     }
745     if (IM == MSInheritanceModel::Unspecified)
746       VBTableOffset = -1;
747     Out << Prefix << Code;
748   }
749 
750   if (inheritanceModelHasNVOffsetField(/*IsMemberFunction=*/true, IM))
751     mangleNumber(static_cast<uint32_t>(NVOffset));
752   if (inheritanceModelHasVBPtrOffsetField(IM))
753     mangleNumber(VBPtrOffset);
754   if (inheritanceModelHasVBTableOffsetField(IM))
755     mangleNumber(VBTableOffset);
756 }
757 
mangleVirtualMemPtrThunk(const CXXMethodDecl * MD,const MethodVFTableLocation & ML)758 void MicrosoftCXXNameMangler::mangleVirtualMemPtrThunk(
759     const CXXMethodDecl *MD, const MethodVFTableLocation &ML) {
760   // Get the vftable offset.
761   CharUnits PointerWidth = getASTContext().toCharUnitsFromBits(
762       getASTContext().getTargetInfo().getPointerWidth(0));
763   uint64_t OffsetInVFTable = ML.Index * PointerWidth.getQuantity();
764 
765   Out << "?_9";
766   mangleName(MD->getParent());
767   Out << "$B";
768   mangleNumber(OffsetInVFTable);
769   Out << 'A';
770   mangleCallingConvention(MD->getType()->castAs<FunctionProtoType>());
771 }
772 
mangleName(const NamedDecl * ND)773 void MicrosoftCXXNameMangler::mangleName(const NamedDecl *ND) {
774   // <name> ::= <unscoped-name> {[<named-scope>]+ | [<nested-name>]}? @
775 
776   // Always start with the unqualified name.
777   mangleUnqualifiedName(ND);
778 
779   mangleNestedName(ND);
780 
781   // Terminate the whole name with an '@'.
782   Out << '@';
783 }
784 
mangleNumber(int64_t Number)785 void MicrosoftCXXNameMangler::mangleNumber(int64_t Number) {
786   mangleNumber(llvm::APSInt(llvm::APInt(64, Number), /*IsUnsigned*/false));
787 }
788 
mangleNumber(llvm::APSInt Number)789 void MicrosoftCXXNameMangler::mangleNumber(llvm::APSInt Number) {
790   // MSVC never mangles any integer wider than 64 bits. In general it appears
791   // to convert every integer to signed 64 bit before mangling (including
792   // unsigned 64 bit values). Do the same, but preserve bits beyond the bottom
793   // 64.
794   llvm::APInt Value =
795       Number.isSigned() ? Number.sextOrSelf(64) : Number.zextOrSelf(64);
796 
797   // <non-negative integer> ::= A@              # when Number == 0
798   //                        ::= <decimal digit> # when 1 <= Number <= 10
799   //                        ::= <hex digit>+ @  # when Number >= 10
800   //
801   // <number>               ::= [?] <non-negative integer>
802 
803   if (Value.isNegative()) {
804     Value = -Value;
805     Out << '?';
806   }
807   mangleBits(Value);
808 }
809 
mangleFloat(llvm::APFloat Number)810 void MicrosoftCXXNameMangler::mangleFloat(llvm::APFloat Number) {
811   using llvm::APFloat;
812 
813   switch (APFloat::SemanticsToEnum(Number.getSemantics())) {
814   case APFloat::S_IEEEsingle: Out << 'A'; break;
815   case APFloat::S_IEEEdouble: Out << 'B'; break;
816 
817   // The following are all Clang extensions. We try to pick manglings that are
818   // unlikely to conflict with MSVC's scheme.
819   case APFloat::S_IEEEhalf: Out << 'V'; break;
820   case APFloat::S_BFloat: Out << 'W'; break;
821   case APFloat::S_x87DoubleExtended: Out << 'X'; break;
822   case APFloat::S_IEEEquad: Out << 'Y'; break;
823   case APFloat::S_PPCDoubleDouble: Out << 'Z'; break;
824   }
825 
826   mangleBits(Number.bitcastToAPInt());
827 }
828 
mangleBits(llvm::APInt Value)829 void MicrosoftCXXNameMangler::mangleBits(llvm::APInt Value) {
830   if (Value == 0)
831     Out << "A@";
832   else if (Value.uge(1) && Value.ule(10))
833     Out << (Value - 1);
834   else {
835     // Numbers that are not encoded as decimal digits are represented as nibbles
836     // in the range of ASCII characters 'A' to 'P'.
837     // The number 0x123450 would be encoded as 'BCDEFA'
838     llvm::SmallString<32> EncodedNumberBuffer;
839     for (; Value != 0; Value.lshrInPlace(4))
840       EncodedNumberBuffer.push_back('A' + (Value & 0xf).getZExtValue());
841     std::reverse(EncodedNumberBuffer.begin(), EncodedNumberBuffer.end());
842     Out.write(EncodedNumberBuffer.data(), EncodedNumberBuffer.size());
843     Out << '@';
844   }
845 }
846 
847 static const TemplateDecl *
isTemplate(const NamedDecl * ND,const TemplateArgumentList * & TemplateArgs)848 isTemplate(const NamedDecl *ND, const TemplateArgumentList *&TemplateArgs) {
849   // Check if we have a function template.
850   if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)) {
851     if (const TemplateDecl *TD = FD->getPrimaryTemplate()) {
852       TemplateArgs = FD->getTemplateSpecializationArgs();
853       return TD;
854     }
855   }
856 
857   // Check if we have a class template.
858   if (const ClassTemplateSpecializationDecl *Spec =
859           dyn_cast<ClassTemplateSpecializationDecl>(ND)) {
860     TemplateArgs = &Spec->getTemplateArgs();
861     return Spec->getSpecializedTemplate();
862   }
863 
864   // Check if we have a variable template.
865   if (const VarTemplateSpecializationDecl *Spec =
866           dyn_cast<VarTemplateSpecializationDecl>(ND)) {
867     TemplateArgs = &Spec->getTemplateArgs();
868     return Spec->getSpecializedTemplate();
869   }
870 
871   return nullptr;
872 }
873 
mangleUnqualifiedName(const NamedDecl * ND,DeclarationName Name)874 void MicrosoftCXXNameMangler::mangleUnqualifiedName(const NamedDecl *ND,
875                                                     DeclarationName Name) {
876   //  <unqualified-name> ::= <operator-name>
877   //                     ::= <ctor-dtor-name>
878   //                     ::= <source-name>
879   //                     ::= <template-name>
880 
881   // Check if we have a template.
882   const TemplateArgumentList *TemplateArgs = nullptr;
883   if (const TemplateDecl *TD = isTemplate(ND, TemplateArgs)) {
884     // Function templates aren't considered for name back referencing.  This
885     // makes sense since function templates aren't likely to occur multiple
886     // times in a symbol.
887     if (isa<FunctionTemplateDecl>(TD)) {
888       mangleTemplateInstantiationName(TD, *TemplateArgs);
889       Out << '@';
890       return;
891     }
892 
893     // Here comes the tricky thing: if we need to mangle something like
894     //   void foo(A::X<Y>, B::X<Y>),
895     // the X<Y> part is aliased. However, if you need to mangle
896     //   void foo(A::X<A::Y>, A::X<B::Y>),
897     // the A::X<> part is not aliased.
898     // That is, from the mangler's perspective we have a structure like this:
899     //   namespace[s] -> type[ -> template-parameters]
900     // but from the Clang perspective we have
901     //   type [ -> template-parameters]
902     //      \-> namespace[s]
903     // What we do is we create a new mangler, mangle the same type (without
904     // a namespace suffix) to a string using the extra mangler and then use
905     // the mangled type name as a key to check the mangling of different types
906     // for aliasing.
907 
908     // It's important to key cache reads off ND, not TD -- the same TD can
909     // be used with different TemplateArgs, but ND uniquely identifies
910     // TD / TemplateArg pairs.
911     ArgBackRefMap::iterator Found = TemplateArgBackReferences.find(ND);
912     if (Found == TemplateArgBackReferences.end()) {
913 
914       TemplateArgStringMap::iterator Found = TemplateArgStrings.find(ND);
915       if (Found == TemplateArgStrings.end()) {
916         // Mangle full template name into temporary buffer.
917         llvm::SmallString<64> TemplateMangling;
918         llvm::raw_svector_ostream Stream(TemplateMangling);
919         MicrosoftCXXNameMangler Extra(Context, Stream);
920         Extra.mangleTemplateInstantiationName(TD, *TemplateArgs);
921 
922         // Use the string backref vector to possibly get a back reference.
923         mangleSourceName(TemplateMangling);
924 
925         // Memoize back reference for this type if one exist, else memoize
926         // the mangling itself.
927         BackRefVec::iterator StringFound =
928             llvm::find(NameBackReferences, TemplateMangling);
929         if (StringFound != NameBackReferences.end()) {
930           TemplateArgBackReferences[ND] =
931               StringFound - NameBackReferences.begin();
932         } else {
933           TemplateArgStrings[ND] =
934               TemplateArgStringStorage.save(TemplateMangling.str());
935         }
936       } else {
937         Out << Found->second << '@'; // Outputs a StringRef.
938       }
939     } else {
940       Out << Found->second; // Outputs a back reference (an int).
941     }
942     return;
943   }
944 
945   switch (Name.getNameKind()) {
946     case DeclarationName::Identifier: {
947       if (const IdentifierInfo *II = Name.getAsIdentifierInfo()) {
948         mangleSourceName(II->getName());
949         break;
950       }
951 
952       // Otherwise, an anonymous entity.  We must have a declaration.
953       assert(ND && "mangling empty name without declaration");
954 
955       if (const NamespaceDecl *NS = dyn_cast<NamespaceDecl>(ND)) {
956         if (NS->isAnonymousNamespace()) {
957           Out << "?A0x" << Context.getAnonymousNamespaceHash() << '@';
958           break;
959         }
960       }
961 
962       if (const DecompositionDecl *DD = dyn_cast<DecompositionDecl>(ND)) {
963         // Decomposition declarations are considered anonymous, and get
964         // numbered with a $S prefix.
965         llvm::SmallString<64> Name("$S");
966         // Get a unique id for the anonymous struct.
967         Name += llvm::utostr(Context.getAnonymousStructId(DD) + 1);
968         mangleSourceName(Name);
969         break;
970       }
971 
972       if (const VarDecl *VD = dyn_cast<VarDecl>(ND)) {
973         // We must have an anonymous union or struct declaration.
974         const CXXRecordDecl *RD = VD->getType()->getAsCXXRecordDecl();
975         assert(RD && "expected variable decl to have a record type");
976         // Anonymous types with no tag or typedef get the name of their
977         // declarator mangled in.  If they have no declarator, number them with
978         // a $S prefix.
979         llvm::SmallString<64> Name("$S");
980         // Get a unique id for the anonymous struct.
981         Name += llvm::utostr(Context.getAnonymousStructId(RD) + 1);
982         mangleSourceName(Name.str());
983         break;
984       }
985 
986       if (const MSGuidDecl *GD = dyn_cast<MSGuidDecl>(ND)) {
987         // Mangle a GUID object as if it were a variable with the corresponding
988         // mangled name.
989         SmallString<sizeof("_GUID_12345678_1234_1234_1234_1234567890ab")> GUID;
990         llvm::raw_svector_ostream GUIDOS(GUID);
991         Context.mangleMSGuidDecl(GD, GUIDOS);
992         mangleSourceName(GUID);
993         break;
994       }
995 
996       if (const auto *TPO = dyn_cast<TemplateParamObjectDecl>(ND)) {
997         Out << "?__N";
998         mangleTemplateArgValue(TPO->getType().getUnqualifiedType(),
999                                TPO->getValue());
1000         break;
1001       }
1002 
1003       // We must have an anonymous struct.
1004       const TagDecl *TD = cast<TagDecl>(ND);
1005       if (const TypedefNameDecl *D = TD->getTypedefNameForAnonDecl()) {
1006         assert(TD->getDeclContext() == D->getDeclContext() &&
1007                "Typedef should not be in another decl context!");
1008         assert(D->getDeclName().getAsIdentifierInfo() &&
1009                "Typedef was not named!");
1010         mangleSourceName(D->getDeclName().getAsIdentifierInfo()->getName());
1011         break;
1012       }
1013 
1014       if (const CXXRecordDecl *Record = dyn_cast<CXXRecordDecl>(TD)) {
1015         if (Record->isLambda()) {
1016           llvm::SmallString<10> Name("<lambda_");
1017 
1018           Decl *LambdaContextDecl = Record->getLambdaContextDecl();
1019           unsigned LambdaManglingNumber = Record->getLambdaManglingNumber();
1020           unsigned LambdaId;
1021           const ParmVarDecl *Parm =
1022               dyn_cast_or_null<ParmVarDecl>(LambdaContextDecl);
1023           const FunctionDecl *Func =
1024               Parm ? dyn_cast<FunctionDecl>(Parm->getDeclContext()) : nullptr;
1025 
1026           if (Func) {
1027             unsigned DefaultArgNo =
1028                 Func->getNumParams() - Parm->getFunctionScopeIndex();
1029             Name += llvm::utostr(DefaultArgNo);
1030             Name += "_";
1031           }
1032 
1033           if (LambdaManglingNumber)
1034             LambdaId = LambdaManglingNumber;
1035           else
1036             LambdaId = Context.getLambdaId(Record);
1037 
1038           Name += llvm::utostr(LambdaId);
1039           Name += ">";
1040 
1041           mangleSourceName(Name);
1042 
1043           // If the context is a variable or a class member and not a parameter,
1044           // it is encoded in a qualified name.
1045           if (LambdaManglingNumber && LambdaContextDecl) {
1046             if ((isa<VarDecl>(LambdaContextDecl) ||
1047                  isa<FieldDecl>(LambdaContextDecl)) &&
1048                 !isa<ParmVarDecl>(LambdaContextDecl)) {
1049               mangleUnqualifiedName(cast<NamedDecl>(LambdaContextDecl));
1050             }
1051           }
1052           break;
1053         }
1054       }
1055 
1056       llvm::SmallString<64> Name;
1057       if (DeclaratorDecl *DD =
1058               Context.getASTContext().getDeclaratorForUnnamedTagDecl(TD)) {
1059         // Anonymous types without a name for linkage purposes have their
1060         // declarator mangled in if they have one.
1061         Name += "<unnamed-type-";
1062         Name += DD->getName();
1063       } else if (TypedefNameDecl *TND =
1064                      Context.getASTContext().getTypedefNameForUnnamedTagDecl(
1065                          TD)) {
1066         // Anonymous types without a name for linkage purposes have their
1067         // associate typedef mangled in if they have one.
1068         Name += "<unnamed-type-";
1069         Name += TND->getName();
1070       } else if (isa<EnumDecl>(TD) &&
1071                  cast<EnumDecl>(TD)->enumerator_begin() !=
1072                      cast<EnumDecl>(TD)->enumerator_end()) {
1073         // Anonymous non-empty enums mangle in the first enumerator.
1074         auto *ED = cast<EnumDecl>(TD);
1075         Name += "<unnamed-enum-";
1076         Name += ED->enumerator_begin()->getName();
1077       } else {
1078         // Otherwise, number the types using a $S prefix.
1079         Name += "<unnamed-type-$S";
1080         Name += llvm::utostr(Context.getAnonymousStructId(TD) + 1);
1081       }
1082       Name += ">";
1083       mangleSourceName(Name.str());
1084       break;
1085     }
1086 
1087     case DeclarationName::ObjCZeroArgSelector:
1088     case DeclarationName::ObjCOneArgSelector:
1089     case DeclarationName::ObjCMultiArgSelector: {
1090       // This is reachable only when constructing an outlined SEH finally
1091       // block.  Nothing depends on this mangling and it's used only with
1092       // functinos with internal linkage.
1093       llvm::SmallString<64> Name;
1094       mangleSourceName(Name.str());
1095       break;
1096     }
1097 
1098     case DeclarationName::CXXConstructorName:
1099       if (isStructorDecl(ND)) {
1100         if (StructorType == Ctor_CopyingClosure) {
1101           Out << "?_O";
1102           return;
1103         }
1104         if (StructorType == Ctor_DefaultClosure) {
1105           Out << "?_F";
1106           return;
1107         }
1108       }
1109       Out << "?0";
1110       return;
1111 
1112     case DeclarationName::CXXDestructorName:
1113       if (isStructorDecl(ND))
1114         // If the named decl is the C++ destructor we're mangling,
1115         // use the type we were given.
1116         mangleCXXDtorType(static_cast<CXXDtorType>(StructorType));
1117       else
1118         // Otherwise, use the base destructor name. This is relevant if a
1119         // class with a destructor is declared within a destructor.
1120         mangleCXXDtorType(Dtor_Base);
1121       break;
1122 
1123     case DeclarationName::CXXConversionFunctionName:
1124       // <operator-name> ::= ?B # (cast)
1125       // The target type is encoded as the return type.
1126       Out << "?B";
1127       break;
1128 
1129     case DeclarationName::CXXOperatorName:
1130       mangleOperatorName(Name.getCXXOverloadedOperator(), ND->getLocation());
1131       break;
1132 
1133     case DeclarationName::CXXLiteralOperatorName: {
1134       Out << "?__K";
1135       mangleSourceName(Name.getCXXLiteralIdentifier()->getName());
1136       break;
1137     }
1138 
1139     case DeclarationName::CXXDeductionGuideName:
1140       llvm_unreachable("Can't mangle a deduction guide name!");
1141 
1142     case DeclarationName::CXXUsingDirective:
1143       llvm_unreachable("Can't mangle a using directive name!");
1144   }
1145 }
1146 
1147 // <postfix> ::= <unqualified-name> [<postfix>]
1148 //           ::= <substitution> [<postfix>]
mangleNestedName(const NamedDecl * ND)1149 void MicrosoftCXXNameMangler::mangleNestedName(const NamedDecl *ND) {
1150   const DeclContext *DC = getEffectiveDeclContext(ND);
1151   while (!DC->isTranslationUnit()) {
1152     if (isa<TagDecl>(ND) || isa<VarDecl>(ND)) {
1153       unsigned Disc;
1154       if (Context.getNextDiscriminator(ND, Disc)) {
1155         Out << '?';
1156         mangleNumber(Disc);
1157         Out << '?';
1158       }
1159     }
1160 
1161     if (const BlockDecl *BD = dyn_cast<BlockDecl>(DC)) {
1162       auto Discriminate =
1163           [](StringRef Name, const unsigned Discriminator,
1164              const unsigned ParameterDiscriminator) -> std::string {
1165         std::string Buffer;
1166         llvm::raw_string_ostream Stream(Buffer);
1167         Stream << Name;
1168         if (Discriminator)
1169           Stream << '_' << Discriminator;
1170         if (ParameterDiscriminator)
1171           Stream << '_' << ParameterDiscriminator;
1172         return Stream.str();
1173       };
1174 
1175       unsigned Discriminator = BD->getBlockManglingNumber();
1176       if (!Discriminator)
1177         Discriminator = Context.getBlockId(BD, /*Local=*/false);
1178 
1179       // Mangle the parameter position as a discriminator to deal with unnamed
1180       // parameters.  Rather than mangling the unqualified parameter name,
1181       // always use the position to give a uniform mangling.
1182       unsigned ParameterDiscriminator = 0;
1183       if (const auto *MC = BD->getBlockManglingContextDecl())
1184         if (const auto *P = dyn_cast<ParmVarDecl>(MC))
1185           if (const auto *F = dyn_cast<FunctionDecl>(P->getDeclContext()))
1186             ParameterDiscriminator =
1187                 F->getNumParams() - P->getFunctionScopeIndex();
1188 
1189       DC = getEffectiveDeclContext(BD);
1190 
1191       Out << '?';
1192       mangleSourceName(Discriminate("_block_invoke", Discriminator,
1193                                     ParameterDiscriminator));
1194       // If we have a block mangling context, encode that now.  This allows us
1195       // to discriminate between named static data initializers in the same
1196       // scope.  This is handled differently from parameters, which use
1197       // positions to discriminate between multiple instances.
1198       if (const auto *MC = BD->getBlockManglingContextDecl())
1199         if (!isa<ParmVarDecl>(MC))
1200           if (const auto *ND = dyn_cast<NamedDecl>(MC))
1201             mangleUnqualifiedName(ND);
1202       // MS ABI and Itanium manglings are in inverted scopes.  In the case of a
1203       // RecordDecl, mangle the entire scope hierarchy at this point rather than
1204       // just the unqualified name to get the ordering correct.
1205       if (const auto *RD = dyn_cast<RecordDecl>(DC))
1206         mangleName(RD);
1207       else
1208         Out << '@';
1209       // void __cdecl
1210       Out << "YAX";
1211       // struct __block_literal *
1212       Out << 'P';
1213       // __ptr64
1214       if (PointersAre64Bit)
1215         Out << 'E';
1216       Out << 'A';
1217       mangleArtificialTagType(TTK_Struct,
1218                              Discriminate("__block_literal", Discriminator,
1219                                           ParameterDiscriminator));
1220       Out << "@Z";
1221 
1222       // If the effective context was a Record, we have fully mangled the
1223       // qualified name and do not need to continue.
1224       if (isa<RecordDecl>(DC))
1225         break;
1226       continue;
1227     } else if (const ObjCMethodDecl *Method = dyn_cast<ObjCMethodDecl>(DC)) {
1228       mangleObjCMethodName(Method);
1229     } else if (isa<NamedDecl>(DC)) {
1230       ND = cast<NamedDecl>(DC);
1231       if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)) {
1232         mangle(FD, "?");
1233         break;
1234       } else {
1235         mangleUnqualifiedName(ND);
1236         // Lambdas in default arguments conceptually belong to the function the
1237         // parameter corresponds to.
1238         if (const auto *LDADC = getLambdaDefaultArgumentDeclContext(ND)) {
1239           DC = LDADC;
1240           continue;
1241         }
1242       }
1243     }
1244     DC = DC->getParent();
1245   }
1246 }
1247 
mangleCXXDtorType(CXXDtorType T)1248 void MicrosoftCXXNameMangler::mangleCXXDtorType(CXXDtorType T) {
1249   // Microsoft uses the names on the case labels for these dtor variants.  Clang
1250   // uses the Itanium terminology internally.  Everything in this ABI delegates
1251   // towards the base dtor.
1252   switch (T) {
1253   // <operator-name> ::= ?1  # destructor
1254   case Dtor_Base: Out << "?1"; return;
1255   // <operator-name> ::= ?_D # vbase destructor
1256   case Dtor_Complete: Out << "?_D"; return;
1257   // <operator-name> ::= ?_G # scalar deleting destructor
1258   case Dtor_Deleting: Out << "?_G"; return;
1259   // <operator-name> ::= ?_E # vector deleting destructor
1260   // FIXME: Add a vector deleting dtor type.  It goes in the vtable, so we need
1261   // it.
1262   case Dtor_Comdat:
1263     llvm_unreachable("not expecting a COMDAT");
1264   }
1265   llvm_unreachable("Unsupported dtor type?");
1266 }
1267 
mangleOperatorName(OverloadedOperatorKind OO,SourceLocation Loc)1268 void MicrosoftCXXNameMangler::mangleOperatorName(OverloadedOperatorKind OO,
1269                                                  SourceLocation Loc) {
1270   switch (OO) {
1271   //                     ?0 # constructor
1272   //                     ?1 # destructor
1273   // <operator-name> ::= ?2 # new
1274   case OO_New: Out << "?2"; break;
1275   // <operator-name> ::= ?3 # delete
1276   case OO_Delete: Out << "?3"; break;
1277   // <operator-name> ::= ?4 # =
1278   case OO_Equal: Out << "?4"; break;
1279   // <operator-name> ::= ?5 # >>
1280   case OO_GreaterGreater: Out << "?5"; break;
1281   // <operator-name> ::= ?6 # <<
1282   case OO_LessLess: Out << "?6"; break;
1283   // <operator-name> ::= ?7 # !
1284   case OO_Exclaim: Out << "?7"; break;
1285   // <operator-name> ::= ?8 # ==
1286   case OO_EqualEqual: Out << "?8"; break;
1287   // <operator-name> ::= ?9 # !=
1288   case OO_ExclaimEqual: Out << "?9"; break;
1289   // <operator-name> ::= ?A # []
1290   case OO_Subscript: Out << "?A"; break;
1291   //                     ?B # conversion
1292   // <operator-name> ::= ?C # ->
1293   case OO_Arrow: Out << "?C"; break;
1294   // <operator-name> ::= ?D # *
1295   case OO_Star: Out << "?D"; break;
1296   // <operator-name> ::= ?E # ++
1297   case OO_PlusPlus: Out << "?E"; break;
1298   // <operator-name> ::= ?F # --
1299   case OO_MinusMinus: Out << "?F"; break;
1300   // <operator-name> ::= ?G # -
1301   case OO_Minus: Out << "?G"; break;
1302   // <operator-name> ::= ?H # +
1303   case OO_Plus: Out << "?H"; break;
1304   // <operator-name> ::= ?I # &
1305   case OO_Amp: Out << "?I"; break;
1306   // <operator-name> ::= ?J # ->*
1307   case OO_ArrowStar: Out << "?J"; break;
1308   // <operator-name> ::= ?K # /
1309   case OO_Slash: Out << "?K"; break;
1310   // <operator-name> ::= ?L # %
1311   case OO_Percent: Out << "?L"; break;
1312   // <operator-name> ::= ?M # <
1313   case OO_Less: Out << "?M"; break;
1314   // <operator-name> ::= ?N # <=
1315   case OO_LessEqual: Out << "?N"; break;
1316   // <operator-name> ::= ?O # >
1317   case OO_Greater: Out << "?O"; break;
1318   // <operator-name> ::= ?P # >=
1319   case OO_GreaterEqual: Out << "?P"; break;
1320   // <operator-name> ::= ?Q # ,
1321   case OO_Comma: Out << "?Q"; break;
1322   // <operator-name> ::= ?R # ()
1323   case OO_Call: Out << "?R"; break;
1324   // <operator-name> ::= ?S # ~
1325   case OO_Tilde: Out << "?S"; break;
1326   // <operator-name> ::= ?T # ^
1327   case OO_Caret: Out << "?T"; break;
1328   // <operator-name> ::= ?U # |
1329   case OO_Pipe: Out << "?U"; break;
1330   // <operator-name> ::= ?V # &&
1331   case OO_AmpAmp: Out << "?V"; break;
1332   // <operator-name> ::= ?W # ||
1333   case OO_PipePipe: Out << "?W"; break;
1334   // <operator-name> ::= ?X # *=
1335   case OO_StarEqual: Out << "?X"; break;
1336   // <operator-name> ::= ?Y # +=
1337   case OO_PlusEqual: Out << "?Y"; break;
1338   // <operator-name> ::= ?Z # -=
1339   case OO_MinusEqual: Out << "?Z"; break;
1340   // <operator-name> ::= ?_0 # /=
1341   case OO_SlashEqual: Out << "?_0"; break;
1342   // <operator-name> ::= ?_1 # %=
1343   case OO_PercentEqual: Out << "?_1"; break;
1344   // <operator-name> ::= ?_2 # >>=
1345   case OO_GreaterGreaterEqual: Out << "?_2"; break;
1346   // <operator-name> ::= ?_3 # <<=
1347   case OO_LessLessEqual: Out << "?_3"; break;
1348   // <operator-name> ::= ?_4 # &=
1349   case OO_AmpEqual: Out << "?_4"; break;
1350   // <operator-name> ::= ?_5 # |=
1351   case OO_PipeEqual: Out << "?_5"; break;
1352   // <operator-name> ::= ?_6 # ^=
1353   case OO_CaretEqual: Out << "?_6"; break;
1354   //                     ?_7 # vftable
1355   //                     ?_8 # vbtable
1356   //                     ?_9 # vcall
1357   //                     ?_A # typeof
1358   //                     ?_B # local static guard
1359   //                     ?_C # string
1360   //                     ?_D # vbase destructor
1361   //                     ?_E # vector deleting destructor
1362   //                     ?_F # default constructor closure
1363   //                     ?_G # scalar deleting destructor
1364   //                     ?_H # vector constructor iterator
1365   //                     ?_I # vector destructor iterator
1366   //                     ?_J # vector vbase constructor iterator
1367   //                     ?_K # virtual displacement map
1368   //                     ?_L # eh vector constructor iterator
1369   //                     ?_M # eh vector destructor iterator
1370   //                     ?_N # eh vector vbase constructor iterator
1371   //                     ?_O # copy constructor closure
1372   //                     ?_P<name> # udt returning <name>
1373   //                     ?_Q # <unknown>
1374   //                     ?_R0 # RTTI Type Descriptor
1375   //                     ?_R1 # RTTI Base Class Descriptor at (a,b,c,d)
1376   //                     ?_R2 # RTTI Base Class Array
1377   //                     ?_R3 # RTTI Class Hierarchy Descriptor
1378   //                     ?_R4 # RTTI Complete Object Locator
1379   //                     ?_S # local vftable
1380   //                     ?_T # local vftable constructor closure
1381   // <operator-name> ::= ?_U # new[]
1382   case OO_Array_New: Out << "?_U"; break;
1383   // <operator-name> ::= ?_V # delete[]
1384   case OO_Array_Delete: Out << "?_V"; break;
1385   // <operator-name> ::= ?__L # co_await
1386   case OO_Coawait: Out << "?__L"; break;
1387   // <operator-name> ::= ?__M # <=>
1388   case OO_Spaceship: Out << "?__M"; break;
1389 
1390   case OO_Conditional: {
1391     DiagnosticsEngine &Diags = Context.getDiags();
1392     unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
1393       "cannot mangle this conditional operator yet");
1394     Diags.Report(Loc, DiagID);
1395     break;
1396   }
1397 
1398   case OO_None:
1399   case NUM_OVERLOADED_OPERATORS:
1400     llvm_unreachable("Not an overloaded operator");
1401   }
1402 }
1403 
mangleSourceName(StringRef Name)1404 void MicrosoftCXXNameMangler::mangleSourceName(StringRef Name) {
1405   // <source name> ::= <identifier> @
1406   BackRefVec::iterator Found = llvm::find(NameBackReferences, Name);
1407   if (Found == NameBackReferences.end()) {
1408     if (NameBackReferences.size() < 10)
1409       NameBackReferences.push_back(std::string(Name));
1410     Out << Name << '@';
1411   } else {
1412     Out << (Found - NameBackReferences.begin());
1413   }
1414 }
1415 
mangleObjCMethodName(const ObjCMethodDecl * MD)1416 void MicrosoftCXXNameMangler::mangleObjCMethodName(const ObjCMethodDecl *MD) {
1417   Context.mangleObjCMethodNameAsSourceName(MD, Out);
1418 }
1419 
mangleTemplateInstantiationName(const TemplateDecl * TD,const TemplateArgumentList & TemplateArgs)1420 void MicrosoftCXXNameMangler::mangleTemplateInstantiationName(
1421     const TemplateDecl *TD, const TemplateArgumentList &TemplateArgs) {
1422   // <template-name> ::= <unscoped-template-name> <template-args>
1423   //                 ::= <substitution>
1424   // Always start with the unqualified name.
1425 
1426   // Templates have their own context for back references.
1427   ArgBackRefMap OuterFunArgsContext;
1428   ArgBackRefMap OuterTemplateArgsContext;
1429   BackRefVec OuterTemplateContext;
1430   PassObjectSizeArgsSet OuterPassObjectSizeArgs;
1431   NameBackReferences.swap(OuterTemplateContext);
1432   FunArgBackReferences.swap(OuterFunArgsContext);
1433   TemplateArgBackReferences.swap(OuterTemplateArgsContext);
1434   PassObjectSizeArgs.swap(OuterPassObjectSizeArgs);
1435 
1436   mangleUnscopedTemplateName(TD);
1437   mangleTemplateArgs(TD, TemplateArgs);
1438 
1439   // Restore the previous back reference contexts.
1440   NameBackReferences.swap(OuterTemplateContext);
1441   FunArgBackReferences.swap(OuterFunArgsContext);
1442   TemplateArgBackReferences.swap(OuterTemplateArgsContext);
1443   PassObjectSizeArgs.swap(OuterPassObjectSizeArgs);
1444 }
1445 
1446 void
mangleUnscopedTemplateName(const TemplateDecl * TD)1447 MicrosoftCXXNameMangler::mangleUnscopedTemplateName(const TemplateDecl *TD) {
1448   // <unscoped-template-name> ::= ?$ <unqualified-name>
1449   Out << "?$";
1450   mangleUnqualifiedName(TD);
1451 }
1452 
mangleIntegerLiteral(const llvm::APSInt & Value,const NonTypeTemplateParmDecl * PD,QualType TemplateArgType)1453 void MicrosoftCXXNameMangler::mangleIntegerLiteral(
1454     const llvm::APSInt &Value, const NonTypeTemplateParmDecl *PD,
1455     QualType TemplateArgType) {
1456   // <integer-literal> ::= $0 <number>
1457   Out << "$";
1458 
1459   // Since MSVC 2019, add 'M[<type>]' after '$' for auto template parameter when
1460   // argument is integer.
1461   if (getASTContext().getLangOpts().isCompatibleWithMSVC(
1462           LangOptions::MSVC2019) &&
1463       PD && PD->getType()->getTypeClass() == Type::Auto &&
1464       !TemplateArgType.isNull()) {
1465     Out << "M";
1466     mangleType(TemplateArgType, SourceRange(), QMM_Drop);
1467   }
1468 
1469   Out << "0";
1470 
1471   mangleNumber(Value);
1472 }
1473 
mangleExpression(const Expr * E,const NonTypeTemplateParmDecl * PD)1474 void MicrosoftCXXNameMangler::mangleExpression(
1475     const Expr *E, const NonTypeTemplateParmDecl *PD) {
1476   // See if this is a constant expression.
1477   if (Optional<llvm::APSInt> Value =
1478           E->getIntegerConstantExpr(Context.getASTContext())) {
1479     mangleIntegerLiteral(*Value, PD, E->getType());
1480     return;
1481   }
1482 
1483   // As bad as this diagnostic is, it's better than crashing.
1484   DiagnosticsEngine &Diags = Context.getDiags();
1485   unsigned DiagID = Diags.getCustomDiagID(
1486       DiagnosticsEngine::Error, "cannot yet mangle expression type %0");
1487   Diags.Report(E->getExprLoc(), DiagID) << E->getStmtClassName()
1488                                         << E->getSourceRange();
1489 }
1490 
mangleTemplateArgs(const TemplateDecl * TD,const TemplateArgumentList & TemplateArgs)1491 void MicrosoftCXXNameMangler::mangleTemplateArgs(
1492     const TemplateDecl *TD, const TemplateArgumentList &TemplateArgs) {
1493   // <template-args> ::= <template-arg>+
1494   const TemplateParameterList *TPL = TD->getTemplateParameters();
1495   assert(TPL->size() == TemplateArgs.size() &&
1496          "size mismatch between args and parms!");
1497 
1498   for (size_t i = 0; i < TemplateArgs.size(); ++i) {
1499     const TemplateArgument &TA = TemplateArgs[i];
1500 
1501     // Separate consecutive packs by $$Z.
1502     if (i > 0 && TA.getKind() == TemplateArgument::Pack &&
1503         TemplateArgs[i - 1].getKind() == TemplateArgument::Pack)
1504       Out << "$$Z";
1505 
1506     mangleTemplateArg(TD, TA, TPL->getParam(i));
1507   }
1508 }
1509 
mangleTemplateArg(const TemplateDecl * TD,const TemplateArgument & TA,const NamedDecl * Parm)1510 void MicrosoftCXXNameMangler::mangleTemplateArg(const TemplateDecl *TD,
1511                                                 const TemplateArgument &TA,
1512                                                 const NamedDecl *Parm) {
1513   // <template-arg> ::= <type>
1514   //                ::= <integer-literal>
1515   //                ::= <member-data-pointer>
1516   //                ::= <member-function-pointer>
1517   //                ::= $ <constant-value>
1518   //                ::= <template-args>
1519   //
1520   // <constant-value> ::= 0 <number>                   # integer
1521   //                  ::= 1 <mangled-name>             # address of D
1522   //                  ::= 2 <type> <typed-constant-value>* @ # struct
1523   //                  ::= 3 <type> <constant-value>* @ # array
1524   //                  ::= 4 ???                        # string
1525   //                  ::= 5 <constant-value> @         # address of subobject
1526   //                  ::= 6 <constant-value> <unqualified-name> @ # a.b
1527   //                  ::= 7 <type> [<unqualified-name> <constant-value>] @
1528   //                      # union, with or without an active member
1529   //                  # pointer to member, symbolically
1530   //                  ::= 8 <class> <unqualified-name> @
1531   //                  ::= A <type> <non-negative integer>  # float
1532   //                  ::= B <type> <non-negative integer>  # double
1533   //                  ::= E <mangled-name>             # reference to D
1534   //                  # pointer to member, by component value
1535   //                  ::= F <number> <number>
1536   //                  ::= G <number> <number> <number>
1537   //                  ::= H <mangled-name> <number>
1538   //                  ::= I <mangled-name> <number> <number>
1539   //                  ::= J <mangled-name> <number> <number> <number>
1540   //
1541   // <typed-constant-value> ::= [<type>] <constant-value>
1542   //
1543   // The <type> appears to be included in a <typed-constant-value> only in the
1544   // '0', '1', '8', 'A', 'B', and 'E' cases.
1545 
1546   switch (TA.getKind()) {
1547   case TemplateArgument::Null:
1548     llvm_unreachable("Can't mangle null template arguments!");
1549   case TemplateArgument::TemplateExpansion:
1550     llvm_unreachable("Can't mangle template expansion arguments!");
1551   case TemplateArgument::Type: {
1552     QualType T = TA.getAsType();
1553     mangleType(T, SourceRange(), QMM_Escape);
1554     break;
1555   }
1556   case TemplateArgument::Declaration: {
1557     const NamedDecl *ND = TA.getAsDecl();
1558     if (isa<FieldDecl>(ND) || isa<IndirectFieldDecl>(ND)) {
1559       mangleMemberDataPointer(cast<CXXRecordDecl>(ND->getDeclContext())
1560                                   ->getMostRecentNonInjectedDecl(),
1561                               cast<ValueDecl>(ND));
1562     } else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)) {
1563       const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD);
1564       if (MD && MD->isInstance()) {
1565         mangleMemberFunctionPointer(
1566             MD->getParent()->getMostRecentNonInjectedDecl(), MD);
1567       } else {
1568         Out << "$1?";
1569         mangleName(FD);
1570         mangleFunctionEncoding(FD, /*ShouldMangle=*/true);
1571       }
1572     } else if (TA.getParamTypeForDecl()->isRecordType()) {
1573       Out << "$";
1574       auto *TPO = cast<TemplateParamObjectDecl>(ND);
1575       mangleTemplateArgValue(TPO->getType().getUnqualifiedType(),
1576                              TPO->getValue());
1577     } else {
1578       mangle(ND, TA.getParamTypeForDecl()->isReferenceType() ? "$E?" : "$1?");
1579     }
1580     break;
1581   }
1582   case TemplateArgument::Integral: {
1583     QualType T = TA.getIntegralType();
1584     mangleIntegerLiteral(TA.getAsIntegral(),
1585                          cast<NonTypeTemplateParmDecl>(Parm), T);
1586     break;
1587   }
1588   case TemplateArgument::NullPtr: {
1589     QualType T = TA.getNullPtrType();
1590     if (const MemberPointerType *MPT = T->getAs<MemberPointerType>()) {
1591       const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
1592       if (MPT->isMemberFunctionPointerType() &&
1593           !isa<FunctionTemplateDecl>(TD)) {
1594         mangleMemberFunctionPointer(RD, nullptr);
1595         return;
1596       }
1597       if (MPT->isMemberDataPointer()) {
1598         if (!isa<FunctionTemplateDecl>(TD)) {
1599           mangleMemberDataPointer(RD, nullptr);
1600           return;
1601         }
1602         // nullptr data pointers are always represented with a single field
1603         // which is initialized with either 0 or -1.  Why -1?  Well, we need to
1604         // distinguish the case where the data member is at offset zero in the
1605         // record.
1606         // However, we are free to use 0 *if* we would use multiple fields for
1607         // non-nullptr member pointers.
1608         if (!RD->nullFieldOffsetIsZero()) {
1609           mangleIntegerLiteral(llvm::APSInt::get(-1),
1610                                cast<NonTypeTemplateParmDecl>(Parm), T);
1611           return;
1612         }
1613       }
1614     }
1615     mangleIntegerLiteral(llvm::APSInt::getUnsigned(0),
1616                          cast<NonTypeTemplateParmDecl>(Parm), T);
1617     break;
1618   }
1619   case TemplateArgument::Expression:
1620     mangleExpression(TA.getAsExpr(), cast<NonTypeTemplateParmDecl>(Parm));
1621     break;
1622   case TemplateArgument::Pack: {
1623     ArrayRef<TemplateArgument> TemplateArgs = TA.getPackAsArray();
1624     if (TemplateArgs.empty()) {
1625       if (isa<TemplateTypeParmDecl>(Parm) ||
1626           isa<TemplateTemplateParmDecl>(Parm))
1627         // MSVC 2015 changed the mangling for empty expanded template packs,
1628         // use the old mangling for link compatibility for old versions.
1629         Out << (Context.getASTContext().getLangOpts().isCompatibleWithMSVC(
1630                     LangOptions::MSVC2015)
1631                     ? "$$V"
1632                     : "$$$V");
1633       else if (isa<NonTypeTemplateParmDecl>(Parm))
1634         Out << "$S";
1635       else
1636         llvm_unreachable("unexpected template parameter decl!");
1637     } else {
1638       for (const TemplateArgument &PA : TemplateArgs)
1639         mangleTemplateArg(TD, PA, Parm);
1640     }
1641     break;
1642   }
1643   case TemplateArgument::Template: {
1644     const NamedDecl *ND =
1645         TA.getAsTemplate().getAsTemplateDecl()->getTemplatedDecl();
1646     if (const auto *TD = dyn_cast<TagDecl>(ND)) {
1647       mangleType(TD);
1648     } else if (isa<TypeAliasDecl>(ND)) {
1649       Out << "$$Y";
1650       mangleName(ND);
1651     } else {
1652       llvm_unreachable("unexpected template template NamedDecl!");
1653     }
1654     break;
1655   }
1656   }
1657 }
1658 
mangleTemplateArgValue(QualType T,const APValue & V,bool WithScalarType)1659 void MicrosoftCXXNameMangler::mangleTemplateArgValue(QualType T,
1660                                                      const APValue &V,
1661                                                      bool WithScalarType) {
1662   switch (V.getKind()) {
1663   case APValue::None:
1664   case APValue::Indeterminate:
1665     // FIXME: MSVC doesn't allow this, so we can't be sure how it should be
1666     // mangled.
1667     if (WithScalarType)
1668       mangleType(T, SourceRange(), QMM_Escape);
1669     Out << '@';
1670     return;
1671 
1672   case APValue::Int:
1673     if (WithScalarType)
1674       mangleType(T, SourceRange(), QMM_Escape);
1675     Out << '0';
1676     mangleNumber(V.getInt());
1677     return;
1678 
1679   case APValue::Float:
1680     if (WithScalarType)
1681       mangleType(T, SourceRange(), QMM_Escape);
1682     mangleFloat(V.getFloat());
1683     return;
1684 
1685   case APValue::LValue: {
1686     if (WithScalarType)
1687       mangleType(T, SourceRange(), QMM_Escape);
1688 
1689     // We don't know how to mangle past-the-end pointers yet.
1690     if (V.isLValueOnePastTheEnd())
1691       break;
1692 
1693     APValue::LValueBase Base = V.getLValueBase();
1694     if (!V.hasLValuePath() || V.getLValuePath().empty()) {
1695       // Taking the address of a complete object has a special-case mangling.
1696       if (Base.isNull()) {
1697         // MSVC emits 0A@ for null pointers. Generalize this for arbitrary
1698         // integers cast to pointers.
1699         // FIXME: This mangles 0 cast to a pointer the same as a null pointer,
1700         // even in cases where the two are different values.
1701         Out << "0";
1702         mangleNumber(V.getLValueOffset().getQuantity());
1703       } else if (!V.hasLValuePath()) {
1704         // FIXME: This can only happen as an extension. Invent a mangling.
1705         break;
1706       } else if (auto *VD = Base.dyn_cast<const ValueDecl*>()) {
1707         Out << (T->isReferenceType() ? "E" : "1");
1708         mangle(VD);
1709       } else {
1710         break;
1711       }
1712     } else {
1713       unsigned NumAts = 0;
1714       if (T->isPointerType()) {
1715         Out << "5";
1716         ++NumAts;
1717       }
1718 
1719       QualType T = Base.getType();
1720       for (APValue::LValuePathEntry E : V.getLValuePath()) {
1721         // We don't know how to mangle array subscripting yet.
1722         if (T->isArrayType())
1723           goto mangling_unknown;
1724 
1725         const Decl *D = E.getAsBaseOrMember().getPointer();
1726         auto *FD = dyn_cast<FieldDecl>(D);
1727         // We don't know how to mangle derived-to-base conversions yet.
1728         if (!FD)
1729           goto mangling_unknown;
1730 
1731         Out << "6";
1732         ++NumAts;
1733         T = FD->getType();
1734       }
1735 
1736       auto *VD = Base.dyn_cast<const ValueDecl*>();
1737       if (!VD)
1738         break;
1739       Out << "E";
1740       mangle(VD);
1741 
1742       for (APValue::LValuePathEntry E : V.getLValuePath()) {
1743         const Decl *D = E.getAsBaseOrMember().getPointer();
1744         mangleUnqualifiedName(cast<FieldDecl>(D));
1745       }
1746       for (unsigned I = 0; I != NumAts; ++I)
1747         Out << '@';
1748     }
1749 
1750     return;
1751   }
1752 
1753   case APValue::MemberPointer: {
1754     if (WithScalarType)
1755       mangleType(T, SourceRange(), QMM_Escape);
1756 
1757     // FIXME: The below manglings don't include a conversion, so bail if there
1758     // would be one. MSVC mangles the (possibly converted) value of the
1759     // pointer-to-member object as if it were a struct, leading to collisions
1760     // in some cases.
1761     if (!V.getMemberPointerPath().empty())
1762       break;
1763 
1764     const CXXRecordDecl *RD =
1765         T->castAs<MemberPointerType>()->getMostRecentCXXRecordDecl();
1766     const ValueDecl *D = V.getMemberPointerDecl();
1767     if (T->isMemberDataPointerType())
1768       mangleMemberDataPointer(RD, D, "");
1769     else
1770       mangleMemberFunctionPointer(RD, cast_or_null<CXXMethodDecl>(D), "");
1771     return;
1772   }
1773 
1774   case APValue::Struct: {
1775     Out << '2';
1776     mangleType(T, SourceRange(), QMM_Escape);
1777     const CXXRecordDecl *RD = T->getAsCXXRecordDecl();
1778     assert(RD && "unexpected type for record value");
1779 
1780     unsigned BaseIndex = 0;
1781     for (const CXXBaseSpecifier &B : RD->bases())
1782       mangleTemplateArgValue(B.getType(), V.getStructBase(BaseIndex++));
1783     for (const FieldDecl *FD : RD->fields())
1784       if (!FD->isUnnamedBitfield())
1785         mangleTemplateArgValue(FD->getType(),
1786                                V.getStructField(FD->getFieldIndex()),
1787                                /*WithScalarType*/ true);
1788     Out << '@';
1789     return;
1790   }
1791 
1792   case APValue::Union:
1793     Out << '7';
1794     mangleType(T, SourceRange(), QMM_Escape);
1795     if (const FieldDecl *FD = V.getUnionField()) {
1796       mangleUnqualifiedName(FD);
1797       mangleTemplateArgValue(FD->getType(), V.getUnionValue());
1798     }
1799     Out << '@';
1800     return;
1801 
1802   case APValue::ComplexInt:
1803     // We mangle complex types as structs, so mangle the value as a struct too.
1804     Out << '2';
1805     mangleType(T, SourceRange(), QMM_Escape);
1806     Out << '0';
1807     mangleNumber(V.getComplexIntReal());
1808     Out << '0';
1809     mangleNumber(V.getComplexIntImag());
1810     Out << '@';
1811     return;
1812 
1813   case APValue::ComplexFloat:
1814     Out << '2';
1815     mangleType(T, SourceRange(), QMM_Escape);
1816     mangleFloat(V.getComplexFloatReal());
1817     mangleFloat(V.getComplexFloatImag());
1818     Out << '@';
1819     return;
1820 
1821   case APValue::Array: {
1822     Out << '3';
1823     QualType ElemT = getASTContext().getAsArrayType(T)->getElementType();
1824     mangleType(ElemT, SourceRange(), QMM_Escape);
1825     for (unsigned I = 0, N = V.getArraySize(); I != N; ++I) {
1826       const APValue &ElemV = I < V.getArrayInitializedElts()
1827                                  ? V.getArrayInitializedElt(I)
1828                                  : V.getArrayFiller();
1829       mangleTemplateArgValue(ElemT, ElemV);
1830       Out << '@';
1831     }
1832     Out << '@';
1833     return;
1834   }
1835 
1836   case APValue::Vector: {
1837     // __m128 is mangled as a struct containing an array. We follow this
1838     // approach for all vector types.
1839     Out << '2';
1840     mangleType(T, SourceRange(), QMM_Escape);
1841     Out << '3';
1842     QualType ElemT = T->castAs<VectorType>()->getElementType();
1843     mangleType(ElemT, SourceRange(), QMM_Escape);
1844     for (unsigned I = 0, N = V.getVectorLength(); I != N; ++I) {
1845       const APValue &ElemV = V.getVectorElt(I);
1846       mangleTemplateArgValue(ElemT, ElemV);
1847       Out << '@';
1848     }
1849     Out << "@@";
1850     return;
1851   }
1852 
1853   case APValue::AddrLabelDiff:
1854   case APValue::FixedPoint:
1855     break;
1856   }
1857 
1858 mangling_unknown:
1859   DiagnosticsEngine &Diags = Context.getDiags();
1860   unsigned DiagID = Diags.getCustomDiagID(
1861       DiagnosticsEngine::Error, "cannot mangle this template argument yet");
1862   Diags.Report(DiagID);
1863 }
1864 
mangleObjCProtocol(const ObjCProtocolDecl * PD)1865 void MicrosoftCXXNameMangler::mangleObjCProtocol(const ObjCProtocolDecl *PD) {
1866   llvm::SmallString<64> TemplateMangling;
1867   llvm::raw_svector_ostream Stream(TemplateMangling);
1868   MicrosoftCXXNameMangler Extra(Context, Stream);
1869 
1870   Stream << "?$";
1871   Extra.mangleSourceName("Protocol");
1872   Extra.mangleArtificialTagType(TTK_Struct, PD->getName());
1873 
1874   mangleArtificialTagType(TTK_Struct, TemplateMangling, {"__ObjC"});
1875 }
1876 
mangleObjCLifetime(const QualType Type,Qualifiers Quals,SourceRange Range)1877 void MicrosoftCXXNameMangler::mangleObjCLifetime(const QualType Type,
1878                                                  Qualifiers Quals,
1879                                                  SourceRange Range) {
1880   llvm::SmallString<64> TemplateMangling;
1881   llvm::raw_svector_ostream Stream(TemplateMangling);
1882   MicrosoftCXXNameMangler Extra(Context, Stream);
1883 
1884   Stream << "?$";
1885   switch (Quals.getObjCLifetime()) {
1886   case Qualifiers::OCL_None:
1887   case Qualifiers::OCL_ExplicitNone:
1888     break;
1889   case Qualifiers::OCL_Autoreleasing:
1890     Extra.mangleSourceName("Autoreleasing");
1891     break;
1892   case Qualifiers::OCL_Strong:
1893     Extra.mangleSourceName("Strong");
1894     break;
1895   case Qualifiers::OCL_Weak:
1896     Extra.mangleSourceName("Weak");
1897     break;
1898   }
1899   Extra.manglePointerCVQualifiers(Quals);
1900   Extra.manglePointerExtQualifiers(Quals, Type);
1901   Extra.mangleType(Type, Range);
1902 
1903   mangleArtificialTagType(TTK_Struct, TemplateMangling, {"__ObjC"});
1904 }
1905 
mangleObjCKindOfType(const ObjCObjectType * T,Qualifiers Quals,SourceRange Range)1906 void MicrosoftCXXNameMangler::mangleObjCKindOfType(const ObjCObjectType *T,
1907                                                    Qualifiers Quals,
1908                                                    SourceRange Range) {
1909   llvm::SmallString<64> TemplateMangling;
1910   llvm::raw_svector_ostream Stream(TemplateMangling);
1911   MicrosoftCXXNameMangler Extra(Context, Stream);
1912 
1913   Stream << "?$";
1914   Extra.mangleSourceName("KindOf");
1915   Extra.mangleType(QualType(T, 0)
1916                        .stripObjCKindOfType(getASTContext())
1917                        ->getAs<ObjCObjectType>(),
1918                    Quals, Range);
1919 
1920   mangleArtificialTagType(TTK_Struct, TemplateMangling, {"__ObjC"});
1921 }
1922 
mangleQualifiers(Qualifiers Quals,bool IsMember)1923 void MicrosoftCXXNameMangler::mangleQualifiers(Qualifiers Quals,
1924                                                bool IsMember) {
1925   // <cvr-qualifiers> ::= [E] [F] [I] <base-cvr-qualifiers>
1926   // 'E' means __ptr64 (32-bit only); 'F' means __unaligned (32/64-bit only);
1927   // 'I' means __restrict (32/64-bit).
1928   // Note that the MSVC __restrict keyword isn't the same as the C99 restrict
1929   // keyword!
1930   // <base-cvr-qualifiers> ::= A  # near
1931   //                       ::= B  # near const
1932   //                       ::= C  # near volatile
1933   //                       ::= D  # near const volatile
1934   //                       ::= E  # far (16-bit)
1935   //                       ::= F  # far const (16-bit)
1936   //                       ::= G  # far volatile (16-bit)
1937   //                       ::= H  # far const volatile (16-bit)
1938   //                       ::= I  # huge (16-bit)
1939   //                       ::= J  # huge const (16-bit)
1940   //                       ::= K  # huge volatile (16-bit)
1941   //                       ::= L  # huge const volatile (16-bit)
1942   //                       ::= M <basis> # based
1943   //                       ::= N <basis> # based const
1944   //                       ::= O <basis> # based volatile
1945   //                       ::= P <basis> # based const volatile
1946   //                       ::= Q  # near member
1947   //                       ::= R  # near const member
1948   //                       ::= S  # near volatile member
1949   //                       ::= T  # near const volatile member
1950   //                       ::= U  # far member (16-bit)
1951   //                       ::= V  # far const member (16-bit)
1952   //                       ::= W  # far volatile member (16-bit)
1953   //                       ::= X  # far const volatile member (16-bit)
1954   //                       ::= Y  # huge member (16-bit)
1955   //                       ::= Z  # huge const member (16-bit)
1956   //                       ::= 0  # huge volatile member (16-bit)
1957   //                       ::= 1  # huge const volatile member (16-bit)
1958   //                       ::= 2 <basis> # based member
1959   //                       ::= 3 <basis> # based const member
1960   //                       ::= 4 <basis> # based volatile member
1961   //                       ::= 5 <basis> # based const volatile member
1962   //                       ::= 6  # near function (pointers only)
1963   //                       ::= 7  # far function (pointers only)
1964   //                       ::= 8  # near method (pointers only)
1965   //                       ::= 9  # far method (pointers only)
1966   //                       ::= _A <basis> # based function (pointers only)
1967   //                       ::= _B <basis> # based function (far?) (pointers only)
1968   //                       ::= _C <basis> # based method (pointers only)
1969   //                       ::= _D <basis> # based method (far?) (pointers only)
1970   //                       ::= _E # block (Clang)
1971   // <basis> ::= 0 # __based(void)
1972   //         ::= 1 # __based(segment)?
1973   //         ::= 2 <name> # __based(name)
1974   //         ::= 3 # ?
1975   //         ::= 4 # ?
1976   //         ::= 5 # not really based
1977   bool HasConst = Quals.hasConst(),
1978        HasVolatile = Quals.hasVolatile();
1979 
1980   if (!IsMember) {
1981     if (HasConst && HasVolatile) {
1982       Out << 'D';
1983     } else if (HasVolatile) {
1984       Out << 'C';
1985     } else if (HasConst) {
1986       Out << 'B';
1987     } else {
1988       Out << 'A';
1989     }
1990   } else {
1991     if (HasConst && HasVolatile) {
1992       Out << 'T';
1993     } else if (HasVolatile) {
1994       Out << 'S';
1995     } else if (HasConst) {
1996       Out << 'R';
1997     } else {
1998       Out << 'Q';
1999     }
2000   }
2001 
2002   // FIXME: For now, just drop all extension qualifiers on the floor.
2003 }
2004 
2005 void
mangleRefQualifier(RefQualifierKind RefQualifier)2006 MicrosoftCXXNameMangler::mangleRefQualifier(RefQualifierKind RefQualifier) {
2007   // <ref-qualifier> ::= G                # lvalue reference
2008   //                 ::= H                # rvalue-reference
2009   switch (RefQualifier) {
2010   case RQ_None:
2011     break;
2012 
2013   case RQ_LValue:
2014     Out << 'G';
2015     break;
2016 
2017   case RQ_RValue:
2018     Out << 'H';
2019     break;
2020   }
2021 }
2022 
manglePointerExtQualifiers(Qualifiers Quals,QualType PointeeType)2023 void MicrosoftCXXNameMangler::manglePointerExtQualifiers(Qualifiers Quals,
2024                                                          QualType PointeeType) {
2025   // Check if this is a default 64-bit pointer or has __ptr64 qualifier.
2026   bool is64Bit = PointeeType.isNull() ? PointersAre64Bit :
2027       is64BitPointer(PointeeType.getQualifiers());
2028   if (is64Bit && (PointeeType.isNull() || !PointeeType->isFunctionType()))
2029     Out << 'E';
2030 
2031   if (Quals.hasRestrict())
2032     Out << 'I';
2033 
2034   if (Quals.hasUnaligned() ||
2035       (!PointeeType.isNull() && PointeeType.getLocalQualifiers().hasUnaligned()))
2036     Out << 'F';
2037 }
2038 
manglePointerCVQualifiers(Qualifiers Quals)2039 void MicrosoftCXXNameMangler::manglePointerCVQualifiers(Qualifiers Quals) {
2040   // <pointer-cv-qualifiers> ::= P  # no qualifiers
2041   //                         ::= Q  # const
2042   //                         ::= R  # volatile
2043   //                         ::= S  # const volatile
2044   bool HasConst = Quals.hasConst(),
2045        HasVolatile = Quals.hasVolatile();
2046 
2047   if (HasConst && HasVolatile) {
2048     Out << 'S';
2049   } else if (HasVolatile) {
2050     Out << 'R';
2051   } else if (HasConst) {
2052     Out << 'Q';
2053   } else {
2054     Out << 'P';
2055   }
2056 }
2057 
mangleFunctionArgumentType(QualType T,SourceRange Range)2058 void MicrosoftCXXNameMangler::mangleFunctionArgumentType(QualType T,
2059                                                          SourceRange Range) {
2060   // MSVC will backreference two canonically equivalent types that have slightly
2061   // different manglings when mangled alone.
2062 
2063   // Decayed types do not match up with non-decayed versions of the same type.
2064   //
2065   // e.g.
2066   // void (*x)(void) will not form a backreference with void x(void)
2067   void *TypePtr;
2068   if (const auto *DT = T->getAs<DecayedType>()) {
2069     QualType OriginalType = DT->getOriginalType();
2070     // All decayed ArrayTypes should be treated identically; as-if they were
2071     // a decayed IncompleteArrayType.
2072     if (const auto *AT = getASTContext().getAsArrayType(OriginalType))
2073       OriginalType = getASTContext().getIncompleteArrayType(
2074           AT->getElementType(), AT->getSizeModifier(),
2075           AT->getIndexTypeCVRQualifiers());
2076 
2077     TypePtr = OriginalType.getCanonicalType().getAsOpaquePtr();
2078     // If the original parameter was textually written as an array,
2079     // instead treat the decayed parameter like it's const.
2080     //
2081     // e.g.
2082     // int [] -> int * const
2083     if (OriginalType->isArrayType())
2084       T = T.withConst();
2085   } else {
2086     TypePtr = T.getCanonicalType().getAsOpaquePtr();
2087   }
2088 
2089   ArgBackRefMap::iterator Found = FunArgBackReferences.find(TypePtr);
2090 
2091   if (Found == FunArgBackReferences.end()) {
2092     size_t OutSizeBefore = Out.tell();
2093 
2094     mangleType(T, Range, QMM_Drop);
2095 
2096     // See if it's worth creating a back reference.
2097     // Only types longer than 1 character are considered
2098     // and only 10 back references slots are available:
2099     bool LongerThanOneChar = (Out.tell() - OutSizeBefore > 1);
2100     if (LongerThanOneChar && FunArgBackReferences.size() < 10) {
2101       size_t Size = FunArgBackReferences.size();
2102       FunArgBackReferences[TypePtr] = Size;
2103     }
2104   } else {
2105     Out << Found->second;
2106   }
2107 }
2108 
manglePassObjectSizeArg(const PassObjectSizeAttr * POSA)2109 void MicrosoftCXXNameMangler::manglePassObjectSizeArg(
2110     const PassObjectSizeAttr *POSA) {
2111   int Type = POSA->getType();
2112   bool Dynamic = POSA->isDynamic();
2113 
2114   auto Iter = PassObjectSizeArgs.insert({Type, Dynamic}).first;
2115   auto *TypePtr = (const void *)&*Iter;
2116   ArgBackRefMap::iterator Found = FunArgBackReferences.find(TypePtr);
2117 
2118   if (Found == FunArgBackReferences.end()) {
2119     std::string Name =
2120         Dynamic ? "__pass_dynamic_object_size" : "__pass_object_size";
2121     mangleArtificialTagType(TTK_Enum, Name + llvm::utostr(Type), {"__clang"});
2122 
2123     if (FunArgBackReferences.size() < 10) {
2124       size_t Size = FunArgBackReferences.size();
2125       FunArgBackReferences[TypePtr] = Size;
2126     }
2127   } else {
2128     Out << Found->second;
2129   }
2130 }
2131 
mangleAddressSpaceType(QualType T,Qualifiers Quals,SourceRange Range)2132 void MicrosoftCXXNameMangler::mangleAddressSpaceType(QualType T,
2133                                                      Qualifiers Quals,
2134                                                      SourceRange Range) {
2135   // Address space is mangled as an unqualified templated type in the __clang
2136   // namespace. The demangled version of this is:
2137   // In the case of a language specific address space:
2138   // __clang::struct _AS[language_addr_space]<Type>
2139   // where:
2140   //  <language_addr_space> ::= <OpenCL-addrspace> | <CUDA-addrspace>
2141   //    <OpenCL-addrspace> ::= "CL" [ "global" | "local" | "constant" |
2142   //                                "private"| "generic" | "device" | "host" ]
2143   //    <CUDA-addrspace> ::= "CU" [ "device" | "constant" | "shared" ]
2144   //    Note that the above were chosen to match the Itanium mangling for this.
2145   //
2146   // In the case of a non-language specific address space:
2147   //  __clang::struct _AS<TargetAS, Type>
2148   assert(Quals.hasAddressSpace() && "Not valid without address space");
2149   llvm::SmallString<32> ASMangling;
2150   llvm::raw_svector_ostream Stream(ASMangling);
2151   MicrosoftCXXNameMangler Extra(Context, Stream);
2152   Stream << "?$";
2153 
2154   LangAS AS = Quals.getAddressSpace();
2155   if (Context.getASTContext().addressSpaceMapManglingFor(AS)) {
2156     unsigned TargetAS = Context.getASTContext().getTargetAddressSpace(AS);
2157     Extra.mangleSourceName("_AS");
2158     Extra.mangleIntegerLiteral(llvm::APSInt::getUnsigned(TargetAS));
2159   } else {
2160     switch (AS) {
2161     default:
2162       llvm_unreachable("Not a language specific address space");
2163     case LangAS::opencl_global:
2164       Extra.mangleSourceName("_ASCLglobal");
2165       break;
2166     case LangAS::opencl_global_device:
2167       Extra.mangleSourceName("_ASCLdevice");
2168       break;
2169     case LangAS::opencl_global_host:
2170       Extra.mangleSourceName("_ASCLhost");
2171       break;
2172     case LangAS::opencl_local:
2173       Extra.mangleSourceName("_ASCLlocal");
2174       break;
2175     case LangAS::opencl_constant:
2176       Extra.mangleSourceName("_ASCLconstant");
2177       break;
2178     case LangAS::opencl_private:
2179       Extra.mangleSourceName("_ASCLprivate");
2180       break;
2181     case LangAS::opencl_generic:
2182       Extra.mangleSourceName("_ASCLgeneric");
2183       break;
2184     case LangAS::cuda_device:
2185       Extra.mangleSourceName("_ASCUdevice");
2186       break;
2187     case LangAS::cuda_constant:
2188       Extra.mangleSourceName("_ASCUconstant");
2189       break;
2190     case LangAS::cuda_shared:
2191       Extra.mangleSourceName("_ASCUshared");
2192       break;
2193     case LangAS::ptr32_sptr:
2194     case LangAS::ptr32_uptr:
2195     case LangAS::ptr64:
2196       llvm_unreachable("don't mangle ptr address spaces with _AS");
2197     }
2198   }
2199 
2200   Extra.mangleType(T, Range, QMM_Escape);
2201   mangleQualifiers(Qualifiers(), false);
2202   mangleArtificialTagType(TTK_Struct, ASMangling, {"__clang"});
2203 }
2204 
mangleType(QualType T,SourceRange Range,QualifierMangleMode QMM)2205 void MicrosoftCXXNameMangler::mangleType(QualType T, SourceRange Range,
2206                                          QualifierMangleMode QMM) {
2207   // Don't use the canonical types.  MSVC includes things like 'const' on
2208   // pointer arguments to function pointers that canonicalization strips away.
2209   T = T.getDesugaredType(getASTContext());
2210   Qualifiers Quals = T.getLocalQualifiers();
2211 
2212   if (const ArrayType *AT = getASTContext().getAsArrayType(T)) {
2213     // If there were any Quals, getAsArrayType() pushed them onto the array
2214     // element type.
2215     if (QMM == QMM_Mangle)
2216       Out << 'A';
2217     else if (QMM == QMM_Escape || QMM == QMM_Result)
2218       Out << "$$B";
2219     mangleArrayType(AT);
2220     return;
2221   }
2222 
2223   bool IsPointer = T->isAnyPointerType() || T->isMemberPointerType() ||
2224                    T->isReferenceType() || T->isBlockPointerType();
2225 
2226   switch (QMM) {
2227   case QMM_Drop:
2228     if (Quals.hasObjCLifetime())
2229       Quals = Quals.withoutObjCLifetime();
2230     break;
2231   case QMM_Mangle:
2232     if (const FunctionType *FT = dyn_cast<FunctionType>(T)) {
2233       Out << '6';
2234       mangleFunctionType(FT);
2235       return;
2236     }
2237     mangleQualifiers(Quals, false);
2238     break;
2239   case QMM_Escape:
2240     if (!IsPointer && Quals) {
2241       Out << "$$C";
2242       mangleQualifiers(Quals, false);
2243     }
2244     break;
2245   case QMM_Result:
2246     // Presence of __unaligned qualifier shouldn't affect mangling here.
2247     Quals.removeUnaligned();
2248     if (Quals.hasObjCLifetime())
2249       Quals = Quals.withoutObjCLifetime();
2250     if ((!IsPointer && Quals) || isa<TagType>(T) || isArtificialTagType(T)) {
2251       Out << '?';
2252       mangleQualifiers(Quals, false);
2253     }
2254     break;
2255   }
2256 
2257   const Type *ty = T.getTypePtr();
2258 
2259   switch (ty->getTypeClass()) {
2260 #define ABSTRACT_TYPE(CLASS, PARENT)
2261 #define NON_CANONICAL_TYPE(CLASS, PARENT) \
2262   case Type::CLASS: \
2263     llvm_unreachable("can't mangle non-canonical type " #CLASS "Type"); \
2264     return;
2265 #define TYPE(CLASS, PARENT) \
2266   case Type::CLASS: \
2267     mangleType(cast<CLASS##Type>(ty), Quals, Range); \
2268     break;
2269 #include "clang/AST/TypeNodes.inc"
2270 #undef ABSTRACT_TYPE
2271 #undef NON_CANONICAL_TYPE
2272 #undef TYPE
2273   }
2274 }
2275 
mangleType(const BuiltinType * T,Qualifiers,SourceRange Range)2276 void MicrosoftCXXNameMangler::mangleType(const BuiltinType *T, Qualifiers,
2277                                          SourceRange Range) {
2278   //  <type>         ::= <builtin-type>
2279   //  <builtin-type> ::= X  # void
2280   //                 ::= C  # signed char
2281   //                 ::= D  # char
2282   //                 ::= E  # unsigned char
2283   //                 ::= F  # short
2284   //                 ::= G  # unsigned short (or wchar_t if it's not a builtin)
2285   //                 ::= H  # int
2286   //                 ::= I  # unsigned int
2287   //                 ::= J  # long
2288   //                 ::= K  # unsigned long
2289   //                     L  # <none>
2290   //                 ::= M  # float
2291   //                 ::= N  # double
2292   //                 ::= O  # long double (__float80 is mangled differently)
2293   //                 ::= _J # long long, __int64
2294   //                 ::= _K # unsigned long long, __int64
2295   //                 ::= _L # __int128
2296   //                 ::= _M # unsigned __int128
2297   //                 ::= _N # bool
2298   //                     _O # <array in parameter>
2299   //                 ::= _Q # char8_t
2300   //                 ::= _S # char16_t
2301   //                 ::= _T # __float80 (Intel)
2302   //                 ::= _U # char32_t
2303   //                 ::= _W # wchar_t
2304   //                 ::= _Z # __float80 (Digital Mars)
2305   switch (T->getKind()) {
2306   case BuiltinType::Void:
2307     Out << 'X';
2308     break;
2309   case BuiltinType::SChar:
2310     Out << 'C';
2311     break;
2312   case BuiltinType::Char_U:
2313   case BuiltinType::Char_S:
2314     Out << 'D';
2315     break;
2316   case BuiltinType::UChar:
2317     Out << 'E';
2318     break;
2319   case BuiltinType::Short:
2320     Out << 'F';
2321     break;
2322   case BuiltinType::UShort:
2323     Out << 'G';
2324     break;
2325   case BuiltinType::Int:
2326     Out << 'H';
2327     break;
2328   case BuiltinType::UInt:
2329     Out << 'I';
2330     break;
2331   case BuiltinType::Long:
2332     Out << 'J';
2333     break;
2334   case BuiltinType::ULong:
2335     Out << 'K';
2336     break;
2337   case BuiltinType::Float:
2338     Out << 'M';
2339     break;
2340   case BuiltinType::Double:
2341     Out << 'N';
2342     break;
2343   // TODO: Determine size and mangle accordingly
2344   case BuiltinType::LongDouble:
2345     Out << 'O';
2346     break;
2347   case BuiltinType::LongLong:
2348     Out << "_J";
2349     break;
2350   case BuiltinType::ULongLong:
2351     Out << "_K";
2352     break;
2353   case BuiltinType::Int128:
2354     Out << "_L";
2355     break;
2356   case BuiltinType::UInt128:
2357     Out << "_M";
2358     break;
2359   case BuiltinType::Bool:
2360     Out << "_N";
2361     break;
2362   case BuiltinType::Char8:
2363     Out << "_Q";
2364     break;
2365   case BuiltinType::Char16:
2366     Out << "_S";
2367     break;
2368   case BuiltinType::Char32:
2369     Out << "_U";
2370     break;
2371   case BuiltinType::WChar_S:
2372   case BuiltinType::WChar_U:
2373     Out << "_W";
2374     break;
2375 
2376 #define BUILTIN_TYPE(Id, SingletonId)
2377 #define PLACEHOLDER_TYPE(Id, SingletonId) \
2378   case BuiltinType::Id:
2379 #include "clang/AST/BuiltinTypes.def"
2380   case BuiltinType::Dependent:
2381     llvm_unreachable("placeholder types shouldn't get to name mangling");
2382 
2383   case BuiltinType::ObjCId:
2384     mangleArtificialTagType(TTK_Struct, "objc_object");
2385     break;
2386   case BuiltinType::ObjCClass:
2387     mangleArtificialTagType(TTK_Struct, "objc_class");
2388     break;
2389   case BuiltinType::ObjCSel:
2390     mangleArtificialTagType(TTK_Struct, "objc_selector");
2391     break;
2392 
2393 #define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
2394   case BuiltinType::Id: \
2395     Out << "PAUocl_" #ImgType "_" #Suffix "@@"; \
2396     break;
2397 #include "clang/Basic/OpenCLImageTypes.def"
2398   case BuiltinType::OCLSampler:
2399     Out << "PA";
2400     mangleArtificialTagType(TTK_Struct, "ocl_sampler");
2401     break;
2402   case BuiltinType::OCLEvent:
2403     Out << "PA";
2404     mangleArtificialTagType(TTK_Struct, "ocl_event");
2405     break;
2406   case BuiltinType::OCLClkEvent:
2407     Out << "PA";
2408     mangleArtificialTagType(TTK_Struct, "ocl_clkevent");
2409     break;
2410   case BuiltinType::OCLQueue:
2411     Out << "PA";
2412     mangleArtificialTagType(TTK_Struct, "ocl_queue");
2413     break;
2414   case BuiltinType::OCLReserveID:
2415     Out << "PA";
2416     mangleArtificialTagType(TTK_Struct, "ocl_reserveid");
2417     break;
2418 #define EXT_OPAQUE_TYPE(ExtType, Id, Ext) \
2419   case BuiltinType::Id: \
2420     mangleArtificialTagType(TTK_Struct, "ocl_" #ExtType); \
2421     break;
2422 #include "clang/Basic/OpenCLExtensionTypes.def"
2423 
2424   case BuiltinType::NullPtr:
2425     Out << "$$T";
2426     break;
2427 
2428   case BuiltinType::Float16:
2429     mangleArtificialTagType(TTK_Struct, "_Float16", {"__clang"});
2430     break;
2431 
2432   case BuiltinType::Half:
2433     mangleArtificialTagType(TTK_Struct, "_Half", {"__clang"});
2434     break;
2435 
2436 #define SVE_TYPE(Name, Id, SingletonId) \
2437   case BuiltinType::Id:
2438 #include "clang/Basic/AArch64SVEACLETypes.def"
2439 #define PPC_VECTOR_TYPE(Name, Id, Size) \
2440   case BuiltinType::Id:
2441 #include "clang/Basic/PPCTypes.def"
2442 #define RVV_TYPE(Name, Id, SingletonId) case BuiltinType::Id:
2443 #include "clang/Basic/RISCVVTypes.def"
2444   case BuiltinType::ShortAccum:
2445   case BuiltinType::Accum:
2446   case BuiltinType::LongAccum:
2447   case BuiltinType::UShortAccum:
2448   case BuiltinType::UAccum:
2449   case BuiltinType::ULongAccum:
2450   case BuiltinType::ShortFract:
2451   case BuiltinType::Fract:
2452   case BuiltinType::LongFract:
2453   case BuiltinType::UShortFract:
2454   case BuiltinType::UFract:
2455   case BuiltinType::ULongFract:
2456   case BuiltinType::SatShortAccum:
2457   case BuiltinType::SatAccum:
2458   case BuiltinType::SatLongAccum:
2459   case BuiltinType::SatUShortAccum:
2460   case BuiltinType::SatUAccum:
2461   case BuiltinType::SatULongAccum:
2462   case BuiltinType::SatShortFract:
2463   case BuiltinType::SatFract:
2464   case BuiltinType::SatLongFract:
2465   case BuiltinType::SatUShortFract:
2466   case BuiltinType::SatUFract:
2467   case BuiltinType::SatULongFract:
2468   case BuiltinType::BFloat16:
2469   case BuiltinType::Float128: {
2470     DiagnosticsEngine &Diags = Context.getDiags();
2471     unsigned DiagID = Diags.getCustomDiagID(
2472         DiagnosticsEngine::Error, "cannot mangle this built-in %0 type yet");
2473     Diags.Report(Range.getBegin(), DiagID)
2474         << T->getName(Context.getASTContext().getPrintingPolicy()) << Range;
2475     break;
2476   }
2477   }
2478 }
2479 
2480 // <type>          ::= <function-type>
mangleType(const FunctionProtoType * T,Qualifiers,SourceRange)2481 void MicrosoftCXXNameMangler::mangleType(const FunctionProtoType *T, Qualifiers,
2482                                          SourceRange) {
2483   // Structors only appear in decls, so at this point we know it's not a
2484   // structor type.
2485   // FIXME: This may not be lambda-friendly.
2486   if (T->getMethodQuals() || T->getRefQualifier() != RQ_None) {
2487     Out << "$$A8@@";
2488     mangleFunctionType(T, /*D=*/nullptr, /*ForceThisQuals=*/true);
2489   } else {
2490     Out << "$$A6";
2491     mangleFunctionType(T);
2492   }
2493 }
mangleType(const FunctionNoProtoType * T,Qualifiers,SourceRange)2494 void MicrosoftCXXNameMangler::mangleType(const FunctionNoProtoType *T,
2495                                          Qualifiers, SourceRange) {
2496   Out << "$$A6";
2497   mangleFunctionType(T);
2498 }
2499 
mangleFunctionType(const FunctionType * T,const FunctionDecl * D,bool ForceThisQuals,bool MangleExceptionSpec)2500 void MicrosoftCXXNameMangler::mangleFunctionType(const FunctionType *T,
2501                                                  const FunctionDecl *D,
2502                                                  bool ForceThisQuals,
2503                                                  bool MangleExceptionSpec) {
2504   // <function-type> ::= <this-cvr-qualifiers> <calling-convention>
2505   //                     <return-type> <argument-list> <throw-spec>
2506   const FunctionProtoType *Proto = dyn_cast<FunctionProtoType>(T);
2507 
2508   SourceRange Range;
2509   if (D) Range = D->getSourceRange();
2510 
2511   bool IsInLambda = false;
2512   bool IsStructor = false, HasThisQuals = ForceThisQuals, IsCtorClosure = false;
2513   CallingConv CC = T->getCallConv();
2514   if (const CXXMethodDecl *MD = dyn_cast_or_null<CXXMethodDecl>(D)) {
2515     if (MD->getParent()->isLambda())
2516       IsInLambda = true;
2517     if (MD->isInstance())
2518       HasThisQuals = true;
2519     if (isa<CXXDestructorDecl>(MD)) {
2520       IsStructor = true;
2521     } else if (isa<CXXConstructorDecl>(MD)) {
2522       IsStructor = true;
2523       IsCtorClosure = (StructorType == Ctor_CopyingClosure ||
2524                        StructorType == Ctor_DefaultClosure) &&
2525                       isStructorDecl(MD);
2526       if (IsCtorClosure)
2527         CC = getASTContext().getDefaultCallingConvention(
2528             /*IsVariadic=*/false, /*IsCXXMethod=*/true);
2529     }
2530   }
2531 
2532   // If this is a C++ instance method, mangle the CVR qualifiers for the
2533   // this pointer.
2534   if (HasThisQuals) {
2535     Qualifiers Quals = Proto->getMethodQuals();
2536     manglePointerExtQualifiers(Quals, /*PointeeType=*/QualType());
2537     mangleRefQualifier(Proto->getRefQualifier());
2538     mangleQualifiers(Quals, /*IsMember=*/false);
2539   }
2540 
2541   mangleCallingConvention(CC);
2542 
2543   // <return-type> ::= <type>
2544   //               ::= @ # structors (they have no declared return type)
2545   if (IsStructor) {
2546     if (isa<CXXDestructorDecl>(D) && isStructorDecl(D)) {
2547       // The scalar deleting destructor takes an extra int argument which is not
2548       // reflected in the AST.
2549       if (StructorType == Dtor_Deleting) {
2550         Out << (PointersAre64Bit ? "PEAXI@Z" : "PAXI@Z");
2551         return;
2552       }
2553       // The vbase destructor returns void which is not reflected in the AST.
2554       if (StructorType == Dtor_Complete) {
2555         Out << "XXZ";
2556         return;
2557       }
2558     }
2559     if (IsCtorClosure) {
2560       // Default constructor closure and copy constructor closure both return
2561       // void.
2562       Out << 'X';
2563 
2564       if (StructorType == Ctor_DefaultClosure) {
2565         // Default constructor closure always has no arguments.
2566         Out << 'X';
2567       } else if (StructorType == Ctor_CopyingClosure) {
2568         // Copy constructor closure always takes an unqualified reference.
2569         mangleFunctionArgumentType(getASTContext().getLValueReferenceType(
2570                                        Proto->getParamType(0)
2571                                            ->getAs<LValueReferenceType>()
2572                                            ->getPointeeType(),
2573                                        /*SpelledAsLValue=*/true),
2574                                    Range);
2575         Out << '@';
2576       } else {
2577         llvm_unreachable("unexpected constructor closure!");
2578       }
2579       Out << 'Z';
2580       return;
2581     }
2582     Out << '@';
2583   } else if (IsInLambda && D && isa<CXXConversionDecl>(D)) {
2584     // The only lambda conversion operators are to function pointers, which
2585     // can differ by their calling convention and are typically deduced.  So
2586     // we make sure that this type gets mangled properly.
2587     mangleType(T->getReturnType(), Range, QMM_Result);
2588   } else {
2589     QualType ResultType = T->getReturnType();
2590     if (IsInLambda && isa<CXXConversionDecl>(D)) {
2591       // The only lambda conversion operators are to function pointers, which
2592       // can differ by their calling convention and are typically deduced.  So
2593       // we make sure that this type gets mangled properly.
2594       mangleType(ResultType, Range, QMM_Result);
2595     } else if (const auto *AT = dyn_cast_or_null<AutoType>(
2596                    ResultType->getContainedAutoType())) {
2597       Out << '?';
2598       mangleQualifiers(ResultType.getLocalQualifiers(), /*IsMember=*/false);
2599       Out << '?';
2600       assert(AT->getKeyword() != AutoTypeKeyword::GNUAutoType &&
2601              "shouldn't need to mangle __auto_type!");
2602       mangleSourceName(AT->isDecltypeAuto() ? "<decltype-auto>" : "<auto>");
2603       Out << '@';
2604     } else if (IsInLambda) {
2605       Out << '@';
2606     } else {
2607       if (ResultType->isVoidType())
2608         ResultType = ResultType.getUnqualifiedType();
2609       mangleType(ResultType, Range, QMM_Result);
2610     }
2611   }
2612 
2613   // <argument-list> ::= X # void
2614   //                 ::= <type>+ @
2615   //                 ::= <type>* Z # varargs
2616   if (!Proto) {
2617     // Function types without prototypes can arise when mangling a function type
2618     // within an overloadable function in C. We mangle these as the absence of
2619     // any parameter types (not even an empty parameter list).
2620     Out << '@';
2621   } else if (Proto->getNumParams() == 0 && !Proto->isVariadic()) {
2622     Out << 'X';
2623   } else {
2624     // Happens for function pointer type arguments for example.
2625     for (unsigned I = 0, E = Proto->getNumParams(); I != E; ++I) {
2626       mangleFunctionArgumentType(Proto->getParamType(I), Range);
2627       // Mangle each pass_object_size parameter as if it's a parameter of enum
2628       // type passed directly after the parameter with the pass_object_size
2629       // attribute. The aforementioned enum's name is __pass_object_size, and we
2630       // pretend it resides in a top-level namespace called __clang.
2631       //
2632       // FIXME: Is there a defined extension notation for the MS ABI, or is it
2633       // necessary to just cross our fingers and hope this type+namespace
2634       // combination doesn't conflict with anything?
2635       if (D)
2636         if (const auto *P = D->getParamDecl(I)->getAttr<PassObjectSizeAttr>())
2637           manglePassObjectSizeArg(P);
2638     }
2639     // <builtin-type>      ::= Z  # ellipsis
2640     if (Proto->isVariadic())
2641       Out << 'Z';
2642     else
2643       Out << '@';
2644   }
2645 
2646   if (MangleExceptionSpec && getASTContext().getLangOpts().CPlusPlus17 &&
2647       getASTContext().getLangOpts().isCompatibleWithMSVC(
2648           LangOptions::MSVC2017_5))
2649     mangleThrowSpecification(Proto);
2650   else
2651     Out << 'Z';
2652 }
2653 
mangleFunctionClass(const FunctionDecl * FD)2654 void MicrosoftCXXNameMangler::mangleFunctionClass(const FunctionDecl *FD) {
2655   // <function-class>  ::= <member-function> E? # E designates a 64-bit 'this'
2656   //                                            # pointer. in 64-bit mode *all*
2657   //                                            # 'this' pointers are 64-bit.
2658   //                   ::= <global-function>
2659   // <member-function> ::= A # private: near
2660   //                   ::= B # private: far
2661   //                   ::= C # private: static near
2662   //                   ::= D # private: static far
2663   //                   ::= E # private: virtual near
2664   //                   ::= F # private: virtual far
2665   //                   ::= I # protected: near
2666   //                   ::= J # protected: far
2667   //                   ::= K # protected: static near
2668   //                   ::= L # protected: static far
2669   //                   ::= M # protected: virtual near
2670   //                   ::= N # protected: virtual far
2671   //                   ::= Q # public: near
2672   //                   ::= R # public: far
2673   //                   ::= S # public: static near
2674   //                   ::= T # public: static far
2675   //                   ::= U # public: virtual near
2676   //                   ::= V # public: virtual far
2677   // <global-function> ::= Y # global near
2678   //                   ::= Z # global far
2679   if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD)) {
2680     bool IsVirtual = MD->isVirtual();
2681     // When mangling vbase destructor variants, ignore whether or not the
2682     // underlying destructor was defined to be virtual.
2683     if (isa<CXXDestructorDecl>(MD) && isStructorDecl(MD) &&
2684         StructorType == Dtor_Complete) {
2685       IsVirtual = false;
2686     }
2687     switch (MD->getAccess()) {
2688       case AS_none:
2689         llvm_unreachable("Unsupported access specifier");
2690       case AS_private:
2691         if (MD->isStatic())
2692           Out << 'C';
2693         else if (IsVirtual)
2694           Out << 'E';
2695         else
2696           Out << 'A';
2697         break;
2698       case AS_protected:
2699         if (MD->isStatic())
2700           Out << 'K';
2701         else if (IsVirtual)
2702           Out << 'M';
2703         else
2704           Out << 'I';
2705         break;
2706       case AS_public:
2707         if (MD->isStatic())
2708           Out << 'S';
2709         else if (IsVirtual)
2710           Out << 'U';
2711         else
2712           Out << 'Q';
2713     }
2714   } else {
2715     Out << 'Y';
2716   }
2717 }
mangleCallingConvention(CallingConv CC)2718 void MicrosoftCXXNameMangler::mangleCallingConvention(CallingConv CC) {
2719   // <calling-convention> ::= A # __cdecl
2720   //                      ::= B # __export __cdecl
2721   //                      ::= C # __pascal
2722   //                      ::= D # __export __pascal
2723   //                      ::= E # __thiscall
2724   //                      ::= F # __export __thiscall
2725   //                      ::= G # __stdcall
2726   //                      ::= H # __export __stdcall
2727   //                      ::= I # __fastcall
2728   //                      ::= J # __export __fastcall
2729   //                      ::= Q # __vectorcall
2730   //                      ::= S # __attribute__((__swiftcall__)) // Clang-only
2731   //                      ::= w # __regcall
2732   // The 'export' calling conventions are from a bygone era
2733   // (*cough*Win16*cough*) when functions were declared for export with
2734   // that keyword. (It didn't actually export them, it just made them so
2735   // that they could be in a DLL and somebody from another module could call
2736   // them.)
2737 
2738   switch (CC) {
2739     default:
2740       llvm_unreachable("Unsupported CC for mangling");
2741     case CC_Win64:
2742     case CC_X86_64SysV:
2743     case CC_C: Out << 'A'; break;
2744     case CC_X86Pascal: Out << 'C'; break;
2745     case CC_X86ThisCall: Out << 'E'; break;
2746     case CC_X86StdCall: Out << 'G'; break;
2747     case CC_X86FastCall: Out << 'I'; break;
2748     case CC_X86VectorCall: Out << 'Q'; break;
2749     case CC_Swift: Out << 'S'; break;
2750     case CC_PreserveMost: Out << 'U'; break;
2751     case CC_X86RegCall: Out << 'w'; break;
2752   }
2753 }
mangleCallingConvention(const FunctionType * T)2754 void MicrosoftCXXNameMangler::mangleCallingConvention(const FunctionType *T) {
2755   mangleCallingConvention(T->getCallConv());
2756 }
2757 
mangleThrowSpecification(const FunctionProtoType * FT)2758 void MicrosoftCXXNameMangler::mangleThrowSpecification(
2759                                                 const FunctionProtoType *FT) {
2760   // <throw-spec> ::= Z # (default)
2761   //              ::= _E # noexcept
2762   if (FT->canThrow())
2763     Out << 'Z';
2764   else
2765     Out << "_E";
2766 }
2767 
mangleType(const UnresolvedUsingType * T,Qualifiers,SourceRange Range)2768 void MicrosoftCXXNameMangler::mangleType(const UnresolvedUsingType *T,
2769                                          Qualifiers, SourceRange Range) {
2770   // Probably should be mangled as a template instantiation; need to see what
2771   // VC does first.
2772   DiagnosticsEngine &Diags = Context.getDiags();
2773   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2774     "cannot mangle this unresolved dependent type yet");
2775   Diags.Report(Range.getBegin(), DiagID)
2776     << Range;
2777 }
2778 
2779 // <type>        ::= <union-type> | <struct-type> | <class-type> | <enum-type>
2780 // <union-type>  ::= T <name>
2781 // <struct-type> ::= U <name>
2782 // <class-type>  ::= V <name>
2783 // <enum-type>   ::= W4 <name>
mangleTagTypeKind(TagTypeKind TTK)2784 void MicrosoftCXXNameMangler::mangleTagTypeKind(TagTypeKind TTK) {
2785   switch (TTK) {
2786     case TTK_Union:
2787       Out << 'T';
2788       break;
2789     case TTK_Struct:
2790     case TTK_Interface:
2791       Out << 'U';
2792       break;
2793     case TTK_Class:
2794       Out << 'V';
2795       break;
2796     case TTK_Enum:
2797       Out << "W4";
2798       break;
2799   }
2800 }
mangleType(const EnumType * T,Qualifiers,SourceRange)2801 void MicrosoftCXXNameMangler::mangleType(const EnumType *T, Qualifiers,
2802                                          SourceRange) {
2803   mangleType(cast<TagType>(T)->getDecl());
2804 }
mangleType(const RecordType * T,Qualifiers,SourceRange)2805 void MicrosoftCXXNameMangler::mangleType(const RecordType *T, Qualifiers,
2806                                          SourceRange) {
2807   mangleType(cast<TagType>(T)->getDecl());
2808 }
mangleType(const TagDecl * TD)2809 void MicrosoftCXXNameMangler::mangleType(const TagDecl *TD) {
2810   mangleTagTypeKind(TD->getTagKind());
2811   mangleName(TD);
2812 }
2813 
2814 // If you add a call to this, consider updating isArtificialTagType() too.
mangleArtificialTagType(TagTypeKind TK,StringRef UnqualifiedName,ArrayRef<StringRef> NestedNames)2815 void MicrosoftCXXNameMangler::mangleArtificialTagType(
2816     TagTypeKind TK, StringRef UnqualifiedName,
2817     ArrayRef<StringRef> NestedNames) {
2818   // <name> ::= <unscoped-name> {[<named-scope>]+ | [<nested-name>]}? @
2819   mangleTagTypeKind(TK);
2820 
2821   // Always start with the unqualified name.
2822   mangleSourceName(UnqualifiedName);
2823 
2824   for (auto I = NestedNames.rbegin(), E = NestedNames.rend(); I != E; ++I)
2825     mangleSourceName(*I);
2826 
2827   // Terminate the whole name with an '@'.
2828   Out << '@';
2829 }
2830 
2831 // <type>       ::= <array-type>
2832 // <array-type> ::= <pointer-cvr-qualifiers> <cvr-qualifiers>
2833 //                  [Y <dimension-count> <dimension>+]
2834 //                  <element-type> # as global, E is never required
2835 // It's supposed to be the other way around, but for some strange reason, it
2836 // isn't. Today this behavior is retained for the sole purpose of backwards
2837 // compatibility.
mangleDecayedArrayType(const ArrayType * T)2838 void MicrosoftCXXNameMangler::mangleDecayedArrayType(const ArrayType *T) {
2839   // This isn't a recursive mangling, so now we have to do it all in this
2840   // one call.
2841   manglePointerCVQualifiers(T->getElementType().getQualifiers());
2842   mangleType(T->getElementType(), SourceRange());
2843 }
mangleType(const ConstantArrayType * T,Qualifiers,SourceRange)2844 void MicrosoftCXXNameMangler::mangleType(const ConstantArrayType *T, Qualifiers,
2845                                          SourceRange) {
2846   llvm_unreachable("Should have been special cased");
2847 }
mangleType(const VariableArrayType * T,Qualifiers,SourceRange)2848 void MicrosoftCXXNameMangler::mangleType(const VariableArrayType *T, Qualifiers,
2849                                          SourceRange) {
2850   llvm_unreachable("Should have been special cased");
2851 }
mangleType(const DependentSizedArrayType * T,Qualifiers,SourceRange)2852 void MicrosoftCXXNameMangler::mangleType(const DependentSizedArrayType *T,
2853                                          Qualifiers, SourceRange) {
2854   llvm_unreachable("Should have been special cased");
2855 }
mangleType(const IncompleteArrayType * T,Qualifiers,SourceRange)2856 void MicrosoftCXXNameMangler::mangleType(const IncompleteArrayType *T,
2857                                          Qualifiers, SourceRange) {
2858   llvm_unreachable("Should have been special cased");
2859 }
mangleArrayType(const ArrayType * T)2860 void MicrosoftCXXNameMangler::mangleArrayType(const ArrayType *T) {
2861   QualType ElementTy(T, 0);
2862   SmallVector<llvm::APInt, 3> Dimensions;
2863   for (;;) {
2864     if (ElementTy->isConstantArrayType()) {
2865       const ConstantArrayType *CAT =
2866           getASTContext().getAsConstantArrayType(ElementTy);
2867       Dimensions.push_back(CAT->getSize());
2868       ElementTy = CAT->getElementType();
2869     } else if (ElementTy->isIncompleteArrayType()) {
2870       const IncompleteArrayType *IAT =
2871           getASTContext().getAsIncompleteArrayType(ElementTy);
2872       Dimensions.push_back(llvm::APInt(32, 0));
2873       ElementTy = IAT->getElementType();
2874     } else if (ElementTy->isVariableArrayType()) {
2875       const VariableArrayType *VAT =
2876         getASTContext().getAsVariableArrayType(ElementTy);
2877       Dimensions.push_back(llvm::APInt(32, 0));
2878       ElementTy = VAT->getElementType();
2879     } else if (ElementTy->isDependentSizedArrayType()) {
2880       // The dependent expression has to be folded into a constant (TODO).
2881       const DependentSizedArrayType *DSAT =
2882         getASTContext().getAsDependentSizedArrayType(ElementTy);
2883       DiagnosticsEngine &Diags = Context.getDiags();
2884       unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2885         "cannot mangle this dependent-length array yet");
2886       Diags.Report(DSAT->getSizeExpr()->getExprLoc(), DiagID)
2887         << DSAT->getBracketsRange();
2888       return;
2889     } else {
2890       break;
2891     }
2892   }
2893   Out << 'Y';
2894   // <dimension-count> ::= <number> # number of extra dimensions
2895   mangleNumber(Dimensions.size());
2896   for (const llvm::APInt &Dimension : Dimensions)
2897     mangleNumber(Dimension.getLimitedValue());
2898   mangleType(ElementTy, SourceRange(), QMM_Escape);
2899 }
2900 
2901 // <type>                   ::= <pointer-to-member-type>
2902 // <pointer-to-member-type> ::= <pointer-cvr-qualifiers> <cvr-qualifiers>
2903 //                                                          <class name> <type>
mangleType(const MemberPointerType * T,Qualifiers Quals,SourceRange Range)2904 void MicrosoftCXXNameMangler::mangleType(const MemberPointerType *T,
2905                                          Qualifiers Quals, SourceRange Range) {
2906   QualType PointeeType = T->getPointeeType();
2907   manglePointerCVQualifiers(Quals);
2908   manglePointerExtQualifiers(Quals, PointeeType);
2909   if (const FunctionProtoType *FPT = PointeeType->getAs<FunctionProtoType>()) {
2910     Out << '8';
2911     mangleName(T->getClass()->castAs<RecordType>()->getDecl());
2912     mangleFunctionType(FPT, nullptr, true);
2913   } else {
2914     mangleQualifiers(PointeeType.getQualifiers(), true);
2915     mangleName(T->getClass()->castAs<RecordType>()->getDecl());
2916     mangleType(PointeeType, Range, QMM_Drop);
2917   }
2918 }
2919 
mangleType(const TemplateTypeParmType * T,Qualifiers,SourceRange Range)2920 void MicrosoftCXXNameMangler::mangleType(const TemplateTypeParmType *T,
2921                                          Qualifiers, SourceRange Range) {
2922   DiagnosticsEngine &Diags = Context.getDiags();
2923   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2924     "cannot mangle this template type parameter type yet");
2925   Diags.Report(Range.getBegin(), DiagID)
2926     << Range;
2927 }
2928 
mangleType(const SubstTemplateTypeParmPackType * T,Qualifiers,SourceRange Range)2929 void MicrosoftCXXNameMangler::mangleType(const SubstTemplateTypeParmPackType *T,
2930                                          Qualifiers, SourceRange Range) {
2931   DiagnosticsEngine &Diags = Context.getDiags();
2932   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2933     "cannot mangle this substituted parameter pack yet");
2934   Diags.Report(Range.getBegin(), DiagID)
2935     << Range;
2936 }
2937 
2938 // <type> ::= <pointer-type>
2939 // <pointer-type> ::= E? <pointer-cvr-qualifiers> <cvr-qualifiers> <type>
2940 //                       # the E is required for 64-bit non-static pointers
mangleType(const PointerType * T,Qualifiers Quals,SourceRange Range)2941 void MicrosoftCXXNameMangler::mangleType(const PointerType *T, Qualifiers Quals,
2942                                          SourceRange Range) {
2943   QualType PointeeType = T->getPointeeType();
2944   manglePointerCVQualifiers(Quals);
2945   manglePointerExtQualifiers(Quals, PointeeType);
2946 
2947   // For pointer size address spaces, go down the same type mangling path as
2948   // non address space types.
2949   LangAS AddrSpace = PointeeType.getQualifiers().getAddressSpace();
2950   if (isPtrSizeAddressSpace(AddrSpace) || AddrSpace == LangAS::Default)
2951     mangleType(PointeeType, Range);
2952   else
2953     mangleAddressSpaceType(PointeeType, PointeeType.getQualifiers(), Range);
2954 }
2955 
mangleType(const ObjCObjectPointerType * T,Qualifiers Quals,SourceRange Range)2956 void MicrosoftCXXNameMangler::mangleType(const ObjCObjectPointerType *T,
2957                                          Qualifiers Quals, SourceRange Range) {
2958   QualType PointeeType = T->getPointeeType();
2959   switch (Quals.getObjCLifetime()) {
2960   case Qualifiers::OCL_None:
2961   case Qualifiers::OCL_ExplicitNone:
2962     break;
2963   case Qualifiers::OCL_Autoreleasing:
2964   case Qualifiers::OCL_Strong:
2965   case Qualifiers::OCL_Weak:
2966     return mangleObjCLifetime(PointeeType, Quals, Range);
2967   }
2968   manglePointerCVQualifiers(Quals);
2969   manglePointerExtQualifiers(Quals, PointeeType);
2970   mangleType(PointeeType, Range);
2971 }
2972 
2973 // <type> ::= <reference-type>
2974 // <reference-type> ::= A E? <cvr-qualifiers> <type>
2975 //                 # the E is required for 64-bit non-static lvalue references
mangleType(const LValueReferenceType * T,Qualifiers Quals,SourceRange Range)2976 void MicrosoftCXXNameMangler::mangleType(const LValueReferenceType *T,
2977                                          Qualifiers Quals, SourceRange Range) {
2978   QualType PointeeType = T->getPointeeType();
2979   assert(!Quals.hasConst() && !Quals.hasVolatile() && "unexpected qualifier!");
2980   Out << 'A';
2981   manglePointerExtQualifiers(Quals, PointeeType);
2982   mangleType(PointeeType, Range);
2983 }
2984 
2985 // <type> ::= <r-value-reference-type>
2986 // <r-value-reference-type> ::= $$Q E? <cvr-qualifiers> <type>
2987 //                 # the E is required for 64-bit non-static rvalue references
mangleType(const RValueReferenceType * T,Qualifiers Quals,SourceRange Range)2988 void MicrosoftCXXNameMangler::mangleType(const RValueReferenceType *T,
2989                                          Qualifiers Quals, SourceRange Range) {
2990   QualType PointeeType = T->getPointeeType();
2991   assert(!Quals.hasConst() && !Quals.hasVolatile() && "unexpected qualifier!");
2992   Out << "$$Q";
2993   manglePointerExtQualifiers(Quals, PointeeType);
2994   mangleType(PointeeType, Range);
2995 }
2996 
mangleType(const ComplexType * T,Qualifiers,SourceRange Range)2997 void MicrosoftCXXNameMangler::mangleType(const ComplexType *T, Qualifiers,
2998                                          SourceRange Range) {
2999   QualType ElementType = T->getElementType();
3000 
3001   llvm::SmallString<64> TemplateMangling;
3002   llvm::raw_svector_ostream Stream(TemplateMangling);
3003   MicrosoftCXXNameMangler Extra(Context, Stream);
3004   Stream << "?$";
3005   Extra.mangleSourceName("_Complex");
3006   Extra.mangleType(ElementType, Range, QMM_Escape);
3007 
3008   mangleArtificialTagType(TTK_Struct, TemplateMangling, {"__clang"});
3009 }
3010 
3011 // Returns true for types that mangleArtificialTagType() gets called for with
3012 // TTK_Union, TTK_Struct, TTK_Class and where compatibility with MSVC's
3013 // mangling matters.
3014 // (It doesn't matter for Objective-C types and the like that cl.exe doesn't
3015 // support.)
isArtificialTagType(QualType T) const3016 bool MicrosoftCXXNameMangler::isArtificialTagType(QualType T) const {
3017   const Type *ty = T.getTypePtr();
3018   switch (ty->getTypeClass()) {
3019   default:
3020     return false;
3021 
3022   case Type::Vector: {
3023     // For ABI compatibility only __m64, __m128(id), and __m256(id) matter,
3024     // but since mangleType(VectorType*) always calls mangleArtificialTagType()
3025     // just always return true (the other vector types are clang-only).
3026     return true;
3027   }
3028   }
3029 }
3030 
mangleType(const VectorType * T,Qualifiers Quals,SourceRange Range)3031 void MicrosoftCXXNameMangler::mangleType(const VectorType *T, Qualifiers Quals,
3032                                          SourceRange Range) {
3033   const BuiltinType *ET = T->getElementType()->getAs<BuiltinType>();
3034   assert(ET && "vectors with non-builtin elements are unsupported");
3035   uint64_t Width = getASTContext().getTypeSize(T);
3036   // Pattern match exactly the typedefs in our intrinsic headers.  Anything that
3037   // doesn't match the Intel types uses a custom mangling below.
3038   size_t OutSizeBefore = Out.tell();
3039   if (!isa<ExtVectorType>(T)) {
3040     if (getASTContext().getTargetInfo().getTriple().isX86()) {
3041       if (Width == 64 && ET->getKind() == BuiltinType::LongLong) {
3042         mangleArtificialTagType(TTK_Union, "__m64");
3043       } else if (Width >= 128) {
3044         if (ET->getKind() == BuiltinType::Float)
3045           mangleArtificialTagType(TTK_Union, "__m" + llvm::utostr(Width));
3046         else if (ET->getKind() == BuiltinType::LongLong)
3047           mangleArtificialTagType(TTK_Union, "__m" + llvm::utostr(Width) + 'i');
3048         else if (ET->getKind() == BuiltinType::Double)
3049           mangleArtificialTagType(TTK_Struct, "__m" + llvm::utostr(Width) + 'd');
3050       }
3051     }
3052   }
3053 
3054   bool IsBuiltin = Out.tell() != OutSizeBefore;
3055   if (!IsBuiltin) {
3056     // The MS ABI doesn't have a special mangling for vector types, so we define
3057     // our own mangling to handle uses of __vector_size__ on user-specified
3058     // types, and for extensions like __v4sf.
3059 
3060     llvm::SmallString<64> TemplateMangling;
3061     llvm::raw_svector_ostream Stream(TemplateMangling);
3062     MicrosoftCXXNameMangler Extra(Context, Stream);
3063     Stream << "?$";
3064     Extra.mangleSourceName("__vector");
3065     Extra.mangleType(QualType(ET, 0), Range, QMM_Escape);
3066     Extra.mangleIntegerLiteral(llvm::APSInt::getUnsigned(T->getNumElements()));
3067 
3068     mangleArtificialTagType(TTK_Union, TemplateMangling, {"__clang"});
3069   }
3070 }
3071 
mangleType(const ExtVectorType * T,Qualifiers Quals,SourceRange Range)3072 void MicrosoftCXXNameMangler::mangleType(const ExtVectorType *T,
3073                                          Qualifiers Quals, SourceRange Range) {
3074   mangleType(static_cast<const VectorType *>(T), Quals, Range);
3075 }
3076 
mangleType(const DependentVectorType * T,Qualifiers,SourceRange Range)3077 void MicrosoftCXXNameMangler::mangleType(const DependentVectorType *T,
3078                                          Qualifiers, SourceRange Range) {
3079   DiagnosticsEngine &Diags = Context.getDiags();
3080   unsigned DiagID = Diags.getCustomDiagID(
3081       DiagnosticsEngine::Error,
3082       "cannot mangle this dependent-sized vector type yet");
3083   Diags.Report(Range.getBegin(), DiagID) << Range;
3084 }
3085 
mangleType(const DependentSizedExtVectorType * T,Qualifiers,SourceRange Range)3086 void MicrosoftCXXNameMangler::mangleType(const DependentSizedExtVectorType *T,
3087                                          Qualifiers, SourceRange Range) {
3088   DiagnosticsEngine &Diags = Context.getDiags();
3089   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
3090     "cannot mangle this dependent-sized extended vector type yet");
3091   Diags.Report(Range.getBegin(), DiagID)
3092     << Range;
3093 }
3094 
mangleType(const ConstantMatrixType * T,Qualifiers quals,SourceRange Range)3095 void MicrosoftCXXNameMangler::mangleType(const ConstantMatrixType *T,
3096                                          Qualifiers quals, SourceRange Range) {
3097   DiagnosticsEngine &Diags = Context.getDiags();
3098   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
3099                                           "Cannot mangle this matrix type yet");
3100   Diags.Report(Range.getBegin(), DiagID) << Range;
3101 }
3102 
mangleType(const DependentSizedMatrixType * T,Qualifiers quals,SourceRange Range)3103 void MicrosoftCXXNameMangler::mangleType(const DependentSizedMatrixType *T,
3104                                          Qualifiers quals, SourceRange Range) {
3105   DiagnosticsEngine &Diags = Context.getDiags();
3106   unsigned DiagID = Diags.getCustomDiagID(
3107       DiagnosticsEngine::Error,
3108       "Cannot mangle this dependent-sized matrix type yet");
3109   Diags.Report(Range.getBegin(), DiagID) << Range;
3110 }
3111 
mangleType(const DependentAddressSpaceType * T,Qualifiers,SourceRange Range)3112 void MicrosoftCXXNameMangler::mangleType(const DependentAddressSpaceType *T,
3113                                          Qualifiers, SourceRange Range) {
3114   DiagnosticsEngine &Diags = Context.getDiags();
3115   unsigned DiagID = Diags.getCustomDiagID(
3116       DiagnosticsEngine::Error,
3117       "cannot mangle this dependent address space type yet");
3118   Diags.Report(Range.getBegin(), DiagID) << Range;
3119 }
3120 
mangleType(const ObjCInterfaceType * T,Qualifiers,SourceRange)3121 void MicrosoftCXXNameMangler::mangleType(const ObjCInterfaceType *T, Qualifiers,
3122                                          SourceRange) {
3123   // ObjC interfaces have structs underlying them.
3124   mangleTagTypeKind(TTK_Struct);
3125   mangleName(T->getDecl());
3126 }
3127 
mangleType(const ObjCObjectType * T,Qualifiers Quals,SourceRange Range)3128 void MicrosoftCXXNameMangler::mangleType(const ObjCObjectType *T,
3129                                          Qualifiers Quals, SourceRange Range) {
3130   if (T->isKindOfType())
3131     return mangleObjCKindOfType(T, Quals, Range);
3132 
3133   if (T->qual_empty() && !T->isSpecialized())
3134     return mangleType(T->getBaseType(), Range, QMM_Drop);
3135 
3136   ArgBackRefMap OuterFunArgsContext;
3137   ArgBackRefMap OuterTemplateArgsContext;
3138   BackRefVec OuterTemplateContext;
3139 
3140   FunArgBackReferences.swap(OuterFunArgsContext);
3141   TemplateArgBackReferences.swap(OuterTemplateArgsContext);
3142   NameBackReferences.swap(OuterTemplateContext);
3143 
3144   mangleTagTypeKind(TTK_Struct);
3145 
3146   Out << "?$";
3147   if (T->isObjCId())
3148     mangleSourceName("objc_object");
3149   else if (T->isObjCClass())
3150     mangleSourceName("objc_class");
3151   else
3152     mangleSourceName(T->getInterface()->getName());
3153 
3154   for (const auto &Q : T->quals())
3155     mangleObjCProtocol(Q);
3156 
3157   if (T->isSpecialized())
3158     for (const auto &TA : T->getTypeArgs())
3159       mangleType(TA, Range, QMM_Drop);
3160 
3161   Out << '@';
3162 
3163   Out << '@';
3164 
3165   FunArgBackReferences.swap(OuterFunArgsContext);
3166   TemplateArgBackReferences.swap(OuterTemplateArgsContext);
3167   NameBackReferences.swap(OuterTemplateContext);
3168 }
3169 
mangleType(const BlockPointerType * T,Qualifiers Quals,SourceRange Range)3170 void MicrosoftCXXNameMangler::mangleType(const BlockPointerType *T,
3171                                          Qualifiers Quals, SourceRange Range) {
3172   QualType PointeeType = T->getPointeeType();
3173   manglePointerCVQualifiers(Quals);
3174   manglePointerExtQualifiers(Quals, PointeeType);
3175 
3176   Out << "_E";
3177 
3178   mangleFunctionType(PointeeType->castAs<FunctionProtoType>());
3179 }
3180 
mangleType(const InjectedClassNameType *,Qualifiers,SourceRange)3181 void MicrosoftCXXNameMangler::mangleType(const InjectedClassNameType *,
3182                                          Qualifiers, SourceRange) {
3183   llvm_unreachable("Cannot mangle injected class name type.");
3184 }
3185 
mangleType(const TemplateSpecializationType * T,Qualifiers,SourceRange Range)3186 void MicrosoftCXXNameMangler::mangleType(const TemplateSpecializationType *T,
3187                                          Qualifiers, SourceRange Range) {
3188   DiagnosticsEngine &Diags = Context.getDiags();
3189   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
3190     "cannot mangle this template specialization type yet");
3191   Diags.Report(Range.getBegin(), DiagID)
3192     << Range;
3193 }
3194 
mangleType(const DependentNameType * T,Qualifiers,SourceRange Range)3195 void MicrosoftCXXNameMangler::mangleType(const DependentNameType *T, Qualifiers,
3196                                          SourceRange Range) {
3197   DiagnosticsEngine &Diags = Context.getDiags();
3198   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
3199     "cannot mangle this dependent name type yet");
3200   Diags.Report(Range.getBegin(), DiagID)
3201     << Range;
3202 }
3203 
mangleType(const DependentTemplateSpecializationType * T,Qualifiers,SourceRange Range)3204 void MicrosoftCXXNameMangler::mangleType(
3205     const DependentTemplateSpecializationType *T, Qualifiers,
3206     SourceRange Range) {
3207   DiagnosticsEngine &Diags = Context.getDiags();
3208   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
3209     "cannot mangle this dependent template specialization type yet");
3210   Diags.Report(Range.getBegin(), DiagID)
3211     << Range;
3212 }
3213 
mangleType(const PackExpansionType * T,Qualifiers,SourceRange Range)3214 void MicrosoftCXXNameMangler::mangleType(const PackExpansionType *T, Qualifiers,
3215                                          SourceRange Range) {
3216   DiagnosticsEngine &Diags = Context.getDiags();
3217   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
3218     "cannot mangle this pack expansion yet");
3219   Diags.Report(Range.getBegin(), DiagID)
3220     << Range;
3221 }
3222 
mangleType(const TypeOfType * T,Qualifiers,SourceRange Range)3223 void MicrosoftCXXNameMangler::mangleType(const TypeOfType *T, Qualifiers,
3224                                          SourceRange Range) {
3225   DiagnosticsEngine &Diags = Context.getDiags();
3226   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
3227     "cannot mangle this typeof(type) yet");
3228   Diags.Report(Range.getBegin(), DiagID)
3229     << Range;
3230 }
3231 
mangleType(const TypeOfExprType * T,Qualifiers,SourceRange Range)3232 void MicrosoftCXXNameMangler::mangleType(const TypeOfExprType *T, Qualifiers,
3233                                          SourceRange Range) {
3234   DiagnosticsEngine &Diags = Context.getDiags();
3235   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
3236     "cannot mangle this typeof(expression) yet");
3237   Diags.Report(Range.getBegin(), DiagID)
3238     << Range;
3239 }
3240 
mangleType(const DecltypeType * T,Qualifiers,SourceRange Range)3241 void MicrosoftCXXNameMangler::mangleType(const DecltypeType *T, Qualifiers,
3242                                          SourceRange Range) {
3243   DiagnosticsEngine &Diags = Context.getDiags();
3244   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
3245     "cannot mangle this decltype() yet");
3246   Diags.Report(Range.getBegin(), DiagID)
3247     << Range;
3248 }
3249 
mangleType(const UnaryTransformType * T,Qualifiers,SourceRange Range)3250 void MicrosoftCXXNameMangler::mangleType(const UnaryTransformType *T,
3251                                          Qualifiers, SourceRange Range) {
3252   DiagnosticsEngine &Diags = Context.getDiags();
3253   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
3254     "cannot mangle this unary transform type yet");
3255   Diags.Report(Range.getBegin(), DiagID)
3256     << Range;
3257 }
3258 
mangleType(const AutoType * T,Qualifiers,SourceRange Range)3259 void MicrosoftCXXNameMangler::mangleType(const AutoType *T, Qualifiers,
3260                                          SourceRange Range) {
3261   assert(T->getDeducedType().isNull() && "expecting a dependent type!");
3262 
3263   DiagnosticsEngine &Diags = Context.getDiags();
3264   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
3265     "cannot mangle this 'auto' type yet");
3266   Diags.Report(Range.getBegin(), DiagID)
3267     << Range;
3268 }
3269 
mangleType(const DeducedTemplateSpecializationType * T,Qualifiers,SourceRange Range)3270 void MicrosoftCXXNameMangler::mangleType(
3271     const DeducedTemplateSpecializationType *T, Qualifiers, SourceRange Range) {
3272   assert(T->getDeducedType().isNull() && "expecting a dependent type!");
3273 
3274   DiagnosticsEngine &Diags = Context.getDiags();
3275   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
3276     "cannot mangle this deduced class template specialization type yet");
3277   Diags.Report(Range.getBegin(), DiagID)
3278     << Range;
3279 }
3280 
mangleType(const AtomicType * T,Qualifiers,SourceRange Range)3281 void MicrosoftCXXNameMangler::mangleType(const AtomicType *T, Qualifiers,
3282                                          SourceRange Range) {
3283   QualType ValueType = T->getValueType();
3284 
3285   llvm::SmallString<64> TemplateMangling;
3286   llvm::raw_svector_ostream Stream(TemplateMangling);
3287   MicrosoftCXXNameMangler Extra(Context, Stream);
3288   Stream << "?$";
3289   Extra.mangleSourceName("_Atomic");
3290   Extra.mangleType(ValueType, Range, QMM_Escape);
3291 
3292   mangleArtificialTagType(TTK_Struct, TemplateMangling, {"__clang"});
3293 }
3294 
mangleType(const PipeType * T,Qualifiers,SourceRange Range)3295 void MicrosoftCXXNameMangler::mangleType(const PipeType *T, Qualifiers,
3296                                          SourceRange Range) {
3297   QualType ElementType = T->getElementType();
3298 
3299   llvm::SmallString<64> TemplateMangling;
3300   llvm::raw_svector_ostream Stream(TemplateMangling);
3301   MicrosoftCXXNameMangler Extra(Context, Stream);
3302   Stream << "?$";
3303   Extra.mangleSourceName("ocl_pipe");
3304   Extra.mangleType(ElementType, Range, QMM_Escape);
3305   Extra.mangleIntegerLiteral(llvm::APSInt::get(T->isReadOnly()));
3306 
3307   mangleArtificialTagType(TTK_Struct, TemplateMangling, {"__clang"});
3308 }
3309 
mangleCXXName(GlobalDecl GD,raw_ostream & Out)3310 void MicrosoftMangleContextImpl::mangleCXXName(GlobalDecl GD,
3311                                                raw_ostream &Out) {
3312   const NamedDecl *D = cast<NamedDecl>(GD.getDecl());
3313   PrettyStackTraceDecl CrashInfo(D, SourceLocation(),
3314                                  getASTContext().getSourceManager(),
3315                                  "Mangling declaration");
3316 
3317   msvc_hashing_ostream MHO(Out);
3318 
3319   if (auto *CD = dyn_cast<CXXConstructorDecl>(D)) {
3320     auto Type = GD.getCtorType();
3321     MicrosoftCXXNameMangler mangler(*this, MHO, CD, Type);
3322     return mangler.mangle(D);
3323   }
3324 
3325   if (auto *DD = dyn_cast<CXXDestructorDecl>(D)) {
3326     auto Type = GD.getDtorType();
3327     MicrosoftCXXNameMangler mangler(*this, MHO, DD, Type);
3328     return mangler.mangle(D);
3329   }
3330 
3331   MicrosoftCXXNameMangler Mangler(*this, MHO);
3332   return Mangler.mangle(D);
3333 }
3334 
mangleType(const ExtIntType * T,Qualifiers,SourceRange Range)3335 void MicrosoftCXXNameMangler::mangleType(const ExtIntType *T, Qualifiers,
3336                                          SourceRange Range) {
3337   llvm::SmallString<64> TemplateMangling;
3338   llvm::raw_svector_ostream Stream(TemplateMangling);
3339   MicrosoftCXXNameMangler Extra(Context, Stream);
3340   Stream << "?$";
3341   if (T->isUnsigned())
3342     Extra.mangleSourceName("_UExtInt");
3343   else
3344     Extra.mangleSourceName("_ExtInt");
3345   Extra.mangleIntegerLiteral(llvm::APSInt::getUnsigned(T->getNumBits()));
3346 
3347   mangleArtificialTagType(TTK_Struct, TemplateMangling, {"__clang"});
3348 }
3349 
mangleType(const DependentExtIntType * T,Qualifiers,SourceRange Range)3350 void MicrosoftCXXNameMangler::mangleType(const DependentExtIntType *T,
3351                                          Qualifiers, SourceRange Range) {
3352   DiagnosticsEngine &Diags = Context.getDiags();
3353   unsigned DiagID = Diags.getCustomDiagID(
3354       DiagnosticsEngine::Error, "cannot mangle this DependentExtInt type yet");
3355   Diags.Report(Range.getBegin(), DiagID) << Range;
3356 }
3357 
3358 // <this-adjustment> ::= <no-adjustment> | <static-adjustment> |
3359 //                       <virtual-adjustment>
3360 // <no-adjustment>      ::= A # private near
3361 //                      ::= B # private far
3362 //                      ::= I # protected near
3363 //                      ::= J # protected far
3364 //                      ::= Q # public near
3365 //                      ::= R # public far
3366 // <static-adjustment>  ::= G <static-offset> # private near
3367 //                      ::= H <static-offset> # private far
3368 //                      ::= O <static-offset> # protected near
3369 //                      ::= P <static-offset> # protected far
3370 //                      ::= W <static-offset> # public near
3371 //                      ::= X <static-offset> # public far
3372 // <virtual-adjustment> ::= $0 <virtual-shift> <static-offset> # private near
3373 //                      ::= $1 <virtual-shift> <static-offset> # private far
3374 //                      ::= $2 <virtual-shift> <static-offset> # protected near
3375 //                      ::= $3 <virtual-shift> <static-offset> # protected far
3376 //                      ::= $4 <virtual-shift> <static-offset> # public near
3377 //                      ::= $5 <virtual-shift> <static-offset> # public far
3378 // <virtual-shift>      ::= <vtordisp-shift> | <vtordispex-shift>
3379 // <vtordisp-shift>     ::= <offset-to-vtordisp>
3380 // <vtordispex-shift>   ::= <offset-to-vbptr> <vbase-offset-offset>
3381 //                          <offset-to-vtordisp>
mangleThunkThisAdjustment(AccessSpecifier AS,const ThisAdjustment & Adjustment,MicrosoftCXXNameMangler & Mangler,raw_ostream & Out)3382 static void mangleThunkThisAdjustment(AccessSpecifier AS,
3383                                       const ThisAdjustment &Adjustment,
3384                                       MicrosoftCXXNameMangler &Mangler,
3385                                       raw_ostream &Out) {
3386   if (!Adjustment.Virtual.isEmpty()) {
3387     Out << '$';
3388     char AccessSpec;
3389     switch (AS) {
3390     case AS_none:
3391       llvm_unreachable("Unsupported access specifier");
3392     case AS_private:
3393       AccessSpec = '0';
3394       break;
3395     case AS_protected:
3396       AccessSpec = '2';
3397       break;
3398     case AS_public:
3399       AccessSpec = '4';
3400     }
3401     if (Adjustment.Virtual.Microsoft.VBPtrOffset) {
3402       Out << 'R' << AccessSpec;
3403       Mangler.mangleNumber(
3404           static_cast<uint32_t>(Adjustment.Virtual.Microsoft.VBPtrOffset));
3405       Mangler.mangleNumber(
3406           static_cast<uint32_t>(Adjustment.Virtual.Microsoft.VBOffsetOffset));
3407       Mangler.mangleNumber(
3408           static_cast<uint32_t>(Adjustment.Virtual.Microsoft.VtordispOffset));
3409       Mangler.mangleNumber(static_cast<uint32_t>(Adjustment.NonVirtual));
3410     } else {
3411       Out << AccessSpec;
3412       Mangler.mangleNumber(
3413           static_cast<uint32_t>(Adjustment.Virtual.Microsoft.VtordispOffset));
3414       Mangler.mangleNumber(-static_cast<uint32_t>(Adjustment.NonVirtual));
3415     }
3416   } else if (Adjustment.NonVirtual != 0) {
3417     switch (AS) {
3418     case AS_none:
3419       llvm_unreachable("Unsupported access specifier");
3420     case AS_private:
3421       Out << 'G';
3422       break;
3423     case AS_protected:
3424       Out << 'O';
3425       break;
3426     case AS_public:
3427       Out << 'W';
3428     }
3429     Mangler.mangleNumber(-static_cast<uint32_t>(Adjustment.NonVirtual));
3430   } else {
3431     switch (AS) {
3432     case AS_none:
3433       llvm_unreachable("Unsupported access specifier");
3434     case AS_private:
3435       Out << 'A';
3436       break;
3437     case AS_protected:
3438       Out << 'I';
3439       break;
3440     case AS_public:
3441       Out << 'Q';
3442     }
3443   }
3444 }
3445 
mangleVirtualMemPtrThunk(const CXXMethodDecl * MD,const MethodVFTableLocation & ML,raw_ostream & Out)3446 void MicrosoftMangleContextImpl::mangleVirtualMemPtrThunk(
3447     const CXXMethodDecl *MD, const MethodVFTableLocation &ML,
3448     raw_ostream &Out) {
3449   msvc_hashing_ostream MHO(Out);
3450   MicrosoftCXXNameMangler Mangler(*this, MHO);
3451   Mangler.getStream() << '?';
3452   Mangler.mangleVirtualMemPtrThunk(MD, ML);
3453 }
3454 
mangleThunk(const CXXMethodDecl * MD,const ThunkInfo & Thunk,raw_ostream & Out)3455 void MicrosoftMangleContextImpl::mangleThunk(const CXXMethodDecl *MD,
3456                                              const ThunkInfo &Thunk,
3457                                              raw_ostream &Out) {
3458   msvc_hashing_ostream MHO(Out);
3459   MicrosoftCXXNameMangler Mangler(*this, MHO);
3460   Mangler.getStream() << '?';
3461   Mangler.mangleName(MD);
3462 
3463   // Usually the thunk uses the access specifier of the new method, but if this
3464   // is a covariant return thunk, then MSVC always uses the public access
3465   // specifier, and we do the same.
3466   AccessSpecifier AS = Thunk.Return.isEmpty() ? MD->getAccess() : AS_public;
3467   mangleThunkThisAdjustment(AS, Thunk.This, Mangler, MHO);
3468 
3469   if (!Thunk.Return.isEmpty())
3470     assert(Thunk.Method != nullptr &&
3471            "Thunk info should hold the overridee decl");
3472 
3473   const CXXMethodDecl *DeclForFPT = Thunk.Method ? Thunk.Method : MD;
3474   Mangler.mangleFunctionType(
3475       DeclForFPT->getType()->castAs<FunctionProtoType>(), MD);
3476 }
3477 
mangleCXXDtorThunk(const CXXDestructorDecl * DD,CXXDtorType Type,const ThisAdjustment & Adjustment,raw_ostream & Out)3478 void MicrosoftMangleContextImpl::mangleCXXDtorThunk(
3479     const CXXDestructorDecl *DD, CXXDtorType Type,
3480     const ThisAdjustment &Adjustment, raw_ostream &Out) {
3481   // FIXME: Actually, the dtor thunk should be emitted for vector deleting
3482   // dtors rather than scalar deleting dtors. Just use the vector deleting dtor
3483   // mangling manually until we support both deleting dtor types.
3484   assert(Type == Dtor_Deleting);
3485   msvc_hashing_ostream MHO(Out);
3486   MicrosoftCXXNameMangler Mangler(*this, MHO, DD, Type);
3487   Mangler.getStream() << "??_E";
3488   Mangler.mangleName(DD->getParent());
3489   mangleThunkThisAdjustment(DD->getAccess(), Adjustment, Mangler, MHO);
3490   Mangler.mangleFunctionType(DD->getType()->castAs<FunctionProtoType>(), DD);
3491 }
3492 
mangleCXXVFTable(const CXXRecordDecl * Derived,ArrayRef<const CXXRecordDecl * > BasePath,raw_ostream & Out)3493 void MicrosoftMangleContextImpl::mangleCXXVFTable(
3494     const CXXRecordDecl *Derived, ArrayRef<const CXXRecordDecl *> BasePath,
3495     raw_ostream &Out) {
3496   // <mangled-name> ::= ?_7 <class-name> <storage-class>
3497   //                    <cvr-qualifiers> [<name>] @
3498   // NOTE: <cvr-qualifiers> here is always 'B' (const). <storage-class>
3499   // is always '6' for vftables.
3500   msvc_hashing_ostream MHO(Out);
3501   MicrosoftCXXNameMangler Mangler(*this, MHO);
3502   if (Derived->hasAttr<DLLImportAttr>())
3503     Mangler.getStream() << "??_S";
3504   else
3505     Mangler.getStream() << "??_7";
3506   Mangler.mangleName(Derived);
3507   Mangler.getStream() << "6B"; // '6' for vftable, 'B' for const.
3508   for (const CXXRecordDecl *RD : BasePath)
3509     Mangler.mangleName(RD);
3510   Mangler.getStream() << '@';
3511 }
3512 
mangleCXXVBTable(const CXXRecordDecl * Derived,ArrayRef<const CXXRecordDecl * > BasePath,raw_ostream & Out)3513 void MicrosoftMangleContextImpl::mangleCXXVBTable(
3514     const CXXRecordDecl *Derived, ArrayRef<const CXXRecordDecl *> BasePath,
3515     raw_ostream &Out) {
3516   // <mangled-name> ::= ?_8 <class-name> <storage-class>
3517   //                    <cvr-qualifiers> [<name>] @
3518   // NOTE: <cvr-qualifiers> here is always 'B' (const). <storage-class>
3519   // is always '7' for vbtables.
3520   msvc_hashing_ostream MHO(Out);
3521   MicrosoftCXXNameMangler Mangler(*this, MHO);
3522   Mangler.getStream() << "??_8";
3523   Mangler.mangleName(Derived);
3524   Mangler.getStream() << "7B";  // '7' for vbtable, 'B' for const.
3525   for (const CXXRecordDecl *RD : BasePath)
3526     Mangler.mangleName(RD);
3527   Mangler.getStream() << '@';
3528 }
3529 
mangleCXXRTTI(QualType T,raw_ostream & Out)3530 void MicrosoftMangleContextImpl::mangleCXXRTTI(QualType T, raw_ostream &Out) {
3531   msvc_hashing_ostream MHO(Out);
3532   MicrosoftCXXNameMangler Mangler(*this, MHO);
3533   Mangler.getStream() << "??_R0";
3534   Mangler.mangleType(T, SourceRange(), MicrosoftCXXNameMangler::QMM_Result);
3535   Mangler.getStream() << "@8";
3536 }
3537 
mangleCXXRTTIName(QualType T,raw_ostream & Out)3538 void MicrosoftMangleContextImpl::mangleCXXRTTIName(QualType T,
3539                                                    raw_ostream &Out) {
3540   MicrosoftCXXNameMangler Mangler(*this, Out);
3541   Mangler.getStream() << '.';
3542   Mangler.mangleType(T, SourceRange(), MicrosoftCXXNameMangler::QMM_Result);
3543 }
3544 
mangleCXXVirtualDisplacementMap(const CXXRecordDecl * SrcRD,const CXXRecordDecl * DstRD,raw_ostream & Out)3545 void MicrosoftMangleContextImpl::mangleCXXVirtualDisplacementMap(
3546     const CXXRecordDecl *SrcRD, const CXXRecordDecl *DstRD, raw_ostream &Out) {
3547   msvc_hashing_ostream MHO(Out);
3548   MicrosoftCXXNameMangler Mangler(*this, MHO);
3549   Mangler.getStream() << "??_K";
3550   Mangler.mangleName(SrcRD);
3551   Mangler.getStream() << "$C";
3552   Mangler.mangleName(DstRD);
3553 }
3554 
mangleCXXThrowInfo(QualType T,bool IsConst,bool IsVolatile,bool IsUnaligned,uint32_t NumEntries,raw_ostream & Out)3555 void MicrosoftMangleContextImpl::mangleCXXThrowInfo(QualType T, bool IsConst,
3556                                                     bool IsVolatile,
3557                                                     bool IsUnaligned,
3558                                                     uint32_t NumEntries,
3559                                                     raw_ostream &Out) {
3560   msvc_hashing_ostream MHO(Out);
3561   MicrosoftCXXNameMangler Mangler(*this, MHO);
3562   Mangler.getStream() << "_TI";
3563   if (IsConst)
3564     Mangler.getStream() << 'C';
3565   if (IsVolatile)
3566     Mangler.getStream() << 'V';
3567   if (IsUnaligned)
3568     Mangler.getStream() << 'U';
3569   Mangler.getStream() << NumEntries;
3570   Mangler.mangleType(T, SourceRange(), MicrosoftCXXNameMangler::QMM_Result);
3571 }
3572 
mangleCXXCatchableTypeArray(QualType T,uint32_t NumEntries,raw_ostream & Out)3573 void MicrosoftMangleContextImpl::mangleCXXCatchableTypeArray(
3574     QualType T, uint32_t NumEntries, raw_ostream &Out) {
3575   msvc_hashing_ostream MHO(Out);
3576   MicrosoftCXXNameMangler Mangler(*this, MHO);
3577   Mangler.getStream() << "_CTA";
3578   Mangler.getStream() << NumEntries;
3579   Mangler.mangleType(T, SourceRange(), MicrosoftCXXNameMangler::QMM_Result);
3580 }
3581 
mangleCXXCatchableType(QualType T,const CXXConstructorDecl * CD,CXXCtorType CT,uint32_t Size,uint32_t NVOffset,int32_t VBPtrOffset,uint32_t VBIndex,raw_ostream & Out)3582 void MicrosoftMangleContextImpl::mangleCXXCatchableType(
3583     QualType T, const CXXConstructorDecl *CD, CXXCtorType CT, uint32_t Size,
3584     uint32_t NVOffset, int32_t VBPtrOffset, uint32_t VBIndex,
3585     raw_ostream &Out) {
3586   MicrosoftCXXNameMangler Mangler(*this, Out);
3587   Mangler.getStream() << "_CT";
3588 
3589   llvm::SmallString<64> RTTIMangling;
3590   {
3591     llvm::raw_svector_ostream Stream(RTTIMangling);
3592     msvc_hashing_ostream MHO(Stream);
3593     mangleCXXRTTI(T, MHO);
3594   }
3595   Mangler.getStream() << RTTIMangling;
3596 
3597   // VS2015 and VS2017.1 omit the copy-constructor in the mangled name but
3598   // both older and newer versions include it.
3599   // FIXME: It is known that the Ctor is present in 2013, and in 2017.7
3600   // (_MSC_VER 1914) and newer, and that it's omitted in 2015 and 2017.4
3601   // (_MSC_VER 1911), but it's unknown when exactly it reappeared (1914?
3602   // Or 1912, 1913 aleady?).
3603   bool OmitCopyCtor = getASTContext().getLangOpts().isCompatibleWithMSVC(
3604                           LangOptions::MSVC2015) &&
3605                       !getASTContext().getLangOpts().isCompatibleWithMSVC(
3606                           LangOptions::MSVC2017_7);
3607   llvm::SmallString<64> CopyCtorMangling;
3608   if (!OmitCopyCtor && CD) {
3609     llvm::raw_svector_ostream Stream(CopyCtorMangling);
3610     msvc_hashing_ostream MHO(Stream);
3611     mangleCXXName(GlobalDecl(CD, CT), MHO);
3612   }
3613   Mangler.getStream() << CopyCtorMangling;
3614 
3615   Mangler.getStream() << Size;
3616   if (VBPtrOffset == -1) {
3617     if (NVOffset) {
3618       Mangler.getStream() << NVOffset;
3619     }
3620   } else {
3621     Mangler.getStream() << NVOffset;
3622     Mangler.getStream() << VBPtrOffset;
3623     Mangler.getStream() << VBIndex;
3624   }
3625 }
3626 
mangleCXXRTTIBaseClassDescriptor(const CXXRecordDecl * Derived,uint32_t NVOffset,int32_t VBPtrOffset,uint32_t VBTableOffset,uint32_t Flags,raw_ostream & Out)3627 void MicrosoftMangleContextImpl::mangleCXXRTTIBaseClassDescriptor(
3628     const CXXRecordDecl *Derived, uint32_t NVOffset, int32_t VBPtrOffset,
3629     uint32_t VBTableOffset, uint32_t Flags, raw_ostream &Out) {
3630   msvc_hashing_ostream MHO(Out);
3631   MicrosoftCXXNameMangler Mangler(*this, MHO);
3632   Mangler.getStream() << "??_R1";
3633   Mangler.mangleNumber(NVOffset);
3634   Mangler.mangleNumber(VBPtrOffset);
3635   Mangler.mangleNumber(VBTableOffset);
3636   Mangler.mangleNumber(Flags);
3637   Mangler.mangleName(Derived);
3638   Mangler.getStream() << "8";
3639 }
3640 
mangleCXXRTTIBaseClassArray(const CXXRecordDecl * Derived,raw_ostream & Out)3641 void MicrosoftMangleContextImpl::mangleCXXRTTIBaseClassArray(
3642     const CXXRecordDecl *Derived, raw_ostream &Out) {
3643   msvc_hashing_ostream MHO(Out);
3644   MicrosoftCXXNameMangler Mangler(*this, MHO);
3645   Mangler.getStream() << "??_R2";
3646   Mangler.mangleName(Derived);
3647   Mangler.getStream() << "8";
3648 }
3649 
mangleCXXRTTIClassHierarchyDescriptor(const CXXRecordDecl * Derived,raw_ostream & Out)3650 void MicrosoftMangleContextImpl::mangleCXXRTTIClassHierarchyDescriptor(
3651     const CXXRecordDecl *Derived, raw_ostream &Out) {
3652   msvc_hashing_ostream MHO(Out);
3653   MicrosoftCXXNameMangler Mangler(*this, MHO);
3654   Mangler.getStream() << "??_R3";
3655   Mangler.mangleName(Derived);
3656   Mangler.getStream() << "8";
3657 }
3658 
mangleCXXRTTICompleteObjectLocator(const CXXRecordDecl * Derived,ArrayRef<const CXXRecordDecl * > BasePath,raw_ostream & Out)3659 void MicrosoftMangleContextImpl::mangleCXXRTTICompleteObjectLocator(
3660     const CXXRecordDecl *Derived, ArrayRef<const CXXRecordDecl *> BasePath,
3661     raw_ostream &Out) {
3662   // <mangled-name> ::= ?_R4 <class-name> <storage-class>
3663   //                    <cvr-qualifiers> [<name>] @
3664   // NOTE: <cvr-qualifiers> here is always 'B' (const). <storage-class>
3665   // is always '6' for vftables.
3666   llvm::SmallString<64> VFTableMangling;
3667   llvm::raw_svector_ostream Stream(VFTableMangling);
3668   mangleCXXVFTable(Derived, BasePath, Stream);
3669 
3670   if (VFTableMangling.startswith("??@")) {
3671     assert(VFTableMangling.endswith("@"));
3672     Out << VFTableMangling << "??_R4@";
3673     return;
3674   }
3675 
3676   assert(VFTableMangling.startswith("??_7") ||
3677          VFTableMangling.startswith("??_S"));
3678 
3679   Out << "??_R4" << StringRef(VFTableMangling).drop_front(4);
3680 }
3681 
mangleSEHFilterExpression(const NamedDecl * EnclosingDecl,raw_ostream & Out)3682 void MicrosoftMangleContextImpl::mangleSEHFilterExpression(
3683     const NamedDecl *EnclosingDecl, raw_ostream &Out) {
3684   msvc_hashing_ostream MHO(Out);
3685   MicrosoftCXXNameMangler Mangler(*this, MHO);
3686   // The function body is in the same comdat as the function with the handler,
3687   // so the numbering here doesn't have to be the same across TUs.
3688   //
3689   // <mangled-name> ::= ?filt$ <filter-number> @0
3690   Mangler.getStream() << "?filt$" << SEHFilterIds[EnclosingDecl]++ << "@0@";
3691   Mangler.mangleName(EnclosingDecl);
3692 }
3693 
mangleSEHFinallyBlock(const NamedDecl * EnclosingDecl,raw_ostream & Out)3694 void MicrosoftMangleContextImpl::mangleSEHFinallyBlock(
3695     const NamedDecl *EnclosingDecl, raw_ostream &Out) {
3696   msvc_hashing_ostream MHO(Out);
3697   MicrosoftCXXNameMangler Mangler(*this, MHO);
3698   // The function body is in the same comdat as the function with the handler,
3699   // so the numbering here doesn't have to be the same across TUs.
3700   //
3701   // <mangled-name> ::= ?fin$ <filter-number> @0
3702   Mangler.getStream() << "?fin$" << SEHFinallyIds[EnclosingDecl]++ << "@0@";
3703   Mangler.mangleName(EnclosingDecl);
3704 }
3705 
mangleTypeName(QualType T,raw_ostream & Out)3706 void MicrosoftMangleContextImpl::mangleTypeName(QualType T, raw_ostream &Out) {
3707   // This is just a made up unique string for the purposes of tbaa.  undname
3708   // does *not* know how to demangle it.
3709   MicrosoftCXXNameMangler Mangler(*this, Out);
3710   Mangler.getStream() << '?';
3711   Mangler.mangleType(T, SourceRange());
3712 }
3713 
mangleReferenceTemporary(const VarDecl * VD,unsigned ManglingNumber,raw_ostream & Out)3714 void MicrosoftMangleContextImpl::mangleReferenceTemporary(
3715     const VarDecl *VD, unsigned ManglingNumber, raw_ostream &Out) {
3716   msvc_hashing_ostream MHO(Out);
3717   MicrosoftCXXNameMangler Mangler(*this, MHO);
3718 
3719   Mangler.getStream() << "?$RT" << ManglingNumber << '@';
3720   Mangler.mangle(VD, "");
3721 }
3722 
mangleThreadSafeStaticGuardVariable(const VarDecl * VD,unsigned GuardNum,raw_ostream & Out)3723 void MicrosoftMangleContextImpl::mangleThreadSafeStaticGuardVariable(
3724     const VarDecl *VD, unsigned GuardNum, raw_ostream &Out) {
3725   msvc_hashing_ostream MHO(Out);
3726   MicrosoftCXXNameMangler Mangler(*this, MHO);
3727 
3728   Mangler.getStream() << "?$TSS" << GuardNum << '@';
3729   Mangler.mangleNestedName(VD);
3730   Mangler.getStream() << "@4HA";
3731 }
3732 
mangleStaticGuardVariable(const VarDecl * VD,raw_ostream & Out)3733 void MicrosoftMangleContextImpl::mangleStaticGuardVariable(const VarDecl *VD,
3734                                                            raw_ostream &Out) {
3735   // <guard-name> ::= ?_B <postfix> @5 <scope-depth>
3736   //              ::= ?__J <postfix> @5 <scope-depth>
3737   //              ::= ?$S <guard-num> @ <postfix> @4IA
3738 
3739   // The first mangling is what MSVC uses to guard static locals in inline
3740   // functions.  It uses a different mangling in external functions to support
3741   // guarding more than 32 variables.  MSVC rejects inline functions with more
3742   // than 32 static locals.  We don't fully implement the second mangling
3743   // because those guards are not externally visible, and instead use LLVM's
3744   // default renaming when creating a new guard variable.
3745   msvc_hashing_ostream MHO(Out);
3746   MicrosoftCXXNameMangler Mangler(*this, MHO);
3747 
3748   bool Visible = VD->isExternallyVisible();
3749   if (Visible) {
3750     Mangler.getStream() << (VD->getTLSKind() ? "??__J" : "??_B");
3751   } else {
3752     Mangler.getStream() << "?$S1@";
3753   }
3754   unsigned ScopeDepth = 0;
3755   if (Visible && !getNextDiscriminator(VD, ScopeDepth))
3756     // If we do not have a discriminator and are emitting a guard variable for
3757     // use at global scope, then mangling the nested name will not be enough to
3758     // remove ambiguities.
3759     Mangler.mangle(VD, "");
3760   else
3761     Mangler.mangleNestedName(VD);
3762   Mangler.getStream() << (Visible ? "@5" : "@4IA");
3763   if (ScopeDepth)
3764     Mangler.mangleNumber(ScopeDepth);
3765 }
3766 
mangleInitFiniStub(const VarDecl * D,char CharCode,raw_ostream & Out)3767 void MicrosoftMangleContextImpl::mangleInitFiniStub(const VarDecl *D,
3768                                                     char CharCode,
3769                                                     raw_ostream &Out) {
3770   msvc_hashing_ostream MHO(Out);
3771   MicrosoftCXXNameMangler Mangler(*this, MHO);
3772   Mangler.getStream() << "??__" << CharCode;
3773   if (D->isStaticDataMember()) {
3774     Mangler.getStream() << '?';
3775     Mangler.mangleName(D);
3776     Mangler.mangleVariableEncoding(D);
3777     Mangler.getStream() << "@@";
3778   } else {
3779     Mangler.mangleName(D);
3780   }
3781   // This is the function class mangling.  These stubs are global, non-variadic,
3782   // cdecl functions that return void and take no args.
3783   Mangler.getStream() << "YAXXZ";
3784 }
3785 
mangleDynamicInitializer(const VarDecl * D,raw_ostream & Out)3786 void MicrosoftMangleContextImpl::mangleDynamicInitializer(const VarDecl *D,
3787                                                           raw_ostream &Out) {
3788   // <initializer-name> ::= ?__E <name> YAXXZ
3789   mangleInitFiniStub(D, 'E', Out);
3790 }
3791 
3792 void
mangleDynamicAtExitDestructor(const VarDecl * D,raw_ostream & Out)3793 MicrosoftMangleContextImpl::mangleDynamicAtExitDestructor(const VarDecl *D,
3794                                                           raw_ostream &Out) {
3795   // <destructor-name> ::= ?__F <name> YAXXZ
3796   mangleInitFiniStub(D, 'F', Out);
3797 }
3798 
mangleStringLiteral(const StringLiteral * SL,raw_ostream & Out)3799 void MicrosoftMangleContextImpl::mangleStringLiteral(const StringLiteral *SL,
3800                                                      raw_ostream &Out) {
3801   // <char-type> ::= 0   # char, char16_t, char32_t
3802   //                     # (little endian char data in mangling)
3803   //             ::= 1   # wchar_t (big endian char data in mangling)
3804   //
3805   // <literal-length> ::= <non-negative integer>  # the length of the literal
3806   //
3807   // <encoded-crc>    ::= <hex digit>+ @          # crc of the literal including
3808   //                                              # trailing null bytes
3809   //
3810   // <encoded-string> ::= <simple character>           # uninteresting character
3811   //                  ::= '?$' <hex digit> <hex digit> # these two nibbles
3812   //                                                   # encode the byte for the
3813   //                                                   # character
3814   //                  ::= '?' [a-z]                    # \xe1 - \xfa
3815   //                  ::= '?' [A-Z]                    # \xc1 - \xda
3816   //                  ::= '?' [0-9]                    # [,/\:. \n\t'-]
3817   //
3818   // <literal> ::= '??_C@_' <char-type> <literal-length> <encoded-crc>
3819   //               <encoded-string> '@'
3820   MicrosoftCXXNameMangler Mangler(*this, Out);
3821   Mangler.getStream() << "??_C@_";
3822 
3823   // The actual string length might be different from that of the string literal
3824   // in cases like:
3825   // char foo[3] = "foobar";
3826   // char bar[42] = "foobar";
3827   // Where it is truncated or zero-padded to fit the array. This is the length
3828   // used for mangling, and any trailing null-bytes also need to be mangled.
3829   unsigned StringLength = getASTContext()
3830                               .getAsConstantArrayType(SL->getType())
3831                               ->getSize()
3832                               .getZExtValue();
3833   unsigned StringByteLength = StringLength * SL->getCharByteWidth();
3834 
3835   // <char-type>: The "kind" of string literal is encoded into the mangled name.
3836   if (SL->isWide())
3837     Mangler.getStream() << '1';
3838   else
3839     Mangler.getStream() << '0';
3840 
3841   // <literal-length>: The next part of the mangled name consists of the length
3842   // of the string in bytes.
3843   Mangler.mangleNumber(StringByteLength);
3844 
3845   auto GetLittleEndianByte = [&SL](unsigned Index) {
3846     unsigned CharByteWidth = SL->getCharByteWidth();
3847     if (Index / CharByteWidth >= SL->getLength())
3848       return static_cast<char>(0);
3849     uint32_t CodeUnit = SL->getCodeUnit(Index / CharByteWidth);
3850     unsigned OffsetInCodeUnit = Index % CharByteWidth;
3851     return static_cast<char>((CodeUnit >> (8 * OffsetInCodeUnit)) & 0xff);
3852   };
3853 
3854   auto GetBigEndianByte = [&SL](unsigned Index) {
3855     unsigned CharByteWidth = SL->getCharByteWidth();
3856     if (Index / CharByteWidth >= SL->getLength())
3857       return static_cast<char>(0);
3858     uint32_t CodeUnit = SL->getCodeUnit(Index / CharByteWidth);
3859     unsigned OffsetInCodeUnit = (CharByteWidth - 1) - (Index % CharByteWidth);
3860     return static_cast<char>((CodeUnit >> (8 * OffsetInCodeUnit)) & 0xff);
3861   };
3862 
3863   // CRC all the bytes of the StringLiteral.
3864   llvm::JamCRC JC;
3865   for (unsigned I = 0, E = StringByteLength; I != E; ++I)
3866     JC.update(GetLittleEndianByte(I));
3867 
3868   // <encoded-crc>: The CRC is encoded utilizing the standard number mangling
3869   // scheme.
3870   Mangler.mangleNumber(JC.getCRC());
3871 
3872   // <encoded-string>: The mangled name also contains the first 32 bytes
3873   // (including null-terminator bytes) of the encoded StringLiteral.
3874   // Each character is encoded by splitting them into bytes and then encoding
3875   // the constituent bytes.
3876   auto MangleByte = [&Mangler](char Byte) {
3877     // There are five different manglings for characters:
3878     // - [a-zA-Z0-9_$]: A one-to-one mapping.
3879     // - ?[a-z]: The range from \xe1 to \xfa.
3880     // - ?[A-Z]: The range from \xc1 to \xda.
3881     // - ?[0-9]: The set of [,/\:. \n\t'-].
3882     // - ?$XX: A fallback which maps nibbles.
3883     if (isIdentifierBody(Byte, /*AllowDollar=*/true)) {
3884       Mangler.getStream() << Byte;
3885     } else if (isLetter(Byte & 0x7f)) {
3886       Mangler.getStream() << '?' << static_cast<char>(Byte & 0x7f);
3887     } else {
3888       const char SpecialChars[] = {',', '/',  '\\', ':',  '.',
3889                                    ' ', '\n', '\t', '\'', '-'};
3890       const char *Pos = llvm::find(SpecialChars, Byte);
3891       if (Pos != std::end(SpecialChars)) {
3892         Mangler.getStream() << '?' << (Pos - std::begin(SpecialChars));
3893       } else {
3894         Mangler.getStream() << "?$";
3895         Mangler.getStream() << static_cast<char>('A' + ((Byte >> 4) & 0xf));
3896         Mangler.getStream() << static_cast<char>('A' + (Byte & 0xf));
3897       }
3898     }
3899   };
3900 
3901   // Enforce our 32 bytes max, except wchar_t which gets 32 chars instead.
3902   unsigned MaxBytesToMangle = SL->isWide() ? 64U : 32U;
3903   unsigned NumBytesToMangle = std::min(MaxBytesToMangle, StringByteLength);
3904   for (unsigned I = 0; I != NumBytesToMangle; ++I) {
3905     if (SL->isWide())
3906       MangleByte(GetBigEndianByte(I));
3907     else
3908       MangleByte(GetLittleEndianByte(I));
3909   }
3910 
3911   Mangler.getStream() << '@';
3912 }
3913 
3914 MicrosoftMangleContext *
create(ASTContext & Context,DiagnosticsEngine & Diags)3915 MicrosoftMangleContext::create(ASTContext &Context, DiagnosticsEngine &Diags) {
3916   return new MicrosoftMangleContextImpl(Context, Diags);
3917 }
3918