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.iface.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         MapDifference<String, Collection<NodeId>> vppNodesByL2FlDiff =
 124                 createDiffForVppNodesByL2Fd(policyCtxBefore, policyCtxAfter);
 125         SetMultimap<String, NodeId> removedVppNodesByL2Fd = HashMultimap.create();
 126         SetMultimap<String, NodeId> createdVppNodesByL2Fd = HashMultimap.create();
 127         for (Entry<String, ValueDifference<Collection<NodeId>>> entry : vppNodesByL2FlDiff.entriesDiffering()
 128             .entrySet()) {
 129             String bridgeDomain = entry.getKey();
 130             Collection<NodeId> beforeNodes = entry.getValue().leftValue();
 131             Collection<NodeId> afterNodes = entry.getValue().rightValue();
 132             if (beforeNodes != null && afterNodes != null) {
 133                 SetView<NodeId> removedNodes = Sets.difference(new HashSet<>(beforeNodes), new HashSet<>(afterNodes));
 134                 removedVppNodesByL2Fd.putAll(bridgeDomain, removedNodes);
 135                 SetView<NodeId> createdNodes = Sets.difference(new HashSet<>(afterNodes), new HashSet<>(beforeNodes));
 136                 createdVppNodesByL2Fd.putAll(bridgeDomain, createdNodes);
 137             } else if (beforeNodes != null) {
 138                 removedVppNodesByL2Fd.putAll(bridgeDomain, beforeNodes);
 139             } else if (afterNodes != null) {
 140                 createdVppNodesByL2Fd.putAll(bridgeDomain, afterNodes);
 141             }
 142         }
 143         Map<String, Collection<NodeId>> removedL2Fds = vppNodesByL2FlDiff.entriesOnlyOnLeft();
 144         for (Entry<String, Collection<NodeId>> entry : removedL2Fds.entrySet()) {
 145             String bridgeDomain = entry.getKey();
 146             Collection<NodeId> removedNodes = entry.getValue();
 147             if (removedNodes != null) {
 148                 removedVppNodesByL2Fd.putAll(bridgeDomain, removedNodes);
 149             }
 150         }
 151         Map<String, Collection<NodeId>> createdL2Fds = vppNodesByL2FlDiff.entriesOnlyOnRight();
 152         for (Entry<String, Collection<NodeId>> entry : createdL2Fds.entrySet()) {
 153             String bridgeDomain = entry.getKey();
 154             Collection<NodeId> createdNodes = entry.getValue();
 155             if (createdNodes != null) {
 156                 createdVppNodesByL2Fd.putAll(bridgeDomain, createdNodes);
 157             }
 158         }
 159
 160         ImmutableSet<RendererEndpointKey> rendEpsBefore = policyCtxBefore.getPolicyTable().rowKeySet();
 161         ImmutableSet<RendererEndpointKey> rendEpsAfter = policyCtxAfter.getPolicyTable().rowKeySet();
 162
 163         SetView<RendererEndpointKey> removedRendEps = Sets.difference(rendEpsBefore, rendEpsAfter);
 164         LOG.debug("Removed renderer endpoints {}", removedRendEps);
 165         removedRendEps.forEach(rEpKey -> fwManager.removeForwardingForEndpoint(rEpKey, policyCtxBefore));
 166
 167         LOG.debug("Removing bridge domains on nodes {}", removedVppNodesByL2Fd);
 168         fwManager.removeBridgeDomainOnNodes(removedVppNodesByL2Fd);
 169         LOG.debug("Creating bridge domains on nodes {}", createdVppNodesByL2Fd);
 170         fwManager.createBridgeDomainOnNodes(createdVppNodesByL2Fd);
 171
 172         fwManager.syncNatEntries(policyCtxAfter);
 173
 174         fwManager.deleteRouting(policyCtxBefore);
 175         fwManager.syncRouting(policyCtxAfter);
 176
 177         SetView<RendererEndpointKey> createdRendEps = Sets.difference(rendEpsAfter, rendEpsBefore);
 178         LOG.debug("Created renderer endpoints {}", createdRendEps);
 179         createdRendEps.forEach(rEpKey -> fwManager.createForwardingForEndpoint(rEpKey, policyCtxAfter));
 180
 181         SetView<RendererEndpointKey> updatedRendEps = Sets.intersection(rendEpsBefore, rendEpsAfter);
 182         LOG.debug("Updated renderer endpoints {}", updatedRendEps);
 183         // update forwarding for endpoint
 184         updatedRendEps.forEach(rEpKey -> {
 185             AddressEndpointWithLocation addrEpWithLocBefore =
 186                     policyCtxBefore.getAddrEpByKey().get(KeyFactory.addressEndpointKey(rEpKey));
 187             AddressEndpointWithLocation addrEpWithLocAfter =
 188                     policyCtxAfter.getAddrEpByKey().get(KeyFactory.addressEndpointKey(rEpKey));
 189             if (isLocationChanged(addrEpWithLocBefore, addrEpWithLocAfter)) {
 190                 LOG.debug("Location is changed in endpoint {}", rEpKey);
 191                 LOG.debug("\nLocation before: {}\nLocation after: {}", addrEpWithLocBefore.getAbsoluteLocation(),
 192                         addrEpWithLocAfter.getAbsoluteLocation());
 193                 fwManager.removeForwardingForEndpoint(rEpKey, policyCtxBefore);
 194                 fwManager.createForwardingForEndpoint(rEpKey, policyCtxAfter);
 195             }
 196         });
 197         updatePolicy(policyCtxBefore, policyCtxAfter);
 198     }
 199
 200     /**
 201      * Looks for changed rule groups in {@code policyCtxBefore} and {@code policyCtxAfter}.
 202      * Access lists are updated for endpoints in {@code policyCtxAfter} affected by changed rule
 203      * groups.
 204      *
 205      * @param policyCtxBefore policy before
 206      * @param policyCtxAfter policy after
 207      */
 208     private void updatePolicy(PolicyContext policyCtxBefore, PolicyContext policyCtxAfter) {
 209         LOG.info("Updating policy by rule groups.");
 210         Set<RuleGroupKey> diffRuleGroups = new HashSet<>();
 211         diffRuleGroups.addAll(Sets.difference(policyCtxBefore.getRuleGroupByKey().keySet(),
 212                 policyCtxAfter.getRuleGroupByKey().keySet()));
 213         diffRuleGroups.addAll(Sets.difference(policyCtxAfter.getRuleGroupByKey().keySet(), policyCtxBefore.getRuleGroupByKey().keySet()));
 214         LOG.trace("Rule groups changed: {} ", diffRuleGroups.size());
 215         Set<RendererEndpointKey> updates = new HashSet<>();
 216         for (PolicyContext policy : new PolicyContext[] {policyCtxBefore, policyCtxAfter}) {
 217             if (policy.getPolicy().getConfiguration() == null
 218                     || policy.getPolicy().getConfiguration().getRendererEndpoints() == null
 219                     || policy.getPolicy().getConfiguration().getRendererEndpoints().getRendererEndpoint() == null) {
 220                 continue;
 221             }
 222             policy.getPolicy()
 223                 .getConfiguration()
 224                 .getRendererEndpoints()
 225                 .getRendererEndpoint()
 226                 .stream()
 227                 .filter(rEp -> !updates.contains(rEp.getKey()))
 228                 .forEach(rEp -> {
 229                     for (PeerEndpoint pEp : rEp.getPeerEndpoint()) {
 230                         for (RuleGroupWithRendererEndpointParticipation rg : pEp
 231                             .getRuleGroupWithRendererEndpointParticipation()) {
 232                             if (!diffRuleGroups.contains(
 233                                     new RuleGroupKey(rg.getContractId(), rg.getSubjectName(), rg.getTenantId()))) {
 234                                 continue;
 235                             }
 236                             LOG.debug("Updated resolved rule group: {}. Affected endpoints {} and {}.", rg.getKey(), rEp.getKey(), pEp.getKey());
 237                             updates.add(rEp.getKey());
 238                             AddressEndpointKey k1 = AddressEndpointUtils.fromPeerEpKey(pEp.getKey());
 239                             updates.add(AddressEndpointUtils.toRendererEpKey(k1));
 240                         }
 241                     }
 242                 });
 243         }
 244         for (RendererEndpointKey rEpKey : updates) {
 245             aclManager.updateAclsForRendEp(rEpKey, policyCtxAfter);
 246         }
 247     }
 248
 249     private static boolean isLocationChanged(AddressEndpointWithLocation before, AddressEndpointWithLocation after) {
 250         ExternalLocationCase locationBefore = ForwardingManager.resolveAndValidateLocation(before);
 251         ExternalLocationCase locationAfter = ForwardingManager.resolveAndValidateLocation(after);
 252         return !locationBefore.equals(locationAfter);
 253     }
 254
 255     private static MapDifference<String, Collection<NodeId>> createDiffForVppNodesByL2Fd(PolicyContext policyCtxBefore,
 256             PolicyContext policyCtxAfter) {
 257         ImmutableSet<RendererEndpointKey> rendEpsBefore = policyCtxBefore.getPolicyTable().rowKeySet();
 258         ImmutableSet<RendererEndpointKey> rendEpsAfter = policyCtxAfter.getPolicyTable().rowKeySet();
 259         SetMultimap<String, NodeId> vppNodesByL2FdBefore = resolveVppNodesByL2Fd(rendEpsBefore, policyCtxBefore);
 260         SetMultimap<String, NodeId> vppNodesByL2FdAfter = resolveVppNodesByL2Fd(rendEpsAfter, policyCtxAfter);
 261         return Maps.difference(vppNodesByL2FdBefore.asMap(), vppNodesByL2FdAfter.asMap());
 262     }
 263
 264     private void rendererPolicyCreated(RendererPolicy rPolicy) {
 265         LOG.trace("VPP renderer policy version {} created", rPolicy.getVersion());
 266         PolicyContext policyCtx = new PolicyContext(rPolicy);
 267         ImmutableSet<RendererEndpointKey> rEpKeys = policyCtx.getPolicyTable().rowKeySet();
 268
 269         SetMultimap<String, NodeId> vppNodesByL2Fd = resolveVppNodesByL2Fd(rEpKeys, policyCtx);
 270         fwManager.createBridgeDomainOnNodes(vppNodesByL2Fd);
 271         fwManager.syncNatEntries(policyCtx);
 272         fwManager.syncRouting(policyCtx);
 273         rEpKeys.forEach(rEpKey -> fwManager.createForwardingForEndpoint(rEpKey, policyCtx));
 274     }
 275
 276     private void rendererPolicyDeleted(RendererPolicy rendererPolicy) {
 277         LOG.trace("VPP renderer policy version {} deleted", rendererPolicy.getVersion());
 278         PolicyContext policyCtx = new PolicyContext(rendererPolicy);
 279         ImmutableSet<RendererEndpointKey> rEpKeys = policyCtx.getPolicyTable().rowKeySet();
 280
 281         rEpKeys.forEach(rEpKey -> fwManager.removeForwardingForEndpoint(rEpKey, policyCtx));
 282
 283         SetMultimap<String, NodeId> vppNodesByL2Fd = resolveVppNodesByL2Fd(rEpKeys, policyCtx);
 284         fwManager.deleteNatEntries(policyCtx);
 285         fwManager.deleteRouting(policyCtx);
 286         fwManager.removeBridgeDomainOnNodes(vppNodesByL2Fd);
 287     }
 288
 289     private static SetMultimap<String, NodeId> resolveVppNodesByL2Fd(Set<RendererEndpointKey> rEpKeys,
 290             PolicyContext policyCtx) {
 291         SetMultimap<String, NodeId> vppNodesByL2Fd = HashMultimap.create();
 292         rEpKeys.stream()
 293             .map(rEpKey -> KeyFactory.addressEndpointKey(rEpKey))
 294             .map(addrEpKey -> policyCtx.getAddrEpByKey().get(addrEpKey))
 295             .collect(Collectors.toSet())
 296             .forEach(addrEpWithLoc -> {
 297                 java.util.Optional<String> optL2Fd = ForwardingManager.resolveL2FloodDomain(addrEpWithLoc, policyCtx);
 298                 if (optL2Fd.isPresent()) {
 299                     ExternalLocationCase rEpLoc = ForwardingManager.resolveAndValidateLocation(addrEpWithLoc);
 300                     InstanceIdentifier<?> externalNodeMountPoint = rEpLoc.getExternalNodeMountPoint();
 301                     NodeId vppNode = externalNodeMountPoint.firstKeyOf(Node.class).getNodeId();
 302                     vppNodesByL2Fd.put(optL2Fd.get(), vppNode);
 303                 }
 304             });
 305         return vppNodesByL2Fd;
 306     }
 307
 308     @Subscribe
 309     public void vppNodeChanged(NodeOperEvent event) {
 310         switch (event.getDtoModificationType()) {
 311             case CREATED:
 312                 if (event.isAfterConnected()) {
 313                     // TODO
 314                 }
 315                 break;
 316             case UPDATED:
 317                 if (!event.isBeforeConnected() && event.isAfterConnected()) {
 318                     // TODO
 319                 }
 320                 break;
 321             case DELETED:
 322                 if (event.isBeforeConnected()) {
 323                     // TODO
 324                 }
 325                 break;
 326         }
 327     }
 328 }