ItaniumMangle.cpp revision 864c041e118155c2b1ce0ba36942a3da5a4a055e
1//===--- 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/Decl.h"
20#include "clang/AST/DeclCXX.h"
21#include "clang/AST/DeclObjC.h"
22#include "clang/AST/DeclTemplate.h"
23#include "clang/AST/ExprCXX.h"
24#include "clang/Basic/ABI.h"
25#include "clang/Basic/SourceManager.h"
26#include "clang/Basic/TargetInfo.h"
27#include "llvm/ADT/StringExtras.h"
28#include "llvm/Support/raw_ostream.h"
29#include "llvm/Support/ErrorHandling.h"
30
31#define MANGLE_CHECKER 0
32
33#if MANGLE_CHECKER
34#include <cxxabi.h>
35#endif
36
37using namespace clang;
38
39namespace {
40
41static const CXXRecordDecl *GetLocalClassDecl(const NamedDecl *ND) {
42  const DeclContext *DC = dyn_cast<DeclContext>(ND);
43  if (!DC)
44    DC = ND->getDeclContext();
45  while (!DC->isNamespace() && !DC->isTranslationUnit()) {
46    if (isa<FunctionDecl>(DC->getParent()))
47      return dyn_cast<CXXRecordDecl>(DC);
48    DC = DC->getParent();
49  }
50  return 0;
51}
52
53static const CXXMethodDecl *getStructor(const CXXMethodDecl *MD) {
54  assert((isa<CXXConstructorDecl>(MD) || isa<CXXDestructorDecl>(MD)) &&
55         "Passed in decl is not a ctor or dtor!");
56
57  if (const TemplateDecl *TD = MD->getPrimaryTemplate()) {
58    MD = cast<CXXMethodDecl>(TD->getTemplatedDecl());
59
60    assert((isa<CXXConstructorDecl>(MD) || isa<CXXDestructorDecl>(MD)) &&
61           "Templated decl is not a ctor or dtor!");
62  }
63
64  return MD;
65}
66
67static const unsigned UnknownArity = ~0U;
68
69class ItaniumMangleContext : public MangleContext {
70  llvm::DenseMap<const TagDecl *, uint64_t> AnonStructIds;
71  unsigned Discriminator;
72  llvm::DenseMap<const NamedDecl*, unsigned> Uniquifier;
73
74public:
75  explicit ItaniumMangleContext(ASTContext &Context,
76                                Diagnostic &Diags)
77    : MangleContext(Context, Diags) { }
78
79  uint64_t getAnonymousStructId(const TagDecl *TD) {
80    std::pair<llvm::DenseMap<const TagDecl *,
81      uint64_t>::iterator, bool> Result =
82      AnonStructIds.insert(std::make_pair(TD, AnonStructIds.size()));
83    return Result.first->second;
84  }
85
86  void startNewFunction() {
87    MangleContext::startNewFunction();
88    mangleInitDiscriminator();
89  }
90
91  /// @name Mangler Entry Points
92  /// @{
93
94  bool shouldMangleDeclName(const NamedDecl *D);
95  void mangleName(const NamedDecl *D, llvm::raw_ostream &);
96  void mangleThunk(const CXXMethodDecl *MD,
97                   const ThunkInfo &Thunk,
98                   llvm::raw_ostream &);
99  void mangleCXXDtorThunk(const CXXDestructorDecl *DD, CXXDtorType Type,
100                          const ThisAdjustment &ThisAdjustment,
101                          llvm::raw_ostream &);
102  void mangleReferenceTemporary(const VarDecl *D,
103                                llvm::raw_ostream &);
104  void mangleCXXVTable(const CXXRecordDecl *RD,
105                       llvm::raw_ostream &);
106  void mangleCXXVTT(const CXXRecordDecl *RD,
107                    llvm::raw_ostream &);
108  void mangleCXXCtorVTable(const CXXRecordDecl *RD, int64_t Offset,
109                           const CXXRecordDecl *Type,
110                           llvm::raw_ostream &);
111  void mangleCXXRTTI(QualType T, llvm::raw_ostream &);
112  void mangleCXXRTTIName(QualType T, llvm::raw_ostream &);
113  void mangleCXXCtor(const CXXConstructorDecl *D, CXXCtorType Type,
114                     llvm::raw_ostream &);
115  void mangleCXXDtor(const CXXDestructorDecl *D, CXXDtorType Type,
116                     llvm::raw_ostream &);
117
118  void mangleItaniumGuardVariable(const VarDecl *D, llvm::raw_ostream &);
119
120  void mangleInitDiscriminator() {
121    Discriminator = 0;
122  }
123
124  bool getNextDiscriminator(const NamedDecl *ND, unsigned &disc) {
125    unsigned &discriminator = Uniquifier[ND];
126    if (!discriminator)
127      discriminator = ++Discriminator;
128    if (discriminator == 1)
129      return false;
130    disc = discriminator-2;
131    return true;
132  }
133  /// @}
134};
135
136/// CXXNameMangler - Manage the mangling of a single name.
137class CXXNameMangler {
138  ItaniumMangleContext &Context;
139  llvm::raw_ostream &Out;
140
141  const CXXMethodDecl *Structor;
142  unsigned StructorType;
143
144  /// SeqID - The next subsitution sequence number.
145  unsigned SeqID;
146
147  llvm::DenseMap<uintptr_t, unsigned> Substitutions;
148
149  ASTContext &getASTContext() const { return Context.getASTContext(); }
150
151public:
152  CXXNameMangler(ItaniumMangleContext &C, llvm::raw_ostream &Out_)
153    : Context(C), Out(Out_), Structor(0), StructorType(0), SeqID(0) { }
154  CXXNameMangler(ItaniumMangleContext &C, llvm::raw_ostream &Out_,
155                 const CXXConstructorDecl *D, CXXCtorType Type)
156    : Context(C), Out(Out_), Structor(getStructor(D)), StructorType(Type),
157    SeqID(0) { }
158  CXXNameMangler(ItaniumMangleContext &C, llvm::raw_ostream &Out_,
159                 const CXXDestructorDecl *D, CXXDtorType Type)
160    : Context(C), Out(Out_), Structor(getStructor(D)), StructorType(Type),
161    SeqID(0) { }
162
163#if MANGLE_CHECKER
164  ~CXXNameMangler() {
165    if (Out.str()[0] == '\01')
166      return;
167
168    int status = 0;
169    char *result = abi::__cxa_demangle(Out.str().str().c_str(), 0, 0, &status);
170    assert(status == 0 && "Could not demangle mangled name!");
171    free(result);
172  }
173#endif
174  llvm::raw_ostream &getStream() { return Out; }
175
176  void mangle(const NamedDecl *D, llvm::StringRef Prefix = "_Z");
177  void mangleCallOffset(int64_t NonVirtual, int64_t Virtual);
178  void mangleNumber(const llvm::APSInt &I);
179  void mangleNumber(int64_t Number);
180  void mangleFloat(const llvm::APFloat &F);
181  void mangleFunctionEncoding(const FunctionDecl *FD);
182  void mangleName(const NamedDecl *ND);
183  void mangleType(QualType T);
184  void mangleNameOrStandardSubstitution(const NamedDecl *ND);
185
186private:
187  bool mangleSubstitution(const NamedDecl *ND);
188  bool mangleSubstitution(QualType T);
189  bool mangleSubstitution(TemplateName Template);
190  bool mangleSubstitution(uintptr_t Ptr);
191
192  bool mangleStandardSubstitution(const NamedDecl *ND);
193
194  void addSubstitution(const NamedDecl *ND) {
195    ND = cast<NamedDecl>(ND->getCanonicalDecl());
196
197    addSubstitution(reinterpret_cast<uintptr_t>(ND));
198  }
199  void addSubstitution(QualType T);
200  void addSubstitution(TemplateName Template);
201  void addSubstitution(uintptr_t Ptr);
202
203  void mangleUnresolvedPrefix(NestedNameSpecifier *qualifier,
204                              NamedDecl *firstQualifierLookup,
205                              bool recursive = false);
206  void mangleUnresolvedName(NestedNameSpecifier *qualifier,
207                            NamedDecl *firstQualifierLookup,
208                            DeclarationName name,
209                            unsigned KnownArity = UnknownArity);
210
211  void mangleUnresolvedType(QualType type);
212
213  void mangleName(const TemplateDecl *TD,
214                  const TemplateArgument *TemplateArgs,
215                  unsigned NumTemplateArgs);
216  void mangleUnqualifiedName(const NamedDecl *ND) {
217    mangleUnqualifiedName(ND, ND->getDeclName(), UnknownArity);
218  }
219  void mangleUnqualifiedName(const NamedDecl *ND, DeclarationName Name,
220                             unsigned KnownArity);
221  void mangleUnscopedName(const NamedDecl *ND);
222  void mangleUnscopedTemplateName(const TemplateDecl *ND);
223  void mangleUnscopedTemplateName(TemplateName);
224  void mangleSourceName(const IdentifierInfo *II);
225  void mangleLocalName(const NamedDecl *ND);
226  void mangleNestedName(const NamedDecl *ND, const DeclContext *DC,
227                        bool NoFunction=false);
228  void mangleNestedName(const TemplateDecl *TD,
229                        const TemplateArgument *TemplateArgs,
230                        unsigned NumTemplateArgs);
231  void manglePrefix(NestedNameSpecifier *qualifier);
232  void manglePrefix(const DeclContext *DC, bool NoFunction=false);
233  void mangleTemplatePrefix(const TemplateDecl *ND);
234  void mangleTemplatePrefix(TemplateName Template);
235  void mangleOperatorName(OverloadedOperatorKind OO, unsigned Arity);
236  void mangleQualifiers(Qualifiers Quals);
237  void mangleRefQualifier(RefQualifierKind RefQualifier);
238
239  void mangleObjCMethodName(const ObjCMethodDecl *MD);
240
241  // Declare manglers for every type class.
242#define ABSTRACT_TYPE(CLASS, PARENT)
243#define NON_CANONICAL_TYPE(CLASS, PARENT)
244#define TYPE(CLASS, PARENT) void mangleType(const CLASS##Type *T);
245#include "clang/AST/TypeNodes.def"
246
247  void mangleType(const TagType*);
248  void mangleType(TemplateName);
249  void mangleBareFunctionType(const FunctionType *T,
250                              bool MangleReturnType);
251  void mangleNeonVectorType(const VectorType *T);
252
253  void mangleIntegerLiteral(QualType T, const llvm::APSInt &Value);
254  void mangleMemberExpr(const Expr *base, bool isArrow,
255                        NestedNameSpecifier *qualifier,
256                        NamedDecl *firstQualifierLookup,
257                        DeclarationName name,
258                        unsigned knownArity);
259  void mangleExpression(const Expr *E, unsigned Arity = UnknownArity);
260  void mangleCXXCtorType(CXXCtorType T);
261  void mangleCXXDtorType(CXXDtorType T);
262
263  void mangleTemplateArgs(const ExplicitTemplateArgumentList &TemplateArgs);
264  void mangleTemplateArgs(TemplateName Template,
265                          const TemplateArgument *TemplateArgs,
266                          unsigned NumTemplateArgs);
267  void mangleTemplateArgs(const TemplateParameterList &PL,
268                          const TemplateArgument *TemplateArgs,
269                          unsigned NumTemplateArgs);
270  void mangleTemplateArgs(const TemplateParameterList &PL,
271                          const TemplateArgumentList &AL);
272  void mangleTemplateArg(const NamedDecl *P, const TemplateArgument &A);
273
274  void mangleTemplateParameter(unsigned Index);
275};
276
277}
278
279static bool isInCLinkageSpecification(const Decl *D) {
280  D = D->getCanonicalDecl();
281  for (const DeclContext *DC = D->getDeclContext();
282       !DC->isTranslationUnit(); DC = DC->getParent()) {
283    if (const LinkageSpecDecl *Linkage = dyn_cast<LinkageSpecDecl>(DC))
284      return Linkage->getLanguage() == LinkageSpecDecl::lang_c;
285  }
286
287  return false;
288}
289
290bool ItaniumMangleContext::shouldMangleDeclName(const NamedDecl *D) {
291  // In C, functions with no attributes never need to be mangled. Fastpath them.
292  if (!getASTContext().getLangOptions().CPlusPlus && !D->hasAttrs())
293    return false;
294
295  // Any decl can be declared with __asm("foo") on it, and this takes precedence
296  // over all other naming in the .o file.
297  if (D->hasAttr<AsmLabelAttr>())
298    return true;
299
300  // Clang's "overloadable" attribute extension to C/C++ implies name mangling
301  // (always) as does passing a C++ member function and a function
302  // whose name is not a simple identifier.
303  const FunctionDecl *FD = dyn_cast<FunctionDecl>(D);
304  if (FD && (FD->hasAttr<OverloadableAttr>() || isa<CXXMethodDecl>(FD) ||
305             !FD->getDeclName().isIdentifier()))
306    return true;
307
308  // Otherwise, no mangling is done outside C++ mode.
309  if (!getASTContext().getLangOptions().CPlusPlus)
310    return false;
311
312  // Variables at global scope with non-internal linkage are not mangled
313  if (!FD) {
314    const DeclContext *DC = D->getDeclContext();
315    // Check for extern variable declared locally.
316    if (DC->isFunctionOrMethod() && D->hasLinkage())
317      while (!DC->isNamespace() && !DC->isTranslationUnit())
318        DC = DC->getParent();
319    if (DC->isTranslationUnit() && D->getLinkage() != InternalLinkage)
320      return false;
321  }
322
323  // Class members are always mangled.
324  if (D->getDeclContext()->isRecord())
325    return true;
326
327  // C functions and "main" are not mangled.
328  if ((FD && FD->isMain()) || isInCLinkageSpecification(D))
329    return false;
330
331  return true;
332}
333
334void CXXNameMangler::mangle(const NamedDecl *D, llvm::StringRef Prefix) {
335  // Any decl can be declared with __asm("foo") on it, and this takes precedence
336  // over all other naming in the .o file.
337  if (const AsmLabelAttr *ALA = D->getAttr<AsmLabelAttr>()) {
338    // If we have an asm name, then we use it as the mangling.
339
340    // Adding the prefix can cause problems when one file has a "foo" and
341    // another has a "\01foo". That is known to happen on ELF with the
342    // tricks normally used for producing aliases (PR9177). Fortunately the
343    // llvm mangler on ELF is a nop, so we can just avoid adding the \01
344    // marker.  We also avoid adding the marker if this is an alias for an
345    // LLVM intrinsic.
346    llvm::StringRef UserLabelPrefix =
347      getASTContext().Target.getUserLabelPrefix();
348    if (!UserLabelPrefix.empty() && !ALA->getLabel().startswith("llvm."))
349      Out << '\01';  // LLVM IR Marker for __asm("foo")
350
351    Out << ALA->getLabel();
352    return;
353  }
354
355  // <mangled-name> ::= _Z <encoding>
356  //            ::= <data name>
357  //            ::= <special-name>
358  Out << Prefix;
359  if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
360    mangleFunctionEncoding(FD);
361  else if (const VarDecl *VD = dyn_cast<VarDecl>(D))
362    mangleName(VD);
363  else
364    mangleName(cast<FieldDecl>(D));
365}
366
367void CXXNameMangler::mangleFunctionEncoding(const FunctionDecl *FD) {
368  // <encoding> ::= <function name> <bare-function-type>
369  mangleName(FD);
370
371  // Don't mangle in the type if this isn't a decl we should typically mangle.
372  if (!Context.shouldMangleDeclName(FD))
373    return;
374
375  // Whether the mangling of a function type includes the return type depends on
376  // the context and the nature of the function. The rules for deciding whether
377  // the return type is included are:
378  //
379  //   1. Template functions (names or types) have return types encoded, with
380  //   the exceptions listed below.
381  //   2. Function types not appearing as part of a function name mangling,
382  //   e.g. parameters, pointer types, etc., have return type encoded, with the
383  //   exceptions listed below.
384  //   3. Non-template function names do not have return types encoded.
385  //
386  // The exceptions mentioned in (1) and (2) above, for which the return type is
387  // never included, are
388  //   1. Constructors.
389  //   2. Destructors.
390  //   3. Conversion operator functions, e.g. operator int.
391  bool MangleReturnType = false;
392  if (FunctionTemplateDecl *PrimaryTemplate = FD->getPrimaryTemplate()) {
393    if (!(isa<CXXConstructorDecl>(FD) || isa<CXXDestructorDecl>(FD) ||
394          isa<CXXConversionDecl>(FD)))
395      MangleReturnType = true;
396
397    // Mangle the type of the primary template.
398    FD = PrimaryTemplate->getTemplatedDecl();
399  }
400
401  // Do the canonicalization out here because parameter types can
402  // undergo additional canonicalization (e.g. array decay).
403  const FunctionType *FT
404    = cast<FunctionType>(Context.getASTContext()
405                                          .getCanonicalType(FD->getType()));
406
407  mangleBareFunctionType(FT, MangleReturnType);
408}
409
410static const DeclContext *IgnoreLinkageSpecDecls(const DeclContext *DC) {
411  while (isa<LinkageSpecDecl>(DC)) {
412    DC = DC->getParent();
413  }
414
415  return DC;
416}
417
418/// isStd - Return whether a given namespace is the 'std' namespace.
419static bool isStd(const NamespaceDecl *NS) {
420  if (!IgnoreLinkageSpecDecls(NS->getParent())->isTranslationUnit())
421    return false;
422
423  const IdentifierInfo *II = NS->getOriginalNamespace()->getIdentifier();
424  return II && II->isStr("std");
425}
426
427// isStdNamespace - Return whether a given decl context is a toplevel 'std'
428// namespace.
429static bool isStdNamespace(const DeclContext *DC) {
430  if (!DC->isNamespace())
431    return false;
432
433  return isStd(cast<NamespaceDecl>(DC));
434}
435
436static const TemplateDecl *
437isTemplate(const NamedDecl *ND, const TemplateArgumentList *&TemplateArgs) {
438  // Check if we have a function template.
439  if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)){
440    if (const TemplateDecl *TD = FD->getPrimaryTemplate()) {
441      TemplateArgs = FD->getTemplateSpecializationArgs();
442      return TD;
443    }
444  }
445
446  // Check if we have a class template.
447  if (const ClassTemplateSpecializationDecl *Spec =
448        dyn_cast<ClassTemplateSpecializationDecl>(ND)) {
449    TemplateArgs = &Spec->getTemplateArgs();
450    return Spec->getSpecializedTemplate();
451  }
452
453  return 0;
454}
455
456void CXXNameMangler::mangleName(const NamedDecl *ND) {
457  //  <name> ::= <nested-name>
458  //         ::= <unscoped-name>
459  //         ::= <unscoped-template-name> <template-args>
460  //         ::= <local-name>
461  //
462  const DeclContext *DC = ND->getDeclContext();
463
464  // If this is an extern variable declared locally, the relevant DeclContext
465  // is that of the containing namespace, or the translation unit.
466  if (isa<FunctionDecl>(DC) && ND->hasLinkage())
467    while (!DC->isNamespace() && !DC->isTranslationUnit())
468      DC = DC->getParent();
469  else if (GetLocalClassDecl(ND)) {
470    mangleLocalName(ND);
471    return;
472  }
473
474  while (isa<LinkageSpecDecl>(DC))
475    DC = DC->getParent();
476
477  if (DC->isTranslationUnit() || isStdNamespace(DC)) {
478    // Check if we have a template.
479    const TemplateArgumentList *TemplateArgs = 0;
480    if (const TemplateDecl *TD = isTemplate(ND, TemplateArgs)) {
481      mangleUnscopedTemplateName(TD);
482      TemplateParameterList *TemplateParameters = TD->getTemplateParameters();
483      mangleTemplateArgs(*TemplateParameters, *TemplateArgs);
484      return;
485    }
486
487    mangleUnscopedName(ND);
488    return;
489  }
490
491  if (isa<FunctionDecl>(DC) || isa<ObjCMethodDecl>(DC)) {
492    mangleLocalName(ND);
493    return;
494  }
495
496  mangleNestedName(ND, DC);
497}
498void CXXNameMangler::mangleName(const TemplateDecl *TD,
499                                const TemplateArgument *TemplateArgs,
500                                unsigned NumTemplateArgs) {
501  const DeclContext *DC = IgnoreLinkageSpecDecls(TD->getDeclContext());
502
503  if (DC->isTranslationUnit() || isStdNamespace(DC)) {
504    mangleUnscopedTemplateName(TD);
505    TemplateParameterList *TemplateParameters = TD->getTemplateParameters();
506    mangleTemplateArgs(*TemplateParameters, TemplateArgs, NumTemplateArgs);
507  } else {
508    mangleNestedName(TD, TemplateArgs, NumTemplateArgs);
509  }
510}
511
512void CXXNameMangler::mangleUnscopedName(const NamedDecl *ND) {
513  //  <unscoped-name> ::= <unqualified-name>
514  //                  ::= St <unqualified-name>   # ::std::
515  if (isStdNamespace(ND->getDeclContext()))
516    Out << "St";
517
518  mangleUnqualifiedName(ND);
519}
520
521void CXXNameMangler::mangleUnscopedTemplateName(const TemplateDecl *ND) {
522  //     <unscoped-template-name> ::= <unscoped-name>
523  //                              ::= <substitution>
524  if (mangleSubstitution(ND))
525    return;
526
527  // <template-template-param> ::= <template-param>
528  if (const TemplateTemplateParmDecl *TTP
529                                     = dyn_cast<TemplateTemplateParmDecl>(ND)) {
530    mangleTemplateParameter(TTP->getIndex());
531    return;
532  }
533
534  mangleUnscopedName(ND->getTemplatedDecl());
535  addSubstitution(ND);
536}
537
538void CXXNameMangler::mangleUnscopedTemplateName(TemplateName Template) {
539  //     <unscoped-template-name> ::= <unscoped-name>
540  //                              ::= <substitution>
541  if (TemplateDecl *TD = Template.getAsTemplateDecl())
542    return mangleUnscopedTemplateName(TD);
543
544  if (mangleSubstitution(Template))
545    return;
546
547  // FIXME: How to cope with operators here?
548  DependentTemplateName *Dependent = Template.getAsDependentTemplateName();
549  assert(Dependent && "Not a dependent template name?");
550  if (!Dependent->isIdentifier()) {
551    // FIXME: We can't possibly know the arity of the operator here!
552    Diagnostic &Diags = Context.getDiags();
553    unsigned DiagID = Diags.getCustomDiagID(Diagnostic::Error,
554                                      "cannot mangle dependent operator name");
555    Diags.Report(DiagID);
556    return;
557  }
558
559  mangleSourceName(Dependent->getIdentifier());
560  addSubstitution(Template);
561}
562
563void CXXNameMangler::mangleFloat(const llvm::APFloat &f) {
564  // ABI:
565  //   Floating-point literals are encoded using a fixed-length
566  //   lowercase hexadecimal string corresponding to the internal
567  //   representation (IEEE on Itanium), high-order bytes first,
568  //   without leading zeroes. For example: "Lf bf800000 E" is -1.0f
569  //   on Itanium.
570  // APInt::toString uses uppercase hexadecimal, and it's not really
571  // worth embellishing that interface for this use case, so we just
572  // do a second pass to lowercase things.
573  typedef llvm::SmallString<20> buffer_t;
574  buffer_t buffer;
575  f.bitcastToAPInt().toString(buffer, 16, false);
576
577  for (buffer_t::iterator i = buffer.begin(), e = buffer.end(); i != e; ++i)
578    if (isupper(*i)) *i = tolower(*i);
579
580  Out.write(buffer.data(), buffer.size());
581}
582
583void CXXNameMangler::mangleNumber(const llvm::APSInt &Value) {
584  if (Value.isSigned() && Value.isNegative()) {
585    Out << 'n';
586    Value.abs().print(Out, true);
587  } else
588    Value.print(Out, Value.isSigned());
589}
590
591void CXXNameMangler::mangleNumber(int64_t Number) {
592  //  <number> ::= [n] <non-negative decimal integer>
593  if (Number < 0) {
594    Out << 'n';
595    Number = -Number;
596  }
597
598  Out << Number;
599}
600
601void CXXNameMangler::mangleCallOffset(int64_t NonVirtual, int64_t Virtual) {
602  //  <call-offset>  ::= h <nv-offset> _
603  //                 ::= v <v-offset> _
604  //  <nv-offset>    ::= <offset number>        # non-virtual base override
605  //  <v-offset>     ::= <offset number> _ <virtual offset number>
606  //                      # virtual base override, with vcall offset
607  if (!Virtual) {
608    Out << 'h';
609    mangleNumber(NonVirtual);
610    Out << '_';
611    return;
612  }
613
614  Out << 'v';
615  mangleNumber(NonVirtual);
616  Out << '_';
617  mangleNumber(Virtual);
618  Out << '_';
619}
620
621void CXXNameMangler::mangleUnresolvedType(QualType type) {
622  if (const TemplateSpecializationType *TST =
623        type->getAs<TemplateSpecializationType>()) {
624    if (!mangleSubstitution(QualType(TST, 0))) {
625      mangleTemplatePrefix(TST->getTemplateName());
626
627      // FIXME: GCC does not appear to mangle the template arguments when
628      // the template in question is a dependent template name. Should we
629      // emulate that badness?
630      mangleTemplateArgs(TST->getTemplateName(), TST->getArgs(),
631                         TST->getNumArgs());
632      addSubstitution(QualType(TST, 0));
633    }
634  } else if (const DependentTemplateSpecializationType *DTST
635               = type->getAs<DependentTemplateSpecializationType>()) {
636    TemplateName Template
637      = getASTContext().getDependentTemplateName(DTST->getQualifier(),
638                                                 DTST->getIdentifier());
639    mangleTemplatePrefix(Template);
640
641    // FIXME: GCC does not appear to mangle the template arguments when
642    // the template in question is a dependent template name. Should we
643    // emulate that badness?
644    mangleTemplateArgs(Template, DTST->getArgs(), DTST->getNumArgs());
645  } else {
646    // We use the QualType mangle type variant here because it handles
647    // substitutions.
648    mangleType(type);
649  }
650}
651
652/// Mangle everything prior to the base-unresolved-name in an unresolved-name.
653///
654/// \param firstQualifierLookup - the entity found by unqualified lookup
655///   for the first name in the qualifier, if this is for a member expression
656/// \param recursive - true if this is being called recursively,
657///   i.e. if there is more prefix "to the right".
658void CXXNameMangler::mangleUnresolvedPrefix(NestedNameSpecifier *qualifier,
659                                            NamedDecl *firstQualifierLookup,
660                                            bool recursive) {
661
662  // x, ::x
663  // <unresolved-name> ::= [gs] <base-unresolved-name>
664
665  // T::x / decltype(p)::x
666  // <unresolved-name> ::= sr <unresolved-type> <base-unresolved-name>
667
668  // T::N::x /decltype(p)::N::x
669  // <unresolved-name> ::= srN <unresolved-type> <unresolved-qualifier-level>+ E
670  //                       <base-unresolved-name>
671
672  // A::x, N::y, A<T>::z; "gs" means leading "::"
673  // <unresolved-name> ::= [gs] sr <unresolved-qualifier-level>+ E
674  //                       <base-unresolved-name>
675
676  switch (qualifier->getKind()) {
677  case NestedNameSpecifier::Global:
678    Out << "gs";
679
680    // We want an 'sr' unless this is the entire NNS.
681    if (recursive)
682      Out << "sr";
683
684    // We never want an 'E' here.
685    return;
686
687  case NestedNameSpecifier::Namespace:
688    if (qualifier->getPrefix())
689      mangleUnresolvedPrefix(qualifier->getPrefix(), firstQualifierLookup,
690                             /*recursive*/ true);
691    else
692      Out << "sr";
693    mangleSourceName(qualifier->getAsNamespace()->getIdentifier());
694    break;
695  case NestedNameSpecifier::NamespaceAlias:
696    if (qualifier->getPrefix())
697      mangleUnresolvedPrefix(qualifier->getPrefix(), firstQualifierLookup,
698                             /*recursive*/ true);
699    else
700      Out << "sr";
701    mangleSourceName(qualifier->getAsNamespaceAlias()->getIdentifier());
702    break;
703
704  case NestedNameSpecifier::TypeSpec:
705  case NestedNameSpecifier::TypeSpecWithTemplate: {
706    // Both cases want this.
707    Out << "sr";
708
709    // We only get here recursively if we're followed by identifiers.
710    if (recursive) Out << 'N';
711
712    mangleUnresolvedType(QualType(qualifier->getAsType(), 0));
713
714    // We never want to print 'E' directly after an unresolved-type,
715    // so we return directly.
716    return;
717  }
718
719  case NestedNameSpecifier::Identifier:
720    // Member expressions can have these without prefixes.
721    if (qualifier->getPrefix()) {
722      mangleUnresolvedPrefix(qualifier->getPrefix(), firstQualifierLookup,
723                             /*recursive*/ true);
724    } else if (firstQualifierLookup) {
725
726      // Try to make a proper qualifier out of the lookup result, and
727      // then just recurse on that.
728      NestedNameSpecifier *newQualifier;
729      if (TypeDecl *typeDecl = dyn_cast<TypeDecl>(firstQualifierLookup)) {
730        QualType type = getASTContext().getTypeDeclType(typeDecl);
731
732        // Pretend we had a different nested name specifier.
733        newQualifier = NestedNameSpecifier::Create(getASTContext(),
734                                                   /*prefix*/ 0,
735                                                   /*template*/ false,
736                                                   type.getTypePtr());
737      } else if (NamespaceDecl *nspace =
738                   dyn_cast<NamespaceDecl>(firstQualifierLookup)) {
739        newQualifier = NestedNameSpecifier::Create(getASTContext(),
740                                                   /*prefix*/ 0,
741                                                   nspace);
742      } else if (NamespaceAliasDecl *alias =
743                   dyn_cast<NamespaceAliasDecl>(firstQualifierLookup)) {
744        newQualifier = NestedNameSpecifier::Create(getASTContext(),
745                                                   /*prefix*/ 0,
746                                                   alias);
747      } else {
748        // No sensible mangling to do here.
749        newQualifier = 0;
750      }
751
752      if (newQualifier)
753        return mangleUnresolvedPrefix(newQualifier, /*lookup*/ 0, recursive);
754
755    } else {
756      Out << "sr";
757    }
758
759    mangleSourceName(qualifier->getAsIdentifier());
760    break;
761  }
762
763  // If this was the innermost part of the NNS, and we fell out to
764  // here, append an 'E'.
765  if (!recursive)
766    Out << 'E';
767}
768
769/// Mangle an unresolved-name, which is generally used for names which
770/// weren't resolved to specific entities.
771void CXXNameMangler::mangleUnresolvedName(NestedNameSpecifier *qualifier,
772                                          NamedDecl *firstQualifierLookup,
773                                          DeclarationName name,
774                                          unsigned knownArity) {
775  if (qualifier) mangleUnresolvedPrefix(qualifier, firstQualifierLookup);
776  mangleUnqualifiedName(0, name, knownArity);
777}
778
779static const FieldDecl *FindFirstNamedDataMember(const RecordDecl *RD) {
780  assert(RD->isAnonymousStructOrUnion() &&
781         "Expected anonymous struct or union!");
782
783  for (RecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end();
784       I != E; ++I) {
785    const FieldDecl *FD = *I;
786
787    if (FD->getIdentifier())
788      return FD;
789
790    if (const RecordType *RT = FD->getType()->getAs<RecordType>()) {
791      if (const FieldDecl *NamedDataMember =
792          FindFirstNamedDataMember(RT->getDecl()))
793        return NamedDataMember;
794    }
795  }
796
797  // We didn't find a named data member.
798  return 0;
799}
800
801void CXXNameMangler::mangleUnqualifiedName(const NamedDecl *ND,
802                                           DeclarationName Name,
803                                           unsigned KnownArity) {
804  //  <unqualified-name> ::= <operator-name>
805  //                     ::= <ctor-dtor-name>
806  //                     ::= <source-name>
807  switch (Name.getNameKind()) {
808  case DeclarationName::Identifier: {
809    if (const IdentifierInfo *II = Name.getAsIdentifierInfo()) {
810      // We must avoid conflicts between internally- and externally-
811      // linked variable and function declaration names in the same TU:
812      //   void test() { extern void foo(); }
813      //   static void foo();
814      // This naming convention is the same as that followed by GCC,
815      // though it shouldn't actually matter.
816      if (ND && ND->getLinkage() == InternalLinkage &&
817          ND->getDeclContext()->isFileContext())
818        Out << 'L';
819
820      mangleSourceName(II);
821      break;
822    }
823
824    // Otherwise, an anonymous entity.  We must have a declaration.
825    assert(ND && "mangling empty name without declaration");
826
827    if (const NamespaceDecl *NS = dyn_cast<NamespaceDecl>(ND)) {
828      if (NS->isAnonymousNamespace()) {
829        // This is how gcc mangles these names.
830        Out << "12_GLOBAL__N_1";
831        break;
832      }
833    }
834
835    if (const VarDecl *VD = dyn_cast<VarDecl>(ND)) {
836      // We must have an anonymous union or struct declaration.
837      const RecordDecl *RD =
838        cast<RecordDecl>(VD->getType()->getAs<RecordType>()->getDecl());
839
840      // Itanium C++ ABI 5.1.2:
841      //
842      //   For the purposes of mangling, the name of an anonymous union is
843      //   considered to be the name of the first named data member found by a
844      //   pre-order, depth-first, declaration-order walk of the data members of
845      //   the anonymous union. If there is no such data member (i.e., if all of
846      //   the data members in the union are unnamed), then there is no way for
847      //   a program to refer to the anonymous union, and there is therefore no
848      //   need to mangle its name.
849      const FieldDecl *FD = FindFirstNamedDataMember(RD);
850
851      // It's actually possible for various reasons for us to get here
852      // with an empty anonymous struct / union.  Fortunately, it
853      // doesn't really matter what name we generate.
854      if (!FD) break;
855      assert(FD->getIdentifier() && "Data member name isn't an identifier!");
856
857      mangleSourceName(FD->getIdentifier());
858      break;
859    }
860
861    // We must have an anonymous struct.
862    const TagDecl *TD = cast<TagDecl>(ND);
863    if (const TypedefNameDecl *D = TD->getTypedefNameForAnonDecl()) {
864      assert(TD->getDeclContext() == D->getDeclContext() &&
865             "Typedef should not be in another decl context!");
866      assert(D->getDeclName().getAsIdentifierInfo() &&
867             "Typedef was not named!");
868      mangleSourceName(D->getDeclName().getAsIdentifierInfo());
869      break;
870    }
871
872    // Get a unique id for the anonymous struct.
873    uint64_t AnonStructId = Context.getAnonymousStructId(TD);
874
875    // Mangle it as a source name in the form
876    // [n] $_<id>
877    // where n is the length of the string.
878    llvm::SmallString<8> Str;
879    Str += "$_";
880    Str += llvm::utostr(AnonStructId);
881
882    Out << Str.size();
883    Out << Str.str();
884    break;
885  }
886
887  case DeclarationName::ObjCZeroArgSelector:
888  case DeclarationName::ObjCOneArgSelector:
889  case DeclarationName::ObjCMultiArgSelector:
890    assert(false && "Can't mangle Objective-C selector names here!");
891    break;
892
893  case DeclarationName::CXXConstructorName:
894    if (ND == Structor)
895      // If the named decl is the C++ constructor we're mangling, use the type
896      // we were given.
897      mangleCXXCtorType(static_cast<CXXCtorType>(StructorType));
898    else
899      // Otherwise, use the complete constructor name. This is relevant if a
900      // class with a constructor is declared within a constructor.
901      mangleCXXCtorType(Ctor_Complete);
902    break;
903
904  case DeclarationName::CXXDestructorName:
905    if (ND == Structor)
906      // If the named decl is the C++ destructor we're mangling, use the type we
907      // were given.
908      mangleCXXDtorType(static_cast<CXXDtorType>(StructorType));
909    else
910      // Otherwise, use the complete destructor name. This is relevant if a
911      // class with a destructor is declared within a destructor.
912      mangleCXXDtorType(Dtor_Complete);
913    break;
914
915  case DeclarationName::CXXConversionFunctionName:
916    // <operator-name> ::= cv <type>    # (cast)
917    Out << "cv";
918    mangleType(Context.getASTContext().getCanonicalType(Name.getCXXNameType()));
919    break;
920
921  case DeclarationName::CXXOperatorName: {
922    unsigned Arity;
923    if (ND) {
924      Arity = cast<FunctionDecl>(ND)->getNumParams();
925
926      // If we have a C++ member function, we need to include the 'this' pointer.
927      // FIXME: This does not make sense for operators that are static, but their
928      // names stay the same regardless of the arity (operator new for instance).
929      if (isa<CXXMethodDecl>(ND))
930        Arity++;
931    } else
932      Arity = KnownArity;
933
934    mangleOperatorName(Name.getCXXOverloadedOperator(), Arity);
935    break;
936  }
937
938  case DeclarationName::CXXLiteralOperatorName:
939    // FIXME: This mangling is not yet official.
940    Out << "li";
941    mangleSourceName(Name.getCXXLiteralIdentifier());
942    break;
943
944  case DeclarationName::CXXUsingDirective:
945    assert(false && "Can't mangle a using directive name!");
946    break;
947  }
948}
949
950void CXXNameMangler::mangleSourceName(const IdentifierInfo *II) {
951  // <source-name> ::= <positive length number> <identifier>
952  // <number> ::= [n] <non-negative decimal integer>
953  // <identifier> ::= <unqualified source code identifier>
954  Out << II->getLength() << II->getName();
955}
956
957void CXXNameMangler::mangleNestedName(const NamedDecl *ND,
958                                      const DeclContext *DC,
959                                      bool NoFunction) {
960  // <nested-name>
961  //   ::= N [<CV-qualifiers>] [<ref-qualifier>] <prefix> <unqualified-name> E
962  //   ::= N [<CV-qualifiers>] [<ref-qualifier>] <template-prefix>
963  //       <template-args> E
964
965  Out << 'N';
966  if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(ND)) {
967    mangleQualifiers(Qualifiers::fromCVRMask(Method->getTypeQualifiers()));
968    mangleRefQualifier(Method->getRefQualifier());
969  }
970
971  // Check if we have a template.
972  const TemplateArgumentList *TemplateArgs = 0;
973  if (const TemplateDecl *TD = isTemplate(ND, TemplateArgs)) {
974    mangleTemplatePrefix(TD);
975    TemplateParameterList *TemplateParameters = TD->getTemplateParameters();
976    mangleTemplateArgs(*TemplateParameters, *TemplateArgs);
977  }
978  else {
979    manglePrefix(DC, NoFunction);
980    mangleUnqualifiedName(ND);
981  }
982
983  Out << 'E';
984}
985void CXXNameMangler::mangleNestedName(const TemplateDecl *TD,
986                                      const TemplateArgument *TemplateArgs,
987                                      unsigned NumTemplateArgs) {
988  // <nested-name> ::= N [<CV-qualifiers>] <template-prefix> <template-args> E
989
990  Out << 'N';
991
992  mangleTemplatePrefix(TD);
993  TemplateParameterList *TemplateParameters = TD->getTemplateParameters();
994  mangleTemplateArgs(*TemplateParameters, TemplateArgs, NumTemplateArgs);
995
996  Out << 'E';
997}
998
999void CXXNameMangler::mangleLocalName(const NamedDecl *ND) {
1000  // <local-name> := Z <function encoding> E <entity name> [<discriminator>]
1001  //              := Z <function encoding> E s [<discriminator>]
1002  // <discriminator> := _ <non-negative number>
1003  const DeclContext *DC = ND->getDeclContext();
1004  Out << 'Z';
1005
1006  if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(DC)) {
1007   mangleObjCMethodName(MD);
1008  } else if (const CXXRecordDecl *RD = GetLocalClassDecl(ND)) {
1009    mangleFunctionEncoding(cast<FunctionDecl>(RD->getDeclContext()));
1010    Out << 'E';
1011
1012    // Mangle the name relative to the closest enclosing function.
1013    if (ND == RD) // equality ok because RD derived from ND above
1014      mangleUnqualifiedName(ND);
1015    else
1016      mangleNestedName(ND, DC, true /*NoFunction*/);
1017
1018    unsigned disc;
1019    if (Context.getNextDiscriminator(RD, disc)) {
1020      if (disc < 10)
1021        Out << '_' << disc;
1022      else
1023        Out << "__" << disc << '_';
1024    }
1025
1026    return;
1027  }
1028  else
1029    mangleFunctionEncoding(cast<FunctionDecl>(DC));
1030
1031  Out << 'E';
1032  mangleUnqualifiedName(ND);
1033}
1034
1035void CXXNameMangler::manglePrefix(NestedNameSpecifier *qualifier) {
1036  switch (qualifier->getKind()) {
1037  case NestedNameSpecifier::Global:
1038    // nothing
1039    return;
1040
1041  case NestedNameSpecifier::Namespace:
1042    mangleName(qualifier->getAsNamespace());
1043    return;
1044
1045  case NestedNameSpecifier::NamespaceAlias:
1046    mangleName(qualifier->getAsNamespaceAlias()->getNamespace());
1047    return;
1048
1049  case NestedNameSpecifier::TypeSpec:
1050  case NestedNameSpecifier::TypeSpecWithTemplate:
1051    mangleUnresolvedType(QualType(qualifier->getAsType(), 0));
1052    return;
1053
1054  case NestedNameSpecifier::Identifier:
1055    // Member expressions can have these without prefixes, but that
1056    // should end up in mangleUnresolvedPrefix instead.
1057    assert(qualifier->getPrefix());
1058    manglePrefix(qualifier->getPrefix());
1059
1060    mangleSourceName(qualifier->getAsIdentifier());
1061    return;
1062  }
1063
1064  llvm_unreachable("unexpected nested name specifier");
1065}
1066
1067void CXXNameMangler::manglePrefix(const DeclContext *DC, bool NoFunction) {
1068  //  <prefix> ::= <prefix> <unqualified-name>
1069  //           ::= <template-prefix> <template-args>
1070  //           ::= <template-param>
1071  //           ::= # empty
1072  //           ::= <substitution>
1073
1074  while (isa<LinkageSpecDecl>(DC))
1075    DC = DC->getParent();
1076
1077  if (DC->isTranslationUnit())
1078    return;
1079
1080  if (const BlockDecl *Block = dyn_cast<BlockDecl>(DC)) {
1081    manglePrefix(DC->getParent(), NoFunction);
1082    llvm::SmallString<64> Name;
1083    llvm::raw_svector_ostream NameStream(Name);
1084    Context.mangleBlock(Block, NameStream);
1085    NameStream.flush();
1086    Out << Name.size() << Name;
1087    return;
1088  }
1089
1090  if (mangleSubstitution(cast<NamedDecl>(DC)))
1091    return;
1092
1093  // Check if we have a template.
1094  const TemplateArgumentList *TemplateArgs = 0;
1095  if (const TemplateDecl *TD = isTemplate(cast<NamedDecl>(DC), TemplateArgs)) {
1096    mangleTemplatePrefix(TD);
1097    TemplateParameterList *TemplateParameters = TD->getTemplateParameters();
1098    mangleTemplateArgs(*TemplateParameters, *TemplateArgs);
1099  }
1100  else if(NoFunction && (isa<FunctionDecl>(DC) || isa<ObjCMethodDecl>(DC)))
1101    return;
1102  else if (const ObjCMethodDecl *Method = dyn_cast<ObjCMethodDecl>(DC))
1103    mangleObjCMethodName(Method);
1104  else {
1105    manglePrefix(DC->getParent(), NoFunction);
1106    mangleUnqualifiedName(cast<NamedDecl>(DC));
1107  }
1108
1109  addSubstitution(cast<NamedDecl>(DC));
1110}
1111
1112void CXXNameMangler::mangleTemplatePrefix(TemplateName Template) {
1113  // <template-prefix> ::= <prefix> <template unqualified-name>
1114  //                   ::= <template-param>
1115  //                   ::= <substitution>
1116  if (TemplateDecl *TD = Template.getAsTemplateDecl())
1117    return mangleTemplatePrefix(TD);
1118
1119  if (QualifiedTemplateName *Qualified = Template.getAsQualifiedTemplateName())
1120    manglePrefix(Qualified->getQualifier());
1121
1122  if (OverloadedTemplateStorage *Overloaded
1123                                      = Template.getAsOverloadedTemplate()) {
1124    mangleUnqualifiedName(0, (*Overloaded->begin())->getDeclName(),
1125                          UnknownArity);
1126    return;
1127  }
1128
1129  DependentTemplateName *Dependent = Template.getAsDependentTemplateName();
1130  assert(Dependent && "Unknown template name kind?");
1131  manglePrefix(Dependent->getQualifier());
1132  mangleUnscopedTemplateName(Template);
1133}
1134
1135void CXXNameMangler::mangleTemplatePrefix(const TemplateDecl *ND) {
1136  // <template-prefix> ::= <prefix> <template unqualified-name>
1137  //                   ::= <template-param>
1138  //                   ::= <substitution>
1139  // <template-template-param> ::= <template-param>
1140  //                               <substitution>
1141
1142  if (mangleSubstitution(ND))
1143    return;
1144
1145  // <template-template-param> ::= <template-param>
1146  if (const TemplateTemplateParmDecl *TTP
1147                                     = dyn_cast<TemplateTemplateParmDecl>(ND)) {
1148    mangleTemplateParameter(TTP->getIndex());
1149    return;
1150  }
1151
1152  manglePrefix(ND->getDeclContext());
1153  mangleUnqualifiedName(ND->getTemplatedDecl());
1154  addSubstitution(ND);
1155}
1156
1157/// Mangles a template name under the production <type>.  Required for
1158/// template template arguments.
1159///   <type> ::= <class-enum-type>
1160///          ::= <template-param>
1161///          ::= <substitution>
1162void CXXNameMangler::mangleType(TemplateName TN) {
1163  if (mangleSubstitution(TN))
1164    return;
1165
1166  TemplateDecl *TD = 0;
1167
1168  switch (TN.getKind()) {
1169  case TemplateName::QualifiedTemplate:
1170    TD = TN.getAsQualifiedTemplateName()->getTemplateDecl();
1171    goto HaveDecl;
1172
1173  case TemplateName::Template:
1174    TD = TN.getAsTemplateDecl();
1175    goto HaveDecl;
1176
1177  HaveDecl:
1178    if (isa<TemplateTemplateParmDecl>(TD))
1179      mangleTemplateParameter(cast<TemplateTemplateParmDecl>(TD)->getIndex());
1180    else
1181      mangleName(TD);
1182    break;
1183
1184  case TemplateName::OverloadedTemplate:
1185    llvm_unreachable("can't mangle an overloaded template name as a <type>");
1186    break;
1187
1188  case TemplateName::DependentTemplate: {
1189    const DependentTemplateName *Dependent = TN.getAsDependentTemplateName();
1190    assert(Dependent->isIdentifier());
1191
1192    // <class-enum-type> ::= <name>
1193    // <name> ::= <nested-name>
1194    mangleUnresolvedPrefix(Dependent->getQualifier(), 0);
1195    mangleSourceName(Dependent->getIdentifier());
1196    break;
1197  }
1198
1199  case TemplateName::SubstTemplateTemplateParmPack: {
1200    SubstTemplateTemplateParmPackStorage *SubstPack
1201      = TN.getAsSubstTemplateTemplateParmPack();
1202    mangleTemplateParameter(SubstPack->getParameterPack()->getIndex());
1203    break;
1204  }
1205  }
1206
1207  addSubstitution(TN);
1208}
1209
1210void
1211CXXNameMangler::mangleOperatorName(OverloadedOperatorKind OO, unsigned Arity) {
1212  switch (OO) {
1213  // <operator-name> ::= nw     # new
1214  case OO_New: Out << "nw"; break;
1215  //              ::= na        # new[]
1216  case OO_Array_New: Out << "na"; break;
1217  //              ::= dl        # delete
1218  case OO_Delete: Out << "dl"; break;
1219  //              ::= da        # delete[]
1220  case OO_Array_Delete: Out << "da"; break;
1221  //              ::= ps        # + (unary)
1222  //              ::= pl        # + (binary or unknown)
1223  case OO_Plus:
1224    Out << (Arity == 1? "ps" : "pl"); break;
1225  //              ::= ng        # - (unary)
1226  //              ::= mi        # - (binary or unknown)
1227  case OO_Minus:
1228    Out << (Arity == 1? "ng" : "mi"); break;
1229  //              ::= ad        # & (unary)
1230  //              ::= an        # & (binary or unknown)
1231  case OO_Amp:
1232    Out << (Arity == 1? "ad" : "an"); break;
1233  //              ::= de        # * (unary)
1234  //              ::= ml        # * (binary or unknown)
1235  case OO_Star:
1236    // Use binary when unknown.
1237    Out << (Arity == 1? "de" : "ml"); break;
1238  //              ::= co        # ~
1239  case OO_Tilde: Out << "co"; break;
1240  //              ::= dv        # /
1241  case OO_Slash: Out << "dv"; break;
1242  //              ::= rm        # %
1243  case OO_Percent: Out << "rm"; break;
1244  //              ::= or        # |
1245  case OO_Pipe: Out << "or"; break;
1246  //              ::= eo        # ^
1247  case OO_Caret: Out << "eo"; break;
1248  //              ::= aS        # =
1249  case OO_Equal: Out << "aS"; break;
1250  //              ::= pL        # +=
1251  case OO_PlusEqual: Out << "pL"; break;
1252  //              ::= mI        # -=
1253  case OO_MinusEqual: Out << "mI"; break;
1254  //              ::= mL        # *=
1255  case OO_StarEqual: Out << "mL"; break;
1256  //              ::= dV        # /=
1257  case OO_SlashEqual: Out << "dV"; break;
1258  //              ::= rM        # %=
1259  case OO_PercentEqual: Out << "rM"; break;
1260  //              ::= aN        # &=
1261  case OO_AmpEqual: Out << "aN"; break;
1262  //              ::= oR        # |=
1263  case OO_PipeEqual: Out << "oR"; break;
1264  //              ::= eO        # ^=
1265  case OO_CaretEqual: Out << "eO"; break;
1266  //              ::= ls        # <<
1267  case OO_LessLess: Out << "ls"; break;
1268  //              ::= rs        # >>
1269  case OO_GreaterGreater: Out << "rs"; break;
1270  //              ::= lS        # <<=
1271  case OO_LessLessEqual: Out << "lS"; break;
1272  //              ::= rS        # >>=
1273  case OO_GreaterGreaterEqual: Out << "rS"; break;
1274  //              ::= eq        # ==
1275  case OO_EqualEqual: Out << "eq"; break;
1276  //              ::= ne        # !=
1277  case OO_ExclaimEqual: Out << "ne"; break;
1278  //              ::= lt        # <
1279  case OO_Less: Out << "lt"; break;
1280  //              ::= gt        # >
1281  case OO_Greater: Out << "gt"; break;
1282  //              ::= le        # <=
1283  case OO_LessEqual: Out << "le"; break;
1284  //              ::= ge        # >=
1285  case OO_GreaterEqual: Out << "ge"; break;
1286  //              ::= nt        # !
1287  case OO_Exclaim: Out << "nt"; break;
1288  //              ::= aa        # &&
1289  case OO_AmpAmp: Out << "aa"; break;
1290  //              ::= oo        # ||
1291  case OO_PipePipe: Out << "oo"; break;
1292  //              ::= pp        # ++
1293  case OO_PlusPlus: Out << "pp"; break;
1294  //              ::= mm        # --
1295  case OO_MinusMinus: Out << "mm"; break;
1296  //              ::= cm        # ,
1297  case OO_Comma: Out << "cm"; break;
1298  //              ::= pm        # ->*
1299  case OO_ArrowStar: Out << "pm"; break;
1300  //              ::= pt        # ->
1301  case OO_Arrow: Out << "pt"; break;
1302  //              ::= cl        # ()
1303  case OO_Call: Out << "cl"; break;
1304  //              ::= ix        # []
1305  case OO_Subscript: Out << "ix"; break;
1306
1307  //              ::= qu        # ?
1308  // The conditional operator can't be overloaded, but we still handle it when
1309  // mangling expressions.
1310  case OO_Conditional: Out << "qu"; break;
1311
1312  case OO_None:
1313  case NUM_OVERLOADED_OPERATORS:
1314    assert(false && "Not an overloaded operator");
1315    break;
1316  }
1317}
1318
1319void CXXNameMangler::mangleQualifiers(Qualifiers Quals) {
1320  // <CV-qualifiers> ::= [r] [V] [K]    # restrict (C99), volatile, const
1321  if (Quals.hasRestrict())
1322    Out << 'r';
1323  if (Quals.hasVolatile())
1324    Out << 'V';
1325  if (Quals.hasConst())
1326    Out << 'K';
1327
1328  if (Quals.hasAddressSpace()) {
1329    // Extension:
1330    //
1331    //   <type> ::= U <address-space-number>
1332    //
1333    // where <address-space-number> is a source name consisting of 'AS'
1334    // followed by the address space <number>.
1335    llvm::SmallString<64> ASString;
1336    ASString = "AS" + llvm::utostr_32(Quals.getAddressSpace());
1337    Out << 'U' << ASString.size() << ASString;
1338  }
1339
1340  // FIXME: For now, just drop all extension qualifiers on the floor.
1341}
1342
1343void CXXNameMangler::mangleRefQualifier(RefQualifierKind RefQualifier) {
1344  // <ref-qualifier> ::= R                # lvalue reference
1345  //                 ::= O                # rvalue-reference
1346  // Proposal to Itanium C++ ABI list on 1/26/11
1347  switch (RefQualifier) {
1348  case RQ_None:
1349    break;
1350
1351  case RQ_LValue:
1352    Out << 'R';
1353    break;
1354
1355  case RQ_RValue:
1356    Out << 'O';
1357    break;
1358  }
1359}
1360
1361void CXXNameMangler::mangleObjCMethodName(const ObjCMethodDecl *MD) {
1362  Context.mangleObjCMethodName(MD, Out);
1363}
1364
1365void CXXNameMangler::mangleType(QualType nonCanon) {
1366  // Only operate on the canonical type!
1367  QualType canon = nonCanon.getCanonicalType();
1368
1369  SplitQualType split = canon.split();
1370  Qualifiers quals = split.second;
1371  const Type *ty = split.first;
1372
1373  bool isSubstitutable = quals || !isa<BuiltinType>(ty);
1374  if (isSubstitutable && mangleSubstitution(canon))
1375    return;
1376
1377  // If we're mangling a qualified array type, push the qualifiers to
1378  // the element type.
1379  if (quals && isa<ArrayType>(ty)) {
1380    ty = Context.getASTContext().getAsArrayType(canon);
1381    quals = Qualifiers();
1382
1383    // Note that we don't update canon: we want to add the
1384    // substitution at the canonical type.
1385  }
1386
1387  if (quals) {
1388    mangleQualifiers(quals);
1389    // Recurse:  even if the qualified type isn't yet substitutable,
1390    // the unqualified type might be.
1391    mangleType(QualType(ty, 0));
1392  } else {
1393    switch (ty->getTypeClass()) {
1394#define ABSTRACT_TYPE(CLASS, PARENT)
1395#define NON_CANONICAL_TYPE(CLASS, PARENT) \
1396    case Type::CLASS: \
1397      llvm_unreachable("can't mangle non-canonical type " #CLASS "Type"); \
1398      return;
1399#define TYPE(CLASS, PARENT) \
1400    case Type::CLASS: \
1401      mangleType(static_cast<const CLASS##Type*>(ty)); \
1402      break;
1403#include "clang/AST/TypeNodes.def"
1404    }
1405  }
1406
1407  // Add the substitution.
1408  if (isSubstitutable)
1409    addSubstitution(canon);
1410}
1411
1412void CXXNameMangler::mangleNameOrStandardSubstitution(const NamedDecl *ND) {
1413  if (!mangleStandardSubstitution(ND))
1414    mangleName(ND);
1415}
1416
1417void CXXNameMangler::mangleType(const BuiltinType *T) {
1418  //  <type>         ::= <builtin-type>
1419  //  <builtin-type> ::= v  # void
1420  //                 ::= w  # wchar_t
1421  //                 ::= b  # bool
1422  //                 ::= c  # char
1423  //                 ::= a  # signed char
1424  //                 ::= h  # unsigned char
1425  //                 ::= s  # short
1426  //                 ::= t  # unsigned short
1427  //                 ::= i  # int
1428  //                 ::= j  # unsigned int
1429  //                 ::= l  # long
1430  //                 ::= m  # unsigned long
1431  //                 ::= x  # long long, __int64
1432  //                 ::= y  # unsigned long long, __int64
1433  //                 ::= n  # __int128
1434  // UNSUPPORTED:    ::= o  # unsigned __int128
1435  //                 ::= f  # float
1436  //                 ::= d  # double
1437  //                 ::= e  # long double, __float80
1438  // UNSUPPORTED:    ::= g  # __float128
1439  // UNSUPPORTED:    ::= Dd # IEEE 754r decimal floating point (64 bits)
1440  // UNSUPPORTED:    ::= De # IEEE 754r decimal floating point (128 bits)
1441  // UNSUPPORTED:    ::= Df # IEEE 754r decimal floating point (32 bits)
1442  // UNSUPPORTED:    ::= Dh # IEEE 754r half-precision floating point (16 bits)
1443  //                 ::= Di # char32_t
1444  //                 ::= Ds # char16_t
1445  //                 ::= Dn # std::nullptr_t (i.e., decltype(nullptr))
1446  //                 ::= u <source-name>    # vendor extended type
1447  switch (T->getKind()) {
1448  case BuiltinType::Void: Out << 'v'; break;
1449  case BuiltinType::Bool: Out << 'b'; break;
1450  case BuiltinType::Char_U: case BuiltinType::Char_S: Out << 'c'; break;
1451  case BuiltinType::UChar: Out << 'h'; break;
1452  case BuiltinType::UShort: Out << 't'; break;
1453  case BuiltinType::UInt: Out << 'j'; break;
1454  case BuiltinType::ULong: Out << 'm'; break;
1455  case BuiltinType::ULongLong: Out << 'y'; break;
1456  case BuiltinType::UInt128: Out << 'o'; break;
1457  case BuiltinType::SChar: Out << 'a'; break;
1458  case BuiltinType::WChar_S:
1459  case BuiltinType::WChar_U: Out << 'w'; break;
1460  case BuiltinType::Char16: Out << "Ds"; break;
1461  case BuiltinType::Char32: Out << "Di"; break;
1462  case BuiltinType::Short: Out << 's'; break;
1463  case BuiltinType::Int: Out << 'i'; break;
1464  case BuiltinType::Long: Out << 'l'; break;
1465  case BuiltinType::LongLong: Out << 'x'; break;
1466  case BuiltinType::Int128: Out << 'n'; break;
1467  case BuiltinType::Float: Out << 'f'; break;
1468  case BuiltinType::Double: Out << 'd'; break;
1469  case BuiltinType::LongDouble: Out << 'e'; break;
1470  case BuiltinType::NullPtr: Out << "Dn"; break;
1471
1472  case BuiltinType::Overload:
1473  case BuiltinType::Dependent:
1474  case BuiltinType::BoundMember:
1475  case BuiltinType::UnknownAny:
1476    assert(false &&
1477           "Overloaded and dependent types shouldn't get to name mangling");
1478    break;
1479  case BuiltinType::ObjCId: Out << "11objc_object"; break;
1480  case BuiltinType::ObjCClass: Out << "10objc_class"; break;
1481  case BuiltinType::ObjCSel: Out << "13objc_selector"; break;
1482  }
1483}
1484
1485// <type>          ::= <function-type>
1486// <function-type> ::= F [Y] <bare-function-type> E
1487void CXXNameMangler::mangleType(const FunctionProtoType *T) {
1488  Out << 'F';
1489  // FIXME: We don't have enough information in the AST to produce the 'Y'
1490  // encoding for extern "C" function types.
1491  mangleBareFunctionType(T, /*MangleReturnType=*/true);
1492  Out << 'E';
1493}
1494void CXXNameMangler::mangleType(const FunctionNoProtoType *T) {
1495  llvm_unreachable("Can't mangle K&R function prototypes");
1496}
1497void CXXNameMangler::mangleBareFunctionType(const FunctionType *T,
1498                                            bool MangleReturnType) {
1499  // We should never be mangling something without a prototype.
1500  const FunctionProtoType *Proto = cast<FunctionProtoType>(T);
1501
1502  // <bare-function-type> ::= <signature type>+
1503  if (MangleReturnType)
1504    mangleType(Proto->getResultType());
1505
1506  if (Proto->getNumArgs() == 0 && !Proto->isVariadic()) {
1507    //   <builtin-type> ::= v   # void
1508    Out << 'v';
1509    return;
1510  }
1511
1512  for (FunctionProtoType::arg_type_iterator Arg = Proto->arg_type_begin(),
1513                                         ArgEnd = Proto->arg_type_end();
1514       Arg != ArgEnd; ++Arg)
1515    mangleType(*Arg);
1516
1517  // <builtin-type>      ::= z  # ellipsis
1518  if (Proto->isVariadic())
1519    Out << 'z';
1520}
1521
1522// <type>            ::= <class-enum-type>
1523// <class-enum-type> ::= <name>
1524void CXXNameMangler::mangleType(const UnresolvedUsingType *T) {
1525  mangleName(T->getDecl());
1526}
1527
1528// <type>            ::= <class-enum-type>
1529// <class-enum-type> ::= <name>
1530void CXXNameMangler::mangleType(const EnumType *T) {
1531  mangleType(static_cast<const TagType*>(T));
1532}
1533void CXXNameMangler::mangleType(const RecordType *T) {
1534  mangleType(static_cast<const TagType*>(T));
1535}
1536void CXXNameMangler::mangleType(const TagType *T) {
1537  mangleName(T->getDecl());
1538}
1539
1540// <type>       ::= <array-type>
1541// <array-type> ::= A <positive dimension number> _ <element type>
1542//              ::= A [<dimension expression>] _ <element type>
1543void CXXNameMangler::mangleType(const ConstantArrayType *T) {
1544  Out << 'A' << T->getSize() << '_';
1545  mangleType(T->getElementType());
1546}
1547void CXXNameMangler::mangleType(const VariableArrayType *T) {
1548  Out << 'A';
1549  // decayed vla types (size 0) will just be skipped.
1550  if (T->getSizeExpr())
1551    mangleExpression(T->getSizeExpr());
1552  Out << '_';
1553  mangleType(T->getElementType());
1554}
1555void CXXNameMangler::mangleType(const DependentSizedArrayType *T) {
1556  Out << 'A';
1557  mangleExpression(T->getSizeExpr());
1558  Out << '_';
1559  mangleType(T->getElementType());
1560}
1561void CXXNameMangler::mangleType(const IncompleteArrayType *T) {
1562  Out << "A_";
1563  mangleType(T->getElementType());
1564}
1565
1566// <type>                   ::= <pointer-to-member-type>
1567// <pointer-to-member-type> ::= M <class type> <member type>
1568void CXXNameMangler::mangleType(const MemberPointerType *T) {
1569  Out << 'M';
1570  mangleType(QualType(T->getClass(), 0));
1571  QualType PointeeType = T->getPointeeType();
1572  if (const FunctionProtoType *FPT = dyn_cast<FunctionProtoType>(PointeeType)) {
1573    mangleQualifiers(Qualifiers::fromCVRMask(FPT->getTypeQuals()));
1574    mangleRefQualifier(FPT->getRefQualifier());
1575    mangleType(FPT);
1576
1577    // Itanium C++ ABI 5.1.8:
1578    //
1579    //   The type of a non-static member function is considered to be different,
1580    //   for the purposes of substitution, from the type of a namespace-scope or
1581    //   static member function whose type appears similar. The types of two
1582    //   non-static member functions are considered to be different, for the
1583    //   purposes of substitution, if the functions are members of different
1584    //   classes. In other words, for the purposes of substitution, the class of
1585    //   which the function is a member is considered part of the type of
1586    //   function.
1587
1588    // We increment the SeqID here to emulate adding an entry to the
1589    // substitution table. We can't actually add it because we don't want this
1590    // particular function type to be substituted.
1591    ++SeqID;
1592  } else
1593    mangleType(PointeeType);
1594}
1595
1596// <type>           ::= <template-param>
1597void CXXNameMangler::mangleType(const TemplateTypeParmType *T) {
1598  mangleTemplateParameter(T->getIndex());
1599}
1600
1601// <type>           ::= <template-param>
1602void CXXNameMangler::mangleType(const SubstTemplateTypeParmPackType *T) {
1603  mangleTemplateParameter(T->getReplacedParameter()->getIndex());
1604}
1605
1606// <type> ::= P <type>   # pointer-to
1607void CXXNameMangler::mangleType(const PointerType *T) {
1608  Out << 'P';
1609  mangleType(T->getPointeeType());
1610}
1611void CXXNameMangler::mangleType(const ObjCObjectPointerType *T) {
1612  Out << 'P';
1613  mangleType(T->getPointeeType());
1614}
1615
1616// <type> ::= R <type>   # reference-to
1617void CXXNameMangler::mangleType(const LValueReferenceType *T) {
1618  Out << 'R';
1619  mangleType(T->getPointeeType());
1620}
1621
1622// <type> ::= O <type>   # rvalue reference-to (C++0x)
1623void CXXNameMangler::mangleType(const RValueReferenceType *T) {
1624  Out << 'O';
1625  mangleType(T->getPointeeType());
1626}
1627
1628// <type> ::= C <type>   # complex pair (C 2000)
1629void CXXNameMangler::mangleType(const ComplexType *T) {
1630  Out << 'C';
1631  mangleType(T->getElementType());
1632}
1633
1634// ARM's ABI for Neon vector types specifies that they should be mangled as
1635// if they are structs (to match ARM's initial implementation).  The
1636// vector type must be one of the special types predefined by ARM.
1637void CXXNameMangler::mangleNeonVectorType(const VectorType *T) {
1638  QualType EltType = T->getElementType();
1639  assert(EltType->isBuiltinType() && "Neon vector element not a BuiltinType");
1640  const char *EltName = 0;
1641  if (T->getVectorKind() == VectorType::NeonPolyVector) {
1642    switch (cast<BuiltinType>(EltType)->getKind()) {
1643    case BuiltinType::SChar:     EltName = "poly8_t"; break;
1644    case BuiltinType::Short:     EltName = "poly16_t"; break;
1645    default: llvm_unreachable("unexpected Neon polynomial vector element type");
1646    }
1647  } else {
1648    switch (cast<BuiltinType>(EltType)->getKind()) {
1649    case BuiltinType::SChar:     EltName = "int8_t"; break;
1650    case BuiltinType::UChar:     EltName = "uint8_t"; break;
1651    case BuiltinType::Short:     EltName = "int16_t"; break;
1652    case BuiltinType::UShort:    EltName = "uint16_t"; break;
1653    case BuiltinType::Int:       EltName = "int32_t"; break;
1654    case BuiltinType::UInt:      EltName = "uint32_t"; break;
1655    case BuiltinType::LongLong:  EltName = "int64_t"; break;
1656    case BuiltinType::ULongLong: EltName = "uint64_t"; break;
1657    case BuiltinType::Float:     EltName = "float32_t"; break;
1658    default: llvm_unreachable("unexpected Neon vector element type");
1659    }
1660  }
1661  const char *BaseName = 0;
1662  unsigned BitSize = (T->getNumElements() *
1663                      getASTContext().getTypeSize(EltType));
1664  if (BitSize == 64)
1665    BaseName = "__simd64_";
1666  else {
1667    assert(BitSize == 128 && "Neon vector type not 64 or 128 bits");
1668    BaseName = "__simd128_";
1669  }
1670  Out << strlen(BaseName) + strlen(EltName);
1671  Out << BaseName << EltName;
1672}
1673
1674// GNU extension: vector types
1675// <type>                  ::= <vector-type>
1676// <vector-type>           ::= Dv <positive dimension number> _
1677//                                    <extended element type>
1678//                         ::= Dv [<dimension expression>] _ <element type>
1679// <extended element type> ::= <element type>
1680//                         ::= p # AltiVec vector pixel
1681void CXXNameMangler::mangleType(const VectorType *T) {
1682  if ((T->getVectorKind() == VectorType::NeonVector ||
1683       T->getVectorKind() == VectorType::NeonPolyVector)) {
1684    mangleNeonVectorType(T);
1685    return;
1686  }
1687  Out << "Dv" << T->getNumElements() << '_';
1688  if (T->getVectorKind() == VectorType::AltiVecPixel)
1689    Out << 'p';
1690  else if (T->getVectorKind() == VectorType::AltiVecBool)
1691    Out << 'b';
1692  else
1693    mangleType(T->getElementType());
1694}
1695void CXXNameMangler::mangleType(const ExtVectorType *T) {
1696  mangleType(static_cast<const VectorType*>(T));
1697}
1698void CXXNameMangler::mangleType(const DependentSizedExtVectorType *T) {
1699  Out << "Dv";
1700  mangleExpression(T->getSizeExpr());
1701  Out << '_';
1702  mangleType(T->getElementType());
1703}
1704
1705void CXXNameMangler::mangleType(const PackExpansionType *T) {
1706  // <type>  ::= Dp <type>          # pack expansion (C++0x)
1707  Out << "Dp";
1708  mangleType(T->getPattern());
1709}
1710
1711void CXXNameMangler::mangleType(const ObjCInterfaceType *T) {
1712  mangleSourceName(T->getDecl()->getIdentifier());
1713}
1714
1715void CXXNameMangler::mangleType(const ObjCObjectType *T) {
1716  // We don't allow overloading by different protocol qualification,
1717  // so mangling them isn't necessary.
1718  mangleType(T->getBaseType());
1719}
1720
1721void CXXNameMangler::mangleType(const BlockPointerType *T) {
1722  Out << "U13block_pointer";
1723  mangleType(T->getPointeeType());
1724}
1725
1726void CXXNameMangler::mangleType(const InjectedClassNameType *T) {
1727  // Mangle injected class name types as if the user had written the
1728  // specialization out fully.  It may not actually be possible to see
1729  // this mangling, though.
1730  mangleType(T->getInjectedSpecializationType());
1731}
1732
1733void CXXNameMangler::mangleType(const TemplateSpecializationType *T) {
1734  if (TemplateDecl *TD = T->getTemplateName().getAsTemplateDecl()) {
1735    mangleName(TD, T->getArgs(), T->getNumArgs());
1736  } else {
1737    if (mangleSubstitution(QualType(T, 0)))
1738      return;
1739
1740    mangleTemplatePrefix(T->getTemplateName());
1741
1742    // FIXME: GCC does not appear to mangle the template arguments when
1743    // the template in question is a dependent template name. Should we
1744    // emulate that badness?
1745    mangleTemplateArgs(T->getTemplateName(), T->getArgs(), T->getNumArgs());
1746    addSubstitution(QualType(T, 0));
1747  }
1748}
1749
1750void CXXNameMangler::mangleType(const DependentNameType *T) {
1751  // Typename types are always nested
1752  Out << 'N';
1753  manglePrefix(T->getQualifier());
1754  mangleSourceName(T->getIdentifier());
1755  Out << 'E';
1756}
1757
1758void CXXNameMangler::mangleType(const DependentTemplateSpecializationType *T) {
1759  // Dependently-scoped template types are nested if they have a prefix.
1760  Out << 'N';
1761
1762  // TODO: avoid making this TemplateName.
1763  TemplateName Prefix =
1764    getASTContext().getDependentTemplateName(T->getQualifier(),
1765                                             T->getIdentifier());
1766  mangleTemplatePrefix(Prefix);
1767
1768  // FIXME: GCC does not appear to mangle the template arguments when
1769  // the template in question is a dependent template name. Should we
1770  // emulate that badness?
1771  mangleTemplateArgs(Prefix, T->getArgs(), T->getNumArgs());
1772  Out << 'E';
1773}
1774
1775void CXXNameMangler::mangleType(const TypeOfType *T) {
1776  // FIXME: this is pretty unsatisfactory, but there isn't an obvious
1777  // "extension with parameters" mangling.
1778  Out << "u6typeof";
1779}
1780
1781void CXXNameMangler::mangleType(const TypeOfExprType *T) {
1782  // FIXME: this is pretty unsatisfactory, but there isn't an obvious
1783  // "extension with parameters" mangling.
1784  Out << "u6typeof";
1785}
1786
1787void CXXNameMangler::mangleType(const DecltypeType *T) {
1788  Expr *E = T->getUnderlyingExpr();
1789
1790  // type ::= Dt <expression> E  # decltype of an id-expression
1791  //                             #   or class member access
1792  //      ::= DT <expression> E  # decltype of an expression
1793
1794  // This purports to be an exhaustive list of id-expressions and
1795  // class member accesses.  Note that we do not ignore parentheses;
1796  // parentheses change the semantics of decltype for these
1797  // expressions (and cause the mangler to use the other form).
1798  if (isa<DeclRefExpr>(E) ||
1799      isa<MemberExpr>(E) ||
1800      isa<UnresolvedLookupExpr>(E) ||
1801      isa<DependentScopeDeclRefExpr>(E) ||
1802      isa<CXXDependentScopeMemberExpr>(E) ||
1803      isa<UnresolvedMemberExpr>(E))
1804    Out << "Dt";
1805  else
1806    Out << "DT";
1807  mangleExpression(E);
1808  Out << 'E';
1809}
1810
1811void CXXNameMangler::mangleType(const AutoType *T) {
1812  QualType D = T->getDeducedType();
1813  // <builtin-type> ::= Da  # dependent auto
1814  if (D.isNull())
1815    Out << "Da";
1816  else
1817    mangleType(D);
1818}
1819
1820void CXXNameMangler::mangleIntegerLiteral(QualType T,
1821                                          const llvm::APSInt &Value) {
1822  //  <expr-primary> ::= L <type> <value number> E # integer literal
1823  Out << 'L';
1824
1825  mangleType(T);
1826  if (T->isBooleanType()) {
1827    // Boolean values are encoded as 0/1.
1828    Out << (Value.getBoolValue() ? '1' : '0');
1829  } else {
1830    mangleNumber(Value);
1831  }
1832  Out << 'E';
1833
1834}
1835
1836/// Mangles a member expression.  Implicit accesses are not handled,
1837/// but that should be okay, because you shouldn't be able to
1838/// make an implicit access in a function template declaration.
1839void CXXNameMangler::mangleMemberExpr(const Expr *base,
1840                                      bool isArrow,
1841                                      NestedNameSpecifier *qualifier,
1842                                      NamedDecl *firstQualifierLookup,
1843                                      DeclarationName member,
1844                                      unsigned arity) {
1845  // <expression> ::= dt <expression> <unresolved-name>
1846  //              ::= pt <expression> <unresolved-name>
1847  Out << (isArrow ? "pt" : "dt");
1848  mangleExpression(base);
1849  mangleUnresolvedName(qualifier, firstQualifierLookup, member, arity);
1850}
1851
1852void CXXNameMangler::mangleExpression(const Expr *E, unsigned Arity) {
1853  // <expression> ::= <unary operator-name> <expression>
1854  //              ::= <binary operator-name> <expression> <expression>
1855  //              ::= <trinary operator-name> <expression> <expression> <expression>
1856  //              ::= cl <expression>* E             # call
1857  //              ::= cv <type> expression           # conversion with one argument
1858  //              ::= cv <type> _ <expression>* E # conversion with a different number of arguments
1859  //              ::= st <type>                      # sizeof (a type)
1860  //              ::= at <type>                      # alignof (a type)
1861  //              ::= <template-param>
1862  //              ::= <function-param>
1863  //              ::= sr <type> <unqualified-name>                   # dependent name
1864  //              ::= sr <type> <unqualified-name> <template-args>   # dependent template-id
1865  //              ::= sZ <template-param>                            # size of a parameter pack
1866  //              ::= sZ <function-param>    # size of a function parameter pack
1867  //              ::= <expr-primary>
1868  // <expr-primary> ::= L <type> <value number> E    # integer literal
1869  //                ::= L <type <value float> E      # floating literal
1870  //                ::= L <mangled-name> E           # external name
1871  switch (E->getStmtClass()) {
1872  case Expr::NoStmtClass:
1873#define ABSTRACT_STMT(Type)
1874#define EXPR(Type, Base)
1875#define STMT(Type, Base) \
1876  case Expr::Type##Class:
1877#include "clang/AST/StmtNodes.inc"
1878    // fallthrough
1879
1880  // These all can only appear in local or variable-initialization
1881  // contexts and so should never appear in a mangling.
1882  case Expr::AddrLabelExprClass:
1883  case Expr::BlockDeclRefExprClass:
1884  case Expr::CXXThisExprClass:
1885  case Expr::DesignatedInitExprClass:
1886  case Expr::ImplicitValueInitExprClass:
1887  case Expr::InitListExprClass:
1888  case Expr::ParenListExprClass:
1889  case Expr::CXXScalarValueInitExprClass:
1890    llvm_unreachable("unexpected statement kind");
1891    break;
1892
1893  // FIXME: invent manglings for all these.
1894  case Expr::BlockExprClass:
1895  case Expr::CXXPseudoDestructorExprClass:
1896  case Expr::ChooseExprClass:
1897  case Expr::CompoundLiteralExprClass:
1898  case Expr::ExtVectorElementExprClass:
1899  case Expr::GenericSelectionExprClass:
1900  case Expr::ObjCEncodeExprClass:
1901  case Expr::ObjCIsaExprClass:
1902  case Expr::ObjCIvarRefExprClass:
1903  case Expr::ObjCMessageExprClass:
1904  case Expr::ObjCPropertyRefExprClass:
1905  case Expr::ObjCProtocolExprClass:
1906  case Expr::ObjCSelectorExprClass:
1907  case Expr::ObjCStringLiteralClass:
1908  case Expr::OffsetOfExprClass:
1909  case Expr::PredefinedExprClass:
1910  case Expr::ShuffleVectorExprClass:
1911  case Expr::StmtExprClass:
1912  case Expr::UnaryTypeTraitExprClass:
1913  case Expr::BinaryTypeTraitExprClass:
1914  case Expr::ExpressionTraitExprClass:
1915  case Expr::VAArgExprClass:
1916  case Expr::CXXUuidofExprClass:
1917  case Expr::CXXNoexceptExprClass:
1918  case Expr::CUDAKernelCallExprClass: {
1919    // As bad as this diagnostic is, it's better than crashing.
1920    Diagnostic &Diags = Context.getDiags();
1921    unsigned DiagID = Diags.getCustomDiagID(Diagnostic::Error,
1922                                     "cannot yet mangle expression type %0");
1923    Diags.Report(E->getExprLoc(), DiagID)
1924      << E->getStmtClassName() << E->getSourceRange();
1925    break;
1926  }
1927
1928  // Even gcc-4.5 doesn't mangle this.
1929  case Expr::BinaryConditionalOperatorClass: {
1930    Diagnostic &Diags = Context.getDiags();
1931    unsigned DiagID =
1932      Diags.getCustomDiagID(Diagnostic::Error,
1933                "?: operator with omitted middle operand cannot be mangled");
1934    Diags.Report(E->getExprLoc(), DiagID)
1935      << E->getStmtClassName() << E->getSourceRange();
1936    break;
1937  }
1938
1939  // These are used for internal purposes and cannot be meaningfully mangled.
1940  case Expr::OpaqueValueExprClass:
1941    llvm_unreachable("cannot mangle opaque value; mangling wrong thing?");
1942
1943  case Expr::CXXDefaultArgExprClass:
1944    mangleExpression(cast<CXXDefaultArgExpr>(E)->getExpr(), Arity);
1945    break;
1946
1947  case Expr::CXXMemberCallExprClass: // fallthrough
1948  case Expr::CallExprClass: {
1949    const CallExpr *CE = cast<CallExpr>(E);
1950    Out << "cl";
1951    mangleExpression(CE->getCallee(), CE->getNumArgs());
1952    for (unsigned I = 0, N = CE->getNumArgs(); I != N; ++I)
1953      mangleExpression(CE->getArg(I));
1954    Out << 'E';
1955    break;
1956  }
1957
1958  case Expr::CXXNewExprClass: {
1959    // Proposal from David Vandervoorde, 2010.06.30
1960    const CXXNewExpr *New = cast<CXXNewExpr>(E);
1961    if (New->isGlobalNew()) Out << "gs";
1962    Out << (New->isArray() ? "na" : "nw");
1963    for (CXXNewExpr::const_arg_iterator I = New->placement_arg_begin(),
1964           E = New->placement_arg_end(); I != E; ++I)
1965      mangleExpression(*I);
1966    Out << '_';
1967    mangleType(New->getAllocatedType());
1968    if (New->hasInitializer()) {
1969      Out << "pi";
1970      for (CXXNewExpr::const_arg_iterator I = New->constructor_arg_begin(),
1971             E = New->constructor_arg_end(); I != E; ++I)
1972        mangleExpression(*I);
1973    }
1974    Out << 'E';
1975    break;
1976  }
1977
1978  case Expr::MemberExprClass: {
1979    const MemberExpr *ME = cast<MemberExpr>(E);
1980    mangleMemberExpr(ME->getBase(), ME->isArrow(),
1981                     ME->getQualifier(), 0, ME->getMemberDecl()->getDeclName(),
1982                     Arity);
1983    break;
1984  }
1985
1986  case Expr::UnresolvedMemberExprClass: {
1987    const UnresolvedMemberExpr *ME = cast<UnresolvedMemberExpr>(E);
1988    mangleMemberExpr(ME->getBase(), ME->isArrow(),
1989                     ME->getQualifier(), 0, ME->getMemberName(),
1990                     Arity);
1991    if (ME->hasExplicitTemplateArgs())
1992      mangleTemplateArgs(ME->getExplicitTemplateArgs());
1993    break;
1994  }
1995
1996  case Expr::CXXDependentScopeMemberExprClass: {
1997    const CXXDependentScopeMemberExpr *ME
1998      = cast<CXXDependentScopeMemberExpr>(E);
1999    mangleMemberExpr(ME->getBase(), ME->isArrow(),
2000                     ME->getQualifier(), ME->getFirstQualifierFoundInScope(),
2001                     ME->getMember(), Arity);
2002    if (ME->hasExplicitTemplateArgs())
2003      mangleTemplateArgs(ME->getExplicitTemplateArgs());
2004    break;
2005  }
2006
2007  case Expr::UnresolvedLookupExprClass: {
2008    const UnresolvedLookupExpr *ULE = cast<UnresolvedLookupExpr>(E);
2009    mangleUnresolvedName(ULE->getQualifier(), 0, ULE->getName(), Arity);
2010    if (ULE->hasExplicitTemplateArgs())
2011      mangleTemplateArgs(ULE->getExplicitTemplateArgs());
2012    break;
2013  }
2014
2015  case Expr::CXXUnresolvedConstructExprClass: {
2016    const CXXUnresolvedConstructExpr *CE = cast<CXXUnresolvedConstructExpr>(E);
2017    unsigned N = CE->arg_size();
2018
2019    Out << "cv";
2020    mangleType(CE->getType());
2021    if (N != 1) Out << '_';
2022    for (unsigned I = 0; I != N; ++I) mangleExpression(CE->getArg(I));
2023    if (N != 1) Out << 'E';
2024    break;
2025  }
2026
2027  case Expr::CXXTemporaryObjectExprClass:
2028  case Expr::CXXConstructExprClass: {
2029    const CXXConstructExpr *CE = cast<CXXConstructExpr>(E);
2030    unsigned N = CE->getNumArgs();
2031
2032    Out << "cv";
2033    mangleType(CE->getType());
2034    if (N != 1) Out << '_';
2035    for (unsigned I = 0; I != N; ++I) mangleExpression(CE->getArg(I));
2036    if (N != 1) Out << 'E';
2037    break;
2038  }
2039
2040  case Expr::UnaryExprOrTypeTraitExprClass: {
2041    const UnaryExprOrTypeTraitExpr *SAE = cast<UnaryExprOrTypeTraitExpr>(E);
2042    switch(SAE->getKind()) {
2043    case UETT_SizeOf:
2044      Out << 's';
2045      break;
2046    case UETT_AlignOf:
2047      Out << 'a';
2048      break;
2049    case UETT_VecStep:
2050      Diagnostic &Diags = Context.getDiags();
2051      unsigned DiagID = Diags.getCustomDiagID(Diagnostic::Error,
2052                                     "cannot yet mangle vec_step expression");
2053      Diags.Report(DiagID);
2054      return;
2055    }
2056    if (SAE->isArgumentType()) {
2057      Out << 't';
2058      mangleType(SAE->getArgumentType());
2059    } else {
2060      Out << 'z';
2061      mangleExpression(SAE->getArgumentExpr());
2062    }
2063    break;
2064  }
2065
2066  case Expr::CXXThrowExprClass: {
2067    const CXXThrowExpr *TE = cast<CXXThrowExpr>(E);
2068
2069    // Proposal from David Vandervoorde, 2010.06.30
2070    if (TE->getSubExpr()) {
2071      Out << "tw";
2072      mangleExpression(TE->getSubExpr());
2073    } else {
2074      Out << "tr";
2075    }
2076    break;
2077  }
2078
2079  case Expr::CXXTypeidExprClass: {
2080    const CXXTypeidExpr *TIE = cast<CXXTypeidExpr>(E);
2081
2082    // Proposal from David Vandervoorde, 2010.06.30
2083    if (TIE->isTypeOperand()) {
2084      Out << "ti";
2085      mangleType(TIE->getTypeOperand());
2086    } else {
2087      Out << "te";
2088      mangleExpression(TIE->getExprOperand());
2089    }
2090    break;
2091  }
2092
2093  case Expr::CXXDeleteExprClass: {
2094    const CXXDeleteExpr *DE = cast<CXXDeleteExpr>(E);
2095
2096    // Proposal from David Vandervoorde, 2010.06.30
2097    if (DE->isGlobalDelete()) Out << "gs";
2098    Out << (DE->isArrayForm() ? "da" : "dl");
2099    mangleExpression(DE->getArgument());
2100    break;
2101  }
2102
2103  case Expr::UnaryOperatorClass: {
2104    const UnaryOperator *UO = cast<UnaryOperator>(E);
2105    mangleOperatorName(UnaryOperator::getOverloadedOperator(UO->getOpcode()),
2106                       /*Arity=*/1);
2107    mangleExpression(UO->getSubExpr());
2108    break;
2109  }
2110
2111  case Expr::ArraySubscriptExprClass: {
2112    const ArraySubscriptExpr *AE = cast<ArraySubscriptExpr>(E);
2113
2114    // Array subscript is treated as a syntactically weird form of
2115    // binary operator.
2116    Out << "ix";
2117    mangleExpression(AE->getLHS());
2118    mangleExpression(AE->getRHS());
2119    break;
2120  }
2121
2122  case Expr::CompoundAssignOperatorClass: // fallthrough
2123  case Expr::BinaryOperatorClass: {
2124    const BinaryOperator *BO = cast<BinaryOperator>(E);
2125    mangleOperatorName(BinaryOperator::getOverloadedOperator(BO->getOpcode()),
2126                       /*Arity=*/2);
2127    mangleExpression(BO->getLHS());
2128    mangleExpression(BO->getRHS());
2129    break;
2130  }
2131
2132  case Expr::ConditionalOperatorClass: {
2133    const ConditionalOperator *CO = cast<ConditionalOperator>(E);
2134    mangleOperatorName(OO_Conditional, /*Arity=*/3);
2135    mangleExpression(CO->getCond());
2136    mangleExpression(CO->getLHS(), Arity);
2137    mangleExpression(CO->getRHS(), Arity);
2138    break;
2139  }
2140
2141  case Expr::ImplicitCastExprClass: {
2142    mangleExpression(cast<ImplicitCastExpr>(E)->getSubExpr(), Arity);
2143    break;
2144  }
2145
2146  case Expr::CStyleCastExprClass:
2147  case Expr::CXXStaticCastExprClass:
2148  case Expr::CXXDynamicCastExprClass:
2149  case Expr::CXXReinterpretCastExprClass:
2150  case Expr::CXXConstCastExprClass:
2151  case Expr::CXXFunctionalCastExprClass: {
2152    const ExplicitCastExpr *ECE = cast<ExplicitCastExpr>(E);
2153    Out << "cv";
2154    mangleType(ECE->getType());
2155    mangleExpression(ECE->getSubExpr());
2156    break;
2157  }
2158
2159  case Expr::CXXOperatorCallExprClass: {
2160    const CXXOperatorCallExpr *CE = cast<CXXOperatorCallExpr>(E);
2161    unsigned NumArgs = CE->getNumArgs();
2162    mangleOperatorName(CE->getOperator(), /*Arity=*/NumArgs);
2163    // Mangle the arguments.
2164    for (unsigned i = 0; i != NumArgs; ++i)
2165      mangleExpression(CE->getArg(i));
2166    break;
2167  }
2168
2169  case Expr::ParenExprClass:
2170    mangleExpression(cast<ParenExpr>(E)->getSubExpr(), Arity);
2171    break;
2172
2173  case Expr::DeclRefExprClass: {
2174    const NamedDecl *D = cast<DeclRefExpr>(E)->getDecl();
2175
2176    switch (D->getKind()) {
2177    default:
2178      //  <expr-primary> ::= L <mangled-name> E # external name
2179      Out << 'L';
2180      mangle(D, "_Z");
2181      Out << 'E';
2182      break;
2183
2184    case Decl::EnumConstant: {
2185      const EnumConstantDecl *ED = cast<EnumConstantDecl>(D);
2186      mangleIntegerLiteral(ED->getType(), ED->getInitVal());
2187      break;
2188    }
2189
2190    case Decl::NonTypeTemplateParm: {
2191      const NonTypeTemplateParmDecl *PD = cast<NonTypeTemplateParmDecl>(D);
2192      mangleTemplateParameter(PD->getIndex());
2193      break;
2194    }
2195
2196    }
2197
2198    break;
2199  }
2200
2201  case Expr::SubstNonTypeTemplateParmPackExprClass:
2202    mangleTemplateParameter(
2203     cast<SubstNonTypeTemplateParmPackExpr>(E)->getParameterPack()->getIndex());
2204    break;
2205
2206  case Expr::DependentScopeDeclRefExprClass: {
2207    const DependentScopeDeclRefExpr *DRE = cast<DependentScopeDeclRefExpr>(E);
2208    NestedNameSpecifier *NNS = DRE->getQualifier();
2209    const Type *QTy = NNS->getAsType();
2210
2211    // When we're dealing with a nested-name-specifier that has just a
2212    // dependent identifier in it, mangle that as a typename.  FIXME:
2213    // It isn't clear that we ever actually want to have such a
2214    // nested-name-specifier; why not just represent it as a typename type?
2215    if (!QTy && NNS->getAsIdentifier() && NNS->getPrefix()) {
2216      QTy = getASTContext().getDependentNameType(ETK_Typename,
2217                                                 NNS->getPrefix(),
2218                                                 NNS->getAsIdentifier())
2219              .getTypePtr();
2220    }
2221    assert(QTy && "Qualifier was not type!");
2222
2223    // ::= sr <type> <unqualified-name>                  # dependent name
2224    // ::= sr <type> <unqualified-name> <template-args>  # dependent template-id
2225    Out << "sr";
2226    mangleType(QualType(QTy, 0));
2227    mangleUnqualifiedName(0, DRE->getDeclName(), Arity);
2228    if (DRE->hasExplicitTemplateArgs())
2229      mangleTemplateArgs(DRE->getExplicitTemplateArgs());
2230
2231    break;
2232  }
2233
2234  case Expr::CXXBindTemporaryExprClass:
2235    mangleExpression(cast<CXXBindTemporaryExpr>(E)->getSubExpr());
2236    break;
2237
2238  case Expr::ExprWithCleanupsClass:
2239    mangleExpression(cast<ExprWithCleanups>(E)->getSubExpr(), Arity);
2240    break;
2241
2242  case Expr::FloatingLiteralClass: {
2243    const FloatingLiteral *FL = cast<FloatingLiteral>(E);
2244    Out << 'L';
2245    mangleType(FL->getType());
2246    mangleFloat(FL->getValue());
2247    Out << 'E';
2248    break;
2249  }
2250
2251  case Expr::CharacterLiteralClass:
2252    Out << 'L';
2253    mangleType(E->getType());
2254    Out << cast<CharacterLiteral>(E)->getValue();
2255    Out << 'E';
2256    break;
2257
2258  case Expr::CXXBoolLiteralExprClass:
2259    Out << "Lb";
2260    Out << (cast<CXXBoolLiteralExpr>(E)->getValue() ? '1' : '0');
2261    Out << 'E';
2262    break;
2263
2264  case Expr::IntegerLiteralClass: {
2265    llvm::APSInt Value(cast<IntegerLiteral>(E)->getValue());
2266    if (E->getType()->isSignedIntegerType())
2267      Value.setIsSigned(true);
2268    mangleIntegerLiteral(E->getType(), Value);
2269    break;
2270  }
2271
2272  case Expr::ImaginaryLiteralClass: {
2273    const ImaginaryLiteral *IE = cast<ImaginaryLiteral>(E);
2274    // Mangle as if a complex literal.
2275    // Proposal from David Vandevoorde, 2010.06.30.
2276    Out << 'L';
2277    mangleType(E->getType());
2278    if (const FloatingLiteral *Imag =
2279          dyn_cast<FloatingLiteral>(IE->getSubExpr())) {
2280      // Mangle a floating-point zero of the appropriate type.
2281      mangleFloat(llvm::APFloat(Imag->getValue().getSemantics()));
2282      Out << '_';
2283      mangleFloat(Imag->getValue());
2284    } else {
2285      Out << "0_";
2286      llvm::APSInt Value(cast<IntegerLiteral>(IE->getSubExpr())->getValue());
2287      if (IE->getSubExpr()->getType()->isSignedIntegerType())
2288        Value.setIsSigned(true);
2289      mangleNumber(Value);
2290    }
2291    Out << 'E';
2292    break;
2293  }
2294
2295  case Expr::StringLiteralClass: {
2296    // Revised proposal from David Vandervoorde, 2010.07.15.
2297    Out << 'L';
2298    assert(isa<ConstantArrayType>(E->getType()));
2299    mangleType(E->getType());
2300    Out << 'E';
2301    break;
2302  }
2303
2304  case Expr::GNUNullExprClass:
2305    // FIXME: should this really be mangled the same as nullptr?
2306    // fallthrough
2307
2308  case Expr::CXXNullPtrLiteralExprClass: {
2309    // Proposal from David Vandervoorde, 2010.06.30, as
2310    // modified by ABI list discussion.
2311    Out << "LDnE";
2312    break;
2313  }
2314
2315  case Expr::PackExpansionExprClass:
2316    Out << "sp";
2317    mangleExpression(cast<PackExpansionExpr>(E)->getPattern());
2318    break;
2319
2320  case Expr::SizeOfPackExprClass: {
2321    Out << "sZ";
2322    const NamedDecl *Pack = cast<SizeOfPackExpr>(E)->getPack();
2323    if (const TemplateTypeParmDecl *TTP = dyn_cast<TemplateTypeParmDecl>(Pack))
2324      mangleTemplateParameter(TTP->getIndex());
2325    else if (const NonTypeTemplateParmDecl *NTTP
2326                = dyn_cast<NonTypeTemplateParmDecl>(Pack))
2327      mangleTemplateParameter(NTTP->getIndex());
2328    else if (const TemplateTemplateParmDecl *TempTP
2329                                    = dyn_cast<TemplateTemplateParmDecl>(Pack))
2330      mangleTemplateParameter(TempTP->getIndex());
2331    else {
2332      // Note: proposed by Mike Herrick on 11/30/10
2333      // <expression> ::= sZ <function-param>  # size of function parameter pack
2334      Diagnostic &Diags = Context.getDiags();
2335      unsigned DiagID = Diags.getCustomDiagID(Diagnostic::Error,
2336                            "cannot mangle sizeof...(function parameter pack)");
2337      Diags.Report(DiagID);
2338      return;
2339    }
2340    break;
2341  }
2342  }
2343}
2344
2345void CXXNameMangler::mangleCXXCtorType(CXXCtorType T) {
2346  // <ctor-dtor-name> ::= C1  # complete object constructor
2347  //                  ::= C2  # base object constructor
2348  //                  ::= C3  # complete object allocating constructor
2349  //
2350  switch (T) {
2351  case Ctor_Complete:
2352    Out << "C1";
2353    break;
2354  case Ctor_Base:
2355    Out << "C2";
2356    break;
2357  case Ctor_CompleteAllocating:
2358    Out << "C3";
2359    break;
2360  }
2361}
2362
2363void CXXNameMangler::mangleCXXDtorType(CXXDtorType T) {
2364  // <ctor-dtor-name> ::= D0  # deleting destructor
2365  //                  ::= D1  # complete object destructor
2366  //                  ::= D2  # base object destructor
2367  //
2368  switch (T) {
2369  case Dtor_Deleting:
2370    Out << "D0";
2371    break;
2372  case Dtor_Complete:
2373    Out << "D1";
2374    break;
2375  case Dtor_Base:
2376    Out << "D2";
2377    break;
2378  }
2379}
2380
2381void CXXNameMangler::mangleTemplateArgs(
2382                          const ExplicitTemplateArgumentList &TemplateArgs) {
2383  // <template-args> ::= I <template-arg>+ E
2384  Out << 'I';
2385  for (unsigned I = 0, E = TemplateArgs.NumTemplateArgs; I != E; ++I)
2386    mangleTemplateArg(0, TemplateArgs.getTemplateArgs()[I].getArgument());
2387  Out << 'E';
2388}
2389
2390void CXXNameMangler::mangleTemplateArgs(TemplateName Template,
2391                                        const TemplateArgument *TemplateArgs,
2392                                        unsigned NumTemplateArgs) {
2393  if (TemplateDecl *TD = Template.getAsTemplateDecl())
2394    return mangleTemplateArgs(*TD->getTemplateParameters(), TemplateArgs,
2395                              NumTemplateArgs);
2396
2397  // <template-args> ::= I <template-arg>+ E
2398  Out << 'I';
2399  for (unsigned i = 0; i != NumTemplateArgs; ++i)
2400    mangleTemplateArg(0, TemplateArgs[i]);
2401  Out << 'E';
2402}
2403
2404void CXXNameMangler::mangleTemplateArgs(const TemplateParameterList &PL,
2405                                        const TemplateArgumentList &AL) {
2406  // <template-args> ::= I <template-arg>+ E
2407  Out << 'I';
2408  for (unsigned i = 0, e = AL.size(); i != e; ++i)
2409    mangleTemplateArg(PL.getParam(i), AL[i]);
2410  Out << 'E';
2411}
2412
2413void CXXNameMangler::mangleTemplateArgs(const TemplateParameterList &PL,
2414                                        const TemplateArgument *TemplateArgs,
2415                                        unsigned NumTemplateArgs) {
2416  // <template-args> ::= I <template-arg>+ E
2417  Out << 'I';
2418  for (unsigned i = 0; i != NumTemplateArgs; ++i)
2419    mangleTemplateArg(PL.getParam(i), TemplateArgs[i]);
2420  Out << 'E';
2421}
2422
2423void CXXNameMangler::mangleTemplateArg(const NamedDecl *P,
2424                                       const TemplateArgument &A) {
2425  // <template-arg> ::= <type>              # type or template
2426  //                ::= X <expression> E    # expression
2427  //                ::= <expr-primary>      # simple expressions
2428  //                ::= J <template-arg>* E # argument pack
2429  //                ::= sp <expression>     # pack expansion of (C++0x)
2430  switch (A.getKind()) {
2431  case TemplateArgument::Null:
2432    llvm_unreachable("Cannot mangle NULL template argument");
2433
2434  case TemplateArgument::Type:
2435    mangleType(A.getAsType());
2436    break;
2437  case TemplateArgument::Template:
2438    // This is mangled as <type>.
2439    mangleType(A.getAsTemplate());
2440    break;
2441  case TemplateArgument::TemplateExpansion:
2442    // <type>  ::= Dp <type>          # pack expansion (C++0x)
2443    Out << "Dp";
2444    mangleType(A.getAsTemplateOrTemplatePattern());
2445    break;
2446  case TemplateArgument::Expression:
2447    Out << 'X';
2448    mangleExpression(A.getAsExpr());
2449    Out << 'E';
2450    break;
2451  case TemplateArgument::Integral:
2452    mangleIntegerLiteral(A.getIntegralType(), *A.getAsIntegral());
2453    break;
2454  case TemplateArgument::Declaration: {
2455    assert(P && "Missing template parameter for declaration argument");
2456    //  <expr-primary> ::= L <mangled-name> E # external name
2457
2458    // Clang produces AST's where pointer-to-member-function expressions
2459    // and pointer-to-function expressions are represented as a declaration not
2460    // an expression. We compensate for it here to produce the correct mangling.
2461    NamedDecl *D = cast<NamedDecl>(A.getAsDecl());
2462    const NonTypeTemplateParmDecl *Parameter = cast<NonTypeTemplateParmDecl>(P);
2463    bool compensateMangling = !Parameter->getType()->isReferenceType();
2464    if (compensateMangling) {
2465      Out << 'X';
2466      mangleOperatorName(OO_Amp, 1);
2467    }
2468
2469    Out << 'L';
2470    // References to external entities use the mangled name; if the name would
2471    // not normally be manged then mangle it as unqualified.
2472    //
2473    // FIXME: The ABI specifies that external names here should have _Z, but
2474    // gcc leaves this off.
2475    if (compensateMangling)
2476      mangle(D, "_Z");
2477    else
2478      mangle(D, "Z");
2479    Out << 'E';
2480
2481    if (compensateMangling)
2482      Out << 'E';
2483
2484    break;
2485  }
2486
2487  case TemplateArgument::Pack: {
2488    // Note: proposal by Mike Herrick on 12/20/10
2489    Out << 'J';
2490    for (TemplateArgument::pack_iterator PA = A.pack_begin(),
2491                                      PAEnd = A.pack_end();
2492         PA != PAEnd; ++PA)
2493      mangleTemplateArg(P, *PA);
2494    Out << 'E';
2495  }
2496  }
2497}
2498
2499void CXXNameMangler::mangleTemplateParameter(unsigned Index) {
2500  // <template-param> ::= T_    # first template parameter
2501  //                  ::= T <parameter-2 non-negative number> _
2502  if (Index == 0)
2503    Out << "T_";
2504  else
2505    Out << 'T' << (Index - 1) << '_';
2506}
2507
2508// <substitution> ::= S <seq-id> _
2509//                ::= S_
2510bool CXXNameMangler::mangleSubstitution(const NamedDecl *ND) {
2511  // Try one of the standard substitutions first.
2512  if (mangleStandardSubstitution(ND))
2513    return true;
2514
2515  ND = cast<NamedDecl>(ND->getCanonicalDecl());
2516  return mangleSubstitution(reinterpret_cast<uintptr_t>(ND));
2517}
2518
2519bool CXXNameMangler::mangleSubstitution(QualType T) {
2520  if (!T.getCVRQualifiers()) {
2521    if (const RecordType *RT = T->getAs<RecordType>())
2522      return mangleSubstitution(RT->getDecl());
2523  }
2524
2525  uintptr_t TypePtr = reinterpret_cast<uintptr_t>(T.getAsOpaquePtr());
2526
2527  return mangleSubstitution(TypePtr);
2528}
2529
2530bool CXXNameMangler::mangleSubstitution(TemplateName Template) {
2531  if (TemplateDecl *TD = Template.getAsTemplateDecl())
2532    return mangleSubstitution(TD);
2533
2534  Template = Context.getASTContext().getCanonicalTemplateName(Template);
2535  return mangleSubstitution(
2536                      reinterpret_cast<uintptr_t>(Template.getAsVoidPointer()));
2537}
2538
2539bool CXXNameMangler::mangleSubstitution(uintptr_t Ptr) {
2540  llvm::DenseMap<uintptr_t, unsigned>::iterator I = Substitutions.find(Ptr);
2541  if (I == Substitutions.end())
2542    return false;
2543
2544  unsigned SeqID = I->second;
2545  if (SeqID == 0)
2546    Out << "S_";
2547  else {
2548    SeqID--;
2549
2550    // <seq-id> is encoded in base-36, using digits and upper case letters.
2551    char Buffer[10];
2552    char *BufferPtr = llvm::array_endof(Buffer);
2553
2554    if (SeqID == 0) *--BufferPtr = '0';
2555
2556    while (SeqID) {
2557      assert(BufferPtr > Buffer && "Buffer overflow!");
2558
2559      char c = static_cast<char>(SeqID % 36);
2560
2561      *--BufferPtr =  (c < 10 ? '0' + c : 'A' + c - 10);
2562      SeqID /= 36;
2563    }
2564
2565    Out << 'S'
2566        << llvm::StringRef(BufferPtr, llvm::array_endof(Buffer)-BufferPtr)
2567        << '_';
2568  }
2569
2570  return true;
2571}
2572
2573static bool isCharType(QualType T) {
2574  if (T.isNull())
2575    return false;
2576
2577  return T->isSpecificBuiltinType(BuiltinType::Char_S) ||
2578    T->isSpecificBuiltinType(BuiltinType::Char_U);
2579}
2580
2581/// isCharSpecialization - Returns whether a given type is a template
2582/// specialization of a given name with a single argument of type char.
2583static bool isCharSpecialization(QualType T, const char *Name) {
2584  if (T.isNull())
2585    return false;
2586
2587  const RecordType *RT = T->getAs<RecordType>();
2588  if (!RT)
2589    return false;
2590
2591  const ClassTemplateSpecializationDecl *SD =
2592    dyn_cast<ClassTemplateSpecializationDecl>(RT->getDecl());
2593  if (!SD)
2594    return false;
2595
2596  if (!isStdNamespace(SD->getDeclContext()))
2597    return false;
2598
2599  const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
2600  if (TemplateArgs.size() != 1)
2601    return false;
2602
2603  if (!isCharType(TemplateArgs[0].getAsType()))
2604    return false;
2605
2606  return SD->getIdentifier()->getName() == Name;
2607}
2608
2609template <std::size_t StrLen>
2610static bool isStreamCharSpecialization(const ClassTemplateSpecializationDecl*SD,
2611                                       const char (&Str)[StrLen]) {
2612  if (!SD->getIdentifier()->isStr(Str))
2613    return false;
2614
2615  const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
2616  if (TemplateArgs.size() != 2)
2617    return false;
2618
2619  if (!isCharType(TemplateArgs[0].getAsType()))
2620    return false;
2621
2622  if (!isCharSpecialization(TemplateArgs[1].getAsType(), "char_traits"))
2623    return false;
2624
2625  return true;
2626}
2627
2628bool CXXNameMangler::mangleStandardSubstitution(const NamedDecl *ND) {
2629  // <substitution> ::= St # ::std::
2630  if (const NamespaceDecl *NS = dyn_cast<NamespaceDecl>(ND)) {
2631    if (isStd(NS)) {
2632      Out << "St";
2633      return true;
2634    }
2635  }
2636
2637  if (const ClassTemplateDecl *TD = dyn_cast<ClassTemplateDecl>(ND)) {
2638    if (!isStdNamespace(TD->getDeclContext()))
2639      return false;
2640
2641    // <substitution> ::= Sa # ::std::allocator
2642    if (TD->getIdentifier()->isStr("allocator")) {
2643      Out << "Sa";
2644      return true;
2645    }
2646
2647    // <<substitution> ::= Sb # ::std::basic_string
2648    if (TD->getIdentifier()->isStr("basic_string")) {
2649      Out << "Sb";
2650      return true;
2651    }
2652  }
2653
2654  if (const ClassTemplateSpecializationDecl *SD =
2655        dyn_cast<ClassTemplateSpecializationDecl>(ND)) {
2656    if (!isStdNamespace(SD->getDeclContext()))
2657      return false;
2658
2659    //    <substitution> ::= Ss # ::std::basic_string<char,
2660    //                            ::std::char_traits<char>,
2661    //                            ::std::allocator<char> >
2662    if (SD->getIdentifier()->isStr("basic_string")) {
2663      const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
2664
2665      if (TemplateArgs.size() != 3)
2666        return false;
2667
2668      if (!isCharType(TemplateArgs[0].getAsType()))
2669        return false;
2670
2671      if (!isCharSpecialization(TemplateArgs[1].getAsType(), "char_traits"))
2672        return false;
2673
2674      if (!isCharSpecialization(TemplateArgs[2].getAsType(), "allocator"))
2675        return false;
2676
2677      Out << "Ss";
2678      return true;
2679    }
2680
2681    //    <substitution> ::= Si # ::std::basic_istream<char,
2682    //                            ::std::char_traits<char> >
2683    if (isStreamCharSpecialization(SD, "basic_istream")) {
2684      Out << "Si";
2685      return true;
2686    }
2687
2688    //    <substitution> ::= So # ::std::basic_ostream<char,
2689    //                            ::std::char_traits<char> >
2690    if (isStreamCharSpecialization(SD, "basic_ostream")) {
2691      Out << "So";
2692      return true;
2693    }
2694
2695    //    <substitution> ::= Sd # ::std::basic_iostream<char,
2696    //                            ::std::char_traits<char> >
2697    if (isStreamCharSpecialization(SD, "basic_iostream")) {
2698      Out << "Sd";
2699      return true;
2700    }
2701  }
2702  return false;
2703}
2704
2705void CXXNameMangler::addSubstitution(QualType T) {
2706  if (!T.getCVRQualifiers()) {
2707    if (const RecordType *RT = T->getAs<RecordType>()) {
2708      addSubstitution(RT->getDecl());
2709      return;
2710    }
2711  }
2712
2713  uintptr_t TypePtr = reinterpret_cast<uintptr_t>(T.getAsOpaquePtr());
2714  addSubstitution(TypePtr);
2715}
2716
2717void CXXNameMangler::addSubstitution(TemplateName Template) {
2718  if (TemplateDecl *TD = Template.getAsTemplateDecl())
2719    return addSubstitution(TD);
2720
2721  Template = Context.getASTContext().getCanonicalTemplateName(Template);
2722  addSubstitution(reinterpret_cast<uintptr_t>(Template.getAsVoidPointer()));
2723}
2724
2725void CXXNameMangler::addSubstitution(uintptr_t Ptr) {
2726  assert(!Substitutions.count(Ptr) && "Substitution already exists!");
2727  Substitutions[Ptr] = SeqID++;
2728}
2729
2730//
2731
2732/// \brief Mangles the name of the declaration D and emits that name to the
2733/// given output stream.
2734///
2735/// If the declaration D requires a mangled name, this routine will emit that
2736/// mangled name to \p os and return true. Otherwise, \p os will be unchanged
2737/// and this routine will return false. In this case, the caller should just
2738/// emit the identifier of the declaration (\c D->getIdentifier()) as its
2739/// name.
2740void ItaniumMangleContext::mangleName(const NamedDecl *D,
2741                                      llvm::raw_ostream &Out) {
2742  assert((isa<FunctionDecl>(D) || isa<VarDecl>(D)) &&
2743          "Invalid mangleName() call, argument is not a variable or function!");
2744  assert(!isa<CXXConstructorDecl>(D) && !isa<CXXDestructorDecl>(D) &&
2745         "Invalid mangleName() call on 'structor decl!");
2746
2747  PrettyStackTraceDecl CrashInfo(D, SourceLocation(),
2748                                 getASTContext().getSourceManager(),
2749                                 "Mangling declaration");
2750
2751  CXXNameMangler Mangler(*this, Out);
2752  return Mangler.mangle(D);
2753}
2754
2755void ItaniumMangleContext::mangleCXXCtor(const CXXConstructorDecl *D,
2756                                         CXXCtorType Type,
2757                                         llvm::raw_ostream &Out) {
2758  CXXNameMangler Mangler(*this, Out, D, Type);
2759  Mangler.mangle(D);
2760}
2761
2762void ItaniumMangleContext::mangleCXXDtor(const CXXDestructorDecl *D,
2763                                         CXXDtorType Type,
2764                                         llvm::raw_ostream &Out) {
2765  CXXNameMangler Mangler(*this, Out, D, Type);
2766  Mangler.mangle(D);
2767}
2768
2769void ItaniumMangleContext::mangleThunk(const CXXMethodDecl *MD,
2770                                       const ThunkInfo &Thunk,
2771                                       llvm::raw_ostream &Out) {
2772  //  <special-name> ::= T <call-offset> <base encoding>
2773  //                      # base is the nominal target function of thunk
2774  //  <special-name> ::= Tc <call-offset> <call-offset> <base encoding>
2775  //                      # base is the nominal target function of thunk
2776  //                      # first call-offset is 'this' adjustment
2777  //                      # second call-offset is result adjustment
2778
2779  assert(!isa<CXXDestructorDecl>(MD) &&
2780         "Use mangleCXXDtor for destructor decls!");
2781  CXXNameMangler Mangler(*this, Out);
2782  Mangler.getStream() << "_ZT";
2783  if (!Thunk.Return.isEmpty())
2784    Mangler.getStream() << 'c';
2785
2786  // Mangle the 'this' pointer adjustment.
2787  Mangler.mangleCallOffset(Thunk.This.NonVirtual, Thunk.This.VCallOffsetOffset);
2788
2789  // Mangle the return pointer adjustment if there is one.
2790  if (!Thunk.Return.isEmpty())
2791    Mangler.mangleCallOffset(Thunk.Return.NonVirtual,
2792                             Thunk.Return.VBaseOffsetOffset);
2793
2794  Mangler.mangleFunctionEncoding(MD);
2795}
2796
2797void
2798ItaniumMangleContext::mangleCXXDtorThunk(const CXXDestructorDecl *DD,
2799                                         CXXDtorType Type,
2800                                         const ThisAdjustment &ThisAdjustment,
2801                                         llvm::raw_ostream &Out) {
2802  //  <special-name> ::= T <call-offset> <base encoding>
2803  //                      # base is the nominal target function of thunk
2804  CXXNameMangler Mangler(*this, Out, DD, Type);
2805  Mangler.getStream() << "_ZT";
2806
2807  // Mangle the 'this' pointer adjustment.
2808  Mangler.mangleCallOffset(ThisAdjustment.NonVirtual,
2809                           ThisAdjustment.VCallOffsetOffset);
2810
2811  Mangler.mangleFunctionEncoding(DD);
2812}
2813
2814/// mangleGuardVariable - Returns the mangled name for a guard variable
2815/// for the passed in VarDecl.
2816void ItaniumMangleContext::mangleItaniumGuardVariable(const VarDecl *D,
2817                                                      llvm::raw_ostream &Out) {
2818  //  <special-name> ::= GV <object name>       # Guard variable for one-time
2819  //                                            # initialization
2820  CXXNameMangler Mangler(*this, Out);
2821  Mangler.getStream() << "_ZGV";
2822  Mangler.mangleName(D);
2823}
2824
2825void ItaniumMangleContext::mangleReferenceTemporary(const VarDecl *D,
2826                                                    llvm::raw_ostream &Out) {
2827  // We match the GCC mangling here.
2828  //  <special-name> ::= GR <object name>
2829  CXXNameMangler Mangler(*this, Out);
2830  Mangler.getStream() << "_ZGR";
2831  Mangler.mangleName(D);
2832}
2833
2834void ItaniumMangleContext::mangleCXXVTable(const CXXRecordDecl *RD,
2835                                           llvm::raw_ostream &Out) {
2836  // <special-name> ::= TV <type>  # virtual table
2837  CXXNameMangler Mangler(*this, Out);
2838  Mangler.getStream() << "_ZTV";
2839  Mangler.mangleNameOrStandardSubstitution(RD);
2840}
2841
2842void ItaniumMangleContext::mangleCXXVTT(const CXXRecordDecl *RD,
2843                                        llvm::raw_ostream &Out) {
2844  // <special-name> ::= TT <type>  # VTT structure
2845  CXXNameMangler Mangler(*this, Out);
2846  Mangler.getStream() << "_ZTT";
2847  Mangler.mangleNameOrStandardSubstitution(RD);
2848}
2849
2850void ItaniumMangleContext::mangleCXXCtorVTable(const CXXRecordDecl *RD,
2851                                               int64_t Offset,
2852                                               const CXXRecordDecl *Type,
2853                                               llvm::raw_ostream &Out) {
2854  // <special-name> ::= TC <type> <offset number> _ <base type>
2855  CXXNameMangler Mangler(*this, Out);
2856  Mangler.getStream() << "_ZTC";
2857  Mangler.mangleNameOrStandardSubstitution(RD);
2858  Mangler.getStream() << Offset;
2859  Mangler.getStream() << '_';
2860  Mangler.mangleNameOrStandardSubstitution(Type);
2861}
2862
2863void ItaniumMangleContext::mangleCXXRTTI(QualType Ty,
2864                                         llvm::raw_ostream &Out) {
2865  // <special-name> ::= TI <type>  # typeinfo structure
2866  assert(!Ty.hasQualifiers() && "RTTI info cannot have top-level qualifiers");
2867  CXXNameMangler Mangler(*this, Out);
2868  Mangler.getStream() << "_ZTI";
2869  Mangler.mangleType(Ty);
2870}
2871
2872void ItaniumMangleContext::mangleCXXRTTIName(QualType Ty,
2873                                             llvm::raw_ostream &Out) {
2874  // <special-name> ::= TS <type>  # typeinfo name (null terminated byte string)
2875  CXXNameMangler Mangler(*this, Out);
2876  Mangler.getStream() << "_ZTS";
2877  Mangler.mangleType(Ty);
2878}
2879
2880MangleContext *clang::createItaniumMangleContext(ASTContext &Context,
2881                                                 Diagnostic &Diags) {
2882  return new ItaniumMangleContext(Context, Diags);
2883}
2884