renderers/vpp/src/main/java/org/opendaylight/groupbasedpolicy/renderer/vpp/policy/ForwardingManager.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.groupbasedpolicy.renderer.vpp.policy;
  10
  11 import java.util.ArrayList;
  12 import java.util.HashMap;
  13 import java.util.List;
  14 import java.util.Map;
  15 import java.util.Set;
  16 import java.util.concurrent.ExecutionException;
  17 import java.util.concurrent.TimeUnit;
  18 import java.util.concurrent.TimeoutException;
  19
  20 import javax.annotation.Nonnull;
  21 import javax.annotation.Nullable;
  22
  23 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  24 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  25 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  26 import org.opendaylight.groupbasedpolicy.renderer.vpp.api.BridgeDomainManager;
  27 import org.opendaylight.groupbasedpolicy.renderer.vpp.commands.DhcpRelayCommand;
  28 import org.opendaylight.groupbasedpolicy.renderer.vpp.commands.NatInstanceCommand.NatInstanceCommandBuilder;
  29 import org.opendaylight.groupbasedpolicy.renderer.vpp.commands.RoutingCommand;
  30 import org.opendaylight.groupbasedpolicy.renderer.vpp.config.ConfigUtil;
  31 import org.opendaylight.groupbasedpolicy.renderer.vpp.dhcp.DhcpRelayHandler;
  32 import org.opendaylight.groupbasedpolicy.renderer.vpp.iface.InterfaceManager;
  33 import org.opendaylight.groupbasedpolicy.renderer.vpp.lisp.LispStateManager;
  34 import org.opendaylight.groupbasedpolicy.renderer.vpp.lisp.flat.overlay.FlatOverlayManager;
  35 import org.opendaylight.groupbasedpolicy.renderer.vpp.lisp.loopback.LoopbackManager;
  36 import org.opendaylight.groupbasedpolicy.renderer.vpp.lisp.mappers.NeutronTenantToVniMapper;
  37 import org.opendaylight.groupbasedpolicy.renderer.vpp.nat.NatManager;
  38 import org.opendaylight.groupbasedpolicy.renderer.vpp.nat.NatUtil;
  39 import org.opendaylight.groupbasedpolicy.renderer.vpp.policy.acl.AclManager;
  40 import org.opendaylight.groupbasedpolicy.renderer.vpp.routing.RoutingManager;
  41 import org.opendaylight.groupbasedpolicy.renderer.vpp.util.General;
  42 import org.opendaylight.groupbasedpolicy.renderer.vpp.util.KeyFactory;
  43 import org.opendaylight.groupbasedpolicy.util.DataStoreHelper;
  44 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix;
  45 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.nat.rev150908.nat.config.nat.instances.nat.instance.mapping.table.MappingEntryBuilder;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.base_endpoint.rev160427.common.endpoint.fields.NetworkContainment;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.base_endpoint.rev160427.common.endpoint.fields.network.containment.Containment;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.base_endpoint.rev160427.common.endpoint.fields.network.containment.containment.ForwardingContextContainment;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.base_endpoint.rev160427.common.endpoint.fields.network.containment.containment.NetworkDomainContainment;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.base_endpoint.rev160427.has.absolute.location.absolute.location.LocationType;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.base_endpoint.rev160427.has.absolute.location.absolute.location.location.type.ExternalLocationCase;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.base_endpoint.rev160427.has.child.endpoints.ChildEndpoint;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.base_endpoint.rev160427.parent.child.endpoints.ParentEndpointChoice;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.base_endpoint.rev160427.parent.child.endpoints.parent.endpoint.choice.ParentEndpointCase;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.base_endpoint.rev160427.parent.child.endpoints.parent.endpoint.choice.parent.endpoint._case.ParentEndpoint;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.ContextId;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.NetworkDomainId;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.common.rev140421.TenantId;
  59 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.l2_l3.rev170511.IpPrefixType;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.l2_l3.rev170511.L2FloodDomain;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.l2_l3.rev170511.MacAddressType;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.l2_l3.rev170511.SubnetAugmentRenderer;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.rev160427.NetworkDomain;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.rev160427.forwarding.fields.Parent;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.NatAddressRenderer;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.RendererPolicy;
  67 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.renderer.policy.Configuration;
  68 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.renderer.policy.configuration.Endpoints;
  69 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.renderer.policy.configuration.RendererForwarding;
  70 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.renderer.policy.configuration.endpoints.AddressEndpointWithLocation;
  71 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.renderer.policy.configuration.renderer.endpoints.RendererEndpointKey;
  72 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.renderer.policy.configuration.renderer.forwarding.RendererForwardingByTenant;
  73 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.renderer.policy.configuration.renderer.forwarding.renderer.forwarding.by.tenant.RendererForwardingContext;
  74 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.renderer.policy.configuration.renderer.forwarding.renderer.forwarding.by.tenant.RendererForwardingContextKey;
  75 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.renderer.policy.configuration.renderer.forwarding.renderer.forwarding.by.tenant.RendererNetworkDomain;
  76 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.renderer.policy.configuration.renderer.forwarding.renderer.forwarding.by.tenant.RendererNetworkDomainKey;
  77 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_renderer.rev160425.Config;
  78 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_renderer.rev160425.VlanNetwork;
  79 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_renderer.rev160425._interface.attributes.InterfaceTypeChoice;
  80 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_renderer.rev160425._interface.attributes._interface.type.choice.LoopbackCase;
  81 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_renderer.rev160425.config.GbpBridgeDomain;
  82 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_renderer.rev160425.config.GbpBridgeDomainKey;
  83 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_renderer.rev160425.config.VppEndpoint;
  84 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_renderer.rev160425.config.VppEndpointKey;
  85 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.vpp_renderer.rev160425.renderers.renderer.renderer.nodes.renderer.node.PhysicalInterface;
  86 import org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId;
  87 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.VxlanVni;
  88 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  89 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  90 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  91 import org.slf4j.Logger;
  92 import org.slf4j.LoggerFactory;
  93
  94 import com.google.common.annotations.VisibleForTesting;
  95 import com.google.common.base.Optional;
  96 import com.google.common.base.Preconditions;
  97 import com.google.common.base.Predicate;
  98 import com.google.common.base.Strings;
  99 import com.google.common.collect.HashBasedTable;
 100 import com.google.common.collect.ImmutableTable;
 101 import com.google.common.collect.Lists;
 102 import com.google.common.collect.SetMultimap;
 103 import com.google.common.collect.Table;
 104
 105 public final class ForwardingManager {
 106
 107     private static final Logger LOG = LoggerFactory.getLogger(ForwardingManager.class);
 108     @VisibleForTesting
 109     private byte WAIT_FOR_BD_PROCESSING = 60; // seconds
 110     private long lastVxlanVni = 1L;
 111     private final Map<String, VxlanVni> vxlanVniByBridgeDomain = new HashMap<>();
 112     private final InterfaceManager ifaceManager;
 113     private final AclManager aclManager;
 114     private final BridgeDomainManager bdManager;
 115     private final NatManager natManager;
 116     private final RoutingManager routingManager;
 117     private final LispStateManager lispStateManager;
 118     private final LoopbackManager loopbackManager;
 119     private final FlatOverlayManager flatOverlayManager;
 120     private final DhcpRelayHandler dhcpRelayHandler;
 121     private final DataBroker dataBroker;
 122
 123     public ForwardingManager(@Nonnull InterfaceManager ifaceManager, @Nonnull AclManager aclManager,
 124                              @Nonnull NatManager natManager, @Nonnull RoutingManager routingManager,
 125                              @Nonnull BridgeDomainManager bdManager, @Nonnull LispStateManager lispStateManager,
 126                              @Nonnull LoopbackManager loopbackManager, @Nonnull FlatOverlayManager flatOverlayManager,
 127                              @Nonnull DhcpRelayHandler dhcpRelayHandler, @Nonnull DataBroker dataBroker) {
 128         this.ifaceManager = Preconditions.checkNotNull(ifaceManager);
 129         this.bdManager = Preconditions.checkNotNull(bdManager);
 130         this.natManager = Preconditions.checkNotNull(natManager);
 131         this.routingManager = Preconditions.checkNotNull(routingManager);
 132         this.lispStateManager = Preconditions.checkNotNull(lispStateManager);
 133         this.loopbackManager = Preconditions.checkNotNull(loopbackManager);
 134         this.flatOverlayManager = Preconditions.checkNotNull(flatOverlayManager);
 135         this.dataBroker = Preconditions.checkNotNull(dataBroker);
 136         this.aclManager = Preconditions.checkNotNull(aclManager);
 137         this.dhcpRelayHandler = Preconditions.checkNotNull(dhcpRelayHandler);
 138     }
 139
 140     Optional<GbpBridgeDomain> readGbpBridgeDomainConfig(String name) {
 141         InstanceIdentifier<GbpBridgeDomain> bdIid = InstanceIdentifier.builder(Config.class)
 142             .child(GbpBridgeDomain.class, new GbpBridgeDomainKey(name))
 143             .build();
 144         ReadOnlyTransaction rTx = dataBroker.newReadOnlyTransaction();
 145         Optional<GbpBridgeDomain> optBd = DataStoreHelper.readFromDs(LogicalDatastoreType.CONFIGURATION, bdIid, rTx);
 146         rTx.close();
 147         return optBd;
 148     }
 149
 150     void createBridgeDomainOnNodes(SetMultimap<String, NodeId> vppNodesByBridgeDomain) {
 151         for (String bd : vppNodesByBridgeDomain.keySet()) {
 152             Optional<GbpBridgeDomain> bdConfig = readGbpBridgeDomainConfig(bd);
 153             Set<NodeId> vppNodes = vppNodesByBridgeDomain.get(bd);
 154             if (bdConfig.isPresent()) {
 155                 if (bdConfig.get().getType().equals(VlanNetwork.class)) {
 156                     createVlanBridgeDomains(bd, bdConfig.get().getVlan(), vppNodes);
 157                 }
 158             } else {
 159                 VxlanVni vxlanVni = vxlanVniByBridgeDomain.get(bd);
 160                 if (vxlanVni == null) {
 161                     vxlanVni = new VxlanVni(lastVxlanVni++);
 162                     vxlanVniByBridgeDomain.put(bd, vxlanVni);
 163                 }
 164                 createVxlanBridgeDomains(bd, vxlanVni, vppNodes);
 165             }
 166         }
 167     }
 168
 169     private void createVxlanBridgeDomains(final String bd, final VxlanVni vni, final Set<NodeId> vppNodes) {
 170         for (NodeId vppNode : vppNodes) {
 171             try {
 172                 LOG.debug("Creating VXLAN bridge-domain {} on node {} with VNI {}", bd, vppNode.getValue(),
 173                         vni);
 174                 bdManager.createVxlanBridgeDomainOnVppNode(bd, vni, vppNode).get(WAIT_FOR_BD_PROCESSING,
 175                         TimeUnit.SECONDS);
 176             } catch (InterruptedException | ExecutionException e) {
 177                 LOG.warn("VXLAN Bridge domain {} was not created on node {}", bd, vppNode.getValue(), e);
 178             } catch (TimeoutException e) {
 179                 LOG.warn("Probably, VXLAN Bridge domain {} was not created on node {} because BridgeDomainManager "
 180                         + "did not respond by {} seconds. Check VBD log for more details",
 181                         bd, vppNode.getValue(), WAIT_FOR_BD_PROCESSING, e);
 182             }
 183         }
 184     }
 185
 186     private void createVlanBridgeDomains(final String bd, final VlanId vlanId, final Set<NodeId> vppNodes) {
 187         for (NodeId vppNode : vppNodes) {
 188             try {
 189                 LOG.debug("Creating VLAN bridge-domain {} on node {} with VLAN ID {}", bd, vppNode.getValue(),
 190                         vlanId.getValue());
 191                 bdManager.createVlanBridgeDomainOnVppNode(bd, vlanId, vppNode).get(WAIT_FOR_BD_PROCESSING,
 192                         TimeUnit.SECONDS);
 193             } catch (InterruptedException | ExecutionException e) {
 194                 LOG.warn("VLAN Bridge domain {} was not created on node {}", bd, vppNode.getValue(), e);
 195             } catch (TimeoutException e) {
 196                 LOG.warn("Probably, VLAN Bridge domain {} was not created on node {} because BridgeDomainManager "
 197                         + "did not respond by {} seconds. Check VBD log for more details",
 198                         bd, vppNode.getValue(), WAIT_FOR_BD_PROCESSING, e);
 199             }
 200         }
 201     }
 202
 203     void removeBridgeDomainOnNodes(final SetMultimap<String, NodeId> vppNodesByBridgeDomain) {
 204         for (String bd : vppNodesByBridgeDomain.keySet()) {
 205             Set<NodeId> vppNodes = vppNodesByBridgeDomain.get(bd);
 206             for (NodeId vppNode : vppNodes) {
 207                 try {
 208                     bdManager.removeBridgeDomainFromVppNode(bd, vppNode).get(WAIT_FOR_BD_PROCESSING,
 209                             TimeUnit.SECONDS);
 210                 } catch (InterruptedException | ExecutionException e) {
 211                     LOG.warn("Bridge domain {} was not removed from node {}", bd, vppNode.getValue(), e);
 212                 } catch (TimeoutException e) {
 213                     LOG.warn("Probably, bridge domain {} was not removed from node {} because BridgeDomainManager "
 214                             + "did not respond by {} seconds. Check VBD log for more details",
 215                             bd, vppNode.getValue(), WAIT_FOR_BD_PROCESSING, e);
 216                 }
 217             }
 218         }
 219     }
 220
 221     void createForwardingForEndpoint(RendererEndpointKey rEpKey, PolicyContext policyCtx) {
 222         AddressEndpointWithLocation rEp = policyCtx.getAddrEpByKey().get(KeyFactory.addressEndpointKey(rEpKey));
 223
 224         if (ConfigUtil.getInstance().isLispOverlayEnabled()) {
 225             lispStateManager.processCreateEndPoint(rEp);
 226             if (ConfigUtil.getInstance().isL3FlatEnabled()) {
 227                 flatOverlayManager.configureEndpointForFlatOverlay(rEp);
 228                 loopbackManager.createSimpleLoopbackIfNeeded(rEp);
 229             }
 230         }
 231
 232         ExternalLocationCase rEpLoc = resolveAndValidateLocation(rEp);
 233         if (rEpLoc == null || Strings.isNullOrEmpty(rEpLoc.getExternalNodeConnector())) {
 234             // TODO add it to the status for renderer manager
 235             LOG.info("Renderer endpoint does not have external-node-connector therefore it is ignored {}", rEp);
 236             return;
 237         }
 238
 239         if (Strings.isNullOrEmpty(rEpLoc.getExternalNode())) {
 240             java.util.Optional<String> optL2FloodDomain = resolveL2FloodDomain(rEp, policyCtx);
 241             if (!optL2FloodDomain.isPresent()) {
 242                 // TODO add it to the status for renderer manager
 243                 LOG.info("Renderer endpoint does not have l2FloodDomain as network containment {}", rEp);
 244                 return;
 245             }
 246             if (!ConfigUtil.getInstance().isL3FlatEnabled()) {
 247                 String l2FloodDomain = optL2FloodDomain.get();
 248                 try {
 249                     ifaceManager.addBridgeDomainToInterface(l2FloodDomain, rEp, aclManager.resolveAclsOnInterface(
 250                             rEpKey, policyCtx).get(), isBviForEndpoint(rEp)).get();
 251                     LOG.debug("Interface added to bridge-domain {} for endpoint {}", l2FloodDomain, rEp);
 252
 253                 } catch (InterruptedException | ExecutionException e) {
 254                     // TODO add it to the status for renderer manager
 255                     LOG.warn("Interface was not added to bridge-domain {} for endpoint {}", l2FloodDomain, rEp, e);
 256                 }
 257             }
 258         } else {
 259             LOG.debug("Forwarding is not created - Location of renderer endpoint contains "
 260                     + "external-node therefore VPP renderer assumes that interface for endpoint is "
 261                     + "already assigned in bridge-domain representing external-node. {}", rEp);
 262         }
 263     }
 264
 265     private boolean isBviForEndpoint(AddressEndpointWithLocation rEp) {
 266         List<ChildEndpoint> childEndpointList = rEp.getChildEndpoint();
 267         VppEndpointKey vppEndpointKey;
 268         if(childEndpointList == null || !childEndpointList.stream().findFirst().isPresent()) {
 269             vppEndpointKey =
 270                 new VppEndpointKey(rEp.getAddress(), rEp.getAddressType(), rEp.getContextId(), rEp.getContextType());
 271         } else {
 272             java.util.Optional<ChildEndpoint> childEndpointOpt = childEndpointList.stream().findFirst();
 273             vppEndpointKey =
 274                 new VppEndpointKey(childEndpointOpt.get().getAddress(), childEndpointOpt.get().getAddressType(),
 275                     childEndpointOpt.get().getContextId(), childEndpointOpt.get().getContextType());
 276         }
 277         ReadOnlyTransaction rTx = dataBroker.newReadOnlyTransaction();
 278         Optional<VppEndpoint> vppEndpointOptional =
 279             DataStoreHelper.readFromDs(LogicalDatastoreType.CONFIGURATION,
 280                 InstanceIdentifier.builder(Config.class).child(VppEndpoint.class, vppEndpointKey).build(), rTx);
 281         rTx.close();
 282         if (vppEndpointOptional.isPresent()) {
 283             InterfaceTypeChoice interfaceTypeChoice = vppEndpointOptional.get().getInterfaceTypeChoice();
 284             if (interfaceTypeChoice instanceof LoopbackCase) {
 285                 LOG.trace("Found new BVI interface: {}", rEp.getKey());
 286                 return ((LoopbackCase) interfaceTypeChoice).isBvi();
 287             }
 288         }
 289
 290         return false;
 291     }
 292
 293     void removeForwardingForEndpoint(RendererEndpointKey rEpKey, PolicyContext policyCtx) {
 294         AddressEndpointWithLocation rEp = policyCtx.getAddrEpByKey().get(KeyFactory.addressEndpointKey(rEpKey));
 295         ExternalLocationCase rEpLoc = resolveAndValidateLocation(rEp);
 296
 297         if (ConfigUtil.getInstance().isLispOverlayEnabled()) {
 298             lispStateManager.processDeleteEndpoint(rEp);
 299             if (ConfigUtil.getInstance().isL3FlatEnabled()) {
 300                 flatOverlayManager.deleteStaticRoutingEntry(rEp);
 301             }
 302         }
 303
 304         if (rEpLoc == null || Strings.isNullOrEmpty(rEpLoc.getExternalNodeConnector())) {
 305             // nothing was created for endpoint therefore nothing is removed
 306             return;
 307         }
 308         if (!Strings.isNullOrEmpty(rEpLoc.getExternalNode())) {
 309             try {
 310                 ifaceManager.deleteBridgeDomainFromInterface(rEp).get();
 311                 LOG.debug("bridge-domain was deleted from interface for endpoint {}", rEp);
 312             } catch (InterruptedException | ExecutionException e) {
 313                 // TODO add it to the status for renderer manager
 314                 LOG.warn("bridge-domain was not deleted from interface for endpoint {}", rEp, e);
 315             }
 316         } else {
 317             LOG.debug("Forwarding is not removed - Location of renderer endpoint does not contain "
 318                     + "external-node therefore VPP renderer assumes that interface for endpoint is not "
 319                     + "assigned to bridge-domain representing external-node. {}", rEp);
 320         }
 321     }
 322
 323     static ExternalLocationCase resolveAndValidateLocation(AddressEndpointWithLocation addrEpWithLoc) {
 324         if (addrEpWithLoc.getAbsoluteLocation() != null
 325                 && addrEpWithLoc.getAbsoluteLocation().getLocationType() != null) {
 326             LocationType locationType = addrEpWithLoc.getAbsoluteLocation().getLocationType();
 327             if (!(locationType instanceof ExternalLocationCase)) {
 328                 throw new IllegalStateException("Endpoint does not have external location " + addrEpWithLoc);
 329             }
 330             ExternalLocationCase result = (ExternalLocationCase) locationType;
 331             if (result.getExternalNodeMountPoint() == null) {
 332                 throw new IllegalStateException("Endpoint does not have external-node-mount-point " + addrEpWithLoc);
 333             }
 334             return result;
 335         }
 336         return null;
 337     }
 338
 339     static java.util.Optional<String> resolveL2FloodDomain(@Nonnull AddressEndpointWithLocation ep,
 340             @Nonnull PolicyContext policyCtx) {
 341         NetworkContainment netCont = ep.getNetworkContainment();
 342         if (netCont == null) {
 343             return java.util.Optional.empty();
 344         }
 345         Containment containment = netCont.getContainment();
 346         if (containment instanceof ForwardingContextContainment) {
 347             ForwardingContextContainment fwCtxCont = (ForwardingContextContainment) containment;
 348             if (L2FloodDomain.class.equals(fwCtxCont.getContextType())) {
 349                 return fwCtxCont.getContextId() == null ? java.util.Optional.empty() : java.util.Optional
 350                     .of(fwCtxCont.getContextId().getValue());
 351             }
 352         }
 353         if (containment instanceof NetworkDomainContainment) {
 354             final NetworkDomainContainment netDomainCont = (NetworkDomainContainment) containment;
 355             final TenantId tenantId = ep.getTenant();
 356             final NetworkDomainId domainId = netDomainCont.getNetworkDomainId();
 357             final Class<? extends NetworkDomain> domainKey = netDomainCont.getNetworkDomainType();
 358             final RendererNetworkDomainKey rendererNetworkDomainKey = new RendererNetworkDomainKey(domainId, domainKey);
 359             final RendererNetworkDomain rendererNetworkDomain =
 360                     policyCtx.getNetworkDomainTable().get(tenantId, rendererNetworkDomainKey);
 361             if (rendererNetworkDomain == null) {
 362                 LOG.debug("Network domain not found. Containment: {}", containment);
 363                 return java.util.Optional.empty();
 364             }
 365             java.util.Optional<String> optL2Fd = getForwardingCtxForParent(ep.getTenant(),
 366                     rendererNetworkDomain.getParent(), policyCtx.getForwardingCtxTable())
 367                         .filter(fwdCtx -> L2FloodDomain.class.equals(fwdCtx.getContextType()))
 368                         .map(RendererForwardingContext::getContextId)
 369                         .map(ContextId::getValue);
 370             if (!optL2Fd.isPresent()) {
 371                 LOG.debug("network-domain-containment in endpoint does not have L2-flood-domain as parent. "
 372                         + "This case is not supported in VPP renderer. {}", ep);
 373             }
 374             return optL2Fd;
 375         }
 376         return java.util.Optional.empty();
 377     }
 378
 379     private static @Nonnull java.util.Optional<RendererForwardingContext> getForwardingCtxForParent(
 380             @Nullable TenantId tenant, @Nullable Parent parent,
 381             Table<TenantId, RendererForwardingContextKey, RendererForwardingContext> forwardingCtxTable) {
 382         if (tenant == null || parent == null) {
 383             return java.util.Optional.empty();
 384         }
 385         if (parent.getContextId() != null && parent.getContextType() != null) {
 386             return java.util.Optional.ofNullable(forwardingCtxTable.get(tenant,
 387                     new RendererForwardingContextKey(parent.getContextId(), parent.getContextType())));
 388         }
 389         return java.util.Optional.empty();
 390     }
 391
 392     private static Optional<Endpoints> checkEndpoints(PolicyContext ctx) {
 393         Optional<PolicyContext> contextOptional = Optional.fromNullable(ctx);
 394         if (contextOptional.isPresent()) {
 395             Optional<RendererPolicy> policyOptional = Optional.fromNullable(contextOptional.get().getPolicy());
 396             if (policyOptional.isPresent()) {
 397                 Optional<Configuration> configOptional = Optional.fromNullable(policyOptional.get().getConfiguration());
 398                 if (configOptional.isPresent()) {
 399                     return Optional.fromNullable(configOptional.get().getEndpoints());
 400                 }
 401             }
 402         }
 403         return Optional.absent();
 404     }
 405
 406
 407     void createNatEntries(@Nonnull PolicyContext after) {
 408         LOG.info("Resolving NAT for cfg version {}", after.getPolicy().getVersion());
 409         Preconditions.checkArgument(checkEndpoints(after).isPresent());
 410         final Table<NodeId, Long, List<MappingEntryBuilder>> staticEntries =
 411                 resolveStaticNatTableEntries(checkEndpoints(after).get());
 412         Map<NodeId, NatInstanceCommandBuilder> natByNode = natManager.staticEntries(staticEntries);
 413         natManager.dynamicEntries(after, natByNode);
 414         natManager.submitNatChanges(natByNode);
 415     }
 416
 417     void syncNatEntries(@Nonnull PolicyContext before,@Nonnull PolicyContext after) {
 418         LOG.info("Syncing NAT entries for version {}", after.getPolicy().getVersion());
 419         Optional<Endpoints> endpointsBeforeOptional = checkEndpoints(before);
 420
 421         Endpoints endpointsAfter = null;
 422         Optional<Endpoints> endpointsAfterOptional = checkEndpoints(after);
 423         if (endpointsAfterOptional != null && endpointsAfterOptional.isPresent()) {
 424             endpointsAfter = endpointsAfterOptional.get();
 425         }
 426
 427         if (endpointsBeforeOptional.isPresent()) {
 428             natManager.clearNodes(endpointsBeforeOptional.get(), endpointsAfter);
 429         }
 430
 431         if (endpointsAfter != null) {
 432             createNatEntries(after);
 433         }
 434     }
 435
 436     void deleteNatEntries(@Nonnull PolicyContext before) {
 437         Optional<Endpoints> endpointsBeforeOptional = checkEndpoints(before);
 438         if (endpointsBeforeOptional.isPresent()) {
 439             natManager.clearNodes(endpointsBeforeOptional.get(), null);
 440         }
 441     }
 442
 443     private ImmutableTable<NodeId, Long, List<MappingEntryBuilder>> resolveStaticNatTableEntries(
 444             @Nonnull Endpoints endpoints) {
 445         Table<NodeId, Long, List<MappingEntryBuilder>> resultBuilder = HashBasedTable.create();
 446         List<Predicate<AddressEndpointWithLocation>> filter = Lists.newArrayList();
 447         filter.add(ep -> ep.getAugmentation(NatAddressRenderer.class) != null);
 448         filter.add(ep -> resolveEpIpAddressForSnat(ep) != null);
 449         filter.add(ep -> ep.getAbsoluteLocation() != null);
 450         filter.add(ep -> ep.getAbsoluteLocation().getLocationType() instanceof ExternalLocationCase);
 451         filter.add(ep -> ep.getAugmentation(NatAddressRenderer.class) != null);
 452         filter.add(ep -> ep.getAugmentation(NatAddressRenderer.class).getNatAddress() != null);
 453         filter.add(ep -> ep.getAugmentation(NatAddressRenderer.class).getNatAddress().getIpv4Address() != null);
 454
 455         endpoints.getAddressEndpointWithLocation().forEach(addrEp -> {
 456             if (!filter.stream().allMatch(f -> f.apply(addrEp))) {
 457                 return;
 458             }
 459             String endpointIP = resolveEpIpAddressForSnat(addrEp);
 460             NatAddressRenderer natAddr = addrEp.getAugmentation(NatAddressRenderer.class);
 461             NodeId nodeId = ((ExternalLocationCase) addrEp.getAbsoluteLocation().getLocationType())
 462                 .getExternalNodeMountPoint().firstKeyOf(Node.class).getNodeId();
 463             Optional<MappingEntryBuilder> entry =
 464                     NatUtil.createStaticEntry(endpointIP, natAddr.getNatAddress().getIpv4Address());
 465             if (entry.isPresent()) {
 466                 long tenantId = flatOverlayManager.getVni(addrEp.getTenant().getValue());
 467                 if (resultBuilder.get(nodeId, tenantId) != null) {
 468                     resultBuilder.get(nodeId, tenantId).add(entry.get());
 469                 } else {
 470                     resultBuilder.put(nodeId, tenantId, Lists.newArrayList(entry.get()));
 471                 }
 472             }
 473         });
 474         return ImmutableTable.copyOf(resultBuilder);
 475     }
 476
 477     private String resolveEpIpAddressForSnat(AddressEndpointWithLocation addrEp) {
 478         LOG.trace("Resolving Ep IP address for SNAT from Address endpoint: {}", addrEp);
 479         if (addrEp.getAddressType().equals(MacAddressType.class)) {
 480             ParentEndpointChoice parentEndpointChoice = addrEp.getParentEndpointChoice();
 481             if (parentEndpointChoice instanceof ParentEndpointCase
 482                 && !((ParentEndpointCase) parentEndpointChoice).getParentEndpoint().isEmpty()) {
 483                 ParentEndpoint parentEndpoint = ((ParentEndpointCase) parentEndpointChoice).getParentEndpoint().get(0);
 484                 if (parentEndpoint.getAddressType().equals(IpPrefixType.class)) {
 485                     String[] ipWithPrefix = parentEndpoint.getAddress().split("/");
 486                     LOG.trace("Resolved Ep IP address for SNAT. Resolved  IP Address: {}", ipWithPrefix[0]);
 487                     return ipWithPrefix[0];
 488                 } else {
 489                     LOG.warn("Endpoint {} Does not have a Parent Ep with IP for SNAT. skipping processing of SNAT",
 490                         addrEp);
 491                     return null;
 492                 }
 493
 494             } else {
 495                 LOG.warn("Endpoint {} Does not contain IP address for SNAT. skipping processing of SNAT", addrEp);
 496                 return null;
 497             }
 498         } else if (addrEp.getAddressType().equals(IpPrefixType.class)) {
 499             String ipAddress = addrEp.getAddress().split("/")[0];
 500             LOG.trace("Resolved Ep IP address for SNAT. Resolved  IP Address: {}", ipAddress);
 501             return ipAddress;
 502         }
 503         return null;
 504     }
 505
 506     @VisibleForTesting
 507     void setTimer(byte time) {
 508         WAIT_FOR_BD_PROCESSING = time;
 509     }
 510
 511     void syncRouting(PolicyContext policyCtx) {
 512         Configuration cfg = policyCtx.getPolicy().getConfiguration();
 513         if (cfg != null && cfg.getRendererForwarding() != null) {
 514             for (RendererForwardingByTenant fwd : cfg.getRendererForwarding().getRendererForwardingByTenant()) {
 515                 if (fwd == null) {
 516                     continue;
 517                 }
 518
 519                 List<InstanceIdentifier<PhysicalInterface>>
 520                     physIfacesIid = resolvePhysicalInterfacesForNat(fwd.getRendererNetworkDomain());
 521                 Map<InstanceIdentifier<Node>, RoutingCommand> routingCommandMap =
 522                     routingManager.createRouting(fwd, physIfacesIid, General.Operations.PUT);
 523
 524                 routingCommandMap.forEach((node, command) -> {
 525                     if (command != null && routingManager.submitRouting(command, node)) {
 526                         LOG.debug("Routing was successfully applied: {}.", command);
 527                     }
 528                 });
 529             }
 530         }
 531     }
 532
 533     void deleteRouting(PolicyContext policyCtx) {
 534         Configuration cfg = policyCtx.getPolicy().getConfiguration();
 535         if (cfg != null && cfg.getRendererForwarding() != null) {
 536             for (RendererForwardingByTenant fwd : cfg.getRendererForwarding().getRendererForwardingByTenant()) {
 537                 if (fwd == null) {
 538                     continue;
 539                 }
 540                 List<InstanceIdentifier<PhysicalInterface>>
 541                     physIfacesIid = resolvePhysicalInterfacesForNat(fwd.getRendererNetworkDomain());
 542                 Map<InstanceIdentifier<Node>, RoutingCommand> routingCommandMap =
 543                     routingManager.createRouting(fwd, physIfacesIid, General.Operations.DELETE);
 544                 routingCommandMap.forEach((node, command) -> {
 545                     if (command != null && routingManager.submitRouting(command, node)) {
 546                         LOG.debug("Routing was successfully removed: {}.", command);
 547                     }
 548                 });
 549             }
 550         }
 551     }
 552
 553     List<InstanceIdentifier<PhysicalInterface>> resolvePhysicalInterfacesForNat(
 554             List<RendererNetworkDomain> rendNetDomains) {
 555             List<InstanceIdentifier<PhysicalInterface>> physIfaces = new ArrayList<>();
 556             for (RendererNetworkDomain rendDomain : rendNetDomains) {
 557                 Optional<IpPrefix> resolvedIpPrefix = resolveIpPrefix(rendDomain);
 558                 if (resolvedIpPrefix.isPresent()) {
 559                     List<InstanceIdentifier<PhysicalInterface>> resPhIface =
 560                         NatUtil.resolvePhysicalInterface(resolvedIpPrefix.get(), dataBroker.newReadOnlyTransaction());
 561                     if (!resPhIface.isEmpty()) {
 562                         physIfaces.addAll(resPhIface);
 563                     }
 564                 }
 565             }
 566             return physIfaces;
 567         }
 568
 569     public static Optional<IpPrefix> resolveIpPrefix(RendererNetworkDomain rendDomain) {
 570         SubnetAugmentRenderer subnetAug = rendDomain.getAugmentation(SubnetAugmentRenderer.class);
 571         if (subnetAug.getSubnet() != null) {
 572             return Optional.of(subnetAug.getSubnet().getIpPrefix());
 573         }
 574         return Optional.absent();
 575     }
 576
 577     List<DhcpRelayCommand> createDhcpRelay(RendererForwarding rendererForwarding,
 578         SetMultimap<String, NodeId> vppNodesByL2Fd) {
 579         for (RendererForwardingByTenant forwardingByTenant : rendererForwarding.getRendererForwardingByTenant()) {
 580             long vni_vrfid = NeutronTenantToVniMapper.getInstance().getVni(forwardingByTenant.getTenantId().getValue());
 581             for (RendererNetworkDomain networkDomain : forwardingByTenant.getRendererNetworkDomain()) {
 582                 org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.l2_l3.rev170511.has.subnet.Subnet
 583                     subnet = networkDomain.getAugmentation((SubnetAugmentRenderer.class)).getSubnet();
 584                 if (subnet.isIsTenant()) {
 585                     LOG.trace("Creating Dhcp Relay from subnet: {}, vrfid: {}, vppNodesByL2Fd: {}", subnet, vni_vrfid,
 586                         vppNodesByL2Fd);
 587                     return dhcpRelayHandler.getCreatedIpv4DhcpRelays(vni_vrfid, subnet, vppNodesByL2Fd);
 588                 }
 589             }
 590         }
 591         return new ArrayList<>();
 592     }
 593
 594     List<DhcpRelayCommand> deleteDhcpRelay(RendererForwarding rendererForwarding, SetMultimap<String,
 595         NodeId> vppNodesByL2Fd) {
 596         for (RendererForwardingByTenant forwardingByTenant : rendererForwarding.getRendererForwardingByTenant()) {
 597             long vni_vrfid = NeutronTenantToVniMapper.getInstance().getVni(forwardingByTenant.getTenantId().getValue());
 598             for (RendererNetworkDomain networkDomain : forwardingByTenant.getRendererNetworkDomain()) {
 599                 org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.forwarding.l2_l3.rev170511.has.subnet.Subnet
 600                     subnet = networkDomain.getAugmentation((SubnetAugmentRenderer.class)).getSubnet();
 601                 if (subnet.isIsTenant()) {
 602                     return dhcpRelayHandler.getDeletedIpv4DhcpRelays(vni_vrfid, subnet, vppNodesByL2Fd);
 603                 }
 604             }
 605         }
 606         return new ArrayList<>();
 607     }
 608
 609     void syncDhcpRelay(List<DhcpRelayCommand> createdDhcpRelays, List<DhcpRelayCommand> deletedDhcpRelays) {
 610         deletedDhcpRelays.stream().filter(deleteCommand -> !createdDhcpRelays.contains(deleteCommand))
 611             .forEach(dhcpRelayHandler::submitDhcpRelay);
 612
 613         createdDhcpRelays.stream().filter(createCommand -> !deletedDhcpRelays.contains(createCommand))
 614             .forEach(dhcpRelayHandler::submitDhcpRelay);
 615     }
 616 }