Adding unmatched traffic flow

Implements standard Ethernet bridging behavior of flooding unmatched traffic.
This is extra credit because it will make it difficult for students to debug
their host discovery code when enabled.

Author: bocon13

EXERCISE-5.md

@@ -345,6 +345,18 @@ bar. If you are using the tutorial VM, open up a browser (e.g. Firefox) to
 
 To toggle showing hosts on the topology view, press `H` on your keyboard.
 
+### Extra Credit
+
+The current solution drops unmatched traffic that is not an ARP or NDP packet.
+This is to prevent masking bugs your unicast forwarding code as you develop it.
+
+However, traditional bridging requires that unmatched traffic be flooded to all
+interfaces except the ingress one. We've provided some starter code that adds a
+rule to flood unmatched traffic. You will need to complete the implementation of `insertUnmatchedBridgingFlowRule()` and then call this method when the device is
+set up (in `setUpDevice()`).
+
+Look for `TODO EXERCISE 5 EXTRA CREDIT` to see where you will need to change code.
+
 ## Congratulations
 
 You have completed the fifth exercise! Now your fabric is capable of forwarding

app/src/main/java/org/onosproject/ngsdn/tutorial/L2BridgingComponent.java

@@ -154,6 +154,9 @@ private void setUpDevice(DeviceId deviceId) {
         }
         insertMulticastGroup(deviceId);
         insertMulticastFlowRules(deviceId);
+        // *** TODO EXERCISE 5 EXTRA CREDIT
+        // Uncomment the following line after you have implemented the method:
+        // insertUnmatchedBridgingFlowRule(deviceId);
     }
 
     /**
@@ -247,6 +250,54 @@ private void insertMulticastFlowRules(DeviceId deviceId) {
         flowRuleService.applyFlowRules(rule1, rule2);
     }
 
+    /**
+     * Insert flow rule that matches all unmatched ethernet traffic. This
+     * will implement the traditional briding behavior that floods all
+     * unmatched traffic.
+     * <p>
+     * This method will be called at component activation for each device
+     * (switch) known by ONOS, and every time a new device-added event is
+     * captured by the InternalDeviceListener defined below.
+     *
+     * @param deviceId device ID where to install the rules
+     */
+    private void insertUnmatchedBridgingFlowRule(DeviceId deviceId) {
+
+        log.info("Adding L2 multicast rules on {}...", deviceId);
+
+        // *** TODO EXERCISE 5 EXTRA CREDIT
+        // Modify P4Runtime entity names to match content of P4Info file (look
+        // for the fully qualified name of tables, match fields, and actions.
+        // ---- START SOLUTION ----
+
+        // Match unmatched traffic - Match ternary **:**:**:**:**:**
+        final PiCriterion unmatchedTrafficCriterion = PiCriterion.builder()
+                .matchTernary(
+                        PiMatchFieldId.of("MODIFY ME"),
+                        MacAddress.valueOf("MODIFY ME").toBytes(),
+                        MacAddress.valueOf("MODIFY ME").toBytes())
+                .build();
+
+        // Action: set multicast group id
+        final PiAction setMcastGroupAction = PiAction.builder()
+                .withId(PiActionId.of("MODIFY ME"))
+                .withParameter(new PiActionParam(
+                        PiActionParamId.of("MODIFY ME"),
+                        DEFAULT_BROADCAST_GROUP_ID))
+                .build();
+
+        //  Build flow rule.
+        final String tableId = "MODIFY ME";
+        // ---- END SOLUTION ----
+
+        final FlowRule rule = Utils.buildFlowRule(
+                deviceId, appId, tableId,
+                unmatchedTrafficCriterion, setMcastGroupAction);
+
+        // Insert rules.
+        flowRuleService.applyFlowRules(rule);
+    }
+
     /**
      * Insert flow rules to forward packets to a given host located at the given
      * device and port.

solution/app/src/main/java/org/onosproject/ngsdn/tutorial/AppConstants.java

@@ -24,6 +24,7 @@ public class AppConstants {
     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 FALLBACK_FLOW_RULE_PRIORITY = 5;
     public static final int INITIAL_SETUP_DELAY = 2; // Seconds.
     public static final int CLEAN_UP_DELAY = 2000; // milliseconds
     public static final int DEFAULT_CLEAN_UP_RETRY_TIMES = 10;

solution/app/src/main/java/org/onosproject/ngsdn/tutorial/L2BridgingComponent.java

@@ -154,6 +154,9 @@ private void setUpDevice(DeviceId deviceId) {
         }
         insertMulticastGroup(deviceId);
         insertMulticastFlowRules(deviceId);
+        // *** TODO EXERCISE 5 EXTRA CREDIT
+        // Uncomment the following line after you have implemented the method:
+        insertUnmatchedBridgingFlowRule(deviceId);
     }
 
     /**
@@ -247,6 +250,54 @@ private void insertMulticastFlowRules(DeviceId deviceId) {
         flowRuleService.applyFlowRules(rule1, rule2);
     }
 
+    /**
+     * Insert flow rule that matches all unmatched ethernet traffic. This
+     * will implement the traditional briding behavior that floods all
+     * unmatched traffic.
+     * <p>
+     * This method will be called at component activation for each device
+     * (switch) known by ONOS, and every time a new device-added event is
+     * captured by the InternalDeviceListener defined below.
+     *
+     * @param deviceId device ID where to install the rules
+     */
+    private void insertUnmatchedBridgingFlowRule(DeviceId deviceId) {
+
+        log.info("Adding L2 multicast rules on {}...", deviceId);
+
+        // *** TODO EXERCISE 5 EXTRA CREDIT
+        // Modify P4Runtime entity names to match content of P4Info file (look
+        // for the fully qualified name of tables, match fields, and actions.
+        // ---- START SOLUTION ----
+
+        // Match unmatched traffic - Match ternary **:**:**:**:**:**
+        final PiCriterion unmatchedTrafficCriterion = PiCriterion.builder()
+                .matchTernary(
+                    PiMatchFieldId.of("hdr.ethernet.dst_addr"),
+                    MacAddress.valueOf("00:00:00:00:00:00").toBytes(),
+                    MacAddress.valueOf("00:00:00:00:00:00").toBytes())
+            .build();
+
+        // Action: set multicast group id
+        final PiAction setMcastGroupAction = PiAction.builder()
+                .withId(PiActionId.of("IngressPipeImpl.set_multicast_group"))
+                .withParameter(new PiActionParam(
+                        PiActionParamId.of("gid"),
+                        DEFAULT_BROADCAST_GROUP_ID))
+                .build();
+
+        //  Build flow rule.
+        final String tableId = "IngressPipeImpl.l2_ternary_table";
+        // ---- END SOLUTION ----
+
+        final FlowRule rule = Utils.buildFlowRule(
+                deviceId, appId, tableId,
+                unmatchedTrafficCriterion, setMcastGroupAction);
+
+        // Insert rules.
+        flowRuleService.applyFlowRules(rule);
+    }
+
     /**
      * Insert flow rules to forward packets to a given host located at the given
      * device and port.