c++ - 我如何检查 C++ 代码以查找所有未使用的返回值？

Question

我想静态检查对未使用返回值的非 void 函数的所有调用。

实际上这就像应用 __attribute__ ((warn_unused_result))对于所有非 void 函数，当然对于一个不切实际的大型项目。

是否有任何静态分析工具可以提供这些信息？

Answer 1

这可以使用 clang-query 来完成.这是调用 clang-query 的 shell 脚本查找返回未使用值的调用:

#!/bin/sh
# cmd.sh: Run clang-query to report unused return values.

# When --dump, print the AST of matching syntax.
if [ "x$1" = "x--dump" ]; then
  dump="set output dump"
  shift
fi

query='m
  callExpr(
    isExpansionInMainFile(),
    hasParent(anyOf(
      compoundStmt(),
      ifStmt(hasCondition(expr().bind("cond"))),
      whileStmt(hasCondition(expr().bind("cond"))),
      doStmt(hasCondition(expr().bind("cond")))
    )),
    unless(hasType(voidType())),
    unless(isTypeDependent()),
    unless(cxxOperatorCallExpr()),
    unless(callee(namedDecl(anyOf(
      hasName("memset"),
      hasName("setlength"),
      hasName("flags"),
      hasName("width"),
      hasName("__builtin_memcpy")
    )))),
    unless(equalsBoundNode("cond")))'

clang-query -c="$dump" -c="$query" "$@"

要在 test1.cc 上运行它:

$ ./cmd.sh test1.cc --

查询的基本思想是寻找其直接父级是复合语句的调用表达式。它被扩展以处理作为控制流语句的直接父级，注意不要在调用作为条件表达式出现时报告。

查询处理的其他一些复杂情况:

• 这仅在翻译单元的主文件中报告，以消除 header 中的大量噪音。删除 isExpansionInMainFile过滤水龙带中的水。

• 在 C++ 模板中，我们可能不知道类型是什么，因此禁止报告所有具有依赖类型的调用。

• 一些函数，例如 memset具有无用或很少有用的返回值。必须过滤掉它们才能看到任何有用的信号。查询中的函数名称列表只是冰山一角。

• C++ 重载运算符，包括 operator<<和 operator= ，通常会返回一个值，但该值通常会被忽略。因此，抑制所有重载运算符的报告。

我已经对我的实用程序库中的一些文件进行了轻微测试(使用来自 clang+llvm-8.0.1 的 clang-query)，这就是我如何找到一些需要为此过滤掉的东西有用。根据您的应用程序，可能还有更多的东西需要过滤。

查询语言描述于https://clang.llvm.org/docs/LibASTMatchersReference.html .参见 this answer of mine有关 clang-query 的更多链接和信息.