source: src/InitTweak/GenInit.cc @ d67cdb7

aaron-thesisarm-ehcleanup-dtorsdeferred_resndemanglerjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-exprnew-envno_listpersistent-indexerresolv-newwith_gc
Last change on this file since d67cdb7 was d67cdb7, checked in by Peter A. Buhr <pabuhr@…>, 4 years ago

merge

  • Property mode set to 100644
File size: 14.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 : 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                bool isManaged( ObjectDecl * objDecl ) const ; // determine if object is managed
88                bool isManaged( Type * type ) const; // determine if type is managed
89                void handleDWT( DeclarationWithType * dwt ); // add type to managed if ctor/dtor
90                GenPoly::ScopedSet< std::string > managedTypes;
91                bool inFunction = false;
92        };
93
94        struct HoistArrayDimension final : public WithDeclsToAdd, public WithShortCircuiting, public WithGuards {
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                void hoist( Type * type );
110
111                Type::StorageClasses storageClasses;
112                bool inFunction = false;
113        };
114
115        void genInit( std::list< Declaration * > & translationUnit ) {
116                fixReturnStatements( translationUnit );
117                HoistArrayDimension::hoistArrayDimension( translationUnit );
118                CtorDtor::generateCtorDtor( translationUnit );
119        }
120
121        void fixReturnStatements( std::list< Declaration * > & translationUnit ) {
122                PassVisitor<ReturnFixer> fixer;
123                mutateAll( translationUnit, fixer );
124        }
125
126        void ReturnFixer::premutate( ReturnStmt *returnStmt ) {
127                std::list< DeclarationWithType * > & returnVals = ftype->get_returnVals();
128                assert( returnVals.size() == 0 || returnVals.size() == 1 );
129                // hands off if the function returns a reference - we don't want to allocate a temporary if a variable's address
130                // is being returned
131                if ( returnStmt->get_expr() && returnVals.size() == 1 && isConstructable( returnVals.front()->get_type() ) ) {
132                        // explicitly construct the return value using the return expression and the retVal object
133                        assertf( returnVals.front()->get_name() != "", "Function %s has unnamed return value\n", funcName.c_str() );
134
135                        stmtsToAddBefore.push_back( genCtorDtor( "?{}", dynamic_cast< ObjectDecl *>( returnVals.front() ), returnStmt->get_expr() ) );
136
137                        // return the retVal object
138                        returnStmt->set_expr( new VariableExpr( returnVals.front() ) );
139                } // if
140        }
141
142        void ReturnFixer::premutate( FunctionDecl *functionDecl ) {
143                GuardValue( ftype );
144                GuardValue( funcName );
145
146                ftype = functionDecl->type;
147                funcName = functionDecl->name;
148        }
149
150        // precompute array dimension expression, because constructor generation may duplicate it,
151        // which would be incorrect if it is a side-effecting computation.
152        void HoistArrayDimension::hoistArrayDimension( std::list< Declaration * > & translationUnit ) {
153                PassVisitor<HoistArrayDimension> hoister;
154                mutateAll( translationUnit, hoister );
155        }
156
157        void HoistArrayDimension::premutate( ObjectDecl * objectDecl ) {
158                GuardValue( storageClasses );
159                storageClasses = objectDecl->get_storageClasses();
160        }
161
162        DeclarationWithType * HoistArrayDimension::postmutate( ObjectDecl * objectDecl ) {
163                hoist( objectDecl->get_type() );
164                return objectDecl;
165        }
166
167        void HoistArrayDimension::hoist( Type * type ) {
168                // if in function, generate const size_t var
169                static UniqueName dimensionName( "_array_dim" );
170
171                // C doesn't allow variable sized arrays at global scope or for static variables, so don't hoist dimension.
172                if ( ! inFunction ) return;
173                if ( storageClasses.is_static ) return;
174
175                if ( ArrayType * arrayType = dynamic_cast< ArrayType * >( type ) ) {
176                        if ( ! arrayType->get_dimension() ) return; // xxx - recursive call to hoist?
177
178                        // don't need to hoist dimension if it's a constexpr - only need to if there's potential for side effects.
179                        if ( isConstExpr( arrayType->get_dimension() ) ) return;
180
181                        ObjectDecl * arrayDimension = new ObjectDecl( dimensionName.newName(), storageClasses, LinkageSpec::C, 0, SymTab::SizeType->clone(), new SingleInit( arrayType->get_dimension() ) );
182                        arrayDimension->get_type()->set_const( true );
183
184                        arrayType->set_dimension( new VariableExpr( arrayDimension ) );
185                        declsToAddBefore.push_back( arrayDimension );
186
187                        hoist( arrayType->get_base() );
188                        return;
189                }
190        }
191
192        void HoistArrayDimension::premutate( FunctionDecl * ) {
193                GuardValue( inFunction );
194        }
195
196        void CtorDtor::generateCtorDtor( std::list< Declaration * > & translationUnit ) {
197                PassVisitor<CtorDtor> ctordtor;
198                acceptAll( translationUnit, ctordtor );
199        }
200
201        bool CtorDtor::isManaged( Type * type ) const {
202                // references are never constructed
203                if ( dynamic_cast< ReferenceType * >( type ) ) return false;
204                // need to clear and reset qualifiers when determining if a type is managed
205                ValueGuard< Type::Qualifiers > qualifiers( type->get_qualifiers() );
206                type->get_qualifiers() = Type::Qualifiers();
207                if ( TupleType * tupleType = dynamic_cast< TupleType * > ( type ) ) {
208                        // tuple is also managed if any of its components are managed
209                        if ( std::any_of( tupleType->types.begin(), tupleType->types.end(), [&](Type * type) { return isManaged( type ); }) ) {
210                                return true;
211                        }
212                }
213                // 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)
214                return managedTypes.find( SymTab::Mangler::mangle( type ) ) != managedTypes.end() || GenPoly::isPolyType( type );
215        }
216
217        bool CtorDtor::isManaged( ObjectDecl * objDecl ) const {
218                Type * type = objDecl->get_type();
219                while ( ArrayType * at = dynamic_cast< ArrayType * >( type ) ) {
220                        type = at->get_base();
221                }
222                return isManaged( type );
223        }
224
225        void CtorDtor::handleDWT( DeclarationWithType * dwt ) {
226                // if this function is a user-defined constructor or destructor, mark down the type as "managed"
227                if ( ! LinkageSpec::isOverridable( dwt->get_linkage() ) && CodeGen::isCtorDtor( dwt->get_name() ) ) {
228                        std::list< DeclarationWithType * > & params = GenPoly::getFunctionType( dwt->get_type() )->get_parameters();
229                        assert( ! params.empty() );
230                        Type * type = InitTweak::getPointerBase( params.front()->get_type() );
231                        assert( type );
232                        managedTypes.insert( SymTab::Mangler::mangle( type ) );
233                }
234        }
235
236        ImplicitCtorDtorStmt * genCtorDtor( const std::string & fname, ObjectDecl * objDecl, Expression * arg ) {
237                // call into genImplicitCall from Autogen.h to generate calls to ctor/dtor
238                assertf( objDecl, "genCtorDtor passed null objDecl" );
239                std::list< Statement * > stmts;
240                InitExpander srcParam( maybeClone( arg ) );
241                SymTab::genImplicitCall( srcParam, new VariableExpr( objDecl ), fname, back_inserter( stmts ), objDecl );
242                assert( stmts.size() <= 1 );
243                return stmts.size() == 1 ? strict_dynamic_cast< ImplicitCtorDtorStmt * >( stmts.front() ) : nullptr;
244        }
245
246        ConstructorInit * genCtorInit( ObjectDecl * objDecl ) {
247                // call into genImplicitCall from Autogen.h to generate calls to ctor/dtor
248                // for each constructable object
249                std::list< Statement * > ctor;
250                std::list< Statement * > dtor;
251
252                InitExpander srcParam( objDecl->get_init() );
253                InitExpander nullParam( (Initializer *)NULL );
254                SymTab::genImplicitCall( srcParam, new VariableExpr( objDecl ), "?{}", back_inserter( ctor ), objDecl );
255                SymTab::genImplicitCall( nullParam, new VariableExpr( objDecl ), "^?{}", front_inserter( dtor ), objDecl, false );
256
257                // Currently genImplicitCall produces a single Statement - a CompoundStmt
258                // which  wraps everything that needs to happen. As such, it's technically
259                // possible to use a Statement ** in the above calls, but this is inherently
260                // unsafe, so instead we take the slightly less efficient route, but will be
261                // immediately informed if somehow the above assumption is broken. In this case,
262                // we could always wrap the list of statements at this point with a CompoundStmt,
263                // but it seems reasonable at the moment for this to be done by genImplicitCall
264                // itself. It is possible that genImplicitCall produces no statements (e.g. if
265                // an array type does not have a dimension). In this case, it's fine to ignore
266                // the object for the purposes of construction.
267                assert( ctor.size() == dtor.size() && ctor.size() <= 1 );
268                if ( ctor.size() == 1 ) {
269                        // need to remember init expression, in case no ctors exist
270                        // if ctor does exist, want to use ctor expression instead of init
271                        // push this decision to the resolver
272                        assert( dynamic_cast< ImplicitCtorDtorStmt * > ( ctor.front() ) && dynamic_cast< ImplicitCtorDtorStmt * > ( dtor.front() ) );
273                        return new ConstructorInit( ctor.front(), dtor.front(), objDecl->get_init() );
274                }
275                return nullptr;
276        }
277
278        void CtorDtor::previsit( ObjectDecl * objDecl ) {
279                handleDWT( objDecl );
280                // hands off if @=, extern, builtin, etc.
281                // even if unmanaged, try to construct global or static if initializer is not constexpr, since this is not legal C
282                if ( tryConstruct( objDecl ) && ( isManaged( objDecl ) || ((! inFunction || objDecl->get_storageClasses().is_static ) && ! isConstExpr( objDecl->get_init() ) ) ) ) {
283                        // constructed objects cannot be designated
284                        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 );
285                        // constructed objects should not have initializers nested too deeply
286                        if ( ! checkInitDepth( objDecl ) ) throw SemanticError( "Managed object's initializer is too deep ", objDecl );
287
288                        objDecl->set_init( genCtorInit( objDecl ) );
289                }
290        }
291
292        void CtorDtor::previsit( FunctionDecl *functionDecl ) {
293                visit_children = false;  // do not try and construct parameters or forall parameters
294                GuardValue( inFunction );
295                inFunction = true;
296
297                handleDWT( functionDecl );
298
299                GuardScope( managedTypes );
300                // go through assertions and recursively add seen ctor/dtors
301                for ( auto & tyDecl : functionDecl->get_functionType()->get_forall() ) {
302                        for ( DeclarationWithType *& assertion : tyDecl->get_assertions() ) {
303                                handleDWT( assertion );
304                        }
305                }
306
307                maybeAccept( functionDecl->get_statements(), *visitor );
308        }
309
310        void CtorDtor::previsit( StructDecl *aggregateDecl ) {
311                visit_children = false; // do not try to construct and destruct aggregate members
312
313                // don't construct members, but need to take note if there is a managed member,
314                // because that means that this type is also managed
315                for ( Declaration * member : aggregateDecl->get_members() ) {
316                        if ( ObjectDecl * field = dynamic_cast< ObjectDecl * >( member ) ) {
317                                if ( isManaged( field ) ) {
318                                        StructInstType inst( Type::Qualifiers(), aggregateDecl );
319                                        managedTypes.insert( SymTab::Mangler::mangle( &inst ) );
320                                        break;
321                                }
322                        }
323                }
324        }
325
326        void CtorDtor::previsit( CompoundStmt * ) {
327                GuardScope( managedTypes );
328        }
329} // namespace InitTweak
330
331// Local Variables: //
332// tab-width: 4 //
333// mode: c++ //
334// compile-command: "make install" //
335// End: //
Note: See TracBrowser for help on using the repository browser.