快速入门

准备调试环境

  1. 参考环境准备完成配套版本NPU驱动包的安装。

    • 若要使能msdebug工具,安装驱动时需要指定--debug参数,驱动安装请参考CANN 软件安装指南中的“安装驱动和固件”章节。
      ./Ascend-hdk-<chip_type>-npu-driver_<version>_linux-<arch>.run --debug
    • 调试通道权限较大,存在安全风险,请谨慎使用,生产环境不推荐使用,使用本调试工具即代表认可并接受该风险。

  2. 参考环境准备完成CANN相关软件包的安装。

    若安装CANN相关软件包时提示与驱动版本不匹配,可使用“--force”强制安装,该参数需要配合“--install”一起使用。

调试编译

Ascend C算子的kernel侧源码通过毕昇编译器进行编译,编译后生成NPU域的可执行文件。编译选项添加 -g -O0,使算子编译时包含了所需的调试信息,以便于使用msDebug工具进行调试,具体方法可参考使用示例

工具启动

msdebug工具安装在Ascend-cann-toolkit开发套件包中,工具路径为${INSTALL_DIR}/tools/msdebug/bin/msdebug。

  • ${INSTALL_DIR}请替换为CANN软件安装后文件存储路径。例如,若安装的Ascend-cann-toolkit软件包,则安装后文件存储路径为:$HOME/Ascend/ascend-toolkit/latest。
  • 若完成了环境准备章节中的环境变量配置,则无需切换目录直接执行msdebug命令。

msdebug工具支持以下两种启动方式:

若工具弹出Cannot read termcap database; using dumb terminal settings. 的提示信息,可以通过配置export TERMINFO=xx消除提示,xx为本地TERMINFO路径:
export TERMINFO=xx    //xx信息可通过infocmp -D命令查询,可以选择符合当前终端配置的路径做为TERMINFO值

调试退出

输入以下命令,退出调试器。
(msdebug) q
[localhost add_ascendc_sample]$ 

该调试通道无法单独关闭,若要关闭调试通道,需要通过覆盖安装方式,具体请参见对应的NPU驱动和固件安装文档。

获取帮助

可以使用help命令输出工具命令的帮助信息,格式为“help msdebug_command”。

打印信息将会展示该命令的功能描述、使用语法以及参数选项。

核切换命令的帮助信息如下所示:
(msdebug) help ascend aic
change the id of the focused ascend aicore.
Syntax: ascend aic <id>

ascend info blocks命令的帮助信息如下所示:

(msdebug) help ascend info blocks
show blocks overall info.
Syntax: ascend info blocks
Command Options Usage:
  ascend info blocks [-d]
       -d ( --details )
            Show stopped states for all blocks.