Merge pull request #23 from definelicht/vitis_hls

Support Vitis 2020.1

Author: definelicht

LICENSE.md

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2019, Johannes de Fine Licht, Scalable Parallel Computing Lab, ETH Zurich
+Copyright (c) 2017-2020, Johannes de Fine Licht, Scalable Parallel Computing Lab (SPCL), Department of Computer Science, ETH Zurich
 
 All rights reserved.
 

cmake/FindVitis.cmake

@@ -6,81 +6,116 @@
 #   Vitis_INCLUDE_DIRS - Include directories for HLS. 
 #   Vitis_LIBRARIES - Runtime libraries required for host side code. 
 #   Vitis_COMPILER - Path to the compiler executable (v++ or xocc).
-#   Vitis_HLS - Path to Vivado HLS executable. 
+#   Vitis_HLS - Path to HLS executable (vitis_hls or vivado_hls). 
 #   Vitis_FLOATING_POINT_LIBRARY - Library required for emulation of fp16.
 #   Vitis_VERSION - Version of Vitis/SDx/SDAccel installation.
 #   Vitis_VERSION_MAJOR - Major version of Vitis/SDx/SDAccel installation.
 #   Vitis_VERSION_MINOR - Minor version of Vitis/SDx/SDAccel installation.
 #   Vitis_IS_LEGACY - Set if using a pre-Vitis version (i.e., SDx or SDAccel)
 #
 # To specify the location of Vitis or SDAccel, or to force this script to use a
-# specific version, set the variable VITIS_ROOT_DIR or SDACCEL_ROOT_DIR to the
-# root directory of the desired Vitis or SDAccel installation, respectively.
-# For SDAccel 2018.3 or newer, Vitis/SDAccel relies on a separate Xilinx Runtime
-# (XRT). This script will search in the default installation location, but a
-# path can be specified with the XRT_ROOT_DIR variable.
-
-if(DEFINED SDACCEL_ROOT_DIR AND NOT DEFINED VITIS_ROOT_DIR)
-  set(VITIS_ROOT_DIR ${SDACCEL_ROOT_DIR})
+# specific version, set the variable VITIS_ROOT, SDX_ROOT, or SDACCEL_ROOT to
+# the root directory of the desired Vitis, SDx, or SDAccel installation,
+# respectively. For SDAccel 2018.3 or newer, Vitis/SDAccel relies on a separate
+# Xilinx Runtime (XRT). This script will search in the default installation
+# location, but a path can be specified with the XRT_ROOT variable.
+
+if(DEFINED SDACCEL_ROOT_DIR AND NOT DEFINED SDACCEL_ROOT)
+  set(SDACCEL_ROOT ${SDACCEL_ROOT_DIR})
+endif()
+if(DEFINED SDX_ROOT_DIR AND NOT DEFINED SDX_ROOT)
+  set(SDX_ROOT ${SDX_ROOT_DIR})
+endif()
+if(DEFINED VITIS_ROOT_DIR AND NOT DEFINED VITIS_ROOT)
+  set(VITIS_ROOT ${VITIS_ROOT_DIR})
+endif()
+if(DEFINED SDX_ROOT AND NOT DEFINED VITIS_ROOT)
+  set(VITIS_ROOT ${SDX_ROOT})
+endif()
+if(DEFINED SDACCEL_ROOT AND NOT DEFINED VITIS_ROOT)
+  set(VITIS_ROOT ${SDACCEL_ROOT})
 endif()
 
-if(NOT DEFINED VITIS_ROOT_DIR)
+if(NOT DEFINED VITIS_ROOT)
 
   find_path(VITIS_SEARCH_PATH v++ xocc 
             PATHS ENV XILINX_OPENCL ENV XILINX_VITIS ENV XILINX_SDACCEL
+                  ENV XILINX_SDX
             PATH_SUFFIXES bin)
-  get_filename_component(VITIS_ROOT_DIR ${VITIS_SEARCH_PATH} DIRECTORY) 
+  get_filename_component(VITIS_ROOT ${VITIS_SEARCH_PATH} DIRECTORY) 
   mark_as_advanced(VITIS_SEARCH_PATH)
 
 else()
 
