MindStudio Debug VSCode Plugin

介绍

MindStudio Debug VSCode Plugin基于msdebug上板调试算子工具提供VSCode可视化调试昇腾算子功能。附：算子开发编程语言Ascend C简介

特性

断点调试（设置/删除/禁用/启用断点）
单步执行调试(逐行执行/内部执行/跳出函数)/继续/暂停/重启
查看变量/寄存器/堆栈/断点信息，监视器支持执行表达式
内存查询
核切换

规格要求

VSCode-huawei (v1.81.3版本及以上)
VSCode-huawei已安装远程登录插件
支持平台: Linux
调试AscendC算子程序时，Linux环境已安装CANN工具包（含算子调试器）
仅支持调试AscendC算子，且算子经过调试模式重新编译后才能调试
当前支持的CANN包最低版本：
- 社区版： 8.0.RC3.alpha001
- 商用版：暂不支持

约束

参考CANN工具包的约束要求

功能

快速使用

打开VSCode-huawei IDE界面，安装远程登录插件(如Remote-SSH)
IDE界面远程SSH登录算子开发环境，打开已编译的算子工程文件(本插件不具备编译功能)
安装MindStudio Debug VSCode Plugin插件

IDE界面离线本地安装

 - 插件.vsix文件上传linux环境
 - 展开IDE界面左侧边栏的插件菜单
 - 点击右上角...图标，选择Install from VSIX...选项，选择本地的插件文件进行安装

后台命令行离线本地安装

 - 插件.vsix文件上传linux环境
 - 后台输入命令安装插件文件: code --install-extension /xx_dir/MindStudio-Debug-VSCode-Plugin-1.0.1.vsix

点开debug侧边工具栏，若未生成.vscode/launch.json文件，则根据提示点击生成launch.json文件(弹窗中调试器选择MSDebug)

需要注意vscode当前打开目录的选择，因为当前目录会影响launch.json文件中cwd参数的值。若msdebug的调试参数文件和打断点的源码文件不直接在同一个目录下（比如源码在src目录下，测试用例在test目录下），则建议切换当前目录为共同的父目录下，再创建.vscode/launch.json文件。

在.vscode/launch.json中添加调试配置(格式参考下面推荐配置)
debug侧边工具栏中，选择已配置的调试器，点击debug或按F5启动调试

launch方式推荐配置

{
    "configurations": [
        {
            "name": "xx-debug",
            "type": "msdebug-mi",
            "request": "launch",
            "cwd": "${workspaceFolder}",
            "target": "/xxx/xx/xx_operator",
            "targetArgs": [
                "arg1",
                "arg2"
            ]
            "msdebugMiPath": "/xx/x/msdebug-mi",
            "environmentScripts": [
                "/xxx/xx/Ascend/ascend-toolkit/set_env.sh",
                "/xxx/xx/xx-user-bussiness/set_env.sh"
            ],
            "environment": [{
                "name": "LD_LIBRARY_PATH",
                "value": "/xx/x/lib:${LD_LIBRARY_PATH}"
            },{
                "name": "LAUNCH_KERNEL_PATH",
                "value": "/yy/y/yy_operator.o"
            }]
        }
    ]
}

name 调试插件的名称
type 固定值"msdebug-mi"
request 固定值"launch"
cwd 调试器启动的工作目录。注意：当target和targetArgs参数不为绝对路径时，cwd参数在target和targetArgs参数上生效。${workspaceFolder}为vscode IDE的当前打开目录。
target (必要配置项)被调试的可执行文件的路径。target可设为算子二进制文件，或者python等二进制命令，建议配置绝对路径
targetArgs 可选配置，被调试的算子可执行文件的参数列表。举例"targetArgs": ["arg1","arg2"]，底层msdebug-mi调试命令调用效果等价于: # msdebug ${target} ${arg1} ${arg2}，若不配置target和targetArgs的绝对路径，则默认加上cwd的路径前缀。
printMiInput 可选配置，打印msdebug-mi的输入命令日志。默认为false建议不配置，避免生成大量冗余日志
printMiOutput 可选配置，打印msdebug-mi的命令输出信息日志。默认为false建议不配置，避免生成大量冗余日志
skipEnvCheck 可选配置，插件初始化加载时是否跳过环境校验。默认为false建议不配置
msdebugMiPath 可选配置，调试器路径，不配置默认为$ASCEND_TOOLKIT_HOME/tools/msdebug/bin/msdebug-mi
environmentScripts 可选配置，为包含msdebug启动所需的环境变量的.sh脚本数组(注：每个脚本每行格式要求:export XX_KEY=XX_VALUE，不支持脚本中包含其他格式文本，包括shell逻辑!!)，依次加载数组中各脚本中的环境变量。若有重复设置可能会产生值覆盖。
environment 可选配置，为包含自定义环境变量的对象数组，在加载完environmentScripts脚本中的环境变量后依次加载environment中的环境变量，格式需满足:[{"name": "xxx", "value":"yyy"}]。若和environmentScripts配置的脚本中有重复设置的环境变量可能会产生值覆盖。

断点调试（设置/删除/禁用/启用断点）

可以在算子程序行号显示处设置、删除、禁用、用断点，也可以在debug侧边工具栏中的底部断点工具栏执行相同操作。

单步执行调试(逐行执行/内部执行/跳出函数)/继续/暂停/重启

可以单击顶部调试工具栏上的图标控制程序，包括单步执行、步入、步出、继续、暂停、重启或停止程序的操作。

查看变量/寄存器/堆栈/断点信息，监视器支持执行表达式

启动调试后，程序会停止在断点，当进程处于停止状态时，可以在IDE界面左侧查看当前线程的变量、堆栈、监视器和断点信息。其中监视器支持执行表达式。

内存查询

变量右键内存查询
调试停在断点时，光标移到代码编辑区的变量上，右键并点击Read Memory菜单跳转到内存查看页面，支持切换数据类型和列数改变内存展示效果
自定义内存查看
点击右下角Read Memory菜单项也可跳转到内存查看页面。支持手动输入内存位置、内存地址、内存大小来进行自定义内存位置的内存查看

核切换

左下角展开KERNEL FOCUS工具栏，可查看核状态，高亮行是当前所在核；点击其他行数据进行切核