Output Directories of the v++ Command - 2021.2 English

Vitis Unified Software Platform Documentation: Application Acceleration Development (UG1393)

Document ID
English (United States)
Release Date
2021.2 English

The directory structure generated by the command-line flow has been organized to let you easily find and access files from the project. By navigating the various compile, link, logs, and reports directories, you can easily find generated files. Similarly, each kernel also has a directory structure created.

When using v++ on the command line, by default it creates a directory structure during compile and link. The XO and xclbin files are always generated in the current working directory. All the intermediate files are created under the directory specified by the --temp_dir option, which defaults to _x when --temp_dir is not specified. The link, logs, and reports directories default to inside of the temp_dir, and contain the respective information on the builds.

You can optionally change the directory structure using the following v++ options:

-–temp_dir <dir_name>
--log_dir <dir_name>
-–report_dir <dir_name>
The example application uses the following command lines:
## Kernel Compilation command:
v++ -t hw_emu --config design.cfg -c -k mmult -I'../src' \
-o'mmult.hw_emu.xilinx_u200_xdma_201830_3.xo' '../src/mmult.cpp'

## Device Binary Linking Command: 
v++ -t hw_emu --config design.cfg -l \
-o'mmult.hw_emu.xilinx_u200_xdma_201830_3.xclbin' mmult.hw_emu.xilinx_u200_xdma_201830_3.xo

The design.cfg file includes the following:



The output directory structure follows, where $cwd is the current working directory from which the commands are launched:

### V++ Command Line Directory Structure

	>emconfig.json -- emulation platform generated by emconfigutil


	>host.exe  -- host executable
	>mmult.hw_emu.xilinx_u200_xdma_201830_3.xclbin  -- device binary generated by v++ --link

	>mmult.hw_emu.xilinx_u200_xdma_201830_3.xclbin.info  -- device binary information file generated by kernelinfo utility

	>mmult.hw_emu.xilinx_u200_xdma_201830_3.xclbin.link_summary  -- summary report of the v++ link command viewable in Vitis analyzer

	>xrt.run_summary  -- summary report of the hardware emulation run viewable in Vitis analyzer

	>mmult.hw_emu.xilinx_u200_xdma_201830_3.xo  -- compiled kernel object file generated by v++ --compile

	>mmult.hw_emu.xilinx_u200_xdma_201830_3.xo.compile_summary  --  summary report of the v++ compile command viewable in Vitis analyzer

	>opencl_summary.csv  -- OpenCL summary produced by XRT during the host/kernel run

	>temp_dir  -- The build directory specified by the --temp_dir option. This defaults to _x when not specified. 

		>link  --  the output files of the link process
					>xsim  --  the Vivado simulator contents with results from hardware emulation
				>xo  -- the temporary kernel files created by the v++ --compile command
			>sys_link  -- files related to the platform used during linking
			>vivado  --  the Vivado Design Suite files for synthesis, implementation, and bitstream generation
					>prj  --  the Vivado Design Suite project files

			>link  -- Logs from the linking process
			>mmult.hw_emu.xilinx_u200_xdma_201830_3  -- Logs from the compiltion process
				>mmult  -- Vits HLS files used and genrated during compilation


			>link  -- Reports generated during the linking process
			>mmult.hw_emu.xilinx_u200_xdma_201830_3  -- Reports generated during the compilation process
		>v++_compile_mmult.hw_emu.xilinx_u200_xdma_201830_3_guidance.json  -- Design guidance generated during compilation


		>v++_link_mmult.hw_emu.xilinx_u200_xdma_201830_3_guidance.json  -- Design guidance generated during linking

	>opencl_trace.csv  -- OpenCL of events generated by XRT during run time. 

	>v++_mmult.hw_emu.xilinx_u200_xdma_201830_3.log  --  Log file generated from the v++ commands


	>xrt.run_summary  -- secondary run_summary report