source: src/InitTweak/FixInit.cc @ 08da53d

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

Refactor findSingleExpr and remove unnecessary resolver-generated casts

  • Property mode set to 100644
File size: 51.0 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// FixInit.h --
8//
9// Author           : Rob Schluntz
10// Created On       : Wed Jan 13 16:29:30 2016
11// Last Modified By : Peter A. Buhr
12// Last Modified On : Wed Jun 21 17:35:05 2017
13// Update Count     : 74
14//
15#include "FixInit.h"
16
17#include <stddef.h>                    // for NULL
18#include <algorithm>                   // for set_difference, copy_if
19#include <cassert>                     // for assert, strict_dynamic_cast
20#include <iostream>                    // for operator<<, ostream, basic_ost...
21#include <iterator>                    // for insert_iterator, back_inserter
22#include <list>                        // for _List_iterator, list, list<>::...
23#include <map>                         // for _Rb_tree_iterator, _Rb_tree_co...
24#include <memory>                      // for allocator_traits<>::value_type
25#include <set>                         // for set, set<>::value_type
26#include <unordered_map>               // for unordered_map, unordered_map<>...
27#include <unordered_set>               // for unordered_set
28#include <utility>                     // for pair
29
30#include "CodeGen/GenType.h"           // for genPrettyType
31#include "CodeGen/OperatorTable.h"
32#include "Common/PassVisitor.h"        // for PassVisitor, WithStmtsToAdd
33#include "Common/SemanticError.h"      // for SemanticError
34#include "Common/UniqueName.h"         // for UniqueName
35#include "Common/utility.h"            // for CodeLocation, ValueGuard, toSt...
36#include "FixGlobalInit.h"             // for fixGlobalInit
37#include "GenInit.h"                   // for genCtorDtor
38#include "GenPoly/GenPoly.h"           // for getFunctionType
39#include "InitTweak.h"                 // for getFunctionName, getCallArg
40#include "Parser/LinkageSpec.h"        // for C, Spec, Cforall, isBuiltin
41#include "ResolvExpr/Resolver.h"       // for findVoidExpression
42#include "ResolvExpr/typeops.h"        // for typesCompatible
43#include "SymTab/Autogen.h"            // for genImplicitCall
44#include "SymTab/Indexer.h"            // for Indexer
45#include "SymTab/Mangler.h"            // for Mangler
46#include "SynTree/Attribute.h"         // for Attribute
47#include "SynTree/Constant.h"          // for Constant
48#include "SynTree/Declaration.h"       // for ObjectDecl, FunctionDecl, Decl...
49#include "SynTree/Expression.h"        // for UniqueExpr, VariableExpr, Unty...
50#include "SynTree/Initializer.h"       // for ConstructorInit, SingleInit
51#include "SynTree/Label.h"             // for Label, noLabels, operator<
52#include "SynTree/Mutator.h"           // for mutateAll, Mutator, maybeMutate
53#include "SynTree/Statement.h"         // for ExprStmt, CompoundStmt, Branch...
54#include "SynTree/Type.h"              // for Type, Type::StorageClasses
55#include "SynTree/TypeSubstitution.h"  // for TypeSubstitution, operator<<
56#include "SynTree/Visitor.h"           // for acceptAll, maybeAccept
57
58bool ctordtorp = false; // print all debug
59bool ctorp = false; // print ctor debug
60bool cpctorp = false; // print copy ctor debug
61bool dtorp = false; // print dtor debug
62#define PRINT( text ) if ( ctordtorp ) { text }
63#define CP_CTOR_PRINT( text ) if ( ctordtorp || cpctorp ) { text }
64#define DTOR_PRINT( text ) if ( ctordtorp || dtorp ) { text }
65
66namespace InitTweak {
67        namespace {
68                typedef std::unordered_map< int, int > UnqCount;
69
70                struct InsertImplicitCalls : public WithTypeSubstitution {
71                        /// wrap function application expressions as ImplicitCopyCtorExpr nodes so that it is easy to identify which
72                        /// function calls need their parameters to be copy constructed
73                        static void insert( std::list< Declaration * > & translationUnit );
74
75                        Expression * postmutate( ApplicationExpr * appExpr );
76                };
77
78                struct ResolveCopyCtors final : public WithIndexer, public WithShortCircuiting, public WithTypeSubstitution {
79                        /// generate temporary ObjectDecls for each argument and return value of each ImplicitCopyCtorExpr,
80                        /// generate/resolve copy construction expressions for each, and generate/resolve destructors for both
81                        /// arguments and return value temporaries
82                        static void resolveImplicitCalls( std::list< Declaration * > & translationUnit, UnqCount & unqCount );
83
84                        ResolveCopyCtors( UnqCount & unqCount ) : unqCount( unqCount ) {}
85
86                        void postvisit( ImplicitCopyCtorExpr * impCpCtorExpr );
87                        void postvisit( StmtExpr * stmtExpr );
88                        void previsit( UniqueExpr * unqExpr );
89                        void postvisit( UniqueExpr * unqExpr );
90
91                        /// create and resolve ctor/dtor expression: fname(var, [cpArg])
92                        Expression * makeCtorDtor( const std::string & fname, ObjectDecl * var, Expression * cpArg = NULL );
93                        /// true if type does not need to be copy constructed to ensure correctness
94                        bool skipCopyConstruct( Type * type );
95                        void copyConstructArg( Expression *& arg, ImplicitCopyCtorExpr * impCpCtorExpr );
96                        void destructRet( ObjectDecl * ret, ImplicitCopyCtorExpr * impCpCtorExpr );
97
98                        UnqCount & unqCount; // count the number of times each unique expr ID appears
99                        std::unordered_set< int > vars;
100                };
101
102                /// collects constructed object decls - used as a base class
103                struct ObjDeclCollector : public WithGuards, public WithShortCircuiting {
104                        // use ordered data structure to maintain ordering for set_difference and for consistent error messages
105                        typedef std::list< ObjectDecl * > ObjectSet;
106                        void previsit( CompoundStmt *compoundStmt );
107                        void previsit( DeclStmt *stmt );
108
109                        // don't go into other functions
110                        void previsit( FunctionDecl * ) { visit_children = false; }
111
112                  protected:
113                        ObjectSet curVars;
114                };
115
116                // debug
117                template<typename ObjectSet>
118                struct PrintSet {
119                        PrintSet( const ObjectSet & objs ) : objs( objs ) {}
120                        const ObjectSet & objs;
121                };
122                template<typename ObjectSet>
123                PrintSet<ObjectSet> printSet( const ObjectSet & objs ) { return PrintSet<ObjectSet>( objs ); }
124                template<typename ObjectSet>
125                std::ostream & operator<<( std::ostream & out, const PrintSet<ObjectSet> & set) {
126                        out << "{ ";
127                        for ( ObjectDecl * obj : set.objs ) {
128                                out << obj->get_name() << ", " ;
129                        } // for
130                        out << " }";
131                        return out;
132                }
133
134                struct LabelFinder final : public ObjDeclCollector {
135                        typedef std::map< Label, ObjectSet > LabelMap;
136                        // map of Label -> live variables at that label
137                        LabelMap vars;
138
139                        typedef ObjDeclCollector Parent;
140                        using Parent::previsit;
141                        void previsit( Statement * stmt );
142
143                        void previsit( CompoundStmt *compoundStmt );
144                        void previsit( DeclStmt *stmt );
145                };
146
147                struct InsertDtors final : public ObjDeclCollector, public WithStmtsToAdd {
148                        /// insert destructor calls at the appropriate places.  must happen before CtorInit nodes are removed
149                        /// (currently by FixInit)
150                        static void insert( std::list< Declaration * > & translationUnit );
151
152                        typedef std::list< ObjectDecl * > OrderedDecls;
153                        typedef std::list< OrderedDecls > OrderedDeclsStack;
154
155                        InsertDtors( PassVisitor<LabelFinder> & finder ) : finder( finder ), labelVars( finder.pass.vars ) {}
156
157                        typedef ObjDeclCollector Parent;
158                        using Parent::previsit;
159
160                        void previsit( ObjectDecl * objDecl );
161                        void previsit( FunctionDecl * funcDecl );
162
163                        void previsit( CompoundStmt * compoundStmt );
164                        void postvisit( CompoundStmt * compoundStmt );
165                        void previsit( ReturnStmt * returnStmt );
166                        void previsit( BranchStmt * stmt );
167                private:
168                        void handleGoto( BranchStmt * stmt );
169
170                        PassVisitor<LabelFinder> & finder;
171                        LabelFinder::LabelMap & labelVars;
172                        OrderedDeclsStack reverseDeclOrder;
173                };
174
175                class FixInit : public WithStmtsToAdd {
176                  public:
177                        /// expand each object declaration to use its constructor after it is declared.
178                        static void fixInitializers( std::list< Declaration * > &translationUnit );
179
180                        DeclarationWithType * postmutate( ObjectDecl *objDecl );
181
182                        std::list< Declaration * > staticDtorDecls;
183                };
184
185                class FixCopyCtors final : public WithStmtsToAdd, public WithShortCircuiting, public WithVisitorRef<FixCopyCtors> {
186                  public:
187                        FixCopyCtors( UnqCount & unqCount ) : unqCount( unqCount ){}
188                        /// expand ImplicitCopyCtorExpr nodes into the temporary declarations, copy constructors, call expression,
189                        /// and destructors
190                        static void fixCopyCtors( std::list< Declaration * > &translationUnit, UnqCount & unqCount );
191
192                        Expression * postmutate( ImplicitCopyCtorExpr * impCpCtorExpr );
193                        void premutate( StmtExpr * stmtExpr );
194                        void premutate( UniqueExpr * unqExpr );
195
196                        UnqCount & unqCount;
197                };
198
199                struct GenStructMemberCalls final : public WithGuards, public WithShortCircuiting, public WithIndexer {
200                        /// generate default/copy ctor and dtor calls for user-defined struct ctor/dtors
201                        /// for any member that is missing a corresponding ctor/dtor call.
202                        /// error if a member is used before constructed
203                        static void generate( std::list< Declaration * > & translationUnit );
204
205                        void previsit( FunctionDecl * funcDecl );
206                        void postvisit( FunctionDecl * funcDecl );
207
208                        void previsit( MemberExpr * memberExpr );
209                        void previsit( ApplicationExpr * appExpr );
210
211                        SemanticError errors;
212                  private:
213                        template< typename... Params >
214                        void emit( CodeLocation, const Params &... params );
215
216                        FunctionDecl * function = nullptr;
217                        std::set< DeclarationWithType * > unhandled;
218                        std::map< DeclarationWithType *, CodeLocation > usedUninit;
219                        ObjectDecl * thisParam = nullptr;
220                        bool isCtor = false; // true if current function is a constructor
221                        StructDecl * structDecl = nullptr;
222                };
223
224                // very simple resolver-like mutator class - used to
225                // resolve UntypedExprs that are found within newly
226                // generated constructor/destructor calls
227                class MutatingResolver final : public Mutator {
228                  public:
229                        MutatingResolver( SymTab::Indexer & indexer ) : indexer( indexer ) {}
230
231                        using Mutator::mutate;
232                        virtual DeclarationWithType* mutate( ObjectDecl *objectDecl ) override;
233                        virtual Expression* mutate( UntypedExpr *untypedExpr ) override;
234
235                  private:
236                        SymTab::Indexer & indexer;
237                };
238
239                struct FixCtorExprs final : public WithDeclsToAdd, public WithIndexer {
240                        /// expands ConstructorExpr nodes into comma expressions, using a temporary for the first argument
241                        static void fix( std::list< Declaration * > & translationUnit );
242
243                        Expression * postmutate( ConstructorExpr * ctorExpr );
244                };
245        } // namespace
246
247        void fix( std::list< Declaration * > & translationUnit, const std::string & filename, bool inLibrary ) {
248                // fixes ConstructorInit for global variables. should happen before fixInitializers.
249                InitTweak::fixGlobalInit( translationUnit, filename, inLibrary );
250
251                UnqCount unqCount;
252
253                InsertImplicitCalls::insert( translationUnit );
254                ResolveCopyCtors::resolveImplicitCalls( translationUnit, unqCount );
255                InsertDtors::insert( translationUnit );
256                FixInit::fixInitializers( translationUnit );
257
258                // FixCopyCtors must happen after FixInit, so that destructors are placed correctly
259                FixCopyCtors::fixCopyCtors( translationUnit, unqCount );
260
261                GenStructMemberCalls::generate( translationUnit );
262                // xxx - ctor expansion currently has to be after FixCopyCtors, because there is currently a
263                // hack in the way untyped assignments are generated, where the first argument cannot have
264                // its address taken because of the way codegeneration handles UntypedExpr vs. ApplicationExpr.
265                // Thus such assignment exprs must never pushed through expression resolution (and thus should
266                // not go through the FixCopyCtors pass), otherwise they will fail -- guaranteed.
267                // Also needs to happen after GenStructMemberCalls, since otherwise member constructors exprs
268                // don't look right, and a member can be constructed more than once.
269                FixCtorExprs::fix( translationUnit );
270        }
271
272        namespace {
273                void InsertImplicitCalls::insert( std::list< Declaration * > & translationUnit ) {
274                        PassVisitor<InsertImplicitCalls> inserter;
275                        mutateAll( translationUnit, inserter );
276                }
277
278                void ResolveCopyCtors::resolveImplicitCalls( std::list< Declaration * > & translationUnit, UnqCount & unqCount ) {
279                        PassVisitor<ResolveCopyCtors> resolver( unqCount );
280                        acceptAll( translationUnit, resolver );
281                }
282
283                void FixInit::fixInitializers( std::list< Declaration * > & translationUnit ) {
284                        PassVisitor<FixInit> fixer;
285
286                        // can't use mutateAll, because need to insert declarations at top-level
287                        // can't use DeclMutator, because sometimes need to insert IfStmt, etc.
288                        SemanticError errors;
289                        for ( std::list< Declaration * >::iterator i = translationUnit.begin(); i != translationUnit.end(); ++i ) {
290                                try {
291                                        maybeMutate( *i, fixer );
292                                        translationUnit.splice( i, fixer.pass.staticDtorDecls );
293                                } catch( SemanticError &e ) {
294                                        e.set_location( (*i)->location );
295                                        errors.append( e );
296                                } // try
297                        } // for
298                        if ( ! errors.isEmpty() ) {
299                                throw errors;
300                        } // if
301                }
302
303                void InsertDtors::insert( std::list< Declaration * > & translationUnit ) {
304                        PassVisitor<LabelFinder> finder;
305                        PassVisitor<InsertDtors> inserter( finder );
306                        acceptAll( translationUnit, inserter );
307                }
308
309                void FixCopyCtors::fixCopyCtors( std::list< Declaration * > & translationUnit, UnqCount & unqCount ) {
310                        PassVisitor<FixCopyCtors> fixer( unqCount );
311                        mutateAll( translationUnit, fixer );
312                }
313
314                void GenStructMemberCalls::generate( std::list< Declaration * > & translationUnit ) {
315                        PassVisitor<GenStructMemberCalls> warner;
316                        acceptAll( translationUnit, warner );
317                }
318
319                void FixCtorExprs::fix( std::list< Declaration * > & translationUnit ) {
320                        PassVisitor<FixCtorExprs> fixer;
321                        mutateAll( translationUnit, fixer );
322                }
323
324                Expression * InsertImplicitCalls::postmutate( ApplicationExpr * appExpr ) {
325                        assert( appExpr );
326
327                        if ( VariableExpr * function = dynamic_cast< VariableExpr * > ( appExpr->get_function() ) ) {
328                                if ( LinkageSpec::isBuiltin( function->get_var()->get_linkage() ) ) {
329                                        // optimization: don't need to copy construct in order to call intrinsic functions
330                                        return appExpr;
331                                } else if ( DeclarationWithType * funcDecl = dynamic_cast< DeclarationWithType * > ( function->get_var() ) ) {
332                                        FunctionType * ftype = dynamic_cast< FunctionType * >( GenPoly::getFunctionType( funcDecl->get_type() ) );
333                                        assertf( ftype, "Function call without function type: %s", toString( funcDecl ).c_str() );
334                                        if ( CodeGen::isConstructor( funcDecl->get_name() ) && ftype->get_parameters().size() == 2 ) {
335                                                Type * t1 = getPointerBase( ftype->get_parameters().front()->get_type() );
336                                                Type * t2 = ftype->get_parameters().back()->get_type();
337                                                assert( t1 );
338
339                                                if ( ResolvExpr::typesCompatible( t1, t2, SymTab::Indexer() ) ) {
340                                                        // optimization: don't need to copy construct in order to call a copy constructor
341                                                        return appExpr;
342                                                } // if
343                                        } else if ( CodeGen::isDestructor( funcDecl->get_name() ) ) {
344                                                // correctness: never copy construct arguments to a destructor
345                                                return appExpr;
346                                        } // if
347                                } // if
348                        } // if
349                        CP_CTOR_PRINT( std::cerr << "InsertImplicitCalls: adding a wrapper " << appExpr << std::endl; )
350
351                        // wrap each function call so that it is easy to identify nodes that have to be copy constructed
352                        ImplicitCopyCtorExpr * expr = new ImplicitCopyCtorExpr( appExpr );
353                        // Move the type substitution to the new top-level, if it is attached to the appExpr.
354                        // Ensure it is not deleted with the ImplicitCopyCtorExpr by removing it before deletion.
355                        // The substitution is needed to obtain the type of temporary variables so that copy constructor
356                        // calls can be resolved.
357                        assert( env );
358                        std::swap( expr->env, appExpr->env );
359                        return expr;
360                }
361
362                bool ResolveCopyCtors::skipCopyConstruct( Type * type ) { return ! isConstructable( type ); }
363
364                Expression * ResolveCopyCtors::makeCtorDtor( const std::string & fname, ObjectDecl * var, Expression * cpArg ) {
365                        assert( var );
366                        // arrays are not copy constructed, so this should always be an ExprStmt
367                        ImplicitCtorDtorStmt * stmt = genCtorDtor( fname, var, cpArg );
368                        ExprStmt * exprStmt = strict_dynamic_cast< ExprStmt * >( stmt->get_callStmt() );
369                        Expression * resolved = exprStmt->expr;
370                        exprStmt->expr = nullptr; // take ownership of expr
371
372                        // resolve copy constructor
373                        // should only be one alternative for copy ctor and dtor expressions, since all arguments are fixed
374                        // (VariableExpr and already resolved expression)
375                        CP_CTOR_PRINT( std::cerr << "ResolvingCtorDtor " << resolved << std::endl; )
376                        ResolvExpr::findVoidExpression( resolved, indexer );
377                        assert( resolved );
378                        if ( resolved->get_env() ) {
379                                // Extract useful information and discard new environments. Keeping them causes problems in PolyMutator passes.
380                                env->add( *resolved->get_env() );
381                                delete resolved->get_env();
382                                resolved->set_env( nullptr );
383                        } // if
384                        delete stmt;
385                        return resolved;
386                }
387
388                void ResolveCopyCtors::copyConstructArg( Expression *& arg, ImplicitCopyCtorExpr * impCpCtorExpr ) {
389                        static UniqueName tempNamer("_tmp_cp");
390                        assert( env );
391                        CP_CTOR_PRINT( std::cerr << "Type Substitution: " << *env << std::endl; )
392                        assert( arg->result );
393                        Type * result = arg->get_result();
394                        if ( skipCopyConstruct( result ) ) return; // skip certain non-copyable types
395
396                        // type may involve type variables, so apply type substitution to get temporary variable's actual type
397                        result = result->clone();
398                        env->apply( result );
399                        ObjectDecl * tmp = ObjectDecl::newObject( "__tmp", result, nullptr );
400                        tmp->get_type()->set_const( false );
401
402                        // create and resolve copy constructor
403                        CP_CTOR_PRINT( std::cerr << "makeCtorDtor for an argument" << std::endl; )
404                        Expression * cpCtor = makeCtorDtor( "?{}", tmp, arg );
405
406                        if ( ApplicationExpr * appExpr = dynamic_cast< ApplicationExpr * >( cpCtor ) ) {
407                                // if the chosen constructor is intrinsic, the copy is unnecessary, so
408                                // don't create the temporary and don't call the copy constructor
409                                VariableExpr * function = dynamic_cast< VariableExpr * >( appExpr->get_function() );
410                                assert( function );
411                                if ( function->get_var()->get_linkage() == LinkageSpec::Intrinsic ) return;
412                        }
413
414                        // set a unique name for the temporary once it's certain the call is necessary
415                        tmp->name = tempNamer.newName();
416
417                        // replace argument to function call with temporary
418                        arg = new CommaExpr( cpCtor, new VariableExpr( tmp ) );
419                        impCpCtorExpr->get_tempDecls().push_back( tmp );
420                        impCpCtorExpr->get_dtors().push_front( makeCtorDtor( "^?{}", tmp ) );
421                }
422
423                void ResolveCopyCtors::destructRet( ObjectDecl * ret, ImplicitCopyCtorExpr * impCpCtorExpr ) {
424                        impCpCtorExpr->get_dtors().push_front( makeCtorDtor( "^?{}", ret ) );
425                }
426
427                void ResolveCopyCtors::postvisit( ImplicitCopyCtorExpr *impCpCtorExpr ) {
428                        CP_CTOR_PRINT( std::cerr << "ResolveCopyCtors: " << impCpCtorExpr << std::endl; )
429
430                        ApplicationExpr * appExpr = impCpCtorExpr->get_callExpr();
431
432                        // take each argument and attempt to copy construct it.
433                        for ( Expression * & arg : appExpr->get_args() ) {
434                                copyConstructArg( arg, impCpCtorExpr );
435                        } // for
436
437                        // each return value from the call needs to be connected with an ObjectDecl at the call site, which is
438                        // initialized with the return value and is destructed later
439                        // xxx - handle named return values?
440                        Type * result = appExpr->get_result();
441                        if ( ! result->isVoid() ) {
442                                static UniqueName retNamer("_tmp_cp_ret");
443                                result = result->clone();
444                                env->apply( result );
445                                ObjectDecl * ret = ObjectDecl::newObject( retNamer.newName(), result, nullptr );
446                                ret->get_type()->set_const( false );
447                                impCpCtorExpr->get_returnDecls().push_back( ret );
448                                CP_CTOR_PRINT( std::cerr << "makeCtorDtor for a return" << std::endl; )
449                                if ( ! dynamic_cast< ReferenceType * >( result ) ) {
450                                        // destructing reference returns is bad because it can cause multiple destructor calls to the same object - the returned object is not a temporary
451                                        destructRet( ret, impCpCtorExpr );
452                                }
453                        } // for
454                        CP_CTOR_PRINT( std::cerr << "after Resolving: " << impCpCtorExpr << std::endl; )
455                }
456
457                void ResolveCopyCtors::postvisit( StmtExpr * stmtExpr ) {
458                        assert( env );
459                        assert( stmtExpr->get_result() );
460                        Type * result = stmtExpr->get_result();
461                        if ( ! result->isVoid() ) {
462                                static UniqueName retNamer("_tmp_stmtexpr_ret");
463
464                                // create variable that will hold the result of the stmt expr
465                                result = result->clone();
466                                env->apply( result );
467                                ObjectDecl * ret = ObjectDecl::newObject( retNamer.newName(), result, nullptr );
468                                ret->get_type()->set_const( false );
469                                stmtExpr->get_returnDecls().push_front( ret );
470
471                                // must have a non-empty body, otherwise it wouldn't have a result
472                                CompoundStmt * body = stmtExpr->get_statements();
473                                assert( ! body->get_kids().empty() );
474                                // must be an ExprStmt, otherwise it wouldn't have a result
475                                ExprStmt * last = strict_dynamic_cast< ExprStmt * >( body->get_kids().back() );
476                                last->set_expr( makeCtorDtor( "?{}", ret, last->get_expr() ) );
477
478                                stmtExpr->get_dtors().push_front( makeCtorDtor( "^?{}", ret ) );
479                        } // if
480                }
481
482                void ResolveCopyCtors::previsit( UniqueExpr * unqExpr ) {
483                        unqCount[ unqExpr->get_id() ]++;  // count the number of unique expressions for each ID
484                        if ( vars.count( unqExpr->get_id() ) ) {
485                                // xxx - hack to prevent double-handling of unique exprs, otherwise too many temporary variables and destructors are generated
486                                visit_children = false;
487                        }
488                }
489
490                void ResolveCopyCtors::postvisit( UniqueExpr * unqExpr ) {
491                        if ( vars.count( unqExpr->get_id() ) ) {
492                                // xxx - hack to prevent double-handling of unique exprs, otherwise too many temporary variables and destructors are generated
493                                return;
494                        }
495
496                        // it should never be necessary to wrap a void-returning expression in a UniqueExpr - if this assumption changes, this needs to be rethought
497                        assert( unqExpr->get_result() );
498                        if ( ImplicitCopyCtorExpr * impCpCtorExpr = dynamic_cast<ImplicitCopyCtorExpr*>( unqExpr->get_expr() ) ) {
499                                // note the variable used as the result from the call
500                                assert( impCpCtorExpr->get_result() && impCpCtorExpr->get_returnDecls().size() == 1 );
501                                unqExpr->set_var( new VariableExpr( impCpCtorExpr->get_returnDecls().front() ) );
502                        } else {
503                                // expr isn't a call expr, so create a new temporary variable to use to hold the value of the unique expression
504                                unqExpr->set_object( ObjectDecl::newObject( toString("_unq", unqExpr->get_id()), unqExpr->get_result()->clone(), nullptr ) );
505                                unqExpr->set_var( new VariableExpr( unqExpr->get_object() ) );
506                        }
507                        vars.insert( unqExpr->get_id() );
508                }
509
510                Expression * FixCopyCtors::postmutate( ImplicitCopyCtorExpr * impCpCtorExpr ) {
511                        CP_CTOR_PRINT( std::cerr << "FixCopyCtors: " << impCpCtorExpr << std::endl; )
512
513                        std::list< ObjectDecl * > & tempDecls = impCpCtorExpr->get_tempDecls();
514                        std::list< ObjectDecl * > & returnDecls = impCpCtorExpr->get_returnDecls();
515                        std::list< Expression * > & dtors = impCpCtorExpr->get_dtors();
516
517                        // add all temporary declarations and their constructors
518                        for ( ObjectDecl * obj : tempDecls ) {
519                                stmtsToAddBefore.push_back( new DeclStmt( noLabels, obj ) );
520                        } // for
521                        for ( ObjectDecl * obj : returnDecls ) {
522                                stmtsToAddBefore.push_back( new DeclStmt( noLabels, obj ) );
523                        } // for
524
525                        // add destructors after current statement
526                        for ( Expression * dtor : dtors ) {
527                                stmtsToAddAfter.push_back( new ExprStmt( noLabels, dtor ) );
528                        } // for
529
530                        ObjectDecl * returnDecl = returnDecls.empty() ? nullptr : returnDecls.front();
531                        Expression * callExpr = impCpCtorExpr->get_callExpr();
532
533                        CP_CTOR_PRINT( std::cerr << "Coming out the back..." << impCpCtorExpr << std::endl; )
534
535                        // detach fields from wrapper node so that it can be deleted without deleting too much
536                        dtors.clear();
537                        tempDecls.clear();
538                        returnDecls.clear();
539                        impCpCtorExpr->set_callExpr( nullptr );
540                        std::swap( impCpCtorExpr->env, callExpr->env );
541                        assert( impCpCtorExpr->env == nullptr );
542                        delete impCpCtorExpr;
543
544                        if ( returnDecl ) {
545                                UntypedExpr * assign = new UntypedExpr( new NameExpr( "?=?" ) );
546                                assign->get_args().push_back( new VariableExpr( returnDecl ) );
547                                assign->get_args().push_back( callExpr );
548                                // know the result type of the assignment is the type of the LHS (minus the pointer), so
549                                // add that onto the assignment expression so that later steps have the necessary information
550                                assign->set_result( returnDecl->get_type()->clone() );
551
552                                Expression * retExpr = new CommaExpr( assign, new VariableExpr( returnDecl ) );
553                                // move env from callExpr to retExpr
554                                std::swap( retExpr->env, callExpr->env );
555                                return retExpr;
556                        } else {
557                                return callExpr;
558                        } // if
559                }
560
561                void FixCopyCtors::premutate( StmtExpr * stmtExpr ) {
562                        // function call temporaries should be placed at statement-level, rather than nested inside of a new statement expression,
563                        // since temporaries can be shared across sub-expressions, e.g.
564                        //   [A, A] f();
565                        //   g([A] x, [A] y);
566                        //   g(f());
567                        // f is executed once, so the return temporary is shared across the tuple constructors for x and y.
568                        // Explicitly mutating children instead of mutating the inner compound statment forces the temporaries to be added
569                        // to the outer context, rather than inside of the statement expression.
570                        visit_children = false;
571                        std::list< Statement * > & stmts = stmtExpr->get_statements()->get_kids();
572                        for ( Statement *& stmt : stmts ) {
573                                stmt = stmt->acceptMutator( *visitor );
574                        } // for
575                        assert( stmtExpr->get_result() );
576                        Type * result = stmtExpr->get_result();
577                        if ( ! result->isVoid() ) {
578                                for ( ObjectDecl * obj : stmtExpr->get_returnDecls() ) {
579                                        stmtsToAddBefore.push_back( new DeclStmt( noLabels, obj ) );
580                                } // for
581                                // add destructors after current statement
582                                for ( Expression * dtor : stmtExpr->get_dtors() ) {
583                                        stmtsToAddAfter.push_back( new ExprStmt( noLabels, dtor ) );
584                                } // for
585                                // must have a non-empty body, otherwise it wouldn't have a result
586                                assert( ! stmts.empty() );
587                                assert( ! stmtExpr->get_returnDecls().empty() );
588                                stmts.push_back( new ExprStmt( noLabels, new VariableExpr( stmtExpr->get_returnDecls().front() ) ) );
589                                stmtExpr->get_returnDecls().clear();
590                                stmtExpr->get_dtors().clear();
591                        }
592                        assert( stmtExpr->get_returnDecls().empty() );
593                        assert( stmtExpr->get_dtors().empty() );
594                }
595
596                void FixCopyCtors::premutate( UniqueExpr * unqExpr ) {
597                        visit_children = false;
598                        unqCount[ unqExpr->get_id() ]--;
599                        static std::unordered_map< int, std::list< Statement * > > dtors;
600                        static std::unordered_map< int, UniqueExpr * > unqMap;
601                        // has to be done to clean up ImplicitCopyCtorExpr nodes, even when this node was skipped in previous passes
602                        if ( unqMap.count( unqExpr->get_id() ) ) {
603                                // take data from other UniqueExpr to ensure consistency
604                                delete unqExpr->get_expr();
605                                unqExpr->set_expr( unqMap[unqExpr->get_id()]->get_expr()->clone() );
606                                delete unqExpr->get_result();
607                                unqExpr->set_result( maybeClone( unqExpr->get_expr()->get_result() ) );
608                                if ( unqCount[ unqExpr->get_id() ] == 0 ) {  // insert destructor after the last use of the unique expression
609                                        stmtsToAddAfter.splice( stmtsToAddAfter.end(), dtors[ unqExpr->get_id() ] );
610                                }
611                                return;
612                        }
613                        PassVisitor<FixCopyCtors> fixer( unqCount );
614                        unqExpr->set_expr( unqExpr->get_expr()->acceptMutator( fixer ) ); // stmtexprs contained should not be separately fixed, so this must occur after the lookup
615                        stmtsToAddBefore.splice( stmtsToAddBefore.end(), fixer.pass.stmtsToAddBefore );
616                        unqMap[unqExpr->get_id()] = unqExpr;
617                        if ( unqCount[ unqExpr->get_id() ] == 0 ) {  // insert destructor after the last use of the unique expression
618                                stmtsToAddAfter.splice( stmtsToAddAfter.end(), dtors[ unqExpr->get_id() ] );
619                        } else { // remember dtors for last instance of unique expr
620                                dtors[ unqExpr->get_id() ] = fixer.pass.stmtsToAddAfter;
621                        }
622                        return;
623                }
624
625                DeclarationWithType * FixInit::postmutate( ObjectDecl *objDecl ) {
626                        // since this removes the init field from objDecl, it must occur after children are mutated (i.e. postmutate)
627                        if ( ConstructorInit * ctorInit = dynamic_cast< ConstructorInit * >( objDecl->get_init() ) ) {
628                                // a decision should have been made by the resolver, so ctor and init are not both non-NULL
629                                assert( ! ctorInit->get_ctor() || ! ctorInit->get_init() );
630                                if ( Statement * ctor = ctorInit->get_ctor() ) {
631                                        if ( objDecl->get_storageClasses().is_static ) {
632                                                // originally wanted to take advantage of gcc nested functions, but
633                                                // we get memory errors with this approach. To remedy this, the static
634                                                // variable is hoisted when the destructor needs to be called.
635                                                //
636                                                // generate:
637                                                // static T __objName_static_varN;
638                                                // void __objName_dtor_atexitN() {
639                                                //   __dtor__...;
640                                                // }
641                                                // int f(...) {
642                                                //   ...
643                                                //   static bool __objName_uninitialized = true;
644                                                //   if (__objName_uninitialized) {
645                                                //     __ctor(__objName);
646                                                //     __objName_uninitialized = false;
647                                                //     atexit(__objName_dtor_atexitN);
648                                                //   }
649                                                //   ...
650                                                // }
651
652                                                static UniqueName dtorCallerNamer( "_dtor_atexit" );
653
654                                                // static bool __objName_uninitialized = true
655                                                BasicType * boolType = new BasicType( Type::Qualifiers(), BasicType::Bool );
656                                                SingleInit * boolInitExpr = new SingleInit( new ConstantExpr( Constant::from_int( 1 ) ) );
657                                                ObjectDecl * isUninitializedVar = new ObjectDecl( objDecl->get_mangleName() + "_uninitialized", Type::StorageClasses( Type::Static ), LinkageSpec::Cforall, 0, boolType, boolInitExpr );
658                                                isUninitializedVar->fixUniqueId();
659
660                                                // __objName_uninitialized = false;
661                                                UntypedExpr * setTrue = new UntypedExpr( new NameExpr( "?=?" ) );
662                                                setTrue->get_args().push_back( new VariableExpr( isUninitializedVar ) );
663                                                setTrue->get_args().push_back( new ConstantExpr( Constant::from_int( 0 ) ) );
664
665                                                // generate body of if
666                                                CompoundStmt * initStmts = new CompoundStmt( noLabels );
667                                                std::list< Statement * > & body = initStmts->get_kids();
668                                                body.push_back( ctor );
669                                                body.push_back( new ExprStmt( noLabels, setTrue ) );
670
671                                                // put it all together
672                                                IfStmt * ifStmt = new IfStmt( noLabels, new VariableExpr( isUninitializedVar ), initStmts, 0 );
673                                                stmtsToAddAfter.push_back( new DeclStmt( noLabels, isUninitializedVar ) );
674                                                stmtsToAddAfter.push_back( ifStmt );
675
676                                                Statement * dtor = ctorInit->get_dtor();
677                                                objDecl->set_init( nullptr );
678                                                ctorInit->set_ctor( nullptr );
679                                                ctorInit->set_dtor( nullptr );
680                                                if ( dtor ) {
681                                                        // if the object has a non-trivial destructor, have to
682                                                        // hoist it and the object into the global space and
683                                                        // call the destructor function with atexit.
684
685                                                        Statement * dtorStmt = dtor->clone();
686
687                                                        // void __objName_dtor_atexitN(...) {...}
688                                                        FunctionDecl * dtorCaller = new FunctionDecl( objDecl->get_mangleName() + dtorCallerNamer.newName(), Type::StorageClasses( Type::Static ), LinkageSpec::C, new FunctionType( Type::Qualifiers(), false ), new CompoundStmt( noLabels ) );
689                                                        dtorCaller->fixUniqueId();
690                                                        dtorCaller->get_statements()->push_back( dtorStmt );
691
692                                                        // atexit(dtor_atexit);
693                                                        UntypedExpr * callAtexit = new UntypedExpr( new NameExpr( "atexit" ) );
694                                                        callAtexit->get_args().push_back( new VariableExpr( dtorCaller ) );
695
696                                                        body.push_back( new ExprStmt( noLabels, callAtexit ) );
697
698                                                        // hoist variable and dtor caller decls to list of decls that will be added into global scope
699                                                        staticDtorDecls.push_back( objDecl );
700                                                        staticDtorDecls.push_back( dtorCaller );
701
702                                                        // need to rename object uniquely since it now appears
703                                                        // at global scope and there could be multiple function-scoped
704                                                        // static variables with the same name in different functions.
705                                                        // Note: it isn't sufficient to modify only the mangleName, because
706                                                        // then subsequent Indexer passes can choke on seeing the object's name
707                                                        // if another object has the same name and type. An unfortunate side-effect
708                                                        // of renaming the object is that subsequent NameExprs may fail to resolve,
709                                                        // but there shouldn't be any remaining past this point.
710                                                        static UniqueName staticNamer( "_static_var" );
711                                                        objDecl->set_name( objDecl->get_name() + staticNamer.newName() );
712                                                        objDecl->set_mangleName( SymTab::Mangler::mangle( objDecl ) );
713
714                                                        // xxx - temporary hack: need to return a declaration, but want to hoist the current object out of this scope
715                                                        // create a new object which is never used
716                                                        static UniqueName dummyNamer( "_dummy" );
717                                                        ObjectDecl * dummy = new ObjectDecl( dummyNamer.newName(), Type::StorageClasses( Type::Static ), LinkageSpec::Cforall, 0, new PointerType( Type::Qualifiers(), new VoidType( Type::Qualifiers() ) ), 0, std::list< Attribute * >{ new Attribute("unused") } );
718                                                        delete ctorInit;
719                                                        return dummy;
720                                                }
721                                        } else {
722                                                ImplicitCtorDtorStmt * implicit = strict_dynamic_cast< ImplicitCtorDtorStmt * > ( ctor );
723                                                ExprStmt * ctorStmt = dynamic_cast< ExprStmt * >( implicit->callStmt );
724                                                ApplicationExpr * ctorCall = nullptr;
725                                                if ( ctorStmt && (ctorCall = isIntrinsicCallExpr( ctorStmt->expr )) && ctorCall->get_args().size() == 2 ) {
726                                                        // clean up intrinsic copy constructor calls by making them into SingleInits
727                                                        objDecl->init = new SingleInit( ctorCall->args.back() );
728                                                        ctorCall->args.pop_back();
729                                                } else {
730                                                        stmtsToAddAfter.push_back( ctor );
731                                                        objDecl->init = nullptr;
732                                                        ctorInit->ctor = nullptr;
733                                                }
734                                        } // if
735                                } else if ( Initializer * init = ctorInit->init ) {
736                                        objDecl->init = init;
737                                        ctorInit->init = nullptr;
738                                } else {
739                                        // no constructor and no initializer, which is okay
740                                        objDecl->init = nullptr;
741                                } // if
742                                delete ctorInit;
743                        } // if
744                        return objDecl;
745                }
746
747                void ObjDeclCollector::previsit( CompoundStmt * ) {
748                        GuardValue( curVars );
749                }
750
751                void ObjDeclCollector::previsit( DeclStmt * stmt ) {
752                        // keep track of all variables currently in scope
753                        if ( ObjectDecl * objDecl = dynamic_cast< ObjectDecl * > ( stmt->get_decl() ) ) {
754                                curVars.push_back( objDecl );
755                        } // if
756                }
757
758                void LabelFinder::previsit( Statement * stmt ) {
759                        // for each label, remember the variables in scope at that label.
760                        for ( Label l : stmt->get_labels() ) {
761                                vars[l] = curVars;
762                        } // for
763                }
764
765                void LabelFinder::previsit( CompoundStmt * stmt ) {
766                        previsit( (Statement *)stmt );
767                        Parent::previsit( stmt );
768                }
769
770                void LabelFinder::previsit( DeclStmt * stmt ) {
771                        previsit( (Statement *)stmt );
772                        Parent::previsit( stmt );
773                }
774
775
776                template<typename Iterator, typename OutputIterator>
777                void insertDtors( Iterator begin, Iterator end, OutputIterator out ) {
778                        for ( Iterator it = begin ; it != end ; ++it ) {
779                                // extract destructor statement from the object decl and insert it into the output. Note that this is
780                                // only called on lists of non-static objects with implicit non-intrinsic dtors, so if the user manually
781                                // calls an intrinsic dtor then the call must (and will) still be generated since the argument may
782                                // contain side effects.
783                                ObjectDecl * objDecl = *it;
784                                ConstructorInit * ctorInit = dynamic_cast< ConstructorInit * >( objDecl->get_init() );
785                                assert( ctorInit && ctorInit->get_dtor() );
786                                *out++ = ctorInit->get_dtor()->clone();
787                        } // for
788                }
789
790                void InsertDtors::previsit( ObjectDecl * objDecl ) {
791                        // remember non-static destructed objects so that their destructors can be inserted later
792                        if ( ! objDecl->get_storageClasses().is_static ) {
793                                if ( ConstructorInit * ctorInit = dynamic_cast< ConstructorInit * >( objDecl->get_init() ) ) {
794                                        // a decision should have been made by the resolver, so ctor and init are not both non-NULL
795                                        assert( ! ctorInit->get_ctor() || ! ctorInit->get_init() );
796                                        Statement * dtor = ctorInit->get_dtor();
797                                        // don't need to call intrinsic dtor, because it does nothing, but
798                                        // non-intrinsic dtors must be called
799                                        if ( dtor && ! isIntrinsicSingleArgCallStmt( dtor ) ) {
800                                                // set dtor location to the object's location for error messages
801                                                ctorInit->dtor->location = objDecl->location;
802                                                reverseDeclOrder.front().push_front( objDecl );
803                                        } // if
804                                } // if
805                        } // if
806                }
807
808                void InsertDtors::previsit( FunctionDecl * funcDecl ) {
809                        // each function needs to have its own set of labels
810                        GuardValue( labelVars );
811                        labelVars.clear();
812                        // LabelFinder does not recurse into FunctionDecl, so need to visit
813                        // its children manually.
814                        maybeAccept( funcDecl->type, finder );
815                        maybeAccept( funcDecl->statements, finder );
816
817                        // all labels for this function have been collected, insert destructors as appropriate via implicit recursion.
818                }
819
820                void InsertDtors::previsit( CompoundStmt * compoundStmt ) {
821                        // visit statements - this will also populate reverseDeclOrder list.  don't want to dump all destructors
822                        // when block is left, just the destructors associated with variables defined in this block, so push a new
823                        // list to the top of the stack so that we can differentiate scopes
824                        reverseDeclOrder.push_front( OrderedDecls() );
825                        Parent::previsit( compoundStmt );
826                }
827
828                void InsertDtors::postvisit( CompoundStmt * compoundStmt ) {
829                        // add destructors for the current scope that we're exiting, unless the last statement is a return, which
830                        // causes unreachable code warnings
831                        std::list< Statement * > & statements = compoundStmt->get_kids();
832                        if ( ! statements.empty() && ! dynamic_cast< ReturnStmt * >( statements.back() ) ) {
833                                insertDtors( reverseDeclOrder.front().begin(), reverseDeclOrder.front().end(), back_inserter( statements ) );
834                        }
835                        reverseDeclOrder.pop_front();
836                }
837
838                void InsertDtors::previsit( ReturnStmt * ) {
839                        // return exits all scopes, so dump destructors for all scopes
840                        for ( OrderedDecls & od : reverseDeclOrder ) {
841                                insertDtors( od.begin(), od.end(), back_inserter( stmtsToAddBefore ) );
842                        } // for
843                }
844
845                // Handle break/continue/goto in the same manner as C++.  Basic idea: any objects that are in scope at the
846                // BranchStmt but not at the labelled (target) statement must be destructed.  If there are any objects in scope
847                // at the target location but not at the BranchStmt then those objects would be uninitialized so notify the user
848                // of the error.  See C++ Reference 6.6 Jump Statements for details.
849                void InsertDtors::handleGoto( BranchStmt * stmt ) {
850                        // can't do anything for computed goto
851                        if ( stmt->computedTarget ) return;
852
853                        assertf( stmt->get_target() != "", "BranchStmt missing a label: %s", toString( stmt ).c_str() );
854                        // S_L = lvars = set of objects in scope at label definition
855                        // S_G = curVars = set of objects in scope at goto statement
856                        ObjectSet & lvars = labelVars[ stmt->get_target() ];
857
858                        DTOR_PRINT(
859                                std::cerr << "at goto label: " << stmt->get_target().get_name() << std::endl;
860                                std::cerr << "S_G = " << printSet( curVars ) << std::endl;
861                                std::cerr << "S_L = " << printSet( lvars ) << std::endl;
862                        )
863
864                        ObjectSet diff;
865                        // S_L-S_G results in set of objects whose construction is skipped - it's an error if this set is non-empty
866                        std::set_difference( lvars.begin(), lvars.end(), curVars.begin(), curVars.end(), std::inserter( diff, diff.begin() ) );
867                        DTOR_PRINT(
868                                std::cerr << "S_L-S_G = " << printSet( diff ) << std::endl;
869                        )
870                        if ( ! diff.empty() ) {
871                                throw SemanticError( std::string("jump to label '") + stmt->get_target().get_name() + "' crosses initialization of " + (*diff.begin())->get_name() + " ", stmt );
872                        } // if
873                        // S_G-S_L results in set of objects that must be destructed
874                        diff.clear();
875                        std::set_difference( curVars.begin(), curVars.end(), lvars.begin(), lvars.end(), std::inserter( diff, diff.end() ) );
876                        DTOR_PRINT(
877                                std::cerr << "S_G-S_L = " << printSet( diff ) << std::endl;
878                        )
879                        if ( ! diff.empty() ) {
880                                // create an auxilliary set for fast lookup -- can't make diff a set, because diff ordering should be consistent for error messages.
881                                std::unordered_set<ObjectDecl *> needsDestructor( diff.begin(), diff.end() );
882
883                                // go through decl ordered list of objectdecl. for each element that occurs in diff, output destructor
884                                OrderedDecls ordered;
885                                for ( OrderedDecls & rdo : reverseDeclOrder ) {
886                                        // add elements from reverseDeclOrder into ordered if they occur in diff - it is key that this happens in reverse declaration order.
887                                        copy_if( rdo.begin(), rdo.end(), back_inserter( ordered ), [&]( ObjectDecl * objDecl ) { return needsDestructor.count( objDecl ); } );
888                                } // for
889                                insertDtors( ordered.begin(), ordered.end(), back_inserter( stmtsToAddBefore ) );
890                        } // if
891                }
892
893                void InsertDtors::previsit( BranchStmt * stmt ) {
894                        switch( stmt->get_type() ) {
895                          case BranchStmt::Continue:
896                          case BranchStmt::Break:
897                                // could optimize the break/continue case, because the S_L-S_G check is unnecessary (this set should
898                                // always be empty), but it serves as a small sanity check.
899                          case BranchStmt::Goto:
900                                handleGoto( stmt );
901                                break;
902                          default:
903                                assert( false );
904                        } // switch
905                }
906
907                bool checkWarnings( FunctionDecl * funcDecl ) {
908                        // only check for warnings if the current function is a user-defined
909                        // constructor or destructor
910                        if ( ! funcDecl ) return false;
911                        if ( ! funcDecl->get_statements() ) return false;
912                        return CodeGen::isCtorDtor( funcDecl->get_name() ) && ! LinkageSpec::isOverridable( funcDecl->get_linkage() );
913                }
914
915                void addIds( SymTab::Indexer & indexer, const std::list< DeclarationWithType * > & decls ) {
916                        for ( auto d : decls ) {
917                                indexer.addId( d );
918                        }
919                }
920
921                void addTypes( SymTab::Indexer & indexer, const std::list< TypeDecl * > & tds ) {
922                        for ( auto td : tds ) {
923                                indexer.addType( td );
924                                addIds( indexer, td->assertions );
925                        }
926                }
927
928                void GenStructMemberCalls::previsit( FunctionDecl * funcDecl ) {
929                        GuardValue( function );
930                        GuardValue( unhandled );
931                        GuardValue( usedUninit );
932                        GuardValue( thisParam );
933                        GuardValue( isCtor );
934                        GuardValue( structDecl );
935                        errors = SemanticError();  // clear previous errors
936
937                        // need to start with fresh sets
938                        unhandled.clear();
939                        usedUninit.clear();
940
941                        function = funcDecl;
942                        isCtor = CodeGen::isConstructor( function->get_name() );
943                        if ( checkWarnings( function ) ) {
944                                FunctionType * type = function->get_functionType();
945                                assert( ! type->get_parameters().empty() );
946                                thisParam = strict_dynamic_cast< ObjectDecl * >( type->get_parameters().front() );
947                                Type * thisType = getPointerBase( thisParam->get_type() );
948                                StructInstType * structType = dynamic_cast< StructInstType * >( thisType );
949                                if ( structType ) {
950                                        structDecl = structType->get_baseStruct();
951                                        for ( Declaration * member : structDecl->get_members() ) {
952                                                if ( ObjectDecl * field = dynamic_cast< ObjectDecl * >( member ) ) {
953                                                        // record all of the struct type's members that need to be constructed or
954                                                        // destructed by the end of the function
955                                                        unhandled.insert( field );
956                                                }
957                                        }
958                                }
959                        }
960                }
961
962                void GenStructMemberCalls::postvisit( FunctionDecl * funcDecl ) {
963                        // remove the unhandled objects from usedUninit, because a call is inserted
964                        // to handle them - only objects that are later constructed are used uninitialized.
965                        std::map< DeclarationWithType *, CodeLocation > diff;
966                        // need the comparator since usedUninit and unhandled have different types
967                        struct comp_t {
968                                typedef decltype(usedUninit)::value_type usedUninit_t;
969                                typedef decltype(unhandled)::value_type unhandled_t;
970                                bool operator()(usedUninit_t x, unhandled_t y) { return x.first < y; }
971                                bool operator()(unhandled_t x, usedUninit_t y) { return x < y.first; }
972                        } comp;
973                        std::set_difference( usedUninit.begin(), usedUninit.end(), unhandled.begin(), unhandled.end(), std::inserter( diff, diff.begin() ), comp );
974                        for ( auto p : diff ) {
975                                DeclarationWithType * member = p.first;
976                                CodeLocation loc = p.second;
977                                // xxx - make error message better by also tracking the location that the object is constructed at?
978                                emit( loc, "in ", CodeGen::genPrettyType( function->get_functionType(), function->get_name() ), ", field ", member->get_name(), " used before being constructed" );
979                        }
980
981                        if ( ! unhandled.empty() ) {
982                                // need to explicitly re-add function parameters to the indexer in order to resolve copy constructors
983                                auto guard = makeFuncGuard( [this]() { indexer.enterScope(); }, [this]() { indexer.leaveScope(); } );
984                                addTypes( indexer, function->type->forall );
985                                addIds( indexer, function->type->returnVals );
986                                addIds( indexer, function->type->parameters );
987
988                                // need to iterate through members in reverse in order for
989                                // ctor/dtor statements to come out in the right order
990                                for ( Declaration * member : reverseIterate( structDecl->get_members() ) ) {
991                                        DeclarationWithType * field = dynamic_cast< DeclarationWithType * >( member );
992                                        // skip non-DWT members
993                                        if ( ! field ) continue;
994                                        // skip non-constructable members
995                                        if ( ! tryConstruct( field ) ) continue;
996                                        // skip handled members
997                                        if ( ! unhandled.count( field ) ) continue;
998
999                                        // insert and resolve default/copy constructor call for each field that's unhandled
1000                                        std::list< Statement * > stmt;
1001                                        Expression * arg2 = 0;
1002                                        if ( isCopyConstructor( function ) ) {
1003                                                // if copy ctor, need to pass second-param-of-this-function.field
1004                                                std::list< DeclarationWithType * > & params = function->get_functionType()->get_parameters();
1005                                                assert( params.size() == 2 );
1006                                                arg2 = new MemberExpr( field, new VariableExpr( params.back() ) );
1007                                        }
1008                                        InitExpander srcParam( arg2 );
1009                                        // cast away reference type and construct field.
1010                                        Expression * thisExpr = new CastExpr( new VariableExpr( thisParam ), thisParam->get_type()->stripReferences()->clone() );
1011                                        Expression * memberDest = new MemberExpr( field, thisExpr );
1012                                        SymTab::genImplicitCall( srcParam, memberDest, function->get_name(), back_inserter( stmt ), field, isCtor );
1013
1014                                        assert( stmt.size() <= 1 );
1015                                        if ( stmt.size() == 1 ) {
1016                                                Statement * callStmt = stmt.front();
1017
1018                                                MutatingResolver resolver( indexer );
1019                                                try {
1020                                                        callStmt->acceptMutator( resolver );
1021                                                        if ( isCtor ) {
1022                                                                function->get_statements()->push_front( callStmt );
1023                                                        } else {
1024                                                                // destructor statements should be added at the end
1025                                                                function->get_statements()->push_back( callStmt );
1026                                                        }
1027                                                } catch ( SemanticError & error ) {
1028                                                        emit( funcDecl->location, "in ", CodeGen::genPrettyType( function->get_functionType(), function->get_name() ), ", field ", field->get_name(), " not explicitly ", isCtor ? "constructed" : "destructed",  " and no ", isCtor ? "default constructor" : "destructor", " found" );
1029                                                }
1030                                        }
1031                                }
1032                        }
1033                        if (! errors.isEmpty()) {
1034                                throw errors;
1035                        }
1036                }
1037
1038                /// true if expr is effectively just the 'this' parameter
1039                bool isThisExpression( Expression * expr, DeclarationWithType * thisParam ) {
1040                        // TODO: there are more complicated ways to pass 'this' to a constructor, e.g. &*, *&, etc.
1041                        if ( VariableExpr * varExpr = dynamic_cast< VariableExpr * >( expr ) ) {
1042                                return varExpr->get_var() == thisParam;
1043                        } else if ( CastExpr * castExpr = dynamic_cast< CastExpr * > ( expr ) ) {
1044                                return isThisExpression( castExpr->get_arg(), thisParam );
1045                        }
1046                        return false;
1047                }
1048
1049                /// returns a MemberExpr if expr is effectively just member access on the 'this' parameter, else nullptr
1050                MemberExpr * isThisMemberExpr( Expression * expr, DeclarationWithType * thisParam ) {
1051                        if ( MemberExpr * memberExpr = dynamic_cast< MemberExpr * >( expr ) ) {
1052                                if ( isThisExpression( memberExpr->get_aggregate(), thisParam ) ) {
1053                                        return memberExpr;
1054                                }
1055                        } else if ( CastExpr * castExpr = dynamic_cast< CastExpr * >( expr ) ) {
1056                                return isThisMemberExpr( castExpr->get_arg(), thisParam );
1057                        }
1058                        return nullptr;
1059                }
1060
1061                void GenStructMemberCalls::previsit( ApplicationExpr * appExpr ) {
1062                        if ( ! checkWarnings( function ) ) {
1063                                visit_children = false;
1064                                return;
1065                        }
1066
1067                        std::string fname = getFunctionName( appExpr );
1068                        if ( fname == function->get_name() ) {
1069                                // call to same kind of function
1070                                Expression * firstParam = appExpr->get_args().front();
1071
1072                                if ( isThisExpression( firstParam, thisParam ) ) {
1073                                        // if calling another constructor on thisParam, assume that function handles
1074                                        // all members - if it doesn't a warning will appear in that function.
1075                                        unhandled.clear();
1076                                } else if ( MemberExpr * memberExpr = isThisMemberExpr( firstParam, thisParam ) ) {
1077                                        // if first parameter is a member expression on the this parameter,
1078                                        // then remove the member from unhandled set.
1079                                        if ( isThisExpression( memberExpr->get_aggregate(), thisParam ) ) {
1080                                                unhandled.erase( memberExpr->get_member() );
1081                                        }
1082                                }
1083                        }
1084                }
1085
1086                void GenStructMemberCalls::previsit( MemberExpr * memberExpr ) {
1087                        if ( ! checkWarnings( function ) || ! isCtor ) {
1088                                visit_children = false;
1089                                return;
1090                        }
1091
1092                        if ( isThisExpression( memberExpr->get_aggregate(), thisParam ) ) {
1093                                if ( unhandled.count( memberExpr->get_member() ) ) {
1094                                        // emit a warning because a member was used before it was constructed
1095                                        usedUninit.insert( { memberExpr->get_member(), memberExpr->location } );
1096                                }
1097                        }
1098                }
1099
1100                template< typename Visitor, typename... Params >
1101                void error( Visitor & v, CodeLocation loc, const Params &... params ) {
1102                        SemanticError err( toString( params... ) );
1103                        err.set_location( loc );
1104                        v.errors.append( err );
1105                }
1106
1107                template< typename... Params >
1108                void GenStructMemberCalls::emit( CodeLocation loc, const Params &... params ) {
1109                        // toggle warnings vs. errors here.
1110                        // warn( params... );
1111                        error( *this, loc, params... );
1112                }
1113
1114                DeclarationWithType * MutatingResolver::mutate( ObjectDecl * objectDecl ) {
1115                        // add object to the indexer assumes that there will be no name collisions
1116                        // in generated code. If this changes, add mutate methods for entities with
1117                        // scope and call {enter,leave}Scope explicitly.
1118                        indexer.addId( objectDecl );
1119                        return objectDecl;
1120                }
1121
1122                Expression * MutatingResolver::mutate( UntypedExpr * untypedExpr ) {
1123                        Expression * newExpr = untypedExpr;
1124                        ResolvExpr::findVoidExpression( newExpr, indexer );
1125                        return newExpr;
1126                }
1127
1128                Expression * FixCtorExprs::postmutate( ConstructorExpr * ctorExpr ) {
1129                        static UniqueName tempNamer( "_tmp_ctor_expr" );
1130                        // xxx - is the size check necessary?
1131                        assert( ctorExpr->result && ctorExpr->get_result()->size() == 1 );
1132
1133                        // xxx - ideally we would reuse the temporary generated from the copy constructor passes from within firstArg if it exists and not generate a temporary if it's unnecessary.
1134                        ObjectDecl * tmp = ObjectDecl::newObject( tempNamer.newName(), ctorExpr->get_result()->clone(), nullptr );
1135                        declsToAddBefore.push_back( tmp );
1136
1137                        // xxx - this can be TupleAssignExpr now. Need to properly handle this case.
1138                        ApplicationExpr * callExpr = strict_dynamic_cast< ApplicationExpr * > ( ctorExpr->get_callExpr() );
1139                        TypeSubstitution * env = ctorExpr->get_env();
1140                        ctorExpr->set_callExpr( nullptr );
1141                        ctorExpr->set_env( nullptr );
1142                        delete ctorExpr;
1143
1144                        // build assignment and replace constructor's first argument with new temporary
1145                        Expression *& firstArg = callExpr->get_args().front();
1146                        Expression * assign = new UntypedExpr( new NameExpr( "?=?" ), { new AddressExpr( new VariableExpr( tmp ) ), new AddressExpr( firstArg ) } );
1147                        firstArg = new VariableExpr( tmp );
1148
1149                        // resolve assignment and dispose of new env
1150                        ResolvExpr::findVoidExpression( assign, indexer );
1151                        delete assign->env;
1152                        assign->env = nullptr;
1153
1154                        // for constructor expr:
1155                        //   T x;
1156                        //   x{};
1157                        // results in:
1158                        //   T x;
1159                        //   T & tmp;
1160                        //   &tmp = &x, ?{}(tmp), tmp
1161                        CommaExpr * commaExpr = new CommaExpr( assign, new CommaExpr( callExpr, new VariableExpr( tmp ) ) );
1162                        commaExpr->set_env( env );
1163                        return commaExpr;
1164                }
1165        } // namespace
1166} // namespace InitTweak
1167
1168// Local Variables: //
1169// tab-width: 4 //
1170// mode: c++ //
1171// compile-command: "make install" //
1172// End: //
Note: See TracBrowser for help on using the repository browser.