source: src/SymTab/Autogen.cc @ f232977

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

Refactor assignment return autogen code

  • Property mode set to 100644
File size: 34.0 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// Autogen.cc --
8//
9// Author           : Rob Schluntz
10// Created On       : Thu Mar 03 15:45:56 2016
11// Last Modified By : Andrew Beach
12// Last Modified On : Fri Jul 14 16:41:00 2017
13// Update Count     : 62
14//
15
16#include "Autogen.h"
17
18#include <algorithm>               // for count_if
19#include <cassert>                 // for strict_dynamic_cast, assert, assertf
20#include <iterator>                // for back_insert_iterator, back_inserter
21#include <list>                    // for list, _List_iterator, list<>::iter...
22#include <set>                     // for set, _Rb_tree_const_iterator
23#include <utility>                 // for pair
24#include <vector>                  // for vector
25
26#include "AddVisit.h"              // for addVisit
27#include "CodeGen/OperatorTable.h" // for isCtorDtor, isCtorDtorAssign
28#include "Common/PassVisitor.h"    // for PassVisitor
29#include "Common/ScopedMap.h"      // for ScopedMap<>::const_iterator, Scope...
30#include "Common/utility.h"        // for cloneAll, operator+
31#include "GenPoly/ScopedSet.h"     // for ScopedSet, ScopedSet<>::iterator
32#include "InitTweak/GenInit.h"     // for fixReturnStatements
33#include "ResolvExpr/Resolver.h"   // for resolveDecl
34#include "SymTab/Mangler.h"        // for Mangler
35#include "SynTree/Attribute.h"     // For Attribute
36#include "SynTree/Mutator.h"       // for maybeMutate
37#include "SynTree/Statement.h"     // for CompoundStmt, ReturnStmt, ExprStmt
38#include "SynTree/Type.h"          // for FunctionType, Type, TypeInstType
39#include "SynTree/Visitor.h"       // for maybeAccept, Visitor, acceptAll
40
41class Attribute;
42
43namespace SymTab {
44        Type * SizeType = 0;
45
46        /// Data used to generate functions generically. Specifically, the name of the generated function and a function which generates the routine protoype
47        struct FuncData {
48                typedef FunctionType * (*TypeGen)( Type * );
49                FuncData( const std::string & fname, const TypeGen & genType ) : fname( fname ), genType( genType ) {}
50                std::string fname;
51                TypeGen genType;
52        };
53
54        struct AutogenerateRoutines final : public WithDeclsToAdd, public WithVisitorRef<AutogenerateRoutines>, public WithGuards, public WithShortCircuiting, public WithIndexer {
55                AutogenerateRoutines();
56
57                void previsit( EnumDecl * enumDecl );
58                void previsit( StructDecl * structDecl );
59                void previsit( UnionDecl * structDecl );
60                void previsit( TypeDecl * typeDecl );
61                void previsit( TraitDecl * traitDecl );
62                void previsit( FunctionDecl * functionDecl );
63
64                void previsit( FunctionType * ftype );
65                void previsit( PointerType * ptype );
66
67                void previsit( CompoundStmt * compoundStmt );
68
69          private:
70
71                GenPoly::ScopedSet< std::string > structsDone;
72                unsigned int functionNesting = 0;     // current level of nested functions
73
74                InitTweak::ManagedTypes managedTypes;
75                std::vector< FuncData > data;
76        };
77
78        /// generates routines for tuple types.
79        struct AutogenTupleRoutines : public WithDeclsToAdd, public WithVisitorRef<AutogenTupleRoutines>, public WithGuards, public WithShortCircuiting {
80                void previsit( FunctionDecl * functionDecl );
81
82                void postvisit( TupleType * tupleType );
83
84                void previsit( CompoundStmt * compoundStmt );
85
86          private:
87                unsigned int functionNesting = 0;     // current level of nested functions
88                GenPoly::ScopedSet< std::string > seenTuples;
89        };
90
91        void autogenerateRoutines( std::list< Declaration * > &translationUnit ) {
92                PassVisitor<AutogenerateRoutines> generator;
93                acceptAll( translationUnit, generator );
94
95                // needs to be done separately because AutogenerateRoutines skips types that appear as function arguments, etc.
96                // AutogenTupleRoutines tupleGenerator;
97                // acceptAll( translationUnit, tupleGenerator );
98        }
99
100        //=============================================================================================
101        // FuncGenerator definitions
102        //=============================================================================================
103        class FuncGenerator {
104        public:
105                std::list< Declaration * > definitions, forwards;
106
107                FuncGenerator( Type * type, const std::vector< FuncData > & data, unsigned int functionNesting, SymTab::Indexer & indexer ) : type( type ), data( data ), functionNesting( functionNesting ), indexer( indexer ) {}
108
109                virtual bool shouldAutogen() const = 0;
110                void genStandardFuncs();
111                virtual void genFieldCtors() = 0;
112        protected:
113                Type * type;
114                const std::vector< FuncData > & data;
115                unsigned int functionNesting;
116                SymTab::Indexer & indexer;
117
118                virtual void genFuncBody( FunctionDecl * dcl ) = 0;
119                virtual bool isConcurrentType() const = 0;
120
121                void resolve( FunctionDecl * dcl );
122                void generatePrototypes( std::list< FunctionDecl * > & newFuncs );
123        };
124
125        class StructFuncGenerator : public FuncGenerator {
126                StructDecl * aggregateDecl;
127        public:
128                StructFuncGenerator( StructDecl * aggregateDecl, StructInstType * refType, const std::vector< FuncData > & data,  unsigned int functionNesting, SymTab::Indexer & indexer ) : FuncGenerator( refType, data, functionNesting, indexer ), aggregateDecl( aggregateDecl) {}
129
130                virtual bool shouldAutogen() const override;
131                virtual bool isConcurrentType() const override;
132
133                virtual void genFuncBody( FunctionDecl * dcl ) override;
134                virtual void genFieldCtors() override;
135
136        private:
137                /// generates a single struct member operation (constructor call, destructor call, assignment call)
138                void makeMemberOp( ObjectDecl * dstParam, Expression * src, DeclarationWithType * field, FunctionDecl * func, bool forward = true );
139
140                /// generates the body of a struct function by iterating the struct members (via parameters) - generates default ctor, copy ctor, assignment, and dtor bodies, but NOT field ctor bodies
141                template<typename Iterator>
142                void makeFunctionBody( Iterator member, Iterator end, FunctionDecl * func, bool forward = true );
143
144                /// generate the body of a constructor which takes parameters that match fields, e.g.
145                /// void ?{}(A *, int) and void?{}(A *, int, int) for a struct A which has two int fields.
146                template<typename Iterator>
147                void makeFieldCtorBody( Iterator member, Iterator end, FunctionDecl * func );
148        };
149
150        class UnionFuncGenerator : public FuncGenerator {
151                UnionDecl * aggregateDecl;
152        public:
153                UnionFuncGenerator( UnionDecl * aggregateDecl, UnionInstType * refType, const std::vector< FuncData > & data,  unsigned int functionNesting, SymTab::Indexer & indexer ) : FuncGenerator( refType, data, functionNesting, indexer ), aggregateDecl( aggregateDecl) {}
154
155                virtual bool shouldAutogen() const override;
156                virtual bool isConcurrentType() const override;
157
158                virtual void genFuncBody( FunctionDecl * dcl ) override;
159                virtual void genFieldCtors() override;
160
161        private:
162                /// generates a single struct member operation (constructor call, destructor call, assignment call)
163                template<typename OutputIterator>
164                void makeMemberOp( ObjectDecl * srcParam, ObjectDecl * dstParam, OutputIterator out );
165
166                /// generates the body of a struct function by iterating the struct members (via parameters) - generates default ctor, copy ctor, assignment, and dtor bodies, but NOT field ctor bodies
167                template<typename Iterator>
168                void makeFunctionBody( Iterator member, Iterator end, FunctionDecl * func, bool forward = true );
169
170                /// generate the body of a constructor which takes parameters that match fields, e.g.
171                /// void ?{}(A *, int) and void?{}(A *, int, int) for a struct A which has two int fields.
172                template<typename Iterator>
173                void makeFieldCtorBody( Iterator member, Iterator end, FunctionDecl * func );
174        };
175
176        class EnumFuncGenerator : public FuncGenerator {
177        public:
178                EnumFuncGenerator( EnumInstType * refType, const std::vector< FuncData > & data,  unsigned int functionNesting, SymTab::Indexer & indexer ) : FuncGenerator( refType, data, functionNesting, indexer ) {}
179
180                virtual bool shouldAutogen() const override;
181                virtual bool isConcurrentType() const override;
182
183                virtual void genFuncBody( FunctionDecl * dcl ) override;
184                virtual void genFieldCtors() override;
185
186        private:
187        };
188
189        class TypeFuncGenerator : public FuncGenerator {
190                TypeDecl * typeDecl;
191        public:
192                TypeFuncGenerator( TypeDecl * typeDecl, TypeInstType * refType, const std::vector<FuncData> & data, unsigned int functionNesting, SymTab::Indexer & indexer ) : FuncGenerator( refType, data, functionNesting, indexer ), typeDecl( typeDecl ) {}
193
194                virtual bool shouldAutogen() const override;
195                virtual void genFuncBody( FunctionDecl * dcl ) override;
196                virtual bool isConcurrentType() const override;
197                virtual void genFieldCtors() override;
198        };
199
200        //=============================================================================================
201        // helper functions
202        //=============================================================================================
203        void generateFunctions( FuncGenerator & gen, std::list< Declaration * > & declsToAdd ) {
204                if ( ! gen.shouldAutogen() ) return;
205
206                // generate each of the functions based on the supplied FuncData objects
207                gen.genStandardFuncs();
208                gen.genFieldCtors();
209
210                declsToAdd.splice( declsToAdd.end(), gen.forwards );
211                declsToAdd.splice( declsToAdd.end(), gen.definitions );
212        }
213
214        bool isUnnamedBitfield( ObjectDecl * obj ) {
215                return obj != nullptr && obj->get_name() == "" && obj->get_bitfieldWidth() != nullptr;
216        }
217
218        /// inserts a forward declaration for functionDecl into declsToAdd
219        void addForwardDecl( FunctionDecl * functionDecl, std::list< Declaration * > & declsToAdd ) {
220                FunctionDecl * decl = functionDecl->clone();
221                delete decl->get_statements();
222                decl->set_statements( nullptr );
223                declsToAdd.push_back( decl );
224                decl->fixUniqueId();
225        }
226
227        /// given type T, generate type of default ctor/dtor, i.e. function type void (*) (T *)
228        FunctionType * genDefaultType( Type * paramType ) {
229                FunctionType *ftype = new FunctionType( Type::Qualifiers(), false );
230                ObjectDecl *dstParam = new ObjectDecl( "_dst", Type::StorageClasses(), LinkageSpec::Cforall, nullptr, new ReferenceType( Type::Qualifiers(), paramType->clone() ), nullptr );
231                ftype->get_parameters().push_back( dstParam );
232                return ftype;
233        }
234
235        /// given type T, generate type of copy ctor, i.e. function type void (*) (T *, T)
236        FunctionType * genCopyType( Type * paramType ) {
237                FunctionType *ftype = genDefaultType( paramType );
238                ObjectDecl *srcParam = new ObjectDecl( "_src", Type::StorageClasses(), LinkageSpec::Cforall, nullptr, paramType->clone(), nullptr );
239                ftype->get_parameters().push_back( srcParam );
240                return ftype;
241        }
242
243        /// given type T, generate type of assignment, i.e. function type T (*) (T *, T)
244        FunctionType * genAssignType( Type * paramType ) {
245                FunctionType *ftype = genCopyType( paramType );
246                ObjectDecl *returnVal = new ObjectDecl( "_ret", Type::StorageClasses(), LinkageSpec::Cforall, nullptr, paramType->clone(), nullptr );
247                ftype->get_returnVals().push_back( returnVal );
248                return ftype;
249        }
250
251        /// generate a function decl from a name and type. Nesting depth determines whether
252        /// the declaration is static or not; optional paramter determines if declaration is intrinsic
253        FunctionDecl * genFunc( const std::string & fname, FunctionType * ftype, unsigned int functionNesting, bool isIntrinsic = false  ) {
254                // Routines at global scope marked "static" to prevent multiple definitions in separate translation units
255                // because each unit generates copies of the default routines for each aggregate.
256                Type::StorageClasses scs = functionNesting > 0 ? Type::StorageClasses() : Type::StorageClasses( Type::Static );
257                LinkageSpec::Spec spec = isIntrinsic ? LinkageSpec::Intrinsic : LinkageSpec::AutoGen;
258                FunctionDecl * decl = new FunctionDecl( fname, scs, spec, ftype, new CompoundStmt( noLabels ),
259                                                                                                std::list< Attribute * >(), Type::FuncSpecifiers( Type::Inline ) );
260                decl->fixUniqueId();
261                return decl;
262        }
263
264        Type * declToType( Declaration * decl ) {
265                if ( DeclarationWithType * dwt = dynamic_cast< DeclarationWithType * >( decl ) ) {
266                        return dwt->get_type();
267                }
268                return nullptr;
269        }
270
271        Type * declToTypeDeclBase( Declaration * decl ) {
272                if ( TypeDecl * td = dynamic_cast< TypeDecl * >( decl ) ) {
273                        return td->base;
274                }
275                return nullptr;
276        }
277
278        const std::list< TypeDecl * > getGenericParams( Type * t ) {
279                std::list< TypeDecl * > * ret = nullptr;
280                if ( StructInstType * inst = dynamic_cast< StructInstType * > ( t ) ) {
281                        ret = inst->get_baseParameters();
282                } else if ( UnionInstType * inst = dynamic_cast< UnionInstType * >( t ) ) {
283                        ret = inst->get_baseParameters();
284                }
285                return ret ? *ret : std::list< TypeDecl * >();
286        }
287
288        //=============================================================================================
289        // FuncGenerator member definitions
290        //=============================================================================================
291        void FuncGenerator::genStandardFuncs() {
292                std::list< FunctionDecl * > newFuncs;
293                generatePrototypes( newFuncs );
294
295                for ( FunctionDecl * dcl : newFuncs ) {
296                        genFuncBody( dcl );
297                        if ( CodeGen::isAssignment( dcl->name ) ) {
298                                // assignment needs to return a value
299                                FunctionType * assignType = dcl->type;
300                                assert( assignType->parameters.size() == 2 );
301                                assert( assignType->returnVals.size() == 1 );
302                                ObjectDecl * dstParam = strict_dynamic_cast< ObjectDecl * >( assignType->parameters.front() );
303                                dcl->statements->push_back( new ReturnStmt( noLabels, new VariableExpr( dstParam ) ) );
304                        }
305                        resolve( dcl );
306                }
307        }
308
309        void FuncGenerator::generatePrototypes( std::list< FunctionDecl * > & newFuncs ) {
310                bool concurrent_type = isConcurrentType();
311                for ( const FuncData & data : data ) {
312                        // generate a function (?{}, ?=?, ^?{}) based on the current FuncData.
313                        FunctionType * ftype = data.genType( type );
314
315                        // destructor for concurrent type must be mutex
316                        if ( concurrent_type && CodeGen::isDestructor( data.fname ) ) {
317                                ftype->parameters.front()->get_type()->set_mutex( true );
318                        }
319
320                        // Make function polymorphic in same parameters as generic struct, if applicable
321                        std::list< TypeDecl * > typeParams = getGenericParams( type ); // List of type variables to be placed on the generated functions
322                        cloneAll( typeParams, ftype->forall );
323
324                        newFuncs.push_back( genFunc( data.fname, ftype, functionNesting ) );
325                }
326        }
327
328        void FuncGenerator::resolve( FunctionDecl * dcl ) {
329                try {
330                        ResolvExpr::resolveDecl( dcl, indexer );
331                        if ( functionNesting == 0 ) {
332                                // forward declare if top-level struct, so that
333                                // type is complete as soon as its body ends
334                                // Note: this is necessary if we want structs which contain
335                                // generic (otype) structs as members.
336                                addForwardDecl( dcl, forwards );
337                        }
338                        definitions.push_back( dcl );
339                        indexer.addId( dcl );
340                } catch ( SemanticError err ) {
341                        // okay if decl does not resolve - that means the function should not be generated
342                        delete dcl;
343                }
344        }
345
346        bool StructFuncGenerator::shouldAutogen() const {
347                // Builtins do not use autogeneration.
348                return ! aggregateDecl->linkage.is_builtin;
349        }
350        bool StructFuncGenerator::isConcurrentType() const { return aggregateDecl->is_thread() || aggregateDecl->is_monitor(); }
351
352        void StructFuncGenerator::genFuncBody( FunctionDecl * dcl ) {
353                // generate appropriate calls to member ctor, assignment
354                // destructor needs to do everything in reverse, so pass "forward" based on whether the function is a destructor
355                if ( ! CodeGen::isDestructor( dcl->get_name() ) ) {
356                        makeFunctionBody( aggregateDecl->members.begin(), aggregateDecl->members.end(), dcl );
357                } else {
358                        makeFunctionBody( aggregateDecl->members.rbegin(), aggregateDecl->members.rend(), dcl, false );
359                }
360        }
361
362        void StructFuncGenerator::genFieldCtors() {
363                // field ctors are only generated if default constructor and copy constructor are both generated
364                unsigned numCtors = std::count_if( definitions.begin(), definitions.end(), [](Declaration * dcl) { return CodeGen::isConstructor( dcl->get_name() ); } );
365
366                // Field constructors are only generated if default and copy constructor
367                // are generated, since they need access to both
368                if ( numCtors != 2 ) return;
369
370                // create constructors which take each member type as a parameter.
371                // for example, for struct A { int x, y; }; generate
372                //   void ?{}(A *, int) and void ?{}(A *, int, int)
373                const auto & typeParams = aggregateDecl->parameters;
374                FunctionType * memCtorType = genDefaultType( type );
375                cloneAll( typeParams, memCtorType->forall );
376                for ( Declaration * member : aggregateDecl->members ) {
377                        DeclarationWithType * field = strict_dynamic_cast<DeclarationWithType *>( member );
378                        if ( isUnnamedBitfield( dynamic_cast< ObjectDecl * > ( field ) ) ) {
379                                // don't make a function whose parameter is an unnamed bitfield
380                                continue;
381                        }
382                        memCtorType->parameters.push_back( new ObjectDecl( field->name, Type::StorageClasses(), LinkageSpec::Cforall, 0, field->get_type()->clone(), 0 ) );
383                        FunctionDecl * ctor = genFunc( "?{}", memCtorType->clone(), functionNesting );
384                        makeFieldCtorBody( aggregateDecl->members.begin(), aggregateDecl->members.end(), ctor );
385                        resolve( ctor );
386                }
387                delete memCtorType;
388        }
389
390        void StructFuncGenerator::makeMemberOp( ObjectDecl * dstParam, Expression * src, DeclarationWithType * field, FunctionDecl * func, bool forward ) {
391                InitTweak::InitExpander srcParam( src );
392
393                // assign to destination
394                Expression *dstselect = new MemberExpr( field, new CastExpr( new VariableExpr( dstParam ), strict_dynamic_cast< ReferenceType* >( dstParam->get_type() )->get_base()->clone() ) );
395                genImplicitCall( srcParam, dstselect, func->get_name(), back_inserter( func->get_statements()->get_kids() ), field, forward );
396        }
397
398        template<typename Iterator>
399        void StructFuncGenerator::makeFunctionBody( Iterator member, Iterator end, FunctionDecl * func, bool forward ) {
400                for ( ; member != end; ++member ) {
401                        if ( DeclarationWithType *field = dynamic_cast< DeclarationWithType * >( *member ) ) { // otherwise some form of type declaration, e.g. Aggregate
402                                // query the type qualifiers of this field and skip assigning it if it is marked const.
403                                // If it is an array type, we need to strip off the array layers to find its qualifiers.
404                                Type * type = field->get_type();
405                                while ( ArrayType * at = dynamic_cast< ArrayType * >( type ) ) {
406                                        type = at->get_base();
407                                }
408
409                                if ( type->get_const() && func->get_name() == "?=?" ) {
410                                        // don't assign const members, but do construct/destruct
411                                        continue;
412                                }
413
414                                assert( ! func->get_functionType()->get_parameters().empty() );
415                                ObjectDecl * dstParam = dynamic_cast<ObjectDecl*>( func->get_functionType()->get_parameters().front() );
416                                ObjectDecl * srcParam = nullptr;
417                                if ( func->get_functionType()->get_parameters().size() == 2 ) {
418                                        srcParam = dynamic_cast<ObjectDecl*>( func->get_functionType()->get_parameters().back() );
419                                }
420                                // srcParam may be NULL, in which case we have default ctor/dtor
421                                assert( dstParam );
422
423                                Expression *srcselect = srcParam ? new MemberExpr( field, new VariableExpr( srcParam ) ) : nullptr;
424                                makeMemberOp( dstParam, srcselect, field, func, forward );
425                        } // if
426                } // for
427        } // makeFunctionBody
428
429        template<typename Iterator>
430        void StructFuncGenerator::makeFieldCtorBody( Iterator member, Iterator end, FunctionDecl * func ) {
431                FunctionType * ftype = func->type;
432                std::list<DeclarationWithType*> & params = ftype->parameters;
433                assert( params.size() >= 2 );  // should not call this function for default ctor, etc.
434
435                // skip 'this' parameter
436                ObjectDecl * dstParam = dynamic_cast<ObjectDecl*>( params.front() );
437                assert( dstParam );
438                std::list<DeclarationWithType*>::iterator parameter = params.begin()+1;
439                for ( ; member != end; ++member ) {
440                        if ( DeclarationWithType * field = dynamic_cast<DeclarationWithType*>( *member ) ) {
441                                if ( isUnnamedBitfield( dynamic_cast< ObjectDecl * > ( field ) ) ) {
442                                        // don't make a function whose parameter is an unnamed bitfield
443                                        continue;
444                                } else if ( parameter != params.end() ) {
445                                        // matching parameter, initialize field with copy ctor
446                                        Expression *srcselect = new VariableExpr(*parameter);
447                                        makeMemberOp( dstParam, srcselect, field, func );
448                                        ++parameter;
449                                } else {
450                                        // no matching parameter, initialize field with default ctor
451                                        makeMemberOp( dstParam, nullptr, field, func );
452                                }
453                        }
454                }
455        }
456
457        bool UnionFuncGenerator::shouldAutogen() const {
458                // Builtins do not use autogeneration.
459                return ! aggregateDecl->linkage.is_builtin;
460        }
461
462        // xxx - is this right?
463        bool UnionFuncGenerator::isConcurrentType() const { return false; };
464
465        /// generate a single union assignment expression (using memcpy)
466        template< typename OutputIterator >
467        void UnionFuncGenerator::makeMemberOp( ObjectDecl * srcParam, ObjectDecl * dstParam, OutputIterator out ) {
468                UntypedExpr *copy = new UntypedExpr( new NameExpr( "__builtin_memcpy" ) );
469                copy->args.push_back( new AddressExpr( new VariableExpr( dstParam ) ) );
470                copy->args.push_back( new AddressExpr( new VariableExpr( srcParam ) ) );
471                copy->args.push_back( new SizeofExpr( srcParam->get_type()->clone() ) );
472                *out++ = new ExprStmt( noLabels, copy );
473        }
474
475        /// generates the body of a union assignment/copy constructor/field constructor
476        void UnionFuncGenerator::genFuncBody( FunctionDecl * funcDecl ) {
477                FunctionType * ftype = funcDecl->type;
478                if ( InitTweak::isCopyConstructor( funcDecl ) || InitTweak::isAssignment( funcDecl ) ) {
479                        assert( ftype->parameters.size() == 2 );
480                        ObjectDecl * dstParam = strict_dynamic_cast< ObjectDecl * >( ftype->parameters.front() );
481                        ObjectDecl * srcParam = strict_dynamic_cast< ObjectDecl * >( ftype->parameters.back() );
482                        makeMemberOp( srcParam, dstParam, back_inserter( funcDecl->statements->kids ) );
483                } else {
484                        // default ctor/dtor body is empty - add unused attribute to parameter to silence warnings
485                        assert( ftype->parameters.size() == 1 );
486                        ObjectDecl * dstParam = strict_dynamic_cast< ObjectDecl * >( ftype->parameters.front() );
487                        dstParam->attributes.push_back( new Attribute( "unused" ) );
488                }
489        }
490
491        /// generate the body of a constructor which takes parameters that match fields, e.g.
492        /// void ?{}(A *, int) and void?{}(A *, int, int) for a struct A which has two int fields.
493        void UnionFuncGenerator::genFieldCtors() {
494                // field ctors are only generated if default constructor and copy constructor are both generated
495                unsigned numCtors = std::count_if( definitions.begin(), definitions.end(), [](Declaration * dcl) { return CodeGen::isConstructor( dcl->get_name() ); } );
496
497                // Field constructors are only generated if default and copy constructor
498                // are generated, since they need access to both
499                if ( numCtors != 2 ) return;
500
501                // create a constructor which takes the first member type as a parameter.
502                // for example, for Union A { int x; double y; }; generate
503                // void ?{}(A *, int)
504                // This is to mimic C's behaviour which initializes the first member of the union.
505                const auto & typeParams = aggregateDecl->parameters;
506                FunctionType * memCtorType = genDefaultType( type );
507                cloneAll( typeParams, memCtorType->forall );
508                for ( Declaration * member : aggregateDecl->members ) {
509                        DeclarationWithType * field = strict_dynamic_cast<DeclarationWithType *>( member );
510                        if ( isUnnamedBitfield( dynamic_cast< ObjectDecl * > ( field ) ) ) {
511                                // don't make a function whose parameter is an unnamed bitfield
512                                break;
513                        }
514                        memCtorType->parameters.push_back( new ObjectDecl( field->name, Type::StorageClasses(), LinkageSpec::Cforall, nullptr, field->get_type()->clone(), nullptr ) );
515                        FunctionDecl * ctor = genFunc( "?{}", memCtorType->clone(), functionNesting );
516                        ObjectDecl * srcParam = strict_dynamic_cast<ObjectDecl *>( ctor->type->parameters.back() );
517                        ObjectDecl * dstParam = InitTweak::getParamThis( ctor->type );
518                        makeMemberOp( srcParam, dstParam, back_inserter( ctor->statements->kids ) );
519                        resolve( ctor );
520                        // only generate one field ctor for unions
521                        break;
522                }
523                delete memCtorType;
524        }
525
526        void EnumFuncGenerator::genFuncBody( FunctionDecl * funcDecl ) {
527                // xxx - Temporary: make these functions intrinsic so they codegen as C assignment.
528                // Really they're something of a cross between instrinsic and autogen, so should
529                // probably make a new linkage type
530                funcDecl->linkage = LinkageSpec::Intrinsic;
531                FunctionType * ftype = funcDecl->type;
532                if ( InitTweak::isCopyConstructor( funcDecl ) || InitTweak::isAssignment( funcDecl ) ) {
533                        assert( ftype->parameters.size() == 2 );
534                        ObjectDecl * dstParam = strict_dynamic_cast< ObjectDecl * >( ftype->parameters.front() );
535                        ObjectDecl * srcParam = strict_dynamic_cast< ObjectDecl * >( ftype->parameters.back() );
536
537                        // enum copy construct and assignment is just C-style assignment.
538                        // this looks like a bad recursive call, but code gen will turn it into
539                        // a C-style assignment.
540                        // This happens before function pointer type conversion, so need to do it manually here
541                        ApplicationExpr * callExpr = new ApplicationExpr( VariableExpr::functionPointer( funcDecl ) );
542                        callExpr->get_args().push_back( new VariableExpr( dstParam ) );
543                        callExpr->get_args().push_back( new VariableExpr( srcParam ) );
544                        funcDecl->statements->push_back( new ExprStmt( noLabels, callExpr ) );
545                } else {
546                        // default ctor/dtor body is empty - add unused attribute to parameter to silence warnings
547                        assert( ftype->parameters.size() == 1 );
548                        ObjectDecl * dstParam = strict_dynamic_cast< ObjectDecl * >( ftype->parameters.front() );
549                        dstParam->attributes.push_back( new Attribute( "unused" ) );
550                }
551        }
552
553        bool EnumFuncGenerator::shouldAutogen() const { return true; }
554        bool EnumFuncGenerator::isConcurrentType() const { return false; }
555        // enums do not have field constructors
556        void EnumFuncGenerator::genFieldCtors() {}
557
558        bool TypeFuncGenerator::shouldAutogen() const { return true; };
559
560        void TypeFuncGenerator::genFuncBody( FunctionDecl * dcl ) {
561                FunctionType * ftype = dcl->type;
562                assertf( ftype->parameters.size() == 1 || ftype->parameters.size() == 2, "Incorrect number of parameters in autogenerated typedecl function: %zd", ftype->parameters.size() );
563                DeclarationWithType * dst = ftype->parameters.front();
564                DeclarationWithType * src = ftype->parameters.size() == 2 ? ftype->parameters.back() : nullptr;
565                // generate appropriate calls to member ctor, assignment
566                UntypedExpr * expr = new UntypedExpr( new NameExpr( dcl->name ) );
567                expr->args.push_back( new CastExpr( new VariableExpr( dst ), new ReferenceType( Type::Qualifiers(), typeDecl->base->clone() ) ) );
568                if ( src ) expr->args.push_back( new CastExpr( new VariableExpr( src ), typeDecl->base->clone() ) );
569                dcl->statements->kids.push_back( new ExprStmt( noLabels, expr ) );
570        };
571
572        // xxx - should reach in and determine if base type is concurrent?
573        bool TypeFuncGenerator::isConcurrentType() const { return false; };
574
575        // opaque types do not have field constructors
576        void TypeFuncGenerator::genFieldCtors() {};
577
578        //=============================================================================================
579        // Visitor definitions
580        //=============================================================================================
581        AutogenerateRoutines::AutogenerateRoutines() {
582                // the order here determines the order that these functions are generated.
583                // assignment should come last since it uses copy constructor in return.
584                data.emplace_back( "?{}", genDefaultType );
585                data.emplace_back( "?{}", genCopyType );
586                data.emplace_back( "^?{}", genDefaultType );
587                data.emplace_back( "?=?", genAssignType );
588        }
589
590        void AutogenerateRoutines::previsit( EnumDecl * enumDecl ) {
591                // must visit children (enum constants) to add them to the indexer
592                if ( enumDecl->has_body() ) {
593                        EnumInstType enumInst( Type::Qualifiers(), enumDecl->get_name() );
594                        enumInst.set_baseEnum( enumDecl );
595                        EnumFuncGenerator gen( &enumInst, data, functionNesting, indexer );
596                        generateFunctions( gen, declsToAddAfter );
597                }
598        }
599
600        void AutogenerateRoutines::previsit( StructDecl * structDecl ) {
601                visit_children = false;
602                if ( structDecl->has_body() ) {
603                        StructInstType structInst( Type::Qualifiers(), structDecl->name );
604                        structInst.set_baseStruct( structDecl );
605                        for ( TypeDecl * typeDecl : structDecl->parameters ) {
606                                structInst.parameters.push_back( new TypeExpr( new TypeInstType( Type::Qualifiers(), typeDecl->name, typeDecl ) ) );
607                        }
608                        StructFuncGenerator gen( structDecl, &structInst, data, functionNesting, indexer );
609                        generateFunctions( gen, declsToAddAfter );
610                } // if
611        }
612
613        void AutogenerateRoutines::previsit( UnionDecl * unionDecl ) {
614                visit_children = false;
615                if ( unionDecl->has_body()  ) {
616                        UnionInstType unionInst( Type::Qualifiers(), unionDecl->get_name() );
617                        unionInst.set_baseUnion( unionDecl );
618                        for ( TypeDecl * typeDecl : unionDecl->get_parameters() ) {
619                                unionInst.get_parameters().push_back( new TypeExpr( new TypeInstType( Type::Qualifiers(), typeDecl->get_name(), typeDecl ) ) );
620                        }
621                        UnionFuncGenerator gen( unionDecl, &unionInst, data, functionNesting, indexer );
622                        generateFunctions( gen, declsToAddAfter );
623                } // if
624        }
625
626        // generate ctor/dtors/assign for typedecls, e.g., otype T = int *;
627        void AutogenerateRoutines::previsit( TypeDecl * typeDecl ) {
628                visit_children = false;
629                if ( ! typeDecl->base ) return;
630
631                TypeInstType refType( Type::Qualifiers(), typeDecl->name, typeDecl );
632                TypeFuncGenerator gen( typeDecl, &refType, data, functionNesting, indexer );
633                generateFunctions( gen, declsToAddAfter );
634        }
635
636        void AutogenerateRoutines::previsit( FunctionType *) {
637                // ensure that we don't add assignment ops for types defined as part of the function
638                visit_children = false;
639        }
640
641        void AutogenerateRoutines::previsit( PointerType *) {
642                // ensure that we don't add assignment ops for types defined as part of the pointer
643                visit_children = false;
644        }
645
646        void AutogenerateRoutines::previsit( TraitDecl * ) {
647                // ensure that we don't add assignment ops for types defined as part of the trait
648                visit_children = false;
649        }
650
651        void AutogenerateRoutines::previsit( FunctionDecl * functionDecl ) {
652                visit_children = false;
653                // record the existence of this function as appropriate
654                managedTypes.handleDWT( functionDecl );
655
656                maybeAccept( functionDecl->type, *visitor );
657                functionNesting += 1;
658                maybeAccept( functionDecl->statements, *visitor );
659                functionNesting -= 1;
660        }
661
662        void AutogenerateRoutines::previsit( CompoundStmt * ) {
663                GuardScope( managedTypes );
664                GuardScope( structsDone );
665        }
666
667        void makeTupleFunctionBody( FunctionDecl * function ) {
668                FunctionType * ftype = function->get_functionType();
669                assertf( ftype->get_parameters().size() == 1 || ftype->get_parameters().size() == 2, "too many parameters in generated tuple function" );
670
671                UntypedExpr * untyped = new UntypedExpr( new NameExpr( function->get_name() ) );
672
673                /// xxx - &* is used to make this easier for later passes to handle
674                untyped->get_args().push_back( new AddressExpr( UntypedExpr::createDeref( new VariableExpr( ftype->get_parameters().front() ) ) ) );
675                if ( ftype->get_parameters().size() == 2 ) {
676                        untyped->get_args().push_back( new VariableExpr( ftype->get_parameters().back() ) );
677                }
678                function->get_statements()->get_kids().push_back( new ExprStmt( noLabels, untyped ) );
679                function->get_statements()->get_kids().push_back( new ReturnStmt( noLabels, UntypedExpr::createDeref( new VariableExpr( ftype->get_parameters().front() ) ) ) );
680        }
681
682        void AutogenTupleRoutines::postvisit( TupleType * tupleType ) {
683                std::string mangleName = SymTab::Mangler::mangleType( tupleType );
684                if ( seenTuples.find( mangleName ) != seenTuples.end() ) return;
685                seenTuples.insert( mangleName );
686
687                // T ?=?(T *, T);
688                FunctionType *assignType = genAssignType( tupleType );
689
690                // void ?{}(T *); void ^?{}(T *);
691                FunctionType *ctorType = genDefaultType( tupleType );
692                FunctionType *dtorType = genDefaultType( tupleType );
693
694                // void ?{}(T *, T);
695                FunctionType *copyCtorType = genCopyType( tupleType );
696
697                std::set< TypeDecl* > done;
698                std::list< TypeDecl * > typeParams;
699                for ( Type * t : *tupleType ) {
700                        if ( TypeInstType * ty = dynamic_cast< TypeInstType * >( t ) ) {
701                                if ( ! done.count( ty->get_baseType() ) ) {
702                                        TypeDecl * newDecl = new TypeDecl( ty->get_baseType()->get_name(), Type::StorageClasses(), nullptr, TypeDecl::Any );
703                                        TypeInstType * inst = new TypeInstType( Type::Qualifiers(), newDecl->get_name(), newDecl );
704                                        newDecl->get_assertions().push_back( new FunctionDecl( "?=?", Type::StorageClasses(), LinkageSpec::Cforall, genAssignType( inst ), nullptr,
705                                                                                                                                                   std::list< Attribute * >(), Type::FuncSpecifiers( Type::Inline ) ) );
706                                        newDecl->get_assertions().push_back( new FunctionDecl( "?{}", Type::StorageClasses(), LinkageSpec::Cforall, genDefaultType( inst ), nullptr,
707                                                                                                                                                   std::list< Attribute * >(), Type::FuncSpecifiers( Type::Inline ) ) );
708                                        newDecl->get_assertions().push_back( new FunctionDecl( "?{}", Type::StorageClasses(), LinkageSpec::Cforall, genCopyType( inst ), nullptr,
709                                                                                                                                                   std::list< Attribute * >(), Type::FuncSpecifiers( Type::Inline ) ) );
710                                        newDecl->get_assertions().push_back( new FunctionDecl( "^?{}", Type::StorageClasses(), LinkageSpec::Cforall, genDefaultType( inst ), nullptr,
711                                                                                                                                                   std::list< Attribute * >(), Type::FuncSpecifiers( Type::Inline ) ) );
712                                        typeParams.push_back( newDecl );
713                                        done.insert( ty->get_baseType() );
714                                }
715                        }
716                }
717                cloneAll( typeParams, ctorType->get_forall() );
718                cloneAll( typeParams, dtorType->get_forall() );
719                cloneAll( typeParams, copyCtorType->get_forall() );
720                cloneAll( typeParams, assignType->get_forall() );
721
722                FunctionDecl *assignDecl = genFunc( "?=?", assignType, functionNesting );
723                FunctionDecl *ctorDecl = genFunc( "?{}", ctorType, functionNesting );
724                FunctionDecl *copyCtorDecl = genFunc( "?{}", copyCtorType, functionNesting );
725                FunctionDecl *dtorDecl = genFunc( "^?{}", dtorType, functionNesting );
726
727                makeTupleFunctionBody( assignDecl );
728                makeTupleFunctionBody( ctorDecl );
729                makeTupleFunctionBody( copyCtorDecl );
730                makeTupleFunctionBody( dtorDecl );
731
732                declsToAddBefore.push_back( ctorDecl );
733                declsToAddBefore.push_back( copyCtorDecl );
734                declsToAddBefore.push_back( dtorDecl );
735                declsToAddBefore.push_back( assignDecl ); // assignment should come last since it uses copy constructor in return
736        }
737
738        void AutogenTupleRoutines::previsit( FunctionDecl *functionDecl ) {
739                visit_children = false;
740                maybeAccept( functionDecl->type, *visitor );
741                functionNesting += 1;
742                maybeAccept( functionDecl->statements, *visitor );
743                functionNesting -= 1;
744        }
745
746        void AutogenTupleRoutines::previsit( CompoundStmt * ) {
747                GuardScope( seenTuples );
748        }
749} // SymTab
750
751// Local Variables: //
752// tab-width: 4 //
753// mode: c++ //
754// compile-command: "make install" //
755// End: //
Note: See TracBrowser for help on using the repository browser.