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