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

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