source: src/InitTweak/GenInit.cc @ e3e16bc

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

Renamed safe_dynamic_cast to strict_dynamic_cast

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