-  message(STATUS "Using user defined directory: ${VITIS_ROOT_DIR}")
+  message(STATUS "Using user defined Vitis directory: ${VITIS_ROOT}")
 
 endif()
 
 # Check if all the necessary components are present. We want to ensure that we
 # use the tools bundled together, so we restrict all further finds to only look
 # in paths relative to the determined installation. 
 
-find_program(Vitis_XOCC xocc PATHS ${VITIS_ROOT_DIR}/bin NO_DEFAULT_PATH)
-find_program(Vitis_VPP v++ PATHS ${VITIS_ROOT_DIR}/bin NO_DEFAULT_PATH)
+find_program(Vitis_XOCC xocc PATHS ${VITIS_ROOT}/bin NO_DEFAULT_PATH)
+find_program(Vitis_VPP v++ PATHS ${VITIS_ROOT}/bin NO_DEFAULT_PATH)
 mark_as_advanced(Vitis_XOCC)
 mark_as_advanced(Vitis_VPP)
 if(Vitis_XOCC)
   set(VITIS_COMPILER ${Vitis_XOCC})
   set(VITIS_IS_LEGACY TRUE)
+  add_definitions(-DVITIS_IS_LEGACY)
 endif()
 # Prefer v++ over xocc executable 
 if(Vitis_VPP)
   set(VITIS_COMPILER ${Vitis_VPP})
   set(VITIS_IS_LEGACY FALSE)
 endif()
-set(Vitis_COMPILER ${VITIS_COMPILER} CACHE STRING "Compiler used to build FPGA kernels.")
-set(Vitis_IS_LEGACY ${VITIS_IS_LEGACY} CACHE STRING "Using legacy version of toolchain (pre-Vitis).")
+unset(Vitis_XOCC)
+unset(Vitis_VPP)
+set(Vitis_COMPILER ${VITIS_COMPILER} CACHE STRING "Compiler used to build FPGA kernels." FORCE)
+set(Vitis_IS_LEGACY ${VITIS_IS_LEGACY} CACHE STRING "Using legacy version of toolchain (pre-Vitis)." FORCE)
 
 # Get version number string
-get_filename_component(VITIS_VERSION "${VITIS_ROOT_DIR}" NAME)
+get_filename_component(VITIS_VERSION "${VITIS_ROOT}" NAME)
 string(REGEX REPLACE "([0-9]+)\\.[0-9]+" "\\1" VITIS_MAJOR_VERSION "${VITIS_VERSION}")
 string(REGEX REPLACE "[0-9]+\\.([0-9]+)" "\\1" VITIS_MINOR_VERSION "${VITIS_VERSION}")
