1 //===--- MicrosoftMangle.cpp - Microsoft Visual C++ Name Mangling ---------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This provides C++ name mangling targeting the Microsoft Visual C++ ABI.
12 //===----------------------------------------------------------------------===//
14 #include "clang/AST/Mangle.h"
15 #include "clang/AST/ASTContext.h"
16 #include "clang/AST/CharUnits.h"
17 #include "clang/AST/Decl.h"
18 #include "clang/AST/DeclCXX.h"
19 #include "clang/AST/DeclObjC.h"
20 #include "clang/AST/DeclTemplate.h"
21 #include "clang/AST/ExprCXX.h"
22 #include "clang/Basic/ABI.h"
24 using namespace clang;
28 /// MicrosoftCXXNameMangler - Manage the mangling of a single name for the
29 /// Microsoft Visual C++ ABI.
30 class MicrosoftCXXNameMangler {
31 MangleContext &Context;
34 ASTContext &getASTContext() const { return Context.getASTContext(); }
37 MicrosoftCXXNameMangler(MangleContext &C, raw_ostream &Out_)
38 : Context(C), Out(Out_) { }
40 void mangle(const NamedDecl *D, StringRef Prefix = "?");
41 void mangleName(const NamedDecl *ND);
42 void mangleFunctionEncoding(const FunctionDecl *FD);
43 void mangleVariableEncoding(const VarDecl *VD);
44 void mangleNumber(int64_t Number);
45 void mangleType(QualType T);
48 void mangleUnqualifiedName(const NamedDecl *ND) {
49 mangleUnqualifiedName(ND, ND->getDeclName());
51 void mangleUnqualifiedName(const NamedDecl *ND, DeclarationName Name);
52 void mangleSourceName(const IdentifierInfo *II);
53 void manglePostfix(const DeclContext *DC, bool NoFunction=false);
54 void mangleOperatorName(OverloadedOperatorKind OO);
55 void mangleQualifiers(Qualifiers Quals, bool IsMember);
57 void mangleObjCMethodName(const ObjCMethodDecl *MD);
59 // Declare manglers for every type class.
60 #define ABSTRACT_TYPE(CLASS, PARENT)
61 #define NON_CANONICAL_TYPE(CLASS, PARENT)
62 #define TYPE(CLASS, PARENT) void mangleType(const CLASS##Type *T);
63 #include "clang/AST/TypeNodes.def"
65 void mangleType(const TagType*);
66 void mangleType(const FunctionType *T, const FunctionDecl *D,
67 bool IsStructor, bool IsInstMethod);
68 void mangleType(const ArrayType *T, bool IsGlobal);
69 void mangleExtraDimensions(QualType T);
70 void mangleFunctionClass(const FunctionDecl *FD);
71 void mangleCallingConvention(const FunctionType *T, bool IsInstMethod = false);
72 void mangleThrowSpecification(const FunctionProtoType *T);
76 /// MicrosoftMangleContext - Overrides the default MangleContext for the
77 /// Microsoft Visual C++ ABI.
78 class MicrosoftMangleContext : public MangleContext {
80 MicrosoftMangleContext(ASTContext &Context,
81 DiagnosticsEngine &Diags) : MangleContext(Context, Diags) { }
82 virtual bool shouldMangleDeclName(const NamedDecl *D);
83 virtual void mangleName(const NamedDecl *D, raw_ostream &Out);
84 virtual void mangleThunk(const CXXMethodDecl *MD,
85 const ThunkInfo &Thunk,
87 virtual void mangleCXXDtorThunk(const CXXDestructorDecl *DD, CXXDtorType Type,
88 const ThisAdjustment &ThisAdjustment,
90 virtual void mangleCXXVTable(const CXXRecordDecl *RD,
92 virtual void mangleCXXVTT(const CXXRecordDecl *RD,
94 virtual void mangleCXXCtorVTable(const CXXRecordDecl *RD, int64_t Offset,
95 const CXXRecordDecl *Type,
97 virtual void mangleCXXRTTI(QualType T, raw_ostream &);
98 virtual void mangleCXXRTTIName(QualType T, raw_ostream &);
99 virtual void mangleCXXCtor(const CXXConstructorDecl *D, CXXCtorType Type,
101 virtual void mangleCXXDtor(const CXXDestructorDecl *D, CXXDtorType Type,
103 virtual void mangleReferenceTemporary(const clang::VarDecl *,
109 static bool isInCLinkageSpecification(const Decl *D) {
110 D = D->getCanonicalDecl();
111 for (const DeclContext *DC = D->getDeclContext();
112 !DC->isTranslationUnit(); DC = DC->getParent()) {
113 if (const LinkageSpecDecl *Linkage = dyn_cast<LinkageSpecDecl>(DC))
114 return Linkage->getLanguage() == LinkageSpecDecl::lang_c;
120 bool MicrosoftMangleContext::shouldMangleDeclName(const NamedDecl *D) {
121 // In C, functions with no attributes never need to be mangled. Fastpath them.
122 if (!getASTContext().getLangOptions().CPlusPlus && !D->hasAttrs())
125 // Any decl can be declared with __asm("foo") on it, and this takes precedence
126 // over all other naming in the .o file.
127 if (D->hasAttr<AsmLabelAttr>())
130 // Clang's "overloadable" attribute extension to C/C++ implies name mangling
131 // (always) as does passing a C++ member function and a function
132 // whose name is not a simple identifier.
133 const FunctionDecl *FD = dyn_cast<FunctionDecl>(D);
134 if (FD && (FD->hasAttr<OverloadableAttr>() || isa<CXXMethodDecl>(FD) ||
135 !FD->getDeclName().isIdentifier()))
138 // Otherwise, no mangling is done outside C++ mode.
139 if (!getASTContext().getLangOptions().CPlusPlus)
142 // Variables at global scope with internal linkage are not mangled.
144 const DeclContext *DC = D->getDeclContext();
145 if (DC->isTranslationUnit() && D->getLinkage() == InternalLinkage)
149 // C functions and "main" are not mangled.
150 if ((FD && FD->isMain()) || isInCLinkageSpecification(D))
156 void MicrosoftCXXNameMangler::mangle(const NamedDecl *D,
158 // MSVC doesn't mangle C++ names the same way it mangles extern "C" names.
159 // Therefore it's really important that we don't decorate the
160 // name with leading underscores or leading/trailing at signs. So, emit a
161 // asm marker at the start so we get the name right.
162 Out << '\01'; // LLVM IR Marker for __asm("foo")
164 // Any decl can be declared with __asm("foo") on it, and this takes precedence
165 // over all other naming in the .o file.
166 if (const AsmLabelAttr *ALA = D->getAttr<AsmLabelAttr>()) {
167 // If we have an asm name, then we use it as the mangling.
168 Out << ALA->getLabel();
172 // <mangled-name> ::= ? <name> <type-encoding>
175 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
176 mangleFunctionEncoding(FD);
177 else if (const VarDecl *VD = dyn_cast<VarDecl>(D))
178 mangleVariableEncoding(VD);
179 // TODO: Fields? Can MSVC even mangle them?
182 void MicrosoftCXXNameMangler::mangleFunctionEncoding(const FunctionDecl *FD) {
183 // <type-encoding> ::= <function-class> <function-type>
185 // Don't mangle in the type if this isn't a decl we should typically mangle.
186 if (!Context.shouldMangleDeclName(FD))
189 // We should never ever see a FunctionNoProtoType at this point.
190 // We don't even know how to mangle their types anyway :).
191 const FunctionProtoType *FT = cast<FunctionProtoType>(FD->getType());
193 bool InStructor = false, InInstMethod = false;
194 const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD);
196 if (MD->isInstance())
198 if (isa<CXXConstructorDecl>(MD) || isa<CXXDestructorDecl>(MD))
202 // First, the function class.
203 mangleFunctionClass(FD);
205 mangleType(FT, FD, InStructor, InInstMethod);
208 void MicrosoftCXXNameMangler::mangleVariableEncoding(const VarDecl *VD) {
209 // <type-encoding> ::= <storage-class> <variable-type>
210 // <storage-class> ::= 0 # private static member
211 // ::= 1 # protected static member
212 // ::= 2 # public static member
214 // ::= 4 # static local
216 // The first character in the encoding (after the name) is the storage class.
217 if (VD->isStaticDataMember()) {
218 // If it's a static member, it also encodes the access level.
219 switch (VD->getAccess()) {
221 case AS_private: Out << '0'; break;
222 case AS_protected: Out << '1'; break;
223 case AS_public: Out << '2'; break;
226 else if (!VD->isStaticLocal())
230 // Now mangle the type.
231 // <variable-type> ::= <type> <cvr-qualifiers>
232 // ::= <type> A # pointers, references, arrays
233 // Pointers and references are odd. The type of 'int * const foo;' gets
234 // mangled as 'QAHA' instead of 'PAHB', for example.
235 QualType Ty = VD->getType();
236 if (Ty->isPointerType() || Ty->isReferenceType()) {
239 } else if (Ty->isArrayType()) {
240 // Global arrays are funny, too.
241 mangleType(cast<ArrayType>(Ty.getTypePtr()), true);
244 mangleType(Ty.getLocalUnqualifiedType());
245 mangleQualifiers(Ty.getLocalQualifiers(), false);
249 void MicrosoftCXXNameMangler::mangleName(const NamedDecl *ND) {
250 // <name> ::= <unscoped-name> {[<named-scope>]+ | [<nested-name>]}? @
251 const DeclContext *DC = ND->getDeclContext();
253 // Always start with the unqualified name.
254 mangleUnqualifiedName(ND);
256 // If this is an extern variable declared locally, the relevant DeclContext
257 // is that of the containing namespace, or the translation unit.
258 if (isa<FunctionDecl>(DC) && ND->hasLinkage())
259 while (!DC->isNamespace() && !DC->isTranslationUnit())
260 DC = DC->getParent();
264 // Terminate the whole name with an '@'.
268 void MicrosoftCXXNameMangler::mangleNumber(int64_t Number) {
269 // <number> ::= [?] <decimal digit> # <= 9
270 // ::= [?] <hex digit>+ @ # > 9; A = 0, B = 1, etc...
275 if (Number >= 1 && Number <= 10) {
278 // We have to build up the encoding in reverse order, so it will come
279 // out right when we write it out.
281 char *EndPtr = Encoding+sizeof(Encoding);
282 char *CurPtr = EndPtr;
284 *--CurPtr = 'A' + (Number % 16);
287 Out.write(CurPtr, EndPtr-CurPtr);
293 MicrosoftCXXNameMangler::mangleUnqualifiedName(const NamedDecl *ND,
294 DeclarationName Name) {
295 // <unqualified-name> ::= <operator-name>
296 // ::= <ctor-dtor-name>
298 switch (Name.getNameKind()) {
299 case DeclarationName::Identifier: {
300 if (const IdentifierInfo *II = Name.getAsIdentifierInfo()) {
301 mangleSourceName(II);
305 // Otherwise, an anonymous entity. We must have a declaration.
306 assert(ND && "mangling empty name without declaration");
308 if (const NamespaceDecl *NS = dyn_cast<NamespaceDecl>(ND)) {
309 if (NS->isAnonymousNamespace()) {
315 // We must have an anonymous struct.
316 const TagDecl *TD = cast<TagDecl>(ND);
317 if (const TypedefNameDecl *D = TD->getTypedefNameForAnonDecl()) {
318 assert(TD->getDeclContext() == D->getDeclContext() &&
319 "Typedef should not be in another decl context!");
320 assert(D->getDeclName().getAsIdentifierInfo() &&
321 "Typedef was not named!");
322 mangleSourceName(D->getDeclName().getAsIdentifierInfo());
326 // When VC encounters an anonymous type with no tag and no typedef,
327 // it literally emits '<unnamed-tag>'.
328 Out << "<unnamed-tag>";
332 case DeclarationName::ObjCZeroArgSelector:
333 case DeclarationName::ObjCOneArgSelector:
334 case DeclarationName::ObjCMultiArgSelector:
335 llvm_unreachable("Can't mangle Objective-C selector names here!");
337 case DeclarationName::CXXConstructorName:
338 llvm_unreachable("Can't mangle constructors yet!");
340 case DeclarationName::CXXDestructorName:
341 llvm_unreachable("Can't mangle destructors yet!");
343 case DeclarationName::CXXConversionFunctionName:
344 // <operator-name> ::= ?B # (cast)
345 // The target type is encoded as the return type.
349 case DeclarationName::CXXOperatorName:
350 mangleOperatorName(Name.getCXXOverloadedOperator());
353 case DeclarationName::CXXLiteralOperatorName:
354 // FIXME: Was this added in VS2010? Does MS even know how to mangle this?
355 llvm_unreachable("Don't know how to mangle literal operators yet!");
357 case DeclarationName::CXXUsingDirective:
358 llvm_unreachable("Can't mangle a using directive name!");
362 void MicrosoftCXXNameMangler::manglePostfix(const DeclContext *DC,
364 // <postfix> ::= <unqualified-name> [<postfix>]
365 // ::= <template-postfix> <template-args> [<postfix>]
366 // ::= <template-param>
367 // ::= <substitution> [<postfix>]
371 while (isa<LinkageSpecDecl>(DC))
372 DC = DC->getParent();
374 if (DC->isTranslationUnit())
377 if (const BlockDecl *BD = dyn_cast<BlockDecl>(DC)) {
378 Context.mangleBlock(BD, Out);
380 return manglePostfix(DC->getParent(), NoFunction);
383 if (NoFunction && (isa<FunctionDecl>(DC) || isa<ObjCMethodDecl>(DC)))
385 else if (const ObjCMethodDecl *Method = dyn_cast<ObjCMethodDecl>(DC))
386 mangleObjCMethodName(Method);
388 mangleUnqualifiedName(cast<NamedDecl>(DC));
389 manglePostfix(DC->getParent(), NoFunction);
393 void MicrosoftCXXNameMangler::mangleOperatorName(OverloadedOperatorKind OO) {
397 // <operator-name> ::= ?2 # new
398 case OO_New: Out << "?2"; break;
399 // <operator-name> ::= ?3 # delete
400 case OO_Delete: Out << "?3"; break;
401 // <operator-name> ::= ?4 # =
402 case OO_Equal: Out << "?4"; break;
403 // <operator-name> ::= ?5 # >>
404 case OO_GreaterGreater: Out << "?5"; break;
405 // <operator-name> ::= ?6 # <<
406 case OO_LessLess: Out << "?6"; break;
407 // <operator-name> ::= ?7 # !
408 case OO_Exclaim: Out << "?7"; break;
409 // <operator-name> ::= ?8 # ==
410 case OO_EqualEqual: Out << "?8"; break;
411 // <operator-name> ::= ?9 # !=
412 case OO_ExclaimEqual: Out << "?9"; break;
413 // <operator-name> ::= ?A # []
414 case OO_Subscript: Out << "?A"; break;
416 // <operator-name> ::= ?C # ->
417 case OO_Arrow: Out << "?C"; break;
418 // <operator-name> ::= ?D # *
419 case OO_Star: Out << "?D"; break;
420 // <operator-name> ::= ?E # ++
421 case OO_PlusPlus: Out << "?E"; break;
422 // <operator-name> ::= ?F # --
423 case OO_MinusMinus: Out << "?F"; break;
424 // <operator-name> ::= ?G # -
425 case OO_Minus: Out << "?G"; break;
426 // <operator-name> ::= ?H # +
427 case OO_Plus: Out << "?H"; break;
428 // <operator-name> ::= ?I # &
429 case OO_Amp: Out << "?I"; break;
430 // <operator-name> ::= ?J # ->*
431 case OO_ArrowStar: Out << "?J"; break;
432 // <operator-name> ::= ?K # /
433 case OO_Slash: Out << "?K"; break;
434 // <operator-name> ::= ?L # %
435 case OO_Percent: Out << "?L"; break;
436 // <operator-name> ::= ?M # <
437 case OO_Less: Out << "?M"; break;
438 // <operator-name> ::= ?N # <=
439 case OO_LessEqual: Out << "?N"; break;
440 // <operator-name> ::= ?O # >
441 case OO_Greater: Out << "?O"; break;
442 // <operator-name> ::= ?P # >=
443 case OO_GreaterEqual: Out << "?P"; break;
444 // <operator-name> ::= ?Q # ,
445 case OO_Comma: Out << "?Q"; break;
446 // <operator-name> ::= ?R # ()
447 case OO_Call: Out << "?R"; break;
448 // <operator-name> ::= ?S # ~
449 case OO_Tilde: Out << "?S"; break;
450 // <operator-name> ::= ?T # ^
451 case OO_Caret: Out << "?T"; break;
452 // <operator-name> ::= ?U # |
453 case OO_Pipe: Out << "?U"; break;
454 // <operator-name> ::= ?V # &&
455 case OO_AmpAmp: Out << "?V"; break;
456 // <operator-name> ::= ?W # ||
457 case OO_PipePipe: Out << "?W"; break;
458 // <operator-name> ::= ?X # *=
459 case OO_StarEqual: Out << "?X"; break;
460 // <operator-name> ::= ?Y # +=
461 case OO_PlusEqual: Out << "?Y"; break;
462 // <operator-name> ::= ?Z # -=
463 case OO_MinusEqual: Out << "?Z"; break;
464 // <operator-name> ::= ?_0 # /=
465 case OO_SlashEqual: Out << "?_0"; break;
466 // <operator-name> ::= ?_1 # %=
467 case OO_PercentEqual: Out << "?_1"; break;
468 // <operator-name> ::= ?_2 # >>=
469 case OO_GreaterGreaterEqual: Out << "?_2"; break;
470 // <operator-name> ::= ?_3 # <<=
471 case OO_LessLessEqual: Out << "?_3"; break;
472 // <operator-name> ::= ?_4 # &=
473 case OO_AmpEqual: Out << "?_4"; break;
474 // <operator-name> ::= ?_5 # |=
475 case OO_PipeEqual: Out << "?_5"; break;
476 // <operator-name> ::= ?_6 # ^=
477 case OO_CaretEqual: Out << "?_6"; break;
482 // ?_B # local static guard
484 // ?_D # vbase destructor
485 // ?_E # vector deleting destructor
486 // ?_F # default constructor closure
487 // ?_G # scalar deleting destructor
488 // ?_H # vector constructor iterator
489 // ?_I # vector destructor iterator
490 // ?_J # vector vbase constructor iterator
491 // ?_K # virtual displacement map
492 // ?_L # eh vector constructor iterator
493 // ?_M # eh vector destructor iterator
494 // ?_N # eh vector vbase constructor iterator
495 // ?_O # copy constructor closure
496 // ?_P<name> # udt returning <name>
498 // ?_R0 # RTTI Type Descriptor
499 // ?_R1 # RTTI Base Class Descriptor at (a,b,c,d)
500 // ?_R2 # RTTI Base Class Array
501 // ?_R3 # RTTI Class Hierarchy Descriptor
502 // ?_R4 # RTTI Complete Object Locator
503 // ?_S # local vftable
504 // ?_T # local vftable constructor closure
505 // <operator-name> ::= ?_U # new[]
506 case OO_Array_New: Out << "?_U"; break;
507 // <operator-name> ::= ?_V # delete[]
508 case OO_Array_Delete: Out << "?_V"; break;
511 llvm_unreachable("Don't know how to mangle ?:");
514 case NUM_OVERLOADED_OPERATORS:
515 llvm_unreachable("Not an overloaded operator");
519 void MicrosoftCXXNameMangler::mangleSourceName(const IdentifierInfo *II) {
520 // <source name> ::= <identifier> @
521 Out << II->getName() << '@';
524 void MicrosoftCXXNameMangler::mangleObjCMethodName(const ObjCMethodDecl *MD) {
525 Context.mangleObjCMethodName(MD, Out);
528 void MicrosoftCXXNameMangler::mangleQualifiers(Qualifiers Quals,
530 // <cvr-qualifiers> ::= [E] [F] [I] <base-cvr-qualifiers>
531 // 'E' means __ptr64 (32-bit only); 'F' means __unaligned (32/64-bit only);
532 // 'I' means __restrict (32/64-bit).
533 // Note that the MSVC __restrict keyword isn't the same as the C99 restrict
535 // <base-cvr-qualifiers> ::= A # near
536 // ::= B # near const
537 // ::= C # near volatile
538 // ::= D # near const volatile
539 // ::= E # far (16-bit)
540 // ::= F # far const (16-bit)
541 // ::= G # far volatile (16-bit)
542 // ::= H # far const volatile (16-bit)
543 // ::= I # huge (16-bit)
544 // ::= J # huge const (16-bit)
545 // ::= K # huge volatile (16-bit)
546 // ::= L # huge const volatile (16-bit)
547 // ::= M <basis> # based
548 // ::= N <basis> # based const
549 // ::= O <basis> # based volatile
550 // ::= P <basis> # based const volatile
551 // ::= Q # near member
552 // ::= R # near const member
553 // ::= S # near volatile member
554 // ::= T # near const volatile member
555 // ::= U # far member (16-bit)
556 // ::= V # far const member (16-bit)
557 // ::= W # far volatile member (16-bit)
558 // ::= X # far const volatile member (16-bit)
559 // ::= Y # huge member (16-bit)
560 // ::= Z # huge const member (16-bit)
561 // ::= 0 # huge volatile member (16-bit)
562 // ::= 1 # huge const volatile member (16-bit)
563 // ::= 2 <basis> # based member
564 // ::= 3 <basis> # based const member
565 // ::= 4 <basis> # based volatile member
566 // ::= 5 <basis> # based const volatile member
567 // ::= 6 # near function (pointers only)
568 // ::= 7 # far function (pointers only)
569 // ::= 8 # near method (pointers only)
570 // ::= 9 # far method (pointers only)
571 // ::= _A <basis> # based function (pointers only)
572 // ::= _B <basis> # based function (far?) (pointers only)
573 // ::= _C <basis> # based method (pointers only)
574 // ::= _D <basis> # based method (far?) (pointers only)
575 // ::= _E # block (Clang)
576 // <basis> ::= 0 # __based(void)
577 // ::= 1 # __based(segment)?
578 // ::= 2 <name> # __based(name)
581 // ::= 5 # not really based
583 if (!Quals.hasVolatile()) {
584 if (!Quals.hasConst())
589 if (!Quals.hasConst())
595 if (!Quals.hasVolatile()) {
596 if (!Quals.hasConst())
601 if (!Quals.hasConst())
608 // FIXME: For now, just drop all extension qualifiers on the floor.
611 void MicrosoftCXXNameMangler::mangleType(QualType T) {
612 // Only operate on the canonical type!
613 T = getASTContext().getCanonicalType(T);
615 Qualifiers Quals = T.getLocalQualifiers();
617 // We have to mangle these now, while we still have enough information.
618 // <pointer-cvr-qualifiers> ::= P # pointer
619 // ::= Q # const pointer
620 // ::= R # volatile pointer
621 // ::= S # const volatile pointer
622 if (T->isAnyPointerType() || T->isMemberPointerType() ||
623 T->isBlockPointerType()) {
624 if (!Quals.hasVolatile())
627 if (!Quals.hasConst())
633 // Just emit qualifiers like normal.
634 // NB: When we mangle a pointer/reference type, and the pointee
635 // type has no qualifiers, the lack of qualifier gets mangled
637 mangleQualifiers(Quals, false);
638 } else if (T->isAnyPointerType() || T->isMemberPointerType() ||
639 T->isBlockPointerType()) {
642 switch (T->getTypeClass()) {
643 #define ABSTRACT_TYPE(CLASS, PARENT)
644 #define NON_CANONICAL_TYPE(CLASS, PARENT) \
646 llvm_unreachable("can't mangle non-canonical type " #CLASS "Type"); \
648 #define TYPE(CLASS, PARENT) \
650 mangleType(static_cast<const CLASS##Type*>(T.getTypePtr())); \
652 #include "clang/AST/TypeNodes.def"
656 void MicrosoftCXXNameMangler::mangleType(const BuiltinType *T) {
657 // <type> ::= <builtin-type>
658 // <builtin-type> ::= X # void
659 // ::= C # signed char
661 // ::= E # unsigned char
663 // ::= G # unsigned short (or wchar_t if it's not a builtin)
665 // ::= I # unsigned int
667 // ::= K # unsigned long
671 // ::= O # long double (__float80 is mangled differently)
672 // ::= _J # long long, __int64
673 // ::= _K # unsigned long long, __int64
675 // ::= _M # unsigned __int128
677 // _O # <array in parameter>
678 // ::= _T # __float80 (Intel)
680 // ::= _Z # __float80 (Digital Mars)
681 switch (T->getKind()) {
682 case BuiltinType::Void: Out << 'X'; break;
683 case BuiltinType::SChar: Out << 'C'; break;
684 case BuiltinType::Char_U: case BuiltinType::Char_S: Out << 'D'; break;
685 case BuiltinType::UChar: Out << 'E'; break;
686 case BuiltinType::Short: Out << 'F'; break;
687 case BuiltinType::UShort: Out << 'G'; break;
688 case BuiltinType::Int: Out << 'H'; break;
689 case BuiltinType::UInt: Out << 'I'; break;
690 case BuiltinType::Long: Out << 'J'; break;
691 case BuiltinType::ULong: Out << 'K'; break;
692 case BuiltinType::Float: Out << 'M'; break;
693 case BuiltinType::Double: Out << 'N'; break;
694 // TODO: Determine size and mangle accordingly
695 case BuiltinType::LongDouble: Out << 'O'; break;
696 case BuiltinType::LongLong: Out << "_J"; break;
697 case BuiltinType::ULongLong: Out << "_K"; break;
698 case BuiltinType::Int128: Out << "_L"; break;
699 case BuiltinType::UInt128: Out << "_M"; break;
700 case BuiltinType::Bool: Out << "_N"; break;
701 case BuiltinType::WChar_S:
702 case BuiltinType::WChar_U: Out << "_W"; break;
704 case BuiltinType::Overload:
705 case BuiltinType::Dependent:
706 case BuiltinType::UnknownAny:
707 case BuiltinType::BoundMember:
709 "Overloaded and dependent types shouldn't get to name mangling");
710 case BuiltinType::ObjCId: Out << "PAUobjc_object@@"; break;
711 case BuiltinType::ObjCClass: Out << "PAUobjc_class@@"; break;
712 case BuiltinType::ObjCSel: Out << "PAUobjc_selector@@"; break;
714 case BuiltinType::Char16:
715 case BuiltinType::Char32:
716 case BuiltinType::Half:
717 case BuiltinType::NullPtr:
718 llvm_unreachable("Don't know how to mangle this type");
722 // <type> ::= <function-type>
723 void MicrosoftCXXNameMangler::mangleType(const FunctionProtoType *T) {
724 // Structors only appear in decls, so at this point we know it's not a
726 // I'll probably have mangleType(MemberPointerType) call the mangleType()
728 mangleType(T, NULL, false, false);
730 void MicrosoftCXXNameMangler::mangleType(const FunctionNoProtoType *T) {
731 llvm_unreachable("Can't mangle K&R function prototypes");
734 void MicrosoftCXXNameMangler::mangleType(const FunctionType *T,
735 const FunctionDecl *D,
738 // <function-type> ::= <this-cvr-qualifiers> <calling-convention>
739 // <return-type> <argument-list> <throw-spec>
740 const FunctionProtoType *Proto = cast<FunctionProtoType>(T);
742 // If this is a C++ instance method, mangle the CVR qualifiers for the
745 mangleQualifiers(Qualifiers::fromCVRMask(Proto->getTypeQuals()), false);
747 mangleCallingConvention(T, IsInstMethod);
749 // <return-type> ::= <type>
750 // ::= @ # structors (they have no declared return type)
754 mangleType(Proto->getResultType());
756 // <argument-list> ::= X # void
758 // ::= <type>* Z # varargs
759 if (Proto->getNumArgs() == 0 && !Proto->isVariadic()) {
763 // If we got a decl, use the "types-as-written" to make sure arrays
764 // get mangled right.
765 for (FunctionDecl::param_const_iterator Parm = D->param_begin(),
766 ParmEnd = D->param_end();
767 Parm != ParmEnd; ++Parm)
768 mangleType((*Parm)->getTypeSourceInfo()->getType());
770 for (FunctionProtoType::arg_type_iterator Arg = Proto->arg_type_begin(),
771 ArgEnd = Proto->arg_type_end();
772 Arg != ArgEnd; ++Arg)
775 // <builtin-type> ::= Z # ellipsis
776 if (Proto->isVariadic())
782 mangleThrowSpecification(Proto);
785 void MicrosoftCXXNameMangler::mangleFunctionClass(const FunctionDecl *FD) {
786 // <function-class> ::= A # private: near
787 // ::= B # private: far
788 // ::= C # private: static near
789 // ::= D # private: static far
790 // ::= E # private: virtual near
791 // ::= F # private: virtual far
792 // ::= G # private: thunk near
793 // ::= H # private: thunk far
794 // ::= I # protected: near
795 // ::= J # protected: far
796 // ::= K # protected: static near
797 // ::= L # protected: static far
798 // ::= M # protected: virtual near
799 // ::= N # protected: virtual far
800 // ::= O # protected: thunk near
801 // ::= P # protected: thunk far
802 // ::= Q # public: near
803 // ::= R # public: far
804 // ::= S # public: static near
805 // ::= T # public: static far
806 // ::= U # public: virtual near
807 // ::= V # public: virtual far
808 // ::= W # public: thunk near
809 // ::= X # public: thunk far
810 // ::= Y # global near
811 // ::= Z # global far
812 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD)) {
813 switch (MD->getAccess()) {
818 else if (MD->isVirtual())
826 else if (MD->isVirtual())
834 else if (MD->isVirtual())
842 void MicrosoftCXXNameMangler::mangleCallingConvention(const FunctionType *T,
844 // <calling-convention> ::= A # __cdecl
845 // ::= B # __export __cdecl
847 // ::= D # __export __pascal
848 // ::= E # __thiscall
849 // ::= F # __export __thiscall
851 // ::= H # __export __stdcall
852 // ::= I # __fastcall
853 // ::= J # __export __fastcall
854 // The 'export' calling conventions are from a bygone era
855 // (*cough*Win16*cough*) when functions were declared for export with
856 // that keyword. (It didn't actually export them, it just made them so
857 // that they could be in a DLL and somebody from another module could call
859 CallingConv CC = T->getCallConv();
860 if (CC == CC_Default)
861 CC = IsInstMethod ? getASTContext().getDefaultMethodCallConv() : CC_C;
864 llvm_unreachable("Unsupported CC for mangling");
866 case CC_C: Out << 'A'; break;
867 case CC_X86Pascal: Out << 'C'; break;
868 case CC_X86ThisCall: Out << 'E'; break;
869 case CC_X86StdCall: Out << 'G'; break;
870 case CC_X86FastCall: Out << 'I'; break;
873 void MicrosoftCXXNameMangler::mangleThrowSpecification(
874 const FunctionProtoType *FT) {
875 // <throw-spec> ::= Z # throw(...) (default)
876 // ::= @ # throw() or __declspec/__attribute__((nothrow))
878 // NOTE: Since the Microsoft compiler ignores throw specifications, they are
879 // all actually mangled as 'Z'. (They're ignored because their associated
880 // functionality isn't implemented, and probably never will be.)
884 void MicrosoftCXXNameMangler::mangleType(const UnresolvedUsingType *T) {
885 llvm_unreachable("Don't know how to mangle UnresolvedUsingTypes yet!");
888 // <type> ::= <union-type> | <struct-type> | <class-type> | <enum-type>
889 // <union-type> ::= T <name>
890 // <struct-type> ::= U <name>
891 // <class-type> ::= V <name>
892 // <enum-type> ::= W <size> <name>
893 void MicrosoftCXXNameMangler::mangleType(const EnumType *T) {
894 mangleType(static_cast<const TagType*>(T));
896 void MicrosoftCXXNameMangler::mangleType(const RecordType *T) {
897 mangleType(static_cast<const TagType*>(T));
899 void MicrosoftCXXNameMangler::mangleType(const TagType *T) {
900 switch (T->getDecl()->getTagKind()) {
912 Out << getASTContext().getTypeSizeInChars(
913 cast<EnumDecl>(T->getDecl())->getIntegerType()).getQuantity();
916 mangleName(T->getDecl());
919 // <type> ::= <array-type>
920 // <array-type> ::= P <cvr-qualifiers> [Y <dimension-count> <dimension>+]
921 // <element-type> # as global
922 // ::= Q <cvr-qualifiers> [Y <dimension-count> <dimension>+]
923 // <element-type> # as param
924 // It's supposed to be the other way around, but for some strange reason, it
925 // isn't. Today this behavior is retained for the sole purpose of backwards
927 void MicrosoftCXXNameMangler::mangleType(const ArrayType *T, bool IsGlobal) {
928 // This isn't a recursive mangling, so now we have to do it all in this
934 mangleExtraDimensions(T->getElementType());
936 void MicrosoftCXXNameMangler::mangleType(const ConstantArrayType *T) {
937 mangleType(static_cast<const ArrayType *>(T), false);
939 void MicrosoftCXXNameMangler::mangleType(const VariableArrayType *T) {
940 mangleType(static_cast<const ArrayType *>(T), false);
942 void MicrosoftCXXNameMangler::mangleType(const DependentSizedArrayType *T) {
943 mangleType(static_cast<const ArrayType *>(T), false);
945 void MicrosoftCXXNameMangler::mangleType(const IncompleteArrayType *T) {
946 mangleType(static_cast<const ArrayType *>(T), false);
948 void MicrosoftCXXNameMangler::mangleExtraDimensions(QualType ElementTy) {
949 SmallVector<llvm::APInt, 3> Dimensions;
951 if (ElementTy->isConstantArrayType()) {
952 const ConstantArrayType *CAT =
953 static_cast<const ConstantArrayType *>(ElementTy.getTypePtr());
954 Dimensions.push_back(CAT->getSize());
955 ElementTy = CAT->getElementType();
956 } else if (ElementTy->isVariableArrayType()) {
957 llvm_unreachable("Don't know how to mangle VLAs!");
958 } else if (ElementTy->isDependentSizedArrayType()) {
959 // The dependent expression has to be folded into a constant (TODO).
960 llvm_unreachable("Don't know how to mangle dependent-sized arrays!");
961 } else if (ElementTy->isIncompleteArrayType()) continue;
964 mangleQualifiers(ElementTy.getQualifiers(), false);
965 // If there are any additional dimensions, mangle them now.
966 if (Dimensions.size() > 0) {
968 // <dimension-count> ::= <number> # number of extra dimensions
969 mangleNumber(Dimensions.size());
970 for (unsigned Dim = 0; Dim < Dimensions.size(); ++Dim) {
971 mangleNumber(Dimensions[Dim].getLimitedValue());
974 mangleType(ElementTy.getLocalUnqualifiedType());
977 // <type> ::= <pointer-to-member-type>
978 // <pointer-to-member-type> ::= <pointer-cvr-qualifiers> <cvr-qualifiers>
979 // <class name> <type>
980 void MicrosoftCXXNameMangler::mangleType(const MemberPointerType *T) {
981 QualType PointeeType = T->getPointeeType();
982 if (const FunctionProtoType *FPT = dyn_cast<FunctionProtoType>(PointeeType)) {
984 mangleName(cast<RecordType>(T->getClass())->getDecl());
985 mangleType(FPT, NULL, false, true);
987 mangleQualifiers(PointeeType.getQualifiers(), true);
988 mangleName(cast<RecordType>(T->getClass())->getDecl());
989 mangleType(PointeeType.getLocalUnqualifiedType());
993 void MicrosoftCXXNameMangler::mangleType(const TemplateTypeParmType *T) {
994 llvm_unreachable("Don't know how to mangle TemplateTypeParmTypes yet!");
997 void MicrosoftCXXNameMangler::mangleType(
998 const SubstTemplateTypeParmPackType *T) {
1000 "Don't know how to mangle SubstTemplateTypeParmPackTypes yet!");
1003 // <type> ::= <pointer-type>
1004 // <pointer-type> ::= <pointer-cvr-qualifiers> <cvr-qualifiers> <type>
1005 void MicrosoftCXXNameMangler::mangleType(const PointerType *T) {
1006 QualType PointeeTy = T->getPointeeType();
1007 if (PointeeTy->isArrayType()) {
1008 // Pointers to arrays are mangled like arrays.
1009 mangleExtraDimensions(T->getPointeeType());
1010 } else if (PointeeTy->isFunctionType()) {
1011 // Function pointers are special.
1013 mangleType(static_cast<const FunctionType *>(PointeeTy.getTypePtr()),
1014 NULL, false, false);
1016 if (!PointeeTy.hasQualifiers())
1017 // Lack of qualifiers is mangled as 'A'.
1019 mangleType(PointeeTy);
1022 void MicrosoftCXXNameMangler::mangleType(const ObjCObjectPointerType *T) {
1023 // Object pointers never have qualifiers.
1025 mangleType(T->getPointeeType());
1028 // <type> ::= <reference-type>
1029 // <reference-type> ::= A <cvr-qualifiers> <type>
1030 void MicrosoftCXXNameMangler::mangleType(const LValueReferenceType *T) {
1032 QualType PointeeTy = T->getPointeeType();
1033 if (!PointeeTy.hasQualifiers())
1034 // Lack of qualifiers is mangled as 'A'.
1036 mangleType(PointeeTy);
1039 void MicrosoftCXXNameMangler::mangleType(const RValueReferenceType *T) {
1040 llvm_unreachable("Don't know how to mangle RValueReferenceTypes yet!");
1043 void MicrosoftCXXNameMangler::mangleType(const ComplexType *T) {
1044 llvm_unreachable("Don't know how to mangle ComplexTypes yet!");
1047 void MicrosoftCXXNameMangler::mangleType(const VectorType *T) {
1048 llvm_unreachable("Don't know how to mangle VectorTypes yet!");
1050 void MicrosoftCXXNameMangler::mangleType(const ExtVectorType *T) {
1051 llvm_unreachable("Don't know how to mangle ExtVectorTypes yet!");
1053 void MicrosoftCXXNameMangler::mangleType(const DependentSizedExtVectorType *T) {
1055 "Don't know how to mangle DependentSizedExtVectorTypes yet!");
1058 void MicrosoftCXXNameMangler::mangleType(const ObjCInterfaceType *T) {
1059 // ObjC interfaces have structs underlying them.
1061 mangleName(T->getDecl());
1064 void MicrosoftCXXNameMangler::mangleType(const ObjCObjectType *T) {
1065 // We don't allow overloading by different protocol qualification,
1066 // so mangling them isn't necessary.
1067 mangleType(T->getBaseType());
1070 void MicrosoftCXXNameMangler::mangleType(const BlockPointerType *T) {
1072 mangleType(T->getPointeeType());
1075 void MicrosoftCXXNameMangler::mangleType(const InjectedClassNameType *T) {
1076 llvm_unreachable("Don't know how to mangle InjectedClassNameTypes yet!");
1079 void MicrosoftCXXNameMangler::mangleType(const TemplateSpecializationType *T) {
1080 llvm_unreachable("Don't know how to mangle TemplateSpecializationTypes yet!");
1083 void MicrosoftCXXNameMangler::mangleType(const DependentNameType *T) {
1084 llvm_unreachable("Don't know how to mangle DependentNameTypes yet!");
1087 void MicrosoftCXXNameMangler::mangleType(
1088 const DependentTemplateSpecializationType *T) {
1090 "Don't know how to mangle DependentTemplateSpecializationTypes yet!");
1093 void MicrosoftCXXNameMangler::mangleType(const PackExpansionType *T) {
1094 llvm_unreachable("Don't know how to mangle PackExpansionTypes yet!");
1097 void MicrosoftCXXNameMangler::mangleType(const TypeOfType *T) {
1098 llvm_unreachable("Don't know how to mangle TypeOfTypes yet!");
1101 void MicrosoftCXXNameMangler::mangleType(const TypeOfExprType *T) {
1102 llvm_unreachable("Don't know how to mangle TypeOfExprTypes yet!");
1105 void MicrosoftCXXNameMangler::mangleType(const DecltypeType *T) {
1106 llvm_unreachable("Don't know how to mangle DecltypeTypes yet!");
1109 void MicrosoftCXXNameMangler::mangleType(const UnaryTransformType *T) {
1110 llvm_unreachable("Don't know how to mangle UnaryTransformationTypes yet!");
1113 void MicrosoftCXXNameMangler::mangleType(const AutoType *T) {
1114 llvm_unreachable("Don't know how to mangle AutoTypes yet!");
1117 void MicrosoftCXXNameMangler::mangleType(const AtomicType *T) {
1118 llvm_unreachable("Don't know how to mangle AtomicTypes yet!");
1121 void MicrosoftMangleContext::mangleName(const NamedDecl *D,
1123 assert((isa<FunctionDecl>(D) || isa<VarDecl>(D)) &&
1124 "Invalid mangleName() call, argument is not a variable or function!");
1125 assert(!isa<CXXConstructorDecl>(D) && !isa<CXXDestructorDecl>(D) &&
1126 "Invalid mangleName() call on 'structor decl!");
1128 PrettyStackTraceDecl CrashInfo(D, SourceLocation(),
1129 getASTContext().getSourceManager(),
1130 "Mangling declaration");
1132 MicrosoftCXXNameMangler Mangler(*this, Out);
1133 return Mangler.mangle(D);
1135 void MicrosoftMangleContext::mangleThunk(const CXXMethodDecl *MD,
1136 const ThunkInfo &Thunk,
1138 llvm_unreachable("Can't yet mangle thunks!");
1140 void MicrosoftMangleContext::mangleCXXDtorThunk(const CXXDestructorDecl *DD,
1142 const ThisAdjustment &,
1144 llvm_unreachable("Can't yet mangle destructor thunks!");
1146 void MicrosoftMangleContext::mangleCXXVTable(const CXXRecordDecl *RD,
1148 llvm_unreachable("Can't yet mangle virtual tables!");
1150 void MicrosoftMangleContext::mangleCXXVTT(const CXXRecordDecl *RD,
1152 llvm_unreachable("The MS C++ ABI does not have virtual table tables!");
1154 void MicrosoftMangleContext::mangleCXXCtorVTable(const CXXRecordDecl *RD,
1156 const CXXRecordDecl *Type,
1158 llvm_unreachable("The MS C++ ABI does not have constructor vtables!");
1160 void MicrosoftMangleContext::mangleCXXRTTI(QualType T,
1162 llvm_unreachable("Can't yet mangle RTTI!");
1164 void MicrosoftMangleContext::mangleCXXRTTIName(QualType T,
1166 llvm_unreachable("Can't yet mangle RTTI names!");
1168 void MicrosoftMangleContext::mangleCXXCtor(const CXXConstructorDecl *D,
1171 llvm_unreachable("Can't yet mangle constructors!");
1173 void MicrosoftMangleContext::mangleCXXDtor(const CXXDestructorDecl *D,
1176 llvm_unreachable("Can't yet mangle destructors!");
1178 void MicrosoftMangleContext::mangleReferenceTemporary(const clang::VarDecl *,
1180 llvm_unreachable("Can't yet mangle reference temporaries!");
1183 MangleContext *clang::createMicrosoftMangleContext(ASTContext &Context,
1184 DiagnosticsEngine &Diags) {
1185 return new MicrosoftMangleContext(Context, Diags);