blob: 926384decb0f39dcf333ba1864a0ee1bd3ec01b9 [file] [log] [blame]
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001//===--- ItaniumMangle.cpp - Itanium C++ Name Mangling ----------*- C++ -*-===//
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// Implements C++ name mangling according to the Itanium C++ ABI,
11// which is used in GCC 3.2 and newer (and many compilers that are
12// ABI-compatible with GCC):
13//
14// http://www.codesourcery.com/public/cxx-abi/abi.html
15//
16//===----------------------------------------------------------------------===//
17#include "clang/AST/Mangle.h"
18#include "clang/AST/ASTContext.h"
19#include "clang/AST/Attr.h"
20#include "clang/AST/Decl.h"
21#include "clang/AST/DeclCXX.h"
22#include "clang/AST/DeclObjC.h"
23#include "clang/AST/DeclTemplate.h"
24#include "clang/AST/ExprCXX.h"
25#include "clang/AST/ExprObjC.h"
26#include "clang/AST/TypeLoc.h"
27#include "clang/Basic/ABI.h"
28#include "clang/Basic/SourceManager.h"
29#include "clang/Basic/TargetInfo.h"
30#include "llvm/ADT/StringExtras.h"
31#include "llvm/Support/ErrorHandling.h"
32#include "llvm/Support/raw_ostream.h"
33
34#define MANGLE_CHECKER 0
35
36#if MANGLE_CHECKER
37#include <cxxabi.h>
38#endif
39
40using namespace clang;
41
42namespace {
43
44/// \brief Retrieve the declaration context that should be used when mangling
45/// the given declaration.
46static const DeclContext *getEffectiveDeclContext(const Decl *D) {
47 // The ABI assumes that lambda closure types that occur within
48 // default arguments live in the context of the function. However, due to
49 // the way in which Clang parses and creates function declarations, this is
50 // not the case: the lambda closure type ends up living in the context
51 // where the function itself resides, because the function declaration itself
52 // had not yet been created. Fix the context here.
53 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
54 if (RD->isLambda())
55 if (ParmVarDecl *ContextParam
56 = dyn_cast_or_null<ParmVarDecl>(RD->getLambdaContextDecl()))
57 return ContextParam->getDeclContext();
58 }
59
60 return D->getDeclContext();
61}
62
63static const DeclContext *getEffectiveParentContext(const DeclContext *DC) {
64 return getEffectiveDeclContext(cast<Decl>(DC));
65}
66
67static const CXXRecordDecl *GetLocalClassDecl(const NamedDecl *ND) {
68 const DeclContext *DC = dyn_cast<DeclContext>(ND);
69 if (!DC)
70 DC = getEffectiveDeclContext(ND);
71 while (!DC->isNamespace() && !DC->isTranslationUnit()) {
72 const DeclContext *Parent = getEffectiveDeclContext(cast<Decl>(DC));
73 if (isa<FunctionDecl>(Parent))
74 return dyn_cast<CXXRecordDecl>(DC);
75 DC = Parent;
76 }
77 return 0;
78}
79
80static const FunctionDecl *getStructor(const FunctionDecl *fn) {
81 if (const FunctionTemplateDecl *ftd = fn->getPrimaryTemplate())
82 return ftd->getTemplatedDecl();
83
84 return fn;
85}
86
87static const NamedDecl *getStructor(const NamedDecl *decl) {
88 const FunctionDecl *fn = dyn_cast_or_null<FunctionDecl>(decl);
89 return (fn ? getStructor(fn) : decl);
90}
91
92static const unsigned UnknownArity = ~0U;
93
94class ItaniumMangleContext : public MangleContext {
95 llvm::DenseMap<const TagDecl *, uint64_t> AnonStructIds;
96 unsigned Discriminator;
97 llvm::DenseMap<const NamedDecl*, unsigned> Uniquifier;
98
99public:
100 explicit ItaniumMangleContext(ASTContext &Context,
101 DiagnosticsEngine &Diags)
102 : MangleContext(Context, Diags) { }
103
104 uint64_t getAnonymousStructId(const TagDecl *TD) {
105 std::pair<llvm::DenseMap<const TagDecl *,
106 uint64_t>::iterator, bool> Result =
107 AnonStructIds.insert(std::make_pair(TD, AnonStructIds.size()));
108 return Result.first->second;
109 }
110
111 void startNewFunction() {
112 MangleContext::startNewFunction();
113 mangleInitDiscriminator();
114 }
115
116 /// @name Mangler Entry Points
117 /// @{
118
119 bool shouldMangleDeclName(const NamedDecl *D);
120 void mangleName(const NamedDecl *D, raw_ostream &);
121 void mangleThunk(const CXXMethodDecl *MD,
122 const ThunkInfo &Thunk,
123 raw_ostream &);
124 void mangleCXXDtorThunk(const CXXDestructorDecl *DD, CXXDtorType Type,
125 const ThisAdjustment &ThisAdjustment,
126 raw_ostream &);
127 void mangleReferenceTemporary(const VarDecl *D,
128 raw_ostream &);
129 void mangleCXXVTable(const CXXRecordDecl *RD,
130 raw_ostream &);
131 void mangleCXXVTT(const CXXRecordDecl *RD,
132 raw_ostream &);
133 void mangleCXXCtorVTable(const CXXRecordDecl *RD, int64_t Offset,
134 const CXXRecordDecl *Type,
135 raw_ostream &);
136 void mangleCXXRTTI(QualType T, raw_ostream &);
137 void mangleCXXRTTIName(QualType T, raw_ostream &);
138 void mangleCXXCtor(const CXXConstructorDecl *D, CXXCtorType Type,
139 raw_ostream &);
140 void mangleCXXDtor(const CXXDestructorDecl *D, CXXDtorType Type,
141 raw_ostream &);
142
143 void mangleItaniumGuardVariable(const VarDecl *D, raw_ostream &);
144
145 void mangleInitDiscriminator() {
146 Discriminator = 0;
147 }
148
149 bool getNextDiscriminator(const NamedDecl *ND, unsigned &disc) {
150 // Lambda closure types with external linkage (indicated by a
151 // non-zero lambda mangling number) have their own numbering scheme, so
152 // they do not need a discriminator.
153 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(ND))
154 if (RD->isLambda() && RD->getLambdaManglingNumber() > 0)
155 return false;
156
157 unsigned &discriminator = Uniquifier[ND];
158 if (!discriminator)
159 discriminator = ++Discriminator;
160 if (discriminator == 1)
161 return false;
162 disc = discriminator-2;
163 return true;
164 }
165 /// @}
166};
167
168/// CXXNameMangler - Manage the mangling of a single name.
169class CXXNameMangler {
170 ItaniumMangleContext &Context;
171 raw_ostream &Out;
172
173 /// The "structor" is the top-level declaration being mangled, if
174 /// that's not a template specialization; otherwise it's the pattern
175 /// for that specialization.
176 const NamedDecl *Structor;
177 unsigned StructorType;
178
179 /// SeqID - The next subsitution sequence number.
180 unsigned SeqID;
181
182 class FunctionTypeDepthState {
183 unsigned Bits;
184
185 enum { InResultTypeMask = 1 };
186
187 public:
188 FunctionTypeDepthState() : Bits(0) {}
189
190 /// The number of function types we're inside.
191 unsigned getDepth() const {
192 return Bits >> 1;
193 }
194
195 /// True if we're in the return type of the innermost function type.
196 bool isInResultType() const {
197 return Bits & InResultTypeMask;
198 }
199
200 FunctionTypeDepthState push() {
201 FunctionTypeDepthState tmp = *this;
202 Bits = (Bits & ~InResultTypeMask) + 2;
203 return tmp;
204 }
205
206 void enterResultType() {
207 Bits |= InResultTypeMask;
208 }
209
210 void leaveResultType() {
211 Bits &= ~InResultTypeMask;
212 }
213
214 void pop(FunctionTypeDepthState saved) {
215 assert(getDepth() == saved.getDepth() + 1);
216 Bits = saved.Bits;
217 }
218
219 } FunctionTypeDepth;
220
221 llvm::DenseMap<uintptr_t, unsigned> Substitutions;
222
223 ASTContext &getASTContext() const { return Context.getASTContext(); }
224
225public:
226 CXXNameMangler(ItaniumMangleContext &C, raw_ostream &Out_,
227 const NamedDecl *D = 0)
228 : Context(C), Out(Out_), Structor(getStructor(D)), StructorType(0),
229 SeqID(0) {
230 // These can't be mangled without a ctor type or dtor type.
231 assert(!D || (!isa<CXXDestructorDecl>(D) &&
232 !isa<CXXConstructorDecl>(D)));
233 }
234 CXXNameMangler(ItaniumMangleContext &C, raw_ostream &Out_,
235 const CXXConstructorDecl *D, CXXCtorType Type)
236 : Context(C), Out(Out_), Structor(getStructor(D)), StructorType(Type),
237 SeqID(0) { }
238 CXXNameMangler(ItaniumMangleContext &C, raw_ostream &Out_,
239 const CXXDestructorDecl *D, CXXDtorType Type)
240 : Context(C), Out(Out_), Structor(getStructor(D)), StructorType(Type),
241 SeqID(0) { }
242
243#if MANGLE_CHECKER
244 ~CXXNameMangler() {
245 if (Out.str()[0] == '\01')
246 return;
247
248 int status = 0;
249 char *result = abi::__cxa_demangle(Out.str().str().c_str(), 0, 0, &status);
250 assert(status == 0 && "Could not demangle mangled name!");
251 free(result);
252 }
253#endif
254 raw_ostream &getStream() { return Out; }
255
256 void mangle(const NamedDecl *D, StringRef Prefix = "_Z");
257 void mangleCallOffset(int64_t NonVirtual, int64_t Virtual);
258 void mangleNumber(const llvm::APSInt &I);
259 void mangleNumber(int64_t Number);
260 void mangleFloat(const llvm::APFloat &F);
261 void mangleFunctionEncoding(const FunctionDecl *FD);
262 void mangleName(const NamedDecl *ND);
263 void mangleType(QualType T);
264 void mangleNameOrStandardSubstitution(const NamedDecl *ND);
265
266private:
267 bool mangleSubstitution(const NamedDecl *ND);
268 bool mangleSubstitution(QualType T);
269 bool mangleSubstitution(TemplateName Template);
270 bool mangleSubstitution(uintptr_t Ptr);
271
272 void mangleExistingSubstitution(QualType type);
273 void mangleExistingSubstitution(TemplateName name);
274
275 bool mangleStandardSubstitution(const NamedDecl *ND);
276
277 void addSubstitution(const NamedDecl *ND) {
278 ND = cast<NamedDecl>(ND->getCanonicalDecl());
279
280 addSubstitution(reinterpret_cast<uintptr_t>(ND));
281 }
282 void addSubstitution(QualType T);
283 void addSubstitution(TemplateName Template);
284 void addSubstitution(uintptr_t Ptr);
285
286 void mangleUnresolvedPrefix(NestedNameSpecifier *qualifier,
287 NamedDecl *firstQualifierLookup,
288 bool recursive = false);
289 void mangleUnresolvedName(NestedNameSpecifier *qualifier,
290 NamedDecl *firstQualifierLookup,
291 DeclarationName name,
292 unsigned KnownArity = UnknownArity);
293
294 void mangleName(const TemplateDecl *TD,
295 const TemplateArgument *TemplateArgs,
296 unsigned NumTemplateArgs);
297 void mangleUnqualifiedName(const NamedDecl *ND) {
298 mangleUnqualifiedName(ND, ND->getDeclName(), UnknownArity);
299 }
300 void mangleUnqualifiedName(const NamedDecl *ND, DeclarationName Name,
301 unsigned KnownArity);
302 void mangleUnscopedName(const NamedDecl *ND);
303 void mangleUnscopedTemplateName(const TemplateDecl *ND);
304 void mangleUnscopedTemplateName(TemplateName);
305 void mangleSourceName(const IdentifierInfo *II);
306 void mangleLocalName(const NamedDecl *ND);
307 void mangleLambda(const CXXRecordDecl *Lambda);
308 void mangleNestedName(const NamedDecl *ND, const DeclContext *DC,
309 bool NoFunction=false);
310 void mangleNestedName(const TemplateDecl *TD,
311 const TemplateArgument *TemplateArgs,
312 unsigned NumTemplateArgs);
313 void manglePrefix(NestedNameSpecifier *qualifier);
314 void manglePrefix(const DeclContext *DC, bool NoFunction=false);
315 void manglePrefix(QualType type);
316 void mangleTemplatePrefix(const TemplateDecl *ND);
317 void mangleTemplatePrefix(TemplateName Template);
318 void mangleOperatorName(OverloadedOperatorKind OO, unsigned Arity);
319 void mangleQualifiers(Qualifiers Quals);
320 void mangleRefQualifier(RefQualifierKind RefQualifier);
321
322 void mangleObjCMethodName(const ObjCMethodDecl *MD);
323
324 // Declare manglers for every type class.
325#define ABSTRACT_TYPE(CLASS, PARENT)
326#define NON_CANONICAL_TYPE(CLASS, PARENT)
327#define TYPE(CLASS, PARENT) void mangleType(const CLASS##Type *T);
328#include "clang/AST/TypeNodes.def"
329
330 void mangleType(const TagType*);
331 void mangleType(TemplateName);
332 void mangleBareFunctionType(const FunctionType *T,
333 bool MangleReturnType);
334 void mangleNeonVectorType(const VectorType *T);
335
336 void mangleIntegerLiteral(QualType T, const llvm::APSInt &Value);
337 void mangleMemberExpr(const Expr *base, bool isArrow,
338 NestedNameSpecifier *qualifier,
339 NamedDecl *firstQualifierLookup,
340 DeclarationName name,
341 unsigned knownArity);
342 void mangleExpression(const Expr *E, unsigned Arity = UnknownArity);
343 void mangleCXXCtorType(CXXCtorType T);
344 void mangleCXXDtorType(CXXDtorType T);
345
346 void mangleTemplateArgs(const ASTTemplateArgumentListInfo &TemplateArgs);
347 void mangleTemplateArgs(const TemplateArgument *TemplateArgs,
348 unsigned NumTemplateArgs);
349 void mangleTemplateArgs(const TemplateArgumentList &AL);
350 void mangleTemplateArg(TemplateArgument A);
351
352 void mangleTemplateParameter(unsigned Index);
353
354 void mangleFunctionParam(const ParmVarDecl *parm);
355};
356
357}
358
359static bool isInCLinkageSpecification(const Decl *D) {
360 D = D->getCanonicalDecl();
361 for (const DeclContext *DC = getEffectiveDeclContext(D);
362 !DC->isTranslationUnit(); DC = getEffectiveParentContext(DC)) {
363 if (const LinkageSpecDecl *Linkage = dyn_cast<LinkageSpecDecl>(DC))
364 return Linkage->getLanguage() == LinkageSpecDecl::lang_c;
365 }
366
367 return false;
368}
369
370bool ItaniumMangleContext::shouldMangleDeclName(const NamedDecl *D) {
371 // In C, functions with no attributes never need to be mangled. Fastpath them.
372 if (!getASTContext().getLangOpts().CPlusPlus && !D->hasAttrs())
373 return false;
374
375 // Any decl can be declared with __asm("foo") on it, and this takes precedence
376 // over all other naming in the .o file.
377 if (D->hasAttr<AsmLabelAttr>())
378 return true;
379
380 // Clang's "overloadable" attribute extension to C/C++ implies name mangling
381 // (always) as does passing a C++ member function and a function
382 // whose name is not a simple identifier.
383 const FunctionDecl *FD = dyn_cast<FunctionDecl>(D);
384 if (FD && (FD->hasAttr<OverloadableAttr>() || isa<CXXMethodDecl>(FD) ||
385 !FD->getDeclName().isIdentifier()))
386 return true;
387
388 // Otherwise, no mangling is done outside C++ mode.
389 if (!getASTContext().getLangOpts().CPlusPlus)
390 return false;
391
392 // Variables at global scope with non-internal linkage are not mangled
393 if (!FD) {
394 const DeclContext *DC = getEffectiveDeclContext(D);
395 // Check for extern variable declared locally.
396 if (DC->isFunctionOrMethod() && D->hasLinkage())
397 while (!DC->isNamespace() && !DC->isTranslationUnit())
398 DC = getEffectiveParentContext(DC);
399 if (DC->isTranslationUnit() && D->getLinkage() != InternalLinkage)
400 return false;
401 }
402
403 // Class members are always mangled.
404 if (getEffectiveDeclContext(D)->isRecord())
405 return true;
406
407 // C functions and "main" are not mangled.
408 if ((FD && FD->isMain()) || isInCLinkageSpecification(D))
409 return false;
410
411 return true;
412}
413
414void CXXNameMangler::mangle(const NamedDecl *D, StringRef Prefix) {
415 // Any decl can be declared with __asm("foo") on it, and this takes precedence
416 // over all other naming in the .o file.
417 if (const AsmLabelAttr *ALA = D->getAttr<AsmLabelAttr>()) {
418 // If we have an asm name, then we use it as the mangling.
419
420 // Adding the prefix can cause problems when one file has a "foo" and
421 // another has a "\01foo". That is known to happen on ELF with the
422 // tricks normally used for producing aliases (PR9177). Fortunately the
423 // llvm mangler on ELF is a nop, so we can just avoid adding the \01
424 // marker. We also avoid adding the marker if this is an alias for an
425 // LLVM intrinsic.
426 StringRef UserLabelPrefix =
427 getASTContext().getTargetInfo().getUserLabelPrefix();
428 if (!UserLabelPrefix.empty() && !ALA->getLabel().startswith("llvm."))
429 Out << '\01'; // LLVM IR Marker for __asm("foo")
430
431 Out << ALA->getLabel();
432 return;
433 }
434
435 // <mangled-name> ::= _Z <encoding>
436 // ::= <data name>
437 // ::= <special-name>
438 Out << Prefix;
439 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
440 mangleFunctionEncoding(FD);
441 else if (const VarDecl *VD = dyn_cast<VarDecl>(D))
442 mangleName(VD);
443 else
444 mangleName(cast<FieldDecl>(D));
445}
446
447void CXXNameMangler::mangleFunctionEncoding(const FunctionDecl *FD) {
448 // <encoding> ::= <function name> <bare-function-type>
449 mangleName(FD);
450
451 // Don't mangle in the type if this isn't a decl we should typically mangle.
452 if (!Context.shouldMangleDeclName(FD))
453 return;
454
455 // Whether the mangling of a function type includes the return type depends on
456 // the context and the nature of the function. The rules for deciding whether
457 // the return type is included are:
458 //
459 // 1. Template functions (names or types) have return types encoded, with
460 // the exceptions listed below.
461 // 2. Function types not appearing as part of a function name mangling,
462 // e.g. parameters, pointer types, etc., have return type encoded, with the
463 // exceptions listed below.
464 // 3. Non-template function names do not have return types encoded.
465 //
466 // The exceptions mentioned in (1) and (2) above, for which the return type is
467 // never included, are
468 // 1. Constructors.
469 // 2. Destructors.
470 // 3. Conversion operator functions, e.g. operator int.
471 bool MangleReturnType = false;
472 if (FunctionTemplateDecl *PrimaryTemplate = FD->getPrimaryTemplate()) {
473 if (!(isa<CXXConstructorDecl>(FD) || isa<CXXDestructorDecl>(FD) ||
474 isa<CXXConversionDecl>(FD)))
475 MangleReturnType = true;
476
477 // Mangle the type of the primary template.
478 FD = PrimaryTemplate->getTemplatedDecl();
479 }
480
481 mangleBareFunctionType(FD->getType()->getAs<FunctionType>(),
482 MangleReturnType);
483}
484
485static const DeclContext *IgnoreLinkageSpecDecls(const DeclContext *DC) {
486 while (isa<LinkageSpecDecl>(DC)) {
487 DC = getEffectiveParentContext(DC);
488 }
489
490 return DC;
491}
492
493/// isStd - Return whether a given namespace is the 'std' namespace.
494static bool isStd(const NamespaceDecl *NS) {
495 if (!IgnoreLinkageSpecDecls(getEffectiveParentContext(NS))
496 ->isTranslationUnit())
497 return false;
498
499 const IdentifierInfo *II = NS->getOriginalNamespace()->getIdentifier();
500 return II && II->isStr("std");
501}
502
503// isStdNamespace - Return whether a given decl context is a toplevel 'std'
504// namespace.
505static bool isStdNamespace(const DeclContext *DC) {
506 if (!DC->isNamespace())
507 return false;
508
509 return isStd(cast<NamespaceDecl>(DC));
510}
511
512static const TemplateDecl *
513isTemplate(const NamedDecl *ND, const TemplateArgumentList *&TemplateArgs) {
514 // Check if we have a function template.
515 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)){
516 if (const TemplateDecl *TD = FD->getPrimaryTemplate()) {
517 TemplateArgs = FD->getTemplateSpecializationArgs();
518 return TD;
519 }
520 }
521
522 // Check if we have a class template.
523 if (const ClassTemplateSpecializationDecl *Spec =
524 dyn_cast<ClassTemplateSpecializationDecl>(ND)) {
525 TemplateArgs = &Spec->getTemplateArgs();
526 return Spec->getSpecializedTemplate();
527 }
528
529 return 0;
530}
531
532static bool isLambda(const NamedDecl *ND) {
533 const CXXRecordDecl *Record = dyn_cast<CXXRecordDecl>(ND);
534 if (!Record)
535 return false;
536
537 return Record->isLambda();
538}
539
540void CXXNameMangler::mangleName(const NamedDecl *ND) {
541 // <name> ::= <nested-name>
542 // ::= <unscoped-name>
543 // ::= <unscoped-template-name> <template-args>
544 // ::= <local-name>
545 //
546 const DeclContext *DC = getEffectiveDeclContext(ND);
547
548 // If this is an extern variable declared locally, the relevant DeclContext
549 // is that of the containing namespace, or the translation unit.
550 // FIXME: This is a hack; extern variables declared locally should have
551 // a proper semantic declaration context!
552 if (isa<FunctionDecl>(DC) && ND->hasLinkage() && !isLambda(ND))
553 while (!DC->isNamespace() && !DC->isTranslationUnit())
554 DC = getEffectiveParentContext(DC);
555 else if (GetLocalClassDecl(ND)) {
556 mangleLocalName(ND);
557 return;
558 }
559
560 DC = IgnoreLinkageSpecDecls(DC);
561
562 if (DC->isTranslationUnit() || isStdNamespace(DC)) {
563 // Check if we have a template.
564 const TemplateArgumentList *TemplateArgs = 0;
565 if (const TemplateDecl *TD = isTemplate(ND, TemplateArgs)) {
566 mangleUnscopedTemplateName(TD);
567 mangleTemplateArgs(*TemplateArgs);
568 return;
569 }
570
571 mangleUnscopedName(ND);
572 return;
573 }
574
575 if (isa<FunctionDecl>(DC) || isa<ObjCMethodDecl>(DC)) {
576 mangleLocalName(ND);
577 return;
578 }
579
580 mangleNestedName(ND, DC);
581}
582void CXXNameMangler::mangleName(const TemplateDecl *TD,
583 const TemplateArgument *TemplateArgs,
584 unsigned NumTemplateArgs) {
585 const DeclContext *DC = IgnoreLinkageSpecDecls(getEffectiveDeclContext(TD));
586
587 if (DC->isTranslationUnit() || isStdNamespace(DC)) {
588 mangleUnscopedTemplateName(TD);
589 mangleTemplateArgs(TemplateArgs, NumTemplateArgs);
590 } else {
591 mangleNestedName(TD, TemplateArgs, NumTemplateArgs);
592 }
593}
594
595void CXXNameMangler::mangleUnscopedName(const NamedDecl *ND) {
596 // <unscoped-name> ::= <unqualified-name>
597 // ::= St <unqualified-name> # ::std::
598
599 if (isStdNamespace(IgnoreLinkageSpecDecls(getEffectiveDeclContext(ND))))
600 Out << "St";
601
602 mangleUnqualifiedName(ND);
603}
604
605void CXXNameMangler::mangleUnscopedTemplateName(const TemplateDecl *ND) {
606 // <unscoped-template-name> ::= <unscoped-name>
607 // ::= <substitution>
608 if (mangleSubstitution(ND))
609 return;
610
611 // <template-template-param> ::= <template-param>
612 if (const TemplateTemplateParmDecl *TTP
613 = dyn_cast<TemplateTemplateParmDecl>(ND)) {
614 mangleTemplateParameter(TTP->getIndex());
615 return;
616 }
617
618 mangleUnscopedName(ND->getTemplatedDecl());
619 addSubstitution(ND);
620}
621
622void CXXNameMangler::mangleUnscopedTemplateName(TemplateName Template) {
623 // <unscoped-template-name> ::= <unscoped-name>
624 // ::= <substitution>
625 if (TemplateDecl *TD = Template.getAsTemplateDecl())
626 return mangleUnscopedTemplateName(TD);
627
628 if (mangleSubstitution(Template))
629 return;
630
631 DependentTemplateName *Dependent = Template.getAsDependentTemplateName();
632 assert(Dependent && "Not a dependent template name?");
633 if (const IdentifierInfo *Id = Dependent->getIdentifier())
634 mangleSourceName(Id);
635 else
636 mangleOperatorName(Dependent->getOperator(), UnknownArity);
637
638 addSubstitution(Template);
639}
640
641void CXXNameMangler::mangleFloat(const llvm::APFloat &f) {
642 // ABI:
643 // Floating-point literals are encoded using a fixed-length
644 // lowercase hexadecimal string corresponding to the internal
645 // representation (IEEE on Itanium), high-order bytes first,
646 // without leading zeroes. For example: "Lf bf800000 E" is -1.0f
647 // on Itanium.
648 // The 'without leading zeroes' thing seems to be an editorial
649 // mistake; see the discussion on cxx-abi-dev beginning on
650 // 2012-01-16.
651
652 // Our requirements here are just barely weird enough to justify
653 // using a custom algorithm instead of post-processing APInt::toString().
654
655 llvm::APInt valueBits = f.bitcastToAPInt();
656 unsigned numCharacters = (valueBits.getBitWidth() + 3) / 4;
657 assert(numCharacters != 0);
658
659 // Allocate a buffer of the right number of characters.
Dmitri Gribenkocfa88f82013-01-12 19:30:44 +0000660 SmallVector<char, 20> buffer;
Guy Benyei7f92f2d2012-12-18 14:30:41 +0000661 buffer.set_size(numCharacters);
662
663 // Fill the buffer left-to-right.
664 for (unsigned stringIndex = 0; stringIndex != numCharacters; ++stringIndex) {
665 // The bit-index of the next hex digit.
666 unsigned digitBitIndex = 4 * (numCharacters - stringIndex - 1);
667
668 // Project out 4 bits starting at 'digitIndex'.
669 llvm::integerPart hexDigit
670 = valueBits.getRawData()[digitBitIndex / llvm::integerPartWidth];
671 hexDigit >>= (digitBitIndex % llvm::integerPartWidth);
672 hexDigit &= 0xF;
673
674 // Map that over to a lowercase hex digit.
675 static const char charForHex[16] = {
676 '0', '1', '2', '3', '4', '5', '6', '7',
677 '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'
678 };
679 buffer[stringIndex] = charForHex[hexDigit];
680 }
681
682 Out.write(buffer.data(), numCharacters);
683}
684
685void CXXNameMangler::mangleNumber(const llvm::APSInt &Value) {
686 if (Value.isSigned() && Value.isNegative()) {
687 Out << 'n';
688 Value.abs().print(Out, /*signed*/ false);
689 } else {
690 Value.print(Out, /*signed*/ false);
691 }
692}
693
694void CXXNameMangler::mangleNumber(int64_t Number) {
695 // <number> ::= [n] <non-negative decimal integer>
696 if (Number < 0) {
697 Out << 'n';
698 Number = -Number;
699 }
700
701 Out << Number;
702}
703
704void CXXNameMangler::mangleCallOffset(int64_t NonVirtual, int64_t Virtual) {
705 // <call-offset> ::= h <nv-offset> _
706 // ::= v <v-offset> _
707 // <nv-offset> ::= <offset number> # non-virtual base override
708 // <v-offset> ::= <offset number> _ <virtual offset number>
709 // # virtual base override, with vcall offset
710 if (!Virtual) {
711 Out << 'h';
712 mangleNumber(NonVirtual);
713 Out << '_';
714 return;
715 }
716
717 Out << 'v';
718 mangleNumber(NonVirtual);
719 Out << '_';
720 mangleNumber(Virtual);
721 Out << '_';
722}
723
724void CXXNameMangler::manglePrefix(QualType type) {
725 if (const TemplateSpecializationType *TST =
726 type->getAs<TemplateSpecializationType>()) {
727 if (!mangleSubstitution(QualType(TST, 0))) {
728 mangleTemplatePrefix(TST->getTemplateName());
729
730 // FIXME: GCC does not appear to mangle the template arguments when
731 // the template in question is a dependent template name. Should we
732 // emulate that badness?
733 mangleTemplateArgs(TST->getArgs(), TST->getNumArgs());
734 addSubstitution(QualType(TST, 0));
735 }
736 } else if (const DependentTemplateSpecializationType *DTST
737 = type->getAs<DependentTemplateSpecializationType>()) {
738 TemplateName Template
739 = getASTContext().getDependentTemplateName(DTST->getQualifier(),
740 DTST->getIdentifier());
741 mangleTemplatePrefix(Template);
742
743 // FIXME: GCC does not appear to mangle the template arguments when
744 // the template in question is a dependent template name. Should we
745 // emulate that badness?
746 mangleTemplateArgs(DTST->getArgs(), DTST->getNumArgs());
747 } else {
748 // We use the QualType mangle type variant here because it handles
749 // substitutions.
750 mangleType(type);
751 }
752}
753
754/// Mangle everything prior to the base-unresolved-name in an unresolved-name.
755///
756/// \param firstQualifierLookup - the entity found by unqualified lookup
757/// for the first name in the qualifier, if this is for a member expression
758/// \param recursive - true if this is being called recursively,
759/// i.e. if there is more prefix "to the right".
760void CXXNameMangler::mangleUnresolvedPrefix(NestedNameSpecifier *qualifier,
761 NamedDecl *firstQualifierLookup,
762 bool recursive) {
763
764 // x, ::x
765 // <unresolved-name> ::= [gs] <base-unresolved-name>
766
767 // T::x / decltype(p)::x
768 // <unresolved-name> ::= sr <unresolved-type> <base-unresolved-name>
769
770 // T::N::x /decltype(p)::N::x
771 // <unresolved-name> ::= srN <unresolved-type> <unresolved-qualifier-level>+ E
772 // <base-unresolved-name>
773
774 // A::x, N::y, A<T>::z; "gs" means leading "::"
775 // <unresolved-name> ::= [gs] sr <unresolved-qualifier-level>+ E
776 // <base-unresolved-name>
777
778 switch (qualifier->getKind()) {
779 case NestedNameSpecifier::Global:
780 Out << "gs";
781
782 // We want an 'sr' unless this is the entire NNS.
783 if (recursive)
784 Out << "sr";
785
786 // We never want an 'E' here.
787 return;
788
789 case NestedNameSpecifier::Namespace:
790 if (qualifier->getPrefix())
791 mangleUnresolvedPrefix(qualifier->getPrefix(), firstQualifierLookup,
792 /*recursive*/ true);
793 else
794 Out << "sr";
795 mangleSourceName(qualifier->getAsNamespace()->getIdentifier());
796 break;
797 case NestedNameSpecifier::NamespaceAlias:
798 if (qualifier->getPrefix())
799 mangleUnresolvedPrefix(qualifier->getPrefix(), firstQualifierLookup,
800 /*recursive*/ true);
801 else
802 Out << "sr";
803 mangleSourceName(qualifier->getAsNamespaceAlias()->getIdentifier());
804 break;
805
806 case NestedNameSpecifier::TypeSpec:
807 case NestedNameSpecifier::TypeSpecWithTemplate: {
808 const Type *type = qualifier->getAsType();
809
810 // We only want to use an unresolved-type encoding if this is one of:
811 // - a decltype
812 // - a template type parameter
813 // - a template template parameter with arguments
814 // In all of these cases, we should have no prefix.
815 if (qualifier->getPrefix()) {
816 mangleUnresolvedPrefix(qualifier->getPrefix(), firstQualifierLookup,
817 /*recursive*/ true);
818 } else {
819 // Otherwise, all the cases want this.
820 Out << "sr";
821 }
822
823 // Only certain other types are valid as prefixes; enumerate them.
824 switch (type->getTypeClass()) {
825 case Type::Builtin:
826 case Type::Complex:
827 case Type::Pointer:
828 case Type::BlockPointer:
829 case Type::LValueReference:
830 case Type::RValueReference:
831 case Type::MemberPointer:
832 case Type::ConstantArray:
833 case Type::IncompleteArray:
834 case Type::VariableArray:
835 case Type::DependentSizedArray:
836 case Type::DependentSizedExtVector:
837 case Type::Vector:
838 case Type::ExtVector:
839 case Type::FunctionProto:
840 case Type::FunctionNoProto:
841 case Type::Enum:
842 case Type::Paren:
843 case Type::Elaborated:
844 case Type::Attributed:
845 case Type::Auto:
846 case Type::PackExpansion:
847 case Type::ObjCObject:
848 case Type::ObjCInterface:
849 case Type::ObjCObjectPointer:
850 case Type::Atomic:
851 llvm_unreachable("type is illegal as a nested name specifier");
852
853 case Type::SubstTemplateTypeParmPack:
854 // FIXME: not clear how to mangle this!
855 // template <class T...> class A {
856 // template <class U...> void foo(decltype(T::foo(U())) x...);
857 // };
858 Out << "_SUBSTPACK_";
859 break;
860
861 // <unresolved-type> ::= <template-param>
862 // ::= <decltype>
863 // ::= <template-template-param> <template-args>
864 // (this last is not official yet)
865 case Type::TypeOfExpr:
866 case Type::TypeOf:
867 case Type::Decltype:
868 case Type::TemplateTypeParm:
869 case Type::UnaryTransform:
870 case Type::SubstTemplateTypeParm:
871 unresolvedType:
872 assert(!qualifier->getPrefix());
873
874 // We only get here recursively if we're followed by identifiers.
875 if (recursive) Out << 'N';
876
877 // This seems to do everything we want. It's not really
878 // sanctioned for a substituted template parameter, though.
879 mangleType(QualType(type, 0));
880
881 // We never want to print 'E' directly after an unresolved-type,
882 // so we return directly.
883 return;
884
885 case Type::Typedef:
886 mangleSourceName(cast<TypedefType>(type)->getDecl()->getIdentifier());
887 break;
888
889 case Type::UnresolvedUsing:
890 mangleSourceName(cast<UnresolvedUsingType>(type)->getDecl()
891 ->getIdentifier());
892 break;
893
894 case Type::Record:
895 mangleSourceName(cast<RecordType>(type)->getDecl()->getIdentifier());
896 break;
897
898 case Type::TemplateSpecialization: {
899 const TemplateSpecializationType *tst
900 = cast<TemplateSpecializationType>(type);
901 TemplateName name = tst->getTemplateName();
902 switch (name.getKind()) {
903 case TemplateName::Template:
904 case TemplateName::QualifiedTemplate: {
905 TemplateDecl *temp = name.getAsTemplateDecl();
906
907 // If the base is a template template parameter, this is an
908 // unresolved type.
909 assert(temp && "no template for template specialization type");
910 if (isa<TemplateTemplateParmDecl>(temp)) goto unresolvedType;
911
912 mangleSourceName(temp->getIdentifier());
913 break;
914 }
915
916 case TemplateName::OverloadedTemplate:
917 case TemplateName::DependentTemplate:
918 llvm_unreachable("invalid base for a template specialization type");
919
920 case TemplateName::SubstTemplateTemplateParm: {
921 SubstTemplateTemplateParmStorage *subst
922 = name.getAsSubstTemplateTemplateParm();
923 mangleExistingSubstitution(subst->getReplacement());
924 break;
925 }
926
927 case TemplateName::SubstTemplateTemplateParmPack: {
928 // FIXME: not clear how to mangle this!
929 // template <template <class U> class T...> class A {
930 // template <class U...> void foo(decltype(T<U>::foo) x...);
931 // };
932 Out << "_SUBSTPACK_";
933 break;
934 }
935 }
936
937 mangleTemplateArgs(tst->getArgs(), tst->getNumArgs());
938 break;
939 }
940
941 case Type::InjectedClassName:
942 mangleSourceName(cast<InjectedClassNameType>(type)->getDecl()
943 ->getIdentifier());
944 break;
945
946 case Type::DependentName:
947 mangleSourceName(cast<DependentNameType>(type)->getIdentifier());
948 break;
949
950 case Type::DependentTemplateSpecialization: {
951 const DependentTemplateSpecializationType *tst
952 = cast<DependentTemplateSpecializationType>(type);
953 mangleSourceName(tst->getIdentifier());
954 mangleTemplateArgs(tst->getArgs(), tst->getNumArgs());
955 break;
956 }
957 }
958 break;
959 }
960
961 case NestedNameSpecifier::Identifier:
962 // Member expressions can have these without prefixes.
963 if (qualifier->getPrefix()) {
964 mangleUnresolvedPrefix(qualifier->getPrefix(), firstQualifierLookup,
965 /*recursive*/ true);
966 } else if (firstQualifierLookup) {
967
968 // Try to make a proper qualifier out of the lookup result, and
969 // then just recurse on that.
970 NestedNameSpecifier *newQualifier;
971 if (TypeDecl *typeDecl = dyn_cast<TypeDecl>(firstQualifierLookup)) {
972 QualType type = getASTContext().getTypeDeclType(typeDecl);
973
974 // Pretend we had a different nested name specifier.
975 newQualifier = NestedNameSpecifier::Create(getASTContext(),
976 /*prefix*/ 0,
977 /*template*/ false,
978 type.getTypePtr());
979 } else if (NamespaceDecl *nspace =
980 dyn_cast<NamespaceDecl>(firstQualifierLookup)) {
981 newQualifier = NestedNameSpecifier::Create(getASTContext(),
982 /*prefix*/ 0,
983 nspace);
984 } else if (NamespaceAliasDecl *alias =
985 dyn_cast<NamespaceAliasDecl>(firstQualifierLookup)) {
986 newQualifier = NestedNameSpecifier::Create(getASTContext(),
987 /*prefix*/ 0,
988 alias);
989 } else {
990 // No sensible mangling to do here.
991 newQualifier = 0;
992 }
993
994 if (newQualifier)
995 return mangleUnresolvedPrefix(newQualifier, /*lookup*/ 0, recursive);
996
997 } else {
998 Out << "sr";
999 }
1000
1001 mangleSourceName(qualifier->getAsIdentifier());
1002 break;
1003 }
1004
1005 // If this was the innermost part of the NNS, and we fell out to
1006 // here, append an 'E'.
1007 if (!recursive)
1008 Out << 'E';
1009}
1010
1011/// Mangle an unresolved-name, which is generally used for names which
1012/// weren't resolved to specific entities.
1013void CXXNameMangler::mangleUnresolvedName(NestedNameSpecifier *qualifier,
1014 NamedDecl *firstQualifierLookup,
1015 DeclarationName name,
1016 unsigned knownArity) {
1017 if (qualifier) mangleUnresolvedPrefix(qualifier, firstQualifierLookup);
1018 mangleUnqualifiedName(0, name, knownArity);
1019}
1020
1021static const FieldDecl *FindFirstNamedDataMember(const RecordDecl *RD) {
1022 assert(RD->isAnonymousStructOrUnion() &&
1023 "Expected anonymous struct or union!");
1024
1025 for (RecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
1026 I != E; ++I) {
1027 if (I->getIdentifier())
1028 return *I;
1029
1030 if (const RecordType *RT = I->getType()->getAs<RecordType>())
1031 if (const FieldDecl *NamedDataMember =
1032 FindFirstNamedDataMember(RT->getDecl()))
1033 return NamedDataMember;
1034 }
1035
1036 // We didn't find a named data member.
1037 return 0;
1038}
1039
1040void CXXNameMangler::mangleUnqualifiedName(const NamedDecl *ND,
1041 DeclarationName Name,
1042 unsigned KnownArity) {
1043 // <unqualified-name> ::= <operator-name>
1044 // ::= <ctor-dtor-name>
1045 // ::= <source-name>
1046 switch (Name.getNameKind()) {
1047 case DeclarationName::Identifier: {
1048 if (const IdentifierInfo *II = Name.getAsIdentifierInfo()) {
1049 // We must avoid conflicts between internally- and externally-
1050 // linked variable and function declaration names in the same TU:
1051 // void test() { extern void foo(); }
1052 // static void foo();
1053 // This naming convention is the same as that followed by GCC,
1054 // though it shouldn't actually matter.
1055 if (ND && ND->getLinkage() == InternalLinkage &&
1056 getEffectiveDeclContext(ND)->isFileContext())
1057 Out << 'L';
1058
1059 mangleSourceName(II);
1060 break;
1061 }
1062
1063 // Otherwise, an anonymous entity. We must have a declaration.
1064 assert(ND && "mangling empty name without declaration");
1065
1066 if (const NamespaceDecl *NS = dyn_cast<NamespaceDecl>(ND)) {
1067 if (NS->isAnonymousNamespace()) {
1068 // This is how gcc mangles these names.
1069 Out << "12_GLOBAL__N_1";
1070 break;
1071 }
1072 }
1073
1074 if (const VarDecl *VD = dyn_cast<VarDecl>(ND)) {
1075 // We must have an anonymous union or struct declaration.
1076 const RecordDecl *RD =
1077 cast<RecordDecl>(VD->getType()->getAs<RecordType>()->getDecl());
1078
1079 // Itanium C++ ABI 5.1.2:
1080 //
1081 // For the purposes of mangling, the name of an anonymous union is
1082 // considered to be the name of the first named data member found by a
1083 // pre-order, depth-first, declaration-order walk of the data members of
1084 // the anonymous union. If there is no such data member (i.e., if all of
1085 // the data members in the union are unnamed), then there is no way for
1086 // a program to refer to the anonymous union, and there is therefore no
1087 // need to mangle its name.
1088 const FieldDecl *FD = FindFirstNamedDataMember(RD);
1089
1090 // It's actually possible for various reasons for us to get here
1091 // with an empty anonymous struct / union. Fortunately, it
1092 // doesn't really matter what name we generate.
1093 if (!FD) break;
1094 assert(FD->getIdentifier() && "Data member name isn't an identifier!");
1095
1096 mangleSourceName(FD->getIdentifier());
1097 break;
1098 }
1099
1100 // We must have an anonymous struct.
1101 const TagDecl *TD = cast<TagDecl>(ND);
1102 if (const TypedefNameDecl *D = TD->getTypedefNameForAnonDecl()) {
1103 assert(TD->getDeclContext() == D->getDeclContext() &&
1104 "Typedef should not be in another decl context!");
1105 assert(D->getDeclName().getAsIdentifierInfo() &&
1106 "Typedef was not named!");
1107 mangleSourceName(D->getDeclName().getAsIdentifierInfo());
1108 break;
1109 }
1110
1111 // <unnamed-type-name> ::= <closure-type-name>
1112 //
1113 // <closure-type-name> ::= Ul <lambda-sig> E [ <nonnegative number> ] _
1114 // <lambda-sig> ::= <parameter-type>+ # Parameter types or 'v' for 'void'.
1115 if (const CXXRecordDecl *Record = dyn_cast<CXXRecordDecl>(TD)) {
1116 if (Record->isLambda() && Record->getLambdaManglingNumber()) {
1117 mangleLambda(Record);
1118 break;
1119 }
1120 }
1121
1122 int UnnamedMangle = Context.getASTContext().getUnnamedTagManglingNumber(TD);
1123 if (UnnamedMangle != -1) {
1124 Out << "Ut";
1125 if (UnnamedMangle != 0)
1126 Out << llvm::utostr(UnnamedMangle - 1);
1127 Out << '_';
1128 break;
1129 }
1130
1131 // Get a unique id for the anonymous struct.
1132 uint64_t AnonStructId = Context.getAnonymousStructId(TD);
1133
1134 // Mangle it as a source name in the form
1135 // [n] $_<id>
1136 // where n is the length of the string.
1137 SmallString<8> Str;
1138 Str += "$_";
1139 Str += llvm::utostr(AnonStructId);
1140
1141 Out << Str.size();
1142 Out << Str.str();
1143 break;
1144 }
1145
1146 case DeclarationName::ObjCZeroArgSelector:
1147 case DeclarationName::ObjCOneArgSelector:
1148 case DeclarationName::ObjCMultiArgSelector:
1149 llvm_unreachable("Can't mangle Objective-C selector names here!");
1150
1151 case DeclarationName::CXXConstructorName:
1152 if (ND == Structor)
1153 // If the named decl is the C++ constructor we're mangling, use the type
1154 // we were given.
1155 mangleCXXCtorType(static_cast<CXXCtorType>(StructorType));
1156 else
1157 // Otherwise, use the complete constructor name. This is relevant if a
1158 // class with a constructor is declared within a constructor.
1159 mangleCXXCtorType(Ctor_Complete);
1160 break;
1161
1162 case DeclarationName::CXXDestructorName:
1163 if (ND == Structor)
1164 // If the named decl is the C++ destructor we're mangling, use the type we
1165 // were given.
1166 mangleCXXDtorType(static_cast<CXXDtorType>(StructorType));
1167 else
1168 // Otherwise, use the complete destructor name. This is relevant if a
1169 // class with a destructor is declared within a destructor.
1170 mangleCXXDtorType(Dtor_Complete);
1171 break;
1172
1173 case DeclarationName::CXXConversionFunctionName:
1174 // <operator-name> ::= cv <type> # (cast)
1175 Out << "cv";
1176 mangleType(Name.getCXXNameType());
1177 break;
1178
1179 case DeclarationName::CXXOperatorName: {
1180 unsigned Arity;
1181 if (ND) {
1182 Arity = cast<FunctionDecl>(ND)->getNumParams();
1183
1184 // If we have a C++ member function, we need to include the 'this' pointer.
1185 // FIXME: This does not make sense for operators that are static, but their
1186 // names stay the same regardless of the arity (operator new for instance).
1187 if (isa<CXXMethodDecl>(ND))
1188 Arity++;
1189 } else
1190 Arity = KnownArity;
1191
1192 mangleOperatorName(Name.getCXXOverloadedOperator(), Arity);
1193 break;
1194 }
1195
1196 case DeclarationName::CXXLiteralOperatorName:
1197 // FIXME: This mangling is not yet official.
1198 Out << "li";
1199 mangleSourceName(Name.getCXXLiteralIdentifier());
1200 break;
1201
1202 case DeclarationName::CXXUsingDirective:
1203 llvm_unreachable("Can't mangle a using directive name!");
1204 }
1205}
1206
1207void CXXNameMangler::mangleSourceName(const IdentifierInfo *II) {
1208 // <source-name> ::= <positive length number> <identifier>
1209 // <number> ::= [n] <non-negative decimal integer>
1210 // <identifier> ::= <unqualified source code identifier>
1211 Out << II->getLength() << II->getName();
1212}
1213
1214void CXXNameMangler::mangleNestedName(const NamedDecl *ND,
1215 const DeclContext *DC,
1216 bool NoFunction) {
1217 // <nested-name>
1218 // ::= N [<CV-qualifiers>] [<ref-qualifier>] <prefix> <unqualified-name> E
1219 // ::= N [<CV-qualifiers>] [<ref-qualifier>] <template-prefix>
1220 // <template-args> E
1221
1222 Out << 'N';
1223 if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(ND)) {
1224 mangleQualifiers(Qualifiers::fromCVRMask(Method->getTypeQualifiers()));
1225 mangleRefQualifier(Method->getRefQualifier());
1226 }
1227
1228 // Check if we have a template.
1229 const TemplateArgumentList *TemplateArgs = 0;
1230 if (const TemplateDecl *TD = isTemplate(ND, TemplateArgs)) {
1231 mangleTemplatePrefix(TD);
1232 mangleTemplateArgs(*TemplateArgs);
1233 }
1234 else {
1235 manglePrefix(DC, NoFunction);
1236 mangleUnqualifiedName(ND);
1237 }
1238
1239 Out << 'E';
1240}
1241void CXXNameMangler::mangleNestedName(const TemplateDecl *TD,
1242 const TemplateArgument *TemplateArgs,
1243 unsigned NumTemplateArgs) {
1244 // <nested-name> ::= N [<CV-qualifiers>] <template-prefix> <template-args> E
1245
1246 Out << 'N';
1247
1248 mangleTemplatePrefix(TD);
1249 mangleTemplateArgs(TemplateArgs, NumTemplateArgs);
1250
1251 Out << 'E';
1252}
1253
1254void CXXNameMangler::mangleLocalName(const NamedDecl *ND) {
1255 // <local-name> := Z <function encoding> E <entity name> [<discriminator>]
1256 // := Z <function encoding> E s [<discriminator>]
1257 // <local-name> := Z <function encoding> E d [ <parameter number> ]
1258 // _ <entity name>
1259 // <discriminator> := _ <non-negative number>
1260 const DeclContext *DC = getEffectiveDeclContext(ND);
1261 if (isa<ObjCMethodDecl>(DC) && isa<FunctionDecl>(ND)) {
1262 // Don't add objc method name mangling to locally declared function
1263 mangleUnqualifiedName(ND);
1264 return;
1265 }
1266
1267 Out << 'Z';
1268
1269 if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(DC)) {
1270 mangleObjCMethodName(MD);
1271 } else if (const CXXRecordDecl *RD = GetLocalClassDecl(ND)) {
1272 mangleFunctionEncoding(cast<FunctionDecl>(getEffectiveDeclContext(RD)));
1273 Out << 'E';
1274
1275 // The parameter number is omitted for the last parameter, 0 for the
1276 // second-to-last parameter, 1 for the third-to-last parameter, etc. The
1277 // <entity name> will of course contain a <closure-type-name>: Its
1278 // numbering will be local to the particular argument in which it appears
1279 // -- other default arguments do not affect its encoding.
1280 bool SkipDiscriminator = false;
1281 if (RD->isLambda()) {
1282 if (const ParmVarDecl *Parm
1283 = dyn_cast_or_null<ParmVarDecl>(RD->getLambdaContextDecl())) {
1284 if (const FunctionDecl *Func
1285 = dyn_cast<FunctionDecl>(Parm->getDeclContext())) {
1286 Out << 'd';
1287 unsigned Num = Func->getNumParams() - Parm->getFunctionScopeIndex();
1288 if (Num > 1)
1289 mangleNumber(Num - 2);
1290 Out << '_';
1291 SkipDiscriminator = true;
1292 }
1293 }
1294 }
1295
1296 // Mangle the name relative to the closest enclosing function.
1297 if (ND == RD) // equality ok because RD derived from ND above
1298 mangleUnqualifiedName(ND);
1299 else
1300 mangleNestedName(ND, DC, true /*NoFunction*/);
1301
1302 if (!SkipDiscriminator) {
1303 unsigned disc;
1304 if (Context.getNextDiscriminator(RD, disc)) {
1305 if (disc < 10)
1306 Out << '_' << disc;
1307 else
1308 Out << "__" << disc << '_';
1309 }
1310 }
1311
1312 return;
1313 }
1314 else
1315 mangleFunctionEncoding(cast<FunctionDecl>(DC));
1316
1317 Out << 'E';
1318 mangleUnqualifiedName(ND);
1319}
1320
1321void CXXNameMangler::mangleLambda(const CXXRecordDecl *Lambda) {
1322 // If the context of a closure type is an initializer for a class member
1323 // (static or nonstatic), it is encoded in a qualified name with a final
1324 // <prefix> of the form:
1325 //
1326 // <data-member-prefix> := <member source-name> M
1327 //
1328 // Technically, the data-member-prefix is part of the <prefix>. However,
1329 // since a closure type will always be mangled with a prefix, it's easier
1330 // to emit that last part of the prefix here.
1331 if (Decl *Context = Lambda->getLambdaContextDecl()) {
1332 if ((isa<VarDecl>(Context) || isa<FieldDecl>(Context)) &&
1333 Context->getDeclContext()->isRecord()) {
1334 if (const IdentifierInfo *Name
1335 = cast<NamedDecl>(Context)->getIdentifier()) {
1336 mangleSourceName(Name);
1337 Out << 'M';
1338 }
1339 }
1340 }
1341
1342 Out << "Ul";
1343 const FunctionProtoType *Proto = Lambda->getLambdaTypeInfo()->getType()->
1344 getAs<FunctionProtoType>();
1345 mangleBareFunctionType(Proto, /*MangleReturnType=*/false);
1346 Out << "E";
1347
1348 // The number is omitted for the first closure type with a given
1349 // <lambda-sig> in a given context; it is n-2 for the nth closure type
1350 // (in lexical order) with that same <lambda-sig> and context.
1351 //
1352 // The AST keeps track of the number for us.
1353 unsigned Number = Lambda->getLambdaManglingNumber();
1354 assert(Number > 0 && "Lambda should be mangled as an unnamed class");
1355 if (Number > 1)
1356 mangleNumber(Number - 2);
1357 Out << '_';
1358}
1359
1360void CXXNameMangler::manglePrefix(NestedNameSpecifier *qualifier) {
1361 switch (qualifier->getKind()) {
1362 case NestedNameSpecifier::Global:
1363 // nothing
1364 return;
1365
1366 case NestedNameSpecifier::Namespace:
1367 mangleName(qualifier->getAsNamespace());
1368 return;
1369
1370 case NestedNameSpecifier::NamespaceAlias:
1371 mangleName(qualifier->getAsNamespaceAlias()->getNamespace());
1372 return;
1373
1374 case NestedNameSpecifier::TypeSpec:
1375 case NestedNameSpecifier::TypeSpecWithTemplate:
1376 manglePrefix(QualType(qualifier->getAsType(), 0));
1377 return;
1378
1379 case NestedNameSpecifier::Identifier:
1380 // Member expressions can have these without prefixes, but that
1381 // should end up in mangleUnresolvedPrefix instead.
1382 assert(qualifier->getPrefix());
1383 manglePrefix(qualifier->getPrefix());
1384
1385 mangleSourceName(qualifier->getAsIdentifier());
1386 return;
1387 }
1388
1389 llvm_unreachable("unexpected nested name specifier");
1390}
1391
1392void CXXNameMangler::manglePrefix(const DeclContext *DC, bool NoFunction) {
1393 // <prefix> ::= <prefix> <unqualified-name>
1394 // ::= <template-prefix> <template-args>
1395 // ::= <template-param>
1396 // ::= # empty
1397 // ::= <substitution>
1398
1399 DC = IgnoreLinkageSpecDecls(DC);
1400
1401 if (DC->isTranslationUnit())
1402 return;
1403
1404 if (const BlockDecl *Block = dyn_cast<BlockDecl>(DC)) {
1405 manglePrefix(getEffectiveParentContext(DC), NoFunction);
1406 SmallString<64> Name;
1407 llvm::raw_svector_ostream NameStream(Name);
1408 Context.mangleBlock(Block, NameStream);
1409 NameStream.flush();
1410 Out << Name.size() << Name;
1411 return;
1412 }
1413
1414 const NamedDecl *ND = cast<NamedDecl>(DC);
1415 if (mangleSubstitution(ND))
1416 return;
1417
1418 // Check if we have a template.
1419 const TemplateArgumentList *TemplateArgs = 0;
1420 if (const TemplateDecl *TD = isTemplate(ND, TemplateArgs)) {
1421 mangleTemplatePrefix(TD);
1422 mangleTemplateArgs(*TemplateArgs);
1423 }
1424 else if(NoFunction && (isa<FunctionDecl>(ND) || isa<ObjCMethodDecl>(ND)))
1425 return;
1426 else if (const ObjCMethodDecl *Method = dyn_cast<ObjCMethodDecl>(ND))
1427 mangleObjCMethodName(Method);
1428 else {
1429 manglePrefix(getEffectiveDeclContext(ND), NoFunction);
1430 mangleUnqualifiedName(ND);
1431 }
1432
1433 addSubstitution(ND);
1434}
1435
1436void CXXNameMangler::mangleTemplatePrefix(TemplateName Template) {
1437 // <template-prefix> ::= <prefix> <template unqualified-name>
1438 // ::= <template-param>
1439 // ::= <substitution>
1440 if (TemplateDecl *TD = Template.getAsTemplateDecl())
1441 return mangleTemplatePrefix(TD);
1442
1443 if (QualifiedTemplateName *Qualified = Template.getAsQualifiedTemplateName())
1444 manglePrefix(Qualified->getQualifier());
1445
1446 if (OverloadedTemplateStorage *Overloaded
1447 = Template.getAsOverloadedTemplate()) {
1448 mangleUnqualifiedName(0, (*Overloaded->begin())->getDeclName(),
1449 UnknownArity);
1450 return;
1451 }
1452
1453 DependentTemplateName *Dependent = Template.getAsDependentTemplateName();
1454 assert(Dependent && "Unknown template name kind?");
1455 manglePrefix(Dependent->getQualifier());
1456 mangleUnscopedTemplateName(Template);
1457}
1458
1459void CXXNameMangler::mangleTemplatePrefix(const TemplateDecl *ND) {
1460 // <template-prefix> ::= <prefix> <template unqualified-name>
1461 // ::= <template-param>
1462 // ::= <substitution>
1463 // <template-template-param> ::= <template-param>
1464 // <substitution>
1465
1466 if (mangleSubstitution(ND))
1467 return;
1468
1469 // <template-template-param> ::= <template-param>
1470 if (const TemplateTemplateParmDecl *TTP
1471 = dyn_cast<TemplateTemplateParmDecl>(ND)) {
1472 mangleTemplateParameter(TTP->getIndex());
1473 return;
1474 }
1475
1476 manglePrefix(getEffectiveDeclContext(ND));
1477 mangleUnqualifiedName(ND->getTemplatedDecl());
1478 addSubstitution(ND);
1479}
1480
1481/// Mangles a template name under the production <type>. Required for
1482/// template template arguments.
1483/// <type> ::= <class-enum-type>
1484/// ::= <template-param>
1485/// ::= <substitution>
1486void CXXNameMangler::mangleType(TemplateName TN) {
1487 if (mangleSubstitution(TN))
1488 return;
1489
1490 TemplateDecl *TD = 0;
1491
1492 switch (TN.getKind()) {
1493 case TemplateName::QualifiedTemplate:
1494 TD = TN.getAsQualifiedTemplateName()->getTemplateDecl();
1495 goto HaveDecl;
1496
1497 case TemplateName::Template:
1498 TD = TN.getAsTemplateDecl();
1499 goto HaveDecl;
1500
1501 HaveDecl:
1502 if (isa<TemplateTemplateParmDecl>(TD))
1503 mangleTemplateParameter(cast<TemplateTemplateParmDecl>(TD)->getIndex());
1504 else
1505 mangleName(TD);
1506 break;
1507
1508 case TemplateName::OverloadedTemplate:
1509 llvm_unreachable("can't mangle an overloaded template name as a <type>");
1510
1511 case TemplateName::DependentTemplate: {
1512 const DependentTemplateName *Dependent = TN.getAsDependentTemplateName();
1513 assert(Dependent->isIdentifier());
1514
1515 // <class-enum-type> ::= <name>
1516 // <name> ::= <nested-name>
1517 mangleUnresolvedPrefix(Dependent->getQualifier(), 0);
1518 mangleSourceName(Dependent->getIdentifier());
1519 break;
1520 }
1521
1522 case TemplateName::SubstTemplateTemplateParm: {
1523 // Substituted template parameters are mangled as the substituted
1524 // template. This will check for the substitution twice, which is
1525 // fine, but we have to return early so that we don't try to *add*
1526 // the substitution twice.
1527 SubstTemplateTemplateParmStorage *subst
1528 = TN.getAsSubstTemplateTemplateParm();
1529 mangleType(subst->getReplacement());
1530 return;
1531 }
1532
1533 case TemplateName::SubstTemplateTemplateParmPack: {
1534 // FIXME: not clear how to mangle this!
1535 // template <template <class> class T...> class A {
1536 // template <template <class> class U...> void foo(B<T,U> x...);
1537 // };
1538 Out << "_SUBSTPACK_";
1539 break;
1540 }
1541 }
1542
1543 addSubstitution(TN);
1544}
1545
1546void
1547CXXNameMangler::mangleOperatorName(OverloadedOperatorKind OO, unsigned Arity) {
1548 switch (OO) {
1549 // <operator-name> ::= nw # new
1550 case OO_New: Out << "nw"; break;
1551 // ::= na # new[]
1552 case OO_Array_New: Out << "na"; break;
1553 // ::= dl # delete
1554 case OO_Delete: Out << "dl"; break;
1555 // ::= da # delete[]
1556 case OO_Array_Delete: Out << "da"; break;
1557 // ::= ps # + (unary)
1558 // ::= pl # + (binary or unknown)
1559 case OO_Plus:
1560 Out << (Arity == 1? "ps" : "pl"); break;
1561 // ::= ng # - (unary)
1562 // ::= mi # - (binary or unknown)
1563 case OO_Minus:
1564 Out << (Arity == 1? "ng" : "mi"); break;
1565 // ::= ad # & (unary)
1566 // ::= an # & (binary or unknown)
1567 case OO_Amp:
1568 Out << (Arity == 1? "ad" : "an"); break;
1569 // ::= de # * (unary)
1570 // ::= ml # * (binary or unknown)
1571 case OO_Star:
1572 // Use binary when unknown.
1573 Out << (Arity == 1? "de" : "ml"); break;
1574 // ::= co # ~
1575 case OO_Tilde: Out << "co"; break;
1576 // ::= dv # /
1577 case OO_Slash: Out << "dv"; break;
1578 // ::= rm # %
1579 case OO_Percent: Out << "rm"; break;
1580 // ::= or # |
1581 case OO_Pipe: Out << "or"; break;
1582 // ::= eo # ^
1583 case OO_Caret: Out << "eo"; break;
1584 // ::= aS # =
1585 case OO_Equal: Out << "aS"; break;
1586 // ::= pL # +=
1587 case OO_PlusEqual: Out << "pL"; break;
1588 // ::= mI # -=
1589 case OO_MinusEqual: Out << "mI"; break;
1590 // ::= mL # *=
1591 case OO_StarEqual: Out << "mL"; break;
1592 // ::= dV # /=
1593 case OO_SlashEqual: Out << "dV"; break;
1594 // ::= rM # %=
1595 case OO_PercentEqual: Out << "rM"; break;
1596 // ::= aN # &=
1597 case OO_AmpEqual: Out << "aN"; break;
1598 // ::= oR # |=
1599 case OO_PipeEqual: Out << "oR"; break;
1600 // ::= eO # ^=
1601 case OO_CaretEqual: Out << "eO"; break;
1602 // ::= ls # <<
1603 case OO_LessLess: Out << "ls"; break;
1604 // ::= rs # >>
1605 case OO_GreaterGreater: Out << "rs"; break;
1606 // ::= lS # <<=
1607 case OO_LessLessEqual: Out << "lS"; break;
1608 // ::= rS # >>=
1609 case OO_GreaterGreaterEqual: Out << "rS"; break;
1610 // ::= eq # ==
1611 case OO_EqualEqual: Out << "eq"; break;
1612 // ::= ne # !=
1613 case OO_ExclaimEqual: Out << "ne"; break;
1614 // ::= lt # <
1615 case OO_Less: Out << "lt"; break;
1616 // ::= gt # >
1617 case OO_Greater: Out << "gt"; break;
1618 // ::= le # <=
1619 case OO_LessEqual: Out << "le"; break;
1620 // ::= ge # >=
1621 case OO_GreaterEqual: Out << "ge"; break;
1622 // ::= nt # !
1623 case OO_Exclaim: Out << "nt"; break;
1624 // ::= aa # &&
1625 case OO_AmpAmp: Out << "aa"; break;
1626 // ::= oo # ||
1627 case OO_PipePipe: Out << "oo"; break;
1628 // ::= pp # ++
1629 case OO_PlusPlus: Out << "pp"; break;
1630 // ::= mm # --
1631 case OO_MinusMinus: Out << "mm"; break;
1632 // ::= cm # ,
1633 case OO_Comma: Out << "cm"; break;
1634 // ::= pm # ->*
1635 case OO_ArrowStar: Out << "pm"; break;
1636 // ::= pt # ->
1637 case OO_Arrow: Out << "pt"; break;
1638 // ::= cl # ()
1639 case OO_Call: Out << "cl"; break;
1640 // ::= ix # []
1641 case OO_Subscript: Out << "ix"; break;
1642
1643 // ::= qu # ?
1644 // The conditional operator can't be overloaded, but we still handle it when
1645 // mangling expressions.
1646 case OO_Conditional: Out << "qu"; break;
1647
1648 case OO_None:
1649 case NUM_OVERLOADED_OPERATORS:
1650 llvm_unreachable("Not an overloaded operator");
1651 }
1652}
1653
1654void CXXNameMangler::mangleQualifiers(Qualifiers Quals) {
1655 // <CV-qualifiers> ::= [r] [V] [K] # restrict (C99), volatile, const
1656 if (Quals.hasRestrict())
1657 Out << 'r';
1658 if (Quals.hasVolatile())
1659 Out << 'V';
1660 if (Quals.hasConst())
1661 Out << 'K';
1662
1663 if (Quals.hasAddressSpace()) {
1664 // Extension:
1665 //
1666 // <type> ::= U <address-space-number>
1667 //
1668 // where <address-space-number> is a source name consisting of 'AS'
1669 // followed by the address space <number>.
1670 SmallString<64> ASString;
1671 ASString = "AS" + llvm::utostr_32(Quals.getAddressSpace());
1672 Out << 'U' << ASString.size() << ASString;
1673 }
1674
1675 StringRef LifetimeName;
1676 switch (Quals.getObjCLifetime()) {
1677 // Objective-C ARC Extension:
1678 //
1679 // <type> ::= U "__strong"
1680 // <type> ::= U "__weak"
1681 // <type> ::= U "__autoreleasing"
1682 case Qualifiers::OCL_None:
1683 break;
1684
1685 case Qualifiers::OCL_Weak:
1686 LifetimeName = "__weak";
1687 break;
1688
1689 case Qualifiers::OCL_Strong:
1690 LifetimeName = "__strong";
1691 break;
1692
1693 case Qualifiers::OCL_Autoreleasing:
1694 LifetimeName = "__autoreleasing";
1695 break;
1696
1697 case Qualifiers::OCL_ExplicitNone:
1698 // The __unsafe_unretained qualifier is *not* mangled, so that
1699 // __unsafe_unretained types in ARC produce the same manglings as the
1700 // equivalent (but, naturally, unqualified) types in non-ARC, providing
1701 // better ABI compatibility.
1702 //
1703 // It's safe to do this because unqualified 'id' won't show up
1704 // in any type signatures that need to be mangled.
1705 break;
1706 }
1707 if (!LifetimeName.empty())
1708 Out << 'U' << LifetimeName.size() << LifetimeName;
1709}
1710
1711void CXXNameMangler::mangleRefQualifier(RefQualifierKind RefQualifier) {
1712 // <ref-qualifier> ::= R # lvalue reference
1713 // ::= O # rvalue-reference
1714 // Proposal to Itanium C++ ABI list on 1/26/11
1715 switch (RefQualifier) {
1716 case RQ_None:
1717 break;
1718
1719 case RQ_LValue:
1720 Out << 'R';
1721 break;
1722
1723 case RQ_RValue:
1724 Out << 'O';
1725 break;
1726 }
1727}
1728
1729void CXXNameMangler::mangleObjCMethodName(const ObjCMethodDecl *MD) {
1730 Context.mangleObjCMethodName(MD, Out);
1731}
1732
1733void CXXNameMangler::mangleType(QualType T) {
1734 // If our type is instantiation-dependent but not dependent, we mangle
1735 // it as it was written in the source, removing any top-level sugar.
1736 // Otherwise, use the canonical type.
1737 //
1738 // FIXME: This is an approximation of the instantiation-dependent name
1739 // mangling rules, since we should really be using the type as written and
1740 // augmented via semantic analysis (i.e., with implicit conversions and
1741 // default template arguments) for any instantiation-dependent type.
1742 // Unfortunately, that requires several changes to our AST:
1743 // - Instantiation-dependent TemplateSpecializationTypes will need to be
1744 // uniqued, so that we can handle substitutions properly
1745 // - Default template arguments will need to be represented in the
1746 // TemplateSpecializationType, since they need to be mangled even though
1747 // they aren't written.
1748 // - Conversions on non-type template arguments need to be expressed, since
1749 // they can affect the mangling of sizeof/alignof.
1750 if (!T->isInstantiationDependentType() || T->isDependentType())
1751 T = T.getCanonicalType();
1752 else {
1753 // Desugar any types that are purely sugar.
1754 do {
1755 // Don't desugar through template specialization types that aren't
1756 // type aliases. We need to mangle the template arguments as written.
1757 if (const TemplateSpecializationType *TST
1758 = dyn_cast<TemplateSpecializationType>(T))
1759 if (!TST->isTypeAlias())
1760 break;
1761
1762 QualType Desugared
1763 = T.getSingleStepDesugaredType(Context.getASTContext());
1764 if (Desugared == T)
1765 break;
1766
1767 T = Desugared;
1768 } while (true);
1769 }
1770 SplitQualType split = T.split();
1771 Qualifiers quals = split.Quals;
1772 const Type *ty = split.Ty;
1773
1774 bool isSubstitutable = quals || !isa<BuiltinType>(T);
1775 if (isSubstitutable && mangleSubstitution(T))
1776 return;
1777
1778 // If we're mangling a qualified array type, push the qualifiers to
1779 // the element type.
1780 if (quals && isa<ArrayType>(T)) {
1781 ty = Context.getASTContext().getAsArrayType(T);
1782 quals = Qualifiers();
1783
1784 // Note that we don't update T: we want to add the
1785 // substitution at the original type.
1786 }
1787
1788 if (quals) {
1789 mangleQualifiers(quals);
1790 // Recurse: even if the qualified type isn't yet substitutable,
1791 // the unqualified type might be.
1792 mangleType(QualType(ty, 0));
1793 } else {
1794 switch (ty->getTypeClass()) {
1795#define ABSTRACT_TYPE(CLASS, PARENT)
1796#define NON_CANONICAL_TYPE(CLASS, PARENT) \
1797 case Type::CLASS: \
1798 llvm_unreachable("can't mangle non-canonical type " #CLASS "Type"); \
1799 return;
1800#define TYPE(CLASS, PARENT) \
1801 case Type::CLASS: \
1802 mangleType(static_cast<const CLASS##Type*>(ty)); \
1803 break;
1804#include "clang/AST/TypeNodes.def"
1805 }
1806 }
1807
1808 // Add the substitution.
1809 if (isSubstitutable)
1810 addSubstitution(T);
1811}
1812
1813void CXXNameMangler::mangleNameOrStandardSubstitution(const NamedDecl *ND) {
1814 if (!mangleStandardSubstitution(ND))
1815 mangleName(ND);
1816}
1817
1818void CXXNameMangler::mangleType(const BuiltinType *T) {
1819 // <type> ::= <builtin-type>
1820 // <builtin-type> ::= v # void
1821 // ::= w # wchar_t
1822 // ::= b # bool
1823 // ::= c # char
1824 // ::= a # signed char
1825 // ::= h # unsigned char
1826 // ::= s # short
1827 // ::= t # unsigned short
1828 // ::= i # int
1829 // ::= j # unsigned int
1830 // ::= l # long
1831 // ::= m # unsigned long
1832 // ::= x # long long, __int64
1833 // ::= y # unsigned long long, __int64
1834 // ::= n # __int128
1835 // UNSUPPORTED: ::= o # unsigned __int128
1836 // ::= f # float
1837 // ::= d # double
1838 // ::= e # long double, __float80
1839 // UNSUPPORTED: ::= g # __float128
1840 // UNSUPPORTED: ::= Dd # IEEE 754r decimal floating point (64 bits)
1841 // UNSUPPORTED: ::= De # IEEE 754r decimal floating point (128 bits)
1842 // UNSUPPORTED: ::= Df # IEEE 754r decimal floating point (32 bits)
1843 // ::= Dh # IEEE 754r half-precision floating point (16 bits)
1844 // ::= Di # char32_t
1845 // ::= Ds # char16_t
1846 // ::= Dn # std::nullptr_t (i.e., decltype(nullptr))
1847 // ::= u <source-name> # vendor extended type
1848 switch (T->getKind()) {
1849 case BuiltinType::Void: Out << 'v'; break;
1850 case BuiltinType::Bool: Out << 'b'; break;
1851 case BuiltinType::Char_U: case BuiltinType::Char_S: Out << 'c'; break;
1852 case BuiltinType::UChar: Out << 'h'; break;
1853 case BuiltinType::UShort: Out << 't'; break;
1854 case BuiltinType::UInt: Out << 'j'; break;
1855 case BuiltinType::ULong: Out << 'm'; break;
1856 case BuiltinType::ULongLong: Out << 'y'; break;
1857 case BuiltinType::UInt128: Out << 'o'; break;
1858 case BuiltinType::SChar: Out << 'a'; break;
1859 case BuiltinType::WChar_S:
1860 case BuiltinType::WChar_U: Out << 'w'; break;
1861 case BuiltinType::Char16: Out << "Ds"; break;
1862 case BuiltinType::Char32: Out << "Di"; break;
1863 case BuiltinType::Short: Out << 's'; break;
1864 case BuiltinType::Int: Out << 'i'; break;
1865 case BuiltinType::Long: Out << 'l'; break;
1866 case BuiltinType::LongLong: Out << 'x'; break;
1867 case BuiltinType::Int128: Out << 'n'; break;
1868 case BuiltinType::Half: Out << "Dh"; break;
1869 case BuiltinType::Float: Out << 'f'; break;
1870 case BuiltinType::Double: Out << 'd'; break;
1871 case BuiltinType::LongDouble: Out << 'e'; break;
1872 case BuiltinType::NullPtr: Out << "Dn"; break;
1873
1874#define BUILTIN_TYPE(Id, SingletonId)
1875#define PLACEHOLDER_TYPE(Id, SingletonId) \
1876 case BuiltinType::Id:
1877#include "clang/AST/BuiltinTypes.def"
1878 case BuiltinType::Dependent:
1879 llvm_unreachable("mangling a placeholder type");
1880 case BuiltinType::ObjCId: Out << "11objc_object"; break;
1881 case BuiltinType::ObjCClass: Out << "10objc_class"; break;
1882 case BuiltinType::ObjCSel: Out << "13objc_selector"; break;
Guy Benyeib13621d2012-12-18 14:38:23 +00001883 case BuiltinType::OCLImage1d: Out << "11ocl_image1d"; break;
1884 case BuiltinType::OCLImage1dArray: Out << "16ocl_image1darray"; break;
1885 case BuiltinType::OCLImage1dBuffer: Out << "17ocl_image1dbuffer"; break;
1886 case BuiltinType::OCLImage2d: Out << "11ocl_image2d"; break;
1887 case BuiltinType::OCLImage2dArray: Out << "16ocl_image2darray"; break;
1888 case BuiltinType::OCLImage3d: Out << "11ocl_image3d"; break;
Guy Benyeie6b9d802013-01-20 12:31:11 +00001889 case BuiltinType::OCLEvent: Out << "9ocl_event"; break;
Guy Benyei7f92f2d2012-12-18 14:30:41 +00001890 }
1891}
1892
1893// <type> ::= <function-type>
1894// <function-type> ::= [<CV-qualifiers>] F [Y]
1895// <bare-function-type> [<ref-qualifier>] E
1896// (Proposal to cxx-abi-dev, 2012-05-11)
1897void CXXNameMangler::mangleType(const FunctionProtoType *T) {
1898 // Mangle CV-qualifiers, if present. These are 'this' qualifiers,
1899 // e.g. "const" in "int (A::*)() const".
1900 mangleQualifiers(Qualifiers::fromCVRMask(T->getTypeQuals()));
1901
1902 Out << 'F';
1903
1904 // FIXME: We don't have enough information in the AST to produce the 'Y'
1905 // encoding for extern "C" function types.
1906 mangleBareFunctionType(T, /*MangleReturnType=*/true);
1907
1908 // Mangle the ref-qualifier, if present.
1909 mangleRefQualifier(T->getRefQualifier());
1910
1911 Out << 'E';
1912}
1913void CXXNameMangler::mangleType(const FunctionNoProtoType *T) {
1914 llvm_unreachable("Can't mangle K&R function prototypes");
1915}
1916void CXXNameMangler::mangleBareFunctionType(const FunctionType *T,
1917 bool MangleReturnType) {
1918 // We should never be mangling something without a prototype.
1919 const FunctionProtoType *Proto = cast<FunctionProtoType>(T);
1920
1921 // Record that we're in a function type. See mangleFunctionParam
1922 // for details on what we're trying to achieve here.
1923 FunctionTypeDepthState saved = FunctionTypeDepth.push();
1924
1925 // <bare-function-type> ::= <signature type>+
1926 if (MangleReturnType) {
1927 FunctionTypeDepth.enterResultType();
1928 mangleType(Proto->getResultType());
1929 FunctionTypeDepth.leaveResultType();
1930 }
1931
1932 if (Proto->getNumArgs() == 0 && !Proto->isVariadic()) {
1933 // <builtin-type> ::= v # void
1934 Out << 'v';
1935
1936 FunctionTypeDepth.pop(saved);
1937 return;
1938 }
1939
1940 for (FunctionProtoType::arg_type_iterator Arg = Proto->arg_type_begin(),
1941 ArgEnd = Proto->arg_type_end();
1942 Arg != ArgEnd; ++Arg)
1943 mangleType(Context.getASTContext().getSignatureParameterType(*Arg));
1944
1945 FunctionTypeDepth.pop(saved);
1946
1947 // <builtin-type> ::= z # ellipsis
1948 if (Proto->isVariadic())
1949 Out << 'z';
1950}
1951
1952// <type> ::= <class-enum-type>
1953// <class-enum-type> ::= <name>
1954void CXXNameMangler::mangleType(const UnresolvedUsingType *T) {
1955 mangleName(T->getDecl());
1956}
1957
1958// <type> ::= <class-enum-type>
1959// <class-enum-type> ::= <name>
1960void CXXNameMangler::mangleType(const EnumType *T) {
1961 mangleType(static_cast<const TagType*>(T));
1962}
1963void CXXNameMangler::mangleType(const RecordType *T) {
1964 mangleType(static_cast<const TagType*>(T));
1965}
1966void CXXNameMangler::mangleType(const TagType *T) {
1967 mangleName(T->getDecl());
1968}
1969
1970// <type> ::= <array-type>
1971// <array-type> ::= A <positive dimension number> _ <element type>
1972// ::= A [<dimension expression>] _ <element type>
1973void CXXNameMangler::mangleType(const ConstantArrayType *T) {
1974 Out << 'A' << T->getSize() << '_';
1975 mangleType(T->getElementType());
1976}
1977void CXXNameMangler::mangleType(const VariableArrayType *T) {
1978 Out << 'A';
1979 // decayed vla types (size 0) will just be skipped.
1980 if (T->getSizeExpr())
1981 mangleExpression(T->getSizeExpr());
1982 Out << '_';
1983 mangleType(T->getElementType());
1984}
1985void CXXNameMangler::mangleType(const DependentSizedArrayType *T) {
1986 Out << 'A';
1987 mangleExpression(T->getSizeExpr());
1988 Out << '_';
1989 mangleType(T->getElementType());
1990}
1991void CXXNameMangler::mangleType(const IncompleteArrayType *T) {
1992 Out << "A_";
1993 mangleType(T->getElementType());
1994}
1995
1996// <type> ::= <pointer-to-member-type>
1997// <pointer-to-member-type> ::= M <class type> <member type>
1998void CXXNameMangler::mangleType(const MemberPointerType *T) {
1999 Out << 'M';
2000 mangleType(QualType(T->getClass(), 0));
2001 QualType PointeeType = T->getPointeeType();
2002 if (const FunctionProtoType *FPT = dyn_cast<FunctionProtoType>(PointeeType)) {
2003 mangleType(FPT);
2004
2005 // Itanium C++ ABI 5.1.8:
2006 //
2007 // The type of a non-static member function is considered to be different,
2008 // for the purposes of substitution, from the type of a namespace-scope or
2009 // static member function whose type appears similar. The types of two
2010 // non-static member functions are considered to be different, for the
2011 // purposes of substitution, if the functions are members of different
2012 // classes. In other words, for the purposes of substitution, the class of
2013 // which the function is a member is considered part of the type of
2014 // function.
2015
2016 // Given that we already substitute member function pointers as a
2017 // whole, the net effect of this rule is just to unconditionally
2018 // suppress substitution on the function type in a member pointer.
2019 // We increment the SeqID here to emulate adding an entry to the
2020 // substitution table.
2021 ++SeqID;
2022 } else
2023 mangleType(PointeeType);
2024}
2025
2026// <type> ::= <template-param>
2027void CXXNameMangler::mangleType(const TemplateTypeParmType *T) {
2028 mangleTemplateParameter(T->getIndex());
2029}
2030
2031// <type> ::= <template-param>
2032void CXXNameMangler::mangleType(const SubstTemplateTypeParmPackType *T) {
2033 // FIXME: not clear how to mangle this!
2034 // template <class T...> class A {
2035 // template <class U...> void foo(T(*)(U) x...);
2036 // };
2037 Out << "_SUBSTPACK_";
2038}
2039
2040// <type> ::= P <type> # pointer-to
2041void CXXNameMangler::mangleType(const PointerType *T) {
2042 Out << 'P';
2043 mangleType(T->getPointeeType());
2044}
2045void CXXNameMangler::mangleType(const ObjCObjectPointerType *T) {
2046 Out << 'P';
2047 mangleType(T->getPointeeType());
2048}
2049
2050// <type> ::= R <type> # reference-to
2051void CXXNameMangler::mangleType(const LValueReferenceType *T) {
2052 Out << 'R';
2053 mangleType(T->getPointeeType());
2054}
2055
2056// <type> ::= O <type> # rvalue reference-to (C++0x)
2057void CXXNameMangler::mangleType(const RValueReferenceType *T) {
2058 Out << 'O';
2059 mangleType(T->getPointeeType());
2060}
2061
2062// <type> ::= C <type> # complex pair (C 2000)
2063void CXXNameMangler::mangleType(const ComplexType *T) {
2064 Out << 'C';
2065 mangleType(T->getElementType());
2066}
2067
2068// ARM's ABI for Neon vector types specifies that they should be mangled as
2069// if they are structs (to match ARM's initial implementation). The
2070// vector type must be one of the special types predefined by ARM.
2071void CXXNameMangler::mangleNeonVectorType(const VectorType *T) {
2072 QualType EltType = T->getElementType();
2073 assert(EltType->isBuiltinType() && "Neon vector element not a BuiltinType");
2074 const char *EltName = 0;
2075 if (T->getVectorKind() == VectorType::NeonPolyVector) {
2076 switch (cast<BuiltinType>(EltType)->getKind()) {
2077 case BuiltinType::SChar: EltName = "poly8_t"; break;
2078 case BuiltinType::Short: EltName = "poly16_t"; break;
2079 default: llvm_unreachable("unexpected Neon polynomial vector element type");
2080 }
2081 } else {
2082 switch (cast<BuiltinType>(EltType)->getKind()) {
2083 case BuiltinType::SChar: EltName = "int8_t"; break;
2084 case BuiltinType::UChar: EltName = "uint8_t"; break;
2085 case BuiltinType::Short: EltName = "int16_t"; break;
2086 case BuiltinType::UShort: EltName = "uint16_t"; break;
2087 case BuiltinType::Int: EltName = "int32_t"; break;
2088 case BuiltinType::UInt: EltName = "uint32_t"; break;
2089 case BuiltinType::LongLong: EltName = "int64_t"; break;
2090 case BuiltinType::ULongLong: EltName = "uint64_t"; break;
2091 case BuiltinType::Float: EltName = "float32_t"; break;
2092 default: llvm_unreachable("unexpected Neon vector element type");
2093 }
2094 }
2095 const char *BaseName = 0;
2096 unsigned BitSize = (T->getNumElements() *
2097 getASTContext().getTypeSize(EltType));
2098 if (BitSize == 64)
2099 BaseName = "__simd64_";
2100 else {
2101 assert(BitSize == 128 && "Neon vector type not 64 or 128 bits");
2102 BaseName = "__simd128_";
2103 }
2104 Out << strlen(BaseName) + strlen(EltName);
2105 Out << BaseName << EltName;
2106}
2107
2108// GNU extension: vector types
2109// <type> ::= <vector-type>
2110// <vector-type> ::= Dv <positive dimension number> _
2111// <extended element type>
2112// ::= Dv [<dimension expression>] _ <element type>
2113// <extended element type> ::= <element type>
2114// ::= p # AltiVec vector pixel
2115// ::= b # Altivec vector bool
2116void CXXNameMangler::mangleType(const VectorType *T) {
2117 if ((T->getVectorKind() == VectorType::NeonVector ||
2118 T->getVectorKind() == VectorType::NeonPolyVector)) {
2119 mangleNeonVectorType(T);
2120 return;
2121 }
2122 Out << "Dv" << T->getNumElements() << '_';
2123 if (T->getVectorKind() == VectorType::AltiVecPixel)
2124 Out << 'p';
2125 else if (T->getVectorKind() == VectorType::AltiVecBool)
2126 Out << 'b';
2127 else
2128 mangleType(T->getElementType());
2129}
2130void CXXNameMangler::mangleType(const ExtVectorType *T) {
2131 mangleType(static_cast<const VectorType*>(T));
2132}
2133void CXXNameMangler::mangleType(const DependentSizedExtVectorType *T) {
2134 Out << "Dv";
2135 mangleExpression(T->getSizeExpr());
2136 Out << '_';
2137 mangleType(T->getElementType());
2138}
2139
2140void CXXNameMangler::mangleType(const PackExpansionType *T) {
2141 // <type> ::= Dp <type> # pack expansion (C++0x)
2142 Out << "Dp";
2143 mangleType(T->getPattern());
2144}
2145
2146void CXXNameMangler::mangleType(const ObjCInterfaceType *T) {
2147 mangleSourceName(T->getDecl()->getIdentifier());
2148}
2149
2150void CXXNameMangler::mangleType(const ObjCObjectType *T) {
2151 // We don't allow overloading by different protocol qualification,
2152 // so mangling them isn't necessary.
2153 mangleType(T->getBaseType());
2154}
2155
2156void CXXNameMangler::mangleType(const BlockPointerType *T) {
2157 Out << "U13block_pointer";
2158 mangleType(T->getPointeeType());
2159}
2160
2161void CXXNameMangler::mangleType(const InjectedClassNameType *T) {
2162 // Mangle injected class name types as if the user had written the
2163 // specialization out fully. It may not actually be possible to see
2164 // this mangling, though.
2165 mangleType(T->getInjectedSpecializationType());
2166}
2167
2168void CXXNameMangler::mangleType(const TemplateSpecializationType *T) {
2169 if (TemplateDecl *TD = T->getTemplateName().getAsTemplateDecl()) {
2170 mangleName(TD, T->getArgs(), T->getNumArgs());
2171 } else {
2172 if (mangleSubstitution(QualType(T, 0)))
2173 return;
2174
2175 mangleTemplatePrefix(T->getTemplateName());
2176
2177 // FIXME: GCC does not appear to mangle the template arguments when
2178 // the template in question is a dependent template name. Should we
2179 // emulate that badness?
2180 mangleTemplateArgs(T->getArgs(), T->getNumArgs());
2181 addSubstitution(QualType(T, 0));
2182 }
2183}
2184
2185void CXXNameMangler::mangleType(const DependentNameType *T) {
2186 // Typename types are always nested
2187 Out << 'N';
2188 manglePrefix(T->getQualifier());
2189 mangleSourceName(T->getIdentifier());
2190 Out << 'E';
2191}
2192
2193void CXXNameMangler::mangleType(const DependentTemplateSpecializationType *T) {
2194 // Dependently-scoped template types are nested if they have a prefix.
2195 Out << 'N';
2196
2197 // TODO: avoid making this TemplateName.
2198 TemplateName Prefix =
2199 getASTContext().getDependentTemplateName(T->getQualifier(),
2200 T->getIdentifier());
2201 mangleTemplatePrefix(Prefix);
2202
2203 // FIXME: GCC does not appear to mangle the template arguments when
2204 // the template in question is a dependent template name. Should we
2205 // emulate that badness?
2206 mangleTemplateArgs(T->getArgs(), T->getNumArgs());
2207 Out << 'E';
2208}
2209
2210void CXXNameMangler::mangleType(const TypeOfType *T) {
2211 // FIXME: this is pretty unsatisfactory, but there isn't an obvious
2212 // "extension with parameters" mangling.
2213 Out << "u6typeof";
2214}
2215
2216void CXXNameMangler::mangleType(const TypeOfExprType *T) {
2217 // FIXME: this is pretty unsatisfactory, but there isn't an obvious
2218 // "extension with parameters" mangling.
2219 Out << "u6typeof";
2220}
2221
2222void CXXNameMangler::mangleType(const DecltypeType *T) {
2223 Expr *E = T->getUnderlyingExpr();
2224
2225 // type ::= Dt <expression> E # decltype of an id-expression
2226 // # or class member access
2227 // ::= DT <expression> E # decltype of an expression
2228
2229 // This purports to be an exhaustive list of id-expressions and
2230 // class member accesses. Note that we do not ignore parentheses;
2231 // parentheses change the semantics of decltype for these
2232 // expressions (and cause the mangler to use the other form).
2233 if (isa<DeclRefExpr>(E) ||
2234 isa<MemberExpr>(E) ||
2235 isa<UnresolvedLookupExpr>(E) ||
2236 isa<DependentScopeDeclRefExpr>(E) ||
2237 isa<CXXDependentScopeMemberExpr>(E) ||
2238 isa<UnresolvedMemberExpr>(E))
2239 Out << "Dt";
2240 else
2241 Out << "DT";
2242 mangleExpression(E);
2243 Out << 'E';
2244}
2245
2246void CXXNameMangler::mangleType(const UnaryTransformType *T) {
2247 // If this is dependent, we need to record that. If not, we simply
2248 // mangle it as the underlying type since they are equivalent.
2249 if (T->isDependentType()) {
2250 Out << 'U';
2251
2252 switch (T->getUTTKind()) {
2253 case UnaryTransformType::EnumUnderlyingType:
2254 Out << "3eut";
2255 break;
2256 }
2257 }
2258
2259 mangleType(T->getUnderlyingType());
2260}
2261
2262void CXXNameMangler::mangleType(const AutoType *T) {
2263 QualType D = T->getDeducedType();
2264 // <builtin-type> ::= Da # dependent auto
2265 if (D.isNull())
2266 Out << "Da";
2267 else
2268 mangleType(D);
2269}
2270
2271void CXXNameMangler::mangleType(const AtomicType *T) {
2272 // <type> ::= U <source-name> <type> # vendor extended type qualifier
2273 // (Until there's a standardized mangling...)
2274 Out << "U7_Atomic";
2275 mangleType(T->getValueType());
2276}
2277
2278void CXXNameMangler::mangleIntegerLiteral(QualType T,
2279 const llvm::APSInt &Value) {
2280 // <expr-primary> ::= L <type> <value number> E # integer literal
2281 Out << 'L';
2282
2283 mangleType(T);
2284 if (T->isBooleanType()) {
2285 // Boolean values are encoded as 0/1.
2286 Out << (Value.getBoolValue() ? '1' : '0');
2287 } else {
2288 mangleNumber(Value);
2289 }
2290 Out << 'E';
2291
2292}
2293
2294/// Mangles a member expression.
2295void CXXNameMangler::mangleMemberExpr(const Expr *base,
2296 bool isArrow,
2297 NestedNameSpecifier *qualifier,
2298 NamedDecl *firstQualifierLookup,
2299 DeclarationName member,
2300 unsigned arity) {
2301 // <expression> ::= dt <expression> <unresolved-name>
2302 // ::= pt <expression> <unresolved-name>
2303 if (base) {
2304 if (base->isImplicitCXXThis()) {
2305 // Note: GCC mangles member expressions to the implicit 'this' as
2306 // *this., whereas we represent them as this->. The Itanium C++ ABI
2307 // does not specify anything here, so we follow GCC.
2308 Out << "dtdefpT";
2309 } else {
2310 Out << (isArrow ? "pt" : "dt");
2311 mangleExpression(base);
2312 }
2313 }
2314 mangleUnresolvedName(qualifier, firstQualifierLookup, member, arity);
2315}
2316
2317/// Look at the callee of the given call expression and determine if
2318/// it's a parenthesized id-expression which would have triggered ADL
2319/// otherwise.
2320static bool isParenthesizedADLCallee(const CallExpr *call) {
2321 const Expr *callee = call->getCallee();
2322 const Expr *fn = callee->IgnoreParens();
2323
2324 // Must be parenthesized. IgnoreParens() skips __extension__ nodes,
2325 // too, but for those to appear in the callee, it would have to be
2326 // parenthesized.
2327 if (callee == fn) return false;
2328
2329 // Must be an unresolved lookup.
2330 const UnresolvedLookupExpr *lookup = dyn_cast<UnresolvedLookupExpr>(fn);
2331 if (!lookup) return false;
2332
2333 assert(!lookup->requiresADL());
2334
2335 // Must be an unqualified lookup.
2336 if (lookup->getQualifier()) return false;
2337
2338 // Must not have found a class member. Note that if one is a class
2339 // member, they're all class members.
2340 if (lookup->getNumDecls() > 0 &&
2341 (*lookup->decls_begin())->isCXXClassMember())
2342 return false;
2343
2344 // Otherwise, ADL would have been triggered.
2345 return true;
2346}
2347
2348void CXXNameMangler::mangleExpression(const Expr *E, unsigned Arity) {
2349 // <expression> ::= <unary operator-name> <expression>
2350 // ::= <binary operator-name> <expression> <expression>
2351 // ::= <trinary operator-name> <expression> <expression> <expression>
2352 // ::= cv <type> expression # conversion with one argument
2353 // ::= cv <type> _ <expression>* E # conversion with a different number of arguments
2354 // ::= st <type> # sizeof (a type)
2355 // ::= at <type> # alignof (a type)
2356 // ::= <template-param>
2357 // ::= <function-param>
2358 // ::= sr <type> <unqualified-name> # dependent name
2359 // ::= sr <type> <unqualified-name> <template-args> # dependent template-id
2360 // ::= ds <expression> <expression> # expr.*expr
2361 // ::= sZ <template-param> # size of a parameter pack
2362 // ::= sZ <function-param> # size of a function parameter pack
2363 // ::= <expr-primary>
2364 // <expr-primary> ::= L <type> <value number> E # integer literal
2365 // ::= L <type <value float> E # floating literal
2366 // ::= L <mangled-name> E # external name
2367 // ::= fpT # 'this' expression
2368 QualType ImplicitlyConvertedToType;
2369
2370recurse:
2371 switch (E->getStmtClass()) {
2372 case Expr::NoStmtClass:
2373#define ABSTRACT_STMT(Type)
2374#define EXPR(Type, Base)
2375#define STMT(Type, Base) \
2376 case Expr::Type##Class:
2377#include "clang/AST/StmtNodes.inc"
2378 // fallthrough
2379
2380 // These all can only appear in local or variable-initialization
2381 // contexts and so should never appear in a mangling.
2382 case Expr::AddrLabelExprClass:
2383 case Expr::DesignatedInitExprClass:
2384 case Expr::ImplicitValueInitExprClass:
2385 case Expr::ParenListExprClass:
2386 case Expr::LambdaExprClass:
2387 llvm_unreachable("unexpected statement kind");
2388
2389 // FIXME: invent manglings for all these.
2390 case Expr::BlockExprClass:
2391 case Expr::CXXPseudoDestructorExprClass:
2392 case Expr::ChooseExprClass:
2393 case Expr::CompoundLiteralExprClass:
2394 case Expr::ExtVectorElementExprClass:
2395 case Expr::GenericSelectionExprClass:
2396 case Expr::ObjCEncodeExprClass:
2397 case Expr::ObjCIsaExprClass:
2398 case Expr::ObjCIvarRefExprClass:
2399 case Expr::ObjCMessageExprClass:
2400 case Expr::ObjCPropertyRefExprClass:
2401 case Expr::ObjCProtocolExprClass:
2402 case Expr::ObjCSelectorExprClass:
2403 case Expr::ObjCStringLiteralClass:
2404 case Expr::ObjCBoxedExprClass:
2405 case Expr::ObjCArrayLiteralClass:
2406 case Expr::ObjCDictionaryLiteralClass:
2407 case Expr::ObjCSubscriptRefExprClass:
2408 case Expr::ObjCIndirectCopyRestoreExprClass:
2409 case Expr::OffsetOfExprClass:
2410 case Expr::PredefinedExprClass:
2411 case Expr::ShuffleVectorExprClass:
2412 case Expr::StmtExprClass:
2413 case Expr::UnaryTypeTraitExprClass:
2414 case Expr::BinaryTypeTraitExprClass:
2415 case Expr::TypeTraitExprClass:
2416 case Expr::ArrayTypeTraitExprClass:
2417 case Expr::ExpressionTraitExprClass:
2418 case Expr::VAArgExprClass:
2419 case Expr::CXXUuidofExprClass:
2420 case Expr::CUDAKernelCallExprClass:
2421 case Expr::AsTypeExprClass:
2422 case Expr::PseudoObjectExprClass:
2423 case Expr::AtomicExprClass:
2424 {
2425 // As bad as this diagnostic is, it's better than crashing.
2426 DiagnosticsEngine &Diags = Context.getDiags();
2427 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2428 "cannot yet mangle expression type %0");
2429 Diags.Report(E->getExprLoc(), DiagID)
2430 << E->getStmtClassName() << E->getSourceRange();
2431 break;
2432 }
2433
2434 // Even gcc-4.5 doesn't mangle this.
2435 case Expr::BinaryConditionalOperatorClass: {
2436 DiagnosticsEngine &Diags = Context.getDiags();
2437 unsigned DiagID =
2438 Diags.getCustomDiagID(DiagnosticsEngine::Error,
2439 "?: operator with omitted middle operand cannot be mangled");
2440 Diags.Report(E->getExprLoc(), DiagID)
2441 << E->getStmtClassName() << E->getSourceRange();
2442 break;
2443 }
2444
2445 // These are used for internal purposes and cannot be meaningfully mangled.
2446 case Expr::OpaqueValueExprClass:
2447 llvm_unreachable("cannot mangle opaque value; mangling wrong thing?");
2448
2449 case Expr::InitListExprClass: {
2450 // Proposal by Jason Merrill, 2012-01-03
2451 Out << "il";
2452 const InitListExpr *InitList = cast<InitListExpr>(E);
2453 for (unsigned i = 0, e = InitList->getNumInits(); i != e; ++i)
2454 mangleExpression(InitList->getInit(i));
2455 Out << "E";
2456 break;
2457 }
2458
2459 case Expr::CXXDefaultArgExprClass:
2460 mangleExpression(cast<CXXDefaultArgExpr>(E)->getExpr(), Arity);
2461 break;
2462
2463 case Expr::SubstNonTypeTemplateParmExprClass:
2464 mangleExpression(cast<SubstNonTypeTemplateParmExpr>(E)->getReplacement(),
2465 Arity);
2466 break;
2467
2468 case Expr::UserDefinedLiteralClass:
2469 // We follow g++'s approach of mangling a UDL as a call to the literal
2470 // operator.
2471 case Expr::CXXMemberCallExprClass: // fallthrough
2472 case Expr::CallExprClass: {
2473 const CallExpr *CE = cast<CallExpr>(E);
2474
2475 // <expression> ::= cp <simple-id> <expression>* E
2476 // We use this mangling only when the call would use ADL except
2477 // for being parenthesized. Per discussion with David
2478 // Vandervoorde, 2011.04.25.
2479 if (isParenthesizedADLCallee(CE)) {
2480 Out << "cp";
2481 // The callee here is a parenthesized UnresolvedLookupExpr with
2482 // no qualifier and should always get mangled as a <simple-id>
2483 // anyway.
2484
2485 // <expression> ::= cl <expression>* E
2486 } else {
2487 Out << "cl";
2488 }
2489
2490 mangleExpression(CE->getCallee(), CE->getNumArgs());
2491 for (unsigned I = 0, N = CE->getNumArgs(); I != N; ++I)
2492 mangleExpression(CE->getArg(I));
2493 Out << 'E';
2494 break;
2495 }
2496
2497 case Expr::CXXNewExprClass: {
2498 const CXXNewExpr *New = cast<CXXNewExpr>(E);
2499 if (New->isGlobalNew()) Out << "gs";
2500 Out << (New->isArray() ? "na" : "nw");
2501 for (CXXNewExpr::const_arg_iterator I = New->placement_arg_begin(),
2502 E = New->placement_arg_end(); I != E; ++I)
2503 mangleExpression(*I);
2504 Out << '_';
2505 mangleType(New->getAllocatedType());
2506 if (New->hasInitializer()) {
2507 // Proposal by Jason Merrill, 2012-01-03
2508 if (New->getInitializationStyle() == CXXNewExpr::ListInit)
2509 Out << "il";
2510 else
2511 Out << "pi";
2512 const Expr *Init = New->getInitializer();
2513 if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(Init)) {
2514 // Directly inline the initializers.
2515 for (CXXConstructExpr::const_arg_iterator I = CCE->arg_begin(),
2516 E = CCE->arg_end();
2517 I != E; ++I)
2518 mangleExpression(*I);
2519 } else if (const ParenListExpr *PLE = dyn_cast<ParenListExpr>(Init)) {
2520 for (unsigned i = 0, e = PLE->getNumExprs(); i != e; ++i)
2521 mangleExpression(PLE->getExpr(i));
2522 } else if (New->getInitializationStyle() == CXXNewExpr::ListInit &&
2523 isa<InitListExpr>(Init)) {
2524 // Only take InitListExprs apart for list-initialization.
2525 const InitListExpr *InitList = cast<InitListExpr>(Init);
2526 for (unsigned i = 0, e = InitList->getNumInits(); i != e; ++i)
2527 mangleExpression(InitList->getInit(i));
2528 } else
2529 mangleExpression(Init);
2530 }
2531 Out << 'E';
2532 break;
2533 }
2534
2535 case Expr::MemberExprClass: {
2536 const MemberExpr *ME = cast<MemberExpr>(E);
2537 mangleMemberExpr(ME->getBase(), ME->isArrow(),
2538 ME->getQualifier(), 0, ME->getMemberDecl()->getDeclName(),
2539 Arity);
2540 break;
2541 }
2542
2543 case Expr::UnresolvedMemberExprClass: {
2544 const UnresolvedMemberExpr *ME = cast<UnresolvedMemberExpr>(E);
2545 mangleMemberExpr(ME->getBase(), ME->isArrow(),
2546 ME->getQualifier(), 0, ME->getMemberName(),
2547 Arity);
2548 if (ME->hasExplicitTemplateArgs())
2549 mangleTemplateArgs(ME->getExplicitTemplateArgs());
2550 break;
2551 }
2552
2553 case Expr::CXXDependentScopeMemberExprClass: {
2554 const CXXDependentScopeMemberExpr *ME
2555 = cast<CXXDependentScopeMemberExpr>(E);
2556 mangleMemberExpr(ME->getBase(), ME->isArrow(),
2557 ME->getQualifier(), ME->getFirstQualifierFoundInScope(),
2558 ME->getMember(), Arity);
2559 if (ME->hasExplicitTemplateArgs())
2560 mangleTemplateArgs(ME->getExplicitTemplateArgs());
2561 break;
2562 }
2563
2564 case Expr::UnresolvedLookupExprClass: {
2565 const UnresolvedLookupExpr *ULE = cast<UnresolvedLookupExpr>(E);
2566 mangleUnresolvedName(ULE->getQualifier(), 0, ULE->getName(), Arity);
2567
2568 // All the <unresolved-name> productions end in a
2569 // base-unresolved-name, where <template-args> are just tacked
2570 // onto the end.
2571 if (ULE->hasExplicitTemplateArgs())
2572 mangleTemplateArgs(ULE->getExplicitTemplateArgs());
2573 break;
2574 }
2575
2576 case Expr::CXXUnresolvedConstructExprClass: {
2577 const CXXUnresolvedConstructExpr *CE = cast<CXXUnresolvedConstructExpr>(E);
2578 unsigned N = CE->arg_size();
2579
2580 Out << "cv";
2581 mangleType(CE->getType());
2582 if (N != 1) Out << '_';
2583 for (unsigned I = 0; I != N; ++I) mangleExpression(CE->getArg(I));
2584 if (N != 1) Out << 'E';
2585 break;
2586 }
2587
2588 case Expr::CXXTemporaryObjectExprClass:
2589 case Expr::CXXConstructExprClass: {
2590 const CXXConstructExpr *CE = cast<CXXConstructExpr>(E);
2591 unsigned N = CE->getNumArgs();
2592
2593 // Proposal by Jason Merrill, 2012-01-03
2594 if (CE->isListInitialization())
2595 Out << "tl";
2596 else
2597 Out << "cv";
2598 mangleType(CE->getType());
2599 if (N != 1) Out << '_';
2600 for (unsigned I = 0; I != N; ++I) mangleExpression(CE->getArg(I));
2601 if (N != 1) Out << 'E';
2602 break;
2603 }
2604
2605 case Expr::CXXScalarValueInitExprClass:
2606 Out <<"cv";
2607 mangleType(E->getType());
2608 Out <<"_E";
2609 break;
2610
2611 case Expr::CXXNoexceptExprClass:
2612 Out << "nx";
2613 mangleExpression(cast<CXXNoexceptExpr>(E)->getOperand());
2614 break;
2615
2616 case Expr::UnaryExprOrTypeTraitExprClass: {
2617 const UnaryExprOrTypeTraitExpr *SAE = cast<UnaryExprOrTypeTraitExpr>(E);
2618
2619 if (!SAE->isInstantiationDependent()) {
2620 // Itanium C++ ABI:
2621 // If the operand of a sizeof or alignof operator is not
2622 // instantiation-dependent it is encoded as an integer literal
2623 // reflecting the result of the operator.
2624 //
2625 // If the result of the operator is implicitly converted to a known
2626 // integer type, that type is used for the literal; otherwise, the type
2627 // of std::size_t or std::ptrdiff_t is used.
2628 QualType T = (ImplicitlyConvertedToType.isNull() ||
2629 !ImplicitlyConvertedToType->isIntegerType())? SAE->getType()
2630 : ImplicitlyConvertedToType;
2631 llvm::APSInt V = SAE->EvaluateKnownConstInt(Context.getASTContext());
2632 mangleIntegerLiteral(T, V);
2633 break;
2634 }
2635
2636 switch(SAE->getKind()) {
2637 case UETT_SizeOf:
2638 Out << 's';
2639 break;
2640 case UETT_AlignOf:
2641 Out << 'a';
2642 break;
2643 case UETT_VecStep:
2644 DiagnosticsEngine &Diags = Context.getDiags();
2645 unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
2646 "cannot yet mangle vec_step expression");
2647 Diags.Report(DiagID);
2648 return;
2649 }
2650 if (SAE->isArgumentType()) {
2651 Out << 't';
2652 mangleType(SAE->getArgumentType());
2653 } else {
2654 Out << 'z';
2655 mangleExpression(SAE->getArgumentExpr());
2656 }
2657 break;
2658 }
2659
2660 case Expr::CXXThrowExprClass: {
2661 const CXXThrowExpr *TE = cast<CXXThrowExpr>(E);
2662
2663 // Proposal from David Vandervoorde, 2010.06.30
2664 if (TE->getSubExpr()) {
2665 Out << "tw";
2666 mangleExpression(TE->getSubExpr());
2667 } else {
2668 Out << "tr";
2669 }
2670 break;
2671 }
2672
2673 case Expr::CXXTypeidExprClass: {
2674 const CXXTypeidExpr *TIE = cast<CXXTypeidExpr>(E);
2675
2676 // Proposal from David Vandervoorde, 2010.06.30
2677 if (TIE->isTypeOperand()) {
2678 Out << "ti";
2679 mangleType(TIE->getTypeOperand());
2680 } else {
2681 Out << "te";
2682 mangleExpression(TIE->getExprOperand());
2683 }
2684 break;
2685 }
2686
2687 case Expr::CXXDeleteExprClass: {
2688 const CXXDeleteExpr *DE = cast<CXXDeleteExpr>(E);
2689
2690 // Proposal from David Vandervoorde, 2010.06.30
2691 if (DE->isGlobalDelete()) Out << "gs";
2692 Out << (DE->isArrayForm() ? "da" : "dl");
2693 mangleExpression(DE->getArgument());
2694 break;
2695 }
2696
2697 case Expr::UnaryOperatorClass: {
2698 const UnaryOperator *UO = cast<UnaryOperator>(E);
2699 mangleOperatorName(UnaryOperator::getOverloadedOperator(UO->getOpcode()),
2700 /*Arity=*/1);
2701 mangleExpression(UO->getSubExpr());
2702 break;
2703 }
2704
2705 case Expr::ArraySubscriptExprClass: {
2706 const ArraySubscriptExpr *AE = cast<ArraySubscriptExpr>(E);
2707
2708 // Array subscript is treated as a syntactically weird form of
2709 // binary operator.
2710 Out << "ix";
2711 mangleExpression(AE->getLHS());
2712 mangleExpression(AE->getRHS());
2713 break;
2714 }
2715
2716 case Expr::CompoundAssignOperatorClass: // fallthrough
2717 case Expr::BinaryOperatorClass: {
2718 const BinaryOperator *BO = cast<BinaryOperator>(E);
2719 if (BO->getOpcode() == BO_PtrMemD)
2720 Out << "ds";
2721 else
2722 mangleOperatorName(BinaryOperator::getOverloadedOperator(BO->getOpcode()),
2723 /*Arity=*/2);
2724 mangleExpression(BO->getLHS());
2725 mangleExpression(BO->getRHS());
2726 break;
2727 }
2728
2729 case Expr::ConditionalOperatorClass: {
2730 const ConditionalOperator *CO = cast<ConditionalOperator>(E);
2731 mangleOperatorName(OO_Conditional, /*Arity=*/3);
2732 mangleExpression(CO->getCond());
2733 mangleExpression(CO->getLHS(), Arity);
2734 mangleExpression(CO->getRHS(), Arity);
2735 break;
2736 }
2737
2738 case Expr::ImplicitCastExprClass: {
2739 ImplicitlyConvertedToType = E->getType();
2740 E = cast<ImplicitCastExpr>(E)->getSubExpr();
2741 goto recurse;
2742 }
2743
2744 case Expr::ObjCBridgedCastExprClass: {
2745 // Mangle ownership casts as a vendor extended operator __bridge,
2746 // __bridge_transfer, or __bridge_retain.
2747 StringRef Kind = cast<ObjCBridgedCastExpr>(E)->getBridgeKindName();
2748 Out << "v1U" << Kind.size() << Kind;
2749 }
2750 // Fall through to mangle the cast itself.
2751
2752 case Expr::CStyleCastExprClass:
2753 case Expr::CXXStaticCastExprClass:
2754 case Expr::CXXDynamicCastExprClass:
2755 case Expr::CXXReinterpretCastExprClass:
2756 case Expr::CXXConstCastExprClass:
2757 case Expr::CXXFunctionalCastExprClass: {
2758 const ExplicitCastExpr *ECE = cast<ExplicitCastExpr>(E);
2759 Out << "cv";
2760 mangleType(ECE->getType());
2761 mangleExpression(ECE->getSubExpr());
2762 break;
2763 }
2764
2765 case Expr::CXXOperatorCallExprClass: {
2766 const CXXOperatorCallExpr *CE = cast<CXXOperatorCallExpr>(E);
2767 unsigned NumArgs = CE->getNumArgs();
2768 mangleOperatorName(CE->getOperator(), /*Arity=*/NumArgs);
2769 // Mangle the arguments.
2770 for (unsigned i = 0; i != NumArgs; ++i)
2771 mangleExpression(CE->getArg(i));
2772 break;
2773 }
2774
2775 case Expr::ParenExprClass:
2776 mangleExpression(cast<ParenExpr>(E)->getSubExpr(), Arity);
2777 break;
2778
2779 case Expr::DeclRefExprClass: {
2780 const NamedDecl *D = cast<DeclRefExpr>(E)->getDecl();
2781
2782 switch (D->getKind()) {
2783 default:
2784 // <expr-primary> ::= L <mangled-name> E # external name
2785 Out << 'L';
2786 mangle(D, "_Z");
2787 Out << 'E';
2788 break;
2789
2790 case Decl::ParmVar:
2791 mangleFunctionParam(cast<ParmVarDecl>(D));
2792 break;
2793
2794 case Decl::EnumConstant: {
2795 const EnumConstantDecl *ED = cast<EnumConstantDecl>(D);
2796 mangleIntegerLiteral(ED->getType(), ED->getInitVal());
2797 break;
2798 }
2799
2800 case Decl::NonTypeTemplateParm: {
2801 const NonTypeTemplateParmDecl *PD = cast<NonTypeTemplateParmDecl>(D);
2802 mangleTemplateParameter(PD->getIndex());
2803 break;
2804 }
2805
2806 }
2807
2808 break;
2809 }
2810
2811 case Expr::SubstNonTypeTemplateParmPackExprClass:
2812 // FIXME: not clear how to mangle this!
2813 // template <unsigned N...> class A {
2814 // template <class U...> void foo(U (&x)[N]...);
2815 // };
2816 Out << "_SUBSTPACK_";
2817 break;
2818
2819 case Expr::FunctionParmPackExprClass: {
2820 // FIXME: not clear how to mangle this!
2821 const FunctionParmPackExpr *FPPE = cast<FunctionParmPackExpr>(E);
2822 Out << "v110_SUBSTPACK";
2823 mangleFunctionParam(FPPE->getParameterPack());
2824 break;
2825 }
2826
2827 case Expr::DependentScopeDeclRefExprClass: {
2828 const DependentScopeDeclRefExpr *DRE = cast<DependentScopeDeclRefExpr>(E);
2829 mangleUnresolvedName(DRE->getQualifier(), 0, DRE->getDeclName(), Arity);
2830
2831 // All the <unresolved-name> productions end in a
2832 // base-unresolved-name, where <template-args> are just tacked
2833 // onto the end.
2834 if (DRE->hasExplicitTemplateArgs())
2835 mangleTemplateArgs(DRE->getExplicitTemplateArgs());
2836 break;
2837 }
2838
2839 case Expr::CXXBindTemporaryExprClass:
2840 mangleExpression(cast<CXXBindTemporaryExpr>(E)->getSubExpr());
2841 break;
2842
2843 case Expr::ExprWithCleanupsClass:
2844 mangleExpression(cast<ExprWithCleanups>(E)->getSubExpr(), Arity);
2845 break;
2846
2847 case Expr::FloatingLiteralClass: {
2848 const FloatingLiteral *FL = cast<FloatingLiteral>(E);
2849 Out << 'L';
2850 mangleType(FL->getType());
2851 mangleFloat(FL->getValue());
2852 Out << 'E';
2853 break;
2854 }
2855
2856 case Expr::CharacterLiteralClass:
2857 Out << 'L';
2858 mangleType(E->getType());
2859 Out << cast<CharacterLiteral>(E)->getValue();
2860 Out << 'E';
2861 break;
2862
2863 // FIXME. __objc_yes/__objc_no are mangled same as true/false
2864 case Expr::ObjCBoolLiteralExprClass:
2865 Out << "Lb";
2866 Out << (cast<ObjCBoolLiteralExpr>(E)->getValue() ? '1' : '0');
2867 Out << 'E';
2868 break;
2869
2870 case Expr::CXXBoolLiteralExprClass:
2871 Out << "Lb";
2872 Out << (cast<CXXBoolLiteralExpr>(E)->getValue() ? '1' : '0');
2873 Out << 'E';
2874 break;
2875
2876 case Expr::IntegerLiteralClass: {
2877 llvm::APSInt Value(cast<IntegerLiteral>(E)->getValue());
2878 if (E->getType()->isSignedIntegerType())
2879 Value.setIsSigned(true);
2880 mangleIntegerLiteral(E->getType(), Value);
2881 break;
2882 }
2883
2884 case Expr::ImaginaryLiteralClass: {
2885 const ImaginaryLiteral *IE = cast<ImaginaryLiteral>(E);
2886 // Mangle as if a complex literal.
2887 // Proposal from David Vandevoorde, 2010.06.30.
2888 Out << 'L';
2889 mangleType(E->getType());
2890 if (const FloatingLiteral *Imag =
2891 dyn_cast<FloatingLiteral>(IE->getSubExpr())) {
2892 // Mangle a floating-point zero of the appropriate type.
2893 mangleFloat(llvm::APFloat(Imag->getValue().getSemantics()));
2894 Out << '_';
2895 mangleFloat(Imag->getValue());
2896 } else {
2897 Out << "0_";
2898 llvm::APSInt Value(cast<IntegerLiteral>(IE->getSubExpr())->getValue());
2899 if (IE->getSubExpr()->getType()->isSignedIntegerType())
2900 Value.setIsSigned(true);
2901 mangleNumber(Value);
2902 }
2903 Out << 'E';
2904 break;
2905 }
2906
2907 case Expr::StringLiteralClass: {
2908 // Revised proposal from David Vandervoorde, 2010.07.15.
2909 Out << 'L';
2910 assert(isa<ConstantArrayType>(E->getType()));
2911 mangleType(E->getType());
2912 Out << 'E';
2913 break;
2914 }
2915
2916 case Expr::GNUNullExprClass:
2917 // FIXME: should this really be mangled the same as nullptr?
2918 // fallthrough
2919
2920 case Expr::CXXNullPtrLiteralExprClass: {
2921 // Proposal from David Vandervoorde, 2010.06.30, as
2922 // modified by ABI list discussion.
2923 Out << "LDnE";
2924 break;
2925 }
2926
2927 case Expr::PackExpansionExprClass:
2928 Out << "sp";
2929 mangleExpression(cast<PackExpansionExpr>(E)->getPattern());
2930 break;
2931
2932 case Expr::SizeOfPackExprClass: {
2933 Out << "sZ";
2934 const NamedDecl *Pack = cast<SizeOfPackExpr>(E)->getPack();
2935 if (const TemplateTypeParmDecl *TTP = dyn_cast<TemplateTypeParmDecl>(Pack))
2936 mangleTemplateParameter(TTP->getIndex());
2937 else if (const NonTypeTemplateParmDecl *NTTP
2938 = dyn_cast<NonTypeTemplateParmDecl>(Pack))
2939 mangleTemplateParameter(NTTP->getIndex());
2940 else if (const TemplateTemplateParmDecl *TempTP
2941 = dyn_cast<TemplateTemplateParmDecl>(Pack))
2942 mangleTemplateParameter(TempTP->getIndex());
2943 else
2944 mangleFunctionParam(cast<ParmVarDecl>(Pack));
2945 break;
2946 }
2947
2948 case Expr::MaterializeTemporaryExprClass: {
2949 mangleExpression(cast<MaterializeTemporaryExpr>(E)->GetTemporaryExpr());
2950 break;
2951 }
2952
2953 case Expr::CXXThisExprClass:
2954 Out << "fpT";
2955 break;
2956 }
2957}
2958
2959/// Mangle an expression which refers to a parameter variable.
2960///
2961/// <expression> ::= <function-param>
2962/// <function-param> ::= fp <top-level CV-qualifiers> _ # L == 0, I == 0
2963/// <function-param> ::= fp <top-level CV-qualifiers>
2964/// <parameter-2 non-negative number> _ # L == 0, I > 0
2965/// <function-param> ::= fL <L-1 non-negative number>
2966/// p <top-level CV-qualifiers> _ # L > 0, I == 0
2967/// <function-param> ::= fL <L-1 non-negative number>
2968/// p <top-level CV-qualifiers>
2969/// <I-1 non-negative number> _ # L > 0, I > 0
2970///
2971/// L is the nesting depth of the parameter, defined as 1 if the
2972/// parameter comes from the innermost function prototype scope
2973/// enclosing the current context, 2 if from the next enclosing
2974/// function prototype scope, and so on, with one special case: if
2975/// we've processed the full parameter clause for the innermost
2976/// function type, then L is one less. This definition conveniently
2977/// makes it irrelevant whether a function's result type was written
2978/// trailing or leading, but is otherwise overly complicated; the
2979/// numbering was first designed without considering references to
2980/// parameter in locations other than return types, and then the
2981/// mangling had to be generalized without changing the existing
2982/// manglings.
2983///
2984/// I is the zero-based index of the parameter within its parameter
2985/// declaration clause. Note that the original ABI document describes
2986/// this using 1-based ordinals.
2987void CXXNameMangler::mangleFunctionParam(const ParmVarDecl *parm) {
2988 unsigned parmDepth = parm->getFunctionScopeDepth();
2989 unsigned parmIndex = parm->getFunctionScopeIndex();
2990
2991 // Compute 'L'.
2992 // parmDepth does not include the declaring function prototype.
2993 // FunctionTypeDepth does account for that.
2994 assert(parmDepth < FunctionTypeDepth.getDepth());
2995 unsigned nestingDepth = FunctionTypeDepth.getDepth() - parmDepth;
2996 if (FunctionTypeDepth.isInResultType())
2997 nestingDepth--;
2998
2999 if (nestingDepth == 0) {
3000 Out << "fp";
3001 } else {
3002 Out << "fL" << (nestingDepth - 1) << 'p';
3003 }
3004
3005 // Top-level qualifiers. We don't have to worry about arrays here,
3006 // because parameters declared as arrays should already have been
3007 // transformed to have pointer type. FIXME: apparently these don't
3008 // get mangled if used as an rvalue of a known non-class type?
3009 assert(!parm->getType()->isArrayType()
3010 && "parameter's type is still an array type?");
3011 mangleQualifiers(parm->getType().getQualifiers());
3012
3013 // Parameter index.
3014 if (parmIndex != 0) {
3015 Out << (parmIndex - 1);
3016 }
3017 Out << '_';
3018}
3019
3020void CXXNameMangler::mangleCXXCtorType(CXXCtorType T) {
3021 // <ctor-dtor-name> ::= C1 # complete object constructor
3022 // ::= C2 # base object constructor
3023 // ::= C3 # complete object allocating constructor
3024 //
3025 switch (T) {
3026 case Ctor_Complete:
3027 Out << "C1";
3028 break;
3029 case Ctor_Base:
3030 Out << "C2";
3031 break;
3032 case Ctor_CompleteAllocating:
3033 Out << "C3";
3034 break;
3035 }
3036}
3037
3038void CXXNameMangler::mangleCXXDtorType(CXXDtorType T) {
3039 // <ctor-dtor-name> ::= D0 # deleting destructor
3040 // ::= D1 # complete object destructor
3041 // ::= D2 # base object destructor
3042 //
3043 switch (T) {
3044 case Dtor_Deleting:
3045 Out << "D0";
3046 break;
3047 case Dtor_Complete:
3048 Out << "D1";
3049 break;
3050 case Dtor_Base:
3051 Out << "D2";
3052 break;
3053 }
3054}
3055
3056void CXXNameMangler::mangleTemplateArgs(
3057 const ASTTemplateArgumentListInfo &TemplateArgs) {
3058 // <template-args> ::= I <template-arg>+ E
3059 Out << 'I';
3060 for (unsigned i = 0, e = TemplateArgs.NumTemplateArgs; i != e; ++i)
3061 mangleTemplateArg(TemplateArgs.getTemplateArgs()[i].getArgument());
3062 Out << 'E';
3063}
3064
3065void CXXNameMangler::mangleTemplateArgs(const TemplateArgumentList &AL) {
3066 // <template-args> ::= I <template-arg>+ E
3067 Out << 'I';
3068 for (unsigned i = 0, e = AL.size(); i != e; ++i)
3069 mangleTemplateArg(AL[i]);
3070 Out << 'E';
3071}
3072
3073void CXXNameMangler::mangleTemplateArgs(const TemplateArgument *TemplateArgs,
3074 unsigned NumTemplateArgs) {
3075 // <template-args> ::= I <template-arg>+ E
3076 Out << 'I';
3077 for (unsigned i = 0; i != NumTemplateArgs; ++i)
3078 mangleTemplateArg(TemplateArgs[i]);
3079 Out << 'E';
3080}
3081
3082void CXXNameMangler::mangleTemplateArg(TemplateArgument A) {
3083 // <template-arg> ::= <type> # type or template
3084 // ::= X <expression> E # expression
3085 // ::= <expr-primary> # simple expressions
3086 // ::= J <template-arg>* E # argument pack
3087 // ::= sp <expression> # pack expansion of (C++0x)
3088 if (!A.isInstantiationDependent() || A.isDependent())
3089 A = Context.getASTContext().getCanonicalTemplateArgument(A);
3090
3091 switch (A.getKind()) {
3092 case TemplateArgument::Null:
3093 llvm_unreachable("Cannot mangle NULL template argument");
3094
3095 case TemplateArgument::Type:
3096 mangleType(A.getAsType());
3097 break;
3098 case TemplateArgument::Template:
3099 // This is mangled as <type>.
3100 mangleType(A.getAsTemplate());
3101 break;
3102 case TemplateArgument::TemplateExpansion:
3103 // <type> ::= Dp <type> # pack expansion (C++0x)
3104 Out << "Dp";
3105 mangleType(A.getAsTemplateOrTemplatePattern());
3106 break;
3107 case TemplateArgument::Expression: {
3108 // It's possible to end up with a DeclRefExpr here in certain
3109 // dependent cases, in which case we should mangle as a
3110 // declaration.
3111 const Expr *E = A.getAsExpr()->IgnoreParens();
3112 if (const DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(E)) {
3113 const ValueDecl *D = DRE->getDecl();
3114 if (isa<VarDecl>(D) || isa<FunctionDecl>(D)) {
3115 Out << "L";
3116 mangle(D, "_Z");
3117 Out << 'E';
3118 break;
3119 }
3120 }
3121
3122 Out << 'X';
3123 mangleExpression(E);
3124 Out << 'E';
3125 break;
3126 }
3127 case TemplateArgument::Integral:
3128 mangleIntegerLiteral(A.getIntegralType(), A.getAsIntegral());
3129 break;
3130 case TemplateArgument::Declaration: {
3131 // <expr-primary> ::= L <mangled-name> E # external name
3132 // Clang produces AST's where pointer-to-member-function expressions
3133 // and pointer-to-function expressions are represented as a declaration not
3134 // an expression. We compensate for it here to produce the correct mangling.
3135 ValueDecl *D = A.getAsDecl();
3136 bool compensateMangling = !A.isDeclForReferenceParam();
3137 if (compensateMangling) {
3138 Out << 'X';
3139 mangleOperatorName(OO_Amp, 1);
3140 }
3141
3142 Out << 'L';
3143 // References to external entities use the mangled name; if the name would
3144 // not normally be manged then mangle it as unqualified.
3145 //
3146 // FIXME: The ABI specifies that external names here should have _Z, but
3147 // gcc leaves this off.
3148 if (compensateMangling)
3149 mangle(D, "_Z");
3150 else
3151 mangle(D, "Z");
3152 Out << 'E';
3153
3154 if (compensateMangling)
3155 Out << 'E';
3156
3157 break;
3158 }
3159 case TemplateArgument::NullPtr: {
3160 // <expr-primary> ::= L <type> 0 E
3161 Out << 'L';
3162 mangleType(A.getNullPtrType());
3163 Out << "0E";
3164 break;
3165 }
3166 case TemplateArgument::Pack: {
3167 // Note: proposal by Mike Herrick on 12/20/10
3168 Out << 'J';
3169 for (TemplateArgument::pack_iterator PA = A.pack_begin(),
3170 PAEnd = A.pack_end();
3171 PA != PAEnd; ++PA)
3172 mangleTemplateArg(*PA);
3173 Out << 'E';
3174 }
3175 }
3176}
3177
3178void CXXNameMangler::mangleTemplateParameter(unsigned Index) {
3179 // <template-param> ::= T_ # first template parameter
3180 // ::= T <parameter-2 non-negative number> _
3181 if (Index == 0)
3182 Out << "T_";
3183 else
3184 Out << 'T' << (Index - 1) << '_';
3185}
3186
3187void CXXNameMangler::mangleExistingSubstitution(QualType type) {
3188 bool result = mangleSubstitution(type);
3189 assert(result && "no existing substitution for type");
3190 (void) result;
3191}
3192
3193void CXXNameMangler::mangleExistingSubstitution(TemplateName tname) {
3194 bool result = mangleSubstitution(tname);
3195 assert(result && "no existing substitution for template name");
3196 (void) result;
3197}
3198
3199// <substitution> ::= S <seq-id> _
3200// ::= S_
3201bool CXXNameMangler::mangleSubstitution(const NamedDecl *ND) {
3202 // Try one of the standard substitutions first.
3203 if (mangleStandardSubstitution(ND))
3204 return true;
3205
3206 ND = cast<NamedDecl>(ND->getCanonicalDecl());
3207 return mangleSubstitution(reinterpret_cast<uintptr_t>(ND));
3208}
3209
3210/// \brief Determine whether the given type has any qualifiers that are
3211/// relevant for substitutions.
3212static bool hasMangledSubstitutionQualifiers(QualType T) {
3213 Qualifiers Qs = T.getQualifiers();
3214 return Qs.getCVRQualifiers() || Qs.hasAddressSpace();
3215}
3216
3217bool CXXNameMangler::mangleSubstitution(QualType T) {
3218 if (!hasMangledSubstitutionQualifiers(T)) {
3219 if (const RecordType *RT = T->getAs<RecordType>())
3220 return mangleSubstitution(RT->getDecl());
3221 }
3222
3223 uintptr_t TypePtr = reinterpret_cast<uintptr_t>(T.getAsOpaquePtr());
3224
3225 return mangleSubstitution(TypePtr);
3226}
3227
3228bool CXXNameMangler::mangleSubstitution(TemplateName Template) {
3229 if (TemplateDecl *TD = Template.getAsTemplateDecl())
3230 return mangleSubstitution(TD);
3231
3232 Template = Context.getASTContext().getCanonicalTemplateName(Template);
3233 return mangleSubstitution(
3234 reinterpret_cast<uintptr_t>(Template.getAsVoidPointer()));
3235}
3236
3237bool CXXNameMangler::mangleSubstitution(uintptr_t Ptr) {
3238 llvm::DenseMap<uintptr_t, unsigned>::iterator I = Substitutions.find(Ptr);
3239 if (I == Substitutions.end())
3240 return false;
3241
3242 unsigned SeqID = I->second;
3243 if (SeqID == 0)
3244 Out << "S_";
3245 else {
3246 SeqID--;
3247
3248 // <seq-id> is encoded in base-36, using digits and upper case letters.
3249 char Buffer[10];
3250 char *BufferPtr = llvm::array_endof(Buffer);
3251
3252 if (SeqID == 0) *--BufferPtr = '0';
3253
3254 while (SeqID) {
3255 assert(BufferPtr > Buffer && "Buffer overflow!");
3256
3257 char c = static_cast<char>(SeqID % 36);
3258
3259 *--BufferPtr = (c < 10 ? '0' + c : 'A' + c - 10);
3260 SeqID /= 36;
3261 }
3262
3263 Out << 'S'
3264 << StringRef(BufferPtr, llvm::array_endof(Buffer)-BufferPtr)
3265 << '_';
3266 }
3267
3268 return true;
3269}
3270
3271static bool isCharType(QualType T) {
3272 if (T.isNull())
3273 return false;
3274
3275 return T->isSpecificBuiltinType(BuiltinType::Char_S) ||
3276 T->isSpecificBuiltinType(BuiltinType::Char_U);
3277}
3278
3279/// isCharSpecialization - Returns whether a given type is a template
3280/// specialization of a given name with a single argument of type char.
3281static bool isCharSpecialization(QualType T, const char *Name) {
3282 if (T.isNull())
3283 return false;
3284
3285 const RecordType *RT = T->getAs<RecordType>();
3286 if (!RT)
3287 return false;
3288
3289 const ClassTemplateSpecializationDecl *SD =
3290 dyn_cast<ClassTemplateSpecializationDecl>(RT->getDecl());
3291 if (!SD)
3292 return false;
3293
3294 if (!isStdNamespace(getEffectiveDeclContext(SD)))
3295 return false;
3296
3297 const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
3298 if (TemplateArgs.size() != 1)
3299 return false;
3300
3301 if (!isCharType(TemplateArgs[0].getAsType()))
3302 return false;
3303
3304 return SD->getIdentifier()->getName() == Name;
3305}
3306
3307template <std::size_t StrLen>
3308static bool isStreamCharSpecialization(const ClassTemplateSpecializationDecl*SD,
3309 const char (&Str)[StrLen]) {
3310 if (!SD->getIdentifier()->isStr(Str))
3311 return false;
3312
3313 const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
3314 if (TemplateArgs.size() != 2)
3315 return false;
3316
3317 if (!isCharType(TemplateArgs[0].getAsType()))
3318 return false;
3319
3320 if (!isCharSpecialization(TemplateArgs[1].getAsType(), "char_traits"))
3321 return false;
3322
3323 return true;
3324}
3325
3326bool CXXNameMangler::mangleStandardSubstitution(const NamedDecl *ND) {
3327 // <substitution> ::= St # ::std::
3328 if (const NamespaceDecl *NS = dyn_cast<NamespaceDecl>(ND)) {
3329 if (isStd(NS)) {
3330 Out << "St";
3331 return true;
3332 }
3333 }
3334
3335 if (const ClassTemplateDecl *TD = dyn_cast<ClassTemplateDecl>(ND)) {
3336 if (!isStdNamespace(getEffectiveDeclContext(TD)))
3337 return false;
3338
3339 // <substitution> ::= Sa # ::std::allocator
3340 if (TD->getIdentifier()->isStr("allocator")) {
3341 Out << "Sa";
3342 return true;
3343 }
3344
3345 // <<substitution> ::= Sb # ::std::basic_string
3346 if (TD->getIdentifier()->isStr("basic_string")) {
3347 Out << "Sb";
3348 return true;
3349 }
3350 }
3351
3352 if (const ClassTemplateSpecializationDecl *SD =
3353 dyn_cast<ClassTemplateSpecializationDecl>(ND)) {
3354 if (!isStdNamespace(getEffectiveDeclContext(SD)))
3355 return false;
3356
3357 // <substitution> ::= Ss # ::std::basic_string<char,
3358 // ::std::char_traits<char>,
3359 // ::std::allocator<char> >
3360 if (SD->getIdentifier()->isStr("basic_string")) {
3361 const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
3362
3363 if (TemplateArgs.size() != 3)
3364 return false;
3365
3366 if (!isCharType(TemplateArgs[0].getAsType()))
3367 return false;
3368
3369 if (!isCharSpecialization(TemplateArgs[1].getAsType(), "char_traits"))
3370 return false;
3371
3372 if (!isCharSpecialization(TemplateArgs[2].getAsType(), "allocator"))
3373 return false;
3374
3375 Out << "Ss";
3376 return true;
3377 }
3378
3379 // <substitution> ::= Si # ::std::basic_istream<char,
3380 // ::std::char_traits<char> >
3381 if (isStreamCharSpecialization(SD, "basic_istream")) {
3382 Out << "Si";
3383 return true;
3384 }
3385
3386 // <substitution> ::= So # ::std::basic_ostream<char,
3387 // ::std::char_traits<char> >
3388 if (isStreamCharSpecialization(SD, "basic_ostream")) {
3389 Out << "So";
3390 return true;
3391 }
3392
3393 // <substitution> ::= Sd # ::std::basic_iostream<char,
3394 // ::std::char_traits<char> >
3395 if (isStreamCharSpecialization(SD, "basic_iostream")) {
3396 Out << "Sd";
3397 return true;
3398 }
3399 }
3400 return false;
3401}
3402
3403void CXXNameMangler::addSubstitution(QualType T) {
3404 if (!hasMangledSubstitutionQualifiers(T)) {
3405 if (const RecordType *RT = T->getAs<RecordType>()) {
3406 addSubstitution(RT->getDecl());
3407 return;
3408 }
3409 }
3410
3411 uintptr_t TypePtr = reinterpret_cast<uintptr_t>(T.getAsOpaquePtr());
3412 addSubstitution(TypePtr);
3413}
3414
3415void CXXNameMangler::addSubstitution(TemplateName Template) {
3416 if (TemplateDecl *TD = Template.getAsTemplateDecl())
3417 return addSubstitution(TD);
3418
3419 Template = Context.getASTContext().getCanonicalTemplateName(Template);
3420 addSubstitution(reinterpret_cast<uintptr_t>(Template.getAsVoidPointer()));
3421}
3422
3423void CXXNameMangler::addSubstitution(uintptr_t Ptr) {
3424 assert(!Substitutions.count(Ptr) && "Substitution already exists!");
3425 Substitutions[Ptr] = SeqID++;
3426}
3427
3428//
3429
3430/// \brief Mangles the name of the declaration D and emits that name to the
3431/// given output stream.
3432///
3433/// If the declaration D requires a mangled name, this routine will emit that
3434/// mangled name to \p os and return true. Otherwise, \p os will be unchanged
3435/// and this routine will return false. In this case, the caller should just
3436/// emit the identifier of the declaration (\c D->getIdentifier()) as its
3437/// name.
3438void ItaniumMangleContext::mangleName(const NamedDecl *D,
3439 raw_ostream &Out) {
3440 assert((isa<FunctionDecl>(D) || isa<VarDecl>(D)) &&
3441 "Invalid mangleName() call, argument is not a variable or function!");
3442 assert(!isa<CXXConstructorDecl>(D) && !isa<CXXDestructorDecl>(D) &&
3443 "Invalid mangleName() call on 'structor decl!");
3444
3445 PrettyStackTraceDecl CrashInfo(D, SourceLocation(),
3446 getASTContext().getSourceManager(),
3447 "Mangling declaration");
3448
3449 CXXNameMangler Mangler(*this, Out, D);
3450 return Mangler.mangle(D);
3451}
3452
3453void ItaniumMangleContext::mangleCXXCtor(const CXXConstructorDecl *D,
3454 CXXCtorType Type,
3455 raw_ostream &Out) {
3456 CXXNameMangler Mangler(*this, Out, D, Type);
3457 Mangler.mangle(D);
3458}
3459
3460void ItaniumMangleContext::mangleCXXDtor(const CXXDestructorDecl *D,
3461 CXXDtorType Type,
3462 raw_ostream &Out) {
3463 CXXNameMangler Mangler(*this, Out, D, Type);
3464 Mangler.mangle(D);
3465}
3466
3467void ItaniumMangleContext::mangleThunk(const CXXMethodDecl *MD,
3468 const ThunkInfo &Thunk,
3469 raw_ostream &Out) {
3470 // <special-name> ::= T <call-offset> <base encoding>
3471 // # base is the nominal target function of thunk
3472 // <special-name> ::= Tc <call-offset> <call-offset> <base encoding>
3473 // # base is the nominal target function of thunk
3474 // # first call-offset is 'this' adjustment
3475 // # second call-offset is result adjustment
3476
3477 assert(!isa<CXXDestructorDecl>(MD) &&
3478 "Use mangleCXXDtor for destructor decls!");
3479 CXXNameMangler Mangler(*this, Out);
3480 Mangler.getStream() << "_ZT";
3481 if (!Thunk.Return.isEmpty())
3482 Mangler.getStream() << 'c';
3483
3484 // Mangle the 'this' pointer adjustment.
3485 Mangler.mangleCallOffset(Thunk.This.NonVirtual, Thunk.This.VCallOffsetOffset);
3486
3487 // Mangle the return pointer adjustment if there is one.
3488 if (!Thunk.Return.isEmpty())
3489 Mangler.mangleCallOffset(Thunk.Return.NonVirtual,
3490 Thunk.Return.VBaseOffsetOffset);
3491
3492 Mangler.mangleFunctionEncoding(MD);
3493}
3494
3495void
3496ItaniumMangleContext::mangleCXXDtorThunk(const CXXDestructorDecl *DD,
3497 CXXDtorType Type,
3498 const ThisAdjustment &ThisAdjustment,
3499 raw_ostream &Out) {
3500 // <special-name> ::= T <call-offset> <base encoding>
3501 // # base is the nominal target function of thunk
3502 CXXNameMangler Mangler(*this, Out, DD, Type);
3503 Mangler.getStream() << "_ZT";
3504
3505 // Mangle the 'this' pointer adjustment.
3506 Mangler.mangleCallOffset(ThisAdjustment.NonVirtual,
3507 ThisAdjustment.VCallOffsetOffset);
3508
3509 Mangler.mangleFunctionEncoding(DD);
3510}
3511
3512/// mangleGuardVariable - Returns the mangled name for a guard variable
3513/// for the passed in VarDecl.
3514void ItaniumMangleContext::mangleItaniumGuardVariable(const VarDecl *D,
3515 raw_ostream &Out) {
3516 // <special-name> ::= GV <object name> # Guard variable for one-time
3517 // # initialization
3518 CXXNameMangler Mangler(*this, Out);
3519 Mangler.getStream() << "_ZGV";
3520 Mangler.mangleName(D);
3521}
3522
3523void ItaniumMangleContext::mangleReferenceTemporary(const VarDecl *D,
3524 raw_ostream &Out) {
3525 // We match the GCC mangling here.
3526 // <special-name> ::= GR <object name>
3527 CXXNameMangler Mangler(*this, Out);
3528 Mangler.getStream() << "_ZGR";
3529 Mangler.mangleName(D);
3530}
3531
3532void ItaniumMangleContext::mangleCXXVTable(const CXXRecordDecl *RD,
3533 raw_ostream &Out) {
3534 // <special-name> ::= TV <type> # virtual table
3535 CXXNameMangler Mangler(*this, Out);
3536 Mangler.getStream() << "_ZTV";
3537 Mangler.mangleNameOrStandardSubstitution(RD);
3538}
3539
3540void ItaniumMangleContext::mangleCXXVTT(const CXXRecordDecl *RD,
3541 raw_ostream &Out) {
3542 // <special-name> ::= TT <type> # VTT structure
3543 CXXNameMangler Mangler(*this, Out);
3544 Mangler.getStream() << "_ZTT";
3545 Mangler.mangleNameOrStandardSubstitution(RD);
3546}
3547
3548void ItaniumMangleContext::mangleCXXCtorVTable(const CXXRecordDecl *RD,
3549 int64_t Offset,
3550 const CXXRecordDecl *Type,
3551 raw_ostream &Out) {
3552 // <special-name> ::= TC <type> <offset number> _ <base type>
3553 CXXNameMangler Mangler(*this, Out);
3554 Mangler.getStream() << "_ZTC";
3555 Mangler.mangleNameOrStandardSubstitution(RD);
3556 Mangler.getStream() << Offset;
3557 Mangler.getStream() << '_';
3558 Mangler.mangleNameOrStandardSubstitution(Type);
3559}
3560
3561void ItaniumMangleContext::mangleCXXRTTI(QualType Ty,
3562 raw_ostream &Out) {
3563 // <special-name> ::= TI <type> # typeinfo structure
3564 assert(!Ty.hasQualifiers() && "RTTI info cannot have top-level qualifiers");
3565 CXXNameMangler Mangler(*this, Out);
3566 Mangler.getStream() << "_ZTI";
3567 Mangler.mangleType(Ty);
3568}
3569
3570void ItaniumMangleContext::mangleCXXRTTIName(QualType Ty,
3571 raw_ostream &Out) {
3572 // <special-name> ::= TS <type> # typeinfo name (null terminated byte string)
3573 CXXNameMangler Mangler(*this, Out);
3574 Mangler.getStream() << "_ZTS";
3575 Mangler.mangleType(Ty);
3576}
3577
3578MangleContext *clang::createItaniumMangleContext(ASTContext &Context,
3579 DiagnosticsEngine &Diags) {
3580 return new ItaniumMangleContext(Context, Diags);
3581}