source: src/InitTweak/GenInit.cc @ 5f98ce5

//
// Cforall Version 1.0.0 Copyright (C) 2015 University of Waterloo
//
// The contents of this file are covered under the licence agreement in the
// file "LICENCE" distributed with Cforall.
//
// GenInit.cc --
//
// Author           : Rob Schluntz
// Created On       : Mon May 18 07:44:20 2015
// Last Modified By : Rob Schluntz
// Last Modified On : Fri May 13 11:37:48 2016
// Update Count     : 166
//

#include <stack>
#include <list>
#include "GenInit.h"
#include "InitTweak.h"
#include "SynTree/Declaration.h"
#include "SynTree/Type.h"
#include "SynTree/Expression.h"
#include "SynTree/Statement.h"
#include "SynTree/Initializer.h"
#include "SynTree/Mutator.h"
#include "SymTab/Autogen.h"
#include "GenPoly/PolyMutator.h"
#include "GenPoly/DeclMutator.h"

namespace InitTweak {
        namespace {
                const std::list<Label> noLabels;
                const std::list<Expression *> noDesignators;
        }

        class ReturnFixer : public GenPoly::PolyMutator {
          public:
                /// consistently allocates a temporary variable for the return value
                /// of a function so that anything which the resolver decides can be constructed
                /// into the return type of a function can be returned.
                static void makeReturnTemp( std::list< Declaration * > &translationUnit );

                ReturnFixer();

                virtual DeclarationWithType * mutate( FunctionDecl *functionDecl );

                virtual Statement * mutate( ReturnStmt * returnStmt );

          protected:
                std::list<DeclarationWithType*> returnVals;
                UniqueName tempNamer;
                std::string funcName;
        };

        class CtorDtor : public GenPoly::PolyMutator {
          public:
                /// create constructor and destructor statements for object declarations.
                /// the actual call statements will be added in after the resolver has run
                /// so that the initializer expression is only removed if a constructor is found
                /// and the same destructor call is inserted in all of the appropriate locations.
                static void generateCtorDtor( std::list< Declaration * > &translationUnit );

                CtorDtor() : inFunction( false ) {}

                virtual DeclarationWithType * mutate( ObjectDecl * );
                virtual DeclarationWithType * mutate( FunctionDecl *functionDecl );
                // should not traverse into any of these declarations to find objects
                // that need to be constructed or destructed
                virtual Declaration* mutate( StructDecl *aggregateDecl ) { return aggregateDecl; }
                virtual Declaration* mutate( UnionDecl *aggregateDecl ) { return aggregateDecl; }
                virtual Declaration* mutate( EnumDecl *aggregateDecl ) { return aggregateDecl; }
                virtual Declaration* mutate( TraitDecl *aggregateDecl ) { return aggregateDecl; }
                virtual TypeDecl* mutate( TypeDecl *typeDecl ) { return typeDecl; }
                virtual Declaration* mutate( TypedefDecl *typeDecl ) { return typeDecl; }

                virtual Type * mutate( FunctionType *funcType ) { return funcType; }

          protected:
                bool inFunction;
        };

        class HoistArrayDimension : public GenPoly::DeclMutator {
          public:
                typedef GenPoly::DeclMutator Parent;

                /// hoist dimension from array types in object declaration so that it uses a single
                /// const variable of type size_t, so that side effecting array dimensions are only
                /// computed once.
                static void hoistArrayDimension( std::list< Declaration * > & translationUnit );

          private:
                DeclarationWithType * mutate( ObjectDecl * objectDecl );
                // should not traverse into any of these declarations to find objects
                // that need to be constructed or destructed
                virtual Declaration* mutate( StructDecl *aggregateDecl ) { return aggregateDecl; }
                virtual Declaration* mutate( UnionDecl *aggregateDecl ) { return aggregateDecl; }
                virtual Declaration* mutate( EnumDecl *aggregateDecl ) { return aggregateDecl; }
                virtual Declaration* mutate( TraitDecl *aggregateDecl ) { return aggregateDecl; }
                virtual TypeDecl* mutate( TypeDecl *typeDecl ) { return typeDecl; }
                virtual Declaration* mutate( TypedefDecl *typeDecl ) { return typeDecl; }

                virtual Type* mutate( FunctionType *funcType ) { return funcType; }

