source: src/AST/Pass.hpp@ a62749f

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

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