vitis -debug 命令行 - 2022.1 简体中文

Vitis 统一软件平台文档 应用加速开发 (UG1393)

Document ID
UG1393
Release Date
2022-05-25
Version
2022.1 简体中文

命令行用法

Vitis 软件平台独立调试功能允许您启动 Vitis IDE 以对现有命令行工程进行调试。在以下章节中,对每个命令行选项进行了解释,并提供了为不同平台和目标构建启动独立调试环境的示例。

-debug

vitis -debug

以独立调试模式启动 Vitis IDE。

-flow

-flow [ data_center | embedded_accel | embedded ]

指定要调试的应用工程的类型。该选项会配置 Vitis IDE,以便对 Alveo 卡上运行的数据中心应用进行调试;例如,嵌入式平台(如 zcu104_base 平台)上运行的应用加速工程或嵌入式软件工程。

重要: 对于 embedded 流程和 embedded_accel 流程,您必须使用 launch_hw_emu.shlaunch_sw_emu.sh 脚本来启动 QEMU 系统仿真器 (emulator),这 2 个脚本是在 --package 步骤中(如 嵌入式平台封装 所述)或者使用 launch_emulator.py 命令生成的。

-workspace

-workspace <workspace>

指定在调试模式下打开应用工程时要使用的 Vitis IDE 工作空间。如果不指定该选项,此工具将在当前工作目录中创建名为 workspace 的目录。如果已存在名为 workspace 的目录,那么该工具将使用此目录作为工作空间。

-exe

-exe <path_to_executable>

指定应用(主机)可执行文件的文件名和到此文件的路径。

例如:

vitis -debug -exe ./host.elf

-target

-target [ sw_emu | hw_emu | hw ]
指定用于调试的构建目标。
提示: 该选项仅适用于 data_center 流程和 embedded_accel 流程。

例如:

vitis -debug -target hw_emu

-program-args

-program-args <program arguments>

指定要在运行时传递给主机应用的命令行实参。如果不指定该选项,那么选中 data_center 流程或 embedded_accel 流程时,此工具将传递 .xclbin 作为程序实参。

例如:

vitis -debug -program-args ./xclbin in.dat

-kernels

-kernels <list of kernels>

指定要调试的内核列表。可指定多个内核名称,以逗号分隔。列出的内核定义为函数级别的断点,因此当内核执行开始时,调试器会停止运行。如果不指定内核,则不提供函数级别调试。

该选项仅对 data_center 流程有效,对于 embedded 流程或 embedded_accel 流程则不受支持。

例如:

vitis -debug -kernels mmult madd

-work-dir

-work-dir <path_to_working_directory>

指定用于保存生成的输出文件和报告的工作目录。该选项对 data_center 流程和 embedded_accel 流程有效。

对于 data_center 流程,将在此目录中启动指定的 .exe 文件。对于 embedded_accel 流程,启动目录将由 -target-work-dir 来定义。

提示: 如果不指定该选项,那么将使用当前工作目录作为工作目录。

-target-work-dir

-target-work-dir <Target working directory>

这是目标开发板操作系统和 QEMU 环境上的目录,可执行文件将在此目录中启动。该选项对于 embedded_accel 流程和使用 Linux 操作系统的 embedded 流程有效。

提示: 如果不指定该选项,那么目标工作目录为 /mnt

-xrt-ini

-xrt-ini <path_to_xrt.ini>

指定 xrt.ini 文件的位置。该选项对于 data_center 流程和 embedded_accel 流程有效。

如果不指定位置,它将在应用的 .exe 所在目录中或者在工作目录中查找此位置。

-os

-os [ linux | baremetal ]

指定目标开发板上运行的操作系统。该选项对于 embedded 流程有效。

-host

-host <host_name or ip_address>

指定运行 TCF 代理或 hw_server 的主机系统的名称或 IP 地址。该选项对于 embedded_accel 流程和 embedded 流程有效。如果不指定该选项,那么对于裸机,默认主机名为 localhost,对于 Linux 目标操作系统,默认 IP 地址为 192.168.0.1。

-port

-port <port number>

目标 Linux 上运行的 TCF 代理的端口,或裸机目标的本地主机上运行的 hw_server 的端口。如果不指定该选项,那么对于 tcf-agent,此端口为 1534,对于 hw_server,此端口为 3121。

-launch-script

-launch-script <path_to_tcl_script>

指定将应用连接到调试器之前要通过 source 命令定位的 Tcl 脚本。该选项仅对含裸机操作系统的 embedded 流程有效。Tcl 脚本可包含用于初始化开发板、下载应用、添加断点和使目标做好准备以连接调试器的命令。