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