在Debian下使用CppCheck对C代码进行静态扫描

• cppcheck是一个C/C++静态检查工具，可以帮助我们检测出代码可能存在(潜在)的问题；

• cppcheck的执行完全基于C/C++源码的文本文件进行词法、语法分析，帮助开发人员找出代码中常见的隐患所在，从而规范化软件开发流程，提高开发质量；

• cppcheck不是编译器，替代不了gcc，cppcheck的执行环境中也不需要安装gcc这类编译工具；

• cppcheck对于软件开发的生态非常完善，可以以插件的方式整合到Visual Studio、Eclipse、Jenkins、SVN、Git等编译器、版本管理工具以及持续部署的工具链中；

• 目前市场上的主流静态分析工具除了cppcheck之外，还有clang、pclint、coverity、tscancode等，主要属性对比如下：

cppcheck在debian/linux上的安装

使用cppcheck对单个c源文件进行扫描

• warning：buf越界；

• style：buf的定义范围可以更小，例如放在x==1000的判断条件之内；

• style：仍然是buf定义范围问题，如果程序没有在x==1000条件下执行，则buf根本就不会用到；

• information：无法找到头文件；
• 可以使用--suppress=missingIncludeSystem选项忽略掉包含头文件的告警信息；
• 也可以使用-I选项指定头文件所在的目录路径；

使用cppcheck对整个c源文件目录进行扫描

• 可以看到，使用cppcheck对一个源码目录进行静态分析和扫描的过程与对单个C文件进行扫描类似，cppcheck会逐个递归的进入各个子目录，对其中包含的C源码文件进行扫描并输出扫描结果，开发人员只需要按照以上给出的结果对问题进行修改即可；

cppcheck的常用执行选项

• cppcheck输出的消息提示类型使用--enable选项进行设置：
• --enable=all：启用所有类型的消息提示；
• --enable=warning：启用警告消息；
• --enable=performance：启用性能消息；
• --enable=information：启用信息消息；
• --enable=style：启用可移植性和样式信息；
• --enable=warning,performance：同时启用警告和性能消息；

• 保存cppcheck的分析结果到一个文本文件中，使用重定向命令即可
• cppcheck sample --enable=all 2> err.txt；

• 多线程检查：选项 -j 用于指定需要使用的线程数，对于大型软件的静态扫描尤其有用
• cppcheck -j 4 sample --enable=all；

• 使用--template选项格式化输出信息
• 以gcc兼容的格式输出扫描信息：
• cppcheck sample/ --enable=all --template=gcc；
• 以Visual Studio兼容的格式输出扫描信息：
• cppcheck sample/ --enable=all --template=vs；
• 此外也可以使用自定义的方式来格式化输出扫描信息：
• cppcheck --template="{file},{line},{severity},{id},{message}" sample/ --enable=all；
• 以xml的形式输出扫描信息
• cppcheck --xml-version=2 sample/ --enable=all 2> err.xml；
• xml文件中的每一个error节点就是一条扫描输出信息；

参考资料

• 【代码质量】C++代码质量扫描主流工具深度比较

• Cppcheck 用法（上篇）