Vitis

Vitis

Getting Started

https://xilinx.github.io/Vitis-Tutorials/

System Requirements

https://docs.xilinx.com/r/en-US/ug1393-vitis-application-acceleration/Installation-Requirements

Operating System: Red Hat or Ubuntu (64-bit)
System Memory: 32 GB
Storage Space: 150-400 GB

Installation on Linux/Ubuntu

Prerequisites

https://support.xilinx.com/s/article/63794
https://support.xilinx.com/s/question/0D52E00006iHjbcSAC/vivado-20211-installation-hangs-at-generating-installed-device-list

## Update (as needed)
sudo apt update
sudo apt upgrade

sudo apt install libncurses5
sudo apt install libtinfo5
sudo apt install libncurses5-dev
sudo apt install libncursesw5-dev

## Install libX11.so.6
sudo apt install libx11-6

## Install libX for JRE
sudo apt install libxext6
sudo apt install libxrender1
sudo apt install libxtst6
sudo apt install libxi6

## Install locale en_US.UTF-8
sudo apt install locales
sudo locale-gen en_US.UTF-8

## Editor (as needed)
sudo apt install vim

## Terminal Multiplexer (as needed)
sudo apt install screen

## Disable X11 DISPLAY (as needed)
export DISPLAY=:0.0

Download Vitis

https://www.xilinx.com/products/design-tools/vitis/vitis-platform.html

Download Linux Self Extracting Web Installer (or Single-File Download) from Xilinx
Batch-mode installation using web installer is now available

Batch-Mode Installation

https://docs.xilinx.com/r/en-US/ug973-vivado-release-notes-install-license/Batch-Mode-Installation-Using-Web-Installer
https://docs.xilinx.com/r/en-US/ug973-vivado-release-notes-install-license/Batch-Mode-Installation-Flow

In case of Version 2023.1:
- The total size of installers would be around 100 GB depending on selected modules
- The required disk space during the installation would be around 200-400 GB
- One of the largest components is 'Devices for Alveo and Edge Acceleration Platforms' as around 70-80 GB
- Another large component is the 'Versal' series as around 100 GB in total

## Case A: Web Installer
chmod 755 ./Xilinx_Unified_2023.1_0507_1903_Lin64.bin
./Xilinx_Unified_2023.1_0507_1903_Lin64.bin --keep --noexec --target Xilinx_Unified_2023.1_0507_1903_Lin64

## Case B: Single-File Installer
#tar xvfz Xilinx_Unified_2023.1_0507_1903.tar.gz

Creating directory Xilinx_Unified_2023.1_0507_1903_Lin64
Verifying archive integrity... All good.
Uncompressing AMD Installer for FPGAs and Adaptive SoCs.......

cd Xilinx_Unified_2023.1_0507_1903_Lin64
#cd Xilinx_Unified_2023.1_0507_1903

## Authentication Token
./xsetup -b AuthTokenGen

This is a fresh install.
INFO Could not detect the display scale (hDPI).
       If you are using a high resolution monitor, you can set the insaller scale factor like this:
       export XINSTALLER_SCALE=2
       setenv XINSTALLER_SCALE 2
Running in batch mode...
Copyright (c) 1986-2022 Xilinx, Inc.  All rights reserved.
Copyright (c) 2022-2023 Advanced Micro Devices, Inc.  All rights reserved.
INFO  - Internet connection validated, can connect to internet.
INFO  - In order to generate the authentication token please provide your AMD account E-mail Address and password.

E-mail Address: [E-MAIL]
Password: [PASSWORD]
INFO  - Generating authentication token...
INFO  - Saved authentication token file successfully, valid until 07/26/2023 02:51 AM

## Configuration File
./xsetup -b ConfigGen

This is a fresh install.
INFO Could not detect the display scale (hDPI).
       If you are using a high resolution monitor, you can set the insaller scale factor like this:
       export XINSTALLER_SCALE=2
       setenv XINSTALLER_SCALE 2
Running in batch mode...
Copyright (c) 1986-2022 Xilinx, Inc.  All rights reserved.
Copyright (c) 2022-2023 Advanced Micro Devices, Inc.  All rights reserved.

Select a Product from the list:
1. Vitis
2. Vivado
3. On-Premises Install for Cloud Deployments
4. BootGen
5. Lab Edition
6. Hardware Server
7. Power Design Manager (PDM)
8. PetaLinux
9. Documentation Navigator (Standalone)

Please choose: 1
INFO  - Config file available at /home/[USER]/.Xilinx/install_config.txt. Please use -c <filename> to point to this install configuration.

