source: src/InitTweak/GenInit.cc @ 029e330

ADTarm-ehast-experimentalcleanup-dtorsenumforall-pointer-decayjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-exprpthread-emulationqualifiedEnum
Last change on this file since 029e330 was 2bfc6b2, checked in by Rob Schluntz <rschlunt@…>, 6 years ago

Refactor FindSpecialDeclarations? and associated special declarations

  • Property mode set to 100644
File size: 16.1 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
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#include "Tuples/Tuples.h"             // for maybeImpure
44#include "Validate/FindSpecialDecls.h" // for SizeType
45
46namespace InitTweak {
47        namespace {
48                const std::list<Label> noLabels;
49                const std::list<Expression *> noDesignators;
50        }
51
52        struct ReturnFixer : public WithStmtsToAdd, public WithGuards {
53                /// consistently allocates a temporary variable for the return value
54                /// of a function so that anything which the resolver decides can be constructed
55                /// into the return type of a function can be returned.
56                static void makeReturnTemp( std::list< Declaration * > &translationUnit );
57
58                void premutate( FunctionDecl *functionDecl );
59                void premutate( ReturnStmt * returnStmt );
60
61          protected:
62                FunctionType * ftype = nullptr;
63                std::string funcName;
64        };
65
66        struct CtorDtor : public WithGuards, public WithShortCircuiting, public WithVisitorRef<CtorDtor>  {
67                /// create constructor and destructor statements for object declarations.
68                /// the actual call statements will be added in after the resolver has run
69                /// so that the initializer expression is only removed if a constructor is found
70                /// and the same destructor call is inserted in all of the appropriate locations.
71                static void generateCtorDtor( std::list< Declaration * > &translationUnit );
72
73                void previsit( ObjectDecl * );
74                void previsit( FunctionDecl *functionDecl );
75
76                // should not traverse into any of these declarations to find objects
77                // that need to be constructed or destructed
78                void previsit( StructDecl *aggregateDecl );
79                void previsit( AggregateDecl * ) { visit_children = false; }
80                void previsit( NamedTypeDecl * ) { visit_children = false; }
81                void previsit( FunctionType * ) { visit_children = false; }
82
83                void previsit( CompoundStmt * compoundStmt );
84
85          private:
86                // set of mangled type names for which a constructor or destructor exists in the current scope.
87                // these types require a ConstructorInit node to be generated, anything else is a POD type and thus
88                // should not have a ConstructorInit generated.
89
90                ManagedTypes managedTypes;
91                bool inFunction = false;
92        };
93
94        struct HoistArrayDimension final : public WithDeclsToAdd, public WithShortCircuiting, public WithGuards, public WithIndexer {
95                /// hoist dimension from array types in object declaration so that it uses a single
96                /// const variable of type size_t, so that side effecting array dimensions are only
97                /// computed once.
98                static void hoistArrayDimension( std::list< Declaration * > & translationUnit );
99
100                void premutate( ObjectDecl * objectDecl );
101                DeclarationWithType * postmutate( ObjectDecl * objectDecl );
102                void premutate( FunctionDecl *functionDecl );
103                // should not traverse into any of these declarations to find objects
104                // that need to be constructed or destructed
105                void premutate( AggregateDecl * ) { visit_children = false; }
106                void premutate( NamedTypeDecl * ) { visit_children = false; }
107                void premutate( FunctionType * ) { visit_children = false; }
108
109                // need this so that enumerators are added to the indexer, due to premutate(AggregateDecl *)
110                void premutate( EnumDecl * ) {}
111
112                void hoist( Type * type );
113
114                Type::StorageClasses storageClasses;
115                bool inFunction = false;
116        };
117
118        void genInit( std::list< Declaration * > & translationUnit ) {
119                fixReturnStatements( translationUnit );
120                HoistArrayDimension::hoistArrayDimension( translationUnit );
121                CtorDtor::generateCtorDtor( translationUnit );
122        }
123
124        void fixReturnStatements( std::list< Declaration * > & translationUnit ) {
125                PassVisitor<ReturnFixer> fixer;
126                mutateAll( translationUnit, fixer );
127        }
128
129        void ReturnFixer::premutate( ReturnStmt *returnStmt ) {
130                std::list< DeclarationWithType * > & returnVals = ftype->get_returnVals();
131                assert( returnVals.size() == 0 || returnVals.size() == 1 );
132                // hands off if the function returns a reference - we don't want to allocate a temporary if a variable's address
133                // is being returned
134                if ( returnStmt->expr && returnVals.size() == 1 && isConstructable( returnVals.front()->get_type() ) ) {
135                        // explicitly construct the return value using the return expression and the retVal object
136                        assertf( returnVals.front()->name != "", "Function %s has unnamed return value\n", funcName.c_str() );
137
138                        ObjectDecl * retVal = strict_dynamic_cast< ObjectDecl * >( returnVals.front() );
139                        if ( VariableExpr * varExpr = dynamic_cast< VariableExpr * >( returnStmt->expr ) ) {
140                                // return statement has already been mutated - don't need to do it again
141                                if ( varExpr->var == retVal ) return;
142                        }
143                        Statement * stmt = genCtorDtor( "?{}", retVal, returnStmt->expr );
144                        assertf( stmt, "ReturnFixer: genCtorDtor returned nullptr: %s / %s", toString( retVal ).c_str(), toString( returnStmt->expr ).c_str() );
145                        stmtsToAddBefore.push_back( stmt );
146
147                        // return the retVal object
148                        returnStmt->expr = new VariableExpr( returnVals.front() );
149                } // if
150        }
151
152        void ReturnFixer::premutate( FunctionDecl *functionDecl ) {
153                GuardValue( ftype );
154                GuardValue( funcName );
155
156                ftype = functionDecl->type;
157                funcName = functionDecl->name;
158        }
159
160        // precompute array dimension expression, because constructor generation may duplicate it,
161        // which would be incorrect if it is a side-effecting computation.
162        void HoistArrayDimension::hoistArrayDimension( std::list< Declaration * > & translationUnit ) {
163                PassVisitor<HoistArrayDimension> hoister;
164                mutateAll( translationUnit, hoister );
165        }
166
167        void HoistArrayDimension::premutate( ObjectDecl * objectDecl ) {
168                GuardValue( storageClasses );
169                storageClasses = objectDecl->get_storageClasses();
170        }
171
172        DeclarationWithType * HoistArrayDimension::postmutate( ObjectDecl * objectDecl ) {
173                hoist( objectDecl->get_type() );
174                return objectDecl;
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                        // need to resolve array dimensions in order to accurately determine if constexpr
189                        ResolvExpr::findSingleExpression( arrayType->dimension, Validate::SizeType->clone(), indexer );
190                        // array is variable-length when the dimension is not constexpr
191                        arrayType->isVarLen = ! isConstExpr( arrayType->dimension );
192                        // don't need to hoist dimension if it's definitely pure - only need to if there's potential for side effects.
193                        if ( ! Tuples::maybeImpure( arrayType->dimension ) ) return;
194
195                        ObjectDecl * arrayDimension = new ObjectDecl( dimensionName.newName(), storageClasses, LinkageSpec::C, 0, Validate::SizeType->clone(), new SingleInit( arrayType->get_dimension() ) );
196                        arrayDimension->get_type()->set_const( true );
197
198                        arrayType->set_dimension( new VariableExpr( arrayDimension ) );
199                        declsToAddBefore.push_back( arrayDimension );
200
201                        hoist( arrayType->get_base() );
202                        return;
203                }
204        }
205
206        void HoistArrayDimension::premutate( FunctionDecl * ) {
207                GuardValue( inFunction );
208                inFunction = true;
209        }
210
211        void CtorDtor::generateCtorDtor( std::list< Declaration * > & translationUnit ) {
212                PassVisitor<CtorDtor> ctordtor;
213                acceptAll( translationUnit, ctordtor );
214        }
215
216        bool ManagedTypes::isManaged( Type * type ) const {
217                // references are never constructed
218                if ( dynamic_cast< ReferenceType * >( type ) ) return false;
219                // need to clear and reset qualifiers when determining if a type is managed
220                ValueGuard< Type::Qualifiers > qualifiers( type->get_qualifiers() );
221                type->get_qualifiers() = Type::Qualifiers();
222                if ( TupleType * tupleType = dynamic_cast< TupleType * > ( type ) ) {
223                        // tuple is also managed if any of its components are managed
224                        if ( std::any_of( tupleType->types.begin(), tupleType->types.end(), [&](Type * type) { return isManaged( type ); }) ) {
225                                return true;
226                        }
227                }
228                // 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)
229                return managedTypes.find( SymTab::Mangler::mangleConcrete( type ) ) != managedTypes.end() || GenPoly::isPolyType( type );
230        }
231
232        bool ManagedTypes::isManaged( ObjectDecl * objDecl ) const {
233                Type * type = objDecl->get_type();
234                while ( ArrayType * at = dynamic_cast< ArrayType * >( type ) ) {
235                        // must always construct VLAs with an initializer, since this is an error in C
236                        if ( at->isVarLen && objDecl->init ) return true;
237                        type = at->get_base();
238                }
239                return isManaged( type );
240        }
241
242        void ManagedTypes::handleDWT( DeclarationWithType * dwt ) {
243                // if this function is a user-defined constructor or destructor, mark down the type as "managed"
244                if ( ! LinkageSpec::isOverridable( dwt->get_linkage() ) && CodeGen::isCtorDtor( dwt->get_name() ) ) {
245                        std::list< DeclarationWithType * > & params = GenPoly::getFunctionType( dwt->get_type() )->get_parameters();
246                        assert( ! params.empty() );
247                        Type * type = InitTweak::getPointerBase( params.front()->get_type() );
248                        assert( type );
249                        managedTypes.insert( SymTab::Mangler::mangleConcrete( type ) );
250                }
251        }
252
253        void ManagedTypes::handleStruct( StructDecl * aggregateDecl ) {
254                // don't construct members, but need to take note if there is a managed member,
255                // because that means that this type is also managed
256                for ( Declaration * member : aggregateDecl->get_members() ) {
257                        if ( ObjectDecl * field = dynamic_cast< ObjectDecl * >( member ) ) {
258                                if ( isManaged( field ) ) {
259                                        // generic parameters should not play a role in determining whether a generic type is constructed - construct all generic types, so that
260                                        // polymorphic constructors make generic types managed types
261                                        StructInstType inst( Type::Qualifiers(), aggregateDecl );
262                                        managedTypes.insert( SymTab::Mangler::mangleConcrete( &inst ) );
263                                        break;
264                                }
265                        }
266                }
267        }
268
269        void ManagedTypes::beginScope() { managedTypes.beginScope(); }
270        void ManagedTypes::endScope() { managedTypes.endScope(); }
271
272        ImplicitCtorDtorStmt * genCtorDtor( const std::string & fname, ObjectDecl * objDecl, Expression * arg ) {
273                // call into genImplicitCall from Autogen.h to generate calls to ctor/dtor
274                assertf( objDecl, "genCtorDtor passed null objDecl" );
275                std::list< Statement * > stmts;
276                InitExpander srcParam( maybeClone( arg ) );
277                SymTab::genImplicitCall( srcParam, new VariableExpr( objDecl ), fname, back_inserter( stmts ), objDecl );
278                assert( stmts.size() <= 1 );
279                return stmts.size() == 1 ? strict_dynamic_cast< ImplicitCtorDtorStmt * >( stmts.front() ) : nullptr;
280        }
281
282        ConstructorInit * genCtorInit( ObjectDecl * objDecl ) {
283                // call into genImplicitCall from Autogen.h to generate calls to ctor/dtor
284                // for each constructable object
285                std::list< Statement * > ctor;
286                std::list< Statement * > dtor;
287
288                InitExpander srcParam( objDecl->get_init() );
289                InitExpander nullParam( (Initializer *)NULL );
290                SymTab::genImplicitCall( srcParam, new VariableExpr( objDecl ), "?{}", back_inserter( ctor ), objDecl );
291                SymTab::genImplicitCall( nullParam, new VariableExpr( objDecl ), "^?{}", front_inserter( dtor ), objDecl, false );
292
293                // Currently genImplicitCall produces a single Statement - a CompoundStmt
294                // which  wraps everything that needs to happen. As such, it's technically
295                // possible to use a Statement ** in the above calls, but this is inherently
296                // unsafe, so instead we take the slightly less efficient route, but will be
297                // immediately informed if somehow the above assumption is broken. In this case,
298                // we could always wrap the list of statements at this point with a CompoundStmt,
299                // but it seems reasonable at the moment for this to be done by genImplicitCall
300                // itself. It is possible that genImplicitCall produces no statements (e.g. if
301                // an array type does not have a dimension). In this case, it's fine to ignore
302                // the object for the purposes of construction.
303                assert( ctor.size() == dtor.size() && ctor.size() <= 1 );
304                if ( ctor.size() == 1 ) {
305                        // need to remember init expression, in case no ctors exist
306                        // if ctor does exist, want to use ctor expression instead of init
307                        // push this decision to the resolver
308                        assert( dynamic_cast< ImplicitCtorDtorStmt * > ( ctor.front() ) && dynamic_cast< ImplicitCtorDtorStmt * > ( dtor.front() ) );
309                        return new ConstructorInit( ctor.front(), dtor.front(), objDecl->get_init() );
310                }
311                return nullptr;
312        }
313
314        void CtorDtor::previsit( ObjectDecl * objDecl ) {
315                managedTypes.handleDWT( objDecl );
316                // hands off if @=, extern, builtin, etc.
317                // even if unmanaged, try to construct global or static if initializer is not constexpr, since this is not legal C
318                if ( tryConstruct( objDecl ) && ( managedTypes.isManaged( objDecl ) || ((! inFunction || objDecl->get_storageClasses().is_static ) && ! isConstExpr( objDecl->get_init() ) ) ) ) {
319                        // constructed objects cannot be designated
320                        if ( isDesignated( objDecl->get_init() ) ) SemanticError( objDecl, "Cannot include designations in the initializer for a managed Object. If this is really what you want, then initialize with @=.\n" );
321                        // constructed objects should not have initializers nested too deeply
322                        if ( ! checkInitDepth( objDecl ) ) SemanticError( objDecl, "Managed object's initializer is too deep " );
323
324                        objDecl->set_init( genCtorInit( objDecl ) );
325                }
326        }
327
328        void CtorDtor::previsit( FunctionDecl *functionDecl ) {
329                visit_children = false;  // do not try and construct parameters or forall parameters
330                GuardValue( inFunction );
331                inFunction = true;
332
333                managedTypes.handleDWT( functionDecl );
334
335                GuardScope( managedTypes );
336                // go through assertions and recursively add seen ctor/dtors
337                for ( auto & tyDecl : functionDecl->get_functionType()->get_forall() ) {
338                        for ( DeclarationWithType *& assertion : tyDecl->get_assertions() ) {
339                                managedTypes.handleDWT( assertion );
340                        }
341                }
342
343                maybeAccept( functionDecl->get_statements(), *visitor );
344        }
345
346        void CtorDtor::previsit( StructDecl *aggregateDecl ) {
347                visit_children = false; // do not try to construct and destruct aggregate members
348
349                managedTypes.handleStruct( aggregateDecl );
350        }
351
352        void CtorDtor::previsit( CompoundStmt * ) {
353                GuardScope( managedTypes );
354        }
355} // namespace InitTweak
356
357// Local Variables: //
358// tab-width: 4 //
359// mode: c++ //
360// compile-command: "make install" //
361// End: //
Note: See TracBrowser for help on using the repository browser.