source: src/InitTweak/FixInit.cc @ f46bfd2f

ADTarm-ehast-experimentalenumforall-pointer-decayjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-exprpthread-emulationqualifiedEnum
Last change on this file since f46bfd2f was f46bfd2f, checked in by Thierry Delisle <tdelisle@…>, 6 years ago

Removed extraneous prints

  • Property mode set to 100644
File size: 55.7 KB
Line 
1//
2// Cforall Version 1.0.0 Copyright (C) 2015 University of Waterloo
3//
4// The contents of this file are covered under the licence agreement in the
5// file "LICENCE" distributed with Cforall.
6//
7// FixInit.cc --
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 Feb 13 18:15:56 2019
13// Update Count     : 76
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, 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/DeclReplacer.h"      // for DeclReplacer
57#include "SynTree/Visitor.h"           // for acceptAll, maybeAccept
58#include "Validate/FindSpecialDecls.h" // for dtorStmt, dtorStructDestroy
59
60bool ctordtorp = false; // print all debug
61bool ctorp = false; // print ctor debug
62bool cpctorp = false; // print copy ctor debug
63bool dtorp = false; // print dtor debug
64#define PRINT( text ) if ( ctordtorp ) { text }
65#define CP_CTOR_PRINT( text ) if ( ctordtorp || cpctorp ) { text }
66#define DTOR_PRINT( text ) if ( ctordtorp || dtorp ) { text }
67
68namespace InitTweak {
69        namespace {
70                struct SelfAssignChecker {
71                        void previsit( ApplicationExpr * appExpr );
72                };
73
74                struct StmtExprResult {
75                        static void link( std::list< Declaration * > & translationUnit );
76
77                        void previsit( StmtExpr * stmtExpr );
78                };
79
80                struct InsertImplicitCalls : public WithConstTypeSubstitution {
81                        /// wrap function application expressions as ImplicitCopyCtorExpr nodes so that it is easy to identify which
82                        /// function calls need their parameters to be copy constructed
83                        static void insert( std::list< Declaration * > & translationUnit );
84
85                        Expression * postmutate( ApplicationExpr * appExpr );
86                };
87
88                struct ResolveCopyCtors final : public WithStmtsToAdd, public WithIndexer, public WithShortCircuiting, public WithTypeSubstitution, public WithVisitorRef<ResolveCopyCtors> {
89                        /// generate temporary ObjectDecls for each argument and return value of each ImplicitCopyCtorExpr,
90                        /// generate/resolve copy construction expressions for each, and generate/resolve destructors for both
91                        /// arguments and return value temporaries
92                        static void resolveImplicitCalls( std::list< Declaration * > & translationUnit );
93
94                        Expression * postmutate( ImplicitCopyCtorExpr * impCpCtorExpr );
95                        void premutate( StmtExpr * stmtExpr );
96                        void premutate( UniqueExpr * unqExpr );
97
98                        /// create and resolve ctor/dtor expression: fname(var, [cpArg])
99                        Expression * makeCtorDtor( const std::string & fname, ObjectDecl * var, Expression * cpArg = NULL );
100                        /// true if type does not need to be copy constructed to ensure correctness
101                        bool skipCopyConstruct( Type * type );
102                        void copyConstructArg( Expression *& arg, ImplicitCopyCtorExpr * impCpCtorExpr, Type * formal );
103                        void destructRet( ObjectDecl * ret, ImplicitCopyCtorExpr * impCpCtorExpr, Expression *& arg );
104                };
105
106                /// collects constructed object decls - used as a base class
107                struct ObjDeclCollector : public WithGuards, public WithShortCircuiting {
108                        // use ordered data structure to maintain ordering for set_difference and for consistent error messages
109                        typedef std::list< ObjectDecl * > ObjectSet;
110                        void previsit( CompoundStmt *compoundStmt );
111                        void previsit( DeclStmt *stmt );
112
113                        // don't go into other functions
114                        void previsit( FunctionDecl * ) { visit_children = false; }
115
116                  protected:
117                        ObjectSet curVars;
118                };
119
120                // debug
121                template<typename ObjectSet>
122                struct PrintSet {
123                        PrintSet( const ObjectSet & objs ) : objs( objs ) {}
124                        const ObjectSet & objs;
125                };
126                template<typename ObjectSet>
127                PrintSet<ObjectSet> printSet( const ObjectSet & objs ) { return PrintSet<ObjectSet>( objs ); }
128                template<typename ObjectSet>
129                std::ostream & operator<<( std::ostream & out, const PrintSet<ObjectSet> & set) {
130                        out << "{ ";
131                        for ( ObjectDecl * obj : set.objs ) {
132                                out << obj->get_name() << ", " ;
133                        } // for
134                        out << " }";
135                        return out;
136                }
137
138                struct LabelFinder final : public ObjDeclCollector {
139                        typedef std::map< Label, ObjectSet > LabelMap;
140                        // map of Label -> live variables at that label
141                        LabelMap vars;
142
143                        typedef ObjDeclCollector Parent;
144                        using Parent::previsit;
145                        void previsit( Statement * stmt );
146
147                        void previsit( CompoundStmt *compoundStmt );
148                        void previsit( DeclStmt *stmt );
149                };
150
151                struct InsertDtors final : public ObjDeclCollector, public WithStmtsToAdd {
152                        /// insert destructor calls at the appropriate places.  must happen before CtorInit nodes are removed
153                        /// (currently by FixInit)
154                        static void insert( std::list< Declaration * > & translationUnit );
155
156                        typedef std::list< ObjectDecl * > OrderedDecls;
157                        typedef std::list< OrderedDecls > OrderedDeclsStack;
158
159                        InsertDtors( PassVisitor<LabelFinder> & finder ) : finder( finder ), labelVars( finder.pass.vars ) {}
160
161                        typedef ObjDeclCollector Parent;
162                        using Parent::previsit;
163
164                        void previsit( FunctionDecl * funcDecl );
165
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                struct GenStructMemberCalls final : public WithGuards, public WithShortCircuiting, public WithIndexer, public WithVisitorRef<GenStructMemberCalls> {
186                        /// generate default/copy ctor and dtor calls for user-defined struct ctor/dtors
187                        /// for any member that is missing a corresponding ctor/dtor call.
188                        /// error if a member is used before constructed
189                        static void generate( std::list< Declaration * > & translationUnit );
190
191                        void premutate( FunctionDecl * funcDecl );
192                        DeclarationWithType * postmutate( FunctionDecl * funcDecl );
193
194                        void premutate( MemberExpr * memberExpr );
195                        void premutate( ApplicationExpr * appExpr );
196
197                        /// Note: this post mutate used to be in a separate visitor. If this pass breaks, one place to examine is whether it is
198                        /// okay for this part of the recursion to occur alongside the rest.
199                        Expression * postmutate( UntypedExpr * expr );
200
201                        SemanticErrorException errors;
202                  private:
203                        template< typename... Params >
204                        void emit( CodeLocation, const Params &... params );
205
206                        FunctionDecl * function = nullptr;
207                        std::set< DeclarationWithType * > unhandled;
208                        std::map< DeclarationWithType *, CodeLocation > usedUninit;
209                        ObjectDecl * thisParam = nullptr;
210                        bool isCtor = false; // true if current function is a constructor
211                        StructDecl * structDecl = nullptr;
212                };
213
214                struct FixCtorExprs final : public WithDeclsToAdd, public WithIndexer {
215                        /// expands ConstructorExpr nodes into comma expressions, using a temporary for the first argument
216                        static void fix( std::list< Declaration * > & translationUnit );
217
218                        Expression * postmutate( ConstructorExpr * ctorExpr );
219                };
220
221                struct SplitExpressions : public WithShortCircuiting, public WithTypeSubstitution, public WithStmtsToAdd {
222                        /// add CompoundStmts around top-level expressions so that temporaries are destroyed in the correct places.
223                        static void split( std::list< Declaration * > &translationUnit );
224
225                        Statement * postmutate( ExprStmt * stmt );
226                        void premutate( TupleAssignExpr * expr );
227                };
228        } // namespace
229
230        void fix( std::list< Declaration * > & translationUnit, bool inLibrary ) {
231                PassVisitor<SelfAssignChecker> checker;
232                acceptAll( translationUnit, checker );
233
234                // fixes StmtExpr to properly link to their resulting expression
235                StmtExprResult::link( translationUnit );
236
237                // fixes ConstructorInit for global variables. should happen before fixInitializers.
238                InitTweak::fixGlobalInit( translationUnit, inLibrary );
239
240                // must happen before ResolveCopyCtors because temporaries have to be inserted into the correct scope
241                SplitExpressions::split( translationUnit );
242
243                InsertImplicitCalls::insert( translationUnit );
244
245                // Needs to happen before ResolveCopyCtors, because argument/return temporaries should not be considered in
246                // error checking branch statements
247                InsertDtors::insert( translationUnit );
248
249                ResolveCopyCtors::resolveImplicitCalls( translationUnit );
250                FixInit::fixInitializers( translationUnit );
251                GenStructMemberCalls::generate( translationUnit );
252
253                // Needs to happen after GenStructMemberCalls, since otherwise member constructors exprs
254                // don't have the correct form, and a member can be constructed more than once.
255                FixCtorExprs::fix( translationUnit );
256        }
257
258        namespace {
259                /// find and return the destructor used in `input`. If `input` is not a simple destructor call, generate a thunk
260                /// that wraps the destructor, insert it into `stmtsToAdd` and return the new function declaration
261                DeclarationWithType * getDtorFunc( ObjectDecl * objDecl, Statement * input, std::list< Statement * > & stmtsToAdd ) {
262                        // unwrap implicit statement wrapper
263                        Statement * dtor = input;
264                        assert( dtor );
265                        std::list< Expression * > matches;
266                        collectCtorDtorCalls( dtor, matches );
267
268                        if ( dynamic_cast< ExprStmt * >( dtor ) ) {
269                                // only one destructor call in the expression
270                                if ( matches.size() == 1 ) {
271                                        DeclarationWithType * func = getFunction( matches.front() );
272                                        assertf( func, "getFunction failed to find function in %s", toString( matches.front() ).c_str() );
273
274                                        // cleanup argument must be a function, not an object (including function pointer)
275                                        if ( FunctionDecl * dtorFunc = dynamic_cast< FunctionDecl * > ( func ) ) {
276                                                if ( dtorFunc->type->forall.empty() ) {
277                                                        // simple case where the destructor is a monomorphic function call - can simply
278                                                        // use that function as the cleanup function.
279                                                        delete dtor;
280                                                        return func;
281                                                }
282                                        }
283                                }
284                        }
285
286                        // otherwise the cleanup is more complicated - need to build a single argument cleanup function that
287                        // wraps the more complicated code.
288                        static UniqueName dtorNamer( "__cleanup_dtor" );
289                        std::string name = dtorNamer.newName();
290                        FunctionDecl * dtorFunc = FunctionDecl::newFunction( name, SymTab::genDefaultType( objDecl->type->stripReferences(), false ), new CompoundStmt() );
291                        stmtsToAdd.push_back( new DeclStmt( dtorFunc ) );
292
293                        // the original code contains uses of objDecl - replace them with the newly generated 'this' parameter.
294                        ObjectDecl * thisParam = getParamThis( dtorFunc->type );
295                        Expression * replacement = new VariableExpr( thisParam );
296
297                        Type * base = replacement->result->stripReferences();
298                        if ( dynamic_cast< ArrayType * >( base ) || dynamic_cast< TupleType * > ( base ) ) {
299                                // need to cast away reference for array types, since the destructor is generated without the reference type,
300                                // and for tuple types since tuple indexing does not work directly on a reference
301                                replacement = new CastExpr( replacement, base->clone() );
302                        }
303                        size_t replaced = DeclReplacer::replace( dtor, { std::make_pair( objDecl, replacement ) } );
304                        if(replaced == 0) {
305                                objDecl->print(std::cerr);
306                                std::cerr << "-----" << std::endl;
307                                dtor->print(std::cerr);
308                                std::cerr << "Failed to replace " << objDecl << std::endl;
309                                abort();
310                        }
311                        dtorFunc->statements->push_back( strict_dynamic_cast<Statement *>( dtor ) );
312
313                        return dtorFunc;
314                }
315
316                void StmtExprResult::link( std::list< Declaration * > & translationUnit ) {
317                        PassVisitor<StmtExprResult> linker;
318                        acceptAll( translationUnit, linker );
319                }
320
321                void SplitExpressions::split( std::list< Declaration * > & translationUnit ) {
322                        PassVisitor<SplitExpressions> splitter;
323                        mutateAll( translationUnit, splitter );
324                }
325
326                void InsertImplicitCalls::insert( std::list< Declaration * > & translationUnit ) {
327                        PassVisitor<InsertImplicitCalls> inserter;
328                        mutateAll( translationUnit, inserter );
329                }
330
331                void ResolveCopyCtors::resolveImplicitCalls( std::list< Declaration * > & translationUnit ) {
332                        PassVisitor<ResolveCopyCtors> resolver;
333                        mutateAll( translationUnit, resolver );
334                }
335
336                void FixInit::fixInitializers( std::list< Declaration * > & translationUnit ) {
337                        PassVisitor<FixInit> fixer;
338
339                        // can't use mutateAll, because need to insert declarations at top-level
340                        // can't use DeclMutator, because sometimes need to insert IfStmt, etc.
341                        SemanticErrorException errors;
342                        for ( std::list< Declaration * >::iterator i = translationUnit.begin(); i != translationUnit.end(); ++i ) {
343                                try {
344                                        maybeMutate( *i, fixer );
345                                        translationUnit.splice( i, fixer.pass.staticDtorDecls );
346                                } catch( SemanticErrorException &e ) {
347                                        errors.append( e );
348                                } // try
349                        } // for
350                        if ( ! errors.isEmpty() ) {
351                                throw errors;
352                        } // if
353                }
354
355                void InsertDtors::insert( std::list< Declaration * > & translationUnit ) {
356                        PassVisitor<LabelFinder> finder;
357                        PassVisitor<InsertDtors> inserter( finder );
358                        acceptAll( translationUnit, inserter );
359                }
360
361                void GenStructMemberCalls::generate( std::list< Declaration * > & translationUnit ) {
362                        PassVisitor<GenStructMemberCalls> warner;
363                        mutateAll( translationUnit, warner );
364                }
365
366                void FixCtorExprs::fix( std::list< Declaration * > & translationUnit ) {
367                        PassVisitor<FixCtorExprs> fixer;
368                        mutateAll( translationUnit, fixer );
369                }
370
371                void StmtExprResult::previsit( StmtExpr * stmtExpr ) {
372                        // we might loose the result expression here so add a pointer to trace back
373                        assert( stmtExpr->result );
374                        Type * result = stmtExpr->result;
375                        if ( ! result->isVoid() ) {
376                                CompoundStmt * body = stmtExpr->statements;
377                                assert( ! body->kids.empty() );
378                                stmtExpr->resultExpr = strict_dynamic_cast< ExprStmt * >( body->kids.back() );
379                        }
380                }
381
382                Statement * SplitExpressions::postmutate( ExprStmt * stmt ) {
383                        // wrap each top-level ExprStmt in a block so that destructors for argument and return temporaries are destroyed
384                        // in the correct places
385                        CompoundStmt * ret = new CompoundStmt( { stmt } );
386                        return ret;
387                }
388
389                void SplitExpressions::premutate( TupleAssignExpr * ) {
390                        // don't do this within TupleAssignExpr, since it is already broken up into multiple expressions
391                        visit_children = false;
392                }
393
394                // Relatively simple structural comparison for expressions, needed to determine
395                // if two expressions are "the same" (used to determine if self assignment occurs)
396                struct StructuralChecker {
397                        Expression * stripCasts( Expression * expr ) {
398                                // this might be too permissive. It's possible that only particular casts are relevant.
399                                while ( CastExpr * cast = dynamic_cast< CastExpr * >( expr ) ) {
400                                        expr = cast->arg;
401                                }
402                                return expr;
403                        }
404
405                        void previsit( Expression * ) {
406                                // anything else does not qualify
407                                isSimilar = false;
408                        }
409
410                        template<typename T>
411                        T * cast( Expression * node ) {
412                                // all expressions need to ignore casts, so this bit has been factored out
413                                return dynamic_cast< T * >( stripCasts( node ) );
414                        }
415
416                        // ignore casts
417                        void previsit( CastExpr * ) {}
418
419                        void previsit( MemberExpr * memExpr ) {
420                                if ( MemberExpr * otherMember = cast< MemberExpr >( other ) ) {
421                                        if ( otherMember->member == memExpr->member ) {
422                                                other = otherMember->aggregate;
423                                                return;
424                                        }
425                                }
426                                isSimilar = false;
427                        }
428
429                        void previsit( VariableExpr * varExpr ) {
430                                if ( VariableExpr * otherVar = cast< VariableExpr >( other ) ) {
431                                        if ( otherVar->var == varExpr->var ) {
432                                                return;
433                                        }
434                                }
435                                isSimilar = false;
436                        }
437
438                        void previsit( AddressExpr * ) {
439                                if ( AddressExpr * addrExpr = cast< AddressExpr >( other ) ) {
440                                        other = addrExpr->arg;
441                                        return;
442                                }
443                                isSimilar = false;
444                        }
445
446                        Expression * other = nullptr;
447                        bool isSimilar = true;
448                };
449
450                bool structurallySimilar( Expression * e1, Expression * e2 ) {
451                        PassVisitor<StructuralChecker> checker;
452                        checker.pass.other = e2;
453                        e1->accept( checker );
454                        return checker.pass.isSimilar;
455                }
456
457                void SelfAssignChecker::previsit( ApplicationExpr * appExpr ) {
458                        DeclarationWithType * function = getFunction( appExpr );
459                        if ( function->name == "?=?" ) { // doesn't use isAssignment, because ?+=?, etc. should not count as self-assignment
460                                if ( appExpr->args.size() == 2 ) {
461                                        // check for structural similarity (same variable use, ignore casts, etc. - but does not look too deeply, anything looking like a function is off limits)
462                                        if ( structurallySimilar( appExpr->args.front(), appExpr->args.back() ) ) {
463                                                SemanticWarning( appExpr->location, Warning::SelfAssignment, toCString( appExpr->args.front() ) );
464                                        }
465                                }
466                        }
467                }
468
469                Expression * InsertImplicitCalls::postmutate( ApplicationExpr * appExpr ) {
470                        if ( VariableExpr * function = dynamic_cast< VariableExpr * > ( appExpr->get_function() ) ) {
471                                if ( function->var->linkage.is_builtin ) {
472                                        // optimization: don't need to copy construct in order to call intrinsic functions
473                                        return appExpr;
474                                } else if ( DeclarationWithType * funcDecl = dynamic_cast< DeclarationWithType * > ( function->get_var() ) ) {
475                                        FunctionType * ftype = dynamic_cast< FunctionType * >( GenPoly::getFunctionType( funcDecl->get_type() ) );
476                                        assertf( ftype, "Function call without function type: %s", toString( funcDecl ).c_str() );
477                                        if ( CodeGen::isConstructor( funcDecl->get_name() ) && ftype->parameters.size() == 2 ) {
478                                                Type * t1 = getPointerBase( ftype->parameters.front()->get_type() );
479                                                Type * t2 = ftype->parameters.back()->get_type();
480                                                assert( t1 );
481
482                                                if ( ResolvExpr::typesCompatible( t1, t2, SymTab::Indexer() ) ) {
483                                                        // optimization: don't need to copy construct in order to call a copy constructor
484                                                        return appExpr;
485                                                } // if
486                                        } else if ( CodeGen::isDestructor( funcDecl->get_name() ) ) {
487                                                // correctness: never copy construct arguments to a destructor
488                                                return appExpr;
489                                        } // if
490                                } // if
491                        } // if
492                        CP_CTOR_PRINT( std::cerr << "InsertImplicitCalls: adding a wrapper " << appExpr << std::endl; )
493
494                        // wrap each function call so that it is easy to identify nodes that have to be copy constructed
495                        ImplicitCopyCtorExpr * expr = new ImplicitCopyCtorExpr( appExpr );
496                        // Move the type substitution to the new top-level, if it is attached to the appExpr.
497                        // Ensure it is not deleted with the ImplicitCopyCtorExpr by removing it before deletion.
498                        // The substitution is needed to obtain the type of temporary variables so that copy constructor
499                        // calls can be resolved.
500                        assert( env );
501                        std::swap( expr->env, appExpr->env );
502                        return expr;
503                }
504
505                bool ResolveCopyCtors::skipCopyConstruct( Type * type ) { return ! isConstructable( type ); }
506
507                Expression * ResolveCopyCtors::makeCtorDtor( const std::string & fname, ObjectDecl * var, Expression * cpArg ) {
508                        assert( var );
509                        // arrays are not copy constructed, so this should always be an ExprStmt
510                        ImplicitCtorDtorStmt * stmt = genCtorDtor( fname, var, cpArg );
511                        assertf( stmt, "ResolveCopyCtors: genCtorDtor returned nullptr: %s / %s / %s", fname.c_str(), toString( var ).c_str(), toString( cpArg ).c_str() );
512                        ExprStmt * exprStmt = strict_dynamic_cast< ExprStmt * >( stmt->callStmt );
513                        Expression * resolved = exprStmt->expr;
514                        exprStmt->expr = nullptr; // take ownership of expr
515
516                        // resolve copy constructor
517                        // should only be one alternative for copy ctor and dtor expressions, since all arguments are fixed
518                        // (VariableExpr and already resolved expression)
519                        CP_CTOR_PRINT( std::cerr << "ResolvingCtorDtor " << resolved << std::endl; )
520                        ResolvExpr::findVoidExpression( resolved, indexer );
521                        assert( resolved );
522                        if ( resolved->env ) {
523                                // Extract useful information and discard new environments. Keeping them causes problems in PolyMutator passes.
524                                env->add( *resolved->env );
525                                delete resolved->env;
526                                resolved->env = nullptr;
527                        } // if
528                        delete stmt;
529                        if ( TupleAssignExpr * assign = dynamic_cast< TupleAssignExpr * >( resolved ) ) {
530                                // fix newly generated StmtExpr
531                                premutate( assign->stmtExpr );
532                        }
533                        return resolved;
534                }
535
536                void ResolveCopyCtors::copyConstructArg( Expression *& arg, ImplicitCopyCtorExpr * impCpCtorExpr, Type * formal ) {
537                        static UniqueName tempNamer("_tmp_cp");
538                        assert( env );
539                        CP_CTOR_PRINT( std::cerr << "Type Substitution: " << *env << std::endl; )
540                        assert( arg->result );
541                        Type * result = arg->result;
542                        if ( skipCopyConstruct( result ) ) return; // skip certain non-copyable types
543
544                        // type may involve type variables, so apply type substitution to get temporary variable's actual type,
545                        // since result type may not be substituted (e.g., if the type does not appear in the parameter list)
546                        // Use applyFree so that types bound in function pointers are not substituted, e.g. in forall(dtype T) void (*)(T).
547                        env->applyFree( result );
548                        ObjectDecl * tmp = ObjectDecl::newObject( "__tmp", result, nullptr );
549                        tmp->get_type()->set_const( false );
550
551                        // create and resolve copy constructor
552                        CP_CTOR_PRINT( std::cerr << "makeCtorDtor for an argument" << std::endl; )
553                        Expression * cpCtor = makeCtorDtor( "?{}", tmp, arg );
554
555                        if ( ApplicationExpr * appExpr = dynamic_cast< ApplicationExpr * >( cpCtor ) ) {
556                                // if the chosen constructor is intrinsic, the copy is unnecessary, so
557                                // don't create the temporary and don't call the copy constructor
558                                VariableExpr * function = strict_dynamic_cast< VariableExpr * >( appExpr->function );
559                                if ( function->var->linkage == LinkageSpec::Intrinsic ) {
560                                        // arguments that need to be boxed need a temporary regardless of whether the copy constructor is intrinsic,
561                                        // so that the object isn't changed inside of the polymorphic function
562                                        if ( ! GenPoly::needsBoxing( formal, result, impCpCtorExpr->callExpr, env ) ) return;
563                                        // xxx - leaking tmp
564                                }
565                        }
566
567                        // set a unique name for the temporary once it's certain the call is necessary
568                        tmp->name = tempNamer.newName();
569
570                        // replace argument to function call with temporary
571                        stmtsToAddBefore.push_back( new DeclStmt( tmp ) );
572                        arg = cpCtor;
573                        destructRet( tmp, impCpCtorExpr, arg );
574
575                        // impCpCtorExpr->dtors.push_front( makeCtorDtor( "^?{}", tmp ) );
576                }
577
578                void ResolveCopyCtors::destructRet( ObjectDecl * ret, ImplicitCopyCtorExpr * /*impCpCtorExpr*/, Expression *& arg ) {
579                        // TODO: refactor code for generating cleanup attribute, since it's common and reused in ~3-4 places
580                        // check for existing cleanup attribute before adding another(?)
581                        // need to add __Destructor for _tmp_cp variables as well
582
583                        assertf( Validate::dtorStruct && Validate::dtorStruct->members.size() == 2, "Destructor generation requires __Destructor definition." );
584                        assertf( Validate::dtorStructDestroy, "Destructor generation requires __destroy_Destructor." );
585
586                        // generate a __Destructor for ret that calls the destructor
587                        Expression * dtor = makeCtorDtor( "^?{}", ret );
588
589                        // if the chosen destructor is intrinsic, elide the generated dtor handler
590                        if ( arg && isIntrinsicCallExpr( dtor ) ) {
591                                arg = new CommaExpr( arg, new VariableExpr( ret ) );
592                                return;
593                        }
594
595                        if ( ! dtor->env ) dtor->env = maybeClone( env );
596                        DeclarationWithType * dtorFunc = getDtorFunc( ret, new ExprStmt( dtor ), stmtsToAddBefore );
597
598                        StructInstType * dtorStructType = new StructInstType( Type::Qualifiers(), Validate::dtorStruct );
599                        dtorStructType->parameters.push_back( new TypeExpr( new VoidType( Type::Qualifiers() ) ) );
600
601                        // cast destructor pointer to void (*)(void *), to silence GCC incompatible pointer warnings
602                        FunctionType * dtorFtype = new FunctionType( Type::Qualifiers(), false );
603                        dtorFtype->parameters.push_back( ObjectDecl::newObject( "", new PointerType( Type::Qualifiers(), new VoidType( Type::Qualifiers() ) ), nullptr ) );
604                        Type * dtorType = new PointerType( Type::Qualifiers(), dtorFtype );
605
606                        static UniqueName namer( "_ret_dtor" );
607                        ObjectDecl * retDtor = ObjectDecl::newObject( namer.newName(), dtorStructType, new ListInit( { new SingleInit( new ConstantExpr( Constant::null() ) ), new SingleInit( new CastExpr( new VariableExpr( dtorFunc ), dtorType ) ) } ) );
608                        retDtor->attributes.push_back( new Attribute( "cleanup", { new VariableExpr( Validate::dtorStructDestroy ) } ) );
609                        stmtsToAddBefore.push_back( new DeclStmt( retDtor ) );
610
611                        if ( arg ) {
612                                Expression * member = new MemberExpr( strict_dynamic_cast<DeclarationWithType *>( Validate::dtorStruct->members.front() ), new VariableExpr( retDtor ) );
613                                Expression * object = new CastExpr( new AddressExpr( new VariableExpr( ret ) ), new PointerType( Type::Qualifiers(), new VoidType( Type::Qualifiers() ) ) );
614                                Expression * assign = createBitwiseAssignment( member, object );
615                                arg = new CommaExpr( new CommaExpr( arg, assign ), new VariableExpr( ret ) );
616                        }
617
618                        // impCpCtorExpr->get_dtors().push_front( makeCtorDtor( "^?{}", ret ) );
619                }
620
621                Expression * ResolveCopyCtors::postmutate( ImplicitCopyCtorExpr *impCpCtorExpr ) {
622                        CP_CTOR_PRINT( std::cerr << "ResolveCopyCtors: " << impCpCtorExpr << std::endl; )
623
624                        ApplicationExpr * appExpr = impCpCtorExpr->callExpr;
625                        ObjectDecl * returnDecl = nullptr;
626
627                        // take each argument and attempt to copy construct it.
628                        FunctionType * ftype = GenPoly::getFunctionType( appExpr->function->result );
629                        assert( ftype );
630                        auto & params = ftype->parameters;
631                        auto iter = params.begin();
632                        for ( Expression * & arg : appExpr->args ) {
633                                Type * formal = nullptr;
634                                if ( iter != params.end() ) { // does not copy construct C-style variadic arguments
635                                        DeclarationWithType * param = *iter++;
636                                        formal = param->get_type();
637                                }
638
639                                copyConstructArg( arg, impCpCtorExpr, formal );
640                        } // for
641
642                        // each return value from the call needs to be connected with an ObjectDecl at the call site, which is
643                        // initialized with the return value and is destructed later
644                        // xxx - handle named return values?
645                        Type * result = appExpr->result;
646                        if ( ! result->isVoid() ) {
647                                static UniqueName retNamer("_tmp_cp_ret");
648                                result = result->clone();
649                                env->apply( result );
650                                ObjectDecl * ret = ObjectDecl::newObject( retNamer.newName(), result, nullptr );
651                                ret->type->set_const( false );
652                                returnDecl = ret;
653                                stmtsToAddBefore.push_back( new DeclStmt( ret ) );
654                                CP_CTOR_PRINT( std::cerr << "makeCtorDtor for a return" << std::endl; )
655                        } // for
656                        CP_CTOR_PRINT( std::cerr << "after Resolving: " << impCpCtorExpr << std::endl; )
657                        // ------------------------------------------------------
658
659                        CP_CTOR_PRINT( std::cerr << "Coming out the back..." << impCpCtorExpr << std::endl; )
660
661                        // detach fields from wrapper node so that it can be deleted without deleting too much
662                        impCpCtorExpr->callExpr = nullptr;
663                        std::swap( impCpCtorExpr->env, appExpr->env );
664                        assert( impCpCtorExpr->env == nullptr );
665                        delete impCpCtorExpr;
666
667                        if ( returnDecl ) {
668                                Expression * assign = createBitwiseAssignment( new VariableExpr( returnDecl ), appExpr );
669                                if ( ! dynamic_cast< ReferenceType * >( result ) ) {
670                                        // destructing reference returns is bad because it can cause multiple destructor calls to the same object - the returned object is not a temporary
671                                        destructRet( returnDecl, impCpCtorExpr, assign );
672                                } else {
673                                        assign = new CommaExpr( assign, new VariableExpr( returnDecl ) );
674                                }
675                                // move env from appExpr to retExpr
676                                std::swap( assign->env, appExpr->env );
677                                return assign;
678                        } else {
679                                return appExpr;
680                        } // if
681                }
682
683                void ResolveCopyCtors::premutate( StmtExpr * stmtExpr ) {
684                        // function call temporaries should be placed at statement-level, rather than nested inside of a new statement expression,
685                        // since temporaries can be shared across sub-expressions, e.g.
686                        //   [A, A] f();       // decl
687                        //   g([A] x, [A] y);  // decl
688                        //   g(f());           // call
689                        // f is executed once, so the return temporary is shared across the tuple constructors for x and y.
690                        // Explicitly mutating children instead of mutating the inner compound statement forces the temporaries to be added
691                        // to the outer context, rather than inside of the statement expression.
692                        visit_children = false;
693
694                        assert( env );
695
696                        indexer.enterScope();
697                        // visit all statements
698                        std::list< Statement * > & stmts = stmtExpr->statements->get_kids();
699                        for ( Statement *& stmt : stmts ) {
700                                stmt = stmt->acceptMutator( *visitor );
701                        } // for
702                        indexer.leaveScope();
703
704                        assert( stmtExpr->result );
705                        Type * result = stmtExpr->result;
706                        if ( ! result->isVoid() ) {
707                                static UniqueName retNamer("_tmp_stmtexpr_ret");
708
709                                result = result->clone();
710                                env->apply( result );
711                                if ( ! InitTweak::isConstructable( result ) ) {
712                                        delete result;
713                                        return;
714                                }
715
716                                // create variable that will hold the result of the stmt expr
717                                ObjectDecl * ret = ObjectDecl::newObject( retNamer.newName(), result, nullptr );
718                                ret->type->set_const( false );
719                                stmtsToAddBefore.push_back( new DeclStmt( ret ) );
720
721                                assertf(
722                                        stmtExpr->resultExpr,
723                                        "Statement-Expression should have a resulting expression at %s:%d",
724                                        stmtExpr->location.filename.c_str(),
725                                        stmtExpr->location.first_line
726                                );
727
728                                ExprStmt * last = stmtExpr->resultExpr;
729                                try {
730                                        last->expr = makeCtorDtor( "?{}", ret, last->expr );
731                                } catch(...) {
732                                        std::cerr << "*CFA internal error: ";
733                                        std::cerr << "can't resolve implicit constructor";
734                                        std::cerr << " at " << stmtExpr->location.filename;
735                                        std::cerr << ":" << stmtExpr->location.first_line << std::endl;
736
737                                        abort();
738                                }
739
740                                // add destructors after current statement
741                                stmtsToAddAfter.push_back( new ExprStmt( makeCtorDtor( "^?{}", ret ) ) );
742
743                                // must have a non-empty body, otherwise it wouldn't have a result
744                                assert( ! stmts.empty() );
745
746                                // if there is a return decl, add a use as the last statement; will not have return decl on non-constructable returns
747                                stmts.push_back( new ExprStmt( new VariableExpr( ret ) ) );
748                        } // if
749
750                        assert( stmtExpr->returnDecls.empty() );
751                        assert( stmtExpr->dtors.empty() );
752                }
753
754                // to prevent warnings (‘_unq0’ may be used uninitialized in this function),
755                // insert an appropriate zero initializer for UniqueExpr temporaries.
756                Initializer * makeInit( Type * t ) {
757                        if ( StructInstType * inst = dynamic_cast< StructInstType * >( t ) ) {
758                                // initizer for empty struct must be empty
759                                if ( inst->baseStruct->members.empty() ) return new ListInit({});
760                        } else if ( UnionInstType * inst = dynamic_cast< UnionInstType * >( t ) ) {
761                                // initizer for empty union must be empty
762                                if ( inst->baseUnion->members.empty() ) return new ListInit({});
763                        }
764
765                        return new ListInit( { new SingleInit( new ConstantExpr( Constant::from_int( 0 ) ) ) } );
766                }
767
768                void ResolveCopyCtors::premutate( UniqueExpr * unqExpr ) {
769                        visit_children = false;
770                        // xxx - hack to prevent double-handling of unique exprs, otherwise too many temporary variables and destructors are generated
771                        static std::unordered_map< int, UniqueExpr * > unqMap;
772                        if ( ! unqMap.count( unqExpr->get_id() ) ) {
773                                // resolve expr and find its
774
775                                ImplicitCopyCtorExpr * impCpCtorExpr = dynamic_cast< ImplicitCopyCtorExpr * >( unqExpr->expr );
776                                // PassVisitor<ResolveCopyCtors> fixer;
777                                unqExpr->expr = unqExpr->expr->acceptMutator( *visitor );
778
779                                // it should never be necessary to wrap a void-returning expression in a UniqueExpr - if this assumption changes, this needs to be rethought
780                                assert( unqExpr->result );
781                                if ( impCpCtorExpr ) {
782                                        CommaExpr * comma = strict_dynamic_cast< CommaExpr * >( unqExpr->expr );
783                                        VariableExpr * var = strict_dynamic_cast<VariableExpr *>( comma->arg2 );
784                                        // note the variable used as the result from the call
785                                        unqExpr->var = var->clone();
786                                } else {
787                                        // expr isn't a call expr, so create a new temporary variable to use to hold the value of the unique expression
788                                        unqExpr->object = ObjectDecl::newObject( toString("_unq", unqExpr->get_id()), unqExpr->result->clone(), makeInit( unqExpr->result ) );
789                                        unqExpr->var = new VariableExpr( unqExpr->object );
790                                }
791
792                                // stmtsToAddBefore.splice( stmtsToAddBefore.end(), fixer.pass.stmtsToAddBefore );
793                                // stmtsToAddAfter.splice( stmtsToAddAfter.end(), fixer.pass.stmtsToAddAfter );
794                                unqMap[unqExpr->get_id()] = unqExpr;
795                        } else {
796                                // take data from other UniqueExpr to ensure consistency
797                                delete unqExpr->get_expr();
798                                unqExpr->expr = unqMap[unqExpr->get_id()]->expr->clone();
799                                delete unqExpr->result;
800                                unqExpr->result = maybeClone( unqExpr->expr->result );
801                        }
802                }
803
804                DeclarationWithType * FixInit::postmutate( ObjectDecl *objDecl ) {
805                        // since this removes the init field from objDecl, it must occur after children are mutated (i.e. postmutate)
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                                if ( Statement * ctor = ctorInit->get_ctor() ) {
810                                        if ( objDecl->get_storageClasses().is_static ) {
811                                                // originally wanted to take advantage of gcc nested functions, but
812                                                // we get memory errors with this approach. To remedy this, the static
813                                                // variable is hoisted when the destructor needs to be called.
814                                                //
815                                                // generate:
816                                                // static T __objName_static_varN;
817                                                // void __objName_dtor_atexitN() {
818                                                //   __dtor__...;
819                                                // }
820                                                // int f(...) {
821                                                //   ...
822                                                //   static bool __objName_uninitialized = true;
823                                                //   if (__objName_uninitialized) {
824                                                //     __ctor(__objName);
825                                                //     __objName_uninitialized = false;
826                                                //     atexit(__objName_dtor_atexitN);
827                                                //   }
828                                                //   ...
829                                                // }
830
831                                                static UniqueName dtorCallerNamer( "_dtor_atexit" );
832
833                                                // static bool __objName_uninitialized = true
834                                                BasicType * boolType = new BasicType( Type::Qualifiers(), BasicType::Bool );
835                                                SingleInit * boolInitExpr = new SingleInit( new ConstantExpr( Constant::from_int( 1 ) ) );
836                                                ObjectDecl * isUninitializedVar = new ObjectDecl( objDecl->get_mangleName() + "_uninitialized", Type::StorageClasses( Type::Static ), LinkageSpec::Cforall, 0, boolType, boolInitExpr );
837                                                isUninitializedVar->fixUniqueId();
838
839                                                // __objName_uninitialized = false;
840                                                UntypedExpr * setTrue = new UntypedExpr( new NameExpr( "?=?" ) );
841                                                setTrue->get_args().push_back( new VariableExpr( isUninitializedVar ) );
842                                                setTrue->get_args().push_back( new ConstantExpr( Constant::from_int( 0 ) ) );
843
844                                                // generate body of if
845                                                CompoundStmt * initStmts = new CompoundStmt();
846                                                std::list< Statement * > & body = initStmts->get_kids();
847                                                body.push_back( ctor );
848                                                body.push_back( new ExprStmt( setTrue ) );
849
850                                                // put it all together
851                                                IfStmt * ifStmt = new IfStmt( new VariableExpr( isUninitializedVar ), initStmts, 0 );
852                                                stmtsToAddAfter.push_back( new DeclStmt( isUninitializedVar ) );
853                                                stmtsToAddAfter.push_back( ifStmt );
854
855                                                Statement * dtor = ctorInit->get_dtor();
856                                                objDecl->set_init( nullptr );
857                                                ctorInit->set_ctor( nullptr );
858                                                ctorInit->set_dtor( nullptr );
859                                                if ( dtor ) {
860                                                        // if the object has a non-trivial destructor, have to
861                                                        // hoist it and the object into the global space and
862                                                        // call the destructor function with atexit.
863
864                                                        Statement * dtorStmt = dtor->clone();
865
866                                                        // void __objName_dtor_atexitN(...) {...}
867                                                        FunctionDecl * dtorCaller = new FunctionDecl( objDecl->get_mangleName() + dtorCallerNamer.newName(), Type::StorageClasses( Type::Static ), LinkageSpec::C, new FunctionType( Type::Qualifiers(), false ), new CompoundStmt() );
868                                                        dtorCaller->fixUniqueId();
869                                                        dtorCaller->get_statements()->push_back( dtorStmt );
870
871                                                        // atexit(dtor_atexit);
872                                                        UntypedExpr * callAtexit = new UntypedExpr( new NameExpr( "atexit" ) );
873                                                        callAtexit->get_args().push_back( new VariableExpr( dtorCaller ) );
874
875                                                        body.push_back( new ExprStmt( callAtexit ) );
876
877                                                        // hoist variable and dtor caller decls to list of decls that will be added into global scope
878                                                        staticDtorDecls.push_back( objDecl );
879                                                        staticDtorDecls.push_back( dtorCaller );
880
881                                                        // need to rename object uniquely since it now appears
882                                                        // at global scope and there could be multiple function-scoped
883                                                        // static variables with the same name in different functions.
884                                                        // Note: it isn't sufficient to modify only the mangleName, because
885                                                        // then subsequent Indexer passes can choke on seeing the object's name
886                                                        // if another object has the same name and type. An unfortunate side-effect
887                                                        // of renaming the object is that subsequent NameExprs may fail to resolve,
888                                                        // but there shouldn't be any remaining past this point.
889                                                        static UniqueName staticNamer( "_static_var" );
890                                                        objDecl->set_name( objDecl->get_name() + staticNamer.newName() );
891                                                        objDecl->set_mangleName( SymTab::Mangler::mangle( objDecl ) );
892
893                                                        // xxx - temporary hack: need to return a declaration, but want to hoist the current object out of this scope
894                                                        // create a new object which is never used
895                                                        static UniqueName dummyNamer( "_dummy" );
896                                                        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") } );
897                                                        delete ctorInit;
898                                                        return dummy;
899                                                }
900                                        } else {
901                                                ImplicitCtorDtorStmt * implicit = strict_dynamic_cast< ImplicitCtorDtorStmt * > ( ctor );
902                                                ExprStmt * ctorStmt = dynamic_cast< ExprStmt * >( implicit->callStmt );
903                                                ApplicationExpr * ctorCall = nullptr;
904                                                if ( ctorStmt && (ctorCall = isIntrinsicCallExpr( ctorStmt->expr )) && ctorCall->get_args().size() == 2 ) {
905                                                        // clean up intrinsic copy constructor calls by making them into SingleInits
906                                                        Expression * ctorArg = ctorCall->args.back();
907                                                        std::swap( ctorArg->env, ctorCall->env );
908                                                        objDecl->init = new SingleInit( ctorArg );
909
910                                                        ctorCall->args.pop_back();
911                                                } else {
912                                                        stmtsToAddAfter.push_back( ctor );
913                                                        objDecl->init = nullptr;
914                                                        ctorInit->ctor = nullptr;
915                                                }
916
917                                                Statement * dtor = ctorInit->dtor;
918                                                if ( dtor ) {
919                                                        ImplicitCtorDtorStmt * implicit = strict_dynamic_cast< ImplicitCtorDtorStmt * >( dtor );
920                                                        Statement * dtorStmt = implicit->callStmt;
921
922                                                        // don't need to call intrinsic dtor, because it does nothing, but
923                                                        // non-intrinsic dtors must be called
924                                                        if ( ! isIntrinsicSingleArgCallStmt( dtorStmt ) ) {
925                                                                // set dtor location to the object's location for error messages
926                                                                DeclarationWithType * dtorFunc = getDtorFunc( objDecl, dtorStmt, stmtsToAddBefore );
927                                                                objDecl->attributes.push_back( new Attribute( "cleanup", { new VariableExpr( dtorFunc ) } ) );
928                                                                ctorInit->dtor = nullptr;
929                                                        } // if
930                                                }
931                                        } // if
932                                } else if ( Initializer * init = ctorInit->init ) {
933                                        objDecl->init = init;
934                                        ctorInit->init = nullptr;
935                                } else {
936                                        // no constructor and no initializer, which is okay
937                                        objDecl->init = nullptr;
938                                } // if
939                                delete ctorInit;
940                        } // if
941                        return objDecl;
942                }
943
944                void ObjDeclCollector::previsit( CompoundStmt * ) {
945                        GuardValue( curVars );
946                }
947
948                void ObjDeclCollector::previsit( DeclStmt * stmt ) {
949                        // keep track of all variables currently in scope
950                        if ( ObjectDecl * objDecl = dynamic_cast< ObjectDecl * > ( stmt->get_decl() ) ) {
951                                curVars.push_back( objDecl );
952                        } // if
953                }
954
955                void LabelFinder::previsit( Statement * stmt ) {
956                        // for each label, remember the variables in scope at that label.
957                        for ( Label l : stmt->get_labels() ) {
958                                vars[l] = curVars;
959                        } // for
960                }
961
962                void LabelFinder::previsit( CompoundStmt * stmt ) {
963                        previsit( (Statement *)stmt );
964                        Parent::previsit( stmt );
965                }
966
967                void LabelFinder::previsit( DeclStmt * stmt ) {
968                        previsit( (Statement *)stmt );
969                        Parent::previsit( stmt );
970                }
971
972
973                void InsertDtors::previsit( FunctionDecl * funcDecl ) {
974                        // each function needs to have its own set of labels
975                        GuardValue( labelVars );
976                        labelVars.clear();
977                        // LabelFinder does not recurse into FunctionDecl, so need to visit
978                        // its children manually.
979                        maybeAccept( funcDecl->type, finder );
980                        maybeAccept( funcDecl->statements, finder );
981
982                        // all labels for this function have been collected, insert destructors as appropriate via implicit recursion.
983                }
984
985                // Handle break/continue/goto in the same manner as C++.  Basic idea: any objects that are in scope at the
986                // BranchStmt but not at the labelled (target) statement must be destructed.  If there are any objects in scope
987                // at the target location but not at the BranchStmt then those objects would be uninitialized so notify the user
988                // of the error.  See C++ Reference 6.6 Jump Statements for details.
989                void InsertDtors::handleGoto( BranchStmt * stmt ) {
990                        // can't do anything for computed goto
991                        if ( stmt->computedTarget ) return;
992
993                        assertf( stmt->get_target() != "", "BranchStmt missing a label: %s", toString( stmt ).c_str() );
994                        // S_L = lvars = set of objects in scope at label definition
995                        // S_G = curVars = set of objects in scope at goto statement
996                        ObjectSet & lvars = labelVars[ stmt->get_target() ];
997
998                        DTOR_PRINT(
999                                std::cerr << "at goto label: " << stmt->get_target().get_name() << std::endl;
1000                                std::cerr << "S_G = " << printSet( curVars ) << std::endl;
1001                                std::cerr << "S_L = " << printSet( lvars ) << std::endl;
1002                        )
1003
1004                        ObjectSet diff;
1005                        // S_L-S_G results in set of objects whose construction is skipped - it's an error if this set is non-empty
1006                        std::set_difference( lvars.begin(), lvars.end(), curVars.begin(), curVars.end(), std::inserter( diff, diff.begin() ) );
1007                        DTOR_PRINT(
1008                                std::cerr << "S_L-S_G = " << printSet( diff ) << std::endl;
1009                        )
1010                        if ( ! diff.empty() ) {
1011                                SemanticError( stmt, std::string("jump to label '") + stmt->get_target().get_name() + "' crosses initialization of " + (*diff.begin())->get_name() + " " );
1012                        } // if
1013                }
1014
1015                void InsertDtors::previsit( BranchStmt * stmt ) {
1016                        switch( stmt->get_type() ) {
1017                          case BranchStmt::Continue:
1018                          case BranchStmt::Break:
1019                                // could optimize the break/continue case, because the S_L-S_G check is unnecessary (this set should
1020                                // always be empty), but it serves as a small sanity check.
1021                          case BranchStmt::Goto:
1022                                handleGoto( stmt );
1023                                break;
1024                          default:
1025                                assert( false );
1026                        } // switch
1027                }
1028
1029                bool checkWarnings( FunctionDecl * funcDecl ) {
1030                        // only check for warnings if the current function is a user-defined
1031                        // constructor or destructor
1032                        if ( ! funcDecl ) return false;
1033                        if ( ! funcDecl->get_statements() ) return false;
1034                        return CodeGen::isCtorDtor( funcDecl->get_name() ) && ! LinkageSpec::isOverridable( funcDecl->get_linkage() );
1035                }
1036
1037                void GenStructMemberCalls::premutate( FunctionDecl * funcDecl ) {
1038                        GuardValue( function );
1039                        GuardValue( unhandled );
1040                        GuardValue( usedUninit );
1041                        GuardValue( thisParam );
1042                        GuardValue( isCtor );
1043                        GuardValue( structDecl );
1044                        errors = SemanticErrorException();  // clear previous errors
1045
1046                        // need to start with fresh sets
1047                        unhandled.clear();
1048                        usedUninit.clear();
1049
1050                        function = funcDecl;
1051                        isCtor = CodeGen::isConstructor( function->get_name() );
1052                        if ( checkWarnings( function ) ) {
1053                                FunctionType * type = function->get_functionType();
1054                                assert( ! type->get_parameters().empty() );
1055                                thisParam = strict_dynamic_cast< ObjectDecl * >( type->get_parameters().front() );
1056                                Type * thisType = getPointerBase( thisParam->get_type() );
1057                                StructInstType * structType = dynamic_cast< StructInstType * >( thisType );
1058                                if ( structType ) {
1059                                        structDecl = structType->get_baseStruct();
1060                                        for ( Declaration * member : structDecl->get_members() ) {
1061                                                if ( ObjectDecl * field = dynamic_cast< ObjectDecl * >( member ) ) {
1062                                                        // record all of the struct type's members that need to be constructed or
1063                                                        // destructed by the end of the function
1064                                                        unhandled.insert( field );
1065                                                }
1066                                        }
1067                                }
1068                        }
1069                }
1070
1071                DeclarationWithType * GenStructMemberCalls::postmutate( FunctionDecl * funcDecl ) {
1072                        // remove the unhandled objects from usedUninit, because a call is inserted
1073                        // to handle them - only objects that are later constructed are used uninitialized.
1074                        std::map< DeclarationWithType *, CodeLocation > diff;
1075                        // need the comparator since usedUninit and unhandled have different types
1076                        struct comp_t {
1077                                typedef decltype(usedUninit)::value_type usedUninit_t;
1078                                typedef decltype(unhandled)::value_type unhandled_t;
1079                                bool operator()(usedUninit_t x, unhandled_t y) { return x.first < y; }
1080                                bool operator()(unhandled_t x, usedUninit_t y) { return x < y.first; }
1081                        } comp;
1082                        std::set_difference( usedUninit.begin(), usedUninit.end(), unhandled.begin(), unhandled.end(), std::inserter( diff, diff.begin() ), comp );
1083                        for ( auto p : diff ) {
1084                                DeclarationWithType * member = p.first;
1085                                CodeLocation loc = p.second;
1086                                // xxx - make error message better by also tracking the location that the object is constructed at?
1087                                emit( loc, "in ", CodeGen::genPrettyType( function->get_functionType(), function->get_name() ), ", field ", member->get_name(), " used before being constructed" );
1088                        }
1089
1090                        if ( ! unhandled.empty() ) {
1091                                // need to explicitly re-add function parameters to the indexer in order to resolve copy constructors
1092                                auto guard = makeFuncGuard( [this]() { indexer.enterScope(); }, [this]() { indexer.leaveScope(); } );
1093                                indexer.addFunctionType( function->type );
1094
1095                                // need to iterate through members in reverse in order for
1096                                // ctor/dtor statements to come out in the right order
1097                                for ( Declaration * member : reverseIterate( structDecl->get_members() ) ) {
1098                                        DeclarationWithType * field = dynamic_cast< DeclarationWithType * >( member );
1099                                        // skip non-DWT members
1100                                        if ( ! field ) continue;
1101                                        // skip non-constructable members
1102                                        if ( ! tryConstruct( field ) ) continue;
1103                                        // skip handled members
1104                                        if ( ! unhandled.count( field ) ) continue;
1105
1106                                        // insert and resolve default/copy constructor call for each field that's unhandled
1107                                        std::list< Statement * > stmt;
1108                                        Expression * arg2 = nullptr;
1109                                        if ( isCopyConstructor( function ) ) {
1110                                                // if copy ctor, need to pass second-param-of-this-function.field
1111                                                std::list< DeclarationWithType * > & params = function->get_functionType()->get_parameters();
1112                                                assert( params.size() == 2 );
1113                                                arg2 = new MemberExpr( field, new VariableExpr( params.back() ) );
1114                                        }
1115                                        InitExpander srcParam( arg2 );
1116                                        // cast away reference type and construct field.
1117                                        Expression * thisExpr = new CastExpr( new VariableExpr( thisParam ), thisParam->get_type()->stripReferences()->clone() );
1118                                        Expression * memberDest = new MemberExpr( field, thisExpr );
1119                                        SymTab::genImplicitCall( srcParam, memberDest, function->get_name(), back_inserter( stmt ), field, isCtor );
1120
1121                                        assert( stmt.size() <= 1 );
1122                                        if ( stmt.size() == 1 ) {
1123                                                Statement * callStmt = stmt.front();
1124
1125                                                try {
1126                                                        callStmt->acceptMutator( *visitor );
1127                                                        if ( isCtor ) {
1128                                                                function->statements->push_front( callStmt );
1129                                                        } else { // TODO: don't generate destructor function/object for intrinsic calls
1130                                                                // destructor statements should be added at the end
1131                                                                // function->get_statements()->push_back( callStmt );
1132
1133                                                                // Optimization: do not need to call intrinsic destructors on members
1134                                                                if ( isIntrinsicSingleArgCallStmt( callStmt ) ) continue;;
1135
1136                                                                // __Destructor _dtor0 = { (void *)&b.a1, (void (*)(void *)_destroy_A };
1137                                                                std::list< Statement * > stmtsToAdd;
1138
1139                                                                static UniqueName memberDtorNamer = { "__memberDtor" };
1140                                                                assertf( Validate::dtorStruct, "builtin __Destructor not found." );
1141                                                                assertf( Validate::dtorStructDestroy, "builtin __destroy_Destructor not found." );
1142
1143                                                                Expression * thisExpr = new CastExpr( new AddressExpr( new VariableExpr( thisParam ) ), new PointerType( Type::Qualifiers(), new VoidType( Type::Qualifiers() ) ) );
1144                                                                Expression * dtorExpr = new VariableExpr( getDtorFunc( thisParam, callStmt, stmtsToAdd ) );
1145
1146                                                                // cast destructor pointer to void (*)(void *), to silence GCC incompatible pointer warnings
1147                                                                FunctionType * dtorFtype = new FunctionType( Type::Qualifiers(), false );
1148                                                                dtorFtype->parameters.push_back( ObjectDecl::newObject( "", new PointerType( Type::Qualifiers(), new VoidType( Type::Qualifiers() ) ), nullptr ) );
1149                                                                Type * dtorType = new PointerType( Type::Qualifiers(), dtorFtype );
1150
1151                                                                ObjectDecl * destructor = ObjectDecl::newObject( memberDtorNamer.newName(), new StructInstType( Type::Qualifiers(), Validate::dtorStruct ), new ListInit( { new SingleInit( thisExpr ), new SingleInit( new CastExpr( dtorExpr, dtorType ) ) } ) );
1152                                                                function->statements->push_front( new DeclStmt( destructor ) );
1153                                                                destructor->attributes.push_back( new Attribute( "cleanup", { new VariableExpr( Validate::dtorStructDestroy ) } ) );
1154
1155                                                                function->statements->kids.splice( function->statements->kids.begin(), stmtsToAdd );
1156                                                        }
1157                                                } catch ( SemanticErrorException & error ) {
1158                                                        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" );
1159                                                }
1160                                        }
1161                                }
1162                        }
1163                        if (! errors.isEmpty()) {
1164                                throw errors;
1165                        }
1166                        return funcDecl;
1167                }
1168
1169                /// true if expr is effectively just the 'this' parameter
1170                bool isThisExpression( Expression * expr, DeclarationWithType * thisParam ) {
1171                        // TODO: there are more complicated ways to pass 'this' to a constructor, e.g. &*, *&, etc.
1172                        if ( VariableExpr * varExpr = dynamic_cast< VariableExpr * >( expr ) ) {
1173                                return varExpr->get_var() == thisParam;
1174                        } else if ( CastExpr * castExpr = dynamic_cast< CastExpr * > ( expr ) ) {
1175                                return isThisExpression( castExpr->get_arg(), thisParam );
1176                        }
1177                        return false;
1178                }
1179
1180                /// returns a MemberExpr if expr is effectively just member access on the 'this' parameter, else nullptr
1181                MemberExpr * isThisMemberExpr( Expression * expr, DeclarationWithType * thisParam ) {
1182                        if ( MemberExpr * memberExpr = dynamic_cast< MemberExpr * >( expr ) ) {
1183                                if ( isThisExpression( memberExpr->get_aggregate(), thisParam ) ) {
1184                                        return memberExpr;
1185                                }
1186                        } else if ( CastExpr * castExpr = dynamic_cast< CastExpr * >( expr ) ) {
1187                                return isThisMemberExpr( castExpr->get_arg(), thisParam );
1188                        }
1189                        return nullptr;
1190                }
1191
1192                void GenStructMemberCalls::premutate( ApplicationExpr * appExpr ) {
1193                        if ( ! checkWarnings( function ) ) {
1194                                visit_children = false;
1195                                return;
1196                        }
1197
1198                        std::string fname = getFunctionName( appExpr );
1199                        if ( fname == function->name ) {
1200                                // call to same kind of function
1201                                Expression * firstParam = appExpr->args.front();
1202
1203                                if ( isThisExpression( firstParam, thisParam ) ) {
1204                                        // if calling another constructor on thisParam, assume that function handles
1205                                        // all members - if it doesn't a warning will appear in that function.
1206                                        unhandled.clear();
1207                                } else if ( MemberExpr * memberExpr = isThisMemberExpr( firstParam, thisParam ) ) {
1208                                        // if first parameter is a member expression on the this parameter,
1209                                        // then remove the member from unhandled set.
1210                                        if ( isThisExpression( memberExpr->aggregate, thisParam ) ) {
1211                                                unhandled.erase( memberExpr->member );
1212                                        }
1213                                }
1214                        }
1215                }
1216
1217                void GenStructMemberCalls::premutate( MemberExpr * memberExpr ) {
1218                        if ( ! checkWarnings( function ) || ! isCtor ) {
1219                                visit_children = false;
1220                                return;
1221                        }
1222
1223                        if ( isThisExpression( memberExpr->get_aggregate(), thisParam ) ) {
1224                                if ( unhandled.count( memberExpr->get_member() ) ) {
1225                                        // emit a warning because a member was used before it was constructed
1226                                        usedUninit.insert( { memberExpr->get_member(), memberExpr->location } );
1227                                }
1228                        }
1229                }
1230
1231                template< typename Visitor, typename... Params >
1232                void error( Visitor & v, CodeLocation loc, const Params &... params ) {
1233                        SemanticErrorException err( loc, toString( params... ) );
1234                        v.errors.append( err );
1235                }
1236
1237                template< typename... Params >
1238                void GenStructMemberCalls::emit( CodeLocation loc, const Params &... params ) {
1239                        // toggle warnings vs. errors here.
1240                        // warn( params... );
1241                        error( *this, loc, params... );
1242                }
1243
1244                Expression * GenStructMemberCalls::postmutate( UntypedExpr * untypedExpr ) {
1245                        Expression * newExpr = untypedExpr;
1246                        ResolvExpr::findVoidExpression( newExpr, indexer );
1247                        return newExpr;
1248                }
1249
1250                Expression * FixCtorExprs::postmutate( ConstructorExpr * ctorExpr ) {
1251                        static UniqueName tempNamer( "_tmp_ctor_expr" );
1252                        // xxx - is the size check necessary?
1253                        assert( ctorExpr->result && ctorExpr->get_result()->size() == 1 );
1254
1255                        // xxx - this can be TupleAssignExpr now. Need to properly handle this case.
1256                        ApplicationExpr * callExpr = strict_dynamic_cast< ApplicationExpr * > ( ctorExpr->get_callExpr() );
1257                        TypeSubstitution * env = ctorExpr->get_env();
1258                        ctorExpr->set_callExpr( nullptr );
1259                        ctorExpr->set_env( nullptr );
1260
1261                        // 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.
1262                        ObjectDecl * tmp = ObjectDecl::newObject( tempNamer.newName(), callExpr->args.front()->result->clone(), nullptr );
1263                        declsToAddBefore.push_back( tmp );
1264                        delete ctorExpr;
1265
1266                        // build assignment and replace constructor's first argument with new temporary
1267                        Expression *& firstArg = callExpr->get_args().front();
1268                        Expression * assign = new UntypedExpr( new NameExpr( "?=?" ), { new AddressExpr( new VariableExpr( tmp ) ), new AddressExpr( firstArg ) } );
1269                        firstArg = new VariableExpr( tmp );
1270
1271                        // resolve assignment and dispose of new env
1272                        ResolvExpr::findVoidExpression( assign, indexer );
1273                        delete assign->env;
1274                        assign->env = nullptr;
1275
1276                        // for constructor expr:
1277                        //   T x;
1278                        //   x{};
1279                        // results in:
1280                        //   T x;
1281                        //   T & tmp;
1282                        //   &tmp = &x, ?{}(tmp), tmp
1283                        CommaExpr * commaExpr = new CommaExpr( assign, new CommaExpr( callExpr, new VariableExpr( tmp ) ) );
1284                        commaExpr->set_env( env );
1285                        return commaExpr;
1286                }
1287        } // namespace
1288} // namespace InitTweak
1289
1290// Local Variables: //
1291// tab-width: 4 //
1292// mode: c++ //
1293// compile-command: "make install" //
1294// End: //
Note: See TracBrowser for help on using the repository browser.