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