Merge pull request #13 from opennetworkinglab/p4-comment

Mostly comments to P4 code and minor refactorings

Author: ccascone

Makefile

@@ -19,7 +19,7 @@ curr_dir_sha := $(shell echo -n "$(curr_dir)" | shasum | cut -c1-7)
 app_build_container_name := app-build-${curr_dir_sha}
 onos_url := http://localhost:8181/onos
 onos_curl := curl --fail -sSL --user onos:rocks --noproxy localhost
-app_name := org.p4.srv6-tutorial
+app_name := org.onosproject.ngsdn-tutorial
 
 default:
 	$(error Please specify a make target (see README.md))
@@ -90,6 +90,7 @@ p4-build:
 p4-test:
 	@cd ptf && ./run_tests
 
+# Create container once, use it many times to preserve mvn repo cache.
 _create_mvn_container:
 	@if ! docker container ls -a --format '{{.Names}}' | grep -q ${app_build_container_name} ; then \
 		docker create -v ${curr_dir}/app:/mvn-src -w /mvn-src --name ${app_build_container_name} ${MAVEN_IMG} mvn clean package; \

app/pom.xml

@@ -19,33 +19,31 @@
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
 
-    <groupId>org.p4</groupId>
-    <artifactId>srv6-tutorial</artifactId>
+    <groupId>org.onosproject</groupId>
+    <artifactId>ngsdn-tutorial</artifactId>
     <version>1.0-SNAPSHOT</version>
     <packaging>bundle</packaging>
 
-    <description>P4D2 SRv6 tutorial app</description>
-    <url>http://p4.org</url>
+    <description>NG-SDN tutorial app</description>
+    <url>http://www.onosproject.org</url>
 
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <onos.version>2.2.0</onos.version>
-        <onos.app.name>org.p4.srv6-tutorial</onos.app.name>
-        <onos.app.title>P4D2 SRv6 Tutorial App</onos.app.title>
+        <onos.app.name>org.onosproject.ngsdn-tutorial</onos.app.name>
+        <onos.app.title>NG-SDN Tutorial App</onos.app.title>
         <onos.app.origin>p4.org</onos.app.origin>
         <onos.app.category>Traffic Steering</onos.app.category>
-        <onos.app.url>http://p4.org</onos.app.url>
+        <onos.app.url>http://www.onosproject.org</onos.app.url>
         <onos.app.readme>
-            Provides SRv6 capabilities to a leaf-spine network of P4 switches
+            Provides IPv6 routing capabilities to a leaf-spine network of P4 switches
         </onos.app.readme>
         <onos.app.requires>
             org.onosproject.drivers.bmv2,
             org.onosproject.lldpprovider,
             org.onosproject.hostprovider,
             org.onosproject.gui
         </onos.app.requires>
-        <maven.compiler.source>1.8</maven.compiler.source>
-        <maven.compiler.target>1.8</maven.compiler.target>
     </properties>
 
     <dependencies>
@@ -159,7 +157,7 @@
                 <extensions>true</extensions>
                 <configuration>
                     <instructions>
-                        <Karaf-Commands>org.p4.p4d2.tutorial.cli</Karaf-Commands>
+                        <Karaf-Commands>org.onosproject.ngsdn.tutorial.cli</Karaf-Commands>
                     </instructions>
                 </configuration>
             </plugin>

app/src/main/java/org/p4/p4d2/tutorial/AppConstants.java renamed to app/src/main/java/org/onosproject/ngsdn/tutorial/AppConstants.java

@@ -14,14 +14,14 @@
  * limitations under the License.
  */
 