                void hoist( Type * type );

                DeclarationNode::StorageClass storageclass = DeclarationNode::NoStorageClass;
        };

        void genInit( std::list< Declaration * > & translationUnit ) {
                ReturnFixer::makeReturnTemp( translationUnit );
                HoistArrayDimension::hoistArrayDimension( translationUnit );
                CtorDtor::generateCtorDtor( translationUnit );
        }

        void ReturnFixer::makeReturnTemp( std::list< Declaration * > & translationUnit ) {
                ReturnFixer fixer;
                mutateAll( translationUnit, fixer );
        }

        ReturnFixer::ReturnFixer() : tempNamer( "_retVal" ) {}

        Statement *ReturnFixer::mutate( ReturnStmt *returnStmt ) {
                // update for multiple return values
                assert( returnVals.size() == 0 || returnVals.size() == 1 );
                // hands off if the function returns an lvalue - we don't want to allocate a temporary if a variable's address
                // is being returned
                if ( returnStmt->get_expr() && returnVals.size() == 1 && funcName != "?=?" && ! returnVals.front()->get_type()->get_isLvalue() ) {
                        // ensure return value is not destructed by explicitly creating
                        // an empty SingleInit node wherein maybeConstruct is false
                        ObjectDecl *newObj = new ObjectDecl( tempNamer.newName(), DeclarationNode::NoStorageClass, LinkageSpec::C, 0, returnVals.front()->get_type()->clone(), new ListInit( std::list<Initializer*>(), noDesignators, false ) );
                        stmtsToAdd.push_back( new DeclStmt( noLabels, newObj ) );

                        // and explicitly create the constructor expression separately
                        UntypedExpr *construct = new UntypedExpr( new NameExpr( "?{}" ) );
                        construct->get_args().push_back( new AddressExpr( new VariableExpr( newObj ) ) );
                        construct->get_args().push_back( returnStmt->get_expr() );
                        stmtsToAdd.push_back(new ExprStmt(noLabels, construct));

                        returnStmt->set_expr( new VariableExpr( newObj ) );
                } // if
                return returnStmt;
        }

        DeclarationWithType* ReturnFixer::mutate( FunctionDecl *functionDecl ) {
                std::list<DeclarationWithType*> oldReturnVals = returnVals;
                std::string oldFuncName = funcName;

                FunctionType * type = functionDecl->get_functionType();
                returnVals = type->get_returnVals();
                funcName = functionDecl->get_name();
                DeclarationWithType * decl = Mutator::mutate( functionDecl );
                returnVals = oldReturnVals;
                funcName = oldFuncName;
                return decl;
        }

        void HoistArrayDimension::hoistArrayDimension( std::list< Declaration * > & translationUnit ) {
                HoistArrayDimension hoister;
                mutateAll( translationUnit, hoister );
        }

        DeclarationWithType * HoistArrayDimension::mutate( ObjectDecl * objectDecl ) {
                storageclass = objectDecl->get_storageClass();
                DeclarationWithType * temp = Parent::mutate( objectDecl );
                hoist( objectDecl->get_type() );
                storageclass = DeclarationNode::NoStorageClass;
                return temp;
        }

        void HoistArrayDimension::hoist( Type * type ) {
                static UniqueName dimensionName( "_array_dim" );
                if ( ArrayType * arrayType = dynamic_cast< ArrayType * >( type ) ) {
                        if ( ! arrayType->get_dimension() ) return; // xxx - recursive call to hoist?

                        // don't need to hoist dimension if it's a constexpr - only need to if there's potential
                        // for side effects.
                        if ( isConstExpr( arrayType->get_dimension() ) ) return;

                        ObjectDecl * arrayDimension = new ObjectDecl( dimensionName.newName(), storageclass, LinkageSpec::C, 0, SymTab::SizeType->clone(), new SingleInit( arrayType->get_dimension() ) );
                        arrayDimension->get_type()->set_isConst( true );

                        arrayType->set_dimension( new VariableExpr( arrayDimension ) );
                        addDeclaration( arrayDimension );

                        hoist( arrayType->get_base() );
                        return;
                }
        }

        void CtorDtor::generateCtorDtor( std::list< Declaration * > & translationUnit ) {
                CtorDtor ctordtor;
                mutateAll( translationUnit, ctordtor );
        }

