Added support for VCI and VC belonging to different libraries.

Improved compliance tests to detect lack of as_sync function and added missing functions to VUnit VCIs

Author: LarsAsplund

tests/unit/test_compliance_test.py

@@ -472,11 +472,11 @@ def test_create_vhdl_testbench_template_references(self):
 
         vc_path = self.make_file("vc2.vhd", vc_contents)
         template, _ = VerificationComponent.create_vhdl_testbench_template(
-            "vc_lib", vc_path, self.vci_path
+            "vc_lib", "vc_lib", vc_path, self.vci_path
         )
         template = VHDLDesignFile.parse(template)
         refs = template.references
-        self.assertEqual(len(refs), 13)
+        self.assertEqual(len(refs), 14)
         self.assertIn(VHDLReference("library", "vunit_lib"), refs)
         self.assertIn(VHDLReference("library", "vc_lib"), refs)
         self.assertIn(VHDLReference("library", "a_lib"), refs)
@@ -485,6 +485,7 @@ def test_create_vhdl_testbench_template_references(self):
         self.assertIn(VHDLReference("package", "vc_lib", "vc_pkg", "all"), refs)
         self.assertIn(VHDLReference("package", "a_lib", "x", "y"), refs)
         self.assertIn(VHDLReference("package", "vunit_lib", "sync_pkg", "all"), refs)
+        self.assertIn(VHDLReference("package", "vunit_lib", "vc_pkg", "all"), refs)
         self.assertIn(VHDLReference("context", "vc_lib", "spam"), refs)
         self.assertIn(VHDLReference("context", "a_lib", "eggs"), refs)
         self.assertIn(VHDLReference("context", "vunit_lib", "vunit_context"), refs)
@@ -667,7 +668,9 @@ def test_creating_template_with_specified_vc_lib(self):
             [
                 "compliance_test.py",
                 "create-vc",
-                "-l",
+                "--vc-lib-name",
+                "my_vc_lib",
+                "--vci-lib-name",
                 "my_vc_lib",
                 self.vc_path,
                 self.vci_path,

vunit/vc/compliance_test.py

@@ -18,7 +18,7 @@
 def _create_vc_template(args):
     """Creates VC testbench template from args."""
     template_code, vc_name = VerificationComponent.create_vhdl_testbench_template(
-        args.vc_lib_name, args.vc_path, args.vci_path
+        args.vc_lib_name, args.vci_lib_name, args.vc_path, args.vci_path
     )
     if not template_code or not vc_name:
         sys.exit(1)
@@ -46,21 +46,21 @@ def _create_vci_template(args):
         template_code,
         vci_name,
     ) = VerificationComponentInterface.create_vhdl_testbench_template(
-        args.vc_lib_name, args.vci_path, args.vc_handle_t
+        args.vci_lib_name, args.vci_path, args.vc_handle_t
     )
     if not template_code or not vci_name:
         sys.exit(1)
 
     if not args.output_path:
-        output_dir = args.vci_path.parent / ".vc" / vci_name
+        output_dir = args.vc_path.parent / ".vc" / vci_name
         if not output_dir.exists():
             output_dir.mkdir(parents=True)
 
         output_path = output_dir / ("tb_%s_compliance_template.vhd" % args.vc_handle_t)
     elif args.output_path.is_dir():
         output_dir = args.output_path / vci_name
         if not output_dir.exists():
-            output_dir.mkdir(parents=True)
+            output_dir.exists(parents=True)
         output_path = output_dir / ("tb_%s_compliance_template.vhd" % args.vc_handle_t)
     else:
         output_path = args.output_path
