blob: 479ac44aa0947f2191614041bb3bfdbec8708f8c [file] [log] [blame]
Guy Benyei11169dd2012-12-18 14:30:41 +00001//===--- MicrosoftMangle.cpp - Microsoft Visual C++ Name Mangling ---------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This provides C++ name mangling targeting the Microsoft Visual C++ ABI.
11//
12//===----------------------------------------------------------------------===//
13
14#include "clang/AST/Mangle.h"
15#include "clang/AST/ASTContext.h"
16#include "clang/AST/Attr.h"
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +000017#include "clang/AST/CXXInheritance.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000018#include "clang/AST/CharUnits.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000019#include "clang/AST/Decl.h"
20#include "clang/AST/DeclCXX.h"
21#include "clang/AST/DeclObjC.h"
Alexey Bataev94a4f0c2016-03-03 05:21:39 +000022#include "clang/AST/DeclOpenMP.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000023#include "clang/AST/DeclTemplate.h"
David Majnemer58e5bee2014-03-24 21:43:36 +000024#include "clang/AST/Expr.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000025#include "clang/AST/ExprCXX.h"
Reid Kleckner96f8f932014-02-05 17:27:08 +000026#include "clang/AST/VTableBuilder.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000027#include "clang/Basic/ABI.h"
28#include "clang/Basic/DiagnosticOptions.h"
Reid Kleckner369f3162013-05-14 20:30:42 +000029#include "clang/Basic/TargetInfo.h"
David Majnemer2206bf52014-03-05 08:57:59 +000030#include "llvm/ADT/StringExtras.h"
David Majnemerb8ed3642015-09-01 21:24:07 +000031#include "llvm/Support/JamCRC.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 Majnemerd5a42b82013-09-13 09:03:14 +000069/// \brief Retrieve the declaration context that should be used when mangling
70/// the given declaration.
71static const DeclContext *getEffectiveDeclContext(const Decl *D) {
72 // The ABI assumes that lambda closure types that occur within
73 // default arguments live in the context of the function. However, due to
74 // the way in which Clang parses and creates function declarations, this is
75 // not the case: the lambda closure type ends up living in the context
76 // where the function itself resides, because the function declaration itself
77 // had not yet been created. Fix the context here.
78 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
79 if (RD->isLambda())
80 if (ParmVarDecl *ContextParam =
81 dyn_cast_or_null<ParmVarDecl>(RD->getLambdaContextDecl()))
82 return ContextParam->getDeclContext();
83 }
84
85 // Perform the same check for block literals.
86 if (const BlockDecl *BD = dyn_cast<BlockDecl>(D)) {
87 if (ParmVarDecl *ContextParam =
88 dyn_cast_or_null<ParmVarDecl>(BD->getBlockManglingContextDecl()))
89 return ContextParam->getDeclContext();
90 }
91
92 const DeclContext *DC = D->getDeclContext();
Alexey Bataev94a4f0c2016-03-03 05:21:39 +000093 if (isa<CapturedDecl>(DC) || isa<OMPDeclareReductionDecl>(DC)) {
94 return getEffectiveDeclContext(cast<Decl>(DC));
95 }
David Majnemerd5a42b82013-09-13 09:03:14 +000096
David Majnemerb0f1dbd2016-05-19 18:15:53 +000097 return DC->getRedeclContext();
David Majnemerd5a42b82013-09-13 09:03:14 +000098}
99
100static const DeclContext *getEffectiveParentContext(const DeclContext *DC) {
101 return getEffectiveDeclContext(cast<Decl>(DC));
102}
103
David Majnemerdfa6d202015-03-11 18:36:39 +0000104static const FunctionDecl *getStructor(const NamedDecl *ND) {
105 if (const auto *FTD = dyn_cast<FunctionTemplateDecl>(ND))
106 return FTD->getTemplatedDecl();
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +0000107
David Majnemerdfa6d202015-03-11 18:36:39 +0000108 const auto *FD = cast<FunctionDecl>(ND);
109 if (const auto *FTD = FD->getPrimaryTemplate())
110 return FTD->getTemplatedDecl();
111
112 return FD;
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +0000113}
114
David Majnemer2206bf52014-03-05 08:57:59 +0000115static bool isLambda(const NamedDecl *ND) {
116 const CXXRecordDecl *Record = dyn_cast<CXXRecordDecl>(ND);
117 if (!Record)
118 return false;
Guy Benyei11169dd2012-12-18 14:30:41 +0000119
David Majnemer2206bf52014-03-05 08:57:59 +0000120 return Record->isLambda();
121}
Guy Benyei11169dd2012-12-18 14:30:41 +0000122
Timur Iskhodzhanov67455222013-10-03 06:26:13 +0000123/// MicrosoftMangleContextImpl - Overrides the default MangleContext for the
Guy Benyei11169dd2012-12-18 14:30:41 +0000124/// Microsoft Visual C++ ABI.
Timur Iskhodzhanov67455222013-10-03 06:26:13 +0000125class MicrosoftMangleContextImpl : public MicrosoftMangleContext {
David Majnemer2206bf52014-03-05 08:57:59 +0000126 typedef std::pair<const DeclContext *, IdentifierInfo *> DiscriminatorKeyTy;
127 llvm::DenseMap<DiscriminatorKeyTy, unsigned> Discriminator;
David Majnemer02e9af42014-04-23 05:16:51 +0000128 llvm::DenseMap<const NamedDecl *, unsigned> Uniquifier;
David Majnemerf017ec32014-03-05 10:35:06 +0000129 llvm::DenseMap<const CXXRecordDecl *, unsigned> LambdaIds;
Reid Kleckner1d59f992015-01-22 01:36:17 +0000130 llvm::DenseMap<const NamedDecl *, unsigned> SEHFilterIds;
Reid Klecknerebaf28d2015-04-14 20:59:00 +0000131 llvm::DenseMap<const NamedDecl *, unsigned> SEHFinallyIds;
David Majnemer2206bf52014-03-05 08:57:59 +0000132
Guy Benyei11169dd2012-12-18 14:30:41 +0000133public:
Timur Iskhodzhanov67455222013-10-03 06:26:13 +0000134 MicrosoftMangleContextImpl(ASTContext &Context, DiagnosticsEngine &Diags)
135 : MicrosoftMangleContext(Context, Diags) {}
Craig Toppercbce6e92014-03-11 06:22:39 +0000136 bool shouldMangleCXXName(const NamedDecl *D) override;
David Majnemer58e5bee2014-03-24 21:43:36 +0000137 bool shouldMangleStringLiteral(const StringLiteral *SL) override;
Craig Toppercbce6e92014-03-11 06:22:39 +0000138 void mangleCXXName(const NamedDecl *D, raw_ostream &Out) override;
David Majnemer02e9af42014-04-23 05:16:51 +0000139 void mangleVirtualMemPtrThunk(const CXXMethodDecl *MD,
140 raw_ostream &) 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.
203 if (isLambda(ND)) {
204 disc = 1;
205 return true;
206 }
207
David Majnemer2206bf52014-03-05 08:57:59 +0000208 // Use the canonical number for externally visible decls.
209 if (ND->isExternallyVisible()) {
210 disc = getASTContext().getManglingNumber(ND);
211 return true;
212 }
213
214 // Anonymous tags are already numbered.
215 if (const TagDecl *Tag = dyn_cast<TagDecl>(ND)) {
David Majnemerb33cd902015-09-02 15:50:38 +0000216 if (!Tag->hasNameForLinkage() &&
217 !getASTContext().getDeclaratorForUnnamedTagDecl(Tag) &&
218 !getASTContext().getTypedefNameForUnnamedTagDecl(Tag))
David Majnemer2206bf52014-03-05 08:57:59 +0000219 return false;
220 }
221
222 // Make up a reasonable number for internal decls.
223 unsigned &discriminator = Uniquifier[ND];
224 if (!discriminator)
225 discriminator = ++Discriminator[std::make_pair(DC, ND->getIdentifier())];
David Majnemer040fa342014-10-05 06:44:53 +0000226 disc = discriminator + 1;
David Majnemer2206bf52014-03-05 08:57:59 +0000227 return true;
228 }
Reid Kleckner1ece9fc2013-09-10 20:43:12 +0000229
David Majnemerf017ec32014-03-05 10:35:06 +0000230 unsigned getLambdaId(const CXXRecordDecl *RD) {
231 assert(RD->isLambda() && "RD must be a lambda!");
232 assert(!RD->isExternallyVisible() && "RD must not be visible!");
233 assert(RD->getLambdaManglingNumber() == 0 &&
234 "RD must not have a mangling number!");
235 std::pair<llvm::DenseMap<const CXXRecordDecl *, unsigned>::iterator, bool>
236 Result = LambdaIds.insert(std::make_pair(RD, LambdaIds.size()));
237 return Result.first->second;
238 }
239
Reid Kleckner1ece9fc2013-09-10 20:43:12 +0000240private:
David Majnemerfebb2722016-03-07 08:51:17 +0000241 void mangleInitFiniStub(const VarDecl *D, char CharCode, raw_ostream &Out);
Guy Benyei11169dd2012-12-18 14:30:41 +0000242};
243
David Majnemer2206bf52014-03-05 08:57:59 +0000244/// MicrosoftCXXNameMangler - Manage the mangling of a single name for the
245/// Microsoft Visual C++ ABI.
246class MicrosoftCXXNameMangler {
247 MicrosoftMangleContextImpl &Context;
248 raw_ostream &Out;
249
250 /// The "structor" is the top-level declaration being mangled, if
251 /// that's not a template specialization; otherwise it's the pattern
252 /// for that specialization.
253 const NamedDecl *Structor;
254 unsigned StructorType;
255
David Majnemer0d0560c2014-09-25 19:43:56 +0000256 typedef llvm::SmallVector<std::string, 10> BackRefVec;
257 BackRefVec NameBackReferences;
David Majnemer2206bf52014-03-05 08:57:59 +0000258
David Majnemer622abd12015-12-31 05:36:52 +0000259 typedef llvm::DenseMap<const void *, unsigned> ArgBackRefMap;
David Majnemer2206bf52014-03-05 08:57:59 +0000260 ArgBackRefMap TypeBackReferences;
261
David Majnemer5f177622015-12-30 05:13:03 +0000262 typedef std::set<int> PassObjectSizeArgsSet;
263 PassObjectSizeArgsSet PassObjectSizeArgs;
264
David Majnemer2206bf52014-03-05 08:57:59 +0000265 ASTContext &getASTContext() const { return Context.getASTContext(); }
266
267 // FIXME: If we add support for __ptr32/64 qualifiers, then we should push
268 // this check into mangleQualifiers().
269 const bool PointersAre64Bit;
270
271public:
272 enum QualifierMangleMode { QMM_Drop, QMM_Mangle, QMM_Escape, QMM_Result };
273
274 MicrosoftCXXNameMangler(MicrosoftMangleContextImpl &C, raw_ostream &Out_)
Craig Topper36250ad2014-05-12 05:36:57 +0000275 : Context(C), Out(Out_), Structor(nullptr), StructorType(-1),
David Majnemer02e9af42014-04-23 05:16:51 +0000276 PointersAre64Bit(C.getASTContext().getTargetInfo().getPointerWidth(0) ==
277 64) {}
David Majnemer2206bf52014-03-05 08:57:59 +0000278
279 MicrosoftCXXNameMangler(MicrosoftMangleContextImpl &C, raw_ostream &Out_,
David Majnemerdfa6d202015-03-11 18:36:39 +0000280 const CXXConstructorDecl *D, CXXCtorType Type)
281 : Context(C), Out(Out_), Structor(getStructor(D)), StructorType(Type),
282 PointersAre64Bit(C.getASTContext().getTargetInfo().getPointerWidth(0) ==
283 64) {}
284
285 MicrosoftCXXNameMangler(MicrosoftMangleContextImpl &C, raw_ostream &Out_,
David Majnemer2206bf52014-03-05 08:57:59 +0000286 const CXXDestructorDecl *D, CXXDtorType Type)
David Majnemer02e9af42014-04-23 05:16:51 +0000287 : Context(C), Out(Out_), Structor(getStructor(D)), StructorType(Type),
David Majnemer02e9af42014-04-23 05:16:51 +0000288 PointersAre64Bit(C.getASTContext().getTargetInfo().getPointerWidth(0) ==
289 64) {}
David Majnemer2206bf52014-03-05 08:57:59 +0000290
291 raw_ostream &getStream() const { return Out; }
292
293 void mangle(const NamedDecl *D, StringRef Prefix = "\01?");
294 void mangleName(const NamedDecl *ND);
David Majnemerab4b4a12015-05-18 00:05:25 +0000295 void mangleFunctionEncoding(const FunctionDecl *FD, bool ShouldMangle);
David Majnemer2206bf52014-03-05 08:57:59 +0000296 void mangleVariableEncoding(const VarDecl *VD);
297 void mangleMemberDataPointer(const CXXRecordDecl *RD, const ValueDecl *VD);
298 void mangleMemberFunctionPointer(const CXXRecordDecl *RD,
299 const CXXMethodDecl *MD);
300 void mangleVirtualMemPtrThunk(
301 const CXXMethodDecl *MD,
302 const MicrosoftVTableContext::MethodVFTableLocation &ML);
303 void mangleNumber(int64_t Number);
David Majnemer3add70b2015-12-29 11:45:53 +0000304 void mangleTagTypeKind(TagTypeKind TK);
305 void mangleArtificalTagType(TagTypeKind TK, StringRef UnqualifiedName,
306 ArrayRef<StringRef> NestedNames = None);
David Majnemer2206bf52014-03-05 08:57:59 +0000307 void mangleType(QualType T, SourceRange Range,
308 QualifierMangleMode QMM = QMM_Mangle);
Craig Topper36250ad2014-05-12 05:36:57 +0000309 void mangleFunctionType(const FunctionType *T,
310 const FunctionDecl *D = nullptr,
David Majnemer2f6a96e2014-08-12 17:53:10 +0000311 bool ForceThisQuals = false);
David Majnemer2206bf52014-03-05 08:57:59 +0000312 void mangleNestedName(const NamedDecl *ND);
313
314private:
David Majnemer2206bf52014-03-05 08:57:59 +0000315 void mangleUnqualifiedName(const NamedDecl *ND) {
316 mangleUnqualifiedName(ND, ND->getDeclName());
317 }
318 void mangleUnqualifiedName(const NamedDecl *ND, DeclarationName Name);
319 void mangleSourceName(StringRef Name);
320 void mangleOperatorName(OverloadedOperatorKind OO, SourceLocation Loc);
321 void mangleCXXDtorType(CXXDtorType T);
322 void mangleQualifiers(Qualifiers Quals, bool IsMember);
David Majnemere3785bb2014-04-23 05:16:56 +0000323 void mangleRefQualifier(RefQualifierKind RefQualifier);
David Majnemer2206bf52014-03-05 08:57:59 +0000324 void manglePointerCVQualifiers(Qualifiers Quals);
David Majnemer7a3ce0c2015-05-26 01:30:45 +0000325 void manglePointerExtQualifiers(Qualifiers Quals, QualType PointeeType);
David Majnemer2206bf52014-03-05 08:57:59 +0000326
327 void mangleUnscopedTemplateName(const TemplateDecl *ND);
David Majnemer02e9af42014-04-23 05:16:51 +0000328 void
329 mangleTemplateInstantiationName(const TemplateDecl *TD,
330 const TemplateArgumentList &TemplateArgs);
David Majnemer2206bf52014-03-05 08:57:59 +0000331 void mangleObjCMethodName(const ObjCMethodDecl *MD);
332
333 void mangleArgumentType(QualType T, SourceRange Range);
David Majnemer5f177622015-12-30 05:13:03 +0000334 void manglePassObjectSizeArg(const PassObjectSizeAttr *POSA);
David Majnemer2206bf52014-03-05 08:57:59 +0000335
336 // Declare manglers for every type class.
337#define ABSTRACT_TYPE(CLASS, PARENT)
338#define NON_CANONICAL_TYPE(CLASS, PARENT)
339#define TYPE(CLASS, PARENT) void mangleType(const CLASS##Type *T, \
David Majnemer7a3ce0c2015-05-26 01:30:45 +0000340 Qualifiers Quals, \
David Majnemer2206bf52014-03-05 08:57:59 +0000341 SourceRange Range);
342#include "clang/AST/TypeNodes.def"
343#undef ABSTRACT_TYPE
344#undef NON_CANONICAL_TYPE
345#undef TYPE
346
347 void mangleType(const TagDecl *TD);
348 void mangleDecayedArrayType(const ArrayType *T);
349 void mangleArrayType(const ArrayType *T);
350 void mangleFunctionClass(const FunctionDecl *FD);
David Majnemerdfa6d202015-03-11 18:36:39 +0000351 void mangleCallingConvention(CallingConv CC);
David Majnemer2206bf52014-03-05 08:57:59 +0000352 void mangleCallingConvention(const FunctionType *T);
353 void mangleIntegerLiteral(const llvm::APSInt &Number, bool IsBoolean);
354 void mangleExpression(const Expr *E);
355 void mangleThrowSpecification(const FunctionProtoType *T);
356
357 void mangleTemplateArgs(const TemplateDecl *TD,
358 const TemplateArgumentList &TemplateArgs);
David Majnemer57fbc0c2014-08-05 22:43:45 +0000359 void mangleTemplateArg(const TemplateDecl *TD, const TemplateArgument &TA,
360 const NamedDecl *Parm);
David Majnemer2206bf52014-03-05 08:57:59 +0000361};
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000362}
Guy Benyei11169dd2012-12-18 14:30:41 +0000363
Rafael Espindola002667c2013-10-16 01:40:34 +0000364bool MicrosoftMangleContextImpl::shouldMangleCXXName(const NamedDecl *D) {
David Majnemerd5a42b82013-09-13 09:03:14 +0000365 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
366 LanguageLinkage L = FD->getLanguageLinkage();
367 // Overloadable functions need mangling.
368 if (FD->hasAttr<OverloadableAttr>())
369 return true;
370
David Majnemerc729b0b2013-09-16 22:44:20 +0000371 // The ABI expects that we would never mangle "typical" user-defined entry
372 // points regardless of visibility or freestanding-ness.
373 //
374 // N.B. This is distinct from asking about "main". "main" has a lot of
375 // special rules associated with it in the standard while these
376 // user-defined entry points are outside of the purview of the standard.
377 // For example, there can be only one definition for "main" in a standards
378 // compliant program; however nothing forbids the existence of wmain and
379 // WinMain in the same translation unit.
380 if (FD->isMSVCRTEntryPoint())
David Majnemerd5a42b82013-09-13 09:03:14 +0000381 return false;
382
383 // C++ functions and those whose names are not a simple identifier need
384 // mangling.
385 if (!FD->getDeclName().isIdentifier() || L == CXXLanguageLinkage)
386 return true;
387
388 // C functions are not mangled.
389 if (L == CLanguageLinkage)
390 return false;
391 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000392
393 // Otherwise, no mangling is done outside C++ mode.
394 if (!getASTContext().getLangOpts().CPlusPlus)
395 return false;
396
Richard Smithda383632016-08-15 01:33:41 +0000397 const VarDecl *VD = dyn_cast<VarDecl>(D);
398 if (VD && !isa<DecompositionDecl>(D)) {
David Majnemerd5a42b82013-09-13 09:03:14 +0000399 // C variables are not mangled.
400 if (VD->isExternC())
401 return false;
402
403 // Variables at global scope with non-internal linkage are not mangled.
404 const DeclContext *DC = getEffectiveDeclContext(D);
405 // Check for extern variable declared locally.
406 if (DC->isFunctionOrMethod() && D->hasLinkage())
407 while (!DC->isNamespace() && !DC->isTranslationUnit())
408 DC = getEffectiveParentContext(DC);
409
410 if (DC->isTranslationUnit() && D->getFormalLinkage() == InternalLinkage &&
David Majnemeree6c4092015-10-22 07:15:56 +0000411 !isa<VarTemplateSpecializationDecl>(D) &&
412 D->getIdentifier() != nullptr)
Guy Benyei11169dd2012-12-18 14:30:41 +0000413 return false;
414 }
415
Guy Benyei11169dd2012-12-18 14:30:41 +0000416 return true;
417}
418
David Majnemer58e5bee2014-03-24 21:43:36 +0000419bool
420MicrosoftMangleContextImpl::shouldMangleStringLiteral(const StringLiteral *SL) {
David Majnemer6fc2d812014-11-22 06:20:38 +0000421 return true;
David Majnemer58e5bee2014-03-24 21:43:36 +0000422}
423
David Majnemer02e9af42014-04-23 05:16:51 +0000424void MicrosoftCXXNameMangler::mangle(const NamedDecl *D, StringRef Prefix) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000425 // MSVC doesn't mangle C++ names the same way it mangles extern "C" names.
426 // Therefore it's really important that we don't decorate the
427 // name with leading underscores or leading/trailing at signs. So, by
428 // default, we emit an asm marker at the start so we get the name right.
429 // Callers can override this with a custom prefix.
430
Guy Benyei11169dd2012-12-18 14:30:41 +0000431 // <mangled-name> ::= ? <name> <type-encoding>
432 Out << Prefix;
433 mangleName(D);
434 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
David Majnemerab4b4a12015-05-18 00:05:25 +0000435 mangleFunctionEncoding(FD, Context.shouldMangleDeclName(FD));
Guy Benyei11169dd2012-12-18 14:30:41 +0000436 else if (const VarDecl *VD = dyn_cast<VarDecl>(D))
437 mangleVariableEncoding(VD);
David Majnemer53b60a12015-12-29 22:02:10 +0000438 else
439 llvm_unreachable("Tried to mangle unexpected NamedDecl!");
Guy Benyei11169dd2012-12-18 14:30:41 +0000440}
441
David Majnemerab4b4a12015-05-18 00:05:25 +0000442void MicrosoftCXXNameMangler::mangleFunctionEncoding(const FunctionDecl *FD,
443 bool ShouldMangle) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000444 // <type-encoding> ::= <function-class> <function-type>
445
Reid Kleckner18da98e2013-06-24 19:21:52 +0000446 // Since MSVC operates on the type as written and not the canonical type, it
447 // actually matters which decl we have here. MSVC appears to choose the
448 // first, since it is most likely to be the declaration in a header file.
Rafael Espindola8db352d2013-10-17 15:37:26 +0000449 FD = FD->getFirstDecl();
Reid Kleckner18da98e2013-06-24 19:21:52 +0000450
Guy Benyei11169dd2012-12-18 14:30:41 +0000451 // We should never ever see a FunctionNoProtoType at this point.
452 // We don't even know how to mangle their types anyway :).
Reid Kleckner9a7f3e62013-10-08 00:58:57 +0000453 const FunctionProtoType *FT = FD->getType()->castAs<FunctionProtoType>();
Guy Benyei11169dd2012-12-18 14:30:41 +0000454
David Majnemerd5a42b82013-09-13 09:03:14 +0000455 // extern "C" functions can hold entities that must be mangled.
456 // As it stands, these functions still need to get expressed in the full
457 // external name. They have their class and type omitted, replaced with '9'.
David Majnemerab4b4a12015-05-18 00:05:25 +0000458 if (ShouldMangle) {
David Majnemer5a7cfea2015-05-18 00:05:29 +0000459 // We would like to mangle all extern "C" functions using this additional
460 // component but this would break compatibility with MSVC's behavior.
461 // Instead, do this when we know that compatibility isn't important (in
Eric Christopherbe528662015-12-16 23:10:46 +0000462 // other words, when it is an overloaded extern "C" function).
David Majnemer5a7cfea2015-05-18 00:05:29 +0000463 if (FD->isExternC() && FD->hasAttr<OverloadableAttr>())
464 Out << "$$J0";
465
David Majnemerd5a42b82013-09-13 09:03:14 +0000466 mangleFunctionClass(FD);
Guy Benyei11169dd2012-12-18 14:30:41 +0000467
Timur Iskhodzhanov555a7722013-10-04 11:25:05 +0000468 mangleFunctionType(FT, FD);
David Majnemerab4b4a12015-05-18 00:05:25 +0000469 } else {
David Majnemerd5a42b82013-09-13 09:03:14 +0000470 Out << '9';
David Majnemerab4b4a12015-05-18 00:05:25 +0000471 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000472}
473
474void MicrosoftCXXNameMangler::mangleVariableEncoding(const VarDecl *VD) {
475 // <type-encoding> ::= <storage-class> <variable-type>
476 // <storage-class> ::= 0 # private static member
477 // ::= 1 # protected static member
478 // ::= 2 # public static member
479 // ::= 3 # global
480 // ::= 4 # static local
David Majnemerb4119f72013-12-13 01:06:04 +0000481
Guy Benyei11169dd2012-12-18 14:30:41 +0000482 // The first character in the encoding (after the name) is the storage class.
483 if (VD->isStaticDataMember()) {
484 // If it's a static member, it also encodes the access level.
485 switch (VD->getAccess()) {
486 default:
487 case AS_private: Out << '0'; break;
488 case AS_protected: Out << '1'; break;
489 case AS_public: Out << '2'; break;
490 }
491 }
492 else if (!VD->isStaticLocal())
493 Out << '3';
494 else
495 Out << '4';
496 // Now mangle the type.
497 // <variable-type> ::= <type> <cvr-qualifiers>
498 // ::= <type> <pointee-cvr-qualifiers> # pointers, references
499 // Pointers and references are odd. The type of 'int * const foo;' gets
500 // mangled as 'QAHA' instead of 'PAHB', for example.
Zachary Turner87422d92014-06-25 05:37:25 +0000501 SourceRange SR = VD->getSourceRange();
David Majnemerb9a5f2d2014-01-21 20:33:36 +0000502 QualType Ty = VD->getType();
David Majnemer6dda7bb2013-08-15 08:13:23 +0000503 if (Ty->isPointerType() || Ty->isReferenceType() ||
504 Ty->isMemberPointerType()) {
Zachary Turner87422d92014-06-25 05:37:25 +0000505 mangleType(Ty, SR, QMM_Drop);
David Majnemer8eec58f2014-02-18 14:20:10 +0000506 manglePointerExtQualifiers(
David Majnemer7a3ce0c2015-05-26 01:30:45 +0000507 Ty.getDesugaredType(getASTContext()).getLocalQualifiers(), QualType());
David Majnemer6dda7bb2013-08-15 08:13:23 +0000508 if (const MemberPointerType *MPT = Ty->getAs<MemberPointerType>()) {
509 mangleQualifiers(MPT->getPointeeType().getQualifiers(), true);
510 // Member pointers are suffixed with a back reference to the member
511 // pointer's class name.
512 mangleName(MPT->getClass()->getAsCXXRecordDecl());
513 } else
514 mangleQualifiers(Ty->getPointeeType().getQualifiers(), false);
David Majnemera2724ae2013-08-09 05:56:24 +0000515 } else if (const ArrayType *AT = getASTContext().getAsArrayType(Ty)) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000516 // Global arrays are funny, too.
David Majnemer5a1b2042013-09-11 04:44:30 +0000517 mangleDecayedArrayType(AT);
Peter Collingbourne2816c022013-04-25 04:25:40 +0000518 if (AT->getElementType()->isArrayType())
519 Out << 'A';
520 else
521 mangleQualifiers(Ty.getQualifiers(), false);
Guy Benyei11169dd2012-12-18 14:30:41 +0000522 } else {
Zachary Turner87422d92014-06-25 05:37:25 +0000523 mangleType(Ty, SR, QMM_Drop);
Will Wilson5f383672014-11-05 13:54:21 +0000524 mangleQualifiers(Ty.getQualifiers(), false);
Guy Benyei11169dd2012-12-18 14:30:41 +0000525 }
526}
527
Reid Kleckner96f8f932014-02-05 17:27:08 +0000528void MicrosoftCXXNameMangler::mangleMemberDataPointer(const CXXRecordDecl *RD,
David Majnemer1e378e42014-02-06 12:46:52 +0000529 const ValueDecl *VD) {
Reid Kleckner96f8f932014-02-05 17:27:08 +0000530 // <member-data-pointer> ::= <integer-literal>
531 // ::= $F <number> <number>
532 // ::= $G <number> <number> <number>
533
David Majnemer763584d2014-02-06 10:59:19 +0000534 int64_t FieldOffset;
535 int64_t VBTableOffset;
Reid Kleckner96f8f932014-02-05 17:27:08 +0000536 MSInheritanceAttr::Spelling IM = RD->getMSInheritanceModel();
David Majnemer1e378e42014-02-06 12:46:52 +0000537 if (VD) {
538 FieldOffset = getASTContext().getFieldOffset(VD);
David Majnemer763584d2014-02-06 10:59:19 +0000539 assert(FieldOffset % getASTContext().getCharWidth() == 0 &&
Reid Kleckner96f8f932014-02-05 17:27:08 +0000540 "cannot take address of bitfield");
David Majnemer763584d2014-02-06 10:59:19 +0000541 FieldOffset /= getASTContext().getCharWidth();
542
543 VBTableOffset = 0;
David Majnemer08ef2ba2015-06-23 20:34:18 +0000544
545 if (IM == MSInheritanceAttr::Keyword_virtual_inheritance)
546 FieldOffset -= getASTContext().getOffsetOfBaseWithVBPtr(RD).getQuantity();
David Majnemer763584d2014-02-06 10:59:19 +0000547 } else {
548 FieldOffset = RD->nullFieldOffsetIsZero() ? 0 : -1;
549
550 VBTableOffset = -1;
Reid Kleckner96f8f932014-02-05 17:27:08 +0000551 }
552
David Majnemer763584d2014-02-06 10:59:19 +0000553 char Code = '\0';
Reid Kleckner96f8f932014-02-05 17:27:08 +0000554 switch (IM) {
David Majnemer763584d2014-02-06 10:59:19 +0000555 case MSInheritanceAttr::Keyword_single_inheritance: Code = '0'; break;
556 case MSInheritanceAttr::Keyword_multiple_inheritance: Code = '0'; break;
557 case MSInheritanceAttr::Keyword_virtual_inheritance: Code = 'F'; break;
558 case MSInheritanceAttr::Keyword_unspecified_inheritance: Code = 'G'; break;
Reid Kleckner96f8f932014-02-05 17:27:08 +0000559 }
560
David Majnemer763584d2014-02-06 10:59:19 +0000561 Out << '$' << Code;
Reid Kleckner96f8f932014-02-05 17:27:08 +0000562
David Majnemer763584d2014-02-06 10:59:19 +0000563 mangleNumber(FieldOffset);
564
Reid Klecknerbf94e6e2014-04-07 18:07:03 +0000565 // The C++ standard doesn't allow base-to-derived member pointer conversions
566 // in template parameter contexts, so the vbptr offset of data member pointers
567 // is always zero.
David Majnemer763584d2014-02-06 10:59:19 +0000568 if (MSInheritanceAttr::hasVBPtrOffsetField(IM))
Reid Kleckner96f8f932014-02-05 17:27:08 +0000569 mangleNumber(0);
David Majnemer763584d2014-02-06 10:59:19 +0000570 if (MSInheritanceAttr::hasVBTableOffsetField(IM))
571 mangleNumber(VBTableOffset);
Reid Kleckner96f8f932014-02-05 17:27:08 +0000572}
573
574void
575MicrosoftCXXNameMangler::mangleMemberFunctionPointer(const CXXRecordDecl *RD,
576 const CXXMethodDecl *MD) {
577 // <member-function-pointer> ::= $1? <name>
578 // ::= $H? <name> <number>
579 // ::= $I? <name> <number> <number>
580 // ::= $J? <name> <number> <number> <number>
Reid Kleckner96f8f932014-02-05 17:27:08 +0000581
582 MSInheritanceAttr::Spelling IM = RD->getMSInheritanceModel();
583
Reid Kleckner96f8f932014-02-05 17:27:08 +0000584 char Code = '\0';
585 switch (IM) {
586 case MSInheritanceAttr::Keyword_single_inheritance: Code = '1'; break;
587 case MSInheritanceAttr::Keyword_multiple_inheritance: Code = 'H'; break;
588 case MSInheritanceAttr::Keyword_virtual_inheritance: Code = 'I'; break;
589 case MSInheritanceAttr::Keyword_unspecified_inheritance: Code = 'J'; break;
590 }
591
Reid Kleckner96f8f932014-02-05 17:27:08 +0000592 // If non-virtual, mangle the name. If virtual, mangle as a virtual memptr
593 // thunk.
594 uint64_t NVOffset = 0;
595 uint64_t VBTableOffset = 0;
Reid Klecknerbf94e6e2014-04-07 18:07:03 +0000596 uint64_t VBPtrOffset = 0;
David Majnemer6a729c62014-06-11 04:55:08 +0000597 if (MD) {
598 Out << '$' << Code << '?';
599 if (MD->isVirtual()) {
600 MicrosoftVTableContext *VTContext =
601 cast<MicrosoftVTableContext>(getASTContext().getVTableContext());
602 const MicrosoftVTableContext::MethodVFTableLocation &ML =
603 VTContext->getMethodVFTableLocation(GlobalDecl(MD));
604 mangleVirtualMemPtrThunk(MD, ML);
605 NVOffset = ML.VFPtrOffset.getQuantity();
606 VBTableOffset = ML.VBTableIndex * 4;
607 if (ML.VBase) {
608 const ASTRecordLayout &Layout = getASTContext().getASTRecordLayout(RD);
609 VBPtrOffset = Layout.getVBPtrOffset().getQuantity();
610 }
611 } else {
612 mangleName(MD);
David Majnemerab4b4a12015-05-18 00:05:25 +0000613 mangleFunctionEncoding(MD, /*ShouldMangle=*/true);
Reid Kleckner96f8f932014-02-05 17:27:08 +0000614 }
David Majnemer08ef2ba2015-06-23 20:34:18 +0000615
616 if (VBTableOffset == 0 &&
617 IM == MSInheritanceAttr::Keyword_virtual_inheritance)
618 NVOffset -= getASTContext().getOffsetOfBaseWithVBPtr(RD).getQuantity();
Reid Kleckner96f8f932014-02-05 17:27:08 +0000619 } else {
David Majnemer6a729c62014-06-11 04:55:08 +0000620 // Null single inheritance member functions are encoded as a simple nullptr.
621 if (IM == MSInheritanceAttr::Keyword_single_inheritance) {
622 Out << "$0A@";
623 return;
624 }
625 if (IM == MSInheritanceAttr::Keyword_unspecified_inheritance)
626 VBTableOffset = -1;
627 Out << '$' << Code;
Reid Kleckner96f8f932014-02-05 17:27:08 +0000628 }
629
630 if (MSInheritanceAttr::hasNVOffsetField(/*IsMemberFunction=*/true, IM))
David Majnemer08ef2ba2015-06-23 20:34:18 +0000631 mangleNumber(static_cast<uint32_t>(NVOffset));
Reid Kleckner96f8f932014-02-05 17:27:08 +0000632 if (MSInheritanceAttr::hasVBPtrOffsetField(IM))
Reid Klecknerbf94e6e2014-04-07 18:07:03 +0000633 mangleNumber(VBPtrOffset);
Reid Kleckner96f8f932014-02-05 17:27:08 +0000634 if (MSInheritanceAttr::hasVBTableOffsetField(IM))
635 mangleNumber(VBTableOffset);
636}
637
638void MicrosoftCXXNameMangler::mangleVirtualMemPtrThunk(
639 const CXXMethodDecl *MD,
640 const MicrosoftVTableContext::MethodVFTableLocation &ML) {
641 // Get the vftable offset.
642 CharUnits PointerWidth = getASTContext().toCharUnitsFromBits(
643 getASTContext().getTargetInfo().getPointerWidth(0));
644 uint64_t OffsetInVFTable = ML.Index * PointerWidth.getQuantity();
645
646 Out << "?_9";
647 mangleName(MD->getParent());
648 Out << "$B";
649 mangleNumber(OffsetInVFTable);
650 Out << 'A';
David Majnemerbc02d322015-03-14 06:34:41 +0000651 mangleCallingConvention(MD->getType()->getAs<FunctionProtoType>());
Reid Kleckner96f8f932014-02-05 17:27:08 +0000652}
653
Guy Benyei11169dd2012-12-18 14:30:41 +0000654void MicrosoftCXXNameMangler::mangleName(const NamedDecl *ND) {
655 // <name> ::= <unscoped-name> {[<named-scope>]+ | [<nested-name>]}? @
Guy Benyei11169dd2012-12-18 14:30:41 +0000656
657 // Always start with the unqualified name.
David Majnemerb4119f72013-12-13 01:06:04 +0000658 mangleUnqualifiedName(ND);
Guy Benyei11169dd2012-12-18 14:30:41 +0000659
David Majnemer2206bf52014-03-05 08:57:59 +0000660 mangleNestedName(ND);
Guy Benyei11169dd2012-12-18 14:30:41 +0000661
662 // Terminate the whole name with an '@'.
663 Out << '@';
664}
665
David Majnemer2a816452013-12-09 10:44:32 +0000666void MicrosoftCXXNameMangler::mangleNumber(int64_t Number) {
667 // <non-negative integer> ::= A@ # when Number == 0
668 // ::= <decimal digit> # when 1 <= Number <= 10
669 // ::= <hex digit>+ @ # when Number >= 10
670 //
671 // <number> ::= [?] <non-negative integer>
Guy Benyei11169dd2012-12-18 14:30:41 +0000672
David Majnemer2a816452013-12-09 10:44:32 +0000673 uint64_t Value = static_cast<uint64_t>(Number);
674 if (Number < 0) {
675 Value = -Value;
Guy Benyei11169dd2012-12-18 14:30:41 +0000676 Out << '?';
Guy Benyei11169dd2012-12-18 14:30:41 +0000677 }
David Majnemer2a816452013-12-09 10:44:32 +0000678
679 if (Value == 0)
680 Out << "A@";
681 else if (Value >= 1 && Value <= 10)
682 Out << (Value - 1);
683 else {
684 // Numbers that are not encoded as decimal digits are represented as nibbles
685 // in the range of ASCII characters 'A' to 'P'.
686 // The number 0x123450 would be encoded as 'BCDEFA'
687 char EncodedNumberBuffer[sizeof(uint64_t) * 2];
Craig Toppere3d2ecbe2014-06-28 23:22:33 +0000688 MutableArrayRef<char> BufferRef(EncodedNumberBuffer);
689 MutableArrayRef<char>::reverse_iterator I = BufferRef.rbegin();
David Majnemer2a816452013-12-09 10:44:32 +0000690 for (; Value != 0; Value >>= 4)
691 *I++ = 'A' + (Value & 0xf);
692 Out.write(I.base(), I - BufferRef.rbegin());
Guy Benyei11169dd2012-12-18 14:30:41 +0000693 Out << '@';
694 }
695}
696
697static const TemplateDecl *
Reid Kleckner52518862013-03-20 01:40:23 +0000698isTemplate(const NamedDecl *ND, const TemplateArgumentList *&TemplateArgs) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000699 // Check if we have a function template.
David Majnemer02e9af42014-04-23 05:16:51 +0000700 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000701 if (const TemplateDecl *TD = FD->getPrimaryTemplate()) {
Reid Kleckner52518862013-03-20 01:40:23 +0000702 TemplateArgs = FD->getTemplateSpecializationArgs();
Guy Benyei11169dd2012-12-18 14:30:41 +0000703 return TD;
704 }
705 }
706
707 // Check if we have a class template.
708 if (const ClassTemplateSpecializationDecl *Spec =
David Majnemer02e9af42014-04-23 05:16:51 +0000709 dyn_cast<ClassTemplateSpecializationDecl>(ND)) {
Reid Kleckner52518862013-03-20 01:40:23 +0000710 TemplateArgs = &Spec->getTemplateArgs();
Guy Benyei11169dd2012-12-18 14:30:41 +0000711 return Spec->getSpecializedTemplate();
712 }
713
David Majnemer8f774532014-03-04 05:38:05 +0000714 // Check if we have a variable template.
715 if (const VarTemplateSpecializationDecl *Spec =
716 dyn_cast<VarTemplateSpecializationDecl>(ND)) {
717 TemplateArgs = &Spec->getTemplateArgs();
718 return Spec->getSpecializedTemplate();
719 }
720
Craig Topper36250ad2014-05-12 05:36:57 +0000721 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +0000722}
723
David Majnemer02e9af42014-04-23 05:16:51 +0000724void MicrosoftCXXNameMangler::mangleUnqualifiedName(const NamedDecl *ND,
725 DeclarationName Name) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000726 // <unqualified-name> ::= <operator-name>
727 // ::= <ctor-dtor-name>
728 // ::= <source-name>
729 // ::= <template-name>
Reid Kleckner52518862013-03-20 01:40:23 +0000730
Guy Benyei11169dd2012-12-18 14:30:41 +0000731 // Check if we have a template.
Craig Topper36250ad2014-05-12 05:36:57 +0000732 const TemplateArgumentList *TemplateArgs = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +0000733 if (const TemplateDecl *TD = isTemplate(ND, TemplateArgs)) {
Reid Klecknerc16c4472013-07-13 00:43:39 +0000734 // Function templates aren't considered for name back referencing. This
735 // makes sense since function templates aren't likely to occur multiple
736 // times in a symbol.
David Majnemer56e2adb2015-12-30 05:40:32 +0000737 if (isa<FunctionTemplateDecl>(TD)) {
Reid Klecknerc16c4472013-07-13 00:43:39 +0000738 mangleTemplateInstantiationName(TD, *TemplateArgs);
Reid Kleckner11c6f612014-06-26 22:42:18 +0000739 Out << '@';
Reid Klecknerc16c4472013-07-13 00:43:39 +0000740 return;
741 }
742
Guy Benyei11169dd2012-12-18 14:30:41 +0000743 // Here comes the tricky thing: if we need to mangle something like
744 // void foo(A::X<Y>, B::X<Y>),
745 // the X<Y> part is aliased. However, if you need to mangle
746 // void foo(A::X<A::Y>, A::X<B::Y>),
747 // the A::X<> part is not aliased.
748 // That said, from the mangler's perspective we have a structure like this:
749 // namespace[s] -> type[ -> template-parameters]
750 // but from the Clang perspective we have
751 // type [ -> template-parameters]
752 // \-> namespace[s]
753 // What we do is we create a new mangler, mangle the same type (without
David Majnemerc986fcc2014-06-08 04:51:13 +0000754 // a namespace suffix) to a string using the extra mangler and then use
755 // the mangled type name as a key to check the mangling of different types
756 // for aliasing.
Guy Benyei11169dd2012-12-18 14:30:41 +0000757
Reid Kleckner11c6f612014-06-26 22:42:18 +0000758 llvm::SmallString<64> TemplateMangling;
759 llvm::raw_svector_ostream Stream(TemplateMangling);
David Majnemerc986fcc2014-06-08 04:51:13 +0000760 MicrosoftCXXNameMangler Extra(Context, Stream);
761 Extra.mangleTemplateInstantiationName(TD, *TemplateArgs);
Guy Benyei11169dd2012-12-18 14:30:41 +0000762
Reid Kleckner11c6f612014-06-26 22:42:18 +0000763 mangleSourceName(TemplateMangling);
Guy Benyei11169dd2012-12-18 14:30:41 +0000764 return;
765 }
766
767 switch (Name.getNameKind()) {
768 case DeclarationName::Identifier: {
769 if (const IdentifierInfo *II = Name.getAsIdentifierInfo()) {
David Majnemer956bc112013-11-25 17:50:19 +0000770 mangleSourceName(II->getName());
Guy Benyei11169dd2012-12-18 14:30:41 +0000771 break;
772 }
David Majnemerb4119f72013-12-13 01:06:04 +0000773
Guy Benyei11169dd2012-12-18 14:30:41 +0000774 // Otherwise, an anonymous entity. We must have a declaration.
775 assert(ND && "mangling empty name without declaration");
David Majnemerb4119f72013-12-13 01:06:04 +0000776
Guy Benyei11169dd2012-12-18 14:30:41 +0000777 if (const NamespaceDecl *NS = dyn_cast<NamespaceDecl>(ND)) {
778 if (NS->isAnonymousNamespace()) {
779 Out << "?A@";
780 break;
781 }
782 }
David Majnemerb4119f72013-12-13 01:06:04 +0000783
Richard Smithda383632016-08-15 01:33:41 +0000784 if (const DecompositionDecl *DD = dyn_cast<DecompositionDecl>(ND)) {
785 // FIXME: Invented mangling for decomposition declarations:
786 // [X,Y,Z]
787 // where X,Y,Z are the names of the bindings.
788 llvm::SmallString<128> Name("[");
789 for (auto *BD : DD->bindings()) {
790 if (Name.size() > 1)
791 Name += ',';
792 Name += BD->getDeclName().getAsIdentifierInfo()->getName();
793 }
794 Name += ']';
795 mangleSourceName(Name);
796 break;
797 }
798
David Majnemer2206bf52014-03-05 08:57:59 +0000799 if (const VarDecl *VD = dyn_cast<VarDecl>(ND)) {
800 // We must have an anonymous union or struct declaration.
801 const CXXRecordDecl *RD = VD->getType()->getAsCXXRecordDecl();
802 assert(RD && "expected variable decl to have a record type");
803 // Anonymous types with no tag or typedef get the name of their
804 // declarator mangled in. If they have no declarator, number them with
805 // a $S prefix.
806 llvm::SmallString<64> Name("$S");
807 // Get a unique id for the anonymous struct.
808 Name += llvm::utostr(Context.getAnonymousStructId(RD) + 1);
809 mangleSourceName(Name.str());
810 break;
811 }
812
Guy Benyei11169dd2012-12-18 14:30:41 +0000813 // We must have an anonymous struct.
814 const TagDecl *TD = cast<TagDecl>(ND);
815 if (const TypedefNameDecl *D = TD->getTypedefNameForAnonDecl()) {
816 assert(TD->getDeclContext() == D->getDeclContext() &&
817 "Typedef should not be in another decl context!");
818 assert(D->getDeclName().getAsIdentifierInfo() &&
819 "Typedef was not named!");
David Majnemer956bc112013-11-25 17:50:19 +0000820 mangleSourceName(D->getDeclName().getAsIdentifierInfo()->getName());
Guy Benyei11169dd2012-12-18 14:30:41 +0000821 break;
822 }
823
David Majnemerf017ec32014-03-05 10:35:06 +0000824 if (const CXXRecordDecl *Record = dyn_cast<CXXRecordDecl>(TD)) {
825 if (Record->isLambda()) {
826 llvm::SmallString<10> Name("<lambda_");
827 unsigned LambdaId;
828 if (Record->getLambdaManglingNumber())
829 LambdaId = Record->getLambdaManglingNumber();
830 else
831 LambdaId = Context.getLambdaId(Record);
832
833 Name += llvm::utostr(LambdaId);
834 Name += ">";
835
836 mangleSourceName(Name);
837 break;
838 }
839 }
840
David Majnemer2206bf52014-03-05 08:57:59 +0000841 llvm::SmallString<64> Name("<unnamed-type-");
David Majnemer00350522015-08-31 18:48:39 +0000842 if (DeclaratorDecl *DD =
843 Context.getASTContext().getDeclaratorForUnnamedTagDecl(TD)) {
844 // Anonymous types without a name for linkage purposes have their
David Majnemer2206bf52014-03-05 08:57:59 +0000845 // declarator mangled in if they have one.
David Majnemer00350522015-08-31 18:48:39 +0000846 Name += DD->getName();
847 } else if (TypedefNameDecl *TND =
848 Context.getASTContext().getTypedefNameForUnnamedTagDecl(
849 TD)) {
850 // Anonymous types without a name for linkage purposes have their
851 // associate typedef mangled in if they have one.
852 Name += TND->getName();
David Majnemer956bc112013-11-25 17:50:19 +0000853 } else {
David Majnemer2206bf52014-03-05 08:57:59 +0000854 // Otherwise, number the types using a $S prefix.
855 Name += "$S";
David Majnemeree6c4092015-10-22 07:15:56 +0000856 Name += llvm::utostr(Context.getAnonymousStructId(TD) + 1);
David Majnemer956bc112013-11-25 17:50:19 +0000857 }
David Majnemer2206bf52014-03-05 08:57:59 +0000858 Name += ">";
859 mangleSourceName(Name.str());
Guy Benyei11169dd2012-12-18 14:30:41 +0000860 break;
861 }
David Majnemerb4119f72013-12-13 01:06:04 +0000862
Guy Benyei11169dd2012-12-18 14:30:41 +0000863 case DeclarationName::ObjCZeroArgSelector:
864 case DeclarationName::ObjCOneArgSelector:
865 case DeclarationName::ObjCMultiArgSelector:
866 llvm_unreachable("Can't mangle Objective-C selector names here!");
David Majnemerb4119f72013-12-13 01:06:04 +0000867
Guy Benyei11169dd2012-12-18 14:30:41 +0000868 case DeclarationName::CXXConstructorName:
David Majnemerdfa6d202015-03-11 18:36:39 +0000869 if (Structor == getStructor(ND)) {
870 if (StructorType == Ctor_CopyingClosure) {
871 Out << "?_O";
872 return;
873 }
874 if (StructorType == Ctor_DefaultClosure) {
875 Out << "?_F";
876 return;
877 }
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000878 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000879 Out << "?0";
David Majnemerdfa6d202015-03-11 18:36:39 +0000880 return;
David Majnemerb4119f72013-12-13 01:06:04 +0000881
Guy Benyei11169dd2012-12-18 14:30:41 +0000882 case DeclarationName::CXXDestructorName:
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +0000883 if (ND == Structor)
884 // If the named decl is the C++ destructor we're mangling,
885 // use the type we were given.
886 mangleCXXDtorType(static_cast<CXXDtorType>(StructorType));
887 else
Reid Klecknere7de47e2013-07-22 13:51:44 +0000888 // Otherwise, use the base destructor name. This is relevant if a
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +0000889 // class with a destructor is declared within a destructor.
Reid Klecknere7de47e2013-07-22 13:51:44 +0000890 mangleCXXDtorType(Dtor_Base);
Guy Benyei11169dd2012-12-18 14:30:41 +0000891 break;
David Majnemerb4119f72013-12-13 01:06:04 +0000892
Guy Benyei11169dd2012-12-18 14:30:41 +0000893 case DeclarationName::CXXConversionFunctionName:
894 // <operator-name> ::= ?B # (cast)
895 // The target type is encoded as the return type.
896 Out << "?B";
897 break;
David Majnemerb4119f72013-12-13 01:06:04 +0000898
Guy Benyei11169dd2012-12-18 14:30:41 +0000899 case DeclarationName::CXXOperatorName:
900 mangleOperatorName(Name.getCXXOverloadedOperator(), ND->getLocation());
901 break;
David Majnemerb4119f72013-12-13 01:06:04 +0000902
Guy Benyei11169dd2012-12-18 14:30:41 +0000903 case DeclarationName::CXXLiteralOperatorName: {
David Majnemere31a3ed2014-06-04 16:46:26 +0000904 Out << "?__K";
905 mangleSourceName(Name.getCXXLiteralIdentifier()->getName());
Guy Benyei11169dd2012-12-18 14:30:41 +0000906 break;
907 }
David Majnemerb4119f72013-12-13 01:06:04 +0000908
Guy Benyei11169dd2012-12-18 14:30:41 +0000909 case DeclarationName::CXXUsingDirective:
910 llvm_unreachable("Can't mangle a using directive name!");
911 }
912}
913
David Majnemer2206bf52014-03-05 08:57:59 +0000914void MicrosoftCXXNameMangler::mangleNestedName(const NamedDecl *ND) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000915 // <postfix> ::= <unqualified-name> [<postfix>]
916 // ::= <substitution> [<postfix>]
David Majnemerff9075f2014-08-06 03:12:47 +0000917 const DeclContext *DC = getEffectiveDeclContext(ND);
Guy Benyei11169dd2012-12-18 14:30:41 +0000918
David Majnemer2206bf52014-03-05 08:57:59 +0000919 while (!DC->isTranslationUnit()) {
920 if (isa<TagDecl>(ND) || isa<VarDecl>(ND)) {
921 unsigned Disc;
922 if (Context.getNextDiscriminator(ND, Disc)) {
923 Out << '?';
924 mangleNumber(Disc);
925 Out << '?';
926 }
927 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000928
David Majnemer2206bf52014-03-05 08:57:59 +0000929 if (const BlockDecl *BD = dyn_cast<BlockDecl>(DC)) {
Alp Tokerc7dc0622014-05-11 22:10:52 +0000930 DiagnosticsEngine &Diags = Context.getDiags();
David Majnemer2206bf52014-03-05 08:57:59 +0000931 unsigned DiagID =
932 Diags.getCustomDiagID(DiagnosticsEngine::Error,
933 "cannot mangle a local inside this block yet");
934 Diags.Report(BD->getLocation(), DiagID);
935
936 // FIXME: This is completely, utterly, wrong; see ItaniumMangle
937 // for how this should be done.
938 Out << "__block_invoke" << Context.getBlockId(BD, false);
939 Out << '@';
940 continue;
941 } else if (const ObjCMethodDecl *Method = dyn_cast<ObjCMethodDecl>(DC)) {
942 mangleObjCMethodName(Method);
943 } else if (isa<NamedDecl>(DC)) {
944 ND = cast<NamedDecl>(DC);
945 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)) {
946 mangle(FD, "?");
947 break;
948 } else
949 mangleUnqualifiedName(ND);
950 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000951 DC = DC->getParent();
Guy Benyei11169dd2012-12-18 14:30:41 +0000952 }
953}
954
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +0000955void MicrosoftCXXNameMangler::mangleCXXDtorType(CXXDtorType T) {
Reid Klecknere7de47e2013-07-22 13:51:44 +0000956 // Microsoft uses the names on the case labels for these dtor variants. Clang
957 // uses the Itanium terminology internally. Everything in this ABI delegates
958 // towards the base dtor.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +0000959 switch (T) {
Reid Klecknere7de47e2013-07-22 13:51:44 +0000960 // <operator-name> ::= ?1 # destructor
961 case Dtor_Base: Out << "?1"; return;
962 // <operator-name> ::= ?_D # vbase destructor
963 case Dtor_Complete: Out << "?_D"; return;
964 // <operator-name> ::= ?_G # scalar deleting destructor
965 case Dtor_Deleting: Out << "?_G"; return;
966 // <operator-name> ::= ?_E # vector deleting destructor
967 // FIXME: Add a vector deleting dtor type. It goes in the vtable, so we need
968 // it.
Rafael Espindola1e4df922014-09-16 15:18:21 +0000969 case Dtor_Comdat:
970 llvm_unreachable("not expecting a COMDAT");
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +0000971 }
972 llvm_unreachable("Unsupported dtor type?");
973}
974
Guy Benyei11169dd2012-12-18 14:30:41 +0000975void MicrosoftCXXNameMangler::mangleOperatorName(OverloadedOperatorKind OO,
976 SourceLocation Loc) {
977 switch (OO) {
978 // ?0 # constructor
979 // ?1 # destructor
980 // <operator-name> ::= ?2 # new
981 case OO_New: Out << "?2"; break;
982 // <operator-name> ::= ?3 # delete
983 case OO_Delete: Out << "?3"; break;
984 // <operator-name> ::= ?4 # =
985 case OO_Equal: Out << "?4"; break;
986 // <operator-name> ::= ?5 # >>
987 case OO_GreaterGreater: Out << "?5"; break;
988 // <operator-name> ::= ?6 # <<
989 case OO_LessLess: Out << "?6"; break;
990 // <operator-name> ::= ?7 # !
991 case OO_Exclaim: Out << "?7"; break;
992 // <operator-name> ::= ?8 # ==
993 case OO_EqualEqual: Out << "?8"; break;
994 // <operator-name> ::= ?9 # !=
995 case OO_ExclaimEqual: Out << "?9"; break;
996 // <operator-name> ::= ?A # []
997 case OO_Subscript: Out << "?A"; break;
998 // ?B # conversion
999 // <operator-name> ::= ?C # ->
1000 case OO_Arrow: Out << "?C"; break;
1001 // <operator-name> ::= ?D # *
1002 case OO_Star: Out << "?D"; break;
1003 // <operator-name> ::= ?E # ++
1004 case OO_PlusPlus: Out << "?E"; break;
1005 // <operator-name> ::= ?F # --
1006 case OO_MinusMinus: Out << "?F"; break;
1007 // <operator-name> ::= ?G # -
1008 case OO_Minus: Out << "?G"; break;
1009 // <operator-name> ::= ?H # +
1010 case OO_Plus: Out << "?H"; break;
1011 // <operator-name> ::= ?I # &
1012 case OO_Amp: Out << "?I"; break;
1013 // <operator-name> ::= ?J # ->*
1014 case OO_ArrowStar: Out << "?J"; break;
1015 // <operator-name> ::= ?K # /
1016 case OO_Slash: Out << "?K"; break;
1017 // <operator-name> ::= ?L # %
1018 case OO_Percent: Out << "?L"; break;
1019 // <operator-name> ::= ?M # <
1020 case OO_Less: Out << "?M"; break;
1021 // <operator-name> ::= ?N # <=
1022 case OO_LessEqual: Out << "?N"; break;
1023 // <operator-name> ::= ?O # >
1024 case OO_Greater: Out << "?O"; break;
1025 // <operator-name> ::= ?P # >=
1026 case OO_GreaterEqual: Out << "?P"; break;
1027 // <operator-name> ::= ?Q # ,
1028 case OO_Comma: Out << "?Q"; break;
1029 // <operator-name> ::= ?R # ()
1030 case OO_Call: Out << "?R"; break;
1031 // <operator-name> ::= ?S # ~
1032 case OO_Tilde: Out << "?S"; break;
1033 // <operator-name> ::= ?T # ^
1034 case OO_Caret: Out << "?T"; break;
1035 // <operator-name> ::= ?U # |
1036 case OO_Pipe: Out << "?U"; break;
1037 // <operator-name> ::= ?V # &&
1038 case OO_AmpAmp: Out << "?V"; break;
1039 // <operator-name> ::= ?W # ||
1040 case OO_PipePipe: Out << "?W"; break;
1041 // <operator-name> ::= ?X # *=
1042 case OO_StarEqual: Out << "?X"; break;
1043 // <operator-name> ::= ?Y # +=
1044 case OO_PlusEqual: Out << "?Y"; break;
1045 // <operator-name> ::= ?Z # -=
1046 case OO_MinusEqual: Out << "?Z"; break;
1047 // <operator-name> ::= ?_0 # /=
1048 case OO_SlashEqual: Out << "?_0"; break;
1049 // <operator-name> ::= ?_1 # %=
1050 case OO_PercentEqual: Out << "?_1"; break;
1051 // <operator-name> ::= ?_2 # >>=
1052 case OO_GreaterGreaterEqual: Out << "?_2"; break;
1053 // <operator-name> ::= ?_3 # <<=
1054 case OO_LessLessEqual: Out << "?_3"; break;
1055 // <operator-name> ::= ?_4 # &=
1056 case OO_AmpEqual: Out << "?_4"; break;
1057 // <operator-name> ::= ?_5 # |=
1058 case OO_PipeEqual: Out << "?_5"; break;
1059 // <operator-name> ::= ?_6 # ^=
1060 case OO_CaretEqual: Out << "?_6"; break;
1061 // ?_7 # vftable
1062 // ?_8 # vbtable
1063 // ?_9 # vcall
1064 // ?_A # typeof
1065 // ?_B # local static guard
1066 // ?_C # string
1067 // ?_D # vbase destructor
1068 // ?_E # vector deleting destructor
1069 // ?_F # default constructor closure
1070 // ?_G # scalar deleting destructor
1071 // ?_H # vector constructor iterator
1072 // ?_I # vector destructor iterator
1073 // ?_J # vector vbase constructor iterator
1074 // ?_K # virtual displacement map
1075 // ?_L # eh vector constructor iterator
1076 // ?_M # eh vector destructor iterator
1077 // ?_N # eh vector vbase constructor iterator
1078 // ?_O # copy constructor closure
1079 // ?_P<name> # udt returning <name>
1080 // ?_Q # <unknown>
1081 // ?_R0 # RTTI Type Descriptor
1082 // ?_R1 # RTTI Base Class Descriptor at (a,b,c,d)
1083 // ?_R2 # RTTI Base Class Array
1084 // ?_R3 # RTTI Class Hierarchy Descriptor
1085 // ?_R4 # RTTI Complete Object Locator
1086 // ?_S # local vftable
1087 // ?_T # local vftable constructor closure
1088 // <operator-name> ::= ?_U # new[]
1089 case OO_Array_New: Out << "?_U"; break;
1090 // <operator-name> ::= ?_V # delete[]
1091 case OO_Array_Delete: Out << "?_V"; break;
David Majnemerb4119f72013-12-13 01:06:04 +00001092
Guy Benyei11169dd2012-12-18 14:30:41 +00001093 case OO_Conditional: {
1094 DiagnosticsEngine &Diags = Context.getDiags();
1095 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
1096 "cannot mangle this conditional operator yet");
1097 Diags.Report(Loc, DiagID);
1098 break;
1099 }
David Majnemerb4119f72013-12-13 01:06:04 +00001100
Richard Smith9be594e2015-10-22 05:12:22 +00001101 case OO_Coawait: {
1102 DiagnosticsEngine &Diags = Context.getDiags();
1103 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
1104 "cannot mangle this operator co_await yet");
1105 Diags.Report(Loc, DiagID);
1106 break;
1107 }
1108
Guy Benyei11169dd2012-12-18 14:30:41 +00001109 case OO_None:
1110 case NUM_OVERLOADED_OPERATORS:
1111 llvm_unreachable("Not an overloaded operator");
1112 }
1113}
1114
David Majnemer956bc112013-11-25 17:50:19 +00001115void MicrosoftCXXNameMangler::mangleSourceName(StringRef Name) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001116 // <source name> ::= <identifier> @
David Majnemer0d0560c2014-09-25 19:43:56 +00001117 BackRefVec::iterator Found =
1118 std::find(NameBackReferences.begin(), NameBackReferences.end(), Name);
David Majnemerc986fcc2014-06-08 04:51:13 +00001119 if (Found == NameBackReferences.end()) {
David Majnemer0d0560c2014-09-25 19:43:56 +00001120 if (NameBackReferences.size() < 10)
1121 NameBackReferences.push_back(Name);
David Majnemer956bc112013-11-25 17:50:19 +00001122 Out << Name << '@';
Guy Benyei11169dd2012-12-18 14:30:41 +00001123 } else {
David Majnemer0d0560c2014-09-25 19:43:56 +00001124 Out << (Found - NameBackReferences.begin());
Guy Benyei11169dd2012-12-18 14:30:41 +00001125 }
1126}
1127
1128void MicrosoftCXXNameMangler::mangleObjCMethodName(const ObjCMethodDecl *MD) {
1129 Context.mangleObjCMethodName(MD, Out);
1130}
1131
Guy Benyei11169dd2012-12-18 14:30:41 +00001132void MicrosoftCXXNameMangler::mangleTemplateInstantiationName(
David Majnemer02e9af42014-04-23 05:16:51 +00001133 const TemplateDecl *TD, const TemplateArgumentList &TemplateArgs) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001134 // <template-name> ::= <unscoped-template-name> <template-args>
1135 // ::= <substitution>
1136 // Always start with the unqualified name.
1137
1138 // Templates have their own context for back references.
1139 ArgBackRefMap OuterArgsContext;
David Majnemer0d0560c2014-09-25 19:43:56 +00001140 BackRefVec OuterTemplateContext;
David Majnemer5f177622015-12-30 05:13:03 +00001141 PassObjectSizeArgsSet OuterPassObjectSizeArgs;
Guy Benyei11169dd2012-12-18 14:30:41 +00001142 NameBackReferences.swap(OuterTemplateContext);
1143 TypeBackReferences.swap(OuterArgsContext);
David Majnemer5f177622015-12-30 05:13:03 +00001144 PassObjectSizeArgs.swap(OuterPassObjectSizeArgs);
Guy Benyei11169dd2012-12-18 14:30:41 +00001145
1146 mangleUnscopedTemplateName(TD);
Reid Kleckner52518862013-03-20 01:40:23 +00001147 mangleTemplateArgs(TD, TemplateArgs);
Guy Benyei11169dd2012-12-18 14:30:41 +00001148
1149 // Restore the previous back reference contexts.
1150 NameBackReferences.swap(OuterTemplateContext);
1151 TypeBackReferences.swap(OuterArgsContext);
David Majnemer5f177622015-12-30 05:13:03 +00001152 PassObjectSizeArgs.swap(OuterPassObjectSizeArgs);
Guy Benyei11169dd2012-12-18 14:30:41 +00001153}
1154
1155void
1156MicrosoftCXXNameMangler::mangleUnscopedTemplateName(const TemplateDecl *TD) {
1157 // <unscoped-template-name> ::= ?$ <unqualified-name>
1158 Out << "?$";
1159 mangleUnqualifiedName(TD);
1160}
1161
David Majnemer02e9af42014-04-23 05:16:51 +00001162void MicrosoftCXXNameMangler::mangleIntegerLiteral(const llvm::APSInt &Value,
1163 bool IsBoolean) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001164 // <integer-literal> ::= $0 <number>
1165 Out << "$0";
1166 // Make sure booleans are encoded as 0/1.
1167 if (IsBoolean && Value.getBoolValue())
1168 mangleNumber(1);
Will Wilsone74c2812014-12-11 05:47:10 +00001169 else if (Value.isSigned())
David Majnemer2a816452013-12-09 10:44:32 +00001170 mangleNumber(Value.getSExtValue());
Will Wilsone74c2812014-12-11 05:47:10 +00001171 else
1172 mangleNumber(Value.getZExtValue());
Guy Benyei11169dd2012-12-18 14:30:41 +00001173}
1174
David Majnemer02e9af42014-04-23 05:16:51 +00001175void MicrosoftCXXNameMangler::mangleExpression(const Expr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001176 // See if this is a constant expression.
1177 llvm::APSInt Value;
1178 if (E->isIntegerConstantExpr(Value, Context.getASTContext())) {
1179 mangleIntegerLiteral(Value, E->getType()->isBooleanType());
1180 return;
1181 }
1182
Reid Klecknerb4848e72014-06-10 20:06:25 +00001183 // Look through no-op casts like template parameter substitutions.
1184 E = E->IgnoreParenNoopCasts(Context.getASTContext());
1185
Craig Topper36250ad2014-05-12 05:36:57 +00001186 const CXXUuidofExpr *UE = nullptr;
David Majnemer8eaab6f2013-08-13 06:32:20 +00001187 if (const UnaryOperator *UO = dyn_cast<UnaryOperator>(E)) {
1188 if (UO->getOpcode() == UO_AddrOf)
1189 UE = dyn_cast<CXXUuidofExpr>(UO->getSubExpr());
1190 } else
1191 UE = dyn_cast<CXXUuidofExpr>(E);
1192
1193 if (UE) {
David Majnemere9cab2f2013-08-13 09:17:25 +00001194 // If we had to peek through an address-of operator, treat this like we are
David Majnemer8eaab6f2013-08-13 06:32:20 +00001195 // dealing with a pointer type. Otherwise, treat it like a const reference.
1196 //
1197 // N.B. This matches up with the handling of TemplateArgument::Declaration
1198 // in mangleTemplateArg
1199 if (UE == E)
1200 Out << "$E?";
1201 else
1202 Out << "$1?";
David Majnemer3add70b2015-12-29 11:45:53 +00001203
1204 // This CXXUuidofExpr is mangled as-if it were actually a VarDecl from
1205 // const __s_GUID _GUID_{lower case UUID with underscores}
David Majnemer2041b462016-03-28 03:19:50 +00001206 StringRef Uuid = UE->getUuidStr();
David Majnemer3add70b2015-12-29 11:45:53 +00001207 std::string Name = "_GUID_" + Uuid.lower();
1208 std::replace(Name.begin(), Name.end(), '-', '_');
1209
1210 mangleSourceName(Name);
1211 // Terminate the whole name with an '@'.
1212 Out << '@';
1213 // It's a global variable.
1214 Out << '3';
1215 // It's a struct called __s_GUID.
1216 mangleArtificalTagType(TTK_Struct, "__s_GUID");
1217 // It's const.
1218 Out << 'B';
David Majnemer8eaab6f2013-08-13 06:32:20 +00001219 return;
1220 }
1221
Guy Benyei11169dd2012-12-18 14:30:41 +00001222 // As bad as this diagnostic is, it's better than crashing.
1223 DiagnosticsEngine &Diags = Context.getDiags();
David Majnemer02e9af42014-04-23 05:16:51 +00001224 unsigned DiagID = Diags.getCustomDiagID(
1225 DiagnosticsEngine::Error, "cannot yet mangle expression type %0");
1226 Diags.Report(E->getExprLoc(), DiagID) << E->getStmtClassName()
1227 << E->getSourceRange();
Guy Benyei11169dd2012-12-18 14:30:41 +00001228}
1229
David Majnemer8265dec2014-03-30 16:30:54 +00001230void MicrosoftCXXNameMangler::mangleTemplateArgs(
1231 const TemplateDecl *TD, const TemplateArgumentList &TemplateArgs) {
Reid Kleckner11c6f612014-06-26 22:42:18 +00001232 // <template-args> ::= <template-arg>+
David Majnemer57fbc0c2014-08-05 22:43:45 +00001233 const TemplateParameterList *TPL = TD->getTemplateParameters();
1234 assert(TPL->size() == TemplateArgs.size() &&
1235 "size mismatch between args and parms!");
1236
1237 unsigned Idx = 0;
David Majnemer8265dec2014-03-30 16:30:54 +00001238 for (const TemplateArgument &TA : TemplateArgs.asArray())
David Majnemer57fbc0c2014-08-05 22:43:45 +00001239 mangleTemplateArg(TD, TA, TPL->getParam(Idx++));
Guy Benyei11169dd2012-12-18 14:30:41 +00001240}
1241
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001242void MicrosoftCXXNameMangler::mangleTemplateArg(const TemplateDecl *TD,
David Majnemer57fbc0c2014-08-05 22:43:45 +00001243 const TemplateArgument &TA,
1244 const NamedDecl *Parm) {
Reid Kleckner96f8f932014-02-05 17:27:08 +00001245 // <template-arg> ::= <type>
1246 // ::= <integer-literal>
1247 // ::= <member-data-pointer>
1248 // ::= <member-function-pointer>
1249 // ::= $E? <name> <type-encoding>
1250 // ::= $1? <name> <type-encoding>
1251 // ::= $0A@
1252 // ::= <template-args>
1253
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001254 switch (TA.getKind()) {
1255 case TemplateArgument::Null:
1256 llvm_unreachable("Can't mangle null template arguments!");
David Majnemer08177c52013-08-27 08:21:25 +00001257 case TemplateArgument::TemplateExpansion:
1258 llvm_unreachable("Can't mangle template expansion arguments!");
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001259 case TemplateArgument::Type: {
1260 QualType T = TA.getAsType();
1261 mangleType(T, SourceRange(), QMM_Escape);
1262 break;
1263 }
David Majnemere8fdc062013-08-13 01:25:35 +00001264 case TemplateArgument::Declaration: {
1265 const NamedDecl *ND = cast<NamedDecl>(TA.getAsDecl());
David Majnemer1e378e42014-02-06 12:46:52 +00001266 if (isa<FieldDecl>(ND) || isa<IndirectFieldDecl>(ND)) {
Reid Klecknere253b092014-02-08 01:15:37 +00001267 mangleMemberDataPointer(
1268 cast<CXXRecordDecl>(ND->getDeclContext())->getMostRecentDecl(),
1269 cast<ValueDecl>(ND));
Reid Kleckner09b47d12014-02-05 18:59:38 +00001270 } else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)) {
Nick Lewycky1f529662014-02-05 23:53:29 +00001271 const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD);
David Majnemerab4b4a12015-05-18 00:05:25 +00001272 if (MD && MD->isInstance()) {
Reid Klecknere253b092014-02-08 01:15:37 +00001273 mangleMemberFunctionPointer(MD->getParent()->getMostRecentDecl(), MD);
David Majnemerab4b4a12015-05-18 00:05:25 +00001274 } else {
1275 Out << "$1?";
1276 mangleName(FD);
1277 mangleFunctionEncoding(FD, /*ShouldMangle=*/true);
1278 }
Reid Kleckner09b47d12014-02-05 18:59:38 +00001279 } else {
David Blaikie952a9b12014-10-17 18:00:12 +00001280 mangle(ND, TA.getParamTypeForDecl()->isReferenceType() ? "$E?" : "$1?");
Reid Kleckner09b47d12014-02-05 18:59:38 +00001281 }
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001282 break;
David Majnemere8fdc062013-08-13 01:25:35 +00001283 }
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001284 case TemplateArgument::Integral:
1285 mangleIntegerLiteral(TA.getAsIntegral(),
1286 TA.getIntegralType()->isBooleanType());
1287 break;
Reid Kleckner96f8f932014-02-05 17:27:08 +00001288 case TemplateArgument::NullPtr: {
1289 QualType T = TA.getNullPtrType();
1290 if (const MemberPointerType *MPT = T->getAs<MemberPointerType>()) {
David Majnemer763584d2014-02-06 10:59:19 +00001291 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
David Majnemerf3027172015-12-01 19:13:51 +00001292 if (MPT->isMemberFunctionPointerType() &&
1293 !isa<FunctionTemplateDecl>(TD)) {
Craig Topper36250ad2014-05-12 05:36:57 +00001294 mangleMemberFunctionPointer(RD, nullptr);
David Majnemer19187872014-06-11 07:08:37 +00001295 return;
1296 }
1297 if (MPT->isMemberDataPointer()) {
David Majnemerf3027172015-12-01 19:13:51 +00001298 if (!isa<FunctionTemplateDecl>(TD)) {
David Majnemer10236682015-07-02 09:43:11 +00001299 mangleMemberDataPointer(RD, nullptr);
1300 return;
1301 }
1302 // nullptr data pointers are always represented with a single field
1303 // which is initialized with either 0 or -1. Why -1? Well, we need to
1304 // distinguish the case where the data member is at offset zero in the
1305 // record.
1306 // However, we are free to use 0 *if* we would use multiple fields for
1307 // non-nullptr member pointers.
1308 if (!RD->nullFieldOffsetIsZero()) {
1309 mangleIntegerLiteral(llvm::APSInt::get(-1), /*IsBoolean=*/false);
1310 return;
1311 }
David Majnemer19187872014-06-11 07:08:37 +00001312 }
Reid Kleckner96f8f932014-02-05 17:27:08 +00001313 }
David Majnemer10236682015-07-02 09:43:11 +00001314 mangleIntegerLiteral(llvm::APSInt::getUnsigned(0), /*IsBoolean=*/false);
David Majnemerae465ef2013-08-05 21:33:59 +00001315 break;
Reid Kleckner96f8f932014-02-05 17:27:08 +00001316 }
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001317 case TemplateArgument::Expression:
1318 mangleExpression(TA.getAsExpr());
1319 break;
David Majnemer06fa05a2014-06-04 16:46:32 +00001320 case TemplateArgument::Pack: {
Craig Topper00bbdcf2014-06-28 23:22:23 +00001321 ArrayRef<TemplateArgument> TemplateArgs = TA.getPackAsArray();
David Majnemer06fa05a2014-06-04 16:46:32 +00001322 if (TemplateArgs.empty()) {
David Majnemer57fbc0c2014-08-05 22:43:45 +00001323 if (isa<TemplateTypeParmDecl>(Parm) ||
1324 isa<TemplateTemplateParmDecl>(Parm))
David Majnemer4deaac72015-03-18 03:56:27 +00001325 // MSVC 2015 changed the mangling for empty expanded template packs,
1326 // use the old mangling for link compatibility for old versions.
David Majnemerb710a932015-05-11 03:57:49 +00001327 Out << (Context.getASTContext().getLangOpts().isCompatibleWithMSVC(
1328 LangOptions::MSVC2015)
David Majnemer4deaac72015-03-18 03:56:27 +00001329 ? "$$V"
1330 : "$$$V");
David Majnemer57fbc0c2014-08-05 22:43:45 +00001331 else if (isa<NonTypeTemplateParmDecl>(Parm))
1332 Out << "$S";
1333 else
1334 llvm_unreachable("unexpected template parameter decl!");
David Majnemer06fa05a2014-06-04 16:46:32 +00001335 } else {
1336 for (const TemplateArgument &PA : TemplateArgs)
David Majnemer57fbc0c2014-08-05 22:43:45 +00001337 mangleTemplateArg(TD, PA, Parm);
David Majnemer06fa05a2014-06-04 16:46:32 +00001338 }
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001339 break;
David Majnemer06fa05a2014-06-04 16:46:32 +00001340 }
David Majnemer8d5f9ab2014-07-30 08:20:03 +00001341 case TemplateArgument::Template: {
1342 const NamedDecl *ND =
1343 TA.getAsTemplate().getAsTemplateDecl()->getTemplatedDecl();
1344 if (const auto *TD = dyn_cast<TagDecl>(ND)) {
1345 mangleType(TD);
1346 } else if (isa<TypeAliasDecl>(ND)) {
David Majnemer9a3bc592014-08-19 07:29:03 +00001347 Out << "$$Y";
1348 mangleName(ND);
David Majnemer8d5f9ab2014-07-30 08:20:03 +00001349 } else {
1350 llvm_unreachable("unexpected template template NamedDecl!");
1351 }
David Majnemer0db0ca42013-08-05 22:26:46 +00001352 break;
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001353 }
David Majnemer8d5f9ab2014-07-30 08:20:03 +00001354 }
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001355}
1356
Guy Benyei11169dd2012-12-18 14:30:41 +00001357void MicrosoftCXXNameMangler::mangleQualifiers(Qualifiers Quals,
1358 bool IsMember) {
1359 // <cvr-qualifiers> ::= [E] [F] [I] <base-cvr-qualifiers>
1360 // 'E' means __ptr64 (32-bit only); 'F' means __unaligned (32/64-bit only);
1361 // 'I' means __restrict (32/64-bit).
1362 // Note that the MSVC __restrict keyword isn't the same as the C99 restrict
1363 // keyword!
1364 // <base-cvr-qualifiers> ::= A # near
1365 // ::= B # near const
1366 // ::= C # near volatile
1367 // ::= D # near const volatile
1368 // ::= E # far (16-bit)
1369 // ::= F # far const (16-bit)
1370 // ::= G # far volatile (16-bit)
1371 // ::= H # far const volatile (16-bit)
1372 // ::= I # huge (16-bit)
1373 // ::= J # huge const (16-bit)
1374 // ::= K # huge volatile (16-bit)
1375 // ::= L # huge const volatile (16-bit)
1376 // ::= M <basis> # based
1377 // ::= N <basis> # based const
1378 // ::= O <basis> # based volatile
1379 // ::= P <basis> # based const volatile
1380 // ::= Q # near member
1381 // ::= R # near const member
1382 // ::= S # near volatile member
1383 // ::= T # near const volatile member
1384 // ::= U # far member (16-bit)
1385 // ::= V # far const member (16-bit)
1386 // ::= W # far volatile member (16-bit)
1387 // ::= X # far const volatile member (16-bit)
1388 // ::= Y # huge member (16-bit)
1389 // ::= Z # huge const member (16-bit)
1390 // ::= 0 # huge volatile member (16-bit)
1391 // ::= 1 # huge const volatile member (16-bit)
1392 // ::= 2 <basis> # based member
1393 // ::= 3 <basis> # based const member
1394 // ::= 4 <basis> # based volatile member
1395 // ::= 5 <basis> # based const volatile member
1396 // ::= 6 # near function (pointers only)
1397 // ::= 7 # far function (pointers only)
1398 // ::= 8 # near method (pointers only)
1399 // ::= 9 # far method (pointers only)
1400 // ::= _A <basis> # based function (pointers only)
1401 // ::= _B <basis> # based function (far?) (pointers only)
1402 // ::= _C <basis> # based method (pointers only)
1403 // ::= _D <basis> # based method (far?) (pointers only)
1404 // ::= _E # block (Clang)
1405 // <basis> ::= 0 # __based(void)
1406 // ::= 1 # __based(segment)?
1407 // ::= 2 <name> # __based(name)
1408 // ::= 3 # ?
1409 // ::= 4 # ?
1410 // ::= 5 # not really based
1411 bool HasConst = Quals.hasConst(),
1412 HasVolatile = Quals.hasVolatile();
David Majnemer89594f32013-08-05 22:43:06 +00001413
Guy Benyei11169dd2012-12-18 14:30:41 +00001414 if (!IsMember) {
1415 if (HasConst && HasVolatile) {
1416 Out << 'D';
1417 } else if (HasVolatile) {
1418 Out << 'C';
1419 } else if (HasConst) {
1420 Out << 'B';
1421 } else {
1422 Out << 'A';
1423 }
1424 } else {
1425 if (HasConst && HasVolatile) {
1426 Out << 'T';
1427 } else if (HasVolatile) {
1428 Out << 'S';
1429 } else if (HasConst) {
1430 Out << 'R';
1431 } else {
1432 Out << 'Q';
1433 }
1434 }
1435
1436 // FIXME: For now, just drop all extension qualifiers on the floor.
1437}
1438
David Majnemer8eec58f2014-02-18 14:20:10 +00001439void
David Majnemere3785bb2014-04-23 05:16:56 +00001440MicrosoftCXXNameMangler::mangleRefQualifier(RefQualifierKind RefQualifier) {
1441 // <ref-qualifier> ::= G # lvalue reference
1442 // ::= H # rvalue-reference
1443 switch (RefQualifier) {
1444 case RQ_None:
1445 break;
1446
1447 case RQ_LValue:
1448 Out << 'G';
1449 break;
1450
1451 case RQ_RValue:
1452 Out << 'H';
1453 break;
1454 }
1455}
1456
David Majnemer7a3ce0c2015-05-26 01:30:45 +00001457void MicrosoftCXXNameMangler::manglePointerExtQualifiers(Qualifiers Quals,
1458 QualType PointeeType) {
David Majnemer8eec58f2014-02-18 14:20:10 +00001459 bool HasRestrict = Quals.hasRestrict();
David Majnemer7a3ce0c2015-05-26 01:30:45 +00001460 if (PointersAre64Bit &&
1461 (PointeeType.isNull() || !PointeeType->isFunctionType()))
David Majnemer8eec58f2014-02-18 14:20:10 +00001462 Out << 'E';
1463
1464 if (HasRestrict)
1465 Out << 'I';
Andrey Bokhanko45d41322016-05-11 18:38:21 +00001466
Andrey Bokhanko67a41862016-05-26 10:06:01 +00001467 if (Quals.hasUnaligned() ||
1468 (!PointeeType.isNull() && PointeeType.getLocalQualifiers().hasUnaligned()))
Andrey Bokhanko45d41322016-05-11 18:38:21 +00001469 Out << 'F';
David Majnemer8eec58f2014-02-18 14:20:10 +00001470}
1471
1472void MicrosoftCXXNameMangler::manglePointerCVQualifiers(Qualifiers Quals) {
1473 // <pointer-cv-qualifiers> ::= P # no qualifiers
1474 // ::= Q # const
1475 // ::= R # volatile
1476 // ::= S # const volatile
Guy Benyei11169dd2012-12-18 14:30:41 +00001477 bool HasConst = Quals.hasConst(),
David Majnemer8eec58f2014-02-18 14:20:10 +00001478 HasVolatile = Quals.hasVolatile();
David Majnemer0b6bf8a2014-02-18 12:58:35 +00001479
Guy Benyei11169dd2012-12-18 14:30:41 +00001480 if (HasConst && HasVolatile) {
1481 Out << 'S';
1482 } else if (HasVolatile) {
1483 Out << 'R';
1484 } else if (HasConst) {
1485 Out << 'Q';
1486 } else {
1487 Out << 'P';
1488 }
1489}
1490
1491void MicrosoftCXXNameMangler::mangleArgumentType(QualType T,
1492 SourceRange Range) {
Reid Kleckner18da98e2013-06-24 19:21:52 +00001493 // MSVC will backreference two canonically equivalent types that have slightly
1494 // different manglings when mangled alone.
David Majnemer5a1b2042013-09-11 04:44:30 +00001495
1496 // Decayed types do not match up with non-decayed versions of the same type.
1497 //
1498 // e.g.
1499 // void (*x)(void) will not form a backreference with void x(void)
1500 void *TypePtr;
David Majnemer96183f62015-04-23 05:21:20 +00001501 if (const auto *DT = T->getAs<DecayedType>()) {
1502 QualType OriginalType = DT->getOriginalType();
David Majnemerbdc1fed2015-04-27 03:07:47 +00001503 // All decayed ArrayTypes should be treated identically; as-if they were
1504 // a decayed IncompleteArrayType.
1505 if (const auto *AT = getASTContext().getAsArrayType(OriginalType))
David Majnemer96183f62015-04-23 05:21:20 +00001506 OriginalType = getASTContext().getIncompleteArrayType(
David Majnemerbdc1fed2015-04-27 03:07:47 +00001507 AT->getElementType(), AT->getSizeModifier(),
1508 AT->getIndexTypeCVRQualifiers());
David Majnemer96183f62015-04-23 05:21:20 +00001509
1510 TypePtr = OriginalType.getCanonicalType().getAsOpaquePtr();
David Majnemer5a1b2042013-09-11 04:44:30 +00001511 // If the original parameter was textually written as an array,
1512 // instead treat the decayed parameter like it's const.
1513 //
1514 // e.g.
1515 // int [] -> int * const
David Majnemer96183f62015-04-23 05:21:20 +00001516 if (OriginalType->isArrayType())
David Majnemer5a1b2042013-09-11 04:44:30 +00001517 T = T.withConst();
David Majnemer96183f62015-04-23 05:21:20 +00001518 } else {
David Majnemer5a1b2042013-09-11 04:44:30 +00001519 TypePtr = T.getCanonicalType().getAsOpaquePtr();
David Majnemer96183f62015-04-23 05:21:20 +00001520 }
David Majnemer5a1b2042013-09-11 04:44:30 +00001521
Guy Benyei11169dd2012-12-18 14:30:41 +00001522 ArgBackRefMap::iterator Found = TypeBackReferences.find(TypePtr);
1523
1524 if (Found == TypeBackReferences.end()) {
Yaron Keren2155f802015-05-02 15:31:08 +00001525 size_t OutSizeBefore = Out.tell();
Guy Benyei11169dd2012-12-18 14:30:41 +00001526
David Majnemer5a1b2042013-09-11 04:44:30 +00001527 mangleType(T, Range, QMM_Drop);
Guy Benyei11169dd2012-12-18 14:30:41 +00001528
1529 // See if it's worth creating a back reference.
1530 // Only types longer than 1 character are considered
1531 // and only 10 back references slots are available:
Yaron Keren2155f802015-05-02 15:31:08 +00001532 bool LongerThanOneChar = (Out.tell() - OutSizeBefore > 1);
Guy Benyei11169dd2012-12-18 14:30:41 +00001533 if (LongerThanOneChar && TypeBackReferences.size() < 10) {
1534 size_t Size = TypeBackReferences.size();
1535 TypeBackReferences[TypePtr] = Size;
1536 }
1537 } else {
1538 Out << Found->second;
1539 }
1540}
1541
David Majnemer5f177622015-12-30 05:13:03 +00001542void MicrosoftCXXNameMangler::manglePassObjectSizeArg(
1543 const PassObjectSizeAttr *POSA) {
1544 int Type = POSA->getType();
1545
1546 auto Iter = PassObjectSizeArgs.insert(Type).first;
David Majnemer622abd12015-12-31 05:36:52 +00001547 auto *TypePtr = (const void *)&*Iter;
David Majnemer5f177622015-12-30 05:13:03 +00001548 ArgBackRefMap::iterator Found = TypeBackReferences.find(TypePtr);
1549
1550 if (Found == TypeBackReferences.end()) {
1551 mangleArtificalTagType(TTK_Enum, "__pass_object_size" + llvm::utostr(Type),
1552 {"__clang"});
1553
1554 if (TypeBackReferences.size() < 10) {
1555 size_t Size = TypeBackReferences.size();
1556 TypeBackReferences[TypePtr] = Size;
1557 }
1558 } else {
1559 Out << Found->second;
1560 }
1561}
1562
Guy Benyei11169dd2012-12-18 14:30:41 +00001563void MicrosoftCXXNameMangler::mangleType(QualType T, SourceRange Range,
Peter Collingbourne2816c022013-04-25 04:25:40 +00001564 QualifierMangleMode QMM) {
Reid Kleckner18da98e2013-06-24 19:21:52 +00001565 // Don't use the canonical types. MSVC includes things like 'const' on
1566 // pointer arguments to function pointers that canonicalization strips away.
1567 T = T.getDesugaredType(getASTContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00001568 Qualifiers Quals = T.getLocalQualifiers();
Reid Kleckner18da98e2013-06-24 19:21:52 +00001569 if (const ArrayType *AT = getASTContext().getAsArrayType(T)) {
1570 // If there were any Quals, getAsArrayType() pushed them onto the array
1571 // element type.
Peter Collingbourne2816c022013-04-25 04:25:40 +00001572 if (QMM == QMM_Mangle)
1573 Out << 'A';
1574 else if (QMM == QMM_Escape || QMM == QMM_Result)
1575 Out << "$$B";
Reid Kleckner18da98e2013-06-24 19:21:52 +00001576 mangleArrayType(AT);
Peter Collingbourne2816c022013-04-25 04:25:40 +00001577 return;
1578 }
1579
1580 bool IsPointer = T->isAnyPointerType() || T->isMemberPointerType() ||
David Majnemer7a3ce0c2015-05-26 01:30:45 +00001581 T->isReferenceType() || T->isBlockPointerType();
Peter Collingbourne2816c022013-04-25 04:25:40 +00001582
1583 switch (QMM) {
1584 case QMM_Drop:
1585 break;
1586 case QMM_Mangle:
1587 if (const FunctionType *FT = dyn_cast<FunctionType>(T)) {
1588 Out << '6';
Timur Iskhodzhanov555a7722013-10-04 11:25:05 +00001589 mangleFunctionType(FT);
Peter Collingbourne2816c022013-04-25 04:25:40 +00001590 return;
1591 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001592 mangleQualifiers(Quals, false);
Peter Collingbourne2816c022013-04-25 04:25:40 +00001593 break;
1594 case QMM_Escape:
1595 if (!IsPointer && Quals) {
1596 Out << "$$C";
1597 mangleQualifiers(Quals, false);
1598 }
1599 break;
1600 case QMM_Result:
Andrey Bokhanko45d41322016-05-11 18:38:21 +00001601 // Presence of __unaligned qualifier shouldn't affect mangling here.
1602 Quals.removeUnaligned();
Peter Collingbourne2816c022013-04-25 04:25:40 +00001603 if ((!IsPointer && Quals) || isa<TagType>(T)) {
1604 Out << '?';
1605 mangleQualifiers(Quals, false);
1606 }
1607 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00001608 }
1609
Peter Collingbourne2816c022013-04-25 04:25:40 +00001610 const Type *ty = T.getTypePtr();
Guy Benyei11169dd2012-12-18 14:30:41 +00001611
1612 switch (ty->getTypeClass()) {
1613#define ABSTRACT_TYPE(CLASS, PARENT)
1614#define NON_CANONICAL_TYPE(CLASS, PARENT) \
1615 case Type::CLASS: \
1616 llvm_unreachable("can't mangle non-canonical type " #CLASS "Type"); \
1617 return;
1618#define TYPE(CLASS, PARENT) \
1619 case Type::CLASS: \
David Majnemer7a3ce0c2015-05-26 01:30:45 +00001620 mangleType(cast<CLASS##Type>(ty), Quals, Range); \
Guy Benyei11169dd2012-12-18 14:30:41 +00001621 break;
1622#include "clang/AST/TypeNodes.def"
1623#undef ABSTRACT_TYPE
1624#undef NON_CANONICAL_TYPE
1625#undef TYPE
1626 }
1627}
1628
David Majnemer7a3ce0c2015-05-26 01:30:45 +00001629void MicrosoftCXXNameMangler::mangleType(const BuiltinType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00001630 SourceRange Range) {
1631 // <type> ::= <builtin-type>
1632 // <builtin-type> ::= X # void
1633 // ::= C # signed char
1634 // ::= D # char
1635 // ::= E # unsigned char
1636 // ::= F # short
1637 // ::= G # unsigned short (or wchar_t if it's not a builtin)
1638 // ::= H # int
1639 // ::= I # unsigned int
1640 // ::= J # long
1641 // ::= K # unsigned long
1642 // L # <none>
1643 // ::= M # float
1644 // ::= N # double
1645 // ::= O # long double (__float80 is mangled differently)
1646 // ::= _J # long long, __int64
1647 // ::= _K # unsigned long long, __int64
1648 // ::= _L # __int128
1649 // ::= _M # unsigned __int128
1650 // ::= _N # bool
1651 // _O # <array in parameter>
1652 // ::= _T # __float80 (Intel)
1653 // ::= _W # wchar_t
1654 // ::= _Z # __float80 (Digital Mars)
1655 switch (T->getKind()) {
Alexey Baderbdf7c842015-09-15 12:18:29 +00001656 case BuiltinType::Void:
1657 Out << 'X';
1658 break;
1659 case BuiltinType::SChar:
1660 Out << 'C';
1661 break;
1662 case BuiltinType::Char_U:
1663 case BuiltinType::Char_S:
1664 Out << 'D';
1665 break;
1666 case BuiltinType::UChar:
1667 Out << 'E';
1668 break;
1669 case BuiltinType::Short:
1670 Out << 'F';
1671 break;
1672 case BuiltinType::UShort:
1673 Out << 'G';
1674 break;
1675 case BuiltinType::Int:
1676 Out << 'H';
1677 break;
1678 case BuiltinType::UInt:
1679 Out << 'I';
1680 break;
1681 case BuiltinType::Long:
1682 Out << 'J';
1683 break;
1684 case BuiltinType::ULong:
1685 Out << 'K';
1686 break;
1687 case BuiltinType::Float:
1688 Out << 'M';
1689 break;
1690 case BuiltinType::Double:
1691 Out << 'N';
1692 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00001693 // TODO: Determine size and mangle accordingly
Alexey Baderbdf7c842015-09-15 12:18:29 +00001694 case BuiltinType::LongDouble:
1695 Out << 'O';
1696 break;
1697 case BuiltinType::LongLong:
1698 Out << "_J";
1699 break;
1700 case BuiltinType::ULongLong:
1701 Out << "_K";
1702 break;
1703 case BuiltinType::Int128:
1704 Out << "_L";
1705 break;
1706 case BuiltinType::UInt128:
1707 Out << "_M";
1708 break;
1709 case BuiltinType::Bool:
1710 Out << "_N";
1711 break;
1712 case BuiltinType::Char16:
1713 Out << "_S";
1714 break;
1715 case BuiltinType::Char32:
1716 Out << "_U";
1717 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00001718 case BuiltinType::WChar_S:
Alexey Baderbdf7c842015-09-15 12:18:29 +00001719 case BuiltinType::WChar_U:
1720 Out << "_W";
1721 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00001722
1723#define BUILTIN_TYPE(Id, SingletonId)
1724#define PLACEHOLDER_TYPE(Id, SingletonId) \
1725 case BuiltinType::Id:
1726#include "clang/AST/BuiltinTypes.def"
1727 case BuiltinType::Dependent:
1728 llvm_unreachable("placeholder types shouldn't get to name mangling");
1729
Alexey Baderbdf7c842015-09-15 12:18:29 +00001730 case BuiltinType::ObjCId:
David Majnemer3add70b2015-12-29 11:45:53 +00001731 Out << "PA";
1732 mangleArtificalTagType(TTK_Struct, "objc_object");
Alexey Baderbdf7c842015-09-15 12:18:29 +00001733 break;
1734 case BuiltinType::ObjCClass:
David Majnemer3add70b2015-12-29 11:45:53 +00001735 Out << "PA";
1736 mangleArtificalTagType(TTK_Struct, "objc_class");
Alexey Baderbdf7c842015-09-15 12:18:29 +00001737 break;
1738 case BuiltinType::ObjCSel:
David Majnemer3add70b2015-12-29 11:45:53 +00001739 Out << "PA";
1740 mangleArtificalTagType(TTK_Struct, "objc_selector");
Alexey Baderbdf7c842015-09-15 12:18:29 +00001741 break;
Guy Benyeid8a08ea2012-12-18 14:38:23 +00001742
Alexey Bader954ba212016-04-08 13:40:33 +00001743#define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
1744 case BuiltinType::Id: \
1745 Out << "PAUocl_" #ImgType "_" #Suffix "@@"; \
Alexey Baderbdf7c842015-09-15 12:18:29 +00001746 break;
Alexey Baderb62f1442016-04-13 08:33:41 +00001747#include "clang/Basic/OpenCLImageTypes.def"
Alexey Baderbdf7c842015-09-15 12:18:29 +00001748 case BuiltinType::OCLSampler:
David Majnemer3add70b2015-12-29 11:45:53 +00001749 Out << "PA";
1750 mangleArtificalTagType(TTK_Struct, "ocl_sampler");
Alexey Baderbdf7c842015-09-15 12:18:29 +00001751 break;
1752 case BuiltinType::OCLEvent:
David Majnemer3add70b2015-12-29 11:45:53 +00001753 Out << "PA";
1754 mangleArtificalTagType(TTK_Struct, "ocl_event");
Alexey Baderbdf7c842015-09-15 12:18:29 +00001755 break;
Alexey Bader9c8453f2015-09-15 11:18:52 +00001756 case BuiltinType::OCLClkEvent:
David Majnemer3add70b2015-12-29 11:45:53 +00001757 Out << "PA";
1758 mangleArtificalTagType(TTK_Struct, "ocl_clkevent");
Alexey Bader9c8453f2015-09-15 11:18:52 +00001759 break;
1760 case BuiltinType::OCLQueue:
David Majnemer3add70b2015-12-29 11:45:53 +00001761 Out << "PA";
1762 mangleArtificalTagType(TTK_Struct, "ocl_queue");
Alexey Bader9c8453f2015-09-15 11:18:52 +00001763 break;
1764 case BuiltinType::OCLNDRange:
David Majnemer3add70b2015-12-29 11:45:53 +00001765 Out << "PA";
1766 mangleArtificalTagType(TTK_Struct, "ocl_ndrange");
Alexey Bader9c8453f2015-09-15 11:18:52 +00001767 break;
1768 case BuiltinType::OCLReserveID:
David Majnemer3add70b2015-12-29 11:45:53 +00001769 Out << "PA";
1770 mangleArtificalTagType(TTK_Struct, "ocl_reserveid");
Alexey Bader9c8453f2015-09-15 11:18:52 +00001771 break;
David Majnemerb4119f72013-12-13 01:06:04 +00001772
Alexey Baderbdf7c842015-09-15 12:18:29 +00001773 case BuiltinType::NullPtr:
1774 Out << "$$T";
1775 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00001776
Nemanja Ivanovicbb1ea2d2016-05-09 08:52:33 +00001777 case BuiltinType::Float128:
Guy Benyei11169dd2012-12-18 14:30:41 +00001778 case BuiltinType::Half: {
1779 DiagnosticsEngine &Diags = Context.getDiags();
Alexey Baderbdf7c842015-09-15 12:18:29 +00001780 unsigned DiagID = Diags.getCustomDiagID(
1781 DiagnosticsEngine::Error, "cannot mangle this built-in %0 type yet");
Guy Benyei11169dd2012-12-18 14:30:41 +00001782 Diags.Report(Range.getBegin(), DiagID)
Alexey Baderbdf7c842015-09-15 12:18:29 +00001783 << T->getName(Context.getASTContext().getPrintingPolicy()) << Range;
Guy Benyei11169dd2012-12-18 14:30:41 +00001784 break;
1785 }
1786 }
1787}
1788
1789// <type> ::= <function-type>
David Majnemer7a3ce0c2015-05-26 01:30:45 +00001790void MicrosoftCXXNameMangler::mangleType(const FunctionProtoType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00001791 SourceRange) {
1792 // Structors only appear in decls, so at this point we know it's not a
1793 // structor type.
1794 // FIXME: This may not be lambda-friendly.
David Majnemer2f6a96e2014-08-12 17:53:10 +00001795 if (T->getTypeQuals() || T->getRefQualifier() != RQ_None) {
1796 Out << "$$A8@@";
1797 mangleFunctionType(T, /*D=*/nullptr, /*ForceThisQuals=*/true);
1798 } else {
1799 Out << "$$A6";
1800 mangleFunctionType(T);
1801 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001802}
1803void MicrosoftCXXNameMangler::mangleType(const FunctionNoProtoType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00001804 Qualifiers, SourceRange) {
Peter Collingbourneeeebc412015-08-07 23:25:47 +00001805 Out << "$$A6";
1806 mangleFunctionType(T);
Guy Benyei11169dd2012-12-18 14:30:41 +00001807}
1808
Peter Collingbourne2816c022013-04-25 04:25:40 +00001809void MicrosoftCXXNameMangler::mangleFunctionType(const FunctionType *T,
1810 const FunctionDecl *D,
David Majnemer2f6a96e2014-08-12 17:53:10 +00001811 bool ForceThisQuals) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001812 // <function-type> ::= <this-cvr-qualifiers> <calling-convention>
1813 // <return-type> <argument-list> <throw-spec>
Peter Collingbourneeeebc412015-08-07 23:25:47 +00001814 const FunctionProtoType *Proto = dyn_cast<FunctionProtoType>(T);
Guy Benyei11169dd2012-12-18 14:30:41 +00001815
Reid Kleckner18da98e2013-06-24 19:21:52 +00001816 SourceRange Range;
1817 if (D) Range = D->getSourceRange();
1818
David Majnemer41311192016-01-17 07:09:24 +00001819 bool IsInLambda = false;
David Majnemerdfa6d202015-03-11 18:36:39 +00001820 bool IsStructor = false, HasThisQuals = ForceThisQuals, IsCtorClosure = false;
1821 CallingConv CC = T->getCallConv();
Timur Iskhodzhanov555a7722013-10-04 11:25:05 +00001822 if (const CXXMethodDecl *MD = dyn_cast_or_null<CXXMethodDecl>(D)) {
David Majnemer41311192016-01-17 07:09:24 +00001823 if (MD->getParent()->isLambda())
1824 IsInLambda = true;
Timur Iskhodzhanov555a7722013-10-04 11:25:05 +00001825 if (MD->isInstance())
David Majnemer2f6a96e2014-08-12 17:53:10 +00001826 HasThisQuals = true;
David Majnemerdfa6d202015-03-11 18:36:39 +00001827 if (isa<CXXDestructorDecl>(MD)) {
Timur Iskhodzhanov555a7722013-10-04 11:25:05 +00001828 IsStructor = true;
David Majnemerdfa6d202015-03-11 18:36:39 +00001829 } else if (isa<CXXConstructorDecl>(MD)) {
1830 IsStructor = true;
1831 IsCtorClosure = (StructorType == Ctor_CopyingClosure ||
1832 StructorType == Ctor_DefaultClosure) &&
1833 getStructor(MD) == Structor;
1834 if (IsCtorClosure)
1835 CC = getASTContext().getDefaultCallingConvention(
1836 /*IsVariadic=*/false, /*IsCXXMethod=*/true);
1837 }
Timur Iskhodzhanov555a7722013-10-04 11:25:05 +00001838 }
1839
Guy Benyei11169dd2012-12-18 14:30:41 +00001840 // If this is a C++ instance method, mangle the CVR qualifiers for the
1841 // this pointer.
David Majnemer2f6a96e2014-08-12 17:53:10 +00001842 if (HasThisQuals) {
Andrey Bokhanko67a41862016-05-26 10:06:01 +00001843 Qualifiers Quals = Qualifiers::fromCVRUMask(Proto->getTypeQuals());
David Majnemer7a3ce0c2015-05-26 01:30:45 +00001844 manglePointerExtQualifiers(Quals, /*PointeeType=*/QualType());
David Majnemere3785bb2014-04-23 05:16:56 +00001845 mangleRefQualifier(Proto->getRefQualifier());
David Majnemer2f6a96e2014-08-12 17:53:10 +00001846 mangleQualifiers(Quals, /*IsMember=*/false);
David Majnemer6dda7bb2013-08-15 08:13:23 +00001847 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001848
David Majnemerdfa6d202015-03-11 18:36:39 +00001849 mangleCallingConvention(CC);
Guy Benyei11169dd2012-12-18 14:30:41 +00001850
1851 // <return-type> ::= <type>
1852 // ::= @ # structors (they have no declared return type)
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001853 if (IsStructor) {
1854 if (isa<CXXDestructorDecl>(D) && D == Structor &&
1855 StructorType == Dtor_Deleting) {
1856 // The scalar deleting destructor takes an extra int argument.
1857 // However, the FunctionType generated has 0 arguments.
1858 // FIXME: This is a temporary hack.
1859 // Maybe should fix the FunctionType creation instead?
Timur Iskhodzhanovf46993e2013-08-26 10:32:04 +00001860 Out << (PointersAre64Bit ? "PEAXI@Z" : "PAXI@Z");
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001861 return;
1862 }
David Majnemerdfa6d202015-03-11 18:36:39 +00001863 if (IsCtorClosure) {
1864 // Default constructor closure and copy constructor closure both return
1865 // void.
1866 Out << 'X';
1867
1868 if (StructorType == Ctor_DefaultClosure) {
1869 // Default constructor closure always has no arguments.
1870 Out << 'X';
1871 } else if (StructorType == Ctor_CopyingClosure) {
1872 // Copy constructor closure always takes an unqualified reference.
1873 mangleArgumentType(getASTContext().getLValueReferenceType(
1874 Proto->getParamType(0)
1875 ->getAs<LValueReferenceType>()
1876 ->getPointeeType(),
1877 /*SpelledAsLValue=*/true),
1878 Range);
David Majnemer37fd66e2015-03-13 22:36:55 +00001879 Out << '@';
David Majnemerdfa6d202015-03-11 18:36:39 +00001880 } else {
1881 llvm_unreachable("unexpected constructor closure!");
1882 }
David Majnemer37fd66e2015-03-13 22:36:55 +00001883 Out << 'Z';
David Majnemerdfa6d202015-03-11 18:36:39 +00001884 return;
1885 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001886 Out << '@';
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001887 } else {
Peter Collingbourneeeebc412015-08-07 23:25:47 +00001888 QualType ResultType = T->getReturnType();
David Majnemer2e1e04912014-04-01 05:29:46 +00001889 if (const auto *AT =
1890 dyn_cast_or_null<AutoType>(ResultType->getContainedAutoType())) {
1891 Out << '?';
1892 mangleQualifiers(ResultType.getLocalQualifiers(), /*IsMember=*/false);
1893 Out << '?';
Richard Smithe301ba22015-11-11 02:02:15 +00001894 assert(AT->getKeyword() != AutoTypeKeyword::GNUAutoType &&
1895 "shouldn't need to mangle __auto_type!");
David Majnemer2e1e04912014-04-01 05:29:46 +00001896 mangleSourceName(AT->isDecltypeAuto() ? "<decltype-auto>" : "<auto>");
1897 Out << '@';
David Majnemer41311192016-01-17 07:09:24 +00001898 } else if (IsInLambda) {
1899 Out << '@';
David Majnemer2e1e04912014-04-01 05:29:46 +00001900 } else {
1901 if (ResultType->isVoidType())
1902 ResultType = ResultType.getUnqualifiedType();
1903 mangleType(ResultType, Range, QMM_Result);
1904 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001905 }
1906
1907 // <argument-list> ::= X # void
1908 // ::= <type>+ @
1909 // ::= <type>* Z # varargs
Peter Collingbourneeeebc412015-08-07 23:25:47 +00001910 if (!Proto) {
1911 // Function types without prototypes can arise when mangling a function type
1912 // within an overloadable function in C. We mangle these as the absence of
1913 // any parameter types (not even an empty parameter list).
1914 Out << '@';
1915 } else if (Proto->getNumParams() == 0 && !Proto->isVariadic()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001916 Out << 'X';
1917 } else {
Reid Kleckner18da98e2013-06-24 19:21:52 +00001918 // Happens for function pointer type arguments for example.
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00001919 for (unsigned I = 0, E = Proto->getNumParams(); I != E; ++I) {
1920 mangleArgumentType(Proto->getParamType(I), Range);
1921 // Mangle each pass_object_size parameter as if it's a paramater of enum
1922 // type passed directly after the parameter with the pass_object_size
1923 // attribute. The aforementioned enum's name is __pass_object_size, and we
1924 // pretend it resides in a top-level namespace called __clang.
1925 //
1926 // FIXME: Is there a defined extension notation for the MS ABI, or is it
1927 // necessary to just cross our fingers and hope this type+namespace
1928 // combination doesn't conflict with anything?
1929 if (D)
David Majnemer5f177622015-12-30 05:13:03 +00001930 if (const auto *P = D->getParamDecl(I)->getAttr<PassObjectSizeAttr>())
1931 manglePassObjectSizeArg(P);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00001932 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001933 // <builtin-type> ::= Z # ellipsis
1934 if (Proto->isVariadic())
1935 Out << 'Z';
1936 else
1937 Out << '@';
1938 }
1939
1940 mangleThrowSpecification(Proto);
1941}
1942
1943void MicrosoftCXXNameMangler::mangleFunctionClass(const FunctionDecl *FD) {
Reid Kleckner369f3162013-05-14 20:30:42 +00001944 // <function-class> ::= <member-function> E? # E designates a 64-bit 'this'
1945 // # pointer. in 64-bit mode *all*
1946 // # 'this' pointers are 64-bit.
1947 // ::= <global-function>
1948 // <member-function> ::= A # private: near
1949 // ::= B # private: far
1950 // ::= C # private: static near
1951 // ::= D # private: static far
1952 // ::= E # private: virtual near
1953 // ::= F # private: virtual far
Reid Kleckner369f3162013-05-14 20:30:42 +00001954 // ::= I # protected: near
1955 // ::= J # protected: far
1956 // ::= K # protected: static near
1957 // ::= L # protected: static far
1958 // ::= M # protected: virtual near
1959 // ::= N # protected: virtual far
Reid Kleckner369f3162013-05-14 20:30:42 +00001960 // ::= Q # public: near
1961 // ::= R # public: far
1962 // ::= S # public: static near
1963 // ::= T # public: static far
1964 // ::= U # public: virtual near
1965 // ::= V # public: virtual far
Reid Kleckner369f3162013-05-14 20:30:42 +00001966 // <global-function> ::= Y # global near
1967 // ::= Z # global far
Guy Benyei11169dd2012-12-18 14:30:41 +00001968 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD)) {
1969 switch (MD->getAccess()) {
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00001970 case AS_none:
1971 llvm_unreachable("Unsupported access specifier");
Guy Benyei11169dd2012-12-18 14:30:41 +00001972 case AS_private:
1973 if (MD->isStatic())
1974 Out << 'C';
1975 else if (MD->isVirtual())
1976 Out << 'E';
1977 else
1978 Out << 'A';
1979 break;
1980 case AS_protected:
1981 if (MD->isStatic())
1982 Out << 'K';
1983 else if (MD->isVirtual())
1984 Out << 'M';
1985 else
1986 Out << 'I';
1987 break;
1988 case AS_public:
1989 if (MD->isStatic())
1990 Out << 'S';
1991 else if (MD->isVirtual())
1992 Out << 'U';
1993 else
1994 Out << 'Q';
1995 }
David Majnemer5a7cfea2015-05-18 00:05:29 +00001996 } else {
Guy Benyei11169dd2012-12-18 14:30:41 +00001997 Out << 'Y';
David Majnemer5a7cfea2015-05-18 00:05:29 +00001998 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001999}
David Majnemerdfa6d202015-03-11 18:36:39 +00002000void MicrosoftCXXNameMangler::mangleCallingConvention(CallingConv CC) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002001 // <calling-convention> ::= A # __cdecl
2002 // ::= B # __export __cdecl
2003 // ::= C # __pascal
2004 // ::= D # __export __pascal
2005 // ::= E # __thiscall
2006 // ::= F # __export __thiscall
2007 // ::= G # __stdcall
2008 // ::= H # __export __stdcall
2009 // ::= I # __fastcall
2010 // ::= J # __export __fastcall
Reid Klecknerd7857f02014-10-24 17:42:17 +00002011 // ::= Q # __vectorcall
Guy Benyei11169dd2012-12-18 14:30:41 +00002012 // The 'export' calling conventions are from a bygone era
2013 // (*cough*Win16*cough*) when functions were declared for export with
2014 // that keyword. (It didn't actually export them, it just made them so
2015 // that they could be in a DLL and somebody from another module could call
2016 // them.)
David Majnemerdfa6d202015-03-11 18:36:39 +00002017
Guy Benyei11169dd2012-12-18 14:30:41 +00002018 switch (CC) {
2019 default:
2020 llvm_unreachable("Unsupported CC for mangling");
Charles Davisb5a214e2013-08-30 04:39:01 +00002021 case CC_X86_64Win64:
2022 case CC_X86_64SysV:
Guy Benyei11169dd2012-12-18 14:30:41 +00002023 case CC_C: Out << 'A'; break;
2024 case CC_X86Pascal: Out << 'C'; break;
2025 case CC_X86ThisCall: Out << 'E'; break;
2026 case CC_X86StdCall: Out << 'G'; break;
2027 case CC_X86FastCall: Out << 'I'; break;
Reid Klecknerd7857f02014-10-24 17:42:17 +00002028 case CC_X86VectorCall: Out << 'Q'; break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002029 }
2030}
David Majnemerdfa6d202015-03-11 18:36:39 +00002031void MicrosoftCXXNameMangler::mangleCallingConvention(const FunctionType *T) {
2032 mangleCallingConvention(T->getCallConv());
2033}
Guy Benyei11169dd2012-12-18 14:30:41 +00002034void MicrosoftCXXNameMangler::mangleThrowSpecification(
2035 const FunctionProtoType *FT) {
2036 // <throw-spec> ::= Z # throw(...) (default)
2037 // ::= @ # throw() or __declspec/__attribute__((nothrow))
2038 // ::= <type>+
2039 // NOTE: Since the Microsoft compiler ignores throw specifications, they are
2040 // all actually mangled as 'Z'. (They're ignored because their associated
2041 // functionality isn't implemented, and probably never will be.)
2042 Out << 'Z';
2043}
2044
2045void MicrosoftCXXNameMangler::mangleType(const UnresolvedUsingType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002046 Qualifiers, SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002047 // Probably should be mangled as a template instantiation; need to see what
2048 // VC does first.
2049 DiagnosticsEngine &Diags = Context.getDiags();
2050 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2051 "cannot mangle this unresolved dependent type yet");
2052 Diags.Report(Range.getBegin(), DiagID)
2053 << Range;
2054}
2055
2056// <type> ::= <union-type> | <struct-type> | <class-type> | <enum-type>
2057// <union-type> ::= T <name>
2058// <struct-type> ::= U <name>
2059// <class-type> ::= V <name>
David Majnemer048f90c2013-12-09 04:28:34 +00002060// <enum-type> ::= W4 <name>
David Majnemer3add70b2015-12-29 11:45:53 +00002061void MicrosoftCXXNameMangler::mangleTagTypeKind(TagTypeKind TTK) {
2062 switch (TTK) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002063 case TTK_Union:
2064 Out << 'T';
2065 break;
2066 case TTK_Struct:
2067 case TTK_Interface:
2068 Out << 'U';
2069 break;
2070 case TTK_Class:
2071 Out << 'V';
2072 break;
2073 case TTK_Enum:
David Majnemer048f90c2013-12-09 04:28:34 +00002074 Out << "W4";
Guy Benyei11169dd2012-12-18 14:30:41 +00002075 break;
2076 }
David Majnemer3add70b2015-12-29 11:45:53 +00002077}
2078void MicrosoftCXXNameMangler::mangleType(const EnumType *T, Qualifiers,
2079 SourceRange) {
2080 mangleType(cast<TagType>(T)->getDecl());
2081}
2082void MicrosoftCXXNameMangler::mangleType(const RecordType *T, Qualifiers,
2083 SourceRange) {
2084 mangleType(cast<TagType>(T)->getDecl());
2085}
2086void MicrosoftCXXNameMangler::mangleType(const TagDecl *TD) {
2087 mangleTagTypeKind(TD->getTagKind());
David Majnemer0db0ca42013-08-05 22:26:46 +00002088 mangleName(TD);
Guy Benyei11169dd2012-12-18 14:30:41 +00002089}
David Majnemer3add70b2015-12-29 11:45:53 +00002090void MicrosoftCXXNameMangler::mangleArtificalTagType(
2091 TagTypeKind TK, StringRef UnqualifiedName, ArrayRef<StringRef> NestedNames) {
2092 // <name> ::= <unscoped-name> {[<named-scope>]+ | [<nested-name>]}? @
2093 mangleTagTypeKind(TK);
2094
2095 // Always start with the unqualified name.
2096 mangleSourceName(UnqualifiedName);
2097
2098 for (auto I = NestedNames.rbegin(), E = NestedNames.rend(); I != E; ++I)
2099 mangleSourceName(*I);
2100
2101 // Terminate the whole name with an '@'.
2102 Out << '@';
2103}
Guy Benyei11169dd2012-12-18 14:30:41 +00002104
2105// <type> ::= <array-type>
2106// <array-type> ::= <pointer-cvr-qualifiers> <cvr-qualifiers>
2107// [Y <dimension-count> <dimension>+]
Reid Kleckner369f3162013-05-14 20:30:42 +00002108// <element-type> # as global, E is never required
Guy Benyei11169dd2012-12-18 14:30:41 +00002109// It's supposed to be the other way around, but for some strange reason, it
2110// isn't. Today this behavior is retained for the sole purpose of backwards
2111// compatibility.
David Majnemer5a1b2042013-09-11 04:44:30 +00002112void MicrosoftCXXNameMangler::mangleDecayedArrayType(const ArrayType *T) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002113 // This isn't a recursive mangling, so now we have to do it all in this
2114 // one call.
David Majnemer8eec58f2014-02-18 14:20:10 +00002115 manglePointerCVQualifiers(T->getElementType().getQualifiers());
Peter Collingbourne2816c022013-04-25 04:25:40 +00002116 mangleType(T->getElementType(), SourceRange());
Guy Benyei11169dd2012-12-18 14:30:41 +00002117}
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002118void MicrosoftCXXNameMangler::mangleType(const ConstantArrayType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002119 SourceRange) {
Peter Collingbourne2816c022013-04-25 04:25:40 +00002120 llvm_unreachable("Should have been special cased");
Guy Benyei11169dd2012-12-18 14:30:41 +00002121}
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002122void MicrosoftCXXNameMangler::mangleType(const VariableArrayType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002123 SourceRange) {
Peter Collingbourne2816c022013-04-25 04:25:40 +00002124 llvm_unreachable("Should have been special cased");
Guy Benyei11169dd2012-12-18 14:30:41 +00002125}
2126void MicrosoftCXXNameMangler::mangleType(const DependentSizedArrayType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002127 Qualifiers, SourceRange) {
Peter Collingbourne2816c022013-04-25 04:25:40 +00002128 llvm_unreachable("Should have been special cased");
Guy Benyei11169dd2012-12-18 14:30:41 +00002129}
2130void MicrosoftCXXNameMangler::mangleType(const IncompleteArrayType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002131 Qualifiers, SourceRange) {
Peter Collingbourne2816c022013-04-25 04:25:40 +00002132 llvm_unreachable("Should have been special cased");
Guy Benyei11169dd2012-12-18 14:30:41 +00002133}
Reid Kleckner18da98e2013-06-24 19:21:52 +00002134void MicrosoftCXXNameMangler::mangleArrayType(const ArrayType *T) {
Peter Collingbourne2816c022013-04-25 04:25:40 +00002135 QualType ElementTy(T, 0);
Guy Benyei11169dd2012-12-18 14:30:41 +00002136 SmallVector<llvm::APInt, 3> Dimensions;
2137 for (;;) {
David Majnemer9595b7d2015-04-23 07:42:08 +00002138 if (ElementTy->isConstantArrayType()) {
2139 const ConstantArrayType *CAT =
2140 getASTContext().getAsConstantArrayType(ElementTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00002141 Dimensions.push_back(CAT->getSize());
2142 ElementTy = CAT->getElementType();
David Majnemer9595b7d2015-04-23 07:42:08 +00002143 } else if (ElementTy->isIncompleteArrayType()) {
2144 const IncompleteArrayType *IAT =
2145 getASTContext().getAsIncompleteArrayType(ElementTy);
2146 Dimensions.push_back(llvm::APInt(32, 0));
2147 ElementTy = IAT->getElementType();
Guy Benyei11169dd2012-12-18 14:30:41 +00002148 } else if (ElementTy->isVariableArrayType()) {
2149 const VariableArrayType *VAT =
2150 getASTContext().getAsVariableArrayType(ElementTy);
David Majnemer9595b7d2015-04-23 07:42:08 +00002151 Dimensions.push_back(llvm::APInt(32, 0));
2152 ElementTy = VAT->getElementType();
Guy Benyei11169dd2012-12-18 14:30:41 +00002153 } else if (ElementTy->isDependentSizedArrayType()) {
2154 // The dependent expression has to be folded into a constant (TODO).
2155 const DependentSizedArrayType *DSAT =
2156 getASTContext().getAsDependentSizedArrayType(ElementTy);
2157 DiagnosticsEngine &Diags = Context.getDiags();
2158 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2159 "cannot mangle this dependent-length array yet");
2160 Diags.Report(DSAT->getSizeExpr()->getExprLoc(), DiagID)
2161 << DSAT->getBracketsRange();
2162 return;
David Majnemer9595b7d2015-04-23 07:42:08 +00002163 } else {
2164 break;
Peter Collingbourne2816c022013-04-25 04:25:40 +00002165 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002166 }
Peter Collingbourne2816c022013-04-25 04:25:40 +00002167 Out << 'Y';
2168 // <dimension-count> ::= <number> # number of extra dimensions
2169 mangleNumber(Dimensions.size());
David Majnemerb926dbc2014-04-23 05:16:53 +00002170 for (const llvm::APInt &Dimension : Dimensions)
2171 mangleNumber(Dimension.getLimitedValue());
Reid Kleckner18da98e2013-06-24 19:21:52 +00002172 mangleType(ElementTy, SourceRange(), QMM_Escape);
Guy Benyei11169dd2012-12-18 14:30:41 +00002173}
2174
2175// <type> ::= <pointer-to-member-type>
2176// <pointer-to-member-type> ::= <pointer-cvr-qualifiers> <cvr-qualifiers>
2177// <class name> <type>
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002178void MicrosoftCXXNameMangler::mangleType(const MemberPointerType *T, Qualifiers Quals,
Guy Benyei11169dd2012-12-18 14:30:41 +00002179 SourceRange Range) {
2180 QualType PointeeType = T->getPointeeType();
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002181 manglePointerCVQualifiers(Quals);
2182 manglePointerExtQualifiers(Quals, PointeeType);
Guy Benyei11169dd2012-12-18 14:30:41 +00002183 if (const FunctionProtoType *FPT = PointeeType->getAs<FunctionProtoType>()) {
2184 Out << '8';
2185 mangleName(T->getClass()->castAs<RecordType>()->getDecl());
Craig Topper36250ad2014-05-12 05:36:57 +00002186 mangleFunctionType(FPT, nullptr, true);
Guy Benyei11169dd2012-12-18 14:30:41 +00002187 } else {
2188 mangleQualifiers(PointeeType.getQualifiers(), true);
2189 mangleName(T->getClass()->castAs<RecordType>()->getDecl());
Peter Collingbourne2816c022013-04-25 04:25:40 +00002190 mangleType(PointeeType, Range, QMM_Drop);
Guy Benyei11169dd2012-12-18 14:30:41 +00002191 }
2192}
2193
2194void MicrosoftCXXNameMangler::mangleType(const TemplateTypeParmType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002195 Qualifiers, SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002196 DiagnosticsEngine &Diags = Context.getDiags();
2197 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2198 "cannot mangle this template type parameter type yet");
2199 Diags.Report(Range.getBegin(), DiagID)
2200 << Range;
2201}
2202
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002203void MicrosoftCXXNameMangler::mangleType(const SubstTemplateTypeParmPackType *T,
2204 Qualifiers, SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002205 DiagnosticsEngine &Diags = Context.getDiags();
2206 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2207 "cannot mangle this substituted parameter pack yet");
2208 Diags.Report(Range.getBegin(), DiagID)
2209 << Range;
2210}
2211
2212// <type> ::= <pointer-type>
Reid Kleckner369f3162013-05-14 20:30:42 +00002213// <pointer-type> ::= E? <pointer-cvr-qualifiers> <cvr-qualifiers> <type>
Alp Tokerd4733632013-12-05 04:47:09 +00002214// # the E is required for 64-bit non-static pointers
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002215void MicrosoftCXXNameMangler::mangleType(const PointerType *T, Qualifiers Quals,
Guy Benyei11169dd2012-12-18 14:30:41 +00002216 SourceRange Range) {
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002217 QualType PointeeType = T->getPointeeType();
2218 manglePointerCVQualifiers(Quals);
2219 manglePointerExtQualifiers(Quals, PointeeType);
2220 mangleType(PointeeType, Range);
Guy Benyei11169dd2012-12-18 14:30:41 +00002221}
2222void MicrosoftCXXNameMangler::mangleType(const ObjCObjectPointerType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002223 Qualifiers Quals, SourceRange Range) {
2224 QualType PointeeType = T->getPointeeType();
2225 manglePointerCVQualifiers(Quals);
2226 manglePointerExtQualifiers(Quals, PointeeType);
Guy Benyei11169dd2012-12-18 14:30:41 +00002227 // Object pointers never have qualifiers.
2228 Out << 'A';
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002229 mangleType(PointeeType, Range);
Guy Benyei11169dd2012-12-18 14:30:41 +00002230}
2231
2232// <type> ::= <reference-type>
Reid Kleckner369f3162013-05-14 20:30:42 +00002233// <reference-type> ::= A E? <cvr-qualifiers> <type>
Alp Tokerd4733632013-12-05 04:47:09 +00002234// # the E is required for 64-bit non-static lvalue references
Guy Benyei11169dd2012-12-18 14:30:41 +00002235void MicrosoftCXXNameMangler::mangleType(const LValueReferenceType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002236 Qualifiers Quals, SourceRange Range) {
2237 QualType PointeeType = T->getPointeeType();
David Majnemere3d71912015-12-31 05:36:50 +00002238 assert(!Quals.hasConst() && !Quals.hasVolatile() && "unexpected qualifier!");
2239 Out << 'A';
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002240 manglePointerExtQualifiers(Quals, PointeeType);
2241 mangleType(PointeeType, Range);
Guy Benyei11169dd2012-12-18 14:30:41 +00002242}
2243
2244// <type> ::= <r-value-reference-type>
Reid Kleckner369f3162013-05-14 20:30:42 +00002245// <r-value-reference-type> ::= $$Q E? <cvr-qualifiers> <type>
Alp Tokerd4733632013-12-05 04:47:09 +00002246// # the E is required for 64-bit non-static rvalue references
Guy Benyei11169dd2012-12-18 14:30:41 +00002247void MicrosoftCXXNameMangler::mangleType(const RValueReferenceType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002248 Qualifiers Quals, SourceRange Range) {
2249 QualType PointeeType = T->getPointeeType();
David Majnemere3d71912015-12-31 05:36:50 +00002250 assert(!Quals.hasConst() && !Quals.hasVolatile() && "unexpected qualifier!");
2251 Out << "$$Q";
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002252 manglePointerExtQualifiers(Quals, PointeeType);
2253 mangleType(PointeeType, Range);
Guy Benyei11169dd2012-12-18 14:30:41 +00002254}
2255
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002256void MicrosoftCXXNameMangler::mangleType(const ComplexType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002257 SourceRange Range) {
David Majnemer0b996dd2015-12-29 22:02:15 +00002258 QualType ElementType = T->getElementType();
2259
2260 llvm::SmallString<64> TemplateMangling;
2261 llvm::raw_svector_ostream Stream(TemplateMangling);
2262 MicrosoftCXXNameMangler Extra(Context, Stream);
2263 Stream << "?$";
2264 Extra.mangleSourceName("_Complex");
2265 Extra.mangleType(ElementType, Range, QMM_Escape);
2266
2267 mangleArtificalTagType(TTK_Struct, TemplateMangling, {"__clang"});
Guy Benyei11169dd2012-12-18 14:30:41 +00002268}
2269
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002270void MicrosoftCXXNameMangler::mangleType(const VectorType *T, Qualifiers Quals,
Guy Benyei11169dd2012-12-18 14:30:41 +00002271 SourceRange Range) {
Reid Klecknere7e64d82013-03-26 16:56:59 +00002272 const BuiltinType *ET = T->getElementType()->getAs<BuiltinType>();
2273 assert(ET && "vectors with non-builtin elements are unsupported");
2274 uint64_t Width = getASTContext().getTypeSize(T);
2275 // Pattern match exactly the typedefs in our intrinsic headers. Anything that
2276 // doesn't match the Intel types uses a custom mangling below.
David Majnemer0a29fed2015-12-29 11:45:58 +00002277 size_t OutSizeBefore = Out.tell();
David Majnemerf04e3862015-06-01 07:41:37 +00002278 llvm::Triple::ArchType AT =
2279 getASTContext().getTargetInfo().getTriple().getArch();
2280 if (AT == llvm::Triple::x86 || AT == llvm::Triple::x86_64) {
2281 if (Width == 64 && ET->getKind() == BuiltinType::LongLong) {
David Majnemer3add70b2015-12-29 11:45:53 +00002282 mangleArtificalTagType(TTK_Union, "__m64");
David Majnemerf04e3862015-06-01 07:41:37 +00002283 } else if (Width >= 128) {
2284 if (ET->getKind() == BuiltinType::Float)
David Majnemer3add70b2015-12-29 11:45:53 +00002285 mangleArtificalTagType(TTK_Union, "__m" + llvm::utostr(Width));
David Majnemerf04e3862015-06-01 07:41:37 +00002286 else if (ET->getKind() == BuiltinType::LongLong)
David Majnemer3add70b2015-12-29 11:45:53 +00002287 mangleArtificalTagType(TTK_Union, "__m" + llvm::utostr(Width) + 'i');
David Majnemerf04e3862015-06-01 07:41:37 +00002288 else if (ET->getKind() == BuiltinType::Double)
David Majnemer3add70b2015-12-29 11:45:53 +00002289 mangleArtificalTagType(TTK_Struct, "__m" + llvm::utostr(Width) + 'd');
David Majnemerf04e3862015-06-01 07:41:37 +00002290 }
Reid Klecknere7e64d82013-03-26 16:56:59 +00002291 }
2292
David Majnemer0a29fed2015-12-29 11:45:58 +00002293 bool IsBuiltin = Out.tell() != OutSizeBefore;
David Majnemerf04e3862015-06-01 07:41:37 +00002294 if (!IsBuiltin) {
Reid Klecknere7e64d82013-03-26 16:56:59 +00002295 // The MS ABI doesn't have a special mangling for vector types, so we define
2296 // our own mangling to handle uses of __vector_size__ on user-specified
2297 // types, and for extensions like __v4sf.
David Majnemer0a29fed2015-12-29 11:45:58 +00002298
2299 llvm::SmallString<64> TemplateMangling;
2300 llvm::raw_svector_ostream Stream(TemplateMangling);
2301 MicrosoftCXXNameMangler Extra(Context, Stream);
2302 Stream << "?$";
2303 Extra.mangleSourceName("__vector");
2304 Extra.mangleType(QualType(ET, 0), Range, QMM_Escape);
2305 Extra.mangleIntegerLiteral(llvm::APSInt::getUnsigned(T->getNumElements()),
2306 /*IsBoolean=*/false);
2307
2308 mangleArtificalTagType(TTK_Union, TemplateMangling, {"__clang"});
Reid Klecknere7e64d82013-03-26 16:56:59 +00002309 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002310}
Reid Klecknere7e64d82013-03-26 16:56:59 +00002311
David Majnemere5c87872015-08-01 05:51:55 +00002312void MicrosoftCXXNameMangler::mangleType(const ExtVectorType *T,
2313 Qualifiers Quals, SourceRange Range) {
2314 mangleType(static_cast<const VectorType *>(T), Quals, Range);
Guy Benyei11169dd2012-12-18 14:30:41 +00002315}
2316void MicrosoftCXXNameMangler::mangleType(const DependentSizedExtVectorType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002317 Qualifiers, SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002318 DiagnosticsEngine &Diags = Context.getDiags();
2319 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2320 "cannot mangle this dependent-sized extended vector type yet");
2321 Diags.Report(Range.getBegin(), DiagID)
2322 << Range;
2323}
2324
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002325void MicrosoftCXXNameMangler::mangleType(const ObjCInterfaceType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002326 SourceRange) {
2327 // ObjC interfaces have structs underlying them.
David Majnemer3add70b2015-12-29 11:45:53 +00002328 mangleTagTypeKind(TTK_Struct);
Guy Benyei11169dd2012-12-18 14:30:41 +00002329 mangleName(T->getDecl());
2330}
2331
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002332void MicrosoftCXXNameMangler::mangleType(const ObjCObjectType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002333 SourceRange Range) {
2334 // We don't allow overloading by different protocol qualification,
2335 // so mangling them isn't necessary.
2336 mangleType(T->getBaseType(), Range);
2337}
2338
2339void MicrosoftCXXNameMangler::mangleType(const BlockPointerType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002340 Qualifiers Quals, SourceRange Range) {
2341 QualType PointeeType = T->getPointeeType();
2342 manglePointerCVQualifiers(Quals);
2343 manglePointerExtQualifiers(Quals, PointeeType);
2344
Guy Benyei11169dd2012-12-18 14:30:41 +00002345 Out << "_E";
2346
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002347 mangleFunctionType(PointeeType->castAs<FunctionProtoType>());
Guy Benyei11169dd2012-12-18 14:30:41 +00002348}
2349
David Majnemerf0a84f22013-08-16 08:29:13 +00002350void MicrosoftCXXNameMangler::mangleType(const InjectedClassNameType *,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002351 Qualifiers, SourceRange) {
David Majnemerf0a84f22013-08-16 08:29:13 +00002352 llvm_unreachable("Cannot mangle injected class name type.");
Guy Benyei11169dd2012-12-18 14:30:41 +00002353}
2354
2355void MicrosoftCXXNameMangler::mangleType(const TemplateSpecializationType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002356 Qualifiers, SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002357 DiagnosticsEngine &Diags = Context.getDiags();
2358 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2359 "cannot mangle this template specialization type yet");
2360 Diags.Report(Range.getBegin(), DiagID)
2361 << Range;
2362}
2363
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002364void MicrosoftCXXNameMangler::mangleType(const DependentNameType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002365 SourceRange Range) {
2366 DiagnosticsEngine &Diags = Context.getDiags();
2367 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2368 "cannot mangle this dependent name type yet");
2369 Diags.Report(Range.getBegin(), DiagID)
2370 << Range;
2371}
2372
2373void MicrosoftCXXNameMangler::mangleType(
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002374 const DependentTemplateSpecializationType *T, Qualifiers,
2375 SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002376 DiagnosticsEngine &Diags = Context.getDiags();
2377 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2378 "cannot mangle this dependent template specialization type yet");
2379 Diags.Report(Range.getBegin(), DiagID)
2380 << Range;
2381}
2382
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002383void MicrosoftCXXNameMangler::mangleType(const PackExpansionType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002384 SourceRange Range) {
2385 DiagnosticsEngine &Diags = Context.getDiags();
2386 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2387 "cannot mangle this pack expansion yet");
2388 Diags.Report(Range.getBegin(), DiagID)
2389 << Range;
2390}
2391
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002392void MicrosoftCXXNameMangler::mangleType(const TypeOfType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002393 SourceRange Range) {
2394 DiagnosticsEngine &Diags = Context.getDiags();
2395 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2396 "cannot mangle this typeof(type) yet");
2397 Diags.Report(Range.getBegin(), DiagID)
2398 << Range;
2399}
2400
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002401void MicrosoftCXXNameMangler::mangleType(const TypeOfExprType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002402 SourceRange Range) {
2403 DiagnosticsEngine &Diags = Context.getDiags();
2404 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2405 "cannot mangle this typeof(expression) yet");
2406 Diags.Report(Range.getBegin(), DiagID)
2407 << Range;
2408}
2409
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002410void MicrosoftCXXNameMangler::mangleType(const DecltypeType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002411 SourceRange Range) {
2412 DiagnosticsEngine &Diags = Context.getDiags();
2413 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2414 "cannot mangle this decltype() yet");
2415 Diags.Report(Range.getBegin(), DiagID)
2416 << Range;
2417}
2418
2419void MicrosoftCXXNameMangler::mangleType(const UnaryTransformType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002420 Qualifiers, SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002421 DiagnosticsEngine &Diags = Context.getDiags();
2422 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2423 "cannot mangle this unary transform type yet");
2424 Diags.Report(Range.getBegin(), DiagID)
2425 << Range;
2426}
2427
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002428void MicrosoftCXXNameMangler::mangleType(const AutoType *T, Qualifiers,
2429 SourceRange Range) {
David Majnemerb9a5f2d2014-01-21 20:33:36 +00002430 assert(T->getDeducedType().isNull() && "expecting a dependent type!");
2431
Guy Benyei11169dd2012-12-18 14:30:41 +00002432 DiagnosticsEngine &Diags = Context.getDiags();
2433 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2434 "cannot mangle this 'auto' type yet");
2435 Diags.Report(Range.getBegin(), DiagID)
2436 << Range;
2437}
2438
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002439void MicrosoftCXXNameMangler::mangleType(const AtomicType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002440 SourceRange Range) {
David Majnemer3421fb62015-12-29 11:46:00 +00002441 QualType ValueType = T->getValueType();
2442
2443 llvm::SmallString<64> TemplateMangling;
2444 llvm::raw_svector_ostream Stream(TemplateMangling);
2445 MicrosoftCXXNameMangler Extra(Context, Stream);
2446 Stream << "?$";
2447 Extra.mangleSourceName("_Atomic");
2448 Extra.mangleType(ValueType, Range, QMM_Escape);
2449
2450 mangleArtificalTagType(TTK_Struct, TemplateMangling, {"__clang"});
Guy Benyei11169dd2012-12-18 14:30:41 +00002451}
2452
Xiuli Pan9c14e282016-01-09 12:53:17 +00002453void MicrosoftCXXNameMangler::mangleType(const PipeType *T, Qualifiers,
2454 SourceRange Range) {
2455 DiagnosticsEngine &Diags = Context.getDiags();
2456 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2457 "cannot mangle this OpenCL pipe type yet");
2458 Diags.Report(Range.getBegin(), DiagID)
2459 << Range;
2460}
2461
Rafael Espindola002667c2013-10-16 01:40:34 +00002462void MicrosoftMangleContextImpl::mangleCXXName(const NamedDecl *D,
2463 raw_ostream &Out) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002464 assert((isa<FunctionDecl>(D) || isa<VarDecl>(D)) &&
2465 "Invalid mangleName() call, argument is not a variable or function!");
2466 assert(!isa<CXXConstructorDecl>(D) && !isa<CXXDestructorDecl>(D) &&
2467 "Invalid mangleName() call on 'structor decl!");
2468
2469 PrettyStackTraceDecl CrashInfo(D, SourceLocation(),
2470 getASTContext().getSourceManager(),
2471 "Mangling declaration");
2472
David Majnemerfebb2722016-03-07 08:51:17 +00002473 msvc_hashing_ostream MHO(Out);
2474 MicrosoftCXXNameMangler Mangler(*this, MHO);
Guy Benyei11169dd2012-12-18 14:30:41 +00002475 return Mangler.mangle(D);
2476}
Timur Iskhodzhanovdf7e7fb2013-07-30 09:46:19 +00002477
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002478// <this-adjustment> ::= <no-adjustment> | <static-adjustment> |
2479// <virtual-adjustment>
2480// <no-adjustment> ::= A # private near
2481// ::= B # private far
2482// ::= I # protected near
2483// ::= J # protected far
2484// ::= Q # public near
2485// ::= R # public far
2486// <static-adjustment> ::= G <static-offset> # private near
2487// ::= H <static-offset> # private far
2488// ::= O <static-offset> # protected near
2489// ::= P <static-offset> # protected far
2490// ::= W <static-offset> # public near
2491// ::= X <static-offset> # public far
2492// <virtual-adjustment> ::= $0 <virtual-shift> <static-offset> # private near
2493// ::= $1 <virtual-shift> <static-offset> # private far
2494// ::= $2 <virtual-shift> <static-offset> # protected near
2495// ::= $3 <virtual-shift> <static-offset> # protected far
2496// ::= $4 <virtual-shift> <static-offset> # public near
2497// ::= $5 <virtual-shift> <static-offset> # public far
2498// <virtual-shift> ::= <vtordisp-shift> | <vtordispex-shift>
2499// <vtordisp-shift> ::= <offset-to-vtordisp>
2500// <vtordispex-shift> ::= <offset-to-vbptr> <vbase-offset-offset>
2501// <offset-to-vtordisp>
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00002502static void mangleThunkThisAdjustment(const CXXMethodDecl *MD,
2503 const ThisAdjustment &Adjustment,
2504 MicrosoftCXXNameMangler &Mangler,
2505 raw_ostream &Out) {
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002506 if (!Adjustment.Virtual.isEmpty()) {
2507 Out << '$';
2508 char AccessSpec;
2509 switch (MD->getAccess()) {
2510 case AS_none:
2511 llvm_unreachable("Unsupported access specifier");
2512 case AS_private:
2513 AccessSpec = '0';
2514 break;
2515 case AS_protected:
2516 AccessSpec = '2';
2517 break;
2518 case AS_public:
2519 AccessSpec = '4';
2520 }
2521 if (Adjustment.Virtual.Microsoft.VBPtrOffset) {
2522 Out << 'R' << AccessSpec;
David Majnemer2a816452013-12-09 10:44:32 +00002523 Mangler.mangleNumber(
2524 static_cast<uint32_t>(Adjustment.Virtual.Microsoft.VBPtrOffset));
2525 Mangler.mangleNumber(
2526 static_cast<uint32_t>(Adjustment.Virtual.Microsoft.VBOffsetOffset));
2527 Mangler.mangleNumber(
2528 static_cast<uint32_t>(Adjustment.Virtual.Microsoft.VtordispOffset));
2529 Mangler.mangleNumber(static_cast<uint32_t>(Adjustment.NonVirtual));
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002530 } else {
2531 Out << AccessSpec;
David Majnemer2a816452013-12-09 10:44:32 +00002532 Mangler.mangleNumber(
2533 static_cast<uint32_t>(Adjustment.Virtual.Microsoft.VtordispOffset));
2534 Mangler.mangleNumber(-static_cast<uint32_t>(Adjustment.NonVirtual));
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002535 }
2536 } else if (Adjustment.NonVirtual != 0) {
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00002537 switch (MD->getAccess()) {
2538 case AS_none:
2539 llvm_unreachable("Unsupported access specifier");
2540 case AS_private:
2541 Out << 'G';
2542 break;
2543 case AS_protected:
2544 Out << 'O';
2545 break;
2546 case AS_public:
2547 Out << 'W';
2548 }
David Majnemer2a816452013-12-09 10:44:32 +00002549 Mangler.mangleNumber(-static_cast<uint32_t>(Adjustment.NonVirtual));
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00002550 } else {
2551 switch (MD->getAccess()) {
2552 case AS_none:
2553 llvm_unreachable("Unsupported access specifier");
2554 case AS_private:
2555 Out << 'A';
2556 break;
2557 case AS_protected:
2558 Out << 'I';
2559 break;
2560 case AS_public:
2561 Out << 'Q';
2562 }
2563 }
2564}
2565
Reid Kleckner96f8f932014-02-05 17:27:08 +00002566void
2567MicrosoftMangleContextImpl::mangleVirtualMemPtrThunk(const CXXMethodDecl *MD,
2568 raw_ostream &Out) {
2569 MicrosoftVTableContext *VTContext =
2570 cast<MicrosoftVTableContext>(getASTContext().getVTableContext());
2571 const MicrosoftVTableContext::MethodVFTableLocation &ML =
2572 VTContext->getMethodVFTableLocation(GlobalDecl(MD));
Hans Wennborg88497d62013-11-15 17:24:45 +00002573
David Majnemerfebb2722016-03-07 08:51:17 +00002574 msvc_hashing_ostream MHO(Out);
2575 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002576 Mangler.getStream() << "\01?";
2577 Mangler.mangleVirtualMemPtrThunk(MD, ML);
Hans Wennborg88497d62013-11-15 17:24:45 +00002578}
2579
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00002580void MicrosoftMangleContextImpl::mangleThunk(const CXXMethodDecl *MD,
2581 const ThunkInfo &Thunk,
2582 raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00002583 msvc_hashing_ostream MHO(Out);
2584 MicrosoftCXXNameMangler Mangler(*this, MHO);
2585 Mangler.getStream() << "\01?";
Timur Iskhodzhanovdf7e7fb2013-07-30 09:46:19 +00002586 Mangler.mangleName(MD);
David Majnemerfebb2722016-03-07 08:51:17 +00002587 mangleThunkThisAdjustment(MD, Thunk.This, Mangler, MHO);
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00002588 if (!Thunk.Return.isEmpty())
Craig Topper36250ad2014-05-12 05:36:57 +00002589 assert(Thunk.Method != nullptr &&
2590 "Thunk info should hold the overridee decl");
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00002591
2592 const CXXMethodDecl *DeclForFPT = Thunk.Method ? Thunk.Method : MD;
2593 Mangler.mangleFunctionType(
2594 DeclForFPT->getType()->castAs<FunctionProtoType>(), MD);
Guy Benyei11169dd2012-12-18 14:30:41 +00002595}
Timur Iskhodzhanovdf7e7fb2013-07-30 09:46:19 +00002596
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00002597void MicrosoftMangleContextImpl::mangleCXXDtorThunk(
2598 const CXXDestructorDecl *DD, CXXDtorType Type,
2599 const ThisAdjustment &Adjustment, raw_ostream &Out) {
2600 // FIXME: Actually, the dtor thunk should be emitted for vector deleting
2601 // dtors rather than scalar deleting dtors. Just use the vector deleting dtor
2602 // mangling manually until we support both deleting dtor types.
2603 assert(Type == Dtor_Deleting);
David Majnemerfebb2722016-03-07 08:51:17 +00002604 msvc_hashing_ostream MHO(Out);
2605 MicrosoftCXXNameMangler Mangler(*this, MHO, DD, Type);
2606 Mangler.getStream() << "\01??_E";
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00002607 Mangler.mangleName(DD->getParent());
David Majnemerfebb2722016-03-07 08:51:17 +00002608 mangleThunkThisAdjustment(DD, Adjustment, Mangler, MHO);
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00002609 Mangler.mangleFunctionType(DD->getType()->castAs<FunctionProtoType>(), DD);
Guy Benyei11169dd2012-12-18 14:30:41 +00002610}
Reid Kleckner7810af02013-06-19 15:20:38 +00002611
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00002612void MicrosoftMangleContextImpl::mangleCXXVFTable(
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00002613 const CXXRecordDecl *Derived, ArrayRef<const CXXRecordDecl *> BasePath,
2614 raw_ostream &Out) {
Reid Kleckner7810af02013-06-19 15:20:38 +00002615 // <mangled-name> ::= ?_7 <class-name> <storage-class>
2616 // <cvr-qualifiers> [<name>] @
Guy Benyei11169dd2012-12-18 14:30:41 +00002617 // NOTE: <cvr-qualifiers> here is always 'B' (const). <storage-class>
Reid Kleckner7810af02013-06-19 15:20:38 +00002618 // is always '6' for vftables.
David Majnemerfebb2722016-03-07 08:51:17 +00002619 msvc_hashing_ostream MHO(Out);
2620 MicrosoftCXXNameMangler Mangler(*this, MHO);
David Majnemer2d8b2002016-02-11 17:49:28 +00002621 if (Derived->hasAttr<DLLImportAttr>())
2622 Mangler.getStream() << "\01??_S";
2623 else
2624 Mangler.getStream() << "\01??_7";
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00002625 Mangler.mangleName(Derived);
2626 Mangler.getStream() << "6B"; // '6' for vftable, 'B' for const.
David Majnemerb926dbc2014-04-23 05:16:53 +00002627 for (const CXXRecordDecl *RD : BasePath)
2628 Mangler.mangleName(RD);
Guy Benyei11169dd2012-12-18 14:30:41 +00002629 Mangler.getStream() << '@';
2630}
Reid Kleckner7810af02013-06-19 15:20:38 +00002631
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00002632void MicrosoftMangleContextImpl::mangleCXXVBTable(
Reid Kleckner7810af02013-06-19 15:20:38 +00002633 const CXXRecordDecl *Derived, ArrayRef<const CXXRecordDecl *> BasePath,
2634 raw_ostream &Out) {
2635 // <mangled-name> ::= ?_8 <class-name> <storage-class>
2636 // <cvr-qualifiers> [<name>] @
2637 // NOTE: <cvr-qualifiers> here is always 'B' (const). <storage-class>
2638 // is always '7' for vbtables.
David Majnemerfebb2722016-03-07 08:51:17 +00002639 msvc_hashing_ostream MHO(Out);
2640 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Kleckner7810af02013-06-19 15:20:38 +00002641 Mangler.getStream() << "\01??_8";
2642 Mangler.mangleName(Derived);
2643 Mangler.getStream() << "7B"; // '7' for vbtable, 'B' for const.
David Majnemerb926dbc2014-04-23 05:16:53 +00002644 for (const CXXRecordDecl *RD : BasePath)
2645 Mangler.mangleName(RD);
Reid Kleckner7810af02013-06-19 15:20:38 +00002646 Mangler.getStream() << '@';
2647}
2648
David Majnemera96b7ee2014-05-13 00:44:44 +00002649void MicrosoftMangleContextImpl::mangleCXXRTTI(QualType T, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00002650 msvc_hashing_ostream MHO(Out);
2651 MicrosoftCXXNameMangler Mangler(*this, MHO);
David Majnemera96b7ee2014-05-13 00:44:44 +00002652 Mangler.getStream() << "\01??_R0";
2653 Mangler.mangleType(T, SourceRange(), MicrosoftCXXNameMangler::QMM_Result);
2654 Mangler.getStream() << "@8";
Guy Benyei11169dd2012-12-18 14:30:41 +00002655}
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00002656
David Majnemera96b7ee2014-05-13 00:44:44 +00002657void MicrosoftMangleContextImpl::mangleCXXRTTIName(QualType T,
2658 raw_ostream &Out) {
2659 MicrosoftCXXNameMangler Mangler(*this, Out);
2660 Mangler.getStream() << '.';
2661 Mangler.mangleType(T, SourceRange(), MicrosoftCXXNameMangler::QMM_Result);
2662}
2663
David Majnemerc1709d32015-06-23 07:31:11 +00002664void MicrosoftMangleContextImpl::mangleCXXVirtualDisplacementMap(
2665 const CXXRecordDecl *SrcRD, const CXXRecordDecl *DstRD, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00002666 msvc_hashing_ostream MHO(Out);
2667 MicrosoftCXXNameMangler Mangler(*this, MHO);
David Majnemerc1709d32015-06-23 07:31:11 +00002668 Mangler.getStream() << "\01??_K";
2669 Mangler.mangleName(SrcRD);
2670 Mangler.getStream() << "$C";
2671 Mangler.mangleName(DstRD);
2672}
2673
David Majnemer526793d2016-07-12 04:42:50 +00002674void MicrosoftMangleContextImpl::mangleCXXThrowInfo(QualType T, bool IsConst,
David Majnemer7c237072015-03-05 00:46:22 +00002675 bool IsVolatile,
David Majnemer526793d2016-07-12 04:42:50 +00002676 bool IsUnaligned,
David Majnemer7c237072015-03-05 00:46:22 +00002677 uint32_t NumEntries,
2678 raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00002679 msvc_hashing_ostream MHO(Out);
2680 MicrosoftCXXNameMangler Mangler(*this, MHO);
David Majnemer7c237072015-03-05 00:46:22 +00002681 Mangler.getStream() << "_TI";
2682 if (IsConst)
2683 Mangler.getStream() << 'C';
2684 if (IsVolatile)
2685 Mangler.getStream() << 'V';
David Majnemer526793d2016-07-12 04:42:50 +00002686 if (IsUnaligned)
2687 Mangler.getStream() << 'U';
David Majnemer7c237072015-03-05 00:46:22 +00002688 Mangler.getStream() << NumEntries;
2689 Mangler.mangleType(T, SourceRange(), MicrosoftCXXNameMangler::QMM_Result);
2690}
2691
2692void MicrosoftMangleContextImpl::mangleCXXCatchableTypeArray(
2693 QualType T, uint32_t NumEntries, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00002694 msvc_hashing_ostream MHO(Out);
2695 MicrosoftCXXNameMangler Mangler(*this, MHO);
David Majnemer7c237072015-03-05 00:46:22 +00002696 Mangler.getStream() << "_CTA";
2697 Mangler.getStream() << NumEntries;
2698 Mangler.mangleType(T, SourceRange(), MicrosoftCXXNameMangler::QMM_Result);
2699}
2700
David Majnemere7a818f2015-03-06 18:53:55 +00002701void MicrosoftMangleContextImpl::mangleCXXCatchableType(
David Majnemerdfa6d202015-03-11 18:36:39 +00002702 QualType T, const CXXConstructorDecl *CD, CXXCtorType CT, uint32_t Size,
2703 uint32_t NVOffset, int32_t VBPtrOffset, uint32_t VBIndex,
2704 raw_ostream &Out) {
David Majnemer7c237072015-03-05 00:46:22 +00002705 MicrosoftCXXNameMangler Mangler(*this, Out);
David Majnemere7a818f2015-03-06 18:53:55 +00002706 Mangler.getStream() << "_CT";
2707
2708 llvm::SmallString<64> RTTIMangling;
2709 {
2710 llvm::raw_svector_ostream Stream(RTTIMangling);
David Majnemerfebb2722016-03-07 08:51:17 +00002711 msvc_hashing_ostream MHO(Stream);
2712 mangleCXXRTTI(T, MHO);
David Majnemere7a818f2015-03-06 18:53:55 +00002713 }
2714 Mangler.getStream() << RTTIMangling.substr(1);
2715
David Majnemer999cbf92015-03-10 19:01:51 +00002716 // VS2015 CTP6 omits the copy-constructor in the mangled name. This name is,
2717 // in fact, superfluous but I'm not sure the change was made consciously.
David Majnemere7a818f2015-03-06 18:53:55 +00002718 llvm::SmallString<64> CopyCtorMangling;
David Majnemerfebb2722016-03-07 08:51:17 +00002719 if (!getASTContext().getLangOpts().isCompatibleWithMSVC(
2720 LangOptions::MSVC2015) &&
2721 CD) {
David Majnemere7a818f2015-03-06 18:53:55 +00002722 llvm::raw_svector_ostream Stream(CopyCtorMangling);
David Majnemerfebb2722016-03-07 08:51:17 +00002723 msvc_hashing_ostream MHO(Stream);
2724 mangleCXXCtor(CD, CT, MHO);
David Majnemere7a818f2015-03-06 18:53:55 +00002725 }
2726 Mangler.getStream() << CopyCtorMangling.substr(1);
2727
David Majnemer7c237072015-03-05 00:46:22 +00002728 Mangler.getStream() << Size;
David Majnemer999cbf92015-03-10 19:01:51 +00002729 if (VBPtrOffset == -1) {
2730 if (NVOffset) {
2731 Mangler.getStream() << NVOffset;
2732 }
2733 } else {
2734 Mangler.getStream() << NVOffset;
2735 Mangler.getStream() << VBPtrOffset;
2736 Mangler.getStream() << VBIndex;
2737 }
David Majnemer7c237072015-03-05 00:46:22 +00002738}
2739
David Majnemera96b7ee2014-05-13 00:44:44 +00002740void MicrosoftMangleContextImpl::mangleCXXRTTIBaseClassDescriptor(
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00002741 const CXXRecordDecl *Derived, uint32_t NVOffset, int32_t VBPtrOffset,
David Majnemeraeb55c92014-05-13 06:57:43 +00002742 uint32_t VBTableOffset, uint32_t Flags, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00002743 msvc_hashing_ostream MHO(Out);
2744 MicrosoftCXXNameMangler Mangler(*this, MHO);
David Majnemera96b7ee2014-05-13 00:44:44 +00002745 Mangler.getStream() << "\01??_R1";
David Majnemera96b7ee2014-05-13 00:44:44 +00002746 Mangler.mangleNumber(NVOffset);
2747 Mangler.mangleNumber(VBPtrOffset);
2748 Mangler.mangleNumber(VBTableOffset);
2749 Mangler.mangleNumber(Flags);
David Majnemeraeb55c92014-05-13 06:57:43 +00002750 Mangler.mangleName(Derived);
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00002751 Mangler.getStream() << "8";
David Majnemera96b7ee2014-05-13 00:44:44 +00002752}
2753
2754void MicrosoftMangleContextImpl::mangleCXXRTTIBaseClassArray(
2755 const CXXRecordDecl *Derived, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00002756 msvc_hashing_ostream MHO(Out);
2757 MicrosoftCXXNameMangler Mangler(*this, MHO);
David Majnemera96b7ee2014-05-13 00:44:44 +00002758 Mangler.getStream() << "\01??_R2";
2759 Mangler.mangleName(Derived);
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00002760 Mangler.getStream() << "8";
David Majnemera96b7ee2014-05-13 00:44:44 +00002761}
2762
2763void MicrosoftMangleContextImpl::mangleCXXRTTIClassHierarchyDescriptor(
2764 const CXXRecordDecl *Derived, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00002765 msvc_hashing_ostream MHO(Out);
2766 MicrosoftCXXNameMangler Mangler(*this, MHO);
David Majnemera96b7ee2014-05-13 00:44:44 +00002767 Mangler.getStream() << "\01??_R3";
2768 Mangler.mangleName(Derived);
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00002769 Mangler.getStream() << "8";
David Majnemera96b7ee2014-05-13 00:44:44 +00002770}
2771
2772void MicrosoftMangleContextImpl::mangleCXXRTTICompleteObjectLocator(
David Majnemeraeb55c92014-05-13 06:57:43 +00002773 const CXXRecordDecl *Derived, ArrayRef<const CXXRecordDecl *> BasePath,
2774 raw_ostream &Out) {
2775 // <mangled-name> ::= ?_R4 <class-name> <storage-class>
2776 // <cvr-qualifiers> [<name>] @
2777 // NOTE: <cvr-qualifiers> here is always 'B' (const). <storage-class>
2778 // is always '6' for vftables.
David Majnemerfebb2722016-03-07 08:51:17 +00002779 llvm::SmallString<64> VFTableMangling;
2780 llvm::raw_svector_ostream Stream(VFTableMangling);
2781 mangleCXXVFTable(Derived, BasePath, Stream);
2782
2783 if (VFTableMangling.startswith("\01??@")) {
2784 assert(VFTableMangling.endswith("@"));
2785 Out << VFTableMangling << "??_R4@";
2786 return;
2787 }
2788
2789 assert(VFTableMangling.startswith("\01??_7") ||
2790 VFTableMangling.startswith("\01??_S"));
2791
2792 Out << "\01??_R4" << StringRef(VFTableMangling).drop_front(5);
Guy Benyei11169dd2012-12-18 14:30:41 +00002793}
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00002794
Reid Kleckner1d59f992015-01-22 01:36:17 +00002795void MicrosoftMangleContextImpl::mangleSEHFilterExpression(
2796 const NamedDecl *EnclosingDecl, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00002797 msvc_hashing_ostream MHO(Out);
2798 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002799 // The function body is in the same comdat as the function with the handler,
2800 // so the numbering here doesn't have to be the same across TUs.
2801 //
2802 // <mangled-name> ::= ?filt$ <filter-number> @0
2803 Mangler.getStream() << "\01?filt$" << SEHFilterIds[EnclosingDecl]++ << "@0@";
2804 Mangler.mangleName(EnclosingDecl);
2805}
2806
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002807void MicrosoftMangleContextImpl::mangleSEHFinallyBlock(
2808 const NamedDecl *EnclosingDecl, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00002809 msvc_hashing_ostream MHO(Out);
2810 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002811 // The function body is in the same comdat as the function with the handler,
2812 // so the numbering here doesn't have to be the same across TUs.
2813 //
2814 // <mangled-name> ::= ?fin$ <filter-number> @0
2815 Mangler.getStream() << "\01?fin$" << SEHFinallyIds[EnclosingDecl]++ << "@0@";
2816 Mangler.mangleName(EnclosingDecl);
2817}
2818
Reid Klecknercc99e262013-11-19 23:23:00 +00002819void MicrosoftMangleContextImpl::mangleTypeName(QualType T, raw_ostream &Out) {
2820 // This is just a made up unique string for the purposes of tbaa. undname
2821 // does *not* know how to demangle it.
2822 MicrosoftCXXNameMangler Mangler(*this, Out);
2823 Mangler.getStream() << '?';
2824 Mangler.mangleType(T, SourceRange());
2825}
2826
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00002827void MicrosoftMangleContextImpl::mangleCXXCtor(const CXXConstructorDecl *D,
2828 CXXCtorType Type,
2829 raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00002830 msvc_hashing_ostream MHO(Out);
2831 MicrosoftCXXNameMangler mangler(*this, MHO, D, Type);
Guy Benyei11169dd2012-12-18 14:30:41 +00002832 mangler.mangle(D);
2833}
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00002834
2835void MicrosoftMangleContextImpl::mangleCXXDtor(const CXXDestructorDecl *D,
2836 CXXDtorType Type,
2837 raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00002838 msvc_hashing_ostream MHO(Out);
2839 MicrosoftCXXNameMangler mangler(*this, MHO, D, Type);
Guy Benyei11169dd2012-12-18 14:30:41 +00002840 mangler.mangle(D);
2841}
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00002842
David Majnemere77de752015-12-29 22:25:14 +00002843void MicrosoftMangleContextImpl::mangleReferenceTemporary(
2844 const VarDecl *VD, unsigned ManglingNumber, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00002845 msvc_hashing_ostream MHO(Out);
2846 MicrosoftCXXNameMangler Mangler(*this, MHO);
David Majnemere77de752015-12-29 22:25:14 +00002847
2848 Mangler.getStream() << "\01?$RT" << ManglingNumber << '@';
2849 Mangler.mangle(VD, "");
Guy Benyei11169dd2012-12-18 14:30:41 +00002850}
2851
David Majnemer8354eee2015-05-07 06:15:46 +00002852void MicrosoftMangleContextImpl::mangleThreadSafeStaticGuardVariable(
2853 const VarDecl *VD, unsigned GuardNum, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00002854 msvc_hashing_ostream MHO(Out);
2855 MicrosoftCXXNameMangler Mangler(*this, MHO);
David Majnemer8354eee2015-05-07 06:15:46 +00002856
2857 Mangler.getStream() << "\01?$TSS" << GuardNum << '@';
2858 Mangler.mangleNestedName(VD);
Dmitry Polukhin5fa681e2016-05-27 08:52:34 +00002859 Mangler.getStream() << "@4HA";
David Majnemer8354eee2015-05-07 06:15:46 +00002860}
2861
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00002862void MicrosoftMangleContextImpl::mangleStaticGuardVariable(const VarDecl *VD,
2863 raw_ostream &Out) {
David Majnemer2206bf52014-03-05 08:57:59 +00002864 // <guard-name> ::= ?_B <postfix> @5 <scope-depth>
David Majnemerec8e54b2015-05-07 21:19:06 +00002865 // ::= ?__J <postfix> @5 <scope-depth>
Reid Klecknerd8110b62013-09-10 20:14:30 +00002866 // ::= ?$S <guard-num> @ <postfix> @4IA
2867
2868 // The first mangling is what MSVC uses to guard static locals in inline
2869 // functions. It uses a different mangling in external functions to support
2870 // guarding more than 32 variables. MSVC rejects inline functions with more
2871 // than 32 static locals. We don't fully implement the second mangling
2872 // because those guards are not externally visible, and instead use LLVM's
2873 // default renaming when creating a new guard variable.
David Majnemerfebb2722016-03-07 08:51:17 +00002874 msvc_hashing_ostream MHO(Out);
2875 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002876
2877 bool Visible = VD->isExternallyVisible();
David Majnemer8354eee2015-05-07 06:15:46 +00002878 if (Visible) {
David Majnemerec8e54b2015-05-07 21:19:06 +00002879 Mangler.getStream() << (VD->getTLSKind() ? "\01??__J" : "\01??_B");
David Majnemer8354eee2015-05-07 06:15:46 +00002880 } else {
2881 Mangler.getStream() << "\01?$S1@";
2882 }
David Majnemer34b49892014-03-06 19:57:36 +00002883 unsigned ScopeDepth = 0;
2884 if (Visible && !getNextDiscriminator(VD, ScopeDepth))
2885 // If we do not have a discriminator and are emitting a guard variable for
2886 // use at global scope, then mangling the nested name will not be enough to
2887 // remove ambiguities.
2888 Mangler.mangle(VD, "");
2889 else
2890 Mangler.mangleNestedName(VD);
David Majnemer2206bf52014-03-05 08:57:59 +00002891 Mangler.getStream() << (Visible ? "@5" : "@4IA");
David Majnemer34b49892014-03-06 19:57:36 +00002892 if (ScopeDepth)
David Majnemer2206bf52014-03-05 08:57:59 +00002893 Mangler.mangleNumber(ScopeDepth);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002894}
2895
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00002896void MicrosoftMangleContextImpl::mangleInitFiniStub(const VarDecl *D,
David Majnemerfebb2722016-03-07 08:51:17 +00002897 char CharCode,
2898 raw_ostream &Out) {
2899 msvc_hashing_ostream MHO(Out);
2900 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Kleckner1ece9fc2013-09-10 20:43:12 +00002901 Mangler.getStream() << "\01??__" << CharCode;
2902 Mangler.mangleName(D);
David Majnemerf55feec2014-03-06 19:10:27 +00002903 if (D->isStaticDataMember()) {
2904 Mangler.mangleVariableEncoding(D);
2905 Mangler.getStream() << '@';
2906 }
Reid Kleckner1ece9fc2013-09-10 20:43:12 +00002907 // This is the function class mangling. These stubs are global, non-variadic,
2908 // cdecl functions that return void and take no args.
2909 Mangler.getStream() << "YAXXZ";
2910}
2911
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00002912void MicrosoftMangleContextImpl::mangleDynamicInitializer(const VarDecl *D,
2913 raw_ostream &Out) {
Reid Kleckner1ece9fc2013-09-10 20:43:12 +00002914 // <initializer-name> ::= ?__E <name> YAXXZ
David Majnemerfebb2722016-03-07 08:51:17 +00002915 mangleInitFiniStub(D, 'E', Out);
Reid Kleckner1ece9fc2013-09-10 20:43:12 +00002916}
2917
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00002918void
2919MicrosoftMangleContextImpl::mangleDynamicAtExitDestructor(const VarDecl *D,
2920 raw_ostream &Out) {
Reid Kleckner1ece9fc2013-09-10 20:43:12 +00002921 // <destructor-name> ::= ?__F <name> YAXXZ
David Majnemerfebb2722016-03-07 08:51:17 +00002922 mangleInitFiniStub(D, 'F', Out);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002923}
2924
David Majnemer58e5bee2014-03-24 21:43:36 +00002925void MicrosoftMangleContextImpl::mangleStringLiteral(const StringLiteral *SL,
2926 raw_ostream &Out) {
2927 // <char-type> ::= 0 # char
2928 // ::= 1 # wchar_t
2929 // ::= ??? # char16_t/char32_t will need a mangling too...
2930 //
2931 // <literal-length> ::= <non-negative integer> # the length of the literal
2932 //
2933 // <encoded-crc> ::= <hex digit>+ @ # crc of the literal including
2934 // # null-terminator
2935 //
2936 // <encoded-string> ::= <simple character> # uninteresting character
2937 // ::= '?$' <hex digit> <hex digit> # these two nibbles
2938 // # encode the byte for the
2939 // # character
2940 // ::= '?' [a-z] # \xe1 - \xfa
2941 // ::= '?' [A-Z] # \xc1 - \xda
2942 // ::= '?' [0-9] # [,/\:. \n\t'-]
2943 //
2944 // <literal> ::= '??_C@_' <char-type> <literal-length> <encoded-crc>
2945 // <encoded-string> '@'
2946 MicrosoftCXXNameMangler Mangler(*this, Out);
2947 Mangler.getStream() << "\01??_C@_";
2948
2949 // <char-type>: The "kind" of string literal is encoded into the mangled name.
David Majnemer98e77a22014-11-21 19:57:25 +00002950 if (SL->isWide())
David Majnemer58e5bee2014-03-24 21:43:36 +00002951 Mangler.getStream() << '1';
2952 else
David Majnemer98e77a22014-11-21 19:57:25 +00002953 Mangler.getStream() << '0';
David Majnemer58e5bee2014-03-24 21:43:36 +00002954
2955 // <literal-length>: The next part of the mangled name consists of the length
2956 // of the string.
2957 // The StringLiteral does not consider the NUL terminator byte(s) but the
2958 // mangling does.
2959 // N.B. The length is in terms of bytes, not characters.
2960 Mangler.mangleNumber(SL->getByteLength() + SL->getCharByteWidth());
2961
David Majnemer4b293eb2014-03-31 17:18:53 +00002962 auto GetLittleEndianByte = [&Mangler, &SL](unsigned Index) {
2963 unsigned CharByteWidth = SL->getCharByteWidth();
2964 uint32_t CodeUnit = SL->getCodeUnit(Index / CharByteWidth);
David Majnemere49c4b62014-03-31 21:46:05 +00002965 unsigned OffsetInCodeUnit = Index % CharByteWidth;
2966 return static_cast<char>((CodeUnit >> (8 * OffsetInCodeUnit)) & 0xff);
David Majnemer4b293eb2014-03-31 17:18:53 +00002967 };
2968
2969 auto GetBigEndianByte = [&Mangler, &SL](unsigned Index) {
2970 unsigned CharByteWidth = SL->getCharByteWidth();
2971 uint32_t CodeUnit = SL->getCodeUnit(Index / CharByteWidth);
David Majnemere49c4b62014-03-31 21:46:05 +00002972 unsigned OffsetInCodeUnit = (CharByteWidth - 1) - (Index % CharByteWidth);
2973 return static_cast<char>((CodeUnit >> (8 * OffsetInCodeUnit)) & 0xff);
David Majnemer4b293eb2014-03-31 17:18:53 +00002974 };
2975
David Majnemer58e5bee2014-03-24 21:43:36 +00002976 // CRC all the bytes of the StringLiteral.
David Majnemerb8ed3642015-09-01 21:24:07 +00002977 llvm::JamCRC JC;
David Majnemer4b293eb2014-03-31 17:18:53 +00002978 for (unsigned I = 0, E = SL->getByteLength(); I != E; ++I)
David Majnemerb8ed3642015-09-01 21:24:07 +00002979 JC.update(GetLittleEndianByte(I));
David Majnemer58e5bee2014-03-24 21:43:36 +00002980
2981 // The NUL terminator byte(s) were not present earlier,
2982 // we need to manually process those bytes into the CRC.
2983 for (unsigned NullTerminator = 0; NullTerminator < SL->getCharByteWidth();
2984 ++NullTerminator)
David Majnemerb8ed3642015-09-01 21:24:07 +00002985 JC.update('\x00');
David Majnemer58e5bee2014-03-24 21:43:36 +00002986
2987 // <encoded-crc>: The CRC is encoded utilizing the standard number mangling
2988 // scheme.
David Majnemerb8ed3642015-09-01 21:24:07 +00002989 Mangler.mangleNumber(JC.getCRC());
David Majnemer58e5bee2014-03-24 21:43:36 +00002990
David Majnemer981c3062014-03-30 16:38:02 +00002991 // <encoded-string>: The mangled name also contains the first 32 _characters_
David Majnemer58e5bee2014-03-24 21:43:36 +00002992 // (including null-terminator bytes) of the StringLiteral.
2993 // Each character is encoded by splitting them into bytes and then encoding
2994 // the constituent bytes.
2995 auto MangleByte = [&Mangler](char Byte) {
2996 // There are five different manglings for characters:
2997 // - [a-zA-Z0-9_$]: A one-to-one mapping.
2998 // - ?[a-z]: The range from \xe1 to \xfa.
2999 // - ?[A-Z]: The range from \xc1 to \xda.
3000 // - ?[0-9]: The set of [,/\:. \n\t'-].
3001 // - ?$XX: A fallback which maps nibbles.
David Majnemer10befcf2014-04-01 00:05:57 +00003002 if (isIdentifierBody(Byte, /*AllowDollar=*/true)) {
David Majnemer58e5bee2014-03-24 21:43:36 +00003003 Mangler.getStream() << Byte;
David Majnemer10befcf2014-04-01 00:05:57 +00003004 } else if (isLetter(Byte & 0x7f)) {
3005 Mangler.getStream() << '?' << static_cast<char>(Byte & 0x7f);
David Majnemer58e5bee2014-03-24 21:43:36 +00003006 } else {
David Majnemer07bc6112014-12-22 06:24:49 +00003007 const char SpecialChars[] = {',', '/', '\\', ':', '.',
3008 ' ', '\n', '\t', '\'', '-'};
3009 const char *Pos =
3010 std::find(std::begin(SpecialChars), std::end(SpecialChars), Byte);
3011 if (Pos != std::end(SpecialChars)) {
3012 Mangler.getStream() << '?' << (Pos - std::begin(SpecialChars));
3013 } else {
3014 Mangler.getStream() << "?$";
3015 Mangler.getStream() << static_cast<char>('A' + ((Byte >> 4) & 0xf));
3016 Mangler.getStream() << static_cast<char>('A' + (Byte & 0xf));
David Majnemer58e5bee2014-03-24 21:43:36 +00003017 }
3018 }
3019 };
3020
David Majnemer58e5bee2014-03-24 21:43:36 +00003021 // Enforce our 32 character max.
3022 unsigned NumCharsToMangle = std::min(32U, SL->getLength());
David Majnemer4b293eb2014-03-31 17:18:53 +00003023 for (unsigned I = 0, E = NumCharsToMangle * SL->getCharByteWidth(); I != E;
3024 ++I)
David Majnemer98e77a22014-11-21 19:57:25 +00003025 if (SL->isWide())
3026 MangleByte(GetBigEndianByte(I));
3027 else
3028 MangleByte(GetLittleEndianByte(I));
David Majnemer58e5bee2014-03-24 21:43:36 +00003029
3030 // Encode the NUL terminator if there is room.
3031 if (NumCharsToMangle < 32)
David Majnemer4b293eb2014-03-31 17:18:53 +00003032 for (unsigned NullTerminator = 0; NullTerminator < SL->getCharByteWidth();
3033 ++NullTerminator)
3034 MangleByte(0);
David Majnemer58e5bee2014-03-24 21:43:36 +00003035
3036 Mangler.getStream() << '@';
3037}
3038
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003039MicrosoftMangleContext *
3040MicrosoftMangleContext::create(ASTContext &Context, DiagnosticsEngine &Diags) {
3041 return new MicrosoftMangleContextImpl(Context, Diags);
Guy Benyei11169dd2012-12-18 14:30:41 +00003042}