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