Merge pull request #960 from nasa/topology-ports-users-guide

Topology ports users guide

Author: Kronos3

compiler/lib/src/main/resources/META-INF/native-image/reflect-config.json

@@ -222,7 +222,7 @@ object Connection {
         case InterfaceInstance.InterfaceComponentInstance(ci) => this
         case InterfaceInstance.InterfaceTopology(top) => this.copy(
           // Look up the mapping for this port instance
-          port = top.portMap(port.portInstance.getUnqualifiedName)._1,
+          port = top.portMap(port.portInstance.getUnqualifiedName).pii,
           topologyPort = Some(this)
           // Recursively resolve the endpoint to a component instance
         ).getUnderlyingEndpoint()

compiler/lib/src/main/scala/analysis/Semantics/Connection.scala

@@ -28,10 +28,9 @@ object ResolvePartiallyNumbered {
 
   /** Check that connection instances are legal */
   private def checkPortInstances(t: Topology): Result.Result[Unit] = {
-    def checkPort(i: (PortInstanceIdentifier, Location)) = {
-      val (port, loc) = i
+    def checkPort(i: TopologyPort) = {
       for {
-        _ <- t.lookUpInstanceAt(port.interfaceInstance, loc)
+        _ <- t.lookUpInstanceAt(i.pii.interfaceInstance, i.getUnderlyingPortLoc)
       }
       yield ()
     }

compiler/lib/src/main/scala/analysis/Semantics/ResolveTopology/ResolvePartiallyNumbered.scala

@@ -16,7 +16,6 @@ object ResolveTopologyPortInterface {
         t <- t.addPort(
           aNode,
           instance,
-          Locations.get(node.id)
         )
       } yield t
     })

compiler/lib/src/main/scala/analysis/Semantics/ResolveTopology/ResolveTopologyPortInterface.scala

@@ -20,7 +20,7 @@ case class Topology(
   /** List of the ports in the topology to resolve later */
   ports: List[Ast.Annotated[AstNode[Ast.SpecTopPort]]] = List(),
   /** The ports in the topology resolved to their port instance identifiers */
-  portMap: Map[Name.Unqualified, (PortInstanceIdentifier, Location)] = Map(),
+  portMap: Map[Name.Unqualified, TopologyPort] = Map(),
   /** Resolved port interface of the topology */
   portInterface: PortInterface = PortInterface("topology"),
   /** The connection patterns of this topology */
@@ -53,17 +53,17 @@ case class Topology(
 
   /** Add a port to the topology */
   def addPort(
-    node: Ast.Annotated[AstNode[Ast.SpecTopPort]],
+    aNode: Ast.Annotated[AstNode[Ast.SpecTopPort]],
     underlyingPort: PortInstanceIdentifier,
-    loc: Location,
   ) = {
-    val name = node._2.data.name
+    val (_, node, _) = aNode
+    val name = node.data.name
 
     for {
       // Check that the topology port for a general port
       pi <- underlyingPort.portInstance match {
         case _: PortInstance.Internal => Left(SemanticError.InvalidPortInstance(
-          loc,
+          Locations.get(node.id),
           "topology port cannot point to an internal port",
           Locations.get(underlyingPort.portInstance.getNodeId)
         ))
@@ -72,7 +72,7 @@ case class Topology(
           for {
             iface <- this.portInterface.addPortInstance(
               PortInstance.Topology(
-                node,
+                aNode,
                 underlyingPort.portInstance
               )
             )
@@ -81,17 +81,20 @@ case class Topology(
       }
 
       t <- portMap.get(name) match {
-        case Some((_, prevPortLoc)) =>
+        case Some(prevPort) =>
           Left(SemanticError.DuplicatePortInstance(
             name,
-            loc,
+            Locations.get(node.id),
             List(),
-            prevPortLoc,
+            prevPort.getLoc,
             List()
           ))
         case None =>
           Right(this.copy(
-            portMap = portMap + (name -> (underlyingPort, loc)),
+            portMap = portMap + (name -> TopologyPort(
+              aNode,
+              underlyingPort
+            )),
             portInterface = pi
           ))
       }

compiler/lib/src/main/scala/analysis/Semantics/Topology.scala

@@ -0,0 +1,16 @@
+package fpp.compiler.analysis
+
+import fpp.compiler.ast._
+import fpp.compiler.util._
+
+/** An FPP topology port */
+case class TopologyPort(
+  aNode: Ast.Annotated[AstNode[Ast.SpecTopPort]],
+  pii: PortInstanceIdentifier
+) {
+
+  def getLoc: Location = Locations.get(aNode._2.id)
+
+  def getUnderlyingPortLoc = Locations.get(aNode._2.data.underlyingPort.id)
+
+}

compiler/lib/src/main/scala/analysis/Semantics/TopologyPort.scala

@@ -0,0 +1,35 @@
+port P
+
+active component C1 {
+
+  output port pOut: [2] P
+
+  internal port P(x: U32)
+
+}
+
+passive component C2 {
+
+  sync input port pIn: P
+
+}
+
+instance c1: C1 base id 0x100 queue size 10
+instance c2: C2 base id 0x200
+
+topology A {
+  instance c1
+
+  port a = c1.pOut
+  port b = c2.pIn
+}
+
+topology B {
+
+  instance A
+
+  connections P {
+    A.a -> A.b
+  }
+
+}

compiler/tools/fpp-check/test/top_ports/interface_instance_not_member.fpp

@@ -0,0 +1,5 @@
+fpp-check
+[ local path prefix ]/compiler/tools/fpp-check/test/top_ports/interface_instance_not_member.fpp:24.12
+  port b = c2.pIn
+           ^
+error: instance c2 is not a member of topology A

compiler/tools/fpp-check/test/top_ports/interface_instance_not_member.ref.txt

@@ -4,6 +4,7 @@ implements
 implements_port_mismatch_1
 implements_port_mismatch_2
 implements_port_missing
+interface_instance_not_member
 internal_port
 nested
 out_to_out

compiler/tools/fpp-check/test/top_ports/tests.sh

@@ -447,6 +447,7 @@ var IN_GLOBAL_SCOPE = false;
           "hook," +
           "id," +
           "if," +
+          "implements," +
           "import," +
           "include," +
           "initial," +