source: src/SymTab/Validate.cc @ ed8a0d2

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

constructor taking an array parameter is now an error

  • Property mode set to 100644
File size: 34.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 : Peter A. Buhr
12// Last Modified On : Thu Mar 30 16:50:13 2017
13// Update Count     : 357
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.  A function
26//   taking no arguments has no argument types.
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 "Common/ScopedMap.h"
43#include "Common/utility.h"
44#include "Common/UniqueName.h"
45#include "Concurrency/Keywords.h"
46#include "Validate.h"
47#include "SynTree/Visitor.h"
48#include "SynTree/Mutator.h"
49#include "SynTree/Type.h"
50#include "SynTree/Expression.h"
51#include "SynTree/Statement.h"
52#include "SynTree/TypeSubstitution.h"
53#include "Indexer.h"
54#include "FixFunction.h"
55// #include "ImplementationType.h"
56#include "GenPoly/DeclMutator.h"
57#include "AddVisit.h"
58#include "MakeLibCfa.h"
59#include "TypeEquality.h"
60#include "Autogen.h"
61#include "ResolvExpr/typeops.h"
62#include <algorithm>
63#include "InitTweak/InitTweak.h"
64#include "CodeGen/CodeGenerator.h"
65
66#define debugPrint( x ) if ( doDebug ) { std::cout << x; }
67
68namespace SymTab {
69        class HoistStruct final : public Visitor {
70                template< typename Visitor >
71                friend void acceptAndAdd( std::list< Declaration * > &translationUnit, Visitor &visitor );
72            template< typename Visitor >
73            friend void addVisitStatementList( std::list< Statement* > &stmts, Visitor &visitor );
74          public:
75                /// Flattens nested struct types
76                static void hoistStruct( std::list< Declaration * > &translationUnit );
77
78                std::list< Declaration * > &get_declsToAdd() { return declsToAdd; }
79
80                virtual void visit( EnumInstType *enumInstType );
81                virtual void visit( StructInstType *structInstType );
82                virtual void visit( UnionInstType *unionInstType );
83                virtual void visit( StructDecl *aggregateDecl );
84                virtual void visit( UnionDecl *aggregateDecl );
85
86                virtual void visit( CompoundStmt *compoundStmt );
87                virtual void visit( SwitchStmt *switchStmt );
88          private:
89                HoistStruct();
90
91                template< typename AggDecl > void handleAggregate( AggDecl *aggregateDecl );
92
93                std::list< Declaration * > declsToAdd, declsToAddAfter;
94                bool inStruct;
95        };
96
97        /// Fix return types so that every function returns exactly one value
98        class ReturnTypeFixer final : public Visitor {
99          public:
100                typedef Visitor Parent;
101                using Parent::visit;
102
103                static void fix( std::list< Declaration * > &translationUnit );
104
105                virtual void visit( FunctionDecl * functionDecl );
106                virtual void visit( FunctionType * ftype );
107        };
108
109        /// Replaces enum types by int, and function or array types in function parameter and return lists by appropriate pointers.
110        class EnumAndPointerDecayPass final : public Visitor {
111                typedef Visitor Parent;
112                virtual void visit( EnumDecl *aggregateDecl );
113                virtual void visit( FunctionType *func );
114        };
115
116        /// Associates forward declarations of aggregates with their definitions
117        class LinkReferenceToTypes final : public Indexer {
118                typedef Indexer Parent;
119          public:
120                LinkReferenceToTypes( bool doDebug, const Indexer *indexer );
121          private:
122                using Parent::visit;
123                void visit( EnumInstType *enumInst ) final;
124                void visit( StructInstType *structInst ) final;
125                void visit( UnionInstType *unionInst ) final;
126                void visit( TraitInstType *contextInst ) final;
127                void visit( EnumDecl *enumDecl ) final;
128                void visit( StructDecl *structDecl ) final;
129                void visit( UnionDecl *unionDecl ) final;
130                void visit( TypeInstType *typeInst ) final;
131
132                const Indexer *indexer;
133
134                typedef std::map< std::string, std::list< EnumInstType * > > ForwardEnumsType;
135                typedef std::map< std::string, std::list< StructInstType * > > ForwardStructsType;
136                typedef std::map< std::string, std::list< UnionInstType * > > ForwardUnionsType;
137                ForwardEnumsType forwardEnums;
138                ForwardStructsType forwardStructs;
139                ForwardUnionsType forwardUnions;
140        };
141
142        /// Replaces array and function types in forall lists by appropriate pointer type
143        class Pass3 final : public Indexer {
144                typedef Indexer Parent;
145          public:
146                using Parent::visit;
147                Pass3( const Indexer *indexer );
148          private:
149                virtual void visit( ObjectDecl *object ) override;
150                virtual void visit( FunctionDecl *func ) override;
151
152                const Indexer *indexer;
153        };
154
155        class ReturnChecker : public Visitor {
156          public:
157                /// Checks that return statements return nothing if their return type is void
158                /// and return something if the return type is non-void.
159                static void checkFunctionReturns( std::list< Declaration * > & translationUnit );
160          private:
161                virtual void visit( FunctionDecl * functionDecl );
162                virtual void visit( ReturnStmt * returnStmt );
163
164                std::list< DeclarationWithType * > returnVals;
165        };
166
167        class EliminateTypedef : public Mutator {
168          public:
169                EliminateTypedef() : scopeLevel( 0 ) {}
170                /// Replaces typedefs by forward declarations
171                static void eliminateTypedef( std::list< Declaration * > &translationUnit );
172          private:
173                virtual Declaration *mutate( TypedefDecl *typeDecl );
174                virtual TypeDecl *mutate( TypeDecl *typeDecl );
175                virtual DeclarationWithType *mutate( FunctionDecl *funcDecl );
176                virtual DeclarationWithType *mutate( ObjectDecl *objDecl );
177                virtual CompoundStmt *mutate( CompoundStmt *compoundStmt );
178                virtual Type *mutate( TypeInstType *aggregateUseType );
179                virtual Expression *mutate( CastExpr *castExpr );
180
181                virtual Declaration *mutate( StructDecl * structDecl );
182                virtual Declaration *mutate( UnionDecl * unionDecl );
183                virtual Declaration *mutate( EnumDecl * enumDecl );
184                virtual Declaration *mutate( TraitDecl * contextDecl );
185
186                template<typename AggDecl>
187                AggDecl *handleAggregate( AggDecl * aggDecl );
188
189                template<typename AggDecl>
190                void addImplicitTypedef( AggDecl * aggDecl );
191
192                typedef std::unique_ptr<TypedefDecl> TypedefDeclPtr;
193                typedef ScopedMap< std::string, std::pair< TypedefDeclPtr, int > > TypedefMap;
194                typedef std::map< std::string, TypeDecl * > TypeDeclMap;
195                TypedefMap typedefNames;
196                TypeDeclMap typedeclNames;
197                int scopeLevel;
198        };
199
200        class VerifyCtorDtorAssign : public Visitor {
201        public:
202                /// ensure that constructors, destructors, and assignment have at least one
203                /// parameter, the first of which must be a pointer, and that ctor/dtors have no
204                /// return values.
205                static void verify( std::list< Declaration * > &translationUnit );
206
207                virtual void visit( FunctionDecl *funcDecl );
208        };
209
210        class ArrayLength : public Visitor {
211        public:
212                /// for array types without an explicit length, compute the length and store it so that it
213                /// is known to the rest of the phases. For example,
214                ///   int x[] = { 1, 2, 3 };
215                ///   int y[][2] = { { 1, 2, 3 }, { 1, 2, 3 } };
216                /// here x and y are known at compile-time to have length 3, so change this into
217                ///   int x[3] = { 1, 2, 3 };
218                ///   int y[3][2] = { { 1, 2, 3 }, { 1, 2, 3 } };
219                static void computeLength( std::list< Declaration * > & translationUnit );
220
221                virtual void visit( ObjectDecl * objDecl );
222        };
223
224        class CompoundLiteral final : public GenPoly::DeclMutator {
225                Type::StorageClasses storageClasses;
226
227                using GenPoly::DeclMutator::mutate;
228                DeclarationWithType * mutate( ObjectDecl *objectDecl ) final;
229                Expression *mutate( CompoundLiteralExpr *compLitExpr ) final;
230        };
231
232        void validate( std::list< Declaration * > &translationUnit, bool doDebug ) {
233                EnumAndPointerDecayPass epc;
234                LinkReferenceToTypes lrt( doDebug, 0 );
235                Pass3 pass3( 0 );
236                CompoundLiteral compoundliteral;
237
238                HoistStruct::hoistStruct( translationUnit );
239                EliminateTypedef::eliminateTypedef( translationUnit );
240                ReturnTypeFixer::fix( translationUnit ); // must happen before autogen
241                acceptAll( translationUnit, lrt ); // must happen before autogen, because sized flag needs to propagate to generated functions
242                acceptAll( translationUnit, epc ); // must happen before VerifyCtorDtorAssign, because void return objects should not exist
243                VerifyCtorDtorAssign::verify( translationUnit );  // must happen before autogen, because autogen examines existing ctor/dtors
244                Concurrency::applyKeywords( translationUnit );
245                autogenerateRoutines( translationUnit ); // moved up, used to be below compoundLiteral - currently needs EnumAndPointerDecayPass
246                Concurrency::implementMutexFuncs( translationUnit );
247                Concurrency::implementThreadStarter( translationUnit );
248                ReturnChecker::checkFunctionReturns( translationUnit );
249                compoundliteral.mutateDeclarationList( translationUnit );
250                acceptAll( translationUnit, pass3 );
251                ArrayLength::computeLength( translationUnit );
252        }
253
254        void validateType( Type *type, const Indexer *indexer ) {
255                EnumAndPointerDecayPass epc;
256                LinkReferenceToTypes lrt( false, indexer );
257                Pass3 pass3( indexer );
258                type->accept( epc );
259                type->accept( lrt );
260                type->accept( pass3 );
261        }
262
263        void HoistStruct::hoistStruct( std::list< Declaration * > &translationUnit ) {
264                HoistStruct hoister;
265                acceptAndAdd( translationUnit, hoister );
266        }
267
268        HoistStruct::HoistStruct() : inStruct( false ) {
269        }
270
271        void filter( std::list< Declaration * > &declList, bool (*pred)( Declaration * ), bool doDelete ) {
272                std::list< Declaration * >::iterator i = declList.begin();
273                while ( i != declList.end() ) {
274                        std::list< Declaration * >::iterator next = i;
275                        ++next;
276                        if ( pred( *i ) ) {
277                                if ( doDelete ) {
278                                        delete *i;
279                                } // if
280                                declList.erase( i );
281                        } // if
282                        i = next;
283                } // while
284        }
285
286        bool isStructOrUnion( Declaration *decl ) {
287                return dynamic_cast< StructDecl * >( decl ) || dynamic_cast< UnionDecl * >( decl );
288        }
289
290        template< typename AggDecl >
291        void HoistStruct::handleAggregate( AggDecl *aggregateDecl ) {
292                if ( inStruct ) {
293                        // Add elements in stack order corresponding to nesting structure.
294                        declsToAdd.push_front( aggregateDecl );
295                        Visitor::visit( aggregateDecl );
296                } else {
297                        inStruct = true;
298                        Visitor::visit( aggregateDecl );
299                        inStruct = false;
300                } // if
301                // Always remove the hoisted aggregate from the inner structure.
302                filter( aggregateDecl->get_members(), isStructOrUnion, false );
303        }
304
305        void HoistStruct::visit( EnumInstType *structInstType ) {
306                if ( structInstType->get_baseEnum() ) {
307                        declsToAdd.push_front( structInstType->get_baseEnum() );
308                }
309        }
310
311        void HoistStruct::visit( StructInstType *structInstType ) {
312                if ( structInstType->get_baseStruct() ) {
313                        declsToAdd.push_front( structInstType->get_baseStruct() );
314                }
315        }
316
317        void HoistStruct::visit( UnionInstType *structInstType ) {
318                if ( structInstType->get_baseUnion() ) {
319                        declsToAdd.push_front( structInstType->get_baseUnion() );
320                }
321        }
322
323        void HoistStruct::visit( StructDecl *aggregateDecl ) {
324                handleAggregate( aggregateDecl );
325        }
326
327        void HoistStruct::visit( UnionDecl *aggregateDecl ) {
328                handleAggregate( aggregateDecl );
329        }
330
331        void HoistStruct::visit( CompoundStmt *compoundStmt ) {
332                addVisit( compoundStmt, *this );
333        }
334
335        void HoistStruct::visit( SwitchStmt *switchStmt ) {
336                addVisit( switchStmt, *this );
337        }
338
339        void EnumAndPointerDecayPass::visit( EnumDecl *enumDecl ) {
340                // Set the type of each member of the enumeration to be EnumConstant
341                for ( std::list< Declaration * >::iterator i = enumDecl->get_members().begin(); i != enumDecl->get_members().end(); ++i ) {
342                        ObjectDecl * obj = dynamic_cast< ObjectDecl * >( *i );
343                        assert( obj );
344                        obj->set_type( new EnumInstType( Type::Qualifiers( Type::Const ), enumDecl->get_name() ) );
345                } // for
346                Parent::visit( enumDecl );
347        }
348
349        namespace {
350                template< typename DWTList >
351                void fixFunctionList( DWTList & dwts, FunctionType * func ) {
352                        // the only case in which "void" is valid is where it is the only one in the list; then it should be removed
353                        // entirely other fix ups are handled by the FixFunction class
354                        typedef typename DWTList::iterator DWTIterator;
355                        DWTIterator begin( dwts.begin() ), end( dwts.end() );
356                        if ( begin == end ) return;
357                        FixFunction fixer;
358                        DWTIterator i = begin;
359                        *i = (*i)->acceptMutator( fixer );
360                        if ( fixer.get_isVoid() ) {
361                                DWTIterator j = i;
362                                ++i;
363                                delete *j;
364                                dwts.erase( j );
365                                if ( i != end ) {
366                                        throw SemanticError( "invalid type void in function type ", func );
367                                } // if
368                        } else {
369                                ++i;
370                                for ( ; i != end; ++i ) {
371                                        FixFunction fixer;
372                                        *i = (*i )->acceptMutator( fixer );
373                                        if ( fixer.get_isVoid() ) {
374                                                throw SemanticError( "invalid type void in function type ", func );
375                                        } // if
376                                } // for
377                        } // if
378                }
379        }
380
381        void EnumAndPointerDecayPass::visit( FunctionType *func ) {
382                // Fix up parameters and return types
383                fixFunctionList( func->get_parameters(), func );
384                fixFunctionList( func->get_returnVals(), func );
385                Visitor::visit( func );
386        }
387
388        LinkReferenceToTypes::LinkReferenceToTypes( bool doDebug, const Indexer *other_indexer ) : Indexer( doDebug ) {
389                if ( other_indexer ) {
390                        indexer = other_indexer;
391                } else {
392                        indexer = this;
393                } // if
394        }
395
396        void LinkReferenceToTypes::visit( EnumInstType *enumInst ) {
397                Parent::visit( enumInst );
398                EnumDecl *st = indexer->lookupEnum( enumInst->get_name() );
399                // it's not a semantic error if the enum is not found, just an implicit forward declaration
400                if ( st ) {
401                        //assert( ! enumInst->get_baseEnum() || enumInst->get_baseEnum()->get_members().empty() || ! st->get_members().empty() );
402                        enumInst->set_baseEnum( st );
403                } // if
404                if ( ! st || st->get_members().empty() ) {
405                        // use of forward declaration
406                        forwardEnums[ enumInst->get_name() ].push_back( enumInst );
407                } // if
408        }
409
410        void LinkReferenceToTypes::visit( StructInstType *structInst ) {
411                Parent::visit( structInst );
412                StructDecl *st = indexer->lookupStruct( structInst->get_name() );
413                // it's not a semantic error if the struct is not found, just an implicit forward declaration
414                if ( st ) {
415                        //assert( ! structInst->get_baseStruct() || structInst->get_baseStruct()->get_members().empty() || ! st->get_members().empty() );
416                        structInst->set_baseStruct( st );
417                } // if
418                if ( ! st || st->get_members().empty() ) {
419                        // use of forward declaration
420                        forwardStructs[ structInst->get_name() ].push_back( structInst );
421                } // if
422        }
423
424        void LinkReferenceToTypes::visit( UnionInstType *unionInst ) {
425                Parent::visit( unionInst );
426                UnionDecl *un = indexer->lookupUnion( unionInst->get_name() );
427                // it's not a semantic error if the union is not found, just an implicit forward declaration
428                if ( un ) {
429                        unionInst->set_baseUnion( un );
430                } // if
431                if ( ! un || un->get_members().empty() ) {
432                        // use of forward declaration
433                        forwardUnions[ unionInst->get_name() ].push_back( unionInst );
434                } // if
435        }
436
437        void LinkReferenceToTypes::visit( TraitInstType *traitInst ) {
438                Parent::visit( traitInst );
439                if ( traitInst->get_name() == "sized" ) {
440                        // "sized" is a special trait with no members - just flick the sized status on for the type variable
441                        if ( traitInst->get_parameters().size() != 1 ) {
442                                throw SemanticError( "incorrect number of trait parameters: ", traitInst );
443                        }
444                        TypeExpr * param = safe_dynamic_cast< TypeExpr * > ( traitInst->get_parameters().front() );
445                        TypeInstType * inst = safe_dynamic_cast< TypeInstType * > ( param->get_type() );
446                        TypeDecl * decl = inst->get_baseType();
447                        decl->set_sized( true );
448                        // since "sized" is special, the next few steps don't apply
449                        return;
450                }
451                TraitDecl *traitDecl = indexer->lookupTrait( traitInst->get_name() );
452                if ( ! traitDecl ) {
453                        throw SemanticError( "use of undeclared trait " + traitInst->get_name() );
454                } // if
455                if ( traitDecl->get_parameters().size() != traitInst->get_parameters().size() ) {
456                        throw SemanticError( "incorrect number of trait parameters: ", traitInst );
457                } // if
458
459                for ( TypeDecl * td : traitDecl->get_parameters() ) {
460                        for ( DeclarationWithType * assert : td->get_assertions() ) {
461                                traitInst->get_members().push_back( assert->clone() );
462                        } // for
463                } // for
464
465                // need to clone members of the trait for ownership purposes
466                std::list< Declaration * > members;
467                std::transform( traitDecl->get_members().begin(), traitDecl->get_members().end(), back_inserter( members ), [](Declaration * dwt) { return dwt->clone(); } );
468
469                applySubstitution( traitDecl->get_parameters().begin(), traitDecl->get_parameters().end(), traitInst->get_parameters().begin(), members.begin(), members.end(), back_inserter( traitInst->get_members() ) );
470
471                // need to carry over the 'sized' status of each decl in the instance
472                for ( auto p : group_iterate( traitDecl->get_parameters(), traitInst->get_parameters() ) ) {
473                        TypeExpr * expr = safe_dynamic_cast< TypeExpr * >( std::get<1>(p) );
474                        if ( TypeInstType * inst = dynamic_cast< TypeInstType * >( expr->get_type() ) ) {
475                                TypeDecl * formalDecl = std::get<0>(p);
476                                TypeDecl * instDecl = inst->get_baseType();
477                                if ( formalDecl->get_sized() ) instDecl->set_sized( true );
478                        }
479                }
480        }
481
482        void LinkReferenceToTypes::visit( EnumDecl *enumDecl ) {
483                // visit enum members first so that the types of self-referencing members are updated properly
484                Parent::visit( enumDecl );
485                if ( ! enumDecl->get_members().empty() ) {
486                        ForwardEnumsType::iterator fwds = forwardEnums.find( enumDecl->get_name() );
487                        if ( fwds != forwardEnums.end() ) {
488                                for ( std::list< EnumInstType * >::iterator inst = fwds->second.begin(); inst != fwds->second.end(); ++inst ) {
489                                        (*inst )->set_baseEnum( enumDecl );
490                                } // for
491                                forwardEnums.erase( fwds );
492                        } // if
493                } // if
494        }
495
496        void LinkReferenceToTypes::visit( StructDecl *structDecl ) {
497                // visit struct members first so that the types of self-referencing members are updated properly
498                Parent::visit( structDecl );
499                if ( ! structDecl->get_members().empty() ) {
500                        ForwardStructsType::iterator fwds = forwardStructs.find( structDecl->get_name() );
501                        if ( fwds != forwardStructs.end() ) {
502                                for ( std::list< StructInstType * >::iterator inst = fwds->second.begin(); inst != fwds->second.end(); ++inst ) {
503                                        (*inst )->set_baseStruct( structDecl );
504                                } // for
505                                forwardStructs.erase( fwds );
506                        } // if
507                } // if
508        }
509
510        void LinkReferenceToTypes::visit( UnionDecl *unionDecl ) {
511                Parent::visit( unionDecl );
512                if ( ! unionDecl->get_members().empty() ) {
513                        ForwardUnionsType::iterator fwds = forwardUnions.find( unionDecl->get_name() );
514                        if ( fwds != forwardUnions.end() ) {
515                                for ( std::list< UnionInstType * >::iterator inst = fwds->second.begin(); inst != fwds->second.end(); ++inst ) {
516                                        (*inst )->set_baseUnion( unionDecl );
517                                } // for
518                                forwardUnions.erase( fwds );
519                        } // if
520                } // if
521        }
522
523        void LinkReferenceToTypes::visit( TypeInstType *typeInst ) {
524                if ( NamedTypeDecl *namedTypeDecl = lookupType( typeInst->get_name() ) ) {
525                        if ( TypeDecl *typeDecl = dynamic_cast< TypeDecl * >( namedTypeDecl ) ) {
526                                typeInst->set_isFtype( typeDecl->get_kind() == TypeDecl::Ftype );
527                        } // if
528                } // if
529        }
530
531        Pass3::Pass3( const Indexer *other_indexer ) :  Indexer( false ) {
532                if ( other_indexer ) {
533                        indexer = other_indexer;
534                } else {
535                        indexer = this;
536                } // if
537        }
538
539        /// Fix up assertions - flattens assertion lists, removing all trait instances
540        void forallFixer( Type * func ) {
541                for ( TypeDecl * type : func->get_forall() ) {
542                        std::list< DeclarationWithType * > toBeDone, nextRound;
543                        toBeDone.splice( toBeDone.end(), type->get_assertions() );
544                        while ( ! toBeDone.empty() ) {
545                                for ( DeclarationWithType * assertion : toBeDone ) {
546                                        if ( TraitInstType *traitInst = dynamic_cast< TraitInstType * >( assertion->get_type() ) ) {
547                                                // expand trait instance into all of its members
548                                                for ( Declaration * member : traitInst->get_members() ) {
549                                                        DeclarationWithType *dwt = safe_dynamic_cast< DeclarationWithType * >( member );
550                                                        nextRound.push_back( dwt->clone() );
551                                                }
552                                                delete traitInst;
553                                        } else {
554                                                // pass assertion through
555                                                FixFunction fixer;
556                                                assertion = assertion->acceptMutator( fixer );
557                                                if ( fixer.get_isVoid() ) {
558                                                        throw SemanticError( "invalid type void in assertion of function ", func );
559                                                }
560                                                type->get_assertions().push_back( assertion );
561                                        } // if
562                                } // for
563                                toBeDone.clear();
564                                toBeDone.splice( toBeDone.end(), nextRound );
565                        } // while
566                } // for
567        }
568
569        void Pass3::visit( ObjectDecl *object ) {
570                forallFixer( object->get_type() );
571                if ( PointerType *pointer = dynamic_cast< PointerType * >( object->get_type() ) ) {
572                        forallFixer( pointer->get_base() );
573                } // if
574                Parent::visit( object );
575                object->fixUniqueId();
576        }
577
578        void Pass3::visit( FunctionDecl *func ) {
579                forallFixer( func->get_type() );
580                Parent::visit( func );
581                func->fixUniqueId();
582        }
583
584        void ReturnChecker::checkFunctionReturns( std::list< Declaration * > & translationUnit ) {
585                ReturnChecker checker;
586                acceptAll( translationUnit, checker );
587        }
588
589        void ReturnChecker::visit( FunctionDecl * functionDecl ) {
590                std::list< DeclarationWithType * > oldReturnVals = returnVals;
591                returnVals = functionDecl->get_functionType()->get_returnVals();
592                Visitor::visit( functionDecl );
593                returnVals = oldReturnVals;
594        }
595
596        void ReturnChecker::visit( ReturnStmt * returnStmt ) {
597                // Previously this also checked for the existence of an expr paired with no return values on
598                // the  function return type. This is incorrect, since you can have an expression attached to
599                // a return statement in a void-returning function in C. The expression is treated as if it
600                // were cast to void.
601                if ( returnStmt->get_expr() == NULL && returnVals.size() != 0 ) {
602                        throw SemanticError( "Non-void function returns no values: " , returnStmt );
603                }
604        }
605
606
607        bool isTypedef( Declaration *decl ) {
608                return dynamic_cast< TypedefDecl * >( decl );
609        }
610
611        void EliminateTypedef::eliminateTypedef( std::list< Declaration * > &translationUnit ) {
612                EliminateTypedef eliminator;
613                mutateAll( translationUnit, eliminator );
614                if ( eliminator.typedefNames.count( "size_t" ) ) {
615                        // grab and remember declaration of size_t
616                        SizeType = eliminator.typedefNames["size_t"].first->get_base()->clone();
617                } else {
618                        // xxx - missing global typedef for size_t - default to long unsigned int, even though that may be wrong
619                        // eventually should have a warning for this case.
620                        SizeType = new BasicType( Type::Qualifiers(), BasicType::LongUnsignedInt );
621                }
622                filter( translationUnit, isTypedef, true );
623
624        }
625
626        Type *EliminateTypedef::mutate( TypeInstType * typeInst ) {
627                // instances of typedef types will come here. If it is an instance
628                // of a typdef type, link the instance to its actual type.
629                TypedefMap::const_iterator def = typedefNames.find( typeInst->get_name() );
630                if ( def != typedefNames.end() ) {
631                        Type *ret = def->second.first->get_base()->clone();
632                        ret->get_qualifiers() |= typeInst->get_qualifiers();
633                        // place instance parameters on the typedef'd type
634                        if ( ! typeInst->get_parameters().empty() ) {
635                                ReferenceToType *rtt = dynamic_cast<ReferenceToType*>(ret);
636                                if ( ! rtt ) {
637                                        throw SemanticError("cannot apply type parameters to base type of " + typeInst->get_name());
638                                }
639                                rtt->get_parameters().clear();
640                                cloneAll( typeInst->get_parameters(), rtt->get_parameters() );
641                                mutateAll( rtt->get_parameters(), *this );  // recursively fix typedefs on parameters
642                        } // if
643                        delete typeInst;
644                        return ret;
645                } else {
646                        TypeDeclMap::const_iterator base = typedeclNames.find( typeInst->get_name() );
647                        assertf( base != typedeclNames.end(), "Can't find typedecl name %s", typeInst->get_name().c_str() );
648                        typeInst->set_baseType( base->second );
649                } // if
650                return typeInst;
651        }
652
653        Declaration *EliminateTypedef::mutate( TypedefDecl * tyDecl ) {
654                Declaration *ret = Mutator::mutate( tyDecl );
655
656                if ( typedefNames.count( tyDecl->get_name() ) == 1 && typedefNames[ tyDecl->get_name() ].second == scopeLevel ) {
657                        // typedef to the same name from the same scope
658                        // must be from the same type
659
660                        Type * t1 = tyDecl->get_base();
661                        Type * t2 = typedefNames[ tyDecl->get_name() ].first->get_base();
662                        if ( ! ResolvExpr::typesCompatible( t1, t2, Indexer() ) ) {
663                                throw SemanticError( "cannot redefine typedef: " + tyDecl->get_name() );
664                        }
665                } else {
666                        typedefNames[ tyDecl->get_name() ] = std::make_pair( TypedefDeclPtr( tyDecl ), scopeLevel );
667                } // if
668
669                // When a typedef is a forward declaration:
670                //    typedef struct screen SCREEN;
671                // the declaration portion must be retained:
672                //    struct screen;
673                // because the expansion of the typedef is:
674                //    void rtn( SCREEN *p ) => void rtn( struct screen *p )
675                // hence the type-name "screen" must be defined.
676                // Note, qualifiers on the typedef are superfluous for the forward declaration.
677
678                Type *designatorType = tyDecl->get_base()->stripDeclarator();
679                if ( StructInstType *aggDecl = dynamic_cast< StructInstType * >( designatorType ) ) {
680                        return new StructDecl( aggDecl->get_name() );
681                } else if ( UnionInstType *aggDecl = dynamic_cast< UnionInstType * >( designatorType ) ) {
682                        return new UnionDecl( aggDecl->get_name() );
683                } else if ( EnumInstType *enumDecl = dynamic_cast< EnumInstType * >( designatorType ) ) {
684                        return new EnumDecl( enumDecl->get_name() );
685                } else {
686                        return ret->clone();
687                } // if
688        }
689
690        TypeDecl *EliminateTypedef::mutate( TypeDecl * typeDecl ) {
691                TypedefMap::iterator i = typedefNames.find( typeDecl->get_name() );
692                if ( i != typedefNames.end() ) {
693                        typedefNames.erase( i ) ;
694                } // if
695
696                typedeclNames[ typeDecl->get_name() ] = typeDecl;
697                return Mutator::mutate( typeDecl );
698        }
699
700        DeclarationWithType *EliminateTypedef::mutate( FunctionDecl * funcDecl ) {
701                typedefNames.beginScope();
702                DeclarationWithType *ret = Mutator::mutate( funcDecl );
703                typedefNames.endScope();
704                return ret;
705        }
706
707        DeclarationWithType *EliminateTypedef::mutate( ObjectDecl * objDecl ) {
708                typedefNames.beginScope();
709                DeclarationWithType *ret = Mutator::mutate( objDecl );
710                typedefNames.endScope();
711
712                if ( FunctionType *funtype = dynamic_cast<FunctionType *>( ret->get_type() ) ) { // function type?
713                        // replace the current object declaration with a function declaration
714                        FunctionDecl * newDecl = new FunctionDecl( ret->get_name(), ret->get_storageClasses(), ret->get_linkage(), funtype, 0, objDecl->get_attributes(), ret->get_funcSpec() );
715                        objDecl->get_attributes().clear();
716                        objDecl->set_type( nullptr );
717                        delete objDecl;
718                        return newDecl;
719                } // if
720                return ret;
721        }
722
723        Expression *EliminateTypedef::mutate( CastExpr * castExpr ) {
724                typedefNames.beginScope();
725                Expression *ret = Mutator::mutate( castExpr );
726                typedefNames.endScope();
727                return ret;
728        }
729
730        CompoundStmt *EliminateTypedef::mutate( CompoundStmt * compoundStmt ) {
731                typedefNames.beginScope();
732                scopeLevel += 1;
733                CompoundStmt *ret = Mutator::mutate( compoundStmt );
734                scopeLevel -= 1;
735                std::list< Statement * >::iterator i = compoundStmt->get_kids().begin();
736                while ( i != compoundStmt->get_kids().end() ) {
737                        std::list< Statement * >::iterator next = i+1;
738                        if ( DeclStmt *declStmt = dynamic_cast< DeclStmt * >( *i ) ) {
739                                if ( dynamic_cast< TypedefDecl * >( declStmt->get_decl() ) ) {
740                                        delete *i;
741                                        compoundStmt->get_kids().erase( i );
742                                } // if
743                        } // if
744                        i = next;
745                } // while
746                typedefNames.endScope();
747                return ret;
748        }
749
750        // there may be typedefs nested within aggregates. in order for everything to work properly, these should be removed
751        // as well
752        template<typename AggDecl>
753        AggDecl *EliminateTypedef::handleAggregate( AggDecl * aggDecl ) {
754                std::list<Declaration *>::iterator it = aggDecl->get_members().begin();
755                for ( ; it != aggDecl->get_members().end(); ) {
756                        std::list< Declaration * >::iterator next = it+1;
757                        if ( dynamic_cast< TypedefDecl * >( *it ) ) {
758                                delete *it;
759                                aggDecl->get_members().erase( it );
760                        } // if
761                        it = next;
762                }
763                return aggDecl;
764        }
765
766        template<typename AggDecl>
767        void EliminateTypedef::addImplicitTypedef( AggDecl * aggDecl ) {
768                if ( typedefNames.count( aggDecl->get_name() ) == 0 ) {
769                        Type *type = nullptr;
770                        if ( StructDecl * newDeclStructDecl = dynamic_cast< StructDecl * >( aggDecl ) ) {
771                                type = new StructInstType( Type::Qualifiers(), newDeclStructDecl->get_name() );
772                        } else if ( UnionDecl * newDeclUnionDecl = dynamic_cast< UnionDecl * >( aggDecl ) ) {
773                                type = new UnionInstType( Type::Qualifiers(), newDeclUnionDecl->get_name() );
774                        } else if ( EnumDecl * newDeclEnumDecl = dynamic_cast< EnumDecl * >( aggDecl )  ) {
775                                type = new EnumInstType( Type::Qualifiers(), newDeclEnumDecl->get_name() );
776                        } // if
777                        TypedefDeclPtr tyDecl( new TypedefDecl( aggDecl->get_name(), Type::StorageClasses(), type ) );
778                        typedefNames[ aggDecl->get_name() ] = std::make_pair( std::move( tyDecl ), scopeLevel );
779                } // if
780        }
781
782        Declaration *EliminateTypedef::mutate( StructDecl * structDecl ) {
783                addImplicitTypedef( structDecl );
784                Mutator::mutate( structDecl );
785                return handleAggregate( structDecl );
786        }
787
788        Declaration *EliminateTypedef::mutate( UnionDecl * unionDecl ) {
789                addImplicitTypedef( unionDecl );
790                Mutator::mutate( unionDecl );
791                return handleAggregate( unionDecl );
792        }
793
794        Declaration *EliminateTypedef::mutate( EnumDecl * enumDecl ) {
795                addImplicitTypedef( enumDecl );
796                Mutator::mutate( enumDecl );
797                return handleAggregate( enumDecl );
798        }
799
800        Declaration *EliminateTypedef::mutate( TraitDecl * contextDecl ) {
801                Mutator::mutate( contextDecl );
802                return handleAggregate( contextDecl );
803        }
804
805        void VerifyCtorDtorAssign::verify( std::list< Declaration * > & translationUnit ) {
806                VerifyCtorDtorAssign verifier;
807                acceptAll( translationUnit, verifier );
808        }
809
810        void VerifyCtorDtorAssign::visit( FunctionDecl * funcDecl ) {
811                FunctionType * funcType = funcDecl->get_functionType();
812                std::list< DeclarationWithType * > &returnVals = funcType->get_returnVals();
813                std::list< DeclarationWithType * > &params = funcType->get_parameters();
814
815                if ( InitTweak::isCtorDtorAssign( funcDecl->get_name() ) ) {
816                        if ( params.size() == 0 ) {
817                                throw SemanticError( "Constructors, destructors, and assignment functions require at least one parameter ", funcDecl );
818                        }
819                        PointerType * ptrType = dynamic_cast< PointerType * >( params.front()->get_type() );
820                        if ( ! ptrType || ptrType->is_array() ) {
821                                throw SemanticError( "First parameter of a constructor, destructor, or assignment function must be a pointer ", funcDecl );
822                        }
823                        if ( InitTweak::isCtorDtor( funcDecl->get_name() ) && returnVals.size() != 0 ) {
824                                throw SemanticError( "Constructors and destructors cannot have explicit return values ", funcDecl );
825                        }
826                }
827
828                Visitor::visit( funcDecl );
829        }
830
831        DeclarationWithType * CompoundLiteral::mutate( ObjectDecl *objectDecl ) {
832                storageClasses = objectDecl->get_storageClasses();
833                DeclarationWithType * temp = Mutator::mutate( objectDecl );
834                return temp;
835        }
836
837        Expression *CompoundLiteral::mutate( CompoundLiteralExpr *compLitExpr ) {
838                // transform [storage_class] ... (struct S){ 3, ... };
839                // into [storage_class] struct S temp =  { 3, ... };
840                static UniqueName indexName( "_compLit" );
841
842                ObjectDecl *tempvar = new ObjectDecl( indexName.newName(), storageClasses, LinkageSpec::C, 0, compLitExpr->get_result(), compLitExpr->get_initializer() );
843                compLitExpr->set_result( 0 );
844                compLitExpr->set_initializer( 0 );
845                delete compLitExpr;
846                DeclarationWithType * newtempvar = mutate( tempvar );
847                addDeclaration( newtempvar );                                   // add modified temporary to current block
848                return new VariableExpr( newtempvar );
849        }
850
851        void ReturnTypeFixer::fix( std::list< Declaration * > &translationUnit ) {
852                ReturnTypeFixer fixer;
853                acceptAll( translationUnit, fixer );
854        }
855
856        void ReturnTypeFixer::visit( FunctionDecl * functionDecl ) {
857                Parent::visit( functionDecl );
858                FunctionType * ftype = functionDecl->get_functionType();
859                std::list< DeclarationWithType * > & retVals = ftype->get_returnVals();
860                assertf( retVals.size() == 0 || retVals.size() == 1, "Function %s has too many return values: %d", functionDecl->get_name().c_str(), retVals.size() );
861                if ( retVals.size() == 1 ) {
862                        // ensure all function return values have a name - use the name of the function to disambiguate (this also provides a nice bit of help for debugging).
863                        // ensure other return values have a name.
864                        DeclarationWithType * ret = retVals.front();
865                        if ( ret->get_name() == "" ) {
866                                ret->set_name( toString( "_retval_", CodeGen::genName( functionDecl ) ) );
867                        }
868                }
869        }
870
871        void ReturnTypeFixer::visit( FunctionType * ftype ) {
872                // xxx - need to handle named return values - this information needs to be saved somehow
873                // so that resolution has access to the names.
874                // Note that this pass needs to happen early so that other passes which look for tuple types
875                // find them in all of the right places, including function return types.
876                std::list< DeclarationWithType * > & retVals = ftype->get_returnVals();
877                if ( retVals.size() > 1 ) {
878                        // generate a single return parameter which is the tuple of all of the return values
879                        TupleType * tupleType = safe_dynamic_cast< TupleType * >( ResolvExpr::extractResultType( ftype ) );
880                        // ensure return value is not destructed by explicitly creating an empty ListInit node wherein maybeConstruct is false.
881                        ObjectDecl * newRet = new ObjectDecl( "", Type::StorageClasses(), LinkageSpec::Cforall, 0, tupleType, new ListInit( std::list<Initializer*>(), noDesignators, false ) );
882                        deleteAll( retVals );
883                        retVals.clear();
884                        retVals.push_back( newRet );
885                }
886        }
887
888        void ArrayLength::computeLength( std::list< Declaration * > & translationUnit ) {
889                ArrayLength len;
890                acceptAll( translationUnit, len );
891        }
892
893        void ArrayLength::visit( ObjectDecl * objDecl ) {
894                if ( ArrayType * at = dynamic_cast< ArrayType * >( objDecl->get_type() ) ) {
895                        if ( at->get_dimension() != nullptr ) return;
896                        if ( ListInit * init = dynamic_cast< ListInit * >( objDecl->get_init() ) ) {
897                                at->set_dimension( new ConstantExpr( Constant::from_ulong( init->get_initializers().size() ) ) );
898                        }
899                }
900        }
901} // namespace SymTab
902
903// Local Variables: //
904// tab-width: 4 //
905// mode: c++ //
906// compile-command: "make install" //
907// End: //
Note: See TracBrowser for help on using the repository browser.