开发者
资源
我要评分
获取效率
正确性
完整性
易理解
在线提单
论坛求助

单文件扫描模式使用场景

用户可以通过在命令./tiancheng之后,添加“-i”参数的方式,实现对单个源码文件中所有源码的扫描和分析。

前提条件

以天秤源码优化工具安装路径“/home/tiancheng-x.x.x-Linux-Kunpeng”为例。

单文件扫描使用示例

  1. 对单个源码文件进行扫描并输出分析报告。此处以扫描“/home/demo”下的input.cpp文件中所有源码,分析报告存放至“/home/demo”路径为例,请根据实际情况进行修改。
    ./tiancheng -i /home/demo/input.cpp -o /home/demo -r /path/to/code_project

    扫描“/home/demo”下的input.cpp文件,在“/home/demo”下生成向量化检查报告和JSON报告文件。同时指定待分析源码文件所属项目的根目录“/path/to/code_project”,避免头文件缺失。

    返回信息如下:

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    Warning: Single file mode uses '-i'. '-r' will be ignored.
    Compile database file does not exist or is unreachable.
    Analyzing file: /home/demo/input.cpp
    Start to recognize file: /home/demo/input.cpp   // 提示开始识别input.cpp源文件。
    compile_commands.json not found under: /path/to/code_project
    Recursively collecting include paths as fallback. 
    Start to scan code.   // 提示开始扫描代码。
    
    
    Vectorization check task is being executed. Please wait...
    Scanning start time: 2026/05/27 17:02:05
    Successfully generated vectorization report: /home/demo/Vectorization_Source_20260527_170218_072_3691.html   // 提示向量化检查报告文件的存放路径。
    Successfully generated vectorization optimization result: /home/demo/Vectorization_Optimization_Result_20260527_170218_072_3691.json   // 提示JSON报告文件的存放路径。
    

    可打开JSON报告文件查看分析结果。若提示头文件找不到,请参见使用天秤源码优化工具扫描源码文件提示头文件找不到进行处理。

  2. 打开生成的JSON报告文件,分析并确认修改点。
    vim /home/demo/Vectorization_Optimization_Result_20260527_170218_072_3691.json

    JSON文件详情如下:

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    {
      "advisor_items": [
        {
          "opt_file": {
            "begin_line": 18,
            "description": "",
            "end_line": 19,
            "fileName": "/home/demo/input.cpp",
            "headerFile": "#include <arm_neon.h>",
            "headerLocBegin": 9,
            "headerLocEnd": 9,
            "sample_code": "    int64_t j = 0;\n    for (; j + 4 < nb; j += 4) {\n        vst1q_f32(dis + j, vaddq_f32(vdupq_n_f32(qNorm), vld1q_f32(bNorms + j)));\n    }\n    for (; j < nb; j++) dis[j] = qNorm + bNorms[j];"
          }
        },
        {
          "opt_file": {
            "begin_line": 25,
            "description": "",
            "end_line": 27,
            "fileName": "/home/demo/input.cpp",
            "headerFile": "#include <arm_neon.h>",
            "headerLocBegin": 9,
            "headerLocEnd": 9,
            "sample_code": "    int64_t j = 0;\n    for (; j + 4 < nb; j += 4) {\n        vst1q_f32(dis + j, vaddq_f32(vdupq_n_f32(qNorm), vld1q_f32(bNorms + j)));\n    }\n    for (; j < nb; j++) {\n        dis[j] = qNorm + bNorms[j];\n    }"
          }
        },
        {
          "opt_file": {
            "begin_line": 48,
            "description": "",
            "end_line": 50,
            "fileName": "/home/demo/input.cpp",
            "headerFile": "#include <arm_neon.h>",
            "headerLocBegin": 9,
            "headerLocEnd": 9,
            "sample_code": "    int64_t j = 0;\n    for (; j + 4 < nb; j += 4) {\n        vst1q_f32(dis + j, vaddq_f32(vld1q_f32(dis + j), vdupq_n_f32(qNorm)));\n    }\n    for (; j < nb; j++) {\n        dis[j] += qNorm;\n    }"
          }
        }
      ],
      "code": 0,
      "recognizedPattern": 3
    }
    
    表1 字段说明

    字段

    字段说明

    advisor_items

    代码优化点建议数组,里面的每一项都是一个代码优化点建议。

    opt_file

    单个优化建议的详细信息。

    begin_line

    需要优化代码的起始行号。

    示例中“18”为优化代码的起始行号。

    description

    优化建议的详细描述。

    end_line

    需要优化代码的结束行号。

    示例中“19”为优化代码的结束行号。

    fileName

    当前分析的源文件所在路径。

    示例中“/home/demo/input.cpp”为分析的源文件所在路径。

    headerFile

    需要添加的头文件。

    示例中“#include <arm_neon.h>”表明此段代码需要添加ARM NEON的头文件,用于使用NEON指令集。

    headerLocBegin

    头文件插入的起始行号。

    • 若为-1,表示头文件在原始代码中已经包含,无需手动添加。
    • 若为正整数,表示头文件插入的起始行号。

    示例中“9”为头文件插入的起始行号。

    headerLocEnd

    头文件插入的结束行号。

    • 若为-1,表示头文件在原始代码中已经包含,无需手动添加。
    • 若为正整数,表示头文件插入的结束行号。

    示例中“9”为头文件插入的结束行号。

    sample_code

    推荐的向量化实现代码样例,可直接用于替换源文件的原始代码。

    示例中以下代码为优化后的代码样例。

        int64_t j = 0;\n    for (; j + 4 < nb; j += 4) {\n        vst1q_f32(dis + j, vaddq_f32(vdupq_n_f32(qNorm), vld1q_f32(bNorms + j)));\n    }\n    for (; j < nb; j++) dis[j] = qNorm + bNorms[j];

    code

    工具执行状态码。

    • 0表示工具执行成功。
    • 非零值表示异常中断

    示例中“0”表明工具执行成功。

    recognizedPattern

    需要优化的代码段数量。

    示例中“3”表明有3处代码需要优化。

  3. 根据JSON报告进行代码改写。
    1. 查看advisor_items,其中包含了所有识别到的优化建议。
    2. 对于每个优化建议,查看begin_line和end_line字段,确定需要替换的代码范围。
    3. 将sample_code字段中的向量化代码复制并替换源文件对应位置的代码(第begin_line行至第end_line行)。
    4. 检查headerLocBegin和headerLocEnd字段:
      • 如果值为-1,表示头文件已存在,无需添加。
      • 如果为正整数,需要在指定位置添加headerFile中的头文件声明。
    5. 保存修改后的文件,即可完成自动化改写。