gcc/cp/mangle.c

   1 /* Name mangling for the 3.0 C++ ABI.
   2    Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2007, 2008, 2009
   3    Free Software Foundation, Inc.
   4    Written by Alex Samuel <samuel@codesourcery.com>
   5
   6    This file is part of GCC.
   7
   8    GCC is free software; you can redistribute it and/or modify it
   9    under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3, or (at your option)
  11    any later version.
  12
  13    GCC is distributed in the hope that it will be useful, but
  14    WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16    General Public License for more details.
  17
  18 You should have received a copy of the GNU General Public License
  19 along with GCC; see the file COPYING3.  If not see
  20 <http://www.gnu.org/licenses/>.  */
  21
  22 /* This file implements mangling of C++ names according to the IA64
  23    C++ ABI specification.  A mangled name encodes a function or
  24    variable's name, scope, type, and/or template arguments into a text
  25    identifier.  This identifier is used as the function's or
  26    variable's linkage name, to preserve compatibility between C++'s
  27    language features (templates, scoping, and overloading) and C
  28    linkers.
  29
  30    Additionally, g++ uses mangled names internally.  To support this,
  31    mangling of types is allowed, even though the mangled name of a
  32    type should not appear by itself as an exported name.  Ditto for
  33    uninstantiated templates.
  34
  35    The primary entry point for this module is mangle_decl, which
  36    returns an identifier containing the mangled name for a decl.
  37    Additional entry points are provided to build mangled names of
  38    particular constructs when the appropriate decl for that construct
  39    is not available.  These are:
  40
  41      mangle_typeinfo_for_type:          typeinfo data
  42      mangle_typeinfo_string_for_type:   typeinfo type name
  43      mangle_vtbl_for_type:              virtual table data
  44      mangle_vtt_for_type:               VTT data
  45      mangle_ctor_vtbl_for_type:         `C-in-B' constructor virtual table data
  46      mangle_thunk:                      thunk function or entry  */
  47
  48 #include "config.h"
  49 #include "system.h"
  50 #include "coretypes.h"
  51 #include "tm.h"
  52 #include "tree.h"
  53 #include "tm_p.h"
  54 #include "cp-tree.h"
  55 #include "real.h"
  56 #include "obstack.h"
  57 #include "toplev.h"
  58 #include "varray.h"
  59 #include "flags.h"
  60 #include "target.h"
  61
  62 /* Debugging support.  */
  63
  64 /* Define DEBUG_MANGLE to enable very verbose trace messages.  */
  65 #ifndef DEBUG_MANGLE
  66 #define DEBUG_MANGLE 0
  67 #endif
  68
  69 /* Macros for tracing the write_* functions.  */
  70 #if DEBUG_MANGLE
  71 # define MANGLE_TRACE(FN, INPUT) \
  72   fprintf (stderr, "  %-24s: %-24s\n", (FN), (INPUT))
  73 # define MANGLE_TRACE_TREE(FN, NODE) \
  74   fprintf (stderr, "  %-24s: %-24s (%p)\n", \
  75            (FN), tree_code_name[TREE_CODE (NODE)], (void *) (NODE))
  76 #else
  77 # define MANGLE_TRACE(FN, INPUT)
  78 # define MANGLE_TRACE_TREE(FN, NODE)
  79 #endif
  80
  81 /* Nonzero if NODE is a class template-id.  We can't rely on
  82    CLASSTYPE_USE_TEMPLATE here because of tricky bugs in the parser
  83    that hard to distinguish A<T> from A, where A<T> is the type as
  84    instantiated outside of the template, and A is the type used
  85    without parameters inside the template.  */
  86 #define CLASSTYPE_TEMPLATE_ID_P(NODE)                                   \
  87   (TYPE_LANG_SPECIFIC (NODE) != NULL                                    \
  88    && (TREE_CODE (NODE) == BOUND_TEMPLATE_TEMPLATE_PARM                 \
  89        || (CLASSTYPE_TEMPLATE_INFO (NODE) != NULL                       \
  90            && (PRIMARY_TEMPLATE_P (CLASSTYPE_TI_TEMPLATE (NODE))))))
  91
  92 /* Things we only need one of.  This module is not reentrant.  */
  93 typedef struct GTY(()) globals {
  94   /* An array of the current substitution candidates, in the order
  95      we've seen them.  */
  96   VEC(tree,gc) *substitutions;
  97
  98   /* The entity that is being mangled.  */
  99   tree GTY ((skip)) entity;
 100
 101   /* True if the mangling will be different in a future version of the
 102      ABI.  */
 103   bool need_abi_warning;
 104 } globals;
 105
 106 static GTY (()) globals G;
 107
 108 /* The obstack on which we build mangled names.  */
 109 static struct obstack *mangle_obstack;
 110
 111 /* The obstack on which we build mangled names that are not going to
 112    be IDENTIFIER_NODEs.  */
 113 static struct obstack name_obstack;
 114
 115 /* The first object on the name_obstack; we use this to free memory
 116    allocated on the name_obstack.  */
 117 static void *name_base;
 118
 119 /* Indices into subst_identifiers.  These are identifiers used in
 120    special substitution rules.  */
 121 typedef enum
 122 {
 123   SUBID_ALLOCATOR,
 124   SUBID_BASIC_STRING,
 125   SUBID_CHAR_TRAITS,
 126   SUBID_BASIC_ISTREAM,
 127   SUBID_BASIC_OSTREAM,
 128   SUBID_BASIC_IOSTREAM,
 129   SUBID_MAX
 130 }
 131 substitution_identifier_index_t;
 132
 133 /* For quick substitution checks, look up these common identifiers
 134    once only.  */
 135 static GTY(()) tree subst_identifiers[SUBID_MAX];
 136
 137 /* Single-letter codes for builtin integer types, defined in
 138    <builtin-type>.  These are indexed by integer_type_kind values.  */
 139 static const char
 140 integer_type_codes[itk_none] =
 141 {
 142   'c',  /* itk_char */
 143   'a',  /* itk_signed_char */
 144   'h',  /* itk_unsigned_char */
 145   's',  /* itk_short */
 146   't',  /* itk_unsigned_short */
 147   'i',  /* itk_int */
 148   'j',  /* itk_unsigned_int */
 149   'l',  /* itk_long */
 150   'm',  /* itk_unsigned_long */
 151   'x',  /* itk_long_long */
 152   'y'   /* itk_unsigned_long_long */
 153 };
 154
 155 static int decl_is_template_id (const tree, tree* const);
 156
 157 /* Functions for handling substitutions.  */
 158
 159 static inline tree canonicalize_for_substitution (tree);
 160 static void add_substitution (tree);
 161 static inline int is_std_substitution (const tree,
 162                                        const substitution_identifier_index_t);
 163 static inline int is_std_substitution_char (const tree,
 164                                             const substitution_identifier_index_t);
 165 static int find_substitution (tree);
 166 static void mangle_call_offset (const tree, const tree);
 167
 168 /* Functions for emitting mangled representations of things.  */
 169
 170 static void write_mangled_name (const tree, bool);
 171 static void write_encoding (const tree);
 172 static void write_name (tree, const int);
 173 static void write_unscoped_name (const tree);
 174 static void write_unscoped_template_name (const tree);
 175 static void write_nested_name (const tree);
 176 static void write_prefix (const tree);
 177 static void write_template_prefix (const tree);
 178 static void write_unqualified_name (const tree);
 179 static void write_conversion_operator_name (const tree);
 180 static void write_source_name (tree);
 181 static void write_unnamed_type_name (const tree);
 182 static void write_closure_type_name (const tree);
 183 static int hwint_to_ascii (unsigned HOST_WIDE_INT, const unsigned int, char *,
 184                            const unsigned int);
 185 static void write_number (unsigned HOST_WIDE_INT, const int,
 186                           const unsigned int);
 187 static void write_compact_number (int num);
 188 static void write_integer_cst (const tree);
 189 static void write_real_cst (const tree);
 190 static void write_identifier (const char *);
 191 static void write_special_name_constructor (const tree);
 192 static void write_special_name_destructor (const tree);
 193 static void write_type (tree);
 194 static int write_CV_qualifiers_for_type (const tree);
 195 static void write_builtin_type (tree);
 196 static void write_function_type (const tree);
 197 static void write_bare_function_type (const tree, const int, const tree);
 198 static void write_method_parms (tree, const int, const tree);
 199 static void write_class_enum_type (const tree);
 200 static void write_template_args (tree);
 201 static void write_expression (tree);
 202 static void write_template_arg_literal (const tree);
 203 static void write_template_arg (tree);
 204 static void write_template_template_arg (const tree);
 205 static void write_array_type (const tree);
 206 static void write_pointer_to_member_type (const tree);
 207 static void write_template_param (const tree);
 208 static void write_template_template_param (const tree);
 209 static void write_substitution (const int);
 210 static int discriminator_for_local_entity (tree);
 211 static int discriminator_for_string_literal (tree, tree);
 212 static void write_discriminator (const int);
 213 static void write_local_name (tree, const tree, const tree);
 214 static void dump_substitution_candidates (void);
 215 static tree mangle_decl_string (const tree);
 216 static int local_class_index (tree);
 217
 218 /* Control functions.  */
 219
 220 static inline void start_mangling (const tree);
 221 static inline const char *finish_mangling (const bool);
 222 static tree mangle_special_for_type (const tree, const char *);
 223
 224 /* Foreign language functions.  */
 225
 226 static void write_java_integer_type_codes (const tree);
 227
 228 /* Append a single character to the end of the mangled
 229    representation.  */
 230 #define write_char(CHAR)                                                \
 231   obstack_1grow (mangle_obstack, (CHAR))
 232
 233 /* Append a sized buffer to the end of the mangled representation.  */
 234 #define write_chars(CHAR, LEN)                                          \
 235   obstack_grow (mangle_obstack, (CHAR), (LEN))
 236
 237 /* Append a NUL-terminated string to the end of the mangled
 238    representation.  */
 239 #define write_string(STRING)                                            \
 240   obstack_grow (mangle_obstack, (STRING), strlen (STRING))
 241
 242 /* Nonzero if NODE1 and NODE2 are both TREE_LIST nodes and have the
 243    same purpose (context, which may be a type) and value (template
 244    decl).  See write_template_prefix for more information on what this
 245    is used for.  */
 246 #define NESTED_TEMPLATE_MATCH(NODE1, NODE2)                             \
 247   (TREE_CODE (NODE1) == TREE_LIST                                       \
 248    && TREE_CODE (NODE2) == TREE_LIST                                    \
 249    && ((TYPE_P (TREE_PURPOSE (NODE1))                                   \
 250         && same_type_p (TREE_PURPOSE (NODE1), TREE_PURPOSE (NODE2)))    \
 251        || TREE_PURPOSE (NODE1) == TREE_PURPOSE (NODE2))                 \
 252    && TREE_VALUE (NODE1) == TREE_VALUE (NODE2))
 253
 254 /* Write out an unsigned quantity in base 10.  */
 255 #define write_unsigned_number(NUMBER)                                   \
 256   write_number ((NUMBER), /*unsigned_p=*/1, 10)
 257
 258 /* If DECL is a template instance, return nonzero and, if
 259    TEMPLATE_INFO is non-NULL, set *TEMPLATE_INFO to its template info.
 260    Otherwise return zero.  */
 261
 262 static int
 263 decl_is_template_id (const tree decl, tree* const template_info)
 264 {
 265   if (TREE_CODE (decl) == TYPE_DECL)
 266     {
 267       /* TYPE_DECLs are handled specially.  Look at its type to decide
 268          if this is a template instantiation.  */
 269       const tree type = TREE_TYPE (decl);
 270
 271       if (CLASS_TYPE_P (type) && CLASSTYPE_TEMPLATE_ID_P (type))
 272         {
 273           if (template_info != NULL)
 274             /* For a templated TYPE_DECL, the template info is hanging
 275                off the type.  */
 276             *template_info = TYPE_TEMPLATE_INFO (type);
 277           return 1;
 278         }
 279     }
 280   else
 281     {
 282       /* Check if this is a primary template.  */
 283       if (DECL_LANG_SPECIFIC (decl) != NULL
 284           && DECL_USE_TEMPLATE (decl)
 285           && PRIMARY_TEMPLATE_P (DECL_TI_TEMPLATE (decl))
 286           && TREE_CODE (decl) != TEMPLATE_DECL)
 287         {
 288           if (template_info != NULL)
 289             /* For most templated decls, the template info is hanging
 290                off the decl.  */
 291             *template_info = DECL_TEMPLATE_INFO (decl);
 292           return 1;
 293         }
 294     }
 295
 296   /* It's not a template id.  */
 297   return 0;
 298 }
 299
 300 /* Produce debugging output of current substitution candidates.  */
 301
 302 static void
 303 dump_substitution_candidates (void)
 304 {
 305   unsigned i;
 306   tree el;
 307
 308   fprintf (stderr, "  ++ substitutions  ");
 309   for (i = 0; VEC_iterate (tree, G.substitutions, i, el); ++i)
 310     {
 311       const char *name = "???";
 312
 313       if (i > 0)
 314         fprintf (stderr, "                    ");
 315       if (DECL_P (el))
 316         name = IDENTIFIER_POINTER (DECL_NAME (el));
 317       else if (TREE_CODE (el) == TREE_LIST)
 318         name = IDENTIFIER_POINTER (DECL_NAME (TREE_VALUE (el)));
 319       else if (TYPE_NAME (el))
 320         name = IDENTIFIER_POINTER (DECL_NAME (TYPE_NAME (el)));
 321       fprintf (stderr, " S%d_ = ", i - 1);
 322       if (TYPE_P (el) &&
 323           (CP_TYPE_RESTRICT_P (el)
 324            || CP_TYPE_VOLATILE_P (el)
 325            || CP_TYPE_CONST_P (el)))
 326         fprintf (stderr, "CV-");
 327       fprintf (stderr, "%s (%s at %p)\n",
 328                name, tree_code_name[TREE_CODE (el)], (void *) el);
 329     }
 330 }
 331
 332 /* Both decls and types can be substitution candidates, but sometimes
 333    they refer to the same thing.  For instance, a TYPE_DECL and
 334    RECORD_TYPE for the same class refer to the same thing, and should
 335    be treated accordingly in substitutions.  This function returns a
 336    canonicalized tree node representing NODE that is used when adding
 337    and substitution candidates and finding matches.  */
 338
 339 static inline tree
 340 canonicalize_for_substitution (tree node)
 341 {
 342   /* For a TYPE_DECL, use the type instead.  */
 343   if (TREE_CODE (node) == TYPE_DECL)
 344     node = TREE_TYPE (node);
 345   if (TYPE_P (node)
 346       && TYPE_CANONICAL (node) != node
 347       && TYPE_MAIN_VARIANT (node) != node)
 348       /* Here we want to strip the topmost typedef only.
 349          We need to do that so is_std_substitution can do proper
 350          name matching.  */
 351     node = cp_build_qualified_type (TYPE_MAIN_VARIANT (node),
 352                                     cp_type_quals (node));
 353   return node;
 354 }
 355
 356 /* Add NODE as a substitution candidate.  NODE must not already be on
 357    the list of candidates.  */
 358
 359 static void
 360 add_substitution (tree node)
 361 {
 362   tree c;
 363
 364   if (DEBUG_MANGLE)
 365     fprintf (stderr, "  ++ add_substitution (%s at %10p)\n",
 366              tree_code_name[TREE_CODE (node)], (void *) node);
 367
 368   /* Get the canonicalized substitution candidate for NODE.  */
 369   c = canonicalize_for_substitution (node);
 370   if (DEBUG_MANGLE && c != node)
 371     fprintf (stderr, "  ++ using candidate (%s at %10p)\n",
 372              tree_code_name[TREE_CODE (node)], (void *) node);
 373   node = c;
 374
 375 #if ENABLE_CHECKING
 376   /* Make sure NODE isn't already a candidate.  */
 377   {
 378     int i;
 379     tree candidate;
 380
 381     for (i = 0; VEC_iterate (tree, G.substitutions, i, candidate); i++)
 382       {
 383         gcc_assert (!(DECL_P (node) && node == candidate));
 384         gcc_assert (!(TYPE_P (node) && TYPE_P (candidate)
 385                       && same_type_p (node, candidate)));
 386       }
 387   }
 388 #endif /* ENABLE_CHECKING */
 389
 390   /* Put the decl onto the varray of substitution candidates.  */
 391   VEC_safe_push (tree, gc, G.substitutions, node);
 392
 393   if (DEBUG_MANGLE)
 394     dump_substitution_candidates ();
 395 }
 396
 397 /* Helper function for find_substitution.  Returns nonzero if NODE,
 398    which may be a decl or a CLASS_TYPE, is a template-id with template
 399    name of substitution_index[INDEX] in the ::std namespace.  */
 400
 401 static inline int
 402 is_std_substitution (const tree node,
 403                      const substitution_identifier_index_t index)
 404 {
 405   tree type = NULL;
 406   tree decl = NULL;
 407
 408   if (DECL_P (node))
 409     {
 410       type = TREE_TYPE (node);
 411       decl = node;
 412     }
 413   else if (CLASS_TYPE_P (node))
 414     {
 415       type = node;
 416       decl = TYPE_NAME (node);
 417     }
 418   else
 419     /* These are not the droids you're looking for.  */
 420     return 0;
 421
 422   return (DECL_NAMESPACE_STD_P (CP_DECL_CONTEXT (decl))
 423           && TYPE_LANG_SPECIFIC (type)
 424           && TYPE_TEMPLATE_INFO (type)
 425           && (DECL_NAME (TYPE_TI_TEMPLATE (type))
 426               == subst_identifiers[index]));
 427 }
 428
 429 /* Helper function for find_substitution.  Returns nonzero if NODE,
 430    which may be a decl or a CLASS_TYPE, is the template-id
 431    ::std::identifier<char>, where identifier is
 432    substitution_index[INDEX].  */
 433
 434 static inline int
 435 is_std_substitution_char (const tree node,
 436                           const substitution_identifier_index_t index)
 437 {
 438   tree args;
 439   /* Check NODE's name is ::std::identifier.  */
 440   if (!is_std_substitution (node, index))
 441     return 0;
 442   /* Figure out its template args.  */
 443   if (DECL_P (node))
 444     args = DECL_TI_ARGS (node);
 445   else if (CLASS_TYPE_P (node))
 446     args = CLASSTYPE_TI_ARGS (node);
 447   else
 448     /* Oops, not a template.  */
 449     return 0;
 450   /* NODE's template arg list should be <char>.  */
 451   return
 452     TREE_VEC_LENGTH (args) == 1
 453     && TREE_VEC_ELT (args, 0) == char_type_node;
 454 }
 455
 456 /* Check whether a substitution should be used to represent NODE in
 457    the mangling.
 458
 459    First, check standard special-case substitutions.
 460
 461      <substitution> ::= St
 462          # ::std
 463
 464                     ::= Sa
 465          # ::std::allocator
 466
 467                     ::= Sb
 468          # ::std::basic_string
 469
 470                     ::= Ss
 471          # ::std::basic_string<char,
 472                                ::std::char_traits<char>,
 473                                ::std::allocator<char> >
 474
 475                     ::= Si
 476          # ::std::basic_istream<char, ::std::char_traits<char> >
 477
 478                     ::= So
 479          # ::std::basic_ostream<char, ::std::char_traits<char> >
 480
 481                     ::= Sd
 482          # ::std::basic_iostream<char, ::std::char_traits<char> >
 483
 484    Then examine the stack of currently available substitution
 485    candidates for entities appearing earlier in the same mangling
 486
 487    If a substitution is found, write its mangled representation and
 488    return nonzero.  If none is found, just return zero.  */
 489
 490 static int
 491 find_substitution (tree node)
 492 {
 493   int i;
 494   const int size = VEC_length (tree, G.substitutions);
 495   tree decl;
 496   tree type;
 497
 498   if (DEBUG_MANGLE)
 499     fprintf (stderr, "  ++ find_substitution (%s at %p)\n",
 500              tree_code_name[TREE_CODE (node)], (void *) node);
 501
 502   /* Obtain the canonicalized substitution representation for NODE.
 503      This is what we'll compare against.  */
 504   node = canonicalize_for_substitution (node);
 505
 506   /* Check for builtin substitutions.  */
 507
 508   decl = TYPE_P (node) ? TYPE_NAME (node) : node;
 509   type = TYPE_P (node) ? node : TREE_TYPE (node);
 510
 511   /* Check for std::allocator.  */
 512   if (decl
 513       && is_std_substitution (decl, SUBID_ALLOCATOR)
 514       && !CLASSTYPE_USE_TEMPLATE (TREE_TYPE (decl)))
 515     {
 516       write_string ("Sa");
 517       return 1;
 518     }
 519
 520   /* Check for std::basic_string.  */
 521   if (decl && is_std_substitution (decl, SUBID_BASIC_STRING))
 522     {
 523       if (TYPE_P (node))
 524         {
 525           /* If this is a type (i.e. a fully-qualified template-id),
 526              check for
 527                  std::basic_string <char,
 528                                     std::char_traits<char>,
 529                                     std::allocator<char> > .  */
 530           if (cp_type_quals (type) == TYPE_UNQUALIFIED
 531               && CLASSTYPE_USE_TEMPLATE (type))
 532             {
 533               tree args = CLASSTYPE_TI_ARGS (type);
 534               if (TREE_VEC_LENGTH (args) == 3
 535                   && same_type_p (TREE_VEC_ELT (args, 0), char_type_node)
 536                   && is_std_substitution_char (TREE_VEC_ELT (args, 1),
 537                                                SUBID_CHAR_TRAITS)
 538                   && is_std_substitution_char (TREE_VEC_ELT (args, 2),
 539                                                SUBID_ALLOCATOR))
 540                 {
 541                   write_string ("Ss");
 542                   return 1;
 543                 }
 544             }
 545         }
 546       else
 547         /* Substitute for the template name only if this isn't a type.  */
 548         {
 549           write_string ("Sb");
 550           return 1;
 551         }
 552     }
 553
 554   /* Check for basic_{i,o,io}stream.  */
 555   if (TYPE_P (node)
 556       && cp_type_quals (type) == TYPE_UNQUALIFIED
 557       && CLASS_TYPE_P (type)
 558       && CLASSTYPE_USE_TEMPLATE (type)
 559       && CLASSTYPE_TEMPLATE_INFO (type) != NULL)
 560     {
 561       /* First, check for the template
 562          args <char, std::char_traits<char> > .  */
 563       tree args = CLASSTYPE_TI_ARGS (type);
 564       if (TREE_VEC_LENGTH (args) == 2
 565           && TYPE_P (TREE_VEC_ELT (args, 0))
 566           && same_type_p (TREE_VEC_ELT (args, 0), char_type_node)
 567           && is_std_substitution_char (TREE_VEC_ELT (args, 1),
 568                                        SUBID_CHAR_TRAITS))
 569         {
 570           /* Got them.  Is this basic_istream?  */
 571           if (is_std_substitution (decl, SUBID_BASIC_ISTREAM))
 572             {
 573               write_string ("Si");
 574               return 1;
 575             }
 576           /* Or basic_ostream?  */
 577           else if (is_std_substitution (decl, SUBID_BASIC_OSTREAM))
 578             {
 579               write_string ("So");
 580               return 1;
 581             }
 582           /* Or basic_iostream?  */
 583           else if (is_std_substitution (decl, SUBID_BASIC_IOSTREAM))
 584             {
 585               write_string ("Sd");
 586               return 1;
 587             }
 588         }
 589     }
 590
 591   /* Check for namespace std.  */
 592   if (decl && DECL_NAMESPACE_STD_P (decl))
 593     {
 594       write_string ("St");
 595       return 1;
 596     }
 597
 598   /* Now check the list of available substitutions for this mangling
 599      operation.  */
 600   for (i = 0; i < size; ++i)
 601     {
 602       tree candidate = VEC_index (tree, G.substitutions, i);
 603       /* NODE is a matched to a candidate if it's the same decl node or
 604          if it's the same type.  */
 605       if (decl == candidate
 606           || (TYPE_P (candidate) && type && TYPE_P (type)
 607               && same_type_p (type, candidate))
 608           || NESTED_TEMPLATE_MATCH (node, candidate))
 609         {
 610           write_substitution (i);
 611           return 1;
 612         }
 613     }
 614
 615   /* No substitution found.  */
 616   return 0;
 617 }
 618
 619
 620 /* TOP_LEVEL is true, if this is being called at outermost level of
 621   mangling. It should be false when mangling a decl appearing in an
 622   expression within some other mangling.
 623
 624   <mangled-name>      ::= _Z <encoding>  */
 625
 626 static void
 627 write_mangled_name (const tree decl, bool top_level)
 628 {
 629   MANGLE_TRACE_TREE ("mangled-name", decl);
 630
 631   if (/* The names of `extern "C"' functions are not mangled.  */
 632       DECL_EXTERN_C_FUNCTION_P (decl)
 633       /* But overloaded operator names *are* mangled.  */
 634       && !DECL_OVERLOADED_OPERATOR_P (decl))
 635     {
 636     unmangled_name:;
 637
 638       if (top_level)
 639         write_string (IDENTIFIER_POINTER (DECL_NAME (decl)));
 640       else
 641         {
 642           /* The standard notes: "The <encoding> of an extern "C"
 643              function is treated like global-scope data, i.e. as its
 644              <source-name> without a type."  We cannot write
 645              overloaded operators that way though, because it contains
 646              characters invalid in assembler.  */
 647           if (abi_version_at_least (2))
 648             write_string ("_Z");
 649           else
 650             G.need_abi_warning = true;
 651           write_source_name (DECL_NAME (decl));
 652         }
 653     }
 654   else if (TREE_CODE (decl) == VAR_DECL
 655            /* The names of non-static global variables aren't mangled.  */
 656            && DECL_EXTERNAL_LINKAGE_P (decl)
 657            && (CP_DECL_CONTEXT (decl) == global_namespace
 658                /* And neither are `extern "C"' variables.  */
 659                || DECL_EXTERN_C_P (decl)))
 660     {
 661       if (top_level || abi_version_at_least (2))
 662         goto unmangled_name;
 663       else
 664         {
 665           G.need_abi_warning = true;
 666           goto mangled_name;
 667         }
 668     }
 669   else
 670     {
 671     mangled_name:;
 672       write_string ("_Z");
 673       write_encoding (decl);
 674       if (DECL_LANG_SPECIFIC (decl)
 675           && (DECL_MAYBE_IN_CHARGE_DESTRUCTOR_P (decl)
 676               || DECL_MAYBE_IN_CHARGE_CONSTRUCTOR_P (decl)))
 677         /* We need a distinct mangled name for these entities, but
 678            we should never actually output it.  So, we append some
 679            characters the assembler won't like.  */
 680         write_string (" *INTERNAL* ");
 681     }
 682 }
 683
 684 /*   <encoding>         ::= <function name> <bare-function-type>
 685                         ::= <data name>  */
 686
 687 static void
 688 write_encoding (const tree decl)
 689 {
 690   MANGLE_TRACE_TREE ("encoding", decl);
 691
 692   if (DECL_LANG_SPECIFIC (decl) && DECL_EXTERN_C_FUNCTION_P (decl))
 693     {
 694       /* For overloaded operators write just the mangled name
 695          without arguments.  */
 696       if (DECL_OVERLOADED_OPERATOR_P (decl))
 697         write_name (decl, /*ignore_local_scope=*/0);
 698       else
 699         write_source_name (DECL_NAME (decl));
 700       return;
 701     }
 702
 703   write_name (decl, /*ignore_local_scope=*/0);
 704   if (TREE_CODE (decl) == FUNCTION_DECL)
 705     {
 706       tree fn_type;
 707       tree d;
 708
 709       if (decl_is_template_id (decl, NULL))
 710         {
 711           fn_type = get_mostly_instantiated_function_type (decl);
 712           /* FN_TYPE will not have parameter types for in-charge or
 713              VTT parameters.  Therefore, we pass NULL_TREE to
 714              write_bare_function_type -- otherwise, it will get
 715              confused about which artificial parameters to skip.  */
 716           d = NULL_TREE;
 717         }
 718       else
 719         {
 720           fn_type = TREE_TYPE (decl);
 721           d = decl;
 722         }
 723
 724       write_bare_function_type (fn_type,
 725                                 (!DECL_CONSTRUCTOR_P (decl)
 726                                  && !DECL_DESTRUCTOR_P (decl)
 727                                  && !DECL_CONV_FN_P (decl)
 728                                  && decl_is_template_id (decl, NULL)),
 729                                 d);
 730     }
 731 }
 732
 733 /* Lambdas can have a bit more context for mangling, specifically VAR_DECL
 734    or PARM_DECL context, which doesn't belong in DECL_CONTEXT.  */
 735
 736 static tree
 737 decl_mangling_context (tree decl)
 738 {
 739   if (TREE_CODE (decl) == TYPE_DECL
 740       && LAMBDA_TYPE_P (TREE_TYPE (decl)))
 741     {
 742       tree extra = LAMBDA_TYPE_EXTRA_SCOPE (TREE_TYPE (decl));
 743       if (extra)
 744         return extra;
 745     }
 746     else if (TREE_CODE (decl) == TYPE_DECL
 747              && TREE_CODE (TREE_TYPE (decl)) == TEMPLATE_TYPE_PARM)
 748      /* template type parms have no mangling context.  */
 749       return NULL_TREE;
 750   return CP_DECL_CONTEXT (decl);
 751 }
 752
 753 /* <name> ::= <unscoped-name>
 754           ::= <unscoped-template-name> <template-args>
 755           ::= <nested-name>
 756           ::= <local-name>
 757
 758    If IGNORE_LOCAL_SCOPE is nonzero, this production of <name> is
 759    called from <local-name>, which mangles the enclosing scope
 760    elsewhere and then uses this function to mangle just the part
 761    underneath the function scope.  So don't use the <local-name>
 762    production, to avoid an infinite recursion.  */
 763
 764 static void
 765 write_name (tree decl, const int ignore_local_scope)
 766 {
 767   tree context;
 768
 769   MANGLE_TRACE_TREE ("name", decl);
 770
 771   if (TREE_CODE (decl) == TYPE_DECL)
 772     {
 773       /* In case this is a typedef, fish out the corresponding
 774          TYPE_DECL for the main variant.  */
 775       decl = TYPE_NAME (TYPE_MAIN_VARIANT (TREE_TYPE (decl)));
 776     }
 777
 778   context = decl_mangling_context (decl);
 779
 780   /* A decl in :: or ::std scope is treated specially.  The former is
 781      mangled using <unscoped-name> or <unscoped-template-name>, the
 782      latter with a special substitution.  Also, a name that is
 783      directly in a local function scope is also mangled with
 784      <unscoped-name> rather than a full <nested-name>.  */
 785   if (context == NULL
 786       || context == global_namespace
 787       || DECL_NAMESPACE_STD_P (context)
 788       || (ignore_local_scope && TREE_CODE (context) == FUNCTION_DECL))
 789     {
 790       tree template_info;
 791       /* Is this a template instance?  */
 792       if (decl_is_template_id (decl, &template_info))
 793         {
 794           /* Yes: use <unscoped-template-name>.  */
 795           write_unscoped_template_name (TI_TEMPLATE (template_info));
 796           write_template_args (TI_ARGS (template_info));
 797         }
 798       else
 799         /* Everything else gets an <unqualified-name>.  */
 800         write_unscoped_name (decl);
 801     }
 802   else
 803     {
 804       /* Handle local names, unless we asked not to (that is, invoked
 805          under <local-name>, to handle only the part of the name under
 806          the local scope).  */
 807       if (!ignore_local_scope)
 808         {
 809           /* Scan up the list of scope context, looking for a
 810              function.  If we find one, this entity is in local
 811              function scope.  local_entity tracks context one scope
 812              level down, so it will contain the element that's
 813              directly in that function's scope, either decl or one of
 814              its enclosing scopes.  */
 815           tree local_entity = decl;
 816           while (context != NULL && context != global_namespace)
 817             {
 818               /* Make sure we're always dealing with decls.  */
 819               if (context != NULL && TYPE_P (context))
 820                 context = TYPE_NAME (context);
 821               /* Is this a function?  */
 822               if (TREE_CODE (context) == FUNCTION_DECL
 823                   || TREE_CODE (context) == PARM_DECL)
 824                 {
 825                   /* Yes, we have local scope.  Use the <local-name>
 826                      production for the innermost function scope.  */
 827                   write_local_name (context, local_entity, decl);
 828                   return;
 829                 }
 830               /* Up one scope level.  */
 831               local_entity = context;
 832               context = decl_mangling_context (context);
 833             }
 834
 835           /* No local scope found?  Fall through to <nested-name>.  */
 836         }
 837
 838       /* Other decls get a <nested-name> to encode their scope.  */
 839       write_nested_name (decl);
 840     }
 841 }
 842
 843 /* <unscoped-name> ::= <unqualified-name>
 844                    ::= St <unqualified-name>   # ::std::  */
 845
 846 static void
 847 write_unscoped_name (const tree decl)
 848 {
 849   tree context = CP_DECL_CONTEXT (decl);
 850
 851   MANGLE_TRACE_TREE ("unscoped-name", decl);
 852
 853   /* Is DECL in ::std?  */
 854   if (DECL_NAMESPACE_STD_P (context))
 855     {
 856       write_string ("St");
 857       write_unqualified_name (decl);
 858     }
 859   else
 860     {
 861       /* If not, it should be either in the global namespace, or directly
 862          in a local function scope.  */
 863       gcc_assert (context == global_namespace
 864                   || context != NULL
 865                   || TREE_CODE (context) == FUNCTION_DECL);
 866
 867       write_unqualified_name (decl);
 868     }
 869 }
 870
 871 /* <unscoped-template-name> ::= <unscoped-name>
 872                             ::= <substitution>  */
 873
 874 static void
 875 write_unscoped_template_name (const tree decl)
 876 {
 877   MANGLE_TRACE_TREE ("unscoped-template-name", decl);
 878
 879   if (find_substitution (decl))
 880     return;
 881   write_unscoped_name (decl);
 882   add_substitution (decl);
 883 }
 884
 885 /* Write the nested name, including CV-qualifiers, of DECL.
 886
 887    <nested-name> ::= N [<CV-qualifiers>] <prefix> <unqualified-name> E
 888                  ::= N [<CV-qualifiers>] <template-prefix> <template-args> E
 889
 890    <CV-qualifiers> ::= [r] [V] [K]  */
 891
 892 static void
 893 write_nested_name (const tree decl)
 894 {
 895   tree template_info;
 896
 897   MANGLE_TRACE_TREE ("nested-name", decl);
 898
 899   write_char ('N');
 900
 901   /* Write CV-qualifiers, if this is a member function.  */
 902   if (TREE_CODE (decl) == FUNCTION_DECL
 903       && DECL_NONSTATIC_MEMBER_FUNCTION_P (decl))
 904     {
 905       if (DECL_VOLATILE_MEMFUNC_P (decl))
 906         write_char ('V');
 907       if (DECL_CONST_MEMFUNC_P (decl))
 908         write_char ('K');
 909     }
 910
 911   /* Is this a template instance?  */
 912   if (decl_is_template_id (decl, &template_info))
 913     {
 914       /* Yes, use <template-prefix>.  */
 915       write_template_prefix (decl);
 916       write_template_args (TI_ARGS (template_info));
 917     }
 918   else if (TREE_CODE (TREE_TYPE (decl)) == TYPENAME_TYPE)
 919     {
 920       tree name = TYPENAME_TYPE_FULLNAME (TREE_TYPE (decl));
 921       if (TREE_CODE (name) == TEMPLATE_ID_EXPR)
 922         {
 923           write_template_prefix (decl);
 924           write_template_args (TREE_OPERAND (name, 1));
 925         }
 926       else
 927         {
 928           write_prefix (CP_DECL_CONTEXT (decl));
 929           write_unqualified_name (decl);
 930         }
 931     }
 932   else
 933     {
 934       /* No, just use <prefix>  */
 935       write_prefix (DECL_CONTEXT (decl));
 936       write_unqualified_name (decl);
 937     }
 938   write_char ('E');
 939 }
 940
 941 /* <prefix> ::= <prefix> <unqualified-name>
 942             ::= <template-param>
 943             ::= <template-prefix> <template-args>
 944             ::= # empty
 945             ::= <substitution>  */
 946
 947 static void
 948 write_prefix (const tree node)
 949 {
 950   tree decl;
 951   /* Non-NULL if NODE represents a template-id.  */
 952   tree template_info = NULL;
 953
 954   if (node == NULL
 955       || node == global_namespace)
 956     return;
 957
 958   MANGLE_TRACE_TREE ("prefix", node);
 959
 960   if (find_substitution (node))
 961     return;
 962
 963   if (DECL_P (node))
 964     {
 965       /* If this is a function or parm decl, that means we've hit function
 966          scope, so this prefix must be for a local name.  In this
 967          case, we're under the <local-name> production, which encodes
 968          the enclosing function scope elsewhere.  So don't continue
 969          here.  */
 970       if (TREE_CODE (node) == FUNCTION_DECL
 971           || TREE_CODE (node) == PARM_DECL)
 972         return;
 973
 974       decl = node;
 975       decl_is_template_id (decl, &template_info);
 976     }
 977   else
 978     {
 979       /* Node is a type.  */
 980       decl = TYPE_NAME (node);
 981       if (CLASSTYPE_TEMPLATE_ID_P (node))
 982         template_info = TYPE_TEMPLATE_INFO (node);
 983     }
 984
 985   /* In G++ 3.2, the name of the template parameter was used.  */
 986   if (TREE_CODE (node) == TEMPLATE_TYPE_PARM
 987       && !abi_version_at_least (2))
 988     G.need_abi_warning = true;
 989
 990   if (TREE_CODE (node) == TEMPLATE_TYPE_PARM
 991       && abi_version_at_least (2))
 992     write_template_param (node);
 993   else if (template_info != NULL)
 994     /* Templated.  */
 995     {
 996       write_template_prefix (decl);
 997       write_template_args (TI_ARGS (template_info));
 998     }
 999   else if (TREE_CODE (TREE_TYPE (decl)) == TYPENAME_TYPE)
1000     {
1001       tree name = TYPENAME_TYPE_FULLNAME (TREE_TYPE (decl));
1002       if (TREE_CODE (name) == TEMPLATE_ID_EXPR)
1003         {
1004           write_template_prefix (decl);
1005           write_template_args (TREE_OPERAND (name, 1));
1006         }
1007       else
1008         {
1009           write_prefix (CP_DECL_CONTEXT (decl));
1010           write_unqualified_name (decl);
1011         }
1012     }
1013   else
1014     /* Not templated.  */
1015     {
1016       write_prefix (decl_mangling_context (decl));
1017       write_unqualified_name (decl);
1018       if (TREE_CODE (decl) == VAR_DECL
1019           || TREE_CODE (decl) == FIELD_DECL)
1020         {
1021           /* <data-member-prefix> := <member source-name> M */
1022           write_char ('M');
1023           return;
1024         }
1025     }
1026
1027   add_substitution (node);
1028 }
1029
1030 /* <template-prefix> ::= <prefix> <template component>
1031                      ::= <template-param>
1032                      ::= <substitution>  */
1033
1034 static void
1035 write_template_prefix (const tree node)
1036 {
1037   tree decl = DECL_P (node) ? node : TYPE_NAME (node);
1038   tree type = DECL_P (node) ? TREE_TYPE (node) : node;
1039   tree context = CP_DECL_CONTEXT (decl);
1040   tree template_info;
1041   tree templ;
1042   tree substitution;
1043
1044   MANGLE_TRACE_TREE ("template-prefix", node);
1045
1046   /* Find the template decl.  */
1047   if (decl_is_template_id (decl, &template_info))
1048     templ = TI_TEMPLATE (template_info);
1049   else if (TREE_CODE (type) == TYPENAME_TYPE)
1050     /* For a typename type, all we have is the name.  */
1051     templ = DECL_NAME (decl);
1052   else
1053     {
1054       gcc_assert (CLASSTYPE_TEMPLATE_ID_P (type));
1055
1056       templ = TYPE_TI_TEMPLATE (type);
1057     }
1058
1059   /* For a member template, though, the template name for the
1060      innermost name must have all the outer template levels
1061      instantiated.  For instance, consider
1062
1063        template<typename T> struct Outer {
1064          template<typename U> struct Inner {};
1065        };
1066
1067      The template name for `Inner' in `Outer<int>::Inner<float>' is
1068      `Outer<int>::Inner<U>'.  In g++, we don't instantiate the template
1069      levels separately, so there's no TEMPLATE_DECL available for this
1070      (there's only `Outer<T>::Inner<U>').
1071
1072      In order to get the substitutions right, we create a special
1073      TREE_LIST to represent the substitution candidate for a nested
1074      template.  The TREE_PURPOSE is the template's context, fully
1075      instantiated, and the TREE_VALUE is the TEMPLATE_DECL for the inner
1076      template.
1077
1078      So, for the example above, `Outer<int>::Inner' is represented as a
1079      substitution candidate by a TREE_LIST whose purpose is `Outer<int>'
1080      and whose value is `Outer<T>::Inner<U>'.  */
1081   if (TYPE_P (context))
1082     substitution = build_tree_list (context, templ);
1083   else
1084     substitution = templ;
1085
1086   if (find_substitution (substitution))
1087     return;
1088
1089   /* In G++ 3.2, the name of the template template parameter was used.  */
1090   if (TREE_TYPE (templ)
1091       && TREE_CODE (TREE_TYPE (templ)) == TEMPLATE_TEMPLATE_PARM
1092       && !abi_version_at_least (2))
1093     G.need_abi_warning = true;
1094
1095   if (TREE_TYPE (templ)
1096       && TREE_CODE (TREE_TYPE (templ)) == TEMPLATE_TEMPLATE_PARM
1097       && abi_version_at_least (2))
1098     write_template_param (TREE_TYPE (templ));
1099   else
1100     {
1101       write_prefix (context);
1102       write_unqualified_name (decl);
1103     }
1104
1105   add_substitution (substitution);
1106 }
1107
1108 /* We don't need to handle thunks, vtables, or VTTs here.  Those are
1109    mangled through special entry points.
1110
1111     <unqualified-name>  ::= <operator-name>
1112                         ::= <special-name>
1113                         ::= <source-name>
1114                         ::= <unnamed-type-name>
1115                         ::= <local-source-name>
1116
1117     <local-source-name> ::= L <source-name> <discriminator> */
1118
1119 static void
1120 write_unqualified_id (tree identifier)
1121 {
1122   if (IDENTIFIER_TYPENAME_P (identifier))
1123     write_conversion_operator_name (TREE_TYPE (identifier));
1124   else if (IDENTIFIER_OPNAME_P (identifier))
1125     {
1126       int i;
1127       const char *mangled_name = NULL;
1128
1129       /* Unfortunately, there is no easy way to go from the
1130          name of the operator back to the corresponding tree
1131          code.  */
1132       for (i = 0; i < MAX_TREE_CODES; ++i)
1133         if (operator_name_info[i].identifier == identifier)
1134           {
1135             /* The ABI says that we prefer binary operator
1136                names to unary operator names.  */
1137             if (operator_name_info[i].arity == 2)
1138               {
1139                 mangled_name = operator_name_info[i].mangled_name;
1140                 break;
1141               }
1142             else if (!mangled_name)
1143               mangled_name = operator_name_info[i].mangled_name;
1144           }
1145         else if (assignment_operator_name_info[i].identifier
1146                  == identifier)
1147           {
1148             mangled_name
1149               = assignment_operator_name_info[i].mangled_name;
1150             break;
1151           }
1152       write_string (mangled_name);
1153     }
1154   else
1155     write_source_name (identifier);
1156 }
1157
1158 static void
1159 write_unqualified_name (const tree decl)
1160 {
1161   MANGLE_TRACE_TREE ("unqualified-name", decl);
1162
1163   if (TREE_CODE (decl) == IDENTIFIER_NODE)
1164     {
1165       write_unqualified_id (decl);
1166       return;
1167     }
1168
1169   if (DECL_NAME (decl) == NULL_TREE)
1170     {
1171       gcc_assert (DECL_ASSEMBLER_NAME_SET_P (decl));
1172       write_source_name (DECL_ASSEMBLER_NAME (decl));
1173       return;
1174     }
1175   else if (DECL_DECLARES_FUNCTION_P (decl))
1176     {
1177       bool found = true;
1178       if (DECL_CONSTRUCTOR_P (decl))
1179         write_special_name_constructor (decl);
1180       else if (DECL_DESTRUCTOR_P (decl))
1181         write_special_name_destructor (decl);
1182       else if (DECL_CONV_FN_P (decl))
1183         {
1184           /* Conversion operator. Handle it right here.
1185              <operator> ::= cv <type>  */
1186           tree type;
1187           if (decl_is_template_id (decl, NULL))
1188             {
1189               tree fn_type;
1190               fn_type = get_mostly_instantiated_function_type (decl);
1191               type = TREE_TYPE (fn_type);
1192             }
1193           else
1194             type = DECL_CONV_FN_TYPE (decl);
1195           write_conversion_operator_name (type);
1196         }
1197       else if (DECL_OVERLOADED_OPERATOR_P (decl))
1198         {
1199           operator_name_info_t *oni;
1200           if (DECL_ASSIGNMENT_OPERATOR_P (decl))
1201             oni = assignment_operator_name_info;
1202           else
1203             oni = operator_name_info;
1204
1205           write_string (oni[DECL_OVERLOADED_OPERATOR_P (decl)].mangled_name);
1206         }
1207       else
1208         found = false;
1209
1210       if (found)
1211         return;
1212     }
1213
1214   if (VAR_OR_FUNCTION_DECL_P (decl) && ! TREE_PUBLIC (decl)
1215       && DECL_NAMESPACE_SCOPE_P (decl)
1216       && decl_linkage (decl) == lk_internal)
1217     {
1218       MANGLE_TRACE_TREE ("local-source-name", decl);
1219       write_char ('L');
1220       write_source_name (DECL_NAME (decl));
1221       /* The default discriminator is 1, and that's all we ever use,
1222          so there's no code to output one here.  */
1223     }
1224   else
1225     {
1226       tree type = TREE_TYPE (decl);
1227
1228       if (TREE_CODE (decl) == TYPE_DECL
1229           && TYPE_ANONYMOUS_P (type))
1230         write_unnamed_type_name (type);
1231       else if (TREE_CODE (decl) == TYPE_DECL
1232                && LAMBDA_TYPE_P (type))
1233         write_closure_type_name (type);
1234       else
1235         write_source_name (DECL_NAME (decl));
1236     }
1237 }
1238
1239 /* Write the unqualified-name for a conversion operator to TYPE.  */
1240
1241 static void
1242 write_conversion_operator_name (const tree type)
1243 {
1244   write_string ("cv");
1245   write_type (type);
1246 }
1247
1248 /* Non-terminal <source-name>.  IDENTIFIER is an IDENTIFIER_NODE.
1249
1250      <source-name> ::= </length/ number> <identifier>  */
1251
1252 static void
1253 write_source_name (tree identifier)
1254 {
1255   MANGLE_TRACE_TREE ("source-name", identifier);
1256
1257   /* Never write the whole template-id name including the template
1258      arguments; we only want the template name.  */
1259   if (IDENTIFIER_TEMPLATE (identifier))
1260     identifier = IDENTIFIER_TEMPLATE (identifier);
1261
1262   write_unsigned_number (IDENTIFIER_LENGTH (identifier));
1263   write_identifier (IDENTIFIER_POINTER (identifier));
1264 }
1265
1266 /* Encode 0 as _, and 1+ as n-1_.  */
1267
1268 static void
1269 write_compact_number (int num)
1270 {
1271   if (num > 0)
1272     write_unsigned_number (num - 1);
1273   write_char ('_');
1274 }
1275
1276 /* Return how many unnamed types precede TYPE in its enclosing class.  */
1277
1278 static int
1279 nested_anon_class_index (tree type)
1280 {
1281   int index = 0;
1282   tree member = TYPE_FIELDS (TYPE_CONTEXT (type));
1283   for (; member; member = TREE_CHAIN (member))
1284     if (DECL_IMPLICIT_TYPEDEF_P (member))
1285       {
1286         tree memtype = TREE_TYPE (member);
1287         if (memtype == type)
1288           return index;
1289         else if (TYPE_ANONYMOUS_P (memtype))
1290           ++index;
1291       }
1292
1293   gcc_unreachable ();
1294 }
1295
1296 /* <unnamed-type-name> ::= Ut [ <nonnegative number> ] _ */
1297
1298 static void
1299 write_unnamed_type_name (const tree type __attribute__ ((__unused__)))
1300 {
1301   int discriminator;
1302   MANGLE_TRACE_TREE ("unnamed-type-name", type);
1303
1304   if (TYPE_FUNCTION_SCOPE_P (type))
1305     discriminator = local_class_index (type);
1306   else if (TYPE_CLASS_SCOPE_P (type))
1307     discriminator = nested_anon_class_index (type);
1308   else
1309     {
1310       gcc_assert (no_linkage_check (type, /*relaxed_p=*/true));
1311       /* Just use the old mangling at namespace scope.  */
1312       write_source_name (TYPE_IDENTIFIER (type));
1313       return;
1314     }
1315
1316   write_string ("Ut");
1317   write_compact_number (discriminator);
1318 }
1319
1320 /* <closure-type-name> ::= Ul <lambda-sig> E [ <nonnegative number> ] _
1321    <lambda-sig> ::= <parameter type>+  # Parameter types or "v" if the lambda has no parameters */
1322
1323 static void
1324 write_closure_type_name (const tree type)
1325 {
1326   tree fn = lambda_function (type);
1327   tree lambda = CLASSTYPE_LAMBDA_EXPR (type);
1328   tree parms = TYPE_ARG_TYPES (TREE_TYPE (fn));
1329
1330   MANGLE_TRACE_TREE ("closure-type-name", type);
1331
1332   write_string ("Ul");
1333   write_method_parms (parms, DECL_NONSTATIC_MEMBER_FUNCTION_P (fn), fn);
1334   write_char ('E');
1335   write_compact_number (LAMBDA_EXPR_DISCRIMINATOR (lambda));
1336 }
1337
1338 /* Convert NUMBER to ascii using base BASE and generating at least
1339    MIN_DIGITS characters. BUFFER points to the _end_ of the buffer
1340    into which to store the characters. Returns the number of
1341    characters generated (these will be layed out in advance of where
1342    BUFFER points).  */
1343
1344 static int
1345 hwint_to_ascii (unsigned HOST_WIDE_INT number, const unsigned int base,
1346                 char *buffer, const unsigned int min_digits)
1347 {
1348   static const char base_digits[] = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ";
1349   unsigned digits = 0;
1350
1351   while (number)
1352     {
1353       unsigned HOST_WIDE_INT d = number / base;
1354
1355       *--buffer = base_digits[number - d * base];
1356       digits++;
1357       number = d;
1358     }
1359   while (digits < min_digits)
1360     {
1361       *--buffer = base_digits[0];
1362       digits++;
1363     }
1364   return digits;
1365 }
1366
1367 /* Non-terminal <number>.
1368
1369      <number> ::= [n] </decimal integer/>  */
1370
1371 static void
1372 write_number (unsigned HOST_WIDE_INT number, const int unsigned_p,
1373               const unsigned int base)
1374 {
1375   char buffer[sizeof (HOST_WIDE_INT) * 8];
1376   unsigned count = 0;
1377
1378   if (!unsigned_p && (HOST_WIDE_INT) number < 0)
1379     {
1380       write_char ('n');
1381       number = -((HOST_WIDE_INT) number);
1382     }
1383   count = hwint_to_ascii (number, base, buffer + sizeof (buffer), 1);
1384   write_chars (buffer + sizeof (buffer) - count, count);
1385 }
1386
1387 /* Write out an integral CST in decimal. Most numbers are small, and
1388    representable in a HOST_WIDE_INT. Occasionally we'll have numbers
1389    bigger than that, which we must deal with.  */
1390
1391 static inline void
1392 write_integer_cst (const tree cst)
1393 {
1394   int sign = tree_int_cst_sgn (cst);
1395
1396   if (TREE_INT_CST_HIGH (cst) + (sign < 0))
1397     {
1398       /* A bignum. We do this in chunks, each of which fits in a
1399          HOST_WIDE_INT.  */
1400       char buffer[sizeof (HOST_WIDE_INT) * 8 * 2];
1401       unsigned HOST_WIDE_INT chunk;
1402       unsigned chunk_digits;
1403       char *ptr = buffer + sizeof (buffer);
1404       unsigned count = 0;
1405       tree n, base, type;
1406       int done;
1407
1408       /* HOST_WIDE_INT must be at least 32 bits, so 10^9 is
1409          representable.  */
1410       chunk = 1000000000;
1411       chunk_digits = 9;
1412
1413       if (sizeof (HOST_WIDE_INT) >= 8)
1414         {
1415           /* It is at least 64 bits, so 10^18 is representable.  */
1416           chunk_digits = 18;
1417           chunk *= chunk;
1418         }
1419
1420       type = c_common_signed_or_unsigned_type (1, TREE_TYPE (cst));
1421       base = build_int_cstu (type, chunk);
1422       n = build_int_cst_wide (type,
1423                               TREE_INT_CST_LOW (cst), TREE_INT_CST_HIGH (cst));
1424
1425       if (sign < 0)
1426         {
1427           write_char ('n');
1428           n = fold_build1_loc (input_location, NEGATE_EXPR, type, n);
1429         }
1430       do
1431         {
1432           tree d = fold_build2_loc (input_location, FLOOR_DIV_EXPR, type, n, base);
1433           tree tmp = fold_build2_loc (input_location, MULT_EXPR, type, d, base);
1434           unsigned c;
1435
1436           done = integer_zerop (d);
1437           tmp = fold_build2_loc (input_location, MINUS_EXPR, type, n, tmp);
1438           c = hwint_to_ascii (TREE_INT_CST_LOW (tmp), 10, ptr,
1439                               done ? 1 : chunk_digits);
1440           ptr -= c;
1441           count += c;
1442           n = d;
1443         }
1444       while (!done);
1445       write_chars (ptr, count);
1446     }
1447   else
1448     {
1449       /* A small num.  */
1450       unsigned HOST_WIDE_INT low = TREE_INT_CST_LOW (cst);
1451
1452       if (sign < 0)
1453         {
1454           write_char ('n');
1455           low = -low;
1456         }
1457       write_unsigned_number (low);
1458     }
1459 }
1460
1461 /* Write out a floating-point literal.
1462
1463     "Floating-point literals are encoded using the bit pattern of the
1464     target processor's internal representation of that number, as a
1465     fixed-length lowercase hexadecimal string, high-order bytes first
1466     (even if the target processor would store low-order bytes first).
1467     The "n" prefix is not used for floating-point literals; the sign
1468     bit is encoded with the rest of the number.
1469
1470     Here are some examples, assuming the IEEE standard representation
1471     for floating point numbers.  (Spaces are for readability, not
1472     part of the encoding.)
1473
1474         1.0f                    Lf 3f80 0000 E
1475        -1.0f                    Lf bf80 0000 E
1476         1.17549435e-38f         Lf 0080 0000 E
1477         1.40129846e-45f         Lf 0000 0001 E
1478         0.0f                    Lf 0000 0000 E"
1479
1480    Caller is responsible for the Lx and the E.  */
1481 static void
1482 write_real_cst (const tree value)
1483 {
1484   if (abi_version_at_least (2))
1485     {
1486       long target_real[4];  /* largest supported float */
1487       char buffer[9];       /* eight hex digits in a 32-bit number */
1488       int i, limit, dir;
1489
1490       tree type = TREE_TYPE (value);
1491       int words = GET_MODE_BITSIZE (TYPE_MODE (type)) / 32;
1492
1493       real_to_target (target_real, &TREE_REAL_CST (value),
1494                       TYPE_MODE (type));
1495
1496       /* The value in target_real is in the target word order,
1497          so we must write it out backward if that happens to be
1498          little-endian.  write_number cannot be used, it will
1499          produce uppercase.  */
1500       if (FLOAT_WORDS_BIG_ENDIAN)
1501         i = 0, limit = words, dir = 1;
1502       else
1503         i = words - 1, limit = -1, dir = -1;
1504
1505       for (; i != limit; i += dir)
1506         {
1507           sprintf (buffer, "%08lx", (unsigned long) target_real[i]);
1508           write_chars (buffer, 8);
1509         }
1510     }
1511   else
1512     {
1513       /* In G++ 3.3 and before the REAL_VALUE_TYPE was written out
1514          literally.  Note that compatibility with 3.2 is impossible,
1515          because the old floating-point emulator used a different
1516          format for REAL_VALUE_TYPE.  */
1517       size_t i;
1518       for (i = 0; i < sizeof (TREE_REAL_CST (value)); ++i)
1519         write_number (((unsigned char *) &TREE_REAL_CST (value))[i],
1520                       /*unsigned_p*/ 1,
1521                       /*base*/ 16);
1522       G.need_abi_warning = 1;
1523     }
1524 }
1525
1526 /* Non-terminal <identifier>.
1527
1528      <identifier> ::= </unqualified source code identifier>  */
1529
1530 static void
1531 write_identifier (const char *identifier)
1532 {
1533   MANGLE_TRACE ("identifier", identifier);
1534   write_string (identifier);
1535 }
1536
1537 /* Handle constructor productions of non-terminal <special-name>.
1538    CTOR is a constructor FUNCTION_DECL.
1539
1540      <special-name> ::= C1   # complete object constructor
1541                     ::= C2   # base object constructor
1542                     ::= C3   # complete object allocating constructor
1543
1544    Currently, allocating constructors are never used.
1545
1546    We also need to provide mangled names for the maybe-in-charge
1547    constructor, so we treat it here too.  mangle_decl_string will
1548    append *INTERNAL* to that, to make sure we never emit it.  */
1549
1550 static void
1551 write_special_name_constructor (const tree ctor)
1552 {
1553   if (DECL_BASE_CONSTRUCTOR_P (ctor))
1554     write_string ("C2");
1555   else
1556     {
1557       gcc_assert (DECL_COMPLETE_CONSTRUCTOR_P (ctor)
1558                   /* Even though we don't ever emit a definition of
1559                      the old-style destructor, we still have to
1560                      consider entities (like static variables) nested
1561                      inside it.  */
1562                   || DECL_MAYBE_IN_CHARGE_CONSTRUCTOR_P (ctor));
1563       write_string ("C1");
1564     }
1565 }
1566
1567 /* Handle destructor productions of non-terminal <special-name>.
1568    DTOR is a destructor FUNCTION_DECL.
1569
1570      <special-name> ::= D0 # deleting (in-charge) destructor
1571                     ::= D1 # complete object (in-charge) destructor
1572                     ::= D2 # base object (not-in-charge) destructor
1573
1574    We also need to provide mangled names for the maybe-incharge
1575    destructor, so we treat it here too.  mangle_decl_string will
1576    append *INTERNAL* to that, to make sure we never emit it.  */
1577
1578 static void
1579 write_special_name_destructor (const tree dtor)
1580 {
1581   if (DECL_DELETING_DESTRUCTOR_P (dtor))
1582     write_string ("D0");
1583   else if (DECL_BASE_DESTRUCTOR_P (dtor))
1584     write_string ("D2");
1585   else
1586     {
1587       gcc_assert (DECL_COMPLETE_DESTRUCTOR_P (dtor)
1588                   /* Even though we don't ever emit a definition of
1589                      the old-style destructor, we still have to
1590                      consider entities (like static variables) nested
1591                      inside it.  */
1592                   || DECL_MAYBE_IN_CHARGE_DESTRUCTOR_P (dtor));
1593       write_string ("D1");
1594     }
1595 }
1596
1597 /* Scan the vector of local classes and return how many others with the
1598    same name (or same no name) and context precede ENTITY.  */
1599
1600 static int
1601 local_class_index (tree entity)
1602 {
1603   int ix, discriminator = 0;
1604   tree name = (TYPE_ANONYMOUS_P (entity) ? NULL_TREE
1605                : TYPE_IDENTIFIER (entity));
1606   tree ctx = TYPE_CONTEXT (entity);
1607   for (ix = 0; ; ix++)
1608     {
1609       tree type = VEC_index (tree, local_classes, ix);
1610       if (type == entity)
1611         return discriminator;
1612       if (TYPE_CONTEXT (type) == ctx
1613           && (name ? TYPE_IDENTIFIER (type) == name
1614               : TYPE_ANONYMOUS_P (type)))
1615         ++discriminator;
1616     }
1617   gcc_unreachable ();
1618 }
1619
1620 /* Return the discriminator for ENTITY appearing inside
1621    FUNCTION.  The discriminator is the lexical ordinal of VAR among
1622    entities with the same name in the same FUNCTION.  */
1623
1624 static int
1625 discriminator_for_local_entity (tree entity)
1626 {
1627   if (DECL_DISCRIMINATOR_P (entity))
1628     {
1629       if (DECL_DISCRIMINATOR_SET_P (entity))
1630         return DECL_DISCRIMINATOR (entity);
1631       else
1632         /* The first entity with a particular name doesn't get
1633            DECL_DISCRIMINATOR set up.  */
1634         return 0;
1635     }
1636   else if (TREE_CODE (entity) == TYPE_DECL)
1637     {
1638       /* Scan the list of local classes.  */
1639       entity = TREE_TYPE (entity);
1640
1641       /* Lambdas and unnamed types have their own discriminators.  */
1642       if (LAMBDA_TYPE_P (entity) || TYPE_ANONYMOUS_P (entity))
1643         return 0;
1644
1645       return local_class_index (entity);
1646     }
1647   else
1648     gcc_unreachable ();
1649 }
1650
1651 /* Return the discriminator for STRING, a string literal used inside
1652    FUNCTION.  The discriminator is the lexical ordinal of STRING among
1653    string literals used in FUNCTION.  */
1654
1655 static int
1656 discriminator_for_string_literal (tree function ATTRIBUTE_UNUSED,
1657                                   tree string ATTRIBUTE_UNUSED)
1658 {
1659   /* For now, we don't discriminate amongst string literals.  */
1660   return 0;
1661 }
1662
1663 /*   <discriminator> := _ <number>
1664
1665    The discriminator is used only for the second and later occurrences
1666    of the same name within a single function. In this case <number> is
1667    n - 2, if this is the nth occurrence, in lexical order.  */
1668
1669 static void
1670 write_discriminator (const int discriminator)
1671 {
1672   /* If discriminator is zero, don't write anything.  Otherwise...  */
1673   if (discriminator > 0)
1674     {
1675       write_char ('_');
1676       write_unsigned_number (discriminator - 1);
1677     }
1678 }
1679
1680 /* Mangle the name of a function-scope entity.  FUNCTION is the
1681    FUNCTION_DECL for the enclosing function, or a PARM_DECL for lambdas in
1682    default argument scope.  ENTITY is the decl for the entity itself.
1683    LOCAL_ENTITY is the entity that's directly scoped in FUNCTION_DECL,
1684    either ENTITY itself or an enclosing scope of ENTITY.
1685
1686      <local-name> := Z <function encoding> E <entity name> [<discriminator>]
1687                   := Z <function encoding> E s [<discriminator>]
1688                   := Z <function encoding> Ed [ <parameter number> ] _ <entity name> */
1689
1690 static void
1691 write_local_name (tree function, const tree local_entity,
1692                   const tree entity)
1693 {
1694   tree parm = NULL_TREE;
1695
1696   MANGLE_TRACE_TREE ("local-name", entity);
1697
1698   if (TREE_CODE (function) == PARM_DECL)
1699     {
1700       parm = function;
1701       function = DECL_CONTEXT (parm);
1702     }
1703
1704   write_char ('Z');
1705   write_encoding (function);
1706   write_char ('E');
1707
1708   /* For this purpose, parameters are numbered from right-to-left.  */
1709   if (parm)
1710     {
1711       tree t;
1712       int i = 0;
1713       for (t = DECL_ARGUMENTS (function); t; t = TREE_CHAIN (t))
1714         {
1715           if (t == parm)
1716             i = 1;
1717           else if (i)
1718             ++i;
1719         }
1720       write_char ('d');
1721       write_compact_number (i - 1);
1722     }
1723
1724   if (TREE_CODE (entity) == STRING_CST)
1725     {
1726       write_char ('s');
1727       write_discriminator (discriminator_for_string_literal (function,
1728                                                              entity));
1729     }
1730   else
1731     {
1732       /* Now the <entity name>.  Let write_name know its being called
1733          from <local-name>, so it doesn't try to process the enclosing
1734          function scope again.  */
1735       write_name (entity, /*ignore_local_scope=*/1);
1736       write_discriminator (discriminator_for_local_entity (local_entity));
1737     }
1738 }
1739
1740 /* Non-terminals <type> and <CV-qualifier>.
1741
1742      <type> ::= <builtin-type>
1743             ::= <function-type>
1744             ::= <class-enum-type>
1745             ::= <array-type>
1746             ::= <pointer-to-member-type>
1747             ::= <template-param>
1748             ::= <substitution>
1749             ::= <CV-qualifier>
1750             ::= P <type>    # pointer-to
1751             ::= R <type>    # reference-to
1752             ::= C <type>    # complex pair (C 2000)
1753             ::= G <type>    # imaginary (C 2000)     [not supported]
1754             ::= U <source-name> <type>   # vendor extended type qualifier
1755
1756    C++0x extensions
1757
1758      <type> ::= RR <type>   # rvalue reference-to
1759      <type> ::= Dt <expression> # decltype of an id-expression or
1760                                 # class member access
1761      <type> ::= DT <expression> # decltype of an expression
1762
1763    TYPE is a type node.  */
1764
1765 static void
1766 write_type (tree type)
1767 {
1768   /* This gets set to nonzero if TYPE turns out to be a (possibly
1769      CV-qualified) builtin type.  */
1770   int is_builtin_type = 0;
1771
1772   MANGLE_TRACE_TREE ("type", type);
1773
1774   if (type == error_mark_node)
1775     return;
1776
1777   if (find_substitution (type))
1778     return;
1779
1780   /* According to the C++ ABI, some library classes are passed the
1781      same as the scalar type of their single member and use the same
1782      mangling.  */
1783   if (TREE_CODE (type) == RECORD_TYPE && TYPE_TRANSPARENT_AGGR (type))
1784     type = TREE_TYPE (first_field (type));
1785
1786   if (write_CV_qualifiers_for_type (type) > 0)
1787     /* If TYPE was CV-qualified, we just wrote the qualifiers; now
1788        mangle the unqualified type.  The recursive call is needed here
1789        since both the qualified and unqualified types are substitution
1790        candidates.  */
1791     write_type (TYPE_MAIN_VARIANT (type));
1792   else if (TREE_CODE (type) == ARRAY_TYPE)
1793     /* It is important not to use the TYPE_MAIN_VARIANT of TYPE here
1794        so that the cv-qualification of the element type is available
1795        in write_array_type.  */
1796     write_array_type (type);
1797   else
1798     {
1799       tree type_orig = type;
1800
1801       /* See through any typedefs.  */
1802       type = TYPE_MAIN_VARIANT (type);
1803
1804       if (TYPE_PTRMEM_P (type))
1805         write_pointer_to_member_type (type);
1806       else
1807         {
1808           /* Handle any target-specific fundamental types.  */
1809           const char *target_mangling
1810             = targetm.mangle_type (type_orig);
1811
1812           if (target_mangling)
1813             {
1814               write_string (target_mangling);
1815               /* Add substitutions for types other than fundamental
1816                  types.  */
1817               if (TREE_CODE (type) != VOID_TYPE
1818                   && TREE_CODE (type) != INTEGER_TYPE
1819                   && TREE_CODE (type) != REAL_TYPE
1820                   && TREE_CODE (type) != BOOLEAN_TYPE)
1821                 add_substitution (type);
1822               return;
1823             }
1824
1825           switch (TREE_CODE (type))
1826             {
1827             case VOID_TYPE:
1828             case BOOLEAN_TYPE:
1829             case INTEGER_TYPE:  /* Includes wchar_t.  */
1830             case REAL_TYPE:
1831             case FIXED_POINT_TYPE:
1832               {
1833                 /* If this is a typedef, TYPE may not be one of
1834                    the standard builtin type nodes, but an alias of one.  Use
1835                    TYPE_MAIN_VARIANT to get to the underlying builtin type.  */
1836                 write_builtin_type (TYPE_MAIN_VARIANT (type));
1837                 ++is_builtin_type;
1838               }
1839               break;
1840
1841             case COMPLEX_TYPE:
1842               write_char ('C');
1843               write_type (TREE_TYPE (type));
1844               break;
1845
1846             case FUNCTION_TYPE:
1847             case METHOD_TYPE:
1848               write_function_type (type);
1849               break;
1850
1851             case UNION_TYPE:
1852             case RECORD_TYPE:
1853             case ENUMERAL_TYPE:
1854               /* A pointer-to-member function is represented as a special
1855                  RECORD_TYPE, so check for this first.  */
1856               if (TYPE_PTRMEMFUNC_P (type))
1857                 write_pointer_to_member_type (type);
1858               else
1859                 write_class_enum_type (type);
1860               break;
1861
1862             case TYPENAME_TYPE:
1863             case UNBOUND_CLASS_TEMPLATE:
1864               /* We handle TYPENAME_TYPEs and UNBOUND_CLASS_TEMPLATEs like
1865                  ordinary nested names.  */
1866               write_nested_name (TYPE_STUB_DECL (type));
1867               break;
1868
1869             case POINTER_TYPE:
1870               write_char ('P');
1871               write_type (TREE_TYPE (type));
1872               break;
1873
1874             case REFERENCE_TYPE:
1875               if (TYPE_REF_IS_RVALUE (type))
1876                 write_char('O');
1877               else
1878                 write_char ('R');
1879               write_type (TREE_TYPE (type));
1880               break;
1881
1882             case TEMPLATE_TYPE_PARM:
1883             case TEMPLATE_PARM_INDEX:
1884               write_template_param (type);
1885               break;
1886
1887             case TEMPLATE_TEMPLATE_PARM:
1888               write_template_template_param (type);
1889               break;
1890
1891             case BOUND_TEMPLATE_TEMPLATE_PARM:
1892               write_template_template_param (type);
1893               write_template_args
1894                 (TI_ARGS (TEMPLATE_TEMPLATE_PARM_TEMPLATE_INFO (type)));
1895               break;
1896
1897             case VECTOR_TYPE:
1898               if (abi_version_at_least (4))
1899                 {
1900                   write_string ("Dv");
1901                   /* Non-constant vector size would be encoded with
1902                      _ expression, but we don't support that yet.  */
1903                   write_unsigned_number (TYPE_VECTOR_SUBPARTS (type));
1904                   write_char ('_');
1905                 }
1906               else
1907                 write_string ("U8__vector");
1908               write_type (TREE_TYPE (type));
1909               break;
1910
1911             case TYPE_PACK_EXPANSION:
1912               write_string ("Dp");
1913               write_type (PACK_EXPANSION_PATTERN (type));
1914               break;
1915
1916             case DECLTYPE_TYPE:
1917               /* These shouldn't make it into mangling.  */
1918               gcc_assert (!DECLTYPE_FOR_LAMBDA_CAPTURE (type)
1919                           && !DECLTYPE_FOR_LAMBDA_RETURN (type));
1920
1921               write_char ('D');
1922               if (DECLTYPE_TYPE_ID_EXPR_OR_MEMBER_ACCESS_P (type))
1923                 write_char ('t');
1924               else
1925                 write_char ('T');
1926               ++cp_unevaluated_operand;
1927               write_expression (DECLTYPE_TYPE_EXPR (type));
1928               --cp_unevaluated_operand;
1929               write_char ('E');
1930               break;
1931
1932             case TYPEOF_TYPE:
1933               sorry ("mangling typeof, use decltype instead");
1934               break;
1935
1936             default:
1937               gcc_unreachable ();
1938             }
1939         }
1940     }
1941
1942   /* Types other than builtin types are substitution candidates.  */
1943   if (!is_builtin_type)
1944     add_substitution (type);
1945 }
1946
1947 /* Non-terminal <CV-qualifiers> for type nodes.  Returns the number of
1948    CV-qualifiers written for TYPE.
1949
1950      <CV-qualifiers> ::= [r] [V] [K]  */
1951
1952 static int
1953 write_CV_qualifiers_for_type (const tree type)
1954 {
1955   int num_qualifiers = 0;
1956
1957   /* The order is specified by:
1958
1959        "In cases where multiple order-insensitive qualifiers are
1960        present, they should be ordered 'K' (closest to the base type),
1961        'V', 'r', and 'U' (farthest from the base type) ..."
1962
1963      Note that we do not use cp_type_quals below; given "const
1964      int[3]", the "const" is emitted with the "int", not with the
1965      array.  */
1966
1967   if (TYPE_QUALS (type) & TYPE_QUAL_RESTRICT)
1968     {
1969       write_char ('r');
1970       ++num_qualifiers;
1971     }
1972   if (TYPE_QUALS (type) & TYPE_QUAL_VOLATILE)
1973     {
1974       write_char ('V');
1975       ++num_qualifiers;
1976     }
1977   if (TYPE_QUALS (type) & TYPE_QUAL_CONST)
1978     {
1979       write_char ('K');
1980       ++num_qualifiers;
1981     }
1982
1983   return num_qualifiers;
1984 }
1985
1986 /* Non-terminal <builtin-type>.
1987
1988      <builtin-type> ::= v   # void
1989                     ::= b   # bool
1990                     ::= w   # wchar_t
1991                     ::= c   # char
1992                     ::= a   # signed char
1993                     ::= h   # unsigned char
1994                     ::= s   # short
1995                     ::= t   # unsigned short
1996                     ::= i   # int
1997                     ::= j   # unsigned int
1998                     ::= l   # long
1999                     ::= m   # unsigned long
2000                     ::= x   # long long, __int64
2001                     ::= y   # unsigned long long, __int64
2002                     ::= n   # __int128
2003                     ::= o   # unsigned __int128
2004                     ::= f   # float
2005                     ::= d   # double
2006                     ::= e   # long double, __float80
2007                     ::= g   # __float128          [not supported]
2008                     ::= u <source-name>  # vendor extended type */
2009
2010 static void
2011 write_builtin_type (tree type)
2012 {
2013   if (TYPE_CANONICAL (type))
2014     type = TYPE_CANONICAL (type);
2015
2016   switch (TREE_CODE (type))
2017     {
2018     case VOID_TYPE:
2019       write_char ('v');
2020       break;
2021
2022     case BOOLEAN_TYPE:
2023       write_char ('b');
2024       break;
2025
2026     case INTEGER_TYPE:
2027       /* TYPE may still be wchar_t, char16_t, or char32_t, since that
2028          isn't in integer_type_nodes.  */
2029       if (type == wchar_type_node)
2030         write_char ('w');
2031       else if (type == char16_type_node)
2032         write_string ("Ds");
2033       else if (type == char32_type_node)
2034         write_string ("Di");
2035       else if (TYPE_FOR_JAVA (type))
2036         write_java_integer_type_codes (type);
2037       else
2038         {
2039           size_t itk;
2040           /* Assume TYPE is one of the shared integer type nodes.  Find
2041              it in the array of these nodes.  */
2042         iagain:
2043           for (itk = 0; itk < itk_none; ++itk)
2044             if (type == integer_types[itk])
2045               {
2046                 /* Print the corresponding single-letter code.  */
2047                 write_char (integer_type_codes[itk]);
2048                 break;
2049               }
2050
2051           if (itk == itk_none)
2052             {
2053               tree t = c_common_type_for_mode (TYPE_MODE (type),
2054                                                TYPE_UNSIGNED (type));
2055               if (type != t)
2056                 {
2057                   type = t;
2058                   goto iagain;
2059                 }
2060
2061               if (TYPE_PRECISION (type) == 128)
2062                 write_char (TYPE_UNSIGNED (type) ? 'o' : 'n');
2063               else
2064                 {
2065                   /* Allow for cases where TYPE is not one of the shared
2066                      integer type nodes and write a "vendor extended builtin
2067                      type" with a name the form intN or uintN, respectively.
2068                      Situations like this can happen if you have an
2069                      __attribute__((__mode__(__SI__))) type and use exotic
2070                      switches like '-mint8' on AVR.  Of course, this is
2071                      undefined by the C++ ABI (and '-mint8' is not even
2072                      Standard C conforming), but when using such special
2073                      options you're pretty much in nowhere land anyway.  */
2074                   const char *prefix;
2075                   char prec[11];        /* up to ten digits for an unsigned */
2076
2077                   prefix = TYPE_UNSIGNED (type) ? "uint" : "int";
2078                   sprintf (prec, "%u", (unsigned) TYPE_PRECISION (type));
2079                   write_char ('u');     /* "vendor extended builtin type" */
2080                   write_unsigned_number (strlen (prefix) + strlen (prec));
2081                   write_string (prefix);
2082                   write_string (prec);
2083                 }
2084             }
2085         }
2086       break;
2087
2088     case REAL_TYPE:
2089       if (type == float_type_node
2090           || type == java_float_type_node)
2091         write_char ('f');
2092       else if (type == double_type_node
2093                || type == java_double_type_node)
2094         write_char ('d');
2095       else if (type == long_double_type_node)
2096         write_char ('e');
2097       else if (type == dfloat32_type_node)
2098         write_string ("Df");
2099       else if (type == dfloat64_type_node)
2100         write_string ("Dd");
2101       else if (type == dfloat128_type_node)
2102         write_string ("De");
2103       else
2104         gcc_unreachable ();
2105       break;
2106
2107     case FIXED_POINT_TYPE:
2108       write_string ("DF");
2109       if (GET_MODE_IBIT (TYPE_MODE (type)) > 0)
2110         write_unsigned_number (GET_MODE_IBIT (TYPE_MODE (type)));
2111       if (type == fract_type_node
2112           || type == sat_fract_type_node
2113           || type == accum_type_node
2114           || type == sat_accum_type_node)
2115         write_char ('i');
2116       else if (type == unsigned_fract_type_node
2117                || type == sat_unsigned_fract_type_node
2118                || type == unsigned_accum_type_node
2119                || type == sat_unsigned_accum_type_node)
2120         write_char ('j');
2121       else if (type == short_fract_type_node
2122                || type == sat_short_fract_type_node
2123                || type == short_accum_type_node
2124                || type == sat_short_accum_type_node)
2125         write_char ('s');
2126       else if (type == unsigned_short_fract_type_node
2127                || type == sat_unsigned_short_fract_type_node
2128                || type == unsigned_short_accum_type_node
2129                || type == sat_unsigned_short_accum_type_node)
2130         write_char ('t');
2131       else if (type == long_fract_type_node
2132                || type == sat_long_fract_type_node
2133                || type == long_accum_type_node
2134                || type == sat_long_accum_type_node)
2135         write_char ('l');
2136       else if (type == unsigned_long_fract_type_node
2137                || type == sat_unsigned_long_fract_type_node
2138                || type == unsigned_long_accum_type_node
2139                || type == sat_unsigned_long_accum_type_node)
2140         write_char ('m');
2141       else if (type == long_long_fract_type_node
2142                || type == sat_long_long_fract_type_node
2143                || type == long_long_accum_type_node
2144                || type == sat_long_long_accum_type_node)
2145         write_char ('x');
2146       else if (type == unsigned_long_long_fract_type_node
2147                || type == sat_unsigned_long_long_fract_type_node
2148                || type == unsigned_long_long_accum_type_node
2149                || type == sat_unsigned_long_long_accum_type_node)
2150         write_char ('y');
2151       else
2152         sorry ("mangling unknown fixed point type");
2153       write_unsigned_number (GET_MODE_FBIT (TYPE_MODE (type)));
2154       if (TYPE_SATURATING (type))
2155         write_char ('s');
2156       else
2157         write_char ('n');
2158       break;
2159
2160     default:
2161       gcc_unreachable ();
2162     }
2163 }
2164
2165 /* Non-terminal <function-type>.  NODE is a FUNCTION_TYPE or
2166    METHOD_TYPE.  The return type is mangled before the parameter
2167    types.
2168
2169      <function-type> ::= F [Y] <bare-function-type> E   */
2170
2171 static void
2172 write_function_type (const tree type)
2173 {
2174   MANGLE_TRACE_TREE ("function-type", type);
2175
2176   /* For a pointer to member function, the function type may have
2177      cv-qualifiers, indicating the quals for the artificial 'this'
2178      parameter.  */
2179   if (TREE_CODE (type) == METHOD_TYPE)
2180     {
2181       /* The first parameter must be a POINTER_TYPE pointing to the
2182          `this' parameter.  */
2183       tree this_type = TREE_TYPE (TREE_VALUE (TYPE_ARG_TYPES (type)));
2184       write_CV_qualifiers_for_type (this_type);
2185     }
2186
2187   write_char ('F');
2188   /* We don't track whether or not a type is `extern "C"'.  Note that
2189      you can have an `extern "C"' function that does not have
2190      `extern "C"' type, and vice versa:
2191
2192        extern "C" typedef void function_t();
2193        function_t f; // f has C++ linkage, but its type is
2194                      // `extern "C"'
2195
2196        typedef void function_t();
2197        extern "C" function_t f; // Vice versa.
2198
2199      See [dcl.link].  */
2200   write_bare_function_type (type, /*include_return_type_p=*/1,
2201                             /*decl=*/NULL);
2202   write_char ('E');
2203 }
2204
2205 /* Non-terminal <bare-function-type>.  TYPE is a FUNCTION_TYPE or
2206    METHOD_TYPE.  If INCLUDE_RETURN_TYPE is nonzero, the return value
2207    is mangled before the parameter types.  If non-NULL, DECL is
2208    FUNCTION_DECL for the function whose type is being emitted.
2209
2210    If DECL is a member of a Java type, then a literal 'J'
2211    is output and the return type is mangled as if INCLUDE_RETURN_TYPE
2212    were nonzero.
2213
2214      <bare-function-type> ::= [J]</signature/ type>+  */
2215
2216 static void
2217 write_bare_function_type (const tree type, const int include_return_type_p,
2218                           const tree decl)
2219 {
2220   int java_method_p;
2221
2222   MANGLE_TRACE_TREE ("bare-function-type", type);
2223
2224   /* Detect Java methods and emit special encoding.  */
2225   if (decl != NULL
2226       && DECL_FUNCTION_MEMBER_P (decl)
2227       && TYPE_FOR_JAVA (DECL_CONTEXT (decl))
2228       && !DECL_CONSTRUCTOR_P (decl)
2229       && !DECL_DESTRUCTOR_P (decl)
2230       && !DECL_CONV_FN_P (decl))
2231     {
2232       java_method_p = 1;
2233       write_char ('J');
2234     }
2235   else
2236     {
2237       java_method_p = 0;
2238     }
2239
2240   /* Mangle the return type, if requested.  */
2241   if (include_return_type_p || java_method_p)
2242     write_type (TREE_TYPE (type));
2243
2244   /* Now mangle the types of the arguments.  */
2245   write_method_parms (TYPE_ARG_TYPES (type),
2246                       TREE_CODE (type) == METHOD_TYPE,
2247                       decl);
2248 }
2249
2250 /* Write the mangled representation of a method parameter list of
2251    types given in PARM_TYPES.  If METHOD_P is nonzero, the function is
2252    considered a non-static method, and the this parameter is omitted.
2253    If non-NULL, DECL is the FUNCTION_DECL for the function whose
2254    parameters are being emitted.  */
2255
2256 static void
2257 write_method_parms (tree parm_types, const int method_p, const tree decl)
2258 {
2259   tree first_parm_type;
2260   tree parm_decl = decl ? DECL_ARGUMENTS (decl) : NULL_TREE;
2261
2262   /* Assume this parameter type list is variable-length.  If it ends
2263      with a void type, then it's not.  */
2264   int varargs_p = 1;
2265
2266   /* If this is a member function, skip the first arg, which is the
2267      this pointer.
2268        "Member functions do not encode the type of their implicit this
2269        parameter."
2270
2271      Similarly, there's no need to mangle artificial parameters, like
2272      the VTT parameters for constructors and destructors.  */
2273   if (method_p)
2274     {
2275       parm_types = TREE_CHAIN (parm_types);
2276       parm_decl = parm_decl ? TREE_CHAIN (parm_decl) : NULL_TREE;
2277
2278       while (parm_decl && DECL_ARTIFICIAL (parm_decl))
2279         {
2280           parm_types = TREE_CHAIN (parm_types);
2281           parm_decl = TREE_CHAIN (parm_decl);
2282         }
2283     }
2284
2285   for (first_parm_type = parm_types;
2286        parm_types;
2287        parm_types = TREE_CHAIN (parm_types))
2288     {
2289       tree parm = TREE_VALUE (parm_types);
2290       if (parm == void_type_node)
2291         {
2292           /* "Empty parameter lists, whether declared as () or
2293              conventionally as (void), are encoded with a void parameter
2294              (v)."  */
2295           if (parm_types == first_parm_type)
2296             write_type (parm);
2297           /* If the parm list is terminated with a void type, it's
2298              fixed-length.  */
2299           varargs_p = 0;
2300           /* A void type better be the last one.  */
2301           gcc_assert (TREE_CHAIN (parm_types) == NULL);
2302         }
2303       else
2304         write_type (parm);
2305     }
2306
2307   if (varargs_p)
2308     /* <builtin-type> ::= z  # ellipsis  */
2309     write_char ('z');
2310 }
2311
2312 /* <class-enum-type> ::= <name>  */
2313
2314 static void
2315 write_class_enum_type (const tree type)
2316 {
2317   write_name (TYPE_NAME (type), /*ignore_local_scope=*/0);
2318 }
2319
2320 /* Non-terminal <template-args>.  ARGS is a TREE_VEC of template
2321    arguments.
2322
2323      <template-args> ::= I <template-arg>* E  */
2324
2325 static void
2326 write_template_args (tree args)
2327 {
2328   int i;
2329   int length = 0;
2330
2331   MANGLE_TRACE_TREE ("template-args", args);
2332
2333   write_char ('I');
2334
2335   if (args)
2336     length = TREE_VEC_LENGTH (args);
2337
2338   if (args && TREE_CODE (TREE_VEC_ELT (args, 0)) == TREE_VEC)
2339     {
2340       /* We have nested template args.  We want the innermost template
2341          argument list.  */
2342       args = TREE_VEC_ELT (args, length - 1);
2343       length = TREE_VEC_LENGTH (args);
2344     }
2345   for (i = 0; i < length; ++i)
2346     write_template_arg (TREE_VEC_ELT (args, i));
2347
2348   write_char ('E');
2349 }
2350
2351 /* Write out the
2352    <unqualified-name>
2353    <unqualified-name> <template-args>
2354    part of SCOPE_REF or COMPONENT_REF mangling.  */
2355
2356 static void
2357 write_member_name (tree member)
2358 {
2359   if (TREE_CODE (member) == IDENTIFIER_NODE)
2360     write_unqualified_id (member);
2361   else if (DECL_P (member))
2362     write_unqualified_name (member);
2363   else if (TREE_CODE (member) == TEMPLATE_ID_EXPR)
2364     {
2365       tree name = TREE_OPERAND (member, 0);
2366       if (TREE_CODE (name) == OVERLOAD)
2367         name = OVL_FUNCTION (name);
2368       write_member_name (name);
2369       write_template_args (TREE_OPERAND (member, 1));
2370     }
2371   else
2372     write_expression (member);
2373 }
2374
2375 /* <expression> ::= <unary operator-name> <expression>
2376                 ::= <binary operator-name> <expression> <expression>
2377                 ::= <expr-primary>
2378
2379    <expr-primary> ::= <template-param>
2380                   ::= L <type> <value number> E         # literal
2381                   ::= L <mangled-name> E                # external name
2382                   ::= st <type>                         # sizeof
2383                   ::= sr <type> <unqualified-name>      # dependent name
2384                   ::= sr <type> <unqualified-name> <template-args> */
2385
2386 static void
2387 write_expression (tree expr)
2388 {
2389   enum tree_code code = TREE_CODE (expr);
2390
2391   /* Skip NOP_EXPRs.  They can occur when (say) a pointer argument
2392      is converted (via qualification conversions) to another
2393      type.  */
2394   while (TREE_CODE (expr) == NOP_EXPR
2395          || TREE_CODE (expr) == NON_LVALUE_EXPR)
2396     {
2397       expr = TREE_OPERAND (expr, 0);
2398       code = TREE_CODE (expr);
2399     }
2400
2401   if (code == BASELINK)
2402     {
2403       expr = BASELINK_FUNCTIONS (expr);
2404       code = TREE_CODE (expr);
2405     }
2406
2407   /* Handle pointers-to-members by making them look like expression
2408      nodes.  */
2409   if (code == PTRMEM_CST)
2410     {
2411       expr = build_nt (ADDR_EXPR,
2412                        build_qualified_name (/*type=*/NULL_TREE,
2413                                              PTRMEM_CST_CLASS (expr),
2414                                              PTRMEM_CST_MEMBER (expr),
2415                                              /*template_p=*/false));
2416       code = TREE_CODE (expr);
2417     }
2418
2419   /* Handle template parameters.  */
2420   if (code == TEMPLATE_TYPE_PARM
2421       || code == TEMPLATE_TEMPLATE_PARM
2422       || code == BOUND_TEMPLATE_TEMPLATE_PARM
2423       || code == TEMPLATE_PARM_INDEX)
2424     write_template_param (expr);
2425   /* Handle literals.  */
2426   else if (TREE_CODE_CLASS (code) == tcc_constant
2427            || (abi_version_at_least (2) && code == CONST_DECL))
2428     write_template_arg_literal (expr);
2429   else if (code == PARM_DECL)
2430     {
2431       /* A function parameter used in a late-specified return type.  */
2432       int index = DECL_PARM_INDEX (expr);
2433       gcc_assert (index >= 1);
2434       write_string ("fp");
2435       write_compact_number (index - 1);
2436     }
2437   else if (DECL_P (expr))
2438     {
2439       /* G++ 3.2 incorrectly mangled non-type template arguments of
2440          enumeration type using their names.  */
2441       if (code == CONST_DECL)
2442         G.need_abi_warning = 1;
2443       write_char ('L');
2444       write_mangled_name (expr, false);
2445       write_char ('E');
2446     }
2447   else if (TREE_CODE (expr) == SIZEOF_EXPR
2448            && TYPE_P (TREE_OPERAND (expr, 0)))
2449     {
2450       write_string ("st");
2451       write_type (TREE_OPERAND (expr, 0));
2452     }
2453   else if (TREE_CODE (expr) == ALIGNOF_EXPR
2454            && TYPE_P (TREE_OPERAND (expr, 0)))
2455     {
2456       write_string ("at");
2457       write_type (TREE_OPERAND (expr, 0));
2458     }
2459   else if (TREE_CODE (expr) == SCOPE_REF)
2460     {
2461       tree scope = TREE_OPERAND (expr, 0);
2462       tree member = TREE_OPERAND (expr, 1);
2463
2464       if (!abi_version_at_least (2))
2465         {
2466           write_string ("sr");
2467           write_type (scope);
2468           /* G++ 3.2 incorrectly put out both the "sr" code and
2469              the nested name of the qualified name.  */
2470           G.need_abi_warning = 1;
2471           write_encoding (member);
2472         }
2473
2474       /* If the MEMBER is a real declaration, then the qualifying
2475          scope was not dependent.  Ideally, we would not have a
2476          SCOPE_REF in those cases, but sometimes we do.  If the second
2477          argument is a DECL, then the name must not have been
2478          dependent.  */
2479       else if (DECL_P (member))
2480         write_expression (member);
2481       else
2482         {
2483           write_string ("sr");
2484           write_type (scope);
2485           write_member_name (member);
2486         }
2487     }
2488   else if (TREE_CODE (expr) == INDIRECT_REF
2489            && TREE_TYPE (TREE_OPERAND (expr, 0))
2490            && TREE_CODE (TREE_TYPE (TREE_OPERAND (expr, 0))) == REFERENCE_TYPE)
2491     {
2492       write_expression (TREE_OPERAND (expr, 0));
2493     }
2494   else if (TREE_CODE (expr) == IDENTIFIER_NODE)
2495     {
2496       /* An operator name appearing as a dependent name needs to be
2497          specially marked to disambiguate between a use of the operator
2498          name and a use of the operator in an expression.  */
2499       if (IDENTIFIER_OPNAME_P (expr))
2500         write_string ("on");
2501       write_unqualified_id (expr);
2502     }
2503   else if (TREE_CODE (expr) == TEMPLATE_ID_EXPR)
2504     {
2505       tree fn = TREE_OPERAND (expr, 0);
2506       if (is_overloaded_fn (fn))
2507         fn = DECL_NAME (get_first_fn (fn));
2508       if (IDENTIFIER_OPNAME_P (fn))
2509         write_string ("on");
2510       write_unqualified_id (fn);
2511       write_template_args (TREE_OPERAND (expr, 1));
2512     }
2513   else
2514     {
2515       int i, len;
2516       const char *name;
2517
2518       /* When we bind a variable or function to a non-type template
2519          argument with reference type, we create an ADDR_EXPR to show
2520          the fact that the entity's address has been taken.  But, we
2521          don't actually want to output a mangling code for the `&'.  */
2522       if (TREE_CODE (expr) == ADDR_EXPR
2523           && TREE_TYPE (expr)
2524           && TREE_CODE (TREE_TYPE (expr)) == REFERENCE_TYPE)
2525         {
2526           expr = TREE_OPERAND (expr, 0);
2527           if (DECL_P (expr))
2528             {
2529               write_expression (expr);
2530               return;
2531             }
2532
2533           code = TREE_CODE (expr);
2534         }
2535
2536       if (code == COMPONENT_REF)
2537         {
2538           tree ob = TREE_OPERAND (expr, 0);
2539
2540           if (TREE_CODE (ob) == ARROW_EXPR)
2541             {
2542               write_string (operator_name_info[(int)code].mangled_name);
2543               ob = TREE_OPERAND (ob, 0);
2544             }
2545           else
2546             write_string ("dt");
2547
2548           write_expression (ob);
2549           write_member_name (TREE_OPERAND (expr, 1));
2550           return;
2551         }
2552
2553       /* If it wasn't any of those, recursively expand the expression.  */
2554       name = operator_name_info[(int) code].mangled_name;
2555       if (name == NULL)
2556         {
2557           sorry ("mangling %C", code);
2558           return;
2559         }
2560       else
2561         write_string (name);
2562
2563       switch (code)
2564         {
2565         case CALL_EXPR:
2566           {
2567             tree fn = CALL_EXPR_FN (expr);
2568
2569             if (TREE_CODE (fn) == ADDR_EXPR)
2570               fn = TREE_OPERAND (fn, 0);
2571
2572             /* Mangle a dependent name as the name, not whatever happens to
2573                be the first function in the overload set.  */
2574             if ((TREE_CODE (fn) == FUNCTION_DECL
2575                  || TREE_CODE (fn) == OVERLOAD)
2576                 && type_dependent_expression_p_push (expr))
2577               fn = DECL_NAME (get_first_fn (fn));
2578
2579             write_expression (fn);
2580           }
2581
2582           for (i = 0; i < call_expr_nargs (expr); ++i)
2583             write_expression (CALL_EXPR_ARG (expr, i));
2584           write_char ('E');
2585           break;
2586
2587         case CAST_EXPR:
2588           write_type (TREE_TYPE (expr));
2589           if (list_length (TREE_OPERAND (expr, 0)) == 1)
2590             write_expression (TREE_VALUE (TREE_OPERAND (expr, 0)));
2591           else
2592             {
2593               tree args = TREE_OPERAND (expr, 0);
2594               write_char ('_');
2595               for (; args; args = TREE_CHAIN (args))
2596                 write_expression (TREE_VALUE (args));
2597               write_char ('E');
2598             }
2599           break;
2600
2601           /* FIXME these should have a distinct mangling.  */
2602         case STATIC_CAST_EXPR:
2603         case CONST_CAST_EXPR:
2604           write_type (TREE_TYPE (expr));
2605           write_expression (TREE_OPERAND (expr, 0));
2606           break;
2607
2608         case NEW_EXPR:
2609           sorry ("mangling new-expression");
2610           break;
2611
2612         default:
2613           /* In the middle-end, some expressions have more operands than
2614              they do in templates (and mangling).  */
2615           switch (code)
2616             {
2617             case PREINCREMENT_EXPR:
2618             case PREDECREMENT_EXPR:
2619             case POSTINCREMENT_EXPR:
2620             case POSTDECREMENT_EXPR:
2621               len = 1;
2622               break;
2623
2624             case ARRAY_REF:
2625               len = 2;
2626               break;
2627
2628             default:
2629               len = TREE_OPERAND_LENGTH (expr);
2630               break;
2631             }
2632
2633           for (i = 0; i < len; ++i)
2634             {
2635               tree operand = TREE_OPERAND (expr, i);
2636               /* As a GNU extension, the middle operand of a
2637                  conditional may be omitted.  Since expression
2638                  manglings are supposed to represent the input token
2639                  stream, there's no good way to mangle such an
2640                  expression without extending the C++ ABI.  */
2641               if (code == COND_EXPR && i == 1 && !operand)
2642                 {
2643                   error ("omitted middle operand to %<?:%> operand "
2644                          "cannot be mangled");
2645                   continue;
2646                 }
2647               write_expression (operand);
2648             }
2649         }
2650     }
2651 }
2652
2653 /* Literal subcase of non-terminal <template-arg>.
2654
2655      "Literal arguments, e.g. "A<42L>", are encoded with their type
2656      and value. Negative integer values are preceded with "n"; for
2657      example, "A<-42L>" becomes "1AILln42EE". The bool value false is
2658      encoded as 0, true as 1."  */
2659
2660 static void
2661 write_template_arg_literal (const tree value)
2662 {
2663   write_char ('L');
2664   write_type (TREE_TYPE (value));
2665
2666   switch (TREE_CODE (value))
2667     {
2668     case CONST_DECL:
2669       write_integer_cst (DECL_INITIAL (value));
2670       break;
2671
2672     case INTEGER_CST:
2673       gcc_assert (!same_type_p (TREE_TYPE (value), boolean_type_node)
2674                   || integer_zerop (value) || integer_onep (value));
2675       write_integer_cst (value);
2676       break;
2677
2678     case REAL_CST:
2679       write_real_cst (value);
2680       break;
2681
2682     default:
2683       gcc_unreachable ();
2684     }
2685
2686   write_char ('E');
2687 }
2688
2689 /* Non-terminal <template-arg>.
2690
2691      <template-arg> ::= <type>                          # type
2692                     ::= L <type> </value/ number> E     # literal
2693                     ::= LZ <name> E                     # external name
2694                     ::= X <expression> E                # expression  */
2695
2696 static void
2697 write_template_arg (tree node)
2698 {
2699   enum tree_code code = TREE_CODE (node);
2700
2701   MANGLE_TRACE_TREE ("template-arg", node);
2702
2703   /* A template template parameter's argument list contains TREE_LIST
2704      nodes of which the value field is the actual argument.  */
2705   if (code == TREE_LIST)
2706     {
2707       node = TREE_VALUE (node);
2708       /* If it's a decl, deal with its type instead.  */
2709       if (DECL_P (node))
2710         {
2711           node = TREE_TYPE (node);
2712           code = TREE_CODE (node);
2713         }
2714     }
2715
2716   if (TREE_CODE (node) == NOP_EXPR
2717       && TREE_CODE (TREE_TYPE (node)) == REFERENCE_TYPE)
2718     {
2719       /* Template parameters can be of reference type. To maintain
2720          internal consistency, such arguments use a conversion from
2721          address of object to reference type.  */
2722       gcc_assert (TREE_CODE (TREE_OPERAND (node, 0)) == ADDR_EXPR);
2723       if (abi_version_at_least (2))
2724         node = TREE_OPERAND (TREE_OPERAND (node, 0), 0);
2725       else
2726         G.need_abi_warning = 1;
2727     }
2728
2729   if (ARGUMENT_PACK_P (node))
2730     {
2731       /* Expand the template argument pack. */
2732       tree args = ARGUMENT_PACK_ARGS (node);
2733       int i, length = TREE_VEC_LENGTH (args);
2734       write_char ('I');
2735       for (i = 0; i < length; ++i)
2736         write_template_arg (TREE_VEC_ELT (args, i));
2737       write_char ('E');
2738     }
2739   else if (TYPE_P (node))
2740     write_type (node);
2741   else if (code == TEMPLATE_DECL)
2742     /* A template appearing as a template arg is a template template arg.  */
2743     write_template_template_arg (node);
2744   else if ((TREE_CODE_CLASS (code) == tcc_constant && code != PTRMEM_CST)
2745            || (abi_version_at_least (2) && code == CONST_DECL))
2746     write_template_arg_literal (node);
2747   else if (DECL_P (node))
2748     {
2749       /* Until ABI version 2, non-type template arguments of
2750          enumeration type were mangled using their names.  */
2751       if (code == CONST_DECL && !abi_version_at_least (2))
2752         G.need_abi_warning = 1;
2753       write_char ('L');
2754       /* Until ABI version 3, the underscore before the mangled name
2755          was incorrectly omitted.  */
2756       if (!abi_version_at_least (3))
2757         {
2758           G.need_abi_warning = 1;
2759           write_char ('Z');
2760         }
2761       else
2762         write_string ("_Z");
2763       write_encoding (node);
2764       write_char ('E');
2765     }
2766   else
2767     {
2768       /* Template arguments may be expressions.  */
2769       write_char ('X');
2770       write_expression (node);
2771       write_char ('E');
2772     }
2773 }
2774
2775 /*  <template-template-arg>
2776                         ::= <name>
2777                         ::= <substitution>  */
2778
2779 static void
2780 write_template_template_arg (const tree decl)
2781 {
2782   MANGLE_TRACE_TREE ("template-template-arg", decl);
2783
2784   if (find_substitution (decl))
2785     return;
2786   write_name (decl, /*ignore_local_scope=*/0);
2787   add_substitution (decl);
2788 }
2789
2790
2791 /* Non-terminal <array-type>.  TYPE is an ARRAY_TYPE.
2792
2793      <array-type> ::= A [</dimension/ number>] _ </element/ type>
2794                   ::= A <expression> _ </element/ type>
2795
2796      "Array types encode the dimension (number of elements) and the
2797      element type. For variable length arrays, the dimension (but not
2798      the '_' separator) is omitted."  */
2799
2800 static void
2801 write_array_type (const tree type)
2802 {
2803   write_char ('A');
2804   if (TYPE_DOMAIN (type))
2805     {
2806       tree index_type;
2807       tree max;
2808
2809       index_type = TYPE_DOMAIN (type);
2810       /* The INDEX_TYPE gives the upper and lower bounds of the
2811          array.  */
2812       max = TYPE_MAX_VALUE (index_type);
2813       if (TREE_CODE (max) == INTEGER_CST)
2814         {
2815           /* The ABI specifies that we should mangle the number of
2816              elements in the array, not the largest allowed index.  */
2817           max = size_binop (PLUS_EXPR, max, size_one_node);
2818           write_unsigned_number (tree_low_cst (max, 1));
2819         }
2820       else
2821         {
2822           max = TREE_OPERAND (max, 0);
2823           if (!abi_version_at_least (2))
2824             {
2825               /* value_dependent_expression_p presumes nothing is
2826                  dependent when PROCESSING_TEMPLATE_DECL is zero.  */
2827               ++processing_template_decl;
2828               if (!value_dependent_expression_p (max))
2829                 G.need_abi_warning = 1;
2830               --processing_template_decl;
2831             }
2832           write_expression (max);
2833         }
2834
2835     }
2836   write_char ('_');
2837   write_type (TREE_TYPE (type));
2838 }
2839
2840 /* Non-terminal <pointer-to-member-type> for pointer-to-member
2841    variables.  TYPE is a pointer-to-member POINTER_TYPE.
2842
2843      <pointer-to-member-type> ::= M </class/ type> </member/ type>  */
2844
2845 static void
2846 write_pointer_to_member_type (const tree type)
2847 {
2848   write_char ('M');
2849   write_type (TYPE_PTRMEM_CLASS_TYPE (type));
2850   write_type (TYPE_PTRMEM_POINTED_TO_TYPE (type));
2851 }
2852
2853 /* Non-terminal <template-param>.  PARM is a TEMPLATE_TYPE_PARM,
2854    TEMPLATE_TEMPLATE_PARM, BOUND_TEMPLATE_TEMPLATE_PARM or a
2855    TEMPLATE_PARM_INDEX.
2856
2857      <template-param> ::= T </parameter/ number> _  */
2858
2859 static void
2860 write_template_param (const tree parm)
2861 {
2862   int parm_index;
2863
2864   MANGLE_TRACE_TREE ("template-parm", parm);
2865
2866   switch (TREE_CODE (parm))
2867     {
2868     case TEMPLATE_TYPE_PARM:
2869     case TEMPLATE_TEMPLATE_PARM:
2870     case BOUND_TEMPLATE_TEMPLATE_PARM:
2871       parm_index = TEMPLATE_TYPE_IDX (parm);
2872       break;
2873
2874     case TEMPLATE_PARM_INDEX:
2875       parm_index = TEMPLATE_PARM_IDX (parm);
2876       break;
2877
2878     default:
2879       gcc_unreachable ();
2880     }
2881
2882   write_char ('T');
2883   /* NUMBER as it appears in the mangling is (-1)-indexed, with the
2884      earliest template param denoted by `_'.  */
2885   write_compact_number (parm_index);
2886 }
2887
2888 /*  <template-template-param>
2889                         ::= <template-param>
2890                         ::= <substitution>  */
2891
2892 static void
2893 write_template_template_param (const tree parm)
2894 {
2895   tree templ = NULL_TREE;
2896
2897   /* PARM, a TEMPLATE_TEMPLATE_PARM, is an instantiation of the
2898      template template parameter.  The substitution candidate here is
2899      only the template.  */
2900   if (TREE_CODE (parm) == BOUND_TEMPLATE_TEMPLATE_PARM)
2901     {
2902       templ
2903         = TI_TEMPLATE (TEMPLATE_TEMPLATE_PARM_TEMPLATE_INFO (parm));
2904       if (find_substitution (templ))
2905         return;
2906     }
2907
2908   /* <template-param> encodes only the template parameter position,
2909      not its template arguments, which is fine here.  */
2910   write_template_param (parm);
2911   if (templ)
2912     add_substitution (templ);
2913 }
2914
2915 /* Non-terminal <substitution>.
2916
2917       <substitution> ::= S <seq-id> _
2918                      ::= S_  */
2919
2920 static void
2921 write_substitution (const int seq_id)
2922 {
2923   MANGLE_TRACE ("substitution", "");
2924
2925   write_char ('S');
2926   if (seq_id > 0)
2927     write_number (seq_id - 1, /*unsigned=*/1, 36);
2928   write_char ('_');
2929 }
2930
2931 /* Start mangling ENTITY.  */
2932
2933 static inline void
2934 start_mangling (const tree entity)
2935 {
2936   G.entity = entity;
2937   G.need_abi_warning = false;
2938   obstack_free (&name_obstack, name_base);
2939   mangle_obstack = &name_obstack;
2940   name_base = obstack_alloc (&name_obstack, 0);
2941 }
2942
2943 /* Done with mangling. If WARN is true, and the name of G.entity will
2944    be mangled differently in a future version of the ABI, issue a
2945    warning.  */
2946
2947 static void
2948 finish_mangling_internal (const bool warn)
2949 {
2950   if (warn_abi && warn && G.need_abi_warning)
2951     warning (OPT_Wabi, "the mangled name of %qD will change in a future "
2952              "version of GCC",
2953              G.entity);
2954
2955   /* Clear all the substitutions.  */
2956   VEC_truncate (tree, G.substitutions, 0);
2957
2958   /* Null-terminate the string.  */
2959   write_char ('\0');
2960 }
2961
2962
2963 /* Like finish_mangling_internal, but return the mangled string.  */
2964
2965 static inline const char *
2966 finish_mangling (const bool warn)
2967 {
2968   finish_mangling_internal (warn);
2969   return (const char *) obstack_finish (mangle_obstack);
2970 }
2971
2972 /* Like finish_mangling_internal, but return an identifier.  */
2973
2974 static tree
2975 finish_mangling_get_identifier (const bool warn)
2976 {
2977   finish_mangling_internal (warn);
2978   /* Don't obstack_finish here, and the next start_mangling will
2979      remove the identifier.  */
2980   return get_identifier ((const char *) obstack_base (mangle_obstack));
2981 }
2982
2983 /* Initialize data structures for mangling.  */
2984
2985 void
2986 init_mangle (void)
2987 {
2988   gcc_obstack_init (&name_obstack);
2989   name_base = obstack_alloc (&name_obstack, 0);
2990   G.substitutions = NULL;
2991
2992   /* Cache these identifiers for quick comparison when checking for
2993      standard substitutions.  */
2994   subst_identifiers[SUBID_ALLOCATOR] = get_identifier ("allocator");
2995   subst_identifiers[SUBID_BASIC_STRING] = get_identifier ("basic_string");
2996   subst_identifiers[SUBID_CHAR_TRAITS] = get_identifier ("char_traits");
2997   subst_identifiers[SUBID_BASIC_ISTREAM] = get_identifier ("basic_istream");
2998   subst_identifiers[SUBID_BASIC_OSTREAM] = get_identifier ("basic_ostream");
2999   subst_identifiers[SUBID_BASIC_IOSTREAM] = get_identifier ("basic_iostream");
3000 }
3001
3002 /* Generate the mangled name of DECL.  */
3003
3004 static tree
3005 mangle_decl_string (const tree decl)
3006 {
3007   tree result;
3008
3009   start_mangling (decl);
3010
3011   if (TREE_CODE (decl) == TYPE_DECL)
3012     write_type (TREE_TYPE (decl));
3013   else
3014     write_mangled_name (decl, true);
3015
3016   result = finish_mangling_get_identifier (/*warn=*/true);
3017   if (DEBUG_MANGLE)
3018     fprintf (stderr, "mangle_decl_string = '%s'\n\n",
3019              IDENTIFIER_POINTER (result));
3020   return result;
3021 }
3022
3023 /* Create an identifier for the external mangled name of DECL.  */
3024
3025 void
3026 mangle_decl (const tree decl)
3027 {
3028   tree id = mangle_decl_string (decl);
3029   id = targetm.mangle_decl_assembler_name (decl, id);
3030   SET_DECL_ASSEMBLER_NAME (decl, id);
3031 }
3032
3033 /* Generate the mangled representation of TYPE.  */
3034
3035 const char *
3036 mangle_type_string (const tree type)
3037 {
3038   const char *result;
3039
3040   start_mangling (type);
3041   write_type (type);
3042   result = finish_mangling (/*warn=*/false);
3043   if (DEBUG_MANGLE)
3044     fprintf (stderr, "mangle_type_string = '%s'\n\n", result);
3045   return result;
3046 }
3047
3048 /* Create an identifier for the mangled name of a special component
3049    for belonging to TYPE.  CODE is the ABI-specified code for this
3050    component.  */
3051
3052 static tree
3053 mangle_special_for_type (const tree type, const char *code)
3054 {
3055   tree result;
3056
3057   /* We don't have an actual decl here for the special component, so
3058      we can't just process the <encoded-name>.  Instead, fake it.  */
3059   start_mangling (type);
3060
3061   /* Start the mangling.  */
3062   write_string ("_Z");
3063   write_string (code);
3064
3065   /* Add the type.  */
3066   write_type (type);
3067   result = finish_mangling_get_identifier (/*warn=*/false);
3068
3069   if (DEBUG_MANGLE)
3070     fprintf (stderr, "mangle_special_for_type = %s\n\n",
3071              IDENTIFIER_POINTER (result));
3072
3073   return result;
3074 }
3075
3076 /* Create an identifier for the mangled representation of the typeinfo
3077    structure for TYPE.  */
3078
3079 tree
3080 mangle_typeinfo_for_type (const tree type)
3081 {
3082   return mangle_special_for_type (type, "TI");
3083 }
3084
3085 /* Create an identifier for the mangled name of the NTBS containing
3086    the mangled name of TYPE.  */
3087
3088 tree
3089 mangle_typeinfo_string_for_type (const tree type)
3090 {
3091   return mangle_special_for_type (type, "TS");
3092 }
3093
3094 /* Create an identifier for the mangled name of the vtable for TYPE.  */
3095
3096 tree
3097 mangle_vtbl_for_type (const tree type)
3098 {
3099   return mangle_special_for_type (type, "TV");
3100 }
3101
3102 /* Returns an identifier for the mangled name of the VTT for TYPE.  */
3103
3104 tree
3105 mangle_vtt_for_type (const tree type)
3106 {
3107   return mangle_special_for_type (type, "TT");
3108 }
3109
3110 /* Return an identifier for a construction vtable group.  TYPE is
3111    the most derived class in the hierarchy; BINFO is the base
3112    subobject for which this construction vtable group will be used.
3113
3114    This mangling isn't part of the ABI specification; in the ABI
3115    specification, the vtable group is dumped in the same COMDAT as the
3116    main vtable, and is referenced only from that vtable, so it doesn't
3117    need an external name.  For binary formats without COMDAT sections,
3118    though, we need external names for the vtable groups.
3119
3120    We use the production
3121
3122     <special-name> ::= CT <type> <offset number> _ <base type>  */
3123
3124 tree
3125 mangle_ctor_vtbl_for_type (const tree type, const tree binfo)
3126 {
3127   tree result;
3128
3129   start_mangling (type);
3130
3131   write_string ("_Z");
3132   write_string ("TC");
3133   write_type (type);
3134   write_integer_cst (BINFO_OFFSET (binfo));
3135   write_char ('_');
3136   write_type (BINFO_TYPE (binfo));
3137
3138   result = finish_mangling_get_identifier (/*warn=*/false);
3139   if (DEBUG_MANGLE)
3140     fprintf (stderr, "mangle_ctor_vtbl_for_type = %s\n\n",
3141              IDENTIFIER_POINTER (result));
3142   return result;
3143 }
3144
3145 /* Mangle a this pointer or result pointer adjustment.
3146
3147    <call-offset> ::= h <fixed offset number> _
3148                  ::= v <fixed offset number> _ <virtual offset number> _ */
3149
3150 static void
3151 mangle_call_offset (const tree fixed_offset, const tree virtual_offset)
3152 {
3153   write_char (virtual_offset ? 'v' : 'h');
3154
3155   /* For either flavor, write the fixed offset.  */
3156   write_integer_cst (fixed_offset);
3157   write_char ('_');
3158
3159   /* For a virtual thunk, add the virtual offset.  */
3160   if (virtual_offset)
3161     {
3162       write_integer_cst (virtual_offset);
3163       write_char ('_');
3164     }
3165 }
3166
3167 /* Return an identifier for the mangled name of a this-adjusting or
3168    covariant thunk to FN_DECL.  FIXED_OFFSET is the initial adjustment
3169    to this used to find the vptr.  If VIRTUAL_OFFSET is non-NULL, this
3170    is a virtual thunk, and it is the vtbl offset in
3171    bytes. THIS_ADJUSTING is nonzero for a this adjusting thunk and
3172    zero for a covariant thunk. Note, that FN_DECL might be a covariant
3173    thunk itself. A covariant thunk name always includes the adjustment
3174    for the this pointer, even if there is none.
3175
3176    <special-name> ::= T <call-offset> <base encoding>
3177                   ::= Tc <this_adjust call-offset> <result_adjust call-offset>
3178                                         <base encoding>  */
3179
3180 tree
3181 mangle_thunk (tree fn_decl, const int this_adjusting, tree fixed_offset,
3182               tree virtual_offset)
3183 {
3184   tree result;
3185
3186   start_mangling (fn_decl);
3187
3188   write_string ("_Z");
3189   write_char ('T');
3190
3191   if (!this_adjusting)
3192     {
3193       /* Covariant thunk with no this adjustment */
3194       write_char ('c');
3195       mangle_call_offset (integer_zero_node, NULL_TREE);
3196       mangle_call_offset (fixed_offset, virtual_offset);
3197     }
3198   else if (!DECL_THUNK_P (fn_decl))
3199     /* Plain this adjusting thunk.  */
3200     mangle_call_offset (fixed_offset, virtual_offset);
3201   else
3202     {
3203       /* This adjusting thunk to covariant thunk.  */
3204       write_char ('c');
3205       mangle_call_offset (fixed_offset, virtual_offset);
3206       fixed_offset = ssize_int (THUNK_FIXED_OFFSET (fn_decl));
3207       virtual_offset = THUNK_VIRTUAL_OFFSET (fn_decl);
3208       if (virtual_offset)
3209         virtual_offset = BINFO_VPTR_FIELD (virtual_offset);
3210       mangle_call_offset (fixed_offset, virtual_offset);
3211       fn_decl = THUNK_TARGET (fn_decl);
3212     }
3213
3214   /* Scoped name.  */
3215   write_encoding (fn_decl);
3216
3217   result = finish_mangling_get_identifier (/*warn=*/false);
3218   if (DEBUG_MANGLE)
3219     fprintf (stderr, "mangle_thunk = %s\n\n", IDENTIFIER_POINTER (result));
3220   return result;
3221 }
3222
3223 /* This hash table maps TYPEs to the IDENTIFIER for a conversion
3224    operator to TYPE.  The nodes are IDENTIFIERs whose TREE_TYPE is the
3225    TYPE.  */
3226
3227 static GTY ((param_is (union tree_node))) htab_t conv_type_names;
3228
3229 /* Hash a node (VAL1) in the table.  */
3230
3231 static hashval_t
3232 hash_type (const void *val)
3233 {
3234   return (hashval_t) TYPE_UID (TREE_TYPE ((const_tree) val));
3235 }
3236
3237 /* Compare VAL1 (a node in the table) with VAL2 (a TYPE).  */
3238
3239 static int
3240 compare_type (const void *val1, const void *val2)
3241 {
3242   return TREE_TYPE ((const_tree) val1) == (const_tree) val2;
3243 }
3244
3245 /* Return an identifier for the mangled unqualified name for a
3246    conversion operator to TYPE.  This mangling is not specified by the
3247    ABI spec; it is only used internally.  */
3248
3249 tree
3250 mangle_conv_op_name_for_type (const tree type)
3251 {
3252   void **slot;
3253   tree identifier;
3254
3255   if (type == error_mark_node)
3256     return error_mark_node;
3257
3258   if (conv_type_names == NULL)
3259     conv_type_names = htab_create_ggc (31, &hash_type, &compare_type, NULL);
3260
3261   slot = htab_find_slot_with_hash (conv_type_names, type,
3262                                    (hashval_t) TYPE_UID (type), INSERT);
3263   identifier = (tree)*slot;
3264   if (!identifier)
3265     {
3266       char buffer[64];
3267
3268        /* Create a unique name corresponding to TYPE.  */
3269       sprintf (buffer, "operator %lu",
3270                (unsigned long) htab_elements (conv_type_names));
3271       identifier = get_identifier (buffer);
3272       *slot = identifier;
3273
3274       /* Hang TYPE off the identifier so it can be found easily later
3275          when performing conversions.  */
3276       TREE_TYPE (identifier) = type;
3277
3278       /* Set bits on the identifier so we know later it's a conversion.  */
3279       IDENTIFIER_OPNAME_P (identifier) = 1;
3280       IDENTIFIER_TYPENAME_P (identifier) = 1;
3281     }
3282
3283   return identifier;
3284 }
3285
3286 /* Return an identifier for the name of an initialization guard
3287    variable for indicated VARIABLE.  */
3288
3289 tree
3290 mangle_guard_variable (const tree variable)
3291 {
3292   start_mangling (variable);
3293   write_string ("_ZGV");
3294   if (strncmp (IDENTIFIER_POINTER (DECL_NAME (variable)), "_ZGR", 4) == 0)
3295     /* The name of a guard variable for a reference temporary should refer
3296        to the reference, not the temporary.  */
3297     write_string (IDENTIFIER_POINTER (DECL_NAME (variable)) + 4);
3298   else
3299     write_name (variable, /*ignore_local_scope=*/0);
3300   return finish_mangling_get_identifier (/*warn=*/false);
3301 }
3302
3303 /* Return an identifier for the name of a temporary variable used to
3304    initialize a static reference.  This isn't part of the ABI, but we might
3305    as well call them something readable.  */
3306
3307 tree
3308 mangle_ref_init_variable (const tree variable)
3309 {
3310   start_mangling (variable);
3311   write_string ("_ZGR");
3312   write_name (variable, /*ignore_local_scope=*/0);
3313   return finish_mangling_get_identifier (/*warn=*/false);
3314 }
3315 \f
3316
3317 /* Foreign language type mangling section.  */
3318
3319 /* How to write the type codes for the integer Java type.  */
3320
3321 static void
3322 write_java_integer_type_codes (const tree type)
3323 {
3324   if (type == java_int_type_node)
3325     write_char ('i');
3326   else if (type == java_short_type_node)
3327     write_char ('s');
3328   else if (type == java_byte_type_node)
3329     write_char ('c');
3330   else if (type == java_char_type_node)
3331     write_char ('w');
3332   else if (type == java_long_type_node)
3333     write_char ('x');
3334   else if (type == java_boolean_type_node)
3335     write_char ('b');
3336   else
3337     gcc_unreachable ();
3338 }
3339
3340 #include "gt-cp-mangle.h"