A set of fixes to ensure that the FlowRuleManager can correctly account for flows
from the dataplane in a multi-table pipeline scenario

Change-Id: I9ca3ef9a77781f126a13538647c824b27f77101c
diff --git a/openflow/api/src/main/java/org/onosproject/openflow/controller/OpenFlowSwitch.java b/openflow/api/src/main/java/org/onosproject/openflow/controller/OpenFlowSwitch.java
index a400b8e..fd2316d 100644
--- a/openflow/api/src/main/java/org/onosproject/openflow/controller/OpenFlowSwitch.java
+++ b/openflow/api/src/main/java/org/onosproject/openflow/controller/OpenFlowSwitch.java
@@ -20,6 +20,7 @@
 import org.projectfloodlight.openflow.protocol.OFFactory;
 import org.projectfloodlight.openflow.protocol.OFMessage;
 import org.projectfloodlight.openflow.protocol.OFPortDesc;
+import org.projectfloodlight.openflow.types.TableId;
 
 /**
  * Represents to provider facing side of a switch.
@@ -38,7 +39,7 @@
         /* VLAN table */
         VLAN,
 
-        /* L2 table */
+        /* Ethertype table */
         ETHER,
 
         /* Class of Service table */
@@ -52,6 +53,8 @@
         ACL,
         /* Single table */
         NONE,
+        /* First table in multi-table */
+        FIRST,
 
 
     }
@@ -64,21 +67,22 @@
     public void sendMsg(OFMessage msg);
 
     /**
-     * Writes to the OFMessage list to the driver.
+     * Writes the OFMessage list to the driver.
      *
      * @param msgs the messages to be written
      */
     public void sendMsg(List<OFMessage> msgs);
 
     /**
-     * Writes to the OFMessage list to the driver.
-     * TableType is used to determine the table ID for the OFMessage.
-     * The switch driver that supports multi-table should implement the function.
+     * Transforms FlowMod messages by setting the correct table-ids and sending
+     * them to the switch. TableType is used to determine the table ID for the OFMessage.
+     * Switch drivers that supports multi-table pipelines should implement this
+     * method.
      *
      * @param msg the message to be written
-     * @param tableType the type of table in which the OFMessage needs to put
+     * @param tableType the type of table in which the FlowMods need to be inserted
      */
-    public void sendMsg(OFMessage msg, TableType tableType);
+    public void transformAndSendMsg(OFMessage msg, TableType tableType);
 
     /**
      * Handle a message from the switch.
@@ -189,4 +193,11 @@
      */
     public String channelId();
 
+    /**
+     * Returns the TableType corresponding to the TableId used to identify
+     * a table in an OpenFlow switch.
+     * @param tid identifies a table in an OpenFlow switch using TableId
+     * @return TableType corresponding to 'tid' identifying the type of table
+     */
+    public TableType getTableType(TableId tid);
 }
diff --git a/openflow/api/src/main/java/org/onosproject/openflow/controller/driver/AbstractOpenFlowSwitch.java b/openflow/api/src/main/java/org/onosproject/openflow/controller/driver/AbstractOpenFlowSwitch.java
index 555c37d..b4a3c29 100644
--- a/openflow/api/src/main/java/org/onosproject/openflow/controller/driver/AbstractOpenFlowSwitch.java
+++ b/openflow/api/src/main/java/org/onosproject/openflow/controller/driver/AbstractOpenFlowSwitch.java
@@ -110,13 +110,6 @@
     }
 
     @Override
-    public void sendMsg(OFMessage msg, TableType tableType) {
-        if (role == RoleState.MASTER) {
-            this.write(msg);
-        }
-    }
-
-    @Override
     public abstract void write(OFMessage msg);
 
     @Override
diff --git a/openflow/ctl/src/test/java/org/onosproject/openflow/controller/impl/RoleManagerTest.java b/openflow/ctl/src/test/java/org/onosproject/openflow/controller/impl/RoleManagerTest.java
index 5d3d827..1d7b3ab 100644
--- a/openflow/ctl/src/test/java/org/onosproject/openflow/controller/impl/RoleManagerTest.java
+++ b/openflow/ctl/src/test/java/org/onosproject/openflow/controller/impl/RoleManagerTest.java
@@ -23,6 +23,7 @@
 import org.junit.Before;
 import org.junit.Test;
 import org.onosproject.openflow.controller.RoleState;
+import org.onosproject.openflow.controller.OpenFlowSwitch.TableType;
 import org.onosproject.openflow.controller.driver.OpenFlowAgent;
 import org.onosproject.openflow.controller.driver.OpenFlowSwitchDriver;
 import org.onosproject.openflow.controller.driver.RoleHandler;
