source: src/GenPoly/Box.cc@ cc3528f

ADT aaron-thesis arm-eh ast-experimental cleanup-dtors ctor deferred_resn demangler enum forall-pointer-decay gc_noraii jacob/cs343-translation jenkins-sandbox memory new-ast new-ast-unique-expr new-env no_list persistent-indexer pthread-emulation qualifiedEnum resolv-new stuck-waitfor-destruct with_gc
Last change on this file since cc3528f was cc3528f, checked in by Rob Schluntz <rschlunt@…>, 10 years ago

Added a few comments to Box.cc

  • Property mode set to 100644
File size: 102.7 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// Box.cc --
8//
9// Author : Richard C. Bilson
10// Created On : Mon May 18 07:44:20 2015
11// Last Modified By : Rob Schluntz
12// Last Modified On : Fri May 13 13:59:22 2016
13// Update Count : 295
14//
15
16#include <algorithm>
17#include <iterator>
18#include <list>
19#include <map>
20#include <set>
21#include <stack>
22#include <string>
23#include <utility>
24#include <vector>
25#include <cassert>
26
27#include "Box.h"
28#include "DeclMutator.h"
29#include "PolyMutator.h"
30#include "FindFunction.h"
31#include "ScopedMap.h"
32#include "ScopedSet.h"
33#include "ScrubTyVars.h"
34
35#include "Parser/ParseNode.h"
36
37#include "SynTree/Constant.h"
38#include "SynTree/Declaration.h"
39#include "SynTree/Expression.h"
40#include "SynTree/Initializer.h"
41#include "SynTree/Mutator.h"
42#include "SynTree/Statement.h"
43#include "SynTree/Type.h"
44#include "SynTree/TypeSubstitution.h"
45
46#include "ResolvExpr/TypeEnvironment.h"
47#include "ResolvExpr/TypeMap.h"
48#include "ResolvExpr/typeops.h"
49
50#include "SymTab/Indexer.h"
51#include "SymTab/Mangler.h"
52
53#include "Common/SemanticError.h"
54#include "Common/UniqueName.h"
55#include "Common/utility.h"
56
57#include <ext/functional> // temporary
58
59namespace GenPoly {
60 namespace {
61 const std::list<Label> noLabels;
62
63 FunctionType *makeAdapterType( FunctionType *adaptee, const TyVarMap &tyVars );
64
65 /// Abstracts type equality for a list of parameter types
66 struct TypeList {
67 TypeList() : params() {}
68 TypeList( const std::list< Type* > &_params ) : params() { cloneAll(_params, params); }
69 TypeList( std::list< Type* > &&_params ) : params( _params ) {}
70
71 TypeList( const TypeList &that ) : params() { cloneAll(that.params, params); }
72 TypeList( TypeList &&that ) : params( std::move( that.params ) ) {}
73
74 /// Extracts types from a list of TypeExpr*
75 TypeList( const std::list< TypeExpr* >& _params ) : params() {
76 for ( std::list< TypeExpr* >::const_iterator param = _params.begin(); param != _params.end(); ++param ) {
77 params.push_back( (*param)->get_type()->clone() );
78 }
79 }
80
81 TypeList& operator= ( const TypeList &that ) {
82 deleteAll( params );
83
84 params.clear();
85 cloneAll( that.params, params );
86
87 return *this;
88 }
89
90 TypeList& operator= ( TypeList &&that ) {
91 deleteAll( params );
92
93 params = std::move( that.params );
94
95 return *this;
96 }
97
98 ~TypeList() { deleteAll( params ); }
99
100 bool operator== ( const TypeList& that ) const {
101 if ( params.size() != that.params.size() ) return false;
102
103 SymTab::Indexer dummy;
104 for ( std::list< Type* >::const_iterator it = params.begin(), jt = that.params.begin(); it != params.end(); ++it, ++jt ) {
105 if ( ! ResolvExpr::typesCompatible( *it, *jt, dummy ) ) return false;
106 }
107 return true;
108 }
109
110 std::list< Type* > params; ///< Instantiation parameters
111 };
112
113 /// Maps a key and a TypeList to the some value, accounting for scope
114 template< typename Key, typename Value >
115 class InstantiationMap {
116 /// Wraps value for a specific (Key, TypeList) combination
117 typedef std::pair< TypeList, Value* > Instantiation;
118 /// List of TypeLists paired with their appropriate values
119 typedef std::vector< Instantiation > ValueList;
120 /// Underlying map type; maps keys to a linear list of corresponding TypeLists and values
121 typedef ScopedMap< Key*, ValueList > InnerMap;
122
123 InnerMap instantiations; ///< instantiations
124
125 public:
126 /// Starts a new scope
127 void beginScope() { instantiations.beginScope(); }
128
129 /// Ends a scope
130 void endScope() { instantiations.endScope(); }
131
132 /// Gets the value for the (key, typeList) pair, returns NULL on none such.
133 Value *lookup( Key *key, const std::list< TypeExpr* >& params ) const {
134 TypeList typeList( params );
135
136 // scan scopes for matches to the key
137 for ( typename InnerMap::const_iterator insts = instantiations.find( key ); insts != instantiations.end(); insts = instantiations.findNext( insts, key ) ) {
138 for ( typename ValueList::const_reverse_iterator inst = insts->second.rbegin(); inst != insts->second.rend(); ++inst ) {
139 if ( inst->first == typeList ) return inst->second;
140 }
141 }
142 // no matching instantiations found
143 return 0;
144 }
145
146 /// Adds a value for a (key, typeList) pair to the current scope
147 void insert( Key *key, const std::list< TypeExpr* > &params, Value *value ) {
148 instantiations[ key ].push_back( Instantiation( TypeList( params ), value ) );
149 }
150 };
151
152 /// Adds layout-generation functions to polymorphic types
153 class LayoutFunctionBuilder : public DeclMutator {
154 unsigned int functionNesting; // current level of nested functions
155 public:
156 LayoutFunctionBuilder() : functionNesting( 0 ) {}
157
158 virtual DeclarationWithType *mutate( FunctionDecl *functionDecl );
159 virtual Declaration *mutate( StructDecl *structDecl );
160 virtual Declaration *mutate( UnionDecl *unionDecl );
161 };
162
163 /// Replaces polymorphic return types with out-parameters, replaces calls to polymorphic functions with adapter calls as needed, and adds appropriate type variables to the function call
164 class Pass1 : public PolyMutator {
165 public:
166 Pass1();
167 virtual Expression *mutate( ApplicationExpr *appExpr );
168 virtual Expression *mutate( AddressExpr *addrExpr );
169 virtual Expression *mutate( UntypedExpr *expr );
170 virtual DeclarationWithType* mutate( FunctionDecl *functionDecl );
171 virtual TypeDecl *mutate( TypeDecl *typeDecl );
172 virtual Expression *mutate( CommaExpr *commaExpr );
173 virtual Expression *mutate( ConditionalExpr *condExpr );
174 virtual Statement * mutate( ReturnStmt *returnStmt );
175 virtual Type *mutate( PointerType *pointerType );
176 virtual Type * mutate( FunctionType *functionType );
177
178 virtual void doBeginScope();
179 virtual void doEndScope();
180 private:
181 /// Pass the extra type parameters from polymorphic generic arguments or return types into a function application
182 void passArgTypeVars( ApplicationExpr *appExpr, Type *parmType, Type *argBaseType, std::list< Expression *>::iterator &arg, const TyVarMap &exprTyVars, std::set< std::string > &seenTypes );
183 /// passes extra type parameters into a polymorphic function application
184 void passTypeVars( ApplicationExpr *appExpr, ReferenceToType *polyRetType, std::list< Expression *>::iterator &arg, const TyVarMap &exprTyVars );
185 /// wraps a function application with a new temporary for the out-parameter return value
186 Expression *addRetParam( ApplicationExpr *appExpr, FunctionType *function, Type *retType, std::list< Expression *>::iterator &arg );
187 /// Replaces all the type parameters of a generic type with their concrete equivalents under the current environment
188 void replaceParametersWithConcrete( ApplicationExpr *appExpr, std::list< Expression* >& params );
189 /// Replaces a polymorphic type with its concrete equivalant under the current environment (returns itself if concrete).
190 /// If `doClone` is set to false, will not clone interior types
191 Type *replaceWithConcrete( ApplicationExpr *appExpr, Type *type, bool doClone = true );
192 /// wraps a function application returning a polymorphic type with a new temporary for the out-parameter return value
193 Expression *addPolyRetParam( ApplicationExpr *appExpr, FunctionType *function, ReferenceToType *polyType, std::list< Expression *>::iterator &arg );
194 Expression *applyAdapter( ApplicationExpr *appExpr, FunctionType *function, std::list< Expression *>::iterator &arg, const TyVarMap &exprTyVars );
195 void boxParam( Type *formal, Expression *&arg, const TyVarMap &exprTyVars );
196 void boxParams( ApplicationExpr *appExpr, FunctionType *function, std::list< Expression *>::iterator &arg, const TyVarMap &exprTyVars );
197 void addInferredParams( ApplicationExpr *appExpr, FunctionType *functionType, std::list< Expression *>::iterator &arg, const TyVarMap &tyVars );
198 /// Stores assignment operators from assertion list in local map of assignment operations
199 void findAssignOps( const std::list< TypeDecl *> &forall );
200 void passAdapters( ApplicationExpr *appExpr, FunctionType *functionType, const TyVarMap &exprTyVars );
201 FunctionDecl *makeAdapter( FunctionType *adaptee, FunctionType *realType, const std::string &mangleName, const TyVarMap &tyVars );
202 /// Replaces intrinsic operator functions with their arithmetic desugaring
203 Expression *handleIntrinsics( ApplicationExpr *appExpr );
204 /// Inserts a new temporary variable into the current scope with an auto-generated name
205 ObjectDecl *makeTemporary( Type *type );
206
207 ScopedMap< std::string, DeclarationWithType *> assignOps; ///< Currently known type variable assignment operators
208 ResolvExpr::TypeMap< DeclarationWithType > scopedAssignOps; ///< Currently known assignment operators
209 ScopedMap< std::string, DeclarationWithType* > adapters; ///< Set of adapter functions in the current scope
210
211 DeclarationWithType *retval;
212 bool useRetval;
213 UniqueName tempNamer;
214 };
215
216 /// * Moves polymorphic returns in function types to pointer-type parameters
217 /// * adds type size and assertion parameters to parameter lists
218 class Pass2 : public PolyMutator {
219 public:
220 template< typename DeclClass >
221 DeclClass *handleDecl( DeclClass *decl, Type *type );
222 virtual DeclarationWithType *mutate( FunctionDecl *functionDecl );
223 virtual ObjectDecl *mutate( ObjectDecl *objectDecl );
224 virtual TypeDecl *mutate( TypeDecl *typeDecl );
225 virtual TypedefDecl *mutate( TypedefDecl *typedefDecl );
226 virtual Type *mutate( PointerType *pointerType );
227 virtual Type *mutate( FunctionType *funcType );
228
229 private:
230 void addAdapters( FunctionType *functionType );
231
232 std::map< UniqueId, std::string > adapterName;
233 };
234
235 /// Mutator pass that replaces concrete instantiations of generic types with actual struct declarations, scoped appropriately
236 class GenericInstantiator : public DeclMutator {
237 /// Map of (generic type, parameter list) pairs to concrete type instantiations
238 InstantiationMap< AggregateDecl, AggregateDecl > instantiations;
239 /// Namer for concrete types
240 UniqueName typeNamer;
241
242 public:
243 GenericInstantiator() : DeclMutator(), instantiations(), typeNamer("_conc_") {}
244
245 virtual Type* mutate( StructInstType *inst );
246 virtual Type* mutate( UnionInstType *inst );
247
248 // virtual Expression* mutate( MemberExpr *memberExpr );
249
250 virtual void doBeginScope();
251 virtual void doEndScope();
252 private:
253 /// Wrap instantiation lookup for structs
254 StructDecl* lookup( StructInstType *inst, const std::list< TypeExpr* > &typeSubs ) { return (StructDecl*)instantiations.lookup( inst->get_baseStruct(), typeSubs ); }
255 /// Wrap instantiation lookup for unions
256 UnionDecl* lookup( UnionInstType *inst, const std::list< TypeExpr* > &typeSubs ) { return (UnionDecl*)instantiations.lookup( inst->get_baseUnion(), typeSubs ); }
257 /// Wrap instantiation insertion for structs
258 void insert( StructInstType *inst, const std::list< TypeExpr* > &typeSubs, StructDecl *decl ) { instantiations.insert( inst->get_baseStruct(), typeSubs, decl ); }
259 /// Wrap instantiation insertion for unions
260 void insert( UnionInstType *inst, const std::list< TypeExpr* > &typeSubs, UnionDecl *decl ) { instantiations.insert( inst->get_baseUnion(), typeSubs, decl ); }
261 };
262
263 /// Replaces member and size/align/offsetof expressions on polymorphic generic types with calculated expressions.
264 /// * Replaces member expressions for polymorphic types with calculated add-field-offset-and-dereference
265 /// * Calculates polymorphic offsetof expressions from offset array
266 /// * Inserts dynamic calculation of polymorphic type layouts where needed
267 class PolyGenericCalculator : public PolyMutator {
268 public:
269 template< typename DeclClass >
270 DeclClass *handleDecl( DeclClass *decl, Type *type );
271 virtual DeclarationWithType *mutate( FunctionDecl *functionDecl );
272 virtual ObjectDecl *mutate( ObjectDecl *objectDecl );
273 virtual TypedefDecl *mutate( TypedefDecl *objectDecl );
274 virtual TypeDecl *mutate( TypeDecl *objectDecl );
275 virtual Statement *mutate( DeclStmt *declStmt );
276 virtual Type *mutate( PointerType *pointerType );
277 virtual Type *mutate( FunctionType *funcType );
278 virtual Expression *mutate( MemberExpr *memberExpr );
279 virtual Expression *mutate( SizeofExpr *sizeofExpr );
280 virtual Expression *mutate( AlignofExpr *alignofExpr );
281 virtual Expression *mutate( OffsetofExpr *offsetofExpr );
282 virtual Expression *mutate( OffsetPackExpr *offsetPackExpr );
283
284 virtual void doBeginScope();
285 virtual void doEndScope();
286
287 private:
288 /// Makes a new variable in the current scope with the given name, type & optional initializer
289 ObjectDecl *makeVar( const std::string &name, Type *type, Initializer *init = 0 );
290 /// returns true if the type has a dynamic layout; such a layout will be stored in appropriately-named local variables when the function returns
291 bool findGeneric( Type *ty );
292 /// adds type parameters to the layout call; will generate the appropriate parameters if needed
293 void addOtypeParamsToLayoutCall( UntypedExpr *layoutCall, const std::list< Type* > &otypeParams );
294
295 /// Enters a new scope for type-variables, adding the type variables from ty
296 void beginTypeScope( Type *ty );
297 /// Exits the type-variable scope
298 void endTypeScope();
299
300 ScopedSet< std::string > knownLayouts; ///< Set of generic type layouts known in the current scope, indexed by sizeofName
301 ScopedSet< std::string > knownOffsets; ///< Set of non-generic types for which the offset array exists in the current scope, indexed by offsetofName
302 };
303
304 /// Replaces initialization of polymorphic values with alloca, declaration of dtype/ftype with appropriate void expression, and sizeof expressions of polymorphic types with the proper variable
305 class Pass3 : public PolyMutator {
306 public:
307 template< typename DeclClass >
308 DeclClass *handleDecl( DeclClass *decl, Type *type );
309 virtual DeclarationWithType *mutate( FunctionDecl *functionDecl );
310 virtual ObjectDecl *mutate( ObjectDecl *objectDecl );
311 virtual TypedefDecl *mutate( TypedefDecl *objectDecl );
312 virtual TypeDecl *mutate( TypeDecl *objectDecl );
313 virtual Type *mutate( PointerType *pointerType );
314 virtual Type *mutate( FunctionType *funcType );
315 private:
316 };
317
318 } // anonymous namespace
319
320 /// version of mutateAll with special handling for translation unit so you can check the end of the prelude when debugging
321 template< typename MutatorType >
322 inline void mutateTranslationUnit( std::list< Declaration* > &translationUnit, MutatorType &mutator ) {
323 bool seenIntrinsic = false;
324 SemanticError errors;
325 for ( typename std::list< Declaration* >::iterator i = translationUnit.begin(); i != translationUnit.end(); ++i ) {
326 try {
327 if ( *i ) {
328 if ( (*i)->get_linkage() == LinkageSpec::Intrinsic ) {
329 seenIntrinsic = true;
330 } else if ( seenIntrinsic ) {
331 seenIntrinsic = false; // break on this line when debugging for end of prelude
332 }
333
334 *i = dynamic_cast< Declaration* >( (*i)->acceptMutator( mutator ) );
335 assert( *i );
336 } // if
337 } catch( SemanticError &e ) {
338 errors.append( e );
339 } // try
340 } // for
341 if ( ! errors.isEmpty() ) {
342 throw errors;
343 } // if
344 }
345
346 void box( std::list< Declaration *>& translationUnit ) {
347 LayoutFunctionBuilder layoutBuilder;
348 Pass1 pass1;
349 Pass2 pass2;
350 GenericInstantiator instantiator;
351 PolyGenericCalculator polyCalculator;
352 Pass3 pass3;
353
354 layoutBuilder.mutateDeclarationList( translationUnit );
355 mutateTranslationUnit/*All*/( translationUnit, pass1 );
356 mutateTranslationUnit/*All*/( translationUnit, pass2 );
357 instantiator.mutateDeclarationList( translationUnit );
358 mutateTranslationUnit/*All*/( translationUnit, polyCalculator );
359 mutateTranslationUnit/*All*/( translationUnit, pass3 );
360 }
361
362 ////////////////////////////////// LayoutFunctionBuilder ////////////////////////////////////////////
363
364 DeclarationWithType *LayoutFunctionBuilder::mutate( FunctionDecl *functionDecl ) {
365 functionDecl->set_functionType( maybeMutate( functionDecl->get_functionType(), *this ) );
366 mutateAll( functionDecl->get_oldDecls(), *this );
367 ++functionNesting;
368 functionDecl->set_statements( maybeMutate( functionDecl->get_statements(), *this ) );
369 --functionNesting;
370 return functionDecl;
371 }
372
373 /// Get a list of type declarations that will affect a layout function
374 std::list< TypeDecl* > takeOtypeOnly( std::list< TypeDecl* > &decls ) {
375 std::list< TypeDecl * > otypeDecls;
376
377 for ( std::list< TypeDecl* >::const_iterator decl = decls.begin(); decl != decls.end(); ++decl ) {
378 if ( (*decl)->get_kind() == TypeDecl::Any ) {
379 otypeDecls.push_back( *decl );
380 }
381 }
382
383 return otypeDecls;
384 }
385
386 /// Adds parameters for otype layout to a function type
387 void addOtypeParams( FunctionType *layoutFnType, std::list< TypeDecl* > &otypeParams ) {
388 BasicType sizeAlignType( Type::Qualifiers(), BasicType::LongUnsignedInt );
389
390 for ( std::list< TypeDecl* >::const_iterator param = otypeParams.begin(); param != otypeParams.end(); ++param ) {
391 TypeInstType paramType( Type::Qualifiers(), (*param)->get_name(), *param );
392 std::string paramName = mangleType( &paramType );
393 layoutFnType->get_parameters().push_back( new ObjectDecl( sizeofName( paramName ), DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, sizeAlignType.clone(), 0 ) );
394 layoutFnType->get_parameters().push_back( new ObjectDecl( alignofName( paramName ), DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, sizeAlignType.clone(), 0 ) );
395 }
396 }
397
398 /// Builds a layout function declaration
399 FunctionDecl *buildLayoutFunctionDecl( AggregateDecl *typeDecl, unsigned int functionNesting, FunctionType *layoutFnType ) {
400 // Routines at global scope marked "static" to prevent multiple definitions is separate translation units
401 // because each unit generates copies of the default routines for each aggregate.
402 FunctionDecl *layoutDecl = new FunctionDecl(
403 layoutofName( typeDecl ), functionNesting > 0 ? DeclarationNode::NoStorageClass : DeclarationNode::Static, LinkageSpec::AutoGen, layoutFnType, new CompoundStmt( noLabels ), true, false );
404 layoutDecl->fixUniqueId();
405 return layoutDecl;
406 }
407
408 /// Makes a unary operation
409 Expression *makeOp( const std::string &name, Expression *arg ) {
410 UntypedExpr *expr = new UntypedExpr( new NameExpr( name ) );
411 expr->get_args().push_back( arg );
412 return expr;
413 }
414
415 /// Makes a binary operation
416 Expression *makeOp( const std::string &name, Expression *lhs, Expression *rhs ) {
417 UntypedExpr *expr = new UntypedExpr( new NameExpr( name ) );
418 expr->get_args().push_back( lhs );
419 expr->get_args().push_back( rhs );
420 return expr;
421 }
422
423 /// Returns the dereference of a local pointer variable
424 Expression *derefVar( ObjectDecl *var ) {
425 return makeOp( "*?", new VariableExpr( var ) );
426 }
427
428 /// makes an if-statement with a single-expression if-block and no then block
429 Statement *makeCond( Expression *cond, Expression *ifPart ) {
430 return new IfStmt( noLabels, cond, new ExprStmt( noLabels, ifPart ), 0 );
431 }
432
433 /// makes a statement that assigns rhs to lhs if lhs < rhs
434 Statement *makeAssignMax( Expression *lhs, Expression *rhs ) {
435 return makeCond( makeOp( "?<?", lhs, rhs ), makeOp( "?=?", lhs->clone(), rhs->clone() ) );
436 }
437
438 /// makes a statement that aligns lhs to rhs (rhs should be an integer power of two)
439 Statement *makeAlignTo( Expression *lhs, Expression *rhs ) {
440 // check that the lhs is zeroed out to the level of rhs
441 Expression *ifCond = makeOp( "?&?", lhs, makeOp( "?-?", rhs, new ConstantExpr( Constant( new BasicType( Type::Qualifiers(), BasicType::LongUnsignedInt ), "1" ) ) ) );
442 // if not aligned, increment to alignment
443 Expression *ifExpr = makeOp( "?+=?", lhs->clone(), makeOp( "?-?", rhs->clone(), ifCond->clone() ) );
444 return makeCond( ifCond, ifExpr );
445 }
446
447 /// adds an expression to a compound statement
448 void addExpr( CompoundStmt *stmts, Expression *expr ) {
449 stmts->get_kids().push_back( new ExprStmt( noLabels, expr ) );
450 }
451
452 /// adds a statement to a compound statement
453 void addStmt( CompoundStmt *stmts, Statement *stmt ) {
454 stmts->get_kids().push_back( stmt );
455 }
456
457 Declaration *LayoutFunctionBuilder::mutate( StructDecl *structDecl ) {
458 // do not generate layout function for "empty" tag structs
459 if ( structDecl->get_members().empty() ) return structDecl;
460
461 // get parameters that can change layout, exiting early if none
462 std::list< TypeDecl* > otypeParams = takeOtypeOnly( structDecl->get_parameters() );
463 if ( otypeParams.empty() ) return structDecl;
464
465 // build layout function signature
466 FunctionType *layoutFnType = new FunctionType( Type::Qualifiers(), false );
467 BasicType *sizeAlignType = new BasicType( Type::Qualifiers(), BasicType::LongUnsignedInt );
468 PointerType *sizeAlignOutType = new PointerType( Type::Qualifiers(), sizeAlignType );
469
470 ObjectDecl *sizeParam = new ObjectDecl( sizeofName( structDecl->get_name() ), DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, sizeAlignOutType, 0 );
471 layoutFnType->get_parameters().push_back( sizeParam );
472 ObjectDecl *alignParam = new ObjectDecl( alignofName( structDecl->get_name() ), DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, sizeAlignOutType->clone(), 0 );
473 layoutFnType->get_parameters().push_back( alignParam );
474 ObjectDecl *offsetParam = new ObjectDecl( offsetofName( structDecl->get_name() ), DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, sizeAlignOutType->clone(), 0 );
475 layoutFnType->get_parameters().push_back( offsetParam );
476 addOtypeParams( layoutFnType, otypeParams );
477
478 // build function decl
479 FunctionDecl *layoutDecl = buildLayoutFunctionDecl( structDecl, functionNesting, layoutFnType );
480
481 // calculate struct layout in function body
482
483 // initialize size and alignment to 0 and 1 (will have at least one member to re-edit size
484 addExpr( layoutDecl->get_statements(), makeOp( "?=?", derefVar( sizeParam ), new ConstantExpr( Constant( sizeAlignType->clone(), "0" ) ) ) );
485 addExpr( layoutDecl->get_statements(), makeOp( "?=?", derefVar( alignParam ), new ConstantExpr( Constant( sizeAlignType->clone(), "1" ) ) ) );
486 unsigned long n_members = 0;
487 bool firstMember = true;
488 for ( std::list< Declaration* >::const_iterator member = structDecl->get_members().begin(); member != structDecl->get_members().end(); ++member ) {
489 DeclarationWithType *dwt = dynamic_cast< DeclarationWithType * >( *member );
490 assert( dwt );
491 Type *memberType = dwt->get_type();
492
493 if ( firstMember ) {
494 firstMember = false;
495 } else {
496 // make sure all members after the first (automatically aligned at 0) are properly padded for alignment
497 addStmt( layoutDecl->get_statements(), makeAlignTo( derefVar( sizeParam ), new AlignofExpr( memberType->clone() ) ) );
498 }
499
500 // place current size in the current offset index
501 addExpr( layoutDecl->get_statements(), makeOp( "?=?", makeOp( "?[?]", new VariableExpr( offsetParam ), new ConstantExpr( Constant::from_ulong( n_members ) ) ),
502 derefVar( sizeParam ) ) );
503 ++n_members;
504
505 // add member size to current size
506 addExpr( layoutDecl->get_statements(), makeOp( "?+=?", derefVar( sizeParam ), new SizeofExpr( memberType->clone() ) ) );
507
508 // take max of member alignment and global alignment
509 addStmt( layoutDecl->get_statements(), makeAssignMax( derefVar( alignParam ), new AlignofExpr( memberType->clone() ) ) );
510 }
511 // make sure the type is end-padded to a multiple of its alignment
512 addStmt( layoutDecl->get_statements(), makeAlignTo( derefVar( sizeParam ), derefVar( alignParam ) ) );
513
514 addDeclarationAfter( layoutDecl );
515 return structDecl;
516 }
517
518 Declaration *LayoutFunctionBuilder::mutate( UnionDecl *unionDecl ) {
519 // do not generate layout function for "empty" tag unions
520 if ( unionDecl->get_members().empty() ) return unionDecl;
521
522 // get parameters that can change layout, exiting early if none
523 std::list< TypeDecl* > otypeParams = takeOtypeOnly( unionDecl->get_parameters() );
524 if ( otypeParams.empty() ) return unionDecl;
525
526 // build layout function signature
527 FunctionType *layoutFnType = new FunctionType( Type::Qualifiers(), false );
528 BasicType *sizeAlignType = new BasicType( Type::Qualifiers(), BasicType::LongUnsignedInt );
529 PointerType *sizeAlignOutType = new PointerType( Type::Qualifiers(), sizeAlignType );
530
531 ObjectDecl *sizeParam = new ObjectDecl( sizeofName( unionDecl->get_name() ), DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, sizeAlignOutType, 0 );
532 layoutFnType->get_parameters().push_back( sizeParam );
533 ObjectDecl *alignParam = new ObjectDecl( alignofName( unionDecl->get_name() ), DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, sizeAlignOutType->clone(), 0 );
534 layoutFnType->get_parameters().push_back( alignParam );
535 addOtypeParams( layoutFnType, otypeParams );
536
537 // build function decl
538 FunctionDecl *layoutDecl = buildLayoutFunctionDecl( unionDecl, functionNesting, layoutFnType );
539
540 // calculate union layout in function body
541 addExpr( layoutDecl->get_statements(), makeOp( "?=?", derefVar( sizeParam ), new ConstantExpr( Constant( sizeAlignType->clone(), "1" ) ) ) );
542 addExpr( layoutDecl->get_statements(), makeOp( "?=?", derefVar( alignParam ), new ConstantExpr( Constant( sizeAlignType->clone(), "1" ) ) ) );
543 for ( std::list< Declaration* >::const_iterator member = unionDecl->get_members().begin(); member != unionDecl->get_members().end(); ++member ) {
544 DeclarationWithType *dwt = dynamic_cast< DeclarationWithType * >( *member );
545 assert( dwt );
546 Type *memberType = dwt->get_type();
547
548 // take max member size and global size
549 addStmt( layoutDecl->get_statements(), makeAssignMax( derefVar( sizeParam ), new SizeofExpr( memberType->clone() ) ) );
550
551 // take max of member alignment and global alignment
552 addStmt( layoutDecl->get_statements(), makeAssignMax( derefVar( alignParam ), new AlignofExpr( memberType->clone() ) ) );
553 }
554 // make sure the type is end-padded to a multiple of its alignment
555 addStmt( layoutDecl->get_statements(), makeAlignTo( derefVar( sizeParam ), derefVar( alignParam ) ) );
556
557 addDeclarationAfter( layoutDecl );
558 return unionDecl;
559 }
560
561 ////////////////////////////////////////// Pass1 ////////////////////////////////////////////////////
562
563 namespace {
564 std::string makePolyMonoSuffix( FunctionType * function, const TyVarMap &tyVars ) {
565 std::stringstream name;
566
567 // NOTE: this function previously used isPolyObj, which failed to produce
568 // the correct thing in some situations. It's not clear to me why this wasn't working.
569
570 // if the return type or a parameter type involved polymorphic types, then the adapter will need
571 // to take those polymorphic types as pointers. Therefore, there can be two different functions
572 // with the same mangled name, so we need to further mangle the names.
573 for ( std::list< DeclarationWithType *>::iterator retval = function->get_returnVals().begin(); retval != function->get_returnVals().end(); ++retval ) {
574 if ( isPolyType( (*retval)->get_type(), tyVars ) ) {
575 name << "P";
576 } else {
577 name << "M";
578 }
579 }
580 name << "_";
581 std::list< DeclarationWithType *> &paramList = function->get_parameters();
582 for ( std::list< DeclarationWithType *>::iterator arg = paramList.begin(); arg != paramList.end(); ++arg ) {
583 if ( isPolyType( (*arg)->get_type(), tyVars ) ) {
584 name << "P";
585 } else {
586 name << "M";
587 }
588 } // for
589 return name.str();
590 }
591
592 std::string mangleAdapterName( FunctionType * function, const TyVarMap &tyVars ) {
593 return SymTab::Mangler::mangle( function ) + makePolyMonoSuffix( function, tyVars );
594 }
595
596 std::string makeAdapterName( const std::string &mangleName ) {
597 return "_adapter" + mangleName;
598 }
599
600 Pass1::Pass1() : useRetval( false ), tempNamer( "_temp" ) {}
601
602 /// Returns T if the given declaration is (*?=?)(T *, T) for some TypeInstType T (return not checked, but maybe should be), NULL otherwise
603 TypeInstType *isTypeInstAssignment( DeclarationWithType *decl ) {
604 if ( decl->get_name() == "?=?" ) {
605 if ( FunctionType *funType = getFunctionType( decl->get_type() ) ) {
606 if ( funType->get_parameters().size() == 2 ) {
607 if ( PointerType *pointer = dynamic_cast< PointerType *>( funType->get_parameters().front()->get_type() ) ) {
608 if ( TypeInstType *refType = dynamic_cast< TypeInstType *>( pointer->get_base() ) ) {
609 if ( TypeInstType *refType2 = dynamic_cast< TypeInstType *>( funType->get_parameters().back()->get_type() ) ) {
610 if ( refType->get_name() == refType2->get_name() ) {
611 return refType;
612 } // if
613 } // if
614 } // if
615 } // if
616 } // if
617 } // if
618 } // if
619 return 0;
620 }
621
622 /// returns T if the given declaration is: (*?=?)(T *, T) for some type T (return not checked, but maybe should be), NULL otherwise
623 /// Only picks assignments where neither parameter is cv-qualified
624 Type *isAssignment( DeclarationWithType *decl ) {
625 if ( decl->get_name() == "?=?" ) {
626 if ( FunctionType *funType = getFunctionType( decl->get_type() ) ) {
627 if ( funType->get_parameters().size() == 2 ) {
628 Type::Qualifiers defaultQualifiers;
629 Type *paramType1 = funType->get_parameters().front()->get_type();
630 if ( paramType1->get_qualifiers() != defaultQualifiers ) return 0;
631 Type *paramType2 = funType->get_parameters().back()->get_type();
632 if ( paramType2->get_qualifiers() != defaultQualifiers ) return 0;
633
634 if ( PointerType *pointerType = dynamic_cast< PointerType* >( paramType1 ) ) {
635 Type *baseType1 = pointerType->get_base();
636 if ( baseType1->get_qualifiers() != defaultQualifiers ) return 0;
637 SymTab::Indexer dummy;
638 if ( ResolvExpr::typesCompatible( baseType1, paramType2, dummy ) ) {
639 return baseType1;
640 } // if
641 } // if
642 } // if
643 } // if
644 } // if
645 return 0;
646 }
647
648 void Pass1::findAssignOps( const std::list< TypeDecl *> &forall ) {
649 // what if a nested function uses an assignment operator?
650 // assignOps.clear();
651 for ( std::list< TypeDecl *>::const_iterator i = forall.begin(); i != forall.end(); ++i ) {
652 for ( std::list< DeclarationWithType *>::const_iterator assert = (*i)->get_assertions().begin(); assert != (*i)->get_assertions().end(); ++assert ) {
653 std::string typeName;
654 if ( TypeInstType *typeInst = isTypeInstAssignment( *assert ) ) {
655 assignOps[ typeInst->get_name() ] = *assert;
656 } // if
657 } // for
658 } // for
659 }
660
661 DeclarationWithType *Pass1::mutate( FunctionDecl *functionDecl ) {
662 // if this is a assignment function, put it in the map for this scope
663 if ( Type *assignedType = isAssignment( functionDecl ) ) {
664 if ( ! dynamic_cast< TypeInstType* >( assignedType ) ) {
665 scopedAssignOps.insert( assignedType, functionDecl );
666 }
667 }
668
669 if ( functionDecl->get_statements() ) { // empty routine body ?
670 doBeginScope();
671 scopeTyVars.beginScope();
672 assignOps.beginScope();
673 DeclarationWithType *oldRetval = retval;
674 bool oldUseRetval = useRetval;
675
676 // process polymorphic return value
677 retval = 0;
678 if ( isPolyRet( functionDecl->get_functionType() ) && functionDecl->get_linkage() == LinkageSpec::Cforall ) {
679 retval = functionDecl->get_functionType()->get_returnVals().front();
680
681 // give names to unnamed return values
682 if ( retval->get_name() == "" ) {
683 retval->set_name( "_retparm" );
684 retval->set_linkage( LinkageSpec::C );
685 } // if
686 } // if
687
688 FunctionType *functionType = functionDecl->get_functionType();
689 makeTyVarMap( functionDecl->get_functionType(), scopeTyVars );
690 findAssignOps( functionDecl->get_functionType()->get_forall() );
691
692 std::list< DeclarationWithType *> &paramList = functionType->get_parameters();
693 std::list< FunctionType *> functions;
694 for ( std::list< TypeDecl *>::iterator tyVar = functionType->get_forall().begin(); tyVar != functionType->get_forall().end(); ++tyVar ) {
695 for ( std::list< DeclarationWithType *>::iterator assert = (*tyVar)->get_assertions().begin(); assert != (*tyVar)->get_assertions().end(); ++assert ) {
696 findFunction( (*assert)->get_type(), functions, scopeTyVars, needsAdapter );
697 } // for
698 } // for
699 for ( std::list< DeclarationWithType *>::iterator arg = paramList.begin(); arg != paramList.end(); ++arg ) {
700 findFunction( (*arg)->get_type(), functions, scopeTyVars, needsAdapter );
701 } // for
702
703 for ( std::list< FunctionType *>::iterator funType = functions.begin(); funType != functions.end(); ++funType ) {
704 std::string mangleName = mangleAdapterName( *funType, scopeTyVars );
705 if ( adapters.find( mangleName ) == adapters.end() ) {
706 std::string adapterName = makeAdapterName( mangleName );
707 adapters.insert( std::pair< std::string, DeclarationWithType *>( mangleName, new ObjectDecl( adapterName, DeclarationNode::NoStorageClass, LinkageSpec::C, 0, new PointerType( Type::Qualifiers(), makeAdapterType( *funType, scopeTyVars ) ), 0 ) ) );
708 } // if
709 } // for
710
711 functionDecl->set_statements( functionDecl->get_statements()->acceptMutator( *this ) );
712
713 scopeTyVars.endScope();
714 assignOps.endScope();
715 retval = oldRetval;
716 useRetval = oldUseRetval;
717 doEndScope();
718 } // if
719 return functionDecl;
720 }
721
722 TypeDecl *Pass1::mutate( TypeDecl *typeDecl ) {
723 scopeTyVars[ typeDecl->get_name() ] = typeDecl->get_kind();
724 return Mutator::mutate( typeDecl );
725 }
726
727 Expression *Pass1::mutate( CommaExpr *commaExpr ) {
728 bool oldUseRetval = useRetval;
729 useRetval = false;
730 commaExpr->set_arg1( maybeMutate( commaExpr->get_arg1(), *this ) );
731 useRetval = oldUseRetval;
732 commaExpr->set_arg2( maybeMutate( commaExpr->get_arg2(), *this ) );
733 return commaExpr;
734 }
735
736 Expression *Pass1::mutate( ConditionalExpr *condExpr ) {
737 bool oldUseRetval = useRetval;
738 useRetval = false;
739 condExpr->set_arg1( maybeMutate( condExpr->get_arg1(), *this ) );
740 useRetval = oldUseRetval;
741 condExpr->set_arg2( maybeMutate( condExpr->get_arg2(), *this ) );
742 condExpr->set_arg3( maybeMutate( condExpr->get_arg3(), *this ) );
743 return condExpr;
744
745 }
746
747 void Pass1::passArgTypeVars( ApplicationExpr *appExpr, Type *parmType, Type *argBaseType, std::list< Expression *>::iterator &arg, const TyVarMap &exprTyVars, std::set< std::string > &seenTypes ) {
748 Type *polyType = isPolyType( parmType, exprTyVars );
749 if ( polyType && ! dynamic_cast< TypeInstType* >( polyType ) ) {
750 std::string typeName = mangleType( polyType );
751 if ( seenTypes.count( typeName ) ) return;
752
753 arg = appExpr->get_args().insert( arg, new SizeofExpr( argBaseType->clone() ) );
754 arg++;
755 arg = appExpr->get_args().insert( arg, new AlignofExpr( argBaseType->clone() ) );
756 arg++;
757 if ( dynamic_cast< StructInstType* >( polyType ) ) {
758 if ( StructInstType *argBaseStructType = dynamic_cast< StructInstType* >( argBaseType ) ) {
759 // zero-length arrays are forbidden by C, so don't pass offset for empty struct
760 if ( ! argBaseStructType->get_baseStruct()->get_members().empty() ) {
761 arg = appExpr->get_args().insert( arg, new OffsetPackExpr( argBaseStructType->clone() ) );
762 arg++;
763 }
764 } else {
765 throw SemanticError( "Cannot pass non-struct type for generic struct" );
766 }
767 }
768
769 seenTypes.insert( typeName );
770 }
771 }
772
773 void Pass1::passTypeVars( ApplicationExpr *appExpr, ReferenceToType *polyRetType, std::list< Expression *>::iterator &arg, const TyVarMap &exprTyVars ) {
774 // pass size/align for type variables
775 for ( TyVarMap::const_iterator tyParm = exprTyVars.begin(); tyParm != exprTyVars.end(); ++tyParm ) {
776 ResolvExpr::EqvClass eqvClass;
777 assert( env );
778 if ( tyParm->second == TypeDecl::Any ) {
779 Type *concrete = env->lookup( tyParm->first );
780 if ( concrete ) {
781 arg = appExpr->get_args().insert( arg, new SizeofExpr( concrete->clone() ) );
782 arg++;
783 arg = appExpr->get_args().insert( arg, new AlignofExpr( concrete->clone() ) );
784 arg++;
785 } else {
786 throw SemanticError( "unbound type variable in application ", appExpr );
787 } // if
788 } // if
789 } // for
790
791 // add size/align for generic types to parameter list
792 if ( appExpr->get_function()->get_results().empty() ) return;
793 FunctionType *funcType = getFunctionType( appExpr->get_function()->get_results().front() );
794 assert( funcType );
795
796 std::list< DeclarationWithType* >::const_iterator fnParm = funcType->get_parameters().begin();
797 std::list< Expression* >::const_iterator fnArg = arg;
798 std::set< std::string > seenTypes; //< names for generic types we've seen
799
800 // a polymorphic return type may need to be added to the argument list
801 if ( polyRetType ) {
802 Type *concRetType = replaceWithConcrete( appExpr, polyRetType );
803 passArgTypeVars( appExpr, polyRetType, concRetType, arg, exprTyVars, seenTypes );
804 }
805
806 // add type information args for presently unseen types in parameter list
807 for ( ; fnParm != funcType->get_parameters().end() && fnArg != appExpr->get_args().end(); ++fnParm, ++fnArg ) {
808 VariableExpr *fnArgBase = getBaseVar( *fnArg );
809 if ( ! fnArgBase || fnArgBase->get_results().empty() ) continue;
810 passArgTypeVars( appExpr, (*fnParm)->get_type(), fnArgBase->get_results().front(), arg, exprTyVars, seenTypes );
811 }
812 }
813
814 ObjectDecl *Pass1::makeTemporary( Type *type ) {
815 ObjectDecl *newObj = new ObjectDecl( tempNamer.newName(), DeclarationNode::NoStorageClass, LinkageSpec::C, 0, type, 0 );
816 stmtsToAdd.push_back( new DeclStmt( noLabels, newObj ) );
817 return newObj;
818 }
819
820 Expression *Pass1::addRetParam( ApplicationExpr *appExpr, FunctionType *function, Type *retType, std::list< Expression *>::iterator &arg ) {
821 // ***** Code Removal ***** After introducing a temporary variable for all return expressions, the following code appears superfluous.
822 // if ( useRetval ) {
823 // assert( retval );
824 // arg = appExpr->get_args().insert( arg, new VariableExpr( retval ) );
825 // arg++;
826 // } else {
827
828 // Create temporary to hold return value of polymorphic function and produce that temporary as a result
829 // using a comma expression. Possibly change comma expression into statement expression "{}" for multiple
830 // return values.
831 ObjectDecl *newObj = makeTemporary( retType->clone() );
832 Expression *paramExpr = new VariableExpr( newObj );
833
834 // If the type of the temporary is not polymorphic, box temporary by taking its address;
835 // otherwise the temporary is already boxed and can be used directly.
836 if ( ! isPolyType( newObj->get_type(), scopeTyVars, env ) ) {
837 paramExpr = new AddressExpr( paramExpr );
838 } // if
839 arg = appExpr->get_args().insert( arg, paramExpr ); // add argument to function call
840 arg++;
841 // Build a comma expression to call the function and emulate a normal return.
842 CommaExpr *commaExpr = new CommaExpr( appExpr, new VariableExpr( newObj ) );
843 commaExpr->set_env( appExpr->get_env() );
844 appExpr->set_env( 0 );
845 return commaExpr;
846 // } // if
847 // return appExpr;
848 }
849
850 void Pass1::replaceParametersWithConcrete( ApplicationExpr *appExpr, std::list< Expression* >& params ) {
851 for ( std::list< Expression* >::iterator param = params.begin(); param != params.end(); ++param ) {
852 TypeExpr *paramType = dynamic_cast< TypeExpr* >( *param );
853 assert(paramType && "Aggregate parameters should be type expressions");
854 paramType->set_type( replaceWithConcrete( appExpr, paramType->get_type(), false ) );
855 }
856 }
857
858 Type *Pass1::replaceWithConcrete( ApplicationExpr *appExpr, Type *type, bool doClone ) {
859 if ( TypeInstType *typeInst = dynamic_cast< TypeInstType * >( type ) ) {
860 Type *concrete = env->lookup( typeInst->get_name() );
861 if ( concrete == 0 ) {
862 throw SemanticError( "Unbound type variable " + typeInst->get_name() + " in ", appExpr );
863 } // if
864 return concrete;
865 } else if ( StructInstType *structType = dynamic_cast< StructInstType* >( type ) ) {
866 if ( doClone ) {
867 structType = structType->clone();
868 }
869 replaceParametersWithConcrete( appExpr, structType->get_parameters() );
870 return structType;
871 } else if ( UnionInstType *unionType = dynamic_cast< UnionInstType* >( type ) ) {
872 if ( doClone ) {
873 unionType = unionType->clone();
874 }
875 replaceParametersWithConcrete( appExpr, unionType->get_parameters() );
876 return unionType;
877 }
878 return type;
879 }
880
881 Expression *Pass1::addPolyRetParam( ApplicationExpr *appExpr, FunctionType *function, ReferenceToType *polyType, std::list< Expression *>::iterator &arg ) {
882 assert( env );
883 Type *concrete = replaceWithConcrete( appExpr, polyType );
884 // add out-parameter for return value
885 return addRetParam( appExpr, function, concrete, arg );
886 }
887
888 Expression *Pass1::applyAdapter( ApplicationExpr *appExpr, FunctionType *function, std::list< Expression *>::iterator &arg, const TyVarMap &tyVars ) {
889 Expression *ret = appExpr;
890 if ( ! function->get_returnVals().empty() && isPolyType( function->get_returnVals().front()->get_type(), tyVars ) ) {
891 ret = addRetParam( appExpr, function, function->get_returnVals().front()->get_type(), arg );
892 } // if
893 std::string mangleName = mangleAdapterName( function, tyVars );
894 std::string adapterName = makeAdapterName( mangleName );
895
896 // cast adaptee to void (*)(), since it may have any type inside a polymorphic function
897 Type * adapteeType = new PointerType( Type::Qualifiers(), new FunctionType( Type::Qualifiers(), true ) );
898 appExpr->get_args().push_front( new CastExpr( appExpr->get_function(), adapteeType ) );
899 appExpr->set_function( new NameExpr( adapterName ) );
900
901 return ret;
902 }
903
904 void Pass1::boxParam( Type *param, Expression *&arg, const TyVarMap &exprTyVars ) {
905 assert( ! arg->get_results().empty() );
906 if ( isPolyType( param, exprTyVars ) ) {
907 if ( isPolyType( arg->get_results().front() ) ) {
908 // if the argument's type is polymorphic, we don't need to box again!
909 return;
910 } else if ( arg->get_results().front()->get_isLvalue() ) {
911 // VariableExpr and MemberExpr are lvalues; need to check this isn't coming from the second arg of a comma expression though (not an lvalue)
912 if ( CommaExpr *commaArg = dynamic_cast< CommaExpr* >( arg ) ) {
913 commaArg->set_arg2( new AddressExpr( commaArg->get_arg2() ) );
914 } else {
915 arg = new AddressExpr( arg );
916 }
917 } else {
918 // use type computed in unification to declare boxed variables
919 Type * newType = param->clone();
920 if ( env ) env->apply( newType );
921 ObjectDecl *newObj = new ObjectDecl( tempNamer.newName(), DeclarationNode::NoStorageClass, LinkageSpec::C, 0, newType, 0 );
922 newObj->get_type()->get_qualifiers() = Type::Qualifiers(); // TODO: is this right???
923 stmtsToAdd.push_back( new DeclStmt( noLabels, newObj ) );
924 UntypedExpr *assign = new UntypedExpr( new NameExpr( "?=?" ) );
925 assign->get_args().push_back( new VariableExpr( newObj ) );
926 assign->get_args().push_back( arg );
927 stmtsToAdd.push_back( new ExprStmt( noLabels, assign ) );
928 arg = new AddressExpr( new VariableExpr( newObj ) );
929 } // if
930 } // if
931 }
932
933 /// cast parameters to polymorphic functions so that types are replaced with
934 /// void * if they are type parameters in the formal type.
935 /// this gets rid of warnings from gcc.
936 void addCast( Expression *&actual, Type *formal, const TyVarMap &tyVars ) {
937 Type * newType = formal->clone();
938 if ( getFunctionType( newType ) ) {
939 newType = ScrubTyVars::scrub( newType, tyVars );
940 actual = new CastExpr( actual, newType );
941 } // if
942 }
943
944 void Pass1::boxParams( ApplicationExpr *appExpr, FunctionType *function, std::list< Expression *>::iterator &arg, const TyVarMap &exprTyVars ) {
945 for ( std::list< DeclarationWithType *>::const_iterator param = function->get_parameters().begin(); param != function->get_parameters().end(); ++param, ++arg ) {
946 assert( arg != appExpr->get_args().end() );
947 addCast( *arg, (*param)->get_type(), exprTyVars );
948 boxParam( (*param)->get_type(), *arg, exprTyVars );
949 } // for
950 }
951
952 void Pass1::addInferredParams( ApplicationExpr *appExpr, FunctionType *functionType, std::list< Expression *>::iterator &arg, const TyVarMap &tyVars ) {
953 std::list< Expression *>::iterator cur = arg;
954 for ( std::list< TypeDecl *>::iterator tyVar = functionType->get_forall().begin(); tyVar != functionType->get_forall().end(); ++tyVar ) {
955 for ( std::list< DeclarationWithType *>::iterator assert = (*tyVar)->get_assertions().begin(); assert != (*tyVar)->get_assertions().end(); ++assert ) {
956 InferredParams::const_iterator inferParam = appExpr->get_inferParams().find( (*assert)->get_uniqueId() );
957 assert( inferParam != appExpr->get_inferParams().end() && "NOTE: Explicit casts of polymorphic functions to compatible monomorphic functions are currently unsupported" );
958 Expression *newExpr = inferParam->second.expr->clone();
959 addCast( newExpr, (*assert)->get_type(), tyVars );
960 boxParam( (*assert)->get_type(), newExpr, tyVars );
961 appExpr->get_args().insert( cur, newExpr );
962 } // for
963 } // for
964 }
965
966 void makeRetParm( FunctionType *funcType ) {
967 DeclarationWithType *retParm = funcType->get_returnVals().front();
968
969 // make a new parameter that is a pointer to the type of the old return value
970 retParm->set_type( new PointerType( Type::Qualifiers(), retParm->get_type() ) );
971 funcType->get_parameters().push_front( retParm );
972
973 // we don't need the return value any more
974 funcType->get_returnVals().clear();
975 }
976
977 FunctionType *makeAdapterType( FunctionType *adaptee, const TyVarMap &tyVars ) {
978 // actually make the adapter type
979 FunctionType *adapter = adaptee->clone();
980 if ( ! adapter->get_returnVals().empty() && isPolyType( adapter->get_returnVals().front()->get_type(), tyVars ) ) {
981 makeRetParm( adapter );
982 } // if
983 adapter->get_parameters().push_front( new ObjectDecl( "", DeclarationNode::NoStorageClass, LinkageSpec::C, 0, new PointerType( Type::Qualifiers(), new FunctionType( Type::Qualifiers(), true ) ), 0 ) );
984 return adapter;
985 }
986
987 Expression *makeAdapterArg( DeclarationWithType *param, DeclarationWithType *arg, DeclarationWithType *realParam, const TyVarMap &tyVars ) {
988 assert( param );
989 assert( arg );
990 if ( isPolyType( realParam->get_type(), tyVars ) ) {
991 if ( ! isPolyType( arg->get_type() ) ) {
992 UntypedExpr *deref = new UntypedExpr( new NameExpr( "*?" ) );
993 deref->get_args().push_back( new CastExpr( new VariableExpr( param ), new PointerType( Type::Qualifiers(), arg->get_type()->clone() ) ) );
994 deref->get_results().push_back( arg->get_type()->clone() );
995 return deref;
996 } // if
997 } // if
998 return new VariableExpr( param );
999 }
1000
1001 void addAdapterParams( ApplicationExpr *adapteeApp, std::list< DeclarationWithType *>::iterator arg, std::list< DeclarationWithType *>::iterator param, std::list< DeclarationWithType *>::iterator paramEnd, std::list< DeclarationWithType *>::iterator realParam, const TyVarMap &tyVars ) {
1002 UniqueName paramNamer( "_p" );
1003 for ( ; param != paramEnd; ++param, ++arg, ++realParam ) {
1004 if ( (*param)->get_name() == "" ) {
1005 (*param)->set_name( paramNamer.newName() );
1006 (*param)->set_linkage( LinkageSpec::C );
1007 } // if
1008 adapteeApp->get_args().push_back( makeAdapterArg( *param, *arg, *realParam, tyVars ) );
1009 } // for
1010 }
1011
1012 FunctionDecl *Pass1::makeAdapter( FunctionType *adaptee, FunctionType *realType, const std::string &mangleName, const TyVarMap &tyVars ) {
1013 FunctionType *adapterType = makeAdapterType( adaptee, tyVars );
1014 adapterType = ScrubTyVars::scrub( adapterType, tyVars );
1015 DeclarationWithType *adapteeDecl = adapterType->get_parameters().front();
1016 adapteeDecl->set_name( "_adaptee" );
1017 ApplicationExpr *adapteeApp = new ApplicationExpr( new CastExpr( new VariableExpr( adapteeDecl ), new PointerType( Type::Qualifiers(), realType ) ) );
1018 Statement *bodyStmt;
1019
1020 std::list< TypeDecl *>::iterator tyArg = realType->get_forall().begin();
1021 std::list< TypeDecl *>::iterator tyParam = adapterType->get_forall().begin();
1022 std::list< TypeDecl *>::iterator realTyParam = adaptee->get_forall().begin();
1023 for ( ; tyParam != adapterType->get_forall().end(); ++tyArg, ++tyParam, ++realTyParam ) {
1024 assert( tyArg != realType->get_forall().end() );
1025 std::list< DeclarationWithType *>::iterator assertArg = (*tyArg)->get_assertions().begin();
1026 std::list< DeclarationWithType *>::iterator assertParam = (*tyParam)->get_assertions().begin();
1027 std::list< DeclarationWithType *>::iterator realAssertParam = (*realTyParam)->get_assertions().begin();
1028 for ( ; assertParam != (*tyParam)->get_assertions().end(); ++assertArg, ++assertParam, ++realAssertParam ) {
1029 assert( assertArg != (*tyArg)->get_assertions().end() );
1030 adapteeApp->get_args().push_back( makeAdapterArg( *assertParam, *assertArg, *realAssertParam, tyVars ) );
1031 } // for
1032 } // for
1033
1034 std::list< DeclarationWithType *>::iterator arg = realType->get_parameters().begin();
1035 std::list< DeclarationWithType *>::iterator param = adapterType->get_parameters().begin();
1036 std::list< DeclarationWithType *>::iterator realParam = adaptee->get_parameters().begin();
1037 param++; // skip adaptee parameter in the adapter type
1038 if ( realType->get_returnVals().empty() ) {
1039 // void return
1040 addAdapterParams( adapteeApp, arg, param, adapterType->get_parameters().end(), realParam, tyVars );
1041 bodyStmt = new ExprStmt( noLabels, adapteeApp );
1042 } else if ( isPolyType( adaptee->get_returnVals().front()->get_type(), tyVars ) ) {
1043 // return type T
1044 if ( (*param)->get_name() == "" ) {
1045 (*param)->set_name( "_ret" );
1046 (*param)->set_linkage( LinkageSpec::C );
1047 } // if
1048 UntypedExpr *assign = new UntypedExpr( new NameExpr( "?=?" ) );
1049 UntypedExpr *deref = new UntypedExpr( new NameExpr( "*?" ) );
1050 deref->get_args().push_back( new CastExpr( new VariableExpr( *param++ ), new PointerType( Type::Qualifiers(), realType->get_returnVals().front()->get_type()->clone() ) ) );
1051 assign->get_args().push_back( deref );
1052 addAdapterParams( adapteeApp, arg, param, adapterType->get_parameters().end(), realParam, tyVars );
1053 assign->get_args().push_back( adapteeApp );
1054 bodyStmt = new ExprStmt( noLabels, assign );
1055 } else {
1056 // adapter for a function that returns a monomorphic value
1057 addAdapterParams( adapteeApp, arg, param, adapterType->get_parameters().end(), realParam, tyVars );
1058 bodyStmt = new ReturnStmt( noLabels, adapteeApp );
1059 } // if
1060 CompoundStmt *adapterBody = new CompoundStmt( noLabels );
1061 adapterBody->get_kids().push_back( bodyStmt );
1062 std::string adapterName = makeAdapterName( mangleName );
1063 return new FunctionDecl( adapterName, DeclarationNode::NoStorageClass, LinkageSpec::C, adapterType, adapterBody, false, false );
1064 }
1065
1066 void Pass1::passAdapters( ApplicationExpr * appExpr, FunctionType * functionType, const TyVarMap & exprTyVars ) {
1067 // collect a list of function types passed as parameters or implicit parameters (assertions)
1068 std::list< DeclarationWithType *> &paramList = functionType->get_parameters();
1069 std::list< FunctionType *> functions;
1070 for ( std::list< TypeDecl *>::iterator tyVar = functionType->get_forall().begin(); tyVar != functionType->get_forall().end(); ++tyVar ) {
1071 for ( std::list< DeclarationWithType *>::iterator assert = (*tyVar)->get_assertions().begin(); assert != (*tyVar)->get_assertions().end(); ++assert ) {
1072 findFunction( (*assert)->get_type(), functions, exprTyVars, needsAdapter );
1073 } // for
1074 } // for
1075 for ( std::list< DeclarationWithType *>::iterator arg = paramList.begin(); arg != paramList.end(); ++arg ) {
1076 findFunction( (*arg)->get_type(), functions, exprTyVars, needsAdapter );
1077 } // for
1078
1079 // parameter function types for which an appropriate adapter has been generated. we cannot use the types
1080 // after applying substitutions, since two different parameter types may be unified to the same type
1081 std::set< std::string > adaptersDone;
1082
1083 for ( std::list< FunctionType *>::iterator funType = functions.begin(); funType != functions.end(); ++funType ) {
1084 FunctionType *originalFunction = (*funType)->clone();
1085 FunctionType *realFunction = (*funType)->clone();
1086 std::string mangleName = SymTab::Mangler::mangle( realFunction );
1087
1088 // only attempt to create an adapter or pass one as a parameter if we haven't already done so for this
1089 // pre-substitution parameter function type.
1090 if ( adaptersDone.find( mangleName ) == adaptersDone.end() ) {
1091 adaptersDone.insert( adaptersDone.begin(), mangleName );
1092
1093 // apply substitution to type variables to figure out what the adapter's type should look like
1094 assert( env );
1095 env->apply( realFunction );
1096 mangleName = SymTab::Mangler::mangle( realFunction );
1097 mangleName += makePolyMonoSuffix( originalFunction, exprTyVars );
1098
1099 typedef ScopedMap< std::string, DeclarationWithType* >::iterator AdapterIter;
1100 AdapterIter adapter = adapters.find( mangleName );
1101 if ( adapter == adapters.end() ) {
1102 // adapter has not been created yet in the current scope, so define it
1103 FunctionDecl *newAdapter = makeAdapter( *funType, realFunction, mangleName, exprTyVars );
1104 std::pair< AdapterIter, bool > answer = adapters.insert( std::pair< std::string, DeclarationWithType *>( mangleName, newAdapter ) );
1105 adapter = answer.first;
1106 stmtsToAdd.push_back( new DeclStmt( noLabels, newAdapter ) );
1107 } // if
1108 assert( adapter != adapters.end() );
1109
1110 // add the appropriate adapter as a parameter
1111 appExpr->get_args().push_front( new VariableExpr( adapter->second ) );
1112 } // if
1113 } // for
1114 } // passAdapters
1115
1116 Expression *makeIncrDecrExpr( ApplicationExpr *appExpr, Type *polyType, bool isIncr ) {
1117 NameExpr *opExpr;
1118 if ( isIncr ) {
1119 opExpr = new NameExpr( "?+=?" );
1120 } else {
1121 opExpr = new NameExpr( "?-=?" );
1122 } // if
1123 UntypedExpr *addAssign = new UntypedExpr( opExpr );
1124 if ( AddressExpr *address = dynamic_cast< AddressExpr *>( appExpr->get_args().front() ) ) {
1125 addAssign->get_args().push_back( address->get_arg() );
1126 } else {
1127 addAssign->get_args().push_back( appExpr->get_args().front() );
1128 } // if
1129 addAssign->get_args().push_back( new NameExpr( sizeofName( mangleType( polyType ) ) ) );
1130 addAssign->get_results().front() = appExpr->get_results().front()->clone();
1131 if ( appExpr->get_env() ) {
1132 addAssign->set_env( appExpr->get_env() );
1133 appExpr->set_env( 0 );
1134 } // if
1135 appExpr->get_args().clear();
1136 delete appExpr;
1137 return addAssign;
1138 }
1139
1140 Expression *Pass1::handleIntrinsics( ApplicationExpr *appExpr ) {
1141 if ( VariableExpr *varExpr = dynamic_cast< VariableExpr *>( appExpr->get_function() ) ) {
1142 if ( varExpr->get_var()->get_linkage() == LinkageSpec::Intrinsic ) {
1143 if ( varExpr->get_var()->get_name() == "?[?]" ) {
1144 assert( ! appExpr->get_results().empty() );
1145 assert( appExpr->get_args().size() == 2 );
1146 Type *baseType1 = isPolyPtr( appExpr->get_args().front()->get_results().front(), scopeTyVars, env );
1147 Type *baseType2 = isPolyPtr( appExpr->get_args().back()->get_results().front(), scopeTyVars, env );
1148 assert( ! baseType1 || ! baseType2 ); // the arguments cannot both be polymorphic pointers
1149 UntypedExpr *ret = 0;
1150 if ( baseType1 || baseType2 ) { // one of the arguments is a polymorphic pointer
1151 ret = new UntypedExpr( new NameExpr( "?+?" ) );
1152 } // if
1153 if ( baseType1 ) {
1154 UntypedExpr *multiply = new UntypedExpr( new NameExpr( "?*?" ) );
1155 multiply->get_args().push_back( appExpr->get_args().back() );
1156 multiply->get_args().push_back( new SizeofExpr( baseType1->clone() ) );
1157 ret->get_args().push_back( appExpr->get_args().front() );
1158 ret->get_args().push_back( multiply );
1159 } else if ( baseType2 ) {
1160 UntypedExpr *multiply = new UntypedExpr( new NameExpr( "?*?" ) );
1161 multiply->get_args().push_back( appExpr->get_args().front() );
1162 multiply->get_args().push_back( new SizeofExpr( baseType2->clone() ) );
1163 ret->get_args().push_back( multiply );
1164 ret->get_args().push_back( appExpr->get_args().back() );
1165 } // if
1166 if ( baseType1 || baseType2 ) {
1167 ret->get_results().push_front( appExpr->get_results().front()->clone() );
1168 if ( appExpr->get_env() ) {
1169 ret->set_env( appExpr->get_env() );
1170 appExpr->set_env( 0 );
1171 } // if
1172 appExpr->get_args().clear();
1173 delete appExpr;
1174 return ret;
1175 } // if
1176 } else if ( varExpr->get_var()->get_name() == "*?" ) {
1177 assert( ! appExpr->get_results().empty() );
1178 assert( ! appExpr->get_args().empty() );
1179 if ( isPolyType( appExpr->get_results().front(), scopeTyVars, env ) ) {
1180 Expression *ret = appExpr->get_args().front();
1181 delete ret->get_results().front();
1182 ret->get_results().front() = appExpr->get_results().front()->clone();
1183 if ( appExpr->get_env() ) {
1184 ret->set_env( appExpr->get_env() );
1185 appExpr->set_env( 0 );
1186 } // if
1187 appExpr->get_args().clear();
1188 delete appExpr;
1189 return ret;
1190 } // if
1191 } else if ( varExpr->get_var()->get_name() == "?++" || varExpr->get_var()->get_name() == "?--" ) {
1192 assert( ! appExpr->get_results().empty() );
1193 assert( appExpr->get_args().size() == 1 );
1194 if ( Type *baseType = isPolyPtr( appExpr->get_results().front(), scopeTyVars, env ) ) {
1195 Type *tempType = appExpr->get_results().front()->clone();
1196 if ( env ) {
1197 env->apply( tempType );
1198 } // if
1199 ObjectDecl *newObj = makeTemporary( tempType );
1200 VariableExpr *tempExpr = new VariableExpr( newObj );
1201 UntypedExpr *assignExpr = new UntypedExpr( new NameExpr( "?=?" ) );
1202 assignExpr->get_args().push_back( tempExpr->clone() );
1203 if ( AddressExpr *address = dynamic_cast< AddressExpr *>( appExpr->get_args().front() ) ) {
1204 assignExpr->get_args().push_back( address->get_arg()->clone() );
1205 } else {
1206 assignExpr->get_args().push_back( appExpr->get_args().front()->clone() );
1207 } // if
1208 CommaExpr *firstComma = new CommaExpr( assignExpr, makeIncrDecrExpr( appExpr, baseType, varExpr->get_var()->get_name() == "?++" ) );
1209 return new CommaExpr( firstComma, tempExpr );
1210 } // if
1211 } else if ( varExpr->get_var()->get_name() == "++?" || varExpr->get_var()->get_name() == "--?" ) {
1212 assert( ! appExpr->get_results().empty() );
1213 assert( appExpr->get_args().size() == 1 );
1214 if ( Type *baseType = isPolyPtr( appExpr->get_results().front(), scopeTyVars, env ) ) {
1215 return makeIncrDecrExpr( appExpr, baseType, varExpr->get_var()->get_name() == "++?" );
1216 } // if
1217 } else if ( varExpr->get_var()->get_name() == "?+?" || varExpr->get_var()->get_name() == "?-?" ) {
1218 assert( ! appExpr->get_results().empty() );
1219 assert( appExpr->get_args().size() == 2 );
1220 Type *baseType1 = isPolyPtr( appExpr->get_args().front()->get_results().front(), scopeTyVars, env );
1221 Type *baseType2 = isPolyPtr( appExpr->get_args().back()->get_results().front(), scopeTyVars, env );
1222 if ( baseType1 && baseType2 ) {
1223 UntypedExpr *divide = new UntypedExpr( new NameExpr( "?/?" ) );
1224 divide->get_args().push_back( appExpr );
1225 divide->get_args().push_back( new SizeofExpr( baseType1->clone() ) );
1226 divide->get_results().push_front( appExpr->get_results().front()->clone() );
1227 if ( appExpr->get_env() ) {
1228 divide->set_env( appExpr->get_env() );
1229 appExpr->set_env( 0 );
1230 } // if
1231 return divide;
1232 } else if ( baseType1 ) {
1233 UntypedExpr *multiply = new UntypedExpr( new NameExpr( "?*?" ) );
1234 multiply->get_args().push_back( appExpr->get_args().back() );
1235 multiply->get_args().push_back( new SizeofExpr( baseType1->clone() ) );
1236 appExpr->get_args().back() = multiply;
1237 } else if ( baseType2 ) {
1238 UntypedExpr *multiply = new UntypedExpr( new NameExpr( "?*?" ) );
1239 multiply->get_args().push_back( appExpr->get_args().front() );
1240 multiply->get_args().push_back( new SizeofExpr( baseType2->clone() ) );
1241 appExpr->get_args().front() = multiply;
1242 } // if
1243 } else if ( varExpr->get_var()->get_name() == "?+=?" || varExpr->get_var()->get_name() == "?-=?" ) {
1244 assert( ! appExpr->get_results().empty() );
1245 assert( appExpr->get_args().size() == 2 );
1246 Type *baseType = isPolyPtr( appExpr->get_results().front(), scopeTyVars, env );
1247 if ( baseType ) {
1248 UntypedExpr *multiply = new UntypedExpr( new NameExpr( "?*?" ) );
1249 multiply->get_args().push_back( appExpr->get_args().back() );
1250 multiply->get_args().push_back( new SizeofExpr( baseType->clone() ) );
1251 appExpr->get_args().back() = multiply;
1252 } // if
1253 } // if
1254 return appExpr;
1255 } // if
1256 } // if
1257 return 0;
1258 }
1259
1260 Expression *Pass1::mutate( ApplicationExpr *appExpr ) {
1261 // std::cerr << "mutate appExpr: ";
1262 // for ( TyVarMap::iterator i = scopeTyVars.begin(); i != scopeTyVars.end(); ++i ) {
1263 // std::cerr << i->first << " ";
1264 // }
1265 // std::cerr << "\n";
1266 bool oldUseRetval = useRetval;
1267 useRetval = false;
1268 appExpr->get_function()->acceptMutator( *this );
1269 mutateAll( appExpr->get_args(), *this );
1270 useRetval = oldUseRetval;
1271
1272 assert( ! appExpr->get_function()->get_results().empty() );
1273 PointerType *pointer = dynamic_cast< PointerType *>( appExpr->get_function()->get_results().front() );
1274 assert( pointer );
1275 FunctionType *function = dynamic_cast< FunctionType *>( pointer->get_base() );
1276 assert( function );
1277
1278 if ( Expression *newExpr = handleIntrinsics( appExpr ) ) {
1279 return newExpr;
1280 } // if
1281
1282 Expression *ret = appExpr;
1283
1284 std::list< Expression *>::iterator arg = appExpr->get_args().begin();
1285 std::list< Expression *>::iterator paramBegin = appExpr->get_args().begin();
1286
1287 TyVarMap exprTyVars( (TypeDecl::Kind)-1 );
1288 makeTyVarMap( function, exprTyVars );
1289 ReferenceToType *polyRetType = isPolyRet( function );
1290
1291 if ( polyRetType ) {
1292 ret = addPolyRetParam( appExpr, function, polyRetType, arg );
1293 } else if ( needsAdapter( function, scopeTyVars ) ) {
1294 // std::cerr << "needs adapter: ";
1295 // for ( TyVarMap::iterator i = scopeTyVars.begin(); i != scopeTyVars.end(); ++i ) {
1296 // std::cerr << i->first << " ";
1297 // }
1298 // std::cerr << "\n";
1299 // change the application so it calls the adapter rather than the passed function
1300 ret = applyAdapter( appExpr, function, arg, scopeTyVars );
1301 } // if
1302 arg = appExpr->get_args().begin();
1303
1304 passTypeVars( appExpr, polyRetType, arg, exprTyVars );
1305 addInferredParams( appExpr, function, arg, exprTyVars );
1306
1307 arg = paramBegin;
1308
1309 boxParams( appExpr, function, arg, exprTyVars );
1310 passAdapters( appExpr, function, exprTyVars );
1311
1312 return ret;
1313 }
1314
1315 Expression *Pass1::mutate( UntypedExpr *expr ) {
1316 if ( ! expr->get_results().empty() && isPolyType( expr->get_results().front(), scopeTyVars, env ) ) {
1317 if ( NameExpr *name = dynamic_cast< NameExpr *>( expr->get_function() ) ) {
1318 if ( name->get_name() == "*?" ) {
1319 Expression *ret = expr->get_args().front();
1320 expr->get_args().clear();
1321 delete expr;
1322 return ret->acceptMutator( *this );
1323 } // if
1324 } // if
1325 } // if
1326 return PolyMutator::mutate( expr );
1327 }
1328
1329 Expression *Pass1::mutate( AddressExpr *addrExpr ) {
1330 assert( ! addrExpr->get_arg()->get_results().empty() );
1331
1332 bool needs = false;
1333 if ( UntypedExpr *expr = dynamic_cast< UntypedExpr *>( addrExpr->get_arg() ) ) {
1334 if ( ! expr->get_results().empty() && isPolyType( expr->get_results().front(), scopeTyVars, env ) ) {
1335 if ( NameExpr *name = dynamic_cast< NameExpr *>( expr->get_function() ) ) {
1336 if ( name->get_name() == "*?" ) {
1337 if ( ApplicationExpr * appExpr = dynamic_cast< ApplicationExpr * >( expr->get_args().front() ) ) {
1338 assert( ! appExpr->get_function()->get_results().empty() );
1339 PointerType *pointer = dynamic_cast< PointerType *>( appExpr->get_function()->get_results().front() );
1340 assert( pointer );
1341 FunctionType *function = dynamic_cast< FunctionType *>( pointer->get_base() );
1342 assert( function );
1343 needs = needsAdapter( function, scopeTyVars );
1344 } // if
1345 } // if
1346 } // if
1347 } // if
1348 } // if
1349 addrExpr->set_arg( mutateExpression( addrExpr->get_arg() ) );
1350 if ( isPolyType( addrExpr->get_arg()->get_results().front(), scopeTyVars, env ) || needs ) {
1351 Expression *ret = addrExpr->get_arg();
1352 delete ret->get_results().front();
1353 ret->get_results().front() = addrExpr->get_results().front()->clone();
1354 addrExpr->set_arg( 0 );
1355 delete addrExpr;
1356 return ret;
1357 } else {
1358 return addrExpr;
1359 } // if
1360 }
1361
1362 /// Wraps a function declaration in a new pointer-to-function variable expression
1363 VariableExpr *wrapFunctionDecl( DeclarationWithType *functionDecl ) {
1364 // line below cloned from FixFunction.cc
1365 ObjectDecl *functionObj = new ObjectDecl( functionDecl->get_name(), functionDecl->get_storageClass(), functionDecl->get_linkage(), 0,
1366 new PointerType( Type::Qualifiers(), functionDecl->get_type()->clone() ), 0 );
1367 functionObj->set_mangleName( functionDecl->get_mangleName() );
1368 return new VariableExpr( functionObj );
1369 }
1370
1371 Statement * Pass1::mutate( ReturnStmt *returnStmt ) {
1372 if ( retval && returnStmt->get_expr() ) {
1373 assert( ! returnStmt->get_expr()->get_results().empty() );
1374 // ***** Code Removal ***** After introducing a temporary variable for all return expressions, the following code appears superfluous.
1375 // if ( returnStmt->get_expr()->get_results().front()->get_isLvalue() ) {
1376 // by this point, a cast expr on a polymorphic return value is redundant
1377 while ( CastExpr *castExpr = dynamic_cast< CastExpr *>( returnStmt->get_expr() ) ) {
1378 returnStmt->set_expr( castExpr->get_arg() );
1379 returnStmt->get_expr()->set_env( castExpr->get_env() );
1380 castExpr->set_env( 0 );
1381 castExpr->set_arg( 0 );
1382 delete castExpr;
1383 } //while
1384
1385 // find assignment operator for (polymorphic) return type
1386 ApplicationExpr *assignExpr = 0;
1387 if ( TypeInstType *typeInst = dynamic_cast< TypeInstType *>( retval->get_type() ) ) {
1388 // find assignment operator for type variable
1389 ScopedMap< std::string, DeclarationWithType *>::const_iterator assignIter = assignOps.find( typeInst->get_name() );
1390 if ( assignIter == assignOps.end() ) {
1391 throw SemanticError( "Attempt to return dtype or ftype object in ", returnStmt->get_expr() );
1392 } // if
1393 assignExpr = new ApplicationExpr( new VariableExpr( assignIter->second ) );
1394 } else if ( ReferenceToType *refType = dynamic_cast< ReferenceToType *>( retval->get_type() ) ) {
1395 // find assignment operator for generic type
1396 DeclarationWithType *functionDecl = scopedAssignOps.find( refType );
1397 if ( ! functionDecl ) {
1398 throw SemanticError( "Attempt to return dtype or ftype generic object in ", returnStmt->get_expr() );
1399 }
1400
1401 // wrap it up in an application expression
1402 assignExpr = new ApplicationExpr( wrapFunctionDecl( functionDecl ) );
1403 assignExpr->set_env( env->clone() );
1404
1405 // find each of its needed secondary assignment operators
1406 std::list< Expression* > &tyParams = refType->get_parameters();
1407 std::list< TypeDecl* > &forallParams = functionDecl->get_type()->get_forall();
1408 std::list< Expression* >::const_iterator tyIt = tyParams.begin();
1409 std::list< TypeDecl* >::const_iterator forallIt = forallParams.begin();
1410 for ( ; tyIt != tyParams.end() && forallIt != forallParams.end(); ++tyIt, ++forallIt ) {
1411 // Add appropriate mapping to assignment expression environment
1412 TypeExpr *formalTypeExpr = dynamic_cast< TypeExpr* >( *tyIt );
1413 assert( formalTypeExpr && "type parameters must be type expressions" );
1414 Type *formalType = formalTypeExpr->get_type();
1415 assignExpr->get_env()->add( (*forallIt)->get_name(), formalType );
1416
1417 // skip types with no assign op (ftype/dtype)
1418 if ( (*forallIt)->get_kind() != TypeDecl::Any ) continue;
1419
1420 // find assignment operator for formal type
1421 DeclarationWithType *assertAssign = 0;
1422 if ( TypeInstType *formalTypeInstType = dynamic_cast< TypeInstType* >( formalType ) ) {
1423 ScopedMap< std::string, DeclarationWithType *>::const_iterator assertAssignIt = assignOps.find( formalTypeInstType->get_name() );
1424 if ( assertAssignIt == assignOps.end() ) {
1425 throw SemanticError( "No assignment operation found for ", formalTypeInstType );
1426 }
1427 assertAssign = assertAssignIt->second;
1428 } else {
1429 assertAssign = scopedAssignOps.find( formalType );
1430 if ( ! assertAssign ) {
1431 throw SemanticError( "No assignment operation found for ", formalType );
1432 }
1433 }
1434
1435 // add inferred parameter for field assignment operator to assignment expression
1436 std::list< DeclarationWithType* > &asserts = (*forallIt)->get_assertions();
1437 assert( ! asserts.empty() && "Type param needs assignment operator assertion" );
1438 DeclarationWithType *actualDecl = asserts.front();
1439 assignExpr->get_inferParams()[ actualDecl->get_uniqueId() ]
1440 = ParamEntry( assertAssign->get_uniqueId(), assertAssign->get_type()->clone(), actualDecl->get_type()->clone(), wrapFunctionDecl( assertAssign ) );
1441 }
1442 }
1443 assert( assignExpr );
1444
1445 // replace return statement with appropriate assignment to out parameter
1446 Expression *retParm = new NameExpr( retval->get_name() );
1447 retParm->get_results().push_back( new PointerType( Type::Qualifiers(), retval->get_type()->clone() ) );
1448 assignExpr->get_args().push_back( retParm );
1449 assignExpr->get_args().push_back( returnStmt->get_expr() );
1450 stmtsToAdd.push_back( new ExprStmt( noLabels, mutateExpression( assignExpr ) ) );
1451 // } else {
1452 // useRetval = true;
1453 // stmtsToAdd.push_back( new ExprStmt( noLabels, mutateExpression( returnStmt->get_expr() ) ) );
1454 // useRetval = false;
1455 // } // if
1456 returnStmt->set_expr( 0 );
1457 } else {
1458 returnStmt->set_expr( mutateExpression( returnStmt->get_expr() ) );
1459 } // if
1460 return returnStmt;
1461 }
1462
1463 Type * Pass1::mutate( PointerType *pointerType ) {
1464 scopeTyVars.beginScope();
1465 makeTyVarMap( pointerType, scopeTyVars );
1466
1467 Type *ret = Mutator::mutate( pointerType );
1468
1469 scopeTyVars.endScope();
1470 return ret;
1471 }
1472
1473 Type * Pass1::mutate( FunctionType *functionType ) {
1474 scopeTyVars.beginScope();
1475 makeTyVarMap( functionType, scopeTyVars );
1476
1477 Type *ret = Mutator::mutate( functionType );
1478
1479 scopeTyVars.endScope();
1480 return ret;
1481 }
1482
1483 void Pass1::doBeginScope() {
1484 adapters.beginScope();
1485 scopedAssignOps.beginScope();
1486 }
1487
1488 void Pass1::doEndScope() {
1489 adapters.endScope();
1490 scopedAssignOps.endScope();
1491 }
1492
1493////////////////////////////////////////// Pass2 ////////////////////////////////////////////////////
1494
1495 void Pass2::addAdapters( FunctionType *functionType ) {
1496 std::list< DeclarationWithType *> &paramList = functionType->get_parameters();
1497 std::list< FunctionType *> functions;
1498 for ( std::list< DeclarationWithType *>::iterator arg = paramList.begin(); arg != paramList.end(); ++arg ) {
1499 Type *orig = (*arg)->get_type();
1500 findAndReplaceFunction( orig, functions, scopeTyVars, needsAdapter );
1501 (*arg)->set_type( orig );
1502 }
1503 std::set< std::string > adaptersDone;
1504 for ( std::list< FunctionType *>::iterator funType = functions.begin(); funType != functions.end(); ++funType ) {
1505 std::string mangleName = mangleAdapterName( *funType, scopeTyVars );
1506 if ( adaptersDone.find( mangleName ) == adaptersDone.end() ) {
1507 std::string adapterName = makeAdapterName( mangleName );
1508 paramList.push_front( new ObjectDecl( adapterName, DeclarationNode::NoStorageClass, LinkageSpec::C, 0, new PointerType( Type::Qualifiers(), makeAdapterType( *funType, scopeTyVars ) ), 0 ) );
1509 adaptersDone.insert( adaptersDone.begin(), mangleName );
1510 }
1511 }
1512// deleteAll( functions );
1513 }
1514
1515 template< typename DeclClass >
1516 DeclClass * Pass2::handleDecl( DeclClass *decl, Type *type ) {
1517 DeclClass *ret = static_cast< DeclClass *>( Mutator::mutate( decl ) );
1518
1519 return ret;
1520 }
1521
1522 DeclarationWithType * Pass2::mutate( FunctionDecl *functionDecl ) {
1523 return handleDecl( functionDecl, functionDecl->get_functionType() );
1524 }
1525
1526 ObjectDecl * Pass2::mutate( ObjectDecl *objectDecl ) {
1527 return handleDecl( objectDecl, objectDecl->get_type() );
1528 }
1529
1530 TypeDecl * Pass2::mutate( TypeDecl *typeDecl ) {
1531 scopeTyVars[ typeDecl->get_name() ] = typeDecl->get_kind();
1532 if ( typeDecl->get_base() ) {
1533 return handleDecl( typeDecl, typeDecl->get_base() );
1534 } else {
1535 return Mutator::mutate( typeDecl );
1536 }
1537 }
1538
1539 TypedefDecl * Pass2::mutate( TypedefDecl *typedefDecl ) {
1540 return handleDecl( typedefDecl, typedefDecl->get_base() );
1541 }
1542
1543 Type * Pass2::mutate( PointerType *pointerType ) {
1544 scopeTyVars.beginScope();
1545 makeTyVarMap( pointerType, scopeTyVars );
1546
1547 Type *ret = Mutator::mutate( pointerType );
1548
1549 scopeTyVars.endScope();
1550 return ret;
1551 }
1552
1553 Type *Pass2::mutate( FunctionType *funcType ) {
1554 scopeTyVars.beginScope();
1555 makeTyVarMap( funcType, scopeTyVars );
1556
1557 // move polymorphic return type to parameter list
1558 if ( isPolyRet( funcType ) ) {
1559 DeclarationWithType *ret = funcType->get_returnVals().front();
1560 ret->set_type( new PointerType( Type::Qualifiers(), ret->get_type() ) );
1561 funcType->get_parameters().push_front( ret );
1562 funcType->get_returnVals().pop_front();
1563 }
1564
1565 // add size/align and assertions for type parameters to parameter list
1566 std::list< DeclarationWithType *>::iterator last = funcType->get_parameters().begin();
1567 std::list< DeclarationWithType *> inferredParams;
1568 ObjectDecl newObj( "", DeclarationNode::NoStorageClass, LinkageSpec::C, 0, new BasicType( Type::Qualifiers(), BasicType::LongUnsignedInt ), 0 );
1569 ObjectDecl newPtr( "", DeclarationNode::NoStorageClass, LinkageSpec::C, 0,
1570 new PointerType( Type::Qualifiers(), new BasicType( Type::Qualifiers(), BasicType::LongUnsignedInt ) ), 0 );
1571 for ( std::list< TypeDecl *>::const_iterator tyParm = funcType->get_forall().begin(); tyParm != funcType->get_forall().end(); ++tyParm ) {
1572 ObjectDecl *sizeParm, *alignParm;
1573 // add all size and alignment parameters to parameter list
1574 if ( (*tyParm)->get_kind() == TypeDecl::Any ) {
1575 TypeInstType parmType( Type::Qualifiers(), (*tyParm)->get_name(), *tyParm );
1576 std::string parmName = mangleType( &parmType );
1577
1578 sizeParm = newObj.clone();
1579 sizeParm->set_name( sizeofName( parmName ) );
1580 last = funcType->get_parameters().insert( last, sizeParm );
1581 ++last;
1582
1583 alignParm = newObj.clone();
1584 alignParm->set_name( alignofName( parmName ) );
1585 last = funcType->get_parameters().insert( last, alignParm );
1586 ++last;
1587 }
1588 // move all assertions into parameter list
1589 for ( std::list< DeclarationWithType *>::iterator assert = (*tyParm)->get_assertions().begin(); assert != (*tyParm)->get_assertions().end(); ++assert ) {
1590// *assert = (*assert)->acceptMutator( *this );
1591 inferredParams.push_back( *assert );
1592 }
1593 (*tyParm)->get_assertions().clear();
1594 }
1595
1596 // add size/align for generic parameter types to parameter list
1597 std::set< std::string > seenTypes; // sizeofName for generic types we've seen
1598 for ( std::list< DeclarationWithType* >::const_iterator fnParm = last; fnParm != funcType->get_parameters().end(); ++fnParm ) {
1599 Type *polyType = isPolyType( (*fnParm)->get_type(), scopeTyVars );
1600 if ( polyType && ! dynamic_cast< TypeInstType* >( polyType ) ) {
1601 std::string typeName = mangleType( polyType );
1602 if ( seenTypes.count( typeName ) ) continue;
1603
1604 ObjectDecl *sizeParm, *alignParm, *offsetParm;
1605 sizeParm = newObj.clone();
1606 sizeParm->set_name( sizeofName( typeName ) );
1607 last = funcType->get_parameters().insert( last, sizeParm );
1608 ++last;
1609
1610 alignParm = newObj.clone();
1611 alignParm->set_name( alignofName( typeName ) );
1612 last = funcType->get_parameters().insert( last, alignParm );
1613 ++last;
1614
1615 if ( StructInstType *polyBaseStruct = dynamic_cast< StructInstType* >( polyType ) ) {
1616 // NOTE zero-length arrays are illegal in C, so empty structs have no offset array
1617 if ( ! polyBaseStruct->get_baseStruct()->get_members().empty() ) {
1618 offsetParm = newPtr.clone();
1619 offsetParm->set_name( offsetofName( typeName ) );
1620 last = funcType->get_parameters().insert( last, offsetParm );
1621 ++last;
1622 }
1623 }
1624
1625 seenTypes.insert( typeName );
1626 }
1627 }
1628
1629 // splice assertion parameters into parameter list
1630 funcType->get_parameters().splice( last, inferredParams );
1631 addAdapters( funcType );
1632 mutateAll( funcType->get_returnVals(), *this );
1633 mutateAll( funcType->get_parameters(), *this );
1634
1635 scopeTyVars.endScope();
1636 return funcType;
1637 }
1638
1639//////////////////////////////////////// GenericInstantiator //////////////////////////////////////////////////
1640
1641 /// Makes substitutions of params into baseParams; returns true if all parameters substituted for a concrete type
1642 bool makeSubstitutions( const std::list< TypeDecl* >& baseParams, const std::list< Expression* >& params, std::list< TypeExpr* >& out ) {
1643 bool allConcrete = true; // will finish the substitution list even if they're not all concrete
1644
1645 // substitute concrete types for given parameters, and incomplete types for placeholders
1646 std::list< TypeDecl* >::const_iterator baseParam = baseParams.begin();
1647 std::list< Expression* >::const_iterator param = params.begin();
1648 for ( ; baseParam != baseParams.end() && param != params.end(); ++baseParam, ++param ) {
1649 // switch ( (*baseParam)->get_kind() ) {
1650 // case TypeDecl::Any: { // any type is a valid substitution here; complete types can be used to instantiate generics
1651 TypeExpr *paramType = dynamic_cast< TypeExpr* >( *param );
1652 assert(paramType && "Aggregate parameters should be type expressions");
1653 out.push_back( paramType->clone() );
1654 // check that the substituted type isn't a type variable itself
1655 if ( dynamic_cast< TypeInstType* >( paramType->get_type() ) ) {
1656 allConcrete = false;
1657 }
1658 // break;
1659 // }
1660 // case TypeDecl::Dtype: // dtype can be consistently replaced with void [only pointers, which become void*]
1661 // out.push_back( new TypeExpr( new VoidType( Type::Qualifiers() ) ) );
1662 // break;
1663 // case TypeDecl::Ftype: // pointer-to-ftype can be consistently replaced with void (*)(void) [similar to dtype]
1664 // out.push_back( new TypeExpr( new FunctionType( Type::Qualifiers(), false ) ) );
1665 // break;
1666 // }
1667 }
1668
1669 // if any parameters left over, not done
1670 if ( baseParam != baseParams.end() ) return false;
1671 // // if not enough parameters given, substitute remaining incomplete types for placeholders
1672 // for ( ; baseParam != baseParams.end(); ++baseParam ) {
1673 // switch ( (*baseParam)->get_kind() ) {
1674 // case TypeDecl::Any: // no more substitutions here, fail early
1675 // return false;
1676 // case TypeDecl::Dtype: // dtype can be consistently replaced with void [only pointers, which become void*]
1677 // out.push_back( new TypeExpr( new VoidType( Type::Qualifiers() ) ) );
1678 // break;
1679 // case TypeDecl::Ftype: // pointer-to-ftype can be consistently replaced with void (*)(void) [similar to dtype]
1680 // out.push_back( new TypeExpr( new FunctionType( Type::Qualifiers(), false ) ) );
1681 // break;
1682 // }
1683 // }
1684
1685 return allConcrete;
1686 }
1687
1688 /// Substitutes types of members of in according to baseParams => typeSubs, appending the result to out
1689 void substituteMembers( const std::list< Declaration* >& in, const std::list< TypeDecl* >& baseParams, const std::list< TypeExpr* >& typeSubs,
1690 std::list< Declaration* >& out ) {
1691 // substitute types into new members
1692 TypeSubstitution subs( baseParams.begin(), baseParams.end(), typeSubs.begin() );
1693 for ( std::list< Declaration* >::const_iterator member = in.begin(); member != in.end(); ++member ) {
1694 Declaration *newMember = (*member)->clone();
1695 subs.apply(newMember);
1696 out.push_back( newMember );
1697 }
1698 }
1699
1700 Type* GenericInstantiator::mutate( StructInstType *inst ) {
1701 // mutate subtypes
1702 Type *mutated = Mutator::mutate( inst );
1703 inst = dynamic_cast< StructInstType* >( mutated );
1704 if ( ! inst ) return mutated;
1705
1706 // exit early if no need for further mutation
1707 if ( inst->get_parameters().empty() ) return inst;
1708 assert( inst->get_baseParameters() && "Base struct has parameters" );
1709
1710 // check if type can be concretely instantiated; put substitutions into typeSubs
1711 std::list< TypeExpr* > typeSubs;
1712 if ( ! makeSubstitutions( *inst->get_baseParameters(), inst->get_parameters(), typeSubs ) ) {
1713 deleteAll( typeSubs );
1714 return inst;
1715 }
1716
1717 // make concrete instantiation of generic type
1718 StructDecl *concDecl = lookup( inst, typeSubs );
1719 if ( ! concDecl ) {
1720 // set concDecl to new type, insert type declaration into statements to add
1721 concDecl = new StructDecl( typeNamer.newName( inst->get_name() ) );
1722 substituteMembers( inst->get_baseStruct()->get_members(), *inst->get_baseParameters(), typeSubs, concDecl->get_members() );
1723 DeclMutator::addDeclaration( concDecl );
1724 insert( inst, typeSubs, concDecl );
1725 }
1726 StructInstType *newInst = new StructInstType( inst->get_qualifiers(), concDecl->get_name() );
1727 newInst->set_baseStruct( concDecl );
1728
1729 deleteAll( typeSubs );
1730 delete inst;
1731 return newInst;
1732 }
1733
1734 Type* GenericInstantiator::mutate( UnionInstType *inst ) {
1735 // mutate subtypes
1736 Type *mutated = Mutator::mutate( inst );
1737 inst = dynamic_cast< UnionInstType* >( mutated );
1738 if ( ! inst ) return mutated;
1739
1740 // exit early if no need for further mutation
1741 if ( inst->get_parameters().empty() ) return inst;
1742 assert( inst->get_baseParameters() && "Base union has parameters" );
1743
1744 // check if type can be concretely instantiated; put substitutions into typeSubs
1745 std::list< TypeExpr* > typeSubs;
1746 if ( ! makeSubstitutions( *inst->get_baseParameters(), inst->get_parameters(), typeSubs ) ) {
1747 deleteAll( typeSubs );
1748 return inst;
1749 }
1750
1751 // make concrete instantiation of generic type
1752 UnionDecl *concDecl = lookup( inst, typeSubs );
1753 if ( ! concDecl ) {
1754 // set concDecl to new type, insert type declaration into statements to add
1755 concDecl = new UnionDecl( typeNamer.newName( inst->get_name() ) );
1756 substituteMembers( inst->get_baseUnion()->get_members(), *inst->get_baseParameters(), typeSubs, concDecl->get_members() );
1757 DeclMutator::addDeclaration( concDecl );
1758 insert( inst, typeSubs, concDecl );
1759 }
1760 UnionInstType *newInst = new UnionInstType( inst->get_qualifiers(), concDecl->get_name() );
1761 newInst->set_baseUnion( concDecl );
1762
1763 deleteAll( typeSubs );
1764 delete inst;
1765 return newInst;
1766 }
1767
1768 // /// Gets the base struct or union declaration for a member expression; NULL if not applicable
1769 // AggregateDecl* getMemberBaseDecl( MemberExpr *memberExpr ) {
1770 // // get variable for member aggregate
1771 // VariableExpr *varExpr = dynamic_cast< VariableExpr* >( memberExpr->get_aggregate() );
1772 // if ( ! varExpr ) return NULL;
1773 //
1774 // // get object for variable
1775 // ObjectDecl *objectDecl = dynamic_cast< ObjectDecl* >( varExpr->get_var() );
1776 // if ( ! objectDecl ) return NULL;
1777 //
1778 // // get base declaration from object type
1779 // Type *objectType = objectDecl->get_type();
1780 // StructInstType *structType = dynamic_cast< StructInstType* >( objectType );
1781 // if ( structType ) return structType->get_baseStruct();
1782 // UnionInstType *unionType = dynamic_cast< UnionInstType* >( objectType );
1783 // if ( unionType ) return unionType->get_baseUnion();
1784 //
1785 // return NULL;
1786 // }
1787 //
1788 // /// Finds the declaration with the given name, returning decls.end() if none such
1789 // std::list< Declaration* >::const_iterator findDeclNamed( const std::list< Declaration* > &decls, const std::string &name ) {
1790 // for( std::list< Declaration* >::const_iterator decl = decls.begin(); decl != decls.end(); ++decl ) {
1791 // if ( (*decl)->get_name() == name ) return decl;
1792 // }
1793 // return decls.end();
1794 // }
1795 //
1796 // Expression* Instantiate::mutate( MemberExpr *memberExpr ) {
1797 // // mutate, exiting early if no longer MemberExpr
1798 // Expression *expr = Mutator::mutate( memberExpr );
1799 // memberExpr = dynamic_cast< MemberExpr* >( expr );
1800 // if ( ! memberExpr ) return expr;
1801 //
1802 // // get declaration of member and base declaration of member, exiting early if not found
1803 // AggregateDecl *memberBase = getMemberBaseDecl( memberExpr );
1804 // if ( ! memberBase ) return memberExpr;
1805 // DeclarationWithType *memberDecl = memberExpr->get_member();
1806 // std::list< Declaration* >::const_iterator baseIt = findDeclNamed( memberBase->get_members(), memberDecl->get_name() );
1807 // if ( baseIt == memberBase->get_members().end() ) return memberExpr;
1808 // DeclarationWithType *baseDecl = dynamic_cast< DeclarationWithType* >( *baseIt );
1809 // if ( ! baseDecl ) return memberExpr;
1810 //
1811 // // check if stated type of the member is not the type of the member's declaration; if so, need a cast
1812 // // this *SHOULD* be safe, I don't think anything but the void-replacements I put in for dtypes would make it past the typechecker
1813 // SymTab::Indexer dummy;
1814 // if ( ResolvExpr::typesCompatible( memberDecl->get_type(), baseDecl->get_type(), dummy ) ) return memberExpr;
1815 // else return new CastExpr( memberExpr, memberDecl->get_type() );
1816 // }
1817
1818 void GenericInstantiator::doBeginScope() {
1819 DeclMutator::doBeginScope();
1820 instantiations.beginScope();
1821 }
1822
1823 void GenericInstantiator::doEndScope() {
1824 DeclMutator::doEndScope();
1825 instantiations.endScope();
1826 }
1827
1828////////////////////////////////////////// PolyGenericCalculator ////////////////////////////////////////////////////
1829
1830 void PolyGenericCalculator::beginTypeScope( Type *ty ) {
1831 scopeTyVars.beginScope();
1832 makeTyVarMap( ty, scopeTyVars );
1833 }
1834
1835 void PolyGenericCalculator::endTypeScope() {
1836 scopeTyVars.endScope();
1837 }
1838
1839 template< typename DeclClass >
1840 DeclClass * PolyGenericCalculator::handleDecl( DeclClass *decl, Type *type ) {
1841 beginTypeScope( type );
1842 knownLayouts.beginScope();
1843 knownOffsets.beginScope();
1844
1845 DeclClass *ret = static_cast< DeclClass *>( Mutator::mutate( decl ) );
1846
1847 knownOffsets.endScope();
1848 knownLayouts.endScope();
1849 endTypeScope();
1850 return ret;
1851 }
1852
1853 ObjectDecl * PolyGenericCalculator::mutate( ObjectDecl *objectDecl ) {
1854 return handleDecl( objectDecl, objectDecl->get_type() );
1855 }
1856
1857 DeclarationWithType * PolyGenericCalculator::mutate( FunctionDecl *functionDecl ) {
1858 return handleDecl( functionDecl, functionDecl->get_functionType() );
1859 }
1860
1861 TypedefDecl * PolyGenericCalculator::mutate( TypedefDecl *typedefDecl ) {
1862 return handleDecl( typedefDecl, typedefDecl->get_base() );
1863 }
1864
1865 TypeDecl * PolyGenericCalculator::mutate( TypeDecl *typeDecl ) {
1866 scopeTyVars[ typeDecl->get_name() ] = typeDecl->get_kind();
1867 return Mutator::mutate( typeDecl );
1868 }
1869
1870 Type * PolyGenericCalculator::mutate( PointerType *pointerType ) {
1871 beginTypeScope( pointerType );
1872
1873 Type *ret = Mutator::mutate( pointerType );
1874
1875 endTypeScope();
1876 return ret;
1877 }
1878
1879 Type * PolyGenericCalculator::mutate( FunctionType *funcType ) {
1880 beginTypeScope( funcType );
1881
1882 // make sure that any type information passed into the function is accounted for
1883 for ( std::list< DeclarationWithType* >::const_iterator fnParm = funcType->get_parameters().begin(); fnParm != funcType->get_parameters().end(); ++fnParm ) {
1884 // condition here duplicates that in Pass2::mutate( FunctionType* )
1885 Type *polyType = isPolyType( (*fnParm)->get_type(), scopeTyVars );
1886 if ( polyType && ! dynamic_cast< TypeInstType* >( polyType ) ) {
1887 knownLayouts.insert( mangleType( polyType ) );
1888 }
1889 }
1890
1891 Type *ret = Mutator::mutate( funcType );
1892
1893 endTypeScope();
1894 return ret;
1895 }
1896
1897 Statement *PolyGenericCalculator::mutate( DeclStmt *declStmt ) {
1898 if ( ObjectDecl *objectDecl = dynamic_cast< ObjectDecl *>( declStmt->get_decl() ) ) {
1899 if ( findGeneric( objectDecl->get_type() ) ) {
1900 // change initialization of a polymorphic value object
1901 // to allocate storage with alloca
1902 Type *declType = objectDecl->get_type();
1903 UntypedExpr *alloc = new UntypedExpr( new NameExpr( "__builtin_alloca" ) );
1904 alloc->get_args().push_back( new NameExpr( sizeofName( mangleType( declType ) ) ) );
1905
1906 delete objectDecl->get_init();
1907
1908 std::list<Expression*> designators;
1909 objectDecl->set_init( new SingleInit( alloc, designators ) );
1910 }
1911 }
1912 return Mutator::mutate( declStmt );
1913 }
1914
1915 /// Finds the member in the base list that matches the given declaration; returns its index, or -1 if not present
1916 long findMember( DeclarationWithType *memberDecl, std::list< Declaration* > &baseDecls ) {
1917 long i = 0;
1918 for(std::list< Declaration* >::const_iterator decl = baseDecls.begin(); decl != baseDecls.end(); ++decl, ++i ) {
1919 if ( memberDecl->get_name() != (*decl)->get_name() ) continue;
1920
1921 if ( DeclarationWithType *declWithType = dynamic_cast< DeclarationWithType* >( *decl ) ) {
1922 if ( memberDecl->get_mangleName().empty() || declWithType->get_mangleName().empty()
1923 || memberDecl->get_mangleName() == declWithType->get_mangleName() ) return i;
1924 else continue;
1925 } else return i;
1926 }
1927 return -1;
1928 }
1929
1930 /// Returns an index expression into the offset array for a type
1931 Expression *makeOffsetIndex( Type *objectType, long i ) {
1932 std::stringstream offset_namer;
1933 offset_namer << i;
1934 ConstantExpr *fieldIndex = new ConstantExpr( Constant( new BasicType( Type::Qualifiers(), BasicType::LongUnsignedInt ), offset_namer.str() ) );
1935 UntypedExpr *fieldOffset = new UntypedExpr( new NameExpr( "?[?]" ) );
1936 fieldOffset->get_args().push_back( new NameExpr( offsetofName( mangleType( objectType ) ) ) );
1937 fieldOffset->get_args().push_back( fieldIndex );
1938 return fieldOffset;
1939 }
1940
1941 /// Returns an expression dereferenced n times
1942 Expression *makeDerefdVar( Expression *derefdVar, long n ) {
1943 for ( int i = 1; i < n; ++i ) {
1944 UntypedExpr *derefExpr = new UntypedExpr( new NameExpr( "*?" ) );
1945 derefExpr->get_args().push_back( derefdVar );
1946 derefdVar = derefExpr;
1947 }
1948 return derefdVar;
1949 }
1950
1951 Expression *PolyGenericCalculator::mutate( MemberExpr *memberExpr ) {
1952 // mutate, exiting early if no longer MemberExpr
1953 Expression *expr = Mutator::mutate( memberExpr );
1954 memberExpr = dynamic_cast< MemberExpr* >( expr );
1955 if ( ! memberExpr ) return expr;
1956
1957 // get declaration for base struct, exiting early if not found
1958 int varDepth;
1959 VariableExpr *varExpr = getBaseVar( memberExpr->get_aggregate(), &varDepth );
1960 if ( ! varExpr ) return memberExpr;
1961 ObjectDecl *objectDecl = dynamic_cast< ObjectDecl* >( varExpr->get_var() );
1962 if ( ! objectDecl ) return memberExpr;
1963
1964 // only mutate member expressions for polymorphic types
1965 int tyDepth;
1966 Type *objectType = hasPolyBase( objectDecl->get_type(), scopeTyVars, &tyDepth );
1967 if ( ! objectType ) return memberExpr;
1968 findGeneric( objectType ); // ensure layout for this type is available
1969
1970 Expression *newMemberExpr = 0;
1971 if ( StructInstType *structType = dynamic_cast< StructInstType* >( objectType ) ) {
1972 // look up offset index
1973 long i = findMember( memberExpr->get_member(), structType->get_baseStruct()->get_members() );
1974 if ( i == -1 ) return memberExpr;
1975
1976 // replace member expression with pointer to base plus offset
1977 UntypedExpr *fieldLoc = new UntypedExpr( new NameExpr( "?+?" ) );
1978 fieldLoc->get_args().push_back( makeDerefdVar( varExpr->clone(), varDepth ) );
1979 fieldLoc->get_args().push_back( makeOffsetIndex( objectType, i ) );
1980 newMemberExpr = fieldLoc;
1981 } else if ( dynamic_cast< UnionInstType* >( objectType ) ) {
1982 // union members are all at offset zero, so build appropriately-dereferenced variable
1983 newMemberExpr = makeDerefdVar( varExpr->clone(), varDepth );
1984 } else return memberExpr;
1985 assert( newMemberExpr );
1986
1987 Type *memberType = memberExpr->get_member()->get_type();
1988 if ( ! isPolyType( memberType, scopeTyVars ) ) {
1989 // Not all members of a polymorphic type are themselves of polymorphic type; in this case the member expression should be wrapped and dereferenced to form an lvalue
1990 CastExpr *ptrCastExpr = new CastExpr( newMemberExpr, new PointerType( Type::Qualifiers(), memberType->clone() ) );
1991 UntypedExpr *derefExpr = new UntypedExpr( new NameExpr( "*?" ) );
1992 derefExpr->get_args().push_back( ptrCastExpr );
1993 newMemberExpr = derefExpr;
1994 }
1995
1996 delete memberExpr;
1997 return newMemberExpr;
1998 }
1999
2000 ObjectDecl *PolyGenericCalculator::makeVar( const std::string &name, Type *type, Initializer *init ) {
2001 ObjectDecl *newObj = new ObjectDecl( name, DeclarationNode::NoStorageClass, LinkageSpec::C, 0, type, init );
2002 stmtsToAdd.push_back( new DeclStmt( noLabels, newObj ) );
2003 return newObj;
2004 }
2005
2006 void PolyGenericCalculator::addOtypeParamsToLayoutCall( UntypedExpr *layoutCall, const std::list< Type* > &otypeParams ) {
2007 for ( std::list< Type* >::const_iterator param = otypeParams.begin(); param != otypeParams.end(); ++param ) {
2008 if ( findGeneric( *param ) ) {
2009 // push size/align vars for a generic parameter back
2010 std::string paramName = mangleType( *param );
2011 layoutCall->get_args().push_back( new NameExpr( sizeofName( paramName ) ) );
2012 layoutCall->get_args().push_back( new NameExpr( alignofName( paramName ) ) );
2013 } else {
2014 layoutCall->get_args().push_back( new SizeofExpr( (*param)->clone() ) );
2015 layoutCall->get_args().push_back( new AlignofExpr( (*param)->clone() ) );
2016 }
2017 }
2018 }
2019
2020 /// returns true if any of the otype parameters have a dynamic layout and puts all otype parameters in the output list
2021 bool findGenericParams( std::list< TypeDecl* > &baseParams, std::list< Expression* > &typeParams, std::list< Type* > &out ) {
2022 bool hasDynamicLayout = false;
2023
2024 std::list< TypeDecl* >::const_iterator baseParam = baseParams.begin();
2025 std::list< Expression* >::const_iterator typeParam = typeParams.begin();
2026 for ( ; baseParam != baseParams.end() && typeParam != typeParams.end(); ++baseParam, ++typeParam ) {
2027 // skip non-otype parameters
2028 if ( (*baseParam)->get_kind() != TypeDecl::Any ) continue;
2029 TypeExpr *typeExpr = dynamic_cast< TypeExpr* >( *typeParam );
2030 assert( typeExpr && "all otype parameters should be type expressions" );
2031
2032 Type *type = typeExpr->get_type();
2033 out.push_back( type );
2034 if ( isPolyType( type ) ) hasDynamicLayout = true;
2035 }
2036 assert( baseParam == baseParams.end() && typeParam == typeParams.end() );
2037
2038 return hasDynamicLayout;
2039 }
2040
2041 bool PolyGenericCalculator::findGeneric( Type *ty ) {
2042 if ( TypeInstType *typeInst = dynamic_cast< TypeInstType* >( ty ) ) {
2043 // duplicate logic from isPolyType()
2044 if ( env ) {
2045 if ( Type *newType = env->lookup( typeInst->get_name() ) ) {
2046 return findGeneric( newType );
2047 } // if
2048 } // if
2049 if ( scopeTyVars.find( typeInst->get_name() ) != scopeTyVars.end() ) {
2050 // NOTE assumes here that getting put in the scopeTyVars included having the layout variables set
2051 return true;
2052 }
2053 return false;
2054 } else if ( StructInstType *structTy = dynamic_cast< StructInstType* >( ty ) ) {
2055 // check if this type already has a layout generated for it
2056 std::string typeName = mangleType( ty );
2057 if ( knownLayouts.find( typeName ) != knownLayouts.end() ) return true;
2058
2059 // check if any of the type parameters have dynamic layout; if none do, this type is (or will be) monomorphized
2060 std::list< Type* > otypeParams;
2061 if ( ! findGenericParams( *structTy->get_baseParameters(), structTy->get_parameters(), otypeParams ) ) return false;
2062
2063 // insert local variables for layout and generate call to layout function
2064 knownLayouts.insert( typeName ); // done early so as not to interfere with the later addition of parameters to the layout call
2065 Type *layoutType = new BasicType( Type::Qualifiers(), BasicType::LongUnsignedInt );
2066
2067 int n_members = structTy->get_baseStruct()->get_members().size();
2068 if ( n_members == 0 ) {
2069 // all empty structs have the same layout - size 1, align 1
2070 makeVar( sizeofName( typeName ), layoutType, new SingleInit( new ConstantExpr( Constant::from_ulong( (unsigned long)1 ) ) ) );
2071 makeVar( alignofName( typeName ), layoutType->clone(), new SingleInit( new ConstantExpr( Constant::from_ulong( (unsigned long)1 ) ) ) );
2072 // NOTE zero-length arrays are forbidden in C, so empty structs have no offsetof array
2073 } else {
2074 ObjectDecl *sizeVar = makeVar( sizeofName( typeName ), layoutType );
2075 ObjectDecl *alignVar = makeVar( alignofName( typeName ), layoutType->clone() );
2076 ObjectDecl *offsetVar = makeVar( offsetofName( typeName ), new ArrayType( Type::Qualifiers(), layoutType->clone(), new ConstantExpr( Constant::from_int( n_members ) ), false, false ) );
2077
2078 // generate call to layout function
2079 UntypedExpr *layoutCall = new UntypedExpr( new NameExpr( layoutofName( structTy->get_baseStruct() ) ) );
2080 layoutCall->get_args().push_back( new AddressExpr( new VariableExpr( sizeVar ) ) );
2081 layoutCall->get_args().push_back( new AddressExpr( new VariableExpr( alignVar ) ) );
2082 layoutCall->get_args().push_back( new VariableExpr( offsetVar ) );
2083 addOtypeParamsToLayoutCall( layoutCall, otypeParams );
2084
2085 stmtsToAdd.push_back( new ExprStmt( noLabels, layoutCall ) );
2086 }
2087
2088 return true;
2089 } else if ( UnionInstType *unionTy = dynamic_cast< UnionInstType* >( ty ) ) {
2090 // check if this type already has a layout generated for it
2091 std::string typeName = mangleType( ty );
2092 if ( knownLayouts.find( typeName ) != knownLayouts.end() ) return true;
2093
2094 // check if any of the type parameters have dynamic layout; if none do, this type is (or will be) monomorphized
2095 std::list< Type* > otypeParams;
2096 if ( ! findGenericParams( *unionTy->get_baseParameters(), unionTy->get_parameters(), otypeParams ) ) return false;
2097
2098 // insert local variables for layout and generate call to layout function
2099 knownLayouts.insert( typeName ); // done early so as not to interfere with the later addition of parameters to the layout call
2100 Type *layoutType = new BasicType( Type::Qualifiers(), BasicType::LongUnsignedInt );
2101
2102 ObjectDecl *sizeVar = makeVar( sizeofName( typeName ), layoutType );
2103 ObjectDecl *alignVar = makeVar( alignofName( typeName ), layoutType->clone() );
2104
2105 // generate call to layout function
2106 UntypedExpr *layoutCall = new UntypedExpr( new NameExpr( layoutofName( unionTy->get_baseUnion() ) ) );
2107 layoutCall->get_args().push_back( new AddressExpr( new VariableExpr( sizeVar ) ) );
2108 layoutCall->get_args().push_back( new AddressExpr( new VariableExpr( alignVar ) ) );
2109 addOtypeParamsToLayoutCall( layoutCall, otypeParams );
2110
2111 stmtsToAdd.push_back( new ExprStmt( noLabels, layoutCall ) );
2112
2113 return true;
2114 }
2115
2116 return false;
2117 }
2118
2119 Expression *PolyGenericCalculator::mutate( SizeofExpr *sizeofExpr ) {
2120 Type *ty = sizeofExpr->get_type();
2121 if ( findGeneric( ty ) ) {
2122 Expression *ret = new NameExpr( sizeofName( mangleType( ty ) ) );
2123 delete sizeofExpr;
2124 return ret;
2125 }
2126 return sizeofExpr;
2127 }
2128
2129 Expression *PolyGenericCalculator::mutate( AlignofExpr *alignofExpr ) {
2130 Type *ty = alignofExpr->get_type();
2131 if ( findGeneric( ty ) ) {
2132 Expression *ret = new NameExpr( alignofName( mangleType( ty ) ) );
2133 delete alignofExpr;
2134 return ret;
2135 }
2136 return alignofExpr;
2137 }
2138
2139 Expression *PolyGenericCalculator::mutate( OffsetofExpr *offsetofExpr ) {
2140 // mutate, exiting early if no longer OffsetofExpr
2141 Expression *expr = Mutator::mutate( offsetofExpr );
2142 offsetofExpr = dynamic_cast< OffsetofExpr* >( expr );
2143 if ( ! offsetofExpr ) return expr;
2144
2145 // only mutate expressions for polymorphic structs/unions
2146 Type *ty = offsetofExpr->get_type();
2147 if ( ! findGeneric( ty ) ) return offsetofExpr;
2148
2149 if ( StructInstType *structType = dynamic_cast< StructInstType* >( ty ) ) {
2150 // replace offsetof expression by index into offset array
2151 long i = findMember( offsetofExpr->get_member(), structType->get_baseStruct()->get_members() );
2152 if ( i == -1 ) return offsetofExpr;
2153
2154 Expression *offsetInd = makeOffsetIndex( ty, i );
2155 delete offsetofExpr;
2156 return offsetInd;
2157 } else if ( dynamic_cast< UnionInstType* >( ty ) ) {
2158 // all union members are at offset zero
2159 delete offsetofExpr;
2160 return new ConstantExpr( Constant( new BasicType( Type::Qualifiers(), BasicType::LongUnsignedInt ), std::string("0") ) );
2161 } else return offsetofExpr;
2162 }
2163
2164 Expression *PolyGenericCalculator::mutate( OffsetPackExpr *offsetPackExpr ) {
2165 StructInstType *ty = offsetPackExpr->get_type();
2166
2167 Expression *ret = 0;
2168 if ( findGeneric( ty ) ) {
2169 // pull offset back from generated type information
2170 ret = new NameExpr( offsetofName( mangleType( ty ) ) );
2171 } else {
2172 std::string offsetName = offsetofName( mangleType( ty ) );
2173 if ( knownOffsets.find( offsetName ) != knownOffsets.end() ) {
2174 // use the already-generated offsets for this type
2175 ret = new NameExpr( offsetName );
2176 } else {
2177 knownOffsets.insert( offsetName );
2178
2179 std::list< Declaration* > &baseMembers = ty->get_baseStruct()->get_members();
2180 Type *offsetType = new BasicType( Type::Qualifiers(), BasicType::LongUnsignedInt );
2181
2182 // build initializer list for offset array
2183 std::list< Initializer* > inits;
2184 for ( std::list< Declaration* >::const_iterator member = baseMembers.begin(); member != baseMembers.end(); ++member ) {
2185 DeclarationWithType *memberDecl;
2186 if ( DeclarationWithType *origMember = dynamic_cast< DeclarationWithType* >( *member ) ) {
2187 memberDecl = origMember->clone();
2188 } else {
2189 memberDecl = new ObjectDecl( (*member)->get_name(), DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, offsetType->clone(), 0 );
2190 }
2191 inits.push_back( new SingleInit( new OffsetofExpr( ty->clone(), memberDecl ) ) );
2192 }
2193
2194 // build the offset array and replace the pack with a reference to it
2195 ObjectDecl *offsetArray = makeVar( offsetName, new ArrayType( Type::Qualifiers(), offsetType, new ConstantExpr( Constant::from_ulong( baseMembers.size() ) ), false, false ),
2196 new ListInit( inits ) );
2197 ret = new VariableExpr( offsetArray );
2198 }
2199 }
2200
2201 delete offsetPackExpr;
2202 return ret;
2203 }
2204
2205 void PolyGenericCalculator::doBeginScope() {
2206 knownLayouts.beginScope();
2207 knownOffsets.beginScope();
2208 }
2209
2210 void PolyGenericCalculator::doEndScope() {
2211 knownLayouts.endScope();
2212 knownOffsets.endScope();
2213 }
2214
2215////////////////////////////////////////// Pass3 ////////////////////////////////////////////////////
2216
2217 template< typename DeclClass >
2218 DeclClass * Pass3::handleDecl( DeclClass *decl, Type *type ) {
2219 scopeTyVars.beginScope();
2220 makeTyVarMap( type, scopeTyVars );
2221
2222 DeclClass *ret = static_cast< DeclClass *>( Mutator::mutate( decl ) );
2223 ScrubTyVars::scrub( decl, scopeTyVars );
2224
2225 scopeTyVars.endScope();
2226 return ret;
2227 }
2228
2229 ObjectDecl * Pass3::mutate( ObjectDecl *objectDecl ) {
2230 return handleDecl( objectDecl, objectDecl->get_type() );
2231 }
2232
2233 DeclarationWithType * Pass3::mutate( FunctionDecl *functionDecl ) {
2234 return handleDecl( functionDecl, functionDecl->get_functionType() );
2235 }
2236
2237 TypedefDecl * Pass3::mutate( TypedefDecl *typedefDecl ) {
2238 return handleDecl( typedefDecl, typedefDecl->get_base() );
2239 }
2240
2241 TypeDecl * Pass3::mutate( TypeDecl *typeDecl ) {
2242// Initializer *init = 0;
2243// std::list< Expression *> designators;
2244// scopeTyVars[ typeDecl->get_name() ] = typeDecl->get_kind();
2245// if ( typeDecl->get_base() ) {
2246// init = new SimpleInit( new SizeofExpr( handleDecl( typeDecl, typeDecl->get_base() ) ), designators );
2247// }
2248// return new ObjectDecl( typeDecl->get_name(), Declaration::Extern, LinkageSpec::C, 0, new BasicType( Type::Qualifiers(), BasicType::UnsignedInt ), init );
2249
2250 scopeTyVars[ typeDecl->get_name() ] = typeDecl->get_kind();
2251 return Mutator::mutate( typeDecl );
2252 }
2253
2254 Type * Pass3::mutate( PointerType *pointerType ) {
2255 scopeTyVars.beginScope();
2256 makeTyVarMap( pointerType, scopeTyVars );
2257
2258 Type *ret = Mutator::mutate( pointerType );
2259
2260 scopeTyVars.endScope();
2261 return ret;
2262 }
2263
2264 Type * Pass3::mutate( FunctionType *functionType ) {
2265 scopeTyVars.beginScope();
2266 makeTyVarMap( functionType, scopeTyVars );
2267
2268 Type *ret = Mutator::mutate( functionType );
2269
2270 scopeTyVars.endScope();
2271 return ret;
2272 }
2273 } // anonymous namespace
2274} // namespace GenPoly
2275
2276// Local Variables: //
2277// tab-width: 4 //
2278// mode: c++ //
2279// compile-command: "make install" //
2280// End: //
Note: See TracBrowser for help on using the repository browser.