source: src/InitTweak/FixInit.cc@ a8e64c4

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 a8e64c4 was 0661678, checked in by Rob Schluntz <rschlunt@…>, 8 years ago

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