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 : Peter A. Buhr |
---|
12 | // Last Modified On : Fri Mar 17 09:12:36 2017 |
---|
13 | // Update Count : 183 |
---|
14 | // |
---|
15 | |
---|
16 | #include <stack> |
---|
17 | #include <list> |
---|
18 | |
---|
19 | #include "InitTweak.h" |
---|
20 | #include "GenInit.h" |
---|
21 | |
---|
22 | #include "Common/PassVisitor.h" |
---|
23 | |
---|
24 | #include "GenPoly/DeclMutator.h" |
---|
25 | #include "GenPoly/PolyMutator.h" |
---|
26 | #include "GenPoly/ScopedSet.h" |
---|
27 | |
---|
28 | #include "ResolvExpr/typeops.h" |
---|
29 | |
---|
30 | #include "SynTree/Declaration.h" |
---|
31 | #include "SynTree/Expression.h" |
---|
32 | #include "SynTree/Initializer.h" |
---|
33 | #include "SynTree/Mutator.h" |
---|
34 | #include "SynTree/Statement.h" |
---|
35 | #include "SynTree/Type.h" |
---|
36 | |
---|
37 | #include "SymTab/Autogen.h" |
---|
38 | #include "SymTab/Mangler.h" |
---|
39 | |
---|
40 | namespace InitTweak { |
---|
41 | namespace { |
---|
42 | const std::list<Label> noLabels; |
---|
43 | const std::list<Expression *> noDesignators; |
---|
44 | } |
---|
45 | |
---|
46 | struct ReturnFixer : public WithStmtsToAdd, public WithGuards { |
---|
47 | /// consistently allocates a temporary variable for the return value |
---|
48 | /// of a function so that anything which the resolver decides can be constructed |
---|
49 | /// into the return type of a function can be returned. |
---|
50 | static void makeReturnTemp( std::list< Declaration * > &translationUnit ); |
---|
51 | |
---|
52 | void premutate( FunctionDecl *functionDecl ); |
---|
53 | void premutate( ReturnStmt * returnStmt ); |
---|
54 | |
---|
55 | protected: |
---|
56 | FunctionType * ftype; |
---|
57 | std::string funcName; |
---|
58 | }; |
---|
59 | |
---|
60 | struct CtorDtor : public WithGuards, public WithShortCircuiting { |
---|
61 | /// create constructor and destructor statements for object declarations. |
---|
62 | /// the actual call statements will be added in after the resolver has run |
---|
63 | /// so that the initializer expression is only removed if a constructor is found |
---|
64 | /// and the same destructor call is inserted in all of the appropriate locations. |
---|
65 | static void generateCtorDtor( std::list< Declaration * > &translationUnit ); |
---|
66 | |
---|
67 | void previsit( ObjectDecl * ); |
---|
68 | void previsit( FunctionDecl *functionDecl ); |
---|
69 | |
---|
70 | // should not traverse into any of these declarations to find objects |
---|
71 | // that need to be constructed or destructed |
---|
72 | void previsit( StructDecl *aggregateDecl ); |
---|
73 | void previsit( UnionDecl *aggregateDecl ) { visit_children = false; } |
---|
74 | void previsit( EnumDecl *aggregateDecl ) { visit_children = false; } |
---|
75 | void previsit( TraitDecl *aggregateDecl ) { visit_children = false; } |
---|
76 | void previsit( TypeDecl *typeDecl ) { visit_children = false; } |
---|
77 | void previsit( TypedefDecl *typeDecl ) { visit_children = false; } |
---|
78 | |
---|
79 | void previsit( FunctionType *funcType ) { visit_children = false; } |
---|
80 | |
---|
81 | void previsit( CompoundStmt * compoundStmt ); |
---|
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 | Type::StorageClasses storageClasses; |
---|
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 | PassVisitor<ReturnFixer> fixer; |
---|
134 | mutateAll( translationUnit, fixer ); |
---|
135 | } |
---|
136 | |
---|
137 | void ReturnFixer::premutate( ReturnStmt *returnStmt ) { |
---|
138 | std::list< DeclarationWithType * > & returnVals = ftype->get_returnVals(); |
---|
139 | assert( returnVals.size() == 0 || returnVals.size() == 1 ); |
---|
140 | // hands off if the function returns an lvalue - we don't want to allocate a temporary if a variable's address |
---|
141 | // is being returned |
---|
142 | if ( returnStmt->get_expr() && returnVals.size() == 1 && ! returnVals.front()->get_type()->get_lvalue() ) { |
---|
143 | // explicitly construct the return value using the return expression and the retVal object |
---|
144 | assertf( returnVals.front()->get_name() != "", "Function %s has unnamed return value\n", funcName.c_str() ); |
---|
145 | UntypedExpr *construct = new UntypedExpr( new NameExpr( "?{}" ) ); |
---|
146 | construct->get_args().push_back( new AddressExpr( new VariableExpr( returnVals.front() ) ) ); |
---|
147 | construct->get_args().push_back( returnStmt->get_expr() ); |
---|
148 | stmtsToAddBefore.push_back(new ExprStmt(noLabels, construct)); |
---|
149 | |
---|
150 | // return the retVal object |
---|
151 | returnStmt->set_expr( new VariableExpr( returnVals.front() ) ); |
---|
152 | } // if |
---|
153 | } |
---|
154 | |
---|
155 | void ReturnFixer::premutate( FunctionDecl *functionDecl ) { |
---|
156 | GuardValue( ftype ); |
---|
157 | GuardValue( funcName ); |
---|
158 | |
---|
159 | ftype = functionDecl->get_functionType(); |
---|
160 | funcName = functionDecl->get_name(); |
---|
161 | } |
---|
162 | |
---|
163 | // precompute array dimension expression, because constructor generation may duplicate it, |
---|
164 | // which would be incorrect if it is a side-effecting computation. |
---|
165 | void HoistArrayDimension::hoistArrayDimension( std::list< Declaration * > & translationUnit ) { |
---|
166 | HoistArrayDimension hoister; |
---|
167 | hoister.mutateDeclarationList( translationUnit ); |
---|
168 | } |
---|
169 | |
---|
170 | DeclarationWithType * HoistArrayDimension::mutate( ObjectDecl * objectDecl ) { |
---|
171 | storageClasses = objectDecl->get_storageClasses(); |
---|
172 | DeclarationWithType * temp = Parent::mutate( objectDecl ); |
---|
173 | hoist( objectDecl->get_type() ); |
---|
174 | return temp; |
---|
175 | } |
---|
176 | |
---|
177 | void HoistArrayDimension::hoist( Type * type ) { |
---|
178 | // if in function, generate const size_t var |
---|
179 | static UniqueName dimensionName( "_array_dim" ); |
---|
180 | |
---|
181 | // C doesn't allow variable sized arrays at global scope or for static variables, so don't hoist dimension. |
---|
182 | if ( ! inFunction ) return; |
---|
183 | if ( storageClasses.is_static ) return; |
---|
184 | |
---|
185 | if ( ArrayType * arrayType = dynamic_cast< ArrayType * >( type ) ) { |
---|
186 | if ( ! arrayType->get_dimension() ) return; // xxx - recursive call to hoist? |
---|
187 | |
---|
188 | // don't need to hoist dimension if it's a constexpr - only need to if there's potential for side effects. |
---|
189 | if ( isConstExpr( arrayType->get_dimension() ) ) return; |
---|
190 | |
---|
191 | ObjectDecl * arrayDimension = new ObjectDecl( dimensionName.newName(), storageClasses, LinkageSpec::C, 0, SymTab::SizeType->clone(), new SingleInit( arrayType->get_dimension() ) ); |
---|
192 | arrayDimension->get_type()->set_const( true ); |
---|
193 | |
---|
194 | arrayType->set_dimension( new VariableExpr( arrayDimension ) ); |
---|
195 | addDeclaration( arrayDimension ); |
---|
196 | |
---|
197 | hoist( arrayType->get_base() ); |
---|
198 | return; |
---|
199 | } |
---|
200 | } |
---|
201 | |
---|
202 | DeclarationWithType * HoistArrayDimension::mutate( FunctionDecl *functionDecl ) { |
---|
203 | ValueGuard< bool > oldInFunc( inFunction ); |
---|
204 | inFunction = true; |
---|
205 | DeclarationWithType * decl = Parent::mutate( functionDecl ); |
---|
206 | return decl; |
---|
207 | } |
---|
208 | |
---|
209 | void CtorDtor::generateCtorDtor( std::list< Declaration * > & translationUnit ) { |
---|
210 | PassVisitor<CtorDtor> ctordtor; |
---|
211 | acceptAll( translationUnit, ctordtor ); |
---|
212 | } |
---|
213 | |
---|
214 | bool CtorDtor::isManaged( Type * type ) const { |
---|
215 | // need to clear and reset qualifiers when determining if a type is managed |
---|
216 | ValueGuard< Type::Qualifiers > qualifiers( type->get_qualifiers() ); |
---|
217 | type->get_qualifiers() = Type::Qualifiers(); |
---|
218 | if ( TupleType * tupleType = dynamic_cast< TupleType * > ( type ) ) { |
---|
219 | // tuple is also managed if any of its components are managed |
---|
220 | if ( std::any_of( tupleType->get_types().begin(), tupleType->get_types().end(), [&](Type * type) { return isManaged( type ); }) ) { |
---|
221 | return true; |
---|
222 | } |
---|
223 | } |
---|
224 | // a type is managed if it appears in the map of known managed types, or if it contains any polymorphism (is a type variable or generic type containing a type variable) |
---|
225 | return managedTypes.find( SymTab::Mangler::mangle( type ) ) != managedTypes.end() || GenPoly::isPolyType( type ); |
---|
226 | } |
---|
227 | |
---|
228 | bool CtorDtor::isManaged( ObjectDecl * objDecl ) const { |
---|
229 | Type * type = objDecl->get_type(); |
---|
230 | while ( ArrayType * at = dynamic_cast< ArrayType * >( type ) ) { |
---|
231 | type = at->get_base(); |
---|
232 | } |
---|
233 | return isManaged( type ); |
---|
234 | } |
---|
235 | |
---|
236 | void CtorDtor::handleDWT( DeclarationWithType * dwt ) { |
---|
237 | // if this function is a user-defined constructor or destructor, mark down the type as "managed" |
---|
238 | if ( ! LinkageSpec::isOverridable( dwt->get_linkage() ) && isCtorDtor( dwt->get_name() ) ) { |
---|
239 | std::list< DeclarationWithType * > & params = GenPoly::getFunctionType( dwt->get_type() )->get_parameters(); |
---|
240 | assert( ! params.empty() ); |
---|
241 | PointerType * type = safe_dynamic_cast< PointerType * >( params.front()->get_type() ); |
---|
242 | managedTypes.insert( SymTab::Mangler::mangle( type->get_base() ) ); |
---|
243 | } |
---|
244 | } |
---|
245 | |
---|
246 | ImplicitCtorDtorStmt * genCtorDtor( const std::string & fname, ObjectDecl * objDecl, Expression * arg ) { |
---|
247 | // call into genImplicitCall from Autogen.h to generate calls to ctor/dtor |
---|
248 | assertf( objDecl, "genCtorDtor passed null objDecl" ); |
---|
249 | std::list< Statement * > stmts; |
---|
250 | InitExpander srcParam( maybeClone( arg ) ); |
---|
251 | SymTab::genImplicitCall( srcParam, new VariableExpr( objDecl ), fname, back_inserter( stmts ), objDecl ); |
---|
252 | assert( stmts.size() <= 1 ); |
---|
253 | return stmts.size() == 1 ? safe_dynamic_cast< ImplicitCtorDtorStmt * >( stmts.front() ) : nullptr; |
---|
254 | } |
---|
255 | |
---|
256 | ConstructorInit * genCtorInit( ObjectDecl * objDecl ) { |
---|
257 | // call into genImplicitCall from Autogen.h to generate calls to ctor/dtor |
---|
258 | // for each constructable object |
---|
259 | std::list< Statement * > ctor; |
---|
260 | std::list< Statement * > dtor; |
---|
261 | |
---|
262 | InitExpander srcParam( objDecl->get_init() ); |
---|
263 | InitExpander nullParam( (Initializer *)NULL ); |
---|
264 | SymTab::genImplicitCall( srcParam, new VariableExpr( objDecl ), "?{}", back_inserter( ctor ), objDecl ); |
---|
265 | SymTab::genImplicitCall( nullParam, new VariableExpr( objDecl ), "^?{}", front_inserter( dtor ), objDecl, false ); |
---|
266 | |
---|
267 | // Currently genImplicitCall produces a single Statement - a CompoundStmt |
---|
268 | // which wraps everything that needs to happen. As such, it's technically |
---|
269 | // possible to use a Statement ** in the above calls, but this is inherently |
---|
270 | // unsafe, so instead we take the slightly less efficient route, but will be |
---|
271 | // immediately informed if somehow the above assumption is broken. In this case, |
---|
272 | // we could always wrap the list of statements at this point with a CompoundStmt, |
---|
273 | // but it seems reasonable at the moment for this to be done by genImplicitCall |
---|
274 | // itself. It is possible that genImplicitCall produces no statements (e.g. if |
---|
275 | // an array type does not have a dimension). In this case, it's fine to ignore |
---|
276 | // the object for the purposes of construction. |
---|
277 | assert( ctor.size() == dtor.size() && ctor.size() <= 1 ); |
---|
278 | if ( ctor.size() == 1 ) { |
---|
279 | // need to remember init expression, in case no ctors exist |
---|
280 | // if ctor does exist, want to use ctor expression instead of init |
---|
281 | // push this decision to the resolver |
---|
282 | assert( dynamic_cast< ImplicitCtorDtorStmt * > ( ctor.front() ) && dynamic_cast< ImplicitCtorDtorStmt * > ( dtor.front() ) ); |
---|
283 | return new ConstructorInit( ctor.front(), dtor.front(), objDecl->get_init() ); |
---|
284 | } |
---|
285 | return nullptr; |
---|
286 | } |
---|
287 | |
---|
288 | void CtorDtor::previsit( ObjectDecl * objDecl ) { |
---|
289 | handleDWT( objDecl ); |
---|
290 | // hands off if @=, extern, builtin, etc. |
---|
291 | // even if unmanaged, try to construct global or static if initializer is not constexpr, since this is not legal C |
---|
292 | if ( tryConstruct( objDecl ) && ( isManaged( objDecl ) || ((! inFunction || objDecl->get_storageClasses().is_static ) && ! isConstExpr( objDecl->get_init() ) ) ) ) { |
---|
293 | // constructed objects cannot be designated |
---|
294 | 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 @=.\n", objDecl ); |
---|
295 | // constructed objects should not have initializers nested too deeply |
---|
296 | if ( ! checkInitDepth( objDecl ) ) throw SemanticError( "Managed object's initializer is too deep ", objDecl ); |
---|
297 | |
---|
298 | objDecl->set_init( genCtorInit( objDecl ) ); |
---|
299 | } |
---|
300 | } |
---|
301 | |
---|
302 | void CtorDtor::previsit( FunctionDecl *functionDecl ) { |
---|
303 | GuardValue( inFunction ); |
---|
304 | inFunction = true; |
---|
305 | |
---|
306 | handleDWT( functionDecl ); |
---|
307 | |
---|
308 | GuardScope( managedTypes ); |
---|
309 | // go through assertions and recursively add seen ctor/dtors |
---|
310 | for ( auto & tyDecl : functionDecl->get_functionType()->get_forall() ) { |
---|
311 | for ( DeclarationWithType *& assertion : tyDecl->get_assertions() ) { |
---|
312 | handleDWT( assertion ); |
---|
313 | } |
---|
314 | } |
---|
315 | |
---|
316 | PassVisitor<CtorDtor> newCtorDtor; |
---|
317 | newCtorDtor.pass = *this; |
---|
318 | maybeAccept( functionDecl->get_statements(), newCtorDtor ); |
---|
319 | visit_children = false; // do not try and construct parameters or forall parameters - must happen after maybeAccept |
---|
320 | } |
---|
321 | |
---|
322 | void CtorDtor::previsit( StructDecl *aggregateDecl ) { |
---|
323 | visit_children = false; // do not try to construct and destruct aggregate members |
---|
324 | |
---|
325 | // don't construct members, but need to take note if there is a managed member, |
---|
326 | // because that means that this type is also managed |
---|
327 | for ( Declaration * member : aggregateDecl->get_members() ) { |
---|
328 | if ( ObjectDecl * field = dynamic_cast< ObjectDecl * >( member ) ) { |
---|
329 | if ( isManaged( field ) ) { |
---|
330 | StructInstType inst( Type::Qualifiers(), aggregateDecl ); |
---|
331 | managedTypes.insert( SymTab::Mangler::mangle( &inst ) ); |
---|
332 | break; |
---|
333 | } |
---|
334 | } |
---|
335 | } |
---|
336 | } |
---|
337 | |
---|
338 | void CtorDtor::previsit( CompoundStmt * compoundStmt ) { |
---|
339 | GuardScope( managedTypes ); |
---|
340 | } |
---|
341 | } // namespace InitTweak |
---|
342 | |
---|
343 | // Local Variables: // |
---|
344 | // tab-width: 4 // |
---|
345 | // mode: c++ // |
---|
346 | // compile-command: "make install" // |
---|
347 | // End: // |
---|