source: src/InitTweak/GenInit.cc@ 2d59d53

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 2d59d53 was b726084, checked in by Rob Schluntz <rschlunt@…>, 9 years ago

Merge branch 'master' into tuples

Conflicts:

src/ControlStruct/LabelTypeChecker.cc
src/InitTweak/FixInit.cc
src/ResolvExpr/Resolver.cc
src/Tuples/TupleAssignment.cc
src/Tuples/TupleAssignment.h
  • Property mode set to 100644
File size: 15.6 KB
Line 
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// GenInit.cc --
8//
9// Author : Rob Schluntz
10// Created On : Mon May 18 07:44:20 2015
11// Last Modified By : Rob Schluntz
12// Last Modified On : Fri May 13 11:37:48 2016
13// Update Count : 166
14//
15
16#include <stack>
17#include <list>
18#include "GenInit.h"
19#include "InitTweak.h"
20#include "SynTree/Declaration.h"
21#include "SynTree/Type.h"
22#include "SynTree/Expression.h"
23#include "SynTree/Statement.h"
24#include "SynTree/Initializer.h"
25#include "SynTree/Mutator.h"
26#include "SymTab/Autogen.h"
27#include "SymTab/Mangler.h"
28#include "GenPoly/PolyMutator.h"
29#include "GenPoly/DeclMutator.h"
30#include "GenPoly/ScopedSet.h"
31#include "ResolvExpr/typeops.h"
32
33namespace InitTweak {
34 namespace {
35 const std::list<Label> noLabels;
36 const std::list<Expression *> noDesignators;
37 }
38
39 class ReturnFixer final : public GenPoly::PolyMutator {
40 public:
41 /// consistently allocates a temporary variable for the return value
42 /// of a function so that anything which the resolver decides can be constructed
43 /// into the return type of a function can be returned.
44 static void makeReturnTemp( std::list< Declaration * > &translationUnit );
45
46 ReturnFixer();
47
48 using GenPoly::PolyMutator::mutate;
49 virtual DeclarationWithType * mutate( FunctionDecl *functionDecl ) override;
50 virtual Statement * mutate( ReturnStmt * returnStmt ) override;
51
52 protected:
53 FunctionType * ftype;
54 UniqueName tempNamer;
55 std::string funcName;
56 };
57
58 class CtorDtor final : public GenPoly::PolyMutator {
59 public:
60 typedef GenPoly::PolyMutator Parent;
61 using Parent::mutate;
62 /// create constructor and destructor statements for object declarations.
63 /// the actual call statements will be added in after the resolver has run
64 /// so that the initializer expression is only removed if a constructor is found
65 /// and the same destructor call is inserted in all of the appropriate locations.
66 static void generateCtorDtor( std::list< Declaration * > &translationUnit );
67
68 virtual DeclarationWithType * mutate( ObjectDecl * ) override;
69 virtual DeclarationWithType * mutate( FunctionDecl *functionDecl ) override;
70 // should not traverse into any of these declarations to find objects
71 // that need to be constructed or destructed
72 virtual Declaration* mutate( StructDecl *aggregateDecl ) override;
73 virtual Declaration* mutate( UnionDecl *aggregateDecl ) override { return aggregateDecl; }
74 virtual Declaration* mutate( EnumDecl *aggregateDecl ) override { return aggregateDecl; }
75 virtual Declaration* mutate( TraitDecl *aggregateDecl ) override { return aggregateDecl; }
76 virtual TypeDecl* mutate( TypeDecl *typeDecl ) override { return typeDecl; }
77 virtual Declaration* mutate( TypedefDecl *typeDecl ) override { return typeDecl; }
78
79 virtual Type * mutate( FunctionType *funcType ) override { return funcType; }
80
81 virtual CompoundStmt * mutate( CompoundStmt * compoundStmt ) override;
82
83 private:
84 // set of mangled type names for which a constructor or destructor exists in the current scope.
85 // these types require a ConstructorInit node to be generated, anything else is a POD type and thus
86 // should not have a ConstructorInit generated.
87
88 bool isManaged( ObjectDecl * objDecl ) const ; // determine if object is managed
89 bool isManaged( Type * type ) const; // determine if type is managed
90 void handleDWT( DeclarationWithType * dwt ); // add type to managed if ctor/dtor
91 GenPoly::ScopedSet< std::string > managedTypes;
92 bool inFunction = false;
93 };
94
95 class HoistArrayDimension final : public GenPoly::DeclMutator {
96 public:
97 typedef GenPoly::DeclMutator Parent;
98
99 /// hoist dimension from array types in object declaration so that it uses a single
100 /// const variable of type size_t, so that side effecting array dimensions are only
101 /// computed once.
102 static void hoistArrayDimension( std::list< Declaration * > & translationUnit );
103
104 private:
105 using Parent::mutate;
106
107 virtual DeclarationWithType * mutate( ObjectDecl * objectDecl ) override;
108 virtual DeclarationWithType * mutate( FunctionDecl *functionDecl ) override;
109 // should not traverse into any of these declarations to find objects
110 // that need to be constructed or destructed
111 virtual Declaration* mutate( StructDecl *aggregateDecl ) override { return aggregateDecl; }
112 virtual Declaration* mutate( UnionDecl *aggregateDecl ) override { return aggregateDecl; }
113 virtual Declaration* mutate( EnumDecl *aggregateDecl ) override { return aggregateDecl; }
114 virtual Declaration* mutate( TraitDecl *aggregateDecl ) override { return aggregateDecl; }
115 virtual TypeDecl* mutate( TypeDecl *typeDecl ) override { return typeDecl; }
116 virtual Declaration* mutate( TypedefDecl *typeDecl ) override { return typeDecl; }
117
118 virtual Type* mutate( FunctionType *funcType ) override { return funcType; }
119
120 void hoist( Type * type );
121
122 DeclarationNode::StorageClass storageclass = DeclarationNode::NoStorageClass;
123 bool inFunction = false;
124 };
125
126 void genInit( std::list< Declaration * > & translationUnit ) {
127 ReturnFixer::makeReturnTemp( translationUnit );
128 HoistArrayDimension::hoistArrayDimension( translationUnit );
129 CtorDtor::generateCtorDtor( translationUnit );
130 }
131
132 void ReturnFixer::makeReturnTemp( std::list< Declaration * > & translationUnit ) {
133 ReturnFixer fixer;
134 mutateAll( translationUnit, fixer );
135 }
136
137 ReturnFixer::ReturnFixer() : tempNamer( "_retVal" ) {}
138
139 Statement *ReturnFixer::mutate( ReturnStmt *returnStmt ) {
140 std::list< DeclarationWithType * > & returnVals = ftype->get_returnVals();
141 assert( returnVals.size() == 0 || returnVals.size() == 1 );
142 // hands off if the function returns an lvalue - we don't want to allocate a temporary if a variable's address
143 // is being returned
144 if ( returnStmt->get_expr() && returnVals.size() == 1 && funcName != "?=?" && ! returnVals.front()->get_type()->get_isLvalue() ) {
145 // ensure return value is not destructed by explicitly creating
146 // an empty SingleInit node wherein maybeConstruct is false
147 ObjectDecl *newObj = new ObjectDecl( tempNamer.newName(), DeclarationNode::NoStorageClass, LinkageSpec::C, 0, returnVals.front()->get_type()->clone(), new ListInit( std::list<Initializer*>(), noDesignators, false ) );
148 stmtsToAdd.push_back( new DeclStmt( noLabels, newObj ) );
149
150 // and explicitly create the constructor expression separately
151 UntypedExpr *construct = new UntypedExpr( new NameExpr( "?{}" ) );
152 construct->get_args().push_back( new AddressExpr( new VariableExpr( newObj ) ) );
153 construct->get_args().push_back( returnStmt->get_expr() );
154 stmtsToAdd.push_back(new ExprStmt(noLabels, construct));
155
156 returnStmt->set_expr( new VariableExpr( newObj ) );
157 } // if
158 return returnStmt;
159 }
160
161 DeclarationWithType* ReturnFixer::mutate( FunctionDecl *functionDecl ) {
162 // xxx - need to handle named return values - this pass may need to happen
163 // after resolution? the ordering is tricky because return statements must be
164 // constructed - the simplest way to do that (while also handling multiple
165 // returns) is to structure the returnVals into a tuple, as done here.
166 // however, if the tuple return value is structured before resolution,
167 // it's difficult to resolve named return values, since the name is lost
168 // in conversion to a tuple. this might be easiest to deal with
169 // after reference types are added, as it may then be possible to
170 // uniformly move named return values to the parameter list directly
171 ValueGuard< FunctionType * > oldFtype( ftype );
172 ValueGuard< std::string > oldFuncName( funcName );
173
174 ftype = functionDecl->get_functionType();
175 std::list< DeclarationWithType * > & retVals = ftype->get_returnVals();
176 if ( retVals.size() > 1 ) {
177 TupleType * tupleType = safe_dynamic_cast< TupleType * >( ResolvExpr::extractResultType( ftype ) );
178 ObjectDecl * newRet = new ObjectDecl( tempNamer.newName(), DeclarationNode::NoStorageClass, LinkageSpec::C, 0, tupleType, new ListInit( std::list<Initializer*>(), noDesignators, false ) );
179 retVals.clear();
180 retVals.push_back( newRet );
181 }
182 funcName = functionDecl->get_name();
183 DeclarationWithType * decl = Mutator::mutate( functionDecl );
184 return decl;
185 }
186
187 // precompute array dimension expression, because constructor generation may duplicate it,
188 // which would be incorrect if it is a side-effecting computation.
189 void HoistArrayDimension::hoistArrayDimension( std::list< Declaration * > & translationUnit ) {
190 HoistArrayDimension hoister;
191 hoister.mutateDeclarationList( translationUnit );
192 }
193
194 DeclarationWithType * HoistArrayDimension::mutate( ObjectDecl * objectDecl ) {
195 storageclass = objectDecl->get_storageClass();
196 DeclarationWithType * temp = Parent::mutate( objectDecl );
197 hoist( objectDecl->get_type() );
198 storageclass = DeclarationNode::NoStorageClass;
199 return temp;
200 }
201
202 void HoistArrayDimension::hoist( Type * type ) {
203 // if in function, generate const size_t var
204 static UniqueName dimensionName( "_array_dim" );
205
206 // C doesn't allow variable sized arrays at global scope or for static variables,
207 // so don't hoist dimension.
208 if ( ! inFunction ) return;
209 if ( storageclass == DeclarationNode::Static ) return;
210
211 if ( ArrayType * arrayType = dynamic_cast< ArrayType * >( type ) ) {
212 if ( ! arrayType->get_dimension() ) return; // xxx - recursive call to hoist?
213
214 // don't need to hoist dimension if it's a constexpr - only need to if there's potential
215 // for side effects.
216 if ( isConstExpr( arrayType->get_dimension() ) ) return;
217
218 ObjectDecl * arrayDimension = new ObjectDecl( dimensionName.newName(), storageclass, LinkageSpec::C, 0, SymTab::SizeType->clone(), new SingleInit( arrayType->get_dimension() ) );
219 arrayDimension->get_type()->set_isConst( true );
220
221 arrayType->set_dimension( new VariableExpr( arrayDimension ) );
222 addDeclaration( arrayDimension );
223
224 hoist( arrayType->get_base() );
225 return;
226 }
227 }
228
229 DeclarationWithType * HoistArrayDimension::mutate( FunctionDecl *functionDecl ) {
230 ValueGuard< bool > oldInFunc( inFunction );
231 inFunction = true;
232 DeclarationWithType * decl = Parent::mutate( functionDecl );
233 return decl;
234 }
235
236 void CtorDtor::generateCtorDtor( std::list< Declaration * > & translationUnit ) {
237 CtorDtor ctordtor;
238 mutateAll( translationUnit, ctordtor );
239 }
240
241 bool CtorDtor::isManaged( Type * type ) const {
242 if ( TupleType * tupleType = dynamic_cast< TupleType * > ( type ) ) {
243 // tuple is also managed if any of its components are managed
244 if ( std::any_of( tupleType->get_types().begin(), tupleType->get_types().end(), [&](Type * type) { return isManaged( type ); }) ) {
245 return true;
246 }
247 }
248 return managedTypes.find( SymTab::Mangler::mangle( type ) ) != managedTypes.end();
249 }
250
251 bool CtorDtor::isManaged( ObjectDecl * objDecl ) const {
252 Type * type = objDecl->get_type();
253 while ( ArrayType * at = dynamic_cast< ArrayType * >( type ) ) {
254 type = at->get_base();
255 }
256 return isManaged( type );
257 }
258
259 void CtorDtor::handleDWT( DeclarationWithType * dwt ) {
260 // if this function is a user-defined constructor or destructor, mark down the type as "managed"
261 if ( ! LinkageSpec::isOverridable( dwt->get_linkage() ) && isCtorDtor( dwt->get_name() ) ) {
262 std::list< DeclarationWithType * > & params = GenPoly::getFunctionType( dwt->get_type() )->get_parameters();
263 assert( ! params.empty() );
264 PointerType * type = safe_dynamic_cast< PointerType * >( params.front()->get_type() );
265 managedTypes.insert( SymTab::Mangler::mangle( type->get_base() ) );
266 }
267 }
268
269 ConstructorInit * genCtorInit( ObjectDecl * objDecl ) {
270 // call into genImplicitCall from Autogen.h to generate calls to ctor/dtor
271 // for each constructable object
272 std::list< Statement * > ctor;
273 std::list< Statement * > dtor;
274
275 InitExpander srcParam( objDecl->get_init() );
276 InitExpander nullParam( (Initializer *)NULL );
277 SymTab::genImplicitCall( srcParam, new VariableExpr( objDecl ), "?{}", back_inserter( ctor ), objDecl );
278 SymTab::genImplicitCall( nullParam, new VariableExpr( objDecl ), "^?{}", front_inserter( dtor ), objDecl, false );
279
280 // Currently genImplicitCall produces a single Statement - a CompoundStmt
281 // which wraps everything that needs to happen. As such, it's technically
282 // possible to use a Statement ** in the above calls, but this is inherently
283 // unsafe, so instead we take the slightly less efficient route, but will be
284 // immediately informed if somehow the above assumption is broken. In this case,
285 // we could always wrap the list of statements at this point with a CompoundStmt,
286 // but it seems reasonable at the moment for this to be done by genImplicitCall
287 // itself. It is possible that genImplicitCall produces no statements (e.g. if
288 // an array type does not have a dimension). In this case, it's fine to ignore
289 // the object for the purposes of construction.
290 assert( ctor.size() == dtor.size() && ctor.size() <= 1 );
291 if ( ctor.size() == 1 ) {
292 // need to remember init expression, in case no ctors exist
293 // if ctor does exist, want to use ctor expression instead of init
294 // push this decision to the resolver
295 assert( dynamic_cast< ImplicitCtorDtorStmt * > ( ctor.front() ) && dynamic_cast< ImplicitCtorDtorStmt * > ( dtor.front() ) );
296 return new ConstructorInit( ctor.front(), dtor.front(), objDecl->get_init() );
297 }
298 return nullptr;
299 }
300
301 DeclarationWithType * CtorDtor::mutate( ObjectDecl * objDecl ) {
302 handleDWT( objDecl );
303 // hands off if @=, extern, builtin, etc.
304 // if global but initializer is not constexpr, always try to construct, since this is not legal C
305 if ( ( tryConstruct( objDecl ) && isManaged( objDecl ) ) || (! inFunction && ! isConstExpr( objDecl->get_init() ) ) ) {
306 // constructed objects cannot be designated
307 if ( isDesignated( objDecl->get_init() ) ) throw SemanticError( "Cannot include designations in the initializer for a managed Object. If this is really what you want, then initialize with @=.", objDecl );
308 // constructed objects should not have initializers nested too deeply
309 if ( ! checkInitDepth( objDecl ) ) throw SemanticError( "Managed object's initializer is too deep ", objDecl );
310
311 objDecl->set_init( genCtorInit( objDecl ) );
312 }
313 return Parent::mutate( objDecl );
314 }
315
316 DeclarationWithType * CtorDtor::mutate( FunctionDecl *functionDecl ) {
317 ValueGuard< bool > oldInFunc = inFunction;
318 inFunction = true;
319
320 handleDWT( functionDecl );
321
322 managedTypes.beginScope();
323 // go through assertions and recursively add seen ctor/dtors
324 for ( auto & tyDecl : functionDecl->get_functionType()->get_forall() ) {
325 for ( DeclarationWithType *& assertion : tyDecl->get_assertions() ) {
326 assertion = assertion->acceptMutator( *this );
327 }
328 }
329 // parameters should not be constructed and destructed, so don't mutate FunctionType
330 mutateAll( functionDecl->get_oldDecls(), *this );
331 functionDecl->set_statements( maybeMutate( functionDecl->get_statements(), *this ) );
332
333 managedTypes.endScope();
334 return functionDecl;
335 }
336
337 Declaration* CtorDtor::mutate( StructDecl *aggregateDecl ) {
338 // don't construct members, but need to take note if there is a managed member,
339 // because that means that this type is also managed
340 for ( Declaration * member : aggregateDecl->get_members() ) {
341 if ( ObjectDecl * field = dynamic_cast< ObjectDecl * >( member ) ) {
342 if ( isManaged( field ) ) {
343 managedTypes.insert( SymTab::Mangler::mangle( aggregateDecl ) );
344 break;
345 }
346 }
347 }
348 return aggregateDecl;
349 }
350
351 CompoundStmt * CtorDtor::mutate( CompoundStmt * compoundStmt ) {
352 managedTypes.beginScope();
353 CompoundStmt * stmt = Parent::mutate( compoundStmt );
354 managedTypes.endScope();
355 return stmt;
356 }
357
358} // namespace InitTweak
359
360// Local Variables: //
361// tab-width: 4 //
362// mode: c++ //
363// compile-command: "make install" //
364// End: //
Note: See TracBrowser for help on using the repository browser.