-set(Vitis_VERSION ${VITIS_VERSION} CACHE STRING "Version of Vitis found")
-set(Vitis_MAJOR_VERSION ${VITIS_MAJOR_VERSION} CACHE STRING "Major version of Vitis found")
-set(Vitis_MINOR_VERSION ${VITIS_MINOR_VERSION} CACHE STRING "Minor version of Vitis found")
-
-# vitis_hls is still in beta as of 2019.2 and breaks some functionality, so
-# prefer vivado_hls for now (subject to change).
-find_program(Vitis_HLS NAMES vivado_hls vitis_hls PATHS
-             ${VITIS_ROOT_DIR}/bin
-             ${VITIS_ROOT_DIR}/../../Vivado/${Vitis_VERSION}/bin
-             ${VITIS_ROOT_DIR}/Vivado_HLS/bin NO_DEFAULT_PATH)
+set(Vitis_VERSION ${VITIS_VERSION} CACHE STRING "Version of Vitis found" FORCE)
+set(Vitis_MAJOR_VERSION ${VITIS_MAJOR_VERSION} CACHE STRING "Major version of Vitis found" FORCE)
+set(Vitis_MINOR_VERSION ${VITIS_MINOR_VERSION} CACHE STRING "Minor version of Vitis found" FORCE)
+add_definitions(-DVITIS_VERSION=${Vitis_VERSION} -DVITIS_MAJOR_VERSION=${Vitis_MAJOR_VERSION} -DVITIS_MINOR_VERSION=${Vitis_MINOR_VERSION})
+
+find_program(Vitis_VIVADO_HLS NAMES vivado_hls PATHS
+             ${VITIS_ROOT}/bin
+             ${VITIS_ROOT}/../../Vivado/${Vitis_VERSION}/bin
+             ${VITIS_ROOT}/Vivado_HLS/bin NO_DEFAULT_PATH DOC
+             "Vivado HLS compiler associated with this version of the tools.")
+
+# Check if we should use vivado_hls or vitis_hls
+if(Vitis_MAJOR_VERSION GREATER_EQUAL 2020)
+  # vitis_hls is used internally for building kernels starting from 2020.1. 
+  set(Vitis_USE_VITIS_HLS ON CACHE BOOL "Use vitis_hls instead of vivado_hls." FORCE)
+  find_program(VITIS_HLS NAMES vitis_hls vivado_hls PATHS
+               ${VITIS_ROOT}/bin
+               ${VITIS_ROOT}/../../Vivado/${Vitis_VERSION}/bin
+               ${VITIS_ROOT}/Vivado_HLS/bin NO_DEFAULT_PATH)
+else()
+  if(NOT DEFINED Vitis_USE_VITIS_HLS OR Vitis_USE_VITIS_HLS)
+    message(WARNING "Vitis 2020.1 introduced breaking changes to hls::stream. Please pass -DVIVADO_MAJOR_VERSION=${VITIS_MAJOR_VERSION} in your synthesis script to always use the correct implementation.")
+  endif()
+  # Prior to 2020.1, vivado_hls from the Vivado installation is used.
+  set(Vitis_USE_VITIS_HLS OFF CACHE BOOL "Use vitis_hls instead of vivado_hls." FORCE)
+  set(VITIS_HLS ${Vitis_VIVADO_HLS})
+endif()
+mark_as_advanced(VITIS_HLS)
+set(Vitis_HLS ${VITIS_HLS} CACHE STRING "Path to HLS executable." FORCE)
 
 find_program(Vitis_VIVADO vivado PATHS
-             ${VITIS_ROOT_DIR}/../../Vivado/${Vitis_VERSION}/bin
-             ${VITIS_ROOT_DIR}/Vivado/bin NO_DEFAULT_PATH)
+             ${VITIS_ROOT}/../../Vivado/${Vitis_VERSION}/bin
+             ${VITIS_ROOT}/Vivado/bin NO_DEFAULT_PATH)
 
 find_path(Vitis_HLS_INCLUDE_DIR hls_stream.h PATHS
-          ${VITIS_ROOT_DIR}/../../Vivado/${Vitis_VERSION}/include
-          ${VITIS_ROOT_DIR}/include
-          ${VITIS_ROOT_DIR}/Vivado_HLS/include
+          ${VITIS_ROOT}/../../Vivado/${Vitis_VERSION}/include
+          ${VITIS_ROOT}/include
+          ${VITIS_ROOT}/Vivado_HLS/include
           NO_DEFAULT_PATH)
 mark_as_advanced(Vitis_HLS_INCLUDE_DIR)
 
