blob: a286c53355840cbf8403cf90964014fe20ae8979 [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
13#include "clang/AST/Mangle.h"
14#include "clang/AST/ASTContext.h"
15#include "clang/AST/Attr.h"
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +000016#include "clang/AST/CXXInheritance.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000017#include "clang/AST/CharUnits.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000018#include "clang/AST/Decl.h"
19#include "clang/AST/DeclCXX.h"
20#include "clang/AST/DeclObjC.h"
Alexey Bataev94a4f0c2016-03-03 05:21:39 +000021#include "clang/AST/DeclOpenMP.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000022#include "clang/AST/DeclTemplate.h"
David Majnemer58e5bee2014-03-24 21:43:36 +000023#include "clang/AST/Expr.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000024#include "clang/AST/ExprCXX.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 Kleckner369f3162013-05-14 20:30:42 +000028#include "clang/Basic/TargetInfo.h"
David Majnemer2206bf52014-03-05 08:57:59 +000029#include "llvm/ADT/StringExtras.h"
Hans Wennborg1e1e3ba2019-10-09 09:06:30 +000030#include "llvm/Support/CRC.h"
David Majnemerfebb2722016-03-07 08:51:17 +000031#include "llvm/Support/MD5.h"
32#include "llvm/Support/MathExtras.h"
Nico Weber48707762019-06-04 23:27:40 +000033#include "llvm/Support/StringSaver.h"
Hans Wennborg1e1e3ba2019-10-09 09:06:30 +000034#include "llvm/Support/xxhash.h"
David Majnemer3843a052014-03-23 17:47:16 +000035
Guy Benyei11169dd2012-12-18 14:30:41 +000036using namespace clang;
37
38namespace {
39
David Majnemerfebb2722016-03-07 08:51:17 +000040struct msvc_hashing_ostream : public llvm::raw_svector_ostream {
41 raw_ostream &OS;
42 llvm::SmallString<64> Buffer;
43
44 msvc_hashing_ostream(raw_ostream &OS)
45 : llvm::raw_svector_ostream(Buffer), OS(OS) {}
46 ~msvc_hashing_ostream() override {
47 StringRef MangledName = str();
48 bool StartsWithEscape = MangledName.startswith("\01");
49 if (StartsWithEscape)
50 MangledName = MangledName.drop_front(1);
51 if (MangledName.size() <= 4096) {
52 OS << str();
53 return;
54 }
55
56 llvm::MD5 Hasher;
57 llvm::MD5::MD5Result Hash;
58 Hasher.update(MangledName);
59 Hasher.final(Hash);
60
61 SmallString<32> HexString;
62 llvm::MD5::stringifyResult(Hash, HexString);
63
64 if (StartsWithEscape)
65 OS << '\01';
66 OS << "??@" << HexString << '@';
67 }
68};
69
David Majnemer984498f2016-12-06 17:01:02 +000070static const DeclContext *
71getLambdaDefaultArgumentDeclContext(const Decl *D) {
72 if (const auto *RD = dyn_cast<CXXRecordDecl>(D))
73 if (RD->isLambda())
74 if (const auto *Parm =
75 dyn_cast_or_null<ParmVarDecl>(RD->getLambdaContextDecl()))
76 return Parm->getDeclContext();
77 return nullptr;
78}
79
Adrian Prantl9fc8faf2018-05-09 01:00:01 +000080/// Retrieve the declaration context that should be used when mangling
David Majnemerd5a42b82013-09-13 09:03:14 +000081/// the given declaration.
82static const DeclContext *getEffectiveDeclContext(const Decl *D) {
83 // The ABI assumes that lambda closure types that occur within
84 // default arguments live in the context of the function. However, due to
85 // the way in which Clang parses and creates function declarations, this is
86 // not the case: the lambda closure type ends up living in the context
87 // where the function itself resides, because the function declaration itself
88 // had not yet been created. Fix the context here.
David Majnemer984498f2016-12-06 17:01:02 +000089 if (const auto *LDADC = getLambdaDefaultArgumentDeclContext(D))
90 return LDADC;
David Majnemerd5a42b82013-09-13 09:03:14 +000091
92 // Perform the same check for block literals.
93 if (const BlockDecl *BD = dyn_cast<BlockDecl>(D)) {
94 if (ParmVarDecl *ContextParam =
95 dyn_cast_or_null<ParmVarDecl>(BD->getBlockManglingContextDecl()))
96 return ContextParam->getDeclContext();
97 }
98
99 const DeclContext *DC = D->getDeclContext();
Michael Kruse251e1482019-02-01 20:25:04 +0000100 if (isa<CapturedDecl>(DC) || isa<OMPDeclareReductionDecl>(DC) ||
101 isa<OMPDeclareMapperDecl>(DC)) {
Alexey Bataev94a4f0c2016-03-03 05:21:39 +0000102 return getEffectiveDeclContext(cast<Decl>(DC));
103 }
David Majnemerd5a42b82013-09-13 09:03:14 +0000104
David Majnemerb0f1dbd2016-05-19 18:15:53 +0000105 return DC->getRedeclContext();
David Majnemerd5a42b82013-09-13 09:03:14 +0000106}
107
108static const DeclContext *getEffectiveParentContext(const DeclContext *DC) {
109 return getEffectiveDeclContext(cast<Decl>(DC));
110}
111
David Majnemerdfa6d202015-03-11 18:36:39 +0000112static const FunctionDecl *getStructor(const NamedDecl *ND) {
113 if (const auto *FTD = dyn_cast<FunctionTemplateDecl>(ND))
Reid Kleckner290feb92017-01-09 17:04:37 +0000114 return FTD->getTemplatedDecl()->getCanonicalDecl();
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +0000115
David Majnemerdfa6d202015-03-11 18:36:39 +0000116 const auto *FD = cast<FunctionDecl>(ND);
117 if (const auto *FTD = FD->getPrimaryTemplate())
Reid Kleckner290feb92017-01-09 17:04:37 +0000118 return FTD->getTemplatedDecl()->getCanonicalDecl();
David Majnemerdfa6d202015-03-11 18:36:39 +0000119
Reid Kleckner290feb92017-01-09 17:04:37 +0000120 return FD->getCanonicalDecl();
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +0000121}
122
Timur Iskhodzhanov67455222013-10-03 06:26:13 +0000123/// MicrosoftMangleContextImpl - Overrides the default MangleContext for the
Guy Benyei11169dd2012-12-18 14:30:41 +0000124/// Microsoft Visual C++ ABI.
Timur Iskhodzhanov67455222013-10-03 06:26:13 +0000125class MicrosoftMangleContextImpl : public MicrosoftMangleContext {
David Majnemer2206bf52014-03-05 08:57:59 +0000126 typedef std::pair<const DeclContext *, IdentifierInfo *> DiscriminatorKeyTy;
127 llvm::DenseMap<DiscriminatorKeyTy, unsigned> Discriminator;
David Majnemer02e9af42014-04-23 05:16:51 +0000128 llvm::DenseMap<const NamedDecl *, unsigned> Uniquifier;
David Majnemerf017ec32014-03-05 10:35:06 +0000129 llvm::DenseMap<const CXXRecordDecl *, unsigned> LambdaIds;
Reid Kleckner1d59f992015-01-22 01:36:17 +0000130 llvm::DenseMap<const NamedDecl *, unsigned> SEHFilterIds;
Reid Klecknerebaf28d2015-04-14 20:59:00 +0000131 llvm::DenseMap<const NamedDecl *, unsigned> SEHFinallyIds;
Reid Klecknerdf8dd612018-08-17 20:59:27 +0000132 SmallString<16> AnonymousNamespaceHash;
David Majnemer2206bf52014-03-05 08:57:59 +0000133
Guy Benyei11169dd2012-12-18 14:30:41 +0000134public:
Reid Klecknerdf8dd612018-08-17 20:59:27 +0000135 MicrosoftMangleContextImpl(ASTContext &Context, DiagnosticsEngine &Diags);
Craig Toppercbce6e92014-03-11 06:22:39 +0000136 bool shouldMangleCXXName(const NamedDecl *D) override;
David Majnemer58e5bee2014-03-24 21:43:36 +0000137 bool shouldMangleStringLiteral(const StringLiteral *SL) override;
Craig Toppercbce6e92014-03-11 06:22:39 +0000138 void mangleCXXName(const NamedDecl *D, raw_ostream &Out) override;
David Majnemer02e9af42014-04-23 05:16:51 +0000139 void mangleVirtualMemPtrThunk(const CXXMethodDecl *MD,
Reid Klecknercbec0262018-04-02 20:00:39 +0000140 const MethodVFTableLocation &ML,
141 raw_ostream &Out) override;
Craig Toppercbce6e92014-03-11 06:22:39 +0000142 void mangleThunk(const CXXMethodDecl *MD, const ThunkInfo &Thunk,
143 raw_ostream &) override;
144 void mangleCXXDtorThunk(const CXXDestructorDecl *DD, CXXDtorType Type,
145 const ThisAdjustment &ThisAdjustment,
146 raw_ostream &) override;
147 void mangleCXXVFTable(const CXXRecordDecl *Derived,
148 ArrayRef<const CXXRecordDecl *> BasePath,
149 raw_ostream &Out) override;
150 void mangleCXXVBTable(const CXXRecordDecl *Derived,
151 ArrayRef<const CXXRecordDecl *> BasePath,
152 raw_ostream &Out) override;
David Majnemerc1709d32015-06-23 07:31:11 +0000153 void mangleCXXVirtualDisplacementMap(const CXXRecordDecl *SrcRD,
154 const CXXRecordDecl *DstRD,
155 raw_ostream &Out) override;
David Majnemer7c237072015-03-05 00:46:22 +0000156 void mangleCXXThrowInfo(QualType T, bool IsConst, bool IsVolatile,
David Majnemer526793d2016-07-12 04:42:50 +0000157 bool IsUnaligned, uint32_t NumEntries,
158 raw_ostream &Out) override;
David Majnemer7c237072015-03-05 00:46:22 +0000159 void mangleCXXCatchableTypeArray(QualType T, uint32_t NumEntries,
160 raw_ostream &Out) override;
David Majnemere7a818f2015-03-06 18:53:55 +0000161 void mangleCXXCatchableType(QualType T, const CXXConstructorDecl *CD,
David Majnemerdfa6d202015-03-11 18:36:39 +0000162 CXXCtorType CT, uint32_t Size, uint32_t NVOffset,
David Majnemer999cbf92015-03-10 19:01:51 +0000163 int32_t VBPtrOffset, uint32_t VBIndex,
164 raw_ostream &Out) override;
David Majnemera96b7ee2014-05-13 00:44:44 +0000165 void mangleCXXRTTI(QualType T, raw_ostream &Out) override;
166 void mangleCXXRTTIName(QualType T, raw_ostream &Out) override;
David Majnemeraeb55c92014-05-13 06:57:43 +0000167 void mangleCXXRTTIBaseClassDescriptor(const CXXRecordDecl *Derived,
Warren Hunt5c2b4ea2014-05-23 16:07:43 +0000168 uint32_t NVOffset, int32_t VBPtrOffset,
David Majnemeraeb55c92014-05-13 06:57:43 +0000169 uint32_t VBTableOffset, uint32_t Flags,
170 raw_ostream &Out) override;
David Majnemera96b7ee2014-05-13 00:44:44 +0000171 void mangleCXXRTTIBaseClassArray(const CXXRecordDecl *Derived,
172 raw_ostream &Out) override;
173 void mangleCXXRTTIClassHierarchyDescriptor(const CXXRecordDecl *Derived,
174 raw_ostream &Out) override;
David Majnemeraeb55c92014-05-13 06:57:43 +0000175 void
176 mangleCXXRTTICompleteObjectLocator(const CXXRecordDecl *Derived,
177 ArrayRef<const CXXRecordDecl *> BasePath,
178 raw_ostream &Out) override;
Craig Toppercbce6e92014-03-11 06:22:39 +0000179 void mangleTypeName(QualType T, raw_ostream &) override;
180 void mangleCXXCtor(const CXXConstructorDecl *D, CXXCtorType Type,
181 raw_ostream &) override;
182 void mangleCXXDtor(const CXXDestructorDecl *D, CXXDtorType Type,
183 raw_ostream &) override;
David Majnemerdaff3702014-05-01 17:50:17 +0000184 void mangleReferenceTemporary(const VarDecl *, unsigned ManglingNumber,
185 raw_ostream &) override;
Craig Toppercbce6e92014-03-11 06:22:39 +0000186 void mangleStaticGuardVariable(const VarDecl *D, raw_ostream &Out) override;
David Majnemer8354eee2015-05-07 06:15:46 +0000187 void mangleThreadSafeStaticGuardVariable(const VarDecl *D, unsigned GuardNum,
188 raw_ostream &Out) override;
Craig Toppercbce6e92014-03-11 06:22:39 +0000189 void mangleDynamicInitializer(const VarDecl *D, raw_ostream &Out) override;
190 void mangleDynamicAtExitDestructor(const VarDecl *D,
191 raw_ostream &Out) override;
Reid Kleckner1d59f992015-01-22 01:36:17 +0000192 void mangleSEHFilterExpression(const NamedDecl *EnclosingDecl,
193 raw_ostream &Out) override;
Reid Klecknerebaf28d2015-04-14 20:59:00 +0000194 void mangleSEHFinallyBlock(const NamedDecl *EnclosingDecl,
195 raw_ostream &Out) override;
David Majnemer58e5bee2014-03-24 21:43:36 +0000196 void mangleStringLiteral(const StringLiteral *SL, raw_ostream &Out) override;
David Majnemer2206bf52014-03-05 08:57:59 +0000197 bool getNextDiscriminator(const NamedDecl *ND, unsigned &disc) {
David Majnemer2206bf52014-03-05 08:57:59 +0000198 const DeclContext *DC = getEffectiveDeclContext(ND);
199 if (!DC->isFunctionOrMethod())
200 return false;
201
David Majnemer41311192016-01-17 07:09:24 +0000202 // Lambda closure types are already numbered, give out a phony number so
203 // that they demangle nicely.
David Majnemer984498f2016-12-06 17:01:02 +0000204 if (const auto *RD = dyn_cast<CXXRecordDecl>(ND)) {
205 if (RD->isLambda()) {
206 disc = 1;
207 return true;
208 }
David Majnemer41311192016-01-17 07:09:24 +0000209 }
210
David Majnemer2206bf52014-03-05 08:57:59 +0000211 // Use the canonical number for externally visible decls.
212 if (ND->isExternallyVisible()) {
213 disc = getASTContext().getManglingNumber(ND);
214 return true;
215 }
216
217 // Anonymous tags are already numbered.
218 if (const TagDecl *Tag = dyn_cast<TagDecl>(ND)) {
David Majnemerb33cd902015-09-02 15:50:38 +0000219 if (!Tag->hasNameForLinkage() &&
220 !getASTContext().getDeclaratorForUnnamedTagDecl(Tag) &&
221 !getASTContext().getTypedefNameForUnnamedTagDecl(Tag))
David Majnemer2206bf52014-03-05 08:57:59 +0000222 return false;
223 }
224
225 // Make up a reasonable number for internal decls.
226 unsigned &discriminator = Uniquifier[ND];
227 if (!discriminator)
228 discriminator = ++Discriminator[std::make_pair(DC, ND->getIdentifier())];
David Majnemer040fa342014-10-05 06:44:53 +0000229 disc = discriminator + 1;
David Majnemer2206bf52014-03-05 08:57:59 +0000230 return true;
231 }
Reid Kleckner1ece9fc2013-09-10 20:43:12 +0000232
David Majnemerf017ec32014-03-05 10:35:06 +0000233 unsigned getLambdaId(const CXXRecordDecl *RD) {
234 assert(RD->isLambda() && "RD must be a lambda!");
235 assert(!RD->isExternallyVisible() && "RD must not be visible!");
236 assert(RD->getLambdaManglingNumber() == 0 &&
237 "RD must not have a mangling number!");
238 std::pair<llvm::DenseMap<const CXXRecordDecl *, unsigned>::iterator, bool>
239 Result = LambdaIds.insert(std::make_pair(RD, LambdaIds.size()));
240 return Result.first->second;
241 }
242
Reid Klecknerdf8dd612018-08-17 20:59:27 +0000243 /// Return a character sequence that is (somewhat) unique to the TU suitable
244 /// for mangling anonymous namespaces.
245 StringRef getAnonymousNamespaceHash() const {
246 return AnonymousNamespaceHash;
247 }
248
Reid Kleckner1ece9fc2013-09-10 20:43:12 +0000249private:
David Majnemerfebb2722016-03-07 08:51:17 +0000250 void mangleInitFiniStub(const VarDecl *D, char CharCode, raw_ostream &Out);
Guy Benyei11169dd2012-12-18 14:30:41 +0000251};
252
David Majnemer2206bf52014-03-05 08:57:59 +0000253/// MicrosoftCXXNameMangler - Manage the mangling of a single name for the
254/// Microsoft Visual C++ ABI.
255class MicrosoftCXXNameMangler {
256 MicrosoftMangleContextImpl &Context;
257 raw_ostream &Out;
258
259 /// The "structor" is the top-level declaration being mangled, if
260 /// that's not a template specialization; otherwise it's the pattern
261 /// for that specialization.
262 const NamedDecl *Structor;
263 unsigned StructorType;
264
David Majnemer0d0560c2014-09-25 19:43:56 +0000265 typedef llvm::SmallVector<std::string, 10> BackRefVec;
266 BackRefVec NameBackReferences;
David Majnemer2206bf52014-03-05 08:57:59 +0000267
David Majnemer622abd12015-12-31 05:36:52 +0000268 typedef llvm::DenseMap<const void *, unsigned> ArgBackRefMap;
Nico Weber73f05842019-06-01 10:12:07 +0000269 ArgBackRefMap FunArgBackReferences;
270 ArgBackRefMap TemplateArgBackReferences;
David Majnemer2206bf52014-03-05 08:57:59 +0000271
Nico Weber48707762019-06-04 23:27:40 +0000272 typedef llvm::DenseMap<const void *, StringRef> TemplateArgStringMap;
273 TemplateArgStringMap TemplateArgStrings;
274 llvm::StringSaver TemplateArgStringStorage;
275 llvm::BumpPtrAllocator TemplateArgStringStorageAlloc;
276
Erik Pilkington02d5fb12019-03-19 20:44:18 +0000277 typedef std::set<std::pair<int, bool>> PassObjectSizeArgsSet;
David Majnemer5f177622015-12-30 05:13:03 +0000278 PassObjectSizeArgsSet PassObjectSizeArgs;
279
David Majnemer2206bf52014-03-05 08:57:59 +0000280 ASTContext &getASTContext() const { return Context.getASTContext(); }
281
David Majnemer2206bf52014-03-05 08:57:59 +0000282 const bool PointersAre64Bit;
283
284public:
285 enum QualifierMangleMode { QMM_Drop, QMM_Mangle, QMM_Escape, QMM_Result };
286
287 MicrosoftCXXNameMangler(MicrosoftMangleContextImpl &C, raw_ostream &Out_)
Craig Topper36250ad2014-05-12 05:36:57 +0000288 : Context(C), Out(Out_), Structor(nullptr), StructorType(-1),
Nico Weber48707762019-06-04 23:27:40 +0000289 TemplateArgStringStorage(TemplateArgStringStorageAlloc),
David Majnemer02e9af42014-04-23 05:16:51 +0000290 PointersAre64Bit(C.getASTContext().getTargetInfo().getPointerWidth(0) ==
291 64) {}
David Majnemer2206bf52014-03-05 08:57:59 +0000292
293 MicrosoftCXXNameMangler(MicrosoftMangleContextImpl &C, raw_ostream &Out_,
David Majnemerdfa6d202015-03-11 18:36:39 +0000294 const CXXConstructorDecl *D, CXXCtorType Type)
295 : Context(C), Out(Out_), Structor(getStructor(D)), StructorType(Type),
Nico Weber48707762019-06-04 23:27:40 +0000296 TemplateArgStringStorage(TemplateArgStringStorageAlloc),
David Majnemerdfa6d202015-03-11 18:36:39 +0000297 PointersAre64Bit(C.getASTContext().getTargetInfo().getPointerWidth(0) ==
298 64) {}
299
300 MicrosoftCXXNameMangler(MicrosoftMangleContextImpl &C, raw_ostream &Out_,
David Majnemer2206bf52014-03-05 08:57:59 +0000301 const CXXDestructorDecl *D, CXXDtorType Type)
David Majnemer02e9af42014-04-23 05:16:51 +0000302 : Context(C), Out(Out_), Structor(getStructor(D)), StructorType(Type),
Nico Weber48707762019-06-04 23:27:40 +0000303 TemplateArgStringStorage(TemplateArgStringStorageAlloc),
David Majnemer02e9af42014-04-23 05:16:51 +0000304 PointersAre64Bit(C.getASTContext().getTargetInfo().getPointerWidth(0) ==
305 64) {}
David Majnemer2206bf52014-03-05 08:57:59 +0000306
307 raw_ostream &getStream() const { return Out; }
308
Reid Klecknerfb931542018-03-16 20:36:49 +0000309 void mangle(const NamedDecl *D, StringRef Prefix = "?");
David Majnemer2206bf52014-03-05 08:57:59 +0000310 void mangleName(const NamedDecl *ND);
David Majnemerab4b4a12015-05-18 00:05:25 +0000311 void mangleFunctionEncoding(const FunctionDecl *FD, bool ShouldMangle);
David Majnemer2206bf52014-03-05 08:57:59 +0000312 void mangleVariableEncoding(const VarDecl *VD);
313 void mangleMemberDataPointer(const CXXRecordDecl *RD, const ValueDecl *VD);
314 void mangleMemberFunctionPointer(const CXXRecordDecl *RD,
315 const CXXMethodDecl *MD);
Reid Klecknercbec0262018-04-02 20:00:39 +0000316 void mangleVirtualMemPtrThunk(const CXXMethodDecl *MD,
317 const MethodVFTableLocation &ML);
David Majnemer2206bf52014-03-05 08:57:59 +0000318 void mangleNumber(int64_t Number);
David Majnemer3add70b2015-12-29 11:45:53 +0000319 void mangleTagTypeKind(TagTypeKind TK);
Shoaib Meenaid84cf132018-11-14 19:16:22 +0000320 void mangleArtificialTagType(TagTypeKind TK, StringRef UnqualifiedName,
David Majnemer3add70b2015-12-29 11:45:53 +0000321 ArrayRef<StringRef> NestedNames = None);
Erich Keane24a0f042018-12-14 23:17:34 +0000322 void mangleAddressSpaceType(QualType T, Qualifiers Quals, SourceRange Range);
David Majnemer2206bf52014-03-05 08:57:59 +0000323 void mangleType(QualType T, SourceRange Range,
324 QualifierMangleMode QMM = QMM_Mangle);
Craig Topper36250ad2014-05-12 05:36:57 +0000325 void mangleFunctionType(const FunctionType *T,
326 const FunctionDecl *D = nullptr,
Reid Klecknerd2f98772018-12-17 23:10:43 +0000327 bool ForceThisQuals = false,
328 bool MangleExceptionSpec = true);
David Majnemer2206bf52014-03-05 08:57:59 +0000329 void mangleNestedName(const NamedDecl *ND);
330
331private:
Reid Kleckner290feb92017-01-09 17:04:37 +0000332 bool isStructorDecl(const NamedDecl *ND) const {
333 return ND == Structor || getStructor(ND) == Structor;
334 }
335
Amy Huanga85f5ef2019-10-24 16:34:25 -0700336 bool is64BitPointer(Qualifiers Quals) const {
337 LangAS AddrSpace = Quals.getAddressSpace();
338 return AddrSpace == LangAS::ptr64 ||
339 (PointersAre64Bit && !(AddrSpace == LangAS::ptr32_sptr ||
340 AddrSpace == LangAS::ptr32_uptr));
341 }
342
David Majnemer2206bf52014-03-05 08:57:59 +0000343 void mangleUnqualifiedName(const NamedDecl *ND) {
344 mangleUnqualifiedName(ND, ND->getDeclName());
345 }
346 void mangleUnqualifiedName(const NamedDecl *ND, DeclarationName Name);
347 void mangleSourceName(StringRef Name);
348 void mangleOperatorName(OverloadedOperatorKind OO, SourceLocation Loc);
349 void mangleCXXDtorType(CXXDtorType T);
350 void mangleQualifiers(Qualifiers Quals, bool IsMember);
David Majnemere3785bb2014-04-23 05:16:56 +0000351 void mangleRefQualifier(RefQualifierKind RefQualifier);
David Majnemer2206bf52014-03-05 08:57:59 +0000352 void manglePointerCVQualifiers(Qualifiers Quals);
David Majnemer7a3ce0c2015-05-26 01:30:45 +0000353 void manglePointerExtQualifiers(Qualifiers Quals, QualType PointeeType);
David Majnemer2206bf52014-03-05 08:57:59 +0000354
355 void mangleUnscopedTemplateName(const TemplateDecl *ND);
David Majnemer02e9af42014-04-23 05:16:51 +0000356 void
357 mangleTemplateInstantiationName(const TemplateDecl *TD,
358 const TemplateArgumentList &TemplateArgs);
David Majnemer2206bf52014-03-05 08:57:59 +0000359 void mangleObjCMethodName(const ObjCMethodDecl *MD);
360
Nico Weber73f05842019-06-01 10:12:07 +0000361 void mangleFunctionArgumentType(QualType T, SourceRange Range);
David Majnemer5f177622015-12-30 05:13:03 +0000362 void manglePassObjectSizeArg(const PassObjectSizeAttr *POSA);
David Majnemer2206bf52014-03-05 08:57:59 +0000363
Nico Weber3239f132018-07-23 20:04:00 +0000364 bool isArtificialTagType(QualType T) const;
365
David Majnemer2206bf52014-03-05 08:57:59 +0000366 // Declare manglers for every type class.
367#define ABSTRACT_TYPE(CLASS, PARENT)
368#define NON_CANONICAL_TYPE(CLASS, PARENT)
369#define TYPE(CLASS, PARENT) void mangleType(const CLASS##Type *T, \
David Majnemer7a3ce0c2015-05-26 01:30:45 +0000370 Qualifiers Quals, \
David Majnemer2206bf52014-03-05 08:57:59 +0000371 SourceRange Range);
John McCall36b12a82019-10-02 06:35:23 +0000372#include "clang/AST/TypeNodes.inc"
David Majnemer2206bf52014-03-05 08:57:59 +0000373#undef ABSTRACT_TYPE
374#undef NON_CANONICAL_TYPE
375#undef TYPE
376
377 void mangleType(const TagDecl *TD);
378 void mangleDecayedArrayType(const ArrayType *T);
379 void mangleArrayType(const ArrayType *T);
380 void mangleFunctionClass(const FunctionDecl *FD);
David Majnemerdfa6d202015-03-11 18:36:39 +0000381 void mangleCallingConvention(CallingConv CC);
David Majnemer2206bf52014-03-05 08:57:59 +0000382 void mangleCallingConvention(const FunctionType *T);
383 void mangleIntegerLiteral(const llvm::APSInt &Number, bool IsBoolean);
384 void mangleExpression(const Expr *E);
385 void mangleThrowSpecification(const FunctionProtoType *T);
386
387 void mangleTemplateArgs(const TemplateDecl *TD,
388 const TemplateArgumentList &TemplateArgs);
David Majnemer57fbc0c2014-08-05 22:43:45 +0000389 void mangleTemplateArg(const TemplateDecl *TD, const TemplateArgument &TA,
390 const NamedDecl *Parm);
Saleem Abdulrasoolbbce34a2018-02-09 03:23:54 +0000391
392 void mangleObjCProtocol(const ObjCProtocolDecl *PD);
393 void mangleObjCLifetime(const QualType T, Qualifiers Quals,
394 SourceRange Range);
Saleem Abdulrasoolf3a981e2018-09-28 16:47:53 +0000395 void mangleObjCKindOfType(const ObjCObjectType *T, Qualifiers Quals,
396 SourceRange Range);
David Majnemer2206bf52014-03-05 08:57:59 +0000397};
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000398}
Guy Benyei11169dd2012-12-18 14:30:41 +0000399
Reid Klecknerdf8dd612018-08-17 20:59:27 +0000400MicrosoftMangleContextImpl::MicrosoftMangleContextImpl(ASTContext &Context,
401 DiagnosticsEngine &Diags)
402 : MicrosoftMangleContext(Context, Diags) {
403 // To mangle anonymous namespaces, hash the path to the main source file. The
404 // path should be whatever (probably relative) path was passed on the command
405 // line. The goal is for the compiler to produce the same output regardless of
406 // working directory, so use the uncanonicalized relative path.
407 //
408 // It's important to make the mangled names unique because, when CodeView
409 // debug info is in use, the debugger uses mangled type names to distinguish
410 // between otherwise identically named types in anonymous namespaces.
411 //
412 // These symbols are always internal, so there is no need for the hash to
413 // match what MSVC produces. For the same reason, clang is free to change the
414 // hash at any time without breaking compatibility with old versions of clang.
415 // The generated names are intended to look similar to what MSVC generates,
416 // which are something like "?A0x01234567@".
417 SourceManager &SM = Context.getSourceManager();
418 if (const FileEntry *FE = SM.getFileEntryForID(SM.getMainFileID())) {
419 // Truncate the hash so we get 8 characters of hexadecimal.
420 uint32_t TruncatedHash = uint32_t(xxHash64(FE->getName()));
421 AnonymousNamespaceHash = llvm::utohexstr(TruncatedHash);
422 } else {
423 // If we don't have a path to the main file, we'll just use 0.
424 AnonymousNamespaceHash = "0";
425 }
426}
427
Rafael Espindola002667c2013-10-16 01:40:34 +0000428bool MicrosoftMangleContextImpl::shouldMangleCXXName(const NamedDecl *D) {
David Majnemerd5a42b82013-09-13 09:03:14 +0000429 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
430 LanguageLinkage L = FD->getLanguageLinkage();
431 // Overloadable functions need mangling.
432 if (FD->hasAttr<OverloadableAttr>())
433 return true;
434
David Majnemerc729b0b2013-09-16 22:44:20 +0000435 // The ABI expects that we would never mangle "typical" user-defined entry
436 // points regardless of visibility or freestanding-ness.
437 //
438 // N.B. This is distinct from asking about "main". "main" has a lot of
439 // special rules associated with it in the standard while these
440 // user-defined entry points are outside of the purview of the standard.
441 // For example, there can be only one definition for "main" in a standards
442 // compliant program; however nothing forbids the existence of wmain and
443 // WinMain in the same translation unit.
444 if (FD->isMSVCRTEntryPoint())
David Majnemerd5a42b82013-09-13 09:03:14 +0000445 return false;
446
447 // C++ functions and those whose names are not a simple identifier need
448 // mangling.
449 if (!FD->getDeclName().isIdentifier() || L == CXXLanguageLinkage)
450 return true;
451
452 // C functions are not mangled.
453 if (L == CLanguageLinkage)
454 return false;
455 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000456
457 // Otherwise, no mangling is done outside C++ mode.
458 if (!getASTContext().getLangOpts().CPlusPlus)
459 return false;
460
Richard Smithda383632016-08-15 01:33:41 +0000461 const VarDecl *VD = dyn_cast<VarDecl>(D);
462 if (VD && !isa<DecompositionDecl>(D)) {
David Majnemerd5a42b82013-09-13 09:03:14 +0000463 // C variables are not mangled.
464 if (VD->isExternC())
465 return false;
466
467 // Variables at global scope with non-internal linkage are not mangled.
468 const DeclContext *DC = getEffectiveDeclContext(D);
469 // Check for extern variable declared locally.
470 if (DC->isFunctionOrMethod() && D->hasLinkage())
471 while (!DC->isNamespace() && !DC->isTranslationUnit())
472 DC = getEffectiveParentContext(DC);
473
474 if (DC->isTranslationUnit() && D->getFormalLinkage() == InternalLinkage &&
David Majnemeree6c4092015-10-22 07:15:56 +0000475 !isa<VarTemplateSpecializationDecl>(D) &&
476 D->getIdentifier() != nullptr)
Guy Benyei11169dd2012-12-18 14:30:41 +0000477 return false;
478 }
479
Guy Benyei11169dd2012-12-18 14:30:41 +0000480 return true;
481}
482
David Majnemer58e5bee2014-03-24 21:43:36 +0000483bool
484MicrosoftMangleContextImpl::shouldMangleStringLiteral(const StringLiteral *SL) {
David Majnemer6fc2d812014-11-22 06:20:38 +0000485 return true;
David Majnemer58e5bee2014-03-24 21:43:36 +0000486}
487
David Majnemer02e9af42014-04-23 05:16:51 +0000488void MicrosoftCXXNameMangler::mangle(const NamedDecl *D, StringRef Prefix) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000489 // MSVC doesn't mangle C++ names the same way it mangles extern "C" names.
490 // Therefore it's really important that we don't decorate the
491 // name with leading underscores or leading/trailing at signs. So, by
492 // default, we emit an asm marker at the start so we get the name right.
493 // Callers can override this with a custom prefix.
494
Guy Benyei11169dd2012-12-18 14:30:41 +0000495 // <mangled-name> ::= ? <name> <type-encoding>
496 Out << Prefix;
497 mangleName(D);
498 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
David Majnemerab4b4a12015-05-18 00:05:25 +0000499 mangleFunctionEncoding(FD, Context.shouldMangleDeclName(FD));
Guy Benyei11169dd2012-12-18 14:30:41 +0000500 else if (const VarDecl *VD = dyn_cast<VarDecl>(D))
501 mangleVariableEncoding(VD);
Shoaib Meenaic8714d22018-10-04 19:50:14 +0000502 else
David Majnemer53b60a12015-12-29 22:02:10 +0000503 llvm_unreachable("Tried to mangle unexpected NamedDecl!");
Guy Benyei11169dd2012-12-18 14:30:41 +0000504}
505
David Majnemerab4b4a12015-05-18 00:05:25 +0000506void MicrosoftCXXNameMangler::mangleFunctionEncoding(const FunctionDecl *FD,
507 bool ShouldMangle) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000508 // <type-encoding> ::= <function-class> <function-type>
509
Reid Kleckner18da98e2013-06-24 19:21:52 +0000510 // Since MSVC operates on the type as written and not the canonical type, it
511 // actually matters which decl we have here. MSVC appears to choose the
512 // first, since it is most likely to be the declaration in a header file.
Rafael Espindola8db352d2013-10-17 15:37:26 +0000513 FD = FD->getFirstDecl();
Reid Kleckner18da98e2013-06-24 19:21:52 +0000514
Guy Benyei11169dd2012-12-18 14:30:41 +0000515 // We should never ever see a FunctionNoProtoType at this point.
516 // We don't even know how to mangle their types anyway :).
Reid Kleckner9a7f3e62013-10-08 00:58:57 +0000517 const FunctionProtoType *FT = FD->getType()->castAs<FunctionProtoType>();
Guy Benyei11169dd2012-12-18 14:30:41 +0000518
David Majnemerd5a42b82013-09-13 09:03:14 +0000519 // extern "C" functions can hold entities that must be mangled.
520 // As it stands, these functions still need to get expressed in the full
521 // external name. They have their class and type omitted, replaced with '9'.
David Majnemerab4b4a12015-05-18 00:05:25 +0000522 if (ShouldMangle) {
David Majnemer5a7cfea2015-05-18 00:05:29 +0000523 // We would like to mangle all extern "C" functions using this additional
524 // component but this would break compatibility with MSVC's behavior.
525 // Instead, do this when we know that compatibility isn't important (in
Eric Christopherbe528662015-12-16 23:10:46 +0000526 // other words, when it is an overloaded extern "C" function).
David Majnemer5a7cfea2015-05-18 00:05:29 +0000527 if (FD->isExternC() && FD->hasAttr<OverloadableAttr>())
528 Out << "$$J0";
529
David Majnemerd5a42b82013-09-13 09:03:14 +0000530 mangleFunctionClass(FD);
Guy Benyei11169dd2012-12-18 14:30:41 +0000531
Reid Klecknerd2f98772018-12-17 23:10:43 +0000532 mangleFunctionType(FT, FD, false, false);
David Majnemerab4b4a12015-05-18 00:05:25 +0000533 } else {
David Majnemerd5a42b82013-09-13 09:03:14 +0000534 Out << '9';
David Majnemerab4b4a12015-05-18 00:05:25 +0000535 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000536}
537
538void MicrosoftCXXNameMangler::mangleVariableEncoding(const VarDecl *VD) {
539 // <type-encoding> ::= <storage-class> <variable-type>
540 // <storage-class> ::= 0 # private static member
541 // ::= 1 # protected static member
542 // ::= 2 # public static member
543 // ::= 3 # global
544 // ::= 4 # static local
David Majnemerb4119f72013-12-13 01:06:04 +0000545
Guy Benyei11169dd2012-12-18 14:30:41 +0000546 // The first character in the encoding (after the name) is the storage class.
547 if (VD->isStaticDataMember()) {
548 // If it's a static member, it also encodes the access level.
549 switch (VD->getAccess()) {
550 default:
551 case AS_private: Out << '0'; break;
552 case AS_protected: Out << '1'; break;
553 case AS_public: Out << '2'; break;
554 }
555 }
556 else if (!VD->isStaticLocal())
557 Out << '3';
558 else
559 Out << '4';
560 // Now mangle the type.
561 // <variable-type> ::= <type> <cvr-qualifiers>
562 // ::= <type> <pointee-cvr-qualifiers> # pointers, references
563 // Pointers and references are odd. The type of 'int * const foo;' gets
564 // mangled as 'QAHA' instead of 'PAHB', for example.
Zachary Turner87422d92014-06-25 05:37:25 +0000565 SourceRange SR = VD->getSourceRange();
David Majnemerb9a5f2d2014-01-21 20:33:36 +0000566 QualType Ty = VD->getType();
David Majnemer6dda7bb2013-08-15 08:13:23 +0000567 if (Ty->isPointerType() || Ty->isReferenceType() ||
568 Ty->isMemberPointerType()) {
Zachary Turner87422d92014-06-25 05:37:25 +0000569 mangleType(Ty, SR, QMM_Drop);
David Majnemer8eec58f2014-02-18 14:20:10 +0000570 manglePointerExtQualifiers(
David Majnemer7a3ce0c2015-05-26 01:30:45 +0000571 Ty.getDesugaredType(getASTContext()).getLocalQualifiers(), QualType());
David Majnemer6dda7bb2013-08-15 08:13:23 +0000572 if (const MemberPointerType *MPT = Ty->getAs<MemberPointerType>()) {
573 mangleQualifiers(MPT->getPointeeType().getQualifiers(), true);
574 // Member pointers are suffixed with a back reference to the member
575 // pointer's class name.
576 mangleName(MPT->getClass()->getAsCXXRecordDecl());
577 } else
578 mangleQualifiers(Ty->getPointeeType().getQualifiers(), false);
David Majnemera2724ae2013-08-09 05:56:24 +0000579 } else if (const ArrayType *AT = getASTContext().getAsArrayType(Ty)) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000580 // Global arrays are funny, too.
David Majnemer5a1b2042013-09-11 04:44:30 +0000581 mangleDecayedArrayType(AT);
Peter Collingbourne2816c022013-04-25 04:25:40 +0000582 if (AT->getElementType()->isArrayType())
583 Out << 'A';
584 else
585 mangleQualifiers(Ty.getQualifiers(), false);
Guy Benyei11169dd2012-12-18 14:30:41 +0000586 } else {
Zachary Turner87422d92014-06-25 05:37:25 +0000587 mangleType(Ty, SR, QMM_Drop);
Will Wilson5f383672014-11-05 13:54:21 +0000588 mangleQualifiers(Ty.getQualifiers(), false);
Guy Benyei11169dd2012-12-18 14:30:41 +0000589 }
590}
591
Reid Kleckner96f8f932014-02-05 17:27:08 +0000592void MicrosoftCXXNameMangler::mangleMemberDataPointer(const CXXRecordDecl *RD,
David Majnemer1e378e42014-02-06 12:46:52 +0000593 const ValueDecl *VD) {
Reid Kleckner96f8f932014-02-05 17:27:08 +0000594 // <member-data-pointer> ::= <integer-literal>
595 // ::= $F <number> <number>
596 // ::= $G <number> <number> <number>
597
David Majnemer763584d2014-02-06 10:59:19 +0000598 int64_t FieldOffset;
599 int64_t VBTableOffset;
Reid Klecknera9cc64e2019-11-15 18:49:32 -0800600 MSInheritanceModel IM = RD->getMSInheritanceModel();
David Majnemer1e378e42014-02-06 12:46:52 +0000601 if (VD) {
602 FieldOffset = getASTContext().getFieldOffset(VD);
David Majnemer763584d2014-02-06 10:59:19 +0000603 assert(FieldOffset % getASTContext().getCharWidth() == 0 &&
Reid Kleckner96f8f932014-02-05 17:27:08 +0000604 "cannot take address of bitfield");
David Majnemer763584d2014-02-06 10:59:19 +0000605 FieldOffset /= getASTContext().getCharWidth();
606
607 VBTableOffset = 0;
David Majnemer08ef2ba2015-06-23 20:34:18 +0000608
Reid Klecknera9cc64e2019-11-15 18:49:32 -0800609 if (IM == MSInheritanceModel::Virtual)
David Majnemer08ef2ba2015-06-23 20:34:18 +0000610 FieldOffset -= getASTContext().getOffsetOfBaseWithVBPtr(RD).getQuantity();
David Majnemer763584d2014-02-06 10:59:19 +0000611 } else {
612 FieldOffset = RD->nullFieldOffsetIsZero() ? 0 : -1;
613
614 VBTableOffset = -1;
Reid Kleckner96f8f932014-02-05 17:27:08 +0000615 }
616
David Majnemer763584d2014-02-06 10:59:19 +0000617 char Code = '\0';
Reid Kleckner96f8f932014-02-05 17:27:08 +0000618 switch (IM) {
Reid Klecknera9cc64e2019-11-15 18:49:32 -0800619 case MSInheritanceModel::Single: Code = '0'; break;
620 case MSInheritanceModel::Multiple: Code = '0'; break;
621 case MSInheritanceModel::Virtual: Code = 'F'; break;
622 case MSInheritanceModel::Unspecified: Code = 'G'; break;
Reid Kleckner96f8f932014-02-05 17:27:08 +0000623 }
624
David Majnemer763584d2014-02-06 10:59:19 +0000625 Out << '$' << Code;
Reid Kleckner96f8f932014-02-05 17:27:08 +0000626
David Majnemer763584d2014-02-06 10:59:19 +0000627 mangleNumber(FieldOffset);
628
Reid Klecknerbf94e6e2014-04-07 18:07:03 +0000629 // The C++ standard doesn't allow base-to-derived member pointer conversions
630 // in template parameter contexts, so the vbptr offset of data member pointers
631 // is always zero.
Reid Klecknera9cc64e2019-11-15 18:49:32 -0800632 if (inheritanceModelHasVBPtrOffsetField(IM))
Reid Kleckner96f8f932014-02-05 17:27:08 +0000633 mangleNumber(0);
Reid Klecknera9cc64e2019-11-15 18:49:32 -0800634 if (inheritanceModelHasVBTableOffsetField(IM))
David Majnemer763584d2014-02-06 10:59:19 +0000635 mangleNumber(VBTableOffset);
Reid Kleckner96f8f932014-02-05 17:27:08 +0000636}
637
638void
639MicrosoftCXXNameMangler::mangleMemberFunctionPointer(const CXXRecordDecl *RD,
640 const CXXMethodDecl *MD) {
641 // <member-function-pointer> ::= $1? <name>
642 // ::= $H? <name> <number>
643 // ::= $I? <name> <number> <number>
644 // ::= $J? <name> <number> <number> <number>
Reid Kleckner96f8f932014-02-05 17:27:08 +0000645
Reid Klecknera9cc64e2019-11-15 18:49:32 -0800646 MSInheritanceModel IM = RD->getMSInheritanceModel();
Reid Kleckner96f8f932014-02-05 17:27:08 +0000647
Reid Kleckner96f8f932014-02-05 17:27:08 +0000648 char Code = '\0';
649 switch (IM) {
Reid Klecknera9cc64e2019-11-15 18:49:32 -0800650 case MSInheritanceModel::Single: Code = '1'; break;
651 case MSInheritanceModel::Multiple: Code = 'H'; break;
652 case MSInheritanceModel::Virtual: Code = 'I'; break;
653 case MSInheritanceModel::Unspecified: Code = 'J'; break;
Reid Kleckner96f8f932014-02-05 17:27:08 +0000654 }
655
Reid Kleckner96f8f932014-02-05 17:27:08 +0000656 // If non-virtual, mangle the name. If virtual, mangle as a virtual memptr
657 // thunk.
658 uint64_t NVOffset = 0;
659 uint64_t VBTableOffset = 0;
Reid Klecknerbf94e6e2014-04-07 18:07:03 +0000660 uint64_t VBPtrOffset = 0;
David Majnemer6a729c62014-06-11 04:55:08 +0000661 if (MD) {
662 Out << '$' << Code << '?';
663 if (MD->isVirtual()) {
664 MicrosoftVTableContext *VTContext =
665 cast<MicrosoftVTableContext>(getASTContext().getVTableContext());
Reid Klecknercbec0262018-04-02 20:00:39 +0000666 MethodVFTableLocation ML =
David Majnemer6a729c62014-06-11 04:55:08 +0000667 VTContext->getMethodVFTableLocation(GlobalDecl(MD));
668 mangleVirtualMemPtrThunk(MD, ML);
669 NVOffset = ML.VFPtrOffset.getQuantity();
670 VBTableOffset = ML.VBTableIndex * 4;
671 if (ML.VBase) {
672 const ASTRecordLayout &Layout = getASTContext().getASTRecordLayout(RD);
673 VBPtrOffset = Layout.getVBPtrOffset().getQuantity();
674 }
675 } else {
676 mangleName(MD);
David Majnemerab4b4a12015-05-18 00:05:25 +0000677 mangleFunctionEncoding(MD, /*ShouldMangle=*/true);
Reid Kleckner96f8f932014-02-05 17:27:08 +0000678 }
David Majnemer08ef2ba2015-06-23 20:34:18 +0000679
Reid Klecknera9cc64e2019-11-15 18:49:32 -0800680 if (VBTableOffset == 0 && IM == MSInheritanceModel::Virtual)
David Majnemer08ef2ba2015-06-23 20:34:18 +0000681 NVOffset -= getASTContext().getOffsetOfBaseWithVBPtr(RD).getQuantity();
Reid Kleckner96f8f932014-02-05 17:27:08 +0000682 } else {
David Majnemer6a729c62014-06-11 04:55:08 +0000683 // Null single inheritance member functions are encoded as a simple nullptr.
Reid Klecknera9cc64e2019-11-15 18:49:32 -0800684 if (IM == MSInheritanceModel::Single) {
David Majnemer6a729c62014-06-11 04:55:08 +0000685 Out << "$0A@";
686 return;
687 }
Reid Klecknera9cc64e2019-11-15 18:49:32 -0800688 if (IM == MSInheritanceModel::Unspecified)
David Majnemer6a729c62014-06-11 04:55:08 +0000689 VBTableOffset = -1;
690 Out << '$' << Code;
Reid Kleckner96f8f932014-02-05 17:27:08 +0000691 }
692
Reid Klecknera9cc64e2019-11-15 18:49:32 -0800693 if (inheritanceModelHasNVOffsetField(/*IsMemberFunction=*/true, IM))
David Majnemer08ef2ba2015-06-23 20:34:18 +0000694 mangleNumber(static_cast<uint32_t>(NVOffset));
Reid Klecknera9cc64e2019-11-15 18:49:32 -0800695 if (inheritanceModelHasVBPtrOffsetField(IM))
Reid Klecknerbf94e6e2014-04-07 18:07:03 +0000696 mangleNumber(VBPtrOffset);
Reid Klecknera9cc64e2019-11-15 18:49:32 -0800697 if (inheritanceModelHasVBTableOffsetField(IM))
Reid Kleckner96f8f932014-02-05 17:27:08 +0000698 mangleNumber(VBTableOffset);
699}
700
701void MicrosoftCXXNameMangler::mangleVirtualMemPtrThunk(
Reid Klecknercbec0262018-04-02 20:00:39 +0000702 const CXXMethodDecl *MD, const MethodVFTableLocation &ML) {
Reid Kleckner96f8f932014-02-05 17:27:08 +0000703 // Get the vftable offset.
704 CharUnits PointerWidth = getASTContext().toCharUnitsFromBits(
705 getASTContext().getTargetInfo().getPointerWidth(0));
706 uint64_t OffsetInVFTable = ML.Index * PointerWidth.getQuantity();
707
708 Out << "?_9";
709 mangleName(MD->getParent());
710 Out << "$B";
711 mangleNumber(OffsetInVFTable);
712 Out << 'A';
Simon Pilgrimd87a76c2020-01-11 15:41:31 +0000713 mangleCallingConvention(MD->getType()->castAs<FunctionProtoType>());
Reid Kleckner96f8f932014-02-05 17:27:08 +0000714}
715
Guy Benyei11169dd2012-12-18 14:30:41 +0000716void MicrosoftCXXNameMangler::mangleName(const NamedDecl *ND) {
717 // <name> ::= <unscoped-name> {[<named-scope>]+ | [<nested-name>]}? @
Guy Benyei11169dd2012-12-18 14:30:41 +0000718
719 // Always start with the unqualified name.
David Majnemerb4119f72013-12-13 01:06:04 +0000720 mangleUnqualifiedName(ND);
Guy Benyei11169dd2012-12-18 14:30:41 +0000721
David Majnemer2206bf52014-03-05 08:57:59 +0000722 mangleNestedName(ND);
Guy Benyei11169dd2012-12-18 14:30:41 +0000723
724 // Terminate the whole name with an '@'.
725 Out << '@';
726}
727
David Majnemer2a816452013-12-09 10:44:32 +0000728void MicrosoftCXXNameMangler::mangleNumber(int64_t Number) {
729 // <non-negative integer> ::= A@ # when Number == 0
730 // ::= <decimal digit> # when 1 <= Number <= 10
731 // ::= <hex digit>+ @ # when Number >= 10
732 //
733 // <number> ::= [?] <non-negative integer>
Guy Benyei11169dd2012-12-18 14:30:41 +0000734
David Majnemer2a816452013-12-09 10:44:32 +0000735 uint64_t Value = static_cast<uint64_t>(Number);
736 if (Number < 0) {
737 Value = -Value;
Guy Benyei11169dd2012-12-18 14:30:41 +0000738 Out << '?';
Guy Benyei11169dd2012-12-18 14:30:41 +0000739 }
David Majnemer2a816452013-12-09 10:44:32 +0000740
741 if (Value == 0)
742 Out << "A@";
743 else if (Value >= 1 && Value <= 10)
744 Out << (Value - 1);
745 else {
746 // Numbers that are not encoded as decimal digits are represented as nibbles
747 // in the range of ASCII characters 'A' to 'P'.
748 // The number 0x123450 would be encoded as 'BCDEFA'
749 char EncodedNumberBuffer[sizeof(uint64_t) * 2];
Craig Toppere3d2ecbe2014-06-28 23:22:33 +0000750 MutableArrayRef<char> BufferRef(EncodedNumberBuffer);
751 MutableArrayRef<char>::reverse_iterator I = BufferRef.rbegin();
David Majnemer2a816452013-12-09 10:44:32 +0000752 for (; Value != 0; Value >>= 4)
753 *I++ = 'A' + (Value & 0xf);
754 Out.write(I.base(), I - BufferRef.rbegin());
Guy Benyei11169dd2012-12-18 14:30:41 +0000755 Out << '@';
756 }
757}
758
759static const TemplateDecl *
Reid Kleckner52518862013-03-20 01:40:23 +0000760isTemplate(const NamedDecl *ND, const TemplateArgumentList *&TemplateArgs) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000761 // Check if we have a function template.
David Majnemer02e9af42014-04-23 05:16:51 +0000762 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000763 if (const TemplateDecl *TD = FD->getPrimaryTemplate()) {
Reid Kleckner52518862013-03-20 01:40:23 +0000764 TemplateArgs = FD->getTemplateSpecializationArgs();
Guy Benyei11169dd2012-12-18 14:30:41 +0000765 return TD;
766 }
767 }
768
769 // Check if we have a class template.
770 if (const ClassTemplateSpecializationDecl *Spec =
David Majnemer02e9af42014-04-23 05:16:51 +0000771 dyn_cast<ClassTemplateSpecializationDecl>(ND)) {
Reid Kleckner52518862013-03-20 01:40:23 +0000772 TemplateArgs = &Spec->getTemplateArgs();
Guy Benyei11169dd2012-12-18 14:30:41 +0000773 return Spec->getSpecializedTemplate();
774 }
775
David Majnemer8f774532014-03-04 05:38:05 +0000776 // Check if we have a variable template.
777 if (const VarTemplateSpecializationDecl *Spec =
778 dyn_cast<VarTemplateSpecializationDecl>(ND)) {
779 TemplateArgs = &Spec->getTemplateArgs();
780 return Spec->getSpecializedTemplate();
781 }
782
Craig Topper36250ad2014-05-12 05:36:57 +0000783 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +0000784}
785
David Majnemer02e9af42014-04-23 05:16:51 +0000786void MicrosoftCXXNameMangler::mangleUnqualifiedName(const NamedDecl *ND,
787 DeclarationName Name) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000788 // <unqualified-name> ::= <operator-name>
789 // ::= <ctor-dtor-name>
790 // ::= <source-name>
791 // ::= <template-name>
Reid Kleckner52518862013-03-20 01:40:23 +0000792
Guy Benyei11169dd2012-12-18 14:30:41 +0000793 // Check if we have a template.
Craig Topper36250ad2014-05-12 05:36:57 +0000794 const TemplateArgumentList *TemplateArgs = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +0000795 if (const TemplateDecl *TD = isTemplate(ND, TemplateArgs)) {
Reid Klecknerc16c4472013-07-13 00:43:39 +0000796 // Function templates aren't considered for name back referencing. This
797 // makes sense since function templates aren't likely to occur multiple
798 // times in a symbol.
David Majnemer56e2adb2015-12-30 05:40:32 +0000799 if (isa<FunctionTemplateDecl>(TD)) {
Reid Klecknerc16c4472013-07-13 00:43:39 +0000800 mangleTemplateInstantiationName(TD, *TemplateArgs);
Reid Kleckner11c6f612014-06-26 22:42:18 +0000801 Out << '@';
Reid Klecknerc16c4472013-07-13 00:43:39 +0000802 return;
803 }
804
Guy Benyei11169dd2012-12-18 14:30:41 +0000805 // Here comes the tricky thing: if we need to mangle something like
806 // void foo(A::X<Y>, B::X<Y>),
807 // the X<Y> part is aliased. However, if you need to mangle
808 // void foo(A::X<A::Y>, A::X<B::Y>),
809 // the A::X<> part is not aliased.
Nico Weber73f05842019-06-01 10:12:07 +0000810 // That is, from the mangler's perspective we have a structure like this:
Guy Benyei11169dd2012-12-18 14:30:41 +0000811 // namespace[s] -> type[ -> template-parameters]
812 // but from the Clang perspective we have
813 // type [ -> template-parameters]
814 // \-> namespace[s]
815 // What we do is we create a new mangler, mangle the same type (without
Fangrui Song6907ce22018-07-30 19:24:48 +0000816 // a namespace suffix) to a string using the extra mangler and then use
David Majnemerc986fcc2014-06-08 04:51:13 +0000817 // the mangled type name as a key to check the mangling of different types
818 // for aliasing.
Guy Benyei11169dd2012-12-18 14:30:41 +0000819
Nico Weber73f05842019-06-01 10:12:07 +0000820 // It's important to key cache reads off ND, not TD -- the same TD can
821 // be used with different TemplateArgs, but ND uniquely identifies
822 // TD / TemplateArg pairs.
823 ArgBackRefMap::iterator Found = TemplateArgBackReferences.find(ND);
824 if (Found == TemplateArgBackReferences.end()) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000825
Nico Weber48707762019-06-04 23:27:40 +0000826 TemplateArgStringMap::iterator Found = TemplateArgStrings.find(ND);
827 if (Found == TemplateArgStrings.end()) {
828 // Mangle full template name into temporary buffer.
829 llvm::SmallString<64> TemplateMangling;
830 llvm::raw_svector_ostream Stream(TemplateMangling);
831 MicrosoftCXXNameMangler Extra(Context, Stream);
832 Extra.mangleTemplateInstantiationName(TD, *TemplateArgs);
Nico Weber73f05842019-06-01 10:12:07 +0000833
Nico Weber48707762019-06-04 23:27:40 +0000834 // Use the string backref vector to possibly get a back reference.
835 mangleSourceName(TemplateMangling);
836
837 // Memoize back reference for this type if one exist, else memoize
838 // the mangling itself.
839 BackRefVec::iterator StringFound =
840 llvm::find(NameBackReferences, TemplateMangling);
841 if (StringFound != NameBackReferences.end()) {
842 TemplateArgBackReferences[ND] =
843 StringFound - NameBackReferences.begin();
844 } else {
845 TemplateArgStrings[ND] =
846 TemplateArgStringStorage.save(TemplateMangling.str());
847 }
848 } else {
Nico Weberb9571372019-10-11 12:27:51 +0000849 Out << Found->second << '@'; // Outputs a StringRef.
Nico Weber73f05842019-06-01 10:12:07 +0000850 }
851 } else {
Nico Weber48707762019-06-04 23:27:40 +0000852 Out << Found->second; // Outputs a back reference (an int).
Nico Weber73f05842019-06-01 10:12:07 +0000853 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000854 return;
855 }
856
857 switch (Name.getNameKind()) {
858 case DeclarationName::Identifier: {
859 if (const IdentifierInfo *II = Name.getAsIdentifierInfo()) {
David Majnemer956bc112013-11-25 17:50:19 +0000860 mangleSourceName(II->getName());
Guy Benyei11169dd2012-12-18 14:30:41 +0000861 break;
862 }
David Majnemerb4119f72013-12-13 01:06:04 +0000863
Guy Benyei11169dd2012-12-18 14:30:41 +0000864 // Otherwise, an anonymous entity. We must have a declaration.
865 assert(ND && "mangling empty name without declaration");
David Majnemerb4119f72013-12-13 01:06:04 +0000866
Guy Benyei11169dd2012-12-18 14:30:41 +0000867 if (const NamespaceDecl *NS = dyn_cast<NamespaceDecl>(ND)) {
868 if (NS->isAnonymousNamespace()) {
Reid Klecknerdf8dd612018-08-17 20:59:27 +0000869 Out << "?A0x" << Context.getAnonymousNamespaceHash() << '@';
Guy Benyei11169dd2012-12-18 14:30:41 +0000870 break;
871 }
872 }
David Majnemerb4119f72013-12-13 01:06:04 +0000873
Richard Smithda383632016-08-15 01:33:41 +0000874 if (const DecompositionDecl *DD = dyn_cast<DecompositionDecl>(ND)) {
Nico Webera47dc842019-09-05 21:08:50 +0000875 // Decomposition declarations are considered anonymous, and get
876 // numbered with a $S prefix.
877 llvm::SmallString<64> Name("$S");
878 // Get a unique id for the anonymous struct.
879 Name += llvm::utostr(Context.getAnonymousStructId(DD) + 1);
Richard Smithda383632016-08-15 01:33:41 +0000880 mangleSourceName(Name);
881 break;
882 }
883
David Majnemer2206bf52014-03-05 08:57:59 +0000884 if (const VarDecl *VD = dyn_cast<VarDecl>(ND)) {
885 // We must have an anonymous union or struct declaration.
886 const CXXRecordDecl *RD = VD->getType()->getAsCXXRecordDecl();
887 assert(RD && "expected variable decl to have a record type");
888 // Anonymous types with no tag or typedef get the name of their
889 // declarator mangled in. If they have no declarator, number them with
890 // a $S prefix.
891 llvm::SmallString<64> Name("$S");
892 // Get a unique id for the anonymous struct.
893 Name += llvm::utostr(Context.getAnonymousStructId(RD) + 1);
894 mangleSourceName(Name.str());
895 break;
896 }
897
Guy Benyei11169dd2012-12-18 14:30:41 +0000898 // We must have an anonymous struct.
899 const TagDecl *TD = cast<TagDecl>(ND);
900 if (const TypedefNameDecl *D = TD->getTypedefNameForAnonDecl()) {
901 assert(TD->getDeclContext() == D->getDeclContext() &&
902 "Typedef should not be in another decl context!");
903 assert(D->getDeclName().getAsIdentifierInfo() &&
904 "Typedef was not named!");
David Majnemer956bc112013-11-25 17:50:19 +0000905 mangleSourceName(D->getDeclName().getAsIdentifierInfo()->getName());
Guy Benyei11169dd2012-12-18 14:30:41 +0000906 break;
907 }
908
David Majnemerf017ec32014-03-05 10:35:06 +0000909 if (const CXXRecordDecl *Record = dyn_cast<CXXRecordDecl>(TD)) {
910 if (Record->isLambda()) {
911 llvm::SmallString<10> Name("<lambda_");
David Majnemer984498f2016-12-06 17:01:02 +0000912
913 Decl *LambdaContextDecl = Record->getLambdaContextDecl();
914 unsigned LambdaManglingNumber = Record->getLambdaManglingNumber();
David Majnemerf017ec32014-03-05 10:35:06 +0000915 unsigned LambdaId;
David Majnemer984498f2016-12-06 17:01:02 +0000916 const ParmVarDecl *Parm =
917 dyn_cast_or_null<ParmVarDecl>(LambdaContextDecl);
918 const FunctionDecl *Func =
919 Parm ? dyn_cast<FunctionDecl>(Parm->getDeclContext()) : nullptr;
920
921 if (Func) {
922 unsigned DefaultArgNo =
923 Func->getNumParams() - Parm->getFunctionScopeIndex();
924 Name += llvm::utostr(DefaultArgNo);
925 Name += "_";
926 }
927
928 if (LambdaManglingNumber)
929 LambdaId = LambdaManglingNumber;
David Majnemerf017ec32014-03-05 10:35:06 +0000930 else
931 LambdaId = Context.getLambdaId(Record);
932
933 Name += llvm::utostr(LambdaId);
934 Name += ">";
935
936 mangleSourceName(Name);
David Majnemer984498f2016-12-06 17:01:02 +0000937
938 // If the context of a closure type is an initializer for a class
939 // member (static or nonstatic), it is encoded in a qualified name.
940 if (LambdaManglingNumber && LambdaContextDecl) {
941 if ((isa<VarDecl>(LambdaContextDecl) ||
942 isa<FieldDecl>(LambdaContextDecl)) &&
943 LambdaContextDecl->getDeclContext()->isRecord()) {
944 mangleUnqualifiedName(cast<NamedDecl>(LambdaContextDecl));
945 }
946 }
David Majnemerf017ec32014-03-05 10:35:06 +0000947 break;
948 }
949 }
950
David Majnemera5cfddc2016-12-25 05:26:02 +0000951 llvm::SmallString<64> Name;
David Majnemer00350522015-08-31 18:48:39 +0000952 if (DeclaratorDecl *DD =
953 Context.getASTContext().getDeclaratorForUnnamedTagDecl(TD)) {
954 // Anonymous types without a name for linkage purposes have their
David Majnemer2206bf52014-03-05 08:57:59 +0000955 // declarator mangled in if they have one.
David Majnemera5cfddc2016-12-25 05:26:02 +0000956 Name += "<unnamed-type-";
David Majnemer00350522015-08-31 18:48:39 +0000957 Name += DD->getName();
958 } else if (TypedefNameDecl *TND =
959 Context.getASTContext().getTypedefNameForUnnamedTagDecl(
960 TD)) {
961 // Anonymous types without a name for linkage purposes have their
962 // associate typedef mangled in if they have one.
David Majnemera5cfddc2016-12-25 05:26:02 +0000963 Name += "<unnamed-type-";
David Majnemer00350522015-08-31 18:48:39 +0000964 Name += TND->getName();
Hans Wennborg4cae35f2018-06-11 06:54:23 +0000965 } else if (isa<EnumDecl>(TD) &&
966 cast<EnumDecl>(TD)->enumerator_begin() !=
967 cast<EnumDecl>(TD)->enumerator_end()) {
968 // Anonymous non-empty enums mangle in the first enumerator.
969 auto *ED = cast<EnumDecl>(TD);
David Majnemera5cfddc2016-12-25 05:26:02 +0000970 Name += "<unnamed-enum-";
Hans Wennborg4cae35f2018-06-11 06:54:23 +0000971 Name += ED->enumerator_begin()->getName();
David Majnemer956bc112013-11-25 17:50:19 +0000972 } else {
David Majnemer2206bf52014-03-05 08:57:59 +0000973 // Otherwise, number the types using a $S prefix.
David Majnemera5cfddc2016-12-25 05:26:02 +0000974 Name += "<unnamed-type-$S";
David Majnemeree6c4092015-10-22 07:15:56 +0000975 Name += llvm::utostr(Context.getAnonymousStructId(TD) + 1);
David Majnemer956bc112013-11-25 17:50:19 +0000976 }
David Majnemer2206bf52014-03-05 08:57:59 +0000977 Name += ">";
978 mangleSourceName(Name.str());
Guy Benyei11169dd2012-12-18 14:30:41 +0000979 break;
980 }
David Majnemerb4119f72013-12-13 01:06:04 +0000981
Guy Benyei11169dd2012-12-18 14:30:41 +0000982 case DeclarationName::ObjCZeroArgSelector:
983 case DeclarationName::ObjCOneArgSelector:
David Chisnall060a7892018-08-14 10:04:36 +0000984 case DeclarationName::ObjCMultiArgSelector: {
985 // This is reachable only when constructing an outlined SEH finally
986 // block. Nothing depends on this mangling and it's used only with
987 // functinos with internal linkage.
988 llvm::SmallString<64> Name;
989 mangleSourceName(Name.str());
990 break;
991 }
David Majnemerb4119f72013-12-13 01:06:04 +0000992
Guy Benyei11169dd2012-12-18 14:30:41 +0000993 case DeclarationName::CXXConstructorName:
Reid Klecknere4bb54a2017-01-09 17:09:59 +0000994 if (isStructorDecl(ND)) {
David Majnemerdfa6d202015-03-11 18:36:39 +0000995 if (StructorType == Ctor_CopyingClosure) {
996 Out << "?_O";
997 return;
998 }
999 if (StructorType == Ctor_DefaultClosure) {
1000 Out << "?_F";
1001 return;
1002 }
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +00001003 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001004 Out << "?0";
David Majnemerdfa6d202015-03-11 18:36:39 +00001005 return;
David Majnemerb4119f72013-12-13 01:06:04 +00001006
Guy Benyei11169dd2012-12-18 14:30:41 +00001007 case DeclarationName::CXXDestructorName:
Reid Kleckner290feb92017-01-09 17:04:37 +00001008 if (isStructorDecl(ND))
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001009 // If the named decl is the C++ destructor we're mangling,
1010 // use the type we were given.
1011 mangleCXXDtorType(static_cast<CXXDtorType>(StructorType));
1012 else
Reid Klecknere7de47e2013-07-22 13:51:44 +00001013 // Otherwise, use the base destructor name. This is relevant if a
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001014 // class with a destructor is declared within a destructor.
Reid Klecknere7de47e2013-07-22 13:51:44 +00001015 mangleCXXDtorType(Dtor_Base);
Guy Benyei11169dd2012-12-18 14:30:41 +00001016 break;
David Majnemerb4119f72013-12-13 01:06:04 +00001017
Guy Benyei11169dd2012-12-18 14:30:41 +00001018 case DeclarationName::CXXConversionFunctionName:
1019 // <operator-name> ::= ?B # (cast)
1020 // The target type is encoded as the return type.
1021 Out << "?B";
1022 break;
David Majnemerb4119f72013-12-13 01:06:04 +00001023
Guy Benyei11169dd2012-12-18 14:30:41 +00001024 case DeclarationName::CXXOperatorName:
1025 mangleOperatorName(Name.getCXXOverloadedOperator(), ND->getLocation());
1026 break;
David Majnemerb4119f72013-12-13 01:06:04 +00001027
Guy Benyei11169dd2012-12-18 14:30:41 +00001028 case DeclarationName::CXXLiteralOperatorName: {
David Majnemere31a3ed2014-06-04 16:46:26 +00001029 Out << "?__K";
1030 mangleSourceName(Name.getCXXLiteralIdentifier()->getName());
Guy Benyei11169dd2012-12-18 14:30:41 +00001031 break;
1032 }
David Majnemerb4119f72013-12-13 01:06:04 +00001033
Richard Smith35845152017-02-07 01:37:30 +00001034 case DeclarationName::CXXDeductionGuideName:
1035 llvm_unreachable("Can't mangle a deduction guide name!");
1036
Guy Benyei11169dd2012-12-18 14:30:41 +00001037 case DeclarationName::CXXUsingDirective:
1038 llvm_unreachable("Can't mangle a using directive name!");
1039 }
1040}
1041
Saleem Abdulrasool58340522018-02-07 01:55:08 +00001042// <postfix> ::= <unqualified-name> [<postfix>]
1043// ::= <substitution> [<postfix>]
David Majnemer2206bf52014-03-05 08:57:59 +00001044void MicrosoftCXXNameMangler::mangleNestedName(const NamedDecl *ND) {
David Majnemerff9075f2014-08-06 03:12:47 +00001045 const DeclContext *DC = getEffectiveDeclContext(ND);
David Majnemer2206bf52014-03-05 08:57:59 +00001046 while (!DC->isTranslationUnit()) {
1047 if (isa<TagDecl>(ND) || isa<VarDecl>(ND)) {
1048 unsigned Disc;
1049 if (Context.getNextDiscriminator(ND, Disc)) {
1050 Out << '?';
1051 mangleNumber(Disc);
1052 Out << '?';
1053 }
1054 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001055
David Majnemer2206bf52014-03-05 08:57:59 +00001056 if (const BlockDecl *BD = dyn_cast<BlockDecl>(DC)) {
Saleem Abdulrasool3cc6d0b2017-06-26 23:28:42 +00001057 auto Discriminate =
1058 [](StringRef Name, const unsigned Discriminator,
1059 const unsigned ParameterDiscriminator) -> std::string {
1060 std::string Buffer;
1061 llvm::raw_string_ostream Stream(Buffer);
1062 Stream << Name;
1063 if (Discriminator)
1064 Stream << '_' << Discriminator;
1065 if (ParameterDiscriminator)
1066 Stream << '_' << ParameterDiscriminator;
1067 return Stream.str();
1068 };
David Majnemer2206bf52014-03-05 08:57:59 +00001069
Saleem Abdulrasool3cc6d0b2017-06-26 23:28:42 +00001070 unsigned Discriminator = BD->getBlockManglingNumber();
1071 if (!Discriminator)
1072 Discriminator = Context.getBlockId(BD, /*Local=*/false);
1073
1074 // Mangle the parameter position as a discriminator to deal with unnamed
1075 // parameters. Rather than mangling the unqualified parameter name,
1076 // always use the position to give a uniform mangling.
1077 unsigned ParameterDiscriminator = 0;
1078 if (const auto *MC = BD->getBlockManglingContextDecl())
1079 if (const auto *P = dyn_cast<ParmVarDecl>(MC))
1080 if (const auto *F = dyn_cast<FunctionDecl>(P->getDeclContext()))
1081 ParameterDiscriminator =
1082 F->getNumParams() - P->getFunctionScopeIndex();
1083
1084 DC = getEffectiveDeclContext(BD);
1085
1086 Out << '?';
1087 mangleSourceName(Discriminate("_block_invoke", Discriminator,
1088 ParameterDiscriminator));
1089 // If we have a block mangling context, encode that now. This allows us
1090 // to discriminate between named static data initializers in the same
1091 // scope. This is handled differently from parameters, which use
1092 // positions to discriminate between multiple instances.
1093 if (const auto *MC = BD->getBlockManglingContextDecl())
1094 if (!isa<ParmVarDecl>(MC))
1095 if (const auto *ND = dyn_cast<NamedDecl>(MC))
1096 mangleUnqualifiedName(ND);
1097 // MS ABI and Itanium manglings are in inverted scopes. In the case of a
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00001098 // RecordDecl, mangle the entire scope hierarchy at this point rather than
Saleem Abdulrasool3cc6d0b2017-06-26 23:28:42 +00001099 // just the unqualified name to get the ordering correct.
1100 if (const auto *RD = dyn_cast<RecordDecl>(DC))
1101 mangleName(RD);
1102 else
1103 Out << '@';
1104 // void __cdecl
1105 Out << "YAX";
1106 // struct __block_literal *
1107 Out << 'P';
1108 // __ptr64
1109 if (PointersAre64Bit)
1110 Out << 'E';
1111 Out << 'A';
Shoaib Meenaid84cf132018-11-14 19:16:22 +00001112 mangleArtificialTagType(TTK_Struct,
Saleem Abdulrasool3cc6d0b2017-06-26 23:28:42 +00001113 Discriminate("__block_literal", Discriminator,
1114 ParameterDiscriminator));
1115 Out << "@Z";
1116
1117 // If the effective context was a Record, we have fully mangled the
1118 // qualified name and do not need to continue.
1119 if (isa<RecordDecl>(DC))
1120 break;
1121 continue;
David Majnemer2206bf52014-03-05 08:57:59 +00001122 } else if (const ObjCMethodDecl *Method = dyn_cast<ObjCMethodDecl>(DC)) {
1123 mangleObjCMethodName(Method);
1124 } else if (isa<NamedDecl>(DC)) {
1125 ND = cast<NamedDecl>(DC);
1126 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)) {
1127 mangle(FD, "?");
1128 break;
David Majnemer984498f2016-12-06 17:01:02 +00001129 } else {
David Majnemer2206bf52014-03-05 08:57:59 +00001130 mangleUnqualifiedName(ND);
David Majnemer984498f2016-12-06 17:01:02 +00001131 // Lambdas in default arguments conceptually belong to the function the
1132 // parameter corresponds to.
1133 if (const auto *LDADC = getLambdaDefaultArgumentDeclContext(ND)) {
1134 DC = LDADC;
1135 continue;
1136 }
1137 }
David Majnemer2206bf52014-03-05 08:57:59 +00001138 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001139 DC = DC->getParent();
Guy Benyei11169dd2012-12-18 14:30:41 +00001140 }
1141}
1142
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001143void MicrosoftCXXNameMangler::mangleCXXDtorType(CXXDtorType T) {
Reid Klecknere7de47e2013-07-22 13:51:44 +00001144 // Microsoft uses the names on the case labels for these dtor variants. Clang
1145 // uses the Itanium terminology internally. Everything in this ABI delegates
1146 // towards the base dtor.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001147 switch (T) {
Reid Klecknere7de47e2013-07-22 13:51:44 +00001148 // <operator-name> ::= ?1 # destructor
1149 case Dtor_Base: Out << "?1"; return;
1150 // <operator-name> ::= ?_D # vbase destructor
1151 case Dtor_Complete: Out << "?_D"; return;
1152 // <operator-name> ::= ?_G # scalar deleting destructor
1153 case Dtor_Deleting: Out << "?_G"; return;
1154 // <operator-name> ::= ?_E # vector deleting destructor
1155 // FIXME: Add a vector deleting dtor type. It goes in the vtable, so we need
1156 // it.
Rafael Espindola1e4df922014-09-16 15:18:21 +00001157 case Dtor_Comdat:
1158 llvm_unreachable("not expecting a COMDAT");
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001159 }
1160 llvm_unreachable("Unsupported dtor type?");
1161}
1162
Guy Benyei11169dd2012-12-18 14:30:41 +00001163void MicrosoftCXXNameMangler::mangleOperatorName(OverloadedOperatorKind OO,
1164 SourceLocation Loc) {
1165 switch (OO) {
1166 // ?0 # constructor
1167 // ?1 # destructor
1168 // <operator-name> ::= ?2 # new
1169 case OO_New: Out << "?2"; break;
1170 // <operator-name> ::= ?3 # delete
1171 case OO_Delete: Out << "?3"; break;
1172 // <operator-name> ::= ?4 # =
1173 case OO_Equal: Out << "?4"; break;
1174 // <operator-name> ::= ?5 # >>
1175 case OO_GreaterGreater: Out << "?5"; break;
1176 // <operator-name> ::= ?6 # <<
1177 case OO_LessLess: Out << "?6"; break;
1178 // <operator-name> ::= ?7 # !
1179 case OO_Exclaim: Out << "?7"; break;
1180 // <operator-name> ::= ?8 # ==
1181 case OO_EqualEqual: Out << "?8"; break;
1182 // <operator-name> ::= ?9 # !=
1183 case OO_ExclaimEqual: Out << "?9"; break;
1184 // <operator-name> ::= ?A # []
1185 case OO_Subscript: Out << "?A"; break;
1186 // ?B # conversion
1187 // <operator-name> ::= ?C # ->
1188 case OO_Arrow: Out << "?C"; break;
1189 // <operator-name> ::= ?D # *
1190 case OO_Star: Out << "?D"; break;
1191 // <operator-name> ::= ?E # ++
1192 case OO_PlusPlus: Out << "?E"; break;
1193 // <operator-name> ::= ?F # --
1194 case OO_MinusMinus: Out << "?F"; break;
1195 // <operator-name> ::= ?G # -
1196 case OO_Minus: Out << "?G"; break;
1197 // <operator-name> ::= ?H # +
1198 case OO_Plus: Out << "?H"; break;
1199 // <operator-name> ::= ?I # &
1200 case OO_Amp: Out << "?I"; break;
1201 // <operator-name> ::= ?J # ->*
1202 case OO_ArrowStar: Out << "?J"; break;
1203 // <operator-name> ::= ?K # /
1204 case OO_Slash: Out << "?K"; break;
1205 // <operator-name> ::= ?L # %
1206 case OO_Percent: Out << "?L"; break;
1207 // <operator-name> ::= ?M # <
1208 case OO_Less: Out << "?M"; break;
1209 // <operator-name> ::= ?N # <=
1210 case OO_LessEqual: Out << "?N"; break;
1211 // <operator-name> ::= ?O # >
1212 case OO_Greater: Out << "?O"; break;
1213 // <operator-name> ::= ?P # >=
1214 case OO_GreaterEqual: Out << "?P"; break;
1215 // <operator-name> ::= ?Q # ,
1216 case OO_Comma: Out << "?Q"; break;
1217 // <operator-name> ::= ?R # ()
1218 case OO_Call: Out << "?R"; break;
1219 // <operator-name> ::= ?S # ~
1220 case OO_Tilde: Out << "?S"; break;
1221 // <operator-name> ::= ?T # ^
1222 case OO_Caret: Out << "?T"; break;
1223 // <operator-name> ::= ?U # |
1224 case OO_Pipe: Out << "?U"; break;
1225 // <operator-name> ::= ?V # &&
1226 case OO_AmpAmp: Out << "?V"; break;
1227 // <operator-name> ::= ?W # ||
1228 case OO_PipePipe: Out << "?W"; break;
1229 // <operator-name> ::= ?X # *=
1230 case OO_StarEqual: Out << "?X"; break;
1231 // <operator-name> ::= ?Y # +=
1232 case OO_PlusEqual: Out << "?Y"; break;
1233 // <operator-name> ::= ?Z # -=
1234 case OO_MinusEqual: Out << "?Z"; break;
1235 // <operator-name> ::= ?_0 # /=
1236 case OO_SlashEqual: Out << "?_0"; break;
1237 // <operator-name> ::= ?_1 # %=
1238 case OO_PercentEqual: Out << "?_1"; break;
1239 // <operator-name> ::= ?_2 # >>=
1240 case OO_GreaterGreaterEqual: Out << "?_2"; break;
1241 // <operator-name> ::= ?_3 # <<=
1242 case OO_LessLessEqual: Out << "?_3"; break;
1243 // <operator-name> ::= ?_4 # &=
1244 case OO_AmpEqual: Out << "?_4"; break;
1245 // <operator-name> ::= ?_5 # |=
1246 case OO_PipeEqual: Out << "?_5"; break;
1247 // <operator-name> ::= ?_6 # ^=
1248 case OO_CaretEqual: Out << "?_6"; break;
1249 // ?_7 # vftable
1250 // ?_8 # vbtable
1251 // ?_9 # vcall
1252 // ?_A # typeof
1253 // ?_B # local static guard
1254 // ?_C # string
1255 // ?_D # vbase destructor
1256 // ?_E # vector deleting destructor
1257 // ?_F # default constructor closure
1258 // ?_G # scalar deleting destructor
1259 // ?_H # vector constructor iterator
1260 // ?_I # vector destructor iterator
1261 // ?_J # vector vbase constructor iterator
1262 // ?_K # virtual displacement map
1263 // ?_L # eh vector constructor iterator
1264 // ?_M # eh vector destructor iterator
1265 // ?_N # eh vector vbase constructor iterator
1266 // ?_O # copy constructor closure
1267 // ?_P<name> # udt returning <name>
1268 // ?_Q # <unknown>
1269 // ?_R0 # RTTI Type Descriptor
1270 // ?_R1 # RTTI Base Class Descriptor at (a,b,c,d)
1271 // ?_R2 # RTTI Base Class Array
1272 // ?_R3 # RTTI Class Hierarchy Descriptor
1273 // ?_R4 # RTTI Complete Object Locator
1274 // ?_S # local vftable
1275 // ?_T # local vftable constructor closure
1276 // <operator-name> ::= ?_U # new[]
1277 case OO_Array_New: Out << "?_U"; break;
1278 // <operator-name> ::= ?_V # delete[]
1279 case OO_Array_Delete: Out << "?_V"; break;
Gor Nishanove2f51be2016-09-28 22:37:17 +00001280 // <operator-name> ::= ?__L # co_await
1281 case OO_Coawait: Out << "?__L"; break;
Nico Weber27df4092019-04-23 16:37:42 +00001282 // <operator-name> ::= ?__M # <=>
1283 case OO_Spaceship: Out << "?__M"; break;
Richard Smithd30b23d2017-12-01 02:13:10 +00001284
Guy Benyei11169dd2012-12-18 14:30:41 +00001285 case OO_Conditional: {
1286 DiagnosticsEngine &Diags = Context.getDiags();
1287 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
1288 "cannot mangle this conditional operator yet");
1289 Diags.Report(Loc, DiagID);
1290 break;
1291 }
David Majnemerb4119f72013-12-13 01:06:04 +00001292
Guy Benyei11169dd2012-12-18 14:30:41 +00001293 case OO_None:
1294 case NUM_OVERLOADED_OPERATORS:
1295 llvm_unreachable("Not an overloaded operator");
1296 }
1297}
1298
David Majnemer956bc112013-11-25 17:50:19 +00001299void MicrosoftCXXNameMangler::mangleSourceName(StringRef Name) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001300 // <source name> ::= <identifier> @
Fangrui Song75e74e02019-03-31 08:48:19 +00001301 BackRefVec::iterator Found = llvm::find(NameBackReferences, Name);
David Majnemerc986fcc2014-06-08 04:51:13 +00001302 if (Found == NameBackReferences.end()) {
David Majnemer0d0560c2014-09-25 19:43:56 +00001303 if (NameBackReferences.size() < 10)
1304 NameBackReferences.push_back(Name);
David Majnemer956bc112013-11-25 17:50:19 +00001305 Out << Name << '@';
Guy Benyei11169dd2012-12-18 14:30:41 +00001306 } else {
David Majnemer0d0560c2014-09-25 19:43:56 +00001307 Out << (Found - NameBackReferences.begin());
Guy Benyei11169dd2012-12-18 14:30:41 +00001308 }
1309}
1310
1311void MicrosoftCXXNameMangler::mangleObjCMethodName(const ObjCMethodDecl *MD) {
1312 Context.mangleObjCMethodName(MD, Out);
1313}
1314
Guy Benyei11169dd2012-12-18 14:30:41 +00001315void MicrosoftCXXNameMangler::mangleTemplateInstantiationName(
David Majnemer02e9af42014-04-23 05:16:51 +00001316 const TemplateDecl *TD, const TemplateArgumentList &TemplateArgs) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001317 // <template-name> ::= <unscoped-template-name> <template-args>
1318 // ::= <substitution>
1319 // Always start with the unqualified name.
1320
1321 // Templates have their own context for back references.
Nico Weber73f05842019-06-01 10:12:07 +00001322 ArgBackRefMap OuterFunArgsContext;
1323 ArgBackRefMap OuterTemplateArgsContext;
David Majnemer0d0560c2014-09-25 19:43:56 +00001324 BackRefVec OuterTemplateContext;
David Majnemer5f177622015-12-30 05:13:03 +00001325 PassObjectSizeArgsSet OuterPassObjectSizeArgs;
Guy Benyei11169dd2012-12-18 14:30:41 +00001326 NameBackReferences.swap(OuterTemplateContext);
Nico Weber73f05842019-06-01 10:12:07 +00001327 FunArgBackReferences.swap(OuterFunArgsContext);
1328 TemplateArgBackReferences.swap(OuterTemplateArgsContext);
David Majnemer5f177622015-12-30 05:13:03 +00001329 PassObjectSizeArgs.swap(OuterPassObjectSizeArgs);
Guy Benyei11169dd2012-12-18 14:30:41 +00001330
1331 mangleUnscopedTemplateName(TD);
Reid Kleckner52518862013-03-20 01:40:23 +00001332 mangleTemplateArgs(TD, TemplateArgs);
Guy Benyei11169dd2012-12-18 14:30:41 +00001333
1334 // Restore the previous back reference contexts.
1335 NameBackReferences.swap(OuterTemplateContext);
Nico Weber73f05842019-06-01 10:12:07 +00001336 FunArgBackReferences.swap(OuterFunArgsContext);
1337 TemplateArgBackReferences.swap(OuterTemplateArgsContext);
David Majnemer5f177622015-12-30 05:13:03 +00001338 PassObjectSizeArgs.swap(OuterPassObjectSizeArgs);
Guy Benyei11169dd2012-12-18 14:30:41 +00001339}
1340
1341void
1342MicrosoftCXXNameMangler::mangleUnscopedTemplateName(const TemplateDecl *TD) {
1343 // <unscoped-template-name> ::= ?$ <unqualified-name>
1344 Out << "?$";
1345 mangleUnqualifiedName(TD);
1346}
1347
David Majnemer02e9af42014-04-23 05:16:51 +00001348void MicrosoftCXXNameMangler::mangleIntegerLiteral(const llvm::APSInt &Value,
1349 bool IsBoolean) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001350 // <integer-literal> ::= $0 <number>
1351 Out << "$0";
1352 // Make sure booleans are encoded as 0/1.
1353 if (IsBoolean && Value.getBoolValue())
1354 mangleNumber(1);
Will Wilsone74c2812014-12-11 05:47:10 +00001355 else if (Value.isSigned())
David Majnemer2a816452013-12-09 10:44:32 +00001356 mangleNumber(Value.getSExtValue());
Will Wilsone74c2812014-12-11 05:47:10 +00001357 else
1358 mangleNumber(Value.getZExtValue());
Guy Benyei11169dd2012-12-18 14:30:41 +00001359}
1360
David Majnemer02e9af42014-04-23 05:16:51 +00001361void MicrosoftCXXNameMangler::mangleExpression(const Expr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001362 // See if this is a constant expression.
1363 llvm::APSInt Value;
1364 if (E->isIntegerConstantExpr(Value, Context.getASTContext())) {
1365 mangleIntegerLiteral(Value, E->getType()->isBooleanType());
1366 return;
1367 }
1368
Reid Klecknerb4848e72014-06-10 20:06:25 +00001369 // Look through no-op casts like template parameter substitutions.
1370 E = E->IgnoreParenNoopCasts(Context.getASTContext());
1371
Craig Topper36250ad2014-05-12 05:36:57 +00001372 const CXXUuidofExpr *UE = nullptr;
David Majnemer8eaab6f2013-08-13 06:32:20 +00001373 if (const UnaryOperator *UO = dyn_cast<UnaryOperator>(E)) {
1374 if (UO->getOpcode() == UO_AddrOf)
1375 UE = dyn_cast<CXXUuidofExpr>(UO->getSubExpr());
1376 } else
1377 UE = dyn_cast<CXXUuidofExpr>(E);
1378
1379 if (UE) {
David Majnemere9cab2f2013-08-13 09:17:25 +00001380 // If we had to peek through an address-of operator, treat this like we are
David Majnemer8eaab6f2013-08-13 06:32:20 +00001381 // dealing with a pointer type. Otherwise, treat it like a const reference.
1382 //
1383 // N.B. This matches up with the handling of TemplateArgument::Declaration
1384 // in mangleTemplateArg
1385 if (UE == E)
1386 Out << "$E?";
1387 else
1388 Out << "$1?";
David Majnemer3add70b2015-12-29 11:45:53 +00001389
1390 // This CXXUuidofExpr is mangled as-if it were actually a VarDecl from
1391 // const __s_GUID _GUID_{lower case UUID with underscores}
David Majnemer2041b462016-03-28 03:19:50 +00001392 StringRef Uuid = UE->getUuidStr();
David Majnemer3add70b2015-12-29 11:45:53 +00001393 std::string Name = "_GUID_" + Uuid.lower();
1394 std::replace(Name.begin(), Name.end(), '-', '_');
1395
1396 mangleSourceName(Name);
1397 // Terminate the whole name with an '@'.
1398 Out << '@';
1399 // It's a global variable.
1400 Out << '3';
1401 // It's a struct called __s_GUID.
Shoaib Meenaid84cf132018-11-14 19:16:22 +00001402 mangleArtificialTagType(TTK_Struct, "__s_GUID");
David Majnemer3add70b2015-12-29 11:45:53 +00001403 // It's const.
1404 Out << 'B';
David Majnemer8eaab6f2013-08-13 06:32:20 +00001405 return;
1406 }
1407
Guy Benyei11169dd2012-12-18 14:30:41 +00001408 // As bad as this diagnostic is, it's better than crashing.
1409 DiagnosticsEngine &Diags = Context.getDiags();
David Majnemer02e9af42014-04-23 05:16:51 +00001410 unsigned DiagID = Diags.getCustomDiagID(
1411 DiagnosticsEngine::Error, "cannot yet mangle expression type %0");
1412 Diags.Report(E->getExprLoc(), DiagID) << E->getStmtClassName()
1413 << E->getSourceRange();
Guy Benyei11169dd2012-12-18 14:30:41 +00001414}
1415
David Majnemer8265dec2014-03-30 16:30:54 +00001416void MicrosoftCXXNameMangler::mangleTemplateArgs(
1417 const TemplateDecl *TD, const TemplateArgumentList &TemplateArgs) {
Reid Kleckner11c6f612014-06-26 22:42:18 +00001418 // <template-args> ::= <template-arg>+
David Majnemer57fbc0c2014-08-05 22:43:45 +00001419 const TemplateParameterList *TPL = TD->getTemplateParameters();
1420 assert(TPL->size() == TemplateArgs.size() &&
1421 "size mismatch between args and parms!");
1422
Nico Webere2dd1572018-09-08 20:58:39 +00001423 for (size_t i = 0; i < TemplateArgs.size(); ++i) {
1424 const TemplateArgument &TA = TemplateArgs[i];
1425
1426 // Separate consecutive packs by $$Z.
1427 if (i > 0 && TA.getKind() == TemplateArgument::Pack &&
1428 TemplateArgs[i - 1].getKind() == TemplateArgument::Pack)
1429 Out << "$$Z";
1430
1431 mangleTemplateArg(TD, TA, TPL->getParam(i));
1432 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001433}
1434
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001435void MicrosoftCXXNameMangler::mangleTemplateArg(const TemplateDecl *TD,
David Majnemer57fbc0c2014-08-05 22:43:45 +00001436 const TemplateArgument &TA,
1437 const NamedDecl *Parm) {
Reid Kleckner96f8f932014-02-05 17:27:08 +00001438 // <template-arg> ::= <type>
1439 // ::= <integer-literal>
1440 // ::= <member-data-pointer>
1441 // ::= <member-function-pointer>
1442 // ::= $E? <name> <type-encoding>
1443 // ::= $1? <name> <type-encoding>
1444 // ::= $0A@
1445 // ::= <template-args>
1446
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001447 switch (TA.getKind()) {
1448 case TemplateArgument::Null:
1449 llvm_unreachable("Can't mangle null template arguments!");
David Majnemer08177c52013-08-27 08:21:25 +00001450 case TemplateArgument::TemplateExpansion:
1451 llvm_unreachable("Can't mangle template expansion arguments!");
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001452 case TemplateArgument::Type: {
1453 QualType T = TA.getAsType();
1454 mangleType(T, SourceRange(), QMM_Escape);
1455 break;
1456 }
David Majnemere8fdc062013-08-13 01:25:35 +00001457 case TemplateArgument::Declaration: {
George Burgess IV00f70bd2018-03-01 05:43:23 +00001458 const NamedDecl *ND = TA.getAsDecl();
David Majnemer1e378e42014-02-06 12:46:52 +00001459 if (isa<FieldDecl>(ND) || isa<IndirectFieldDecl>(ND)) {
Nico Weber2b5f3fd2018-08-01 11:56:20 +00001460 mangleMemberDataPointer(cast<CXXRecordDecl>(ND->getDeclContext())
1461 ->getMostRecentNonInjectedDecl(),
1462 cast<ValueDecl>(ND));
Reid Kleckner09b47d12014-02-05 18:59:38 +00001463 } else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)) {
Nick Lewycky1f529662014-02-05 23:53:29 +00001464 const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD);
David Majnemerab4b4a12015-05-18 00:05:25 +00001465 if (MD && MD->isInstance()) {
Nico Weber2b5f3fd2018-08-01 11:56:20 +00001466 mangleMemberFunctionPointer(
1467 MD->getParent()->getMostRecentNonInjectedDecl(), MD);
David Majnemerab4b4a12015-05-18 00:05:25 +00001468 } else {
1469 Out << "$1?";
1470 mangleName(FD);
1471 mangleFunctionEncoding(FD, /*ShouldMangle=*/true);
1472 }
Reid Kleckner09b47d12014-02-05 18:59:38 +00001473 } else {
David Blaikie952a9b12014-10-17 18:00:12 +00001474 mangle(ND, TA.getParamTypeForDecl()->isReferenceType() ? "$E?" : "$1?");
Reid Kleckner09b47d12014-02-05 18:59:38 +00001475 }
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001476 break;
David Majnemere8fdc062013-08-13 01:25:35 +00001477 }
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001478 case TemplateArgument::Integral:
1479 mangleIntegerLiteral(TA.getAsIntegral(),
1480 TA.getIntegralType()->isBooleanType());
1481 break;
Reid Kleckner96f8f932014-02-05 17:27:08 +00001482 case TemplateArgument::NullPtr: {
1483 QualType T = TA.getNullPtrType();
1484 if (const MemberPointerType *MPT = T->getAs<MemberPointerType>()) {
David Majnemer763584d2014-02-06 10:59:19 +00001485 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
David Majnemerf3027172015-12-01 19:13:51 +00001486 if (MPT->isMemberFunctionPointerType() &&
1487 !isa<FunctionTemplateDecl>(TD)) {
Craig Topper36250ad2014-05-12 05:36:57 +00001488 mangleMemberFunctionPointer(RD, nullptr);
David Majnemer19187872014-06-11 07:08:37 +00001489 return;
1490 }
1491 if (MPT->isMemberDataPointer()) {
David Majnemerf3027172015-12-01 19:13:51 +00001492 if (!isa<FunctionTemplateDecl>(TD)) {
David Majnemer10236682015-07-02 09:43:11 +00001493 mangleMemberDataPointer(RD, nullptr);
1494 return;
1495 }
1496 // nullptr data pointers are always represented with a single field
1497 // which is initialized with either 0 or -1. Why -1? Well, we need to
1498 // distinguish the case where the data member is at offset zero in the
1499 // record.
1500 // However, we are free to use 0 *if* we would use multiple fields for
1501 // non-nullptr member pointers.
1502 if (!RD->nullFieldOffsetIsZero()) {
1503 mangleIntegerLiteral(llvm::APSInt::get(-1), /*IsBoolean=*/false);
1504 return;
1505 }
David Majnemer19187872014-06-11 07:08:37 +00001506 }
Reid Kleckner96f8f932014-02-05 17:27:08 +00001507 }
David Majnemer10236682015-07-02 09:43:11 +00001508 mangleIntegerLiteral(llvm::APSInt::getUnsigned(0), /*IsBoolean=*/false);
David Majnemerae465ef2013-08-05 21:33:59 +00001509 break;
Reid Kleckner96f8f932014-02-05 17:27:08 +00001510 }
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001511 case TemplateArgument::Expression:
1512 mangleExpression(TA.getAsExpr());
1513 break;
David Majnemer06fa05a2014-06-04 16:46:32 +00001514 case TemplateArgument::Pack: {
Craig Topper00bbdcf2014-06-28 23:22:23 +00001515 ArrayRef<TemplateArgument> TemplateArgs = TA.getPackAsArray();
David Majnemer06fa05a2014-06-04 16:46:32 +00001516 if (TemplateArgs.empty()) {
David Majnemer57fbc0c2014-08-05 22:43:45 +00001517 if (isa<TemplateTypeParmDecl>(Parm) ||
1518 isa<TemplateTemplateParmDecl>(Parm))
David Majnemer4deaac72015-03-18 03:56:27 +00001519 // MSVC 2015 changed the mangling for empty expanded template packs,
1520 // use the old mangling for link compatibility for old versions.
David Majnemerb710a932015-05-11 03:57:49 +00001521 Out << (Context.getASTContext().getLangOpts().isCompatibleWithMSVC(
1522 LangOptions::MSVC2015)
David Majnemer4deaac72015-03-18 03:56:27 +00001523 ? "$$V"
1524 : "$$$V");
David Majnemer57fbc0c2014-08-05 22:43:45 +00001525 else if (isa<NonTypeTemplateParmDecl>(Parm))
1526 Out << "$S";
1527 else
1528 llvm_unreachable("unexpected template parameter decl!");
David Majnemer06fa05a2014-06-04 16:46:32 +00001529 } else {
1530 for (const TemplateArgument &PA : TemplateArgs)
David Majnemer57fbc0c2014-08-05 22:43:45 +00001531 mangleTemplateArg(TD, PA, Parm);
David Majnemer06fa05a2014-06-04 16:46:32 +00001532 }
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001533 break;
David Majnemer06fa05a2014-06-04 16:46:32 +00001534 }
David Majnemer8d5f9ab2014-07-30 08:20:03 +00001535 case TemplateArgument::Template: {
1536 const NamedDecl *ND =
1537 TA.getAsTemplate().getAsTemplateDecl()->getTemplatedDecl();
1538 if (const auto *TD = dyn_cast<TagDecl>(ND)) {
1539 mangleType(TD);
1540 } else if (isa<TypeAliasDecl>(ND)) {
David Majnemer9a3bc592014-08-19 07:29:03 +00001541 Out << "$$Y";
1542 mangleName(ND);
David Majnemer8d5f9ab2014-07-30 08:20:03 +00001543 } else {
1544 llvm_unreachable("unexpected template template NamedDecl!");
1545 }
David Majnemer0db0ca42013-08-05 22:26:46 +00001546 break;
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001547 }
David Majnemer8d5f9ab2014-07-30 08:20:03 +00001548 }
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001549}
1550
Saleem Abdulrasoolbbce34a2018-02-09 03:23:54 +00001551void MicrosoftCXXNameMangler::mangleObjCProtocol(const ObjCProtocolDecl *PD) {
1552 llvm::SmallString<64> TemplateMangling;
1553 llvm::raw_svector_ostream Stream(TemplateMangling);
1554 MicrosoftCXXNameMangler Extra(Context, Stream);
1555
1556 Stream << "?$";
1557 Extra.mangleSourceName("Protocol");
Shoaib Meenaid84cf132018-11-14 19:16:22 +00001558 Extra.mangleArtificialTagType(TTK_Struct, PD->getName());
Saleem Abdulrasoolbbce34a2018-02-09 03:23:54 +00001559
Shoaib Meenaid84cf132018-11-14 19:16:22 +00001560 mangleArtificialTagType(TTK_Struct, TemplateMangling, {"__ObjC"});
Saleem Abdulrasoolbbce34a2018-02-09 03:23:54 +00001561}
1562
1563void MicrosoftCXXNameMangler::mangleObjCLifetime(const QualType Type,
1564 Qualifiers Quals,
1565 SourceRange Range) {
1566 llvm::SmallString<64> TemplateMangling;
1567 llvm::raw_svector_ostream Stream(TemplateMangling);
1568 MicrosoftCXXNameMangler Extra(Context, Stream);
1569
1570 Stream << "?$";
1571 switch (Quals.getObjCLifetime()) {
1572 case Qualifiers::OCL_None:
1573 case Qualifiers::OCL_ExplicitNone:
1574 break;
1575 case Qualifiers::OCL_Autoreleasing:
1576 Extra.mangleSourceName("Autoreleasing");
1577 break;
1578 case Qualifiers::OCL_Strong:
1579 Extra.mangleSourceName("Strong");
1580 break;
1581 case Qualifiers::OCL_Weak:
1582 Extra.mangleSourceName("Weak");
1583 break;
1584 }
1585 Extra.manglePointerCVQualifiers(Quals);
1586 Extra.manglePointerExtQualifiers(Quals, Type);
1587 Extra.mangleType(Type, Range);
1588
Shoaib Meenaid84cf132018-11-14 19:16:22 +00001589 mangleArtificialTagType(TTK_Struct, TemplateMangling, {"__ObjC"});
Saleem Abdulrasoolbbce34a2018-02-09 03:23:54 +00001590}
1591
Saleem Abdulrasoolf3a981e2018-09-28 16:47:53 +00001592void MicrosoftCXXNameMangler::mangleObjCKindOfType(const ObjCObjectType *T,
1593 Qualifiers Quals,
1594 SourceRange Range) {
1595 llvm::SmallString<64> TemplateMangling;
1596 llvm::raw_svector_ostream Stream(TemplateMangling);
1597 MicrosoftCXXNameMangler Extra(Context, Stream);
1598
1599 Stream << "?$";
1600 Extra.mangleSourceName("KindOf");
1601 Extra.mangleType(QualType(T, 0)
1602 .stripObjCKindOfType(getASTContext())
1603 ->getAs<ObjCObjectType>(),
1604 Quals, Range);
1605
Shoaib Meenaid84cf132018-11-14 19:16:22 +00001606 mangleArtificialTagType(TTK_Struct, TemplateMangling, {"__ObjC"});
Saleem Abdulrasoolf3a981e2018-09-28 16:47:53 +00001607}
1608
Guy Benyei11169dd2012-12-18 14:30:41 +00001609void MicrosoftCXXNameMangler::mangleQualifiers(Qualifiers Quals,
1610 bool IsMember) {
1611 // <cvr-qualifiers> ::= [E] [F] [I] <base-cvr-qualifiers>
1612 // 'E' means __ptr64 (32-bit only); 'F' means __unaligned (32/64-bit only);
1613 // 'I' means __restrict (32/64-bit).
1614 // Note that the MSVC __restrict keyword isn't the same as the C99 restrict
1615 // keyword!
1616 // <base-cvr-qualifiers> ::= A # near
1617 // ::= B # near const
1618 // ::= C # near volatile
1619 // ::= D # near const volatile
1620 // ::= E # far (16-bit)
1621 // ::= F # far const (16-bit)
1622 // ::= G # far volatile (16-bit)
1623 // ::= H # far const volatile (16-bit)
1624 // ::= I # huge (16-bit)
1625 // ::= J # huge const (16-bit)
1626 // ::= K # huge volatile (16-bit)
1627 // ::= L # huge const volatile (16-bit)
1628 // ::= M <basis> # based
1629 // ::= N <basis> # based const
1630 // ::= O <basis> # based volatile
1631 // ::= P <basis> # based const volatile
1632 // ::= Q # near member
1633 // ::= R # near const member
1634 // ::= S # near volatile member
1635 // ::= T # near const volatile member
1636 // ::= U # far member (16-bit)
1637 // ::= V # far const member (16-bit)
1638 // ::= W # far volatile member (16-bit)
1639 // ::= X # far const volatile member (16-bit)
1640 // ::= Y # huge member (16-bit)
1641 // ::= Z # huge const member (16-bit)
1642 // ::= 0 # huge volatile member (16-bit)
1643 // ::= 1 # huge const volatile member (16-bit)
1644 // ::= 2 <basis> # based member
1645 // ::= 3 <basis> # based const member
1646 // ::= 4 <basis> # based volatile member
1647 // ::= 5 <basis> # based const volatile member
1648 // ::= 6 # near function (pointers only)
1649 // ::= 7 # far function (pointers only)
1650 // ::= 8 # near method (pointers only)
1651 // ::= 9 # far method (pointers only)
1652 // ::= _A <basis> # based function (pointers only)
1653 // ::= _B <basis> # based function (far?) (pointers only)
1654 // ::= _C <basis> # based method (pointers only)
1655 // ::= _D <basis> # based method (far?) (pointers only)
1656 // ::= _E # block (Clang)
1657 // <basis> ::= 0 # __based(void)
1658 // ::= 1 # __based(segment)?
1659 // ::= 2 <name> # __based(name)
1660 // ::= 3 # ?
1661 // ::= 4 # ?
1662 // ::= 5 # not really based
1663 bool HasConst = Quals.hasConst(),
1664 HasVolatile = Quals.hasVolatile();
David Majnemer89594f32013-08-05 22:43:06 +00001665
Guy Benyei11169dd2012-12-18 14:30:41 +00001666 if (!IsMember) {
1667 if (HasConst && HasVolatile) {
1668 Out << 'D';
1669 } else if (HasVolatile) {
1670 Out << 'C';
1671 } else if (HasConst) {
1672 Out << 'B';
1673 } else {
1674 Out << 'A';
1675 }
1676 } else {
1677 if (HasConst && HasVolatile) {
1678 Out << 'T';
1679 } else if (HasVolatile) {
1680 Out << 'S';
1681 } else if (HasConst) {
1682 Out << 'R';
1683 } else {
1684 Out << 'Q';
1685 }
1686 }
1687
1688 // FIXME: For now, just drop all extension qualifiers on the floor.
1689}
1690
David Majnemer8eec58f2014-02-18 14:20:10 +00001691void
David Majnemere3785bb2014-04-23 05:16:56 +00001692MicrosoftCXXNameMangler::mangleRefQualifier(RefQualifierKind RefQualifier) {
1693 // <ref-qualifier> ::= G # lvalue reference
1694 // ::= H # rvalue-reference
1695 switch (RefQualifier) {
1696 case RQ_None:
1697 break;
1698
1699 case RQ_LValue:
1700 Out << 'G';
1701 break;
1702
1703 case RQ_RValue:
1704 Out << 'H';
1705 break;
1706 }
1707}
1708
David Majnemer7a3ce0c2015-05-26 01:30:45 +00001709void MicrosoftCXXNameMangler::manglePointerExtQualifiers(Qualifiers Quals,
1710 QualType PointeeType) {
Amy Huanga85f5ef2019-10-24 16:34:25 -07001711 // Check if this is a default 64-bit pointer or has __ptr64 qualifier.
1712 bool is64Bit = PointeeType.isNull() ? PointersAre64Bit :
1713 is64BitPointer(PointeeType.getQualifiers());
1714 if (is64Bit && (PointeeType.isNull() || !PointeeType->isFunctionType()))
David Majnemer8eec58f2014-02-18 14:20:10 +00001715 Out << 'E';
1716
Saleem Abdulrasool26d9bdb2018-01-25 19:54:31 +00001717 if (Quals.hasRestrict())
David Majnemer8eec58f2014-02-18 14:20:10 +00001718 Out << 'I';
Andrey Bokhanko45d41322016-05-11 18:38:21 +00001719
Andrey Bokhanko67a41862016-05-26 10:06:01 +00001720 if (Quals.hasUnaligned() ||
1721 (!PointeeType.isNull() && PointeeType.getLocalQualifiers().hasUnaligned()))
Andrey Bokhanko45d41322016-05-11 18:38:21 +00001722 Out << 'F';
David Majnemer8eec58f2014-02-18 14:20:10 +00001723}
1724
1725void MicrosoftCXXNameMangler::manglePointerCVQualifiers(Qualifiers Quals) {
1726 // <pointer-cv-qualifiers> ::= P # no qualifiers
1727 // ::= Q # const
1728 // ::= R # volatile
1729 // ::= S # const volatile
Guy Benyei11169dd2012-12-18 14:30:41 +00001730 bool HasConst = Quals.hasConst(),
David Majnemer8eec58f2014-02-18 14:20:10 +00001731 HasVolatile = Quals.hasVolatile();
David Majnemer0b6bf8a2014-02-18 12:58:35 +00001732
Guy Benyei11169dd2012-12-18 14:30:41 +00001733 if (HasConst && HasVolatile) {
1734 Out << 'S';
1735 } else if (HasVolatile) {
1736 Out << 'R';
1737 } else if (HasConst) {
1738 Out << 'Q';
1739 } else {
1740 Out << 'P';
1741 }
1742}
1743
Nico Weber73f05842019-06-01 10:12:07 +00001744void MicrosoftCXXNameMangler::mangleFunctionArgumentType(QualType T,
1745 SourceRange Range) {
Reid Kleckner18da98e2013-06-24 19:21:52 +00001746 // MSVC will backreference two canonically equivalent types that have slightly
1747 // different manglings when mangled alone.
David Majnemer5a1b2042013-09-11 04:44:30 +00001748
1749 // Decayed types do not match up with non-decayed versions of the same type.
1750 //
1751 // e.g.
1752 // void (*x)(void) will not form a backreference with void x(void)
1753 void *TypePtr;
David Majnemer96183f62015-04-23 05:21:20 +00001754 if (const auto *DT = T->getAs<DecayedType>()) {
1755 QualType OriginalType = DT->getOriginalType();
David Majnemerbdc1fed2015-04-27 03:07:47 +00001756 // All decayed ArrayTypes should be treated identically; as-if they were
1757 // a decayed IncompleteArrayType.
1758 if (const auto *AT = getASTContext().getAsArrayType(OriginalType))
David Majnemer96183f62015-04-23 05:21:20 +00001759 OriginalType = getASTContext().getIncompleteArrayType(
David Majnemerbdc1fed2015-04-27 03:07:47 +00001760 AT->getElementType(), AT->getSizeModifier(),
1761 AT->getIndexTypeCVRQualifiers());
David Majnemer96183f62015-04-23 05:21:20 +00001762
1763 TypePtr = OriginalType.getCanonicalType().getAsOpaquePtr();
David Majnemer5a1b2042013-09-11 04:44:30 +00001764 // If the original parameter was textually written as an array,
1765 // instead treat the decayed parameter like it's const.
1766 //
1767 // e.g.
1768 // int [] -> int * const
David Majnemer96183f62015-04-23 05:21:20 +00001769 if (OriginalType->isArrayType())
David Majnemer5a1b2042013-09-11 04:44:30 +00001770 T = T.withConst();
David Majnemer96183f62015-04-23 05:21:20 +00001771 } else {
David Majnemer5a1b2042013-09-11 04:44:30 +00001772 TypePtr = T.getCanonicalType().getAsOpaquePtr();
David Majnemer96183f62015-04-23 05:21:20 +00001773 }
David Majnemer5a1b2042013-09-11 04:44:30 +00001774
Nico Weber73f05842019-06-01 10:12:07 +00001775 ArgBackRefMap::iterator Found = FunArgBackReferences.find(TypePtr);
Guy Benyei11169dd2012-12-18 14:30:41 +00001776
Nico Weber73f05842019-06-01 10:12:07 +00001777 if (Found == FunArgBackReferences.end()) {
Yaron Keren2155f802015-05-02 15:31:08 +00001778 size_t OutSizeBefore = Out.tell();
Guy Benyei11169dd2012-12-18 14:30:41 +00001779
David Majnemer5a1b2042013-09-11 04:44:30 +00001780 mangleType(T, Range, QMM_Drop);
Guy Benyei11169dd2012-12-18 14:30:41 +00001781
1782 // See if it's worth creating a back reference.
1783 // Only types longer than 1 character are considered
1784 // and only 10 back references slots are available:
Yaron Keren2155f802015-05-02 15:31:08 +00001785 bool LongerThanOneChar = (Out.tell() - OutSizeBefore > 1);
Nico Weber73f05842019-06-01 10:12:07 +00001786 if (LongerThanOneChar && FunArgBackReferences.size() < 10) {
1787 size_t Size = FunArgBackReferences.size();
1788 FunArgBackReferences[TypePtr] = Size;
Guy Benyei11169dd2012-12-18 14:30:41 +00001789 }
1790 } else {
1791 Out << Found->second;
1792 }
1793}
1794
David Majnemer5f177622015-12-30 05:13:03 +00001795void MicrosoftCXXNameMangler::manglePassObjectSizeArg(
1796 const PassObjectSizeAttr *POSA) {
1797 int Type = POSA->getType();
Erik Pilkington02d5fb12019-03-19 20:44:18 +00001798 bool Dynamic = POSA->isDynamic();
David Majnemer5f177622015-12-30 05:13:03 +00001799
Erik Pilkington02d5fb12019-03-19 20:44:18 +00001800 auto Iter = PassObjectSizeArgs.insert({Type, Dynamic}).first;
David Majnemer622abd12015-12-31 05:36:52 +00001801 auto *TypePtr = (const void *)&*Iter;
Nico Weber73f05842019-06-01 10:12:07 +00001802 ArgBackRefMap::iterator Found = FunArgBackReferences.find(TypePtr);
David Majnemer5f177622015-12-30 05:13:03 +00001803
Nico Weber73f05842019-06-01 10:12:07 +00001804 if (Found == FunArgBackReferences.end()) {
Erik Pilkington02d5fb12019-03-19 20:44:18 +00001805 std::string Name =
1806 Dynamic ? "__pass_dynamic_object_size" : "__pass_object_size";
1807 mangleArtificialTagType(TTK_Enum, Name + llvm::utostr(Type), {"__clang"});
David Majnemer5f177622015-12-30 05:13:03 +00001808
Nico Weber73f05842019-06-01 10:12:07 +00001809 if (FunArgBackReferences.size() < 10) {
1810 size_t Size = FunArgBackReferences.size();
1811 FunArgBackReferences[TypePtr] = Size;
David Majnemer5f177622015-12-30 05:13:03 +00001812 }
1813 } else {
1814 Out << Found->second;
1815 }
1816}
1817
Erich Keane24a0f042018-12-14 23:17:34 +00001818void MicrosoftCXXNameMangler::mangleAddressSpaceType(QualType T,
1819 Qualifiers Quals,
1820 SourceRange Range) {
1821 // Address space is mangled as an unqualified templated type in the __clang
1822 // namespace. The demangled version of this is:
1823 // In the case of a language specific address space:
1824 // __clang::struct _AS[language_addr_space]<Type>
1825 // where:
1826 // <language_addr_space> ::= <OpenCL-addrspace> | <CUDA-addrspace>
1827 // <OpenCL-addrspace> ::= "CL" [ "global" | "local" | "constant" |
1828 // "private"| "generic" ]
1829 // <CUDA-addrspace> ::= "CU" [ "device" | "constant" | "shared" ]
1830 // Note that the above were chosen to match the Itanium mangling for this.
1831 //
1832 // In the case of a non-language specific address space:
1833 // __clang::struct _AS<TargetAS, Type>
1834 assert(Quals.hasAddressSpace() && "Not valid without address space");
1835 llvm::SmallString<32> ASMangling;
1836 llvm::raw_svector_ostream Stream(ASMangling);
1837 MicrosoftCXXNameMangler Extra(Context, Stream);
1838 Stream << "?$";
1839
1840 LangAS AS = Quals.getAddressSpace();
1841 if (Context.getASTContext().addressSpaceMapManglingFor(AS)) {
1842 unsigned TargetAS = Context.getASTContext().getTargetAddressSpace(AS);
1843 Extra.mangleSourceName("_AS");
1844 Extra.mangleIntegerLiteral(llvm::APSInt::getUnsigned(TargetAS),
1845 /*IsBoolean*/ false);
1846 } else {
1847 switch (AS) {
1848 default:
1849 llvm_unreachable("Not a language specific address space");
1850 case LangAS::opencl_global:
1851 Extra.mangleSourceName("_ASCLglobal");
1852 break;
1853 case LangAS::opencl_local:
1854 Extra.mangleSourceName("_ASCLlocal");
1855 break;
1856 case LangAS::opencl_constant:
1857 Extra.mangleSourceName("_ASCLconstant");
1858 break;
1859 case LangAS::opencl_private:
1860 Extra.mangleSourceName("_ASCLprivate");
1861 break;
1862 case LangAS::opencl_generic:
1863 Extra.mangleSourceName("_ASCLgeneric");
1864 break;
1865 case LangAS::cuda_device:
1866 Extra.mangleSourceName("_ASCUdevice");
1867 break;
1868 case LangAS::cuda_constant:
1869 Extra.mangleSourceName("_ASCUconstant");
1870 break;
1871 case LangAS::cuda_shared:
1872 Extra.mangleSourceName("_ASCUshared");
1873 break;
Amy Huanga85f5ef2019-10-24 16:34:25 -07001874 case LangAS::ptr32_sptr:
1875 case LangAS::ptr32_uptr:
1876 case LangAS::ptr64:
1877 llvm_unreachable("don't mangle ptr address spaces with _AS");
Erich Keane24a0f042018-12-14 23:17:34 +00001878 }
1879 }
1880
1881 Extra.mangleType(T, Range, QMM_Escape);
1882 mangleQualifiers(Qualifiers(), false);
1883 mangleArtificialTagType(TTK_Struct, ASMangling, {"__clang"});
1884}
1885
Guy Benyei11169dd2012-12-18 14:30:41 +00001886void MicrosoftCXXNameMangler::mangleType(QualType T, SourceRange Range,
Peter Collingbourne2816c022013-04-25 04:25:40 +00001887 QualifierMangleMode QMM) {
Reid Kleckner18da98e2013-06-24 19:21:52 +00001888 // Don't use the canonical types. MSVC includes things like 'const' on
1889 // pointer arguments to function pointers that canonicalization strips away.
1890 T = T.getDesugaredType(getASTContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00001891 Qualifiers Quals = T.getLocalQualifiers();
Erich Keane24a0f042018-12-14 23:17:34 +00001892
Reid Kleckner18da98e2013-06-24 19:21:52 +00001893 if (const ArrayType *AT = getASTContext().getAsArrayType(T)) {
1894 // If there were any Quals, getAsArrayType() pushed them onto the array
1895 // element type.
Peter Collingbourne2816c022013-04-25 04:25:40 +00001896 if (QMM == QMM_Mangle)
1897 Out << 'A';
1898 else if (QMM == QMM_Escape || QMM == QMM_Result)
1899 Out << "$$B";
Reid Kleckner18da98e2013-06-24 19:21:52 +00001900 mangleArrayType(AT);
Peter Collingbourne2816c022013-04-25 04:25:40 +00001901 return;
1902 }
1903
1904 bool IsPointer = T->isAnyPointerType() || T->isMemberPointerType() ||
David Majnemer7a3ce0c2015-05-26 01:30:45 +00001905 T->isReferenceType() || T->isBlockPointerType();
Peter Collingbourne2816c022013-04-25 04:25:40 +00001906
1907 switch (QMM) {
1908 case QMM_Drop:
Saleem Abdulrasoolbbce34a2018-02-09 03:23:54 +00001909 if (Quals.hasObjCLifetime())
1910 Quals = Quals.withoutObjCLifetime();
Peter Collingbourne2816c022013-04-25 04:25:40 +00001911 break;
1912 case QMM_Mangle:
1913 if (const FunctionType *FT = dyn_cast<FunctionType>(T)) {
1914 Out << '6';
Timur Iskhodzhanov555a7722013-10-04 11:25:05 +00001915 mangleFunctionType(FT);
Peter Collingbourne2816c022013-04-25 04:25:40 +00001916 return;
1917 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001918 mangleQualifiers(Quals, false);
Peter Collingbourne2816c022013-04-25 04:25:40 +00001919 break;
1920 case QMM_Escape:
1921 if (!IsPointer && Quals) {
1922 Out << "$$C";
1923 mangleQualifiers(Quals, false);
1924 }
1925 break;
1926 case QMM_Result:
Andrey Bokhanko45d41322016-05-11 18:38:21 +00001927 // Presence of __unaligned qualifier shouldn't affect mangling here.
1928 Quals.removeUnaligned();
Saleem Abdulrasoolbbce34a2018-02-09 03:23:54 +00001929 if (Quals.hasObjCLifetime())
1930 Quals = Quals.withoutObjCLifetime();
Nico Weber3239f132018-07-23 20:04:00 +00001931 if ((!IsPointer && Quals) || isa<TagType>(T) || isArtificialTagType(T)) {
Peter Collingbourne2816c022013-04-25 04:25:40 +00001932 Out << '?';
1933 mangleQualifiers(Quals, false);
1934 }
1935 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00001936 }
1937
Peter Collingbourne2816c022013-04-25 04:25:40 +00001938 const Type *ty = T.getTypePtr();
Guy Benyei11169dd2012-12-18 14:30:41 +00001939
1940 switch (ty->getTypeClass()) {
1941#define ABSTRACT_TYPE(CLASS, PARENT)
1942#define NON_CANONICAL_TYPE(CLASS, PARENT) \
1943 case Type::CLASS: \
1944 llvm_unreachable("can't mangle non-canonical type " #CLASS "Type"); \
1945 return;
1946#define TYPE(CLASS, PARENT) \
1947 case Type::CLASS: \
David Majnemer7a3ce0c2015-05-26 01:30:45 +00001948 mangleType(cast<CLASS##Type>(ty), Quals, Range); \
Guy Benyei11169dd2012-12-18 14:30:41 +00001949 break;
John McCall36b12a82019-10-02 06:35:23 +00001950#include "clang/AST/TypeNodes.inc"
Guy Benyei11169dd2012-12-18 14:30:41 +00001951#undef ABSTRACT_TYPE
1952#undef NON_CANONICAL_TYPE
1953#undef TYPE
1954 }
1955}
1956
David Majnemer7a3ce0c2015-05-26 01:30:45 +00001957void MicrosoftCXXNameMangler::mangleType(const BuiltinType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00001958 SourceRange Range) {
1959 // <type> ::= <builtin-type>
1960 // <builtin-type> ::= X # void
1961 // ::= C # signed char
1962 // ::= D # char
1963 // ::= E # unsigned char
1964 // ::= F # short
1965 // ::= G # unsigned short (or wchar_t if it's not a builtin)
1966 // ::= H # int
1967 // ::= I # unsigned int
1968 // ::= J # long
1969 // ::= K # unsigned long
1970 // L # <none>
1971 // ::= M # float
1972 // ::= N # double
1973 // ::= O # long double (__float80 is mangled differently)
1974 // ::= _J # long long, __int64
1975 // ::= _K # unsigned long long, __int64
1976 // ::= _L # __int128
1977 // ::= _M # unsigned __int128
1978 // ::= _N # bool
1979 // _O # <array in parameter>
Richard Smith5178c6b2019-02-21 23:04:35 +00001980 // ::= _Q # char8_t
Reid Kleckner9e2584a2017-05-26 17:11:10 +00001981 // ::= _S # char16_t
Richard Smith5178c6b2019-02-21 23:04:35 +00001982 // ::= _T # __float80 (Intel)
Reid Kleckner9e2584a2017-05-26 17:11:10 +00001983 // ::= _U # char32_t
Guy Benyei11169dd2012-12-18 14:30:41 +00001984 // ::= _W # wchar_t
1985 // ::= _Z # __float80 (Digital Mars)
1986 switch (T->getKind()) {
Alexey Baderbdf7c842015-09-15 12:18:29 +00001987 case BuiltinType::Void:
1988 Out << 'X';
1989 break;
1990 case BuiltinType::SChar:
1991 Out << 'C';
1992 break;
1993 case BuiltinType::Char_U:
1994 case BuiltinType::Char_S:
1995 Out << 'D';
1996 break;
1997 case BuiltinType::UChar:
1998 Out << 'E';
1999 break;
2000 case BuiltinType::Short:
2001 Out << 'F';
2002 break;
2003 case BuiltinType::UShort:
2004 Out << 'G';
2005 break;
2006 case BuiltinType::Int:
2007 Out << 'H';
2008 break;
2009 case BuiltinType::UInt:
2010 Out << 'I';
2011 break;
2012 case BuiltinType::Long:
2013 Out << 'J';
2014 break;
2015 case BuiltinType::ULong:
2016 Out << 'K';
2017 break;
2018 case BuiltinType::Float:
2019 Out << 'M';
2020 break;
2021 case BuiltinType::Double:
2022 Out << 'N';
2023 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002024 // TODO: Determine size and mangle accordingly
Alexey Baderbdf7c842015-09-15 12:18:29 +00002025 case BuiltinType::LongDouble:
2026 Out << 'O';
2027 break;
2028 case BuiltinType::LongLong:
2029 Out << "_J";
2030 break;
2031 case BuiltinType::ULongLong:
2032 Out << "_K";
2033 break;
2034 case BuiltinType::Int128:
2035 Out << "_L";
2036 break;
2037 case BuiltinType::UInt128:
2038 Out << "_M";
2039 break;
2040 case BuiltinType::Bool:
2041 Out << "_N";
2042 break;
Richard Smith5178c6b2019-02-21 23:04:35 +00002043 case BuiltinType::Char8:
2044 Out << "_Q";
2045 break;
Alexey Baderbdf7c842015-09-15 12:18:29 +00002046 case BuiltinType::Char16:
2047 Out << "_S";
2048 break;
2049 case BuiltinType::Char32:
2050 Out << "_U";
2051 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002052 case BuiltinType::WChar_S:
Alexey Baderbdf7c842015-09-15 12:18:29 +00002053 case BuiltinType::WChar_U:
2054 Out << "_W";
2055 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002056
2057#define BUILTIN_TYPE(Id, SingletonId)
2058#define PLACEHOLDER_TYPE(Id, SingletonId) \
2059 case BuiltinType::Id:
2060#include "clang/AST/BuiltinTypes.def"
2061 case BuiltinType::Dependent:
2062 llvm_unreachable("placeholder types shouldn't get to name mangling");
2063
Alexey Baderbdf7c842015-09-15 12:18:29 +00002064 case BuiltinType::ObjCId:
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002065 mangleArtificialTagType(TTK_Struct, "objc_object");
Alexey Baderbdf7c842015-09-15 12:18:29 +00002066 break;
2067 case BuiltinType::ObjCClass:
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002068 mangleArtificialTagType(TTK_Struct, "objc_class");
Alexey Baderbdf7c842015-09-15 12:18:29 +00002069 break;
2070 case BuiltinType::ObjCSel:
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002071 mangleArtificialTagType(TTK_Struct, "objc_selector");
Alexey Baderbdf7c842015-09-15 12:18:29 +00002072 break;
Guy Benyeid8a08ea2012-12-18 14:38:23 +00002073
Alexey Bader954ba212016-04-08 13:40:33 +00002074#define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
2075 case BuiltinType::Id: \
2076 Out << "PAUocl_" #ImgType "_" #Suffix "@@"; \
Alexey Baderbdf7c842015-09-15 12:18:29 +00002077 break;
Alexey Baderb62f1442016-04-13 08:33:41 +00002078#include "clang/Basic/OpenCLImageTypes.def"
Alexey Baderbdf7c842015-09-15 12:18:29 +00002079 case BuiltinType::OCLSampler:
David Majnemer3add70b2015-12-29 11:45:53 +00002080 Out << "PA";
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002081 mangleArtificialTagType(TTK_Struct, "ocl_sampler");
Alexey Baderbdf7c842015-09-15 12:18:29 +00002082 break;
2083 case BuiltinType::OCLEvent:
David Majnemer3add70b2015-12-29 11:45:53 +00002084 Out << "PA";
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002085 mangleArtificialTagType(TTK_Struct, "ocl_event");
Alexey Baderbdf7c842015-09-15 12:18:29 +00002086 break;
Alexey Bader9c8453f2015-09-15 11:18:52 +00002087 case BuiltinType::OCLClkEvent:
David Majnemer3add70b2015-12-29 11:45:53 +00002088 Out << "PA";
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002089 mangleArtificialTagType(TTK_Struct, "ocl_clkevent");
Alexey Bader9c8453f2015-09-15 11:18:52 +00002090 break;
2091 case BuiltinType::OCLQueue:
David Majnemer3add70b2015-12-29 11:45:53 +00002092 Out << "PA";
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002093 mangleArtificialTagType(TTK_Struct, "ocl_queue");
Alexey Bader9c8453f2015-09-15 11:18:52 +00002094 break;
Alexey Bader9c8453f2015-09-15 11:18:52 +00002095 case BuiltinType::OCLReserveID:
David Majnemer3add70b2015-12-29 11:45:53 +00002096 Out << "PA";
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002097 mangleArtificialTagType(TTK_Struct, "ocl_reserveid");
Alexey Bader9c8453f2015-09-15 11:18:52 +00002098 break;
Andrew Savonichev3fee3512018-11-08 11:25:41 +00002099#define EXT_OPAQUE_TYPE(ExtType, Id, Ext) \
2100 case BuiltinType::Id: \
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002101 mangleArtificialTagType(TTK_Struct, "ocl_" #ExtType); \
Andrew Savonichev3fee3512018-11-08 11:25:41 +00002102 break;
2103#include "clang/Basic/OpenCLExtensionTypes.def"
David Majnemerb4119f72013-12-13 01:06:04 +00002104
Alexey Baderbdf7c842015-09-15 12:18:29 +00002105 case BuiltinType::NullPtr:
2106 Out << "$$T";
2107 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002108
Sjoerd Meijercc623ad2017-09-08 15:15:00 +00002109 case BuiltinType::Float16:
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002110 mangleArtificialTagType(TTK_Struct, "_Float16", {"__clang"});
Erich Keane5da1e692018-04-17 22:00:54 +00002111 break;
2112
Erich Keane14c10852018-05-01 14:16:15 +00002113 case BuiltinType::Half:
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002114 mangleArtificialTagType(TTK_Struct, "_Half", {"__clang"});
Erich Keane14c10852018-05-01 14:16:15 +00002115 break;
2116
Richard Sandifordeb485fb2019-08-09 08:52:54 +00002117#define SVE_TYPE(Name, Id, SingletonId) \
2118 case BuiltinType::Id:
2119#include "clang/Basic/AArch64SVEACLETypes.def"
Leonard Chanf921d852018-06-04 16:07:52 +00002120 case BuiltinType::ShortAccum:
2121 case BuiltinType::Accum:
2122 case BuiltinType::LongAccum:
2123 case BuiltinType::UShortAccum:
2124 case BuiltinType::UAccum:
2125 case BuiltinType::ULongAccum:
Leonard Chanab80f3c2018-06-14 14:53:51 +00002126 case BuiltinType::ShortFract:
2127 case BuiltinType::Fract:
2128 case BuiltinType::LongFract:
2129 case BuiltinType::UShortFract:
2130 case BuiltinType::UFract:
2131 case BuiltinType::ULongFract:
2132 case BuiltinType::SatShortAccum:
2133 case BuiltinType::SatAccum:
2134 case BuiltinType::SatLongAccum:
2135 case BuiltinType::SatUShortAccum:
2136 case BuiltinType::SatUAccum:
2137 case BuiltinType::SatULongAccum:
2138 case BuiltinType::SatShortFract:
2139 case BuiltinType::SatFract:
2140 case BuiltinType::SatLongFract:
2141 case BuiltinType::SatUShortFract:
2142 case BuiltinType::SatUFract:
2143 case BuiltinType::SatULongFract:
Erich Keane14c10852018-05-01 14:16:15 +00002144 case BuiltinType::Float128: {
Guy Benyei11169dd2012-12-18 14:30:41 +00002145 DiagnosticsEngine &Diags = Context.getDiags();
Alexey Baderbdf7c842015-09-15 12:18:29 +00002146 unsigned DiagID = Diags.getCustomDiagID(
2147 DiagnosticsEngine::Error, "cannot mangle this built-in %0 type yet");
Guy Benyei11169dd2012-12-18 14:30:41 +00002148 Diags.Report(Range.getBegin(), DiagID)
Alexey Baderbdf7c842015-09-15 12:18:29 +00002149 << T->getName(Context.getASTContext().getPrintingPolicy()) << Range;
Guy Benyei11169dd2012-12-18 14:30:41 +00002150 break;
2151 }
2152 }
2153}
2154
2155// <type> ::= <function-type>
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002156void MicrosoftCXXNameMangler::mangleType(const FunctionProtoType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002157 SourceRange) {
2158 // Structors only appear in decls, so at this point we know it's not a
2159 // structor type.
2160 // FIXME: This may not be lambda-friendly.
Anastasia Stulovac61eaa52019-01-28 11:37:49 +00002161 if (T->getMethodQuals() || T->getRefQualifier() != RQ_None) {
David Majnemer2f6a96e2014-08-12 17:53:10 +00002162 Out << "$$A8@@";
2163 mangleFunctionType(T, /*D=*/nullptr, /*ForceThisQuals=*/true);
2164 } else {
2165 Out << "$$A6";
2166 mangleFunctionType(T);
2167 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002168}
2169void MicrosoftCXXNameMangler::mangleType(const FunctionNoProtoType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002170 Qualifiers, SourceRange) {
Peter Collingbourneeeebc412015-08-07 23:25:47 +00002171 Out << "$$A6";
2172 mangleFunctionType(T);
Guy Benyei11169dd2012-12-18 14:30:41 +00002173}
2174
Peter Collingbourne2816c022013-04-25 04:25:40 +00002175void MicrosoftCXXNameMangler::mangleFunctionType(const FunctionType *T,
2176 const FunctionDecl *D,
Reid Klecknerd2f98772018-12-17 23:10:43 +00002177 bool ForceThisQuals,
2178 bool MangleExceptionSpec) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002179 // <function-type> ::= <this-cvr-qualifiers> <calling-convention>
2180 // <return-type> <argument-list> <throw-spec>
Peter Collingbourneeeebc412015-08-07 23:25:47 +00002181 const FunctionProtoType *Proto = dyn_cast<FunctionProtoType>(T);
Guy Benyei11169dd2012-12-18 14:30:41 +00002182
Reid Kleckner18da98e2013-06-24 19:21:52 +00002183 SourceRange Range;
2184 if (D) Range = D->getSourceRange();
2185
David Majnemer41311192016-01-17 07:09:24 +00002186 bool IsInLambda = false;
David Majnemerdfa6d202015-03-11 18:36:39 +00002187 bool IsStructor = false, HasThisQuals = ForceThisQuals, IsCtorClosure = false;
2188 CallingConv CC = T->getCallConv();
Timur Iskhodzhanov555a7722013-10-04 11:25:05 +00002189 if (const CXXMethodDecl *MD = dyn_cast_or_null<CXXMethodDecl>(D)) {
David Majnemer41311192016-01-17 07:09:24 +00002190 if (MD->getParent()->isLambda())
2191 IsInLambda = true;
Timur Iskhodzhanov555a7722013-10-04 11:25:05 +00002192 if (MD->isInstance())
David Majnemer2f6a96e2014-08-12 17:53:10 +00002193 HasThisQuals = true;
David Majnemerdfa6d202015-03-11 18:36:39 +00002194 if (isa<CXXDestructorDecl>(MD)) {
Timur Iskhodzhanov555a7722013-10-04 11:25:05 +00002195 IsStructor = true;
David Majnemerdfa6d202015-03-11 18:36:39 +00002196 } else if (isa<CXXConstructorDecl>(MD)) {
2197 IsStructor = true;
2198 IsCtorClosure = (StructorType == Ctor_CopyingClosure ||
2199 StructorType == Ctor_DefaultClosure) &&
Reid Kleckner290feb92017-01-09 17:04:37 +00002200 isStructorDecl(MD);
David Majnemerdfa6d202015-03-11 18:36:39 +00002201 if (IsCtorClosure)
2202 CC = getASTContext().getDefaultCallingConvention(
2203 /*IsVariadic=*/false, /*IsCXXMethod=*/true);
2204 }
Timur Iskhodzhanov555a7722013-10-04 11:25:05 +00002205 }
2206
Guy Benyei11169dd2012-12-18 14:30:41 +00002207 // If this is a C++ instance method, mangle the CVR qualifiers for the
2208 // this pointer.
David Majnemer2f6a96e2014-08-12 17:53:10 +00002209 if (HasThisQuals) {
Anastasia Stulovac61eaa52019-01-28 11:37:49 +00002210 Qualifiers Quals = Proto->getMethodQuals();
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002211 manglePointerExtQualifiers(Quals, /*PointeeType=*/QualType());
David Majnemere3785bb2014-04-23 05:16:56 +00002212 mangleRefQualifier(Proto->getRefQualifier());
David Majnemer2f6a96e2014-08-12 17:53:10 +00002213 mangleQualifiers(Quals, /*IsMember=*/false);
David Majnemer6dda7bb2013-08-15 08:13:23 +00002214 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002215
David Majnemerdfa6d202015-03-11 18:36:39 +00002216 mangleCallingConvention(CC);
Guy Benyei11169dd2012-12-18 14:30:41 +00002217
2218 // <return-type> ::= <type>
2219 // ::= @ # structors (they have no declared return type)
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002220 if (IsStructor) {
David Majnemerdc169752017-02-14 00:54:11 +00002221 if (isa<CXXDestructorDecl>(D) && isStructorDecl(D)) {
2222 // The scalar deleting destructor takes an extra int argument which is not
2223 // reflected in the AST.
2224 if (StructorType == Dtor_Deleting) {
2225 Out << (PointersAre64Bit ? "PEAXI@Z" : "PAXI@Z");
2226 return;
2227 }
2228 // The vbase destructor returns void which is not reflected in the AST.
2229 if (StructorType == Dtor_Complete) {
2230 Out << "XXZ";
2231 return;
2232 }
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002233 }
David Majnemerdfa6d202015-03-11 18:36:39 +00002234 if (IsCtorClosure) {
2235 // Default constructor closure and copy constructor closure both return
2236 // void.
2237 Out << 'X';
2238
2239 if (StructorType == Ctor_DefaultClosure) {
2240 // Default constructor closure always has no arguments.
2241 Out << 'X';
2242 } else if (StructorType == Ctor_CopyingClosure) {
2243 // Copy constructor closure always takes an unqualified reference.
Nico Weber73f05842019-06-01 10:12:07 +00002244 mangleFunctionArgumentType(getASTContext().getLValueReferenceType(
2245 Proto->getParamType(0)
2246 ->getAs<LValueReferenceType>()
2247 ->getPointeeType(),
2248 /*SpelledAsLValue=*/true),
2249 Range);
David Majnemer37fd66e2015-03-13 22:36:55 +00002250 Out << '@';
David Majnemerdfa6d202015-03-11 18:36:39 +00002251 } else {
2252 llvm_unreachable("unexpected constructor closure!");
2253 }
David Majnemer37fd66e2015-03-13 22:36:55 +00002254 Out << 'Z';
David Majnemerdfa6d202015-03-11 18:36:39 +00002255 return;
2256 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002257 Out << '@';
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002258 } else {
Peter Collingbourneeeebc412015-08-07 23:25:47 +00002259 QualType ResultType = T->getReturnType();
David Majnemer2e1e04912014-04-01 05:29:46 +00002260 if (const auto *AT =
2261 dyn_cast_or_null<AutoType>(ResultType->getContainedAutoType())) {
2262 Out << '?';
2263 mangleQualifiers(ResultType.getLocalQualifiers(), /*IsMember=*/false);
2264 Out << '?';
Richard Smithe301ba22015-11-11 02:02:15 +00002265 assert(AT->getKeyword() != AutoTypeKeyword::GNUAutoType &&
2266 "shouldn't need to mangle __auto_type!");
David Majnemer2e1e04912014-04-01 05:29:46 +00002267 mangleSourceName(AT->isDecltypeAuto() ? "<decltype-auto>" : "<auto>");
2268 Out << '@';
David Majnemer41311192016-01-17 07:09:24 +00002269 } else if (IsInLambda) {
2270 Out << '@';
David Majnemer2e1e04912014-04-01 05:29:46 +00002271 } else {
2272 if (ResultType->isVoidType())
2273 ResultType = ResultType.getUnqualifiedType();
2274 mangleType(ResultType, Range, QMM_Result);
2275 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002276 }
2277
2278 // <argument-list> ::= X # void
2279 // ::= <type>+ @
2280 // ::= <type>* Z # varargs
Peter Collingbourneeeebc412015-08-07 23:25:47 +00002281 if (!Proto) {
2282 // Function types without prototypes can arise when mangling a function type
2283 // within an overloadable function in C. We mangle these as the absence of
2284 // any parameter types (not even an empty parameter list).
2285 Out << '@';
2286 } else if (Proto->getNumParams() == 0 && !Proto->isVariadic()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002287 Out << 'X';
2288 } else {
Reid Kleckner18da98e2013-06-24 19:21:52 +00002289 // Happens for function pointer type arguments for example.
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00002290 for (unsigned I = 0, E = Proto->getNumParams(); I != E; ++I) {
Nico Weber73f05842019-06-01 10:12:07 +00002291 mangleFunctionArgumentType(Proto->getParamType(I), Range);
Simon Pilgrim27cc0542017-02-15 15:12:06 +00002292 // Mangle each pass_object_size parameter as if it's a parameter of enum
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00002293 // type passed directly after the parameter with the pass_object_size
2294 // attribute. The aforementioned enum's name is __pass_object_size, and we
2295 // pretend it resides in a top-level namespace called __clang.
2296 //
2297 // FIXME: Is there a defined extension notation for the MS ABI, or is it
2298 // necessary to just cross our fingers and hope this type+namespace
2299 // combination doesn't conflict with anything?
2300 if (D)
David Majnemer5f177622015-12-30 05:13:03 +00002301 if (const auto *P = D->getParamDecl(I)->getAttr<PassObjectSizeAttr>())
2302 manglePassObjectSizeArg(P);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00002303 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002304 // <builtin-type> ::= Z # ellipsis
2305 if (Proto->isVariadic())
2306 Out << 'Z';
2307 else
2308 Out << '@';
2309 }
2310
Reid Klecknerd2f98772018-12-17 23:10:43 +00002311 if (MangleExceptionSpec && getASTContext().getLangOpts().CPlusPlus17 &&
2312 getASTContext().getLangOpts().isCompatibleWithMSVC(
2313 LangOptions::MSVC2017_5))
2314 mangleThrowSpecification(Proto);
2315 else
2316 Out << 'Z';
Guy Benyei11169dd2012-12-18 14:30:41 +00002317}
2318
2319void MicrosoftCXXNameMangler::mangleFunctionClass(const FunctionDecl *FD) {
Reid Kleckner369f3162013-05-14 20:30:42 +00002320 // <function-class> ::= <member-function> E? # E designates a 64-bit 'this'
2321 // # pointer. in 64-bit mode *all*
2322 // # 'this' pointers are 64-bit.
2323 // ::= <global-function>
2324 // <member-function> ::= A # private: near
2325 // ::= B # private: far
2326 // ::= C # private: static near
2327 // ::= D # private: static far
2328 // ::= E # private: virtual near
2329 // ::= F # private: virtual far
Reid Kleckner369f3162013-05-14 20:30:42 +00002330 // ::= I # protected: near
2331 // ::= J # protected: far
2332 // ::= K # protected: static near
2333 // ::= L # protected: static far
2334 // ::= M # protected: virtual near
2335 // ::= N # protected: virtual far
Reid Kleckner369f3162013-05-14 20:30:42 +00002336 // ::= Q # public: near
2337 // ::= R # public: far
2338 // ::= S # public: static near
2339 // ::= T # public: static far
2340 // ::= U # public: virtual near
2341 // ::= V # public: virtual far
Reid Kleckner369f3162013-05-14 20:30:42 +00002342 // <global-function> ::= Y # global near
2343 // ::= Z # global far
Guy Benyei11169dd2012-12-18 14:30:41 +00002344 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD)) {
David Majnemerdc169752017-02-14 00:54:11 +00002345 bool IsVirtual = MD->isVirtual();
2346 // When mangling vbase destructor variants, ignore whether or not the
2347 // underlying destructor was defined to be virtual.
2348 if (isa<CXXDestructorDecl>(MD) && isStructorDecl(MD) &&
2349 StructorType == Dtor_Complete) {
2350 IsVirtual = false;
2351 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002352 switch (MD->getAccess()) {
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00002353 case AS_none:
2354 llvm_unreachable("Unsupported access specifier");
Guy Benyei11169dd2012-12-18 14:30:41 +00002355 case AS_private:
2356 if (MD->isStatic())
2357 Out << 'C';
David Majnemerdc169752017-02-14 00:54:11 +00002358 else if (IsVirtual)
Guy Benyei11169dd2012-12-18 14:30:41 +00002359 Out << 'E';
2360 else
2361 Out << 'A';
2362 break;
2363 case AS_protected:
2364 if (MD->isStatic())
2365 Out << 'K';
David Majnemerdc169752017-02-14 00:54:11 +00002366 else if (IsVirtual)
Guy Benyei11169dd2012-12-18 14:30:41 +00002367 Out << 'M';
2368 else
2369 Out << 'I';
2370 break;
2371 case AS_public:
2372 if (MD->isStatic())
2373 Out << 'S';
David Majnemerdc169752017-02-14 00:54:11 +00002374 else if (IsVirtual)
Guy Benyei11169dd2012-12-18 14:30:41 +00002375 Out << 'U';
2376 else
2377 Out << 'Q';
2378 }
David Majnemer5a7cfea2015-05-18 00:05:29 +00002379 } else {
Guy Benyei11169dd2012-12-18 14:30:41 +00002380 Out << 'Y';
David Majnemer5a7cfea2015-05-18 00:05:29 +00002381 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002382}
David Majnemerdfa6d202015-03-11 18:36:39 +00002383void MicrosoftCXXNameMangler::mangleCallingConvention(CallingConv CC) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002384 // <calling-convention> ::= A # __cdecl
2385 // ::= B # __export __cdecl
2386 // ::= C # __pascal
2387 // ::= D # __export __pascal
2388 // ::= E # __thiscall
2389 // ::= F # __export __thiscall
2390 // ::= G # __stdcall
2391 // ::= H # __export __stdcall
2392 // ::= I # __fastcall
2393 // ::= J # __export __fastcall
Reid Klecknerd7857f02014-10-24 17:42:17 +00002394 // ::= Q # __vectorcall
Erich Keane757d3172016-11-02 18:29:35 +00002395 // ::= w # __regcall
Guy Benyei11169dd2012-12-18 14:30:41 +00002396 // The 'export' calling conventions are from a bygone era
2397 // (*cough*Win16*cough*) when functions were declared for export with
2398 // that keyword. (It didn't actually export them, it just made them so
2399 // that they could be in a DLL and somebody from another module could call
2400 // them.)
David Majnemerdfa6d202015-03-11 18:36:39 +00002401
Guy Benyei11169dd2012-12-18 14:30:41 +00002402 switch (CC) {
2403 default:
2404 llvm_unreachable("Unsupported CC for mangling");
Martin Storsjo022e7822017-07-17 20:49:45 +00002405 case CC_Win64:
Charles Davisb5a214e2013-08-30 04:39:01 +00002406 case CC_X86_64SysV:
Guy Benyei11169dd2012-12-18 14:30:41 +00002407 case CC_C: Out << 'A'; break;
2408 case CC_X86Pascal: Out << 'C'; break;
2409 case CC_X86ThisCall: Out << 'E'; break;
2410 case CC_X86StdCall: Out << 'G'; break;
2411 case CC_X86FastCall: Out << 'I'; break;
Reid Klecknerd7857f02014-10-24 17:42:17 +00002412 case CC_X86VectorCall: Out << 'Q'; break;
Saleem Abdulrasool58340522018-02-07 01:55:08 +00002413 case CC_Swift: Out << 'S'; break;
Saleem Abdulrasool13aeee02018-04-02 22:25:50 +00002414 case CC_PreserveMost: Out << 'U'; break;
Erich Keane757d3172016-11-02 18:29:35 +00002415 case CC_X86RegCall: Out << 'w'; break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002416 }
2417}
David Majnemerdfa6d202015-03-11 18:36:39 +00002418void MicrosoftCXXNameMangler::mangleCallingConvention(const FunctionType *T) {
2419 mangleCallingConvention(T->getCallConv());
2420}
Reid Klecknerd2f98772018-12-17 23:10:43 +00002421
Guy Benyei11169dd2012-12-18 14:30:41 +00002422void MicrosoftCXXNameMangler::mangleThrowSpecification(
2423 const FunctionProtoType *FT) {
Reid Klecknerd2f98772018-12-17 23:10:43 +00002424 // <throw-spec> ::= Z # (default)
2425 // ::= _E # noexcept
2426 if (FT->canThrow())
2427 Out << 'Z';
2428 else
2429 Out << "_E";
Guy Benyei11169dd2012-12-18 14:30:41 +00002430}
2431
2432void MicrosoftCXXNameMangler::mangleType(const UnresolvedUsingType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002433 Qualifiers, SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002434 // Probably should be mangled as a template instantiation; need to see what
2435 // VC does first.
2436 DiagnosticsEngine &Diags = Context.getDiags();
2437 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2438 "cannot mangle this unresolved dependent type yet");
2439 Diags.Report(Range.getBegin(), DiagID)
2440 << Range;
2441}
2442
2443// <type> ::= <union-type> | <struct-type> | <class-type> | <enum-type>
2444// <union-type> ::= T <name>
2445// <struct-type> ::= U <name>
2446// <class-type> ::= V <name>
David Majnemer048f90c2013-12-09 04:28:34 +00002447// <enum-type> ::= W4 <name>
David Majnemer3add70b2015-12-29 11:45:53 +00002448void MicrosoftCXXNameMangler::mangleTagTypeKind(TagTypeKind TTK) {
2449 switch (TTK) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002450 case TTK_Union:
2451 Out << 'T';
2452 break;
2453 case TTK_Struct:
2454 case TTK_Interface:
2455 Out << 'U';
2456 break;
2457 case TTK_Class:
2458 Out << 'V';
2459 break;
2460 case TTK_Enum:
David Majnemer048f90c2013-12-09 04:28:34 +00002461 Out << "W4";
Guy Benyei11169dd2012-12-18 14:30:41 +00002462 break;
2463 }
David Majnemer3add70b2015-12-29 11:45:53 +00002464}
2465void MicrosoftCXXNameMangler::mangleType(const EnumType *T, Qualifiers,
2466 SourceRange) {
2467 mangleType(cast<TagType>(T)->getDecl());
2468}
2469void MicrosoftCXXNameMangler::mangleType(const RecordType *T, Qualifiers,
2470 SourceRange) {
2471 mangleType(cast<TagType>(T)->getDecl());
2472}
2473void MicrosoftCXXNameMangler::mangleType(const TagDecl *TD) {
2474 mangleTagTypeKind(TD->getTagKind());
David Majnemer0db0ca42013-08-05 22:26:46 +00002475 mangleName(TD);
Guy Benyei11169dd2012-12-18 14:30:41 +00002476}
Nico Weber3239f132018-07-23 20:04:00 +00002477
2478// If you add a call to this, consider updating isArtificialTagType() too.
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002479void MicrosoftCXXNameMangler::mangleArtificialTagType(
Nico Weber2b5f3fd2018-08-01 11:56:20 +00002480 TagTypeKind TK, StringRef UnqualifiedName,
2481 ArrayRef<StringRef> NestedNames) {
David Majnemer3add70b2015-12-29 11:45:53 +00002482 // <name> ::= <unscoped-name> {[<named-scope>]+ | [<nested-name>]}? @
2483 mangleTagTypeKind(TK);
2484
2485 // Always start with the unqualified name.
2486 mangleSourceName(UnqualifiedName);
2487
2488 for (auto I = NestedNames.rbegin(), E = NestedNames.rend(); I != E; ++I)
2489 mangleSourceName(*I);
2490
2491 // Terminate the whole name with an '@'.
2492 Out << '@';
2493}
Guy Benyei11169dd2012-12-18 14:30:41 +00002494
2495// <type> ::= <array-type>
2496// <array-type> ::= <pointer-cvr-qualifiers> <cvr-qualifiers>
2497// [Y <dimension-count> <dimension>+]
Reid Kleckner369f3162013-05-14 20:30:42 +00002498// <element-type> # as global, E is never required
Guy Benyei11169dd2012-12-18 14:30:41 +00002499// It's supposed to be the other way around, but for some strange reason, it
2500// isn't. Today this behavior is retained for the sole purpose of backwards
2501// compatibility.
David Majnemer5a1b2042013-09-11 04:44:30 +00002502void MicrosoftCXXNameMangler::mangleDecayedArrayType(const ArrayType *T) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002503 // This isn't a recursive mangling, so now we have to do it all in this
2504 // one call.
David Majnemer8eec58f2014-02-18 14:20:10 +00002505 manglePointerCVQualifiers(T->getElementType().getQualifiers());
Peter Collingbourne2816c022013-04-25 04:25:40 +00002506 mangleType(T->getElementType(), SourceRange());
Guy Benyei11169dd2012-12-18 14:30:41 +00002507}
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002508void MicrosoftCXXNameMangler::mangleType(const ConstantArrayType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002509 SourceRange) {
Peter Collingbourne2816c022013-04-25 04:25:40 +00002510 llvm_unreachable("Should have been special cased");
Guy Benyei11169dd2012-12-18 14:30:41 +00002511}
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002512void MicrosoftCXXNameMangler::mangleType(const VariableArrayType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002513 SourceRange) {
Peter Collingbourne2816c022013-04-25 04:25:40 +00002514 llvm_unreachable("Should have been special cased");
Guy Benyei11169dd2012-12-18 14:30:41 +00002515}
2516void MicrosoftCXXNameMangler::mangleType(const DependentSizedArrayType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002517 Qualifiers, SourceRange) {
Peter Collingbourne2816c022013-04-25 04:25:40 +00002518 llvm_unreachable("Should have been special cased");
Guy Benyei11169dd2012-12-18 14:30:41 +00002519}
2520void MicrosoftCXXNameMangler::mangleType(const IncompleteArrayType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002521 Qualifiers, SourceRange) {
Peter Collingbourne2816c022013-04-25 04:25:40 +00002522 llvm_unreachable("Should have been special cased");
Guy Benyei11169dd2012-12-18 14:30:41 +00002523}
Reid Kleckner18da98e2013-06-24 19:21:52 +00002524void MicrosoftCXXNameMangler::mangleArrayType(const ArrayType *T) {
Peter Collingbourne2816c022013-04-25 04:25:40 +00002525 QualType ElementTy(T, 0);
Guy Benyei11169dd2012-12-18 14:30:41 +00002526 SmallVector<llvm::APInt, 3> Dimensions;
2527 for (;;) {
David Majnemer9595b7d2015-04-23 07:42:08 +00002528 if (ElementTy->isConstantArrayType()) {
2529 const ConstantArrayType *CAT =
2530 getASTContext().getAsConstantArrayType(ElementTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00002531 Dimensions.push_back(CAT->getSize());
2532 ElementTy = CAT->getElementType();
David Majnemer9595b7d2015-04-23 07:42:08 +00002533 } else if (ElementTy->isIncompleteArrayType()) {
2534 const IncompleteArrayType *IAT =
2535 getASTContext().getAsIncompleteArrayType(ElementTy);
2536 Dimensions.push_back(llvm::APInt(32, 0));
2537 ElementTy = IAT->getElementType();
Guy Benyei11169dd2012-12-18 14:30:41 +00002538 } else if (ElementTy->isVariableArrayType()) {
2539 const VariableArrayType *VAT =
2540 getASTContext().getAsVariableArrayType(ElementTy);
David Majnemer9595b7d2015-04-23 07:42:08 +00002541 Dimensions.push_back(llvm::APInt(32, 0));
2542 ElementTy = VAT->getElementType();
Guy Benyei11169dd2012-12-18 14:30:41 +00002543 } else if (ElementTy->isDependentSizedArrayType()) {
2544 // The dependent expression has to be folded into a constant (TODO).
2545 const DependentSizedArrayType *DSAT =
2546 getASTContext().getAsDependentSizedArrayType(ElementTy);
2547 DiagnosticsEngine &Diags = Context.getDiags();
2548 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2549 "cannot mangle this dependent-length array yet");
2550 Diags.Report(DSAT->getSizeExpr()->getExprLoc(), DiagID)
2551 << DSAT->getBracketsRange();
2552 return;
David Majnemer9595b7d2015-04-23 07:42:08 +00002553 } else {
2554 break;
Peter Collingbourne2816c022013-04-25 04:25:40 +00002555 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002556 }
Peter Collingbourne2816c022013-04-25 04:25:40 +00002557 Out << 'Y';
2558 // <dimension-count> ::= <number> # number of extra dimensions
2559 mangleNumber(Dimensions.size());
David Majnemerb926dbc2014-04-23 05:16:53 +00002560 for (const llvm::APInt &Dimension : Dimensions)
2561 mangleNumber(Dimension.getLimitedValue());
Reid Kleckner18da98e2013-06-24 19:21:52 +00002562 mangleType(ElementTy, SourceRange(), QMM_Escape);
Guy Benyei11169dd2012-12-18 14:30:41 +00002563}
2564
2565// <type> ::= <pointer-to-member-type>
2566// <pointer-to-member-type> ::= <pointer-cvr-qualifiers> <cvr-qualifiers>
2567// <class name> <type>
Nico Weber2b5f3fd2018-08-01 11:56:20 +00002568void MicrosoftCXXNameMangler::mangleType(const MemberPointerType *T,
2569 Qualifiers Quals, SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002570 QualType PointeeType = T->getPointeeType();
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002571 manglePointerCVQualifiers(Quals);
2572 manglePointerExtQualifiers(Quals, PointeeType);
Guy Benyei11169dd2012-12-18 14:30:41 +00002573 if (const FunctionProtoType *FPT = PointeeType->getAs<FunctionProtoType>()) {
2574 Out << '8';
2575 mangleName(T->getClass()->castAs<RecordType>()->getDecl());
Craig Topper36250ad2014-05-12 05:36:57 +00002576 mangleFunctionType(FPT, nullptr, true);
Guy Benyei11169dd2012-12-18 14:30:41 +00002577 } else {
2578 mangleQualifiers(PointeeType.getQualifiers(), true);
2579 mangleName(T->getClass()->castAs<RecordType>()->getDecl());
Peter Collingbourne2816c022013-04-25 04:25:40 +00002580 mangleType(PointeeType, Range, QMM_Drop);
Guy Benyei11169dd2012-12-18 14:30:41 +00002581 }
2582}
2583
2584void MicrosoftCXXNameMangler::mangleType(const TemplateTypeParmType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002585 Qualifiers, SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002586 DiagnosticsEngine &Diags = Context.getDiags();
2587 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2588 "cannot mangle this template type parameter type yet");
2589 Diags.Report(Range.getBegin(), DiagID)
2590 << Range;
2591}
2592
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002593void MicrosoftCXXNameMangler::mangleType(const SubstTemplateTypeParmPackType *T,
2594 Qualifiers, SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002595 DiagnosticsEngine &Diags = Context.getDiags();
2596 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2597 "cannot mangle this substituted parameter pack yet");
2598 Diags.Report(Range.getBegin(), DiagID)
2599 << Range;
2600}
2601
2602// <type> ::= <pointer-type>
Reid Kleckner369f3162013-05-14 20:30:42 +00002603// <pointer-type> ::= E? <pointer-cvr-qualifiers> <cvr-qualifiers> <type>
Alp Tokerd4733632013-12-05 04:47:09 +00002604// # the E is required for 64-bit non-static pointers
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002605void MicrosoftCXXNameMangler::mangleType(const PointerType *T, Qualifiers Quals,
Guy Benyei11169dd2012-12-18 14:30:41 +00002606 SourceRange Range) {
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002607 QualType PointeeType = T->getPointeeType();
2608 manglePointerCVQualifiers(Quals);
2609 manglePointerExtQualifiers(Quals, PointeeType);
Erich Keane24a0f042018-12-14 23:17:34 +00002610
Amy Huanga85f5ef2019-10-24 16:34:25 -07002611 // For pointer size address spaces, go down the same type mangling path as
2612 // non address space types.
2613 LangAS AddrSpace = PointeeType.getQualifiers().getAddressSpace();
2614 if (isPtrSizeAddressSpace(AddrSpace) || AddrSpace == LangAS::Default)
Erich Keane24a0f042018-12-14 23:17:34 +00002615 mangleType(PointeeType, Range);
Amy Huanga85f5ef2019-10-24 16:34:25 -07002616 else
2617 mangleAddressSpaceType(PointeeType, PointeeType.getQualifiers(), Range);
Guy Benyei11169dd2012-12-18 14:30:41 +00002618}
Saleem Abdulrasool5a3e50a2017-08-23 22:38:58 +00002619
Guy Benyei11169dd2012-12-18 14:30:41 +00002620void MicrosoftCXXNameMangler::mangleType(const ObjCObjectPointerType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002621 Qualifiers Quals, SourceRange Range) {
2622 QualType PointeeType = T->getPointeeType();
Saleem Abdulrasoolbbce34a2018-02-09 03:23:54 +00002623 switch (Quals.getObjCLifetime()) {
2624 case Qualifiers::OCL_None:
2625 case Qualifiers::OCL_ExplicitNone:
2626 break;
2627 case Qualifiers::OCL_Autoreleasing:
2628 case Qualifiers::OCL_Strong:
2629 case Qualifiers::OCL_Weak:
2630 return mangleObjCLifetime(PointeeType, Quals, Range);
2631 }
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002632 manglePointerCVQualifiers(Quals);
2633 manglePointerExtQualifiers(Quals, PointeeType);
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002634 mangleType(PointeeType, Range);
Guy Benyei11169dd2012-12-18 14:30:41 +00002635}
2636
2637// <type> ::= <reference-type>
Reid Kleckner369f3162013-05-14 20:30:42 +00002638// <reference-type> ::= A E? <cvr-qualifiers> <type>
Alp Tokerd4733632013-12-05 04:47:09 +00002639// # the E is required for 64-bit non-static lvalue references
Guy Benyei11169dd2012-12-18 14:30:41 +00002640void MicrosoftCXXNameMangler::mangleType(const LValueReferenceType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002641 Qualifiers Quals, SourceRange Range) {
2642 QualType PointeeType = T->getPointeeType();
David Majnemere3d71912015-12-31 05:36:50 +00002643 assert(!Quals.hasConst() && !Quals.hasVolatile() && "unexpected qualifier!");
2644 Out << 'A';
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002645 manglePointerExtQualifiers(Quals, PointeeType);
2646 mangleType(PointeeType, Range);
Guy Benyei11169dd2012-12-18 14:30:41 +00002647}
2648
2649// <type> ::= <r-value-reference-type>
Reid Kleckner369f3162013-05-14 20:30:42 +00002650// <r-value-reference-type> ::= $$Q E? <cvr-qualifiers> <type>
Alp Tokerd4733632013-12-05 04:47:09 +00002651// # the E is required for 64-bit non-static rvalue references
Guy Benyei11169dd2012-12-18 14:30:41 +00002652void MicrosoftCXXNameMangler::mangleType(const RValueReferenceType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002653 Qualifiers Quals, SourceRange Range) {
2654 QualType PointeeType = T->getPointeeType();
David Majnemere3d71912015-12-31 05:36:50 +00002655 assert(!Quals.hasConst() && !Quals.hasVolatile() && "unexpected qualifier!");
2656 Out << "$$Q";
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002657 manglePointerExtQualifiers(Quals, PointeeType);
2658 mangleType(PointeeType, Range);
Guy Benyei11169dd2012-12-18 14:30:41 +00002659}
2660
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002661void MicrosoftCXXNameMangler::mangleType(const ComplexType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002662 SourceRange Range) {
David Majnemer0b996dd2015-12-29 22:02:15 +00002663 QualType ElementType = T->getElementType();
2664
2665 llvm::SmallString<64> TemplateMangling;
2666 llvm::raw_svector_ostream Stream(TemplateMangling);
2667 MicrosoftCXXNameMangler Extra(Context, Stream);
2668 Stream << "?$";
2669 Extra.mangleSourceName("_Complex");
2670 Extra.mangleType(ElementType, Range, QMM_Escape);
2671
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002672 mangleArtificialTagType(TTK_Struct, TemplateMangling, {"__clang"});
Guy Benyei11169dd2012-12-18 14:30:41 +00002673}
2674
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002675// Returns true for types that mangleArtificialTagType() gets called for with
Nico Weber3239f132018-07-23 20:04:00 +00002676// TTK_Union, TTK_Struct, TTK_Class and where compatibility with MSVC's
2677// mangling matters.
2678// (It doesn't matter for Objective-C types and the like that cl.exe doesn't
2679// support.)
2680bool MicrosoftCXXNameMangler::isArtificialTagType(QualType T) const {
2681 const Type *ty = T.getTypePtr();
2682 switch (ty->getTypeClass()) {
2683 default:
2684 return false;
2685
2686 case Type::Vector: {
2687 // For ABI compatibility only __m64, __m128(id), and __m256(id) matter,
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002688 // but since mangleType(VectorType*) always calls mangleArtificialTagType()
Nico Weber3239f132018-07-23 20:04:00 +00002689 // just always return true (the other vector types are clang-only).
2690 return true;
2691 }
2692 }
2693}
2694
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002695void MicrosoftCXXNameMangler::mangleType(const VectorType *T, Qualifiers Quals,
Guy Benyei11169dd2012-12-18 14:30:41 +00002696 SourceRange Range) {
Reid Klecknere7e64d82013-03-26 16:56:59 +00002697 const BuiltinType *ET = T->getElementType()->getAs<BuiltinType>();
2698 assert(ET && "vectors with non-builtin elements are unsupported");
2699 uint64_t Width = getASTContext().getTypeSize(T);
2700 // Pattern match exactly the typedefs in our intrinsic headers. Anything that
2701 // doesn't match the Intel types uses a custom mangling below.
David Majnemer0a29fed2015-12-29 11:45:58 +00002702 size_t OutSizeBefore = Out.tell();
Saleem Abdulrasool21568182018-10-28 18:05:20 +00002703 if (!isa<ExtVectorType>(T)) {
Fangrui Song6904cd92020-01-06 10:16:28 -08002704 if (getASTContext().getTargetInfo().getTriple().isX86()) {
Saleem Abdulrasool21568182018-10-28 18:05:20 +00002705 if (Width == 64 && ET->getKind() == BuiltinType::LongLong) {
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002706 mangleArtificialTagType(TTK_Union, "__m64");
Saleem Abdulrasool21568182018-10-28 18:05:20 +00002707 } else if (Width >= 128) {
2708 if (ET->getKind() == BuiltinType::Float)
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002709 mangleArtificialTagType(TTK_Union, "__m" + llvm::utostr(Width));
Saleem Abdulrasool21568182018-10-28 18:05:20 +00002710 else if (ET->getKind() == BuiltinType::LongLong)
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002711 mangleArtificialTagType(TTK_Union, "__m" + llvm::utostr(Width) + 'i');
Saleem Abdulrasool21568182018-10-28 18:05:20 +00002712 else if (ET->getKind() == BuiltinType::Double)
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002713 mangleArtificialTagType(TTK_Struct, "__m" + llvm::utostr(Width) + 'd');
Saleem Abdulrasool21568182018-10-28 18:05:20 +00002714 }
David Majnemerf04e3862015-06-01 07:41:37 +00002715 }
Reid Klecknere7e64d82013-03-26 16:56:59 +00002716 }
2717
David Majnemer0a29fed2015-12-29 11:45:58 +00002718 bool IsBuiltin = Out.tell() != OutSizeBefore;
David Majnemerf04e3862015-06-01 07:41:37 +00002719 if (!IsBuiltin) {
Reid Klecknere7e64d82013-03-26 16:56:59 +00002720 // The MS ABI doesn't have a special mangling for vector types, so we define
2721 // our own mangling to handle uses of __vector_size__ on user-specified
2722 // types, and for extensions like __v4sf.
David Majnemer0a29fed2015-12-29 11:45:58 +00002723
2724 llvm::SmallString<64> TemplateMangling;
2725 llvm::raw_svector_ostream Stream(TemplateMangling);
2726 MicrosoftCXXNameMangler Extra(Context, Stream);
2727 Stream << "?$";
2728 Extra.mangleSourceName("__vector");
2729 Extra.mangleType(QualType(ET, 0), Range, QMM_Escape);
2730 Extra.mangleIntegerLiteral(llvm::APSInt::getUnsigned(T->getNumElements()),
2731 /*IsBoolean=*/false);
2732
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002733 mangleArtificialTagType(TTK_Union, TemplateMangling, {"__clang"});
Reid Klecknere7e64d82013-03-26 16:56:59 +00002734 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002735}
Reid Klecknere7e64d82013-03-26 16:56:59 +00002736
David Majnemere5c87872015-08-01 05:51:55 +00002737void MicrosoftCXXNameMangler::mangleType(const ExtVectorType *T,
2738 Qualifiers Quals, SourceRange Range) {
2739 mangleType(static_cast<const VectorType *>(T), Quals, Range);
Guy Benyei11169dd2012-12-18 14:30:41 +00002740}
Erich Keanef702b022018-07-13 19:46:04 +00002741
2742void MicrosoftCXXNameMangler::mangleType(const DependentVectorType *T,
2743 Qualifiers, SourceRange Range) {
2744 DiagnosticsEngine &Diags = Context.getDiags();
2745 unsigned DiagID = Diags.getCustomDiagID(
2746 DiagnosticsEngine::Error,
2747 "cannot mangle this dependent-sized vector type yet");
2748 Diags.Report(Range.getBegin(), DiagID) << Range;
2749}
2750
Guy Benyei11169dd2012-12-18 14:30:41 +00002751void MicrosoftCXXNameMangler::mangleType(const DependentSizedExtVectorType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002752 Qualifiers, SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002753 DiagnosticsEngine &Diags = Context.getDiags();
2754 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2755 "cannot mangle this dependent-sized extended vector type yet");
2756 Diags.Report(Range.getBegin(), DiagID)
2757 << Range;
2758}
2759
Andrew Gozillon572bbb02017-10-02 06:25:51 +00002760void MicrosoftCXXNameMangler::mangleType(const DependentAddressSpaceType *T,
2761 Qualifiers, SourceRange Range) {
2762 DiagnosticsEngine &Diags = Context.getDiags();
2763 unsigned DiagID = Diags.getCustomDiagID(
2764 DiagnosticsEngine::Error,
2765 "cannot mangle this dependent address space type yet");
2766 Diags.Report(Range.getBegin(), DiagID) << Range;
2767}
2768
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002769void MicrosoftCXXNameMangler::mangleType(const ObjCInterfaceType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002770 SourceRange) {
Shoaib Meenaic8714d22018-10-04 19:50:14 +00002771 // ObjC interfaces have structs underlying them.
David Majnemer3add70b2015-12-29 11:45:53 +00002772 mangleTagTypeKind(TTK_Struct);
Shoaib Meenaic8714d22018-10-04 19:50:14 +00002773 mangleName(T->getDecl());
Guy Benyei11169dd2012-12-18 14:30:41 +00002774}
2775
Saleem Abdulrasoolf3a981e2018-09-28 16:47:53 +00002776void MicrosoftCXXNameMangler::mangleType(const ObjCObjectType *T,
2777 Qualifiers Quals, SourceRange Range) {
2778 if (T->isKindOfType())
2779 return mangleObjCKindOfType(T, Quals, Range);
2780
2781 if (T->qual_empty() && !T->isSpecialized())
Saleem Abdulrasoolf591e362018-01-26 19:08:26 +00002782 return mangleType(T->getBaseType(), Range, QMM_Drop);
2783
Nico Weber73f05842019-06-01 10:12:07 +00002784 ArgBackRefMap OuterFunArgsContext;
2785 ArgBackRefMap OuterTemplateArgsContext;
Saleem Abdulrasoolf591e362018-01-26 19:08:26 +00002786 BackRefVec OuterTemplateContext;
2787
Nico Weber73f05842019-06-01 10:12:07 +00002788 FunArgBackReferences.swap(OuterFunArgsContext);
2789 TemplateArgBackReferences.swap(OuterTemplateArgsContext);
Saleem Abdulrasoolf591e362018-01-26 19:08:26 +00002790 NameBackReferences.swap(OuterTemplateContext);
2791
2792 mangleTagTypeKind(TTK_Struct);
2793
2794 Out << "?$";
2795 if (T->isObjCId())
Shoaib Meenaic8714d22018-10-04 19:50:14 +00002796 mangleSourceName("objc_object");
Saleem Abdulrasoolf591e362018-01-26 19:08:26 +00002797 else if (T->isObjCClass())
Shoaib Meenaic8714d22018-10-04 19:50:14 +00002798 mangleSourceName("objc_class");
Saleem Abdulrasoolf591e362018-01-26 19:08:26 +00002799 else
Shoaib Meenaic8714d22018-10-04 19:50:14 +00002800 mangleSourceName(T->getInterface()->getName());
Saleem Abdulrasoolf591e362018-01-26 19:08:26 +00002801
Saleem Abdulrasoolbbce34a2018-02-09 03:23:54 +00002802 for (const auto &Q : T->quals())
2803 mangleObjCProtocol(Q);
Saleem Abdulrasoolf3a981e2018-09-28 16:47:53 +00002804
2805 if (T->isSpecialized())
2806 for (const auto &TA : T->getTypeArgs())
2807 mangleType(TA, Range, QMM_Drop);
2808
Saleem Abdulrasoolf591e362018-01-26 19:08:26 +00002809 Out << '@';
2810
2811 Out << '@';
2812
Nico Weber73f05842019-06-01 10:12:07 +00002813 FunArgBackReferences.swap(OuterFunArgsContext);
2814 TemplateArgBackReferences.swap(OuterTemplateArgsContext);
Saleem Abdulrasoolf591e362018-01-26 19:08:26 +00002815 NameBackReferences.swap(OuterTemplateContext);
Guy Benyei11169dd2012-12-18 14:30:41 +00002816}
2817
2818void MicrosoftCXXNameMangler::mangleType(const BlockPointerType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002819 Qualifiers Quals, SourceRange Range) {
2820 QualType PointeeType = T->getPointeeType();
2821 manglePointerCVQualifiers(Quals);
2822 manglePointerExtQualifiers(Quals, PointeeType);
2823
Guy Benyei11169dd2012-12-18 14:30:41 +00002824 Out << "_E";
2825
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002826 mangleFunctionType(PointeeType->castAs<FunctionProtoType>());
Guy Benyei11169dd2012-12-18 14:30:41 +00002827}
2828
David Majnemerf0a84f22013-08-16 08:29:13 +00002829void MicrosoftCXXNameMangler::mangleType(const InjectedClassNameType *,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002830 Qualifiers, SourceRange) {
David Majnemerf0a84f22013-08-16 08:29:13 +00002831 llvm_unreachable("Cannot mangle injected class name type.");
Guy Benyei11169dd2012-12-18 14:30:41 +00002832}
2833
2834void MicrosoftCXXNameMangler::mangleType(const TemplateSpecializationType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002835 Qualifiers, SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002836 DiagnosticsEngine &Diags = Context.getDiags();
2837 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2838 "cannot mangle this template specialization type yet");
2839 Diags.Report(Range.getBegin(), DiagID)
2840 << Range;
2841}
2842
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002843void MicrosoftCXXNameMangler::mangleType(const DependentNameType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002844 SourceRange Range) {
2845 DiagnosticsEngine &Diags = Context.getDiags();
2846 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2847 "cannot mangle this dependent name type yet");
2848 Diags.Report(Range.getBegin(), DiagID)
2849 << Range;
2850}
2851
2852void MicrosoftCXXNameMangler::mangleType(
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002853 const DependentTemplateSpecializationType *T, Qualifiers,
2854 SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002855 DiagnosticsEngine &Diags = Context.getDiags();
2856 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2857 "cannot mangle this dependent template specialization type yet");
2858 Diags.Report(Range.getBegin(), DiagID)
2859 << Range;
2860}
2861
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002862void MicrosoftCXXNameMangler::mangleType(const PackExpansionType *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 pack expansion yet");
2867 Diags.Report(Range.getBegin(), DiagID)
2868 << Range;
2869}
2870
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002871void MicrosoftCXXNameMangler::mangleType(const TypeOfType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002872 SourceRange Range) {
2873 DiagnosticsEngine &Diags = Context.getDiags();
2874 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2875 "cannot mangle this typeof(type) yet");
2876 Diags.Report(Range.getBegin(), DiagID)
2877 << Range;
2878}
2879
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002880void MicrosoftCXXNameMangler::mangleType(const TypeOfExprType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002881 SourceRange Range) {
2882 DiagnosticsEngine &Diags = Context.getDiags();
2883 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2884 "cannot mangle this typeof(expression) yet");
2885 Diags.Report(Range.getBegin(), DiagID)
2886 << Range;
2887}
2888
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002889void MicrosoftCXXNameMangler::mangleType(const DecltypeType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002890 SourceRange Range) {
2891 DiagnosticsEngine &Diags = Context.getDiags();
2892 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2893 "cannot mangle this decltype() yet");
2894 Diags.Report(Range.getBegin(), DiagID)
2895 << Range;
2896}
2897
2898void MicrosoftCXXNameMangler::mangleType(const UnaryTransformType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002899 Qualifiers, SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002900 DiagnosticsEngine &Diags = Context.getDiags();
2901 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2902 "cannot mangle this unary transform type yet");
2903 Diags.Report(Range.getBegin(), DiagID)
2904 << Range;
2905}
2906
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002907void MicrosoftCXXNameMangler::mangleType(const AutoType *T, Qualifiers,
2908 SourceRange Range) {
David Majnemerb9a5f2d2014-01-21 20:33:36 +00002909 assert(T->getDeducedType().isNull() && "expecting a dependent type!");
2910
Guy Benyei11169dd2012-12-18 14:30:41 +00002911 DiagnosticsEngine &Diags = Context.getDiags();
2912 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2913 "cannot mangle this 'auto' type yet");
2914 Diags.Report(Range.getBegin(), DiagID)
2915 << Range;
2916}
2917
Richard Smith600b5262017-01-26 20:40:47 +00002918void MicrosoftCXXNameMangler::mangleType(
2919 const DeducedTemplateSpecializationType *T, Qualifiers, SourceRange Range) {
2920 assert(T->getDeducedType().isNull() && "expecting a dependent type!");
2921
2922 DiagnosticsEngine &Diags = Context.getDiags();
2923 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2924 "cannot mangle this deduced class template specialization type yet");
2925 Diags.Report(Range.getBegin(), DiagID)
2926 << Range;
2927}
2928
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002929void MicrosoftCXXNameMangler::mangleType(const AtomicType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002930 SourceRange Range) {
David Majnemer3421fb62015-12-29 11:46:00 +00002931 QualType ValueType = T->getValueType();
2932
2933 llvm::SmallString<64> TemplateMangling;
2934 llvm::raw_svector_ostream Stream(TemplateMangling);
2935 MicrosoftCXXNameMangler Extra(Context, Stream);
2936 Stream << "?$";
2937 Extra.mangleSourceName("_Atomic");
2938 Extra.mangleType(ValueType, Range, QMM_Escape);
2939
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002940 mangleArtificialTagType(TTK_Struct, TemplateMangling, {"__clang"});
Guy Benyei11169dd2012-12-18 14:30:41 +00002941}
2942
Xiuli Pan9c14e282016-01-09 12:53:17 +00002943void MicrosoftCXXNameMangler::mangleType(const PipeType *T, Qualifiers,
2944 SourceRange Range) {
2945 DiagnosticsEngine &Diags = Context.getDiags();
2946 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2947 "cannot mangle this OpenCL pipe type yet");
2948 Diags.Report(Range.getBegin(), DiagID)
2949 << Range;
2950}
2951
Rafael Espindola002667c2013-10-16 01:40:34 +00002952void MicrosoftMangleContextImpl::mangleCXXName(const NamedDecl *D,
2953 raw_ostream &Out) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002954 assert((isa<FunctionDecl>(D) || isa<VarDecl>(D)) &&
2955 "Invalid mangleName() call, argument is not a variable or function!");
2956 assert(!isa<CXXConstructorDecl>(D) && !isa<CXXDestructorDecl>(D) &&
2957 "Invalid mangleName() call on 'structor decl!");
2958
2959 PrettyStackTraceDecl CrashInfo(D, SourceLocation(),
2960 getASTContext().getSourceManager(),
2961 "Mangling declaration");
2962
David Majnemerfebb2722016-03-07 08:51:17 +00002963 msvc_hashing_ostream MHO(Out);
2964 MicrosoftCXXNameMangler Mangler(*this, MHO);
Guy Benyei11169dd2012-12-18 14:30:41 +00002965 return Mangler.mangle(D);
2966}
Timur Iskhodzhanovdf7e7fb2013-07-30 09:46:19 +00002967
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002968// <this-adjustment> ::= <no-adjustment> | <static-adjustment> |
2969// <virtual-adjustment>
2970// <no-adjustment> ::= A # private near
2971// ::= B # private far
2972// ::= I # protected near
2973// ::= J # protected far
2974// ::= Q # public near
2975// ::= R # public far
2976// <static-adjustment> ::= G <static-offset> # private near
2977// ::= H <static-offset> # private far
2978// ::= O <static-offset> # protected near
2979// ::= P <static-offset> # protected far
2980// ::= W <static-offset> # public near
2981// ::= X <static-offset> # public far
2982// <virtual-adjustment> ::= $0 <virtual-shift> <static-offset> # private near
2983// ::= $1 <virtual-shift> <static-offset> # private far
2984// ::= $2 <virtual-shift> <static-offset> # protected near
2985// ::= $3 <virtual-shift> <static-offset> # protected far
2986// ::= $4 <virtual-shift> <static-offset> # public near
2987// ::= $5 <virtual-shift> <static-offset> # public far
2988// <virtual-shift> ::= <vtordisp-shift> | <vtordispex-shift>
2989// <vtordisp-shift> ::= <offset-to-vtordisp>
2990// <vtordispex-shift> ::= <offset-to-vbptr> <vbase-offset-offset>
2991// <offset-to-vtordisp>
Reid Kleckner3ab5a9c2018-12-26 20:07:52 +00002992static void mangleThunkThisAdjustment(AccessSpecifier AS,
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00002993 const ThisAdjustment &Adjustment,
2994 MicrosoftCXXNameMangler &Mangler,
2995 raw_ostream &Out) {
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002996 if (!Adjustment.Virtual.isEmpty()) {
2997 Out << '$';
2998 char AccessSpec;
Reid Kleckner3ab5a9c2018-12-26 20:07:52 +00002999 switch (AS) {
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00003000 case AS_none:
3001 llvm_unreachable("Unsupported access specifier");
3002 case AS_private:
3003 AccessSpec = '0';
3004 break;
3005 case AS_protected:
3006 AccessSpec = '2';
3007 break;
3008 case AS_public:
3009 AccessSpec = '4';
3010 }
3011 if (Adjustment.Virtual.Microsoft.VBPtrOffset) {
3012 Out << 'R' << AccessSpec;
David Majnemer2a816452013-12-09 10:44:32 +00003013 Mangler.mangleNumber(
3014 static_cast<uint32_t>(Adjustment.Virtual.Microsoft.VBPtrOffset));
3015 Mangler.mangleNumber(
3016 static_cast<uint32_t>(Adjustment.Virtual.Microsoft.VBOffsetOffset));
3017 Mangler.mangleNumber(
3018 static_cast<uint32_t>(Adjustment.Virtual.Microsoft.VtordispOffset));
3019 Mangler.mangleNumber(static_cast<uint32_t>(Adjustment.NonVirtual));
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00003020 } else {
3021 Out << AccessSpec;
David Majnemer2a816452013-12-09 10:44:32 +00003022 Mangler.mangleNumber(
3023 static_cast<uint32_t>(Adjustment.Virtual.Microsoft.VtordispOffset));
3024 Mangler.mangleNumber(-static_cast<uint32_t>(Adjustment.NonVirtual));
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00003025 }
3026 } else if (Adjustment.NonVirtual != 0) {
Reid Kleckner3ab5a9c2018-12-26 20:07:52 +00003027 switch (AS) {
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00003028 case AS_none:
3029 llvm_unreachable("Unsupported access specifier");
3030 case AS_private:
3031 Out << 'G';
3032 break;
3033 case AS_protected:
3034 Out << 'O';
3035 break;
3036 case AS_public:
3037 Out << 'W';
3038 }
David Majnemer2a816452013-12-09 10:44:32 +00003039 Mangler.mangleNumber(-static_cast<uint32_t>(Adjustment.NonVirtual));
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00003040 } else {
Reid Kleckner3ab5a9c2018-12-26 20:07:52 +00003041 switch (AS) {
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00003042 case AS_none:
3043 llvm_unreachable("Unsupported access specifier");
3044 case AS_private:
3045 Out << 'A';
3046 break;
3047 case AS_protected:
3048 Out << 'I';
3049 break;
3050 case AS_public:
3051 Out << 'Q';
3052 }
3053 }
3054}
3055
Reid Klecknercbec0262018-04-02 20:00:39 +00003056void MicrosoftMangleContextImpl::mangleVirtualMemPtrThunk(
3057 const CXXMethodDecl *MD, const MethodVFTableLocation &ML,
3058 raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003059 msvc_hashing_ostream MHO(Out);
3060 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Klecknerfb931542018-03-16 20:36:49 +00003061 Mangler.getStream() << '?';
Reid Kleckner96f8f932014-02-05 17:27:08 +00003062 Mangler.mangleVirtualMemPtrThunk(MD, ML);
Hans Wennborg88497d62013-11-15 17:24:45 +00003063}
3064
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003065void MicrosoftMangleContextImpl::mangleThunk(const CXXMethodDecl *MD,
3066 const ThunkInfo &Thunk,
3067 raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003068 msvc_hashing_ostream MHO(Out);
3069 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Klecknerfb931542018-03-16 20:36:49 +00003070 Mangler.getStream() << '?';
Timur Iskhodzhanovdf7e7fb2013-07-30 09:46:19 +00003071 Mangler.mangleName(MD);
Reid Kleckner3ab5a9c2018-12-26 20:07:52 +00003072
3073 // Usually the thunk uses the access specifier of the new method, but if this
3074 // is a covariant return thunk, then MSVC always uses the public access
3075 // specifier, and we do the same.
3076 AccessSpecifier AS = Thunk.Return.isEmpty() ? MD->getAccess() : AS_public;
3077 mangleThunkThisAdjustment(AS, Thunk.This, Mangler, MHO);
3078
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00003079 if (!Thunk.Return.isEmpty())
Craig Topper36250ad2014-05-12 05:36:57 +00003080 assert(Thunk.Method != nullptr &&
3081 "Thunk info should hold the overridee decl");
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00003082
3083 const CXXMethodDecl *DeclForFPT = Thunk.Method ? Thunk.Method : MD;
3084 Mangler.mangleFunctionType(
3085 DeclForFPT->getType()->castAs<FunctionProtoType>(), MD);
Guy Benyei11169dd2012-12-18 14:30:41 +00003086}
Timur Iskhodzhanovdf7e7fb2013-07-30 09:46:19 +00003087
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00003088void MicrosoftMangleContextImpl::mangleCXXDtorThunk(
3089 const CXXDestructorDecl *DD, CXXDtorType Type,
3090 const ThisAdjustment &Adjustment, raw_ostream &Out) {
3091 // FIXME: Actually, the dtor thunk should be emitted for vector deleting
3092 // dtors rather than scalar deleting dtors. Just use the vector deleting dtor
3093 // mangling manually until we support both deleting dtor types.
3094 assert(Type == Dtor_Deleting);
David Majnemerfebb2722016-03-07 08:51:17 +00003095 msvc_hashing_ostream MHO(Out);
3096 MicrosoftCXXNameMangler Mangler(*this, MHO, DD, Type);
Reid Klecknerfb931542018-03-16 20:36:49 +00003097 Mangler.getStream() << "??_E";
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00003098 Mangler.mangleName(DD->getParent());
Reid Kleckner3ab5a9c2018-12-26 20:07:52 +00003099 mangleThunkThisAdjustment(DD->getAccess(), Adjustment, Mangler, MHO);
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00003100 Mangler.mangleFunctionType(DD->getType()->castAs<FunctionProtoType>(), DD);
Guy Benyei11169dd2012-12-18 14:30:41 +00003101}
Reid Kleckner7810af02013-06-19 15:20:38 +00003102
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003103void MicrosoftMangleContextImpl::mangleCXXVFTable(
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00003104 const CXXRecordDecl *Derived, ArrayRef<const CXXRecordDecl *> BasePath,
3105 raw_ostream &Out) {
Reid Kleckner7810af02013-06-19 15:20:38 +00003106 // <mangled-name> ::= ?_7 <class-name> <storage-class>
3107 // <cvr-qualifiers> [<name>] @
Guy Benyei11169dd2012-12-18 14:30:41 +00003108 // NOTE: <cvr-qualifiers> here is always 'B' (const). <storage-class>
Reid Kleckner7810af02013-06-19 15:20:38 +00003109 // is always '6' for vftables.
David Majnemerfebb2722016-03-07 08:51:17 +00003110 msvc_hashing_ostream MHO(Out);
3111 MicrosoftCXXNameMangler Mangler(*this, MHO);
David Majnemer2d8b2002016-02-11 17:49:28 +00003112 if (Derived->hasAttr<DLLImportAttr>())
Reid Klecknerfb931542018-03-16 20:36:49 +00003113 Mangler.getStream() << "??_S";
David Majnemer2d8b2002016-02-11 17:49:28 +00003114 else
Reid Klecknerfb931542018-03-16 20:36:49 +00003115 Mangler.getStream() << "??_7";
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00003116 Mangler.mangleName(Derived);
3117 Mangler.getStream() << "6B"; // '6' for vftable, 'B' for const.
David Majnemerb926dbc2014-04-23 05:16:53 +00003118 for (const CXXRecordDecl *RD : BasePath)
3119 Mangler.mangleName(RD);
Guy Benyei11169dd2012-12-18 14:30:41 +00003120 Mangler.getStream() << '@';
3121}
Reid Kleckner7810af02013-06-19 15:20:38 +00003122
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003123void MicrosoftMangleContextImpl::mangleCXXVBTable(
Reid Kleckner7810af02013-06-19 15:20:38 +00003124 const CXXRecordDecl *Derived, ArrayRef<const CXXRecordDecl *> BasePath,
3125 raw_ostream &Out) {
3126 // <mangled-name> ::= ?_8 <class-name> <storage-class>
3127 // <cvr-qualifiers> [<name>] @
3128 // NOTE: <cvr-qualifiers> here is always 'B' (const). <storage-class>
3129 // is always '7' for vbtables.
David Majnemerfebb2722016-03-07 08:51:17 +00003130 msvc_hashing_ostream MHO(Out);
3131 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Klecknerfb931542018-03-16 20:36:49 +00003132 Mangler.getStream() << "??_8";
Reid Kleckner7810af02013-06-19 15:20:38 +00003133 Mangler.mangleName(Derived);
3134 Mangler.getStream() << "7B"; // '7' for vbtable, 'B' for const.
David Majnemerb926dbc2014-04-23 05:16:53 +00003135 for (const CXXRecordDecl *RD : BasePath)
3136 Mangler.mangleName(RD);
Reid Kleckner7810af02013-06-19 15:20:38 +00003137 Mangler.getStream() << '@';
3138}
3139
David Majnemera96b7ee2014-05-13 00:44:44 +00003140void MicrosoftMangleContextImpl::mangleCXXRTTI(QualType T, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003141 msvc_hashing_ostream MHO(Out);
3142 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Klecknerfb931542018-03-16 20:36:49 +00003143 Mangler.getStream() << "??_R0";
David Majnemera96b7ee2014-05-13 00:44:44 +00003144 Mangler.mangleType(T, SourceRange(), MicrosoftCXXNameMangler::QMM_Result);
3145 Mangler.getStream() << "@8";
Guy Benyei11169dd2012-12-18 14:30:41 +00003146}
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003147
David Majnemera96b7ee2014-05-13 00:44:44 +00003148void MicrosoftMangleContextImpl::mangleCXXRTTIName(QualType T,
3149 raw_ostream &Out) {
3150 MicrosoftCXXNameMangler Mangler(*this, Out);
3151 Mangler.getStream() << '.';
3152 Mangler.mangleType(T, SourceRange(), MicrosoftCXXNameMangler::QMM_Result);
3153}
3154
David Majnemerc1709d32015-06-23 07:31:11 +00003155void MicrosoftMangleContextImpl::mangleCXXVirtualDisplacementMap(
3156 const CXXRecordDecl *SrcRD, const CXXRecordDecl *DstRD, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003157 msvc_hashing_ostream MHO(Out);
3158 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Klecknerfb931542018-03-16 20:36:49 +00003159 Mangler.getStream() << "??_K";
David Majnemerc1709d32015-06-23 07:31:11 +00003160 Mangler.mangleName(SrcRD);
3161 Mangler.getStream() << "$C";
3162 Mangler.mangleName(DstRD);
3163}
3164
David Majnemer526793d2016-07-12 04:42:50 +00003165void MicrosoftMangleContextImpl::mangleCXXThrowInfo(QualType T, bool IsConst,
David Majnemer7c237072015-03-05 00:46:22 +00003166 bool IsVolatile,
David Majnemer526793d2016-07-12 04:42:50 +00003167 bool IsUnaligned,
David Majnemer7c237072015-03-05 00:46:22 +00003168 uint32_t NumEntries,
3169 raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003170 msvc_hashing_ostream MHO(Out);
3171 MicrosoftCXXNameMangler Mangler(*this, MHO);
David Majnemer7c237072015-03-05 00:46:22 +00003172 Mangler.getStream() << "_TI";
3173 if (IsConst)
3174 Mangler.getStream() << 'C';
3175 if (IsVolatile)
3176 Mangler.getStream() << 'V';
David Majnemer526793d2016-07-12 04:42:50 +00003177 if (IsUnaligned)
3178 Mangler.getStream() << 'U';
David Majnemer7c237072015-03-05 00:46:22 +00003179 Mangler.getStream() << NumEntries;
3180 Mangler.mangleType(T, SourceRange(), MicrosoftCXXNameMangler::QMM_Result);
3181}
3182
3183void MicrosoftMangleContextImpl::mangleCXXCatchableTypeArray(
3184 QualType T, uint32_t NumEntries, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003185 msvc_hashing_ostream MHO(Out);
3186 MicrosoftCXXNameMangler Mangler(*this, MHO);
David Majnemer7c237072015-03-05 00:46:22 +00003187 Mangler.getStream() << "_CTA";
3188 Mangler.getStream() << NumEntries;
3189 Mangler.mangleType(T, SourceRange(), MicrosoftCXXNameMangler::QMM_Result);
3190}
3191
David Majnemere7a818f2015-03-06 18:53:55 +00003192void MicrosoftMangleContextImpl::mangleCXXCatchableType(
David Majnemerdfa6d202015-03-11 18:36:39 +00003193 QualType T, const CXXConstructorDecl *CD, CXXCtorType CT, uint32_t Size,
3194 uint32_t NVOffset, int32_t VBPtrOffset, uint32_t VBIndex,
3195 raw_ostream &Out) {
David Majnemer7c237072015-03-05 00:46:22 +00003196 MicrosoftCXXNameMangler Mangler(*this, Out);
David Majnemere7a818f2015-03-06 18:53:55 +00003197 Mangler.getStream() << "_CT";
3198
3199 llvm::SmallString<64> RTTIMangling;
3200 {
3201 llvm::raw_svector_ostream Stream(RTTIMangling);
David Majnemerfebb2722016-03-07 08:51:17 +00003202 msvc_hashing_ostream MHO(Stream);
3203 mangleCXXRTTI(T, MHO);
David Majnemere7a818f2015-03-06 18:53:55 +00003204 }
Reid Klecknerfb931542018-03-16 20:36:49 +00003205 Mangler.getStream() << RTTIMangling;
David Majnemere7a818f2015-03-06 18:53:55 +00003206
Nico Webere3b1f5d2019-05-29 13:48:19 +00003207 // VS2015 and VS2017.1 omit the copy-constructor in the mangled name but
3208 // both older and newer versions include it.
3209 // FIXME: It is known that the Ctor is present in 2013, and in 2017.7
3210 // (_MSC_VER 1914) and newer, and that it's omitted in 2015 and 2017.4
3211 // (_MSC_VER 1911), but it's unknown when exactly it reappeared (1914?
3212 // Or 1912, 1913 aleady?).
3213 bool OmitCopyCtor = getASTContext().getLangOpts().isCompatibleWithMSVC(
3214 LangOptions::MSVC2015) &&
3215 !getASTContext().getLangOpts().isCompatibleWithMSVC(
3216 LangOptions::MSVC2017_7);
David Majnemere7a818f2015-03-06 18:53:55 +00003217 llvm::SmallString<64> CopyCtorMangling;
Nico Webere3b1f5d2019-05-29 13:48:19 +00003218 if (!OmitCopyCtor && CD) {
David Majnemere7a818f2015-03-06 18:53:55 +00003219 llvm::raw_svector_ostream Stream(CopyCtorMangling);
David Majnemerfebb2722016-03-07 08:51:17 +00003220 msvc_hashing_ostream MHO(Stream);
3221 mangleCXXCtor(CD, CT, MHO);
David Majnemere7a818f2015-03-06 18:53:55 +00003222 }
Reid Klecknerfb931542018-03-16 20:36:49 +00003223 Mangler.getStream() << CopyCtorMangling;
David Majnemere7a818f2015-03-06 18:53:55 +00003224
David Majnemer7c237072015-03-05 00:46:22 +00003225 Mangler.getStream() << Size;
David Majnemer999cbf92015-03-10 19:01:51 +00003226 if (VBPtrOffset == -1) {
3227 if (NVOffset) {
3228 Mangler.getStream() << NVOffset;
3229 }
3230 } else {
3231 Mangler.getStream() << NVOffset;
3232 Mangler.getStream() << VBPtrOffset;
3233 Mangler.getStream() << VBIndex;
3234 }
David Majnemer7c237072015-03-05 00:46:22 +00003235}
3236
David Majnemera96b7ee2014-05-13 00:44:44 +00003237void MicrosoftMangleContextImpl::mangleCXXRTTIBaseClassDescriptor(
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00003238 const CXXRecordDecl *Derived, uint32_t NVOffset, int32_t VBPtrOffset,
David Majnemeraeb55c92014-05-13 06:57:43 +00003239 uint32_t VBTableOffset, uint32_t Flags, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003240 msvc_hashing_ostream MHO(Out);
3241 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Klecknerfb931542018-03-16 20:36:49 +00003242 Mangler.getStream() << "??_R1";
David Majnemera96b7ee2014-05-13 00:44:44 +00003243 Mangler.mangleNumber(NVOffset);
3244 Mangler.mangleNumber(VBPtrOffset);
3245 Mangler.mangleNumber(VBTableOffset);
3246 Mangler.mangleNumber(Flags);
David Majnemeraeb55c92014-05-13 06:57:43 +00003247 Mangler.mangleName(Derived);
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00003248 Mangler.getStream() << "8";
David Majnemera96b7ee2014-05-13 00:44:44 +00003249}
3250
3251void MicrosoftMangleContextImpl::mangleCXXRTTIBaseClassArray(
3252 const CXXRecordDecl *Derived, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003253 msvc_hashing_ostream MHO(Out);
3254 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Klecknerfb931542018-03-16 20:36:49 +00003255 Mangler.getStream() << "??_R2";
David Majnemera96b7ee2014-05-13 00:44:44 +00003256 Mangler.mangleName(Derived);
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00003257 Mangler.getStream() << "8";
David Majnemera96b7ee2014-05-13 00:44:44 +00003258}
3259
3260void MicrosoftMangleContextImpl::mangleCXXRTTIClassHierarchyDescriptor(
3261 const CXXRecordDecl *Derived, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003262 msvc_hashing_ostream MHO(Out);
3263 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Klecknerfb931542018-03-16 20:36:49 +00003264 Mangler.getStream() << "??_R3";
David Majnemera96b7ee2014-05-13 00:44:44 +00003265 Mangler.mangleName(Derived);
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00003266 Mangler.getStream() << "8";
David Majnemera96b7ee2014-05-13 00:44:44 +00003267}
3268
3269void MicrosoftMangleContextImpl::mangleCXXRTTICompleteObjectLocator(
David Majnemeraeb55c92014-05-13 06:57:43 +00003270 const CXXRecordDecl *Derived, ArrayRef<const CXXRecordDecl *> BasePath,
3271 raw_ostream &Out) {
3272 // <mangled-name> ::= ?_R4 <class-name> <storage-class>
3273 // <cvr-qualifiers> [<name>] @
3274 // NOTE: <cvr-qualifiers> here is always 'B' (const). <storage-class>
3275 // is always '6' for vftables.
David Majnemerfebb2722016-03-07 08:51:17 +00003276 llvm::SmallString<64> VFTableMangling;
3277 llvm::raw_svector_ostream Stream(VFTableMangling);
3278 mangleCXXVFTable(Derived, BasePath, Stream);
3279
Reid Klecknerfb931542018-03-16 20:36:49 +00003280 if (VFTableMangling.startswith("??@")) {
David Majnemerfebb2722016-03-07 08:51:17 +00003281 assert(VFTableMangling.endswith("@"));
3282 Out << VFTableMangling << "??_R4@";
3283 return;
3284 }
3285
Reid Klecknerfb931542018-03-16 20:36:49 +00003286 assert(VFTableMangling.startswith("??_7") ||
3287 VFTableMangling.startswith("??_S"));
David Majnemerfebb2722016-03-07 08:51:17 +00003288
Reid Klecknerfb931542018-03-16 20:36:49 +00003289 Out << "??_R4" << StringRef(VFTableMangling).drop_front(4);
Guy Benyei11169dd2012-12-18 14:30:41 +00003290}
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003291
Reid Kleckner1d59f992015-01-22 01:36:17 +00003292void MicrosoftMangleContextImpl::mangleSEHFilterExpression(
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 Kleckner1d59f992015-01-22 01:36:17 +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> ::= ?filt$ <filter-number> @0
Reid Klecknerfb931542018-03-16 20:36:49 +00003300 Mangler.getStream() << "?filt$" << SEHFilterIds[EnclosingDecl]++ << "@0@";
Reid Kleckner1d59f992015-01-22 01:36:17 +00003301 Mangler.mangleName(EnclosingDecl);
3302}
3303
Reid Klecknerebaf28d2015-04-14 20:59:00 +00003304void MicrosoftMangleContextImpl::mangleSEHFinallyBlock(
3305 const NamedDecl *EnclosingDecl, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003306 msvc_hashing_ostream MHO(Out);
3307 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00003308 // The function body is in the same comdat as the function with the handler,
3309 // so the numbering here doesn't have to be the same across TUs.
3310 //
3311 // <mangled-name> ::= ?fin$ <filter-number> @0
Reid Klecknerfb931542018-03-16 20:36:49 +00003312 Mangler.getStream() << "?fin$" << SEHFinallyIds[EnclosingDecl]++ << "@0@";
Reid Klecknerebaf28d2015-04-14 20:59:00 +00003313 Mangler.mangleName(EnclosingDecl);
3314}
3315
Reid Klecknercc99e262013-11-19 23:23:00 +00003316void MicrosoftMangleContextImpl::mangleTypeName(QualType T, raw_ostream &Out) {
3317 // This is just a made up unique string for the purposes of tbaa. undname
3318 // does *not* know how to demangle it.
3319 MicrosoftCXXNameMangler Mangler(*this, Out);
3320 Mangler.getStream() << '?';
3321 Mangler.mangleType(T, SourceRange());
3322}
3323
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003324void MicrosoftMangleContextImpl::mangleCXXCtor(const CXXConstructorDecl *D,
3325 CXXCtorType Type,
3326 raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003327 msvc_hashing_ostream MHO(Out);
3328 MicrosoftCXXNameMangler mangler(*this, MHO, D, Type);
Guy Benyei11169dd2012-12-18 14:30:41 +00003329 mangler.mangle(D);
3330}
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003331
3332void MicrosoftMangleContextImpl::mangleCXXDtor(const CXXDestructorDecl *D,
3333 CXXDtorType Type,
3334 raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003335 msvc_hashing_ostream MHO(Out);
3336 MicrosoftCXXNameMangler mangler(*this, MHO, D, Type);
Guy Benyei11169dd2012-12-18 14:30:41 +00003337 mangler.mangle(D);
3338}
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003339
David Majnemere77de752015-12-29 22:25:14 +00003340void MicrosoftMangleContextImpl::mangleReferenceTemporary(
3341 const VarDecl *VD, unsigned ManglingNumber, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003342 msvc_hashing_ostream MHO(Out);
3343 MicrosoftCXXNameMangler Mangler(*this, MHO);
David Majnemere77de752015-12-29 22:25:14 +00003344
Reid Klecknerfb931542018-03-16 20:36:49 +00003345 Mangler.getStream() << "?$RT" << ManglingNumber << '@';
David Majnemere77de752015-12-29 22:25:14 +00003346 Mangler.mangle(VD, "");
Guy Benyei11169dd2012-12-18 14:30:41 +00003347}
3348
David Majnemer8354eee2015-05-07 06:15:46 +00003349void MicrosoftMangleContextImpl::mangleThreadSafeStaticGuardVariable(
3350 const VarDecl *VD, unsigned GuardNum, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003351 msvc_hashing_ostream MHO(Out);
3352 MicrosoftCXXNameMangler Mangler(*this, MHO);
David Majnemer8354eee2015-05-07 06:15:46 +00003353
Reid Klecknerfb931542018-03-16 20:36:49 +00003354 Mangler.getStream() << "?$TSS" << GuardNum << '@';
David Majnemer8354eee2015-05-07 06:15:46 +00003355 Mangler.mangleNestedName(VD);
Dmitry Polukhin5fa681e2016-05-27 08:52:34 +00003356 Mangler.getStream() << "@4HA";
David Majnemer8354eee2015-05-07 06:15:46 +00003357}
3358
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003359void MicrosoftMangleContextImpl::mangleStaticGuardVariable(const VarDecl *VD,
3360 raw_ostream &Out) {
David Majnemer2206bf52014-03-05 08:57:59 +00003361 // <guard-name> ::= ?_B <postfix> @5 <scope-depth>
David Majnemerec8e54b2015-05-07 21:19:06 +00003362 // ::= ?__J <postfix> @5 <scope-depth>
Reid Klecknerd8110b62013-09-10 20:14:30 +00003363 // ::= ?$S <guard-num> @ <postfix> @4IA
3364
3365 // The first mangling is what MSVC uses to guard static locals in inline
3366 // functions. It uses a different mangling in external functions to support
3367 // guarding more than 32 variables. MSVC rejects inline functions with more
3368 // than 32 static locals. We don't fully implement the second mangling
3369 // because those guards are not externally visible, and instead use LLVM's
3370 // default renaming when creating a new guard variable.
David Majnemerfebb2722016-03-07 08:51:17 +00003371 msvc_hashing_ostream MHO(Out);
3372 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Klecknerd8110b62013-09-10 20:14:30 +00003373
3374 bool Visible = VD->isExternallyVisible();
David Majnemer8354eee2015-05-07 06:15:46 +00003375 if (Visible) {
Reid Klecknerfb931542018-03-16 20:36:49 +00003376 Mangler.getStream() << (VD->getTLSKind() ? "??__J" : "??_B");
David Majnemer8354eee2015-05-07 06:15:46 +00003377 } else {
Reid Klecknerfb931542018-03-16 20:36:49 +00003378 Mangler.getStream() << "?$S1@";
David Majnemer8354eee2015-05-07 06:15:46 +00003379 }
David Majnemer34b49892014-03-06 19:57:36 +00003380 unsigned ScopeDepth = 0;
3381 if (Visible && !getNextDiscriminator(VD, ScopeDepth))
3382 // If we do not have a discriminator and are emitting a guard variable for
3383 // use at global scope, then mangling the nested name will not be enough to
3384 // remove ambiguities.
3385 Mangler.mangle(VD, "");
3386 else
3387 Mangler.mangleNestedName(VD);
David Majnemer2206bf52014-03-05 08:57:59 +00003388 Mangler.getStream() << (Visible ? "@5" : "@4IA");
David Majnemer34b49892014-03-06 19:57:36 +00003389 if (ScopeDepth)
David Majnemer2206bf52014-03-05 08:57:59 +00003390 Mangler.mangleNumber(ScopeDepth);
Reid Klecknerd8110b62013-09-10 20:14:30 +00003391}
3392
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003393void MicrosoftMangleContextImpl::mangleInitFiniStub(const VarDecl *D,
David Majnemerfebb2722016-03-07 08:51:17 +00003394 char CharCode,
3395 raw_ostream &Out) {
3396 msvc_hashing_ostream MHO(Out);
3397 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Klecknerfb931542018-03-16 20:36:49 +00003398 Mangler.getStream() << "??__" << CharCode;
David Majnemerf55feec2014-03-06 19:10:27 +00003399 if (D->isStaticDataMember()) {
Zachary Turnerf4f767d2018-08-30 20:53:11 +00003400 Mangler.getStream() << '?';
3401 Mangler.mangleName(D);
David Majnemerf55feec2014-03-06 19:10:27 +00003402 Mangler.mangleVariableEncoding(D);
Zachary Turnerf4f767d2018-08-30 20:53:11 +00003403 Mangler.getStream() << "@@";
3404 } else {
3405 Mangler.mangleName(D);
David Majnemerf55feec2014-03-06 19:10:27 +00003406 }
Reid Kleckner1ece9fc2013-09-10 20:43:12 +00003407 // This is the function class mangling. These stubs are global, non-variadic,
3408 // cdecl functions that return void and take no args.
3409 Mangler.getStream() << "YAXXZ";
3410}
3411
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003412void MicrosoftMangleContextImpl::mangleDynamicInitializer(const VarDecl *D,
3413 raw_ostream &Out) {
Reid Kleckner1ece9fc2013-09-10 20:43:12 +00003414 // <initializer-name> ::= ?__E <name> YAXXZ
David Majnemerfebb2722016-03-07 08:51:17 +00003415 mangleInitFiniStub(D, 'E', Out);
Reid Kleckner1ece9fc2013-09-10 20:43:12 +00003416}
3417
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003418void
3419MicrosoftMangleContextImpl::mangleDynamicAtExitDestructor(const VarDecl *D,
3420 raw_ostream &Out) {
Reid Kleckner1ece9fc2013-09-10 20:43:12 +00003421 // <destructor-name> ::= ?__F <name> YAXXZ
David Majnemerfebb2722016-03-07 08:51:17 +00003422 mangleInitFiniStub(D, 'F', Out);
Reid Klecknerd8110b62013-09-10 20:14:30 +00003423}
3424
David Majnemer58e5bee2014-03-24 21:43:36 +00003425void MicrosoftMangleContextImpl::mangleStringLiteral(const StringLiteral *SL,
3426 raw_ostream &Out) {
Nico Webera2d9c2b2018-07-02 12:31:20 +00003427 // <char-type> ::= 0 # char, char16_t, char32_t
3428 // # (little endian char data in mangling)
3429 // ::= 1 # wchar_t (big endian char data in mangling)
David Majnemer58e5bee2014-03-24 21:43:36 +00003430 //
3431 // <literal-length> ::= <non-negative integer> # the length of the literal
3432 //
3433 // <encoded-crc> ::= <hex digit>+ @ # crc of the literal including
Hans Wennborg7525edc2018-07-06 06:54:16 +00003434 // # trailing null bytes
David Majnemer58e5bee2014-03-24 21:43:36 +00003435 //
3436 // <encoded-string> ::= <simple character> # uninteresting character
3437 // ::= '?$' <hex digit> <hex digit> # these two nibbles
3438 // # encode the byte for the
3439 // # character
3440 // ::= '?' [a-z] # \xe1 - \xfa
3441 // ::= '?' [A-Z] # \xc1 - \xda
3442 // ::= '?' [0-9] # [,/\:. \n\t'-]
3443 //
3444 // <literal> ::= '??_C@_' <char-type> <literal-length> <encoded-crc>
3445 // <encoded-string> '@'
3446 MicrosoftCXXNameMangler Mangler(*this, Out);
Reid Klecknerfb931542018-03-16 20:36:49 +00003447 Mangler.getStream() << "??_C@_";
David Majnemer58e5bee2014-03-24 21:43:36 +00003448
Hans Wennborg7525edc2018-07-06 06:54:16 +00003449 // The actual string length might be different from that of the string literal
3450 // in cases like:
3451 // char foo[3] = "foobar";
3452 // char bar[42] = "foobar";
3453 // Where it is truncated or zero-padded to fit the array. This is the length
3454 // used for mangling, and any trailing null-bytes also need to be mangled.
3455 unsigned StringLength = getASTContext()
3456 .getAsConstantArrayType(SL->getType())
3457 ->getSize()
3458 .getZExtValue();
3459 unsigned StringByteLength = StringLength * SL->getCharByteWidth();
3460
David Majnemer58e5bee2014-03-24 21:43:36 +00003461 // <char-type>: The "kind" of string literal is encoded into the mangled name.
David Majnemer98e77a22014-11-21 19:57:25 +00003462 if (SL->isWide())
David Majnemer58e5bee2014-03-24 21:43:36 +00003463 Mangler.getStream() << '1';
3464 else
David Majnemer98e77a22014-11-21 19:57:25 +00003465 Mangler.getStream() << '0';
David Majnemer58e5bee2014-03-24 21:43:36 +00003466
3467 // <literal-length>: The next part of the mangled name consists of the length
Hans Wennborg7525edc2018-07-06 06:54:16 +00003468 // of the string in bytes.
3469 Mangler.mangleNumber(StringByteLength);
David Majnemer58e5bee2014-03-24 21:43:36 +00003470
Malcolm Parsonsc6e45832017-01-13 18:55:32 +00003471 auto GetLittleEndianByte = [&SL](unsigned Index) {
David Majnemer4b293eb2014-03-31 17:18:53 +00003472 unsigned CharByteWidth = SL->getCharByteWidth();
Hans Wennborg7525edc2018-07-06 06:54:16 +00003473 if (Index / CharByteWidth >= SL->getLength())
3474 return static_cast<char>(0);
David Majnemer4b293eb2014-03-31 17:18:53 +00003475 uint32_t CodeUnit = SL->getCodeUnit(Index / CharByteWidth);
David Majnemere49c4b62014-03-31 21:46:05 +00003476 unsigned OffsetInCodeUnit = Index % CharByteWidth;
3477 return static_cast<char>((CodeUnit >> (8 * OffsetInCodeUnit)) & 0xff);
David Majnemer4b293eb2014-03-31 17:18:53 +00003478 };
3479
Malcolm Parsonsc6e45832017-01-13 18:55:32 +00003480 auto GetBigEndianByte = [&SL](unsigned Index) {
David Majnemer4b293eb2014-03-31 17:18:53 +00003481 unsigned CharByteWidth = SL->getCharByteWidth();
Hans Wennborg7525edc2018-07-06 06:54:16 +00003482 if (Index / CharByteWidth >= SL->getLength())
3483 return static_cast<char>(0);
David Majnemer4b293eb2014-03-31 17:18:53 +00003484 uint32_t CodeUnit = SL->getCodeUnit(Index / CharByteWidth);
David Majnemere49c4b62014-03-31 21:46:05 +00003485 unsigned OffsetInCodeUnit = (CharByteWidth - 1) - (Index % CharByteWidth);
3486 return static_cast<char>((CodeUnit >> (8 * OffsetInCodeUnit)) & 0xff);
David Majnemer4b293eb2014-03-31 17:18:53 +00003487 };
3488
David Majnemer58e5bee2014-03-24 21:43:36 +00003489 // CRC all the bytes of the StringLiteral.
David Majnemerb8ed3642015-09-01 21:24:07 +00003490 llvm::JamCRC JC;
Hans Wennborg7525edc2018-07-06 06:54:16 +00003491 for (unsigned I = 0, E = StringByteLength; I != E; ++I)
David Majnemerb8ed3642015-09-01 21:24:07 +00003492 JC.update(GetLittleEndianByte(I));
David Majnemer58e5bee2014-03-24 21:43:36 +00003493
David Majnemer58e5bee2014-03-24 21:43:36 +00003494 // <encoded-crc>: The CRC is encoded utilizing the standard number mangling
3495 // scheme.
David Majnemerb8ed3642015-09-01 21:24:07 +00003496 Mangler.mangleNumber(JC.getCRC());
David Majnemer58e5bee2014-03-24 21:43:36 +00003497
Nico Webera2d9c2b2018-07-02 12:31:20 +00003498 // <encoded-string>: The mangled name also contains the first 32 bytes
3499 // (including null-terminator bytes) of the encoded StringLiteral.
David Majnemer58e5bee2014-03-24 21:43:36 +00003500 // Each character is encoded by splitting them into bytes and then encoding
3501 // the constituent bytes.
3502 auto MangleByte = [&Mangler](char Byte) {
3503 // There are five different manglings for characters:
3504 // - [a-zA-Z0-9_$]: A one-to-one mapping.
3505 // - ?[a-z]: The range from \xe1 to \xfa.
3506 // - ?[A-Z]: The range from \xc1 to \xda.
3507 // - ?[0-9]: The set of [,/\:. \n\t'-].
3508 // - ?$XX: A fallback which maps nibbles.
David Majnemer10befcf2014-04-01 00:05:57 +00003509 if (isIdentifierBody(Byte, /*AllowDollar=*/true)) {
David Majnemer58e5bee2014-03-24 21:43:36 +00003510 Mangler.getStream() << Byte;
David Majnemer10befcf2014-04-01 00:05:57 +00003511 } else if (isLetter(Byte & 0x7f)) {
3512 Mangler.getStream() << '?' << static_cast<char>(Byte & 0x7f);
David Majnemer58e5bee2014-03-24 21:43:36 +00003513 } else {
David Majnemer07bc6112014-12-22 06:24:49 +00003514 const char SpecialChars[] = {',', '/', '\\', ':', '.',
3515 ' ', '\n', '\t', '\'', '-'};
Fangrui Song75e74e02019-03-31 08:48:19 +00003516 const char *Pos = llvm::find(SpecialChars, Byte);
David Majnemer07bc6112014-12-22 06:24:49 +00003517 if (Pos != std::end(SpecialChars)) {
3518 Mangler.getStream() << '?' << (Pos - std::begin(SpecialChars));
3519 } else {
3520 Mangler.getStream() << "?$";
3521 Mangler.getStream() << static_cast<char>('A' + ((Byte >> 4) & 0xf));
3522 Mangler.getStream() << static_cast<char>('A' + (Byte & 0xf));
David Majnemer58e5bee2014-03-24 21:43:36 +00003523 }
3524 }
3525 };
3526
Nico Webera2d9c2b2018-07-02 12:31:20 +00003527 // Enforce our 32 bytes max, except wchar_t which gets 32 chars instead.
3528 unsigned MaxBytesToMangle = SL->isWide() ? 64U : 32U;
Hans Wennborg7525edc2018-07-06 06:54:16 +00003529 unsigned NumBytesToMangle = std::min(MaxBytesToMangle, StringByteLength);
3530 for (unsigned I = 0; I != NumBytesToMangle; ++I) {
David Majnemer98e77a22014-11-21 19:57:25 +00003531 if (SL->isWide())
3532 MangleByte(GetBigEndianByte(I));
3533 else
3534 MangleByte(GetLittleEndianByte(I));
Hans Wennborg7525edc2018-07-06 06:54:16 +00003535 }
David Majnemer58e5bee2014-03-24 21:43:36 +00003536
3537 Mangler.getStream() << '@';
3538}
3539
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003540MicrosoftMangleContext *
3541MicrosoftMangleContext::create(ASTContext &Context, DiagnosticsEngine &Diags) {
3542 return new MicrosoftMangleContextImpl(Context, Diags);
Guy Benyei11169dd2012-12-18 14:30:41 +00003543}