source: src/InitTweak/FixInit.cc @ ae1b9ea

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

Always copy construct arguments that require boxing

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