数据竞争检查功能说明

只支持对单进程应用进行数据竞争检查，且GCC版本在9.4.0以上。

命令功能

动态检查源码中数据竞争的情况。

命令格式

devkit advisor dr-check [-h | --help] {-f ELF_FILE | --elf-file ELF_FILE} [-i INPUT_PATH | --input INPUT_PATH] [-ec {true,false} | --enable-collect {true,false}] [--start-collect PID] [--stop-collect PID] [-s SAFE_FILE | --safe-file SAFE_FILE] [-p ELF_PARAMS | --elf-params ELF_PARAMS] [-o OUTPUT_PATH | --output OUTPUT_PATH] [-sf SHIELD_FILE | --shield-file SHIELD_FILE] [-cf CONFIG_FILE | --config-file CONFIG_FILE] [-d REPORT_FILE | --decode REPORT_FILE] [-sr {true,false} | --summary-report {true,false}] [-eb {true,false} | --enable-backtrace {true,false}] [-r {all,json,html,csv} | --report-type {all,json,html,csv}] [-l {0,1,2,3} | --log-level {0,1,2,3}] [--set-timeout TIMEOUT]

参数说明

表1 参数说明
参数	参数选项	参数说明
-h/--help	-	获取帮助信息。
-f/--elf-file	ELF_FILE	必选参数，ELF文件路径。待测ELF文件必须带有调试信息（编译时增加-g选项）。 ELF文件是指编译C/C++程序生成的二进制文件。
-i/--input	INPUT_PATH	可选参数，ELF文件对应的源码文件夹路径。
-ec/--enable-collect	true/false	可选参数，启动应用时是否开启数据竞争检查功能，默认为true。 true：开启数据竞争检查功能。 false：关闭数据竞争检查功能。
--start-collect	PID	可选参数，对指定的进程发送开启数据竞争检查功能信号，指定的进程号为有效的数据竞争检查进程。说明： -ec参数为false时，配置--start-collect参数生效。
--stop-collect	PID	可选参数，对指定的进程发送关闭数据竞争检查功能信号，指定的进程号为有效的数据竞争检查进程。说明： -ec参数为true时，配置--stop-collect参数生效。
-s/--safe-file	SAFE_FILE	可选参数，cfg配置文件。指定在动态数据竞争检测中不进行检查的安全函数，C++中函数名称需为重载后的函数名称。
-p/--elf-params	ELF_PARAMS	可选参数，指定执行ELF文件时所需的输入参数。
-o/--output	OUTPUT_PATH	可选参数，扫描报告的存放路径，默认存放在当前执行路径下，报告名称为模块名称_时间戳。
-sf/--shield-file	SHIELD_FILE	可选参数，cfg配置文件。指定在动态数据竞争检测中不参与检查的文件名或动态库。
-cf/--config-file	CONFIG_FILE	可选参数，json配置文件。指定在动态内存一致性检测期间不检查数据竞争的自定义锁。
-d/--decode	REPORT_FILE	可选参数，历史报告文件。指定运行过程中保存的历史报告文件，最多支持保存5份历史报告，指定该选项后将进行单独报告解析。说明：历史报告文件生成后存放在DevKit命令行亲和分析工具（advisor）所在路径下。报告名称为：ELF文件名_时间戳.memtracer_report -d参数指定的历史报告文件对应的ELF文件要与-f指定的ELF文件相匹配。
-sr/--summary-report	true/false	可选参数，是否生成精简报告，默认为false。 true：生成精简报告，仅生成json格式。 false：生成-r选项指定的全量报告。说明：精简后的json报告中仅包含address、location、type、file、line、function、source_code、core_code和backtrace。若同时指定-sr和-r参数，且-sr参数选项指定为true，-r参数失效。
-eb/--enable-backtrace	true/false	可选参数，是否开启调用栈记录，默认为false。 true：开启调用栈记录。 false：关闭调用栈记录。
-r/--report-type	all/json/html/csv	可选参数，扫描报告的格式，默认为all。 all：生成JSON、HTML、CSV三种格式报告。 json：生成JSON格式报告。 html：生成HTML格式报告。 csv：生成CSV格式报告。
-l/--log-level	0/1/2/3	可选参数，设置日志级别，默认为1。 0：日志级别为DEBUG。 1：日志级别为INFO。 2：日志级别为WARNING。 3：日志级别为ERROR。
--set-timeout	TIMEOUT	可选参数，任务超时时间，单位为分钟，若执行时间超过超时时间则退出执行。默认无超时时间，任务将持续执行直到结束。

使用示例

此处以扫描“/home/testcase/project”路径下源码文件为例，请根据实际情况进行修改。

devkit advisor dr-check -i /home/testcase/project -f /home/advisor/test

返回信息如下，并输出报告。

Executing data race check task, please wait...
The pid of the memtracer process is 3517879
Scanned time: 2025/05/14 08:54:50
 
Configuration:
    Elf file path: /home/advisor/test
    Scan source code path: /home/testcase/project
    Generate report path: /home/DevKit_Software
    Generate report type: all
    Task Timeout Interval: The timeout period is not set.
    Log level: info
 
Summary:
There are 2 recommendable code lines to modify.
 
For the details information, please check:
    /home/DevKit_Software/dr-check_20250514085450_0541.json
    /home/DevKit_Software/dr-check_20250514085450_0541.html
    /home/DevKit_Software/dr-check_20250514085450_0541.csv

输出报告说明

表2 数据竞争检查输出报告参数说明
参数	说明
配置信息	显示软件源码文件及可执行文件存放路径。
需要修改的源码文件	显示存在数据竞争问题，并需要进行修改的源码文件路径等相关信息。

父主题： 数据竞争检查