Data Race Check

Command Function

Dynamically checks for data race in source code.

Syntax

devkit advisor dr-check [-h | --help] {-f ELF_FILE | --elf-file ELF_FILE} [-i INPUT_PATH | --input INPUT_PATH] [-s SAFE_FILE | --safe-file SAFE_FILE][-p ELF_PARAMS | --elf-params ELF_PARAMS] [-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]

Parameter Description

Example

In this example, the source file in the /home/testcase/project directory is scanned. Replace the example directory with the actual one.

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

The following information is displayed and a report is generated:

Scanned time: 2024/07/16 14:01:30
 
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_20240716140130_6480.json
    /home/ DevKit_Software /dr-check_20240716140130_6480.html
    /home/ DevKit_Software /dr-check_20240716140130_6480.csv

Example of Secure Functions

To add the -s/--safe-funcs parameter, you need to specify the CFG configuration file. In the configuration file, write the name of a secure function in each line. If the source file is a CPP file, write the name of the overloaded secure function.

The following example describes how to add a lock for a user-defined class. Add secure functions based on your requirements.

class my_custom_spinlock{
    std::atomic_flag is_locked ={false};
public:
  void lock(){
      while (is_locked.test_and_set(std::memory_order_acquire)){}
  }
  
  void unlock (){
      is_locked .clear (std :: memory_order_release);
  }
};
 
int data_race = 0;
 
my_custom_spinlock spinlock;
void* first_thread(void* arg){
    spinlock.lock();
    data_race = 5;
    spinlock.unlock();
    return 0;
}
 
void* second_thread(void* arg){
    spinlock.lock();
    data_race = 3;
    spinlock.unlock();
    return 0;
}

You can run the nm command to view the names of the reloaded first_thread and second_thread functions.

nm test

0000000000400a84 T _Z12first_threadPv
0000000000400ac4 T _Z13second_threadPv

You can create the safe_functions.cfg file and write the following content to the file:

_Z12first_threadPv
_Z13second_threadPv

Output Report