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