☢️ Libero backend for rad-hard PolarFire line of FPGAs

hls4ml/backends/__init__.py

@@ -1,5 +1,6 @@
 from hls4ml.backends.backend import Backend, get_available_backends, get_backend, register_backend  # noqa: F401
 from hls4ml.backends.fpga.fpga_backend import FPGABackend  # noqa: F401
+from hls4ml.backends.libero.libero_backend import LiberoBackend
 from hls4ml.backends.oneapi.oneapi_backend import OneAPIBackend
 from hls4ml.backends.plugin_loader import load_backend_plugins
 from hls4ml.backends.quartus.quartus_backend import QuartusBackend
@@ -21,6 +22,7 @@ def _register_builtin_backends():
     register_backend('Catapult', CatapultBackend)
     register_backend('SymbolicExpression', SymbolicExpressionBackend)
     register_backend('oneAPI', OneAPIBackend)
+    register_backend('Libero', LiberoBackend)
 
 
 _register_builtin_backends()

hls4ml/backends/libero/libero_backend.py

@@ -0,0 +1,254 @@
+import os
+import subprocess
+import sys
+from pathlib import Path
+
+from hls4ml.backends import FPGABackend
+from hls4ml.model.attributes import ChoiceAttribute
+from hls4ml.model.flow import register_flow
+from hls4ml.model.layers import Dense, Layer
+from hls4ml.model.optimizer import layer_optimizer
+from hls4ml.model.types import StructWrapperVariable
+from hls4ml.report import parse_libero_report
+
+
+class LiberoBackend(FPGABackend):
+    def __init__(self):
+        super().__init__(name='Libero')
+        self._register_layer_attributes()
+        self._register_flows()
+
+    def _register_layer_attributes(self):
+        strategy_layers = [
+            Dense,
+        ]
+
+        for layer in strategy_layers:
+            attrs = self.attribute_map.get(layer, [])
+            attrs.append(
+                ChoiceAttribute(
+                    'strategy',
+                    choices=['latency', 'resource'],
+                    default='latency',
+                )
+            )
+            self.attribute_map[layer] = attrs
+
+    def _register_flows(self):
+        initializers = self._get_layer_initializers()
+        init_flow = register_flow('init_layers', initializers, requires=['optimize'], backend=self.name)
+
+        libero_types = [
+            'libero:transform_types',
+            'libero:set_pipeline_style',
+        ]
+        libero_types_flow = register_flow('specific_types', libero_types, requires=[init_flow], backend=self.name)
+
+        template_flow = register_flow('apply_templates', self._get_layer_templates, requires=[init_flow], backend=self.name)
+
+        writer_passes = ['make_stamp', 'libero:write_hls']
+        self._writer_flow = register_flow('write', writer_passes, requires=['libero:ip'], backend=self.name)
+
+        ip_flow_requirements = [
+            'optimize',
+            init_flow,
+            libero_types_flow,
+            template_flow,
+        ]
+
+        self._default_flow = register_flow('ip', None, requires=ip_flow_requirements, backend=self.name)
+
+    def get_default_flow(self):
+        return self._default_flow
+
+    def get_writer_flow(self):
+        return self._writer_flow
+
+    def create_initial_config(
+        self,
+        fpga_family='PolarFire',
+        part='MPF300',
+        board='hw_only',
+        clock_period=5,
+        io_type='io_parallel',
+        smarthls_path=None,
+        namespace=None,
+        write_weights_txt=True,
+        write_tar=False,
+        **_,
+    ):
+        """Create initial configuration of the Libero backend.
+
+        Args:
+            fpga_family (str, optional): The FPGA family to be used. Defaults to 'PolarFire'.
+            part (str, optional): The FPGA part to be used. Defaults to 'MPF300'.
+            board (str, optional): The target board. Defaults to 'hw_only'.
+            clock_period (int, optional): The clock period. Defaults to 5.
+            io_type (str, optional): Type of implementation used. One of
+                'io_parallel' or 'io_stream'. Defaults to 'io_parallel'.
+            smarthls_path (str, optional): Path to SmartHLS installation (part of Libero installation).
+                For example: /opt/microchip/Libero_SoC_v2024.2/SmartHLS-2024.2/SmartHLS
+                If None, installation path will be inferred from the location of ``shls`` binary. Defaults to None.
+            namespace (str, optional): If defined, place all generated code within a namespace. Defaults to None.
+            write_weights_txt (bool, optional): If True, writes weights to .txt files which speeds up compilation.
+                Defaults to True.
+            write_tar (bool, optional): If True, compresses the output directory into a .tar.gz file. Defaults to False.
+
+        Returns:
+            dict: initial configuration.
+        """
+
+        config = {}
+
+        config['FPGAFamily'] = fpga_family if fpga_family is not None else 'PolarFire'
+        config['Part'] = part if part is not None else 'MPF300'
+        config['Board'] = board if board is not None else 'hw_only'
+        config['ClockPeriod'] = clock_period if clock_period is not None else 5
+        config['IOType'] = io_type if io_type is not None else 'io_parallel'
+        config['SmartHLSPath'] = self._find_smarthls_path(smarthls_path)
+        config['HLSConfig'] = {}
+        config['WriterConfig'] = {
+            'Namespace': namespace,
+            'WriteWeightsTxt': write_weights_txt,
+            'WriteTar': write_tar,
+        }
+
+        return config
+
+    def _find_smarthls_path(self, smarthls_path):
+        if smarthls_path is None:
+            shls_path = subprocess.check_output(['which', 'shls']).decode('utf-8').strip()
+            smarthls_path = Path(shls_path).parent.parent
+        else:
+            if not isinstance(smarthls_path, Path):
+                smarthls_path = Path(smarthls_path)
+
+        return smarthls_path
+
+    def _run_shls_cmd(self, cmd_name, cwd, skip=True):
+        if skip:
+            flag = '-s'
+        else:
+            flag = '-a'
+        ret_val = subprocess.run(
+            ['shls', flag, cmd_name],
+            shell=False,
+            check=True,
+            stdout=sys.stdout,
+            stderr=sys.stderr,
+            cwd=cwd,
+        )
+        return ret_val
+
+    def compile(self, model):
+        """Compile the generated project that can be linked into Python runtime.
+
+        Args:
+            model (ModelGraph): Model to compile.
+
+        Raises:
+            Exception: If the project failed to compile
+
+        Returns:
+            string: Returns the name of the compiled library.
+        """
+
+        lib_name = None
+
+        # This is a bit hacky, we can't change the Makefile used to run the regular build(), so we have to swap the file
+        # to do the compile(). Alternative was to use environment variables.
+        out_dir = model.config.get_output_dir()
+
+        makefile_path = os.path.join(out_dir, 'Makefile')
+        os.rename(makefile_path, makefile_path + '.build')
+        os.rename(makefile_path + '.compile', makefile_path)
+        ret_val = self._run_shls_cmd('sw_compile', out_dir, skip=True)
+        os.rename(makefile_path, makefile_path + '.compile')
+        os.rename(makefile_path + '.build', makefile_path)
+
+        if ret_val.returncode != 0:
+            print(ret_val.stdout)
+            raise Exception(f'Failed to compile project "{model.config.get_project_name()}"')
+        lib_name = f'{out_dir}/hls_output/.hls/{model.config.get_project_name()}.sw_binary'
+
+        return lib_name
+
+    def build(
+        self,
+        model,
+        reset=False,
+        skip_preqs=True,
+        sw_compile=True,
+        hw=True,
+        cosim=False,
+        rtl_synth=False,
+        fpga=False,
+        **kwargs,
+    ):
+        """Build the model using Libero suite and SmartHLS compiler. Additional arguments passed to the function in form of
+        `<arg>=True` will be passed as an argument to the `shls` command. See SmartHLS user guide for list of possible
+        command line options.
+
+        Args:
+            model (ModelGraph): Model to build
+            reset (bool, optional): Clean up any existing files. Defaults to False.
+            skip_preqs(bool, optional): Skip any prerequisite step that is outdated. Defaults to False.
+            sw_compile (bool, optional): Compile the generated HLS in software. Defaults to True.
+            hw (bool, optional): Compile the software to hardware, producing a set of Verilog HDL files. Defaults to True.
+            cosim (bool, optional): Run co-simulation. Defaults to False.
+            rtl_synth (bool, optional): Run RTL synthesis for resource results. This will take less time than `fpga`.
+                Defaults to False.
+            fpga (bool, optional): Synthesize the generated hardware to target FPGA. This runs RTL synthesis and
+                place-and-route for resource and timing results. Defaults to False.
+
+        Raises:
+            Exception: Raised if the `shls` command has not been found
+            CalledProcessError: Raised if SmartHLS returns non-zero code for any of the commands executed
+
+        Returns:
+            dict: Detailed report produced by SmartHLS.
+        """
+        if 'linux' in sys.platform:
+            found = os.system('command -v shls > /dev/null')
+            if found != 0:
+                raise Exception('Libero/SmartHLS installation not found. Make sure "shls" is on PATH.')
+
+        cwd = model.config.get_output_dir()
+
+        if reset:
+            self._run_shls_cmd('clean', cwd, skip_preqs)
+        if sw_compile:
+            self._run_shls_cmd('sw_compile', cwd, skip_preqs)
+        if hw:
+            self._run_shls_cmd('hw', cwd, skip_preqs)
+        if cosim:
+            self._run_shls_cmd('cosim', cwd, skip_preqs)
+        if rtl_synth:
+            self._run_shls_cmd('rtl_synth', cwd, skip_preqs)
+        if fpga:
+            self._run_shls_cmd('fpga', cwd, skip_preqs)
+
+        for arg_name, arg_val in kwargs.items():
+            if arg_val:
+                self._run_shls_cmd(arg_name, cwd, skip_preqs)
+
+        return parse_libero_report(model.config.get_output_dir())
+
+    @layer_optimizer(Layer)
+    def init_base_layer(self, layer):
+        reuse_factor = layer.model.config.get_reuse_factor(layer)
+        layer.set_attr('reuse_factor', reuse_factor)
+        if layer.name in layer.model.inputs + layer.model.outputs:
+            for out_name, out_var in layer.variables.items():
+                new_out_var = StructWrapperVariable(out_var)
+                layer.set_attr(out_name, new_out_var)
+
+    @layer_optimizer(Dense)
+    def init_dense(self, layer):
+        if layer.model.config.is_resource_strategy(layer):
+            n_in, n_out = self.get_layer_mult_size(layer)
+            self.set_target_reuse_factor(layer)
+            self.set_closest_reuse_factor(layer, n_in, n_out)
+            layer.set_attr('strategy', 'resource')
+        else:
+            layer.set_attr('strategy', 'latency')