-package org.p4.p4d2.tutorial;
+package org.onosproject.ngsdn.tutorial;
 
 import org.onosproject.net.pi.model.PiPipeconfId;
 
 public class AppConstants {
 
-    public static final String APP_NAME = "org.p4.srv6-tutorial";
-    public static final PiPipeconfId PIPECONF_ID = new PiPipeconfId("org.p4.srv6-tutorial");
+    public static final String APP_NAME = "org.onosproject.ngsdn-tutorial";
+    public static final PiPipeconfId PIPECONF_ID = new PiPipeconfId("org.onosproject.ngsdn-tutorial");
 
     public static final int DEFAULT_FLOW_RULE_PRIORITY = 10;
     public static final int INITIAL_SETUP_DELAY = 2; // Seconds.

app/src/main/java/org/p4/p4d2/tutorial/Ipv6RoutingComponent.java renamed to app/src/main/java/org/onosproject/ngsdn/tutorial/Ipv6RoutingComponent.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.p4.p4d2.tutorial;
+package org.onosproject.ngsdn.tutorial;
 
 import com.google.common.collect.Lists;
 import org.onlab.packet.Ip6Address;
@@ -60,8 +60,8 @@
 import org.osgi.service.component.annotations.Deactivate;
 import org.osgi.service.component.annotations.Reference;
 import org.osgi.service.component.annotations.ReferenceCardinality;
-import org.p4.p4d2.tutorial.common.Srv6DeviceConfig;
-import org.p4.p4d2.tutorial.common.Utils;
+import org.onosproject.ngsdn.tutorial.common.Srv6DeviceConfig;
+import org.onosproject.ngsdn.tutorial.common.Utils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -73,7 +73,7 @@
 import java.util.stream.Collectors;
 
 import static com.google.common.collect.Streams.stream;
-import static org.p4.p4d2.tutorial.AppConstants.INITIAL_SETUP_DELAY;
+import static org.onosproject.ngsdn.tutorial.AppConstants.INITIAL_SETUP_DELAY;
 
 /**
  * App component that configures devices to provide IPv6 routing capabilities
@@ -190,7 +190,7 @@ private void setUpMyStationTable(DeviceId deviceId) {
         // Modify P4Runtime entity names to match content of P4Info file (look
         // for the fully qualified name of tables, match fields, and actions.
         // ---- START SOLUTION ----
-        final String tableId = "IngressPipeImpl.l2_my_station";
+        final String tableId = "IngressPipeImpl.my_station_table";
 
         final PiCriterion match = PiCriterion.builder()
                 .matchExact(
@@ -235,10 +235,10 @@ private GroupDescription createNextHopGroup(int groupId,
         // Modify P4Runtime entity names to match content of P4Info file (look
         // for the fully qualified name of tables, match fields, and actions.
         // ---- START SOLUTION ----
-        final String tableId = "IngressPipeImpl.l3_table";
+        final String tableId = "IngressPipeImpl.routing_v6_table";
         for (MacAddress nextHopMac : nextHopMacs) {
             final PiAction action = PiAction.builder()
-                    .withId(PiActionId.of("IngressPipeImpl.set_l2_next_hop"))
+                    .withId(PiActionId.of("IngressPipeImpl.set_next_hop"))
                     .withParameter(new PiActionParam(
                             // Action param name.
                             PiActionParamId.of("dmac"),
@@ -270,7 +270,7 @@ private FlowRule createRoutingRule(DeviceId deviceId, Ip6Prefix ip6Prefix,
         // Modify P4Runtime entity names to match content of P4Info file (look
         // for the fully qualified name of tables, match fields, and actions.
         // ---- START SOLUTION ----
-        final String tableId = "IngressPipeImpl.l3_table";
+        final String tableId = "IngressPipeImpl.routing_v6_table";
         final PiCriterion match = PiCriterion.builder()
                 .matchLpm(
                         PiMatchFieldId.of("hdr.ipv6.dst_addr"),

app/src/main/java/org/p4/p4d2/tutorial/L2BridgingComponent.java renamed to app/src/main/java/org/onosproject/ngsdn/tutorial/L2BridgingComponent.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.p4.p4d2.tutorial;
+package org.onosproject.ngsdn.tutorial;
 
 import org.onlab.packet.MacAddress;
 import org.onosproject.core.ApplicationId;
@@ -47,15 +47,15 @@
 import org.osgi.service.component.annotations.Deactivate;
 import org.osgi.service.component.annotations.Reference;
 import org.osgi.service.component.annotations.ReferenceCardinality;
-import org.p4.p4d2.tutorial.common.Srv6DeviceConfig;
-import org.p4.p4d2.tutorial.common.Utils;
+import org.onosproject.ngsdn.tutorial.common.Srv6DeviceConfig;
+import org.onosproject.ngsdn.tutorial.common.Utils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import java.util.Set;
 import java.util.stream.Collectors;
 
-import static org.p4.p4d2.tutorial.AppConstants.INITIAL_SETUP_DELAY;
+import static org.onosproject.ngsdn.tutorial.AppConstants.INITIAL_SETUP_DELAY;
 
 /**
  * App component that configures devices to provide L2 bridging capabilities.

app/src/main/java/org/p4/p4d2/tutorial/MainComponent.java renamed to app/src/main/java/org/onosproject/ngsdn/tutorial/MainComponent.java

@@ -1,4 +1,4 @@
-package org.p4.p4d2.tutorial;
+package org.onosproject.ngsdn.tutorial;
 
 import com.google.common.collect.Lists;
 import org.onlab.util.SharedScheduledExecutors;
@@ -20,8 +20,8 @@
 import org.osgi.service.component.annotations.Deactivate;
 import org.osgi.service.component.annotations.Reference;
 import org.osgi.service.component.annotations.ReferenceCardinality;
-import org.p4.p4d2.tutorial.common.Srv6DeviceConfig;
-import org.p4.p4d2.tutorial.pipeconf.PipeconfLoader;
+import org.onosproject.ngsdn.tutorial.common.Srv6DeviceConfig;
+import org.onosproject.ngsdn.tutorial.pipeconf.PipeconfLoader;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -30,10 +30,10 @@
 import java.util.concurrent.Executors;
 import java.util.concurrent.TimeUnit;
 
-import static org.p4.p4d2.tutorial.AppConstants.APP_NAME;
-import static org.p4.p4d2.tutorial.AppConstants.CLEAN_UP_DELAY;
-import static org.p4.p4d2.tutorial.AppConstants.DEFAULT_CLEAN_UP_RETRY_TIMES;
-import static org.p4.p4d2.tutorial.common.Utils.sleep;
+import static org.onosproject.ngsdn.tutorial.AppConstants.APP_NAME;
+import static org.onosproject.ngsdn.tutorial.AppConstants.CLEAN_UP_DELAY;
+import static org.onosproject.ngsdn.tutorial.AppConstants.DEFAULT_CLEAN_UP_RETRY_TIMES;
+import static org.onosproject.ngsdn.tutorial.common.Utils.sleep;
 
 /**
  * A component which among other things registers the Srv6DeviceConfig to the

app/src/main/java/org/p4/p4d2/tutorial/NdpReplyComponent.java renamed to app/src/main/java/org/onosproject/ngsdn/tutorial/NdpReplyComponent.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.p4.p4d2.tutorial;
+package org.onosproject.ngsdn.tutorial;
 
 import org.onlab.packet.Ip6Address;
 import org.onlab.packet.IpAddress;
@@ -50,15 +50,15 @@
 import org.osgi.service.component.annotations.Deactivate;
 import org.osgi.service.component.annotations.Reference;
 import org.osgi.service.component.annotations.ReferenceCardinality;
-import org.p4.p4d2.tutorial.common.Srv6DeviceConfig;
+import org.onosproject.ngsdn.tutorial.common.Srv6DeviceConfig;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import java.util.Collection;
 import java.util.stream.Collectors;
 
-import static org.p4.p4d2.tutorial.AppConstants.DEFAULT_FLOW_RULE_PRIORITY;
-import static org.p4.p4d2.tutorial.AppConstants.INITIAL_SETUP_DELAY;
+import static org.onosproject.ngsdn.tutorial.AppConstants.DEFAULT_FLOW_RULE_PRIORITY;
+import static org.onosproject.ngsdn.tutorial.AppConstants.INITIAL_SETUP_DELAY;
 
 /**
  * App component that configures devices to generate NDP Neighbor Advertisement

app/src/main/java/org/p4/p4d2/tutorial/Srv6Component.java renamed to app/src/main/java/org/onosproject/ngsdn/tutorial/Srv6Component.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.p4.p4d2.tutorial;
+package org.onosproject.ngsdn.tutorial;
 
 import com.google.common.collect.Lists;
 import org.onlab.packet.Ip6Address;
@@ -41,16 +41,16 @@
 import org.osgi.service.component.annotations.Deactivate;
 import org.osgi.service.component.annotations.Reference;
 import org.osgi.service.component.annotations.ReferenceCardinality;
-import org.p4.p4d2.tutorial.common.Srv6DeviceConfig;
-import org.p4.p4d2.tutorial.common.Utils;
+import org.onosproject.ngsdn.tutorial.common.Srv6DeviceConfig;
+import org.onosproject.ngsdn.tutorial.common.Utils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import java.util.List;
 import java.util.Optional;
 
 import static com.google.common.collect.Streams.stream;
-import static org.p4.p4d2.tutorial.AppConstants.INITIAL_SETUP_DELAY;
+import static org.onosproject.ngsdn.tutorial.AppConstants.INITIAL_SETUP_DELAY;
 
 /**
  * Application which handles SRv6 segment routing.

app/src/main/java/org/p4/p4d2/tutorial/cli/Srv6ClearCommand.java renamed to app/src/main/java/org/onosproject/ngsdn/tutorial/cli/Srv6ClearCommand.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.p4.p4d2.tutorial.cli;
+package org.onosproject.ngsdn.tutorial.cli;
 
 import org.apache.karaf.shell.api.action.Argument;
 import org.apache.karaf.shell.api.action.Command;
@@ -24,7 +24,7 @@
 import org.onosproject.net.Device;
 import org.onosproject.net.DeviceId;
 import org.onosproject.net.device.DeviceService;
-import org.p4.p4d2.tutorial.Srv6Component;
+import org.onosproject.ngsdn.tutorial.Srv6Component;
 
 /**
  * SRv6 Transit Clear Command

app/src/main/java/org/p4/p4d2/tutorial/cli/Srv6InsertCommand.java renamed to app/src/main/java/org/onosproject/ngsdn/tutorial/cli/Srv6InsertCommand.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.p4.p4d2.tutorial.cli;
+package org.onosproject.ngsdn.tutorial.cli;
 
 import org.apache.karaf.shell.api.action.Argument;
 import org.apache.karaf.shell.api.action.Command;
@@ -26,7 +26,7 @@
 import org.onosproject.net.Device;
 import org.onosproject.net.DeviceId;
 import org.onosproject.net.device.DeviceService;
-import org.p4.p4d2.tutorial.Srv6Component;
+import org.onosproject.ngsdn.tutorial.Srv6Component;
 
 import java.util.List;
 import java.util.stream.Collectors;

app/src/main/java/org/p4/p4d2/tutorial/cli/Srv6SidCompleter.java renamed to app/src/main/java/org/onosproject/ngsdn/tutorial/cli/Srv6SidCompleter.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.p4.p4d2.tutorial.cli;
+package org.onosproject.ngsdn.tutorial.cli;
 
 import org.apache.karaf.shell.api.action.lifecycle.Service;
 import org.apache.karaf.shell.api.console.CommandLine;
@@ -23,7 +23,7 @@
 import org.onosproject.cli.AbstractShellCommand;
 import org.onosproject.net.config.NetworkConfigService;
 import org.onosproject.net.device.DeviceService;
-import org.p4.p4d2.tutorial.common.Srv6DeviceConfig;
+import org.onosproject.ngsdn.tutorial.common.Srv6DeviceConfig;
 
 import java.util.List;
 import java.util.Objects;

app/src/main/java/org/p4/p4d2/tutorial/common/Srv6DeviceConfig.java renamed to app/src/main/java/org/onosproject/ngsdn/tutorial/common/Srv6DeviceConfig.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.p4.p4d2.tutorial.common;
+package org.onosproject.ngsdn.tutorial.common;
 
 import org.onlab.packet.Ip6Address;
 import org.onlab.packet.MacAddress;

app/src/main/java/org/p4/p4d2/tutorial/common/Utils.java renamed to app/src/main/java/org/onosproject/ngsdn/tutorial/common/Utils.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.p4.p4d2.tutorial.common;
+package org.onosproject.ngsdn.tutorial.common;
 
 import org.onosproject.core.ApplicationId;
 import org.onosproject.net.DeviceId;
@@ -48,7 +48,7 @@
 import static com.google.common.base.Preconditions.checkNotNull;
 import static org.onosproject.net.group.DefaultGroupBucket.createAllGroupBucket;
 import static org.onosproject.net.group.DefaultGroupBucket.createCloneGroupBucket;
-import static org.p4.p4d2.tutorial.AppConstants.DEFAULT_FLOW_RULE_PRIORITY;
+import static org.onosproject.ngsdn.tutorial.AppConstants.DEFAULT_FLOW_RULE_PRIORITY;
 
 public final class Utils {
 

app/src/main/java/org/p4/p4d2/tutorial/pipeconf/InterpreterImpl.java renamed to app/src/main/java/org/onosproject/ngsdn/tutorial/pipeconf/InterpreterImpl.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.p4.p4d2.tutorial.pipeconf;
+package org.onosproject.ngsdn.tutorial.pipeconf;
 
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableMap;
@@ -54,7 +54,7 @@
 import static org.onosproject.net.flow.instructions.Instruction.Type.OUTPUT;
 import static org.onosproject.net.flow.instructions.Instructions.OutputInstruction;
 import static org.onosproject.net.pi.model.PiPacketOperationType.PACKET_OUT;
-import static org.p4.p4d2.tutorial.AppConstants.CPU_PORT_ID;
+import static org.onosproject.ngsdn.tutorial.AppConstants.CPU_PORT_ID;
 
 
 /**
@@ -75,9 +75,8 @@ public class InterpreterImpl extends AbstractHandlerBehaviour
                     .put(Criterion.Type.ETH_SRC, "hdr.ethernet.src_addr")
                     .put(Criterion.Type.ETH_TYPE, "hdr.ethernet.ether_type")
                     .put(Criterion.Type.IPV6_DST, "hdr.ipv6.dst_addr")
-                    .put(Criterion.Type.IP_PROTO, "local_metadata.ip_proto")
-                    .put(Criterion.Type.ICMPV4_TYPE, "local_metadata.icmp_type")
-                    .put(Criterion.Type.ICMPV6_TYPE, "local_metadata.icmp_type")
+                    .put(Criterion.Type.IP_PROTO, "hdr.ipv6.next_hdr")
+                    .put(Criterion.Type.ICMPV6_TYPE, "hdr.icmpv6.type")
                     .build();
 
     /**

app/src/main/java/org/p4/p4d2/tutorial/pipeconf/PipeconfLoader.java renamed to app/src/main/java/org/onosproject/ngsdn/tutorial/pipeconf/PipeconfLoader.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.p4.p4d2.tutorial.pipeconf;
+package org.onosproject.ngsdn.tutorial.pipeconf;
 
 import org.onosproject.net.behaviour.Pipeliner;
 import org.onosproject.net.driver.DriverAdminService;
@@ -40,7 +40,7 @@
 
 import static org.onosproject.net.pi.model.PiPipeconf.ExtensionType.BMV2_JSON;
 import static org.onosproject.net.pi.model.PiPipeconf.ExtensionType.P4_INFO_TEXT;
-import static org.p4.p4d2.tutorial.AppConstants.PIPECONF_ID;
+import static org.onosproject.ngsdn.tutorial.AppConstants.PIPECONF_ID;
 
 /**
  * Component that builds and register the pipeconf at app activation.