英文原文: Facebook Open-Sources RacerD - Java Race Condition Detector
由 Facebook 开源的静态分析工具Infer,现已支持使用 RacerD 检测 Java 代码中竞争条件。RacerD 使用锁机制或@ThreadSafe
注解,识别类中各方法间的竞争条件。
去年,Facebook 就已在生产代码中使用了 RacerD,并在代码提交生产前检测到了一千多处的多线程问题。现在,如果 Java 开发人员使用 Infer 去检测 Java 代码中的软件缺陷,同样可以使用 RacerD 的并发检测能力。
竞争条件是一种并发错误或软件缺陷。如果两个访问同一对象的线程(其中至少有一个需要做写操作)间没有做适当的同步操作,这时就会引发竞争条件,进而导致线程的执行存在彼此重叠。并发问题难以调试,更难以在发生问题后重现现场。
RacerD 可以大规模快速并发地执行一些有用的分析。RacerD 之所以可以做快速分析,原因在于它在检测并发问题时并没有非力图去检查整个代码库,而是仅检查那些它认为是并发运行的代码。
RacerD 检查的类、方法和接口定义中可并发运行的代码。这些代码或者是使用@ThreadSafe
注解的、或者是根据关键字synchronized
所创建锁而识别的。如果一个类或结构使用了@ThreadSafe
注解,那么 RacerD 也会评估该类或实现的所有子类。为增加代码覆盖,RacerD 还额外添加了一些有用的注解,包括@ThreadConfined
、@Functional
、@ReturnsOwnership
和@VisibleForTesting
。
启动 RacerD 分析,需要在命令行调用命令infer
。该命令可与其它 Infer 分析一并运行,也可以与只允许 RacerD 运行的infer --racerd-only
命令一并运行。例如,输入命令infer --racerd-only -- javac StockPortfolio.java
,将会对StockPortfolio.java
运行 RacerD。
下面给出一个例子代码。RacerD 在检查该例子代码时,会对其中的竞争条件给出警告。
@ThreadSafe public class StockPortfolio { int shares = 0; public void buy (int count) { if (count > 0) { shares += count; } } public int sell (int count){ if (count >= 0 && shares - count >= 0) { shares -= count; return shares; } else { return 0; } } }
RacerD 会发现上面代码中的软件缺陷:
Read/Write race. Public method int StockPortfolio.sell (int) reads from field StockPortfolio.shares. Potentially races with writes in methods void StockPortfolio.buy (int), int StockPortfolio.sell (int)
可以看到,RacerD 对代码中包含有未保护写、读写竞争等给出了警告。当前 RacerD 具有局限性,它只检测数据竞争情况,并不检测其它一些并发问题,例如死锁或原子性。在下面一些情况下,RacerD 会漏掉其中的数据竞争问题:
volatile
关键字。RacerD 的这些局限性,源自于其设计目标针对的是降低误报率,即便会导致一些漏报。
RacerD 的共同作者 Sam Blackshear 和 Peter O'Hearn 在一份声明中指出:
Infer 当前已在 Facebook 使用,一种方式是批处理部署,另一种方式是作为参与代码审核的机器人。部署用于代码审核的 Infer,是作为 Facebook 持续集成系统的一部分运行。对于开发人员提交的每次代码更改,持续集成将 Infer 与其它一些编译和测试任务一并运行。
RacerD 的代码开源提供在 GitHub 上。更多细节,可参见用户指南。