source: src/AST/Pass.hpp @ b9fa85b

arm-ehjacob/cs343-translationnew-ast-unique-expr
Last change on this file since b9fa85b was b9fa85b, checked in by Andrew Beach <ajbeach@…>, 15 months ago

Should fix both trac #173 by porting the catch scoping hack to the new ast and the incompatability with older compiler intoduce in the read addition.

  • Property mode set to 100644
File size: 18.7 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// | WithTypeSubstitution  - provides polymorphic const TypeSubstitution * env 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
93        virtual ~Pass() = default;
94
95        /// Storage for the actual pass.
96        core_t core;
97
98        /// If the core defines a result, call it if possible, otherwise return it.
99        inline auto get_result() -> decltype( __pass::get_result( core, '0' ) ) {
100                return __pass::get_result( core, '0' );
101        }
102
103        /// Construct and run a pass on a translation unit.
104        template< typename... Args >
105        static void run( std::list< ptr<Decl> > & decls, Args &&... args ) {
106                Pass<core_t> visitor( std::forward<Args>( args )... );
107                accept_all( decls, visitor );
108        }
109
110        /// Contruct and run a pass on a pointer to extract a value.
111        template< typename node_type, typename... Args >
112        static auto read( node_type const * node, Args&&... args ) {
113                Pass<core_t> visitor( std::forward<Args>( args )... );
114                node_type const * temp = node->accept( visitor );
115                assert( temp == node );
116                return visitor.get_result();
117        }
118
119        // Versions of the above for older compilers.
120        template< typename... Args >
121        static void run( std::list< ptr<Decl> > & decls ) {
122                Pass<core_t> visitor;
123                accept_all( decls, visitor );
124        }
125
126        template< typename node_type, typename... Args >
127        static auto read( node_type const * node ) {
128                Pass<core_t> visitor;
129                node_type const * temp = node->accept( visitor );
130                assert( temp == node );
131                return visitor.get_result();
132        }
133
134        /// Visit function declarations
135        const ast::DeclWithType *     visit( const ast::ObjectDecl           * ) override final;
136        const ast::DeclWithType *     visit( const ast::FunctionDecl         * ) override final;
137        const ast::Decl *             visit( const ast::StructDecl           * ) override final;
138        const ast::Decl *             visit( const ast::UnionDecl            * ) override final;
139        const ast::Decl *             visit( const ast::EnumDecl             * ) override final;
140        const ast::Decl *             visit( const ast::TraitDecl            * ) override final;
141        const ast::Decl *             visit( const ast::TypeDecl             * ) override final;
142        const ast::Decl *             visit( const ast::TypedefDecl          * ) override final;
143        const ast::AsmDecl *          visit( const ast::AsmDecl              * ) override final;
144        const ast::StaticAssertDecl * visit( const ast::StaticAssertDecl     * ) override final;
145        const ast::CompoundStmt *     visit( const ast::CompoundStmt         * ) override final;
146        const ast::Stmt *             visit( const ast::ExprStmt             * ) override final;
147        const ast::Stmt *             visit( const ast::AsmStmt              * ) override final;
148        const ast::Stmt *             visit( const ast::DirectiveStmt        * ) override final;
149        const ast::Stmt *             visit( const ast::IfStmt               * ) override final;
150        const ast::Stmt *             visit( const ast::WhileStmt            * ) override final;
151        const ast::Stmt *             visit( const ast::ForStmt              * ) override final;
152        const ast::Stmt *             visit( const ast::SwitchStmt           * ) override final;
153        const ast::Stmt *             visit( const ast::CaseStmt             * ) override final;
154        const ast::Stmt *             visit( const ast::BranchStmt           * ) override final;
155        const ast::Stmt *             visit( const ast::ReturnStmt           * ) override final;
156        const ast::Stmt *             visit( const ast::ThrowStmt            * ) override final;
157        const ast::Stmt *             visit( const ast::TryStmt              * ) override final;
158        const ast::Stmt *             visit( const ast::CatchStmt            * ) override final;
159        const ast::Stmt *             visit( const ast::FinallyStmt          * ) override final;
160        const ast::Stmt *             visit( const ast::SuspendStmt          * ) override final;
161        const ast::Stmt *             visit( const ast::WaitForStmt          * ) override final;
162        const ast::Decl *             visit( const ast::WithStmt             * ) override final;
163        const ast::NullStmt *         visit( const ast::NullStmt             * ) override final;
164        const ast::Stmt *             visit( const ast::DeclStmt             * ) override final;
165        const ast::Stmt *             visit( const ast::ImplicitCtorDtorStmt * ) override final;
166        const ast::Expr *             visit( const ast::ApplicationExpr      * ) override final;
167        const ast::Expr *             visit( const ast::UntypedExpr          * ) override final;
168        const ast::Expr *             visit( const ast::NameExpr             * ) override final;
169        const ast::Expr *             visit( const ast::AddressExpr          * ) override final;
170        const ast::Expr *             visit( const ast::LabelAddressExpr     * ) override final;
171        const ast::Expr *             visit( const ast::CastExpr             * ) override final;
172        const ast::Expr *             visit( const ast::KeywordCastExpr      * ) override final;
173        const ast::Expr *             visit( const ast::VirtualCastExpr      * ) override final;
174        const ast::Expr *             visit( const ast::UntypedMemberExpr    * ) override final;
175        const ast::Expr *             visit( const ast::MemberExpr           * ) override final;
176        const ast::Expr *             visit( const ast::VariableExpr         * ) override final;
177        const ast::Expr *             visit( const ast::ConstantExpr         * ) override final;
178        const ast::Expr *             visit( const ast::SizeofExpr           * ) override final;
179        const ast::Expr *             visit( const ast::AlignofExpr          * ) override final;
180        const ast::Expr *             visit( const ast::UntypedOffsetofExpr  * ) override final;
181        const ast::Expr *             visit( const ast::OffsetofExpr         * ) override final;
182        const ast::Expr *             visit( const ast::OffsetPackExpr       * ) override final;
183        const ast::Expr *             visit( const ast::LogicalExpr          * ) override final;
184        const ast::Expr *             visit( const ast::ConditionalExpr      * ) override final;
185        const ast::Expr *             visit( const ast::CommaExpr            * ) override final;
186        const ast::Expr *             visit( const ast::TypeExpr             * ) override final;
187        const ast::Expr *             visit( const ast::AsmExpr              * ) override final;
188        const ast::Expr *             visit( const ast::ImplicitCopyCtorExpr * ) override final;
189        const ast::Expr *             visit( const ast::ConstructorExpr      * ) override final;
190        const ast::Expr *             visit( const ast::CompoundLiteralExpr  * ) override final;
191        const ast::Expr *             visit( const ast::RangeExpr            * ) override final;
192        const ast::Expr *             visit( const ast::UntypedTupleExpr     * ) override final;
193        const ast::Expr *             visit( const ast::TupleExpr            * ) override final;
194        const ast::Expr *             visit( const ast::TupleIndexExpr       * ) override final;
195        const ast::Expr *             visit( const ast::TupleAssignExpr      * ) override final;
196        const ast::Expr *             visit( const ast::StmtExpr             * ) override final;
197        const ast::Expr *             visit( const ast::UniqueExpr           * ) override final;
198        const ast::Expr *             visit( const ast::UntypedInitExpr      * ) override final;
199        const ast::Expr *             visit( const ast::InitExpr             * ) override final;
200        const ast::Expr *             visit( const ast::DeletedExpr          * ) override final;
201        const ast::Expr *             visit( const ast::DefaultArgExpr       * ) override final;
202        const ast::Expr *             visit( const ast::GenericExpr          * ) override final;
203        const ast::Type *             visit( const ast::VoidType             * ) override final;
204        const ast::Type *             visit( const ast::BasicType            * ) override final;
205        const ast::Type *             visit( const ast::PointerType          * ) override final;
206        const ast::Type *             visit( const ast::ArrayType            * ) override final;
207        const ast::Type *             visit( const ast::ReferenceType        * ) override final;
208        const ast::Type *             visit( const ast::QualifiedType        * ) override final;
209        const ast::Type *             visit( const ast::FunctionType         * ) override final;
210        const ast::Type *             visit( const ast::StructInstType       * ) override final;
211        const ast::Type *             visit( const ast::UnionInstType        * ) override final;
212        const ast::Type *             visit( const ast::EnumInstType         * ) override final;
213        const ast::Type *             visit( const ast::TraitInstType        * ) override final;
214        const ast::Type *             visit( const ast::TypeInstType         * ) override final;
215        const ast::Type *             visit( const ast::TupleType            * ) override final;
216        const ast::Type *             visit( const ast::TypeofType           * ) override final;
217        const ast::Type *             visit( const ast::VarArgsType          * ) override final;
218        const ast::Type *             visit( const ast::ZeroType             * ) override final;
219        const ast::Type *             visit( const ast::OneType              * ) override final;
220        const ast::Type *             visit( const ast::GlobalScopeType      * ) override final;
221        const ast::Designation *      visit( const ast::Designation          * ) override final;
222        const ast::Init *             visit( const ast::SingleInit           * ) override final;
223        const ast::Init *             visit( const ast::ListInit             * ) override final;
224        const ast::Init *             visit( const ast::ConstructorInit      * ) override final;
225        const ast::Attribute *        visit( const ast::Attribute            * ) override final;
226        const ast::TypeSubstitution * visit( const ast::TypeSubstitution     * ) override final;
227
228        template<typename core_type>
229        friend void accept_all( std::list< ptr<Decl> > & decls, Pass<core_type>& visitor );
230private:
231
232        bool __visit_children() { __pass::bool_ref * ptr = __pass::visit_children(core, 0); return ptr ? *ptr : true; }
233
234private:
235        const ast::Stmt * call_accept( const ast::Stmt * );
236        const ast::Expr * call_accept( const ast::Expr * );
237
238        template< typename node_t >
239        auto call_accept( const node_t * node ) -> typename std::enable_if<
240                                !std::is_base_of<ast::Expr, node_t>::value &&
241                                !std::is_base_of<ast::Stmt, node_t>::value
242                        , decltype( node->accept(*this) )
243                >::type;
244
245        template< template <class...> class container_t >
246        container_t< ptr<Stmt> > call_accept( const container_t< ptr<Stmt> > & );
247
248        template< template <class...> class container_t, typename node_t >
249        container_t< ptr<node_t> > call_accept( const container_t< ptr<node_t> > & container );
250
251        /// Mutate forall-list, accounting for presence of type substitution map
252        template<typename node_t>
253        void mutate_forall( const node_t *& );
254
255public:
256        /// Logic to call the accept and mutate the parent if needed, delegates call to accept
257        template<typename node_t, typename parent_t, typename child_t>
258        void maybe_accept(const node_t * &, child_t parent_t::* child);
259
260private:
261        /// Internal RAII guard for symbol table features
262        struct guard_symtab {
263                guard_symtab( Pass<core_t> & pass ): pass( pass ) { __pass::symtab::enter(pass.core, 0); }
264                ~guard_symtab()                                   { __pass::symtab::leave(pass.core, 0); }
265                Pass<core_t> & pass;
266        };
267
268        /// Internal RAII guard for scope features
269        struct guard_scope {
270                guard_scope( Pass<core_t> & pass ): pass( pass ) { __pass::scope::enter(pass.core, 0); }
271                ~guard_scope()                                   { __pass::scope::leave(pass.core, 0); }
272                Pass<core_t> & pass;
273        };
274
275        /// Internal RAII guard for forall substitutions
276        struct guard_forall_subs {
277                guard_forall_subs( Pass<core_t> & pass, const ParameterizedType * type )
278                : pass( pass ), type( type ) { __pass::forall::enter(pass.core, 0, type ); }
279                ~guard_forall_subs()         { __pass::forall::leave(pass.core, 0, type ); }
280                Pass<core_t> & pass;
281                const ParameterizedType * type;
282        };
283
284private:
285        bool inFunction = false;
286};
287
288/// Apply a pass to an entire translation unit
289template<typename core_t>
290void accept_all( std::list< ast::ptr<ast::Decl> > &, ast::Pass<core_t> & visitor );
291
292//-------------------------------------------------------------------------------------------------
293// PASS ACCESSORIES
294//-------------------------------------------------------------------------------------------------
295
296/// Keep track of the polymorphic const TypeSubstitution * env for the current expression
297
298/// If used the visitor will always clone nodes.
299struct PureVisitor {};
300
301struct WithConstTypeSubstitution {
302        const TypeSubstitution * env = nullptr;
303};
304
305/// Used if visitor requires added statements before or after the current node.
306/// The Pass template handles what *before* and *after* means automatically
307template< template<class...> class container_t = std::list >
308struct WithStmtsToAdd {
309        container_t< ptr<Stmt> > stmtsToAddBefore;
310        container_t< ptr<Stmt> > stmtsToAddAfter;
311};
312
313/// Used if visitor requires added declarations before or after the current node.
314/// The Pass template handles what *before* and *after* means automatically
315template< template<class...> class container_t = std::list >
316struct WithDeclsToAdd {
317        container_t< ptr<Decl> > declsToAddBefore;
318        container_t< ptr<Decl> > declsToAddAfter;
319};
320
321/// Use if visitation should stop at certain levels
322/// set visit_children false of all child nodes should be ignored
323struct WithShortCircuiting {
324        __pass::bool_ref visit_children;
325};
326
327/// Used to restore values/functions/etc. when the Pass finishes visiting this node
328class WithGuards {
329        __pass::at_cleanup_t at_cleanup = [](__pass::cleanup_func_t, void*) {
330                std::cerr << "No cleanup function was set" << std::endl;
331                abort();
332        };
333
334        template< typename core_t>
335        friend auto __pass::at_cleanup( core_t & core, int ) -> decltype( &core.at_cleanup );
336public:
337
338        /// When this node is finished being visited, restore the value of a variable
339        template< typename T >
340        void GuardValue( T& val ) {
341                at_cleanup( [ val ]( void * newVal ) {
342                        * static_cast< T * >( newVal ) = val;
343                }, static_cast< void * >( & val ) );
344        }
345
346        /// On the object, all beginScope now and endScope when the current node is finished being visited
347        template< typename T >
348        void GuardScope( T& val ) {
349                val.beginScope();
350                at_cleanup( []( void * val ) {
351                        static_cast< T * >( val )->endScope();
352                }, static_cast< void * >( & val ) );
353        }
354
355        /// When this node is finished being visited, call a function
356        template< typename Func >
357        void GuardAction( Func func ) {
358                at_cleanup( [func](void *) { func(); }, nullptr );
359        }
360
361        /// When this node is finished being visited, call a member of an object.
362        template<typename T>
363        void GuardMethod( T * obj, void (T::*method)() ) {
364                at_cleanup( [ method ]( void * object ) {
365                        static_cast< T * >( object )->method();
366                }, static_cast< void * >( obj ) );
367        }
368};
369
370/// Used to get a pointer to the pass with its wrapped type
371template<typename core_t>
372struct WithVisitorRef {
373        Pass<core_t> * const visitor = nullptr;
374};
375
376/// Use when the templated visitor should update the symbol table
377struct WithSymbolTable {
378        SymbolTable symtab;
379};
380
381/// Use when the templated visitor needs to keep TypeInstType instances properly linked to TypeDecl
382struct WithForallSubstitutor {
383        ForallSubstitutionTable subs;
384};
385
386}
387
388#include "Common/Stats.h"
389
390namespace ast {
391extern struct PassVisitorStats {
392        size_t depth = 0;
393        Stats::Counters::MaxCounter<double> * max;
394        Stats::Counters::AverageCounter<double> * avg;
395} pass_visitor_stats;
396}
397
398#include "AST/Pass.impl.hpp"
Note: See TracBrowser for help on using the repository browser.