## Optimize Configuration (as needed)
vi ~/.Xilinx/install_config.txt
======================================================
Destination=/tools/Xilinx
======================================================
## Default
Modules=Versal HBM Series:1,Versal Prime Series ES1:0,Virtex UltraScale+ 58G:1,Versal Prime Series:1,Install Devices for Kria SOMs and Starter Kits:1,Versal Premium Series ES1:0,Vitis IP Cache (Enable faster on-boarding for new users):0,Versal Net Series ES1:0,Zynq-7000:1,Kintex UltraScale+:1,Artix UltraScale+:1,Spartan-7:1,Install devices for Alveo and edge acceleration platforms:1,Versal Premium Series:1,Versal AI Edge Series:1,Versal AI Core Series ES1:0,Versal AI Edge Series ES1:0,Artix-7:1,Zynq UltraScale+ MPSoC:1,DocNav:1,Virtex UltraScale+ HBM:1,Kintex-7:1,Virtex UltraScale+:1,Vitis Model Composer(Toolbox for MATLAB and Simulink. Includes the functionality of System Generator for DSP):1,Kintex UltraScale:1,Virtex UltraScale:1,Engineering Sample Devices for Custom Platforms:0,Zynq UltraScale+ RFSoC:1,Versal AI Core Series:1,Virtex-7:1,Virtex UltraScale+ HBM ES:0,Versal HBM Series ES1:0
## Case A: Download 90 GB
Modules=Versal HBM Series:0,Versal Prime Series ES1:0,Virtex UltraScale+ 58G:0,Versal Prime Series:0,Install Devices for Kria SOMs and Starter Kits:1,Versal Premium Series ES1:0,Vitis IP Cache (Enable faster on-boarding for new users):1,Versal Net Series ES1:0,Zynq-7000:1,Kintex UltraScale+:0,Artix UltraScale+:0,Spartan-7:1,Install devices for Alveo and edge acceleration platforms:1,Versal Premium Series:0,Versal AI Edge Series:0,Versal AI Core Series ES1:0,Versal AI Edge Series ES1:0,Artix-7:1,Zynq UltraScale+ MPSoC:1,DocNav:0,Virtex UltraScale+ HBM:0,Kintex-7:1,Virtex UltraScale+:0,Vitis Model Composer(Toolbox for MATLAB and Simulink. Includes the functionality of System Generator for DSP):1,Kintex UltraScale:0,Virtex UltraScale:0,Engineering Sample Devices for Custom Platforms:0,Zynq UltraScale+ RFSoC:1,Versal AI Core Series:0,Virtex-7:1,Virtex UltraScale+ HBM ES:0,Versal HBM Series ES1:0
## Case B: Download 25 GB
Modules=Versal HBM Series:0,Versal Prime Series ES1:0,Virtex UltraScale+ 58G:0,Versal Prime Series:0,Install Devices for Kria SOMs and Starter Kits:1,Versal Premium Series ES1:0,Vitis IP Cache (Enable faster on-boarding for new users):1,Versal Net Series ES1:0,Zynq-7000:1,Kintex UltraScale+:0,Artix UltraScale+:0,Spartan-7:1,Install devices for Alveo and edge acceleration platforms:0,Versal Premium Series:0,Versal AI Edge Series:0,Versal AI Core Series ES1:0,Versal AI Edge Series ES1:0,Artix-7:1,Zynq UltraScale+ MPSoC:1,DocNav:0,Virtex UltraScale+ HBM:0,Kintex-7:1,Virtex UltraScale+:0,Vitis Model Composer(Toolbox for MATLAB and Simulink. Includes the functionality of System Generator for DSP):1,Kintex UltraScale:0,Virtex UltraScale:0,Engineering Sample Devices for Custom Platforms:0,Zynq UltraScale+ RFSoC:1,Versal AI Core Series:0,Virtex-7:1,Virtex UltraScale+ HBM ES:0,Versal HBM Series ES1:0
======================================================
CreateDesktopShortcuts=0
======================================================
EnableDiskUsageOptimization=1
======================================================

## Preparing Install Directory
sudo mkdir -p /tools/Xilinx
sudo chown -R $(whoami):$(whoami) /tools/Xilinx

## Using a terminal multiplexer (e.g., screen, tmux) is recommended because downloading installers takes several (or more) hours
screen

## Vitis Installation
./xsetup -b Install -a XilinxEULA,3rdPartyEULA -c ~/.Xilinx/install_config.txt | tee ~/.Xilinx/xinstall/xinstall-vitis.log

