source: src/InitTweak/FixInitNew.cpp @ 37b7d95

arm-ehjacob/cs343-translationnew-ast-unique-expr
Last change on this file since 37b7d95 was 37b7d95, checked in by Fangren Yu <f37yu@…>, 13 months ago

remove old information

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