Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

LVA: Add support for FlowCaptureOperation and FlowCaptureReferenceOperation #9433

Merged
merged 11 commits into from
Jun 24, 2024
Merged

LVA: Add support for FlowCaptureOperation and FlowCaptureReferenceOperation #9433

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
96451f0
Add tests
mary-georgiou-sonarsource Jun 14, 2024
92b454d
Support flow captures
mary-georgiou-sonarsource Jun 19, 2024
7ef498f
delete unused using
mary-georgiou-sonarsource Jun 20, 2024
f916be8
refactoring
mary-georgiou-sonarsource Jun 20, 2024
4d025ca
Un-nuking the czeching
mary-georgiou-sonarsource Jun 21, 2024
ffd7585
ART
mary-georgiou-sonarsource Jun 21, 2024
f4b841d
UT polishing comments
mary-georgiou-sonarsource Jun 21, 2024
55c6f07
ART (•_•)
mary-georgiou-sonarsource Jun 21, 2024
38a99f8
Hopefully last czeching for now
mary-georgiou-sonarsource Jun 24, 2024
6e729a3
apply comment
mary-georgiou-sonarsource Jun 24, 2024
a318a59
rename
mary-georgiou-sonarsource Jun 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
103 changes: 79 additions & 24 deletions analyzers/src/SonarAnalyzer.CFG/LiveVariableAnalysis/RoslynLiveVariableAnalysis.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ namespace SonarAnalyzer.CFG.LiveVariableAnalysis;