This is a fresh install.
INFO Could not detect the display scale (hDPI).
       If you are using a high resolution monitor, you can set the insaller scale factor like this:
       export XINSTALLER_SCALE=2
       setenv XINSTALLER_SCALE 2
Running in batch mode...
Copyright (c) 1986-2022 Xilinx, Inc.  All rights reserved.
Copyright (c) 2022-2023 Advanced Micro Devices, Inc.  All rights reserved.
INFO  - User has accepted the EULAs.
INFO  - Internet connection validated, can connect to internet.
INFO  - Authenticated user [E-MAIL] successfully.
INFO  - Installing Edition: Vitis Unified Software Platform
INFO  - Installation directory is /tools/Xilinx

## Alveo and Edge Acceleration Platforms included:
Downloading files (100.76 GB / 100.76 GB) <1 minute left at 6 MB/sec. (Done)
It took 7 h and 20 m(s) to download files.

## Alveo and Edge Acceleration Platforms excluded:
Downloading files (24.81 GB / 24.81 GB) <1 minute left at 3 MB/sec. (Done)
It took 2 h and 28 m(s) to download files.
Installing files, 100% completed. (Done)
It took 1 h and 2 m(s) to install files.

## Minimal Configuration of Version 2022.1:
Downloading files (52.67 GB / 52.67 GB) <1 minute left at 4 MB/sec. (Done)
It took 3 h and 13 m(s) to download files.
Installing files, 100% completed. (Done)
It took 1 h and 52 m(s) to install files.

INFO  - Installation completed successfully.

Troubleshooting - No X11 DISPLAY Variable

## No X11 DISPLAY variable was set, but this program performed an operation which requires it.

## Disable X11 DISPLAY
export DISPLAY=:0.0

Troubleshooting - Xargs: File Not Found (TBD)

https://support.xilinx.com/s/question/0D54U00005ZOIq0SAH/vitis-20221-docker-image-creation-stalling-after-successful-install-but-with-a-post-installation-task-warning

## ######## Execution of Pre/Post Installation Tasks Failed ########
## Warning: AMD software was installed successfully, but an unexpected status was returned from the following post installation task(s)
## xargs: file: No such file or directory sed: no input files

No need to fix this error if running the installer on a virtual machine without GUI

Troubleshooting - libX11.so.6 Not Found

## ERROR: [Common 17-258] Couldn't open 'libX11.so.6': 'libX11.so.6: cannot open shared object file: No such file or directory'
## ERROR: [Common 17-217] Failed to load feature 'base'.
## ERROR: [Common 17-258] Couldn't open 'libX11.so.6': 'libX11.so.6: cannot open shared object file: No such file or directory'
## ERROR: [Common 17-217] Failed to load feature 'base'.

## Install libX11.so.6
sudo apt install libx11-6

Troubleshooting - Unsatisfied Link Errors of Java Runtime Environment

https://askubuntu.com/questions/674579/libawt-xawt-so-libxext-so-6-cannot-open-shared-object-file-no-such-file-or-di

## ERROR - Install terminated unexpectedly.
## ERROR - The installation failed.

## Exception in thread "main" java.lang.UnsatisfiedLinkError:
## Xilinx_Unified_2022.1_0420_0327_Lin64/tps/lnx64/jre11.0.11_9/lib/libawt_xawt.so: libXext.so.6: cannot open shared object file: No such file or directory

sudo apt install libxext6

## Exception in thread "main" java.lang.UnsatisfiedLinkError:
## Xilinx_Unified_2022.1_0420_0327_Lin64/tps/lnx64/jre11.0.11_9/lib/libawt_xawt.so: libXrender.so.1: cannot open shared object file: No such file or directory

sudo apt install libxrender1

## Exception in thread "main" java.lang.UnsatisfiedLinkError:
## Xilinx_Unified_2022.1_0420_0327_Lin64/tps/lnx64/jre11.0.11_9/lib/libawt_xawt.so: libXtst.so.6: cannot open shared object file: No such file or directory

sudo apt install libxtst6

## Exception in thread "main" java.lang.UnsatisfiedLinkError:
## Xilinx_Unified_2022.1_0420_0327_Lin64/tps/lnx64/jre11.0.11_9/lib/libawt_xawt.so: libXi.so.6: cannot open shared object file: No such file or directory

sudo apt install libxi6

Executing Vitis HLS

https://xilinx.github.io/Vitis-Tutorials/2022-1/build/html/docs/Getting_Started/Vitis/Part2.html

