blob: 007a358957f87207d8074bf011f7d90479f941c3 [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 Majnemer984498f2016-12-06 17:01:02 +000069static const DeclContext *
70getLambdaDefaultArgumentDeclContext(const Decl *D) {
71 if (const auto *RD = dyn_cast<CXXRecordDecl>(D))
72 if (RD->isLambda())
73 if (const auto *Parm =
74 dyn_cast_or_null<ParmVarDecl>(RD->getLambdaContextDecl()))
75 return Parm->getDeclContext();
76 return nullptr;
77}
78
David Majnemerd5a42b82013-09-13 09:03:14 +000079/// \brief Retrieve the declaration context that should be used when mangling
80/// the given declaration.
81static const DeclContext *getEffectiveDeclContext(const Decl *D) {
82 // The ABI assumes that lambda closure types that occur within
83 // default arguments live in the context of the function. However, due to
84 // the way in which Clang parses and creates function declarations, this is
85 // not the case: the lambda closure type ends up living in the context
86 // where the function itself resides, because the function declaration itself
87 // had not yet been created. Fix the context here.
David Majnemer984498f2016-12-06 17:01:02 +000088 if (const auto *LDADC = getLambdaDefaultArgumentDeclContext(D))
89 return LDADC;
David Majnemerd5a42b82013-09-13 09:03:14 +000090
91 // Perform the same check for block literals.
92 if (const BlockDecl *BD = dyn_cast<BlockDecl>(D)) {
93 if (ParmVarDecl *ContextParam =
94 dyn_cast_or_null<ParmVarDecl>(BD->getBlockManglingContextDecl()))
95 return ContextParam->getDeclContext();
96 }
97
98 const DeclContext *DC = D->getDeclContext();
Alexey Bataev94a4f0c2016-03-03 05:21:39 +000099 if (isa<CapturedDecl>(DC) || isa<OMPDeclareReductionDecl>(DC)) {
100 return getEffectiveDeclContext(cast<Decl>(DC));
101 }
David Majnemerd5a42b82013-09-13 09:03:14 +0000102
David Majnemerb0f1dbd2016-05-19 18:15:53 +0000103 return DC->getRedeclContext();
David Majnemerd5a42b82013-09-13 09:03:14 +0000104}
105
106static const DeclContext *getEffectiveParentContext(const DeclContext *DC) {
107 return getEffectiveDeclContext(cast<Decl>(DC));
108}
109
David Majnemerdfa6d202015-03-11 18:36:39 +0000110static const FunctionDecl *getStructor(const NamedDecl *ND) {
111 if (const auto *FTD = dyn_cast<FunctionTemplateDecl>(ND))
Reid Kleckner290feb92017-01-09 17:04:37 +0000112 return FTD->getTemplatedDecl()->getCanonicalDecl();
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +0000113
David Majnemerdfa6d202015-03-11 18:36:39 +0000114 const auto *FD = cast<FunctionDecl>(ND);
115 if (const auto *FTD = FD->getPrimaryTemplate())
Reid Kleckner290feb92017-01-09 17:04:37 +0000116 return FTD->getTemplatedDecl()->getCanonicalDecl();
David Majnemerdfa6d202015-03-11 18:36:39 +0000117
Reid Kleckner290feb92017-01-09 17:04:37 +0000118 return FD->getCanonicalDecl();
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +0000119}
120
Timur Iskhodzhanov67455222013-10-03 06:26:13 +0000121/// MicrosoftMangleContextImpl - Overrides the default MangleContext for the
Guy Benyei11169dd2012-12-18 14:30:41 +0000122/// Microsoft Visual C++ ABI.
Timur Iskhodzhanov67455222013-10-03 06:26:13 +0000123class MicrosoftMangleContextImpl : public MicrosoftMangleContext {
David Majnemer2206bf52014-03-05 08:57:59 +0000124 typedef std::pair<const DeclContext *, IdentifierInfo *> DiscriminatorKeyTy;
125 llvm::DenseMap<DiscriminatorKeyTy, unsigned> Discriminator;
David Majnemer02e9af42014-04-23 05:16:51 +0000126 llvm::DenseMap<const NamedDecl *, unsigned> Uniquifier;
David Majnemerf017ec32014-03-05 10:35:06 +0000127 llvm::DenseMap<const CXXRecordDecl *, unsigned> LambdaIds;
Reid Kleckner1d59f992015-01-22 01:36:17 +0000128 llvm::DenseMap<const NamedDecl *, unsigned> SEHFilterIds;
Reid Klecknerebaf28d2015-04-14 20:59:00 +0000129 llvm::DenseMap<const NamedDecl *, unsigned> SEHFinallyIds;
David Majnemer2206bf52014-03-05 08:57:59 +0000130
Guy Benyei11169dd2012-12-18 14:30:41 +0000131public:
Timur Iskhodzhanov67455222013-10-03 06:26:13 +0000132 MicrosoftMangleContextImpl(ASTContext &Context, DiagnosticsEngine &Diags)
133 : MicrosoftMangleContext(Context, Diags) {}
Craig Toppercbce6e92014-03-11 06:22:39 +0000134 bool shouldMangleCXXName(const NamedDecl *D) override;
David Majnemer58e5bee2014-03-24 21:43:36 +0000135 bool shouldMangleStringLiteral(const StringLiteral *SL) override;
Craig Toppercbce6e92014-03-11 06:22:39 +0000136 void mangleCXXName(const NamedDecl *D, raw_ostream &Out) override;
David Majnemer02e9af42014-04-23 05:16:51 +0000137 void mangleVirtualMemPtrThunk(const CXXMethodDecl *MD,
138 raw_ostream &) override;
Craig Toppercbce6e92014-03-11 06:22:39 +0000139 void mangleThunk(const CXXMethodDecl *MD, const ThunkInfo &Thunk,
140 raw_ostream &) override;
141 void mangleCXXDtorThunk(const CXXDestructorDecl *DD, CXXDtorType Type,
142 const ThisAdjustment &ThisAdjustment,
143 raw_ostream &) override;
144 void mangleCXXVFTable(const CXXRecordDecl *Derived,
145 ArrayRef<const CXXRecordDecl *> BasePath,
146 raw_ostream &Out) override;
147 void mangleCXXVBTable(const CXXRecordDecl *Derived,
148 ArrayRef<const CXXRecordDecl *> BasePath,
149 raw_ostream &Out) override;
David Majnemerc1709d32015-06-23 07:31:11 +0000150 void mangleCXXVirtualDisplacementMap(const CXXRecordDecl *SrcRD,
151 const CXXRecordDecl *DstRD,
152 raw_ostream &Out) override;
David Majnemer7c237072015-03-05 00:46:22 +0000153 void mangleCXXThrowInfo(QualType T, bool IsConst, bool IsVolatile,
David Majnemer526793d2016-07-12 04:42:50 +0000154 bool IsUnaligned, uint32_t NumEntries,
155 raw_ostream &Out) override;
David Majnemer7c237072015-03-05 00:46:22 +0000156 void mangleCXXCatchableTypeArray(QualType T, uint32_t NumEntries,
157 raw_ostream &Out) override;
David Majnemere7a818f2015-03-06 18:53:55 +0000158 void mangleCXXCatchableType(QualType T, const CXXConstructorDecl *CD,
David Majnemerdfa6d202015-03-11 18:36:39 +0000159 CXXCtorType CT, uint32_t Size, uint32_t NVOffset,
David Majnemer999cbf92015-03-10 19:01:51 +0000160 int32_t VBPtrOffset, uint32_t VBIndex,
161 raw_ostream &Out) override;
David Majnemera96b7ee2014-05-13 00:44:44 +0000162 void mangleCXXRTTI(QualType T, raw_ostream &Out) override;
163 void mangleCXXRTTIName(QualType T, raw_ostream &Out) override;
David Majnemeraeb55c92014-05-13 06:57:43 +0000164 void mangleCXXRTTIBaseClassDescriptor(const CXXRecordDecl *Derived,
Warren Hunt5c2b4ea2014-05-23 16:07:43 +0000165 uint32_t NVOffset, int32_t VBPtrOffset,
David Majnemeraeb55c92014-05-13 06:57:43 +0000166 uint32_t VBTableOffset, uint32_t Flags,
167 raw_ostream &Out) override;
David Majnemera96b7ee2014-05-13 00:44:44 +0000168 void mangleCXXRTTIBaseClassArray(const CXXRecordDecl *Derived,
169 raw_ostream &Out) override;
170 void mangleCXXRTTIClassHierarchyDescriptor(const CXXRecordDecl *Derived,
171 raw_ostream &Out) override;
David Majnemeraeb55c92014-05-13 06:57:43 +0000172 void
173 mangleCXXRTTICompleteObjectLocator(const CXXRecordDecl *Derived,
174 ArrayRef<const CXXRecordDecl *> BasePath,
175 raw_ostream &Out) override;
Craig Toppercbce6e92014-03-11 06:22:39 +0000176 void mangleTypeName(QualType T, raw_ostream &) override;
177 void mangleCXXCtor(const CXXConstructorDecl *D, CXXCtorType Type,
178 raw_ostream &) override;
179 void mangleCXXDtor(const CXXDestructorDecl *D, CXXDtorType Type,
180 raw_ostream &) override;
David Majnemerdaff3702014-05-01 17:50:17 +0000181 void mangleReferenceTemporary(const VarDecl *, unsigned ManglingNumber,
182 raw_ostream &) override;
Craig Toppercbce6e92014-03-11 06:22:39 +0000183 void mangleStaticGuardVariable(const VarDecl *D, raw_ostream &Out) override;
David Majnemer8354eee2015-05-07 06:15:46 +0000184 void mangleThreadSafeStaticGuardVariable(const VarDecl *D, unsigned GuardNum,
185 raw_ostream &Out) override;
Craig Toppercbce6e92014-03-11 06:22:39 +0000186 void mangleDynamicInitializer(const VarDecl *D, raw_ostream &Out) override;
187 void mangleDynamicAtExitDestructor(const VarDecl *D,
188 raw_ostream &Out) override;
Reid Kleckner1d59f992015-01-22 01:36:17 +0000189 void mangleSEHFilterExpression(const NamedDecl *EnclosingDecl,
190 raw_ostream &Out) override;
Reid Klecknerebaf28d2015-04-14 20:59:00 +0000191 void mangleSEHFinallyBlock(const NamedDecl *EnclosingDecl,
192 raw_ostream &Out) override;
David Majnemer58e5bee2014-03-24 21:43:36 +0000193 void mangleStringLiteral(const StringLiteral *SL, raw_ostream &Out) override;
David Majnemer2206bf52014-03-05 08:57:59 +0000194 bool getNextDiscriminator(const NamedDecl *ND, unsigned &disc) {
David Majnemer2206bf52014-03-05 08:57:59 +0000195 const DeclContext *DC = getEffectiveDeclContext(ND);
196 if (!DC->isFunctionOrMethod())
197 return false;
198
David Majnemer41311192016-01-17 07:09:24 +0000199 // Lambda closure types are already numbered, give out a phony number so
200 // that they demangle nicely.
David Majnemer984498f2016-12-06 17:01:02 +0000201 if (const auto *RD = dyn_cast<CXXRecordDecl>(ND)) {
202 if (RD->isLambda()) {
203 disc = 1;
204 return true;
205 }
David Majnemer41311192016-01-17 07:09:24 +0000206 }
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:
Reid Kleckner290feb92017-01-09 17:04:37 +0000315 bool isStructorDecl(const NamedDecl *ND) const {
316 return ND == Structor || getStructor(ND) == Structor;
317 }
318
David Majnemer2206bf52014-03-05 08:57:59 +0000319 void mangleUnqualifiedName(const NamedDecl *ND) {
320 mangleUnqualifiedName(ND, ND->getDeclName());
321 }
322 void mangleUnqualifiedName(const NamedDecl *ND, DeclarationName Name);
323 void mangleSourceName(StringRef Name);
324 void mangleOperatorName(OverloadedOperatorKind OO, SourceLocation Loc);
325 void mangleCXXDtorType(CXXDtorType T);
326 void mangleQualifiers(Qualifiers Quals, bool IsMember);
David Majnemere3785bb2014-04-23 05:16:56 +0000327 void mangleRefQualifier(RefQualifierKind RefQualifier);
David Majnemer2206bf52014-03-05 08:57:59 +0000328 void manglePointerCVQualifiers(Qualifiers Quals);
David Majnemer7a3ce0c2015-05-26 01:30:45 +0000329 void manglePointerExtQualifiers(Qualifiers Quals, QualType PointeeType);
David Majnemer2206bf52014-03-05 08:57:59 +0000330
331 void mangleUnscopedTemplateName(const TemplateDecl *ND);
David Majnemer02e9af42014-04-23 05:16:51 +0000332 void
333 mangleTemplateInstantiationName(const TemplateDecl *TD,
334 const TemplateArgumentList &TemplateArgs);
David Majnemer2206bf52014-03-05 08:57:59 +0000335 void mangleObjCMethodName(const ObjCMethodDecl *MD);
336
337 void mangleArgumentType(QualType T, SourceRange Range);
David Majnemer5f177622015-12-30 05:13:03 +0000338 void manglePassObjectSizeArg(const PassObjectSizeAttr *POSA);
David Majnemer2206bf52014-03-05 08:57:59 +0000339
340 // Declare manglers for every type class.
341#define ABSTRACT_TYPE(CLASS, PARENT)
342#define NON_CANONICAL_TYPE(CLASS, PARENT)
343#define TYPE(CLASS, PARENT) void mangleType(const CLASS##Type *T, \
David Majnemer7a3ce0c2015-05-26 01:30:45 +0000344 Qualifiers Quals, \
David Majnemer2206bf52014-03-05 08:57:59 +0000345 SourceRange Range);
346#include "clang/AST/TypeNodes.def"
347#undef ABSTRACT_TYPE
348#undef NON_CANONICAL_TYPE
349#undef TYPE
350
351 void mangleType(const TagDecl *TD);
352 void mangleDecayedArrayType(const ArrayType *T);
353 void mangleArrayType(const ArrayType *T);
354 void mangleFunctionClass(const FunctionDecl *FD);
David Majnemerdfa6d202015-03-11 18:36:39 +0000355 void mangleCallingConvention(CallingConv CC);
David Majnemer2206bf52014-03-05 08:57:59 +0000356 void mangleCallingConvention(const FunctionType *T);
357 void mangleIntegerLiteral(const llvm::APSInt &Number, bool IsBoolean);
358 void mangleExpression(const Expr *E);
359 void mangleThrowSpecification(const FunctionProtoType *T);
360
361 void mangleTemplateArgs(const TemplateDecl *TD,
362 const TemplateArgumentList &TemplateArgs);
David Majnemer57fbc0c2014-08-05 22:43:45 +0000363 void mangleTemplateArg(const TemplateDecl *TD, const TemplateArgument &TA,
364 const NamedDecl *Parm);
David Majnemer2206bf52014-03-05 08:57:59 +0000365};
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000366}
Guy Benyei11169dd2012-12-18 14:30:41 +0000367
Rafael Espindola002667c2013-10-16 01:40:34 +0000368bool MicrosoftMangleContextImpl::shouldMangleCXXName(const NamedDecl *D) {
David Majnemerd5a42b82013-09-13 09:03:14 +0000369 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
370 LanguageLinkage L = FD->getLanguageLinkage();
371 // Overloadable functions need mangling.
372 if (FD->hasAttr<OverloadableAttr>())
373 return true;
374
David Majnemerc729b0b2013-09-16 22:44:20 +0000375 // The ABI expects that we would never mangle "typical" user-defined entry
376 // points regardless of visibility or freestanding-ness.
377 //
378 // N.B. This is distinct from asking about "main". "main" has a lot of
379 // special rules associated with it in the standard while these
380 // user-defined entry points are outside of the purview of the standard.
381 // For example, there can be only one definition for "main" in a standards
382 // compliant program; however nothing forbids the existence of wmain and
383 // WinMain in the same translation unit.
384 if (FD->isMSVCRTEntryPoint())
David Majnemerd5a42b82013-09-13 09:03:14 +0000385 return false;
386
387 // C++ functions and those whose names are not a simple identifier need
388 // mangling.
389 if (!FD->getDeclName().isIdentifier() || L == CXXLanguageLinkage)
390 return true;
391
392 // C functions are not mangled.
393 if (L == CLanguageLinkage)
394 return false;
395 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000396
397 // Otherwise, no mangling is done outside C++ mode.
398 if (!getASTContext().getLangOpts().CPlusPlus)
399 return false;
400
Richard Smithda383632016-08-15 01:33:41 +0000401 const VarDecl *VD = dyn_cast<VarDecl>(D);
402 if (VD && !isa<DecompositionDecl>(D)) {
David Majnemerd5a42b82013-09-13 09:03:14 +0000403 // C variables are not mangled.
404 if (VD->isExternC())
405 return false;
406
407 // Variables at global scope with non-internal linkage are not mangled.
408 const DeclContext *DC = getEffectiveDeclContext(D);
409 // Check for extern variable declared locally.
410 if (DC->isFunctionOrMethod() && D->hasLinkage())
411 while (!DC->isNamespace() && !DC->isTranslationUnit())
412 DC = getEffectiveParentContext(DC);
413
414 if (DC->isTranslationUnit() && D->getFormalLinkage() == InternalLinkage &&
David Majnemeree6c4092015-10-22 07:15:56 +0000415 !isa<VarTemplateSpecializationDecl>(D) &&
416 D->getIdentifier() != nullptr)
Guy Benyei11169dd2012-12-18 14:30:41 +0000417 return false;
418 }
419
Guy Benyei11169dd2012-12-18 14:30:41 +0000420 return true;
421}
422
David Majnemer58e5bee2014-03-24 21:43:36 +0000423bool
424MicrosoftMangleContextImpl::shouldMangleStringLiteral(const StringLiteral *SL) {
David Majnemer6fc2d812014-11-22 06:20:38 +0000425 return true;
David Majnemer58e5bee2014-03-24 21:43:36 +0000426}
427
David Majnemer02e9af42014-04-23 05:16:51 +0000428void MicrosoftCXXNameMangler::mangle(const NamedDecl *D, StringRef Prefix) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000429 // MSVC doesn't mangle C++ names the same way it mangles extern "C" names.
430 // Therefore it's really important that we don't decorate the
431 // name with leading underscores or leading/trailing at signs. So, by
432 // default, we emit an asm marker at the start so we get the name right.
433 // Callers can override this with a custom prefix.
434
Guy Benyei11169dd2012-12-18 14:30:41 +0000435 // <mangled-name> ::= ? <name> <type-encoding>
436 Out << Prefix;
437 mangleName(D);
438 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
David Majnemerab4b4a12015-05-18 00:05:25 +0000439 mangleFunctionEncoding(FD, Context.shouldMangleDeclName(FD));
Guy Benyei11169dd2012-12-18 14:30:41 +0000440 else if (const VarDecl *VD = dyn_cast<VarDecl>(D))
441 mangleVariableEncoding(VD);
David Majnemer53b60a12015-12-29 22:02:10 +0000442 else
443 llvm_unreachable("Tried to mangle unexpected NamedDecl!");
Guy Benyei11169dd2012-12-18 14:30:41 +0000444}
445
David Majnemerab4b4a12015-05-18 00:05:25 +0000446void MicrosoftCXXNameMangler::mangleFunctionEncoding(const FunctionDecl *FD,
447 bool ShouldMangle) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000448 // <type-encoding> ::= <function-class> <function-type>
449
Reid Kleckner18da98e2013-06-24 19:21:52 +0000450 // Since MSVC operates on the type as written and not the canonical type, it
451 // actually matters which decl we have here. MSVC appears to choose the
452 // first, since it is most likely to be the declaration in a header file.
Rafael Espindola8db352d2013-10-17 15:37:26 +0000453 FD = FD->getFirstDecl();
Reid Kleckner18da98e2013-06-24 19:21:52 +0000454
Guy Benyei11169dd2012-12-18 14:30:41 +0000455 // We should never ever see a FunctionNoProtoType at this point.
456 // We don't even know how to mangle their types anyway :).
Reid Kleckner9a7f3e62013-10-08 00:58:57 +0000457 const FunctionProtoType *FT = FD->getType()->castAs<FunctionProtoType>();
Guy Benyei11169dd2012-12-18 14:30:41 +0000458
David Majnemerd5a42b82013-09-13 09:03:14 +0000459 // extern "C" functions can hold entities that must be mangled.
460 // As it stands, these functions still need to get expressed in the full
461 // external name. They have their class and type omitted, replaced with '9'.
David Majnemerab4b4a12015-05-18 00:05:25 +0000462 if (ShouldMangle) {
David Majnemer5a7cfea2015-05-18 00:05:29 +0000463 // We would like to mangle all extern "C" functions using this additional
464 // component but this would break compatibility with MSVC's behavior.
465 // Instead, do this when we know that compatibility isn't important (in
Eric Christopherbe528662015-12-16 23:10:46 +0000466 // other words, when it is an overloaded extern "C" function).
David Majnemer5a7cfea2015-05-18 00:05:29 +0000467 if (FD->isExternC() && FD->hasAttr<OverloadableAttr>())
468 Out << "$$J0";
469
David Majnemerd5a42b82013-09-13 09:03:14 +0000470 mangleFunctionClass(FD);
Guy Benyei11169dd2012-12-18 14:30:41 +0000471
Timur Iskhodzhanov555a7722013-10-04 11:25:05 +0000472 mangleFunctionType(FT, FD);
David Majnemerab4b4a12015-05-18 00:05:25 +0000473 } else {
David Majnemerd5a42b82013-09-13 09:03:14 +0000474 Out << '9';
David Majnemerab4b4a12015-05-18 00:05:25 +0000475 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000476}
477
478void MicrosoftCXXNameMangler::mangleVariableEncoding(const VarDecl *VD) {
479 // <type-encoding> ::= <storage-class> <variable-type>
480 // <storage-class> ::= 0 # private static member
481 // ::= 1 # protected static member
482 // ::= 2 # public static member
483 // ::= 3 # global
484 // ::= 4 # static local
David Majnemerb4119f72013-12-13 01:06:04 +0000485
Guy Benyei11169dd2012-12-18 14:30:41 +0000486 // The first character in the encoding (after the name) is the storage class.
487 if (VD->isStaticDataMember()) {
488 // If it's a static member, it also encodes the access level.
489 switch (VD->getAccess()) {
490 default:
491 case AS_private: Out << '0'; break;
492 case AS_protected: Out << '1'; break;
493 case AS_public: Out << '2'; break;
494 }
495 }
496 else if (!VD->isStaticLocal())
497 Out << '3';
498 else
499 Out << '4';
500 // Now mangle the type.
501 // <variable-type> ::= <type> <cvr-qualifiers>
502 // ::= <type> <pointee-cvr-qualifiers> # pointers, references
503 // Pointers and references are odd. The type of 'int * const foo;' gets
504 // mangled as 'QAHA' instead of 'PAHB', for example.
Zachary Turner87422d92014-06-25 05:37:25 +0000505 SourceRange SR = VD->getSourceRange();
David Majnemerb9a5f2d2014-01-21 20:33:36 +0000506 QualType Ty = VD->getType();
David Majnemer6dda7bb2013-08-15 08:13:23 +0000507 if (Ty->isPointerType() || Ty->isReferenceType() ||
508 Ty->isMemberPointerType()) {
Zachary Turner87422d92014-06-25 05:37:25 +0000509 mangleType(Ty, SR, QMM_Drop);
David Majnemer8eec58f2014-02-18 14:20:10 +0000510 manglePointerExtQualifiers(
David Majnemer7a3ce0c2015-05-26 01:30:45 +0000511 Ty.getDesugaredType(getASTContext()).getLocalQualifiers(), QualType());
David Majnemer6dda7bb2013-08-15 08:13:23 +0000512 if (const MemberPointerType *MPT = Ty->getAs<MemberPointerType>()) {
513 mangleQualifiers(MPT->getPointeeType().getQualifiers(), true);
514 // Member pointers are suffixed with a back reference to the member
515 // pointer's class name.
516 mangleName(MPT->getClass()->getAsCXXRecordDecl());
517 } else
518 mangleQualifiers(Ty->getPointeeType().getQualifiers(), false);
David Majnemera2724ae2013-08-09 05:56:24 +0000519 } else if (const ArrayType *AT = getASTContext().getAsArrayType(Ty)) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000520 // Global arrays are funny, too.
David Majnemer5a1b2042013-09-11 04:44:30 +0000521 mangleDecayedArrayType(AT);
Peter Collingbourne2816c022013-04-25 04:25:40 +0000522 if (AT->getElementType()->isArrayType())
523 Out << 'A';
524 else
525 mangleQualifiers(Ty.getQualifiers(), false);
Guy Benyei11169dd2012-12-18 14:30:41 +0000526 } else {
Zachary Turner87422d92014-06-25 05:37:25 +0000527 mangleType(Ty, SR, QMM_Drop);
Will Wilson5f383672014-11-05 13:54:21 +0000528 mangleQualifiers(Ty.getQualifiers(), false);
Guy Benyei11169dd2012-12-18 14:30:41 +0000529 }
530}
531
Reid Kleckner96f8f932014-02-05 17:27:08 +0000532void MicrosoftCXXNameMangler::mangleMemberDataPointer(const CXXRecordDecl *RD,
David Majnemer1e378e42014-02-06 12:46:52 +0000533 const ValueDecl *VD) {
Reid Kleckner96f8f932014-02-05 17:27:08 +0000534 // <member-data-pointer> ::= <integer-literal>
535 // ::= $F <number> <number>
536 // ::= $G <number> <number> <number>
537
David Majnemer763584d2014-02-06 10:59:19 +0000538 int64_t FieldOffset;
539 int64_t VBTableOffset;
Reid Kleckner96f8f932014-02-05 17:27:08 +0000540 MSInheritanceAttr::Spelling IM = RD->getMSInheritanceModel();
David Majnemer1e378e42014-02-06 12:46:52 +0000541 if (VD) {
542 FieldOffset = getASTContext().getFieldOffset(VD);
David Majnemer763584d2014-02-06 10:59:19 +0000543 assert(FieldOffset % getASTContext().getCharWidth() == 0 &&
Reid Kleckner96f8f932014-02-05 17:27:08 +0000544 "cannot take address of bitfield");
David Majnemer763584d2014-02-06 10:59:19 +0000545 FieldOffset /= getASTContext().getCharWidth();
546
547 VBTableOffset = 0;
David Majnemer08ef2ba2015-06-23 20:34:18 +0000548
549 if (IM == MSInheritanceAttr::Keyword_virtual_inheritance)
550 FieldOffset -= getASTContext().getOffsetOfBaseWithVBPtr(RD).getQuantity();
David Majnemer763584d2014-02-06 10:59:19 +0000551 } else {
552 FieldOffset = RD->nullFieldOffsetIsZero() ? 0 : -1;
553
554 VBTableOffset = -1;
Reid Kleckner96f8f932014-02-05 17:27:08 +0000555 }
556
David Majnemer763584d2014-02-06 10:59:19 +0000557 char Code = '\0';
Reid Kleckner96f8f932014-02-05 17:27:08 +0000558 switch (IM) {
David Majnemer763584d2014-02-06 10:59:19 +0000559 case MSInheritanceAttr::Keyword_single_inheritance: Code = '0'; break;
560 case MSInheritanceAttr::Keyword_multiple_inheritance: Code = '0'; break;
561 case MSInheritanceAttr::Keyword_virtual_inheritance: Code = 'F'; break;
562 case MSInheritanceAttr::Keyword_unspecified_inheritance: Code = 'G'; break;
Reid Kleckner96f8f932014-02-05 17:27:08 +0000563 }
564
David Majnemer763584d2014-02-06 10:59:19 +0000565 Out << '$' << Code;
Reid Kleckner96f8f932014-02-05 17:27:08 +0000566
David Majnemer763584d2014-02-06 10:59:19 +0000567 mangleNumber(FieldOffset);
568
Reid Klecknerbf94e6e2014-04-07 18:07:03 +0000569 // The C++ standard doesn't allow base-to-derived member pointer conversions
570 // in template parameter contexts, so the vbptr offset of data member pointers
571 // is always zero.
David Majnemer763584d2014-02-06 10:59:19 +0000572 if (MSInheritanceAttr::hasVBPtrOffsetField(IM))
Reid Kleckner96f8f932014-02-05 17:27:08 +0000573 mangleNumber(0);
David Majnemer763584d2014-02-06 10:59:19 +0000574 if (MSInheritanceAttr::hasVBTableOffsetField(IM))
575 mangleNumber(VBTableOffset);
Reid Kleckner96f8f932014-02-05 17:27:08 +0000576}
577
578void
579MicrosoftCXXNameMangler::mangleMemberFunctionPointer(const CXXRecordDecl *RD,
580 const CXXMethodDecl *MD) {
581 // <member-function-pointer> ::= $1? <name>
582 // ::= $H? <name> <number>
583 // ::= $I? <name> <number> <number>
584 // ::= $J? <name> <number> <number> <number>
Reid Kleckner96f8f932014-02-05 17:27:08 +0000585
586 MSInheritanceAttr::Spelling IM = RD->getMSInheritanceModel();
587
Reid Kleckner96f8f932014-02-05 17:27:08 +0000588 char Code = '\0';
589 switch (IM) {
590 case MSInheritanceAttr::Keyword_single_inheritance: Code = '1'; break;
591 case MSInheritanceAttr::Keyword_multiple_inheritance: Code = 'H'; break;
592 case MSInheritanceAttr::Keyword_virtual_inheritance: Code = 'I'; break;
593 case MSInheritanceAttr::Keyword_unspecified_inheritance: Code = 'J'; break;
594 }
595
Reid Kleckner96f8f932014-02-05 17:27:08 +0000596 // If non-virtual, mangle the name. If virtual, mangle as a virtual memptr
597 // thunk.
598 uint64_t NVOffset = 0;
599 uint64_t VBTableOffset = 0;
Reid Klecknerbf94e6e2014-04-07 18:07:03 +0000600 uint64_t VBPtrOffset = 0;
David Majnemer6a729c62014-06-11 04:55:08 +0000601 if (MD) {
602 Out << '$' << Code << '?';
603 if (MD->isVirtual()) {
604 MicrosoftVTableContext *VTContext =
605 cast<MicrosoftVTableContext>(getASTContext().getVTableContext());
606 const MicrosoftVTableContext::MethodVFTableLocation &ML =
607 VTContext->getMethodVFTableLocation(GlobalDecl(MD));
608 mangleVirtualMemPtrThunk(MD, ML);
609 NVOffset = ML.VFPtrOffset.getQuantity();
610 VBTableOffset = ML.VBTableIndex * 4;
611 if (ML.VBase) {
612 const ASTRecordLayout &Layout = getASTContext().getASTRecordLayout(RD);
613 VBPtrOffset = Layout.getVBPtrOffset().getQuantity();
614 }
615 } else {
616 mangleName(MD);
David Majnemerab4b4a12015-05-18 00:05:25 +0000617 mangleFunctionEncoding(MD, /*ShouldMangle=*/true);
Reid Kleckner96f8f932014-02-05 17:27:08 +0000618 }
David Majnemer08ef2ba2015-06-23 20:34:18 +0000619
620 if (VBTableOffset == 0 &&
621 IM == MSInheritanceAttr::Keyword_virtual_inheritance)
622 NVOffset -= getASTContext().getOffsetOfBaseWithVBPtr(RD).getQuantity();
Reid Kleckner96f8f932014-02-05 17:27:08 +0000623 } else {
David Majnemer6a729c62014-06-11 04:55:08 +0000624 // Null single inheritance member functions are encoded as a simple nullptr.
625 if (IM == MSInheritanceAttr::Keyword_single_inheritance) {
626 Out << "$0A@";
627 return;
628 }
629 if (IM == MSInheritanceAttr::Keyword_unspecified_inheritance)
630 VBTableOffset = -1;
631 Out << '$' << Code;
Reid Kleckner96f8f932014-02-05 17:27:08 +0000632 }
633
634 if (MSInheritanceAttr::hasNVOffsetField(/*IsMemberFunction=*/true, IM))
David Majnemer08ef2ba2015-06-23 20:34:18 +0000635 mangleNumber(static_cast<uint32_t>(NVOffset));
Reid Kleckner96f8f932014-02-05 17:27:08 +0000636 if (MSInheritanceAttr::hasVBPtrOffsetField(IM))
Reid Klecknerbf94e6e2014-04-07 18:07:03 +0000637 mangleNumber(VBPtrOffset);
Reid Kleckner96f8f932014-02-05 17:27:08 +0000638 if (MSInheritanceAttr::hasVBTableOffsetField(IM))
639 mangleNumber(VBTableOffset);
640}
641
642void MicrosoftCXXNameMangler::mangleVirtualMemPtrThunk(
643 const CXXMethodDecl *MD,
644 const MicrosoftVTableContext::MethodVFTableLocation &ML) {
645 // Get the vftable offset.
646 CharUnits PointerWidth = getASTContext().toCharUnitsFromBits(
647 getASTContext().getTargetInfo().getPointerWidth(0));
648 uint64_t OffsetInVFTable = ML.Index * PointerWidth.getQuantity();
649
650 Out << "?_9";
651 mangleName(MD->getParent());
652 Out << "$B";
653 mangleNumber(OffsetInVFTable);
654 Out << 'A';
David Majnemerbc02d322015-03-14 06:34:41 +0000655 mangleCallingConvention(MD->getType()->getAs<FunctionProtoType>());
Reid Kleckner96f8f932014-02-05 17:27:08 +0000656}
657
Guy Benyei11169dd2012-12-18 14:30:41 +0000658void MicrosoftCXXNameMangler::mangleName(const NamedDecl *ND) {
659 // <name> ::= <unscoped-name> {[<named-scope>]+ | [<nested-name>]}? @
Guy Benyei11169dd2012-12-18 14:30:41 +0000660
661 // Always start with the unqualified name.
David Majnemerb4119f72013-12-13 01:06:04 +0000662 mangleUnqualifiedName(ND);
Guy Benyei11169dd2012-12-18 14:30:41 +0000663
David Majnemer2206bf52014-03-05 08:57:59 +0000664 mangleNestedName(ND);
Guy Benyei11169dd2012-12-18 14:30:41 +0000665
666 // Terminate the whole name with an '@'.
667 Out << '@';
668}
669
David Majnemer2a816452013-12-09 10:44:32 +0000670void MicrosoftCXXNameMangler::mangleNumber(int64_t Number) {
671 // <non-negative integer> ::= A@ # when Number == 0
672 // ::= <decimal digit> # when 1 <= Number <= 10
673 // ::= <hex digit>+ @ # when Number >= 10
674 //
675 // <number> ::= [?] <non-negative integer>
Guy Benyei11169dd2012-12-18 14:30:41 +0000676
David Majnemer2a816452013-12-09 10:44:32 +0000677 uint64_t Value = static_cast<uint64_t>(Number);
678 if (Number < 0) {
679 Value = -Value;
Guy Benyei11169dd2012-12-18 14:30:41 +0000680 Out << '?';
Guy Benyei11169dd2012-12-18 14:30:41 +0000681 }
David Majnemer2a816452013-12-09 10:44:32 +0000682
683 if (Value == 0)
684 Out << "A@";
685 else if (Value >= 1 && Value <= 10)
686 Out << (Value - 1);
687 else {
688 // Numbers that are not encoded as decimal digits are represented as nibbles
689 // in the range of ASCII characters 'A' to 'P'.
690 // The number 0x123450 would be encoded as 'BCDEFA'
691 char EncodedNumberBuffer[sizeof(uint64_t) * 2];
Craig Toppere3d2ecbe2014-06-28 23:22:33 +0000692 MutableArrayRef<char> BufferRef(EncodedNumberBuffer);
693 MutableArrayRef<char>::reverse_iterator I = BufferRef.rbegin();
David Majnemer2a816452013-12-09 10:44:32 +0000694 for (; Value != 0; Value >>= 4)
695 *I++ = 'A' + (Value & 0xf);
696 Out.write(I.base(), I - BufferRef.rbegin());
Guy Benyei11169dd2012-12-18 14:30:41 +0000697 Out << '@';
698 }
699}
700
701static const TemplateDecl *
Reid Kleckner52518862013-03-20 01:40:23 +0000702isTemplate(const NamedDecl *ND, const TemplateArgumentList *&TemplateArgs) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000703 // Check if we have a function template.
David Majnemer02e9af42014-04-23 05:16:51 +0000704 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000705 if (const TemplateDecl *TD = FD->getPrimaryTemplate()) {
Reid Kleckner52518862013-03-20 01:40:23 +0000706 TemplateArgs = FD->getTemplateSpecializationArgs();
Guy Benyei11169dd2012-12-18 14:30:41 +0000707 return TD;
708 }
709 }
710
711 // Check if we have a class template.
712 if (const ClassTemplateSpecializationDecl *Spec =
David Majnemer02e9af42014-04-23 05:16:51 +0000713 dyn_cast<ClassTemplateSpecializationDecl>(ND)) {
Reid Kleckner52518862013-03-20 01:40:23 +0000714 TemplateArgs = &Spec->getTemplateArgs();
Guy Benyei11169dd2012-12-18 14:30:41 +0000715 return Spec->getSpecializedTemplate();
716 }
717
David Majnemer8f774532014-03-04 05:38:05 +0000718 // Check if we have a variable template.
719 if (const VarTemplateSpecializationDecl *Spec =
720 dyn_cast<VarTemplateSpecializationDecl>(ND)) {
721 TemplateArgs = &Spec->getTemplateArgs();
722 return Spec->getSpecializedTemplate();
723 }
724
Craig Topper36250ad2014-05-12 05:36:57 +0000725 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +0000726}
727
David Majnemer02e9af42014-04-23 05:16:51 +0000728void MicrosoftCXXNameMangler::mangleUnqualifiedName(const NamedDecl *ND,
729 DeclarationName Name) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000730 // <unqualified-name> ::= <operator-name>
731 // ::= <ctor-dtor-name>
732 // ::= <source-name>
733 // ::= <template-name>
Reid Kleckner52518862013-03-20 01:40:23 +0000734
Guy Benyei11169dd2012-12-18 14:30:41 +0000735 // Check if we have a template.
Craig Topper36250ad2014-05-12 05:36:57 +0000736 const TemplateArgumentList *TemplateArgs = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +0000737 if (const TemplateDecl *TD = isTemplate(ND, TemplateArgs)) {
Reid Klecknerc16c4472013-07-13 00:43:39 +0000738 // Function templates aren't considered for name back referencing. This
739 // makes sense since function templates aren't likely to occur multiple
740 // times in a symbol.
David Majnemer56e2adb2015-12-30 05:40:32 +0000741 if (isa<FunctionTemplateDecl>(TD)) {
Reid Klecknerc16c4472013-07-13 00:43:39 +0000742 mangleTemplateInstantiationName(TD, *TemplateArgs);
Reid Kleckner11c6f612014-06-26 22:42:18 +0000743 Out << '@';
Reid Klecknerc16c4472013-07-13 00:43:39 +0000744 return;
745 }
746
Guy Benyei11169dd2012-12-18 14:30:41 +0000747 // Here comes the tricky thing: if we need to mangle something like
748 // void foo(A::X<Y>, B::X<Y>),
749 // the X<Y> part is aliased. However, if you need to mangle
750 // void foo(A::X<A::Y>, A::X<B::Y>),
751 // the A::X<> part is not aliased.
752 // That said, from the mangler's perspective we have a structure like this:
753 // namespace[s] -> type[ -> template-parameters]
754 // but from the Clang perspective we have
755 // type [ -> template-parameters]
756 // \-> namespace[s]
757 // What we do is we create a new mangler, mangle the same type (without
David Majnemerc986fcc2014-06-08 04:51:13 +0000758 // a namespace suffix) to a string using the extra mangler and then use
759 // the mangled type name as a key to check the mangling of different types
760 // for aliasing.
Guy Benyei11169dd2012-12-18 14:30:41 +0000761
Reid Kleckner11c6f612014-06-26 22:42:18 +0000762 llvm::SmallString<64> TemplateMangling;
763 llvm::raw_svector_ostream Stream(TemplateMangling);
David Majnemerc986fcc2014-06-08 04:51:13 +0000764 MicrosoftCXXNameMangler Extra(Context, Stream);
765 Extra.mangleTemplateInstantiationName(TD, *TemplateArgs);
Guy Benyei11169dd2012-12-18 14:30:41 +0000766
Reid Kleckner11c6f612014-06-26 22:42:18 +0000767 mangleSourceName(TemplateMangling);
Guy Benyei11169dd2012-12-18 14:30:41 +0000768 return;
769 }
770
771 switch (Name.getNameKind()) {
772 case DeclarationName::Identifier: {
773 if (const IdentifierInfo *II = Name.getAsIdentifierInfo()) {
David Majnemer956bc112013-11-25 17:50:19 +0000774 mangleSourceName(II->getName());
Guy Benyei11169dd2012-12-18 14:30:41 +0000775 break;
776 }
David Majnemerb4119f72013-12-13 01:06:04 +0000777
Guy Benyei11169dd2012-12-18 14:30:41 +0000778 // Otherwise, an anonymous entity. We must have a declaration.
779 assert(ND && "mangling empty name without declaration");
David Majnemerb4119f72013-12-13 01:06:04 +0000780
Guy Benyei11169dd2012-12-18 14:30:41 +0000781 if (const NamespaceDecl *NS = dyn_cast<NamespaceDecl>(ND)) {
782 if (NS->isAnonymousNamespace()) {
783 Out << "?A@";
784 break;
785 }
786 }
David Majnemerb4119f72013-12-13 01:06:04 +0000787
Richard Smithda383632016-08-15 01:33:41 +0000788 if (const DecompositionDecl *DD = dyn_cast<DecompositionDecl>(ND)) {
789 // FIXME: Invented mangling for decomposition declarations:
790 // [X,Y,Z]
791 // where X,Y,Z are the names of the bindings.
792 llvm::SmallString<128> Name("[");
793 for (auto *BD : DD->bindings()) {
794 if (Name.size() > 1)
795 Name += ',';
796 Name += BD->getDeclName().getAsIdentifierInfo()->getName();
797 }
798 Name += ']';
799 mangleSourceName(Name);
800 break;
801 }
802
David Majnemer2206bf52014-03-05 08:57:59 +0000803 if (const VarDecl *VD = dyn_cast<VarDecl>(ND)) {
804 // We must have an anonymous union or struct declaration.
805 const CXXRecordDecl *RD = VD->getType()->getAsCXXRecordDecl();
806 assert(RD && "expected variable decl to have a record type");
807 // Anonymous types with no tag or typedef get the name of their
808 // declarator mangled in. If they have no declarator, number them with
809 // a $S prefix.
810 llvm::SmallString<64> Name("$S");
811 // Get a unique id for the anonymous struct.
812 Name += llvm::utostr(Context.getAnonymousStructId(RD) + 1);
813 mangleSourceName(Name.str());
814 break;
815 }
816
Guy Benyei11169dd2012-12-18 14:30:41 +0000817 // We must have an anonymous struct.
818 const TagDecl *TD = cast<TagDecl>(ND);
819 if (const TypedefNameDecl *D = TD->getTypedefNameForAnonDecl()) {
820 assert(TD->getDeclContext() == D->getDeclContext() &&
821 "Typedef should not be in another decl context!");
822 assert(D->getDeclName().getAsIdentifierInfo() &&
823 "Typedef was not named!");
David Majnemer956bc112013-11-25 17:50:19 +0000824 mangleSourceName(D->getDeclName().getAsIdentifierInfo()->getName());
Guy Benyei11169dd2012-12-18 14:30:41 +0000825 break;
826 }
827
David Majnemerf017ec32014-03-05 10:35:06 +0000828 if (const CXXRecordDecl *Record = dyn_cast<CXXRecordDecl>(TD)) {
829 if (Record->isLambda()) {
830 llvm::SmallString<10> Name("<lambda_");
David Majnemer984498f2016-12-06 17:01:02 +0000831
832 Decl *LambdaContextDecl = Record->getLambdaContextDecl();
833 unsigned LambdaManglingNumber = Record->getLambdaManglingNumber();
David Majnemerf017ec32014-03-05 10:35:06 +0000834 unsigned LambdaId;
David Majnemer984498f2016-12-06 17:01:02 +0000835 const ParmVarDecl *Parm =
836 dyn_cast_or_null<ParmVarDecl>(LambdaContextDecl);
837 const FunctionDecl *Func =
838 Parm ? dyn_cast<FunctionDecl>(Parm->getDeclContext()) : nullptr;
839
840 if (Func) {
841 unsigned DefaultArgNo =
842 Func->getNumParams() - Parm->getFunctionScopeIndex();
843 Name += llvm::utostr(DefaultArgNo);
844 Name += "_";
845 }
846
847 if (LambdaManglingNumber)
848 LambdaId = LambdaManglingNumber;
David Majnemerf017ec32014-03-05 10:35:06 +0000849 else
850 LambdaId = Context.getLambdaId(Record);
851
852 Name += llvm::utostr(LambdaId);
853 Name += ">";
854
855 mangleSourceName(Name);
David Majnemer984498f2016-12-06 17:01:02 +0000856
857 // If the context of a closure type is an initializer for a class
858 // member (static or nonstatic), it is encoded in a qualified name.
859 if (LambdaManglingNumber && LambdaContextDecl) {
860 if ((isa<VarDecl>(LambdaContextDecl) ||
861 isa<FieldDecl>(LambdaContextDecl)) &&
862 LambdaContextDecl->getDeclContext()->isRecord()) {
863 mangleUnqualifiedName(cast<NamedDecl>(LambdaContextDecl));
864 }
865 }
David Majnemerf017ec32014-03-05 10:35:06 +0000866 break;
867 }
868 }
869
David Majnemera5cfddc2016-12-25 05:26:02 +0000870 llvm::SmallString<64> Name;
David Majnemer00350522015-08-31 18:48:39 +0000871 if (DeclaratorDecl *DD =
872 Context.getASTContext().getDeclaratorForUnnamedTagDecl(TD)) {
873 // Anonymous types without a name for linkage purposes have their
David Majnemer2206bf52014-03-05 08:57:59 +0000874 // declarator mangled in if they have one.
David Majnemera5cfddc2016-12-25 05:26:02 +0000875 Name += "<unnamed-type-";
David Majnemer00350522015-08-31 18:48:39 +0000876 Name += DD->getName();
877 } else if (TypedefNameDecl *TND =
878 Context.getASTContext().getTypedefNameForUnnamedTagDecl(
879 TD)) {
880 // Anonymous types without a name for linkage purposes have their
881 // associate typedef mangled in if they have one.
David Majnemera5cfddc2016-12-25 05:26:02 +0000882 Name += "<unnamed-type-";
David Majnemer00350522015-08-31 18:48:39 +0000883 Name += TND->getName();
David Majnemera5cfddc2016-12-25 05:26:02 +0000884 } else if (auto *ED = dyn_cast<EnumDecl>(TD)) {
885 auto EnumeratorI = ED->enumerator_begin();
886 assert(EnumeratorI != ED->enumerator_end());
887 Name += "<unnamed-enum-";
888 Name += EnumeratorI->getName();
David Majnemer956bc112013-11-25 17:50:19 +0000889 } else {
David Majnemer2206bf52014-03-05 08:57:59 +0000890 // Otherwise, number the types using a $S prefix.
David Majnemera5cfddc2016-12-25 05:26:02 +0000891 Name += "<unnamed-type-$S";
David Majnemeree6c4092015-10-22 07:15:56 +0000892 Name += llvm::utostr(Context.getAnonymousStructId(TD) + 1);
David Majnemer956bc112013-11-25 17:50:19 +0000893 }
David Majnemer2206bf52014-03-05 08:57:59 +0000894 Name += ">";
895 mangleSourceName(Name.str());
Guy Benyei11169dd2012-12-18 14:30:41 +0000896 break;
897 }
David Majnemerb4119f72013-12-13 01:06:04 +0000898
Guy Benyei11169dd2012-12-18 14:30:41 +0000899 case DeclarationName::ObjCZeroArgSelector:
900 case DeclarationName::ObjCOneArgSelector:
901 case DeclarationName::ObjCMultiArgSelector:
902 llvm_unreachable("Can't mangle Objective-C selector names here!");
David Majnemerb4119f72013-12-13 01:06:04 +0000903
Guy Benyei11169dd2012-12-18 14:30:41 +0000904 case DeclarationName::CXXConstructorName:
Reid Klecknere4bb54a2017-01-09 17:09:59 +0000905 if (isStructorDecl(ND)) {
David Majnemerdfa6d202015-03-11 18:36:39 +0000906 if (StructorType == Ctor_CopyingClosure) {
907 Out << "?_O";
908 return;
909 }
910 if (StructorType == Ctor_DefaultClosure) {
911 Out << "?_F";
912 return;
913 }
Timur Iskhodzhanov57cbe5c2013-02-27 13:46:31 +0000914 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000915 Out << "?0";
David Majnemerdfa6d202015-03-11 18:36:39 +0000916 return;
David Majnemerb4119f72013-12-13 01:06:04 +0000917
Guy Benyei11169dd2012-12-18 14:30:41 +0000918 case DeclarationName::CXXDestructorName:
Reid Kleckner290feb92017-01-09 17:04:37 +0000919 if (isStructorDecl(ND))
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +0000920 // If the named decl is the C++ destructor we're mangling,
921 // use the type we were given.
922 mangleCXXDtorType(static_cast<CXXDtorType>(StructorType));
923 else
Reid Klecknere7de47e2013-07-22 13:51:44 +0000924 // Otherwise, use the base destructor name. This is relevant if a
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +0000925 // class with a destructor is declared within a destructor.
Reid Klecknere7de47e2013-07-22 13:51:44 +0000926 mangleCXXDtorType(Dtor_Base);
Guy Benyei11169dd2012-12-18 14:30:41 +0000927 break;
David Majnemerb4119f72013-12-13 01:06:04 +0000928
Guy Benyei11169dd2012-12-18 14:30:41 +0000929 case DeclarationName::CXXConversionFunctionName:
930 // <operator-name> ::= ?B # (cast)
931 // The target type is encoded as the return type.
932 Out << "?B";
933 break;
David Majnemerb4119f72013-12-13 01:06:04 +0000934
Guy Benyei11169dd2012-12-18 14:30:41 +0000935 case DeclarationName::CXXOperatorName:
936 mangleOperatorName(Name.getCXXOverloadedOperator(), ND->getLocation());
937 break;
David Majnemerb4119f72013-12-13 01:06:04 +0000938
Guy Benyei11169dd2012-12-18 14:30:41 +0000939 case DeclarationName::CXXLiteralOperatorName: {
David Majnemere31a3ed2014-06-04 16:46:26 +0000940 Out << "?__K";
941 mangleSourceName(Name.getCXXLiteralIdentifier()->getName());
Guy Benyei11169dd2012-12-18 14:30:41 +0000942 break;
943 }
David Majnemerb4119f72013-12-13 01:06:04 +0000944
Richard Smith35845152017-02-07 01:37:30 +0000945 case DeclarationName::CXXDeductionGuideName:
946 llvm_unreachable("Can't mangle a deduction guide name!");
947
Guy Benyei11169dd2012-12-18 14:30:41 +0000948 case DeclarationName::CXXUsingDirective:
949 llvm_unreachable("Can't mangle a using directive name!");
950 }
951}
952
David Majnemer2206bf52014-03-05 08:57:59 +0000953void MicrosoftCXXNameMangler::mangleNestedName(const NamedDecl *ND) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000954 // <postfix> ::= <unqualified-name> [<postfix>]
955 // ::= <substitution> [<postfix>]
David Majnemerff9075f2014-08-06 03:12:47 +0000956 const DeclContext *DC = getEffectiveDeclContext(ND);
Guy Benyei11169dd2012-12-18 14:30:41 +0000957
David Majnemer2206bf52014-03-05 08:57:59 +0000958 while (!DC->isTranslationUnit()) {
959 if (isa<TagDecl>(ND) || isa<VarDecl>(ND)) {
960 unsigned Disc;
961 if (Context.getNextDiscriminator(ND, Disc)) {
962 Out << '?';
963 mangleNumber(Disc);
964 Out << '?';
965 }
966 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000967
David Majnemer2206bf52014-03-05 08:57:59 +0000968 if (const BlockDecl *BD = dyn_cast<BlockDecl>(DC)) {
Alp Tokerc7dc0622014-05-11 22:10:52 +0000969 DiagnosticsEngine &Diags = Context.getDiags();
David Majnemer2206bf52014-03-05 08:57:59 +0000970 unsigned DiagID =
971 Diags.getCustomDiagID(DiagnosticsEngine::Error,
972 "cannot mangle a local inside this block yet");
973 Diags.Report(BD->getLocation(), DiagID);
974
975 // FIXME: This is completely, utterly, wrong; see ItaniumMangle
976 // for how this should be done.
977 Out << "__block_invoke" << Context.getBlockId(BD, false);
978 Out << '@';
David Majnemer2206bf52014-03-05 08:57:59 +0000979 } else if (const ObjCMethodDecl *Method = dyn_cast<ObjCMethodDecl>(DC)) {
980 mangleObjCMethodName(Method);
981 } else if (isa<NamedDecl>(DC)) {
982 ND = cast<NamedDecl>(DC);
983 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)) {
984 mangle(FD, "?");
985 break;
David Majnemer984498f2016-12-06 17:01:02 +0000986 } else {
David Majnemer2206bf52014-03-05 08:57:59 +0000987 mangleUnqualifiedName(ND);
David Majnemer984498f2016-12-06 17:01:02 +0000988 // Lambdas in default arguments conceptually belong to the function the
989 // parameter corresponds to.
990 if (const auto *LDADC = getLambdaDefaultArgumentDeclContext(ND)) {
991 DC = LDADC;
992 continue;
993 }
994 }
David Majnemer2206bf52014-03-05 08:57:59 +0000995 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000996 DC = DC->getParent();
Guy Benyei11169dd2012-12-18 14:30:41 +0000997 }
998}
999
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001000void MicrosoftCXXNameMangler::mangleCXXDtorType(CXXDtorType T) {
Reid Klecknere7de47e2013-07-22 13:51:44 +00001001 // Microsoft uses the names on the case labels for these dtor variants. Clang
1002 // uses the Itanium terminology internally. Everything in this ABI delegates
1003 // towards the base dtor.
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001004 switch (T) {
Reid Klecknere7de47e2013-07-22 13:51:44 +00001005 // <operator-name> ::= ?1 # destructor
1006 case Dtor_Base: Out << "?1"; return;
1007 // <operator-name> ::= ?_D # vbase destructor
1008 case Dtor_Complete: Out << "?_D"; return;
1009 // <operator-name> ::= ?_G # scalar deleting destructor
1010 case Dtor_Deleting: Out << "?_G"; return;
1011 // <operator-name> ::= ?_E # vector deleting destructor
1012 // FIXME: Add a vector deleting dtor type. It goes in the vtable, so we need
1013 // it.
Rafael Espindola1e4df922014-09-16 15:18:21 +00001014 case Dtor_Comdat:
1015 llvm_unreachable("not expecting a COMDAT");
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001016 }
1017 llvm_unreachable("Unsupported dtor type?");
1018}
1019
Guy Benyei11169dd2012-12-18 14:30:41 +00001020void MicrosoftCXXNameMangler::mangleOperatorName(OverloadedOperatorKind OO,
1021 SourceLocation Loc) {
1022 switch (OO) {
1023 // ?0 # constructor
1024 // ?1 # destructor
1025 // <operator-name> ::= ?2 # new
1026 case OO_New: Out << "?2"; break;
1027 // <operator-name> ::= ?3 # delete
1028 case OO_Delete: Out << "?3"; break;
1029 // <operator-name> ::= ?4 # =
1030 case OO_Equal: Out << "?4"; break;
1031 // <operator-name> ::= ?5 # >>
1032 case OO_GreaterGreater: Out << "?5"; break;
1033 // <operator-name> ::= ?6 # <<
1034 case OO_LessLess: Out << "?6"; break;
1035 // <operator-name> ::= ?7 # !
1036 case OO_Exclaim: Out << "?7"; break;
1037 // <operator-name> ::= ?8 # ==
1038 case OO_EqualEqual: Out << "?8"; break;
1039 // <operator-name> ::= ?9 # !=
1040 case OO_ExclaimEqual: Out << "?9"; break;
1041 // <operator-name> ::= ?A # []
1042 case OO_Subscript: Out << "?A"; break;
1043 // ?B # conversion
1044 // <operator-name> ::= ?C # ->
1045 case OO_Arrow: Out << "?C"; break;
1046 // <operator-name> ::= ?D # *
1047 case OO_Star: Out << "?D"; break;
1048 // <operator-name> ::= ?E # ++
1049 case OO_PlusPlus: Out << "?E"; break;
1050 // <operator-name> ::= ?F # --
1051 case OO_MinusMinus: Out << "?F"; break;
1052 // <operator-name> ::= ?G # -
1053 case OO_Minus: Out << "?G"; break;
1054 // <operator-name> ::= ?H # +
1055 case OO_Plus: Out << "?H"; break;
1056 // <operator-name> ::= ?I # &
1057 case OO_Amp: Out << "?I"; break;
1058 // <operator-name> ::= ?J # ->*
1059 case OO_ArrowStar: Out << "?J"; break;
1060 // <operator-name> ::= ?K # /
1061 case OO_Slash: Out << "?K"; break;
1062 // <operator-name> ::= ?L # %
1063 case OO_Percent: Out << "?L"; break;
1064 // <operator-name> ::= ?M # <
1065 case OO_Less: Out << "?M"; break;
1066 // <operator-name> ::= ?N # <=
1067 case OO_LessEqual: Out << "?N"; break;
1068 // <operator-name> ::= ?O # >
1069 case OO_Greater: Out << "?O"; break;
1070 // <operator-name> ::= ?P # >=
1071 case OO_GreaterEqual: Out << "?P"; break;
1072 // <operator-name> ::= ?Q # ,
1073 case OO_Comma: Out << "?Q"; break;
1074 // <operator-name> ::= ?R # ()
1075 case OO_Call: Out << "?R"; break;
1076 // <operator-name> ::= ?S # ~
1077 case OO_Tilde: Out << "?S"; break;
1078 // <operator-name> ::= ?T # ^
1079 case OO_Caret: Out << "?T"; break;
1080 // <operator-name> ::= ?U # |
1081 case OO_Pipe: Out << "?U"; break;
1082 // <operator-name> ::= ?V # &&
1083 case OO_AmpAmp: Out << "?V"; break;
1084 // <operator-name> ::= ?W # ||
1085 case OO_PipePipe: Out << "?W"; break;
1086 // <operator-name> ::= ?X # *=
1087 case OO_StarEqual: Out << "?X"; break;
1088 // <operator-name> ::= ?Y # +=
1089 case OO_PlusEqual: Out << "?Y"; break;
1090 // <operator-name> ::= ?Z # -=
1091 case OO_MinusEqual: Out << "?Z"; break;
1092 // <operator-name> ::= ?_0 # /=
1093 case OO_SlashEqual: Out << "?_0"; break;
1094 // <operator-name> ::= ?_1 # %=
1095 case OO_PercentEqual: Out << "?_1"; break;
1096 // <operator-name> ::= ?_2 # >>=
1097 case OO_GreaterGreaterEqual: Out << "?_2"; break;
1098 // <operator-name> ::= ?_3 # <<=
1099 case OO_LessLessEqual: Out << "?_3"; break;
1100 // <operator-name> ::= ?_4 # &=
1101 case OO_AmpEqual: Out << "?_4"; break;
1102 // <operator-name> ::= ?_5 # |=
1103 case OO_PipeEqual: Out << "?_5"; break;
1104 // <operator-name> ::= ?_6 # ^=
1105 case OO_CaretEqual: Out << "?_6"; break;
1106 // ?_7 # vftable
1107 // ?_8 # vbtable
1108 // ?_9 # vcall
1109 // ?_A # typeof
1110 // ?_B # local static guard
1111 // ?_C # string
1112 // ?_D # vbase destructor
1113 // ?_E # vector deleting destructor
1114 // ?_F # default constructor closure
1115 // ?_G # scalar deleting destructor
1116 // ?_H # vector constructor iterator
1117 // ?_I # vector destructor iterator
1118 // ?_J # vector vbase constructor iterator
1119 // ?_K # virtual displacement map
1120 // ?_L # eh vector constructor iterator
1121 // ?_M # eh vector destructor iterator
1122 // ?_N # eh vector vbase constructor iterator
1123 // ?_O # copy constructor closure
1124 // ?_P<name> # udt returning <name>
1125 // ?_Q # <unknown>
1126 // ?_R0 # RTTI Type Descriptor
1127 // ?_R1 # RTTI Base Class Descriptor at (a,b,c,d)
1128 // ?_R2 # RTTI Base Class Array
1129 // ?_R3 # RTTI Class Hierarchy Descriptor
1130 // ?_R4 # RTTI Complete Object Locator
1131 // ?_S # local vftable
1132 // ?_T # local vftable constructor closure
1133 // <operator-name> ::= ?_U # new[]
1134 case OO_Array_New: Out << "?_U"; break;
1135 // <operator-name> ::= ?_V # delete[]
1136 case OO_Array_Delete: Out << "?_V"; break;
Gor Nishanove2f51be2016-09-28 22:37:17 +00001137 // <operator-name> ::= ?__L # co_await
1138 case OO_Coawait: Out << "?__L"; break;
David Majnemerb4119f72013-12-13 01:06:04 +00001139
Guy Benyei11169dd2012-12-18 14:30:41 +00001140 case OO_Conditional: {
1141 DiagnosticsEngine &Diags = Context.getDiags();
1142 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
1143 "cannot mangle this conditional operator yet");
1144 Diags.Report(Loc, DiagID);
1145 break;
1146 }
David Majnemerb4119f72013-12-13 01:06:04 +00001147
Guy Benyei11169dd2012-12-18 14:30:41 +00001148 case OO_None:
1149 case NUM_OVERLOADED_OPERATORS:
1150 llvm_unreachable("Not an overloaded operator");
1151 }
1152}
1153
David Majnemer956bc112013-11-25 17:50:19 +00001154void MicrosoftCXXNameMangler::mangleSourceName(StringRef Name) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001155 // <source name> ::= <identifier> @
David Majnemer0d0560c2014-09-25 19:43:56 +00001156 BackRefVec::iterator Found =
1157 std::find(NameBackReferences.begin(), NameBackReferences.end(), Name);
David Majnemerc986fcc2014-06-08 04:51:13 +00001158 if (Found == NameBackReferences.end()) {
David Majnemer0d0560c2014-09-25 19:43:56 +00001159 if (NameBackReferences.size() < 10)
1160 NameBackReferences.push_back(Name);
David Majnemer956bc112013-11-25 17:50:19 +00001161 Out << Name << '@';
Guy Benyei11169dd2012-12-18 14:30:41 +00001162 } else {
David Majnemer0d0560c2014-09-25 19:43:56 +00001163 Out << (Found - NameBackReferences.begin());
Guy Benyei11169dd2012-12-18 14:30:41 +00001164 }
1165}
1166
1167void MicrosoftCXXNameMangler::mangleObjCMethodName(const ObjCMethodDecl *MD) {
1168 Context.mangleObjCMethodName(MD, Out);
1169}
1170
Guy Benyei11169dd2012-12-18 14:30:41 +00001171void MicrosoftCXXNameMangler::mangleTemplateInstantiationName(
David Majnemer02e9af42014-04-23 05:16:51 +00001172 const TemplateDecl *TD, const TemplateArgumentList &TemplateArgs) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001173 // <template-name> ::= <unscoped-template-name> <template-args>
1174 // ::= <substitution>
1175 // Always start with the unqualified name.
1176
1177 // Templates have their own context for back references.
1178 ArgBackRefMap OuterArgsContext;
David Majnemer0d0560c2014-09-25 19:43:56 +00001179 BackRefVec OuterTemplateContext;
David Majnemer5f177622015-12-30 05:13:03 +00001180 PassObjectSizeArgsSet OuterPassObjectSizeArgs;
Guy Benyei11169dd2012-12-18 14:30:41 +00001181 NameBackReferences.swap(OuterTemplateContext);
1182 TypeBackReferences.swap(OuterArgsContext);
David Majnemer5f177622015-12-30 05:13:03 +00001183 PassObjectSizeArgs.swap(OuterPassObjectSizeArgs);
Guy Benyei11169dd2012-12-18 14:30:41 +00001184
1185 mangleUnscopedTemplateName(TD);
Reid Kleckner52518862013-03-20 01:40:23 +00001186 mangleTemplateArgs(TD, TemplateArgs);
Guy Benyei11169dd2012-12-18 14:30:41 +00001187
1188 // Restore the previous back reference contexts.
1189 NameBackReferences.swap(OuterTemplateContext);
1190 TypeBackReferences.swap(OuterArgsContext);
David Majnemer5f177622015-12-30 05:13:03 +00001191 PassObjectSizeArgs.swap(OuterPassObjectSizeArgs);
Guy Benyei11169dd2012-12-18 14:30:41 +00001192}
1193
1194void
1195MicrosoftCXXNameMangler::mangleUnscopedTemplateName(const TemplateDecl *TD) {
1196 // <unscoped-template-name> ::= ?$ <unqualified-name>
1197 Out << "?$";
1198 mangleUnqualifiedName(TD);
1199}
1200
David Majnemer02e9af42014-04-23 05:16:51 +00001201void MicrosoftCXXNameMangler::mangleIntegerLiteral(const llvm::APSInt &Value,
1202 bool IsBoolean) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001203 // <integer-literal> ::= $0 <number>
1204 Out << "$0";
1205 // Make sure booleans are encoded as 0/1.
1206 if (IsBoolean && Value.getBoolValue())
1207 mangleNumber(1);
Will Wilsone74c2812014-12-11 05:47:10 +00001208 else if (Value.isSigned())
David Majnemer2a816452013-12-09 10:44:32 +00001209 mangleNumber(Value.getSExtValue());
Will Wilsone74c2812014-12-11 05:47:10 +00001210 else
1211 mangleNumber(Value.getZExtValue());
Guy Benyei11169dd2012-12-18 14:30:41 +00001212}
1213
David Majnemer02e9af42014-04-23 05:16:51 +00001214void MicrosoftCXXNameMangler::mangleExpression(const Expr *E) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001215 // See if this is a constant expression.
1216 llvm::APSInt Value;
1217 if (E->isIntegerConstantExpr(Value, Context.getASTContext())) {
1218 mangleIntegerLiteral(Value, E->getType()->isBooleanType());
1219 return;
1220 }
1221
Reid Klecknerb4848e72014-06-10 20:06:25 +00001222 // Look through no-op casts like template parameter substitutions.
1223 E = E->IgnoreParenNoopCasts(Context.getASTContext());
1224
Craig Topper36250ad2014-05-12 05:36:57 +00001225 const CXXUuidofExpr *UE = nullptr;
David Majnemer8eaab6f2013-08-13 06:32:20 +00001226 if (const UnaryOperator *UO = dyn_cast<UnaryOperator>(E)) {
1227 if (UO->getOpcode() == UO_AddrOf)
1228 UE = dyn_cast<CXXUuidofExpr>(UO->getSubExpr());
1229 } else
1230 UE = dyn_cast<CXXUuidofExpr>(E);
1231
1232 if (UE) {
David Majnemere9cab2f2013-08-13 09:17:25 +00001233 // If we had to peek through an address-of operator, treat this like we are
David Majnemer8eaab6f2013-08-13 06:32:20 +00001234 // dealing with a pointer type. Otherwise, treat it like a const reference.
1235 //
1236 // N.B. This matches up with the handling of TemplateArgument::Declaration
1237 // in mangleTemplateArg
1238 if (UE == E)
1239 Out << "$E?";
1240 else
1241 Out << "$1?";
David Majnemer3add70b2015-12-29 11:45:53 +00001242
1243 // This CXXUuidofExpr is mangled as-if it were actually a VarDecl from
1244 // const __s_GUID _GUID_{lower case UUID with underscores}
David Majnemer2041b462016-03-28 03:19:50 +00001245 StringRef Uuid = UE->getUuidStr();
David Majnemer3add70b2015-12-29 11:45:53 +00001246 std::string Name = "_GUID_" + Uuid.lower();
1247 std::replace(Name.begin(), Name.end(), '-', '_');
1248
1249 mangleSourceName(Name);
1250 // Terminate the whole name with an '@'.
1251 Out << '@';
1252 // It's a global variable.
1253 Out << '3';
1254 // It's a struct called __s_GUID.
1255 mangleArtificalTagType(TTK_Struct, "__s_GUID");
1256 // It's const.
1257 Out << 'B';
David Majnemer8eaab6f2013-08-13 06:32:20 +00001258 return;
1259 }
1260
Guy Benyei11169dd2012-12-18 14:30:41 +00001261 // As bad as this diagnostic is, it's better than crashing.
1262 DiagnosticsEngine &Diags = Context.getDiags();
David Majnemer02e9af42014-04-23 05:16:51 +00001263 unsigned DiagID = Diags.getCustomDiagID(
1264 DiagnosticsEngine::Error, "cannot yet mangle expression type %0");
1265 Diags.Report(E->getExprLoc(), DiagID) << E->getStmtClassName()
1266 << E->getSourceRange();
Guy Benyei11169dd2012-12-18 14:30:41 +00001267}
1268
David Majnemer8265dec2014-03-30 16:30:54 +00001269void MicrosoftCXXNameMangler::mangleTemplateArgs(
1270 const TemplateDecl *TD, const TemplateArgumentList &TemplateArgs) {
Reid Kleckner11c6f612014-06-26 22:42:18 +00001271 // <template-args> ::= <template-arg>+
David Majnemer57fbc0c2014-08-05 22:43:45 +00001272 const TemplateParameterList *TPL = TD->getTemplateParameters();
1273 assert(TPL->size() == TemplateArgs.size() &&
1274 "size mismatch between args and parms!");
1275
1276 unsigned Idx = 0;
David Majnemer8265dec2014-03-30 16:30:54 +00001277 for (const TemplateArgument &TA : TemplateArgs.asArray())
David Majnemer57fbc0c2014-08-05 22:43:45 +00001278 mangleTemplateArg(TD, TA, TPL->getParam(Idx++));
Guy Benyei11169dd2012-12-18 14:30:41 +00001279}
1280
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001281void MicrosoftCXXNameMangler::mangleTemplateArg(const TemplateDecl *TD,
David Majnemer57fbc0c2014-08-05 22:43:45 +00001282 const TemplateArgument &TA,
1283 const NamedDecl *Parm) {
Reid Kleckner96f8f932014-02-05 17:27:08 +00001284 // <template-arg> ::= <type>
1285 // ::= <integer-literal>
1286 // ::= <member-data-pointer>
1287 // ::= <member-function-pointer>
1288 // ::= $E? <name> <type-encoding>
1289 // ::= $1? <name> <type-encoding>
1290 // ::= $0A@
1291 // ::= <template-args>
1292
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001293 switch (TA.getKind()) {
1294 case TemplateArgument::Null:
1295 llvm_unreachable("Can't mangle null template arguments!");
David Majnemer08177c52013-08-27 08:21:25 +00001296 case TemplateArgument::TemplateExpansion:
1297 llvm_unreachable("Can't mangle template expansion arguments!");
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001298 case TemplateArgument::Type: {
1299 QualType T = TA.getAsType();
1300 mangleType(T, SourceRange(), QMM_Escape);
1301 break;
1302 }
David Majnemere8fdc062013-08-13 01:25:35 +00001303 case TemplateArgument::Declaration: {
1304 const NamedDecl *ND = cast<NamedDecl>(TA.getAsDecl());
David Majnemer1e378e42014-02-06 12:46:52 +00001305 if (isa<FieldDecl>(ND) || isa<IndirectFieldDecl>(ND)) {
Reid Klecknere253b092014-02-08 01:15:37 +00001306 mangleMemberDataPointer(
1307 cast<CXXRecordDecl>(ND->getDeclContext())->getMostRecentDecl(),
1308 cast<ValueDecl>(ND));
Reid Kleckner09b47d12014-02-05 18:59:38 +00001309 } else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)) {
Nick Lewycky1f529662014-02-05 23:53:29 +00001310 const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD);
David Majnemerab4b4a12015-05-18 00:05:25 +00001311 if (MD && MD->isInstance()) {
Reid Klecknere253b092014-02-08 01:15:37 +00001312 mangleMemberFunctionPointer(MD->getParent()->getMostRecentDecl(), MD);
David Majnemerab4b4a12015-05-18 00:05:25 +00001313 } else {
1314 Out << "$1?";
1315 mangleName(FD);
1316 mangleFunctionEncoding(FD, /*ShouldMangle=*/true);
1317 }
Reid Kleckner09b47d12014-02-05 18:59:38 +00001318 } else {
David Blaikie952a9b12014-10-17 18:00:12 +00001319 mangle(ND, TA.getParamTypeForDecl()->isReferenceType() ? "$E?" : "$1?");
Reid Kleckner09b47d12014-02-05 18:59:38 +00001320 }
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001321 break;
David Majnemere8fdc062013-08-13 01:25:35 +00001322 }
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001323 case TemplateArgument::Integral:
1324 mangleIntegerLiteral(TA.getAsIntegral(),
1325 TA.getIntegralType()->isBooleanType());
1326 break;
Reid Kleckner96f8f932014-02-05 17:27:08 +00001327 case TemplateArgument::NullPtr: {
1328 QualType T = TA.getNullPtrType();
1329 if (const MemberPointerType *MPT = T->getAs<MemberPointerType>()) {
David Majnemer763584d2014-02-06 10:59:19 +00001330 const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
David Majnemerf3027172015-12-01 19:13:51 +00001331 if (MPT->isMemberFunctionPointerType() &&
1332 !isa<FunctionTemplateDecl>(TD)) {
Craig Topper36250ad2014-05-12 05:36:57 +00001333 mangleMemberFunctionPointer(RD, nullptr);
David Majnemer19187872014-06-11 07:08:37 +00001334 return;
1335 }
1336 if (MPT->isMemberDataPointer()) {
David Majnemerf3027172015-12-01 19:13:51 +00001337 if (!isa<FunctionTemplateDecl>(TD)) {
David Majnemer10236682015-07-02 09:43:11 +00001338 mangleMemberDataPointer(RD, nullptr);
1339 return;
1340 }
1341 // nullptr data pointers are always represented with a single field
1342 // which is initialized with either 0 or -1. Why -1? Well, we need to
1343 // distinguish the case where the data member is at offset zero in the
1344 // record.
1345 // However, we are free to use 0 *if* we would use multiple fields for
1346 // non-nullptr member pointers.
1347 if (!RD->nullFieldOffsetIsZero()) {
1348 mangleIntegerLiteral(llvm::APSInt::get(-1), /*IsBoolean=*/false);
1349 return;
1350 }
David Majnemer19187872014-06-11 07:08:37 +00001351 }
Reid Kleckner96f8f932014-02-05 17:27:08 +00001352 }
David Majnemer10236682015-07-02 09:43:11 +00001353 mangleIntegerLiteral(llvm::APSInt::getUnsigned(0), /*IsBoolean=*/false);
David Majnemerae465ef2013-08-05 21:33:59 +00001354 break;
Reid Kleckner96f8f932014-02-05 17:27:08 +00001355 }
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001356 case TemplateArgument::Expression:
1357 mangleExpression(TA.getAsExpr());
1358 break;
David Majnemer06fa05a2014-06-04 16:46:32 +00001359 case TemplateArgument::Pack: {
Craig Topper00bbdcf2014-06-28 23:22:23 +00001360 ArrayRef<TemplateArgument> TemplateArgs = TA.getPackAsArray();
David Majnemer06fa05a2014-06-04 16:46:32 +00001361 if (TemplateArgs.empty()) {
David Majnemer57fbc0c2014-08-05 22:43:45 +00001362 if (isa<TemplateTypeParmDecl>(Parm) ||
1363 isa<TemplateTemplateParmDecl>(Parm))
David Majnemer4deaac72015-03-18 03:56:27 +00001364 // MSVC 2015 changed the mangling for empty expanded template packs,
1365 // use the old mangling for link compatibility for old versions.
David Majnemerb710a932015-05-11 03:57:49 +00001366 Out << (Context.getASTContext().getLangOpts().isCompatibleWithMSVC(
1367 LangOptions::MSVC2015)
David Majnemer4deaac72015-03-18 03:56:27 +00001368 ? "$$V"
1369 : "$$$V");
David Majnemer57fbc0c2014-08-05 22:43:45 +00001370 else if (isa<NonTypeTemplateParmDecl>(Parm))
1371 Out << "$S";
1372 else
1373 llvm_unreachable("unexpected template parameter decl!");
David Majnemer06fa05a2014-06-04 16:46:32 +00001374 } else {
1375 for (const TemplateArgument &PA : TemplateArgs)
David Majnemer57fbc0c2014-08-05 22:43:45 +00001376 mangleTemplateArg(TD, PA, Parm);
David Majnemer06fa05a2014-06-04 16:46:32 +00001377 }
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001378 break;
David Majnemer06fa05a2014-06-04 16:46:32 +00001379 }
David Majnemer8d5f9ab2014-07-30 08:20:03 +00001380 case TemplateArgument::Template: {
1381 const NamedDecl *ND =
1382 TA.getAsTemplate().getAsTemplateDecl()->getTemplatedDecl();
1383 if (const auto *TD = dyn_cast<TagDecl>(ND)) {
1384 mangleType(TD);
1385 } else if (isa<TypeAliasDecl>(ND)) {
David Majnemer9a3bc592014-08-19 07:29:03 +00001386 Out << "$$Y";
1387 mangleName(ND);
David Majnemer8d5f9ab2014-07-30 08:20:03 +00001388 } else {
1389 llvm_unreachable("unexpected template template NamedDecl!");
1390 }
David Majnemer0db0ca42013-08-05 22:26:46 +00001391 break;
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001392 }
David Majnemer8d5f9ab2014-07-30 08:20:03 +00001393 }
Reid Klecknerf0ae35b2013-07-02 18:10:07 +00001394}
1395
Guy Benyei11169dd2012-12-18 14:30:41 +00001396void MicrosoftCXXNameMangler::mangleQualifiers(Qualifiers Quals,
1397 bool IsMember) {
1398 // <cvr-qualifiers> ::= [E] [F] [I] <base-cvr-qualifiers>
1399 // 'E' means __ptr64 (32-bit only); 'F' means __unaligned (32/64-bit only);
1400 // 'I' means __restrict (32/64-bit).
1401 // Note that the MSVC __restrict keyword isn't the same as the C99 restrict
1402 // keyword!
1403 // <base-cvr-qualifiers> ::= A # near
1404 // ::= B # near const
1405 // ::= C # near volatile
1406 // ::= D # near const volatile
1407 // ::= E # far (16-bit)
1408 // ::= F # far const (16-bit)
1409 // ::= G # far volatile (16-bit)
1410 // ::= H # far const volatile (16-bit)
1411 // ::= I # huge (16-bit)
1412 // ::= J # huge const (16-bit)
1413 // ::= K # huge volatile (16-bit)
1414 // ::= L # huge const volatile (16-bit)
1415 // ::= M <basis> # based
1416 // ::= N <basis> # based const
1417 // ::= O <basis> # based volatile
1418 // ::= P <basis> # based const volatile
1419 // ::= Q # near member
1420 // ::= R # near const member
1421 // ::= S # near volatile member
1422 // ::= T # near const volatile member
1423 // ::= U # far member (16-bit)
1424 // ::= V # far const member (16-bit)
1425 // ::= W # far volatile member (16-bit)
1426 // ::= X # far const volatile member (16-bit)
1427 // ::= Y # huge member (16-bit)
1428 // ::= Z # huge const member (16-bit)
1429 // ::= 0 # huge volatile member (16-bit)
1430 // ::= 1 # huge const volatile member (16-bit)
1431 // ::= 2 <basis> # based member
1432 // ::= 3 <basis> # based const member
1433 // ::= 4 <basis> # based volatile member
1434 // ::= 5 <basis> # based const volatile member
1435 // ::= 6 # near function (pointers only)
1436 // ::= 7 # far function (pointers only)
1437 // ::= 8 # near method (pointers only)
1438 // ::= 9 # far method (pointers only)
1439 // ::= _A <basis> # based function (pointers only)
1440 // ::= _B <basis> # based function (far?) (pointers only)
1441 // ::= _C <basis> # based method (pointers only)
1442 // ::= _D <basis> # based method (far?) (pointers only)
1443 // ::= _E # block (Clang)
1444 // <basis> ::= 0 # __based(void)
1445 // ::= 1 # __based(segment)?
1446 // ::= 2 <name> # __based(name)
1447 // ::= 3 # ?
1448 // ::= 4 # ?
1449 // ::= 5 # not really based
1450 bool HasConst = Quals.hasConst(),
1451 HasVolatile = Quals.hasVolatile();
David Majnemer89594f32013-08-05 22:43:06 +00001452
Guy Benyei11169dd2012-12-18 14:30:41 +00001453 if (!IsMember) {
1454 if (HasConst && HasVolatile) {
1455 Out << 'D';
1456 } else if (HasVolatile) {
1457 Out << 'C';
1458 } else if (HasConst) {
1459 Out << 'B';
1460 } else {
1461 Out << 'A';
1462 }
1463 } else {
1464 if (HasConst && HasVolatile) {
1465 Out << 'T';
1466 } else if (HasVolatile) {
1467 Out << 'S';
1468 } else if (HasConst) {
1469 Out << 'R';
1470 } else {
1471 Out << 'Q';
1472 }
1473 }
1474
1475 // FIXME: For now, just drop all extension qualifiers on the floor.
1476}
1477
David Majnemer8eec58f2014-02-18 14:20:10 +00001478void
David Majnemere3785bb2014-04-23 05:16:56 +00001479MicrosoftCXXNameMangler::mangleRefQualifier(RefQualifierKind RefQualifier) {
1480 // <ref-qualifier> ::= G # lvalue reference
1481 // ::= H # rvalue-reference
1482 switch (RefQualifier) {
1483 case RQ_None:
1484 break;
1485
1486 case RQ_LValue:
1487 Out << 'G';
1488 break;
1489
1490 case RQ_RValue:
1491 Out << 'H';
1492 break;
1493 }
1494}
1495
David Majnemer7a3ce0c2015-05-26 01:30:45 +00001496void MicrosoftCXXNameMangler::manglePointerExtQualifiers(Qualifiers Quals,
1497 QualType PointeeType) {
David Majnemer8eec58f2014-02-18 14:20:10 +00001498 bool HasRestrict = Quals.hasRestrict();
David Majnemer7a3ce0c2015-05-26 01:30:45 +00001499 if (PointersAre64Bit &&
1500 (PointeeType.isNull() || !PointeeType->isFunctionType()))
David Majnemer8eec58f2014-02-18 14:20:10 +00001501 Out << 'E';
1502
1503 if (HasRestrict)
1504 Out << 'I';
Andrey Bokhanko45d41322016-05-11 18:38:21 +00001505
Andrey Bokhanko67a41862016-05-26 10:06:01 +00001506 if (Quals.hasUnaligned() ||
1507 (!PointeeType.isNull() && PointeeType.getLocalQualifiers().hasUnaligned()))
Andrey Bokhanko45d41322016-05-11 18:38:21 +00001508 Out << 'F';
David Majnemer8eec58f2014-02-18 14:20:10 +00001509}
1510
1511void MicrosoftCXXNameMangler::manglePointerCVQualifiers(Qualifiers Quals) {
1512 // <pointer-cv-qualifiers> ::= P # no qualifiers
1513 // ::= Q # const
1514 // ::= R # volatile
1515 // ::= S # const volatile
Guy Benyei11169dd2012-12-18 14:30:41 +00001516 bool HasConst = Quals.hasConst(),
David Majnemer8eec58f2014-02-18 14:20:10 +00001517 HasVolatile = Quals.hasVolatile();
David Majnemer0b6bf8a2014-02-18 12:58:35 +00001518
Guy Benyei11169dd2012-12-18 14:30:41 +00001519 if (HasConst && HasVolatile) {
1520 Out << 'S';
1521 } else if (HasVolatile) {
1522 Out << 'R';
1523 } else if (HasConst) {
1524 Out << 'Q';
1525 } else {
1526 Out << 'P';
1527 }
1528}
1529
1530void MicrosoftCXXNameMangler::mangleArgumentType(QualType T,
1531 SourceRange Range) {
Reid Kleckner18da98e2013-06-24 19:21:52 +00001532 // MSVC will backreference two canonically equivalent types that have slightly
1533 // different manglings when mangled alone.
David Majnemer5a1b2042013-09-11 04:44:30 +00001534
1535 // Decayed types do not match up with non-decayed versions of the same type.
1536 //
1537 // e.g.
1538 // void (*x)(void) will not form a backreference with void x(void)
1539 void *TypePtr;
David Majnemer96183f62015-04-23 05:21:20 +00001540 if (const auto *DT = T->getAs<DecayedType>()) {
1541 QualType OriginalType = DT->getOriginalType();
David Majnemerbdc1fed2015-04-27 03:07:47 +00001542 // All decayed ArrayTypes should be treated identically; as-if they were
1543 // a decayed IncompleteArrayType.
1544 if (const auto *AT = getASTContext().getAsArrayType(OriginalType))
David Majnemer96183f62015-04-23 05:21:20 +00001545 OriginalType = getASTContext().getIncompleteArrayType(
David Majnemerbdc1fed2015-04-27 03:07:47 +00001546 AT->getElementType(), AT->getSizeModifier(),
1547 AT->getIndexTypeCVRQualifiers());
David Majnemer96183f62015-04-23 05:21:20 +00001548
1549 TypePtr = OriginalType.getCanonicalType().getAsOpaquePtr();
David Majnemer5a1b2042013-09-11 04:44:30 +00001550 // If the original parameter was textually written as an array,
1551 // instead treat the decayed parameter like it's const.
1552 //
1553 // e.g.
1554 // int [] -> int * const
David Majnemer96183f62015-04-23 05:21:20 +00001555 if (OriginalType->isArrayType())
David Majnemer5a1b2042013-09-11 04:44:30 +00001556 T = T.withConst();
David Majnemer96183f62015-04-23 05:21:20 +00001557 } else {
David Majnemer5a1b2042013-09-11 04:44:30 +00001558 TypePtr = T.getCanonicalType().getAsOpaquePtr();
David Majnemer96183f62015-04-23 05:21:20 +00001559 }
David Majnemer5a1b2042013-09-11 04:44:30 +00001560
Guy Benyei11169dd2012-12-18 14:30:41 +00001561 ArgBackRefMap::iterator Found = TypeBackReferences.find(TypePtr);
1562
1563 if (Found == TypeBackReferences.end()) {
Yaron Keren2155f802015-05-02 15:31:08 +00001564 size_t OutSizeBefore = Out.tell();
Guy Benyei11169dd2012-12-18 14:30:41 +00001565
David Majnemer5a1b2042013-09-11 04:44:30 +00001566 mangleType(T, Range, QMM_Drop);
Guy Benyei11169dd2012-12-18 14:30:41 +00001567
1568 // See if it's worth creating a back reference.
1569 // Only types longer than 1 character are considered
1570 // and only 10 back references slots are available:
Yaron Keren2155f802015-05-02 15:31:08 +00001571 bool LongerThanOneChar = (Out.tell() - OutSizeBefore > 1);
Guy Benyei11169dd2012-12-18 14:30:41 +00001572 if (LongerThanOneChar && TypeBackReferences.size() < 10) {
1573 size_t Size = TypeBackReferences.size();
1574 TypeBackReferences[TypePtr] = Size;
1575 }
1576 } else {
1577 Out << Found->second;
1578 }
1579}
1580
David Majnemer5f177622015-12-30 05:13:03 +00001581void MicrosoftCXXNameMangler::manglePassObjectSizeArg(
1582 const PassObjectSizeAttr *POSA) {
1583 int Type = POSA->getType();
1584
1585 auto Iter = PassObjectSizeArgs.insert(Type).first;
David Majnemer622abd12015-12-31 05:36:52 +00001586 auto *TypePtr = (const void *)&*Iter;
David Majnemer5f177622015-12-30 05:13:03 +00001587 ArgBackRefMap::iterator Found = TypeBackReferences.find(TypePtr);
1588
1589 if (Found == TypeBackReferences.end()) {
1590 mangleArtificalTagType(TTK_Enum, "__pass_object_size" + llvm::utostr(Type),
1591 {"__clang"});
1592
1593 if (TypeBackReferences.size() < 10) {
1594 size_t Size = TypeBackReferences.size();
1595 TypeBackReferences[TypePtr] = Size;
1596 }
1597 } else {
1598 Out << Found->second;
1599 }
1600}
1601
Guy Benyei11169dd2012-12-18 14:30:41 +00001602void MicrosoftCXXNameMangler::mangleType(QualType T, SourceRange Range,
Peter Collingbourne2816c022013-04-25 04:25:40 +00001603 QualifierMangleMode QMM) {
Reid Kleckner18da98e2013-06-24 19:21:52 +00001604 // Don't use the canonical types. MSVC includes things like 'const' on
1605 // pointer arguments to function pointers that canonicalization strips away.
1606 T = T.getDesugaredType(getASTContext());
Guy Benyei11169dd2012-12-18 14:30:41 +00001607 Qualifiers Quals = T.getLocalQualifiers();
Reid Kleckner18da98e2013-06-24 19:21:52 +00001608 if (const ArrayType *AT = getASTContext().getAsArrayType(T)) {
1609 // If there were any Quals, getAsArrayType() pushed them onto the array
1610 // element type.
Peter Collingbourne2816c022013-04-25 04:25:40 +00001611 if (QMM == QMM_Mangle)
1612 Out << 'A';
1613 else if (QMM == QMM_Escape || QMM == QMM_Result)
1614 Out << "$$B";
Reid Kleckner18da98e2013-06-24 19:21:52 +00001615 mangleArrayType(AT);
Peter Collingbourne2816c022013-04-25 04:25:40 +00001616 return;
1617 }
1618
1619 bool IsPointer = T->isAnyPointerType() || T->isMemberPointerType() ||
David Majnemer7a3ce0c2015-05-26 01:30:45 +00001620 T->isReferenceType() || T->isBlockPointerType();
Peter Collingbourne2816c022013-04-25 04:25:40 +00001621
1622 switch (QMM) {
1623 case QMM_Drop:
1624 break;
1625 case QMM_Mangle:
1626 if (const FunctionType *FT = dyn_cast<FunctionType>(T)) {
1627 Out << '6';
Timur Iskhodzhanov555a7722013-10-04 11:25:05 +00001628 mangleFunctionType(FT);
Peter Collingbourne2816c022013-04-25 04:25:40 +00001629 return;
1630 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001631 mangleQualifiers(Quals, false);
Peter Collingbourne2816c022013-04-25 04:25:40 +00001632 break;
1633 case QMM_Escape:
1634 if (!IsPointer && Quals) {
1635 Out << "$$C";
1636 mangleQualifiers(Quals, false);
1637 }
1638 break;
1639 case QMM_Result:
Andrey Bokhanko45d41322016-05-11 18:38:21 +00001640 // Presence of __unaligned qualifier shouldn't affect mangling here.
1641 Quals.removeUnaligned();
Peter Collingbourne2816c022013-04-25 04:25:40 +00001642 if ((!IsPointer && Quals) || isa<TagType>(T)) {
1643 Out << '?';
1644 mangleQualifiers(Quals, false);
1645 }
1646 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00001647 }
1648
Peter Collingbourne2816c022013-04-25 04:25:40 +00001649 const Type *ty = T.getTypePtr();
Guy Benyei11169dd2012-12-18 14:30:41 +00001650
1651 switch (ty->getTypeClass()) {
1652#define ABSTRACT_TYPE(CLASS, PARENT)
1653#define NON_CANONICAL_TYPE(CLASS, PARENT) \
1654 case Type::CLASS: \
1655 llvm_unreachable("can't mangle non-canonical type " #CLASS "Type"); \
1656 return;
1657#define TYPE(CLASS, PARENT) \
1658 case Type::CLASS: \
David Majnemer7a3ce0c2015-05-26 01:30:45 +00001659 mangleType(cast<CLASS##Type>(ty), Quals, Range); \
Guy Benyei11169dd2012-12-18 14:30:41 +00001660 break;
1661#include "clang/AST/TypeNodes.def"
1662#undef ABSTRACT_TYPE
1663#undef NON_CANONICAL_TYPE
1664#undef TYPE
1665 }
1666}
1667
David Majnemer7a3ce0c2015-05-26 01:30:45 +00001668void MicrosoftCXXNameMangler::mangleType(const BuiltinType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00001669 SourceRange Range) {
1670 // <type> ::= <builtin-type>
1671 // <builtin-type> ::= X # void
1672 // ::= C # signed char
1673 // ::= D # char
1674 // ::= E # unsigned char
1675 // ::= F # short
1676 // ::= G # unsigned short (or wchar_t if it's not a builtin)
1677 // ::= H # int
1678 // ::= I # unsigned int
1679 // ::= J # long
1680 // ::= K # unsigned long
1681 // L # <none>
1682 // ::= M # float
1683 // ::= N # double
1684 // ::= O # long double (__float80 is mangled differently)
1685 // ::= _J # long long, __int64
1686 // ::= _K # unsigned long long, __int64
1687 // ::= _L # __int128
1688 // ::= _M # unsigned __int128
1689 // ::= _N # bool
1690 // _O # <array in parameter>
1691 // ::= _T # __float80 (Intel)
1692 // ::= _W # wchar_t
1693 // ::= _Z # __float80 (Digital Mars)
1694 switch (T->getKind()) {
Alexey Baderbdf7c842015-09-15 12:18:29 +00001695 case BuiltinType::Void:
1696 Out << 'X';
1697 break;
1698 case BuiltinType::SChar:
1699 Out << 'C';
1700 break;
1701 case BuiltinType::Char_U:
1702 case BuiltinType::Char_S:
1703 Out << 'D';
1704 break;
1705 case BuiltinType::UChar:
1706 Out << 'E';
1707 break;
1708 case BuiltinType::Short:
1709 Out << 'F';
1710 break;
1711 case BuiltinType::UShort:
1712 Out << 'G';
1713 break;
1714 case BuiltinType::Int:
1715 Out << 'H';
1716 break;
1717 case BuiltinType::UInt:
1718 Out << 'I';
1719 break;
1720 case BuiltinType::Long:
1721 Out << 'J';
1722 break;
1723 case BuiltinType::ULong:
1724 Out << 'K';
1725 break;
1726 case BuiltinType::Float:
1727 Out << 'M';
1728 break;
1729 case BuiltinType::Double:
1730 Out << 'N';
1731 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00001732 // TODO: Determine size and mangle accordingly
Alexey Baderbdf7c842015-09-15 12:18:29 +00001733 case BuiltinType::LongDouble:
1734 Out << 'O';
1735 break;
1736 case BuiltinType::LongLong:
1737 Out << "_J";
1738 break;
1739 case BuiltinType::ULongLong:
1740 Out << "_K";
1741 break;
1742 case BuiltinType::Int128:
1743 Out << "_L";
1744 break;
1745 case BuiltinType::UInt128:
1746 Out << "_M";
1747 break;
1748 case BuiltinType::Bool:
1749 Out << "_N";
1750 break;
1751 case BuiltinType::Char16:
1752 Out << "_S";
1753 break;
1754 case BuiltinType::Char32:
1755 Out << "_U";
1756 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00001757 case BuiltinType::WChar_S:
Alexey Baderbdf7c842015-09-15 12:18:29 +00001758 case BuiltinType::WChar_U:
1759 Out << "_W";
1760 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00001761
1762#define BUILTIN_TYPE(Id, SingletonId)
1763#define PLACEHOLDER_TYPE(Id, SingletonId) \
1764 case BuiltinType::Id:
1765#include "clang/AST/BuiltinTypes.def"
1766 case BuiltinType::Dependent:
1767 llvm_unreachable("placeholder types shouldn't get to name mangling");
1768
Alexey Baderbdf7c842015-09-15 12:18:29 +00001769 case BuiltinType::ObjCId:
David Majnemer3add70b2015-12-29 11:45:53 +00001770 Out << "PA";
1771 mangleArtificalTagType(TTK_Struct, "objc_object");
Alexey Baderbdf7c842015-09-15 12:18:29 +00001772 break;
1773 case BuiltinType::ObjCClass:
David Majnemer3add70b2015-12-29 11:45:53 +00001774 Out << "PA";
1775 mangleArtificalTagType(TTK_Struct, "objc_class");
Alexey Baderbdf7c842015-09-15 12:18:29 +00001776 break;
1777 case BuiltinType::ObjCSel:
David Majnemer3add70b2015-12-29 11:45:53 +00001778 Out << "PA";
1779 mangleArtificalTagType(TTK_Struct, "objc_selector");
Alexey Baderbdf7c842015-09-15 12:18:29 +00001780 break;
Guy Benyeid8a08ea2012-12-18 14:38:23 +00001781
Alexey Bader954ba212016-04-08 13:40:33 +00001782#define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
1783 case BuiltinType::Id: \
1784 Out << "PAUocl_" #ImgType "_" #Suffix "@@"; \
Alexey Baderbdf7c842015-09-15 12:18:29 +00001785 break;
Alexey Baderb62f1442016-04-13 08:33:41 +00001786#include "clang/Basic/OpenCLImageTypes.def"
Alexey Baderbdf7c842015-09-15 12:18:29 +00001787 case BuiltinType::OCLSampler:
David Majnemer3add70b2015-12-29 11:45:53 +00001788 Out << "PA";
1789 mangleArtificalTagType(TTK_Struct, "ocl_sampler");
Alexey Baderbdf7c842015-09-15 12:18:29 +00001790 break;
1791 case BuiltinType::OCLEvent:
David Majnemer3add70b2015-12-29 11:45:53 +00001792 Out << "PA";
1793 mangleArtificalTagType(TTK_Struct, "ocl_event");
Alexey Baderbdf7c842015-09-15 12:18:29 +00001794 break;
Alexey Bader9c8453f2015-09-15 11:18:52 +00001795 case BuiltinType::OCLClkEvent:
David Majnemer3add70b2015-12-29 11:45:53 +00001796 Out << "PA";
1797 mangleArtificalTagType(TTK_Struct, "ocl_clkevent");
Alexey Bader9c8453f2015-09-15 11:18:52 +00001798 break;
1799 case BuiltinType::OCLQueue:
David Majnemer3add70b2015-12-29 11:45:53 +00001800 Out << "PA";
1801 mangleArtificalTagType(TTK_Struct, "ocl_queue");
Alexey Bader9c8453f2015-09-15 11:18:52 +00001802 break;
1803 case BuiltinType::OCLNDRange:
David Majnemer3add70b2015-12-29 11:45:53 +00001804 Out << "PA";
1805 mangleArtificalTagType(TTK_Struct, "ocl_ndrange");
Alexey Bader9c8453f2015-09-15 11:18:52 +00001806 break;
1807 case BuiltinType::OCLReserveID:
David Majnemer3add70b2015-12-29 11:45:53 +00001808 Out << "PA";
1809 mangleArtificalTagType(TTK_Struct, "ocl_reserveid");
Alexey Bader9c8453f2015-09-15 11:18:52 +00001810 break;
David Majnemerb4119f72013-12-13 01:06:04 +00001811
Alexey Baderbdf7c842015-09-15 12:18:29 +00001812 case BuiltinType::NullPtr:
1813 Out << "$$T";
1814 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00001815
Nemanja Ivanovicbb1ea2d2016-05-09 08:52:33 +00001816 case BuiltinType::Float128:
Guy Benyei11169dd2012-12-18 14:30:41 +00001817 case BuiltinType::Half: {
1818 DiagnosticsEngine &Diags = Context.getDiags();
Alexey Baderbdf7c842015-09-15 12:18:29 +00001819 unsigned DiagID = Diags.getCustomDiagID(
1820 DiagnosticsEngine::Error, "cannot mangle this built-in %0 type yet");
Guy Benyei11169dd2012-12-18 14:30:41 +00001821 Diags.Report(Range.getBegin(), DiagID)
Alexey Baderbdf7c842015-09-15 12:18:29 +00001822 << T->getName(Context.getASTContext().getPrintingPolicy()) << Range;
Guy Benyei11169dd2012-12-18 14:30:41 +00001823 break;
1824 }
1825 }
1826}
1827
1828// <type> ::= <function-type>
David Majnemer7a3ce0c2015-05-26 01:30:45 +00001829void MicrosoftCXXNameMangler::mangleType(const FunctionProtoType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00001830 SourceRange) {
1831 // Structors only appear in decls, so at this point we know it's not a
1832 // structor type.
1833 // FIXME: This may not be lambda-friendly.
David Majnemer2f6a96e2014-08-12 17:53:10 +00001834 if (T->getTypeQuals() || T->getRefQualifier() != RQ_None) {
1835 Out << "$$A8@@";
1836 mangleFunctionType(T, /*D=*/nullptr, /*ForceThisQuals=*/true);
1837 } else {
1838 Out << "$$A6";
1839 mangleFunctionType(T);
1840 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001841}
1842void MicrosoftCXXNameMangler::mangleType(const FunctionNoProtoType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00001843 Qualifiers, SourceRange) {
Peter Collingbourneeeebc412015-08-07 23:25:47 +00001844 Out << "$$A6";
1845 mangleFunctionType(T);
Guy Benyei11169dd2012-12-18 14:30:41 +00001846}
1847
Peter Collingbourne2816c022013-04-25 04:25:40 +00001848void MicrosoftCXXNameMangler::mangleFunctionType(const FunctionType *T,
1849 const FunctionDecl *D,
David Majnemer2f6a96e2014-08-12 17:53:10 +00001850 bool ForceThisQuals) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001851 // <function-type> ::= <this-cvr-qualifiers> <calling-convention>
1852 // <return-type> <argument-list> <throw-spec>
Peter Collingbourneeeebc412015-08-07 23:25:47 +00001853 const FunctionProtoType *Proto = dyn_cast<FunctionProtoType>(T);
Guy Benyei11169dd2012-12-18 14:30:41 +00001854
Reid Kleckner18da98e2013-06-24 19:21:52 +00001855 SourceRange Range;
1856 if (D) Range = D->getSourceRange();
1857
David Majnemer41311192016-01-17 07:09:24 +00001858 bool IsInLambda = false;
David Majnemerdfa6d202015-03-11 18:36:39 +00001859 bool IsStructor = false, HasThisQuals = ForceThisQuals, IsCtorClosure = false;
1860 CallingConv CC = T->getCallConv();
Timur Iskhodzhanov555a7722013-10-04 11:25:05 +00001861 if (const CXXMethodDecl *MD = dyn_cast_or_null<CXXMethodDecl>(D)) {
David Majnemer41311192016-01-17 07:09:24 +00001862 if (MD->getParent()->isLambda())
1863 IsInLambda = true;
Timur Iskhodzhanov555a7722013-10-04 11:25:05 +00001864 if (MD->isInstance())
David Majnemer2f6a96e2014-08-12 17:53:10 +00001865 HasThisQuals = true;
David Majnemerdfa6d202015-03-11 18:36:39 +00001866 if (isa<CXXDestructorDecl>(MD)) {
Timur Iskhodzhanov555a7722013-10-04 11:25:05 +00001867 IsStructor = true;
David Majnemerdfa6d202015-03-11 18:36:39 +00001868 } else if (isa<CXXConstructorDecl>(MD)) {
1869 IsStructor = true;
1870 IsCtorClosure = (StructorType == Ctor_CopyingClosure ||
1871 StructorType == Ctor_DefaultClosure) &&
Reid Kleckner290feb92017-01-09 17:04:37 +00001872 isStructorDecl(MD);
David Majnemerdfa6d202015-03-11 18:36:39 +00001873 if (IsCtorClosure)
1874 CC = getASTContext().getDefaultCallingConvention(
1875 /*IsVariadic=*/false, /*IsCXXMethod=*/true);
1876 }
Timur Iskhodzhanov555a7722013-10-04 11:25:05 +00001877 }
1878
Guy Benyei11169dd2012-12-18 14:30:41 +00001879 // If this is a C++ instance method, mangle the CVR qualifiers for the
1880 // this pointer.
David Majnemer2f6a96e2014-08-12 17:53:10 +00001881 if (HasThisQuals) {
Andrey Bokhanko67a41862016-05-26 10:06:01 +00001882 Qualifiers Quals = Qualifiers::fromCVRUMask(Proto->getTypeQuals());
David Majnemer7a3ce0c2015-05-26 01:30:45 +00001883 manglePointerExtQualifiers(Quals, /*PointeeType=*/QualType());
David Majnemere3785bb2014-04-23 05:16:56 +00001884 mangleRefQualifier(Proto->getRefQualifier());
David Majnemer2f6a96e2014-08-12 17:53:10 +00001885 mangleQualifiers(Quals, /*IsMember=*/false);
David Majnemer6dda7bb2013-08-15 08:13:23 +00001886 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001887
David Majnemerdfa6d202015-03-11 18:36:39 +00001888 mangleCallingConvention(CC);
Guy Benyei11169dd2012-12-18 14:30:41 +00001889
1890 // <return-type> ::= <type>
1891 // ::= @ # structors (they have no declared return type)
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001892 if (IsStructor) {
David Majnemerdc169752017-02-14 00:54:11 +00001893 if (isa<CXXDestructorDecl>(D) && isStructorDecl(D)) {
1894 // The scalar deleting destructor takes an extra int argument which is not
1895 // reflected in the AST.
1896 if (StructorType == Dtor_Deleting) {
1897 Out << (PointersAre64Bit ? "PEAXI@Z" : "PAXI@Z");
1898 return;
1899 }
1900 // The vbase destructor returns void which is not reflected in the AST.
1901 if (StructorType == Dtor_Complete) {
1902 Out << "XXZ";
1903 return;
1904 }
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001905 }
David Majnemerdfa6d202015-03-11 18:36:39 +00001906 if (IsCtorClosure) {
1907 // Default constructor closure and copy constructor closure both return
1908 // void.
1909 Out << 'X';
1910
1911 if (StructorType == Ctor_DefaultClosure) {
1912 // Default constructor closure always has no arguments.
1913 Out << 'X';
1914 } else if (StructorType == Ctor_CopyingClosure) {
1915 // Copy constructor closure always takes an unqualified reference.
1916 mangleArgumentType(getASTContext().getLValueReferenceType(
1917 Proto->getParamType(0)
1918 ->getAs<LValueReferenceType>()
1919 ->getPointeeType(),
1920 /*SpelledAsLValue=*/true),
1921 Range);
David Majnemer37fd66e2015-03-13 22:36:55 +00001922 Out << '@';
David Majnemerdfa6d202015-03-11 18:36:39 +00001923 } else {
1924 llvm_unreachable("unexpected constructor closure!");
1925 }
David Majnemer37fd66e2015-03-13 22:36:55 +00001926 Out << 'Z';
David Majnemerdfa6d202015-03-11 18:36:39 +00001927 return;
1928 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001929 Out << '@';
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +00001930 } else {
Peter Collingbourneeeebc412015-08-07 23:25:47 +00001931 QualType ResultType = T->getReturnType();
David Majnemer2e1e04912014-04-01 05:29:46 +00001932 if (const auto *AT =
1933 dyn_cast_or_null<AutoType>(ResultType->getContainedAutoType())) {
1934 Out << '?';
1935 mangleQualifiers(ResultType.getLocalQualifiers(), /*IsMember=*/false);
1936 Out << '?';
Richard Smithe301ba22015-11-11 02:02:15 +00001937 assert(AT->getKeyword() != AutoTypeKeyword::GNUAutoType &&
1938 "shouldn't need to mangle __auto_type!");
David Majnemer2e1e04912014-04-01 05:29:46 +00001939 mangleSourceName(AT->isDecltypeAuto() ? "<decltype-auto>" : "<auto>");
1940 Out << '@';
David Majnemer41311192016-01-17 07:09:24 +00001941 } else if (IsInLambda) {
1942 Out << '@';
David Majnemer2e1e04912014-04-01 05:29:46 +00001943 } else {
1944 if (ResultType->isVoidType())
1945 ResultType = ResultType.getUnqualifiedType();
1946 mangleType(ResultType, Range, QMM_Result);
1947 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001948 }
1949
1950 // <argument-list> ::= X # void
1951 // ::= <type>+ @
1952 // ::= <type>* Z # varargs
Peter Collingbourneeeebc412015-08-07 23:25:47 +00001953 if (!Proto) {
1954 // Function types without prototypes can arise when mangling a function type
1955 // within an overloadable function in C. We mangle these as the absence of
1956 // any parameter types (not even an empty parameter list).
1957 Out << '@';
1958 } else if (Proto->getNumParams() == 0 && !Proto->isVariadic()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001959 Out << 'X';
1960 } else {
Reid Kleckner18da98e2013-06-24 19:21:52 +00001961 // Happens for function pointer type arguments for example.
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00001962 for (unsigned I = 0, E = Proto->getNumParams(); I != E; ++I) {
1963 mangleArgumentType(Proto->getParamType(I), Range);
Simon Pilgrim27cc0542017-02-15 15:12:06 +00001964 // Mangle each pass_object_size parameter as if it's a parameter of enum
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00001965 // type passed directly after the parameter with the pass_object_size
1966 // attribute. The aforementioned enum's name is __pass_object_size, and we
1967 // pretend it resides in a top-level namespace called __clang.
1968 //
1969 // FIXME: Is there a defined extension notation for the MS ABI, or is it
1970 // necessary to just cross our fingers and hope this type+namespace
1971 // combination doesn't conflict with anything?
1972 if (D)
David Majnemer5f177622015-12-30 05:13:03 +00001973 if (const auto *P = D->getParamDecl(I)->getAttr<PassObjectSizeAttr>())
1974 manglePassObjectSizeArg(P);
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00001975 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001976 // <builtin-type> ::= Z # ellipsis
1977 if (Proto->isVariadic())
1978 Out << 'Z';
1979 else
1980 Out << '@';
1981 }
1982
1983 mangleThrowSpecification(Proto);
1984}
1985
1986void MicrosoftCXXNameMangler::mangleFunctionClass(const FunctionDecl *FD) {
Reid Kleckner369f3162013-05-14 20:30:42 +00001987 // <function-class> ::= <member-function> E? # E designates a 64-bit 'this'
1988 // # pointer. in 64-bit mode *all*
1989 // # 'this' pointers are 64-bit.
1990 // ::= <global-function>
1991 // <member-function> ::= A # private: near
1992 // ::= B # private: far
1993 // ::= C # private: static near
1994 // ::= D # private: static far
1995 // ::= E # private: virtual near
1996 // ::= F # private: virtual far
Reid Kleckner369f3162013-05-14 20:30:42 +00001997 // ::= I # protected: near
1998 // ::= J # protected: far
1999 // ::= K # protected: static near
2000 // ::= L # protected: static far
2001 // ::= M # protected: virtual near
2002 // ::= N # protected: virtual far
Reid Kleckner369f3162013-05-14 20:30:42 +00002003 // ::= Q # public: near
2004 // ::= R # public: far
2005 // ::= S # public: static near
2006 // ::= T # public: static far
2007 // ::= U # public: virtual near
2008 // ::= V # public: virtual far
Reid Kleckner369f3162013-05-14 20:30:42 +00002009 // <global-function> ::= Y # global near
2010 // ::= Z # global far
Guy Benyei11169dd2012-12-18 14:30:41 +00002011 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD)) {
David Majnemerdc169752017-02-14 00:54:11 +00002012 bool IsVirtual = MD->isVirtual();
2013 // When mangling vbase destructor variants, ignore whether or not the
2014 // underlying destructor was defined to be virtual.
2015 if (isa<CXXDestructorDecl>(MD) && isStructorDecl(MD) &&
2016 StructorType == Dtor_Complete) {
2017 IsVirtual = false;
2018 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002019 switch (MD->getAccess()) {
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00002020 case AS_none:
2021 llvm_unreachable("Unsupported access specifier");
Guy Benyei11169dd2012-12-18 14:30:41 +00002022 case AS_private:
2023 if (MD->isStatic())
2024 Out << 'C';
David Majnemerdc169752017-02-14 00:54:11 +00002025 else if (IsVirtual)
Guy Benyei11169dd2012-12-18 14:30:41 +00002026 Out << 'E';
2027 else
2028 Out << 'A';
2029 break;
2030 case AS_protected:
2031 if (MD->isStatic())
2032 Out << 'K';
David Majnemerdc169752017-02-14 00:54:11 +00002033 else if (IsVirtual)
Guy Benyei11169dd2012-12-18 14:30:41 +00002034 Out << 'M';
2035 else
2036 Out << 'I';
2037 break;
2038 case AS_public:
2039 if (MD->isStatic())
2040 Out << 'S';
David Majnemerdc169752017-02-14 00:54:11 +00002041 else if (IsVirtual)
Guy Benyei11169dd2012-12-18 14:30:41 +00002042 Out << 'U';
2043 else
2044 Out << 'Q';
2045 }
David Majnemer5a7cfea2015-05-18 00:05:29 +00002046 } else {
Guy Benyei11169dd2012-12-18 14:30:41 +00002047 Out << 'Y';
David Majnemer5a7cfea2015-05-18 00:05:29 +00002048 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002049}
David Majnemerdfa6d202015-03-11 18:36:39 +00002050void MicrosoftCXXNameMangler::mangleCallingConvention(CallingConv CC) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002051 // <calling-convention> ::= A # __cdecl
2052 // ::= B # __export __cdecl
2053 // ::= C # __pascal
2054 // ::= D # __export __pascal
2055 // ::= E # __thiscall
2056 // ::= F # __export __thiscall
2057 // ::= G # __stdcall
2058 // ::= H # __export __stdcall
2059 // ::= I # __fastcall
2060 // ::= J # __export __fastcall
Reid Klecknerd7857f02014-10-24 17:42:17 +00002061 // ::= Q # __vectorcall
Erich Keane757d3172016-11-02 18:29:35 +00002062 // ::= w # __regcall
Guy Benyei11169dd2012-12-18 14:30:41 +00002063 // The 'export' calling conventions are from a bygone era
2064 // (*cough*Win16*cough*) when functions were declared for export with
2065 // that keyword. (It didn't actually export them, it just made them so
2066 // that they could be in a DLL and somebody from another module could call
2067 // them.)
David Majnemerdfa6d202015-03-11 18:36:39 +00002068
Guy Benyei11169dd2012-12-18 14:30:41 +00002069 switch (CC) {
2070 default:
2071 llvm_unreachable("Unsupported CC for mangling");
Charles Davisb5a214e2013-08-30 04:39:01 +00002072 case CC_X86_64Win64:
2073 case CC_X86_64SysV:
Guy Benyei11169dd2012-12-18 14:30:41 +00002074 case CC_C: Out << 'A'; break;
2075 case CC_X86Pascal: Out << 'C'; break;
2076 case CC_X86ThisCall: Out << 'E'; break;
2077 case CC_X86StdCall: Out << 'G'; break;
2078 case CC_X86FastCall: Out << 'I'; break;
Reid Klecknerd7857f02014-10-24 17:42:17 +00002079 case CC_X86VectorCall: Out << 'Q'; break;
Erich Keane757d3172016-11-02 18:29:35 +00002080 case CC_X86RegCall: Out << 'w'; break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002081 }
2082}
David Majnemerdfa6d202015-03-11 18:36:39 +00002083void MicrosoftCXXNameMangler::mangleCallingConvention(const FunctionType *T) {
2084 mangleCallingConvention(T->getCallConv());
2085}
Guy Benyei11169dd2012-12-18 14:30:41 +00002086void MicrosoftCXXNameMangler::mangleThrowSpecification(
2087 const FunctionProtoType *FT) {
2088 // <throw-spec> ::= Z # throw(...) (default)
2089 // ::= @ # throw() or __declspec/__attribute__((nothrow))
2090 // ::= <type>+
2091 // NOTE: Since the Microsoft compiler ignores throw specifications, they are
2092 // all actually mangled as 'Z'. (They're ignored because their associated
2093 // functionality isn't implemented, and probably never will be.)
2094 Out << 'Z';
2095}
2096
2097void MicrosoftCXXNameMangler::mangleType(const UnresolvedUsingType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002098 Qualifiers, SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002099 // Probably should be mangled as a template instantiation; need to see what
2100 // VC does first.
2101 DiagnosticsEngine &Diags = Context.getDiags();
2102 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2103 "cannot mangle this unresolved dependent type yet");
2104 Diags.Report(Range.getBegin(), DiagID)
2105 << Range;
2106}
2107
2108// <type> ::= <union-type> | <struct-type> | <class-type> | <enum-type>
2109// <union-type> ::= T <name>
2110// <struct-type> ::= U <name>
2111// <class-type> ::= V <name>
David Majnemer048f90c2013-12-09 04:28:34 +00002112// <enum-type> ::= W4 <name>
David Majnemer3add70b2015-12-29 11:45:53 +00002113void MicrosoftCXXNameMangler::mangleTagTypeKind(TagTypeKind TTK) {
2114 switch (TTK) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002115 case TTK_Union:
2116 Out << 'T';
2117 break;
2118 case TTK_Struct:
2119 case TTK_Interface:
2120 Out << 'U';
2121 break;
2122 case TTK_Class:
2123 Out << 'V';
2124 break;
2125 case TTK_Enum:
David Majnemer048f90c2013-12-09 04:28:34 +00002126 Out << "W4";
Guy Benyei11169dd2012-12-18 14:30:41 +00002127 break;
2128 }
David Majnemer3add70b2015-12-29 11:45:53 +00002129}
2130void MicrosoftCXXNameMangler::mangleType(const EnumType *T, Qualifiers,
2131 SourceRange) {
2132 mangleType(cast<TagType>(T)->getDecl());
2133}
2134void MicrosoftCXXNameMangler::mangleType(const RecordType *T, Qualifiers,
2135 SourceRange) {
2136 mangleType(cast<TagType>(T)->getDecl());
2137}
2138void MicrosoftCXXNameMangler::mangleType(const TagDecl *TD) {
2139 mangleTagTypeKind(TD->getTagKind());
David Majnemer0db0ca42013-08-05 22:26:46 +00002140 mangleName(TD);
Guy Benyei11169dd2012-12-18 14:30:41 +00002141}
David Majnemer3add70b2015-12-29 11:45:53 +00002142void MicrosoftCXXNameMangler::mangleArtificalTagType(
2143 TagTypeKind TK, StringRef UnqualifiedName, ArrayRef<StringRef> NestedNames) {
2144 // <name> ::= <unscoped-name> {[<named-scope>]+ | [<nested-name>]}? @
2145 mangleTagTypeKind(TK);
2146
2147 // Always start with the unqualified name.
2148 mangleSourceName(UnqualifiedName);
2149
2150 for (auto I = NestedNames.rbegin(), E = NestedNames.rend(); I != E; ++I)
2151 mangleSourceName(*I);
2152
2153 // Terminate the whole name with an '@'.
2154 Out << '@';
2155}
Guy Benyei11169dd2012-12-18 14:30:41 +00002156
2157// <type> ::= <array-type>
2158// <array-type> ::= <pointer-cvr-qualifiers> <cvr-qualifiers>
2159// [Y <dimension-count> <dimension>+]
Reid Kleckner369f3162013-05-14 20:30:42 +00002160// <element-type> # as global, E is never required
Guy Benyei11169dd2012-12-18 14:30:41 +00002161// It's supposed to be the other way around, but for some strange reason, it
2162// isn't. Today this behavior is retained for the sole purpose of backwards
2163// compatibility.
David Majnemer5a1b2042013-09-11 04:44:30 +00002164void MicrosoftCXXNameMangler::mangleDecayedArrayType(const ArrayType *T) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002165 // This isn't a recursive mangling, so now we have to do it all in this
2166 // one call.
David Majnemer8eec58f2014-02-18 14:20:10 +00002167 manglePointerCVQualifiers(T->getElementType().getQualifiers());
Peter Collingbourne2816c022013-04-25 04:25:40 +00002168 mangleType(T->getElementType(), SourceRange());
Guy Benyei11169dd2012-12-18 14:30:41 +00002169}
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002170void MicrosoftCXXNameMangler::mangleType(const ConstantArrayType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002171 SourceRange) {
Peter Collingbourne2816c022013-04-25 04:25:40 +00002172 llvm_unreachable("Should have been special cased");
Guy Benyei11169dd2012-12-18 14:30:41 +00002173}
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002174void MicrosoftCXXNameMangler::mangleType(const VariableArrayType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002175 SourceRange) {
Peter Collingbourne2816c022013-04-25 04:25:40 +00002176 llvm_unreachable("Should have been special cased");
Guy Benyei11169dd2012-12-18 14:30:41 +00002177}
2178void MicrosoftCXXNameMangler::mangleType(const DependentSizedArrayType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002179 Qualifiers, SourceRange) {
Peter Collingbourne2816c022013-04-25 04:25:40 +00002180 llvm_unreachable("Should have been special cased");
Guy Benyei11169dd2012-12-18 14:30:41 +00002181}
2182void MicrosoftCXXNameMangler::mangleType(const IncompleteArrayType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002183 Qualifiers, SourceRange) {
Peter Collingbourne2816c022013-04-25 04:25:40 +00002184 llvm_unreachable("Should have been special cased");
Guy Benyei11169dd2012-12-18 14:30:41 +00002185}
Reid Kleckner18da98e2013-06-24 19:21:52 +00002186void MicrosoftCXXNameMangler::mangleArrayType(const ArrayType *T) {
Peter Collingbourne2816c022013-04-25 04:25:40 +00002187 QualType ElementTy(T, 0);
Guy Benyei11169dd2012-12-18 14:30:41 +00002188 SmallVector<llvm::APInt, 3> Dimensions;
2189 for (;;) {
David Majnemer9595b7d2015-04-23 07:42:08 +00002190 if (ElementTy->isConstantArrayType()) {
2191 const ConstantArrayType *CAT =
2192 getASTContext().getAsConstantArrayType(ElementTy);
Guy Benyei11169dd2012-12-18 14:30:41 +00002193 Dimensions.push_back(CAT->getSize());
2194 ElementTy = CAT->getElementType();
David Majnemer9595b7d2015-04-23 07:42:08 +00002195 } else if (ElementTy->isIncompleteArrayType()) {
2196 const IncompleteArrayType *IAT =
2197 getASTContext().getAsIncompleteArrayType(ElementTy);
2198 Dimensions.push_back(llvm::APInt(32, 0));
2199 ElementTy = IAT->getElementType();
Guy Benyei11169dd2012-12-18 14:30:41 +00002200 } else if (ElementTy->isVariableArrayType()) {
2201 const VariableArrayType *VAT =
2202 getASTContext().getAsVariableArrayType(ElementTy);
David Majnemer9595b7d2015-04-23 07:42:08 +00002203 Dimensions.push_back(llvm::APInt(32, 0));
2204 ElementTy = VAT->getElementType();
Guy Benyei11169dd2012-12-18 14:30:41 +00002205 } else if (ElementTy->isDependentSizedArrayType()) {
2206 // The dependent expression has to be folded into a constant (TODO).
2207 const DependentSizedArrayType *DSAT =
2208 getASTContext().getAsDependentSizedArrayType(ElementTy);
2209 DiagnosticsEngine &Diags = Context.getDiags();
2210 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2211 "cannot mangle this dependent-length array yet");
2212 Diags.Report(DSAT->getSizeExpr()->getExprLoc(), DiagID)
2213 << DSAT->getBracketsRange();
2214 return;
David Majnemer9595b7d2015-04-23 07:42:08 +00002215 } else {
2216 break;
Peter Collingbourne2816c022013-04-25 04:25:40 +00002217 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002218 }
Peter Collingbourne2816c022013-04-25 04:25:40 +00002219 Out << 'Y';
2220 // <dimension-count> ::= <number> # number of extra dimensions
2221 mangleNumber(Dimensions.size());
David Majnemerb926dbc2014-04-23 05:16:53 +00002222 for (const llvm::APInt &Dimension : Dimensions)
2223 mangleNumber(Dimension.getLimitedValue());
Reid Kleckner18da98e2013-06-24 19:21:52 +00002224 mangleType(ElementTy, SourceRange(), QMM_Escape);
Guy Benyei11169dd2012-12-18 14:30:41 +00002225}
2226
2227// <type> ::= <pointer-to-member-type>
2228// <pointer-to-member-type> ::= <pointer-cvr-qualifiers> <cvr-qualifiers>
2229// <class name> <type>
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002230void MicrosoftCXXNameMangler::mangleType(const MemberPointerType *T, Qualifiers Quals,
Guy Benyei11169dd2012-12-18 14:30:41 +00002231 SourceRange Range) {
2232 QualType PointeeType = T->getPointeeType();
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002233 manglePointerCVQualifiers(Quals);
2234 manglePointerExtQualifiers(Quals, PointeeType);
Guy Benyei11169dd2012-12-18 14:30:41 +00002235 if (const FunctionProtoType *FPT = PointeeType->getAs<FunctionProtoType>()) {
2236 Out << '8';
2237 mangleName(T->getClass()->castAs<RecordType>()->getDecl());
Craig Topper36250ad2014-05-12 05:36:57 +00002238 mangleFunctionType(FPT, nullptr, true);
Guy Benyei11169dd2012-12-18 14:30:41 +00002239 } else {
2240 mangleQualifiers(PointeeType.getQualifiers(), true);
2241 mangleName(T->getClass()->castAs<RecordType>()->getDecl());
Peter Collingbourne2816c022013-04-25 04:25:40 +00002242 mangleType(PointeeType, Range, QMM_Drop);
Guy Benyei11169dd2012-12-18 14:30:41 +00002243 }
2244}
2245
2246void MicrosoftCXXNameMangler::mangleType(const TemplateTypeParmType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002247 Qualifiers, SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002248 DiagnosticsEngine &Diags = Context.getDiags();
2249 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2250 "cannot mangle this template type parameter type yet");
2251 Diags.Report(Range.getBegin(), DiagID)
2252 << Range;
2253}
2254
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002255void MicrosoftCXXNameMangler::mangleType(const SubstTemplateTypeParmPackType *T,
2256 Qualifiers, SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002257 DiagnosticsEngine &Diags = Context.getDiags();
2258 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2259 "cannot mangle this substituted parameter pack yet");
2260 Diags.Report(Range.getBegin(), DiagID)
2261 << Range;
2262}
2263
2264// <type> ::= <pointer-type>
Reid Kleckner369f3162013-05-14 20:30:42 +00002265// <pointer-type> ::= E? <pointer-cvr-qualifiers> <cvr-qualifiers> <type>
Alp Tokerd4733632013-12-05 04:47:09 +00002266// # the E is required for 64-bit non-static pointers
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002267void MicrosoftCXXNameMangler::mangleType(const PointerType *T, Qualifiers Quals,
Guy Benyei11169dd2012-12-18 14:30:41 +00002268 SourceRange Range) {
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002269 QualType PointeeType = T->getPointeeType();
2270 manglePointerCVQualifiers(Quals);
2271 manglePointerExtQualifiers(Quals, PointeeType);
2272 mangleType(PointeeType, Range);
Guy Benyei11169dd2012-12-18 14:30:41 +00002273}
2274void MicrosoftCXXNameMangler::mangleType(const ObjCObjectPointerType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002275 Qualifiers Quals, SourceRange Range) {
2276 QualType PointeeType = T->getPointeeType();
2277 manglePointerCVQualifiers(Quals);
2278 manglePointerExtQualifiers(Quals, PointeeType);
Guy Benyei11169dd2012-12-18 14:30:41 +00002279 // Object pointers never have qualifiers.
2280 Out << 'A';
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002281 mangleType(PointeeType, Range);
Guy Benyei11169dd2012-12-18 14:30:41 +00002282}
2283
2284// <type> ::= <reference-type>
Reid Kleckner369f3162013-05-14 20:30:42 +00002285// <reference-type> ::= A E? <cvr-qualifiers> <type>
Alp Tokerd4733632013-12-05 04:47:09 +00002286// # the E is required for 64-bit non-static lvalue references
Guy Benyei11169dd2012-12-18 14:30:41 +00002287void MicrosoftCXXNameMangler::mangleType(const LValueReferenceType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002288 Qualifiers Quals, SourceRange Range) {
2289 QualType PointeeType = T->getPointeeType();
David Majnemere3d71912015-12-31 05:36:50 +00002290 assert(!Quals.hasConst() && !Quals.hasVolatile() && "unexpected qualifier!");
2291 Out << 'A';
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002292 manglePointerExtQualifiers(Quals, PointeeType);
2293 mangleType(PointeeType, Range);
Guy Benyei11169dd2012-12-18 14:30:41 +00002294}
2295
2296// <type> ::= <r-value-reference-type>
Reid Kleckner369f3162013-05-14 20:30:42 +00002297// <r-value-reference-type> ::= $$Q E? <cvr-qualifiers> <type>
Alp Tokerd4733632013-12-05 04:47:09 +00002298// # the E is required for 64-bit non-static rvalue references
Guy Benyei11169dd2012-12-18 14:30:41 +00002299void MicrosoftCXXNameMangler::mangleType(const RValueReferenceType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002300 Qualifiers Quals, SourceRange Range) {
2301 QualType PointeeType = T->getPointeeType();
David Majnemere3d71912015-12-31 05:36:50 +00002302 assert(!Quals.hasConst() && !Quals.hasVolatile() && "unexpected qualifier!");
2303 Out << "$$Q";
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002304 manglePointerExtQualifiers(Quals, PointeeType);
2305 mangleType(PointeeType, Range);
Guy Benyei11169dd2012-12-18 14:30:41 +00002306}
2307
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002308void MicrosoftCXXNameMangler::mangleType(const ComplexType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002309 SourceRange Range) {
David Majnemer0b996dd2015-12-29 22:02:15 +00002310 QualType ElementType = T->getElementType();
2311
2312 llvm::SmallString<64> TemplateMangling;
2313 llvm::raw_svector_ostream Stream(TemplateMangling);
2314 MicrosoftCXXNameMangler Extra(Context, Stream);
2315 Stream << "?$";
2316 Extra.mangleSourceName("_Complex");
2317 Extra.mangleType(ElementType, Range, QMM_Escape);
2318
2319 mangleArtificalTagType(TTK_Struct, TemplateMangling, {"__clang"});
Guy Benyei11169dd2012-12-18 14:30:41 +00002320}
2321
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002322void MicrosoftCXXNameMangler::mangleType(const VectorType *T, Qualifiers Quals,
Guy Benyei11169dd2012-12-18 14:30:41 +00002323 SourceRange Range) {
Reid Klecknere7e64d82013-03-26 16:56:59 +00002324 const BuiltinType *ET = T->getElementType()->getAs<BuiltinType>();
2325 assert(ET && "vectors with non-builtin elements are unsupported");
2326 uint64_t Width = getASTContext().getTypeSize(T);
2327 // Pattern match exactly the typedefs in our intrinsic headers. Anything that
2328 // doesn't match the Intel types uses a custom mangling below.
David Majnemer0a29fed2015-12-29 11:45:58 +00002329 size_t OutSizeBefore = Out.tell();
David Majnemerf04e3862015-06-01 07:41:37 +00002330 llvm::Triple::ArchType AT =
2331 getASTContext().getTargetInfo().getTriple().getArch();
2332 if (AT == llvm::Triple::x86 || AT == llvm::Triple::x86_64) {
2333 if (Width == 64 && ET->getKind() == BuiltinType::LongLong) {
David Majnemer3add70b2015-12-29 11:45:53 +00002334 mangleArtificalTagType(TTK_Union, "__m64");
David Majnemerf04e3862015-06-01 07:41:37 +00002335 } else if (Width >= 128) {
2336 if (ET->getKind() == BuiltinType::Float)
David Majnemer3add70b2015-12-29 11:45:53 +00002337 mangleArtificalTagType(TTK_Union, "__m" + llvm::utostr(Width));
David Majnemerf04e3862015-06-01 07:41:37 +00002338 else if (ET->getKind() == BuiltinType::LongLong)
David Majnemer3add70b2015-12-29 11:45:53 +00002339 mangleArtificalTagType(TTK_Union, "__m" + llvm::utostr(Width) + 'i');
David Majnemerf04e3862015-06-01 07:41:37 +00002340 else if (ET->getKind() == BuiltinType::Double)
David Majnemer3add70b2015-12-29 11:45:53 +00002341 mangleArtificalTagType(TTK_Struct, "__m" + llvm::utostr(Width) + 'd');
David Majnemerf04e3862015-06-01 07:41:37 +00002342 }
Reid Klecknere7e64d82013-03-26 16:56:59 +00002343 }
2344
David Majnemer0a29fed2015-12-29 11:45:58 +00002345 bool IsBuiltin = Out.tell() != OutSizeBefore;
David Majnemerf04e3862015-06-01 07:41:37 +00002346 if (!IsBuiltin) {
Reid Klecknere7e64d82013-03-26 16:56:59 +00002347 // The MS ABI doesn't have a special mangling for vector types, so we define
2348 // our own mangling to handle uses of __vector_size__ on user-specified
2349 // types, and for extensions like __v4sf.
David Majnemer0a29fed2015-12-29 11:45:58 +00002350
2351 llvm::SmallString<64> TemplateMangling;
2352 llvm::raw_svector_ostream Stream(TemplateMangling);
2353 MicrosoftCXXNameMangler Extra(Context, Stream);
2354 Stream << "?$";
2355 Extra.mangleSourceName("__vector");
2356 Extra.mangleType(QualType(ET, 0), Range, QMM_Escape);
2357 Extra.mangleIntegerLiteral(llvm::APSInt::getUnsigned(T->getNumElements()),
2358 /*IsBoolean=*/false);
2359
2360 mangleArtificalTagType(TTK_Union, TemplateMangling, {"__clang"});
Reid Klecknere7e64d82013-03-26 16:56:59 +00002361 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002362}
Reid Klecknere7e64d82013-03-26 16:56:59 +00002363
David Majnemere5c87872015-08-01 05:51:55 +00002364void MicrosoftCXXNameMangler::mangleType(const ExtVectorType *T,
2365 Qualifiers Quals, SourceRange Range) {
2366 mangleType(static_cast<const VectorType *>(T), Quals, Range);
Guy Benyei11169dd2012-12-18 14:30:41 +00002367}
2368void MicrosoftCXXNameMangler::mangleType(const DependentSizedExtVectorType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002369 Qualifiers, SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002370 DiagnosticsEngine &Diags = Context.getDiags();
2371 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2372 "cannot mangle this dependent-sized extended vector type yet");
2373 Diags.Report(Range.getBegin(), DiagID)
2374 << Range;
2375}
2376
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002377void MicrosoftCXXNameMangler::mangleType(const ObjCInterfaceType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002378 SourceRange) {
2379 // ObjC interfaces have structs underlying them.
David Majnemer3add70b2015-12-29 11:45:53 +00002380 mangleTagTypeKind(TTK_Struct);
Guy Benyei11169dd2012-12-18 14:30:41 +00002381 mangleName(T->getDecl());
2382}
2383
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002384void MicrosoftCXXNameMangler::mangleType(const ObjCObjectType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002385 SourceRange Range) {
2386 // We don't allow overloading by different protocol qualification,
2387 // so mangling them isn't necessary.
2388 mangleType(T->getBaseType(), Range);
2389}
2390
2391void MicrosoftCXXNameMangler::mangleType(const BlockPointerType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002392 Qualifiers Quals, SourceRange Range) {
2393 QualType PointeeType = T->getPointeeType();
2394 manglePointerCVQualifiers(Quals);
2395 manglePointerExtQualifiers(Quals, PointeeType);
2396
Guy Benyei11169dd2012-12-18 14:30:41 +00002397 Out << "_E";
2398
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002399 mangleFunctionType(PointeeType->castAs<FunctionProtoType>());
Guy Benyei11169dd2012-12-18 14:30:41 +00002400}
2401
David Majnemerf0a84f22013-08-16 08:29:13 +00002402void MicrosoftCXXNameMangler::mangleType(const InjectedClassNameType *,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002403 Qualifiers, SourceRange) {
David Majnemerf0a84f22013-08-16 08:29:13 +00002404 llvm_unreachable("Cannot mangle injected class name type.");
Guy Benyei11169dd2012-12-18 14:30:41 +00002405}
2406
2407void MicrosoftCXXNameMangler::mangleType(const TemplateSpecializationType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002408 Qualifiers, SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002409 DiagnosticsEngine &Diags = Context.getDiags();
2410 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2411 "cannot mangle this template specialization type yet");
2412 Diags.Report(Range.getBegin(), DiagID)
2413 << Range;
2414}
2415
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002416void MicrosoftCXXNameMangler::mangleType(const DependentNameType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002417 SourceRange Range) {
2418 DiagnosticsEngine &Diags = Context.getDiags();
2419 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2420 "cannot mangle this dependent name type yet");
2421 Diags.Report(Range.getBegin(), DiagID)
2422 << Range;
2423}
2424
2425void MicrosoftCXXNameMangler::mangleType(
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002426 const DependentTemplateSpecializationType *T, Qualifiers,
2427 SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002428 DiagnosticsEngine &Diags = Context.getDiags();
2429 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2430 "cannot mangle this dependent template specialization type yet");
2431 Diags.Report(Range.getBegin(), DiagID)
2432 << Range;
2433}
2434
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002435void MicrosoftCXXNameMangler::mangleType(const PackExpansionType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002436 SourceRange Range) {
2437 DiagnosticsEngine &Diags = Context.getDiags();
2438 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2439 "cannot mangle this pack expansion yet");
2440 Diags.Report(Range.getBegin(), DiagID)
2441 << Range;
2442}
2443
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002444void MicrosoftCXXNameMangler::mangleType(const TypeOfType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002445 SourceRange Range) {
2446 DiagnosticsEngine &Diags = Context.getDiags();
2447 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2448 "cannot mangle this typeof(type) yet");
2449 Diags.Report(Range.getBegin(), DiagID)
2450 << Range;
2451}
2452
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002453void MicrosoftCXXNameMangler::mangleType(const TypeOfExprType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002454 SourceRange Range) {
2455 DiagnosticsEngine &Diags = Context.getDiags();
2456 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2457 "cannot mangle this typeof(expression) yet");
2458 Diags.Report(Range.getBegin(), DiagID)
2459 << Range;
2460}
2461
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002462void MicrosoftCXXNameMangler::mangleType(const DecltypeType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002463 SourceRange Range) {
2464 DiagnosticsEngine &Diags = Context.getDiags();
2465 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2466 "cannot mangle this decltype() yet");
2467 Diags.Report(Range.getBegin(), DiagID)
2468 << Range;
2469}
2470
2471void MicrosoftCXXNameMangler::mangleType(const UnaryTransformType *T,
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002472 Qualifiers, SourceRange Range) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002473 DiagnosticsEngine &Diags = Context.getDiags();
2474 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2475 "cannot mangle this unary transform type yet");
2476 Diags.Report(Range.getBegin(), DiagID)
2477 << Range;
2478}
2479
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002480void MicrosoftCXXNameMangler::mangleType(const AutoType *T, Qualifiers,
2481 SourceRange Range) {
David Majnemerb9a5f2d2014-01-21 20:33:36 +00002482 assert(T->getDeducedType().isNull() && "expecting a dependent type!");
2483
Guy Benyei11169dd2012-12-18 14:30:41 +00002484 DiagnosticsEngine &Diags = Context.getDiags();
2485 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2486 "cannot mangle this 'auto' type yet");
2487 Diags.Report(Range.getBegin(), DiagID)
2488 << Range;
2489}
2490
Richard Smith600b5262017-01-26 20:40:47 +00002491void MicrosoftCXXNameMangler::mangleType(
2492 const DeducedTemplateSpecializationType *T, Qualifiers, SourceRange Range) {
2493 assert(T->getDeducedType().isNull() && "expecting a dependent type!");
2494
2495 DiagnosticsEngine &Diags = Context.getDiags();
2496 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2497 "cannot mangle this deduced class template specialization type yet");
2498 Diags.Report(Range.getBegin(), DiagID)
2499 << Range;
2500}
2501
David Majnemer7a3ce0c2015-05-26 01:30:45 +00002502void MicrosoftCXXNameMangler::mangleType(const AtomicType *T, Qualifiers,
Guy Benyei11169dd2012-12-18 14:30:41 +00002503 SourceRange Range) {
David Majnemer3421fb62015-12-29 11:46:00 +00002504 QualType ValueType = T->getValueType();
2505
2506 llvm::SmallString<64> TemplateMangling;
2507 llvm::raw_svector_ostream Stream(TemplateMangling);
2508 MicrosoftCXXNameMangler Extra(Context, Stream);
2509 Stream << "?$";
2510 Extra.mangleSourceName("_Atomic");
2511 Extra.mangleType(ValueType, Range, QMM_Escape);
2512
2513 mangleArtificalTagType(TTK_Struct, TemplateMangling, {"__clang"});
Guy Benyei11169dd2012-12-18 14:30:41 +00002514}
2515
Xiuli Pan9c14e282016-01-09 12:53:17 +00002516void MicrosoftCXXNameMangler::mangleType(const PipeType *T, Qualifiers,
2517 SourceRange Range) {
2518 DiagnosticsEngine &Diags = Context.getDiags();
2519 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2520 "cannot mangle this OpenCL pipe type yet");
2521 Diags.Report(Range.getBegin(), DiagID)
2522 << Range;
2523}
2524
Rafael Espindola002667c2013-10-16 01:40:34 +00002525void MicrosoftMangleContextImpl::mangleCXXName(const NamedDecl *D,
2526 raw_ostream &Out) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002527 assert((isa<FunctionDecl>(D) || isa<VarDecl>(D)) &&
2528 "Invalid mangleName() call, argument is not a variable or function!");
2529 assert(!isa<CXXConstructorDecl>(D) && !isa<CXXDestructorDecl>(D) &&
2530 "Invalid mangleName() call on 'structor decl!");
2531
2532 PrettyStackTraceDecl CrashInfo(D, SourceLocation(),
2533 getASTContext().getSourceManager(),
2534 "Mangling declaration");
2535
David Majnemerfebb2722016-03-07 08:51:17 +00002536 msvc_hashing_ostream MHO(Out);
2537 MicrosoftCXXNameMangler Mangler(*this, MHO);
Guy Benyei11169dd2012-12-18 14:30:41 +00002538 return Mangler.mangle(D);
2539}
Timur Iskhodzhanovdf7e7fb2013-07-30 09:46:19 +00002540
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002541// <this-adjustment> ::= <no-adjustment> | <static-adjustment> |
2542// <virtual-adjustment>
2543// <no-adjustment> ::= A # private near
2544// ::= B # private far
2545// ::= I # protected near
2546// ::= J # protected far
2547// ::= Q # public near
2548// ::= R # public far
2549// <static-adjustment> ::= G <static-offset> # private near
2550// ::= H <static-offset> # private far
2551// ::= O <static-offset> # protected near
2552// ::= P <static-offset> # protected far
2553// ::= W <static-offset> # public near
2554// ::= X <static-offset> # public far
2555// <virtual-adjustment> ::= $0 <virtual-shift> <static-offset> # private near
2556// ::= $1 <virtual-shift> <static-offset> # private far
2557// ::= $2 <virtual-shift> <static-offset> # protected near
2558// ::= $3 <virtual-shift> <static-offset> # protected far
2559// ::= $4 <virtual-shift> <static-offset> # public near
2560// ::= $5 <virtual-shift> <static-offset> # public far
2561// <virtual-shift> ::= <vtordisp-shift> | <vtordispex-shift>
2562// <vtordisp-shift> ::= <offset-to-vtordisp>
2563// <vtordispex-shift> ::= <offset-to-vbptr> <vbase-offset-offset>
2564// <offset-to-vtordisp>
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00002565static void mangleThunkThisAdjustment(const CXXMethodDecl *MD,
2566 const ThisAdjustment &Adjustment,
2567 MicrosoftCXXNameMangler &Mangler,
2568 raw_ostream &Out) {
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002569 if (!Adjustment.Virtual.isEmpty()) {
2570 Out << '$';
2571 char AccessSpec;
2572 switch (MD->getAccess()) {
2573 case AS_none:
2574 llvm_unreachable("Unsupported access specifier");
2575 case AS_private:
2576 AccessSpec = '0';
2577 break;
2578 case AS_protected:
2579 AccessSpec = '2';
2580 break;
2581 case AS_public:
2582 AccessSpec = '4';
2583 }
2584 if (Adjustment.Virtual.Microsoft.VBPtrOffset) {
2585 Out << 'R' << AccessSpec;
David Majnemer2a816452013-12-09 10:44:32 +00002586 Mangler.mangleNumber(
2587 static_cast<uint32_t>(Adjustment.Virtual.Microsoft.VBPtrOffset));
2588 Mangler.mangleNumber(
2589 static_cast<uint32_t>(Adjustment.Virtual.Microsoft.VBOffsetOffset));
2590 Mangler.mangleNumber(
2591 static_cast<uint32_t>(Adjustment.Virtual.Microsoft.VtordispOffset));
2592 Mangler.mangleNumber(static_cast<uint32_t>(Adjustment.NonVirtual));
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002593 } else {
2594 Out << AccessSpec;
David Majnemer2a816452013-12-09 10:44:32 +00002595 Mangler.mangleNumber(
2596 static_cast<uint32_t>(Adjustment.Virtual.Microsoft.VtordispOffset));
2597 Mangler.mangleNumber(-static_cast<uint32_t>(Adjustment.NonVirtual));
Timur Iskhodzhanov053142a2013-11-06 06:24:31 +00002598 }
2599 } else if (Adjustment.NonVirtual != 0) {
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00002600 switch (MD->getAccess()) {
2601 case AS_none:
2602 llvm_unreachable("Unsupported access specifier");
2603 case AS_private:
2604 Out << 'G';
2605 break;
2606 case AS_protected:
2607 Out << 'O';
2608 break;
2609 case AS_public:
2610 Out << 'W';
2611 }
David Majnemer2a816452013-12-09 10:44:32 +00002612 Mangler.mangleNumber(-static_cast<uint32_t>(Adjustment.NonVirtual));
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00002613 } else {
2614 switch (MD->getAccess()) {
2615 case AS_none:
2616 llvm_unreachable("Unsupported access specifier");
2617 case AS_private:
2618 Out << 'A';
2619 break;
2620 case AS_protected:
2621 Out << 'I';
2622 break;
2623 case AS_public:
2624 Out << 'Q';
2625 }
2626 }
2627}
2628
Reid Kleckner96f8f932014-02-05 17:27:08 +00002629void
2630MicrosoftMangleContextImpl::mangleVirtualMemPtrThunk(const CXXMethodDecl *MD,
2631 raw_ostream &Out) {
2632 MicrosoftVTableContext *VTContext =
2633 cast<MicrosoftVTableContext>(getASTContext().getVTableContext());
2634 const MicrosoftVTableContext::MethodVFTableLocation &ML =
2635 VTContext->getMethodVFTableLocation(GlobalDecl(MD));
Hans Wennborg88497d62013-11-15 17:24:45 +00002636
David Majnemerfebb2722016-03-07 08:51:17 +00002637 msvc_hashing_ostream MHO(Out);
2638 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Kleckner96f8f932014-02-05 17:27:08 +00002639 Mangler.getStream() << "\01?";
2640 Mangler.mangleVirtualMemPtrThunk(MD, ML);
Hans Wennborg88497d62013-11-15 17:24:45 +00002641}
2642
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00002643void MicrosoftMangleContextImpl::mangleThunk(const CXXMethodDecl *MD,
2644 const ThunkInfo &Thunk,
2645 raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00002646 msvc_hashing_ostream MHO(Out);
2647 MicrosoftCXXNameMangler Mangler(*this, MHO);
2648 Mangler.getStream() << "\01?";
Timur Iskhodzhanovdf7e7fb2013-07-30 09:46:19 +00002649 Mangler.mangleName(MD);
David Majnemerfebb2722016-03-07 08:51:17 +00002650 mangleThunkThisAdjustment(MD, Thunk.This, Mangler, MHO);
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00002651 if (!Thunk.Return.isEmpty())
Craig Topper36250ad2014-05-12 05:36:57 +00002652 assert(Thunk.Method != nullptr &&
2653 "Thunk info should hold the overridee decl");
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00002654
2655 const CXXMethodDecl *DeclForFPT = Thunk.Method ? Thunk.Method : MD;
2656 Mangler.mangleFunctionType(
2657 DeclForFPT->getType()->castAs<FunctionProtoType>(), MD);
Guy Benyei11169dd2012-12-18 14:30:41 +00002658}
Timur Iskhodzhanovdf7e7fb2013-07-30 09:46:19 +00002659
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00002660void MicrosoftMangleContextImpl::mangleCXXDtorThunk(
2661 const CXXDestructorDecl *DD, CXXDtorType Type,
2662 const ThisAdjustment &Adjustment, raw_ostream &Out) {
2663 // FIXME: Actually, the dtor thunk should be emitted for vector deleting
2664 // dtors rather than scalar deleting dtors. Just use the vector deleting dtor
2665 // mangling manually until we support both deleting dtor types.
2666 assert(Type == Dtor_Deleting);
David Majnemerfebb2722016-03-07 08:51:17 +00002667 msvc_hashing_ostream MHO(Out);
2668 MicrosoftCXXNameMangler Mangler(*this, MHO, DD, Type);
2669 Mangler.getStream() << "\01??_E";
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00002670 Mangler.mangleName(DD->getParent());
David Majnemerfebb2722016-03-07 08:51:17 +00002671 mangleThunkThisAdjustment(DD, Adjustment, Mangler, MHO);
Timur Iskhodzhanovad9d3b82013-10-09 09:23:58 +00002672 Mangler.mangleFunctionType(DD->getType()->castAs<FunctionProtoType>(), DD);
Guy Benyei11169dd2012-12-18 14:30:41 +00002673}
Reid Kleckner7810af02013-06-19 15:20:38 +00002674
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00002675void MicrosoftMangleContextImpl::mangleCXXVFTable(
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00002676 const CXXRecordDecl *Derived, ArrayRef<const CXXRecordDecl *> BasePath,
2677 raw_ostream &Out) {
Reid Kleckner7810af02013-06-19 15:20:38 +00002678 // <mangled-name> ::= ?_7 <class-name> <storage-class>
2679 // <cvr-qualifiers> [<name>] @
Guy Benyei11169dd2012-12-18 14:30:41 +00002680 // NOTE: <cvr-qualifiers> here is always 'B' (const). <storage-class>
Reid Kleckner7810af02013-06-19 15:20:38 +00002681 // is always '6' for vftables.
David Majnemerfebb2722016-03-07 08:51:17 +00002682 msvc_hashing_ostream MHO(Out);
2683 MicrosoftCXXNameMangler Mangler(*this, MHO);
David Majnemer2d8b2002016-02-11 17:49:28 +00002684 if (Derived->hasAttr<DLLImportAttr>())
2685 Mangler.getStream() << "\01??_S";
2686 else
2687 Mangler.getStream() << "\01??_7";
Timur Iskhodzhanov8b5987e2013-09-27 14:48:01 +00002688 Mangler.mangleName(Derived);
2689 Mangler.getStream() << "6B"; // '6' for vftable, 'B' for const.
David Majnemerb926dbc2014-04-23 05:16:53 +00002690 for (const CXXRecordDecl *RD : BasePath)
2691 Mangler.mangleName(RD);
Guy Benyei11169dd2012-12-18 14:30:41 +00002692 Mangler.getStream() << '@';
2693}
Reid Kleckner7810af02013-06-19 15:20:38 +00002694
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00002695void MicrosoftMangleContextImpl::mangleCXXVBTable(
Reid Kleckner7810af02013-06-19 15:20:38 +00002696 const CXXRecordDecl *Derived, ArrayRef<const CXXRecordDecl *> BasePath,
2697 raw_ostream &Out) {
2698 // <mangled-name> ::= ?_8 <class-name> <storage-class>
2699 // <cvr-qualifiers> [<name>] @
2700 // NOTE: <cvr-qualifiers> here is always 'B' (const). <storage-class>
2701 // is always '7' for vbtables.
David Majnemerfebb2722016-03-07 08:51:17 +00002702 msvc_hashing_ostream MHO(Out);
2703 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Kleckner7810af02013-06-19 15:20:38 +00002704 Mangler.getStream() << "\01??_8";
2705 Mangler.mangleName(Derived);
2706 Mangler.getStream() << "7B"; // '7' for vbtable, 'B' for const.
David Majnemerb926dbc2014-04-23 05:16:53 +00002707 for (const CXXRecordDecl *RD : BasePath)
2708 Mangler.mangleName(RD);
Reid Kleckner7810af02013-06-19 15:20:38 +00002709 Mangler.getStream() << '@';
2710}
2711
David Majnemera96b7ee2014-05-13 00:44:44 +00002712void MicrosoftMangleContextImpl::mangleCXXRTTI(QualType T, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00002713 msvc_hashing_ostream MHO(Out);
2714 MicrosoftCXXNameMangler Mangler(*this, MHO);
David Majnemera96b7ee2014-05-13 00:44:44 +00002715 Mangler.getStream() << "\01??_R0";
2716 Mangler.mangleType(T, SourceRange(), MicrosoftCXXNameMangler::QMM_Result);
2717 Mangler.getStream() << "@8";
Guy Benyei11169dd2012-12-18 14:30:41 +00002718}
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00002719
David Majnemera96b7ee2014-05-13 00:44:44 +00002720void MicrosoftMangleContextImpl::mangleCXXRTTIName(QualType T,
2721 raw_ostream &Out) {
2722 MicrosoftCXXNameMangler Mangler(*this, Out);
2723 Mangler.getStream() << '.';
2724 Mangler.mangleType(T, SourceRange(), MicrosoftCXXNameMangler::QMM_Result);
2725}
2726
David Majnemerc1709d32015-06-23 07:31:11 +00002727void MicrosoftMangleContextImpl::mangleCXXVirtualDisplacementMap(
2728 const CXXRecordDecl *SrcRD, const CXXRecordDecl *DstRD, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00002729 msvc_hashing_ostream MHO(Out);
2730 MicrosoftCXXNameMangler Mangler(*this, MHO);
David Majnemerc1709d32015-06-23 07:31:11 +00002731 Mangler.getStream() << "\01??_K";
2732 Mangler.mangleName(SrcRD);
2733 Mangler.getStream() << "$C";
2734 Mangler.mangleName(DstRD);
2735}
2736
David Majnemer526793d2016-07-12 04:42:50 +00002737void MicrosoftMangleContextImpl::mangleCXXThrowInfo(QualType T, bool IsConst,
David Majnemer7c237072015-03-05 00:46:22 +00002738 bool IsVolatile,
David Majnemer526793d2016-07-12 04:42:50 +00002739 bool IsUnaligned,
David Majnemer7c237072015-03-05 00:46:22 +00002740 uint32_t NumEntries,
2741 raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00002742 msvc_hashing_ostream MHO(Out);
2743 MicrosoftCXXNameMangler Mangler(*this, MHO);
David Majnemer7c237072015-03-05 00:46:22 +00002744 Mangler.getStream() << "_TI";
2745 if (IsConst)
2746 Mangler.getStream() << 'C';
2747 if (IsVolatile)
2748 Mangler.getStream() << 'V';
David Majnemer526793d2016-07-12 04:42:50 +00002749 if (IsUnaligned)
2750 Mangler.getStream() << 'U';
David Majnemer7c237072015-03-05 00:46:22 +00002751 Mangler.getStream() << NumEntries;
2752 Mangler.mangleType(T, SourceRange(), MicrosoftCXXNameMangler::QMM_Result);
2753}
2754
2755void MicrosoftMangleContextImpl::mangleCXXCatchableTypeArray(
2756 QualType T, uint32_t NumEntries, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00002757 msvc_hashing_ostream MHO(Out);
2758 MicrosoftCXXNameMangler Mangler(*this, MHO);
David Majnemer7c237072015-03-05 00:46:22 +00002759 Mangler.getStream() << "_CTA";
2760 Mangler.getStream() << NumEntries;
2761 Mangler.mangleType(T, SourceRange(), MicrosoftCXXNameMangler::QMM_Result);
2762}
2763
David Majnemere7a818f2015-03-06 18:53:55 +00002764void MicrosoftMangleContextImpl::mangleCXXCatchableType(
David Majnemerdfa6d202015-03-11 18:36:39 +00002765 QualType T, const CXXConstructorDecl *CD, CXXCtorType CT, uint32_t Size,
2766 uint32_t NVOffset, int32_t VBPtrOffset, uint32_t VBIndex,
2767 raw_ostream &Out) {
David Majnemer7c237072015-03-05 00:46:22 +00002768 MicrosoftCXXNameMangler Mangler(*this, Out);
David Majnemere7a818f2015-03-06 18:53:55 +00002769 Mangler.getStream() << "_CT";
2770
2771 llvm::SmallString<64> RTTIMangling;
2772 {
2773 llvm::raw_svector_ostream Stream(RTTIMangling);
David Majnemerfebb2722016-03-07 08:51:17 +00002774 msvc_hashing_ostream MHO(Stream);
2775 mangleCXXRTTI(T, MHO);
David Majnemere7a818f2015-03-06 18:53:55 +00002776 }
2777 Mangler.getStream() << RTTIMangling.substr(1);
2778
David Majnemer999cbf92015-03-10 19:01:51 +00002779 // VS2015 CTP6 omits the copy-constructor in the mangled name. This name is,
2780 // in fact, superfluous but I'm not sure the change was made consciously.
David Majnemere7a818f2015-03-06 18:53:55 +00002781 llvm::SmallString<64> CopyCtorMangling;
David Majnemerfebb2722016-03-07 08:51:17 +00002782 if (!getASTContext().getLangOpts().isCompatibleWithMSVC(
2783 LangOptions::MSVC2015) &&
2784 CD) {
David Majnemere7a818f2015-03-06 18:53:55 +00002785 llvm::raw_svector_ostream Stream(CopyCtorMangling);
David Majnemerfebb2722016-03-07 08:51:17 +00002786 msvc_hashing_ostream MHO(Stream);
2787 mangleCXXCtor(CD, CT, MHO);
David Majnemere7a818f2015-03-06 18:53:55 +00002788 }
2789 Mangler.getStream() << CopyCtorMangling.substr(1);
2790
David Majnemer7c237072015-03-05 00:46:22 +00002791 Mangler.getStream() << Size;
David Majnemer999cbf92015-03-10 19:01:51 +00002792 if (VBPtrOffset == -1) {
2793 if (NVOffset) {
2794 Mangler.getStream() << NVOffset;
2795 }
2796 } else {
2797 Mangler.getStream() << NVOffset;
2798 Mangler.getStream() << VBPtrOffset;
2799 Mangler.getStream() << VBIndex;
2800 }
David Majnemer7c237072015-03-05 00:46:22 +00002801}
2802
David Majnemera96b7ee2014-05-13 00:44:44 +00002803void MicrosoftMangleContextImpl::mangleCXXRTTIBaseClassDescriptor(
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00002804 const CXXRecordDecl *Derived, uint32_t NVOffset, int32_t VBPtrOffset,
David Majnemeraeb55c92014-05-13 06:57:43 +00002805 uint32_t VBTableOffset, uint32_t Flags, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00002806 msvc_hashing_ostream MHO(Out);
2807 MicrosoftCXXNameMangler Mangler(*this, MHO);
David Majnemera96b7ee2014-05-13 00:44:44 +00002808 Mangler.getStream() << "\01??_R1";
David Majnemera96b7ee2014-05-13 00:44:44 +00002809 Mangler.mangleNumber(NVOffset);
2810 Mangler.mangleNumber(VBPtrOffset);
2811 Mangler.mangleNumber(VBTableOffset);
2812 Mangler.mangleNumber(Flags);
David Majnemeraeb55c92014-05-13 06:57:43 +00002813 Mangler.mangleName(Derived);
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00002814 Mangler.getStream() << "8";
David Majnemera96b7ee2014-05-13 00:44:44 +00002815}
2816
2817void MicrosoftMangleContextImpl::mangleCXXRTTIBaseClassArray(
2818 const CXXRecordDecl *Derived, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00002819 msvc_hashing_ostream MHO(Out);
2820 MicrosoftCXXNameMangler Mangler(*this, MHO);
David Majnemera96b7ee2014-05-13 00:44:44 +00002821 Mangler.getStream() << "\01??_R2";
2822 Mangler.mangleName(Derived);
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00002823 Mangler.getStream() << "8";
David Majnemera96b7ee2014-05-13 00:44:44 +00002824}
2825
2826void MicrosoftMangleContextImpl::mangleCXXRTTIClassHierarchyDescriptor(
2827 const CXXRecordDecl *Derived, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00002828 msvc_hashing_ostream MHO(Out);
2829 MicrosoftCXXNameMangler Mangler(*this, MHO);
David Majnemera96b7ee2014-05-13 00:44:44 +00002830 Mangler.getStream() << "\01??_R3";
2831 Mangler.mangleName(Derived);
Warren Hunt5c2b4ea2014-05-23 16:07:43 +00002832 Mangler.getStream() << "8";
David Majnemera96b7ee2014-05-13 00:44:44 +00002833}
2834
2835void MicrosoftMangleContextImpl::mangleCXXRTTICompleteObjectLocator(
David Majnemeraeb55c92014-05-13 06:57:43 +00002836 const CXXRecordDecl *Derived, ArrayRef<const CXXRecordDecl *> BasePath,
2837 raw_ostream &Out) {
2838 // <mangled-name> ::= ?_R4 <class-name> <storage-class>
2839 // <cvr-qualifiers> [<name>] @
2840 // NOTE: <cvr-qualifiers> here is always 'B' (const). <storage-class>
2841 // is always '6' for vftables.
David Majnemerfebb2722016-03-07 08:51:17 +00002842 llvm::SmallString<64> VFTableMangling;
2843 llvm::raw_svector_ostream Stream(VFTableMangling);
2844 mangleCXXVFTable(Derived, BasePath, Stream);
2845
2846 if (VFTableMangling.startswith("\01??@")) {
2847 assert(VFTableMangling.endswith("@"));
2848 Out << VFTableMangling << "??_R4@";
2849 return;
2850 }
2851
2852 assert(VFTableMangling.startswith("\01??_7") ||
2853 VFTableMangling.startswith("\01??_S"));
2854
2855 Out << "\01??_R4" << StringRef(VFTableMangling).drop_front(5);
Guy Benyei11169dd2012-12-18 14:30:41 +00002856}
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00002857
Reid Kleckner1d59f992015-01-22 01:36:17 +00002858void MicrosoftMangleContextImpl::mangleSEHFilterExpression(
2859 const NamedDecl *EnclosingDecl, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00002860 msvc_hashing_ostream MHO(Out);
2861 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Kleckner1d59f992015-01-22 01:36:17 +00002862 // The function body is in the same comdat as the function with the handler,
2863 // so the numbering here doesn't have to be the same across TUs.
2864 //
2865 // <mangled-name> ::= ?filt$ <filter-number> @0
2866 Mangler.getStream() << "\01?filt$" << SEHFilterIds[EnclosingDecl]++ << "@0@";
2867 Mangler.mangleName(EnclosingDecl);
2868}
2869
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002870void MicrosoftMangleContextImpl::mangleSEHFinallyBlock(
2871 const NamedDecl *EnclosingDecl, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00002872 msvc_hashing_ostream MHO(Out);
2873 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Klecknerebaf28d2015-04-14 20:59:00 +00002874 // The function body is in the same comdat as the function with the handler,
2875 // so the numbering here doesn't have to be the same across TUs.
2876 //
2877 // <mangled-name> ::= ?fin$ <filter-number> @0
2878 Mangler.getStream() << "\01?fin$" << SEHFinallyIds[EnclosingDecl]++ << "@0@";
2879 Mangler.mangleName(EnclosingDecl);
2880}
2881
Reid Klecknercc99e262013-11-19 23:23:00 +00002882void MicrosoftMangleContextImpl::mangleTypeName(QualType T, raw_ostream &Out) {
2883 // This is just a made up unique string for the purposes of tbaa. undname
2884 // does *not* know how to demangle it.
2885 MicrosoftCXXNameMangler Mangler(*this, Out);
2886 Mangler.getStream() << '?';
2887 Mangler.mangleType(T, SourceRange());
2888}
2889
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00002890void MicrosoftMangleContextImpl::mangleCXXCtor(const CXXConstructorDecl *D,
2891 CXXCtorType Type,
2892 raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00002893 msvc_hashing_ostream MHO(Out);
2894 MicrosoftCXXNameMangler mangler(*this, MHO, D, Type);
Guy Benyei11169dd2012-12-18 14:30:41 +00002895 mangler.mangle(D);
2896}
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00002897
2898void MicrosoftMangleContextImpl::mangleCXXDtor(const CXXDestructorDecl *D,
2899 CXXDtorType Type,
2900 raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00002901 msvc_hashing_ostream MHO(Out);
2902 MicrosoftCXXNameMangler mangler(*this, MHO, D, Type);
Guy Benyei11169dd2012-12-18 14:30:41 +00002903 mangler.mangle(D);
2904}
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00002905
David Majnemere77de752015-12-29 22:25:14 +00002906void MicrosoftMangleContextImpl::mangleReferenceTemporary(
2907 const VarDecl *VD, unsigned ManglingNumber, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00002908 msvc_hashing_ostream MHO(Out);
2909 MicrosoftCXXNameMangler Mangler(*this, MHO);
David Majnemere77de752015-12-29 22:25:14 +00002910
2911 Mangler.getStream() << "\01?$RT" << ManglingNumber << '@';
2912 Mangler.mangle(VD, "");
Guy Benyei11169dd2012-12-18 14:30:41 +00002913}
2914
David Majnemer8354eee2015-05-07 06:15:46 +00002915void MicrosoftMangleContextImpl::mangleThreadSafeStaticGuardVariable(
2916 const VarDecl *VD, unsigned GuardNum, raw_ostream &Out) {
David Majnemerfebb2722016-03-07 08:51:17 +00002917 msvc_hashing_ostream MHO(Out);
2918 MicrosoftCXXNameMangler Mangler(*this, MHO);
David Majnemer8354eee2015-05-07 06:15:46 +00002919
2920 Mangler.getStream() << "\01?$TSS" << GuardNum << '@';
2921 Mangler.mangleNestedName(VD);
Dmitry Polukhin5fa681e2016-05-27 08:52:34 +00002922 Mangler.getStream() << "@4HA";
David Majnemer8354eee2015-05-07 06:15:46 +00002923}
2924
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00002925void MicrosoftMangleContextImpl::mangleStaticGuardVariable(const VarDecl *VD,
2926 raw_ostream &Out) {
David Majnemer2206bf52014-03-05 08:57:59 +00002927 // <guard-name> ::= ?_B <postfix> @5 <scope-depth>
David Majnemerec8e54b2015-05-07 21:19:06 +00002928 // ::= ?__J <postfix> @5 <scope-depth>
Reid Klecknerd8110b62013-09-10 20:14:30 +00002929 // ::= ?$S <guard-num> @ <postfix> @4IA
2930
2931 // The first mangling is what MSVC uses to guard static locals in inline
2932 // functions. It uses a different mangling in external functions to support
2933 // guarding more than 32 variables. MSVC rejects inline functions with more
2934 // than 32 static locals. We don't fully implement the second mangling
2935 // because those guards are not externally visible, and instead use LLVM's
2936 // default renaming when creating a new guard variable.
David Majnemerfebb2722016-03-07 08:51:17 +00002937 msvc_hashing_ostream MHO(Out);
2938 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002939
2940 bool Visible = VD->isExternallyVisible();
David Majnemer8354eee2015-05-07 06:15:46 +00002941 if (Visible) {
David Majnemerec8e54b2015-05-07 21:19:06 +00002942 Mangler.getStream() << (VD->getTLSKind() ? "\01??__J" : "\01??_B");
David Majnemer8354eee2015-05-07 06:15:46 +00002943 } else {
2944 Mangler.getStream() << "\01?$S1@";
2945 }
David Majnemer34b49892014-03-06 19:57:36 +00002946 unsigned ScopeDepth = 0;
2947 if (Visible && !getNextDiscriminator(VD, ScopeDepth))
2948 // If we do not have a discriminator and are emitting a guard variable for
2949 // use at global scope, then mangling the nested name will not be enough to
2950 // remove ambiguities.
2951 Mangler.mangle(VD, "");
2952 else
2953 Mangler.mangleNestedName(VD);
David Majnemer2206bf52014-03-05 08:57:59 +00002954 Mangler.getStream() << (Visible ? "@5" : "@4IA");
David Majnemer34b49892014-03-06 19:57:36 +00002955 if (ScopeDepth)
David Majnemer2206bf52014-03-05 08:57:59 +00002956 Mangler.mangleNumber(ScopeDepth);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002957}
2958
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00002959void MicrosoftMangleContextImpl::mangleInitFiniStub(const VarDecl *D,
David Majnemerfebb2722016-03-07 08:51:17 +00002960 char CharCode,
2961 raw_ostream &Out) {
2962 msvc_hashing_ostream MHO(Out);
2963 MicrosoftCXXNameMangler Mangler(*this, MHO);
Reid Kleckner1ece9fc2013-09-10 20:43:12 +00002964 Mangler.getStream() << "\01??__" << CharCode;
2965 Mangler.mangleName(D);
David Majnemerf55feec2014-03-06 19:10:27 +00002966 if (D->isStaticDataMember()) {
2967 Mangler.mangleVariableEncoding(D);
2968 Mangler.getStream() << '@';
2969 }
Reid Kleckner1ece9fc2013-09-10 20:43:12 +00002970 // This is the function class mangling. These stubs are global, non-variadic,
2971 // cdecl functions that return void and take no args.
2972 Mangler.getStream() << "YAXXZ";
2973}
2974
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00002975void MicrosoftMangleContextImpl::mangleDynamicInitializer(const VarDecl *D,
2976 raw_ostream &Out) {
Reid Kleckner1ece9fc2013-09-10 20:43:12 +00002977 // <initializer-name> ::= ?__E <name> YAXXZ
David Majnemerfebb2722016-03-07 08:51:17 +00002978 mangleInitFiniStub(D, 'E', Out);
Reid Kleckner1ece9fc2013-09-10 20:43:12 +00002979}
2980
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00002981void
2982MicrosoftMangleContextImpl::mangleDynamicAtExitDestructor(const VarDecl *D,
2983 raw_ostream &Out) {
Reid Kleckner1ece9fc2013-09-10 20:43:12 +00002984 // <destructor-name> ::= ?__F <name> YAXXZ
David Majnemerfebb2722016-03-07 08:51:17 +00002985 mangleInitFiniStub(D, 'F', Out);
Reid Klecknerd8110b62013-09-10 20:14:30 +00002986}
2987
David Majnemer58e5bee2014-03-24 21:43:36 +00002988void MicrosoftMangleContextImpl::mangleStringLiteral(const StringLiteral *SL,
2989 raw_ostream &Out) {
2990 // <char-type> ::= 0 # char
2991 // ::= 1 # wchar_t
2992 // ::= ??? # char16_t/char32_t will need a mangling too...
2993 //
2994 // <literal-length> ::= <non-negative integer> # the length of the literal
2995 //
2996 // <encoded-crc> ::= <hex digit>+ @ # crc of the literal including
2997 // # null-terminator
2998 //
2999 // <encoded-string> ::= <simple character> # uninteresting character
3000 // ::= '?$' <hex digit> <hex digit> # these two nibbles
3001 // # encode the byte for the
3002 // # character
3003 // ::= '?' [a-z] # \xe1 - \xfa
3004 // ::= '?' [A-Z] # \xc1 - \xda
3005 // ::= '?' [0-9] # [,/\:. \n\t'-]
3006 //
3007 // <literal> ::= '??_C@_' <char-type> <literal-length> <encoded-crc>
3008 // <encoded-string> '@'
3009 MicrosoftCXXNameMangler Mangler(*this, Out);
3010 Mangler.getStream() << "\01??_C@_";
3011
3012 // <char-type>: The "kind" of string literal is encoded into the mangled name.
David Majnemer98e77a22014-11-21 19:57:25 +00003013 if (SL->isWide())
David Majnemer58e5bee2014-03-24 21:43:36 +00003014 Mangler.getStream() << '1';
3015 else
David Majnemer98e77a22014-11-21 19:57:25 +00003016 Mangler.getStream() << '0';
David Majnemer58e5bee2014-03-24 21:43:36 +00003017
3018 // <literal-length>: The next part of the mangled name consists of the length
3019 // of the string.
3020 // The StringLiteral does not consider the NUL terminator byte(s) but the
3021 // mangling does.
3022 // N.B. The length is in terms of bytes, not characters.
3023 Mangler.mangleNumber(SL->getByteLength() + SL->getCharByteWidth());
3024
Malcolm Parsonsc6e45832017-01-13 18:55:32 +00003025 auto GetLittleEndianByte = [&SL](unsigned Index) {
David Majnemer4b293eb2014-03-31 17:18:53 +00003026 unsigned CharByteWidth = SL->getCharByteWidth();
3027 uint32_t CodeUnit = SL->getCodeUnit(Index / CharByteWidth);
David Majnemere49c4b62014-03-31 21:46:05 +00003028 unsigned OffsetInCodeUnit = Index % CharByteWidth;
3029 return static_cast<char>((CodeUnit >> (8 * OffsetInCodeUnit)) & 0xff);
David Majnemer4b293eb2014-03-31 17:18:53 +00003030 };
3031
Malcolm Parsonsc6e45832017-01-13 18:55:32 +00003032 auto GetBigEndianByte = [&SL](unsigned Index) {
David Majnemer4b293eb2014-03-31 17:18:53 +00003033 unsigned CharByteWidth = SL->getCharByteWidth();
3034 uint32_t CodeUnit = SL->getCodeUnit(Index / CharByteWidth);
David Majnemere49c4b62014-03-31 21:46:05 +00003035 unsigned OffsetInCodeUnit = (CharByteWidth - 1) - (Index % CharByteWidth);
3036 return static_cast<char>((CodeUnit >> (8 * OffsetInCodeUnit)) & 0xff);
David Majnemer4b293eb2014-03-31 17:18:53 +00003037 };
3038
David Majnemer58e5bee2014-03-24 21:43:36 +00003039 // CRC all the bytes of the StringLiteral.
David Majnemerb8ed3642015-09-01 21:24:07 +00003040 llvm::JamCRC JC;
David Majnemer4b293eb2014-03-31 17:18:53 +00003041 for (unsigned I = 0, E = SL->getByteLength(); I != E; ++I)
David Majnemerb8ed3642015-09-01 21:24:07 +00003042 JC.update(GetLittleEndianByte(I));
David Majnemer58e5bee2014-03-24 21:43:36 +00003043
3044 // The NUL terminator byte(s) were not present earlier,
3045 // we need to manually process those bytes into the CRC.
3046 for (unsigned NullTerminator = 0; NullTerminator < SL->getCharByteWidth();
3047 ++NullTerminator)
David Majnemerb8ed3642015-09-01 21:24:07 +00003048 JC.update('\x00');
David Majnemer58e5bee2014-03-24 21:43:36 +00003049
3050 // <encoded-crc>: The CRC is encoded utilizing the standard number mangling
3051 // scheme.
David Majnemerb8ed3642015-09-01 21:24:07 +00003052 Mangler.mangleNumber(JC.getCRC());
David Majnemer58e5bee2014-03-24 21:43:36 +00003053
David Majnemer981c3062014-03-30 16:38:02 +00003054 // <encoded-string>: The mangled name also contains the first 32 _characters_
David Majnemer58e5bee2014-03-24 21:43:36 +00003055 // (including null-terminator bytes) of the StringLiteral.
3056 // Each character is encoded by splitting them into bytes and then encoding
3057 // the constituent bytes.
3058 auto MangleByte = [&Mangler](char Byte) {
3059 // There are five different manglings for characters:
3060 // - [a-zA-Z0-9_$]: A one-to-one mapping.
3061 // - ?[a-z]: The range from \xe1 to \xfa.
3062 // - ?[A-Z]: The range from \xc1 to \xda.
3063 // - ?[0-9]: The set of [,/\:. \n\t'-].
3064 // - ?$XX: A fallback which maps nibbles.
David Majnemer10befcf2014-04-01 00:05:57 +00003065 if (isIdentifierBody(Byte, /*AllowDollar=*/true)) {
David Majnemer58e5bee2014-03-24 21:43:36 +00003066 Mangler.getStream() << Byte;
David Majnemer10befcf2014-04-01 00:05:57 +00003067 } else if (isLetter(Byte & 0x7f)) {
3068 Mangler.getStream() << '?' << static_cast<char>(Byte & 0x7f);
David Majnemer58e5bee2014-03-24 21:43:36 +00003069 } else {
David Majnemer07bc6112014-12-22 06:24:49 +00003070 const char SpecialChars[] = {',', '/', '\\', ':', '.',
3071 ' ', '\n', '\t', '\'', '-'};
3072 const char *Pos =
3073 std::find(std::begin(SpecialChars), std::end(SpecialChars), Byte);
3074 if (Pos != std::end(SpecialChars)) {
3075 Mangler.getStream() << '?' << (Pos - std::begin(SpecialChars));
3076 } else {
3077 Mangler.getStream() << "?$";
3078 Mangler.getStream() << static_cast<char>('A' + ((Byte >> 4) & 0xf));
3079 Mangler.getStream() << static_cast<char>('A' + (Byte & 0xf));
David Majnemer58e5bee2014-03-24 21:43:36 +00003080 }
3081 }
3082 };
3083
David Majnemer58e5bee2014-03-24 21:43:36 +00003084 // Enforce our 32 character max.
3085 unsigned NumCharsToMangle = std::min(32U, SL->getLength());
David Majnemer4b293eb2014-03-31 17:18:53 +00003086 for (unsigned I = 0, E = NumCharsToMangle * SL->getCharByteWidth(); I != E;
3087 ++I)
David Majnemer98e77a22014-11-21 19:57:25 +00003088 if (SL->isWide())
3089 MangleByte(GetBigEndianByte(I));
3090 else
3091 MangleByte(GetLittleEndianByte(I));
David Majnemer58e5bee2014-03-24 21:43:36 +00003092
3093 // Encode the NUL terminator if there is room.
3094 if (NumCharsToMangle < 32)
David Majnemer4b293eb2014-03-31 17:18:53 +00003095 for (unsigned NullTerminator = 0; NullTerminator < SL->getCharByteWidth();
3096 ++NullTerminator)
3097 MangleByte(0);
David Majnemer58e5bee2014-03-24 21:43:36 +00003098
3099 Mangler.getStream() << '@';
3100}
3101
Timur Iskhodzhanov67455222013-10-03 06:26:13 +00003102MicrosoftMangleContext *
3103MicrosoftMangleContext::create(ASTContext &Context, DiagnosticsEngine &Diags) {
3104 return new MicrosoftMangleContextImpl(Context, Diags);
Guy Benyei11169dd2012-12-18 14:30:41 +00003105}