source: src/SymTab/Mangler.cc@ ad72c8b

ADT aaron-thesis arm-eh ast-experimental cleanup-dtors deferred_resn enum forall-pointer-decay jacob/cs343-translation jenkins-sandbox new-ast new-ast-unique-expr no_list persistent-indexer pthread-emulation qualifiedEnum
Last change on this file since ad72c8b was 0e761e40, checked in by Rob Schluntz <rschlunt@…>, 7 years ago

Change type variable name mangling to use combination of tyvar position/encoding prefix rather than type variable name
  • Property mode set to 100644
File size: 15.4 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::void_t;
147 }
148
149 void Mangler::postvisit( BasicType * basicType ) {
150 printQualifiers( basicType );
151 assertf( basicType->get_kind() < BasicType::NUMBER_OF_BASIC_TYPES, "Unhandled basic type: %d", basicType->get_kind() );
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::void_t;
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, Encoding::struct_t );
226 }
227
228 void Mangler::postvisit( UnionInstType * aggregateUseType ) {
229 mangleRef( aggregateUseType, Encoding::union_t );
230 }
231
232 void Mangler::postvisit( EnumInstType * aggregateUseType ) {
233 mangleRef( aggregateUseType, Encoding::enum_t );
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, Encoding::type );
240 } else {
241 printQualifiers( typeInst );
242 // Note: Can't use name here, since type variable names do not actually disambiguate a function, e.g.
243 // forall(dtype T) void f(T);
244 // forall(dtype S) void f(S);
245 // are equivalent and should mangle the same way. This is accomplished by numbering the type variables when they
246 // are first found and prefixing with the appropriate encoding for the type class.
247 assertf( varNum->second.second < TypeDecl::NUMBER_OF_KINDS, "Unhandled type variable kind: %d", varNum->second.second );
248 mangleName << Encoding::typeVariables[varNum->second.second] << varNum->second.first;
249 } // if
250 }
251
252 void Mangler::postvisit( TraitInstType * inst ) {
253 printQualifiers( inst );
254 mangleName << inst->name.size() << inst->name;
255 }
256
257 void Mangler::postvisit( TupleType * tupleType ) {
258 printQualifiers( tupleType );
259 mangleName << Encoding::tuple << tupleType->types.size();
260 acceptAll( tupleType->types, *visitor );
261 }
262
263 void Mangler::postvisit( VarArgsType * varArgsType ) {
264 printQualifiers( varArgsType );
265 static const std::string vargs = "__builtin_va_list";
266 mangleName << Encoding::type << vargs.size() << vargs;
267 }
268
269 void Mangler::postvisit( ZeroType * ) {
270 mangleName << Encoding::zero;
271 }
272
273 void Mangler::postvisit( OneType * ) {
274 mangleName << Encoding::one;
275 }
276
277 void Mangler::postvisit( QualifiedType * qualType ) {
278 bool inqual = inQualifiedType;
279 if (! inqual ) {
280 // N marks the start of a qualified type
281 inQualifiedType = true;
282 mangleName << Encoding::qualifiedTypeStart;
283 }
284 maybeAccept( qualType->parent, *visitor );
285 maybeAccept( qualType->child, *visitor );
286 if ( ! inqual ) {
287 // E marks the end of a qualified type
288 inQualifiedType = false;
289 mangleName << Encoding::qualifiedTypeEnd;
290 }
291 }
292
293 void Mangler::postvisit( TypeDecl * decl ) {
294 // TODO: is there any case where mangling a TypeDecl makes sense? If so, this code needs to be
295 // fixed to ensure that two TypeDecls mangle to the same name when they are the same type and vice versa.
296 // Note: The current scheme may already work correctly for this case, I have not thought about this deeply
297 // and the case has not yet come up in practice. Alternatively, if not then this code can be removed
298 // aside from the assert false.
299 assertf(false, "Mangler should not visit typedecl: %s", toCString(decl));
300 assertf( decl->get_kind() < TypeDecl::NUMBER_OF_KINDS, "Unhandled type variable kind: %d", decl->get_kind() );
301 mangleName << Encoding::typeVariables[ decl->get_kind() ] << ( decl->name.length() ) << decl->name;
302 }
303
304 __attribute__((unused)) void printVarMap( const std::map< std::string, std::pair< int, int > > &varMap, std::ostream &os ) {
305 for ( std::map< std::string, std::pair< int, int > >::const_iterator i = varMap.begin(); i != varMap.end(); ++i ) {
306 os << i->first << "(" << i->second.first << "/" << i->second.second << ")" << std::endl;
307 } // for
308 }
309
310 void Mangler::printQualifiers( Type * type ) {
311 // skip if not including qualifiers
312 if ( typeMode ) return;
313 if ( ! type->get_forall().empty() ) {
314 std::list< std::string > assertionNames;
315 int dcount = 0, fcount = 0, vcount = 0, acount = 0;
316 mangleName << Encoding::forall;
317 for ( Type::ForallList::iterator i = type->forall.begin(); i != type->forall.end(); ++i ) {
318 switch ( (*i)->get_kind() ) {
319 case TypeDecl::Dtype:
320 dcount++;
321 break;
322 case TypeDecl::Ftype:
323 fcount++;
324 break;
325 case TypeDecl::Ttype:
326 vcount++;
327 break;
328 default:
329 assert( false );
330 } // switch
331 varNums[ (*i)->name ] = std::pair< int, int >( nextVarNum++, (int)(*i)->get_kind() );
332 for ( std::list< DeclarationWithType* >::iterator assert = (*i)->assertions.begin(); assert != (*i)->assertions.end(); ++assert ) {
333 PassVisitor<Mangler> sub_mangler( mangleOverridable, typeMode, mangleGenericParams );
334 sub_mangler.pass.nextVarNum = nextVarNum;
335 sub_mangler.pass.isTopLevel = false;
336 sub_mangler.pass.varNums = varNums;
337 (*assert)->accept( sub_mangler );
338 assertionNames.push_back( sub_mangler.pass.mangleName.str() );
339 acount++;
340 } // for
341 } // for
342 mangleName << dcount << "_" << fcount << "_" << vcount << "_" << acount << "_";
343 std::copy( assertionNames.begin(), assertionNames.end(), std::ostream_iterator< std::string >( mangleName, "" ) );
344 mangleName << "_";
345 } // if
346 if ( ! inFunctionType ) {
347 // these qualifiers do not distinguish the outermost type of a function parameter
348 if ( type->get_const() ) {
349 mangleName << Encoding::qualifiers.at(Type::Const);
350 } // if
351 if ( type->get_volatile() ) {
352 mangleName << Encoding::qualifiers.at(Type::Volatile);
353 } // if
354 // Removed due to restrict not affecting function compatibility in GCC
355 // if ( type->get_isRestrict() ) {
356 // mangleName << "E";
357 // } // if
358 if ( type->get_atomic() ) {
359 mangleName << Encoding::qualifiers.at(Type::Atomic);
360 } // if
361 }
362 if ( type->get_mutex() ) {
363 mangleName << Encoding::qualifiers.at(Type::Mutex);
364 } // if
365 if ( type->get_lvalue() ) {
366 // mangle based on whether the type is lvalue, so that the resolver can differentiate lvalues and rvalues
367 mangleName << Encoding::qualifiers.at(Type::Lvalue);
368 }
369
370 if ( inFunctionType ) {
371 // turn off inFunctionType so that types can be differentiated for nested qualifiers
372 GuardValue( inFunctionType );
373 inFunctionType = false;
374 }
375 }
376 } // namespace
377 } // namespace Mangler
378} // namespace SymTab
379
380// Local Variables: //
381// tab-width: 4 //
382// mode: c++ //
383// compile-command: "make install" //
384// End: //
Note: See TracBrowser for help on using the repository browser.