source: src/SymTab/Validate.cc @ 2ae171d8

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

Minor clean up

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