参考文档
https://clang.llvm.org/extra/clang-tidy/
测试代码
先写个简单的代码
main.c
1#include
2#include
3#include
4int main(int argc, char *argv[])
5{
6 char *tmp = (char *)malloc(argc);
7 if(tmp)
8 {
9 strncpy(tmp, argv[0], argc);
10 printf("%s", tmp);
11 if(argc > 2)
12 {
13 free(tmp);
14 }
15 }
16 printf("hello world!\n");
17 return 0;
18}
使用clang-tidy分析一下
1# apt install -y clang-tidy
2# clang-tidy main.c
3Error while trying to load a compilation database:
4Could not auto-detect compilation database for file "main.c"
5No compilation database found in /work/analyzer or any parent directory
6fixed-compilation-database: Error while opening fixed database: No such file or directory
7json-compilation-database: Error while opening JSON database: No such file or directory
8Running without flags.
92 warnings generated.
10/work/analyzer/main.c:12:3: warning: Call to function 'strncpy' is insecure as it does not provide security checks introduced in the C11 standard. Replace with analogous functions that support length arguments or provides boundary checks such as 'strncpy_s' in case of C11 [clang-analyzer-security.insecureAPI.DeprecatedOrUnsafeBufferHandling]
11 strncpy(tmp, argv[0], argc);
12 ^~~~~~~
13/work/analyzer/main.c:12:3: note: Call to function 'strncpy' is insecure as it does not provide security checks introduced in the C11 standard. Replace with analogous functions that support length arguments or provides boundary checks such as 'strncpy_s' in case of C11
14 strncpy(tmp, argv[0], argc);
15 ^~~~~~~
16/work/analyzer/main.c:21:2: warning: Potential leak of memory pointed to by 'tmp' [clang-analyzer-unix.Malloc]
17 printf("hello world!\n");
18 ^
19/work/analyzer/main.c:8:22: note: Memory is allocated
20 char *tmp = (char *)malloc(argc);
21 ^~~~~~~~~~~~
22/work/analyzer/main.c:10:5: note: Assuming 'tmp' is non-null
23 if(tmp)
24 ^~~
25/work/analyzer/main.c:10:2: note: Taking true branch
26 if(tmp)
27 ^
28/work/analyzer/main.c:15:6: note: Assuming 'argc' is <= 2
29 if(argc > 2)
30 ^~~~~~~~
31/work/analyzer/main.c:15:3: note: Taking false branch
32 if(argc > 2)
33 ^
34/work/analyzer/main.c:21:2: note: Potential leak of memory pointed to by 'tmp'
35 printf("hello world!\n");
36 ^
compile_commands.json
还是有点用的,但我们RT-Thread项目中代码那么多,一个一个输入太麻烦了。
而且我们代码多是arm和gcc的,而开发机多是x86,clang默认参数也分析不了。
刚才分析结果第1行就有提示,没有找到compilation database,其实scons就可以生成
需要比较新的版本
1python3 -m pip install scons
2python3 -m SCons -v
3SCons by Steven Knight et al.:
4 SCons: v4.0.1.c289977f8b34786ab6c334311e232886da7e8df1, 2020-07-17 01:50:03, by bdbaddog on ProDog2020
5 SCons path: ['/usr/lib/python3/dist-packages/SCons']
6Copyright (c) 2001 - 2020 The SCons Foundation
然后更新下Scons脚本,让生成compile_commands.json
1# git diff SConstruct
2+env.Tool('compilation_db')
3+env.CompilationDatabase()
4# make a building
5DoBuilding(TARGET, objs)
run-clang-tidy
然后使用 run-clang-tidy 就可以自动分析所有的源代码了。
输出html
生成的结果是文本,查看起来还是比较费力的,目前有个简单的转换为html格式,
虽然也比较简陋,但比文本还是方便多了。
欢迎各位朋友移步原帖,交流讨论:https://club.rt-thread.org/ask/article/1b1df03e18ffc73d.html
———————End———————
RT-Thread线下入门培训
5月 - 成都、武汉、西安
1.免费 2.动手实验+理论 3.主办方免费提供开发板 4.自行携带电脑,及插线板用于笔记本电脑充电 5.参与者需要有C语言、单片机(ARM Cortex-M核)基础,请提前安装好RT-Thread Studio 开发环境
立即扫码报名
报名链接
https://jinshuju.net/f/UYxS2k
巡回城市:青岛、北京、西安、成都、武汉、郑州、杭州、深圳、上海、南京
你可以添加微信:rtthread2020 为好友,注明:公司+姓名,拉进RT-Thread官方微信交流群!
👊点击阅读原文,进入RT-Thread 创意创客大赛