@@ -38,6 +39,7 @@
 import org.projectfloodlight.openflow.protocol.OFPortDesc;
 import org.projectfloodlight.openflow.protocol.OFPortDescStatsReply;
 import org.projectfloodlight.openflow.protocol.OFVersion;
+import org.projectfloodlight.openflow.types.TableId;
 import org.projectfloodlight.openflow.types.U64;
 
 import static org.junit.Assert.assertEquals;
@@ -111,7 +113,7 @@
         }
 
         @Override
-        public void sendMsg(OFMessage msg, TableType tableType) {
+        public void transformAndSendMsg(OFMessage msg, TableType tableType) {
         }
 
         @Override
@@ -309,6 +311,10 @@
             return "1.2.3.4:1";
         }
 
+        @Override
+        public TableType getTableType(TableId tid) {
+            return TableType.NONE;
+        }
 
     }
 }
diff --git a/openflow/drivers/src/main/java/org/onosproject/openflow/drivers/DriverManager.java b/openflow/drivers/src/main/java/org/onosproject/openflow/drivers/DriverManager.java
index 1307f4a..079d3ee 100644
--- a/openflow/drivers/src/main/java/org/onosproject/openflow/drivers/DriverManager.java
+++ b/openflow/drivers/src/main/java/org/onosproject/openflow/drivers/DriverManager.java
@@ -29,6 +29,7 @@
 import org.projectfloodlight.openflow.protocol.OFMessage;
 import org.projectfloodlight.openflow.protocol.OFPortDesc;
 import org.projectfloodlight.openflow.protocol.OFVersion;
+import org.projectfloodlight.openflow.types.TableId;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -125,6 +126,17 @@
                     return Collections.unmodifiableList(ports.getEntries());
                 }
             }
+
+            @Override
+            public TableType getTableType(TableId tid) {
+                return TableType.NONE;
+            }
+
+            @Override
+            public void transformAndSendMsg(OFMessage msg, TableType tableType) {
+                // TODO Auto-generated method stub
+
+            }
         };
     }
 
diff --git a/openflow/drivers/src/main/java/org/onosproject/openflow/drivers/OFCorsaSwitchDriver.java b/openflow/drivers/src/main/java/org/onosproject/openflow/drivers/OFCorsaSwitchDriver.java
index 6009420..75bb9d4 100644
--- a/openflow/drivers/src/main/java/org/onosproject/openflow/drivers/OFCorsaSwitchDriver.java
+++ b/openflow/drivers/src/main/java/org/onosproject/openflow/drivers/OFCorsaSwitchDriver.java
@@ -16,6 +16,7 @@
 package org.onosproject.openflow.drivers;
 
 import com.google.common.collect.Lists;
+
 import org.onosproject.openflow.controller.Dpid;
 import org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch;
 import org.projectfloodlight.openflow.protocol.OFDescStatsReply;
@@ -26,6 +27,7 @@
 import org.projectfloodlight.openflow.protocol.instruction.OFInstructionGotoTable;
 import org.projectfloodlight.openflow.types.TableId;
 
+import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
 
@@ -33,7 +35,7 @@
  * Corsa switch driver for BGP Router deployment.
  */
 public class OFCorsaSwitchDriver extends AbstractOpenFlowSwitch {
-
+    private static final int FIRST_TABLE = 0;
     private static final int VLAN_MPLS_TABLE = 1;
     private static final int VLAN_TABLE = 2;
     private static final int MPLS_TABLE = 3;
@@ -48,18 +50,45 @@
         setSwitchDescription(desc);
     }
 
+    /**
+     * Used by the default sendMsg to 'write' to the switch.
+     * This method is indirectly used by generic onos services like proxyarp
+     * to request packets from the default flow table. In a multi-table
+     * pipeline, these requests are redirected to the correct table.
+     *
+     * For the Corsa switch, the equivalent table is the LOCAL TABLE
+     *
+     */
     @Override
     public void write(OFMessage msg) {
-        this.write(Collections.singletonList(msg));
+        if (msg.getType() == OFType.FLOW_MOD) {
+            OFFlowMod flowMod = (OFFlowMod) msg;
+            OFFlowMod.Builder builder = flowMod.createBuilder();
+            builder.setTableId(TableId.of(LOCAL_TABLE));
+            channel.write(Collections.singletonList(builder.build()));
+        } else {
+            channel.write(Collections.singletonList(msg));
+        }
     }
 
     @Override
     public void write(List<OFMessage> msgs) {
-        channel.write(msgs);
+        List<OFMessage> newMsgs = new ArrayList<OFMessage>();
+        for (OFMessage msg : msgs) {
+            if (msg.getType() == OFType.FLOW_MOD) {
+                OFFlowMod flowMod = (OFFlowMod) msg;
+                OFFlowMod.Builder builder = flowMod.createBuilder();
+                builder.setTableId(TableId.of(LOCAL_TABLE));
+                newMsgs.add(builder.build());
+            } else {
+                newMsgs.add(msg);
+            }
+        }
+        channel.write(newMsgs);
     }
 
     @Override
