source: src/SymTab/Validate.cc @ 32d281d

aaron-thesisarm-ehcleanup-dtorsctordeferred_resndemanglergc_noraiijacob/cs343-translationjenkins-sandboxmemorynew-astnew-ast-unique-exprnew-envno_listpersistent-indexerresolv-newstringwith_gc
Last change on this file since 32d281d was 32d281d, checked in by Aaron Moss <a3moss@…>, 6 years ago

Fixed generic struct assignment operator generation to generify parameters

  • Property mode set to 100644
File size: 39.1 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// Validate.cc --
8//
9// Author           : Richard C. Bilson
10// Created On       : Sun May 17 21:50:04 2015
11// Last Modified By : Rob Schluntz
12// Last Modified On : Fri Nov 20 16:33:52 2015
13// Update Count     : 201
14//
15
16// The "validate" phase of translation is used to take a syntax tree and convert it into a standard form that aims to be
17// as regular in structure as possible.  Some assumptions can be made regarding the state of the tree after this pass is
18// complete, including:
19//
20// - No nested structure or union definitions; any in the input are "hoisted" to the level of the containing struct or
21//   union.
22//
23// - All enumeration constants have type EnumInstType.
24//
25// - The type "void" never occurs in lists of function parameter or return types; neither do tuple types.  A function
26//   taking no arguments has no argument types, and tuples are flattened.
27//
28// - No context instances exist; they are all replaced by the set of declarations signified by the context, instantiated
29//   by the particular set of type arguments.
30//
31// - Every declaration is assigned a unique id.
32//
33// - No typedef declarations or instances exist; the actual type is substituted for each instance.
34//
35// - Each type, struct, and union definition is followed by an appropriate assignment operator.
36//
37// - Each use of a struct or union is connected to a complete definition of that struct or union, even if that
38//   definition occurs later in the input.
39
40#include <list>
41#include <iterator>
42#include "Validate.h"
43#include "SynTree/Visitor.h"
44#include "SynTree/Mutator.h"
45#include "SynTree/Type.h"
46#include "SynTree/Statement.h"
47#include "SynTree/TypeSubstitution.h"
48#include "Indexer.h"
49#include "FixFunction.h"
50// #include "ImplementationType.h"
51#include "utility.h"
52#include "UniqueName.h"
53#include "AddVisit.h"
54#include "MakeLibCfa.h"
55#include "TypeEquality.h"
56#include "ResolvExpr/typeops.h"
57
58#define debugPrint( x ) if ( doDebug ) { std::cout << x; }
59
60namespace SymTab {
61        class HoistStruct : public Visitor {
62          public:
63                /// Flattens nested struct types
64                static void hoistStruct( std::list< Declaration * > &translationUnit );
65 
66                std::list< Declaration * > &get_declsToAdd() { return declsToAdd; }
67 
68                virtual void visit( StructDecl *aggregateDecl );
69                virtual void visit( UnionDecl *aggregateDecl );
70
71                virtual void visit( CompoundStmt *compoundStmt );
72                virtual void visit( IfStmt *ifStmt );
73                virtual void visit( WhileStmt *whileStmt );
74                virtual void visit( ForStmt *forStmt );
75                virtual void visit( SwitchStmt *switchStmt );
76                virtual void visit( ChooseStmt *chooseStmt );
77                virtual void visit( CaseStmt *caseStmt );
78                virtual void visit( CatchStmt *catchStmt );
79          private:
80                HoistStruct();
81
82                template< typename AggDecl > void handleAggregate( AggDecl *aggregateDecl );
83
84                std::list< Declaration * > declsToAdd;
85                bool inStruct;
86        };
87
88        /// Replaces enum types by int, and function or array types in function parameter and return lists by appropriate pointers
89        class Pass1 : public Visitor {
90                typedef Visitor Parent;
91                virtual void visit( EnumDecl *aggregateDecl );
92                virtual void visit( FunctionType *func );
93        };
94
95        /// Associates forward declarations of aggregates with their definitions
96        class Pass2 : public Indexer {
97                typedef Indexer Parent;
98          public:
99                Pass2( bool doDebug, const Indexer *indexer );
100          private:
101                virtual void visit( StructInstType *structInst );
102                virtual void visit( UnionInstType *unionInst );
103                virtual void visit( ContextInstType *contextInst );
104                virtual void visit( StructDecl *structDecl );
105                virtual void visit( UnionDecl *unionDecl );
106                virtual void visit( TypeInstType *typeInst );
107
108                const Indexer *indexer;
109 
110                typedef std::map< std::string, std::list< StructInstType * > > ForwardStructsType;
111                typedef std::map< std::string, std::list< UnionInstType * > > ForwardUnionsType;
112                ForwardStructsType forwardStructs;
113                ForwardUnionsType forwardUnions;
114        };
115
116        /// Replaces array and function types in forall lists by appropriate pointer type
117        class Pass3 : public Indexer {
118                typedef Indexer Parent;
119          public:
120                Pass3( const Indexer *indexer );
121          private:
122                virtual void visit( ObjectDecl *object );
123                virtual void visit( FunctionDecl *func );
124
125                const Indexer *indexer;
126        };
127
128        class AutogenerateRoutines : public Visitor {
129          public:
130                /// Generates assignment operators for aggregate types as required
131                static void autogenerateRoutines( std::list< Declaration * > &translationUnit );
132
133                std::list< Declaration * > &get_declsToAdd() { return declsToAdd; }
134 
135                virtual void visit( EnumDecl *enumDecl );
136                virtual void visit( StructDecl *structDecl );
137                virtual void visit( UnionDecl *structDecl );
138                virtual void visit( TypeDecl *typeDecl );
139                virtual void visit( ContextDecl *ctxDecl );
140                virtual void visit( FunctionDecl *functionDecl );
141
142                virtual void visit( FunctionType *ftype );
143                virtual void visit( PointerType *ftype );
144 
145                virtual void visit( CompoundStmt *compoundStmt );
146                virtual void visit( IfStmt *ifStmt );
147                virtual void visit( WhileStmt *whileStmt );
148                virtual void visit( ForStmt *forStmt );
149                virtual void visit( SwitchStmt *switchStmt );
150                virtual void visit( ChooseStmt *chooseStmt );
151                virtual void visit( CaseStmt *caseStmt );
152                virtual void visit( CatchStmt *catchStmt );
153
154                AutogenerateRoutines() : functionNesting( 0 ) {}
155          private:
156                template< typename StmtClass > void visitStatement( StmtClass *stmt );
157 
158                std::list< Declaration * > declsToAdd;
159                std::set< std::string > structsDone;
160                unsigned int functionNesting;                   // current level of nested functions
161        };
162
163        class EliminateTypedef : public Mutator {
164          public:
165          EliminateTypedef() : scopeLevel( 0 ) {}
166            /// Replaces typedefs by forward declarations
167                static void eliminateTypedef( std::list< Declaration * > &translationUnit );
168          private:
169                virtual Declaration *mutate( TypedefDecl *typeDecl );
170                virtual TypeDecl *mutate( TypeDecl *typeDecl );
171                virtual DeclarationWithType *mutate( FunctionDecl *funcDecl );
172                virtual DeclarationWithType *mutate( ObjectDecl *objDecl );
173                virtual CompoundStmt *mutate( CompoundStmt *compoundStmt );
174                virtual Type *mutate( TypeInstType *aggregateUseType );
175                virtual Expression *mutate( CastExpr *castExpr );
176
177                virtual Declaration *mutate( StructDecl * structDecl );
178                virtual Declaration *mutate( UnionDecl * unionDecl );
179                virtual Declaration *mutate( EnumDecl * enumDecl );
180                virtual Declaration *mutate( ContextDecl * contextDecl );
181
182                template<typename AggDecl>
183                AggDecl *handleAggregate( AggDecl * aggDecl );
184
185                typedef std::map< std::string, std::pair< TypedefDecl *, int > > TypedefMap;
186                TypedefMap typedefNames;
187                int scopeLevel;
188        };
189
190        void validate( std::list< Declaration * > &translationUnit, bool doDebug ) {
191                Pass1 pass1;
192                Pass2 pass2( doDebug, 0 );
193                Pass3 pass3( 0 );
194                EliminateTypedef::eliminateTypedef( translationUnit );
195                HoistStruct::hoistStruct( translationUnit );
196                acceptAll( translationUnit, pass1 );
197                acceptAll( translationUnit, pass2 );
198                AutogenerateRoutines::autogenerateRoutines( translationUnit );
199                acceptAll( translationUnit, pass3 );
200        }
201       
202        void validateType( Type *type, const Indexer *indexer ) {
203                Pass1 pass1;
204                Pass2 pass2( false, indexer );
205                Pass3 pass3( indexer );
206                type->accept( pass1 );
207                type->accept( pass2 );
208                type->accept( pass3 );
209        }
210
211        template< typename Visitor >
212        void acceptAndAdd( std::list< Declaration * > &translationUnit, Visitor &visitor, bool addBefore ) {
213                std::list< Declaration * >::iterator i = translationUnit.begin();
214                while ( i != translationUnit.end() ) {
215                        (*i)->accept( visitor );
216                        std::list< Declaration * >::iterator next = i;
217                        next++;
218                        if ( ! visitor.get_declsToAdd().empty() ) {
219                                translationUnit.splice( addBefore ? i : next, visitor.get_declsToAdd() );
220                        } // if
221                        i = next;
222                } // while
223        }
224
225        void HoistStruct::hoistStruct( std::list< Declaration * > &translationUnit ) {
226                HoistStruct hoister;
227                acceptAndAdd( translationUnit, hoister, true );
228        }
229
230        HoistStruct::HoistStruct() : inStruct( false ) {
231        }
232
233        void filter( std::list< Declaration * > &declList, bool (*pred)( Declaration * ), bool doDelete ) {
234                std::list< Declaration * >::iterator i = declList.begin();
235                while ( i != declList.end() ) {
236                        std::list< Declaration * >::iterator next = i;
237                        ++next;
238                        if ( pred( *i ) ) {
239                                if ( doDelete ) {
240                                        delete *i;
241                                } // if
242                                declList.erase( i );
243                        } // if
244                        i = next;
245                } // while
246        }
247
248        bool isStructOrUnion( Declaration *decl ) {
249                return dynamic_cast< StructDecl * >( decl ) || dynamic_cast< UnionDecl * >( decl );
250        }
251
252        template< typename AggDecl >
253        void HoistStruct::handleAggregate( AggDecl *aggregateDecl ) {
254                if ( inStruct ) {
255                        // Add elements in stack order corresponding to nesting structure.
256                        declsToAdd.push_front( aggregateDecl );
257                        Visitor::visit( aggregateDecl );
258                } else {
259                        inStruct = true;
260                        Visitor::visit( aggregateDecl );
261                        inStruct = false;
262                } // if
263                // Always remove the hoisted aggregate from the inner structure.
264                filter( aggregateDecl->get_members(), isStructOrUnion, false );
265        }
266
267        void HoistStruct::visit( StructDecl *aggregateDecl ) {
268                handleAggregate( aggregateDecl );
269        }
270
271        void HoistStruct::visit( UnionDecl *aggregateDecl ) {
272                handleAggregate( aggregateDecl );
273        }
274
275        void HoistStruct::visit( CompoundStmt *compoundStmt ) {
276                addVisit( compoundStmt, *this );
277        }
278
279        void HoistStruct::visit( IfStmt *ifStmt ) {
280                addVisit( ifStmt, *this );
281        }
282
283        void HoistStruct::visit( WhileStmt *whileStmt ) {
284                addVisit( whileStmt, *this );
285        }
286
287        void HoistStruct::visit( ForStmt *forStmt ) {
288                addVisit( forStmt, *this );
289        }
290
291        void HoistStruct::visit( SwitchStmt *switchStmt ) {
292                addVisit( switchStmt, *this );
293        }
294
295        void HoistStruct::visit( ChooseStmt *switchStmt ) {
296                addVisit( switchStmt, *this );
297        }
298
299        void HoistStruct::visit( CaseStmt *caseStmt ) {
300                addVisit( caseStmt, *this );
301        }
302
303        void HoistStruct::visit( CatchStmt *cathStmt ) {
304                addVisit( cathStmt, *this );
305        }
306
307        void Pass1::visit( EnumDecl *enumDecl ) {
308                // Set the type of each member of the enumeration to be EnumConstant
309 
310                for ( std::list< Declaration * >::iterator i = enumDecl->get_members().begin(); i != enumDecl->get_members().end(); ++i ) {
311                        ObjectDecl * obj = dynamic_cast< ObjectDecl * >( *i );
312                        assert( obj );
313                        // obj->set_type( new EnumInstType( Type::Qualifiers( true, false, false, false, false, false ), enumDecl->get_name() ) );
314                        BasicType * enumType = new BasicType( Type::Qualifiers(), BasicType::SignedInt );
315                        obj->set_type( enumType ) ;
316                } // for
317                Parent::visit( enumDecl );
318        }
319
320        namespace {
321                template< typename DWTIterator >
322                void fixFunctionList( DWTIterator begin, DWTIterator end, FunctionType *func ) {
323                        // the only case in which "void" is valid is where it is the only one in the list; then it should be removed
324                        // entirely other fix ups are handled by the FixFunction class
325                        if ( begin == end ) return;
326                        FixFunction fixer;
327                        DWTIterator i = begin;
328                        *i = (*i )->acceptMutator( fixer );
329                        if ( fixer.get_isVoid() ) {
330                                DWTIterator j = i;
331                                ++i;
332                                func->get_parameters().erase( j );
333                                if ( i != end ) { 
334                                        throw SemanticError( "invalid type void in function type ", func );
335                                } // if
336                        } else {
337                                ++i;
338                                for ( ; i != end; ++i ) {
339                                        FixFunction fixer;
340                                        *i = (*i )->acceptMutator( fixer );
341                                        if ( fixer.get_isVoid() ) {
342                                                throw SemanticError( "invalid type void in function type ", func );
343                                        } // if
344                                } // for
345                        } // if
346                }
347        }
348
349        void Pass1::visit( FunctionType *func ) {
350                // Fix up parameters and return types
351                fixFunctionList( func->get_parameters().begin(), func->get_parameters().end(), func );
352                fixFunctionList( func->get_returnVals().begin(), func->get_returnVals().end(), func );
353                Visitor::visit( func );
354        }
355
356        Pass2::Pass2( bool doDebug, const Indexer *other_indexer ) : Indexer( doDebug ) {
357                if ( other_indexer ) {
358                        indexer = other_indexer;
359                } else {
360                        indexer = this;
361                } // if
362        }
363
364        void Pass2::visit( StructInstType *structInst ) {
365                Parent::visit( structInst );
366                StructDecl *st = indexer->lookupStruct( structInst->get_name() );
367                // it's not a semantic error if the struct is not found, just an implicit forward declaration
368                if ( st ) {
369                        assert( ! structInst->get_baseStruct() || structInst->get_baseStruct()->get_members().empty() || ! st->get_members().empty() );
370                        structInst->set_baseStruct( st );
371                } // if
372                if ( ! st || st->get_members().empty() ) {
373                        // use of forward declaration
374                        forwardStructs[ structInst->get_name() ].push_back( structInst );
375                } // if
376        }
377
378        void Pass2::visit( UnionInstType *unionInst ) {
379                Parent::visit( unionInst );
380                UnionDecl *un = indexer->lookupUnion( unionInst->get_name() );
381                // it's not a semantic error if the union is not found, just an implicit forward declaration
382                if ( un ) {
383                        unionInst->set_baseUnion( un );
384                } // if
385                if ( ! un || un->get_members().empty() ) {
386                        // use of forward declaration
387                        forwardUnions[ unionInst->get_name() ].push_back( unionInst );
388                } // if
389        }
390
391        void Pass2::visit( ContextInstType *contextInst ) {
392                Parent::visit( contextInst );
393                ContextDecl *ctx = indexer->lookupContext( contextInst->get_name() );
394                if ( ! ctx ) {
395                        throw SemanticError( "use of undeclared context " + contextInst->get_name() );
396                } // if
397                for ( std::list< TypeDecl * >::const_iterator i = ctx->get_parameters().begin(); i != ctx->get_parameters().end(); ++i ) {
398                        for ( std::list< DeclarationWithType * >::const_iterator assert = (*i )->get_assertions().begin(); assert != (*i )->get_assertions().end(); ++assert ) {
399                                if ( ContextInstType *otherCtx = dynamic_cast< ContextInstType * >(*assert ) ) {
400                                        cloneAll( otherCtx->get_members(), contextInst->get_members() );
401                                } else {
402                                        contextInst->get_members().push_back( (*assert )->clone() );
403                                } // if
404                        } // for
405                } // for
406
407                if ( ctx->get_parameters().size() != contextInst->get_parameters().size() ) {
408                        throw SemanticError( "incorrect number of context parameters: ", contextInst );
409                } // if
410
411                applySubstitution( ctx->get_parameters().begin(), ctx->get_parameters().end(), contextInst->get_parameters().begin(), ctx->get_members().begin(), ctx->get_members().end(), back_inserter( contextInst->get_members() ) );
412        }
413
414        void Pass2::visit( StructDecl *structDecl ) {
415                if ( ! structDecl->get_members().empty() ) {
416                        ForwardStructsType::iterator fwds = forwardStructs.find( structDecl->get_name() );
417                        if ( fwds != forwardStructs.end() ) {
418                                for ( std::list< StructInstType * >::iterator inst = fwds->second.begin(); inst != fwds->second.end(); ++inst ) {
419                                        (*inst )->set_baseStruct( structDecl );
420                                } // for
421                                forwardStructs.erase( fwds );
422                        } // if
423                } // if
424                Indexer::visit( structDecl );
425        }
426
427        void Pass2::visit( UnionDecl *unionDecl ) {
428                if ( ! unionDecl->get_members().empty() ) {
429                        ForwardUnionsType::iterator fwds = forwardUnions.find( unionDecl->get_name() );
430                        if ( fwds != forwardUnions.end() ) {
431                                for ( std::list< UnionInstType * >::iterator inst = fwds->second.begin(); inst != fwds->second.end(); ++inst ) {
432                                        (*inst )->set_baseUnion( unionDecl );
433                                } // for
434                                forwardUnions.erase( fwds );
435                        } // if
436                } // if
437                Indexer::visit( unionDecl );
438        }
439
440        void Pass2::visit( TypeInstType *typeInst ) {
441                if ( NamedTypeDecl *namedTypeDecl = lookupType( typeInst->get_name() ) ) {
442                        if ( TypeDecl *typeDecl = dynamic_cast< TypeDecl * >( namedTypeDecl ) ) {
443                                typeInst->set_isFtype( typeDecl->get_kind() == TypeDecl::Ftype );
444                        } // if
445                } // if
446        }
447
448        Pass3::Pass3( const Indexer *other_indexer ) :  Indexer( false ) {
449                if ( other_indexer ) {
450                        indexer = other_indexer;
451                } else {
452                        indexer = this;
453                } // if
454        }
455
456        /// Fix up assertions
457        void forallFixer( Type *func ) {
458                for ( std::list< TypeDecl * >::iterator type = func->get_forall().begin(); type != func->get_forall().end(); ++type ) {
459                        std::list< DeclarationWithType * > toBeDone, nextRound;
460                        toBeDone.splice( toBeDone.end(), (*type )->get_assertions() );
461                        while ( ! toBeDone.empty() ) {
462                                for ( std::list< DeclarationWithType * >::iterator assertion = toBeDone.begin(); assertion != toBeDone.end(); ++assertion ) {
463                                        if ( ContextInstType *ctx = dynamic_cast< ContextInstType * >( (*assertion )->get_type() ) ) {
464                                                for ( std::list< Declaration * >::const_iterator i = ctx->get_members().begin(); i != ctx->get_members().end(); ++i ) {
465                                                        DeclarationWithType *dwt = dynamic_cast< DeclarationWithType * >( *i );
466                                                        assert( dwt );
467                                                        nextRound.push_back( dwt->clone() );
468                                                }
469                                                delete ctx;
470                                        } else {
471                                                FixFunction fixer;
472                                                *assertion = (*assertion )->acceptMutator( fixer );
473                                                if ( fixer.get_isVoid() ) {
474                                                        throw SemanticError( "invalid type void in assertion of function ", func );
475                                                }
476                                                (*type )->get_assertions().push_back( *assertion );
477                                        } // if
478                                } // for
479                                toBeDone.clear();
480                                toBeDone.splice( toBeDone.end(), nextRound );
481                        } // while
482                } // for
483        }
484
485        void Pass3::visit( ObjectDecl *object ) {
486                forallFixer( object->get_type() );
487                if ( PointerType *pointer = dynamic_cast< PointerType * >( object->get_type() ) ) {
488                        forallFixer( pointer->get_base() );
489                } // if
490                Parent::visit( object );
491                object->fixUniqueId();
492        }
493
494        void Pass3::visit( FunctionDecl *func ) {
495                forallFixer( func->get_type() );
496                Parent::visit( func );
497                func->fixUniqueId();
498        }
499
500        static const std::list< std::string > noLabels;
501
502        void AutogenerateRoutines::autogenerateRoutines( std::list< Declaration * > &translationUnit ) {
503                AutogenerateRoutines visitor;
504                acceptAndAdd( translationUnit, visitor, false );
505        }
506
507        template< typename OutputIterator >
508        void makeScalarAssignment( ObjectDecl *srcParam, ObjectDecl *dstParam, DeclarationWithType *member, OutputIterator out ) {
509                ObjectDecl *obj = dynamic_cast<ObjectDecl *>( member );
510                // unnamed bit fields are not copied as they cannot be accessed
511                if ( obj != NULL && obj->get_name() == "" && obj->get_bitfieldWidth() != NULL ) return;
512
513                UntypedExpr *assignExpr = new UntypedExpr( new NameExpr( "?=?" ) );
514 
515                UntypedExpr *derefExpr = new UntypedExpr( new NameExpr( "*?" ) );
516                derefExpr->get_args().push_back( new VariableExpr( dstParam ) );
517 
518                // do something special for unnamed members
519                Expression *dstselect = new AddressExpr( new MemberExpr( member, derefExpr ) );
520                assignExpr->get_args().push_back( dstselect );
521 
522                Expression *srcselect = new MemberExpr( member, new VariableExpr( srcParam ) );
523                assignExpr->get_args().push_back( srcselect );
524 
525                *out++ = new ExprStmt( noLabels, assignExpr );
526        }
527
528        template< typename OutputIterator >
529        void makeArrayAssignment( ObjectDecl *srcParam, ObjectDecl *dstParam, DeclarationWithType *member, ArrayType *array, OutputIterator out ) {
530                static UniqueName indexName( "_index" );
531 
532                // for a flexible array member nothing is done -- user must define own assignment
533                if ( ! array->get_dimension() ) return;
534 
535                ObjectDecl *index = new ObjectDecl( indexName.newName(), DeclarationNode::NoStorageClass, LinkageSpec::C, 0, new BasicType( Type::Qualifiers(), BasicType::SignedInt ), 0 );
536                *out++ = new DeclStmt( noLabels, index );
537 
538                UntypedExpr *init = new UntypedExpr( new NameExpr( "?=?" ) );
539                init->get_args().push_back( new AddressExpr( new VariableExpr( index ) ) );
540                init->get_args().push_back( new NameExpr( "0" ) );
541                Statement *initStmt = new ExprStmt( noLabels, init );
542                std::list<Statement *> initList;
543                initList.push_back( initStmt );
544 
545                UntypedExpr *cond = new UntypedExpr( new NameExpr( "?<?" ) );
546                cond->get_args().push_back( new VariableExpr( index ) );
547                cond->get_args().push_back( array->get_dimension()->clone() );
548 
549                UntypedExpr *inc = new UntypedExpr( new NameExpr( "++?" ) );
550                inc->get_args().push_back( new AddressExpr( new VariableExpr( index ) ) );
551 
552                UntypedExpr *assignExpr = new UntypedExpr( new NameExpr( "?=?" ) );
553 
554                UntypedExpr *derefExpr = new UntypedExpr( new NameExpr( "*?" ) );
555                derefExpr->get_args().push_back( new VariableExpr( dstParam ) );
556 
557                Expression *dstselect = new MemberExpr( member, derefExpr );
558                UntypedExpr *dstIndex = new UntypedExpr( new NameExpr( "?+?" ) );
559                dstIndex->get_args().push_back( dstselect );
560                dstIndex->get_args().push_back( new VariableExpr( index ) );
561                assignExpr->get_args().push_back( dstIndex );
562 
563                Expression *srcselect = new MemberExpr( member, new VariableExpr( srcParam ) );
564                UntypedExpr *srcIndex = new UntypedExpr( new NameExpr( "?[?]" ) );
565                srcIndex->get_args().push_back( srcselect );
566                srcIndex->get_args().push_back( new VariableExpr( index ) );
567                assignExpr->get_args().push_back( srcIndex );
568 
569                *out++ = new ForStmt( noLabels, initList, cond, inc, new ExprStmt( noLabels, assignExpr ) );
570        }
571
572        //E ?=?(E volatile*, int),
573        //  ?=?(E _Atomic volatile*, int);
574        void makeEnumAssignment( EnumDecl *enumDecl, EnumInstType *refType, unsigned int functionNesting, std::list< Declaration * > &declsToAdd ) {
575                FunctionType *assignType = new FunctionType( Type::Qualifiers(), false );
576 
577                ObjectDecl *returnVal = new ObjectDecl( "", DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, refType->clone(), 0 );
578                assignType->get_returnVals().push_back( returnVal );
579
580                // need two assignment operators with different types
581                FunctionType * assignType2 = assignType->clone();
582
583                // E ?=?(E volatile *, E)
584                Type *etype = refType->clone();
585                // etype->get_qualifiers() += Type::Qualifiers(false, true, false, false, false, false);
586
587                ObjectDecl *dstParam = new ObjectDecl( "_dst", DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, new PointerType( Type::Qualifiers(), etype ), 0 );
588                assignType->get_parameters().push_back( dstParam );
589
590                ObjectDecl *srcParam = new ObjectDecl( "_src", DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, etype->clone(), 0 );
591                assignType->get_parameters().push_back( srcParam );
592
593                // E ?=?(E volatile *, int)
594                assignType2->get_parameters().push_back( dstParam->clone() );
595                BasicType * paramType = new BasicType(Type::Qualifiers(), BasicType::SignedInt); 
596                ObjectDecl *srcParam2 = new ObjectDecl( "_src", DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, paramType, 0 );
597                assignType2->get_parameters().push_back( srcParam2 );
598
599                // Routines at global scope marked "static" to prevent multiple definitions is separate translation units
600                // because each unit generates copies of the default routines for each aggregate.
601
602                // since there is no definition, these should not be inline
603                // make these intrinsic so that the code generator does not make use of them
604                FunctionDecl *assignDecl = new FunctionDecl( "?=?", functionNesting > 0 ? DeclarationNode::NoStorageClass : DeclarationNode::Static, LinkageSpec::Intrinsic, assignType, 0, false, false );
605                assignDecl->fixUniqueId();
606                FunctionDecl *assignDecl2 = new FunctionDecl( "?=?", functionNesting > 0 ? DeclarationNode::NoStorageClass : DeclarationNode::Static, LinkageSpec::Intrinsic, assignType2, 0, false, false );
607                assignDecl2->fixUniqueId();
608
609                // these should be built in the same way that the prelude
610                // functions are, so build a list containing the prototypes
611                // and allow MakeLibCfa to autogenerate the bodies.
612                std::list< Declaration * > assigns;
613                assigns.push_back( assignDecl );
614                assigns.push_back( assignDecl2 );
615
616                LibCfa::makeLibCfa( assigns );
617
618                // need to remove the prototypes, since this may be nested in a routine
619                for (int start = 0, end = assigns.size()/2; start < end; start++) {
620                        delete assigns.front();
621                        assigns.pop_front();
622                } // for
623
624                declsToAdd.insert( declsToAdd.begin(), assigns.begin(), assigns.end() );
625        }
626
627        /// Clones a reference type, replacing any parameters it may have with a clone of the provided list
628        template< typename GenericInstType >
629        GenericInstType *cloneWithParams( GenericInstType *refType, const std::list< Expression* >& params ) {
630                GenericInstType *clone = refType->clone();
631                clone->get_parameters().clear();
632                cloneAll( params, clone->get_parameters() );
633                return clone;
634        }
635
636        Declaration *makeStructAssignment( StructDecl *aggregateDecl, StructInstType *refType, unsigned int functionNesting ) {
637                FunctionType *assignType = new FunctionType( Type::Qualifiers(), false );
638
639                // Make function polymorphic in same parameters as generic struct, if applicable
640                std::list< TypeDecl* >& genericParams = aggregateDecl->get_parameters();
641                std::list< Expression* > structParams;  // List of matching parameters to put on types
642                for ( std::list< TypeDecl* >::const_iterator param = genericParams.begin(); param != genericParams.end(); ++param ) {
643                        TypeDecl *typeParam = (*param)->clone();
644                        assignType->get_forall().push_back( typeParam );
645                        structParams.push_back( new TypeExpr( new TypeInstType( Type::Qualifiers(), typeParam->get_name(), typeParam ) ) );
646                }
647 
648                ObjectDecl *returnVal = new ObjectDecl( "", DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, cloneWithParams( refType, structParams ), 0 );
649                assignType->get_returnVals().push_back( returnVal );
650 
651                ObjectDecl *dstParam = new ObjectDecl( "_dst", DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, new PointerType( Type::Qualifiers(), cloneWithParams( refType, structParams ) ), 0 );
652                assignType->get_parameters().push_back( dstParam );
653 
654                ObjectDecl *srcParam = new ObjectDecl( "_src", DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, cloneWithParams( refType, structParams ), 0 );
655                assignType->get_parameters().push_back( srcParam );
656
657                // Routines at global scope marked "static" to prevent multiple definitions is separate translation units
658                // because each unit generates copies of the default routines for each aggregate.
659                FunctionDecl *assignDecl = new FunctionDecl( "?=?", functionNesting > 0 ? DeclarationNode::NoStorageClass : DeclarationNode::Static, LinkageSpec::AutoGen, assignType, new CompoundStmt( noLabels ), true, false );
660                assignDecl->fixUniqueId();
661 
662                for ( std::list< Declaration * >::const_iterator member = aggregateDecl->get_members().begin(); member != aggregateDecl->get_members().end(); ++member ) {
663                        if ( DeclarationWithType *dwt = dynamic_cast< DeclarationWithType * >( *member ) ) {
664                                // query the type qualifiers of this field and skip assigning it if it is marked const.
665                                // If it is an array type, we need to strip off the array layers to find its qualifiers.
666                                Type * type = dwt->get_type();
667                                while ( ArrayType * at = dynamic_cast< ArrayType * >( type ) ) {
668                                        type = at->get_base();
669                                }
670
671                                if ( type->get_qualifiers().isConst ) {
672                                        // don't assign const members
673                                        continue;
674                                }
675
676                                if ( ArrayType *array = dynamic_cast< ArrayType * >( dwt->get_type() ) ) {
677                                        makeArrayAssignment( srcParam, dstParam, dwt, array, back_inserter( assignDecl->get_statements()->get_kids() ) );
678                                } else {
679                                        makeScalarAssignment( srcParam, dstParam, dwt, back_inserter( assignDecl->get_statements()->get_kids() ) );
680                                } // if
681                        } // if
682                } // for
683                assignDecl->get_statements()->get_kids().push_back( new ReturnStmt( noLabels, new VariableExpr( srcParam ) ) );
684 
685                return assignDecl;
686        }
687
688        Declaration *makeUnionAssignment( UnionDecl *aggregateDecl, UnionInstType *refType, unsigned int functionNesting ) {
689                FunctionType *assignType = new FunctionType( Type::Qualifiers(), false );
690
691                // Make function polymorphic in same parameters as generic union, if applicable
692                std::list< TypeDecl* >& genericParams = aggregateDecl->get_parameters();
693                std::list< Expression* > unionParams;  // List of matching parameters to put on types
694                for ( std::list< TypeDecl* >::const_iterator param = genericParams.begin(); param != genericParams.end(); ++param ) {
695                        TypeDecl *typeParam = (*param)->clone();
696                        assignType->get_forall().push_back( typeParam );
697                        unionParams.push_back( new TypeExpr( new TypeInstType( Type::Qualifiers(), typeParam->get_name(), typeParam ) ) );
698                }
699 
700                ObjectDecl *returnVal = new ObjectDecl( "", DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, cloneWithParams( refType, unionParams ), 0 );
701                assignType->get_returnVals().push_back( returnVal );
702 
703                ObjectDecl *dstParam = new ObjectDecl( "_dst", DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, new PointerType( Type::Qualifiers(), cloneWithParams( refType, unionParams ) ), 0 );
704                assignType->get_parameters().push_back( dstParam );
705 
706                ObjectDecl *srcParam = new ObjectDecl( "_src", DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, cloneWithParams( refType, unionParams ), 0 );
707                assignType->get_parameters().push_back( srcParam );
708 
709                // Routines at global scope marked "static" to prevent multiple definitions is separate translation units
710                // because each unit generates copies of the default routines for each aggregate.
711                FunctionDecl *assignDecl = new FunctionDecl( "?=?",  functionNesting > 0 ? DeclarationNode::NoStorageClass : DeclarationNode::Static, LinkageSpec::AutoGen, assignType, new CompoundStmt( noLabels ), true, false );
712                assignDecl->fixUniqueId();
713 
714                UntypedExpr *copy = new UntypedExpr( new NameExpr( "__builtin_memcpy" ) );
715                copy->get_args().push_back( new VariableExpr( dstParam ) );
716                copy->get_args().push_back( new AddressExpr( new VariableExpr( srcParam ) ) );
717                copy->get_args().push_back( new SizeofExpr( cloneWithParams( refType, unionParams ) ) );
718
719                assignDecl->get_statements()->get_kids().push_back( new ExprStmt( noLabels, copy ) );
720                assignDecl->get_statements()->get_kids().push_back( new ReturnStmt( noLabels, new VariableExpr( srcParam ) ) );
721 
722                return assignDecl;
723        }
724
725        void AutogenerateRoutines::visit( EnumDecl *enumDecl ) {
726                if ( ! enumDecl->get_members().empty() ) {
727                        EnumInstType *enumInst = new EnumInstType( Type::Qualifiers(), enumDecl->get_name() );
728                        // enumInst->set_baseEnum( enumDecl );
729                        // declsToAdd.push_back(
730                        makeEnumAssignment( enumDecl, enumInst, functionNesting, declsToAdd );
731                }
732        }
733
734        void AutogenerateRoutines::visit( StructDecl *structDecl ) {
735                if ( ! structDecl->get_members().empty() && structsDone.find( structDecl->get_name() ) == structsDone.end() ) {
736                        StructInstType structInst( Type::Qualifiers(), structDecl->get_name() );
737                        structInst.set_baseStruct( structDecl );
738                        declsToAdd.push_back( makeStructAssignment( structDecl, &structInst, functionNesting ) );
739                        structsDone.insert( structDecl->get_name() );
740                } // if
741        }
742
743        void AutogenerateRoutines::visit( UnionDecl *unionDecl ) {
744                if ( ! unionDecl->get_members().empty() ) {
745                        UnionInstType unionInst( Type::Qualifiers(), unionDecl->get_name() );
746                        unionInst.set_baseUnion( unionDecl );
747                        declsToAdd.push_back( makeUnionAssignment( unionDecl, &unionInst, functionNesting ) );
748                } // if
749        }
750
751        void AutogenerateRoutines::visit( TypeDecl *typeDecl ) {
752                CompoundStmt *stmts = 0;
753                TypeInstType *typeInst = new TypeInstType( Type::Qualifiers(), typeDecl->get_name(), false );
754                typeInst->set_baseType( typeDecl );
755                ObjectDecl *src = new ObjectDecl( "_src", DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, typeInst->clone(), 0 );
756                ObjectDecl *dst = new ObjectDecl( "_dst", DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, new PointerType( Type::Qualifiers(), typeInst->clone() ), 0 );
757                if ( typeDecl->get_base() ) {
758                        stmts = new CompoundStmt( std::list< Label >() );
759                        UntypedExpr *assign = new UntypedExpr( new NameExpr( "?=?" ) );
760                        assign->get_args().push_back( new CastExpr( new VariableExpr( dst ), new PointerType( Type::Qualifiers(), typeDecl->get_base()->clone() ) ) );
761                        assign->get_args().push_back( new CastExpr( new VariableExpr( src ), typeDecl->get_base()->clone() ) );
762                        stmts->get_kids().push_back( new ReturnStmt( std::list< Label >(), assign ) );
763                } // if
764                FunctionType *type = new FunctionType( Type::Qualifiers(), false );
765                type->get_returnVals().push_back( new ObjectDecl( "", DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, typeInst, 0 ) );
766                type->get_parameters().push_back( dst );
767                type->get_parameters().push_back( src );
768                FunctionDecl *func = new FunctionDecl( "?=?", DeclarationNode::NoStorageClass, LinkageSpec::AutoGen, type, stmts, false, false );
769                declsToAdd.push_back( func );
770        }
771
772        void addDecls( std::list< Declaration * > &declsToAdd, std::list< Statement * > &statements, std::list< Statement * >::iterator i ) {
773                for ( std::list< Declaration * >::iterator decl = declsToAdd.begin(); decl != declsToAdd.end(); ++decl ) {
774                        statements.insert( i, new DeclStmt( noLabels, *decl ) );
775                } // for
776                declsToAdd.clear();
777        }
778
779        void AutogenerateRoutines::visit( FunctionType *) {
780                // ensure that we don't add assignment ops for types defined as part of the function
781        }
782
783        void AutogenerateRoutines::visit( PointerType *) {
784                // ensure that we don't add assignment ops for types defined as part of the pointer
785        }
786
787        void AutogenerateRoutines::visit( ContextDecl *) {
788                // ensure that we don't add assignment ops for types defined as part of the context
789        }
790
791        template< typename StmtClass >
792        inline void AutogenerateRoutines::visitStatement( StmtClass *stmt ) {
793                std::set< std::string > oldStructs = structsDone;
794                addVisit( stmt, *this );
795                structsDone = oldStructs;
796        }
797
798        void AutogenerateRoutines::visit( FunctionDecl *functionDecl ) {
799                maybeAccept( functionDecl->get_functionType(), *this );
800                acceptAll( functionDecl->get_oldDecls(), *this );
801                functionNesting += 1;
802                maybeAccept( functionDecl->get_statements(), *this );
803                functionNesting -= 1;
804        }
805
806        void AutogenerateRoutines::visit( CompoundStmt *compoundStmt ) {
807                visitStatement( compoundStmt );
808        }
809
810        void AutogenerateRoutines::visit( IfStmt *ifStmt ) {
811                visitStatement( ifStmt );
812        }
813
814        void AutogenerateRoutines::visit( WhileStmt *whileStmt ) {
815                visitStatement( whileStmt );
816        }
817
818        void AutogenerateRoutines::visit( ForStmt *forStmt ) {
819                visitStatement( forStmt );
820        }
821
822        void AutogenerateRoutines::visit( SwitchStmt *switchStmt ) {
823                visitStatement( switchStmt );
824        }
825
826        void AutogenerateRoutines::visit( ChooseStmt *switchStmt ) {
827                visitStatement( switchStmt );
828        }
829
830        void AutogenerateRoutines::visit( CaseStmt *caseStmt ) {
831                visitStatement( caseStmt );
832        }
833
834        void AutogenerateRoutines::visit( CatchStmt *cathStmt ) {
835                visitStatement( cathStmt );
836        }
837
838        bool isTypedef( Declaration *decl ) {
839                return dynamic_cast< TypedefDecl * >( decl );
840        }
841
842        void EliminateTypedef::eliminateTypedef( std::list< Declaration * > &translationUnit ) {
843                EliminateTypedef eliminator;
844                mutateAll( translationUnit, eliminator );
845                filter( translationUnit, isTypedef, true );
846        }
847
848        Type *EliminateTypedef::mutate( TypeInstType * typeInst ) {
849                // instances of typedef types will come here. If it is an instance
850                // of a typdef type, link the instance to its actual type.
851                TypedefMap::const_iterator def = typedefNames.find( typeInst->get_name() );
852                if ( def != typedefNames.end() ) {
853                        Type *ret = def->second.first->get_base()->clone();
854                        ret->get_qualifiers() += typeInst->get_qualifiers();
855                        // place instance parameters on the typedef'd type
856                        if ( ! typeInst->get_parameters().empty() ) {
857                                ReferenceToType *rtt = dynamic_cast<ReferenceToType*>(ret);
858                                if ( ! rtt ) {
859                                        throw SemanticError("cannot apply type parameters to base type of " + typeInst->get_name());
860                                }
861                                rtt->get_parameters().clear();
862                                cloneAll(typeInst->get_parameters(), rtt->get_parameters());
863                        } // if
864                        delete typeInst;
865                        return ret;
866                } // if
867                return typeInst;
868        }
869
870        Declaration *EliminateTypedef::mutate( TypedefDecl * tyDecl ) {
871                Declaration *ret = Mutator::mutate( tyDecl );
872                if ( typedefNames.count( tyDecl->get_name() ) == 1 && typedefNames[ tyDecl->get_name() ].second == scopeLevel ) {
873                        // typedef to the same name from the same scope
874                        // must be from the same type
875
876                        Type * t1 = tyDecl->get_base();
877                        Type * t2 = typedefNames[ tyDecl->get_name() ].first->get_base();
878                        if ( ! ResolvExpr::typesCompatible( t1, t2, Indexer() ) ) {
879                                throw SemanticError( "cannot redefine typedef: " + tyDecl->get_name() );
880                        }
881                } else {
882                        typedefNames[ tyDecl->get_name() ] = std::make_pair( tyDecl, scopeLevel );
883                } // if
884
885                // When a typedef is a forward declaration:
886                //    typedef struct screen SCREEN;
887                // the declaration portion must be retained:
888                //    struct screen;
889                // because the expansion of the typedef is:
890                //    void rtn( SCREEN *p ) => void rtn( struct screen *p )
891                // hence the type-name "screen" must be defined.
892                // Note, qualifiers on the typedef are superfluous for the forward declaration.
893                if ( StructInstType *aggDecl = dynamic_cast< StructInstType * >( tyDecl->get_base() ) ) {
894                        return new StructDecl( aggDecl->get_name() );
895                } else if ( UnionInstType *aggDecl = dynamic_cast< UnionInstType * >( tyDecl->get_base() ) ) {
896                        return new UnionDecl( aggDecl->get_name() );
897                } else {
898                        return ret;
899                } // if
900        }
901
902        TypeDecl *EliminateTypedef::mutate( TypeDecl * typeDecl ) {
903                TypedefMap::iterator i = typedefNames.find( typeDecl->get_name() );
904                if ( i != typedefNames.end() ) {
905                        typedefNames.erase( i ) ;
906                } // if
907                return typeDecl;
908        }
909
910        DeclarationWithType *EliminateTypedef::mutate( FunctionDecl * funcDecl ) {
911                TypedefMap oldNames = typedefNames;
912                DeclarationWithType *ret = Mutator::mutate( funcDecl );
913                typedefNames = oldNames;
914                return ret;
915        }
916
917        DeclarationWithType *EliminateTypedef::mutate( ObjectDecl * objDecl ) {
918                TypedefMap oldNames = typedefNames;
919                DeclarationWithType *ret = Mutator::mutate( objDecl );
920                typedefNames = oldNames;
921                // is the type a function?
922                if ( FunctionType *funtype = dynamic_cast<FunctionType *>( ret->get_type() ) ) {
923                        // replace the current object declaration with a function declaration
924                        return new FunctionDecl( ret->get_name(), ret->get_storageClass(), ret->get_linkage(), funtype, 0, ret->get_isInline(), ret->get_isNoreturn() );
925                } else if ( objDecl->get_isInline() || objDecl->get_isNoreturn() ) {
926                        throw SemanticError( "invalid inline or _Noreturn specification in declaration of ", objDecl );
927                } // if
928                return ret;
929        }
930
931        Expression *EliminateTypedef::mutate( CastExpr * castExpr ) {
932                TypedefMap oldNames = typedefNames;
933                Expression *ret = Mutator::mutate( castExpr );
934                typedefNames = oldNames;
935                return ret;
936        }
937
938        CompoundStmt *EliminateTypedef::mutate( CompoundStmt * compoundStmt ) {
939                TypedefMap oldNames = typedefNames;
940                scopeLevel += 1;
941                CompoundStmt *ret = Mutator::mutate( compoundStmt );
942                scopeLevel -= 1;
943                std::list< Statement * >::iterator i = compoundStmt->get_kids().begin();
944                while ( i != compoundStmt->get_kids().end() ) {
945                        std::list< Statement * >::iterator next = i+1;
946                        if ( DeclStmt *declStmt = dynamic_cast< DeclStmt * >( *i ) ) {
947                                if ( dynamic_cast< TypedefDecl * >( declStmt->get_decl() ) ) {
948                                        delete *i;
949                                        compoundStmt->get_kids().erase( i );
950                                } // if
951                        } // if
952                        i = next;
953                } // while
954                typedefNames = oldNames;
955                return ret;
956        }
957
958        // there may be typedefs nested within aggregates
959        // in order for everything to work properly, these
960        // should be removed as well
961        template<typename AggDecl>
962        AggDecl *EliminateTypedef::handleAggregate( AggDecl * aggDecl ) {
963                std::list<Declaration *>::iterator it = aggDecl->get_members().begin();
964                for ( ; it != aggDecl->get_members().end(); ) {
965                        std::list< Declaration * >::iterator next = it+1;
966                        if ( dynamic_cast< TypedefDecl * >( *it ) ) {
967                                delete *it;
968                                aggDecl->get_members().erase( it );
969                        } // if
970                        it = next;
971                }
972                return aggDecl;
973        }
974
975        Declaration *EliminateTypedef::mutate( StructDecl * structDecl ) {
976                Mutator::mutate( structDecl );
977                return handleAggregate( structDecl );
978        }
979
980        Declaration *EliminateTypedef::mutate( UnionDecl * unionDecl ) {
981                Mutator::mutate( unionDecl );
982                return handleAggregate( unionDecl );
983        }
984
985        Declaration *EliminateTypedef::mutate( EnumDecl * enumDecl ) {
986                Mutator::mutate( enumDecl );
987                return handleAggregate( enumDecl );
988        }
989
990                Declaration *EliminateTypedef::mutate( ContextDecl * contextDecl ) {
991                Mutator::mutate( contextDecl );
992                return handleAggregate( contextDecl );
993        }
994
995} // namespace SymTab
996
997// Local Variables: //
998// tab-width: 4 //
999// mode: c++ //
1000// compile-command: "make install" //
1001// End: //
Note: See TracBrowser for help on using the repository browser.