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