source: src/GenPoly/Box.cc @ 6635c74

ADTaaron-thesisarm-ehast-experimentalcleanup-dtorsctordeferred_resndemanglerenumforall-pointer-decaygc_noraiijacob/cs343-translationjenkins-sandboxmemorynew-astnew-ast-unique-exprnew-envno_listpersistent-indexerpthread-emulationqualifiedEnumresolv-newstringwith_gc
Last change on this file since 6635c74 was 6635c74, checked in by Aaron Moss <a3moss@…>, 8 years ago

Switched GenPoly::Pass1.adapters over to non-copying ScopedMap? from copying stack of std::map

  • Property mode set to 100644
File size: 79.2 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 : Peter A. Buhr
12// Last Modified On : Fri Feb  5 16:45:07 2016
13// Update Count     : 286
14//
15
16#include <set>
17#include <stack>
18#include <string>
19#include <iterator>
20#include <algorithm>
21#include <cassert>
22
23#include "Box.h"
24#include "DeclMutator.h"
25#include "InstantiateGeneric.h"
26#include "PolyMutator.h"
27#include "FindFunction.h"
28#include "ScopedMap.h"
29#include "ScrubTyVars.h"
30
31#include "Parser/ParseNode.h"
32
33#include "SynTree/Constant.h"
34#include "SynTree/Type.h"
35#include "SynTree/Expression.h"
36#include "SynTree/Initializer.h"
37#include "SynTree/Statement.h"
38#include "SynTree/Mutator.h"
39
40#include "ResolvExpr/TypeEnvironment.h"
41#include "ResolvExpr/TypeMap.h"
42#include "ResolvExpr/typeops.h"
43
44#include "SymTab/Mangler.h"
45
46#include "Common/SemanticError.h"
47#include "Common/UniqueName.h"
48#include "Common/utility.h"
49
50#include <ext/functional> // temporary
51
52namespace GenPoly {
53        namespace {
54                const std::list<Label> noLabels;
55
56                FunctionType *makeAdapterType( FunctionType *adaptee, const TyVarMap &tyVars );
57
58                /// Adds layout-generation functions to polymorphic types
59                class LayoutFunctionBuilder : public DeclMutator {
60                        unsigned int functionNesting;  // current level of nested functions
61                public:
62                        LayoutFunctionBuilder() : functionNesting( 0 ) {}
63
64                        virtual DeclarationWithType *mutate( FunctionDecl *functionDecl );
65                        virtual Declaration *mutate( StructDecl *structDecl );
66                        virtual Declaration *mutate( UnionDecl *unionDecl );
67                };
68               
69                /// 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
70                class Pass1 : public PolyMutator {
71                  public:
72                        Pass1();
73                        virtual Expression *mutate( ApplicationExpr *appExpr );
74                        virtual Expression *mutate( AddressExpr *addrExpr );
75                        virtual Expression *mutate( UntypedExpr *expr );
76                        virtual DeclarationWithType* mutate( FunctionDecl *functionDecl );
77                        virtual TypeDecl *mutate( TypeDecl *typeDecl );
78                        virtual Expression *mutate( CommaExpr *commaExpr );
79                        virtual Expression *mutate( ConditionalExpr *condExpr );
80                        virtual Statement * mutate( ReturnStmt *returnStmt );
81                        virtual Type *mutate( PointerType *pointerType );
82                        virtual Type * mutate( FunctionType *functionType );
83
84                        virtual void doBeginScope();
85                        virtual void doEndScope();
86                  private:
87                        /// Makes a new temporary array holding the offsets of the fields of `type`, and returns a new variable expression referencing it
88                        Expression *makeOffsetArray( StructInstType *type );
89                        /// Pass the extra type parameters from polymorphic generic arguments or return types into a function application
90                        void passArgTypeVars( ApplicationExpr *appExpr, Type *parmType, Type *argBaseType, std::list< Expression *>::iterator &arg, const TyVarMap &exprTyVars, std::set< std::string > &seenTypes );
91                        /// passes extra type parameters into a polymorphic function application
92                        void passTypeVars( ApplicationExpr *appExpr, ReferenceToType *polyRetType, std::list< Expression *>::iterator &arg, const TyVarMap &exprTyVars );
93                        /// wraps a function application with a new temporary for the out-parameter return value
94                        Expression *addRetParam( ApplicationExpr *appExpr, FunctionType *function, Type *retType, std::list< Expression *>::iterator &arg );
95                        /// Replaces all the type parameters of a generic type with their concrete equivalents under the current environment
96                        void replaceParametersWithConcrete( ApplicationExpr *appExpr, std::list< Expression* >& params );
97                        /// Replaces a polymorphic type with its concrete equivalant under the current environment (returns itself if concrete).
98                        /// If `doClone` is set to false, will not clone interior types
99                        Type *replaceWithConcrete( ApplicationExpr *appExpr, Type *type, bool doClone = true );
100                        /// wraps a function application returning a polymorphic type with a new temporary for the out-parameter return value
101                        Expression *addPolyRetParam( ApplicationExpr *appExpr, FunctionType *function, ReferenceToType *polyType, std::list< Expression *>::iterator &arg );
102                        Expression *applyAdapter( ApplicationExpr *appExpr, FunctionType *function, std::list< Expression *>::iterator &arg, const TyVarMap &exprTyVars );
103                        void boxParam( Type *formal, Expression *&arg, const TyVarMap &exprTyVars );
104                        void boxParams( ApplicationExpr *appExpr, FunctionType *function, std::list< Expression *>::iterator &arg, const TyVarMap &exprTyVars );
105                        void addInferredParams( ApplicationExpr *appExpr, FunctionType *functionType, std::list< Expression *>::iterator &arg, const TyVarMap &tyVars );
106                        /// Stores assignment operators from assertion list in local map of assignment operations
107                        void findAssignOps( const std::list< TypeDecl *> &forall );
108                        void passAdapters( ApplicationExpr *appExpr, FunctionType *functionType, const TyVarMap &exprTyVars );
109                        FunctionDecl *makeAdapter( FunctionType *adaptee, FunctionType *realType, const std::string &mangleName, const TyVarMap &tyVars );
110                        /// Replaces intrinsic operator functions with their arithmetic desugaring
111                        Expression *handleIntrinsics( ApplicationExpr *appExpr );
112                        /// Inserts a new temporary variable into the current scope with an auto-generated name
113                        ObjectDecl *makeTemporary( Type *type );
114
115                        std::map< std::string, DeclarationWithType *> assignOps;
116                        ResolvExpr::TypeMap< DeclarationWithType > scopedAssignOps;
117                        ScopedMap< std::string, DeclarationWithType* > adapters;
118                        DeclarationWithType *retval;
119                        bool useRetval;
120                        UniqueName tempNamer;
121                };
122
123                /// Moves polymorphic returns in function types to pointer-type parameters, adds type size and assertion parameters to parameter lists as well
124                class Pass2 : public PolyMutator {
125                  public:
126                        template< typename DeclClass >
127                        DeclClass *handleDecl( DeclClass *decl, Type *type );
128                        virtual DeclarationWithType *mutate( FunctionDecl *functionDecl );
129                        virtual ObjectDecl *mutate( ObjectDecl *objectDecl );
130                        virtual TypeDecl *mutate( TypeDecl *typeDecl );
131                        virtual TypedefDecl *mutate( TypedefDecl *typedefDecl );
132                        virtual Type *mutate( PointerType *pointerType );
133                        virtual Type *mutate( FunctionType *funcType );
134                  private:
135                        void addAdapters( FunctionType *functionType );
136
137                        std::map< UniqueId, std::string > adapterName;
138                };
139
140                /// Replaces member expressions for polymorphic types with calculated add-field-offset-and-dereference;
141                /// also fixes offsetof expressions.
142                class MemberExprFixer : public PolyMutator {
143                  public:
144                        template< typename DeclClass >
145                        DeclClass *handleDecl( DeclClass *decl, Type *type );
146                        virtual DeclarationWithType *mutate( FunctionDecl *functionDecl );
147                        virtual ObjectDecl *mutate( ObjectDecl *objectDecl );
148                        virtual TypedefDecl *mutate( TypedefDecl *objectDecl );
149                        virtual TypeDecl *mutate( TypeDecl *objectDecl );
150                        virtual Statement *mutate( DeclStmt *declStmt );
151                        virtual Type *mutate( PointerType *pointerType );
152                        virtual Type *mutate( FunctionType *funcType );
153                        virtual Expression *mutate( MemberExpr *memberExpr );
154                        virtual Expression *mutate( OffsetofExpr *offsetofExpr );
155                };
156
157                /// 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
158                class Pass3 : public PolyMutator {
159                  public:
160                        template< typename DeclClass >
161                        DeclClass *handleDecl( DeclClass *decl, Type *type );
162                        virtual DeclarationWithType *mutate( FunctionDecl *functionDecl );
163                        virtual ObjectDecl *mutate( ObjectDecl *objectDecl );
164                        virtual TypedefDecl *mutate( TypedefDecl *objectDecl );
165                        virtual TypeDecl *mutate( TypeDecl *objectDecl );
166                        virtual Type *mutate( PointerType *pointerType );
167                        virtual Type *mutate( FunctionType *funcType );
168                  private:
169                };
170
171        } // anonymous namespace
172
173        /// version of mutateAll with special handling for translation unit so you can check the end of the prelude when debugging
174        template< typename MutatorType >
175        inline void mutateTranslationUnit( std::list< Declaration* > &translationUnit, MutatorType &mutator ) {
176                bool seenIntrinsic = false;
177                SemanticError errors;
178                for ( typename std::list< Declaration* >::iterator i = translationUnit.begin(); i != translationUnit.end(); ++i ) {
179                        try {
180                                if ( *i ) {
181                                        if ( (*i)->get_linkage() == LinkageSpec::Intrinsic ) {
182                                                seenIntrinsic = true;
183                                        } else if ( seenIntrinsic ) {
184                                                seenIntrinsic = false; // break on this line when debugging for end of prelude
185                                        }
186
187                                        *i = dynamic_cast< Declaration* >( (*i)->acceptMutator( mutator ) );
188                                        assert( *i );
189                                } // if
190                        } catch( SemanticError &e ) {
191                                errors.append( e );
192                        } // try
193                } // for
194                if ( ! errors.isEmpty() ) {
195                        throw errors;
196                } // if
197        }
198
199        void box( std::list< Declaration *>& translationUnit ) {
200                LayoutFunctionBuilder layoutBuilder;
201                Pass1 pass1;
202                Pass2 pass2;
203                MemberExprFixer memberFixer;
204                Pass3 pass3;
205                layoutBuilder.mutateDeclarationList( translationUnit );
206                mutateTranslationUnit/*All*/( translationUnit, pass1 );
207                mutateTranslationUnit/*All*/( translationUnit, pass2 );
208                instantiateGeneric( translationUnit );
209                mutateTranslationUnit/*All*/( translationUnit, memberFixer );
210                mutateTranslationUnit/*All*/( translationUnit, pass3 );
211        }
212
213        ////////////////////////////////// LayoutFunctionBuilder ////////////////////////////////////////////
214
215        DeclarationWithType *LayoutFunctionBuilder::mutate( FunctionDecl *functionDecl ) {
216                functionDecl->set_functionType( maybeMutate( functionDecl->get_functionType(), *this ) );
217                mutateAll( functionDecl->get_oldDecls(), *this );
218                ++functionNesting;
219                functionDecl->set_statements( maybeMutate( functionDecl->get_statements(), *this ) );
220                --functionNesting;
221                return functionDecl;
222        }
223       
224        /// Get a list of type declarations that will affect a layout function
225        std::list< TypeDecl* > takeOtypeOnly( std::list< TypeDecl* > &decls ) {
226                std::list< TypeDecl * > otypeDecls;
227
228                for ( std::list< TypeDecl* >::const_iterator decl = decls.begin(); decl != decls.end(); ++decl ) {
229                        if ( (*decl)->get_kind() == TypeDecl::Any ) {
230                                otypeDecls.push_back( *decl );
231                        }
232                }
233               
234                return otypeDecls;
235        }
236
237        /// Adds parameters for otype layout to a function type
238        void addOtypeParams( FunctionType *layoutFnType, std::list< TypeDecl* > &otypeParams ) {
239                BasicType sizeAlignType( Type::Qualifiers(), BasicType::LongUnsignedInt );
240               
241                for ( std::list< TypeDecl* >::const_iterator param = otypeParams.begin(); param != otypeParams.end(); ++param ) {
242                        TypeInstType paramType( Type::Qualifiers(), (*param)->get_name(), *param );
243                        layoutFnType->get_parameters().push_back( new ObjectDecl( sizeofName( &paramType ), DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, sizeAlignType.clone(), 0 ) );
244                        layoutFnType->get_parameters().push_back( new ObjectDecl( alignofName( &paramType ), DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, sizeAlignType.clone(), 0 ) );
245                }
246        }
247
248        /// Builds a layout function declaration
249        FunctionDecl *buildLayoutFunctionDecl( const std::string &typeName, unsigned int functionNesting, FunctionType *layoutFnType ) {
250                // Routines at global scope marked "static" to prevent multiple definitions is separate translation units
251                // because each unit generates copies of the default routines for each aggregate.
252                FunctionDecl *layoutDecl = new FunctionDecl(
253                        "__layoutof_" + typeName, functionNesting > 0 ? DeclarationNode::NoStorageClass : DeclarationNode::Static, LinkageSpec::AutoGen, layoutFnType, new CompoundStmt( noLabels ), true, false );
254                layoutDecl->fixUniqueId();
255                return layoutDecl;
256        }
257
258        /// Makes a unary operation
259        Expression *makeOp( const std::string &name, Expression *arg ) {
260                UntypedExpr *expr = new UntypedExpr( new NameExpr( name ) );
261                expr->get_args().push_back( arg );
262                return expr;
263        }
264
265        /// Makes a binary operation
266        Expression *makeOp( const std::string &name, Expression *lhs, Expression *rhs ) {
267                UntypedExpr *expr = new UntypedExpr( new NameExpr( name ) );
268                expr->get_args().push_back( lhs );
269                expr->get_args().push_back( rhs );
270                return expr;
271        }
272
273        /// Returns the dereference of a local pointer variable
274        Expression *derefVar( ObjectDecl *var ) {
275                return makeOp( "*?", new VariableExpr( var ) );
276        }
277
278        /// makes an if-statement with a single-expression if-block and no then block
279        Statement *makeCond( Expression *cond, Expression *ifPart ) {
280                return new IfStmt( noLabels, cond, new ExprStmt( noLabels, ifPart ), 0 );
281        }
282
283        /// makes a statement that assigns rhs to lhs if lhs < rhs
284        Statement *makeAssignMax( Expression *lhs, Expression *rhs ) {
285                return makeCond( makeOp( "?<?", lhs, rhs ), makeOp( "?=?", lhs->clone(), rhs->clone() ) );
286        }
287
288        /// makes a statement that aligns lhs to rhs (rhs should be an integer power of two)
289        Statement *makeAlignTo( Expression *lhs, Expression *rhs ) {
290                // check that the lhs is zeroed out to the level of rhs
291                Expression *ifCond = makeOp( "?&?", lhs, makeOp( "?-?", rhs, new ConstantExpr( Constant( new BasicType( Type::Qualifiers(), BasicType::LongUnsignedInt ), "1" ) ) ) );
292                // if not aligned, increment to alignment
293                Expression *ifExpr = makeOp( "?+=?", lhs->clone(), makeOp( "?-?", rhs->clone(), ifCond->clone() ) );
294                return makeCond( ifCond, ifExpr );
295        }
296       
297        /// adds an expression to a compound statement
298        void addExpr( CompoundStmt *stmts, Expression *expr ) {
299                stmts->get_kids().push_back( new ExprStmt( noLabels, expr ) );
300        }
301
302        /// adds a statement to a compound statement
303        void addStmt( CompoundStmt *stmts, Statement *stmt ) {
304                stmts->get_kids().push_back( stmt );
305        }
306       
307        Declaration *LayoutFunctionBuilder::mutate( StructDecl *structDecl ) {
308                // do not generate layout function for "empty" tag structs
309                if ( structDecl->get_members().empty() ) return structDecl;
310
311                // get parameters that can change layout, exiting early if none
312                std::list< TypeDecl* > otypeParams = takeOtypeOnly( structDecl->get_parameters() );
313                if ( otypeParams.empty() ) return structDecl;
314
315                // build layout function signature
316                FunctionType *layoutFnType = new FunctionType( Type::Qualifiers(), false );
317                BasicType *sizeAlignType = new BasicType( Type::Qualifiers(), BasicType::LongUnsignedInt );
318                PointerType *sizeAlignOutType = new PointerType( Type::Qualifiers(), sizeAlignType );
319               
320                ObjectDecl *sizeParam = new ObjectDecl( "__sizeof_" + structDecl->get_name(), DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, sizeAlignOutType, 0 );
321                layoutFnType->get_parameters().push_back( sizeParam );
322                ObjectDecl *alignParam = new ObjectDecl( "__alignof_" + structDecl->get_name(), DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, sizeAlignOutType->clone(), 0 );
323                layoutFnType->get_parameters().push_back( alignParam );
324                ObjectDecl *offsetParam = new ObjectDecl( "__offsetof_" + structDecl->get_name(), DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, sizeAlignOutType->clone(), 0 );
325                layoutFnType->get_parameters().push_back( offsetParam );
326                addOtypeParams( layoutFnType, otypeParams );
327
328                // build function decl
329                FunctionDecl *layoutDecl = buildLayoutFunctionDecl( structDecl->get_name(), functionNesting, layoutFnType );
330
331                // calculate struct layout in function body
332
333                // initialize size and alignment to 0 and 1 (will have at least one member to re-edit size
334                addExpr( layoutDecl->get_statements(), makeOp( "?=?", derefVar( sizeParam ), new ConstantExpr( Constant( sizeAlignType->clone(), "0" ) ) ) );
335                addExpr( layoutDecl->get_statements(), makeOp( "?=?", derefVar( alignParam ), new ConstantExpr( Constant( sizeAlignType->clone(), "1" ) ) ) );
336                unsigned long n_members = 0;
337                bool firstMember = true;
338                for ( std::list< Declaration* >::const_iterator member = structDecl->get_members().begin(); member != structDecl->get_members().end(); ++member ) {
339                        DeclarationWithType *dwt = dynamic_cast< DeclarationWithType * >( *member );
340                        assert( dwt );
341                        Type *memberType = dwt->get_type();
342
343                        if ( firstMember ) {
344                                firstMember = false;
345                        } else {
346                                // make sure all members after the first (automatically aligned at 0) are properly padded for alignment
347                                addStmt( layoutDecl->get_statements(), makeAlignTo( derefVar( sizeParam ), new AlignofExpr( memberType->clone() ) ) );
348                        }
349                       
350                        // place current size in the current offset index
351                        addExpr( layoutDecl->get_statements(), makeOp( "?=?", makeOp( "?[?]", new VariableExpr( offsetParam ), new ConstantExpr( Constant::from( n_members ) ) ),
352                                                                              derefVar( sizeParam ) ) );
353                        ++n_members;
354
355                        // add member size to current size
356                        addExpr( layoutDecl->get_statements(), makeOp( "?+=?", derefVar( sizeParam ), new SizeofExpr( memberType->clone() ) ) );
357                       
358                        // take max of member alignment and global alignment
359                        addStmt( layoutDecl->get_statements(), makeAssignMax( derefVar( alignParam ), new AlignofExpr( memberType->clone() ) ) );
360                }
361                // make sure the type is end-padded to a multiple of its alignment
362                addStmt( layoutDecl->get_statements(), makeAlignTo( derefVar( sizeParam ), derefVar( alignParam ) ) );
363
364                addDeclarationAfter( layoutDecl );
365                return structDecl;
366        }
367       
368        Declaration *LayoutFunctionBuilder::mutate( UnionDecl *unionDecl ) {
369                // do not generate layout function for "empty" tag unions
370                if ( unionDecl->get_members().empty() ) return unionDecl;
371               
372                // get parameters that can change layout, exiting early if none
373                std::list< TypeDecl* > otypeParams = takeOtypeOnly( unionDecl->get_parameters() );
374                if ( otypeParams.empty() ) return unionDecl;
375
376                // build layout function signature
377                FunctionType *layoutFnType = new FunctionType( Type::Qualifiers(), false );
378                BasicType *sizeAlignType = new BasicType( Type::Qualifiers(), BasicType::LongUnsignedInt );
379                PointerType *sizeAlignOutType = new PointerType( Type::Qualifiers(), sizeAlignType );
380               
381                ObjectDecl *sizeParam = new ObjectDecl( "__sizeof_" + unionDecl->get_name(), DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, sizeAlignOutType, 0 );
382                layoutFnType->get_parameters().push_back( sizeParam );
383                ObjectDecl *alignParam = new ObjectDecl( "__alignof_" + unionDecl->get_name(), DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, sizeAlignOutType->clone(), 0 );
384                layoutFnType->get_parameters().push_back( alignParam );
385                addOtypeParams( layoutFnType, otypeParams );
386
387                // build function decl
388                FunctionDecl *layoutDecl = buildLayoutFunctionDecl( unionDecl->get_name(), functionNesting, layoutFnType );
389
390                // calculate union layout in function body
391                addExpr( layoutDecl->get_statements(), makeOp( "?=?", derefVar( sizeParam ), new ConstantExpr( Constant( sizeAlignType->clone(), "1" ) ) ) );
392                addExpr( layoutDecl->get_statements(), makeOp( "?=?", derefVar( alignParam ), new ConstantExpr( Constant( sizeAlignType->clone(), "1" ) ) ) );
393                for ( std::list< Declaration* >::const_iterator member = unionDecl->get_members().begin(); member != unionDecl->get_members().end(); ++member ) {
394                        DeclarationWithType *dwt = dynamic_cast< DeclarationWithType * >( *member );
395                        assert( dwt );
396                        Type *memberType = dwt->get_type();
397                       
398                        // take max member size and global size
399                        addStmt( layoutDecl->get_statements(), makeAssignMax( derefVar( sizeParam ), new SizeofExpr( memberType->clone() ) ) );
400                       
401                        // take max of member alignment and global alignment
402                        addStmt( layoutDecl->get_statements(), makeAssignMax( derefVar( alignParam ), new AlignofExpr( memberType->clone() ) ) );
403                }
404                // make sure the type is end-padded to a multiple of its alignment
405                addStmt( layoutDecl->get_statements(), makeAlignTo( derefVar( sizeParam ), derefVar( alignParam ) ) );
406
407                addDeclarationAfter( layoutDecl );
408                return unionDecl;
409        }
410       
411        ////////////////////////////////////////// Pass1 ////////////////////////////////////////////////////
412
413        namespace {
414                std::string makePolyMonoSuffix( FunctionType * function, const TyVarMap &tyVars ) {
415                        std::stringstream name;
416
417                        // NOTE: this function previously used isPolyObj, which failed to produce
418                        // the correct thing in some situations. It's not clear to me why this wasn't working.
419
420                        // if the return type or a parameter type involved polymorphic types, then the adapter will need
421                        // to take those polymorphic types as pointers. Therefore, there can be two different functions
422                        // with the same mangled name, so we need to further mangle the names.
423                        for ( std::list< DeclarationWithType *>::iterator retval = function->get_returnVals().begin(); retval != function->get_returnVals().end(); ++retval ) {
424                                if ( isPolyType( (*retval)->get_type(), tyVars ) ) {
425                                        name << "P";
426                                } else {
427                                        name << "M";
428                                }
429                        }
430                        name << "_";
431                        std::list< DeclarationWithType *> &paramList = function->get_parameters();
432                        for ( std::list< DeclarationWithType *>::iterator arg = paramList.begin(); arg != paramList.end(); ++arg ) {
433                                if ( isPolyType( (*arg)->get_type(), tyVars ) ) {
434                                        name << "P";
435                                } else {
436                                        name << "M";
437                                }
438                        } // for
439                        return name.str();
440                }
441
442                std::string mangleAdapterName( FunctionType * function, const TyVarMap &tyVars ) {
443                        return SymTab::Mangler::mangle( function ) + makePolyMonoSuffix( function, tyVars );
444                }
445
446                std::string makeAdapterName( const std::string &mangleName ) {
447                        return "_adapter" + mangleName;
448                }
449
450                Pass1::Pass1() : useRetval( false ), tempNamer( "_temp" ) {}
451
452                /// Returns T if the given declaration is (*?=?)(T *, T) for some TypeInstType T (return not checked, but maybe should be), NULL otherwise
453                TypeInstType *isTypeInstAssignment( DeclarationWithType *decl ) {
454                        if ( decl->get_name() == "?=?" ) {
455                                if ( FunctionType *funType = getFunctionType( decl->get_type() ) ) {
456                                        if ( funType->get_parameters().size() == 2 ) {
457                                                if ( PointerType *pointer = dynamic_cast< PointerType *>( funType->get_parameters().front()->get_type() ) ) {
458                                                        if ( TypeInstType *refType = dynamic_cast< TypeInstType *>( pointer->get_base() ) ) {
459                                                                if ( TypeInstType *refType2 = dynamic_cast< TypeInstType *>( funType->get_parameters().back()->get_type() ) ) {
460                                                                        if ( refType->get_name() == refType2->get_name() ) {
461                                                                                return refType;
462                                                                        } // if
463                                                                } // if
464                                                        } // if
465                                                } // if
466                                        } // if
467                                } // if
468                        } // if
469                        return 0;
470                }
471               
472                /// returns T if the given declaration is: (*?=?)(T *, T) for some type T (return not checked, but maybe should be), NULL otherwise
473                /// Only picks assignments where neither parameter is cv-qualified
474                Type *isAssignment( DeclarationWithType *decl ) {
475                        if ( decl->get_name() == "?=?" ) {
476                                if ( FunctionType *funType = getFunctionType( decl->get_type() ) ) {
477                                        if ( funType->get_parameters().size() == 2 ) {
478                                                Type::Qualifiers defaultQualifiers;
479                                                Type *paramType1 = funType->get_parameters().front()->get_type();
480                                                if ( paramType1->get_qualifiers() != defaultQualifiers ) return 0;
481                                                Type *paramType2 = funType->get_parameters().back()->get_type();
482                                                if ( paramType2->get_qualifiers() != defaultQualifiers ) return 0;
483                                               
484                                                if ( PointerType *pointerType = dynamic_cast< PointerType* >( paramType1 ) ) {
485                                                        Type *baseType1 = pointerType->get_base();
486                                                        if ( baseType1->get_qualifiers() != defaultQualifiers ) return 0;
487                                                        SymTab::Indexer dummy;
488                                                        if ( ResolvExpr::typesCompatible( baseType1, paramType2, dummy ) ) {
489                                                                return baseType1;
490                                                        } // if
491                                                } // if
492                                        } // if
493                                } // if
494                        } // if
495                        return 0;
496                }
497
498                void Pass1::findAssignOps( const std::list< TypeDecl *> &forall ) {
499                        // what if a nested function uses an assignment operator?
500                        // assignOps.clear();
501                        for ( std::list< TypeDecl *>::const_iterator i = forall.begin(); i != forall.end(); ++i ) {
502                                for ( std::list< DeclarationWithType *>::const_iterator assert = (*i)->get_assertions().begin(); assert != (*i)->get_assertions().end(); ++assert ) {
503                                        std::string typeName;
504                                        if ( TypeInstType *typeInst = isTypeInstAssignment( *assert ) ) {
505                                                assignOps[ typeInst->get_name() ] = *assert;
506                                        } // if
507                                } // for
508                        } // for
509                }
510
511                DeclarationWithType *Pass1::mutate( FunctionDecl *functionDecl ) {
512                        // if this is a polymorphic assignment function, put it in the map for this scope
513                        if ( Type *assignedType = isAssignment( functionDecl ) ) {
514                                if ( ! dynamic_cast< TypeInstType* >( assignedType ) ) {
515                                        scopedAssignOps.insert( assignedType, functionDecl );
516                                }
517                        }
518
519                        if ( functionDecl->get_statements() ) {         // empty routine body ?
520                                doBeginScope();
521                                TyVarMap oldtyVars = scopeTyVars;
522                                std::map< std::string, DeclarationWithType *> oldassignOps = assignOps;
523                                DeclarationWithType *oldRetval = retval;
524                                bool oldUseRetval = useRetval;
525
526                                // process polymorphic return value
527                                retval = 0;
528                                if ( isPolyRet( functionDecl->get_functionType() ) && functionDecl->get_linkage() == LinkageSpec::Cforall ) {
529                                        retval = functionDecl->get_functionType()->get_returnVals().front();
530
531                                        // give names to unnamed return values
532                                        if ( retval->get_name() == "" ) {
533                                                retval->set_name( "_retparm" );
534                                                retval->set_linkage( LinkageSpec::C );
535                                        } // if
536                                } // if
537
538                                FunctionType *functionType = functionDecl->get_functionType();
539                                makeTyVarMap( functionDecl->get_functionType(), scopeTyVars );
540                                findAssignOps( functionDecl->get_functionType()->get_forall() );
541
542                                std::list< DeclarationWithType *> &paramList = functionType->get_parameters();
543                                std::list< FunctionType *> functions;
544                                for ( std::list< TypeDecl *>::iterator tyVar = functionType->get_forall().begin(); tyVar != functionType->get_forall().end(); ++tyVar ) {
545                                        for ( std::list< DeclarationWithType *>::iterator assert = (*tyVar)->get_assertions().begin(); assert != (*tyVar)->get_assertions().end(); ++assert ) {
546                                                findFunction( (*assert)->get_type(), functions, scopeTyVars, needsAdapter );
547                                        } // for
548                                } // for
549                                for ( std::list< DeclarationWithType *>::iterator arg = paramList.begin(); arg != paramList.end(); ++arg ) {
550                                        findFunction( (*arg)->get_type(), functions, scopeTyVars, needsAdapter );
551                                } // for
552
553                                for ( std::list< FunctionType *>::iterator funType = functions.begin(); funType != functions.end(); ++funType ) {
554                                        std::string mangleName = mangleAdapterName( *funType, scopeTyVars );
555                                        if ( adapters.find( mangleName ) == adapters.end() ) {
556                                                std::string adapterName = makeAdapterName( mangleName );
557                                                adapters.insert( std::pair< std::string, DeclarationWithType *>( mangleName, new ObjectDecl( adapterName, DeclarationNode::NoStorageClass, LinkageSpec::C, 0, new PointerType( Type::Qualifiers(), makeAdapterType( *funType, scopeTyVars ) ), 0 ) ) );
558                                        } // if
559                                } // for
560
561                                functionDecl->set_statements( functionDecl->get_statements()->acceptMutator( *this ) );
562
563                                scopeTyVars = oldtyVars;
564                                assignOps = oldassignOps;
565                                // std::cerr << "end FunctionDecl: ";
566                                // for ( TyVarMap::iterator i = scopeTyVars.begin(); i != scopeTyVars.end(); ++i ) {
567                                //      std::cerr << i->first << " ";
568                                // }
569                                // std::cerr << "\n";
570                                retval = oldRetval;
571                                useRetval = oldUseRetval;
572                                doEndScope();
573                        } // if
574                        return functionDecl;
575                }
576
577                TypeDecl *Pass1::mutate( TypeDecl *typeDecl ) {
578                        scopeTyVars[ typeDecl->get_name() ] = typeDecl->get_kind();
579                        return Mutator::mutate( typeDecl );
580                }
581
582                Expression *Pass1::mutate( CommaExpr *commaExpr ) {
583                        bool oldUseRetval = useRetval;
584                        useRetval = false;
585                        commaExpr->set_arg1( maybeMutate( commaExpr->get_arg1(), *this ) );
586                        useRetval = oldUseRetval;
587                        commaExpr->set_arg2( maybeMutate( commaExpr->get_arg2(), *this ) );
588                        return commaExpr;
589                }
590
591                Expression *Pass1::mutate( ConditionalExpr *condExpr ) {
592                        bool oldUseRetval = useRetval;
593                        useRetval = false;
594                        condExpr->set_arg1( maybeMutate( condExpr->get_arg1(), *this ) );
595                        useRetval = oldUseRetval;
596                        condExpr->set_arg2( maybeMutate( condExpr->get_arg2(), *this ) );
597                        condExpr->set_arg3( maybeMutate( condExpr->get_arg3(), *this ) );
598                        return condExpr;
599
600                }
601
602                Expression *Pass1::makeOffsetArray( StructInstType *ty ) {
603                        std::list< Declaration* > &baseMembers = ty->get_baseStruct()->get_members();
604
605                        // make a new temporary array
606                        Type *offsetType = new BasicType( Type::Qualifiers(), BasicType::LongUnsignedInt );
607                        std::stringstream lenGen;
608                        lenGen << baseMembers.size();
609                        ConstantExpr *lenExpr = new ConstantExpr( Constant( offsetType->clone(), lenGen.str() ) );
610                        ObjectDecl *arrayTemp = makeTemporary( new ArrayType( Type::Qualifiers(), offsetType, lenExpr, false, false ) );
611
612                        // build initializer list for temporary
613                        std::list< Initializer* > inits;
614                        for ( std::list< Declaration* >::const_iterator member = baseMembers.begin(); member != baseMembers.end(); ++member ) {
615                                DeclarationWithType *memberDecl;
616                                if ( DeclarationWithType *origMember = dynamic_cast< DeclarationWithType* >( *member ) ) {
617                                        memberDecl = origMember->clone();
618                                } else {
619                                        memberDecl = new ObjectDecl( (*member)->get_name(), DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, offsetType->clone(), 0 );
620                                }
621                                inits.push_back( new SingleInit( new OffsetofExpr( ty->clone(), memberDecl ) ) );
622                        }
623                        arrayTemp->set_init( new ListInit( inits ) );
624
625                        // return variable pointing to temporary
626                        return new VariableExpr( arrayTemp );
627                }
628
629                void Pass1::passArgTypeVars( ApplicationExpr *appExpr, Type *parmType, Type *argBaseType, std::list< Expression *>::iterator &arg, const TyVarMap &exprTyVars, std::set< std::string > &seenTypes ) {
630                        Type *polyBase = hasPolyBase( parmType, exprTyVars );
631                        if ( polyBase && ! dynamic_cast< TypeInstType* >( polyBase ) ) {
632                                std::string sizeName = sizeofName( polyBase );
633                                if ( seenTypes.count( sizeName ) ) return;
634
635                                arg = appExpr->get_args().insert( arg, new SizeofExpr( argBaseType->clone() ) );
636                                arg++;
637                                arg = appExpr->get_args().insert( arg, new AlignofExpr( argBaseType->clone() ) );
638                                arg++;
639                                if ( dynamic_cast< StructInstType* >( polyBase ) ) {
640                                        if ( StructInstType *argBaseStructType = dynamic_cast< StructInstType* >( argBaseType ) ) {
641                                                arg = appExpr->get_args().insert( arg, makeOffsetArray( argBaseStructType ) );
642                                                arg++;
643                                        } else {
644                                                throw SemanticError( "Cannot pass non-struct type for generic struct" );
645                                        }
646                                }
647
648                                seenTypes.insert( sizeName );
649                        }
650                }
651
652                void Pass1::passTypeVars( ApplicationExpr *appExpr, ReferenceToType *polyRetType, std::list< Expression *>::iterator &arg, const TyVarMap &exprTyVars ) {
653                        // pass size/align for type variables
654                        for ( TyVarMap::const_iterator tyParm = exprTyVars.begin(); tyParm != exprTyVars.end(); ++tyParm ) {
655                                ResolvExpr::EqvClass eqvClass;
656                                assert( env );
657                                if ( tyParm->second == TypeDecl::Any ) {
658                                        Type *concrete = env->lookup( tyParm->first );
659                                        if ( concrete ) {
660                                                arg = appExpr->get_args().insert( arg, new SizeofExpr( concrete->clone() ) );
661                                                arg++;
662                                                arg = appExpr->get_args().insert( arg, new AlignofExpr( concrete->clone() ) );
663                                                arg++;
664                                        } else {
665                                                throw SemanticError( "unbound type variable in application ", appExpr );
666                                        } // if
667                                } // if
668                        } // for
669
670                        // add size/align for generic types to parameter list
671                        if ( appExpr->get_function()->get_results().empty() ) return;
672                        FunctionType *funcType = getFunctionType( appExpr->get_function()->get_results().front() );
673                        assert( funcType );
674
675                        std::list< DeclarationWithType* >::const_iterator fnParm = funcType->get_parameters().begin();
676                        std::list< Expression* >::const_iterator fnArg = arg;
677                        std::set< std::string > seenTypes; //< names for generic types we've seen
678
679                        // a polymorphic return type may need to be added to the argument list
680                        if ( polyRetType ) {
681                                Type *concRetType = replaceWithConcrete( appExpr, polyRetType );
682                                passArgTypeVars( appExpr, polyRetType, concRetType, arg, exprTyVars, seenTypes );
683                        }
684                       
685                        // add type information args for presently unseen types in parameter list
686                        for ( ; fnParm != funcType->get_parameters().end() && fnArg != appExpr->get_args().end(); ++fnParm, ++fnArg ) {
687                                VariableExpr *fnArgBase = getBaseVar( *fnArg );
688                                if ( ! fnArgBase || fnArgBase->get_results().empty() ) continue;
689                                passArgTypeVars( appExpr, (*fnParm)->get_type(), fnArgBase->get_results().front(), arg, exprTyVars, seenTypes );
690                        }
691                }
692
693                ObjectDecl *Pass1::makeTemporary( Type *type ) {
694                        ObjectDecl *newObj = new ObjectDecl( tempNamer.newName(), DeclarationNode::NoStorageClass, LinkageSpec::C, 0, type, 0 );
695                        stmtsToAdd.push_back( new DeclStmt( noLabels, newObj ) );
696                        return newObj;
697                }
698
699                Expression *Pass1::addRetParam( ApplicationExpr *appExpr, FunctionType *function, Type *retType, std::list< Expression *>::iterator &arg ) {
700                        // ***** Code Removal ***** After introducing a temporary variable for all return expressions, the following code appears superfluous.
701                        // if ( useRetval ) {
702                        //      assert( retval );
703                        //      arg = appExpr->get_args().insert( arg, new VariableExpr( retval ) );
704                        //      arg++;
705                        // } else {
706
707                        // Create temporary to hold return value of polymorphic function and produce that temporary as a result
708                        // using a comma expression.  Possibly change comma expression into statement expression "{}" for multiple
709                        // return values.
710                        ObjectDecl *newObj = makeTemporary( retType->clone() );
711                        Expression *paramExpr = new VariableExpr( newObj );
712
713                        // If the type of the temporary is not polymorphic, box temporary by taking its address;
714                        // otherwise the temporary is already boxed and can be used directly.
715                        if ( ! isPolyType( newObj->get_type(), scopeTyVars, env ) ) {
716                                paramExpr = new AddressExpr( paramExpr );
717                        } // if
718                        arg = appExpr->get_args().insert( arg, paramExpr ); // add argument to function call
719                        arg++;
720                        // Build a comma expression to call the function and emulate a normal return.
721                        CommaExpr *commaExpr = new CommaExpr( appExpr, new VariableExpr( newObj ) );
722                        commaExpr->set_env( appExpr->get_env() );
723                        appExpr->set_env( 0 );
724                        return commaExpr;
725                        // } // if
726                        // return appExpr;
727                }
728
729                void Pass1::replaceParametersWithConcrete( ApplicationExpr *appExpr, std::list< Expression* >& params ) {
730                        for ( std::list< Expression* >::iterator param = params.begin(); param != params.end(); ++param ) {
731                                TypeExpr *paramType = dynamic_cast< TypeExpr* >( *param );
732                                assert(paramType && "Aggregate parameters should be type expressions");
733                                paramType->set_type( replaceWithConcrete( appExpr, paramType->get_type(), false ) );
734                        }
735                }
736
737                Type *Pass1::replaceWithConcrete( ApplicationExpr *appExpr, Type *type, bool doClone ) {
738                        if ( TypeInstType *typeInst = dynamic_cast< TypeInstType * >( type ) ) {
739                                Type *concrete = env->lookup( typeInst->get_name() );
740                                if ( concrete == 0 ) {
741                                        throw SemanticError( "Unbound type variable " + typeInst->get_name() + " in ", appExpr );
742                                } // if
743                                return concrete;
744                        } else if ( StructInstType *structType = dynamic_cast< StructInstType* >( type ) ) {
745                                if ( doClone ) {
746                                        structType = structType->clone();
747                                }
748                                replaceParametersWithConcrete( appExpr, structType->get_parameters() );
749                                return structType;
750                        } else if ( UnionInstType *unionType = dynamic_cast< UnionInstType* >( type ) ) {
751                                if ( doClone ) {
752                                        unionType = unionType->clone();
753                                }
754                                replaceParametersWithConcrete( appExpr, unionType->get_parameters() );
755                                return unionType;
756                        }
757                        return type;
758                }
759
760                Expression *Pass1::addPolyRetParam( ApplicationExpr *appExpr, FunctionType *function, ReferenceToType *polyType, std::list< Expression *>::iterator &arg ) {
761                        assert( env );
762                        Type *concrete = replaceWithConcrete( appExpr, polyType );
763                        // add out-parameter for return value   
764                        return addRetParam( appExpr, function, concrete, arg );
765                }
766
767                Expression *Pass1::applyAdapter( ApplicationExpr *appExpr, FunctionType *function, std::list< Expression *>::iterator &arg, const TyVarMap &tyVars ) {
768                        Expression *ret = appExpr;
769                        if ( ! function->get_returnVals().empty() && isPolyType( function->get_returnVals().front()->get_type(), tyVars ) ) {
770                                ret = addRetParam( appExpr, function, function->get_returnVals().front()->get_type(), arg );
771                        } // if
772                        std::string mangleName = mangleAdapterName( function, tyVars );
773                        std::string adapterName = makeAdapterName( mangleName );
774
775                        // cast adaptee to void (*)(), since it may have any type inside a polymorphic function
776                        Type * adapteeType = new PointerType( Type::Qualifiers(), new FunctionType( Type::Qualifiers(), true ) );
777                        appExpr->get_args().push_front( new CastExpr( appExpr->get_function(), adapteeType ) );
778                        appExpr->set_function( new NameExpr( adapterName ) );
779
780                        return ret;
781                }
782
783                void Pass1::boxParam( Type *param, Expression *&arg, const TyVarMap &exprTyVars ) {
784                        assert( ! arg->get_results().empty() );
785                        if ( isPolyType( param, exprTyVars ) ) {
786                                if ( isPolyType( arg->get_results().front() ) ) {
787                                        // if the argument's type is polymorphic, we don't need to box again!
788                                        return;
789                                } else if ( arg->get_results().front()->get_isLvalue() ) {
790                                        // VariableExpr and MemberExpr are lvalues
791                                        arg = new AddressExpr( arg );
792                                } else {
793                                        // use type computed in unification to declare boxed variables
794                                        Type * newType = param->clone();
795                                        if ( env ) env->apply( newType );
796                                        ObjectDecl *newObj = new ObjectDecl( tempNamer.newName(), DeclarationNode::NoStorageClass, LinkageSpec::C, 0, newType, 0 );
797                                        newObj->get_type()->get_qualifiers() = Type::Qualifiers(); // TODO: is this right???
798                                        stmtsToAdd.push_back( new DeclStmt( noLabels, newObj ) );
799                                        UntypedExpr *assign = new UntypedExpr( new NameExpr( "?=?" ) );
800                                        assign->get_args().push_back( new VariableExpr( newObj ) );
801                                        assign->get_args().push_back( arg );
802                                        stmtsToAdd.push_back( new ExprStmt( noLabels, assign ) );
803                                        arg = new AddressExpr( new VariableExpr( newObj ) );
804                                } // if
805                        } // if
806                }
807
808                /// cast parameters to polymorphic functions so that types are replaced with
809                /// void * if they are type parameters in the formal type.
810                /// this gets rid of warnings from gcc.
811                void addCast( Expression *&actual, Type *formal, const TyVarMap &tyVars ) {
812                        Type * newType = formal->clone();
813                        if ( getFunctionType( newType ) ) {
814                                newType = ScrubTyVars::scrub( newType, tyVars );
815                                actual = new CastExpr( actual, newType );
816                        } // if
817                }
818
819                void Pass1::boxParams( ApplicationExpr *appExpr, FunctionType *function, std::list< Expression *>::iterator &arg, const TyVarMap &exprTyVars ) {
820                        for ( std::list< DeclarationWithType *>::const_iterator param = function->get_parameters().begin(); param != function->get_parameters().end(); ++param, ++arg ) {
821                                assert( arg != appExpr->get_args().end() );
822                                addCast( *arg, (*param)->get_type(), exprTyVars );
823                                boxParam( (*param)->get_type(), *arg, exprTyVars );
824                        } // for
825                }
826
827                void Pass1::addInferredParams( ApplicationExpr *appExpr, FunctionType *functionType, std::list< Expression *>::iterator &arg, const TyVarMap &tyVars ) {
828                        std::list< Expression *>::iterator cur = arg;
829                        for ( std::list< TypeDecl *>::iterator tyVar = functionType->get_forall().begin(); tyVar != functionType->get_forall().end(); ++tyVar ) {
830                                for ( std::list< DeclarationWithType *>::iterator assert = (*tyVar)->get_assertions().begin(); assert != (*tyVar)->get_assertions().end(); ++assert ) {
831                                        InferredParams::const_iterator inferParam = appExpr->get_inferParams().find( (*assert)->get_uniqueId() );
832                                        assert( inferParam != appExpr->get_inferParams().end() && "NOTE: Explicit casts of polymorphic functions to compatible monomorphic functions are currently unsupported" );
833                                        Expression *newExpr = inferParam->second.expr->clone();
834                                        addCast( newExpr, (*assert)->get_type(), tyVars );
835                                        boxParam( (*assert)->get_type(), newExpr, tyVars );
836                                        appExpr->get_args().insert( cur, newExpr );
837                                } // for
838                        } // for
839                }
840
841                void makeRetParm( FunctionType *funcType ) {
842                        DeclarationWithType *retParm = funcType->get_returnVals().front();
843
844                        // make a new parameter that is a pointer to the type of the old return value
845                        retParm->set_type( new PointerType( Type::Qualifiers(), retParm->get_type() ) );
846                        funcType->get_parameters().push_front( retParm );
847
848                        // we don't need the return value any more
849                        funcType->get_returnVals().clear();
850                }
851
852                FunctionType *makeAdapterType( FunctionType *adaptee, const TyVarMap &tyVars ) {
853                        // actually make the adapter type
854                        FunctionType *adapter = adaptee->clone();
855                        if ( ! adapter->get_returnVals().empty() && isPolyType( adapter->get_returnVals().front()->get_type(), tyVars ) ) {
856                                makeRetParm( adapter );
857                        } // if
858                        adapter->get_parameters().push_front( new ObjectDecl( "", DeclarationNode::NoStorageClass, LinkageSpec::C, 0, new PointerType( Type::Qualifiers(), new FunctionType( Type::Qualifiers(), true ) ), 0 ) );
859                        return adapter;
860                }
861
862                Expression *makeAdapterArg( DeclarationWithType *param, DeclarationWithType *arg, DeclarationWithType *realParam, const TyVarMap &tyVars ) {
863                        assert( param );
864                        assert( arg );
865                        if ( isPolyType( realParam->get_type(), tyVars ) ) {
866                                if ( ! isPolyType( arg->get_type() ) ) {
867                                        UntypedExpr *deref = new UntypedExpr( new NameExpr( "*?" ) );
868                                        deref->get_args().push_back( new CastExpr( new VariableExpr( param ), new PointerType( Type::Qualifiers(), arg->get_type()->clone() ) ) );
869                                        deref->get_results().push_back( arg->get_type()->clone() );
870                                        return deref;
871                                } // if
872                        } // if
873                        return new VariableExpr( param );
874                }
875
876                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 ) {
877                        UniqueName paramNamer( "_p" );
878                        for ( ; param != paramEnd; ++param, ++arg, ++realParam ) {
879                                if ( (*param)->get_name() == "" ) {
880                                        (*param)->set_name( paramNamer.newName() );
881                                        (*param)->set_linkage( LinkageSpec::C );
882                                } // if
883                                adapteeApp->get_args().push_back( makeAdapterArg( *param, *arg, *realParam, tyVars ) );
884                        } // for
885                }
886
887
888
889                FunctionDecl *Pass1::makeAdapter( FunctionType *adaptee, FunctionType *realType, const std::string &mangleName, const TyVarMap &tyVars ) {
890                        FunctionType *adapterType = makeAdapterType( adaptee, tyVars );
891                        adapterType = ScrubTyVars::scrub( adapterType, tyVars );
892                        DeclarationWithType *adapteeDecl = adapterType->get_parameters().front();
893                        adapteeDecl->set_name( "_adaptee" );
894                        ApplicationExpr *adapteeApp = new ApplicationExpr( new CastExpr( new VariableExpr( adapteeDecl ), new PointerType( Type::Qualifiers(), realType ) ) );
895                        Statement *bodyStmt;
896
897                        std::list< TypeDecl *>::iterator tyArg = realType->get_forall().begin();
898                        std::list< TypeDecl *>::iterator tyParam = adapterType->get_forall().begin();
899                        std::list< TypeDecl *>::iterator realTyParam = adaptee->get_forall().begin();
900                        for ( ; tyParam != adapterType->get_forall().end(); ++tyArg, ++tyParam, ++realTyParam ) {
901                                assert( tyArg != realType->get_forall().end() );
902                                std::list< DeclarationWithType *>::iterator assertArg = (*tyArg)->get_assertions().begin();
903                                std::list< DeclarationWithType *>::iterator assertParam = (*tyParam)->get_assertions().begin();
904                                std::list< DeclarationWithType *>::iterator realAssertParam = (*realTyParam)->get_assertions().begin();
905                                for ( ; assertParam != (*tyParam)->get_assertions().end(); ++assertArg, ++assertParam, ++realAssertParam ) {
906                                        assert( assertArg != (*tyArg)->get_assertions().end() );
907                                        adapteeApp->get_args().push_back( makeAdapterArg( *assertParam, *assertArg, *realAssertParam, tyVars ) );
908                                } // for
909                        } // for
910
911                        std::list< DeclarationWithType *>::iterator arg = realType->get_parameters().begin();
912                        std::list< DeclarationWithType *>::iterator param = adapterType->get_parameters().begin();
913                        std::list< DeclarationWithType *>::iterator realParam = adaptee->get_parameters().begin();
914                        param++;                // skip adaptee parameter
915                        if ( realType->get_returnVals().empty() ) {
916                                addAdapterParams( adapteeApp, arg, param, adapterType->get_parameters().end(), realParam, tyVars );
917                                bodyStmt = new ExprStmt( noLabels, adapteeApp );
918                        } else if ( isPolyType( adaptee->get_returnVals().front()->get_type(), tyVars ) ) {
919                                if ( (*param)->get_name() == "" ) {
920                                        (*param)->set_name( "_ret" );
921                                        (*param)->set_linkage( LinkageSpec::C );
922                                } // if
923                                UntypedExpr *assign = new UntypedExpr( new NameExpr( "?=?" ) );
924                                UntypedExpr *deref = new UntypedExpr( new NameExpr( "*?" ) );
925                                deref->get_args().push_back( new CastExpr( new VariableExpr( *param++ ), new PointerType( Type::Qualifiers(), realType->get_returnVals().front()->get_type()->clone() ) ) );
926                                assign->get_args().push_back( deref );
927                                addAdapterParams( adapteeApp, arg, param, adapterType->get_parameters().end(), realParam, tyVars );
928                                assign->get_args().push_back( adapteeApp );
929                                bodyStmt = new ExprStmt( noLabels, assign );
930                        } else {
931                                // adapter for a function that returns a monomorphic value
932                                addAdapterParams( adapteeApp, arg, param, adapterType->get_parameters().end(), realParam, tyVars );
933                                bodyStmt = new ReturnStmt( noLabels, adapteeApp );
934                        } // if
935                        CompoundStmt *adapterBody = new CompoundStmt( noLabels );
936                        adapterBody->get_kids().push_back( bodyStmt );
937                        std::string adapterName = makeAdapterName( mangleName );
938                        return new FunctionDecl( adapterName, DeclarationNode::NoStorageClass, LinkageSpec::C, adapterType, adapterBody, false, false );
939                }
940
941                void Pass1::passAdapters( ApplicationExpr * appExpr, FunctionType * functionType, const TyVarMap & exprTyVars ) {
942                        // collect a list of function types passed as parameters or implicit parameters (assertions)
943                        std::list< DeclarationWithType *> &paramList = functionType->get_parameters();
944                        std::list< FunctionType *> functions;
945                        for ( std::list< TypeDecl *>::iterator tyVar = functionType->get_forall().begin(); tyVar != functionType->get_forall().end(); ++tyVar ) {
946                                for ( std::list< DeclarationWithType *>::iterator assert = (*tyVar)->get_assertions().begin(); assert != (*tyVar)->get_assertions().end(); ++assert ) {
947                                        findFunction( (*assert)->get_type(), functions, exprTyVars, needsAdapter );
948                                } // for
949                        } // for
950                        for ( std::list< DeclarationWithType *>::iterator arg = paramList.begin(); arg != paramList.end(); ++arg ) {
951                                findFunction( (*arg)->get_type(), functions, exprTyVars, needsAdapter );
952                        } // for
953
954                        // parameter function types for which an appropriate adapter has been generated.  we cannot use the types
955                        // after applying substitutions, since two different parameter types may be unified to the same type
956                        std::set< std::string > adaptersDone;
957
958                        for ( std::list< FunctionType *>::iterator funType = functions.begin(); funType != functions.end(); ++funType ) {
959                                FunctionType *originalFunction = (*funType)->clone();
960                                FunctionType *realFunction = (*funType)->clone();
961                                std::string mangleName = SymTab::Mangler::mangle( realFunction );
962
963                                // only attempt to create an adapter or pass one as a parameter if we haven't already done so for this
964                                // pre-substitution parameter function type.
965                                if ( adaptersDone.find( mangleName ) == adaptersDone.end() ) {
966                                        adaptersDone.insert( adaptersDone.begin(), mangleName );
967
968                                        // apply substitution to type variables to figure out what the adapter's type should look like
969                                        assert( env );
970                                        env->apply( realFunction );
971                                        mangleName = SymTab::Mangler::mangle( realFunction );
972                                        mangleName += makePolyMonoSuffix( originalFunction, exprTyVars );
973
974                                        typedef ScopedMap< std::string, DeclarationWithType* >::iterator AdapterIter;
975                                        AdapterIter adapter = adapters.find( mangleName );
976                                        if ( adapter == adapters.end() ) {
977                                                // adapter has not been created yet in the current scope, so define it
978                                                FunctionDecl *newAdapter = makeAdapter( *funType, realFunction, mangleName, exprTyVars );
979                                                std::pair< AdapterIter, bool > answer = adapters.insert( std::pair< std::string, DeclarationWithType *>( mangleName, newAdapter ) );
980                                                adapter = answer.first;
981                                                stmtsToAdd.push_back( new DeclStmt( noLabels, newAdapter ) );
982                                        } // if
983                                        assert( adapter != adapters.end() );
984
985                                        // add the appropriate adapter as a parameter
986                                        appExpr->get_args().push_front( new VariableExpr( adapter->second ) );
987                                } // if
988                        } // for
989                } // passAdapters
990
991                Expression *makeIncrDecrExpr( ApplicationExpr *appExpr, Type *polyType, bool isIncr ) {
992                        NameExpr *opExpr;
993                        if ( isIncr ) {
994                                opExpr = new NameExpr( "?+=?" );
995                        } else {
996                                opExpr = new NameExpr( "?-=?" );
997                        } // if
998                        UntypedExpr *addAssign = new UntypedExpr( opExpr );
999                        if ( AddressExpr *address = dynamic_cast< AddressExpr *>( appExpr->get_args().front() ) ) {
1000                                addAssign->get_args().push_back( address->get_arg() );
1001                        } else {
1002                                addAssign->get_args().push_back( appExpr->get_args().front() );
1003                        } // if
1004                        addAssign->get_args().push_back( new NameExpr( sizeofName( polyType ) ) );
1005                        addAssign->get_results().front() = appExpr->get_results().front()->clone();
1006                        if ( appExpr->get_env() ) {
1007                                addAssign->set_env( appExpr->get_env() );
1008                                appExpr->set_env( 0 );
1009                        } // if
1010                        appExpr->get_args().clear();
1011                        delete appExpr;
1012                        return addAssign;
1013                }
1014
1015                Expression *Pass1::handleIntrinsics( ApplicationExpr *appExpr ) {
1016                        if ( VariableExpr *varExpr = dynamic_cast< VariableExpr *>( appExpr->get_function() ) ) {
1017                                if ( varExpr->get_var()->get_linkage() == LinkageSpec::Intrinsic ) {
1018                                        if ( varExpr->get_var()->get_name() == "?[?]" ) {
1019                                                assert( ! appExpr->get_results().empty() );
1020                                                assert( appExpr->get_args().size() == 2 );
1021                                                Type *baseType1 = isPolyPtr( appExpr->get_args().front()->get_results().front(), scopeTyVars, env );
1022                                                Type *baseType2 = isPolyPtr( appExpr->get_args().back()->get_results().front(), scopeTyVars, env );
1023                                                assert( ! baseType1 || ! baseType2 ); // the arguments cannot both be polymorphic pointers
1024                                                UntypedExpr *ret = 0;
1025                                                if ( baseType1 || baseType2 ) { // one of the arguments is a polymorphic pointer
1026                                                        ret = new UntypedExpr( new NameExpr( "?+?" ) );
1027                                                } // if
1028                                                if ( baseType1 ) {
1029                                                        UntypedExpr *multiply = new UntypedExpr( new NameExpr( "?*?" ) );
1030                                                        multiply->get_args().push_back( appExpr->get_args().back() );
1031                                                        multiply->get_args().push_back( new NameExpr( sizeofName( baseType1 ) ) );
1032                                                        ret->get_args().push_back( appExpr->get_args().front() );
1033                                                        ret->get_args().push_back( multiply );
1034                                                } else if ( baseType2 ) {
1035                                                        UntypedExpr *multiply = new UntypedExpr( new NameExpr( "?*?" ) );
1036                                                        multiply->get_args().push_back( appExpr->get_args().front() );
1037                                                        multiply->get_args().push_back( new NameExpr( sizeofName( baseType2 ) ) );
1038                                                        ret->get_args().push_back( multiply );
1039                                                        ret->get_args().push_back( appExpr->get_args().back() );
1040                                                } // if
1041                                                if ( baseType1 || baseType2 ) {
1042                                                        ret->get_results().push_front( appExpr->get_results().front()->clone() );
1043                                                        if ( appExpr->get_env() ) {
1044                                                                ret->set_env( appExpr->get_env() );
1045                                                                appExpr->set_env( 0 );
1046                                                        } // if
1047                                                        appExpr->get_args().clear();
1048                                                        delete appExpr;
1049                                                        return ret;
1050                                                } // if
1051                                        } else if ( varExpr->get_var()->get_name() == "*?" ) {
1052                                                assert( ! appExpr->get_results().empty() );
1053                                                assert( ! appExpr->get_args().empty() );
1054                                                if ( isPolyType( appExpr->get_results().front(), scopeTyVars, env ) ) {
1055                                                        Expression *ret = appExpr->get_args().front();
1056                                                        delete ret->get_results().front();
1057                                                        ret->get_results().front() = appExpr->get_results().front()->clone();
1058                                                        if ( appExpr->get_env() ) {
1059                                                                ret->set_env( appExpr->get_env() );
1060                                                                appExpr->set_env( 0 );
1061                                                        } // if
1062                                                        appExpr->get_args().clear();
1063                                                        delete appExpr;
1064                                                        return ret;
1065                                                } // if
1066                                        } else if ( varExpr->get_var()->get_name() == "?++" || varExpr->get_var()->get_name() == "?--" ) {
1067                                                assert( ! appExpr->get_results().empty() );
1068                                                assert( appExpr->get_args().size() == 1 );
1069                                                if ( Type *baseType = isPolyPtr( appExpr->get_results().front(), scopeTyVars, env ) ) {
1070                                                        Type *tempType = appExpr->get_results().front()->clone();
1071                                                        if ( env ) {
1072                                                                env->apply( tempType );
1073                                                        } // if
1074                                                        ObjectDecl *newObj = makeTemporary( tempType );
1075                                                        VariableExpr *tempExpr = new VariableExpr( newObj );
1076                                                        UntypedExpr *assignExpr = new UntypedExpr( new NameExpr( "?=?" ) );
1077                                                        assignExpr->get_args().push_back( tempExpr->clone() );
1078                                                        if ( AddressExpr *address = dynamic_cast< AddressExpr *>( appExpr->get_args().front() ) ) {
1079                                                                assignExpr->get_args().push_back( address->get_arg()->clone() );
1080                                                        } else {
1081                                                                assignExpr->get_args().push_back( appExpr->get_args().front()->clone() );
1082                                                        } // if
1083                                                        CommaExpr *firstComma = new CommaExpr( assignExpr, makeIncrDecrExpr( appExpr, baseType, varExpr->get_var()->get_name() == "?++" ) );
1084                                                        return new CommaExpr( firstComma, tempExpr );
1085                                                } // if
1086                                        } else if ( varExpr->get_var()->get_name() == "++?" || varExpr->get_var()->get_name() == "--?" ) {
1087                                                assert( ! appExpr->get_results().empty() );
1088                                                assert( appExpr->get_args().size() == 1 );
1089                                                if ( Type *baseType = isPolyPtr( appExpr->get_results().front(), scopeTyVars, env ) ) {
1090                                                        return makeIncrDecrExpr( appExpr, baseType, varExpr->get_var()->get_name() == "++?" );
1091                                                } // if
1092                                        } else if ( varExpr->get_var()->get_name() == "?+?" || varExpr->get_var()->get_name() == "?-?" ) {
1093                                                assert( ! appExpr->get_results().empty() );
1094                                                assert( appExpr->get_args().size() == 2 );
1095                                                Type *baseType1 = isPolyPtr( appExpr->get_args().front()->get_results().front(), scopeTyVars, env );
1096                                                Type *baseType2 = isPolyPtr( appExpr->get_args().back()->get_results().front(), scopeTyVars, env );
1097                                                if ( baseType1 && baseType2 ) {
1098                                                        UntypedExpr *divide = new UntypedExpr( new NameExpr( "?/?" ) );
1099                                                        divide->get_args().push_back( appExpr );
1100                                                        divide->get_args().push_back( new NameExpr( sizeofName( baseType1 ) ) );
1101                                                        divide->get_results().push_front( appExpr->get_results().front()->clone() );
1102                                                        if ( appExpr->get_env() ) {
1103                                                                divide->set_env( appExpr->get_env() );
1104                                                                appExpr->set_env( 0 );
1105                                                        } // if
1106                                                        return divide;
1107                                                } else if ( baseType1 ) {
1108                                                        UntypedExpr *multiply = new UntypedExpr( new NameExpr( "?*?" ) );
1109                                                        multiply->get_args().push_back( appExpr->get_args().back() );
1110                                                        multiply->get_args().push_back( new NameExpr( sizeofName( baseType1 ) ) );
1111                                                        appExpr->get_args().back() = multiply;
1112                                                } else if ( baseType2 ) {
1113                                                        UntypedExpr *multiply = new UntypedExpr( new NameExpr( "?*?" ) );
1114                                                        multiply->get_args().push_back( appExpr->get_args().front() );
1115                                                        multiply->get_args().push_back( new NameExpr( sizeofName( baseType2 ) ) );
1116                                                        appExpr->get_args().front() = multiply;
1117                                                } // if
1118                                        } else if ( varExpr->get_var()->get_name() == "?+=?" || varExpr->get_var()->get_name() == "?-=?" ) {
1119                                                assert( ! appExpr->get_results().empty() );
1120                                                assert( appExpr->get_args().size() == 2 );
1121                                                Type *baseType = isPolyPtr( appExpr->get_results().front(), scopeTyVars, env );
1122                                                if ( baseType ) {
1123                                                        UntypedExpr *multiply = new UntypedExpr( new NameExpr( "?*?" ) );
1124                                                        multiply->get_args().push_back( appExpr->get_args().back() );
1125                                                        multiply->get_args().push_back( new NameExpr( sizeofName( baseType ) ) );
1126                                                        appExpr->get_args().back() = multiply;
1127                                                } // if
1128                                        } // if
1129                                        return appExpr;
1130                                } // if
1131                        } // if
1132                        return 0;
1133                }
1134
1135                Expression *Pass1::mutate( ApplicationExpr *appExpr ) {
1136                        // std::cerr << "mutate appExpr: ";
1137                        // for ( TyVarMap::iterator i = scopeTyVars.begin(); i != scopeTyVars.end(); ++i ) {
1138                        //      std::cerr << i->first << " ";
1139                        // }
1140                        // std::cerr << "\n";
1141                        bool oldUseRetval = useRetval;
1142                        useRetval = false;
1143                        appExpr->get_function()->acceptMutator( *this );
1144                        mutateAll( appExpr->get_args(), *this );
1145                        useRetval = oldUseRetval;
1146
1147                        assert( ! appExpr->get_function()->get_results().empty() );
1148                        PointerType *pointer = dynamic_cast< PointerType *>( appExpr->get_function()->get_results().front() );
1149                        assert( pointer );
1150                        FunctionType *function = dynamic_cast< FunctionType *>( pointer->get_base() );
1151                        assert( function );
1152
1153                        if ( Expression *newExpr = handleIntrinsics( appExpr ) ) {
1154                                return newExpr;
1155                        } // if
1156
1157                        Expression *ret = appExpr;
1158
1159                        std::list< Expression *>::iterator arg = appExpr->get_args().begin();
1160                        std::list< Expression *>::iterator paramBegin = appExpr->get_args().begin();
1161
1162                        TyVarMap exprTyVars;
1163                        makeTyVarMap( function, exprTyVars );
1164                        ReferenceToType *polyRetType = isPolyRet( function );
1165
1166                        if ( polyRetType ) {
1167                                ret = addPolyRetParam( appExpr, function, polyRetType, arg );
1168                        } else if ( needsAdapter( function, scopeTyVars ) ) {
1169                                // std::cerr << "needs adapter: ";
1170                                // for ( TyVarMap::iterator i = scopeTyVars.begin(); i != scopeTyVars.end(); ++i ) {
1171                                //      std::cerr << i->first << " ";
1172                                // }
1173                                // std::cerr << "\n";
1174                                // change the application so it calls the adapter rather than the passed function
1175                                ret = applyAdapter( appExpr, function, arg, scopeTyVars );
1176                        } // if
1177                        arg = appExpr->get_args().begin();
1178
1179                        passTypeVars( appExpr, polyRetType, arg, exprTyVars );
1180                        addInferredParams( appExpr, function, arg, exprTyVars );
1181
1182                        arg = paramBegin;
1183
1184                        boxParams( appExpr, function, arg, exprTyVars );
1185
1186                        passAdapters( appExpr, function, exprTyVars );
1187
1188                        return ret;
1189                }
1190
1191                Expression *Pass1::mutate( UntypedExpr *expr ) {
1192                        if ( ! expr->get_results().empty() && isPolyType( expr->get_results().front(), scopeTyVars, env ) ) {
1193                                if ( NameExpr *name = dynamic_cast< NameExpr *>( expr->get_function() ) ) {
1194                                        if ( name->get_name() == "*?" ) {
1195                                                Expression *ret = expr->get_args().front();
1196                                                expr->get_args().clear();
1197                                                delete expr;
1198                                                return ret->acceptMutator( *this );
1199                                        } // if
1200                                } // if
1201                        } // if
1202                        return PolyMutator::mutate( expr );
1203                }
1204
1205                Expression *Pass1::mutate( AddressExpr *addrExpr ) {
1206                        assert( ! addrExpr->get_arg()->get_results().empty() );
1207
1208                        bool needs = false;
1209                        if ( UntypedExpr *expr = dynamic_cast< UntypedExpr *>( addrExpr->get_arg() ) ) {
1210                                if ( ! expr->get_results().empty() && isPolyType( expr->get_results().front(), scopeTyVars, env ) ) {
1211                                        if ( NameExpr *name = dynamic_cast< NameExpr *>( expr->get_function() ) ) {
1212                                                if ( name->get_name() == "*?" ) {
1213                                                        if ( ApplicationExpr * appExpr = dynamic_cast< ApplicationExpr * >( expr->get_args().front() ) ) {
1214                                                                assert( ! appExpr->get_function()->get_results().empty() );
1215                                                                PointerType *pointer = dynamic_cast< PointerType *>( appExpr->get_function()->get_results().front() );
1216                                                                assert( pointer );
1217                                                                FunctionType *function = dynamic_cast< FunctionType *>( pointer->get_base() );
1218                                                                assert( function );
1219                                                                needs = needsAdapter( function, scopeTyVars );
1220                                                        } // if
1221                                                } // if
1222                                        } // if
1223                                } // if
1224                        } // if
1225                        addrExpr->set_arg( mutateExpression( addrExpr->get_arg() ) );
1226                        if ( isPolyType( addrExpr->get_arg()->get_results().front(), scopeTyVars, env ) || needs ) {
1227                                Expression *ret = addrExpr->get_arg();
1228                                delete ret->get_results().front();
1229                                ret->get_results().front() = addrExpr->get_results().front()->clone();
1230                                addrExpr->set_arg( 0 );
1231                                delete addrExpr;
1232                                return ret;
1233                        } else {
1234                                return addrExpr;
1235                        } // if
1236                }
1237
1238                /// Wraps a function declaration in a new pointer-to-function variable expression
1239                VariableExpr *wrapFunctionDecl( DeclarationWithType *functionDecl ) {
1240                        // line below cloned from FixFunction.cc
1241                        ObjectDecl *functionObj = new ObjectDecl( functionDecl->get_name(), functionDecl->get_storageClass(), functionDecl->get_linkage(), 0,
1242                                                                  new PointerType( Type::Qualifiers(), functionDecl->get_type()->clone() ), 0 );
1243                        functionObj->set_mangleName( functionDecl->get_mangleName() );
1244                        return new VariableExpr( functionObj );
1245                }
1246               
1247                Statement * Pass1::mutate( ReturnStmt *returnStmt ) {
1248                        if ( retval && returnStmt->get_expr() ) {
1249                                assert( ! returnStmt->get_expr()->get_results().empty() );
1250                                // ***** Code Removal ***** After introducing a temporary variable for all return expressions, the following code appears superfluous.
1251                                // if ( returnStmt->get_expr()->get_results().front()->get_isLvalue() ) {
1252                                // by this point, a cast expr on a polymorphic return value is redundant
1253                                while ( CastExpr *castExpr = dynamic_cast< CastExpr *>( returnStmt->get_expr() ) ) {
1254                                        returnStmt->set_expr( castExpr->get_arg() );
1255                                        returnStmt->get_expr()->set_env( castExpr->get_env() );
1256                                        castExpr->set_env( 0 );
1257                                        castExpr->set_arg( 0 );
1258                                        delete castExpr;
1259                                } //while
1260
1261                                // find assignment operator for (polymorphic) return type
1262                                ApplicationExpr *assignExpr = 0;
1263                                if ( TypeInstType *typeInst = dynamic_cast< TypeInstType *>( retval->get_type() ) ) {
1264                                        // find assignment operator for type variable
1265                                        std::map< std::string, DeclarationWithType *>::const_iterator assignIter = assignOps.find( typeInst->get_name() );
1266                                        if ( assignIter == assignOps.end() ) {
1267                                                throw SemanticError( "Attempt to return dtype or ftype object in ", returnStmt->get_expr() );
1268                                        } // if
1269                                        assignExpr = new ApplicationExpr( new VariableExpr( assignIter->second ) );
1270                                } else if ( ReferenceToType *refType = dynamic_cast< ReferenceToType *>( retval->get_type() ) ) {
1271                                        // find assignment operator for generic type
1272                                        DeclarationWithType *functionDecl = scopedAssignOps.find( refType );
1273                                        if ( ! functionDecl ) {
1274                                                throw SemanticError( "Attempt to return dtype or ftype generic object in ", returnStmt->get_expr() );
1275                                        }
1276
1277                                        // wrap it up in an application expression
1278                                        assignExpr = new ApplicationExpr( wrapFunctionDecl( functionDecl ) );
1279                                        assignExpr->set_env( env->clone() );
1280
1281                                        // find each of its needed secondary assignment operators
1282                                        std::list< Expression* > &tyParams = refType->get_parameters();
1283                                        std::list< TypeDecl* > &forallParams = functionDecl->get_type()->get_forall();
1284                                        std::list< Expression* >::const_iterator tyIt = tyParams.begin();
1285                                        std::list< TypeDecl* >::const_iterator forallIt = forallParams.begin();
1286                                        for ( ; tyIt != tyParams.end() && forallIt != forallParams.end(); ++tyIt, ++forallIt ) {
1287                                                if ( (*forallIt)->get_kind() != TypeDecl::Any ) continue; // skip types with no assign op (ftype/dtype)
1288
1289                                                std::list< DeclarationWithType* > &asserts = (*forallIt)->get_assertions();
1290                                                assert( ! asserts.empty() && "Type param needs assignment operator assertion" );
1291                                                DeclarationWithType *actualDecl = asserts.front();
1292                                                TypeInstType *actualType = isTypeInstAssignment( actualDecl );
1293                                                assert( actualType && "First assertion of type with assertions should be assignment operator" );
1294                                                TypeExpr *formalTypeExpr = dynamic_cast< TypeExpr* >( *tyIt );
1295                                                assert( formalTypeExpr && "type parameters must be type expressions" );
1296                                                Type *formalType = formalTypeExpr->get_type();
1297                                                assignExpr->get_env()->add( actualType->get_name(), formalType );
1298                                               
1299                                                DeclarationWithType *assertAssign = 0;
1300                                                if ( TypeInstType *formalTypeInstType = dynamic_cast< TypeInstType* >( formalType ) ) {
1301                                                        std::map< std::string, DeclarationWithType *>::const_iterator assertAssignIt = assignOps.find( formalTypeInstType->get_name() );
1302                                                        if ( assertAssignIt == assignOps.end() ) {
1303                                                                throw SemanticError( "No assignment operation found for ", formalTypeInstType );
1304                                                        }
1305                                                        assertAssign = assertAssignIt->second;
1306                                                } else {
1307                                                        assertAssign = scopedAssignOps.find( formalType );
1308                                                        if ( ! assertAssign ) {
1309                                                                throw SemanticError( "No assignment operation found for ", formalType );
1310                                                        }
1311                                                }
1312                                               
1313
1314                                                assignExpr->get_inferParams()[ actualDecl->get_uniqueId() ]
1315                                                        = ParamEntry( assertAssign->get_uniqueId(), assertAssign->get_type()->clone(), actualDecl->get_type()->clone(), wrapFunctionDecl( assertAssign ) );
1316                                        }
1317                                }
1318                                assert( assignExpr );
1319
1320                                // replace return statement with appropriate assignment to out parameter
1321                                Expression *retParm = new NameExpr( retval->get_name() );
1322                                retParm->get_results().push_back( new PointerType( Type::Qualifiers(), retval->get_type()->clone() ) );
1323                                assignExpr->get_args().push_back( retParm );
1324                                assignExpr->get_args().push_back( returnStmt->get_expr() );
1325                                stmtsToAdd.push_back( new ExprStmt( noLabels, mutateExpression( assignExpr ) ) );
1326                                // } else {
1327                                //      useRetval = true;
1328                                //      stmtsToAdd.push_back( new ExprStmt( noLabels, mutateExpression( returnStmt->get_expr() ) ) );
1329                                //      useRetval = false;
1330                                // } // if
1331                                returnStmt->set_expr( 0 );
1332                        } else {
1333                                returnStmt->set_expr( mutateExpression( returnStmt->get_expr() ) );
1334                        } // if
1335                        return returnStmt;
1336                }
1337
1338                Type * Pass1::mutate( PointerType *pointerType ) {
1339                        TyVarMap oldtyVars = scopeTyVars;
1340                        makeTyVarMap( pointerType, scopeTyVars );
1341
1342                        Type *ret = Mutator::mutate( pointerType );
1343
1344                        scopeTyVars = oldtyVars;
1345                        return ret;
1346                }
1347
1348                Type * Pass1::mutate( FunctionType *functionType ) {
1349                        TyVarMap oldtyVars = scopeTyVars;
1350                        makeTyVarMap( functionType, scopeTyVars );
1351
1352                        Type *ret = Mutator::mutate( functionType );
1353
1354                        scopeTyVars = oldtyVars;
1355                        return ret;
1356                }
1357
1358                void Pass1::doBeginScope() {
1359                        adapters.beginScope();
1360                        scopedAssignOps.beginScope();
1361                }
1362
1363                void Pass1::doEndScope() {
1364                        adapters.endScope();
1365                        scopedAssignOps.endScope();
1366                }
1367
1368////////////////////////////////////////// Pass2 ////////////////////////////////////////////////////
1369
1370                void Pass2::addAdapters( FunctionType *functionType ) {
1371                        std::list< DeclarationWithType *> &paramList = functionType->get_parameters();
1372                        std::list< FunctionType *> functions;
1373                        for ( std::list< DeclarationWithType *>::iterator arg = paramList.begin(); arg != paramList.end(); ++arg ) {
1374                                Type *orig = (*arg)->get_type();
1375                                findAndReplaceFunction( orig, functions, scopeTyVars, needsAdapter );
1376                                (*arg)->set_type( orig );
1377                        }
1378                        std::set< std::string > adaptersDone;
1379                        for ( std::list< FunctionType *>::iterator funType = functions.begin(); funType != functions.end(); ++funType ) {
1380                                std::string mangleName = mangleAdapterName( *funType, scopeTyVars );
1381                                if ( adaptersDone.find( mangleName ) == adaptersDone.end() ) {
1382                                        std::string adapterName = makeAdapterName( mangleName );
1383                                        paramList.push_front( new ObjectDecl( adapterName, DeclarationNode::NoStorageClass, LinkageSpec::C, 0, new PointerType( Type::Qualifiers(), makeAdapterType( *funType, scopeTyVars ) ), 0 ) );
1384                                        adaptersDone.insert( adaptersDone.begin(), mangleName );
1385                                }
1386                        }
1387//  deleteAll( functions );
1388                }
1389
1390                template< typename DeclClass >
1391                DeclClass * Pass2::handleDecl( DeclClass *decl, Type *type ) {
1392                        DeclClass *ret = static_cast< DeclClass *>( Mutator::mutate( decl ) );
1393
1394                        return ret;
1395                }
1396
1397                DeclarationWithType * Pass2::mutate( FunctionDecl *functionDecl ) {
1398                        return handleDecl( functionDecl, functionDecl->get_functionType() );
1399                }
1400
1401                ObjectDecl * Pass2::mutate( ObjectDecl *objectDecl ) {
1402                        return handleDecl( objectDecl, objectDecl->get_type() );
1403                }
1404
1405                TypeDecl * Pass2::mutate( TypeDecl *typeDecl ) {
1406                        scopeTyVars[ typeDecl->get_name() ] = typeDecl->get_kind();
1407                        if ( typeDecl->get_base() ) {
1408                                return handleDecl( typeDecl, typeDecl->get_base() );
1409                        } else {
1410                                return Mutator::mutate( typeDecl );
1411                        }
1412                }
1413
1414                TypedefDecl * Pass2::mutate( TypedefDecl *typedefDecl ) {
1415                        return handleDecl( typedefDecl, typedefDecl->get_base() );
1416                }
1417
1418                Type * Pass2::mutate( PointerType *pointerType ) {
1419                        TyVarMap oldtyVars = scopeTyVars;
1420                        makeTyVarMap( pointerType, scopeTyVars );
1421
1422                        Type *ret = Mutator::mutate( pointerType );
1423
1424                        scopeTyVars = oldtyVars;
1425                        return ret;
1426                }
1427
1428                Type *Pass2::mutate( FunctionType *funcType ) {
1429                        TyVarMap oldtyVars = scopeTyVars;
1430                        makeTyVarMap( funcType, scopeTyVars );
1431
1432                        // move polymorphic return type to parameter list
1433                        if ( isPolyRet( funcType ) ) {
1434                                DeclarationWithType *ret = funcType->get_returnVals().front();
1435                                ret->set_type( new PointerType( Type::Qualifiers(), ret->get_type() ) );
1436                                funcType->get_parameters().push_front( ret );
1437                                funcType->get_returnVals().pop_front();
1438                        }
1439
1440                        // add size/align and assertions for type parameters to parameter list
1441                        std::list< DeclarationWithType *>::iterator last = funcType->get_parameters().begin();
1442                        std::list< DeclarationWithType *> inferredParams;
1443                        ObjectDecl newObj( "", DeclarationNode::NoStorageClass, LinkageSpec::C, 0, new BasicType( Type::Qualifiers(), BasicType::LongUnsignedInt ), 0 );
1444                        ObjectDecl newPtr( "", DeclarationNode::NoStorageClass, LinkageSpec::C, 0,
1445                                           new PointerType( Type::Qualifiers(), new BasicType( Type::Qualifiers(), BasicType::LongUnsignedInt ) ), 0 );
1446//   ObjectDecl *newFunPtr = new ObjectDecl( "", DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, new PointerType( Type::Qualifiers(), new FunctionType( Type::Qualifiers(), true ) ), 0 );
1447                        for ( std::list< TypeDecl *>::const_iterator tyParm = funcType->get_forall().begin(); tyParm != funcType->get_forall().end(); ++tyParm ) {
1448                                ObjectDecl *sizeParm, *alignParm;
1449                                // add all size and alignment parameters to parameter list
1450                                if ( (*tyParm)->get_kind() == TypeDecl::Any ) {
1451                                        TypeInstType parmType( Type::Qualifiers(), (*tyParm)->get_name(), *tyParm );
1452
1453                                        sizeParm = newObj.clone();
1454                                        sizeParm->set_name( sizeofName( &parmType ) );
1455                                        last = funcType->get_parameters().insert( last, sizeParm );
1456                                        ++last;
1457
1458                                        alignParm = newObj.clone();
1459                                        alignParm->set_name( alignofName( &parmType ) );
1460                                        last = funcType->get_parameters().insert( last, alignParm );
1461                                        ++last;
1462                                }
1463                                // move all assertions into parameter list
1464                                for ( std::list< DeclarationWithType *>::iterator assert = (*tyParm)->get_assertions().begin(); assert != (*tyParm)->get_assertions().end(); ++assert ) {
1465//      *assert = (*assert)->acceptMutator( *this );
1466                                        inferredParams.push_back( *assert );
1467                                }
1468                                (*tyParm)->get_assertions().clear();
1469                        }
1470
1471                        // add size/align for generic parameter types to parameter list
1472                        std::set< std::string > seenTypes; // sizeofName for generic types we've seen
1473                        for ( std::list< DeclarationWithType* >::const_iterator fnParm = last; fnParm != funcType->get_parameters().end(); ++fnParm ) {
1474                                Type *polyBase = hasPolyBase( (*fnParm)->get_type(), scopeTyVars );
1475                                if ( polyBase && ! dynamic_cast< TypeInstType* >( polyBase ) ) {
1476                                        std::string sizeName = sizeofName( polyBase );
1477                                        if ( seenTypes.count( sizeName ) ) continue;
1478
1479                                        ObjectDecl *sizeParm, *alignParm, *offsetParm;
1480                                        sizeParm = newObj.clone();
1481                                        sizeParm->set_name( sizeName );
1482                                        last = funcType->get_parameters().insert( last, sizeParm );
1483                                        ++last;
1484
1485                                        alignParm = newObj.clone();
1486                                        alignParm->set_name( alignofName( polyBase ) );
1487                                        last = funcType->get_parameters().insert( last, alignParm );
1488                                        ++last;
1489
1490                                        if ( dynamic_cast< StructInstType* >( polyBase ) ) {
1491                                                offsetParm = newPtr.clone();
1492                                                offsetParm->set_name( offsetofName( polyBase ) );
1493                                                last = funcType->get_parameters().insert( last, offsetParm );
1494                                                ++last;
1495                                        }
1496
1497                                        seenTypes.insert( sizeName );
1498                                }
1499                        }
1500
1501                        // splice assertion parameters into parameter list
1502                        funcType->get_parameters().splice( last, inferredParams );
1503                        addAdapters( funcType );
1504                        mutateAll( funcType->get_returnVals(), *this );
1505                        mutateAll( funcType->get_parameters(), *this );
1506
1507                        scopeTyVars = oldtyVars;
1508                        return funcType;
1509                }
1510
1511////////////////////////////////////////// MemberExprFixer ////////////////////////////////////////////////////
1512
1513                template< typename DeclClass >
1514                DeclClass * MemberExprFixer::handleDecl( DeclClass *decl, Type *type ) {
1515                        TyVarMap oldtyVars = scopeTyVars;
1516                        makeTyVarMap( type, scopeTyVars );
1517
1518                        DeclClass *ret = static_cast< DeclClass *>( Mutator::mutate( decl ) );
1519
1520                        scopeTyVars = oldtyVars;
1521                        return ret;
1522                }
1523
1524                ObjectDecl * MemberExprFixer::mutate( ObjectDecl *objectDecl ) {
1525                        return handleDecl( objectDecl, objectDecl->get_type() );
1526                }
1527
1528                DeclarationWithType * MemberExprFixer::mutate( FunctionDecl *functionDecl ) {
1529                        return handleDecl( functionDecl, functionDecl->get_functionType() );
1530                }
1531
1532                TypedefDecl * MemberExprFixer::mutate( TypedefDecl *typedefDecl ) {
1533                        return handleDecl( typedefDecl, typedefDecl->get_base() );
1534                }
1535
1536                TypeDecl * MemberExprFixer::mutate( TypeDecl *typeDecl ) {
1537                        scopeTyVars[ typeDecl->get_name() ] = typeDecl->get_kind();
1538                        return Mutator::mutate( typeDecl );
1539                }
1540
1541                Type * MemberExprFixer::mutate( PointerType *pointerType ) {
1542                        TyVarMap oldtyVars = scopeTyVars;
1543                        makeTyVarMap( pointerType, scopeTyVars );
1544
1545                        Type *ret = Mutator::mutate( pointerType );
1546
1547                        scopeTyVars = oldtyVars;
1548                        return ret;
1549                }
1550
1551                Type * MemberExprFixer::mutate( FunctionType *functionType ) {
1552                        TyVarMap oldtyVars = scopeTyVars;
1553                        makeTyVarMap( functionType, scopeTyVars );
1554
1555                        Type *ret = Mutator::mutate( functionType );
1556
1557                        scopeTyVars = oldtyVars;
1558                        return ret;
1559                }
1560
1561                Statement *MemberExprFixer::mutate( DeclStmt *declStmt ) {
1562                        if ( ObjectDecl *objectDecl = dynamic_cast< ObjectDecl *>( declStmt->get_decl() ) ) {
1563                                if ( isPolyType( objectDecl->get_type(), scopeTyVars ) ) {
1564                                        // change initialization of a polymorphic value object
1565                                        // to allocate storage with alloca
1566                                        Type *declType = objectDecl->get_type();
1567                                        UntypedExpr *alloc = new UntypedExpr( new NameExpr( "__builtin_alloca" ) );
1568                                        alloc->get_args().push_back( new NameExpr( sizeofName( declType ) ) );
1569
1570                                        delete objectDecl->get_init();
1571
1572                                        std::list<Expression*> designators;
1573                                        objectDecl->set_init( new SingleInit( alloc, designators ) );
1574                                }
1575                        }
1576                        return Mutator::mutate( declStmt );
1577                }
1578
1579                /// Finds the member in the base list that matches the given declaration; returns its index, or -1 if not present
1580                long findMember( DeclarationWithType *memberDecl, std::list< Declaration* > &baseDecls ) {
1581                        long i = 0;
1582                        for(std::list< Declaration* >::const_iterator decl = baseDecls.begin(); decl != baseDecls.end(); ++decl, ++i ) {
1583                                if ( memberDecl->get_name() != (*decl)->get_name() ) continue;
1584
1585                                if ( DeclarationWithType *declWithType = dynamic_cast< DeclarationWithType* >( *decl ) ) {
1586                                        if ( memberDecl->get_mangleName().empty() || declWithType->get_mangleName().empty()
1587                                             || memberDecl->get_mangleName() == declWithType->get_mangleName() ) return i;
1588                                        else continue;
1589                                } else return i;
1590                        }
1591                        return -1;
1592                }
1593
1594                /// Returns an index expression into the offset array for a type
1595                Expression *makeOffsetIndex( Type *objectType, long i ) {
1596                        std::stringstream offset_namer;
1597                        offset_namer << i;
1598                        ConstantExpr *fieldIndex = new ConstantExpr( Constant( new BasicType( Type::Qualifiers(), BasicType::LongUnsignedInt ), offset_namer.str() ) );
1599                        UntypedExpr *fieldOffset = new UntypedExpr( new NameExpr( "?[?]" ) );
1600                        fieldOffset->get_args().push_back( new NameExpr( offsetofName( objectType ) ) );
1601                        fieldOffset->get_args().push_back( fieldIndex );
1602                        return fieldOffset;
1603                }
1604
1605                /// Returns an expression dereferenced n times
1606                Expression *makeDerefdVar( Expression *derefdVar, long n ) {
1607                        for ( int i = 1; i < n; ++i ) {
1608                                UntypedExpr *derefExpr = new UntypedExpr( new NameExpr( "*?" ) );
1609                                derefExpr->get_args().push_back( derefdVar );
1610                                derefdVar = derefExpr;
1611                        }
1612                        return derefdVar;
1613                }
1614               
1615                Expression *MemberExprFixer::mutate( MemberExpr *memberExpr ) {
1616                        // mutate, exiting early if no longer MemberExpr
1617                        Expression *expr = Mutator::mutate( memberExpr );
1618                        memberExpr = dynamic_cast< MemberExpr* >( expr );
1619                        if ( ! memberExpr ) return expr;
1620
1621                        // get declaration for base struct, exiting early if not found
1622                        int varDepth;
1623                        VariableExpr *varExpr = getBaseVar( memberExpr->get_aggregate(), &varDepth );
1624                        if ( ! varExpr ) return memberExpr;
1625                        ObjectDecl *objectDecl = dynamic_cast< ObjectDecl* >( varExpr->get_var() );
1626                        if ( ! objectDecl ) return memberExpr;
1627
1628                        // only mutate member expressions for polymorphic types
1629                        int tyDepth;
1630                        Type *objectType = hasPolyBase( objectDecl->get_type(), scopeTyVars, &tyDepth );
1631                        if ( ! objectType ) return memberExpr;
1632
1633                        Expression *newMemberExpr = 0;
1634                        if ( StructInstType *structType = dynamic_cast< StructInstType* >( objectType ) ) {
1635                                // look up offset index
1636                                long i = findMember( memberExpr->get_member(), structType->get_baseStruct()->get_members() );
1637                                if ( i == -1 ) return memberExpr;
1638
1639                                // replace member expression with pointer to base plus offset
1640                                UntypedExpr *fieldLoc = new UntypedExpr( new NameExpr( "?+?" ) );
1641                                fieldLoc->get_args().push_back( makeDerefdVar( varExpr->clone(), varDepth ) );
1642                                fieldLoc->get_args().push_back( makeOffsetIndex( objectType, i ) );
1643                                newMemberExpr = fieldLoc;
1644                        } else if ( dynamic_cast< UnionInstType* >( objectType ) ) {
1645                                // union members are all at offset zero, so build appropriately-dereferenced variable
1646                                newMemberExpr = makeDerefdVar( varExpr->clone(), varDepth );
1647                        } else return memberExpr;
1648                        assert( newMemberExpr );
1649
1650                        Type *memberType = memberExpr->get_member()->get_type();
1651                        if ( ! isPolyType( memberType, scopeTyVars ) ) {
1652                                // 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
1653                                CastExpr *ptrCastExpr = new CastExpr( newMemberExpr, new PointerType( Type::Qualifiers(), memberType->clone() ) );
1654                                UntypedExpr *derefExpr = new UntypedExpr( new NameExpr( "*?" ) );
1655                                derefExpr->get_args().push_back( ptrCastExpr );
1656                                newMemberExpr = derefExpr;
1657                        }
1658
1659                        delete memberExpr;
1660                        return newMemberExpr;
1661                }
1662
1663                Expression *MemberExprFixer::mutate( OffsetofExpr *offsetofExpr ) {
1664                        // mutate, exiting early if no longer OffsetofExpr
1665                        Expression *expr = Mutator::mutate( offsetofExpr );
1666                        offsetofExpr = dynamic_cast< OffsetofExpr* >( expr );
1667                        if ( ! offsetofExpr ) return expr;
1668
1669                        // only mutate expressions for polymorphic structs/unions
1670                        Type *ty = isPolyType( offsetofExpr->get_type(), scopeTyVars );
1671                        if ( ! ty ) return offsetofExpr;
1672
1673                        if ( StructInstType *structType = dynamic_cast< StructInstType* >( ty ) ) {
1674                                // replace offsetof expression by index into offset array
1675                                long i = findMember( offsetofExpr->get_member(), structType->get_baseStruct()->get_members() );
1676                                if ( i == -1 ) return offsetofExpr;
1677
1678                                Expression *offsetInd = makeOffsetIndex( ty, i );
1679                                delete offsetofExpr;
1680                                return offsetInd;
1681                        } else if ( dynamic_cast< UnionInstType* >( ty ) ) {
1682                                // all union members are at offset zero
1683                                delete offsetofExpr;
1684                                return new ConstantExpr( Constant( new BasicType( Type::Qualifiers(), BasicType::LongUnsignedInt ), std::string("0") ) );
1685                        } else return offsetofExpr;
1686                }
1687
1688////////////////////////////////////////// Pass3 ////////////////////////////////////////////////////
1689
1690                template< typename DeclClass >
1691                DeclClass * Pass3::handleDecl( DeclClass *decl, Type *type ) {
1692                        TyVarMap oldtyVars = scopeTyVars;
1693                        makeTyVarMap( type, scopeTyVars );
1694
1695                        DeclClass *ret = static_cast< DeclClass *>( Mutator::mutate( decl ) );
1696                        ScrubTyVars::scrub( decl, scopeTyVars );
1697
1698                        scopeTyVars = oldtyVars;
1699                        return ret;
1700                }
1701
1702                ObjectDecl * Pass3::mutate( ObjectDecl *objectDecl ) {
1703                        return handleDecl( objectDecl, objectDecl->get_type() );
1704                }
1705
1706                DeclarationWithType * Pass3::mutate( FunctionDecl *functionDecl ) {
1707                        return handleDecl( functionDecl, functionDecl->get_functionType() );
1708                }
1709
1710                TypedefDecl * Pass3::mutate( TypedefDecl *typedefDecl ) {
1711                        return handleDecl( typedefDecl, typedefDecl->get_base() );
1712                }
1713
1714                TypeDecl * Pass3::mutate( TypeDecl *typeDecl ) {
1715//   Initializer *init = 0;
1716//   std::list< Expression *> designators;
1717//   scopeTyVars[ typeDecl->get_name() ] = typeDecl->get_kind();
1718//   if ( typeDecl->get_base() ) {
1719//     init = new SimpleInit( new SizeofExpr( handleDecl( typeDecl, typeDecl->get_base() ) ), designators );
1720//   }
1721//   return new ObjectDecl( typeDecl->get_name(), Declaration::Extern, LinkageSpec::C, 0, new BasicType( Type::Qualifiers(), BasicType::UnsignedInt ), init );
1722
1723                        scopeTyVars[ typeDecl->get_name() ] = typeDecl->get_kind();
1724                        return Mutator::mutate( typeDecl );
1725                }
1726
1727                Type * Pass3::mutate( PointerType *pointerType ) {
1728                        TyVarMap oldtyVars = scopeTyVars;
1729                        makeTyVarMap( pointerType, scopeTyVars );
1730
1731                        Type *ret = Mutator::mutate( pointerType );
1732
1733                        scopeTyVars = oldtyVars;
1734                        return ret;
1735                }
1736
1737                Type * Pass3::mutate( FunctionType *functionType ) {
1738                        TyVarMap oldtyVars = scopeTyVars;
1739                        makeTyVarMap( functionType, scopeTyVars );
1740
1741                        Type *ret = Mutator::mutate( functionType );
1742
1743                        scopeTyVars = oldtyVars;
1744                        return ret;
1745                }
1746        } // anonymous namespace
1747} // namespace GenPoly
1748
1749// Local Variables: //
1750// tab-width: 4 //
1751// mode: c++ //
1752// compile-command: "make install" //
1753// End: //
Note: See TracBrowser for help on using the repository browser.