source: src/AST/Pass.hpp @ 5d2db68

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

Fixed documentation and naming

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