## Environment Setup
#source /tools/Xilinx/Vitis/2022.1/settings64.sh
source /tools/Xilinx/Vitis/2023.1/settings64.sh

vitis_hls -help

Vitis HLS - High-Level Synthesis from C, C++ and OpenCL v2023.1 (64-bit)
SW Build 3854077 on May  4 2023
IP Build 3864474 on Sun May  7 20:36:21 MDT 2023
SharedData Build 3865790 on Sun May 07 13:33:03 MDT 2023
Copyright 1986-2022 Xilinx, Inc. All Rights Reserved.
Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.

source /tools/Xilinx/Vitis_HLS/2023.1/scripts/vitis_hls/hls.tcl -notrace
SYNTAX
  vitis_hls <tclscripts> [OPTIONS]

DESCRIPTION
  Vitis HLS command line

OPTIONS
  tclscripts : <string>
    TCL file
  -config <string>
    Config ini files (may be specified 1+ times), must be used with -run
  -eval <string>
    Run TCL commands
  -f [=true|false]
    start in shell mode
  -i [=true|false]
    start in interactive mode
  -l <string:vitis_hls.log>
    log file
  -n [=true|false]
    do not show splash screen
  -nolog [=true|false]
    Disable log file creation
  -nosplash [=true|false]
    do not show splash screen
  -p <string>
    project name
  -run <csim|csynth|cosim|vivado|tcl>
    run target
  -terse [=true|false]
    Filter stdout to only show status INFO and WARNING messages, log file will contain all messages
  -version [=true|false]
    show product version
  -work_dir <string>
    Output project directory, must be used with -run target

SEE ALSO
  www.xilinx.com/cgi-bin/docs/rdoc?v=2023.1;t=vitis+doc;d=wic1584802485878.html

INFO: [HLS 200-112] Total CPU user time: 0.92 seconds. Total CPU system time: 0.1 seconds. Total elapsed time: 1.03 seconds; peak allocated memory: 98.938 MB.
INFO: [Common 17-206] Exiting vitis_hls at Wed Jul 19 08:04:06 2023...

vitis_hls -version

Vitis HLS - High-Level Synthesis from C, C++ and OpenCL v2023.1 (64-bit)
SW Build 3854077 on May  4 2023
IP Build 3864474 on Sun May  7 20:36:21 MDT 2023
Tool Version Limit: 2023.05
Copyright 1986-2022 Xilinx, Inc. All Rights Reserved.
Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.
SharedData Build 3865790 on Sun May 07 13:33:03 MDT 2023

Troubleshooting - Cannot Change Locale

## /tools/Xilinx/Vitis_HLS/2023.1/bin/rdiArgs.sh: line 37: warning: setlocale: LC_ALL: cannot change locale (en_US.UTF-8): No such file or directory
## /bin/bash: warning: setlocale: LC_ALL: cannot change locale (en_US.UTF-8)
## terminate called after throwing an instance of 'std::runtime_error'
##   what(): locale::facet::_S_create_c_locale name not valid
## /tools/Xilinx/Vitis_HLS/2023.1/bin/rdiArgs.sh: line 352: 1220 Aborted (core dumped) "$RDI_PROG" "$@"

## Check if en_US.UTF-8 is included in the available locale list
locale -a

## Install locale en_US.UTF-8
sudo apt install locales
sudo locale-gen en_US.UTF-8

Troubleshooting - libtinfo.so.5 Not Found

https://support.xilinx.com/s/article/76616

## application-specific initialization failed: couldn't load file "libxv_commontasks.so": libtinfo.so.5: cannot open shared object file: No such file or directory

## Install libtinfo.so.5
sudo apt install libtinfo5

References

https://proc-cpuinfo.fixstars.com/2019/11/2019-2-vitis-tutorial/
https://phys-higashi.com/2094/
https://qiita.com/Alaska_Panda/items/d37d78e4998eaa10585f
https://msyksphinz.hatenablog.com/entry/2016/09/09/020000

Table of Contents

Vitis

Getting Started

System Requirements

Installation on Linux/Ubuntu

Prerequisites

Download Vitis

Batch-Mode Installation

Troubleshooting - No X11 DISPLAY Variable

Troubleshooting - Xargs: File Not Found (TBD)

Troubleshooting - libX11.so.6 Not Found

Troubleshooting - Unsatisfied Link Errors of Java Runtime Environment

Executing Vitis HLS

Troubleshooting - Cannot Change Locale

Troubleshooting - libtinfo.so.5 Not Found

References