source: src/SymTab/Validate.cc @ 522363e

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

Fix PassVisitor? Indexer calls, aggregate top-level errors in PassVisitor?, convert ForallPointerDecay? and LinkReferenceToTypes? to PassVisitor?

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