renderers/vpp/src/main/java/org/opendaylight/groupbasedpolicy/renderer/vpp/policy/VppRendererPolicyManager.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.Collection;
  12 import java.util.HashSet;
  13 import java.util.Map;
  14 import java.util.Map.Entry;
  15 import java.util.Set;
  16 import java.util.stream.Collectors;
  17
  18 import javax.annotation.Nonnull;
  19
  20 import org.opendaylight.controller.config.yang.config.vpp_provider.impl.VppRenderer;
  21 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  22 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  23 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  24 import org.opendaylight.groupbasedpolicy.renderer.vpp.config.ConfigUtil;
  25 import org.opendaylight.groupbasedpolicy.renderer.vpp.event.NodeOperEvent;
  26 import org.opendaylight.groupbasedpolicy.renderer.vpp.event.RendererPolicyConfEvent;
  27 import org.opendaylight.groupbasedpolicy.renderer.vpp.policy.acl.AclManager;
  28 import org.opendaylight.groupbasedpolicy.renderer.vpp.util.KeyFactory;
  29 import org.opendaylight.groupbasedpolicy.util.IidFactory;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.base_endpoint.rev160427.has.absolute.location.absolute.location.location.type.ExternalLocationCase;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.RendererPolicy;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.RendererPolicyBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.renderer.policy.configuration.RendererForwarding;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.renderer.policy.configuration.endpoints.AddressEndpointWithLocation;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.renderer.policy.configuration.renderer.endpoints.RendererEndpointKey;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.groupbasedpolicy.renderer.rev151103.renderers.renderer.renderer.policy.configuration.rule.groups.RuleGroupKey;
  37 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  38 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  39 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  40 import org.slf4j.Logger;
  41 import org.slf4j.LoggerFactory;
  42
  43 import com.google.common.base.Preconditions;
  44 import com.google.common.collect.HashMultimap;
  45 import com.google.common.collect.ImmutableSet;
  46 import com.google.common.collect.MapDifference;
  47 import com.google.common.collect.MapDifference.ValueDifference;
  48 import com.google.common.collect.Maps;
  49 import com.google.common.collect.SetMultimap;
  50 import com.google.common.collect.Sets;
  51 import com.google.common.collect.Sets.SetView;
  52 import com.google.common.eventbus.Subscribe;
  53
  54
  55 public class VppRendererPolicyManager {
  56
  57     private static final Logger LOG = LoggerFactory.getLogger(VppRendererPolicyManager.class);
  58     private final DataBroker dataProvider;
  59     private ForwardingManager fwManager;
  60     private final AclManager aclManager;
  61
  62     public VppRendererPolicyManager(@Nonnull ForwardingManager fwManager, @Nonnull AclManager aclManager,
  63                                     @Nonnull DataBroker dataProvider) {
  64         this.fwManager = Preconditions.checkNotNull(fwManager);
  65         this.dataProvider = Preconditions.checkNotNull(dataProvider);
  66         this.aclManager = Preconditions.checkNotNull(aclManager);
  67     }
  68
  69     @Subscribe
  70     public void rendererPolicyChanged(RendererPolicyConfEvent event) {
  71         RendererPolicyBuilder responseBuilder = new RendererPolicyBuilder();
  72         switch (event.getDtoModificationType()) {
  73             case CREATED:
  74                 LOG.debug("CREATED : {}", event.getIid());
  75                 responseBuilder.setVersion(event.getAfter().get().getVersion());
  76                 rendererPolicyCreated(event.getAfter().get());
  77                 break;
  78             case UPDATED:
  79                 LOG.debug("UPDATED: {}", event.getIid());
  80                 RendererPolicy rPolicyBefore = event.getBefore().get();
  81                 RendererPolicy rPolicyAfter = event.getAfter().get();
  82                 responseBuilder.setVersion(rPolicyAfter.getVersion());
  83                 if (rPolicyBefore.getConfiguration() == null && rPolicyAfter.getConfiguration() == null) {
  84                     LOG.debug("Configuration is not changed only updating config version from {} to {}",
  85                             rPolicyBefore.getVersion(), rPolicyAfter.getVersion());
  86                 } else {
  87                     // TODO collect unconfigured rules and put them to responseBuilder
  88                     rendererPolicyUpdated(rPolicyBefore, rPolicyAfter);
  89                 }
  90                 break;
  91             case DELETED:
  92                 LOG.debug("DELETED: {}", event.getIid());
  93                 responseBuilder.setVersion(event.getBefore().get().getVersion());
  94                 rendererPolicyDeleted(event.getBefore().get());
  95                 break;
  96         }
  97         WriteTransaction wTx = dataProvider.newWriteOnlyTransaction();
  98         RendererPolicy response = responseBuilder.build();
  99         wTx.put(LogicalDatastoreType.OPERATIONAL, IidFactory.rendererIid(VppRenderer.NAME).child(RendererPolicy.class),
 100                 response, true);
 101         try {
 102             wTx.submit().get();
 103         } catch (Exception ex) {
 104             LOG.trace("Got Exception in renderer policy update. Exception: {}", ex);
 105         }
 106     }
 107
 108     private void rendererPolicyUpdated(RendererPolicy rPolicyBefore, RendererPolicy rPolicyAfter) {
 109         LOG.trace("VPP renderer policy updated");
 110         PolicyContext policyCtxBefore = new PolicyContext(rPolicyBefore);
 111         PolicyContext policyCtxAfter = new PolicyContext(rPolicyAfter);
 112         aclManager.cacheMultiInterfaces(policyCtxAfter);
 113         MapDifference<String, Collection<NodeId>> vppNodesByL2FlDiff =
 114                 createDiffForVppNodesByL2Fd(policyCtxBefore, policyCtxAfter);
 115         SetMultimap<String, NodeId> removedVppNodesByL2Fd = HashMultimap.create();
 116         SetMultimap<String, NodeId> createdVppNodesByL2Fd = HashMultimap.create();
 117         for (Entry<String, ValueDifference<Collection<NodeId>>> entry : vppNodesByL2FlDiff.entriesDiffering()
 118                 .entrySet()) {
 119             String bridgeDomain = entry.getKey();
 120             Collection<NodeId> beforeNodes = entry.getValue().leftValue();
 121             Collection<NodeId> afterNodes = entry.getValue().rightValue();
 122             if (beforeNodes != null && afterNodes != null) {
 123                 SetView<NodeId> removedNodes = Sets.difference(new HashSet<>(beforeNodes), new HashSet<>(afterNodes));
 124                 removedVppNodesByL2Fd.putAll(bridgeDomain, removedNodes);
 125                 SetView<NodeId> createdNodes = Sets.difference(new HashSet<>(afterNodes), new HashSet<>(beforeNodes));
 126                 createdVppNodesByL2Fd.putAll(bridgeDomain, createdNodes);
 127             } else if (beforeNodes != null) {
 128                 removedVppNodesByL2Fd.putAll(bridgeDomain, beforeNodes);
 129             } else if (afterNodes != null) {
 130                 createdVppNodesByL2Fd.putAll(bridgeDomain, afterNodes);
 131             }
 132         }
 133         Map<String, Collection<NodeId>> removedL2Fds = vppNodesByL2FlDiff.entriesOnlyOnLeft();
 134         for (Entry<String, Collection<NodeId>> entry : removedL2Fds.entrySet()) {
 135             String bridgeDomain = entry.getKey();
 136             Collection<NodeId> removedNodes = entry.getValue();
 137             if (removedNodes != null) {
 138                 removedVppNodesByL2Fd.putAll(bridgeDomain, removedNodes);
 139             }
 140         }
 141         Map<String, Collection<NodeId>> createdL2Fds = vppNodesByL2FlDiff.entriesOnlyOnRight();
 142         for (Entry<String, Collection<NodeId>> entry : createdL2Fds.entrySet()) {
 143             String bridgeDomain = entry.getKey();
 144             Collection<NodeId> createdNodes = entry.getValue();
 145             if (createdNodes != null) {
 146                 createdVppNodesByL2Fd.putAll(bridgeDomain, createdNodes);
 147             }
 148         }
 149
 150         ImmutableSet<RendererEndpointKey> rendEpsBefore = policyCtxBefore.getPolicyTable().rowKeySet();
 151         ImmutableSet<RendererEndpointKey> rendEpsAfter = policyCtxAfter.getPolicyTable().rowKeySet();
 152
 153         SetView<RendererEndpointKey> removedRendEps = Sets.difference(rendEpsBefore, rendEpsAfter);
 154         LOG.debug("Removed renderer endpoints {}", removedRendEps);
 155         removedRendEps.forEach(rEpKey -> fwManager.removeForwardingForEndpoint(rEpKey, policyCtxBefore));
 156
 157         if (!ConfigUtil.getInstance().isL3FlatEnabled()) {
 158             LOG.debug("Removing bridge domains on nodes {}", removedVppNodesByL2Fd);
 159             fwManager.removeBridgeDomainOnNodes(removedVppNodesByL2Fd);
 160             LOG.debug("Creating bridge domains on nodes {}", createdVppNodesByL2Fd);
 161             fwManager.createBridgeDomainOnNodes(createdVppNodesByL2Fd);
 162         } else {
 163             if (rPolicyBefore.getConfiguration() != null) {
 164                 RendererForwarding rendererForwardingBefore = rPolicyBefore.getConfiguration().getRendererForwarding();
 165
 166                 SetMultimap<String, NodeId> vppNodesByL2FdBefore =
 167                         resolveVppNodesByL2Fd(policyCtxBefore.getPolicyTable().rowKeySet(), policyCtxBefore);
 168                 if (!vppNodesByL2FdBefore.isEmpty()) {
 169                     LOG.debug("Deleting DhcpRelay for forwarding: {}, on VPP nodes: {}", rendererForwardingBefore,
 170                             vppNodesByL2FdBefore);
 171                     fwManager.deleteDhcpRelay(rendererForwardingBefore, vppNodesByL2FdBefore);
 172                 }
 173             }
 174
 175             if (rPolicyAfter.getConfiguration() != null) {
 176                 RendererForwarding rendererForwardingAfter = rPolicyAfter.getConfiguration().getRendererForwarding();
 177                 SetMultimap<String, NodeId> vppNodesByL2FdAfter =
 178                         resolveVppNodesByL2Fd(policyCtxAfter.getPolicyTable().rowKeySet(), policyCtxAfter);
 179                 if (!vppNodesByL2FdAfter.isEmpty()) {
 180                     LOG.debug("Creating DhcpRelay for forwarding: {}, on VPP nodes: {}", rendererForwardingAfter,
 181                             vppNodesByL2FdAfter);
 182                     fwManager.createDhcpRelay(rendererForwardingAfter, vppNodesByL2FdAfter);
 183                 }
 184             }
 185         }
 186
 187         fwManager.syncNatEntries(policyCtxAfter);
 188
 189         fwManager.deleteRouting(policyCtxBefore);
 190         fwManager.syncRouting(policyCtxAfter);
 191
 192         SetView<RendererEndpointKey> createdRendEps = Sets.difference(rendEpsAfter, rendEpsBefore);
 193         LOG.debug("Created renderer endpoints {}", createdRendEps);
 194         createdRendEps.forEach(rEpKey -> fwManager.createForwardingForEndpoint(rEpKey, policyCtxAfter));
 195
 196         SetView<RendererEndpointKey> updatedRendEps = Sets.intersection(rendEpsBefore, rendEpsAfter);
 197         LOG.debug("Updated renderer endpoints {}", updatedRendEps);
 198         // update forwarding for endpoint
 199         updatedRendEps.forEach(rEpKey -> {
 200             AddressEndpointWithLocation addrEpWithLocBefore =
 201                     policyCtxBefore.getAddrEpByKey().get(KeyFactory.addressEndpointKey(rEpKey));
 202             AddressEndpointWithLocation addrEpWithLocAfter =
 203                     policyCtxAfter.getAddrEpByKey().get(KeyFactory.addressEndpointKey(rEpKey));
 204             if (isLocationChanged(addrEpWithLocBefore, addrEpWithLocAfter)) {
 205                 LOG.debug("Location is changed in endpoint {}", rEpKey);
 206                 LOG.debug("\nLocation before: {}\nLocation after: {}", addrEpWithLocBefore.getAbsoluteLocation(),
 207                         addrEpWithLocAfter.getAbsoluteLocation());
 208                 fwManager.removeForwardingForEndpoint(rEpKey, policyCtxBefore);
 209                 fwManager.createForwardingForEndpoint(rEpKey, policyCtxAfter);
 210             }
 211         });
 212         ImmutableSet<RuleGroupKey> rulesBefore = policyCtxAfter.getRuleGroupByKey().keySet();
 213         ImmutableSet<RuleGroupKey> rulesAfter = policyCtxBefore.getRuleGroupByKey().keySet();
 214         SetView<RuleGroupKey> removedRules = Sets.difference(rulesAfter, rulesBefore);
 215         SetView<RuleGroupKey> createdRules = Sets.difference(rulesBefore, rulesAfter);
 216         LOG.debug("Removed rules {}", removedRules);
 217         LOG.debug("Created rules {}", createdRules);
 218         aclManager.resolveRulesToConfigure(policyCtxBefore, removedRendEps, removedRules, false);
 219         aclManager.resolveRulesToConfigure(policyCtxAfter, createdRendEps, createdRules, true);
 220     }
 221
 222     private static boolean isLocationChanged(AddressEndpointWithLocation before, AddressEndpointWithLocation after) {
 223         ExternalLocationCase locationBefore = ForwardingManager.resolveAndValidateLocation(before);
 224         ExternalLocationCase locationAfter = ForwardingManager.resolveAndValidateLocation(after);
 225         if(locationBefore == null && locationAfter == null) {
 226             return false;
 227         }
 228         if(locationBefore == null || locationAfter == null) {
 229             return true;
 230         }
 231         return !locationBefore.equals(locationAfter);
 232     }
 233
 234     private static MapDifference<String, Collection<NodeId>> createDiffForVppNodesByL2Fd(PolicyContext policyCtxBefore,
 235                                                                                          PolicyContext policyCtxAfter) {
 236         ImmutableSet<RendererEndpointKey> rendEpsBefore = policyCtxBefore.getPolicyTable().rowKeySet();
 237         ImmutableSet<RendererEndpointKey> rendEpsAfter = policyCtxAfter.getPolicyTable().rowKeySet();
 238         SetMultimap<String, NodeId> vppNodesByL2FdBefore = resolveVppNodesByL2Fd(rendEpsBefore, policyCtxBefore);
 239         SetMultimap<String, NodeId> vppNodesByL2FdAfter = resolveVppNodesByL2Fd(rendEpsAfter, policyCtxAfter);
 240         return Maps.difference(vppNodesByL2FdBefore.asMap(), vppNodesByL2FdAfter.asMap());
 241     }
 242
 243     private void rendererPolicyCreated(RendererPolicy rPolicy) {
 244         LOG.trace("VPP renderer policy version {} created", rPolicy.getVersion());
 245         PolicyContext policyCtx = new PolicyContext(rPolicy);
 246         aclManager.cacheMultiInterfaces(policyCtx);
 247         ImmutableSet<RendererEndpointKey> rEpKeys = policyCtx.getPolicyTable().rowKeySet();
 248         SetMultimap<String, NodeId> vppNodesByL2Fd = resolveVppNodesByL2Fd(rEpKeys, policyCtx);
 249         if (!ConfigUtil.getInstance().isL3FlatEnabled()) {
 250             fwManager.createBridgeDomainOnNodes(vppNodesByL2Fd);
 251         } else {
 252             RendererForwarding rendererForwarding = rPolicy.getConfiguration().getRendererForwarding();
 253             fwManager.createDhcpRelay(rendererForwarding, vppNodesByL2Fd);
 254         }
 255
 256         rEpKeys.forEach(rEpKey -> fwManager.createForwardingForEndpoint(rEpKey, policyCtx));
 257         fwManager.syncNatEntries(policyCtx);
 258         fwManager.syncRouting(policyCtx);
 259     }
 260
 261     private void rendererPolicyDeleted(RendererPolicy rendererPolicy) {
 262         LOG.trace("VPP renderer policy version {} deleted", rendererPolicy.getVersion());
 263         PolicyContext policyCtx = new PolicyContext(rendererPolicy);
 264         aclManager.cacheMultiInterfaces(policyCtx);
 265         ImmutableSet<RendererEndpointKey> rEpKeys = policyCtx.getPolicyTable().rowKeySet();
 266
 267         rEpKeys.forEach(rEpKey -> fwManager.removeForwardingForEndpoint(rEpKey, policyCtx));
 268         SetMultimap<String, NodeId> vppNodesByL2Fd = resolveVppNodesByL2Fd(rEpKeys, policyCtx);
 269         if (!ConfigUtil.getInstance().isL3FlatEnabled()) {
 270             fwManager.removeBridgeDomainOnNodes(vppNodesByL2Fd);
 271         } else {
 272             RendererForwarding rendererForwarding = rendererPolicy.getConfiguration().getRendererForwarding();
 273             fwManager.deleteDhcpRelay(rendererForwarding, vppNodesByL2Fd);
 274         }
 275         fwManager.deleteNatEntries(policyCtx);
 276         fwManager.deleteRouting(policyCtx);
 277     }
 278
 279     private static SetMultimap<String, NodeId> resolveVppNodesByL2Fd(Set<RendererEndpointKey> rEpKeys,
 280                                                                      PolicyContext policyCtx) {
 281         SetMultimap<String, NodeId> vppNodesByL2Fd = HashMultimap.create();
 282         rEpKeys.stream()
 283                 .map(rEpKey -> KeyFactory.addressEndpointKey(rEpKey))
 284                 .map(addrEpKey -> policyCtx.getAddrEpByKey().get(addrEpKey))
 285                 .collect(Collectors.toSet())
 286                 .forEach(addrEpWithLoc -> {
 287                     java.util.Optional<String> optL2Fd = ForwardingManager.resolveL2FloodDomain(addrEpWithLoc, policyCtx);
 288                     if (optL2Fd.isPresent()) {
 289                         ExternalLocationCase rEpLoc = ForwardingManager.resolveAndValidateLocation(addrEpWithLoc);
 290                         if (rEpLoc != null) {
 291                             InstanceIdentifier<?> externalNodeMountPoint = rEpLoc.getExternalNodeMountPoint();
 292                             NodeId vppNode = externalNodeMountPoint.firstKeyOf(Node.class).getNodeId();
 293                             vppNodesByL2Fd.put(optL2Fd.get(), vppNode);
 294                         }
 295                     }
 296                 });
 297         return vppNodesByL2Fd;
 298     }
 299
 300     @Subscribe
 301     public void vppNodeChanged(NodeOperEvent event) {
 302         switch (event.getDtoModificationType()) {
 303             case CREATED:
 304                 if (event.isAfterConnected()) {
 305                     // TODO
 306                 }
 307                 break;
 308             case UPDATED:
 309                 if (!event.isBeforeConnected() && event.isAfterConnected()) {
 310                     // TODO
 311                 }
 312                 break;
 313             case DELETED:
 314                 if (event.isBeforeConnected()) {
 315                     // TODO
 316                 }
 317                 break;
 318         }
 319     }
 320 }