source: src/InitTweak/GenInit.cc @ fdd0509

aaron-thesisarm-ehcleanup-dtorsdeferred_resndemanglerjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-exprnew-envno_listpersistent-indexerresolv-newwith_gc
Last change on this file since fdd0509 was fdd0509, checked in by Rob Schluntz <rschlunt@…>, 4 years ago

Hoist non-constexpr array dimensions

  • Property mode set to 100644
File size: 15.7 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 : Peter A. Buhr
12// Last Modified On : Fri Mar 17 09:12:36 2017
13// Update Count     : 183
14//
15#include "GenInit.h"
16
17#include <stddef.h>                // for NULL
18#include <algorithm>               // for any_of
19#include <cassert>                 // for assert, strict_dynamic_cast, assertf
20#include <iterator>                // for back_inserter, inserter, back_inse...
21#include <list>                    // for _List_iterator, list
22
23#include "CodeGen/OperatorTable.h"
24#include "Common/PassVisitor.h"    // for PassVisitor, WithGuards, WithShort...
25#include "Common/SemanticError.h"  // for SemanticError
26#include "Common/UniqueName.h"     // for UniqueName
27#include "Common/utility.h"        // for ValueGuard, maybeClone
28#include "GenPoly/GenPoly.h"       // for getFunctionType, isPolyType
29#include "GenPoly/ScopedSet.h"     // for ScopedSet, ScopedSet<>::const_iter...
30#include "InitTweak.h"             // for isConstExpr, InitExpander, checkIn...
31#include "Parser/LinkageSpec.h"    // for isOverridable, C
32#include "ResolvExpr/Resolver.h"
33#include "SymTab/Autogen.h"        // for genImplicitCall, SizeType
34#include "SymTab/Mangler.h"        // for Mangler
35#include "SynTree/Declaration.h"   // for ObjectDecl, DeclarationWithType
36#include "SynTree/Expression.h"    // for VariableExpr, UntypedExpr, Address...
37#include "SynTree/Initializer.h"   // for ConstructorInit, SingleInit, Initi...
38#include "SynTree/Label.h"         // for Label
39#include "SynTree/Mutator.h"       // for mutateAll
40#include "SynTree/Statement.h"     // for CompoundStmt, ImplicitCtorDtorStmt
41#include "SynTree/Type.h"          // for Type, ArrayType, Type::Qualifiers
42#include "SynTree/Visitor.h"       // for acceptAll, maybeAccept
43
44namespace InitTweak {
45        namespace {
46                const std::list<Label> noLabels;
47                const std::list<Expression *> noDesignators;
48        }
49
50        struct ReturnFixer : public WithStmtsToAdd, public WithGuards {
51                /// consistently allocates a temporary variable for the return value
52                /// of a function so that anything which the resolver decides can be constructed
53                /// into the return type of a function can be returned.
54                static void makeReturnTemp( std::list< Declaration * > &translationUnit );
55
56                void premutate( FunctionDecl *functionDecl );
57                void premutate( ReturnStmt * returnStmt );
58
59          protected:
60                FunctionType * ftype = nullptr;
61                std::string funcName;
62        };
63
64        struct CtorDtor : public WithGuards, public WithShortCircuiting, public WithVisitorRef<CtorDtor>  {
65                /// create constructor and destructor statements for object declarations.
66                /// the actual call statements will be added in after the resolver has run
67                /// so that the initializer expression is only removed if a constructor is found
68                /// and the same destructor call is inserted in all of the appropriate locations.
69                static void generateCtorDtor( std::list< Declaration * > &translationUnit );
70
71                void previsit( ObjectDecl * );
72                void previsit( FunctionDecl *functionDecl );
73
74                // should not traverse into any of these declarations to find objects
75                // that need to be constructed or destructed
76                void previsit( StructDecl *aggregateDecl );
77                void previsit( AggregateDecl * ) { visit_children = false; }
78                void previsit( NamedTypeDecl * ) { visit_children = false; }
79                void previsit( FunctionType * ) { 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                ManagedTypes managedTypes;
89                bool inFunction = false;
90        };
91
92        struct HoistArrayDimension final : public WithDeclsToAdd, public WithShortCircuiting, public WithGuards, public WithIndexer {
93                /// hoist dimension from array types in object declaration so that it uses a single
94                /// const variable of type size_t, so that side effecting array dimensions are only
95                /// computed once.
96                static void hoistArrayDimension( std::list< Declaration * > & translationUnit );
97
98                void premutate( ObjectDecl * objectDecl );
99                DeclarationWithType * postmutate( ObjectDecl * objectDecl );
100                void premutate( FunctionDecl *functionDecl );
101                // should not traverse into any of these declarations to find objects
102                // that need to be constructed or destructed
103                void premutate( AggregateDecl * ) { visit_children = false; }
104                void premutate( NamedTypeDecl * ) { visit_children = false; }
105                void premutate( FunctionType * ) { visit_children = false; }
106
107                // need this so that enumerators are added to the indexer, due to premutate(AggregateDecl *)
108                void premutate( EnumDecl * ) {}
109
110                void hoist( Type * type );
111
112                Type::StorageClasses storageClasses;
113                bool inFunction = false;
114        };
115
116        void genInit( std::list< Declaration * > & translationUnit ) {
117                fixReturnStatements( translationUnit );
118                HoistArrayDimension::hoistArrayDimension( translationUnit );
119                CtorDtor::generateCtorDtor( translationUnit );
120        }
121
122        void fixReturnStatements( std::list< Declaration * > & translationUnit ) {
123                PassVisitor<ReturnFixer> fixer;
124                mutateAll( translationUnit, fixer );
125        }
126
127        void ReturnFixer::premutate( ReturnStmt *returnStmt ) {
128                std::list< DeclarationWithType * > & returnVals = ftype->get_returnVals();
129                assert( returnVals.size() == 0 || returnVals.size() == 1 );
130                // hands off if the function returns a reference - we don't want to allocate a temporary if a variable's address
131                // is being returned
132                if ( returnStmt->expr && returnVals.size() == 1 && isConstructable( returnVals.front()->get_type() ) ) {
133                        // explicitly construct the return value using the return expression and the retVal object
134                        assertf( returnVals.front()->name != "", "Function %s has unnamed return value\n", funcName.c_str() );
135
136                        ObjectDecl * retVal = strict_dynamic_cast< ObjectDecl * >( returnVals.front() );
137                        if ( VariableExpr * varExpr = dynamic_cast< VariableExpr * >( returnStmt->expr ) ) {
138                                // return statement has already been mutated - don't need to do it again
139                                if ( varExpr->var == retVal ) return;
140                        }
141                        Statement * stmt = genCtorDtor( "?{}", retVal, returnStmt->expr );
142                        assertf( stmt, "ReturnFixer: genCtorDtor returned nullptr: %s / %s", toString( retVal ).c_str(), toString( returnStmt->expr ).c_str() );
143                        stmtsToAddBefore.push_back( stmt );
144
145                        // return the retVal object
146                        returnStmt->expr = new VariableExpr( returnVals.front() );
147                } // if
148        }
149
150        void ReturnFixer::premutate( FunctionDecl *functionDecl ) {
151                GuardValue( ftype );
152                GuardValue( funcName );
153
154                ftype = functionDecl->type;
155                funcName = functionDecl->name;
156        }
157
158        // precompute array dimension expression, because constructor generation may duplicate it,
159        // which would be incorrect if it is a side-effecting computation.
160        void HoistArrayDimension::hoistArrayDimension( std::list< Declaration * > & translationUnit ) {
161                PassVisitor<HoistArrayDimension> hoister;
162                mutateAll( translationUnit, hoister );
163        }
164
165        void HoistArrayDimension::premutate( ObjectDecl * objectDecl ) {
166                GuardValue( storageClasses );
167                storageClasses = objectDecl->get_storageClasses();
168        }
169
170        DeclarationWithType * HoistArrayDimension::postmutate( ObjectDecl * objectDecl ) {
171                hoist( objectDecl->get_type() );
172                return objectDecl;
173        }
174
175        void HoistArrayDimension::hoist( Type * type ) {
176                // if in function, generate const size_t var
177                static UniqueName dimensionName( "_array_dim" );
178
179                // C doesn't allow variable sized arrays at global scope or for static variables, so don't hoist dimension.
180                if ( ! inFunction ) return;
181                if ( storageClasses.is_static ) return;
182
183                if ( ArrayType * arrayType = dynamic_cast< ArrayType * >( type ) ) {
184                        if ( ! arrayType->get_dimension() ) return; // xxx - recursive call to hoist?
185
186                        // need to resolve array dimensions in order to accurately determine if constexpr
187                        ResolvExpr::findSingleExpression( arrayType->dimension, SymTab::SizeType->clone(), indexer );
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                        declsToAddBefore.push_back( arrayDimension );
196
197                        hoist( arrayType->get_base() );
198                        return;
199                }
200        }
201
202        void HoistArrayDimension::premutate( FunctionDecl * ) {
203                GuardValue( inFunction );
204                inFunction = true;
205        }
206
207        void CtorDtor::generateCtorDtor( std::list< Declaration * > & translationUnit ) {
208                PassVisitor<CtorDtor> ctordtor;
209                acceptAll( translationUnit, ctordtor );
210        }
211
212        bool ManagedTypes::isManaged( Type * type ) const {
213                // references are never constructed
214                if ( dynamic_cast< ReferenceType * >( type ) ) return false;
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->types.begin(), tupleType->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::mangleConcrete( type ) ) != managedTypes.end() || GenPoly::isPolyType( type );
226        }
227
228        bool ManagedTypes::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 ManagedTypes::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() ) && CodeGen::isCtorDtor( dwt->get_name() ) ) {
239                        std::list< DeclarationWithType * > & params = GenPoly::getFunctionType( dwt->get_type() )->get_parameters();
240                        assert( ! params.empty() );
241                        Type * type = InitTweak::getPointerBase( params.front()->get_type() );
242                        assert( type );
243                        managedTypes.insert( SymTab::Mangler::mangleConcrete( type ) );
244                }
245        }
246
247        void ManagedTypes::handleStruct( StructDecl * aggregateDecl ) {
248                // don't construct members, but need to take note if there is a managed member,
249                // because that means that this type is also managed
250                for ( Declaration * member : aggregateDecl->get_members() ) {
251                        if ( ObjectDecl * field = dynamic_cast< ObjectDecl * >( member ) ) {
252                                if ( isManaged( field ) ) {
253                                        // generic parameters should not play a role in determining whether a generic type is constructed - construct all generic types, so that
254                                        // polymorphic constructors make generic types managed types
255                                        StructInstType inst( Type::Qualifiers(), aggregateDecl );
256                                        managedTypes.insert( SymTab::Mangler::mangleConcrete( &inst ) );
257                                        break;
258                                }
259                        }
260                }
261        }
262
263        void ManagedTypes::beginScope() { managedTypes.beginScope(); }
264        void ManagedTypes::endScope() { managedTypes.endScope(); }
265
266        ImplicitCtorDtorStmt * genCtorDtor( const std::string & fname, ObjectDecl * objDecl, Expression * arg ) {
267                // call into genImplicitCall from Autogen.h to generate calls to ctor/dtor
268                assertf( objDecl, "genCtorDtor passed null objDecl" );
269                std::list< Statement * > stmts;
270                InitExpander srcParam( maybeClone( arg ) );
271                SymTab::genImplicitCall( srcParam, new VariableExpr( objDecl ), fname, back_inserter( stmts ), objDecl );
272                assert( stmts.size() <= 1 );
273                return stmts.size() == 1 ? strict_dynamic_cast< ImplicitCtorDtorStmt * >( stmts.front() ) : nullptr;
274        }
275
276        ConstructorInit * genCtorInit( ObjectDecl * objDecl ) {
277                // call into genImplicitCall from Autogen.h to generate calls to ctor/dtor
278                // for each constructable object
279                std::list< Statement * > ctor;
280                std::list< Statement * > dtor;
281
282                InitExpander srcParam( objDecl->get_init() );
283                InitExpander nullParam( (Initializer *)NULL );
284                SymTab::genImplicitCall( srcParam, new VariableExpr( objDecl ), "?{}", back_inserter( ctor ), objDecl );
285                SymTab::genImplicitCall( nullParam, new VariableExpr( objDecl ), "^?{}", front_inserter( dtor ), objDecl, false );
286
287                // Currently genImplicitCall produces a single Statement - a CompoundStmt
288                // which  wraps everything that needs to happen. As such, it's technically
289                // possible to use a Statement ** in the above calls, but this is inherently
290                // unsafe, so instead we take the slightly less efficient route, but will be
291                // immediately informed if somehow the above assumption is broken. In this case,
292                // we could always wrap the list of statements at this point with a CompoundStmt,
293                // but it seems reasonable at the moment for this to be done by genImplicitCall
294                // itself. It is possible that genImplicitCall produces no statements (e.g. if
295                // an array type does not have a dimension). In this case, it's fine to ignore
296                // the object for the purposes of construction.
297                assert( ctor.size() == dtor.size() && ctor.size() <= 1 );
298                if ( ctor.size() == 1 ) {
299                        // need to remember init expression, in case no ctors exist
300                        // if ctor does exist, want to use ctor expression instead of init
301                        // push this decision to the resolver
302                        assert( dynamic_cast< ImplicitCtorDtorStmt * > ( ctor.front() ) && dynamic_cast< ImplicitCtorDtorStmt * > ( dtor.front() ) );
303                        return new ConstructorInit( ctor.front(), dtor.front(), objDecl->get_init() );
304                }
305                return nullptr;
306        }
307
308        void CtorDtor::previsit( ObjectDecl * objDecl ) {
309                managedTypes.handleDWT( objDecl );
310                // hands off if @=, extern, builtin, etc.
311                // even if unmanaged, try to construct global or static if initializer is not constexpr, since this is not legal C
312                if ( tryConstruct( objDecl ) && ( managedTypes.isManaged( objDecl ) || ((! inFunction || objDecl->get_storageClasses().is_static ) && ! isConstExpr( objDecl->get_init() ) ) ) ) {
313                        // constructed objects cannot be designated
314                        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 );
315                        // constructed objects should not have initializers nested too deeply
316                        if ( ! checkInitDepth( objDecl ) ) throw SemanticError( "Managed object's initializer is too deep ", objDecl );
317
318                        objDecl->set_init( genCtorInit( objDecl ) );
319                }
320        }
321
322        void CtorDtor::previsit( FunctionDecl *functionDecl ) {
323                visit_children = false;  // do not try and construct parameters or forall parameters
324                GuardValue( inFunction );
325                inFunction = true;
326
327                managedTypes.handleDWT( functionDecl );
328
329                GuardScope( managedTypes );
330                // go through assertions and recursively add seen ctor/dtors
331                for ( auto & tyDecl : functionDecl->get_functionType()->get_forall() ) {
332                        for ( DeclarationWithType *& assertion : tyDecl->get_assertions() ) {
333                                managedTypes.handleDWT( assertion );
334                        }
335                }
336
337                maybeAccept( functionDecl->get_statements(), *visitor );
338        }
339
340        void CtorDtor::previsit( StructDecl *aggregateDecl ) {
341                visit_children = false; // do not try to construct and destruct aggregate members
342
343                managedTypes.handleStruct( aggregateDecl );
344        }
345
346        void CtorDtor::previsit( CompoundStmt * ) {
347                GuardScope( managedTypes );
348        }
349} // namespace InitTweak
350
351// Local Variables: //
352// tab-width: 4 //
353// mode: c++ //
354// compile-command: "make install" //
355// End: //
Note: See TracBrowser for help on using the repository browser.