Improve Vivado/Vitis build flow, report generation, and VivadoAccelerator refactor

.gitignore

@@ -11,7 +11,7 @@ my-hls-test
 *.tar.gz
 docs/_build
 docs/autodoc/*
-hls4mlprj_*
+test/pytest/*_test_*
 *~
 *.ipynb
 *.ipynb_checkpoints/

hls4ml/backends/symbolic/symbolic_backend.py

@@ -89,24 +89,43 @@ def create_initial_config(
 
         return config
 
-    def build(self, model, reset=False, csim=True, synth=True, cosim=False, validation=False, export=False, vsynth=False):
+    def build(
+        self,
+        model,
+        reset=False,
+        csim=True,
+        synth=True,
+        cosim=False,
+        validation=False,
+        export=False,
+        vsynth=False,
+        pnr=False,
+    ):
         if 'linux' in sys.platform:
             found = os.system('command -v vivado_hls > /dev/null')
             if found != 0:
                 raise Exception('Vivado HLS installation not found. Make sure "vivado_hls" is on PATH.')
 
-        curr_dir = os.getcwd()
-        os.chdir(model.config.get_output_dir())
-        vivado_cmd = (
-            f'vivado_hls -f build_prj.tcl "reset={reset} '
-            f'csim={csim} '
-            f'synth={synth} '
-            f'cosim={cosim} '
-            f'validation={validation} '
-            f'export={export} '
-            f'vsynth={vsynth}"'
+        build_opts = (
+            'array set opt {\n'
+            f'    reset      {int(reset)}\n'
+            f'    csim       {int(csim)}\n'
+            f'    synth      {int(synth)}\n'
+            f'    cosim      {int(cosim)}\n'
+            f'    validation {int(validation)}\n'
+            f'    export     {int(export)}\n'
+            f'    vsynth     {int(vsynth)}\n'
+            f'    pnr        {int(pnr)}\n'
+            '}\n'
         )
-        os.system(vivado_cmd)
+        output_dir = model.config.get_output_dir()
+        tcl_path = os.path.join(output_dir, 'build_opt.tcl')
+        with open(tcl_path, 'w') as f:
+            f.write(build_opts)
+
+        curr_dir = os.getcwd()
+        os.chdir(output_dir)
+        os.system('vivado_hls -f build_prj.tcl')
         os.chdir(curr_dir)
 
-        return parse_vivado_report(model.config.get_output_dir())
+        return parse_vivado_report(output_dir)

hls4ml/backends/vitis/vitis_backend.py

@@ -117,6 +117,7 @@ def build(
         vsynth=False,
         fifo_opt=False,
         log_to_stdout=True,
+        pnr=False,
     ):
         if 'linux' in sys.platform:
             found_vrun = os.system('command -v vitis-run > /dev/null') == 0
@@ -133,6 +134,7 @@ def build(
             f'    export     {int(export)}\n'
             f'    vsynth     {int(vsynth)}\n'
             f'    fifo_opt   {int(fifo_opt)}\n'
+            f'    pnr        {int(pnr)}\n'
             '}\n'
         )
 

hls4ml/backends/vivado/vivado_backend.py

@@ -301,28 +301,44 @@ def build(
         export=False,
         vsynth=False,
         fifo_opt=False,
+        pnr=False,
     ):
+        """Run HLS / optional Vivado flow.
+
+        Args:
+            pnr: If True (default) and ``vsynth`` is True, Vivado runs through place and route.
+                If False, Vivado stops after post-synthesis reports and statistics.
+        """
         if 'linux' in sys.platform:
             found = os.system('command -v vivado_hls > /dev/null')
             if found != 0:
                 raise Exception('Vivado HLS installation not found. Make sure "vivado_hls" is on PATH.')
 
-        curr_dir = os.getcwd()
-        os.chdir(model.config.get_output_dir())
-        vivado_cmd = (
-            f'vivado_hls -f build_prj.tcl "reset={reset} '
-            f'csim={csim} '
-            f'synth={synth} '
-            f'cosim={cosim} '
-            f'validation={validation} '
-            f'export={export} '
-            f'vsynth={vsynth} '
-            f'fifo_opt={fifo_opt}"'
+        build_opts = (
+            'array set opt {\n'
+            f'    reset      {int(reset)}\n'
+            f'    csim       {int(csim)}\n'
+            f'    synth      {int(synth)}\n'
+            f'    cosim      {int(cosim)}\n'
+            f'    validation {int(validation)}\n'
+            f'    export     {int(export)}\n'
+            f'    vsynth     {int(vsynth)}\n'
+            f'    fifo_opt   {int(fifo_opt)}\n'
+            f'    pnr        {int(pnr)}\n'
+            '}\n'
         )
+        output_dir = model.config.get_output_dir()
+        tcl_path = os.path.join(output_dir, 'build_opt.tcl')
+        with open(tcl_path, 'w') as f:
+            f.write(build_opts)
+
+        curr_dir = os.getcwd()
+        os.chdir(output_dir)
+        vivado_cmd = 'vivado_hls -f build_prj.tcl'
         os.system(vivado_cmd)
         os.chdir(curr_dir)
 
-        return parse_vivado_report(model.config.get_output_dir())
+        return parse_vivado_report(output_dir)
 
     @layer_optimizer(Layer)
     def init_base_layer(self, layer):

hls4ml/backends/vivado_accelerator/vivado_accelerator_backend.py

@@ -1,4 +1,5 @@
 import os
+import sys
 
 from hls4ml.backends import VivadoBackend
 from hls4ml.model.flow import register_flow
@@ -23,78 +24,40 @@ def build(
         vsynth=False,
         fifo_opt=False,
         bitfile=False,
+        pnr=False,
     ):
-        # run the VivadoBackend build
-        super().build(
-            model,
-            reset=reset,
-            csim=csim,
-            synth=synth,
-            cosim=cosim,
-            validation=validation,
-            export=export,
-            vsynth=vsynth,
-            fifo_opt=fifo_opt,
+        if 'linux' in sys.platform:
+            found = os.system('command -v vivado_hls > /dev/null')
+            if found != 0:
+                raise Exception('Vivado HLS installation not found. Make sure "vivado_hls" is on PATH.')
+
+        build_opts = (
+            'array set opt {\n'
+            f'    reset      {int(reset)}\n'
+            f'    csim       {int(csim)}\n'
+            f'    synth      {int(synth)}\n'
+            f'    cosim      {int(cosim)}\n'
+            f'    validation {int(validation)}\n'
+            f'    export     {int(export)}\n'
+            f'    vsynth     {int(vsynth)}\n'
+            f'    fifo_opt   {int(fifo_opt)}\n'
+            f'    bitfile    {int(bitfile)}\n'
+            f'    pnr        {int(pnr)}\n'
+            '}\n'
         )
-        # Get Config to view Board and Platform
-        from hls4ml.backends import VivadoAcceleratorConfig
+        output_dir = model.config.get_output_dir()
+        tcl_path = os.path.join(output_dir, 'build_opt.tcl')
+        with open(tcl_path, 'w') as f:
+            f.write(build_opts)
 
-        vivado_accelerator_config = VivadoAcceleratorConfig(
-            model.config, model.get_input_variables(), model.get_output_variables()
-        )
-        # now make a bitfile
-        if bitfile:
-            if vivado_accelerator_config.get_board().startswith('alveo'):
-                self.make_xclbin(model, vivado_accelerator_config.get_platform())
-            else:
-                curr_dir = os.getcwd()
-                os.chdir(model.config.get_output_dir())
-                try:
-                    os.system('vivado -mode batch -source design.tcl')
-                except Exception:
-                    print('Something went wrong, check the Vivado logs')
-                os.chdir(curr_dir)
-
-        return parse_vivado_report(model.config.get_output_dir())
-
-    def make_xclbin(self, model, platform='xilinx_u250_xdma_201830_2'):
-        """Create the xclbin for the given model and target platform.
-
-        Args:
-            model (ModelGraph): Compiled and build model.
-            platform (str, optional): Development/Deployment target platform, must be installed first.
-                The host machine only requires the deployment target platform. Refer to the Getting Started section of
-                the Alveo guide. Defaults to 'xilinx_u250_xdma_201830_2'.
-        """
         curr_dir = os.getcwd()
-        abs_path_dir = os.path.abspath(model.config.get_output_dir())
-        os.chdir(abs_path_dir)
-        os.makedirs('xo_files', exist_ok=True)
-        try:
-            os.system('vivado -mode batch -source design.tcl')
-        except Exception:
-            print('Something went wrong, check the Vivado logs')
-        project_name = model.config.get_project_name()
-        ip_repo_path = abs_path_dir + '/' + project_name + '_prj' + '/solution1/impl/ip'
-        os.makedirs('xclbin_files', exist_ok=True)
-        os.chdir(abs_path_dir + '/xclbin_files')
-        # TODO Add other platforms
-        vitis_cmd = (
-            'v++ -t hw --platform '
-            + platform
-            + ' --link ../xo_files/'
-            + project_name
-            + "_kernel.xo -o'"
-            + project_name
-            + "_kernel.xclbin' --user_ip_repo_paths "
-            + ip_repo_path
-        )
-        try:
-            os.system(vitis_cmd)
-        except Exception:
-            print('Something went wrong, check the Vitis/Vivado logs')
+        os.chdir(output_dir)
+        vivado_cmd = 'vivado_hls -f build_prj.tcl'
+        os.system(vivado_cmd)
         os.chdir(curr_dir)
 
+        return parse_vivado_report(output_dir)
+
     def create_initial_config(
         self,
         board='pynq-z2',

hls4ml/cli/__init__.py

@@ -193,6 +193,13 @@ def _build_vivado(args, extra_args):
         action='store_true',
     )
     vivado_parser.add_argument('--reset', help='Remove any previous builds', action='store_true', default=False)
+    vivado_parser.add_argument('--fifo-opt', help='Optimize FIFO usage', action='store_true', default=False)
+    vivado_parser.add_argument(
+        '--pnr',
+        help='With Vivado synthesis (-l), run place and route',
+        action='store_true',
+        default=False,
+    )
 
     if args.list_options:
         vivado_parser.print_help()
@@ -207,6 +214,8 @@ def _build_vivado(args, extra_args):
     validation = int(vivado_args.validation)
     export = int(vivado_args.export)
     vsynth = int(vivado_args.vivado_synthesis)
+    fifo_opt = int(vivado_args.fifo_opt)
+    pnr = int(vivado_args.pnr)
     if vivado_args.all:
         csim = synth = cosim = validation = export = vsynth = 1
 
@@ -217,21 +226,24 @@ def _build_vivado(args, extra_args):
             print('Vivado HLS installation not found. Make sure "vivado_hls" is on PATH.')
             sys.exit(1)
 
-    os.system(
-        (
-            'cd {dir} && vivado_hls -f build_prj.tcl "reset={reset} csim={csim} synth={synth} cosim={cosim} '
-            'validation={validation} export={export} vsynth={vsynth}"'
-        ).format(
-            dir=args.project,
-            reset=reset,
-            csim=csim,
-            synth=synth,
-            cosim=cosim,
-            validation=validation,
-            export=export,
-            vsynth=vsynth,
-        )
+    build_opts = (
+        'array set opt {\n'
+        f'    reset      {reset}\n'
+        f'    csim       {csim}\n'
+        f'    synth      {synth}\n'
+        f'    cosim      {cosim}\n'
+        f'    validation {validation}\n'
+        f'    export     {export}\n'
+        f'    vsynth     {vsynth}\n'
+        f'    fifo_opt   {fifo_opt}\n'
+        f'    pnr        {pnr}\n'
+        '}\n'
     )
+    tcl_path = os.path.join(args.project, 'build_opt.tcl')
+    with open(tcl_path, 'w') as f:
+        f.write(build_opts)
+
+    os.system(f'cd {args.project} && vivado_hls -f build_prj.tcl')
 
 
 def _build_quartus(args, extra_args):