-    public void sendMsg(OFMessage msg, TableType type) {
+    public void transformAndSendMsg(OFMessage msg, TableType type) {
         if (msg.getType() == OFType.FLOW_MOD) {
             OFFlowMod flowMod = (OFFlowMod) msg;
             OFFlowMod.Builder builder = flowMod.createBuilder();
@@ -142,19 +171,47 @@
                 case ACL:
                     builder.setTableId(TableId.of(LOCAL_TABLE));
                     break;
+                case FIRST:
+                    builder.setTableId(TableId.of(FIRST_TABLE));
+                    break;
                 case NONE:
-                    builder.setTableId(TableId.of(0));
+                    builder.setTableId(TableId.of(LOCAL_TABLE));
                     break;
                 default:
                     log.warn("Unknown table type: {}", type);
             }
             builder.setInstructions(newInstructions);
             OFMessage msgnew = builder.build();
-            this.write(msgnew);
+            channel.write(Collections.singletonList(msgnew));
             log.debug("Installed {}", msgnew);
 
         } else {
-            this.write(msg);
+            channel.write(Collections.singletonList(msg));
+        }
+    }
+
+    @Override
+    public TableType getTableType(TableId tid) {
+        switch (tid.getValue()) {
+        case VLAN_MPLS_TABLE:
+            return TableType.VLAN_MPLS;
+        case VLAN_TABLE:
+            return TableType.VLAN;
+        case ETHER_TABLE:
+            return TableType.ETHER;
+        case COS_MAP_TABLE:
+            return TableType.COS;
+        case FIB_TABLE:
+            return TableType.IP;
+        case MPLS_TABLE:
+            return TableType.MPLS;
+        case LOCAL_TABLE:
+            return TableType.NONE;
+        case FIRST_TABLE:
+            return TableType.FIRST;
+        default:
+            log.warn("Unknown table type: {}", tid.getValue());
+            return TableType.NONE;
         }
     }
 
diff --git a/openflow/drivers/src/main/java/org/onosproject/openflow/drivers/OFOpticalSwitchImplLINC13.java b/openflow/drivers/src/main/java/org/onosproject/openflow/drivers/OFOpticalSwitchImplLINC13.java
index 5663c48..1a45774 100644
--- a/openflow/drivers/src/main/java/org/onosproject/openflow/drivers/OFOpticalSwitchImplLINC13.java
+++ b/openflow/drivers/src/main/java/org/onosproject/openflow/drivers/OFOpticalSwitchImplLINC13.java
@@ -30,6 +30,7 @@
 import org.projectfloodlight.openflow.protocol.OFPortOptical;
 import org.projectfloodlight.openflow.protocol.OFStatsReply;
 import org.projectfloodlight.openflow.protocol.OFStatsType;
+import org.projectfloodlight.openflow.types.TableId;
 
 import java.io.IOException;
 import java.util.ArrayList;
@@ -209,5 +210,15 @@
         return true;
     }
 
+    @Override
+    public TableType getTableType(TableId tid) {
+        return TableType.NONE;
+    }
+
+    @Override
+    public void transformAndSendMsg(OFMessage msg, TableType tableType) {
+        // TODO Auto-generated method stub
+
+    }
 
 }
diff --git a/openflow/drivers/src/main/java/org/onosproject/openflow/drivers/OFSwitchImplCPqD13.java b/openflow/drivers/src/main/java/org/onosproject/openflow/drivers/OFSwitchImplCPqD13.java
index 9b68fa8..3fea81c 100644
--- a/openflow/drivers/src/main/java/org/onosproject/openflow/drivers/OFSwitchImplCPqD13.java
+++ b/openflow/drivers/src/main/java/org/onosproject/openflow/drivers/OFSwitchImplCPqD13.java
@@ -25,6 +25,7 @@
 
 import org.onosproject.openflow.controller.Dpid;
 import org.onosproject.openflow.controller.RoleState;