@@ -90,7 +125,7 @@ if(Vitis_VPP OR (Vitis_MAJOR_VERSION GREATER 2018) OR
 else()
   set(VITIS_USE_XRT FALSE)
 endif()
-set(Vitis_USE_XRT ${VITIS_USE_XRT} CACHE STRING "Use XRT as runtime. Otherwise, use SDAccel/SDx OpenCL runtime.")
+set(Vitis_USE_XRT ${VITIS_USE_XRT} CACHE STRING "Use XRT as runtime. Otherwise, use SDAccel/SDx OpenCL runtime." FORCE)
 
 # Currently only x86 support
 
@@ -102,9 +137,9 @@ if(CMAKE_SYSTEM_PROCESSOR MATCHES "(x86)|(X86)|(amd64)|(AMD64)")
 
   find_library(Vitis_FLOATING_POINT_LIBRARY Ip_floating_point_v7_0_bitacc_cmodel
                PATHS
-               ${VITIS_ROOT_DIR}/lnx64/tools/fpo_v7_0
-               ${VITIS_ROOT_DIR}/../../Vivado/${Vitis_VERSION}/lnx64/tools/fpo_v7_0
-               ${VITIS_ROOT_DIR}/Vivado_HLS/lnx64/tools/fpo_v7_0)
+               ${VITIS_ROOT}/lnx64/tools/fpo_v7_0
+               ${VITIS_ROOT}/../../Vivado/${Vitis_VERSION}/lnx64/tools/fpo_v7_0
+               ${VITIS_ROOT}/Vivado_HLS/lnx64/tools/fpo_v7_0)
   mark_as_advanced(Vitis_FLOATING_POINT_LIBRARY)
 
   get_filename_component(VITIS_FP_DIR ${Vitis_FLOATING_POINT_LIBRARY}
@@ -130,7 +165,7 @@ if(CMAKE_SYSTEM_PROCESSOR MATCHES "(x86)|(X86)|(amd64)|(AMD64)")
 
   if(NOT Vitis_USE_XRT)
 
-    set(VITIS_RUNTIME_DIR ${VITIS_ROOT_DIR}/runtime)
+    set(VITIS_RUNTIME_DIR ${VITIS_ROOT}/runtime)
 
     # Older versions of SDAccel ship with their own OpenCL headers. Make sure
     # to use them.
@@ -190,7 +225,7 @@ if(CMAKE_SYSTEM_PROCESSOR MATCHES "(x86)|(X86)|(amd64)|(AMD64)")
   # Only succeed if libraries were found
   if(Vitis_LIBXILINXOPENCL)
     set(Vitis_LIBRARIES ${OpenCL_LIBRARIES} ${Vitis_LIBXILINXOPENCL}
-        CACHE STRING "OpenCL runtime libraries.")
+        CACHE STRING "OpenCL runtime libraries." FORCE)
   endif()
 
   # For some reason, the executable finds the floating point library on the
@@ -211,7 +246,7 @@ if(CMAKE_SYSTEM_PROCESSOR MATCHES "(x86)|(X86)|(amd64)|(AMD64)")
      Vitis_OPENCL_EXTENSIONS_INCLUDE_DIR)
     set(Vitis_INCLUDE_DIRS ${Vitis_HLS_INCLUDE_DIR}
         ${Vitis_OPENCL_INCLUDE_DIR} ${Vitis_OPENCL_EXTENSIONS_INCLUDE_DIR} 
-        CACHE STRING "Vitis include directories.")
+        CACHE STRING "Vitis include directories." FORCE)
   endif()
 
 else()

include/hlslib/intel/OpenCL.h

@@ -1,5 +1,4 @@
 /// @author    Johannes de Fine Licht (definelicht@inf.ethz.ch)
-/// @date      February 2019
 /// @copyright This software is copyrighted under the BSD 3-Clause License.
 
 #pragma once

include/hlslib/xilinx/Accumulate.h

@@ -1,5 +1,4 @@
 /// @author    Johannes de Fine Licht (definelicht@inf.ethz.ch)
-/// @date      June 2017
 /// @copyright This software is copyrighted under the BSD 3-Clause License.
 
 #pragma once
