我正在使用Roslyn创建一个分析器,当特定类以不同步的方式暴露其字段时,该分析器会警告用户,以帮助防止竞争条件。
我目前有工作代码检查以确保字段是私有的。我遇到了最后一块拼图的麻烦:找出一种方法来确保所有字段只能在一个锁定块内访问,因此它们(表面上)是同步的。
using System;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Linq;
using System.Threading;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis.CSharp.Syntax;
using Microsoft.CodeAnalysis.Diagnostics;
using Microsoft.CodeAnalysis.FindSymbols;
namespace RaceConditions
{
[DiagnosticAnalyzer(LanguageNames.CSharp)]
public class UnsynchronizedMemberAccess : DiagnosticAnalyzer
{
public const string DiagnosticId = "UnsynchronizedMemberAccess";
internal static readonly LocalizableString Title = "UnsynchronizedMemberAccess Title";
private static readonly LocalizableString MessageFormat = "Unsychronized fields are not thread-safe";
private static readonly LocalizableString Description = "Accessing fields without a get/set methods synchronized with each other and the constructor may lead to race conditions";
internal const string Category = "Race Conditions";
private static DiagnosticDescriptor Rule = new DiagnosticDescriptor(DiagnosticId, Title, MessageFormat, Category, DiagnosticSeverity.Warning, isEnabledByDefault: true, description: Description);
public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get { return ImmutableArray.Create(Rule); } }
//meant to stop other classes and itself from accessing members in an unsychronized fashion.
public override void Initialize(AnalysisContext analysisContext)
{
analysisContext.RegisterSemanticModelAction((context) =>
{
var model = context.SemanticModel;
var root = model.SyntaxTree.GetRoot();
var nodes = model.SyntaxTree.GetRoot().DescendantNodes();
var fields = nodes.OfType<VariableDeclaratorSyntax>()
.Where(v => v.Ancestors().OfType<FieldDeclarationSyntax>().Any());
//since (it appears) that you can't read/write to a an initialized field,
//I think it means you can only read/write inside a block
foreach (BlockSyntax b in nodes.OfType<BlockSyntax>())
{
//where I plan to put code to check references to the fields
}
});
}
}
}
更具体地说,我希望能够确保参考突出显示器突出显示的所有内容(至少是微软似乎称之为的内容)位于锁定块内,而重载参数则不需要。
using System;
using System.Linq;
using System.Activities;
using System.Activities.Statements;
using System.Data.SqlClient;
namespace Sandbox
{
partial class Program
{
private int xe = 0, y = 0;
public Program(int xe)
{
this.xe = xe;
}
void bleh()
{
if (xe == 0)
{
xe = xe + 1;
}
}
static void Main(string[] args)
{
Program p0 = new Program(5),
p1 = new Program(p0),
p2 = new Program(p0.xe);
Console.WriteLine(p1.xe);
Console.Read();
}
}
partial class Program
{
public Program(Program p) : this(p.xe) { }
}
}
在这里,Josh Varty [1]建议我使用SymbolFinder.FindReferencesAsync
,这需要Solution
个对象。 Jason Malinowski [2]说我不应该在分析器中使用它,因为使MSBuildWorkspace
获得Solution
对象太慢,而这个人[3]提供不完整/缺失缓慢问题的解决方法(ReferenceResolver
的链接似乎被破坏了。)
我也调查了DataFlowAnalysis
(SemanticModel.AnalyzeDataFlow()
),但我找不到任何特定的方法,显然让我保证我引用了字段xe
,不是局部变量xe
。
我确实觉得有一些非常明显的东西我不见了。是否有一些优雅的方式来实现我忽略了?如果答案使用语义模型,那将是更好的,因为我希望我必须在其他分析器中使用它来确定数据/引用的来源,但我意识到存在局限性,所以没有语义模型的任何答案也是细
.cs
文件中。首先是小步骤,嗯?答案 0 :(得分:5)
诀窍是颠倒你提问的方式。来自:
如何找到我想确保同步的所有对此符号的引用?
但是
在查看符号的使用时,如何确定它是否应该在锁定语句中?
因为这提供了一个操作过程:您的分析器应该查看不在锁定语句中的方法体中的每个标识符,调用SemanticModel.GetSymbolInfo()
,获取被引用的符号,然后检查该字段是通过你的逻辑(私人等)“同步”的那个。那时,既然您正在查看该用途,您可以标记该特定用途。
这种反转是我们期望编写分析仪的方式,并非偶然。原因主要是表现。想象一下,你的分析器在Visual Studio中运行,你删除了一行代码。如果分析器是在“看一个符号,现在要求所有用途”的模型中编写的,那就意味着任何和所有分析器都可能必须从头开始重新运行。这对你的CPU或电池寿命来说并不是很好。当问题像这样颠倒时,这意味着我们只需要重新分析该特定文件,因为你没有扩展到“给我一切”。