+import org.onosproject.openflow.controller.OpenFlowSwitch.TableType;
 import org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch;
 import org.onosproject.openflow.controller.driver.SwitchDriverSubHandshakeAlreadyStarted;
 import org.onosproject.openflow.controller.driver.SwitchDriverSubHandshakeCompleted;
@@ -1216,4 +1217,15 @@
         this.channel.write(msgs);
     }
 
+
+    @Override
+    public TableType getTableType(TableId tid) {
+        return TableType.NONE; // XXX this needs to be fixed
+    }
+
+    @Override
+    public void transformAndSendMsg(OFMessage msg, TableType tableType) {
+        // TODO Auto-generated method stub
+
+    }
 }
diff --git a/openflow/drivers/src/main/java/org/onosproject/openflow/drivers/OFSwitchImplOVS10.java b/openflow/drivers/src/main/java/org/onosproject/openflow/drivers/OFSwitchImplOVS10.java
index a017abe..bdf719e 100644
--- a/openflow/drivers/src/main/java/org/onosproject/openflow/drivers/OFSwitchImplOVS10.java
+++ b/openflow/drivers/src/main/java/org/onosproject/openflow/drivers/OFSwitchImplOVS10.java
@@ -24,6 +24,7 @@
 import org.projectfloodlight.openflow.protocol.OFFlowAdd;
 import org.projectfloodlight.openflow.protocol.OFMessage;
 import org.projectfloodlight.openflow.protocol.OFPortDesc;
+import org.projectfloodlight.openflow.types.TableId;
 
 /**
  * OFDescriptionStatistics Vendor (Manufacturer Desc.): Nicira, Inc. Make
@@ -85,5 +86,15 @@
         return Collections.unmodifiableList(features.getPorts());
     }
 
+    @Override
+    public TableType getTableType(TableId tid) {
+        return TableType.NONE;
+    }
+
+    @Override
+    public void transformAndSendMsg(OFMessage msg, TableType tableType) {
+        // TODO Auto-generated method stub
+
+    }
 
 }
diff --git a/openflow/drivers/src/main/java/org/onosproject/openflow/drivers/OFSwitchImplOVS13.java b/openflow/drivers/src/main/java/org/onosproject/openflow/drivers/OFSwitchImplOVS13.java
index 1b267d3..a4ec0a1 100644
--- a/openflow/drivers/src/main/java/org/onosproject/openflow/drivers/OFSwitchImplOVS13.java
+++ b/openflow/drivers/src/main/java/org/onosproject/openflow/drivers/OFSwitchImplOVS13.java
@@ -237,4 +237,15 @@
         write(tableMissEntry);
     }
 
+    @Override
+    public TableType getTableType(TableId tid) {
+        return TableType.NONE;
+    }
+
+    @Override
+    public void transformAndSendMsg(OFMessage msg, TableType tableType) {
+        // TODO Auto-generated method stub
+
+    }
+
 }
diff --git a/openflow/drivers/src/main/java/org/onosproject/openflow/drivers/OFSwitchImplSpringOpenTTP.java b/openflow/drivers/src/main/java/org/onosproject/openflow/drivers/OFSwitchImplSpringOpenTTP.java
index cd6bfef..963529c 100644
--- a/openflow/drivers/src/main/java/org/onosproject/openflow/drivers/OFSwitchImplSpringOpenTTP.java
+++ b/openflow/drivers/src/main/java/org/onosproject/openflow/drivers/OFSwitchImplSpringOpenTTP.java
@@ -17,6 +17,7 @@
 
 import org.onosproject.openflow.controller.Dpid;
 import org.onosproject.openflow.controller.RoleState;
+import org.onosproject.openflow.controller.OpenFlowSwitch.TableType;
 import org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch;
 import org.onosproject.openflow.controller.driver.SwitchDriverSubHandshakeAlreadyStarted;
 import org.onosproject.openflow.controller.driver.SwitchDriverSubHandshakeCompleted;
@@ -167,7 +168,7 @@
     }
 
     @Override
-    public void sendMsg(OFMessage m, TableType tableType) {
+    public void transformAndSendMsg(OFMessage m, TableType tableType) {
 
         if (m.getType() == OFType.FLOW_MOD) {
             OFFlowMod flowMod = (OFFlowMod) m;
@@ -571,4 +572,10 @@
                 .build();
         write(br);
     }
+
+    @Override
+    public TableType getTableType(TableId tid) {
+        return TableType.NONE; // XXX this needs to be fixed
+    }
+
 }