source: src/AST/Pass.hpp @ 08e0d65

Last change on this file since 08e0d65 was a7efc96, checked in by Andrew Beach <ajbeach@…>, 2 months ago

Made sure a variable is always initialized and removed some trailing whitespace.
  • Property mode set to 100644
File size: 21.2 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// Private prelude header, needed for some of the magic tricks this class pulls off
38#include "AST/Pass.proto.hpp"
39
40namespace ast {
41//-------------------------------------------------------------------------------------------------
42// Templated visitor type
43// To use declare a Pass< YOUR VISITOR TYPE >
44// The visitor type should specify the previsit/postvisit for types that are desired.
45// Note: previsit/postvisit must be **public** members
46//
47// Several additional features are available through inheritance
48// | PureVisitor           - makes the visitor pure, it never modifies nodes in place and always
49//                           clones nodes it needs to make changes to
50// | WithConstTypeSubstitution - provides polymorphic const TypeSubstitution * typeSubs for the
51//                           current expression
52// | WithStmtsToAdd        - provides the ability to insert statements before or after the current
53//                           statement by adding new statements into stmtsToAddBefore or
54//                           stmtsToAddAfter respectively.
55// | WithDeclsToAdd        - provides the ability to insert declarations before or after the
56//                           current declarations by adding new DeclStmt into declsToAddBefore or
57//                           declsToAddAfter respectively.
58// | WithShortCircuiting   - provides the ability to skip visiting child nodes; set visit_children
59//                           to false in pre{visit,visit} to skip visiting children
60// | WithGuards            - provides the ability to save/restore data like a LIFO stack; to save,
61//                           call GuardValue with the variable to save, the variable will
62//                           automatically be restored to its previous value after the
63//                           corresponding postvisit/postmutate teminates.
64// | WithVisitorRef        - provides an pointer to the templated visitor wrapper
65// | WithSymbolTable       - provides symbol table functionality
66//
67// Other Special Members:
68// | beginScope            - A method with no parameters or return value, called each time the
69//                           visitor enters a block.
70// | endScope              - A method with no parameters or return value, called each time the
71//                           visitor leaves a block.
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
94        virtual ~Pass() = default;
95
96        /// Storage for the actual pass.
97        core_t core;
98
99        /// If the core defines a result, call it if possible, otherwise return it.
100        inline auto get_result() -> decltype( __pass::result::get( core, '0' ) ) {
101                return __pass::result::get( core, '0' );
102        }
103
104        /// Construct and run a pass on a translation unit.
105        template< typename... Args >
106        static void run( TranslationUnit & decls, Args &&... args ) {
107                Pass<core_t> visitor( std::forward<Args>( args )... );
108                accept_all( decls, visitor );
109        }
110
111        /// Contruct and run a pass on a pointer to extract a value.
112        template< typename node_type, typename... Args >
113        static auto read( node_type const * node, Args&&... args ) {
114                Pass<core_t> visitor( std::forward<Args>( args )... );
115                auto const * temp = node->accept( visitor );
116                assert( temp == node );
117                return visitor.get_result();
118        }
119
120        /// Visit function declarations
121        const ast::DeclWithType *     visit( const ast::ObjectDecl           * ) override final;
122        const ast::DeclWithType *     visit( const ast::FunctionDecl         * ) override final;
123        const ast::Decl *             visit( const ast::StructDecl           * ) override final;
124        const ast::Decl *             visit( const ast::UnionDecl            * ) override final;
125        const ast::Decl *             visit( const ast::EnumDecl             * ) override final;
126        const ast::Decl *             visit( const ast::TraitDecl            * ) override final;
127        const ast::Decl *             visit( const ast::TypeDecl             * ) override final;
128        const ast::Decl *             visit( const ast::TypedefDecl          * ) override final;
129        const ast::AsmDecl *          visit( const ast::AsmDecl              * ) override final;
130        const ast::DirectiveDecl *    visit( const ast::DirectiveDecl        * ) override final;
131        const ast::StaticAssertDecl * visit( const ast::StaticAssertDecl     * ) override final;
132        const ast::DeclWithType *     visit( const ast::InlineMemberDecl     * ) override final;
133        const ast::CompoundStmt *     visit( const ast::CompoundStmt         * ) override final;
134        const ast::Stmt *             visit( const ast::ExprStmt             * ) override final;
135        const ast::Stmt *             visit( const ast::AsmStmt              * ) override final;
136        const ast::Stmt *             visit( const ast::DirectiveStmt        * ) override final;
137        const ast::Stmt *             visit( const ast::IfStmt               * ) override final;
138        const ast::Stmt *             visit( const ast::WhileDoStmt          * ) override final;
139        const ast::Stmt *             visit( const ast::ForStmt              * ) override final;
140        const ast::Stmt *             visit( const ast::SwitchStmt           * ) override final;
141        const ast::CaseClause *       visit( const ast::CaseClause           * ) override final;
142        const ast::Stmt *             visit( const ast::BranchStmt           * ) override final;
143        const ast::Stmt *             visit( const ast::ReturnStmt           * ) override final;
144        const ast::Stmt *             visit( const ast::ThrowStmt            * ) override final;
145        const ast::Stmt *             visit( const ast::TryStmt              * ) override final;
146        const ast::CatchClause *      visit( const ast::CatchClause          * ) override final;
147        const ast::FinallyClause *    visit( const ast::FinallyClause        * ) override final;
148        const ast::Stmt *             visit( const ast::SuspendStmt          * ) override final;
149        const ast::WhenClause *       visit( const ast::WhenClause           * ) override final;
150        const ast::Stmt *             visit( const ast::WaitForStmt          * ) override final;
151        const ast::WaitForClause *    visit( const ast::WaitForClause        * ) override final;
152        const ast::Stmt *             visit( const ast::WaitUntilStmt        * ) override final;
153        const ast::Decl *             visit( const ast::WithStmt             * ) override final;
154        const ast::NullStmt *         visit( const ast::NullStmt             * ) override final;
155        const ast::Stmt *             visit( const ast::DeclStmt             * ) override final;
156        const ast::Stmt *             visit( const ast::ImplicitCtorDtorStmt * ) override final;
157        const ast::Stmt *             visit( const ast::MutexStmt            * ) override final;
158        const ast::Stmt *             visit( const ast::CorunStmt            * ) override final;
159        const ast::Stmt *             visit( const ast::CoforStmt            * ) override final;
160        const ast::Expr *             visit( const ast::ApplicationExpr      * ) override final;
161        const ast::Expr *             visit( const ast::UntypedExpr          * ) override final;
162        const ast::Expr *             visit( const ast::NameExpr             * ) override final;
163        const ast::Expr *             visit( const ast::QualifiedNameExpr        * ) override final;
164        const ast::Expr *             visit( const ast::AddressExpr          * ) override final;
165        const ast::Expr *             visit( const ast::LabelAddressExpr     * ) override final;
166        const ast::Expr *             visit( const ast::CastExpr             * ) override final;
167        const ast::Expr *             visit( const ast::KeywordCastExpr      * ) override final;
168        const ast::Expr *             visit( const ast::VirtualCastExpr      * ) override final;
169        const ast::Expr *             visit( const ast::UntypedMemberExpr    * ) override final;
170        const ast::Expr *             visit( const ast::MemberExpr           * ) override final;
171        const ast::Expr *             visit( const ast::VariableExpr         * ) override final;
172        const ast::Expr *             visit( const ast::ConstantExpr         * ) override final;
173        const ast::Expr *             visit( const ast::SizeofExpr           * ) override final;
174        const ast::Expr *             visit( const ast::CountExpr            * ) override final;
175        const ast::Expr *             visit( const ast::AlignofExpr          * ) override final;
176        const ast::Expr *             visit( const ast::UntypedOffsetofExpr  * ) override final;
177        const ast::Expr *             visit( const ast::OffsetofExpr         * ) override final;
178        const ast::Expr *             visit( const ast::OffsetPackExpr       * ) override final;
179        const ast::Expr *             visit( const ast::LogicalExpr          * ) override final;
180        const ast::Expr *             visit( const ast::ConditionalExpr      * ) override final;
181        const ast::Expr *             visit( const ast::CommaExpr            * ) override final;
182        const ast::Expr *             visit( const ast::TypeExpr             * ) override final;
183        const ast::Expr *             visit( const ast::DimensionExpr        * ) override final;
184        const ast::Expr *             visit( const ast::AsmExpr              * ) override final;
185        const ast::Expr *             visit( const ast::ImplicitCopyCtorExpr * ) override final;
186        const ast::Expr *             visit( const ast::ConstructorExpr      * ) override final;
187        const ast::Expr *             visit( const ast::CompoundLiteralExpr  * ) override final;
188        const ast::Expr *             visit( const ast::RangeExpr            * ) override final;
189        const ast::Expr *             visit( const ast::UntypedTupleExpr     * ) override final;
190        const ast::Expr *             visit( const ast::TupleExpr            * ) override final;
191        const ast::Expr *             visit( const ast::TupleIndexExpr       * ) override final;
192        const ast::Expr *             visit( const ast::TupleAssignExpr      * ) override final;
193        const ast::Expr *             visit( const ast::StmtExpr             * ) override final;
194        const ast::Expr *             visit( const ast::UniqueExpr           * ) override final;
195        const ast::Expr *             visit( const ast::UntypedInitExpr      * ) override final;
196        const ast::Expr *             visit( const ast::InitExpr             * ) override final;
197        const ast::Expr *             visit( const ast::DeletedExpr          * ) override final;
198        const ast::Expr *             visit( const ast::DefaultArgExpr       * ) override final;
199        const ast::Expr *             visit( const ast::GenericExpr          * ) override final;
200        const ast::Type *             visit( const ast::VoidType             * ) override final;
201        const ast::Type *             visit( const ast::BasicType            * ) override final;
202        const ast::Type *             visit( const ast::PointerType          * ) override final;
203        const ast::Type *             visit( const ast::ArrayType            * ) override final;
204        const ast::Type *             visit( const ast::ReferenceType        * ) override final;
205        const ast::Type *             visit( const ast::QualifiedType        * ) override final;
206        const ast::Type *             visit( const ast::FunctionType         * ) override final;
207        const ast::Type *             visit( const ast::StructInstType       * ) override final;
208        const ast::Type *             visit( const ast::UnionInstType        * ) override final;
209        const ast::Type *             visit( const ast::EnumInstType         * ) override final;
210        const ast::Type *             visit( const ast::TraitInstType        * ) override final;
211        const ast::Type *             visit( const ast::TypeInstType         * ) override final;
212        const ast::Type *             visit( const ast::TupleType            * ) override final;
213        const ast::Type *             visit( const ast::TypeofType           * ) override final;
214        const ast::Type *             visit( const ast::VTableType           * ) override final;
215        const ast::Type *             visit( const ast::VarArgsType          * ) override final;
216        const ast::Type *             visit( const ast::ZeroType             * ) override final;
217        const ast::Type *             visit( const ast::OneType              * ) override final;
218        const ast::Type *             visit( const ast::GlobalScopeType      * ) override final;
219        const ast::Designation *      visit( const ast::Designation          * ) override final;
220        const ast::Init *             visit( const ast::SingleInit           * ) override final;
221        const ast::Init *             visit( const ast::ListInit             * ) override final;
222        const ast::Init *             visit( const ast::ConstructorInit      * ) override final;
223        const ast::Attribute *        visit( const ast::Attribute            * ) override final;
224        const ast::TypeSubstitution * visit( const ast::TypeSubstitution     * ) override final;
225
226        template<typename core_type>
227        friend void accept_all( std::list< ptr<Decl> > & decls, Pass<core_type>& visitor );
228
229        bool isInFunction() const {
230                return inFunction;
231        }
232
233private:
234
235        bool __visit_children() { bool * ptr = __pass::visit_children(core, 0); return ptr ? *ptr : true; }
236
237private:
238
239        /// The return type of the general call_accept function.
240        template< typename node_t >
241        using call_accept_result_t = __pass::result1<
242                typename std::remove_pointer< typename std::result_of<
243                        decltype(&node_t::accept)(node_t*, type&) >::type >::type
244                >;
245
246        template< typename node_t >
247        auto call_accept( const node_t * node ) -> call_accept_result_t<node_t>;
248
249        // requests WithStmtsToAdd directly add to this statement, as if it is a compound.
250        __pass::result1<ast::Stmt> call_accept_as_compound(const ast::Stmt *);
251
252        // requests type environment to be updated (why is it implemented like this?)
253        __pass::result1<ast::Expr> call_accept_top(const ast::Expr *);
254
255        template< template <class...> class container_t >
256        __pass::resultNstmt<container_t> call_accept( const container_t< ptr<Stmt> > & );
257
258        template< template <class...> class container_t, typename node_t >
259        __pass::resultN< container_t, node_t > call_accept( const container_t< ptr<node_t> > & container );
260
261public:
262        /// Logic to call the accept and mutate the parent if needed, delegates call to accept
263        template<typename node_t, typename parent_t, typename field_t>
264        void maybe_accept(const node_t * &, field_t parent_t::* field);
265
266        template<typename node_t, typename parent_t, typename field_t>
267        void maybe_accept_as_compound(const node_t * &, field_t parent_t::* field);
268
269        template<typename node_t, typename parent_t, typename field_t>
270        void maybe_accept_top(const node_t * &, field_t parent_t::* field);
271
272private:
273        /// Internal RAII guard for symbol table features
274        struct guard_symtab {
275                guard_symtab( Pass<core_t> & pass ): pass( pass ) { __pass::symtab::enter(pass.core, 0); }
276                ~guard_symtab()                                   { __pass::symtab::leave(pass.core, 0); }
277                Pass<core_t> & pass;
278        };
279
280        /// Internal RAII guard for scope features
281        struct guard_scope {
282                guard_scope( Pass<core_t> & pass ): pass( pass ) { __pass::scope::enter(pass.core, 0); }
283                ~guard_scope()                                   { __pass::scope::leave(pass.core, 0); }
284                Pass<core_t> & pass;
285        };
286
287        /// Internal RAII guard for forall substitutions
288        struct guard_forall_subs {
289                guard_forall_subs( Pass<core_t> & pass, const FunctionType * type )
290                : pass( pass ), type( type ) { __pass::forall::enter(pass.core, 0, type ); }
291                ~guard_forall_subs()         { __pass::forall::leave(pass.core, 0, type ); }
292                Pass<core_t> & pass;
293                const FunctionType * type;
294        };
295
296private:
297        bool inFunction = false;
298        bool atFunctionTop = 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
305template<typename core_t>
306void accept_all( ast::TranslationUnit &, ast::Pass<core_t> & visitor );
307
308//-------------------------------------------------------------------------------------------------
309// PASS ACCESSORIES
310//-------------------------------------------------------------------------------------------------
311
312/// If used the visitor will always clone nodes.
313struct PureVisitor {};
314
315/// Keep track of the nearest parent node's location field.
316struct WithCodeLocation {
317        const CodeLocation * location = nullptr;
318};
319
320/// Keep track of the polymorphic const TypeSubstitution * typeSubs for the current expression.
321struct WithConstTypeSubstitution {
322        const TypeSubstitution * typeSubs = nullptr;
323};
324
325/// Used if visitor requires added statements 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 WithStmtsToAdd {
329        container_t< ptr<Stmt> > stmtsToAddBefore;
330        container_t< ptr<Stmt> > stmtsToAddAfter;
331};
332
333/// Used if visitor requires added declarations before or after the current node.
334/// The Pass template handles what *before* and *after* means automatically
335template< template<class...> class container_t = std::list >
336struct WithDeclsToAdd {
337        container_t< ptr<Decl> > declsToAddBefore;
338        container_t< ptr<Decl> > declsToAddAfter;
339};
340
341/// Use if visitation should stop at certain levels
342/// set visit_children false of all child nodes should be ignored
343struct WithShortCircuiting {
344        bool visit_children = true;
345};
346
347/// Used to restore values/functions/etc. when the Pass finishes visiting this node
348class WithGuards {
349        __pass::at_cleanup_t at_cleanup = [](__pass::cleanup_func_t, void*) {
350                std::cerr << "No cleanup function was set" << std::endl;
351                abort();
352        };
353
354        template< typename core_t >
355        friend auto __pass::make_value_guard( core_t & core, int )
356                -> decltype( __pass::value_guard( core.at_cleanup ) );
357public:
358
359        /// When this node is finished being visited, restore the value of a variable
360        /// You may assign to the return value to set the new value in the same statement.
361        template< typename T >
362        T& GuardValue( T& val ) {
363                at_cleanup( [ val ]( void * newVal ) {
364                        * static_cast< T * >( newVal ) = val;
365                }, static_cast< void * >( & val ) );
366                return val;
367        }
368
369        /// On the object, all beginScope now and endScope when the current node is finished being visited
370        template< typename T >
371        void GuardScope( T& val ) {
372                val.beginScope();
373                at_cleanup( []( void * val ) {
374                        static_cast< T * >( val )->endScope();
375                }, static_cast< void * >( & val ) );
376        }
377
378        /// When this node is finished being visited, call a function
379        template< typename Func >
380        void GuardAction( Func func ) {
381                at_cleanup( [func](void *) { func(); }, nullptr );
382        }
383};
384
385/// Used to get a pointer to the pass with its wrapped type
386template<typename core_t>
387struct WithVisitorRef {
388        Pass<core_t> * const visitor = nullptr;
389
390        bool isInFunction() const {
391                return visitor->isInFunction();
392        }
393};
394
395/// Use when the templated visitor should update the symbol table,
396/// that is, when your pass core needs to query the symbol table.
397/// Expected setups:
398/// - For master passes that kick off at the compilation unit
399///   - before resolver: extend WithSymbolTableX<IgnoreErrors>
400///   - after resolver: extend WithSymbolTable and use defaults
401///   - (FYI, for completeness, the resolver's main pass uses ValidateOnAdd when it kicks off)
402/// - For helper passes that kick off at arbitrary points in the AST:
403///   - take an existing symbol table as a parameter, extend WithSymbolTable,
404///     and construct with WithSymbolTable(const SymbolTable &)
405struct WithSymbolTable {
406        WithSymbolTable(const ast::SymbolTable & from) : symtab(from) {}
407        WithSymbolTable(ast::SymbolTable::ErrorDetection errorMode = ast::SymbolTable::ErrorDetection::AssertClean) : symtab(errorMode) {}
408        ast::SymbolTable symtab;
409};
410template <ast::SymbolTable::ErrorDetection errorMode>
411struct WithSymbolTableX : WithSymbolTable {
412        WithSymbolTableX() : WithSymbolTable(errorMode) {}
413};
414
415/// Used to get a pointer to the wrapping TranslationUnit.
416struct WithConstTranslationUnit {
417        const TranslationUnit * translationUnit = nullptr;
418
419        const TranslationUnit & transUnit() const {
420                assertf( translationUnit, "WithConstTranslationUnit not set-up." );
421                return *translationUnit;
422        }
423};
424
425}
426
427#include "Common/Stats.hpp"
428
429namespace ast {
430extern struct PassVisitorStats {
431        size_t depth = 0;
432        Stats::Counters::MaxCounter<double> * max;
433        Stats::Counters::AverageCounter<double> * avg;
434} pass_visitor_stats;
435}
436
437#include "AST/Pass.impl.hpp"
Note: See TracBrowser for help on using the repository browser.