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