source: src/InitTweak/FixInit.cc @ aaeacf4

arm-ehjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-expr
Last change on this file since aaeacf4 was aaeacf4, checked in by Thierry Delisle <tdelisle@…>, 2 years ago

Removed global look-up table from UniqueId? to Decl

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