source: src/SymTab/Mangler.cc @ 642bc83

aaron-thesisarm-ehcleanup-dtorsdeferred_resndemanglerjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-exprno_listpersistent-indexer
Last change on this file since 642bc83 was 642bc83, checked in by Rob Schluntz <rschlunt@…>, 3 years ago

Modify name mangling scheme to more closely resembly itanium C++ name mangling

  • Property mode set to 100644
File size: 14.5 KB
Line 
1//
2// Cforall Version 1.0.0 Copyright (C) 2015 University of Waterloo
3//
4// The contents of this file are covered under the licence agreement in the
5// file "LICENCE" distributed with Cforall.
6//
7// Mangler.cc --
8//
9// Author           : Richard C. Bilson
10// Created On       : Sun May 17 21:40:29 2015
11// Last Modified By : Peter A. Buhr
12// Last Modified On : Mon Sep 25 15:49:26 2017
13// Update Count     : 23
14//
15#include "Mangler.h"
16
17#include <algorithm>                // for copy, transform
18#include <cassert>                  // for assert, assertf
19#include <functional>               // for const_mem_fun_t, mem_fun
20#include <iterator>                 // for ostream_iterator, back_insert_ite...
21#include <list>                     // for _List_iterator, list, _List_const...
22#include <string>                   // for string, char_traits, operator<<
23
24#include "CodeGen/OperatorTable.h"  // for OperatorInfo, operatorLookup
25#include "Common/PassVisitor.h"
26#include "Common/SemanticError.h"   // for SemanticError
27#include "Common/utility.h"         // for toString
28#include "Parser/LinkageSpec.h"     // for Spec, isOverridable, AutoGen, Int...
29#include "SynTree/Declaration.h"    // for TypeDecl, DeclarationWithType
30#include "SynTree/Expression.h"     // for TypeExpr, Expression, operator<<
31#include "SynTree/Type.h"           // for Type, ReferenceToType, Type::Fora...
32
33namespace SymTab {
34        namespace Mangler {
35                namespace {
36                        /// Mangles names to a unique C identifier
37                        struct Mangler : public WithShortCircuiting, public WithVisitorRef<Mangler>, public WithGuards {
38                                Mangler( bool mangleOverridable, bool typeMode, bool mangleGenericParams );
39                                Mangler( const Mangler & ) = delete;
40
41                                void previsit( BaseSyntaxNode * ) { visit_children = false; }
42
43                                void postvisit( ObjectDecl * declaration );
44                                void postvisit( FunctionDecl * declaration );
45                                void postvisit( TypeDecl * declaration );
46
47                                void postvisit( VoidType * voidType );
48                                void postvisit( BasicType * basicType );
49                                void postvisit( PointerType * pointerType );
50                                void postvisit( ArrayType * arrayType );
51                                void postvisit( ReferenceType * refType );
52                                void postvisit( FunctionType * functionType );
53                                void postvisit( StructInstType * aggregateUseType );
54                                void postvisit( UnionInstType * aggregateUseType );
55                                void postvisit( EnumInstType * aggregateUseType );
56                                void postvisit( TypeInstType * aggregateUseType );
57                                void postvisit( TraitInstType * inst );
58                                void postvisit( TupleType * tupleType );
59                                void postvisit( VarArgsType * varArgsType );
60                                void postvisit( ZeroType * zeroType );
61                                void postvisit( OneType * oneType );
62                                void postvisit( QualifiedType * qualType );
63
64                                std::string get_mangleName() { return mangleName.str(); }
65                          private:
66                                std::ostringstream mangleName;  ///< Mangled name being constructed
67                                typedef std::map< std::string, std::pair< int, int > > VarMapType;
68                                VarMapType varNums;             ///< Map of type variables to indices
69                                int nextVarNum;                 ///< Next type variable index
70                                bool isTopLevel;                ///< Is the Mangler at the top level
71                                bool mangleOverridable;         ///< Specially mangle overridable built-in methods
72                                bool typeMode;                  ///< Produce a unique mangled name for a type
73                                bool mangleGenericParams;       ///< Include generic parameters in name mangling if true
74                                bool inFunctionType = false;    ///< Include type qualifiers if false.
75                                bool inQualifiedType = false;   ///< Add start/end delimiters around qualified type
76
77                                void mangleDecl( DeclarationWithType *declaration );
78                                void mangleRef( ReferenceToType *refType, std::string prefix );
79
80                                void printQualifiers( Type *type );
81                        }; // Mangler
82                } // namespace
83
84                std::string mangle( BaseSyntaxNode * decl, bool mangleOverridable, bool typeMode, bool mangleGenericParams ) {
85                        PassVisitor<Mangler> mangler( mangleOverridable, typeMode, mangleGenericParams );
86                        maybeAccept( decl, mangler );
87                        return mangler.pass.get_mangleName();
88                }
89
90                std::string mangleType( Type * ty ) {
91                        PassVisitor<Mangler> mangler( false, true, true );
92                        maybeAccept( ty, mangler );
93                        return mangler.pass.get_mangleName();
94                }
95
96                std::string mangleConcrete( Type * ty ) {
97                        PassVisitor<Mangler> mangler( false, false, false );
98                        maybeAccept( ty, mangler );
99                        return mangler.pass.get_mangleName();
100                }
101
102                namespace {
103                        Mangler::Mangler( bool mangleOverridable, bool typeMode, bool mangleGenericParams )
104                                : nextVarNum( 0 ), isTopLevel( true ), mangleOverridable( mangleOverridable ), typeMode( typeMode ), mangleGenericParams( mangleGenericParams ) {}
105
106                        void Mangler::mangleDecl( DeclarationWithType * declaration ) {
107                                bool wasTopLevel = isTopLevel;
108                                if ( isTopLevel ) {
109                                        varNums.clear();
110                                        nextVarNum = 0;
111                                        isTopLevel = false;
112                                } // if
113                                mangleName << Encoding::manglePrefix;
114                                CodeGen::OperatorInfo opInfo;
115                                if ( operatorLookup( declaration->get_name(), opInfo ) ) {
116                                        mangleName << opInfo.outputName.size() << opInfo.outputName;
117                                } else {
118                                        mangleName << declaration->name.size() << declaration->name;
119                                } // if
120                                maybeAccept( declaration->get_type(), *visitor );
121                                if ( mangleOverridable && LinkageSpec::isOverridable( declaration->get_linkage() ) ) {
122                                        // want to be able to override autogenerated and intrinsic routines,
123                                        // so they need a different name mangling
124                                        if ( declaration->get_linkage() == LinkageSpec::AutoGen ) {
125                                                mangleName << Encoding::autogen;
126                                        } else if ( declaration->get_linkage() == LinkageSpec::Intrinsic ) {
127                                                mangleName << Encoding::intrinsic;
128                                        } else {
129                                                // if we add another kind of overridable function, this has to change
130                                                assert( false && "unknown overrideable linkage" );
131                                        } // if
132                                }
133                                isTopLevel = wasTopLevel;
134                        }
135
136                        void Mangler::postvisit( ObjectDecl * declaration ) {
137                                mangleDecl( declaration );
138                        }
139
140                        void Mangler::postvisit( FunctionDecl * declaration ) {
141                                mangleDecl( declaration );
142                        }
143
144                        void Mangler::postvisit( VoidType * voidType ) {
145                                printQualifiers( voidType );
146                                mangleName << Encoding::voidType;
147                        }
148
149                        void Mangler::postvisit( BasicType * basicType ) {
150                                printQualifiers( basicType );
151                                assert( basicType->get_kind() < BasicType::NUMBER_OF_BASIC_TYPES );
152                                mangleName << Encoding::basicTypes[ basicType->get_kind() ];
153                        }
154
155                        void Mangler::postvisit( PointerType * pointerType ) {
156                                printQualifiers( pointerType );
157                                // mangle void (*f)() and void f() to the same name to prevent overloading on functions and function pointers
158                                if ( ! dynamic_cast<FunctionType *>( pointerType->base ) ) mangleName << Encoding::pointer;
159                                maybeAccept( pointerType->base, *visitor );
160                        }
161
162                        void Mangler::postvisit( ArrayType * arrayType ) {
163                                // TODO: encode dimension
164                                printQualifiers( arrayType );
165                                mangleName << Encoding::array << "0";
166                                maybeAccept( arrayType->base, *visitor );
167                        }
168
169                        void Mangler::postvisit( ReferenceType * refType ) {
170                                // don't print prefix (e.g. 'R') for reference types so that references and non-references do not overload.
171                                // Further, do not print the qualifiers for a reference type (but do run printQualifers because of TypeDecls, etc.),
172                                // by pretending every reference type is a function parameter.
173                                GuardValue( inFunctionType );
174                                inFunctionType = true;
175                                printQualifiers( refType );
176                                maybeAccept( refType->base, *visitor );
177                        }
178
179                        namespace {
180                                inline std::list< Type* > getTypes( const std::list< DeclarationWithType* > decls ) {
181                                        std::list< Type* > ret;
182                                        std::transform( decls.begin(), decls.end(), std::back_inserter( ret ),
183                                                                        std::mem_fun( &DeclarationWithType::get_type ) );
184                                        return ret;
185                                }
186                        }
187
188                        void Mangler::postvisit( FunctionType * functionType ) {
189                                printQualifiers( functionType );
190                                mangleName << Encoding::function;
191                                // turn on inFunctionType so that printQualifiers does not print most qualifiers for function parameters,
192                                // since qualifiers on outermost parameter type do not differentiate function types, e.g.,
193                                // void (*)(const int) and void (*)(int) are the same type, but void (*)(const int *) and void (*)(int *) are different
194                                GuardValue( inFunctionType );
195                                inFunctionType = true;
196                                std::list< Type* > returnTypes = getTypes( functionType->returnVals );
197                                if (returnTypes.empty()) mangleName << Encoding::voidType;
198                                else acceptAll( returnTypes, *visitor );
199                                mangleName << "_";
200                                std::list< Type* > paramTypes = getTypes( functionType->parameters );
201                                acceptAll( paramTypes, *visitor );
202                                mangleName << "_";
203                        }
204
205                        void Mangler::mangleRef( ReferenceToType * refType, std::string prefix ) {
206                                printQualifiers( refType );
207
208                                mangleName << prefix << refType->name.length() << refType->name;
209
210                                if ( mangleGenericParams ) {
211                                        std::list< Expression* >& params = refType->parameters;
212                                        if ( ! params.empty() ) {
213                                                mangleName << "_";
214                                                for ( std::list< Expression* >::const_iterator param = params.begin(); param != params.end(); ++param ) {
215                                                        TypeExpr *paramType = dynamic_cast< TypeExpr* >( *param );
216                                                        assertf(paramType, "Aggregate parameters should be type expressions: %s", toCString(*param));
217                                                        maybeAccept( paramType->type, *visitor );
218                                                }
219                                                mangleName << "_";
220                                        }
221                                }
222                        }
223
224                        void Mangler::postvisit( StructInstType * aggregateUseType ) {
225                                mangleRef( aggregateUseType, "s" );
226                        }
227
228                        void Mangler::postvisit( UnionInstType * aggregateUseType ) {
229                                mangleRef( aggregateUseType, "u" );
230                        }
231
232                        void Mangler::postvisit( EnumInstType * aggregateUseType ) {
233                                mangleRef( aggregateUseType, "e" );
234                        }
235
236                        void Mangler::postvisit( TypeInstType * typeInst ) {
237                                VarMapType::iterator varNum = varNums.find( typeInst->get_name() );
238                                if ( varNum == varNums.end() ) {
239                                        mangleRef( typeInst, "t" );
240                                } else {
241                                        printQualifiers( typeInst );
242                                        std::ostringstream numStream;
243                                        numStream << varNum->second.first;
244                                        switch ( (TypeDecl::Kind )varNum->second.second ) {
245                                          case TypeDecl::Dtype:
246                                                mangleName << "d";
247                                                break;
248                                          case TypeDecl::Ftype:
249                                                mangleName << "f";
250                                                break;
251                                                case TypeDecl::Ttype:
252                                                mangleName << "tVARGS";
253                                                break;
254                                                default:
255                                                assert( false );
256                                        } // switch
257                                        mangleName << numStream.str();
258                                } // if
259                        }
260
261                        void Mangler::postvisit( TraitInstType * inst ) {
262                                printQualifiers( inst );
263                                mangleName << inst->name.size() << inst->name;
264                        }
265
266                        void Mangler::postvisit( TupleType * tupleType ) {
267                                printQualifiers( tupleType );
268                                mangleName << Encoding::tuple << tupleType->types.size();
269                                acceptAll( tupleType->types, *visitor );
270                        }
271
272                        void Mangler::postvisit( VarArgsType * varArgsType ) {
273                                printQualifiers( varArgsType );
274                                static const std::string vargs = "__builtin_va_list";
275                                mangleName << vargs.size() << vargs;
276                        }
277
278                        void Mangler::postvisit( ZeroType * ) {
279                                mangleName << Encoding::zero;
280                        }
281
282                        void Mangler::postvisit( OneType * ) {
283                                mangleName << Encoding::one;
284                        }
285
286                        void Mangler::postvisit( QualifiedType * qualType ) {
287                                bool inqual = inQualifiedType;
288                                if (! inqual ) {
289                                        // N marks the start of a qualified type
290                                        inQualifiedType = true;
291                                        mangleName << Encoding::qualifiedTypeStart;
292                                }
293                                maybeAccept( qualType->parent, *visitor );
294                                maybeAccept( qualType->child, *visitor );
295                                if ( ! inqual ) {
296                                        // E marks the end of a qualified type
297                                        inQualifiedType = false;
298                                        mangleName << Encoding::qualifiedTypeEnd;
299                                }
300                        }
301
302                        void Mangler::postvisit( TypeDecl * decl ) {
303                                static const char *typePrefix[] = { "BT", "BD", "BF" };
304                                mangleName << typePrefix[ decl->get_kind() ] << ( decl->name.length() + 1 ) << decl->name;
305                        }
306
307                        __attribute__((unused)) void printVarMap( const std::map< std::string, std::pair< int, int > > &varMap, std::ostream &os ) {
308                                for ( std::map< std::string, std::pair< int, int > >::const_iterator i = varMap.begin(); i != varMap.end(); ++i ) {
309                                        os << i->first << "(" << i->second.first << "/" << i->second.second << ")" << std::endl;
310                                } // for
311                        }
312
313                        void Mangler::printQualifiers( Type * type ) {
314                                // skip if not including qualifiers
315                                if ( typeMode ) return;
316                                if ( ! type->get_forall().empty() ) {
317                                        std::list< std::string > assertionNames;
318                                        int tcount = 0, dcount = 0, fcount = 0, vcount = 0;
319                                        mangleName << "A";
320                                        for ( Type::ForallList::iterator i = type->forall.begin(); i != type->forall.end(); ++i ) {
321                                                switch ( (*i)->get_kind() ) {
322                                                  case TypeDecl::Dtype:
323                                                        dcount++;
324                                                        break;
325                                                  case TypeDecl::Ftype:
326                                                        fcount++;
327                                                        break;
328                                                  case TypeDecl::Ttype:
329                                                        vcount++;
330                                                        break;
331                                                  default:
332                                                        assert( false );
333                                                } // switch
334                                                varNums[ (*i)->name ] = std::pair< int, int >( nextVarNum++, (int)(*i)->get_kind() );
335                                                for ( std::list< DeclarationWithType* >::iterator assert = (*i)->assertions.begin(); assert != (*i)->assertions.end(); ++assert ) {
336                                                        PassVisitor<Mangler> sub_mangler( mangleOverridable, typeMode, mangleGenericParams );
337                                                        sub_mangler.pass.nextVarNum = nextVarNum;
338                                                        sub_mangler.pass.isTopLevel = false;
339                                                        sub_mangler.pass.varNums = varNums;
340                                                        (*assert)->accept( sub_mangler );
341                                                        assertionNames.push_back( sub_mangler.pass.mangleName.str() );
342                                                } // for
343                                        } // for
344                                        mangleName << tcount << "_" << dcount << "_" << fcount << "_" << vcount << "_";
345                                        std::copy( assertionNames.begin(), assertionNames.end(), std::ostream_iterator< std::string >( mangleName, "" ) );
346                                        mangleName << "_";
347                                } // if
348                                if ( ! inFunctionType ) {
349                                        // these qualifiers do not distinguish the outermost type of a function parameter
350                                        if ( type->get_const() ) {
351                                                mangleName << Encoding::qualifiers.at(Type::Const);
352                                        } // if
353                                        if ( type->get_volatile() ) {
354                                                mangleName << Encoding::qualifiers.at(Type::Volatile);
355                                        } // if
356                                        // Removed due to restrict not affecting function compatibility in GCC
357                                        // if ( type->get_isRestrict() ) {
358                                        //      mangleName << "E";
359                                        // } // if
360                                        if ( type->get_atomic() ) {
361                                                mangleName << Encoding::qualifiers.at(Type::Atomic);
362                                        } // if
363                                }
364                                if ( type->get_mutex() ) {
365                                        mangleName << Encoding::qualifiers.at(Type::Mutex);
366                                } // if
367                                if ( type->get_lvalue() ) {
368                                        // mangle based on whether the type is lvalue, so that the resolver can differentiate lvalues and rvalues
369                                        mangleName << Encoding::qualifiers.at(Type::Lvalue);
370                                }
371
372                                if ( inFunctionType ) {
373                                        // turn off inFunctionType so that types can be differentiated for nested qualifiers
374                                        GuardValue( inFunctionType );
375                                        inFunctionType = false;
376                                }
377                        }
378                }       // namespace
379        } // namespace Mangler
380} // namespace SymTab
381
382// Local Variables: //
383// tab-width: 4 //
384// mode: c++ //
385// compile-command: "make install" //
386// End: //
Note: See TracBrowser for help on using the repository browser.