source: src/SymTab/Validate.cc @ 6fa9e71

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

Fix error handling for VLA typedefs

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