Parse explicit VLNV in KPM frontend

Author: Krzysztof Szymanski

tests/tests_ir/frontend/test_kpm.py

@@ -9,7 +9,7 @@
 from pipeline_manager.dataflow_builder.data_structures import OutOfSpecificationNodeError
 
 from examples.ir_examples.modules import ALL_MODULES
-from topwrap.backend.kpm.common import LayerType
+from topwrap.backend.kpm.common import LayerType, id_to_kpm_name
 from topwrap.frontend.kpm.common import KpmFrontendParseException
 from topwrap.frontend.kpm.dataflow import KpmDataflowFrontend
 from topwrap.frontend.kpm.frontend import KpmFrontend
@@ -101,7 +101,10 @@ def test_ir(self, files: dict[str, JsonType], file: str, validator: Callable[[Mo
     def test_non_default_version(self):
         mod = Module(id=Identifier(name="versioned_mod", version="2.0"), ports=[])
         front = KpmDataflowFrontend([mod])
-        assert front._modmap[mod.id.name] is mod
+        assert mod.id == Identifier(
+            name="versioned_mod", version="2.0", library="libdefault", vendor="vendor"
+        )
+        assert front._modmap[id_to_kpm_name(mod.id)] == mod
 
     def test_io_inference(self, files: dict[str, JsonType]):
         front = KpmDataflowFrontend(ALL_MODULES)

topwrap/backend/kpm/common.py

@@ -60,7 +60,14 @@ class KpmNodeId:
 
     @classmethod
     def from_ir_id(cls, id: Identifier):
-        return cls(id.to_kpm_name(), f"{id.vendor}/{id.library}")
+        return cls(id_to_kpm_name(id), f"{id.vendor}/{id.library}")
+
+
+def id_to_kpm_name(id: Identifier) -> str:
+    """
+    Return KPM name from id in the format '{name} v{version} ({vendor}/{library})'.
+    """
+    return f"{id.name} v{id.version} ({id.vendor}/{id.library})"
 
 
 def kpm_dir_from(dir: Union[PortDirection, InterfaceMode, str]) -> KpmDirection:

topwrap/frontend/kpm/common.py

@@ -15,7 +15,9 @@
 from topwrap.frontend.frontend import FrontendParseException
 from topwrap.model.connections import PortDirection
 from topwrap.model.interface import InterfaceMode
-from topwrap.model.misc import TranslationError
+from topwrap.model.misc import (
+    TranslationError,
+)
 
 
 class KpmFrontendParseException(FrontendParseException):

topwrap/frontend/kpm/dataflow.py

@@ -54,7 +54,13 @@
 from topwrap.model.hdl_types import Bit, Logic
 from topwrap.model.interconnect import Interconnect
 from topwrap.model.interface import Interface, InterfaceDefinition
-from topwrap.model.misc import ElaboratableValue, FileReference, Identifier, ObjectId, QuerableView
+from topwrap.model.misc import (
+    ElaboratableValue,
+    FileReference,
+    Identifier,
+    ObjectId,
+    QuerableView,
+)
 from topwrap.model.module import Design, Module
 from topwrap.util import JsonType, UnreachableError
 
@@ -205,7 +211,7 @@ def __init__(self, modules: Iterable[Module]) -> None:
         for mod in modules:
             spec.add_module(mod)
         for node in spec._spec._get_nodes(False):
-            if (add := node.get("additionalData")) is not None:
+            if (add := node.get("additionalData", None)) is not None:
                 self._modmap[node["name"]] = modids[Identifier(**add["full_module_id"])]
         self._spec = spec.build()
 

topwrap/frontend/kpm/specification.py

@@ -7,7 +7,7 @@
 
 from pipeline_manager.dataflow_builder.entities import Direction
 
-from topwrap.backend.kpm.common import PORT_INTF_TYPE, KpmNodeAdditionalData, LayerType
+from topwrap.backend.kpm.common import PORT_INTF_TYPE, LayerType
 from topwrap.frontend.kpm.common import (
     KpmFrontendParseException,
     kpm_dir_to_ir_intf,
@@ -17,7 +17,12 @@
 from topwrap.kpm_common import SPECIFICATION_VERSION
 from topwrap.model.connections import Port
 from topwrap.model.interface import Interface, InterfaceDefinition
-from topwrap.model.misc import ElaboratableValue, FileReference, Identifier, Parameter
+from topwrap.model.misc import (
+    ElaboratableValue,
+    FileReference,
+    Identifier,
+    Parameter,
+)
 from topwrap.model.module import Module
 from topwrap.util import JsonType
 
@@ -84,13 +89,13 @@ def parse(
             if node.get("layer", "") != LayerType.IP_CORE.value:
                 continue
 
-            add: KpmNodeAdditionalData = node["additionalData"]
+            add = node.get("additionalData", None)
+            if add is None:
+                raise KpmFrontendParseException(
+                    f"Node {node['name']} lacks additionalData vith VLNV"
+                )
             mod = Module(
-                id=Identifier(
-                    name=add["full_module_id"]["name"],
-                    vendor=add["full_module_id"]["vendor"],
-                    library=add["full_module_id"]["library"],
-                ),
+                id=Identifier(**add["full_module_id"]),
                 refs=[FileReference(source)] if source else (),
             )
 

topwrap/model/misc.py

@@ -259,20 +259,6 @@ def combined(self) -> str:
     def __str__(self) -> str:
         return f"{self.vendor}:{self.library}:{self.name}:{self.version}"
 
-    def to_kpm_name(self) -> str:
-        """
-        Return KPM name from id in the format "{name} v{version} ({vendor}/{library})".
-        """
-        return f"{self.name} v{self.version} ({self.vendor}/{self.library})"
-
-
-def id_from_kpm_name(kpm_name: str) -> Identifier:
-    name, rest = kpm_name.split(" v", 1)
-    version, rest = rest.split(" (", 1)
-    vendor, rest = rest.split("/", 1)
-    library = rest[:-1]
-    return Identifier(name, vendor, library, version)
-
 
 @dataclass
 class FileReference: