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