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