source: src/GenPoly/Box.cc @ d9fa60a

aaron-thesisarm-ehcleanup-dtorsdeferred_resndemanglerjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-exprnew-envno_listpersistent-indexerresolv-newwith_gc
Last change on this file since d9fa60a was d9fa60a, checked in by Rob Schluntz <rschlunt@…>, 5 years ago

moved substituion into MemberExpr? constructor, change generated tuple structs to generic structs, tuples containing type variables almost works

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