source: src/InitTweak/FixInit.cc@ efe8172b

ADT aaron-thesis arm-eh ast-experimental cleanup-dtors deferred_resn demangler enum forall-pointer-decay jacob/cs343-translation jenkins-sandbox new-ast new-ast-unique-expr new-env no_list persistent-indexer pthread-emulation qualifiedEnum resolv-new with_gc
Last change on this file since efe8172b was 1ba5803, checked in by Rob Schluntz <rschlunt@…>, 8 years ago

Merge branch 'fix-bug-51'

  • Property mode set to 100644
File size: 51.7 KB
RevLine 
[71f4e4f]1//
2// Cforall Version 1.0.0 Copyright (C) 2015 University of Waterloo
3//
4// The contents of this file are covered under the licence agreement in the
5// file "LICENCE" distributed with Cforall.
6//
7// FixInit.h --
8//
9// Author : Rob Schluntz
10// Created On : Wed Jan 13 16:29:30 2016
[adcc065]11// Last Modified By : Peter A. Buhr
[d56e5bc]12// Last Modified On : Wed Jun 21 17:35:05 2017
13// Update Count : 74
[71f4e4f]14//
[be9288a]15#include "FixInit.h"
[71f4e4f]16
[d180746]17#include <stddef.h> // for NULL
18#include <algorithm> // for set_difference, copy_if
[e3e16bc]19#include <cassert> // for assert, strict_dynamic_cast
[d180746]20#include <iostream> // for operator<<, ostream, basic_ost...
21#include <iterator> // for insert_iterator, back_inserter
22#include <list> // for _List_iterator, list, list<>::...
23#include <map> // for _Rb_tree_iterator, _Rb_tree_co...
24#include <memory> // for allocator_traits<>::value_type
25#include <set> // for set, set<>::value_type
26#include <unordered_map> // for unordered_map, unordered_map<>...
27#include <unordered_set> // for unordered_set
28#include <utility> // for pair
[134322e]29
[d180746]30#include "CodeGen/GenType.h" // for genPrettyType
[bff227f]31#include "CodeGen/OperatorTable.h"
[d180746]32#include "Common/PassVisitor.h" // for PassVisitor, WithStmtsToAdd
33#include "Common/SemanticError.h" // for SemanticError
34#include "Common/UniqueName.h" // for UniqueName
35#include "Common/utility.h" // for CodeLocation, ValueGuard, toSt...
36#include "FixGlobalInit.h" // for fixGlobalInit
37#include "GenInit.h" // for genCtorDtor
38#include "GenPoly/GenPoly.h" // for getFunctionType
39#include "InitTweak.h" // for getFunctionName, getCallArg
40#include "Parser/LinkageSpec.h" // for C, Spec, Cforall, isBuiltin
41#include "ResolvExpr/Resolver.h" // for findVoidExpression
42#include "ResolvExpr/typeops.h" // for typesCompatible
43#include "SymTab/Autogen.h" // for genImplicitCall
44#include "SymTab/Indexer.h" // for Indexer
45#include "SymTab/Mangler.h" // for Mangler
46#include "SynTree/Attribute.h" // for Attribute
47#include "SynTree/Constant.h" // for Constant
48#include "SynTree/Declaration.h" // for ObjectDecl, FunctionDecl, Decl...
49#include "SynTree/Expression.h" // for UniqueExpr, VariableExpr, Unty...
50#include "SynTree/Initializer.h" // for ConstructorInit, SingleInit
51#include "SynTree/Label.h" // for Label, noLabels, operator<
52#include "SynTree/Mutator.h" // for mutateAll, Mutator, maybeMutate
53#include "SynTree/Statement.h" // for ExprStmt, CompoundStmt, Branch...
54#include "SynTree/Type.h" // for Type, Type::StorageClasses
55#include "SynTree/TypeSubstitution.h" // for TypeSubstitution, operator<<
56#include "SynTree/Visitor.h" // for acceptAll, maybeAccept
[71f4e4f]57
[f0121d7]58bool ctordtorp = false; // print all debug
59bool ctorp = false; // print ctor debug
60bool cpctorp = false; // print copy ctor debug
61bool dtorp = false; // print dtor debug
[845cedc]62#define PRINT( text ) if ( ctordtorp ) { text }
[c2931ea]63#define CP_CTOR_PRINT( text ) if ( ctordtorp || cpctorp ) { text }
64#define DTOR_PRINT( text ) if ( ctordtorp || dtorp ) { text }
[845cedc]65
[71f4e4f]66namespace InitTweak {
67 namespace {
[597db97f]68 typedef std::unordered_map< int, int > UnqCount;
[31f379c]69
[c0714bf]70 struct InsertImplicitCalls : public WithTypeSubstitution {
[adcc065]71 /// wrap function application expressions as ImplicitCopyCtorExpr nodes so that it is easy to identify which
72 /// function calls need their parameters to be copy constructed
[c0714bf]73 static void insert( std::list< Declaration * > & translationUnit );
[134322e]74
75 Expression * postmutate( ApplicationExpr * appExpr );
[c2931ea]76 };
77
[c0714bf]78 struct ResolveCopyCtors final : public WithIndexer, public WithShortCircuiting, public WithTypeSubstitution {
[adcc065]79 /// generate temporary ObjectDecls for each argument and return value of each ImplicitCopyCtorExpr,
80 /// generate/resolve copy construction expressions for each, and generate/resolve destructors for both
81 /// arguments and return value temporaries
[c0714bf]82 static void resolveImplicitCalls( std::list< Declaration * > & translationUnit, UnqCount & unqCount );
[c2931ea]83
[c0714bf]84 ResolveCopyCtors( UnqCount & unqCount ) : unqCount( unqCount ) {}
[31f379c]85
[c0714bf]86 void postvisit( ImplicitCopyCtorExpr * impCpCtorExpr );
87 void postvisit( StmtExpr * stmtExpr );
88 void previsit( UniqueExpr * unqExpr );
89 void postvisit( UniqueExpr * unqExpr );
[c2931ea]90
91 /// create and resolve ctor/dtor expression: fname(var, [cpArg])
[65660bd]92 Expression * makeCtorDtor( const std::string & fname, ObjectDecl * var, Expression * cpArg = NULL );
[c2931ea]93 /// true if type does not need to be copy constructed to ensure correctness
[1132b62]94 bool skipCopyConstruct( Type * type );
[ae1b9ea]95 void copyConstructArg( Expression *& arg, ImplicitCopyCtorExpr * impCpCtorExpr, Type * formal );
[092528b]96 void destructRet( ObjectDecl * ret, ImplicitCopyCtorExpr * impCpCtorExpr );
[31f379c]97
[597db97f]98 UnqCount & unqCount; // count the number of times each unique expr ID appears
[c0714bf]99 std::unordered_set< int > vars;
[c2931ea]100 };
101
102 /// collects constructed object decls - used as a base class
[698ec72]103 struct ObjDeclCollector : public WithGuards, public WithShortCircuiting {
[62423350]104 // use ordered data structure to maintain ordering for set_difference and for consistent error messages
105 typedef std::list< ObjectDecl * > ObjectSet;
[698ec72]106 void previsit( CompoundStmt *compoundStmt );
107 void previsit( DeclStmt *stmt );
[52c14b3]108
109 // don't go into other functions
[698ec72]110 void previsit( FunctionDecl * ) { visit_children = false; }
[52c14b3]111
[c2931ea]112 protected:
113 ObjectSet curVars;
114 };
115
[6cf27a07]116 // debug
[62423350]117 template<typename ObjectSet>
118 struct PrintSet {
119 PrintSet( const ObjectSet & objs ) : objs( objs ) {}
[c2931ea]120 const ObjectSet & objs;
121 };
[62423350]122 template<typename ObjectSet>
123 PrintSet<ObjectSet> printSet( const ObjectSet & objs ) { return PrintSet<ObjectSet>( objs ); }
124 template<typename ObjectSet>
125 std::ostream & operator<<( std::ostream & out, const PrintSet<ObjectSet> & set) {
[c2931ea]126 out << "{ ";
127 for ( ObjectDecl * obj : set.objs ) {
128 out << obj->get_name() << ", " ;
[adcc065]129 } // for
[c2931ea]130 out << " }";
131 return out;
132 }
133
[698ec72]134 struct LabelFinder final : public ObjDeclCollector {
[c2931ea]135 typedef std::map< Label, ObjectSet > LabelMap;
136 // map of Label -> live variables at that label
137 LabelMap vars;
138
[698ec72]139 typedef ObjDeclCollector Parent;
140 using Parent::previsit;
141 void previsit( Statement * stmt );
142
143 void previsit( CompoundStmt *compoundStmt );
144 void previsit( DeclStmt *stmt );
[c2931ea]145 };
146
[698ec72]147 struct InsertDtors final : public ObjDeclCollector, public WithStmtsToAdd {
[adcc065]148 /// insert destructor calls at the appropriate places. must happen before CtorInit nodes are removed
149 /// (currently by FixInit)
[c2931ea]150 static void insert( std::list< Declaration * > & translationUnit );
151
152 typedef std::list< ObjectDecl * > OrderedDecls;
153 typedef std::list< OrderedDecls > OrderedDeclsStack;
154
[698ec72]155 InsertDtors( PassVisitor<LabelFinder> & finder ) : finder( finder ), labelVars( finder.pass.vars ) {}
[c2931ea]156
[698ec72]157 typedef ObjDeclCollector Parent;
158 using Parent::previsit;
[62e5546]159
[698ec72]160 void previsit( ObjectDecl * objDecl );
161 void previsit( FunctionDecl * funcDecl );
[c2931ea]162
[698ec72]163 void previsit( CompoundStmt * compoundStmt );
164 void postvisit( CompoundStmt * compoundStmt );
165 void previsit( ReturnStmt * returnStmt );
166 void previsit( BranchStmt * stmt );
[c2931ea]167 private:
168 void handleGoto( BranchStmt * stmt );
169
[698ec72]170 PassVisitor<LabelFinder> & finder;
[c2931ea]171 LabelFinder::LabelMap & labelVars;
172 OrderedDeclsStack reverseDeclOrder;
173 };
174
[0508ab3]175 class FixInit : public WithStmtsToAdd {
[c2931ea]176 public:
177 /// expand each object declaration to use its constructor after it is declared.
178 static void fixInitializers( std::list< Declaration * > &translationUnit );
179
[aff3af4]180 DeclarationWithType * postmutate( ObjectDecl *objDecl );
[72e9222]181
182 std::list< Declaration * > staticDtorDecls;
[c2931ea]183 };
184
[dc2334c]185 class FixCopyCtors final : public WithStmtsToAdd, public WithShortCircuiting, public WithVisitorRef<FixCopyCtors> {
[c2931ea]186 public:
[597db97f]187 FixCopyCtors( UnqCount & unqCount ) : unqCount( unqCount ){}
[adcc065]188 /// expand ImplicitCopyCtorExpr nodes into the temporary declarations, copy constructors, call expression,
189 /// and destructors
[597db97f]190 static void fixCopyCtors( std::list< Declaration * > &translationUnit, UnqCount & unqCount );
[c2931ea]191
[dc2334c]192 Expression * postmutate( ImplicitCopyCtorExpr * impCpCtorExpr );
193 void premutate( StmtExpr * stmtExpr );
194 void premutate( UniqueExpr * unqExpr );
[597db97f]195
196 UnqCount & unqCount;
[c2931ea]197 };
[79970ed]198
[9a707e4e]199 struct GenStructMemberCalls final : public WithGuards, public WithShortCircuiting, public WithIndexer {
[c8dfcd3]200 /// generate default/copy ctor and dtor calls for user-defined struct ctor/dtors
201 /// for any member that is missing a corresponding ctor/dtor call.
202 /// error if a member is used before constructed
203 static void generate( std::list< Declaration * > & translationUnit );
[79970ed]204
[9a707e4e]205 void previsit( FunctionDecl * funcDecl );
206 void postvisit( FunctionDecl * funcDecl );
[79970ed]207
[9a707e4e]208 void previsit( MemberExpr * memberExpr );
209 void previsit( ApplicationExpr * appExpr );
[79970ed]210
[3906301]211 SemanticError errors;
[79970ed]212 private:
[3906301]213 template< typename... Params >
[64ac636]214 void emit( CodeLocation, const Params &... params );
[79970ed]215
[5363fdf]216 FunctionDecl * function = nullptr;
[64ac636]217 std::set< DeclarationWithType * > unhandled;
218 std::map< DeclarationWithType *, CodeLocation > usedUninit;
[5363fdf]219 ObjectDecl * thisParam = nullptr;
[c8dfcd3]220 bool isCtor = false; // true if current function is a constructor
[5363fdf]221 StructDecl * structDecl = nullptr;
[c8dfcd3]222 };
223
224 // very simple resolver-like mutator class - used to
225 // resolve UntypedExprs that are found within newly
226 // generated constructor/destructor calls
[62e5546]227 class MutatingResolver final : public Mutator {
[c8dfcd3]228 public:
229 MutatingResolver( SymTab::Indexer & indexer ) : indexer( indexer ) {}
230
[62e5546]231 using Mutator::mutate;
232 virtual DeclarationWithType* mutate( ObjectDecl *objectDecl ) override;
233 virtual Expression* mutate( UntypedExpr *untypedExpr ) override;
[c8dfcd3]234
[62e5546]235 private:
[c8dfcd3]236 SymTab::Indexer & indexer;
[79970ed]237 };
[b6fe7e6]238
[696bf6e]239 struct FixCtorExprs final : public WithDeclsToAdd, public WithIndexer {
[b6fe7e6]240 /// expands ConstructorExpr nodes into comma expressions, using a temporary for the first argument
241 static void fix( std::list< Declaration * > & translationUnit );
242
[696bf6e]243 Expression * postmutate( ConstructorExpr * ctorExpr );
[b6fe7e6]244 };
[c2931ea]245 } // namespace
[db4ecc5]246
[6cf27a07]247 void fix( std::list< Declaration * > & translationUnit, const std::string & filename, bool inLibrary ) {
248 // fixes ConstructorInit for global variables. should happen before fixInitializers.
249 InitTweak::fixGlobalInit( translationUnit, filename, inLibrary );
250
[597db97f]251 UnqCount unqCount;
[b6fe7e6]252
[c0714bf]253 InsertImplicitCalls::insert( translationUnit );
254 ResolveCopyCtors::resolveImplicitCalls( translationUnit, unqCount );
[c2931ea]255 InsertDtors::insert( translationUnit );
[71f4e4f]256 FixInit::fixInitializers( translationUnit );
[c2931ea]257
[db4ecc5]258 // FixCopyCtors must happen after FixInit, so that destructors are placed correctly
[597db97f]259 FixCopyCtors::fixCopyCtors( translationUnit, unqCount );
[79970ed]260
[c8dfcd3]261 GenStructMemberCalls::generate( translationUnit );
[ae1b9ea]262
[b6fe7e6]263 // xxx - ctor expansion currently has to be after FixCopyCtors, because there is currently a
264 // hack in the way untyped assignments are generated, where the first argument cannot have
265 // its address taken because of the way codegeneration handles UntypedExpr vs. ApplicationExpr.
266 // Thus such assignment exprs must never pushed through expression resolution (and thus should
267 // not go through the FixCopyCtors pass), otherwise they will fail -- guaranteed.
268 // Also needs to happen after GenStructMemberCalls, since otherwise member constructors exprs
269 // don't look right, and a member can be constructed more than once.
270 FixCtorExprs::fix( translationUnit );
[db4ecc5]271 }
272
[c2931ea]273 namespace {
[c0714bf]274 void InsertImplicitCalls::insert( std::list< Declaration * > & translationUnit ) {
275 PassVisitor<InsertImplicitCalls> inserter;
[c2931ea]276 mutateAll( translationUnit, inserter );
277 }
[db4ecc5]278
[c0714bf]279 void ResolveCopyCtors::resolveImplicitCalls( std::list< Declaration * > & translationUnit, UnqCount & unqCount ) {
280 PassVisitor<ResolveCopyCtors> resolver( unqCount );
[c2931ea]281 acceptAll( translationUnit, resolver );
282 }
[71f4e4f]283
[c2931ea]284 void FixInit::fixInitializers( std::list< Declaration * > & translationUnit ) {
[aff3af4]285 PassVisitor<FixInit> fixer;
[72e9222]286
287 // can't use mutateAll, because need to insert declarations at top-level
288 // can't use DeclMutator, because sometimes need to insert IfStmt, etc.
289 SemanticError errors;
290 for ( std::list< Declaration * >::iterator i = translationUnit.begin(); i != translationUnit.end(); ++i ) {
291 try {
[3c398b6]292 maybeMutate( *i, fixer );
[aff3af4]293 translationUnit.splice( i, fixer.pass.staticDtorDecls );
[72e9222]294 } catch( SemanticError &e ) {
[138e29e]295 e.set_location( (*i)->location );
[72e9222]296 errors.append( e );
297 } // try
298 } // for
299 if ( ! errors.isEmpty() ) {
300 throw errors;
301 } // if
[c2931ea]302 }
[71f4e4f]303
[c2931ea]304 void InsertDtors::insert( std::list< Declaration * > & translationUnit ) {
[698ec72]305 PassVisitor<LabelFinder> finder;
306 PassVisitor<InsertDtors> inserter( finder );
[c2931ea]307 acceptAll( translationUnit, inserter );
308 }
309
[597db97f]310 void FixCopyCtors::fixCopyCtors( std::list< Declaration * > & translationUnit, UnqCount & unqCount ) {
[dc2334c]311 PassVisitor<FixCopyCtors> fixer( unqCount );
[c2931ea]312 mutateAll( translationUnit, fixer );
313 }
[db4ecc5]314
[c8dfcd3]315 void GenStructMemberCalls::generate( std::list< Declaration * > & translationUnit ) {
[9a707e4e]316 PassVisitor<GenStructMemberCalls> warner;
[c8dfcd3]317 acceptAll( translationUnit, warner );
[79970ed]318 }
319
[b6fe7e6]320 void FixCtorExprs::fix( std::list< Declaration * > & translationUnit ) {
[696bf6e]321 PassVisitor<FixCtorExprs> fixer;
322 mutateAll( translationUnit, fixer );
[b6fe7e6]323 }
324
[134322e]325 Expression * InsertImplicitCalls::postmutate( ApplicationExpr * appExpr ) {
[c2931ea]326 if ( VariableExpr * function = dynamic_cast< VariableExpr * > ( appExpr->get_function() ) ) {
[be151bf]327 if ( function->var->linkage.is_builtin ) {
[c2931ea]328 // optimization: don't need to copy construct in order to call intrinsic functions
329 return appExpr;
330 } else if ( DeclarationWithType * funcDecl = dynamic_cast< DeclarationWithType * > ( function->get_var() ) ) {
331 FunctionType * ftype = dynamic_cast< FunctionType * >( GenPoly::getFunctionType( funcDecl->get_type() ) );
[05807e9]332 assertf( ftype, "Function call without function type: %s", toString( funcDecl ).c_str() );
[be151bf]333 if ( CodeGen::isConstructor( funcDecl->get_name() ) && ftype->parameters.size() == 2 ) {
334 Type * t1 = getPointerBase( ftype->parameters.front()->get_type() );
335 Type * t2 = ftype->parameters.back()->get_type();
[0a81c3f]336 assert( t1 );
[c2931ea]337
[0a81c3f]338 if ( ResolvExpr::typesCompatible( t1, t2, SymTab::Indexer() ) ) {
[a28bc02]339 // optimization: don't need to copy construct in order to call a copy constructor
[c2931ea]340 return appExpr;
[adcc065]341 } // if
[bff227f]342 } else if ( CodeGen::isDestructor( funcDecl->get_name() ) ) {
[c2931ea]343 // correctness: never copy construct arguments to a destructor
[845cedc]344 return appExpr;
[adcc065]345 } // if
346 } // if
347 } // if
[c2931ea]348 CP_CTOR_PRINT( std::cerr << "InsertImplicitCalls: adding a wrapper " << appExpr << std::endl; )
349
350 // wrap each function call so that it is easy to identify nodes that have to be copy constructed
351 ImplicitCopyCtorExpr * expr = new ImplicitCopyCtorExpr( appExpr );
[c0714bf]352 // Move the type substitution to the new top-level, if it is attached to the appExpr.
[c2931ea]353 // Ensure it is not deleted with the ImplicitCopyCtorExpr by removing it before deletion.
354 // The substitution is needed to obtain the type of temporary variables so that copy constructor
[c0714bf]355 // calls can be resolved.
[c2931ea]356 assert( env );
[c0714bf]357 std::swap( expr->env, appExpr->env );
[c2931ea]358 return expr;
[db4ecc5]359 }
360
[29bc63e]361 bool ResolveCopyCtors::skipCopyConstruct( Type * type ) { return ! isConstructable( type ); }
[c2931ea]362
[65660bd]363 Expression * ResolveCopyCtors::makeCtorDtor( const std::string & fname, ObjectDecl * var, Expression * cpArg ) {
[c2931ea]364 assert( var );
[092528b]365 // arrays are not copy constructed, so this should always be an ExprStmt
366 ImplicitCtorDtorStmt * stmt = genCtorDtor( fname, var, cpArg );
[e3e16bc]367 ExprStmt * exprStmt = strict_dynamic_cast< ExprStmt * >( stmt->get_callStmt() );
[08da53d]368 Expression * resolved = exprStmt->expr;
369 exprStmt->expr = nullptr; // take ownership of expr
[c2931ea]370
371 // resolve copy constructor
[adcc065]372 // should only be one alternative for copy ctor and dtor expressions, since all arguments are fixed
373 // (VariableExpr and already resolved expression)
[08da53d]374 CP_CTOR_PRINT( std::cerr << "ResolvingCtorDtor " << resolved << std::endl; )
375 ResolvExpr::findVoidExpression( resolved, indexer );
[65660bd]376 assert( resolved );
[c2931ea]377 if ( resolved->get_env() ) {
[31f379c]378 // Extract useful information and discard new environments. Keeping them causes problems in PolyMutator passes.
[c2931ea]379 env->add( *resolved->get_env() );
[31f379c]380 delete resolved->get_env();
381 resolved->set_env( nullptr );
[adcc065]382 } // if
[092528b]383 delete stmt;
[c2931ea]384 return resolved;
[540de412]385 }
[db4ecc5]386
[ae1b9ea]387 void ResolveCopyCtors::copyConstructArg( Expression *& arg, ImplicitCopyCtorExpr * impCpCtorExpr, Type * formal ) {
[c2931ea]388 static UniqueName tempNamer("_tmp_cp");
[31f379c]389 assert( env );
390 CP_CTOR_PRINT( std::cerr << "Type Substitution: " << *env << std::endl; )
[d29fa5f]391 assert( arg->result );
[ae1b9ea]392 Type * result = arg->result;
[1132b62]393 if ( skipCopyConstruct( result ) ) return; // skip certain non-copyable types
394
[f5c3b6c]395 // type may involve type variables, so apply type substitution to get temporary variable's actual type,
396 // since result type may not be substituted (e.g., if the type does not appear in the parameter list)
[ae1b9ea]397 // Use applyFree so that types bound in function pointers are not substituted, e.g. in forall(dtype T) void (*)(T).
398 env->applyFree( result );
[3aeaecd]399 ObjectDecl * tmp = ObjectDecl::newObject( "__tmp", result, nullptr );
[615a096]400 tmp->get_type()->set_const( false );
[1132b62]401
402 // create and resolve copy constructor
403 CP_CTOR_PRINT( std::cerr << "makeCtorDtor for an argument" << std::endl; )
[65660bd]404 Expression * cpCtor = makeCtorDtor( "?{}", tmp, arg );
405
406 if ( ApplicationExpr * appExpr = dynamic_cast< ApplicationExpr * >( cpCtor ) ) {
407 // if the chosen constructor is intrinsic, the copy is unnecessary, so
408 // don't create the temporary and don't call the copy constructor
[ae1b9ea]409 VariableExpr * function = strict_dynamic_cast< VariableExpr * >( appExpr->function );
410 if ( function->var->linkage == LinkageSpec::Intrinsic ) {
411 // arguments that need to be boxed need a temporary regardless of whether the copy constructor is intrinsic,
412 // so that the object isn't changed inside of the polymorphic function
413 if ( ! GenPoly::needsBoxing( formal, result, impCpCtorExpr->callExpr, env ) ) return;
414 }
[65660bd]415 }
416
[3aeaecd]417 // set a unique name for the temporary once it's certain the call is necessary
418 tmp->name = tempNamer.newName();
419
[65660bd]420 // replace argument to function call with temporary
421 arg = new CommaExpr( cpCtor, new VariableExpr( tmp ) );
[ae1b9ea]422 impCpCtorExpr->tempDecls.push_back( tmp );
423 impCpCtorExpr->dtors.push_front( makeCtorDtor( "^?{}", tmp ) );
[1132b62]424 }
[c2931ea]425
[092528b]426 void ResolveCopyCtors::destructRet( ObjectDecl * ret, ImplicitCopyCtorExpr * impCpCtorExpr ) {
427 impCpCtorExpr->get_dtors().push_front( makeCtorDtor( "^?{}", ret ) );
[1132b62]428 }
429
[c0714bf]430 void ResolveCopyCtors::postvisit( ImplicitCopyCtorExpr *impCpCtorExpr ) {
[c2931ea]431 CP_CTOR_PRINT( std::cerr << "ResolveCopyCtors: " << impCpCtorExpr << std::endl; )
432
[ae1b9ea]433 ApplicationExpr * appExpr = impCpCtorExpr->callExpr;
[c2931ea]434
435 // take each argument and attempt to copy construct it.
[ae1b9ea]436 FunctionType * ftype = GenPoly::getFunctionType( appExpr->function->result );
437 assert( ftype );
438 auto & params = ftype->parameters;
439 auto iter = params.begin();
440 for ( Expression * & arg : appExpr->args ) {
441 Type * formal = nullptr;
442 if ( iter != params.end() ) {
443 DeclarationWithType * param = *iter++;
444 formal = param->get_type();
445 }
446
447 copyConstructArg( arg, impCpCtorExpr, formal );
[adcc065]448 } // for
[db4ecc5]449
[adcc065]450 // each return value from the call needs to be connected with an ObjectDecl at the call site, which is
451 // initialized with the return value and is destructed later
[31f379c]452 // xxx - handle named return values?
[ae1b9ea]453 Type * result = appExpr->result;
[906e24d]454 if ( ! result->isVoid() ) {
[1132b62]455 static UniqueName retNamer("_tmp_cp_ret");
[c2931ea]456 result = result->clone();
[31f379c]457 env->apply( result );
[3aeaecd]458 ObjectDecl * ret = ObjectDecl::newObject( retNamer.newName(), result, nullptr );
[ae1b9ea]459 ret->type->set_const( false );
460 impCpCtorExpr->returnDecls.push_back( ret );
[c2931ea]461 CP_CTOR_PRINT( std::cerr << "makeCtorDtor for a return" << std::endl; )
[0a81c3f]462 if ( ! dynamic_cast< ReferenceType * >( result ) ) {
[3aeaecd]463 // destructing reference returns is bad because it can cause multiple destructor calls to the same object - the returned object is not a temporary
[092528b]464 destructRet( ret, impCpCtorExpr );
[dc86541]465 }
[adcc065]466 } // for
[c2931ea]467 CP_CTOR_PRINT( std::cerr << "after Resolving: " << impCpCtorExpr << std::endl; )
[db4ecc5]468 }
469
[c0714bf]470 void ResolveCopyCtors::postvisit( StmtExpr * stmtExpr ) {
471 assert( env );
[31f379c]472 assert( stmtExpr->get_result() );
473 Type * result = stmtExpr->get_result();
474 if ( ! result->isVoid() ) {
475 static UniqueName retNamer("_tmp_stmtexpr_ret");
476
477 // create variable that will hold the result of the stmt expr
478 result = result->clone();
479 env->apply( result );
[3aeaecd]480 ObjectDecl * ret = ObjectDecl::newObject( retNamer.newName(), result, nullptr );
[615a096]481 ret->get_type()->set_const( false );
[31f379c]482 stmtExpr->get_returnDecls().push_front( ret );
483
484 // must have a non-empty body, otherwise it wouldn't have a result
485 CompoundStmt * body = stmtExpr->get_statements();
486 assert( ! body->get_kids().empty() );
487 // must be an ExprStmt, otherwise it wouldn't have a result
[e3e16bc]488 ExprStmt * last = strict_dynamic_cast< ExprStmt * >( body->get_kids().back() );
[31f379c]489 last->set_expr( makeCtorDtor( "?{}", ret, last->get_expr() ) );
490
[092528b]491 stmtExpr->get_dtors().push_front( makeCtorDtor( "^?{}", ret ) );
[31f379c]492 } // if
493 }
494
[c0714bf]495 void ResolveCopyCtors::previsit( UniqueExpr * unqExpr ) {
[597db97f]496 unqCount[ unqExpr->get_id() ]++; // count the number of unique expressions for each ID
[c0714bf]497 if ( vars.count( unqExpr->get_id() ) ) {
498 // xxx - hack to prevent double-handling of unique exprs, otherwise too many temporary variables and destructors are generated
499 visit_children = false;
500 }
501 }
502
[ddae809]503 // to prevent warnings (‘_unq0’ may be used uninitialized in this function),
504 // insert an appropriate zero initializer for UniqueExpr temporaries.
505 Initializer * makeInit( Type * t ) {
506 if ( StructInstType * inst = dynamic_cast< StructInstType * >( t ) ) {
507 // initizer for empty struct must be empty
508 if ( inst->baseStruct->members.empty() ) return new ListInit({});
509 } else if ( UnionInstType * inst = dynamic_cast< UnionInstType * >( t ) ) {
510 // initizer for empty union must be empty
511 if ( inst->baseUnion->members.empty() ) return new ListInit({});
512 }
513
514 return new ListInit( { new SingleInit( new ConstantExpr( Constant::from_int( 0 ) ) ) } );
515 }
516
[c0714bf]517 void ResolveCopyCtors::postvisit( UniqueExpr * unqExpr ) {
[141b786]518 if ( vars.count( unqExpr->get_id() ) ) {
519 // xxx - hack to prevent double-handling of unique exprs, otherwise too many temporary variables and destructors are generated
520 return;
521 }
522
523 // it should never be necessary to wrap a void-returning expression in a UniqueExpr - if this assumption changes, this needs to be rethought
524 assert( unqExpr->get_result() );
525 if ( ImplicitCopyCtorExpr * impCpCtorExpr = dynamic_cast<ImplicitCopyCtorExpr*>( unqExpr->get_expr() ) ) {
526 // note the variable used as the result from the call
527 assert( impCpCtorExpr->get_result() && impCpCtorExpr->get_returnDecls().size() == 1 );
528 unqExpr->set_var( new VariableExpr( impCpCtorExpr->get_returnDecls().front() ) );
529 } else {
530 // expr isn't a call expr, so create a new temporary variable to use to hold the value of the unique expression
[ddae809]531 unqExpr->set_object( ObjectDecl::newObject( toString("_unq", unqExpr->get_id()), unqExpr->get_result()->clone(), makeInit( unqExpr->get_result() ) ) );
[141b786]532 unqExpr->set_var( new VariableExpr( unqExpr->get_object() ) );
533 }
534 vars.insert( unqExpr->get_id() );
535 }
536
[dc2334c]537 Expression * FixCopyCtors::postmutate( ImplicitCopyCtorExpr * impCpCtorExpr ) {
[c2931ea]538 CP_CTOR_PRINT( std::cerr << "FixCopyCtors: " << impCpCtorExpr << std::endl; )
539
540 std::list< ObjectDecl * > & tempDecls = impCpCtorExpr->get_tempDecls();
541 std::list< ObjectDecl * > & returnDecls = impCpCtorExpr->get_returnDecls();
542 std::list< Expression * > & dtors = impCpCtorExpr->get_dtors();
[845cedc]543
[c2931ea]544 // add all temporary declarations and their constructors
545 for ( ObjectDecl * obj : tempDecls ) {
[dc2334c]546 stmtsToAddBefore.push_back( new DeclStmt( noLabels, obj ) );
[adcc065]547 } // for
[c2931ea]548 for ( ObjectDecl * obj : returnDecls ) {
[dc2334c]549 stmtsToAddBefore.push_back( new DeclStmt( noLabels, obj ) );
[adcc065]550 } // for
[db4ecc5]551
[c2931ea]552 // add destructors after current statement
553 for ( Expression * dtor : dtors ) {
554 stmtsToAddAfter.push_back( new ExprStmt( noLabels, dtor ) );
[adcc065]555 } // for
[db4ecc5]556
[c0714bf]557 ObjectDecl * returnDecl = returnDecls.empty() ? nullptr : returnDecls.front();
[c2931ea]558 Expression * callExpr = impCpCtorExpr->get_callExpr();
559
560 CP_CTOR_PRINT( std::cerr << "Coming out the back..." << impCpCtorExpr << std::endl; )
561
562 // detach fields from wrapper node so that it can be deleted without deleting too much
563 dtors.clear();
564 tempDecls.clear();
565 returnDecls.clear();
[c0714bf]566 impCpCtorExpr->set_callExpr( nullptr );
567 std::swap( impCpCtorExpr->env, callExpr->env );
568 assert( impCpCtorExpr->env == nullptr );
[c2931ea]569 delete impCpCtorExpr;
570
571 if ( returnDecl ) {
[f5c3b6c]572 ApplicationExpr * assign = createBitwiseAssignment( new VariableExpr( returnDecl ), callExpr );
[c2931ea]573 Expression * retExpr = new CommaExpr( assign, new VariableExpr( returnDecl ) );
[31f379c]574 // move env from callExpr to retExpr
[50377a4]575 std::swap( retExpr->env, callExpr->env );
[c2931ea]576 return retExpr;
577 } else {
578 return callExpr;
[adcc065]579 } // if
[4ffdd63]580 }
[c2931ea]581
[dc2334c]582 void FixCopyCtors::premutate( StmtExpr * stmtExpr ) {
[65aca88]583 // function call temporaries should be placed at statement-level, rather than nested inside of a new statement expression,
584 // since temporaries can be shared across sub-expressions, e.g.
585 // [A, A] f();
586 // g([A] x, [A] y);
[dc2334c]587 // g(f());
[65aca88]588 // f is executed once, so the return temporary is shared across the tuple constructors for x and y.
[dc2334c]589 // Explicitly mutating children instead of mutating the inner compound statment forces the temporaries to be added
590 // to the outer context, rather than inside of the statement expression.
591 visit_children = false;
[65aca88]592 std::list< Statement * > & stmts = stmtExpr->get_statements()->get_kids();
593 for ( Statement *& stmt : stmts ) {
[dc2334c]594 stmt = stmt->acceptMutator( *visitor );
[65aca88]595 } // for
[31f379c]596 assert( stmtExpr->get_result() );
597 Type * result = stmtExpr->get_result();
598 if ( ! result->isVoid() ) {
599 for ( ObjectDecl * obj : stmtExpr->get_returnDecls() ) {
[dc2334c]600 stmtsToAddBefore.push_back( new DeclStmt( noLabels, obj ) );
[31f379c]601 } // for
602 // add destructors after current statement
603 for ( Expression * dtor : stmtExpr->get_dtors() ) {
604 stmtsToAddAfter.push_back( new ExprStmt( noLabels, dtor ) );
605 } // for
606 // must have a non-empty body, otherwise it wouldn't have a result
[dc2334c]607 assert( ! stmts.empty() );
[31f379c]608 assert( ! stmtExpr->get_returnDecls().empty() );
[dc2334c]609 stmts.push_back( new ExprStmt( noLabels, new VariableExpr( stmtExpr->get_returnDecls().front() ) ) );
[a28bc02]610 stmtExpr->get_returnDecls().clear();
611 stmtExpr->get_dtors().clear();
[31f379c]612 }
[a28bc02]613 assert( stmtExpr->get_returnDecls().empty() );
614 assert( stmtExpr->get_dtors().empty() );
[31f379c]615 }
616
[dc2334c]617 void FixCopyCtors::premutate( UniqueExpr * unqExpr ) {
618 visit_children = false;
[597db97f]619 unqCount[ unqExpr->get_id() ]--;
620 static std::unordered_map< int, std::list< Statement * > > dtors;
[141b786]621 static std::unordered_map< int, UniqueExpr * > unqMap;
622 // has to be done to clean up ImplicitCopyCtorExpr nodes, even when this node was skipped in previous passes
623 if ( unqMap.count( unqExpr->get_id() ) ) {
624 // take data from other UniqueExpr to ensure consistency
625 delete unqExpr->get_expr();
626 unqExpr->set_expr( unqMap[unqExpr->get_id()]->get_expr()->clone() );
627 delete unqExpr->get_result();
628 unqExpr->set_result( maybeClone( unqExpr->get_expr()->get_result() ) );
[597db97f]629 if ( unqCount[ unqExpr->get_id() ] == 0 ) { // insert destructor after the last use of the unique expression
[edbdbe6]630 stmtsToAddAfter.splice( stmtsToAddAfter.end(), dtors[ unqExpr->get_id() ] );
[597db97f]631 }
[dc2334c]632 return;
[141b786]633 }
[dc2334c]634 PassVisitor<FixCopyCtors> fixer( unqCount );
[597db97f]635 unqExpr->set_expr( unqExpr->get_expr()->acceptMutator( fixer ) ); // stmtexprs contained should not be separately fixed, so this must occur after the lookup
[dc2334c]636 stmtsToAddBefore.splice( stmtsToAddBefore.end(), fixer.pass.stmtsToAddBefore );
[141b786]637 unqMap[unqExpr->get_id()] = unqExpr;
[edbdbe6]638 if ( unqCount[ unqExpr->get_id() ] == 0 ) { // insert destructor after the last use of the unique expression
639 stmtsToAddAfter.splice( stmtsToAddAfter.end(), dtors[ unqExpr->get_id() ] );
640 } else { // remember dtors for last instance of unique expr
[dc2334c]641 dtors[ unqExpr->get_id() ] = fixer.pass.stmtsToAddAfter;
[141b786]642 }
[dc2334c]643 return;
[141b786]644 }
645
[5363fdf]646 DeclarationWithType * FixInit::postmutate( ObjectDecl *objDecl ) {
[aff3af4]647 // since this removes the init field from objDecl, it must occur after children are mutated (i.e. postmutate)
[c2931ea]648 if ( ConstructorInit * ctorInit = dynamic_cast< ConstructorInit * >( objDecl->get_init() ) ) {
649 // a decision should have been made by the resolver, so ctor and init are not both non-NULL
650 assert( ! ctorInit->get_ctor() || ! ctorInit->get_init() );
651 if ( Statement * ctor = ctorInit->get_ctor() ) {
[08d5507b]652 if ( objDecl->get_storageClasses().is_static ) {
[72e9222]653 // originally wanted to take advantage of gcc nested functions, but
[f9cebb5]654 // we get memory errors with this approach. To remedy this, the static
655 // variable is hoisted when the destructor needs to be called.
[72e9222]656 //
[c2931ea]657 // generate:
[f9cebb5]658 // static T __objName_static_varN;
[72e9222]659 // void __objName_dtor_atexitN() {
[f9cebb5]660 // __dtor__...;
[72e9222]661 // }
662 // int f(...) {
663 // ...
664 // static bool __objName_uninitialized = true;
665 // if (__objName_uninitialized) {
666 // __ctor(__objName);
667 // __objName_uninitialized = false;
[f9cebb5]668 // atexit(__objName_dtor_atexitN);
[c2931ea]669 // }
[72e9222]670 // ...
[c2931ea]671 // }
672
[72e9222]673 static UniqueName dtorCallerNamer( "_dtor_atexit" );
674
675 // static bool __objName_uninitialized = true
[c2931ea]676 BasicType * boolType = new BasicType( Type::Qualifiers(), BasicType::Bool );
[579263a]677 SingleInit * boolInitExpr = new SingleInit( new ConstantExpr( Constant::from_int( 1 ) ) );
[68fe077a]678 ObjectDecl * isUninitializedVar = new ObjectDecl( objDecl->get_mangleName() + "_uninitialized", Type::StorageClasses( Type::Static ), LinkageSpec::Cforall, 0, boolType, boolInitExpr );
[c2931ea]679 isUninitializedVar->fixUniqueId();
680
681 // __objName_uninitialized = false;
682 UntypedExpr * setTrue = new UntypedExpr( new NameExpr( "?=?" ) );
683 setTrue->get_args().push_back( new VariableExpr( isUninitializedVar ) );
[d56e5bc]684 setTrue->get_args().push_back( new ConstantExpr( Constant::from_int( 0 ) ) );
[c2931ea]685
686 // generate body of if
687 CompoundStmt * initStmts = new CompoundStmt( noLabels );
688 std::list< Statement * > & body = initStmts->get_kids();
689 body.push_back( ctor );
690 body.push_back( new ExprStmt( noLabels, setTrue ) );
691
692 // put it all together
693 IfStmt * ifStmt = new IfStmt( noLabels, new VariableExpr( isUninitializedVar ), initStmts, 0 );
694 stmtsToAddAfter.push_back( new DeclStmt( noLabels, isUninitializedVar ) );
695 stmtsToAddAfter.push_back( ifStmt );
[72e9222]696
[a4dd728]697 Statement * dtor = ctorInit->get_dtor();
[62423350]698 objDecl->set_init( nullptr );
699 ctorInit->set_ctor( nullptr );
[a4dd728]700 ctorInit->set_dtor( nullptr );
701 if ( dtor ) {
[f9cebb5]702 // if the object has a non-trivial destructor, have to
703 // hoist it and the object into the global space and
704 // call the destructor function with atexit.
705
[a4dd728]706 Statement * dtorStmt = dtor->clone();
[f9cebb5]707
708 // void __objName_dtor_atexitN(...) {...}
[68fe077a]709 FunctionDecl * dtorCaller = new FunctionDecl( objDecl->get_mangleName() + dtorCallerNamer.newName(), Type::StorageClasses( Type::Static ), LinkageSpec::C, new FunctionType( Type::Qualifiers(), false ), new CompoundStmt( noLabels ) );
[f9cebb5]710 dtorCaller->fixUniqueId();
[c8dfcd3]711 dtorCaller->get_statements()->push_back( dtorStmt );
[f9cebb5]712
713 // atexit(dtor_atexit);
714 UntypedExpr * callAtexit = new UntypedExpr( new NameExpr( "atexit" ) );
715 callAtexit->get_args().push_back( new VariableExpr( dtorCaller ) );
716
717 body.push_back( new ExprStmt( noLabels, callAtexit ) );
718
719 // hoist variable and dtor caller decls to list of decls that will be added into global scope
720 staticDtorDecls.push_back( objDecl );
721 staticDtorDecls.push_back( dtorCaller );
722
723 // need to rename object uniquely since it now appears
724 // at global scope and there could be multiple function-scoped
725 // static variables with the same name in different functions.
[c8dfcd3]726 // Note: it isn't sufficient to modify only the mangleName, because
727 // then subsequent Indexer passes can choke on seeing the object's name
728 // if another object has the same name and type. An unfortunate side-effect
729 // of renaming the object is that subsequent NameExprs may fail to resolve,
730 // but there shouldn't be any remaining past this point.
[f9cebb5]731 static UniqueName staticNamer( "_static_var" );
[c8dfcd3]732 objDecl->set_name( objDecl->get_name() + staticNamer.newName() );
733 objDecl->set_mangleName( SymTab::Mangler::mangle( objDecl ) );
[f9cebb5]734
735 // xxx - temporary hack: need to return a declaration, but want to hoist the current object out of this scope
736 // create a new object which is never used
737 static UniqueName dummyNamer( "_dummy" );
[68fe077a]738 ObjectDecl * dummy = new ObjectDecl( dummyNamer.newName(), Type::StorageClasses( Type::Static ), LinkageSpec::Cforall, 0, new PointerType( Type::Qualifiers(), new VoidType( Type::Qualifiers() ) ), 0, std::list< Attribute * >{ new Attribute("unused") } );
[a4dd728]739 delete ctorInit;
[f9cebb5]740 return dummy;
741 }
[c2931ea]742 } else {
[e3e16bc]743 ImplicitCtorDtorStmt * implicit = strict_dynamic_cast< ImplicitCtorDtorStmt * > ( ctor );
[5363fdf]744 ExprStmt * ctorStmt = dynamic_cast< ExprStmt * >( implicit->callStmt );
[233e4d9]745 ApplicationExpr * ctorCall = nullptr;
[5363fdf]746 if ( ctorStmt && (ctorCall = isIntrinsicCallExpr( ctorStmt->expr )) && ctorCall->get_args().size() == 2 ) {
[233e4d9]747 // clean up intrinsic copy constructor calls by making them into SingleInits
[e41306d]748 Expression * ctorArg = ctorCall->args.back();
749 std::swap( ctorArg->env, ctorCall->env );
750 objDecl->init = new SingleInit( ctorArg );
751
[5363fdf]752 ctorCall->args.pop_back();
[233e4d9]753 } else {
754 stmtsToAddAfter.push_back( ctor );
[5363fdf]755 objDecl->init = nullptr;
756 ctorInit->ctor = nullptr;
[233e4d9]757 }
[adcc065]758 } // if
[5363fdf]759 } else if ( Initializer * init = ctorInit->init ) {
760 objDecl->init = init;
761 ctorInit->init = nullptr;
[c2931ea]762 } else {
763 // no constructor and no initializer, which is okay
[5363fdf]764 objDecl->init = nullptr;
[adcc065]765 } // if
[c2931ea]766 delete ctorInit;
[adcc065]767 } // if
[c2931ea]768 return objDecl;
[db4ecc5]769 }
770
[698ec72]771 void ObjDeclCollector::previsit( CompoundStmt * ) {
772 GuardValue( curVars );
[db4ecc5]773 }
774
[698ec72]775 void ObjDeclCollector::previsit( DeclStmt * stmt ) {
[4b2589a]776 // keep track of all variables currently in scope
[c2931ea]777 if ( ObjectDecl * objDecl = dynamic_cast< ObjectDecl * > ( stmt->get_decl() ) ) {
[62423350]778 curVars.push_back( objDecl );
[adcc065]779 } // if
[db4ecc5]780 }
781
[698ec72]782 void LabelFinder::previsit( Statement * stmt ) {
[4b2589a]783 // for each label, remember the variables in scope at that label.
[c2931ea]784 for ( Label l : stmt->get_labels() ) {
785 vars[l] = curVars;
[adcc065]786 } // for
[71f4e4f]787 }
[f1e012b]788
[698ec72]789 void LabelFinder::previsit( CompoundStmt * stmt ) {
790 previsit( (Statement *)stmt );
791 Parent::previsit( stmt );
792 }
793
794 void LabelFinder::previsit( DeclStmt * stmt ) {
795 previsit( (Statement *)stmt );
796 Parent::previsit( stmt );
797 }
798
799
[ec79847]800 template<typename Iterator, typename OutputIterator>
801 void insertDtors( Iterator begin, Iterator end, OutputIterator out ) {
802 for ( Iterator it = begin ; it != end ; ++it ) {
[adcc065]803 // extract destructor statement from the object decl and insert it into the output. Note that this is
804 // only called on lists of non-static objects with implicit non-intrinsic dtors, so if the user manually
805 // calls an intrinsic dtor then the call must (and will) still be generated since the argument may
806 // contain side effects.
[c2931ea]807 ObjectDecl * objDecl = *it;
808 ConstructorInit * ctorInit = dynamic_cast< ConstructorInit * >( objDecl->get_init() );
809 assert( ctorInit && ctorInit->get_dtor() );
810 *out++ = ctorInit->get_dtor()->clone();
[adcc065]811 } // for
[f1e012b]812 }
[39786813]813
[698ec72]814 void InsertDtors::previsit( ObjectDecl * objDecl ) {
[c2931ea]815 // remember non-static destructed objects so that their destructors can be inserted later
[08d5507b]816 if ( ! objDecl->get_storageClasses().is_static ) {
[c2931ea]817 if ( ConstructorInit * ctorInit = dynamic_cast< ConstructorInit * >( objDecl->get_init() ) ) {
818 // a decision should have been made by the resolver, so ctor and init are not both non-NULL
819 assert( ! ctorInit->get_ctor() || ! ctorInit->get_init() );
820 Statement * dtor = ctorInit->get_dtor();
[e4d6335]821 // don't need to call intrinsic dtor, because it does nothing, but
822 // non-intrinsic dtors must be called
[f9cebb5]823 if ( dtor && ! isIntrinsicSingleArgCallStmt( dtor ) ) {
[e4d6335]824 // set dtor location to the object's location for error messages
825 ctorInit->dtor->location = objDecl->location;
[c2931ea]826 reverseDeclOrder.front().push_front( objDecl );
[adcc065]827 } // if
828 } // if
829 } // if
[52c14b3]830 }
831
[698ec72]832 void InsertDtors::previsit( FunctionDecl * funcDecl ) {
[52c14b3]833 // each function needs to have its own set of labels
[698ec72]834 GuardValue( labelVars );
[52c14b3]835 labelVars.clear();
[680620d]836 // LabelFinder does not recurse into FunctionDecl, so need to visit
837 // its children manually.
[698ec72]838 maybeAccept( funcDecl->type, finder );
839 maybeAccept( funcDecl->statements, finder );
[52c14b3]840
[698ec72]841 // all labels for this function have been collected, insert destructors as appropriate via implicit recursion.
[52c14b3]842 }
843
[698ec72]844 void InsertDtors::previsit( CompoundStmt * compoundStmt ) {
[adcc065]845 // visit statements - this will also populate reverseDeclOrder list. don't want to dump all destructors
846 // when block is left, just the destructors associated with variables defined in this block, so push a new
847 // list to the top of the stack so that we can differentiate scopes
[c2931ea]848 reverseDeclOrder.push_front( OrderedDecls() );
[698ec72]849 Parent::previsit( compoundStmt );
850 }
[39786813]851
[698ec72]852 void InsertDtors::postvisit( CompoundStmt * compoundStmt ) {
[0661678]853 // add destructors for the current scope that we're exiting, unless the last statement is a return, which
854 // causes unreachable code warnings
[c2931ea]855 std::list< Statement * > & statements = compoundStmt->get_kids();
[0661678]856 if ( ! statements.empty() && ! dynamic_cast< ReturnStmt * >( statements.back() ) ) {
857 insertDtors( reverseDeclOrder.front().begin(), reverseDeclOrder.front().end(), back_inserter( statements ) );
858 }
[c2931ea]859 reverseDeclOrder.pop_front();
[39786813]860 }
861
[698ec72]862 void InsertDtors::previsit( ReturnStmt * ) {
[4b2589a]863 // return exits all scopes, so dump destructors for all scopes
[c2931ea]864 for ( OrderedDecls & od : reverseDeclOrder ) {
[698ec72]865 insertDtors( od.begin(), od.end(), back_inserter( stmtsToAddBefore ) );
[adcc065]866 } // for
[39786813]867 }
[f1e012b]868
[adcc065]869 // Handle break/continue/goto in the same manner as C++. Basic idea: any objects that are in scope at the
870 // BranchStmt but not at the labelled (target) statement must be destructed. If there are any objects in scope
871 // at the target location but not at the BranchStmt then those objects would be uninitialized so notify the user
872 // of the error. See C++ Reference 6.6 Jump Statements for details.
[c2931ea]873 void InsertDtors::handleGoto( BranchStmt * stmt ) {
[5809461]874 // can't do anything for computed goto
875 if ( stmt->computedTarget ) return;
876
877 assertf( stmt->get_target() != "", "BranchStmt missing a label: %s", toString( stmt ).c_str() );
[c2931ea]878 // S_L = lvars = set of objects in scope at label definition
879 // S_G = curVars = set of objects in scope at goto statement
880 ObjectSet & lvars = labelVars[ stmt->get_target() ];
881
882 DTOR_PRINT(
883 std::cerr << "at goto label: " << stmt->get_target().get_name() << std::endl;
884 std::cerr << "S_G = " << printSet( curVars ) << std::endl;
885 std::cerr << "S_L = " << printSet( lvars ) << std::endl;
886 )
887
888 ObjectSet diff;
889 // S_L-S_G results in set of objects whose construction is skipped - it's an error if this set is non-empty
890 std::set_difference( lvars.begin(), lvars.end(), curVars.begin(), curVars.end(), std::inserter( diff, diff.begin() ) );
891 DTOR_PRINT(
892 std::cerr << "S_L-S_G = " << printSet( diff ) << std::endl;
893 )
894 if ( ! diff.empty() ) {
895 throw SemanticError( std::string("jump to label '") + stmt->get_target().get_name() + "' crosses initialization of " + (*diff.begin())->get_name() + " ", stmt );
[adcc065]896 } // if
[c2931ea]897 // S_G-S_L results in set of objects that must be destructed
898 diff.clear();
899 std::set_difference( curVars.begin(), curVars.end(), lvars.begin(), lvars.end(), std::inserter( diff, diff.end() ) );
900 DTOR_PRINT(
901 std::cerr << "S_G-S_L = " << printSet( diff ) << std::endl;
902 )
903 if ( ! diff.empty() ) {
[62423350]904 // create an auxilliary set for fast lookup -- can't make diff a set, because diff ordering should be consistent for error messages.
905 std::unordered_set<ObjectDecl *> needsDestructor( diff.begin(), diff.end() );
906
[c2931ea]907 // go through decl ordered list of objectdecl. for each element that occurs in diff, output destructor
908 OrderedDecls ordered;
909 for ( OrderedDecls & rdo : reverseDeclOrder ) {
910 // add elements from reverseDeclOrder into ordered if they occur in diff - it is key that this happens in reverse declaration order.
[62423350]911 copy_if( rdo.begin(), rdo.end(), back_inserter( ordered ), [&]( ObjectDecl * objDecl ) { return needsDestructor.count( objDecl ); } );
[adcc065]912 } // for
[698ec72]913 insertDtors( ordered.begin(), ordered.end(), back_inserter( stmtsToAddBefore ) );
[adcc065]914 } // if
[c2931ea]915 }
[39786813]916
[698ec72]917 void InsertDtors::previsit( BranchStmt * stmt ) {
[c2931ea]918 switch( stmt->get_type() ) {
[adcc065]919 case BranchStmt::Continue:
920 case BranchStmt::Break:
921 // could optimize the break/continue case, because the S_L-S_G check is unnecessary (this set should
922 // always be empty), but it serves as a small sanity check.
923 case BranchStmt::Goto:
924 handleGoto( stmt );
925 break;
926 default:
927 assert( false );
928 } // switch
[c2931ea]929 }
[79970ed]930
931 bool checkWarnings( FunctionDecl * funcDecl ) {
932 // only check for warnings if the current function is a user-defined
933 // constructor or destructor
934 if ( ! funcDecl ) return false;
935 if ( ! funcDecl->get_statements() ) return false;
[bff227f]936 return CodeGen::isCtorDtor( funcDecl->get_name() ) && ! LinkageSpec::isOverridable( funcDecl->get_linkage() );
[79970ed]937 }
938
[9a707e4e]939 void GenStructMemberCalls::previsit( FunctionDecl * funcDecl ) {
[5363fdf]940 GuardValue( function );
[9a707e4e]941 GuardValue( unhandled );
942 GuardValue( usedUninit );
943 GuardValue( thisParam );
944 GuardValue( isCtor );
945 GuardValue( structDecl );
[64ac636]946 errors = SemanticError(); // clear previous errors
[c8dfcd3]947
948 // need to start with fresh sets
949 unhandled.clear();
950 usedUninit.clear();
[79970ed]951
952 function = funcDecl;
[bff227f]953 isCtor = CodeGen::isConstructor( function->get_name() );
[c8dfcd3]954 if ( checkWarnings( function ) ) {
955 FunctionType * type = function->get_functionType();
[79970ed]956 assert( ! type->get_parameters().empty() );
[e3e16bc]957 thisParam = strict_dynamic_cast< ObjectDecl * >( type->get_parameters().front() );
[0a81c3f]958 Type * thisType = getPointerBase( thisParam->get_type() );
959 StructInstType * structType = dynamic_cast< StructInstType * >( thisType );
[79970ed]960 if ( structType ) {
[44f6341]961 structDecl = structType->get_baseStruct();
[79970ed]962 for ( Declaration * member : structDecl->get_members() ) {
963 if ( ObjectDecl * field = dynamic_cast< ObjectDecl * >( member ) ) {
964 // record all of the struct type's members that need to be constructed or
965 // destructed by the end of the function
966 unhandled.insert( field );
967 }
968 }
969 }
970 }
[9a707e4e]971 }
972
973 void GenStructMemberCalls::postvisit( FunctionDecl * funcDecl ) {
[c8dfcd3]974 // remove the unhandled objects from usedUninit, because a call is inserted
975 // to handle them - only objects that are later constructed are used uninitialized.
[64ac636]976 std::map< DeclarationWithType *, CodeLocation > diff;
977 // need the comparator since usedUninit and unhandled have different types
978 struct comp_t {
979 typedef decltype(usedUninit)::value_type usedUninit_t;
980 typedef decltype(unhandled)::value_type unhandled_t;
981 bool operator()(usedUninit_t x, unhandled_t y) { return x.first < y; }
982 bool operator()(unhandled_t x, usedUninit_t y) { return x < y.first; }
983 } comp;
984 std::set_difference( usedUninit.begin(), usedUninit.end(), unhandled.begin(), unhandled.end(), std::inserter( diff, diff.begin() ), comp );
985 for ( auto p : diff ) {
986 DeclarationWithType * member = p.first;
987 CodeLocation loc = p.second;
988 // xxx - make error message better by also tracking the location that the object is constructed at?
989 emit( loc, "in ", CodeGen::genPrettyType( function->get_functionType(), function->get_name() ), ", field ", member->get_name(), " used before being constructed" );
[79970ed]990 }
991
[c8dfcd3]992 if ( ! unhandled.empty() ) {
[4618319]993 // need to explicitly re-add function parameters to the indexer in order to resolve copy constructors
[9a707e4e]994 auto guard = makeFuncGuard( [this]() { indexer.enterScope(); }, [this]() { indexer.leaveScope(); } );
[5fe35d6]995 indexer.addFunctionType( function->type );
[44f6341]996
997 // need to iterate through members in reverse in order for
998 // ctor/dtor statements to come out in the right order
[1ba88a0]999 for ( Declaration * member : reverseIterate( structDecl->get_members() ) ) {
[44f6341]1000 DeclarationWithType * field = dynamic_cast< DeclarationWithType * >( member );
1001 // skip non-DWT members
1002 if ( ! field ) continue;
[05807e9]1003 // skip non-constructable members
1004 if ( ! tryConstruct( field ) ) continue;
[44f6341]1005 // skip handled members
1006 if ( ! unhandled.count( field ) ) continue;
1007
1008 // insert and resolve default/copy constructor call for each field that's unhandled
[c8dfcd3]1009 std::list< Statement * > stmt;
[5fe35d6]1010 Expression * arg2 = nullptr;
[4d4882a]1011 if ( isCopyConstructor( function ) ) {
[44f6341]1012 // if copy ctor, need to pass second-param-of-this-function.field
[4d4882a]1013 std::list< DeclarationWithType * > & params = function->get_functionType()->get_parameters();
1014 assert( params.size() == 2 );
[44f6341]1015 arg2 = new MemberExpr( field, new VariableExpr( params.back() ) );
[4d4882a]1016 }
1017 InitExpander srcParam( arg2 );
[4618319]1018 // cast away reference type and construct field.
1019 Expression * thisExpr = new CastExpr( new VariableExpr( thisParam ), thisParam->get_type()->stripReferences()->clone() );
1020 Expression * memberDest = new MemberExpr( field, thisExpr );
1021 SymTab::genImplicitCall( srcParam, memberDest, function->get_name(), back_inserter( stmt ), field, isCtor );
[c8dfcd3]1022
1023 assert( stmt.size() <= 1 );
1024 if ( stmt.size() == 1 ) {
1025 Statement * callStmt = stmt.front();
1026
[9a707e4e]1027 MutatingResolver resolver( indexer );
[c8dfcd3]1028 try {
1029 callStmt->acceptMutator( resolver );
1030 if ( isCtor ) {
1031 function->get_statements()->push_front( callStmt );
1032 } else {
1033 // destructor statements should be added at the end
1034 function->get_statements()->push_back( callStmt );
1035 }
1036 } catch ( SemanticError & error ) {
[64ac636]1037 emit( funcDecl->location, "in ", CodeGen::genPrettyType( function->get_functionType(), function->get_name() ), ", field ", field->get_name(), " not explicitly ", isCtor ? "constructed" : "destructed", " and no ", isCtor ? "default constructor" : "destructor", " found" );
[c8dfcd3]1038 }
1039 }
1040 }
1041 }
[64ac636]1042 if (! errors.isEmpty()) {
1043 throw errors;
1044 }
[79970ed]1045 }
1046
[4618319]1047 /// true if expr is effectively just the 'this' parameter
1048 bool isThisExpression( Expression * expr, DeclarationWithType * thisParam ) {
1049 // TODO: there are more complicated ways to pass 'this' to a constructor, e.g. &*, *&, etc.
1050 if ( VariableExpr * varExpr = dynamic_cast< VariableExpr * >( expr ) ) {
1051 return varExpr->get_var() == thisParam;
1052 } else if ( CastExpr * castExpr = dynamic_cast< CastExpr * > ( expr ) ) {
1053 return isThisExpression( castExpr->get_arg(), thisParam );
1054 }
1055 return false;
1056 }
1057
1058 /// returns a MemberExpr if expr is effectively just member access on the 'this' parameter, else nullptr
1059 MemberExpr * isThisMemberExpr( Expression * expr, DeclarationWithType * thisParam ) {
1060 if ( MemberExpr * memberExpr = dynamic_cast< MemberExpr * >( expr ) ) {
1061 if ( isThisExpression( memberExpr->get_aggregate(), thisParam ) ) {
1062 return memberExpr;
1063 }
1064 } else if ( CastExpr * castExpr = dynamic_cast< CastExpr * >( expr ) ) {
1065 return isThisMemberExpr( castExpr->get_arg(), thisParam );
1066 }
1067 return nullptr;
1068 }
1069
[9a707e4e]1070 void GenStructMemberCalls::previsit( ApplicationExpr * appExpr ) {
1071 if ( ! checkWarnings( function ) ) {
1072 visit_children = false;
1073 return;
1074 }
[79970ed]1075
1076 std::string fname = getFunctionName( appExpr );
1077 if ( fname == function->get_name() ) {
1078 // call to same kind of function
1079 Expression * firstParam = appExpr->get_args().front();
1080
[4618319]1081 if ( isThisExpression( firstParam, thisParam ) ) {
[79970ed]1082 // if calling another constructor on thisParam, assume that function handles
1083 // all members - if it doesn't a warning will appear in that function.
[4618319]1084 unhandled.clear();
1085 } else if ( MemberExpr * memberExpr = isThisMemberExpr( firstParam, thisParam ) ) {
1086 // if first parameter is a member expression on the this parameter,
1087 // then remove the member from unhandled set.
1088 if ( isThisExpression( memberExpr->get_aggregate(), thisParam ) ) {
1089 unhandled.erase( memberExpr->get_member() );
[79970ed]1090 }
1091 }
1092 }
1093 }
1094
[9a707e4e]1095 void GenStructMemberCalls::previsit( MemberExpr * memberExpr ) {
1096 if ( ! checkWarnings( function ) || ! isCtor ) {
1097 visit_children = false;
1098 return;
1099 }
[79970ed]1100
[4618319]1101 if ( isThisExpression( memberExpr->get_aggregate(), thisParam ) ) {
1102 if ( unhandled.count( memberExpr->get_member() ) ) {
1103 // emit a warning because a member was used before it was constructed
1104 usedUninit.insert( { memberExpr->get_member(), memberExpr->location } );
[79970ed]1105 }
1106 }
1107 }
[3906301]1108
1109 template< typename Visitor, typename... Params >
[64ac636]1110 void error( Visitor & v, CodeLocation loc, const Params &... params ) {
1111 SemanticError err( toString( params... ) );
1112 err.set_location( loc );
1113 v.errors.append( err );
[3906301]1114 }
1115
1116 template< typename... Params >
[64ac636]1117 void GenStructMemberCalls::emit( CodeLocation loc, const Params &... params ) {
[3906301]1118 // toggle warnings vs. errors here.
1119 // warn( params... );
[64ac636]1120 error( *this, loc, params... );
[3906301]1121 }
[c8dfcd3]1122
[08da53d]1123 DeclarationWithType * MutatingResolver::mutate( ObjectDecl * objectDecl ) {
[c8dfcd3]1124 // add object to the indexer assumes that there will be no name collisions
1125 // in generated code. If this changes, add mutate methods for entities with
1126 // scope and call {enter,leave}Scope explicitly.
[33a25f9]1127 indexer.addId( objectDecl );
[c8dfcd3]1128 return objectDecl;
1129 }
1130
[08da53d]1131 Expression * MutatingResolver::mutate( UntypedExpr * untypedExpr ) {
1132 Expression * newExpr = untypedExpr;
1133 ResolvExpr::findVoidExpression( newExpr, indexer );
1134 return newExpr;
[c8dfcd3]1135 }
[b6fe7e6]1136
[696bf6e]1137 Expression * FixCtorExprs::postmutate( ConstructorExpr * ctorExpr ) {
[b6fe7e6]1138 static UniqueName tempNamer( "_tmp_ctor_expr" );
[f0121d7]1139 // xxx - is the size check necessary?
[d29fa5f]1140 assert( ctorExpr->result && ctorExpr->get_result()->size() == 1 );
[b7b8674]1141
[627f585]1142 // xxx - this can be TupleAssignExpr now. Need to properly handle this case.
[e3e16bc]1143 ApplicationExpr * callExpr = strict_dynamic_cast< ApplicationExpr * > ( ctorExpr->get_callExpr() );
[b6fe7e6]1144 TypeSubstitution * env = ctorExpr->get_env();
1145 ctorExpr->set_callExpr( nullptr );
1146 ctorExpr->set_env( nullptr );
[f5c3b6c]1147
1148 // 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.
1149 ObjectDecl * tmp = ObjectDecl::newObject( tempNamer.newName(), callExpr->args.front()->result->clone(), nullptr );
1150 declsToAddBefore.push_back( tmp );
[8a6cf7e]1151 delete ctorExpr;
[b6fe7e6]1152
[696bf6e]1153 // build assignment and replace constructor's first argument with new temporary
[b6fe7e6]1154 Expression *& firstArg = callExpr->get_args().front();
[696bf6e]1155 Expression * assign = new UntypedExpr( new NameExpr( "?=?" ), { new AddressExpr( new VariableExpr( tmp ) ), new AddressExpr( firstArg ) } );
[8a6cf7e]1156 firstArg = new VariableExpr( tmp );
1157
[696bf6e]1158 // resolve assignment and dispose of new env
[08da53d]1159 ResolvExpr::findVoidExpression( assign, indexer );
1160 delete assign->env;
1161 assign->env = nullptr;
[696bf6e]1162
[8a6cf7e]1163 // for constructor expr:
1164 // T x;
1165 // x{};
1166 // results in:
1167 // T x;
1168 // T & tmp;
1169 // &tmp = &x, ?{}(tmp), tmp
[08da53d]1170 CommaExpr * commaExpr = new CommaExpr( assign, new CommaExpr( callExpr, new VariableExpr( tmp ) ) );
[b6fe7e6]1171 commaExpr->set_env( env );
1172 return commaExpr;
1173 }
[c2931ea]1174 } // namespace
[71f4e4f]1175} // namespace InitTweak
1176
1177// Local Variables: //
1178// tab-width: 4 //
1179// mode: c++ //
1180// compile-command: "make install" //
1181// End: //
Note: See TracBrowser for help on using the repository browser.