@@ -79,9 +79,13 @@ def create_vc_parser(subparsers):
             "create-vc", help="Creates a VC compliance test template"
         )
         parser.add_argument(
-            "-l",
             "--vc-lib-name",
-            help="Name of library hosting the VC and the VCI (default: vc_lib)",
+            help="Name of library hosting the VC (default: vc_lib)",
+            default="vc_lib",
+        )
+        parser.add_argument(
+            "--vci-lib-name",
+            help="Name of library hosting the VCI (default: vc_lib)",
             default="vc_lib",
         )
         parser.add_argument(
@@ -102,9 +106,8 @@ def create_vci_parser(subparsers):
             "create-vci", help="Creates a VCI compliance test template"
         )
         parser.add_argument(
-            "-l",
-            "--vc-lib-name",
-            help="Name of library hosting the VC and the VCI (default: vc_lib)",
+            "--vci-lib-name",
+            help="Name of library hosting the VCI (default: vc_lib)",
             default="vc_lib",
         )
         parser.add_argument(

vunit/vc/verification_component.py

@@ -99,11 +99,12 @@ def validate(vc_path):
             return vc_code
 
     @staticmethod
-    def create_vhdl_testbench_template(vc_lib_name, vc_path, vci_path):
+    def create_vhdl_testbench_template(vc_lib_name, vci_lib_name, vc_path, vci_path):
         """
         Creates a template for a VC compliance testbench.
 
-        :param vc_lib_name: Name of the library containing the verification component and its interface.
+        :param vc_lib_name: Name of the library containing the verification component.
+        :param vci_lib_name: Name of the library containing the verification component interface.
         :param vc_path: Path to the file containing the verification component entity.
         :param vci_path: Path to the file containing the verification component interface package.
 
@@ -209,8 +210,9 @@ def create_signal_declarations_and_vc_instantiation(vc_entity, vc_lib_name):
 
         initial_package_refs = set(
             [
+                "vunit_lib.vc_pkg.all",
                 "vunit_lib.sync_pkg.all",
-                "%s.%s.all" % (vc_lib_name, vci_code.packages[0].identifier),
+                "%s.%s.all" % (vci_lib_name, vci_code.packages[0].identifier),
             ]
         )
         context_items = create_context_items(
@@ -385,6 +387,7 @@ def update_generics(code):
         else:
             template_code, _ = self.create_vhdl_testbench_template(
                 self.vc_facade.library,
+                self.vci.vci_facade.library,
                 self.vc_facade.source_file.name,
                 self.vci.vci_facade.source_file.name,
             )

vunit/vc/verification_component_interface.py

@@ -57,18 +57,18 @@ class VerificationComponentInterface:
     """Represents a Verification Component Interface (VCI)."""
 
     @classmethod
-    def find(cls, vc_lib, vci_name, vc_handle_t):
+    def find(cls, vci_lib, vci_name, vc_handle_t):
         """Finds the specified VCI if present.
 
-        :param vc_lib: Library object containing the VCI.
+        :param vci_lib: Library object containing the VCI.
         :param vci_name: Name of VCI package.
         :param vc_handle_t: Name of VC handle type.
 
         :returns: A VerificationComponentInterface object.
         """
 
         try:
-            vci_facade = vc_lib.package(vci_name)
+            vci_facade = vci_lib.package(vci_name)
         except KeyError:
             LOGGER.error("Failed to find VCI %s", vci_name)
             sys.exit(1)
@@ -91,6 +91,10 @@ def validate(cls, vci_path, vc_handle_t):
                 LOGGER.error("%s must contain a single VCI package", vci_path)
                 return None, None
 
+            if not cls._validate_as_sync(code, vc_handle_t):
+                LOGGER.error("%s must provide an as_sync function", vci_path)
+                return None, None
+
             vc_constructor = cls._validate_constructor(code, vc_handle_t)
             if not cls._validate_handle(code, vc_handle_t):
                 vc_constructor = None
@@ -101,6 +105,30 @@ def __init__(self, vci_facade, vc_constructor):
         self.vci_facade = vci_facade
         self.vc_constructor = vc_constructor
 
+    @staticmethod
+    def _validate_as_sync(code, vc_handle_t):
+        """Validates the existence and format of the as_sync function."""
+
+        for func in VHDLFunctionSpecification.find(code):
+            if not func.identifier.startswith("as_sync"):
+                continue
+
+            if func.return_type_mark != "sync_handle_t":
+                continue
+
+            if len(func.parameter_list) != 1:
+                continue
+
+            if len(func.parameter_list[0].identifier_list) != 1:
+                continue
+
+            if func.parameter_list[0].subtype_indication.type_mark != vc_handle_t:
+                continue
+
+            return func
+
+        return None
+
     @staticmethod
     def _validate_constructor(code, vc_handle_t):
         """Validates the existence and format of the verification component constructor."""

vunit/vhdl/verification_components/src/stream_master_pkg-body.vhd

@@ -30,6 +30,11 @@ package body stream_master_pkg is
     return master.p_std_cfg;
   end;
 
+  impure function as_sync(master : stream_master_t) return sync_handle_t is
+  begin
+    return get_actor(master.p_std_cfg);
+  end;
+
   procedure push_stream(signal net : inout network_t;
                         stream : stream_master_t;
                         data : std_logic_vector;

vunit/vhdl/verification_components/src/stream_master_pkg.vhd

@@ -12,6 +12,7 @@ use ieee.std_logic_1164.all;
 context work.vunit_context;
 context work.com_context;
 use work.vc_pkg.all;
+use work.sync_pkg.all;
 
 package stream_master_pkg is
   -- Stream master handle
@@ -31,6 +32,7 @@ package stream_master_pkg is
   ) return stream_master_t;
 
   function get_std_cfg(master : stream_master_t) return std_cfg_t;
+  impure function as_sync(master : stream_master_t) return sync_handle_t;
 
   -- Push a data value to the stream
   procedure push_stream(signal net : inout network_t;

vunit/vhdl/verification_components/src/stream_slave_pkg-body.vhd

@@ -25,6 +25,11 @@ package body stream_slave_pkg is
     return slave.p_std_cfg;
   end;
 
+  impure function as_sync(slave : stream_slave_t) return sync_handle_t is
+  begin
+    return get_actor(slave.p_std_cfg);
+  end;
+
   procedure pop_stream(signal net : inout network_t;
                        stream : stream_slave_t;
                        variable reference : inout stream_reference_t) is

vunit/vhdl/verification_components/src/stream_slave_pkg.vhd

@@ -13,6 +13,7 @@ context work.vunit_context;
 context work.com_context;
 
 use work.vc_pkg.all;
+use work.sync_pkg.all;
 
 package stream_slave_pkg is
   -- Stream slave handle
@@ -32,6 +33,7 @@ package stream_slave_pkg is
   ) return stream_slave_t;
 
   function get_std_cfg(slave : stream_slave_t) return std_cfg_t;
+  impure function as_sync(slave : stream_slave_t) return sync_handle_t;
 
   -- Reference to future stream result
   alias stream_reference_t is msg_t;