source: src/InitTweak/GenInit.cc @ 9fe33947

ADTaaron-thesisarm-ehast-experimentalcleanup-dtorsdeferred_resndemanglerenumforall-pointer-decayjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-exprnew-envno_listpersistent-indexerpthread-emulationqualifiedEnumresolv-newwith_gc
Last change on this file since 9fe33947 was 9fe33947, checked in by Rob Schluntz <rschlunt@…>, 7 years ago

Minor code cleanup

  • Property mode set to 100644
File size: 15.3 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 "SymTab/Autogen.h"        // for genImplicitCall, SizeType
33#include "SymTab/Mangler.h"        // for Mangler
34#include "SynTree/Declaration.h"   // for ObjectDecl, DeclarationWithType
35#include "SynTree/Expression.h"    // for VariableExpr, UntypedExpr, Address...
36#include "SynTree/Initializer.h"   // for ConstructorInit, SingleInit, Initi...
37#include "SynTree/Label.h"         // for Label
38#include "SynTree/Mutator.h"       // for mutateAll
39#include "SynTree/Statement.h"     // for CompoundStmt, ImplicitCtorDtorStmt
40#include "SynTree/Type.h"          // for Type, ArrayType, Type::Qualifiers
41#include "SynTree/Visitor.h"       // for acceptAll, maybeAccept
42
43namespace InitTweak {
44        namespace {
45                const std::list<Label> noLabels;
46                const std::list<Expression *> noDesignators;
47        }
48
49        struct ReturnFixer : public WithStmtsToAdd, public WithGuards {
50                /// consistently allocates a temporary variable for the return value
51                /// of a function so that anything which the resolver decides can be constructed
52                /// into the return type of a function can be returned.
53                static void makeReturnTemp( std::list< Declaration * > &translationUnit );
54
55                void premutate( FunctionDecl *functionDecl );
56                void premutate( ReturnStmt * returnStmt );
57
58          protected:
59                FunctionType * ftype = nullptr;
60                std::string funcName;
61        };
62
63        struct CtorDtor : public WithGuards, public WithShortCircuiting, public WithVisitorRef<CtorDtor>  {
64                /// create constructor and destructor statements for object declarations.
65                /// the actual call statements will be added in after the resolver has run
66                /// so that the initializer expression is only removed if a constructor is found
67                /// and the same destructor call is inserted in all of the appropriate locations.
68                static void generateCtorDtor( std::list< Declaration * > &translationUnit );
69
70                void previsit( ObjectDecl * );
71                void previsit( FunctionDecl *functionDecl );
72
73                // should not traverse into any of these declarations to find objects
74                // that need to be constructed or destructed
75                void previsit( StructDecl *aggregateDecl );
76                void previsit( AggregateDecl * ) { visit_children = false; }
77                void previsit( NamedTypeDecl * ) { visit_children = false; }
78                void previsit( FunctionType * ) { visit_children = false; }
79
80                void previsit( CompoundStmt * compoundStmt );
81
82          private:
83                // set of mangled type names for which a constructor or destructor exists in the current scope.
84                // these types require a ConstructorInit node to be generated, anything else is a POD type and thus
85                // should not have a ConstructorInit generated.
86
87                ManagedTypes managedTypes;
88                bool inFunction = false;
89        };
90
91        struct HoistArrayDimension final : public WithDeclsToAdd, public WithShortCircuiting, public WithGuards {
92                /// hoist dimension from array types in object declaration so that it uses a single
93                /// const variable of type size_t, so that side effecting array dimensions are only
94                /// computed once.
95                static void hoistArrayDimension( std::list< Declaration * > & translationUnit );
96
97                void premutate( ObjectDecl * objectDecl );
98                DeclarationWithType * postmutate( ObjectDecl * objectDecl );
99                void premutate( FunctionDecl *functionDecl );
100                // should not traverse into any of these declarations to find objects
101                // that need to be constructed or destructed
102                void premutate( AggregateDecl * ) { visit_children = false; }
103                void premutate( NamedTypeDecl * ) { visit_children = false; }
104                void premutate( FunctionType * ) { visit_children = false; }
105
106                void hoist( Type * type );
107
108                Type::StorageClasses storageClasses;
109                bool inFunction = false;
110        };
111
112        void genInit( std::list< Declaration * > & translationUnit ) {
113                fixReturnStatements( translationUnit );
114                HoistArrayDimension::hoistArrayDimension( translationUnit );
115                CtorDtor::generateCtorDtor( translationUnit );
116        }
117
118        void fixReturnStatements( std::list< Declaration * > & translationUnit ) {
119                PassVisitor<ReturnFixer> fixer;
120                mutateAll( translationUnit, fixer );
121        }
122
123        void ReturnFixer::premutate( ReturnStmt *returnStmt ) {
124                std::list< DeclarationWithType * > & returnVals = ftype->get_returnVals();
125                assert( returnVals.size() == 0 || returnVals.size() == 1 );
126                // hands off if the function returns a reference - we don't want to allocate a temporary if a variable's address
127                // is being returned
128                if ( returnStmt->expr && returnVals.size() == 1 && isConstructable( returnVals.front()->get_type() ) ) {
129                        // explicitly construct the return value using the return expression and the retVal object
130                        assertf( returnVals.front()->name != "", "Function %s has unnamed return value\n", funcName.c_str() );
131
132                        ObjectDecl * retVal = strict_dynamic_cast< ObjectDecl * >( returnVals.front() );
133                        if ( VariableExpr * varExpr = dynamic_cast< VariableExpr * >( returnStmt->expr ) ) {
134                                // return statement has already been mutated - don't need to do it again
135                                if ( varExpr->var == retVal ) return;
136                        }
137                        Statement * stmt = genCtorDtor( "?{}", retVal, returnStmt->expr );
138                        assertf( stmt, "ReturnFixer: genCtorDtor returned nullptr: %s / %s", toString( retVal ).c_str(), toString( returnStmt->expr ).c_str() );
139                        stmtsToAddBefore.push_back( stmt );
140
141                        // return the retVal object
142                        returnStmt->expr = new VariableExpr( returnVals.front() );
143                } // if
144        }
145
146        void ReturnFixer::premutate( FunctionDecl *functionDecl ) {
147                GuardValue( ftype );
148                GuardValue( funcName );
149
150                ftype = functionDecl->type;
151                funcName = functionDecl->name;
152        }
153
154        // precompute array dimension expression, because constructor generation may duplicate it,
155        // which would be incorrect if it is a side-effecting computation.
156        void HoistArrayDimension::hoistArrayDimension( std::list< Declaration * > & translationUnit ) {
157                PassVisitor<HoistArrayDimension> hoister;
158                mutateAll( translationUnit, hoister );
159        }
160
161        void HoistArrayDimension::premutate( ObjectDecl * objectDecl ) {
162                GuardValue( storageClasses );
163                storageClasses = objectDecl->get_storageClasses();
164        }
165
166        DeclarationWithType * HoistArrayDimension::postmutate( ObjectDecl * objectDecl ) {
167                hoist( objectDecl->get_type() );
168                return objectDecl;
169        }
170
171        void HoistArrayDimension::hoist( Type * type ) {
172                // if in function, generate const size_t var
173                static UniqueName dimensionName( "_array_dim" );
174
175                // C doesn't allow variable sized arrays at global scope or for static variables, so don't hoist dimension.
176                if ( ! inFunction ) return;
177                if ( storageClasses.is_static ) return;
178
179                if ( ArrayType * arrayType = dynamic_cast< ArrayType * >( type ) ) {
180                        if ( ! arrayType->get_dimension() ) return; // xxx - recursive call to hoist?
181
182                        // don't need to hoist dimension if it's a constexpr - only need to if there's potential for side effects.
183                        if ( isConstExpr( arrayType->get_dimension() ) ) return;
184
185                        ObjectDecl * arrayDimension = new ObjectDecl( dimensionName.newName(), storageClasses, LinkageSpec::C, 0, SymTab::SizeType->clone(), new SingleInit( arrayType->get_dimension() ) );
186                        arrayDimension->get_type()->set_const( true );
187
188                        arrayType->set_dimension( new VariableExpr( arrayDimension ) );
189                        declsToAddBefore.push_back( arrayDimension );
190
191                        hoist( arrayType->get_base() );
192                        return;
193                }
194        }
195
196        void HoistArrayDimension::premutate( FunctionDecl * ) {
197                GuardValue( inFunction );
198        }
199
200        void CtorDtor::generateCtorDtor( std::list< Declaration * > & translationUnit ) {
201                PassVisitor<CtorDtor> ctordtor;
202                acceptAll( translationUnit, ctordtor );
203        }
204
205        bool ManagedTypes::isManaged( Type * type ) const {
206                // references are never constructed
207                if ( dynamic_cast< ReferenceType * >( type ) ) return false;
208                // need to clear and reset qualifiers when determining if a type is managed
209                ValueGuard< Type::Qualifiers > qualifiers( type->get_qualifiers() );
210                type->get_qualifiers() = Type::Qualifiers();
211                if ( TupleType * tupleType = dynamic_cast< TupleType * > ( type ) ) {
212                        // tuple is also managed if any of its components are managed
213                        if ( std::any_of( tupleType->types.begin(), tupleType->types.end(), [&](Type * type) { return isManaged( type ); }) ) {
214                                return true;
215                        }
216                }
217                // 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)
218                return managedTypes.find( SymTab::Mangler::mangleConcrete( type ) ) != managedTypes.end() || GenPoly::isPolyType( type );
219        }
220
221        bool ManagedTypes::isManaged( ObjectDecl * objDecl ) const {
222                Type * type = objDecl->get_type();
223                while ( ArrayType * at = dynamic_cast< ArrayType * >( type ) ) {
224                        type = at->get_base();
225                }
226                return isManaged( type );
227        }
228
229        void ManagedTypes::handleDWT( DeclarationWithType * dwt ) {
230                // if this function is a user-defined constructor or destructor, mark down the type as "managed"
231                if ( ! LinkageSpec::isOverridable( dwt->get_linkage() ) && CodeGen::isCtorDtor( dwt->get_name() ) ) {
232                        std::list< DeclarationWithType * > & params = GenPoly::getFunctionType( dwt->get_type() )->get_parameters();
233                        assert( ! params.empty() );
234                        Type * type = InitTweak::getPointerBase( params.front()->get_type() );
235                        assert( type );
236                        managedTypes.insert( SymTab::Mangler::mangleConcrete( type ) );
237                }
238        }
239
240        void ManagedTypes::handleStruct( StructDecl * aggregateDecl ) {
241                // don't construct members, but need to take note if there is a managed member,
242                // because that means that this type is also managed
243                for ( Declaration * member : aggregateDecl->get_members() ) {
244                        if ( ObjectDecl * field = dynamic_cast< ObjectDecl * >( member ) ) {
245                                if ( isManaged( field ) ) {
246                                        // generic parameters should not play a role in determining whether a generic type is constructed - construct all generic types, so that
247                                        // polymorphic constructors make generic types managed types
248                                        StructInstType inst( Type::Qualifiers(), aggregateDecl );
249                                        managedTypes.insert( SymTab::Mangler::mangleConcrete( &inst ) );
250                                        break;
251                                }
252                        }
253                }
254        }
255
256        void ManagedTypes::beginScope() { managedTypes.beginScope(); }
257        void ManagedTypes::endScope() { managedTypes.endScope(); }
258
259        ImplicitCtorDtorStmt * genCtorDtor( const std::string & fname, ObjectDecl * objDecl, Expression * arg ) {
260                // call into genImplicitCall from Autogen.h to generate calls to ctor/dtor
261                assertf( objDecl, "genCtorDtor passed null objDecl" );
262                std::list< Statement * > stmts;
263                InitExpander srcParam( maybeClone( arg ) );
264                SymTab::genImplicitCall( srcParam, new VariableExpr( objDecl ), fname, back_inserter( stmts ), objDecl );
265                assert( stmts.size() <= 1 );
266                return stmts.size() == 1 ? strict_dynamic_cast< ImplicitCtorDtorStmt * >( stmts.front() ) : nullptr;
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        void CtorDtor::previsit( ObjectDecl * objDecl ) {
302                managedTypes.handleDWT( objDecl );
303                // hands off if @=, extern, builtin, etc.
304                // even if unmanaged, try to construct global or static if initializer is not constexpr, since this is not legal C
305                if ( tryConstruct( objDecl ) && ( managedTypes.isManaged( objDecl ) || ((! inFunction || objDecl->get_storageClasses().is_static ) && ! 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 @=.\n", 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        }
314
315        void CtorDtor::previsit( FunctionDecl *functionDecl ) {
316                visit_children = false;  // do not try and construct parameters or forall parameters
317                GuardValue( inFunction );
318                inFunction = true;
319
320                managedTypes.handleDWT( functionDecl );
321
322                GuardScope( managedTypes );
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                                managedTypes.handleDWT( assertion );
327                        }
328                }
329
330                maybeAccept( functionDecl->get_statements(), *visitor );
331        }
332
333        void CtorDtor::previsit( StructDecl *aggregateDecl ) {
334                visit_children = false; // do not try to construct and destruct aggregate members
335
336                managedTypes.handleStruct( aggregateDecl );
337        }
338
339        void CtorDtor::previsit( CompoundStmt * ) {
340                GuardScope( managedTypes );
341        }
342} // namespace InitTweak
343
344// Local Variables: //
345// tab-width: 4 //
346// mode: c++ //
347// compile-command: "make install" //
348// End: //
Note: See TracBrowser for help on using the repository browser.