blob: a021e7162e44242d9e4eee332e38a4f47a72e8df [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"
David Majnemerb8ed3642015-09-01 21:24:07 +000030#include "llvm/Support/JamCRC.h"
Reid Klecknerdf8dd612018-08-17 20:59:27 +000031#include "llvm/Support/xxhash.h"
David Majnemerfebb2722016-03-07 08:51:17 +000032#include "llvm/Support/MD5.h"
33#include "llvm/Support/MathExtras.h"
David Majnemer3843a052014-03-23 17:47:16 +000034
Guy Benyei11169dd2012-12-18 14:30:41 +000035using namespace clang;
36
37namespace {
38
David Majnemerfebb2722016-03-07 08:51:17 +000039struct msvc_hashing_ostream : public llvm::raw_svector_ostream {
40 raw_ostream &OS;
41 llvm::SmallString<64> Buffer;
42
43 msvc_hashing_ostream(raw_ostream &OS)
44 : llvm::raw_svector_ostream(Buffer), OS(OS) {}
45 ~msvc_hashing_ostream() override {
46 StringRef MangledName = str();
47 bool StartsWithEscape = MangledName.startswith("\01");
48 if (StartsWithEscape)
49 MangledName = MangledName.drop_front(1);
50 if (MangledName.size() <= 4096) {
51 OS << str();
52 return;
53 }
54
55 llvm::MD5 Hasher;
56 llvm::MD5::MD5Result Hash;
57 Hasher.update(MangledName);
58 Hasher.final(Hash);
59
60 SmallString<32> HexString;
61 llvm::MD5::stringifyResult(Hash, HexString);
62
63 if (StartsWithEscape)
64 OS << '\01';
65 OS << "??@" << HexString << '@';
66 }
67};
68
David Majnemer984498f2016-12-06 17:01:02 +000069static const DeclContext *
70getLambdaDefaultArgumentDeclContext(const Decl *D) {
71 if (const auto *RD = dyn_cast<CXXRecordDecl>(D))
72 if (RD->isLambda())
73 if (const auto *Parm =
74 dyn_cast_or_null<ParmVarDecl>(RD->getLambdaContextDecl()))
75 return Parm->getDeclContext();
76 return nullptr;
77}
78
Adrian Prantl9fc8faf2018-05-09 01:00:01 +000079/// Retrieve the declaration context that should be used when mangling
David Majnemerd5a42b82013-09-13 09:03:14 +000080/// the given declaration.
81static const DeclContext *getEffectiveDeclContext(const Decl *D) {
82 // The ABI assumes that lambda closure types that occur within
83 // default arguments live in the context of the function. However, due to
84 // the way in which Clang parses and creates function declarations, this is
85 // not the case: the lambda closure type ends up living in the context
86 // where the function itself resides, because the function declaration itself
87 // had not yet been created. Fix the context here.
David Majnemer984498f2016-12-06 17:01:02 +000088 if (const auto *LDADC = getLambdaDefaultArgumentDeclContext(D))
89 return LDADC;
David Majnemerd5a42b82013-09-13 09:03:14 +000090
91 // Perform the same check for block literals.
92 if (const BlockDecl *BD = dyn_cast<BlockDecl>(D)) {
93 if (ParmVarDecl *ContextParam =
94 dyn_cast_or_null<ParmVarDecl>(BD->getBlockManglingContextDecl()))
95 return ContextParam->getDeclContext();
96 }
97
98 const DeclContext *DC = D->getDeclContext();
Michael Kruse251e1482019-02-01 20:25:04 +000099 if (isa<CapturedDecl>(DC) || isa<OMPDeclareReductionDecl>(DC) ||
100 isa<OMPDeclareMapperDecl>(DC)) {
Alexey Bataev94a4f0c2016-03-03 05:21:39 +0000101 return getEffectiveDeclContext(cast<Decl>(DC));
102 }
David Majnemerd5a42b82013-09-13 09:03:14 +0000103
David Majnemerb0f1dbd2016-05-19 18:15:53 +0000104 return DC->getRedeclContext();
David Majnemerd5a42b82013-09-13 09:03:14 +0000105}
106
107static const DeclContext *getEffectiveParentContext(const DeclContext *DC) {
108 return getEffectiveDeclContext(cast<Decl>(DC));
109}
110
David Majnemerdfa6d202015-03-11 18:36:39 +0000111static const FunctionDecl *getStructor(const NamedDecl *ND) {
112 if (const auto *FTD = dyn_cast<FunctionTemplateDecl>(ND))
Reid Kleckner290feb92017-01-09 17:04:37 +0000113 return FTD->getTemplatedDecl()->getCanonicalDecl();
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +0000114
David Majnemerdfa6d202015-03-11 18:36:39 +0000115 const auto *FD = cast<FunctionDecl>(ND);
116 if (const auto *FTD = FD->getPrimaryTemplate())
Reid Kleckner290feb92017-01-09 17:04:37 +0000117 return FTD->getTemplatedDecl()->getCanonicalDecl();
David Majnemerdfa6d202015-03-11 18:36:39 +0000118
Reid Kleckner290feb92017-01-09 17:04:37 +0000119 return FD->getCanonicalDecl();
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +0000120}
121
Timur Iskhodzhanov67455222013-10-03 06:26:13 +0000122/// MicrosoftMangleContextImpl - Overrides the default MangleContext for the
Guy Benyei11169dd2012-12-18 14:30:41 +0000123/// Microsoft Visual C++ ABI.
Timur Iskhodzhanov67455222013-10-03 06:26:13 +0000124class MicrosoftMangleContextImpl : public MicrosoftMangleContext {
David Majnemer2206bf52014-03-05 08:57:59 +0000125 typedef std::pair<const DeclContext *, IdentifierInfo *> DiscriminatorKeyTy;
126 llvm::DenseMap<DiscriminatorKeyTy, unsigned> Discriminator;
David Majnemer02e9af42014-04-23 05:16:51 +0000127 llvm::DenseMap<const NamedDecl *, unsigned> Uniquifier;
David Majnemerf017ec32014-03-05 10:35:06 +0000128 llvm::DenseMap<const CXXRecordDecl *, unsigned> LambdaIds;
Reid Kleckner1d59f992015-01-22 01:36:17 +0000129 llvm::DenseMap<const NamedDecl *, unsigned> SEHFilterIds;
Reid Klecknerebaf28d2015-04-14 20:59:00 +0000130 llvm::DenseMap<const NamedDecl *, unsigned> SEHFinallyIds;
Reid Klecknerdf8dd612018-08-17 20:59:27 +0000131 SmallString<16> AnonymousNamespaceHash;
David Majnemer2206bf52014-03-05 08:57:59 +0000132
Guy Benyei11169dd2012-12-18 14:30:41 +0000133public:
Reid Klecknerdf8dd612018-08-17 20:59:27 +0000134 MicrosoftMangleContextImpl(ASTContext &Context, DiagnosticsEngine &Diags);
Craig Toppercbce6e92014-03-11 06:22:39 +0000135 bool shouldMangleCXXName(const NamedDecl *D) override;
David Majnemer58e5bee2014-03-24 21:43:36 +0000136 bool shouldMangleStringLiteral(const StringLiteral *SL) override;
Craig Toppercbce6e92014-03-11 06:22:39 +0000137 void mangleCXXName(const NamedDecl *D, raw_ostream &Out) override;
David Majnemer02e9af42014-04-23 05:16:51 +0000138 void mangleVirtualMemPtrThunk(const CXXMethodDecl *MD,
Reid Klecknercbec0262018-04-02 20:00:39 +0000139 const MethodVFTableLocation &ML,
140 raw_ostream &Out) override;
Craig Toppercbce6e92014-03-11 06:22:39 +0000141 void mangleThunk(const CXXMethodDecl *MD, const ThunkInfo &Thunk,
142 raw_ostream &) override;
143 void mangleCXXDtorThunk(const CXXDestructorDecl *DD, CXXDtorType Type,
144 const ThisAdjustment &ThisAdjustment,
145 raw_ostream &) override;
146 void mangleCXXVFTable(const CXXRecordDecl *Derived,
147 ArrayRef<const CXXRecordDecl *> BasePath,
148 raw_ostream &Out) override;
149 void mangleCXXVBTable(const CXXRecordDecl *Derived,
150 ArrayRef<const CXXRecordDecl *> BasePath,
151 raw_ostream &Out) override;
David Majnemerc1709d32015-06-23 07:31:11 +0000152 void mangleCXXVirtualDisplacementMap(const CXXRecordDecl *SrcRD,
153 const CXXRecordDecl *DstRD,
154 raw_ostream &Out) override;
David Majnemer7c237072015-03-05 00:46:22 +0000155 void mangleCXXThrowInfo(QualType T, bool IsConst, bool IsVolatile,
David Majnemer526793d2016-07-12 04:42:50 +0000156 bool IsUnaligned, uint32_t NumEntries,
157 raw_ostream &Out) override;
David Majnemer7c237072015-03-05 00:46:22 +0000158 void mangleCXXCatchableTypeArray(QualType T, uint32_t NumEntries,
159 raw_ostream &Out) override;
David Majnemere7a818f2015-03-06 18:53:55 +0000160 void mangleCXXCatchableType(QualType T, const CXXConstructorDecl *CD,
David Majnemerdfa6d202015-03-11 18:36:39 +0000161 CXXCtorType CT, uint32_t Size, uint32_t NVOffset,
David Majnemer999cbf92015-03-10 19:01:51 +0000162 int32_t VBPtrOffset, uint32_t VBIndex,
163 raw_ostream &Out) override;
David Majnemera96b7ee2014-05-13 00:44:44 +0000164 void mangleCXXRTTI(QualType T, raw_ostream &Out) override;
165 void mangleCXXRTTIName(QualType T, raw_ostream &Out) override;
David Majnemeraeb55c92014-05-13 06:57:43 +0000166 void mangleCXXRTTIBaseClassDescriptor(const CXXRecordDecl *Derived,
Warren Hunt5c2b4ea2014-05-23 16:07:43 +0000167 uint32_t NVOffset, int32_t VBPtrOffset,
David Majnemeraeb55c92014-05-13 06:57:43 +0000168 uint32_t VBTableOffset, uint32_t Flags,
169 raw_ostream &Out) override;
David Majnemera96b7ee2014-05-13 00:44:44 +0000170 void mangleCXXRTTIBaseClassArray(const CXXRecordDecl *Derived,
171 raw_ostream &Out) override;
172 void mangleCXXRTTIClassHierarchyDescriptor(const CXXRecordDecl *Derived,
173 raw_ostream &Out) override;
David Majnemeraeb55c92014-05-13 06:57:43 +0000174 void
175 mangleCXXRTTICompleteObjectLocator(const CXXRecordDecl *Derived,
176 ArrayRef<const CXXRecordDecl *> BasePath,
177 raw_ostream &Out) override;
Craig Toppercbce6e92014-03-11 06:22:39 +0000178 void mangleTypeName(QualType T, raw_ostream &) override;
179 void mangleCXXCtor(const CXXConstructorDecl *D, CXXCtorType Type,
180 raw_ostream &) override;
181 void mangleCXXDtor(const CXXDestructorDecl *D, CXXDtorType Type,
182 raw_ostream &) override;
David Majnemerdaff3702014-05-01 17:50:17 +0000183 void mangleReferenceTemporary(const VarDecl *, unsigned ManglingNumber,
184 raw_ostream &) override;
Craig Toppercbce6e92014-03-11 06:22:39 +0000185 void mangleStaticGuardVariable(const VarDecl *D, raw_ostream &Out) override;
David Majnemer8354eee2015-05-07 06:15:46 +0000186 void mangleThreadSafeStaticGuardVariable(const VarDecl *D, unsigned GuardNum,
187 raw_ostream &Out) override;
Craig Toppercbce6e92014-03-11 06:22:39 +0000188 void mangleDynamicInitializer(const VarDecl *D, raw_ostream &Out) override;
189 void mangleDynamicAtExitDestructor(const VarDecl *D,
190 raw_ostream &Out) override;
Reid Kleckner1d59f992015-01-22 01:36:17 +0000191 void mangleSEHFilterExpression(const NamedDecl *EnclosingDecl,
192 raw_ostream &Out) override;
Reid Klecknerebaf28d2015-04-14 20:59:00 +0000193 void mangleSEHFinallyBlock(const NamedDecl *EnclosingDecl,
194 raw_ostream &Out) override;
David Majnemer58e5bee2014-03-24 21:43:36 +0000195 void mangleStringLiteral(const StringLiteral *SL, raw_ostream &Out) override;
David Majnemer2206bf52014-03-05 08:57:59 +0000196 bool getNextDiscriminator(const NamedDecl *ND, unsigned &disc) {
David Majnemer2206bf52014-03-05 08:57:59 +0000197 const DeclContext *DC = getEffectiveDeclContext(ND);
198 if (!DC->isFunctionOrMethod())
199 return false;
200
David Majnemer41311192016-01-17 07:09:24 +0000201 // Lambda closure types are already numbered, give out a phony number so
202 // that they demangle nicely.
David Majnemer984498f2016-12-06 17:01:02 +0000203 if (const auto *RD = dyn_cast<CXXRecordDecl>(ND)) {
204 if (RD->isLambda()) {
205 disc = 1;
206 return true;
207 }
David Majnemer41311192016-01-17 07:09:24 +0000208 }
209
David Majnemer2206bf52014-03-05 08:57:59 +0000210 // Use the canonical number for externally visible decls.
211 if (ND->isExternallyVisible()) {
212 disc = getASTContext().getManglingNumber(ND);
213 return true;
214 }
215
216 // Anonymous tags are already numbered.
217 if (const TagDecl *Tag = dyn_cast<TagDecl>(ND)) {
David Majnemerb33cd902015-09-02 15:50:38 +0000218 if (!Tag->hasNameForLinkage() &&
219 !getASTContext().getDeclaratorForUnnamedTagDecl(Tag) &&
220 !getASTContext().getTypedefNameForUnnamedTagDecl(Tag))
David Majnemer2206bf52014-03-05 08:57:59 +0000221 return false;
222 }
223
224 // Make up a reasonable number for internal decls.
225 unsigned &discriminator = Uniquifier[ND];
226 if (!discriminator)
227 discriminator = ++Discriminator[std::make_pair(DC, ND->getIdentifier())];
David Majnemer040fa342014-10-05 06:44:53 +0000228 disc = discriminator + 1;
David Majnemer2206bf52014-03-05 08:57:59 +0000229 return true;
230 }
Reid Kleckner1ece9fc2013-09-10 20:43:12 +0000231
David Majnemerf017ec32014-03-05 10:35:06 +0000232 unsigned getLambdaId(const CXXRecordDecl *RD) {
233 assert(RD->isLambda() && "RD must be a lambda!");
234 assert(!RD->isExternallyVisible() && "RD must not be visible!");
235 assert(RD->getLambdaManglingNumber() == 0 &&
236 "RD must not have a mangling number!");
237 std::pair<llvm::DenseMap<const CXXRecordDecl *, unsigned>::iterator, bool>
238 Result = LambdaIds.insert(std::make_pair(RD, LambdaIds.size()));
239 return Result.first->second;
240 }
241
Reid Klecknerdf8dd612018-08-17 20:59:27 +0000242 /// Return a character sequence that is (somewhat) unique to the TU suitable
243 /// for mangling anonymous namespaces.
244 StringRef getAnonymousNamespaceHash() const {
245 return AnonymousNamespaceHash;
246 }
247
Reid Kleckner1ece9fc2013-09-10 20:43:12 +0000248private:
David Majnemerfebb2722016-03-07 08:51:17 +0000249 void mangleInitFiniStub(const VarDecl *D, char CharCode, raw_ostream &Out);
Guy Benyei11169dd2012-12-18 14:30:41 +0000250};
251
David Majnemer2206bf52014-03-05 08:57:59 +0000252/// MicrosoftCXXNameMangler - Manage the mangling of a single name for the
253/// Microsoft Visual C++ ABI.
254class MicrosoftCXXNameMangler {
255 MicrosoftMangleContextImpl &Context;
256 raw_ostream &Out;
257
258 /// The "structor" is the top-level declaration being mangled, if
259 /// that's not a template specialization; otherwise it's the pattern
260 /// for that specialization.
261 const NamedDecl *Structor;
262 unsigned StructorType;
263
David Majnemer0d0560c2014-09-25 19:43:56 +0000264 typedef llvm::SmallVector<std::string, 10> BackRefVec;
265 BackRefVec NameBackReferences;
David Majnemer2206bf52014-03-05 08:57:59 +0000266
David Majnemer622abd12015-12-31 05:36:52 +0000267 typedef llvm::DenseMap<const void *, unsigned> ArgBackRefMap;
David Majnemer2206bf52014-03-05 08:57:59 +0000268 ArgBackRefMap TypeBackReferences;
269
Erik Pilkington02d5fb12019-03-19 20:44:18 +0000270 typedef std::set<std::pair<int, bool>> PassObjectSizeArgsSet;
David Majnemer5f177622015-12-30 05:13:03 +0000271 PassObjectSizeArgsSet PassObjectSizeArgs;
272
David Majnemer2206bf52014-03-05 08:57:59 +0000273 ASTContext &getASTContext() const { return Context.getASTContext(); }
274
275 // FIXME: If we add support for __ptr32/64 qualifiers, then we should push
276 // this check into mangleQualifiers().
277 const bool PointersAre64Bit;
278
279public:
280 enum QualifierMangleMode { QMM_Drop, QMM_Mangle, QMM_Escape, QMM_Result };
281
282 MicrosoftCXXNameMangler(MicrosoftMangleContextImpl &C, raw_ostream &Out_)
Craig Topper36250ad2014-05-12 05:36:57 +0000283 : Context(C), Out(Out_), Structor(nullptr), StructorType(-1),
David Majnemer02e9af42014-04-23 05:16:51 +0000284 PointersAre64Bit(C.getASTContext().getTargetInfo().getPointerWidth(0) ==
285 64) {}
David Majnemer2206bf52014-03-05 08:57:59 +0000286
287 MicrosoftCXXNameMangler(MicrosoftMangleContextImpl &C, raw_ostream &Out_,
David Majnemerdfa6d202015-03-11 18:36:39 +0000288 const CXXConstructorDecl *D, CXXCtorType Type)
289 : Context(C), Out(Out_), Structor(getStructor(D)), StructorType(Type),
290 PointersAre64Bit(C.getASTContext().getTargetInfo().getPointerWidth(0) ==
291 64) {}
292
293 MicrosoftCXXNameMangler(MicrosoftMangleContextImpl &C, raw_ostream &Out_,
David Majnemer2206bf52014-03-05 08:57:59 +0000294 const CXXDestructorDecl *D, CXXDtorType Type)
David Majnemer02e9af42014-04-23 05:16:51 +0000295 : Context(C), Out(Out_), Structor(getStructor(D)), StructorType(Type),
David Majnemer02e9af42014-04-23 05:16:51 +0000296 PointersAre64Bit(C.getASTContext().getTargetInfo().getPointerWidth(0) ==
297 64) {}
David Majnemer2206bf52014-03-05 08:57:59 +0000298
299 raw_ostream &getStream() const { return Out; }
300
Reid Klecknerfb931542018-03-16 20:36:49 +0000301 void mangle(const NamedDecl *D, StringRef Prefix = "?");
David Majnemer2206bf52014-03-05 08:57:59 +0000302 void mangleName(const NamedDecl *ND);
David Majnemerab4b4a12015-05-18 00:05:25 +0000303 void mangleFunctionEncoding(const FunctionDecl *FD, bool ShouldMangle);
David Majnemer2206bf52014-03-05 08:57:59 +0000304 void mangleVariableEncoding(const VarDecl *VD);
305 void mangleMemberDataPointer(const CXXRecordDecl *RD, const ValueDecl *VD);
306 void mangleMemberFunctionPointer(const CXXRecordDecl *RD,
307 const CXXMethodDecl *MD);
Reid Klecknercbec0262018-04-02 20:00:39 +0000308 void mangleVirtualMemPtrThunk(const CXXMethodDecl *MD,
309 const MethodVFTableLocation &ML);
David Majnemer2206bf52014-03-05 08:57:59 +0000310 void mangleNumber(int64_t Number);
David Majnemer3add70b2015-12-29 11:45:53 +0000311 void mangleTagTypeKind(TagTypeKind TK);
Shoaib Meenaid84cf132018-11-14 19:16:22 +0000312 void mangleArtificialTagType(TagTypeKind TK, StringRef UnqualifiedName,
David Majnemer3add70b2015-12-29 11:45:53 +0000313 ArrayRef<StringRef> NestedNames = None);
Erich Keane24a0f042018-12-14 23:17:34 +0000314 void mangleAddressSpaceType(QualType T, Qualifiers Quals, SourceRange Range);
David Majnemer2206bf52014-03-05 08:57:59 +0000315 void mangleType(QualType T, SourceRange Range,
316 QualifierMangleMode QMM = QMM_Mangle);
Craig Topper36250ad2014-05-12 05:36:57 +0000317 void mangleFunctionType(const FunctionType *T,
318 const FunctionDecl *D = nullptr,
Reid Klecknerd2f98772018-12-17 23:10:43 +0000319 bool ForceThisQuals = false,
320 bool MangleExceptionSpec = true);
David Majnemer2206bf52014-03-05 08:57:59 +0000321 void mangleNestedName(const NamedDecl *ND);
322
323private:
Reid Kleckner290feb92017-01-09 17:04:37 +0000324 bool isStructorDecl(const NamedDecl *ND) const {
325 return ND == Structor || getStructor(ND) == Structor;
326 }
327
David Majnemer2206bf52014-03-05 08:57:59 +0000328 void mangleUnqualifiedName(const NamedDecl *ND) {
329 mangleUnqualifiedName(ND, ND->getDeclName());
330 }
331 void mangleUnqualifiedName(const NamedDecl *ND, DeclarationName Name);
332 void mangleSourceName(StringRef Name);
333 void mangleOperatorName(OverloadedOperatorKind OO, SourceLocation Loc);
334 void mangleCXXDtorType(CXXDtorType T);
335 void mangleQualifiers(Qualifiers Quals, bool IsMember);
David Majnemere3785bb2014-04-23 05:16:56 +0000336 void mangleRefQualifier(RefQualifierKind RefQualifier);
David Majnemer2206bf52014-03-05 08:57:59 +0000337 void manglePointerCVQualifiers(Qualifiers Quals);
David Majnemer7a3ce0c2015-05-26 01:30:45 +0000338 void manglePointerExtQualifiers(Qualifiers Quals, QualType PointeeType);
David Majnemer2206bf52014-03-05 08:57:59 +0000339
340 void mangleUnscopedTemplateName(const TemplateDecl *ND);
David Majnemer02e9af42014-04-23 05:16:51 +0000341 void
342 mangleTemplateInstantiationName(const TemplateDecl *TD,
343 const TemplateArgumentList &TemplateArgs);
David Majnemer2206bf52014-03-05 08:57:59 +0000344 void mangleObjCMethodName(const ObjCMethodDecl *MD);
345
346 void mangleArgumentType(QualType T, SourceRange Range);
David Majnemer5f177622015-12-30 05:13:03 +0000347 void manglePassObjectSizeArg(const PassObjectSizeAttr *POSA);
David Majnemer2206bf52014-03-05 08:57:59 +0000348
Nico Weber3239f132018-07-23 20:04:00 +0000349 bool isArtificialTagType(QualType T) const;
350
David Majnemer2206bf52014-03-05 08:57:59 +0000351 // Declare manglers for every type class.
352#define ABSTRACT_TYPE(CLASS, PARENT)
353#define NON_CANONICAL_TYPE(CLASS, PARENT)
354#define TYPE(CLASS, PARENT) void mangleType(const CLASS##Type *T, \
David Majnemer7a3ce0c2015-05-26 01:30:45 +0000355 Qualifiers Quals, \
David Majnemer2206bf52014-03-05 08:57:59 +0000356 SourceRange Range);
357#include "clang/AST/TypeNodes.def"
358#undef ABSTRACT_TYPE
359#undef NON_CANONICAL_TYPE
360#undef TYPE
361
362 void mangleType(const TagDecl *TD);
363 void mangleDecayedArrayType(const ArrayType *T);
364 void mangleArrayType(const ArrayType *T);
365 void mangleFunctionClass(const FunctionDecl *FD);
David Majnemerdfa6d202015-03-11 18:36:39 +0000366 void mangleCallingConvention(CallingConv CC);
David Majnemer2206bf52014-03-05 08:57:59 +0000367 void mangleCallingConvention(const FunctionType *T);
368 void mangleIntegerLiteral(const llvm::APSInt &Number, bool IsBoolean);
369 void mangleExpression(const Expr *E);
370 void mangleThrowSpecification(const FunctionProtoType *T);
371
372 void mangleTemplateArgs(const TemplateDecl *TD,
373 const TemplateArgumentList &TemplateArgs);
David Majnemer57fbc0c2014-08-05 22:43:45 +0000374 void mangleTemplateArg(const TemplateDecl *TD, const TemplateArgument &TA,
375 const NamedDecl *Parm);
Saleem Abdulrasoolbbce34a2018-02-09 03:23:54 +0000376
377 void mangleObjCProtocol(const ObjCProtocolDecl *PD);
378 void mangleObjCLifetime(const QualType T, Qualifiers Quals,
379 SourceRange Range);
Saleem Abdulrasoolf3a981e2018-09-28 16:47:53 +0000380 void mangleObjCKindOfType(const ObjCObjectType *T, Qualifiers Quals,
381 SourceRange Range);
David Majnemer2206bf52014-03-05 08:57:59 +0000382};
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000383}
Guy Benyei11169dd2012-12-18 14:30:41 +0000384
Reid Klecknerdf8dd612018-08-17 20:59:27 +0000385MicrosoftMangleContextImpl::MicrosoftMangleContextImpl(ASTContext &Context,
386 DiagnosticsEngine &Diags)
387 : MicrosoftMangleContext(Context, Diags) {
388 // To mangle anonymous namespaces, hash the path to the main source file. The
389 // path should be whatever (probably relative) path was passed on the command
390 // line. The goal is for the compiler to produce the same output regardless of
391 // working directory, so use the uncanonicalized relative path.
392 //
393 // It's important to make the mangled names unique because, when CodeView
394 // debug info is in use, the debugger uses mangled type names to distinguish
395 // between otherwise identically named types in anonymous namespaces.
396 //
397 // These symbols are always internal, so there is no need for the hash to
398 // match what MSVC produces. For the same reason, clang is free to change the
399 // hash at any time without breaking compatibility with old versions of clang.
400 // The generated names are intended to look similar to what MSVC generates,
401 // which are something like "?A0x01234567@".
402 SourceManager &SM = Context.getSourceManager();
403 if (const FileEntry *FE = SM.getFileEntryForID(SM.getMainFileID())) {
404 // Truncate the hash so we get 8 characters of hexadecimal.
405 uint32_t TruncatedHash = uint32_t(xxHash64(FE->getName()));
406 AnonymousNamespaceHash = llvm::utohexstr(TruncatedHash);
407 } else {
408 // If we don't have a path to the main file, we'll just use 0.
409 AnonymousNamespaceHash = "0";
410 }
411}
412
Rafael Espindola002667c2013-10-16 01:40:34 +0000413bool MicrosoftMangleContextImpl::shouldMangleCXXName(const NamedDecl *D) {
David Majnemerd5a42b82013-09-13 09:03:14 +0000414 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
415 LanguageLinkage L = FD->getLanguageLinkage();
416 // Overloadable functions need mangling.
417 if (FD->hasAttr<OverloadableAttr>())
418 return true;
419
David Majnemerc729b0b2013-09-16 22:44:20 +0000420 // The ABI expects that we would never mangle "typical" user-defined entry
421 // points regardless of visibility or freestanding-ness.
422 //
423 // N.B. This is distinct from asking about "main". "main" has a lot of
424 // special rules associated with it in the standard while these
425 // user-defined entry points are outside of the purview of the standard.
426 // For example, there can be only one definition for "main" in a standards
427 // compliant program; however nothing forbids the existence of wmain and
428 // WinMain in the same translation unit.
429 if (FD->isMSVCRTEntryPoint())
David Majnemerd5a42b82013-09-13 09:03:14 +0000430 return false;
431
432 // C++ functions and those whose names are not a simple identifier need
433 // mangling.
434 if (!FD->getDeclName().isIdentifier() || L == CXXLanguageLinkage)
435 return true;
436
437 // C functions are not mangled.
438 if (L == CLanguageLinkage)
439 return false;
440 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000441
442 // Otherwise, no mangling is done outside C++ mode.
443 if (!getASTContext().getLangOpts().CPlusPlus)
444 return false;
445
Richard Smithda383632016-08-15 01:33:41 +0000446 const VarDecl *VD = dyn_cast<VarDecl>(D);
447 if (VD && !isa<DecompositionDecl>(D)) {
David Majnemerd5a42b82013-09-13 09:03:14 +0000448 // C variables are not mangled.
449 if (VD->isExternC())
450 return false;
451
452 // Variables at global scope with non-internal linkage are not mangled.
453 const DeclContext *DC = getEffectiveDeclContext(D);
454 // Check for extern variable declared locally.
455 if (DC->isFunctionOrMethod() && D->hasLinkage())
456 while (!DC->isNamespace() && !DC->isTranslationUnit())
457 DC = getEffectiveParentContext(DC);
458
459 if (DC->isTranslationUnit() && D->getFormalLinkage() == InternalLinkage &&
David Majnemeree6c4092015-10-22 07:15:56 +0000460 !isa<VarTemplateSpecializationDecl>(D) &&
461 D->getIdentifier() != nullptr)
Guy Benyei11169dd2012-12-18 14:30:41 +0000462 return false;
463 }
464
Guy Benyei11169dd2012-12-18 14:30:41 +0000465 return true;
466}
467
David Majnemer58e5bee2014-03-24 21:43:36 +0000468bool
469MicrosoftMangleContextImpl::shouldMangleStringLiteral(const StringLiteral *SL) {
David Majnemer6fc2d812014-11-22 06:20:38 +0000470 return true;
David Majnemer58e5bee2014-03-24 21:43:36 +0000471}
472
David Majnemer02e9af42014-04-23 05:16:51 +0000473void MicrosoftCXXNameMangler::mangle(const NamedDecl *D, StringRef Prefix) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000474 // MSVC doesn't mangle C++ names the same way it mangles extern "C" names.
475 // Therefore it's really important that we don't decorate the
476 // name with leading underscores or leading/trailing at signs. So, by
477 // default, we emit an asm marker at the start so we get the name right.
478 // Callers can override this with a custom prefix.
479
Guy Benyei11169dd2012-12-18 14:30:41 +0000480 // <mangled-name> ::= ? <name> <type-encoding>
481 Out << Prefix;
482 mangleName(D);
483 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
David Majnemerab4b4a12015-05-18 00:05:25 +0000484 mangleFunctionEncoding(FD, Context.shouldMangleDeclName(FD));
Guy Benyei11169dd2012-12-18 14:30:41 +0000485 else if (const VarDecl *VD = dyn_cast<VarDecl>(D))
486 mangleVariableEncoding(VD);
Shoaib Meenaic8714d22018-10-04 19:50:14 +0000487 else
David Majnemer53b60a12015-12-29 22:02:10 +0000488 llvm_unreachable("Tried to mangle unexpected NamedDecl!");
Guy Benyei11169dd2012-12-18 14:30:41 +0000489}
490
David Majnemerab4b4a12015-05-18 00:05:25 +0000491void MicrosoftCXXNameMangler::mangleFunctionEncoding(const FunctionDecl *FD,
492 bool ShouldMangle) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000493 // <type-encoding> ::= <function-class> <function-type>
494
Reid Kleckner18da98e2013-06-24 19:21:52 +0000495 // Since MSVC operates on the type as written and not the canonical type, it
496 // actually matters which decl we have here. MSVC appears to choose the
497 // first, since it is most likely to be the declaration in a header file.
Rafael Espindola8db352d2013-10-17 15:37:26 +0000498 FD = FD->getFirstDecl();
Reid Kleckner18da98e2013-06-24 19:21:52 +0000499
Guy Benyei11169dd2012-12-18 14:30:41 +0000500 // We should never ever see a FunctionNoProtoType at this point.
501 // We don't even know how to mangle their types anyway :).
Reid Kleckner9a7f3e62013-10-08 00:58:57 +0000502 const FunctionProtoType *FT = FD->getType()->castAs<FunctionProtoType>();
Guy Benyei11169dd2012-12-18 14:30:41 +0000503
David Majnemerd5a42b82013-09-13 09:03:14 +0000504 // extern "C" functions can hold entities that must be mangled.
505 // As it stands, these functions still need to get expressed in the full
506 // external name. They have their class and type omitted, replaced with '9'.
David Majnemerab4b4a12015-05-18 00:05:25 +0000507 if (ShouldMangle) {
David Majnemer5a7cfea2015-05-18 00:05:29 +0000508 // We would like to mangle all extern "C" functions using this additional
509 // component but this would break compatibility with MSVC's behavior.
510 // Instead, do this when we know that compatibility isn't important (in
Eric Christopherbe528662015-12-16 23:10:46 +0000511 // other words, when it is an overloaded extern "C" function).
David Majnemer5a7cfea2015-05-18 00:05:29 +0000512 if (FD->isExternC() && FD->hasAttr<OverloadableAttr>())
513 Out << "$$J0";
514
David Majnemerd5a42b82013-09-13 09:03:14 +0000515 mangleFunctionClass(FD);
Guy Benyei11169dd2012-12-18 14:30:41 +0000516
Reid Klecknerd2f98772018-12-17 23:10:43 +0000517 mangleFunctionType(FT, FD, false, false);
David Majnemerab4b4a12015-05-18 00:05:25 +0000518 } else {
David Majnemerd5a42b82013-09-13 09:03:14 +0000519 Out << '9';
David Majnemerab4b4a12015-05-18 00:05:25 +0000520 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000521}
522
523void MicrosoftCXXNameMangler::mangleVariableEncoding(const VarDecl *VD) {
524 // <type-encoding> ::= <storage-class> <variable-type>
525 // <storage-class> ::= 0 # private static member
526 // ::= 1 # protected static member
527 // ::= 2 # public static member
528 // ::= 3 # global
529 // ::= 4 # static local
David Majnemerb4119f72013-12-13 01:06:04 +0000530
Guy Benyei11169dd2012-12-18 14:30:41 +0000531 // The first character in the encoding (after the name) is the storage class.
532 if (VD->isStaticDataMember()) {
533 // If it's a static member, it also encodes the access level.
534 switch (VD->getAccess()) {
535 default:
536 case AS_private: Out << '0'; break;
537 case AS_protected: Out << '1'; break;
538 case AS_public: Out << '2'; break;
539 }
540 }
541 else if (!VD->isStaticLocal())
542 Out << '3';
543 else
544 Out << '4';
545 // Now mangle the type.
546 // <variable-type> ::= <type> <cvr-qualifiers>
547 // ::= <type> <pointee-cvr-qualifiers> # pointers, references
548 // Pointers and references are odd. The type of 'int * const foo;' gets
549 // mangled as 'QAHA' instead of 'PAHB', for example.
Zachary Turner87422d92014-06-25 05:37:25 +0000550 SourceRange SR = VD->getSourceRange();
David Majnemerb9a5f2d2014-01-21 20:33:36 +0000551 QualType Ty = VD->getType();
David Majnemer6dda7bb2013-08-15 08:13:23 +0000552 if (Ty->isPointerType() || Ty->isReferenceType() ||
553 Ty->isMemberPointerType()) {
Zachary Turner87422d92014-06-25 05:37:25 +0000554 mangleType(Ty, SR, QMM_Drop);
David Majnemer8eec58f2014-02-18 14:20:10 +0000555 manglePointerExtQualifiers(
David Majnemer7a3ce0c2015-05-26 01:30:45 +0000556 Ty.getDesugaredType(getASTContext()).getLocalQualifiers(), QualType());
David Majnemer6dda7bb2013-08-15 08:13:23 +0000557 if (const MemberPointerType *MPT = Ty->getAs<MemberPointerType>()) {
558 mangleQualifiers(MPT->getPointeeType().getQualifiers(), true);
559 // Member pointers are suffixed with a back reference to the member
560 // pointer's class name.
561 mangleName(MPT->getClass()->getAsCXXRecordDecl());
562 } else
563 mangleQualifiers(Ty->getPointeeType().getQualifiers(), false);
David Majnemera2724ae2013-08-09 05:56:24 +0000564 } else if (const ArrayType *AT = getASTContext().getAsArrayType(Ty)) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000565 // Global arrays are funny, too.
David Majnemer5a1b2042013-09-11 04:44:30 +0000566 mangleDecayedArrayType(AT);
Peter Collingbourne2816c022013-04-25 04:25:40 +0000567 if (AT->getElementType()->isArrayType())
568 Out << 'A';
569 else
570 mangleQualifiers(Ty.getQualifiers(), false);
Guy Benyei11169dd2012-12-18 14:30:41 +0000571 } else {
Zachary Turner87422d92014-06-25 05:37:25 +0000572 mangleType(Ty, SR, QMM_Drop);
Will Wilson5f383672014-11-05 13:54:21 +0000573 mangleQualifiers(Ty.getQualifiers(), false);
Guy Benyei11169dd2012-12-18 14:30:41 +0000574 }
575}
576
Reid Kleckner96f8f932014-02-05 17:27:08 +0000577void MicrosoftCXXNameMangler::mangleMemberDataPointer(const CXXRecordDecl *RD,
David Majnemer1e378e42014-02-06 12:46:52 +0000578 const ValueDecl *VD) {
Reid Kleckner96f8f932014-02-05 17:27:08 +0000579 // <member-data-pointer> ::= <integer-literal>
580 // ::= $F <number> <number>
581 // ::= $G <number> <number> <number>
582
David Majnemer763584d2014-02-06 10:59:19 +0000583 int64_t FieldOffset;
584 int64_t VBTableOffset;
Reid Kleckner96f8f932014-02-05 17:27:08 +0000585 MSInheritanceAttr::Spelling IM = RD->getMSInheritanceModel();
David Majnemer1e378e42014-02-06 12:46:52 +0000586 if (VD) {
587 FieldOffset = getASTContext().getFieldOffset(VD);
David Majnemer763584d2014-02-06 10:59:19 +0000588 assert(FieldOffset % getASTContext().getCharWidth() == 0 &&
Reid Kleckner96f8f932014-02-05 17:27:08 +0000589 "cannot take address of bitfield");
David Majnemer763584d2014-02-06 10:59:19 +0000590 FieldOffset /= getASTContext().getCharWidth();
591
592 VBTableOffset = 0;
David Majnemer08ef2ba2015-06-23 20:34:18 +0000593
594 if (IM == MSInheritanceAttr::Keyword_virtual_inheritance)
595 FieldOffset -= getASTContext().getOffsetOfBaseWithVBPtr(RD).getQuantity();
David Majnemer763584d2014-02-06 10:59:19 +0000596 } else {
597 FieldOffset = RD->nullFieldOffsetIsZero() ? 0 : -1;
598
599 VBTableOffset = -1;
Reid Kleckner96f8f932014-02-05 17:27:08 +0000600 }
601
David Majnemer763584d2014-02-06 10:59:19 +0000602 char Code = '\0';
Reid Kleckner96f8f932014-02-05 17:27:08 +0000603 switch (IM) {
David Majnemer763584d2014-02-06 10:59:19 +0000604 case MSInheritanceAttr::Keyword_single_inheritance: Code = '0'; break;
605 case MSInheritanceAttr::Keyword_multiple_inheritance: Code = '0'; break;
606 case MSInheritanceAttr::Keyword_virtual_inheritance: Code = 'F'; break;
607 case MSInheritanceAttr::Keyword_unspecified_inheritance: Code = 'G'; break;
Reid Kleckner96f8f932014-02-05 17:27:08 +0000608 }
609
David Majnemer763584d2014-02-06 10:59:19 +0000610 Out << '$' << Code;
Reid Kleckner96f8f932014-02-05 17:27:08 +0000611
David Majnemer763584d2014-02-06 10:59:19 +0000612 mangleNumber(FieldOffset);
613
Reid Klecknerbf94e6e2014-04-07 18:07:03 +0000614 // The C++ standard doesn't allow base-to-derived member pointer conversions
615 // in template parameter contexts, so the vbptr offset of data member pointers
616 // is always zero.
David Majnemer763584d2014-02-06 10:59:19 +0000617 if (MSInheritanceAttr::hasVBPtrOffsetField(IM))
Reid Kleckner96f8f932014-02-05 17:27:08 +0000618 mangleNumber(0);
David Majnemer763584d2014-02-06 10:59:19 +0000619 if (MSInheritanceAttr::hasVBTableOffsetField(IM))
620 mangleNumber(VBTableOffset);
Reid Kleckner96f8f932014-02-05 17:27:08 +0000621}
622
623void
624MicrosoftCXXNameMangler::mangleMemberFunctionPointer(const CXXRecordDecl *RD,
625 const CXXMethodDecl *MD) {
626 // <member-function-pointer> ::= $1? <name>
627 // ::= $H? <name> <number>
628 // ::= $I? <name> <number> <number>
629 // ::= $J? <name> <number> <number> <number>
Reid Kleckner96f8f932014-02-05 17:27:08 +0000630
631 MSInheritanceAttr::Spelling IM = RD->getMSInheritanceModel();
632
Reid Kleckner96f8f932014-02-05 17:27:08 +0000633 char Code = '\0';
634 switch (IM) {
635 case MSInheritanceAttr::Keyword_single_inheritance: Code = '1'; break;
636 case MSInheritanceAttr::Keyword_multiple_inheritance: Code = 'H'; break;
637 case MSInheritanceAttr::Keyword_virtual_inheritance: Code = 'I'; break;
638 case MSInheritanceAttr::Keyword_unspecified_inheritance: Code = 'J'; break;
639 }
640
Reid Kleckner96f8f932014-02-05 17:27:08 +0000641 // If non-virtual, mangle the name. If virtual, mangle as a virtual memptr
642 // thunk.
643 uint64_t NVOffset = 0;
644 uint64_t VBTableOffset = 0;
Reid Klecknerbf94e6e2014-04-07 18:07:03 +0000645 uint64_t VBPtrOffset = 0;
David Majnemer6a729c62014-06-11 04:55:08 +0000646 if (MD) {
647 Out << '$' << Code << '?';
648 if (MD->isVirtual()) {
649 MicrosoftVTableContext *VTContext =
650 cast<MicrosoftVTableContext>(getASTContext().getVTableContext());
Reid Klecknercbec0262018-04-02 20:00:39 +0000651 MethodVFTableLocation ML =
David Majnemer6a729c62014-06-11 04:55:08 +0000652 VTContext->getMethodVFTableLocation(GlobalDecl(MD));
653 mangleVirtualMemPtrThunk(MD, ML);
654 NVOffset = ML.VFPtrOffset.getQuantity();
655 VBTableOffset = ML.VBTableIndex * 4;
656 if (ML.VBase) {
657 const ASTRecordLayout &Layout = getASTContext().getASTRecordLayout(RD);
658 VBPtrOffset = Layout.getVBPtrOffset().getQuantity();
659 }
660 } else {
661 mangleName(MD);
David Majnemerab4b4a12015-05-18 00:05:25 +0000662 mangleFunctionEncoding(MD, /*ShouldMangle=*/true);
Reid Kleckner96f8f932014-02-05 17:27:08 +0000663 }
David Majnemer08ef2ba2015-06-23 20:34:18 +0000664
665 if (VBTableOffset == 0 &&
666 IM == MSInheritanceAttr::Keyword_virtual_inheritance)
667 NVOffset -= getASTContext().getOffsetOfBaseWithVBPtr(RD).getQuantity();
Reid Kleckner96f8f932014-02-05 17:27:08 +0000668 } else {
David Majnemer6a729c62014-06-11 04:55:08 +0000669 // Null single inheritance member functions are encoded as a simple nullptr.
670 if (IM == MSInheritanceAttr::Keyword_single_inheritance) {
671 Out << "$0A@";
672 return;
673 }
674 if (IM == MSInheritanceAttr::Keyword_unspecified_inheritance)
675 VBTableOffset = -1;
676 Out << '$' << Code;
Reid Kleckner96f8f932014-02-05 17:27:08 +0000677 }
678
679 if (MSInheritanceAttr::hasNVOffsetField(/*IsMemberFunction=*/true, IM))
David Majnemer08ef2ba2015-06-23 20:34:18 +0000680 mangleNumber(static_cast<uint32_t>(NVOffset));
Reid Kleckner96f8f932014-02-05 17:27:08 +0000681 if (MSInheritanceAttr::hasVBPtrOffsetField(IM))
Reid Klecknerbf94e6e2014-04-07 18:07:03 +0000682 mangleNumber(VBPtrOffset);
Reid Kleckner96f8f932014-02-05 17:27:08 +0000683 if (MSInheritanceAttr::hasVBTableOffsetField(IM))
684 mangleNumber(VBTableOffset);
685}
686
687void MicrosoftCXXNameMangler::mangleVirtualMemPtrThunk(
Reid Klecknercbec0262018-04-02 20:00:39 +0000688 const CXXMethodDecl *MD, const MethodVFTableLocation &ML) {
Reid Kleckner96f8f932014-02-05 17:27:08 +0000689 // Get the vftable offset.
690 CharUnits PointerWidth = getASTContext().toCharUnitsFromBits(
691 getASTContext().getTargetInfo().getPointerWidth(0));
692 uint64_t OffsetInVFTable = ML.Index * PointerWidth.getQuantity();
693
694 Out << "?_9";
695 mangleName(MD->getParent());
696 Out << "$B";
697 mangleNumber(OffsetInVFTable);
698 Out << 'A';
David Majnemerbc02d322015-03-14 06:34:41 +0000699 mangleCallingConvention(MD->getType()->getAs<FunctionProtoType>());
Reid Kleckner96f8f932014-02-05 17:27:08 +0000700}
701
Guy Benyei11169dd2012-12-18 14:30:41 +0000702void MicrosoftCXXNameMangler::mangleName(const NamedDecl *ND) {
703 // <name> ::= <unscoped-name> {[<named-scope>]+ | [<nested-name>]}? @
Guy Benyei11169dd2012-12-18 14:30:41 +0000704
705 // Always start with the unqualified name.
David Majnemerb4119f72013-12-13 01:06:04 +0000706 mangleUnqualifiedName(ND);
Guy Benyei11169dd2012-12-18 14:30:41 +0000707
David Majnemer2206bf52014-03-05 08:57:59 +0000708 mangleNestedName(ND);
Guy Benyei11169dd2012-12-18 14:30:41 +0000709
710 // Terminate the whole name with an '@'.
711 Out << '@';
712}
713
David Majnemer2a816452013-12-09 10:44:32 +0000714void MicrosoftCXXNameMangler::mangleNumber(int64_t Number) {
715 // <non-negative integer> ::= A@ # when Number == 0
716 // ::= <decimal digit> # when 1 <= Number <= 10
717 // ::= <hex digit>+ @ # when Number >= 10
718 //
719 // <number> ::= [?] <non-negative integer>
Guy Benyei11169dd2012-12-18 14:30:41 +0000720
David Majnemer2a816452013-12-09 10:44:32 +0000721 uint64_t Value = static_cast<uint64_t>(Number);
722 if (Number < 0) {
723 Value = -Value;
Guy Benyei11169dd2012-12-18 14:30:41 +0000724 Out << '?';
Guy Benyei11169dd2012-12-18 14:30:41 +0000725 }
David Majnemer2a816452013-12-09 10:44:32 +0000726
727 if (Value == 0)
728 Out << "A@";
729 else if (Value >= 1 && Value <= 10)
730 Out << (Value - 1);
731 else {
732 // Numbers that are not encoded as decimal digits are represented as nibbles
733 // in the range of ASCII characters 'A' to 'P'.
734 // The number 0x123450 would be encoded as 'BCDEFA'
735 char EncodedNumberBuffer[sizeof(uint64_t) * 2];
Craig Toppere3d2ecbe2014-06-28 23:22:33 +0000736 MutableArrayRef<char> BufferRef(EncodedNumberBuffer);
737 MutableArrayRef<char>::reverse_iterator I = BufferRef.rbegin();
David Majnemer2a816452013-12-09 10:44:32 +0000738 for (; Value != 0; Value >>= 4)
739 *I++ = 'A' + (Value & 0xf);
740 Out.write(I.base(), I - BufferRef.rbegin());
Guy Benyei11169dd2012-12-18 14:30:41 +0000741 Out << '@';
742 }
743}
744
745static const TemplateDecl *
Reid Kleckner52518862013-03-20 01:40:23 +0000746isTemplate(const NamedDecl *ND, const TemplateArgumentList *&TemplateArgs) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000747 // Check if we have a function template.
David Majnemer02e9af42014-04-23 05:16:51 +0000748 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000749 if (const TemplateDecl *TD = FD->getPrimaryTemplate()) {
Reid Kleckner52518862013-03-20 01:40:23 +0000750 TemplateArgs = FD->getTemplateSpecializationArgs();
Guy Benyei11169dd2012-12-18 14:30:41 +0000751 return TD;
752 }
753 }
754
755 // Check if we have a class template.
756 if (const ClassTemplateSpecializationDecl *Spec =
David Majnemer02e9af42014-04-23 05:16:51 +0000757 dyn_cast<ClassTemplateSpecializationDecl>(ND)) {
Reid Kleckner52518862013-03-20 01:40:23 +0000758 TemplateArgs = &Spec->getTemplateArgs();
Guy Benyei11169dd2012-12-18 14:30:41 +0000759 return Spec->getSpecializedTemplate();
760 }
761
David Majnemer8f774532014-03-04 05:38:05 +0000762 // Check if we have a variable template.
763 if (const VarTemplateSpecializationDecl *Spec =
764 dyn_cast<VarTemplateSpecializationDecl>(ND)) {
765 TemplateArgs = &Spec->getTemplateArgs();
766 return Spec->getSpecializedTemplate();
767 }
768
Craig Topper36250ad2014-05-12 05:36:57 +0000769 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +0000770}
771
David Majnemer02e9af42014-04-23 05:16:51 +0000772void MicrosoftCXXNameMangler::mangleUnqualifiedName(const NamedDecl *ND,
773 DeclarationName Name) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000774 // <unqualified-name> ::= <operator-name>
775 // ::= <ctor-dtor-name>
776 // ::= <source-name>
777 // ::= <template-name>
Reid Kleckner52518862013-03-20 01:40:23 +0000778
Guy Benyei11169dd2012-12-18 14:30:41 +0000779 // Check if we have a template.
Craig Topper36250ad2014-05-12 05:36:57 +0000780 const TemplateArgumentList *TemplateArgs = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +0000781 if (const TemplateDecl *TD = isTemplate(ND, TemplateArgs)) {
Reid Klecknerc16c4472013-07-13 00:43:39 +0000782 // Function templates aren't considered for name back referencing. This
783 // makes sense since function templates aren't likely to occur multiple
784 // times in a symbol.
David Majnemer56e2adb2015-12-30 05:40:32 +0000785 if (isa<FunctionTemplateDecl>(TD)) {
Reid Klecknerc16c4472013-07-13 00:43:39 +0000786 mangleTemplateInstantiationName(TD, *TemplateArgs);
Reid Kleckner11c6f612014-06-26 22:42:18 +0000787 Out << '@';
Reid Klecknerc16c4472013-07-13 00:43:39 +0000788 return;
789 }
790
Guy Benyei11169dd2012-12-18 14:30:41 +0000791 // Here comes the tricky thing: if we need to mangle something like
792 // void foo(A::X<Y>, B::X<Y>),
793 // the X<Y> part is aliased. However, if you need to mangle
794 // void foo(A::X<A::Y>, A::X<B::Y>),
795 // the A::X<> part is not aliased.
796 // That said, from the mangler's perspective we have a structure like this:
797 // namespace[s] -> type[ -> template-parameters]
798 // but from the Clang perspective we have
799 // type [ -> template-parameters]
800 // \-> namespace[s]
801 // What we do is we create a new mangler, mangle the same type (without
Fangrui Song6907ce22018-07-30 19:24:48 +0000802 // a namespace suffix) to a string using the extra mangler and then use
David Majnemerc986fcc2014-06-08 04:51:13 +0000803 // the mangled type name as a key to check the mangling of different types
804 // for aliasing.
Guy Benyei11169dd2012-12-18 14:30:41 +0000805
Reid Kleckner11c6f612014-06-26 22:42:18 +0000806 llvm::SmallString<64> TemplateMangling;
807 llvm::raw_svector_ostream Stream(TemplateMangling);
David Majnemerc986fcc2014-06-08 04:51:13 +0000808 MicrosoftCXXNameMangler Extra(Context, Stream);
809 Extra.mangleTemplateInstantiationName(TD, *TemplateArgs);
Guy Benyei11169dd2012-12-18 14:30:41 +0000810
Reid Kleckner11c6f612014-06-26 22:42:18 +0000811 mangleSourceName(TemplateMangling);
Guy Benyei11169dd2012-12-18 14:30:41 +0000812 return;
813 }
814
815 switch (Name.getNameKind()) {
816 case DeclarationName::Identifier: {
817 if (const IdentifierInfo *II = Name.getAsIdentifierInfo()) {
David Majnemer956bc112013-11-25 17:50:19 +0000818 mangleSourceName(II->getName());
Guy Benyei11169dd2012-12-18 14:30:41 +0000819 break;
820 }
David Majnemerb4119f72013-12-13 01:06:04 +0000821
Guy Benyei11169dd2012-12-18 14:30:41 +0000822 // Otherwise, an anonymous entity. We must have a declaration.
823 assert(ND && "mangling empty name without declaration");
David Majnemerb4119f72013-12-13 01:06:04 +0000824
Guy Benyei11169dd2012-12-18 14:30:41 +0000825 if (const NamespaceDecl *NS = dyn_cast<NamespaceDecl>(ND)) {
826 if (NS->isAnonymousNamespace()) {
Reid Klecknerdf8dd612018-08-17 20:59:27 +0000827 Out << "?A0x" << Context.getAnonymousNamespaceHash() << '@';
Guy Benyei11169dd2012-12-18 14:30:41 +0000828 break;
829 }
830 }
David Majnemerb4119f72013-12-13 01:06:04 +0000831
Richard Smithda383632016-08-15 01:33:41 +0000832 if (const DecompositionDecl *DD = dyn_cast<DecompositionDecl>(ND)) {
833 // FIXME: Invented mangling for decomposition declarations:
834 // [X,Y,Z]
835 // where X,Y,Z are the names of the bindings.
836 llvm::SmallString<128> Name("[");
837 for (auto *BD : DD->bindings()) {
838 if (Name.size() > 1)
839 Name += ',';
840 Name += BD->getDeclName().getAsIdentifierInfo()->getName();
841 }
842 Name += ']';
843 mangleSourceName(Name);
844 break;
845 }
846
David Majnemer2206bf52014-03-05 08:57:59 +0000847 if (const VarDecl *VD = dyn_cast<VarDecl>(ND)) {
848 // We must have an anonymous union or struct declaration.
849 const CXXRecordDecl *RD = VD->getType()->getAsCXXRecordDecl();
850 assert(RD && "expected variable decl to have a record type");
851 // Anonymous types with no tag or typedef get the name of their
852 // declarator mangled in. If they have no declarator, number them with
853 // a $S prefix.
854 llvm::SmallString<64> Name("$S");
855 // Get a unique id for the anonymous struct.
856 Name += llvm::utostr(Context.getAnonymousStructId(RD) + 1);
857 mangleSourceName(Name.str());
858 break;
859 }
860
Guy Benyei11169dd2012-12-18 14:30:41 +0000861 // We must have an anonymous struct.
862 const TagDecl *TD = cast<TagDecl>(ND);
863 if (const TypedefNameDecl *D = TD->getTypedefNameForAnonDecl()) {
864 assert(TD->getDeclContext() == D->getDeclContext() &&
865 "Typedef should not be in another decl context!");
866 assert(D->getDeclName().getAsIdentifierInfo() &&
867 "Typedef was not named!");
David Majnemer956bc112013-11-25 17:50:19 +0000868 mangleSourceName(D->getDeclName().getAsIdentifierInfo()->getName());
Guy Benyei11169dd2012-12-18 14:30:41 +0000869 break;
870 }
871
David Majnemerf017ec32014-03-05 10:35:06 +0000872 if (const CXXRecordDecl *Record = dyn_cast<CXXRecordDecl>(TD)) {
873 if (Record->isLambda()) {
874 llvm::SmallString<10> Name("<lambda_");
David Majnemer984498f2016-12-06 17:01:02 +0000875
876 Decl *LambdaContextDecl = Record->getLambdaContextDecl();
877 unsigned LambdaManglingNumber = Record->getLambdaManglingNumber();
David Majnemerf017ec32014-03-05 10:35:06 +0000878 unsigned LambdaId;
David Majnemer984498f2016-12-06 17:01:02 +0000879 const ParmVarDecl *Parm =
880 dyn_cast_or_null<ParmVarDecl>(LambdaContextDecl);
881 const FunctionDecl *Func =
882 Parm ? dyn_cast<FunctionDecl>(Parm->getDeclContext()) : nullptr;
883
884 if (Func) {
885 unsigned DefaultArgNo =
886 Func->getNumParams() - Parm->getFunctionScopeIndex();
887 Name += llvm::utostr(DefaultArgNo);
888 Name += "_";
889 }
890
891 if (LambdaManglingNumber)
892 LambdaId = LambdaManglingNumber;
David Majnemerf017ec32014-03-05 10:35:06 +0000893 else
894 LambdaId = Context.getLambdaId(Record);
895
896 Name += llvm::utostr(LambdaId);
897 Name += ">";
898
899 mangleSourceName(Name);
David Majnemer984498f2016-12-06 17:01:02 +0000900
901 // If the context of a closure type is an initializer for a class
902 // member (static or nonstatic), it is encoded in a qualified name.
903 if (LambdaManglingNumber && LambdaContextDecl) {
904 if ((isa<VarDecl>(LambdaContextDecl) ||
905 isa<FieldDecl>(LambdaContextDecl)) &&
906 LambdaContextDecl->getDeclContext()->isRecord()) {
907 mangleUnqualifiedName(cast<NamedDecl>(LambdaContextDecl));
908 }
909 }
David Majnemerf017ec32014-03-05 10:35:06 +0000910 break;
911 }
912 }
913
David Majnemera5cfddc2016-12-25 05:26:02 +0000914 llvm::SmallString<64> Name;
David Majnemer00350522015-08-31 18:48:39 +0000915 if (DeclaratorDecl *DD =
916 Context.getASTContext().getDeclaratorForUnnamedTagDecl(TD)) {
917 // Anonymous types without a name for linkage purposes have their
David Majnemer2206bf52014-03-05 08:57:59 +0000918 // declarator mangled in if they have one.
David Majnemera5cfddc2016-12-25 05:26:02 +0000919 Name += "<unnamed-type-";
David Majnemer00350522015-08-31 18:48:39 +0000920 Name += DD->getName();
921 } else if (TypedefNameDecl *TND =
922 Context.getASTContext().getTypedefNameForUnnamedTagDecl(
923 TD)) {
924 // Anonymous types without a name for linkage purposes have their
925 // associate typedef mangled in if they have one.
David Majnemera5cfddc2016-12-25 05:26:02 +0000926 Name += "<unnamed-type-";
David Majnemer00350522015-08-31 18:48:39 +0000927 Name += TND->getName();
Hans Wennborg4cae35f2018-06-11 06:54:23 +0000928 } else if (isa<EnumDecl>(TD) &&
929 cast<EnumDecl>(TD)->enumerator_begin() !=
930 cast<EnumDecl>(TD)->enumerator_end()) {
931 // Anonymous non-empty enums mangle in the first enumerator.
932 auto *ED = cast<EnumDecl>(TD);
David Majnemera5cfddc2016-12-25 05:26:02 +0000933 Name += "<unnamed-enum-";
Hans Wennborg4cae35f2018-06-11 06:54:23 +0000934 Name += ED->enumerator_begin()->getName();
David Majnemer956bc112013-11-25 17:50:19 +0000935 } else {
David Majnemer2206bf52014-03-05 08:57:59 +0000936 // Otherwise, number the types using a $S prefix.
David Majnemera5cfddc2016-12-25 05:26:02 +0000937 Name += "<unnamed-type-$S";
David Majnemeree6c4092015-10-22 07:15:56 +0000938 Name += llvm::utostr(Context.getAnonymousStructId(TD) + 1);
David Majnemer956bc112013-11-25 17:50:19 +0000939 }
David Majnemer2206bf52014-03-05 08:57:59 +0000940 Name += ">";
941 mangleSourceName(Name.str());
Guy Benyei11169dd2012-12-18 14:30:41 +0000942 break;
943 }
David Majnemerb4119f72013-12-13 01:06:04 +0000944
Guy Benyei11169dd2012-12-18 14:30:41 +0000945 case DeclarationName::ObjCZeroArgSelector:
946 case DeclarationName::ObjCOneArgSelector:
David Chisnall060a7892018-08-14 10:04:36 +0000947 case DeclarationName::ObjCMultiArgSelector: {
948 // This is reachable only when constructing an outlined SEH finally
949 // block. Nothing depends on this mangling and it's used only with
950 // functinos with internal linkage.
951 llvm::SmallString<64> Name;
952 mangleSourceName(Name.str());
953 break;
954 }
David Majnemerb4119f72013-12-13 01:06:04 +0000955
Guy Benyei11169dd2012-12-18 14:30:41 +0000956 case DeclarationName::CXXConstructorName:
Reid Klecknere4bb54a2017-01-09 17:09:59 +0000957 if (isStructorDecl(ND)) {
David Majnemerdfa6d202015-03-11 18:36:39 +0000958 if (StructorType == Ctor_CopyingClosure) {
959 Out << "?_O";
960 return;
961 }
962 if (StructorType == Ctor_DefaultClosure) {
963 Out << "?_F";
964 return;
965 }
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000966 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000967 Out << "?0";
David Majnemerdfa6d202015-03-11 18:36:39 +0000968 return;
David Majnemerb4119f72013-12-13 01:06:04 +0000969
Guy Benyei11169dd2012-12-18 14:30:41 +0000970 case DeclarationName::CXXDestructorName:
Reid Kleckner290feb92017-01-09 17:04:37 +0000971 if (isStructorDecl(ND))
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +0000972 // If the named decl is the C++ destructor we're mangling,
973 // use the type we were given.
974 mangleCXXDtorType(static_cast<CXXDtorType>(StructorType));
975 else
Reid Klecknere7de47e2013-07-22 13:51:44 +0000976 // Otherwise, use the base destructor name. This is relevant if a
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +0000977 // class with a destructor is declared within a destructor.
Reid Klecknere7de47e2013-07-22 13:51:44 +0000978 mangleCXXDtorType(Dtor_Base);
Guy Benyei11169dd2012-12-18 14:30:41 +0000979 break;
David Majnemerb4119f72013-12-13 01:06:04 +0000980
Guy Benyei11169dd2012-12-18 14:30:41 +0000981 case DeclarationName::CXXConversionFunctionName:
982 // <operator-name> ::= ?B # (cast)
983 // The target type is encoded as the return type.
984 Out << "?B";
985 break;
David Majnemerb4119f72013-12-13 01:06:04 +0000986
Guy Benyei11169dd2012-12-18 14:30:41 +0000987 case DeclarationName::CXXOperatorName:
988 mangleOperatorName(Name.getCXXOverloadedOperator(), ND->getLocation());
989 break;
David Majnemerb4119f72013-12-13 01:06:04 +0000990
Guy Benyei11169dd2012-12-18 14:30:41 +0000991 case DeclarationName::CXXLiteralOperatorName: {
David Majnemere31a3ed2014-06-04 16:46:26 +0000992 Out << "?__K";
993 mangleSourceName(Name.getCXXLiteralIdentifier()->getName());
Guy Benyei11169dd2012-12-18 14:30:41 +0000994 break;
995 }
David Majnemerb4119f72013-12-13 01:06:04 +0000996
Richard Smith35845152017-02-07 01:37:30 +0000997 case DeclarationName::CXXDeductionGuideName:
998 llvm_unreachable("Can't mangle a deduction guide name!");
999
Guy Benyei11169dd2012-12-18 14:30:41 +00001000 case DeclarationName::CXXUsingDirective:
1001 llvm_unreachable("Can't mangle a using directive name!");
1002 }
1003}
1004
Saleem Abdulrasool58340522018-02-07 01:55:08 +00001005// <postfix> ::= <unqualified-name> [<postfix>]
1006// ::= <substitution> [<postfix>]
David Majnemer2206bf52014-03-05 08:57:59 +00001007void MicrosoftCXXNameMangler::mangleNestedName(const NamedDecl *ND) {
David Majnemerff9075f2014-08-06 03:12:47 +00001008 const DeclContext *DC = getEffectiveDeclContext(ND);
David Majnemer2206bf52014-03-05 08:57:59 +00001009 while (!DC->isTranslationUnit()) {
1010 if (isa<TagDecl>(ND) || isa<VarDecl>(ND)) {
1011 unsigned Disc;
1012 if (Context.getNextDiscriminator(ND, Disc)) {
1013 Out << '?';
1014 mangleNumber(Disc);
1015 Out << '?';
1016 }
1017 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001018
David Majnemer2206bf52014-03-05 08:57:59 +00001019 if (const BlockDecl *BD = dyn_cast<BlockDecl>(DC)) {
Saleem Abdulrasool3cc6d0b2017-06-26 23:28:42 +00001020 auto Discriminate =
1021 [](StringRef Name, const unsigned Discriminator,
1022 const unsigned ParameterDiscriminator) -> std::string {
1023 std::string Buffer;
1024 llvm::raw_string_ostream Stream(Buffer);
1025 Stream << Name;
1026 if (Discriminator)
1027 Stream << '_' << Discriminator;
1028 if (ParameterDiscriminator)
1029 Stream << '_' << ParameterDiscriminator;
1030 return Stream.str();
1031 };
David Majnemer2206bf52014-03-05 08:57:59 +00001032
Saleem Abdulrasool3cc6d0b2017-06-26 23:28:42 +00001033 unsigned Discriminator = BD->getBlockManglingNumber();
1034 if (!Discriminator)
1035 Discriminator = Context.getBlockId(BD, /*Local=*/false);
1036
1037 // Mangle the parameter position as a discriminator to deal with unnamed
1038 // parameters. Rather than mangling the unqualified parameter name,
1039 // always use the position to give a uniform mangling.
1040 unsigned ParameterDiscriminator = 0;
1041 if (const auto *MC = BD->getBlockManglingContextDecl())
1042 if (const auto *P = dyn_cast<ParmVarDecl>(MC))
1043 if (const auto *F = dyn_cast<FunctionDecl>(P->getDeclContext()))
1044 ParameterDiscriminator =
1045 F->getNumParams() - P->getFunctionScopeIndex();
1046
1047 DC = getEffectiveDeclContext(BD);
1048
1049 Out << '?';
1050 mangleSourceName(Discriminate("_block_invoke", Discriminator,
1051 ParameterDiscriminator));
1052 // If we have a block mangling context, encode that now. This allows us
1053 // to discriminate between named static data initializers in the same
1054 // scope. This is handled differently from parameters, which use
1055 // positions to discriminate between multiple instances.
1056 if (const auto *MC = BD->getBlockManglingContextDecl())
1057 if (!isa<ParmVarDecl>(MC))
1058 if (const auto *ND = dyn_cast<NamedDecl>(MC))
1059 mangleUnqualifiedName(ND);
1060 // MS ABI and Itanium manglings are in inverted scopes. In the case of a
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00001061 // RecordDecl, mangle the entire scope hierarchy at this point rather than
Saleem Abdulrasool3cc6d0b2017-06-26 23:28:42 +00001062 // just the unqualified name to get the ordering correct.
1063 if (const auto *RD = dyn_cast<RecordDecl>(DC))
1064 mangleName(RD);
1065 else
1066 Out << '@';
1067 // void __cdecl
1068 Out << "YAX";
1069 // struct __block_literal *
1070 Out << 'P';
1071 // __ptr64
1072 if (PointersAre64Bit)
1073 Out << 'E';
1074 Out << 'A';
Shoaib Meenaid84cf132018-11-14 19:16:22 +00001075 mangleArtificialTagType(TTK_Struct,
Saleem Abdulrasool3cc6d0b2017-06-26 23:28:42 +00001076 Discriminate("__block_literal", Discriminator,
1077 ParameterDiscriminator));
1078 Out << "@Z";
1079
1080 // If the effective context was a Record, we have fully mangled the
1081 // qualified name and do not need to continue.
1082 if (isa<RecordDecl>(DC))
1083 break;
1084 continue;
David Majnemer2206bf52014-03-05 08:57:59 +00001085 } else if (const ObjCMethodDecl *Method = dyn_cast<ObjCMethodDecl>(DC)) {
1086 mangleObjCMethodName(Method);
1087 } else if (isa<NamedDecl>(DC)) {
1088 ND = cast<NamedDecl>(DC);
1089 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)) {
1090 mangle(FD, "?");
1091 break;
David Majnemer984498f2016-12-06 17:01:02 +00001092 } else {
David Majnemer2206bf52014-03-05 08:57:59 +00001093 mangleUnqualifiedName(ND);
David Majnemer984498f2016-12-06 17:01:02 +00001094 // Lambdas in default arguments conceptually belong to the function the
1095 // parameter corresponds to.
1096 if (const auto *LDADC = getLambdaDefaultArgumentDeclContext(ND)) {
1097 DC = LDADC;
1098 continue;
1099 }
1100 }
David Majnemer2206bf52014-03-05 08:57:59 +00001101 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001102 DC = DC->getParent();
Guy Benyei11169dd2012-12-18 14:30:41 +00001103 }
1104}
1105
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001106void MicrosoftCXXNameMangler::mangleCXXDtorType(CXXDtorType T) {
Reid Klecknere7de47e2013-07-22 13:51:44 +00001107 // Microsoft uses the names on the case labels for these dtor variants. Clang
1108 // uses the Itanium terminology internally. Everything in this ABI delegates
1109 // towards the base dtor.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001110 switch (T) {
Reid Klecknere7de47e2013-07-22 13:51:44 +00001111 // <operator-name> ::= ?1 # destructor
1112 case Dtor_Base: Out << "?1"; return;
1113 // <operator-name> ::= ?_D # vbase destructor
1114 case Dtor_Complete: Out << "?_D"; return;
1115 // <operator-name> ::= ?_G # scalar deleting destructor
1116 case Dtor_Deleting: Out << "?_G"; return;
1117 // <operator-name> ::= ?_E # vector deleting destructor
1118 // FIXME: Add a vector deleting dtor type. It goes in the vtable, so we need
1119 // it.
Rafael Espindola1e4df922014-09-16 15:18:21 +00001120 case Dtor_Comdat:
1121 llvm_unreachable("not expecting a COMDAT");
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001122 }
1123 llvm_unreachable("Unsupported dtor type?");
1124}
1125
Guy Benyei11169dd2012-12-18 14:30:41 +00001126void MicrosoftCXXNameMangler::mangleOperatorName(OverloadedOperatorKind OO,
1127 SourceLocation Loc) {
1128 switch (OO) {
1129 // ?0 # constructor
1130 // ?1 # destructor
1131 // <operator-name> ::= ?2 # new
1132 case OO_New: Out << "?2"; break;
1133 // <operator-name> ::= ?3 # delete
1134 case OO_Delete: Out << "?3"; break;
1135 // <operator-name> ::= ?4 # =
1136 case OO_Equal: Out << "?4"; break;
1137 // <operator-name> ::= ?5 # >>
1138 case OO_GreaterGreater: Out << "?5"; break;
1139 // <operator-name> ::= ?6 # <<
1140 case OO_LessLess: Out << "?6"; break;
1141 // <operator-name> ::= ?7 # !
1142 case OO_Exclaim: Out << "?7"; break;
1143 // <operator-name> ::= ?8 # ==
1144 case OO_EqualEqual: Out << "?8"; break;
1145 // <operator-name> ::= ?9 # !=
1146 case OO_ExclaimEqual: Out << "?9"; break;
1147 // <operator-name> ::= ?A # []
1148 case OO_Subscript: Out << "?A"; break;
1149 // ?B # conversion
1150 // <operator-name> ::= ?C # ->
1151 case OO_Arrow: Out << "?C"; break;
1152 // <operator-name> ::= ?D # *
1153 case OO_Star: Out << "?D"; break;
1154 // <operator-name> ::= ?E # ++
1155 case OO_PlusPlus: Out << "?E"; break;
1156 // <operator-name> ::= ?F # --
1157 case OO_MinusMinus: Out << "?F"; break;
1158 // <operator-name> ::= ?G # -
1159 case OO_Minus: Out << "?G"; break;
1160 // <operator-name> ::= ?H # +
1161 case OO_Plus: Out << "?H"; break;
1162 // <operator-name> ::= ?I # &
1163 case OO_Amp: Out << "?I"; break;
1164 // <operator-name> ::= ?J # ->*
1165 case OO_ArrowStar: Out << "?J"; break;
1166 // <operator-name> ::= ?K # /
1167 case OO_Slash: Out << "?K"; break;
1168 // <operator-name> ::= ?L # %
1169 case OO_Percent: Out << "?L"; break;
1170 // <operator-name> ::= ?M # <
1171 case OO_Less: Out << "?M"; break;
1172 // <operator-name> ::= ?N # <=
1173 case OO_LessEqual: Out << "?N"; break;
1174 // <operator-name> ::= ?O # >
1175 case OO_Greater: Out << "?O"; break;
1176 // <operator-name> ::= ?P # >=
1177 case OO_GreaterEqual: Out << "?P"; break;
1178 // <operator-name> ::= ?Q # ,
1179 case OO_Comma: Out << "?Q"; break;
1180 // <operator-name> ::= ?R # ()
1181 case OO_Call: Out << "?R"; break;
1182 // <operator-name> ::= ?S # ~
1183 case OO_Tilde: Out << "?S"; break;
1184 // <operator-name> ::= ?T # ^
1185 case OO_Caret: Out << "?T"; break;
1186 // <operator-name> ::= ?U # |
1187 case OO_Pipe: Out << "?U"; break;
1188 // <operator-name> ::= ?V # &&
1189 case OO_AmpAmp: Out << "?V"; break;
1190 // <operator-name> ::= ?W # ||
1191 case OO_PipePipe: Out << "?W"; break;
1192 // <operator-name> ::= ?X # *=
1193 case OO_StarEqual: Out << "?X"; break;
1194 // <operator-name> ::= ?Y # +=
1195 case OO_PlusEqual: Out << "?Y"; break;
1196 // <operator-name> ::= ?Z # -=
1197 case OO_MinusEqual: Out << "?Z"; break;
1198 // <operator-name> ::= ?_0 # /=
1199 case OO_SlashEqual: Out << "?_0"; break;
1200 // <operator-name> ::= ?_1 # %=
1201 case OO_PercentEqual: Out << "?_1"; break;
1202 // <operator-name> ::= ?_2 # >>=
1203 case OO_GreaterGreaterEqual: Out << "?_2"; break;
1204 // <operator-name> ::= ?_3 # <<=
1205 case OO_LessLessEqual: Out << "?_3"; break;
1206 // <operator-name> ::= ?_4 # &=
1207 case OO_AmpEqual: Out << "?_4"; break;
1208 // <operator-name> ::= ?_5 # |=
1209 case OO_PipeEqual: Out << "?_5"; break;
1210 // <operator-name> ::= ?_6 # ^=
1211 case OO_CaretEqual: Out << "?_6"; break;
1212 // ?_7 # vftable
1213 // ?_8 # vbtable
1214 // ?_9 # vcall
1215 // ?_A # typeof
1216 // ?_B # local static guard
1217 // ?_C # string
1218 // ?_D # vbase destructor
1219 // ?_E # vector deleting destructor
1220 // ?_F # default constructor closure
1221 // ?_G # scalar deleting destructor
1222 // ?_H # vector constructor iterator
1223 // ?_I # vector destructor iterator
1224 // ?_J # vector vbase constructor iterator
1225 // ?_K # virtual displacement map
1226 // ?_L # eh vector constructor iterator
1227 // ?_M # eh vector destructor iterator
1228 // ?_N # eh vector vbase constructor iterator
1229 // ?_O # copy constructor closure
1230 // ?_P<name> # udt returning <name>
1231 // ?_Q # <unknown>
1232 // ?_R0 # RTTI Type Descriptor
1233 // ?_R1 # RTTI Base Class Descriptor at (a,b,c,d)
1234 // ?_R2 # RTTI Base Class Array
1235 // ?_R3 # RTTI Class Hierarchy Descriptor
1236 // ?_R4 # RTTI Complete Object Locator
1237 // ?_S # local vftable
1238 // ?_T # local vftable constructor closure
1239 // <operator-name> ::= ?_U # new[]
1240 case OO_Array_New: Out << "?_U"; break;
1241 // <operator-name> ::= ?_V # delete[]
1242 case OO_Array_Delete: Out << "?_V"; break;
Gor Nishanove2f51be2016-09-28 22:37:17 +00001243 // <operator-name> ::= ?__L # co_await
1244 case OO_Coawait: Out << "?__L"; break;
Nico Weber27df4092019-04-23 16:37:42 +00001245 // <operator-name> ::= ?__M # <=>
1246 case OO_Spaceship: Out << "?__M"; break;
Richard Smithd30b23d2017-12-01 02:13:10 +00001247
Guy Benyei11169dd2012-12-18 14:30:41 +00001248 case OO_Conditional: {
1249 DiagnosticsEngine &Diags = Context.getDiags();
1250 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
1251 "cannot mangle this conditional operator yet");
1252 Diags.Report(Loc, DiagID);
1253 break;
1254 }
David Majnemerb4119f72013-12-13 01:06:04 +00001255
Guy Benyei11169dd2012-12-18 14:30:41 +00001256 case OO_None:
1257 case NUM_OVERLOADED_OPERATORS:
1258 llvm_unreachable("Not an overloaded operator");
1259 }
1260}
1261
David Majnemer956bc112013-11-25 17:50:19 +00001262void MicrosoftCXXNameMangler::mangleSourceName(StringRef Name) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001263 // <source name> ::= <identifier> @
Fangrui Song75e74e02019-03-31 08:48:19 +00001264 BackRefVec::iterator Found = llvm::find(NameBackReferences, Name);
David Majnemerc986fcc2014-06-08 04:51:13 +00001265 if (Found == NameBackReferences.end()) {
David Majnemer0d0560c2014-09-25 19:43:56 +00001266 if (NameBackReferences.size() < 10)
1267 NameBackReferences.push_back(Name);
David Majnemer956bc112013-11-25 17:50:19 +00001268 Out << Name << '@';
Guy Benyei11169dd2012-12-18 14:30:41 +00001269 } else {
David Majnemer0d0560c2014-09-25 19:43:56 +00001270 Out << (Found - NameBackReferences.begin());
Guy Benyei11169dd2012-12-18 14:30:41 +00001271 }
1272}
1273
1274void MicrosoftCXXNameMangler::mangleObjCMethodName(const ObjCMethodDecl *MD) {
1275 Context.mangleObjCMethodName(MD, Out);
1276}
1277
Guy Benyei11169dd2012-12-18 14:30:41 +00001278void MicrosoftCXXNameMangler::mangleTemplateInstantiationName(
David Majnemer02e9af42014-04-23 05:16:51 +00001279 const TemplateDecl *TD, const TemplateArgumentList &TemplateArgs) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001280 // <template-name> ::= <unscoped-template-name> <template-args>
1281 // ::= <substitution>
1282 // Always start with the unqualified name.
1283
1284 // Templates have their own context for back references.
1285 ArgBackRefMap OuterArgsContext;
David Majnemer0d0560c2014-09-25 19:43:56 +00001286 BackRefVec OuterTemplateContext;
David Majnemer5f177622015-12-30 05:13:03 +00001287 PassObjectSizeArgsSet OuterPassObjectSizeArgs;
Guy Benyei11169dd2012-12-18 14:30:41 +00001288 NameBackReferences.swap(OuterTemplateContext);
1289 TypeBackReferences.swap(OuterArgsContext);
David Majnemer5f177622015-12-30 05:13:03 +00001290 PassObjectSizeArgs.swap(OuterPassObjectSizeArgs);
Guy Benyei11169dd2012-12-18 14:30:41 +00001291
1292 mangleUnscopedTemplateName(TD);
Reid Kleckner52518862013-03-20 01:40:23 +00001293 mangleTemplateArgs(TD, TemplateArgs);
Guy Benyei11169dd2012-12-18 14:30:41 +00001294
1295 // Restore the previous back reference contexts.
1296 NameBackReferences.swap(OuterTemplateContext);
1297 TypeBackReferences.swap(OuterArgsContext);
David Majnemer5f177622015-12-30 05:13:03 +00001298 PassObjectSizeArgs.swap(OuterPassObjectSizeArgs);
Guy Benyei11169dd2012-12-18 14:30:41 +00001299}
1300
1301void
1302MicrosoftCXXNameMangler::mangleUnscopedTemplateName(const TemplateDecl *TD) {
1303 // <unscoped-template-name> ::= ?$ <unqualified-name>
1304 Out << "?$";
1305 mangleUnqualifiedName(TD);
1306}
1307
David Majnemer02e9af42014-04-23 05:16:51 +00001308void MicrosoftCXXNameMangler::mangleIntegerLiteral(const llvm::APSInt &Value,
1309 bool IsBoolean) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001310 // <integer-literal> ::= $0 <number>
1311 Out << "$0";
1312 // Make sure booleans are encoded as 0/1.
1313 if (IsBoolean && Value.getBoolValue())
1314 mangleNumber(1);
Will Wilsone74c2812014-12-11 05:47:10 +00001315 else if (Value.isSigned())
David Majnemer2a816452013-12-09 10:44:32 +00001316 mangleNumber(Value.getSExtValue());
Will Wilsone74c2812014-12-11 05:47:10 +00001317 else
1318 mangleNumber(Value.getZExtValue());
Guy Benyei11169dd2012-12-18 14:30:41 +00001319}
1320
David Majnemer02e9af42014-04-23 05:16:51 +00001321void MicrosoftCXXNameMangler::mangleExpression(const Expr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001322 // See if this is a constant expression.
1323 llvm::APSInt Value;
1324 if (E->isIntegerConstantExpr(Value, Context.getASTContext())) {
1325 mangleIntegerLiteral(Value, E->getType()->isBooleanType());
1326 return;
1327 }
1328
Reid Klecknerb4848e72014-06-10 20:06:25 +00001329 // Look through no-op casts like template parameter substitutions.
1330 E = E->IgnoreParenNoopCasts(Context.getASTContext());
1331
Craig Topper36250ad2014-05-12 05:36:57 +00001332 const CXXUuidofExpr *UE = nullptr;
David Majnemer8eaab6f2013-08-13 06:32:20 +00001333 if (const UnaryOperator *UO = dyn_cast<UnaryOperator>(E)) {
1334 if (UO->getOpcode() == UO_AddrOf)
1335 UE = dyn_cast<CXXUuidofExpr>(UO->getSubExpr());
1336 } else
1337 UE = dyn_cast<CXXUuidofExpr>(E);
1338
1339 if (UE) {
David Majnemere9cab2f2013-08-13 09:17:25 +00001340 // If we had to peek through an address-of operator, treat this like we are
David Majnemer8eaab6f2013-08-13 06:32:20 +00001341 // dealing with a pointer type. Otherwise, treat it like a const reference.
1342 //
1343 // N.B. This matches up with the handling of TemplateArgument::Declaration
1344 // in mangleTemplateArg
1345 if (UE == E)
1346 Out << "$E?";
1347 else
1348 Out << "$1?";
David Majnemer3add70b2015-12-29 11:45:53 +00001349
1350 // This CXXUuidofExpr is mangled as-if it were actually a VarDecl from
1351 // const __s_GUID _GUID_{lower case UUID with underscores}
David Majnemer2041b462016-03-28 03:19:50 +00001352 StringRef Uuid = UE->getUuidStr();
David Majnemer3add70b2015-12-29 11:45:53 +00001353 std::string Name = "_GUID_" + Uuid.lower();
1354 std::replace(Name.begin(), Name.end(), '-', '_');
1355
1356 mangleSourceName(Name);
1357 // Terminate the whole name with an '@'.
1358 Out << '@';
1359 // It's a global variable.
1360 Out << '3';
1361 // It's a struct called __s_GUID.
Shoaib Meenaid84cf132018-11-14 19:16:22 +00001362 mangleArtificialTagType(TTK_Struct, "__s_GUID");
David Majnemer3add70b2015-12-29 11:45:53 +00001363 // It's const.
1364 Out << 'B';
David Majnemer8eaab6f2013-08-13 06:32:20 +00001365 return;
1366 }
1367
Guy Benyei11169dd2012-12-18 14:30:41 +00001368 // As bad as this diagnostic is, it's better than crashing.
1369 DiagnosticsEngine &Diags = Context.getDiags();
David Majnemer02e9af42014-04-23 05:16:51 +00001370 unsigned DiagID = Diags.getCustomDiagID(
1371 DiagnosticsEngine::Error, "cannot yet mangle expression type %0");
1372 Diags.Report(E->getExprLoc(), DiagID) << E->getStmtClassName()
1373 << E->getSourceRange();
Guy Benyei11169dd2012-12-18 14:30:41 +00001374}
1375
David Majnemer8265dec2014-03-30 16:30:54 +00001376void MicrosoftCXXNameMangler::mangleTemplateArgs(
1377 const TemplateDecl *TD, const TemplateArgumentList &TemplateArgs) {
Reid Kleckner11c6f612014-06-26 22:42:18 +00001378 // <template-args> ::= <template-arg>+
David Majnemer57fbc0c2014-08-05 22:43:45 +00001379 const TemplateParameterList *TPL = TD->getTemplateParameters();
1380 assert(TPL->size() == TemplateArgs.size() &&
1381 "size mismatch between args and parms!");
1382
Nico Webere2dd1572018-09-08 20:58:39 +00001383 for (size_t i = 0; i < TemplateArgs.size(); ++i) {
1384 const TemplateArgument &TA = TemplateArgs[i];
1385
1386 // Separate consecutive packs by $$Z.
1387 if (i > 0 && TA.getKind() == TemplateArgument::Pack &&
1388 TemplateArgs[i - 1].getKind() == TemplateArgument::Pack)
1389 Out << "$$Z";
1390
1391 mangleTemplateArg(TD, TA, TPL->getParam(i));
1392 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001393}
1394
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001395void MicrosoftCXXNameMangler::mangleTemplateArg(const TemplateDecl *TD,
David Majnemer57fbc0c2014-08-05 22:43:45 +00001396 const TemplateArgument &TA,
1397 const NamedDecl *Parm) {
Reid Kleckner96f8f932014-02-05 17:27:08 +00001398 // <template-arg> ::= <type>
1399 // ::= <integer-literal>
1400 // ::= <member-data-pointer>
1401 // ::= <member-function-pointer>
1402 // ::= $E? <name> <type-encoding>
1403 // ::= $1? <name> <type-encoding>
1404 // ::= $0A@
1405 // ::= <template-args>
1406
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001407 switch (TA.getKind()) {
1408 case TemplateArgument::Null:
1409 llvm_unreachable("Can't mangle null template arguments!");
David Majnemer08177c52013-08-27 08:21:25 +00001410 case TemplateArgument::TemplateExpansion:
1411 llvm_unreachable("Can't mangle template expansion arguments!");
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001412 case TemplateArgument::Type: {
1413 QualType T = TA.getAsType();
1414 mangleType(T, SourceRange(), QMM_Escape);
1415 break;
1416 }
David Majnemere8fdc062013-08-13 01:25:35 +00001417 case TemplateArgument::Declaration: {
George Burgess IV00f70bd2018-03-01 05:43:23 +00001418 const NamedDecl *ND = TA.getAsDecl();
David Majnemer1e378e42014-02-06 12:46:52 +00001419 if (isa<FieldDecl>(ND) || isa<IndirectFieldDecl>(ND)) {
Nico Weber2b5f3fd2018-08-01 11:56:20 +00001420 mangleMemberDataPointer(cast<CXXRecordDecl>(ND->getDeclContext())
1421 ->getMostRecentNonInjectedDecl(),
1422 cast<ValueDecl>(ND));
Reid Kleckner09b47d12014-02-05 18:59:38 +00001423 } else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)) {
Nick Lewycky1f529662014-02-05 23:53:29 +00001424 const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD);
David Majnemerab4b4a12015-05-18 00:05:25 +00001425 if (MD && MD->isInstance()) {
Nico Weber2b5f3fd2018-08-01 11:56:20 +00001426 mangleMemberFunctionPointer(
1427 MD->getParent()->getMostRecentNonInjectedDecl(), MD);
David Majnemerab4b4a12015-05-18 00:05:25 +00001428 } else {
1429 Out << "$1?";
1430 mangleName(FD);
1431 mangleFunctionEncoding(FD, /*ShouldMangle=*/true);
1432 }
Reid Kleckner09b47d12014-02-05 18:59:38 +00001433 } else {
David Blaikie952a9b12014-10-17 18:00:12 +00001434 mangle(ND, TA.getParamTypeForDecl()->isReferenceType() ? "$E?" : "$1?");
Reid Kleckner09b47d12014-02-05 18:59:38 +00001435 }
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001436 break;
David Majnemere8fdc062013-08-13 01:25:35 +00001437 }
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001438 case TemplateArgument::Integral:
1439 mangleIntegerLiteral(TA.getAsIntegral(),
1440 TA.getIntegralType()->isBooleanType());
1441 break;
Reid Kleckner96f8f932014-02-05 17:27:08 +00001442 case TemplateArgument::NullPtr: {
1443 QualType T = TA.getNullPtrType();
1444 if (const MemberPointerType *MPT = T->getAs<MemberPointerType>()) {
David Majnemer763584d2014-02-06 10:59:19 +00001445 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
David Majnemerf3027172015-12-01 19:13:51 +00001446 if (MPT->isMemberFunctionPointerType() &&
1447 !isa<FunctionTemplateDecl>(TD)) {
Craig Topper36250ad2014-05-12 05:36:57 +00001448 mangleMemberFunctionPointer(RD, nullptr);
David Majnemer19187872014-06-11 07:08:37 +00001449 return;
1450 }
1451 if (MPT->isMemberDataPointer()) {
David Majnemerf3027172015-12-01 19:13:51 +00001452 if (!isa<FunctionTemplateDecl>(TD)) {
David Majnemer10236682015-07-02 09:43:11 +00001453 mangleMemberDataPointer(RD, nullptr);
1454 return;
1455 }
1456 // nullptr data pointers are always represented with a single field
1457 // which is initialized with either 0 or -1. Why -1? Well, we need to
1458 // distinguish the case where the data member is at offset zero in the
1459 // record.
1460 // However, we are free to use 0 *if* we would use multiple fields for
1461 // non-nullptr member pointers.
1462 if (!RD->nullFieldOffsetIsZero()) {
1463 mangleIntegerLiteral(llvm::APSInt::get(-1), /*IsBoolean=*/false);
1464 return;
1465 }
David Majnemer19187872014-06-11 07:08:37 +00001466 }
Reid Kleckner96f8f932014-02-05 17:27:08 +00001467 }
David Majnemer10236682015-07-02 09:43:11 +00001468 mangleIntegerLiteral(llvm::APSInt::getUnsigned(0), /*IsBoolean=*/false);
David Majnemerae465ef2013-08-05 21:33:59 +00001469 break;
Reid Kleckner96f8f932014-02-05 17:27:08 +00001470 }
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001471 case TemplateArgument::Expression:
1472 mangleExpression(TA.getAsExpr());
1473 break;
David Majnemer06fa05a2014-06-04 16:46:32 +00001474 case TemplateArgument::Pack: {
Craig Topper00bbdcf2014-06-28 23:22:23 +00001475 ArrayRef<TemplateArgument> TemplateArgs = TA.getPackAsArray();
David Majnemer06fa05a2014-06-04 16:46:32 +00001476 if (TemplateArgs.empty()) {
David Majnemer57fbc0c2014-08-05 22:43:45 +00001477 if (isa<TemplateTypeParmDecl>(Parm) ||
1478 isa<TemplateTemplateParmDecl>(Parm))
David Majnemer4deaac72015-03-18 03:56:27 +00001479 // MSVC 2015 changed the mangling for empty expanded template packs,
1480 // use the old mangling for link compatibility for old versions.
David Majnemerb710a932015-05-11 03:57:49 +00001481 Out << (Context.getASTContext().getLangOpts().isCompatibleWithMSVC(
1482 LangOptions::MSVC2015)
David Majnemer4deaac72015-03-18 03:56:27 +00001483 ? "$$V"
1484 : "$$$V");
David Majnemer57fbc0c2014-08-05 22:43:45 +00001485 else if (isa<NonTypeTemplateParmDecl>(Parm))
1486 Out << "$S";
1487 else
1488 llvm_unreachable("unexpected template parameter decl!");
David Majnemer06fa05a2014-06-04 16:46:32 +00001489 } else {
1490 for (const TemplateArgument &PA : TemplateArgs)
David Majnemer57fbc0c2014-08-05 22:43:45 +00001491 mangleTemplateArg(TD, PA, Parm);
David Majnemer06fa05a2014-06-04 16:46:32 +00001492 }
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001493 break;
David Majnemer06fa05a2014-06-04 16:46:32 +00001494 }
David Majnemer8d5f9ab2014-07-30 08:20:03 +00001495 case TemplateArgument::Template: {
1496 const NamedDecl *ND =
1497 TA.getAsTemplate().getAsTemplateDecl()->getTemplatedDecl();
1498 if (const auto *TD = dyn_cast<TagDecl>(ND)) {
1499 mangleType(TD);
1500 } else if (isa<TypeAliasDecl>(ND)) {
David Majnemer9a3bc592014-08-19 07:29:03 +00001501 Out << "$$Y";
1502 mangleName(ND);
David Majnemer8d5f9ab2014-07-30 08:20:03 +00001503 } else {
1504 llvm_unreachable("unexpected template template NamedDecl!");
1505 }
David Majnemer0db0ca42013-08-05 22:26:46 +00001506 break;
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001507 }
David Majnemer8d5f9ab2014-07-30 08:20:03 +00001508 }
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001509}
1510
Saleem Abdulrasoolbbce34a2018-02-09 03:23:54 +00001511void MicrosoftCXXNameMangler::mangleObjCProtocol(const ObjCProtocolDecl *PD) {
1512 llvm::SmallString<64> TemplateMangling;
1513 llvm::raw_svector_ostream Stream(TemplateMangling);
1514 MicrosoftCXXNameMangler Extra(Context, Stream);
1515
1516 Stream << "?$";
1517 Extra.mangleSourceName("Protocol");
Shoaib Meenaid84cf132018-11-14 19:16:22 +00001518 Extra.mangleArtificialTagType(TTK_Struct, PD->getName());
Saleem Abdulrasoolbbce34a2018-02-09 03:23:54 +00001519
Shoaib Meenaid84cf132018-11-14 19:16:22 +00001520 mangleArtificialTagType(TTK_Struct, TemplateMangling, {"__ObjC"});
Saleem Abdulrasoolbbce34a2018-02-09 03:23:54 +00001521}
1522
1523void MicrosoftCXXNameMangler::mangleObjCLifetime(const QualType Type,
1524 Qualifiers Quals,
1525 SourceRange Range) {
1526 llvm::SmallString<64> TemplateMangling;
1527 llvm::raw_svector_ostream Stream(TemplateMangling);
1528 MicrosoftCXXNameMangler Extra(Context, Stream);
1529
1530 Stream << "?$";
1531 switch (Quals.getObjCLifetime()) {
1532 case Qualifiers::OCL_None:
1533 case Qualifiers::OCL_ExplicitNone:
1534 break;
1535 case Qualifiers::OCL_Autoreleasing:
1536 Extra.mangleSourceName("Autoreleasing");
1537 break;
1538 case Qualifiers::OCL_Strong:
1539 Extra.mangleSourceName("Strong");
1540 break;
1541 case Qualifiers::OCL_Weak:
1542 Extra.mangleSourceName("Weak");
1543 break;
1544 }
1545 Extra.manglePointerCVQualifiers(Quals);
1546 Extra.manglePointerExtQualifiers(Quals, Type);
1547 Extra.mangleType(Type, Range);
1548
Shoaib Meenaid84cf132018-11-14 19:16:22 +00001549 mangleArtificialTagType(TTK_Struct, TemplateMangling, {"__ObjC"});
Saleem Abdulrasoolbbce34a2018-02-09 03:23:54 +00001550}
1551
Saleem Abdulrasoolf3a981e2018-09-28 16:47:53 +00001552void MicrosoftCXXNameMangler::mangleObjCKindOfType(const ObjCObjectType *T,
1553 Qualifiers Quals,
1554 SourceRange Range) {
1555 llvm::SmallString<64> TemplateMangling;
1556 llvm::raw_svector_ostream Stream(TemplateMangling);
1557 MicrosoftCXXNameMangler Extra(Context, Stream);
1558
1559 Stream << "?$";
1560 Extra.mangleSourceName("KindOf");
1561 Extra.mangleType(QualType(T, 0)
1562 .stripObjCKindOfType(getASTContext())
1563 ->getAs<ObjCObjectType>(),
1564 Quals, Range);
1565
Shoaib Meenaid84cf132018-11-14 19:16:22 +00001566 mangleArtificialTagType(TTK_Struct, TemplateMangling, {"__ObjC"});
Saleem Abdulrasoolf3a981e2018-09-28 16:47:53 +00001567}
1568
Guy Benyei11169dd2012-12-18 14:30:41 +00001569void MicrosoftCXXNameMangler::mangleQualifiers(Qualifiers Quals,
1570 bool IsMember) {
1571 // <cvr-qualifiers> ::= [E] [F] [I] <base-cvr-qualifiers>
1572 // 'E' means __ptr64 (32-bit only); 'F' means __unaligned (32/64-bit only);
1573 // 'I' means __restrict (32/64-bit).
1574 // Note that the MSVC __restrict keyword isn't the same as the C99 restrict
1575 // keyword!
1576 // <base-cvr-qualifiers> ::= A # near
1577 // ::= B # near const
1578 // ::= C # near volatile
1579 // ::= D # near const volatile
1580 // ::= E # far (16-bit)
1581 // ::= F # far const (16-bit)
1582 // ::= G # far volatile (16-bit)
1583 // ::= H # far const volatile (16-bit)
1584 // ::= I # huge (16-bit)
1585 // ::= J # huge const (16-bit)
1586 // ::= K # huge volatile (16-bit)
1587 // ::= L # huge const volatile (16-bit)
1588 // ::= M <basis> # based
1589 // ::= N <basis> # based const
1590 // ::= O <basis> # based volatile
1591 // ::= P <basis> # based const volatile
1592 // ::= Q # near member
1593 // ::= R # near const member
1594 // ::= S # near volatile member
1595 // ::= T # near const volatile member
1596 // ::= U # far member (16-bit)
1597 // ::= V # far const member (16-bit)
1598 // ::= W # far volatile member (16-bit)
1599 // ::= X # far const volatile member (16-bit)
1600 // ::= Y # huge member (16-bit)
1601 // ::= Z # huge const member (16-bit)
1602 // ::= 0 # huge volatile member (16-bit)
1603 // ::= 1 # huge const volatile member (16-bit)
1604 // ::= 2 <basis> # based member
1605 // ::= 3 <basis> # based const member
1606 // ::= 4 <basis> # based volatile member
1607 // ::= 5 <basis> # based const volatile member
1608 // ::= 6 # near function (pointers only)
1609 // ::= 7 # far function (pointers only)
1610 // ::= 8 # near method (pointers only)
1611 // ::= 9 # far method (pointers only)
1612 // ::= _A <basis> # based function (pointers only)
1613 // ::= _B <basis> # based function (far?) (pointers only)
1614 // ::= _C <basis> # based method (pointers only)
1615 // ::= _D <basis> # based method (far?) (pointers only)
1616 // ::= _E # block (Clang)
1617 // <basis> ::= 0 # __based(void)
1618 // ::= 1 # __based(segment)?
1619 // ::= 2 <name> # __based(name)
1620 // ::= 3 # ?
1621 // ::= 4 # ?
1622 // ::= 5 # not really based
1623 bool HasConst = Quals.hasConst(),
1624 HasVolatile = Quals.hasVolatile();
David Majnemer89594f32013-08-05 22:43:06 +00001625
Guy Benyei11169dd2012-12-18 14:30:41 +00001626 if (!IsMember) {
1627 if (HasConst && HasVolatile) {
1628 Out << 'D';
1629 } else if (HasVolatile) {
1630 Out << 'C';
1631 } else if (HasConst) {
1632 Out << 'B';
1633 } else {
1634 Out << 'A';
1635 }
1636 } else {
1637 if (HasConst && HasVolatile) {
1638 Out << 'T';
1639 } else if (HasVolatile) {
1640 Out << 'S';
1641 } else if (HasConst) {
1642 Out << 'R';
1643 } else {
1644 Out << 'Q';
1645 }
1646 }
1647
1648 // FIXME: For now, just drop all extension qualifiers on the floor.
1649}
1650
David Majnemer8eec58f2014-02-18 14:20:10 +00001651void
David Majnemere3785bb2014-04-23 05:16:56 +00001652MicrosoftCXXNameMangler::mangleRefQualifier(RefQualifierKind RefQualifier) {
1653 // <ref-qualifier> ::= G # lvalue reference
1654 // ::= H # rvalue-reference
1655 switch (RefQualifier) {
1656 case RQ_None:
1657 break;
1658
1659 case RQ_LValue:
1660 Out << 'G';
1661 break;
1662
1663 case RQ_RValue:
1664 Out << 'H';
1665 break;
1666 }
1667}
1668
David Majnemer7a3ce0c2015-05-26 01:30:45 +00001669void MicrosoftCXXNameMangler::manglePointerExtQualifiers(Qualifiers Quals,
1670 QualType PointeeType) {
David Majnemer7a3ce0c2015-05-26 01:30:45 +00001671 if (PointersAre64Bit &&
1672 (PointeeType.isNull() || !PointeeType->isFunctionType()))
David Majnemer8eec58f2014-02-18 14:20:10 +00001673 Out << 'E';
1674
Saleem Abdulrasool26d9bdb2018-01-25 19:54:31 +00001675 if (Quals.hasRestrict())
David Majnemer8eec58f2014-02-18 14:20:10 +00001676 Out << 'I';
Andrey Bokhanko45d41322016-05-11 18:38:21 +00001677
Andrey Bokhanko67a41862016-05-26 10:06:01 +00001678 if (Quals.hasUnaligned() ||
1679 (!PointeeType.isNull() && PointeeType.getLocalQualifiers().hasUnaligned()))
Andrey Bokhanko45d41322016-05-11 18:38:21 +00001680 Out << 'F';
David Majnemer8eec58f2014-02-18 14:20:10 +00001681}
1682
1683void MicrosoftCXXNameMangler::manglePointerCVQualifiers(Qualifiers Quals) {
1684 // <pointer-cv-qualifiers> ::= P # no qualifiers
1685 // ::= Q # const
1686 // ::= R # volatile
1687 // ::= S # const volatile
Guy Benyei11169dd2012-12-18 14:30:41 +00001688 bool HasConst = Quals.hasConst(),
David Majnemer8eec58f2014-02-18 14:20:10 +00001689 HasVolatile = Quals.hasVolatile();
David Majnemer0b6bf8a2014-02-18 12:58:35 +00001690
Guy Benyei11169dd2012-12-18 14:30:41 +00001691 if (HasConst && HasVolatile) {
1692 Out << 'S';
1693 } else if (HasVolatile) {
1694 Out << 'R';
1695 } else if (HasConst) {
1696 Out << 'Q';
1697 } else {
1698 Out << 'P';
1699 }
1700}
1701
1702void MicrosoftCXXNameMangler::mangleArgumentType(QualType T,
1703 SourceRange Range) {
Reid Kleckner18da98e2013-06-24 19:21:52 +00001704 // MSVC will backreference two canonically equivalent types that have slightly
1705 // different manglings when mangled alone.
David Majnemer5a1b2042013-09-11 04:44:30 +00001706
1707 // Decayed types do not match up with non-decayed versions of the same type.
1708 //
1709 // e.g.
1710 // void (*x)(void) will not form a backreference with void x(void)
1711 void *TypePtr;
David Majnemer96183f62015-04-23 05:21:20 +00001712 if (const auto *DT = T->getAs<DecayedType>()) {
1713 QualType OriginalType = DT->getOriginalType();
David Majnemerbdc1fed2015-04-27 03:07:47 +00001714 // All decayed ArrayTypes should be treated identically; as-if they were
1715 // a decayed IncompleteArrayType.
1716 if (const auto *AT = getASTContext().getAsArrayType(OriginalType))
David Majnemer96183f62015-04-23 05:21:20 +00001717 OriginalType = getASTContext().getIncompleteArrayType(
David Majnemerbdc1fed2015-04-27 03:07:47 +00001718 AT->getElementType(), AT->getSizeModifier(),
1719 AT->getIndexTypeCVRQualifiers());
David Majnemer96183f62015-04-23 05:21:20 +00001720
1721 TypePtr = OriginalType.getCanonicalType().getAsOpaquePtr();
David Majnemer5a1b2042013-09-11 04:44:30 +00001722 // If the original parameter was textually written as an array,
1723 // instead treat the decayed parameter like it's const.
1724 //
1725 // e.g.
1726 // int [] -> int * const
David Majnemer96183f62015-04-23 05:21:20 +00001727 if (OriginalType->isArrayType())
David Majnemer5a1b2042013-09-11 04:44:30 +00001728 T = T.withConst();
David Majnemer96183f62015-04-23 05:21:20 +00001729 } else {
David Majnemer5a1b2042013-09-11 04:44:30 +00001730 TypePtr = T.getCanonicalType().getAsOpaquePtr();
David Majnemer96183f62015-04-23 05:21:20 +00001731 }
David Majnemer5a1b2042013-09-11 04:44:30 +00001732
Guy Benyei11169dd2012-12-18 14:30:41 +00001733 ArgBackRefMap::iterator Found = TypeBackReferences.find(TypePtr);
1734
1735 if (Found == TypeBackReferences.end()) {
Yaron Keren2155f802015-05-02 15:31:08 +00001736 size_t OutSizeBefore = Out.tell();
Guy Benyei11169dd2012-12-18 14:30:41 +00001737
David Majnemer5a1b2042013-09-11 04:44:30 +00001738 mangleType(T, Range, QMM_Drop);
Guy Benyei11169dd2012-12-18 14:30:41 +00001739
1740 // See if it's worth creating a back reference.
1741 // Only types longer than 1 character are considered
1742 // and only 10 back references slots are available:
Yaron Keren2155f802015-05-02 15:31:08 +00001743 bool LongerThanOneChar = (Out.tell() - OutSizeBefore > 1);
Guy Benyei11169dd2012-12-18 14:30:41 +00001744 if (LongerThanOneChar && TypeBackReferences.size() < 10) {
1745 size_t Size = TypeBackReferences.size();
1746 TypeBackReferences[TypePtr] = Size;
1747 }
1748 } else {
1749 Out << Found->second;
1750 }
1751}
1752
David Majnemer5f177622015-12-30 05:13:03 +00001753void MicrosoftCXXNameMangler::manglePassObjectSizeArg(
1754 const PassObjectSizeAttr *POSA) {
1755 int Type = POSA->getType();
Erik Pilkington02d5fb12019-03-19 20:44:18 +00001756 bool Dynamic = POSA->isDynamic();
David Majnemer5f177622015-12-30 05:13:03 +00001757
Erik Pilkington02d5fb12019-03-19 20:44:18 +00001758 auto Iter = PassObjectSizeArgs.insert({Type, Dynamic}).first;
David Majnemer622abd12015-12-31 05:36:52 +00001759 auto *TypePtr = (const void *)&*Iter;
David Majnemer5f177622015-12-30 05:13:03 +00001760 ArgBackRefMap::iterator Found = TypeBackReferences.find(TypePtr);
1761
1762 if (Found == TypeBackReferences.end()) {
Erik Pilkington02d5fb12019-03-19 20:44:18 +00001763 std::string Name =
1764 Dynamic ? "__pass_dynamic_object_size" : "__pass_object_size";
1765 mangleArtificialTagType(TTK_Enum, Name + llvm::utostr(Type), {"__clang"});
David Majnemer5f177622015-12-30 05:13:03 +00001766
1767 if (TypeBackReferences.size() < 10) {
1768 size_t Size = TypeBackReferences.size();
1769 TypeBackReferences[TypePtr] = Size;
1770 }
1771 } else {
1772 Out << Found->second;
1773 }
1774}
1775
Erich Keane24a0f042018-12-14 23:17:34 +00001776void MicrosoftCXXNameMangler::mangleAddressSpaceType(QualType T,
1777 Qualifiers Quals,
1778 SourceRange Range) {
1779 // Address space is mangled as an unqualified templated type in the __clang
1780 // namespace. The demangled version of this is:
1781 // In the case of a language specific address space:
1782 // __clang::struct _AS[language_addr_space]<Type>
1783 // where:
1784 // <language_addr_space> ::= <OpenCL-addrspace> | <CUDA-addrspace>
1785 // <OpenCL-addrspace> ::= "CL" [ "global" | "local" | "constant" |
1786 // "private"| "generic" ]
1787 // <CUDA-addrspace> ::= "CU" [ "device" | "constant" | "shared" ]
1788 // Note that the above were chosen to match the Itanium mangling for this.
1789 //
1790 // In the case of a non-language specific address space:
1791 // __clang::struct _AS<TargetAS, Type>
1792 assert(Quals.hasAddressSpace() && "Not valid without address space");
1793 llvm::SmallString<32> ASMangling;
1794 llvm::raw_svector_ostream Stream(ASMangling);
1795 MicrosoftCXXNameMangler Extra(Context, Stream);
1796 Stream << "?$";
1797
1798 LangAS AS = Quals.getAddressSpace();
1799 if (Context.getASTContext().addressSpaceMapManglingFor(AS)) {
1800 unsigned TargetAS = Context.getASTContext().getTargetAddressSpace(AS);
1801 Extra.mangleSourceName("_AS");
1802 Extra.mangleIntegerLiteral(llvm::APSInt::getUnsigned(TargetAS),
1803 /*IsBoolean*/ false);
1804 } else {
1805 switch (AS) {
1806 default:
1807 llvm_unreachable("Not a language specific address space");
1808 case LangAS::opencl_global:
1809 Extra.mangleSourceName("_ASCLglobal");
1810 break;
1811 case LangAS::opencl_local:
1812 Extra.mangleSourceName("_ASCLlocal");
1813 break;
1814 case LangAS::opencl_constant:
1815 Extra.mangleSourceName("_ASCLconstant");
1816 break;
1817 case LangAS::opencl_private:
1818 Extra.mangleSourceName("_ASCLprivate");
1819 break;
1820 case LangAS::opencl_generic:
1821 Extra.mangleSourceName("_ASCLgeneric");
1822 break;
1823 case LangAS::cuda_device:
1824 Extra.mangleSourceName("_ASCUdevice");
1825 break;
1826 case LangAS::cuda_constant:
1827 Extra.mangleSourceName("_ASCUconstant");
1828 break;
1829 case LangAS::cuda_shared:
1830 Extra.mangleSourceName("_ASCUshared");
1831 break;
1832 }
1833 }
1834
1835 Extra.mangleType(T, Range, QMM_Escape);
1836 mangleQualifiers(Qualifiers(), false);
1837 mangleArtificialTagType(TTK_Struct, ASMangling, {"__clang"});
1838}
1839
Guy Benyei11169dd2012-12-18 14:30:41 +00001840void MicrosoftCXXNameMangler::mangleType(QualType T, SourceRange Range,
Peter Collingbourne2816c022013-04-25 04:25:40 +00001841 QualifierMangleMode QMM) {
Reid Kleckner18da98e2013-06-24 19:21:52 +00001842 // Don't use the canonical types. MSVC includes things like 'const' on
1843 // pointer arguments to function pointers that canonicalization strips away.
1844 T = T.getDesugaredType(getASTContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00001845 Qualifiers Quals = T.getLocalQualifiers();
Erich Keane24a0f042018-12-14 23:17:34 +00001846
Reid Kleckner18da98e2013-06-24 19:21:52 +00001847 if (const ArrayType *AT = getASTContext().getAsArrayType(T)) {
1848 // If there were any Quals, getAsArrayType() pushed them onto the array
1849 // element type.
Peter Collingbourne2816c022013-04-25 04:25:40 +00001850 if (QMM == QMM_Mangle)
1851 Out << 'A';
1852 else if (QMM == QMM_Escape || QMM == QMM_Result)
1853 Out << "$$B";
Reid Kleckner18da98e2013-06-24 19:21:52 +00001854 mangleArrayType(AT);
Peter Collingbourne2816c022013-04-25 04:25:40 +00001855 return;
1856 }
1857
1858 bool IsPointer = T->isAnyPointerType() || T->isMemberPointerType() ||
David Majnemer7a3ce0c2015-05-26 01:30:45 +00001859 T->isReferenceType() || T->isBlockPointerType();
Peter Collingbourne2816c022013-04-25 04:25:40 +00001860
1861 switch (QMM) {
1862 case QMM_Drop:
Saleem Abdulrasoolbbce34a2018-02-09 03:23:54 +00001863 if (Quals.hasObjCLifetime())
1864 Quals = Quals.withoutObjCLifetime();
Peter Collingbourne2816c022013-04-25 04:25:40 +00001865 break;
1866 case QMM_Mangle:
1867 if (const FunctionType *FT = dyn_cast<FunctionType>(T)) {
1868 Out << '6';
Timur Iskhodzhanov555a7722013-10-04 11:25:05 +00001869 mangleFunctionType(FT);
Peter Collingbourne2816c022013-04-25 04:25:40 +00001870 return;
1871 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001872 mangleQualifiers(Quals, false);
Peter Collingbourne2816c022013-04-25 04:25:40 +00001873 break;
1874 case QMM_Escape:
1875 if (!IsPointer && Quals) {
1876 Out << "$$C";
1877 mangleQualifiers(Quals, false);
1878 }
1879 break;
1880 case QMM_Result:
Andrey Bokhanko45d41322016-05-11 18:38:21 +00001881 // Presence of __unaligned qualifier shouldn't affect mangling here.
1882 Quals.removeUnaligned();
Saleem Abdulrasoolbbce34a2018-02-09 03:23:54 +00001883 if (Quals.hasObjCLifetime())
1884 Quals = Quals.withoutObjCLifetime();
Nico Weber3239f132018-07-23 20:04:00 +00001885 if ((!IsPointer && Quals) || isa<TagType>(T) || isArtificialTagType(T)) {
Peter Collingbourne2816c022013-04-25 04:25:40 +00001886 Out << '?';
1887 mangleQualifiers(Quals, false);
1888 }
1889 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00001890 }
1891
Peter Collingbourne2816c022013-04-25 04:25:40 +00001892 const Type *ty = T.getTypePtr();
Guy Benyei11169dd2012-12-18 14:30:41 +00001893
1894 switch (ty->getTypeClass()) {
1895#define ABSTRACT_TYPE(CLASS, PARENT)
1896#define NON_CANONICAL_TYPE(CLASS, PARENT) \
1897 case Type::CLASS: \
1898 llvm_unreachable("can't mangle non-canonical type " #CLASS "Type"); \
1899 return;
1900#define TYPE(CLASS, PARENT) \
1901 case Type::CLASS: \
David Majnemer7a3ce0c2015-05-26 01:30:45 +00001902 mangleType(cast<CLASS##Type>(ty), Quals, Range); \
Guy Benyei11169dd2012-12-18 14:30:41 +00001903 break;
1904#include "clang/AST/TypeNodes.def"
1905#undef ABSTRACT_TYPE
1906#undef NON_CANONICAL_TYPE
1907#undef TYPE
1908 }
1909}
1910
David Majnemer7a3ce0c2015-05-26 01:30:45 +00001911void MicrosoftCXXNameMangler::mangleType(const BuiltinType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00001912 SourceRange Range) {
1913 // <type> ::= <builtin-type>
1914 // <builtin-type> ::= X # void
1915 // ::= C # signed char
1916 // ::= D # char
1917 // ::= E # unsigned char
1918 // ::= F # short
1919 // ::= G # unsigned short (or wchar_t if it's not a builtin)
1920 // ::= H # int
1921 // ::= I # unsigned int
1922 // ::= J # long
1923 // ::= K # unsigned long
1924 // L # <none>
1925 // ::= M # float
1926 // ::= N # double
1927 // ::= O # long double (__float80 is mangled differently)
1928 // ::= _J # long long, __int64
1929 // ::= _K # unsigned long long, __int64
1930 // ::= _L # __int128
1931 // ::= _M # unsigned __int128
1932 // ::= _N # bool
1933 // _O # <array in parameter>
Richard Smith5178c6b2019-02-21 23:04:35 +00001934 // ::= _Q # char8_t
Reid Kleckner9e2584a2017-05-26 17:11:10 +00001935 // ::= _S # char16_t
Richard Smith5178c6b2019-02-21 23:04:35 +00001936 // ::= _T # __float80 (Intel)
Reid Kleckner9e2584a2017-05-26 17:11:10 +00001937 // ::= _U # char32_t
Guy Benyei11169dd2012-12-18 14:30:41 +00001938 // ::= _W # wchar_t
1939 // ::= _Z # __float80 (Digital Mars)
1940 switch (T->getKind()) {
Alexey Baderbdf7c842015-09-15 12:18:29 +00001941 case BuiltinType::Void:
1942 Out << 'X';
1943 break;
1944 case BuiltinType::SChar:
1945 Out << 'C';
1946 break;
1947 case BuiltinType::Char_U:
1948 case BuiltinType::Char_S:
1949 Out << 'D';
1950 break;
1951 case BuiltinType::UChar:
1952 Out << 'E';
1953 break;
1954 case BuiltinType::Short:
1955 Out << 'F';
1956 break;
1957 case BuiltinType::UShort:
1958 Out << 'G';
1959 break;
1960 case BuiltinType::Int:
1961 Out << 'H';
1962 break;
1963 case BuiltinType::UInt:
1964 Out << 'I';
1965 break;
1966 case BuiltinType::Long:
1967 Out << 'J';
1968 break;
1969 case BuiltinType::ULong:
1970 Out << 'K';
1971 break;
1972 case BuiltinType::Float:
1973 Out << 'M';
1974 break;
1975 case BuiltinType::Double:
1976 Out << 'N';
1977 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00001978 // TODO: Determine size and mangle accordingly
Alexey Baderbdf7c842015-09-15 12:18:29 +00001979 case BuiltinType::LongDouble:
1980 Out << 'O';
1981 break;
1982 case BuiltinType::LongLong:
1983 Out << "_J";
1984 break;
1985 case BuiltinType::ULongLong:
1986 Out << "_K";
1987 break;
1988 case BuiltinType::Int128:
1989 Out << "_L";
1990 break;
1991 case BuiltinType::UInt128:
1992 Out << "_M";
1993 break;
1994 case BuiltinType::Bool:
1995 Out << "_N";
1996 break;
Richard Smith5178c6b2019-02-21 23:04:35 +00001997 case BuiltinType::Char8:
1998 Out << "_Q";
1999 break;
Alexey Baderbdf7c842015-09-15 12:18:29 +00002000 case BuiltinType::Char16:
2001 Out << "_S";
2002 break;
2003 case BuiltinType::Char32:
2004 Out << "_U";
2005 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002006 case BuiltinType::WChar_S:
Alexey Baderbdf7c842015-09-15 12:18:29 +00002007 case BuiltinType::WChar_U:
2008 Out << "_W";
2009 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002010
2011#define BUILTIN_TYPE(Id, SingletonId)
2012#define PLACEHOLDER_TYPE(Id, SingletonId) \
2013 case BuiltinType::Id:
2014#include "clang/AST/BuiltinTypes.def"
2015 case BuiltinType::Dependent:
2016 llvm_unreachable("placeholder types shouldn't get to name mangling");
2017
Alexey Baderbdf7c842015-09-15 12:18:29 +00002018 case BuiltinType::ObjCId:
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002019 mangleArtificialTagType(TTK_Struct, "objc_object");
Alexey Baderbdf7c842015-09-15 12:18:29 +00002020 break;
2021 case BuiltinType::ObjCClass:
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002022 mangleArtificialTagType(TTK_Struct, "objc_class");
Alexey Baderbdf7c842015-09-15 12:18:29 +00002023 break;
2024 case BuiltinType::ObjCSel:
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002025 mangleArtificialTagType(TTK_Struct, "objc_selector");
Alexey Baderbdf7c842015-09-15 12:18:29 +00002026 break;
Guy Benyeid8a08ea2012-12-18 14:38:23 +00002027
Alexey Bader954ba212016-04-08 13:40:33 +00002028#define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
2029 case BuiltinType::Id: \
2030 Out << "PAUocl_" #ImgType "_" #Suffix "@@"; \
Alexey Baderbdf7c842015-09-15 12:18:29 +00002031 break;
Alexey Baderb62f1442016-04-13 08:33:41 +00002032#include "clang/Basic/OpenCLImageTypes.def"
Alexey Baderbdf7c842015-09-15 12:18:29 +00002033 case BuiltinType::OCLSampler:
David Majnemer3add70b2015-12-29 11:45:53 +00002034 Out << "PA";
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002035 mangleArtificialTagType(TTK_Struct, "ocl_sampler");
Alexey Baderbdf7c842015-09-15 12:18:29 +00002036 break;
2037 case BuiltinType::OCLEvent:
David Majnemer3add70b2015-12-29 11:45:53 +00002038 Out << "PA";
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002039 mangleArtificialTagType(TTK_Struct, "ocl_event");
Alexey Baderbdf7c842015-09-15 12:18:29 +00002040 break;
Alexey Bader9c8453f2015-09-15 11:18:52 +00002041 case BuiltinType::OCLClkEvent:
David Majnemer3add70b2015-12-29 11:45:53 +00002042 Out << "PA";
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002043 mangleArtificialTagType(TTK_Struct, "ocl_clkevent");
Alexey Bader9c8453f2015-09-15 11:18:52 +00002044 break;
2045 case BuiltinType::OCLQueue:
David Majnemer3add70b2015-12-29 11:45:53 +00002046 Out << "PA";
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002047 mangleArtificialTagType(TTK_Struct, "ocl_queue");
Alexey Bader9c8453f2015-09-15 11:18:52 +00002048 break;
Alexey Bader9c8453f2015-09-15 11:18:52 +00002049 case BuiltinType::OCLReserveID:
David Majnemer3add70b2015-12-29 11:45:53 +00002050 Out << "PA";
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002051 mangleArtificialTagType(TTK_Struct, "ocl_reserveid");
Alexey Bader9c8453f2015-09-15 11:18:52 +00002052 break;
Andrew Savonichev3fee3512018-11-08 11:25:41 +00002053#define EXT_OPAQUE_TYPE(ExtType, Id, Ext) \
2054 case BuiltinType::Id: \
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002055 mangleArtificialTagType(TTK_Struct, "ocl_" #ExtType); \
Andrew Savonichev3fee3512018-11-08 11:25:41 +00002056 break;
2057#include "clang/Basic/OpenCLExtensionTypes.def"
David Majnemerb4119f72013-12-13 01:06:04 +00002058
Alexey Baderbdf7c842015-09-15 12:18:29 +00002059 case BuiltinType::NullPtr:
2060 Out << "$$T";
2061 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002062
Sjoerd Meijercc623ad2017-09-08 15:15:00 +00002063 case BuiltinType::Float16:
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002064 mangleArtificialTagType(TTK_Struct, "_Float16", {"__clang"});
Erich Keane5da1e692018-04-17 22:00:54 +00002065 break;
2066
Erich Keane14c10852018-05-01 14:16:15 +00002067 case BuiltinType::Half:
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002068 mangleArtificialTagType(TTK_Struct, "_Half", {"__clang"});
Erich Keane14c10852018-05-01 14:16:15 +00002069 break;
2070
Leonard Chanf921d852018-06-04 16:07:52 +00002071 case BuiltinType::ShortAccum:
2072 case BuiltinType::Accum:
2073 case BuiltinType::LongAccum:
2074 case BuiltinType::UShortAccum:
2075 case BuiltinType::UAccum:
2076 case BuiltinType::ULongAccum:
Leonard Chanab80f3c2018-06-14 14:53:51 +00002077 case BuiltinType::ShortFract:
2078 case BuiltinType::Fract:
2079 case BuiltinType::LongFract:
2080 case BuiltinType::UShortFract:
2081 case BuiltinType::UFract:
2082 case BuiltinType::ULongFract:
2083 case BuiltinType::SatShortAccum:
2084 case BuiltinType::SatAccum:
2085 case BuiltinType::SatLongAccum:
2086 case BuiltinType::SatUShortAccum:
2087 case BuiltinType::SatUAccum:
2088 case BuiltinType::SatULongAccum:
2089 case BuiltinType::SatShortFract:
2090 case BuiltinType::SatFract:
2091 case BuiltinType::SatLongFract:
2092 case BuiltinType::SatUShortFract:
2093 case BuiltinType::SatUFract:
2094 case BuiltinType::SatULongFract:
Erich Keane14c10852018-05-01 14:16:15 +00002095 case BuiltinType::Float128: {
Guy Benyei11169dd2012-12-18 14:30:41 +00002096 DiagnosticsEngine &Diags = Context.getDiags();
Alexey Baderbdf7c842015-09-15 12:18:29 +00002097 unsigned DiagID = Diags.getCustomDiagID(
2098 DiagnosticsEngine::Error, "cannot mangle this built-in %0 type yet");
Guy Benyei11169dd2012-12-18 14:30:41 +00002099 Diags.Report(Range.getBegin(), DiagID)
Alexey Baderbdf7c842015-09-15 12:18:29 +00002100 << T->getName(Context.getASTContext().getPrintingPolicy()) << Range;
Guy Benyei11169dd2012-12-18 14:30:41 +00002101 break;
2102 }
2103 }
2104}
2105
2106// <type> ::= <function-type>
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002107void MicrosoftCXXNameMangler::mangleType(const FunctionProtoType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002108 SourceRange) {
2109 // Structors only appear in decls, so at this point we know it's not a
2110 // structor type.
2111 // FIXME: This may not be lambda-friendly.
Anastasia Stulovac61eaa52019-01-28 11:37:49 +00002112 if (T->getMethodQuals() || T->getRefQualifier() != RQ_None) {
David Majnemer2f6a96e2014-08-12 17:53:10 +00002113 Out << "$$A8@@";
2114 mangleFunctionType(T, /*D=*/nullptr, /*ForceThisQuals=*/true);
2115 } else {
2116 Out << "$$A6";
2117 mangleFunctionType(T);
2118 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002119}
2120void MicrosoftCXXNameMangler::mangleType(const FunctionNoProtoType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002121 Qualifiers, SourceRange) {
Peter Collingbourneeeebc412015-08-07 23:25:47 +00002122 Out << "$$A6";
2123 mangleFunctionType(T);
Guy Benyei11169dd2012-12-18 14:30:41 +00002124}
2125
Peter Collingbourne2816c022013-04-25 04:25:40 +00002126void MicrosoftCXXNameMangler::mangleFunctionType(const FunctionType *T,
2127 const FunctionDecl *D,
Reid Klecknerd2f98772018-12-17 23:10:43 +00002128 bool ForceThisQuals,
2129 bool MangleExceptionSpec) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002130 // <function-type> ::= <this-cvr-qualifiers> <calling-convention>
2131 // <return-type> <argument-list> <throw-spec>
Peter Collingbourneeeebc412015-08-07 23:25:47 +00002132 const FunctionProtoType *Proto = dyn_cast<FunctionProtoType>(T);
Guy Benyei11169dd2012-12-18 14:30:41 +00002133
Reid Kleckner18da98e2013-06-24 19:21:52 +00002134 SourceRange Range;
2135 if (D) Range = D->getSourceRange();
2136
David Majnemer41311192016-01-17 07:09:24 +00002137 bool IsInLambda = false;
David Majnemerdfa6d202015-03-11 18:36:39 +00002138 bool IsStructor = false, HasThisQuals = ForceThisQuals, IsCtorClosure = false;
2139 CallingConv CC = T->getCallConv();
Timur Iskhodzhanov555a7722013-10-04 11:25:05 +00002140 if (const CXXMethodDecl *MD = dyn_cast_or_null<CXXMethodDecl>(D)) {
David Majnemer41311192016-01-17 07:09:24 +00002141 if (MD->getParent()->isLambda())
2142 IsInLambda = true;
Timur Iskhodzhanov555a7722013-10-04 11:25:05 +00002143 if (MD->isInstance())
David Majnemer2f6a96e2014-08-12 17:53:10 +00002144 HasThisQuals = true;
David Majnemerdfa6d202015-03-11 18:36:39 +00002145 if (isa<CXXDestructorDecl>(MD)) {
Timur Iskhodzhanov555a7722013-10-04 11:25:05 +00002146 IsStructor = true;
David Majnemerdfa6d202015-03-11 18:36:39 +00002147 } else if (isa<CXXConstructorDecl>(MD)) {
2148 IsStructor = true;
2149 IsCtorClosure = (StructorType == Ctor_CopyingClosure ||
2150 StructorType == Ctor_DefaultClosure) &&
Reid Kleckner290feb92017-01-09 17:04:37 +00002151 isStructorDecl(MD);
David Majnemerdfa6d202015-03-11 18:36:39 +00002152 if (IsCtorClosure)
2153 CC = getASTContext().getDefaultCallingConvention(
2154 /*IsVariadic=*/false, /*IsCXXMethod=*/true);
2155 }
Timur Iskhodzhanov555a7722013-10-04 11:25:05 +00002156 }
2157
Guy Benyei11169dd2012-12-18 14:30:41 +00002158 // If this is a C++ instance method, mangle the CVR qualifiers for the
2159 // this pointer.
David Majnemer2f6a96e2014-08-12 17:53:10 +00002160 if (HasThisQuals) {
Anastasia Stulovac61eaa52019-01-28 11:37:49 +00002161 Qualifiers Quals = Proto->getMethodQuals();
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002162 manglePointerExtQualifiers(Quals, /*PointeeType=*/QualType());
David Majnemere3785bb2014-04-23 05:16:56 +00002163 mangleRefQualifier(Proto->getRefQualifier());
David Majnemer2f6a96e2014-08-12 17:53:10 +00002164 mangleQualifiers(Quals, /*IsMember=*/false);
David Majnemer6dda7bb2013-08-15 08:13:23 +00002165 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002166
David Majnemerdfa6d202015-03-11 18:36:39 +00002167 mangleCallingConvention(CC);
Guy Benyei11169dd2012-12-18 14:30:41 +00002168
2169 // <return-type> ::= <type>
2170 // ::= @ # structors (they have no declared return type)
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002171 if (IsStructor) {
David Majnemerdc169752017-02-14 00:54:11 +00002172 if (isa<CXXDestructorDecl>(D) && isStructorDecl(D)) {
2173 // The scalar deleting destructor takes an extra int argument which is not
2174 // reflected in the AST.
2175 if (StructorType == Dtor_Deleting) {
2176 Out << (PointersAre64Bit ? "PEAXI@Z" : "PAXI@Z");
2177 return;
2178 }
2179 // The vbase destructor returns void which is not reflected in the AST.
2180 if (StructorType == Dtor_Complete) {
2181 Out << "XXZ";
2182 return;
2183 }
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002184 }
David Majnemerdfa6d202015-03-11 18:36:39 +00002185 if (IsCtorClosure) {
2186 // Default constructor closure and copy constructor closure both return
2187 // void.
2188 Out << 'X';
2189
2190 if (StructorType == Ctor_DefaultClosure) {
2191 // Default constructor closure always has no arguments.
2192 Out << 'X';
2193 } else if (StructorType == Ctor_CopyingClosure) {
2194 // Copy constructor closure always takes an unqualified reference.
2195 mangleArgumentType(getASTContext().getLValueReferenceType(
2196 Proto->getParamType(0)
2197 ->getAs<LValueReferenceType>()
2198 ->getPointeeType(),
2199 /*SpelledAsLValue=*/true),
2200 Range);
David Majnemer37fd66e2015-03-13 22:36:55 +00002201 Out << '@';
David Majnemerdfa6d202015-03-11 18:36:39 +00002202 } else {
2203 llvm_unreachable("unexpected constructor closure!");
2204 }
David Majnemer37fd66e2015-03-13 22:36:55 +00002205 Out << 'Z';
David Majnemerdfa6d202015-03-11 18:36:39 +00002206 return;
2207 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002208 Out << '@';
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00002209 } else {
Peter Collingbourneeeebc412015-08-07 23:25:47 +00002210 QualType ResultType = T->getReturnType();
David Majnemer2e1e04912014-04-01 05:29:46 +00002211 if (const auto *AT =
2212 dyn_cast_or_null<AutoType>(ResultType->getContainedAutoType())) {
2213 Out << '?';
2214 mangleQualifiers(ResultType.getLocalQualifiers(), /*IsMember=*/false);
2215 Out << '?';
Richard Smithe301ba22015-11-11 02:02:15 +00002216 assert(AT->getKeyword() != AutoTypeKeyword::GNUAutoType &&
2217 "shouldn't need to mangle __auto_type!");
David Majnemer2e1e04912014-04-01 05:29:46 +00002218 mangleSourceName(AT->isDecltypeAuto() ? "<decltype-auto>" : "<auto>");
2219 Out << '@';
David Majnemer41311192016-01-17 07:09:24 +00002220 } else if (IsInLambda) {
2221 Out << '@';
David Majnemer2e1e04912014-04-01 05:29:46 +00002222 } else {
2223 if (ResultType->isVoidType())
2224 ResultType = ResultType.getUnqualifiedType();
2225 mangleType(ResultType, Range, QMM_Result);
2226 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002227 }
2228
2229 // <argument-list> ::= X # void
2230 // ::= <type>+ @
2231 // ::= <type>* Z # varargs
Peter Collingbourneeeebc412015-08-07 23:25:47 +00002232 if (!Proto) {
2233 // Function types without prototypes can arise when mangling a function type
2234 // within an overloadable function in C. We mangle these as the absence of
2235 // any parameter types (not even an empty parameter list).
2236 Out << '@';
2237 } else if (Proto->getNumParams() == 0 && !Proto->isVariadic()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002238 Out << 'X';
2239 } else {
Reid Kleckner18da98e2013-06-24 19:21:52 +00002240 // Happens for function pointer type arguments for example.
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00002241 for (unsigned I = 0, E = Proto->getNumParams(); I != E; ++I) {
2242 mangleArgumentType(Proto->getParamType(I), Range);
Simon Pilgrim27cc0542017-02-15 15:12:06 +00002243 // Mangle each pass_object_size parameter as if it's a parameter of enum
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00002244 // type passed directly after the parameter with the pass_object_size
2245 // attribute. The aforementioned enum's name is __pass_object_size, and we
2246 // pretend it resides in a top-level namespace called __clang.
2247 //
2248 // FIXME: Is there a defined extension notation for the MS ABI, or is it
2249 // necessary to just cross our fingers and hope this type+namespace
2250 // combination doesn't conflict with anything?
2251 if (D)
David Majnemer5f177622015-12-30 05:13:03 +00002252 if (const auto *P = D->getParamDecl(I)->getAttr<PassObjectSizeAttr>())
2253 manglePassObjectSizeArg(P);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00002254 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002255 // <builtin-type> ::= Z # ellipsis
2256 if (Proto->isVariadic())
2257 Out << 'Z';
2258 else
2259 Out << '@';
2260 }
2261
Reid Klecknerd2f98772018-12-17 23:10:43 +00002262 if (MangleExceptionSpec && getASTContext().getLangOpts().CPlusPlus17 &&
2263 getASTContext().getLangOpts().isCompatibleWithMSVC(
2264 LangOptions::MSVC2017_5))
2265 mangleThrowSpecification(Proto);
2266 else
2267 Out << 'Z';
Guy Benyei11169dd2012-12-18 14:30:41 +00002268}
2269
2270void MicrosoftCXXNameMangler::mangleFunctionClass(const FunctionDecl *FD) {
Reid Kleckner369f3162013-05-14 20:30:42 +00002271 // <function-class> ::= <member-function> E? # E designates a 64-bit 'this'
2272 // # pointer. in 64-bit mode *all*
2273 // # 'this' pointers are 64-bit.
2274 // ::= <global-function>
2275 // <member-function> ::= A # private: near
2276 // ::= B # private: far
2277 // ::= C # private: static near
2278 // ::= D # private: static far
2279 // ::= E # private: virtual near
2280 // ::= F # private: virtual far
Reid Kleckner369f3162013-05-14 20:30:42 +00002281 // ::= I # protected: near
2282 // ::= J # protected: far
2283 // ::= K # protected: static near
2284 // ::= L # protected: static far
2285 // ::= M # protected: virtual near
2286 // ::= N # protected: virtual far
Reid Kleckner369f3162013-05-14 20:30:42 +00002287 // ::= Q # public: near
2288 // ::= R # public: far
2289 // ::= S # public: static near
2290 // ::= T # public: static far
2291 // ::= U # public: virtual near
2292 // ::= V # public: virtual far
Reid Kleckner369f3162013-05-14 20:30:42 +00002293 // <global-function> ::= Y # global near
2294 // ::= Z # global far
Guy Benyei11169dd2012-12-18 14:30:41 +00002295 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD)) {
David Majnemerdc169752017-02-14 00:54:11 +00002296 bool IsVirtual = MD->isVirtual();
2297 // When mangling vbase destructor variants, ignore whether or not the
2298 // underlying destructor was defined to be virtual.
2299 if (isa<CXXDestructorDecl>(MD) && isStructorDecl(MD) &&
2300 StructorType == Dtor_Complete) {
2301 IsVirtual = false;
2302 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002303 switch (MD->getAccess()) {
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00002304 case AS_none:
2305 llvm_unreachable("Unsupported access specifier");
Guy Benyei11169dd2012-12-18 14:30:41 +00002306 case AS_private:
2307 if (MD->isStatic())
2308 Out << 'C';
David Majnemerdc169752017-02-14 00:54:11 +00002309 else if (IsVirtual)
Guy Benyei11169dd2012-12-18 14:30:41 +00002310 Out << 'E';
2311 else
2312 Out << 'A';
2313 break;
2314 case AS_protected:
2315 if (MD->isStatic())
2316 Out << 'K';
David Majnemerdc169752017-02-14 00:54:11 +00002317 else if (IsVirtual)
Guy Benyei11169dd2012-12-18 14:30:41 +00002318 Out << 'M';
2319 else
2320 Out << 'I';
2321 break;
2322 case AS_public:
2323 if (MD->isStatic())
2324 Out << 'S';
David Majnemerdc169752017-02-14 00:54:11 +00002325 else if (IsVirtual)
Guy Benyei11169dd2012-12-18 14:30:41 +00002326 Out << 'U';
2327 else
2328 Out << 'Q';
2329 }
David Majnemer5a7cfea2015-05-18 00:05:29 +00002330 } else {
Guy Benyei11169dd2012-12-18 14:30:41 +00002331 Out << 'Y';
David Majnemer5a7cfea2015-05-18 00:05:29 +00002332 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002333}
David Majnemerdfa6d202015-03-11 18:36:39 +00002334void MicrosoftCXXNameMangler::mangleCallingConvention(CallingConv CC) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002335 // <calling-convention> ::= A # __cdecl
2336 // ::= B # __export __cdecl
2337 // ::= C # __pascal
2338 // ::= D # __export __pascal
2339 // ::= E # __thiscall
2340 // ::= F # __export __thiscall
2341 // ::= G # __stdcall
2342 // ::= H # __export __stdcall
2343 // ::= I # __fastcall
2344 // ::= J # __export __fastcall
Reid Klecknerd7857f02014-10-24 17:42:17 +00002345 // ::= Q # __vectorcall
Erich Keane757d3172016-11-02 18:29:35 +00002346 // ::= w # __regcall
Guy Benyei11169dd2012-12-18 14:30:41 +00002347 // The 'export' calling conventions are from a bygone era
2348 // (*cough*Win16*cough*) when functions were declared for export with
2349 // that keyword. (It didn't actually export them, it just made them so
2350 // that they could be in a DLL and somebody from another module could call
2351 // them.)
David Majnemerdfa6d202015-03-11 18:36:39 +00002352
Guy Benyei11169dd2012-12-18 14:30:41 +00002353 switch (CC) {
2354 default:
2355 llvm_unreachable("Unsupported CC for mangling");
Martin Storsjo022e7822017-07-17 20:49:45 +00002356 case CC_Win64:
Charles Davisb5a214e2013-08-30 04:39:01 +00002357 case CC_X86_64SysV:
Guy Benyei11169dd2012-12-18 14:30:41 +00002358 case CC_C: Out << 'A'; break;
2359 case CC_X86Pascal: Out << 'C'; break;
2360 case CC_X86ThisCall: Out << 'E'; break;
2361 case CC_X86StdCall: Out << 'G'; break;
2362 case CC_X86FastCall: Out << 'I'; break;
Reid Klecknerd7857f02014-10-24 17:42:17 +00002363 case CC_X86VectorCall: Out << 'Q'; break;
Saleem Abdulrasool58340522018-02-07 01:55:08 +00002364 case CC_Swift: Out << 'S'; break;
Saleem Abdulrasool13aeee02018-04-02 22:25:50 +00002365 case CC_PreserveMost: Out << 'U'; break;
Erich Keane757d3172016-11-02 18:29:35 +00002366 case CC_X86RegCall: Out << 'w'; break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002367 }
2368}
David Majnemerdfa6d202015-03-11 18:36:39 +00002369void MicrosoftCXXNameMangler::mangleCallingConvention(const FunctionType *T) {
2370 mangleCallingConvention(T->getCallConv());
2371}
Reid Klecknerd2f98772018-12-17 23:10:43 +00002372
Guy Benyei11169dd2012-12-18 14:30:41 +00002373void MicrosoftCXXNameMangler::mangleThrowSpecification(
2374 const FunctionProtoType *FT) {
Reid Klecknerd2f98772018-12-17 23:10:43 +00002375 // <throw-spec> ::= Z # (default)
2376 // ::= _E # noexcept
2377 if (FT->canThrow())
2378 Out << 'Z';
2379 else
2380 Out << "_E";
Guy Benyei11169dd2012-12-18 14:30:41 +00002381}
2382
2383void MicrosoftCXXNameMangler::mangleType(const UnresolvedUsingType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002384 Qualifiers, SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002385 // Probably should be mangled as a template instantiation; need to see what
2386 // VC does first.
2387 DiagnosticsEngine &Diags = Context.getDiags();
2388 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2389 "cannot mangle this unresolved dependent type yet");
2390 Diags.Report(Range.getBegin(), DiagID)
2391 << Range;
2392}
2393
2394// <type> ::= <union-type> | <struct-type> | <class-type> | <enum-type>
2395// <union-type> ::= T <name>
2396// <struct-type> ::= U <name>
2397// <class-type> ::= V <name>
David Majnemer048f90c2013-12-09 04:28:34 +00002398// <enum-type> ::= W4 <name>
David Majnemer3add70b2015-12-29 11:45:53 +00002399void MicrosoftCXXNameMangler::mangleTagTypeKind(TagTypeKind TTK) {
2400 switch (TTK) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002401 case TTK_Union:
2402 Out << 'T';
2403 break;
2404 case TTK_Struct:
2405 case TTK_Interface:
2406 Out << 'U';
2407 break;
2408 case TTK_Class:
2409 Out << 'V';
2410 break;
2411 case TTK_Enum:
David Majnemer048f90c2013-12-09 04:28:34 +00002412 Out << "W4";
Guy Benyei11169dd2012-12-18 14:30:41 +00002413 break;
2414 }
David Majnemer3add70b2015-12-29 11:45:53 +00002415}
2416void MicrosoftCXXNameMangler::mangleType(const EnumType *T, Qualifiers,
2417 SourceRange) {
2418 mangleType(cast<TagType>(T)->getDecl());
2419}
2420void MicrosoftCXXNameMangler::mangleType(const RecordType *T, Qualifiers,
2421 SourceRange) {
2422 mangleType(cast<TagType>(T)->getDecl());
2423}
2424void MicrosoftCXXNameMangler::mangleType(const TagDecl *TD) {
2425 mangleTagTypeKind(TD->getTagKind());
David Majnemer0db0ca42013-08-05 22:26:46 +00002426 mangleName(TD);
Guy Benyei11169dd2012-12-18 14:30:41 +00002427}
Nico Weber3239f132018-07-23 20:04:00 +00002428
2429// If you add a call to this, consider updating isArtificialTagType() too.
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002430void MicrosoftCXXNameMangler::mangleArtificialTagType(
Nico Weber2b5f3fd2018-08-01 11:56:20 +00002431 TagTypeKind TK, StringRef UnqualifiedName,
2432 ArrayRef<StringRef> NestedNames) {
David Majnemer3add70b2015-12-29 11:45:53 +00002433 // <name> ::= <unscoped-name> {[<named-scope>]+ | [<nested-name>]}? @
2434 mangleTagTypeKind(TK);
2435
2436 // Always start with the unqualified name.
2437 mangleSourceName(UnqualifiedName);
2438
2439 for (auto I = NestedNames.rbegin(), E = NestedNames.rend(); I != E; ++I)
2440 mangleSourceName(*I);
2441
2442 // Terminate the whole name with an '@'.
2443 Out << '@';
2444}
Guy Benyei11169dd2012-12-18 14:30:41 +00002445
2446// <type> ::= <array-type>
2447// <array-type> ::= <pointer-cvr-qualifiers> <cvr-qualifiers>
2448// [Y <dimension-count> <dimension>+]
Reid Kleckner369f3162013-05-14 20:30:42 +00002449// <element-type> # as global, E is never required
Guy Benyei11169dd2012-12-18 14:30:41 +00002450// It's supposed to be the other way around, but for some strange reason, it
2451// isn't. Today this behavior is retained for the sole purpose of backwards
2452// compatibility.
David Majnemer5a1b2042013-09-11 04:44:30 +00002453void MicrosoftCXXNameMangler::mangleDecayedArrayType(const ArrayType *T) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002454 // This isn't a recursive mangling, so now we have to do it all in this
2455 // one call.
David Majnemer8eec58f2014-02-18 14:20:10 +00002456 manglePointerCVQualifiers(T->getElementType().getQualifiers());
Peter Collingbourne2816c022013-04-25 04:25:40 +00002457 mangleType(T->getElementType(), SourceRange());
Guy Benyei11169dd2012-12-18 14:30:41 +00002458}
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002459void MicrosoftCXXNameMangler::mangleType(const ConstantArrayType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002460 SourceRange) {
Peter Collingbourne2816c022013-04-25 04:25:40 +00002461 llvm_unreachable("Should have been special cased");
Guy Benyei11169dd2012-12-18 14:30:41 +00002462}
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002463void MicrosoftCXXNameMangler::mangleType(const VariableArrayType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002464 SourceRange) {
Peter Collingbourne2816c022013-04-25 04:25:40 +00002465 llvm_unreachable("Should have been special cased");
Guy Benyei11169dd2012-12-18 14:30:41 +00002466}
2467void MicrosoftCXXNameMangler::mangleType(const DependentSizedArrayType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002468 Qualifiers, SourceRange) {
Peter Collingbourne2816c022013-04-25 04:25:40 +00002469 llvm_unreachable("Should have been special cased");
Guy Benyei11169dd2012-12-18 14:30:41 +00002470}
2471void MicrosoftCXXNameMangler::mangleType(const IncompleteArrayType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002472 Qualifiers, SourceRange) {
Peter Collingbourne2816c022013-04-25 04:25:40 +00002473 llvm_unreachable("Should have been special cased");
Guy Benyei11169dd2012-12-18 14:30:41 +00002474}
Reid Kleckner18da98e2013-06-24 19:21:52 +00002475void MicrosoftCXXNameMangler::mangleArrayType(const ArrayType *T) {
Peter Collingbourne2816c022013-04-25 04:25:40 +00002476 QualType ElementTy(T, 0);
Guy Benyei11169dd2012-12-18 14:30:41 +00002477 SmallVector<llvm::APInt, 3> Dimensions;
2478 for (;;) {
David Majnemer9595b7d2015-04-23 07:42:08 +00002479 if (ElementTy->isConstantArrayType()) {
2480 const ConstantArrayType *CAT =
2481 getASTContext().getAsConstantArrayType(ElementTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00002482 Dimensions.push_back(CAT->getSize());
2483 ElementTy = CAT->getElementType();
David Majnemer9595b7d2015-04-23 07:42:08 +00002484 } else if (ElementTy->isIncompleteArrayType()) {
2485 const IncompleteArrayType *IAT =
2486 getASTContext().getAsIncompleteArrayType(ElementTy);
2487 Dimensions.push_back(llvm::APInt(32, 0));
2488 ElementTy = IAT->getElementType();
Guy Benyei11169dd2012-12-18 14:30:41 +00002489 } else if (ElementTy->isVariableArrayType()) {
2490 const VariableArrayType *VAT =
2491 getASTContext().getAsVariableArrayType(ElementTy);
David Majnemer9595b7d2015-04-23 07:42:08 +00002492 Dimensions.push_back(llvm::APInt(32, 0));
2493 ElementTy = VAT->getElementType();
Guy Benyei11169dd2012-12-18 14:30:41 +00002494 } else if (ElementTy->isDependentSizedArrayType()) {
2495 // The dependent expression has to be folded into a constant (TODO).
2496 const DependentSizedArrayType *DSAT =
2497 getASTContext().getAsDependentSizedArrayType(ElementTy);
2498 DiagnosticsEngine &Diags = Context.getDiags();
2499 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2500 "cannot mangle this dependent-length array yet");
2501 Diags.Report(DSAT->getSizeExpr()->getExprLoc(), DiagID)
2502 << DSAT->getBracketsRange();
2503 return;
David Majnemer9595b7d2015-04-23 07:42:08 +00002504 } else {
2505 break;
Peter Collingbourne2816c022013-04-25 04:25:40 +00002506 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002507 }
Peter Collingbourne2816c022013-04-25 04:25:40 +00002508 Out << 'Y';
2509 // <dimension-count> ::= <number> # number of extra dimensions
2510 mangleNumber(Dimensions.size());
David Majnemerb926dbc2014-04-23 05:16:53 +00002511 for (const llvm::APInt &Dimension : Dimensions)
2512 mangleNumber(Dimension.getLimitedValue());
Reid Kleckner18da98e2013-06-24 19:21:52 +00002513 mangleType(ElementTy, SourceRange(), QMM_Escape);
Guy Benyei11169dd2012-12-18 14:30:41 +00002514}
2515
2516// <type> ::= <pointer-to-member-type>
2517// <pointer-to-member-type> ::= <pointer-cvr-qualifiers> <cvr-qualifiers>
2518// <class name> <type>
Nico Weber2b5f3fd2018-08-01 11:56:20 +00002519void MicrosoftCXXNameMangler::mangleType(const MemberPointerType *T,
2520 Qualifiers Quals, SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002521 QualType PointeeType = T->getPointeeType();
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002522 manglePointerCVQualifiers(Quals);
2523 manglePointerExtQualifiers(Quals, PointeeType);
Guy Benyei11169dd2012-12-18 14:30:41 +00002524 if (const FunctionProtoType *FPT = PointeeType->getAs<FunctionProtoType>()) {
2525 Out << '8';
2526 mangleName(T->getClass()->castAs<RecordType>()->getDecl());
Craig Topper36250ad2014-05-12 05:36:57 +00002527 mangleFunctionType(FPT, nullptr, true);
Guy Benyei11169dd2012-12-18 14:30:41 +00002528 } else {
2529 mangleQualifiers(PointeeType.getQualifiers(), true);
2530 mangleName(T->getClass()->castAs<RecordType>()->getDecl());
Peter Collingbourne2816c022013-04-25 04:25:40 +00002531 mangleType(PointeeType, Range, QMM_Drop);
Guy Benyei11169dd2012-12-18 14:30:41 +00002532 }
2533}
2534
2535void MicrosoftCXXNameMangler::mangleType(const TemplateTypeParmType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002536 Qualifiers, SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002537 DiagnosticsEngine &Diags = Context.getDiags();
2538 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2539 "cannot mangle this template type parameter type yet");
2540 Diags.Report(Range.getBegin(), DiagID)
2541 << Range;
2542}
2543
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002544void MicrosoftCXXNameMangler::mangleType(const SubstTemplateTypeParmPackType *T,
2545 Qualifiers, SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002546 DiagnosticsEngine &Diags = Context.getDiags();
2547 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2548 "cannot mangle this substituted parameter pack yet");
2549 Diags.Report(Range.getBegin(), DiagID)
2550 << Range;
2551}
2552
2553// <type> ::= <pointer-type>
Reid Kleckner369f3162013-05-14 20:30:42 +00002554// <pointer-type> ::= E? <pointer-cvr-qualifiers> <cvr-qualifiers> <type>
Alp Tokerd4733632013-12-05 04:47:09 +00002555// # the E is required for 64-bit non-static pointers
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002556void MicrosoftCXXNameMangler::mangleType(const PointerType *T, Qualifiers Quals,
Guy Benyei11169dd2012-12-18 14:30:41 +00002557 SourceRange Range) {
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002558 QualType PointeeType = T->getPointeeType();
2559 manglePointerCVQualifiers(Quals);
2560 manglePointerExtQualifiers(Quals, PointeeType);
Erich Keane24a0f042018-12-14 23:17:34 +00002561
2562 if (PointeeType.getQualifiers().hasAddressSpace())
2563 mangleAddressSpaceType(PointeeType, PointeeType.getQualifiers(), Range);
2564 else
2565 mangleType(PointeeType, Range);
Guy Benyei11169dd2012-12-18 14:30:41 +00002566}
Saleem Abdulrasool5a3e50a2017-08-23 22:38:58 +00002567
Guy Benyei11169dd2012-12-18 14:30:41 +00002568void MicrosoftCXXNameMangler::mangleType(const ObjCObjectPointerType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002569 Qualifiers Quals, SourceRange Range) {
2570 QualType PointeeType = T->getPointeeType();
Saleem Abdulrasoolbbce34a2018-02-09 03:23:54 +00002571 switch (Quals.getObjCLifetime()) {
2572 case Qualifiers::OCL_None:
2573 case Qualifiers::OCL_ExplicitNone:
2574 break;
2575 case Qualifiers::OCL_Autoreleasing:
2576 case Qualifiers::OCL_Strong:
2577 case Qualifiers::OCL_Weak:
2578 return mangleObjCLifetime(PointeeType, Quals, Range);
2579 }
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002580 manglePointerCVQualifiers(Quals);
2581 manglePointerExtQualifiers(Quals, PointeeType);
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002582 mangleType(PointeeType, Range);
Guy Benyei11169dd2012-12-18 14:30:41 +00002583}
2584
2585// <type> ::= <reference-type>
Reid Kleckner369f3162013-05-14 20:30:42 +00002586// <reference-type> ::= A E? <cvr-qualifiers> <type>
Alp Tokerd4733632013-12-05 04:47:09 +00002587// # the E is required for 64-bit non-static lvalue references
Guy Benyei11169dd2012-12-18 14:30:41 +00002588void MicrosoftCXXNameMangler::mangleType(const LValueReferenceType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002589 Qualifiers Quals, SourceRange Range) {
2590 QualType PointeeType = T->getPointeeType();
David Majnemere3d71912015-12-31 05:36:50 +00002591 assert(!Quals.hasConst() && !Quals.hasVolatile() && "unexpected qualifier!");
2592 Out << 'A';
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002593 manglePointerExtQualifiers(Quals, PointeeType);
2594 mangleType(PointeeType, Range);
Guy Benyei11169dd2012-12-18 14:30:41 +00002595}
2596
2597// <type> ::= <r-value-reference-type>
Reid Kleckner369f3162013-05-14 20:30:42 +00002598// <r-value-reference-type> ::= $$Q E? <cvr-qualifiers> <type>
Alp Tokerd4733632013-12-05 04:47:09 +00002599// # the E is required for 64-bit non-static rvalue references
Guy Benyei11169dd2012-12-18 14:30:41 +00002600void MicrosoftCXXNameMangler::mangleType(const RValueReferenceType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002601 Qualifiers Quals, SourceRange Range) {
2602 QualType PointeeType = T->getPointeeType();
David Majnemere3d71912015-12-31 05:36:50 +00002603 assert(!Quals.hasConst() && !Quals.hasVolatile() && "unexpected qualifier!");
2604 Out << "$$Q";
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002605 manglePointerExtQualifiers(Quals, PointeeType);
2606 mangleType(PointeeType, Range);
Guy Benyei11169dd2012-12-18 14:30:41 +00002607}
2608
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002609void MicrosoftCXXNameMangler::mangleType(const ComplexType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002610 SourceRange Range) {
David Majnemer0b996dd2015-12-29 22:02:15 +00002611 QualType ElementType = T->getElementType();
2612
2613 llvm::SmallString<64> TemplateMangling;
2614 llvm::raw_svector_ostream Stream(TemplateMangling);
2615 MicrosoftCXXNameMangler Extra(Context, Stream);
2616 Stream << "?$";
2617 Extra.mangleSourceName("_Complex");
2618 Extra.mangleType(ElementType, Range, QMM_Escape);
2619
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002620 mangleArtificialTagType(TTK_Struct, TemplateMangling, {"__clang"});
Guy Benyei11169dd2012-12-18 14:30:41 +00002621}
2622
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002623// Returns true for types that mangleArtificialTagType() gets called for with
Nico Weber3239f132018-07-23 20:04:00 +00002624// TTK_Union, TTK_Struct, TTK_Class and where compatibility with MSVC's
2625// mangling matters.
2626// (It doesn't matter for Objective-C types and the like that cl.exe doesn't
2627// support.)
2628bool MicrosoftCXXNameMangler::isArtificialTagType(QualType T) const {
2629 const Type *ty = T.getTypePtr();
2630 switch (ty->getTypeClass()) {
2631 default:
2632 return false;
2633
2634 case Type::Vector: {
2635 // For ABI compatibility only __m64, __m128(id), and __m256(id) matter,
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002636 // but since mangleType(VectorType*) always calls mangleArtificialTagType()
Nico Weber3239f132018-07-23 20:04:00 +00002637 // just always return true (the other vector types are clang-only).
2638 return true;
2639 }
2640 }
2641}
2642
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002643void MicrosoftCXXNameMangler::mangleType(const VectorType *T, Qualifiers Quals,
Guy Benyei11169dd2012-12-18 14:30:41 +00002644 SourceRange Range) {
Reid Klecknere7e64d82013-03-26 16:56:59 +00002645 const BuiltinType *ET = T->getElementType()->getAs<BuiltinType>();
2646 assert(ET && "vectors with non-builtin elements are unsupported");
2647 uint64_t Width = getASTContext().getTypeSize(T);
2648 // Pattern match exactly the typedefs in our intrinsic headers. Anything that
2649 // doesn't match the Intel types uses a custom mangling below.
David Majnemer0a29fed2015-12-29 11:45:58 +00002650 size_t OutSizeBefore = Out.tell();
Saleem Abdulrasool21568182018-10-28 18:05:20 +00002651 if (!isa<ExtVectorType>(T)) {
2652 llvm::Triple::ArchType AT =
2653 getASTContext().getTargetInfo().getTriple().getArch();
2654 if (AT == llvm::Triple::x86 || AT == llvm::Triple::x86_64) {
2655 if (Width == 64 && ET->getKind() == BuiltinType::LongLong) {
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002656 mangleArtificialTagType(TTK_Union, "__m64");
Saleem Abdulrasool21568182018-10-28 18:05:20 +00002657 } else if (Width >= 128) {
2658 if (ET->getKind() == BuiltinType::Float)
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002659 mangleArtificialTagType(TTK_Union, "__m" + llvm::utostr(Width));
Saleem Abdulrasool21568182018-10-28 18:05:20 +00002660 else if (ET->getKind() == BuiltinType::LongLong)
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002661 mangleArtificialTagType(TTK_Union, "__m" + llvm::utostr(Width) + 'i');
Saleem Abdulrasool21568182018-10-28 18:05:20 +00002662 else if (ET->getKind() == BuiltinType::Double)
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002663 mangleArtificialTagType(TTK_Struct, "__m" + llvm::utostr(Width) + 'd');
Saleem Abdulrasool21568182018-10-28 18:05:20 +00002664 }
David Majnemerf04e3862015-06-01 07:41:37 +00002665 }
Reid Klecknere7e64d82013-03-26 16:56:59 +00002666 }
2667
David Majnemer0a29fed2015-12-29 11:45:58 +00002668 bool IsBuiltin = Out.tell() != OutSizeBefore;
David Majnemerf04e3862015-06-01 07:41:37 +00002669 if (!IsBuiltin) {
Reid Klecknere7e64d82013-03-26 16:56:59 +00002670 // The MS ABI doesn't have a special mangling for vector types, so we define
2671 // our own mangling to handle uses of __vector_size__ on user-specified
2672 // types, and for extensions like __v4sf.
David Majnemer0a29fed2015-12-29 11:45:58 +00002673
2674 llvm::SmallString<64> TemplateMangling;
2675 llvm::raw_svector_ostream Stream(TemplateMangling);
2676 MicrosoftCXXNameMangler Extra(Context, Stream);
2677 Stream << "?$";
2678 Extra.mangleSourceName("__vector");
2679 Extra.mangleType(QualType(ET, 0), Range, QMM_Escape);
2680 Extra.mangleIntegerLiteral(llvm::APSInt::getUnsigned(T->getNumElements()),
2681 /*IsBoolean=*/false);
2682
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002683 mangleArtificialTagType(TTK_Union, TemplateMangling, {"__clang"});
Reid Klecknere7e64d82013-03-26 16:56:59 +00002684 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002685}
Reid Klecknere7e64d82013-03-26 16:56:59 +00002686
David Majnemere5c87872015-08-01 05:51:55 +00002687void MicrosoftCXXNameMangler::mangleType(const ExtVectorType *T,
2688 Qualifiers Quals, SourceRange Range) {
2689 mangleType(static_cast<const VectorType *>(T), Quals, Range);
Guy Benyei11169dd2012-12-18 14:30:41 +00002690}
Erich Keanef702b022018-07-13 19:46:04 +00002691
2692void MicrosoftCXXNameMangler::mangleType(const DependentVectorType *T,
2693 Qualifiers, SourceRange Range) {
2694 DiagnosticsEngine &Diags = Context.getDiags();
2695 unsigned DiagID = Diags.getCustomDiagID(
2696 DiagnosticsEngine::Error,
2697 "cannot mangle this dependent-sized vector type yet");
2698 Diags.Report(Range.getBegin(), DiagID) << Range;
2699}
2700
Guy Benyei11169dd2012-12-18 14:30:41 +00002701void MicrosoftCXXNameMangler::mangleType(const DependentSizedExtVectorType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002702 Qualifiers, SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002703 DiagnosticsEngine &Diags = Context.getDiags();
2704 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2705 "cannot mangle this dependent-sized extended vector type yet");
2706 Diags.Report(Range.getBegin(), DiagID)
2707 << Range;
2708}
2709
Andrew Gozillon572bbb02017-10-02 06:25:51 +00002710void MicrosoftCXXNameMangler::mangleType(const DependentAddressSpaceType *T,
2711 Qualifiers, SourceRange Range) {
2712 DiagnosticsEngine &Diags = Context.getDiags();
2713 unsigned DiagID = Diags.getCustomDiagID(
2714 DiagnosticsEngine::Error,
2715 "cannot mangle this dependent address space type yet");
2716 Diags.Report(Range.getBegin(), DiagID) << Range;
2717}
2718
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002719void MicrosoftCXXNameMangler::mangleType(const ObjCInterfaceType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002720 SourceRange) {
Shoaib Meenaic8714d22018-10-04 19:50:14 +00002721 // ObjC interfaces have structs underlying them.
David Majnemer3add70b2015-12-29 11:45:53 +00002722 mangleTagTypeKind(TTK_Struct);
Shoaib Meenaic8714d22018-10-04 19:50:14 +00002723 mangleName(T->getDecl());
Guy Benyei11169dd2012-12-18 14:30:41 +00002724}
2725
Saleem Abdulrasoolf3a981e2018-09-28 16:47:53 +00002726void MicrosoftCXXNameMangler::mangleType(const ObjCObjectType *T,
2727 Qualifiers Quals, SourceRange Range) {
2728 if (T->isKindOfType())
2729 return mangleObjCKindOfType(T, Quals, Range);
2730
2731 if (T->qual_empty() && !T->isSpecialized())
Saleem Abdulrasoolf591e362018-01-26 19:08:26 +00002732 return mangleType(T->getBaseType(), Range, QMM_Drop);
2733
2734 ArgBackRefMap OuterArgsContext;
2735 BackRefVec OuterTemplateContext;
2736
2737 TypeBackReferences.swap(OuterArgsContext);
2738 NameBackReferences.swap(OuterTemplateContext);
2739
2740 mangleTagTypeKind(TTK_Struct);
2741
2742 Out << "?$";
2743 if (T->isObjCId())
Shoaib Meenaic8714d22018-10-04 19:50:14 +00002744 mangleSourceName("objc_object");
Saleem Abdulrasoolf591e362018-01-26 19:08:26 +00002745 else if (T->isObjCClass())
Shoaib Meenaic8714d22018-10-04 19:50:14 +00002746 mangleSourceName("objc_class");
Saleem Abdulrasoolf591e362018-01-26 19:08:26 +00002747 else
Shoaib Meenaic8714d22018-10-04 19:50:14 +00002748 mangleSourceName(T->getInterface()->getName());
Saleem Abdulrasoolf591e362018-01-26 19:08:26 +00002749
Saleem Abdulrasoolbbce34a2018-02-09 03:23:54 +00002750 for (const auto &Q : T->quals())
2751 mangleObjCProtocol(Q);
Saleem Abdulrasoolf3a981e2018-09-28 16:47:53 +00002752
2753 if (T->isSpecialized())
2754 for (const auto &TA : T->getTypeArgs())
2755 mangleType(TA, Range, QMM_Drop);
2756
Saleem Abdulrasoolf591e362018-01-26 19:08:26 +00002757 Out << '@';
2758
2759 Out << '@';
2760
2761 TypeBackReferences.swap(OuterArgsContext);
2762 NameBackReferences.swap(OuterTemplateContext);
Guy Benyei11169dd2012-12-18 14:30:41 +00002763}
2764
2765void MicrosoftCXXNameMangler::mangleType(const BlockPointerType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002766 Qualifiers Quals, SourceRange Range) {
2767 QualType PointeeType = T->getPointeeType();
2768 manglePointerCVQualifiers(Quals);
2769 manglePointerExtQualifiers(Quals, PointeeType);
2770
Guy Benyei11169dd2012-12-18 14:30:41 +00002771 Out << "_E";
2772
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002773 mangleFunctionType(PointeeType->castAs<FunctionProtoType>());
Guy Benyei11169dd2012-12-18 14:30:41 +00002774}
2775
David Majnemerf0a84f22013-08-16 08:29:13 +00002776void MicrosoftCXXNameMangler::mangleType(const InjectedClassNameType *,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002777 Qualifiers, SourceRange) {
David Majnemerf0a84f22013-08-16 08:29:13 +00002778 llvm_unreachable("Cannot mangle injected class name type.");
Guy Benyei11169dd2012-12-18 14:30:41 +00002779}
2780
2781void MicrosoftCXXNameMangler::mangleType(const TemplateSpecializationType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002782 Qualifiers, SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002783 DiagnosticsEngine &Diags = Context.getDiags();
2784 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2785 "cannot mangle this template specialization type yet");
2786 Diags.Report(Range.getBegin(), DiagID)
2787 << Range;
2788}
2789
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002790void MicrosoftCXXNameMangler::mangleType(const DependentNameType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002791 SourceRange Range) {
2792 DiagnosticsEngine &Diags = Context.getDiags();
2793 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2794 "cannot mangle this dependent name type yet");
2795 Diags.Report(Range.getBegin(), DiagID)
2796 << Range;
2797}
2798
2799void MicrosoftCXXNameMangler::mangleType(
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002800 const DependentTemplateSpecializationType *T, Qualifiers,
2801 SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002802 DiagnosticsEngine &Diags = Context.getDiags();
2803 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2804 "cannot mangle this dependent template specialization type yet");
2805 Diags.Report(Range.getBegin(), DiagID)
2806 << Range;
2807}
2808
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002809void MicrosoftCXXNameMangler::mangleType(const PackExpansionType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002810 SourceRange Range) {
2811 DiagnosticsEngine &Diags = Context.getDiags();
2812 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2813 "cannot mangle this pack expansion yet");
2814 Diags.Report(Range.getBegin(), DiagID)
2815 << Range;
2816}
2817
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002818void MicrosoftCXXNameMangler::mangleType(const TypeOfType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002819 SourceRange Range) {
2820 DiagnosticsEngine &Diags = Context.getDiags();
2821 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2822 "cannot mangle this typeof(type) yet");
2823 Diags.Report(Range.getBegin(), DiagID)
2824 << Range;
2825}
2826
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002827void MicrosoftCXXNameMangler::mangleType(const TypeOfExprType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002828 SourceRange Range) {
2829 DiagnosticsEngine &Diags = Context.getDiags();
2830 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2831 "cannot mangle this typeof(expression) yet");
2832 Diags.Report(Range.getBegin(), DiagID)
2833 << Range;
2834}
2835
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002836void MicrosoftCXXNameMangler::mangleType(const DecltypeType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002837 SourceRange Range) {
2838 DiagnosticsEngine &Diags = Context.getDiags();
2839 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2840 "cannot mangle this decltype() yet");
2841 Diags.Report(Range.getBegin(), DiagID)
2842 << Range;
2843}
2844
2845void MicrosoftCXXNameMangler::mangleType(const UnaryTransformType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002846 Qualifiers, SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002847 DiagnosticsEngine &Diags = Context.getDiags();
2848 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2849 "cannot mangle this unary transform type yet");
2850 Diags.Report(Range.getBegin(), DiagID)
2851 << Range;
2852}
2853
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002854void MicrosoftCXXNameMangler::mangleType(const AutoType *T, Qualifiers,
2855 SourceRange Range) {
David Majnemerb9a5f2d2014-01-21 20:33:36 +00002856 assert(T->getDeducedType().isNull() && "expecting a dependent type!");
2857
Guy Benyei11169dd2012-12-18 14:30:41 +00002858 DiagnosticsEngine &Diags = Context.getDiags();
2859 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2860 "cannot mangle this 'auto' type yet");
2861 Diags.Report(Range.getBegin(), DiagID)
2862 << Range;
2863}
2864
Richard Smith600b5262017-01-26 20:40:47 +00002865void MicrosoftCXXNameMangler::mangleType(
2866 const DeducedTemplateSpecializationType *T, Qualifiers, SourceRange Range) {
2867 assert(T->getDeducedType().isNull() && "expecting a dependent type!");
2868
2869 DiagnosticsEngine &Diags = Context.getDiags();
2870 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2871 "cannot mangle this deduced class template specialization type yet");
2872 Diags.Report(Range.getBegin(), DiagID)
2873 << Range;
2874}
2875
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002876void MicrosoftCXXNameMangler::mangleType(const AtomicType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002877 SourceRange Range) {
David Majnemer3421fb62015-12-29 11:46:00 +00002878 QualType ValueType = T->getValueType();
2879
2880 llvm::SmallString<64> TemplateMangling;
2881 llvm::raw_svector_ostream Stream(TemplateMangling);
2882 MicrosoftCXXNameMangler Extra(Context, Stream);
2883 Stream << "?$";
2884 Extra.mangleSourceName("_Atomic");
2885 Extra.mangleType(ValueType, Range, QMM_Escape);
2886
Shoaib Meenaid84cf132018-11-14 19:16:22 +00002887 mangleArtificialTagType(TTK_Struct, TemplateMangling, {"__clang"});
Guy Benyei11169dd2012-12-18 14:30:41 +00002888}
2889
Xiuli Pan9c14e282016-01-09 12:53:17 +00002890void MicrosoftCXXNameMangler::mangleType(const PipeType *T, Qualifiers,
2891 SourceRange Range) {
2892 DiagnosticsEngine &Diags = Context.getDiags();
2893 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2894 "cannot mangle this OpenCL pipe type yet");
2895 Diags.Report(Range.getBegin(), DiagID)
2896 << Range;
2897}
2898
Rafael Espindola002667c2013-10-16 01:40:34 +00002899void MicrosoftMangleContextImpl::mangleCXXName(const NamedDecl *D,
2900 raw_ostream &Out) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002901 assert((isa<FunctionDecl>(D) || isa<VarDecl>(D)) &&
2902 "Invalid mangleName() call, argument is not a variable or function!");
2903 assert(!isa<CXXConstructorDecl>(D) && !isa<CXXDestructorDecl>(D) &&
2904 "Invalid mangleName() call on 'structor decl!");
2905
2906 PrettyStackTraceDecl CrashInfo(D, SourceLocation(),
2907 getASTContext().getSourceManager(),
2908 "Mangling declaration");
2909
David Majnemerfebb2722016-03-07 08:51:17 +00002910 msvc_hashing_ostream MHO(Out);
2911 MicrosoftCXXNameMangler Mangler(*this, MHO);
Guy Benyei11169dd2012-12-18 14:30:41 +00002912 return Mangler.mangle(D);
2913}
Timur Iskhodzhanovdf7e7fb2013-07-30 09:46:19 +00002914
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002915// <this-adjustment> ::= <no-adjustment> | <static-adjustment> |
2916// <virtual-adjustment>
2917// <no-adjustment> ::= A # private near
2918// ::= B # private far
2919// ::= I # protected near
2920// ::= J # protected far
2921// ::= Q # public near
2922// ::= R # public far
2923// <static-adjustment> ::= G <static-offset> # private near
2924// ::= H <static-offset> # private far
2925// ::= O <static-offset> # protected near
2926// ::= P <static-offset> # protected far
2927// ::= W <static-offset> # public near
2928// ::= X <static-offset> # public far
2929// <virtual-adjustment> ::= $0 <virtual-shift> <static-offset> # private near
2930// ::= $1 <virtual-shift> <static-offset> # private far
2931// ::= $2 <virtual-shift> <static-offset> # protected near
2932// ::= $3 <virtual-shift> <static-offset> # protected far
2933// ::= $4 <virtual-shift> <static-offset> # public near
2934// ::= $5 <virtual-shift> <static-offset> # public far
2935// <virtual-shift> ::= <vtordisp-shift> | <vtordispex-shift>
2936// <vtordisp-shift> ::= <offset-to-vtordisp>
2937// <vtordispex-shift> ::= <offset-to-vbptr> <vbase-offset-offset>
2938// <offset-to-vtordisp>
Reid Kleckner3ab5a9c2018-12-26 20:07:52 +00002939static void mangleThunkThisAdjustment(AccessSpecifier AS,
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00002940 const ThisAdjustment &Adjustment,
2941 MicrosoftCXXNameMangler &Mangler,
2942 raw_ostream &Out) {
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002943 if (!Adjustment.Virtual.isEmpty()) {
2944 Out << '$';
2945 char AccessSpec;
Reid Kleckner3ab5a9c2018-12-26 20:07:52 +00002946 switch (AS) {
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002947 case AS_none:
2948 llvm_unreachable("Unsupported access specifier");
2949 case AS_private:
2950 AccessSpec = '0';
2951 break;
2952 case AS_protected:
2953 AccessSpec = '2';
2954 break;
2955 case AS_public:
2956 AccessSpec = '4';
2957 }
2958 if (Adjustment.Virtual.Microsoft.VBPtrOffset) {
2959 Out << 'R' << AccessSpec;
David Majnemer2a816452013-12-09 10:44:32 +00002960 Mangler.mangleNumber(
2961 static_cast<uint32_t>(Adjustment.Virtual.Microsoft.VBPtrOffset));
2962 Mangler.mangleNumber(
2963 static_cast<uint32_t>(Adjustment.Virtual.Microsoft.VBOffsetOffset));
2964 Mangler.mangleNumber(
2965 static_cast<uint32_t>(Adjustment.Virtual.Microsoft.VtordispOffset));
2966 Mangler.mangleNumber(static_cast<uint32_t>(Adjustment.NonVirtual));
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002967 } else {
2968 Out << AccessSpec;
David Majnemer2a816452013-12-09 10:44:32 +00002969 Mangler.mangleNumber(
2970 static_cast<uint32_t>(Adjustment.Virtual.Microsoft.VtordispOffset));
2971 Mangler.mangleNumber(-static_cast<uint32_t>(Adjustment.NonVirtual));
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002972 }
2973 } else if (Adjustment.NonVirtual != 0) {
Reid Kleckner3ab5a9c2018-12-26 20:07:52 +00002974 switch (AS) {
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00002975 case AS_none:
2976 llvm_unreachable("Unsupported access specifier");
2977 case AS_private:
2978 Out << 'G';
2979 break;
2980 case AS_protected:
2981 Out << 'O';
2982 break;
2983 case AS_public:
2984 Out << 'W';
2985 }
David Majnemer2a816452013-12-09 10:44:32 +00002986 Mangler.mangleNumber(-static_cast<uint32_t>(Adjustment.NonVirtual));
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00002987 } else {
Reid Kleckner3ab5a9c2018-12-26 20:07:52 +00002988 switch (AS) {
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00002989 case AS_none:
2990 llvm_unreachable("Unsupported access specifier");
2991 case AS_private:
2992 Out << 'A';
2993 break;
2994 case AS_protected:
2995 Out << 'I';
2996 break;
2997 case AS_public:
2998 Out << 'Q';
2999 }
3000 }
3001}
3002
Reid Klecknercbec0262018-04-02 20:00:39 +00003003void MicrosoftMangleContextImpl::mangleVirtualMemPtrThunk(
3004 const CXXMethodDecl *MD, const MethodVFTableLocation &ML,
3005 raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003006 msvc_hashing_ostream MHO(Out);
3007 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Klecknerfb931542018-03-16 20:36:49 +00003008 Mangler.getStream() << '?';
Reid Kleckner96f8f932014-02-05 17:27:08 +00003009 Mangler.mangleVirtualMemPtrThunk(MD, ML);
Hans Wennborg88497d62013-11-15 17:24:45 +00003010}
3011
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003012void MicrosoftMangleContextImpl::mangleThunk(const CXXMethodDecl *MD,
3013 const ThunkInfo &Thunk,
3014 raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003015 msvc_hashing_ostream MHO(Out);
3016 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Klecknerfb931542018-03-16 20:36:49 +00003017 Mangler.getStream() << '?';
Timur Iskhodzhanovdf7e7fb2013-07-30 09:46:19 +00003018 Mangler.mangleName(MD);
Reid Kleckner3ab5a9c2018-12-26 20:07:52 +00003019
3020 // Usually the thunk uses the access specifier of the new method, but if this
3021 // is a covariant return thunk, then MSVC always uses the public access
3022 // specifier, and we do the same.
3023 AccessSpecifier AS = Thunk.Return.isEmpty() ? MD->getAccess() : AS_public;
3024 mangleThunkThisAdjustment(AS, Thunk.This, Mangler, MHO);
3025
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00003026 if (!Thunk.Return.isEmpty())
Craig Topper36250ad2014-05-12 05:36:57 +00003027 assert(Thunk.Method != nullptr &&
3028 "Thunk info should hold the overridee decl");
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00003029
3030 const CXXMethodDecl *DeclForFPT = Thunk.Method ? Thunk.Method : MD;
3031 Mangler.mangleFunctionType(
3032 DeclForFPT->getType()->castAs<FunctionProtoType>(), MD);
Guy Benyei11169dd2012-12-18 14:30:41 +00003033}
Timur Iskhodzhanovdf7e7fb2013-07-30 09:46:19 +00003034
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00003035void MicrosoftMangleContextImpl::mangleCXXDtorThunk(
3036 const CXXDestructorDecl *DD, CXXDtorType Type,
3037 const ThisAdjustment &Adjustment, raw_ostream &Out) {
3038 // FIXME: Actually, the dtor thunk should be emitted for vector deleting
3039 // dtors rather than scalar deleting dtors. Just use the vector deleting dtor
3040 // mangling manually until we support both deleting dtor types.
3041 assert(Type == Dtor_Deleting);
David Majnemerfebb2722016-03-07 08:51:17 +00003042 msvc_hashing_ostream MHO(Out);
3043 MicrosoftCXXNameMangler Mangler(*this, MHO, DD, Type);
Reid Klecknerfb931542018-03-16 20:36:49 +00003044 Mangler.getStream() << "??_E";
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00003045 Mangler.mangleName(DD->getParent());
Reid Kleckner3ab5a9c2018-12-26 20:07:52 +00003046 mangleThunkThisAdjustment(DD->getAccess(), Adjustment, Mangler, MHO);
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00003047 Mangler.mangleFunctionType(DD->getType()->castAs<FunctionProtoType>(), DD);
Guy Benyei11169dd2012-12-18 14:30:41 +00003048}
Reid Kleckner7810af02013-06-19 15:20:38 +00003049
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003050void MicrosoftMangleContextImpl::mangleCXXVFTable(
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00003051 const CXXRecordDecl *Derived, ArrayRef<const CXXRecordDecl *> BasePath,
3052 raw_ostream &Out) {
Reid Kleckner7810af02013-06-19 15:20:38 +00003053 // <mangled-name> ::= ?_7 <class-name> <storage-class>
3054 // <cvr-qualifiers> [<name>] @
Guy Benyei11169dd2012-12-18 14:30:41 +00003055 // NOTE: <cvr-qualifiers> here is always 'B' (const). <storage-class>
Reid Kleckner7810af02013-06-19 15:20:38 +00003056 // is always '6' for vftables.
David Majnemerfebb2722016-03-07 08:51:17 +00003057 msvc_hashing_ostream MHO(Out);
3058 MicrosoftCXXNameMangler Mangler(*this, MHO);
David Majnemer2d8b2002016-02-11 17:49:28 +00003059 if (Derived->hasAttr<DLLImportAttr>())
Reid Klecknerfb931542018-03-16 20:36:49 +00003060 Mangler.getStream() << "??_S";
David Majnemer2d8b2002016-02-11 17:49:28 +00003061 else
Reid Klecknerfb931542018-03-16 20:36:49 +00003062 Mangler.getStream() << "??_7";
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00003063 Mangler.mangleName(Derived);
3064 Mangler.getStream() << "6B"; // '6' for vftable, 'B' for const.
David Majnemerb926dbc2014-04-23 05:16:53 +00003065 for (const CXXRecordDecl *RD : BasePath)
3066 Mangler.mangleName(RD);
Guy Benyei11169dd2012-12-18 14:30:41 +00003067 Mangler.getStream() << '@';
3068}
Reid Kleckner7810af02013-06-19 15:20:38 +00003069
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003070void MicrosoftMangleContextImpl::mangleCXXVBTable(
Reid Kleckner7810af02013-06-19 15:20:38 +00003071 const CXXRecordDecl *Derived, ArrayRef<const CXXRecordDecl *> BasePath,
3072 raw_ostream &Out) {
3073 // <mangled-name> ::= ?_8 <class-name> <storage-class>
3074 // <cvr-qualifiers> [<name>] @
3075 // NOTE: <cvr-qualifiers> here is always 'B' (const). <storage-class>
3076 // is always '7' for vbtables.
David Majnemerfebb2722016-03-07 08:51:17 +00003077 msvc_hashing_ostream MHO(Out);
3078 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Klecknerfb931542018-03-16 20:36:49 +00003079 Mangler.getStream() << "??_8";
Reid Kleckner7810af02013-06-19 15:20:38 +00003080 Mangler.mangleName(Derived);
3081 Mangler.getStream() << "7B"; // '7' for vbtable, 'B' for const.
David Majnemerb926dbc2014-04-23 05:16:53 +00003082 for (const CXXRecordDecl *RD : BasePath)
3083 Mangler.mangleName(RD);
Reid Kleckner7810af02013-06-19 15:20:38 +00003084 Mangler.getStream() << '@';
3085}
3086
David Majnemera96b7ee2014-05-13 00:44:44 +00003087void MicrosoftMangleContextImpl::mangleCXXRTTI(QualType T, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003088 msvc_hashing_ostream MHO(Out);
3089 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Klecknerfb931542018-03-16 20:36:49 +00003090 Mangler.getStream() << "??_R0";
David Majnemera96b7ee2014-05-13 00:44:44 +00003091 Mangler.mangleType(T, SourceRange(), MicrosoftCXXNameMangler::QMM_Result);
3092 Mangler.getStream() << "@8";
Guy Benyei11169dd2012-12-18 14:30:41 +00003093}
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003094
David Majnemera96b7ee2014-05-13 00:44:44 +00003095void MicrosoftMangleContextImpl::mangleCXXRTTIName(QualType T,
3096 raw_ostream &Out) {
3097 MicrosoftCXXNameMangler Mangler(*this, Out);
3098 Mangler.getStream() << '.';
3099 Mangler.mangleType(T, SourceRange(), MicrosoftCXXNameMangler::QMM_Result);
3100}
3101
David Majnemerc1709d32015-06-23 07:31:11 +00003102void MicrosoftMangleContextImpl::mangleCXXVirtualDisplacementMap(
3103 const CXXRecordDecl *SrcRD, const CXXRecordDecl *DstRD, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003104 msvc_hashing_ostream MHO(Out);
3105 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Klecknerfb931542018-03-16 20:36:49 +00003106 Mangler.getStream() << "??_K";
David Majnemerc1709d32015-06-23 07:31:11 +00003107 Mangler.mangleName(SrcRD);
3108 Mangler.getStream() << "$C";
3109 Mangler.mangleName(DstRD);
3110}
3111
David Majnemer526793d2016-07-12 04:42:50 +00003112void MicrosoftMangleContextImpl::mangleCXXThrowInfo(QualType T, bool IsConst,
David Majnemer7c237072015-03-05 00:46:22 +00003113 bool IsVolatile,
David Majnemer526793d2016-07-12 04:42:50 +00003114 bool IsUnaligned,
David Majnemer7c237072015-03-05 00:46:22 +00003115 uint32_t NumEntries,
3116 raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003117 msvc_hashing_ostream MHO(Out);
3118 MicrosoftCXXNameMangler Mangler(*this, MHO);
David Majnemer7c237072015-03-05 00:46:22 +00003119 Mangler.getStream() << "_TI";
3120 if (IsConst)
3121 Mangler.getStream() << 'C';
3122 if (IsVolatile)
3123 Mangler.getStream() << 'V';
David Majnemer526793d2016-07-12 04:42:50 +00003124 if (IsUnaligned)
3125 Mangler.getStream() << 'U';
David Majnemer7c237072015-03-05 00:46:22 +00003126 Mangler.getStream() << NumEntries;
3127 Mangler.mangleType(T, SourceRange(), MicrosoftCXXNameMangler::QMM_Result);
3128}
3129
3130void MicrosoftMangleContextImpl::mangleCXXCatchableTypeArray(
3131 QualType T, uint32_t NumEntries, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003132 msvc_hashing_ostream MHO(Out);
3133 MicrosoftCXXNameMangler Mangler(*this, MHO);
David Majnemer7c237072015-03-05 00:46:22 +00003134 Mangler.getStream() << "_CTA";
3135 Mangler.getStream() << NumEntries;
3136 Mangler.mangleType(T, SourceRange(), MicrosoftCXXNameMangler::QMM_Result);
3137}
3138
David Majnemere7a818f2015-03-06 18:53:55 +00003139void MicrosoftMangleContextImpl::mangleCXXCatchableType(
David Majnemerdfa6d202015-03-11 18:36:39 +00003140 QualType T, const CXXConstructorDecl *CD, CXXCtorType CT, uint32_t Size,
3141 uint32_t NVOffset, int32_t VBPtrOffset, uint32_t VBIndex,
3142 raw_ostream &Out) {
David Majnemer7c237072015-03-05 00:46:22 +00003143 MicrosoftCXXNameMangler Mangler(*this, Out);
David Majnemere7a818f2015-03-06 18:53:55 +00003144 Mangler.getStream() << "_CT";
3145
3146 llvm::SmallString<64> RTTIMangling;
3147 {
3148 llvm::raw_svector_ostream Stream(RTTIMangling);
David Majnemerfebb2722016-03-07 08:51:17 +00003149 msvc_hashing_ostream MHO(Stream);
3150 mangleCXXRTTI(T, MHO);
David Majnemere7a818f2015-03-06 18:53:55 +00003151 }
Reid Klecknerfb931542018-03-16 20:36:49 +00003152 Mangler.getStream() << RTTIMangling;
David Majnemere7a818f2015-03-06 18:53:55 +00003153
Nico Webere3b1f5d2019-05-29 13:48:19 +00003154 // VS2015 and VS2017.1 omit the copy-constructor in the mangled name but
3155 // both older and newer versions include it.
3156 // FIXME: It is known that the Ctor is present in 2013, and in 2017.7
3157 // (_MSC_VER 1914) and newer, and that it's omitted in 2015 and 2017.4
3158 // (_MSC_VER 1911), but it's unknown when exactly it reappeared (1914?
3159 // Or 1912, 1913 aleady?).
3160 bool OmitCopyCtor = getASTContext().getLangOpts().isCompatibleWithMSVC(
3161 LangOptions::MSVC2015) &&
3162 !getASTContext().getLangOpts().isCompatibleWithMSVC(
3163 LangOptions::MSVC2017_7);
David Majnemere7a818f2015-03-06 18:53:55 +00003164 llvm::SmallString<64> CopyCtorMangling;
Nico Webere3b1f5d2019-05-29 13:48:19 +00003165 if (!OmitCopyCtor && CD) {
David Majnemere7a818f2015-03-06 18:53:55 +00003166 llvm::raw_svector_ostream Stream(CopyCtorMangling);
David Majnemerfebb2722016-03-07 08:51:17 +00003167 msvc_hashing_ostream MHO(Stream);
3168 mangleCXXCtor(CD, CT, MHO);
David Majnemere7a818f2015-03-06 18:53:55 +00003169 }
Reid Klecknerfb931542018-03-16 20:36:49 +00003170 Mangler.getStream() << CopyCtorMangling;
David Majnemere7a818f2015-03-06 18:53:55 +00003171
David Majnemer7c237072015-03-05 00:46:22 +00003172 Mangler.getStream() << Size;
David Majnemer999cbf92015-03-10 19:01:51 +00003173 if (VBPtrOffset == -1) {
3174 if (NVOffset) {
3175 Mangler.getStream() << NVOffset;
3176 }
3177 } else {
3178 Mangler.getStream() << NVOffset;
3179 Mangler.getStream() << VBPtrOffset;
3180 Mangler.getStream() << VBIndex;
3181 }
David Majnemer7c237072015-03-05 00:46:22 +00003182}
3183
David Majnemera96b7ee2014-05-13 00:44:44 +00003184void MicrosoftMangleContextImpl::mangleCXXRTTIBaseClassDescriptor(
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00003185 const CXXRecordDecl *Derived, uint32_t NVOffset, int32_t VBPtrOffset,
David Majnemeraeb55c92014-05-13 06:57:43 +00003186 uint32_t VBTableOffset, uint32_t Flags, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003187 msvc_hashing_ostream MHO(Out);
3188 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Klecknerfb931542018-03-16 20:36:49 +00003189 Mangler.getStream() << "??_R1";
David Majnemera96b7ee2014-05-13 00:44:44 +00003190 Mangler.mangleNumber(NVOffset);
3191 Mangler.mangleNumber(VBPtrOffset);
3192 Mangler.mangleNumber(VBTableOffset);
3193 Mangler.mangleNumber(Flags);
David Majnemeraeb55c92014-05-13 06:57:43 +00003194 Mangler.mangleName(Derived);
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00003195 Mangler.getStream() << "8";
David Majnemera96b7ee2014-05-13 00:44:44 +00003196}
3197
3198void MicrosoftMangleContextImpl::mangleCXXRTTIBaseClassArray(
3199 const CXXRecordDecl *Derived, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003200 msvc_hashing_ostream MHO(Out);
3201 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Klecknerfb931542018-03-16 20:36:49 +00003202 Mangler.getStream() << "??_R2";
David Majnemera96b7ee2014-05-13 00:44:44 +00003203 Mangler.mangleName(Derived);
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00003204 Mangler.getStream() << "8";
David Majnemera96b7ee2014-05-13 00:44:44 +00003205}
3206
3207void MicrosoftMangleContextImpl::mangleCXXRTTIClassHierarchyDescriptor(
3208 const CXXRecordDecl *Derived, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003209 msvc_hashing_ostream MHO(Out);
3210 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Klecknerfb931542018-03-16 20:36:49 +00003211 Mangler.getStream() << "??_R3";
David Majnemera96b7ee2014-05-13 00:44:44 +00003212 Mangler.mangleName(Derived);
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00003213 Mangler.getStream() << "8";
David Majnemera96b7ee2014-05-13 00:44:44 +00003214}
3215
3216void MicrosoftMangleContextImpl::mangleCXXRTTICompleteObjectLocator(
David Majnemeraeb55c92014-05-13 06:57:43 +00003217 const CXXRecordDecl *Derived, ArrayRef<const CXXRecordDecl *> BasePath,
3218 raw_ostream &Out) {
3219 // <mangled-name> ::= ?_R4 <class-name> <storage-class>
3220 // <cvr-qualifiers> [<name>] @
3221 // NOTE: <cvr-qualifiers> here is always 'B' (const). <storage-class>
3222 // is always '6' for vftables.
David Majnemerfebb2722016-03-07 08:51:17 +00003223 llvm::SmallString<64> VFTableMangling;
3224 llvm::raw_svector_ostream Stream(VFTableMangling);
3225 mangleCXXVFTable(Derived, BasePath, Stream);
3226
Reid Klecknerfb931542018-03-16 20:36:49 +00003227 if (VFTableMangling.startswith("??@")) {
David Majnemerfebb2722016-03-07 08:51:17 +00003228 assert(VFTableMangling.endswith("@"));
3229 Out << VFTableMangling << "??_R4@";
3230 return;
3231 }
3232
Reid Klecknerfb931542018-03-16 20:36:49 +00003233 assert(VFTableMangling.startswith("??_7") ||
3234 VFTableMangling.startswith("??_S"));
David Majnemerfebb2722016-03-07 08:51:17 +00003235
Reid Klecknerfb931542018-03-16 20:36:49 +00003236 Out << "??_R4" << StringRef(VFTableMangling).drop_front(4);
Guy Benyei11169dd2012-12-18 14:30:41 +00003237}
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003238
Reid Kleckner1d59f992015-01-22 01:36:17 +00003239void MicrosoftMangleContextImpl::mangleSEHFilterExpression(
3240 const NamedDecl *EnclosingDecl, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003241 msvc_hashing_ostream MHO(Out);
3242 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Kleckner1d59f992015-01-22 01:36:17 +00003243 // The function body is in the same comdat as the function with the handler,
3244 // so the numbering here doesn't have to be the same across TUs.
3245 //
3246 // <mangled-name> ::= ?filt$ <filter-number> @0
Reid Klecknerfb931542018-03-16 20:36:49 +00003247 Mangler.getStream() << "?filt$" << SEHFilterIds[EnclosingDecl]++ << "@0@";
Reid Kleckner1d59f992015-01-22 01:36:17 +00003248 Mangler.mangleName(EnclosingDecl);
3249}
3250
Reid Klecknerebaf28d2015-04-14 20:59:00 +00003251void MicrosoftMangleContextImpl::mangleSEHFinallyBlock(
3252 const NamedDecl *EnclosingDecl, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003253 msvc_hashing_ostream MHO(Out);
3254 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00003255 // The function body is in the same comdat as the function with the handler,
3256 // so the numbering here doesn't have to be the same across TUs.
3257 //
3258 // <mangled-name> ::= ?fin$ <filter-number> @0
Reid Klecknerfb931542018-03-16 20:36:49 +00003259 Mangler.getStream() << "?fin$" << SEHFinallyIds[EnclosingDecl]++ << "@0@";
Reid Klecknerebaf28d2015-04-14 20:59:00 +00003260 Mangler.mangleName(EnclosingDecl);
3261}
3262
Reid Klecknercc99e262013-11-19 23:23:00 +00003263void MicrosoftMangleContextImpl::mangleTypeName(QualType T, raw_ostream &Out) {
3264 // This is just a made up unique string for the purposes of tbaa. undname
3265 // does *not* know how to demangle it.
3266 MicrosoftCXXNameMangler Mangler(*this, Out);
3267 Mangler.getStream() << '?';
3268 Mangler.mangleType(T, SourceRange());
3269}
3270
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003271void MicrosoftMangleContextImpl::mangleCXXCtor(const CXXConstructorDecl *D,
3272 CXXCtorType Type,
3273 raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003274 msvc_hashing_ostream MHO(Out);
3275 MicrosoftCXXNameMangler mangler(*this, MHO, D, Type);
Guy Benyei11169dd2012-12-18 14:30:41 +00003276 mangler.mangle(D);
3277}
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003278
3279void MicrosoftMangleContextImpl::mangleCXXDtor(const CXXDestructorDecl *D,
3280 CXXDtorType Type,
3281 raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003282 msvc_hashing_ostream MHO(Out);
3283 MicrosoftCXXNameMangler mangler(*this, MHO, D, Type);
Guy Benyei11169dd2012-12-18 14:30:41 +00003284 mangler.mangle(D);
3285}
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003286
David Majnemere77de752015-12-29 22:25:14 +00003287void MicrosoftMangleContextImpl::mangleReferenceTemporary(
3288 const VarDecl *VD, unsigned ManglingNumber, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003289 msvc_hashing_ostream MHO(Out);
3290 MicrosoftCXXNameMangler Mangler(*this, MHO);
David Majnemere77de752015-12-29 22:25:14 +00003291
Reid Klecknerfb931542018-03-16 20:36:49 +00003292 Mangler.getStream() << "?$RT" << ManglingNumber << '@';
David Majnemere77de752015-12-29 22:25:14 +00003293 Mangler.mangle(VD, "");
Guy Benyei11169dd2012-12-18 14:30:41 +00003294}
3295
David Majnemer8354eee2015-05-07 06:15:46 +00003296void MicrosoftMangleContextImpl::mangleThreadSafeStaticGuardVariable(
3297 const VarDecl *VD, unsigned GuardNum, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00003298 msvc_hashing_ostream MHO(Out);
3299 MicrosoftCXXNameMangler Mangler(*this, MHO);
David Majnemer8354eee2015-05-07 06:15:46 +00003300
Reid Klecknerfb931542018-03-16 20:36:49 +00003301 Mangler.getStream() << "?$TSS" << GuardNum << '@';
David Majnemer8354eee2015-05-07 06:15:46 +00003302 Mangler.mangleNestedName(VD);
Dmitry Polukhin5fa681e2016-05-27 08:52:34 +00003303 Mangler.getStream() << "@4HA";
David Majnemer8354eee2015-05-07 06:15:46 +00003304}
3305
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003306void MicrosoftMangleContextImpl::mangleStaticGuardVariable(const VarDecl *VD,
3307 raw_ostream &Out) {
David Majnemer2206bf52014-03-05 08:57:59 +00003308 // <guard-name> ::= ?_B <postfix> @5 <scope-depth>
David Majnemerec8e54b2015-05-07 21:19:06 +00003309 // ::= ?__J <postfix> @5 <scope-depth>
Reid Klecknerd8110b62013-09-10 20:14:30 +00003310 // ::= ?$S <guard-num> @ <postfix> @4IA
3311
3312 // The first mangling is what MSVC uses to guard static locals in inline
3313 // functions. It uses a different mangling in external functions to support
3314 // guarding more than 32 variables. MSVC rejects inline functions with more
3315 // than 32 static locals. We don't fully implement the second mangling
3316 // because those guards are not externally visible, and instead use LLVM's
3317 // default renaming when creating a new guard variable.
David Majnemerfebb2722016-03-07 08:51:17 +00003318 msvc_hashing_ostream MHO(Out);
3319 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Klecknerd8110b62013-09-10 20:14:30 +00003320
3321 bool Visible = VD->isExternallyVisible();
David Majnemer8354eee2015-05-07 06:15:46 +00003322 if (Visible) {
Reid Klecknerfb931542018-03-16 20:36:49 +00003323 Mangler.getStream() << (VD->getTLSKind() ? "??__J" : "??_B");
David Majnemer8354eee2015-05-07 06:15:46 +00003324 } else {
Reid Klecknerfb931542018-03-16 20:36:49 +00003325 Mangler.getStream() << "?$S1@";
David Majnemer8354eee2015-05-07 06:15:46 +00003326 }
David Majnemer34b49892014-03-06 19:57:36 +00003327 unsigned ScopeDepth = 0;
3328 if (Visible && !getNextDiscriminator(VD, ScopeDepth))
3329 // If we do not have a discriminator and are emitting a guard variable for
3330 // use at global scope, then mangling the nested name will not be enough to
3331 // remove ambiguities.
3332 Mangler.mangle(VD, "");
3333 else
3334 Mangler.mangleNestedName(VD);
David Majnemer2206bf52014-03-05 08:57:59 +00003335 Mangler.getStream() << (Visible ? "@5" : "@4IA");
David Majnemer34b49892014-03-06 19:57:36 +00003336 if (ScopeDepth)
David Majnemer2206bf52014-03-05 08:57:59 +00003337 Mangler.mangleNumber(ScopeDepth);
Reid Klecknerd8110b62013-09-10 20:14:30 +00003338}
3339
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003340void MicrosoftMangleContextImpl::mangleInitFiniStub(const VarDecl *D,
David Majnemerfebb2722016-03-07 08:51:17 +00003341 char CharCode,
3342 raw_ostream &Out) {
3343 msvc_hashing_ostream MHO(Out);
3344 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Klecknerfb931542018-03-16 20:36:49 +00003345 Mangler.getStream() << "??__" << CharCode;
David Majnemerf55feec2014-03-06 19:10:27 +00003346 if (D->isStaticDataMember()) {
Zachary Turnerf4f767d2018-08-30 20:53:11 +00003347 Mangler.getStream() << '?';
3348 Mangler.mangleName(D);
David Majnemerf55feec2014-03-06 19:10:27 +00003349 Mangler.mangleVariableEncoding(D);
Zachary Turnerf4f767d2018-08-30 20:53:11 +00003350 Mangler.getStream() << "@@";
3351 } else {
3352 Mangler.mangleName(D);
David Majnemerf55feec2014-03-06 19:10:27 +00003353 }
Reid Kleckner1ece9fc2013-09-10 20:43:12 +00003354 // This is the function class mangling. These stubs are global, non-variadic,
3355 // cdecl functions that return void and take no args.
3356 Mangler.getStream() << "YAXXZ";
3357}
3358
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003359void MicrosoftMangleContextImpl::mangleDynamicInitializer(const VarDecl *D,
3360 raw_ostream &Out) {
Reid Kleckner1ece9fc2013-09-10 20:43:12 +00003361 // <initializer-name> ::= ?__E <name> YAXXZ
David Majnemerfebb2722016-03-07 08:51:17 +00003362 mangleInitFiniStub(D, 'E', Out);
Reid Kleckner1ece9fc2013-09-10 20:43:12 +00003363}
3364
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003365void
3366MicrosoftMangleContextImpl::mangleDynamicAtExitDestructor(const VarDecl *D,
3367 raw_ostream &Out) {
Reid Kleckner1ece9fc2013-09-10 20:43:12 +00003368 // <destructor-name> ::= ?__F <name> YAXXZ
David Majnemerfebb2722016-03-07 08:51:17 +00003369 mangleInitFiniStub(D, 'F', Out);
Reid Klecknerd8110b62013-09-10 20:14:30 +00003370}
3371
David Majnemer58e5bee2014-03-24 21:43:36 +00003372void MicrosoftMangleContextImpl::mangleStringLiteral(const StringLiteral *SL,
3373 raw_ostream &Out) {
Nico Webera2d9c2b2018-07-02 12:31:20 +00003374 // <char-type> ::= 0 # char, char16_t, char32_t
3375 // # (little endian char data in mangling)
3376 // ::= 1 # wchar_t (big endian char data in mangling)
David Majnemer58e5bee2014-03-24 21:43:36 +00003377 //
3378 // <literal-length> ::= <non-negative integer> # the length of the literal
3379 //
3380 // <encoded-crc> ::= <hex digit>+ @ # crc of the literal including
Hans Wennborg7525edc2018-07-06 06:54:16 +00003381 // # trailing null bytes
David Majnemer58e5bee2014-03-24 21:43:36 +00003382 //
3383 // <encoded-string> ::= <simple character> # uninteresting character
3384 // ::= '?$' <hex digit> <hex digit> # these two nibbles
3385 // # encode the byte for the
3386 // # character
3387 // ::= '?' [a-z] # \xe1 - \xfa
3388 // ::= '?' [A-Z] # \xc1 - \xda
3389 // ::= '?' [0-9] # [,/\:. \n\t'-]
3390 //
3391 // <literal> ::= '??_C@_' <char-type> <literal-length> <encoded-crc>
3392 // <encoded-string> '@'
3393 MicrosoftCXXNameMangler Mangler(*this, Out);
Reid Klecknerfb931542018-03-16 20:36:49 +00003394 Mangler.getStream() << "??_C@_";
David Majnemer58e5bee2014-03-24 21:43:36 +00003395
Hans Wennborg7525edc2018-07-06 06:54:16 +00003396 // The actual string length might be different from that of the string literal
3397 // in cases like:
3398 // char foo[3] = "foobar";
3399 // char bar[42] = "foobar";
3400 // Where it is truncated or zero-padded to fit the array. This is the length
3401 // used for mangling, and any trailing null-bytes also need to be mangled.
3402 unsigned StringLength = getASTContext()
3403 .getAsConstantArrayType(SL->getType())
3404 ->getSize()
3405 .getZExtValue();
3406 unsigned StringByteLength = StringLength * SL->getCharByteWidth();
3407
David Majnemer58e5bee2014-03-24 21:43:36 +00003408 // <char-type>: The "kind" of string literal is encoded into the mangled name.
David Majnemer98e77a22014-11-21 19:57:25 +00003409 if (SL->isWide())
David Majnemer58e5bee2014-03-24 21:43:36 +00003410 Mangler.getStream() << '1';
3411 else
David Majnemer98e77a22014-11-21 19:57:25 +00003412 Mangler.getStream() << '0';
David Majnemer58e5bee2014-03-24 21:43:36 +00003413
3414 // <literal-length>: The next part of the mangled name consists of the length
Hans Wennborg7525edc2018-07-06 06:54:16 +00003415 // of the string in bytes.
3416 Mangler.mangleNumber(StringByteLength);
David Majnemer58e5bee2014-03-24 21:43:36 +00003417
Malcolm Parsonsc6e45832017-01-13 18:55:32 +00003418 auto GetLittleEndianByte = [&SL](unsigned Index) {
David Majnemer4b293eb2014-03-31 17:18:53 +00003419 unsigned CharByteWidth = SL->getCharByteWidth();
Hans Wennborg7525edc2018-07-06 06:54:16 +00003420 if (Index / CharByteWidth >= SL->getLength())
3421 return static_cast<char>(0);
David Majnemer4b293eb2014-03-31 17:18:53 +00003422 uint32_t CodeUnit = SL->getCodeUnit(Index / CharByteWidth);
David Majnemere49c4b62014-03-31 21:46:05 +00003423 unsigned OffsetInCodeUnit = Index % CharByteWidth;
3424 return static_cast<char>((CodeUnit >> (8 * OffsetInCodeUnit)) & 0xff);
David Majnemer4b293eb2014-03-31 17:18:53 +00003425 };
3426
Malcolm Parsonsc6e45832017-01-13 18:55:32 +00003427 auto GetBigEndianByte = [&SL](unsigned Index) {
David Majnemer4b293eb2014-03-31 17:18:53 +00003428 unsigned CharByteWidth = SL->getCharByteWidth();
Hans Wennborg7525edc2018-07-06 06:54:16 +00003429 if (Index / CharByteWidth >= SL->getLength())
3430 return static_cast<char>(0);
David Majnemer4b293eb2014-03-31 17:18:53 +00003431 uint32_t CodeUnit = SL->getCodeUnit(Index / CharByteWidth);
David Majnemere49c4b62014-03-31 21:46:05 +00003432 unsigned OffsetInCodeUnit = (CharByteWidth - 1) - (Index % CharByteWidth);
3433 return static_cast<char>((CodeUnit >> (8 * OffsetInCodeUnit)) & 0xff);
David Majnemer4b293eb2014-03-31 17:18:53 +00003434 };
3435
David Majnemer58e5bee2014-03-24 21:43:36 +00003436 // CRC all the bytes of the StringLiteral.
David Majnemerb8ed3642015-09-01 21:24:07 +00003437 llvm::JamCRC JC;
Hans Wennborg7525edc2018-07-06 06:54:16 +00003438 for (unsigned I = 0, E = StringByteLength; I != E; ++I)
David Majnemerb8ed3642015-09-01 21:24:07 +00003439 JC.update(GetLittleEndianByte(I));
David Majnemer58e5bee2014-03-24 21:43:36 +00003440
David Majnemer58e5bee2014-03-24 21:43:36 +00003441 // <encoded-crc>: The CRC is encoded utilizing the standard number mangling
3442 // scheme.
David Majnemerb8ed3642015-09-01 21:24:07 +00003443 Mangler.mangleNumber(JC.getCRC());
David Majnemer58e5bee2014-03-24 21:43:36 +00003444
Nico Webera2d9c2b2018-07-02 12:31:20 +00003445 // <encoded-string>: The mangled name also contains the first 32 bytes
3446 // (including null-terminator bytes) of the encoded StringLiteral.
David Majnemer58e5bee2014-03-24 21:43:36 +00003447 // Each character is encoded by splitting them into bytes and then encoding
3448 // the constituent bytes.
3449 auto MangleByte = [&Mangler](char Byte) {
3450 // There are five different manglings for characters:
3451 // - [a-zA-Z0-9_$]: A one-to-one mapping.
3452 // - ?[a-z]: The range from \xe1 to \xfa.
3453 // - ?[A-Z]: The range from \xc1 to \xda.
3454 // - ?[0-9]: The set of [,/\:. \n\t'-].
3455 // - ?$XX: A fallback which maps nibbles.
David Majnemer10befcf2014-04-01 00:05:57 +00003456 if (isIdentifierBody(Byte, /*AllowDollar=*/true)) {
David Majnemer58e5bee2014-03-24 21:43:36 +00003457 Mangler.getStream() << Byte;
David Majnemer10befcf2014-04-01 00:05:57 +00003458 } else if (isLetter(Byte & 0x7f)) {
3459 Mangler.getStream() << '?' << static_cast<char>(Byte & 0x7f);
David Majnemer58e5bee2014-03-24 21:43:36 +00003460 } else {
David Majnemer07bc6112014-12-22 06:24:49 +00003461 const char SpecialChars[] = {',', '/', '\\', ':', '.',
3462 ' ', '\n', '\t', '\'', '-'};
Fangrui Song75e74e02019-03-31 08:48:19 +00003463 const char *Pos = llvm::find(SpecialChars, Byte);
David Majnemer07bc6112014-12-22 06:24:49 +00003464 if (Pos != std::end(SpecialChars)) {
3465 Mangler.getStream() << '?' << (Pos - std::begin(SpecialChars));
3466 } else {
3467 Mangler.getStream() << "?$";
3468 Mangler.getStream() << static_cast<char>('A' + ((Byte >> 4) & 0xf));
3469 Mangler.getStream() << static_cast<char>('A' + (Byte & 0xf));
David Majnemer58e5bee2014-03-24 21:43:36 +00003470 }
3471 }
3472 };
3473
Nico Webera2d9c2b2018-07-02 12:31:20 +00003474 // Enforce our 32 bytes max, except wchar_t which gets 32 chars instead.
3475 unsigned MaxBytesToMangle = SL->isWide() ? 64U : 32U;
Hans Wennborg7525edc2018-07-06 06:54:16 +00003476 unsigned NumBytesToMangle = std::min(MaxBytesToMangle, StringByteLength);
3477 for (unsigned I = 0; I != NumBytesToMangle; ++I) {
David Majnemer98e77a22014-11-21 19:57:25 +00003478 if (SL->isWide())
3479 MangleByte(GetBigEndianByte(I));
3480 else
3481 MangleByte(GetLittleEndianByte(I));
Hans Wennborg7525edc2018-07-06 06:54:16 +00003482 }
David Majnemer58e5bee2014-03-24 21:43:36 +00003483
3484 Mangler.getStream() << '@';
3485}
3486
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003487MicrosoftMangleContext *
3488MicrosoftMangleContext::create(ASTContext &Context, DiagnosticsEngine &Diags) {
3489 return new MicrosoftMangleContextImpl(Context, Diags);
Guy Benyei11169dd2012-12-18 14:30:41 +00003490}