blob: af51ae07bc579fc339208f2a63d11c52c0362a71 [file] [log] [blame]
Guy Benyei11169dd2012-12-18 14:30:41 +00001//===--- MicrosoftMangle.cpp - Microsoft Visual C++ Name Mangling ---------===//
2//
Chandler Carruth2946cd72019-01-19 08:50:56 +00003// 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
Guy Benyei11169dd2012-12-18 14:30:41 +00006//
7//===----------------------------------------------------------------------===//
8//
9// This provides C++ name mangling targeting the Microsoft Visual C++ ABI.
10//
11//===----------------------------------------------------------------------===//
12
Guy Benyei11169dd2012-12-18 14:30:41 +000013#include "clang/AST/ASTContext.h"
14#include "clang/AST/Attr.h"
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +000015#include "clang/AST/CXXInheritance.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000016#include "clang/AST/CharUnits.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000017#include "clang/AST/Decl.h"
18#include "clang/AST/DeclCXX.h"
19#include "clang/AST/DeclObjC.h"
Alexey Bataev94a4f0c2016-03-03 05:21:39 +000020#include "clang/AST/DeclOpenMP.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000021#include "clang/AST/DeclTemplate.h"
David Majnemer58e5bee2014-03-24 21:43:36 +000022#include "clang/AST/Expr.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000023#include "clang/AST/ExprCXX.h"
Reid Kleckner86565c12020-02-27 11:01:58 -080024#include "clang/AST/Mangle.h"
Reid Kleckner96f8f932014-02-05 17:27:08 +000025#include "clang/AST/VTableBuilder.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000026#include "clang/Basic/ABI.h"
27#include "clang/Basic/DiagnosticOptions.h"
Reid Klecknere08464f2020-02-29 09:10:42 -080028#include "clang/Basic/FileManager.h"
Reid Kleckner86565c12020-02-27 11:01:58 -080029#include "clang/Basic/SourceManager.h"
Reid Kleckner369f3162013-05-14 20:30:42 +000030#include "clang/Basic/TargetInfo.h"
David Majnemer2206bf52014-03-05 08:57:59 +000031#include "llvm/ADT/StringExtras.h"
Hans Wennborg1e1e3ba2019-10-09 09:06:30 +000032#include "llvm/Support/CRC.h"
David Majnemerfebb2722016-03-07 08:51:17 +000033#include "llvm/Support/MD5.h"
34#include "llvm/Support/MathExtras.h"
Nico Weber48707762019-06-04 23:27:40 +000035#include "llvm/Support/StringSaver.h"
Hans Wennborg1e1e3ba2019-10-09 09:06:30 +000036#include "llvm/Support/xxhash.h"
David Majnemer3843a052014-03-23 17:47:16 +000037
Guy Benyei11169dd2012-12-18 14:30:41 +000038using namespace clang;
39
40namespace {
41
David Majnemerfebb2722016-03-07 08:51:17 +000042struct msvc_hashing_ostream : public llvm::raw_svector_ostream {
43 raw_ostream &OS;
44 llvm::SmallString<64> Buffer;
45
46 msvc_hashing_ostream(raw_ostream &OS)
47 : llvm::raw_svector_ostream(Buffer), OS(OS) {}
48 ~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
David Majnemer984498f2016-12-06 17:01:02 +000072static const DeclContext *
73getLambdaDefaultArgumentDeclContext(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
Adrian Prantl9fc8faf2018-05-09 01:00:01 +000082/// Retrieve the declaration context that should be used when mangling
David Majnemerd5a42b82013-09-13 09:03:14 +000083/// the given declaration.
84static 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.
David Majnemer984498f2016-12-06 17:01:02 +000091 if (const auto *LDADC = getLambdaDefaultArgumentDeclContext(D))
92 return LDADC;
David Majnemerd5a42b82013-09-13 09:03:14 +000093
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();
Michael Kruse251e1482019-02-01 20:25:04 +0000102 if (isa<CapturedDecl>(DC) || isa<OMPDeclareReductionDecl>(DC) ||
103 isa<OMPDeclareMapperDecl>(DC)) {
Alexey Bataev94a4f0c2016-03-03 05:21:39 +0000104 return getEffectiveDeclContext(cast<Decl>(DC));
105 }
David Majnemerd5a42b82013-09-13 09:03:14 +0000106
David Majnemerb0f1dbd2016-05-19 18:15:53 +0000107 return DC->getRedeclContext();
David Majnemerd5a42b82013-09-13 09:03:14 +0000108}
109
110static const DeclContext *getEffectiveParentContext(const DeclContext *DC) {
111 return getEffectiveDeclContext(cast<Decl>(DC));
112}
113
David Majnemerdfa6d202015-03-11 18:36:39 +0000114static const FunctionDecl *getStructor(const NamedDecl *ND) {
115 if (const auto *FTD = dyn_cast<FunctionTemplateDecl>(ND))
Reid Kleckner290feb92017-01-09 17:04:37 +0000116 return FTD->getTemplatedDecl()->getCanonicalDecl();
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +0000117
David Majnemerdfa6d202015-03-11 18:36:39 +0000118 const auto *FD = cast<FunctionDecl>(ND);
119 if (const auto *FTD = FD->getPrimaryTemplate())
Reid Kleckner290feb92017-01-09 17:04:37 +0000120 return FTD->getTemplatedDecl()->getCanonicalDecl();
David Majnemerdfa6d202015-03-11 18:36:39 +0000121
Reid Kleckner290feb92017-01-09 17:04:37 +0000122 return FD->getCanonicalDecl();
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +0000123}
124
Timur Iskhodzhanov67455222013-10-03 06:26:13 +0000125/// MicrosoftMangleContextImpl - Overrides the default MangleContext for the
Guy Benyei11169dd2012-12-18 14:30:41 +0000126/// Microsoft Visual C++ ABI.
Timur Iskhodzhanov67455222013-10-03 06:26:13 +0000127class MicrosoftMangleContextImpl : public MicrosoftMangleContext {
David Majnemer2206bf52014-03-05 08:57:59 +0000128 typedef std::pair<const DeclContext *, IdentifierInfo *> DiscriminatorKeyTy;
129 llvm::DenseMap<DiscriminatorKeyTy, unsigned> Discriminator;
David Majnemer02e9af42014-04-23 05:16:51 +0000130 llvm::DenseMap<const NamedDecl *, unsigned> Uniquifier;
David Majnemerf017ec32014-03-05 10:35:06 +0000131 llvm::DenseMap<const CXXRecordDecl *, unsigned> LambdaIds;
Reid Kleckner1d59f992015-01-22 01:36:17 +0000132 llvm::DenseMap<const NamedDecl *, unsigned> SEHFilterIds;
Reid Klecknerebaf28d2015-04-14 20:59:00 +0000133 llvm::DenseMap<const NamedDecl *, unsigned> SEHFinallyIds;
Reid Klecknerdf8dd612018-08-17 20:59:27 +0000134 SmallString<16> AnonymousNamespaceHash;
David Majnemer2206bf52014-03-05 08:57:59 +0000135
Guy Benyei11169dd2012-12-18 14:30:41 +0000136public:
Reid Klecknerdf8dd612018-08-17 20:59:27 +0000137 MicrosoftMangleContextImpl(ASTContext &Context, DiagnosticsEngine &Diags);
Craig Toppercbce6e92014-03-11 06:22:39 +0000138 bool shouldMangleCXXName(const NamedDecl *D) override;
David Majnemer58e5bee2014-03-24 21:43:36 +0000139 bool shouldMangleStringLiteral(const StringLiteral *SL) override;
Yaxun (Sam) Liu29e1a162020-03-05 12:02:13 -0500140 void mangleCXXName(GlobalDecl GD, raw_ostream &Out) override;
David Majnemer02e9af42014-04-23 05:16:51 +0000141 void mangleVirtualMemPtrThunk(const CXXMethodDecl *MD,
Reid Klecknercbec0262018-04-02 20:00:39 +0000142 const MethodVFTableLocation &ML,
143 raw_ostream &Out) override;
Craig Toppercbce6e92014-03-11 06:22:39 +0000144 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;
David Majnemerc1709d32015-06-23 07:31:11 +0000155 void mangleCXXVirtualDisplacementMap(const CXXRecordDecl *SrcRD,
156 const CXXRecordDecl *DstRD,
157 raw_ostream &Out) override;
David Majnemer7c237072015-03-05 00:46:22 +0000158 void mangleCXXThrowInfo(QualType T, bool IsConst, bool IsVolatile,
David Majnemer526793d2016-07-12 04:42:50 +0000159 bool IsUnaligned, uint32_t NumEntries,
160 raw_ostream &Out) override;
David Majnemer7c237072015-03-05 00:46:22 +0000161 void mangleCXXCatchableTypeArray(QualType T, uint32_t NumEntries,
162 raw_ostream &Out) override;
David Majnemere7a818f2015-03-06 18:53:55 +0000163 void mangleCXXCatchableType(QualType T, const CXXConstructorDecl *CD,
David Majnemerdfa6d202015-03-11 18:36:39 +0000164 CXXCtorType CT, uint32_t Size, uint32_t NVOffset,
David Majnemer999cbf92015-03-10 19:01:51 +0000165 int32_t VBPtrOffset, uint32_t VBIndex,
166 raw_ostream &Out) override;
David Majnemera96b7ee2014-05-13 00:44:44 +0000167 void mangleCXXRTTI(QualType T, raw_ostream &Out) override;
168 void mangleCXXRTTIName(QualType T, raw_ostream &Out) override;
David Majnemeraeb55c92014-05-13 06:57:43 +0000169 void mangleCXXRTTIBaseClassDescriptor(const CXXRecordDecl *Derived,
Warren Hunt5c2b4ea2014-05-23 16:07:43 +0000170 uint32_t NVOffset, int32_t VBPtrOffset,
David Majnemeraeb55c92014-05-13 06:57:43 +0000171 uint32_t VBTableOffset, uint32_t Flags,
172 raw_ostream &Out) override;
David Majnemera96b7ee2014-05-13 00:44:44 +0000173 void mangleCXXRTTIBaseClassArray(const CXXRecordDecl *Derived,
174 raw_ostream &Out) override;
175 void mangleCXXRTTIClassHierarchyDescriptor(const CXXRecordDecl *Derived,
176 raw_ostream &Out) override;
David Majnemeraeb55c92014-05-13 06:57:43 +0000177 void
178 mangleCXXRTTICompleteObjectLocator(const CXXRecordDecl *Derived,
179 ArrayRef<const CXXRecordDecl *> BasePath,
180 raw_ostream &Out) override;
Craig Toppercbce6e92014-03-11 06:22:39 +0000181 void mangleTypeName(QualType T, raw_ostream &) override;
David Majnemerdaff3702014-05-01 17:50:17 +0000182 void mangleReferenceTemporary(const VarDecl *, unsigned ManglingNumber,
183 raw_ostream &) override;
Craig Toppercbce6e92014-03-11 06:22:39 +0000184 void mangleStaticGuardVariable(const VarDecl *D, raw_ostream &Out) override;
David Majnemer8354eee2015-05-07 06:15:46 +0000185 void mangleThreadSafeStaticGuardVariable(const VarDecl *D, unsigned GuardNum,
186 raw_ostream &Out) override;
Craig Toppercbce6e92014-03-11 06:22:39 +0000187 void mangleDynamicInitializer(const VarDecl *D, raw_ostream &Out) override;
188 void mangleDynamicAtExitDestructor(const VarDecl *D,
189 raw_ostream &Out) override;
Reid Kleckner1d59f992015-01-22 01:36:17 +0000190 void mangleSEHFilterExpression(const NamedDecl *EnclosingDecl,
191 raw_ostream &Out) override;
Reid Klecknerebaf28d2015-04-14 20:59:00 +0000192 void mangleSEHFinallyBlock(const NamedDecl *EnclosingDecl,
193 raw_ostream &Out) override;
David Majnemer58e5bee2014-03-24 21:43:36 +0000194 void mangleStringLiteral(const StringLiteral *SL, raw_ostream &Out) override;
David Majnemer2206bf52014-03-05 08:57:59 +0000195 bool getNextDiscriminator(const NamedDecl *ND, unsigned &disc) {
David Majnemer2206bf52014-03-05 08:57:59 +0000196 const DeclContext *DC = getEffectiveDeclContext(ND);
197 if (!DC->isFunctionOrMethod())
198 return false;
199
David Majnemer41311192016-01-17 07:09:24 +0000200 // Lambda closure types are already numbered, give out a phony number so
201 // that they demangle nicely.
David Majnemer984498f2016-12-06 17:01:02 +0000202 if (const auto *RD = dyn_cast<CXXRecordDecl>(ND)) {
203 if (RD->isLambda()) {
204 disc = 1;
205 return true;
206 }
David Majnemer41311192016-01-17 07:09:24 +0000207 }
208
David Majnemer2206bf52014-03-05 08:57:59 +0000209 // 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)) {
David Majnemerb33cd902015-09-02 15:50:38 +0000217 if (!Tag->hasNameForLinkage() &&
218 !getASTContext().getDeclaratorForUnnamedTagDecl(Tag) &&
219 !getASTContext().getTypedefNameForUnnamedTagDecl(Tag))
David Majnemer2206bf52014-03-05 08:57:59 +0000220 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())];
David Majnemer040fa342014-10-05 06:44:53 +0000227 disc = discriminator + 1;
David Majnemer2206bf52014-03-05 08:57:59 +0000228 return true;
229 }
Reid Kleckner1ece9fc2013-09-10 20:43:12 +0000230
David Majnemerf017ec32014-03-05 10:35:06 +0000231 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
Reid Klecknerdf8dd612018-08-17 20:59:27 +0000241 /// Return a character sequence that is (somewhat) unique to the TU suitable
242 /// for mangling anonymous namespaces.
243 StringRef getAnonymousNamespaceHash() const {
244 return AnonymousNamespaceHash;
245 }
246
Reid Kleckner1ece9fc2013-09-10 20:43:12 +0000247private:
David Majnemerfebb2722016-03-07 08:51:17 +0000248 void mangleInitFiniStub(const VarDecl *D, char CharCode, raw_ostream &Out);
Guy Benyei11169dd2012-12-18 14:30:41 +0000249};
250
David Majnemer2206bf52014-03-05 08:57:59 +0000251/// MicrosoftCXXNameMangler - Manage the mangling of a single name for the
252/// Microsoft Visual C++ ABI.
253class 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
David Majnemer0d0560c2014-09-25 19:43:56 +0000263 typedef llvm::SmallVector<std::string, 10> BackRefVec;
264 BackRefVec NameBackReferences;
David Majnemer2206bf52014-03-05 08:57:59 +0000265
David Majnemer622abd12015-12-31 05:36:52 +0000266 typedef llvm::DenseMap<const void *, unsigned> ArgBackRefMap;
Nico Weber73f05842019-06-01 10:12:07 +0000267 ArgBackRefMap FunArgBackReferences;
268 ArgBackRefMap TemplateArgBackReferences;
David Majnemer2206bf52014-03-05 08:57:59 +0000269
Nico Weber48707762019-06-04 23:27:40 +0000270 typedef llvm::DenseMap<const void *, StringRef> TemplateArgStringMap;
271 TemplateArgStringMap TemplateArgStrings;
272 llvm::StringSaver TemplateArgStringStorage;
273 llvm::BumpPtrAllocator TemplateArgStringStorageAlloc;
274
Erik Pilkington02d5fb12019-03-19 20:44:18 +0000275 typedef std::set<std::pair<int, bool>> PassObjectSizeArgsSet;
David Majnemer5f177622015-12-30 05:13:03 +0000276 PassObjectSizeArgsSet PassObjectSizeArgs;
277
David Majnemer2206bf52014-03-05 08:57:59 +0000278 ASTContext &getASTContext() const { return Context.getASTContext(); }
279
David Majnemer2206bf52014-03-05 08:57:59 +0000280 const bool PointersAre64Bit;
281
282public:
283 enum QualifierMangleMode { QMM_Drop, QMM_Mangle, QMM_Escape, QMM_Result };
284
285 MicrosoftCXXNameMangler(MicrosoftMangleContextImpl &C, raw_ostream &Out_)
Craig Topper36250ad2014-05-12 05:36:57 +0000286 : Context(C), Out(Out_), Structor(nullptr), StructorType(-1),
Nico Weber48707762019-06-04 23:27:40 +0000287 TemplateArgStringStorage(TemplateArgStringStorageAlloc),
David Majnemer02e9af42014-04-23 05:16:51 +0000288 PointersAre64Bit(C.getASTContext().getTargetInfo().getPointerWidth(0) ==
289 64) {}
David Majnemer2206bf52014-03-05 08:57:59 +0000290
291 MicrosoftCXXNameMangler(MicrosoftMangleContextImpl &C, raw_ostream &Out_,
David Majnemerdfa6d202015-03-11 18:36:39 +0000292 const CXXConstructorDecl *D, CXXCtorType Type)
293 : Context(C), Out(Out_), Structor(getStructor(D)), StructorType(Type),
Nico Weber48707762019-06-04 23:27:40 +0000294 TemplateArgStringStorage(TemplateArgStringStorageAlloc),
David Majnemerdfa6d202015-03-11 18:36:39 +0000295 PointersAre64Bit(C.getASTContext().getTargetInfo().getPointerWidth(0) ==
296 64) {}
297
298 MicrosoftCXXNameMangler(MicrosoftMangleContextImpl &C, raw_ostream &Out_,
David Majnemer2206bf52014-03-05 08:57:59 +0000299 const CXXDestructorDecl *D, CXXDtorType Type)
David Majnemer02e9af42014-04-23 05:16:51 +0000300 : Context(C), Out(Out_), Structor(getStructor(D)), StructorType(Type),
Nico Weber48707762019-06-04 23:27:40 +0000301 TemplateArgStringStorage(TemplateArgStringStorageAlloc),
David Majnemer02e9af42014-04-23 05:16:51 +0000302 PointersAre64Bit(C.getASTContext().getTargetInfo().getPointerWidth(0) ==
303 64) {}
David Majnemer2206bf52014-03-05 08:57:59 +0000304
305 raw_ostream &getStream() const { return Out; }
306
Reid Klecknerfb931542018-03-16 20:36:49 +0000307 void mangle(const NamedDecl *D, StringRef Prefix = "?");
David Majnemer2206bf52014-03-05 08:57:59 +0000308 void mangleName(const NamedDecl *ND);
David Majnemerab4b4a12015-05-18 00:05:25 +0000309 void mangleFunctionEncoding(const FunctionDecl *FD, bool ShouldMangle);
David Majnemer2206bf52014-03-05 08:57:59 +0000310 void mangleVariableEncoding(const VarDecl *VD);
311 void mangleMemberDataPointer(const CXXRecordDecl *RD, const ValueDecl *VD);
312 void mangleMemberFunctionPointer(const CXXRecordDecl *RD,
313 const CXXMethodDecl *MD);
Reid Klecknercbec0262018-04-02 20:00:39 +0000314 void mangleVirtualMemPtrThunk(const CXXMethodDecl *MD,
315 const MethodVFTableLocation &ML);
David Majnemer2206bf52014-03-05 08:57:59 +0000316 void mangleNumber(int64_t Number);
David Majnemer3add70b2015-12-29 11:45:53 +0000317 void mangleTagTypeKind(TagTypeKind TK);
Shoaib Meenaid84cf132018-11-14 19:16:22 +0000318 void mangleArtificialTagType(TagTypeKind TK, StringRef UnqualifiedName,
David Majnemer3add70b2015-12-29 11:45:53 +0000319 ArrayRef<StringRef> NestedNames = None);
Erich Keane24a0f042018-12-14 23:17:34 +0000320 void mangleAddressSpaceType(QualType T, Qualifiers Quals, SourceRange Range);
David Majnemer2206bf52014-03-05 08:57:59 +0000321 void mangleType(QualType T, SourceRange Range,
322 QualifierMangleMode QMM = QMM_Mangle);
Craig Topper36250ad2014-05-12 05:36:57 +0000323 void mangleFunctionType(const FunctionType *T,
324 const FunctionDecl *D = nullptr,
Reid Klecknerd2f98772018-12-17 23:10:43 +0000325 bool ForceThisQuals = false,
326 bool MangleExceptionSpec = true);
David Majnemer2206bf52014-03-05 08:57:59 +0000327 void mangleNestedName(const NamedDecl *ND);
328
329private:
Reid Kleckner290feb92017-01-09 17:04:37 +0000330 bool isStructorDecl(const NamedDecl *ND) const {
331 return ND == Structor || getStructor(ND) == Structor;
332 }
333
Amy Huanga85f5ef2019-10-24 16:34:25 -0700334 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
David Majnemer2206bf52014-03-05 08:57:59 +0000341 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);
David Majnemere3785bb2014-04-23 05:16:56 +0000349 void mangleRefQualifier(RefQualifierKind RefQualifier);
David Majnemer2206bf52014-03-05 08:57:59 +0000350 void manglePointerCVQualifiers(Qualifiers Quals);
David Majnemer7a3ce0c2015-05-26 01:30:45 +0000351 void manglePointerExtQualifiers(Qualifiers Quals, QualType PointeeType);
David Majnemer2206bf52014-03-05 08:57:59 +0000352
353 void mangleUnscopedTemplateName(const TemplateDecl *ND);
David Majnemer02e9af42014-04-23 05:16:51 +0000354 void
355 mangleTemplateInstantiationName(const TemplateDecl *TD,
356 const TemplateArgumentList &TemplateArgs);
David Majnemer2206bf52014-03-05 08:57:59 +0000357 void mangleObjCMethodName(const ObjCMethodDecl *MD);
358
Nico Weber73f05842019-06-01 10:12:07 +0000359 void mangleFunctionArgumentType(QualType T, SourceRange Range);
David Majnemer5f177622015-12-30 05:13:03 +0000360 void manglePassObjectSizeArg(const PassObjectSizeAttr *POSA);
David Majnemer2206bf52014-03-05 08:57:59 +0000361
Nico Weber3239f132018-07-23 20:04:00 +0000362 bool isArtificialTagType(QualType T) const;
363
David Majnemer2206bf52014-03-05 08:57:59 +0000364 // 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, \
David Majnemer7a3ce0c2015-05-26 01:30:45 +0000368 Qualifiers Quals, \
David Majnemer2206bf52014-03-05 08:57:59 +0000369 SourceRange Range);
John McCall36b12a82019-10-02 06:35:23 +0000370#include "clang/AST/TypeNodes.inc"
David Majnemer2206bf52014-03-05 08:57:59 +0000371#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);
David Majnemerdfa6d202015-03-11 18:36:39 +0000379 void mangleCallingConvention(CallingConv CC);
David Majnemer2206bf52014-03-05 08:57:59 +0000380 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);
David Majnemer57fbc0c2014-08-05 22:43:45 +0000387 void mangleTemplateArg(const TemplateDecl *TD, const TemplateArgument &TA,
388 const NamedDecl *Parm);
Saleem Abdulrasoolbbce34a2018-02-09 03:23:54 +0000389
390 void mangleObjCProtocol(const ObjCProtocolDecl *PD);
391 void mangleObjCLifetime(const QualType T, Qualifiers Quals,
392 SourceRange Range);
Saleem Abdulrasoolf3a981e2018-09-28 16:47:53 +0000393 void mangleObjCKindOfType(const ObjCObjectType *T, Qualifiers Quals,
394 SourceRange Range);
David Majnemer2206bf52014-03-05 08:57:59 +0000395};
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000396}
Guy Benyei11169dd2012-12-18 14:30:41 +0000397
Reid Klecknerdf8dd612018-08-17 20:59:27 +0000398MicrosoftMangleContextImpl::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
Rafael Espindola002667c2013-10-16 01:40:34 +0000426bool MicrosoftMangleContextImpl::shouldMangleCXXName(const NamedDecl *D) {
David Majnemerd5a42b82013-09-13 09:03:14 +0000427 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
David Majnemerc729b0b2013-09-16 22:44:20 +0000433 // 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())
David Majnemerd5a42b82013-09-13 09:03:14 +0000443 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 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000454
455 // Otherwise, no mangling is done outside C++ mode.
456 if (!getASTContext().getLangOpts().CPlusPlus)
457 return false;
458
Richard Smithda383632016-08-15 01:33:41 +0000459 const VarDecl *VD = dyn_cast<VarDecl>(D);
460 if (VD && !isa<DecompositionDecl>(D)) {
David Majnemerd5a42b82013-09-13 09:03:14 +0000461 // C variables are not mangled.
462 if (VD->isExternC())
463 return false;
464
Richard Smithbab6df82020-04-11 22:15:29 -0700465 // Variables at global scope with internal linkage are not mangled.
David Majnemerd5a42b82013-09-13 09:03:14 +0000466 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 &&
David Majnemeree6c4092015-10-22 07:15:56 +0000473 !isa<VarTemplateSpecializationDecl>(D) &&
474 D->getIdentifier() != nullptr)
Guy Benyei11169dd2012-12-18 14:30:41 +0000475 return false;
476 }
477
Guy Benyei11169dd2012-12-18 14:30:41 +0000478 return true;
479}
480
David Majnemer58e5bee2014-03-24 21:43:36 +0000481bool
482MicrosoftMangleContextImpl::shouldMangleStringLiteral(const StringLiteral *SL) {
David Majnemer6fc2d812014-11-22 06:20:38 +0000483 return true;
David Majnemer58e5bee2014-03-24 21:43:36 +0000484}
485
David Majnemer02e9af42014-04-23 05:16:51 +0000486void MicrosoftCXXNameMangler::mangle(const NamedDecl *D, StringRef Prefix) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000487 // 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
Guy Benyei11169dd2012-12-18 14:30:41 +0000493 // <mangled-name> ::= ? <name> <type-encoding>
494 Out << Prefix;
495 mangleName(D);
496 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
David Majnemerab4b4a12015-05-18 00:05:25 +0000497 mangleFunctionEncoding(FD, Context.shouldMangleDeclName(FD));
Guy Benyei11169dd2012-12-18 14:30:41 +0000498 else if (const VarDecl *VD = dyn_cast<VarDecl>(D))
499 mangleVariableEncoding(VD);
Richard Smithbab6df82020-04-11 22:15:29 -0700500 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";
Shoaib Meenaic8714d22018-10-04 19:50:14 +0000504 else
David Majnemer53b60a12015-12-29 22:02:10 +0000505 llvm_unreachable("Tried to mangle unexpected NamedDecl!");
Guy Benyei11169dd2012-12-18 14:30:41 +0000506}
507
David Majnemerab4b4a12015-05-18 00:05:25 +0000508void MicrosoftCXXNameMangler::mangleFunctionEncoding(const FunctionDecl *FD,
509 bool ShouldMangle) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000510 // <type-encoding> ::= <function-class> <function-type>
511
Reid Kleckner18da98e2013-06-24 19:21:52 +0000512 // 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.
Rafael Espindola8db352d2013-10-17 15:37:26 +0000515 FD = FD->getFirstDecl();
Reid Kleckner18da98e2013-06-24 19:21:52 +0000516
Guy Benyei11169dd2012-12-18 14:30:41 +0000517 // We should never ever see a FunctionNoProtoType at this point.
518 // We don't even know how to mangle their types anyway :).
Reid Kleckner9a7f3e62013-10-08 00:58:57 +0000519 const FunctionProtoType *FT = FD->getType()->castAs<FunctionProtoType>();
Guy Benyei11169dd2012-12-18 14:30:41 +0000520
David Majnemerd5a42b82013-09-13 09:03:14 +0000521 // 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'.
David Majnemerab4b4a12015-05-18 00:05:25 +0000524 if (ShouldMangle) {
David Majnemer5a7cfea2015-05-18 00:05:29 +0000525 // 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
Eric Christopherbe528662015-12-16 23:10:46 +0000528 // other words, when it is an overloaded extern "C" function).
David Majnemer5a7cfea2015-05-18 00:05:29 +0000529 if (FD->isExternC() && FD->hasAttr<OverloadableAttr>())
530 Out << "$$J0";
531
David Majnemerd5a42b82013-09-13 09:03:14 +0000532 mangleFunctionClass(FD);
Guy Benyei11169dd2012-12-18 14:30:41 +0000533
Reid Klecknerd2f98772018-12-17 23:10:43 +0000534 mangleFunctionType(FT, FD, false, false);
David Majnemerab4b4a12015-05-18 00:05:25 +0000535 } else {
David Majnemerd5a42b82013-09-13 09:03:14 +0000536 Out << '9';
David Majnemerab4b4a12015-05-18 00:05:25 +0000537 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000538}
539
540void 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
David Majnemerb4119f72013-12-13 01:06:04 +0000547
Guy Benyei11169dd2012-12-18 14:30:41 +0000548 // 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.
Zachary Turner87422d92014-06-25 05:37:25 +0000567 SourceRange SR = VD->getSourceRange();
David Majnemerb9a5f2d2014-01-21 20:33:36 +0000568 QualType Ty = VD->getType();
David Majnemer6dda7bb2013-08-15 08:13:23 +0000569 if (Ty->isPointerType() || Ty->isReferenceType() ||
570 Ty->isMemberPointerType()) {
Zachary Turner87422d92014-06-25 05:37:25 +0000571 mangleType(Ty, SR, QMM_Drop);
David Majnemer8eec58f2014-02-18 14:20:10 +0000572 manglePointerExtQualifiers(
David Majnemer7a3ce0c2015-05-26 01:30:45 +0000573 Ty.getDesugaredType(getASTContext()).getLocalQualifiers(), QualType());
David Majnemer6dda7bb2013-08-15 08:13:23 +0000574 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);
David Majnemera2724ae2013-08-09 05:56:24 +0000581 } else if (const ArrayType *AT = getASTContext().getAsArrayType(Ty)) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000582 // Global arrays are funny, too.
David Majnemer5a1b2042013-09-11 04:44:30 +0000583 mangleDecayedArrayType(AT);
Peter Collingbourne2816c022013-04-25 04:25:40 +0000584 if (AT->getElementType()->isArrayType())
585 Out << 'A';
586 else
587 mangleQualifiers(Ty.getQualifiers(), false);
Guy Benyei11169dd2012-12-18 14:30:41 +0000588 } else {
Zachary Turner87422d92014-06-25 05:37:25 +0000589 mangleType(Ty, SR, QMM_Drop);
Will Wilson5f383672014-11-05 13:54:21 +0000590 mangleQualifiers(Ty.getQualifiers(), false);
Guy Benyei11169dd2012-12-18 14:30:41 +0000591 }
592}
593
Reid Kleckner96f8f932014-02-05 17:27:08 +0000594void MicrosoftCXXNameMangler::mangleMemberDataPointer(const CXXRecordDecl *RD,
David Majnemer1e378e42014-02-06 12:46:52 +0000595 const ValueDecl *VD) {
Reid Kleckner96f8f932014-02-05 17:27:08 +0000596 // <member-data-pointer> ::= <integer-literal>
597 // ::= $F <number> <number>
598 // ::= $G <number> <number> <number>
599
David Majnemer763584d2014-02-06 10:59:19 +0000600 int64_t FieldOffset;
601 int64_t VBTableOffset;
Reid Klecknera9cc64e2019-11-15 18:49:32 -0800602 MSInheritanceModel IM = RD->getMSInheritanceModel();
David Majnemer1e378e42014-02-06 12:46:52 +0000603 if (VD) {
604 FieldOffset = getASTContext().getFieldOffset(VD);
David Majnemer763584d2014-02-06 10:59:19 +0000605 assert(FieldOffset % getASTContext().getCharWidth() == 0 &&
Reid Kleckner96f8f932014-02-05 17:27:08 +0000606 "cannot take address of bitfield");
David Majnemer763584d2014-02-06 10:59:19 +0000607 FieldOffset /= getASTContext().getCharWidth();
608
609 VBTableOffset = 0;
David Majnemer08ef2ba2015-06-23 20:34:18 +0000610
Reid Klecknera9cc64e2019-11-15 18:49:32 -0800611 if (IM == MSInheritanceModel::Virtual)
David Majnemer08ef2ba2015-06-23 20:34:18 +0000612 FieldOffset -= getASTContext().getOffsetOfBaseWithVBPtr(RD).getQuantity();
David Majnemer763584d2014-02-06 10:59:19 +0000613 } else {
614 FieldOffset = RD->nullFieldOffsetIsZero() ? 0 : -1;
615
616 VBTableOffset = -1;
Reid Kleckner96f8f932014-02-05 17:27:08 +0000617 }
618
David Majnemer763584d2014-02-06 10:59:19 +0000619 char Code = '\0';
Reid Kleckner96f8f932014-02-05 17:27:08 +0000620 switch (IM) {
Reid Klecknera9cc64e2019-11-15 18:49:32 -0800621 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;
Reid Kleckner96f8f932014-02-05 17:27:08 +0000625 }
626
David Majnemer763584d2014-02-06 10:59:19 +0000627 Out << '$' << Code;
Reid Kleckner96f8f932014-02-05 17:27:08 +0000628
David Majnemer763584d2014-02-06 10:59:19 +0000629 mangleNumber(FieldOffset);
630
Reid Klecknerbf94e6e2014-04-07 18:07:03 +0000631 // 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.
Reid Klecknera9cc64e2019-11-15 18:49:32 -0800634 if (inheritanceModelHasVBPtrOffsetField(IM))
Reid Kleckner96f8f932014-02-05 17:27:08 +0000635 mangleNumber(0);
Reid Klecknera9cc64e2019-11-15 18:49:32 -0800636 if (inheritanceModelHasVBTableOffsetField(IM))
David Majnemer763584d2014-02-06 10:59:19 +0000637 mangleNumber(VBTableOffset);
Reid Kleckner96f8f932014-02-05 17:27:08 +0000638}
639
640void
641MicrosoftCXXNameMangler::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>
Reid Kleckner96f8f932014-02-05 17:27:08 +0000647
Reid Klecknera9cc64e2019-11-15 18:49:32 -0800648 MSInheritanceModel IM = RD->getMSInheritanceModel();
Reid Kleckner96f8f932014-02-05 17:27:08 +0000649
Reid Kleckner96f8f932014-02-05 17:27:08 +0000650 char Code = '\0';
651 switch (IM) {
Reid Klecknera9cc64e2019-11-15 18:49:32 -0800652 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;
Reid Kleckner96f8f932014-02-05 17:27:08 +0000656 }
657
Reid Kleckner96f8f932014-02-05 17:27:08 +0000658 // 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;
Reid Klecknerbf94e6e2014-04-07 18:07:03 +0000662 uint64_t VBPtrOffset = 0;
David Majnemer6a729c62014-06-11 04:55:08 +0000663 if (MD) {
664 Out << '$' << Code << '?';
665 if (MD->isVirtual()) {
666 MicrosoftVTableContext *VTContext =
667 cast<MicrosoftVTableContext>(getASTContext().getVTableContext());
Reid Klecknercbec0262018-04-02 20:00:39 +0000668 MethodVFTableLocation ML =
David Majnemer6a729c62014-06-11 04:55:08 +0000669 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);
David Majnemerab4b4a12015-05-18 00:05:25 +0000679 mangleFunctionEncoding(MD, /*ShouldMangle=*/true);
Reid Kleckner96f8f932014-02-05 17:27:08 +0000680 }
David Majnemer08ef2ba2015-06-23 20:34:18 +0000681
Reid Klecknera9cc64e2019-11-15 18:49:32 -0800682 if (VBTableOffset == 0 && IM == MSInheritanceModel::Virtual)
David Majnemer08ef2ba2015-06-23 20:34:18 +0000683 NVOffset -= getASTContext().getOffsetOfBaseWithVBPtr(RD).getQuantity();
Reid Kleckner96f8f932014-02-05 17:27:08 +0000684 } else {
David Majnemer6a729c62014-06-11 04:55:08 +0000685 // Null single inheritance member functions are encoded as a simple nullptr.
Reid Klecknera9cc64e2019-11-15 18:49:32 -0800686 if (IM == MSInheritanceModel::Single) {
David Majnemer6a729c62014-06-11 04:55:08 +0000687 Out << "$0A@";
688 return;
689 }
Reid Klecknera9cc64e2019-11-15 18:49:32 -0800690 if (IM == MSInheritanceModel::Unspecified)
David Majnemer6a729c62014-06-11 04:55:08 +0000691 VBTableOffset = -1;
692 Out << '$' << Code;
Reid Kleckner96f8f932014-02-05 17:27:08 +0000693 }
694
Reid Klecknera9cc64e2019-11-15 18:49:32 -0800695 if (inheritanceModelHasNVOffsetField(/*IsMemberFunction=*/true, IM))
David Majnemer08ef2ba2015-06-23 20:34:18 +0000696 mangleNumber(static_cast<uint32_t>(NVOffset));
Reid Klecknera9cc64e2019-11-15 18:49:32 -0800697 if (inheritanceModelHasVBPtrOffsetField(IM))
Reid Klecknerbf94e6e2014-04-07 18:07:03 +0000698 mangleNumber(VBPtrOffset);
Reid Klecknera9cc64e2019-11-15 18:49:32 -0800699 if (inheritanceModelHasVBTableOffsetField(IM))
Reid Kleckner96f8f932014-02-05 17:27:08 +0000700 mangleNumber(VBTableOffset);
701}
702
703void MicrosoftCXXNameMangler::mangleVirtualMemPtrThunk(
Reid Klecknercbec0262018-04-02 20:00:39 +0000704 const CXXMethodDecl *MD, const MethodVFTableLocation &ML) {
Reid Kleckner96f8f932014-02-05 17:27:08 +0000705 // 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';
Simon Pilgrimd87a76c2020-01-11 15:41:31 +0000715 mangleCallingConvention(MD->getType()->castAs<FunctionProtoType>());
Reid Kleckner96f8f932014-02-05 17:27:08 +0000716}
717
Guy Benyei11169dd2012-12-18 14:30:41 +0000718void MicrosoftCXXNameMangler::mangleName(const NamedDecl *ND) {
719 // <name> ::= <unscoped-name> {[<named-scope>]+ | [<nested-name>]}? @
Guy Benyei11169dd2012-12-18 14:30:41 +0000720
721 // Always start with the unqualified name.
David Majnemerb4119f72013-12-13 01:06:04 +0000722 mangleUnqualifiedName(ND);
Guy Benyei11169dd2012-12-18 14:30:41 +0000723
David Majnemer2206bf52014-03-05 08:57:59 +0000724 mangleNestedName(ND);
Guy Benyei11169dd2012-12-18 14:30:41 +0000725
726 // Terminate the whole name with an '@'.
727 Out << '@';
728}
729
David Majnemer2a816452013-12-09 10:44:32 +0000730void 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>
Guy Benyei11169dd2012-12-18 14:30:41 +0000736
David Majnemer2a816452013-12-09 10:44:32 +0000737 uint64_t Value = static_cast<uint64_t>(Number);
738 if (Number < 0) {
739 Value = -Value;
Guy Benyei11169dd2012-12-18 14:30:41 +0000740 Out << '?';
Guy Benyei11169dd2012-12-18 14:30:41 +0000741 }
David Majnemer2a816452013-12-09 10:44:32 +0000742
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];
Craig Toppere3d2ecbe2014-06-28 23:22:33 +0000752 MutableArrayRef<char> BufferRef(EncodedNumberBuffer);
753 MutableArrayRef<char>::reverse_iterator I = BufferRef.rbegin();
David Majnemer2a816452013-12-09 10:44:32 +0000754 for (; Value != 0; Value >>= 4)
755 *I++ = 'A' + (Value & 0xf);
756 Out.write(I.base(), I - BufferRef.rbegin());
Guy Benyei11169dd2012-12-18 14:30:41 +0000757 Out << '@';
758 }
759}
760
761static const TemplateDecl *
Reid Kleckner52518862013-03-20 01:40:23 +0000762isTemplate(const NamedDecl *ND, const TemplateArgumentList *&TemplateArgs) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000763 // Check if we have a function template.
David Majnemer02e9af42014-04-23 05:16:51 +0000764 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000765 if (const TemplateDecl *TD = FD->getPrimaryTemplate()) {
Reid Kleckner52518862013-03-20 01:40:23 +0000766 TemplateArgs = FD->getTemplateSpecializationArgs();
Guy Benyei11169dd2012-12-18 14:30:41 +0000767 return TD;
768 }
769 }
770
771 // Check if we have a class template.
772 if (const ClassTemplateSpecializationDecl *Spec =
David Majnemer02e9af42014-04-23 05:16:51 +0000773 dyn_cast<ClassTemplateSpecializationDecl>(ND)) {
Reid Kleckner52518862013-03-20 01:40:23 +0000774 TemplateArgs = &Spec->getTemplateArgs();
Guy Benyei11169dd2012-12-18 14:30:41 +0000775 return Spec->getSpecializedTemplate();
776 }
777
David Majnemer8f774532014-03-04 05:38:05 +0000778 // 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
Craig Topper36250ad2014-05-12 05:36:57 +0000785 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +0000786}
787
David Majnemer02e9af42014-04-23 05:16:51 +0000788void MicrosoftCXXNameMangler::mangleUnqualifiedName(const NamedDecl *ND,
789 DeclarationName Name) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000790 // <unqualified-name> ::= <operator-name>
791 // ::= <ctor-dtor-name>
792 // ::= <source-name>
793 // ::= <template-name>
Reid Kleckner52518862013-03-20 01:40:23 +0000794
Guy Benyei11169dd2012-12-18 14:30:41 +0000795 // Check if we have a template.
Craig Topper36250ad2014-05-12 05:36:57 +0000796 const TemplateArgumentList *TemplateArgs = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +0000797 if (const TemplateDecl *TD = isTemplate(ND, TemplateArgs)) {
Reid Klecknerc16c4472013-07-13 00:43:39 +0000798 // 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.
David Majnemer56e2adb2015-12-30 05:40:32 +0000801 if (isa<FunctionTemplateDecl>(TD)) {
Reid Klecknerc16c4472013-07-13 00:43:39 +0000802 mangleTemplateInstantiationName(TD, *TemplateArgs);
Reid Kleckner11c6f612014-06-26 22:42:18 +0000803 Out << '@';
Reid Klecknerc16c4472013-07-13 00:43:39 +0000804 return;
805 }
806
Guy Benyei11169dd2012-12-18 14:30:41 +0000807 // 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.
Nico Weber73f05842019-06-01 10:12:07 +0000812 // That is, from the mangler's perspective we have a structure like this:
Guy Benyei11169dd2012-12-18 14:30:41 +0000813 // 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
Fangrui Song6907ce22018-07-30 19:24:48 +0000818 // a namespace suffix) to a string using the extra mangler and then use
David Majnemerc986fcc2014-06-08 04:51:13 +0000819 // the mangled type name as a key to check the mangling of different types
820 // for aliasing.
Guy Benyei11169dd2012-12-18 14:30:41 +0000821
Nico Weber73f05842019-06-01 10:12:07 +0000822 // 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()) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000827
Nico Weber48707762019-06-04 23:27:40 +0000828 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);
Nico Weber73f05842019-06-01 10:12:07 +0000835
Nico Weber48707762019-06-04 23:27:40 +0000836 // 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 {
Nico Weberb9571372019-10-11 12:27:51 +0000851 Out << Found->second << '@'; // Outputs a StringRef.
Nico Weber73f05842019-06-01 10:12:07 +0000852 }
853 } else {
Nico Weber48707762019-06-04 23:27:40 +0000854 Out << Found->second; // Outputs a back reference (an int).
Nico Weber73f05842019-06-01 10:12:07 +0000855 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000856 return;
857 }
858
859 switch (Name.getNameKind()) {
860 case DeclarationName::Identifier: {
861 if (const IdentifierInfo *II = Name.getAsIdentifierInfo()) {
David Majnemer956bc112013-11-25 17:50:19 +0000862 mangleSourceName(II->getName());
Guy Benyei11169dd2012-12-18 14:30:41 +0000863 break;
864 }
David Majnemerb4119f72013-12-13 01:06:04 +0000865
Guy Benyei11169dd2012-12-18 14:30:41 +0000866 // Otherwise, an anonymous entity. We must have a declaration.
867 assert(ND && "mangling empty name without declaration");
David Majnemerb4119f72013-12-13 01:06:04 +0000868
Guy Benyei11169dd2012-12-18 14:30:41 +0000869 if (const NamespaceDecl *NS = dyn_cast<NamespaceDecl>(ND)) {
870 if (NS->isAnonymousNamespace()) {
Reid Klecknerdf8dd612018-08-17 20:59:27 +0000871 Out << "?A0x" << Context.getAnonymousNamespaceHash() << '@';
Guy Benyei11169dd2012-12-18 14:30:41 +0000872 break;
873 }
874 }
David Majnemerb4119f72013-12-13 01:06:04 +0000875
Richard Smithda383632016-08-15 01:33:41 +0000876 if (const DecompositionDecl *DD = dyn_cast<DecompositionDecl>(ND)) {
Nico Webera47dc842019-09-05 21:08:50 +0000877 // 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);
Richard Smithda383632016-08-15 01:33:41 +0000882 mangleSourceName(Name);
883 break;
884 }
885
David Majnemer2206bf52014-03-05 08:57:59 +0000886 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
Richard Smithbab6df82020-04-11 22:15:29 -0700900 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
Guy Benyei11169dd2012-12-18 14:30:41 +0000910 // 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!");
David Majnemer956bc112013-11-25 17:50:19 +0000917 mangleSourceName(D->getDeclName().getAsIdentifierInfo()->getName());
Guy Benyei11169dd2012-12-18 14:30:41 +0000918 break;
919 }
920
David Majnemerf017ec32014-03-05 10:35:06 +0000921 if (const CXXRecordDecl *Record = dyn_cast<CXXRecordDecl>(TD)) {
922 if (Record->isLambda()) {
923 llvm::SmallString<10> Name("<lambda_");
David Majnemer984498f2016-12-06 17:01:02 +0000924
925 Decl *LambdaContextDecl = Record->getLambdaContextDecl();
926 unsigned LambdaManglingNumber = Record->getLambdaManglingNumber();
David Majnemerf017ec32014-03-05 10:35:06 +0000927 unsigned LambdaId;
David Majnemer984498f2016-12-06 17:01:02 +0000928 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;
David Majnemerf017ec32014-03-05 10:35:06 +0000942 else
943 LambdaId = Context.getLambdaId(Record);
944
945 Name += llvm::utostr(LambdaId);
946 Name += ">";
947
948 mangleSourceName(Name);
David Majnemer984498f2016-12-06 17:01:02 +0000949
950 // If the context of a closure type is an initializer for a class
951 // member (static or nonstatic), it is encoded in a qualified name.
952 if (LambdaManglingNumber && LambdaContextDecl) {
953 if ((isa<VarDecl>(LambdaContextDecl) ||
954 isa<FieldDecl>(LambdaContextDecl)) &&
955 LambdaContextDecl->getDeclContext()->isRecord()) {
956 mangleUnqualifiedName(cast<NamedDecl>(LambdaContextDecl));
957 }
958 }
David Majnemerf017ec32014-03-05 10:35:06 +0000959 break;
960 }
961 }
962
David Majnemera5cfddc2016-12-25 05:26:02 +0000963 llvm::SmallString<64> Name;
David Majnemer00350522015-08-31 18:48:39 +0000964 if (DeclaratorDecl *DD =
965 Context.getASTContext().getDeclaratorForUnnamedTagDecl(TD)) {
966 // Anonymous types without a name for linkage purposes have their
David Majnemer2206bf52014-03-05 08:57:59 +0000967 // declarator mangled in if they have one.
David Majnemera5cfddc2016-12-25 05:26:02 +0000968 Name += "<unnamed-type-";
David Majnemer00350522015-08-31 18:48:39 +0000969 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.
David Majnemera5cfddc2016-12-25 05:26:02 +0000975 Name += "<unnamed-type-";
David Majnemer00350522015-08-31 18:48:39 +0000976 Name += TND->getName();
Hans Wennborg4cae35f2018-06-11 06:54:23 +0000977 } 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);
David Majnemera5cfddc2016-12-25 05:26:02 +0000982 Name += "<unnamed-enum-";
Hans Wennborg4cae35f2018-06-11 06:54:23 +0000983 Name += ED->enumerator_begin()->getName();
David Majnemer956bc112013-11-25 17:50:19 +0000984 } else {
David Majnemer2206bf52014-03-05 08:57:59 +0000985 // Otherwise, number the types using a $S prefix.
David Majnemera5cfddc2016-12-25 05:26:02 +0000986 Name += "<unnamed-type-$S";
David Majnemeree6c4092015-10-22 07:15:56 +0000987 Name += llvm::utostr(Context.getAnonymousStructId(TD) + 1);
David Majnemer956bc112013-11-25 17:50:19 +0000988 }
David Majnemer2206bf52014-03-05 08:57:59 +0000989 Name += ">";
990 mangleSourceName(Name.str());
Guy Benyei11169dd2012-12-18 14:30:41 +0000991 break;
992 }
David Majnemerb4119f72013-12-13 01:06:04 +0000993
Guy Benyei11169dd2012-12-18 14:30:41 +0000994 case DeclarationName::ObjCZeroArgSelector:
995 case DeclarationName::ObjCOneArgSelector:
David Chisnall060a7892018-08-14 10:04:36 +0000996 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 }
David Majnemerb4119f72013-12-13 01:06:04 +00001004
Guy Benyei11169dd2012-12-18 14:30:41 +00001005 case DeclarationName::CXXConstructorName:
Reid Klecknere4bb54a2017-01-09 17:09:59 +00001006 if (isStructorDecl(ND)) {
David Majnemerdfa6d202015-03-11 18:36:39 +00001007 if (StructorType == Ctor_CopyingClosure) {
1008 Out << "?_O";
1009 return;
1010 }
1011 if (StructorType == Ctor_DefaultClosure) {
1012 Out << "?_F";
1013 return;
1014 }
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001015 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001016 Out << "?0";
David Majnemerdfa6d202015-03-11 18:36:39 +00001017 return;
David Majnemerb4119f72013-12-13 01:06:04 +00001018
Guy Benyei11169dd2012-12-18 14:30:41 +00001019 case DeclarationName::CXXDestructorName:
Reid Kleckner290feb92017-01-09 17:04:37 +00001020 if (isStructorDecl(ND))
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001021 // 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
Reid Klecknere7de47e2013-07-22 13:51:44 +00001025 // Otherwise, use the base destructor name. This is relevant if a
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001026 // class with a destructor is declared within a destructor.
Reid Klecknere7de47e2013-07-22 13:51:44 +00001027 mangleCXXDtorType(Dtor_Base);
Guy Benyei11169dd2012-12-18 14:30:41 +00001028 break;
David Majnemerb4119f72013-12-13 01:06:04 +00001029
Guy Benyei11169dd2012-12-18 14:30:41 +00001030 case DeclarationName::CXXConversionFunctionName:
1031 // <operator-name> ::= ?B # (cast)
1032 // The target type is encoded as the return type.
1033 Out << "?B";
1034 break;
David Majnemerb4119f72013-12-13 01:06:04 +00001035
Guy Benyei11169dd2012-12-18 14:30:41 +00001036 case DeclarationName::CXXOperatorName:
1037 mangleOperatorName(Name.getCXXOverloadedOperator(), ND->getLocation());
1038 break;
David Majnemerb4119f72013-12-13 01:06:04 +00001039
Guy Benyei11169dd2012-12-18 14:30:41 +00001040 case DeclarationName::CXXLiteralOperatorName: {
David Majnemere31a3ed2014-06-04 16:46:26 +00001041 Out << "?__K";
1042 mangleSourceName(Name.getCXXLiteralIdentifier()->getName());
Guy Benyei11169dd2012-12-18 14:30:41 +00001043 break;
1044 }
David Majnemerb4119f72013-12-13 01:06:04 +00001045
Richard Smith35845152017-02-07 01:37:30 +00001046 case DeclarationName::CXXDeductionGuideName:
1047 llvm_unreachable("Can't mangle a deduction guide name!");
1048
Guy Benyei11169dd2012-12-18 14:30:41 +00001049 case DeclarationName::CXXUsingDirective:
1050 llvm_unreachable("Can't mangle a using directive name!");
1051 }
1052}
1053
Saleem Abdulrasool58340522018-02-07 01:55:08 +00001054// <postfix> ::= <unqualified-name> [<postfix>]
1055// ::= <substitution> [<postfix>]
David Majnemer2206bf52014-03-05 08:57:59 +00001056void MicrosoftCXXNameMangler::mangleNestedName(const NamedDecl *ND) {
David Majnemerff9075f2014-08-06 03:12:47 +00001057 const DeclContext *DC = getEffectiveDeclContext(ND);
David Majnemer2206bf52014-03-05 08:57:59 +00001058 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 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001067
David Majnemer2206bf52014-03-05 08:57:59 +00001068 if (const BlockDecl *BD = dyn_cast<BlockDecl>(DC)) {
Saleem Abdulrasool3cc6d0b2017-06-26 23:28:42 +00001069 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 };
David Majnemer2206bf52014-03-05 08:57:59 +00001081
Saleem Abdulrasool3cc6d0b2017-06-26 23:28:42 +00001082 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
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00001110 // RecordDecl, mangle the entire scope hierarchy at this point rather than
Saleem Abdulrasool3cc6d0b2017-06-26 23:28:42 +00001111 // 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';
Shoaib Meenaid84cf132018-11-14 19:16:22 +00001124 mangleArtificialTagType(TTK_Struct,
Saleem Abdulrasool3cc6d0b2017-06-26 23:28:42 +00001125 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;
David Majnemer2206bf52014-03-05 08:57:59 +00001134 } 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;
David Majnemer984498f2016-12-06 17:01:02 +00001141 } else {
David Majnemer2206bf52014-03-05 08:57:59 +00001142 mangleUnqualifiedName(ND);
David Majnemer984498f2016-12-06 17:01:02 +00001143 // 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 }
David Majnemer2206bf52014-03-05 08:57:59 +00001150 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001151 DC = DC->getParent();
Guy Benyei11169dd2012-12-18 14:30:41 +00001152 }
1153}
1154
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001155void MicrosoftCXXNameMangler::mangleCXXDtorType(CXXDtorType T) {
Reid Klecknere7de47e2013-07-22 13:51:44 +00001156 // 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.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001159 switch (T) {
Reid Klecknere7de47e2013-07-22 13:51:44 +00001160 // <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.
Rafael Espindola1e4df922014-09-16 15:18:21 +00001169 case Dtor_Comdat:
1170 llvm_unreachable("not expecting a COMDAT");
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001171 }
1172 llvm_unreachable("Unsupported dtor type?");
1173}
1174
Guy Benyei11169dd2012-12-18 14:30:41 +00001175void 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;
Gor Nishanove2f51be2016-09-28 22:37:17 +00001292 // <operator-name> ::= ?__L # co_await
1293 case OO_Coawait: Out << "?__L"; break;
Nico Weber27df4092019-04-23 16:37:42 +00001294 // <operator-name> ::= ?__M # <=>
1295 case OO_Spaceship: Out << "?__M"; break;
Richard Smithd30b23d2017-12-01 02:13:10 +00001296
Guy Benyei11169dd2012-12-18 14:30:41 +00001297 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 }
David Majnemerb4119f72013-12-13 01:06:04 +00001304
Guy Benyei11169dd2012-12-18 14:30:41 +00001305 case OO_None:
1306 case NUM_OVERLOADED_OPERATORS:
1307 llvm_unreachable("Not an overloaded operator");
1308 }
1309}
1310
David Majnemer956bc112013-11-25 17:50:19 +00001311void MicrosoftCXXNameMangler::mangleSourceName(StringRef Name) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001312 // <source name> ::= <identifier> @
Fangrui Song75e74e02019-03-31 08:48:19 +00001313 BackRefVec::iterator Found = llvm::find(NameBackReferences, Name);
David Majnemerc986fcc2014-06-08 04:51:13 +00001314 if (Found == NameBackReferences.end()) {
David Majnemer0d0560c2014-09-25 19:43:56 +00001315 if (NameBackReferences.size() < 10)
Benjamin Krameradcd0262020-01-28 20:23:46 +01001316 NameBackReferences.push_back(std::string(Name));
David Majnemer956bc112013-11-25 17:50:19 +00001317 Out << Name << '@';
Guy Benyei11169dd2012-12-18 14:30:41 +00001318 } else {
David Majnemer0d0560c2014-09-25 19:43:56 +00001319 Out << (Found - NameBackReferences.begin());
Guy Benyei11169dd2012-12-18 14:30:41 +00001320 }
1321}
1322
1323void MicrosoftCXXNameMangler::mangleObjCMethodName(const ObjCMethodDecl *MD) {
1324 Context.mangleObjCMethodName(MD, Out);
1325}
1326
Guy Benyei11169dd2012-12-18 14:30:41 +00001327void MicrosoftCXXNameMangler::mangleTemplateInstantiationName(
David Majnemer02e9af42014-04-23 05:16:51 +00001328 const TemplateDecl *TD, const TemplateArgumentList &TemplateArgs) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001329 // <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.
Nico Weber73f05842019-06-01 10:12:07 +00001334 ArgBackRefMap OuterFunArgsContext;
1335 ArgBackRefMap OuterTemplateArgsContext;
David Majnemer0d0560c2014-09-25 19:43:56 +00001336 BackRefVec OuterTemplateContext;
David Majnemer5f177622015-12-30 05:13:03 +00001337 PassObjectSizeArgsSet OuterPassObjectSizeArgs;
Guy Benyei11169dd2012-12-18 14:30:41 +00001338 NameBackReferences.swap(OuterTemplateContext);
Nico Weber73f05842019-06-01 10:12:07 +00001339 FunArgBackReferences.swap(OuterFunArgsContext);
1340 TemplateArgBackReferences.swap(OuterTemplateArgsContext);
David Majnemer5f177622015-12-30 05:13:03 +00001341 PassObjectSizeArgs.swap(OuterPassObjectSizeArgs);
Guy Benyei11169dd2012-12-18 14:30:41 +00001342
1343 mangleUnscopedTemplateName(TD);
Reid Kleckner52518862013-03-20 01:40:23 +00001344 mangleTemplateArgs(TD, TemplateArgs);
Guy Benyei11169dd2012-12-18 14:30:41 +00001345
1346 // Restore the previous back reference contexts.
1347 NameBackReferences.swap(OuterTemplateContext);
Nico Weber73f05842019-06-01 10:12:07 +00001348 FunArgBackReferences.swap(OuterFunArgsContext);
1349 TemplateArgBackReferences.swap(OuterTemplateArgsContext);
David Majnemer5f177622015-12-30 05:13:03 +00001350 PassObjectSizeArgs.swap(OuterPassObjectSizeArgs);
Guy Benyei11169dd2012-12-18 14:30:41 +00001351}
1352
1353void
1354MicrosoftCXXNameMangler::mangleUnscopedTemplateName(const TemplateDecl *TD) {
1355 // <unscoped-template-name> ::= ?$ <unqualified-name>
1356 Out << "?$";
1357 mangleUnqualifiedName(TD);
1358}
1359
David Majnemer02e9af42014-04-23 05:16:51 +00001360void MicrosoftCXXNameMangler::mangleIntegerLiteral(const llvm::APSInt &Value,
1361 bool IsBoolean) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001362 // <integer-literal> ::= $0 <number>
1363 Out << "$0";
1364 // Make sure booleans are encoded as 0/1.
1365 if (IsBoolean && Value.getBoolValue())
1366 mangleNumber(1);
Will Wilsone74c2812014-12-11 05:47:10 +00001367 else if (Value.isSigned())
David Majnemer2a816452013-12-09 10:44:32 +00001368 mangleNumber(Value.getSExtValue());
Will Wilsone74c2812014-12-11 05:47:10 +00001369 else
1370 mangleNumber(Value.getZExtValue());
Guy Benyei11169dd2012-12-18 14:30:41 +00001371}
1372
David Majnemer02e9af42014-04-23 05:16:51 +00001373void MicrosoftCXXNameMangler::mangleExpression(const Expr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001374 // 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();
David Majnemer02e9af42014-04-23 05:16:51 +00001383 unsigned DiagID = Diags.getCustomDiagID(
1384 DiagnosticsEngine::Error, "cannot yet mangle expression type %0");
1385 Diags.Report(E->getExprLoc(), DiagID) << E->getStmtClassName()
1386 << E->getSourceRange();
Guy Benyei11169dd2012-12-18 14:30:41 +00001387}
1388
David Majnemer8265dec2014-03-30 16:30:54 +00001389void MicrosoftCXXNameMangler::mangleTemplateArgs(
1390 const TemplateDecl *TD, const TemplateArgumentList &TemplateArgs) {
Reid Kleckner11c6f612014-06-26 22:42:18 +00001391 // <template-args> ::= <template-arg>+
David Majnemer57fbc0c2014-08-05 22:43:45 +00001392 const TemplateParameterList *TPL = TD->getTemplateParameters();
1393 assert(TPL->size() == TemplateArgs.size() &&
1394 "size mismatch between args and parms!");
1395
Nico Webere2dd1572018-09-08 20:58:39 +00001396 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 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001406}
1407
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001408void MicrosoftCXXNameMangler::mangleTemplateArg(const TemplateDecl *TD,
David Majnemer57fbc0c2014-08-05 22:43:45 +00001409 const TemplateArgument &TA,
1410 const NamedDecl *Parm) {
Reid Kleckner96f8f932014-02-05 17:27:08 +00001411 // <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
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001420 switch (TA.getKind()) {
1421 case TemplateArgument::Null:
1422 llvm_unreachable("Can't mangle null template arguments!");
David Majnemer08177c52013-08-27 08:21:25 +00001423 case TemplateArgument::TemplateExpansion:
1424 llvm_unreachable("Can't mangle template expansion arguments!");
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001425 case TemplateArgument::Type: {
1426 QualType T = TA.getAsType();
1427 mangleType(T, SourceRange(), QMM_Escape);
1428 break;
1429 }
David Majnemere8fdc062013-08-13 01:25:35 +00001430 case TemplateArgument::Declaration: {
George Burgess IV00f70bd2018-03-01 05:43:23 +00001431 const NamedDecl *ND = TA.getAsDecl();
David Majnemer1e378e42014-02-06 12:46:52 +00001432 if (isa<FieldDecl>(ND) || isa<IndirectFieldDecl>(ND)) {
Nico Weber2b5f3fd2018-08-01 11:56:20 +00001433 mangleMemberDataPointer(cast<CXXRecordDecl>(ND->getDeclContext())
1434 ->getMostRecentNonInjectedDecl(),
1435 cast<ValueDecl>(ND));
Reid Kleckner09b47d12014-02-05 18:59:38 +00001436 } else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)) {
Nick Lewycky1f529662014-02-05 23:53:29 +00001437 const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD);
David Majnemerab4b4a12015-05-18 00:05:25 +00001438 if (MD && MD->isInstance()) {
Nico Weber2b5f3fd2018-08-01 11:56:20 +00001439 mangleMemberFunctionPointer(
1440 MD->getParent()->getMostRecentNonInjectedDecl(), MD);
David Majnemerab4b4a12015-05-18 00:05:25 +00001441 } else {
1442 Out << "$1?";
1443 mangleName(FD);
1444 mangleFunctionEncoding(FD, /*ShouldMangle=*/true);
1445 }
Reid Kleckner09b47d12014-02-05 18:59:38 +00001446 } else {
David Blaikie952a9b12014-10-17 18:00:12 +00001447 mangle(ND, TA.getParamTypeForDecl()->isReferenceType() ? "$E?" : "$1?");
Reid Kleckner09b47d12014-02-05 18:59:38 +00001448 }
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001449 break;
David Majnemere8fdc062013-08-13 01:25:35 +00001450 }
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001451 case TemplateArgument::Integral:
1452 mangleIntegerLiteral(TA.getAsIntegral(),
1453 TA.getIntegralType()->isBooleanType());
1454 break;
Reid Kleckner96f8f932014-02-05 17:27:08 +00001455 case TemplateArgument::NullPtr: {
1456 QualType T = TA.getNullPtrType();
1457 if (const MemberPointerType *MPT = T->getAs<MemberPointerType>()) {
David Majnemer763584d2014-02-06 10:59:19 +00001458 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
David Majnemerf3027172015-12-01 19:13:51 +00001459 if (MPT->isMemberFunctionPointerType() &&
1460 !isa<FunctionTemplateDecl>(TD)) {
Craig Topper36250ad2014-05-12 05:36:57 +00001461 mangleMemberFunctionPointer(RD, nullptr);
David Majnemer19187872014-06-11 07:08:37 +00001462 return;
1463 }
1464 if (MPT->isMemberDataPointer()) {
David Majnemerf3027172015-12-01 19:13:51 +00001465 if (!isa<FunctionTemplateDecl>(TD)) {
David Majnemer10236682015-07-02 09:43:11 +00001466 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 }
David Majnemer19187872014-06-11 07:08:37 +00001479 }
Reid Kleckner96f8f932014-02-05 17:27:08 +00001480 }
David Majnemer10236682015-07-02 09:43:11 +00001481 mangleIntegerLiteral(llvm::APSInt::getUnsigned(0), /*IsBoolean=*/false);
David Majnemerae465ef2013-08-05 21:33:59 +00001482 break;
Reid Kleckner96f8f932014-02-05 17:27:08 +00001483 }
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001484 case TemplateArgument::Expression:
1485 mangleExpression(TA.getAsExpr());
1486 break;
David Majnemer06fa05a2014-06-04 16:46:32 +00001487 case TemplateArgument::Pack: {
Craig Topper00bbdcf2014-06-28 23:22:23 +00001488 ArrayRef<TemplateArgument> TemplateArgs = TA.getPackAsArray();
David Majnemer06fa05a2014-06-04 16:46:32 +00001489 if (TemplateArgs.empty()) {
David Majnemer57fbc0c2014-08-05 22:43:45 +00001490 if (isa<TemplateTypeParmDecl>(Parm) ||
1491 isa<TemplateTemplateParmDecl>(Parm))
David Majnemer4deaac72015-03-18 03:56:27 +00001492 // MSVC 2015 changed the mangling for empty expanded template packs,
1493 // use the old mangling for link compatibility for old versions.
David Majnemerb710a932015-05-11 03:57:49 +00001494 Out << (Context.getASTContext().getLangOpts().isCompatibleWithMSVC(
1495 LangOptions::MSVC2015)
David Majnemer4deaac72015-03-18 03:56:27 +00001496 ? "$$V"
1497 : "$$$V");
David Majnemer57fbc0c2014-08-05 22:43:45 +00001498 else if (isa<NonTypeTemplateParmDecl>(Parm))
1499 Out << "$S";
1500 else
1501 llvm_unreachable("unexpected template parameter decl!");
David Majnemer06fa05a2014-06-04 16:46:32 +00001502 } else {
1503 for (const TemplateArgument &PA : TemplateArgs)
David Majnemer57fbc0c2014-08-05 22:43:45 +00001504 mangleTemplateArg(TD, PA, Parm);
David Majnemer06fa05a2014-06-04 16:46:32 +00001505 }
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001506 break;
David Majnemer06fa05a2014-06-04 16:46:32 +00001507 }
David Majnemer8d5f9ab2014-07-30 08:20:03 +00001508 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)) {
David Majnemer9a3bc592014-08-19 07:29:03 +00001514 Out << "$$Y";
1515 mangleName(ND);
David Majnemer8d5f9ab2014-07-30 08:20:03 +00001516 } else {
1517 llvm_unreachable("unexpected template template NamedDecl!");
1518 }
David Majnemer0db0ca42013-08-05 22:26:46 +00001519 break;
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001520 }
David Majnemer8d5f9ab2014-07-30 08:20:03 +00001521 }
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001522}
1523
Saleem Abdulrasoolbbce34a2018-02-09 03:23:54 +00001524void 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");
Shoaib Meenaid84cf132018-11-14 19:16:22 +00001531 Extra.mangleArtificialTagType(TTK_Struct, PD->getName());
Saleem Abdulrasoolbbce34a2018-02-09 03:23:54 +00001532
Shoaib Meenaid84cf132018-11-14 19:16:22 +00001533 mangleArtificialTagType(TTK_Struct, TemplateMangling, {"__ObjC"});
Saleem Abdulrasoolbbce34a2018-02-09 03:23:54 +00001534}
1535
1536void 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
Shoaib Meenaid84cf132018-11-14 19:16:22 +00001562 mangleArtificialTagType(TTK_Struct, TemplateMangling, {"__ObjC"});
Saleem Abdulrasoolbbce34a2018-02-09 03:23:54 +00001563}
1564
Saleem Abdulrasoolf3a981e2018-09-28 16:47:53 +00001565void 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
Shoaib Meenaid84cf132018-11-14 19:16:22 +00001579 mangleArtificialTagType(TTK_Struct, TemplateMangling, {"__ObjC"});
Saleem Abdulrasoolf3a981e2018-09-28 16:47:53 +00001580}
1581
Guy Benyei11169dd2012-12-18 14:30:41 +00001582void 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();
David Majnemer89594f32013-08-05 22:43:06 +00001638
Guy Benyei11169dd2012-12-18 14:30:41 +00001639 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
David Majnemer8eec58f2014-02-18 14:20:10 +00001664void
David Majnemere3785bb2014-04-23 05:16:56 +00001665MicrosoftCXXNameMangler::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
David Majnemer7a3ce0c2015-05-26 01:30:45 +00001682void MicrosoftCXXNameMangler::manglePointerExtQualifiers(Qualifiers Quals,
1683 QualType PointeeType) {
Amy Huanga85f5ef2019-10-24 16:34:25 -07001684 // 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()))
David Majnemer8eec58f2014-02-18 14:20:10 +00001688 Out << 'E';
1689
Saleem Abdulrasool26d9bdb2018-01-25 19:54:31 +00001690 if (Quals.hasRestrict())
David Majnemer8eec58f2014-02-18 14:20:10 +00001691 Out << 'I';
Andrey Bokhanko45d41322016-05-11 18:38:21 +00001692
Andrey Bokhanko67a41862016-05-26 10:06:01 +00001693 if (Quals.hasUnaligned() ||
1694 (!PointeeType.isNull() && PointeeType.getLocalQualifiers().hasUnaligned()))
Andrey Bokhanko45d41322016-05-11 18:38:21 +00001695 Out << 'F';
David Majnemer8eec58f2014-02-18 14:20:10 +00001696}
1697
1698void MicrosoftCXXNameMangler::manglePointerCVQualifiers(Qualifiers Quals) {
1699 // <pointer-cv-qualifiers> ::= P # no qualifiers
1700 // ::= Q # const
1701 // ::= R # volatile
1702 // ::= S # const volatile
Guy Benyei11169dd2012-12-18 14:30:41 +00001703 bool HasConst = Quals.hasConst(),
David Majnemer8eec58f2014-02-18 14:20:10 +00001704 HasVolatile = Quals.hasVolatile();
David Majnemer0b6bf8a2014-02-18 12:58:35 +00001705
Guy Benyei11169dd2012-12-18 14:30:41 +00001706 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
Nico Weber73f05842019-06-01 10:12:07 +00001717void MicrosoftCXXNameMangler::mangleFunctionArgumentType(QualType T,
1718 SourceRange Range) {
Reid Kleckner18da98e2013-06-24 19:21:52 +00001719 // MSVC will backreference two canonically equivalent types that have slightly
1720 // different manglings when mangled alone.
David Majnemer5a1b2042013-09-11 04:44:30 +00001721
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;
David Majnemer96183f62015-04-23 05:21:20 +00001727 if (const auto *DT = T->getAs<DecayedType>()) {
1728 QualType OriginalType = DT->getOriginalType();
David Majnemerbdc1fed2015-04-27 03:07:47 +00001729 // All decayed ArrayTypes should be treated identically; as-if they were
1730 // a decayed IncompleteArrayType.
1731 if (const auto *AT = getASTContext().getAsArrayType(OriginalType))
David Majnemer96183f62015-04-23 05:21:20 +00001732 OriginalType = getASTContext().getIncompleteArrayType(
David Majnemerbdc1fed2015-04-27 03:07:47 +00001733 AT->getElementType(), AT->getSizeModifier(),
1734 AT->getIndexTypeCVRQualifiers());
David Majnemer96183f62015-04-23 05:21:20 +00001735
1736 TypePtr = OriginalType.getCanonicalType().getAsOpaquePtr();
David Majnemer5a1b2042013-09-11 04:44:30 +00001737 // 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
David Majnemer96183f62015-04-23 05:21:20 +00001742 if (OriginalType->isArrayType())
David Majnemer5a1b2042013-09-11 04:44:30 +00001743 T = T.withConst();
David Majnemer96183f62015-04-23 05:21:20 +00001744 } else {
David Majnemer5a1b2042013-09-11 04:44:30 +00001745 TypePtr = T.getCanonicalType().getAsOpaquePtr();
David Majnemer96183f62015-04-23 05:21:20 +00001746 }
David Majnemer5a1b2042013-09-11 04:44:30 +00001747
Nico Weber73f05842019-06-01 10:12:07 +00001748 ArgBackRefMap::iterator Found = FunArgBackReferences.find(TypePtr);
Guy Benyei11169dd2012-12-18 14:30:41 +00001749
Nico Weber73f05842019-06-01 10:12:07 +00001750 if (Found == FunArgBackReferences.end()) {
Yaron Keren2155f802015-05-02 15:31:08 +00001751 size_t OutSizeBefore = Out.tell();
Guy Benyei11169dd2012-12-18 14:30:41 +00001752
David Majnemer5a1b2042013-09-11 04:44:30 +00001753 mangleType(T, Range, QMM_Drop);
Guy Benyei11169dd2012-12-18 14:30:41 +00001754
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:
Yaron Keren2155f802015-05-02 15:31:08 +00001758 bool LongerThanOneChar = (Out.tell() - OutSizeBefore > 1);
Nico Weber73f05842019-06-01 10:12:07 +00001759 if (LongerThanOneChar && FunArgBackReferences.size() < 10) {
1760 size_t Size = FunArgBackReferences.size();
1761 FunArgBackReferences[TypePtr] = Size;
Guy Benyei11169dd2012-12-18 14:30:41 +00001762 }
1763 } else {
1764 Out << Found->second;
1765 }
1766}
1767
David Majnemer5f177622015-12-30 05:13:03 +00001768void MicrosoftCXXNameMangler::manglePassObjectSizeArg(
1769 const PassObjectSizeAttr *POSA) {
1770 int Type = POSA->getType();
Erik Pilkington02d5fb12019-03-19 20:44:18 +00001771 bool Dynamic = POSA->isDynamic();
David Majnemer5f177622015-12-30 05:13:03 +00001772
Erik Pilkington02d5fb12019-03-19 20:44:18 +00001773 auto Iter = PassObjectSizeArgs.insert({Type, Dynamic}).first;
David Majnemer622abd12015-12-31 05:36:52 +00001774 auto *TypePtr = (const void *)&*Iter;
Nico Weber73f05842019-06-01 10:12:07 +00001775 ArgBackRefMap::iterator Found = FunArgBackReferences.find(TypePtr);
David Majnemer5f177622015-12-30 05:13:03 +00001776
Nico Weber73f05842019-06-01 10:12:07 +00001777 if (Found == FunArgBackReferences.end()) {
Erik Pilkington02d5fb12019-03-19 20:44:18 +00001778 std::string Name =
1779 Dynamic ? "__pass_dynamic_object_size" : "__pass_object_size";
1780 mangleArtificialTagType(TTK_Enum, Name + llvm::utostr(Type), {"__clang"});
David Majnemer5f177622015-12-30 05:13:03 +00001781
Nico Weber73f05842019-06-01 10:12:07 +00001782 if (FunArgBackReferences.size() < 10) {
1783 size_t Size = FunArgBackReferences.size();
1784 FunArgBackReferences[TypePtr] = Size;
David Majnemer5f177622015-12-30 05:13:03 +00001785 }
1786 } else {
1787 Out << Found->second;
1788 }
1789}
1790
Erich Keane24a0f042018-12-14 23:17:34 +00001791void 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;
Amy Huanga85f5ef2019-10-24 16:34:25 -07001847 case LangAS::ptr32_sptr:
1848 case LangAS::ptr32_uptr:
1849 case LangAS::ptr64:
1850 llvm_unreachable("don't mangle ptr address spaces with _AS");
Erich Keane24a0f042018-12-14 23:17:34 +00001851 }
1852 }
1853
1854 Extra.mangleType(T, Range, QMM_Escape);
1855 mangleQualifiers(Qualifiers(), false);
1856 mangleArtificialTagType(TTK_Struct, ASMangling, {"__clang"});
1857}
1858
Guy Benyei11169dd2012-12-18 14:30:41 +00001859void MicrosoftCXXNameMangler::mangleType(QualType T, SourceRange Range,
Peter Collingbourne2816c022013-04-25 04:25:40 +00001860 QualifierMangleMode QMM) {
Reid Kleckner18da98e2013-06-24 19:21:52 +00001861 // 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());
Guy Benyei11169dd2012-12-18 14:30:41 +00001864 Qualifiers Quals = T.getLocalQualifiers();
Erich Keane24a0f042018-12-14 23:17:34 +00001865
Reid Kleckner18da98e2013-06-24 19:21:52 +00001866 if (const ArrayType *AT = getASTContext().getAsArrayType(T)) {
1867 // If there were any Quals, getAsArrayType() pushed them onto the array
1868 // element type.
Peter Collingbourne2816c022013-04-25 04:25:40 +00001869 if (QMM == QMM_Mangle)
1870 Out << 'A';
1871 else if (QMM == QMM_Escape || QMM == QMM_Result)
1872 Out << "$$B";
Reid Kleckner18da98e2013-06-24 19:21:52 +00001873 mangleArrayType(AT);
Peter Collingbourne2816c022013-04-25 04:25:40 +00001874 return;
1875 }
1876
1877 bool IsPointer = T->isAnyPointerType() || T->isMemberPointerType() ||
David Majnemer7a3ce0c2015-05-26 01:30:45 +00001878 T->isReferenceType() || T->isBlockPointerType();
Peter Collingbourne2816c022013-04-25 04:25:40 +00001879
1880 switch (QMM) {
1881 case QMM_Drop:
Saleem Abdulrasoolbbce34a2018-02-09 03:23:54 +00001882 if (Quals.hasObjCLifetime())
1883 Quals = Quals.withoutObjCLifetime();
Peter Collingbourne2816c022013-04-25 04:25:40 +00001884 break;
1885 case QMM_Mangle:
1886 if (const FunctionType *FT = dyn_cast<FunctionType>(T)) {
1887 Out << '6';
Timur Iskhodzhanov555a7722013-10-04 11:25:05 +00001888 mangleFunctionType(FT);
Peter Collingbourne2816c022013-04-25 04:25:40 +00001889 return;
1890 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001891 mangleQualifiers(Quals, false);
Peter Collingbourne2816c022013-04-25 04:25:40 +00001892 break;
1893 case QMM_Escape:
1894 if (!IsPointer && Quals) {
1895 Out << "$$C";
1896 mangleQualifiers(Quals, false);
1897 }
1898 break;
1899 case QMM_Result:
Andrey Bokhanko45d41322016-05-11 18:38:21 +00001900 // Presence of __unaligned qualifier shouldn't affect mangling here.
1901 Quals.removeUnaligned();
Saleem Abdulrasoolbbce34a2018-02-09 03:23:54 +00001902 if (Quals.hasObjCLifetime())
1903 Quals = Quals.withoutObjCLifetime();
Nico Weber3239f132018-07-23 20:04:00 +00001904 if ((!IsPointer && Quals) || isa<TagType>(T) || isArtificialTagType(T)) {
Peter Collingbourne2816c022013-04-25 04:25:40 +00001905 Out << '?';
1906 mangleQualifiers(Quals, false);
1907 }
1908 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00001909 }
1910
Peter Collingbourne2816c022013-04-25 04:25:40 +00001911 const Type *ty = T.getTypePtr();
Guy Benyei11169dd2012-12-18 14:30:41 +00001912
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: \
David Majnemer7a3ce0c2015-05-26 01:30:45 +00001921 mangleType(cast<CLASS##Type>(ty), Quals, Range); \
Guy Benyei11169dd2012-12-18 14:30:41 +00001922 break;
John McCall36b12a82019-10-02 06:35:23 +00001923#include "clang/AST/TypeNodes.inc"
Guy Benyei11169dd2012-12-18 14:30:41 +00001924#undef ABSTRACT_TYPE
1925#undef NON_CANONICAL_TYPE
1926#undef TYPE
1927 }
1928}
1929
David Majnemer7a3ce0c2015-05-26 01:30:45 +00001930void MicrosoftCXXNameMangler::mangleType(const BuiltinType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00001931 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>
Richard Smith5178c6b2019-02-21 23:04:35 +00001953 // ::= _Q # char8_t
Reid Kleckner9e2584a2017-05-26 17:11:10 +00001954 // ::= _S # char16_t
Richard Smith5178c6b2019-02-21 23:04:35 +00001955 // ::= _T # __float80 (Intel)
Reid Kleckner9e2584a2017-05-26 17:11:10 +00001956 // ::= _U # char32_t
Guy Benyei11169dd2012-12-18 14:30:41 +00001957 // ::= _W # wchar_t
1958 // ::= _Z # __float80 (Digital Mars)
1959 switch (T->getKind()) {
Alexey Baderbdf7c842015-09-15 12:18:29 +00001960 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;
Guy Benyei11169dd2012-12-18 14:30:41 +00001997 // TODO: Determine size and mangle accordingly
Alexey Baderbdf7c842015-09-15 12:18:29 +00001998 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;
Richard Smith5178c6b2019-02-21 23:04:35 +00002016 case BuiltinType::Char8:
2017 Out << "_Q";
2018 break;
Alexey Baderbdf7c842015-09-15 12:18:29 +00002019 case BuiltinType::Char16:
2020 Out << "_S";
2021 break;
2022 case BuiltinType::Char32:
2023 Out << "_U";
2024 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002025 case BuiltinType::WChar_S:
Alexey Baderbdf7c842015-09-15 12:18:29 +00002026 case BuiltinType::WChar_U:
2027 Out << "_W";
2028 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002029
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
Alexey Baderbdf7c842015-09-15 12:18:29 +00002037 case BuiltinType::ObjCId:
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002038 mangleArtificialTagType(TTK_Struct, "objc_object");
Alexey Baderbdf7c842015-09-15 12:18:29 +00002039 break;
2040 case BuiltinType::ObjCClass:
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002041 mangleArtificialTagType(TTK_Struct, "objc_class");
Alexey Baderbdf7c842015-09-15 12:18:29 +00002042 break;
2043 case BuiltinType::ObjCSel:
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002044 mangleArtificialTagType(TTK_Struct, "objc_selector");
Alexey Baderbdf7c842015-09-15 12:18:29 +00002045 break;
Guy Benyeid8a08ea2012-12-18 14:38:23 +00002046
Alexey Bader954ba212016-04-08 13:40:33 +00002047#define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
2048 case BuiltinType::Id: \
2049 Out << "PAUocl_" #ImgType "_" #Suffix "@@"; \
Alexey Baderbdf7c842015-09-15 12:18:29 +00002050 break;
Alexey Baderb62f1442016-04-13 08:33:41 +00002051#include "clang/Basic/OpenCLImageTypes.def"
Alexey Baderbdf7c842015-09-15 12:18:29 +00002052 case BuiltinType::OCLSampler:
David Majnemer3add70b2015-12-29 11:45:53 +00002053 Out << "PA";
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002054 mangleArtificialTagType(TTK_Struct, "ocl_sampler");
Alexey Baderbdf7c842015-09-15 12:18:29 +00002055 break;
2056 case BuiltinType::OCLEvent:
David Majnemer3add70b2015-12-29 11:45:53 +00002057 Out << "PA";
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002058 mangleArtificialTagType(TTK_Struct, "ocl_event");
Alexey Baderbdf7c842015-09-15 12:18:29 +00002059 break;
Alexey Bader9c8453f2015-09-15 11:18:52 +00002060 case BuiltinType::OCLClkEvent:
David Majnemer3add70b2015-12-29 11:45:53 +00002061 Out << "PA";
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002062 mangleArtificialTagType(TTK_Struct, "ocl_clkevent");
Alexey Bader9c8453f2015-09-15 11:18:52 +00002063 break;
2064 case BuiltinType::OCLQueue:
David Majnemer3add70b2015-12-29 11:45:53 +00002065 Out << "PA";
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002066 mangleArtificialTagType(TTK_Struct, "ocl_queue");
Alexey Bader9c8453f2015-09-15 11:18:52 +00002067 break;
Alexey Bader9c8453f2015-09-15 11:18:52 +00002068 case BuiltinType::OCLReserveID:
David Majnemer3add70b2015-12-29 11:45:53 +00002069 Out << "PA";
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002070 mangleArtificialTagType(TTK_Struct, "ocl_reserveid");
Alexey Bader9c8453f2015-09-15 11:18:52 +00002071 break;
Andrew Savonichev3fee3512018-11-08 11:25:41 +00002072#define EXT_OPAQUE_TYPE(ExtType, Id, Ext) \
2073 case BuiltinType::Id: \
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002074 mangleArtificialTagType(TTK_Struct, "ocl_" #ExtType); \
Andrew Savonichev3fee3512018-11-08 11:25:41 +00002075 break;
2076#include "clang/Basic/OpenCLExtensionTypes.def"
David Majnemerb4119f72013-12-13 01:06:04 +00002077
Alexey Baderbdf7c842015-09-15 12:18:29 +00002078 case BuiltinType::NullPtr:
2079 Out << "$$T";
2080 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002081
Sjoerd Meijercc623ad2017-09-08 15:15:00 +00002082 case BuiltinType::Float16:
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002083 mangleArtificialTagType(TTK_Struct, "_Float16", {"__clang"});
Erich Keane5da1e692018-04-17 22:00:54 +00002084 break;
2085
Erich Keane14c10852018-05-01 14:16:15 +00002086 case BuiltinType::Half:
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002087 mangleArtificialTagType(TTK_Struct, "_Half", {"__clang"});
Erich Keane14c10852018-05-01 14:16:15 +00002088 break;
2089
Richard Sandifordeb485fb2019-08-09 08:52:54 +00002090#define SVE_TYPE(Name, Id, SingletonId) \
2091 case BuiltinType::Id:
2092#include "clang/Basic/AArch64SVEACLETypes.def"
Leonard Chanf921d852018-06-04 16:07:52 +00002093 case BuiltinType::ShortAccum:
2094 case BuiltinType::Accum:
2095 case BuiltinType::LongAccum:
2096 case BuiltinType::UShortAccum:
2097 case BuiltinType::UAccum:
2098 case BuiltinType::ULongAccum:
Leonard Chanab80f3c2018-06-14 14:53:51 +00002099 case BuiltinType::ShortFract:
2100 case BuiltinType::Fract:
2101 case BuiltinType::LongFract:
2102 case BuiltinType::UShortFract:
2103 case BuiltinType::UFract:
2104 case BuiltinType::ULongFract:
2105 case BuiltinType::SatShortAccum:
2106 case BuiltinType::SatAccum:
2107 case BuiltinType::SatLongAccum:
2108 case BuiltinType::SatUShortAccum:
2109 case BuiltinType::SatUAccum:
2110 case BuiltinType::SatULongAccum:
2111 case BuiltinType::SatShortFract:
2112 case BuiltinType::SatFract:
2113 case BuiltinType::SatLongFract:
2114 case BuiltinType::SatUShortFract:
2115 case BuiltinType::SatUFract:
2116 case BuiltinType::SatULongFract:
Erich Keane14c10852018-05-01 14:16:15 +00002117 case BuiltinType::Float128: {
Guy Benyei11169dd2012-12-18 14:30:41 +00002118 DiagnosticsEngine &Diags = Context.getDiags();
Alexey Baderbdf7c842015-09-15 12:18:29 +00002119 unsigned DiagID = Diags.getCustomDiagID(
2120 DiagnosticsEngine::Error, "cannot mangle this built-in %0 type yet");
Guy Benyei11169dd2012-12-18 14:30:41 +00002121 Diags.Report(Range.getBegin(), DiagID)
Alexey Baderbdf7c842015-09-15 12:18:29 +00002122 << T->getName(Context.getASTContext().getPrintingPolicy()) << Range;
Guy Benyei11169dd2012-12-18 14:30:41 +00002123 break;
2124 }
2125 }
2126}
2127
2128// <type> ::= <function-type>
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002129void MicrosoftCXXNameMangler::mangleType(const FunctionProtoType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002130 SourceRange) {
2131 // Structors only appear in decls, so at this point we know it's not a
2132 // structor type.
2133 // FIXME: This may not be lambda-friendly.
Anastasia Stulovac61eaa52019-01-28 11:37:49 +00002134 if (T->getMethodQuals() || T->getRefQualifier() != RQ_None) {
David Majnemer2f6a96e2014-08-12 17:53:10 +00002135 Out << "$$A8@@";
2136 mangleFunctionType(T, /*D=*/nullptr, /*ForceThisQuals=*/true);
2137 } else {
2138 Out << "$$A6";
2139 mangleFunctionType(T);
2140 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002141}
2142void MicrosoftCXXNameMangler::mangleType(const FunctionNoProtoType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002143 Qualifiers, SourceRange) {
Peter Collingbourneeeebc412015-08-07 23:25:47 +00002144 Out << "$$A6";
2145 mangleFunctionType(T);
Guy Benyei11169dd2012-12-18 14:30:41 +00002146}
2147
Peter Collingbourne2816c022013-04-25 04:25:40 +00002148void MicrosoftCXXNameMangler::mangleFunctionType(const FunctionType *T,
2149 const FunctionDecl *D,
Reid Klecknerd2f98772018-12-17 23:10:43 +00002150 bool ForceThisQuals,
2151 bool MangleExceptionSpec) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002152 // <function-type> ::= <this-cvr-qualifiers> <calling-convention>
2153 // <return-type> <argument-list> <throw-spec>
Peter Collingbourneeeebc412015-08-07 23:25:47 +00002154 const FunctionProtoType *Proto = dyn_cast<FunctionProtoType>(T);
Guy Benyei11169dd2012-12-18 14:30:41 +00002155
Reid Kleckner18da98e2013-06-24 19:21:52 +00002156 SourceRange Range;
2157 if (D) Range = D->getSourceRange();
2158
David Majnemer41311192016-01-17 07:09:24 +00002159 bool IsInLambda = false;
David Majnemerdfa6d202015-03-11 18:36:39 +00002160 bool IsStructor = false, HasThisQuals = ForceThisQuals, IsCtorClosure = false;
2161 CallingConv CC = T->getCallConv();
Timur Iskhodzhanov555a7722013-10-04 11:25:05 +00002162 if (const CXXMethodDecl *MD = dyn_cast_or_null<CXXMethodDecl>(D)) {
David Majnemer41311192016-01-17 07:09:24 +00002163 if (MD->getParent()->isLambda())
2164 IsInLambda = true;
Timur Iskhodzhanov555a7722013-10-04 11:25:05 +00002165 if (MD->isInstance())
David Majnemer2f6a96e2014-08-12 17:53:10 +00002166 HasThisQuals = true;
David Majnemerdfa6d202015-03-11 18:36:39 +00002167 if (isa<CXXDestructorDecl>(MD)) {
Timur Iskhodzhanov555a7722013-10-04 11:25:05 +00002168 IsStructor = true;
David Majnemerdfa6d202015-03-11 18:36:39 +00002169 } else if (isa<CXXConstructorDecl>(MD)) {
2170 IsStructor = true;
2171 IsCtorClosure = (StructorType == Ctor_CopyingClosure ||
2172 StructorType == Ctor_DefaultClosure) &&
Reid Kleckner290feb92017-01-09 17:04:37 +00002173 isStructorDecl(MD);
David Majnemerdfa6d202015-03-11 18:36:39 +00002174 if (IsCtorClosure)
2175 CC = getASTContext().getDefaultCallingConvention(
2176 /*IsVariadic=*/false, /*IsCXXMethod=*/true);
2177 }
Timur Iskhodzhanov555a7722013-10-04 11:25:05 +00002178 }
2179
Guy Benyei11169dd2012-12-18 14:30:41 +00002180 // If this is a C++ instance method, mangle the CVR qualifiers for the
2181 // this pointer.
David Majnemer2f6a96e2014-08-12 17:53:10 +00002182 if (HasThisQuals) {
Anastasia Stulovac61eaa52019-01-28 11:37:49 +00002183 Qualifiers Quals = Proto->getMethodQuals();
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002184 manglePointerExtQualifiers(Quals, /*PointeeType=*/QualType());
David Majnemere3785bb2014-04-23 05:16:56 +00002185 mangleRefQualifier(Proto->getRefQualifier());
David Majnemer2f6a96e2014-08-12 17:53:10 +00002186 mangleQualifiers(Quals, /*IsMember=*/false);
David Majnemer6dda7bb2013-08-15 08:13:23 +00002187 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002188
David Majnemerdfa6d202015-03-11 18:36:39 +00002189 mangleCallingConvention(CC);
Guy Benyei11169dd2012-12-18 14:30:41 +00002190
2191 // <return-type> ::= <type>
2192 // ::= @ # structors (they have no declared return type)
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002193 if (IsStructor) {
David Majnemerdc169752017-02-14 00:54:11 +00002194 if (isa<CXXDestructorDecl>(D) && isStructorDecl(D)) {
2195 // The scalar deleting destructor takes an extra int argument which is not
2196 // reflected in the AST.
2197 if (StructorType == Dtor_Deleting) {
2198 Out << (PointersAre64Bit ? "PEAXI@Z" : "PAXI@Z");
2199 return;
2200 }
2201 // The vbase destructor returns void which is not reflected in the AST.
2202 if (StructorType == Dtor_Complete) {
2203 Out << "XXZ";
2204 return;
2205 }
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002206 }
David Majnemerdfa6d202015-03-11 18:36:39 +00002207 if (IsCtorClosure) {
2208 // Default constructor closure and copy constructor closure both return
2209 // void.
2210 Out << 'X';
2211
2212 if (StructorType == Ctor_DefaultClosure) {
2213 // Default constructor closure always has no arguments.
2214 Out << 'X';
2215 } else if (StructorType == Ctor_CopyingClosure) {
2216 // Copy constructor closure always takes an unqualified reference.
Nico Weber73f05842019-06-01 10:12:07 +00002217 mangleFunctionArgumentType(getASTContext().getLValueReferenceType(
2218 Proto->getParamType(0)
2219 ->getAs<LValueReferenceType>()
2220 ->getPointeeType(),
2221 /*SpelledAsLValue=*/true),
2222 Range);
David Majnemer37fd66e2015-03-13 22:36:55 +00002223 Out << '@';
David Majnemerdfa6d202015-03-11 18:36:39 +00002224 } else {
2225 llvm_unreachable("unexpected constructor closure!");
2226 }
David Majnemer37fd66e2015-03-13 22:36:55 +00002227 Out << 'Z';
David Majnemerdfa6d202015-03-11 18:36:39 +00002228 return;
2229 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002230 Out << '@';
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002231 } else {
Peter Collingbourneeeebc412015-08-07 23:25:47 +00002232 QualType ResultType = T->getReturnType();
David Majnemer2e1e04912014-04-01 05:29:46 +00002233 if (const auto *AT =
2234 dyn_cast_or_null<AutoType>(ResultType->getContainedAutoType())) {
2235 Out << '?';
2236 mangleQualifiers(ResultType.getLocalQualifiers(), /*IsMember=*/false);
2237 Out << '?';
Richard Smithe301ba22015-11-11 02:02:15 +00002238 assert(AT->getKeyword() != AutoTypeKeyword::GNUAutoType &&
2239 "shouldn't need to mangle __auto_type!");
David Majnemer2e1e04912014-04-01 05:29:46 +00002240 mangleSourceName(AT->isDecltypeAuto() ? "<decltype-auto>" : "<auto>");
2241 Out << '@';
David Majnemer41311192016-01-17 07:09:24 +00002242 } else if (IsInLambda) {
2243 Out << '@';
David Majnemer2e1e04912014-04-01 05:29:46 +00002244 } else {
2245 if (ResultType->isVoidType())
2246 ResultType = ResultType.getUnqualifiedType();
2247 mangleType(ResultType, Range, QMM_Result);
2248 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002249 }
2250
2251 // <argument-list> ::= X # void
2252 // ::= <type>+ @
2253 // ::= <type>* Z # varargs
Peter Collingbourneeeebc412015-08-07 23:25:47 +00002254 if (!Proto) {
2255 // Function types without prototypes can arise when mangling a function type
2256 // within an overloadable function in C. We mangle these as the absence of
2257 // any parameter types (not even an empty parameter list).
2258 Out << '@';
2259 } else if (Proto->getNumParams() == 0 && !Proto->isVariadic()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002260 Out << 'X';
2261 } else {
Reid Kleckner18da98e2013-06-24 19:21:52 +00002262 // Happens for function pointer type arguments for example.
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00002263 for (unsigned I = 0, E = Proto->getNumParams(); I != E; ++I) {
Nico Weber73f05842019-06-01 10:12:07 +00002264 mangleFunctionArgumentType(Proto->getParamType(I), Range);
Simon Pilgrim27cc0542017-02-15 15:12:06 +00002265 // Mangle each pass_object_size parameter as if it's a parameter of enum
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00002266 // type passed directly after the parameter with the pass_object_size
2267 // attribute. The aforementioned enum's name is __pass_object_size, and we
2268 // pretend it resides in a top-level namespace called __clang.
2269 //
2270 // FIXME: Is there a defined extension notation for the MS ABI, or is it
2271 // necessary to just cross our fingers and hope this type+namespace
2272 // combination doesn't conflict with anything?
2273 if (D)
David Majnemer5f177622015-12-30 05:13:03 +00002274 if (const auto *P = D->getParamDecl(I)->getAttr<PassObjectSizeAttr>())
2275 manglePassObjectSizeArg(P);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00002276 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002277 // <builtin-type> ::= Z # ellipsis
2278 if (Proto->isVariadic())
2279 Out << 'Z';
2280 else
2281 Out << '@';
2282 }
2283
Reid Klecknerd2f98772018-12-17 23:10:43 +00002284 if (MangleExceptionSpec && getASTContext().getLangOpts().CPlusPlus17 &&
2285 getASTContext().getLangOpts().isCompatibleWithMSVC(
2286 LangOptions::MSVC2017_5))
2287 mangleThrowSpecification(Proto);
2288 else
2289 Out << 'Z';
Guy Benyei11169dd2012-12-18 14:30:41 +00002290}
2291
2292void MicrosoftCXXNameMangler::mangleFunctionClass(const FunctionDecl *FD) {
Reid Kleckner369f3162013-05-14 20:30:42 +00002293 // <function-class> ::= <member-function> E? # E designates a 64-bit 'this'
2294 // # pointer. in 64-bit mode *all*
2295 // # 'this' pointers are 64-bit.
2296 // ::= <global-function>
2297 // <member-function> ::= A # private: near
2298 // ::= B # private: far
2299 // ::= C # private: static near
2300 // ::= D # private: static far
2301 // ::= E # private: virtual near
2302 // ::= F # private: virtual far
Reid Kleckner369f3162013-05-14 20:30:42 +00002303 // ::= I # protected: near
2304 // ::= J # protected: far
2305 // ::= K # protected: static near
2306 // ::= L # protected: static far
2307 // ::= M # protected: virtual near
2308 // ::= N # protected: virtual far
Reid Kleckner369f3162013-05-14 20:30:42 +00002309 // ::= Q # public: near
2310 // ::= R # public: far
2311 // ::= S # public: static near
2312 // ::= T # public: static far
2313 // ::= U # public: virtual near
2314 // ::= V # public: virtual far
Reid Kleckner369f3162013-05-14 20:30:42 +00002315 // <global-function> ::= Y # global near
2316 // ::= Z # global far
Guy Benyei11169dd2012-12-18 14:30:41 +00002317 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD)) {
David Majnemerdc169752017-02-14 00:54:11 +00002318 bool IsVirtual = MD->isVirtual();
2319 // When mangling vbase destructor variants, ignore whether or not the
2320 // underlying destructor was defined to be virtual.
2321 if (isa<CXXDestructorDecl>(MD) && isStructorDecl(MD) &&
2322 StructorType == Dtor_Complete) {
2323 IsVirtual = false;
2324 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002325 switch (MD->getAccess()) {
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00002326 case AS_none:
2327 llvm_unreachable("Unsupported access specifier");
Guy Benyei11169dd2012-12-18 14:30:41 +00002328 case AS_private:
2329 if (MD->isStatic())
2330 Out << 'C';
David Majnemerdc169752017-02-14 00:54:11 +00002331 else if (IsVirtual)
Guy Benyei11169dd2012-12-18 14:30:41 +00002332 Out << 'E';
2333 else
2334 Out << 'A';
2335 break;
2336 case AS_protected:
2337 if (MD->isStatic())
2338 Out << 'K';
David Majnemerdc169752017-02-14 00:54:11 +00002339 else if (IsVirtual)
Guy Benyei11169dd2012-12-18 14:30:41 +00002340 Out << 'M';
2341 else
2342 Out << 'I';
2343 break;
2344 case AS_public:
2345 if (MD->isStatic())
2346 Out << 'S';
David Majnemerdc169752017-02-14 00:54:11 +00002347 else if (IsVirtual)
Guy Benyei11169dd2012-12-18 14:30:41 +00002348 Out << 'U';
2349 else
2350 Out << 'Q';
2351 }
David Majnemer5a7cfea2015-05-18 00:05:29 +00002352 } else {
Guy Benyei11169dd2012-12-18 14:30:41 +00002353 Out << 'Y';
David Majnemer5a7cfea2015-05-18 00:05:29 +00002354 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002355}
David Majnemerdfa6d202015-03-11 18:36:39 +00002356void MicrosoftCXXNameMangler::mangleCallingConvention(CallingConv CC) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002357 // <calling-convention> ::= A # __cdecl
2358 // ::= B # __export __cdecl
2359 // ::= C # __pascal
2360 // ::= D # __export __pascal
2361 // ::= E # __thiscall
2362 // ::= F # __export __thiscall
2363 // ::= G # __stdcall
2364 // ::= H # __export __stdcall
2365 // ::= I # __fastcall
2366 // ::= J # __export __fastcall
Reid Klecknerd7857f02014-10-24 17:42:17 +00002367 // ::= Q # __vectorcall
Erich Keane757d3172016-11-02 18:29:35 +00002368 // ::= w # __regcall
Guy Benyei11169dd2012-12-18 14:30:41 +00002369 // The 'export' calling conventions are from a bygone era
2370 // (*cough*Win16*cough*) when functions were declared for export with
2371 // that keyword. (It didn't actually export them, it just made them so
2372 // that they could be in a DLL and somebody from another module could call
2373 // them.)
David Majnemerdfa6d202015-03-11 18:36:39 +00002374
Guy Benyei11169dd2012-12-18 14:30:41 +00002375 switch (CC) {
2376 default:
2377 llvm_unreachable("Unsupported CC for mangling");
Martin Storsjo022e7822017-07-17 20:49:45 +00002378 case CC_Win64:
Charles Davisb5a214e2013-08-30 04:39:01 +00002379 case CC_X86_64SysV:
Guy Benyei11169dd2012-12-18 14:30:41 +00002380 case CC_C: Out << 'A'; break;
2381 case CC_X86Pascal: Out << 'C'; break;
2382 case CC_X86ThisCall: Out << 'E'; break;
2383 case CC_X86StdCall: Out << 'G'; break;
2384 case CC_X86FastCall: Out << 'I'; break;
Reid Klecknerd7857f02014-10-24 17:42:17 +00002385 case CC_X86VectorCall: Out << 'Q'; break;
Saleem Abdulrasool58340522018-02-07 01:55:08 +00002386 case CC_Swift: Out << 'S'; break;
Saleem Abdulrasool13aeee02018-04-02 22:25:50 +00002387 case CC_PreserveMost: Out << 'U'; break;
Erich Keane757d3172016-11-02 18:29:35 +00002388 case CC_X86RegCall: Out << 'w'; break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002389 }
2390}
David Majnemerdfa6d202015-03-11 18:36:39 +00002391void MicrosoftCXXNameMangler::mangleCallingConvention(const FunctionType *T) {
2392 mangleCallingConvention(T->getCallConv());
2393}
Reid Klecknerd2f98772018-12-17 23:10:43 +00002394
Guy Benyei11169dd2012-12-18 14:30:41 +00002395void MicrosoftCXXNameMangler::mangleThrowSpecification(
2396 const FunctionProtoType *FT) {
Reid Klecknerd2f98772018-12-17 23:10:43 +00002397 // <throw-spec> ::= Z # (default)
2398 // ::= _E # noexcept
2399 if (FT->canThrow())
2400 Out << 'Z';
2401 else
2402 Out << "_E";
Guy Benyei11169dd2012-12-18 14:30:41 +00002403}
2404
2405void MicrosoftCXXNameMangler::mangleType(const UnresolvedUsingType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002406 Qualifiers, SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002407 // Probably should be mangled as a template instantiation; need to see what
2408 // VC does first.
2409 DiagnosticsEngine &Diags = Context.getDiags();
2410 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2411 "cannot mangle this unresolved dependent type yet");
2412 Diags.Report(Range.getBegin(), DiagID)
2413 << Range;
2414}
2415
2416// <type> ::= <union-type> | <struct-type> | <class-type> | <enum-type>
2417// <union-type> ::= T <name>
2418// <struct-type> ::= U <name>
2419// <class-type> ::= V <name>
David Majnemer048f90c2013-12-09 04:28:34 +00002420// <enum-type> ::= W4 <name>
David Majnemer3add70b2015-12-29 11:45:53 +00002421void MicrosoftCXXNameMangler::mangleTagTypeKind(TagTypeKind TTK) {
2422 switch (TTK) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002423 case TTK_Union:
2424 Out << 'T';
2425 break;
2426 case TTK_Struct:
2427 case TTK_Interface:
2428 Out << 'U';
2429 break;
2430 case TTK_Class:
2431 Out << 'V';
2432 break;
2433 case TTK_Enum:
David Majnemer048f90c2013-12-09 04:28:34 +00002434 Out << "W4";
Guy Benyei11169dd2012-12-18 14:30:41 +00002435 break;
2436 }
David Majnemer3add70b2015-12-29 11:45:53 +00002437}
2438void MicrosoftCXXNameMangler::mangleType(const EnumType *T, Qualifiers,
2439 SourceRange) {
2440 mangleType(cast<TagType>(T)->getDecl());
2441}
2442void MicrosoftCXXNameMangler::mangleType(const RecordType *T, Qualifiers,
2443 SourceRange) {
2444 mangleType(cast<TagType>(T)->getDecl());
2445}
2446void MicrosoftCXXNameMangler::mangleType(const TagDecl *TD) {
2447 mangleTagTypeKind(TD->getTagKind());
David Majnemer0db0ca42013-08-05 22:26:46 +00002448 mangleName(TD);
Guy Benyei11169dd2012-12-18 14:30:41 +00002449}
Nico Weber3239f132018-07-23 20:04:00 +00002450
2451// If you add a call to this, consider updating isArtificialTagType() too.
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002452void MicrosoftCXXNameMangler::mangleArtificialTagType(
Nico Weber2b5f3fd2018-08-01 11:56:20 +00002453 TagTypeKind TK, StringRef UnqualifiedName,
2454 ArrayRef<StringRef> NestedNames) {
David Majnemer3add70b2015-12-29 11:45:53 +00002455 // <name> ::= <unscoped-name> {[<named-scope>]+ | [<nested-name>]}? @
2456 mangleTagTypeKind(TK);
2457
2458 // Always start with the unqualified name.
2459 mangleSourceName(UnqualifiedName);
2460
2461 for (auto I = NestedNames.rbegin(), E = NestedNames.rend(); I != E; ++I)
2462 mangleSourceName(*I);
2463
2464 // Terminate the whole name with an '@'.
2465 Out << '@';
2466}
Guy Benyei11169dd2012-12-18 14:30:41 +00002467
2468// <type> ::= <array-type>
2469// <array-type> ::= <pointer-cvr-qualifiers> <cvr-qualifiers>
2470// [Y <dimension-count> <dimension>+]
Reid Kleckner369f3162013-05-14 20:30:42 +00002471// <element-type> # as global, E is never required
Guy Benyei11169dd2012-12-18 14:30:41 +00002472// It's supposed to be the other way around, but for some strange reason, it
2473// isn't. Today this behavior is retained for the sole purpose of backwards
2474// compatibility.
David Majnemer5a1b2042013-09-11 04:44:30 +00002475void MicrosoftCXXNameMangler::mangleDecayedArrayType(const ArrayType *T) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002476 // This isn't a recursive mangling, so now we have to do it all in this
2477 // one call.
David Majnemer8eec58f2014-02-18 14:20:10 +00002478 manglePointerCVQualifiers(T->getElementType().getQualifiers());
Peter Collingbourne2816c022013-04-25 04:25:40 +00002479 mangleType(T->getElementType(), SourceRange());
Guy Benyei11169dd2012-12-18 14:30:41 +00002480}
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002481void MicrosoftCXXNameMangler::mangleType(const ConstantArrayType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002482 SourceRange) {
Peter Collingbourne2816c022013-04-25 04:25:40 +00002483 llvm_unreachable("Should have been special cased");
Guy Benyei11169dd2012-12-18 14:30:41 +00002484}
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002485void MicrosoftCXXNameMangler::mangleType(const VariableArrayType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002486 SourceRange) {
Peter Collingbourne2816c022013-04-25 04:25:40 +00002487 llvm_unreachable("Should have been special cased");
Guy Benyei11169dd2012-12-18 14:30:41 +00002488}
2489void MicrosoftCXXNameMangler::mangleType(const DependentSizedArrayType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002490 Qualifiers, SourceRange) {
Peter Collingbourne2816c022013-04-25 04:25:40 +00002491 llvm_unreachable("Should have been special cased");
Guy Benyei11169dd2012-12-18 14:30:41 +00002492}
2493void MicrosoftCXXNameMangler::mangleType(const IncompleteArrayType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002494 Qualifiers, SourceRange) {
Peter Collingbourne2816c022013-04-25 04:25:40 +00002495 llvm_unreachable("Should have been special cased");
Guy Benyei11169dd2012-12-18 14:30:41 +00002496}
Reid Kleckner18da98e2013-06-24 19:21:52 +00002497void MicrosoftCXXNameMangler::mangleArrayType(const ArrayType *T) {
Peter Collingbourne2816c022013-04-25 04:25:40 +00002498 QualType ElementTy(T, 0);
Guy Benyei11169dd2012-12-18 14:30:41 +00002499 SmallVector<llvm::APInt, 3> Dimensions;
2500 for (;;) {
David Majnemer9595b7d2015-04-23 07:42:08 +00002501 if (ElementTy->isConstantArrayType()) {
2502 const ConstantArrayType *CAT =
2503 getASTContext().getAsConstantArrayType(ElementTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00002504 Dimensions.push_back(CAT->getSize());
2505 ElementTy = CAT->getElementType();
David Majnemer9595b7d2015-04-23 07:42:08 +00002506 } else if (ElementTy->isIncompleteArrayType()) {
2507 const IncompleteArrayType *IAT =
2508 getASTContext().getAsIncompleteArrayType(ElementTy);
2509 Dimensions.push_back(llvm::APInt(32, 0));
2510 ElementTy = IAT->getElementType();
Guy Benyei11169dd2012-12-18 14:30:41 +00002511 } else if (ElementTy->isVariableArrayType()) {
2512 const VariableArrayType *VAT =
2513 getASTContext().getAsVariableArrayType(ElementTy);
David Majnemer9595b7d2015-04-23 07:42:08 +00002514 Dimensions.push_back(llvm::APInt(32, 0));
2515 ElementTy = VAT->getElementType();
Guy Benyei11169dd2012-12-18 14:30:41 +00002516 } else if (ElementTy->isDependentSizedArrayType()) {
2517 // The dependent expression has to be folded into a constant (TODO).
2518 const DependentSizedArrayType *DSAT =
2519 getASTContext().getAsDependentSizedArrayType(ElementTy);
2520 DiagnosticsEngine &Diags = Context.getDiags();
2521 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2522 "cannot mangle this dependent-length array yet");
2523 Diags.Report(DSAT->getSizeExpr()->getExprLoc(), DiagID)
2524 << DSAT->getBracketsRange();
2525 return;
David Majnemer9595b7d2015-04-23 07:42:08 +00002526 } else {
2527 break;
Peter Collingbourne2816c022013-04-25 04:25:40 +00002528 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002529 }
Peter Collingbourne2816c022013-04-25 04:25:40 +00002530 Out << 'Y';
2531 // <dimension-count> ::= <number> # number of extra dimensions
2532 mangleNumber(Dimensions.size());
David Majnemerb926dbc2014-04-23 05:16:53 +00002533 for (const llvm::APInt &Dimension : Dimensions)
2534 mangleNumber(Dimension.getLimitedValue());
Reid Kleckner18da98e2013-06-24 19:21:52 +00002535 mangleType(ElementTy, SourceRange(), QMM_Escape);
Guy Benyei11169dd2012-12-18 14:30:41 +00002536}
2537
2538// <type> ::= <pointer-to-member-type>
2539// <pointer-to-member-type> ::= <pointer-cvr-qualifiers> <cvr-qualifiers>
2540// <class name> <type>
Nico Weber2b5f3fd2018-08-01 11:56:20 +00002541void MicrosoftCXXNameMangler::mangleType(const MemberPointerType *T,
2542 Qualifiers Quals, SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002543 QualType PointeeType = T->getPointeeType();
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002544 manglePointerCVQualifiers(Quals);
2545 manglePointerExtQualifiers(Quals, PointeeType);
Guy Benyei11169dd2012-12-18 14:30:41 +00002546 if (const FunctionProtoType *FPT = PointeeType->getAs<FunctionProtoType>()) {
2547 Out << '8';
2548 mangleName(T->getClass()->castAs<RecordType>()->getDecl());
Craig Topper36250ad2014-05-12 05:36:57 +00002549 mangleFunctionType(FPT, nullptr, true);
Guy Benyei11169dd2012-12-18 14:30:41 +00002550 } else {
2551 mangleQualifiers(PointeeType.getQualifiers(), true);
2552 mangleName(T->getClass()->castAs<RecordType>()->getDecl());
Peter Collingbourne2816c022013-04-25 04:25:40 +00002553 mangleType(PointeeType, Range, QMM_Drop);
Guy Benyei11169dd2012-12-18 14:30:41 +00002554 }
2555}
2556
2557void MicrosoftCXXNameMangler::mangleType(const TemplateTypeParmType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002558 Qualifiers, SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002559 DiagnosticsEngine &Diags = Context.getDiags();
2560 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2561 "cannot mangle this template type parameter type yet");
2562 Diags.Report(Range.getBegin(), DiagID)
2563 << Range;
2564}
2565
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002566void MicrosoftCXXNameMangler::mangleType(const SubstTemplateTypeParmPackType *T,
2567 Qualifiers, SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002568 DiagnosticsEngine &Diags = Context.getDiags();
2569 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2570 "cannot mangle this substituted parameter pack yet");
2571 Diags.Report(Range.getBegin(), DiagID)
2572 << Range;
2573}
2574
2575// <type> ::= <pointer-type>
Reid Kleckner369f3162013-05-14 20:30:42 +00002576// <pointer-type> ::= E? <pointer-cvr-qualifiers> <cvr-qualifiers> <type>
Alp Tokerd4733632013-12-05 04:47:09 +00002577// # the E is required for 64-bit non-static pointers
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002578void MicrosoftCXXNameMangler::mangleType(const PointerType *T, Qualifiers Quals,
Guy Benyei11169dd2012-12-18 14:30:41 +00002579 SourceRange Range) {
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002580 QualType PointeeType = T->getPointeeType();
2581 manglePointerCVQualifiers(Quals);
2582 manglePointerExtQualifiers(Quals, PointeeType);
Erich Keane24a0f042018-12-14 23:17:34 +00002583
Amy Huanga85f5ef2019-10-24 16:34:25 -07002584 // For pointer size address spaces, go down the same type mangling path as
2585 // non address space types.
2586 LangAS AddrSpace = PointeeType.getQualifiers().getAddressSpace();
2587 if (isPtrSizeAddressSpace(AddrSpace) || AddrSpace == LangAS::Default)
Erich Keane24a0f042018-12-14 23:17:34 +00002588 mangleType(PointeeType, Range);
Amy Huanga85f5ef2019-10-24 16:34:25 -07002589 else
2590 mangleAddressSpaceType(PointeeType, PointeeType.getQualifiers(), Range);
Guy Benyei11169dd2012-12-18 14:30:41 +00002591}
Saleem Abdulrasool5a3e50a2017-08-23 22:38:58 +00002592
Guy Benyei11169dd2012-12-18 14:30:41 +00002593void MicrosoftCXXNameMangler::mangleType(const ObjCObjectPointerType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002594 Qualifiers Quals, SourceRange Range) {
2595 QualType PointeeType = T->getPointeeType();
Saleem Abdulrasoolbbce34a2018-02-09 03:23:54 +00002596 switch (Quals.getObjCLifetime()) {
2597 case Qualifiers::OCL_None:
2598 case Qualifiers::OCL_ExplicitNone:
2599 break;
2600 case Qualifiers::OCL_Autoreleasing:
2601 case Qualifiers::OCL_Strong:
2602 case Qualifiers::OCL_Weak:
2603 return mangleObjCLifetime(PointeeType, Quals, Range);
2604 }
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002605 manglePointerCVQualifiers(Quals);
2606 manglePointerExtQualifiers(Quals, PointeeType);
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002607 mangleType(PointeeType, Range);
Guy Benyei11169dd2012-12-18 14:30:41 +00002608}
2609
2610// <type> ::= <reference-type>
Reid Kleckner369f3162013-05-14 20:30:42 +00002611// <reference-type> ::= A E? <cvr-qualifiers> <type>
Alp Tokerd4733632013-12-05 04:47:09 +00002612// # the E is required for 64-bit non-static lvalue references
Guy Benyei11169dd2012-12-18 14:30:41 +00002613void MicrosoftCXXNameMangler::mangleType(const LValueReferenceType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002614 Qualifiers Quals, SourceRange Range) {
2615 QualType PointeeType = T->getPointeeType();
David Majnemere3d71912015-12-31 05:36:50 +00002616 assert(!Quals.hasConst() && !Quals.hasVolatile() && "unexpected qualifier!");
2617 Out << 'A';
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002618 manglePointerExtQualifiers(Quals, PointeeType);
2619 mangleType(PointeeType, Range);
Guy Benyei11169dd2012-12-18 14:30:41 +00002620}
2621
2622// <type> ::= <r-value-reference-type>
Reid Kleckner369f3162013-05-14 20:30:42 +00002623// <r-value-reference-type> ::= $$Q E? <cvr-qualifiers> <type>
Alp Tokerd4733632013-12-05 04:47:09 +00002624// # the E is required for 64-bit non-static rvalue references
Guy Benyei11169dd2012-12-18 14:30:41 +00002625void MicrosoftCXXNameMangler::mangleType(const RValueReferenceType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002626 Qualifiers Quals, SourceRange Range) {
2627 QualType PointeeType = T->getPointeeType();
David Majnemere3d71912015-12-31 05:36:50 +00002628 assert(!Quals.hasConst() && !Quals.hasVolatile() && "unexpected qualifier!");
2629 Out << "$$Q";
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002630 manglePointerExtQualifiers(Quals, PointeeType);
2631 mangleType(PointeeType, Range);
Guy Benyei11169dd2012-12-18 14:30:41 +00002632}
2633
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002634void MicrosoftCXXNameMangler::mangleType(const ComplexType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002635 SourceRange Range) {
David Majnemer0b996dd2015-12-29 22:02:15 +00002636 QualType ElementType = T->getElementType();
2637
2638 llvm::SmallString<64> TemplateMangling;
2639 llvm::raw_svector_ostream Stream(TemplateMangling);
2640 MicrosoftCXXNameMangler Extra(Context, Stream);
2641 Stream << "?$";
2642 Extra.mangleSourceName("_Complex");
2643 Extra.mangleType(ElementType, Range, QMM_Escape);
2644
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002645 mangleArtificialTagType(TTK_Struct, TemplateMangling, {"__clang"});
Guy Benyei11169dd2012-12-18 14:30:41 +00002646}
2647
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002648// Returns true for types that mangleArtificialTagType() gets called for with
Nico Weber3239f132018-07-23 20:04:00 +00002649// TTK_Union, TTK_Struct, TTK_Class and where compatibility with MSVC's
2650// mangling matters.
2651// (It doesn't matter for Objective-C types and the like that cl.exe doesn't
2652// support.)
2653bool MicrosoftCXXNameMangler::isArtificialTagType(QualType T) const {
2654 const Type *ty = T.getTypePtr();
2655 switch (ty->getTypeClass()) {
2656 default:
2657 return false;
2658
2659 case Type::Vector: {
2660 // For ABI compatibility only __m64, __m128(id), and __m256(id) matter,
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002661 // but since mangleType(VectorType*) always calls mangleArtificialTagType()
Nico Weber3239f132018-07-23 20:04:00 +00002662 // just always return true (the other vector types are clang-only).
2663 return true;
2664 }
2665 }
2666}
2667
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002668void MicrosoftCXXNameMangler::mangleType(const VectorType *T, Qualifiers Quals,
Guy Benyei11169dd2012-12-18 14:30:41 +00002669 SourceRange Range) {
Reid Klecknere7e64d82013-03-26 16:56:59 +00002670 const BuiltinType *ET = T->getElementType()->getAs<BuiltinType>();
2671 assert(ET && "vectors with non-builtin elements are unsupported");
2672 uint64_t Width = getASTContext().getTypeSize(T);
2673 // Pattern match exactly the typedefs in our intrinsic headers. Anything that
2674 // doesn't match the Intel types uses a custom mangling below.
David Majnemer0a29fed2015-12-29 11:45:58 +00002675 size_t OutSizeBefore = Out.tell();
Saleem Abdulrasool21568182018-10-28 18:05:20 +00002676 if (!isa<ExtVectorType>(T)) {
Fangrui Song6904cd92020-01-06 10:16:28 -08002677 if (getASTContext().getTargetInfo().getTriple().isX86()) {
Saleem Abdulrasool21568182018-10-28 18:05:20 +00002678 if (Width == 64 && ET->getKind() == BuiltinType::LongLong) {
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002679 mangleArtificialTagType(TTK_Union, "__m64");
Saleem Abdulrasool21568182018-10-28 18:05:20 +00002680 } else if (Width >= 128) {
2681 if (ET->getKind() == BuiltinType::Float)
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002682 mangleArtificialTagType(TTK_Union, "__m" + llvm::utostr(Width));
Saleem Abdulrasool21568182018-10-28 18:05:20 +00002683 else if (ET->getKind() == BuiltinType::LongLong)
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002684 mangleArtificialTagType(TTK_Union, "__m" + llvm::utostr(Width) + 'i');
Saleem Abdulrasool21568182018-10-28 18:05:20 +00002685 else if (ET->getKind() == BuiltinType::Double)
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002686 mangleArtificialTagType(TTK_Struct, "__m" + llvm::utostr(Width) + 'd');
Saleem Abdulrasool21568182018-10-28 18:05:20 +00002687 }
David Majnemerf04e3862015-06-01 07:41:37 +00002688 }
Reid Klecknere7e64d82013-03-26 16:56:59 +00002689 }
2690
David Majnemer0a29fed2015-12-29 11:45:58 +00002691 bool IsBuiltin = Out.tell() != OutSizeBefore;
David Majnemerf04e3862015-06-01 07:41:37 +00002692 if (!IsBuiltin) {
Reid Klecknere7e64d82013-03-26 16:56:59 +00002693 // The MS ABI doesn't have a special mangling for vector types, so we define
2694 // our own mangling to handle uses of __vector_size__ on user-specified
2695 // types, and for extensions like __v4sf.
David Majnemer0a29fed2015-12-29 11:45:58 +00002696
2697 llvm::SmallString<64> TemplateMangling;
2698 llvm::raw_svector_ostream Stream(TemplateMangling);
2699 MicrosoftCXXNameMangler Extra(Context, Stream);
2700 Stream << "?$";
2701 Extra.mangleSourceName("__vector");
2702 Extra.mangleType(QualType(ET, 0), Range, QMM_Escape);
2703 Extra.mangleIntegerLiteral(llvm::APSInt::getUnsigned(T->getNumElements()),
2704 /*IsBoolean=*/false);
2705
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002706 mangleArtificialTagType(TTK_Union, TemplateMangling, {"__clang"});
Reid Klecknere7e64d82013-03-26 16:56:59 +00002707 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002708}
Reid Klecknere7e64d82013-03-26 16:56:59 +00002709
David Majnemere5c87872015-08-01 05:51:55 +00002710void MicrosoftCXXNameMangler::mangleType(const ExtVectorType *T,
2711 Qualifiers Quals, SourceRange Range) {
2712 mangleType(static_cast<const VectorType *>(T), Quals, Range);
Guy Benyei11169dd2012-12-18 14:30:41 +00002713}
Erich Keanef702b022018-07-13 19:46:04 +00002714
2715void MicrosoftCXXNameMangler::mangleType(const DependentVectorType *T,
2716 Qualifiers, SourceRange Range) {
2717 DiagnosticsEngine &Diags = Context.getDiags();
2718 unsigned DiagID = Diags.getCustomDiagID(
2719 DiagnosticsEngine::Error,
2720 "cannot mangle this dependent-sized vector type yet");
2721 Diags.Report(Range.getBegin(), DiagID) << Range;
2722}
2723
Guy Benyei11169dd2012-12-18 14:30:41 +00002724void MicrosoftCXXNameMangler::mangleType(const DependentSizedExtVectorType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002725 Qualifiers, SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002726 DiagnosticsEngine &Diags = Context.getDiags();
2727 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2728 "cannot mangle this dependent-sized extended vector type yet");
2729 Diags.Report(Range.getBegin(), DiagID)
2730 << Range;
2731}
2732
Andrew Gozillon572bbb02017-10-02 06:25:51 +00002733void MicrosoftCXXNameMangler::mangleType(const DependentAddressSpaceType *T,
2734 Qualifiers, SourceRange Range) {
2735 DiagnosticsEngine &Diags = Context.getDiags();
2736 unsigned DiagID = Diags.getCustomDiagID(
2737 DiagnosticsEngine::Error,
2738 "cannot mangle this dependent address space type yet");
2739 Diags.Report(Range.getBegin(), DiagID) << Range;
2740}
2741
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002742void MicrosoftCXXNameMangler::mangleType(const ObjCInterfaceType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002743 SourceRange) {
Shoaib Meenaic8714d22018-10-04 19:50:14 +00002744 // ObjC interfaces have structs underlying them.
David Majnemer3add70b2015-12-29 11:45:53 +00002745 mangleTagTypeKind(TTK_Struct);
Shoaib Meenaic8714d22018-10-04 19:50:14 +00002746 mangleName(T->getDecl());
Guy Benyei11169dd2012-12-18 14:30:41 +00002747}
2748
Saleem Abdulrasoolf3a981e2018-09-28 16:47:53 +00002749void MicrosoftCXXNameMangler::mangleType(const ObjCObjectType *T,
2750 Qualifiers Quals, SourceRange Range) {
2751 if (T->isKindOfType())
2752 return mangleObjCKindOfType(T, Quals, Range);
2753
2754 if (T->qual_empty() && !T->isSpecialized())
Saleem Abdulrasoolf591e362018-01-26 19:08:26 +00002755 return mangleType(T->getBaseType(), Range, QMM_Drop);
2756
Nico Weber73f05842019-06-01 10:12:07 +00002757 ArgBackRefMap OuterFunArgsContext;
2758 ArgBackRefMap OuterTemplateArgsContext;
Saleem Abdulrasoolf591e362018-01-26 19:08:26 +00002759 BackRefVec OuterTemplateContext;
2760
Nico Weber73f05842019-06-01 10:12:07 +00002761 FunArgBackReferences.swap(OuterFunArgsContext);
2762 TemplateArgBackReferences.swap(OuterTemplateArgsContext);
Saleem Abdulrasoolf591e362018-01-26 19:08:26 +00002763 NameBackReferences.swap(OuterTemplateContext);
2764
2765 mangleTagTypeKind(TTK_Struct);
2766
2767 Out << "?$";
2768 if (T->isObjCId())
Shoaib Meenaic8714d22018-10-04 19:50:14 +00002769 mangleSourceName("objc_object");
Saleem Abdulrasoolf591e362018-01-26 19:08:26 +00002770 else if (T->isObjCClass())
Shoaib Meenaic8714d22018-10-04 19:50:14 +00002771 mangleSourceName("objc_class");
Saleem Abdulrasoolf591e362018-01-26 19:08:26 +00002772 else
Shoaib Meenaic8714d22018-10-04 19:50:14 +00002773 mangleSourceName(T->getInterface()->getName());
Saleem Abdulrasoolf591e362018-01-26 19:08:26 +00002774
Saleem Abdulrasoolbbce34a2018-02-09 03:23:54 +00002775 for (const auto &Q : T->quals())
2776 mangleObjCProtocol(Q);
Saleem Abdulrasoolf3a981e2018-09-28 16:47:53 +00002777
2778 if (T->isSpecialized())
2779 for (const auto &TA : T->getTypeArgs())
2780 mangleType(TA, Range, QMM_Drop);
2781
Saleem Abdulrasoolf591e362018-01-26 19:08:26 +00002782 Out << '@';
2783
2784 Out << '@';
2785
Nico Weber73f05842019-06-01 10:12:07 +00002786 FunArgBackReferences.swap(OuterFunArgsContext);
2787 TemplateArgBackReferences.swap(OuterTemplateArgsContext);
Saleem Abdulrasoolf591e362018-01-26 19:08:26 +00002788 NameBackReferences.swap(OuterTemplateContext);
Guy Benyei11169dd2012-12-18 14:30:41 +00002789}
2790
2791void MicrosoftCXXNameMangler::mangleType(const BlockPointerType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002792 Qualifiers Quals, SourceRange Range) {
2793 QualType PointeeType = T->getPointeeType();
2794 manglePointerCVQualifiers(Quals);
2795 manglePointerExtQualifiers(Quals, PointeeType);
2796
Guy Benyei11169dd2012-12-18 14:30:41 +00002797 Out << "_E";
2798
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002799 mangleFunctionType(PointeeType->castAs<FunctionProtoType>());
Guy Benyei11169dd2012-12-18 14:30:41 +00002800}
2801
David Majnemerf0a84f22013-08-16 08:29:13 +00002802void MicrosoftCXXNameMangler::mangleType(const InjectedClassNameType *,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002803 Qualifiers, SourceRange) {
David Majnemerf0a84f22013-08-16 08:29:13 +00002804 llvm_unreachable("Cannot mangle injected class name type.");
Guy Benyei11169dd2012-12-18 14:30:41 +00002805}
2806
2807void MicrosoftCXXNameMangler::mangleType(const TemplateSpecializationType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002808 Qualifiers, SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002809 DiagnosticsEngine &Diags = Context.getDiags();
2810 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2811 "cannot mangle this template specialization type yet");
2812 Diags.Report(Range.getBegin(), DiagID)
2813 << Range;
2814}
2815
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002816void MicrosoftCXXNameMangler::mangleType(const DependentNameType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002817 SourceRange Range) {
2818 DiagnosticsEngine &Diags = Context.getDiags();
2819 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2820 "cannot mangle this dependent name type yet");
2821 Diags.Report(Range.getBegin(), DiagID)
2822 << Range;
2823}
2824
2825void MicrosoftCXXNameMangler::mangleType(
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002826 const DependentTemplateSpecializationType *T, Qualifiers,
2827 SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002828 DiagnosticsEngine &Diags = Context.getDiags();
2829 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2830 "cannot mangle this dependent template specialization type yet");
2831 Diags.Report(Range.getBegin(), DiagID)
2832 << Range;
2833}
2834
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002835void MicrosoftCXXNameMangler::mangleType(const PackExpansionType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002836 SourceRange Range) {
2837 DiagnosticsEngine &Diags = Context.getDiags();
2838 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2839 "cannot mangle this pack expansion yet");
2840 Diags.Report(Range.getBegin(), DiagID)
2841 << Range;
2842}
2843
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002844void MicrosoftCXXNameMangler::mangleType(const TypeOfType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002845 SourceRange Range) {
2846 DiagnosticsEngine &Diags = Context.getDiags();
2847 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2848 "cannot mangle this typeof(type) yet");
2849 Diags.Report(Range.getBegin(), DiagID)
2850 << Range;
2851}
2852
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002853void MicrosoftCXXNameMangler::mangleType(const TypeOfExprType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002854 SourceRange Range) {
2855 DiagnosticsEngine &Diags = Context.getDiags();
2856 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2857 "cannot mangle this typeof(expression) yet");
2858 Diags.Report(Range.getBegin(), DiagID)
2859 << Range;
2860}
2861
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002862void MicrosoftCXXNameMangler::mangleType(const DecltypeType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002863 SourceRange Range) {
2864 DiagnosticsEngine &Diags = Context.getDiags();
2865 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2866 "cannot mangle this decltype() yet");
2867 Diags.Report(Range.getBegin(), DiagID)
2868 << Range;
2869}
2870
2871void MicrosoftCXXNameMangler::mangleType(const UnaryTransformType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002872 Qualifiers, SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002873 DiagnosticsEngine &Diags = Context.getDiags();
2874 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2875 "cannot mangle this unary transform type yet");
2876 Diags.Report(Range.getBegin(), DiagID)
2877 << Range;
2878}
2879
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002880void MicrosoftCXXNameMangler::mangleType(const AutoType *T, Qualifiers,
2881 SourceRange Range) {
David Majnemerb9a5f2d2014-01-21 20:33:36 +00002882 assert(T->getDeducedType().isNull() && "expecting a dependent type!");
2883
Guy Benyei11169dd2012-12-18 14:30:41 +00002884 DiagnosticsEngine &Diags = Context.getDiags();
2885 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2886 "cannot mangle this 'auto' type yet");
2887 Diags.Report(Range.getBegin(), DiagID)
2888 << Range;
2889}
2890
Richard Smith600b5262017-01-26 20:40:47 +00002891void MicrosoftCXXNameMangler::mangleType(
2892 const DeducedTemplateSpecializationType *T, Qualifiers, SourceRange Range) {
2893 assert(T->getDeducedType().isNull() && "expecting a dependent type!");
2894
2895 DiagnosticsEngine &Diags = Context.getDiags();
2896 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2897 "cannot mangle this deduced class template specialization type yet");
2898 Diags.Report(Range.getBegin(), DiagID)
2899 << Range;
2900}
2901
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002902void MicrosoftCXXNameMangler::mangleType(const AtomicType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002903 SourceRange Range) {
David Majnemer3421fb62015-12-29 11:46:00 +00002904 QualType ValueType = T->getValueType();
2905
2906 llvm::SmallString<64> TemplateMangling;
2907 llvm::raw_svector_ostream Stream(TemplateMangling);
2908 MicrosoftCXXNameMangler Extra(Context, Stream);
2909 Stream << "?$";
2910 Extra.mangleSourceName("_Atomic");
2911 Extra.mangleType(ValueType, Range, QMM_Escape);
2912
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002913 mangleArtificialTagType(TTK_Struct, TemplateMangling, {"__clang"});
Guy Benyei11169dd2012-12-18 14:30:41 +00002914}
2915
Xiuli Pan9c14e282016-01-09 12:53:17 +00002916void MicrosoftCXXNameMangler::mangleType(const PipeType *T, Qualifiers,
2917 SourceRange Range) {
Erich Keane86e0a6c2020-03-05 08:10:00 -08002918 QualType ElementType = T->getElementType();
2919
2920 llvm::SmallString<64> TemplateMangling;
2921 llvm::raw_svector_ostream Stream(TemplateMangling);
2922 MicrosoftCXXNameMangler Extra(Context, Stream);
2923 Stream << "?$";
2924 Extra.mangleSourceName("ocl_pipe");
2925 Extra.mangleType(ElementType, Range, QMM_Escape);
2926 Extra.mangleIntegerLiteral(llvm::APSInt::get(T->isReadOnly()), true);
2927
2928 mangleArtificialTagType(TTK_Struct, TemplateMangling, {"__clang"});
Xiuli Pan9c14e282016-01-09 12:53:17 +00002929}
2930
Yaxun (Sam) Liu29e1a162020-03-05 12:02:13 -05002931void MicrosoftMangleContextImpl::mangleCXXName(GlobalDecl GD,
Rafael Espindola002667c2013-10-16 01:40:34 +00002932 raw_ostream &Out) {
Yaxun (Sam) Liu29e1a162020-03-05 12:02:13 -05002933 const NamedDecl *D = cast<NamedDecl>(GD.getDecl());
Guy Benyei11169dd2012-12-18 14:30:41 +00002934 PrettyStackTraceDecl CrashInfo(D, SourceLocation(),
2935 getASTContext().getSourceManager(),
2936 "Mangling declaration");
2937
David Majnemerfebb2722016-03-07 08:51:17 +00002938 msvc_hashing_ostream MHO(Out);
Yaxun (Sam) Liu29e1a162020-03-05 12:02:13 -05002939
2940 if (auto *CD = dyn_cast<CXXConstructorDecl>(D)) {
2941 auto Type = GD.getCtorType();
2942 MicrosoftCXXNameMangler mangler(*this, MHO, CD, Type);
2943 return mangler.mangle(D);
2944 }
2945
2946 if (auto *DD = dyn_cast<CXXDestructorDecl>(D)) {
2947 auto Type = GD.getDtorType();
2948 MicrosoftCXXNameMangler mangler(*this, MHO, DD, Type);
2949 return mangler.mangle(D);
2950 }
2951
David Majnemerfebb2722016-03-07 08:51:17 +00002952 MicrosoftCXXNameMangler Mangler(*this, MHO);
Guy Benyei11169dd2012-12-18 14:30:41 +00002953 return Mangler.mangle(D);
2954}
Timur Iskhodzhanovdf7e7fb2013-07-30 09:46:19 +00002955
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002956// <this-adjustment> ::= <no-adjustment> | <static-adjustment> |
2957// <virtual-adjustment>
2958// <no-adjustment> ::= A # private near
2959// ::= B # private far
2960// ::= I # protected near
2961// ::= J # protected far
2962// ::= Q # public near
2963// ::= R # public far
2964// <static-adjustment> ::= G <static-offset> # private near
2965// ::= H <static-offset> # private far
2966// ::= O <static-offset> # protected near
2967// ::= P <static-offset> # protected far
2968// ::= W <static-offset> # public near
2969// ::= X <static-offset> # public far
2970// <virtual-adjustment> ::= $0 <virtual-shift> <static-offset> # private near
2971// ::= $1 <virtual-shift> <static-offset> # private far
2972// ::= $2 <virtual-shift> <static-offset> # protected near
2973// ::= $3 <virtual-shift> <static-offset> # protected far
2974// ::= $4 <virtual-shift> <static-offset> # public near
2975// ::= $5 <virtual-shift> <static-offset> # public far
2976// <virtual-shift> ::= <vtordisp-shift> | <vtordispex-shift>
2977// <vtordisp-shift> ::= <offset-to-vtordisp>
2978// <vtordispex-shift> ::= <offset-to-vbptr> <vbase-offset-offset>
2979// <offset-to-vtordisp>
Reid Kleckner3ab5a9c2018-12-26 20:07:52 +00002980static void mangleThunkThisAdjustment(AccessSpecifier AS,
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00002981 const ThisAdjustment &Adjustment,
2982 MicrosoftCXXNameMangler &Mangler,
2983 raw_ostream &Out) {
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002984 if (!Adjustment.Virtual.isEmpty()) {
2985 Out << '$';
2986 char AccessSpec;
Reid Kleckner3ab5a9c2018-12-26 20:07:52 +00002987 switch (AS) {
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002988 case AS_none:
2989 llvm_unreachable("Unsupported access specifier");
2990 case AS_private:
2991 AccessSpec = '0';
2992 break;
2993 case AS_protected:
2994 AccessSpec = '2';
2995 break;
2996 case AS_public:
2997 AccessSpec = '4';
2998 }
2999 if (Adjustment.Virtual.Microsoft.VBPtrOffset) {
3000 Out << 'R' << AccessSpec;
David Majnemer2a816452013-12-09 10:44:32 +00003001 Mangler.mangleNumber(
3002 static_cast<uint32_t>(Adjustment.Virtual.Microsoft.VBPtrOffset));
3003 Mangler.mangleNumber(
3004 static_cast<uint32_t>(Adjustment.Virtual.Microsoft.VBOffsetOffset));
3005 Mangler.mangleNumber(
3006 static_cast<uint32_t>(Adjustment.Virtual.Microsoft.VtordispOffset));
3007 Mangler.mangleNumber(static_cast<uint32_t>(Adjustment.NonVirtual));
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00003008 } else {
3009 Out << AccessSpec;
David Majnemer2a816452013-12-09 10:44:32 +00003010 Mangler.mangleNumber(
3011 static_cast<uint32_t>(Adjustment.Virtual.Microsoft.VtordispOffset));
3012 Mangler.mangleNumber(-static_cast<uint32_t>(Adjustment.NonVirtual));
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00003013 }
3014 } else if (Adjustment.NonVirtual != 0) {
Reid Kleckner3ab5a9c2018-12-26 20:07:52 +00003015 switch (AS) {
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00003016 case AS_none:
3017 llvm_unreachable("Unsupported access specifier");
3018 case AS_private:
3019 Out << 'G';
3020 break;
3021 case AS_protected:
3022 Out << 'O';
3023 break;
3024 case AS_public:
3025 Out << 'W';
3026 }
David Majnemer2a816452013-12-09 10:44:32 +00003027 Mangler.mangleNumber(-static_cast<uint32_t>(Adjustment.NonVirtual));
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00003028 } else {
Reid Kleckner3ab5a9c2018-12-26 20:07:52 +00003029 switch (AS) {
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00003030 case AS_none:
3031 llvm_unreachable("Unsupported access specifier");
3032 case AS_private:
3033 Out << 'A';
3034 break;
3035 case AS_protected:
3036 Out << 'I';
3037 break;
3038 case AS_public:
3039 Out << 'Q';
3040 }
3041 }
3042}
3043
Reid Klecknercbec0262018-04-02 20:00:39 +00003044void MicrosoftMangleContextImpl::mangleVirtualMemPtrThunk(
3045 const CXXMethodDecl *MD, const MethodVFTableLocation &ML,
3046 raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003047 msvc_hashing_ostream MHO(Out);
3048 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Klecknerfb931542018-03-16 20:36:49 +00003049 Mangler.getStream() << '?';
Reid Kleckner96f8f932014-02-05 17:27:08 +00003050 Mangler.mangleVirtualMemPtrThunk(MD, ML);
Hans Wennborg88497d62013-11-15 17:24:45 +00003051}
3052
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003053void MicrosoftMangleContextImpl::mangleThunk(const CXXMethodDecl *MD,
3054 const ThunkInfo &Thunk,
3055 raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003056 msvc_hashing_ostream MHO(Out);
3057 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Klecknerfb931542018-03-16 20:36:49 +00003058 Mangler.getStream() << '?';
Timur Iskhodzhanovdf7e7fb2013-07-30 09:46:19 +00003059 Mangler.mangleName(MD);
Reid Kleckner3ab5a9c2018-12-26 20:07:52 +00003060
3061 // Usually the thunk uses the access specifier of the new method, but if this
3062 // is a covariant return thunk, then MSVC always uses the public access
3063 // specifier, and we do the same.
3064 AccessSpecifier AS = Thunk.Return.isEmpty() ? MD->getAccess() : AS_public;
3065 mangleThunkThisAdjustment(AS, Thunk.This, Mangler, MHO);
3066
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00003067 if (!Thunk.Return.isEmpty())
Craig Topper36250ad2014-05-12 05:36:57 +00003068 assert(Thunk.Method != nullptr &&
3069 "Thunk info should hold the overridee decl");
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00003070
3071 const CXXMethodDecl *DeclForFPT = Thunk.Method ? Thunk.Method : MD;
3072 Mangler.mangleFunctionType(
3073 DeclForFPT->getType()->castAs<FunctionProtoType>(), MD);
Guy Benyei11169dd2012-12-18 14:30:41 +00003074}
Timur Iskhodzhanovdf7e7fb2013-07-30 09:46:19 +00003075
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00003076void MicrosoftMangleContextImpl::mangleCXXDtorThunk(
3077 const CXXDestructorDecl *DD, CXXDtorType Type,
3078 const ThisAdjustment &Adjustment, raw_ostream &Out) {
3079 // FIXME: Actually, the dtor thunk should be emitted for vector deleting
3080 // dtors rather than scalar deleting dtors. Just use the vector deleting dtor
3081 // mangling manually until we support both deleting dtor types.
3082 assert(Type == Dtor_Deleting);
David Majnemerfebb2722016-03-07 08:51:17 +00003083 msvc_hashing_ostream MHO(Out);
3084 MicrosoftCXXNameMangler Mangler(*this, MHO, DD, Type);
Reid Klecknerfb931542018-03-16 20:36:49 +00003085 Mangler.getStream() << "??_E";
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00003086 Mangler.mangleName(DD->getParent());
Reid Kleckner3ab5a9c2018-12-26 20:07:52 +00003087 mangleThunkThisAdjustment(DD->getAccess(), Adjustment, Mangler, MHO);
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00003088 Mangler.mangleFunctionType(DD->getType()->castAs<FunctionProtoType>(), DD);
Guy Benyei11169dd2012-12-18 14:30:41 +00003089}
Reid Kleckner7810af02013-06-19 15:20:38 +00003090
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003091void MicrosoftMangleContextImpl::mangleCXXVFTable(
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00003092 const CXXRecordDecl *Derived, ArrayRef<const CXXRecordDecl *> BasePath,
3093 raw_ostream &Out) {
Reid Kleckner7810af02013-06-19 15:20:38 +00003094 // <mangled-name> ::= ?_7 <class-name> <storage-class>
3095 // <cvr-qualifiers> [<name>] @
Guy Benyei11169dd2012-12-18 14:30:41 +00003096 // NOTE: <cvr-qualifiers> here is always 'B' (const). <storage-class>
Reid Kleckner7810af02013-06-19 15:20:38 +00003097 // is always '6' for vftables.
David Majnemerfebb2722016-03-07 08:51:17 +00003098 msvc_hashing_ostream MHO(Out);
3099 MicrosoftCXXNameMangler Mangler(*this, MHO);
David Majnemer2d8b2002016-02-11 17:49:28 +00003100 if (Derived->hasAttr<DLLImportAttr>())
Reid Klecknerfb931542018-03-16 20:36:49 +00003101 Mangler.getStream() << "??_S";
David Majnemer2d8b2002016-02-11 17:49:28 +00003102 else
Reid Klecknerfb931542018-03-16 20:36:49 +00003103 Mangler.getStream() << "??_7";
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00003104 Mangler.mangleName(Derived);
3105 Mangler.getStream() << "6B"; // '6' for vftable, 'B' for const.
David Majnemerb926dbc2014-04-23 05:16:53 +00003106 for (const CXXRecordDecl *RD : BasePath)
3107 Mangler.mangleName(RD);
Guy Benyei11169dd2012-12-18 14:30:41 +00003108 Mangler.getStream() << '@';
3109}
Reid Kleckner7810af02013-06-19 15:20:38 +00003110
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003111void MicrosoftMangleContextImpl::mangleCXXVBTable(
Reid Kleckner7810af02013-06-19 15:20:38 +00003112 const CXXRecordDecl *Derived, ArrayRef<const CXXRecordDecl *> BasePath,
3113 raw_ostream &Out) {
3114 // <mangled-name> ::= ?_8 <class-name> <storage-class>
3115 // <cvr-qualifiers> [<name>] @
3116 // NOTE: <cvr-qualifiers> here is always 'B' (const). <storage-class>
3117 // is always '7' for vbtables.
David Majnemerfebb2722016-03-07 08:51:17 +00003118 msvc_hashing_ostream MHO(Out);
3119 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Klecknerfb931542018-03-16 20:36:49 +00003120 Mangler.getStream() << "??_8";
Reid Kleckner7810af02013-06-19 15:20:38 +00003121 Mangler.mangleName(Derived);
3122 Mangler.getStream() << "7B"; // '7' for vbtable, 'B' for const.
David Majnemerb926dbc2014-04-23 05:16:53 +00003123 for (const CXXRecordDecl *RD : BasePath)
3124 Mangler.mangleName(RD);
Reid Kleckner7810af02013-06-19 15:20:38 +00003125 Mangler.getStream() << '@';
3126}
3127
David Majnemera96b7ee2014-05-13 00:44:44 +00003128void MicrosoftMangleContextImpl::mangleCXXRTTI(QualType T, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003129 msvc_hashing_ostream MHO(Out);
3130 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Klecknerfb931542018-03-16 20:36:49 +00003131 Mangler.getStream() << "??_R0";
David Majnemera96b7ee2014-05-13 00:44:44 +00003132 Mangler.mangleType(T, SourceRange(), MicrosoftCXXNameMangler::QMM_Result);
3133 Mangler.getStream() << "@8";
Guy Benyei11169dd2012-12-18 14:30:41 +00003134}
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003135
David Majnemera96b7ee2014-05-13 00:44:44 +00003136void MicrosoftMangleContextImpl::mangleCXXRTTIName(QualType T,
3137 raw_ostream &Out) {
3138 MicrosoftCXXNameMangler Mangler(*this, Out);
3139 Mangler.getStream() << '.';
3140 Mangler.mangleType(T, SourceRange(), MicrosoftCXXNameMangler::QMM_Result);
3141}
3142
David Majnemerc1709d32015-06-23 07:31:11 +00003143void MicrosoftMangleContextImpl::mangleCXXVirtualDisplacementMap(
3144 const CXXRecordDecl *SrcRD, const CXXRecordDecl *DstRD, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003145 msvc_hashing_ostream MHO(Out);
3146 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Klecknerfb931542018-03-16 20:36:49 +00003147 Mangler.getStream() << "??_K";
David Majnemerc1709d32015-06-23 07:31:11 +00003148 Mangler.mangleName(SrcRD);
3149 Mangler.getStream() << "$C";
3150 Mangler.mangleName(DstRD);
3151}
3152
David Majnemer526793d2016-07-12 04:42:50 +00003153void MicrosoftMangleContextImpl::mangleCXXThrowInfo(QualType T, bool IsConst,
David Majnemer7c237072015-03-05 00:46:22 +00003154 bool IsVolatile,
David Majnemer526793d2016-07-12 04:42:50 +00003155 bool IsUnaligned,
David Majnemer7c237072015-03-05 00:46:22 +00003156 uint32_t NumEntries,
3157 raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003158 msvc_hashing_ostream MHO(Out);
3159 MicrosoftCXXNameMangler Mangler(*this, MHO);
David Majnemer7c237072015-03-05 00:46:22 +00003160 Mangler.getStream() << "_TI";
3161 if (IsConst)
3162 Mangler.getStream() << 'C';
3163 if (IsVolatile)
3164 Mangler.getStream() << 'V';
David Majnemer526793d2016-07-12 04:42:50 +00003165 if (IsUnaligned)
3166 Mangler.getStream() << 'U';
David Majnemer7c237072015-03-05 00:46:22 +00003167 Mangler.getStream() << NumEntries;
3168 Mangler.mangleType(T, SourceRange(), MicrosoftCXXNameMangler::QMM_Result);
3169}
3170
3171void MicrosoftMangleContextImpl::mangleCXXCatchableTypeArray(
3172 QualType T, uint32_t NumEntries, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003173 msvc_hashing_ostream MHO(Out);
3174 MicrosoftCXXNameMangler Mangler(*this, MHO);
David Majnemer7c237072015-03-05 00:46:22 +00003175 Mangler.getStream() << "_CTA";
3176 Mangler.getStream() << NumEntries;
3177 Mangler.mangleType(T, SourceRange(), MicrosoftCXXNameMangler::QMM_Result);
3178}
3179
David Majnemere7a818f2015-03-06 18:53:55 +00003180void MicrosoftMangleContextImpl::mangleCXXCatchableType(
David Majnemerdfa6d202015-03-11 18:36:39 +00003181 QualType T, const CXXConstructorDecl *CD, CXXCtorType CT, uint32_t Size,
3182 uint32_t NVOffset, int32_t VBPtrOffset, uint32_t VBIndex,
3183 raw_ostream &Out) {
David Majnemer7c237072015-03-05 00:46:22 +00003184 MicrosoftCXXNameMangler Mangler(*this, Out);
David Majnemere7a818f2015-03-06 18:53:55 +00003185 Mangler.getStream() << "_CT";
3186
3187 llvm::SmallString<64> RTTIMangling;
3188 {
3189 llvm::raw_svector_ostream Stream(RTTIMangling);
David Majnemerfebb2722016-03-07 08:51:17 +00003190 msvc_hashing_ostream MHO(Stream);
3191 mangleCXXRTTI(T, MHO);
David Majnemere7a818f2015-03-06 18:53:55 +00003192 }
Reid Klecknerfb931542018-03-16 20:36:49 +00003193 Mangler.getStream() << RTTIMangling;
David Majnemere7a818f2015-03-06 18:53:55 +00003194
Nico Webere3b1f5d2019-05-29 13:48:19 +00003195 // VS2015 and VS2017.1 omit the copy-constructor in the mangled name but
3196 // both older and newer versions include it.
3197 // FIXME: It is known that the Ctor is present in 2013, and in 2017.7
3198 // (_MSC_VER 1914) and newer, and that it's omitted in 2015 and 2017.4
3199 // (_MSC_VER 1911), but it's unknown when exactly it reappeared (1914?
3200 // Or 1912, 1913 aleady?).
3201 bool OmitCopyCtor = getASTContext().getLangOpts().isCompatibleWithMSVC(
3202 LangOptions::MSVC2015) &&
3203 !getASTContext().getLangOpts().isCompatibleWithMSVC(
3204 LangOptions::MSVC2017_7);
David Majnemere7a818f2015-03-06 18:53:55 +00003205 llvm::SmallString<64> CopyCtorMangling;
Nico Webere3b1f5d2019-05-29 13:48:19 +00003206 if (!OmitCopyCtor && CD) {
David Majnemere7a818f2015-03-06 18:53:55 +00003207 llvm::raw_svector_ostream Stream(CopyCtorMangling);
David Majnemerfebb2722016-03-07 08:51:17 +00003208 msvc_hashing_ostream MHO(Stream);
Yaxun (Sam) Liu29e1a162020-03-05 12:02:13 -05003209 mangleCXXName(GlobalDecl(CD, CT), MHO);
David Majnemere7a818f2015-03-06 18:53:55 +00003210 }
Reid Klecknerfb931542018-03-16 20:36:49 +00003211 Mangler.getStream() << CopyCtorMangling;
David Majnemere7a818f2015-03-06 18:53:55 +00003212
David Majnemer7c237072015-03-05 00:46:22 +00003213 Mangler.getStream() << Size;
David Majnemer999cbf92015-03-10 19:01:51 +00003214 if (VBPtrOffset == -1) {
3215 if (NVOffset) {
3216 Mangler.getStream() << NVOffset;
3217 }
3218 } else {
3219 Mangler.getStream() << NVOffset;
3220 Mangler.getStream() << VBPtrOffset;
3221 Mangler.getStream() << VBIndex;
3222 }
David Majnemer7c237072015-03-05 00:46:22 +00003223}
3224
David Majnemera96b7ee2014-05-13 00:44:44 +00003225void MicrosoftMangleContextImpl::mangleCXXRTTIBaseClassDescriptor(
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00003226 const CXXRecordDecl *Derived, uint32_t NVOffset, int32_t VBPtrOffset,
David Majnemeraeb55c92014-05-13 06:57:43 +00003227 uint32_t VBTableOffset, uint32_t Flags, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003228 msvc_hashing_ostream MHO(Out);
3229 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Klecknerfb931542018-03-16 20:36:49 +00003230 Mangler.getStream() << "??_R1";
David Majnemera96b7ee2014-05-13 00:44:44 +00003231 Mangler.mangleNumber(NVOffset);
3232 Mangler.mangleNumber(VBPtrOffset);
3233 Mangler.mangleNumber(VBTableOffset);
3234 Mangler.mangleNumber(Flags);
David Majnemeraeb55c92014-05-13 06:57:43 +00003235 Mangler.mangleName(Derived);
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00003236 Mangler.getStream() << "8";
David Majnemera96b7ee2014-05-13 00:44:44 +00003237}
3238
3239void MicrosoftMangleContextImpl::mangleCXXRTTIBaseClassArray(
3240 const CXXRecordDecl *Derived, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003241 msvc_hashing_ostream MHO(Out);
3242 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Klecknerfb931542018-03-16 20:36:49 +00003243 Mangler.getStream() << "??_R2";
David Majnemera96b7ee2014-05-13 00:44:44 +00003244 Mangler.mangleName(Derived);
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00003245 Mangler.getStream() << "8";
David Majnemera96b7ee2014-05-13 00:44:44 +00003246}
3247
3248void MicrosoftMangleContextImpl::mangleCXXRTTIClassHierarchyDescriptor(
3249 const CXXRecordDecl *Derived, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003250 msvc_hashing_ostream MHO(Out);
3251 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Klecknerfb931542018-03-16 20:36:49 +00003252 Mangler.getStream() << "??_R3";
David Majnemera96b7ee2014-05-13 00:44:44 +00003253 Mangler.mangleName(Derived);
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00003254 Mangler.getStream() << "8";
David Majnemera96b7ee2014-05-13 00:44:44 +00003255}
3256
3257void MicrosoftMangleContextImpl::mangleCXXRTTICompleteObjectLocator(
David Majnemeraeb55c92014-05-13 06:57:43 +00003258 const CXXRecordDecl *Derived, ArrayRef<const CXXRecordDecl *> BasePath,
3259 raw_ostream &Out) {
3260 // <mangled-name> ::= ?_R4 <class-name> <storage-class>
3261 // <cvr-qualifiers> [<name>] @
3262 // NOTE: <cvr-qualifiers> here is always 'B' (const). <storage-class>
3263 // is always '6' for vftables.
David Majnemerfebb2722016-03-07 08:51:17 +00003264 llvm::SmallString<64> VFTableMangling;
3265 llvm::raw_svector_ostream Stream(VFTableMangling);
3266 mangleCXXVFTable(Derived, BasePath, Stream);
3267
Reid Klecknerfb931542018-03-16 20:36:49 +00003268 if (VFTableMangling.startswith("??@")) {
David Majnemerfebb2722016-03-07 08:51:17 +00003269 assert(VFTableMangling.endswith("@"));
3270 Out << VFTableMangling << "??_R4@";
3271 return;
3272 }
3273
Reid Klecknerfb931542018-03-16 20:36:49 +00003274 assert(VFTableMangling.startswith("??_7") ||
3275 VFTableMangling.startswith("??_S"));
David Majnemerfebb2722016-03-07 08:51:17 +00003276
Reid Klecknerfb931542018-03-16 20:36:49 +00003277 Out << "??_R4" << StringRef(VFTableMangling).drop_front(4);
Guy Benyei11169dd2012-12-18 14:30:41 +00003278}
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003279
Reid Kleckner1d59f992015-01-22 01:36:17 +00003280void MicrosoftMangleContextImpl::mangleSEHFilterExpression(
3281 const NamedDecl *EnclosingDecl, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003282 msvc_hashing_ostream MHO(Out);
3283 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Kleckner1d59f992015-01-22 01:36:17 +00003284 // The function body is in the same comdat as the function with the handler,
3285 // so the numbering here doesn't have to be the same across TUs.
3286 //
3287 // <mangled-name> ::= ?filt$ <filter-number> @0
Reid Klecknerfb931542018-03-16 20:36:49 +00003288 Mangler.getStream() << "?filt$" << SEHFilterIds[EnclosingDecl]++ << "@0@";
Reid Kleckner1d59f992015-01-22 01:36:17 +00003289 Mangler.mangleName(EnclosingDecl);
3290}
3291
Reid Klecknerebaf28d2015-04-14 20:59:00 +00003292void MicrosoftMangleContextImpl::mangleSEHFinallyBlock(
3293 const NamedDecl *EnclosingDecl, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003294 msvc_hashing_ostream MHO(Out);
3295 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00003296 // The function body is in the same comdat as the function with the handler,
3297 // so the numbering here doesn't have to be the same across TUs.
3298 //
3299 // <mangled-name> ::= ?fin$ <filter-number> @0
Reid Klecknerfb931542018-03-16 20:36:49 +00003300 Mangler.getStream() << "?fin$" << SEHFinallyIds[EnclosingDecl]++ << "@0@";
Reid Klecknerebaf28d2015-04-14 20:59:00 +00003301 Mangler.mangleName(EnclosingDecl);
3302}
3303
Reid Klecknercc99e262013-11-19 23:23:00 +00003304void MicrosoftMangleContextImpl::mangleTypeName(QualType T, raw_ostream &Out) {
3305 // This is just a made up unique string for the purposes of tbaa. undname
3306 // does *not* know how to demangle it.
3307 MicrosoftCXXNameMangler Mangler(*this, Out);
3308 Mangler.getStream() << '?';
3309 Mangler.mangleType(T, SourceRange());
3310}
3311
David Majnemere77de752015-12-29 22:25:14 +00003312void MicrosoftMangleContextImpl::mangleReferenceTemporary(
3313 const VarDecl *VD, unsigned ManglingNumber, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003314 msvc_hashing_ostream MHO(Out);
3315 MicrosoftCXXNameMangler Mangler(*this, MHO);
David Majnemere77de752015-12-29 22:25:14 +00003316
Reid Klecknerfb931542018-03-16 20:36:49 +00003317 Mangler.getStream() << "?$RT" << ManglingNumber << '@';
David Majnemere77de752015-12-29 22:25:14 +00003318 Mangler.mangle(VD, "");
Guy Benyei11169dd2012-12-18 14:30:41 +00003319}
3320
David Majnemer8354eee2015-05-07 06:15:46 +00003321void MicrosoftMangleContextImpl::mangleThreadSafeStaticGuardVariable(
3322 const VarDecl *VD, unsigned GuardNum, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003323 msvc_hashing_ostream MHO(Out);
3324 MicrosoftCXXNameMangler Mangler(*this, MHO);
David Majnemer8354eee2015-05-07 06:15:46 +00003325
Reid Klecknerfb931542018-03-16 20:36:49 +00003326 Mangler.getStream() << "?$TSS" << GuardNum << '@';
David Majnemer8354eee2015-05-07 06:15:46 +00003327 Mangler.mangleNestedName(VD);
Dmitry Polukhin5fa681e2016-05-27 08:52:34 +00003328 Mangler.getStream() << "@4HA";
David Majnemer8354eee2015-05-07 06:15:46 +00003329}
3330
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003331void MicrosoftMangleContextImpl::mangleStaticGuardVariable(const VarDecl *VD,
3332 raw_ostream &Out) {
David Majnemer2206bf52014-03-05 08:57:59 +00003333 // <guard-name> ::= ?_B <postfix> @5 <scope-depth>
David Majnemerec8e54b2015-05-07 21:19:06 +00003334 // ::= ?__J <postfix> @5 <scope-depth>
Reid Klecknerd8110b62013-09-10 20:14:30 +00003335 // ::= ?$S <guard-num> @ <postfix> @4IA
3336
3337 // The first mangling is what MSVC uses to guard static locals in inline
3338 // functions. It uses a different mangling in external functions to support
3339 // guarding more than 32 variables. MSVC rejects inline functions with more
3340 // than 32 static locals. We don't fully implement the second mangling
3341 // because those guards are not externally visible, and instead use LLVM's
3342 // default renaming when creating a new guard variable.
David Majnemerfebb2722016-03-07 08:51:17 +00003343 msvc_hashing_ostream MHO(Out);
3344 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Klecknerd8110b62013-09-10 20:14:30 +00003345
3346 bool Visible = VD->isExternallyVisible();
David Majnemer8354eee2015-05-07 06:15:46 +00003347 if (Visible) {
Reid Klecknerfb931542018-03-16 20:36:49 +00003348 Mangler.getStream() << (VD->getTLSKind() ? "??__J" : "??_B");
David Majnemer8354eee2015-05-07 06:15:46 +00003349 } else {
Reid Klecknerfb931542018-03-16 20:36:49 +00003350 Mangler.getStream() << "?$S1@";
David Majnemer8354eee2015-05-07 06:15:46 +00003351 }
David Majnemer34b49892014-03-06 19:57:36 +00003352 unsigned ScopeDepth = 0;
3353 if (Visible && !getNextDiscriminator(VD, ScopeDepth))
3354 // If we do not have a discriminator and are emitting a guard variable for
3355 // use at global scope, then mangling the nested name will not be enough to
3356 // remove ambiguities.
3357 Mangler.mangle(VD, "");
3358 else
3359 Mangler.mangleNestedName(VD);
David Majnemer2206bf52014-03-05 08:57:59 +00003360 Mangler.getStream() << (Visible ? "@5" : "@4IA");
David Majnemer34b49892014-03-06 19:57:36 +00003361 if (ScopeDepth)
David Majnemer2206bf52014-03-05 08:57:59 +00003362 Mangler.mangleNumber(ScopeDepth);
Reid Klecknerd8110b62013-09-10 20:14:30 +00003363}
3364
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003365void MicrosoftMangleContextImpl::mangleInitFiniStub(const VarDecl *D,
David Majnemerfebb2722016-03-07 08:51:17 +00003366 char CharCode,
3367 raw_ostream &Out) {
3368 msvc_hashing_ostream MHO(Out);
3369 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Klecknerfb931542018-03-16 20:36:49 +00003370 Mangler.getStream() << "??__" << CharCode;
David Majnemerf55feec2014-03-06 19:10:27 +00003371 if (D->isStaticDataMember()) {
Zachary Turnerf4f767d2018-08-30 20:53:11 +00003372 Mangler.getStream() << '?';
3373 Mangler.mangleName(D);
David Majnemerf55feec2014-03-06 19:10:27 +00003374 Mangler.mangleVariableEncoding(D);
Zachary Turnerf4f767d2018-08-30 20:53:11 +00003375 Mangler.getStream() << "@@";
3376 } else {
3377 Mangler.mangleName(D);
David Majnemerf55feec2014-03-06 19:10:27 +00003378 }
Reid Kleckner1ece9fc2013-09-10 20:43:12 +00003379 // This is the function class mangling. These stubs are global, non-variadic,
3380 // cdecl functions that return void and take no args.
3381 Mangler.getStream() << "YAXXZ";
3382}
3383
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003384void MicrosoftMangleContextImpl::mangleDynamicInitializer(const VarDecl *D,
3385 raw_ostream &Out) {
Reid Kleckner1ece9fc2013-09-10 20:43:12 +00003386 // <initializer-name> ::= ?__E <name> YAXXZ
David Majnemerfebb2722016-03-07 08:51:17 +00003387 mangleInitFiniStub(D, 'E', Out);
Reid Kleckner1ece9fc2013-09-10 20:43:12 +00003388}
3389
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003390void
3391MicrosoftMangleContextImpl::mangleDynamicAtExitDestructor(const VarDecl *D,
3392 raw_ostream &Out) {
Reid Kleckner1ece9fc2013-09-10 20:43:12 +00003393 // <destructor-name> ::= ?__F <name> YAXXZ
David Majnemerfebb2722016-03-07 08:51:17 +00003394 mangleInitFiniStub(D, 'F', Out);
Reid Klecknerd8110b62013-09-10 20:14:30 +00003395}
3396
David Majnemer58e5bee2014-03-24 21:43:36 +00003397void MicrosoftMangleContextImpl::mangleStringLiteral(const StringLiteral *SL,
3398 raw_ostream &Out) {
Nico Webera2d9c2b2018-07-02 12:31:20 +00003399 // <char-type> ::= 0 # char, char16_t, char32_t
3400 // # (little endian char data in mangling)
3401 // ::= 1 # wchar_t (big endian char data in mangling)
David Majnemer58e5bee2014-03-24 21:43:36 +00003402 //
3403 // <literal-length> ::= <non-negative integer> # the length of the literal
3404 //
3405 // <encoded-crc> ::= <hex digit>+ @ # crc of the literal including
Hans Wennborg7525edc2018-07-06 06:54:16 +00003406 // # trailing null bytes
David Majnemer58e5bee2014-03-24 21:43:36 +00003407 //
3408 // <encoded-string> ::= <simple character> # uninteresting character
3409 // ::= '?$' <hex digit> <hex digit> # these two nibbles
3410 // # encode the byte for the
3411 // # character
3412 // ::= '?' [a-z] # \xe1 - \xfa
3413 // ::= '?' [A-Z] # \xc1 - \xda
3414 // ::= '?' [0-9] # [,/\:. \n\t'-]
3415 //
3416 // <literal> ::= '??_C@_' <char-type> <literal-length> <encoded-crc>
3417 // <encoded-string> '@'
3418 MicrosoftCXXNameMangler Mangler(*this, Out);
Reid Klecknerfb931542018-03-16 20:36:49 +00003419 Mangler.getStream() << "??_C@_";
David Majnemer58e5bee2014-03-24 21:43:36 +00003420
Hans Wennborg7525edc2018-07-06 06:54:16 +00003421 // The actual string length might be different from that of the string literal
3422 // in cases like:
3423 // char foo[3] = "foobar";
3424 // char bar[42] = "foobar";
3425 // Where it is truncated or zero-padded to fit the array. This is the length
3426 // used for mangling, and any trailing null-bytes also need to be mangled.
3427 unsigned StringLength = getASTContext()
3428 .getAsConstantArrayType(SL->getType())
3429 ->getSize()
3430 .getZExtValue();
3431 unsigned StringByteLength = StringLength * SL->getCharByteWidth();
3432
David Majnemer58e5bee2014-03-24 21:43:36 +00003433 // <char-type>: The "kind" of string literal is encoded into the mangled name.
David Majnemer98e77a22014-11-21 19:57:25 +00003434 if (SL->isWide())
David Majnemer58e5bee2014-03-24 21:43:36 +00003435 Mangler.getStream() << '1';
3436 else
David Majnemer98e77a22014-11-21 19:57:25 +00003437 Mangler.getStream() << '0';
David Majnemer58e5bee2014-03-24 21:43:36 +00003438
3439 // <literal-length>: The next part of the mangled name consists of the length
Hans Wennborg7525edc2018-07-06 06:54:16 +00003440 // of the string in bytes.
3441 Mangler.mangleNumber(StringByteLength);
David Majnemer58e5bee2014-03-24 21:43:36 +00003442
Malcolm Parsonsc6e45832017-01-13 18:55:32 +00003443 auto GetLittleEndianByte = [&SL](unsigned Index) {
David Majnemer4b293eb2014-03-31 17:18:53 +00003444 unsigned CharByteWidth = SL->getCharByteWidth();
Hans Wennborg7525edc2018-07-06 06:54:16 +00003445 if (Index / CharByteWidth >= SL->getLength())
3446 return static_cast<char>(0);
David Majnemer4b293eb2014-03-31 17:18:53 +00003447 uint32_t CodeUnit = SL->getCodeUnit(Index / CharByteWidth);
David Majnemere49c4b62014-03-31 21:46:05 +00003448 unsigned OffsetInCodeUnit = Index % CharByteWidth;
3449 return static_cast<char>((CodeUnit >> (8 * OffsetInCodeUnit)) & 0xff);
David Majnemer4b293eb2014-03-31 17:18:53 +00003450 };
3451
Malcolm Parsonsc6e45832017-01-13 18:55:32 +00003452 auto GetBigEndianByte = [&SL](unsigned Index) {
David Majnemer4b293eb2014-03-31 17:18:53 +00003453 unsigned CharByteWidth = SL->getCharByteWidth();
Hans Wennborg7525edc2018-07-06 06:54:16 +00003454 if (Index / CharByteWidth >= SL->getLength())
3455 return static_cast<char>(0);
David Majnemer4b293eb2014-03-31 17:18:53 +00003456 uint32_t CodeUnit = SL->getCodeUnit(Index / CharByteWidth);
David Majnemere49c4b62014-03-31 21:46:05 +00003457 unsigned OffsetInCodeUnit = (CharByteWidth - 1) - (Index % CharByteWidth);
3458 return static_cast<char>((CodeUnit >> (8 * OffsetInCodeUnit)) & 0xff);
David Majnemer4b293eb2014-03-31 17:18:53 +00003459 };
3460
David Majnemer58e5bee2014-03-24 21:43:36 +00003461 // CRC all the bytes of the StringLiteral.
David Majnemerb8ed3642015-09-01 21:24:07 +00003462 llvm::JamCRC JC;
Hans Wennborg7525edc2018-07-06 06:54:16 +00003463 for (unsigned I = 0, E = StringByteLength; I != E; ++I)
David Majnemerb8ed3642015-09-01 21:24:07 +00003464 JC.update(GetLittleEndianByte(I));
David Majnemer58e5bee2014-03-24 21:43:36 +00003465
David Majnemer58e5bee2014-03-24 21:43:36 +00003466 // <encoded-crc>: The CRC is encoded utilizing the standard number mangling
3467 // scheme.
David Majnemerb8ed3642015-09-01 21:24:07 +00003468 Mangler.mangleNumber(JC.getCRC());
David Majnemer58e5bee2014-03-24 21:43:36 +00003469
Nico Webera2d9c2b2018-07-02 12:31:20 +00003470 // <encoded-string>: The mangled name also contains the first 32 bytes
3471 // (including null-terminator bytes) of the encoded StringLiteral.
David Majnemer58e5bee2014-03-24 21:43:36 +00003472 // Each character is encoded by splitting them into bytes and then encoding
3473 // the constituent bytes.
3474 auto MangleByte = [&Mangler](char Byte) {
3475 // There are five different manglings for characters:
3476 // - [a-zA-Z0-9_$]: A one-to-one mapping.
3477 // - ?[a-z]: The range from \xe1 to \xfa.
3478 // - ?[A-Z]: The range from \xc1 to \xda.
3479 // - ?[0-9]: The set of [,/\:. \n\t'-].
3480 // - ?$XX: A fallback which maps nibbles.
David Majnemer10befcf2014-04-01 00:05:57 +00003481 if (isIdentifierBody(Byte, /*AllowDollar=*/true)) {
David Majnemer58e5bee2014-03-24 21:43:36 +00003482 Mangler.getStream() << Byte;
David Majnemer10befcf2014-04-01 00:05:57 +00003483 } else if (isLetter(Byte & 0x7f)) {
3484 Mangler.getStream() << '?' << static_cast<char>(Byte & 0x7f);
David Majnemer58e5bee2014-03-24 21:43:36 +00003485 } else {
David Majnemer07bc6112014-12-22 06:24:49 +00003486 const char SpecialChars[] = {',', '/', '\\', ':', '.',
3487 ' ', '\n', '\t', '\'', '-'};
Fangrui Song75e74e02019-03-31 08:48:19 +00003488 const char *Pos = llvm::find(SpecialChars, Byte);
David Majnemer07bc6112014-12-22 06:24:49 +00003489 if (Pos != std::end(SpecialChars)) {
3490 Mangler.getStream() << '?' << (Pos - std::begin(SpecialChars));
3491 } else {
3492 Mangler.getStream() << "?$";
3493 Mangler.getStream() << static_cast<char>('A' + ((Byte >> 4) & 0xf));
3494 Mangler.getStream() << static_cast<char>('A' + (Byte & 0xf));
David Majnemer58e5bee2014-03-24 21:43:36 +00003495 }
3496 }
3497 };
3498
Nico Webera2d9c2b2018-07-02 12:31:20 +00003499 // Enforce our 32 bytes max, except wchar_t which gets 32 chars instead.
3500 unsigned MaxBytesToMangle = SL->isWide() ? 64U : 32U;
Hans Wennborg7525edc2018-07-06 06:54:16 +00003501 unsigned NumBytesToMangle = std::min(MaxBytesToMangle, StringByteLength);
3502 for (unsigned I = 0; I != NumBytesToMangle; ++I) {
David Majnemer98e77a22014-11-21 19:57:25 +00003503 if (SL->isWide())
3504 MangleByte(GetBigEndianByte(I));
3505 else
3506 MangleByte(GetLittleEndianByte(I));
Hans Wennborg7525edc2018-07-06 06:54:16 +00003507 }
David Majnemer58e5bee2014-03-24 21:43:36 +00003508
3509 Mangler.getStream() << '@';
3510}
3511
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003512MicrosoftMangleContext *
3513MicrosoftMangleContext::create(ASTContext &Context, DiagnosticsEngine &Diags) {
3514 return new MicrosoftMangleContextImpl(Context, Diags);
Guy Benyei11169dd2012-12-18 14:30:41 +00003515}