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 : Peter A. Buhr
|
---|
12 | // Last Modified On : Fri Mar 12 18:35:37 2021
|
---|
13 | // Update Count : 2
|
---|
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.h"
|
---|
23 |
|
---|
24 | namespace {
|
---|
25 |
|
---|
26 | // There are a lot of helpers in this file that could be used much more
|
---|
27 | // generally if anyone has another use for them.
|
---|
28 |
|
---|
29 | // Check if a node type has a code location.
|
---|
30 | template<typename node_t>
|
---|
31 | struct has_code_location : public std::is_base_of<ast::ParseNode, node_t> {};
|
---|
32 |
|
---|
33 | template<typename node_t, bool has_location>
|
---|
34 | struct __GetCL;
|
---|
35 |
|
---|
36 | template<typename node_t>
|
---|
37 | struct __GetCL<node_t, true> {
|
---|
38 | static inline CodeLocation const * get( node_t const * node ) {
|
---|
39 | return &node->location;
|
---|
40 | }
|
---|
41 |
|
---|
42 | static inline CodeLocation * get( node_t * node ) {
|
---|
43 | return &node->location;
|
---|
44 | }
|
---|
45 | };
|
---|
46 |
|
---|
47 | template<typename node_t>
|
---|
48 | struct __GetCL<node_t, false> {
|
---|
49 | static inline CodeLocation * get( node_t const * ) {
|
---|
50 | return nullptr;
|
---|
51 | }
|
---|
52 | };
|
---|
53 |
|
---|
54 | template<typename node_t>
|
---|
55 | CodeLocation const * get_code_location( node_t const * node ) {
|
---|
56 | return __GetCL< node_t, has_code_location< node_t >::value >::get( node );
|
---|
57 | }
|
---|
58 |
|
---|
59 | template<typename node_t>
|
---|
60 | CodeLocation * get_code_location( node_t * node ) {
|
---|
61 | return __GetCL< node_t, has_code_location< node_t >::value >::get( node );
|
---|
62 | }
|
---|
63 |
|
---|
64 | // Fill every location with a nearby (parent) location.
|
---|
65 | class FillCore : public ast::WithGuards {
|
---|
66 | CodeLocation const * parent;
|
---|
67 | public:
|
---|
68 | FillCore() : parent( nullptr ) {}
|
---|
69 |
|
---|
70 | template<typename node_t>
|
---|
71 | node_t const * previsit( node_t const * node ) {
|
---|
72 | GuardValue( parent );
|
---|
73 | CodeLocation const * location = get_code_location( node );
|
---|
74 | if ( location && location->isUnset() ) {
|
---|
75 | assert( parent );
|
---|
76 | node_t * newNode = ast::mutate( node );
|
---|
77 | CodeLocation * newLocation = get_code_location( newNode );
|
---|
78 | assert( newLocation );
|
---|
79 | *newLocation = *parent;
|
---|
80 | parent = newLocation;
|
---|
81 | return newNode;
|
---|
82 | } else if ( location ) {
|
---|
83 | parent = location;
|
---|
84 | }
|
---|
85 | return node;
|
---|
86 | }
|
---|
87 | };
|
---|
88 |
|
---|
89 | // ALL_VISITS(macro)
|
---|
90 | // Expands `macro(node_type, return_type)` for every visit method of the
|
---|
91 | // ast::Visitor class where node_type is the name of the parameter and
|
---|
92 | // return_type is the name of the return type; not including the namespace,
|
---|
93 | // pointer or const qualifiers.
|
---|
94 | #define ALL_VISITS(macro) \
|
---|
95 | macro(ObjectDecl, DeclWithType) \
|
---|
96 | macro(FunctionDecl, DeclWithType) \
|
---|
97 | macro(StructDecl, Decl) \
|
---|
98 | macro(UnionDecl, Decl) \
|
---|
99 | macro(EnumDecl, Decl) \
|
---|
100 | macro(TraitDecl, Decl) \
|
---|
101 | macro(TypeDecl, Decl) \
|
---|
102 | macro(TypedefDecl, Decl) \
|
---|
103 | macro(AsmDecl, AsmDecl) \
|
---|
104 | macro(DirectiveDecl, DirectiveDecl) \
|
---|
105 | macro(StaticAssertDecl, StaticAssertDecl) \
|
---|
106 | macro(CompoundStmt, CompoundStmt) \
|
---|
107 | macro(ExprStmt, Stmt) \
|
---|
108 | macro(AsmStmt, Stmt) \
|
---|
109 | macro(DirectiveStmt, Stmt) \
|
---|
110 | macro(IfStmt, Stmt) \
|
---|
111 | macro(WhileStmt, Stmt) \
|
---|
112 | macro(ForStmt, Stmt) \
|
---|
113 | macro(SwitchStmt, Stmt) \
|
---|
114 | macro(CaseStmt, Stmt) \
|
---|
115 | macro(BranchStmt, Stmt) \
|
---|
116 | macro(ReturnStmt, Stmt) \
|
---|
117 | macro(ThrowStmt, Stmt) \
|
---|
118 | macro(TryStmt, Stmt) \
|
---|
119 | macro(CatchStmt, Stmt) \
|
---|
120 | macro(FinallyStmt, Stmt) \
|
---|
121 | macro(SuspendStmt, Stmt) \
|
---|
122 | macro(WaitForStmt, Stmt) \
|
---|
123 | macro(WithStmt, Decl) \
|
---|
124 | macro(NullStmt, NullStmt) \
|
---|
125 | macro(DeclStmt, Stmt) \
|
---|
126 | macro(ImplicitCtorDtorStmt, Stmt) \
|
---|
127 | macro(MutexStmt, Stmt) \
|
---|
128 | macro(ApplicationExpr, Expr) \
|
---|
129 | macro(UntypedExpr, Expr) \
|
---|
130 | macro(NameExpr, Expr) \
|
---|
131 | macro(AddressExpr, Expr) \
|
---|
132 | macro(LabelAddressExpr, Expr) \
|
---|
133 | macro(CastExpr, Expr) \
|
---|
134 | macro(KeywordCastExpr, Expr) \
|
---|
135 | macro(VirtualCastExpr, Expr) \
|
---|
136 | macro(UntypedMemberExpr, Expr) \
|
---|
137 | macro(MemberExpr, Expr) \
|
---|
138 | macro(VariableExpr, Expr) \
|
---|
139 | macro(ConstantExpr, Expr) \
|
---|
140 | macro(SizeofExpr, Expr) \
|
---|
141 | macro(AlignofExpr, Expr) \
|
---|
142 | macro(UntypedOffsetofExpr, Expr) \
|
---|
143 | macro(OffsetofExpr, Expr) \
|
---|
144 | macro(OffsetPackExpr, Expr) \
|
---|
145 | macro(LogicalExpr, Expr) \
|
---|
146 | macro(ConditionalExpr, Expr) \
|
---|
147 | macro(CommaExpr, Expr) \
|
---|
148 | macro(TypeExpr, Expr) \
|
---|
149 | macro(AsmExpr, Expr) \
|
---|
150 | macro(ImplicitCopyCtorExpr, Expr) \
|
---|
151 | macro(ConstructorExpr, Expr) \
|
---|
152 | macro(CompoundLiteralExpr, Expr) \
|
---|
153 | macro(RangeExpr, Expr) \
|
---|
154 | macro(UntypedTupleExpr, Expr) \
|
---|
155 | macro(TupleExpr, Expr) \
|
---|
156 | macro(TupleIndexExpr, Expr) \
|
---|
157 | macro(TupleAssignExpr, Expr) \
|
---|
158 | macro(StmtExpr, Expr) \
|
---|
159 | macro(UniqueExpr, Expr) \
|
---|
160 | macro(UntypedInitExpr, Expr) \
|
---|
161 | macro(InitExpr, Expr) \
|
---|
162 | macro(DeletedExpr, Expr) \
|
---|
163 | macro(DefaultArgExpr, Expr) \
|
---|
164 | macro(GenericExpr, Expr) \
|
---|
165 | macro(VoidType, Type) \
|
---|
166 | macro(BasicType, Type) \
|
---|
167 | macro(PointerType, Type) \
|
---|
168 | macro(ArrayType, Type) \
|
---|
169 | macro(ReferenceType, Type) \
|
---|
170 | macro(QualifiedType, Type) \
|
---|
171 | macro(FunctionType, Type) \
|
---|
172 | macro(StructInstType, Type) \
|
---|
173 | macro(UnionInstType, Type) \
|
---|
174 | macro(EnumInstType, Type) \
|
---|
175 | macro(TraitInstType, Type) \
|
---|
176 | macro(TypeInstType, Type) \
|
---|
177 | macro(TupleType, Type) \
|
---|
178 | macro(TypeofType, Type) \
|
---|
179 | macro(VTableType, Type) \
|
---|
180 | macro(VarArgsType, Type) \
|
---|
181 | macro(ZeroType, Type) \
|
---|
182 | macro(OneType, Type) \
|
---|
183 | macro(GlobalScopeType, Type) \
|
---|
184 | macro(Designation, Designation) \
|
---|
185 | macro(SingleInit, Init) \
|
---|
186 | macro(ListInit, Init) \
|
---|
187 | macro(ConstructorInit, Init) \
|
---|
188 | macro(Attribute, Attribute) \
|
---|
189 | macro(TypeSubstitution, TypeSubstitution)
|
---|
190 |
|
---|
191 | // These could even go into the ast namespace.
|
---|
192 | enum class LeafKind {
|
---|
193 | #define VISIT(node_type, return_type) node_type,
|
---|
194 | ALL_VISITS(VISIT)
|
---|
195 | #undef VISIT
|
---|
196 | };
|
---|
197 |
|
---|
198 | struct LeafKindVisitor : public ast::Visitor {
|
---|
199 | LeafKind kind;
|
---|
200 |
|
---|
201 | #define VISIT(node_type, return_type) \
|
---|
202 | const ast::return_type * visit( const ast::node_type * ) final { \
|
---|
203 | kind = LeafKind::node_type; \
|
---|
204 | return nullptr; \
|
---|
205 | }
|
---|
206 | ALL_VISITS(VISIT)
|
---|
207 | #undef VISIT
|
---|
208 | };
|
---|
209 |
|
---|
210 | constexpr size_t leaf_kind_count = (1 + (size_t)LeafKind::TypeSubstitution);
|
---|
211 |
|
---|
212 | LeafKind get_leaf_kind( ast::Node const * node ) {
|
---|
213 | LeafKindVisitor visitor;
|
---|
214 | node->accept( visitor );
|
---|
215 | return visitor.kind;
|
---|
216 | }
|
---|
217 |
|
---|
218 | const char * leaf_kind_names[leaf_kind_count] = {
|
---|
219 | #define VISIT(node_type, return_type) #node_type,
|
---|
220 | ALL_VISITS(VISIT)
|
---|
221 | #undef VISIT
|
---|
222 | };
|
---|
223 |
|
---|
224 | // Collect pointers to all the nodes with unset code locations.
|
---|
225 | class CollectCore {
|
---|
226 | std::list< ast::ptr< ast::Node > > & unset;
|
---|
227 | public:
|
---|
228 | CollectCore( std::list< ast::ptr< ast::Node > > & unset ) :
|
---|
229 | unset( unset )
|
---|
230 | {}
|
---|
231 |
|
---|
232 | template<typename node_t>
|
---|
233 | void previsit( node_t const * node ) {
|
---|
234 | CodeLocation const * location = get_code_location( node );
|
---|
235 | if ( location && location->isUnset() ) {
|
---|
236 | unset.push_back( node );
|
---|
237 | }
|
---|
238 | }
|
---|
239 | };
|
---|
240 |
|
---|
241 | } // namespace
|
---|
242 |
|
---|
243 | void checkAllCodeLocations( ast::TranslationUnit const & unit ) {
|
---|
244 | checkAllCodeLocations( "unknown location", unit );
|
---|
245 | }
|
---|
246 |
|
---|
247 | void checkAllCodeLocations( char const * label, ast::TranslationUnit const & unit ) {
|
---|
248 | std::list< ast::ptr< ast::Node > > unsetNodes;
|
---|
249 | {
|
---|
250 | ast::Pass<CollectCore> collector( unsetNodes );
|
---|
251 | for ( auto node : unit.decls ) {
|
---|
252 | node->accept( collector );
|
---|
253 | }
|
---|
254 | }
|
---|
255 | if ( unsetNodes.empty() ) {
|
---|
256 | return;
|
---|
257 | }
|
---|
258 |
|
---|
259 | std::cerr << "Code Location check at " << label << " failed." << std::endl;
|
---|
260 | std::cerr << "Total nodes without a set code location: "
|
---|
261 | << unsetNodes.size() << std::endl;
|
---|
262 |
|
---|
263 | size_t node_counts[leaf_kind_count] = {0};
|
---|
264 | for ( auto unset : unsetNodes ) {
|
---|
265 | node_counts[(size_t)get_leaf_kind(unset)] += 1;
|
---|
266 | }
|
---|
267 | for ( size_t i = 0 ; i < leaf_kind_count ; ++i ) {
|
---|
268 | if ( node_counts[i] ) {
|
---|
269 | std::cerr << '\t' << node_counts[i]
|
---|
270 | << " of type " << leaf_kind_names[i] << std::endl;
|
---|
271 | }
|
---|
272 | }
|
---|
273 |
|
---|
274 | assert( unsetNodes.empty() );
|
---|
275 | }
|
---|
276 |
|
---|
277 | void forceFillCodeLocations( ast::TranslationUnit & unit ) {
|
---|
278 | ast::Pass<FillCore>::run( unit );
|
---|
279 | }
|
---|