        namespace {
                Expression * makeCtorDtorExpr( std::string name, ObjectDecl * objDecl, std::list< Expression * > args ) {
                        UntypedExpr * expr = new UntypedExpr( new NameExpr( name ) );
                        expr->get_args().push_back( new AddressExpr( new VariableExpr( objDecl ) ) );
                        expr->get_args().splice( expr->get_args().end(), args );
                        return expr;
                }
        }

        DeclarationWithType * CtorDtor::mutate( ObjectDecl * objDecl ) {
                // hands off if designated or if @=
                if ( tryConstruct( objDecl ) ) {
                        if ( inFunction ) {
                                if ( ArrayType * at = dynamic_cast< ArrayType * >( objDecl->get_type() ) ) {
                                        // call into makeArrayFunction from validate.cc to generate calls to ctor/dtor for each element of array
                                        // TODO: walk initializers and generate appropriate ctor if element has initializer.
                                        // Initializer could be nested (depends on the depth of the array type on the object)

                                        std::list< Expression * > args = makeInitList( objDecl->get_init() );
                                        if ( args.empty() ) {
                                                std::list< Statement * > ctor;
                                                std::list< Statement * > dtor;

                                                SymTab::genImplicitCall( NULL, new VariableExpr( objDecl ), "?{}", back_inserter( ctor ), objDecl );
                                                SymTab::genImplicitCall( NULL, new VariableExpr( objDecl ), "^?{}", front_inserter( dtor ), objDecl, false );

                                                // Currently genArrayCall produces a single Statement - a CompoundStmt
                                                // which  wraps everything that needs to happen. As such, it's technically
                                                // possible to use a Statement ** in the above calls, but this is inherently
                                                // unsafe, so instead we take the slightly less efficient route, but will be
                                                // immediately informed if somehow the above assumption is broken. In this case,
                                                // we could always wrap the list of statements at this point with a CompoundStmt,
                                                // but it seems reasonable at the moment for this to be done by genArrayCall
                                                // itself
                                                assert( ctor.size() == 1 && dynamic_cast< ImplicitCtorDtorStmt * >( ctor.front() ) );
                                                assert( dtor.size() == 1 && dynamic_cast< ImplicitCtorDtorStmt * >( dtor.front() ) );
                                                objDecl->set_init( new ConstructorInit( ctor.front(), dtor.front(), objDecl->get_init() ) );
                                        } else {
                                                // array came with an initializer list: initialize each element
                                                // may have more initializers than elements in the array - need to check at each index that
                                                // we haven't exceeded size. This requires precomputing the size because it might be a side-effecting
                                                // computation.
                                                // may have fewer initializers than elements in the array - need to default construct
                                                // remaining elements.
                                                // might be able to merge this with the case above.

                                        }
                                } else {
                                        // it's sufficient to attempt to call the ctor/dtor for the given object and its initializer
                                        Expression * ctor = makeCtorDtorExpr( "?{}", objDecl, makeInitList( objDecl->get_init() ) );
                                        Expression * dtor = makeCtorDtorExpr( "^?{}", objDecl, std::list< Expression * >() );

                                        // need to remember init expression, in case no ctors exist
                                        // if ctor does exist, want to use ctor expression instead of init
                                        // push this decision to the resolver
                                        ExprStmt * ctorStmt = new ExprStmt( noLabels, ctor );
                                        ExprStmt * dtorStmt = new ExprStmt( noLabels, dtor );
                                        objDecl->set_init( new ConstructorInit( new ImplicitCtorDtorStmt( ctorStmt ), new ImplicitCtorDtorStmt( dtorStmt ), objDecl->get_init() ) );
                                }
                        }
                }
                return Mutator::mutate( objDecl );
        }

        DeclarationWithType * CtorDtor::mutate( FunctionDecl *functionDecl ) {
                // parameters should not be constructed and destructed, so don't mutate FunctionType
                bool oldInFunc = inFunction;
                mutateAll( functionDecl->get_oldDecls(), *this );
                inFunction = true;
                functionDecl->set_statements( maybeMutate( functionDecl->get_statements(), *this ) );
                inFunction = oldInFunc;
                return functionDecl;
        }
} // namespace InitTweak

// Local Variables: //
// tab-width: 4 //
// mode: c++ //
// compile-command: "make install" //
// End: //