source: src/Common/CodeLocationTools.cpp@ 35cc6d4

Last change on this file since 35cc6d4 was fca78f1, checked in by Andrew Beach <ajbeach@…>, 12 months ago

Added ForeachStmt (felt better than ForEachStmt). This new node is a bit optimistic in that currently it is covering a very narrow case, but with improvements to it and RangeExpr, it could handle many more kind of loops.
  • Property mode set to 100644
File size: 8.2 KB
Line 
1//
2// Cforall Version 1.0.0 Copyright (C) 2015 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// CodeLocationTools.cpp -- Additional tools for code locations.
8//
9// Author : Andrew Beach
10// Created On : Fri Dec 4 15:42:00 2020
11// Last Modified By : Andrew Beach
12// Last Modified On : Wed May 11 16:16:00 2022
13// Update Count : 5
14//
15
16#include "CodeLocationTools.hpp"
17
18#include <type_traits>
19
20#include "AST/Pass.hpp"
21#include "AST/TranslationUnit.hpp"
22#include "Common/CodeLocation.hpp"
23
24namespace {
25
26// Fill every location with a nearby (parent) location.
27class FillCore : public ast::WithGuards {
28 CodeLocation const * parent;
29
30 template<typename node_t>
31 node_t const * parse_visit( node_t const * node ) {
32 if ( node->location.isUnset() ) {
33 assert( parent );
34 node_t * newNode = ast::mutate( node );
35 newNode->location = *parent;
36 return newNode;
37 }
38 GuardValue( parent ) = &node->location;
39 return node;
40 }
41
42 bool hasUnsetLabels( const ast::Stmt * stmt ) {
43 for ( const ast::Label& label : stmt->labels ) {
44 if ( label.location.isUnset() ) {
45 return true;
46 }
47 }
48 return false;
49 }
50
51 template<typename node_t>
52 node_t const * stmt_visit( node_t const * node ) {
53 assert( node->location.isSet() );
54
55 if ( hasUnsetLabels( node ) ) {
56 node_t * newNode = ast::mutate( node );
57 for ( ast::Label& label : newNode->labels ) {
58 if ( label.location.isUnset() ) {
59 label.location = newNode->location;
60 }
61 }
62 return newNode;
63 }
64 return node;
65 }
66
67 template<typename node_t>
68 auto visit( node_t const * node, long ) {
69 return node;
70 }
71
72 template<typename node_t>
73 auto visit( node_t const * node, int ) -> typename
74 std::remove_reference< decltype( node->location, node ) >::type {
75 return parse_visit( node );
76 }
77
78 template<typename node_t>
79 auto visit( node_t const * node, char ) -> typename
80 std::remove_reference< decltype( node->labels, node ) >::type {
81 return stmt_visit( parse_visit( node ) );
82 }
83
84public:
85 FillCore() : parent( nullptr ) {}
86 FillCore( const CodeLocation& location ) : parent( &location ) {
87 assert( location.isSet() );
88 }
89
90 template<typename node_t>
91 node_t const * previsit( node_t const * node ) {
92 return visit( node, '\0' );
93 }
94};
95
96// ALL_VISITS(macro)
97// Expands `macro(node_type, return_type)` for every visit method of the
98// ast::Visitor class where node_type is the name of the parameter and
99// return_type is the name of the return type; not including the namespace,
100// pointer or const qualifiers.
101#define ALL_VISITS(macro) \
102 macro(ObjectDecl, DeclWithType) \
103 macro(FunctionDecl, DeclWithType) \
104 macro(StructDecl, Decl) \
105 macro(UnionDecl, Decl) \
106 macro(EnumDecl, Decl) \
107 macro(TraitDecl, Decl) \
108 macro(TypeDecl, Decl) \
109 macro(TypedefDecl, Decl) \
110 macro(AsmDecl, AsmDecl) \
111 macro(DirectiveDecl, DirectiveDecl) \
112 macro(StaticAssertDecl, StaticAssertDecl) \
113 macro(InlineMemberDecl, DeclWithType) \
114 macro(CompoundStmt, CompoundStmt) \
115 macro(ExprStmt, Stmt) \
116 macro(AsmStmt, Stmt) \
117 macro(DirectiveStmt, Stmt) \
118 macro(IfStmt, Stmt) \
119 macro(WhileDoStmt, Stmt) \
120 macro(ForStmt, Stmt) \
121 macro(ForeachStmt, Stmt) \
122 macro(SwitchStmt, Stmt) \
123 macro(CaseClause, CaseClause) \
124 macro(BranchStmt, Stmt) \
125 macro(ReturnStmt, Stmt) \
126 macro(ThrowStmt, Stmt) \
127 macro(TryStmt, Stmt) \
128 macro(CatchClause, CatchClause) \
129 macro(FinallyClause, FinallyClause) \
130 macro(SuspendStmt, Stmt) \
131 macro(WhenClause, WhenClause) \
132 macro(WaitForStmt, Stmt) \
133 macro(WaitForClause, WaitForClause) \
134 macro(WaitUntilStmt, Stmt) \
135 macro(WithStmt, Decl) \
136 macro(NullStmt, NullStmt) \
137 macro(DeclStmt, Stmt) \
138 macro(ImplicitCtorDtorStmt, Stmt) \
139 macro(MutexStmt, Stmt) \
140 macro(CorunStmt, Stmt) \
141 macro(CoforStmt, Stmt) \
142 macro(ApplicationExpr, Expr) \
143 macro(UntypedExpr, Expr) \
144 macro(NameExpr, Expr) \
145 macro(QualifiedNameExpr, Expr) \
146 macro(AddressExpr, Expr) \
147 macro(LabelAddressExpr, Expr) \
148 macro(CastExpr, Expr) \
149 macro(KeywordCastExpr, Expr) \
150 macro(VirtualCastExpr, Expr) \
151 macro(UntypedMemberExpr, Expr) \
152 macro(MemberExpr, Expr) \
153 macro(VariableExpr, Expr) \
154 macro(ConstantExpr, Expr) \
155 macro(SizeofExpr, Expr) \
156 macro(CountExpr, Expr ) \
157 macro(AlignofExpr, Expr) \
158 macro(UntypedOffsetofExpr, Expr) \
159 macro(OffsetofExpr, Expr) \
160 macro(OffsetPackExpr, Expr) \
161 macro(LogicalExpr, Expr) \
162 macro(ConditionalExpr, Expr) \
163 macro(CommaExpr, Expr) \
164 macro(TypeExpr, Expr) \
165 macro(DimensionExpr, Expr) \
166 macro(AsmExpr, Expr) \
167 macro(ImplicitCopyCtorExpr, Expr) \
168 macro(ConstructorExpr, Expr) \
169 macro(CompoundLiteralExpr, Expr) \
170 macro(RangeExpr, Expr) \
171 macro(UntypedTupleExpr, Expr) \
172 macro(TupleExpr, Expr) \
173 macro(TupleIndexExpr, Expr) \
174 macro(TupleAssignExpr, Expr) \
175 macro(StmtExpr, Expr) \
176 macro(UniqueExpr, Expr) \
177 macro(UntypedInitExpr, Expr) \
178 macro(InitExpr, Expr) \
179 macro(DeletedExpr, Expr) \
180 macro(DefaultArgExpr, Expr) \
181 macro(GenericExpr, Expr) \
182 macro(VoidType, Type) \
183 macro(BasicType, Type) \
184 macro(PointerType, Type) \
185 macro(ArrayType, Type) \
186 macro(ReferenceType, Type) \
187 macro(QualifiedType, Type) \
188 macro(FunctionType, Type) \
189 macro(StructInstType, Type) \
190 macro(UnionInstType, Type) \
191 macro(EnumInstType, Type) \
192 macro(TraitInstType, Type) \
193 macro(TypeInstType, Type) \
194 macro(TupleType, Type) \
195 macro(TypeofType, Type) \
196 macro(VTableType, Type) \
197 macro(VarArgsType, Type) \
198 macro(ZeroType, Type) \
199 macro(OneType, Type) \
200 macro(GlobalScopeType, Type) \
201 macro(Designation, Designation) \
202 macro(SingleInit, Init) \
203 macro(ListInit, Init) \
204 macro(ConstructorInit, Init) \
205 macro(Attribute, Attribute) \
206 macro(TypeSubstitution, TypeSubstitution)
207
208// These could even go into the ast namespace.
209enum class LeafKind {
210#define VISIT(node_type, return_type) node_type,
211 ALL_VISITS(VISIT)
212#undef VISIT
213};
214
215struct LeafKindVisitor : public ast::Visitor {
216 LeafKind result;
217
218#define VISIT(node_type, return_type) \
219 const ast::return_type * visit( const ast::node_type * ) final { \
220 result = LeafKind::node_type; \
221 return nullptr; \
222 }
223 ALL_VISITS(VISIT)
224#undef VISIT
225};
226
227constexpr size_t leaf_kind_count = (1 + (size_t)LeafKind::TypeSubstitution);
228
229LeafKind get_leaf_kind( ast::Node const * node ) {
230 return ast::Pass<LeafKindVisitor>::read( node );
231}
232
233const char * leaf_kind_names[leaf_kind_count] = {
234#define VISIT(node_type, return_type) #node_type,
235 ALL_VISITS(VISIT)
236#undef VISIT
237};
238
239// Collect pointers to all the nodes with unset code locations.
240class CollectCore {
241 std::list< ast::ptr< ast::Node > > & unset;
242public:
243 CollectCore( std::list< ast::ptr< ast::Node > > & unset ) :
244 unset( unset )
245 {}
246
247 template<typename node_t>
248 auto previsit( node_t const * node ) -> decltype( node->location, void() ) {
249 if ( node->location.isUnset() ) {
250 unset.push_back( node );
251 }
252 }
253};
254
255} // namespace
256
257void checkAllCodeLocations( ast::TranslationUnit const & unit ) {
258 checkAllCodeLocations( "unknown location", unit );
259}
260
261void checkAllCodeLocations( char const * label, ast::TranslationUnit const & unit ) {
262 std::list< ast::ptr< ast::Node > > unsetNodes;
263 {
264 ast::Pass<CollectCore> collector( unsetNodes );
265 for ( auto node : unit.decls ) {
266 node->accept( collector );
267 }
268 }
269 if ( unsetNodes.empty() ) {
270 return;
271 }
272
273 std::cerr << "Code Location check at " << label << " failed." << std::endl;
274 std::cerr << "Total nodes without a set code location: "
275 << unsetNodes.size() << std::endl;
276
277 size_t node_counts[leaf_kind_count] = {0};
278 for ( auto unset : unsetNodes ) {
279 node_counts[(size_t)get_leaf_kind(unset)] += 1;
280 }
281 for ( size_t i = 0 ; i < leaf_kind_count ; ++i ) {
282 if ( node_counts[i] ) {
283 std::cerr << '\t' << node_counts[i]
284 << " of type " << leaf_kind_names[i] << std::endl;
285 }
286 }
287
288 assert( unsetNodes.empty() );
289}
290
291void forceFillCodeLocations( ast::TranslationUnit & unit ) {
292 ast::Pass<FillCore>::run( unit );
293}
294
295ast::Node const * localFillCodeLocations(
296 CodeLocation const & location , ast::Node const * node ) {
297 ast::Pass<FillCore> visitor( location );
298 return node->accept( visitor );
299}
Note: See TracBrowser for help on using the repository browser.