@@ -51,7 +50,7 @@
 namespace hlslib {
 
 template <typename T, class Operator, int latency>
-void AccumulateIterate(Stream<T> &input, Stream<T> &fromFeedback,
+void AccumulateIterate(Stream<T> &input, Stream<T, latency> &fromFeedback,
                        Stream<T> &toFeedback, int size, int iterations) {
 AccumulateIterate_Iterations:
   for (int i = 0; i < iterations; ++i) {
@@ -61,22 +60,22 @@ void AccumulateIterate(Stream<T> &input, Stream<T> &fromFeedback,
       for (int k = 0; k < latency; ++k) {
         #pragma HLS PIPELINE
         #pragma HLS LOOP_FLATTEN
-        const T a = hlslib::ReadBlocking(input);
+        const T a = input.Pop();
         T b;
         if (j > 0) {
-          b = hlslib::ReadOptimistic(fromFeedback);
+          b = fromFeedback.ReadOptimistic();
         } else {
           b = Operator::identity();
         }
         const auto result = Operator::Apply(a, b);
-        hlslib::WriteBlocking(toFeedback, result, 1);
+        toFeedback.Push(result);
       }
     }
   }
 }
 
 template <typename T, int latency>
-void AccumulateFeedback(Stream<T> &toFeedback, Stream<T> &fromFeedback,
+void AccumulateFeedback(Stream<T> &toFeedback, Stream<T, latency> &fromFeedback,
                         Stream<T> &toReduce, int size, int iterations) {
 AccumulateFeedback_Iterations:
   for (int i = 0; i < iterations; ++i) {
@@ -86,13 +85,13 @@ void AccumulateFeedback(Stream<T> &toFeedback, Stream<T> &fromFeedback,
       for (int k = 0; k < latency; ++k) {
         #pragma HLS PIPELINE
         #pragma HLS LOOP_FLATTEN
-        const auto read = hlslib::ReadBlocking(toFeedback);
+        const auto read = toFeedback.Pop();
         if (j < size / latency - 1) {
           // Feedback back
-          hlslib::WriteBlocking(fromFeedback, read, latency);
+          fromFeedback.Push(read);
         } else {
           // Write to output
-          hlslib::WriteBlocking(toReduce, read, 1);
+          toReduce.Push(read);
         }
       }
     }
@@ -108,10 +107,10 @@ void AccumulateReduce(Stream<T> &toReduce, Stream<T> &output, int size,
     T result(Operator::identity());
   AccumulateReduce_Latency:
     for (int j = 0; j < latency; ++j) {
-      const auto read = hlslib::ReadBlocking(toReduce);
+      const auto read = toReduce.Pop();
       result = Operator::Apply(result, read);
     }
-    hlslib::WriteBlocking(output, result, 1);
+    output.Push(result);
   }
 }
 
@@ -125,11 +124,11 @@ void AccumulateSimple(Stream<T> &in, Stream<T> &out, int size, int iterations) {
     for (int j = 0; j < size; ++j) {
       #pragma HLS LOOP_FLATTEN
       #pragma HLS PIPELINE
-      const auto a = hlslib::ReadBlocking(in);
+      const auto a = in.Pop();
       const auto b = (j > 0) ? acc : T(Operator::identity());
       acc = Operator::Apply(a, b);
       if (j == size - 1) {
-        hlslib::WriteBlocking(out, acc, 1);
+        out.Push(acc);
       }
     }
   }

include/hlslib/xilinx/Axi.h

@@ -1,5 +1,4 @@
 /// @author    Johannes de Fine Licht (definelicht@inf.ethz.ch)
-/// @date      October 2017
 /// @copyright This software is copyrighted under the BSD 3-Clause License. 
 
 #pragma once

include/hlslib/xilinx/DataPack.h

@@ -1,5 +1,4 @@
 /// @author    Johannes de Fine Licht (definelicht@inf.ethz.ch)
-/// @date      April 2016
 /// @copyright This software is copyrighted under the BSD 3-Clause License. 
 
 #pragma once

include/hlslib/xilinx/Flatten.h

@@ -1,5 +1,4 @@
 /// @author    Johannes de Fine Licht (definelicht@inf.ethz.ch)
-/// @date      July 2018
 /// @copyright This software is copyrighted under the BSD 3-Clause License. 
 
 #pragma once

include/hlslib/xilinx/Operators.h

@@ -1,5 +1,4 @@
 /// @author    Johannes de Fine Licht (definelicht@inf.ethz.ch)
-/// @date      June 2017
 /// @copyright This software is copyrighted under the BSD 3-Clause License.
 
 #pragma once

include/hlslib/xilinx/Resource.h

@@ -1,5 +1,4 @@
 /// @author    Johannes de Fine Licht (definelicht@inf.ethz.ch)
-/// @date      August 2017 
 /// @copyright This software is copyrighted under the BSD 3-Clause License. 
 
 #pragma once

include/hlslib/xilinx/SDAccel.h

@@ -1,5 +1,4 @@
 /// @author    Johannes de Fine Licht (definelicht@inf.ethz.ch)
-/// @date      February 2019
 /// @copyright This software is copyrighted under the BSD 3-Clause License.
 
 #pragma once