source: src/InitTweak/FixInitNew.cpp

Last change on this file was e01eb4a, checked in by Andrew Beach <ajbeach@…>, 2 months ago

Moved some functions from InitTweak? to Inspect.

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