Static Memory Consistency Check

Prerequisites

You have logged in to the Kunpeng DevKit.

• /opt/DevKit is the default installation directory of the tool. The following uses this directory as an example. Replace it with the actual directory.
• To perform a 64-bit running mode check on the WebUI, you need to manually upload files or compressed packages. In the IDE, you can simply scan local projects to run the check.

Procedure

1. On the left pane of the page, choose Affinity Analyzer > Static Memory Consistency Check, and click to create a task. See Figure 1.
   Figure 1 Static memory consistency check
   
2. Select a check mode.
   • Static check
   • Auto repair by compiler. For details, see Using the Auto Repair by Compiler.
     

     The static check features low false positive ratio and a repair rate up to 60%. The auto repair by compiler does not miss any report and features a repair rate of 100%, but the false positive ratio is higher. Higher false positive ratio indicates greater impact on performance. The repair rate varies depending on the software, and the impact on performance also varies.

3. Set Source file path using either of the following methods:
   • If you want to use uploaded source code, click the text box and select a source code path from the drop-down list or manually enter a source code path.
   • Click Upload on the right to upload the package or folder. (The package is automatically decompressed during the upload.)
     

     • Only TAR, TAR.BZ, TAR.BZ2, TAR.GZ, TAR.XZ, TBZ, TBZ2, TGZ, TXZ and ZIP packages can be uploaded. Only one package can be uploaded at a time. The source package cannot exceed 1 GB, and the extracted files must be less than or equal to half of the remaining drive space.
     • Only one folder can be uploaded at a time. The size of the folder must be less than or equal to half of the remaining drive space.
4. Set BC File Path using either of the following methods:
   • If you want to use an uploaded BC file, click the text box and select a BC path from the drop-down list or manually enter a BC path.
   • Click Upload on the right to upload the package or folder. (The package is automatically decompressed during the upload.)
   

   • For details about the BC file and how to obtain it, see Generating a BC File.
   • Only TAR, TAR.BZ, TAR.BZ2, TAR.GZ, TAR.XZ, TBZ, TBZ2, TGZ, TXZ and ZIP packages can be uploaded. Only one package can be uploaded at a time. The source package cannot exceed 1 GB, and the extracted files must be less than or equal to half of the remaining drive space.
   • Only one folder can be uploaded at a time. The size of the folder must be less than or equal to half of the remaining drive space.
5. Choose whether to generate a compiler configuration file. The default value is Disabled.
6. Click Check to start the static memory consistency check. After the check is complete, the check report page is displayed. See Figure 2.
   Figure 2 Static memory consistency check report
   
   

   • You can click to sort the source files to be modified by path or number of recommended modifications.
   • You can click Download Report (.csv) or Download Report (.html) to download the report to your local PC.
   • If Generating compiler tool configuration files is selected, you can click Download compiler configuration files to download the file. You can also hover the mouse pointer over the of the target report in the Historical Reports area and select Download compiler configuration files.
   • If the system displays a message indicating that the compiler file is not the latest, click Go to download the file from the latest report. If the system displays a message indicating that the latest report does not contain the compiler configuration file, perform operations as prompted.
7. Click View Suggested Source Code. The Source Code Modification Suggestion tab page is displayed. See Figure 3.
   Figure 3 Source code modification suggestion
   
   

   • The tool supports concurrent running of multiple static memory consistency check tasks.
   • To cancel a task, click Close during the task running process.
   • You can click the arrow keys in the upper right corner of Original Source Code to view the code.
   • If you use shortcut keys to modify the source code, pay attention to shortcut key conflicts caused by the input method or IDE environment.
   • If the check fails or the check result indicates that no modification is required, an empty report is generated.
   • If the system displays a message indicating that the task times out, rectify the fault by following instructions in Task Timed Out.

Using the Auto Repair by Compiler

Table 1 lists the OSs and GCC versions supported by the tool.

• The GCC versions listed are the default GCC versions supported by the OSs. If the GCC version of the server has been upgraded, compatibility issues may occur.
• The supported GCC versions are official GCC branches. Do not use the GCC for openEuler versions.

Before using this function, you need to configure the environment as follows:

1. Download required software packages.
   • GCC source code: https://gcc.gnu.org/ (Download the source code of the corresponding version from the official GCC website.)
   • GCC repair tool patch: https://github.com/kunpengcompute/devkitdriver/tree/main/gccchecker (for Debian and RHEL OSs)
   • Memory consistency repair component: Obtain /devkitplugins/affinity/tools/weakconsistency/gccchecker/gcctool.tar.gz in the DevKit installation directory.
2. Install the memory consistency repair component.
   1. Decompress the installation package.

      1	tar xf gcctool.tar.gz

      After the decompression, check that the following files exist in the gcctool/bin directory:

      gcctool, gcctool-bin, and libstdc++.so.6

   2. Configure environment variables.

      Place gcctool in the installation directory and configure environment variables.

      1	export PATH=/path/to/gcctool/bin:$PATH

3. Apply the GCC patch.
   

   If "'patch' command not found" is displayed, run the following command to install the patch:

   Debian OSs:

   1	apt install patch

   RHEL OSs:

   1	yum install patch

   1 2	cd /gcc/source/root/dir patch -p1 < /path/to/gcc/patch/file

4. Compile GCC.

   For details about how to compile the GCC source code, see the official GCC documents. The patch does not affect the GCC dependency components and the compilation process. If you have any GCC compilation problem, visit the GNU community.

After the environment is set up, perform the following steps to use the tool:

1. Set the optimization level of the memory consistency repair component.

   1	export HW_DEBUG=[ 0 | 1 | 2 ]

   You can set the repair optimization level through an environment variable. The default level is 0.

   • 0: disables the memory consistency repair function.
   • 1: uses component optimization rules. This setting helps minimize the performance loss.
   • 2: uses the most secure repair policy. This setting compromises the performance a lot.
2. (Optional) Define the range of source code that can be automatically fixed.
   1. You can customize the source code repair range by file or function. After the allowlist is configured, the repair component repairs only the content in the list. The allowlist must meet the following requirements:
      • The file list starts with files:. Each file occupies one line.
      • The file path must be an absolute path.
      • Only C, C++, and Fortran files are supported. Pure assembly files are not supported.
      • The function list starts with functions:. Each function occupies one line.
      • C/C++ common functions are supported. Templates or functions with the abi_tag attribute are not supported.

      Allowlist example:

      1 2 3 4 5 6 7 8 9 10 11 12 13

      files: /path/to/file/a /path/to/./file/b /path/to/../file/c /path/to/file/d functions: func_a func_b() func_c(int xxx) int func_d() classA::func_e ns::classB::func_f() std::string nsA::nsB::classC::func_g(int xxx)

   2. The repair component obtains the path of the allowlist.

      You can set environment variables to specify the path of the allowlist. The path is not specified by default.

      export AUTOFIXLIST=/path/to/allowlist

3. Compile software.

   The compilation process remains unchanged.

   

   Remove the -pipe compilation option if it is used in the previous compilation. This does not affect the result of the previous compilation.