source: src/AST/Pass.proto.hpp@ 8abee136

ADT arm-eh ast-experimental cleanup-dtors enum forall-pointer-decay jacob/cs343-translation jenkins-sandbox new-ast new-ast-unique-expr pthread-emulation qualifiedEnum
Last change on this file since 8abee136 was b0abc8a0, checked in by Thierry Delisle <tdelisle@…>, 6 years ago

Fixed errors in the pass visitor
  • Property mode set to 100644
File size: 10.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.impl.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 "Pass.hpp"
18
19namespace ast {
20template<typename pass_type>
21class Pass;
22
23namespace __pass {
24 typedef std::function<void( void * )> cleanup_func_t;
25 typedef std::function<void( cleanup_func_t, void * )> at_cleanup_t;
26
27
28 // boolean reference that may be null
29 // either refers to a boolean value or is null and returns true
30 class bool_ref {
31 public:
32 bool_ref() = default;
33 ~bool_ref() = default;
34
35 operator bool() { return m_ref ? *m_ref : true; }
36 bool operator=( bool val ) { assert(m_ref); return *m_ref = val; }
37
38 private:
39
40 friend class visit_children_guard;
41
42 bool * set( bool * val ) {
43 bool * prev = m_ref;
44 m_ref = val;
45 return prev;
46 }
47
48 bool * m_ref = nullptr;
49 };
50
51 // Implementation of the guard value
52 // Created inside the visit scope
53 class guard_value {
54 public:
55 /// Push onto the cleanup
56 guard_value( at_cleanup_t * at_cleanup ) {
57 if( at_cleanup ) {
58 *at_cleanup = [this]( cleanup_func_t && func, void* val ) {
59 push( std::move( func ), val );
60 };
61 }
62 }
63
64 ~guard_value() {
65 while( !cleanups.empty() ) {
66 auto& cleanup = cleanups.top();
67 cleanup.func( cleanup.val );
68 cleanups.pop();
69 }
70 }
71
72 void push( cleanup_func_t && func, void* val ) {
73 cleanups.emplace( std::move(func), val );
74 }
75
76 private:
77 struct cleanup_t {
78 cleanup_func_t func;
79 void * val;
80
81 cleanup_t( cleanup_func_t&& func, void * val ) : func(func), val(val) {}
82 };
83
84 std::stack< cleanup_t > cleanups;
85 };
86
87 // Guard structure implementation for whether or not children should be visited
88 class visit_children_guard {
89 public:
90
91 visit_children_guard( bool_ref * ref )
92 : m_val ( true )
93 , m_prev( ref ? ref->set( &m_val ) : nullptr )
94 , m_ref ( ref )
95 {}
96
97 ~visit_children_guard() {
98 if( m_ref ) {
99 m_ref->set( m_prev );
100 }
101 }
102
103 operator bool() { return m_val; }
104
105 private:
106 bool m_val;
107 bool * m_prev;
108 bool_ref * m_ref;
109 };
110
111 //-------------------------------------------------------------------------------------------------------------------------------------------------------------------------
112 // Deep magic (a.k.a template meta programming) to make the templated visitor work
113 // Basically the goal is to make 2 previsit
114 // 1 - Use when a pass implements a valid previsit. This uses overloading which means the any overload of
115 // 'pass.previsit( node )' that compiles will be used for that node for that type
116 // This requires that this option only compile for passes that actually define an appropriate visit.
117 // SFINAE will make sure the compilation errors in this function don't halt the build.
118 // See http://en.cppreference.com/w/cpp/language/sfinae for details on SFINAE
119 // 2 - Since the first implementation might not be specilizable, the second implementation exists and does nothing.
120 // This is needed only to eliminate the need for passes to specify any kind of handlers.
121 // The second implementation only works because it has a lower priority. This is due to the bogus last parameter.
122 // The second implementation takes a long while the first takes an int. Since the caller always passes an literal 0
123 // the first implementation takes priority in regards to overloading.
124 //-------------------------------------------------------------------------------------------------------------------------------------------------------------------------
125 // PreVisit : may mutate the pointer passed in if the node is mutated in the previsit call
126 template<typename pass_t, typename node_t>
127 static inline auto previsit( pass_t & pass, const node_t * & node, int ) -> decltype( pass.previsit( node ), void() ) {
128 static_assert(
129 std::is_base_of<const node_t, typename std::remove_pointer<decltype( pass.previsit( node ) )>::type >::value,
130 "Previsit may not change the type of the node. Use postvisit instead."
131 );
132 node = pass.previsit( node );
133 assert(node);
134 }
135
136 template<typename pass_t, typename node_t>
137 static inline auto previsit( pass_t &, const node_t *, long ) {}
138
139 // PostVisit : never mutates the passed pointer but may return a different node
140 template<typename pass_t, typename node_t>
141 static inline auto postvisit( pass_t & pass, const node_t * node, int ) -> decltype( pass.postvisit( node ), (const node_t *)nullptr ) {
142 return pass.postvisit( node );
143 }
144
145 template<typename pass_t, typename node_t>
146 static inline const node_t * postvisit( pass_t &, const node_t * node, long ) { return node; }
147
148 //-------------------------------------------------------------------------------------------------------------------------------------------------------------------------
149 // Deep magic (a.k.a template meta programming) continued
150 // To make the templated visitor be more expressive, we allow 'accessories' : classes/structs the implementation can inherit
151 // from in order to get extra functionallity for example
152 // class ErrorChecker : WithShortCircuiting { ... };
153 // Pass<ErrorChecker> checker;
154 // this would define a pass that uses the templated visitor with the additionnal feature that it has short circuiting
155 // Note that in all cases the accessories are not required but guarantee the requirements of the feature is matched
156 //-------------------------------------------------------------------------------------------------------------------------------------------------------------------------
157 // For several accessories, the feature is enabled by detecting that a specific field is present
158 // Use a macro the encapsulate the logic of detecting a particular field
159 // The type is not strictly enforced but does match the accessory
160 #define FIELD_PTR( name, default_type ) \
161 template< typename pass_t > \
162 static inline auto name( pass_t & pass, int ) -> decltype( &pass.name ) { return &pass.name; } \
163 \
164 template< typename pass_t > \
165 static inline default_type * name( pass_t &, long ) { return nullptr; }
166
167 // List of fields and their expected types
168 FIELD_PTR( env, const ast::TypeSubstitution * )
169 FIELD_PTR( stmtsToAddBefore, std::list< ast::ptr< ast::Stmt > > )
170 FIELD_PTR( stmtsToAddAfter , std::list< ast::ptr< ast::Stmt > > )
171 FIELD_PTR( declsToAddBefore, std::list< ast::ptr< ast::Decl > > )
172 FIELD_PTR( declsToAddAfter , std::list< ast::ptr< ast::Decl > > )
173 FIELD_PTR( visit_children, __pass::bool_ref )
174 FIELD_PTR( at_cleanup, __pass::at_cleanup_t )
175 FIELD_PTR( visitor, ast::Pass<pass_t> * const )
176
177 // Remove the macro to make sure we don't clash
178 #undef FIELD_PTR
179
180 // Another feature of the templated visitor is that it calls beginScope()/endScope() for compound statement.
181 // All passes which have such functions are assumed desire this behaviour
182 // detect it using the same strategy
183 namespace scope {
184 template<typename pass_t>
185 static inline auto enter( pass_t & pass, int ) -> decltype( pass.beginScope(), void() ) {
186 pass.beginScope();
187 }
188
189 template<typename pass_t>
190 static inline void enter( pass_t &, long ) {}
191
192 template<typename pass_t>
193 static inline auto leave( pass_t & pass, int ) -> decltype( pass.endScope(), void() ) {
194 pass.endScope();
195 }
196
197 template<typename pass_t>
198 static inline void leave( pass_t &, long ) {}
199 };
200
201 // Finally certain pass desire an up to date indexer automatically
202 // detect the presence of a member name indexer and call all the members appropriately
203 namespace indexer {
204 // Some simple scoping rules
205 template<typename pass_t>
206 static inline auto enter( pass_t & pass, int ) -> decltype( pass.indexer.enterScope(), void() ) {
207 pass.indexer.enterScope();
208 }
209
210 template<typename pass_t>
211 static inline auto enter( pass_t &, long ) {}
212
213 template<typename pass_t>
214 static inline auto leave( pass_t & pass, int ) -> decltype( pass.indexer.leaveScope(), void() ) {
215 pass.indexer.leaveScope();
216 }
217
218 template<typename pass_t>
219 static inline auto leave( pass_t &, long ) {}
220
221 // The indexer has 2 kind of functions mostly, 1 argument and 2 arguments
222 // Create macro to condense these common patterns
223 #define INDEXER_FUNC1( func, type ) \
224 template<typename pass_t> \
225 static inline auto func( pass_t & pass, int, type arg ) -> decltype( pass.indexer.func( arg ), void() ) {\
226 pass.indexer.func( arg ); \
227 } \
228 \
229 template<typename pass_t> \
230 static inline void func( pass_t &, long, type ) {}
231
232 #define INDEXER_FUNC2( func, type1, type2 ) \
233 template<typename pass_t> \
234 static inline auto func( pass_t & pass, int, type1 arg1, type2 arg2 ) -> decltype( pass.indexer.func( arg1, arg2 ), void () ) {\
235 pass.indexer.func( arg1, arg2 ); \
236 } \
237 \
238 template<typename pass_t> \
239 static inline void func( pass_t &, long, type1, type2 ) {}
240
241 INDEXER_FUNC1( addId , const DeclWithType * );
242 INDEXER_FUNC1( addType , const NamedTypeDecl * );
243 INDEXER_FUNC1( addStruct , const StructDecl * );
244 INDEXER_FUNC1( addEnum , const EnumDecl * );
245 INDEXER_FUNC1( addUnion , const UnionDecl * );
246 INDEXER_FUNC1( addTrait , const TraitDecl * );
247 INDEXER_FUNC2( addWith , const std::vector< ptr<Expr> > &, const Node * );
248 INDEXER_FUNC2( addWith , const std::list < ptr<Expr> > &, const Node * );
249
250 // A few extra functions have more complicated behaviour, they are hand written
251 template<typename pass_t>
252 static inline auto addStructFwd( pass_t & pass, int, const ast::StructDecl * decl ) -> decltype( pass.indexer.addStruct( decl ), void() ) {
253 ast::StructDecl * fwd = new ast::StructDecl( decl->location, decl->name );
254 fwd->params = decl->params;
255 pass.indexer.addStruct( fwd );
256 }
257
258 template<typename pass_t>
259 static inline void addStructFwd( pass_t &, long, const ast::StructDecl * ) {}
260
261 template<typename pass_t>
262 static inline auto addUnionFwd( pass_t & pass, int, const ast::UnionDecl * decl ) -> decltype( pass.indexer.addUnion( decl ), void() ) {
263 UnionDecl * fwd = new UnionDecl( decl->location, decl->name );
264 fwd->params = decl->params;
265 pass.indexer.addUnion( fwd );
266 }
267
268 template<typename pass_t>
269 static inline void addUnionFwd( pass_t &, long, const ast::UnionDecl * ) {}
270
271 template<typename pass_t>
272 static inline auto addStruct( pass_t & pass, int, const std::string & str ) -> decltype( pass.indexer.addStruct( str ), void() ) {
273 if ( ! pass.indexer.lookupStruct( str ) ) {
274 pass.indexer.addStruct( str );
275 }
276 }
277
278 template<typename pass_t>
279 static inline void addStruct( pass_t &, long, const std::string & ) {}
280
281 template<typename pass_t>
282 static inline auto addUnion( pass_t & pass, int, const std::string & str ) -> decltype( pass.indexer.addUnion( str ), void() ) {
283 if ( ! pass.indexer.lookupUnion( str ) ) {
284 pass.indexer.addUnion( str );
285 }
286 }
287
288 template<typename pass_t>
289 static inline void addUnion( pass_t &, long, const std::string & ) {}
290
291 #undef INDEXER_FUNC1
292 #undef INDEXER_FUNC2
293 };
294};
295};
Note: See TracBrowser for help on using the repository browser.