public sealed class RoslynLiveVariableAnalysis : LiveVariableAnalysisBase<ControlFlowGraph, BasicBlock>
{
private readonly Dictionary<CaptureId, List<IOperation>> flowCaptureOperations = [];
private readonly Dictionary<int, List<BasicBlock>> blockPredecessors = [];
private readonly Dictionary<int, List<BasicBlock>> blockSuccessors = [];

Expand All @@ -41,6 +42,7 @@ public RoslynLiveVariableAnalysis(ControlFlowGraph cfg, CancellationToken cancel
{
BuildBranches(block);
}
ResolveCaptures();
Analyze();
}

Expand Down Expand Up @@ -70,10 +72,45 @@ protected override IEnumerable<BasicBlock> Successors(BasicBlock block) =>
protected override State ProcessBlock(BasicBlock block)
{
var ret = new RoslynState(this);
ret.ProcessBlock(Cfg, block);
ret.ProcessBlock(Cfg, block, flowCaptureOperations);
return ret;
}

private void ResolveCaptures()
{
foreach (var operation in Cfg.Blocks
.Where(x => x.EnclosingRegion.EnclosingRegionOrSelf(ControlFlowRegionKind.LocalLifetime) is not null)
.SelectMany(x => x.OperationsAndBranchValue)
.ToExecutionOrder())
{
if (IFlowCaptureOperationWrapper.IsInstance(operation.Instance))
{
var flowCapture = IFlowCaptureOperationWrapper.FromOperation(operation.Instance);

if (IFlowCaptureReferenceOperationWrapper.IsInstance(flowCapture.Value)
pavel-mikula-sonarsource marked this conversation as resolved.
Show resolved Hide resolved
&& IFlowCaptureReferenceOperationWrapper.FromOperation(flowCapture.Value) is var captureReference
&& flowCaptureOperations.TryGetValue(captureReference.Id, out var capturedOperations))
{
AppendFlowCaptureReference(flowCapture.Id, capturedOperations.ToArray());
}
else
{
AppendFlowCaptureReference(flowCapture.Id, flowCapture.Value);
}
}
}

void AppendFlowCaptureReference(CaptureId id, params IOperation[] operations)
{
if (!flowCaptureOperations.TryGetValue(id, out var list))
{
list = [];
flowCaptureOperations.Add(id, list);
}
list.AddRange(operations);
}
}

private void BuildBranches(BasicBlock block)
{
foreach (var successor in block.Successors)
Expand Down Expand Up @@ -190,35 +227,53 @@ private sealed class RoslynState : State
public RoslynState(RoslynLiveVariableAnalysis owner) =>
this.owner = owner;

public void ProcessBlock(ControlFlowGraph cfg, BasicBlock block)
public void ProcessBlock(ControlFlowGraph cfg, BasicBlock block, Dictionary<CaptureId, List<IOperation>> flowCaptureOperations)
{
foreach (var operation in block.OperationsAndBranchValue.ToReversedExecutionOrder())
foreach (var operation in block.OperationsAndBranchValue.ToReversedExecutionOrder().Select(x => x.Instance))
{
// Everything that is added to this switch needs to be considered inside ProcessCaptured as well
switch (operation.Instance.Kind)
if ((IFlowCaptureOperationWrapper.IsInstance(operation)
pavel-mikula-sonarsource marked this conversation as resolved.
Show resolved Hide resolved
&& flowCaptureOperations.TryGetValue(IFlowCaptureOperationWrapper.FromOperation(operation).Id, out var captured))
|| (IFlowCaptureReferenceOperationWrapper.IsInstance(operation)
&& flowCaptureOperations.TryGetValue(IFlowCaptureReferenceOperationWrapper.FromOperation(operation).Id, out captured)))
{
foreach (var capturedOperation in captured)
{
ProcessOperation(cfg, capturedOperation);
}
}
else
{
case OperationKindEx.LocalReference:
ProcessParameterOrLocalReference(ILocalReferenceOperationWrapper.FromOperation(operation.Instance));
break;
case OperationKindEx.ParameterReference:
ProcessParameterOrLocalReference(IParameterReferenceOperationWrapper.FromOperation(operation.Instance));
break;
case OperationKindEx.SimpleAssignment:
ProcessSimpleAssignment(ISimpleAssignmentOperationWrapper.FromOperation(operation.Instance));
break;
case OperationKindEx.FlowAnonymousFunction:
ProcessFlowAnonymousFunction(cfg, IFlowAnonymousFunctionOperationWrapper.FromOperation(operation.Instance));
break;
case OperationKindEx.Invocation:
ProcessLocalFunction(cfg, IInvocationOperationWrapper.FromOperation(operation.Instance).TargetMethod);
break;
case OperationKindEx.MethodReference:
ProcessLocalFunction(cfg, IMethodReferenceOperationWrapper.FromOperation(operation.Instance).Method);
break;
ProcessOperation(cfg, operation);
}
}
}

private void ProcessOperation(ControlFlowGraph cfg, IOperation operation)
{
// Everything that is added to this switch needs to be considered inside ProcessCaptured as well
switch (operation.Kind)
{
case OperationKindEx.LocalReference:
ProcessParameterOrLocalReference(ILocalReferenceOperationWrapper.FromOperation(operation));
break;
case OperationKindEx.ParameterReference:
ProcessParameterOrLocalReference(IParameterReferenceOperationWrapper.FromOperation(operation));
break;
case OperationKindEx.SimpleAssignment:
ProcessSimpleAssignment(ISimpleAssignmentOperationWrapper.FromOperation(operation));
break;
case OperationKindEx.FlowAnonymousFunction:
ProcessFlowAnonymousFunction(cfg, IFlowAnonymousFunctionOperationWrapper.FromOperation(operation));
break;
case OperationKindEx.Invocation:
ProcessLocalFunction(cfg, IInvocationOperationWrapper.FromOperation(operation).TargetMethod);
break;
case OperationKindEx.MethodReference:
ProcessLocalFunction(cfg, IMethodReferenceOperationWrapper.FromOperation(operation).Method);
break;
}
}

private void ProcessParameterOrLocalReference(IOperationWrapper reference)
{
if (owner.ParameterOrLocalSymbol(reference.WrappedOperation) is { } symbol)
Expand Down Expand Up @@ -295,7 +350,7 @@ private void ProcessLocalFunction(ControlFlowGraph cfg, IMethodSymbol method)
var localFunctionCfg = cfg.FindLocalFunctionCfgInScope(localFunction, owner.Cancel);
foreach (var block in localFunctionCfg.Blocks.Reverse()) // Simplified approach, ignoring branching and try/catch/finally flows
{
ProcessBlock(localFunctionCfg, block);
ProcessBlock(localFunctionCfg, block, []);
}
}
}
Expand Down
Loading
Loading