openstack/net-virt-providers/src/main/java/org/opendaylight/ovsdb/openstack/netvirt/providers/openflow13/OF13Provider.java

   1 /*
   2  * Copyright (c) 2013, 2015 Red Hat, Inc. and others. All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.ovsdb.openstack.netvirt.providers.openflow13;
  10
  11 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  12 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  13 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
  14 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  15 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  16 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  17 import org.opendaylight.neutron.spi.NeutronNetwork;
  18 import org.opendaylight.neutron.spi.NeutronPort;
  19 import org.opendaylight.neutron.spi.Neutron_IPs;
  20 import org.opendaylight.ovsdb.openstack.netvirt.MdsalHelper;
  21 import org.opendaylight.ovsdb.openstack.netvirt.NetworkHandler;
  22 import org.opendaylight.ovsdb.openstack.netvirt.api.BridgeConfigurationManager;
  23 import org.opendaylight.ovsdb.openstack.netvirt.api.ClassifierProvider;
  24 import org.opendaylight.ovsdb.openstack.netvirt.api.ConfigurationService;
  25 import org.opendaylight.ovsdb.openstack.netvirt.api.Constants;
  26 import org.opendaylight.ovsdb.openstack.netvirt.api.EgressAclProvider;
  27 import org.opendaylight.ovsdb.openstack.netvirt.api.IngressAclProvider;
  28 import org.opendaylight.ovsdb.openstack.netvirt.api.L2ForwardingProvider;
  29 import org.opendaylight.ovsdb.openstack.netvirt.api.NetworkingProvider;
  30 import org.opendaylight.ovsdb.openstack.netvirt.api.NetworkingProviderManager;
  31 import org.opendaylight.ovsdb.openstack.netvirt.api.NodeCacheManager;
  32 import org.opendaylight.ovsdb.openstack.netvirt.api.SecurityServicesManager;
  33 import org.opendaylight.ovsdb.openstack.netvirt.api.Southbound;
  34 import org.opendaylight.ovsdb.openstack.netvirt.api.Status;
  35 import org.opendaylight.ovsdb.openstack.netvirt.api.StatusCode;
  36 import org.opendaylight.ovsdb.openstack.netvirt.api.TenantNetworkManager;
  37 import org.opendaylight.ovsdb.openstack.netvirt.providers.ConfigInterface;
  38 import org.opendaylight.ovsdb.openstack.netvirt.providers.NetvirtProvidersProvider;
  39 import org.opendaylight.ovsdb.utils.mdsal.openflow.InstructionUtils;
  40 import org.opendaylight.ovsdb.utils.servicehelper.ServiceHelper;
  41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Uri;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.GroupActionCase;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.GroupActionCaseBuilder;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.OutputActionCase;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.OutputActionCaseBuilder;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.group.action._case.GroupActionBuilder;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.output.action._case.OutputActionBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.ActionBuilder;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.ActionKey;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.Table;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.TableKey;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowBuilder;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowKey;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.InstructionsBuilder;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.MatchBuilder;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.ApplyActionsCase;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.ApplyActionsCaseBuilder;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.apply.actions._case.ApplyActionsBuilder;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.InstructionBuilder;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.InstructionKey;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.BucketId;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.GroupId;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.GroupTypes;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.Buckets;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.BucketsBuilder;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.buckets.Bucket;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.buckets.BucketBuilder;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.group.buckets.BucketKey;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.Group;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.GroupBuilder;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.groups.GroupKey;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbTerminationPointAugmentation;
  81 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeBuilder;
  83 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  84 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  85 import org.osgi.framework.BundleContext;
  86 import org.osgi.framework.ServiceReference;
  87 import org.slf4j.Logger;
  88 import org.slf4j.LoggerFactory;
  89
  90 import com.google.common.base.Optional;
  91 import com.google.common.base.Preconditions;
  92 import com.google.common.collect.Lists;
  93 import com.google.common.collect.Maps;
  94 import com.google.common.util.concurrent.CheckedFuture;
  95
  96 import java.net.InetAddress;
  97 import java.util.List;
  98 import java.util.Map;
  99 import java.util.concurrent.ExecutionException;
 100
 101
 102 /**
 103  * Open vSwitch OpenFlow 1.3 Networking Provider for OpenStack Neutron
 104  *
 105  * @author Madhu Venugopal
 106  * @author Brent Salisbury
 107  * @author Dave Tucker
 108  * @author Sam Hague
 109  */
 110 // Methods' parameters in this class follow the same pattern to avoid confusion between same-typed parameters
 111 // The patterns need to be preserved even though not all parameters are used in all methods
 112 @SuppressWarnings("UnusedParameters")
 113 public class OF13Provider implements ConfigInterface, NetworkingProvider {
 114     private static final Logger LOG = LoggerFactory.getLogger(OF13Provider.class);
 115     private static final short TABLE_0_DEFAULT_INGRESS = 0;
 116     private static final short TABLE_1_ISOLATE_TENANT = 10;
 117     private static final short TABLE_2_LOCAL_FORWARD = 20;
 118     private static Long groupId = 1L;
 119     private DataBroker dataBroker = null;
 120
 121     private volatile ConfigurationService configurationService;
 122     private volatile BridgeConfigurationManager bridgeConfigurationManager;
 123     private volatile TenantNetworkManager tenantNetworkManager;
 124     private volatile SecurityServicesManager securityServicesManager;
 125     private volatile ClassifierProvider classifierProvider;
 126     private volatile IngressAclProvider ingressAclProvider;
 127     private volatile EgressAclProvider egressAclProvider;
 128     private volatile NodeCacheManager nodeCacheManager;
 129     private volatile L2ForwardingProvider l2ForwardingProvider;
 130
 131     public static final String NAME = "OF13Provider";
 132     private volatile BundleContext bundleContext;
 133     private volatile Southbound southbound;
 134
 135     public OF13Provider() {
 136         this.dataBroker = NetvirtProvidersProvider.getDataBroker();
 137     }
 138
 139     @Override
 140     public String getName() {
 141         return NAME;
 142     }
 143
 144     @Override
 145     public boolean supportsServices() {
 146         return true;
 147     }
 148
 149     @Override
 150     public boolean hasPerTenantTunneling() {
 151         return false;
 152     }
 153
 154     // The method is tested for in OF13ProviderTest
 155     @SuppressWarnings("unused")
 156     private Status getTunnelReadinessStatus (Node node, String tunnelKey) {
 157         InetAddress srcTunnelEndPoint = configurationService.getTunnelEndPoint(node);
 158         if (srcTunnelEndPoint == null) {
 159             LOG.error("Tunnel Endpoint not configured for Node {}", node);
 160             return new Status(StatusCode.NOTFOUND, "Tunnel Endpoint not configured for "+ node);
 161         }
 162
 163         if (!bridgeConfigurationManager.isNodeNeutronReady(node)) {
 164             LOG.error("{} is not Overlay ready", node);
 165             return new Status(StatusCode.NOTACCEPTABLE, node+" is not Overlay ready");
 166         }
 167
 168         if (!tenantNetworkManager.isTenantNetworkPresentInNode(node, tunnelKey)) {
 169             LOG.debug("{} has no VM corresponding to segment {}", node, tunnelKey);
 170             return new Status(StatusCode.NOTACCEPTABLE, node+" has no VM corresponding to segment "+ tunnelKey);
 171         }
 172         return new Status(StatusCode.SUCCESS);
 173     }
 174
 175     private String getTunnelName(String tunnelType, InetAddress dst) {
 176         return tunnelType+"-"+dst.getHostAddress();
 177     }
 178
 179     private boolean addTunnelPort (Node node, String tunnelType, InetAddress src, InetAddress dst) {
 180         String tunnelBridgeName = configurationService.getIntegrationBridgeName();
 181         String portName = getTunnelName(tunnelType, dst);
 182         LOG.info("addTunnelPort enter: portName: {}", portName);
 183         if (southbound.extractTerminationPointAugmentation(node, portName) != null
 184                 || southbound.isTunnelTerminationPointExist(node, tunnelBridgeName, portName)) {
 185             LOG.info("Tunnel {} is present in {} of {}", portName, tunnelBridgeName, node.getNodeId().getValue());
 186             return true;
 187         }
 188
 189         Map<String, String> options = Maps.newHashMap();
 190         options.put("key", "flow");
 191         options.put("local_ip", src.getHostAddress());
 192         options.put("remote_ip", dst.getHostAddress());
 193
 194         if (!southbound.addTunnelTerminationPoint(node, tunnelBridgeName, portName, tunnelType, options)) {
 195             LOG.error("Failed to insert Tunnel port {} in {}", portName, tunnelBridgeName);
 196             return false;
 197         }
 198
 199             LOG.info("addTunnelPort exit: portName: {}", portName);
 200         return true;
 201     }
 202
 203     /* delete port from ovsdb port table */
 204     private boolean deletePort(Node node, String bridgeName, String portName) {
 205         // TODO SB_MIGRATION
 206         // might need to convert from ovsdb node to bridge node
 207         return southbound.deleteTerminationPoint(node, portName);
 208     }
 209
 210     private boolean deleteTunnelPort(Node node, String tunnelType, InetAddress src, InetAddress dst) {
 211         String tunnelBridgeName = configurationService.getIntegrationBridgeName();
 212         String portName = getTunnelName(tunnelType, dst);
 213         return deletePort(node, tunnelBridgeName, portName);
 214     }
 215
 216     private boolean deletePhysicalPort(Node node, String phyIntfName) {
 217         String intBridgeName = configurationService.getIntegrationBridgeName();
 218         return deletePort(node, intBridgeName, phyIntfName);
 219     }
 220
 221     private void programLocalBridgeRules(Node node, Long dpid, String segmentationId,
 222                                          String attachedMac, long localPort) {
 223         /*
 224          * Table(0) Rule #3
 225          * ----------------
 226          * Match: VM sMac and Local Ingress Port
 227          * Action:Action: Set Tunnel ID and GOTO Local Table (5)
 228          */
 229
 230         handleLocalInPort(dpid, TABLE_0_DEFAULT_INGRESS, TABLE_1_ISOLATE_TENANT,
 231                 segmentationId, localPort, attachedMac, true);
 232
 233         /*
 234          * Table(0) Rule #4
 235          * ----------------
 236          * Match: Drop any remaining Ingress Local VM Packets
 237          * Action: Drop w/ a low priority
 238          */
 239
 240         handleDropSrcIface(dpid, localPort, true);
 241
 242         /*
 243          * Table(2) Rule #1
 244          * ----------------
 245          * Match: Match TunID and Destination DL/dMAC Addr
 246          * Action: Output Port
 247          * table=2,tun_id=0x5,dl_dst=00:00:00:00:00:01 actions=output:2
 248          */
 249
 250         handleLocalUcastOut(dpid, TABLE_2_LOCAL_FORWARD, segmentationId, localPort, attachedMac, true);
 251
 252         /*
 253          * Table(2) Rule #2
 254          * ----------------
 255          * Match: Tunnel ID and dMAC (::::FF:FF)
 256          * table=2,priority=16384,tun_id=0x5,dl_dst=ff:ff:ff:ff:ff:ff \
 257          * actions=output:2,3,4,5
 258          */
 259
 260         handleLocalBcastOut(dpid, TABLE_2_LOCAL_FORWARD, segmentationId, localPort, true);
 261         handleTunnelFloodOut(dpid, TABLE_1_ISOLATE_TENANT, TABLE_2_LOCAL_FORWARD, segmentationId, localPort, true);
 262
 263         /*
 264          * TODO : Optimize the following 2 writes to be restricted only for the very first port known in a segment.
 265          */
 266         /*
 267          * Table(1) Rule #3
 268          * ----------------
 269          * Match:  Any remaining Ingress Local VM Packets
 270          * Action: Drop w/ a low priority
 271          * -------------------------------------------
 272          * table=1,priority=8192,tun_id=0x5 actions=goto_table:2
 273          */
 274
 275         handleTunnelMiss(dpid, TABLE_1_ISOLATE_TENANT, TABLE_2_LOCAL_FORWARD, segmentationId, true);
 276
 277         /*
 278          * Table(2) Rule #3
 279          * ----------------
 280          * Match: Any Remaining Flows w/a TunID
 281          * Action: Drop w/ a low priority
 282          * table=2,priority=8192,tun_id=0x5 actions=drop
 283          */
 284
 285         handleLocalTableMiss(dpid, TABLE_2_LOCAL_FORWARD, segmentationId, true);
 286     }
 287
 288     private void removeLocalBridgeRules(Node node, Long dpid, String segmentationId, String attachedMac, long localPort) {
 289         /*
 290          * Table(0) Rule #3
 291          * ----------------
 292          * Match: VM sMac and Local Ingress Port
 293          * Action:Action: Set Tunnel ID and GOTO Local Table (5)
 294          */
 295
 296         handleLocalInPort(dpid, TABLE_0_DEFAULT_INGRESS, TABLE_1_ISOLATE_TENANT, segmentationId, localPort, attachedMac, false);
 297
 298         /*
 299          * Table(0) Rule #4
 300          * ----------------
 301          * Match: Drop any remaining Ingress Local VM Packets
 302          * Action: Drop w/ a low priority
 303          */
 304
 305         handleDropSrcIface(dpid, localPort, false);
 306
 307         /*
 308          * Table(2) Rule #1
 309          * ----------------
 310          * Match: Match TunID and Destination DL/dMAC Addr
 311          * Action: Output Port
 312          * table=2,tun_id=0x5,dl_dst=00:00:00:00:00:01 actions=output:2
 313          */
 314
 315         handleLocalUcastOut(dpid, TABLE_2_LOCAL_FORWARD, segmentationId, localPort, attachedMac, false);
 316
 317         /*
 318          * Table(2) Rule #2
 319          * ----------------
 320          * Match: Tunnel ID and dMAC (::::FF:FF)
 321          * table=2,priority=16384,tun_id=0x5,dl_dst=ff:ff:ff:ff:ff:ff \
 322          * actions=output:2,3,4,5
 323          */
 324
 325         handleLocalBcastOut(dpid, TABLE_2_LOCAL_FORWARD, segmentationId, localPort, false);
 326         handleTunnelFloodOut(dpid, TABLE_1_ISOLATE_TENANT, TABLE_2_LOCAL_FORWARD, segmentationId, localPort, false);
 327     }
 328
 329     private void programLocalIngressTunnelBridgeRules(Node node, Long dpid, String segmentationId, String attachedMac, long tunnelOFPort, long localPort) {
 330         /*
 331          * Table(0) Rule #2
 332          * ----------------
 333          * Match: Ingress Port, Tunnel ID
 334          * Action: GOTO Local Table (20)
 335          */
 336
 337         handleTunnelIn(dpid, TABLE_0_DEFAULT_INGRESS, TABLE_2_LOCAL_FORWARD, segmentationId, tunnelOFPort, true);
 338
 339         /*
 340          * Table(1) Rule #2
 341          * ----------------
 342          * Match: Match Tunnel ID and L2 ::::FF:FF Flooding
 343          * Action: Flood to selected destination TEPs
 344          * -------------------------------------------
 345          * table=1,priority=16384,tun_id=0x5,dl_dst=ff:ff:ff:ff:ff:ff \
 346          * actions=output:10,output:11,goto_table:2
 347          */
 348
 349         handleTunnelFloodOut(dpid, TABLE_1_ISOLATE_TENANT, TABLE_2_LOCAL_FORWARD, segmentationId, tunnelOFPort, true);
 350
 351     }
 352
 353     private void programRemoteEgressTunnelBridgeRules(Node node, Long dpid, String segmentationId, String attachedMac, long tunnelOFPort, long localPort) {
 354         /*
 355          * Table(1) Rule #1
 356          * ----------------
 357          * Match: Drop any remaining Ingress Local VM Packets
 358          * Action: Drop w/ a low priority
 359          * -------------------------------------------
 360          * table=1,tun_id=0x5,dl_dst=00:00:00:00:00:08 \
 361          * actions=output:11,goto_table:2
 362          */
 363
 364         handleTunnelOut(dpid, TABLE_1_ISOLATE_TENANT, TABLE_2_LOCAL_FORWARD, segmentationId, tunnelOFPort, attachedMac, true);
 365     }
 366
 367     private void removeRemoteEgressTunnelBridgeRules(Node node, Long dpid, String segmentationId, String attachedMac, long tunnelOFPort, long localPort) {
 368         /*
 369          * Table(1) Rule #1
 370          * ----------------
 371          * Match: Drop any remaining Ingress Local VM Packets
 372          * Action: Drop w/ a low priority
 373          * -------------------------------------------
 374          * table=1,tun_id=0x5,dl_dst=00:00:00:00:00:08 \
 375          * actions=output:11,goto_table:2
 376          */
 377
 378         handleTunnelOut(dpid, TABLE_1_ISOLATE_TENANT, TABLE_2_LOCAL_FORWARD, segmentationId, tunnelOFPort, attachedMac, false);
 379     }
 380
 381     /* Remove tunnel rules if last node in this tenant network */
 382     private void removePerTunnelRules(Node node, Long dpid, String segmentationId, long tunnelOFPort) {
 383         /*
 384          * TODO : Optimize the following 2 writes to be restricted only for the very first port known in a segment.
 385          */
 386         /*
 387          * Table(1) Rule #3
 388          * ----------------
 389          * Match:  Any remaining Ingress Local VM Packets
 390          * Action: Drop w/ a low priority
 391          * -------------------------------------------
 392          * table=1,priority=8192,tun_id=0x5 actions=goto_table:2
 393          */
 394
 395         handleTunnelMiss(dpid, TABLE_1_ISOLATE_TENANT, TABLE_2_LOCAL_FORWARD, segmentationId, false);
 396
 397         /*
 398          * Table(2) Rule #3
 399          * ----------------
 400          * Match: Any Remaining Flows w/a TunID
 401          * Action: Drop w/ a low priority
 402          * table=2,priority=8192,tun_id=0x5 actions=drop
 403          */
 404
 405         handleLocalTableMiss(dpid, TABLE_2_LOCAL_FORWARD, segmentationId, false);
 406
 407         /*
 408          * Table(0) Rule #2
 409          * ----------------
 410          * Match: Ingress Port, Tunnel ID
 411          * Action: GOTO Local Table (10)
 412          */
 413
 414         handleTunnelIn(dpid, TABLE_0_DEFAULT_INGRESS, TABLE_2_LOCAL_FORWARD, segmentationId, tunnelOFPort, false);
 415
 416         /*
 417          * Table(1) Rule #2
 418          * ----------------
 419          * Match: Match Tunnel ID and L2 ::::FF:FF Flooding
 420          * Action: Flood to selected destination TEPs
 421          * -------------------------------------------
 422          * table=1,priority=16384,tun_id=0x5,dl_dst=ff:ff:ff:ff:ff:ff \
 423          * actions=output:10,output:11,goto_table:2
 424          */
 425
 426         handleTunnelFloodOut(dpid, TABLE_1_ISOLATE_TENANT, TABLE_2_LOCAL_FORWARD, segmentationId, tunnelOFPort, false);
 427     }
 428
 429     private void programLocalVlanRules(Node node, Long dpid, String segmentationId, String attachedMac, long localPort) {
 430         /*
 431          * Table(0) Rule #1
 432          * ----------------
 433          * Tag traffic coming from the local port and vm srcmac
 434          * Match: VM sMac and Local Ingress Port
 435          * Action: Set VLAN ID and GOTO Local Table 1
 436          */
 437
 438         handleLocalInPortSetVlan(dpid, TABLE_0_DEFAULT_INGRESS,
 439                 TABLE_1_ISOLATE_TENANT, segmentationId, localPort,
 440                 attachedMac, true);
 441
 442         /*
 443          * Table(0) Rule #3
 444          * ----------------
 445          * Drop all other traffic coming from the local port
 446          * Match: Drop any remaining Ingress Local VM Packets
 447          * Action: Drop w/ a low priority
 448          */
 449
 450         handleDropSrcIface(dpid, localPort, true);
 451
 452         /*
 453          * Table(2) Rule #1
 454          * ----------------
 455          * Forward unicast traffic destined to the local port after stripping tag
 456          * Match: Match VLAN ID and Destination DL/dMAC Addr
 457          * Action: strip vlan, output to local port
 458          * Example: table=2,vlan_id=0x5,dl_dst=00:00:00:00:00:01 actions= strip vlan, output:2
 459          */
 460
 461         handleLocalVlanUcastOut(dpid, TABLE_2_LOCAL_FORWARD, segmentationId,
 462                 localPort, attachedMac, true);
 463
 464         /*
 465          * Table(2) Rule #2
 466          * ----------------
 467          * Match: VLAN ID and dMAC (::::FF:FF)
 468          * Action: strip vlan, output to all local ports in this vlan
 469          * Example: table=2,priority=16384,vlan_id=0x5,dl_dst=ff:ff:ff:ff:ff:ff \
 470          * actions= strip_vlan, output:2,3,4,5
 471          */
 472
 473         //handleLocalVlanBcastOut(dpid, TABLE_2_LOCAL_FORWARD, segmentationId,
 474         //        localPort, ethPort, true);
 475         //handleVlanFloodOut(dpid, TABLE_1_ISOLATE_TENANT, TABLE_2_LOCAL_FORWARD,
 476         //        segmentationId, localPort, ethport, true);
 477
 478         /*
 479          * Table(2) Rule #3
 480          * ----------------
 481          * Match: Any Remaining Flows w/a VLAN ID
 482          * Action: Drop w/ a low priority
 483          * Example: table=2,priority=8192,vlan_id=0x5 actions=drop
 484          */
 485
 486         //handleLocalVlanTableMiss(dpid, TABLE_2_LOCAL_FORWARD, segmentationId,
 487         //        true);
 488     }
 489
 490     private void removeLocalVlanRules(Node node, Long dpid,
 491                                       String segmentationId, String attachedMac, long localPort) {
 492         /*
 493          * Table(0) Rule #1
 494          * ----------------
 495          * Match: VM sMac and Local Ingress Port
 496          * Action: Set VLAN ID and GOTO Local Table 1
 497          */
 498
 499         handleLocalInPortSetVlan(dpid, TABLE_0_DEFAULT_INGRESS,
 500                 TABLE_1_ISOLATE_TENANT, segmentationId, localPort,
 501                 attachedMac, false);
 502
 503         /*
 504          * Table(0) Rule #3
 505          * ----------------
 506          * Match: Drop any remaining Ingress Local VM Packets
 507          * Action: Drop w/ a low priority
 508          */
 509
 510         handleDropSrcIface(dpid, localPort, false);
 511
 512         /*
 513          * Table(2) Rule #1
 514          * ----------------
 515          * Match: Match VLAN ID and Destination DL/dMAC Addr
 516          * Action: strip vlan, output to local port
 517          * Example: table=2,vlan_id=0x5,dl_dst=00:00:00:00:00:01 actions= strip vlan, output:2
 518          */
 519
 520         handleLocalVlanUcastOut(dpid, TABLE_2_LOCAL_FORWARD, segmentationId,
 521                 localPort, attachedMac, false);
 522
 523         /*
 524          * Table(2) Rule #2
 525          * ----------------
 526          * Match: VLAN ID and dMAC (::::FF:FF)
 527          * Action: strip vlan, output to all local ports in this vlan
 528          * Example: table=2,priority=16384,vlan_id=0x5,dl_dst=ff:ff:ff:ff:ff:ff \
 529          * actions= strip_vlan, output:2,3,4,5
 530          */
 531
 532         //handleLocalVlanBcastOut(dpid, TABLE_2_LOCAL_FORWARD, segmentationId,
 533         //        localPort, ethPort, false);
 534         //handleVlanFloodOut(dpid, TABLE_1_ISOLATE_TENANT, TABLE_2_LOCAL_FORWARD,
 535         //        segmentationId, localPort, false);
 536
 537     }
 538
 539     private void programLocalIngressVlanRules(Node node, Long dpid, String segmentationId, String attachedMac,
 540                                               long localPort, long ethPort) {
 541         /*
 542          * Table(0) Rule #2
 543          * ----------------
 544          * Match: Ingress port = physical interface, Vlan ID
 545          * Action: GOTO Local Table 2
 546          */
 547
 548         handleVlanIn(dpid, TABLE_0_DEFAULT_INGRESS, TABLE_2_LOCAL_FORWARD,
 549                 segmentationId, ethPort, true);
 550
 551         /*
 552          * Table(1) Rule #2
 553          * ----------------
 554          * Match: Match VLAN ID and L2 ::::FF:FF Flooding
 555          * Action: Flood to local and remote VLAN members
 556          * -------------------------------------------
 557          * Example: table=1,priority=16384,vlan_id=0x5,dl_dst=ff:ff:ff:ff:ff:ff \
 558          * actions=output:10 (eth port),goto_table:2
 559          * table=110, priority=16384,dl_vlan=2001,dl_dst=01:00:00:00:00:00/01:00:00:00:00:00 actions=output:2,pop_vlan,output:1,output:3,output:4
 560          */
 561
 562         handleLocalVlanBcastOut(dpid, TABLE_2_LOCAL_FORWARD, segmentationId, localPort, ethPort, true);
 563
 564         /*
 565          * Table(1) Rule #2
 566          * ----------------
 567          * Match: Match VLAN ID and L2 ::::FF:FF Flooding
 568          * Action: Flood to local and remote VLAN members
 569          * -------------------------------------------
 570          * Example: table=1,priority=16384,vlan_id=0x5,dl_dst=ff:ff:ff:ff:ff:ff \
 571          * actions=output:10 (eth port),goto_table:2
 572          */
 573
 574         //handleVlanFloodOut(dpid, TABLE_1_ISOLATE_TENANT, TABLE_2_LOCAL_FORWARD,
 575         //        segmentationId, ethPort, true);
 576     }
 577
 578     private void programRemoteEgressVlanRules(Node node, Long dpid, String segmentationId,
 579                                               String attachedMac, long ethPort) {
 580         /*
 581          * Table(1) Rule #1
 582          * ----------------
 583          * Match: Destination MAC is local VM MAC and vlan id
 584          * Action: go to table 2
 585          * -------------------------------------------
 586          * Example: table=1,vlan_id=0x5,dl_dst=00:00:00:00:00:08 \
 587          * actions=goto_table:2
 588          */
 589
 590         //handleVlanOut(dpid, TABLE_1_ISOLATE_TENANT, TABLE_2_LOCAL_FORWARD,
 591         //        segmentationId, ethPort, attachedMac, true);
 592
 593         /*
 594          * Table(1) Rule #3
 595          * ----------------
 596          * Match:  VLAN ID
 597          * Action: Go to table 2
 598          * -------------------------------------------
 599          * Example: table=1,priority=8192,vlan_id=0x5 actions=output:1,goto_table:2
 600          * table=110,priority=8192,dl_vlan=2001 actions=output:2
 601          */
 602
 603         handleVlanMiss(dpid, TABLE_1_ISOLATE_TENANT, TABLE_2_LOCAL_FORWARD, segmentationId, ethPort, true);
 604     }
 605
 606     private void removeRemoteEgressVlanRules(Node node, Long dpid, String segmentationId,
 607                                              String attachedMac, long localPort, long ethPort) {
 608         /*
 609          * Table(1) Rule #1
 610          * ----------------
 611          * Match: Destination MAC is local VM MAC and vlan id
 612          * Action: go to table 2
 613          * -------------------------------------------
 614          * Example: table=1,vlan_id=0x5,dl_dst=00:00:00:00:00:08 \
 615          * actions=goto_table:2
 616          */
 617
 618         //handleVlanOut(dpid, TABLE_1_ISOLATE_TENANT, TABLE_2_LOCAL_FORWARD,
 619         //        segmentationId, ethPort, attachedMac, false);
 620
 621         /*
 622          * Table(1) Rule #2
 623          * ----------------
 624          * Match: Match VLAN ID and L2 ::::FF:FF Flooding
 625          * Action: Flood to local and remote VLAN members
 626          * -------------------------------------------
 627          * Example: table=1,priority=16384,vlan_id=0x5,dl_dst=ff:ff:ff:ff:ff:ff \
 628          * actions=output:10 (eth port),goto_table:2
 629          * table=110, priority=16384,dl_vlan=2001,dl_dst=01:00:00:00:00:00/01:00:00:00:00:00 actions=output:2,pop_vlan,output:1,output:3,output:4
 630          */
 631
 632         handleLocalVlanBcastOut(dpid, TABLE_2_LOCAL_FORWARD, segmentationId, localPort, ethPort, false);
 633     }
 634
 635     private void removePerVlanRules(Node node, Long dpid, String segmentationId, long localPort, long ethPort) {
 636         /*
 637          * Table(2) Rule #3
 638          * ----------------
 639          * Match: Any Remaining Flows w/a VLAN ID
 640          * Action: Drop w/ a low priority
 641          * Example: table=2,priority=8192,vlan_id=0x5 actions=drop
 642          */
 643
 644         //handleLocalVlanTableMiss(dpid, TABLE_2_LOCAL_FORWARD, segmentationId, false);
 645
 646         /*
 647          * Table(0) Rule #2
 648          * ----------------
 649          * Match: Ingress port = physical interface, Vlan ID
 650          * Action: GOTO Local Table 2
 651          */
 652
 653         handleVlanIn(dpid, TABLE_0_DEFAULT_INGRESS, TABLE_2_LOCAL_FORWARD, segmentationId, ethPort, false);
 654
 655         /*
 656          * Table(1) Rule #2
 657          * ----------------
 658          * Match: Match VLAN ID and L2 ::::FF:FF Flooding
 659          * Action: Flood to local and remote VLAN members
 660          * -------------------------------------------
 661          * Example: table=1,priority=16384,vlan_id=0x5,dl_dst=ff:ff:ff:ff:ff:ff \
 662          * actions=output:10 (eth port),goto_table:2
 663          * table=110, priority=16384,dl_vlan=2001,dl_dst=01:00:00:00:00:00/01:00:00:00:00:00 actions=output:2,pop_vlan,output:1,output:3,output:4
 664          */
 665
 666         //handleLocalVlanBcastOut(dpid, TABLE_2_LOCAL_FORWARD, segmentationId, localPort, ethPort, false);
 667
 668         /*
 669          * Table(1) Rule #2
 670          * ----------------
 671          * Match: Match VLAN ID and L2 ::::FF:FF Flooding
 672          * Action: Flood to local and remote VLAN members
 673          * -------------------------------------------
 674          * Example: table=1,priority=16384,vlan_id=0x5,dl_dst=ff:ff:ff:ff:ff:ff \
 675          * actions=output:10 (eth port),goto_table:2
 676          */
 677
 678         //handleVlanFloodOut(dpid, TABLE_1_ISOLATE_TENANT, TABLE_2_LOCAL_FORWARD,
 679         //        segmentationId, ethPort, false);
 680
 681         /*
 682          * Table(1) Rule #3
 683          * ----------------
 684          * Match:  VLAN ID
 685          * Action: Go to table 2
 686          * -------------------------------------------
 687          * Example: table=1,priority=8192,vlan_id=0x5 actions=output:1,goto_table:2
 688          * table=110,priority=8192,dl_vlan=2001 actions=output:2
 689          */
 690
 691         handleVlanMiss(dpid, TABLE_1_ISOLATE_TENANT, TABLE_2_LOCAL_FORWARD, segmentationId, ethPort, false);
 692     }
 693
 694     private long getDpid(Node node) {
 695         long dpid = southbound.getDataPathId(node);
 696         if (dpid == 0) {
 697             LOG.warn("getDpid: dpid not found: {}", node);
 698         }
 699         return dpid;
 700     }
 701
 702     private long getIntegrationBridgeOFDPID(Node node) {
 703         long dpid = 0L;
 704         if (southbound.getBridgeName(node).equals(configurationService.getIntegrationBridgeName())) {
 705             dpid = getDpid(node);
 706         }
 707         return dpid;
 708     }
 709
 710     /**
 711      * Returns true is the network if of type GRE or VXLAN
 712      *
 713      * @param networkType The type of the network
 714      * @return returns true if the network is a tunnel
 715      */
 716     private boolean isTunnel(String networkType)
 717     {
 718         return (networkType.equalsIgnoreCase(NetworkHandler.NETWORK_TYPE_GRE) || networkType.equalsIgnoreCase
 719                 (NetworkHandler.NETWORK_TYPE_VXLAN));
 720     }
 721
 722     /**
 723      * Returns true if the network is of type vlan.
 724      *
 725      * @param networkType The type of the network
 726      * @return returns true if the network is a vlan
 727      */
 728     private boolean isVlan(String networkType)
 729     {
 730         return networkType.equalsIgnoreCase(NetworkHandler.NETWORK_TYPE_VLAN);
 731     }
 732
 733     private void programLocalRules (String networkType, String segmentationId, Node node,
 734                                     OvsdbTerminationPointAugmentation intf) {
 735         LOG.debug("programLocalRules: node: {}, intf: {}, networkType: {}, segmentationId: {}",
 736                 node.getNodeId(), intf.getName(), networkType, segmentationId);
 737         try {
 738             long dpid = getIntegrationBridgeOFDPID(node);
 739             if (dpid == 0L) {
 740                 LOG.debug("programLocalRules: Openflow Datapath-ID not set for the integration bridge in {}",
 741                         node);
 742                 return;
 743             }
 744
 745             long localPort = southbound.getOFPort(intf);
 746             if (localPort == 0) {
 747                 LOG.info("programLocalRules: could not find ofPort for Port {} on Node {}", intf.getName(), node.getNodeId());
 748                 return;
 749             }
 750
 751             String attachedMac = southbound.getInterfaceExternalIdsValue(intf, Constants.EXTERNAL_ID_VM_MAC);
 752             if (attachedMac == null) {
 753                 LOG.warn("No AttachedMac seen in {}", intf);
 754                 return;
 755             }
 756
 757             /* Program local rules based on network type */
 758             if (isVlan(networkType)) {
 759                 LOG.debug("Program local vlan rules for interface {}", intf.getName());
 760                 programLocalVlanRules(node, dpid, segmentationId, attachedMac, localPort);
 761             }
 762             if ((isTunnel(networkType)|| isVlan(networkType))) {
 763                 LOG.debug("programLocalRules: Program fixed security group rules for interface {}", intf.getName());
 764                 // Get the DHCP port for the subnet to which  the interface belongs to.
 765                 NeutronPort dhcpPort = securityServicesManager.getDHCPServerPort(intf);
 766                 if (null != dhcpPort) {
 767                     boolean isComputePort =securityServicesManager.isComputePort(intf);
 768                     boolean isLastPortinBridge = securityServicesManager.isLastPortinBridge(node, intf);
 769                     boolean isLastPortinSubnet =false;
 770                     List<Neutron_IPs> srcAddressList = null;
 771                     if(isComputePort) {
 772                         isLastPortinSubnet = securityServicesManager.isLastPortinSubnet(node, intf);
 773                         srcAddressList = securityServicesManager.getIpAddress(node, intf);
 774                         if (null == srcAddressList) {
 775                             LOG.warn("programLocalRules: No Ip address assigned {}", intf);
 776                             return;
 777                         }
 778                     }
 779                     ingressAclProvider.programFixedSecurityACL(dpid,segmentationId, dhcpPort.getMacAddress(), localPort,
 780                             isLastPortinSubnet,isComputePort,   true);
 781                     egressAclProvider.programFixedSecurityACL(dpid, segmentationId, attachedMac, localPort,
 782                                                               srcAddressList, isLastPortinBridge, isComputePort,true);
 783                 } else {
 784                     LOG.warn("programLocalRules: No DCHP port seen in  network of {}", intf);
 785                 }
 786             }
 787             /* If the network type is tunnel based (VXLAN/GRRE/etc) with Neutron Port Security ACLs */
 788             /* TODO SB_MIGRATION */
 789             /*if ((networkType.equalsIgnoreCase(NetworkHandler.NETWORK_TYPE_GRE) || networkType.equalsIgnoreCase
 790                     (NetworkHandler.NETWORK_TYPE_VXLAN)) && securityServicesManager.isPortSecurityReady(intf)) {
 791                 LOG.debug("Neutron port has a Port Security Group");
 792                 // Retrieve the security group UUID from the Neutron Port
 793                 NeutronSecurityGroup securityGroupInPort = securityServicesManager.getSecurityGroupInPort(intf);
 794                 LOG.debug("Program Local rules for networkType: {} does contain a Port Security Group: {} " +
 795                         "to be installed on DPID: {}", networkType, securityGroupInPort, dpid);
 796                 ingressAclProvider.programPortSecurityACL(dpid, segmentationId, attachedMac, localPort,
 797                         securityGroupInPort);
 798                 egressAclProvider.programPortSecurityACL(dpid, segmentationId, attachedMac, localPort,
 799                         securityGroupInPort);
 800             }*/
 801             if (isTunnel(networkType)) {
 802                 LOG.debug("Program local bridge rules for interface {}, "
 803                                 + "dpid: {}, segmentationId: {}, attachedMac: {}, localPort: {}",
 804                         intf.getName(), dpid, segmentationId, attachedMac, localPort);
 805                 programLocalBridgeRules(node, dpid, segmentationId, attachedMac, localPort);
 806             }
 807         } catch (Exception e) {
 808             LOG.error("Exception in programming Local Rules for " + intf + " on " + node, e);
 809         }
 810     }
 811
 812     private void removeLocalRules (String networkType, String segmentationId, Node node,
 813                                    OvsdbTerminationPointAugmentation intf) {
 814         LOG.debug("removeLocalRules: node: {}, intf: {}, networkType: {}, segmentationId: {}",
 815                 node.getNodeId(), intf.getName(), networkType, segmentationId);
 816         try {
 817             long dpid = getIntegrationBridgeOFDPID(node);
 818             if (dpid == 0L) {
 819                 LOG.debug("removeLocalRules: Openflow Datapath-ID not set for the integration bridge in {}", node);
 820                 return;
 821             }
 822
 823             long localPort = southbound.getOFPort(intf);
 824             if (localPort == 0) {
 825                 LOG.info("removeLocalRules: could not find ofPort");
 826                 return;
 827             }
 828
 829             String attachedMac = southbound.getInterfaceExternalIdsValue(intf, Constants.EXTERNAL_ID_VM_MAC);
 830             if (attachedMac == null) {
 831                 LOG.warn("No AttachedMac seen in {}", intf);
 832                 return;
 833             }
 834
 835             /* Program local rules based on network type */
 836             if (isVlan(networkType)) {
 837                 LOG.debug("Remove local vlan rules for interface {}", intf.getName());
 838                 removeLocalVlanRules(node, dpid, segmentationId, attachedMac, localPort);
 839             } else if (isTunnel(networkType)) {
 840                 LOG.debug("Remove local bridge rules for interface {}", intf.getName());
 841                 removeLocalBridgeRules(node, dpid, segmentationId, attachedMac, localPort);
 842             }
 843             if (isTunnel(networkType)|| isVlan(networkType)) {
 844                 LOG.debug("removeLocalRules: Remove fixed security group rules for interface {}", intf.getName());
 845                 NeutronPort dhcpPort = securityServicesManager.getDHCPServerPort(intf);
 846                 if (null != dhcpPort) {
 847                     List<Neutron_IPs> srcAddressList = securityServicesManager.getIpAddress(node, intf);
 848                     if (null == srcAddressList) {
 849                         LOG.warn("removeLocalRules: No Ip address assigned {}", intf);
 850                         return;
 851                     }
 852                     boolean isLastPortinBridge = securityServicesManager.isLastPortinBridge(node, intf);
 853                     boolean isComputePort =securityServicesManager.isComputePort(intf);
 854                     boolean isLastPortinSubnet =false;
 855                     if (isComputePort)
 856                     {
 857                         isLastPortinSubnet = securityServicesManager.isLastPortinSubnet(node, intf);
 858                     }
 859                     ingressAclProvider.programFixedSecurityACL(dpid,    segmentationId, dhcpPort.getMacAddress(), localPort,
 860                             isLastPortinSubnet, isComputePort, false);
 861                     egressAclProvider.programFixedSecurityACL(dpid, segmentationId,     attachedMac, localPort,
 862                                                               srcAddressList, isLastPortinBridge, isComputePort, false);
 863                 }else{
 864                     LOG.warn("removeLocalRules: No DCHP port seen in  network of {}", intf);
 865                 }
 866             }
 867         } catch (Exception e) {
 868             LOG.error("Exception in removing Local Rules for " + intf + " on " + node, e);
 869         }
 870     }
 871
 872     // TODO SB_MIGRATION
 873     // Need to handle case where a node comes online after a network and tunnels have
 874     // already been created. The interface update is what triggers creating the l2 forwarding flows
 875     // so we don't see those updates in this case - we only see the new nodes interface updates.
 876     private void programTunnelRules (String tunnelType, String segmentationId, InetAddress dst, Node node,
 877                                      OvsdbTerminationPointAugmentation intf, boolean local) {
 878         LOG.debug("programTunnelRules: node: {}, intf: {}, local: {}, tunnelType: {}, "
 879                         + "segmentationId: {}, dstAddr: {}",
 880                 node.getNodeId(), intf.getName(), local, tunnelType, segmentationId, dst.getHostAddress());
 881         try {
 882             long dpid = getIntegrationBridgeOFDPID(node);
 883             if (dpid == 0L) {
 884                 LOG.debug("programTunnelRules: Openflow Datapath-ID not set for the integration bridge in {}", node);
 885                 return;
 886             }
 887
 888             long localPort = southbound.getOFPort(intf);
 889             if (localPort == 0) {
 890                 LOG.info("programTunnelRules: could not find ofPort for Port {} on Node{}", intf.getName(), node.getNodeId());
 891                 return;
 892             }
 893
 894             String attachedMac = southbound.getInterfaceExternalIdsValue(intf, Constants.EXTERNAL_ID_VM_MAC);
 895             if (attachedMac == null) {
 896                 LOG.warn("programTunnelRules: No AttachedMac seen in {}", intf);
 897                 return;
 898             }
 899
 900             OvsdbTerminationPointAugmentation tunnelPort= southbound.getTerminationPointOfBridge(node, getTunnelName(tunnelType, dst));
 901             if(tunnelPort != null){
 902                 long tunnelOFPort = southbound.getOFPort(tunnelPort);
 903                 if (tunnelOFPort == 0) {
 904                     LOG.error("programTunnelRules: Could not Identify Tunnel port {} -> OF ({}) on {}",
 905                             tunnelPort.getName(), tunnelOFPort, node);
 906                     return;
 907                 }
 908                 LOG.debug("programTunnelRules: Identified Tunnel port {} -> OF ({}) on {}",
 909                         tunnelPort.getName(), tunnelOFPort, node);
 910
 911                 if (!local) {
 912                     LOG.trace("programTunnelRules: program remote egress tunnel rules: node {}, intf {}",
 913                             node.getNodeId().getValue(), intf.getName());
 914                     programRemoteEgressTunnelBridgeRules(node, dpid, segmentationId, attachedMac,
 915                             tunnelOFPort, localPort);
 916                 } else {
 917                     LOG.trace("programTunnelRules: program local ingress tunnel rules: node {}, intf {}",
 918                             node.getNodeId().getValue(), intf.getName());
 919                     programLocalIngressTunnelBridgeRules(node, dpid, segmentationId, attachedMac,
 920                             tunnelOFPort, localPort);
 921                 }
 922             }
 923         } catch (Exception e) {
 924             LOG.trace("", e);
 925         }
 926     }
 927
 928     private void removeTunnelRules (String tunnelType, String segmentationId, InetAddress dst, Node node,
 929                                     OvsdbTerminationPointAugmentation intf,
 930                                     boolean local, boolean isLastInstanceOnNode) {
 931         LOG.debug("removeTunnelRules: node: {}, intf: {}, local: {}, tunnelType: {}, "
 932                         + "segmentationId: {}, dstAddr: {}, isLastinstanceOnNode: {}",
 933                 node.getNodeId(), intf.getName(), local, tunnelType, segmentationId, dst, isLastInstanceOnNode);
 934         try {
 935             long dpid = getIntegrationBridgeOFDPID(node);
 936             if (dpid == 0L) {
 937                 LOG.debug("removeTunnelRules: Openflow Datapath-ID not set for the integration bridge in {}", node);
 938                 return;
 939             }
 940
 941             long localPort = southbound.getOFPort(intf);
 942             if (localPort == 0) {
 943                 LOG.info("removeTunnelRules: could not find ofPort");
 944                 return;
 945             }
 946
 947             String attachedMac = southbound.getInterfaceExternalIdsValue(intf, Constants.EXTERNAL_ID_VM_MAC);
 948             if (attachedMac == null) {
 949                 LOG.error("removeTunnelRules: No AttachedMac seen in {}", intf);
 950                 return;
 951             }
 952
 953             List<OvsdbTerminationPointAugmentation> intfs = southbound.getTerminationPointsOfBridge(node);
 954             for (OvsdbTerminationPointAugmentation tunIntf : intfs) {
 955                 if (tunIntf.getName().equals(getTunnelName(tunnelType, dst))) {
 956                     long tunnelOFPort = southbound.getOFPort(tunIntf);
 957                     if (tunnelOFPort == 0) {
 958                         LOG.error("Could not Identify Tunnel port {} -> OF ({}) on {}",
 959                                 tunIntf.getName(), tunnelOFPort, node);
 960                         return;
 961                     }
 962                     LOG.debug("Identified Tunnel port {} -> OF ({}) on {}",
 963                             tunIntf.getName(), tunnelOFPort, node);
 964
 965                     if (!local) {
 966                         removeRemoteEgressTunnelBridgeRules(node, dpid, segmentationId, attachedMac,
 967                                 tunnelOFPort, localPort);
 968                     }
 969                     if (local && isLastInstanceOnNode) {
 970                         removePerTunnelRules(node, dpid, segmentationId, tunnelOFPort);
 971                     }
 972                     return;
 973                 }
 974             }
 975         } catch (Exception e) {
 976             LOG.error("", e);
 977         }
 978     }
 979
 980     private void programVlanRules (NeutronNetwork network, Node node, OvsdbTerminationPointAugmentation intf) {
 981         LOG.debug("programVlanRules: node: {}, network: {}, intf: {}",
 982                 node.getNodeId(), network.getNetworkUUID(), intf.getName());
 983         long dpid = getIntegrationBridgeOFDPID(node);
 984         if (dpid == 0L) {
 985             LOG.debug("programVlanRules: Openflow Datapath-ID not set for the integration bridge in {}", node);
 986             return;
 987         }
 988
 989         long localPort = southbound.getOFPort(intf);
 990         if (localPort == 0) {
 991             LOG.debug("programVlanRules: could not find ofPort for {}", intf.getName());
 992             return;
 993         }
 994
 995         String attachedMac = southbound.getInterfaceExternalIdsValue(intf, Constants.EXTERNAL_ID_VM_MAC);
 996         if (attachedMac == null) {
 997             LOG.debug("programVlanRules: No AttachedMac seen in {}", intf);
 998             return;
 999         }
1000
1001         String phyIfName =
1002                 bridgeConfigurationManager.getPhysicalInterfaceName(node, network.getProviderPhysicalNetwork());
1003         long ethOFPort = southbound.getOFPort(node, phyIfName);
1004         if (ethOFPort == 0) {
1005             LOG.warn("programVlanRules: could not find ofPort for physical port {}", phyIfName);
1006             return;
1007         }
1008         LOG.debug("programVlanRules: Identified eth port {} -> ofPort ({}) on {}",
1009                 phyIfName, ethOFPort, node);
1010         // TODO: add logic to only add rule on remote nodes
1011         programRemoteEgressVlanRules(node, dpid, network.getProviderSegmentationID(),
1012                 attachedMac, ethOFPort);
1013         programLocalIngressVlanRules(node, dpid, network.getProviderSegmentationID(),
1014                 attachedMac, localPort, ethOFPort);
1015     }
1016
1017     private void removeVlanRules (NeutronNetwork network, Node node, OvsdbTerminationPointAugmentation intf,
1018                                   boolean isLastInstanceOnNode) {
1019         LOG.debug("removeVlanRules: node: {}, network: {}, intf: {}, isLastInstanceOnNode",
1020                 node.getNodeId(), network.getNetworkUUID(), intf.getName(), isLastInstanceOnNode);
1021         long dpid = getIntegrationBridgeOFDPID(node);
1022         if (dpid == 0L) {
1023             LOG.debug("removeVlanRules: Openflow Datapath-ID not set for the integration bridge in {}", node);
1024             return;
1025         }
1026
1027         long localPort = southbound.getOFPort(intf);
1028         if (localPort == 0) {
1029             LOG.debug("removeVlanRules: programVlanRules: could not find ofPort for {}", intf.getName());
1030             return;
1031         }
1032
1033         String attachedMac = southbound.getInterfaceExternalIdsValue(intf, Constants.EXTERNAL_ID_VM_MAC);
1034         if (attachedMac == null) {
1035             LOG.debug("removeVlanRules: No AttachedMac seen in {}", intf);
1036             return;
1037         }
1038
1039         String phyIfName =
1040                 bridgeConfigurationManager.getPhysicalInterfaceName(node, network.getProviderPhysicalNetwork());
1041         long ethOFPort = southbound.getOFPort(node, phyIfName);
1042         if (ethOFPort == 0) {
1043             LOG.warn("removeVlanRules: could not find ofPort for physical port {}", phyIfName);
1044             return;
1045         }
1046         LOG.debug("removeVlanRules: Identified eth port {} -> ofPort ({}) on {}",
1047                 phyIfName, ethOFPort, node);
1048
1049         removeRemoteEgressVlanRules(node, dpid, network.getProviderSegmentationID(),
1050                 attachedMac, localPort, ethOFPort);
1051         if (isLastInstanceOnNode) {
1052             removePerVlanRules(node, dpid, network.getProviderSegmentationID(), localPort, ethOFPort);
1053         }
1054     }
1055
1056     @Override
1057     public boolean handleInterfaceUpdate(NeutronNetwork network, Node srcNode,
1058                                          OvsdbTerminationPointAugmentation intf) {
1059         Preconditions.checkNotNull(nodeCacheManager);
1060         Map<org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId,Node> nodes =
1061                 nodeCacheManager.getOvsdbNodes();
1062         nodes.remove(southbound.extractBridgeOvsdbNodeId(srcNode));
1063         String networkType = network.getProviderNetworkType();
1064         String segmentationId = network.getProviderSegmentationID();
1065         Node srcBridgeNode = southbound.getBridgeNode(srcNode, configurationService.getIntegrationBridgeName());
1066         programLocalRules(networkType, network.getProviderSegmentationID(), srcBridgeNode, intf);
1067
1068         if (isVlan(networkType)) {
1069             programVlanRules(network, srcNode, intf);
1070         } else if (isTunnel(networkType)){
1071
1072             boolean sourceTunnelStatus;
1073             boolean destTunnelStatus = false;
1074             for (Node dstNode : nodes.values()) {
1075                 InetAddress src = configurationService.getTunnelEndPoint(srcNode);
1076                 InetAddress dst = configurationService.getTunnelEndPoint(dstNode);
1077                 if ((src != null) && (dst != null)) {
1078                     sourceTunnelStatus = addTunnelPort(srcBridgeNode, networkType, src, dst);
1079
1080                     Node dstBridgeNode = southbound.getBridgeNode(dstNode,
1081                             configurationService.getIntegrationBridgeName());
1082
1083                     if(dstBridgeNode != null){
1084                         destTunnelStatus = addTunnelPort(dstBridgeNode, networkType, dst, src);
1085                     }
1086
1087                     if (sourceTunnelStatus) {
1088                         programTunnelRules(networkType, segmentationId, dst, srcBridgeNode, intf, true);
1089                     }
1090                     if (destTunnelStatus) {
1091                         programTunnelRules(networkType, segmentationId, src, dstBridgeNode, intf, false);
1092                     }
1093                 } else {
1094                     LOG.warn("Tunnel end-point configuration missing. Please configure it in OpenVSwitch Table. "
1095                                     + "Check source {} or destination {}",
1096                             src != null ? src.getHostAddress() : "null",
1097                             dst != null ? dst.getHostAddress() : "null");
1098                 }
1099             }
1100         }
1101
1102         return true;
1103     }
1104
1105     private void triggerInterfaceUpdates(Node node) {
1106         LOG.debug("enter triggerInterfaceUpdates for {}", node.getNodeId());
1107         List<OvsdbTerminationPointAugmentation> ports = southbound.extractTerminationPointAugmentations(node);
1108         if (ports != null && !ports.isEmpty()) {
1109             for (OvsdbTerminationPointAugmentation port : ports) {
1110                 NeutronNetwork neutronNetwork = tenantNetworkManager.getTenantNetwork(port);
1111                 if (neutronNetwork != null) {
1112                     LOG.warn("Trigger Interface update for {}", port);
1113                     handleInterfaceUpdate(neutronNetwork, node, port);
1114                 }
1115             }
1116         } else {
1117             LOG.warn("triggerInterfaceUpdates: tps are null");
1118         }
1119         LOG.debug("exit triggerInterfaceUpdates for {}", node.getNodeId());
1120     }
1121
1122     @Override
1123     public boolean handleInterfaceDelete(String tunnelType, NeutronNetwork network, Node srcNode,
1124                                          OvsdbTerminationPointAugmentation intf, boolean isLastInstanceOnNode) {
1125         Map<org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId,Node> nodes =
1126                 nodeCacheManager.getOvsdbNodes();
1127         nodes.remove(southbound.extractBridgeOvsdbNodeId(srcNode));
1128
1129         LOG.info("Delete intf " + intf.getName() + " isLastInstanceOnNode " + isLastInstanceOnNode);
1130         List<String> phyIfName = bridgeConfigurationManager.getAllPhysicalInterfaceNames(srcNode);
1131         if (southbound.isTunnel(intf)) {
1132             // Delete tunnel port
1133             try {
1134                 InetAddress src = InetAddress.getByName(
1135                         southbound.getOptionsValue(intf.getOptions(), "local_ip"));
1136                 InetAddress dst = InetAddress.getByName(
1137                         southbound.getOptionsValue(intf.getOptions(), "remote_ip"));
1138                 deleteTunnelPort(srcNode,
1139                         MdsalHelper.createOvsdbInterfaceType(intf.getInterfaceType()),
1140                         src, dst);
1141             } catch (Exception e) {
1142                 LOG.error(e.getMessage(), e);
1143             }
1144         } else if (phyIfName.contains(intf.getName())) {
1145             deletePhysicalPort(srcNode, intf.getName());
1146         } else {
1147             // delete all other interfaces
1148             removeLocalRules(network.getProviderNetworkType(), network.getProviderSegmentationID(),
1149                     srcNode, intf);
1150
1151             if (isVlan(network.getProviderNetworkType())) {
1152                 removeVlanRules(network, srcNode, intf, isLastInstanceOnNode);
1153             } else if (isTunnel(network.getProviderNetworkType())) {
1154
1155                 for (Node dstNode : nodes.values()) {
1156                     InetAddress src = configurationService.getTunnelEndPoint(srcNode);
1157                     InetAddress dst = configurationService.getTunnelEndPoint(dstNode);
1158                     if ((src != null) && (dst != null)) {
1159                         LOG.info("Remove tunnel rules for interface "
1160                                 + intf.getName() + " on srcNode " + srcNode.getNodeId().getValue());
1161                         removeTunnelRules(tunnelType, network.getProviderSegmentationID(),
1162                                 dst, srcNode, intf, true, isLastInstanceOnNode);
1163                         Node dstBridgeNode = southbound.getBridgeNode(dstNode, Constants.INTEGRATION_BRIDGE);
1164                         if(dstBridgeNode != null){
1165                             LOG.info("Remove tunnel rules for interface "
1166                                     + intf.getName() + " on dstNode " + dstNode.getNodeId().getValue());
1167                             removeTunnelRules(tunnelType, network.getProviderSegmentationID(),
1168                                     src, dstBridgeNode, intf, false, isLastInstanceOnNode);
1169                         }
1170                     } else {
1171                         LOG.warn("Tunnel end-point configuration missing. Please configure it in "
1172                                         + "OpenVSwitch Table. "
1173                                         + "Check source {} or destination {}",
1174                                 src != null ? src.getHostAddress() : "null",
1175                                 dst != null ? dst.getHostAddress() : "null");
1176                     }
1177                 }
1178             }
1179         }
1180         return true;
1181     }
1182
1183     @Override
1184     public void initializeFlowRules(Node node) {
1185         initializeFlowRules(node, configurationService.getIntegrationBridgeName());
1186         initializeFlowRules(node, configurationService.getExternalBridgeName());
1187         triggerInterfaceUpdates(node);
1188     }
1189
1190     private void initializeFlowRules(Node node, String bridgeName) {
1191         Long dpid = southbound.getDataPathId(node);
1192         String datapathId = southbound.getDatapathId(node);
1193         LOG.info("initializeFlowRules: bridgeName: {}, dpid: {} - {}",
1194                 bridgeName, dpid, datapathId);
1195
1196         if (dpid == 0L) {
1197             LOG.debug("Openflow Datapath-ID not set for the integration bridge in {}", node);
1198             return;
1199         }
1200
1201         /*
1202          * Table(0) Rule #1
1203          * ----------------
1204          * Match: LLDP (0x88CCL)
1205          * Action: Packet_In to Controller Reserved Port
1206          */
1207
1208         writeLLDPRule(dpid);
1209
1210         if (bridgeName.equals(configurationService.getExternalBridgeName())) {
1211             writeNormalRule(dpid);
1212         }
1213     }
1214
1215     /*
1216      * Create an LLDP Flow Rule to encapsulate into
1217      * a packet_in that is sent to the controller
1218      * for topology handling.
1219      * Match: Ethertype 0x88CCL
1220      * Action: Punt to Controller in a Packet_In msg
1221      */
1222
1223     private void writeLLDPRule(Long dpidLong) {
1224         classifierProvider.programLLDPPuntRule(dpidLong);
1225     }
1226
1227     /*
1228      * Create a NORMAL Table Miss Flow Rule
1229      * Match: any
1230      * Action: forward to NORMAL pipeline
1231      */
1232
1233     private void writeNormalRule(Long dpidLong) {
1234
1235         String nodeName = Constants.OPENFLOW_NODE_PREFIX + dpidLong;
1236
1237         MatchBuilder matchBuilder = new MatchBuilder();
1238         NodeBuilder nodeBuilder = createNodeBuilder(nodeName);
1239         FlowBuilder flowBuilder = new FlowBuilder();
1240
1241         // Create the OF Actions and Instructions
1242         InstructionBuilder ib = new InstructionBuilder();
1243         InstructionsBuilder isb = new InstructionsBuilder();
1244
1245         // Instructions List Stores Individual Instructions
1246         List<Instruction> instructions = Lists.newArrayList();
1247
1248         // Call the InstructionBuilder Methods Containing Actions
1249         InstructionUtils.createNormalInstructions(nodeName, ib);
1250         ib.setOrder(0);
1251         ib.setKey(new InstructionKey(0));
1252         instructions.add(ib.build());
1253
1254         // Add InstructionBuilder to the Instruction(s)Builder List
1255         isb.setInstruction(instructions);
1256
1257         // Add InstructionsBuilder to FlowBuilder
1258         flowBuilder.setInstructions(isb.build());
1259
1260         String flowId = "NORMAL";
1261         flowBuilder.setId(new FlowId(flowId));
1262         FlowKey key = new FlowKey(new FlowId(flowId));
1263         flowBuilder.setMatch(matchBuilder.build());
1264         flowBuilder.setPriority(0);
1265         flowBuilder.setBarrier(true);
1266         flowBuilder.setTableId((short) 0);
1267         flowBuilder.setKey(key);
1268         flowBuilder.setFlowName(flowId);
1269         flowBuilder.setHardTimeout(0);
1270         flowBuilder.setIdleTimeout(0);
1271         writeFlow(flowBuilder, nodeBuilder);
1272     }
1273
1274     /*
1275      * (Table:0) Ingress Tunnel Traffic
1276      * Match: OpenFlow InPort and Tunnel ID
1277      * Action: GOTO Local Table (10)
1278      * table=0,tun_id=0x5,in_port=10, actions=goto_table:2
1279      */
1280
1281     private void handleTunnelIn(Long dpidLong, Short writeTable,
1282             Short goToTableId, String segmentationId,
1283             Long ofPort, boolean write) {
1284         classifierProvider.programTunnelIn(dpidLong, segmentationId, ofPort, write);
1285     }
1286
1287     /*
1288      * (Table:0) Ingress VLAN Traffic
1289      * Match: OpenFlow InPort and vlan ID
1290      * Action: GOTO Local Table (20)
1291      * table=0,vlan_id=0x5,in_port=10, actions=goto_table:2
1292      */
1293
1294     private void handleVlanIn(Long dpidLong, Short writeTable, Short goToTableId,
1295             String segmentationId,  Long ethPort, boolean write) {
1296         classifierProvider.programVlanIn(dpidLong, segmentationId, ethPort, write);
1297     }
1298
1299     /*
1300      * (Table:0) Egress VM Traffic Towards TEP
1301      * Match: Destination Ethernet Addr and OpenFlow InPort
1302      * Instruction: Set TunnelID and GOTO Table Tunnel Table (n)
1303      * table=0,in_port=2,dl_src=00:00:00:00:00:01 \
1304      * actions=set_field:5->tun_id,goto_table=1"
1305      */
1306
1307     private void handleLocalInPort(Long dpidLong, Short writeTable, Short goToTableId,
1308             String segmentationId, Long inPort, String attachedMac,
1309             boolean write) {
1310         classifierProvider.programLocalInPort(dpidLong, segmentationId, inPort, attachedMac, write);
1311     }
1312
1313     /*
1314      * (Table:0) Egress VM Traffic Towards TEP
1315      * Match: Source Ethernet Addr and OpenFlow InPort
1316      * Instruction: Set VLANID and GOTO Table Egress (n)
1317      * table=0,in_port=2,dl_src=00:00:00:00:00:01 \
1318      * actions=push_vlan, set_field:5->vlan_id,goto_table=1"
1319      */
1320
1321     private void handleLocalInPortSetVlan(Long dpidLong, Short writeTable,
1322             Short goToTableId, String segmentationId,
1323             Long inPort, String attachedMac,
1324             boolean write) {
1325         classifierProvider.programLocalInPortSetVlan(dpidLong, segmentationId, inPort, attachedMac, write);
1326     }
1327
1328     /*
1329      * (Table:0) Drop frames source from a VM that do not
1330      * match the associated MAC address of the local VM.
1331      * Match: Low priority anything not matching the VM SMAC
1332      * Instruction: Drop
1333      * table=0,priority=16384,in_port=1 actions=drop"
1334      */
1335
1336     private void handleDropSrcIface(Long dpidLong, Long inPort, boolean write) {
1337         classifierProvider.programDropSrcIface(dpidLong, inPort, write);
1338     }
1339
1340     /*
1341      * (Table:1) Egress Tunnel Traffic
1342      * Match: Destination Ethernet Addr and Local InPort
1343      * Instruction: Set TunnelID and GOTO Table Tunnel Table (n)
1344      * table=1,tun_id=0x5,dl_dst=00:00:00:00:00:08 \
1345      * actions=output:10,goto_table:2"
1346      */
1347     private void handleTunnelOut(Long dpidLong, Short writeTable,
1348             Short goToTableId, String segmentationId,
1349             Long OFPortOut, String attachedMac,
1350             boolean write) {
1351         l2ForwardingProvider.programTunnelOut(dpidLong, segmentationId, OFPortOut, attachedMac, write);
1352     }
1353
1354     /*
1355      * (Table:1) Egress VLAN Traffic
1356      * Match: Destination Ethernet Addr and VLAN id
1357      * Instruction: GOTO Table Table 2
1358      * table=1,vlan_id=0x5,dl_dst=00:00:00:00:00:08 \
1359      * actions= goto_table:2"
1360      */
1361     // TODO This method is referenced from commented code above (which needs to be checked)
1362     @SuppressWarnings("unused")
1363     private void handleVlanOut(Long dpidLong, Short writeTable,
1364             Short goToTableId, String segmentationId,
1365             Long ethPort, String attachedMac, boolean write) {
1366         l2ForwardingProvider.programVlanOut(dpidLong, segmentationId, ethPort, attachedMac, write);
1367     }
1368
1369     /*
1370      * (Table:1) Egress Tunnel Traffic
1371      * Match: Destination Ethernet Addr and Local InPort
1372      * Instruction: Set TunnelID and GOTO Table Tunnel Table (n)
1373      * table=1,priority=16384,tun_id=0x5,dl_dst=ff:ff:ff:ff:ff:ff \
1374      * actions=output:10,output:11,goto_table:2
1375      */
1376
1377     private void handleTunnelFloodOut(Long dpidLong, Short writeTable,
1378             Short localTable, String segmentationId,
1379             Long OFPortOut, boolean write) {
1380         l2ForwardingProvider.programTunnelFloodOut(dpidLong, segmentationId, OFPortOut, write);
1381     }
1382
1383     /*
1384      * (Table:1) Egress VLAN Traffic
1385      * Match: Destination Ethernet Addr and VLAN id
1386      * Instruction: GOTO table 2 and Output port eth interface
1387      * Example: table=1,priority=16384,vlan_id=0x5,dl_dst=ff:ff:ff:ff:ff:ff \
1388      * actions=output:eth1,goto_table:2
1389      */
1390     // TODO This method is referenced from commented code above (which needs to be checked)
1391     @SuppressWarnings("unused")
1392     private void handleVlanFloodOut(Long dpidLong, Short writeTable,
1393             Short localTable, String segmentationId,
1394             Long localPort, Long ethPort, boolean write) {
1395         //l2ForwardingProvider.programVlanFloodOut(dpidLong, segmentationId, localPort, ethPort, write);
1396     }
1397
1398     /*
1399      * (Table:1) Table Drain w/ Catch All
1400      * Match: Tunnel ID
1401      * Action: GOTO Local Table (10)
1402      * table=2,priority=8192,tun_id=0x5 actions=drop
1403      */
1404
1405     private void handleTunnelMiss(Long dpidLong, Short writeTable,
1406             Short goToTableId, String segmentationId,
1407             boolean write) {
1408         l2ForwardingProvider.programTunnelMiss(dpidLong, segmentationId, write);
1409     }
1410
1411
1412     /*
1413      * (Table:1) Table Drain w/ Catch All
1414      * Match: Vlan ID
1415      * Action: Output port eth interface
1416      * table=1,priority=8192,vlan_id=0x5 actions= output port:eth1
1417      * table=110,priority=8192,dl_vlan=2001 actions=output:2
1418      */
1419
1420     private void handleVlanMiss(Long dpidLong, Short writeTable,
1421             Short goToTableId, String segmentationId,
1422             Long ethPort, boolean write) {
1423         l2ForwardingProvider.programVlanMiss(dpidLong, segmentationId, ethPort, write);
1424     }
1425
1426     /*
1427      * (Table:1) Local Broadcast Flood
1428      * Match: Tunnel ID and dMAC
1429      * Action: Output Port
1430      * table=2,tun_id=0x5,dl_dst=00:00:00:00:00:01 actions=output:2
1431      */
1432
1433     private void handleLocalUcastOut(Long dpidLong, Short writeTable,
1434             String segmentationId, Long localPort,
1435             String attachedMac, boolean write) {
1436         l2ForwardingProvider.programLocalUcastOut(dpidLong, segmentationId, localPort, attachedMac, write);
1437     }
1438
1439     /*
1440      * (Table:2) Local VLAN unicast
1441      * Match: VLAN ID and dMAC
1442      * Action: Output Port
1443      * table=2,vlan_id=0x5,dl_dst=00:00:00:00:00:01 actions=output:2
1444      */
1445
1446     private void handleLocalVlanUcastOut(Long dpidLong, Short writeTable,
1447             String segmentationId, Long localPort,
1448             String attachedMac, boolean write) {
1449         l2ForwardingProvider.programLocalVlanUcastOut(dpidLong, segmentationId, localPort, attachedMac, write);
1450     }
1451
1452     /*
1453      * (Table:2) Local Broadcast Flood
1454      * Match: Tunnel ID and dMAC (::::FF:FF)
1455      * table=2,priority=16384,tun_id=0x5,dl_dst=ff:ff:ff:ff:ff:ff \
1456      * actions=output:2,3,4,5
1457      */
1458
1459     private void handleLocalBcastOut(Long dpidLong, Short writeTable,
1460             String segmentationId, Long localPort,
1461             boolean write) {
1462         l2ForwardingProvider.programLocalBcastOut(dpidLong, segmentationId, localPort, write);
1463     }
1464
1465     /*
1466      * (Table:2) Local VLAN Broadcast Flood
1467      * Match: vlan ID and dMAC (::::FF:FF)
1468      * table=2,priority=16384,vlan_id=0x5,dl_dst=ff:ff:ff:ff:ff:ff \
1469      * actions=strip_vlan, output:2,3,4,5
1470      * table=110,dl_vlan=2001,dl_dst=01:00:00:00:00:00/01:00:00:00:00:00 actions=output:2,pop_vlan,output:1,output:3,output:4
1471      */
1472
1473     private void handleLocalVlanBcastOut(Long dpidLong, Short writeTable, String segmentationId,
1474                                          Long localPort, Long ethPort, boolean write) {
1475         l2ForwardingProvider.programLocalVlanBcastOut(dpidLong, segmentationId, localPort, ethPort, write);
1476     }
1477
1478     /*
1479      * (Table:1) Local Table Miss
1480      * Match: Any Remaining Flows w/a TunID
1481      * Action: Drop w/ a low priority
1482      * table=2,priority=8192,tun_id=0x5 actions=drop
1483      */
1484
1485     private void handleLocalTableMiss(Long dpidLong, Short writeTable,
1486             String segmentationId, boolean write) {
1487         l2ForwardingProvider.programLocalTableMiss(dpidLong, segmentationId, write);
1488     }
1489
1490     /*
1491      * (Table:1) Local Table Miss
1492      * Match: Any Remaining Flows w/a VLAN ID
1493      * Action: Drop w/ a low priority
1494      * table=2,priority=8192,vlan_id=0x5 actions=drop
1495      */
1496     // TODO This method is referenced from commented code above (which needs to be checked)
1497     @SuppressWarnings("unused")
1498     private void handleLocalVlanTableMiss(Long dpidLong, Short writeTable,
1499             String segmentationId, boolean write) {
1500         l2ForwardingProvider.programLocalVlanTableMiss(dpidLong, segmentationId, write);
1501     }
1502
1503     private Group getGroup(GroupBuilder groupBuilder, NodeBuilder nodeBuilder) {
1504         InstanceIdentifier<Group> path1 = InstanceIdentifier.builder(Nodes.class).child(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory
1505                 .rev130819.nodes.Node.class, nodeBuilder.getKey()).augmentation(FlowCapableNode.class).child(Group.class,
1506                         new GroupKey(groupBuilder.getGroupId())).build();
1507         ReadOnlyTransaction readTx = dataBroker.newReadOnlyTransaction();
1508         try {
1509             Optional<Group> data = readTx.read(LogicalDatastoreType.CONFIGURATION, path1).get();
1510             if (data.isPresent()) {
1511                 return data.get();
1512             }
1513         } catch (InterruptedException|ExecutionException e) {
1514             LOG.error(e.getMessage(), e);
1515         }
1516
1517         LOG.debug("Cannot find data for Group " + groupBuilder.getGroupName());
1518         return null;
1519     }
1520
1521     private void writeGroup(GroupBuilder groupBuilder, NodeBuilder nodeBuilder) {
1522         ReadWriteTransaction modification = dataBroker.newReadWriteTransaction();
1523         InstanceIdentifier<Group> path1 = InstanceIdentifier.builder(Nodes.class).child(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory
1524                 .rev130819.nodes.Node.class, nodeBuilder.getKey()).augmentation(FlowCapableNode.class).child(Group.class,
1525                         new GroupKey(groupBuilder.getGroupId())).build();
1526         modification.put(LogicalDatastoreType.CONFIGURATION, path1, groupBuilder.build(), true /*createMissingParents*/);
1527
1528         CheckedFuture<Void, TransactionCommitFailedException> commitFuture = modification.submit();
1529         try {
1530             commitFuture.get();  // TODO: Make it async (See bug 1362)
1531             LOG.debug("Transaction success for write of Group " + groupBuilder.getGroupName());
1532         } catch (InterruptedException|ExecutionException e) {
1533             LOG.error(e.getMessage(), e);
1534         }
1535     }
1536
1537     private void removeGroup(GroupBuilder groupBuilder, NodeBuilder nodeBuilder) {
1538         WriteTransaction modification = dataBroker.newWriteOnlyTransaction();
1539         InstanceIdentifier<Group> path1 = InstanceIdentifier.builder(Nodes.class).child(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory
1540                 .rev130819.nodes.Node.class, nodeBuilder.getKey()).augmentation(FlowCapableNode.class).child(Group.class,
1541                         new GroupKey(groupBuilder.getGroupId())).build();
1542         modification.delete(LogicalDatastoreType.CONFIGURATION, path1);
1543         CheckedFuture<Void, TransactionCommitFailedException> commitFuture = modification.submit();
1544
1545         try {
1546             commitFuture.get();  // TODO: Make it async (See bug 1362)
1547             LOG.debug("Transaction success for deletion of Group " + groupBuilder.getGroupName());
1548         } catch (InterruptedException|ExecutionException e) {
1549             LOG.error(e.getMessage(), e);
1550         }
1551     }
1552
1553     private void writeFlow(FlowBuilder flowBuilder, NodeBuilder nodeBuilder) {
1554         ReadWriteTransaction modification = dataBroker.newReadWriteTransaction();
1555         InstanceIdentifier<Flow> path1 =
1556                 InstanceIdentifier.builder(Nodes.class).child(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory
1557                                 .rev130819.nodes.Node.class,
1558                         nodeBuilder.getKey()).augmentation(FlowCapableNode.class).child(Table.class,
1559                         new TableKey(flowBuilder.getTableId())).child(Flow.class, flowBuilder.getKey()).build();
1560
1561         //modification.put(LogicalDatastoreType.OPERATIONAL, path1, flowBuilder.build());
1562         modification.put(LogicalDatastoreType.CONFIGURATION, path1, flowBuilder.build(),
1563                 true);//createMissingParents
1564
1565
1566         CheckedFuture<Void, TransactionCommitFailedException> commitFuture = modification.submit();
1567         try {
1568             commitFuture.get();  // TODO: Make it async (See bug 1362)
1569             LOG.debug("Transaction success for write of Flow " + flowBuilder.getFlowName());
1570         } catch (InterruptedException|ExecutionException e) {
1571             LOG.error(e.getMessage(), e);
1572         }
1573     }
1574
1575     /**
1576      * Create Output Port Group Instruction
1577      *
1578      * @param ib       Map InstructionBuilder without any instructions
1579      * @param dpidLong Long the datapath ID of a switch/node
1580      * @param port     Long representing a port on a switch/node
1581      * @return ib InstructionBuilder Map with instructions
1582      */
1583     // TODO This method is referenced from commented code in L2ForwardingService (which needs to be checked)
1584     @SuppressWarnings("unused")
1585     protected InstructionBuilder createOutputGroupInstructions(NodeBuilder nodeBuilder,
1586             InstructionBuilder ib,
1587             Long dpidLong, Long port ,
1588             List<Instruction> instructions) {
1589         NodeConnectorId ncid = new NodeConnectorId(Constants.OPENFLOW_NODE_PREFIX + dpidLong + ":" + port);
1590         LOG.debug("createOutputGroupInstructions() Node Connector ID is - Type=openflow: DPID={} port={} existingInstructions={}", dpidLong, port, instructions);
1591
1592         List<Action> actionList = Lists.newArrayList();
1593         ActionBuilder ab = new ActionBuilder();
1594
1595         List<Action> existingActions;
1596         if (instructions != null) {
1597             for (Instruction in : instructions) {
1598                 if (in.getInstruction() instanceof ApplyActionsCase) {
1599                     existingActions = (((ApplyActionsCase) in.getInstruction()).getApplyActions().getAction());
1600                     actionList.addAll(existingActions);
1601                 }
1602             }
1603         }
1604
1605         GroupBuilder groupBuilder = new GroupBuilder();
1606         Group group = null;
1607
1608         /* Create output action for this port*/
1609         OutputActionBuilder oab = new OutputActionBuilder();
1610         oab.setOutputNodeConnector(ncid);
1611         ab.setAction(new OutputActionCaseBuilder().setOutputAction(oab.build()).build());
1612         LOG.debug("createOutputGroupInstructions(): output action {}", ab.build());
1613         boolean addNew = true;
1614         boolean groupActionAdded = false;
1615
1616         /* Find the group action and get the group */
1617         for (Action action : actionList) {
1618             if (action.getAction() instanceof GroupActionCase) {
1619                 groupActionAdded = true;
1620                 GroupActionCase groupAction = (GroupActionCase) action.getAction();
1621                 Long id = groupAction.getGroupAction().getGroupId();
1622                 String groupName = groupAction.getGroupAction().getGroup();
1623                 GroupKey key = new GroupKey(new GroupId(id));
1624
1625                 groupBuilder.setGroupId(new GroupId(id));
1626                 groupBuilder.setGroupName(groupName);
1627                 groupBuilder.setGroupType(GroupTypes.GroupAll);
1628                 groupBuilder.setKey(key);
1629                 group = getGroup(groupBuilder, nodeBuilder);
1630                 LOG.debug("createOutputGroupInstructions: group {}", group);
1631                 break;
1632             }
1633         }
1634
1635         LOG.debug("createOutputGroupInstructions: groupActionAdded {}", groupActionAdded);
1636         if (groupActionAdded) {
1637             /* modify the action bucket in group */
1638             groupBuilder = new GroupBuilder(group);
1639             Buckets buckets = groupBuilder.getBuckets();
1640             for (Bucket bucket : buckets.getBucket()) {
1641                 List<Action> bucketActions = bucket.getAction();
1642                 LOG.debug("createOutputGroupInstructions: bucketActions {}", bucketActions);
1643                 for (Action action : bucketActions) {
1644                     if (action.getAction() instanceof OutputActionCase) {
1645                         OutputActionCase opAction = (OutputActionCase)action.getAction();
1646                         /* If output port action already in the action list of one of the buckets, skip */
1647                         if (opAction.getOutputAction().getOutputNodeConnector().equals(new Uri(ncid))) {
1648                             addNew = false;
1649                             break;
1650                         }
1651                     }
1652                 }
1653             }
1654             LOG.debug("createOutputGroupInstructions: addNew {}", addNew);
1655             if (addNew) {
1656                 /* the new output action is not in the bucket, add to bucket */
1657                 if (!buckets.getBucket().isEmpty()) {
1658                     Bucket bucket = buckets.getBucket().get(0);
1659                     List<Action> bucketActionList = Lists.newArrayList();
1660                     bucketActionList.addAll(bucket.getAction());
1661                     /* set order for new action and add to action list */
1662                     ab.setOrder(bucketActionList.size());
1663                     ab.setKey(new ActionKey(bucketActionList.size()));
1664                     bucketActionList.add(ab.build());
1665
1666                     /* set bucket and buckets list. Reset groupBuilder with new buckets.*/
1667                     BucketsBuilder bucketsBuilder = new BucketsBuilder();
1668                     List<Bucket> bucketList = Lists.newArrayList();
1669                     BucketBuilder bucketBuilder = new BucketBuilder();
1670                     bucketBuilder.setBucketId(new BucketId((long) 1));
1671                     bucketBuilder.setKey(new BucketKey(new BucketId((long) 1)));
1672                     bucketBuilder.setAction(bucketActionList);
1673                     bucketList.add(bucketBuilder.build());
1674                     bucketsBuilder.setBucket(bucketList);
1675                     groupBuilder.setBuckets(bucketsBuilder.build());
1676                     LOG.debug("createOutputGroupInstructions: bucketList {}", bucketList);
1677                 }
1678             }
1679         } else {
1680             /* create group */
1681             groupBuilder = new GroupBuilder();
1682             groupBuilder.setGroupType(GroupTypes.GroupAll);
1683             groupBuilder.setGroupId(new GroupId(groupId));
1684             groupBuilder.setKey(new GroupKey(new GroupId(groupId)));
1685             groupBuilder.setGroupName("Output port group " + groupId);
1686             groupBuilder.setBarrier(false);
1687
1688             BucketsBuilder bucketBuilder = new BucketsBuilder();
1689             List<Bucket> bucketList = Lists.newArrayList();
1690             BucketBuilder bucket = new BucketBuilder();
1691             bucket.setBucketId(new BucketId((long) 1));
1692             bucket.setKey(new BucketKey(new BucketId((long) 1)));
1693
1694             /* put output action to the bucket */
1695             List<Action> bucketActionList = Lists.newArrayList();
1696             /* set order for new action and add to action list */
1697             ab.setOrder(bucketActionList.size());
1698             ab.setKey(new ActionKey(bucketActionList.size()));
1699             bucketActionList.add(ab.build());
1700
1701             bucket.setAction(bucketActionList);
1702             bucketList.add(bucket.build());
1703             bucketBuilder.setBucket(bucketList);
1704             groupBuilder.setBuckets(bucketBuilder.build());
1705
1706             /* Add new group action */
1707             GroupActionBuilder groupActionB = new GroupActionBuilder();
1708             groupActionB.setGroupId(groupId);
1709             groupActionB.setGroup("Output port group " + groupId);
1710             ab = new ActionBuilder();
1711             ab.setAction(new GroupActionCaseBuilder().setGroupAction(groupActionB.build()).build());
1712             ab.setOrder(actionList.size());
1713             ab.setKey(new ActionKey(actionList.size()));
1714             actionList.add(ab.build());
1715
1716             groupId++;
1717         }
1718         LOG.debug("createOutputGroupInstructions: group {}", groupBuilder.build());
1719         LOG.debug("createOutputGroupInstructions: actionList {}", actionList);
1720
1721         if (addNew) {
1722             /* rewrite the group to group table */
1723             writeGroup(groupBuilder, nodeBuilder);
1724         }
1725
1726         // Create an Apply Action
1727         ApplyActionsBuilder aab = new ApplyActionsBuilder();
1728         aab.setAction(actionList);
1729         ib.setInstruction(new ApplyActionsCaseBuilder().setApplyActions(aab.build()).build());
1730
1731         return ib;
1732     }
1733
1734     /**
1735      * Remove Output Port from action list in group bucket
1736      *
1737      * @param ib       Map InstructionBuilder without any instructions
1738      * @param dpidLong Long the datapath ID of a switch/node
1739      * @param port     Long representing a port on a switch/node
1740      * @return ib InstructionBuilder Map with instructions
1741      */
1742     // TODO This method is referenced from commented code in L2ForwardingService (which needs to be checked)
1743     @SuppressWarnings("unused")
1744     protected boolean removeOutputPortFromGroup(NodeBuilder nodeBuilder, InstructionBuilder ib,
1745             Long dpidLong, Long port , List<Instruction> instructions) {
1746
1747         NodeConnectorId ncid = new NodeConnectorId(Constants.OPENFLOW_NODE_PREFIX + dpidLong + ":" + port);
1748         LOG.debug("removeOutputPortFromGroup() Node Connector ID is - Type=openflow: DPID={} port={} existingInstructions={}", dpidLong, port, instructions);
1749
1750         List<Action> actionList = Lists.newArrayList();
1751         ActionBuilder ab;
1752
1753         List<Action> existingActions;
1754         if (instructions != null) {
1755             for (Instruction in : instructions) {
1756                 if (in.getInstruction() instanceof ApplyActionsCase) {
1757                     existingActions = (((ApplyActionsCase) in.getInstruction()).getApplyActions().getAction());
1758                     actionList.addAll(existingActions);
1759                     break;
1760                 }
1761             }
1762         }
1763
1764         GroupBuilder groupBuilder = new GroupBuilder();
1765         Group group = null;
1766         boolean groupActionAdded = false;
1767         /* Find the group action and get the group */
1768         for (Action action : actionList) {
1769             if (action.getAction() instanceof GroupActionCase) {
1770                 groupActionAdded = true;
1771                 GroupActionCase groupAction = (GroupActionCase) action.getAction();
1772                 Long id = groupAction.getGroupAction().getGroupId();
1773                 String groupName = groupAction.getGroupAction().getGroup();
1774                 GroupKey key = new GroupKey(new GroupId(id));
1775
1776                 groupBuilder.setGroupId(new GroupId(id));
1777                 groupBuilder.setGroupName(groupName);
1778                 groupBuilder.setGroupType(GroupTypes.GroupAll);
1779                 groupBuilder.setKey(key);
1780                 group = getGroup(groupBuilder, nodeBuilder);
1781                 break;
1782             }
1783         }
1784
1785         if (groupActionAdded) {
1786             /* modify the action bucket in group */
1787             groupBuilder = new GroupBuilder(group);
1788             Buckets buckets = groupBuilder.getBuckets();
1789             List<Action> bucketActions = Lists.newArrayList();
1790             for (Bucket bucket : buckets.getBucket()) {
1791                 int index = 0;
1792                 boolean isPortDeleted = false;
1793                 bucketActions = bucket.getAction();
1794                 for (Action action : bucketActions) {
1795                     if (action.getAction() instanceof OutputActionCase) {
1796                         OutputActionCase opAction = (OutputActionCase)action.getAction();
1797                         if (opAction.getOutputAction().getOutputNodeConnector().equals(new Uri(ncid))) {
1798                             /* Find the output port in action list and remove */
1799                             index = bucketActions.indexOf(action);
1800                             bucketActions.remove(action);
1801                             isPortDeleted = true;
1802                             break;
1803                         }
1804                     }
1805                 }
1806                 if (isPortDeleted && !bucketActions.isEmpty()) {
1807                     for (int i = index; i< bucketActions.size(); i++) {
1808                         Action action = bucketActions.get(i);
1809                         if (action.getOrder() != i) {
1810                             /* Shift the action order */
1811                             ab = new ActionBuilder();
1812                             ab.setAction(action.getAction());
1813                             ab.setOrder(i);
1814                             ab.setKey(new ActionKey(i));
1815                             Action actionNewOrder = ab.build();
1816                             bucketActions.remove(action);
1817                             bucketActions.add(i, actionNewOrder);
1818                         }
1819                     }
1820
1821                 } else if (bucketActions.isEmpty()) {
1822                     /* remove bucket with empty action list */
1823                     buckets.getBucket().remove(bucket);
1824                     break;
1825                 }
1826             }
1827             if (!buckets.getBucket().isEmpty()) {
1828                 /* rewrite the group to group table */
1829                 /* set bucket and buckets list. Reset groupBuilder with new buckets.*/
1830                 BucketsBuilder bucketsBuilder = new BucketsBuilder();
1831                 List<Bucket> bucketList = Lists.newArrayList();
1832                 BucketBuilder bucketBuilder = new BucketBuilder();
1833                 bucketBuilder.setBucketId(new BucketId((long) 1));
1834                 bucketBuilder.setKey(new BucketKey(new BucketId((long) 1)));
1835                 bucketBuilder.setAction(bucketActions);
1836                 bucketList.add(bucketBuilder.build());
1837                 bucketsBuilder.setBucket(bucketList);
1838                 groupBuilder.setBuckets(bucketsBuilder.build());
1839                 LOG.debug("removeOutputPortFromGroup: bucketList {}", bucketList);
1840
1841                 writeGroup(groupBuilder, nodeBuilder);
1842                 ApplyActionsBuilder aab = new ApplyActionsBuilder();
1843                 aab.setAction(actionList);
1844                 ib.setInstruction(new ApplyActionsCaseBuilder().setApplyActions(aab.build()).build());
1845                 return false;
1846             } else {
1847                 /* remove group with empty bucket. return true to delete flow */
1848                 removeGroup(groupBuilder, nodeBuilder);
1849                 return true;
1850             }
1851         } else {
1852             /* no group for port list. flow can be removed */
1853             return true;
1854         }
1855     }
1856
1857     @Override
1858     public void initializeOFFlowRules(Node openflowNode) {
1859         String bridgeName = southbound.getBridgeName(openflowNode);
1860         LOG.info("initializeOFFlowRules: bridgeName: {}", bridgeName);
1861         if (bridgeName.equals(configurationService.getIntegrationBridgeName())) {
1862             initializeFlowRules(openflowNode, configurationService.getIntegrationBridgeName());
1863             triggerInterfaceUpdates(openflowNode);
1864         } else if (bridgeName.equals(configurationService.getExternalBridgeName())) {
1865             initializeFlowRules(openflowNode, configurationService.getExternalBridgeName());
1866             LOG.info("initializeOFFlowRules after writeFlow: bridgeName: {}", bridgeName);
1867             triggerInterfaceUpdates(openflowNode);
1868             LOG.info("initializeOFFlowRules after triggerUpdates: bridgeName: {}", bridgeName);
1869         }
1870     }
1871
1872     public static NodeBuilder createNodeBuilder(String nodeId) {
1873         NodeBuilder builder = new NodeBuilder();
1874         builder.setId(new NodeId(nodeId));
1875         builder.setKey(new NodeKey(builder.getId()));
1876         return builder;
1877     }
1878
1879     @Override
1880     public void setDependencies(BundleContext bundleContext, ServiceReference serviceReference) {
1881         this.bundleContext = bundleContext;
1882         configurationService =
1883                 (ConfigurationService) ServiceHelper.getGlobalInstance(ConfigurationService.class, this);
1884         tenantNetworkManager =
1885                 (TenantNetworkManager) ServiceHelper.getGlobalInstance(TenantNetworkManager.class, this);
1886         bridgeConfigurationManager =
1887                 (BridgeConfigurationManager) ServiceHelper.getGlobalInstance(BridgeConfigurationManager.class, this);
1888         nodeCacheManager =
1889                 (NodeCacheManager) ServiceHelper.getGlobalInstance(NodeCacheManager.class, this);
1890         classifierProvider =
1891                 (ClassifierProvider) ServiceHelper.getGlobalInstance(ClassifierProvider.class, this);
1892         ingressAclProvider =
1893                 (IngressAclProvider) ServiceHelper.getGlobalInstance(IngressAclProvider.class, this);
1894         egressAclProvider =
1895                 (EgressAclProvider) ServiceHelper.getGlobalInstance(EgressAclProvider.class, this);
1896         l2ForwardingProvider =
1897                 (L2ForwardingProvider) ServiceHelper.getGlobalInstance(L2ForwardingProvider.class, this);
1898         securityServicesManager =
1899                 (SecurityServicesManager) ServiceHelper.getGlobalInstance(SecurityServicesManager.class, this);
1900         southbound =
1901                 (Southbound) ServiceHelper.getGlobalInstance(Southbound.class, this);
1902     }
1903
1904     @Override
1905     public void setDependencies(Object impl) {
1906         if (impl instanceof NetworkingProviderManager) {
1907             NetworkingProviderManager networkingProviderManager = (NetworkingProviderManager) impl;
1908             networkingProviderManager.providerAdded(
1909                     bundleContext.getServiceReference(NetworkingProvider.class.getName()), this);
1910         }
1911     }
1912 }