source: src/InitTweak/FixInitNew.cpp @ 598dc68

ADTast-experimentalpthread-emulationqualifiedEnum
Last change on this file since 598dc68 was 8060b2b, checked in by Andrew Beach <ajbeach@…>, 23 months ago

Some recent work has taken me by ResolveCopyCtors?, while there I saw some clean-up to do.

  • Property mode set to 100644
File size: 58.5 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/CodeLocationTools.hpp"
19#include "Common/PassVisitor.h"        // for PassVisitor, WithStmtsToAdd
20#include "Common/SemanticError.h"      // for SemanticError
21#include "Common/UniqueName.h"         // for UniqueName
22#include "Common/utility.h"            // for CodeLocation, ValueGuard, toSt...
23#include "FixGlobalInit.h"             // for fixGlobalInit
24#include "GenInit.h"                   // for genCtorDtor
25#include "GenPoly/GenPoly.h"           // for getFunctionType
26#include "InitTweak.h"                 // for getFunctionName, getCallArg
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::WithConstTypeSubstitution, 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                assert( typeSubs );
460                expr->env = tmp;
461                return expr;
462        }
463
464        void ResolveCopyCtors::previsit(const ast::Expr * expr) {
465                if ( nullptr == expr->env ) {
466                        return;
467                }
468                GuardValue( env ) = expr->env->clone();
469                GuardValue( envModified ) = false;
470        }
471
472        const ast::Expr * ResolveCopyCtors::postvisit(const ast::Expr * expr) {
473                // No local environment, skip.
474                if ( nullptr == expr->env ) {
475                        return expr;
476                // Environment was modified, mutate and replace.
477                } else if ( envModified ) {
478                        auto mutExpr = mutate(expr);
479                        mutExpr->env = env;
480                        return mutExpr;
481                // Environment was not mutated, delete the shallow copy before guard.
482                } else {
483                        delete env;
484                        return expr;
485                }
486        }
487
488        bool ResolveCopyCtors::skipCopyConstruct( const ast::Type * type ) { return ! isConstructable( type ); }
489
490        const ast::Expr * ResolveCopyCtors::makeCtorDtor( const std::string & fname, const ast::ObjectDecl * var, const ast::Expr * cpArg ) {
491                assert( var );
492                assert( var->isManaged() );
493                assert( !cpArg || cpArg->isManaged() );
494                // arrays are not copy constructed, so this should always be an ExprStmt
495                ast::ptr< ast::Stmt > stmt = genCtorDtor(var->location, fname, var, cpArg );
496                assertf( stmt, "ResolveCopyCtors: genCtorDtor returned nullptr: %s / %s / %s", fname.c_str(), toString( var ).c_str(), toString( cpArg ).c_str() );
497                auto exprStmt = stmt.strict_as<ast::ImplicitCtorDtorStmt>()->callStmt.strict_as<ast::ExprStmt>();
498                ast::ptr<ast::Expr> untyped = exprStmt->expr; // take ownership of expr
499
500                // resolve copy constructor
501                // should only be one alternative for copy ctor and dtor expressions, since all arguments are fixed
502                // (VariableExpr and already resolved expression)
503                CP_CTOR_PRINT( std::cerr << "ResolvingCtorDtor " << untyped << std::endl; )
504                ast::ptr<ast::Expr> resolved = ResolvExpr::findVoidExpression(untyped, { symtab, transUnit().global } );
505                assert( resolved );
506                if ( resolved->env ) {
507                        // Extract useful information and discard new environments. Keeping them causes problems in PolyMutator passes.
508                        env->add( *resolved->env );
509                        envModified = true;
510                        auto mut = mutate(resolved.get());
511                        assertf(mut == resolved.get(), "newly resolved expression must be unique");
512                        mut->env = nullptr;
513                } // if
514                if ( auto assign = resolved.as<ast::TupleAssignExpr>() ) {
515                        // fix newly generated StmtExpr
516                        previsit( assign->stmtExpr );
517                }
518                return resolved.release();
519        }
520
521        ast::ptr<ast::Expr> ResolveCopyCtors::copyConstructArg(
522                const ast::Expr * arg, const ast::ImplicitCopyCtorExpr * impCpCtorExpr, const ast::Type * formal )
523        {
524                static UniqueName tempNamer("_tmp_cp");
525                assert( env );
526                const CodeLocation loc = impCpCtorExpr->location;
527                // CP_CTOR_PRINT( std::cerr << "Type Substitution: " << *env << std::endl; )
528                assert( arg->result );
529                ast::ptr<ast::Type> result = arg->result;
530                if ( skipCopyConstruct( result ) ) return arg; // skip certain non-copyable types
531
532                // type may involve type variables, so apply type substitution to get temporary variable's actual type,
533                // since result type may not be substituted (e.g., if the type does not appear in the parameter list)
534                // Use applyFree so that types bound in function pointers are not substituted, e.g. in forall(dtype T) void (*)(T).
535
536                // xxx - this originally mutates arg->result in place. is it correct?
537                result = env->applyFree( result.get() ).node;
538                auto mutResult = result.get_and_mutate();
539                mutResult->set_const(false);
540
541                auto mutArg = mutate(arg);
542                mutArg->result = mutResult;
543
544                ast::ptr<ast::Expr> guard = mutArg;
545
546                ast::ptr<ast::ObjectDecl> tmp = new ast::ObjectDecl(loc, "__tmp", mutResult, nullptr );
547
548                // create and resolve copy constructor
549                CP_CTOR_PRINT( std::cerr << "makeCtorDtor for an argument" << std::endl; )
550                auto cpCtor = makeCtorDtor( "?{}", tmp, mutArg );
551
552                if ( auto appExpr = dynamic_cast< const ast::ApplicationExpr * >( cpCtor ) ) {
553                        // if the chosen constructor is intrinsic, the copy is unnecessary, so
554                        // don't create the temporary and don't call the copy constructor
555                        auto function = appExpr->func.strict_as<ast::VariableExpr>();
556                        if ( function->var->linkage == ast::Linkage::Intrinsic ) {
557                                // arguments that need to be boxed need a temporary regardless of whether the copy constructor is intrinsic,
558                                // so that the object isn't changed inside of the polymorphic function
559                                if ( ! GenPoly::needsBoxing( formal, result, impCpCtorExpr->callExpr, env ) ) {
560                                        // xxx - should arg->result be mutated? see comment above.
561                                        return guard;
562                                }
563                        }
564                }
565
566                // set a unique name for the temporary once it's certain the call is necessary
567                auto mut = tmp.get_and_mutate();
568                assertf (mut == tmp, "newly created ObjectDecl must be unique");
569                mut->name = tempNamer.newName();
570
571                // replace argument to function call with temporary
572                stmtsToAddBefore.push_back( new ast::DeclStmt(loc, tmp ) );
573                arg = cpCtor;
574                return destructRet( tmp, arg );
575
576                // impCpCtorExpr->dtors.push_front( makeCtorDtor( "^?{}", tmp ) );
577        }
578
579        ast::Expr * ResolveCopyCtors::destructRet( const ast::ObjectDecl * ret, const ast::Expr * arg ) {
580                auto global = transUnit().global;
581                // TODO: refactor code for generating cleanup attribute, since it's common and reused in ~3-4 places
582                // check for existing cleanup attribute before adding another(?)
583                // need to add __Destructor for _tmp_cp variables as well
584
585                assertf( global.dtorStruct, "Destructor generation requires __Destructor definition." );
586                assertf( global.dtorStruct->members.size() == 2, "__Destructor definition does not have expected fields." );
587                assertf( global.dtorDestroy, "Destructor generation requires __destroy_Destructor." );
588
589                const CodeLocation loc = ret->location;
590
591                // generate a __Destructor for ret that calls the destructor
592                auto res = makeCtorDtor( "^?{}", ret );
593                auto dtor = mutate(res);
594
595                // if the chosen destructor is intrinsic, elide the generated dtor handler
596                if ( arg && isIntrinsicCallExpr( dtor ) ) {
597                        return new ast::CommaExpr(loc, arg, new ast::VariableExpr(loc, ret ) );
598                        // return;
599                }
600
601                if ( ! dtor->env ) dtor->env = maybeClone( env );
602                auto dtorFunc = getDtorFunc( ret, new ast::ExprStmt(loc, dtor ), stmtsToAddBefore );
603
604                auto dtorStructType = new ast::StructInstType( global.dtorStruct );
605
606                // what does this do???
607                dtorStructType->params.push_back( new ast::TypeExpr(loc, new ast::VoidType() ) );
608
609                // cast destructor pointer to void (*)(void *), to silence GCC incompatible pointer warnings
610                auto dtorFtype = new ast::FunctionType();
611                dtorFtype->params.push_back( new ast::PointerType(new ast::VoidType( ) ) );
612                auto dtorType = new ast::PointerType( dtorFtype );
613
614                static UniqueName namer( "_ret_dtor" );
615                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 ) ) } ) );
616                retDtor->attributes.push_back( new ast::Attribute( "cleanup", { new ast::VariableExpr(loc, global.dtorDestroy ) } ) );
617                stmtsToAddBefore.push_back( new ast::DeclStmt(loc, retDtor ) );
618
619                if ( arg ) {
620                        auto member = new ast::MemberExpr(loc, global.dtorStruct->members.front().strict_as<ast::DeclWithType>(), new ast::VariableExpr(loc, retDtor ) );
621                        auto object = new ast::CastExpr( new ast::AddressExpr( new ast::VariableExpr(loc, ret ) ), new ast::PointerType(new ast::VoidType() ) );
622                        ast::Expr * assign = createBitwiseAssignment( member, object );
623                        return new ast::CommaExpr(loc, new ast::CommaExpr(loc, arg, assign ), new ast::VariableExpr(loc, ret ) );
624                }
625                return nullptr;
626                // impCpCtorExpr->get_dtors().push_front( makeCtorDtor( "^?{}", ret ) );
627        }
628
629        const ast::Expr * ResolveCopyCtors::postvisit( const ast::ImplicitCopyCtorExpr *impCpCtorExpr ) {
630                CP_CTOR_PRINT( std::cerr << "ResolveCopyCtors: " << impCpCtorExpr << std::endl; )
631
632                ast::ApplicationExpr * appExpr = mutate(impCpCtorExpr->callExpr.get());
633                const ast::ObjectDecl * returnDecl = nullptr;
634                const CodeLocation loc = appExpr->location;
635
636                // take each argument and attempt to copy construct it.
637                auto ftype = GenPoly::getFunctionType( appExpr->func->result );
638                assert( ftype );
639                auto & params = ftype->params;
640                auto iter = params.begin();
641                for ( auto & arg : appExpr->args ) {
642                        const ast::Type * formal = nullptr;
643                        if ( iter != params.end() ) { // does not copy construct C-style variadic arguments
644                                // DeclarationWithType * param = *iter++;
645                                formal = *iter++;
646                        }
647
648                        arg = copyConstructArg( arg, impCpCtorExpr, formal );
649                } // for
650
651                // each return value from the call needs to be connected with an ObjectDecl at the call site, which is
652                // initialized with the return value and is destructed later
653                // xxx - handle named return values?
654                const ast::Type * result = appExpr->result;
655                if ( ! result->isVoid() ) {
656                        static UniqueName retNamer("_tmp_cp_ret");
657                        // result = result->clone();
658                        auto subResult = env->apply( result ).node;
659                        auto ret = new ast::ObjectDecl(loc, retNamer.newName(), subResult, nullptr );
660                        auto mutType = mutate(ret->type.get());
661                        mutType->set_const( false );
662                        ret->type = mutType;
663                        returnDecl = ret;
664                        stmtsToAddBefore.push_back( new ast::DeclStmt(loc, ret ) );
665                        CP_CTOR_PRINT( std::cerr << "makeCtorDtor for a return" << std::endl; )
666                } // for
667                CP_CTOR_PRINT( std::cerr << "after Resolving: " << impCpCtorExpr << std::endl; )
668                // ------------------------------------------------------
669
670                CP_CTOR_PRINT( std::cerr << "Coming out the back..." << impCpCtorExpr << std::endl; )
671
672                // detach fields from wrapper node so that it can be deleted without deleting too much
673
674                // xxx - actual env might be somewhere else, need to keep invariant
675
676                // deletion of wrapper should be handled by pass template now
677
678                // impCpCtorExpr->callExpr = nullptr;
679                assert (appExpr->env == nullptr);
680                appExpr->env = impCpCtorExpr->env;
681                // std::swap( impCpCtorExpr->env, appExpr->env );
682                // assert( impCpCtorExpr->env == nullptr );
683                // delete impCpCtorExpr;
684
685                if ( returnDecl ) {
686                        ast::Expr * assign = createBitwiseAssignment( new ast::VariableExpr(loc, returnDecl ), appExpr );
687                        if ( ! dynamic_cast< const ast::ReferenceType * >( result ) ) {
688                                // destructing reference returns is bad because it can cause multiple destructor calls to the same object - the returned object is not a temporary
689                                assign = destructRet( returnDecl, assign );
690                                assert(assign);
691                        } else {
692                                assign = new ast::CommaExpr(loc, assign, new ast::VariableExpr(loc, returnDecl ) );
693                        }
694                        // move env from appExpr to retExpr
695                        // std::swap( assign->env, appExpr->env );
696                        assign->env = appExpr->env;
697                        // actual env is handled by common routine that replaces WithTypeSubstitution
698                        return postvisit((const ast::Expr *)assign);
699                } else {
700                        return postvisit((const ast::Expr *)appExpr);
701                } // if
702        }
703
704        const ast::StmtExpr * ResolveCopyCtors::previsit( const ast::StmtExpr * _stmtExpr ) {
705                // function call temporaries should be placed at statement-level, rather than nested inside of a new statement expression,
706                // since temporaries can be shared across sub-expressions, e.g.
707                //   [A, A] f();       // decl
708                //   g([A] x, [A] y);  // decl
709                //   g(f());           // call
710                // f is executed once, so the return temporary is shared across the tuple constructors for x and y.
711                // Explicitly mutating children instead of mutating the inner compound statement forces the temporaries to be added
712                // to the outer context, rather than inside of the statement expression.
713
714                // call the common routine that replaces WithTypeSubstitution
715                previsit((const ast::Expr *) _stmtExpr);
716
717                visit_children = false;
718                const CodeLocation loc = _stmtExpr->location;
719
720                assert( env );
721
722                symtab.enterScope();
723                // visit all statements
724                auto stmtExpr = mutate(_stmtExpr);
725                auto mutStmts = mutate(stmtExpr->stmts.get());
726
727                auto & stmts = mutStmts->kids;
728                for ( auto & stmt : stmts ) {
729                        stmt = stmt->accept( *visitor );
730                } // for
731                stmtExpr->stmts = mutStmts;
732                symtab.leaveScope();
733
734                assert( stmtExpr->result );
735                // const ast::Type * result = stmtExpr->result;
736                if ( ! stmtExpr->result->isVoid() ) {
737                        static UniqueName retNamer("_tmp_stmtexpr_ret");
738
739                        // result = result->clone();
740                        auto result = env->apply( stmtExpr->result.get() ).node;
741                        if ( ! InitTweak::isConstructable( result ) ) {
742                                // delete result;
743                                return stmtExpr;
744                        }
745                        auto mutResult = result.get_and_mutate();
746                        mutResult->set_const(false);
747
748                        // create variable that will hold the result of the stmt expr
749                        auto ret = new ast::ObjectDecl(loc, retNamer.newName(), mutResult, nullptr );
750                        stmtsToAddBefore.push_back( new ast::DeclStmt(loc, ret ) );
751
752                        assertf(
753                                stmtExpr->resultExpr,
754                                "Statement-Expression should have a resulting expression at %s:%d",
755                                stmtExpr->location.filename.c_str(),
756                                stmtExpr->location.first_line
757                        );
758
759                        const ast::ExprStmt * last = stmtExpr->resultExpr;
760                        // xxx - if this is non-unique, need to copy while making resultExpr ref
761                        assertf(last->unique(), "attempt to modify weakly shared statement");
762                        auto mutLast = mutate(last);
763                        // above assertion means in-place mutation is OK
764                        try {
765                                mutLast->expr = makeCtorDtor( "?{}", ret, mutLast->expr );
766                        } catch(...) {
767                                std::cerr << "*CFA internal error: ";
768                                std::cerr << "can't resolve implicit constructor";
769                                std::cerr << " at " << stmtExpr->location.filename;
770                                std::cerr << ":" << stmtExpr->location.first_line << std::endl;
771
772                                abort();
773                        }
774
775                        // add destructors after current statement
776                        stmtsToAddAfter.push_back( new ast::ExprStmt(loc, makeCtorDtor( "^?{}", ret ) ) );
777
778                        // must have a non-empty body, otherwise it wouldn't have a result
779                        assert( ! stmts.empty() );
780
781                        // if there is a return decl, add a use as the last statement; will not have return decl on non-constructable returns
782                        stmts.push_back( new ast::ExprStmt(loc, new ast::VariableExpr(loc, ret ) ) );
783                } // if
784
785                assert( stmtExpr->returnDecls.empty() );
786                assert( stmtExpr->dtors.empty() );
787
788                return stmtExpr;
789        }
790
791        // to prevent warnings ('_unq0' may be used uninitialized in this function),
792        // insert an appropriate zero initializer for UniqueExpr temporaries.
793        ast::Init * makeInit( const ast::Type * t, CodeLocation const & loc ) {
794                if ( auto inst = dynamic_cast< const ast::StructInstType * >( t ) ) {
795                        // initizer for empty struct must be empty
796                        if ( inst->base->members.empty() ) {
797                                return new ast::ListInit( loc, {} );
798                        }
799                } else if ( auto inst = dynamic_cast< const ast::UnionInstType * >( t ) ) {
800                        // initizer for empty union must be empty
801                        if ( inst->base->members.empty() ) {
802                                return new ast::ListInit( loc, {} );
803                        }
804                }
805
806                return new ast::ListInit( loc, {
807                        new ast::SingleInit( loc, ast::ConstantExpr::from_int( loc, 0 ) )
808                } );
809        }
810
811        const ast::UniqueExpr * ResolveCopyCtors::previsit( const ast::UniqueExpr * unqExpr ) {
812                visit_children = false;
813                // xxx - hack to prevent double-handling of unique exprs, otherwise too many temporary variables and destructors are generated
814                static std::unordered_map< int, const ast::UniqueExpr * > unqMap;
815                auto mutExpr = mutate(unqExpr);
816                if ( ! unqMap.count( unqExpr->id ) ) {
817                        // resolve expr and find its
818
819                        auto impCpCtorExpr = mutExpr->expr.as<ast::ImplicitCopyCtorExpr>();
820                        // PassVisitor<ResolveCopyCtors> fixer;
821
822                        mutExpr->expr = mutExpr->expr->accept( *visitor );
823                        // it should never be necessary to wrap a void-returning expression in a UniqueExpr - if this assumption changes, this needs to be rethought
824                        assert( unqExpr->result );
825                        if ( impCpCtorExpr ) {
826                                auto comma = unqExpr->expr.strict_as<ast::CommaExpr>();
827                                auto var = comma->arg2.strict_as<ast::VariableExpr>();
828                                // note the variable used as the result from the call
829                                mutExpr->var = var;
830                        } else {
831                                // expr isn't a call expr, so create a new temporary variable to use to hold the value of the unique expression
832                                mutExpr->object = new ast::ObjectDecl( mutExpr->location, toString("_unq", mutExpr->id), mutExpr->result, makeInit( mutExpr->result, mutExpr->location ) );
833                                mutExpr->var = new ast::VariableExpr( mutExpr->location, mutExpr->object );
834                        }
835
836                        // stmtsToAddBefore.splice( stmtsToAddBefore.end(), fixer.pass.stmtsToAddBefore );
837                        // stmtsToAddAfter.splice( stmtsToAddAfter.end(), fixer.pass.stmtsToAddAfter );
838                        unqMap[mutExpr->id] = mutExpr;
839                } else {
840                        // take data from other UniqueExpr to ensure consistency
841                        // delete unqExpr->get_expr();
842                        mutExpr->expr = unqMap[mutExpr->id]->expr;
843                        // delete unqExpr->result;
844                        mutExpr->result = mutExpr->expr->result;
845                }
846                return mutExpr;
847        }
848
849        const ast::DeclWithType * FixInit::postvisit( const ast::ObjectDecl *_objDecl ) {
850                const CodeLocation loc = _objDecl->location;
851
852                // since this removes the init field from objDecl, it must occur after children are mutated (i.e. postvisit)
853                if ( ast::ptr<ast::ConstructorInit> ctorInit = _objDecl->init.as<ast::ConstructorInit>() ) {
854                        auto objDecl = mutate(_objDecl);
855
856                        // could this be non-unique?
857                        if (objDecl != _objDecl) {
858                                std::cerr << "FixInit: non-unique object decl " << objDecl->location << objDecl->name << std::endl;
859                        }
860                        // a decision should have been made by the resolver, so ctor and init are not both non-NULL
861                        assert( ! ctorInit->ctor || ! ctorInit->init );
862                        if ( const ast::Stmt * ctor = ctorInit->ctor ) {
863                                if ( objDecl->storage.is_static ) {
864                                        addDataSectionAttribute(objDecl);
865                                        // originally wanted to take advantage of gcc nested functions, but
866                                        // we get memory errors with this approach. To remedy this, the static
867                                        // variable is hoisted when the destructor needs to be called.
868                                        //
869                                        // generate:
870                                        // static T __objName_static_varN;
871                                        // void __objName_dtor_atexitN() {
872                                        //   __dtor__...;
873                                        // }
874                                        // int f(...) {
875                                        //   ...
876                                        //   static bool __objName_uninitialized = true;
877                                        //   if (__objName_uninitialized) {
878                                        //     __ctor(__objName);
879                                        //     __objName_uninitialized = false;
880                                        //     atexit(__objName_dtor_atexitN);
881                                        //   }
882                                        //   ...
883                                        // }
884
885                                        static UniqueName dtorCallerNamer( "_dtor_atexit" );
886
887                                        // static bool __objName_uninitialized = true
888                                        auto boolType = new ast::BasicType( ast::BasicType::Kind::Bool );
889                                        auto boolInitExpr = new ast::SingleInit(loc, ast::ConstantExpr::from_int(loc, 1 ) );
890                                        auto isUninitializedVar = new ast::ObjectDecl(loc, objDecl->mangleName + "_uninitialized", boolType, boolInitExpr, ast::Storage::Static, ast::Linkage::Cforall);
891                                        isUninitializedVar->fixUniqueId();
892
893                                        // __objName_uninitialized = false;
894                                        auto setTrue = new ast::UntypedExpr(loc, new ast::NameExpr(loc, "?=?" ) );
895                                        setTrue->args.push_back( new ast::VariableExpr(loc, isUninitializedVar ) );
896                                        setTrue->args.push_back( ast::ConstantExpr::from_int(loc, 0 ) );
897
898                                        // generate body of if
899                                        auto initStmts = new ast::CompoundStmt(loc);
900                                        auto & body = initStmts->kids;
901                                        body.push_back( ctor );
902                                        body.push_back( new ast::ExprStmt(loc, setTrue ) );
903
904                                        // put it all together
905                                        auto ifStmt = new ast::IfStmt(loc, new ast::VariableExpr(loc, isUninitializedVar ), initStmts, 0 );
906                                        stmtsToAddAfter.push_back( new ast::DeclStmt(loc, isUninitializedVar ) );
907                                        stmtsToAddAfter.push_back( ifStmt );
908
909                                        const ast::Stmt * dtor = ctorInit->dtor;
910
911                                        // these should be automatically managed once reassigned
912                                        // objDecl->set_init( nullptr );
913                                        // ctorInit->set_ctor( nullptr );
914                                        // ctorInit->set_dtor( nullptr );
915                                        if ( dtor ) {
916                                                // if the object has a non-trivial destructor, have to
917                                                // hoist it and the object into the global space and
918                                                // call the destructor function with atexit.
919
920                                                // Statement * dtorStmt = dtor->clone();
921
922                                                // void __objName_dtor_atexitN(...) {...}
923                                                ast::FunctionDecl * dtorCaller = new ast::FunctionDecl(loc, objDecl->mangleName + dtorCallerNamer.newName(), {}, {}, {}, new ast::CompoundStmt(loc, {dtor}), ast::Storage::Static, ast::Linkage::C );
924                                                dtorCaller->fixUniqueId();
925                                                // dtorCaller->stmts->push_back( dtor );
926
927                                                // atexit(dtor_atexit);
928                                                auto callAtexit = new ast::UntypedExpr(loc, new ast::NameExpr(loc, "atexit" ) );
929                                                callAtexit->args.push_back( new ast::VariableExpr(loc, dtorCaller ) );
930
931                                                body.push_back( new ast::ExprStmt(loc, callAtexit ) );
932
933                                                // hoist variable and dtor caller decls to list of decls that will be added into global scope
934                                                staticDtorDecls.push_back( objDecl );
935                                                staticDtorDecls.push_back( dtorCaller );
936
937                                                // need to rename object uniquely since it now appears
938                                                // at global scope and there could be multiple function-scoped
939                                                // static variables with the same name in different functions.
940                                                // Note: it isn't sufficient to modify only the mangleName, because
941                                                // then subsequent Indexer passes can choke on seeing the object's name
942                                                // if another object has the same name and type. An unfortunate side-effect
943                                                // of renaming the object is that subsequent NameExprs may fail to resolve,
944                                                // but there shouldn't be any remaining past this point.
945                                                static UniqueName staticNamer( "_static_var" );
946                                                objDecl->name = objDecl->name + staticNamer.newName();
947                                                objDecl->mangleName = Mangle::mangle( objDecl );
948                                                objDecl->init = nullptr;
949
950                                                // xxx - temporary hack: need to return a declaration, but want to hoist the current object out of this scope
951                                                // create a new object which is never used
952                                                static UniqueName dummyNamer( "_dummy" );
953                                                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") } );
954                                                // delete ctorInit;
955                                                return dummy;
956                                        } else {
957                                                objDecl->init = nullptr;
958                                                return objDecl;
959                                        }
960                                } else {
961                                        auto implicit = strict_dynamic_cast< const ast::ImplicitCtorDtorStmt * > ( ctor );
962                                        auto ctorStmt = implicit->callStmt.as<ast::ExprStmt>();
963                                        const ast::ApplicationExpr * ctorCall = nullptr;
964                                        if ( ctorStmt && (ctorCall = isIntrinsicCallExpr( ctorStmt->expr )) && ctorCall->args.size() == 2 ) {
965                                                // clean up intrinsic copy constructor calls by making them into SingleInits
966                                                const ast::Expr * ctorArg = ctorCall->args.back();
967                                                // ctorCall should be gone afterwards
968                                                auto mutArg = mutate(ctorArg);
969                                                mutArg->env = ctorCall->env;
970                                                // std::swap( ctorArg->env, ctorCall->env );
971                                                objDecl->init = new ast::SingleInit(loc, mutArg );
972
973                                                // ctorCall->args.pop_back();
974                                        } else {
975                                                stmtsToAddAfter.push_back( ctor );
976                                                objDecl->init = nullptr;
977                                                // ctorInit->ctor = nullptr;
978                                        }
979
980                                        const ast::Stmt * dtor = ctorInit->dtor;
981                                        if ( dtor ) {
982                                                auto implicit = strict_dynamic_cast< const ast::ImplicitCtorDtorStmt * >( dtor );
983                                                const ast::Stmt * dtorStmt = implicit->callStmt;
984
985                                                // don't need to call intrinsic dtor, because it does nothing, but
986                                                // non-intrinsic dtors must be called
987                                                if ( ! isIntrinsicSingleArgCallStmt( dtorStmt ) ) {
988                                                        // set dtor location to the object's location for error messages
989                                                        auto dtorFunc = getDtorFunc( objDecl, dtorStmt, stmtsToAddBefore );
990                                                        objDecl->attributes.push_back( new ast::Attribute( "cleanup", { new ast::VariableExpr(loc, dtorFunc ) } ) );
991                                                        // ctorInit->dtor = nullptr;
992                                                } // if
993                                        }
994                                } // if
995                        } else if ( const ast::Init * init = ctorInit->init ) {
996                                objDecl->init = init;
997                                // ctorInit->init = nullptr;
998                        } else {
999                                // no constructor and no initializer, which is okay
1000                                objDecl->init = nullptr;
1001                        } // if
1002                        // delete ctorInit;
1003                        return objDecl;
1004                } // if
1005                return _objDecl;
1006        }
1007
1008        void ObjDeclCollector::previsit( const ast::CompoundStmt * ) {
1009                GuardValue( curVars );
1010        }
1011
1012        void ObjDeclCollector::previsit( const ast::DeclStmt * stmt ) {
1013                // keep track of all variables currently in scope
1014                if ( auto objDecl = stmt->decl.as<ast::ObjectDecl>() ) {
1015                        curVars.push_back( objDecl );
1016                } // if
1017        }
1018
1019        void LabelFinder::previsit( const ast::Stmt * stmt ) {
1020                // for each label, remember the variables in scope at that label.
1021                for ( auto l : stmt->labels ) {
1022                        vars[l] = curVars;
1023                } // for
1024        }
1025
1026        void LabelFinder::previsit( const ast::CompoundStmt * stmt ) {
1027                previsit( (const ast::Stmt *) stmt );
1028                Parent::previsit( stmt );
1029        }
1030
1031        void LabelFinder::previsit( const ast::DeclStmt * stmt ) {
1032                previsit( (const ast::Stmt *)stmt );
1033                Parent::previsit( stmt );
1034        }
1035
1036
1037        void InsertDtors::previsit( const ast::FunctionDecl * funcDecl ) {
1038                // each function needs to have its own set of labels
1039                GuardValue( labelVars );
1040                labelVars.clear();
1041                // LabelFinder does not recurse into FunctionDecl, so need to visit
1042                // its children manually.
1043                if (funcDecl->type) funcDecl->type->accept(finder);
1044                // maybeAccept( funcDecl->type, finder );
1045                if (funcDecl->stmts) funcDecl->stmts->accept(finder) ;
1046
1047                // all labels for this function have been collected, insert destructors as appropriate via implicit recursion.
1048        }
1049
1050        // Handle break/continue/goto in the same manner as C++.  Basic idea: any objects that are in scope at the
1051        // BranchStmt but not at the labelled (target) statement must be destructed.  If there are any objects in scope
1052        // at the target location but not at the BranchStmt then those objects would be uninitialized so notify the user
1053        // of the error.  See C++ Reference 6.6 Jump Statements for details.
1054        void InsertDtors::handleGoto( const ast::BranchStmt * stmt ) {
1055                // can't do anything for computed goto
1056                if ( stmt->computedTarget ) return;
1057
1058                assertf( stmt->target.name != "", "BranchStmt missing a label: %s", toString( stmt ).c_str() );
1059                // S_L = lvars = set of objects in scope at label definition
1060                // S_G = curVars = set of objects in scope at goto statement
1061                ObjectSet & lvars = labelVars[ stmt->target ];
1062
1063                DTOR_PRINT(
1064                        std::cerr << "at goto label: " << stmt->target.name << std::endl;
1065                        std::cerr << "S_G = " << printSet( curVars ) << std::endl;
1066                        std::cerr << "S_L = " << printSet( lvars ) << std::endl;
1067                )
1068
1069
1070                // std::set_difference requires that the inputs be sorted.
1071                lvars.sort();
1072                curVars.sort();
1073
1074                ObjectSet diff;
1075                // S_L-S_G results in set of objects whose construction is skipped - it's an error if this set is non-empty
1076                std::set_difference( lvars.begin(), lvars.end(), curVars.begin(), curVars.end(), std::inserter( diff, diff.begin() ) );
1077                DTOR_PRINT(
1078                        std::cerr << "S_L-S_G = " << printSet( diff ) << std::endl;
1079                )
1080                if ( ! diff.empty() ) {
1081                        SemanticError( stmt, std::string("jump to label '") + stmt->target.name + "' crosses initialization of " + (*diff.begin())->name + " " );
1082                } // if
1083        }
1084
1085        void InsertDtors::previsit( const ast::BranchStmt * stmt ) {
1086                switch( stmt->kind ) {
1087                  case ast::BranchStmt::Continue:
1088                  case ast::BranchStmt::Break:
1089                        // could optimize the break/continue case, because the S_L-S_G check is unnecessary (this set should
1090                        // always be empty), but it serves as a small sanity check.
1091                  case ast::BranchStmt::Goto:
1092                        handleGoto( stmt );
1093                        break;
1094                  default:
1095                        assert( false );
1096                } // switch
1097        }
1098
1099        bool checkWarnings( const ast::FunctionDecl * funcDecl ) {
1100                // only check for warnings if the current function is a user-defined
1101                // constructor or destructor
1102                if ( ! funcDecl ) return false;
1103                if ( ! funcDecl->stmts ) return false;
1104                return CodeGen::isCtorDtor( funcDecl->name ) && ! funcDecl->linkage.is_overrideable;
1105        }
1106
1107        void GenStructMemberCalls::previsit( const ast::FunctionDecl * funcDecl ) {
1108                GuardValue( function );
1109                GuardValue( unhandled );
1110                GuardValue( usedUninit );
1111                GuardValue( thisParam );
1112                GuardValue( isCtor );
1113                GuardValue( structDecl );
1114                errors = SemanticErrorException();  // clear previous errors
1115
1116                // need to start with fresh sets
1117                unhandled.clear();
1118                usedUninit.clear();
1119
1120                function = mutate(funcDecl);
1121                // could this be non-unique?
1122                if (function != funcDecl) {
1123                        std::cerr << "GenStructMemberCalls: non-unique FunctionDecl " << funcDecl->location << funcDecl->name << std::endl;
1124                }
1125
1126                isCtor = CodeGen::isConstructor( function->name );
1127                if ( checkWarnings( function ) ) {
1128                        // const ast::FunctionType * type = function->type;
1129                        // assert( ! type->params.empty() );
1130                        thisParam = function->params.front().strict_as<ast::ObjectDecl>();
1131                        auto thisType = getPointerBase( thisParam->get_type() );
1132                        auto structType = dynamic_cast< const ast::StructInstType * >( thisType );
1133                        if ( structType ) {
1134                                structDecl = structType->base;
1135                                for ( auto & member : structDecl->members ) {
1136                                        if ( auto field = member.as<ast::ObjectDecl>() ) {
1137                                                // record all of the struct type's members that need to be constructed or
1138                                                // destructed by the end of the function
1139                                                unhandled.insert( field );
1140                                        }
1141                                }
1142                        }
1143                }
1144        }
1145
1146        const ast::DeclWithType * GenStructMemberCalls::postvisit( const ast::FunctionDecl * funcDecl ) {
1147                // remove the unhandled objects from usedUninit, because a call is inserted
1148                // to handle them - only objects that are later constructed are used uninitialized.
1149                std::map< const ast::DeclWithType *, CodeLocation > diff;
1150                // need the comparator since usedUninit and unhandled have different types
1151                struct comp_t {
1152                        typedef decltype(usedUninit)::value_type usedUninit_t;
1153                        typedef decltype(unhandled)::value_type unhandled_t;
1154                        bool operator()(usedUninit_t x, unhandled_t y) { return x.first < y; }
1155                        bool operator()(unhandled_t x, usedUninit_t y) { return x < y.first; }
1156                } comp;
1157                std::set_difference( usedUninit.begin(), usedUninit.end(), unhandled.begin(), unhandled.end(), std::inserter( diff, diff.begin() ), comp );
1158                for ( auto p : diff ) {
1159                        auto member = p.first;
1160                        auto loc = p.second;
1161                        // xxx - make error message better by also tracking the location that the object is constructed at?
1162                        emit( loc, "in ", function->name, ", field ", member->name, " used before being constructed" );
1163                }
1164
1165                const CodeLocation loc = funcDecl->location;
1166
1167                if ( ! unhandled.empty() ) {
1168                        auto mutStmts = function->stmts.get_and_mutate();
1169                        // need to explicitly re-add function parameters to the indexer in order to resolve copy constructors
1170                        auto guard = makeFuncGuard( [this]() { symtab.enterScope(); }, [this]() { symtab.leaveScope(); } );
1171                        symtab.addFunction( function );
1172                        auto global = transUnit().global;
1173
1174                        // need to iterate through members in reverse in order for
1175                        // ctor/dtor statements to come out in the right order
1176                        for ( auto & member : reverseIterate( structDecl->members ) ) {
1177                                auto field = member.as<ast::ObjectDecl>();
1178                                // skip non-DWT members
1179                                if ( ! field ) continue;
1180                                // skip non-constructable members
1181                                if ( ! tryConstruct( field ) ) continue;
1182                                // skip handled members
1183                                if ( ! unhandled.count( field ) ) continue;
1184
1185                                // insert and resolve default/copy constructor call for each field that's unhandled
1186                                // std::list< const ast::Stmt * > stmt;
1187                                ast::Expr * arg2 = nullptr;
1188                                if ( function->name == "?{}" && isCopyFunction( function ) ) {
1189                                        // if copy ctor, need to pass second-param-of-this-function.field
1190                                        // std::list< DeclarationWithType * > & params = function->get_functionType()->get_parameters();
1191                                        assert( function->params.size() == 2 );
1192                                        arg2 = new ast::MemberExpr(funcDecl->location, field, new ast::VariableExpr(funcDecl->location, function->params.back() ) );
1193                                }
1194                                InitExpander_new srcParam( arg2 );
1195                                // cast away reference type and construct field.
1196                                ast::Expr * thisExpr = new ast::CastExpr(funcDecl->location, new ast::VariableExpr(funcDecl->location, thisParam ), thisParam->get_type()->stripReferences());
1197                                ast::Expr * memberDest = new ast::MemberExpr(funcDecl->location, field, thisExpr );
1198                                ast::ptr<ast::Stmt> callStmt = SymTab::genImplicitCall( srcParam, memberDest, loc, function->name, field, static_cast<SymTab::LoopDirection>(isCtor) );
1199
1200                                if ( callStmt ) {
1201                                        // auto & callStmt = stmt.front();
1202
1203                                        try {
1204                                                callStmt = callStmt->accept( *visitor );
1205                                                if ( isCtor ) {
1206                                                        mutStmts->push_front( callStmt );
1207                                                } else { // TODO: don't generate destructor function/object for intrinsic calls
1208                                                        // destructor statements should be added at the end
1209                                                        // function->get_statements()->push_back( callStmt );
1210
1211                                                        // Optimization: do not need to call intrinsic destructors on members
1212                                                        if ( isIntrinsicSingleArgCallStmt( callStmt ) ) continue;
1213
1214                                                        // __Destructor _dtor0 = { (void *)&b.a1, (void (*)(void *)_destroy_A };
1215                                                        std::list< ast::ptr<ast::Stmt> > stmtsToAdd;
1216
1217                                                        static UniqueName memberDtorNamer = { "__memberDtor" };
1218                                                        assertf( global.dtorStruct, "builtin __Destructor not found." );
1219                                                        assertf( global.dtorDestroy, "builtin __destroy_Destructor not found." );
1220
1221                                                        ast::Expr * thisExpr = new ast::CastExpr( new ast::AddressExpr( new ast::VariableExpr(loc, thisParam ) ), new ast::PointerType( new ast::VoidType(), ast::CV::Qualifiers() ) );
1222                                                        ast::Expr * dtorExpr = new ast::VariableExpr(loc, getDtorFunc( thisParam, callStmt, stmtsToAdd ) );
1223
1224                                                        // cast destructor pointer to void (*)(void *), to silence GCC incompatible pointer warnings
1225                                                        auto dtorFtype = new ast::FunctionType();
1226                                                        dtorFtype->params.emplace_back( new ast::PointerType( new ast::VoidType() ) );
1227                                                        auto dtorType = new ast::PointerType( dtorFtype );
1228
1229                                                        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 ) ) } ) );
1230                                                        destructor->attributes.push_back( new ast::Attribute( "cleanup", { new ast::VariableExpr( loc, global.dtorDestroy ) } ) );
1231                                                        mutStmts->push_front( new ast::DeclStmt(loc, destructor ) );
1232                                                        mutStmts->kids.splice( mutStmts->kids.begin(), stmtsToAdd );
1233                                                }
1234                                        } catch ( SemanticErrorException & error ) {
1235                                                emit( funcDecl->location, "in ", function->name , ", field ", field->name, " not explicitly ", isCtor ? "constructed" : "destructed",  " and no ", isCtor ? "default constructor" : "destructor", " found" );
1236                                        }
1237                                }
1238                        }
1239                        function->stmts = mutStmts;
1240                }
1241                if (! errors.isEmpty()) {
1242                        throw errors;
1243                }
1244                // return funcDecl;
1245                return function;
1246        }
1247
1248        /// true if expr is effectively just the 'this' parameter
1249        bool isThisExpression( const ast::Expr * expr, const ast::DeclWithType * thisParam ) {
1250                // TODO: there are more complicated ways to pass 'this' to a constructor, e.g. &*, *&, etc.
1251                if ( auto varExpr = dynamic_cast< const ast::VariableExpr * >( expr ) ) {
1252                        return varExpr->var == thisParam;
1253                } else if ( auto castExpr = dynamic_cast< const ast::CastExpr * > ( expr ) ) {
1254                        return isThisExpression( castExpr->arg, thisParam );
1255                }
1256                return false;
1257        }
1258
1259        /// returns a MemberExpr if expr is effectively just member access on the 'this' parameter, else nullptr
1260        const ast::MemberExpr * isThisMemberExpr( const ast::Expr * expr, const ast::DeclWithType * thisParam ) {
1261                if ( auto memberExpr = dynamic_cast< const ast::MemberExpr * >( expr ) ) {
1262                        if ( isThisExpression( memberExpr->aggregate, thisParam ) ) {
1263                                return memberExpr;
1264                        }
1265                } else if ( auto castExpr = dynamic_cast< const ast::CastExpr * >( expr ) ) {
1266                        return isThisMemberExpr( castExpr->arg, thisParam );
1267                }
1268                return nullptr;
1269        }
1270
1271        void GenStructMemberCalls::previsit( const ast::ApplicationExpr * appExpr ) {
1272                if ( ! checkWarnings( function ) ) {
1273                        visit_children = false;
1274                        return;
1275                }
1276
1277                std::string fname = getFunctionName( appExpr );
1278                if ( fname == function->name ) {
1279                        // call to same kind of function
1280                        const ast::Expr * firstParam = appExpr->args.front();
1281
1282                        if ( isThisExpression( firstParam, thisParam ) ) {
1283                                // if calling another constructor on thisParam, assume that function handles
1284                                // all members - if it doesn't a warning will appear in that function.
1285                                unhandled.clear();
1286                        } else if ( auto memberExpr = isThisMemberExpr( firstParam, thisParam ) ) {
1287                                // if first parameter is a member expression on the this parameter,
1288                                // then remove the member from unhandled set.
1289                                if ( isThisExpression( memberExpr->aggregate, thisParam ) ) {
1290                                        unhandled.erase( memberExpr->member );
1291                                }
1292                        }
1293                }
1294        }
1295
1296        void GenStructMemberCalls::previsit( const ast::MemberExpr * memberExpr ) {
1297                if ( ! checkWarnings( function ) || ! isCtor ) {
1298                        visit_children = false;
1299                        return;
1300                }
1301
1302                if ( isThisExpression( memberExpr->aggregate, thisParam ) ) {
1303                        if ( unhandled.count( memberExpr->member ) ) {
1304                                // emit a warning because a member was used before it was constructed
1305                                usedUninit.insert( { memberExpr->member, memberExpr->location } );
1306                        }
1307                }
1308        }
1309
1310        template< typename Visitor, typename... Params >
1311        void error( Visitor & v, CodeLocation loc, const Params &... params ) {
1312                SemanticErrorException err( loc, toString( params... ) );
1313                v.errors.append( err );
1314        }
1315
1316        template< typename... Params >
1317        void GenStructMemberCalls::emit( CodeLocation loc, const Params &... params ) {
1318                // toggle warnings vs. errors here.
1319                // warn( params... );
1320                error( *this, loc, params... );
1321        }
1322
1323        const ast::Expr * GenStructMemberCalls::postvisit( const ast::UntypedExpr * untypedExpr ) {
1324                // xxx - functions returning ast::ptr seems wrong...
1325                auto res = ResolvExpr::findVoidExpression( untypedExpr, { symtab, transUnit().global } );
1326                // Fix CodeLocation (at least until resolver is fixed).
1327                auto fix = localFillCodeLocations( untypedExpr->location, res.release() );
1328                return strict_dynamic_cast<const ast::Expr *>( fix );
1329        }
1330
1331        void InsertImplicitCalls::previsit(const ast::UniqueExpr * unqExpr) {
1332                if (visitedIds.count(unqExpr->id)) visit_children = false;
1333                else visitedIds.insert(unqExpr->id);
1334        }
1335
1336        const ast::Expr * FixCtorExprs::postvisit( const ast::ConstructorExpr * ctorExpr ) {
1337                const CodeLocation loc = ctorExpr->location;
1338                static UniqueName tempNamer( "_tmp_ctor_expr" );
1339                // xxx - is the size check necessary?
1340                assert( ctorExpr->result && ctorExpr->result->size() == 1 );
1341
1342                // xxx - this can be TupleAssignExpr now. Need to properly handle this case.
1343                // take possession of expr and env
1344                ast::ptr<ast::ApplicationExpr> callExpr = ctorExpr->callExpr.strict_as<ast::ApplicationExpr>();
1345                ast::ptr<ast::TypeSubstitution> env = ctorExpr->env;
1346                // ctorExpr->set_callExpr( nullptr );
1347                // ctorExpr->set_env( nullptr );
1348
1349                // 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.
1350                auto tmp = new ast::ObjectDecl(loc, tempNamer.newName(), callExpr->args.front()->result );
1351                declsToAddBefore.push_back( tmp );
1352                // delete ctorExpr;
1353
1354                // build assignment and replace constructor's first argument with new temporary
1355                auto mutCallExpr = callExpr.get_and_mutate();
1356                const ast::Expr * firstArg = callExpr->args.front();
1357                ast::Expr * assign = new ast::UntypedExpr(loc, new ast::NameExpr(loc, "?=?" ), { new ast::AddressExpr(loc, new ast::VariableExpr(loc, tmp ) ), new ast::AddressExpr( firstArg ) } );
1358                firstArg = new ast::VariableExpr(loc, tmp );
1359                mutCallExpr->args.front() = firstArg;
1360
1361                // resolve assignment and dispose of new env
1362                auto resolved = ResolvExpr::findVoidExpression( assign, { symtab, transUnit().global } );
1363                auto mut = resolved.get_and_mutate();
1364                assertf(resolved.get() == mut, "newly resolved expression must be unique");
1365                mut->env = nullptr;
1366
1367                // for constructor expr:
1368                //   T x;
1369                //   x{};
1370                // results in:
1371                //   T x;
1372                //   T & tmp;
1373                //   &tmp = &x, ?{}(tmp), tmp
1374                ast::CommaExpr * commaExpr = new ast::CommaExpr(loc, resolved, new ast::CommaExpr(loc, mutCallExpr, new ast::VariableExpr(loc, tmp ) ) );
1375                commaExpr->env = env;
1376                return commaExpr;
1377        }
1378} // namespace
1379} // namespace InitTweak
1380
1381// Local Variables: //
1382// tab-width: 4 //
1383// mode: c++ //
1384// compile-command: "make install" //
1385// End: //
Note: See TracBrowser for help on using the repository browser.