source: src/AST/Pass.hpp @ cb25fc9

arm-ehjacob/cs343-translationnew-ast-unique-expr
Last change on this file since cb25fc9 was cb25fc9, checked in by Thierry Delisle <tdelisle@…>, 13 months ago

Added to new ast mixin for checker whether it is inFunction or not

  • Property mode set to 100644
File size: 19.5 KB
Line 
1//
2// Cforall Version 1.0.0 Copyright (C) 2019 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// Pass.hpp --
8//
9// Author           : Thierry Delisle
10// Created On       : Thu May 09 15:37:05 2019
11// Last Modified By :
12// Last Modified On :
13// Update Count     :
14//
15
16#pragma once
17// IWYU pragma: private, include "AST/Pass.hpp"
18
19#include <functional>
20#include <list>
21#include <stack>
22
23#include "AST/Fwd.hpp"
24#include "AST/Node.hpp"
25
26#include "AST/Attribute.hpp"
27#include "AST/Decl.hpp"
28#include "AST/Expr.hpp"
29#include "AST/Init.hpp"
30#include "AST/Stmt.hpp"
31#include "AST/Type.hpp"
32
33#include "AST/Visitor.hpp"
34
35#include "AST/SymbolTable.hpp"
36
37#include "AST/ForallSubstitutionTable.hpp"
38
39// Private prelude header, needed for some of the magic tricks this class pulls off
40#include "AST/Pass.proto.hpp"
41
42namespace ast {
43//-------------------------------------------------------------------------------------------------
44// Templated visitor type
45// To use declare a Pass< YOUR VISITOR TYPE >
46// The visitor type should specify the previsit/postvisit for types that are desired.
47// Note: previsit/postvisit must be **public** members
48//
49// Several additional features are available through inheritance
50// | PureVisitor           - makes the visitor pure, it never modifies nodes in place and always
51//                           clones nodes it needs to make changes to
52// | WithConstTypeSubstitution - provides polymorphic const TypeSubstitution * typeSubs for the
53//                           current expression
54// | WithStmtsToAdd        - provides the ability to insert statements before or after the current
55//                           statement by adding new statements into stmtsToAddBefore or
56//                           stmtsToAddAfter respectively.
57// | WithDeclsToAdd        - provides the ability to insert declarations before or after the
58//                           current declarations by adding new DeclStmt into declsToAddBefore or
59//                           declsToAddAfter respectively.
60// | WithShortCircuiting   - provides the ability to skip visiting child nodes; set visit_children
61//                           to false in pre{visit,visit} to skip visiting children
62// | WithGuards            - provides the ability to save/restore data like a LIFO stack; to save,
63//                           call GuardValue with the variable to save, the variable will
64//                           automatically be restored to its previous value after the
65//                           corresponding postvisit/postmutate teminates.
66// | WithVisitorRef        - provides an pointer to the templated visitor wrapper
67// | WithSymbolTable       - provides symbol table functionality
68// | WithForallSubstitutor - maintains links between TypeInstType and TypeDecl under mutation
69//
70// Other Special Members:
71// | result                - Either a method that takes no parameters or a field. If a method (or
72//                           callable field) get_result calls it, otherwise the value is returned.
73//-------------------------------------------------------------------------------------------------
74template< typename core_t >
75class Pass final : public ast::Visitor {
76public:
77        using core_type = core_t;
78        using type = Pass<core_t>;
79
80        /// Forward any arguments to the pass constructor
81        /// Propagate 'this' if necessary
82        template< typename... Args >
83        Pass( Args &&... args)
84                : core( std::forward<Args>( args )... )
85        {
86                // After the pass is constructed, check if it wants the have a pointer to the wrapping visitor
87                type * const * visitor = __pass::visitor(core, 0);
88                if(visitor) {
89                        *const_cast<type **>( visitor ) = this;
90                }
91
92                // After the pass is constructed, check if it wants to track the inFunction field
93                const bool * const * infunc_ptr = __pass::infunc_ptr(core, 0);
94                if(infunc_ptr) {
95                        *const_cast<const bool **>( infunc_ptr ) = &this->inFunction;
96                }
97        }
98
99        virtual ~Pass() = default;
100
101        /// Storage for the actual pass.
102        core_t core;
103
104        /// If the core defines a result, call it if possible, otherwise return it.
105        inline auto get_result() -> decltype( __pass::get_result( core, '0' ) ) {
106                return __pass::get_result( core, '0' );
107        }
108
109        /// Construct and run a pass on a translation unit.
110        template< typename... Args >
111        static void run( std::list< ptr<Decl> > & decls, Args &&... args ) {
112                Pass<core_t> visitor( std::forward<Args>( args )... );
113                accept_all( decls, visitor );
114        }
115
116        /// Contruct and run a pass on a pointer to extract a value.
117        template< typename node_type, typename... Args >
118        static auto read( node_type const * node, Args&&... args ) {
119                Pass<core_t> visitor( std::forward<Args>( args )... );
120                node_type const * temp = node->accept( visitor );
121                assert( temp == node );
122                return visitor.get_result();
123        }
124
125        // Versions of the above for older compilers.
126        template< typename... Args >
127        static void run( std::list< ptr<Decl> > & decls ) {
128                Pass<core_t> visitor;
129                accept_all( decls, visitor );
130        }
131
132        template< typename node_type, typename... Args >
133        static auto read( node_type const * node ) {
134                Pass<core_t> visitor;
135                node_type const * temp = node->accept( visitor );
136                assert( temp == node );
137                return visitor.get_result();
138        }
139
140        /// Visit function declarations
141        const ast::DeclWithType *     visit( const ast::ObjectDecl           * ) override final;
142        const ast::DeclWithType *     visit( const ast::FunctionDecl         * ) override final;
143        const ast::Decl *             visit( const ast::StructDecl           * ) override final;
144        const ast::Decl *             visit( const ast::UnionDecl            * ) override final;
145        const ast::Decl *             visit( const ast::EnumDecl             * ) override final;
146        const ast::Decl *             visit( const ast::TraitDecl            * ) override final;
147        const ast::Decl *             visit( const ast::TypeDecl             * ) override final;
148        const ast::Decl *             visit( const ast::TypedefDecl          * ) override final;
149        const ast::AsmDecl *          visit( const ast::AsmDecl              * ) override final;
150        const ast::StaticAssertDecl * visit( const ast::StaticAssertDecl     * ) override final;
151        const ast::CompoundStmt *     visit( const ast::CompoundStmt         * ) override final;
152        const ast::Stmt *             visit( const ast::ExprStmt             * ) override final;
153        const ast::Stmt *             visit( const ast::AsmStmt              * ) override final;
154        const ast::Stmt *             visit( const ast::DirectiveStmt        * ) override final;
155        const ast::Stmt *             visit( const ast::IfStmt               * ) override final;
156        const ast::Stmt *             visit( const ast::WhileStmt            * ) override final;
157        const ast::Stmt *             visit( const ast::ForStmt              * ) override final;
158        const ast::Stmt *             visit( const ast::SwitchStmt           * ) override final;
159        const ast::Stmt *             visit( const ast::CaseStmt             * ) override final;
160        const ast::Stmt *             visit( const ast::BranchStmt           * ) override final;
161        const ast::Stmt *             visit( const ast::ReturnStmt           * ) override final;
162        const ast::Stmt *             visit( const ast::ThrowStmt            * ) override final;
163        const ast::Stmt *             visit( const ast::TryStmt              * ) override final;
164        const ast::Stmt *             visit( const ast::CatchStmt            * ) override final;
165        const ast::Stmt *             visit( const ast::FinallyStmt          * ) override final;
166        const ast::Stmt *             visit( const ast::SuspendStmt          * ) override final;
167        const ast::Stmt *             visit( const ast::WaitForStmt          * ) override final;
168        const ast::Decl *             visit( const ast::WithStmt             * ) override final;
169        const ast::NullStmt *         visit( const ast::NullStmt             * ) override final;
170        const ast::Stmt *             visit( const ast::DeclStmt             * ) override final;
171        const ast::Stmt *             visit( const ast::ImplicitCtorDtorStmt * ) override final;
172        const ast::Expr *             visit( const ast::ApplicationExpr      * ) override final;
173        const ast::Expr *             visit( const ast::UntypedExpr          * ) override final;
174        const ast::Expr *             visit( const ast::NameExpr             * ) override final;
175        const ast::Expr *             visit( const ast::AddressExpr          * ) override final;
176        const ast::Expr *             visit( const ast::LabelAddressExpr     * ) override final;
177        const ast::Expr *             visit( const ast::CastExpr             * ) override final;
178        const ast::Expr *             visit( const ast::KeywordCastExpr      * ) override final;
179        const ast::Expr *             visit( const ast::VirtualCastExpr      * ) override final;
180        const ast::Expr *             visit( const ast::UntypedMemberExpr    * ) override final;
181        const ast::Expr *             visit( const ast::MemberExpr           * ) override final;
182        const ast::Expr *             visit( const ast::VariableExpr         * ) override final;
183        const ast::Expr *             visit( const ast::ConstantExpr         * ) override final;
184        const ast::Expr *             visit( const ast::SizeofExpr           * ) override final;
185        const ast::Expr *             visit( const ast::AlignofExpr          * ) override final;
186        const ast::Expr *             visit( const ast::UntypedOffsetofExpr  * ) override final;
187        const ast::Expr *             visit( const ast::OffsetofExpr         * ) override final;
188        const ast::Expr *             visit( const ast::OffsetPackExpr       * ) override final;
189        const ast::Expr *             visit( const ast::LogicalExpr          * ) override final;
190        const ast::Expr *             visit( const ast::ConditionalExpr      * ) override final;
191        const ast::Expr *             visit( const ast::CommaExpr            * ) override final;
192        const ast::Expr *             visit( const ast::TypeExpr             * ) override final;
193        const ast::Expr *             visit( const ast::AsmExpr              * ) override final;
194        const ast::Expr *             visit( const ast::ImplicitCopyCtorExpr * ) override final;
195        const ast::Expr *             visit( const ast::ConstructorExpr      * ) override final;
196        const ast::Expr *             visit( const ast::CompoundLiteralExpr  * ) override final;
197        const ast::Expr *             visit( const ast::RangeExpr            * ) override final;
198        const ast::Expr *             visit( const ast::UntypedTupleExpr     * ) override final;
199        const ast::Expr *             visit( const ast::TupleExpr            * ) override final;
200        const ast::Expr *             visit( const ast::TupleIndexExpr       * ) override final;
201        const ast::Expr *             visit( const ast::TupleAssignExpr      * ) override final;
202        const ast::Expr *             visit( const ast::StmtExpr             * ) override final;
203        const ast::Expr *             visit( const ast::UniqueExpr           * ) override final;
204        const ast::Expr *             visit( const ast::UntypedInitExpr      * ) override final;
205        const ast::Expr *             visit( const ast::InitExpr             * ) override final;
206        const ast::Expr *             visit( const ast::DeletedExpr          * ) override final;
207        const ast::Expr *             visit( const ast::DefaultArgExpr       * ) override final;
208        const ast::Expr *             visit( const ast::GenericExpr          * ) override final;
209        const ast::Type *             visit( const ast::VoidType             * ) override final;
210        const ast::Type *             visit( const ast::BasicType            * ) override final;
211        const ast::Type *             visit( const ast::PointerType          * ) override final;
212        const ast::Type *             visit( const ast::ArrayType            * ) override final;
213        const ast::Type *             visit( const ast::ReferenceType        * ) override final;
214        const ast::Type *             visit( const ast::QualifiedType        * ) override final;
215        const ast::Type *             visit( const ast::FunctionType         * ) override final;
216        const ast::Type *             visit( const ast::StructInstType       * ) override final;
217        const ast::Type *             visit( const ast::UnionInstType        * ) override final;
218        const ast::Type *             visit( const ast::EnumInstType         * ) override final;
219        const ast::Type *             visit( const ast::TraitInstType        * ) override final;
220        const ast::Type *             visit( const ast::TypeInstType         * ) override final;
221        const ast::Type *             visit( const ast::TupleType            * ) override final;
222        const ast::Type *             visit( const ast::TypeofType           * ) override final;
223        const ast::Type *             visit( const ast::VarArgsType          * ) override final;
224        const ast::Type *             visit( const ast::ZeroType             * ) override final;
225        const ast::Type *             visit( const ast::OneType              * ) override final;
226        const ast::Type *             visit( const ast::GlobalScopeType      * ) override final;
227        const ast::Designation *      visit( const ast::Designation          * ) override final;
228        const ast::Init *             visit( const ast::SingleInit           * ) override final;
229        const ast::Init *             visit( const ast::ListInit             * ) override final;
230        const ast::Init *             visit( const ast::ConstructorInit      * ) override final;
231        const ast::Attribute *        visit( const ast::Attribute            * ) override final;
232        const ast::TypeSubstitution * visit( const ast::TypeSubstitution     * ) override final;
233
234        template<typename core_type>
235        friend void accept_all( std::list< ptr<Decl> > & decls, Pass<core_type>& visitor );
236private:
237
238        bool __visit_children() { __pass::bool_ref * ptr = __pass::visit_children(core, 0); return ptr ? *ptr : true; }
239
240private:
241        const ast::Stmt * call_accept( const ast::Stmt * );
242        const ast::Expr * call_accept( const ast::Expr * );
243
244        // requests WithStmtsToAdd directly add to this statement, as if it is a compound.
245
246        const ast::Stmt * call_accept_as_compound(const ast::Stmt *);
247
248        template< typename node_t >
249        auto call_accept( const node_t * node ) -> typename std::enable_if<
250                                !std::is_base_of<ast::Expr, node_t>::value &&
251                                !std::is_base_of<ast::Stmt, node_t>::value
252                        , decltype( node->accept(*this) )
253                >::type;
254
255        template< template <class...> class container_t >
256        container_t< ptr<Stmt> > call_accept( const container_t< ptr<Stmt> > & );
257
258        template< template <class...> class container_t, typename node_t >
259        container_t< ptr<node_t> > call_accept( const container_t< ptr<node_t> > & container );
260
261        /// Mutate forall-list, accounting for presence of type substitution map
262        template<typename node_t>
263        void mutate_forall( const node_t *& );
264
265public:
266        /// Logic to call the accept and mutate the parent if needed, delegates call to accept
267        template<typename node_t, typename parent_t, typename child_t>
268        void maybe_accept(const node_t * &, child_t parent_t::* child);
269
270        template<typename node_t, typename parent_t, typename child_t>
271        void maybe_accept_as_compound(const node_t * &, child_t parent_t::* child);
272
273private:
274        /// Internal RAII guard for symbol table features
275        struct guard_symtab {
276                guard_symtab( Pass<core_t> & pass ): pass( pass ) { __pass::symtab::enter(pass.core, 0); }
277                ~guard_symtab()                                   { __pass::symtab::leave(pass.core, 0); }
278                Pass<core_t> & pass;
279        };
280
281        /// Internal RAII guard for scope features
282        struct guard_scope {
283                guard_scope( Pass<core_t> & pass ): pass( pass ) { __pass::scope::enter(pass.core, 0); }
284                ~guard_scope()                                   { __pass::scope::leave(pass.core, 0); }
285                Pass<core_t> & pass;
286        };
287
288        /// Internal RAII guard for forall substitutions
289        struct guard_forall_subs {
290                guard_forall_subs( Pass<core_t> & pass, const ParameterizedType * type )
291                : pass( pass ), type( type ) { __pass::forall::enter(pass.core, 0, type ); }
292                ~guard_forall_subs()         { __pass::forall::leave(pass.core, 0, type ); }
293                Pass<core_t> & pass;
294                const ParameterizedType * type;
295        };
296
297private:
298        bool inFunction = false;
299};
300
301/// Apply a pass to an entire translation unit
302template<typename core_t>
303void accept_all( std::list< ast::ptr<ast::Decl> > &, ast::Pass<core_t> & visitor );
304
305//-------------------------------------------------------------------------------------------------
306// PASS ACCESSORIES
307//-------------------------------------------------------------------------------------------------
308
309/// If used the visitor will always clone nodes.
310struct PureVisitor {};
311
312/// Keep track of the polymorphic const TypeSubstitution * typeSubs for the current expression.
313struct WithConstTypeSubstitution {
314        const TypeSubstitution * typeSubs = nullptr;
315};
316
317/// Used if visitor requires added statements before or after the current node.
318/// The Pass template handles what *before* and *after* means automatically
319template< template<class...> class container_t = std::list >
320struct WithStmtsToAdd {
321        container_t< ptr<Stmt> > stmtsToAddBefore;
322        container_t< ptr<Stmt> > stmtsToAddAfter;
323};
324
325/// Used if visitor requires added declarations before or after the current node.
326/// The Pass template handles what *before* and *after* means automatically
327template< template<class...> class container_t = std::list >
328struct WithDeclsToAdd {
329        container_t< ptr<Decl> > declsToAddBefore;
330        container_t< ptr<Decl> > declsToAddAfter;
331};
332
333/// Use if visitation should stop at certain levels
334/// set visit_children false of all child nodes should be ignored
335struct WithShortCircuiting {
336        __pass::bool_ref visit_children;
337};
338
339/// Used to restore values/functions/etc. when the Pass finishes visiting this node
340class WithGuards {
341        __pass::at_cleanup_t at_cleanup = [](__pass::cleanup_func_t, void*) {
342                std::cerr << "No cleanup function was set" << std::endl;
343                abort();
344        };
345
346        template< typename core_t>
347        friend auto __pass::at_cleanup( core_t & core, int ) -> decltype( &core.at_cleanup );
348public:
349
350        /// When this node is finished being visited, restore the value of a variable
351        template< typename T >
352        void GuardValue( T& val ) {
353                at_cleanup( [ val ]( void * newVal ) {
354                        * static_cast< T * >( newVal ) = val;
355                }, static_cast< void * >( & val ) );
356        }
357
358        /// On the object, all beginScope now and endScope when the current node is finished being visited
359        template< typename T >
360        void GuardScope( T& val ) {
361                val.beginScope();
362                at_cleanup( []( void * val ) {
363                        static_cast< T * >( val )->endScope();
364                }, static_cast< void * >( & val ) );
365        }
366
367        /// When this node is finished being visited, call a function
368        template< typename Func >
369        void GuardAction( Func func ) {
370                at_cleanup( [func](void *) { func(); }, nullptr );
371        }
372
373        /// When this node is finished being visited, call a member of an object.
374        template<typename T>
375        void GuardMethod( T * obj, void (T::*method)() ) {
376                at_cleanup( [ method ]( void * object ) {
377                        static_cast< T * >( object )->method();
378                }, static_cast< void * >( obj ) );
379        }
380};
381
382/// Used to get a pointer to the pass with its wrapped type
383template<typename core_t>
384struct WithVisitorRef {
385        Pass<core_t> * const visitor = nullptr;
386};
387
388/// Used to track whether or not we are in a function.
389class WithIsInFuncion {
390        const bool * const __in_funct_ptr = nullptr;
391
392        template<typename core_t>
393        friend class Pass;
394public:
395        bool isInFunction() {
396                assert( __in_funct_ptr );
397                return *__in_funct_ptr;
398        }
399};
400
401/// Use when the templated visitor should update the symbol table
402struct WithSymbolTable {
403        SymbolTable symtab;
404};
405
406/// Use when the templated visitor needs to keep TypeInstType instances properly linked to TypeDecl
407struct WithForallSubstitutor {
408        ForallSubstitutionTable subs;
409};
410
411}
412
413#include "Common/Stats.h"
414
415namespace ast {
416extern struct PassVisitorStats {
417        size_t depth = 0;
418        Stats::Counters::MaxCounter<double> * max;
419        Stats::Counters::AverageCounter<double> * avg;
420} pass_visitor_stats;
421}
422
423#include "AST/Pass.impl.hpp"
Note: See TracBrowser for help on using the repository browser.