source: src/InitTweak/GenInit.cc @ 2f42718

no_list
Last change on this file since 2f42718 was 2f42718, checked in by tdelisle <tdelisle@…>, 5 years ago

Parameters and return value of functions are now vectors (and some related clean-up)

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