-
Notifications
You must be signed in to change notification settings - Fork 38
/
SourceGraph.cs
507 lines (439 loc) · 19.6 KB
/
SourceGraph.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
using DataExtraction.Utils;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using Newtonsoft.Json;
using System;
using System.Collections.Generic;
using Microsoft.CodeAnalysis.CSharp.Syntax;
using System.Diagnostics;
using System.Linq;
namespace SourceGraphExtractionUtils.Utils
{
public enum SourceGraphEdge
{
Child,
NextToken,
LastUsedVariable,
LastUse,
LastWrite,
LastLexicalUse,
ComputedFrom,
ReturnsTo,
FormalArgName,
GuardedBy,
GuardedByNegation,
BindsToSymbol
}
public class SourceGraphComparer
: IEqualityComparer<Edge<SyntaxNodeOrToken, SourceGraphEdge>>,
IEqualityComparer<SyntaxNodeOrToken>
{
bool IEqualityComparer<Edge<SyntaxNodeOrToken, SourceGraphEdge>>.Equals(Edge<SyntaxNodeOrToken, SourceGraphEdge> x, Edge<SyntaxNodeOrToken, SourceGraphEdge> y)
=> x.Label == y.Label
&& ((IEqualityComparer<SyntaxNodeOrToken>)this).Equals(x.Source, y.Source)
&& ((IEqualityComparer<SyntaxNodeOrToken>)this).Equals(x.Target, y.Target);
bool IEqualityComparer<SyntaxNodeOrToken>.Equals(SyntaxNodeOrToken x, SyntaxNodeOrToken y)
=> x.Equals(y);
int IEqualityComparer<Edge<SyntaxNodeOrToken, SourceGraphEdge>>.GetHashCode(Edge<SyntaxNodeOrToken, SourceGraphEdge> edge)
=> 29 * edge.Source.GetHashCode() + 31 * edge.Target.GetHashCode() + 37 * edge.Label.GetHashCode();
int IEqualityComparer<SyntaxNodeOrToken>.GetHashCode(SyntaxNodeOrToken node)
=> node.GetHashCode();
}
public class SourceGraph : DirectedGraph<SyntaxNodeOrToken, SourceGraphEdge>
{
public const string NOTYPE_NAME = "NOTYPE";
public readonly SemanticModel SemanticModel;
private readonly Dictionary<SyntaxNodeOrToken, string> _nodeToTypeStringCache;
private readonly HashSet<SyntaxNodeOrToken> _declarationNodes;
private readonly HashSet<SyntaxNodeOrToken> _usedVariableNodes;
private readonly HashSet<SyntaxNodeOrToken> _writtenVariableNodes;
private readonly Dictionary<SyntaxToken, ISet<ISymbol>> _aliasedVariableNodes;
private SourceGraph(SemanticModel semanticModel, SourceGraphComparer comparer) : base(comparer, comparer)
{
SemanticModel = semanticModel;
_nodeToTypeStringCache = new Dictionary<SyntaxNodeOrToken, string>();
_usedVariableNodes = new HashSet<SyntaxNodeOrToken>();
_writtenVariableNodes = new HashSet<SyntaxNodeOrToken>();
_declarationNodes = new HashSet<SyntaxNodeOrToken>();
_aliasedVariableNodes = new Dictionary<SyntaxToken, ISet<ISymbol>>();
}
private SourceGraph(SourceGraph baseGraph, SourceGraphComparer comparer) : base(comparer, comparer)
{
SemanticModel = baseGraph.SemanticModel;
_nodeToTypeStringCache = baseGraph._nodeToTypeStringCache;
_usedVariableNodes = new HashSet<SyntaxNodeOrToken>(baseGraph._usedVariableNodes);
_writtenVariableNodes = new HashSet<SyntaxNodeOrToken>(baseGraph._writtenVariableNodes);
_declarationNodes = new HashSet<SyntaxNodeOrToken>(baseGraph._declarationNodes);
_aliasedVariableNodes = new Dictionary<SyntaxToken, ISet<ISymbol>>();
foreach (var kvp in baseGraph._aliasedVariableNodes)
{
_aliasedVariableNodes.Add(kvp.Key, new HashSet<ISymbol>(kvp.Value));
}
}
public static SourceGraph Create(SemanticModel semanticModel)
{
var comparer = new SourceGraphComparer();
return new SourceGraph(semanticModel, comparer);
}
public static SourceGraph Create(SourceGraph baseGraph)
{
var comparer = new SourceGraphComparer();
return new SourceGraph(baseGraph, comparer);
}
public bool IsDeclaration(SyntaxNodeOrToken node) => _declarationNodes.Contains(node);
public bool IsWrite(SyntaxNodeOrToken node) => _writtenVariableNodes.Contains(node);
public ISet<SyntaxNodeOrToken> DeclarationNodes => _declarationNodes;
public ISet<SyntaxNodeOrToken> UsedVariableNodes => _usedVariableNodes;
public ISet<SyntaxNodeOrToken> WrittenVariableNodes => _writtenVariableNodes;
public IDictionary<SyntaxToken, ISet<ISymbol>> AliasedVariableNodes => _aliasedVariableNodes;
public string GetNodeLabel(SyntaxNodeOrToken node, Dictionary<SyntaxNodeOrToken, string> nodeLabelOverrides = null)
{
if (nodeLabelOverrides != null && nodeLabelOverrides.TryGetValue(node, out var label))
{
return label;
}
if (node.IsToken)
{
label = node.ToString();
// Stip "@" off of masked keywords, as we use proper symbols in the rest of the code, which don't have the @ either:
if (label.StartsWith("@"))
{
label = label.Substring(1);
}
return label;
}
else
{
return node.AsNode().Kind().ToString();
}
}
private Action<JsonWriter, Dictionary<SyntaxNodeOrToken, int>> WriteNodeLabelsJson(Dictionary<SyntaxNodeOrToken, string> nodeLabelOverrides)
=> (jWriter, nodeNumberer) =>
{
jWriter.WritePropertyName("NodeLabels");
jWriter.WriteStartObject();
foreach ((var node, var nodeNumber) in nodeNumberer)
{
jWriter.WritePropertyName(nodeNumber.ToString());
jWriter.WriteValue(GetNodeLabel(node, nodeLabelOverrides));
}
jWriter.WriteEndObject();
};
public string GetNodeType(SyntaxNodeOrToken node)
{
if (!_nodeToTypeStringCache.TryGetValue(node, out var res))
{
// Handle some literal types:
if (node.IsKind(SyntaxKind.StringLiteralToken))
{
res = "string";
}
else if (node.IsKind(SyntaxKind.CharacterLiteralToken))
{
res = "char";
}
else if (node.IsKind(SyntaxKind.NumericLiteralToken))
{
res = node.AsToken().Value.GetType().Name.ToLower();
}
else
{
var syntaxNode = node.IsNode ? node.AsNode() : node.AsToken().Parent;
if (syntaxNode != null)
{
ISymbol symbol = RoslynUtils.GetReferenceSymbol(syntaxNode, SemanticModel);
if (RoslynUtils.GetTypeSymbol(symbol, out var typeSymbol))
{
res = typeSymbol.ToString();
}
else
{
res = NOTYPE_NAME;
}
}
else
{
res = NOTYPE_NAME;
}
}
_nodeToTypeStringCache[node] = res;
}
return res;
}
public void OverrideTypeForNode(SyntaxNodeOrToken node, string type)
{
_nodeToTypeStringCache[node] = type;
}
private Action<JsonWriter, Dictionary<SyntaxNodeOrToken, int>> WriteNodeTypesJson()
=> (jWriter, nodeNumberer) =>
{
jWriter.WritePropertyName("NodeTypes");
jWriter.WriteStartObject();
foreach ((var node, var nodeNumber) in nodeNumberer)
{
var nodeType = GetNodeType(node);
if (nodeType != NOTYPE_NAME)
{
jWriter.WritePropertyName(nodeNumber.ToString());
jWriter.WriteValue(nodeType);
}
}
jWriter.WriteEndObject();
};
private Action<JsonWriter, (SyntaxNodeOrToken From, SyntaxNodeOrToken To)> WriteEdgeDistanceValueJson(SemanticModel semanticModel, int slotLineNumber) =>
(jWriter, edgeInfo) =>
{
int fromLineNo = slotLineNumber;
if (edgeInfo.From.Parent != null)
{
fromLineNo = edgeInfo.From.Parent.SyntaxTree.GetLineSpan(edgeInfo.From.FullSpan).StartLinePosition.Line;
}
int toLineNo = slotLineNumber;
if (edgeInfo.To.Parent != null)
{
toLineNo = edgeInfo.To.Parent.SyntaxTree.GetLineSpan(edgeInfo.To.FullSpan).EndLinePosition.Line;
}
jWriter.WriteValue(toLineNo - fromLineNo);
};
public void WriteJson(JsonWriter jWriter, Dictionary<SyntaxNodeOrToken, int> nodeNumberer, Dictionary<SyntaxNodeOrToken, string> nodeLabelOverrides, int holeLineNumber)
{
WriteJson(jWriter,
nodeNumberer,
new Action<JsonWriter, Dictionary<SyntaxNodeOrToken, int>>[] {
WriteNodeLabelsJson(nodeLabelOverrides),
WriteNodeTypesJson(),
},
new (Predicate<SourceGraphEdge> acceptsEdgeLabel, Action<JsonWriter, (SyntaxNodeOrToken From, SyntaxNodeOrToken To)> writer)[] {
(edgeType => edgeType.Equals(SourceGraphEdge.LastLexicalUse)
|| edgeType.Equals(SourceGraphEdge.LastUse)
|| edgeType.Equals(SourceGraphEdge.LastWrite), WriteEdgeDistanceValueJson(SemanticModel, holeLineNumber))
});
}
public void ToDotFile(string outputPath, Dictionary<SyntaxNodeOrToken, int> nodeNumberer, Dictionary<SyntaxNodeOrToken, string> nodeLabeler, bool diffable=false)
{
Func<SyntaxNodeOrToken, object> ToLineSpan = t =>
{
var span = t.GetLocation().GetMappedLineSpan();
return $"{span.StartLinePosition} -- {span.EndLinePosition}";
};
ToDotFile(outputPath, diffable ? nodeNumberer.ToDictionary(kv => kv.Key, kv => ToLineSpan(kv.Key))
: nodeNumberer.ToDictionary(kv => kv.Key, kv => (object)kv.Value),
node => node.IsToken ? "rectangle" : "circle",
node => GetNodeLabel(node, nodeLabeler).Replace("\"", "\\\""));
}
}
public class ASTGraphExtractor : CSharpSyntaxWalker
{
private SourceGraph _graph;
private SyntaxToken? _lastAddedToken;
private ASTGraphExtractor(SemanticModel semanticModel)
{
_graph = SourceGraph.Create(semanticModel);
}
public static SourceGraph ConstructASTGraph(SemanticModel semanticModel)
{
var visitor = new ASTGraphExtractor(semanticModel);
visitor.Visit(semanticModel.SyntaxTree.GetRoot());
return visitor._graph;
}
private void AddToken(SyntaxNode parentNode, SyntaxToken token)
{
if (_lastAddedToken.HasValue)
{
_graph.AddEdge(_lastAddedToken.Value, SourceGraphEdge.NextToken, token);
}
_lastAddedToken = token;
}
public override void Visit(SyntaxNode node)
{
foreach (var child in node.ChildNodesAndTokens())
{
_graph.AddEdge(node, SourceGraphEdge.Child, child);
if (child.IsNode)
{
Visit(child.AsNode());
}
else
{
AddToken(node, child.AsToken());
}
}
}
}
public class MethodInfoGraphExtractor : CSharpSyntaxWalker
{
private readonly DirectedGraph<SyntaxNodeOrToken, SourceGraphEdge> _graph;
private readonly SemanticModel _semanticModel;
private readonly Stack<SyntaxNodeOrToken> _returningPoint = new Stack<SyntaxNodeOrToken>();
private readonly Dictionary<IMethodSymbol, HashSet<SyntaxNodeOrToken>> _boundMethods = new Dictionary<IMethodSymbol, HashSet<SyntaxNodeOrToken>>();
private MethodInfoGraphExtractor(SemanticModel semanticModel, DirectedGraph<SyntaxNodeOrToken, SourceGraphEdge> graph)
{
_graph = graph;
_semanticModel = semanticModel;
}
public static void ConstructMethodInfoGraph(SemanticModel semanticModel,
DirectedGraph<SyntaxNodeOrToken, SourceGraphEdge> graph)
{
var extractor = new MethodInfoGraphExtractor(semanticModel, graph);
extractor.Visit(semanticModel.SyntaxTree.GetRoot());
// For all methods that are called at least twice, bind them with a dummy symbol
foreach (var (invocationSymbol, invocationSites) in extractor._boundMethods.Where(kv => kv.Value.Count > 1))
{
var dummySymbol = SyntaxFactory.Identifier(invocationSymbol.Name);
foreach (var invocation in invocationSites)
{
graph.AddEdge(invocation, SourceGraphEdge.BindsToSymbol, dummySymbol);
}
}
}
public override void VisitReturnStatement(ReturnStatementSyntax node)
{
Debug.Assert(_returningPoint.Count > 0);
if (node.Expression != null)
{
_graph.AddEdge(node.Expression, SourceGraphEdge.ReturnsTo, _returningPoint.Peek());
}
base.VisitReturnStatement(node);
}
public override void VisitInvocationExpression(InvocationExpressionSyntax node)
{
base.VisitInvocationExpression(node);
var invocationSymbol = (IMethodSymbol)_semanticModel.GetSymbolInfo(node).Symbol;
if (invocationSymbol == null) return;
if (!_boundMethods.TryGetValue(invocationSymbol, out var boundInvocations))
{
boundInvocations = new HashSet<SyntaxNodeOrToken>();
_boundMethods.Add(invocationSymbol, boundInvocations);
}
boundInvocations.Add(node);
foreach (var arg in node.ArgumentList.Arguments)
{
var paramSymbol = DetermineParameter(node.ArgumentList, arg, invocationSymbol);
Debug.Assert(arg.Expression != null);
if (paramSymbol == null) continue; // rarely happens on __arglist (probably present only on coreclr)
SyntaxNodeOrToken dummySymbol = SyntaxFactory.Identifier(paramSymbol.Name);
// Create a dummy node for the formal parameter symbol
_graph.AddEdge(arg.Expression, SourceGraphEdge.FormalArgName, dummySymbol);
}
}
public override void VisitMethodDeclaration(MethodDeclarationSyntax node)
{
_returningPoint.Push(node.Identifier);
base.VisitMethodDeclaration(node);
_returningPoint.Pop();
}
public override void VisitConstructorDeclaration(ConstructorDeclarationSyntax node)
{
_returningPoint.Push(node.Identifier);
base.VisitConstructorDeclaration(node);
_returningPoint.Pop();
}
public override void VisitDestructorDeclaration(DestructorDeclarationSyntax node)
{
_returningPoint.Push(node.Identifier);
base.VisitDestructorDeclaration(node);
_returningPoint.Pop();
}
public override void VisitConversionOperatorDeclaration(ConversionOperatorDeclarationSyntax node)
{
_returningPoint.Push(node);
base.VisitConversionOperatorDeclaration(node);
_returningPoint.Pop();
}
public override void VisitOperatorDeclaration(OperatorDeclarationSyntax node)
{
_returningPoint.Push(node);
base.VisitOperatorDeclaration(node);
_returningPoint.Pop();
}
public override void VisitPropertyDeclaration(PropertyDeclarationSyntax node)
{
_returningPoint.Push(node.Identifier);
base.VisitPropertyDeclaration(node);
_returningPoint.Pop();
}
public override void VisitIndexerDeclaration(IndexerDeclarationSyntax node)
{
_returningPoint.Push(node);
base.VisitIndexerDeclaration(node);
_returningPoint.Pop();
}
public override void VisitEventDeclaration(EventDeclarationSyntax node)
{
_returningPoint.Push(node.Identifier);
base.VisitEventDeclaration(node);
_returningPoint.Pop();
}
public override void VisitYieldStatement(YieldStatementSyntax node)
{
bool isReturnStatement = node.IsKind(SyntaxKind.YieldReturnStatement);
if (isReturnStatement && node.Expression != null)
{
_graph.AddEdge(node.Expression, SourceGraphEdge.ReturnsTo, _returningPoint.Peek());
}
base.VisitYieldStatement(node);
}
public override void VisitLocalFunctionStatement(LocalFunctionStatementSyntax node)
{
_returningPoint.Push(node.Identifier);
base.VisitLocalFunctionStatement(node);
_returningPoint.Pop();
}
public override void VisitSimpleLambdaExpression(SimpleLambdaExpressionSyntax node)
{
_returningPoint.Push(node); // Lambdas don't have names. Use the AST node instead
base.VisitSimpleLambdaExpression(node);
_returningPoint.Pop();
}
public override void VisitParenthesizedLambdaExpression(ParenthesizedLambdaExpressionSyntax node)
{
_returningPoint.Push(node);
base.VisitParenthesizedLambdaExpression(node);
_returningPoint.Pop();
}
public override void VisitAnonymousMethodExpression(AnonymousMethodExpressionSyntax node)
{
_returningPoint.Push(node);
base.VisitAnonymousMethodExpression(node);
_returningPoint.Pop();
}
/// <summary>
/// Copied from Roslyn source code. Determines the parameter for a given argument
/// </summary>
/// <param name="argumentList"></param>
/// <param name="argument"></param>
/// <param name="symbol"></param>
/// <returns></returns>
public IParameterSymbol DetermineParameter(BaseArgumentListSyntax argumentList, ArgumentSyntax argument, IMethodSymbol symbol)
{
var parameters = symbol.Parameters;
// Handle named argument
if (argument.NameColon != null && !argument.NameColon.IsMissing)
{
var name = argument.NameColon.Name.Identifier.ValueText;
return parameters.FirstOrDefault(p => p.Name == name);
}
// Handle positional argument
var index = argumentList.Arguments.IndexOf(argument);
if (index < 0)
{
return null;
}
if (index < parameters.Length)
{
return parameters[index];
}
// Handle Params
var lastParameter = parameters.LastOrDefault();
if (lastParameter == null)
{
return null;
}
if (lastParameter.IsParams)
{
return lastParameter;
}
return null;
}
}
}