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