source: src/AST/Pass.hpp@ 4fe6224

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

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