Command Parameter Description

The tool checks for any memory consistency problem when the source code is ported to the Kunpeng platform and provides suggestions on inserting memory barriers.

Command Function

Displays all command parameters used for memory consistency check.

Syntax

devkit advisor mem-cons -h

Example

Run the following command to query the parameter descriptions of all commands.

devkit advisor mem-cons -h

The command output is as follows:

 OVERVIEW
        Run this command to check for any memory consistency problem when the source code is ported to the Kunpeng platform and provides suggestions on inserting memory barriers.

    USAGE
        devkit advisor mem-cons {-i INPUT_PATH | --input INPUT_PATH}{-f BC_PATH | --bc-file BC_PATH} [--autofix {true,false}] [--autofix-dir AUTOFIX_OUTPUT_PATH] [-o OUTPUT_PATH | --output OUTPUT_PATH] [-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]

    OPTIONS
        -i, --input INPUT_PATH
            [Mandatory option] Specifies the folder path of the source code to be scanned.
        -f, --bc-file BC_PATH
            [Mandatory option] Specifies the folder path of the bc file to be scanned. For the detail, please refer to the following document:
'https://www.hikunpeng.com/document/detail/zh/kunpengdevps/userguide/usermanual/DevKit_Affinity_0018.html'.
        --autofix {true,false}
            Specifies whether to generate the compiler configuration file.
        --autofix-dir   AUTOFIX_OUTPUT_PATH
            Specify the path for storing the compile configuration file. By default, the file is stored in the current path(pwd) and its name is in the format of function autofixlist_timestamp.
        -o, --output OUTPUT_PATH
            Specify the path for storing the scan report and the file name. By default, the file is stored in the current path(pwd) and its name is in the format of function name_timestamp.
        -l, --log-level {0,1,2,3}
            Specifies the log level of the current task, 0(DEBUG) | 1(INFO) | 2(WARNING) | 3(ERROR). The default value is 1(INFO).
        -r, --report-type {all,json,html,csv}
            Specify the report type for the scan report. The default value is all.
        --set-timeout <min>
            Specifies the timeout period of a task. By default, the timeout period is not set.

    EXAMPLE
        # Scan a project and generate scanning reports.
        devkit advisor mem-cons -i /home/advisor/project -f /home/advisor/bc_file

Parent topic: Memory Consistency Check