source: src/AST/Pass.hpp@ a3ade94

ADT arm-eh ast-experimental enum forall-pointer-decay jacob/cs343-translation new-ast-unique-expr pthread-emulation qualifiedEnum
Last change on this file since a3ade94 was 73f1b1c, checked in by Andrew Beach <ajbeach@…>, 5 years ago

Cleaned up comments from the PureVisitor addition.

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