Add a new method sendMsg(OFMessage msg, TableType type) in OpenFlowSwitch interf…

…ace to support multiple-table aware FlowRuleService.
  Other changes are caused due to the new method.
Add type() in FlowRule interface to determine the table in which the flow rule need to be set.

Change-Id: I6518a01f4a5fba23f09f70b619f3844b5e33ce8f

@@ -40,6 +40,8 @@ public class DefaultFlowRule implements FlowRule {
     private final boolean permanent;
     private final boolean permanent;
     private final GroupId groupId;
     private final GroupId groupId;
 
 
+    private final Type type;
+
 
 
     public DefaultFlowRule(DeviceId deviceId, TrafficSelector selector,
     public DefaultFlowRule(DeviceId deviceId, TrafficSelector selector,
             TrafficTreatment treatment, int priority, long flowId,
             TrafficTreatment treatment, int priority, long flowId,
@@ -55,12 +57,42 @@ public class DefaultFlowRule implements FlowRule {
         this.appId = (short) (flowId >>> 48);
         this.appId = (short) (flowId >>> 48);
         this.groupId = new DefaultGroupId((short) ((flowId >>> 32) & 0xFFFF));
         this.groupId = new DefaultGroupId((short) ((flowId >>> 32) & 0xFFFF));
         this.id = FlowId.valueOf(flowId);
         this.id = FlowId.valueOf(flowId);
+        this.type = Type.DEFAULT;
     }
     }
 
 
     public DefaultFlowRule(DeviceId deviceId, TrafficSelector selector,
     public DefaultFlowRule(DeviceId deviceId, TrafficSelector selector,
                            TrafficTreatment treatment, int priority, ApplicationId appId,
                            TrafficTreatment treatment, int priority, ApplicationId appId,
                            int timeout, boolean permanent) {
                            int timeout, boolean permanent) {
-        this(deviceId, selector, treatment, priority, appId, new DefaultGroupId(0), timeout, permanent);
+        this(deviceId, selector, treatment, priority, appId, new DefaultGroupId(0),
+                timeout, permanent);
+    }
+
+    public DefaultFlowRule(DeviceId deviceId, TrafficSelector selector,
+                           TrafficTreatment treatment, int priority, ApplicationId appId,
+                           int timeout, boolean permanent, Type type) {
+
+        if (priority < FlowRule.MIN_PRIORITY) {
+            throw new IllegalArgumentException("Priority cannot be less than " + MIN_PRIORITY);
+        }
+
+        this.deviceId = deviceId;
+        this.priority = priority;
+        this.selector = selector;
+        this.treatment = treatment;
+        this.appId = appId.id();
+        this.groupId = new DefaultGroupId(0);
+        this.timeout = timeout;
+        this.permanent = permanent;
+        this.created = System.currentTimeMillis();
+        this.type = type;
+
+        /*
+         * id consists of the following.
+         * | appId (16 bits) | groupId (16 bits) | flowId (32 bits) |
+         */
+        this.id = FlowId.valueOf((((long) this.appId) << 48) | (((long) this.groupId.id()) << 32)
+                | (this.hash() & 0xffffffffL));
+
     }
     }
 
 
     public DefaultFlowRule(DeviceId deviceId, TrafficSelector selector,
     public DefaultFlowRule(DeviceId deviceId, TrafficSelector selector,
@@ -80,6 +112,7 @@ public class DefaultFlowRule implements FlowRule {
         this.timeout = timeout;
         this.timeout = timeout;
         this.permanent = permanent;
         this.permanent = permanent;
         this.created = System.currentTimeMillis();
         this.created = System.currentTimeMillis();
+        this.type = Type.DEFAULT;
 
 
         /*
         /*
          * id consists of the following.
          * id consists of the following.
@@ -100,10 +133,10 @@ public class DefaultFlowRule implements FlowRule {
         this.timeout = rule.timeout();
         this.timeout = rule.timeout();
         this.permanent = rule.isPermanent();
         this.permanent = rule.isPermanent();
         this.created = System.currentTimeMillis();
         this.created = System.currentTimeMillis();
+        this.type = rule.type();
 
 
     }
     }
 
 
-
     @Override
     @Override
     public FlowId id() {
     public FlowId id() {
         return id;
         return id;
@@ -198,4 +231,9 @@ public class DefaultFlowRule implements FlowRule {
         return permanent;
         return permanent;
     }
     }
 
 
+    @Override
+    public Type type() {
+        return type;
+    }
+
 }
 }

@@ -27,6 +27,22 @@ public interface FlowRule {
     static final int MAX_TIMEOUT = 60;
     static final int MAX_TIMEOUT = 60;
     static final int MIN_PRIORITY = 0;
     static final int MIN_PRIORITY = 0;
 
 
+    /**
+     * The FlowRule type is used to determine in which table the flow rule
+     * needs to be put for multi-table support switch.
+     * For single table switch, Default is used.
+     */
+    public static enum Type {
+        /* Default type - used in flow rule for single table switch */
+        DEFAULT,
+        /* Used in flow entry for IP table */
+        IP,
+        /* Used in flow entry for MPLS table */
+        MPLS,
+        /* Used in flow entry for ACL table */
+        ACL
+    }
+
     //TODO: build cookie value
     //TODO: build cookie value
     /**
     /**
      * Returns the ID of this flow.
      * Returns the ID of this flow.
@@ -93,4 +109,11 @@ public interface FlowRule {
      */
      */
     boolean isPermanent();
     boolean isPermanent();
 
 
+    /**
+     * Returns the flow rule type.
+     *
+     * @return flow rule type
+     */
+    Type type();
+
 }
 }

@@ -296,8 +296,11 @@ public class IntentTestsMocks {
     public static class MockFlowRule implements FlowRule {
     public static class MockFlowRule implements FlowRule {
 
 
         int priority;
         int priority;
+        Type type;
+
         public MockFlowRule(int priority) {
         public MockFlowRule(int priority) {
             this.priority = priority;
             this.priority = priority;
+            this.type = Type.DEFAULT;
         }
         }
 
 
         @Override
         @Override
@@ -361,6 +364,11 @@ public class IntentTestsMocks {
             final MockFlowRule other = (MockFlowRule) obj;
             final MockFlowRule other = (MockFlowRule) obj;
             return Objects.equals(this.priority, other.priority);
             return Objects.equals(this.priority, other.priority);
         }
         }
+
+        @Override
+        public Type type() {
+            return type;
+        }
     }
     }
 
 
 
 

@@ -53,6 +53,7 @@ import org.onosproject.net.PortNumber;
 import org.onosproject.net.device.DefaultDeviceDescription;
 import org.onosproject.net.device.DefaultDeviceDescription;
 import org.onosproject.net.device.DefaultPortDescription;
 import org.onosproject.net.device.DefaultPortDescription;
 import org.onosproject.net.flow.CompletedBatchOperation;
 import org.onosproject.net.flow.CompletedBatchOperation;
+import org.onosproject.net.flow.FlowRule;
 import org.onosproject.net.flow.DefaultFlowEntry;
 import org.onosproject.net.flow.DefaultFlowEntry;
 import org.onosproject.net.flow.DefaultFlowRule;
 import org.onosproject.net.flow.DefaultFlowRule;
 import org.onosproject.net.flow.DefaultTrafficSelector;
 import org.onosproject.net.flow.DefaultTrafficSelector;
@@ -214,6 +215,7 @@ public final class KryoNamespaces {
                     DefaultHostDescription.class,
                     DefaultHostDescription.class,
                     DefaultFlowEntry.class,
                     DefaultFlowEntry.class,
                     StoredFlowEntry.class,
                     StoredFlowEntry.class,
+                    FlowRule.Type.class,
                     DefaultFlowRule.class,
                     DefaultFlowRule.class,
                     DefaultFlowEntry.class,
                     DefaultFlowEntry.class,
                     FlowEntry.FlowEntryState.class,
                     FlowEntry.FlowEntryState.class,

@@ -27,6 +27,22 @@ import org.projectfloodlight.openflow.protocol.OFPortDesc;
 public interface OpenFlowSwitch {
 public interface OpenFlowSwitch {
 
 
     /**
     /**
+     * The TableType is used to determine in which table (TableID) each flow rule
+     * needs to be put for multi-table support switch.
+     * It is used only for multi-table support switch.
+     */
+    public static enum TableType {
+        /* IP table */
+        IP,
+        /* MPLS table */
+        MPLS,
+        /* ACL table */
+        ACL,
+        /* Single table */
+        NONE,
+    }
+
+    /**
      * Writes the message to the driver.
      * Writes the message to the driver.
      *
      *
      * @param msg the message to write
      * @param msg the message to write
@@ -41,6 +57,16 @@ public interface OpenFlowSwitch {
     public void sendMsg(List<OFMessage> msgs);
     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.
+     *
+     * @param msg the message to be written
+     * @param tableType the type of table in which the OFMessage needs to put
+     */
+    public void sendMsg(OFMessage msg, TableType tableType);
+
+    /**
      * Handle a message from the switch.
      * Handle a message from the switch.
      * @param fromSwitch the message to handle
      * @param fromSwitch the message to handle
      */
      */

@@ -110,6 +110,13 @@ public abstract class AbstractOpenFlowSwitch implements OpenFlowSwitchDriver {
     }
     }
 
 
     @Override
     @Override
+    public void sendMsg(OFMessage msg, TableType tableType) {
+        if (role == RoleState.MASTER) {
+            this.write(msg);
+        }
+    }
+
+    @Override
     public abstract void write(OFMessage msg);
     public abstract void write(OFMessage msg);
 
 
     @Override
     @Override

@@ -111,6 +111,10 @@ public class RoleManagerTest {
         }
         }
 
 
         @Override
         @Override
+        public void sendMsg(OFMessage msg, TableType tableType) {
+        }
+
+        @Override
         public void handleMessage(OFMessage fromSwitch) {
         public void handleMessage(OFMessage fromSwitch) {
         }
         }
 
 

@@ -669,7 +669,6 @@ public class OFSwitchImplCPqD13 extends AbstractOpenFlowSwitch {
         }
         }
         return subnetIps;
         return subnetIps;
     }
     }
-
     private static class RouteEntry {
     private static class RouteEntry {
         String prefix;
         String prefix;
         String mask;
         String mask;

+/*
+ * Copyright 2015 Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.onosproject.openflow.drivers;
+
+import org.onosproject.openflow.controller.Dpid;
+import org.onosproject.openflow.controller.driver.AbstractOpenFlowSwitch;
+import org.projectfloodlight.openflow.protocol.OFMessage;
+
+import java.util.List;
+
+/**
+ * Created by sanghoshin on 1/22/15.
+ */
+public class OFSwitchImplSpringOpenTTP extends AbstractOpenFlowSwitch {
+
+    protected OFSwitchImplSpringOpenTTP(Dpid dp) {
+        super(dp);
+    }
+
+    @Override
+    public void write(OFMessage msg) {
+
+    }
+
+    @Override
+    public void write(List<OFMessage> msgs) {
+
+    }
+
+    @Override
+    public Boolean supportNxRole() {
+        return null;
+    }
+
+    @Override
+    public void startDriverHandshake() {
+
+    }
+
+    @Override
+    public boolean isDriverHandshakeComplete() {
+        return false;
+    }
+
+    @Override
+    public void processDriverHandshakeMessage(OFMessage m) {
+
+    }
+
+}

@@ -310,6 +310,10 @@ public class OpenFlowDeviceProviderTest {
         }
         }
 
 
         @Override
         @Override
+        public void sendMsg(OFMessage msg, TableType tableType) {
+        }
+
+        @Override
         public void handleMessage(OFMessage fromSwitch) {
         public void handleMessage(OFMessage fromSwitch) {
         }
         }
 
 

@@ -414,6 +414,10 @@ public class OpenFlowLinkProviderTest {
         }
         }
 
 
         @Override
         @Override
+        public void sendMsg(OFMessage msg, TableType tableType) {
+        }
+
+        @Override
         public void handleMessage(OFMessage fromSwitch) {
         public void handleMessage(OFMessage fromSwitch) {
         }
         }
 
 

@@ -347,6 +347,10 @@ public class OpenFlowPacketProviderTest {
         }
         }
 
 
         @Override
         @Override
+        public void sendMsg(OFMessage msg, TableType tableType) {
+        }
+
+        @Override
         public void handleMessage(OFMessage fromSwitch) {
         public void handleMessage(OFMessage fromSwitch) {
         }
         }
 
 

@@ -186,6 +186,10 @@ public class FlowsResourceTest extends ResourceTest {
         public boolean isPermanent() {
         public boolean isPermanent() {
             return false;
             return false;
         }
         }
+
+        public Type type() {
+            return Type.DEFAULT;
+        }
     }
     }
 
 
     /**
     /**