Skip to content

Latest commit

 

History

History
60 lines (38 loc) · 2.8 KB

PREREQUISITES.md

File metadata and controls

60 lines (38 loc) · 2.8 KB
Raw

Prerequisites

OS

The operating system we target is Linux, specifically, we test Phism on Ubuntu 20.04 and CentOS 7.6.

Xilinx Vitis 2020.2

Please ensure you follow these steps carefully. They are necessary for working seamlessly with the toolchain encapsulated within Vitis. You may hit unexpected linking issue if the environment is not properly set.

You need to have Vitis on your machine before installing Phism. The version we're currently using is 2020.2. For more information please visit this page.

Once you have Vitis installed, you need to source its settings script:

# Suppose Vitis is installed under /opt
source /opt/Vitis/2020.2/settings64.sh

And you should be able to see the following output if the previous command is successful:

echo $XILINX_VITIS
# Should print /opt/Vitis/2020.2
echo $XILINX_HLS
# Should print /opt/Vitis_HLS/2020.2

After that, run the script setup-vitis-hls-llvm.sh under the scripts directory:

source scripts/setup-vitis-hls-llvm.sh

This script is borrowed from the official Vitis HLS frontend repository. It is used to set environment variables to point essential build tools to the versions encapsulated in Vitis.

After running that script, please do check if the GCC toolchain correctly points to the version wrapped in Vitis, which should be 6.2.0 suppose you're using Vitis 2020.2.

gcc --version
# Should print "gcc (GCC) 6.2.0"

CMake

You should also install your own CMake. Version 3.13.4 is the minimum required to work with the latest LLVM.

LLVM toolchain

It might sound weird since we will build LLVM by our own hands later, but Pluto, a polyhedral optimization package that we depends on, specifically needs an LLVM version lower than 10, which is much lower than the version we're going to build (at the time of writing this doc, the LLVM we will build is 13).

It is not that hard to have an older LLVM: just go to your package manager and install the LLVM it provides by default. Typically, you need this one-liner on Ubuntu:

sudo apt-get install -y libclang-dev

You may notice the exact package we install is not "llvm", but "libclang-dev". It is because Pluto needs the LibClang (the clang library) and the FileCheck tool from LLVM, and we can simply install this libclang-dev package to install both of them.

After that (you may need to relaunch your terminal), do check if you have FileCheck and llvm-config command available (just type FileCheck and llvm-config in your terminal and see if any error appears). Also, verify what llvm-config --version shows is a version below 10.