contrib/llvm/tools/clang/lib/AST/MicrosoftMangle.cpp

   1 //===--- 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"
  17 #include "clang/AST/CXXInheritance.h"
  18 #include "clang/AST/CharUnits.h"
  19 #include "clang/AST/Decl.h"
  20 #include "clang/AST/DeclCXX.h"
  21 #include "clang/AST/DeclObjC.h"
  22 #include "clang/AST/DeclOpenMP.h"
  23 #include "clang/AST/DeclTemplate.h"
  24 #include "clang/AST/Expr.h"
  25 #include "clang/AST/ExprCXX.h"
  26 #include "clang/AST/VTableBuilder.h"
  27 #include "clang/Basic/ABI.h"
  28 #include "clang/Basic/DiagnosticOptions.h"
  29 #include "clang/Basic/TargetInfo.h"
  30 #include "llvm/ADT/StringExtras.h"
  31 #include "llvm/Support/JamCRC.h"
  32 #include "llvm/Support/MD5.h"
  33 #include "llvm/Support/MathExtras.h"
  34
  35 using namespace clang;
  36
  37 namespace {
  38
  39 struct 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
  69 static const DeclContext *
  70 getLambdaDefaultArgumentDeclContext(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
  79 /// Retrieve the declaration context that should be used when mangling
  80 /// the given declaration.
  81 static 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.
  88   if (const auto *LDADC = getLambdaDefaultArgumentDeclContext(D))
  89     return LDADC;
  90
  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();
  99   if (isa<CapturedDecl>(DC) || isa<OMPDeclareReductionDecl>(DC)) {
 100     return getEffectiveDeclContext(cast<Decl>(DC));
 101   }
 102
 103   return DC->getRedeclContext();
 104 }
 105
 106 static const DeclContext *getEffectiveParentContext(const DeclContext *DC) {
 107   return getEffectiveDeclContext(cast<Decl>(DC));
 108 }
 109
 110 static const FunctionDecl *getStructor(const NamedDecl *ND) {
 111   if (const auto *FTD = dyn_cast<FunctionTemplateDecl>(ND))
 112     return FTD->getTemplatedDecl()->getCanonicalDecl();
 113
 114   const auto *FD = cast<FunctionDecl>(ND);
 115   if (const auto *FTD = FD->getPrimaryTemplate())
 116     return FTD->getTemplatedDecl()->getCanonicalDecl();
 117
 118   return FD->getCanonicalDecl();
 119 }
 120
 121 /// MicrosoftMangleContextImpl - Overrides the default MangleContext for the
 122 /// Microsoft Visual C++ ABI.
 123 class MicrosoftMangleContextImpl : public MicrosoftMangleContext {
 124   typedef std::pair<const DeclContext *, IdentifierInfo *> DiscriminatorKeyTy;
 125   llvm::DenseMap<DiscriminatorKeyTy, unsigned> Discriminator;
 126   llvm::DenseMap<const NamedDecl *, unsigned> Uniquifier;
 127   llvm::DenseMap<const CXXRecordDecl *, unsigned> LambdaIds;
 128   llvm::DenseMap<const NamedDecl *, unsigned> SEHFilterIds;
 129   llvm::DenseMap<const NamedDecl *, unsigned> SEHFinallyIds;
 130
 131 public:
 132   MicrosoftMangleContextImpl(ASTContext &Context, DiagnosticsEngine &Diags)
 133       : MicrosoftMangleContext(Context, Diags) {}
 134   bool shouldMangleCXXName(const NamedDecl *D) override;
 135   bool shouldMangleStringLiteral(const StringLiteral *SL) override;
 136   void mangleCXXName(const NamedDecl *D, raw_ostream &Out) override;
 137   void mangleVirtualMemPtrThunk(const CXXMethodDecl *MD,
 138                                 const MethodVFTableLocation &ML,
 139                                 raw_ostream &Out) override;
 140   void mangleThunk(const CXXMethodDecl *MD, const ThunkInfo &Thunk,
 141                    raw_ostream &) override;
 142   void mangleCXXDtorThunk(const CXXDestructorDecl *DD, CXXDtorType Type,
 143                           const ThisAdjustment &ThisAdjustment,
 144                           raw_ostream &) override;
 145   void mangleCXXVFTable(const CXXRecordDecl *Derived,
 146                         ArrayRef<const CXXRecordDecl *> BasePath,
 147                         raw_ostream &Out) override;
 148   void mangleCXXVBTable(const CXXRecordDecl *Derived,
 149                         ArrayRef<const CXXRecordDecl *> BasePath,
 150                         raw_ostream &Out) override;
 151   void mangleCXXVirtualDisplacementMap(const CXXRecordDecl *SrcRD,
 152                                        const CXXRecordDecl *DstRD,
 153                                        raw_ostream &Out) override;
 154   void mangleCXXThrowInfo(QualType T, bool IsConst, bool IsVolatile,
 155                           bool IsUnaligned, uint32_t NumEntries,
 156                           raw_ostream &Out) override;
 157   void mangleCXXCatchableTypeArray(QualType T, uint32_t NumEntries,
 158                                    raw_ostream &Out) override;
 159   void mangleCXXCatchableType(QualType T, const CXXConstructorDecl *CD,
 160                               CXXCtorType CT, uint32_t Size, uint32_t NVOffset,
 161                               int32_t VBPtrOffset, uint32_t VBIndex,
 162                               raw_ostream &Out) override;
 163   void mangleCXXRTTI(QualType T, raw_ostream &Out) override;
 164   void mangleCXXRTTIName(QualType T, raw_ostream &Out) override;
 165   void mangleCXXRTTIBaseClassDescriptor(const CXXRecordDecl *Derived,
 166                                         uint32_t NVOffset, int32_t VBPtrOffset,
 167                                         uint32_t VBTableOffset, uint32_t Flags,
 168                                         raw_ostream &Out) override;
 169   void mangleCXXRTTIBaseClassArray(const CXXRecordDecl *Derived,
 170                                    raw_ostream &Out) override;
 171   void mangleCXXRTTIClassHierarchyDescriptor(const CXXRecordDecl *Derived,
 172                                              raw_ostream &Out) override;
 173   void
 174   mangleCXXRTTICompleteObjectLocator(const CXXRecordDecl *Derived,
 175                                      ArrayRef<const CXXRecordDecl *> BasePath,
 176                                      raw_ostream &Out) override;
 177   void mangleTypeName(QualType T, raw_ostream &) override;
 178   void mangleCXXCtor(const CXXConstructorDecl *D, CXXCtorType Type,
 179                      raw_ostream &) override;
 180   void mangleCXXDtor(const CXXDestructorDecl *D, CXXDtorType Type,
 181                      raw_ostream &) override;
 182   void mangleReferenceTemporary(const VarDecl *, unsigned ManglingNumber,
 183                                 raw_ostream &) override;
 184   void mangleStaticGuardVariable(const VarDecl *D, raw_ostream &Out) override;
 185   void mangleThreadSafeStaticGuardVariable(const VarDecl *D, unsigned GuardNum,
 186                                            raw_ostream &Out) override;
 187   void mangleDynamicInitializer(const VarDecl *D, raw_ostream &Out) override;
 188   void mangleDynamicAtExitDestructor(const VarDecl *D,
 189                                      raw_ostream &Out) override;
 190   void mangleSEHFilterExpression(const NamedDecl *EnclosingDecl,
 191                                  raw_ostream &Out) override;
 192   void mangleSEHFinallyBlock(const NamedDecl *EnclosingDecl,
 193                              raw_ostream &Out) override;
 194   void mangleStringLiteral(const StringLiteral *SL, raw_ostream &Out) override;
 195   bool getNextDiscriminator(const NamedDecl *ND, unsigned &disc) {
 196     const DeclContext *DC = getEffectiveDeclContext(ND);
 197     if (!DC->isFunctionOrMethod())
 198       return false;
 199
 200     // Lambda closure types are already numbered, give out a phony number so
 201     // that they demangle nicely.
 202     if (const auto *RD = dyn_cast<CXXRecordDecl>(ND)) {
 203       if (RD->isLambda()) {
 204         disc = 1;
 205         return true;
 206       }
 207     }
 208
 209     // Use the canonical number for externally visible decls.
 210     if (ND->isExternallyVisible()) {
 211       disc = getASTContext().getManglingNumber(ND);
 212       return true;
 213     }
 214
 215     // Anonymous tags are already numbered.
 216     if (const TagDecl *Tag = dyn_cast<TagDecl>(ND)) {
 217       if (!Tag->hasNameForLinkage() &&
 218           !getASTContext().getDeclaratorForUnnamedTagDecl(Tag) &&
 219           !getASTContext().getTypedefNameForUnnamedTagDecl(Tag))
 220         return false;
 221     }
 222
 223     // Make up a reasonable number for internal decls.
 224     unsigned &discriminator = Uniquifier[ND];
 225     if (!discriminator)
 226       discriminator = ++Discriminator[std::make_pair(DC, ND->getIdentifier())];
 227     disc = discriminator + 1;
 228     return true;
 229   }
 230
 231   unsigned getLambdaId(const CXXRecordDecl *RD) {
 232     assert(RD->isLambda() && "RD must be a lambda!");
 233     assert(!RD->isExternallyVisible() && "RD must not be visible!");
 234     assert(RD->getLambdaManglingNumber() == 0 &&
 235            "RD must not have a mangling number!");
 236     std::pair<llvm::DenseMap<const CXXRecordDecl *, unsigned>::iterator, bool>
 237         Result = LambdaIds.insert(std::make_pair(RD, LambdaIds.size()));
 238     return Result.first->second;
 239   }
 240
 241 private:
 242   void mangleInitFiniStub(const VarDecl *D, char CharCode, raw_ostream &Out);
 243 };
 244
 245 /// MicrosoftCXXNameMangler - Manage the mangling of a single name for the
 246 /// Microsoft Visual C++ ABI.
 247 class MicrosoftCXXNameMangler {
 248   MicrosoftMangleContextImpl &Context;
 249   raw_ostream &Out;
 250
 251   /// The "structor" is the top-level declaration being mangled, if
 252   /// that's not a template specialization; otherwise it's the pattern
 253   /// for that specialization.
 254   const NamedDecl *Structor;
 255   unsigned StructorType;
 256
 257   typedef llvm::SmallVector<std::string, 10> BackRefVec;
 258   BackRefVec NameBackReferences;
 259
 260   typedef llvm::DenseMap<const void *, unsigned> ArgBackRefMap;
 261   ArgBackRefMap TypeBackReferences;
 262
 263   typedef std::set<int> PassObjectSizeArgsSet;
 264   PassObjectSizeArgsSet PassObjectSizeArgs;
 265
 266   ASTContext &getASTContext() const { return Context.getASTContext(); }
 267
 268   // FIXME: If we add support for __ptr32/64 qualifiers, then we should push
 269   // this check into mangleQualifiers().
 270   const bool PointersAre64Bit;
 271
 272 public:
 273   enum QualifierMangleMode { QMM_Drop, QMM_Mangle, QMM_Escape, QMM_Result };
 274
 275   MicrosoftCXXNameMangler(MicrosoftMangleContextImpl &C, raw_ostream &Out_)
 276       : Context(C), Out(Out_), Structor(nullptr), StructorType(-1),
 277         PointersAre64Bit(C.getASTContext().getTargetInfo().getPointerWidth(0) ==
 278                          64) {}
 279
 280   MicrosoftCXXNameMangler(MicrosoftMangleContextImpl &C, raw_ostream &Out_,
 281                           const CXXConstructorDecl *D, CXXCtorType Type)
 282       : Context(C), Out(Out_), Structor(getStructor(D)), StructorType(Type),
 283         PointersAre64Bit(C.getASTContext().getTargetInfo().getPointerWidth(0) ==
 284                          64) {}
 285
 286   MicrosoftCXXNameMangler(MicrosoftMangleContextImpl &C, raw_ostream &Out_,
 287                           const CXXDestructorDecl *D, CXXDtorType Type)
 288       : Context(C), Out(Out_), Structor(getStructor(D)), StructorType(Type),
 289         PointersAre64Bit(C.getASTContext().getTargetInfo().getPointerWidth(0) ==
 290                          64) {}
 291
 292   raw_ostream &getStream() const { return Out; }
 293
 294   void mangle(const NamedDecl *D, StringRef Prefix = "?");
 295   void mangleName(const NamedDecl *ND);
 296   void mangleFunctionEncoding(const FunctionDecl *FD, bool ShouldMangle);
 297   void mangleVariableEncoding(const VarDecl *VD);
 298   void mangleMemberDataPointer(const CXXRecordDecl *RD, const ValueDecl *VD);
 299   void mangleMemberFunctionPointer(const CXXRecordDecl *RD,
 300                                    const CXXMethodDecl *MD);
 301   void mangleVirtualMemPtrThunk(const CXXMethodDecl *MD,
 302                                 const MethodVFTableLocation &ML);
 303   void mangleNumber(int64_t Number);
 304   void mangleTagTypeKind(TagTypeKind TK);
 305   void mangleArtificalTagType(TagTypeKind TK, StringRef UnqualifiedName,
 306                               ArrayRef<StringRef> NestedNames = None);
 307   void mangleType(QualType T, SourceRange Range,
 308                   QualifierMangleMode QMM = QMM_Mangle);
 309   void mangleFunctionType(const FunctionType *T,
 310                           const FunctionDecl *D = nullptr,
 311                           bool ForceThisQuals = false);
 312   void mangleNestedName(const NamedDecl *ND);
 313
 314 private:
 315   bool isStructorDecl(const NamedDecl *ND) const {
 316     return ND == Structor || getStructor(ND) == Structor;
 317   }
 318
 319   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);
 327   void mangleRefQualifier(RefQualifierKind RefQualifier);
 328   void manglePointerCVQualifiers(Qualifiers Quals);
 329   void manglePointerExtQualifiers(Qualifiers Quals, QualType PointeeType);
 330
 331   void mangleUnscopedTemplateName(const TemplateDecl *ND);
 332   void
 333   mangleTemplateInstantiationName(const TemplateDecl *TD,
 334                                   const TemplateArgumentList &TemplateArgs);
 335   void mangleObjCMethodName(const ObjCMethodDecl *MD);
 336
 337   void mangleArgumentType(QualType T, SourceRange Range);
 338   void manglePassObjectSizeArg(const PassObjectSizeAttr *POSA);
 339
 340   bool isArtificialTagType(QualType T) const;
 341
 342   // Declare manglers for every type class.
 343 #define ABSTRACT_TYPE(CLASS, PARENT)
 344 #define NON_CANONICAL_TYPE(CLASS, PARENT)
 345 #define TYPE(CLASS, PARENT) void mangleType(const CLASS##Type *T, \
 346                                             Qualifiers Quals, \
 347                                             SourceRange Range);
 348 #include "clang/AST/TypeNodes.def"
 349 #undef ABSTRACT_TYPE
 350 #undef NON_CANONICAL_TYPE
 351 #undef TYPE
 352
 353   void mangleType(const TagDecl *TD);
 354   void mangleDecayedArrayType(const ArrayType *T);
 355   void mangleArrayType(const ArrayType *T);
 356   void mangleFunctionClass(const FunctionDecl *FD);
 357   void mangleCallingConvention(CallingConv CC);
 358   void mangleCallingConvention(const FunctionType *T);
 359   void mangleIntegerLiteral(const llvm::APSInt &Number, bool IsBoolean);
 360   void mangleExpression(const Expr *E);
 361   void mangleThrowSpecification(const FunctionProtoType *T);
 362
 363   void mangleTemplateArgs(const TemplateDecl *TD,
 364                           const TemplateArgumentList &TemplateArgs);
 365   void mangleTemplateArg(const TemplateDecl *TD, const TemplateArgument &TA,
 366                          const NamedDecl *Parm);
 367
 368   void mangleObjCProtocol(const ObjCProtocolDecl *PD);
 369   void mangleObjCLifetime(const QualType T, Qualifiers Quals,
 370                           SourceRange Range);
 371 };
 372 }
 373
 374 bool MicrosoftMangleContextImpl::shouldMangleCXXName(const NamedDecl *D) {
 375   if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
 376     LanguageLinkage L = FD->getLanguageLinkage();
 377     // Overloadable functions need mangling.
 378     if (FD->hasAttr<OverloadableAttr>())
 379       return true;
 380
 381     // The ABI expects that we would never mangle "typical" user-defined entry
 382     // points regardless of visibility or freestanding-ness.
 383     //
 384     // N.B. This is distinct from asking about "main".  "main" has a lot of
 385     // special rules associated with it in the standard while these
 386     // user-defined entry points are outside of the purview of the standard.
 387     // For example, there can be only one definition for "main" in a standards
 388     // compliant program; however nothing forbids the existence of wmain and
 389     // WinMain in the same translation unit.
 390     if (FD->isMSVCRTEntryPoint())
 391       return false;
 392
 393     // C++ functions and those whose names are not a simple identifier need
 394     // mangling.
 395     if (!FD->getDeclName().isIdentifier() || L == CXXLanguageLinkage)
 396       return true;
 397
 398     // C functions are not mangled.
 399     if (L == CLanguageLinkage)
 400       return false;
 401   }
 402
 403   // Otherwise, no mangling is done outside C++ mode.
 404   if (!getASTContext().getLangOpts().CPlusPlus)
 405     return false;
 406
 407   const VarDecl *VD = dyn_cast<VarDecl>(D);
 408   if (VD && !isa<DecompositionDecl>(D)) {
 409     // C variables are not mangled.
 410     if (VD->isExternC())
 411       return false;
 412
 413     // Variables at global scope with non-internal linkage are not mangled.
 414     const DeclContext *DC = getEffectiveDeclContext(D);
 415     // Check for extern variable declared locally.
 416     if (DC->isFunctionOrMethod() && D->hasLinkage())
 417       while (!DC->isNamespace() && !DC->isTranslationUnit())
 418         DC = getEffectiveParentContext(DC);
 419
 420     if (DC->isTranslationUnit() && D->getFormalLinkage() == InternalLinkage &&
 421         !isa<VarTemplateSpecializationDecl>(D) &&
 422         D->getIdentifier() != nullptr)
 423       return false;
 424   }
 425
 426   return true;
 427 }
 428
 429 bool
 430 MicrosoftMangleContextImpl::shouldMangleStringLiteral(const StringLiteral *SL) {
 431   return true;
 432 }
 433
 434 void MicrosoftCXXNameMangler::mangle(const NamedDecl *D, StringRef Prefix) {
 435   // MSVC doesn't mangle C++ names the same way it mangles extern "C" names.
 436   // Therefore it's really important that we don't decorate the
 437   // name with leading underscores or leading/trailing at signs. So, by
 438   // default, we emit an asm marker at the start so we get the name right.
 439   // Callers can override this with a custom prefix.
 440
 441   // <mangled-name> ::= ? <name> <type-encoding>
 442   Out << Prefix;
 443   mangleName(D);
 444   if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
 445     mangleFunctionEncoding(FD, Context.shouldMangleDeclName(FD));
 446   else if (const VarDecl *VD = dyn_cast<VarDecl>(D))
 447     mangleVariableEncoding(VD);
 448   else if (!isa<ObjCInterfaceDecl>(D))
 449     llvm_unreachable("Tried to mangle unexpected NamedDecl!");
 450 }
 451
 452 void MicrosoftCXXNameMangler::mangleFunctionEncoding(const FunctionDecl *FD,
 453                                                      bool ShouldMangle) {
 454   // <type-encoding> ::= <function-class> <function-type>
 455
 456   // Since MSVC operates on the type as written and not the canonical type, it
 457   // actually matters which decl we have here.  MSVC appears to choose the
 458   // first, since it is most likely to be the declaration in a header file.
 459   FD = FD->getFirstDecl();
 460
 461   // We should never ever see a FunctionNoProtoType at this point.
 462   // We don't even know how to mangle their types anyway :).
 463   const FunctionProtoType *FT = FD->getType()->castAs<FunctionProtoType>();
 464
 465   // extern "C" functions can hold entities that must be mangled.
 466   // As it stands, these functions still need to get expressed in the full
 467   // external name.  They have their class and type omitted, replaced with '9'.
 468   if (ShouldMangle) {
 469     // We would like to mangle all extern "C" functions using this additional
 470     // component but this would break compatibility with MSVC's behavior.
 471     // Instead, do this when we know that compatibility isn't important (in
 472     // other words, when it is an overloaded extern "C" function).
 473     if (FD->isExternC() && FD->hasAttr<OverloadableAttr>())
 474       Out << "$$J0";
 475
 476     mangleFunctionClass(FD);
 477
 478     mangleFunctionType(FT, FD);
 479   } else {
 480     Out << '9';
 481   }
 482 }
 483
 484 void MicrosoftCXXNameMangler::mangleVariableEncoding(const VarDecl *VD) {
 485   // <type-encoding> ::= <storage-class> <variable-type>
 486   // <storage-class> ::= 0  # private static member
 487   //                 ::= 1  # protected static member
 488   //                 ::= 2  # public static member
 489   //                 ::= 3  # global
 490   //                 ::= 4  # static local
 491
 492   // The first character in the encoding (after the name) is the storage class.
 493   if (VD->isStaticDataMember()) {
 494     // If it's a static member, it also encodes the access level.
 495     switch (VD->getAccess()) {
 496       default:
 497       case AS_private: Out << '0'; break;
 498       case AS_protected: Out << '1'; break;
 499       case AS_public: Out << '2'; break;
 500     }
 501   }
 502   else if (!VD->isStaticLocal())
 503     Out << '3';
 504   else
 505     Out << '4';
 506   // Now mangle the type.
 507   // <variable-type> ::= <type> <cvr-qualifiers>
 508   //                 ::= <type> <pointee-cvr-qualifiers> # pointers, references
 509   // Pointers and references are odd. The type of 'int * const foo;' gets
 510   // mangled as 'QAHA' instead of 'PAHB', for example.
 511   SourceRange SR = VD->getSourceRange();
 512   QualType Ty = VD->getType();
 513   if (Ty->isPointerType() || Ty->isReferenceType() ||
 514       Ty->isMemberPointerType()) {
 515     mangleType(Ty, SR, QMM_Drop);
 516     manglePointerExtQualifiers(
 517         Ty.getDesugaredType(getASTContext()).getLocalQualifiers(), QualType());
 518     if (const MemberPointerType *MPT = Ty->getAs<MemberPointerType>()) {
 519       mangleQualifiers(MPT->getPointeeType().getQualifiers(), true);
 520       // Member pointers are suffixed with a back reference to the member
 521       // pointer's class name.
 522       mangleName(MPT->getClass()->getAsCXXRecordDecl());
 523     } else
 524       mangleQualifiers(Ty->getPointeeType().getQualifiers(), false);
 525   } else if (const ArrayType *AT = getASTContext().getAsArrayType(Ty)) {
 526     // Global arrays are funny, too.
 527     mangleDecayedArrayType(AT);
 528     if (AT->getElementType()->isArrayType())
 529       Out << 'A';
 530     else
 531       mangleQualifiers(Ty.getQualifiers(), false);
 532   } else {
 533     mangleType(Ty, SR, QMM_Drop);
 534     mangleQualifiers(Ty.getQualifiers(), false);
 535   }
 536 }
 537
 538 void MicrosoftCXXNameMangler::mangleMemberDataPointer(const CXXRecordDecl *RD,
 539                                                       const ValueDecl *VD) {
 540   // <member-data-pointer> ::= <integer-literal>
 541   //                       ::= $F <number> <number>
 542   //                       ::= $G <number> <number> <number>
 543
 544   int64_t FieldOffset;
 545   int64_t VBTableOffset;
 546   MSInheritanceAttr::Spelling IM = RD->getMSInheritanceModel();
 547   if (VD) {
 548     FieldOffset = getASTContext().getFieldOffset(VD);
 549     assert(FieldOffset % getASTContext().getCharWidth() == 0 &&
 550            "cannot take address of bitfield");
 551     FieldOffset /= getASTContext().getCharWidth();
 552
 553     VBTableOffset = 0;
 554
 555     if (IM == MSInheritanceAttr::Keyword_virtual_inheritance)
 556       FieldOffset -= getASTContext().getOffsetOfBaseWithVBPtr(RD).getQuantity();
 557   } else {
 558     FieldOffset = RD->nullFieldOffsetIsZero() ? 0 : -1;
 559
 560     VBTableOffset = -1;
 561   }
 562
 563   char Code = '\0';
 564   switch (IM) {
 565   case MSInheritanceAttr::Keyword_single_inheritance:      Code = '0'; break;
 566   case MSInheritanceAttr::Keyword_multiple_inheritance:    Code = '0'; break;
 567   case MSInheritanceAttr::Keyword_virtual_inheritance:     Code = 'F'; break;
 568   case MSInheritanceAttr::Keyword_unspecified_inheritance: Code = 'G'; break;
 569   }
 570
 571   Out << '$' << Code;
 572
 573   mangleNumber(FieldOffset);
 574
 575   // The C++ standard doesn't allow base-to-derived member pointer conversions
 576   // in template parameter contexts, so the vbptr offset of data member pointers
 577   // is always zero.
 578   if (MSInheritanceAttr::hasVBPtrOffsetField(IM))
 579     mangleNumber(0);
 580   if (MSInheritanceAttr::hasVBTableOffsetField(IM))
 581     mangleNumber(VBTableOffset);
 582 }
 583
 584 void
 585 MicrosoftCXXNameMangler::mangleMemberFunctionPointer(const CXXRecordDecl *RD,
 586                                                      const CXXMethodDecl *MD) {
 587   // <member-function-pointer> ::= $1? <name>
 588   //                           ::= $H? <name> <number>
 589   //                           ::= $I? <name> <number> <number>
 590   //                           ::= $J? <name> <number> <number> <number>
 591
 592   MSInheritanceAttr::Spelling IM = RD->getMSInheritanceModel();
 593
 594   char Code = '\0';
 595   switch (IM) {
 596   case MSInheritanceAttr::Keyword_single_inheritance:      Code = '1'; break;
 597   case MSInheritanceAttr::Keyword_multiple_inheritance:    Code = 'H'; break;
 598   case MSInheritanceAttr::Keyword_virtual_inheritance:     Code = 'I'; break;
 599   case MSInheritanceAttr::Keyword_unspecified_inheritance: Code = 'J'; break;
 600   }
 601
 602   // If non-virtual, mangle the name.  If virtual, mangle as a virtual memptr
 603   // thunk.
 604   uint64_t NVOffset = 0;
 605   uint64_t VBTableOffset = 0;
 606   uint64_t VBPtrOffset = 0;
 607   if (MD) {
 608     Out << '$' << Code << '?';
 609     if (MD->isVirtual()) {
 610       MicrosoftVTableContext *VTContext =
 611           cast<MicrosoftVTableContext>(getASTContext().getVTableContext());
 612       MethodVFTableLocation ML =
 613           VTContext->getMethodVFTableLocation(GlobalDecl(MD));
 614       mangleVirtualMemPtrThunk(MD, ML);
 615       NVOffset = ML.VFPtrOffset.getQuantity();
 616       VBTableOffset = ML.VBTableIndex * 4;
 617       if (ML.VBase) {
 618         const ASTRecordLayout &Layout = getASTContext().getASTRecordLayout(RD);
 619         VBPtrOffset = Layout.getVBPtrOffset().getQuantity();
 620       }
 621     } else {
 622       mangleName(MD);
 623       mangleFunctionEncoding(MD, /*ShouldMangle=*/true);
 624     }
 625
 626     if (VBTableOffset == 0 &&
 627         IM == MSInheritanceAttr::Keyword_virtual_inheritance)
 628       NVOffset -= getASTContext().getOffsetOfBaseWithVBPtr(RD).getQuantity();
 629   } else {
 630     // Null single inheritance member functions are encoded as a simple nullptr.
 631     if (IM == MSInheritanceAttr::Keyword_single_inheritance) {
 632       Out << "$0A@";
 633       return;
 634     }
 635     if (IM == MSInheritanceAttr::Keyword_unspecified_inheritance)
 636       VBTableOffset = -1;
 637     Out << '$' << Code;
 638   }
 639
 640   if (MSInheritanceAttr::hasNVOffsetField(/*IsMemberFunction=*/true, IM))
 641     mangleNumber(static_cast<uint32_t>(NVOffset));
 642   if (MSInheritanceAttr::hasVBPtrOffsetField(IM))
 643     mangleNumber(VBPtrOffset);
 644   if (MSInheritanceAttr::hasVBTableOffsetField(IM))
 645     mangleNumber(VBTableOffset);
 646 }
 647
 648 void MicrosoftCXXNameMangler::mangleVirtualMemPtrThunk(
 649     const CXXMethodDecl *MD, const MethodVFTableLocation &ML) {
 650   // Get the vftable offset.
 651   CharUnits PointerWidth = getASTContext().toCharUnitsFromBits(
 652       getASTContext().getTargetInfo().getPointerWidth(0));
 653   uint64_t OffsetInVFTable = ML.Index * PointerWidth.getQuantity();
 654
 655   Out << "?_9";
 656   mangleName(MD->getParent());
 657   Out << "$B";
 658   mangleNumber(OffsetInVFTable);
 659   Out << 'A';
 660   mangleCallingConvention(MD->getType()->getAs<FunctionProtoType>());
 661 }
 662
 663 void MicrosoftCXXNameMangler::mangleName(const NamedDecl *ND) {
 664   // <name> ::= <unscoped-name> {[<named-scope>]+ | [<nested-name>]}? @
 665
 666   // Always start with the unqualified name.
 667   mangleUnqualifiedName(ND);
 668
 669   mangleNestedName(ND);
 670
 671   // Terminate the whole name with an '@'.
 672   Out << '@';
 673 }
 674
 675 void MicrosoftCXXNameMangler::mangleNumber(int64_t Number) {
 676   // <non-negative integer> ::= A@              # when Number == 0
 677   //                        ::= <decimal digit> # when 1 <= Number <= 10
 678   //                        ::= <hex digit>+ @  # when Number >= 10
 679   //
 680   // <number>               ::= [?] <non-negative integer>
 681
 682   uint64_t Value = static_cast<uint64_t>(Number);
 683   if (Number < 0) {
 684     Value = -Value;
 685     Out << '?';
 686   }
 687
 688   if (Value == 0)
 689     Out << "A@";
 690   else if (Value >= 1 && Value <= 10)
 691     Out << (Value - 1);
 692   else {
 693     // Numbers that are not encoded as decimal digits are represented as nibbles
 694     // in the range of ASCII characters 'A' to 'P'.
 695     // The number 0x123450 would be encoded as 'BCDEFA'
 696     char EncodedNumberBuffer[sizeof(uint64_t) * 2];
 697     MutableArrayRef<char> BufferRef(EncodedNumberBuffer);
 698     MutableArrayRef<char>::reverse_iterator I = BufferRef.rbegin();
 699     for (; Value != 0; Value >>= 4)
 700       *I++ = 'A' + (Value & 0xf);
 701     Out.write(I.base(), I - BufferRef.rbegin());
 702     Out << '@';
 703   }
 704 }
 705
 706 static const TemplateDecl *
 707 isTemplate(const NamedDecl *ND, const TemplateArgumentList *&TemplateArgs) {
 708   // Check if we have a function template.
 709   if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)) {
 710     if (const TemplateDecl *TD = FD->getPrimaryTemplate()) {
 711       TemplateArgs = FD->getTemplateSpecializationArgs();
 712       return TD;
 713     }
 714   }
 715
 716   // Check if we have a class template.
 717   if (const ClassTemplateSpecializationDecl *Spec =
 718           dyn_cast<ClassTemplateSpecializationDecl>(ND)) {
 719     TemplateArgs = &Spec->getTemplateArgs();
 720     return Spec->getSpecializedTemplate();
 721   }
 722
 723   // Check if we have a variable template.
 724   if (const VarTemplateSpecializationDecl *Spec =
 725           dyn_cast<VarTemplateSpecializationDecl>(ND)) {
 726     TemplateArgs = &Spec->getTemplateArgs();
 727     return Spec->getSpecializedTemplate();
 728   }
 729
 730   return nullptr;
 731 }
 732
 733 void MicrosoftCXXNameMangler::mangleUnqualifiedName(const NamedDecl *ND,
 734                                                     DeclarationName Name) {
 735   //  <unqualified-name> ::= <operator-name>
 736   //                     ::= <ctor-dtor-name>
 737   //                     ::= <source-name>
 738   //                     ::= <template-name>
 739
 740   // Check if we have a template.
 741   const TemplateArgumentList *TemplateArgs = nullptr;
 742   if (const TemplateDecl *TD = isTemplate(ND, TemplateArgs)) {
 743     // Function templates aren't considered for name back referencing.  This
 744     // makes sense since function templates aren't likely to occur multiple
 745     // times in a symbol.
 746     if (isa<FunctionTemplateDecl>(TD)) {
 747       mangleTemplateInstantiationName(TD, *TemplateArgs);
 748       Out << '@';
 749       return;
 750     }
 751
 752     // Here comes the tricky thing: if we need to mangle something like
 753     //   void foo(A::X<Y>, B::X<Y>),
 754     // the X<Y> part is aliased. However, if you need to mangle
 755     //   void foo(A::X<A::Y>, A::X<B::Y>),
 756     // the A::X<> part is not aliased.
 757     // That said, from the mangler's perspective we have a structure like this:
 758     //   namespace[s] -> type[ -> template-parameters]
 759     // but from the Clang perspective we have
 760     //   type [ -> template-parameters]
 761     //      \-> namespace[s]
 762     // What we do is we create a new mangler, mangle the same type (without
 763     // a namespace suffix) to a string using the extra mangler and then use
 764     // the mangled type name as a key to check the mangling of different types
 765     // for aliasing.
 766
 767     llvm::SmallString<64> TemplateMangling;
 768     llvm::raw_svector_ostream Stream(TemplateMangling);
 769     MicrosoftCXXNameMangler Extra(Context, Stream);
 770     Extra.mangleTemplateInstantiationName(TD, *TemplateArgs);
 771
 772     mangleSourceName(TemplateMangling);
 773     return;
 774   }
 775
 776   switch (Name.getNameKind()) {
 777     case DeclarationName::Identifier: {
 778       if (const IdentifierInfo *II = Name.getAsIdentifierInfo()) {
 779         mangleSourceName(II->getName());
 780         break;
 781       }
 782
 783       // Otherwise, an anonymous entity.  We must have a declaration.
 784       assert(ND && "mangling empty name without declaration");
 785
 786       if (const NamespaceDecl *NS = dyn_cast<NamespaceDecl>(ND)) {
 787         if (NS->isAnonymousNamespace()) {
 788           Out << "?A@";
 789           break;
 790         }
 791       }
 792
 793       if (const DecompositionDecl *DD = dyn_cast<DecompositionDecl>(ND)) {
 794         // FIXME: Invented mangling for decomposition declarations:
 795         //   [X,Y,Z]
 796         // where X,Y,Z are the names of the bindings.
 797         llvm::SmallString<128> Name("[");
 798         for (auto *BD : DD->bindings()) {
 799           if (Name.size() > 1)
 800             Name += ',';
 801           Name += BD->getDeclName().getAsIdentifierInfo()->getName();
 802         }
 803         Name += ']';
 804         mangleSourceName(Name);
 805         break;
 806       }
 807
 808       if (const VarDecl *VD = dyn_cast<VarDecl>(ND)) {
 809         // We must have an anonymous union or struct declaration.
 810         const CXXRecordDecl *RD = VD->getType()->getAsCXXRecordDecl();
 811         assert(RD && "expected variable decl to have a record type");
 812         // Anonymous types with no tag or typedef get the name of their
 813         // declarator mangled in.  If they have no declarator, number them with
 814         // a $S prefix.
 815         llvm::SmallString<64> Name("$S");
 816         // Get a unique id for the anonymous struct.
 817         Name += llvm::utostr(Context.getAnonymousStructId(RD) + 1);
 818         mangleSourceName(Name.str());
 819         break;
 820       }
 821
 822       // We must have an anonymous struct.
 823       const TagDecl *TD = cast<TagDecl>(ND);
 824       if (const TypedefNameDecl *D = TD->getTypedefNameForAnonDecl()) {
 825         assert(TD->getDeclContext() == D->getDeclContext() &&
 826                "Typedef should not be in another decl context!");
 827         assert(D->getDeclName().getAsIdentifierInfo() &&
 828                "Typedef was not named!");
 829         mangleSourceName(D->getDeclName().getAsIdentifierInfo()->getName());
 830         break;
 831       }
 832
 833       if (const CXXRecordDecl *Record = dyn_cast<CXXRecordDecl>(TD)) {
 834         if (Record->isLambda()) {
 835           llvm::SmallString<10> Name("<lambda_");
 836
 837           Decl *LambdaContextDecl = Record->getLambdaContextDecl();
 838           unsigned LambdaManglingNumber = Record->getLambdaManglingNumber();
 839           unsigned LambdaId;
 840           const ParmVarDecl *Parm =
 841               dyn_cast_or_null<ParmVarDecl>(LambdaContextDecl);
 842           const FunctionDecl *Func =
 843               Parm ? dyn_cast<FunctionDecl>(Parm->getDeclContext()) : nullptr;
 844
 845           if (Func) {
 846             unsigned DefaultArgNo =
 847                 Func->getNumParams() - Parm->getFunctionScopeIndex();
 848             Name += llvm::utostr(DefaultArgNo);
 849             Name += "_";
 850           }
 851
 852           if (LambdaManglingNumber)
 853             LambdaId = LambdaManglingNumber;
 854           else
 855             LambdaId = Context.getLambdaId(Record);
 856
 857           Name += llvm::utostr(LambdaId);
 858           Name += ">";
 859
 860           mangleSourceName(Name);
 861
 862           // If the context of a closure type is an initializer for a class
 863           // member (static or nonstatic), it is encoded in a qualified name.
 864           if (LambdaManglingNumber && LambdaContextDecl) {
 865             if ((isa<VarDecl>(LambdaContextDecl) ||
 866                  isa<FieldDecl>(LambdaContextDecl)) &&
 867                 LambdaContextDecl->getDeclContext()->isRecord()) {
 868               mangleUnqualifiedName(cast<NamedDecl>(LambdaContextDecl));
 869             }
 870           }
 871           break;
 872         }
 873       }
 874
 875       llvm::SmallString<64> Name;
 876       if (DeclaratorDecl *DD =
 877               Context.getASTContext().getDeclaratorForUnnamedTagDecl(TD)) {
 878         // Anonymous types without a name for linkage purposes have their
 879         // declarator mangled in if they have one.
 880         Name += "<unnamed-type-";
 881         Name += DD->getName();
 882       } else if (TypedefNameDecl *TND =
 883                      Context.getASTContext().getTypedefNameForUnnamedTagDecl(
 884                          TD)) {
 885         // Anonymous types without a name for linkage purposes have their
 886         // associate typedef mangled in if they have one.
 887         Name += "<unnamed-type-";
 888         Name += TND->getName();
 889       } else if (isa<EnumDecl>(TD) &&
 890                  cast<EnumDecl>(TD)->enumerator_begin() !=
 891                      cast<EnumDecl>(TD)->enumerator_end()) {
 892         // Anonymous non-empty enums mangle in the first enumerator.
 893         auto *ED = cast<EnumDecl>(TD);
 894         Name += "<unnamed-enum-";
 895         Name += ED->enumerator_begin()->getName();
 896       } else {
 897         // Otherwise, number the types using a $S prefix.
 898         Name += "<unnamed-type-$S";
 899         Name += llvm::utostr(Context.getAnonymousStructId(TD) + 1);
 900       }
 901       Name += ">";
 902       mangleSourceName(Name.str());
 903       break;
 904     }
 905
 906     case DeclarationName::ObjCZeroArgSelector:
 907     case DeclarationName::ObjCOneArgSelector:
 908     case DeclarationName::ObjCMultiArgSelector:
 909       llvm_unreachable("Can't mangle Objective-C selector names here!");
 910
 911     case DeclarationName::CXXConstructorName:
 912       if (isStructorDecl(ND)) {
 913         if (StructorType == Ctor_CopyingClosure) {
 914           Out << "?_O";
 915           return;
 916         }
 917         if (StructorType == Ctor_DefaultClosure) {
 918           Out << "?_F";
 919           return;
 920         }
 921       }
 922       Out << "?0";
 923       return;
 924
 925     case DeclarationName::CXXDestructorName:
 926       if (isStructorDecl(ND))
 927         // If the named decl is the C++ destructor we're mangling,
 928         // use the type we were given.
 929         mangleCXXDtorType(static_cast<CXXDtorType>(StructorType));
 930       else
 931         // Otherwise, use the base destructor name. This is relevant if a
 932         // class with a destructor is declared within a destructor.
 933         mangleCXXDtorType(Dtor_Base);
 934       break;
 935
 936     case DeclarationName::CXXConversionFunctionName:
 937       // <operator-name> ::= ?B # (cast)
 938       // The target type is encoded as the return type.
 939       Out << "?B";
 940       break;
 941
 942     case DeclarationName::CXXOperatorName:
 943       mangleOperatorName(Name.getCXXOverloadedOperator(), ND->getLocation());
 944       break;
 945
 946     case DeclarationName::CXXLiteralOperatorName: {
 947       Out << "?__K";
 948       mangleSourceName(Name.getCXXLiteralIdentifier()->getName());
 949       break;
 950     }
 951
 952     case DeclarationName::CXXDeductionGuideName:
 953       llvm_unreachable("Can't mangle a deduction guide name!");
 954
 955     case DeclarationName::CXXUsingDirective:
 956       llvm_unreachable("Can't mangle a using directive name!");
 957   }
 958 }
 959
 960 // <postfix> ::= <unqualified-name> [<postfix>]
 961 //           ::= <substitution> [<postfix>]
 962 void MicrosoftCXXNameMangler::mangleNestedName(const NamedDecl *ND) {
 963   const DeclContext *DC = getEffectiveDeclContext(ND);
 964   while (!DC->isTranslationUnit()) {
 965     if (isa<TagDecl>(ND) || isa<VarDecl>(ND)) {
 966       unsigned Disc;
 967       if (Context.getNextDiscriminator(ND, Disc)) {
 968         Out << '?';
 969         mangleNumber(Disc);
 970         Out << '?';
 971       }
 972     }
 973
 974     if (const BlockDecl *BD = dyn_cast<BlockDecl>(DC)) {
 975       auto Discriminate =
 976           [](StringRef Name, const unsigned Discriminator,
 977              const unsigned ParameterDiscriminator) -> std::string {
 978         std::string Buffer;
 979         llvm::raw_string_ostream Stream(Buffer);
 980         Stream << Name;
 981         if (Discriminator)
 982           Stream << '_' << Discriminator;
 983         if (ParameterDiscriminator)
 984           Stream << '_' << ParameterDiscriminator;
 985         return Stream.str();
 986       };
 987
 988       unsigned Discriminator = BD->getBlockManglingNumber();
 989       if (!Discriminator)
 990         Discriminator = Context.getBlockId(BD, /*Local=*/false);
 991
 992       // Mangle the parameter position as a discriminator to deal with unnamed
 993       // parameters.  Rather than mangling the unqualified parameter name,
 994       // always use the position to give a uniform mangling.
 995       unsigned ParameterDiscriminator = 0;
 996       if (const auto *MC = BD->getBlockManglingContextDecl())
 997         if (const auto *P = dyn_cast<ParmVarDecl>(MC))
 998           if (const auto *F = dyn_cast<FunctionDecl>(P->getDeclContext()))
 999             ParameterDiscriminator =
1000                 F->getNumParams() - P->getFunctionScopeIndex();
1001
1002       DC = getEffectiveDeclContext(BD);
1003
1004       Out << '?';
1005       mangleSourceName(Discriminate("_block_invoke", Discriminator,
1006                                     ParameterDiscriminator));
1007       // If we have a block mangling context, encode that now.  This allows us
1008       // to discriminate between named static data initializers in the same
1009       // scope.  This is handled differently from parameters, which use
1010       // positions to discriminate between multiple instances.
1011       if (const auto *MC = BD->getBlockManglingContextDecl())
1012         if (!isa<ParmVarDecl>(MC))
1013           if (const auto *ND = dyn_cast<NamedDecl>(MC))
1014             mangleUnqualifiedName(ND);
1015       // MS ABI and Itanium manglings are in inverted scopes.  In the case of a
1016       // RecordDecl, mangle the entire scope hierarchy at this point rather than
1017       // just the unqualified name to get the ordering correct.
1018       if (const auto *RD = dyn_cast<RecordDecl>(DC))
1019         mangleName(RD);
1020       else
1021         Out << '@';
1022       // void __cdecl
1023       Out << "YAX";
1024       // struct __block_literal *
1025       Out << 'P';
1026       // __ptr64
1027       if (PointersAre64Bit)
1028         Out << 'E';
1029       Out << 'A';
1030       mangleArtificalTagType(TTK_Struct,
1031                              Discriminate("__block_literal", Discriminator,
1032                                           ParameterDiscriminator));
1033       Out << "@Z";
1034
1035       // If the effective context was a Record, we have fully mangled the
1036       // qualified name and do not need to continue.
1037       if (isa<RecordDecl>(DC))
1038         break;
1039       continue;
1040     } else if (const ObjCMethodDecl *Method = dyn_cast<ObjCMethodDecl>(DC)) {
1041       mangleObjCMethodName(Method);
1042     } else if (isa<NamedDecl>(DC)) {
1043       ND = cast<NamedDecl>(DC);
1044       if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)) {
1045         mangle(FD, "?");
1046         break;
1047       } else {
1048         mangleUnqualifiedName(ND);
1049         // Lambdas in default arguments conceptually belong to the function the
1050         // parameter corresponds to.
1051         if (const auto *LDADC = getLambdaDefaultArgumentDeclContext(ND)) {
1052           DC = LDADC;
1053           continue;
1054         }
1055       }
1056     }
1057     DC = DC->getParent();
1058   }
1059 }
1060
1061 void MicrosoftCXXNameMangler::mangleCXXDtorType(CXXDtorType T) {
1062   // Microsoft uses the names on the case labels for these dtor variants.  Clang
1063   // uses the Itanium terminology internally.  Everything in this ABI delegates
1064   // towards the base dtor.
1065   switch (T) {
1066   // <operator-name> ::= ?1  # destructor
1067   case Dtor_Base: Out << "?1"; return;
1068   // <operator-name> ::= ?_D # vbase destructor
1069   case Dtor_Complete: Out << "?_D"; return;
1070   // <operator-name> ::= ?_G # scalar deleting destructor
1071   case Dtor_Deleting: Out << "?_G"; return;
1072   // <operator-name> ::= ?_E # vector deleting destructor
1073   // FIXME: Add a vector deleting dtor type.  It goes in the vtable, so we need
1074   // it.
1075   case Dtor_Comdat:
1076     llvm_unreachable("not expecting a COMDAT");
1077   }
1078   llvm_unreachable("Unsupported dtor type?");
1079 }
1080
1081 void MicrosoftCXXNameMangler::mangleOperatorName(OverloadedOperatorKind OO,
1082                                                  SourceLocation Loc) {
1083   switch (OO) {
1084   //                     ?0 # constructor
1085   //                     ?1 # destructor
1086   // <operator-name> ::= ?2 # new
1087   case OO_New: Out << "?2"; break;
1088   // <operator-name> ::= ?3 # delete
1089   case OO_Delete: Out << "?3"; break;
1090   // <operator-name> ::= ?4 # =
1091   case OO_Equal: Out << "?4"; break;
1092   // <operator-name> ::= ?5 # >>
1093   case OO_GreaterGreater: Out << "?5"; break;
1094   // <operator-name> ::= ?6 # <<
1095   case OO_LessLess: Out << "?6"; break;
1096   // <operator-name> ::= ?7 # !
1097   case OO_Exclaim: Out << "?7"; break;
1098   // <operator-name> ::= ?8 # ==
1099   case OO_EqualEqual: Out << "?8"; break;
1100   // <operator-name> ::= ?9 # !=
1101   case OO_ExclaimEqual: Out << "?9"; break;
1102   // <operator-name> ::= ?A # []
1103   case OO_Subscript: Out << "?A"; break;
1104   //                     ?B # conversion
1105   // <operator-name> ::= ?C # ->
1106   case OO_Arrow: Out << "?C"; break;
1107   // <operator-name> ::= ?D # *
1108   case OO_Star: Out << "?D"; break;
1109   // <operator-name> ::= ?E # ++
1110   case OO_PlusPlus: Out << "?E"; break;
1111   // <operator-name> ::= ?F # --
1112   case OO_MinusMinus: Out << "?F"; break;
1113   // <operator-name> ::= ?G # -
1114   case OO_Minus: Out << "?G"; break;
1115   // <operator-name> ::= ?H # +
1116   case OO_Plus: Out << "?H"; break;
1117   // <operator-name> ::= ?I # &
1118   case OO_Amp: Out << "?I"; break;
1119   // <operator-name> ::= ?J # ->*
1120   case OO_ArrowStar: Out << "?J"; break;
1121   // <operator-name> ::= ?K # /
1122   case OO_Slash: Out << "?K"; break;
1123   // <operator-name> ::= ?L # %
1124   case OO_Percent: Out << "?L"; break;
1125   // <operator-name> ::= ?M # <
1126   case OO_Less: Out << "?M"; break;
1127   // <operator-name> ::= ?N # <=
1128   case OO_LessEqual: Out << "?N"; break;
1129   // <operator-name> ::= ?O # >
1130   case OO_Greater: Out << "?O"; break;
1131   // <operator-name> ::= ?P # >=
1132   case OO_GreaterEqual: Out << "?P"; break;
1133   // <operator-name> ::= ?Q # ,
1134   case OO_Comma: Out << "?Q"; break;
1135   // <operator-name> ::= ?R # ()
1136   case OO_Call: Out << "?R"; break;
1137   // <operator-name> ::= ?S # ~
1138   case OO_Tilde: Out << "?S"; break;
1139   // <operator-name> ::= ?T # ^
1140   case OO_Caret: Out << "?T"; break;
1141   // <operator-name> ::= ?U # |
1142   case OO_Pipe: Out << "?U"; break;
1143   // <operator-name> ::= ?V # &&
1144   case OO_AmpAmp: Out << "?V"; break;
1145   // <operator-name> ::= ?W # ||
1146   case OO_PipePipe: Out << "?W"; break;
1147   // <operator-name> ::= ?X # *=
1148   case OO_StarEqual: Out << "?X"; break;
1149   // <operator-name> ::= ?Y # +=
1150   case OO_PlusEqual: Out << "?Y"; break;
1151   // <operator-name> ::= ?Z # -=
1152   case OO_MinusEqual: Out << "?Z"; break;
1153   // <operator-name> ::= ?_0 # /=
1154   case OO_SlashEqual: Out << "?_0"; break;
1155   // <operator-name> ::= ?_1 # %=
1156   case OO_PercentEqual: Out << "?_1"; break;
1157   // <operator-name> ::= ?_2 # >>=
1158   case OO_GreaterGreaterEqual: Out << "?_2"; break;
1159   // <operator-name> ::= ?_3 # <<=
1160   case OO_LessLessEqual: Out << "?_3"; break;
1161   // <operator-name> ::= ?_4 # &=
1162   case OO_AmpEqual: Out << "?_4"; break;
1163   // <operator-name> ::= ?_5 # |=
1164   case OO_PipeEqual: Out << "?_5"; break;
1165   // <operator-name> ::= ?_6 # ^=
1166   case OO_CaretEqual: Out << "?_6"; break;
1167   //                     ?_7 # vftable
1168   //                     ?_8 # vbtable
1169   //                     ?_9 # vcall
1170   //                     ?_A # typeof
1171   //                     ?_B # local static guard
1172   //                     ?_C # string
1173   //                     ?_D # vbase destructor
1174   //                     ?_E # vector deleting destructor
1175   //                     ?_F # default constructor closure
1176   //                     ?_G # scalar deleting destructor
1177   //                     ?_H # vector constructor iterator
1178   //                     ?_I # vector destructor iterator
1179   //                     ?_J # vector vbase constructor iterator
1180   //                     ?_K # virtual displacement map
1181   //                     ?_L # eh vector constructor iterator
1182   //                     ?_M # eh vector destructor iterator
1183   //                     ?_N # eh vector vbase constructor iterator
1184   //                     ?_O # copy constructor closure
1185   //                     ?_P<name> # udt returning <name>
1186   //                     ?_Q # <unknown>
1187   //                     ?_R0 # RTTI Type Descriptor
1188   //                     ?_R1 # RTTI Base Class Descriptor at (a,b,c,d)
1189   //                     ?_R2 # RTTI Base Class Array
1190   //                     ?_R3 # RTTI Class Hierarchy Descriptor
1191   //                     ?_R4 # RTTI Complete Object Locator
1192   //                     ?_S # local vftable
1193   //                     ?_T # local vftable constructor closure
1194   // <operator-name> ::= ?_U # new[]
1195   case OO_Array_New: Out << "?_U"; break;
1196   // <operator-name> ::= ?_V # delete[]
1197   case OO_Array_Delete: Out << "?_V"; break;
1198   // <operator-name> ::= ?__L # co_await
1199   case OO_Coawait: Out << "?__L"; break;
1200
1201   case OO_Spaceship: {
1202     // FIXME: Once MS picks a mangling, use it.
1203     DiagnosticsEngine &Diags = Context.getDiags();
1204     unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
1205       "cannot mangle this three-way comparison operator yet");
1206     Diags.Report(Loc, DiagID);
1207     break;
1208   }
1209
1210   case OO_Conditional: {
1211     DiagnosticsEngine &Diags = Context.getDiags();
1212     unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
1213       "cannot mangle this conditional operator yet");
1214     Diags.Report(Loc, DiagID);
1215     break;
1216   }
1217
1218   case OO_None:
1219   case NUM_OVERLOADED_OPERATORS:
1220     llvm_unreachable("Not an overloaded operator");
1221   }
1222 }
1223
1224 void MicrosoftCXXNameMangler::mangleSourceName(StringRef Name) {
1225   // <source name> ::= <identifier> @
1226   BackRefVec::iterator Found =
1227       std::find(NameBackReferences.begin(), NameBackReferences.end(), Name);
1228   if (Found == NameBackReferences.end()) {
1229     if (NameBackReferences.size() < 10)
1230       NameBackReferences.push_back(Name);
1231     Out << Name << '@';
1232   } else {
1233     Out << (Found - NameBackReferences.begin());
1234   }
1235 }
1236
1237 void MicrosoftCXXNameMangler::mangleObjCMethodName(const ObjCMethodDecl *MD) {
1238   Context.mangleObjCMethodName(MD, Out);
1239 }
1240
1241 void MicrosoftCXXNameMangler::mangleTemplateInstantiationName(
1242     const TemplateDecl *TD, const TemplateArgumentList &TemplateArgs) {
1243   // <template-name> ::= <unscoped-template-name> <template-args>
1244   //                 ::= <substitution>
1245   // Always start with the unqualified name.
1246
1247   // Templates have their own context for back references.
1248   ArgBackRefMap OuterArgsContext;
1249   BackRefVec OuterTemplateContext;
1250   PassObjectSizeArgsSet OuterPassObjectSizeArgs;
1251   NameBackReferences.swap(OuterTemplateContext);
1252   TypeBackReferences.swap(OuterArgsContext);
1253   PassObjectSizeArgs.swap(OuterPassObjectSizeArgs);
1254
1255   mangleUnscopedTemplateName(TD);
1256   mangleTemplateArgs(TD, TemplateArgs);
1257
1258   // Restore the previous back reference contexts.
1259   NameBackReferences.swap(OuterTemplateContext);
1260   TypeBackReferences.swap(OuterArgsContext);
1261   PassObjectSizeArgs.swap(OuterPassObjectSizeArgs);
1262 }
1263
1264 void
1265 MicrosoftCXXNameMangler::mangleUnscopedTemplateName(const TemplateDecl *TD) {
1266   // <unscoped-template-name> ::= ?$ <unqualified-name>
1267   Out << "?$";
1268   mangleUnqualifiedName(TD);
1269 }
1270
1271 void MicrosoftCXXNameMangler::mangleIntegerLiteral(const llvm::APSInt &Value,
1272                                                    bool IsBoolean) {
1273   // <integer-literal> ::= $0 <number>
1274   Out << "$0";
1275   // Make sure booleans are encoded as 0/1.
1276   if (IsBoolean && Value.getBoolValue())
1277     mangleNumber(1);
1278   else if (Value.isSigned())
1279     mangleNumber(Value.getSExtValue());
1280   else
1281     mangleNumber(Value.getZExtValue());
1282 }
1283
1284 void MicrosoftCXXNameMangler::mangleExpression(const Expr *E) {
1285   // See if this is a constant expression.
1286   llvm::APSInt Value;
1287   if (E->isIntegerConstantExpr(Value, Context.getASTContext())) {
1288     mangleIntegerLiteral(Value, E->getType()->isBooleanType());
1289     return;
1290   }
1291
1292   // Look through no-op casts like template parameter substitutions.
1293   E = E->IgnoreParenNoopCasts(Context.getASTContext());
1294
1295   const CXXUuidofExpr *UE = nullptr;
1296   if (const UnaryOperator *UO = dyn_cast<UnaryOperator>(E)) {
1297     if (UO->getOpcode() == UO_AddrOf)
1298       UE = dyn_cast<CXXUuidofExpr>(UO->getSubExpr());
1299   } else
1300     UE = dyn_cast<CXXUuidofExpr>(E);
1301
1302   if (UE) {
1303     // If we had to peek through an address-of operator, treat this like we are
1304     // dealing with a pointer type.  Otherwise, treat it like a const reference.
1305     //
1306     // N.B. This matches up with the handling of TemplateArgument::Declaration
1307     // in mangleTemplateArg
1308     if (UE == E)
1309       Out << "$E?";
1310     else
1311       Out << "$1?";
1312
1313     // This CXXUuidofExpr is mangled as-if it were actually a VarDecl from
1314     // const __s_GUID _GUID_{lower case UUID with underscores}
1315     StringRef Uuid = UE->getUuidStr();
1316     std::string Name = "_GUID_" + Uuid.lower();
1317     std::replace(Name.begin(), Name.end(), '-', '_');
1318
1319     mangleSourceName(Name);
1320     // Terminate the whole name with an '@'.
1321     Out << '@';
1322     // It's a global variable.
1323     Out << '3';
1324     // It's a struct called __s_GUID.
1325     mangleArtificalTagType(TTK_Struct, "__s_GUID");
1326     // It's const.
1327     Out << 'B';
1328     return;
1329   }
1330
1331   // As bad as this diagnostic is, it's better than crashing.
1332   DiagnosticsEngine &Diags = Context.getDiags();
1333   unsigned DiagID = Diags.getCustomDiagID(
1334       DiagnosticsEngine::Error, "cannot yet mangle expression type %0");
1335   Diags.Report(E->getExprLoc(), DiagID) << E->getStmtClassName()
1336                                         << E->getSourceRange();
1337 }
1338
1339 void MicrosoftCXXNameMangler::mangleTemplateArgs(
1340     const TemplateDecl *TD, const TemplateArgumentList &TemplateArgs) {
1341   // <template-args> ::= <template-arg>+
1342   const TemplateParameterList *TPL = TD->getTemplateParameters();
1343   assert(TPL->size() == TemplateArgs.size() &&
1344          "size mismatch between args and parms!");
1345
1346   unsigned Idx = 0;
1347   for (const TemplateArgument &TA : TemplateArgs.asArray())
1348     mangleTemplateArg(TD, TA, TPL->getParam(Idx++));
1349 }
1350
1351 void MicrosoftCXXNameMangler::mangleTemplateArg(const TemplateDecl *TD,
1352                                                 const TemplateArgument &TA,
1353                                                 const NamedDecl *Parm) {
1354   // <template-arg> ::= <type>
1355   //                ::= <integer-literal>
1356   //                ::= <member-data-pointer>
1357   //                ::= <member-function-pointer>
1358   //                ::= $E? <name> <type-encoding>
1359   //                ::= $1? <name> <type-encoding>
1360   //                ::= $0A@
1361   //                ::= <template-args>
1362
1363   switch (TA.getKind()) {
1364   case TemplateArgument::Null:
1365     llvm_unreachable("Can't mangle null template arguments!");
1366   case TemplateArgument::TemplateExpansion:
1367     llvm_unreachable("Can't mangle template expansion arguments!");
1368   case TemplateArgument::Type: {
1369     QualType T = TA.getAsType();
1370     mangleType(T, SourceRange(), QMM_Escape);
1371     break;
1372   }
1373   case TemplateArgument::Declaration: {
1374     const NamedDecl *ND = TA.getAsDecl();
1375     if (isa<FieldDecl>(ND) || isa<IndirectFieldDecl>(ND)) {
1376       mangleMemberDataPointer(cast<CXXRecordDecl>(ND->getDeclContext())
1377                                   ->getMostRecentNonInjectedDecl(),
1378                               cast<ValueDecl>(ND));
1379     } else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)) {
1380       const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD);
1381       if (MD && MD->isInstance()) {
1382         mangleMemberFunctionPointer(
1383             MD->getParent()->getMostRecentNonInjectedDecl(), MD);
1384       } else {
1385         Out << "$1?";
1386         mangleName(FD);
1387         mangleFunctionEncoding(FD, /*ShouldMangle=*/true);
1388       }
1389     } else {
1390       mangle(ND, TA.getParamTypeForDecl()->isReferenceType() ? "$E?" : "$1?");
1391     }
1392     break;
1393   }
1394   case TemplateArgument::Integral:
1395     mangleIntegerLiteral(TA.getAsIntegral(),
1396                          TA.getIntegralType()->isBooleanType());
1397     break;
1398   case TemplateArgument::NullPtr: {
1399     QualType T = TA.getNullPtrType();
1400     if (const MemberPointerType *MPT = T->getAs<MemberPointerType>()) {
1401       const CXXRecordDecl *RD = MPT->getMostRecentCXXRecordDecl();
1402       if (MPT->isMemberFunctionPointerType() &&
1403           !isa<FunctionTemplateDecl>(TD)) {
1404         mangleMemberFunctionPointer(RD, nullptr);
1405         return;
1406       }
1407       if (MPT->isMemberDataPointer()) {
1408         if (!isa<FunctionTemplateDecl>(TD)) {
1409           mangleMemberDataPointer(RD, nullptr);
1410           return;
1411         }
1412         // nullptr data pointers are always represented with a single field
1413         // which is initialized with either 0 or -1.  Why -1?  Well, we need to
1414         // distinguish the case where the data member is at offset zero in the
1415         // record.
1416         // However, we are free to use 0 *if* we would use multiple fields for
1417         // non-nullptr member pointers.
1418         if (!RD->nullFieldOffsetIsZero()) {
1419           mangleIntegerLiteral(llvm::APSInt::get(-1), /*IsBoolean=*/false);
1420           return;
1421         }
1422       }
1423     }
1424     mangleIntegerLiteral(llvm::APSInt::getUnsigned(0), /*IsBoolean=*/false);
1425     break;
1426   }
1427   case TemplateArgument::Expression:
1428     mangleExpression(TA.getAsExpr());
1429     break;
1430   case TemplateArgument::Pack: {
1431     ArrayRef<TemplateArgument> TemplateArgs = TA.getPackAsArray();
1432     if (TemplateArgs.empty()) {
1433       if (isa<TemplateTypeParmDecl>(Parm) ||
1434           isa<TemplateTemplateParmDecl>(Parm))
1435         // MSVC 2015 changed the mangling for empty expanded template packs,
1436         // use the old mangling for link compatibility for old versions.
1437         Out << (Context.getASTContext().getLangOpts().isCompatibleWithMSVC(
1438                     LangOptions::MSVC2015)
1439                     ? "$$V"
1440                     : "$$$V");
1441       else if (isa<NonTypeTemplateParmDecl>(Parm))
1442         Out << "$S";
1443       else
1444         llvm_unreachable("unexpected template parameter decl!");
1445     } else {
1446       for (const TemplateArgument &PA : TemplateArgs)
1447         mangleTemplateArg(TD, PA, Parm);
1448     }
1449     break;
1450   }
1451   case TemplateArgument::Template: {
1452     const NamedDecl *ND =
1453         TA.getAsTemplate().getAsTemplateDecl()->getTemplatedDecl();
1454     if (const auto *TD = dyn_cast<TagDecl>(ND)) {
1455       mangleType(TD);
1456     } else if (isa<TypeAliasDecl>(ND)) {
1457       Out << "$$Y";
1458       mangleName(ND);
1459     } else {
1460       llvm_unreachable("unexpected template template NamedDecl!");
1461     }
1462     break;
1463   }
1464   }
1465 }
1466
1467 void MicrosoftCXXNameMangler::mangleObjCProtocol(const ObjCProtocolDecl *PD) {
1468   llvm::SmallString<64> TemplateMangling;
1469   llvm::raw_svector_ostream Stream(TemplateMangling);
1470   MicrosoftCXXNameMangler Extra(Context, Stream);
1471
1472   Stream << "?$";
1473   Extra.mangleSourceName("Protocol");
1474   Extra.mangleArtificalTagType(TTK_Struct, PD->getName());
1475
1476   mangleArtificalTagType(TTK_Struct, TemplateMangling, {"__ObjC"});
1477 }
1478
1479 void MicrosoftCXXNameMangler::mangleObjCLifetime(const QualType Type,
1480                                                  Qualifiers Quals,
1481                                                  SourceRange Range) {
1482   llvm::SmallString<64> TemplateMangling;
1483   llvm::raw_svector_ostream Stream(TemplateMangling);
1484   MicrosoftCXXNameMangler Extra(Context, Stream);
1485
1486   Stream << "?$";
1487   switch (Quals.getObjCLifetime()) {
1488   case Qualifiers::OCL_None:
1489   case Qualifiers::OCL_ExplicitNone:
1490     break;
1491   case Qualifiers::OCL_Autoreleasing:
1492     Extra.mangleSourceName("Autoreleasing");
1493     break;
1494   case Qualifiers::OCL_Strong:
1495     Extra.mangleSourceName("Strong");
1496     break;
1497   case Qualifiers::OCL_Weak:
1498     Extra.mangleSourceName("Weak");
1499     break;
1500   }
1501   Extra.manglePointerCVQualifiers(Quals);
1502   Extra.manglePointerExtQualifiers(Quals, Type);
1503   Extra.mangleType(Type, Range);
1504
1505   mangleArtificalTagType(TTK_Struct, TemplateMangling, {"__ObjC"});
1506 }
1507
1508 void MicrosoftCXXNameMangler::mangleQualifiers(Qualifiers Quals,
1509                                                bool IsMember) {
1510   // <cvr-qualifiers> ::= [E] [F] [I] <base-cvr-qualifiers>
1511   // 'E' means __ptr64 (32-bit only); 'F' means __unaligned (32/64-bit only);
1512   // 'I' means __restrict (32/64-bit).
1513   // Note that the MSVC __restrict keyword isn't the same as the C99 restrict
1514   // keyword!
1515   // <base-cvr-qualifiers> ::= A  # near
1516   //                       ::= B  # near const
1517   //                       ::= C  # near volatile
1518   //                       ::= D  # near const volatile
1519   //                       ::= E  # far (16-bit)
1520   //                       ::= F  # far const (16-bit)
1521   //                       ::= G  # far volatile (16-bit)
1522   //                       ::= H  # far const volatile (16-bit)
1523   //                       ::= I  # huge (16-bit)
1524   //                       ::= J  # huge const (16-bit)
1525   //                       ::= K  # huge volatile (16-bit)
1526   //                       ::= L  # huge const volatile (16-bit)
1527   //                       ::= M <basis> # based
1528   //                       ::= N <basis> # based const
1529   //                       ::= O <basis> # based volatile
1530   //                       ::= P <basis> # based const volatile
1531   //                       ::= Q  # near member
1532   //                       ::= R  # near const member
1533   //                       ::= S  # near volatile member
1534   //                       ::= T  # near const volatile member
1535   //                       ::= U  # far member (16-bit)
1536   //                       ::= V  # far const member (16-bit)
1537   //                       ::= W  # far volatile member (16-bit)
1538   //                       ::= X  # far const volatile member (16-bit)
1539   //                       ::= Y  # huge member (16-bit)
1540   //                       ::= Z  # huge const member (16-bit)
1541   //                       ::= 0  # huge volatile member (16-bit)
1542   //                       ::= 1  # huge const volatile member (16-bit)
1543   //                       ::= 2 <basis> # based member
1544   //                       ::= 3 <basis> # based const member
1545   //                       ::= 4 <basis> # based volatile member
1546   //                       ::= 5 <basis> # based const volatile member
1547   //                       ::= 6  # near function (pointers only)
1548   //                       ::= 7  # far function (pointers only)
1549   //                       ::= 8  # near method (pointers only)
1550   //                       ::= 9  # far method (pointers only)
1551   //                       ::= _A <basis> # based function (pointers only)
1552   //                       ::= _B <basis> # based function (far?) (pointers only)
1553   //                       ::= _C <basis> # based method (pointers only)
1554   //                       ::= _D <basis> # based method (far?) (pointers only)
1555   //                       ::= _E # block (Clang)
1556   // <basis> ::= 0 # __based(void)
1557   //         ::= 1 # __based(segment)?
1558   //         ::= 2 <name> # __based(name)
1559   //         ::= 3 # ?
1560   //         ::= 4 # ?
1561   //         ::= 5 # not really based
1562   bool HasConst = Quals.hasConst(),
1563        HasVolatile = Quals.hasVolatile();
1564
1565   if (!IsMember) {
1566     if (HasConst && HasVolatile) {
1567       Out << 'D';
1568     } else if (HasVolatile) {
1569       Out << 'C';
1570     } else if (HasConst) {
1571       Out << 'B';
1572     } else {
1573       Out << 'A';
1574     }
1575   } else {
1576     if (HasConst && HasVolatile) {
1577       Out << 'T';
1578     } else if (HasVolatile) {
1579       Out << 'S';
1580     } else if (HasConst) {
1581       Out << 'R';
1582     } else {
1583       Out << 'Q';
1584     }
1585   }
1586
1587   // FIXME: For now, just drop all extension qualifiers on the floor.
1588 }
1589
1590 void
1591 MicrosoftCXXNameMangler::mangleRefQualifier(RefQualifierKind RefQualifier) {
1592   // <ref-qualifier> ::= G                # lvalue reference
1593   //                 ::= H                # rvalue-reference
1594   switch (RefQualifier) {
1595   case RQ_None:
1596     break;
1597
1598   case RQ_LValue:
1599     Out << 'G';
1600     break;
1601
1602   case RQ_RValue:
1603     Out << 'H';
1604     break;
1605   }
1606 }
1607
1608 void MicrosoftCXXNameMangler::manglePointerExtQualifiers(Qualifiers Quals,
1609                                                          QualType PointeeType) {
1610   if (PointersAre64Bit &&
1611       (PointeeType.isNull() || !PointeeType->isFunctionType()))
1612     Out << 'E';
1613
1614   if (Quals.hasRestrict())
1615     Out << 'I';
1616
1617   if (Quals.hasUnaligned() ||
1618       (!PointeeType.isNull() && PointeeType.getLocalQualifiers().hasUnaligned()))
1619     Out << 'F';
1620 }
1621
1622 void MicrosoftCXXNameMangler::manglePointerCVQualifiers(Qualifiers Quals) {
1623   // <pointer-cv-qualifiers> ::= P  # no qualifiers
1624   //                         ::= Q  # const
1625   //                         ::= R  # volatile
1626   //                         ::= S  # const volatile
1627   bool HasConst = Quals.hasConst(),
1628        HasVolatile = Quals.hasVolatile();
1629
1630   if (HasConst && HasVolatile) {
1631     Out << 'S';
1632   } else if (HasVolatile) {
1633     Out << 'R';
1634   } else if (HasConst) {
1635     Out << 'Q';
1636   } else {
1637     Out << 'P';
1638   }
1639 }
1640
1641 void MicrosoftCXXNameMangler::mangleArgumentType(QualType T,
1642                                                  SourceRange Range) {
1643   // MSVC will backreference two canonically equivalent types that have slightly
1644   // different manglings when mangled alone.
1645
1646   // Decayed types do not match up with non-decayed versions of the same type.
1647   //
1648   // e.g.
1649   // void (*x)(void) will not form a backreference with void x(void)
1650   void *TypePtr;
1651   if (const auto *DT = T->getAs<DecayedType>()) {
1652     QualType OriginalType = DT->getOriginalType();
1653     // All decayed ArrayTypes should be treated identically; as-if they were
1654     // a decayed IncompleteArrayType.
1655     if (const auto *AT = getASTContext().getAsArrayType(OriginalType))
1656       OriginalType = getASTContext().getIncompleteArrayType(
1657           AT->getElementType(), AT->getSizeModifier(),
1658           AT->getIndexTypeCVRQualifiers());
1659
1660     TypePtr = OriginalType.getCanonicalType().getAsOpaquePtr();
1661     // If the original parameter was textually written as an array,
1662     // instead treat the decayed parameter like it's const.
1663     //
1664     // e.g.
1665     // int [] -> int * const
1666     if (OriginalType->isArrayType())
1667       T = T.withConst();
1668   } else {
1669     TypePtr = T.getCanonicalType().getAsOpaquePtr();
1670   }
1671
1672   ArgBackRefMap::iterator Found = TypeBackReferences.find(TypePtr);
1673
1674   if (Found == TypeBackReferences.end()) {
1675     size_t OutSizeBefore = Out.tell();
1676
1677     mangleType(T, Range, QMM_Drop);
1678
1679     // See if it's worth creating a back reference.
1680     // Only types longer than 1 character are considered
1681     // and only 10 back references slots are available:
1682     bool LongerThanOneChar = (Out.tell() - OutSizeBefore > 1);
1683     if (LongerThanOneChar && TypeBackReferences.size() < 10) {
1684       size_t Size = TypeBackReferences.size();
1685       TypeBackReferences[TypePtr] = Size;
1686     }
1687   } else {
1688     Out << Found->second;
1689   }
1690 }
1691
1692 void MicrosoftCXXNameMangler::manglePassObjectSizeArg(
1693     const PassObjectSizeAttr *POSA) {
1694   int Type = POSA->getType();
1695
1696   auto Iter = PassObjectSizeArgs.insert(Type).first;
1697   auto *TypePtr = (const void *)&*Iter;
1698   ArgBackRefMap::iterator Found = TypeBackReferences.find(TypePtr);
1699
1700   if (Found == TypeBackReferences.end()) {
1701     mangleArtificalTagType(TTK_Enum, "__pass_object_size" + llvm::utostr(Type),
1702                            {"__clang"});
1703
1704     if (TypeBackReferences.size() < 10) {
1705       size_t Size = TypeBackReferences.size();
1706       TypeBackReferences[TypePtr] = Size;
1707     }
1708   } else {
1709     Out << Found->second;
1710   }
1711 }
1712
1713 void MicrosoftCXXNameMangler::mangleType(QualType T, SourceRange Range,
1714                                          QualifierMangleMode QMM) {
1715   // Don't use the canonical types.  MSVC includes things like 'const' on
1716   // pointer arguments to function pointers that canonicalization strips away.
1717   T = T.getDesugaredType(getASTContext());
1718   Qualifiers Quals = T.getLocalQualifiers();
1719   if (const ArrayType *AT = getASTContext().getAsArrayType(T)) {
1720     // If there were any Quals, getAsArrayType() pushed them onto the array
1721     // element type.
1722     if (QMM == QMM_Mangle)
1723       Out << 'A';
1724     else if (QMM == QMM_Escape || QMM == QMM_Result)
1725       Out << "$$B";
1726     mangleArrayType(AT);
1727     return;
1728   }
1729
1730   bool IsPointer = T->isAnyPointerType() || T->isMemberPointerType() ||
1731                    T->isReferenceType() || T->isBlockPointerType();
1732
1733   switch (QMM) {
1734   case QMM_Drop:
1735     if (Quals.hasObjCLifetime())
1736       Quals = Quals.withoutObjCLifetime();
1737     break;
1738   case QMM_Mangle:
1739     if (const FunctionType *FT = dyn_cast<FunctionType>(T)) {
1740       Out << '6';
1741       mangleFunctionType(FT);
1742       return;
1743     }
1744     mangleQualifiers(Quals, false);
1745     break;
1746   case QMM_Escape:
1747     if (!IsPointer && Quals) {
1748       Out << "$$C";
1749       mangleQualifiers(Quals, false);
1750     }
1751     break;
1752   case QMM_Result:
1753     // Presence of __unaligned qualifier shouldn't affect mangling here.
1754     Quals.removeUnaligned();
1755     if (Quals.hasObjCLifetime())
1756       Quals = Quals.withoutObjCLifetime();
1757     if ((!IsPointer && Quals) || isa<TagType>(T) || isArtificialTagType(T)) {
1758       Out << '?';
1759       mangleQualifiers(Quals, false);
1760     }
1761     break;
1762   }
1763
1764   const Type *ty = T.getTypePtr();
1765
1766   switch (ty->getTypeClass()) {
1767 #define ABSTRACT_TYPE(CLASS, PARENT)
1768 #define NON_CANONICAL_TYPE(CLASS, PARENT) \
1769   case Type::CLASS: \
1770     llvm_unreachable("can't mangle non-canonical type " #CLASS "Type"); \
1771     return;
1772 #define TYPE(CLASS, PARENT) \
1773   case Type::CLASS: \
1774     mangleType(cast<CLASS##Type>(ty), Quals, Range); \
1775     break;
1776 #include "clang/AST/TypeNodes.def"
1777 #undef ABSTRACT_TYPE
1778 #undef NON_CANONICAL_TYPE
1779 #undef TYPE
1780   }
1781 }
1782
1783 void MicrosoftCXXNameMangler::mangleType(const BuiltinType *T, Qualifiers,
1784                                          SourceRange Range) {
1785   //  <type>         ::= <builtin-type>
1786   //  <builtin-type> ::= X  # void
1787   //                 ::= C  # signed char
1788   //                 ::= D  # char
1789   //                 ::= E  # unsigned char
1790   //                 ::= F  # short
1791   //                 ::= G  # unsigned short (or wchar_t if it's not a builtin)
1792   //                 ::= H  # int
1793   //                 ::= I  # unsigned int
1794   //                 ::= J  # long
1795   //                 ::= K  # unsigned long
1796   //                     L  # <none>
1797   //                 ::= M  # float
1798   //                 ::= N  # double
1799   //                 ::= O  # long double (__float80 is mangled differently)
1800   //                 ::= _J # long long, __int64
1801   //                 ::= _K # unsigned long long, __int64
1802   //                 ::= _L # __int128
1803   //                 ::= _M # unsigned __int128
1804   //                 ::= _N # bool
1805   //                     _O # <array in parameter>
1806   //                 ::= _T # __float80 (Intel)
1807   //                 ::= _S # char16_t
1808   //                 ::= _U # char32_t
1809   //                 ::= _W # wchar_t
1810   //                 ::= _Z # __float80 (Digital Mars)
1811   switch (T->getKind()) {
1812   case BuiltinType::Void:
1813     Out << 'X';
1814     break;
1815   case BuiltinType::SChar:
1816     Out << 'C';
1817     break;
1818   case BuiltinType::Char_U:
1819   case BuiltinType::Char_S:
1820     Out << 'D';
1821     break;
1822   case BuiltinType::UChar:
1823     Out << 'E';
1824     break;
1825   case BuiltinType::Short:
1826     Out << 'F';
1827     break;
1828   case BuiltinType::UShort:
1829     Out << 'G';
1830     break;
1831   case BuiltinType::Int:
1832     Out << 'H';
1833     break;
1834   case BuiltinType::UInt:
1835     Out << 'I';
1836     break;
1837   case BuiltinType::Long:
1838     Out << 'J';
1839     break;
1840   case BuiltinType::ULong:
1841     Out << 'K';
1842     break;
1843   case BuiltinType::Float:
1844     Out << 'M';
1845     break;
1846   case BuiltinType::Double:
1847     Out << 'N';
1848     break;
1849   // TODO: Determine size and mangle accordingly
1850   case BuiltinType::LongDouble:
1851     Out << 'O';
1852     break;
1853   case BuiltinType::LongLong:
1854     Out << "_J";
1855     break;
1856   case BuiltinType::ULongLong:
1857     Out << "_K";
1858     break;
1859   case BuiltinType::Int128:
1860     Out << "_L";
1861     break;
1862   case BuiltinType::UInt128:
1863     Out << "_M";
1864     break;
1865   case BuiltinType::Bool:
1866     Out << "_N";
1867     break;
1868   case BuiltinType::Char16:
1869     Out << "_S";
1870     break;
1871   case BuiltinType::Char32:
1872     Out << "_U";
1873     break;
1874   case BuiltinType::WChar_S:
1875   case BuiltinType::WChar_U:
1876     Out << "_W";
1877     break;
1878
1879 #define BUILTIN_TYPE(Id, SingletonId)
1880 #define PLACEHOLDER_TYPE(Id, SingletonId) \
1881   case BuiltinType::Id:
1882 #include "clang/AST/BuiltinTypes.def"
1883   case BuiltinType::Dependent:
1884     llvm_unreachable("placeholder types shouldn't get to name mangling");
1885
1886   case BuiltinType::ObjCId:
1887     mangleArtificalTagType(TTK_Struct, ".objc_object");
1888     break;
1889   case BuiltinType::ObjCClass:
1890     mangleArtificalTagType(TTK_Struct, ".objc_class");
1891     break;
1892   case BuiltinType::ObjCSel:
1893     mangleArtificalTagType(TTK_Struct, ".objc_selector");
1894     break;
1895
1896 #define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
1897   case BuiltinType::Id: \
1898     Out << "PAUocl_" #ImgType "_" #Suffix "@@"; \
1899     break;
1900 #include "clang/Basic/OpenCLImageTypes.def"
1901   case BuiltinType::OCLSampler:
1902     Out << "PA";
1903     mangleArtificalTagType(TTK_Struct, "ocl_sampler");
1904     break;
1905   case BuiltinType::OCLEvent:
1906     Out << "PA";
1907     mangleArtificalTagType(TTK_Struct, "ocl_event");
1908     break;
1909   case BuiltinType::OCLClkEvent:
1910     Out << "PA";
1911     mangleArtificalTagType(TTK_Struct, "ocl_clkevent");
1912     break;
1913   case BuiltinType::OCLQueue:
1914     Out << "PA";
1915     mangleArtificalTagType(TTK_Struct, "ocl_queue");
1916     break;
1917   case BuiltinType::OCLReserveID:
1918     Out << "PA";
1919     mangleArtificalTagType(TTK_Struct, "ocl_reserveid");
1920     break;
1921
1922   case BuiltinType::NullPtr:
1923     Out << "$$T";
1924     break;
1925
1926   case BuiltinType::Float16:
1927     mangleArtificalTagType(TTK_Struct, "_Float16", {"__clang"});
1928     break;
1929
1930   case BuiltinType::Half:
1931     mangleArtificalTagType(TTK_Struct, "_Half", {"__clang"});
1932     break;
1933
1934   case BuiltinType::ShortAccum:
1935   case BuiltinType::Accum:
1936   case BuiltinType::LongAccum:
1937   case BuiltinType::UShortAccum:
1938   case BuiltinType::UAccum:
1939   case BuiltinType::ULongAccum:
1940   case BuiltinType::ShortFract:
1941   case BuiltinType::Fract:
1942   case BuiltinType::LongFract:
1943   case BuiltinType::UShortFract:
1944   case BuiltinType::UFract:
1945   case BuiltinType::ULongFract:
1946   case BuiltinType::SatShortAccum:
1947   case BuiltinType::SatAccum:
1948   case BuiltinType::SatLongAccum:
1949   case BuiltinType::SatUShortAccum:
1950   case BuiltinType::SatUAccum:
1951   case BuiltinType::SatULongAccum:
1952   case BuiltinType::SatShortFract:
1953   case BuiltinType::SatFract:
1954   case BuiltinType::SatLongFract:
1955   case BuiltinType::SatUShortFract:
1956   case BuiltinType::SatUFract:
1957   case BuiltinType::SatULongFract:
1958   case BuiltinType::Char8:
1959   case BuiltinType::Float128: {
1960     DiagnosticsEngine &Diags = Context.getDiags();
1961     unsigned DiagID = Diags.getCustomDiagID(
1962         DiagnosticsEngine::Error, "cannot mangle this built-in %0 type yet");
1963     Diags.Report(Range.getBegin(), DiagID)
1964         << T->getName(Context.getASTContext().getPrintingPolicy()) << Range;
1965     break;
1966   }
1967   }
1968 }
1969
1970 // <type>          ::= <function-type>
1971 void MicrosoftCXXNameMangler::mangleType(const FunctionProtoType *T, Qualifiers,
1972                                          SourceRange) {
1973   // Structors only appear in decls, so at this point we know it's not a
1974   // structor type.
1975   // FIXME: This may not be lambda-friendly.
1976   if (T->getTypeQuals() || T->getRefQualifier() != RQ_None) {
1977     Out << "$$A8@@";
1978     mangleFunctionType(T, /*D=*/nullptr, /*ForceThisQuals=*/true);
1979   } else {
1980     Out << "$$A6";
1981     mangleFunctionType(T);
1982   }
1983 }
1984 void MicrosoftCXXNameMangler::mangleType(const FunctionNoProtoType *T,
1985                                          Qualifiers, SourceRange) {
1986   Out << "$$A6";
1987   mangleFunctionType(T);
1988 }
1989
1990 void MicrosoftCXXNameMangler::mangleFunctionType(const FunctionType *T,
1991                                                  const FunctionDecl *D,
1992                                                  bool ForceThisQuals) {
1993   // <function-type> ::= <this-cvr-qualifiers> <calling-convention>
1994   //                     <return-type> <argument-list> <throw-spec>
1995   const FunctionProtoType *Proto = dyn_cast<FunctionProtoType>(T);
1996
1997   SourceRange Range;
1998   if (D) Range = D->getSourceRange();
1999
2000   bool IsInLambda = false;
2001   bool IsStructor = false, HasThisQuals = ForceThisQuals, IsCtorClosure = false;
2002   CallingConv CC = T->getCallConv();
2003   if (const CXXMethodDecl *MD = dyn_cast_or_null<CXXMethodDecl>(D)) {
2004     if (MD->getParent()->isLambda())
2005       IsInLambda = true;
2006     if (MD->isInstance())
2007       HasThisQuals = true;
2008     if (isa<CXXDestructorDecl>(MD)) {
2009       IsStructor = true;
2010     } else if (isa<CXXConstructorDecl>(MD)) {
2011       IsStructor = true;
2012       IsCtorClosure = (StructorType == Ctor_CopyingClosure ||
2013                        StructorType == Ctor_DefaultClosure) &&
2014                       isStructorDecl(MD);
2015       if (IsCtorClosure)
2016         CC = getASTContext().getDefaultCallingConvention(
2017             /*IsVariadic=*/false, /*IsCXXMethod=*/true);
2018     }
2019   }
2020
2021   // If this is a C++ instance method, mangle the CVR qualifiers for the
2022   // this pointer.
2023   if (HasThisQuals) {
2024     Qualifiers Quals = Qualifiers::fromCVRUMask(Proto->getTypeQuals());
2025     manglePointerExtQualifiers(Quals, /*PointeeType=*/QualType());
2026     mangleRefQualifier(Proto->getRefQualifier());
2027     mangleQualifiers(Quals, /*IsMember=*/false);
2028   }
2029
2030   mangleCallingConvention(CC);
2031
2032   // <return-type> ::= <type>
2033   //               ::= @ # structors (they have no declared return type)
2034   if (IsStructor) {
2035     if (isa<CXXDestructorDecl>(D) && isStructorDecl(D)) {
2036       // The scalar deleting destructor takes an extra int argument which is not
2037       // reflected in the AST.
2038       if (StructorType == Dtor_Deleting) {
2039         Out << (PointersAre64Bit ? "PEAXI@Z" : "PAXI@Z");
2040         return;
2041       }
2042       // The vbase destructor returns void which is not reflected in the AST.
2043       if (StructorType == Dtor_Complete) {
2044         Out << "XXZ";
2045         return;
2046       }
2047     }
2048     if (IsCtorClosure) {
2049       // Default constructor closure and copy constructor closure both return
2050       // void.
2051       Out << 'X';
2052
2053       if (StructorType == Ctor_DefaultClosure) {
2054         // Default constructor closure always has no arguments.
2055         Out << 'X';
2056       } else if (StructorType == Ctor_CopyingClosure) {
2057         // Copy constructor closure always takes an unqualified reference.
2058         mangleArgumentType(getASTContext().getLValueReferenceType(
2059                                Proto->getParamType(0)
2060                                    ->getAs<LValueReferenceType>()
2061                                    ->getPointeeType(),
2062                                /*SpelledAsLValue=*/true),
2063                            Range);
2064         Out << '@';
2065       } else {
2066         llvm_unreachable("unexpected constructor closure!");
2067       }
2068       Out << 'Z';
2069       return;
2070     }
2071     Out << '@';
2072   } else {
2073     QualType ResultType = T->getReturnType();
2074     if (const auto *AT =
2075             dyn_cast_or_null<AutoType>(ResultType->getContainedAutoType())) {
2076       Out << '?';
2077       mangleQualifiers(ResultType.getLocalQualifiers(), /*IsMember=*/false);
2078       Out << '?';
2079       assert(AT->getKeyword() != AutoTypeKeyword::GNUAutoType &&
2080              "shouldn't need to mangle __auto_type!");
2081       mangleSourceName(AT->isDecltypeAuto() ? "<decltype-auto>" : "<auto>");
2082       Out << '@';
2083     } else if (IsInLambda) {
2084       Out << '@';
2085     } else {
2086       if (ResultType->isVoidType())
2087         ResultType = ResultType.getUnqualifiedType();
2088       mangleType(ResultType, Range, QMM_Result);
2089     }
2090   }
2091
2092   // <argument-list> ::= X # void
2093   //                 ::= <type>+ @
2094   //                 ::= <type>* Z # varargs
2095   if (!Proto) {
2096     // Function types without prototypes can arise when mangling a function type
2097     // within an overloadable function in C. We mangle these as the absence of
2098     // any parameter types (not even an empty parameter list).
2099     Out << '@';
2100   } else if (Proto->getNumParams() == 0 && !Proto->isVariadic()) {
2101     Out << 'X';
2102   } else {
2103     // Happens for function pointer type arguments for example.
2104     for (unsigned I = 0, E = Proto->getNumParams(); I != E; ++I) {
2105       mangleArgumentType(Proto->getParamType(I), Range);
2106       // Mangle each pass_object_size parameter as if it's a parameter of enum
2107       // type passed directly after the parameter with the pass_object_size
2108       // attribute. The aforementioned enum's name is __pass_object_size, and we
2109       // pretend it resides in a top-level namespace called __clang.
2110       //
2111       // FIXME: Is there a defined extension notation for the MS ABI, or is it
2112       // necessary to just cross our fingers and hope this type+namespace
2113       // combination doesn't conflict with anything?
2114       if (D)
2115         if (const auto *P = D->getParamDecl(I)->getAttr<PassObjectSizeAttr>())
2116           manglePassObjectSizeArg(P);
2117     }
2118     // <builtin-type>      ::= Z  # ellipsis
2119     if (Proto->isVariadic())
2120       Out << 'Z';
2121     else
2122       Out << '@';
2123   }
2124
2125   mangleThrowSpecification(Proto);
2126 }
2127
2128 void MicrosoftCXXNameMangler::mangleFunctionClass(const FunctionDecl *FD) {
2129   // <function-class>  ::= <member-function> E? # E designates a 64-bit 'this'
2130   //                                            # pointer. in 64-bit mode *all*
2131   //                                            # 'this' pointers are 64-bit.
2132   //                   ::= <global-function>
2133   // <member-function> ::= A # private: near
2134   //                   ::= B # private: far
2135   //                   ::= C # private: static near
2136   //                   ::= D # private: static far
2137   //                   ::= E # private: virtual near
2138   //                   ::= F # private: virtual far
2139   //                   ::= I # protected: near
2140   //                   ::= J # protected: far
2141   //                   ::= K # protected: static near
2142   //                   ::= L # protected: static far
2143   //                   ::= M # protected: virtual near
2144   //                   ::= N # protected: virtual far
2145   //                   ::= Q # public: near
2146   //                   ::= R # public: far
2147   //                   ::= S # public: static near
2148   //                   ::= T # public: static far
2149   //                   ::= U # public: virtual near
2150   //                   ::= V # public: virtual far
2151   // <global-function> ::= Y # global near
2152   //                   ::= Z # global far
2153   if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD)) {
2154     bool IsVirtual = MD->isVirtual();
2155     // When mangling vbase destructor variants, ignore whether or not the
2156     // underlying destructor was defined to be virtual.
2157     if (isa<CXXDestructorDecl>(MD) && isStructorDecl(MD) &&
2158         StructorType == Dtor_Complete) {
2159       IsVirtual = false;
2160     }
2161     switch (MD->getAccess()) {
2162       case AS_none:
2163         llvm_unreachable("Unsupported access specifier");
2164       case AS_private:
2165         if (MD->isStatic())
2166           Out << 'C';
2167         else if (IsVirtual)
2168           Out << 'E';
2169         else
2170           Out << 'A';
2171         break;
2172       case AS_protected:
2173         if (MD->isStatic())
2174           Out << 'K';
2175         else if (IsVirtual)
2176           Out << 'M';
2177         else
2178           Out << 'I';
2179         break;
2180       case AS_public:
2181         if (MD->isStatic())
2182           Out << 'S';
2183         else if (IsVirtual)
2184           Out << 'U';
2185         else
2186           Out << 'Q';
2187     }
2188   } else {
2189     Out << 'Y';
2190   }
2191 }
2192 void MicrosoftCXXNameMangler::mangleCallingConvention(CallingConv CC) {
2193   // <calling-convention> ::= A # __cdecl
2194   //                      ::= B # __export __cdecl
2195   //                      ::= C # __pascal
2196   //                      ::= D # __export __pascal
2197   //                      ::= E # __thiscall
2198   //                      ::= F # __export __thiscall
2199   //                      ::= G # __stdcall
2200   //                      ::= H # __export __stdcall
2201   //                      ::= I # __fastcall
2202   //                      ::= J # __export __fastcall
2203   //                      ::= Q # __vectorcall
2204   //                      ::= w # __regcall
2205   // The 'export' calling conventions are from a bygone era
2206   // (*cough*Win16*cough*) when functions were declared for export with
2207   // that keyword. (It didn't actually export them, it just made them so
2208   // that they could be in a DLL and somebody from another module could call
2209   // them.)
2210
2211   switch (CC) {
2212     default:
2213       llvm_unreachable("Unsupported CC for mangling");
2214     case CC_Win64:
2215     case CC_X86_64SysV:
2216     case CC_C: Out << 'A'; break;
2217     case CC_X86Pascal: Out << 'C'; break;
2218     case CC_X86ThisCall: Out << 'E'; break;
2219     case CC_X86StdCall: Out << 'G'; break;
2220     case CC_X86FastCall: Out << 'I'; break;
2221     case CC_X86VectorCall: Out << 'Q'; break;
2222     case CC_Swift: Out << 'S'; break;
2223     case CC_PreserveMost: Out << 'U'; break;
2224     case CC_X86RegCall: Out << 'w'; break;
2225   }
2226 }
2227 void MicrosoftCXXNameMangler::mangleCallingConvention(const FunctionType *T) {
2228   mangleCallingConvention(T->getCallConv());
2229 }
2230 void MicrosoftCXXNameMangler::mangleThrowSpecification(
2231                                                 const FunctionProtoType *FT) {
2232   // <throw-spec> ::= Z # throw(...) (default)
2233   //              ::= @ # throw() or __declspec/__attribute__((nothrow))
2234   //              ::= <type>+
2235   // NOTE: Since the Microsoft compiler ignores throw specifications, they are
2236   // all actually mangled as 'Z'. (They're ignored because their associated
2237   // functionality isn't implemented, and probably never will be.)
2238   Out << 'Z';
2239 }
2240
2241 void MicrosoftCXXNameMangler::mangleType(const UnresolvedUsingType *T,
2242                                          Qualifiers, SourceRange Range) {
2243   // Probably should be mangled as a template instantiation; need to see what
2244   // VC does first.
2245   DiagnosticsEngine &Diags = Context.getDiags();
2246   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2247     "cannot mangle this unresolved dependent type yet");
2248   Diags.Report(Range.getBegin(), DiagID)
2249     << Range;
2250 }
2251
2252 // <type>        ::= <union-type> | <struct-type> | <class-type> | <enum-type>
2253 // <union-type>  ::= T <name>
2254 // <struct-type> ::= U <name>
2255 // <class-type>  ::= V <name>
2256 // <enum-type>   ::= W4 <name>
2257 void MicrosoftCXXNameMangler::mangleTagTypeKind(TagTypeKind TTK) {
2258   switch (TTK) {
2259     case TTK_Union:
2260       Out << 'T';
2261       break;
2262     case TTK_Struct:
2263     case TTK_Interface:
2264       Out << 'U';
2265       break;
2266     case TTK_Class:
2267       Out << 'V';
2268       break;
2269     case TTK_Enum:
2270       Out << "W4";
2271       break;
2272   }
2273 }
2274 void MicrosoftCXXNameMangler::mangleType(const EnumType *T, Qualifiers,
2275                                          SourceRange) {
2276   mangleType(cast<TagType>(T)->getDecl());
2277 }
2278 void MicrosoftCXXNameMangler::mangleType(const RecordType *T, Qualifiers,
2279                                          SourceRange) {
2280   mangleType(cast<TagType>(T)->getDecl());
2281 }
2282 void MicrosoftCXXNameMangler::mangleType(const TagDecl *TD) {
2283   mangleTagTypeKind(TD->getTagKind());
2284   mangleName(TD);
2285 }
2286
2287 // If you add a call to this, consider updating isArtificialTagType() too.
2288 void MicrosoftCXXNameMangler::mangleArtificalTagType(
2289     TagTypeKind TK, StringRef UnqualifiedName,
2290     ArrayRef<StringRef> NestedNames) {
2291   // <name> ::= <unscoped-name> {[<named-scope>]+ | [<nested-name>]}? @
2292   mangleTagTypeKind(TK);
2293
2294   // Always start with the unqualified name.
2295   mangleSourceName(UnqualifiedName);
2296
2297   for (auto I = NestedNames.rbegin(), E = NestedNames.rend(); I != E; ++I)
2298     mangleSourceName(*I);
2299
2300   // Terminate the whole name with an '@'.
2301   Out << '@';
2302 }
2303
2304 // <type>       ::= <array-type>
2305 // <array-type> ::= <pointer-cvr-qualifiers> <cvr-qualifiers>
2306 //                  [Y <dimension-count> <dimension>+]
2307 //                  <element-type> # as global, E is never required
2308 // It's supposed to be the other way around, but for some strange reason, it
2309 // isn't. Today this behavior is retained for the sole purpose of backwards
2310 // compatibility.
2311 void MicrosoftCXXNameMangler::mangleDecayedArrayType(const ArrayType *T) {
2312   // This isn't a recursive mangling, so now we have to do it all in this
2313   // one call.
2314   manglePointerCVQualifiers(T->getElementType().getQualifiers());
2315   mangleType(T->getElementType(), SourceRange());
2316 }
2317 void MicrosoftCXXNameMangler::mangleType(const ConstantArrayType *T, Qualifiers,
2318                                          SourceRange) {
2319   llvm_unreachable("Should have been special cased");
2320 }
2321 void MicrosoftCXXNameMangler::mangleType(const VariableArrayType *T, Qualifiers,
2322                                          SourceRange) {
2323   llvm_unreachable("Should have been special cased");
2324 }
2325 void MicrosoftCXXNameMangler::mangleType(const DependentSizedArrayType *T,
2326                                          Qualifiers, SourceRange) {
2327   llvm_unreachable("Should have been special cased");
2328 }
2329 void MicrosoftCXXNameMangler::mangleType(const IncompleteArrayType *T,
2330                                          Qualifiers, SourceRange) {
2331   llvm_unreachable("Should have been special cased");
2332 }
2333 void MicrosoftCXXNameMangler::mangleArrayType(const ArrayType *T) {
2334   QualType ElementTy(T, 0);
2335   SmallVector<llvm::APInt, 3> Dimensions;
2336   for (;;) {
2337     if (ElementTy->isConstantArrayType()) {
2338       const ConstantArrayType *CAT =
2339           getASTContext().getAsConstantArrayType(ElementTy);
2340       Dimensions.push_back(CAT->getSize());
2341       ElementTy = CAT->getElementType();
2342     } else if (ElementTy->isIncompleteArrayType()) {
2343       const IncompleteArrayType *IAT =
2344           getASTContext().getAsIncompleteArrayType(ElementTy);
2345       Dimensions.push_back(llvm::APInt(32, 0));
2346       ElementTy = IAT->getElementType();
2347     } else if (ElementTy->isVariableArrayType()) {
2348       const VariableArrayType *VAT =
2349         getASTContext().getAsVariableArrayType(ElementTy);
2350       Dimensions.push_back(llvm::APInt(32, 0));
2351       ElementTy = VAT->getElementType();
2352     } else if (ElementTy->isDependentSizedArrayType()) {
2353       // The dependent expression has to be folded into a constant (TODO).
2354       const DependentSizedArrayType *DSAT =
2355         getASTContext().getAsDependentSizedArrayType(ElementTy);
2356       DiagnosticsEngine &Diags = Context.getDiags();
2357       unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2358         "cannot mangle this dependent-length array yet");
2359       Diags.Report(DSAT->getSizeExpr()->getExprLoc(), DiagID)
2360         << DSAT->getBracketsRange();
2361       return;
2362     } else {
2363       break;
2364     }
2365   }
2366   Out << 'Y';
2367   // <dimension-count> ::= <number> # number of extra dimensions
2368   mangleNumber(Dimensions.size());
2369   for (const llvm::APInt &Dimension : Dimensions)
2370     mangleNumber(Dimension.getLimitedValue());
2371   mangleType(ElementTy, SourceRange(), QMM_Escape);
2372 }
2373
2374 // <type>                   ::= <pointer-to-member-type>
2375 // <pointer-to-member-type> ::= <pointer-cvr-qualifiers> <cvr-qualifiers>
2376 //                                                          <class name> <type>
2377 void MicrosoftCXXNameMangler::mangleType(const MemberPointerType *T,
2378                                          Qualifiers Quals, SourceRange Range) {
2379   QualType PointeeType = T->getPointeeType();
2380   manglePointerCVQualifiers(Quals);
2381   manglePointerExtQualifiers(Quals, PointeeType);
2382   if (const FunctionProtoType *FPT = PointeeType->getAs<FunctionProtoType>()) {
2383     Out << '8';
2384     mangleName(T->getClass()->castAs<RecordType>()->getDecl());
2385     mangleFunctionType(FPT, nullptr, true);
2386   } else {
2387     mangleQualifiers(PointeeType.getQualifiers(), true);
2388     mangleName(T->getClass()->castAs<RecordType>()->getDecl());
2389     mangleType(PointeeType, Range, QMM_Drop);
2390   }
2391 }
2392
2393 void MicrosoftCXXNameMangler::mangleType(const TemplateTypeParmType *T,
2394                                          Qualifiers, SourceRange Range) {
2395   DiagnosticsEngine &Diags = Context.getDiags();
2396   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2397     "cannot mangle this template type parameter type yet");
2398   Diags.Report(Range.getBegin(), DiagID)
2399     << Range;
2400 }
2401
2402 void MicrosoftCXXNameMangler::mangleType(const SubstTemplateTypeParmPackType *T,
2403                                          Qualifiers, SourceRange Range) {
2404   DiagnosticsEngine &Diags = Context.getDiags();
2405   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2406     "cannot mangle this substituted parameter pack yet");
2407   Diags.Report(Range.getBegin(), DiagID)
2408     << Range;
2409 }
2410
2411 // <type> ::= <pointer-type>
2412 // <pointer-type> ::= E? <pointer-cvr-qualifiers> <cvr-qualifiers> <type>
2413 //                       # the E is required for 64-bit non-static pointers
2414 void MicrosoftCXXNameMangler::mangleType(const PointerType *T, Qualifiers Quals,
2415                                          SourceRange Range) {
2416   QualType PointeeType = T->getPointeeType();
2417   manglePointerCVQualifiers(Quals);
2418   manglePointerExtQualifiers(Quals, PointeeType);
2419   mangleType(PointeeType, Range);
2420 }
2421
2422 void MicrosoftCXXNameMangler::mangleType(const ObjCObjectPointerType *T,
2423                                          Qualifiers Quals, SourceRange Range) {
2424   QualType PointeeType = T->getPointeeType();
2425   switch (Quals.getObjCLifetime()) {
2426   case Qualifiers::OCL_None:
2427   case Qualifiers::OCL_ExplicitNone:
2428     break;
2429   case Qualifiers::OCL_Autoreleasing:
2430   case Qualifiers::OCL_Strong:
2431   case Qualifiers::OCL_Weak:
2432     return mangleObjCLifetime(PointeeType, Quals, Range);
2433   }
2434   manglePointerCVQualifiers(Quals);
2435   manglePointerExtQualifiers(Quals, PointeeType);
2436   mangleType(PointeeType, Range);
2437 }
2438
2439 // <type> ::= <reference-type>
2440 // <reference-type> ::= A E? <cvr-qualifiers> <type>
2441 //                 # the E is required for 64-bit non-static lvalue references
2442 void MicrosoftCXXNameMangler::mangleType(const LValueReferenceType *T,
2443                                          Qualifiers Quals, SourceRange Range) {
2444   QualType PointeeType = T->getPointeeType();
2445   assert(!Quals.hasConst() && !Quals.hasVolatile() && "unexpected qualifier!");
2446   Out << 'A';
2447   manglePointerExtQualifiers(Quals, PointeeType);
2448   mangleType(PointeeType, Range);
2449 }
2450
2451 // <type> ::= <r-value-reference-type>
2452 // <r-value-reference-type> ::= $$Q E? <cvr-qualifiers> <type>
2453 //                 # the E is required for 64-bit non-static rvalue references
2454 void MicrosoftCXXNameMangler::mangleType(const RValueReferenceType *T,
2455                                          Qualifiers Quals, SourceRange Range) {
2456   QualType PointeeType = T->getPointeeType();
2457   assert(!Quals.hasConst() && !Quals.hasVolatile() && "unexpected qualifier!");
2458   Out << "$$Q";
2459   manglePointerExtQualifiers(Quals, PointeeType);
2460   mangleType(PointeeType, Range);
2461 }
2462
2463 void MicrosoftCXXNameMangler::mangleType(const ComplexType *T, Qualifiers,
2464                                          SourceRange Range) {
2465   QualType ElementType = T->getElementType();
2466
2467   llvm::SmallString<64> TemplateMangling;
2468   llvm::raw_svector_ostream Stream(TemplateMangling);
2469   MicrosoftCXXNameMangler Extra(Context, Stream);
2470   Stream << "?$";
2471   Extra.mangleSourceName("_Complex");
2472   Extra.mangleType(ElementType, Range, QMM_Escape);
2473
2474   mangleArtificalTagType(TTK_Struct, TemplateMangling, {"__clang"});
2475 }
2476
2477 // Returns true for types that mangleArtificalTagType() gets called for with
2478 // TTK_Union, TTK_Struct, TTK_Class and where compatibility with MSVC's
2479 // mangling matters.
2480 // (It doesn't matter for Objective-C types and the like that cl.exe doesn't
2481 // support.)
2482 bool MicrosoftCXXNameMangler::isArtificialTagType(QualType T) const {
2483   const Type *ty = T.getTypePtr();
2484   switch (ty->getTypeClass()) {
2485   default:
2486     return false;
2487
2488   case Type::Vector: {
2489     // For ABI compatibility only __m64, __m128(id), and __m256(id) matter,
2490     // but since mangleType(VectorType*) always calls mangleArtificalTagType()
2491     // just always return true (the other vector types are clang-only).
2492     return true;
2493   }
2494   }
2495 }
2496
2497 void MicrosoftCXXNameMangler::mangleType(const VectorType *T, Qualifiers Quals,
2498                                          SourceRange Range) {
2499   const BuiltinType *ET = T->getElementType()->getAs<BuiltinType>();
2500   assert(ET && "vectors with non-builtin elements are unsupported");
2501   uint64_t Width = getASTContext().getTypeSize(T);
2502   // Pattern match exactly the typedefs in our intrinsic headers.  Anything that
2503   // doesn't match the Intel types uses a custom mangling below.
2504   size_t OutSizeBefore = Out.tell();
2505   llvm::Triple::ArchType AT =
2506       getASTContext().getTargetInfo().getTriple().getArch();
2507   if (AT == llvm::Triple::x86 || AT == llvm::Triple::x86_64) {
2508     if (Width == 64 && ET->getKind() == BuiltinType::LongLong) {
2509       mangleArtificalTagType(TTK_Union, "__m64");
2510     } else if (Width >= 128) {
2511       if (ET->getKind() == BuiltinType::Float)
2512         mangleArtificalTagType(TTK_Union, "__m" + llvm::utostr(Width));
2513       else if (ET->getKind() == BuiltinType::LongLong)
2514         mangleArtificalTagType(TTK_Union, "__m" + llvm::utostr(Width) + 'i');
2515       else if (ET->getKind() == BuiltinType::Double)
2516         mangleArtificalTagType(TTK_Struct, "__m" + llvm::utostr(Width) + 'd');
2517     }
2518   }
2519
2520   bool IsBuiltin = Out.tell() != OutSizeBefore;
2521   if (!IsBuiltin) {
2522     // The MS ABI doesn't have a special mangling for vector types, so we define
2523     // our own mangling to handle uses of __vector_size__ on user-specified
2524     // types, and for extensions like __v4sf.
2525
2526     llvm::SmallString<64> TemplateMangling;
2527     llvm::raw_svector_ostream Stream(TemplateMangling);
2528     MicrosoftCXXNameMangler Extra(Context, Stream);
2529     Stream << "?$";
2530     Extra.mangleSourceName("__vector");
2531     Extra.mangleType(QualType(ET, 0), Range, QMM_Escape);
2532     Extra.mangleIntegerLiteral(llvm::APSInt::getUnsigned(T->getNumElements()),
2533                                /*IsBoolean=*/false);
2534
2535     mangleArtificalTagType(TTK_Union, TemplateMangling, {"__clang"});
2536   }
2537 }
2538
2539 void MicrosoftCXXNameMangler::mangleType(const ExtVectorType *T,
2540                                          Qualifiers Quals, SourceRange Range) {
2541   mangleType(static_cast<const VectorType *>(T), Quals, Range);
2542 }
2543
2544 void MicrosoftCXXNameMangler::mangleType(const DependentVectorType *T,
2545                                          Qualifiers, SourceRange Range) {
2546   DiagnosticsEngine &Diags = Context.getDiags();
2547   unsigned DiagID = Diags.getCustomDiagID(
2548       DiagnosticsEngine::Error,
2549       "cannot mangle this dependent-sized vector type yet");
2550   Diags.Report(Range.getBegin(), DiagID) << Range;
2551 }
2552
2553 void MicrosoftCXXNameMangler::mangleType(const DependentSizedExtVectorType *T,
2554                                          Qualifiers, SourceRange Range) {
2555   DiagnosticsEngine &Diags = Context.getDiags();
2556   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2557     "cannot mangle this dependent-sized extended vector type yet");
2558   Diags.Report(Range.getBegin(), DiagID)
2559     << Range;
2560 }
2561
2562 void MicrosoftCXXNameMangler::mangleType(const DependentAddressSpaceType *T,
2563                                          Qualifiers, SourceRange Range) {
2564   DiagnosticsEngine &Diags = Context.getDiags();
2565   unsigned DiagID = Diags.getCustomDiagID(
2566       DiagnosticsEngine::Error,
2567       "cannot mangle this dependent address space type yet");
2568   Diags.Report(Range.getBegin(), DiagID) << Range;
2569 }
2570
2571 void MicrosoftCXXNameMangler::mangleType(const ObjCInterfaceType *T, Qualifiers,
2572                                          SourceRange) {
2573   // ObjC interfaces are mangled as if they were structs with a name that is
2574   // not a valid C/C++ identifier
2575   mangleTagTypeKind(TTK_Struct);
2576   mangle(T->getDecl(), ".objc_cls_");
2577 }
2578
2579 void MicrosoftCXXNameMangler::mangleType(const ObjCObjectType *T, Qualifiers,
2580                                          SourceRange Range) {
2581   if (T->qual_empty())
2582     return mangleType(T->getBaseType(), Range, QMM_Drop);
2583
2584   ArgBackRefMap OuterArgsContext;
2585   BackRefVec OuterTemplateContext;
2586
2587   TypeBackReferences.swap(OuterArgsContext);
2588   NameBackReferences.swap(OuterTemplateContext);
2589
2590   mangleTagTypeKind(TTK_Struct);
2591
2592   Out << "?$";
2593   if (T->isObjCId())
2594     mangleSourceName(".objc_object");
2595   else if (T->isObjCClass())
2596     mangleSourceName(".objc_class");
2597   else
2598     mangleSourceName((".objc_cls_" + T->getInterface()->getName()).str());
2599
2600   for (const auto &Q : T->quals())
2601     mangleObjCProtocol(Q);
2602   Out << '@';
2603
2604   Out << '@';
2605
2606   TypeBackReferences.swap(OuterArgsContext);
2607   NameBackReferences.swap(OuterTemplateContext);
2608 }
2609
2610 void MicrosoftCXXNameMangler::mangleType(const BlockPointerType *T,
2611                                          Qualifiers Quals, SourceRange Range) {
2612   QualType PointeeType = T->getPointeeType();
2613   manglePointerCVQualifiers(Quals);
2614   manglePointerExtQualifiers(Quals, PointeeType);
2615
2616   Out << "_E";
2617
2618   mangleFunctionType(PointeeType->castAs<FunctionProtoType>());
2619 }
2620
2621 void MicrosoftCXXNameMangler::mangleType(const InjectedClassNameType *,
2622                                          Qualifiers, SourceRange) {
2623   llvm_unreachable("Cannot mangle injected class name type.");
2624 }
2625
2626 void MicrosoftCXXNameMangler::mangleType(const TemplateSpecializationType *T,
2627                                          Qualifiers, SourceRange Range) {
2628   DiagnosticsEngine &Diags = Context.getDiags();
2629   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2630     "cannot mangle this template specialization type yet");
2631   Diags.Report(Range.getBegin(), DiagID)
2632     << Range;
2633 }
2634
2635 void MicrosoftCXXNameMangler::mangleType(const DependentNameType *T, Qualifiers,
2636                                          SourceRange Range) {
2637   DiagnosticsEngine &Diags = Context.getDiags();
2638   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2639     "cannot mangle this dependent name type yet");
2640   Diags.Report(Range.getBegin(), DiagID)
2641     << Range;
2642 }
2643
2644 void MicrosoftCXXNameMangler::mangleType(
2645     const DependentTemplateSpecializationType *T, Qualifiers,
2646     SourceRange Range) {
2647   DiagnosticsEngine &Diags = Context.getDiags();
2648   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2649     "cannot mangle this dependent template specialization type yet");
2650   Diags.Report(Range.getBegin(), DiagID)
2651     << Range;
2652 }
2653
2654 void MicrosoftCXXNameMangler::mangleType(const PackExpansionType *T, Qualifiers,
2655                                          SourceRange Range) {
2656   DiagnosticsEngine &Diags = Context.getDiags();
2657   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2658     "cannot mangle this pack expansion yet");
2659   Diags.Report(Range.getBegin(), DiagID)
2660     << Range;
2661 }
2662
2663 void MicrosoftCXXNameMangler::mangleType(const TypeOfType *T, Qualifiers,
2664                                          SourceRange Range) {
2665   DiagnosticsEngine &Diags = Context.getDiags();
2666   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2667     "cannot mangle this typeof(type) yet");
2668   Diags.Report(Range.getBegin(), DiagID)
2669     << Range;
2670 }
2671
2672 void MicrosoftCXXNameMangler::mangleType(const TypeOfExprType *T, Qualifiers,
2673                                          SourceRange Range) {
2674   DiagnosticsEngine &Diags = Context.getDiags();
2675   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2676     "cannot mangle this typeof(expression) yet");
2677   Diags.Report(Range.getBegin(), DiagID)
2678     << Range;
2679 }
2680
2681 void MicrosoftCXXNameMangler::mangleType(const DecltypeType *T, Qualifiers,
2682                                          SourceRange Range) {
2683   DiagnosticsEngine &Diags = Context.getDiags();
2684   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2685     "cannot mangle this decltype() yet");
2686   Diags.Report(Range.getBegin(), DiagID)
2687     << Range;
2688 }
2689
2690 void MicrosoftCXXNameMangler::mangleType(const UnaryTransformType *T,
2691                                          Qualifiers, SourceRange Range) {
2692   DiagnosticsEngine &Diags = Context.getDiags();
2693   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2694     "cannot mangle this unary transform type yet");
2695   Diags.Report(Range.getBegin(), DiagID)
2696     << Range;
2697 }
2698
2699 void MicrosoftCXXNameMangler::mangleType(const AutoType *T, Qualifiers,
2700                                          SourceRange Range) {
2701   assert(T->getDeducedType().isNull() && "expecting a dependent type!");
2702
2703   DiagnosticsEngine &Diags = Context.getDiags();
2704   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2705     "cannot mangle this 'auto' type yet");
2706   Diags.Report(Range.getBegin(), DiagID)
2707     << Range;
2708 }
2709
2710 void MicrosoftCXXNameMangler::mangleType(
2711     const DeducedTemplateSpecializationType *T, Qualifiers, SourceRange Range) {
2712   assert(T->getDeducedType().isNull() && "expecting a dependent type!");
2713
2714   DiagnosticsEngine &Diags = Context.getDiags();
2715   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2716     "cannot mangle this deduced class template specialization type yet");
2717   Diags.Report(Range.getBegin(), DiagID)
2718     << Range;
2719 }
2720
2721 void MicrosoftCXXNameMangler::mangleType(const AtomicType *T, Qualifiers,
2722                                          SourceRange Range) {
2723   QualType ValueType = T->getValueType();
2724
2725   llvm::SmallString<64> TemplateMangling;
2726   llvm::raw_svector_ostream Stream(TemplateMangling);
2727   MicrosoftCXXNameMangler Extra(Context, Stream);
2728   Stream << "?$";
2729   Extra.mangleSourceName("_Atomic");
2730   Extra.mangleType(ValueType, Range, QMM_Escape);
2731
2732   mangleArtificalTagType(TTK_Struct, TemplateMangling, {"__clang"});
2733 }
2734
2735 void MicrosoftCXXNameMangler::mangleType(const PipeType *T, Qualifiers,
2736                                          SourceRange Range) {
2737   DiagnosticsEngine &Diags = Context.getDiags();
2738   unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2739     "cannot mangle this OpenCL pipe type yet");
2740   Diags.Report(Range.getBegin(), DiagID)
2741     << Range;
2742 }
2743
2744 void MicrosoftMangleContextImpl::mangleCXXName(const NamedDecl *D,
2745                                                raw_ostream &Out) {
2746   assert((isa<FunctionDecl>(D) || isa<VarDecl>(D)) &&
2747          "Invalid mangleName() call, argument is not a variable or function!");
2748   assert(!isa<CXXConstructorDecl>(D) && !isa<CXXDestructorDecl>(D) &&
2749          "Invalid mangleName() call on 'structor decl!");
2750
2751   PrettyStackTraceDecl CrashInfo(D, SourceLocation(),
2752                                  getASTContext().getSourceManager(),
2753                                  "Mangling declaration");
2754
2755   msvc_hashing_ostream MHO(Out);
2756   MicrosoftCXXNameMangler Mangler(*this, MHO);
2757   return Mangler.mangle(D);
2758 }
2759
2760 // <this-adjustment> ::= <no-adjustment> | <static-adjustment> |
2761 //                       <virtual-adjustment>
2762 // <no-adjustment>      ::= A # private near
2763 //                      ::= B # private far
2764 //                      ::= I # protected near
2765 //                      ::= J # protected far
2766 //                      ::= Q # public near
2767 //                      ::= R # public far
2768 // <static-adjustment>  ::= G <static-offset> # private near
2769 //                      ::= H <static-offset> # private far
2770 //                      ::= O <static-offset> # protected near
2771 //                      ::= P <static-offset> # protected far
2772 //                      ::= W <static-offset> # public near
2773 //                      ::= X <static-offset> # public far
2774 // <virtual-adjustment> ::= $0 <virtual-shift> <static-offset> # private near
2775 //                      ::= $1 <virtual-shift> <static-offset> # private far
2776 //                      ::= $2 <virtual-shift> <static-offset> # protected near
2777 //                      ::= $3 <virtual-shift> <static-offset> # protected far
2778 //                      ::= $4 <virtual-shift> <static-offset> # public near
2779 //                      ::= $5 <virtual-shift> <static-offset> # public far
2780 // <virtual-shift>      ::= <vtordisp-shift> | <vtordispex-shift>
2781 // <vtordisp-shift>     ::= <offset-to-vtordisp>
2782 // <vtordispex-shift>   ::= <offset-to-vbptr> <vbase-offset-offset>
2783 //                          <offset-to-vtordisp>
2784 static void mangleThunkThisAdjustment(const CXXMethodDecl *MD,
2785                                       const ThisAdjustment &Adjustment,
2786                                       MicrosoftCXXNameMangler &Mangler,
2787                                       raw_ostream &Out) {
2788   if (!Adjustment.Virtual.isEmpty()) {
2789     Out << '$';
2790     char AccessSpec;
2791     switch (MD->getAccess()) {
2792     case AS_none:
2793       llvm_unreachable("Unsupported access specifier");
2794     case AS_private:
2795       AccessSpec = '0';
2796       break;
2797     case AS_protected:
2798       AccessSpec = '2';
2799       break;
2800     case AS_public:
2801       AccessSpec = '4';
2802     }
2803     if (Adjustment.Virtual.Microsoft.VBPtrOffset) {
2804       Out << 'R' << AccessSpec;
2805       Mangler.mangleNumber(
2806           static_cast<uint32_t>(Adjustment.Virtual.Microsoft.VBPtrOffset));
2807       Mangler.mangleNumber(
2808           static_cast<uint32_t>(Adjustment.Virtual.Microsoft.VBOffsetOffset));
2809       Mangler.mangleNumber(
2810           static_cast<uint32_t>(Adjustment.Virtual.Microsoft.VtordispOffset));
2811       Mangler.mangleNumber(static_cast<uint32_t>(Adjustment.NonVirtual));
2812     } else {
2813       Out << AccessSpec;
2814       Mangler.mangleNumber(
2815           static_cast<uint32_t>(Adjustment.Virtual.Microsoft.VtordispOffset));
2816       Mangler.mangleNumber(-static_cast<uint32_t>(Adjustment.NonVirtual));
2817     }
2818   } else if (Adjustment.NonVirtual != 0) {
2819     switch (MD->getAccess()) {
2820     case AS_none:
2821       llvm_unreachable("Unsupported access specifier");
2822     case AS_private:
2823       Out << 'G';
2824       break;
2825     case AS_protected:
2826       Out << 'O';
2827       break;
2828     case AS_public:
2829       Out << 'W';
2830     }
2831     Mangler.mangleNumber(-static_cast<uint32_t>(Adjustment.NonVirtual));
2832   } else {
2833     switch (MD->getAccess()) {
2834     case AS_none:
2835       llvm_unreachable("Unsupported access specifier");
2836     case AS_private:
2837       Out << 'A';
2838       break;
2839     case AS_protected:
2840       Out << 'I';
2841       break;
2842     case AS_public:
2843       Out << 'Q';
2844     }
2845   }
2846 }
2847
2848 void MicrosoftMangleContextImpl::mangleVirtualMemPtrThunk(
2849     const CXXMethodDecl *MD, const MethodVFTableLocation &ML,
2850     raw_ostream &Out) {
2851   msvc_hashing_ostream MHO(Out);
2852   MicrosoftCXXNameMangler Mangler(*this, MHO);
2853   Mangler.getStream() << '?';
2854   Mangler.mangleVirtualMemPtrThunk(MD, ML);
2855 }
2856
2857 void MicrosoftMangleContextImpl::mangleThunk(const CXXMethodDecl *MD,
2858                                              const ThunkInfo &Thunk,
2859                                              raw_ostream &Out) {
2860   msvc_hashing_ostream MHO(Out);
2861   MicrosoftCXXNameMangler Mangler(*this, MHO);
2862   Mangler.getStream() << '?';
2863   Mangler.mangleName(MD);
2864   mangleThunkThisAdjustment(MD, Thunk.This, Mangler, MHO);
2865   if (!Thunk.Return.isEmpty())
2866     assert(Thunk.Method != nullptr &&
2867            "Thunk info should hold the overridee decl");
2868
2869   const CXXMethodDecl *DeclForFPT = Thunk.Method ? Thunk.Method : MD;
2870   Mangler.mangleFunctionType(
2871       DeclForFPT->getType()->castAs<FunctionProtoType>(), MD);
2872 }
2873
2874 void MicrosoftMangleContextImpl::mangleCXXDtorThunk(
2875     const CXXDestructorDecl *DD, CXXDtorType Type,
2876     const ThisAdjustment &Adjustment, raw_ostream &Out) {
2877   // FIXME: Actually, the dtor thunk should be emitted for vector deleting
2878   // dtors rather than scalar deleting dtors. Just use the vector deleting dtor
2879   // mangling manually until we support both deleting dtor types.
2880   assert(Type == Dtor_Deleting);
2881   msvc_hashing_ostream MHO(Out);
2882   MicrosoftCXXNameMangler Mangler(*this, MHO, DD, Type);
2883   Mangler.getStream() << "??_E";
2884   Mangler.mangleName(DD->getParent());
2885   mangleThunkThisAdjustment(DD, Adjustment, Mangler, MHO);
2886   Mangler.mangleFunctionType(DD->getType()->castAs<FunctionProtoType>(), DD);
2887 }
2888
2889 void MicrosoftMangleContextImpl::mangleCXXVFTable(
2890     const CXXRecordDecl *Derived, ArrayRef<const CXXRecordDecl *> BasePath,
2891     raw_ostream &Out) {
2892   // <mangled-name> ::= ?_7 <class-name> <storage-class>
2893   //                    <cvr-qualifiers> [<name>] @
2894   // NOTE: <cvr-qualifiers> here is always 'B' (const). <storage-class>
2895   // is always '6' for vftables.
2896   msvc_hashing_ostream MHO(Out);
2897   MicrosoftCXXNameMangler Mangler(*this, MHO);
2898   if (Derived->hasAttr<DLLImportAttr>())
2899     Mangler.getStream() << "??_S";
2900   else
2901     Mangler.getStream() << "??_7";
2902   Mangler.mangleName(Derived);
2903   Mangler.getStream() << "6B"; // '6' for vftable, 'B' for const.
2904   for (const CXXRecordDecl *RD : BasePath)
2905     Mangler.mangleName(RD);
2906   Mangler.getStream() << '@';
2907 }
2908
2909 void MicrosoftMangleContextImpl::mangleCXXVBTable(
2910     const CXXRecordDecl *Derived, ArrayRef<const CXXRecordDecl *> BasePath,
2911     raw_ostream &Out) {
2912   // <mangled-name> ::= ?_8 <class-name> <storage-class>
2913   //                    <cvr-qualifiers> [<name>] @
2914   // NOTE: <cvr-qualifiers> here is always 'B' (const). <storage-class>
2915   // is always '7' for vbtables.
2916   msvc_hashing_ostream MHO(Out);
2917   MicrosoftCXXNameMangler Mangler(*this, MHO);
2918   Mangler.getStream() << "??_8";
2919   Mangler.mangleName(Derived);
2920   Mangler.getStream() << "7B";  // '7' for vbtable, 'B' for const.
2921   for (const CXXRecordDecl *RD : BasePath)
2922     Mangler.mangleName(RD);
2923   Mangler.getStream() << '@';
2924 }
2925
2926 void MicrosoftMangleContextImpl::mangleCXXRTTI(QualType T, raw_ostream &Out) {
2927   msvc_hashing_ostream MHO(Out);
2928   MicrosoftCXXNameMangler Mangler(*this, MHO);
2929   Mangler.getStream() << "??_R0";
2930   Mangler.mangleType(T, SourceRange(), MicrosoftCXXNameMangler::QMM_Result);
2931   Mangler.getStream() << "@8";
2932 }
2933
2934 void MicrosoftMangleContextImpl::mangleCXXRTTIName(QualType T,
2935                                                    raw_ostream &Out) {
2936   MicrosoftCXXNameMangler Mangler(*this, Out);
2937   Mangler.getStream() << '.';
2938   Mangler.mangleType(T, SourceRange(), MicrosoftCXXNameMangler::QMM_Result);
2939 }
2940
2941 void MicrosoftMangleContextImpl::mangleCXXVirtualDisplacementMap(
2942     const CXXRecordDecl *SrcRD, const CXXRecordDecl *DstRD, raw_ostream &Out) {
2943   msvc_hashing_ostream MHO(Out);
2944   MicrosoftCXXNameMangler Mangler(*this, MHO);
2945   Mangler.getStream() << "??_K";
2946   Mangler.mangleName(SrcRD);
2947   Mangler.getStream() << "$C";
2948   Mangler.mangleName(DstRD);
2949 }
2950
2951 void MicrosoftMangleContextImpl::mangleCXXThrowInfo(QualType T, bool IsConst,
2952                                                     bool IsVolatile,
2953                                                     bool IsUnaligned,
2954                                                     uint32_t NumEntries,
2955                                                     raw_ostream &Out) {
2956   msvc_hashing_ostream MHO(Out);
2957   MicrosoftCXXNameMangler Mangler(*this, MHO);
2958   Mangler.getStream() << "_TI";
2959   if (IsConst)
2960     Mangler.getStream() << 'C';
2961   if (IsVolatile)
2962     Mangler.getStream() << 'V';
2963   if (IsUnaligned)
2964     Mangler.getStream() << 'U';
2965   Mangler.getStream() << NumEntries;
2966   Mangler.mangleType(T, SourceRange(), MicrosoftCXXNameMangler::QMM_Result);
2967 }
2968
2969 void MicrosoftMangleContextImpl::mangleCXXCatchableTypeArray(
2970     QualType T, uint32_t NumEntries, raw_ostream &Out) {
2971   msvc_hashing_ostream MHO(Out);
2972   MicrosoftCXXNameMangler Mangler(*this, MHO);
2973   Mangler.getStream() << "_CTA";
2974   Mangler.getStream() << NumEntries;
2975   Mangler.mangleType(T, SourceRange(), MicrosoftCXXNameMangler::QMM_Result);
2976 }
2977
2978 void MicrosoftMangleContextImpl::mangleCXXCatchableType(
2979     QualType T, const CXXConstructorDecl *CD, CXXCtorType CT, uint32_t Size,
2980     uint32_t NVOffset, int32_t VBPtrOffset, uint32_t VBIndex,
2981     raw_ostream &Out) {
2982   MicrosoftCXXNameMangler Mangler(*this, Out);
2983   Mangler.getStream() << "_CT";
2984
2985   llvm::SmallString<64> RTTIMangling;
2986   {
2987     llvm::raw_svector_ostream Stream(RTTIMangling);
2988     msvc_hashing_ostream MHO(Stream);
2989     mangleCXXRTTI(T, MHO);
2990   }
2991   Mangler.getStream() << RTTIMangling;
2992
2993   // VS2015 CTP6 omits the copy-constructor in the mangled name.  This name is,
2994   // in fact, superfluous but I'm not sure the change was made consciously.
2995   llvm::SmallString<64> CopyCtorMangling;
2996   if (!getASTContext().getLangOpts().isCompatibleWithMSVC(
2997           LangOptions::MSVC2015) &&
2998       CD) {
2999     llvm::raw_svector_ostream Stream(CopyCtorMangling);
3000     msvc_hashing_ostream MHO(Stream);
3001     mangleCXXCtor(CD, CT, MHO);
3002   }
3003   Mangler.getStream() << CopyCtorMangling;
3004
3005   Mangler.getStream() << Size;
3006   if (VBPtrOffset == -1) {
3007     if (NVOffset) {
3008       Mangler.getStream() << NVOffset;
3009     }
3010   } else {
3011     Mangler.getStream() << NVOffset;
3012     Mangler.getStream() << VBPtrOffset;
3013     Mangler.getStream() << VBIndex;
3014   }
3015 }
3016
3017 void MicrosoftMangleContextImpl::mangleCXXRTTIBaseClassDescriptor(
3018     const CXXRecordDecl *Derived, uint32_t NVOffset, int32_t VBPtrOffset,
3019     uint32_t VBTableOffset, uint32_t Flags, raw_ostream &Out) {
3020   msvc_hashing_ostream MHO(Out);
3021   MicrosoftCXXNameMangler Mangler(*this, MHO);
3022   Mangler.getStream() << "??_R1";
3023   Mangler.mangleNumber(NVOffset);
3024   Mangler.mangleNumber(VBPtrOffset);
3025   Mangler.mangleNumber(VBTableOffset);
3026   Mangler.mangleNumber(Flags);
3027   Mangler.mangleName(Derived);
3028   Mangler.getStream() << "8";
3029 }
3030
3031 void MicrosoftMangleContextImpl::mangleCXXRTTIBaseClassArray(
3032     const CXXRecordDecl *Derived, raw_ostream &Out) {
3033   msvc_hashing_ostream MHO(Out);
3034   MicrosoftCXXNameMangler Mangler(*this, MHO);
3035   Mangler.getStream() << "??_R2";
3036   Mangler.mangleName(Derived);
3037   Mangler.getStream() << "8";
3038 }
3039
3040 void MicrosoftMangleContextImpl::mangleCXXRTTIClassHierarchyDescriptor(
3041     const CXXRecordDecl *Derived, raw_ostream &Out) {
3042   msvc_hashing_ostream MHO(Out);
3043   MicrosoftCXXNameMangler Mangler(*this, MHO);
3044   Mangler.getStream() << "??_R3";
3045   Mangler.mangleName(Derived);
3046   Mangler.getStream() << "8";
3047 }
3048
3049 void MicrosoftMangleContextImpl::mangleCXXRTTICompleteObjectLocator(
3050     const CXXRecordDecl *Derived, ArrayRef<const CXXRecordDecl *> BasePath,
3051     raw_ostream &Out) {
3052   // <mangled-name> ::= ?_R4 <class-name> <storage-class>
3053   //                    <cvr-qualifiers> [<name>] @
3054   // NOTE: <cvr-qualifiers> here is always 'B' (const). <storage-class>
3055   // is always '6' for vftables.
3056   llvm::SmallString<64> VFTableMangling;
3057   llvm::raw_svector_ostream Stream(VFTableMangling);
3058   mangleCXXVFTable(Derived, BasePath, Stream);
3059
3060   if (VFTableMangling.startswith("??@")) {
3061     assert(VFTableMangling.endswith("@"));
3062     Out << VFTableMangling << "??_R4@";
3063     return;
3064   }
3065
3066   assert(VFTableMangling.startswith("??_7") ||
3067          VFTableMangling.startswith("??_S"));
3068
3069   Out << "??_R4" << StringRef(VFTableMangling).drop_front(4);
3070 }
3071
3072 void MicrosoftMangleContextImpl::mangleSEHFilterExpression(
3073     const NamedDecl *EnclosingDecl, raw_ostream &Out) {
3074   msvc_hashing_ostream MHO(Out);
3075   MicrosoftCXXNameMangler Mangler(*this, MHO);
3076   // The function body is in the same comdat as the function with the handler,
3077   // so the numbering here doesn't have to be the same across TUs.
3078   //
3079   // <mangled-name> ::= ?filt$ <filter-number> @0
3080   Mangler.getStream() << "?filt$" << SEHFilterIds[EnclosingDecl]++ << "@0@";
3081   Mangler.mangleName(EnclosingDecl);
3082 }
3083
3084 void MicrosoftMangleContextImpl::mangleSEHFinallyBlock(
3085     const NamedDecl *EnclosingDecl, raw_ostream &Out) {
3086   msvc_hashing_ostream MHO(Out);
3087   MicrosoftCXXNameMangler Mangler(*this, MHO);
3088   // The function body is in the same comdat as the function with the handler,
3089   // so the numbering here doesn't have to be the same across TUs.
3090   //
3091   // <mangled-name> ::= ?fin$ <filter-number> @0
3092   Mangler.getStream() << "?fin$" << SEHFinallyIds[EnclosingDecl]++ << "@0@";
3093   Mangler.mangleName(EnclosingDecl);
3094 }
3095
3096 void MicrosoftMangleContextImpl::mangleTypeName(QualType T, raw_ostream &Out) {
3097   // This is just a made up unique string for the purposes of tbaa.  undname
3098   // does *not* know how to demangle it.
3099   MicrosoftCXXNameMangler Mangler(*this, Out);
3100   Mangler.getStream() << '?';
3101   Mangler.mangleType(T, SourceRange());
3102 }
3103
3104 void MicrosoftMangleContextImpl::mangleCXXCtor(const CXXConstructorDecl *D,
3105                                                CXXCtorType Type,
3106                                                raw_ostream &Out) {
3107   msvc_hashing_ostream MHO(Out);
3108   MicrosoftCXXNameMangler mangler(*this, MHO, D, Type);
3109   mangler.mangle(D);
3110 }
3111
3112 void MicrosoftMangleContextImpl::mangleCXXDtor(const CXXDestructorDecl *D,
3113                                                CXXDtorType Type,
3114                                                raw_ostream &Out) {
3115   msvc_hashing_ostream MHO(Out);
3116   MicrosoftCXXNameMangler mangler(*this, MHO, D, Type);
3117   mangler.mangle(D);
3118 }
3119
3120 void MicrosoftMangleContextImpl::mangleReferenceTemporary(
3121     const VarDecl *VD, unsigned ManglingNumber, raw_ostream &Out) {
3122   msvc_hashing_ostream MHO(Out);
3123   MicrosoftCXXNameMangler Mangler(*this, MHO);
3124
3125   Mangler.getStream() << "?$RT" << ManglingNumber << '@';
3126   Mangler.mangle(VD, "");
3127 }
3128
3129 void MicrosoftMangleContextImpl::mangleThreadSafeStaticGuardVariable(
3130     const VarDecl *VD, unsigned GuardNum, raw_ostream &Out) {
3131   msvc_hashing_ostream MHO(Out);
3132   MicrosoftCXXNameMangler Mangler(*this, MHO);
3133
3134   Mangler.getStream() << "?$TSS" << GuardNum << '@';
3135   Mangler.mangleNestedName(VD);
3136   Mangler.getStream() << "@4HA";
3137 }
3138
3139 void MicrosoftMangleContextImpl::mangleStaticGuardVariable(const VarDecl *VD,
3140                                                            raw_ostream &Out) {
3141   // <guard-name> ::= ?_B <postfix> @5 <scope-depth>
3142   //              ::= ?__J <postfix> @5 <scope-depth>
3143   //              ::= ?$S <guard-num> @ <postfix> @4IA
3144
3145   // The first mangling is what MSVC uses to guard static locals in inline
3146   // functions.  It uses a different mangling in external functions to support
3147   // guarding more than 32 variables.  MSVC rejects inline functions with more
3148   // than 32 static locals.  We don't fully implement the second mangling
3149   // because those guards are not externally visible, and instead use LLVM's
3150   // default renaming when creating a new guard variable.
3151   msvc_hashing_ostream MHO(Out);
3152   MicrosoftCXXNameMangler Mangler(*this, MHO);
3153
3154   bool Visible = VD->isExternallyVisible();
3155   if (Visible) {
3156     Mangler.getStream() << (VD->getTLSKind() ? "??__J" : "??_B");
3157   } else {
3158     Mangler.getStream() << "?$S1@";
3159   }
3160   unsigned ScopeDepth = 0;
3161   if (Visible && !getNextDiscriminator(VD, ScopeDepth))
3162     // If we do not have a discriminator and are emitting a guard variable for
3163     // use at global scope, then mangling the nested name will not be enough to
3164     // remove ambiguities.
3165     Mangler.mangle(VD, "");
3166   else
3167     Mangler.mangleNestedName(VD);
3168   Mangler.getStream() << (Visible ? "@5" : "@4IA");
3169   if (ScopeDepth)
3170     Mangler.mangleNumber(ScopeDepth);
3171 }
3172
3173 void MicrosoftMangleContextImpl::mangleInitFiniStub(const VarDecl *D,
3174                                                     char CharCode,
3175                                                     raw_ostream &Out) {
3176   msvc_hashing_ostream MHO(Out);
3177   MicrosoftCXXNameMangler Mangler(*this, MHO);
3178   Mangler.getStream() << "??__" << CharCode;
3179   Mangler.mangleName(D);
3180   if (D->isStaticDataMember()) {
3181     Mangler.mangleVariableEncoding(D);
3182     Mangler.getStream() << '@';
3183   }
3184   // This is the function class mangling.  These stubs are global, non-variadic,
3185   // cdecl functions that return void and take no args.
3186   Mangler.getStream() << "YAXXZ";
3187 }
3188
3189 void MicrosoftMangleContextImpl::mangleDynamicInitializer(const VarDecl *D,
3190                                                           raw_ostream &Out) {
3191   // <initializer-name> ::= ?__E <name> YAXXZ
3192   mangleInitFiniStub(D, 'E', Out);
3193 }
3194
3195 void
3196 MicrosoftMangleContextImpl::mangleDynamicAtExitDestructor(const VarDecl *D,
3197                                                           raw_ostream &Out) {
3198   // <destructor-name> ::= ?__F <name> YAXXZ
3199   mangleInitFiniStub(D, 'F', Out);
3200 }
3201
3202 void MicrosoftMangleContextImpl::mangleStringLiteral(const StringLiteral *SL,
3203                                                      raw_ostream &Out) {
3204   // <char-type> ::= 0   # char, char16_t, char32_t
3205   //                     # (little endian char data in mangling)
3206   //             ::= 1   # wchar_t (big endian char data in mangling)
3207   //
3208   // <literal-length> ::= <non-negative integer>  # the length of the literal
3209   //
3210   // <encoded-crc>    ::= <hex digit>+ @          # crc of the literal including
3211   //                                              # trailing null bytes
3212   //
3213   // <encoded-string> ::= <simple character>           # uninteresting character
3214   //                  ::= '?$' <hex digit> <hex digit> # these two nibbles
3215   //                                                   # encode the byte for the
3216   //                                                   # character
3217   //                  ::= '?' [a-z]                    # \xe1 - \xfa
3218   //                  ::= '?' [A-Z]                    # \xc1 - \xda
3219   //                  ::= '?' [0-9]                    # [,/\:. \n\t'-]
3220   //
3221   // <literal> ::= '??_C@_' <char-type> <literal-length> <encoded-crc>
3222   //               <encoded-string> '@'
3223   MicrosoftCXXNameMangler Mangler(*this, Out);
3224   Mangler.getStream() << "??_C@_";
3225
3226   // The actual string length might be different from that of the string literal
3227   // in cases like:
3228   // char foo[3] = "foobar";
3229   // char bar[42] = "foobar";
3230   // Where it is truncated or zero-padded to fit the array. This is the length
3231   // used for mangling, and any trailing null-bytes also need to be mangled.
3232   unsigned StringLength = getASTContext()
3233                               .getAsConstantArrayType(SL->getType())
3234                               ->getSize()
3235                               .getZExtValue();
3236   unsigned StringByteLength = StringLength * SL->getCharByteWidth();
3237
3238   // <char-type>: The "kind" of string literal is encoded into the mangled name.
3239   if (SL->isWide())
3240     Mangler.getStream() << '1';
3241   else
3242     Mangler.getStream() << '0';
3243
3244   // <literal-length>: The next part of the mangled name consists of the length
3245   // of the string in bytes.
3246   Mangler.mangleNumber(StringByteLength);
3247
3248   auto GetLittleEndianByte = [&SL](unsigned Index) {
3249     unsigned CharByteWidth = SL->getCharByteWidth();
3250     if (Index / CharByteWidth >= SL->getLength())
3251       return static_cast<char>(0);
3252     uint32_t CodeUnit = SL->getCodeUnit(Index / CharByteWidth);
3253     unsigned OffsetInCodeUnit = Index % CharByteWidth;
3254     return static_cast<char>((CodeUnit >> (8 * OffsetInCodeUnit)) & 0xff);
3255   };
3256
3257   auto GetBigEndianByte = [&SL](unsigned Index) {
3258     unsigned CharByteWidth = SL->getCharByteWidth();
3259     if (Index / CharByteWidth >= SL->getLength())
3260       return static_cast<char>(0);
3261     uint32_t CodeUnit = SL->getCodeUnit(Index / CharByteWidth);
3262     unsigned OffsetInCodeUnit = (CharByteWidth - 1) - (Index % CharByteWidth);
3263     return static_cast<char>((CodeUnit >> (8 * OffsetInCodeUnit)) & 0xff);
3264   };
3265
3266   // CRC all the bytes of the StringLiteral.
3267   llvm::JamCRC JC;
3268   for (unsigned I = 0, E = StringByteLength; I != E; ++I)
3269     JC.update(GetLittleEndianByte(I));
3270
3271   // <encoded-crc>: The CRC is encoded utilizing the standard number mangling
3272   // scheme.
3273   Mangler.mangleNumber(JC.getCRC());
3274
3275   // <encoded-string>: The mangled name also contains the first 32 bytes
3276   // (including null-terminator bytes) of the encoded StringLiteral.
3277   // Each character is encoded by splitting them into bytes and then encoding
3278   // the constituent bytes.
3279   auto MangleByte = [&Mangler](char Byte) {
3280     // There are five different manglings for characters:
3281     // - [a-zA-Z0-9_$]: A one-to-one mapping.
3282     // - ?[a-z]: The range from \xe1 to \xfa.
3283     // - ?[A-Z]: The range from \xc1 to \xda.
3284     // - ?[0-9]: The set of [,/\:. \n\t'-].
3285     // - ?$XX: A fallback which maps nibbles.
3286     if (isIdentifierBody(Byte, /*AllowDollar=*/true)) {
3287       Mangler.getStream() << Byte;
3288     } else if (isLetter(Byte & 0x7f)) {
3289       Mangler.getStream() << '?' << static_cast<char>(Byte & 0x7f);
3290     } else {
3291       const char SpecialChars[] = {',', '/',  '\\', ':',  '.',
3292                                    ' ', '\n', '\t', '\'', '-'};
3293       const char *Pos =
3294           std::find(std::begin(SpecialChars), std::end(SpecialChars), Byte);
3295       if (Pos != std::end(SpecialChars)) {
3296         Mangler.getStream() << '?' << (Pos - std::begin(SpecialChars));
3297       } else {
3298         Mangler.getStream() << "?$";
3299         Mangler.getStream() << static_cast<char>('A' + ((Byte >> 4) & 0xf));
3300         Mangler.getStream() << static_cast<char>('A' + (Byte & 0xf));
3301       }
3302     }
3303   };
3304
3305   // Enforce our 32 bytes max, except wchar_t which gets 32 chars instead.
3306   unsigned MaxBytesToMangle = SL->isWide() ? 64U : 32U;
3307   unsigned NumBytesToMangle = std::min(MaxBytesToMangle, StringByteLength);
3308   for (unsigned I = 0; I != NumBytesToMangle; ++I) {
3309     if (SL->isWide())
3310       MangleByte(GetBigEndianByte(I));
3311     else
3312       MangleByte(GetLittleEndianByte(I));
3313   }
3314
3315   Mangler.getStream() << '@';
3316 }
3317
3318 MicrosoftMangleContext *
3319 MicrosoftMangleContext::create(ASTContext &Context, DiagnosticsEngine &Diags) {
3320   return new MicrosoftMangleContextImpl(Context, Diags);
3321 }